diff --git a/.github/workflows/AutoLabelAssign.yml b/.github/workflows/AutoLabelAssign.yml index 1a30efad7c..65e87b3d4b 100644 --- a/.github/workflows/AutoLabelAssign.yml +++ b/.github/workflows/AutoLabelAssign.yml @@ -14,6 +14,7 @@ on: 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 }} @@ -23,6 +24,7 @@ jobs: 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: @@ -32,4 +34,4 @@ jobs: ExcludedUserList: '["user1", "user2"]' ExcludedBranchList: '["branch1", "branch2"]' secrets: - AccessToken: ${{ secrets.GITHUB_TOKEN }} + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/AutoLabelMsftContributor.yml b/.github/workflows/AutoLabelMsftContributor.yml index 7058a420cf..6fcfb6e43e 100644 --- a/.github/workflows/AutoLabelMsftContributor.yml +++ b/.github/workflows/AutoLabelMsftContributor.yml @@ -13,7 +13,7 @@ on: jobs: download-payload: - if: github.repository_visibility == 'public' + 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: @@ -24,11 +24,12 @@ jobs: label-msft: name: Label Microsoft contributors - if: github.repository_visibility == 'public' + 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 }} - TeamReadAccessToken: ${{ secrets.ORG_READTEAMS_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 index c0389bb252..8dc3ceae0a 100644 --- a/.github/workflows/BackgroundTasks.yml +++ b/.github/workflows/BackgroundTasks.yml @@ -9,6 +9,7 @@ on: jobs: upload: + if: github.repository_owner == 'MicrosoftDocs' runs-on: ubuntu-latest steps: @@ -23,4 +24,4 @@ jobs: - uses: actions/upload-artifact@v4 with: name: PayloadJson - path: pr/ + 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 index 56b79b4813..7db35548e9 100644 --- a/.github/workflows/LiveMergeCheck.yml +++ b/.github/workflows/LiveMergeCheck.yml @@ -12,8 +12,9 @@ on: 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 }} + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/PrFileCount.yml b/.github/workflows/PrFileCount.yml index 95fcf5e1ed..17faf7a211 100644 --- a/.github/workflows/PrFileCount.yml +++ b/.github/workflows/PrFileCount.yml @@ -12,8 +12,9 @@ on: 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 }} + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/ProtectedFiles.yml b/.github/workflows/ProtectedFiles.yml index 769cd0aa14..bbdbbe2e40 100644 --- a/.github/workflows/ProtectedFiles.yml +++ b/.github/workflows/ProtectedFiles.yml @@ -10,8 +10,9 @@ 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 }} + 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.publish.config.json b/.openpublishing.publish.config.json index 5ec6581821..6144e7e800 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -1,213 +1,202 @@ { - "docsets_to_publish": [ - { - "docset_name": "exchange-ps", - "build_source_folder": "exchange", - "build_output_subfolder": "exchange-ps", - "locale": "en-us", - "monikers": [], - "moniker_ranges": [], - "open_to_public_contributors": true, - "type_mapping": { - "Conceptual": "Content", - "ManagedReference": "Content", - "RestApi": "Content", - "PowershellModule": "Content", - "PowershellCmdlet": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "version": 0, - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/MAML2Yaml/tools/Run.ps1" + "branch_target_mapping": { + "live": [ + "Publish" ] - }, - "monikerPath": [ - "mapping/monikerMapping.json" - ] }, - { - "docset_name": "officewebapps-ps", - "build_source_folder": "officewebapps", - "build_output_subfolder": "officewebapps-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" - ] - }, - { - "docset_name": "skype-ps", - "build_source_folder": "skype", - "build_output_subfolder": "skype-ps", - "locale": "en-us", - "monikers": [], - "moniker_ranges": [], - "open_to_public_contributors": true, - "type_mapping": { - "Conceptual": "Content", - "ManagedReference": "Content", - "RestApi": "Content", - "PowershellModule": "Content", - "PowershellCmdlet": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "version": 0, - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/MAML2Yaml/tools/Run.ps1" - ] - }, - "monikerPath": [ - "mapping/monikerMapping.json" - ] - }, - { - "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" - ] - }, - { - "docset_name": "staffhub-ps", - "build_source_folder": "staffhub", - "build_output_subfolder": "staffhub-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": "teams-ps", - "build_source_folder": "teams", - "build_output_subfolder": "teams-ps", - "locale": "en-us", - "monikers": [], - "moniker_ranges": [], - "open_to_public_contributors": true, - "type_mapping": { - "Conceptual": "Content", - "ManagedReference": "Content", - "RestApi": "Content", - "PowershellModule": "Content", - "PowershellCmdlet": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "version": 0, - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/MAML2Yaml/tools/Run.ps1" - ] - }, - "monikerPath": [ - "mapping/monikerMapping.json" - ] - }, - { - "docset_name": "whiteboard-ps", - "build_source_folder": "whiteboard", - "build_output_subfolder": "whiteboard-ps", - "locale": "en-us", - "monikers": [], - "moniker_ranges": [], - "open_to_public_contributors": true, - "type_mapping": { - "Conceptual": "Content", - "ManagedReference": "Content", - "RestApi": "Content", - "PowershellModule": "Content", - "PowershellCmdlet": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "version": 0, - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/MAML2Yaml/tools/Run.ps1" - ] - }, - "monikerPath": [ - "mapping/monikerMapping.json" - ] - } - ], - "notification_subscribers": [], - "sync_notification_subscribers": [], - "branches_to_filter": [], - "git_repository_branch_open_to_public_contributors": "main", - "need_preview_pull_request": true, - "dependent_repositories": [ - { - "path_to_root": "_themes", - "url": "https://github.com/Microsoft/templates.docs.msft", - "branch": "main", - "branch_mapping": {} - } - ], - "branch_target_mapping": { - "live": [ - "Publish" - ] - }, - "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": [ - { - "id": "Microsoft.DocAsCode.MAML2Yaml", - "nuget_feed": "https://www.myget.org/F/op/api/v2", - "path_to_root": "_dependentPackages/MAML2Yaml", - "target_framework": "net45", - "version": "latest" + "branches_to_filter": [], + "contribution_branch_mappings": {}, + "dependent_packages": [ + { + "id": "Microsoft.DocAsCode.MAML2Yaml", + "nuget_feed": "https://www.myget.org/F/op/api/v2", + "path_to_root": "_dependentPackages/MAML2Yaml", + "target_framework": "net45", + "version": "latest" + } + ], + "dependent_repositories": [ + { + "branch": "main", + "branch_mapping": {}, + "path_to_root": "_themes", + "url": "https://github.com/Microsoft/templates.docs.msft" + } + ], + "docs_build_engine": {}, + "docsets_to_publish": [ + { + "build_entry_point": "docs", + "build_output_subfolder": "exchange-ps", + "build_source_folder": "exchange", + "customized_tasks": { + "docset_prebuild": [ + "_dependentPackages/MAML2Yaml/tools/Run.ps1" + ] + }, + "docset_name": "exchange-ps", + "locale": "en-us", + "monikerPath": [ + "mapping/monikerMapping.json" + ], + "moniker_ranges": [], + "monikers": [], + "open_to_public_contributors": true, + "template_folder": "_themes", + "type_mapping": { + "Conceptual": "Content", + "ManagedReference": "Content", + "PowerShellCmdlet1": "Content", + "PowerShellModule1": "Content", + "RestApi": "Content" + }, + "version": 0 + }, + { + "build_entry_point": "docs", + "build_output_subfolder": "officewebapps-ps", + "build_source_folder": "officewebapps", + "docset_name": "officewebapps-ps", + "locale": "en-us", + "monikerPath": [ + "mapping/monikerMapping.json" + ], + "moniker_ranges": [], + "monikers": [], + "open_to_public_contributors": true, + "template_folder": "_themes", + "type_mapping": { + "Conceptual": "Content", + "ManagedReference": "Content", + "PowerShellCmdlet1": "Content", + "PowerShellModule1": "Content", + "RestApi": "Content" + }, + "version": 0 + }, + { + "build_entry_point": "docs", + "build_output_subfolder": "skype-ps", + "build_source_folder": "skype", + "customized_tasks": { + "docset_prebuild": [ + "_dependentPackages/MAML2Yaml/tools/Run.ps1" + ] + }, + "docset_name": "skype-ps", + "locale": "en-us", + "monikerPath": [ + "mapping/monikerMapping.json" + ], + "moniker_ranges": [], + "monikers": [], + "open_to_public_contributors": true, + "template_folder": "_themes", + "type_mapping": { + "Conceptual": "Content", + "ManagedReference": "Content", + "PowerShellCmdlet1": "Content", + "PowerShellModule1": "Content", + "RestApi": "Content" + }, + "version": 0 + }, + { + "build_entry_point": "docs", + "build_output_subfolder": "spmt-ps", + "build_source_folder": "spmt", + "docset_name": "spmt-ps", + "locale": "en-us", + "monikerPath": [ + "mapping/monikerMapping.json" + ], + "moniker_ranges": [], + "monikers": [], + "open_to_public_contributors": true, + "template_folder": "_themes", + "type_mapping": { + "Conceptual": "Content", + "ManagedReference": "Content", + "PowerShellCmdlet1": "Content", + "PowerShellModule1": "Content", + "RestApi": "Content" + }, + "version": 0 + }, + { + "build_entry_point": "docs", + "build_output_subfolder": "teams-ps", + "build_source_folder": "teams", + "customized_tasks": { + "docset_prebuild": [ + "_dependentPackages/MAML2Yaml/tools/Run.ps1" + ] + }, + "docset_name": "teams-ps", + "locale": "en-us", + "monikerPath": [ + "mapping/monikerMapping.json" + ], + "moniker_ranges": [], + "monikers": [], + "open_to_public_contributors": true, + "template_folder": "_themes", + "type_mapping": { + "Conceptual": "Content", + "ManagedReference": "Content", + "PowerShellCmdlet1": "Content", + "PowerShellModule1": "Content", + "RestApi": "Content" + }, + "version": 0 + }, + { + "build_entry_point": "docs", + "build_output_subfolder": "whiteboard-ps", + "build_source_folder": "whiteboard", + "customized_tasks": { + "docset_prebuild": [ + "_dependentPackages/MAML2Yaml/tools/Run.ps1" + ] + }, + "docset_name": "whiteboard-ps", + "locale": "en-us", + "monikerPath": [ + "mapping/monikerMapping.json" + ], + "moniker_ranges": [], + "monikers": [], + "open_to_public_contributors": true, + "template_folder": "_themes", + "type_mapping": { + "Conceptual": "Content", + "ManagedReference": "Content", + "PowerShellCmdlet1": "Content", + "PowerShellModule1": "Content", + "RestApi": "Content" + }, + "version": 0 + } + ], + "enable_incremental_build": false, + "git_repository_branch_open_to_public_contributors": "main", + "need_generate_intellisense": false, + "need_generate_pdf_url_template": false, + "need_preview_pull_request": true, + "notification_subscribers": [], + "redirection_files": [ + ".openpublishing.redirection.exchange.json", + ".openpublishing.redirection.officewebapps.json", + ".openpublishing.redirection.skype.json", + ".openpublishing.redirection.spmt.json", + ".openpublishing.redirection.teams.json", + ".openpublishing.redirection.whiteboard.json" + ], + "skip_source_output_uploading": false, + "sync_notification_subscribers": [], + "targets": { + "Pdf": { + "template_folder": "_themes.pdf" + } } - ] -} \ No newline at end of file +} diff --git a/.openpublishing.redirection.exchange.json b/.openpublishing.redirection.exchange.json new file mode 100644 index 0000000000..68da428a79 --- /dev/null +++ b/.openpublishing.redirection.exchange.json @@ -0,0 +1,14239 @@ +{ + "redirections": [ + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpEdmSschema.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpedmschema", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-TeamsRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-TeamsRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-TeamsRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-TeamsRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-TeamsRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-TeamsRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-TeamsRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-TeamsRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpComplianceRuleV2.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpComplianceRuleV2.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRuleV2.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpComplianceRuleV2.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/exchange-ps-v2-module/connect-exchangeonline.md", + "redirect_url": "/powershell/module/exchangepowershell/connect-exchangeonline", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Test-ExchangeUMCallFlow.md", + "redirect_url": "https://www.microsoft.com/download/details.aspx?id=20839", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-ConnectSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-HotmailSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-ImapSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-PopSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-SendAddress.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-Subscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/New-ConnectSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/New-HotmailSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/New-ImapSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/New-PopSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/New-Subscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Remove-ConnectSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Remove-Subscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Set-ConnectSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Set-HotmailSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Set-ImapSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/connected-accounts/Set-PopSubscription.md", + "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Add-ADPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-adpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Dump-ProvisioningCache.md", + "redirect_url": "/powershell/module/exchangepowershell/dump-provisioningcache", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADServerSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adserversettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADSite.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adsite", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Get-AdSiteLink.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adsitelink", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Get-DomainController.md", + "redirect_url": "/powershell/module/exchangepowershell/get-domaincontroller", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Get-OrganizationalUnit.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationalunit", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Get-Trust.md", + "redirect_url": "/powershell/module/exchangepowershell/get-trust", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Get-UserPrincipalNamesSuffix.md", + "redirect_url": "/powershell/module/exchangepowershell/get-userprincipalnamessuffix", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Remove-ADPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-adpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Reset-ProvisioningCache.md", + "redirect_url": "/powershell/module/exchangepowershell/reset-provisioningcache", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Set-ADServerSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adserversettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Set-ADSite.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adsite", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/active-directory/Set-AdSiteLink.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adsitelink", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-antiphishrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-safeattachmentrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-safelinksrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-antiphishrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-safeattachmentrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-safelinksrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentDetail.md", + "redirect_url": "/powershell/module/exchangepowershell/get-advancedthreatprotectiondocumentdetail", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-advancedthreatprotectiondocumentreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionTrafficReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-antiphishpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-antiphishrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AtpPolicyForO365.md", + "redirect_url": "/powershell/module/exchangepowershell/get-atppolicyforo365", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-MailDetailATPReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-MailTrafficATPReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-PhishFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-tenantallowblocklistspoofitems", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safeattachmentpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safeattachmentrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinkspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SpoofMailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-spoofmailreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-UrlTrace.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksaggregatereport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-antiphishpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-antiphishrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safeattachmentpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safeattachmentrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safelinkspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safelinksrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-antiphishpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-antiphishrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safeattachmentpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safeattachmentrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safelinkspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safelinksrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-antiphishpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-antiphishrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AtpPolicyForO365.md", + "redirect_url": "/powershell/module/exchangepowershell/set-atppolicyforo365", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-PhishFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-tenantallowblocklistspoofitems", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safeattachmentpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safeattachmentrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safelinkspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safelinksrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-AttachmentFilterEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-attachmentfilterentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-ContentFilterPhrase.md", + "redirect_url": "/powershell/module/exchangepowershell/add-contentfilterphrase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPAllowListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipallowlistentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipallowlistprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPBlockListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipblocklistentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipblocklistprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Delete-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/delete-quarantinemessage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-hostedcontentfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-hostedoutboundspamfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-malwarefilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-AntispamUpdates.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-antispamupdates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-hostedcontentfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-hostedoutboundspamfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-malwarefilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Export-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/export-quarantinemessage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AgentLog.md", + "redirect_url": "/powershell/module/exchangepowershell/get-agentlog", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AttachmentFilterEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-attachmentfilterentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AttachmentFilterListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-attachmentfilterlistconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-BlockedSenderAddress.md", + "redirect_url": "/powershell/module/exchangepowershell/get-blockedsenderaddress", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-ContentFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentfilterconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-ContentFilterPhrase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentfilterphrase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dkimsigningconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedConnectionFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedconnectionfilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedcontentfilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedcontentfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedoutboundspamfilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedoutboundspamfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistprovidersconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistprovidersconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MailboxJunkEmailConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxjunkemailconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilteringServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilteringserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-quarantinemessage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-QuarantineMessageHeader.md", + "redirect_url": "/powershell/module/exchangepowershell/get-quarantinemessageheader", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-RecipientFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientfilterconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-senderfilterconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderIdConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-senderidconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderReputationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-senderreputationconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dkimsigningconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedcontentfilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedcontentfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedoutboundspamfilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedoutboundspamfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-malwarefilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-malwarefilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Preview-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/preview-quarantinemessage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Release-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/release-quarantinemessage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-AttachmentFilterEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-attachmentfilterentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-BlockedSenderAddress.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-blockedsenderaddress", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-ContentFilterPhrase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-contentfilterphrase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedcontentfilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedcontentfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPAllowListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipallowlistentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipallowlistprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPBlockListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipblocklistentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipblocklistprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-malwarefilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-malwarefilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Rotate-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/rotate-dkimsigningconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-AttachmentFilterListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-attachmentfilterlistconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-ContentFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-contentfilterconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dkimsigningconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedConnectionFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedconnectionfilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedcontentfilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedcontentfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedoutboundspamfilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedoutboundspamfilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistprovidersconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistprovidersconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MailboxJunkEmailConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxjunkemailconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilteringServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilteringserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilterpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilterrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-RecipientFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-recipientfilterconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-senderfilterconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderIdConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-senderidconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderReputationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-senderreputationconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/test-ipallowlistprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/test-ipblocklistprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-SenderId.md", + "redirect_url": "/powershell/module/exchangepowershell/test-senderid", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Update-SafeList.md", + "redirect_url": "/powershell/module/exchangepowershell/update-safelist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Clear-TextMessagingAccount.md", + "redirect_url": "/powershell/module/exchangepowershell/clear-textmessagingaccount", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Compare-TextMessagingVerificationCode.md", + "redirect_url": "/powershell/module/exchangepowershell/compare-textmessagingverificationcode", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Disable-PushNotificationProxy.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-pushnotificationproxy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Enable-PushNotificationProxy.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-pushnotificationproxy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Export-AutoDiscoverConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/export-autodiscoverconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-CASMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-casmailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-CASMailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/get-casmailboxplan", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-ImapSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-imapsettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxCalendarConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxcalendarconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxMessageConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxmessageconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxRegionalConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxregionalconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxSpellingConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxspellingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-owamailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-PopSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-popsettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Get-TextMessagingAccount.md", + "redirect_url": "/powershell/module/exchangepowershell/get-textmessagingaccount", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/New-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-clientaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/New-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/new-outlookprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/New-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-owamailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Remove-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-clientaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Remove-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-outlookprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Remove-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-owamailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Send-TextMessagingVerificationCode.md", + "redirect_url": "/powershell/module/exchangepowershell/send-textmessagingverificationcode", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-CASMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-casmailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/set-CASMailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/set-casmailboxplan", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-ImapSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-imapsettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxCalendarConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxcalendarconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxMessageConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxmessageconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxRegionalConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxregionalconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxSpellingConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxspellingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookprovider", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-owamailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-PopSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-popsettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Set-TextMessagingAccount.md", + "redirect_url": "/powershell/module/exchangepowershell/set-textmessagingaccount", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Test-CalendarConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-calendarconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Test-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/test-clientaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Test-EcpConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-ecpconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Test-ImapConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-imapconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Test-OutlookConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-outlookconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Test-OutlookWebServices.md", + "redirect_url": "/powershell/module/exchangepowershell/test-outlookwebservices", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Test-OwaConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-owaconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Test-PopConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-popconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Test-PowerShellConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-powershellconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access/Test-WebServicesConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-webservicesconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Disable-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-outlookanywhere", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Enable-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-outlookanywhere", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authredirect", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-autodiscovervirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessarray", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ecpvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mapivirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookanywhere", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-owavirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-powershellvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rpcclientaccess", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-webservicesvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/new-authredirect", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-autodiscovervirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/new-clientaccessarray", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-ecpvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mapivirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-owavirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-powershellvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/new-rpcclientaccess", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-webservicesvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-authredirect", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-autodiscovervirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-clientaccessarray", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ecpvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mapivirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-owavirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-powershellvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-rpcclientaccess", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-webservicesvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authredirect", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-autodiscovervirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessarray", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ecpvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mapivirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookanywhere", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-owavirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-powershellvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/set-rpcclientaccess", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-webservicesvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Add-DatabaseAvailabilityGroupServer.md", + "redirect_url": "/powershell/module/exchangepowershell/add-databaseavailabilitygroupserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Add-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxdatabasecopy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-databaseavailabilitygroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/get-databaseavailabilitygroupnetwork", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-MailboxDatabaseCopyStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxdatabasecopystatus", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Move-ActiveMailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/move-activemailboxdatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/New-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-databaseavailabilitygroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/New-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/new-databaseavailabilitygroupnetwork", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroupnetwork", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupServer.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroupserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxdatabasecopy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Restore-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-databaseavailabilitygroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Resume-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxdatabasecopy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-databaseavailabilitygroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/set-databaseavailabilitygroupnetwork", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxdatabasecopy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Start-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/start-databaseavailabilitygroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Stop-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-databaseavailabilitygroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Suspend-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxdatabasecopy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Test-ReplicationHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-replicationhealth", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Update-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-mailboxdatabasecopy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Clear-ActiveSyncDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/clear-activesyncdevice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Clear-MobileDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/clear-mobiledevice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Export-ActiveSyncLog.md", + "redirect_url": "/powershell/module/exchangepowershell/export-activesynclog", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdevice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceAutoblockThreshold.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceautoblockthreshold", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceClass.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceclass", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdevicestatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncmailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncOrganizationSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncorganizationsettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconditionalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconditionalaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconfigurationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconfigurationrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-DevicePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-devicepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-devicetenantpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-devicetenantrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevicemailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDeviceStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevicestatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/New-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncdeviceaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/New-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncmailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconditionalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconditionalaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconfigurationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconfigurationrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-devicetenantpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-devicetenantrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/New-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mobiledevicemailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdevice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdeviceaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDeviceClass.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdeviceclass", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncmailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconditionalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconditionalaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconfigurationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconfigurationrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-devicetenantpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-devicetenantrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-MobileDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mobiledevice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Remove-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mobiledevicemailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncdeviceaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncDeviceAutoblockThreshold.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncdeviceautoblockthreshold", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncmailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncOrganizationSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncorganizationsettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconditionalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconditionalaccessrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconfigurationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconfigurationrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-devicetenantpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-devicetenantrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Set-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mobiledevicemailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/devices/Test-ActiveSyncConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-activesyncconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Disable-AddressListPaging.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-addresslistpaging", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Enable-AddressListPaging.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-addresslistpaging", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-addressbookpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/get-addresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-DetailsTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-detailstemplate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-emailaddresspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/get-globaladdresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-oabvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/get-offlineaddressbook", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Move-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/move-addresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Move-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/move-offlineaddressbook", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-addressbookpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/new-addresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-emailaddresspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/new-globaladdresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-oabvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/new-offlineaddressbook", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-addressbookpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-addresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-emailaddresspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-globaladdresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-oabvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-offlineaddressbook", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Restore-DetailsTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-detailstemplate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-addressbookpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/set-addresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-DetailsTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/set-detailstemplate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-emailaddresspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/set-globaladdresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-oabvirtualdirectory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/set-offlineaddressbook", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/update-addresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-emailaddresspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/update-globaladdresslist", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/update-offlineaddressbook", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Enable-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-exchangecertificate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Export-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/export-exchangecertificate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-DataEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataencryptionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangecertificate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-IRMConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-irmconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-omeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-OMEMessageStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-omemessagestatus", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-RMSTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rmstemplate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-SmimeConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-smimeconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Import-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/import-exchangecertificate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Import-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-DataEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dataencryptionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exchangecertificate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/new-omeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-exchangecertificate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-omeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-DataEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dataencryptionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-IRMConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-irmconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-omeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-OMEMessageRevocation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-omemessagerevocation", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-RMSTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/set-rmstemplate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-SmimeConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-smimeconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Test-IRMConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/test-irmconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Add-FederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/add-federateddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Disable-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-remotemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Enable-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-remotemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederatedDomainProof.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federateddomainproof", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederatedOrganizationIdentifier.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federatedorganizationidentifier", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederationInformation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federationinformation", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federationtrust", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hybridconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridMailflow.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hybridmailflow", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridMailflowDatacenterIPs.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hybridmailflowdatacenterips", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-IntraOrganizationConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-intraorganizationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-intraorganizationconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/get-onpremisesorganization", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-PendingFederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-pendingfederateddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-remotemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/new-federationtrust", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hybridconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-intraorganizationconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/new-onpremisesorganization", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/new-remotemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-FederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-federateddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-federationtrust", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hybridconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-intraorganizationconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-onpremisesorganization", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-remotemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-FederatedOrganizationIdentifier.md", + "redirect_url": "/powershell/module/exchangepowershell/set-federatedorganizationidentifier", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/set-federationtrust", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hybridconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-HybridMailflow.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hybridmailflow", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-intraorganizationconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/set-onpremisesorganization", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-PendingFederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-pendingfederateddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-remotemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Test-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/test-federationtrust", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Test-FederationTrustCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/test-federationtrustcertificate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Update-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/update-hybridconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Update-Recipient.md", + "redirect_url": "/powershell/module/exchangepowershell/update-recipient", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Add-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/add-resubmitrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Disable-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-transportagent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Enable-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-transportagent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Export-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/export-message", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-accepteddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-addressrewriteentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deliveryagentconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-EdgeSubscription.md", + "redirect_url": "/powershell/module/exchangepowershell/get-edgesubscription", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-EdgeSyncServiceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-edgesyncserviceconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-foreignconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-FrontendTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-frontendtransportservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-inboundconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MailboxTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxtransportservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/get-message", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrace.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrace", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTraceDetail.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetracedetail", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrackingLog.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrackinglog", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrackingReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrackingreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-NetworkConnectionInfo.md", + "redirect_url": "/powershell/module/exchangepowershell/get-networkconnectioninfo", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outboundconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/get-queue", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-QueueDigest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-queuedigest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-receiveconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-remotedomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-resubmitrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-routinggroupconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sendconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-systemmessage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportagent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportPipeline.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportpipeline", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-x400authoritativedomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Install-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/install-transportagent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/new-accepteddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/new-addressrewriteentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deliveryagentconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-EdgeSubscription.md", + "redirect_url": "/powershell/module/exchangepowershell/new-edgesubscription", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-EdgeSyncServiceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-edgesyncserviceconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-foreignconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-inboundconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-outboundconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-receiveconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/new-remotedomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-routinggroupconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sendconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-systemmessage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/New-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/new-x400authoritativedomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Redirect-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/redirect-message", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-accepteddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-addressrewriteentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deliveryagentconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-EdgeSubscription.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-edgesubscription", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-foreignconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-inboundconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-message", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-outboundconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-receiveconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-remotedomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-resubmitrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-routinggroupconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sendconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-systemmessage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-x400authoritativedomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Resume-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-message", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Resume-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-queue", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Retry-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/retry-queue", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Search-MessageTrackingReport.md", + "redirect_url": "/powershell/module/exchangepowershell/search-messagetrackingreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-accepteddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/set-addressrewriteentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deliveryagentconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-EdgeSyncServiceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-edgesyncserviceconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-foreignconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-FrontendTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-frontendtransportservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-inboundconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-MailboxTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxtransportservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outboundconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-receiveconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-remotedomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-resubmitrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-routinggroupconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sendconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/set-systemmessage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportagent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-x400authoritativedomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Start-EdgeSynchronization.md", + "redirect_url": "/powershell/module/exchangepowershell/start-edgesynchronization", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Start-HistoricalSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-historicalsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Stop-HistoricalSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-historicalsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Suspend-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-message", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Suspend-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-queue", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-EdgeSynchronization.md", + "redirect_url": "/powershell/module/exchangepowershell/test-edgesynchronization", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-Mailflow.md", + "redirect_url": "/powershell/module/exchangepowershell/test-mailflow", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-SmtpConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-smtpconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Uninstall-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/uninstall-transportagent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mail-flow/Validate-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/validate-outboundconnector", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Clean-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/clean-mailboxdatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Disable-MailboxQuarantine.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailboxquarantine", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Disable-MetaCacheDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-metacachedatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Dismount-Database.md", + "redirect_url": "/powershell/module/exchangepowershell/dismount-database", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Enable-MailboxQuarantine.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailboxquarantine", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Enable-MetaCacheDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-metacachedatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-FailedContentIndexDocuments.md", + "redirect_url": "/powershell/module/exchangepowershell/get-failedcontentindexdocuments", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxdatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrepairrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/get-searchdocumentformat", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-StoreUsageStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-storeusagestatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Mount-Database.md", + "redirect_url": "/powershell/module/exchangepowershell/mount-database", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Move-DatabasePath.md", + "redirect_url": "/powershell/module/exchangepowershell/move-databasepath", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxdatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-MailboxRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxrepairrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/new-searchdocumentformat", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxdatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-MailboxRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxrepairrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-searchdocumentformat", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-StoreMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-storemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxdatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-MailboxServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/set-searchdocumentformat", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-AssistantHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-assistanthealth", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-ExchangeSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/test-exchangesearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-MRSHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-mrshealth", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-DatabaseSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/update-databaseschema", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-FileDistributionService.md", + "redirect_url": "/powershell/module/exchangepowershell/update-filedistributionservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-StoreMailboxState.md", + "redirect_url": "/powershell/module/exchangepowershell/update-storemailboxstate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxfolderpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-MailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-RecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-recipientpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Connect-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/connect-mailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-App.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-app", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-inboxrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-ServiceEmailChannel.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-serviceemailchannel", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-sweeprule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-App.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-app", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-inboxrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-ServiceEmailChannel.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-serviceemailchannel", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-sweeprule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Export-MailboxDiagnosticLogs.md", + "redirect_url": "/powershell/module/exchangepowershell/export-mailboxdiagnosticlogs", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Export-RecipientDataProperty.md", + "redirect_url": "/powershell/module/exchangepowershell/export-recipientdataproperty", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-App.md", + "redirect_url": "/powershell/module/exchangepowershell/get-app", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticAnalysis.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticanalysis", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticLog.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticlog", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticObjects.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticobjects", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarNotification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendarnotification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarProcessing.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendarprocessing", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Clutter.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clutter", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-FocusedInbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-focusedinbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-inboxrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxAutoReplyConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxautoreplyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxCalendarFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxcalendarfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxexportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxExportRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxexportrequeststatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolderpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolderStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolderstatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboximportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxImportRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboximportrequeststatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxLocation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxlocation", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxplan", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrestorerequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxRestoreRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrestorerequeststatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxSentItemsConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxsentitemsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxstatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxUserConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxuserconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MessageCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagecategory", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Place.md", + "redirect_url": "/powershell/module/exchangepowershell/get-place", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-RecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-RecoverableItems.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recoverableitems", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-ResourceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-resourceconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sweeprule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-UserPhoto.md", + "redirect_url": "/powershell/module/exchangepowershell/get-userphoto", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Import-ContactList.md", + "redirect_url": "https://support.microsoft.com/office/import-contacts-to-outlook-bb796340-b58a-46c1-90c7-b549b8f3c5f8", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Import-RecipientDataProperty.md", + "redirect_url": "/powershell/module/exchangepowershell/import-recipientdataproperty", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/New-App.md", + "redirect_url": "/powershell/module/exchangepowershell/new-app", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/New-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-inboxrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/New-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxexportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboximportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxrestorerequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailmessage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/New-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sitemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/New-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sweeprule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-App.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-app", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-CalendarEvents.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-calendarevents", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-inboxrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxexportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxfolderpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboximportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxrestorerequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxUserConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxuserconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-RecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-recipientpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sweeprule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-UserPhoto.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-userphoto", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Restore-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-mailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Restore-RecoverableItems.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-recoverableitems", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxexportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboximportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxrestorerequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Search-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/search-mailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-App.md", + "redirect_url": "/powershell/module/exchangepowershell/set-app", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-CalendarNotification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-calendarnotification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-CalendarProcessing.md", + "redirect_url": "/powershell/module/exchangepowershell/set-calendarprocessing", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Clutter.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clutter", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-FocusedInbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-focusedinbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-inboxrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxAutoReplyConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxautoreplyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxCalendarFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxcalendarfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxexportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxfolderpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboximportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxplan", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxrestorerequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxSentItemsConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxsentitemsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Place.md", + "redirect_url": "/powershell/module/exchangepowershell/set-place", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-ResourceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-resourceconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sweeprule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-UserPhoto.md", + "redirect_url": "/powershell/module/exchangepowershell/set-userphoto", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxexportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboximportrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxrestorerequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Test-MAPIConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-mapiconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/mailboxes/Undo-SoftDeletedMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/undo-softdeletedmailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Complete-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/complete-migrationbatch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Export-MigrationReport.md", + "redirect_url": "/powershell/module/exchangepowershell/export-migrationreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationbatch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationendpoint", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationstatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationUserStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationuserstatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-moverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MoveRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-moverequeststatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequeststatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermigrationrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMigrationRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermigrationrequeststatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermoverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMoveRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermoverequeststatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-migrationbatch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/new-migrationendpoint", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-moverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfoldermigrationrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfoldermoverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationbatch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationendpoint", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-moverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMailboxMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermailboxmigrationrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermigrationrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermoverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-moverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfoldermigrationrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfoldermoverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationbatch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationendpoint", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-moverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfoldermigrationrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfoldermoverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Start-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-migrationbatch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Start-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/start-migrationuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Stop-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-migrationbatch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Stop-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-migrationuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-moverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMailboxMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermailboxmigrationrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermigrationrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermoverequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/move-and-migration/Test-MigrationServerAvailability.md", + "redirect_url": "/powershell/module/exchangepowershell/test-migrationserveravailability", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Disable-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-cmdletextensionagent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Enable-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-cmdletextensionagent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Enable-OrganizationCustomization.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-organizationcustomization", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-AccessToCustomerDataRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-accesstocustomerdatarequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-applicationaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authenticationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-cmdletextensionagent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeAssistanceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeassistanceconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeDiagnosticInfo.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangediagnosticinfo", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServerAccessLicense.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserveraccesslicense", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServerAccessLicenseUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserveraccesslicenseuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangesettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-Notification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-notification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-OrganizationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/get-partnerapplication", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-PerimeterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-perimeterconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Get-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/get-settingoverride", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/New-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-applicationaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/New-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-authenticationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/New-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/new-authserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/New-ExchangeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exchangesettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/New-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/new-partnerapplication", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/New-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/new-settingoverride", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Remove-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-applicationaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Remove-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-authenticationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Remove-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-authserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Remove-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-partnerapplication", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Remove-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-settingoverride", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-AccessToCustomerDataRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-accesstocustomerdatarequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-applicationaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authenticationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/set-cmdletextensionagent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeAssistanceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangeassistanceconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangeserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangesettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-Notification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-notification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-OrganizationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/set-partnerapplication", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-PerimeterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-perimeterconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Set-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/set-settingoverride", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Test-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/test-applicationaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Test-OAuthConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-oauthconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Test-SystemHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-systemhealth", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/organization/Update-ExchangeHelp.md", + "redirect_url": "/powershell/module/exchangepowershell/update-exchangehelp", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-JournalArchiving.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-journalarchiving", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-journalrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-outlookprotectionrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-transportrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-journalrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-outlookprotectionrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-transportrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Export-JournalRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/export-journalrulecollection", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Export-TransportRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/export-transportrulecollection", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-ActivityAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activityalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-AdministrativeUnit.md", + "redirect_url": "/powershell/module/exchangepowershell/get-administrativeunit", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierPoliciesApplicationStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierpoliciesapplicationstatus", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierRecipientStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierrecipientstatus", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-journalrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/get-label", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-labelpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messageclassification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationsegment", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookprotectionrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/get-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewpolicyv2", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-SupervisoryReviewRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRuleAction.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportruleaction", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRulePredicate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportrulepredicate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Import-JournalRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/import-journalrulecollection", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Import-TransportRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/import-transportrulecollection", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Install-UnifiedCompliancePrerequisite.md", + "redirect_url": "/powershell/module/exchangepowershell/install-unifiedcomplianceprerequisite", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-ActivityAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/new-activityalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-informationbarrierpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-journalrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/new-label", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-labelpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/new-messageclassification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/new-organizationsegment", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-outlookprotectionrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/new-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/new-supervisoryreviewpolicyv2", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-SupervisoryReviewRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-supervisoryreviewrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-transportrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-ActivityAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activityalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-informationbarrierpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-journalrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-label", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-labelpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-messageclassification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-organizationsegment", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-outlookprotectionrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-supervisoryreviewpolicyv2", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-transportrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-ActivityAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activityalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-informationbarrierpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-journalrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/set-label", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-labelpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-messageclassification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationsegment", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookprotectionrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/set-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/set-supervisoryreviewpolicyv2", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-SupervisoryReviewRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-supervisoryreviewrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Start-InformationBarrierPoliciesApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/start-informationbarrierpoliciesapplication", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Stop-InformationBarrierPoliciesApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-informationbarrierpoliciesapplication", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Test-ArchiveConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-archiveconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AdminAuditLogConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adminauditlogconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-auditconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-auditconfigurationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-auditconfigurationrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditLogSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-auditlogsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-MailboxAuditBypassAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxauditbypassassociation", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedauditlogretentionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AdminAuditLogSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-adminauditlogsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-auditconfigurationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-auditconfigurationrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-MailboxAuditLogSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxauditlogsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-unifiedauditlogretentionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-auditconfigurationpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-auditconfigurationrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedauditlogretentionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-AdminAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/search-adminauditlog", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-MailboxAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/search-mailboxauditlog", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-UnifiedAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/search-unifiedauditlog", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AdminAuditLogConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adminauditlogconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AuditConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-auditconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-auditconfigurationrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-MailboxAuditBypassAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxauditbypassassociation", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-unifiedauditlogretentionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Write-AdminAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/write-adminauditlog", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesearchaction", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesecurityfilter", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Invoke-ComplianceSearchActionStep.md", + "redirect_url": "/powershell/module/exchangepowershell/invoke-compliancesearchactionstep", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesearchaction", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesecurityfilter", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesearchaction", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesecurityfilter", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesearchaction", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesecurityfilter", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Start-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-compliancesearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Start-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-mailboxsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Stop-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-compliancesearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Stop-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-mailboxsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Export-DlpPolicyCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/export-dlppolicycollection", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/get-classificationrulecollection", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataclassification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DataClassificationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataclassificationconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpcompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpdetailreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpDetectionsReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpdetectionsreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpedmschema", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpkeyworddictionary", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlppolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpPolicyTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlppolicytemplate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsensitiveinformationtype", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSiDetectionsReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsidetectionsreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-policytipconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Import-DlpPolicyCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/import-dlppolicycollection", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Import-DlpPolicyTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/import-dlppolicytemplate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/new-classificationrulecollection", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dataclassification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpcompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpedmschema", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpFingerprint.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpfingerprint", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpkeyworddictionary", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlppolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpsensitiveinformationtype", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-Fingerprint.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fingerprint", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-policytipconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-classificationrulecollection", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dataclassification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpcompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpedmschema", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpkeyworddictionary", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlppolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpPolicyTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlppolicytemplate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtype", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-policytipconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/set-classificationrulecollection", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dataclassification", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpcompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpedmschema", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpkeyworddictionary", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlppolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpsensitiveinformationtype", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-policytipconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Add-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/add-compliancecasemember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Add-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ediscoverycaseadmin", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-caseholdpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-caseholdrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancecase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancecasemember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ediscoverycaseadmin", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-caseholdpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-caseholdrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancecase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-caseholdpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-caseholdrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancecase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancecasemember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ediscoverycaseadmin", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-caseholdpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-caseholdrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancecase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Update-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-compliancecasemember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Update-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/update-ediscoverycaseadmin", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Enable-ComplianceTagStorage.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-compliancetagstorage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEvent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-complianceretentionevent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/get-complianceretentioneventtype", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancetag", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceTagStorage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancetagstorage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-DataRetentionReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataretentionreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-holdcompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-holdcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managedcontentsettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managedfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managedfoldermailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionEvent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionevent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionpolicytag", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceRetentionEvent.md", + "redirect_url": "/powershell/module/exchangepowershell/new-complianceretentionevent", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/new-complianceretentioneventtype", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancetag", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-holdcompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-holdcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managedcontentsettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managedfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managedfoldermailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentionpolicytag", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-complianceretentioneventtype", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancetag", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-holdcompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-holdcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedcontentsettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedfoldermailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentionpolicytag", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/set-complianceretentioneventtype", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancetag", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-holdcompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-holdcompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managedcontentsettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managedfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managedfoldermailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancerule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentionpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentionpolicytag", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Start-ManagedFolderAssistant.md", + "redirect_url": "/powershell/module/exchangepowershell/start-managedfolderassistant", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Start-RetentionAutoTagLearning.md", + "redirect_url": "/powershell/module/exchangepowershell/start-retentionautotaglearning", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Stop-ManagedFolderAssistant.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-managedfolderassistant", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Validate-RetentionRuleQuery.md", + "redirect_url": "/powershell/module/exchangepowershell/validate-retentionrulequery", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Connect-ExchangeOnline.md", + "redirect_url": "/powershell/module/exchangepowershell/connect-exchangeonline", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOCasMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exocasmailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxfolderpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxFolderStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxfolderstatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxstatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMobileDeviceStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomobiledevicestatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXORecipient.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exorecipient", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXORecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exorecipientpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-ConnectionByClientTypeDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-ConnectionByClientTypeReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsActiveUserReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsAVConferenceTimeReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsClientDeviceDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsClientDeviceReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsConferenceReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsP2PAVTimeReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsP2PSessionReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsPSTNConferenceTimeReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsPSTNUsageDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsUserActivitiesReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsUsersBlockedReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-GroupActivityReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-HistoricalSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-historicalsearch", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-LicenseVsUsageSummaryReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-LogonStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-logonstatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailboxActivityReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailboxUsageDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailboxUsageReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailDlpPolicyReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetaildlppolicyreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailMalwareReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailSpamReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailTransportRuleReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailtransportrulereport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailFilterListReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailfilterlistreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficPolicyReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficpolicyreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficSummaryReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficsummaryreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficTopReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficsummaryreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-MxRecordReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mxrecordreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientBrowserDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientBrowserReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientOSDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientOSReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-OutboundConnectorReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outboundconnectorreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-RecipientStatisticsReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientstatisticsreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-ReportExecutionInstance.md", + "redirect_url": "/powershell/module/exchangepowershell/get-reportexecutioninstance", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SCInsights.md", + "redirect_url": "/powershell/module/exchangepowershell/get-scinsights", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-ServiceDeliveryReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-servicedeliveryreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOActiveUserReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOSkyDriveProDeployedReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOSkyDriveProStorageReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOTeamSiteDeployedReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOTeamSiteStorageReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOTenantStorageMetricReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-StaleMailboxDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-StaleMailboxReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewActivity.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewactivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewOverallProgressReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewoverallprogressreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewPolicyReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewpolicyreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewTopCasesReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewtopcasesreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-TenantAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Get-UserAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Set-TenantAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/reporting/Set-UserAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Add-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-managementroleentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Add-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/add-rolegroupmember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRole.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementrole", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementroleassignment", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementroleentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementscope", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-roleassignmentpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rolegroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rolegroupmember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementRole.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managementrole", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managementroleassignment", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managementscope", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-roleassignmentpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-rolegroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRole.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementrole", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementroleassignment", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementroleentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementscope", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-roleassignmentpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-rolegroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-rolegroupmember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managementroleassignment", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managementroleentry", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managementscope", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-roleassignmentpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-rolegroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Update-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-rolegroupmember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Add-GlobalMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/add-globalmonitoringoverride", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Add-ServerMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/add-servermonitoringoverride", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityreportoutage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-EventLogLevel.md", + "redirect_url": "/powershell/module/exchangepowershell/get-eventloglevel", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-GlobalMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/get-globalmonitoringoverride", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-HealthReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-healthreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-MonitoringItemHelp.md", + "redirect_url": "/powershell/module/exchangepowershell/get-monitoringitemhelp", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-MonitoringItemIdentity.md", + "redirect_url": "/powershell/module/exchangepowershell/get-monitoringitemidentity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerComponentState.md", + "redirect_url": "/powershell/module/exchangepowershell/get-servercomponentstate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/get-serverhealth", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/get-servermonitoringoverride", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-throttlingpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ThrottlingPolicyAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-throttlingpolicyassociation", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Invoke-MonitoringProbe.md", + "redirect_url": "/powershell/module/exchangepowershell/invoke-monitoringprobe", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/New-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-availabilityreportoutage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/New-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-throttlingpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityreportoutage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-GlobalMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-globalmonitoringoverride", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-ServerMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-servermonitoringoverride", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-throttlingpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/set-availabilityreportoutage", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-EventLogLevel.md", + "redirect_url": "/powershell/module/exchangepowershell/set-eventloglevel", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ServerComponentState.md", + "redirect_url": "/powershell/module/exchangepowershell/set-servercomponentstate", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ServerMonitor.md", + "redirect_url": "/powershell/module/exchangepowershell/set-servermonitor", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-throttlingpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ThrottlingPolicyAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-throttlingpolicyassociation", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Test-ServiceHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-servicehealth", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-AvailabilityAddressSpace.md", + "redirect_url": "/powershell/module/exchangepowershell/add-availabilityaddressspace", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-PublicFolderAdministrativePermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-publicfolderadministrativepermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-PublicFolderClientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-publicfolderclientpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Disable-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailpublicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Enable-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailpublicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-AvailabilityAddressSpace.md", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityaddressspace", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailpublicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationrelationship", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderAdministrativePermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderadministrativepermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderClientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderclientpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderdatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderItemStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderitemstatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderMailboxDiagnostics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxdiagnostics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderstatistics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sharingpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailboxDiagnostics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailboxdiagnostics", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailboxprovisioningpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-availabilityconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/new-organizationrelationship", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolderdatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolderDatabaseRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolderdatabaserepairrequest", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sharingpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sitemailboxprovisioningpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SyncMailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-syncmailpublicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-AvailabilityAddressSpace.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityaddressspace", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-organizationrelationship", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderAdministrativePermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderadministrativepermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderClientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderclientpermission", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderdatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sharingpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sitemailboxprovisioningpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SyncMailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-syncmailpublicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Resume-PublicFolderReplication.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfolderreplication", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-availabilityconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailpublicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationrelationship", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfolderdatabase", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sharingpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sitemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sitemailboxprovisioningpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Suspend-PublicFolderReplication.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfolderreplication", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Test-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/test-organizationrelationship", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Test-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/test-sitemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfolder", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolderHierarchy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfolderhierarchy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolderMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfoldermailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/update-sitemailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umautoattendant", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umcallansweringrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umipgateway", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-ummailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMServer.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umautoattendant", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umcallansweringrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umipgateway", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-ummailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMServer.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Export-UMCallDataRecord.md", + "redirect_url": "/powershell/module/exchangepowershell/export-umcalldatarecord", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Export-UMPrompt.md", + "redirect_url": "/powershell/module/exchangepowershell/export-umprompt", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-OnlineMeetingConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-onlinemeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMActiveCalls.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umactivecalls", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umautoattendant", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallansweringrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallDataRecord.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcalldatarecord", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallRouterSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallroutersettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallSummaryReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallsummaryreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umdialplan", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMHuntGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umhuntgroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umipgateway", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailboxPIN.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailboxpin", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UmServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Import-UMPrompt.md", + "redirect_url": "/powershell/module/exchangepowershell/import-umprompt", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umautoattendant", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umcallansweringrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umdialplan", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMHuntGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umhuntgroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umipgateway", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-ummailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umautoattendant", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umcallansweringrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umdialplan", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMHuntGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umhuntgroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umipgateway", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ummailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umautoattendant", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umcallansweringrule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMCallRouterSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umcallroutersettings", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umdialplan", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umipgateway", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailbox", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailboxPIN.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailboxpin", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailboxpolicy", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UmServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umserver", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umservice", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/unified-messaging/Test-UMConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-umconnectivity", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Add-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/add-distributiongroupmember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Add-UnifiedGroupLinks.md", + "redirect_url": "/powershell/module/exchangepowershell/add-unifiedgrouplinks", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailcontact", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailcontact", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Contact.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contact", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-distributiongroupmember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dynamicdistributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-EligibleDistributionGroupForMigration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-eligibledistributiongroupformigration", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Group.md", + "redirect_url": "/powershell/module/exchangepowershell/get-group", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-LinkedUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-linkeduser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailcontact", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Recipient.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipient", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-SecurityPrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/get-securityprincipal", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedgroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-UnifiedGroupLinks.md", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedgrouplinks", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-User.md", + "redirect_url": "/powershell/module/exchangepowershell/get-user", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dynamicdistributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPMailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailcontact", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-unifiedgroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroupmember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dynamicdistributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPMailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailcontact", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedgroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-UnifiedGroupLinks.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedgrouplinks", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-Contact.md", + "redirect_url": "/powershell/module/exchangepowershell/set-contact", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dynamicdistributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-group", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPMailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-user", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-Group.md", + "redirect_url": "/powershell/module/exchangepowershell/set-group", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-LinkedUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-linkeduser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailcontact", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-unifiedgroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-User.md", + "redirect_url": "/powershell/module/exchangepowershell/set-user", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Undo-SoftDeletedUnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/undo-softdeletedunifiedgroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Update-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-distributiongroupmember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Update-EOPDistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-distributiongroupmember", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/users-and-groups/Upgrade-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/upgrade-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/office-365-scc/office-365-scc-powershell.md", + "redirect_url": "/powershell/exchange/scc-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/mfa-connect-to-scc-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-server/connect-to-exchange-servers-using-remote-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-servers-using-remote-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-server/control-remote-powershell-access-to-exchange-servers.md", + "redirect_url": "/powershell/exchange/control-remote-powershell-access-to-exchange-servers", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-server/exchange-cmdlet-syntax.md", + "redirect_url": "/powershell/exchange/exchange-cmdlet-syntax", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-server/exchange-management-shell.md", + "redirect_url": "/powershell/exchange/exchange-management-shell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-server/find-exchange-cmdlet-permissions.md", + "redirect_url": "/powershell/exchange/find-exchange-cmdlet-permissions", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-server/open-the-exchange-management-shell.md", + "redirect_url": "/powershell/exchange/open-the-exchange-management-shell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-server/use-update-exchangehelp.md", + "redirect_url": "/powershell/exchange/exchange-management-shell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/filter-properties.md", + "redirect_url": "/powershell/exchange/filter-properties", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/recipient-filters.md", + "redirect_url": "/powershell/exchange/recipient-filters", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/recipientfilter-properties.md", + "redirect_url": "/powershell/exchange/recipientfilter-properties", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-online/disable-access-to-exchange-online-powershell.md", + "redirect_url": "/powershell/exchange/disable-access-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell.md", + "redirect_url": "/powershell/exchange/exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/mfa-connect-to-exchange-online-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/app-only-auth-powershell-v2.md", + "redirect_url": "/powershell/exchange/app-only-auth-powershell-v2", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets.md", + "redirect_url": "/powershell/exchange/cmdlet-property-sets", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2.md", + "redirect_url": "/powershell/exchange/exchange-online-powershell-v2", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/filters-v2.md", + "redirect_url": "/powershell/exchange/filters-v2", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-eop/connect-to-exchange-online-protection-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/exchange-eop/exchange-online-protection-powershell.md", + "redirect_url": "/powershell/exchange/exchange-online-protection-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/mfa-connect-to-exchange-online-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/mfa-connect-to-scc-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TenantAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TenantAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UserAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UserAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailMalwareReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailSpamReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionTrafficReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UrlTrace.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksaggregatereport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-ContactList.md", + "redirect_url": "https://support.microsoft.com/office/import-contacts-to-outlook-bb796340-b58a-46c1-90c7-b549b8f3c5f8", + "redirect_document_id": false + }, + { + "source_path": "staffhub/docs-conceptual/index.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/docs-conceptual/intro.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/docs-conceptual/overview.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Add-StaffHubMember.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Add-StaffHubShift.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Add-StaffHubTeam.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Connect-StaffHub.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubMember.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubShifts.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubTeamsForTenant.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubUsersForTenant.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Import-StaffHubMember.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Import-StaffHubShift.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Import-StaffHubTeam.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Remove-StaffHubMember.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Remove-StaffHubUser.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/staffhub.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CustomNudge.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CustomNudgeAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CustomNudgeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-CustomNudge.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-CustomNudgeAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-CustomNudge.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-CustomNudgeAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CustomNudge.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CustomNudgeAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CustomNudgeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficTopReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficsummaryreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PhishFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-tenantallowblocklistspoofitems", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PhishFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-tenantallowblocklistspoofitems", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EOPMailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EOPMailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-group", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPMailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-user", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-EOPDistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-distributiongroupmember", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/use-update-exchangehelp.md", + "redirect_url": "/powershell/exchange/exchange-management-shell", + "redirect_document_id": true + }, + { + "source_path": "exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionDocumentDetail.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentmalwaremdodetailreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionDocumentReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentmalwaremdoaggregatereport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exosecopsoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-exosecopsoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exosecopsoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exophishsimoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-exophishsimoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/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/exchangepowershell/get-exophishsimoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/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/exchangepowershell/get-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActivityAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/get-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ActivityAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/new-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActivityAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActivityAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/set-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RecordLabel.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-label", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ADPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-adpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-AttachmentFilterEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-attachmentfilterentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-AvailabilityAddressSpace.md", + "redirect_url": "/powershell/module/exchangepowershell/add-availabilityaddressspace", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/add-compliancecasemember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ContentFilterPhrase.md", + "redirect_url": "/powershell/module/exchangepowershell/add-contentfilterphrase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-DatabaseAvailabilityGroupServer.md", + "redirect_url": "/powershell/module/exchangepowershell/add-databaseavailabilitygroupserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/add-distributiongroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-FederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/add-federateddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-GlobalMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/add-globalmonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-IPAllowListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipallowlistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipallowlistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-IPBlockListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipblocklistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipblocklistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxfolderpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-MailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-managementroleentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-PublicFolderAdministrativePermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-publicfolderadministrativepermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-PublicFolderClientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-publicfolderclientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-RecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-recipientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/add-resubmitrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/add-rolegroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ServerMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/add-servermonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-UnifiedGroupLinks.md", + "redirect_url": "/powershell/module/exchangepowershell/add-unifiedgrouplinks", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-VivaModuleFeaturePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/add-vivamodulefeaturepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-VivaOrgInsightsDelegatedRole.md", + "redirect_url": "/powershell/module/exchangepowershell/add-vivaorginsightsdelegatedrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ediscoverycaseadmin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Check-PurviewConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/check-purviewconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Clean-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/clean-mailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Clear-ActiveSyncDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/clear-activesyncdevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Clear-MobileDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/clear-mobiledevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Clear-TextMessagingAccount.md", + "redirect_url": "/powershell/module/exchangepowershell/clear-textmessagingaccount", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Compare-TextMessagingVerificationCode.md", + "redirect_url": "/powershell/module/exchangepowershell/compare-textmessagingverificationcode", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Complete-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/complete-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Connect-ExchangeOnline.md", + "redirect_url": "/powershell/module/exchangepowershell/connect-exchangeonline", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Connect-IPPSSession.md", + "redirect_url": "/powershell/module/exchangepowershell/connect-ippssession", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Connect-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/connect-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Delete-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/delete-quarantinemessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-AddressListPaging.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-addresslistpaging", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-App.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-cmdletextensionagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-DnssecForVerifiedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-dnssecforverifieddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-IPv6ForAcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-ipv6foraccepteddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-JournalArchiving.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-journalarchiving", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MailboxQuarantine.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailboxquarantine", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MetaCacheDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-metacachedatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-outlookanywhere", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-PushNotificationProxy.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-pushnotificationproxy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-ServiceEmailChannel.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-serviceemailchannel", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-SmtpDaneInbound.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-smtpdaneinbound", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-ummailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMServer.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disconnect-ExchangeOnline.md", + "redirect_url": "/powershell/module/exchangepowershell/disconnect-exchangeonline", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Dismount-Database.md", + "redirect_url": "/powershell/module/exchangepowershell/dismount-database", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Dump-ProvisioningCache.md", + "redirect_url": "/powershell/module/exchangepowershell/dump-provisioningcache", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-AddressListPaging.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-addresslistpaging", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-AntispamUpdates.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-antispamupdates", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-App.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-cmdletextensionagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-ComplianceTagStorage.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-compliancetagstorage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-DnssecForVerifiedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-dnssecforverifieddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-IPv6ForAcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-ipv6foraccepteddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MailboxQuarantine.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailboxquarantine", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MetaCacheDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-metacachedatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-OrganizationCustomization.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-organizationcustomization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-outlookanywhere", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-PushNotificationProxy.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-pushnotificationproxy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-ServiceEmailChannel.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-serviceemailchannel", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-SmtpDaneInbound.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-smtpdaneinbound", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-ummailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMServer.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/exchange.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/index.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Execute-AzureADLabelSync.md", + "redirect_url": "/powershell/module/exchangepowershell/execute-azureadlabelsync", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Expedite-Delicensing.md", + "redirect_url": "/powershell/module/exchangepowershell/expedite-delicensing", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-ActiveSyncLog.md", + "redirect_url": "/powershell/module/exchangepowershell/export-activesynclog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-ActivityExplorerData.md", + "redirect_url": "/powershell/module/exchangepowershell/export-activityexplorerdata", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-AutoDiscoverConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/export-autodiscoverconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-ContentExplorerData.md", + "redirect_url": "/powershell/module/exchangepowershell/export-contentexplorerdata", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-DlpPolicyCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/export-dlppolicycollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/export-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-FilePlanProperty.md", + "redirect_url": "/powershell/module/exchangepowershell/export-fileplanproperty", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-JournalRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/export-journalrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-MailboxDiagnosticLogs.md", + "redirect_url": "/powershell/module/exchangepowershell/export-mailboxdiagnosticlogs", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/export-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-MigrationReport.md", + "redirect_url": "/powershell/module/exchangepowershell/export-migrationreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/export-quarantinemessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-RecipientDataProperty.md", + "redirect_url": "/powershell/module/exchangepowershell/export-recipientdataproperty", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-TransportRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/export-transportrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-UMCallDataRecord.md", + "redirect_url": "/powershell/module/exchangepowershell/export-umcalldatarecord", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-UMPrompt.md", + "redirect_url": "/powershell/module/exchangepowershell/export-umprompt", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ADPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ADServerSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adserversettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ADSite.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adsite", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ATPBuiltInProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-atpbuiltinprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ATPTotalTrafficReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-atptotaltrafficreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-accepteddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AccessToCustomerDataRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-accesstocustomerdatarequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceautoblockthreshold", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncDeviceClass.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceclass", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncDeviceStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdevicestatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncmailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncOrganizationSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncorganizationsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdSiteLink.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adsitelink", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdaptiveScope.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adaptivescope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-addressbookpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/get-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-addressrewriteentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdminAuditLogConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adminauditlogconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdministrativeUnit.md", + "redirect_url": "/powershell/module/exchangepowershell/get-administrativeunit", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AgentLog.md", + "redirect_url": "/powershell/module/exchangepowershell/get-agentlog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AggregateZapReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-aggregatezapreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-antiphishpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-App.md", + "redirect_url": "/powershell/module/exchangepowershell/get-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AppRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-appretentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AppRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-appretentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-applicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ArcConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-arcconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AtpPolicyForO365.md", + "redirect_url": "/powershell/module/exchangepowershell/get-atppolicyforo365", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AttachmentFilterEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-attachmentfilterentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AttachmentFilterListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-attachmentfilterlistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuditConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-auditconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuditLogSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-auditlogsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuthConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authredirect", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authenticationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AutoSensitivityLabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-autosensitivitylabelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AutoSensitivityLabelRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-autosensitivitylabelrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-autodiscovervirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AvailabilityAddressSpace.md", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityaddressspace", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityreportoutage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-BlockedConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-blockedconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-BlockedSenderAddress.md", + "redirect_url": "/powershell/module/exchangepowershell/get-blockedsenderaddress", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CASMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-casmailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CASMailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/get-casmailboxplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CalendarDiagnosticAnalysis.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticanalysis", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CalendarDiagnosticLog.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticlog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CalendarDiagnosticObjects.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticobjects", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CalendarNotification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendarnotification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CalendarProcessing.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendarprocessing", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-caseholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-caseholdrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/get-classificationrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessarray", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ClientAccessServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ClientAccessService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Clutter.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clutter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-cmdletextensionagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancecase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancecasemember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceRetentionEvent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-complianceretentionevent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/get-complianceretentioneventtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesearchaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesecurityfilter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancetag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceTagStorage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancetagstorage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CompromisedUserAggregateReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compromiseduseraggregatereport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CompromisedUserDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compromiseduserdetailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ConfigAnalyzerPolicyRecommendation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-configanalyzerpolicyrecommendation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ConnectionInformation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-connectioninformation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Contact.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ContentFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ContentFilterPhrase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentfilterphrase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ContentMalwareMdoAggregateReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentmalwaremdoaggregatereport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ContentMalwareMdoDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentmalwaremdodetailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DataClassificationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataclassificationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DataEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DataRetentionReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataretentionreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/get-databaseavailabilitygroupnetwork", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DefaultTenantBriefingConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-defaulttenantbriefingconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-defaulttenantmyanalyticsfeatureconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deliveryagentconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DetailZapReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-detailzapreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DetailsTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-detailstemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconditionalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconditionalaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconfigurationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconfigurationrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DevicePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-devicepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-devicetenantpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-devicetenantrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-distributiongroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dkimsigningconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpdetailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpDetectionsReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpdetectionsreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpedmschema", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpIncidentDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpincidentdetailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpkeyworddictionary", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlppolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpPolicyTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlppolicytemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsensitiveinformationtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpSiDetectionsReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsidetectionsreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DnssecStatusForVerifiedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dnssecstatusforverifieddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DomainController.md", + "redirect_url": "/powershell/module/exchangepowershell/get-domaincontroller", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dynamicdistributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DynamicDistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dynamicdistributiongroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOCasMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exocasmailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxfolderpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMailboxFolderStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxfolderstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMailboxStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMobileDeviceStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomobiledevicestatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXORecipient.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exorecipient", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXORecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exorecipientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ecpvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EdgeSubscription.md", + "redirect_url": "/powershell/module/exchangepowershell/get-edgesubscription", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EdgeSyncServiceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-edgesyncserviceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EligibleDistributionGroupForMigration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-eligibledistributiongroupformigration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-emailaddresspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EmailTenantSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-emailtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EtrLimits.md", + "redirect_url": "/powershell/module/exchangepowershell/get-etrlimits", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EventLogLevel.md", + "redirect_url": "/powershell/module/exchangepowershell/get-eventloglevel", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EventsFromEmailConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-eventsfromemailconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeAssistanceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeassistanceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeDiagnosticInfo.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangediagnosticinfo", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeFeature.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangefeature", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeServerAccessLicense.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserveraccesslicense", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeServerAccessLicenseUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserveraccesslicenseuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangesettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExoInformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exoinformationbarrierpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExoInformationBarrierRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exoinformationbarrierrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExoInformationBarrierSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exoinformationbarriersegment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExoPhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exophishsimoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExoSecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exosecopsoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExternalInOutlook.md", + "redirect_url": "/powershell/module/exchangepowershell/get-externalinoutlook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FailedContentIndexDocuments.md", + "redirect_url": "/powershell/module/exchangepowershell/get-failedcontentindexdocuments", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FeatureConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-featureconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FederatedDomainProof.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federateddomainproof", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FederatedOrganizationIdentifier.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federatedorganizationidentifier", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FederationInformation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federationinformation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federationtrust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyAuthority.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertyauthority", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertycategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyCitation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertycitation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyDepartment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertydepartment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyReferenceId.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertyreferenceid", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyStructure.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertystructure", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertySubCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertysubcategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FocusedInbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-focusedinbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-foreignconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FrontendTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-frontendtransportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/get-globaladdresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-GlobalMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/get-globalmonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Group.md", + "redirect_url": "/powershell/module/exchangepowershell/get-group", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HealthReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-healthreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HistoricalSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-historicalsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-holdcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-holdcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HostedConnectionFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedconnectionfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedcontentfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedoutboundspamfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HybridMailflowDatacenterIPs.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hybridmailflowdatacenterips", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPAllowListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPAllowListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPAllowListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistprovidersconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPBlockListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPBlockListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPBlockListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistprovidersconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPv6StatusForAcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipv6statusforaccepteddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IRMConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-irmconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ImapSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-imapsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-inboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-InformationBarrierPoliciesApplicationStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierpoliciesapplicationstatus", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-InformationBarrierRecipientStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierrecipientstatus", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IntraOrganizationConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-intraorganizationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-intraorganizationconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/get-label", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-labelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-LinkedUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-linkeduser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-LogonStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-logonstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-M365DataAtRestEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-m365dataatrestencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-m365dataatrestencryptionpolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailATPReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailDlpPolicyReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetaildlppolicyreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailEncryptionReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailencryptionreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailTransportRuleReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailtransportrulereport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailFilterListReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailfilterlistreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficATPReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficatpreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficEncryptionReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficencryptionreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficPolicyReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficpolicyreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficSummaryReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficsummaryreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxAuditBypassAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxauditbypassassociation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxAutoReplyConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxautoreplyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxCalendarConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxcalendarconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxCalendarFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxcalendarfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxDatabaseCopyStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxdatabasecopystatus", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxExportRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxexportrequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolderpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxFolderStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolderstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxIRMAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxirmaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxImportRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboximportrequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxJunkEmailConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxjunkemailconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxLocation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxlocation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxMessageConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxmessageconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxRegionalConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxregionalconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrepairrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxRestoreRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrestorerequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxSentItemsConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxsentitemsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxSpellingConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxspellingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxtransportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxUserConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxuserconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailflowStatusReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailflowstatusreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MalwareFilteringServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilteringserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managedcontentsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managedfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managedfoldermailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagementRole.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementroleassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementroleentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementscope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mapivirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/get-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagecategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messageclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTrace.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrace", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTraceDetail.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetracedetail", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTraceDetailV2.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetracedetailv2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTraceV2.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetracev2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTrackingLog.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrackinglog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTrackingReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrackingreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationendpoint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationUserStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationuserstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MobileDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevicemailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MobileDeviceStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevicestatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MonitoringItemHelp.md", + "redirect_url": "/powershell/module/exchangepowershell/get-monitoringitemhelp", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MonitoringItemIdentity.md", + "redirect_url": "/powershell/module/exchangepowershell/get-monitoringitemidentity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MoveRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-moverequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MxRecordReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mxrecordreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MyAnalyticsFeatureConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-NetworkConnectionInfo.md", + "redirect_url": "/powershell/module/exchangepowershell/get-networkconnectioninfo", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Notification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-notification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-omeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OMEMessageStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-omemessagestatus", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-oabvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/get-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/get-onpremisesorganization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OnlineMeetingConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-onlinemeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OrganizationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationsegment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OrganizationalUnit.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationalunit", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OutboundConnectorReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outboundconnectorreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookanywhere", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-owamailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-owavirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/get-partnerapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PendingDelicenseUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-pendingdelicenseuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PendingFederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-pendingfederateddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PerimeterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-perimeterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PhishSimOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-phishsimoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Place.md", + "redirect_url": "/powershell/module/exchangepowershell/get-place", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PolicyConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-policyconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-policytipconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PopSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-popsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-powershellvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/get-protectionalert", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderAdministrativePermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderadministrativepermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderClientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderclientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderItemStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderitemstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMailboxDiagnostics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxdiagnostics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMailboxMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMigrationRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermigrationrequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMoveRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermoverequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-quarantinemessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-QuarantineMessageHeader.md", + "redirect_url": "/powershell/module/exchangepowershell/get-quarantinemessageheader", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-QuarantinePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-quarantinepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/get-queue", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-QueueDigest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-queuedigest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RMSTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rmstemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-receiveconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Recipient.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipient", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RecipientFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RecipientStatisticsReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientstatisticsreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RecordReviewNotificationTemplateConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recordreviewnotificationtemplateconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RecoverableItems.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recoverableitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RegulatoryComplianceUI.md", + "redirect_url": "/powershell/module/exchangepowershell/get-regulatorycomplianceui", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-remotedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ReportExecutionInstance.md", + "redirect_url": "/powershell/module/exchangepowershell/get-reportexecutioninstance", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ReportSubmissionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-reportsubmissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ResourceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-resourceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-resubmitrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RetentionEvent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionevent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionpolicytag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ReviewItems.md", + "redirect_url": "/powershell/module/exchangepowershell/get-reviewitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-roleassignmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rolegroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rolegroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-routinggroupconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rpcclientaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SCInsights.md", + "redirect_url": "/powershell/module/exchangepowershell/get-scinsights", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safeattachmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeLinksAggregateReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksaggregatereport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeLinksDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksdetailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinkspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/get-searchdocumentformat", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SecOpsOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-secopsoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SecurityPrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/get-securityprincipal", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sendconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SenderFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-senderfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SenderIdConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-senderidconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SenderReputationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-senderreputationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ServerComponentState.md", + "redirect_url": "/powershell/module/exchangepowershell/get-servercomponentstate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ServerHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/get-serverhealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ServerMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/get-servermonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ServiceDeliveryReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-servicedeliveryreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ServicePrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/get-serviceprincipal", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/get-settingoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sharingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SiteMailboxDiagnostics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailboxdiagnostics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailboxprovisioningpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SmimeConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-smimeconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SmtpDaneInboundStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-smtpdaneinboundstatus", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SpoofIntelligenceInsight.md", + "redirect_url": "/powershell/module/exchangepowershell/get-spoofintelligenceinsight", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SpoofMailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-spoofmailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-StoreUsageStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-storeusagestatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewActivity.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewactivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewOverallProgressReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewoverallprogressreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewPolicyReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewpolicyreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewpolicyv2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewTopCasesReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewtopcasesreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-systemmessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TeamsProtectionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-teamsprotectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TeamsProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-teamsprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TenantAllowBlockListItems.md", + "redirect_url": "/powershell/module/exchangepowershell/get-tenantallowblocklistitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TenantAllowBlockListSpoofItems.md", + "redirect_url": "/powershell/module/exchangepowershell/get-tenantallowblocklistspoofitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TextMessagingAccount.md", + "redirect_url": "/powershell/module/exchangepowershell/get-textmessagingaccount", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-throttlingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ThrottlingPolicyAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-throttlingpolicyassociation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportPipeline.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportpipeline", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportRuleAction.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportruleaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportRulePredicate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportrulepredicate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Trust.md", + "redirect_url": "/powershell/module/exchangepowershell/get-trust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMActiveCalls.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umactivecalls", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMCallDataRecord.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcalldatarecord", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMCallRouterSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallroutersettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMCallSummaryReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallsummaryreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umdialplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMHuntGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umhuntgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMMailboxPIN.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailboxpin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UmServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedauditlogretentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UnifiedGroupLinks.md", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedgrouplinks", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-User.md", + "redirect_url": "/powershell/module/exchangepowershell/get-user", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UserBriefingConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-userbriefingconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UserPhoto.md", + "redirect_url": "/powershell/module/exchangepowershell/get-userphoto", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UserPrincipalNamesSuffix.md", + "redirect_url": "/powershell/module/exchangepowershell/get-userprincipalnamessuffix", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaInsightsSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-vivainsightssettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaModuleFeature.md", + "redirect_url": "/powershell/module/exchangepowershell/get-vivamodulefeature", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaModuleFeatureEnablement.md", + "redirect_url": "/powershell/module/exchangepowershell/get-vivamodulefeatureenablement", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaModuleFeaturePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-vivamodulefeaturepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaOrgInsightsDelegatedRole.md", + "redirect_url": "/powershell/module/exchangepowershell/get-vivaorginsightsdelegatedrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-webservicesvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-x400authoritativedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ediscoverycaseadmin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-DlpPolicyCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/import-dlppolicycollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-DlpPolicyTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/import-dlppolicytemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/import-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-FilePlanProperty.md", + "redirect_url": "/powershell/module/exchangepowershell/import-fileplanproperty", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-JournalRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/import-journalrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-RecipientDataProperty.md", + "redirect_url": "/powershell/module/exchangepowershell/import-recipientdataproperty", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-TransportRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/import-transportrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-UMPrompt.md", + "redirect_url": "/powershell/module/exchangepowershell/import-umprompt", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Install-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/install-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Install-UnifiedCompliancePrerequisite.md", + "redirect_url": "/powershell/module/exchangepowershell/install-unifiedcomplianceprerequisite", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Invoke-ComplianceSearchActionStep.md", + "redirect_url": "/powershell/module/exchangepowershell/invoke-compliancesearchactionstep", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Invoke-ComplianceSecurityFilterAction.md", + "redirect_url": "/powershell/module/exchangepowershell/invoke-compliancesecurityfilteraction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Invoke-HoldRemovalAction.md", + "redirect_url": "/powershell/module/exchangepowershell/invoke-holdremovalaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Invoke-MonitoringProbe.md", + "redirect_url": "/powershell/module/exchangepowershell/invoke-monitoringprobe", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Mount-Database.md", + "redirect_url": "/powershell/module/exchangepowershell/mount-database", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Move-ActiveMailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/move-activemailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Move-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/move-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Move-DatabasePath.md", + "redirect_url": "/powershell/module/exchangepowershell/move-databasepath", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Move-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/move-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ATPBuiltInProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-atpbuiltinprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/new-accepteddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncdeviceaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncmailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AdaptiveScope.md", + "redirect_url": "/powershell/module/exchangepowershell/new-adaptivescope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-addressbookpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/new-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/new-addressrewriteentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AdminAuditLogSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-adminauditlogsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-antiphishpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-App.md", + "redirect_url": "/powershell/module/exchangepowershell/new-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AppRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-appretentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AppRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-appretentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-applicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/new-authredirect", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/new-authserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-authenticationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AutoSensitivityLabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-autosensitivitylabelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AutoSensitivityLabelRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-autosensitivitylabelrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-autodiscovervirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-availabilityconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-availabilityreportoutage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-caseholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-caseholdrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/new-classificationrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/new-clientaccessarray", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-clientaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancecase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceRetentionEvent.md", + "redirect_url": "/powershell/module/exchangepowershell/new-complianceretentionevent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/new-complianceretentioneventtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesearchaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesecurityfilter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancetag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dataclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DataEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dataencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/new-databaseavailabilitygroupnetwork", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deliveryagentconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconditionalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconditionalaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconfigurationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconfigurationrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-devicetenantpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-devicetenantrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dkimsigningconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpedmschema", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpFingerprint.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpfingerprint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpkeyworddictionary", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlppolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpsensitiveinformationtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dynamicdistributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-ecpvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EdgeSubscription.md", + "redirect_url": "/powershell/module/exchangepowershell/new-edgesubscription", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EdgeSyncServiceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-edgesyncserviceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-emailaddresspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ExchangeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exchangesettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ExoPhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exophishsimoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ExoSecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exosecopsoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FeatureConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/new-featureconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/new-federationtrust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertyAuthority.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertyauthority", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertyCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertycategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertyCitation.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertycitation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertyDepartment.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertydepartment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertyReferenceId.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertyreferenceid", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertySubCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertysubcategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-Fingerprint.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fingerprint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-foreignconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/new-globaladdresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-holdcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-holdcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedcontentfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedoutboundspamfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-inboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-informationbarrierpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-intraorganizationconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/new-label", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-labelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-M365DataAtRestEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-m365dataatrestencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailmessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxAuditLogSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxauditlogsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxrepairrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-malwarefilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managedcontentsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managedfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managedfoldermailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagementRole.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managementrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managementroleassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managementscope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mapivirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/new-messageclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/new-migrationendpoint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mobiledevicemailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/new-omeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-oabvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/new-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/new-onpremisesorganization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/new-organizationrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/new-organizationsegment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-outboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/new-outlookprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-owamailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-owavirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/new-partnerapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PhishSimOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-phishsimoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-policytipconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-powershellvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/new-protectionalert", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolderdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PublicFolderDatabaseRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolderdatabaserepairrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-QuarantinePermissions.md", + "redirect_url": "/powershell/module/exchangepowershell/new-quarantinepermissions", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-QuarantinePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-quarantinepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-receiveconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/new-remotedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/new-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ReportSubmissionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-reportsubmissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentionpolicytag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-roleassignmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-rolegroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-routinggroupconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/new-rpcclientaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safeattachmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safelinkspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/new-searchdocumentformat", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SecOpsOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-secopsoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sendconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ServicePrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/new-serviceprincipal", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/new-settingoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sharingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sitemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sitemailboxprovisioningpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/new-supervisoryreviewpolicyv2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SupervisoryReviewRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-supervisoryreviewrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SyncMailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-syncmailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-systemmessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-TeamsProtectionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-teamsprotectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-TeamsProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-teamsprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-TenantAllowBlockListItems.md", + "redirect_url": "/powershell/module/exchangepowershell/new-tenantallowblocklistitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-TenantAllowBlockListSpoofItems.md", + "redirect_url": "/powershell/module/exchangepowershell/new-tenantallowblocklistspoofitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-throttlingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umdialplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMHuntGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umhuntgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-ummailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-unifiedauditlogretentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-unifiedgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-webservicesvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/new-x400authoritativedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Preview-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/preview-quarantinemessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Redirect-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/redirect-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Release-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/release-quarantinemessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ADPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-adpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-accepteddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActiveSyncDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdeviceaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActiveSyncDeviceClass.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdeviceclass", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncmailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AdaptiveScope.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-adaptivescope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-addressbookpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-addressrewriteentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-antiphishpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-App.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AppRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-appretentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AppRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-appretentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-applicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AttachmentFilterEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-attachmentfilterentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-authredirect", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-authserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-authenticationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AutoSensitivityLabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-autosensitivitylabelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AutoSensitivityLabelRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-autosensitivitylabelrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-autodiscovervirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AvailabilityAddressSpace.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityaddressspace", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityreportoutage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-BlockedConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-blockedconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-BlockedSenderAddress.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-blockedsenderaddress", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-CalendarEvents.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-calendarevents", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-caseholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-caseholdrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-classificationrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-clientaccessarray", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-clientaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancecase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancecasemember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-complianceretentioneventtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesearchaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesecurityfilter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancetag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ContentFilterPhrase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-contentfilterphrase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dataclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroupnetwork", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DatabaseAvailabilityGroupServer.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroupserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deliveryagentconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconditionalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconditionalaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconfigurationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconfigurationrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-devicetenantpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-devicetenantrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpedmschema", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpkeyworddictionary", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlppolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpPolicyTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlppolicytemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dynamicdistributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ecpvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EdgeSubscription.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-edgesubscription", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-emailaddresspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ExoPhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-exophishsimoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ExoSecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-exosecopsoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FeatureConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-featureconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-federateddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-federationtrust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertyAuthority.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertyauthority", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertyCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertycategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertyCitation.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertycitation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertyDepartment.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertydepartment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertyReferenceId.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertyreferenceid", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertySubCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertysubcategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-foreignconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-globaladdresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-GlobalMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-globalmonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-holdcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-holdcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedcontentfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-IPAllowListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipallowlistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipallowlistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-IPBlockListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipblocklistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipblocklistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-inboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-informationbarrierpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-intraorganizationconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-label", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-labelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxfolderpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxIRMAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxirmaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxrepairrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxUserConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxuserconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-malwarefilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedcontentsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedfoldermailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagementRole.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementroleassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementroleentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementscope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mapivirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-messageclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationendpoint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MobileDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mobiledevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mobiledevicemailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-omeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-oabvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-onpremisesorganization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-organizationrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-organizationsegment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-outboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-outlookprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-owamailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-owavirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-partnerapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PhishSimOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-phishsimoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-policytipconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-powershellvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-protectionalert", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderAdministrativePermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderadministrativepermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderClientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderclientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderMailboxMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermailboxmigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-QuarantinePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-quarantinepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-receiveconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-recipientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-remotedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ReportSubmissionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-reportsubmissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-resubmitrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentionpolicytag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-roleassignmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-rolegroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-rolegroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-routinggroupconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-rpcclientaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safeattachmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safelinkspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-searchdocumentformat", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SecOpsOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-secopsoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sendconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ServerMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-servermonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ServicePrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-serviceprincipal", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-settingoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sharingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sitemailboxprovisioningpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-StoreMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-storemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-supervisoryreviewpolicyv2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SyncMailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-syncmailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-systemmessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-TenantAllowBlockListItems.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-tenantallowblocklistitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-TenantAllowBlockListSpoofItems.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-tenantallowblocklistspoofitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-throttlingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umdialplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMHuntGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umhuntgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ummailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedauditlogretentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UnifiedGroupLinks.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedgrouplinks", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UserPhoto.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-userphoto", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-VivaModuleFeaturePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-vivamodulefeaturepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-VivaOrgInsightsDelegatedRole.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-vivaorginsightsdelegatedrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-webservicesvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-x400authoritativedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ediscoverycaseadmin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Reset-ProvisioningCache.md", + "redirect_url": "/powershell/module/exchangepowershell/reset-provisioningcache", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Restore-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Restore-DetailsTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-detailstemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Restore-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Restore-RecoverableItems.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-recoverableitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-PublicFolderReplication.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfolderreplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-queue", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Retry-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/retry-queue", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Rotate-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/rotate-dkimsigningconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Search-AdminAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/search-adminauditlog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Search-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/search-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Search-MailboxAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/search-mailboxauditlog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Search-MessageTrackingReport.md", + "redirect_url": "/powershell/module/exchangepowershell/search-messagetrackingreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Search-UnifiedAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/search-unifiedauditlog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Send-TextMessagingVerificationCode.md", + "redirect_url": "/powershell/module/exchangepowershell/send-textmessagingverificationcode", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ADServerSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adserversettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ADSite.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adsite", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ATPBuiltInProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-atpbuiltinprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-accepteddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AccessToCustomerDataRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-accesstocustomerdatarequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncdeviceaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncdeviceautoblockthreshold", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncmailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActiveSyncOrganizationSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncorganizationsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AdSiteLink.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adsitelink", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AdaptiveScope.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adaptivescope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-addressbookpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/set-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/set-addressrewriteentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AdminAuditLogConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adminauditlogconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-antiphishpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-App.md", + "redirect_url": "/powershell/module/exchangepowershell/set-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AppRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-appretentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AppRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-appretentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-applicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ArcConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-arcconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AtpPolicyForO365.md", + "redirect_url": "/powershell/module/exchangepowershell/set-atppolicyforo365", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AttachmentFilterListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-attachmentfilterlistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuditConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-auditconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuthConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authredirect", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authenticationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AutoSensitivityLabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-autosensitivitylabelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AutoSensitivityLabelRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-autosensitivitylabelrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-autodiscovervirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-availabilityconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/set-availabilityreportoutage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CASMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-casmailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CASMailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/set-casmailboxplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CalendarNotification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-calendarnotification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CalendarProcessing.md", + "redirect_url": "/powershell/module/exchangepowershell/set-calendarprocessing", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-caseholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-caseholdrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/set-classificationrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessarray", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ClientAccessServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ClientAccessService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Clutter.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clutter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/set-cmdletextensionagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancecase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/set-complianceretentioneventtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesearchaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesecurityfilter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancetag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Contact.md", + "redirect_url": "/powershell/module/exchangepowershell/set-contact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ContentFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-contentfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dataclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DataEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dataencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/set-databaseavailabilitygroupnetwork", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DefaultTenantBriefingConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-defaulttenantbriefingconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-defaulttenantmyanalyticsfeatureconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deliveryagentconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DetailsTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/set-detailstemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconditionalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconditionalaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconfigurationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconfigurationrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-devicetenantpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-devicetenantrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dkimsigningconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpedmschema", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpkeyworddictionary", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlppolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpsensitiveinformationtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dynamicdistributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ecpvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EdgeSyncServiceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-edgesyncserviceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-emailaddresspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EmailTenantSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-emailtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EventLogLevel.md", + "redirect_url": "/powershell/module/exchangepowershell/set-eventloglevel", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EventsFromEmailConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-eventsfromemailconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExchangeAssistanceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangeassistanceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExchangeFeature.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangefeature", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExchangeServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangeserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExchangeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangesettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExoPhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exophishsimoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExoSecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exosecopsoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExternalInOutlook.md", + "redirect_url": "/powershell/module/exchangepowershell/set-externalinoutlook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FeatureConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-featureconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FederatedOrganizationIdentifier.md", + "redirect_url": "/powershell/module/exchangepowershell/set-federatedorganizationidentifier", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/set-federationtrust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertyAuthority.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertyauthority", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertyCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertycategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertyCitation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertycitation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertyDepartment.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertydepartment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertyReferenceId.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertyreferenceid", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertySubCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertysubcategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FocusedInbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-focusedinbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-foreignconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FrontendTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-frontendtransportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/set-globaladdresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Group.md", + "redirect_url": "/powershell/module/exchangepowershell/set-group", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-holdcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-holdcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HostedConnectionFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedconnectionfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedcontentfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedoutboundspamfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPAllowListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPAllowListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistprovidersconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPBlockListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPBlockListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistprovidersconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IRMConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-irmconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ImapSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-imapsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-inboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-informationbarrierpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-intraorganizationconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/set-label", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-labelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-LinkedUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-linkeduser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-M365DataAtRestEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-m365dataatrestencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/set-m365dataatrestencryptionpolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxAuditBypassAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxauditbypassassociation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxAutoReplyConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxautoreplyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxCalendarConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxcalendarconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxCalendarFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxcalendarfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxfolderpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxIRMAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxirmaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxJunkEmailConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxjunkemailconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxMessageConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxmessageconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxRegionalConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxregionalconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxSentItemsConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxsentitemsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxSpellingConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxspellingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxtransportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MalwareFilteringServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilteringserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managedcontentsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managedfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managedfoldermailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managementroleassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managementroleentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managementscope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mapivirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-messageclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MigrationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationendpoint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mobiledevicemailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MyAnalyticsFeatureConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-myanalyticsfeatureconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Notification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-notification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-omeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OMEMessageRevocation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-omemessagerevocation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-oabvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/set-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/set-onpremisesorganization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OrganizationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationsegment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookanywhere", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-owamailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-owavirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/set-partnerapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PendingFederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-pendingfederateddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PerimeterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-perimeterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PhishSimOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-phishsimoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Place.md", + "redirect_url": "/powershell/module/exchangepowershell/set-place", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PolicyConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-policyconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-policytipconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PopSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-popsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-powershellvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/set-protectionalert", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfolderdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-QuarantinePermissions.md", + "redirect_url": "/powershell/module/exchangepowershell/set-quarantinepermissions", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-QuarantinePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-quarantinepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RMSTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/set-rmstemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-receiveconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RecipientFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-recipientfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RecordReviewNotificationTemplateConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-recordreviewnotificationtemplateconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RegulatoryComplianceUI.md", + "redirect_url": "/powershell/module/exchangepowershell/set-regulatorycomplianceui", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-remotedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ReportSubmissionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-reportsubmissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ResourceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-resourceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-resubmitrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentionpolicytag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-roleassignmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-rolegroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-routinggroupconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/set-rpcclientaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safeattachmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safelinkspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/set-searchdocumentformat", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SecOpsOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-secopsoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sendconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SenderFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-senderfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SenderIdConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-senderidconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SenderReputationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-senderreputationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ServerComponentState.md", + "redirect_url": "/powershell/module/exchangepowershell/set-servercomponentstate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ServerMonitor.md", + "redirect_url": "/powershell/module/exchangepowershell/set-servermonitor", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ServicePrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/set-serviceprincipal", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/set-settingoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sharingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sitemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sitemailboxprovisioningpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SmimeConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-smimeconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/set-supervisoryreviewpolicyv2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SupervisoryReviewRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-supervisoryreviewrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/set-systemmessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TeamsProtectionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-teamsprotectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TeamsProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-teamsprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TenantAllowBlockListItems.md", + "redirect_url": "/powershell/module/exchangepowershell/set-tenantallowblocklistitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TenantAllowBlockListSpoofItems.md", + "redirect_url": "/powershell/module/exchangepowershell/set-tenantallowblocklistspoofitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TextMessagingAccount.md", + "redirect_url": "/powershell/module/exchangepowershell/set-textmessagingaccount", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-throttlingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ThrottlingPolicyAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-throttlingpolicyassociation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TransportConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TransportServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMCallRouterSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umcallroutersettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umdialplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMMailboxPIN.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailboxpin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UmServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-unifiedauditlogretentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-unifiedgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-User.md", + "redirect_url": "/powershell/module/exchangepowershell/set-user", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UserBriefingConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-userbriefingconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UserPhoto.md", + "redirect_url": "/powershell/module/exchangepowershell/set-userphoto", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-VivaInsightsSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-vivainsightssettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-webservicesvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-x400authoritativedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/start-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-EdgeSynchronization.md", + "redirect_url": "/powershell/module/exchangepowershell/start-edgesynchronization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-HistoricalSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-historicalsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-InformationBarrierPoliciesApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/start-informationbarrierpoliciesapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-MailboxAssistant.md", + "redirect_url": "/powershell/module/exchangepowershell/start-mailboxassistant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-ManagedFolderAssistant.md", + "redirect_url": "/powershell/module/exchangepowershell/start-managedfolderassistant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/start-migrationuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-RetentionAutoTagLearning.md", + "redirect_url": "/powershell/module/exchangepowershell/start-retentionautotaglearning", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-HistoricalSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-historicalsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-InformationBarrierPoliciesApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-informationbarrierpoliciesapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-ManagedFolderAssistant.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-managedfolderassistant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-migrationuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-PublicFolderMailboxMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermailboxmigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-PublicFolderReplication.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfolderreplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-queue", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ActiveSyncConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-activesyncconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/test-applicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ArchiveConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-archiveconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-AssistantHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-assistanthealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-CalendarConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-calendarconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/test-clientaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/test-dataclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-EcpConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-ecpconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-EdgeSynchronization.md", + "redirect_url": "/powershell/module/exchangepowershell/test-edgesynchronization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ExchangeSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/test-exchangesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/test-federationtrust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-FederationTrustCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/test-federationtrustcertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/test-ipallowlistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/test-ipblocklistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-IRMConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/test-irmconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ImapConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-imapconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-M365DataAtRestEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/test-m365dataatrestencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-MAPIConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-mapiconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-MRSHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-mrshealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-Mailflow.md", + "redirect_url": "/powershell/module/exchangepowershell/test-mailflow", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/test-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-MigrationServerAvailability.md", + "redirect_url": "/powershell/module/exchangepowershell/test-migrationserveravailability", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-OAuthConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-oauthconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/test-organizationrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-OutlookConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-outlookconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-OutlookWebServices.md", + "redirect_url": "/powershell/module/exchangepowershell/test-outlookwebservices", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-OwaConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-owaconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-PopConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-popconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-PowerShellConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-powershellconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ReplicationHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-replicationhealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-SenderId.md", + "redirect_url": "/powershell/module/exchangepowershell/test-senderid", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ServiceHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-servicehealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ServicePrincipalAuthorization.md", + "redirect_url": "/powershell/module/exchangepowershell/test-serviceprincipalauthorization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/test-sitemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-SmtpConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-smtpconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-SystemHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-systemhealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-TextExtraction.md", + "redirect_url": "/powershell/module/exchangepowershell/test-textextraction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-UMConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-umconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-WebServicesConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-webservicesconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Undo-SoftDeletedMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/undo-softdeletedmailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Undo-SoftDeletedUnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/undo-softdeletedunifiedgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Uninstall-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/uninstall-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/update-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-compliancecasemember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-DatabaseSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/update-databaseschema", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-distributiongroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-emailaddresspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-ExchangeHelp.md", + "redirect_url": "/powershell/module/exchangepowershell/update-exchangehelp", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-FileDistributionService.md", + "redirect_url": "/powershell/module/exchangepowershell/update-filedistributionservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/update-globaladdresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/update-hybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/update-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-PublicFolderHierarchy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfolderhierarchy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-PublicFolderMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfoldermailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-Recipient.md", + "redirect_url": "/powershell/module/exchangepowershell/update-recipient", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-rolegroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-SafeList.md", + "redirect_url": "/powershell/module/exchangepowershell/update-safelist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/update-sitemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-StoreMailboxState.md", + "redirect_url": "/powershell/module/exchangepowershell/update-storemailboxstate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-VivaModuleFeaturePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-vivamodulefeaturepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/update-ediscoverycaseadmin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Upgrade-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/upgrade-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Validate-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/validate-outboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Validate-RetentionRuleQuery.md", + "redirect_url": "/powershell/module/exchangepowershell/validate-retentionrulequery", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Write-AdminAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/write-adminauditlog", + "redirect_document_id": true + } + ] +} diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json deleted file mode 100644 index 6a71f4fa5c..0000000000 --- a/.openpublishing.redirection.json +++ /dev/null @@ -1,8961 +0,0 @@ -{ - "redirections": [ - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpEdmSschema.md", - "redirect_url": "/powershell/module/exchange/new-dlpedmschema", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-TeamsRetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/get-retentioncompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-TeamsRetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/get-retentioncompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-TeamsRetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/new-retentioncompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-TeamsRetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/new-retentioncompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-TeamsRetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/remove-retentioncompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-TeamsRetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/remove-retentioncompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-TeamsRetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/set-retentioncompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-TeamsRetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/set-retentioncompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpComplianceRuleV2.md", - "redirect_url": "/powershell/module/exchange/get-dlpcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpComplianceRuleV2.md", - "redirect_url": "/powershell/module/exchange/new-dlpcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRuleV2.md", - "redirect_url": "/powershell/module/exchange/remove-dlpcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpComplianceRuleV2.md", - "redirect_url": "/powershell/module/exchange/set-dlpcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/exchange-ps-v2-module/connect-exchangeonline.md", - "redirect_url": "/powershell/module/exchange/connect-exchangeonline", - "redirect_document_id": true - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Test-ExchangeUMCallFlow.md", - "redirect_url": "https://www.microsoft.com/download/details.aspx?id=20839", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-ConnectSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-HotmailSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-ImapSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-PopSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-SendAddress.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Get-Subscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/New-ConnectSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/New-HotmailSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/New-ImapSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/New-PopSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/New-Subscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Remove-ConnectSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Remove-Subscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Set-ConnectSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Set-HotmailSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Set-ImapSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/connected-accounts/Set-PopSubscription.md", - "redirect_url": "https://support.office.com/article/5cc526bf-e928-4a99-8b9f-5e089df7d887", - "redirect_document_id": false - }, - { - "source_path": "sharepoint/docs-conceptual/overview.md", - "redirect_url": "/powershell/sharepoint", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Add-ADPermission.md", - "redirect_url": "/powershell/module/exchange/add-adpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Dump-ProvisioningCache.md", - "redirect_url": "/powershell/module/exchange/dump-provisioningcache", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADPermission.md", - "redirect_url": "/powershell/module/exchange/get-adpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADServerSettings.md", - "redirect_url": "/powershell/module/exchange/get-adserversettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADSite.md", - "redirect_url": "/powershell/module/exchange/get-adsite", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Get-AdSiteLink.md", - "redirect_url": "/powershell/module/exchange/get-adsitelink", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Get-DomainController.md", - "redirect_url": "/powershell/module/exchange/get-domaincontroller", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Get-OrganizationalUnit.md", - "redirect_url": "/powershell/module/exchange/get-organizationalunit", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Get-Trust.md", - "redirect_url": "/powershell/module/exchange/get-trust", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Get-UserPrincipalNamesSuffix.md", - "redirect_url": "/powershell/module/exchange/get-userprincipalnamessuffix", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Remove-ADPermission.md", - "redirect_url": "/powershell/module/exchange/remove-adpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Reset-ProvisioningCache.md", - "redirect_url": "/powershell/module/exchange/reset-provisioningcache", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Set-ADServerSettings.md", - "redirect_url": "/powershell/module/exchange/set-adserversettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Set-ADSite.md", - "redirect_url": "/powershell/module/exchange/set-adsite", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/active-directory/Set-AdSiteLink.md", - "redirect_url": "/powershell/module/exchange/set-adsitelink", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/disable-antiphishrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/disable-safeattachmentrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/disable-safelinksrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/enable-antiphishrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/enable-safeattachmentrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/enable-safelinksrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentDetail.md", - "redirect_url": "/powershell/module/exchange/get-advancedthreatprotectiondocumentdetail", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentReport.md", - "redirect_url": "/powershell/module/exchange/get-advancedthreatprotectiondocumentreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionTrafficReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AntiPhishPolicy.md", - "redirect_url": "/powershell/module/exchange/get-antiphishpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/get-antiphishrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AtpPolicyForO365.md", - "redirect_url": "/powershell/module/exchange/get-atppolicyforo365", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-MailDetailATPReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-MailTrafficATPReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficatpreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-tenantallowblocklistspoofitems", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeAttachmentPolicy.md", - "redirect_url": "/powershell/module/exchange/get-safeattachmentpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/get-safeattachmentrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeLinksPolicy.md", - "redirect_url": "/powershell/module/exchange/get-safelinkspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/get-safelinksrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SpoofMailReport.md", - "redirect_url": "/powershell/module/exchange/get-spoofmailreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-UrlTrace.md", - "redirect_url": "/powershell/module/exchange/get-safelinksaggregatereport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-AntiPhishPolicy.md", - "redirect_url": "/powershell/module/exchange/new-antiphishpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/new-antiphishrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeAttachmentPolicy.md", - "redirect_url": "/powershell/module/exchange/new-safeattachmentpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/new-safeattachmentrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeLinksPolicy.md", - "redirect_url": "/powershell/module/exchange/new-safelinkspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/new-safelinksrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-AntiPhishPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-antiphishpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/remove-antiphishrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeAttachmentPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-safeattachmentpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/remove-safeattachmentrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeLinksPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-safelinkspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/remove-safelinksrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AntiPhishPolicy.md", - "redirect_url": "/powershell/module/exchange/set-antiphishpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/set-antiphishrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AtpPolicyForO365.md", - "redirect_url": "/powershell/module/exchange/set-atppolicyforo365", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-tenantallowblocklistspoofitems", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeAttachmentPolicy.md", - "redirect_url": "/powershell/module/exchange/set-safeattachmentpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/set-safeattachmentrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeLinksPolicy.md", - "redirect_url": "/powershell/module/exchange/set-safelinkspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/set-safelinksrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-AttachmentFilterEntry.md", - "redirect_url": "/powershell/module/exchange/add-attachmentfilterentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-ContentFilterPhrase.md", - "redirect_url": "/powershell/module/exchange/add-contentfilterphrase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPAllowListEntry.md", - "redirect_url": "/powershell/module/exchange/add-ipallowlistentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPAllowListProvider.md", - "redirect_url": "/powershell/module/exchange/add-ipallowlistprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPBlockListEntry.md", - "redirect_url": "/powershell/module/exchange/add-ipblocklistentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPBlockListProvider.md", - "redirect_url": "/powershell/module/exchange/add-ipblocklistprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Delete-QuarantineMessage.md", - "redirect_url": "/powershell/module/exchange/delete-quarantinemessage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/disable-hostedcontentfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/disable-hostedoutboundspamfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/disable-malwarefilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-AntispamUpdates.md", - "redirect_url": "/powershell/module/exchange/enable-antispamupdates", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/enable-hostedcontentfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/enable-hostedoutboundspamfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/enable-malwarefilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Export-QuarantineMessage.md", - "redirect_url": "/powershell/module/exchange/export-quarantinemessage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AgentLog.md", - "redirect_url": "/powershell/module/exchange/get-agentlog", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AttachmentFilterEntry.md", - "redirect_url": "/powershell/module/exchange/get-attachmentfilterentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AttachmentFilterListConfig.md", - "redirect_url": "/powershell/module/exchange/get-attachmentfilterlistconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-BlockedSenderAddress.md", - "redirect_url": "/powershell/module/exchange/get-blockedsenderaddress", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-ContentFilterConfig.md", - "redirect_url": "/powershell/module/exchange/get-contentfilterconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-ContentFilterPhrase.md", - "redirect_url": "/powershell/module/exchange/get-contentfilterphrase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-DkimSigningConfig.md", - "redirect_url": "/powershell/module/exchange/get-dkimsigningconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedConnectionFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-hostedconnectionfilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedContentFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-hostedcontentfilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/get-hostedcontentfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-hostedoutboundspamfilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/get-hostedoutboundspamfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListConfig.md", - "redirect_url": "/powershell/module/exchange/get-ipallowlistconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListEntry.md", - "redirect_url": "/powershell/module/exchange/get-ipallowlistentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListProvider.md", - "redirect_url": "/powershell/module/exchange/get-ipallowlistprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListProvidersConfig.md", - "redirect_url": "/powershell/module/exchange/get-ipallowlistprovidersconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListConfig.md", - "redirect_url": "/powershell/module/exchange/get-ipblocklistconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListEntry.md", - "redirect_url": "/powershell/module/exchange/get-ipblocklistentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListProvider.md", - "redirect_url": "/powershell/module/exchange/get-ipblocklistprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListProvidersConfig.md", - "redirect_url": "/powershell/module/exchange/get-ipblocklistprovidersconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MailboxJunkEmailConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxjunkemailconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilteringServer.md", - "redirect_url": "/powershell/module/exchange/get-malwarefilteringserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-malwarefilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/get-malwarefilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-QuarantineMessage.md", - "redirect_url": "/powershell/module/exchange/get-quarantinemessage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-QuarantineMessageHeader.md", - "redirect_url": "/powershell/module/exchange/get-quarantinemessageheader", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-RecipientFilterConfig.md", - "redirect_url": "/powershell/module/exchange/get-recipientfilterconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderFilterConfig.md", - "redirect_url": "/powershell/module/exchange/get-senderfilterconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderIdConfig.md", - "redirect_url": "/powershell/module/exchange/get-senderidconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderReputationConfig.md", - "redirect_url": "/powershell/module/exchange/get-senderreputationconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-DkimSigningConfig.md", - "redirect_url": "/powershell/module/exchange/new-dkimsigningconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedContentFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/new-hostedcontentfilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/new-hostedcontentfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/new-hostedoutboundspamfilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/new-hostedoutboundspamfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-MalwareFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/new-malwarefilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/new-malwarefilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Preview-QuarantineMessage.md", - "redirect_url": "/powershell/module/exchange/preview-quarantinemessage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Release-QuarantineMessage.md", - "redirect_url": "/powershell/module/exchange/release-quarantinemessage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-AttachmentFilterEntry.md", - "redirect_url": "/powershell/module/exchange/remove-attachmentfilterentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-BlockedSenderAddress.md", - "redirect_url": "/powershell/module/exchange/remove-blockedsenderaddress", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-ContentFilterPhrase.md", - "redirect_url": "/powershell/module/exchange/remove-contentfilterphrase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedContentFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-hostedcontentfilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/remove-hostedcontentfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-hostedoutboundspamfilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/remove-hostedoutboundspamfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPAllowListEntry.md", - "redirect_url": "/powershell/module/exchange/remove-ipallowlistentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPAllowListProvider.md", - "redirect_url": "/powershell/module/exchange/remove-ipallowlistprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPBlockListEntry.md", - "redirect_url": "/powershell/module/exchange/remove-ipblocklistentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPBlockListProvider.md", - "redirect_url": "/powershell/module/exchange/remove-ipblocklistprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-MalwareFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-malwarefilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/remove-malwarefilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Rotate-DkimSigningConfig.md", - "redirect_url": "/powershell/module/exchange/rotate-dkimsigningconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-AttachmentFilterListConfig.md", - "redirect_url": "/powershell/module/exchange/set-attachmentfilterlistconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-ContentFilterConfig.md", - "redirect_url": "/powershell/module/exchange/set-contentfilterconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-DkimSigningConfig.md", - "redirect_url": "/powershell/module/exchange/set-dkimsigningconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedConnectionFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-hostedconnectionfilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedContentFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-hostedcontentfilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/set-hostedcontentfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-hostedoutboundspamfilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/set-hostedoutboundspamfilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListConfig.md", - "redirect_url": "/powershell/module/exchange/set-ipallowlistconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListProvider.md", - "redirect_url": "/powershell/module/exchange/set-ipallowlistprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListProvidersConfig.md", - "redirect_url": "/powershell/module/exchange/set-ipallowlistprovidersconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListConfig.md", - "redirect_url": "/powershell/module/exchange/set-ipblocklistconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListProvider.md", - "redirect_url": "/powershell/module/exchange/set-ipblocklistprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListProvidersConfig.md", - "redirect_url": "/powershell/module/exchange/set-ipblocklistprovidersconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MailboxJunkEmailConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxjunkemailconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilteringServer.md", - "redirect_url": "/powershell/module/exchange/set-malwarefilteringserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-malwarefilterpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/set-malwarefilterrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-RecipientFilterConfig.md", - "redirect_url": "/powershell/module/exchange/set-recipientfilterconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderFilterConfig.md", - "redirect_url": "/powershell/module/exchange/set-senderfilterconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderIdConfig.md", - "redirect_url": "/powershell/module/exchange/set-senderidconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderReputationConfig.md", - "redirect_url": "/powershell/module/exchange/set-senderreputationconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-IPAllowListProvider.md", - "redirect_url": "/powershell/module/exchange/test-ipallowlistprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-IPBlockListProvider.md", - "redirect_url": "/powershell/module/exchange/test-ipblocklistprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-SenderId.md", - "redirect_url": "/powershell/module/exchange/test-senderid", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Update-SafeList.md", - "redirect_url": "/powershell/module/exchange/update-safelist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Clear-TextMessagingAccount.md", - "redirect_url": "/powershell/module/exchange/clear-textmessagingaccount", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Compare-TextMessagingVerificationCode.md", - "redirect_url": "/powershell/module/exchange/compare-textmessagingverificationcode", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Disable-PushNotificationProxy.md", - "redirect_url": "/powershell/module/exchange/disable-pushnotificationproxy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Enable-PushNotificationProxy.md", - "redirect_url": "/powershell/module/exchange/enable-pushnotificationproxy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Export-AutoDiscoverConfig.md", - "redirect_url": "/powershell/module/exchange/export-autodiscoverconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-CASMailbox.md", - "redirect_url": "/powershell/module/exchange/get-casmailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-CASMailboxPlan.md", - "redirect_url": "/powershell/module/exchange/get-casmailboxplan", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-ClientAccessRule.md", - "redirect_url": "/powershell/module/exchange/get-clientaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-ImapSettings.md", - "redirect_url": "/powershell/module/exchange/get-imapsettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxCalendarConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxcalendarconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxMessageConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxmessageconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxRegionalConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxregionalconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxSpellingConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxspellingconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-OutlookProvider.md", - "redirect_url": "/powershell/module/exchange/get-outlookprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-OwaMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/get-owamailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-PopSettings.md", - "redirect_url": "/powershell/module/exchange/get-popsettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Get-TextMessagingAccount.md", - "redirect_url": "/powershell/module/exchange/get-textmessagingaccount", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/New-ClientAccessRule.md", - "redirect_url": "/powershell/module/exchange/new-clientaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/New-OutlookProvider.md", - "redirect_url": "/powershell/module/exchange/new-outlookprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/New-OwaMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/new-owamailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Remove-ClientAccessRule.md", - "redirect_url": "/powershell/module/exchange/remove-clientaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Remove-OutlookProvider.md", - "redirect_url": "/powershell/module/exchange/remove-outlookprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Remove-OwaMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-owamailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Send-TextMessagingVerificationCode.md", - "redirect_url": "/powershell/module/exchange/send-textmessagingverificationcode", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-CASMailbox.md", - "redirect_url": "/powershell/module/exchange/set-casmailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/set-CASMailboxPlan.md", - "redirect_url": "/powershell/module/exchange/set-casmailboxplan", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-ClientAccessRule.md", - "redirect_url": "/powershell/module/exchange/set-clientaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-ImapSettings.md", - "redirect_url": "/powershell/module/exchange/set-imapsettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxCalendarConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxcalendarconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxMessageConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxmessageconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxRegionalConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxregionalconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxSpellingConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxspellingconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-OutlookProvider.md", - "redirect_url": "/powershell/module/exchange/set-outlookprovider", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-OwaMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/set-owamailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-PopSettings.md", - "redirect_url": "/powershell/module/exchange/set-popsettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Set-TextMessagingAccount.md", - "redirect_url": "/powershell/module/exchange/set-textmessagingaccount", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Test-CalendarConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-calendarconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Test-ClientAccessRule.md", - "redirect_url": "/powershell/module/exchange/test-clientaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Test-EcpConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-ecpconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Test-ImapConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-imapconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Test-OutlookConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-outlookconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Test-OutlookWebServices.md", - "redirect_url": "/powershell/module/exchange/test-outlookwebservices", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Test-OwaConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-owaconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Test-PopConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-popconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Test-PowerShellConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-powershellconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access/Test-WebServicesConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-webservicesconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Disable-OutlookAnywhere.md", - "redirect_url": "/powershell/module/exchange/disable-outlookanywhere", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Enable-OutlookAnywhere.md", - "redirect_url": "/powershell/module/exchange/enable-outlookanywhere", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ActiveSyncVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-activesyncvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-AuthRedirect.md", - "redirect_url": "/powershell/module/exchange/get-authredirect", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-AutodiscoverVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-autodiscovervirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessArray.md", - "redirect_url": "/powershell/module/exchange/get-clientaccessarray", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessServer.md", - "redirect_url": "/powershell/module/exchange/get-clientaccessserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessService.md", - "redirect_url": "/powershell/module/exchange/get-clientaccessservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-EcpVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-ecpvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-MapiVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-mapivirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-OutlookAnywhere.md", - "redirect_url": "/powershell/module/exchange/get-outlookanywhere", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-OwaVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-owavirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-PowerShellVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-powershellvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-RpcClientAccess.md", - "redirect_url": "/powershell/module/exchange/get-rpcclientaccess", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-WebServicesVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-webservicesvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-ActiveSyncVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-activesyncvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-AuthRedirect.md", - "redirect_url": "/powershell/module/exchange/new-authredirect", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-AutodiscoverVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-autodiscovervirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-ClientAccessArray.md", - "redirect_url": "/powershell/module/exchange/new-clientaccessarray", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-EcpVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-ecpvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-MapiVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-mapivirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-OwaVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-owavirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-PowerShellVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-powershellvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-RpcClientAccess.md", - "redirect_url": "/powershell/module/exchange/new-rpcclientaccess", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-WebServicesVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-webservicesvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-ActiveSyncVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-activesyncvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-AuthRedirect.md", - "redirect_url": "/powershell/module/exchange/remove-authredirect", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-AutodiscoverVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-autodiscovervirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-ClientAccessArray.md", - "redirect_url": "/powershell/module/exchange/remove-clientaccessarray", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-EcpVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-ecpvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-MapiVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-mapivirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-OwaVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-owavirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-PowerShellVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-powershellvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-RpcClientAccess.md", - "redirect_url": "/powershell/module/exchange/remove-rpcclientaccess", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-WebServicesVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-webservicesvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ActiveSyncVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-activesyncvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-AuthRedirect.md", - "redirect_url": "/powershell/module/exchange/set-authredirect", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-AutodiscoverVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-autodiscovervirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessArray.md", - "redirect_url": "/powershell/module/exchange/set-clientaccessarray", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessServer.md", - "redirect_url": "/powershell/module/exchange/set-clientaccessserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessService.md", - "redirect_url": "/powershell/module/exchange/set-clientaccessservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-EcpVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-ecpvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-MapiVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-mapivirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-OutlookAnywhere.md", - "redirect_url": "/powershell/module/exchange/set-outlookanywhere", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-OwaVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-owavirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-PowerShellVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-powershellvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-RpcClientAccess.md", - "redirect_url": "/powershell/module/exchange/set-rpcclientaccess", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-WebServicesVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-webservicesvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Add-DatabaseAvailabilityGroupServer.md", - "redirect_url": "/powershell/module/exchange/add-databaseavailabilitygroupserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Add-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/add-mailboxdatabasecopy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/get-databaseavailabilitygroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "/powershell/module/exchange/get-databaseavailabilitygroupnetwork", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-MailboxDatabaseCopyStatus.md", - "redirect_url": "/powershell/module/exchange/get-mailboxdatabasecopystatus", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Move-ActiveMailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/move-activemailboxdatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/New-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/new-databaseavailabilitygroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/New-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "/powershell/module/exchange/new-databaseavailabilitygroupnetwork", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/remove-databaseavailabilitygroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "/powershell/module/exchange/remove-databaseavailabilitygroupnetwork", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupServer.md", - "redirect_url": "/powershell/module/exchange/remove-databaseavailabilitygroupserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxdatabasecopy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Restore-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/restore-databaseavailabilitygroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Resume-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/resume-mailboxdatabasecopy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/set-databaseavailabilitygroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "/powershell/module/exchange/set-databaseavailabilitygroupnetwork", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/set-mailboxdatabasecopy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Start-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/start-databaseavailabilitygroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Stop-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/stop-databaseavailabilitygroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Suspend-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/suspend-mailboxdatabasecopy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Test-ReplicationHealth.md", - "redirect_url": "/powershell/module/exchange/test-replicationhealth", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Update-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/update-mailboxdatabasecopy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Clear-ActiveSyncDevice.md", - "redirect_url": "/powershell/module/exchange/clear-activesyncdevice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Clear-MobileDevice.md", - "redirect_url": "/powershell/module/exchange/clear-mobiledevice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Export-ActiveSyncLog.md", - "redirect_url": "/powershell/module/exchange/export-activesynclog", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDevice.md", - "redirect_url": "/powershell/module/exchange/get-activesyncdevice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceAccessRule.md", - "redirect_url": "/powershell/module/exchange/get-activesyncdeviceaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceAutoblockThreshold.md", - "redirect_url": "/powershell/module/exchange/get-activesyncdeviceautoblockthreshold", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceClass.md", - "redirect_url": "/powershell/module/exchange/get-activesyncdeviceclass", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceStatistics.md", - "redirect_url": "/powershell/module/exchange/get-activesyncdevicestatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/get-activesyncmailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncOrganizationSettings.md", - "redirect_url": "/powershell/module/exchange/get-activesyncorganizationsettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConditionalAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/get-deviceconditionalaccesspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConditionalAccessRule.md", - "redirect_url": "/powershell/module/exchange/get-deviceconditionalaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/get-deviceconfigurationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/get-deviceconfigurationrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-DevicePolicy.md", - "redirect_url": "/powershell/module/exchange/get-devicepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceTenantPolicy.md", - "redirect_url": "/powershell/module/exchange/get-devicetenantpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceTenantRule.md", - "redirect_url": "/powershell/module/exchange/get-devicetenantrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDevice.md", - "redirect_url": "/powershell/module/exchange/get-mobiledevice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDeviceMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/get-mobiledevicemailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDeviceStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mobiledevicestatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/New-ActiveSyncDeviceAccessRule.md", - "redirect_url": "/powershell/module/exchange/new-activesyncdeviceaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/New-ActiveSyncMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/new-activesyncmailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConditionalAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/new-deviceconditionalaccesspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConditionalAccessRule.md", - "redirect_url": "/powershell/module/exchange/new-deviceconditionalaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/new-deviceconfigurationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/new-deviceconfigurationrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceTenantPolicy.md", - "redirect_url": "/powershell/module/exchange/new-devicetenantpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceTenantRule.md", - "redirect_url": "/powershell/module/exchange/new-devicetenantrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/New-MobileDeviceMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/new-mobiledevicemailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDevice.md", - "redirect_url": "/powershell/module/exchange/remove-activesyncdevice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDeviceAccessRule.md", - "redirect_url": "/powershell/module/exchange/remove-activesyncdeviceaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDeviceClass.md", - "redirect_url": "/powershell/module/exchange/remove-activesyncdeviceclass", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-activesyncmailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConditionalAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-deviceconditionalaccesspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConditionalAccessRule.md", - "redirect_url": "/powershell/module/exchange/remove-deviceconditionalaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-deviceconfigurationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/remove-deviceconfigurationrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceTenantPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-devicetenantpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceTenantRule.md", - "redirect_url": "/powershell/module/exchange/remove-devicetenantrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-MobileDevice.md", - "redirect_url": "/powershell/module/exchange/remove-mobiledevice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Remove-MobileDeviceMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-mobiledevicemailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncDeviceAccessRule.md", - "redirect_url": "/powershell/module/exchange/set-activesyncdeviceaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncDeviceAutoblockThreshold.md", - "redirect_url": "/powershell/module/exchange/set-activesyncdeviceautoblockthreshold", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/set-activesyncmailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncOrganizationSettings.md", - "redirect_url": "/powershell/module/exchange/set-activesyncorganizationsettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConditionalAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/set-deviceconditionalaccesspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConditionalAccessRule.md", - "redirect_url": "/powershell/module/exchange/set-deviceconditionalaccessrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/set-deviceconfigurationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/set-deviceconfigurationrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceTenantPolicy.md", - "redirect_url": "/powershell/module/exchange/set-devicetenantpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceTenantRule.md", - "redirect_url": "/powershell/module/exchange/set-devicetenantrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Set-MobileDeviceMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/set-mobiledevicemailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/devices/Test-ActiveSyncConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-activesyncconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Disable-AddressListPaging.md", - "redirect_url": "/powershell/module/exchange/disable-addresslistpaging", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Enable-AddressListPaging.md", - "redirect_url": "/powershell/module/exchange/enable-addresslistpaging", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-AddressBookPolicy.md", - "redirect_url": "/powershell/module/exchange/get-addressbookpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-AddressList.md", - "redirect_url": "/powershell/module/exchange/get-addresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-DetailsTemplate.md", - "redirect_url": "/powershell/module/exchange/get-detailstemplate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-EmailAddressPolicy.md", - "redirect_url": "/powershell/module/exchange/get-emailaddresspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-GlobalAddressList.md", - "redirect_url": "/powershell/module/exchange/get-globaladdresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-OabVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-oabvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/get-offlineaddressbook", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Move-AddressList.md", - "redirect_url": "/powershell/module/exchange/move-addresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Move-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/move-offlineaddressbook", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-AddressBookPolicy.md", - "redirect_url": "/powershell/module/exchange/new-addressbookpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-AddressList.md", - "redirect_url": "/powershell/module/exchange/new-addresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-EmailAddressPolicy.md", - "redirect_url": "/powershell/module/exchange/new-emailaddresspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-GlobalAddressList.md", - "redirect_url": "/powershell/module/exchange/new-globaladdresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-OabVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-oabvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/new-offlineaddressbook", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-AddressBookPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-addressbookpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-AddressList.md", - "redirect_url": "/powershell/module/exchange/remove-addresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-EmailAddressPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-emailaddresspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-GlobalAddressList.md", - "redirect_url": "/powershell/module/exchange/remove-globaladdresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-OabVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-oabvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/remove-offlineaddressbook", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Restore-DetailsTemplate.md", - "redirect_url": "/powershell/module/exchange/restore-detailstemplate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-AddressBookPolicy.md", - "redirect_url": "/powershell/module/exchange/set-addressbookpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-AddressList.md", - "redirect_url": "/powershell/module/exchange/set-addresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-DetailsTemplate.md", - "redirect_url": "/powershell/module/exchange/set-detailstemplate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-EmailAddressPolicy.md", - "redirect_url": "/powershell/module/exchange/set-emailaddresspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-GlobalAddressList.md", - "redirect_url": "/powershell/module/exchange/set-globaladdresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-OabVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-oabvirtualdirectory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/set-offlineaddressbook", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-AddressList.md", - "redirect_url": "/powershell/module/exchange/update-addresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-EmailAddressPolicy.md", - "redirect_url": "/powershell/module/exchange/update-emailaddresspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-GlobalAddressList.md", - "redirect_url": "/powershell/module/exchange/update-globaladdresslist", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/update-offlineaddressbook", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Enable-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/enable-exchangecertificate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Export-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/export-exchangecertificate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-DataEncryptionPolicy.md", - "redirect_url": "/powershell/module/exchange/get-dataencryptionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/get-exchangecertificate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-IRMConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-irmconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-OMEConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-omeconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-OMEMessageStatus.md", - "redirect_url": "/powershell/module/exchange/get-omemessagestatus", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-RMSTemplate.md", - "redirect_url": "/powershell/module/exchange/get-rmstemplate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-SmimeConfig.md", - "redirect_url": "/powershell/module/exchange/get-smimeconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Import-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/import-exchangecertificate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Import-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-DataEncryptionPolicy.md", - "redirect_url": "/powershell/module/exchange/new-dataencryptionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/new-exchangecertificate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-OMEConfiguration.md", - "redirect_url": "/powershell/module/exchange/new-omeconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/remove-exchangecertificate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-OMEConfiguration.md", - "redirect_url": "/powershell/module/exchange/remove-omeconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-DataEncryptionPolicy.md", - "redirect_url": "/powershell/module/exchange/set-dataencryptionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-IRMConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-irmconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-OMEConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-omeconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-OMEMessageRevocation.md", - "redirect_url": "/powershell/module/exchange/set-omemessagerevocation", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-RMSTemplate.md", - "redirect_url": "/powershell/module/exchange/set-rmstemplate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-SmimeConfig.md", - "redirect_url": "/powershell/module/exchange/set-smimeconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Test-IRMConfiguration.md", - "redirect_url": "/powershell/module/exchange/test-irmconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Add-FederatedDomain.md", - "redirect_url": "/powershell/module/exchange/add-federateddomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Disable-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/disable-remotemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Enable-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/enable-remotemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederatedDomainProof.md", - "redirect_url": "/powershell/module/exchange/get-federateddomainproof", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederatedOrganizationIdentifier.md", - "redirect_url": "/powershell/module/exchange/get-federatedorganizationidentifier", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederationInformation.md", - "redirect_url": "/powershell/module/exchange/get-federationinformation", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederationTrust.md", - "redirect_url": "/powershell/module/exchange/get-federationtrust", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-hybridconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridMailflow.md", - "redirect_url": "/powershell/module/exchange/get-hybridmailflow", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridMailflowDatacenterIPs.md", - "redirect_url": "/powershell/module/exchange/get-hybridmailflowdatacenterips", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-IntraOrganizationConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-intraorganizationconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-IntraOrganizationConnector.md", - "redirect_url": "/powershell/module/exchange/get-intraorganizationconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-OnPremisesOrganization.md", - "redirect_url": "/powershell/module/exchange/get-onpremisesorganization", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-PendingFederatedDomain.md", - "redirect_url": "/powershell/module/exchange/get-pendingfederateddomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/get-remotemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-FederationTrust.md", - "redirect_url": "/powershell/module/exchange/new-federationtrust", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-HybridConfiguration.md", - "redirect_url": "/powershell/module/exchange/new-hybridconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-IntraOrganizationConnector.md", - "redirect_url": "/powershell/module/exchange/new-intraorganizationconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-OnPremisesOrganization.md", - "redirect_url": "/powershell/module/exchange/new-onpremisesorganization", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/new-remotemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-FederatedDomain.md", - "redirect_url": "/powershell/module/exchange/remove-federateddomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-FederationTrust.md", - "redirect_url": "/powershell/module/exchange/remove-federationtrust", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-HybridConfiguration.md", - "redirect_url": "/powershell/module/exchange/remove-hybridconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-IntraOrganizationConnector.md", - "redirect_url": "/powershell/module/exchange/remove-intraorganizationconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-OnPremisesOrganization.md", - "redirect_url": "/powershell/module/exchange/remove-onpremisesorganization", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/remove-remotemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-FederatedOrganizationIdentifier.md", - "redirect_url": "/powershell/module/exchange/set-federatedorganizationidentifier", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-FederationTrust.md", - "redirect_url": "/powershell/module/exchange/set-federationtrust", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-HybridConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-hybridconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-HybridMailflow.md", - "redirect_url": "/powershell/module/exchange/set-hybridmailflow", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-IntraOrganizationConnector.md", - "redirect_url": "/powershell/module/exchange/set-intraorganizationconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-OnPremisesOrganization.md", - "redirect_url": "/powershell/module/exchange/set-onpremisesorganization", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-PendingFederatedDomain.md", - "redirect_url": "/powershell/module/exchange/set-pendingfederateddomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/set-remotemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Test-FederationTrust.md", - "redirect_url": "/powershell/module/exchange/test-federationtrust", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Test-FederationTrustCertificate.md", - "redirect_url": "/powershell/module/exchange/test-federationtrustcertificate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Update-HybridConfiguration.md", - "redirect_url": "/powershell/module/exchange/update-hybridconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Update-Recipient.md", - "redirect_url": "/powershell/module/exchange/update-recipient", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Add-ResubmitRequest.md", - "redirect_url": "/powershell/module/exchange/add-resubmitrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Disable-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/disable-transportagent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Enable-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/enable-transportagent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Export-Message.md", - "redirect_url": "/powershell/module/exchange/export-message", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-AcceptedDomain.md", - "redirect_url": "/powershell/module/exchange/get-accepteddomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-AddressRewriteEntry.md", - "redirect_url": "/powershell/module/exchange/get-addressrewriteentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-DeliveryAgentConnector.md", - "redirect_url": "/powershell/module/exchange/get-deliveryagentconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-EdgeSubscription.md", - "redirect_url": "/powershell/module/exchange/get-edgesubscription", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-EdgeSyncServiceConfig.md", - "redirect_url": "/powershell/module/exchange/get-edgesyncserviceconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ForeignConnector.md", - "redirect_url": "/powershell/module/exchange/get-foreignconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-FrontendTransportService.md", - "redirect_url": "/powershell/module/exchange/get-frontendtransportservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-InboundConnector.md", - "redirect_url": "/powershell/module/exchange/get-inboundconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MailboxTransportService.md", - "redirect_url": "/powershell/module/exchange/get-mailboxtransportservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-Message.md", - "redirect_url": "/powershell/module/exchange/get-message", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrace.md", - "redirect_url": "/powershell/module/exchange/get-messagetrace", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTraceDetail.md", - "redirect_url": "/powershell/module/exchange/get-messagetracedetail", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrackingLog.md", - "redirect_url": "/powershell/module/exchange/get-messagetrackinglog", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrackingReport.md", - "redirect_url": "/powershell/module/exchange/get-messagetrackingreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-NetworkConnectionInfo.md", - "redirect_url": "/powershell/module/exchange/get-networkconnectioninfo", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-OutboundConnector.md", - "redirect_url": "/powershell/module/exchange/get-outboundconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-Queue.md", - "redirect_url": "/powershell/module/exchange/get-queue", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-QueueDigest.md", - "redirect_url": "/powershell/module/exchange/get-queuedigest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ReceiveConnector.md", - "redirect_url": "/powershell/module/exchange/get-receiveconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-RemoteDomain.md", - "redirect_url": "/powershell/module/exchange/get-remotedomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ResubmitRequest.md", - "redirect_url": "/powershell/module/exchange/get-resubmitrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-RoutingGroupConnector.md", - "redirect_url": "/powershell/module/exchange/get-routinggroupconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-SendConnector.md", - "redirect_url": "/powershell/module/exchange/get-sendconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-SystemMessage.md", - "redirect_url": "/powershell/module/exchange/get-systemmessage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/get-transportagent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportConfig.md", - "redirect_url": "/powershell/module/exchange/get-transportconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportPipeline.md", - "redirect_url": "/powershell/module/exchange/get-transportpipeline", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportServer.md", - "redirect_url": "/powershell/module/exchange/get-transportserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportService.md", - "redirect_url": "/powershell/module/exchange/get-transportservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-X400AuthoritativeDomain.md", - "redirect_url": "/powershell/module/exchange/get-x400authoritativedomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Install-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/install-transportagent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-AcceptedDomain.md", - "redirect_url": "/powershell/module/exchange/new-accepteddomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-AddressRewriteEntry.md", - "redirect_url": "/powershell/module/exchange/new-addressrewriteentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-DeliveryAgentConnector.md", - "redirect_url": "/powershell/module/exchange/new-deliveryagentconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-EdgeSubscription.md", - "redirect_url": "/powershell/module/exchange/new-edgesubscription", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-EdgeSyncServiceConfig.md", - "redirect_url": "/powershell/module/exchange/new-edgesyncserviceconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-ForeignConnector.md", - "redirect_url": "/powershell/module/exchange/new-foreignconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-InboundConnector.md", - "redirect_url": "/powershell/module/exchange/new-inboundconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-OutboundConnector.md", - "redirect_url": "/powershell/module/exchange/new-outboundconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-ReceiveConnector.md", - "redirect_url": "/powershell/module/exchange/new-receiveconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-RemoteDomain.md", - "redirect_url": "/powershell/module/exchange/new-remotedomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-RoutingGroupConnector.md", - "redirect_url": "/powershell/module/exchange/new-routinggroupconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-SendConnector.md", - "redirect_url": "/powershell/module/exchange/new-sendconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-SystemMessage.md", - "redirect_url": "/powershell/module/exchange/new-systemmessage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/New-X400AuthoritativeDomain.md", - "redirect_url": "/powershell/module/exchange/new-x400authoritativedomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Redirect-Message.md", - "redirect_url": "/powershell/module/exchange/redirect-message", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-AcceptedDomain.md", - "redirect_url": "/powershell/module/exchange/remove-accepteddomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-AddressRewriteEntry.md", - "redirect_url": "/powershell/module/exchange/remove-addressrewriteentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-DeliveryAgentConnector.md", - "redirect_url": "/powershell/module/exchange/remove-deliveryagentconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-EdgeSubscription.md", - "redirect_url": "/powershell/module/exchange/remove-edgesubscription", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ForeignConnector.md", - "redirect_url": "/powershell/module/exchange/remove-foreignconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-InboundConnector.md", - "redirect_url": "/powershell/module/exchange/remove-inboundconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-Message.md", - "redirect_url": "/powershell/module/exchange/remove-message", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-OutboundConnector.md", - "redirect_url": "/powershell/module/exchange/remove-outboundconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ReceiveConnector.md", - "redirect_url": "/powershell/module/exchange/remove-receiveconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-RemoteDomain.md", - "redirect_url": "/powershell/module/exchange/remove-remotedomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ResubmitRequest.md", - "redirect_url": "/powershell/module/exchange/remove-resubmitrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-RoutingGroupConnector.md", - "redirect_url": "/powershell/module/exchange/remove-routinggroupconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-SendConnector.md", - "redirect_url": "/powershell/module/exchange/remove-sendconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-SystemMessage.md", - "redirect_url": "/powershell/module/exchange/remove-systemmessage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-X400AuthoritativeDomain.md", - "redirect_url": "/powershell/module/exchange/remove-x400authoritativedomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Resume-Message.md", - "redirect_url": "/powershell/module/exchange/resume-message", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Resume-Queue.md", - "redirect_url": "/powershell/module/exchange/resume-queue", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Retry-Queue.md", - "redirect_url": "/powershell/module/exchange/retry-queue", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Search-MessageTrackingReport.md", - "redirect_url": "/powershell/module/exchange/search-messagetrackingreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-AcceptedDomain.md", - "redirect_url": "/powershell/module/exchange/set-accepteddomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-AddressRewriteEntry.md", - "redirect_url": "/powershell/module/exchange/set-addressrewriteentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-DeliveryAgentConnector.md", - "redirect_url": "/powershell/module/exchange/set-deliveryagentconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-EdgeSyncServiceConfig.md", - "redirect_url": "/powershell/module/exchange/set-edgesyncserviceconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ForeignConnector.md", - "redirect_url": "/powershell/module/exchange/set-foreignconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-FrontendTransportService.md", - "redirect_url": "/powershell/module/exchange/set-frontendtransportservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-InboundConnector.md", - "redirect_url": "/powershell/module/exchange/set-inboundconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-MailboxTransportService.md", - "redirect_url": "/powershell/module/exchange/set-mailboxtransportservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-OutboundConnector.md", - "redirect_url": "/powershell/module/exchange/set-outboundconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ReceiveConnector.md", - "redirect_url": "/powershell/module/exchange/set-receiveconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-RemoteDomain.md", - "redirect_url": "/powershell/module/exchange/set-remotedomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ResubmitRequest.md", - "redirect_url": "/powershell/module/exchange/set-resubmitrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-RoutingGroupConnector.md", - "redirect_url": "/powershell/module/exchange/set-routinggroupconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-SendConnector.md", - "redirect_url": "/powershell/module/exchange/set-sendconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-SystemMessage.md", - "redirect_url": "/powershell/module/exchange/set-systemmessage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/set-transportagent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportConfig.md", - "redirect_url": "/powershell/module/exchange/set-transportconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportServer.md", - "redirect_url": "/powershell/module/exchange/set-transportserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportService.md", - "redirect_url": "/powershell/module/exchange/set-transportservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-X400AuthoritativeDomain.md", - "redirect_url": "/powershell/module/exchange/set-x400authoritativedomain", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Start-EdgeSynchronization.md", - "redirect_url": "/powershell/module/exchange/start-edgesynchronization", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Start-HistoricalSearch.md", - "redirect_url": "/powershell/module/exchange/start-historicalsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Stop-HistoricalSearch.md", - "redirect_url": "/powershell/module/exchange/stop-historicalsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Suspend-Message.md", - "redirect_url": "/powershell/module/exchange/suspend-message", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Suspend-Queue.md", - "redirect_url": "/powershell/module/exchange/suspend-queue", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-EdgeSynchronization.md", - "redirect_url": "/powershell/module/exchange/test-edgesynchronization", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-Mailflow.md", - "redirect_url": "/powershell/module/exchange/test-mailflow", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-SmtpConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-smtpconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Uninstall-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/uninstall-transportagent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mail-flow/Validate-OutboundConnector.md", - "redirect_url": "/powershell/module/exchange/validate-outboundconnector", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Clean-MailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/clean-mailboxdatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Disable-MailboxQuarantine.md", - "redirect_url": "/powershell/module/exchange/disable-mailboxquarantine", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Disable-MetaCacheDatabase.md", - "redirect_url": "/powershell/module/exchange/disable-metacachedatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Dismount-Database.md", - "redirect_url": "/powershell/module/exchange/dismount-database", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Enable-MailboxQuarantine.md", - "redirect_url": "/powershell/module/exchange/enable-mailboxquarantine", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Enable-MetaCacheDatabase.md", - "redirect_url": "/powershell/module/exchange/enable-metacachedatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-FailedContentIndexDocuments.md", - "redirect_url": "/powershell/module/exchange/get-failedcontentindexdocuments", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/get-mailboxdatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxRepairRequest.md", - "redirect_url": "/powershell/module/exchange/get-mailboxrepairrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxServer.md", - "redirect_url": "/powershell/module/exchange/get-mailboxserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-SearchDocumentFormat.md", - "redirect_url": "/powershell/module/exchange/get-searchdocumentformat", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-StoreUsageStatistics.md", - "redirect_url": "/powershell/module/exchange/get-storeusagestatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Mount-Database.md", - "redirect_url": "/powershell/module/exchange/mount-database", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Move-DatabasePath.md", - "redirect_url": "/powershell/module/exchange/move-databasepath", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-MailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/new-mailboxdatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-MailboxRepairRequest.md", - "redirect_url": "/powershell/module/exchange/new-mailboxrepairrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-SearchDocumentFormat.md", - "redirect_url": "/powershell/module/exchange/new-searchdocumentformat", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-MailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxdatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-MailboxRepairRequest.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxrepairrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-SearchDocumentFormat.md", - "redirect_url": "/powershell/module/exchange/remove-searchdocumentformat", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-StoreMailbox.md", - "redirect_url": "/powershell/module/exchange/remove-storemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-MailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/set-mailboxdatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-MailboxServer.md", - "redirect_url": "/powershell/module/exchange/set-mailboxserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-SearchDocumentFormat.md", - "redirect_url": "/powershell/module/exchange/set-searchdocumentformat", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-AssistantHealth.md", - "redirect_url": "/powershell/module/exchange/test-assistanthealth", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-ExchangeSearch.md", - "redirect_url": "/powershell/module/exchange/test-exchangesearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-MRSHealth.md", - "redirect_url": "/powershell/module/exchange/test-mrshealth", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-DatabaseSchema.md", - "redirect_url": "/powershell/module/exchange/update-databaseschema", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-FileDistributionService.md", - "redirect_url": "/powershell/module/exchange/update-filedistributionservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-StoreMailboxState.md", - "redirect_url": "/powershell/module/exchange/update-storemailboxstate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-MailboxFolderPermission.md", - "redirect_url": "/powershell/module/exchange/add-mailboxfolderpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-MailboxPermission.md", - "redirect_url": "/powershell/module/exchange/add-mailboxpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-RecipientPermission.md", - "redirect_url": "/powershell/module/exchange/add-recipientpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Connect-Mailbox.md", - "redirect_url": "/powershell/module/exchange/connect-mailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-App.md", - "redirect_url": "/powershell/module/exchange/disable-app", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-InboxRule.md", - "redirect_url": "/powershell/module/exchange/disable-inboxrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-Mailbox.md", - "redirect_url": "/powershell/module/exchange/disable-mailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-ServiceEmailChannel.md", - "redirect_url": "/powershell/module/exchange/disable-serviceemailchannel", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-SweepRule.md", - "redirect_url": "/powershell/module/exchange/disable-sweeprule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-App.md", - "redirect_url": "/powershell/module/exchange/enable-app", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-InboxRule.md", - "redirect_url": "/powershell/module/exchange/enable-inboxrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-Mailbox.md", - "redirect_url": "/powershell/module/exchange/enable-mailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-ServiceEmailChannel.md", - "redirect_url": "/powershell/module/exchange/enable-serviceemailchannel", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-SweepRule.md", - "redirect_url": "/powershell/module/exchange/enable-sweeprule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Export-MailboxDiagnosticLogs.md", - "redirect_url": "/powershell/module/exchange/export-mailboxdiagnosticlogs", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Export-RecipientDataProperty.md", - "redirect_url": "/powershell/module/exchange/export-recipientdataproperty", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-App.md", - "redirect_url": "/powershell/module/exchange/get-app", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticAnalysis.md", - "redirect_url": "/powershell/module/exchange/get-calendardiagnosticanalysis", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticLog.md", - "redirect_url": "/powershell/module/exchange/get-calendardiagnosticlog", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticObjects.md", - "redirect_url": "/powershell/module/exchange/get-calendardiagnosticobjects", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarNotification.md", - "redirect_url": "/powershell/module/exchange/get-calendarnotification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarProcessing.md", - "redirect_url": "/powershell/module/exchange/get-calendarprocessing", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Clutter.md", - "redirect_url": "/powershell/module/exchange/get-clutter", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-FocusedInbox.md", - "redirect_url": "/powershell/module/exchange/get-focusedinbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-InboxRule.md", - "redirect_url": "/powershell/module/exchange/get-inboxrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Mailbox.md", - "redirect_url": "/powershell/module/exchange/get-mailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxAutoReplyConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxautoreplyconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxCalendarFolder.md", - "redirect_url": "/powershell/module/exchange/get-mailboxcalendarfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/get-mailboxexportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxExportRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mailboxexportrequeststatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolder.md", - "redirect_url": "/powershell/module/exchange/get-mailboxfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolderPermission.md", - "redirect_url": "/powershell/module/exchange/get-mailboxfolderpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolderStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mailboxfolderstatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/get-mailboximportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxImportRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mailboximportrequeststatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxLocation.md", - "redirect_url": "/powershell/module/exchange/get-mailboxlocation", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxPermission.md", - "redirect_url": "/powershell/module/exchange/get-mailboxpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxPlan.md", - "redirect_url": "/powershell/module/exchange/get-mailboxplan", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/get-mailboxrestorerequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxRestoreRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mailboxrestorerequeststatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxSentItemsConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxsentitemsconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mailboxstatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxUserConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxuserconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MessageCategory.md", - "redirect_url": "/powershell/module/exchange/get-messagecategory", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Place.md", - "redirect_url": "/powershell/module/exchange/get-place", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-RecipientPermission.md", - "redirect_url": "/powershell/module/exchange/get-recipientpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-RecoverableItems.md", - "redirect_url": "/powershell/module/exchange/get-recoverableitems", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-ResourceConfig.md", - "redirect_url": "/powershell/module/exchange/get-resourceconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-SweepRule.md", - "redirect_url": "/powershell/module/exchange/get-sweeprule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-UserPhoto.md", - "redirect_url": "/powershell/module/exchange/get-userphoto", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Import-ContactList.md", - "redirect_url": "https://support.microsoft.com/office/import-contacts-to-outlook-bb796340-b58a-46c1-90c7-b549b8f3c5f8", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Import-RecipientDataProperty.md", - "redirect_url": "/powershell/module/exchange/import-recipientdataproperty", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/New-App.md", - "redirect_url": "/powershell/module/exchange/new-app", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/New-InboxRule.md", - "redirect_url": "/powershell/module/exchange/new-inboxrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/New-Mailbox.md", - "redirect_url": "/powershell/module/exchange/new-mailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/new-mailboxexportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxFolder.md", - "redirect_url": "/powershell/module/exchange/new-mailboxfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/new-mailboximportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/new-mailboxrestorerequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailMessage.md", - "redirect_url": "/powershell/module/exchange/new-mailmessage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/New-SiteMailbox.md", - "redirect_url": "/powershell/module/exchange/new-sitemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/New-SweepRule.md", - "redirect_url": "/powershell/module/exchange/new-sweeprule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-App.md", - "redirect_url": "/powershell/module/exchange/remove-app", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-CalendarEvents.md", - "redirect_url": "/powershell/module/exchange/remove-calendarevents", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-InboxRule.md", - "redirect_url": "/powershell/module/exchange/remove-inboxrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-Mailbox.md", - "redirect_url": "/powershell/module/exchange/remove-mailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxexportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxFolderPermission.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxfolderpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/remove-mailboximportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxPermission.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxrestorerequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxUserConfiguration.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxuserconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-RecipientPermission.md", - "redirect_url": "/powershell/module/exchange/remove-recipientpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-SweepRule.md", - "redirect_url": "/powershell/module/exchange/remove-sweeprule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-UserPhoto.md", - "redirect_url": "/powershell/module/exchange/remove-userphoto", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Restore-Mailbox.md", - "redirect_url": "/powershell/module/exchange/restore-mailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Restore-RecoverableItems.md", - "redirect_url": "/powershell/module/exchange/restore-recoverableitems", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/resume-mailboxexportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/resume-mailboximportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/resume-mailboxrestorerequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Search-Mailbox.md", - "redirect_url": "/powershell/module/exchange/search-mailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-App.md", - "redirect_url": "/powershell/module/exchange/set-app", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-CalendarNotification.md", - "redirect_url": "/powershell/module/exchange/set-calendarnotification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-CalendarProcessing.md", - "redirect_url": "/powershell/module/exchange/set-calendarprocessing", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Clutter.md", - "redirect_url": "/powershell/module/exchange/set-clutter", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-FocusedInbox.md", - "redirect_url": "/powershell/module/exchange/set-focusedinbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-InboxRule.md", - "redirect_url": "/powershell/module/exchange/set-inboxrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Mailbox.md", - "redirect_url": "/powershell/module/exchange/set-mailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxAutoReplyConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxautoreplyconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxCalendarFolder.md", - "redirect_url": "/powershell/module/exchange/set-mailboxcalendarfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/set-mailboxexportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxFolderPermission.md", - "redirect_url": "/powershell/module/exchange/set-mailboxfolderpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/set-mailboximportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxPlan.md", - "redirect_url": "/powershell/module/exchange/set-mailboxplan", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/set-mailboxrestorerequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxSentItemsConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxsentitemsconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Place.md", - "redirect_url": "/powershell/module/exchange/set-place", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-ResourceConfig.md", - "redirect_url": "/powershell/module/exchange/set-resourceconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-SweepRule.md", - "redirect_url": "/powershell/module/exchange/set-sweeprule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-UserPhoto.md", - "redirect_url": "/powershell/module/exchange/set-userphoto", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-mailboxexportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-mailboximportrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-mailboxrestorerequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Test-MAPIConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-mapiconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/mailboxes/Undo-SoftDeletedMailbox.md", - "redirect_url": "/powershell/module/exchange/undo-softdeletedmailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Complete-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/complete-migrationbatch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Export-MigrationReport.md", - "redirect_url": "/powershell/module/exchange/export-migrationreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/get-migrationbatch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationConfig.md", - "redirect_url": "/powershell/module/exchange/get-migrationconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationEndpoint.md", - "redirect_url": "/powershell/module/exchange/get-migrationendpoint", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationStatistics.md", - "redirect_url": "/powershell/module/exchange/get-migrationstatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationUser.md", - "redirect_url": "/powershell/module/exchange/get-migrationuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationUserStatistics.md", - "redirect_url": "/powershell/module/exchange/get-migrationuserstatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/get-moverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MoveRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-moverequeststatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermailboxmigrationrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermailboxmigrationrequeststatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermigrationrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMigrationRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermigrationrequeststatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermoverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMoveRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermoverequeststatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/new-migrationbatch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MigrationEndpoint.md", - "redirect_url": "/powershell/module/exchange/new-migrationendpoint", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/new-moverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/new-publicfoldermigrationrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/new-publicfoldermoverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/remove-migrationbatch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationEndpoint.md", - "redirect_url": "/powershell/module/exchange/remove-migrationendpoint", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationUser.md", - "redirect_url": "/powershell/module/exchange/remove-migrationuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/remove-moverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMailboxMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/remove-publicfoldermailboxmigrationrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/remove-publicfoldermigrationrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/remove-publicfoldermoverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/resume-moverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/resume-publicfoldermigrationrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/resume-publicfoldermoverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/set-migrationbatch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationConfig.md", - "redirect_url": "/powershell/module/exchange/set-migrationconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationEndpoint.md", - "redirect_url": "/powershell/module/exchange/set-migrationendpoint", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationUser.md", - "redirect_url": "/powershell/module/exchange/set-migrationuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/set-moverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/set-publicfoldermigrationrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/set-publicfoldermoverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Start-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/start-migrationbatch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Start-MigrationUser.md", - "redirect_url": "/powershell/module/exchange/start-migrationuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Stop-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/stop-migrationbatch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Stop-MigrationUser.md", - "redirect_url": "/powershell/module/exchange/stop-migrationuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-moverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMailboxMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-publicfoldermailboxmigrationrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-publicfoldermigrationrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-publicfoldermoverequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/move-and-migration/Test-MigrationServerAvailability.md", - "redirect_url": "/powershell/module/exchange/test-migrationserveravailability", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Disable-CmdletExtensionAgent.md", - "redirect_url": "/powershell/module/exchange/disable-cmdletextensionagent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Enable-CmdletExtensionAgent.md", - "redirect_url": "/powershell/module/exchange/enable-cmdletextensionagent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Enable-OrganizationCustomization.md", - "redirect_url": "/powershell/module/exchange/enable-organizationcustomization", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-AccessToCustomerDataRequest.md", - "redirect_url": "/powershell/module/exchange/get-accesstocustomerdatarequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-ApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/get-applicationaccesspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthConfig.md", - "redirect_url": "/powershell/module/exchange/get-authconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthenticationPolicy.md", - "redirect_url": "/powershell/module/exchange/get-authenticationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthServer.md", - "redirect_url": "/powershell/module/exchange/get-authserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-CmdletExtensionAgent.md", - "redirect_url": "/powershell/module/exchange/get-cmdletextensionagent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeAssistanceConfig.md", - "redirect_url": "/powershell/module/exchange/get-exchangeassistanceconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeDiagnosticInfo.md", - "redirect_url": "/powershell/module/exchange/get-exchangediagnosticinfo", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServer.md", - "redirect_url": "/powershell/module/exchange/get-exchangeserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServerAccessLicense.md", - "redirect_url": "/powershell/module/exchange/get-exchangeserveraccesslicense", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServerAccessLicenseUser.md", - "redirect_url": "/powershell/module/exchange/get-exchangeserveraccesslicenseuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeSettings.md", - "redirect_url": "/powershell/module/exchange/get-exchangesettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-Notification.md", - "redirect_url": "/powershell/module/exchange/get-notification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-OrganizationConfig.md", - "redirect_url": "/powershell/module/exchange/get-organizationconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-PartnerApplication.md", - "redirect_url": "/powershell/module/exchange/get-partnerapplication", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-PerimeterConfig.md", - "redirect_url": "/powershell/module/exchange/get-perimeterconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Get-SettingOverride.md", - "redirect_url": "/powershell/module/exchange/get-settingoverride", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/New-ApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/new-applicationaccesspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/New-AuthenticationPolicy.md", - "redirect_url": "/powershell/module/exchange/new-authenticationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/New-AuthServer.md", - "redirect_url": "/powershell/module/exchange/new-authserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/New-ExchangeSettings.md", - "redirect_url": "/powershell/module/exchange/new-exchangesettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/New-PartnerApplication.md", - "redirect_url": "/powershell/module/exchange/new-partnerapplication", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/New-SettingOverride.md", - "redirect_url": "/powershell/module/exchange/new-settingoverride", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Remove-ApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-applicationaccesspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Remove-AuthenticationPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-authenticationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Remove-AuthServer.md", - "redirect_url": "/powershell/module/exchange/remove-authserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Remove-PartnerApplication.md", - "redirect_url": "/powershell/module/exchange/remove-partnerapplication", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Remove-SettingOverride.md", - "redirect_url": "/powershell/module/exchange/remove-settingoverride", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-AccessToCustomerDataRequest.md", - "redirect_url": "/powershell/module/exchange/set-accesstocustomerdatarequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-ApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/set-applicationaccesspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthConfig.md", - "redirect_url": "/powershell/module/exchange/set-authconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthenticationPolicy.md", - "redirect_url": "/powershell/module/exchange/set-authenticationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthServer.md", - "redirect_url": "/powershell/module/exchange/set-authserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-CmdletExtensionAgent.md", - "redirect_url": "/powershell/module/exchange/set-cmdletextensionagent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeAssistanceConfig.md", - "redirect_url": "/powershell/module/exchange/set-exchangeassistanceconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeServer.md", - "redirect_url": "/powershell/module/exchange/set-exchangeserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeSettings.md", - "redirect_url": "/powershell/module/exchange/set-exchangesettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-Notification.md", - "redirect_url": "/powershell/module/exchange/set-notification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-OrganizationConfig.md", - "redirect_url": "/powershell/module/exchange/set-organizationconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-PartnerApplication.md", - "redirect_url": "/powershell/module/exchange/set-partnerapplication", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-PerimeterConfig.md", - "redirect_url": "/powershell/module/exchange/set-perimeterconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Set-SettingOverride.md", - "redirect_url": "/powershell/module/exchange/set-settingoverride", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Test-ApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/test-applicationaccesspolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Test-OAuthConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-oauthconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Test-SystemHealth.md", - "redirect_url": "/powershell/module/exchange/test-systemhealth", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/organization/Update-ExchangeHelp.md", - "redirect_url": "/powershell/module/exchange/update-exchangehelp", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-JournalArchiving.md", - "redirect_url": "/powershell/module/exchange/disable-journalarchiving", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-JournalRule.md", - "redirect_url": "/powershell/module/exchange/disable-journalrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/disable-outlookprotectionrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-TransportRule.md", - "redirect_url": "/powershell/module/exchange/disable-transportrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-JournalRule.md", - "redirect_url": "/powershell/module/exchange/enable-journalrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/enable-outlookprotectionrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-TransportRule.md", - "redirect_url": "/powershell/module/exchange/enable-transportrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Export-JournalRuleCollection.md", - "redirect_url": "/powershell/module/exchange/export-journalrulecollection", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Export-TransportRuleCollection.md", - "redirect_url": "/powershell/module/exchange/export-transportrulecollection", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/get-activityalert", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-AdministrativeUnit.md", - "redirect_url": "/powershell/module/exchange/get-administrativeunit", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierPoliciesApplicationStatus.md", - "redirect_url": "/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierPolicy.md", - "redirect_url": "/powershell/module/exchange/get-informationbarrierpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierRecipientStatus.md", - "redirect_url": "/powershell/module/exchange/get-informationbarrierrecipientstatus", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-JournalRule.md", - "redirect_url": "/powershell/module/exchange/get-journalrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-Label.md", - "redirect_url": "/powershell/module/exchange/get-label", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-LabelPolicy.md", - "redirect_url": "/powershell/module/exchange/get-labelpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-MessageClassification.md", - "redirect_url": "/powershell/module/exchange/get-messageclassification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-OrganizationSegment.md", - "redirect_url": "/powershell/module/exchange/get-organizationsegment", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/get-outlookprotectionrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-ProtectionAlert.md", - "redirect_url": "/powershell/module/exchange/get-protectionalert", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-SupervisoryReviewPolicyV2.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewpolicyv2", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-SupervisoryReviewRule.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRule.md", - "redirect_url": "/powershell/module/exchange/get-transportrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRuleAction.md", - "redirect_url": "/powershell/module/exchange/get-transportruleaction", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRulePredicate.md", - "redirect_url": "/powershell/module/exchange/get-transportrulepredicate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Import-JournalRuleCollection.md", - "redirect_url": "/powershell/module/exchange/import-journalrulecollection", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Import-TransportRuleCollection.md", - "redirect_url": "/powershell/module/exchange/import-transportrulecollection", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Install-UnifiedCompliancePrerequisite.md", - "redirect_url": "/powershell/module/exchange/install-unifiedcomplianceprerequisite", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/new-activityalert", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-InformationBarrierPolicy.md", - "redirect_url": "/powershell/module/exchange/new-informationbarrierpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-JournalRule.md", - "redirect_url": "/powershell/module/exchange/new-journalrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-Label.md", - "redirect_url": "/powershell/module/exchange/new-label", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-LabelPolicy.md", - "redirect_url": "/powershell/module/exchange/new-labelpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-MessageClassification.md", - "redirect_url": "/powershell/module/exchange/new-messageclassification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-OrganizationSegment.md", - "redirect_url": "/powershell/module/exchange/new-organizationsegment", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/new-outlookprotectionrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-ProtectionAlert.md", - "redirect_url": "/powershell/module/exchange/new-protectionalert", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-SupervisoryReviewPolicyV2.md", - "redirect_url": "/powershell/module/exchange/new-supervisoryreviewpolicyv2", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-SupervisoryReviewRule.md", - "redirect_url": "/powershell/module/exchange/new-supervisoryreviewrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-TransportRule.md", - "redirect_url": "/powershell/module/exchange/new-transportrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/remove-activityalert", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-InformationBarrierPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-informationbarrierpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-JournalRule.md", - "redirect_url": "/powershell/module/exchange/remove-journalrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-Label.md", - "redirect_url": "/powershell/module/exchange/remove-label", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-LabelPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-labelpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-MessageClassification.md", - "redirect_url": "/powershell/module/exchange/remove-messageclassification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-OrganizationSegment.md", - "redirect_url": "/powershell/module/exchange/remove-organizationsegment", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/remove-outlookprotectionrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-ProtectionAlert.md", - "redirect_url": "/powershell/module/exchange/remove-protectionalert", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-SupervisoryReviewPolicyV2.md", - "redirect_url": "/powershell/module/exchange/remove-supervisoryreviewpolicyv2", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-TransportRule.md", - "redirect_url": "/powershell/module/exchange/remove-transportrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/set-activityalert", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-InformationBarrierPolicy.md", - "redirect_url": "/powershell/module/exchange/set-informationbarrierpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-JournalRule.md", - "redirect_url": "/powershell/module/exchange/set-journalrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-Label.md", - "redirect_url": "/powershell/module/exchange/set-label", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-LabelPolicy.md", - "redirect_url": "/powershell/module/exchange/set-labelpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-MessageClassification.md", - "redirect_url": "/powershell/module/exchange/set-messageclassification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-OrganizationSegment.md", - "redirect_url": "/powershell/module/exchange/set-organizationsegment", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/set-outlookprotectionrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-ProtectionAlert.md", - "redirect_url": "/powershell/module/exchange/set-protectionalert", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-SupervisoryReviewPolicyV2.md", - "redirect_url": "/powershell/module/exchange/set-supervisoryreviewpolicyv2", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-SupervisoryReviewRule.md", - "redirect_url": "/powershell/module/exchange/set-supervisoryreviewrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-TransportRule.md", - "redirect_url": "/powershell/module/exchange/set-transportrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Start-InformationBarrierPoliciesApplication.md", - "redirect_url": "/powershell/module/exchange/start-informationbarrierpoliciesapplication", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Stop-InformationBarrierPoliciesApplication.md", - "redirect_url": "/powershell/module/exchange/stop-informationbarrierpoliciesapplication", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Test-ArchiveConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-archiveconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AdminAuditLogConfig.md", - "redirect_url": "/powershell/module/exchange/get-adminauditlogconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfig.md", - "redirect_url": "/powershell/module/exchange/get-auditconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/get-auditconfigurationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/get-auditconfigurationrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditLogSearch.md", - "redirect_url": "/powershell/module/exchange/get-auditlogsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-MailboxAuditBypassAssociation.md", - "redirect_url": "/powershell/module/exchange/get-mailboxauditbypassassociation", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/get-unifiedauditlogretentionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AdminAuditLogSearch.md", - "redirect_url": "/powershell/module/exchange/new-adminauditlogsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AuditConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/new-auditconfigurationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/new-auditconfigurationrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-MailboxAuditLogSearch.md", - "redirect_url": "/powershell/module/exchange/new-mailboxauditlogsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/new-unifiedauditlogretentionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-AuditConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-auditconfigurationpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/remove-auditconfigurationrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-unifiedauditlogretentionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-AdminAuditLog.md", - "redirect_url": "/powershell/module/exchange/search-adminauditlog", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-MailboxAuditLog.md", - "redirect_url": "/powershell/module/exchange/search-mailboxauditlog", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-UnifiedAuditLog.md", - "redirect_url": "/powershell/module/exchange/search-unifiedauditlog", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AdminAuditLogConfig.md", - "redirect_url": "/powershell/module/exchange/set-adminauditlogconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AuditConfig.md", - "redirect_url": "/powershell/module/exchange/set-auditconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/set-auditconfigurationrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-MailboxAuditBypassAssociation.md", - "redirect_url": "/powershell/module/exchange/set-mailboxauditbypassassociation", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/set-unifiedauditlogretentionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Write-AdminAuditLog.md", - "redirect_url": "/powershell/module/exchange/write-adminauditlog", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/get-compliancesearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSearchAction.md", - "redirect_url": "/powershell/module/exchange/get-compliancesearchaction", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSecurityFilter.md", - "redirect_url": "/powershell/module/exchange/get-compliancesecurityfilter", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/get-mailboxsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Invoke-ComplianceSearchActionStep.md", - "redirect_url": "/powershell/module/exchange/invoke-compliancesearchactionstep", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/new-compliancesearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSearchAction.md", - "redirect_url": "/powershell/module/exchange/new-compliancesearchaction", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSecurityFilter.md", - "redirect_url": "/powershell/module/exchange/new-compliancesecurityfilter", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/new-mailboxsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/remove-compliancesearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSearchAction.md", - "redirect_url": "/powershell/module/exchange/remove-compliancesearchaction", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSecurityFilter.md", - "redirect_url": "/powershell/module/exchange/remove-compliancesecurityfilter", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/set-compliancesearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSearchAction.md", - "redirect_url": "/powershell/module/exchange/set-compliancesearchaction", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSecurityFilter.md", - "redirect_url": "/powershell/module/exchange/set-compliancesecurityfilter", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/set-mailboxsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Start-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/start-compliancesearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Start-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/start-mailboxsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Stop-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/stop-compliancesearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Stop-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/stop-mailboxsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Export-DlpPolicyCollection.md", - "redirect_url": "/powershell/module/exchange/export-dlppolicycollection", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-ClassificationRuleCollection.md", - "redirect_url": "/powershell/module/exchange/get-classificationrulecollection", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DataClassification.md", - "redirect_url": "/powershell/module/exchange/get-dataclassification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DataClassificationConfig.md", - "redirect_url": "/powershell/module/exchange/get-dataclassificationconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/get-dlpcompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpComplianceRule.md", - "redirect_url": "/powershell/module/exchange/get-dlpcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpDetailReport.md", - "redirect_url": "/powershell/module/exchange/get-dlpdetailreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpDetectionsReport.md", - "redirect_url": "/powershell/module/exchange/get-dlpdetectionsreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpEdmSchema.md", - "redirect_url": "/powershell/module/exchange/get-dlpedmschema", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpKeywordDictionary.md", - "redirect_url": "/powershell/module/exchange/get-dlpkeyworddictionary", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpPolicy.md", - "redirect_url": "/powershell/module/exchange/get-dlppolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpPolicyTemplate.md", - "redirect_url": "/powershell/module/exchange/get-dlppolicytemplate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationType.md", - "redirect_url": "/powershell/module/exchange/get-dlpsensitiveinformationtype", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "/powershell/module/exchange/get-dlpsensitiveinformationtyperulepackage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSiDetectionsReport.md", - "redirect_url": "/powershell/module/exchange/get-dlpsidetectionsreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-PolicyTipConfig.md", - "redirect_url": "/powershell/module/exchange/get-policytipconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Import-DlpPolicyCollection.md", - "redirect_url": "/powershell/module/exchange/import-dlppolicycollection", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Import-DlpPolicyTemplate.md", - "redirect_url": "/powershell/module/exchange/import-dlppolicytemplate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-ClassificationRuleCollection.md", - "redirect_url": "/powershell/module/exchange/new-classificationrulecollection", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DataClassification.md", - "redirect_url": "/powershell/module/exchange/new-dataclassification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/new-dlpcompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpComplianceRule.md", - "redirect_url": "/powershell/module/exchange/new-dlpcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpEdmSchema.md", - "redirect_url": "/powershell/module/exchange/new-dlpedmschema", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpFingerprint.md", - "redirect_url": "/powershell/module/exchange/new-dlpfingerprint", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpKeywordDictionary.md", - "redirect_url": "/powershell/module/exchange/new-dlpkeyworddictionary", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpPolicy.md", - "redirect_url": "/powershell/module/exchange/new-dlppolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationType.md", - "redirect_url": "/powershell/module/exchange/new-dlpsensitiveinformationtype", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-Fingerprint.md", - "redirect_url": "/powershell/module/exchange/new-fingerprint", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-PolicyTipConfig.md", - "redirect_url": "/powershell/module/exchange/new-policytipconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-ClassificationRuleCollection.md", - "redirect_url": "/powershell/module/exchange/remove-classificationrulecollection", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DataClassification.md", - "redirect_url": "/powershell/module/exchange/remove-dataclassification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/remove-dlpcompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRule.md", - "redirect_url": "/powershell/module/exchange/remove-dlpcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpEdmSchema.md", - "redirect_url": "/powershell/module/exchange/remove-dlpedmschema", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpKeywordDictionary.md", - "redirect_url": "/powershell/module/exchange/remove-dlpkeyworddictionary", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-dlppolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpPolicyTemplate.md", - "redirect_url": "/powershell/module/exchange/remove-dlppolicytemplate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationType.md", - "redirect_url": "/powershell/module/exchange/remove-dlpsensitiveinformationtype", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-PolicyTipConfig.md", - "redirect_url": "/powershell/module/exchange/remove-policytipconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-ClassificationRuleCollection.md", - "redirect_url": "/powershell/module/exchange/set-classificationrulecollection", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DataClassification.md", - "redirect_url": "/powershell/module/exchange/set-dataclassification", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/set-dlpcompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpComplianceRule.md", - "redirect_url": "/powershell/module/exchange/set-dlpcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpEdmSchema.md", - "redirect_url": "/powershell/module/exchange/set-dlpedmschema", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpKeywordDictionary.md", - "redirect_url": "/powershell/module/exchange/set-dlpkeyworddictionary", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpPolicy.md", - "redirect_url": "/powershell/module/exchange/set-dlppolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationType.md", - "redirect_url": "/powershell/module/exchange/set-dlpsensitiveinformationtype", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "/powershell/module/exchange/set-dlpsensitiveinformationtyperulepackage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-PolicyTipConfig.md", - "redirect_url": "/powershell/module/exchange/set-policytipconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Add-ComplianceCaseMember.md", - "redirect_url": "/powershell/module/exchange/add-compliancecasemember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Add-eDiscoveryCaseAdmin.md", - "redirect_url": "/powershell/module/exchange/add-ediscoverycaseadmin", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-CaseHoldPolicy.md", - "redirect_url": "/powershell/module/exchange/get-caseholdpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-CaseHoldRule.md", - "redirect_url": "/powershell/module/exchange/get-caseholdrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-ComplianceCase.md", - "redirect_url": "/powershell/module/exchange/get-compliancecase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-ComplianceCaseMember.md", - "redirect_url": "/powershell/module/exchange/get-compliancecasemember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-eDiscoveryCaseAdmin.md", - "redirect_url": "/powershell/module/exchange/get-ediscoverycaseadmin", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-CaseHoldPolicy.md", - "redirect_url": "/powershell/module/exchange/new-caseholdpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-CaseHoldRule.md", - "redirect_url": "/powershell/module/exchange/new-caseholdrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-ComplianceCase.md", - "redirect_url": "/powershell/module/exchange/new-compliancecase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-caseholdpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldRule.md", - "redirect_url": "/powershell/module/exchange/remove-caseholdrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCase.md", - "redirect_url": "/powershell/module/exchange/remove-compliancecase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCaseMember.md", - "redirect_url": "/powershell/module/exchange/remove-compliancecasemember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-eDiscoveryCaseAdmin.md", - "redirect_url": "/powershell/module/exchange/remove-ediscoverycaseadmin", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-CaseHoldPolicy.md", - "redirect_url": "/powershell/module/exchange/set-caseholdpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-CaseHoldRule.md", - "redirect_url": "/powershell/module/exchange/set-caseholdrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-ComplianceCase.md", - "redirect_url": "/powershell/module/exchange/set-compliancecase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Update-ComplianceCaseMember.md", - "redirect_url": "/powershell/module/exchange/update-compliancecasemember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Update-eDiscoveryCaseAdmin.md", - "redirect_url": "/powershell/module/exchange/update-ediscoverycaseadmin", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Enable-ComplianceTagStorage.md", - "redirect_url": "/powershell/module/exchange/enable-compliancetagstorage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEvent.md", - "redirect_url": "/powershell/module/exchange/get-complianceretentionevent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEventType.md", - "redirect_url": "/powershell/module/exchange/get-complianceretentioneventtype", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceTag.md", - "redirect_url": "/powershell/module/exchange/get-compliancetag", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceTagStorage.md", - "redirect_url": "/powershell/module/exchange/get-compliancetagstorage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-DataRetentionReport.md", - "redirect_url": "/powershell/module/exchange/get-dataretentionreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-HoldCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/get-holdcompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-HoldComplianceRule.md", - "redirect_url": "/powershell/module/exchange/get-holdcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedContentSettings.md", - "redirect_url": "/powershell/module/exchange/get-managedcontentsettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedFolder.md", - "redirect_url": "/powershell/module/exchange/get-managedfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedFolderMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/get-managedfoldermailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/get-retentioncompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/get-retentioncompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionEvent.md", - "redirect_url": "/powershell/module/exchange/get-retentionevent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/get-retentionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionPolicyTag.md", - "redirect_url": "/powershell/module/exchange/get-retentionpolicytag", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceRetentionEvent.md", - "redirect_url": "/powershell/module/exchange/new-complianceretentionevent", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceRetentionEventType.md", - "redirect_url": "/powershell/module/exchange/new-complianceretentioneventtype", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceTag.md", - "redirect_url": "/powershell/module/exchange/new-compliancetag", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-HoldCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/new-holdcompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-HoldComplianceRule.md", - "redirect_url": "/powershell/module/exchange/new-holdcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedContentSettings.md", - "redirect_url": "/powershell/module/exchange/new-managedcontentsettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedFolder.md", - "redirect_url": "/powershell/module/exchange/new-managedfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedFolderMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/new-managedfoldermailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/new-retentioncompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/new-retentioncompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/new-retentionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionPolicyTag.md", - "redirect_url": "/powershell/module/exchange/new-retentionpolicytag", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ComplianceRetentionEventType.md", - "redirect_url": "/powershell/module/exchange/remove-complianceretentioneventtype", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ComplianceTag.md", - "redirect_url": "/powershell/module/exchange/remove-compliancetag", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-HoldCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/remove-holdcompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-HoldComplianceRule.md", - "redirect_url": "/powershell/module/exchange/remove-holdcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedContentSettings.md", - "redirect_url": "/powershell/module/exchange/remove-managedcontentsettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedFolder.md", - "redirect_url": "/powershell/module/exchange/remove-managedfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedFolderMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-managedfoldermailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/remove-retentioncompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/remove-retentioncompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-retentionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionPolicyTag.md", - "redirect_url": "/powershell/module/exchange/remove-retentionpolicytag", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ComplianceRetentionEventType.md", - "redirect_url": "/powershell/module/exchange/set-complianceretentioneventtype", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ComplianceTag.md", - "redirect_url": "/powershell/module/exchange/set-compliancetag", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-HoldCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/set-holdcompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-HoldComplianceRule.md", - "redirect_url": "/powershell/module/exchange/set-holdcompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedContentSettings.md", - "redirect_url": "/powershell/module/exchange/set-managedcontentsettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedFolder.md", - "redirect_url": "/powershell/module/exchange/set-managedfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedFolderMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/set-managedfoldermailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/set-retentioncompliancepolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/set-retentioncompliancerule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/set-retentionpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionPolicyTag.md", - "redirect_url": "/powershell/module/exchange/set-retentionpolicytag", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Start-ManagedFolderAssistant.md", - "redirect_url": "/powershell/module/exchange/start-managedfolderassistant", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Start-RetentionAutoTagLearning.md", - "redirect_url": "/powershell/module/exchange/start-retentionautotaglearning", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Stop-ManagedFolderAssistant.md", - "redirect_url": "/powershell/module/exchange/stop-managedfolderassistant", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Validate-RetentionRuleQuery.md", - "redirect_url": "/powershell/module/exchange/validate-retentionrulequery", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Connect-ExchangeOnline.md", - "redirect_url": "/powershell/module/exchange/connect-exchangeonline", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOCasMailbox.md", - "redirect_url": "/powershell/module/exchange/get-exocasmailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailbox.md", - "redirect_url": "/powershell/module/exchange/get-exomailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxFolderPermission.md", - "redirect_url": "/powershell/module/exchange/get-exomailboxfolderpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxFolderStatistics.md", - "redirect_url": "/powershell/module/exchange/get-exomailboxfolderstatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxPermission.md", - "redirect_url": "/powershell/module/exchange/get-exomailboxpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxStatistics.md", - "redirect_url": "/powershell/module/exchange/get-exomailboxstatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMobileDeviceStatistics.md", - "redirect_url": "/powershell/module/exchange/get-exomobiledevicestatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXORecipient.md", - "redirect_url": "/powershell/module/exchange/get-exorecipient", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXORecipientPermission.md", - "redirect_url": "/powershell/module/exchange/get-exorecipientpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-ConnectionByClientTypeDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-ConnectionByClientTypeReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsActiveUserReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsAVConferenceTimeReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsClientDeviceDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsClientDeviceReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsConferenceReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsP2PAVTimeReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsP2PSessionReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsPSTNConferenceTimeReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsPSTNUsageDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsUserActivitiesReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsUsersBlockedReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-GroupActivityReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-HistoricalSearch.md", - "redirect_url": "/powershell/module/exchange/get-historicalsearch", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-LicenseVsUsageSummaryReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-LogonStatistics.md", - "redirect_url": "/powershell/module/exchange/get-logonstatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailboxActivityReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailboxUsageDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailboxUsageReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailDlpPolicyReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetaildlppolicyreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailMalwareReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailSpamReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailTransportRuleReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailtransportrulereport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailFilterListReport.md", - "redirect_url": "/powershell/module/exchange/get-mailfilterlistreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficPolicyReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficpolicyreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficSummaryReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficTopReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-MxRecordReport.md", - "redirect_url": "/powershell/module/exchange/get-mxrecordreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientBrowserDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientBrowserReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientOSDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientOSReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-OutboundConnectorReport.md", - "redirect_url": "/powershell/module/exchange/get-outboundconnectorreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-RecipientStatisticsReport.md", - "redirect_url": "/powershell/module/exchange/get-recipientstatisticsreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-ReportExecutionInstance.md", - "redirect_url": "/powershell/module/exchange/get-reportexecutioninstance", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SCInsights.md", - "redirect_url": "/powershell/module/exchange/get-scinsights", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-ServiceDeliveryReport.md", - "redirect_url": "/powershell/module/exchange/get-servicedeliveryreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOActiveUserReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOSkyDriveProDeployedReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOSkyDriveProStorageReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOTeamSiteDeployedReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOTeamSiteStorageReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOTenantStorageMetricReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-StaleMailboxDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-StaleMailboxReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewActivity.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewactivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewOverallProgressReport.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewoverallprogressreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewPolicyReport.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewpolicyreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewReport.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewTopCasesReport.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewtopcasesreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-TenantAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Get-UserAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Set-TenantAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/myanalyticsfeatureconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/reporting/Set-UserAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/myanalyticsfeatureconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Add-ManagementRoleEntry.md", - "redirect_url": "/powershell/module/exchange/add-managementroleentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Add-RoleGroupMember.md", - "redirect_url": "/powershell/module/exchange/add-rolegroupmember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRole.md", - "redirect_url": "/powershell/module/exchange/get-managementrole", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRoleAssignment.md", - "redirect_url": "/powershell/module/exchange/get-managementroleassignment", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRoleEntry.md", - "redirect_url": "/powershell/module/exchange/get-managementroleentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementScope.md", - "redirect_url": "/powershell/module/exchange/get-managementscope", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleAssignmentPolicy.md", - "redirect_url": "/powershell/module/exchange/get-roleassignmentpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleGroup.md", - "redirect_url": "/powershell/module/exchange/get-rolegroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleGroupMember.md", - "redirect_url": "/powershell/module/exchange/get-rolegroupmember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementRole.md", - "redirect_url": "/powershell/module/exchange/new-managementrole", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementRoleAssignment.md", - "redirect_url": "/powershell/module/exchange/new-managementroleassignment", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementScope.md", - "redirect_url": "/powershell/module/exchange/new-managementscope", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-RoleAssignmentPolicy.md", - "redirect_url": "/powershell/module/exchange/new-roleassignmentpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-RoleGroup.md", - "redirect_url": "/powershell/module/exchange/new-rolegroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRole.md", - "redirect_url": "/powershell/module/exchange/remove-managementrole", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRoleAssignment.md", - "redirect_url": "/powershell/module/exchange/remove-managementroleassignment", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRoleEntry.md", - "redirect_url": "/powershell/module/exchange/remove-managementroleentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementScope.md", - "redirect_url": "/powershell/module/exchange/remove-managementscope", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleAssignmentPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-roleassignmentpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleGroup.md", - "redirect_url": "/powershell/module/exchange/remove-rolegroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleGroupMember.md", - "redirect_url": "/powershell/module/exchange/remove-rolegroupmember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementRoleAssignment.md", - "redirect_url": "/powershell/module/exchange/set-managementroleassignment", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementRoleEntry.md", - "redirect_url": "/powershell/module/exchange/set-managementroleentry", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementScope.md", - "redirect_url": "/powershell/module/exchange/set-managementscope", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-RoleAssignmentPolicy.md", - "redirect_url": "/powershell/module/exchange/set-roleassignmentpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-RoleGroup.md", - "redirect_url": "/powershell/module/exchange/set-rolegroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Update-RoleGroupMember.md", - "redirect_url": "/powershell/module/exchange/update-rolegroupmember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Add-GlobalMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/add-globalmonitoringoverride", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Add-ServerMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/add-servermonitoringoverride", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-AvailabilityReportOutage.md", - "redirect_url": "/powershell/module/exchange/get-availabilityreportoutage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-EventLogLevel.md", - "redirect_url": "/powershell/module/exchange/get-eventloglevel", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-GlobalMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/get-globalmonitoringoverride", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-HealthReport.md", - "redirect_url": "/powershell/module/exchange/get-healthreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-MonitoringItemHelp.md", - "redirect_url": "/powershell/module/exchange/get-monitoringitemhelp", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-MonitoringItemIdentity.md", - "redirect_url": "/powershell/module/exchange/get-monitoringitemidentity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerComponentState.md", - "redirect_url": "/powershell/module/exchange/get-servercomponentstate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerHealth.md", - "redirect_url": "/powershell/module/exchange/get-serverhealth", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/get-servermonitoringoverride", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ThrottlingPolicy.md", - "redirect_url": "/powershell/module/exchange/get-throttlingpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ThrottlingPolicyAssociation.md", - "redirect_url": "/powershell/module/exchange/get-throttlingpolicyassociation", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Invoke-MonitoringProbe.md", - "redirect_url": "/powershell/module/exchange/invoke-monitoringprobe", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/New-AvailabilityReportOutage.md", - "redirect_url": "/powershell/module/exchange/new-availabilityreportoutage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/New-ThrottlingPolicy.md", - "redirect_url": "/powershell/module/exchange/new-throttlingpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-AvailabilityReportOutage.md", - "redirect_url": "/powershell/module/exchange/remove-availabilityreportoutage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-GlobalMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/remove-globalmonitoringoverride", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-ServerMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/remove-servermonitoringoverride", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-ThrottlingPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-throttlingpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-AvailabilityReportOutage.md", - "redirect_url": "/powershell/module/exchange/set-availabilityreportoutage", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-EventLogLevel.md", - "redirect_url": "/powershell/module/exchange/set-eventloglevel", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ServerComponentState.md", - "redirect_url": "/powershell/module/exchange/set-servercomponentstate", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ServerMonitor.md", - "redirect_url": "/powershell/module/exchange/set-servermonitor", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ThrottlingPolicy.md", - "redirect_url": "/powershell/module/exchange/set-throttlingpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ThrottlingPolicyAssociation.md", - "redirect_url": "/powershell/module/exchange/set-throttlingpolicyassociation", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Test-ServiceHealth.md", - "redirect_url": "/powershell/module/exchange/test-servicehealth", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-AvailabilityAddressSpace.md", - "redirect_url": "/powershell/module/exchange/add-availabilityaddressspace", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-PublicFolderAdministrativePermission.md", - "redirect_url": "/powershell/module/exchange/add-publicfolderadministrativepermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-PublicFolderClientPermission.md", - "redirect_url": "/powershell/module/exchange/add-publicfolderclientpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Disable-MailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/disable-mailpublicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Enable-MailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/enable-mailpublicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-AvailabilityAddressSpace.md", - "redirect_url": "/powershell/module/exchange/get-availabilityaddressspace", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-AvailabilityConfig.md", - "redirect_url": "/powershell/module/exchange/get-availabilityconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-MailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/get-mailpublicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-OrganizationRelationship.md", - "redirect_url": "/powershell/module/exchange/get-organizationrelationship", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolder.md", - "redirect_url": "/powershell/module/exchange/get-publicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderAdministrativePermission.md", - "redirect_url": "/powershell/module/exchange/get-publicfolderadministrativepermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderClientPermission.md", - "redirect_url": "/powershell/module/exchange/get-publicfolderclientpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderDatabase.md", - "redirect_url": "/powershell/module/exchange/get-publicfolderdatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderItemStatistics.md", - "redirect_url": "/powershell/module/exchange/get-publicfolderitemstatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderMailboxDiagnostics.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermailboxdiagnostics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderStatistics.md", - "redirect_url": "/powershell/module/exchange/get-publicfolderstatistics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SharingPolicy.md", - "redirect_url": "/powershell/module/exchange/get-sharingpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailbox.md", - "redirect_url": "/powershell/module/exchange/get-sitemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailboxDiagnostics.md", - "redirect_url": "/powershell/module/exchange/get-sitemailboxdiagnostics", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailboxProvisioningPolicy.md", - "redirect_url": "/powershell/module/exchange/get-sitemailboxprovisioningpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-AvailabilityConfig.md", - "redirect_url": "/powershell/module/exchange/new-availabilityconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-OrganizationRelationship.md", - "redirect_url": "/powershell/module/exchange/new-organizationrelationship", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolder.md", - "redirect_url": "/powershell/module/exchange/new-publicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolderDatabase.md", - "redirect_url": "/powershell/module/exchange/new-publicfolderdatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolderDatabaseRepairRequest.md", - "redirect_url": "/powershell/module/exchange/new-publicfolderdatabaserepairrequest", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SharingPolicy.md", - "redirect_url": "/powershell/module/exchange/new-sharingpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SiteMailboxProvisioningPolicy.md", - "redirect_url": "/powershell/module/exchange/new-sitemailboxprovisioningpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SyncMailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/new-syncmailpublicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-AvailabilityAddressSpace.md", - "redirect_url": "/powershell/module/exchange/remove-availabilityaddressspace", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-AvailabilityConfig.md", - "redirect_url": "/powershell/module/exchange/remove-availabilityconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-OrganizationRelationship.md", - "redirect_url": "/powershell/module/exchange/remove-organizationrelationship", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolder.md", - "redirect_url": "/powershell/module/exchange/remove-publicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderAdministrativePermission.md", - "redirect_url": "/powershell/module/exchange/remove-publicfolderadministrativepermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderClientPermission.md", - "redirect_url": "/powershell/module/exchange/remove-publicfolderclientpermission", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderDatabase.md", - "redirect_url": "/powershell/module/exchange/remove-publicfolderdatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SharingPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-sharingpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SiteMailboxProvisioningPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-sitemailboxprovisioningpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SyncMailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/remove-syncmailpublicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Resume-PublicFolderReplication.md", - "redirect_url": "/powershell/module/exchange/resume-publicfolderreplication", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-AvailabilityConfig.md", - "redirect_url": "/powershell/module/exchange/set-availabilityconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-MailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/set-mailpublicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-OrganizationRelationship.md", - "redirect_url": "/powershell/module/exchange/set-organizationrelationship", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-PublicFolder.md", - "redirect_url": "/powershell/module/exchange/set-publicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-PublicFolderDatabase.md", - "redirect_url": "/powershell/module/exchange/set-publicfolderdatabase", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SharingPolicy.md", - "redirect_url": "/powershell/module/exchange/set-sharingpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SiteMailbox.md", - "redirect_url": "/powershell/module/exchange/set-sitemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SiteMailboxProvisioningPolicy.md", - "redirect_url": "/powershell/module/exchange/set-sitemailboxprovisioningpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Suspend-PublicFolderReplication.md", - "redirect_url": "/powershell/module/exchange/suspend-publicfolderreplication", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Test-OrganizationRelationship.md", - "redirect_url": "/powershell/module/exchange/test-organizationrelationship", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Test-SiteMailbox.md", - "redirect_url": "/powershell/module/exchange/test-sitemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolder.md", - "redirect_url": "/powershell/module/exchange/update-publicfolder", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolderHierarchy.md", - "redirect_url": "/powershell/module/exchange/update-publicfolderhierarchy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolderMailbox.md", - "redirect_url": "/powershell/module/exchange/update-publicfoldermailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-SiteMailbox.md", - "redirect_url": "/powershell/module/exchange/update-sitemailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/disable-umautoattendant", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/disable-umcallansweringrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/disable-umipgateway", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMMailbox.md", - "redirect_url": "/powershell/module/exchange/disable-ummailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMServer.md", - "redirect_url": "/powershell/module/exchange/disable-umserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMService.md", - "redirect_url": "/powershell/module/exchange/disable-umservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/enable-umautoattendant", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/enable-umcallansweringrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/enable-umipgateway", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMMailbox.md", - "redirect_url": "/powershell/module/exchange/enable-ummailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMServer.md", - "redirect_url": "/powershell/module/exchange/enable-umserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMService.md", - "redirect_url": "/powershell/module/exchange/enable-umservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Export-UMCallDataRecord.md", - "redirect_url": "/powershell/module/exchange/export-umcalldatarecord", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Export-UMPrompt.md", - "redirect_url": "/powershell/module/exchange/export-umprompt", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-OnlineMeetingConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-onlinemeetingconfiguration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMActiveCalls.md", - "redirect_url": "/powershell/module/exchange/get-umactivecalls", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/get-umautoattendant", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/get-umcallansweringrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallDataRecord.md", - "redirect_url": "/powershell/module/exchange/get-umcalldatarecord", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallRouterSettings.md", - "redirect_url": "/powershell/module/exchange/get-umcallroutersettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallSummaryReport.md", - "redirect_url": "/powershell/module/exchange/get-umcallsummaryreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMDialPlan.md", - "redirect_url": "/powershell/module/exchange/get-umdialplan", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMHuntGroup.md", - "redirect_url": "/powershell/module/exchange/get-umhuntgroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/get-umipgateway", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailbox.md", - "redirect_url": "/powershell/module/exchange/get-ummailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailboxPIN.md", - "redirect_url": "/powershell/module/exchange/get-ummailboxpin", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/get-ummailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UmServer.md", - "redirect_url": "/powershell/module/exchange/get-umserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMService.md", - "redirect_url": "/powershell/module/exchange/get-umservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Import-UMPrompt.md", - "redirect_url": "/powershell/module/exchange/import-umprompt", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/new-umautoattendant", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/new-umcallansweringrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMDialPlan.md", - "redirect_url": "/powershell/module/exchange/new-umdialplan", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMHuntGroup.md", - "redirect_url": "/powershell/module/exchange/new-umhuntgroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/new-umipgateway", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/new-ummailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/remove-umautoattendant", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/remove-umcallansweringrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMDialPlan.md", - "redirect_url": "/powershell/module/exchange/remove-umdialplan", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMHuntGroup.md", - "redirect_url": "/powershell/module/exchange/remove-umhuntgroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/remove-umipgateway", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-ummailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/set-umautoattendant", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/set-umcallansweringrule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMCallRouterSettings.md", - "redirect_url": "/powershell/module/exchange/set-umcallroutersettings", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMDialPlan.md", - "redirect_url": "/powershell/module/exchange/set-umdialplan", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/set-umipgateway", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailbox.md", - "redirect_url": "/powershell/module/exchange/set-ummailbox", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailboxPIN.md", - "redirect_url": "/powershell/module/exchange/set-ummailboxpin", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/set-ummailboxpolicy", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UmServer.md", - "redirect_url": "/powershell/module/exchange/set-umserver", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMService.md", - "redirect_url": "/powershell/module/exchange/set-umservice", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/unified-messaging/Test-UMConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-umconnectivity", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Add-DistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/add-distributiongroupmember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Add-UnifiedGroupLinks.md", - "redirect_url": "/powershell/module/exchange/add-unifiedgrouplinks", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/disable-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-MailContact.md", - "redirect_url": "/powershell/module/exchange/disable-mailcontact", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-MailUser.md", - "redirect_url": "/powershell/module/exchange/disable-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/enable-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-MailContact.md", - "redirect_url": "/powershell/module/exchange/enable-mailcontact", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-MailUser.md", - "redirect_url": "/powershell/module/exchange/enable-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Contact.md", - "redirect_url": "/powershell/module/exchange/get-contact", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/get-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/get-distributiongroupmember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DynamicDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/get-dynamicdistributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-EligibleDistributionGroupForMigration.md", - "redirect_url": "/powershell/module/exchange/get-eligibledistributiongroupformigration", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Group.md", - "redirect_url": "/powershell/module/exchange/get-group", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-LinkedUser.md", - "redirect_url": "/powershell/module/exchange/get-linkeduser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-MailContact.md", - "redirect_url": "/powershell/module/exchange/get-mailcontact", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-MailUser.md", - "redirect_url": "/powershell/module/exchange/get-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Recipient.md", - "redirect_url": "/powershell/module/exchange/get-recipient", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-SecurityPrincipal.md", - "redirect_url": "/powershell/module/exchange/get-securityprincipal", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-UnifiedGroup.md", - "redirect_url": "/powershell/module/exchange/get-unifiedgroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-UnifiedGroupLinks.md", - "redirect_url": "/powershell/module/exchange/get-unifiedgrouplinks", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-User.md", - "redirect_url": "/powershell/module/exchange/get-user", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/new-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-DynamicDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/new-dynamicdistributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/new-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/new-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-MailContact.md", - "redirect_url": "/powershell/module/exchange/new-mailcontact", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-MailUser.md", - "redirect_url": "/powershell/module/exchange/new-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-UnifiedGroup.md", - "redirect_url": "/powershell/module/exchange/new-unifiedgroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/remove-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/remove-distributiongroupmember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DynamicDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/remove-dynamicdistributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/remove-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/remove-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-MailContact.md", - "redirect_url": "/powershell/module/exchange/remove-mailcontact", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-MailUser.md", - "redirect_url": "/powershell/module/exchange/remove-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-UnifiedGroup.md", - "redirect_url": "/powershell/module/exchange/remove-unifiedgroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-UnifiedGroupLinks.md", - "redirect_url": "/powershell/module/exchange/remove-unifiedgrouplinks", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-Contact.md", - "redirect_url": "/powershell/module/exchange/set-contact", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/set-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-DynamicDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/set-dynamicdistributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/set-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPGroup.md", - "redirect_url": "/powershell/module/exchange/set-group", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/set-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPUser.md", - "redirect_url": "/powershell/module/exchange/set-user", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-Group.md", - "redirect_url": "/powershell/module/exchange/set-group", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-LinkedUser.md", - "redirect_url": "/powershell/module/exchange/set-linkeduser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-MailContact.md", - "redirect_url": "/powershell/module/exchange/set-mailcontact", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-MailUser.md", - "redirect_url": "/powershell/module/exchange/set-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-UnifiedGroup.md", - "redirect_url": "/powershell/module/exchange/set-unifiedgroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-User.md", - "redirect_url": "/powershell/module/exchange/set-user", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Undo-SoftDeletedUnifiedGroup.md", - "redirect_url": "/powershell/module/exchange/undo-softdeletedunifiedgroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Update-DistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Update-EOPDistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/users-and-groups/Upgrade-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/upgrade-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/office-365-scc/office-365-scc-powershell.md", - "redirect_url": "/powershell/exchange/scc-powershell", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-scc-powershell", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/mfa-connect-to-scc-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-scc-powershell", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/exchange-server/connect-to-exchange-servers-using-remote-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-exchange-servers-using-remote-powershell", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-server/control-remote-powershell-access-to-exchange-servers.md", - "redirect_url": "/powershell/exchange/control-remote-powershell-access-to-exchange-servers", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-server/exchange-cmdlet-syntax.md", - "redirect_url": "/powershell/exchange/exchange-cmdlet-syntax", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-server/exchange-management-shell.md", - "redirect_url": "/powershell/exchange/exchange-management-shell", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-server/find-exchange-cmdlet-permissions.md", - "redirect_url": "/powershell/exchange/find-exchange-cmdlet-permissions", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-server/open-the-exchange-management-shell.md", - "redirect_url": "/powershell/exchange/open-the-exchange-management-shell", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-server/use-update-exchangehelp.md", - "redirect_url": "/powershell/exchange/exchange-management-shell", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/filter-properties.md", - "redirect_url": "/powershell/exchange/filter-properties", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/recipient-filters.md", - "redirect_url": "/powershell/exchange/recipient-filters", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/recipientfilter-properties.md", - "redirect_url": "/powershell/exchange/recipientfilter-properties", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-online/disable-access-to-exchange-online-powershell.md", - "redirect_url": "/powershell/exchange/disable-access-to-exchange-online-powershell", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell.md", - "redirect_url": "/powershell/exchange/exchange-online-powershell", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/mfa-connect-to-exchange-online-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/app-only-auth-powershell-v2.md", - "redirect_url": "/powershell/exchange/app-only-auth-powershell-v2", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets.md", - "redirect_url": "/powershell/exchange/cmdlet-property-sets", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2.md", - "redirect_url": "/powershell/exchange/exchange-online-powershell-v2", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/filters-v2.md", - "redirect_url": "/powershell/exchange/filters-v2", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-eop/connect-to-exchange-online-protection-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-exchange-online-protection-powershell", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/exchange-eop/exchange-online-protection-powershell.md", - "redirect_url": "/powershell/exchange/exchange-online-protection-powershell", - "redirect_document_id": true - }, - { - "source_path": "exchange/docs-conceptual/mfa-connect-to-exchange-online-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/mfa-connect-to-scc-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-scc-powershell", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-TenantAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-TenantAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/set-myanalyticsfeatureconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-UserAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-UserAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/set-myanalyticsfeatureconfig", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-MailDetailMalwareReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-MailDetailSpamReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionTrafficReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-UrlTrace.md", - "redirect_url": "/powershell/module/exchange/get-safelinksaggregatereport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Import-ContactList.md", - "redirect_url": "https://support.microsoft.com/office/import-contacts-to-outlook-bb796340-b58a-46c1-90c7-b549b8f3c5f8", - "redirect_document_id": false - }, - { - "source_path": "staffhub/docs-conceptual/index.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/docs-conceptual/intro.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/docs-conceptual/overview.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Add-StaffHubMember.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Add-StaffHubShift.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Add-StaffHubTeam.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Connect-StaffHub.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubMember.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubShifts.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubTeamsForTenant.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubUsersForTenant.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Import-StaffHubMember.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Import-StaffHubShift.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Import-StaffHubTeam.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Remove-StaffHubMember.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/Remove-StaffHubUser.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "staffhub/staffhub-ps/staffhub/staffhub.md", - "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Import-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Remove-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", - "redirect_document_id": false - }, - { - "source_path": "teams/docs-conceptual/intro.md", - "redirect_url": "/powershell/teams", - "redirect_document_id": false - }, - { - "source_path": "spmt/spmt-ps/spmt/spmt.md", - "redirect_url": "/powershell/module/spmt", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CustomNudge.md", - "redirect_url": "/powershell/module/exchange/", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CustomNudgeAssignment.md", - "redirect_url": "/powershell/module/exchange/", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CustomNudgeSettings.md", - "redirect_url": "/powershell/module/exchange/", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/New-CustomNudge.md", - "redirect_url": "/powershell/module/exchange/", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/New-CustomNudgeAssignment.md", - "redirect_url": "/powershell/module/exchange/", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Remove-CustomNudge.md", - "redirect_url": "/powershell/module/exchange/", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Remove-CustomNudgeAssignment.md", - "redirect_url": "/powershell/module/exchange/", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-CustomNudge.md", - "redirect_url": "/powershell/module/exchange/", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-CustomNudgeAssignment.md", - "redirect_url": "/powershell/module/exchange/", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-CustomNudgeSettings.md", - "redirect_url": "/powershell/module/exchange/", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficTopReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-tenantallowblocklistspoofitems", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-tenantallowblocklistspoofitems", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-exchange-online-protection-powershell", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-scc-powershell", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/New-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/new-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/New-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/new-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Remove-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/remove-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Remove-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/remove-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/set-distributiongroup", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-EOPGroup.md", - "redirect_url": "/powershell/module/exchange/set-group", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/set-mailuser", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-EOPUser.md", - "redirect_url": "/powershell/module/exchange/set-user", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Update-EOPDistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", - "redirect_document_id": false - }, - { - "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.yml", - "redirect_url": "https://review.learn.microsoft.com/en-us/powershell/module/teams/", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/use-update-exchangehelp.md", - "redirect_url": "/powershell/exchange/exchange-management-shell", - "redirect_document_id": false - }, - { - "source_path": "exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md", - "redirect_url": "/powershell/exchange/connect-to-scc-powershell", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionDocumentDetail.md", - "redirect_url": "/powershell/module/exchange/get-contentmalwaremdodetailreport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionDocumentReport.md", - "redirect_url": "/powershell/module/exchange/get-contentmalwaremdoaggregatereport", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/New-SecOpsOverrideRule.md", - "redirect_url": "/powershell/module/exchange/new-exosecopsoverriderule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Remove-SecOpsOverrideRule.md", - "redirect_url": "/powershell/module/exchange/remove-exosecopsoverriderule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-SecOpsOverrideRule.md", - "redirect_url": "/powershell/module/exchange/set-exosecopsoverriderule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/New-PhishSimOverrideRule.md", - "redirect_url": "/powershell/module/exchange/new-exophishsimoverriderule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Remove-PhishSimOverrideRule.md", - "redirect_url": "/powershell/module/exchange/remove-exophishsimoverriderule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-PhishSimOverrideRule.md", - "redirect_url": "/powershell/module/exchange/set-exophishsimoverriderule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-ConnectionByClientTypeDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-ConnectionByClientTypeReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsActiveUserReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsAVConferenceTimeReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsClientDeviceDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsClientDeviceReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsConferenceReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsP2PAVTimeReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsP2PSessionReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsPSTNConferenceTimeReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsPSTNUsageDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsUserActivitiesReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-CsUsersBlockedReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-GroupActivityReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, { - "source_path": "exchange/virtual-folder/exchange/Get-LicenseVsUsageSummaryReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-MailboxActivityReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-MailboxUsageDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-MailboxUsageReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, { - "source_path": "exchange/virtual-folder/exchange/Get-O365ClientBrowserDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-O365ClientBrowserReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-O365ClientOSDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-O365ClientOSReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-SPOActiveUserReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-SPOSkyDriveProDeployedReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-SPOSkyDriveProStorageReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-SPOTeamSiteDeployedReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-SPOTeamSiteStorageReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-SPOTenantStorageMetricReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-StaleMailboxDetailReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-StaleMailboxReport.md", - "redirect_url": "/graph/api/resources/report", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-HybridMailflow.md", - "redirect_url": "/exchange/exchange-hybrid", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-HybridMailflow.md", - "redirect_url": "/exchange/exchange-hybrid", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-PhishSimOverrideRule.md", - "redirect_url": "/powershell/module/exchange/get-exophishsimoverriderule", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Get-SecOpsOverrideRule.md", - "redirect_url": "/powershell/module/exchange/get-exosecopsoverriderule", - "redirect_document_id": false - }, - { - "source_path": "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/.openpublishing.redirection.officewebapps.json b/.openpublishing.redirection.officewebapps.json new file mode 100644 index 0000000000..6080f09e7f --- /dev/null +++ b/.openpublishing.redirection.officewebapps.json @@ -0,0 +1,4 @@ +{ + "redirections": [ + ] +} \ No newline at end of file diff --git a/.openpublishing.redirection.skype.json b/.openpublishing.redirection.skype.json new file mode 100644 index 0000000000..c4bdfdadd4 --- /dev/null +++ b/.openpublishing.redirection.skype.json @@ -0,0 +1,6324 @@ +{ + "redirections": [ + { + "source_path": "skype/virtual-folder/skype/Disable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Disable-CsOnlineSipDomain", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Enable-CsOnlineSipDomain", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Export-CsAutoAttendantHolidays", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/export-csonlineaudiofile.md", + "redirect_url": "/powershell/module/MicrosoftTeams/export-csonlineaudiofile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Find-CsGroup.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Find-CsGroup", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Find-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Find-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsApplicationMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantHolidays", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantStatus.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantStatus", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantSupportedLanguage.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantSupportedTimeZone.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantTenantInformation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantTenantInformation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCallQueue.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsEffectiveTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsMeetingMigrationStatus.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsMeetingMigrationStatus", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstanceAssociationStatus.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineAudioFile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialinConferencingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialOutPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialOutPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDirectoryTenant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDirectoryTenant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisPort", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisSwitch", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlinePstnUsage", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineSipDomain", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineTelephoneNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineUser.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoiceUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsClientConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantFederationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantLicensingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantLicensingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantMigrationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsCloudMeetingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsCloudMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsDialoutPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsDialoutPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsExternalUserCommunicationPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Import-CsAutoAttendantHolidays", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Import-CsOnlineAudioFile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallableEntity.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantCallableEntity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallFlow.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantCallFlow", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallHandlingAssociation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantDialScope.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantDialScope", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantMenu.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantMenu", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantMenuOption.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantMenuOption", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantPrompt.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantPrompt", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCallQueue.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsEdgeAllowAllKnownDomains.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsEdgeAllowList.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsEdgeAllowList", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsEdgeDomainPattern.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsEdgeDomainPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineDateTimeRange.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineDateTimeRange", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineTimeRange.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineTimeRange", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingPairedApplication.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallingExtendedNotification.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyNumber.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsPinnedApp", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Register-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAutoAttendant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCallQueue.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineAudioFile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisPort", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisSwitch", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineTelephoneNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsPinnedApp", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsApplicationMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAutoAttendant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCallQueue.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingUserDefaultNumber.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingUserDefaultNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisPort", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisSwitch", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlinePstnUsage", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceApplicationInstance.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsClientConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsPinnedApp", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantFederationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantMigrationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Start-CsExMeetingMigration.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Start-CsExMeetingMigration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Sync-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Sync-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Test-CsEffectiveTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Test-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Test-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsAutoAttendant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/Update-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Clear-CsOnlineTelephoneNumberReservation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsOrganizationalAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHuntGroup.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHuntGroupTenantInformation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUserInfo.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUserState.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDirectoryTenantNumberCities.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineNumberPortOutOrderPin.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberAvailableCount.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryCities.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantStatus.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsUpgradeStatus.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantPublicProvider.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsBroadcastMeetingPolicy.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsOrganizationalAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsHuntGroup.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineBulkAssignmentInput.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineSession.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallableEntity.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallFlow.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantDialScope.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantMenu.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantMenuOption.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantPrompt.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsHuntGroup.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Search-CsOnlineTelephoneNumberInventory.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Select-CsOnlineTelephoneNumberInventory.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsHuntGroup.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDirectoryUser.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineNumberPortOutOrderPin.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceUserBulk.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantPublicProvider.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsOnlineCarrierPortabilityIn.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsOnlinePortabilityIn.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/MicrosoftTeams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Clear-CsDeviceUpdateFile.md", + "redirect_url": "/powershell/module/skypeforbusiness/clear-csdeviceupdatefile", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Clear-CsDeviceUpdateLog.md", + "redirect_url": "/powershell/module/skypeforbusiness/clear-csdeviceupdatelog", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Clear-CsPersistentChatRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/clear-cspersistentchatroom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Convert-CsUserData.md", + "redirect_url": "/powershell/module/skypeforbusiness/convert-csuserdata", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/ConvertTo-JsonForPSWS.md", + "redirect_url": "/powershell/module/skypeforbusiness/convertto-jsonforpsws", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Copy-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/copy-csvoicepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Debug-CsAddressBookReplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csaddressbookreplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Debug-CsDataConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csdataconference", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Debug-CsInterPoolReplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csinterpoolreplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Debug-CsIntraPoolReplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csintrapoolreplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Debug-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-cslisconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Debug-CsStorageServiceFailures.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csstorageservicefailures", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Debug-CsUnifiedContactStore.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csunifiedcontactstore", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsAdDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-csaddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsAdForest.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-csadforest", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-cscomputer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-cshostingprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsMeetingRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-csmeetingroom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-cspublicprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-csuser", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsAdDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-csaddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsAdForest.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-csadforest", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-cscomputer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-cshostingprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsMeetingRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-csmeetingroom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-cspublicprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsReplica.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-csreplica", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsTopology.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-cstopology", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-csuser", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsArchivingData.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-csarchivingdata", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-csconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-cslisconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsPersistentChatData.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-cspersistentchatdata", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsRgsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-csrgsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsUserData.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-csuserdata", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAccessEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaccessedgeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAdContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadcontact", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAdditionalInternalDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadditionalinternaldomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAdDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAddressBookConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaddressbookconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAddressBookNormalizationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaddressbooknormalizationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAddressBookNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaddressbooknormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAdForest.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadforest", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAdminRole.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadminrole", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAdminRoleAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadminroleassignment", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAdPrincipal.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadprincipal", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAdServerSchema.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadserverschema", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAdUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaduser", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAllowedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csalloweddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAnalogDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csanalogdevice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAnnouncement.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csannouncement", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csapplicationendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsArchivingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csarchivingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsArchivingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csarchivingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAudioConferencingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaudioconferencingprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAudioTestServiceApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaudiotestserviceapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAuthConfig.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csauthconfig", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutodiscoverConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csautodiscoverconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAVEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csavedgeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsBackupServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbackupserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsBackupServiceStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbackupservicestatus", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsBandwidthPolicyServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbandwidthpolicyserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsBlockedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csblockeddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsBroadcastMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbroadcastmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsBroadcastMeetingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbroadcastmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsBusyOptions.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbusyoptions", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCallParkOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscallparkorbit", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCallViaWorkPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscallviaworkpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCdrConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscdrconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscertificate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClientAccessLicense.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientaccesslicense", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClientCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientcertificate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClientPinInfo.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientpininfo", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClientPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClientVersionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientversionconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClientVersionPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientversionpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClientVersionPolicyRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientversionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCloudCallDataConnector.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscloudcalldataconnector", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCloudCallDataConnectorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscloudcalldataconnectorconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCloudMeetingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscloudmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClsAgentStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclsagentstatus", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClsRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclsregion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClsScenario.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclsscenario", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClsSearchTerm.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclssearchterm", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsClsSecurityGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclssecuritygroup", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCommonAreaPhone.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscommonareaphone", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscomputer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsConferenceDirectory.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencedirectory", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsConferenceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencedisclaimer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsConferencingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsConfigurationStoreLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconfigurationstorelocation", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsConversationHistoryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconversationhistoryconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCpsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscpsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsDatabaseMirrorState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdatabasemirrorstate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsDeviceUpdateConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdeviceupdateconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsDeviceUpdateRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdeviceupdaterule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsDiagnosticConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdiagnosticconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsDiagnosticHeaderConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdiagnosticheaderconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsDialInConferencingAccessNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencingaccessnumber", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsDialInConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsDialInConferencingDtmfConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencingdtmfconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsDialInConferencingLanguageList.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencinglanguagelist", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdialplan", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsEffectivePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cseffectivepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csenhancedemergencyservicedisclaimer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csexternalusercommunicationpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsExUmContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csexumcontact", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsFileTransferFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csfiletransferfilterconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsFIPSConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csfipsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsGraphPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csgraphpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsGroupPickupUserOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csgrouppickupuserorbit", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHealthMonitoringConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshealthmonitoringconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHostedVoicemailPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshostedvoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshostingprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHybridApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHybridMediationServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridmediationserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHybridPSTNAppliance.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridpstnappliance", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHybridPSTNSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridpstnsite", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsImConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csimconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsImFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csimfilterconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsImTranslationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csimtranslationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsIPPhonePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsKerberosAccountAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cskerberosaccountassignment", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsLisCivicAddress.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csliscivicaddress", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsLisLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslislocation", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsLisPort.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslisport", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsLisServiceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslisserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsLisSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslissubnet", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsLisSwitch.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslisswitch", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csliswirelessaccesspoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslocationpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsManagementConnection.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmanagementconnection", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsManagementStoreReplicationStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmanagementstorereplicationstatus", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsMcxConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmcxconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsMediaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmediaconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsMeetingRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmeetingroom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsMobilityPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsNetworkBandwidthPolicyProfile.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkbandwidthpolicyprofile", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsNetworkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsNetworkInterface.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkinterface", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsNetworkInterRegionRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkinterregionroute", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsNetworkInterSitePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkintersitepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsNetworkRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsNetworkRegionLink.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkregionlink", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsNetworkSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworksite", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsNetworkSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOAuthConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csoauthconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOAuthServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csoauthserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOutboundCallingNumberTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csoutboundcallingnumbertranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOutboundTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csoutboundtranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPartnerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspartnerapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatAddin.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchataddin", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatCategory.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatcategory", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatComplianceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatcomplianceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatEligiblePrincipal.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchateligibleprincipal", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatroom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatstate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPinPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspinpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPlatformServiceSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csplatformservicesettings", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspool", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPoolBackupRelationship.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspoolbackuprelationship", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPoolFabricState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspoolfabricstate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPoolUpgradeReadinessState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspoolupgradereadinessstate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPresenceManagementState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspresencemanagementstate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPresencePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspresencepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPresenceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspresenceprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPrivacyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csprivacyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsProxyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csproxyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPstnUsage.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspstnusage", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspublicprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsPushNotificationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspushnotificationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsQoEConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csqoeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsRegistrarConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csregistrarconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsReportingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csreportingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsRgsAgentGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsagentgroup", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsRgsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsRgsHolidaySet.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsholidayset", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsRgsHoursOfBusiness.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgshoursofbusiness", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsRgsQueue.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsqueue", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsRgsWorkflow.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsworkflow", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsServerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csserverapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsServerPatchVersion.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csserverpatchversion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsServerVersion.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csserverversion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsService.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csservice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsSimpleUrlConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cssimpleurlconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsSipDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cssipdomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsSipResponseCodeTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cssipresponsecodetranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cssite", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsSlaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csslaconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsStaticRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csstaticroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsStorageServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csstorageserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsUpgradeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csteamsupgradeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csteamsupgradepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTelemetryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstelemetryconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantHybridConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstenanthybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantUpdateTimeWindow.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstenantupdatetimewindow", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTestDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstestdevice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTestUserCredential.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstestusercredential", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsThirdPartyVideoSystem.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csthirdpartyvideosystem", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsThirdPartyVideoSystemPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csthirdpartyvideosystempolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTopology.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstopology", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTrunk.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrunk", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrunkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTrustedApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTrustedApplicationComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplicationcomputer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTrustedApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplicationendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTrustedApplicationPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplicationpool", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUCPhoneConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csucphoneconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUICulture.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuiculture", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUnassignedNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csunassignednumber", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUpgradeDomainInfo.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csupgradedomaininfo", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuser", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserAcp.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuseracp", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserCallForwardingSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csusercallforwardingsettings", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserDatabaseState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserdatabasestate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserDelegates.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserdelegates", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserLocationStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserlocationstatus", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserPoolInfo.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserpoolinfo", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserPstnSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserpstnsettings", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserReplicatorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserreplicatorconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserServicesConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserservicesconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserServicesPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserservicespolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserSession.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csusersession", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserSettingsPageConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csusersettingspageconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsUserTeamMembers.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserteammembers", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVideoInteropServerConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvideointeropserverconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvideointeropserversynthetictransactionconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVideoTrunk.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvideotrunk", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVideoTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvideotrunkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVoiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoiceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVoicemailReroutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicemailreroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicenormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVoiceRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoiceroute", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVoiceTestConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicetestconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsWatcherNodeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cswatchernodeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsWebServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cswebserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsWindowsService.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cswindowsservice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsXmppAllowedPartner.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csxmppallowedpartner", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsXmppGatewayConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csxmppgatewayconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsArchivingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csarchivingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsCallViaWorkPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cscallviaworkpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsClientPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csclientpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsClientVersionPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csclientversionpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsConferencingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csdialplan", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsGraphPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csgraphpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsHostedVoicemailPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cshostedvoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsIPPhonePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cslocationpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsMobilityPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsOUPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csoupermission", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsPersistentChatPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cspersistentchatpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsPinPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cspinpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsPresencePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cspresencepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsSetupPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cssetuppermission", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csteamsupgradepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsThirdPartyVideoSystemPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csthirdpartyvideosystempolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsUserServicesPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csuserservicespolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csvoicepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csvoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CSAnnouncementFile.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csannouncementfile", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cscertificate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsCompanyPhoneNormalizationRules.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cscompanyphonenormalizationrules", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsDeviceUpdate.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csdeviceupdate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsLegacyConferenceDirectory.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cslegacyconferencedirectory", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsLegacyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cslegacyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cslisconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsPersistentChatData.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cspersistentchatdata", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsRgsAudioFile.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csrgsaudiofile", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsRgsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csrgsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsUserData.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csuserdata", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Install-CsAdServerSchema.md", + "redirect_url": "/powershell/module/skypeforbusiness/install-csadserverschema", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Install-CsDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/install-csdatabase", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Install-CsMirrorDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/install-csmirrordatabase", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsArchivingDatabasePurge.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csarchivingdatabasepurge", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsBackupServiceSync.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csbackupservicesync", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsCdrDatabasePurge.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-cscdrdatabasepurge", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsComputerFailBack.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-cscomputerfailback", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsComputerFailOver.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-cscomputerfailover", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsDatabaseFailover.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csdatabasefailover", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsManagementServerFailover.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csmanagementserverfailover", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsManagementStoreReplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csmanagementstorereplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsPoolFailBack.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-cspoolfailback", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsPoolFailOver.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-cspoolfailover", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsQoEDatabasePurge.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csqoedatabasepurge", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsRgsStoreReplicateData.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csrgsstorereplicatedata", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsStorageServiceFlush.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csstorageserviceflush", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Invoke-CsUcsRollback.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csucsrollback", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Lock-CsClientPin.md", + "redirect_url": "/powershell/module/skypeforbusiness/lock-csclientpin", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Merge-CsLegacyTopology.md", + "redirect_url": "/powershell/module/skypeforbusiness/merge-cslegacytopology", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsAnalogDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csanalogdevice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csapplicationendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsCommonAreaPhone.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-cscommonareaphone", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsConferenceDirectory.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csconferencedirectory", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsExUmContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csexumcontact", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsLegacyUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-cslegacyuser", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsManagementServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csmanagementserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsMeetingRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csmeetingroom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsRgsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csrgsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsThirdPartyVideoSystem.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csthirdpartyvideosystem", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Move-CsUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csuser", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAdditionalInternalDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csadditionalinternaldomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAddressBookConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csaddressbookconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAddressBookNormalizationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csaddressbooknormalizationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAddressBookNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csaddressbooknormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAdminRole.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csadminrole", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAllowedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csalloweddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAnalogDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csanalogdevice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAnnouncement.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csannouncement", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsArchivingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csarchivingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsArchivingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csarchivingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutodiscoverConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csautodiscoverconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAVEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csavedgeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsBandwidthPolicyServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csbandwidthpolicyserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsBlockedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csblockeddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCallParkOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscallparkorbit", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCallViaWorkPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscallviaworkpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCdrConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscdrconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsClientPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclientpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsClientPolicyEntry.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclientpolicyentry", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsClientVersionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclientversionconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsClientVersionPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclientversionpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsClientVersionPolicyRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclientversionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCloudCallDataConnectorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscloudcalldataconnectorconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsClsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsClsProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclsprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsClsRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclsregion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsClsScenario.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclsscenario", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsClsSecurityGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclssecuritygroup", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCommonAreaPhone.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscommonareaphone", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsConferenceDirectory.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csconferencedirectory", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csconferencingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsConferencingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCpsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscpsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsDeviceUpdateConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdeviceupdateconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsDiagnosticConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdiagnosticconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsDiagnosticHeaderConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdiagnosticheaderconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsDiagnosticsFilter.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdiagnosticsfilter", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsDialInConferencingAccessNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdialinconferencingaccessnumber", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsDialInConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdialinconferencingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsDialInConferencingDtmfConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdialinconferencingdtmfconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdialplan", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsEmergencyNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csemergencynumber", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsExtendedTest.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csextendedtest", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csexternalusercommunicationpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsExUmContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csexumcontact", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsFileTransferFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csfiletransferfilterconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsFIPSConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csfipsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsGroupPickupUserOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csgrouppickupuserorbit", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsHealthMonitoringConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cshealthmonitoringconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsHostedVoicemailPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cshostedvoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cshostingprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsHybridApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsHybridPSTNSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cshybridpstnsite", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsImConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csimconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsImFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csimfilterconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsImTranslationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csimtranslationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsIssuedCertId.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csissuedcertid", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsKerberosAccount.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cskerberosaccount", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsKerberosAccountAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cskerberosaccountassignment", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cslocationpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsMcxConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csmcxconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsMediaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csmediaconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsMobilityPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsNetworkBandwidthPolicyProfile.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkbandwidthpolicyprofile", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsNetworkBWAlternatePath.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkbwalternatepath", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsNetworkBWPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkbwpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsNetworkInterRegionRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkinterregionroute", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsNetworkInterSitePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkintersitepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsNetworkMediaBypassConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkmediabypassconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsNetworkRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsNetworkRegionLink.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkregionlink", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsNetworkSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworksite", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsNetworkSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOAuthServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csoauthserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOutboundCallingNumberTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csoutboundcallingnumbertranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOutboundTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csoutboundtranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPartnerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspartnerapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatAddin.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchataddin", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatCategory.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatcategory", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatComplianceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatcomplianceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatroom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPinPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspinpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPlatformServiceSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csplatformservicesettings", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPresencePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspresencepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPresenceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspresenceprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPrivacyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csprivacyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsProxyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csproxyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspublicprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsPushNotificationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspushnotificationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsQoEConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csqoeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRegistrarConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csregistrarconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsReportingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csreportingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsAgentGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsagentgroup", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsAnswer.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsanswer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsCallAction.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgscallaction", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsHoliday.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsholiday", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsHolidaySet.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsholidayset", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsHoursOfBusiness.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgshoursofbusiness", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsPrompt.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsprompt", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsQuestion.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsquestion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsQueue.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsqueue", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsTimeRange.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgstimerange", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRgsWorkflow.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsworkflow", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsServerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csserverapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSimpleUrl.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssimpleurl", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSimpleUrlConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssimpleurlconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSimpleUrlEntry.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssimpleurlentry", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSipDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipdomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSipProxyCustom.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxycustom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSipProxyRealm.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxyrealm", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSipProxyTCP.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxytcp", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSipProxyTLS.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxytls", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSipProxyTransport.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxytransport", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSipProxyUseDefault.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxyusedefault", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSipProxyUseDefaultCert.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxyusedefaultcert", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsSipResponseCodeTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipresponsecodetranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsStaticRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csstaticroute", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsStaticRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csstaticroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsStorageServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csstorageserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csteamsupgradepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTelemetryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstelemetryconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantUpdateTimeWindow.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstenantupdatetimewindow", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTestDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstestdevice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsThirdPartyVideoSystem.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csthirdpartyvideosystem", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsThirdPartyVideoSystemPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csthirdpartyvideosystempolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstrunkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTrustedApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTrustedApplicationComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplicationcomputer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTrustedApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplicationendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTrustedApplicationPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplicationpool", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsUCPhoneConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csucphoneconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsUnassignedNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csunassignednumber", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsUserReplicatorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csuserreplicatorconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsUserServicesConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csuserservicesconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsUserServicesPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csuserservicespolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVideoInteropServerConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvideointeropserverconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvideointeropserversynthetictransactionconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVideoTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvideotrunkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVoicemailReroutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicemailreroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicenormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVoiceRegex.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoiceregex", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVoiceRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoiceroute", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVoiceTestConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicetestconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsWatcherNodeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cswatchernodeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsWebLink.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csweblink", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsWebOrigin.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csweborigin", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsWebServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cswebserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsWebTrustedCACertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cswebtrustedcacertificate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/New-CsXmppAllowedPartner.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csxmppallowedpartner", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Publish-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/publish-cslisconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Publish-CsTopology.md", + "redirect_url": "/powershell/module/skypeforbusiness/publish-cstopology", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Register-CsHybridPSTNAppliance.md", + "redirect_url": "/powershell/module/skypeforbusiness/register-cshybridpstnappliance", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAdditionalInternalDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csadditionalinternaldomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAddressBookConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csaddressbookconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAddressBookNormalizationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csaddressbooknormalizationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAddressBookNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csaddressbooknormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAdminRole.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csadminrole", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAllowedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csalloweddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAnalogDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csanalogdevice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAnnouncement.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csannouncement", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsArchivingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csarchivingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsArchivingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csarchivingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAutodiscoverConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csautodiscoverconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAVEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csavedgeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsBackupServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csbackupserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsBandwidthPolicyServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csbandwidthpolicyserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsBlockedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csblockeddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsBusyOptions.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csbusyoptions", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCallParkOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscallparkorbit", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCallViaWorkPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscallviaworkpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCdrConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscdrconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscertificate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsClientPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsClientVersionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientversionconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsClientVersionPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientversionpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsClientVersionPolicyRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientversionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsClsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsClsRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclsregion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsClsScenario.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclsscenario", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsClsSecurityGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclssecuritygroup", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCommonAreaPhone.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscommonareaphone", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsConferenceDirectory.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencedirectory", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsConferenceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencedisclaimer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsConferencingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsConfigurationStoreLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconfigurationstorelocation", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsConversationHistoryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconversationhistoryconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCpsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscpsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsDeviceUpdateConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdeviceupdateconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsDeviceUpdateRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdeviceupdaterule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsDiagnosticConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdiagnosticconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsDiagnosticHeaderConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdiagnosticheaderconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsDialInConferencingAccessNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialinconferencingaccessnumber", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsDialInConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialinconferencingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsDialInConferencingDtmfConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialinconferencingdtmfconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialplan", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csenhancedemergencyservicedisclaimer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csexternalusercommunicationpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsExUmContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csexumcontact", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsFileTransferFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csfiletransferfilterconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsFIPSConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csfipsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsGroupPickupUserOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csgrouppickupuserorbit", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsHealthMonitoringConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cshealthmonitoringconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsHostedVoicemailPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cshostedvoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cshostingprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsHybridApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsHybridPSTNSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cshybridpstnsite", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsImConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csimconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsImFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csimfilterconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsImTranslationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csimtranslationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsKerberosAccountAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cskerberosaccountassignment", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsLisLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslislocation", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsLisPort.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslisport", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsLisServiceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslisserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsLisSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslissubnet", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsLisSwitch.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslisswitch", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csliswirelessaccesspoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslocationpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsManagementConnection.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csmanagementconnection", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsMcxConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csmcxconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsMediaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csmediaconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsMobilityPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkBandwidthPolicyProfile.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkbandwidthpolicyprofile", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkInterRegionRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkinterregionroute", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkInterSitePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkintersitepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkRegionLink.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkregionlink", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworksite", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOAuthServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csoauthserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOutboundCallingNumberTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csoutboundcallingnumbertranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOutboundTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csoutboundtranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPartnerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspartnerapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatAddin.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchataddin", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatCategory.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatcategory", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatComplianceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatcomplianceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatMessage.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatmessage", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatroom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPinPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspinpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPlatformServiceSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csplatformservicesettings", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPresencePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspresencepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPresenceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspresenceprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPrivacyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csprivacyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsProxyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csproxyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspublicprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsPushNotificationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspushnotificationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsQoEConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csqoeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsRegistrarConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csregistrarconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsReportingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csreportingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsRgsAgentGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsagentgroup", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsRgsHolidaySet.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsholidayset", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsRgsHoursOfBusiness.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgshoursofbusiness", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsRgsQueue.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsqueue", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsRgsWorkflow.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsworkflow", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsServerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csserverapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsSimpleUrlConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cssimpleurlconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsSipDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cssipdomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsSipResponseCodeTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cssipresponsecodetranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsSlaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csslaconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsSlaDelegates.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cssladelegates", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsStaticRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csstaticroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsStorageServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csstorageserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csteamsupgradepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTelemetryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstelemetryconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantUpdateTimeWindow.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstenantupdatetimewindow", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTestDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstestdevice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTestUserCredential.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstestusercredential", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsThirdPartyVideoSystem.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csthirdpartyvideosystem", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsThirdPartyVideoSystemPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csthirdpartyvideosystempolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrunkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTrustedApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTrustedApplicationComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplicationcomputer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTrustedApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplicationendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTrustedApplicationPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplicationpool", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsUCPhoneConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csucphoneconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsUnassignedNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csunassignednumber", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsUserAcp.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csuseracp", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsUserReplicatorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserreplicatorconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsUserServicesConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserservicesconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsUserServicesPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserservicespolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsUserStoreBackupData.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserstorebackupdata", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVideoInteropServerConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvideointeropserverconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvideointeropserversynthetictransactionconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVideoTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvideotrunkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVoiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoiceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVoicemailReroutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicemailreroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicenormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVoiceRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoiceroute", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVoiceTestConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicetestconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsWatcherNodeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cswatchernodeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsWebServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cswebserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsXmppAllowedPartner.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csxmppallowedpartner", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Request-CsCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/request-cscertificate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Reset-CsDeviceUpdateRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/reset-csdeviceupdaterule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Reset-CsNotificationQueues.md", + "redirect_url": "/powershell/module/skypeforbusiness/reset-csnotificationqueues", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Reset-CsPoolRegistrarState.md", + "redirect_url": "/powershell/module/skypeforbusiness/reset-cspoolregistrarstate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Reset-CsRoutingGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/reset-csroutinggroup", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Restore-CsDeviceUpdateRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/restore-csdeviceupdaterule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Revoke-CsClientCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/revoke-csclientcertificate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Revoke-CsOUPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/revoke-csoupermission", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Revoke-CsSetupPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/revoke-cssetuppermission", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Search-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/search-csclslogging", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAccessEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csaccessedgeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAddressBookConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csaddressbookconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAddressBookNormalizationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csaddressbooknormalizationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAddressBookNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csaddressbooknormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAdminRole.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csadminrole", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAllowedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csalloweddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAnalogDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csanalogdevice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAnnouncement.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csannouncement", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsApplicationServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csapplicationserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsArchivingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csarchivingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsArchivingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csarchivingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsArchivingServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csarchivingserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAudioTestServiceApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csaudiotestserviceapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAuthConfig.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csauthconfig", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAutodiscoverConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csautodiscoverconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAVEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csavedgeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsBackupServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csbackupserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsBandwidthPolicyServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csbandwidthpolicyserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsBlockedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csblockeddomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsBroadcastMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csbroadcastmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsBusyOptions.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csbusyoptions", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCallParkOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscallparkorbit", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCallParkServiceMusicOnHoldFile.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscallparkservicemusiconholdfile", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCallViaWorkPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscallviaworkpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCceApplianceConfigurationReplicationStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscceapplianceconfigurationreplicationstatus", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCceApplianceDeploymentStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscceappliancedeploymentstatus", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCceApplianceStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscceappliancestatus", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCdrConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscdrconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscertificate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsClientPin.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclientpin", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsClientPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclientpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsClientVersionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclientversionconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsClientVersionPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclientversionpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsClientVersionPolicyRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclientversionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCloudCallDataConnector.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscloudcalldataconnector", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCloudCallDataConnectorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscloudcalldataconnectorconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsClsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsClsRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclsregion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsClsScenario.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclsscenario", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsClsSearchTerm.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclssearchterm", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsClsSecurityGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclssecuritygroup", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCommonAreaPhone.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscommonareaphone", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsConferenceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconferencedisclaimer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsConferenceServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconferenceserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconferencingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsConferencingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsConfigurationStoreLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconfigurationstorelocation", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsConversationHistoryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconversationhistoryconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCpsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscpsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsDeviceUpdateConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdeviceupdateconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsDiagnosticConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdiagnosticconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsDiagnosticHeaderConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdiagnosticheaderconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsDialInConferencingAccessNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdialinconferencingaccessnumber", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsDialInConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdialinconferencingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsDialInConferencingDtmfConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdialinconferencingdtmfconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdialplan", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsDirector.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdirector", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsEdgeServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csedgeserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csenhancedemergencyservicedisclaimer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csexternalusercommunicationpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsExUmContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csexumcontact", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsFileTransferFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csfiletransferfilterconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsFIPSConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csfipsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsGroupPickupUserOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csgrouppickupuserorbit", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsHealthMonitoringConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshealthmonitoringconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsHostedVoicemailPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshostedvoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshostingprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsHybridApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsHybridMediationServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridmediationserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsHybridPSTNAppliance.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridpstnappliance", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsHybridPSTNSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridpstnsite", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsImConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csimconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsImFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csimfilterconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsImTranslationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csimtranslationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsIPPhonePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsKerberosAccountAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cskerberosaccountassignment", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsKerberosAccountPassword.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cskerberosaccountpassword", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsLisLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslislocation", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsLisPort.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslisport", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsLisServiceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslisserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsLisSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslissubnet", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsLisSwitch.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslisswitch", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csliswirelessaccesspoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslocationpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsManagementConnection.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmanagementconnection", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsManagementServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmanagementserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsMcxConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmcxconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsMediaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmediaconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsMediationServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmediationserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsMeetingRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmeetingroom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsMobilityPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsMonitoringServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmonitoringserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsNetworkBandwidthPolicyProfile.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkbandwidthpolicyprofile", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsNetworkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsNetworkInterRegionRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkinterregionroute", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsNetworkInterSitePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkintersitepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsNetworkRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsNetworkRegionLink.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkregionlink", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsNetworkSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworksite", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsNetworkSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOAuthConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csoauthconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOAuthServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csoauthserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOutboundCallingNumberTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csoutboundcallingnumbertranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOutboundTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csoutboundtranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPartnerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspartnerapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatActiveServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatactiveserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatAddin.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchataddin", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatCategory.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatcategory", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatComplianceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatcomplianceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatroom", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatState.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatstate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPinPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspinpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPlatformServiceSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csplatformservicesettings", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPresenceManagementState.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspresencemanagementstate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPresencePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspresencepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPresenceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspresenceprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPrivacyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csprivacyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsProxyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csproxyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPstnGateway.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspstngateway", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPstnUsage.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspstnusage", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspublicprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsPushNotificationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsQoEConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csqoeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsRegistrar.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csregistrar", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsRegistrarConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csregistrarconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsReportingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csreportingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsRgsAgentGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsagentgroup", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsRgsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsRgsHolidaySet.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsholidayset", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsRgsHoursOfBusiness.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgshoursofbusiness", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsRgsQueue.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsqueue", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsRgsWorkflow.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsworkflow", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsServerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csserverapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsSimpleUrlConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cssimpleurlconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsSipDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cssipdomain", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsSipResponseCodeTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cssipresponsecodetranslationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cssite", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsSlaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csslaconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsStaticRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csstaticroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsStorageServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csstorageserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsUpgradeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csteamsupgradeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csteamsupgradepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTelemetryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstelemetryconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantHybridConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstenanthybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantUpdateTimeWindow.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstenantupdatetimewindow", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTestDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstestdevice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTestUserCredential.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstestusercredential", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsThirdPartyVideoSystem.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csthirdpartyvideosystem", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsThirdPartyVideoSystemPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csthirdpartyvideosystempolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstrunkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTrustedApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstrustedapplication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTrustedApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstrustedapplicationendpoint", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTrustedApplicationPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstrustedapplicationpool", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUCPhoneConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csucphoneconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUICulture.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuiculture", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUnassignedNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csunassignednumber", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuser", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUserAcp.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuseracp", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUserCallForwardingSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csusercallforwardingsettings", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUserDatabaseState.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserdatabasestate", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUserDelegates.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserdelegates", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUserPstnSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserpstnsettings", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUserReplicatorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserreplicatorconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUserServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUserServicesConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserservicesconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUserServicesPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserservicespolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsUserTeamMembers.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserteammembers", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVideoGateway.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvideogateway", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvideointeropserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServerConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvideointeropserverconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvideointeropserversynthetictransactionconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVideoTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvideotrunkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVoiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoiceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVoicemailReroutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicemailreroutingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicenormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVoiceRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoiceroute", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVoiceTestConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicetestconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsWatcherNodeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cswatchernodeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsWebServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cswebserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsWebServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cswebserviceconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsXmppAllowedPartner.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csxmppallowedpartner", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsXmppGatewayConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csxmppgatewayconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Show-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/show-csclslogging", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/skype.md", + "redirect_url": "/powershell/module/skypeforbusiness/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/index.md", + "redirect_url": "/powershell/module/skypeforbusiness/", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Start-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/start-csclslogging", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Start-CsPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/start-cspool", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Start-CsWindowsService.md", + "redirect_url": "/powershell/module/skypeforbusiness/start-cswindowsservice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Stop-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/stop-csclslogging", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Stop-CsWindowsService.md", + "redirect_url": "/powershell/module/skypeforbusiness/stop-cswindowsservice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Sync-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/sync-csclslogging", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Sync-CsUserData.md", + "redirect_url": "/powershell/module/skypeforbusiness/sync-csuserdata", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsAddressBookService.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csaddressbookservice", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsAddressBookWebQuery.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csaddressbookwebquery", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsASConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csasconference", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsAudioConferencingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csaudioconferencingprovider", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsAVConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csavconference", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsAVEdgeConnectivity.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csavedgeconnectivity", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsCertificateConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cscertificateconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsClientAuth.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csclientauth", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsClientAuthentication.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csclientauthentication", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cscomputer", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csdatabase", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsDataConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csdataconference", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsDialInConferencing.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csdialinconferencing", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csdialplan", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsExStorageConnectivity.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csexstorageconnectivity", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsExStorageNotification.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csexstoragenotification", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsExUMConnectivity.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csexumconnectivity", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsExUMVoiceMail.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csexumvoicemail", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsFederatedPartner.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csfederatedpartner", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsGroupExpansion.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csgroupexpansion", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsGroupIM.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csgroupim", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsIM.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csim", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsInterTrunkRouting.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csintertrunkrouting", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsKerberosAccountAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cskerberosaccountassignment", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsLisCivicAddress.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csliscivicaddress", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cslisconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cslocationpolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsManagementServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csmanagementserver", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsMcxConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csmcxconference", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsMcxP2PIM.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csmcxp2pim", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsMcxPushNotification.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csmcxpushnotification", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsOUPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csoupermission", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsP2PAV.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csp2pav", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csp2pvideointeropserversiptrunkav", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsPersistentChatMessage.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cspersistentchatmessage", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsPhoneBootstrap.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csphonebootstrap", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsPresence.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cspresence", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsPstnOutboundCall.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cspstnoutboundcall", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsPstnPeerToPeerCall.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cspstnpeertopeercall", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsRegistration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csregistration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsReplica.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csreplica", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsSetupPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cssetuppermission", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsTopology.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cstopology", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cstrunkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsUcwaConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csucwaconference", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsUnifiedContactStore.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csunifiedcontactstore", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csvoicenormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csvoicepolicy", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsVoiceRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csvoiceroute", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsVoiceTestConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csvoicetestconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsVoiceUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csvoiceuser", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsWatcherNodeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cswatchernodeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsWebApp.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cswebapp", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsWebAppAnonymous.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cswebappanonymous", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsWebScheduler.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cswebscheduler", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsXmppIM.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csxmppim", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Uninstall-CsDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/uninstall-csdatabase", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Uninstall-CsMirrorDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/uninstall-csmirrordatabase", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Unlock-CsClientPin.md", + "redirect_url": "/powershell/module/skypeforbusiness/unlock-csclientpin", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Unpublish-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/unpublish-cslisconfiguration", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Unregister-CsHybridPSTNAppliance.md", + "redirect_url": "/powershell/module/skypeforbusiness/unregister-cshybridpstnappliance", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsAddressBook.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-csaddressbook", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsAdminRole.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-csadminrole", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-csclslogging", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsTenantMeetingUrl.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-cstenantmeetingurl", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsUserData.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-csuserdata", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsUserDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-csuserdatabase", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Add-CsSlaDelegates.md", + "redirect_url": "/powershell/module/skypeforbusiness/add-cssladelegates", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Approve-CsDeviceUpdateRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/approve-csdeviceupdaterule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Backup-CsPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/backup-cspool", + "redirect_document_id": true + } + ] +} diff --git a/.openpublishing.redirection.spmt.json b/.openpublishing.redirection.spmt.json new file mode 100644 index 0000000000..73f0d186b2 --- /dev/null +++ b/.openpublishing.redirection.spmt.json @@ -0,0 +1,54 @@ +{ + "redirections": [ + { + "source_path": "spmt/spmt-ps/spmt/spmt.md", + "redirect_url": "/powershell/module/microsoft.sharepoint.migrationtool.powershell", + "redirect_document_id": false + }, + { + "source_path": "spmt/spmt-ps/spmt/Add-SPMTTask.md", + "redirect_url": "/powershell/module/microsoft.sharepoint.migrationtool.powershell/add-spmttask", + "redirect_document_id": false + }, + { + "source_path": "spmt/spmt-ps/spmt/Get-SPMTMigration.md", + "redirect_url": "/powershell/module/microsoft.sharepoint.migrationtool.powershell/get-spmtmigration", + "redirect_document_id": false + }, + { + "source_path": "spmt/spmt-ps/spmt/Register-SPMTMigration.md", + "redirect_url": "/powershell/module/microsoft.sharepoint.migrationtool.powershell/register-spmtmigration", + "redirect_document_id": false + }, + { + "source_path": "spmt/spmt-ps/spmt/Remove-SPMTTask.md", + "redirect_url": "/powershell/module/microsoft.sharepoint.migrationtool.powershell/remove-spmttask", + "redirect_document_id": false + }, + { + "source_path": "spmt/spmt-ps/spmt/SharePointMigrationTool.md", + "redirect_url": "/powershell/module/microsoft.sharepoint.migrationtool.powershell/sharepointmigrationtool", + "redirect_document_id": false + }, + { + "source_path": "spmt/spmt-ps/spmt/Show-SPMTMigration.md", + "redirect_url": "/powershell/module/microsoft.sharepoint.migrationtool.powershell/show-spmtmigration", + "redirect_document_id": false + }, + { + "source_path": "spmt/spmt-ps/spmt/Start-SPMTMigration.md", + "redirect_url": "/powershell/module/microsoft.sharepoint.migrationtool.powershell/start-spmtmigration", + "redirect_document_id": false + }, + { + "source_path": "spmt/spmt-ps/spmt/Stop-SPMTMigration.md", + "redirect_url": "/powershell/module/microsoft.sharepoint.migrationtool.powershell/stop-spmtmigration", + "redirect_document_id": false + }, + { + "source_path": "spmt/spmt-ps/spmt/Unregister-SPMTMigration.md", + "redirect_url": "/powershell/module/microsoft.sharepoint.migrationtool.powershell/unregister-spmtmigration", + "redirect_document_id": false + } + ] +} \ No newline at end of file diff --git a/.openpublishing.redirection.teams.json b/.openpublishing.redirection.teams.json new file mode 100644 index 0000000000..7cc7ac6b8b --- /dev/null +++ b/.openpublishing.redirection.teams.json @@ -0,0 +1,3019 @@ +{ + "redirections": [ + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/", + "redirect_document_id": false + }, + { + "source_path": "teams/docs-conceptual/intro.md", + "redirect_url": "/powershell/module/microsoftteams/", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Add-TeamChannelUser.md", + "redirect_url": "/powershell/module/microsoftteams/add-teamchanneluser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Add-TeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/add-teamuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Clear-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Clear-TeamsEnvironmentConfig.md", + "redirect_url": "/powershell/module/microsoftteams/clear-teamsenvironmentconfig", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Complete-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Connect-MicrosoftTeams.md", + "redirect_url": "/powershell/module/microsoftteams/connect-microsoftteams", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Disable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/microsoftteams/disable-csonlinesipdomain", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Disconnect-MicrosoftTeams.md", + "redirect_url": "/powershell/module/microsoftteams/disconnect-microsoftteams", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Enable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/microsoftteams/enable-csonlinesipdomain", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Export-CsAcquiredPhoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/export-csacquiredphonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Export-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/microsoftteams/export-csautoattendantholidays", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Find-CsGroup.md", + "redirect_url": "/powershell/module/microsoftteams/find-csgroup", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Find-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/find-csonlineapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-ALLM365TeamsApps.md", + "redirect_url": "/powershell/module/microsoftteams/get-allm365teamsapps", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-AssociatedTeam.md", + "redirect_url": "/powershell/module/microsoftteams/get-associatedteam", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csapplicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csapplicationmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantholidays", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendantStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantstatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendantSupportedLanguage.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendantSupportedTimeZone.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendantTenantInformation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendanttenantinformation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsBatchPolicyAssignmentOperation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csbatchpolicyassignmentoperation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsBatchTeamsDeploymentStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csbatchteamsdeploymentstatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscallqueue", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscallinglineidentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsCloudCallDataConnection.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscloudcalldataconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/get-cseffectivetenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsExportAcquiredPhoneNumberStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csgrouppolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsHybridTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/get-cshybridtelephonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/get-csinboundblockednumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/get-csinboundexemptnumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsMeetingMigrationStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csmeetingmigrationstatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineaudiofile", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingbridge", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencinglanguagessupported", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingservicenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencinguser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialoutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialinConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDirectoryTenant.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedirectorytenant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineenhancedemergencyservicedisclaimer", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineliscivicaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelislocation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelisport", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelissubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelisswitch", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineliswirelessaccesspoint", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinepstngateway", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinepstnusage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineschedule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinesipdomain", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineTelephoneNumberCountry.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumberorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineTelephoneNumberType.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumbertype", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoiceroute", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoiceuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoicemailusersettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsPhoneNumberAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csphonenumberassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/get-csphonenumbertag", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/get-cspolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsSdgBulkSignInRequestStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-cssdgbulksigninrequeststatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsSdgBulkSignInRequestsSummary.md", + "redirect_url": "/powershell/module/microsoftteams/get-cssdgbulksigninrequestssummary", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/get-cssharedcallqueuehistorytemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamtemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamTemplateList.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamtemplatelist", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsaipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsAcsFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsacsfederationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsapppermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsappsetuppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscallholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscallparkpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamschannelspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsclientconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscortanapolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamseducationassignmentsapppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEducationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamseducationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamseventspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsExternalAccessConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsexternalaccessconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsfeedbackpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsfilespolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsfirstpartymeetingtemplateconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsguestcallingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsguestmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsguestmessagingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMediaLoggingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmedialoggingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingbroadcastconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingbroadcastpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingTemplateConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingtemplateconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmessagingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmultitenantorganizationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsnetworkroamingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsNotificationAndFeedsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsnotificationandfeedspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsrecordingrolloutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsSettingsCustomApp.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssettingscustomapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsapppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionConnector.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionconnector", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionErrorReport.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionerrorreport", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionOperation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionoperation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionSyncResult.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionsyncresult", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionteammap", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionWfmTeam.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmteam", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionWfmUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsSipDevicesConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssipdevicesconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssurvivablebranchappliance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsTargetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamstargetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamstranslationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsupdatemanagementpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsUpgradeConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsupgradeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsupgradepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvdipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvideointeropservicepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsworkloadpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenant.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantfederationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantLicensingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantlicensingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantmigrationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantNetworkConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworksite", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenanttrustedipaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsUserCallingSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-csusercallingsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsUserPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csuserpolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsUserPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/get-csuserpolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsUserPolicyPackageRecommendation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/get-csvideointeropserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-M365TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/get-m365teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-M365UnifiedCustomPendingApps.md", + "redirect_url": "/powershell/module/microsoftteams/get-m365unifiedcustompendingapps", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-M365UnifiedTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-m365unifiedtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-SharedWithTeam.md", + "redirect_url": "/powershell/module/microsoftteams/get-sharedwithteam", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-SharedWithTeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-sharedwithteamuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-Team.md", + "redirect_url": "/powershell/module/microsoftteams/get-team", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamAllChannel.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamallchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamChannelUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamchanneluser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamIncomingChannel.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamincomingchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamTargetingHierarchyStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamtargetinghierarchystatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csapplicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/grant-cscallinglineidentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsDialoutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csdialoutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsGroupPolicyPackageAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csgrouppolicypackageassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsaipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsapppermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsappsetuppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscallholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscallparkpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamschannelspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscortanapolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamseventspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsfeedbackpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsfilespolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmediaconnectivitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMediaLoggingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmedialoggingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingbroadcastpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmessagingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsrecordingrolloutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsshiftspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsupdatemanagementpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsupgradepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvdipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvideointeropservicepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsworkloadpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/grant-cstenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsUserPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csuserpolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Import-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/microsoftteams/import-csautoattendantholidays", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Import-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/microsoftteams/import-csonlineaudiofile", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csapplicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantCallFlow.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantcallflow", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantCallHandlingAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantCallableEntity.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantcallableentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantDialScope.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantdialscope", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantMenu.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantmenu", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantMenuOption.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantmenuoption", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantPrompt.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantprompt", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsBatchPolicyAssignmentOperation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csbatchpolicyassignmentoperation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsBatchPolicyPackageAssignmentOperation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csbatchpolicypackageassignmentoperation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsBatchTeamsDeployment.md", + "redirect_url": "/powershell/module/microsoftteams/new-csbatchteamsdeployment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscallqueue", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscallinglineidentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsCloudCallDataConnection.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscloudcalldataconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsCustomPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscustompolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsEdgeAllowAllKnownDomains.md", + "redirect_url": "/powershell/module/microsoftteams/new-csedgeallowallknowndomains", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsEdgeAllowList.md", + "redirect_url": "/powershell/module/microsoftteams/new-csedgeallowlist", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsEdgeDomainPattern.md", + "redirect_url": "/powershell/module/microsoftteams/new-csedgedomainpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/new-csgrouppolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsHybridTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/new-cshybridtelephonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/new-csinboundblockednumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/new-csinboundexemptnumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineDateTimeRange.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinedatetimerange", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinedirectroutingtelephonenumberuploadorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineliscivicaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinelislocation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinepstngateway", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineschedule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinetelephonenumberorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineTelephoneNumberReleaseOrder.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinetelephonenumberreleaseorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineTimeRange.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinetimerange", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinevoiceroute", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinevoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsSdgBulkSignInRequest.md", + "redirect_url": "/powershell/module/microsoftteams/new-cssdgbulksigninrequest", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-cssharedcallqueuehistorytemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamtemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsaipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsapppermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsappsetuppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscallholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscallparkpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamschannelspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsComplianceRecordingPairedApplication.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscortanapolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEmergencyCallingExtendedNotification.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencycallingextendednotification", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEmergencyNumber.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencynumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamseventspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsfeedbackpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsfilespolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsHiddenMeetingTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamshiddenmeetingtemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsHiddenTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamshiddentemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingbroadcastpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmessagingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsnetworkroamingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsrecordingrolloutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftsconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftsconnectionbatchteammap", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamssurvivablebranchappliance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamstranslationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsupdatemanagementpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsvdipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsworkloadpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantnetworksite", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenanttrustedipaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsUserCallingDelegate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csusercallingdelegate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/new-csvideointeropserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/microsoftteams/new-csvoicenormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-Team.md", + "redirect_url": "/powershell/module/microsoftteams/new-team", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/new-teamchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/new-teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Register-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/register-csonlinedialinconferencingservicenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csapplicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csautoattendant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscallqueue", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscallinglineidentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsCustomPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscustompolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csgrouppolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsHybridTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cshybridtelephonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csinboundblockednumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineaudiofile", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinedialinconferencingtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineliscivicaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelislocation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelisport", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelissubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelisswitch", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineliswirelessaccesspoint", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinepstngateway", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineschedule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinetelephonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinevoiceroute", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsPhoneNumberAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csphonenumberassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csphonenumbertag", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cssharedcallqueuehistorytemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamtemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsaipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsapppermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsappsetuppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsaudioconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscallholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscallparkpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamschannelspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscortanapolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamseventspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsfeedbackpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsfilespolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingbroadcastpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmessagingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsnetworkroamingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsnotificationandfeedspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsrecordingrolloutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsShiftsConnectionTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsconnectionteammap", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsShiftsScheduleRecord.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsschedulerecord", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamssurvivablebranchappliance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsTargetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamstargetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamstranslationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsupdatemanagementpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsvdipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsworkloadpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantnetworksite", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenanttrustedipaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsUserCallingDelegate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csusercallingdelegate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsUserLicenseGracePeriod.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csuserlicensegraceperiod", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csvideointeropserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-SharedWithTeam.md", + "redirect_url": "/powershell/module/microsoftteams/remove-sharedwithteam", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-Team.md", + "redirect_url": "/powershell/module/microsoftteams/remove-team", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamChannelUser.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamchanneluser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamTargetingHierarchy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamtargetinghierarchy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csapplicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csapplicationmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/set-csautoattendant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/set-cscallqueue", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/set-cscallinglineidentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/set-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/set-csinboundblockednumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/set-csinboundexemptnumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencingbridge", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencingservicenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencingtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencinguser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineenhancedemergencyservicedisclaimer", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineliscivicaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelislocation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelisport", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelissubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelisswitch", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineliswirelessaccesspoint", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinepstngateway", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinepstnusage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineschedule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoiceApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceroute", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoicemailusersettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsPhoneNumberAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/set-csphonenumberassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/set-csphonenumbertag", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/set-cssharedcallqueuehistorytemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsaipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsAcsFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsapppermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsappsetuppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscallholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscallparkpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamschannelspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsclientconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscortanapolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamseducationassignmentsapppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEducationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamseducationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamseventspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsExternalAccessConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsexternalaccessconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsfeedbackpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsfilespolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsguestcallingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsguestmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsguestmessagingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingbroadcastconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingbroadcastpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmessagingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmultitenantorganizationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsnetworkroamingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsNotificationAndFeedsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsnotificationandfeedspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsrecordingrolloutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsSettingsCustomApp.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssettingscustomapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsShiftsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftsapppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftsconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsSipDevicesConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssipdevicesconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssurvivablebranchappliance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsTargetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamstargetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamstranslationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsupdatemanagementpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsUpgradeConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsupgradeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsvdipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsworkloadpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantblockedcallingnumbers", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantfederationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantmigrationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantnetworksite", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenanttrustedipaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsUser.md", + "redirect_url": "/powershell/module/microsoftteams/set-csuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsUserCallingDelegate.md", + "redirect_url": "/powershell/module/microsoftteams/set-csusercallingdelegate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsUserCallingSettings.md", + "redirect_url": "/powershell/module/microsoftteams/set-csusercallingsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/set-csvideointeropserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-Team.md", + "redirect_url": "/powershell/module/microsoftteams/set-team", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamArchivedState.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamarchivedstate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamPicture.md", + "redirect_url": "/powershell/module/microsoftteams/set-teampicture", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamTargetingHierarchy.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamtargetinghierarchy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamsEnvironmentConfig.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamsenvironmentconfig", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Start-CsExMeetingMigration.md", + "redirect_url": "/powershell/module/microsoftteams/start-csexmeetingmigration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Sync-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/sync-csonlineapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/test-cseffectivetenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/test-csinboundblockednumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsTeamsShiftsConnectionValidate.md", + "redirect_url": "/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/test-csteamstranslationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/microsoftteams/test-csvoicenormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/unregister-csonlinedialinconferencingservicenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/update-csautoattendant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsCustomPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/update-cscustompolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/update-csphonenumbertag", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/update-csteamtemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/update-csteamsshiftsconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/update-csteamsshiftsconnectioninstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-M365TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/update-m365teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-M365UnifiedCustomPendingApp.md", + "redirect_url": "/powershell/module/microsoftteams/update-m365unifiedcustompendingapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-M365UnifiedTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/update-m365unifiedtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/export-csonlineaudiofile.md", + "redirect_url": "/powershell/module/microsoftteams/export-csonlineaudiofile", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/get-csteamsmessagingconfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmessagingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/set-csteamsmessagingconfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmessagingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Add-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Disable-CsTeamsShiftsConnectionErrorReport.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsMainlineAttendantFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-LicenseReportForChangeNotificationSubscription.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamFunSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamGuestSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamMemberSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamMessagingSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsCloudMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamFunSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamGuestSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamMemberSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamMessagingSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Update-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/teams.md", + "redirect_url": "/powershell/module/microsoftteams/", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/index.md", + "redirect_url": "/powershell/module/microsoftteams/", + "redirect_document_id": true + } + ] +} \ No newline at end of file diff --git a/.openpublishing.redirection.whiteboard.json b/.openpublishing.redirection.whiteboard.json new file mode 100644 index 0000000000..1611895c32 --- /dev/null +++ b/.openpublishing.redirection.whiteboard.json @@ -0,0 +1,74 @@ +{ + "redirections": [ + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md", + "redirect_url": "/powershell/module/whiteboardadmin/get-originalfluidwhiteboards", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md", + "redirect_url": "/powershell/module/whiteboardadmin/get-originalfluidwhiteboardsfortenant", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md", + "redirect_url": "/powershell/module/whiteboardadmin/get-whiteboar", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardOwners.md", + "redirect_url": "/powershell/module/whiteboardadmin/get-whiteboardowners", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md", + "redirect_url": "/powershell/module/whiteboardadmin/get-whiteboardsettings", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md", + "redirect_url": "/powershell/module/whiteboardadmin/get-whiteboardsfortenant", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md", + "redirect_url": "/powershell/module/whiteboardadmin/get-whiteboardsfortenantmigrate", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md", + "redirect_url": "/powershell/module/whiteboardadmin/get-whiteboardsmigrate", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md", + "redirect_url": "/powershell/module/whiteboardadmin/invoke-transferallwhiteboards", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md", + "redirect_url": "/powershell/module/whiteboardadmin/remove-whiteboard", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md", + "redirect_url": "/powershell/module/whiteboardadmin/restore-whiteboard", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md", + "redirect_url": "/powershell/module/whiteboardadmin/set-whiteboardowner", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md", + "redirect_url": "/powershell/module/whiteboardadmin/set-whiteboardsettings", + "redirect_document_id": false + }, + { + "source_path": "whiteboard/whiteboard-ps/whiteboard/whiteboard.md", + "redirect_url": "/powershell/module/whiteboardadmin/whiteboardadmin", + "redirect_document_id": false + } + ] +} \ No newline at end of file diff --git a/README.md b/README.md index 31d229b9d1..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 f23758f7ff..fc8364d818 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -33,22 +33,24 @@ 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). > +> - CBA or app-only authentication is available in Office 365 operated by 21Vianet in China. +> > - REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). > > If the procedures in this article don't work for you, verify that you don't have Beta versions of the PackageManagement or PowerShellGet modules installed by running the following command: `Get-InstalledModule PackageManagement -AllVersions; Get-InstalledModule PowerShellGet -AllVersions`. > > - In Exchange Online PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: -> - [New-UnifiedGroup](/powershell/module/exchange/new-unifiedgroup) -> - [Remove-UnifiedGroup](/powershell/module/exchange/remove-unifiedgroup) -> - [Remove-UnifiedGroupLinks](/powershell/module/exchange/remove-unifiedgrouplinks) -> - [Add-UnifiedGroupLinks](/powershell/module/exchange/add-unifiedgrouplinks) +> - [New-UnifiedGroup](/powershell/module/exchangepowershell/new-unifiedgroup) +> - [Remove-UnifiedGroup](/powershell/module/exchangepowershell/remove-unifiedgroup) +> - [Remove-UnifiedGroupLinks](/powershell/module/exchangepowershell/remove-unifiedgrouplinks) +> - [Add-UnifiedGroupLinks](/powershell/module/exchangepowershell/add-unifiedgrouplinks) > > You can use Microsoft Graph to replace most of the functionality from those cmdlets. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview). > > - In Security & Compliance PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: -> - [Get-ComplianceSearchAction](/powershell/module/exchange/get-compliancesearchaction) -> - [New-ComplianceSearch](/powershell/module/exchange/new-compliancesearch) -> - [Start-ComplianceSearch](/powershell/module/exchange/start-compliancesearch) +> - [Get-ComplianceSearchAction](/powershell/module/exchangepowershell/get-compliancesearchaction) +> - [New-ComplianceSearch](/powershell/module/exchangepowershell/new-compliancesearch) +> - [Start-ComplianceSearch](/powershell/module/exchangepowershell/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. > @@ -523,7 +525,7 @@ To assign custom role groups to the application using service principals, do the $SP = Get-ServicePrincipal -Identity "SP for Azure AD App ExO PowerShell CBA" ``` - For detailed syntax and parameter information, see [New-ServicePrincipal](/powershell/module/exchange/new-serviceprincipal). + For detailed syntax and parameter information, see [New-ServicePrincipal](/powershell/module/exchangepowershell/new-serviceprincipal). 3. In Exchange Online PowerShell or Security & Compliance PowerShell, run the following command to add the service principal as a member of the custom role group: @@ -537,4 +539,4 @@ To assign custom role groups to the application using service principals, do the Add-RoleGroupMember -Identity "Contoso View-Only Recipients" -Member $SP.Identity ``` - For detailed syntax and parameter information, see [Add-RoleGroupMember](/powershell/module/exchange/add-rolegroupmember). + For detailed syntax and parameter information, see [Add-RoleGroupMember](/powershell/module/exchangepowershell/add-rolegroupmember). diff --git a/exchange/docs-conceptual/client-advanced-settings.md b/exchange/docs-conceptual/client-advanced-settings.md index dc5a85dd20..4ef196f94f 100644 --- a/exchange/docs-conceptual/client-advanced-settings.md +++ b/exchange/docs-conceptual/client-advanced-settings.md @@ -21,8 +21,8 @@ description: "Security & Compliance PowerShell advanced settings for Microsoft P 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) +- [New-Label](/powershell/module/exchangepowershell/new-label) or [Set-Label](/powershell/module/exchangepowershell/set-label) +- [New-LabelPolicy](/powershell/module/exchangepowershell/new-labelpolicy) or [Set-LabelPolicy](/powershell/module/exchangepowershell/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). @@ -317,11 +317,11 @@ Use this advanced setting in conjunction with *ScannerMinCPU* to limit CPU consu - 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. +The value is set to **100** by default, which means there is no limit of maximum CPU consumption. In this case, the scanner process tries 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. +If you set **ScannerMaxCPU** to less than 100, the scanner monitors the CPU consumption over the last 30 minutes. If the average CPU crossed the limit you set, it starts 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**. +The limit on the number of threads continues as long as CPU consumption is higher than the limit set for **ScannerMaxCPU**. ## ScannerMinCPU @@ -334,7 +334,7 @@ Used only if *ScannerMaxCPU* is not equal to 100, and cannot be set to a number 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. +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 starts adding new threads to scan more files in parallel, until the CPU consumption reaches the level you have set for *ScannerMaxCPU*-15. ## ScannerConcurrencyLevel @@ -361,17 +361,17 @@ Set-LabelPolicy -Identity Scanner -AdvancedSettings @{ScannerConcurrencyLevel="8 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. +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 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** +**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** +**Skip files that are either read-only or archived**: To use an OR logic, run the same property multiple times. For example: diff --git a/exchange/docs-conceptual/cmdlet-property-sets.md b/exchange/docs-conceptual/cmdlet-property-sets.md index bbd2cf89d9..af41ff82fd 100644 --- a/exchange/docs-conceptual/cmdlet-property-sets.md +++ b/exchange/docs-conceptual/cmdlet-property-sets.md @@ -49,8 +49,8 @@ The available property sets for the **Get-EXOCasMailbox** cmdlet and the propert For more information, see: -- [Get-EXOCASMailbox](/powershell/module/exchange/get-exocasmailbox) -- [Get-CASMailbox](/powershell/module/exchange/get-casmailbox) +- [Get-EXOCASMailbox](/powershell/module/exchangepowershell/get-exocasmailbox) +- [Get-CASMailbox](/powershell/module/exchangepowershell/get-casmailbox) ## Get-EXOMailbox property sets @@ -86,8 +86,8 @@ The available property sets for the **Get-EXOMailbox** cmdlet and the properties For more information, see: -- [Get-EXOMailbox](/powershell/module/exchange/get-exomailbox) -- [Get-Mailbox](/powershell/module/exchange/get-mailbox) +- [Get-EXOMailbox](/powershell/module/exchangepowershell/get-exomailbox) +- [Get-Mailbox](/powershell/module/exchangepowershell/get-mailbox) ## Get-EXOMailboxStatistics property sets @@ -100,8 +100,8 @@ The available property sets for the **Get-EXOMailboxStatistics** cmdlet and the For more information, see: -- [Get-EXOMailboxStatistics](/powershell/module/exchange/get-exomailboxstatistics) -- [Get-MailboxStatistics](/powershell/module/exchange/get-mailboxstatistics) +- [Get-EXOMailboxStatistics](/powershell/module/exchangepowershell/get-exomailboxstatistics) +- [Get-MailboxStatistics](/powershell/module/exchangepowershell/get-mailboxstatistics) ## Get-EXORecipient property sets @@ -121,5 +121,5 @@ The available property sets for the **Get-EXORecipient** cmdlet and the properti For more information, see: -- [Get-EXORecipient](/powershell/module/exchange/get-exorecipient) -- [Get-Recipient](/powershell/module/exchange/get-recipient) +- [Get-EXORecipient](/powershell/module/exchangepowershell/get-exorecipient) +- [Get-Recipient](/powershell/module/exchangepowershell/get-recipient) diff --git a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md index 2f484fd336..8baf75ef9f 100644 --- a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md +++ b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md @@ -28,10 +28,10 @@ The rest of this article explains how to connect using managed identity, and the > [!NOTE] > In Exchange Online PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: > -> - [New-UnifiedGroup](/powershell/module/exchange/new-unifiedgroup) -> - [Remove-UnifiedGroup](/powershell/module/exchange/remove-unifiedgroup) -> - [Remove-UnifiedGroupLinks](/powershell/module/exchange/remove-unifiedgrouplinks) -> - [Add-UnifiedGroupLinks](/powershell/module/exchange/add-unifiedgrouplinks) +> - [New-UnifiedGroup](/powershell/module/exchangepowershell/new-unifiedgroup) +> - [Remove-UnifiedGroup](/powershell/module/exchangepowershell/remove-unifiedgroup) +> - [Remove-UnifiedGroupLinks](/powershell/module/exchangepowershell/remove-unifiedgrouplinks) +> - [Add-UnifiedGroupLinks](/powershell/module/exchangepowershell/add-unifiedgrouplinks) > > You can use Microsoft Graph to replace most of the functionality from those cmdlets. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview). > @@ -68,7 +68,7 @@ The first command in the PowerShell runbook must be the `Connect-ExchangeOnline. Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com ``` -After that, as a test, you can start with as simple, low-impact command in the runbook before moving on to more complex commands or scripts. For example: +After that, as a test, you can start with as simple, low risk command in the runbook before moving on to more complex commands or scripts. For example: ```powershell Get-AcceptedDomain | Format-Table Name @@ -118,7 +118,7 @@ Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com -M You get the ManagedIdentityAccount value from [Step 3: Store the user-assigned managed identity in a variable](#step-3-store-the-user-assigned-managed-identity-in-a-variable). -After that, as a test, you can start with as simple, low-impact command in the runbook before moving on to more complex commands or scripts. For example: +After that, as a test, you can start with as simple, low risk command in the runbook before moving on to more complex commands or scripts. For example: ```powershell Get-AcceptedDomain | Format-Table Name @@ -285,7 +285,7 @@ To verify that the module imported successfully, run the following command: Get-AzAutomationModule -ResourceGroupName ContosoRG -AutomationAccountName ContosoAzAuto1 -Name ExchangeOnlineManagement ``` -During the import, the ProvisioningState property will have the value Creating. When the module import is complete, the value will change to Succeeded. +During the import, the ProvisioningState property has the value Creating. When the module import is complete, the value changes to Succeeded. For detailed syntax and parameter information, see [New-AzAutomationModule](/powershell/module/az.automation/new-azautomationmodule). diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index c762926d96..e36b948699 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -2,7 +2,7 @@ title: Connect to Exchange Online PowerShell author: chrisda manager: deniseb -ms.date: 8/21/2023 +ms.date: 07/11/2025 ms.audience: Admin audience: Admin ms.topic: article @@ -13,14 +13,17 @@ ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn how to use the Exchange Online PowerShell V3 module to connect to Exchange Online PowerShell with modern authentication and/or multi-factor authentication (MFA)." +description: "Learn how to use the Exchange Online PowerShell V3 module to connect to Exchange Online PowerShell with modern authentication and/or multifactor authentication (MFA)." --- # Connect to Exchange Online PowerShell -This article contains instructions for how to connect to Exchange Online PowerShell using the Exchange Online PowerShell module with or without multi-factor authentication (MFA). +This article contains instructions for how to connect to Exchange Online PowerShell using the Exchange Online PowerShell module with or without multifactor authentication (MFA). -The Exchange Online PowerShell module uses modern authentication for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the Exchange Online PowerShell module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). +> [!TIP] +> The connection instructions in this article also apply to Exchange Online Protection PowerShell for cloud protection of on-premises email environments without cloud mailboxes. + +The Exchange Online PowerShell module uses modern authentication for connecting to Exchange Online PowerShell and Security & Compliance PowerShell. For more information about the Exchange Online PowerShell module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). To connect to Exchange Online PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.md) and [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). @@ -30,24 +33,18 @@ To connect to Exchange Online PowerShell from C#, see [Use C# to connect to Exch - The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). - > [!NOTE] - > Remote PowerShell connections are deprecated in Exchange Online PowerShell. For more information, see [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). - > - > REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). +- 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). +- After you connect, role-based access control (RBAC) controls the cmdlets and parameters that you have or don't have access to. For more information, see [Permissions in Exchange Online](/exchange/permissions-exo/permissions-exo). To find the permissions that are required to run specific Exchange Online cmdlets, see [Find the permissions required to run any Exchange cmdlet](find-exchange-cmdlet-permissions.md). -> [!TIP] -> Having problems? Ask in the [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542) forum. - ## Step 1: Load the Exchange Online PowerShell module > [!NOTE] > If the module is already installed, you can typically skip this step and run **Connect-ExchangeOnline** without manually loading the module first. -After you've [installed the module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module), open a PowerShell window and load the module by running the following command: +After you [install the module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module), open a PowerShell window and load the module by running the following command: ```powershell Import-Module ExchangeOnlineManagement @@ -56,20 +53,18 @@ Import-Module ExchangeOnlineManagement ## Step 2: Connect and authenticate > [!NOTE] -> Connect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. +> Connect commands likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. The command that you need to run uses the following syntax: ```powershell -Connect-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). +For detailed syntax and parameter information, see [Connect-ExchangeOnline](/powershell/module/exchangepowershell/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 +77,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. @@ -90,11 +87,13 @@ For detailed syntax and parameter information, see [Connect-ExchangeOnline](/pow - Use the _SkipLoadingFormatData_ switch to avoid errors when connecting to Exchange Online PowerShell from within a Windows service. -- Using the module in PowerShell 7 requires version 2.0.4 or later. +- 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 +### Connect to Exchange Online PowerShell with an interactive sign in prompt 1. The following examples work in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: @@ -122,16 +121,16 @@ The connection examples in the following sections use modern authentication, and Connect-ExchangeOnline -UserPrincipalName lukas@fabrikam.de -ExchangeEnvironmentName O365GermanyCloud ``` -2. In the sign-in window that opens, enter your password, and then click **Sign in**. +2. In the sign-in window that opens, enter your password, and then select **Sign in**. ![Enter your password in the Sign in to your account window.](media/connect-exo-password-prompt.png) > [!NOTE] > In PowerShell 7, browser-based single sign-on (SSO) is used by default, so the sign-in prompt opens in your default web browser instead of a standalone dialog. -3. **MFA only**: A verification code is generated and delivered based on the response option that's configured for your account (for example, a text message or the Microsoft Authenticator app on your device). +3. **MFA only**: A verification code is generated and delivered based on the response option configured for your account (for example, a text message or the Microsoft Authenticator app on your device). - In the verification window that opens, enter the verification code, and then click **Verify**. + In the verification window that opens, enter the verification code, and then select **Verify**. ![Enter your verification code in the Sign in to your account window.](media/connect-exo-mfa-verify-prompt.png) @@ -161,17 +160,17 @@ The connection examples in the following sections use modern authentication, and 3. Enter your credentials on the resulting pages. - 4. In the confirmation prompt, click **Continue**. The next message should indicate success, and you can close the browser or tab. + 4. In the confirmation prompt, select **Continue**. The next message should indicate success, and you can close the browser or tab. 5. The command from step 1 continues to connect you to Exchange Online PowerShell. -### Connect to Exchange Online PowerShell without a login prompt (unattended scripts) +### Connect to Exchange Online PowerShell without a sign in prompt (unattended scripts) For complete instructions, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). ### Connect to Exchange Online PowerShell in customer organizations -For more information about partners and customer organizations, see the following topics: +For more information about partners and customer organizations, see the following articles: - [What is the Cloud Solution Provider (CSP) program?](/partner-center/csp-overview). - [Introduction to granular delegated admin privileges (GDAP)](/partner-center/gdap-introduction) @@ -180,7 +179,7 @@ This example connects to customer organizations in the following scenarios: - Connect to a customer organization using a CSP account. - Connect to a customer organization using a GDAP. -- Connect to a customer organization as a guest user. +- Connect to a customer organization as a guest. ```powershell Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com -DelegatedOrganization adatum.onmicrosoft.com @@ -217,11 +216,11 @@ Disconnect-ExchangeOnline -Confirm:$false ``` > [!NOTE] -> The disconnect command will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. +> The disconnect command likely fails if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. -## How do you know you've connected successfully? +## How do you know you connected successfully? -If you don't receive any errors, you've connected successfully. A quick test is to run an Exchange Online PowerShell cmdlet, for example, **Get-AcceptedDomain**, and see the results. +If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online PowerShell cmdlet, for example, **Get-AcceptedDomain**, and see the results. If you receive errors, check the following requirements: @@ -231,25 +230,25 @@ If you receive errors, check the following requirements: - TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive internet access policy. -- If your organization uses federated authentication, and your identity provider (IDP) and/or security token service (STS) isn't publicly available, you can't use a federated account to connect to Exchange Online PowerShell. Instead, create and use a non-federated account in Microsoft 365 to connect to Exchange Online PowerShell. +- If your organization uses federated authentication, and your identity provider (IDP) and/or security token service (STS) isn't publicly available, you can't use a federated account to connect to Exchange Online PowerShell. Instead, create and use a nonfederated account in Microsoft 365 to connect to Exchange Online PowerShell. -- REST-based connections to Exchange Online PowerShell require the PowerShellGet module, and by dependency, the PackageManagement module, so you'll receive errors if you try to connect without having them installed. For example, you might see the following error: +- REST-based connections to Exchange Online PowerShell require the PowerShellGet module. By dependency, the PowerShellGet module requires the PackageManagement module. You get errors if you try to connect without having both modules installed. For example, you might see the following error: > The term 'Update-ModuleManifest' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. For more information about the PowerShellGet and PackageManagement module requirements, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). -- After you connect, you might received an error that looks like this: +- After you connect, you might receive an error that looks like this: > Could not load file or assembly 'System.IdentityModel.Tokens.Jwt,Version=\, Culture=neutral, PublicKeyToken=\'. Could not find or load a specific file. - This error happens when the Exchange Online PowerShell module conflicts with another module that's imported into the runspace. Try connecting in a new Windows PowerShell window before importing other modules. + This error happens when the Exchange Online PowerShell module conflicts with another module imported into the runspace. Try connecting in a new Windows PowerShell window before importing other modules. ## Appendix: Comparison of old and new connection methods -This section attempts to compare older connection methods that have been replaced by the Exchange Online PowerShell module. The Basic authentication and OAuth token procedures are included for historical reference only and are no longer supported. +This section attempts to compare older connection methods the Exchange Online PowerShell module replaced. The Basic authentication and OAuth token procedures are included for historical reference only and are no longer supported. -### Connect without multi-factor authentication +### Connect without multifactor authentication - **Exchange Online PowerShell module with interactive credential prompt**: @@ -291,7 +290,7 @@ This section attempts to compare older connection methods that have been replace Import-PSSession $Session ``` -### Connect with multi-factor authentication +### Connect with multifactor authentication - **Exchange Online PowerShell module with interactive credential prompt**: @@ -367,7 +366,7 @@ This section attempts to compare older connection methods that have been replace Import-PSSession $Session ``` -### Connect to a customer organization as a guest user +### Connect to a customer organization as a guest - **Exchange Online PowerShell module**: diff --git a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md deleted file mode 100644 index 7e28d7e8a7..0000000000 --- a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Connect to Exchange Online Protection PowerShell -author: chrisda -manager: deniseb -ms.date: 8/21/2023 -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -ms.reviewer: -ms.localizationpriority: high -ms.collection: Strat_EX_Admin -ms.custom: -ms.assetid: -search.appverid: MET150 -description: "Learn how to use the Exchange Online PowerShell V3 module to connect to standalone Exchange Online Protection PowerShell with modern authentication and/or multi-factor authentication (MFA)." ---- - -# Connect to Exchange Online Protection PowerShell - -This article contains instructions for how to connect to Exchange Online Protection PowerShell using the Exchange Online PowerShell module with or without using multi-factor authentication (MFA). - -The Exchange Online PowerShell module uses modern authentication for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). - -For more information about Exchange Online Protection PowerShell, see [Exchange Online Protection PowerShell](exchange-online-protection-powershell.md). - -> [!NOTE] -> As of June 2020, the instructions for connecting to standalone Exchange Online Protection PowerShell and Exchange Online PowerShell are basically the same. If you use the **Connect-IPPSSession** cmdlet with the _ConnectionUri_ parameter value `https://ps.protection.outlook.com/powershell-liveid/`, you're redirected to the same `https://outlook.office365.com/powershell-liveid/` endpoint that's used by **Connect-ExchangeOnline** for Exchange Online PowerShell connections. -> -> Remote PowerShell connections in Exchange Online PowerShell are deprecated. For more information, see [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). -> -> REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). - -## What do you need to know before you begin? - -- The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). - -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in standalone EOP](/exchange/standalone-eop/manage-admin-role-group-permissions-in-eop). - -> [!TIP] -> Having problems? Ask for help in the [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351) forum. - -## Connect to Exchange Online Protection PowerShell using modern authentication with or without MFA - -These connection instructions use modern authentication and work with or without multi-factor authentication (MFA). - -## Step 1: Load the Exchange Online PowerShell module - -> [!NOTE] -> If the module is already installed, you can typically skip this step and run **Connect-ExchangeOnline** without manually loading the module first. - -After you've [installed the module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module), open a PowerShell window and load the module by running the following command: - -```powershell -Import-Module ExchangeOnlineManagement -``` - -## Step 2: Connect and authenticate - -> [!NOTE] -> Connect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. - -The command that you need to run uses the following syntax: - -```powershell -Connect-ExchangeOnline -UserPrincipalName [-ShowBanner:$false] -``` - -For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - -- _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). - -- With the EXO V3 module (v3.0.0 or later) and the [demise of Basic authentication (remote PowerShell) connections to Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432), you're using REST API cmdlets only. For more information, see [REST API connections in the EXO V3 module](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module). - -### Connect to Exchange Online Protection PowerShell with an interactive login prompt - -This example works in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: - -```powershell -Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com -``` - -## Step 3: Disconnect when you're finished - -Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you need to wait for the sessions to expire. To disconnect the session, run the following command: - -```powershell -Disconnect-ExchangeOnline -``` - -To silently disconnect without a confirmation prompt, run the following command: - -```powershell -Disconnect-ExchangeOnline -Confirm:$false -``` - -## How do you know you've connected successfully? - -The Exchange Online Protection Protection cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you've connected successfully. A quick test is to run an Exchange Online Protection cmdlet, for example, **Get-AcceptedDomain**, and see the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the connection steps again and pay close attention to the username and password that you use. - -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. - -- You might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: - - > The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. - - To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Exchange Online Protection PowerShell endpoint. diff --git a/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md b/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md index f34a86b8d1..f372350e60 100644 --- a/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md +++ b/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md @@ -207,7 +207,7 @@ void ParallelConnectionsToExchangeOnline() // Set the ThreadOptions to reuse the same threads for the runspaces so that - // the Exchange Online cmdlets will be available after running Connect-ExchangeOnline in each runspace. + // the Exchange Online cmdlets are available after running Connect-ExchangeOnline in each runspace. pool.ThreadOptions = PSThreadOptions.ReuseThread; diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index f8496d64d5..dfa2726eb2 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -2,7 +2,7 @@ title: Connect to Security & Compliance PowerShell author: chrisda manager: deniseb -ms.date: 12/12/2023 +ms.date: 07/11/2025 ms.audience: Admin audience: Admin ms.topic: article @@ -13,14 +13,14 @@ ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn how to use the Exchange Online PowerShell V3 module to connect to Security & Compliance PowerShell with modern authentication and/or multi-factor authentication (MFA)." +description: "Learn how to use the Exchange Online PowerShell V3 module to connect to Security & Compliance PowerShell with modern authentication and/or multifactor authentication (MFA)." --- # Connect to Security & Compliance PowerShell -This article contains instructions for how to connect to Security & Compliance PowerShell using the Exchange Online PowerShell module with or without multi-factor authentication (MFA). +This article contains instructions for how to connect to Security & Compliance PowerShell using the Exchange Online PowerShell module with or without multifactor authentication (MFA). -The Exchange Online PowerShell module uses modern authentication for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the Exchange Online PowerShell module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). +The Exchange Online PowerShell module uses modern authentication for connecting to Exchange Online PowerShell and Security & Compliance PowerShell. For more information about the Exchange Online PowerShell module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). To connect to Security & Compliance PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.md). @@ -28,19 +28,16 @@ To connect to Security & Compliance PowerShell for automation, see [App-only aut - The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). - > [!NOTE] - > Remote PowerShell connections are deprecated in Security & Compliance PowerShell. For more information, see [Deprecation of Remote PowerShell (RPS) Protocol in Security & Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). - > - > REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). +- 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](/defender-office-365/mdo-portal-permissions) and [Permissions in the Microsoft Purview compliance portal](/purview/purview-compliance-portal-permissions). +- After you connect, role-based access control (RBAC) controls the cmdlets and parameters that you have or don't have access to. For more information, see [Permissions in the Microsoft Defender portal](/defender-office-365/mdo-portal-permissions) and [Permissions in the Microsoft Purview portal](/purview/purview-permissions). ## Step 1: Load the Exchange Online PowerShell module > [!NOTE] > If the module is already installed, you can typically skip this step and run **Connect-IPPSSession** without manually loading the module first. -After you've [installed the module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module), open a PowerShell window and load the module by running the following command: +After you [install the module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module), open a PowerShell window and load the module by running the following command: ```powershell Import-Module ExchangeOnlineManagement @@ -49,7 +46,7 @@ Import-Module ExchangeOnlineManagement ## Step 2: Connect and authenticate > [!NOTE] -> Connect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. +> Connect commands likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. The command that you need to run uses the following syntax: @@ -57,7 +54,7 @@ The command that you need to run uses the following syntax: Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-AzureADAuthorizationEndpointUri ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] ``` -For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). +For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchangepowershell/connect-ippssession). - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). @@ -81,7 +78,7 @@ For detailed syntax and parameter information, see [Connect-IPPSSession](/powers - If you aren't using MFA, you should be able to use the _Credential_ parameter instead of the _UserPrincipalName_ parameter. First, run the command `$Credential = Get-Credential`, enter your username and password, and then use the variable name for the _Credential_ parameter (`-Credential $Credential`). If it doesn't work, then you need to use the _UserPrincipalName_ parameter. -### Connect to Security & Compliance PowerShell with an interactive login prompt +### Connect to Security & Compliance PowerShell with an interactive sign in prompt 1. The following examples work in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: @@ -109,20 +106,20 @@ For detailed syntax and parameter information, see [Connect-IPPSSession](/powers 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**. +2. In the sign-in window that opens, enter your password, and then select **Sign in**. ![Enter your password in the Sign in to your account window.](media/connect-exo-password-prompt.png) > [!NOTE] > In PowerShell 7, browser-based single sign-on (SSO) is used by default, so the sign in prompt opens in your default web browser instead of a standalone dialog. -3. **MFA only**: A verification code is generated and delivered based on the response option that's configured for your account (for example, a text message or the Microsoft Authenticator app on your device). +3. **MFA only**: A verification code is generated and delivered based on the response option configured for your account (for example, a text message or the Microsoft Authenticator app on your device). - In the verification window that opens, enter the verification code, and then click **Verify**. + In the verification window that opens, enter the verification code, and then select **Verify**. ![Enter your verification code in the Sign in to your account window.](media/connect-exo-mfa-verify-prompt.png) -### Connect to Security & Compliance PowerShell without a login prompt (unattended scripts) +### Connect to Security & Compliance PowerShell without a sign in prompt (unattended scripts) For complete instructions, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). @@ -132,7 +129,7 @@ The procedures in this section require version 3.0.0 or later of the module. In Security & Compliance PowerShell, you need to use the _AzureADAuthorizationEndpointUri_ with the _DelegatedOrganization_ parameter. -For more information, about partners and customer organizations, see the following topics: +For more information, about partners and customer organizations, see the following articles: - [What is the Cloud Solution Provider (CSP) program?](/partner-center/csp-overview). - [Introduction to granular delegated admin privileges (GDAP)](/partner-center/gdap-introduction) @@ -141,7 +138,7 @@ This example connects to customer organizations in the following scenarios: - Connect to a customer organization using a CSP account. - Connect to a customer organization using a GDAP. -- Connect to a customer organization as a guest user. +- Connect to a customer organization as a guest. ```powershell Connect-IPPSSession -UserPrincipalName navin@contoso.onmicrosoft.com -DelegatedOrganization adatum.onmicrosoft.com -AzureADAuthorizationEndpointUri https://login.microsoftonline.com/adatum.onmicrosoft.com @@ -162,11 +159,11 @@ Disconnect-ExchangeOnline -Confirm:$false ``` > [!NOTE] -> The disconnect command will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. +> The disconnect command likely fails if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. -## How do you know you've connected successfully? +## How do you know you connected successfully? -The Security & Compliance PowerShell cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you've connected successfully. A quick test is to run a Security & Compliance PowerShell cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. +The Security & Compliance PowerShell cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run a Security & Compliance PowerShell cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. If you receive errors, check the following requirements: @@ -176,14 +173,17 @@ If you receive errors, check the following requirements: - TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive internet access policy. -- REST-based connections to Security & Compliance PowerShell require the PowerShellGet module, and by dependency, the PackageManagement module, so you'll receive errors if you try to connect without having them installed. For example, you might see the following error: +- REST-based connections to Security & Compliance PowerShell require the PowerShellGet module. By dependency, the PowerShellGet module requires the PackageManagement module. You get errors if you try to connect without having both modules installed. For example, you might see the following error: > The term 'Update-ModuleManifest' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. For more information about the PowerShellGet and PackageManagement module requirements, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). -- You might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: +- You might fail to connect if your client IP address changes during the connection request. The failure occurs if your organization uses a source network address translation (SNAT) pool with multiple IP addresses. The connection error looks like this: > The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. - To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Security & Compliance PowerShell endpoint. + To fix the issue, do either of the following steps: + + - Use an SNAT pool that contains a single IP address. + - Force the use of a specific IP address for connections to the Security & Compliance PowerShell endpoint. 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 eafad0e59b..da394b256c 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 @@ -36,7 +36,7 @@ For additional management tasks related to remote PowerShell, see [Connect to Ex - You need to be assigned permissions before you can perform this procedure or procedures. To see what permissions you need, see the "Remote PowerShell" entry in the [Exchange infrastructure and PowerShell permissions](/Exchange/permissions/feature-permissions/infrastructure-permissions) article. -- If you're using third-party tools to customize email addresses of users, you need to disable email address policies on the affected users before you do the procedures in this article. If you don't, the **Set-User** commands change the email addresses of the users to match the applicable email address policy. To disable email address policies on users, set the value of the EmailAddressPolicyEnabled parameter to $false on the [Set-Mailbox](/powershell/module/exchange/set-mailbox) cmdlet. +- If you're using non-Microsoft tools to customize email addresses of users, you need to disable email address policies on the affected users before you do the procedures in this article. If you don't, the **Set-User** commands change the email addresses of the users to match the applicable email address policy. To disable email address policies on users, set the value of the EmailAddressPolicyEnabled parameter to $false on the [Set-Mailbox](/powershell/module/exchangepowershell/set-mailbox) cmdlet. > [!TIP] > Having problems? Ask for help in the [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) forums. 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 79a641ef08..83778c6b43 100644 --- a/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md @@ -3,7 +3,7 @@ title: "Enable or disable access to Exchange Online PowerShell" ms.author: chrisda author: chrisda manager: deniseb -ms.date: 12/11/2024 +ms.date: 07/11/2025 ms.audience: Admin audience: Admin ms.topic: article @@ -16,7 +16,7 @@ description: "Admins can learn how to disable or enable access to Exchange Onlin # Enable or disable access to Exchange Online PowerShell -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). +Exchange Online PowerShell is the administrative interface that enables you to manage the Exchange Online part of your Microsoft 365 organization from the command line (including many default email protections for all cloud mailboxes and protections in Microsoft Defender for Office 365). By default, all accounts in Microsoft 365 are allowed to use Exchange Online PowerShell. This access doesn't give users administrative capabilities. They're still limited by [role based access control (RBAC)](/exchange/permissions-exo/permissions-exo). For example, they can configure some settings on their own mailbox and manage distribution groups that they own, but not much else. @@ -29,7 +29,7 @@ Admins can use the procedures in this article to disable or enable a user's abil - The procedures in this article are available only in Exchange Online PowerShell. To connect to Exchange Online PowerShell, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - You need to be assigned permissions before you can do the procedures in this article. You have the following options: - - [Exchange Online RBAC](/exchange/permissions-exo/permissions-exo): Membership in the **Organization Management** or **Recipient Management** role groups. + - [Exchange Online permissions](/exchange/permissions-exo/permissions-exo): Membership in the **Organization Management** or **Recipient Management** role groups. - [Microsoft Entra RBAC](/microsoft-365/admin/add-users/about-admin-roles): Membership in the **Exchange Administrator** or **Global Administrator**\* roles gives users the required permissions *and* permissions for other features in Microsoft 365. > [!IMPORTANT] @@ -41,9 +41,6 @@ Admins can use the procedures in this article to disable or enable a user's abil - For detailed information about OPATH filter syntax in Exchange Online, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - ## Enable or disable access to Exchange Online PowerShell for a user This example disables access to Exchange Online PowerShell for the user `david@contoso.onmicrosoft.com`. diff --git a/exchange/docs-conceptual/exchange-cmdlet-syntax.md b/exchange/docs-conceptual/exchange-cmdlet-syntax.md index 2d91c08839..b5b796e1be 100644 --- a/exchange/docs-conceptual/exchange-cmdlet-syntax.md +++ b/exchange/docs-conceptual/exchange-cmdlet-syntax.md @@ -3,36 +3,44 @@ title: "Exchange cmdlet syntax" ms.author: chrisda author: chrisda manager: deniseb -ms.date: 9/7/2023 +ms.date: 07/11/2025 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-online ms.localizationpriority: medium ms.assetid: 85ffe9c8-7f03-4877-8e55-3cbd40228d84 -description: "Learn about the structure and syntax of cmdlets in Exchange PowerShell, Exchange Online PowerShell, standalone Exchange Online Protection (EOP) PowerShell, and Security & Compliance PowerShell." +description: "Learn about the structure and syntax of cmdlets in Exchange PowerShell, Exchange Online PowerShell, Security & Compliance PowerShell, and Exchange Online Protection PowerShell for cloud protection of on-premises email environments." --- # Exchange cmdlet syntax Exchange cmdlet reference articles use a standardized method that describes key aspects about the cmdlet. For example: -- Parameters that are available on the cmdlet. +- Parameters available on the cmdlet. - Values that each parameter accepts. - Parameters that can be used together, and parameters that need to be used separately. -This article explains these conventions, and also the syntax that's required to run commands in Exchange PowerShell. +This article explains these conventions, and also the syntax required to run commands in Exchange PowerShell. ## Command conventions in Exchange PowerShell -Exchange PowerShell help follows conventions that indicate what's required or optional, and how to enter parameters and values when you run a command. These command conventions are listed in the following table. - -|Symbol|Description| -|---|---| -|`-`|A hyphen indicates a parameter. For example, `-Identity`.| -|`< >`|Angle brackets indicate the possible values for a parameter. For example, `-Location ` or -Enabled \<$true \| $false\>.| -|`[ ]`|Square brackets indicate optional parameters and their values. For example, `[-WhatIf]` or `[-ResultSize ]`.

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

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

For example, `Get-Mailbox [[-Identity] ]` means the _Identity_ parameter is positional (because it's enclosed in square brackets) and optional (because the whole parameter-value pair is enclosed in square brackets), so you can use `Get-Mailbox -Identity ` or `Get-Mailbox `. Similarly, `Set-Mailbox [-Identity] ` means the _Identity_ parameter is positional (because it's enclosed in square brackets) and required (because the whole parameter-value pair isn't enclosed in square brackets), so you can use `Set-Mailbox -Identity ` or `Set-Mailbox `.| -|`|`|Pipe symbols in parameter values indicate a choice between values. For example, -Enabled \<$true \| $false\> indicates the _Enabled_ parameter can have the value `$true` or `$false`.| +Exchange PowerShell help follows conventions to indicate required or optional information, and how to enter parameters and values when you run a command. These command conventions are described in the following list: + +- `-`: A hyphen indicates a parameter. For example, `-Identity`. +- `< >`: Angle brackets indicate the possible values for a parameter. For example, `-Location ` or `-Enabled <$true | $false>`. +- `[ ]`: Square brackets indicate optional parameters and their values. For example, `[-WhatIf]` or `[-ResultSize ]`. + - Parameter-value pairs not enclosed in square brackets are required. For example, `-Password `. + - Square brackets around the parameter name itself indicates a _positional_ parameter where you can use the parameter value without specifying the parameter name. Positional parameters are required or optional. For example: + - `Get-Mailbox [[-Identity] ]` means the _Identity_ parameter is: + - Positional because the parameter enclosed in square brackets. + - Optional because the whole parameter-value pair is enclosed in square brackets. + - So, you can use `Get-Mailbox -Identity ` or `Get-Mailbox `. + - `Set-Mailbox [-Identity] ` means the _Identity_ parameter is: + - Positional because the parameter is enclosed in square brackets. + - Required because the whole parameter-value pair isn't enclosed in square brackets. + - So, you can use `Set-Mailbox -Identity ` or `Set-Mailbox `. +- `|`: Pipe symbols in parameter values indicate a choice between values. For example, `-Enabled <$true | $false>` indicates the _Enabled_ parameter can have the value `$true` or `$false`. These command conventions help you understand how a command is constructed. Except for the hyphen that indicates a parameter, you don't use these symbols as they're described in the table when you run cmdlets in Exchange PowerShell. @@ -116,26 +124,38 @@ If you enclose the string in single quotation marks, the only special character ## Command operators in Exchange PowerShell -The following table shows the valid operators that you can use in an Exchange command. Some of these symbols were also described in the earlier [Command conventions in Exchange PowerShell](#command-conventions-in-exchange-powershell) section. However, these symbols have different meanings when they're used on the command line as operators. For example, the minus sign that's used to indicate a parameter can also be used in a command as a mathematical operator. - -|Operator|Description| -|---|---| -|`=`|The equal sign is an assignment character. The value on the right side of the equal sign is assigned to the variable on the left side of the equal sign (for example, `$x= Get-Mailbox`). You can also use other characters with the equal sign:
  • `+=`: Add the value on the right side of the equal sign to the current value that's contained in the variable on the left side of the equal sign.
  • `-=`: Subtract the value on the right side of the equal sign from the current value that's contained in the variable on the left side of the equal sign.
  • `*=`: Multiply the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
  • `/=`: Divide the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
  • `%=`: Modify the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
| -|`:`|Use a colon to separate a parameter's name from the parameter's value. For example, `-Enabled:$True`. A colon separator works and is optional on virtually all parameter-value pairs. A colon separator is required on switch parameters. For more information about switch parameters, see [about_Parameters](/powershell/module/microsoft.powershell.core/about/about_parameters).| -|`!`|The exclamation point is the logical NOT operator. The combined pair `!=` means "not equal to."| -|`[ ]`|Brackets specify the index value of an array position. Index values are offsets that always start at zero. For example, in the array named `$Red`, the value of the tenth position in the array is `$Red[9]`.

Brackets can also assign a type to a variable. For example, to identify the variable named `$A` as XML, use `$A=[XML] "value"`. The following variable types are available: `Array`, `Bool`, `Byte`, `Char`, `Char[]`, `Decimal`, `Double`, `Float`, `Int`, `Int[]`, `Long`, `Long[]`, `RegEx`, `Single`, `ScriptBlock`, `String`, `Type`, and `XML.`| -|`{ }`|Use braces to include an expression in a command. For example, `Get-Process | Where {$_.HandleCount -gt 400}`| -|`|`|Use the pipe symbol to pipe the output of one command to another command. For example, `Get-Mailbox -Server SRV1 | Set-Mailbox -ProhibitSendQuota 2GB`.| -|`>`|Use the right-angle bracket to send the output of a command to a file. If the file already exists, the contents are overwritten. For example, `Get-TransportRule > "C:\My Documents\TransportRules.txt"`.| -|`>>`|Use double right-angle brackets to append the output of a command to an existing file. If the file doesn't exist, a new file is created. For example, `Get-TransportRule >> "C:\My Documents\TransportRules.txt"`.| -|`"`|Use double quotation marks to enclose text strings that contain spaces. As previously described, variables are replaced with their actual values.| -|`$`|The dollar sign indicates a variable. For example, to create a variable named `$Blue` with the value 10, use `$Blue = 10`. After you store the variable, you can use it as the value of a parameter.| -|`@`|The at symbol references an associative array. For more information, see [about_Arrays](/powershell/module/microsoft.powershell.core/about/about_arrays).| -|`$( )`|A dollar sign with parentheses indicates command substitution. You can use command substitution when you want to use the output of one command as an argument in another command. For example, `Get-ChildItem $(Read-Host -Prompt "Enter FileName: ")`.| -|`..`|Double-periods indicate a value range. For example, if an array contains several indexes, you can return the values of all indexes between the second and fifth indexes by running the command: `$Blue[2..5]`.| -|`+`|The plus sign operator adds two values together. For example, `6 + 6` equals `12`.| -|`-`|The minus sign operator subtracts one value from another value (for example, `12 - 6` equals `6`) or indicates a negative number (for example, `-6 * 6` equals `-36`).| -|`*`|You can use an asterisk to:
  • **Match strings**: For example, `Get-User | Where-Object {$_.Department -like 'Sales*'})`
  • **Multiply numeric values**: For example, `6 * 6` equals `36`
  • **Repeat the string value a specified number of times**: For example, `"Test" * 3` equals `TestTestTest`
| -|`/`|A forward slash divides one value by another. For example, `6 / 6` equals `1`.| -|`%`|The percent sign has the following uses:
  • In a numerical evaluation, it returns the remainder from a division operator. For example, `6 % 4` equals `2`.
  • In a [pipeline](/powershell/module/microsoft.powershell.core/about/about_pipelines), it's shorthand for the **ForEach-Object** cmdlet. For example, `Import-Csv C:\MyFile.csv | ForEach-Object {Set-Mailbox $_.Identity -Name $_.Name}` is the same as `Import-Csv C:\MyFile.csv | % {Set-Mailbox $_.Identity -Name $_.Name}`.
| -|`?`|The question mark character is shorthand for the **Where-Object** cmdlet. For example, `Get-Alias | Where-Object {$_.Definition -eq "Clear-Host"}` is the same as `Get-Alias | ? {$_.Definition -eq "Clear-Host"}`.| +The following list shows the valid operators you can use in an Exchange command. Some of these symbols were also described in the earlier [Command conventions in Exchange PowerShell](#command-conventions-in-exchange-powershell) section. However, these symbols have different meanings when used as operators. For example, the minus sign that indicates a parameter can also be used as a mathematical operator. + +- `=`: The equal sign is an assignment character. The value on the right side of the equal sign is assigned to the variable on the left side. For example, `$x = Get-Mailbox`. You can also use other characters with the equal sign: + - `+=`: Add the value on the right side of the equal sign to the current value in the variable on the left side. + - `-=`: Subtract the value on the right side of the equal sign from the current in the variable on the left side. + - `*=`: Multiply the current value of the variable on the left side of the equal sign by the value specified on the right side. + - `/=`: Divide the current value of the variable on the left side of the equal sign by the value specified on the right side. + - `%=`: Modify the current value of the variable on the left side of the equal sign by the value specified on the right side. +- `:`: Use a colon to separate a parameter name from the parameter value. For example, `-Enabled:$True`. + - A colon separator works and is optional on virtually all parameter-value pairs. + - A colon separator is required on switch parameters. For more information about switch parameters, see [about_Parameters](/powershell/module/microsoft.powershell.core/about/about_parameters). +- `!`: The exclamation point is the logical NOT operator. The combined pair `!=` means "not equal to." +- `[ ]`: Brackets specify the index value of an array position. Index values are offsets that always start at zero. For example, in the array named `$Red`, the value of the tenth position in the array is `$Red[9]`. + + Brackets can also assign a type to a variable. For example, to identify the variable named `$A` as XML, use `$A=[XML] "value"`. The following variable types are available: `Array`, `Bool`, `Byte`, `Char`, `Char[]`, `Decimal`, `Double`, `Float`, `Int`, `Int[]`, `Long`, `Long[]`, `RegEx`, `Single`, `ScriptBlock`, `String`, `Type`, and `XML.` +- `{ }`: Use braces to include an expression in a command. For example, `Get-Process | Where {$_.HandleCount -gt 400}`. +- `|`: Use the pipe symbol to pipe the output of one command to another command. For example, `Get-Mailbox -Server SRV1 | Set-Mailbox -ProhibitSendQuota 2GB`. +- `>`: Use the right-angle bracket to send the output of a command to a file. If the file already exists, the contents are overwritten. For example, `Get-TransportRule > "C:\My Documents\TransportRules.txt"`. +- `>>`: Use double right-angle brackets to append the output of a command to an existing file. If the file doesn't exist, a new file is created. For example, `Get-TransportRule >> "C:\My Documents\TransportRules.txt"`. +- `"`: Use double quotation marks to enclose text strings that contain spaces. As previously described, variables are replaced with their actual values. +- `$`: The dollar sign indicates a variable. For example, to create a variable named `$Blue` with the value 10, use `$Blue = 10`. After you store the variable, you can use it as a parameter value. +- `@`: The at symbol references an associative array. For more information, see [about_Arrays](/powershell/module/microsoft.powershell.core/about/about_arrays). +- `$( )`: A dollar sign with parentheses indicates command substitution. You can use command substitution when you want to use the output of one command as an argument in another command. For example, `Get-ChildItem $(Read-Host -Prompt "Enter FileName: ")`. +- `..`: Double-periods indicate a value range. For example, if an array contains several indexes, you can return the values of all indexes between the second and fifth indexes by running the command: `$Blue[2..5]`. +- `+`: The plus sign operator adds two values together. For example, `6 + 6` equals `12`. +- `-`: The minus sign operator subtracts one value from another value (for example, `12 - 6` equals `6`) or indicates a negative number (for example, `-6 * 6` equals `-36`). +- `*`: You can use an asterisk for the following tasks: + - **Match strings**: For example, `Get-User | Where-Object {$_.Department -like 'Sales*'})`. + - **Multiply numeric values**: For example, `6 * 6` equals `36`. + - **Repeat the string value a specified number of times**: For example, `"Test" * 3` equals `TestTestTest`. +- `/`: A forward slash divides one value by another. For example, `6 / 6` equals `1`. +- `%`: The percent sign has the following uses: + - In a numerical evaluation, it returns the remainder from a division operator. For example, `6 % 4` equals `2`. + - In a [pipeline](/powershell/module/microsoft.powershell.core/about/about_pipelines), it's shorthand for the **ForEach-Object** cmdlet. For example, `Import-Csv C:\MyFile.csv | ForEach-Object {Set-Mailbox $_.Identity -Name $_.Name}` is the same as `Import-Csv C:\MyFile.csv | % {Set-Mailbox $_.Identity -Name $_.Name}`. + - `?`: The question mark is shorthand for the **Where-Object** cmdlet. For example, `Get-Alias | Where-Object {$_.Definition -eq "Clear-Host"}` is the same as `Get-Alias | ? {$_.Definition -eq "Clear-Host"}`.| diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 399ea39cf3..0f362ffe35 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -3,7 +3,7 @@ title: About the Exchange Online PowerShell V3 module ms.author: chrisda author: chrisda manager: deniseb -ms.date: 10/28/2024 +ms.date: 07/31/2025 ms.audience: Admin audience: Admin ms.topic: article @@ -15,45 +15,42 @@ ms.custom: ms.assetid: search.appverid: MET150 keywords: Exchange Online PowerShell V2 module, Exchange Online PowerShell V3 module, EXO V2 module, EXO V3 module -description: "Admins can learn about the installation, maintenance, and design of the Exchange Online PowerShell V3 module that they use to connect to all Exchange-related PowerShell environments in Microsoft 365." +description: "Admins can learn about the installation, maintenance, and design of the Exchange Online PowerShell V3 module that they use to connect to all Exchange cloud-related PowerShell environments." --- # About the Exchange Online PowerShell module -The Exchange Online PowerShell module uses modern authentication and works with or without multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. +The Exchange Online PowerShell module (also known as the Exchange Online PowerShell V3 module or EXO V3 module since 2022) uses modern authentication and works with or without multifactor authentication (MFA) for connecting to all Exchange cloud-related PowerShell environments: Exchange Online PowerShell, Security & Compliance PowerShell, and Exchange Online Protection PowerShell for cloud protection of on-premises email environments. For connection instructions using the module, see the following articles: - [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) + + > [!TIP] + > Exchange Online Protection PowerShell for cloud protection of on-premises email environments uses the same connection instructions as Exchange Online PowerShell. + - [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md) -- [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md) - [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md) - [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md) - [Use C# to connect to Exchange Online PowerShell](connect-to-exo-powershell-c-sharp.md) The rest of this article explains how the module works, how to install and maintain the module, and the optimized Exchange Online cmdlets that are available in the module. -> [!TIP] -> Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). - ## REST API connections in the EXO V3 module -Exchange Online PowerShell and Security & Compliance PowerShell now use REST API connections for all cmdlets: - -- **Exchange Online PowerShell**: EXO V3 module v3.0.0 or later. -- **Security & Compliance PowerShell**: EXO V3 module v3.2.0 or later. +Exchange Online PowerShell and Security & Compliance PowerShell use REST API connections for all cmdlets since 2023. -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 connections require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](#powershellget-required-in-windows). Cmdlets in REST API connections have the following advantages over their historical counterparts: -- **More secure**: Built-in support for modern authentication and no dependence on the remote PowerShell session. PowerShell on your client computer doesn't need [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm). +- **More 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](#basic-authentication-in-winrm). - **More reliable**: Transient failures use built-in retries, so failures or delays are minimized. For example: - Failures due to network delays. - Delays due to large queries that take a long time to complete. - **Better performance**: REST API connections avoid setting up a PowerShell runspace. -The benefits of cmdlets in REST API connections are described in the following table: +The following table compares the benefits of REST API cmdlets to unavailable remote PowerShell cmdlets and the [exclusive Get-EXO\* cmdlets in the EXO V3 module](#cmdlets-in-the-exchange-online-powershell-module) | |Remote PowerShell cmdlets|Get-EXO\* cmdlets|REST API cmdlets| |---|---|---|---| @@ -62,21 +59,19 @@ The benefits of cmdlets in REST API connections are described in the following t |**Reliability**|Least reliable|Highly reliable|Highly reliable| |**Functionality**|All parameters and output properties available|Limited parameters and output properties available|All parameters and output properties available| -REST API cmdlets have the same cmdlet names and work just like their remote PowerShell equivalents, so you don't need to update cmdlet names or parameters in older scripts. +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 scripts. > [!TIP] > The [Invoke-Command](/powershell/module/microsoft.powershell.core/invoke-command) cmdlet doesn't work in REST API connections. For alternatives, see [Workarounds for Invoke-Command scenarios in REST API connections](invoke-command-workarounds-rest-api.md). -Basic authentication (remote PowerShell) connections are deprecated in Exchange Online PowerShell and Security & Compliance PowerShell. For more information, see [here](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692) and [here](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). - -A few cmdlets in Exchange Online PowerShell have been updated with the experimental _UseCustomRouting_ switch in REST API connections. This switch routes the command directly to the required Mailbox server, and might improve overall performance. Use the _UseCustomRouting_ switch experimentally. +A few cmdlets in Exchange Online PowerShell are updated with the experimental _UseCustomRouting_ switch. 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: +- The _UseCustomRouting_ switch is available only on the following Exchange Online PowerShell cmdlets: - **Get-Clutter** - **Get-FocusedInbox** - **Get-InboxRule** @@ -96,14 +91,14 @@ A few cmdlets in Exchange Online PowerShell have been updated with the experimen - **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. +- Use the [Get-ConnectionInformation](/powershell/module/exchangepowershell/get-connectioninformation) cmdlet to get information about connections to Exchange Online PowerShell and Security & Compliance PowerShell. This cmdlet is required because the [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession) cmdlet in Windows PowerShell doesn't return information for REST API connections. Scenarios where you can use **Get-ConnectionInformation** are described in the following table: |Scenario|Expected output| |---|---| - |Run after **Connect-ExchangeOnline** or **Connect-IPPSSession** commands for REST API connections.|Returns one connection information object.| - |Run after multiple **Connect-ExchangeOnline** or **Connect-IPPSSession** commands for REST API connections.|Returns a collection of connection information objects.| + |Run after **Connect-ExchangeOnline** or **Connect-IPPSSession** commands.|Returns one connection information object.| + |Run after multiple **Connect-ExchangeOnline** or **Connect-IPPSSession** commands.|Returns a collection of connection information objects.| - Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet to avoid loading format data and to run **Connect-ExchangeOnline** commands faster. @@ -134,9 +129,9 @@ For more information about what's new in the EXO V3 module, see the [Release not ## Report bugs and issues for Preview versions of the Exchange Online PowerShell module > [!TIP] -> For General Availability (GA) versions of the module, don't use the following email address to report issues. Messages about GA versions of the module won't be answered. Instead, open a support ticket. +> For General Availability (GA) versions of the module, don't use the following email address to report issues. Messages about GA versions of the module aren't answered. Instead, open a support ticket. -For **Preview versions of the module**, use `exocmdletpreview[at]service[dot]microsoft[dot]com` to report any issues that you might encounter. Be sure to include the log files in your email message. To generate the log files, replace \ with an output folder, and then run the following command: +For **Preview versions of the module only**, 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 @@ -148,15 +143,15 @@ The EXO module contains nine exclusive **Get-EXO\*** cmdlets that are optimized |EXO module cmdlet|Older related cmdlet| |---|---| -|[Get-EXOMailbox](/powershell/module/exchange/get-exomailbox)|[Get-Mailbox](/powershell/module/exchange/get-mailbox)| -|[Get-EXORecipient](/powershell/module/exchange/get-exorecipient)|[Get-Recipient](/powershell/module/exchange/get-recipient)| -|[Get-EXOCasMailbox](/powershell/module/exchange/get-exocasmailbox)|[Get-CASMailbox](/powershell/module/exchange/get-casmailbox)| -|[Get-EXOMailboxPermission](/powershell/module/exchange/get-exomailboxPermission)|[Get-MailboxPermission](/powershell/module/exchange/get-mailboxpermission)| -|[Get-EXORecipientPermission](/powershell/module/exchange/get-exorecipientpermission)|[Get-RecipientPermission](/powershell/module/exchange/get-recipientpermission)| -|[Get-EXOMailboxStatistics](/powershell/module/exchange/get-exomailboxstatistics)|[Get-MailboxStatistics](/powershell/module/exchange/get-mailboxstatistics)| -|[Get-EXOMailboxFolderStatistics](/powershell/module/exchange/get-exomailboxfolderstatistics)|[Get-MailboxFolderStatistics](/powershell/module/exchange/get-mailboxfolderstatistics)| -|[Get-EXOMailboxFolderPermission](/powershell/module/exchange/get-exomailboxfolderpermission)|[Get-MailboxFolderPermission](/powershell/module/exchange/get-mailboxfolderpermission)| -|[Get-EXOMobileDeviceStatistics](/powershell/module/exchange/get-exomobiledevicestatistics)|[Get-MobileDeviceStatistics](/powershell/module/exchange/get-mobiledevicestatistics)| +|[Get-EXOMailbox](/powershell/module/exchangepowershell/get-exomailbox)|[Get-Mailbox](/powershell/module/exchangepowershell/get-mailbox)| +|[Get-EXORecipient](/powershell/module/exchangepowershell/get-exorecipient)|[Get-Recipient](/powershell/module/exchangepowershell/get-recipient)| +|[Get-EXOCasMailbox](/powershell/module/exchangepowershell/get-exocasmailbox)|[Get-CASMailbox](/powershell/module/exchangepowershell/get-casmailbox)| +|[Get-EXOMailboxPermission](/powershell/module/exchangepowershell/get-exomailboxPermission)|[Get-MailboxPermission](/powershell/module/exchangepowershell/get-mailboxpermission)| +|[Get-EXORecipientPermission](/powershell/module/exchangepowershell/get-exorecipientpermission)|[Get-RecipientPermission](/powershell/module/exchangepowershell/get-recipientpermission)| +|[Get-EXOMailboxStatistics](/powershell/module/exchangepowershell/get-exomailboxstatistics)|[Get-MailboxStatistics](/powershell/module/exchangepowershell/get-mailboxstatistics)| +|[Get-EXOMailboxFolderStatistics](/powershell/module/exchangepowershell/get-exomailboxfolderstatistics)|[Get-MailboxFolderStatistics](/powershell/module/exchangepowershell/get-mailboxfolderstatistics)| +|[Get-EXOMailboxFolderPermission](/powershell/module/exchangepowershell/get-exomailboxfolderpermission)|[Get-MailboxFolderPermission](/powershell/module/exchangepowershell/get-mailboxfolderpermission)| +|[Get-EXOMobileDeviceStatistics](/powershell/module/exchangepowershell/get-exomobiledevicestatistics)|[Get-MobileDeviceStatistics](/powershell/module/exchangepowershell/get-mobiledevicestatistics)| > [!TIP] > If you open multiple connections to Exchange Online PowerShell in the same window, the **Get-EXO\*** cmdlets are always associated with the last (most recent) Exchange Online PowerShell connection. Run the following command to find the REST API session where the **Get-EXO\*** cmdlets are run: `Get-ConnectionInformation | Where-Object {$_.ConnectionUsedForInbuiltCmdlets -eq $true}`. @@ -165,37 +160,37 @@ The connection-related cmdlets in the module are listed in the following table: |EXO module cmdlet|Older related cmdlet|Comments| |---|---|---| -|[Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline)|**Connect-EXOPSSession** in V1 of the module
or
[New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession)|| -|[Connect-IPPSSession](/powershell/module/exchange/connect-ippssession)|**Connect-IPPSSession** in V1 of the module|| -|[Disconnect-ExchangeOnline](/powershell/module/exchange/disconnect-exchangeonline)|[Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession)|| -|[Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation)|[Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)|Available in v3.0.0 or later.| +|[Connect-ExchangeOnline](/powershell/module/exchangepowershell/connect-exchangeonline)|**Connect-EXOPSSession** in V1 of the module
or
[New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession)|| +|[Connect-IPPSSession](/powershell/module/exchangepowershell/connect-ippssession)|**Connect-IPPSSession** in V1 of the module|| +|[Disconnect-ExchangeOnline](/powershell/module/exchangepowershell/disconnect-exchangeonline)|[Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession)|| +|[Get-ConnectionInformation](/powershell/module/exchangepowershell/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: +Miscellaneous Exchange Online feature cmdlets that happen to be in the module are listed in the following table: |Cmdlet|Comments| |---|---| -|[Get-DefaultTenantBriefingConfig](/powershell/module/exchange/get-defaulttenantbriefingconfig)|Available in v3.2.0 or later.| -|[Set-DefaultTenantBriefingConfig](/powershell/module/exchange/set-defaulttenantbriefingconfig)|Available in v3.2.0 or later.| -|[Get-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0 or later.| -|[Set-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0 or later.| -|[Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| -|[Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| -|[Get-UserBriefingConfig](/powershell/module/exchange/get-userbriefingconfig)|Replaced by [Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig).| -|[Set-UserBriefingConfig](/powershell/module/exchange/set-userbriefingconfig)|Replaced by [Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig).| -|[Get-VivaInsightsSettings](/powershell/module/exchange/get-vivainsightssettings)|Available in v2.0.5 or later.| -|[Set-VivaInsightsSettings](/powershell/module/exchange/set-vivainsightssettings)|Available in v2.0.5 or later.| -|[Get-VivaModuleFeature](/powershell/module/exchange/get-vivamodulefeature)|Available in v3.2.0 or later.| -|[Get-VivaModuleFeatureEnablement](/powershell/module/exchange/get-vivamodulefeatureenablement)|Available in v3.2.0 or later.| -|[Add-VivaModuleFeaturePolicy](/powershell/module/exchange/add-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| -|[Get-VivaModuleFeaturePolicy](/powershell/module/exchange/get-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| -|[Remove-VivaModuleFeaturePolicy](/powershell/module/exchange/remove-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| -|[Update-VivaModuleFeaturePolicy](/powershell/module/exchange/update-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| -|[Add-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/add-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| -|[Get-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/get-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| -|[Remove-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/remove-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Get-DefaultTenantBriefingConfig](/powershell/module/exchangepowershell/get-defaulttenantbriefingconfig)|Available in v3.2.0 or later.| +|[Set-DefaultTenantBriefingConfig](/powershell/module/exchangepowershell/set-defaulttenantbriefingconfig)|Available in v3.2.0 or later.| +|[Get-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchangepowershell/get-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0 or later.| +|[Set-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchangepowershell/set-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0 or later.| +|[Get-MyAnalyticsFeatureConfig](/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| +|[Set-MyAnalyticsFeatureConfig](/powershell/module/exchangepowershell/set-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| +|[Get-UserBriefingConfig](/powershell/module/exchangepowershell/get-userbriefingconfig)|Replaced by [Get-MyAnalyticsFeatureConfig](/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig).| +|[Set-UserBriefingConfig](/powershell/module/exchangepowershell/set-userbriefingconfig)|Replaced by [Set-MyAnalyticsFeatureConfig](/powershell/module/exchangepowershell/set-myanalyticsfeatureconfig).| +|[Get-VivaInsightsSettings](/powershell/module/exchangepowershell/get-vivainsightssettings)|Available in v2.0.5 or later.| +|[Set-VivaInsightsSettings](/powershell/module/exchangepowershell/set-vivainsightssettings)|Available in v2.0.5 or later.| +|[Get-VivaModuleFeature](/powershell/module/exchangepowershell/get-vivamodulefeature)|Available in v3.2.0 or later.| +|[Get-VivaModuleFeatureEnablement](/powershell/module/exchangepowershell/get-vivamodulefeatureenablement)|Available in v3.2.0 or later.| +|[Add-VivaModuleFeaturePolicy](/powershell/module/exchangepowershell/add-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Get-VivaModuleFeaturePolicy](/powershell/module/exchangepowershell/get-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Remove-VivaModuleFeaturePolicy](/powershell/module/exchangepowershell/remove-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Update-VivaModuleFeaturePolicy](/powershell/module/exchangepowershell/update-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Add-VivaOrgInsightsDelegatedRole](/powershell/module/exchangepowershell/add-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Get-VivaOrgInsightsDelegatedRole](/powershell/module/exchangepowershell/get-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Remove-VivaOrgInsightsDelegatedRole](/powershell/module/exchangepowershell/remove-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| ## Install and maintain the Exchange Online PowerShell module @@ -205,11 +200,15 @@ The procedures in this section explain how to install, update, and uninstall the ### Supported operating systems for the Exchange Online PowerShell module -The latest versions of the module are officially supported in PowerShell 7 on Windows, Linux, and Apple macOS. +The module is officially supported in PowerShell 7 on Windows, Linux, and Apple macOS: + +- Module versions 3.5.1 (July 2024) or later require PowerShell 7 version 7.4.0 (November 2023) or later. Earlier versions of PowerShell 7 might encounter compatibility issues due to missing .NET 8.0 assemblies (v3.5.1 is built on .NET 8.0). +- Module versions 2.0.4 (February 2021) to 3.5.0 (May 2024) are supported in PowerShell 7 version 7.0.3 (July 2020) or later. -Specifically, version **2.0.4 or later** is supported in **PowerShell 7.0.3 or later**. +For more information about PowerShell 7, see [What is PowerShell?](/powershell/scripting/overview). -For more information about PowerShell 7, see [Announcing PowerShell 7.0](https://devblogs.microsoft.com/powershell/announcing-PowerShell-7-0/). +> [!TIP] +> All versions of the module are supported and compatible in Windows PowerShell 5.1. #### Apple macOS @@ -264,27 +263,34 @@ After you install PowerShell 7, do the following steps: Now you can do the [regular PowerShell prerequisites](#prerequisites-for-the-exchange-online-powershell-module) and [install the Exchange Online PowerShell module](#install-the-exchange-online-powershell-module). > [!NOTE] -> If you connect to Exchange Online PowerShell from a network that's behind a proxy server, the EXO V2 module (version v2.0.5 or earlier) doesn't work in Linux. You need to use the EXO V3 module (v3.0.0 or later) in Linux to connect from a network that's behind a proxy server. +> If you connect to Exchange Online PowerShell on Linux from a network behind a proxy server, you need to use the EXO V3 module (v3.0.0 or later). #### Windows -All versions of the module are supported in Windows PowerShell 5.1. +- **Windows PowerShell 5.1**: + - All versions of the module are supported. + - Version 2.0.5 (May 2021) or later versions of the module require the Microsoft .NET Framework 4.7.2 or later to connect. Otherwise, you get a `System.Runtime.InteropServices.OSPlatform` error. 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). -PowerShell 7 on Windows requires version 2.0.4 or later. + > [!TIP] + > Current versions of Windows include the required versions of .NET and/or the .NET Framework, so you don't need to install .NET or the .NET Framework to use the module in Windows PowerShell 5.1. -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). +- **PowerShell 7**: + - Module versions 3.5.1 (July 2024) or later require PowerShell 7 version 7.4.0 (November 2023) or later. Earlier versions of PowerShell 7 might encounter compatibility issues due to missing .NET 8.0 assemblies (v3.5.1 is built on .NET 8.0). + - Module versions 2.0.4 (February 2021) to 3.5.0 (May 2024) are supported in PowerShell 7 version 7.0.3 (July 2020) or later. Windows PowerShell requirements and module support **in older versions of Windows** are described in the following list: -- Windows 8.1¹ -- Windows Server 2012 or Windows Server 2012 R2¹ -- Windows 7 Service Pack 1 (SP1)² ³ ⁴ -- Windows Server 2008 R2 SP1² ³ ⁴ +- Windows 10¹ +- Windows 8.1² ³ +- Windows Server 2012 or Windows Server 2012 R2² ³ +- Windows 7 Service Pack 1 (SP1)² ⁴ ⁵ +- 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). -- ² 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). +¹ Windows 10 Anniversary Update (version 1607 from August 2016) is the earliest version of Windows 10 that's reliably compatible with the .NET Framework 4.7.2 (v2.0.5 or later versions of the module in Windows PowerShell 5.1).
+² Support for this version of Windows is over. This version of Windows is supported only in Azure virtual machines.
+³ PowerShell 7 on this version of Windows requires a compatible version of .NET Core or .NET runtime and the [Windows 10 Universal C Runtime (CRT)](https://support.microsoft.com/topic/c0514201-7fe6-95a3-b0a5-287930f3560c). The last officially supported version of PowerShell 7 on this version of Windows is 7.2 (7.2.19 from August 2024), which means the last supported version of the module in PowerShell 7 is v3.5.0 (May 2024).
+⁴ The latest version of the module supported on this version of Windows is v2.0.3 (September 2020).
+⁵ Windows PowerShell 5.1 on this version of Windows requires the .NET Framework 4.5 or later and the Windows Management Framework 5.1. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). ### Prerequisites for the Exchange Online PowerShell module @@ -297,7 +303,7 @@ PowerShell needs to be configured to run scripts, and by default, it isn't. You > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. -To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated PowerShell window (a PowerShell window you open by selecting **Run as administrator**): +To require trusted publisher signing for all PowerShell scripts downloaded from the internet, run the following command in an elevated PowerShell window (a PowerShell window you open by selecting **Run as administrator**): ```powershell Set-ExecutionPolicy RemoteSigned @@ -305,56 +311,22 @@ Set-ExecutionPolicy RemoteSigned For more information about execution policies, see [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). -#### Turn on Basic authentication in WinRM - -> [!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 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**: +#### Basic authentication in WinRM -> [!NOTE] -> The following commands require that WinRM is enabled. To enable WinRM, run the following command: `winrm quickconfig`. - -```DOS -winrm get winrm/config/client/auth -``` - -If you don't see the value `Basic = true`, you need to run **one** of the following commands to enable Basic authentication for WinRM: - -- **In a Command Prompt**: +As of October 2023, REST API connections replaced basic authentication (remote PowerShell) connections in [Exchange Online PowerShell](https://techcommunity.microsoft.com/blog/exchange/deprecation-of-remote-powershell-in-exchange-online-%e2%80%93-re-enabling-or-extending-r/3779692) and [Security & Compliance PowerShell](https://techcommunity.microsoft.com/blog/exchange/deprecation-of-remote-powershell-rps-protocol-in-security-and-compliance-powersh/3815432). REST API connections don't require Basic authentication in WinRM. - ```DOS - winrm set winrm/config/client/auth @{Basic="true"} - ``` + -- **In Windows PowerShell**: +### PowerShellGet required in Windows - ```powershell - winrm set winrm/config/client/auth '@{Basic="true"}' - ``` - -- **In Windows PowerShell to modify the registry**: - - ```PowerShell - Set-ItemProperty -Path 'HKLM:\SOFTWARE\Policies\Microsoft\Windows\WinRM\Client' -Name 'AllowBasic' -Type DWord -Value '1' - ``` - -If Basic authentication for WinRM is disabled, you get one of the following errors when you try to connect using a Basic authentication (remote PowerShell) connection: - -> The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. -> -> Create Powershell Session is failed using OAuth. - -### PowerShellGet for REST API connections in Windows - -[REST API connections](#rest-api-connections-in-the-exo-v3-module) in Windows require the PowerShellGet module, and by dependency, the PackageManagement module. Consideration for these modules is more for PowerShell 5.1 than PowerShell 7, but all versions of PowerShell benefit from having the latest versions of the modules installed. For installation and update instructions, see [Installing PowerShellGet on Windows](/powershell/scripting/gallery/installing-psget). +REST API connections in Windows require the PowerShellGet module. By dependency, the PowerShellGet module requires the PackageManagement module. Consideration for these modules is more for PowerShell 5.1 than PowerShell 7, but all versions of PowerShell benefit from having the latest versions of the modules installed. For installation and update instructions, see [Installing PowerShellGet on Windows](/powershell/scripting/gallery/installing-psget). > [!TIP] -> 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`. +> Preview versions of the PackageManagement or PowerShellGet modules might cause connection issues. If you have connection issues, verify that you don't have preview versions of the modules installed by running the following command: `Get-InstalledModule PackageManagement -AllVersions; Get-InstalledModule PowerShellGet -AllVersions`. -If you don't have PowerShellGet installed when you try to create a REST API connection, you get the following error when you try to connect: +If you don't have PowerShellGet installed when you try to connect, you get the following error: > Cannot find a cmdlet Update-Manifest @@ -364,9 +336,9 @@ To install the module for the first time, complete the following steps: 1. Install or update the PowerShellGet module as described in [Installing PowerShellGet](/powershell/scripting/gallery/installing-psget). -2. Close and re-open the Windows PowerShell window. +2. Close and reopen the Windows PowerShell window. -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. +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 that's newer than the current version. - To install **the latest public version** of the module, run **one** of the following commands: @@ -486,7 +458,7 @@ If the module is already installed on your computer, you can use the procedures When you're finished, enter **Y** to accept the license agreement. -3. To confirm that the update was successful, run the following commands to check the version information of the module that's installed: +3. To confirm that the update was successful, run the following commands to check the version information of the installed module: ```powershell Import-Module ExchangeOnlineManagement; Get-Module ExchangeOnlineManagement @@ -504,7 +476,7 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m > WARNING: Unable to download the list of available providers. Check your internet connection. - Update your installation of the PowerShellGet module to the latest version as described in [Installing PowerShellGet](/powershell/scripting/gallery/installing-psget). Be sure to close and re-open the PowerShell window before you attempt to update the ExchangeOnlineManagement module again. + 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 reopen the PowerShell window before you attempt to update the ExchangeOnlineManagement module again. - You receive the following error: @@ -571,16 +543,16 @@ For detailed syntax and parameter information, see [Uninstall-Module](/powershel 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 categorized specific related properties into _property sets_. These property sets are buckets of two or more related properties on the cmdlet. +The **Get-EXO\*** cmdlets in the module contain 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: -- [Get-EXOCasMailbox](/powershell/module/exchange/get-exocasmailbox) -- [Get-EXOMailbox](/powershell/module/exchange/get-exomailbox) -- [Get-EXOMailboxStatistics](/powershell/module/exchange/get-exomailboxstatistics) -- [Get-EXORecipient](/powershell/module/exchange/get-exorecipient) +- [Get-EXOCasMailbox](/powershell/module/exchangepowershell/get-exocasmailbox) +- [Get-EXOMailbox](/powershell/module/exchangepowershell/get-exomailbox) +- [Get-EXOMailboxStatistics](/powershell/module/exchangepowershell/get-exomailboxstatistics) +- [Get-EXORecipient](/powershell/module/exchangepowershell/get-exorecipient) -In those cmdlets, property sets are controlled by the following parameters: +In those cmdlets, the following parameters control property sets: - _PropertySets_: This parameter accepts one or more available property set names separated by commas. The available property sets are described in [Property sets in Exchange Online PowerShell module cmdlets](cmdlet-property-sets.md). - _Properties_: This parameter accepts one or more property names separated by commas. @@ -613,25 +585,53 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo ### Current release +#### Version 3.8.0 + +- Support for providing an access token with **Connect-IPPSSession**. +- **Get-VivaModuleFeature** now returns information about ParentFeature, ChildFeature, and PolicyModes. These values represent parent and child features of a Viva app feature along with available enablement modes for future policies. +- New parameters _IsUserOptedInByDefault_ on the **Add-VivaModuleFeaturePolicy** and **Update-VivaModuleFeaturePolicy** cmdlets and the corresponding property value in all **\*-VivaModuleFeaturePolicy** cmdlets. The value indicates if users are opted in or out by the policy, as long as the user doesn't set a preference. + + You can use this parameter to keep the feature enabled in your organization while opting out the affected users by default, effectively soft disabling the feature for those users. + +- Deprecated the **Get-VivaFeatureCategory** cmdlet, all category-related parameters, and return values (_CategoryId_, _IsCategoryEnabled_). + +### Previous releases + +#### Version 3.7.2 + +- The _DisableWAM_ switch is available on the **Connect-ExchangeOnline** cmdlet to disable Web Account Manager (WAM) if you get WAM-related connection errors. + +#### 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). +- **Get-VivaModuleFeature** now returns information about the kinds of identities that the feature supports creating policies for (for example, users, groups, or the entire organization). - Cmdlets for Viva feature access management now handle continuous access evaluation (CAE) claim challenges. - Added fix for compatibility issue with the Microsoft.Graph module. -### Previous releases - #### 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. +- The module is 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. +- New IsFeatureEnabledByDefault property in the output of **Get-VivaModuleFeaturePolicy**. The value of this property shows the default enablement state for users when no organization or user/group policies were created. #### Version 3.4.0 @@ -668,15 +668,15 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo - Features already described in the [REST API connections in the EXO V3 module](#rest-api-connections-in-the-exo-v3-module) section: - [Certificate based authentication](app-only-auth-powershell-v2.md) for Security & Compliance PowerShell (version 2.0.6-Preview5 or later). - - The [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet for REST-based connections (version 2.0.6-Preview7 or later). + - The [Get-ConnectionInformation](/powershell/module/exchangepowershell/get-connectioninformation) cmdlet for REST-based connections (version 2.0.6-Preview7 or later). - The _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet for REST-based connections (version 2.0.6-Preview8 or later). - The _DelegatedOrganization_ parameter works in the **Connect-IPPSSession** cmdlet as long as you also use the _AzureADAuthorizationEndpointUri_ parameter in the command. -- Certain cmdlets that used to prompt for confirmation in specific scenarios no longer do so. By default, the cmdlet runs to completion. +- Certain cmdlets that prompted for confirmation in specific scenarios no longer do so. By default, the cmdlet runs to completion. - The format of the error returned from failed cmdlet execution is slightly modified. The exception now contains more data (for example, the exception type), and the `FullyQualifiedErrorId` doesn't contain the `FailureCategory`. The format of the error is subject to further modification. #### Version 2.0.5 -- New **Get-OwnerlessGroupPolicy** and **Set-OwnerlessGroupPolicy** cmdlets to manage ownerless Microsoft 365 groups. +- New **Get-OwnerlessGroupPolicy** and **Set-OwnerlessGroupPolicy** cmdlets to manage ownerless Microsoft 365 Groups. > [!NOTE] > Although the _cmdlets_ are available in the module, the _feature_ is only available to members of a Private Preview. @@ -703,17 +703,17 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo - Remote in the Azure Key Value (the _Certificate_) parameter. This option enhances security by fetching the certificate only at runtime. - Local in the CurrentUser or LocalMachine certificate store (the _CertificateThumbprint_ parameter). - Local in an exported certificate file (the _CertificateFilePath_ and _CertificatePassword_ parameters). - For more information, see the parameter descriptions in [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline) and [App-only authentication for unattended scripts in the Exchange Online PowerShell module](app-only-auth-powershell-v2.md). + For more information, see the parameter descriptions in [Connect-ExchangeOnline](/powershell/module/exchangepowershell/connect-exchangeonline) and [App-only authentication for unattended scripts in the Exchange Online PowerShell module](app-only-auth-powershell-v2.md). - Connect to Exchange Online PowerShell and Security & Compliance PowerShell simultaneously in a single PowerShell window. - The new _CommandName_ parameter allows you to specify and restrict the Exchange Online PowerShell cmdlets that are imported in a session. This option reduces the memory footprint for high usage PowerShell applications. - **Get-EXOMailboxFolderPermission** now supports ExternalDirectoryObjectID in the _Identity_ parameter. -- Optimized latency of the first V2 cmdlet call. Lab results show the first call latency has been reduced from 8 seconds to approximately 1 second. Actual results depend on the cmdlet result size and the tenant environment. +- Optimized latency of the first V2 cmdlet call. Lab results show the first call latency decreased from 8 seconds to approximately 1 second. Actual results depend on the cmdlet result size and the organization environment. #### Version 1.0.1 - 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. +- Improved reliability for auto reconnect of sessions in certain scenarios where a script was running for ~50 minutes and threw a "Cmdlet not found" error due to a bug in auto reconnect logic. - Fixed data-type issues of two commonly used "User" and "MailboxFolderUser" attributes for easy migration of scripts. - Enhanced support for filters as it now supports four more operators: EndsWith, Contains, Not and NotLike support. Check [Filters in the Exchange Online PowerShell module](filters-v2.md) for attributes that aren't supported in filters. @@ -724,15 +724,15 @@ 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 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. +- Improved reliability of **Get-EXOMailboxStatistics** as certain request routing errors that led to failures are resolved. +- Optimized memory usage for new sessions created from reusing existing modules instead of creating a new session 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 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. +- Remote PowerShell contained various complex data types that were intentionally not supported in EXO cmdlets to improve performance. Differences in noncomplex data types between remote PowerShell cmdlets and V2 cmdlets are resolved to allow seamless migration of management scripts. #### Version 0.3582.0 @@ -756,7 +756,7 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo #### Version 0.3527.3 -- Added support for managing Exchange for a different tenant using delegation flow. +- Added support for managing Exchange for a different organization using delegation flow. - Works in tandem with other PowerShell modules in a single PowerShell window. - Added support for positional parameters. - Date Time field now supports client locale. diff --git a/exchange/docs-conceptual/exchange-online-powershell.md b/exchange/docs-conceptual/exchange-online-powershell.md index 026e69d6a7..0f485e3fbc 100644 --- a/exchange/docs-conceptual/exchange-online-powershell.md +++ b/exchange/docs-conceptual/exchange-online-powershell.md @@ -3,7 +3,7 @@ title: "Exchange Online PowerShell" ms.author: chrisda author: chrisda manager: deniseb -ms.date: 9/1/2023 +ms.date: 05/07/2025 ms.audience: Admin audience: Admin ms.topic: article @@ -16,13 +16,10 @@ description: "Learn about articles that are available for using PowerShell in Ex # Exchange Online PowerShell -Exchange Online PowerShell is the administrative interface that enables you to manage the Exchange Online part of your Microsoft 365 organization from the command line (including many security features in Exchange Online Protection and Microsoft Defender for Office 365). For example, you can use Exchange Online PowerShell to configure mail flow rules (also known as transport rules) and connectors. The following articles provide information about using Exchange Online PowerShell: +Exchange Online PowerShell is the administrative interface that enables you to manage the Exchange Online part of your Microsoft 365 organization from the command line (including many default email protections for all cloud mailboxes and protections in Microsoft Defender for Office 365). For example, you can use Exchange Online PowerShell to configure mail flow rules (also known as transport rules) and connectors. The following articles provide information about using Exchange Online PowerShell: - To learn about the ExchangeOnlineManagement module that's required to connect to Exchange Online PowerShell, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). - > [!TIP] - > Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). - To learn about what's new in the Exchange Online PowerShell module, see [What's new in the Exchange Online PowerShell module](whats-new-in-the-exo-module.md). - To connect to Exchange Online PowerShell, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). @@ -41,6 +38,6 @@ Exchange Online PowerShell is the administrative interface that enables you to m - To learn about recipient filters in Exchange Online PowerShell, see [Recipient filters in Exchange Management Shell and Exchange Online PowerShell commands](recipient-filters.md). -- To learn about recipient filters for the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell, see [Filters in the Exchange Online PowerShell module](filters-v2.md). +- To learn about recipient filters for the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell module, see [Filters in the Exchange Online PowerShell module](filters-v2.md). - To learn about property sets in the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell module, see [Property sets in Exchange Online PowerShell module cmdlets](cmdlet-property-sets.md). diff --git a/exchange/docs-conceptual/exchange-online-protection-powershell.md b/exchange/docs-conceptual/exchange-online-protection-powershell.md index 93e9dd4bf7..cb28f5339f 100644 --- a/exchange/docs-conceptual/exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/exchange-online-protection-powershell.md @@ -1,39 +1,36 @@ --- -title: "Exchange Online Protection PowerShell" +title: "Exchange Online Protection PowerShell for cloud protection of on-premises email environments" ms.author: chrisda author: chrisda manager: deniseb -ms.date: 9/1/2023 +ms.date: 07/11/2025 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell ms.localizationpriority: medium ms.assetid: f7918a88-774a-405e-945b-bc2f5ee9f748 -description: "Learn about the articles that are available for using PowerShell in Exchange Online Protection (EOP) only organizations without cloud mailboxes." +description: "Learn about the articles available for using Exchange Online Protection PowerShell to manage cloud protection features for on-premises email environments." --- -# Exchange Online Protection PowerShell +# Exchange Online Protection PowerShell for cloud protection of on-premises email environments -Exchange Online Protection PowerShell is the administrative interface that enables you to manage security features in Exchange Online Protection (EOP) organizations from the command line. For example, you can use Exchange Online Protection PowerShell to configure anti-spam policies, mail flow rules (also known as transport rules) and connectors. +Exchange Online Protection PowerShell is the administrative interface that enables you to manage cloud protection features for on-premises email environments from the command line. For example, you can use Exchange Online Protection PowerShell to configure anti-spam policies, mail flow rules (also known as transport rules) and connectors to support on-premises email protection. > [!TIP] -> Microsoft 365 organizations with cloud mailboxes (Microsoft 365 A3/E3/G3, A5/E5/G5, Microsoft 365 Business Premium, etc.) use [Exchange Online PowerShell](exchange-online-powershell.md) to manage these same features. +> All organizations with cloud mailboxes (Microsoft 365 A3/E3/G3, A5/E5/G5, Microsoft 365 Business Premium, etc.) use [Exchange Online PowerShell](exchange-online-powershell.md) to manage these same features for cloud email protection. -Exchange Online Protection PowerShell includes the following environments: +Exchange Online Protection PowerShell for cloud protection of on-premises email environments is available in the following scenarios: -- **Standalone EOP organizations**: Your Microsoft 365 subscription includes no Exchange Online mailboxes, because you use EOP to protect your on-premises email environment. -- **Exchange Enterprise CAL with Services**: The licenses for your on-premises Exchange organization include Exchange Enterprise CAL with Services (EOP is one of the services). +- **On-premises email environments (not just Microsoft Exchange)**: Mail from the internet passes through cloud protection and filtering before delivery to on-premises recipients. The cloud environment contains no mailboxes. +- **Exchange Enterprise CAL with Services**: The licenses for your on-premises Exchange organization include Exchange Enterprise CAL with Services (cloud protection of on-premises mailboxes is one of the services). -The following articles provide information about using Exchange Online Protection PowerShell: +The following articles provide information about using Exchange Online Protection PowerShell for cloud protection of on-premises email environments: -- To learn about the ExchangeOnlineManagement module that's required to connect to standalone Exchange Online Protection PowerShell, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). - - > [!TIP] - > Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). +- To learn about the ExchangeOnlineManagement module that's required to connect to Exchange Online Protection PowerShell, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). To learn about what's new in the Exchange Online PowerShell module, see [What's new in the Exchange Online PowerShell module](whats-new-in-the-exo-module.md). -- To connect to Exchange Online Protection PowerShell, see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). +- The connection instructions for Exchange Online Protection PowerShell and Exchange Online PowerShell are the same. For instructions, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). -- To learn about the structure and layout of the cmdlet reference articles in Exchange Online Protection PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). +- To learn about the structure and layout of the cmdlet reference articles, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). diff --git a/exchange/docs-conceptual/filter-properties.md b/exchange/docs-conceptual/filter-properties.md index acd6c6bdeb..12f17e81b9 100644 --- a/exchange/docs-conceptual/filter-properties.md +++ b/exchange/docs-conceptual/filter-properties.md @@ -17,22 +17,22 @@ description: "Learn about the filterable properties for the Filter parameter in You use the _Filter_ parameter to create OPATH filters based on the properties of user and group objects in the Exchange Management Shell (Exchange Server PowerShell) and in Exchange Online PowerShell. The _Filter_ parameter is available on these recipient cmdlets: -- [Get-CASMailbox](/powershell/module/exchange/get-casmailbox) -- [Get-Contact](/powershell/module/exchange/get-contact) -- [Get-DistributionGroup](/powershell/module/exchange/get-distributiongroup) -- [Get-DynamicDistributionGroup](/powershell/module/exchange/get-dynamicdistributiongroup) -- [Get-Group](/powershell/module/exchange/get-group) -- [Get-LinkedUser](/powershell/module/exchange/get-linkeduser) -- [Get-Mailbox](/powershell/module/exchange/get-mailbox) -- [Get-MailContact](/powershell/module/exchange/get-mailcontact) -- [Get-MailPublicFolder](/powershell/module/exchange/get-mailpublicfolder) -- [Get-MailUser](/powershell/module/exchange/get-mailuser) -- [Get-Recipient](/powershell/module/exchange/get-recipient) -- [Get-RemoteMailbox](/powershell/module/exchange/get-remotemailbox) -- [Get-SecurityPrincipal](/powershell/module/exchange/get-securityprincipal) -- [Get-UMMailbox](/powershell/module/exchange/get-ummailbox) -- [Get-User](/powershell/module/exchange/get-user) -- [Get-UnifiedGroup](/powershell/module/exchange/get-unifiedgroup) +- [Get-CASMailbox](/powershell/module/exchangepowershell/get-casmailbox) +- [Get-Contact](/powershell/module/exchangepowershell/get-contact) +- [Get-DistributionGroup](/powershell/module/exchangepowershell/get-distributiongroup) +- [Get-DynamicDistributionGroup](/powershell/module/exchangepowershell/get-dynamicdistributiongroup) +- [Get-Group](/powershell/module/exchangepowershell/get-group) +- [Get-LinkedUser](/powershell/module/exchangepowershell/get-linkeduser) +- [Get-Mailbox](/powershell/module/exchangepowershell/get-mailbox) +- [Get-MailContact](/powershell/module/exchangepowershell/get-mailcontact) +- [Get-MailPublicFolder](/powershell/module/exchangepowershell/get-mailpublicfolder) +- [Get-MailUser](/powershell/module/exchangepowershell/get-mailuser) +- [Get-Recipient](/powershell/module/exchangepowershell/get-recipient) +- [Get-RemoteMailbox](/powershell/module/exchangepowershell/get-remotemailbox) +- [Get-SecurityPrincipal](/powershell/module/exchangepowershell/get-securityprincipal) +- [Get-UMMailbox](/powershell/module/exchangepowershell/get-ummailbox) +- [Get-User](/powershell/module/exchangepowershell/get-user) +- [Get-UnifiedGroup](/powershell/module/exchangepowershell/get-unifiedgroup) For more information about _recipient_ filters in Exchange PowerShell, see [Recipient filters in Exchange PowerShell commands](recipient-filters.md). @@ -532,7 +532,7 @@ For example, `Get-CASMailbox -Filter 'EcpEnabled -eq $false'`. For example, `Get-Recipient -Filter "EmailAddresses -like 'marketing*'"`. -When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"EmailAddresses -eq 'lila@fabrikam.com'"` returns a match, `"EmailAddresses -like 'lila*'"` won't return a match, but or `"EmailAddresses -like 'smtp:lila*'"` will return a match. +When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"EmailAddresses -eq 'lila@fabrikam.com'"` returns a match, `"EmailAddresses -like 'lila*'"` won't return a match, but `"EmailAddresses -like 'smtp:lila*'"` returns a match. Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. @@ -640,7 +640,7 @@ For example, `Get-Recipient -Filter 'ExternalDirectoryObjectId -ne $null'`. For example, `Get-Recipient -Filter "ExternalEmailAddress -like '@fabrikam.com*'"`. -When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ExternalEmailAddress -eq 'lila@fabrikam.com'"` returns a match, `"ExternalEmailAddress -like 'lila*'"` won't return a match, but `"ExternalEmailAddress -like 'smtp:lila*'"` will return a match. +When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ExternalEmailAddress -eq 'lila@fabrikam.com'"` returns a match, `"ExternalEmailAddress -like 'lila*'"` won't return a match, but `"ExternalEmailAddress -like 'smtp:lila*'"` returns a match. ## ExternalOofOptions @@ -684,7 +684,7 @@ To find the distinguished name of a forwarding recipient, replace _\ **Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _Flags_ parameter in [Get-MoveRequest](/powershell/module/exchange/get-moverequest#-flags).| +|_msExchMailboxMoveFlags_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _Flags_ parameter in [Get-MoveRequest](/powershell/module/exchangepowershell/get-moverequest#-flags).| For example, `Get-Mailbox -Filter "MailboxMoveFlags -ne 'None'"`. You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-Recipient -Filter "MailboxMoveFlags -eq 'IntraOrg,Pull'"` returns the same results as `Get-Recipient -Filter "MailboxMoveFlags -eq 'Pull,IntraOrg'"`. -This multivalued property will only return a match if the property _equals_ the specified value. +This multivalued property returns a match only if the property _equals_ the specified value. ## MailboxMoveRemoteHostName @@ -1082,7 +1082,7 @@ You can find the distinguished names of mailbox databases by running this comman |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchMailboxMoveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _MoveStatus_ parameter in [Get-MoveRequest](/powershell/module/exchange/get-moverequest#-movestatus).| +|_msExchMailboxMoveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _MoveStatus_ parameter in [Get-MoveRequest](/powershell/module/exchangepowershell/get-moverequest#-movestatus).| For example, `Get-Mailbox -Filter "MailboxMoveStatus -eq 'Completed'"`. @@ -1504,7 +1504,7 @@ For example, `Get-User -Filter "PostOfficeBox -like '555*'"`. |---|---|---| |_msExchPreviousRecipientTypeDetails_|**Get-LinkedUser**
**Get-User**|String or `$null`| -For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient#-recipienttypedetails). +For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchangepowershell/get-recipient#-recipienttypedetails). For example, `Get-User -Filter 'PreviousRecipientTypeDetails -ne $null'`. @@ -1514,7 +1514,7 @@ For example, `Get-User -Filter 'PreviousRecipientTypeDetails -ne $null'`. |---|---|---| |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'"`. +Don't use the _PrimarySmtpAddress_ property; use the _EmailAddresses_ property instead. Any filter that uses the _PrimarySmtpAddress_ property also searchs 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 return that mailbox in the result: `"PrimarySmtpAddress -eq 'dario@contoso.com'"`, `"PrimarySmtpAddress -eq 'dario2@contoso.com'"`, or `"PrimarySmtpAddress -eq 'dario3@contoso.com'"`. ## ProhibitSendQuota @@ -1602,7 +1602,7 @@ For example, `Get-Recipient -Filter "RecipientType -eq 'MailContact'"`. |---|---|---| |n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|String| -For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient#-recipienttypedetails). +For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchangepowershell/get-recipient#-recipienttypedetails). For example, `Get-Recipient -Filter "RecipientTypeDetails -eq 'SharedMailbox'"`. @@ -2085,7 +2085,7 @@ For example, `Get-User -Filter "UserAccountControl -eq 'NormalAccount'"`. You can specify multiple values separated by commas, but the order matters. For example, `Get-User -Filter "UserAccountControl -eq 'AccountDisabled,NormalAccount'"` returns different results than `Get-User -Filter "UserAccountControl -eq 'NormalAccount,AccountDisabled'"`. -This multivalued property will only return a match if the property _equals_ the specified value. +This multivalued property returns a match only if the property _equals_ the specified value. ## UserPrincipalName diff --git a/exchange/docs-conceptual/filters-v2.md b/exchange/docs-conceptual/filters-v2.md index aae21efdc2..85f538fcdc 100644 --- a/exchange/docs-conceptual/filters-v2.md +++ b/exchange/docs-conceptual/filters-v2.md @@ -40,9 +40,9 @@ The **Get-EXO\*** cmdlets in the module support the majority of [filterable prop |Cmdlet|Unsupported filterable property|LDAP Display Name| |---|---|---| -|[Get-EXOCASMailbox](/powershell/module/exchange/get-exocasmailbox)|MemberOfGroup

ExternalDirectoryObjectId|memberOf

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

LanguagesRaw

MasterAccountSid

MemberOfGroup

RequireAllSendersAreAuthenticated

SCLDeleteThresholdInt

SCLJunkThresholdInt

SCLQuarantineThresholdInt

SCLRejectThresholdInt|deletedItemFlags

msExchUserCulture

msExchMasterAccountSid

memberOf

msExchRequireAuthToSendTo

msExchMessageHygieneSCLDeleteThreshold

msExchMessageHygieneSCLJunkThreshold

msExchMessageHygieneSCLQuarantineThreshold

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

ExternalDirectoryObjectId

MasterAccountSid

MemberOfGroup

Members|countryCode

msExchExternalDirectoryObjectId

msExchMasterAccountSid

memberOf

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

ExternalDirectoryObjectId|memberOf

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

LanguagesRaw

MasterAccountSid

MemberOfGroup

RequireAllSendersAreAuthenticated

SCLDeleteThresholdInt

SCLJunkThresholdInt

SCLQuarantineThresholdInt

SCLRejectThresholdInt|deletedItemFlags

msExchUserCulture

msExchMasterAccountSid

memberOf

msExchRequireAuthToSendTo

msExchMessageHygieneSCLDeleteThreshold

msExchMessageHygieneSCLJunkThreshold

msExchMessageHygieneSCLQuarantineThreshold

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

ExternalDirectoryObjectId

MasterAccountSid

MemberOfGroup

Members|countryCode

msExchExternalDirectoryObjectId

msExchMasterAccountSid

memberOf

member| ## Supported operators diff --git a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md index e19393384e..6b4f22af79 100644 --- a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md +++ b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md @@ -50,8 +50,7 @@ You can use PowerShell to find the permissions required to run any Exchange or E ## Use PowerShell to find the permissions required to run a cmdlet 1. If you haven't already, open the Exchange PowerShell environment that you're interested in: - - **Exchange Online**: [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - - **Exchange Online Protection** (Microsoft 365 organizations without Exchange Online mailboxes): [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). + - **Exchange Online PowerShell**: [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - **Exchange Server**: [Open the Exchange Management Shell](open-the-exchange-management-shell.md) or [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). 2. Replace `` and optionally, `,,...` with the values that you want to use, and run the following command: diff --git a/exchange/docs-conceptual/index.yml b/exchange/docs-conceptual/index.yml index 7fe140c922..31d1e247ed 100644 --- a/exchange/docs-conceptual/index.yml +++ b/exchange/docs-conceptual/index.yml @@ -31,7 +31,7 @@ landingContent: url: /powershell/exchange/exchange-online-powershell - text: Security & Compliance PowerShell url: /powershell/exchange/scc-powershell - - text: Exchange Online Protection PowerShell + - text: Exchange Online Protection PowerShell for cloud protection of on-premises email environments url: /powershell/exchange/exchange-online-protection-powershell - title: Connect linkLists: @@ -45,8 +45,6 @@ landingContent: url: /powershell/exchange/connect-to-exchange-online-powershell - text: Connect to Security & Compliance PowerShell url: /powershell/exchange/connect-to-scc-powershell - - text: Connect to Exchange Online Protection PowerShell - url: /powershell/exchange/connect-to-exchange-online-protection-powershell - title: More linkLists: - linkListType: overview diff --git a/exchange/docs-conceptual/recipient-filters.md b/exchange/docs-conceptual/recipient-filters.md index dc3ea8bf77..bf995e41b3 100644 --- a/exchange/docs-conceptual/recipient-filters.md +++ b/exchange/docs-conceptual/recipient-filters.md @@ -42,17 +42,17 @@ The following parameters are considered precanned filters: Precanned filters are available on the following cmdlets: -- [New-DynamicDistributionGroup](/powershell/module/exchange/new-dynamicdistributiongroup) -- [Set-DynamicDistributionGroup](/powershell/module/exchange/set-dynamicdistributiongroup) +- [New-DynamicDistributionGroup](/powershell/module/exchangepowershell/new-dynamicdistributiongroup) +- [Set-DynamicDistributionGroup](/powershell/module/exchangepowershell/set-dynamicdistributiongroup) -- [New-EmailAddressPolicy](/powershell/module/exchange/new-emailaddresspolicy) -- [Set-EmailAddressPolicy](/powershell/module/exchange/set-emailaddresspolicy) +- [New-EmailAddressPolicy](/powershell/module/exchangepowershell/new-emailaddresspolicy) +- [Set-EmailAddressPolicy](/powershell/module/exchangepowershell/set-emailaddresspolicy) -- [New-AddressList](/powershell/module/exchange/new-addresslist) -- [Set-AddressList](/powershell/module/exchange/set-addresslist) +- [New-AddressList](/powershell/module/exchangepowershell/new-addresslist) +- [Set-AddressList](/powershell/module/exchangepowershell/set-addresslist) -- [New-GlobalAddressList](/powershell/module/exchange/new-globaladdresslist) -- [Set-GlobalAddressList](/powershell/module/exchange/set-globaladdresslist) +- [New-GlobalAddressList](/powershell/module/exchangepowershell/new-globaladdresslist) +- [Set-GlobalAddressList](/powershell/module/exchangepowershell/set-globaladdresslist) ### Precanned filter example @@ -88,17 +88,17 @@ Get-DynamicDistributionGroup -Identity "Contoso Finance" | Format-List Recipient If precanned filters don't meet your needs, you can create custom filters by using the _RecipientFilter_ parameter. This parameter is available on the following cmdlets: -- [New-DynamicDistributionGroup](/powershell/module/exchange/new-dynamicdistributiongroup) -- [Set-DynamicDistributionGroup](/powershell/module/exchange/set-dynamicdistributiongroup) +- [New-DynamicDistributionGroup](/powershell/module/exchangepowershell/new-dynamicdistributiongroup) +- [Set-DynamicDistributionGroup](/powershell/module/exchangepowershell/set-dynamicdistributiongroup) -- [New-EmailAddressPolicy](/powershell/module/exchange/new-emailaddresspolicy) -- [Set-EmailAddressPolicy](/powershell/module/exchange/set-emailaddresspolicy) +- [New-EmailAddressPolicy](/powershell/module/exchangepowershell/new-emailaddresspolicy) +- [Set-EmailAddressPolicy](/powershell/module/exchangepowershell/set-emailaddresspolicy) -- [New-AddressList](/powershell/module/exchange/new-addresslist) -- [Set-AddressList](/powershell/module/exchange/set-addresslist) +- [New-AddressList](/powershell/module/exchangepowershell/new-addresslist) +- [Set-AddressList](/powershell/module/exchangepowershell/set-addresslist) -- [New-GlobalAddressList](/powershell/module/exchange/new-globaladdresslist) -- [Set-GlobalAddressList](/powershell/module/exchange/set-globaladdresslist) +- [New-GlobalAddressList](/powershell/module/exchangepowershell/new-globaladdresslist) +- [Set-GlobalAddressList](/powershell/module/exchangepowershell/set-globaladdresslist) For more information about the filterable properties you can use with the _RecipientFilter_ parameter, see [Filterable properties for the RecipientFilter parameter](recipientfilter-properties.md). @@ -133,21 +133,21 @@ Get-Mailbox -Identity Ayla | Format-List The _Filter_ parameter is available for the following recipient cmdlets: -- [Get-CASMailbox](/powershell/module/exchange/get-casmailbox) -- [Get-Contact](/powershell/module/exchange/get-contact) -- [Get-DistributionGroup](/powershell/module/exchange/get-distributiongroup) -- [Get-DynamicDistributionGroup](/powershell/module/exchange/get-dynamicdistributiongroup) -- [Get-Group](/powershell/module/exchange/get-group) -- [Get-Mailbox](/powershell/module/exchange/get-mailbox) -- [Get-MailContact](/powershell/module/exchange/get-mailcontact) -- [Get-MailPublicFolder](/powershell/module/exchange/get-mailpublicfolder) -- [Get-MailUser](/powershell/module/exchange/get-mailuser) -- [Get-Recipient](/powershell/module/exchange/get-recipient) -- [Get-RemoteMailbox](/powershell/module/exchange/get-remotemailbox) -- [Get-SecurityPrincipal](/powershell/module/exchange/get-securityprincipal) -- [Get-UMMailbox](/powershell/module/exchange/get-ummailbox) -- [Get-User](/powershell/module/exchange/get-user) -- [Get-UnifiedGroup](/powershell/module/exchange/get-unifiedgroup) +- [Get-CASMailbox](/powershell/module/exchangepowershell/get-casmailbox) +- [Get-Contact](/powershell/module/exchangepowershell/get-contact) +- [Get-DistributionGroup](/powershell/module/exchangepowershell/get-distributiongroup) +- [Get-DynamicDistributionGroup](/powershell/module/exchangepowershell/get-dynamicdistributiongroup) +- [Get-Group](/powershell/module/exchangepowershell/get-group) +- [Get-Mailbox](/powershell/module/exchangepowershell/get-mailbox) +- [Get-MailContact](/powershell/module/exchangepowershell/get-mailcontact) +- [Get-MailPublicFolder](/powershell/module/exchangepowershell/get-mailpublicfolder) +- [Get-MailUser](/powershell/module/exchangepowershell/get-mailuser) +- [Get-Recipient](/powershell/module/exchangepowershell/get-recipient) +- [Get-RemoteMailbox](/powershell/module/exchangepowershell/get-remotemailbox) +- [Get-SecurityPrincipal](/powershell/module/exchangepowershell/get-securityprincipal) +- [Get-UMMailbox](/powershell/module/exchangepowershell/get-ummailbox) +- [Get-User](/powershell/module/exchangepowershell/get-user) +- [Get-UnifiedGroup](/powershell/module/exchangepowershell/get-unifiedgroup) For more information about the filterable properties you can use with the _Filter_ parameter, see [Filterable properties for the Filter parameter](filter-properties.md). @@ -161,7 +161,7 @@ Get-User -Filter "Title -like 'Manager*'" ## Custom filters using the ContentFilter parameter -You can use the _ContentFilter_ parameter to select specific message content to export when using the [New-MailboxExportRequest](/powershell/module/exchange/new-mailboxexportrequest) cmdlet. If the command finds a message that contains the match to the content filter, it exports the message to a .pst file. +You can use the _ContentFilter_ parameter to select specific message content to export when using the [New-MailboxExportRequest](/powershell/module/exchangepowershell/new-mailboxexportrequest) cmdlet. If the command finds a message that contains the match to the content filter, it exports the message to a .pst file. ### ContentFilter parameter example diff --git a/exchange/docs-conceptual/recipientfilter-properties.md b/exchange/docs-conceptual/recipientfilter-properties.md index 0c75acd5b6..6e2a411bad 100644 --- a/exchange/docs-conceptual/recipientfilter-properties.md +++ b/exchange/docs-conceptual/recipientfilter-properties.md @@ -17,10 +17,10 @@ description: "Learn about the recipient properties that you can use with the Rec You use the _RecipientFilter_ parameter to create OPATH filters based on the properties of recipient objects in Exchange Server 2016 or later, and Exchange Online. The _RecipientFilter_ parameter is available in the following cmdlets: -- [New-AddressList](/powershell/module/exchange/new-addresslist) and [Set-AddressList](/powershell/module/exchange/set-addresslist) -- [New-DynamicDistributionGroup](/powershell/module/exchange/new-dynamicdistributiongroup) and [Set-DynamicDistributionGroup](/powershell/module/exchange/set-dynamicdistributiongroup) -- [New-EmailAddressPolicy](/powershell/module/exchange/new-emailaddresspolicy) and [Set-EmailAddressPolicy](/powershell/module/exchange/set-emailaddresspolicy) -- [New-GlobalAddressList](/powershell/module/exchange/new-globaladdresslist) and [Set-GlobalAddressList](/powershell/module/exchange/set-globaladdresslist) +- [New-AddressList](/powershell/module/exchangepowershell/new-addresslist) and [Set-AddressList](/powershell/module/exchangepowershell/set-addresslist) +- [New-DynamicDistributionGroup](/powershell/module/exchangepowershell/new-dynamicdistributiongroup) and [Set-DynamicDistributionGroup](/powershell/module/exchangepowershell/set-dynamicdistributiongroup) +- [New-EmailAddressPolicy](/powershell/module/exchangepowershell/new-emailaddresspolicy) and [Set-EmailAddressPolicy](/powershell/module/exchangepowershell/set-emailaddresspolicy) +- [New-GlobalAddressList](/powershell/module/exchangepowershell/new-globaladdresslist) and [Set-GlobalAddressList](/powershell/module/exchangepowershell/set-globaladdresslist) ## Filterable recipient properties @@ -117,7 +117,7 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_EwsApplicationAccessPolicy_|_msExchEwsApplicationAccessPolicy_|`EnforceAllowList` or `EnforceBlockList`.|| |_EwsEnabled_|_msExchEwsEnabled_|Integer|| |_ExchangeGuid_|_msExchMailboxGuid_|String (wildcards accepted).|| -|_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).|| +|_ExchangeUserAccountControl_|_msExchUserAccountControl_|For valid values, see [ADS_USER_FLAG_ENUM enumeration](/windows/win32/api/iads/ne-iads-ads_user_flag_enum). The integer values work as described. Most of the text values don'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).|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).| @@ -167,10 +167,10 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_LitigationHoldOwner_|_msExchLitigationHoldOwner_|String (wildcards accepted).|| |_LocaleID_|_localeID_|Integer|For valid values, [Microsoft Locale ID Values](/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a).| |_MailboxMoveBatchName_|_msExchMailboxMoveBatchName_|String (wildcards accepted).|| -|_MailboxMoveFlags_|_msExchMailboxMoveFlags_|For valid values, see the description of the _Flags_ parameter in [Get-MoveRequest](/powershell/module/exchange/get-moverequest).|| +|_MailboxMoveFlags_|_msExchMailboxMoveFlags_|For valid values, see the description of the _Flags_ parameter in [Get-MoveRequest](/powershell/module/exchangepowershell/get-moverequest).|| |_MailboxMoveRemoteHostName_|_msExchMailboxMoveRemoteHostName_|String (wildcards accepted).|| |_MailboxMoveSourceMDB_|_msExchMailboxMoveSourceMDBLink_|String (wildcards accepted in dynamic distribution groups).|| -|_MailboxMoveStatus_|_msExchMailboxMoveStatus_|For valid values, see the description of the _MoveStatus_ parameter in [Get-MoveRequest](/powershell/module/exchange/get-moverequest).|| +|_MailboxMoveStatus_|_msExchMailboxMoveStatus_|For valid values, see the description of the _MoveStatus_ parameter in [Get-MoveRequest](/powershell/module/exchangepowershell/get-moverequest).|| |_MailboxMoveTargetMDB_|_msExchMailboxMoveTargetMDBLink_|String (wildcards accepted in dynamic distribution groups).|| |_MailboxPlan_|_msExchParentPlanLink_|String (wildcards accepted).|Mailbox plans correspond to Microsoft 365 license types. The availability of a license plans is determined by the selections that you make when you enroll your domain.| |_MailboxRelease_|_msExchMailboxRelease_|String (wildcards accepted).|| @@ -221,9 +221,9 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_PopEnabled_|n/a|Boolean (`$true` or `$false`)|| |_PostalCode_|_postalCode_|String (wildcards accepted).|| |_PostOfficeBox_|_postOfficeBox_|String (wildcards accepted).|| -|_PreviousRecipientTypeDetails_|_msExchPreviousRecipientTypeDetails_|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient).|| +|_PreviousRecipientTypeDetails_|_msExchPreviousRecipientTypeDetails_|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchangepowershell/get-recipient).|| |_PrimaryGroupId_|_primaryGroupId_|Integer|For domain users, the value of this property is typically 513, which corresponds to the Domain Users group.| -|_PrimarySmtpAddress_|n/a|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'"`.| +|_PrimarySmtpAddress_|n/a|String (wildcards accepted).|Don't use the _PrimarySmtpAddress_ property; use the _EmailAddresses_ property instead. Any filter that uses the _PrimarySmtpAddress_ property also searches 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 return that mailbox in the result: `"PrimarySmtpAddress -eq 'dario@contoso.com'"`, `"PrimarySmtpAddress -eq 'dario2@contoso.com'"`, or `"PrimarySmtpAddress -eq 'dario3@contoso.com'"`.| |_ProhibitSendQuota_|_mDBOverQuotaLimit_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| |_ProhibitSendReceiveQuota_|_mDBOverHardQuotaLimit_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| |_ProtocolSettings_|_protocolSettings_|String (wildcards accepted).|| @@ -237,8 +237,8 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_RecipientDisplayType_|_msExchRecipientDisplayType_|`MailboxUser` (0), `DistributionGroup` (1), `PublicFolder` (2), `DynamicDistributionGroup` (3), `Organization` (4), `PrivateDistributionList` (5), `RemoteMailUser` (6). `ConferenceRoomMailbox` (7), or `EquipmentMailbox` (8).|| |_RecipientFilter_|_msExchQueryFilter_|String (wildcards accepted).|| |_RecipientLimits_|_msExchRecipLimit_|`Unlimited` or an integer.|This property specifies the maximum number of recipients that are allowed in messages sent by the mailbox.| -|_RecipientType_|n/a|For valid values, see the description of the _RecipientType_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient).|| -|_RecipientTypeDetails_|n/a|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient).|| +|_RecipientType_|n/a|For valid values, see the description of the _RecipientType_ parameter in [Get-Recipient](/powershell/module/exchangepowershell/get-recipient).|| +|_RecipientTypeDetails_|n/a|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchangepowershell/get-recipient).|| |_RecoverableItemsQuota_|_msExchDumpsterQuota_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| |_RecoverableItemsWarningQuota_|_msExchDumpsterWarningQuota_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| |_RejectMessagesFrom_|_unauthOrig_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| diff --git a/exchange/docs-conceptual/scc-powershell.md b/exchange/docs-conceptual/scc-powershell.md index e5ec203673..057ea44964 100644 --- a/exchange/docs-conceptual/scc-powershell.md +++ b/exchange/docs-conceptual/scc-powershell.md @@ -25,7 +25,7 @@ Security & Compliance PowerShell is the administrative interface that enables yo To learn about what's new in the Exchange Online PowerShell module, see [What's new in the Exchange Online PowerShell module](whats-new-in-the-exo-module.md). -- To connect to Security & Compliance PowerShell, see [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). The connection instructions are different from Exchange Online PowerShell or standalone Exchange Online Protection (EOP) PowerShell. +- To connect to Security & Compliance PowerShell, see [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). The connection instructions are different from Exchange Online PowerShell. To connect to Security & Compliance PowerShell for unattended scripts, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](app-only-auth-powershell-v2.md). @@ -34,8 +34,8 @@ Security & Compliance PowerShell is the administrative interface that enables yo Security & Compliance PowerShell contains the following types of cmdlets: - Cmdlets that correspond to features available only in Purview compliance and the Microsoft Purview compliance portal. Most cmdlets in Security & Compliance PowerShell fall into this category. -- Basic cmdlets that are also available in Exchange Online PowerShell (for example, [Get-User](/powershell/module/exchange/get-user), and [Get-RoleGroup](/powershell/module/exchange/get-rolegroup)). -- A few cmdlets that correspond to security features available in Exchange Online Protection (EOP) and Microsoft Defender for Office 365 in the Microsoft Defender portal (for example, [Set-SecOpsOverridePolicy](/powershell/module/exchange/set-secopsoverridepolicy)). +- Basic cmdlets that are also available in Exchange Online PowerShell (for example, [Get-User](/powershell/module/exchangepowershell/get-user), and [Get-RoleGroup](/powershell/module/exchangepowershell/get-rolegroup)). +- A few cmdlets that correspond to default protections for cloud mailboxes and protections in Microsoft Defender for Office 365 in the Microsoft Defender portal (for example, [Set-SecOpsOverridePolicy](/powershell/module/exchangepowershell/set-secopsoverridepolicy)). Cmdlets for most EOP and Defender for Office 365 security features (for example, [anti-spam policies](/defender-office-365/anti-spam-protection-about)) are available only in [Exchange Online PowerShell](exchange-online-powershell.md). diff --git a/exchange/docs-conceptual/toc.yml b/exchange/docs-conceptual/toc.yml index b19c66c699..fdf23fce6e 100644 --- a/exchange/docs-conceptual/toc.yml +++ b/exchange/docs-conceptual/toc.yml @@ -28,7 +28,7 @@ items: - name: About the Exchange Online PowerShell module href: exchange-online-powershell-v2.md - - name: Connect to Exchange Online PowerShell - modern auth and MFA + - name: Connect to Exchange Online PowerShell href: connect-to-exchange-online-powershell.md - name: Connect using app-only authentication for unattended scripts href: app-only-auth-powershell-v2.md @@ -62,7 +62,7 @@ items: - name: About the Exchange Online PowerShell module href: exchange-online-powershell-v2.md - - name: Connect to Security & Compliance PowerShell - modern auth and MFA + - name: Connect to Security & Compliance PowerShell href: connect-to-scc-powershell.md - name: App-only authentication for unattended scripts href: app-only-auth-powershell-v2.md @@ -72,13 +72,13 @@ 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 + - name: Exchange Online Protection PowerShell for cloud protection of on-premises email environments href: exchange-online-protection-powershell.md items: - name: About the Exchange Online PowerShell module href: exchange-online-powershell-v2.md - - name: Connect to Exchange Online Protection PowerShell - modern auth and MFA - href: connect-to-exchange-online-protection-powershell.md + - name: Connect to Exchange Online Protection PowerShell + href: connect-to-exchange-online-powershell.md - name: Exchange cmdlet syntax href: exchange-cmdlet-syntax.md - name: What's new in the Exchange Online PowerShell module diff --git a/exchange/docs-conceptual/values-for-custompropertynames-parameter.md b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md index ea729cff90..fcb4c97c9d 100644 --- a/exchange/docs-conceptual/values-for-custompropertynames-parameter.md +++ b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md @@ -19,7 +19,7 @@ description: "Learn about the valid values for the CustomPropertyNames parameter # Values for the CustomPropertyNames parameter in Exchange Online PowerShell -The _CustomPropertyNames_ parameter on the [Get-CalendarDiagnosticObjects](/powershell/module/exchange/get-calendardiagnosticobjects) cmdlet returns the specified properties in the results. +The _CustomPropertyNames_ parameter on the [Get-CalendarDiagnosticObjects](/powershell/module/exchangepowershell/get-calendardiagnosticobjects) cmdlet returns the specified properties in the results. The article describes the valid values for the _CustomPropertyNames_ parameter. 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 8433f095b8..8fd4fe23ec 100644 --- a/exchange/docs-conceptual/whats-new-in-the-exo-module.md +++ b/exchange/docs-conceptual/whats-new-in-the-exo-module.md @@ -3,7 +3,7 @@ title: What's new in the Exchange Online PowerShell module ms.author: chrisda author: chrisda manager: deniseb -ms.date: 09/25/2024 +ms.date: 06/23/2025 ms.audience: Admin audience: Admin ms.topic: article @@ -20,7 +20,33 @@ description: "Learn about the new features and functionality available in the la # What's new in the Exchange Online PowerShell module -This article lists new features in the Exchange Online PowerShell module that's used for connecting to Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. Features that are currently in preview are denoted with **(preview)**. +This article lists new features in the Exchange Online PowerShell module used for connecting to Exchange Online PowerShell, Security & Compliance PowerShell, and Exchange Online Protection PowerShell for cloud protection of on-premises email environments. Features that are currently in preview are denoted with **(preview)**. + +## May 2025 + +- [Version 3.8.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.8.0) + + - For information about what's in this release, see [Version 3.8.0](exchange-online-powershell-v2.md#version-380). + +## 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 diff --git a/exchange/exchange-ps/exchange/Add-ADPermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-ADPermission.md similarity index 79% rename from exchange/exchange-ps/exchange/Add-ADPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ADPermission.md index c1daf4b98b..72d50e2a33 100644 --- a/exchange/exchange-ps/exchange/Add-ADPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ADPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-adpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-ADPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-adpermission +schema: 2.0.0 +title: Add-ADPermission --- # Add-ADPermission @@ -63,9 +64,9 @@ Add-ADPermission [[-Identity] ] -Instance Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the object that's getting permissions added. You can specify either the distinguished name (DN) of the object or the object's name if it's unique. If the DN or name contains spaces, enclose the name in quotation marks ("). ```yaml Type: ADRawEntryIdParameter -Parameter Sets: AccessRights, Owner +Parameter Sets: AccessRights, Owner, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -103,27 +106,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: ADRawEntryIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Instance -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Instance The Instance parameter enables you to pass an entire object to the command to be processed. It's mainly used in scripts where an entire object must be passed to the command. ```yaml Type: ADAcePresentationObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -133,6 +125,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Owner parameter specifies the owner of the Active Directory object. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -158,7 +153,6 @@ You can't use this parameter with the AccessRights or User parameters. Type: SecurityPrincipalIdParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -168,6 +162,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The User parameter specifies who gets the permissions on the Active Directory object. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -196,9 +193,8 @@ You can't use this parameter with the Owner parameter. ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -207,20 +203,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -AccessRights -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -AccessRights The AccessRights parameter specifies the rights that you want to add for the user on the Active Directory object. Valid values include: - AccessSystemSecurity @@ -251,7 +237,6 @@ You can't use this parameter with the Owner parameter. Type: ActiveDirectoryRights[] Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,6 +246,9 @@ Accept wildcard characters: False ``` ### -ChildObjectTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ChildObjectTypes parameter specifies what type of object the permission should be applied to. The ChildObjectTypes parameter can only be used if the AccessRights parameter is set to CreateChild or DeleteChild. @@ -269,7 +257,6 @@ The ChildObjectTypes parameter can only be used if the AccessRights parameter is Type: ADSchemaObjectIdParameter[] Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -279,6 +266,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -288,7 +278,6 @@ 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 Required: False Position: Named @@ -298,13 +287,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Deny switch specifies that the permissions you're adding are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -314,6 +305,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -322,7 +316,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,13 +325,15 @@ Accept wildcard characters: False ``` ### -ExtendedRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedRights parameter specifies the extended rights needed to perform the operation. ```yaml Type: ExtendedRightIdParameter[] Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -348,6 +343,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InheritanceType parameter specifies how permissions are inherited. Valid values are: - None @@ -360,7 +358,6 @@ The InheritanceType parameter specifies how permissions are inherited. Valid val Type: ActiveDirectorySecurityInheritance Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -370,13 +367,15 @@ Accept wildcard characters: False ``` ### -InheritedObjectType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InheritedObjectType parameter specifies what kind of object inherits this access control entry (ACE). ```yaml Type: ADSchemaObjectIdParameter Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -386,6 +385,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Properties parameter specifies what properties the object contains. The Properties parameter can only be used if the AccessRights parameter is set to ReadProperty, WriteProperty or Self. @@ -394,7 +396,6 @@ The Properties parameter can only be used if the AccessRights parameter is set t Type: ADSchemaObjectIdParameter[] Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -404,13 +405,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-AttachmentFilterEntry.md b/exchange/exchange-ps/ExchangePowerShell/Add-AttachmentFilterEntry.md similarity index 88% rename from exchange/exchange-ps/exchange/Add-AttachmentFilterEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Add-AttachmentFilterEntry.md index 000fae4281..db5f2e767d 100644 --- a/exchange/exchange-ps/exchange/Add-AttachmentFilterEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-AttachmentFilterEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-attachmentfilterentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-AttachmentFilterEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-attachmentfilterentry +schema: 2.0.0 +title: Add-AttachmentFilterEntry --- # Add-AttachmentFilterEntry @@ -29,7 +30,7 @@ Add-AttachmentFilterEntry -Name -Type ``` ## DESCRIPTION -On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchangepowershell/set-attachmentfilterlistconfig). On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. @@ -52,6 +53,9 @@ This example adds an attachment filter entry based on the MIME content type imag ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the files that you want to block. Valid values are: - A exact file name (for example, BadFile.exe) or file name extension (for example, \*.exe). You need to use the value Filename for the Type parameter. @@ -61,7 +65,6 @@ The Name parameter specifies the files that you want to block. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Type parameter specifies what type of attachment the attachment filter entry blocks. Valid values are: - ContentType: This value matches the attachment filter entry against the MIME content type that's specified in the Name parameter. @@ -80,7 +86,6 @@ The Type parameter specifies what type of attachment the attachment filter entry Type: AttachmentType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -99,7 +107,6 @@ 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 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -117,7 +127,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md b/exchange/exchange-ps/ExchangePowerShell/Add-AvailabilityAddressSpace.md similarity index 78% rename from exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md rename to exchange/exchange-ps/ExchangePowerShell/Add-AvailabilityAddressSpace.md index aedd7aee1a..838c126e41 100644 --- a/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-AvailabilityAddressSpace.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-availabilityaddressspace -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Add-AvailabilityAddressSpace -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-availabilityaddressspace +schema: 2.0.0 +title: Add-AvailabilityAddressSpace --- # Add-AvailabilityAddressSpace ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Add-AvailabilityAddressSpace cmdlet to create availability address space objects that are used to share free/busy data across Exchange organizations. @@ -39,7 +40,7 @@ Add-AvailabilityAddressSpace -AccessMethod -ForestNam ## DESCRIPTION In Exchange Online, you need to run the New-AvailabilityConfig cmdlet before you run the Add-AvailabilityAddressSpace cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,11 +75,14 @@ In Exchange Online, this example sets up the sharing of free/busy information wi ## PARAMETERS ### -AccessMethod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AccessMethod parameter specifies how the free/busy data is accessed. Valid values are: - 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: Free/busy sharing between tenants that are all in Exchange Online. +- OrgWideFB: Only the 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. This value is deprecated for accessing target forests in Exchange Online. +- OrgWideFBToken: Used for free/busy sharing between two tenants in Exchange Online. Only the default free/busy for each user can be requested. This value also requires you to set both the TargetTenantId and TargetServiceEpr parameters. - 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. @@ -86,7 +90,6 @@ The AccessMethod parameter specifies how the free/busy data is accessed. Valid v Type: AvailabilityAccessMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -ForestName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -121,7 +129,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -Credentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Credentials parameter specifies the username and password that's used to access the Availability services in the target forest. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -139,7 +149,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -157,7 +169,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,17 +178,19 @@ Accept wildcard characters: False ``` ### -ProxyUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 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). +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/exchangepowershell/new-federationtrust). ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,13 +200,15 @@ Accept wildcard characters: False ``` ### -TargetAutodiscoverEpr + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,6 +218,9 @@ Accept wildcard characters: False ``` ### -TargetServiceEpr + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The TargetServiceEpr parameter specifies the Exchange Online Calendar Service URL of the external Microsoft 365 organization that you're trying to read free/busy information from. Valid values are: @@ -211,11 +229,12 @@ The TargetServiceEpr parameter specifies the Exchange Online Calendar Service UR - Office 365 operated by 21Vianet: partner.outlook.cn - Microsoft 365 GCC High or DoD: outlook.office365.us +You use this parameter only when the AccessMethod parameter value is OrgWideFBToken. + ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -225,15 +244,19 @@ Accept wildcard characters: False ``` ### -TargetTenantId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The TargetTenantID parameter specifies the tenant ID of the external Microsoft 365 organization that you're trying to read free/busy information from. +You use this parameter only when the AccessMethod parameter value is OrgWideFBToken. + ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,6 +266,9 @@ Accept wildcard characters: False ``` ### -UseServiceAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UseServiceAccount parameter specifies whether to use the local Availability service account for authorization. Valid values @@ -254,7 +280,6 @@ The UseServiceAccount parameter specifies whether to use the local Availability Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +289,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 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/Add-ComplianceCaseMember.md b/exchange/exchange-ps/ExchangePowerShell/Add-ComplianceCaseMember.md similarity index 94% rename from exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ComplianceCaseMember.md index ddec608aad..c486c651c8 100644 --- a/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ComplianceCaseMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-compliancecasemember applicable: Security & Compliance -title: Add-ComplianceCaseMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-compliancecasemember +schema: 2.0.0 +title: Add-ComplianceCaseMember --- # Add-ComplianceCaseMember @@ -50,6 +51,9 @@ This example adds John Evans to the eDiscovery case named Case 2112. ## PARAMETERS ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the name of the eDiscovery case that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. @@ -58,7 +62,6 @@ To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Security & Compliance + The Member parameter specifies the user that you want to add to the eDiscovery case. You can use any value that uniquely identifies the user. For example: - Name @@ -79,7 +85,6 @@ The Member parameter specifies the user that you want to add to the eDiscovery c Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md b/exchange/exchange-ps/ExchangePowerShell/Add-ContentFilterPhrase.md similarity index 79% rename from exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ContentFilterPhrase.md index 72bcef12ec..09129774b2 100644 --- a/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ContentFilterPhrase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-contentfilterphrase -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-ContentFilterPhrase -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-contentfilterphrase +schema: 2.0.0 +title: Add-ContentFilterPhrase --- # Add-ContentFilterPhrase @@ -31,7 +32,7 @@ Add-ContentFilterPhrase [-Phrase] -Influence ## DESCRIPTION The Add-ContentFilterPhrase cmdlet adds phrases to the Allow or Block phrases list. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,18 +41,20 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Add-ContentFilterPhrase -Phrase "Free credit report" -Influence BadWord ``` -This example adds the phrase Free credit report to the Block phrase list. Any messages that contain this phrase will be marked as spam by the Content Filtering agent. +This example adds the phrase Free credit report to the Block phrase list. Any messages that contain this phrase are marked as spam by the Content Filtering agent. ## PARAMETERS ### -Phrase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Phrase parameter specifies a custom word or phrase for the Content Filter agent. When you pass an argument, you must enclose the Phrase parameter in quotation marks (") if the phrase contains spaces, for example: "This is a bad phrase". Custom phrases must be less than 257 characters in length. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,7 +64,10 @@ Accept wildcard characters: False ``` ### -Influence -The Influence parameter specifies whether the phrase being added will cause the messages that contain the phrase to be allowed or blocked. Valid values are GoodWord and BadWord. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Influence parameter specifies whether the phrase being added cause messages that contain the phrase to be allowed or blocked. Valid values are GoodWord and BadWord. A message that contains a custom word or phrase that has an Influence value of GoodWord is automatically assigned a spam confidence level (SCL) rating of 0 and therefore bypasses downstream spam processing. A message that contains a custom word or phrase that has an Influence value of BadWord is automatically assigned an SCL rating of 9 and therefore is treated as spam. @@ -69,7 +75,6 @@ A message that contains a custom word or phrase that has an Influence value of G Type: Influence Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -88,7 +96,6 @@ 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 Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -106,7 +116,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md b/exchange/exchange-ps/ExchangePowerShell/Add-DatabaseAvailabilityGroupServer.md similarity index 83% rename from exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md rename to exchange/exchange-ps/ExchangePowerShell/Add-DatabaseAvailabilityGroupServer.md index d1e4a31542..304718b464 100644 --- a/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-DatabaseAvailabilityGroupServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-databaseavailabilitygroupserver -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-DatabaseAvailabilityGroupServer -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-databaseavailabilitygroupserver +schema: 2.0.0 +title: Add-DatabaseAvailabilityGroupServer --- # Add-DatabaseAvailabilityGroupServer @@ -36,7 +37,7 @@ To add a Mailbox server to a DAG, the Mailbox server must be running the Windows To add the first server to a DAG and create a computer object for the DAG, the Exchange Windows Permissions security group must have the appropriate rights to add computer accounts to the domain. Alternatively, a computer account can be created and disabled prior to adding the server. Adding the first server to the DAG enables the computer account for the DAG. Thus, the account used for the task doesn't need permissions to add a computer account to the domain. If you're pre-creating the computer account, the name of the account must match the name for the DAG. For example, if the DAG is named DAG1, the computer account must be named DAG1. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example adds the Mailbox server MBX1 to the DAG DAG1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the DAG to which the server is being added. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxServer parameter specifies the Mailbox server to add to the DAG. You can use any value that uniquely identifies the server. For example: - Name @@ -77,7 +83,6 @@ The MailboxServer parameter specifies the Mailbox server to add to the DAG. You Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 2 @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -96,7 +104,6 @@ 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 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -SkipDagValidation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when adding members to the DAG. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Add-DistributionGroupMember.md similarity index 78% rename from exchange/exchange-ps/exchange/Add-DistributionGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Add-DistributionGroupMember.md index 90029ad72b..27ef056242 100644 --- a/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-DistributionGroupMember.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-distributiongroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Add-DistributionGroupMember -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-distributiongroupmember +schema: 2.0.0 +title: Add-DistributionGroupMember --- # Add-DistributionGroupMember ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Add-DistributionGroupMember cmdlet to add a single recipient to distribution groups and mail-enabled security groups. To replace all members, use the Update-DistributionGroupMember cmdlet. @@ -31,7 +32,7 @@ Add-DistributionGroupMember [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example adds John Evans to the distribution group named Staff. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the group that you want to modify. You can use Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -79,7 +85,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -98,7 +106,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Member parameter specifies the recipient that you want to add to the group. A member can be any mail-enabled recipient in your organization. You can use any value that uniquely identifies the recipient. For example: - Name @@ -135,13 +147,12 @@ The Member parameter specifies the recipient that you want to add to the group. - Email address - GUID -Although it isn't required, it's a good idea to add only security principals (for example, mailboxes and mail users with user accounts or other mail-enabled security groups) to mail-enabled security groups. If you assign permissions to a mail-enabled security group, any members that aren't security principals (for example, mail contacts or distribution groups) won't have the permissions assigned. +Although it isn't required, it's a good idea to add only security principals (for example, mailboxes and mail users with user accounts or other mail-enabled security groups) to mail-enabled security groups. If you assign permissions to a mail-enabled security group, any members that aren't security principals (for example, mail contacts or distribution groups) don't have the permissions assigned. ```yaml Type: RecipientWithAdUserGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 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/Add-FederatedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Add-FederatedDomain.md similarity index 80% rename from exchange/exchange-ps/exchange/Add-FederatedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Add-FederatedDomain.md index 1a193dfead..43d6ec2fd3 100644 --- a/exchange/exchange-ps/exchange/Add-FederatedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-FederatedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-federateddomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-FederatedDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-federateddomain +schema: 2.0.0 +title: Add-FederatedDomain --- # Add-FederatedDomain @@ -35,7 +36,7 @@ You can add any registered Internet domain to the federated organization identif For more details, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example adds the domain Contoso.co.uk to the existing federation trust. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainName parameter specifies the secondary domain to be configured. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -90,7 +98,6 @@ 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 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Add-GlobalMonitoringOverride.md similarity index 80% rename from exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Add-GlobalMonitoringOverride.md index 975a6bf632..259ccd73c8 100644 --- a/exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-GlobalMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-globalmonitoringoverride -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-GlobalMonitoringOverride -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-globalmonitoringoverride +schema: 2.0.0 +title: Add-GlobalMonitoringOverride --- # Add-GlobalMonitoringOverride @@ -43,7 +44,7 @@ Add-GlobalMonitoringOverride [-Identity] -ItemType Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Identity parameter specifies the identity of the probe, monitor, or responder. This parameter uses the syntax `HealthSetName\MonitoringItemName[\TargetResource]`. The values are case sensitive. For example, use `AD\ActiveDirectoryConnectivityServerReboot`, not `ad\activedirectoryconnectivityserverreboot`. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -ApplyVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ApplyVersion parameter specifies the version of Exchange that gets the override. If an Exchange server is older or newer than the version you specify, the override isn't applied to the server. Typically, you increase the Exchange version by applying Cumulative Updates or Service Packs. Valid input for this parameter is an Exchange version number in the format 15.0x.xxxx.xxx. @@ -90,7 +96,6 @@ You can't use this parameter with the Duration parameter. Type: Version Parameter Sets: ApplyVersion Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -ItemType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ItemType parameter specifies the item type for the property that you want to override. Valid values are: - Probe @@ -110,7 +118,6 @@ The ItemType parameter specifies the item type for the property that you want to Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PropertyName parameter specifies the property that you want to override. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PropertyValue parameter specifies the new value for the property that you want to override. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -161,7 +175,6 @@ 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 Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -179,7 +195,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,6 +204,9 @@ Accept wildcard characters: False ``` ### -Duration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Duration parameter specifies the length of time that the override is active. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -201,7 +219,6 @@ You can't use this parameter with the ApplyVersion parameter. Type: EnhancedTimeSpan Parameter Sets: Duration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,13 +228,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,13 +246,15 @@ Accept wildcard characters: False ``` ### -BuildRange + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: Duration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,13 +264,15 @@ Accept wildcard characters: False ``` ### -Roles + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListEntry.md similarity index 84% rename from exchange/exchange-ps/exchange/Add-IPAllowListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListEntry.md index d987ed4c56..15d016541d 100644 --- a/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-ipallowlistentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-IPAllowListEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-ipallowlistentry +schema: 2.0.0 +title: Add-IPAllowListEntry --- # Add-IPAllowListEntry @@ -65,13 +66,15 @@ This example adds the IP address range 192.168.0.1/24 to the list of allowed IP ## PARAMETERS ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddress parameter specifies a single IP address to add to the IP Allow list, for example, 192.168.0.1. ```yaml Type: IPAddress Parameter Sets: IPAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -IPRange + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPRange parameter specifies a range of IP addresses to add to the IP Allow list. Valid values are: - IP address range: 192.168.0.1-192.168.0.254. @@ -90,7 +96,6 @@ The IPRange parameter specifies a range of IP addresses to add to the IP Allow l Type: IPRange Parameter Sets: IPRange Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -125,7 +135,6 @@ 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 Required: False Position: Named @@ -135,7 +144,10 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ExpirationTime parameter specifies a day and time when the IP Allow list entry expires. 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". @@ -143,7 +155,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,6 +164,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -168,7 +182,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-IPAllowListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListProvider.md similarity index 85% rename from exchange/exchange-ps/exchange/Add-IPAllowListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListProvider.md index 9b528293bd..1082ee93e4 100644 --- a/exchange/exchange-ps/exchange/Add-IPAllowListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-ipallowlistprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-IPAllowListProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-ipallowlistprovider +schema: 2.0.0 +title: Add-IPAllowListProvider --- # Add-IPAllowListProvider @@ -55,13 +56,15 @@ This example adds an IP Allow list provider and configures a bitmask return valu ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a descriptive name for the IP Allow list provider. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -LookupDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LookupDomain parameter specifies the host name that's required to use the allow list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An example value is allowlist.spamservice.com. The actual value you need to use is provided by the allow list provider. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -AnyMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnyMatch parameter specifies whether any response by the allow list provider is treated as a match. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, and connection filtering sends the IP address of the connecting SMTP server to the allow list provider, any response code returned by the allow list provider causes connection filtering to allow messages from that source. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -BitmaskMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BitmaskMatch parameter specifies the bit mask status code that's returned by the allow list provider. Use this parameter if the allow list provider returns bitmask responses. Valid input for this parameter is a single IP address in the format 127.0.0.1. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -128,7 +140,6 @@ 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 Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -146,7 +160,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +169,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the connection filtering uses this IP Allow List provider. Valid input for this parameter is $true or $false. The default value is $true. By default, connection filtering uses new IP Allow List providers that you create. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +187,15 @@ Accept wildcard characters: False ``` ### -IPAddressesMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddressesMatch parameter specifies the IP address status codes that are returned by the allow list provider. Use this parameter if the allow list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. You can enter multiple IP addresses separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +205,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Priority parameter specifies the order that the Connection Filtering agent queries the IP Allow list providers that you have configured. A lower priority integer value indicates a higher priority. By default, every time that you add a new IP Allow list provider, the entry is assigned a priority of N+1, where N is the number of IP Allow list providers that you have configured. If you set the Priority parameter to a value that's the same as another IP Allow list provider, the priority of the IP Allow list provider that you add first is incremented by 1. @@ -196,7 +216,6 @@ If you set the Priority parameter to a value that's the same as another IP Allow Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +225,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListEntry.md similarity index 84% rename from exchange/exchange-ps/exchange/Add-IPBlockListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListEntry.md index 35072b31fd..8fb02445ce 100644 --- a/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-ipblocklistentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-IPBlockListEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-ipblocklistentry +schema: 2.0.0 +title: Add-IPBlockListEntry --- # Add-IPBlockListEntry @@ -64,13 +65,15 @@ This example adds the IP address range 192.168.0.1/24 to the list of blocked IP ## PARAMETERS ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddress parameter specifies a single IP address to add to the IP Block list, for example, 192.168.0.1. ```yaml Type: IPAddress Parameter Sets: IPAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -IPRange + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPRange parameter specifies a range of IP addresses to add to the IP Block list. Valid values are: - IP address range: 192.168.0.1-192.168.0.254. @@ -89,7 +95,6 @@ The IPRange parameter specifies a range of IP addresses to add to the IP Block l Type: IPRange Parameter Sets: IPRange Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -124,7 +134,6 @@ 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 Required: False Position: Named @@ -134,7 +143,10 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ExpirationTime parameter specifies a day and time when the IP Block list entry expires. 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". @@ -142,7 +154,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -167,7 +181,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-IPBlockListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListProvider.md similarity index 85% rename from exchange/exchange-ps/exchange/Add-IPBlockListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListProvider.md index 29ca57a584..a7505efecc 100644 --- a/exchange/exchange-ps/exchange/Add-IPBlockListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-ipblocklistprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-IPBlockListProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-ipblocklistprovider +schema: 2.0.0 +title: Add-IPBlockListProvider --- # Add-IPBlockListProvider @@ -56,13 +57,15 @@ This example adds an IP Block list provider and configures a bitmask return valu ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a descriptive name for the IP Block list provider. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -LookupDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LookupDomain parameter specifies the host name that's required to use the block list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An example value is blocklist.spamservice.com. The actual value you need to use is provided by the block list provider. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -AnyMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnyMatch parameter specifies whether any response by the block list provider is treated as a match. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, and connection filtering sends the IP address of the connecting SMTP server to the block list provider, any response code returned by the block list provider causes connection filtering to block messages from that source. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -BitmaskMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BitmaskMatch parameter specifies the bit mask status code that's returned by the block list provider. Use this parameter if the block list provider returns bitmask responses. Valid input for this parameter is a single IP address in the format 127.0.0.1. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -129,7 +141,6 @@ 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 Required: False Position: Named @@ -139,6 +150,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -147,7 +161,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +170,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the connection filtering uses this IP Block list provider. Valid input for this parameter is $true or $false. The default value is $true. By default, connection filtering uses new IP Block List providers that you create. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,13 +188,15 @@ Accept wildcard characters: False ``` ### -IPAddressesMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddressesMatch parameter specifies the IP address status codes that are returned by the block list provider. Use this parameter if the block list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. You can enter multiple IP addresses separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,6 +206,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Priority parameter specifies the order that the Connection Filtering agent queries the IP Block list providers. A lower priority integer value indicates a higher priority. By default, every time that you add a new IP Block list provider, the entry is assigned a priority of N+1, where N is the number of IP Block list provider services that you have configured. If you set the Priority parameter to a value that's the same as another IP Block list provider service, the priority of the IP Block list provider that you add first is incremented by 1. @@ -197,7 +217,6 @@ If you set the Priority parameter to a value that's the same as another IP Block Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +226,9 @@ Accept wildcard characters: False ``` ### -RejectionResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectionResponse parameter specifies the text that you want to include in the SMTP rejection response when messages are blocked by connection filtering. The argument can't exceed 240 characters. If the value contains spaces, enclose the value in quotation marks ("). You should always specify the block list provider in the response so that legitimate senders can contact the block list provider for removal instructions. For example, "Source IP address is listed at the Contoso.com block list provider". @@ -215,7 +237,6 @@ You should always specify the block list provider in the response so that legiti Type: AsciiString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +246,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxDatabaseCopy.md similarity index 78% rename from exchange/exchange-ps/exchange/Add-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Add-MailboxDatabaseCopy.md index df90710452..94aac1dcad 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-mailboxdatabasecopy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-MailboxDatabaseCopy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxdatabasecopy +schema: 2.0.0 +title: Add-MailboxDatabaseCopy --- # Add-MailboxDatabaseCopy @@ -40,11 +41,11 @@ To use the Add-MailboxDatabaseCopy cmdlet to add a mailbox database copy, the fo - The specified Mailbox server must be in the same database availability group (DAG), and the DAG must have quorum and be healthy. - The specified Mailbox server must not already host a copy of the specified mailbox database. - The database path used by the specified database must also be available on the specified Mailbox server, because all copies of a database must use the same path. -- If you're adding the second copy of a database (for example, adding the first passive copy of the database), circular logging must not be enabled for the specified mailbox database. If circular logging is enabled, you must first disable it. After the mailbox database copy has been added, circular logging can be enabled. After enabling circular logging for a replicated mailbox database, continuous replication circular logging (CRCL) is used instead of JET circular logging. If you're adding the third or subsequent copy of a database, CRCL can remain enabled. +- If you're adding the second copy of a database (for example, adding the first passive copy of the database), circular logging must not be enabled for the specified mailbox database. If circular logging is enabled, you must first disable it. After the mailbox database copy is added, circular logging can be enabled. After enabling circular logging for a replicated mailbox database, continuous replication circular logging (CRCL) is used instead of JET circular logging. If you're adding the third or subsequent copy of a database, CRCL can remain enabled. After running the Add-MailboxDatabaseCopy cmdlet, the new copy remains in a Suspended state if the SeedingPostponed parameter is specified. When the database copy status is set to Suspended, the SuspendMessage is set to "Replication is suspended for database copy '{0}' because database needs to be seeded." -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,6 +73,9 @@ This example adds a copy of mailbox database DB3 to the Mailbox server MBX4. Rep ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox database that's being copied. You can use any value that uniquely identifies the database. For example: - Name @@ -82,7 +86,6 @@ The Identity parameter specifies the mailbox database that's being copied. You c Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -92,13 +95,15 @@ Accept wildcard characters: False ``` ### -MailboxServer -The MailboxServer parameter specifies the name of the server that will host the database copy. This server must be a member of the same DAG and must not already host a copy of the database. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The MailboxServer parameter specifies the name of the server that hosts the database copy. This server must be a member of the same DAG and must not already host a copy of the database. ```yaml Type: MailboxServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 2 @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -ActivationPreference + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActivationPreference parameter value is used as part of Active Manager's best copy selection process and to redistribute active mailbox databases throughout the DAG when using the RedistributeActiveDatabases.ps1 script. The value for the activation preference is a number equal to or greater than 1, where 1 is at the top of the preference order. The preference number can't be larger than the number of copies of the mailbox database. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,15 +131,17 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigurationOnly switch allows database copies to be added without invoking automatic seeding. You don't need to specify a value with this switch. -The source database does not need to be online or present when using this parameter. It will create a new database in Active Directory without contacting the target server. This parameter may be useful in situations where the target server is down for maintenance and the new database copy does not yet exist on the target server. +The source database does not need to be online or present when using this parameter. It creates a new database in Active Directory without contacting the target server. This parameter might be useful in situations where the target server is down for maintenance and the new database copy does not yet exist on the target server. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -151,7 +163,6 @@ 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 Required: False Position: Named @@ -161,13 +172,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,19 +190,21 @@ Accept wildcard characters: False ``` ### -ReplayLagMaxDelay + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplayLagMaxDelay parameter specifies the maximum delay for lagged database copy play down (also known as deferred lagged copy play down). If the disk read IO latency is greater than 25 ms, lagged copy play down is delayed up to the value of this parameter. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. The default value is 24:00:00 (24 hours). To disable deferred lagged copy play down, specify the value 00:00:00. -Note that when the disk is running out of space, the value of this parameter is ignored and lagged copy play down occurs without delay. +When the disk is running out of space, the value of this parameter is ignored and lagged copy play down occurs without delay. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,6 +214,9 @@ Accept wildcard characters: False ``` ### -ReplayLagTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplayLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service waits before replaying log files that have been copied to the database copy. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -209,7 +227,6 @@ The default value is 00.00:00:00, which specifies that there's no truncation lag Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,13 +236,15 @@ Accept wildcard characters: False ``` ### -SeedingPostponed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SeedingPostponed switch specifies that the task doesn't seed the database copy, so you need to explicitly seed the database copy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -235,7 +254,10 @@ Accept wildcard characters: False ``` ### -TruncationLagTime -The TruncationLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service waits before truncating log files that have replayed into a copy of the database. The time period begins after the log has been successfully replayed into the copy of the database. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The TruncationLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service waits before truncating log files that have replayed into a copy of the database. The time period begins after the log is successfully replayed into the copy of the database. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -245,7 +267,6 @@ The default value is 00.00:00:00, which specifies that there's no truncation lag Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,13 +276,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxFolderPermission.md similarity index 83% rename from exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-MailboxFolderPermission.md index bda1bfce49..f8c9b6d56e 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxFolderPermission.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Add-MailboxFolderPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxfolderpermission +schema: 2.0.0 +title: Add-MailboxFolderPermission --- # Add-MailboxFolderPermission ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Add-MailboxFolderPermission cmdlet to add folder-level permissions for users in mailboxes. @@ -33,7 +34,7 @@ Add-MailboxFolderPermission [-Identity] -AccessRights ## DESCRIPTION To modify the permissions that are assigned to the user on a mailbox folder, use the Set-MailboxFolderPermission cmdlet. To remove all permissions that are assigned to a user on a mailbox folder, use the Remove-MailboxFolderPermission cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,6 +62,9 @@ In Exchange Online, this example adds Laura as a calendar delegate to Ayla's mai ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the target mailbox and folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -82,7 +86,6 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Inb Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AccessRights parameter specifies the permissions that you want to add for the user on the mailbox folder. You can specify individual folder permissions or roles, which are combinations of permissions. You can specify multiple permissions and roles separated by commas. @@ -132,7 +138,6 @@ When the Editor role is applied to calendar folders, delegates can accept or dec Type: MailboxFolderAccessRight[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -142,6 +147,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The User parameter specifies who's granted permission to the mailbox folder. Valid values are mail-enabled security principals (mail-enabled accounts or groups that have security identifiers or SIDs that can have permissions assigned to them). For example: - User mailboxes @@ -166,7 +174,6 @@ Otherwise, you can use any value that uniquely identifies the user or group. For Type: MailboxFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -176,6 +183,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -185,7 +195,6 @@ 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 Required: False Position: Named @@ -195,6 +204,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -203,7 +215,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -213,12 +224,15 @@ Accept wildcard characters: False ``` ### -SendNotificationToUser + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The SendNotificationToUser parameter specifies whether to send a sharing invitation to the user when you add calendar permissions for them. The message will be a normal calendar sharing invitation that can be accepted by the recipient. Valid values are: +The SendNotificationToUser parameter specifies whether to send a sharing invitation to the user when you add calendar permissions for them. The message is a normal calendar sharing invitation that can be accepted by the recipient. Valid values are: - $true: A sharing invitation is sent. -- $false: No sharing invitation is sent. This is the default value. +- $false: No sharing invitation is sent. This value is the default. This parameter only applies to calendar folders and can only be used with the following AccessRights parameter values: @@ -231,7 +245,6 @@ This parameter only applies to calendar folders and can only be used with the fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -241,12 +254,15 @@ Accept wildcard characters: False ``` ### -SharingPermissionFlags + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SharingPermissionFlags parameter assigns calendar delegate permissions. This parameter only applies to calendar folders and can only be used when the AccessRights parameter value is Editor. Valid values are: -- None: Has no effect. This is the default value. -- Delegate: The user is made a calendar delegate, which includes receiving meeting invites and responses. If there are no other delegates, this value will create the meeting message rule. If there are existing delegates, the user is added to the meeting message rule without changing how delegate messages are sent. +- None: Has no effect. This value is the default. +- Delegate: The user is made a calendar delegate, which includes receiving meeting invites and responses. If there are no other delegates, this value creates the meeting message rule. If there are existing delegates, the user is added to the meeting message rule without changing how delegate messages are sent. - CanViewPrivateItems: The user can access private items on the calendar. You must use this value with the Delegate value. You can specify multiple values separated by commas. @@ -257,7 +273,6 @@ You can specify multiple values separated by commas. Type: MailboxFolderPermissionFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -267,13 +282,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -299,10 +316,10 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderpermission) -[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxfolderpermission) -[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Add-MailboxPermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxPermission.md similarity index 77% rename from exchange/exchange-ps/exchange/Add-MailboxPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-MailboxPermission.md index 47a39e1221..cb64d53366 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxPermission.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-mailboxpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Add-MailboxPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxpermission +schema: 2.0.0 +title: Add-MailboxPermission --- # Add-MailboxPermission ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Add-MailboxPermission cmdlet to add permissions to a mailbox or to an Exchange Server 2016, Exchange Server 2019, or Exchange Online mail user. @@ -66,7 +67,7 @@ Add-MailboxPermission [[-Identity] ] -Instance [!NOTE] > You can use this cmdlet to add a maximum of 500 permission entries (ACEs) to a mailbox. To grant permissions to more than 500 users, use security groups instead of individual users for the User parameter. Security groups contain many members, but only count as one entry. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -101,6 +102,9 @@ In Exchange Online, this example assigns the administrator account admin@contoso ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox where you want to assign permissions to the user. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -116,9 +120,8 @@ The Identity parameter specifies the mailbox where you want to assign permission ```yaml Type: MailboxIdParameter -Parameter Sets: AccessRights, Owner +Parameter Sets: AccessRights, Owner, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -127,20 +130,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: MailboxIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -AccessRights -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -AccessRights The AccessRights parameter specifies the permission that you want to add for the user on the mailbox. Valid values are: - ChangeOwner @@ -156,9 +149,8 @@ You can't use this parameter with the Owner parameter. ```yaml Type: MailboxRights[] -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -167,29 +159,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxRights[] -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Instance -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Instance This parameter is available only in on-premises Exchange. -This parameter has been deprecated and is no longer used. +This parameter is deprecated and no longer used. ```yaml Type: MailboxAcePresentationObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -199,6 +180,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Owner parameter specifies the owner of the mailbox object. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -226,7 +210,6 @@ You can't use this parameter with the AccessRights or User parameters. Type: SecurityPrincipalIdParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -236,13 +219,16 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The User parameter specifies who gets the permissions on the mailbox. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users - Mail users - Mail-enabled security groups (non-mail-enabled security groups are selectable, but they don't work) -**Note**: When a mail-enabled security group is used to specify Full Access permissions, the auto-mapping feature won't automatically add the mailbox in Outlook for the group member. For more information, see [Mailboxes to which your account has full access aren't automapped to Outlook profile](https://learn.microsoft.com/outlook/troubleshoot/profiles-and-accounts/full-access-mailbox-not-automapped-outlook-profile). +**Note**: When a mail-enabled security group is used to specify Full Access permissions, the auto-mapping feature doesn't automatically add the mailbox in Outlook for the group member. For more information, see [Mailboxes to which your account has full access aren't automapped to Outlook profile](https://learn.microsoft.com/outlook/troubleshoot/profiles-and-accounts/full-access-mailbox-not-automapped-outlook-profile). For the best results, we recommend using the following values: @@ -266,9 +252,8 @@ You can't use this parameter with the Owner parameter. ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -277,23 +262,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -AutoMapping -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -AutoMapping -The AutoMapping parameter includes or excludes the mailbox from the auto-mapping feature in Microsoft Outlook. Auto-mapping uses Autodiscover to automatically add mailboxes to a user's Outlook profile if the user has Full Access permission to the mailbox. However, Autodiscover won't enumerate security groups that are given Full Access permission to the mailbox. Valid values are: +The AutoMapping parameter includes or excludes the mailbox from the auto-mapping feature in Microsoft Outlook. Auto-mapping uses Autodiscover to automatically add mailboxes to a user's Outlook profile if the user has Full Access permission to the mailbox. However, Autodiscover doesn't enumerate security groups that have Full Access permission to the mailbox. Valid values are: -- $true: The mailbox is automatically added to the user's Outlook profile if the user has Full Access permission. This is the default value. +- $true: The mailbox is automatically added to the user's Outlook profile if the user has Full Access permission. This value is the default. - $false: The mailbox is not automatically added to the user's Outlook profile if the user has Full Access permission. **Note**: To disable auto-mapping for a mailbox where the user was already assigned Full Access permission, you need to remove the user's Full Access permission by using the Remove-MailboxPermission cmdlet, and then reassign the user Full Access permission on the mailbox using the AutoMapping parameter with the value $false. @@ -302,7 +277,6 @@ The AutoMapping parameter includes or excludes the mailbox from the auto-mapping Type: Boolean Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -312,6 +286,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -321,7 +298,6 @@ 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 Required: False Position: Named @@ -331,13 +307,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Deny switch specifies that the permissions you're adding are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -347,6 +325,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -355,7 +336,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -365,6 +345,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to add permissions to a Microsoft 365 Group mailbox. You don't need to specify a value with this switch. @@ -373,7 +356,6 @@ The GroupMailbox switch is required to add permissions to a Microsoft 365 Group Type: SwitchParameter Parameter Sets: AccessRights, Owner, Instance Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -383,6 +365,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -394,7 +379,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -404,6 +388,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InheritanceType parameter specifies how permissions are inherited by folders in the mailbox. Valid values are: - None @@ -416,23 +403,24 @@ The InheritanceType parameter specifies how permissions are inherited by folders Type: ActiveDirectorySecurityInheritance Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named -Default value: None +Default value: All Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md b/exchange/exchange-ps/ExchangePowerShell/Add-ManagementRoleEntry.md similarity index 77% rename from exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ManagementRoleEntry.md index 6b98323cb7..711946c26d 100644 --- a/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ManagementRoleEntry.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-managementroleentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Add-ManagementRoleEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-managementroleentry +schema: 2.0.0 +title: Add-ManagementRoleEntry --- # Add-ManagementRoleEntry ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Add-ManagementRoleEntry cmdlet to add management role entries to an existing management role. @@ -49,11 +50,11 @@ Add-ManagementRoleEntry [-ParentRoleEntry] -Role Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the role entry that you want to add. This parameter uses the syntax: `Management role\role entry name` (for example, `CustomRole\Set-Mailbox`). For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). @@ -98,7 +102,6 @@ The role entry you want to add must exist in the parent role. If the role entry Type: RoleEntryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -108,13 +111,15 @@ Accept wildcard characters: False ``` ### -ParentRoleEntry + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ParentRoleEntry parameter specifies the role entry in the parent role to add to the role specified with the Role parameter. This parameter generally isn't used directly, but exists to enable the piping of role entries from the Get-ManagementRoleEntry cmdlet. If you use the ParentRoleEntry parameter, you can't use the UnScopedTopLevel switch. ```yaml Type: RoleEntryIdParameter Parameter Sets: ParentRoleEntry Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -124,13 +129,15 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Role parameter specifies the role to which the new role entry, specified by the ParentRoleEntry parameter, is added. ```yaml Type: RoleIdParameter Parameter Sets: ParentRoleEntry Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -149,7 +159,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -167,7 +179,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,6 +188,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -187,7 +201,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -197,13 +210,15 @@ Accept wildcard characters: False ``` ### -Overwrite + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Overwrite switch causes existing role entries to be overwritten by the role entries being added. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -213,13 +228,15 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Parameters parameter specifies the parameters to be included in the role being added. The parameters specified must exist on the cmdlet associated with the role entry. You can specify multiple parameters, separated with commas. ```yaml Type: String[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -229,6 +246,9 @@ Accept wildcard characters: False ``` ### -PSSnapinName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PSSnapinName parameter specifies the Windows PowerShell snap-in that contains the cmdlet associated with the role being added. Use the Get-PSSnapin cmdlet to retrieve a list of available Windows PowerShell snap-ins. @@ -237,7 +257,6 @@ The PSSnapinName parameter specifies the Windows PowerShell snap-in that contain Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -247,13 +266,15 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Type parameter specifies the type of role entry being added. The valid values are Cmdlet, Script and ApplicationPermission. ```yaml Type: ManagementRoleEntryType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -263,6 +284,9 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -277,7 +301,6 @@ You can't use this switch with the ParentRoleEntry parameter. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -287,13 +310,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 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/Add-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderAdministrativePermission.md similarity index 87% rename from exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderAdministrativePermission.md index 153ba0c086..7cc7bfea5a 100644 --- a/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderAdministrativePermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-publicfolderadministrativepermission applicable: Exchange Server 2010 -title: Add-PublicFolderAdministrativePermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-publicfolderadministrativepermission +schema: 2.0.0 +title: Add-PublicFolderAdministrativePermission --- # Add-PublicFolderAdministrativePermission @@ -57,7 +58,7 @@ Add-PublicFolderAdministrativePermission [-Identity] - ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,15 +79,17 @@ This example denies the user Chris the ViewInformationStore permission. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. ```yaml Type: PublicFolderIdParameter -Parameter Sets: Identity, Owner +Parameter Sets: Identity, Owner, Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -95,20 +98,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: PublicFolderIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 +### -AccessRights -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -AccessRights The AccessRights parameter specifies the rights that you want to add for the administrator on the public folder. Valid values include: - None The administrator has no rights to modify public folder attributes. @@ -128,9 +121,8 @@ You can't use this parameter with the Owner parameter. ```yaml Type: MultiValuedProperty -Parameter Sets: Identity +Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -139,27 +131,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MultiValuedProperty -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 +### -Instance -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -Instance The Instance parameter specifies whether to pass an entire object to the command to be processed. It's mainly used in scripts where an entire object must be passed to the command. ```yaml Type: PublicFolderAdministrativeAceObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -169,6 +150,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010 + The Owner parameter specifies the owner of the public folder object. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -194,7 +178,6 @@ You can't use this parameter with the AccessRights or User parameters. Type: SecurityPrincipalIdParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -204,6 +187,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010 + The User parameter specifies who gets the admin permissions on the public folder. You can specify the following types of users or groups: - Mailbox users @@ -227,9 +213,8 @@ You can't use this parameter with the Owner parameter. ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: Identity +Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -238,20 +223,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -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`. @@ -261,7 +236,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -271,13 +245,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010 + The Deny switch specifies that the permissions you're adding are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -287,13 +263,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -303,6 +281,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010 + The InheritanceType parameter specifies how permissions are inherited. Valid values are: - None @@ -315,7 +296,6 @@ The InheritanceType parameter specifies how permissions are inherited. Valid val Type: ActiveDirectorySecurityInheritance Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -325,6 +305,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -338,7 +321,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -348,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderClientPermission.md similarity index 84% rename from exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderClientPermission.md index 059bc10445..9686b9e4d2 100644 --- a/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderClientPermission.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-publicfolderclientpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Add-PublicFolderClientPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-publicfolderclientpermission +schema: 2.0.0 +title: Add-PublicFolderClientPermission --- # Add-PublicFolderClientPermission ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Add-PublicFolderClientPermission cmdlet to add permissions to public folders. @@ -30,7 +31,7 @@ Add-PublicFolderClientPermission [-Identity] -AccessRi ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example adds permission for the user Chris to create items in the public fo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -59,7 +63,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AccessRights parameter specifies the rights that you want to add for the user on the public folder. You can specify individual folder permissions or roles, which are combinations of permissions. You can specify multiple permissions and roles separated by commas. @@ -102,7 +108,6 @@ In addition to access rights, you can create rights based upon roles, which incl Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The User parameter specifies the user for whom rights are being added. For the best results, we recommend using the following values: @@ -123,7 +131,6 @@ For the best results, we recommend using the following values: Type: PublicFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -142,7 +152,6 @@ 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 Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -160,7 +172,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -185,7 +199,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -195,13 +208,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-RecipientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-RecipientPermission.md similarity index 89% rename from exchange/exchange-ps/exchange/Add-RecipientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-RecipientPermission.md index 06dfc9280a..e1708d0560 100644 --- a/exchange/exchange-ps/exchange/Add-RecipientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-RecipientPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-recipientpermission applicable: Exchange Online -title: Add-RecipientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-recipientpermission +schema: 2.0.0 +title: Add-RecipientPermission --- # Add-RecipientPermission @@ -30,7 +31,7 @@ Add-RecipientPermission [-Identity] -AccessRights Applicable: Exchange Online + The Identity parameter specifies the target recipient. The user or group specified by the Trustee parameter receives SendAs permission on this recipient. You can specify any type of recipient, for example: @@ -67,7 +71,6 @@ You can use any value that uniquely identifies the recipient. For example: Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Online + The AccessRights parameter specifies the permission that you want to add for the trustee on the target recipient. The only valid value for this parameter is SendAs. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Trustee + +> Applicable: Exchange Online + The Trustee parameter specifies the user or group that receives SendAs permission on the recipient specified by the Identity parameter. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -116,7 +124,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -137,7 +147,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Add-ResubmitRequest.md b/exchange/exchange-ps/ExchangePowerShell/Add-ResubmitRequest.md similarity index 83% rename from exchange/exchange-ps/exchange/Add-ResubmitRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ResubmitRequest.md index d1801a114d..86d99f2f49 100644 --- a/exchange/exchange-ps/exchange/Add-ResubmitRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ResubmitRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-resubmitrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-ResubmitRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-resubmitrequest +schema: 2.0.0 +title: Add-ResubmitRequest --- # Add-ResubmitRequest @@ -50,7 +51,7 @@ Add-ResubmitRequest -EndTime -StartTime ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +65,9 @@ This example replays the redundant copies of messages delivered from 6:00 PM Jun ## PARAMETERS ### -EndTime + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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". @@ -74,7 +78,6 @@ The date and time specified by the EndTime parameter must be later than the date Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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". @@ -94,7 +100,6 @@ The date and time specified by the StartTime parameter must be earlier than the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -113,7 +121,6 @@ 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 Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -CorrelationId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -Destination + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Destination parameter specifies the GUID of the destination mailbox database. To find the GUID of the mailbox database, run the command: `Get-MailboxDatabase -Server | Format-List Name,GUID`. You can't use this parameter with the Recipient, ResubmitTo, or Sender parameters. @@ -147,7 +159,6 @@ You can't use this parameter with the Recipient, ResubmitTo, or Sender parameter Type: Guid Parameter Sets: MDBResubmit Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +168,15 @@ 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, ""). + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: ConditionalResubmit Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +186,9 @@ Accept wildcard characters: False ``` ### -Recipient + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Recipient parameter filters the messages to resubmit from Safety Net by the specified recipient's email address. You can't use this parameter with the Destination parameter. @@ -181,7 +197,6 @@ You can't use this parameter with the Destination parameter. Type: String Parameter Sets: ConditionalResubmit Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +206,15 @@ Accept wildcard characters: False ``` ### -ResubmitTo + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResubmitTo parameter specifies the recipient's email address for resubmitted messages that are identified by using the Recipient or Sender parameters. ```yaml Type: String Parameter Sets: ConditionalResubmit Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +224,9 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Sender parameter filters the messages to resubmit from Safety Net by the specified sender's email address. You can't use this parameter with the Destination parameter. @@ -215,7 +235,6 @@ You can't use this parameter with the Destination parameter. Type: String Parameter Sets: ConditionalResubmit Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +244,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -238,7 +260,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,13 +269,15 @@ Accept wildcard characters: False ``` ### -TestOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +287,15 @@ Accept wildcard characters: False ``` ### -UnresponsivePrimaryServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UnresponsivePrimaryServers parameter identifies the primary servers that should resubmit the messages from Safety Net as being unavailable so other servers can resubmit the messages. If the primary servers are unavailable, you can designate other servers that hold redundant copies of the messages in Safety Net to resubmit their copies of the messages. However, you must identify the unresponsive primary servers to the other servers using this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +305,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Add-RoleGroupMember.md similarity index 77% rename from exchange/exchange-ps/exchange/Add-RoleGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Add-RoleGroupMember.md index 5f64ff5636..5786755108 100644 --- a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-RoleGroupMember.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-rolegroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Add-RoleGroupMember -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-rolegroupmember +schema: 2.0.0 +title: Add-RoleGroupMember --- # Add-RoleGroupMember ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Add-RoleGroupMember cmdlet to add members to a management role group. @@ -32,13 +33,13 @@ Add-RoleGroupMember [-Identity] -Member Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group to add a member to. If the role group name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Member parameter specifies who you want to add to the role group. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -113,7 +119,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -134,7 +142,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -153,7 +163,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -171,7 +183,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -189,7 +203,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Add-ServerMonitoringOverride.md similarity index 79% rename from exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ServerMonitoringOverride.md index 97858e26e8..af9e8c7c0b 100644 --- a/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ServerMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-servermonitoringoverride -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-ServerMonitoringOverride -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-servermonitoringoverride +schema: 2.0.0 +title: Add-ServerMonitoringOverride --- # Add-ServerMonitoringOverride @@ -38,7 +39,7 @@ Add-ServerMonitoringOverride [-Identity] -ItemType Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Identity parameter specifies the identity of the monitoring item that you want to override. This parameter uses the syntax `HealthSet\MonitoringItemName[\TargetResource]`. The values are case sensitive. For example, use `AD\ActiveDirectoryConnectivityConfigDCServerReboot`, not `ad\activedirectoryconnectivityconfigdcserverreboot`. You can use Get-ServerHealth to find the correct object for the monitoring item you want to override. @@ -60,7 +64,6 @@ You can use Get-ServerHealth to find the correct object for the monitoring item Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -ApplyVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ApplyVersion parameter specifies the version of Exchange that gets the override. If you update Exchange to a newer version (for example, you apply a Cumulative Update or Service Pack), the override is no longer applied to the server. Valid input for this parameter is an Exchange version number in the format 15.01.xxxx.xxx. @@ -80,7 +86,6 @@ You can't use this parameter with the Duration parameter. Type: Version Parameter Sets: ApplyVersion Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -ItemType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ItemType parameter specifies the server item type for the property that you want to override. Valid value are: - Probe @@ -100,7 +108,6 @@ The ItemType parameter specifies the server item type for the property that you Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PropertyName parameter specifies the server property that you want to override. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PropertyValue parameter specifies the new value for the server property that you want to override. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to add the monitoring override. You can use any value that uniquely identifies the server. For example: - Name @@ -155,7 +169,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -165,6 +178,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -174,7 +190,6 @@ 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 Required: False Position: Named @@ -184,6 +199,9 @@ Accept wildcard characters: False ``` ### -Duration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Duration parameter specifies the length of time that the override is active. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -196,7 +214,6 @@ You can't use this parameter with the ApplyVersion parameter. Type: EnhancedTimeSpan Parameter Sets: Duration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +223,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md b/exchange/exchange-ps/ExchangePowerShell/Add-UnifiedGroupLinks.md similarity index 66% rename from exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md rename to exchange/exchange-ps/ExchangePowerShell/Add-UnifiedGroupLinks.md index 1004d761bf..4e1ade63bf 100644 --- a/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-UnifiedGroupLinks.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-unifiedgrouplinks applicable: Exchange Online, Exchange Online Protection -title: Add-UnifiedGroupLinks -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-unifiedgrouplinks +schema: 2.0.0 +title: Add-UnifiedGroupLinks --- # Add-UnifiedGroupLinks @@ -16,7 +17,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). @@ -32,9 +36,9 @@ Add-UnifiedGroupLinks [-Identity] -Links Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to modify. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -70,7 +77,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to modify Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -80,7 +86,10 @@ 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. + +> Applicable: Exchange Online, Exchange Online Protection + +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,13 +102,14 @@ 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[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -109,21 +119,23 @@ Accept wildcard characters: False ``` ### -LinkType + +> Applicable: Exchange Online, Exchange Online Protection + The LinkType parameter specifies the recipient's role in the Microsoft 365 Group that you want to add. Valid values are: - 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -133,6 +145,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -142,7 +157,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -152,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Add-VivaModuleFeaturePolicy.md similarity index 68% rename from exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Add-VivaModuleFeaturePolicy.md index fab2b15e16..c3ca0dd9e1 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-VivaModuleFeaturePolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/add-vivamodulefeaturepolicy applicable: Exchange Online -title: Add-VivaModuleFeaturePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-vivamodulefeaturepolicy +schema: 2.0.0 +title: Add-VivaModuleFeaturePolicy --- # Add-VivaModuleFeaturePolicy @@ -15,41 +15,24 @@ 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**: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available. - -Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature or a category 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 or category for specific users, groups, or the entire tenant. +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/category. An additional one policy per feature/category 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/category is enabled. If a user has multiple policies assigned for a feature/category (directly as a user or member of a group), the most restrictive policy applies. -- If a category is disabled by category policies, all features under the category are disabled regardless of the policies set at the feature level. -- You can only update user controls at the feature policy level, not the category policy level. -- 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. +- You can assign up to 10 policies per feature. An additional one policy per feature can be assigned to the entire tenant. +- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies. +- Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivamodulefeature) cmdlet. Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX - -### FeaturePolicy ``` Add-VivaModuleFeaturePolicy -FeatureId -IsFeatureEnabled -ModuleId -Name [-Confirm] [-Everyone] [-GroupIds ] [-IsUserControlEnabled ] - [-ResultSize ] - [-UserIds ] - [-WhatIf] - [] -``` - -### CategoryPolicy -``` -Add-VivaModuleFeaturePolicy -CategoryId -IsCategoryEnabled -Name - [-Confirm] - [-Everyone] - [-GroupIds ] + [-IsUserOptedInByDefault ] [-ResultSize ] [-UserIds ] [-WhatIf] @@ -57,9 +40,7 @@ Add-VivaModuleFeaturePolicy -CategoryId -IsCategoryEnabled -N ``` ## DESCRIPTION -Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature or category in Viva. - -Support for categories is available in version 3.5.0-Preview2 or later of the module. +Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. You need to use the Connect-ExchangeOnline cmdlet to authenticate. @@ -106,71 +87,25 @@ This example adds a policy for the Reflection feature in Viva Insights. The poli ### Example 5 ```powershell -Add-VivaModuleFeaturePolicy -CategoryId -Name DisableCategoryForAll -IsCategoryEnabled $false -Everyone -``` - -This example adds a policy for the `` category in Viva. The policy disables the category (effectively all features under the category) for all users in the organization. - -### Example 6 -```powershell -Add-VivaModuleFeaturePolicy -CategoryId -Name MultipleGroups -IsCategoryEnabled $false -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 -``` - -This example adds a policy for the `` category in Viva. The policy disables the category (effectively all features under the category) for all users in the specified groups. - -### Example 7 -```powershell -Add-VivaModuleFeaturePolicy -CategoryId -Name MultipleUsers -IsCategoryEnabled $false -UserIds user1@contoso.com,user2@contoso.com +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 `` category in Viva. The policy disables the category (effectively all features under the category) for the specified users. - -### Example 8 -```powershell -Add-VivaModuleFeaturePolicy -CategoryId -Name UsersAndGroups -IsCategoryEnabled $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 `` category in Viva. The policy disables the category (effectively all features under the category) for the specified users and group members. - -### Example 9 -```powershell -Add-VivaModuleFeaturePolicy -CategoryId -Name "Disable Category For All" -IsCategoryEnabled $false -Everyone -``` - -This example adds a policy for the `` category in Viva where the policy name is with spaces. The policy disables the category (effectively all features under the category) for all users in the organization. +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 -### -CategoryId -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. - -The CategoryId parameter specifies the Viva category that you want to add the policy for. - -```yaml -Type: String -Parameter Sets: CategoryPolicy -Aliases: -Applicable: Exchange Online +### -FeatureId -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for. To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -179,30 +114,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsCategoryEnabled -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. - -The IsCategoryEnabled parameter specifies whether or not the category is enabled by the policy. Valid values are: - -- $true: The category is enabled by the policy. -- $false: The category is not enabled by the policy. +### -IsFeatureEnabled -```yaml -Type: Boolean -Parameter Sets: CategoryPolicy -Aliases: -Applicable: Exchange Online +> Applicable: Exchange Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsFeatureEnabled The IsFeatureEnabled parameter specifies whether or not the feature is enabled by the policy. Valid values are: - $true: The feature is enabled by the policy. @@ -210,9 +125,8 @@ The IsFeatureEnabled parameter specifies whether or not the feature is enabled b ```yaml Type: Boolean -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -222,13 +136,15 @@ Accept wildcard characters: False ``` ### -ModuleId + +> Applicable: Exchange Online + The ModuleId parameter specifies the Viva module that you want to add the feature policy for. ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -238,6 +154,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the name of the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). Valid characters are English letters, numbers, commas, periods, and spaces. @@ -246,7 +165,6 @@ Valid characters are English letters, numbers, commas, periods, and spaces. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -256,6 +174,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -267,7 +188,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -277,6 +197,9 @@ Accept wildcard characters: False ``` ### -Everyone + +> Applicable: Exchange Online + The Everyone switch specifies that the policy applies to all users in the organization. You don't need to specify a value with this switch. Don't use this switch with the GroupIds or UserIds parameters. @@ -285,7 +208,6 @@ Don't use this switch with the GroupIds or UserIds parameters. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -295,6 +217,9 @@ Accept wildcard characters: False ``` ### -GroupIds + +> Applicable: Exchange Online + 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.). @@ -307,7 +232,6 @@ To have the policy apply to all users in the organization, use the Everyone swit Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -317,6 +241,9 @@ Accept wildcard characters: False ``` ### -IsUserControlEnabled + +> Applicable: Exchange Online + 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: @@ -328,9 +255,35 @@ Only features that allow admins to enable and disable user controls by policy ca ```yaml Type: Boolean -Parameter Sets: FeaturePolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUserOptedInByDefault + +> Applicable: Exchange Online + +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 @@ -340,13 +293,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -356,6 +311,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Exchange Online + The UserIds parameter specifies the user principal names (UPNs) of the users that the policy applies to. You can enter multiple values separated by commas. You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). @@ -366,7 +324,6 @@ To have the policy apply to all users in the organization, use the Everyone swit Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -376,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/ExchangePowerShell/Add-VivaOrgInsightsDelegatedRole.md similarity index 91% rename from exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md rename to exchange/exchange-ps/ExchangePowerShell/Add-VivaOrgInsightsDelegatedRole.md index 0cd646edd6..3a6604d12d 100644 --- a/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-VivaOrgInsightsDelegatedRole.md @@ -1,18 +1,18 @@ --- -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 +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-vivaorginsightsdelegatedrole +schema: 2.0.0 +title: Add-VivaOrgInsightsDelegatedRole --- # Add-VivaOrgInsightsDelegatedRole ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module v3.7.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). +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). @@ -47,6 +47,9 @@ This example adds the organization insights viewing capability of the specified ## PARAMETERS ### -Delegate + +> Applicable: Exchange Online + 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. @@ -55,7 +58,6 @@ A valid value for this parameter is the Microsoft Entra ObjectId value of the de Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -Delegator + +> Applicable: Exchange Online + 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. @@ -73,7 +78,6 @@ A valid value for this parameter is the ObjectID value of the delegator account. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -83,13 +87,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/ExchangePowerShell/Add-eDiscoveryCaseAdmin.md similarity index 81% rename from exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md rename to exchange/exchange-ps/ExchangePowerShell/Add-eDiscoveryCaseAdmin.md index 2fffa65d08..c0127b3b6e 100644 --- a/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-eDiscoveryCaseAdmin.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-ediscoverycaseadmin applicable: Security & Compliance -title: Add-eDiscoveryCaseAdmin -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-ediscoverycaseadmin +schema: 2.0.0 +title: Add-eDiscoveryCaseAdmin --- # Add-eDiscoveryCaseAdmin @@ -28,7 +29,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. To make a user an eDiscovery Administrator, add the user to the eDiscovery Manager role group. For instructions, see [Add users or groups to a Microsoft Purview built-in role group](https://learn.microsoft.com/purview/purview-compliance-portal-permissions#add-users-or-groups-to-a-microsoft-purview-built-in-role-group). You can then use this cmdlet to manage the list of eDiscover Administrators. +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 ""`. + +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). @@ -44,6 +47,9 @@ This example adds an eDiscovery Administrator. ## PARAMETERS ### -User + +> Applicable: Security & Compliance + The User parameter specifies the user that you want to add to the list of eDiscovery Administrators. You can use any value that uniquely identifies the user. For example: - Name @@ -55,7 +61,6 @@ The User parameter specifies the user that you want to add to the list of eDisco Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -65,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -74,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/ExchangePowerShell/Check-PurviewConfig.md b/exchange/exchange-ps/ExchangePowerShell/Check-PurviewConfig.md new file mode 100644 index 0000000000..27692105c9 --- /dev/null +++ b/exchange/exchange-ps/ExchangePowerShell/Check-PurviewConfig.md @@ -0,0 +1,401 @@ +--- +applicable: Security & Compliance +author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/check-purviewconfig +schema: 2.0.0 +title: Check-PurviewConfig +--- + +# Check-PurviewConfig + +## 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 Check-PurviewConfig cmdlet to validate and review your organization's configuration settings in Microsoft Purview. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Check-PurviewConfig + [[-Component] ] + [[-DateTimeUTC] ] + [[-File] ] + [[-IncidentId] ] + [[-ItemId] ] + [[-MessageId] ] + [[-RecordId] ] + [[-RuleName] ] + [[-TestCases] ] + [[-Theme] ] + [[-UserPrincipalName] ] + [[-Workload] ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Check-PurviewConfig cmdlet to run Microsoft Information Protection diagnostic test cases for your organization and check the results. + +Admins with the Organization Configuration role assigned have the necessary permissions to run this cmdlet. + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Check-PurviewConfig +``` + +This example runs all Microsoft Information Protection test cases that don't require additional parameters. + +### Example 2 +```powershell +Check-PurviewConfig -Component Encryption +``` + +This example runs all test cases for the Encryption component. + +### Example 3 +```powershell +Check-PurviewConfig -Component Encryption -Theme LicenseAvailability +``` + +This example runs all cases for the LicenseAvailability theme in the Encryption component. + +### Example 4 +```powershell +Check-PurviewConfig -TestCases "MipLabels_EnabledEntities_ScopedLabels" -UserPrincipalName sathya@contoso.onmicrosoft.com +``` + +This example runs the test case named MipLabels_EnabledEntities_ScopedLabels, which requires a UserPrincipalName value. + +### Example 5 +```powershell +Check-PurviewConfig -TestCases "MipLabels_EnabledEntities_ScopedLabels","MipLabels_EnabledEntities_CompareSyncStatus" -UserPrincipalName sathya@contoso.onmicrosoft.com +``` + +This example runs the specified test cases. A UserPrincipalName value is required for the MipLabels_EnabledEntities_ScopedLabels test case. + +## PARAMETERS + +### -Component + +> Applicable: Security & Compliance + +The Component parameter specifies the component to analyze in the test case. Valid values are: + +- DLP +- DLPAlerts +- Encryption +- MIPLabels + +```yaml +Type: PurviewConfigComponent +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Security & Compliance + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DateTimeUTC + +> Applicable: Security & Compliance + +The DateTimeUTC specifies the date-time of the test case in Coordinated Universal Time (UTC). For example, "2025-06-05 14:30:00". + +This parameter is required for the following TestCases values: + +- DlpAlerts_CheckAlertsCreated +- DlpAlerts_FindAlertForActivity + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File + +> Applicable: Security & Compliance + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId + +> Applicable: Security & Compliance + +The IncidentId parameter specifies the incident to analyze in the test case. + +You can find a value for this parameter in audit log searches filtered by the operation DLPRuleMatch in the IncidentId property. + +This parameter is required for the TestCases value DlpAlerts_FindAlertForActivity. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemId + +> Applicable: Security & Compliance + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId + +> Applicable: Security & Compliance + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordId + +> Applicable: Security & Compliance + +The RuleName parameter specifies the record to analyze in the test case. + +You can find a value for this parameter in Activity Explorer filtered by the activity type DLPRuleMatch in the RecordId property. + +This parameter is optional with the TestCases value DlpAlerts_FindAlertForActivity. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleName + +> Applicable: Security & Compliance + +The RuleName parameter specifies the DLP rule to analyze in the test case. + +This parameter is optional with the TestCases value DlpAlerts_CheckAlertsCreated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestCases + +> Applicable: Security & Compliance + +The TestCases parameter specifies the name of the test case to analyze. The available test cases and their required parameters are described in the following list: + +- **Encryption_EvaluationDetails**: Validates email encryption evaluation details. No other parameters are required. +- **Encryption_LicenseAvailability**: Checks email encryption configurations. No other parameters are required. +- **MipLabels_EnabledEntities_ScopedLabels**: Shows the labels and label settings that apply to a user. Requires the UserPrincipalName parameter. +- **MipLabels_LicenseAvailability**: Verifies whether the MIP Label feature is enabled. No other parameters required. +- **DlpAlerts_CheckAlertsCreated**: Validates the DLP rule configuration for alerts created in last 5 days. Requires the DateTimeUTC parameter. The RuleName parameter is optional. +- **DlpAlerts_FindAlertForActivity**: Identifies missing alerts for an activity. Requires the DateTimeUTC parameter. The IncidentId and RecordId parameters are optional. +- **DLP_ScopedEntities**: Returns all DLP policies and rules that apply to a user or a site. Requires the Workload parameter. The SiteUrl and UserPrincipalName parameters are optional. + +You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Theme + +> Applicable: Security & Compliance + +The Theme parameter filters specifies the them to analyze in the test case. Valid values are: + +- EnabledEntities +- EvaluationDetails +- LicenseAvailability + +```yaml +Type: PurviewConfigTheme +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName + +> Applicable: Security & Compliance + +The UserPrincipalName parameter specifies the user account to analyze in the test case (for example, `sathya@contoso.onmicrosoft.com`). + +- Required for the TestCases value MipLabels_EnabledEntities_ScopedLabels. +- Optional for the TestCases value DLP_ScopedEntities. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Security & Compliance + +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workload + +> Applicable: Security & Compliance + +The Workload parameter specifies the service workload. Value values are: + +- EndpointDevices +- Exchange +- OneDriveForBusiness +- SharePoint +- Teams + +This parameter is required for the TestCases value DLP_ScopedEntities. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Clean-MailboxDatabase.md similarity index 88% rename from exchange/exchange-ps/exchange/Clean-MailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Clean-MailboxDatabase.md index 9e3829eb4e..7908ebabdd 100644 --- a/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Clean-MailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/clean-mailboxdatabase applicable: Exchange Server 2010 -title: Clean-MailboxDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/clean-mailboxdatabase +schema: 2.0.0 +title: Clean-MailboxDatabase --- # Clean-MailboxDatabase @@ -33,9 +34,9 @@ A connected mailbox has two parts: the mailbox object in the Exchange store and If you want to reconnect a disconnected mailbox to an Active Directory user account, use the Connect-Mailbox cmdlet. -Under normal circumstances, it isn't necessary to run the Clean-MailboxDatabase cmdlet because a mailbox is marked as disconnected immediately after the Disable-Mailbox or Remove-Mailbox command completes. If you used the Disable-Mailbox cmdlet or the Remove-Mailbox cmdlet while the Microsoft Exchange Information Store service was stopped, or if a mailbox was disabled by an external means other than the Disable-Mailbox cmdlet or Remove-Mailbox cmdlet, you may want to use the Clean-MailboxDatabase cmdlet to scan for disconnected mailboxes. +Under normal circumstances, it isn't necessary to run the Clean-MailboxDatabase cmdlet because a mailbox is marked as disconnected immediately after the Disable-Mailbox or Remove-Mailbox command completes. If you used the Disable-Mailbox cmdlet or the Remove-Mailbox cmdlet while the Microsoft Exchange Information Store service was stopped, or if a mailbox was disabled by an external means other than the Disable-Mailbox cmdlet or Remove-Mailbox cmdlet, you might want to use the Clean-MailboxDatabase cmdlet to scan for disconnected mailboxes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example cleans the mailbox database MBD01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the mailbox database that you want to update. You can use any value that uniquely identifies the database. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the mailbox database that you want to update. Y Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -96,7 +104,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md b/exchange/exchange-ps/ExchangePowerShell/Clear-ActiveSyncDevice.md similarity index 80% rename from exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Clear-ActiveSyncDevice.md index f729195ad5..9e7abc5201 100644 --- a/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Clear-ActiveSyncDevice.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/clear-activesyncdevice -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Clear-ActiveSyncDevice -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/clear-activesyncdevice +schema: 2.0.0 +title: Clear-ActiveSyncDevice --- # Clear-ActiveSyncDevice ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Clear-ActiveSyncDevice cmdlet to delete all data from a mobile device. @@ -37,7 +38,7 @@ The Clear-ActiveSyncDevice cmdlet deletes all user data from a mobile device the After you run this cmdlet, you receive a warning that states: "This command will force all the data on the device to be permanently deleted. Do you want to continue?" You must respond to the warning for the cmdlet to run on the mobile phone. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,13 +66,15 @@ This example cancels a previously sent Clear-ActiveSyncDevice command request fo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the device that you want to reset. ```yaml Type: ActiveSyncDeviceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -Cancel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Cancel switch specifies whether to issue a cancellation request for a pending remote device wipe. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -108,7 +116,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -126,7 +136,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Clear-MobileDevice.md b/exchange/exchange-ps/ExchangePowerShell/Clear-MobileDevice.md similarity index 83% rename from exchange/exchange-ps/exchange/Clear-MobileDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Clear-MobileDevice.md index 9a5eda7425..e6ee9c56d3 100644 --- a/exchange/exchange-ps/exchange/Clear-MobileDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Clear-MobileDevice.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/clear-mobiledevice -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Clear-MobileDevice -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/clear-mobiledevice +schema: 2.0.0 +title: Clear-MobileDevice --- # Clear-MobileDevice ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Clear-MobileDevice cmdlet to delete all data from a mobile phone. This action is often called a remote device wipe. @@ -36,7 +37,7 @@ The Clear-MobileDevice cmdlet deletes all user data from a mobile device the nex After you run this cmdlet, you receive a warning that states: "This command will force all the data on the device to be permanently deleted. Do you want to continue?" You must respond to the warning for the cmdlet to run on the mobile phone. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +65,9 @@ This example cancels a previously sent Clear-MobileDevice command request for th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mobile device that you want to reset. You can use the following values that uniquely identifies the mobile device: - Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) @@ -74,7 +78,6 @@ The Identity parameter specifies the mobile device that you want to reset. You c Type: MobileDeviceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -AccountOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AccountOnly switch specifies whether to perform an account-only remote device wipe where only Exchange mailbox data is removed from the device. You don't need to specify a value with this switch. You don't need to use this switch for the DeviceType value Outlook, because an account-only remote device wipe is the only type of wipe that's used on Outlook devices. @@ -92,7 +98,6 @@ You don't need to use this switch for the DeviceType value Outlook, because an a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -Cancel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Cancel switch specifies whether to issue a cancellation request for a pending remote device wipe. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -129,7 +139,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -147,7 +159,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +168,15 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -173,13 +186,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md b/exchange/exchange-ps/ExchangePowerShell/Clear-TextMessagingAccount.md similarity index 80% rename from exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md rename to exchange/exchange-ps/ExchangePowerShell/Clear-TextMessagingAccount.md index 0cfbdb03d1..7e3d2fdad5 100644 --- a/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md +++ b/exchange/exchange-ps/ExchangePowerShell/Clear-TextMessagingAccount.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/clear-textmessagingaccount -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Clear-TextMessagingAccount -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/clear-textmessagingaccount +schema: 2.0.0 +title: Clear-TextMessagingAccount --- # Clear-TextMessagingAccount ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. The Clear-TextMessagingAccount cmdlet allows a user to remove the text messaging settings from their own mailbox. An administrator can't use this cmdlet to remove the text messaging settings from another user's mailbox. @@ -32,7 +33,7 @@ Clear-TextMessagingAccount [-Identity] ## DESCRIPTION The Clear-TextMessagingAccount cmdlet clears all of a user's text messaging settings, including communication and notification settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example clears the text messaging account settings and notification setting ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the target mailbox. You can any value that uniquely identifies the mailbox. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the target mailbox. You can any value that uniq Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -82,7 +88,6 @@ 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 Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -100,7 +108,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -121,7 +131,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md b/exchange/exchange-ps/ExchangePowerShell/Compare-TextMessagingVerificationCode.md similarity index 80% rename from exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md rename to exchange/exchange-ps/ExchangePowerShell/Compare-TextMessagingVerificationCode.md index c536c48908..e1af49693c 100644 --- a/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md +++ b/exchange/exchange-ps/ExchangePowerShell/Compare-TextMessagingVerificationCode.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/compare-textmessagingverificationcode -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Compare-TextMessagingVerificationCode -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/compare-textmessagingverificationcode +schema: 2.0.0 +title: Compare-TextMessagingVerificationCode --- # Compare-TextMessagingVerificationCode ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Compare-TextMessagingVerificationCode cmdlet to verify the text messaging verification code that the user specified as part of configuring text message notifications on the mailbox. @@ -33,7 +34,7 @@ The Compare-TextMessagingVerificationCode cmdlet returns the value true if the c When text messaging notifications are enabled on a mailbox, you can configure calendar notifications, voice mail notifications, and email notifications using an inbox rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,6 +62,9 @@ This example compares the verification code 111555 to the code sent to Tony Smit ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox where you are trying to enable text messaging notifications. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -78,7 +82,6 @@ The Identity parameter specifies the mailbox where you are trying to enable text Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -VerificationCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The VerificationCode parameter contains the verification code that the user specified. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -113,7 +121,6 @@ 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 Required: False Position: Named @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -131,7 +141,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,13 +150,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Complete-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Complete-MigrationBatch.md similarity index 82% rename from exchange/exchange-ps/exchange/Complete-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Complete-MigrationBatch.md index 922eeca5b8..5a40710740 100644 --- a/exchange/exchange-ps/exchange/Complete-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Complete-MigrationBatch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/complete-migrationbatch -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Complete-MigrationBatch -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/complete-migrationbatch +schema: 2.0.0 +title: Complete-MigrationBatch --- # Complete-MigrationBatch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Complete-MigrationBatch cmdlet to finalize a migration batch for a local move, cross-forest move, or remote move migration that has successfully finished initial synchronization. @@ -39,13 +40,13 @@ After a migration batch for a local or cross-forest move has successfully run an - Configures the user's Microsoft Outlook profile to point to the new target domain. - Converts the source mailbox to a mail-enabled user in the source domain. -In the cloud-based service, this cmdlet sets the value of CompleteAfter to the current time. It is important to remember that any CompleteAfter setting that has been applied to the individual users within the batch will override the setting on the batch, so the completion for some users may be delayed until their configured time. +In the cloud-based service, this cmdlet sets the value of CompleteAfter to the current time. It is important to remember that any CompleteAfter setting applied to the individual users within the batch overrides the setting on the batch, so the completion for some users might be delayed until their configured time. When the finalization process is complete, you can remove the batch by using the Remove-MigrationBatch cmdlet. If a migration batch has a status of Completed with Errors, you can re-attempt to finalize the failed users. In Exchange Online, use the Start-MigrationBatch cmdlet to retry migration for failed users. In Exchange 2013 or Exchange 2016, use the Complete-MigrationBatch to retry these failed users. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,13 +60,15 @@ This example completes the migration batch LocalMove1 and sends a notification e ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the migration batch that you want to complete. The value for this parameter is specified by the Name parameter for the New-MigrationBatch cmdlet. Use the Get-MigrationBatch cmdlet to determine the value of this parameter for the migration batch. ```yaml Type: MigrationBatchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -CompletePublicFolderMigrationWithDataLoss + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -83,7 +89,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -104,7 +112,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -122,7 +132,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -NotificationEmails + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The NotificationEmails parameter specifies one or more email addresses that status reports are sent to after the migration batch is completed. You can specify multiple email addresses separated by commas. @@ -142,7 +154,6 @@ If you don't use this parameter, the final status report is sent to the administ Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -160,7 +174,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -SyncAndComplete + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SyncAndComplete switch specifies whether to trigger a synchronization immediately followed by a completion of the migration batch if the synchronization was successful. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/ExchangePowerShell/Connect-ExchangeOnline.md similarity index 91% rename from exchange/exchange-ps/exchange/Connect-ExchangeOnline.md rename to exchange/exchange-ps/ExchangePowerShell/Connect-ExchangeOnline.md index aa3d145279..b424b12ca1 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/ExchangePowerShell/Connect-ExchangeOnline.md @@ -1,13 +1,13 @@ --- -external help file: ExchangeOnlineManagement-help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/connect-exchangeonline applicable: Exchange Online -title: Connect-ExchangeOnline -schema: 2.0.0 author: chrisda +external help file: ExchangeOnlineManagement-help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/connect-exchangeonline +schema: 2.0.0 +title: Connect-ExchangeOnline --- # Connect-ExchangeOnline @@ -15,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to connect to Exchange Online PowerShell or standalone Exchange Online Protection PowerShell using modern authentication. This cmdlet works for accounts with or without multi-factor authentication (MFA). +Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to use modern authentication to connect to Exchange Online PowerShell or Exchange Online Protection PowerShell for cloud protection of on-premises email environments. This cmdlet works for accounts with or without multi-factor authentication (MFA). -To connect to Security & Compliance PowerShell, use the [Connect-IPPSSession](https://learn.microsoft.com/powershell/module/exchange/connect-ippssession) cmdlet. +To connect to Security & Compliance PowerShell, use the [Connect-IPPSSession](https://learn.microsoft.com/powershell/module/exchangepowershell/connect-ippssession) cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -42,6 +42,7 @@ Connect-ExchangeOnline [-CertificateThumbprint ] [-Credential ] [-Device] + [-DisableWAM] [-EnableErrorReporting] [-InlineCredential] [-LoadCmdletHelp] @@ -110,6 +111,9 @@ In PowerShell 7.0.3 or later using version 2.0.4 or later of the module, this ex ## PARAMETERS ### -ConnectionUri + +> Applicable: Exchange Online + **Note**: If you use the ExchangeEnvironmentName parameter, you don't need to use the AzureADAuthorizationEndpointUri or ConnectionUri parameters. The ConnectionUri parameter specifies the connection endpoint for the PowerShell session. The following Exchange Online PowerShell environments and related values are supported: @@ -124,7 +128,6 @@ The ConnectionUri parameter specifies the connection endpoint for the PowerShell Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -134,6 +137,9 @@ Accept wildcard characters: False ``` ### -AzureADAuthorizationEndpointUri + +> Applicable: Exchange Online + **Note**: If you use the ExchangeEnvironmentName parameter, you don't need to use the AzureADAuthorizationEndpointUri or ConnectionUri parameters. The AzureADAuthorizationEndpointUri parameter specifies the Microsoft Entra Authorization endpoint that can issue OAuth2 access tokens. The following Exchange Online PowerShell environments and related values are supported: @@ -150,7 +156,6 @@ If you use the UserPrincipalName parameter, you don't need to use the AzureADAut Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -160,6 +165,9 @@ Accept wildcard characters: False ``` ### -ExchangeEnvironmentName + +> Applicable: Exchange Online + The ExchangeEnvironmentName specifies the Exchange Online environment and eliminates the need to use the AzureADAuthorizationEndpointUri and ConnectionUri parameters. The following Exchange Online PowerShell environments are supported: - Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `O365Default`, but that's also the default value, so you don't need to use this parameter. @@ -172,7 +180,6 @@ The ExchangeEnvironmentName specifies the Exchange Online environment and elimin Type: ExchangeEnvironment Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 @@ -182,6 +189,9 @@ Accept wildcard characters: False ``` ### -PSSessionOption + +> Applicable: Exchange Online + **Note**: This parameter doesn't work in REST API connections. The PSSessionOption parameter specifies the PowerShell session options to use in your connection to Exchange Online. This parameter works only if you also use the UseRPSSession switch in the same command. @@ -192,7 +202,6 @@ Store the output of the [New-PSSessionOption](https://learn.microsoft.com/powers Type: PSSessionOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 3 @@ -202,6 +211,9 @@ Accept wildcard characters: False ``` ### -DelegatedOrganization + +> Applicable: Exchange Online + The DelegatedOrganization parameter specifies the customer organization that you want to manage. A valid value for this parameter is the primary .onmicrosoft.com domain or tenant ID of the customer organization. This parameter works only if the customer organization has agreed to your delegated management via the CSP program. @@ -212,7 +224,6 @@ After you successfully authenticate, the cmdlets in this session are mapped to t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 4 @@ -222,6 +233,9 @@ Accept wildcard characters: False ``` ### -Prefix + +> Applicable: Exchange Online + The Prefix parameter specifies a text value to add to the names of Exchange Online PowerShell cmdlets when you connect. For example, Get-InboundConnector becomes Get-ContosoInboundConnector when you use the value Contoso for this parameter. - The Prefix value can't contain spaces or special characters like underscores or asterisks. @@ -232,7 +246,6 @@ The Prefix parameter specifies a text value to add to the names of Exchange Onli Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 5 @@ -242,13 +255,15 @@ Accept wildcard characters: False ``` ### -CommandName + +> Applicable: Exchange Online + The CommandName parameter specifies the comma separated list of commands to import into the session. Use this parameter for applications or scripts that use a specific set of cmdlets. Reducing the number of cmdlets in the session helps improve performance and reduces the memory footprint of the application or script. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 6 @@ -258,13 +273,15 @@ Accept wildcard characters: False ``` ### -FormatTypeName + +> Applicable: Exchange Online + The FormatTypeName parameter specifies the output format of the cmdlet. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 7 @@ -274,17 +291,19 @@ Accept wildcard characters: False ``` ### -AccessToken + +> Applicable: Exchange Online + **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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -294,6 +313,9 @@ Accept wildcard characters: False ``` ### -AppId + +> Applicable: Exchange Online + The AppId parameter specifies the application ID of the service principal that's used in certificate based authentication (CBA). A valid value is the GUID of the application ID (service principal). For example, `36ee4c6c-0812-40a2-b820-b22ebd02bce3`. For more information, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). @@ -302,7 +324,6 @@ For more information, see [App-only authentication for unattended scripts in the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -312,13 +333,15 @@ Accept wildcard characters: False ``` ### -BypassMailboxAnchoring + +> Applicable: Exchange Online + The BypassMailboxAnchoring switch bypasses the use of the mailbox anchoring hint. 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 @@ -328,6 +351,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: Exchange Online + The Certificate parameter specifies the certificate that's used for certificate-based authentication (CBA). A valid value is the X509Certificate2 object value of the certificate. Don't use this parameter with the CertificateFilePath or CertificateThumbprint parameters. @@ -338,7 +364,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: X509Certificate2 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -348,6 +373,9 @@ Accept wildcard characters: False ``` ### -CertificateFilePath + +> Applicable: Exchange Online + The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter. Don't use this parameter with the Certificate or CertificateThumbprint parameters. @@ -358,7 +386,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -368,6 +395,9 @@ Accept wildcard characters: False ``` ### -CertificatePassword + +> Applicable: Exchange Online + The CertificatePassword parameter specifies the password that's required to open the certificate file when you use the CertificateFilePath parameter to identify the certificate that's used for CBA. You can use the following methods as a value for this parameter: @@ -384,7 +414,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -394,6 +423,9 @@ Accept wildcard characters: False ``` ### -CertificateThumbprint + +> Applicable: Exchange Online + The CertificateThumbprint parameter specifies the certificate that's used for CBA. A valid value is the thumbprint value of the certificate. For example, `83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1`. Don't use this parameter with the Certificate or CertificateFilePath parameters. @@ -406,7 +438,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -416,6 +447,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Online + The Credential parameter specifies the username and password that's used to connect to Exchange Online PowerShell. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. Don't use this parameter for accounts that use multi-factor authentication (MFA). Before you run the Connect-ExchangeOnline command, store the username and password in a variable (for example, `$UserCredential = Get-Credential`). Then, use the variable name (`$UserCredential`) for this parameter. @@ -428,7 +462,6 @@ To specify the password for a certificate file, don't use this parameter; use th Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -438,6 +471,9 @@ Accept wildcard characters: False ``` ### -Device + +> Applicable: Exchange Online + **Note**: This parameter is available in version 2.0.4 or later of the module, and only in PowerShell 7. The Device switch is typically used on computers without web browsers. You don't need to specify a value with this switch. @@ -450,7 +486,28 @@ If your login was successful, the PowerShell connection continues. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableWAM + +> Applicable: Exchange Online + +**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: Required: False Position: Named @@ -460,13 +517,15 @@ Accept wildcard characters: False ``` ### -EnableErrorReporting + +> Applicable: Exchange Online + The EnableErrorReporting switch specifies whether to enable error reporting. 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 @@ -476,6 +535,9 @@ Accept wildcard characters: False ``` ### -InlineCredential + +> Applicable: Exchange Online + **Note**: This parameter is available in version 2.0.4 or later of the module, and only in PowerShell 7. The InlineCredential switch specifies whether to pass credentials directly in the Windows PowerShell window. You don't need to specify a value with this switch. @@ -488,7 +550,6 @@ This switch does not work with accounts that use MFA. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -498,6 +559,9 @@ Accept wildcard characters: False ``` ### -LoadCmdletHelp + +> Applicable: Exchange Online + **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. @@ -510,7 +574,6 @@ Starting in v3.7.0-Preview1, help files for the command line aren't downloaded b Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -520,6 +583,9 @@ Accept wildcard characters: False ``` ### -LogDirectoryPath + +> Applicable: Exchange Online + The LogDirectoryPath parameter specifies the location of the log files. The default location is `%TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv`. If you specify a custom location and filename that contains spaces, enclose the value in quotation marks ("). @@ -528,7 +594,6 @@ If you specify a custom location and filename that contains spaces, enclose the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -538,13 +603,15 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Online + The LogLevel parameter specifies the logging level. Valid values are Default and All. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -554,6 +621,9 @@ Accept wildcard characters: False ``` ### -ManagedIdentity + +> Applicable: Exchange Online + The ManagedIdentity switch specifies that you're using managed identity to connect. You don't need to specify a value with this switch. Managed identity connections are currently supported for the following types of Azure resources: @@ -573,7 +643,6 @@ For more information about connecting with managed identity, see [Use Azure mana Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -583,6 +652,9 @@ Accept wildcard characters: False ``` ### -ManagedIdentityAccountId + +> Applicable: Exchange Online + The ManagedIdentityAccountId parameter specifies the user-assigned managed identity that you're using to connect. A valid value for this parameter is the application ID (GUID) of the service principal that corresponds to the user-assigned managed identity in Azure. You must use this parameter with the Organization parameter and the ManagedIdentity switch. @@ -593,7 +665,6 @@ For more information about connecting with managed identity, see [Use Azure mana Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -603,6 +674,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + 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). @@ -613,7 +687,6 @@ For more information about connecting with managed identity, see [Use Azure mana Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -623,13 +696,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 1000. The default value is 1000. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -639,6 +714,9 @@ Accept wildcard characters: False ``` ### -ShowBanner + +> Applicable: Exchange Online + The ShowBanner switch shows or hides the banner message that's displayed when you run Connect-ExchangeOnline. You don't need to specify a value with this switch. - To show the banner, you don't need to use this switch (the banner is displayed by default). @@ -648,7 +726,6 @@ The ShowBanner switch shows or hides the banner message that's displayed when yo Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -658,16 +735,18 @@ Accept wildcard characters: False ``` ### -ShowProgress + +> Applicable: Exchange Online + The ShowProgress parameter specifies whether to show or hide the progress bar of imported cmdlets when you connect. Valid values are: -- $true: The progress bar is displayed. This is the default value. +- $true: The progress bar is displayed. This value is the default. - $false: Currently, this value has no effect. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -677,6 +756,9 @@ Accept wildcard characters: False ``` ### -SigningCertificate + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.2.0 or later of the module. The SigningCertificate parameter specifies the client certificate that's used to sign the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that Connect-ExchangeOnline creates. @@ -689,7 +771,6 @@ To find the certificate, use the Get-PfxCertificate cmdlet in the Microsoft.Powe Type: X509Certificate2 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -699,9 +780,12 @@ Accept wildcard characters: False ``` ### -SkipLoadingCmdletHelp + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.3.0 or later of the module. -In version 3.7.0-Preview1 or later, this parameter is replaced by the LoadCmdletHelp parameter. The SkipLoadingCmdletHelp parameter is no longer required and no longer does anything, because cmdlet help files are no longer downloaded by default. Eventually, this parameter will be retired, so remove it from any scripts. +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. 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. @@ -713,7 +797,6 @@ This switch doesn't work with the UseRPSSession switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -723,9 +806,12 @@ Accept wildcard characters: False ``` ### -SkipLoadingFormatData + +> Applicable: Exchange Online + 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. +When you use this switch, the output of any Exchange cmdlet is unformatted. Use this switch to avoid errors when connecting to Exchange Online PowerShell from within a Windows service or the Windows PowerShell SDK. @@ -735,7 +821,6 @@ This switch doesn't work with the UseRPSSession switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -745,10 +830,13 @@ Accept wildcard characters: False ``` ### -TrackPerformance + +> Applicable: Exchange Online + The TrackPerformance parameter measures additional events (for example, CPU load and memory consumed). Valid values are: - $true: Performance tracking is enabled. -- $false: Performance tracking is disabled. This is the default value. +- $false: Performance tracking is disabled. This value is the default. This parameter works only when logging is enabled. @@ -756,7 +844,6 @@ This parameter works only when logging is enabled. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -766,16 +853,18 @@ Accept wildcard characters: False ``` ### -UseMultithreading + +> Applicable: Exchange Online + The UseMultithreading parameter specifies whether to disable or enable multi-threading in the Exchange Online PowerShell module. Valid values are: -- $true: Enable multi-threading. This is the default value. -- $false: Disable multi-threading. This value will degrade the performance of the nine exclusive **Get-EXO\*** cmdlets in the module. +- $true: Enable multi-threading. This value is the default. +- $false: Disable multi-threading. This value degrades the performance of the nine exclusive **Get-EXO\*** cmdlets in the module. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -785,6 +874,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + 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). @@ -793,7 +885,6 @@ If you use the UserPrincipalName parameter, you don't need to use the AzureADAut Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -803,6 +894,9 @@ Accept wildcard characters: False ``` ### -UseRPSSession + +> Applicable: Exchange Online + **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. @@ -815,7 +909,6 @@ If you don't use this switch, REST API mode is used for the connection, so Basic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/ExchangePowerShell/Connect-IPPSSession.md similarity index 93% rename from exchange/exchange-ps/exchange/Connect-IPPSSession.md rename to exchange/exchange-ps/ExchangePowerShell/Connect-IPPSSession.md index 728ed8e33f..1fdc9b65e9 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/ExchangePowerShell/Connect-IPPSSession.md @@ -1,13 +1,13 @@ --- -external help file: ExchangeOnlineManagement-help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/connect-ippssession applicable: Exchange Online -title: Connect-IPPSSession -schema: 2.0.0 author: chrisda +external help file: ExchangeOnlineManagement-help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/connect-ippssession +schema: 2.0.0 +title: Connect-IPPSSession --- # Connect-IPPSSession @@ -32,6 +32,7 @@ Connect-IPPSSession [[-Prefix] ] [[-CommandName] ] [[-FormatTypeName] ] + [-AccessToken ] [-AppId ] [-BypassMailboxAnchoring] [-Certificate ] @@ -81,6 +82,9 @@ This example connects to Security & Compliance PowerShell in an unattended scrip ## PARAMETERS ### -ConnectionUri + +> Applicable: Exchange Online + The ConnectionUri parameter specifies the connection endpoint for the PowerShell session. The following PowerShell environments and related values are supported: - Security & Compliance PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://ps.compliance.protection.outlook.com/powershell-liveid/`, but that's also the default value, so you don't need to use this parameter. @@ -92,7 +96,6 @@ The ConnectionUri parameter specifies the connection endpoint for the PowerShell Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -AzureADAuthorizationEndpointUri + +> Applicable: Exchange Online + The AzureADAuthorizationEndpointUri parameter specifies the Microsoft Entra Authorization endpoint that can issue OAuth2 access tokens. The following PowerShell environments and related values are supported: - Security & Compliance PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://login.microsoftonline.com/common`, but that's also the default value, so you don't need to use this parameter. @@ -114,7 +120,6 @@ If you use the UserPrincipalName parameter, you don't need to use the AzureADAut Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -DelegatedOrganization + +> Applicable: Exchange Online + The DelegatedOrganization parameter specifies the customer organization that you want to manage (for example, contosoelectronics.onmicrosoft.com). This parameter works only if the customer organization has agreed to your delegated management via the CSP program. After you successfully authenticate, the cmdlets in this session are mapped to the customer organization, and all operations in this session are done on the customer organization. @@ -137,7 +145,6 @@ After you successfully authenticate, the cmdlets in this session are mapped to t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -PSSessionOption + +> Applicable: Exchange Online + **Note**: This parameter doesn't work in REST API connections. The PSSessionOption parameter specifies the remote PowerShell session options to use in your connection to Security & Compliance PowerShell. This parameter works only if you also use the UseRPSSession switch in the same command. @@ -157,7 +167,6 @@ Store the output of the [New-PSSessionOption](https://learn.microsoft.com/powers Type: PSSessionOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 3 @@ -167,6 +176,9 @@ Accept wildcard characters: False ``` ### -Prefix + +> Applicable: Exchange Online + The Prefix parameter specifies a text value to add to the names of Security & Compliance PowerShell cmdlets when you connect. For example, Get-ComplianceCase becomes Get-ContosoComplianceCase when you use the value Contoso for this parameter. - The Prefix value can't contain spaces or special characters like underscores or asterisks. @@ -177,7 +189,6 @@ The Prefix parameter specifies a text value to add to the names of Security & Co Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 4 @@ -187,13 +198,15 @@ Accept wildcard characters: False ``` ### -CommandName + +> Applicable: Exchange Online + The CommandName parameter specifies the comma separated list of commands to import into the session. Use this parameter for applications or scripts that use a specific set of cmdlets. Reducing the number of cmdlets in the session helps improve performance and reduces the memory footprint of the application or script. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 5 @@ -203,13 +216,15 @@ Accept wildcard characters: False ``` ### -FormatTypeName + +> Applicable: Exchange Online + The FormatTypeName parameter specifies the output format of the cmdlet. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 6 @@ -218,7 +233,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AccessToken + +> Applicable: Exchange Online + +**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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AppId + +> Applicable: Exchange Online + The AppId parameter specifies the application ID of the service principal that's used in certificate based authentication (CBA). A valid value is the GUID of the application ID (service principal). For example, `36ee4c6c-0812-40a2-b820-b22ebd02bce3`. For more information, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). @@ -227,7 +267,6 @@ For more information, see [App-only authentication for unattended scripts in the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -237,13 +276,15 @@ Accept wildcard characters: False ``` ### -BypassMailboxAnchoring + +> Applicable: Exchange Online + The BypassMailboxAnchoring switch bypasses the use of the mailbox anchoring hint. 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 @@ -253,6 +294,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: Exchange Online + The Certificate parameter specifies the certificate that's used for certificate-based authentication (CBA). A valid value is the X509Certificate2 object value of the certificate. Don't use this parameter with the CertificateFilePath or CertificateThumbprint parameters. @@ -263,7 +307,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: X509Certificate2 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -273,6 +316,9 @@ Accept wildcard characters: False ``` ### -CertificateFilePath + +> Applicable: Exchange Online + The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter. Don't use this parameter with the Certificate or CertificateThumbprint parameters. @@ -283,7 +329,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -293,6 +338,9 @@ Accept wildcard characters: False ``` ### -CertificatePassword + +> Applicable: Exchange Online + The CertificatePassword parameter specifies the password that's required to open the certificate file when you use the CertificateFilePath parameter to identify the certificate that's used for CBA. You can use the following methods as a value for this parameter: @@ -309,7 +357,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -319,6 +366,9 @@ Accept wildcard characters: False ``` ### -CertificateThumbprint + +> Applicable: Exchange Online + The CertificateThumbprint parameter specifies the certificate that's used for CBA. A valid value is the thumbprint value of the certificate. For example, `83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1`. Don't use this parameter with the Certificate or CertificateFilePath parameters. @@ -331,7 +381,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -341,6 +390,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Online + The Credential parameter specifies the username and password that's used to connect to Exchange Online PowerShell. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. Don't use this parameter for accounts that use multi-factor authentication (MFA). Before you run the Connect-IPPSSession command, store the username and password in a variable (for example, `$UserCredential = Get-Credential`). Then, use the variable name (`$UserCredential`) for this parameter. @@ -351,7 +403,6 @@ After the Connect-IPPSSession command is complete, the password key in the varia Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -361,6 +412,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + The Organization parameter specifies the organization when you connect using CBA. You must use the primary .onmicrosoft.com domain of the organization for the value of this parameter. For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). @@ -369,7 +423,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -379,6 +432,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + 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). @@ -387,7 +443,6 @@ If you use the UserPrincipalName parameter, you don't need to use the AzureADAut Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -397,6 +452,9 @@ Accept wildcard characters: False ``` ### -UseRPSSession + +> Applicable: Exchange Online + 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). @@ -411,7 +469,6 @@ If you don't use this switch, Basic authentication in WinRM is not required. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Connect-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Connect-Mailbox.md similarity index 84% rename from exchange/exchange-ps/exchange/Connect-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Connect-Mailbox.md index 87bea6279a..37a5e4b89c 100644 --- a/exchange/exchange-ps/exchange/Connect-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Connect-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/connect-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Connect-Mailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/connect-mailbox +schema: 2.0.0 +title: Connect-Mailbox --- # Connect-Mailbox @@ -115,7 +116,7 @@ Connect-Mailbox [-Identity] [-Database] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox that you want to connect to a user account. This parameter doesn't specify an Active Directory object. You can use the following values to identify the mailbox: - Display name @@ -178,7 +182,6 @@ You use this parameter with the Database parameter to specify the mailbox that y Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -188,6 +191,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Database parameter specifies the Exchange database that contains the mailbox that you want to connect. You can use any value that uniquely identifies the database. For example: - Name @@ -200,7 +206,6 @@ You use this parameter with the Identity parameter to specify the mailbox that y Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 2 @@ -210,6 +215,9 @@ Accept wildcard characters: False ``` ### -Equipment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Equipment switch is required to connect equipment mailboxes. You don't need to specify a value with this switch. Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers). @@ -218,7 +226,6 @@ Equipment mailboxes are resource mailboxes that aren't associated with a specifi Type: SwitchParameter Parameter Sets: Equipment Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -228,6 +235,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if the mailbox is a linked mailbox. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter. Use the fully qualified domain name (FQDN) of the domain controller that you want to use as the value for this parameter. This parameter is required only if you're connecting a linked mailbox. @@ -236,7 +246,6 @@ This parameter is required only if you're connecting a linked mailbox. Type: Fqdn Parameter Sets: Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -246,6 +255,9 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if this mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. This parameter is required only if you're creating a linked mailbox. You can use any value that uniquely identifies the master account. For example: - Name @@ -259,7 +271,6 @@ This parameter is required only if you're connecting a linked mailbox. Type: UserIdParameter Parameter Sets: Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -269,6 +280,9 @@ Accept wildcard characters: False ``` ### -Room + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Room switch is required to connect room mailboxes. You don't need to specify a value with this switch. Room mailboxes are resource mailboxes that are associated with a specific location (for example, conference rooms). @@ -277,7 +291,6 @@ Room mailboxes are resource mailboxes that are associated with a specific locati Type: SwitchParameter Parameter Sets: Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -287,6 +300,9 @@ Accept wildcard characters: False ``` ### -Shared + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Shared switch is required to connect shared mailboxes. You don't need to specify a value with this switch. A shared mailbox is a mailbox where multiple users can log on to access the mailbox contents. This mailbox isn't associated with any of the users that can log on. It's associated with a disabled user account. @@ -295,7 +311,6 @@ A shared mailbox is a mailbox where multiple users can log on to access the mail Type: SwitchParameter Parameter Sets: Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -305,7 +320,10 @@ Accept wildcard characters: False ``` ### -ValidateOnly -The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. You don't need to specify a value with this switch. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ValidateOnly switch specifies whether to evaluate the potential success or failure of the command without making changes. You don't need to specify a value with this switch. No changes are made when you use this switch. @@ -313,7 +331,6 @@ No changes are made when you use this switch. Type: SwitchParameter Parameter Sets: ValidateOnly Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -323,6 +340,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveSyncMailboxPolicy parameter specifies the mobile device mailbox policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example:. - Name @@ -335,7 +355,6 @@ If you don't use this parameter, the default mobile device mailbox policy is use Type: MailboxPolicyIdParameter Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -345,6 +364,9 @@ Accept wildcard characters: False ``` ### -AddressBookPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AddressBookPolicy parameter specifies the address book policy that's applied to the mailbox. You can use any value that uniquely identifies the address book policy. For example: - Name @@ -357,7 +379,6 @@ For more information about address book policies, see [Address book policies in Type: AddressBookMailboxPolicyIdParameter Parameter Sets: User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -367,6 +388,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -391,7 +415,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -401,13 +424,15 @@ Accept wildcard characters: False ``` ### -AllowLegacyDNMismatch + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: User Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -417,13 +442,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Archive switch specifies whether to connect the associated archive mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +460,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -442,7 +472,6 @@ 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 Required: False Position: Named @@ -452,13 +481,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,6 +499,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -476,7 +510,6 @@ 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 Required: False Position: Named @@ -486,6 +519,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LinkedCredential parameter specifies the credentials used to access the domain controller that's specified by the LinkedDomainController parameter. This parameter is optional, even if you're connecting a linked mailbox. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -494,7 +530,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -504,13 +539,15 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -520,13 +557,15 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicyAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -536,6 +575,9 @@ Accept wildcard characters: False ``` ### -RetentionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RetentionPolicy parameter specifies the retention policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example: - Name @@ -548,7 +590,6 @@ Retention policies consist of tags that are applied to mailbox folders and mail Type: MailboxPolicyIdParameter Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -558,6 +599,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The User parameter specifies the user object in Active Directory that you want to connect the mailbox to. For the best results, we recommend using the following values: @@ -578,7 +622,6 @@ If you don't use this parameter, the command uses the LegacyExchangeDN and Displ Type: UserIdParameter Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -588,13 +631,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/ExchangePowerShell/Delete-QuarantineMessage.md similarity index 82% rename from exchange/exchange-ps/exchange/Delete-QuarantineMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Delete-QuarantineMessage.md index 3dc21e421f..eaa566a1f2 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Delete-QuarantineMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/delete-quarantinemessage applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Delete-QuarantineMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/delete-quarantinemessage +schema: 2.0.0 +title: Delete-QuarantineMessage --- # Delete-QuarantineMessage @@ -44,7 +45,7 @@ Delete-QuarantineMessage -Identity ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -76,6 +77,9 @@ This example deletes all quarantined messages. The Identity parameter is require ## PARAMETERS ### -Identities + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2...valueN`. Each value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. @@ -86,7 +90,6 @@ When you use this parameter, the Identity parameter is required, but the value i Type: QuarantineMessageIdentity[] Parameter Sets: Identities Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -96,15 +99,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the quarantined message that you want to delete. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. ```yaml Type: QuarantineMessageIdentity -Parameter Sets: Identities +Parameter Sets: Identities, IdentityOnly Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -113,20 +118,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: IdentityOnly -Aliases: -Applicable: Exchange Online, Exchange Online Protection +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection -### -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`. @@ -136,7 +131,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -146,6 +140,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -157,7 +154,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -167,6 +163,9 @@ Accept wildcard characters: False ``` ### -HardDelete + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The HardDelete switch specifies the message is permanently deleted and isn't recoverable. You don't need to specify a value with this switch. If you don't use this switch, the message is deleted, but is potentially recoverable. @@ -175,7 +174,6 @@ If you don't use this switch, the message is deleted, but is potentially recover Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -185,13 +183,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -201,13 +201,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-ATPProtectionPolicyRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-ATPProtectionPolicyRule.md index fe87141f2e..55e5a4c0fd 100644 --- a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-atpprotectionpolicyrule applicable: Exchange Online -title: Disable-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-atpprotectionpolicyrule +schema: 2.0.0 +title: Disable-ATPProtectionPolicyRule --- # Disable-ATPProtectionPolicyRule @@ -32,7 +33,7 @@ The State property in rules that are associated with preset security policies in 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ In organizations with Defender for Office 365, this example turns off the Standa ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Disable-AddressListPaging.md b/exchange/exchange-ps/ExchangePowerShell/Disable-AddressListPaging.md similarity index 80% rename from exchange/exchange-ps/exchange/Disable-AddressListPaging.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-AddressListPaging.md index 45471267d2..0c7b2a55ce 100644 --- a/exchange/exchange-ps/exchange/Disable-AddressListPaging.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-AddressListPaging.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-addresslistpaging -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-AddressListPaging -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-addresslistpaging +schema: 2.0.0 +title: Disable-AddressListPaging --- # Disable-AddressListPaging @@ -28,7 +29,7 @@ Disable-AddressListPaging [-Confirm] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example disables virtual list view for address lists in your organization. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -53,7 +57,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-AntiPhishRule.md similarity index 82% rename from exchange/exchange-ps/exchange/Disable-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-AntiPhishRule.md index df08fecd4f..3773a17e34 100644 --- a/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: Disable-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-antiphishrule +schema: 2.0.0 +title: Disable-AntiPhishRule --- # Disable-AntiPhishRule @@ -28,7 +29,7 @@ Disable-AntiPhishRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example disables the antiphish rule named Engineering Department Phishing R ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the antiphish rule that you want to disable. Yo Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-App.md b/exchange/exchange-ps/ExchangePowerShell/Disable-App.md similarity index 78% rename from exchange/exchange-ps/exchange/Disable-App.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-App.md index 881f7f9195..1ca9ed7f04 100644 --- a/exchange/exchange-ps/exchange/Disable-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-App.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-app -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-App -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-app +schema: 2.0.0 +title: Disable-App --- # Disable-App ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Disable-App cmdlet to disable (turn off) a specific app for a specific user. @@ -30,11 +31,11 @@ Disable-App [-Identity] ``` ## DESCRIPTION -The Disable-App cmdlet requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet, or that it's a default app for Microsoft Outlook). +The Disable-App cmdlet requires that the specified app has already been installed (for example, that the app is installed with the New-App cmdlet, or that it's a default app for Microsoft Outlook). For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://learn.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://learn.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,16 +60,20 @@ Disable-App -Identity 545d8236-721a-468f-85d8-254eca7cb0da -Mailbox Tony This example disables the Share to Teams app for user Tony. +**Note**: Even if you disable the default app with this cmdlet, that app is automatically enabled when the user accesses the app. This behavior is by design. + ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID of the app. ```yaml Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -89,7 +97,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -107,7 +117,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +126,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the identity of the mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -136,7 +148,6 @@ You can't use this parameter with the Identity parameter. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,13 +157,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md b/exchange/exchange-ps/ExchangePowerShell/Disable-CmdletExtensionAgent.md similarity index 79% rename from exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-CmdletExtensionAgent.md index 071e1f83ec..02844b93ac 100644 --- a/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-CmdletExtensionAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-cmdletextensionagent -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-CmdletExtensionAgent -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-cmdletextensionagent +schema: 2.0.0 +title: Disable-CmdletExtensionAgent --- # Disable-CmdletExtensionAgent @@ -29,11 +30,11 @@ Disable-CmdletExtensionAgent [-Identity] ``` ## DESCRIPTION -Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or third-party products can't use cmdlet extension agents. +Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or non-Microsoft products can't use cmdlet extension agents. When you disable a cmdlet extension agent, the agent is disabled for the entire organization. When an agent is disabled, it's not made available to cmdlets. Cmdlets can no longer use the agent to perform additional operations. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example disables the cmdlet extension agent named Scripting Agent. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the enabled cmdlet extension agent that you want to disable. You can use any value that uniquely identifies the agent. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the enabled cmdlet extension agent that you wan Type: CmdletExtensionAgentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -78,7 +84,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Disable-DistributionGroup.md similarity index 82% rename from exchange/exchange-ps/exchange/Disable-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-DistributionGroup.md index e773646d76..ebe082cf21 100644 --- a/exchange/exchange-ps/exchange/Disable-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-DistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-distributiongroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-DistributionGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-distributiongroup +schema: 2.0.0 +title: Disable-DistributionGroup --- # Disable-DistributionGroup @@ -32,7 +33,7 @@ Disable-DistributionGroup [-Identity] ## DESCRIPTION The Disable-DistributionGroup cmdlet mail-disables existing mail-enabled security groups and distribution groups by removing the email attributes that are required by Exchange. Mail-disabled groups are invisible to the \*-DistributionGroup cmdlets (with the exception of Enable-DistributionGroup). All groups (mail-enabled or not) are visible to the Get-Group and Set-Group cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example mail-disables the distribution group named Distribution Group1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the distribution group or mail-enabled security group that you want to mail-disable. You can use any value that uniquely identifies the group. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -80,7 +86,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -117,7 +127,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Disable-DnssecForVerifiedDomain.md similarity index 79% rename from exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-DnssecForVerifiedDomain.md index 9cb03986fd..41c64fcc70 100644 --- a/exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-DnssecForVerifiedDomain.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-dnssecforverifieddomain +schema: 2.0.0 +title: Disable-DnssecForVerifiedDomain --- # Disable-DnssecForVerifiedDomain @@ -30,7 +31,7 @@ Disable-DnssecForVerifiedDomain [-DomainName] ## DESCRIPTION For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example disables DNSSEC for mail sent to contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + 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 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -76,13 +81,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named @@ -92,7 +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](http://go.microsoft.com/fwlink/p/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS diff --git a/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-EOPProtectionPolicyRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-EOPProtectionPolicyRule.md index b611fc63b1..0a8a006a20 100644 --- a/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: Disable-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-eopprotectionpolicyrule +schema: 2.0.0 +title: Disable-EOPProtectionPolicyRule --- # Disable-EOPProtectionPolicyRule @@ -32,7 +33,7 @@ The State property in rules that are associated with preset security policies in 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ In organizations with Defender for Office 365, this example turns off the Standa ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +69,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -86,7 +92,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-HostedContentFilterRule.md similarity index 84% rename from exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-HostedContentFilterRule.md index 7adfa0cbae..bc31eef052 100644 --- a/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection -title: Disable-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-hostedcontentfilterrule +schema: 2.0.0 +title: Disable-HostedContentFilterRule --- # Disable-HostedContentFilterRule @@ -28,7 +29,7 @@ Disable-HostedContentFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example disables the enabled spam filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the spam filter rule that you want to disable. Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-HostedOutboundSpamFilterRule.md similarity index 82% rename from exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-HostedOutboundSpamFilterRule.md index 442273d3c0..4b73d2012f 100644 --- a/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: Disable-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-hostedoutboundspamfilterrule +schema: 2.0.0 +title: Disable-HostedOutboundSpamFilterRule --- # Disable-HostedOutboundSpamFilterRule @@ -28,7 +29,7 @@ Disable-HostedOutboundSpamFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example disables the enabled outbound spam filter rule named Contoso Execut ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the outbound spam filter rule that you want to Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Disable-IPv6ForAcceptedDomain.md similarity index 81% rename from exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-IPv6ForAcceptedDomain.md index 59ff3a79b1..799ceca694 100644 --- a/exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-IPv6ForAcceptedDomain.md @@ -1,12 +1,12 @@ --- -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 +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-ipv6foraccepteddomain +schema: 2.0.0 +title: Disable-IPv6ForAcceptedDomain --- # Disable-IPv6ForAcceptedDomain @@ -32,7 +32,7 @@ Use the Get-AcceptedDomain cmdlet to return accepted domains in the Exchange Onl 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +46,15 @@ This example disables IPv6 support for mail sent to contoso.com. Mail can be del ## PARAMETERS ### -Domain + +> Applicable: Exchange Online + 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 @@ -62,13 +64,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -78,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-InboxRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Disable-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-InboxRule.md index 7bc6e6bce3..6844c2d30f 100644 --- a/exchange/exchange-ps/exchange/Disable-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-InboxRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-inboxrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-InboxRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-inboxrule +schema: 2.0.0 +title: Disable-InboxRule --- # Disable-InboxRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Disable-InboxRule cmdlet to disable existing Inbox rules in mailboxes. @@ -34,7 +35,7 @@ Disable-InboxRule [-Identity] ## DESCRIPTION When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example disables the Inbox rule MoveAnnouncements in the mailbox Joe@Contos ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Inbox rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the Inbox rule that you want to disable. You ca Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -96,7 +104,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -114,7 +124,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,17 +133,19 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. -A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. +A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules are removed by the actions of this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -144,6 +155,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -161,7 +175,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-JournalArchiving.md b/exchange/exchange-ps/ExchangePowerShell/Disable-JournalArchiving.md similarity index 85% rename from exchange/exchange-ps/exchange/Disable-JournalArchiving.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-JournalArchiving.md index a1bf697510..e8dfd114a9 100644 --- a/exchange/exchange-ps/exchange/Disable-JournalArchiving.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-JournalArchiving.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-journalarchiving applicable: Exchange Online -title: Disable-JournalArchiving -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-journalarchiving +schema: 2.0.0 +title: Disable-JournalArchiving --- # Disable-JournalArchiving @@ -35,7 +36,7 @@ The Disable-JournalArchiving cmdlet removes the mail user and converts the journ In hybrid organizations that use DirSync, this cmdlet doesn't remove the mail user. Removal of the mail user is handled by DirSync. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example disables the journal archiving for the user named Timothy Amaral. T ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the identity of the user's journal archive mailbox in Exchange Online. You can use any value that uniquely identifies the journal archive mailbox. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the identity of the user's journal archive mail Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -PreserveMailUser + +> Applicable: Exchange Online + The PreserveMailUser switch specifies that you want to keep the mail user that's associated with the archive mailbox. 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 @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-JournalRule.md similarity index 79% rename from exchange/exchange-ps/exchange/Disable-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-JournalRule.md index f36f1eaaaa..afa8c7c7f9 100644 --- a/exchange/exchange-ps/exchange/Disable-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-JournalRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-journalrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-JournalRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-journalrule +schema: 2.0.0 +title: Disable-JournalRule --- # Disable-JournalRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Disable-JournalRule cmdlet to disable a journal rule on a Mailbox server. @@ -31,7 +32,7 @@ Disable-JournalRule -Identity ## DESCRIPTION You can enable or disable specific journal rules in your organization at any time using the Disable-JournalRule and Enable-JournalRule cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,13 +53,15 @@ This example disables all journal rules. The Get-JournalRule cmdlet is used to a ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the journal rule you want to disable. Enter either the name or the GUID of the journal rule. You can omit this parameter label. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -79,7 +85,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -97,7 +105,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MailContact.md similarity index 82% rename from exchange/exchange-ps/exchange/Disable-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MailContact.md index 97902c5fd6..29c0f0cafb 100644 --- a/exchange/exchange-ps/exchange/Disable-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MailContact.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailcontact -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-MailContact -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-mailcontact +schema: 2.0.0 +title: Disable-MailContact --- # Disable-MailContact @@ -32,7 +33,7 @@ Disable-MailContact [-Identity] ## DESCRIPTION The Disable-MailContact cmdlet mail-disables existing mail contacts by removing the email attributes that are required by Exchange. Mail-disabled contacts are invisible to the \*-MailContact cmdlets (with the exception of Enable-MailContact). All contacts (mail-enabled or not) are visible to the Get-Contact and Set-Contact cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example mail-disables the mail contact named Ed Meadows. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mail contact that you want to mail-disable. You can use any value that uniquely identifies the mail contact. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the mail contact that you want to mail-disable. Type: MailContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -80,7 +86,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -117,7 +127,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MailPublicFolder.md similarity index 79% rename from exchange/exchange-ps/exchange/Disable-MailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MailPublicFolder.md index a4aadbbe70..8c17a89a9b 100644 --- a/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MailPublicFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailpublicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-MailPublicFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-mailpublicfolder +schema: 2.0.0 +title: Disable-MailPublicFolder --- # Disable-MailPublicFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Disable-MailPublicFolder cmdlet to mail-disable a public folder. @@ -30,7 +31,7 @@ Disable-MailPublicFolder [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example mail-disables the public folder Help Desk. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label Identity so that only the public folder name or GUID is supplied. @@ -52,7 +56,6 @@ You can omit the parameter label Identity so that only the public folder name or Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -91,7 +99,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -116,7 +126,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MailUser.md similarity index 83% rename from exchange/exchange-ps/exchange/Disable-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MailUser.md index c0728ff91a..63338fd044 100644 --- a/exchange/exchange-ps/exchange/Disable-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MailUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailuser -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-MailUser -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-mailuser +schema: 2.0.0 +title: Disable-MailUser --- # Disable-MailUser @@ -33,7 +34,7 @@ Disable-MailUser [-Identity] ## DESCRIPTION The Disable-MailUser cmdlet mail-disables existing mail users by removing the email attributes that are required by Exchange. Mail-disabled users are invisible to the \*-MailUser cmdlets (with the exception of Enable-MailUser). All users (mail-enabled or not) are visible to the Get-User and Set-User cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example mail-disables an existing mail user. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mail user that you want to mail-disable. You can use any value that uniquely identifies the mail user. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the mail user that you want to mail-disable. Yo Type: MailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -81,7 +87,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -118,7 +128,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. @@ -138,7 +150,6 @@ After you disable or remove a mailbox, you can't include it in a discovery searc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Disable-Mailbox.md similarity index 82% rename from exchange/exchange-ps/exchange/Disable-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-Mailbox.md index 8997b03b35..273ce9e0bd 100644 --- a/exchange/exchange-ps/exchange/Disable-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-Mailbox.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Disable-Mailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-mailbox +schema: 2.0.0 +title: Disable-Mailbox --- # Disable-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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Disable-Mailbox cmdlet to disable the mailbox of existing users who already have mailboxes. For this cmdlet, a user could also be a public folder mailbox or an InetOrgPerson object. The user account that's associated with the mailbox remains, but it's no longer associated with a mailbox. @@ -76,9 +77,9 @@ The Disable-Mailbox cmdlet removes the mailbox's Exchange attributes from Active The Disable-Mailbox cmdlet also performs the clean-up task on the individual mailbox, so the mailbox is disconnected immediately after this task completes. -Under normal circumstances, a mailbox is marked as disconnected immediately after the Disable-Mailbox or Remove-Mailbox command completes. However, if the mailbox was disabled or removed while the Exchange Information Store service was stopped, or if it was disabled or removed by an external means other than Exchange management interfaces, the status of the mailbox object in the Exchange mailbox database won't be marked as disconnected. +Under normal circumstances, a mailbox is marked as disconnected immediately after the Disable-Mailbox or Remove-Mailbox command completes. However, if the mailbox was disabled or removed while the Exchange Information Store service was stopped, or if it was disabled or removed by an external means other than Exchange management interfaces, the status of the mailbox object in the Exchange mailbox database isn't marked as disconnected. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,6 +100,9 @@ This example disables the remote archive for the on-premises user named John Woo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to mailbox-disable. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -116,7 +120,6 @@ The Identity parameter specifies the mailbox that you want to mailbox-disable. Y Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -126,6 +129,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Arbitration switch is required to mailbox-disable arbitration mailboxes. You don't need to specify a value with this switch. @@ -136,7 +142,6 @@ Arbitration mailboxes are system mailboxes that are used for storing different t Type: SwitchParameter Parameter Sets: Arbitration Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +151,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Archive switch specifies whether to disconnect the archive mailbox from the associated user. You don't need to specify a value with this switch. You can't use this switch with the RemoteArchive switch. @@ -154,7 +162,6 @@ You can't use this switch with the RemoteArchive switch. Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -164,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -175,7 +185,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -185,6 +194,9 @@ Accept wildcard characters: False ``` ### -DisableArbitrationMailboxWithOABsAllowed + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DisableArbitrationMailboxWithOABsAllowed switch specifies whether to bypass the checks for offline address books (OABs) within the specified arbitration mailbox that is being mail-disabled. When you use this switch, the arbitration mailbox is disabled even if OABs are present in the mailbox. You don't need to specify a value with this switch. @@ -193,7 +205,6 @@ The DisableArbitrationMailboxWithOABsAllowed switch specifies whether to bypass Type: SwitchParameter Parameter Sets: Arbitration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,6 +214,9 @@ Accept wildcard characters: False ``` ### -DisableLastArbitrationMailboxAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DisableLastArbitrationMailboxAllowed switch specifies whether to disable the specified mailbox, even if it's the last arbitration mailbox in the organization. If you disable the last arbitration mailbox in the organization, you can't have user-created distribution groups or moderated recipients. You don't need to specify a value with this switch. @@ -211,7 +225,6 @@ The DisableLastArbitrationMailboxAllowed switch specifies whether to disable the Type: SwitchParameter Parameter Sets: Arbitration Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -221,6 +234,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -229,7 +245,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,6 +254,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -252,7 +270,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,6 +279,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. @@ -274,7 +294,6 @@ After you disable or remove a mailbox, you can't include it in a discovery searc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,6 +303,9 @@ Accept wildcard characters: False ``` ### -PermanentlyDisable + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PermanentlyDisable switch specifies whether to permanently disable the mailbox. You don't need to specify a value with this switch. @@ -291,13 +313,12 @@ The PermanentlyDisable switch specifies whether to permanently disable the mailb **Notes**: - You can only use this switch on user mailboxes that aren't licensed and aren't on hold. -- When the Exchange Online license is removed from a mailbox without following other deprovisioning steps, this may leave the mailbox in a hard-deleted state. In this case, this parameter is not useful. You can use it, for example, in hybrid Exchange environments. +- When the Exchange Online license is removed from a mailbox without following other deprovisioning steps, this might leave the mailbox in a hard-deleted state. In this case, this parameter is not useful. You can use it, for example, in hybrid Exchange environments. ```yaml Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -307,6 +328,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PublicFolder switch is required to mailbox-disable public folder mailboxes. You don't need to specify a value with this switch. @@ -317,7 +341,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -327,6 +350,9 @@ Accept wildcard characters: False ``` ### -RemoteArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoteArchive switch specifies whether to disconnect the remote archive for this mailbox. Remote archives exist in the cloud-based service. When you use this switch, the RemoteRecipientType property for the mailbox is reset to specify that this mailbox doesn't have a remote archive. You don't need to specify a value with this switch. @@ -337,7 +363,6 @@ You can't use this switch with the Archive switch. Type: SwitchParameter Parameter Sets: RemoteArchive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -347,13 +372,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MailboxQuarantine.md similarity index 85% rename from exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MailboxQuarantine.md index 98aaf73776..f33a6ec479 100644 --- a/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MailboxQuarantine.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailboxquarantine -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-MailboxQuarantine -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-mailboxquarantine +schema: 2.0.0 +title: Disable-MailboxQuarantine --- # Disable-MailboxQuarantine @@ -67,9 +68,9 @@ Disable-MailboxQuarantine -Server ``` ## DESCRIPTION -Mailboxes are quarantined when they affect the availability of the mailbox database. Typically a software fix from Microsoft is required before releasing a mailbox from quarantine. If a fix isn't deployed before releasing the mailbox, the quarantine on the mailbox will be re-enabled if the condition recurs. The default quarantine duration is 24 hours. +Mailboxes are quarantined when they affect the availability of the mailbox database. Typically a software fix from Microsoft is required before releasing a mailbox from quarantine. If a fix isn't deployed before releasing the mailbox, the quarantine on the mailbox is re-enabled if the condition recurs. The default quarantine duration is 24 hours. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,6 +84,9 @@ This example releases the mailbox for the user Brian Johnson from quarantine. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013 + The Identity parameter specifies the mailbox that you want to release from quarantine. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -100,9 +104,8 @@ You can't use this parameter with the Database or Server parameters. ```yaml Type: GeneralMailboxIdParameter -Parameter Sets: MailboxIdentity +Parameter Sets: MailboxIdentity, MailboxOrMailUserIdentity Aliases: -Applicable: Exchange Server 2013 Required: True Position: 1 @@ -111,20 +114,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: MailboxOrMailUserIdentity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -Database -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Database The Database parameter specifies the database that contains the mailboxes you want to release from quarantine. You can use any value that uniquely identifies the database. For example: - Name @@ -139,7 +132,6 @@ You can't use this parameter with the Identity or Server parameters. Type: DatabaseIdParameter Parameter Sets: StoreMailboxIdentity, IncludeAllMailboxes Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -149,6 +141,9 @@ Accept wildcard characters: False ``` ### -IncludeAllDatabases + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeAllDatabases switch specifies that you want to release all quarantined mailboxes in all databases on the server you specify with the Server parameter. You don't need to specify a value with this switch. You can only use this switch with the Identity or Database parameters. @@ -157,7 +152,6 @@ You can only use this switch with the Identity or Database parameters. Type: SwitchParameter Parameter Sets: IncludeAllDatabases Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -167,6 +161,9 @@ Accept wildcard characters: False ``` ### -IncludeAllMailboxes + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeAllMailboxes switch specifies that you want to release all mailboxes from quarantine in the database you specify with the Database parameter. You don't need to specify a value with this switch. You can't use this switch with the StoreMailboxIdentity parameter. @@ -175,7 +172,6 @@ You can't use this switch with the StoreMailboxIdentity parameter. Type: SwitchParameter Parameter Sets: IncludeAllMailboxes Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -185,6 +181,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the server that contains the mailboxes that you want to release from quarantine by using the IncludeAllDatabases switch. You can use any value that uniquely identifies the server. For example: - Name @@ -198,7 +197,6 @@ You can't use this parameter with the Identity or Database parameters. Type: ServerIdParameter Parameter Sets: IncludeAllDatabases Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -208,6 +206,9 @@ Accept wildcard characters: False ``` ### -StoreMailboxIdentity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StoreMailboxIdentity parameter specifies the mailbox that you want to release from quarantine when you use the Database parameter. You identify the mailbox by its GUID value. You can find the GUID value by using the Get-Mailbox or Get-MailboxStatistics cmdlets. @@ -218,7 +219,6 @@ You can't use this switch with the IncludeAllMailboxes switch. Type: StoreMailboxIdParameter Parameter Sets: StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -228,6 +228,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -239,7 +242,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -249,13 +251,15 @@ Accept wildcard characters: False ``` ### -IncludePassive + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludePassive switch specifies that you also want to release inactive copies of the mailbox from quarantine. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, IncludeAllMailboxes, MailboxOrMailUserIdentity, IncludeAllDatabases Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -265,13 +269,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MalwareFilterRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MalwareFilterRule.md index 127a8f0542..28433ca829 100644 --- a/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MalwareFilterRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-malwarefilterrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Disable-MalwareFilterRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-malwarefilterrule +schema: 2.0.0 +title: Disable-MalwareFilterRule --- # Disable-MalwareFilterRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Disable-MalwareFilterRule cmdlet to disable malware filter rules in your organization. @@ -29,7 +30,7 @@ Disable-MalwareFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example disables the enabled malware filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter rule that you want to disable. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -70,7 +76,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -88,7 +96,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MetaCacheDatabase.md similarity index 82% rename from exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MetaCacheDatabase.md index 87451f2763..97db1f920f 100644 --- a/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MetaCacheDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-metacachedatabase -applicable: Exchange Server 2019 -title: Disable-MetaCacheDatabase -schema: 2.0.0 +applicable: Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-metacachedatabase +schema: 2.0.0 +title: Disable-MetaCacheDatabase --- # Disable-MetaCacheDatabase @@ -28,7 +29,7 @@ Disable-MetaCacheDatabase -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example disables the metacache database on the Exchange server named Mailbo ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Mailbox server where you want to disable the metacache database. You can use any value that uniquely identifies the server. For example: - Name @@ -55,7 +59,6 @@ You can specify multiple values separated by commas. If the value contains space Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: True Position: Named @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019, Exchange Server SE + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019, Exchange Server SE + 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 diff --git a/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md b/exchange/exchange-ps/ExchangePowerShell/Disable-OutlookAnywhere.md similarity index 88% rename from exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-OutlookAnywhere.md index 30685164f7..2be4362dad 100644 --- a/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-OutlookAnywhere.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-outlookanywhere applicable: Exchange Server 2010 -title: Disable-OutlookAnywhere -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-outlookanywhere +schema: 2.0.0 +title: Disable-OutlookAnywhere --- # Disable-OutlookAnywhere @@ -43,9 +44,9 @@ Enabling Outlook Anywhere on the Client Access server prevents the server from a When you run this cmdlet, it can take as long as an hour for the settings to become effective, depending on how long it takes for Active Directory to replicate. -After the Client Access server is disabled for Outlook Anywhere, you may want to remove the RPC over HTTP proxy Windows networking component. +After the Client Access server is disabled for Outlook Anywhere, you might want to remove the RPC over HTTP proxy Windows networking component. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,6 +67,9 @@ This example disables Outlook Anywhere on the specified virtual directory on the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Outlook Anywhere virtual directory that you want to disable. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -80,7 +84,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -99,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Client Access server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -136,7 +146,6 @@ The Server parameter specifies the Client Access server where you want to run th Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-OutlookProtectionRule.md similarity index 79% rename from exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-OutlookProtectionRule.md index 6032b60587..7230030d14 100644 --- a/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-outlookprotectionrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-OutlookProtectionRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-outlookprotectionrule +schema: 2.0.0 +title: Disable-OutlookProtectionRule --- # Disable-OutlookProtectionRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS **Note**: This cmdlet is no longer supported in the cloud-based service. -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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Disable-OutlookProtectionRule cmdlet to disable an existing Microsoft Outlook protection rule. @@ -35,7 +36,7 @@ Outlook protection rules are administrator-created rules applied before a user s For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example disables the Outlook protection rule Project Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the rule being disabled. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -76,7 +82,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md b/exchange/exchange-ps/ExchangePowerShell/Disable-PushNotificationProxy.md similarity index 83% rename from exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-PushNotificationProxy.md index ade8f3935d..8eb51ee19e 100644 --- a/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-PushNotificationProxy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-pushnotificationproxy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-PushNotificationProxy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-pushnotificationproxy +schema: 2.0.0 +title: Disable-PushNotificationProxy --- # Disable-PushNotificationProxy @@ -29,7 +30,7 @@ Disable-PushNotificationProxy [-Confirm] ## DESCRIPTION The push notification proxy relays event notifications (for example, new email or calendar updates) for on-premises mailboxes through Microsoft 365 to Outlook on the web for devices on the user's device. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example disables the push notification proxy in the on-premises Exchange or ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -54,7 +58,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Disable-RemoteMailbox.md similarity index 81% rename from exchange/exchange-ps/exchange/Disable-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-RemoteMailbox.md index 8039e5d1fd..805dcedf5e 100644 --- a/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-remotemailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-RemoteMailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-remotemailbox +schema: 2.0.0 +title: Disable-RemoteMailbox --- # Disable-RemoteMailbox @@ -34,7 +35,7 @@ Disable-RemoteMailbox [-Identity] ## DESCRIPTION Use the Disable-RemoteMailbox cmdlet to perform the following actions: -- Remove a cloud-based mailbox but keep the associated on-premises user account. To do this, you first need to remove the Exchange Online license for the mailbox. Otherwise, the mailbox won't be removed. The on-premises mail user is automatically converted to a regular user object. You can mail-enable the on-premises user object using the Enable-MailUser cmdlet. +- Remove a cloud-based mailbox but keep the associated on-premises user account. To do this, you first need to remove the Exchange Online license for the mailbox. Otherwise, the mailbox isn't removed. The on-premises mail user is automatically converted to a regular user object. You can mail-enable the on-premises user object using the Enable-MailUser cmdlet. - Disconnect a cloud-based archive mailbox from a cloud-based mailbox. The cloud-based mailbox and the associated on-premises mail user are preserved. If you want to remove both the cloud-based mailbox and the associated on-premises mail user, use the Remove-RemoteMailbox cmdlet. @@ -43,10 +44,10 @@ Directory synchronization must be configured correctly for a mailbox to be remov **Notes**: -- If you are deprovisioning a cloud mailbox and its associated online archive, you must first disable the online archive with the command `Disable-RemoteMailbox -Archive` and then perform a directory synchronization prior to disabling the remote mailbox. Attempting to disable both the online archive and cloud mailbox without a sync between them may result in an ArchiveGuid mismatch and validation error. +- If you are deprovisioning a cloud mailbox and its associated online archive, you must first disable the online archive with the command `Disable-RemoteMailbox -Archive` and then perform a directory synchronization prior to disabling the remote mailbox. Attempting to disable both the online archive and cloud mailbox without a sync between them might result in an ArchiveGuid mismatch and validation error. - Due to the current service architecture, you need to convert shared mailboxes to user mailboxes prior to running the Disable-RemoteMailbox cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,18 +56,21 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Disable-RemoteMailbox "Kim Akers" ``` -This example removes the cloud-based mailbox that's associated with the on-premises mail user named Kim Akers. The mail user is automatically converted to a regular user. This example assumes that you've already removed the Exchange Online license for the mailbox, and that directory synchronization has been configured. +This example removes the cloud-based mailbox that's associated with the on-premises mail user named Kim Akers. The mail user is automatically converted to a regular user. This example assumes that you've already removed the Exchange Online license for the mailbox, and that directory synchronization is configured. ### Example 2 ```powershell Disable-RemoteMailbox "David Strome" -Archive ``` -This example removes the cloud-based archive mailbox but keeps the cloud-based mailbox that's associated with the on-premises mail user named David Strome. This example assumes directory synchronization has been configured. +This example removes the cloud-based archive mailbox but keeps the cloud-based mailbox that's associated with the on-premises mail user named David Strome. This example assumes directory synchronization is configured. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the cloud-based mailbox. Valid values are: - ADObjectID @@ -82,7 +86,6 @@ The Identity parameter specifies the cloud-based mailbox. Valid values are: Type: RemoteMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Archive switch specifies whether to disconnect the cloud-based archive mailbox from the associated cloud-based mailbox. You don't need to specify a value with this switch. The on-premises mail user and its associated cloud-based mailbox aren't removed if you use this switch. @@ -100,7 +106,6 @@ The on-premises mail user and its associated cloud-based mailbox aren't removed Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -121,7 +129,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,6 +156,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -158,7 +170,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +179,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreLegalHold switch ignores the legal hold status of the remote user. You don't need to specify a value with this switch. This switch disables the instance of the remote object in the on-premises organization, and the request to disable the mailbox is synchronized to the cloud. However, if the cloud mailbox is on hold, the request to disable the mailbox is blocked, and an error is returned. @@ -176,7 +190,6 @@ This switch disables the instance of the remote object in the on-premises organi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-ReportSubmissionRule.md similarity index 84% rename from exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-ReportSubmissionRule.md index 8e8073a184..95727eff23 100644 --- a/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-reportsubmissionrule applicable: Exchange Online -title: Disable-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-reportsubmissionrule +schema: 2.0.0 +title: Disable-ReportSubmissionRule --- # Disable-ReportSubmissionRule @@ -28,7 +29,7 @@ Disable-ReportSubmissionRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,13 +43,15 @@ This example disables the report submission rule if it's already enabled. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission rule that you want to disable. The default rule is named DefaultReportSubmissionRule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -69,7 +75,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-SafeAttachmentRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-SafeAttachmentRule.md index 35ef4b854d..ee21f6286e 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-safeattachmentrule applicable: Exchange Online -title: Disable-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-safeattachmentrule +schema: 2.0.0 +title: Disable-SafeAttachmentRule --- # Disable-SafeAttachmentRule @@ -30,7 +31,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example disables the safe attachment rule named Engineering Department Atta ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the enabled safe attachment rule that you want to disable. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -77,7 +83,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-SafeLinksRule.md similarity index 85% rename from exchange/exchange-ps/exchange/Disable-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-SafeLinksRule.md index fa714bf72f..24f062ac31 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-safelinksrule applicable: Exchange Online -title: Disable-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-safelinksrule +schema: 2.0.0 +title: Disable-SafeLinksRule --- # Disable-SafeLinksRule @@ -30,7 +31,7 @@ Disable-SafeLinksRule [-Identity] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example disables the enabled Safe Links rule named Engineering Department U ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the enabled Safe Links rule that you want to disable. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -77,7 +83,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md b/exchange/exchange-ps/ExchangePowerShell/Disable-ServiceEmailChannel.md similarity index 83% rename from exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-ServiceEmailChannel.md index 13a29e56ed..0a53d8ae61 100644 --- a/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-ServiceEmailChannel.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-serviceemailchannel -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-ServiceEmailChannel -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-serviceemailchannel +schema: 2.0.0 +title: Disable-ServiceEmailChannel --- # Disable-ServiceEmailChannel @@ -31,7 +32,7 @@ Disable-ServiceEmailChannel [-Identity] ## DESCRIPTION The Disable-ServiceEmailChannel cmdlet deletes the receive folder in the user's mailbox under the root folder. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example disables the .NET service channel for the user Jeff Hay without req ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the user for which you want to enable the .NET service channel. The user specified must be a valid user in Active Directory who has an Exchange mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -78,7 +82,6 @@ You can use any value that uniquely identifies the mailbox. For example: Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -99,7 +105,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md b/exchange/exchange-ps/ExchangePowerShell/Disable-SmtpDaneInbound.md similarity index 81% rename from exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-SmtpDaneInbound.md index 927fd4cd53..9c28890fee 100644 --- a/exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-SmtpDaneInbound.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-smtpdaneinbound +schema: 2.0.0 +title: Disable-SmtpDaneInbound --- # Disable-SmtpDaneInbound @@ -30,7 +31,7 @@ Disable-SmtpDaneInbound [-DomainName] ## DESCRIPTION For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example disables SMTP DANE for mail sent to contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + 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 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -76,13 +81,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-SweepRule.md similarity index 80% rename from exchange/exchange-ps/exchange/Disable-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-SweepRule.md index 225c628693..a4cef4646f 100644 --- a/exchange/exchange-ps/exchange/Disable-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-SweepRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-sweeprule -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-SweepRule -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-sweeprule +schema: 2.0.0 +title: Disable-SweepRule --- # Disable-SweepRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Disable-SweepRule cmdlet to disable Sweep rules in mailboxes. @@ -30,7 +31,7 @@ Disable-SweepRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example disables all Sweep rules in the specified mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Sweep rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). @@ -61,7 +65,6 @@ The Identity parameter specifies the Sweep rule that you want to disable. You ca Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the rule you want to disable. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +135,6 @@ The Mailbox parameter specifies the mailbox that contains the rule you want to d Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Disable-TransportAgent.md similarity index 81% rename from exchange/exchange-ps/exchange/Disable-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-TransportAgent.md index 5ccd3fab73..3eaed77483 100644 --- a/exchange/exchange-ps/exchange/Disable-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-transportagent -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-TransportAgent -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-transportagent +schema: 2.0.0 +title: Disable-TransportAgent --- # Disable-TransportAgent @@ -30,7 +31,7 @@ Disable-TransportAgent [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example shows how a fictitious application named Test App is disabled in th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the display name of the transport agent to be disabled. The length of the name can't exceed 64 characters. ```yaml Type: TransportAgentObjectId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -71,7 +77,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -89,7 +97,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -111,7 +121,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-TransportRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Disable-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-TransportRule.md index 03d4189525..46e2f40a3a 100644 --- a/exchange/exchange-ps/exchange/Disable-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-TransportRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-transportrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Disable-TransportRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-transportrule +schema: 2.0.0 +title: Disable-TransportRule --- # Disable-TransportRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Disable-TransportRule cmdlet to disable transport rules (mail flow rules) in your organization. @@ -31,7 +32,7 @@ Disable-TransportRule [-Identity] ## DESCRIPTION To enable rules that are disabled, use the Enable-TransportRule cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example disables the rule named Sales Disclaimer. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the rule that you want to disable. You can use Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -76,7 +82,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -96,7 +104,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMAutoAttendant.md similarity index 83% rename from exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMAutoAttendant.md index 9a332903c9..55d93cb30b 100644 --- a/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Disable-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-umautoattendant +schema: 2.0.0 +title: Disable-UMAutoAttendant --- # Disable-UMAutoAttendant @@ -31,9 +32,9 @@ Disable-UMAutoAttendant [-Identity] ## DESCRIPTION The Disable-UMAutoAttendant cmdlet disables an existing UM auto attendant that's currently enabled. The Disable-UMAutoAttendant cmdlet disables the UM auto attendant by modifying its status variable. The Disable-UMAutoAttendant cmdlet can't disable the UM auto attendant if it's linked or associated to the UM hunt group associated with the default UM dial plan. -After this task is completed, the UM auto attendant is disabled and won't accept incoming calls. +After this task is completed, the UM auto attendant is disabled and doesn't accept incoming calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example disables the UM auto attendant MyUMAutoAttendant. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM auto attendant that's being disabled. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMCallAnsweringRule.md similarity index 87% rename from exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMCallAnsweringRule.md index d9f8154eaf..83930d80a6 100644 --- a/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: Disable-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-umcallansweringrule +schema: 2.0.0 +title: Disable-UMCallAnsweringRule --- # Disable-UMCallAnsweringRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Disable-UMCallAnsweringRule cmdlet to disable a call answering rule that has been created within a UM-enabled mailbox. +Use the Disable-UMCallAnsweringRule cmdlet to disable a call answering rule that is created within a UM-enabled mailbox. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -34,7 +35,7 @@ The Disable-UMCallAnsweringRule cmdlet disables the call answering rule by modif When the call answering rule is created, you should disable the call answering rule when you're setting up conditions and actions. This prevents the call answering rule from being processed when an incoming call is received until you've correctly configured the call answering rule. After this task is completed, the cmdlet sets the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,13 +63,15 @@ This example disables the call answering rule MyUMCallAnsweringRule in the mailb ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the UM call answering rule in a UM-enabled mailbox that's to be disabled. ```yaml Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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`. @@ -89,7 +95,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox that contains the UM call answering rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -134,7 +144,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMIPGateway.md similarity index 85% rename from exchange/exchange-ps/exchange/Disable-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMIPGateway.md index f0738b7185..99d701cbe6 100644 --- a/exchange/exchange-ps/exchange/Disable-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Disable-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-umipgateway +schema: 2.0.0 +title: Disable-UMIPGateway --- # Disable-UMIPGateway @@ -32,7 +33,7 @@ Disable-UMIPGateway [-Identity] ## DESCRIPTION The status variable for a UM IP gateway can be used to enable or disable call answering destined for the IP gateway. The Disable-UMIPGateway cmdlet disables a UM IP gateway in Active Directory by modifying its status variable. After this task is completed, the UM IP gateway no longer answers incoming calls or makes outgoing calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example disables the UM IP gateway MyUMIPGateway and disconnects all curren ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM IP gateway being disabled. This is the directory object ID for the UM IP gateway. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -80,7 +86,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -Immediate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Immediate parameter specifies whether the Mailbox server running the Microsoft Exchange Unified Messaging service drops incoming calls associated with this UM IP gateway immediately or waits for the current calls to finish processing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMMailbox.md similarity index 84% rename from exchange/exchange-ps/exchange/Disable-UMMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMMailbox.md index f9ea3dd8ba..de6a75d801 100644 --- a/exchange/exchange-ps/exchange/Disable-UMMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Disable-UMMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-ummailbox +schema: 2.0.0 +title: Disable-UMMailbox --- # Disable-UMMailbox @@ -33,7 +34,7 @@ Disable-UMMailbox [-Identity] ## DESCRIPTION After the mailbox is disabled for Unified Messaging, the user can no longer use the UM features that are included in Microsoft Exchange and the Microsoft Exchange Unified Messaging service no longer handle calls for the associated extension number. The mailbox continues to function normally for all other operations that are unrelated to Unified Messaging. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example disables Unified Messaging on the mailbox for tonysmith@contoso.com ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the mailbox that you want to disable for Unified Messaging. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the mailbox that you want to disable for Unifie Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -83,7 +89,6 @@ 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 Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -120,7 +130,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -130,16 +139,18 @@ Accept wildcard characters: False ``` ### -KeepProperties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The KeepProperties parameter specifies whether to keep or remove the UM properties for the mailbox. Valid values are: -- $true: The UM properties are retained on the mailbox. This is the default value. +- $true: The UM properties are retained on the mailbox. This value is the default. - $false: The UM properties are removed from the mailbox. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMServer.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMServer.md similarity index 84% rename from exchange/exchange-ps/exchange/Disable-UMServer.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMServer.md index 2b34bd0f25..090daef048 100644 --- a/exchange/exchange-ps/exchange/Disable-UMServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-umserver applicable: Exchange Server 2010 -title: Disable-UMServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-umserver +schema: 2.0.0 +title: Disable-UMServer --- # Disable-UMServer @@ -30,7 +31,7 @@ Disable-UMServer [-Identity] ``` ## DESCRIPTION -The Disable-UMServer cmdlet sets the status of a Unified Messaging server. A UM server has a logical status variable controlled using the enable and disable cmdlets. A UM server won't process any new calls unless it's in the enabled state. With this status variable, you can start or stop call processing on a UM server so the UM server can be brought online or taken offline in a controlled way. +The Disable-UMServer cmdlet sets the status of a Unified Messaging server. A UM server has a logical status variable controlled using the enable and disable cmdlets. A UM server doesn't process any new calls unless it's in the enabled state. With this status variable, you can start or stop call processing on a UM server so the UM server can be brought online or taken offline in a controlled way. After this task is completed, the UM server can no longer: @@ -39,7 +40,7 @@ After this task is completed, the UM server can no longer: - Be used to manage UM-enabled mailboxes - Be queried when a diagnostic task is used -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,13 +61,15 @@ This example disables Unified Messaging on the Unified Messaging server named My ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the identifier for the Unified Messaging server being disabled. This is the directory object ID for the UM server. ```yaml Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -85,7 +91,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -111,13 +118,15 @@ Accept wildcard characters: False ``` ### -Immediate + +> Applicable: Exchange Server 2010 + The Immediate parameter specifies whether the Unified Messaging server drops all current calls or enables current calls to finish. If this parameter is set to $true, all calls that are currently connected are disconnected. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMService.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMService.md similarity index 83% rename from exchange/exchange-ps/exchange/Disable-UMService.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMService.md index 48cc82a85b..f3f2b6c64a 100644 --- a/exchange/exchange-ps/exchange/Disable-UMService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-umservice applicable: Exchange Server 2013, Exchange Server 2016 -title: Disable-UMService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-umservice +schema: 2.0.0 +title: Disable-UMService --- # Disable-UMService @@ -32,7 +33,7 @@ Disable-UMService [-Identity] ``` ## DESCRIPTION -The Disable-UMService cmdlet sets the status of a UM server. A UM server has a logical status variable controlled using the enable and disable cmdlets. A UM server won't process any new calls unless it's in the enabled state. With this status variable, you can start or stop call processing on a UM server so the UM server can be brought online or taken offline in a controlled way. +The Disable-UMService cmdlet sets the status of a UM server. A UM server has a logical status variable controlled using the enable and disable cmdlets. A UM server doesn't process any new calls unless it's in the enabled state. With this status variable, you can start or stop call processing on a UM server so the UM server can be brought online or taken offline in a controlled way. After this task is completed, the UM server can no longer: @@ -41,7 +42,7 @@ After this task is completed, the UM server can no longer: - Be used to manage UM-enabled mailboxes. - Be queried when a diagnostic task is used. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example disables Unified Messaging on the UM server MyUMServer and disconne ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the Exchange 2010 UM server that you want to disable. You can use any value that uniquely identifies the UM server. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the Exchange 2010 UM server that you want to di Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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`. @@ -92,7 +98,6 @@ 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 Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -Immediate + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Immediate parameter specifies whether the UM server drops all current calls or enables current calls to finish. If this parameter is set to $true, all calls that are currently connected are disconnected. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md b/exchange/exchange-ps/ExchangePowerShell/Disconnect-ExchangeOnline.md similarity index 96% rename from exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md rename to exchange/exchange-ps/ExchangePowerShell/Disconnect-ExchangeOnline.md index c2a6bb1153..c79725b236 100644 --- a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disconnect-ExchangeOnline.md @@ -1,13 +1,13 @@ --- -external help file: ExchangeOnlineManagement-help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/disconnect-exchangeonline applicable: Exchange Online -title: Disconnect-ExchangeOnline -schema: 2.0.0 author: chrisda +external help file: ExchangeOnlineManagement-help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disconnect-exchangeonline +schema: 2.0.0 +title: Disconnect-ExchangeOnline --- # Disconnect-ExchangeOnline @@ -85,6 +85,9 @@ This example disconnects the REST-based Exchange Online PowerShell connections t ## PARAMETERS ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -94,7 +97,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -104,6 +106,9 @@ Accept wildcard characters: False ``` ### -ConnectionId + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.2.0 or later of the module. The ConnectionId parameter specifies the REST API connections to disconnect by ConnectionId. ConnectionId is a GUID value in the output of the Get-ConnectionInformation cmdlet that uniquely identifies a connection, even if you have multiple connections open. You can specify multiple ConnectionId values separated by commas. @@ -114,7 +119,6 @@ Don't use this parameter with the ModulePrefix parameter. Type: String[] Parameter Sets: ConnectionId Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -124,6 +128,9 @@ Accept wildcard characters: False ``` ### -ModulePrefix + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.2.0 or later of the module. The ModulePrefix parameter specifies the REST API connections to disconnect by ModulePrefix. When you use the Prefix parameter with the Connect-ExchangeOnline cmdlet, the specified text is added to the names of all Exchange Online cmdlets (for example, Get-InboundConnector becomes Get-ContosoInboundConnector). The ModulePrefix value is visible in the output of the Get-ConnectionInformation cmdlet. You can specify multiple ModulePrefix values separated by commas. @@ -134,7 +141,6 @@ Don't use this parameter with the ConnectionId parameter. Type: String[] Parameter Sets: ModulePrefix Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -144,13 +150,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Dismount-Database.md b/exchange/exchange-ps/ExchangePowerShell/Dismount-Database.md similarity index 80% rename from exchange/exchange-ps/exchange/Dismount-Database.md rename to exchange/exchange-ps/ExchangePowerShell/Dismount-Database.md index 7159912a4e..1cd64ef534 100644 --- a/exchange/exchange-ps/exchange/Dismount-Database.md +++ b/exchange/exchange-ps/ExchangePowerShell/Dismount-Database.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/dismount-database -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Dismount-Database -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/dismount-database +schema: 2.0.0 +title: Dismount-Database --- # Dismount-Database @@ -29,7 +30,7 @@ Dismount-Database [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ Regardless of where you run this cmdlet, it operates against the server hosting ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the database that you want to dismount. You can use any value that uniquely identifies the database. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the database that you want to dismount. You can Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -74,7 +80,6 @@ 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 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md b/exchange/exchange-ps/ExchangePowerShell/Dump-ProvisioningCache.md similarity index 78% rename from exchange/exchange-ps/exchange/Dump-ProvisioningCache.md rename to exchange/exchange-ps/ExchangePowerShell/Dump-ProvisioningCache.md index b16e9a249e..5b91af3edb 100644 --- a/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md +++ b/exchange/exchange-ps/ExchangePowerShell/Dump-ProvisioningCache.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/dump-provisioningcache -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Dump-ProvisioningCache -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/dump-provisioningcache +schema: 2.0.0 +title: Dump-ProvisioningCache --- # Dump-ProvisioningCache @@ -42,11 +43,11 @@ Dump-ProvisioningCache [-Server] -Application ``` ## DESCRIPTION -The Dump-ProvisioningCache cmdlet is for diagnostic purposes only and is rarely used. Exchange administrators or Microsoft support personnel may need to run this cmdlet to troubleshoot problems resulting from incorrect links or properties stamped on newly provisioned recipients, which can be caused by stale data in the provisioning cache. +The Dump-ProvisioningCache cmdlet is for diagnostic purposes only and is rarely used. Exchange administrators or Microsoft support personnel might need to run this cmdlet to troubleshoot problems resulting from incorrect links or properties stamped on newly provisioned recipients, which can be caused by stale data in the provisioning cache. The Dump-ProvisioningCache cmdlet displays a list of the Windows PowerShell provisioning cache keys. Use the value of these cache keys with the Reset-ProvisioningCache cmdlet to reset provisioning cache data. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,13 +61,15 @@ This example displays all cache keys for the specified server and Windows PowerS ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the fully qualified domain name (FQDN) of the server that the application you want to reset is running on. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Application + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Application parameter specifies the specific administrative application to reset the provisioning cache for. You can use the following values: - Powershell @@ -89,7 +95,6 @@ The Application parameter specifies the specific administrative application to r Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -GlobalCache + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GlobalCache switch specifies that all cache keys are cleared. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: GlobalCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -CacheKeys + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CacheKeys parameter specifies the value for the cache key that you want to clear. The format for the values should contain 32 digits separated by four dashes: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Use the Dump-ProvisioningCache cmdlet to return a list of cache keys. @@ -123,7 +133,6 @@ Use the Dump-ProvisioningCache cmdlet to return a list of cache keys. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -142,7 +154,6 @@ 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 Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -CurrentOrganization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CurrentOrganization switch specifies that the provision cache is reset for this organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: OrganizationCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -Organizations -The Organizations parameter specifies the organizations that the provisioning cache will be reset. This parameter is used in multi-tenant deployments. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Organizations parameter specifies the organizations where the provisioning cache is reset. This parameter is used in multi-tenant deployments. ```yaml Type: MultiValuedProperty Parameter Sets: OrganizationCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,13 +199,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-ATPProtectionPolicyRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-ATPProtectionPolicyRule.md index af887e025f..58eda1bbbf 100644 --- a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-atpprotectionpolicyrule applicable: Exchange Online -title: Enable-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-atpprotectionpolicyrule +schema: 2.0.0 +title: Enable-ATPProtectionPolicyRule --- # Enable-ATPProtectionPolicyRule @@ -32,7 +33,7 @@ The State property in rules that are associated with preset security policies in 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ In organizations with Defender for Office 365, this example turns on the Standar ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Enable-AddressListPaging.md b/exchange/exchange-ps/ExchangePowerShell/Enable-AddressListPaging.md similarity index 81% rename from exchange/exchange-ps/exchange/Enable-AddressListPaging.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-AddressListPaging.md index 7bdc8deb33..93281b268d 100644 --- a/exchange/exchange-ps/exchange/Enable-AddressListPaging.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-AddressListPaging.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-addresslistpaging -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-AddressListPaging -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-addresslistpaging +schema: 2.0.0 +title: Enable-AddressListPaging --- # Enable-AddressListPaging @@ -30,7 +31,7 @@ Enable-AddressListPaging [-Confirm] ## DESCRIPTION The Enable-AddressListPaging cmdlet creates the Address List container in Active Directory. Recipient cmdlets, such as Get-Recipient, use the information written to the container to quickly retrieve recipient data. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example enables virtual list view for your organization. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -53,7 +57,6 @@ 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 Required: False Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-AntiPhishRule.md similarity index 82% rename from exchange/exchange-ps/exchange/Enable-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-AntiPhishRule.md index 55bc463ac2..9cd62cc3f6 100644 --- a/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: Enable-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-antiphishrule +schema: 2.0.0 +title: Enable-AntiPhishRule --- # Enable-AntiPhishRule @@ -28,7 +29,7 @@ Enable-AntiPhishRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example enables the antiphish rule named Marketing Department Phishing Rule ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the antiphish rule that you want to enable. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md b/exchange/exchange-ps/ExchangePowerShell/Enable-AntispamUpdates.md similarity index 82% rename from exchange/exchange-ps/exchange/Enable-AntispamUpdates.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-AntispamUpdates.md index 40a8ec1a57..ca733a5aae 100644 --- a/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-AntispamUpdates.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-antispamupdates -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-AntispamUpdates -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-antispamupdates +schema: 2.0.0 +title: Enable-AntispamUpdates --- # Enable-AntispamUpdates @@ -41,13 +42,15 @@ This cmdlet was deprecated in Microsoft Exchange Server 2010 Service Pack 1 and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -57,13 +60,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -73,13 +78,15 @@ Accept wildcard characters: False ``` ### -SpamSignatureUpdatesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +96,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-App.md b/exchange/exchange-ps/ExchangePowerShell/Enable-App.md similarity index 79% rename from exchange/exchange-ps/exchange/Enable-App.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-App.md index 788dc99c86..dfe13783a8 100644 --- a/exchange/exchange-ps/exchange/Enable-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-App.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-app -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-App -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-app +schema: 2.0.0 +title: Enable-App --- # Enable-App ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Enable-App cmdlet to enable (turn on) a specific app for a specific user. @@ -30,11 +31,11 @@ Enable-App [-Identity] ``` ## DESCRIPTION -The Enable-App cmdlet requires that the specified app has already been installed (for example, that it has been installed with the New-App cmdlet, or that it's a default app for Microsoft Outlook). +The Enable-App cmdlet requires that the specified app has already been installed (for example, that it is installed with the New-App cmdlet, or that it's a default app for Microsoft Outlook). For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://learn.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://learn.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,13 +63,15 @@ This example enables the Share to Teams app for user Tony. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID of the app. ```yaml Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -87,7 +93,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -105,7 +113,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -132,7 +142,6 @@ The Mailbox parameter specifies the mailbox. You can use any value that uniquely Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md b/exchange/exchange-ps/ExchangePowerShell/Enable-CmdletExtensionAgent.md similarity index 75% rename from exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-CmdletExtensionAgent.md index 588d8f1d9a..bb9a5e1e05 100644 --- a/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-CmdletExtensionAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-cmdletextensionagent -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-CmdletExtensionAgent -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-cmdletextensionagent +schema: 2.0.0 +title: Enable-CmdletExtensionAgent --- # Enable-CmdletExtensionAgent @@ -29,13 +30,13 @@ Enable-CmdletExtensionAgent [-Identity] ``` ## DESCRIPTION -Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or third-party products can't use cmdlet extension agents. +Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or non-Microsoft products can't use cmdlet extension agents. When you enable a cmdlet extension agent, the agent is run on every Exchange server in the organization. When an agent is enabled, it's made available to cmdlets that can then use the agent to perform additional operations. -Before you enable agents, be sure that you're aware of how the agent works and what impact the agent will have on your organization. +Before you enable agents, be sure that you're aware of how the agent works and what effect the agent can have on your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,11 +45,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Enable-CmdletExtensionAgent "Scripting Agent" ``` -This example enables the cmdlet extension agent named Scripting Agent. Before you enable the Scripting Agent, you need to configure the %ExchangeInstallPath%Bin\\CmdletExtensionAgents\\ScriptingAgentConfig.xml.sample file and rename it to ScriptingAgentConfig.xml on all the Exchange servers in your organization. If you don't, all non-Get cmdlets will fail. +This example enables the cmdlet extension agent named Scripting Agent. Before you enable the Scripting Agent, you need to configure the `%ExchangeInstallPath%Bin\CmdletExtensionAgents\ScriptingAgentConfig.xml.sample` file and rename it to `ScriptingAgentConfig.xml` on all the Exchange servers in your organization. If you don't configure the file, all non-Get cmdlets will fail. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the disabled cmdlet extension agent that you want to enable. You can use any value that uniquely identifies the agent. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the disabled cmdlet extension agent that you wa Type: CmdletExtensionAgentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -78,7 +84,6 @@ 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 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md b/exchange/exchange-ps/ExchangePowerShell/Enable-ComplianceTagStorage.md similarity index 91% rename from exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-ComplianceTagStorage.md index c2a69f5215..7eaaed4768 100644 --- a/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-ComplianceTagStorage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-compliancetagstorage applicable: Security & Compliance -title: Enable-ComplianceTagStorage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-compliancetagstorage +schema: 2.0.0 +title: Enable-ComplianceTagStorage --- # Enable-ComplianceTagStorage @@ -29,7 +30,7 @@ Enable-ComplianceTagStorage ``` ## DESCRIPTION -You can check the status by running the following command: `Get-ComplianceTagStorage | Format-List Enabled,DistributionStatus`. The value True for the Enabled property and the value Success for the DistributionStatus property indicates the Enable-ComplianceTagStorage cmdlet has already been run in the organization, and you don't need to run it again. If you run the cmdlet unnecessarily, you'll get a warning, and the DistributionStatus property changes to the value Pending for a few minutes before returning to the value Success. +You can check the status by running the following command: `Get-ComplianceTagStorage | Format-List Enabled,DistributionStatus`. The value True for the Enabled property and the value Success for the DistributionStatus property indicates the Enable-ComplianceTagStorage cmdlet has already been run in the organization, and you don't need to run it again. If you run the cmdlet unnecessarily, you get a warning, and the DistributionStatus property changes to the value Pending for a few minutes before returning to the value Success. To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). @@ -45,6 +46,9 @@ This example creates the label policy in the Microsoft Purview compliance portal ## PARAMETERS ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -54,7 +58,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -RecordsManagementSecurityGroupEmail + +> Applicable: Security & Compliance + This RecordsManagementSecurityGroupEmail parameter specifies the email address of the mail-enabled security group that contains the records managers in the organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Enable-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Enable-DistributionGroup.md similarity index 84% rename from exchange/exchange-ps/exchange/Enable-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-DistributionGroup.md index cda305dfb4..2687d8df3f 100644 --- a/exchange/exchange-ps/exchange/Enable-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-DistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-distributiongroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-DistributionGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-distributiongroup +schema: 2.0.0 +title: Enable-DistributionGroup --- # Enable-DistributionGroup @@ -34,7 +35,7 @@ Enable-DistributionGroup [-Identity] ## DESCRIPTION The Enable-DistributionGroup cmdlet mail-enables existing universal security groups and universal distribution groups by adding the email attributes that are required by Exchange. Mail-enabled security groups and distribution groups are visible to the other \*-DistributionGroup cmdlets and to the \*-DistributionGroupMember cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. @@ -50,6 +51,9 @@ This example mail-enables the universal distribution group named Distribution Gr ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the universal security group or universal distribution group that you want to mail-enable. You can use any value that uniquely identifies the group. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the universal security group or universal distr Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -95,7 +101,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -114,7 +122,6 @@ 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 Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,15 +167,17 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. -By default, the primary SMTP address is generated based on the default email address policy and the value of the Alias parameter or the Name property. If you use the PrimarySmtpAddress parameter to specify the primary email address, the EmailAddressPolicyEnabled property is set to the value False, which means the email addresses of the group won't be automatically updated by email address policies. +By default, the primary SMTP address is generated based on the default email address policy and the value of the Alias parameter or the Name property. If you use the PrimarySmtpAddress parameter to specify the primary email address, the EmailAddressPolicyEnabled property is set to the value False, which means the email addresses of the group aren't automatically updated by email address policies. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Enable-DnssecForVerifiedDomain.md similarity index 79% rename from exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-DnssecForVerifiedDomain.md index 45d2f19537..d538718ea9 100644 --- a/exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-DnssecForVerifiedDomain.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-dnssecforverifieddomain +schema: 2.0.0 +title: Enable-DnssecForVerifiedDomain --- # Enable-DnssecForVerifiedDomain @@ -32,7 +33,7 @@ The output of this cmdlet is an MX record value that you need to add to DNS for 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +47,15 @@ This example enables DNSSEC for mail sent to contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + 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 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named @@ -94,7 +101,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS diff --git a/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-EOPProtectionPolicyRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-EOPProtectionPolicyRule.md index a73b54c47d..a71a9634b9 100644 --- a/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: Enable-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-eopprotectionpolicyrule +schema: 2.0.0 +title: Enable-EOPProtectionPolicyRule --- # Enable-EOPProtectionPolicyRule @@ -32,7 +33,7 @@ The State property in rules that are associated with preset security policies in 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ In organizations with Defender for Office 365, this example turns on the Standar ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +69,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -84,7 +90,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Enable-ExchangeCertificate.md similarity index 85% rename from exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-ExchangeCertificate.md index 29cc1af6d3..1d585aa2b4 100644 --- a/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-exchangecertificate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-ExchangeCertificate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-exchangecertificate +schema: 2.0.0 +title: Enable-ExchangeCertificate --- # Enable-ExchangeCertificate @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-ExchangeCertificate cmdlet to enable an existing certificate on the Exchange server for Exchange services such as Internet Information Services (IIS), SMTP, POP, IMAP and Unified Messaging (UM). Once you enable a certificate for a service, you can't disable it. -To see the existing certificates that are used for Exchange services, use [Get-ExchangeCertificate](https://learn.microsoft.com/powershell/module/exchange/get-exchangecertificate). +To see the existing certificates that are used for Exchange services, use [Get-ExchangeCertificate](https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangecertificate). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -56,7 +57,7 @@ There are many factors to consider when you configure certificates for Transport Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center, and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). For more information, see [Exchange Server TLS configuration best practices](https://learn.microsoft.com/Exchange/exchange-tls-configuration). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,6 +71,9 @@ This example enables a certificate for POP, IMAP, SMTP and IIS services. ## PARAMETERS ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Thumbprint parameter specifies the certificate that you want to configure. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. @@ -78,7 +82,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: String Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the certificate that you want to configure. Valid values are: - `ServerNameOrFQDN\Thumbprint` @@ -103,7 +109,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: ExchangeCertificateIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Services + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Services parameter specifies the Exchange services that the certificate is enabled for. Valid values are: - Federation: Don't use this command to enable a certificate for federation. Creating or modifying a federation trust enables or modifies how certificates are used for federation. You manage the certificates that used for federation trusts with the New-FederationTrust and Set-FederationTrust cmdlets. @@ -127,13 +135,12 @@ You can specify multiple values separated by commas. The values that you specify with this parameter are additive. When you enable a certificate for one or more services, any existing services remain in the Services property and you can't remove the existing services. Instead, configure another certificate for the services and then remove the certificate that you don't want to use. -Different services have different certificate requirements. For example, some services may require a server name in the certificate's Subject Name or Subject Alternative Name fields, but other services may require an FQDN. Verify that the certificate supports the services that you want to configure. +Different services have different certificate requirements. For example, some services might require a server name in the certificate's Subject Name or Subject Alternative Name fields, but other services might require an FQDN. Verify that the certificate supports the services that you want to configure. ```yaml Type: AllowedServices Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -143,6 +150,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -152,7 +162,6 @@ 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 Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -170,7 +182,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,6 +191,9 @@ Accept wildcard characters: False ``` ### -DoNotRequireSsl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DoNotRequireSsl switch prevents the command from enabling the "require SSL" setting on the default web site when you enable the certificate for IIS. You don't need to specify a value with this switch. If you don't use this switch, and you use the Services parameter to enable the certificate for IIS, the command enables the "require SSL" setting for the default web site in IIS. @@ -188,7 +202,6 @@ If you don't use this switch, and you use the Services parameter to enable the c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -208,7 +224,6 @@ By default, when you enable a certificate for SMTP, the command prompts you to r Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -218,13 +233,15 @@ Accept wildcard characters: False ``` ### -NetworkServiceAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NetworkServiceAllowed switch gives the built-in Network Service account permission to read the certificate's private key without enabling the certificate for SMTP. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -234,6 +251,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -249,7 +269,6 @@ You can't use this parameter with the Identity parameter, but you can use it wit Type: ServerIdParameter Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,13 +278,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-HostedContentFilterRule.md similarity index 84% rename from exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-HostedContentFilterRule.md index 8b49e06134..3bed2ac086 100644 --- a/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection -title: Enable-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-hostedcontentfilterrule +schema: 2.0.0 +title: Enable-HostedContentFilterRule --- # Enable-HostedContentFilterRule @@ -28,7 +29,7 @@ Enable-HostedContentFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example enables the disabled spam filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the spam filter rule that you want to enable. Y Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-HostedOutboundSpamFilterRule.md similarity index 82% rename from exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-HostedOutboundSpamFilterRule.md index b0b6d2ea45..4db53e86eb 100644 --- a/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: Enable-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-hostedoutboundspamfilterrule +schema: 2.0.0 +title: Enable-HostedOutboundSpamFilterRule --- # Enable-HostedOutboundSpamFilterRule @@ -28,7 +29,7 @@ Enable-HostedOutboundSpamFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example enables the disabled outbound spam filter rule named Contoso Execut ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the outbound spam filter rule that you want to Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Enable-IPv6ForAcceptedDomain.md similarity index 81% rename from exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-IPv6ForAcceptedDomain.md index 1ce4f5db89..faceb49a5d 100644 --- a/exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-IPv6ForAcceptedDomain.md @@ -1,12 +1,12 @@ --- -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 +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-ipv6foraccepteddomain +schema: 2.0.0 +title: Enable-IPv6ForAcceptedDomain --- # Enable-IPv6ForAcceptedDomain @@ -32,7 +32,7 @@ Use the Get-AcceptedDomain cmdlet to return accepted domains in the Exchange Onl 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +46,15 @@ This example enables IPv6 support for mail sent to contoso.com. Mail can be deli ## PARAMETERS ### -Domain + +> Applicable: Exchange Online + 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 @@ -62,13 +64,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -78,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-InboxRule.md similarity index 78% rename from exchange/exchange-ps/exchange/Enable-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-InboxRule.md index a4e38bdcbb..3ea7170fbb 100644 --- a/exchange/exchange-ps/exchange/Enable-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-InboxRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-inboxrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-InboxRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-inboxrule +schema: 2.0.0 +title: Enable-InboxRule --- # Enable-InboxRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Enable-InboxRule cmdlet to enable an Inbox rule. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. @@ -34,7 +35,7 @@ Enable-InboxRule [-Identity] ## DESCRIPTION When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example enables the Inbox rule named Move To Junk Mail in the mailbox that ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Inbox rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the Inbox rule that you want to enable. You can Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -94,7 +102,6 @@ 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 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -112,7 +122,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,17 +131,19 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. -A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. +A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules are removed by the actions of this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -159,7 +173,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -169,13 +182,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-JournalRule.md similarity index 78% rename from exchange/exchange-ps/exchange/Enable-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-JournalRule.md index a642ee6b6f..82ee42db15 100644 --- a/exchange/exchange-ps/exchange/Enable-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-JournalRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-journalrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-JournalRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-journalrule +schema: 2.0.0 +title: Enable-JournalRule --- # Enable-JournalRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Enable-JournalRule cmdlet to enable an existing journal rule on a Mailbox server. @@ -31,7 +32,7 @@ Enable-JournalRule [-Identity] ## DESCRIPTION You can enable or disable specific journal rules in your organization at any time using the Enable-JournalRule and Disable-JournalRule cmdlets. For more information, see [Journaling in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/journaling/journaling). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example enables the existing journal rule Brokerage Communications. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the journal rule you want to enable. Enter either the name or GUID of the journal rule. You can omit this parameter label. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -70,7 +76,6 @@ 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 Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -88,7 +96,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MailContact.md similarity index 84% rename from exchange/exchange-ps/exchange/Enable-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MailContact.md index 32afb576cd..fcf7d1cd3b 100644 --- a/exchange/exchange-ps/exchange/Enable-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MailContact.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailcontact -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-MailContact -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-mailcontact +schema: 2.0.0 +title: Enable-MailContact --- # Enable-MailContact @@ -38,7 +39,7 @@ Enable-MailContact [-Identity] -ExternalEmailAddress Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the non-mail-enabled contact that you want to mail-enable. You can use any value that uniquely identifies the contact. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the non-mail-enabled contact that you want to m Type: ContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. @@ -81,7 +87,6 @@ In on-premises environments, you can use the PrimarySMTPAddress parameter to set Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -115,7 +123,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -134,7 +144,6 @@ 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 Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisplayName parameter specifies the display name of the mail contact. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -176,9 +189,12 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: -- BinHex (This is the default value) +- BinHex (default value) - UuEncode - AppleSingle - AppleDouble @@ -192,7 +208,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,11 +217,14 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text - Html -- TextAndHtml (This is the default value) +- TextAndHtml (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -217,7 +235,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,10 +244,13 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are: - Text -- Mime (This is the default value) +- Mime (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -243,7 +263,6 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,6 +272,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. By default, the primary address is the same as the ExternalEmailAddress parameter value. @@ -263,7 +285,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,16 +294,18 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are: - $true: Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact. -- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This is the default value. +- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -292,13 +315,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MailPublicFolder.md similarity index 80% rename from exchange/exchange-ps/exchange/Enable-MailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MailPublicFolder.md index a029579014..215078a6d5 100644 --- a/exchange/exchange-ps/exchange/Enable-MailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MailPublicFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailpublicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-MailPublicFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-mailpublicfolder +schema: 2.0.0 +title: Enable-MailPublicFolder --- # Enable-MailPublicFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Enable-MailPublicFolder cmdlet to mail-enable public folders. @@ -32,7 +33,7 @@ Enable-MailPublicFolder [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example mail-enables the public folder Reports that's in the parent folder ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -61,7 +65,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -80,7 +86,6 @@ 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 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HiddenFromAddressListsEnabled parameter specifies whether the folder is hidden from address lists. Valid values are $true and $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -OverrideRecipientQuotas + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -132,7 +144,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -157,7 +171,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -167,13 +180,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MailUser.md similarity index 84% rename from exchange/exchange-ps/exchange/Enable-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MailUser.md index 0a00e13f2c..83842d063a 100644 --- a/exchange/exchange-ps/exchange/Enable-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MailUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailuser -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-MailUser -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-mailuser +schema: 2.0.0 +title: Enable-MailUser --- # Enable-MailUser @@ -54,7 +55,7 @@ The Enable-MailUser cmdlet mail-enables existing users by adding the email attri Mail users have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. Email messages sent to mail users are delivered to the specified external email address. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,6 +69,9 @@ This example mail-enables user John with the external email address john@contoso ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the user that you want to mail-enable. You can use any value that uniquely identifies the user. For example: - Name @@ -79,7 +83,6 @@ The Identity parameter specifies the user that you want to mail-enable. You can Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalEmailAddress parameter specifies an email address outside the organization. Email messages sent to the mail-enabled user are sent to this external address. ```yaml Type: ProxyAddress -Parameter Sets: EnabledUser +Parameter Sets: EnabledUser, EnableGuestUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -104,20 +109,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: ProxyAddress -Parameter Sets: EnableGuestUser -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Alias -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -142,7 +137,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +146,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -161,7 +158,6 @@ 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 Required: False Position: Named @@ -171,13 +167,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,13 +185,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,9 +203,12 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: -- BinHex (This is the default value) +- BinHex (default value) - UuEncode - AppleSingle - AppleDouble @@ -219,7 +222,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -229,11 +231,14 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text - Html -- TextAndHtml (This is the default value) +- TextAndHtml (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -244,7 +249,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,10 +258,13 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are: - Text -- Mime (This is the default value) +- Mime (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -270,7 +277,6 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,6 +286,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. By default, the primary address is the same as the ExternalEmailAddress parameter value. @@ -290,7 +299,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,16 +308,18 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are: - $true: Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact. -- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This is the default value. +- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This value is the default. ```yaml Type: Boolean Parameter Sets: EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -319,13 +329,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Enable-Mailbox.md similarity index 87% rename from exchange/exchange-ps/exchange/Enable-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-Mailbox.md index 3a49c7ac0c..c29fa8ab72 100644 --- a/exchange/exchange-ps/exchange/Enable-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-Mailbox.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Enable-Mailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-mailbox +schema: 2.0.0 +title: Enable-Mailbox --- # Enable-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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Enable-Mailbox cmdlet to create mailboxes for existing users who don't already have mailboxes. You can also use this cmdlet to create In-Place archives for existing mailboxes. @@ -272,7 +273,7 @@ The Enable-Mailbox cmdlet mailbox-enables existing users, public folders, or Ine When mailbox-enabling an existing user, beware of non-supported characters in the user account or Name property. If you don't specify an Alias value when you mailbox-enable the user, Exchange converts all non-supported characters to question marks (?). To avoid question marks in the Alias, verify that the user account and Name properties have only supported ASCII or Unicode characters or specify an Alias value when you mailbox-enable the user. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. @@ -302,6 +303,9 @@ This example creates a remote archive for the existing on-premises user named Ay ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the user or InetOrgPerson object that you want to mailbox-enable. You can use any value that uniquely identifies the user. For example: - Name @@ -313,7 +317,6 @@ The Identity parameter specifies the user or InetOrgPerson object that you want Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -323,6 +326,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Arbitration switch is required to mailbox-enable arbitration mailboxes. You don't need to specify a value with this switch. @@ -333,7 +339,6 @@ Arbitration mailboxes are system mailboxes that are used for storing different t Type: SwitchParameter Parameter Sets: Arbitration Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -343,6 +348,9 @@ Accept wildcard characters: False ``` ### -ArchiveDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArchiveDomain parameter specifies the domain in the cloud-based service where the archive that's associated with this mailbox exists. For example, if the SMTP email address of the user is tony@contoso.com, the SMTP domain could be archive.contoso.com. @@ -353,7 +361,6 @@ Only use this parameter if the archive is hosted in the cloud-based service. Type: SmtpDomain Parameter Sets: RemoteArchive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -363,6 +370,9 @@ Accept wildcard characters: False ``` ### -Discovery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Discovery switch is required to mailbox-enable Discovery mailboxes. You don't need to specify a value with this switch. @@ -373,7 +383,6 @@ Discovery mailboxes are created as target mailboxes for Discovery searches. Afte Type: SwitchParameter Parameter Sets: Discovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -383,6 +392,9 @@ Accept wildcard characters: False ``` ### -Equipment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Equipment switch is required to mailbox-enable equipment mailboxes. You don't need to specify a value with this switch. @@ -393,7 +405,6 @@ Equipment mailboxes are resource mailboxes that aren't associated with a specifi Type: SwitchParameter Parameter Sets: Equipment Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -403,6 +414,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if the mailbox is a linked mailbox. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter. Use the fully qualified domain name (FQDN) of the domain controller that you want to use as the value for this parameter. @@ -413,7 +427,6 @@ This parameter is required only if you're enabling a linked mailbox. Type: String Parameter Sets: LinkedRoomMailbox, Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -423,6 +436,9 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: @@ -438,7 +454,6 @@ This parameter is required only if you're enabling a linked mailbox. Type: UserIdParameter Parameter Sets: LinkedRoomMailbox, Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -448,6 +463,9 @@ Accept wildcard characters: False ``` ### -LinkedRoom + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedRoom switch is required to mailbox-enable linked resource mailboxes. You don't need to specify a value with this switch. @@ -458,7 +476,6 @@ A linked resource mailbox is useful in a scenario where you have an account in a Type: SwitchParameter Parameter Sets: LinkedRoomMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -468,6 +485,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PublicFolder switch is required to mailbox-enable public folder mailboxes. You don't need to specify a value with this switch. @@ -478,7 +498,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -488,6 +507,9 @@ Accept wildcard characters: False ``` ### -Room + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Room switch is required to mailbox-enable room mailboxes. You don't need to specify a value with this switch. @@ -498,7 +520,6 @@ Room mailboxes are resource mailboxes that are associated with a specific locati Type: SwitchParameter Parameter Sets: Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -508,6 +529,9 @@ Accept wildcard characters: False ``` ### -Shared + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Shared switch is required to connect shared mailboxes. You don't need to specify a value with this switch. @@ -518,7 +542,6 @@ A shared mailbox is a mailbox where multiple users can log on to access the mail Type: SwitchParameter Parameter Sets: Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -528,6 +551,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ActiveSyncMailboxPolicy parameter specifies the mobile device mailbox policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example:. @@ -542,7 +568,6 @@ If you don't use this parameter, the default mobile device mailbox policy is app Type: MailboxPolicyIdParameter Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -552,6 +577,9 @@ Accept wildcard characters: False ``` ### -AddressBookPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AddressBookPolicy parameter specifies the address book policy that's applied to the mailbox. You can use any value that uniquely identifies the address book policy. For example: @@ -566,7 +594,6 @@ For more information about address book policies, see [Address book policies in Type: AddressBookMailboxPolicyIdParameter Parameter Sets: User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -576,6 +603,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. @@ -602,7 +632,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -612,13 +641,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Archive switch creates an archive mailbox for an existing user that already has a mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -628,6 +659,9 @@ Accept wildcard characters: False ``` ### -ArchiveDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArchiveDatabase parameter specifies the Exchange database that contains the archive that's associated with this mailbox. You can use any value that uniquely identifies the database. For example: @@ -640,7 +674,6 @@ The ArchiveDatabase parameter specifies the Exchange database that contains the Type: DatabaseIdParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -650,6 +683,9 @@ Accept wildcard characters: False ``` ### -ArchiveGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -658,7 +694,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -668,6 +703,9 @@ Accept wildcard characters: False ``` ### -ArchiveName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). In on-premises Exchange, if you don't use this parameter, the following default values are used based on the version of Exchange: @@ -684,7 +722,6 @@ In Outlook in Exchange Online, the value of this parameter is ignored. The name Type: MultiValuedProperty Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -694,6 +731,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -702,7 +742,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: AuditLog Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -712,6 +751,9 @@ Accept wildcard characters: False ``` ### -AutoExpandingArchive + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AutoExpandingArchive switch enables the auto-expanding archiving feature for the specified mailbox. You don't need to specify a value with this switch. @@ -727,7 +769,6 @@ After you enable auto-expanding archiving, additional storage space is automatic Type: SwitchParameter Parameter Sets: AutoExpandingArchive Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -737,6 +778,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -746,7 +790,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -756,6 +799,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Database parameter specifies the Exchange database that contains the new mailbox. You can use any value that uniquely identifies the database. For example: @@ -768,7 +814,6 @@ The Database parameter specifies the Exchange database that contains the new mai Type: DatabaseIdParameter Parameter Sets: Arbitration, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -778,6 +823,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -788,7 +836,6 @@ If you don't use DisplayName parameter, the value of the Name property is used f Type: String Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -798,6 +845,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -806,7 +856,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -816,6 +865,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -824,7 +876,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -834,19 +885,21 @@ Accept wildcard characters: False ``` ### -HoldForMigration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The HoldForMigration switch specifies whether to prevent any client or user, except the Microsoft Exchange Mailbox Replication service (MRS) process, from logging on to a public folder mailbox. You don't need to specify a value with this switch. You need to use this switch when you create the first public folder, which is called the hierarchy mailbox, in your organization. -Use this switch only if you plan to migrate legacy Exchange 2010 public folders to Exchange 2016. If you use this switch but don't have legacy public folders to migrate, you won't be able to create any public folders. +Use this switch only if you plan to migrate legacy Exchange 2010 public folders to Exchange 2016. If you use this switch but don't have legacy public folders to migrate, you can't create any public folders. ```yaml Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -856,6 +909,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the credentials used to access the domain controller that's specified by the LinkedDomainController parameter. This parameter is optional, even if you're enabling a linked mailbox. @@ -866,7 +922,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: LinkedRoomMailbox, Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -876,6 +931,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicy + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox policy to enable for the mailbox that you create. If you don't specify this parameter, the default managed folder mailbox policy is used. @@ -884,7 +942,6 @@ The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox po Type: MailboxPolicyIdParameter Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -894,6 +951,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicyAllowed + +> Applicable: Exchange Server 2010 + This parameter is available in Exchange Server 2010. The ManagedFolderMailboxPolicyAllowed switch specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for clients using versions of Outlook earlier than Office Outlook 2007. You don't need to specify a value with this switch. @@ -906,7 +966,6 @@ Outlook 2003 Service Pack 3 clients are supported but are provided limited funct Type: SwitchParameter Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -916,6 +975,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. @@ -926,7 +988,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -936,6 +997,9 @@ Accept wildcard characters: False ``` ### -RemoteArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoteArchive switch specifies that a remote archive mailbox is created for this mailbox. A remote archive exists in the cloud-based service. You don't need to specify a value with this switch. @@ -946,7 +1010,6 @@ You need to use this parameter with the ArchiveDomain parameter, and you can't u Type: SwitchParameter Parameter Sets: RemoteArchive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -956,6 +1019,9 @@ Accept wildcard characters: False ``` ### -RetentionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RetentionPolicy parameter specifies the retention policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example: @@ -970,7 +1036,6 @@ Retention policies consist of tags that are applied to mailbox folders and mail Type: MailboxPolicyIdParameter Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -980,6 +1045,9 @@ Accept wildcard characters: False ``` ### -RoleAssignmentPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RoleAssignmentPolicy parameter specifies the management role assignment policy that's assigned to the mailbox. You can use any value that uniquely identifies the policy. For example: - Name @@ -992,7 +1060,6 @@ If you don't use this parameter, the default role assignment policy is used. If Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1002,13 +1069,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MailboxQuarantine.md similarity index 84% rename from exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MailboxQuarantine.md index 94f1b1b2d7..fbb199722f 100644 --- a/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MailboxQuarantine.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailboxquarantine -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-MailboxQuarantine -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-mailboxquarantine +schema: 2.0.0 +title: Enable-MailboxQuarantine --- # Enable-MailboxQuarantine @@ -53,7 +54,7 @@ Enable-MailboxQuarantine -Database -StoreMailboxIdentity < ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example quarantines the mailbox for the user Brian Johnson. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013 + The Identity parameter specifies the mailbox that you want to quarantine. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -84,9 +88,8 @@ You can't use this parameter with the Database parameter. ```yaml Type: GeneralMailboxIdParameter -Parameter Sets: MailboxIdentity +Parameter Sets: MailboxIdentity, MailboxOrMailUserIdentity Aliases: -Applicable: Exchange Server 2013 Required: True Position: 1 @@ -95,20 +98,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: MailboxOrMailUserIdentity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -Database -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Database The Database parameter specifies the database that contains the mailboxes you want to quarantine. You can use any value that uniquely identifies the database. For example: - Name @@ -123,7 +116,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -133,6 +125,9 @@ Accept wildcard characters: False ``` ### -StoreMailboxIdentity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StoreMailboxIdentity parameter specifies the mailbox that you want to quarantine when you use the Database parameter. You identify the mailbox by its GUID value. You can find the GUID value by using the Get-Mailbox or Get-MailboxStatistics cmdlets. @@ -143,7 +138,6 @@ You can't use this parameter with the Identity parameter. Type: StoreMailboxIdParameter Parameter Sets: StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -153,6 +147,9 @@ Accept wildcard characters: False ``` ### -AllowMigration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AllowMigration switch allows a quarantined mailbox to be moved to another mailbox database or to the cloud. You don't need to specify a value with this switch. Moving a mailbox is one method of correcting data corruption that's required before releasing the mailbox from quarantine. @@ -161,7 +158,6 @@ Moving a mailbox is one method of correcting data corruption that's required bef Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +167,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -182,7 +181,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,6 +190,9 @@ Accept wildcard characters: False ``` ### -Duration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Duration parameter specifies how long the mailbox should remain quarantined. The default value is 24 hours. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -200,7 +201,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,13 +210,15 @@ Accept wildcard characters: False ``` ### -QuarantineReason + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QuarantineReason parameter specifies why you quarantined the mailbox. The maximum length is 255 characters. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: StoreMailboxIdentity, MailboxOrMailUserIdentity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -226,13 +228,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MalwareFilterRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MalwareFilterRule.md index d671effeae..d22115dc1d 100644 --- a/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MalwareFilterRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-malwarefilterrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Enable-MalwareFilterRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-malwarefilterrule +schema: 2.0.0 +title: Enable-MalwareFilterRule --- # Enable-MalwareFilterRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Enable-MalwareFilterRule cmdlet to enable malware filter rules in your organization. @@ -29,7 +30,7 @@ Enable-MalwareFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example enables the disabled malware filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter rule that you want to enable. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -86,7 +94,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MetaCacheDatabase.md similarity index 82% rename from exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MetaCacheDatabase.md index 642a0ec9b8..c313a87911 100644 --- a/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MetaCacheDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-metacachedatabase -applicable: Exchange Server 2019 -title: Enable-MetaCacheDatabase -schema: 2.0.0 +applicable: Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-metacachedatabase +schema: 2.0.0 +title: Enable-MetaCacheDatabase --- # Enable-MetaCacheDatabase @@ -28,7 +29,7 @@ Enable-MetaCacheDatabase -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example enables the metacache database on the Exchange server named Mailbox ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Mailbox server where you want to enable the metacache database. You can use any value that uniquely identifies the server. For example: - Name @@ -55,7 +59,6 @@ You can specify multiple values separated by commas. If the value contains space Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: True Position: Named @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019, Exchange Server SE + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019, Exchange Server SE + 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 diff --git a/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md b/exchange/exchange-ps/ExchangePowerShell/Enable-OrganizationCustomization.md similarity index 74% rename from exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-OrganizationCustomization.md index 23f178be9e..92019b3cd6 100644 --- a/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-OrganizationCustomization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-organizationcustomization applicable: Exchange Online, Exchange Online Protection -title: Enable-OrganizationCustomization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-organizationcustomization +schema: 2.0.0 +title: Enable-OrganizationCustomization --- # Enable-OrganizationCustomization @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -You may be prompted to run the EnableOrganizationCustomization cmdlet before you create or modify objects in your Exchange Online organization. +You might be prompted to run the EnableOrganizationCustomization cmdlet before you create or modify objects in your Exchange Online organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -27,7 +28,7 @@ Enable-OrganizationCustomization [-Confirm] ``` ## DESCRIPTION -In the Microsoft datacenters, certain objects are consolidated to save space. When you use Exchange Online PowerShell or the Exchange admin center to modify one of these objects for the first time, you may encounter an error message that tells you to run the Enable-OrganizationCustomization cmdlet. +In the Microsoft datacenters, certain objects are consolidated to save space. When you use Exchange Online PowerShell or the Exchange admin center to modify one of these objects for the first time, you might encounter an error message that tells you to run the Enable-OrganizationCustomization cmdlet. Here are some examples of when you might see this: @@ -38,11 +39,11 @@ Here are some examples of when you might see this: - Creating a new retention policy or modifying a built-in retention policy. - Enabling preset security policies in the Microsoft Defender portal. -Note that you are only required to run the Enable-OrganizationCustomization cmdlet once in your Exchange Online organization. If you attempt to run the cmdlet again, you'll get an error. +You are only required to run the Enable-OrganizationCustomization cmdlet once in your Exchange Online organization. If you attempt to run the cmdlet again, you get an error. -Whether or not this command has been previously run in an organization is available in the IsDehydrated property of the Get-OrganizationConfig cmdlet: False ($false) = the command has already been run; True ($true) = the command has never been run. +Whether or not this command is previously run in an organization is available in the IsDehydrated property of the Get-OrganizationConfig cmdlet: False ($false) = the command has already been run; True ($true) = the command has never been run. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,6 +57,9 @@ This example runs the command as required. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -65,7 +69,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md b/exchange/exchange-ps/ExchangePowerShell/Enable-OutlookAnywhere.md similarity index 80% rename from exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-OutlookAnywhere.md index f2706fde72..300964c824 100644 --- a/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-OutlookAnywhere.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-outlookanywhere applicable: Exchange Server 2010 -title: Enable-OutlookAnywhere -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-outlookanywhere +schema: 2.0.0 +title: Enable-OutlookAnywhere --- # Enable-OutlookAnywhere @@ -56,7 +57,7 @@ When you run this cmdlet, it can take as long as an hour for the settings to bec For more information about the different authentication methods that you can see in this article, see [Understanding HTTP Authentication](https://learn.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -84,6 +85,9 @@ This example enables the Exchange Client Access server for Outlook Anywhere. The ## PARAMETERS ### -ClientAuthenticationMethod + +> Applicable: Exchange Server 2010 + The ClientAuthenticationMethod parameter specifies the authentication method that the Autodiscover service provides to the Outlook Anywhere clients to authenticate to the Client Access server. Valid values are: - Basic @@ -91,13 +95,12 @@ The ClientAuthenticationMethod parameter specifies the authentication method tha This parameter must be specified if you don't use the DefaultAuthenticationMethod parameter. When you use this parameter without specifying the IISAuthenticationMethods parameter, IISAuthenticationMethods parameter is set to both NTLM and Basic. -Although this parameter only allows setting one authentication method, the command won't return an error if you include multiple values. +Although this parameter only allows setting one authentication method, the command doesn't return an error if you include multiple values. ```yaml Type: AuthenticationMethod Parameter Sets: CustomIdentity Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -DefaultAuthenticationMethod + +> Applicable: Exchange Server 2010 + The DefaultAuthenticationMethod parameter specifies whether to set both the ClientAuthenticationMethod and IISAuthenticationMethods parameters to the same authentication value. When you set an authentication value by using the DefaultAuthenticationMethod parameter, you force the specified authentication method to be used on the /rpc virtual directory in Internet Information Services (IIS). Valid values are: @@ -120,7 +126,6 @@ If the DefaultAuthenticationMethod parameter is specified, neither the ClientAut Type: AuthenticationMethod Parameter Sets: DefaultIdentity Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -130,13 +135,15 @@ Accept wildcard characters: False ``` ### -ExternalHostname + +> Applicable: Exchange Server 2010 + The ExternalHostname parameter specifies the external host name to use in the Outlook profiles for users enabled for Outlook Anywhere. ```yaml Type: Hostname Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -146,13 +153,15 @@ Accept wildcard characters: False ``` ### -SSLOffloading + +> Applicable: Exchange Server 2010 + The SSLOffloading parameter specifies whether the Client Access server requires Secure Sockets Layer (SSL). This value should be set only to $true when an SSL hardware solution is running in front of the Client Access server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -171,7 +183,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -181,13 +192,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -197,19 +210,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010 + The ExtendedProtectionFlags parameter is used to customize the options you use if you're using Extended Protection for Authentication. The possible values are: - None: Default setting. - Proxy: Specifies that a proxy is terminating the SSL channel. A Service Principal Name (SPN) must be registered in the ExtendedProtectionSPNList parameter if proxy mode is configured. -- ProxyCoHosting: Specifies that both HTTP and HTTPS traffic may be accessing the Client Access server and that a proxy is located between at least some of the clients and the Client Access server. +- ProxyCoHosting: Specifies that both HTTP and HTTPS traffic might be accessing the Client Access server and that a proxy is located between at least some of the clients and the Client Access server. - AllowDotlessSPN: Specifies whether you want to support valid SPNs that aren't in the fully qualified domain name (FQDN) format, for example ContosoMail. You specify valid SPNs with the ExtendedProtectionSPNList parameter. This option makes extended protection less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. -- NoServiceNameCheck: Specifies that the SPN list won't be checked to validate a channel binding token. This option makes Extended Protection for Authentication less secure. We generally don't recommend this setting. +- NoServiceNameCheck: Specifies that the SPN list isn't checked to validate a channel binding token. This option makes Extended Protection for Authentication less secure. We generally don't recommend this setting. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -219,18 +234,20 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the specified virtual directory. The possible values are: -- Null This is the default value. +- Null This value is the default. - Single SPN or comma delimited list of valid SPNs By default, you must specify the fully qualified domain name (FQDN) (for example mail.contoso.com) for each SPN. If you want to add an SPN that's not an FQDN (for example, ContosoMail), you must also use the ExtendedProtectionTokenChecking parameter with the AllowDotlessSPN value. You specify the domain in SPN format. The SPN format is `Protocol\FQDN` (for example, `HTTP/mail.contoso.com`). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -240,16 +257,16 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking -The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the specified Exchange virtual directory. Extended Protection for Authentication isn't enabled by default. The available settings are: -- None Extended Protection for Authentication won't be used. Connections between the client and Exchange won't use Extended Protection for Authentication on this virtual directory. This is the default setting. -- Allow Extended Protection for Authentication will be used for connections between the client and Exchange on this virtual directory if both the client and server support Extended Protection for Authentication. Connections that don't support Extended Protection for Authentication on the client and server will work, but may not be as secure as a connection using Extended Protection for Authentication. +> Applicable: Exchange Server 2010 -If you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the specified Exchange virtual directory. Extended Protection for Authentication isn't enabled by default. The available settings are: -- Require Extended Protection for Authentication will be used for all connections between clients and Exchange servers for this virtual directory. If either the client or server doesn't support Extended Protection for Authentication, the connection between the client and server will fail. If you set this option, you must also set a value for the ExtendedProtectionSPNList parameter. +- None Extended Protection for Authentication isn't used. Connections between the client and Exchange don't use Extended Protection for Authentication on this virtual directory. This is the default setting. +- Allow Extended Protection for Authentication is used for connections between the client and Exchange on this virtual directory if both the client and server support Extended Protection for Authentication. Connections that don't support Extended Protection for Authentication on the client and server work, but might not be as secure as a connection using Extended Protection for Authentication. +- Require Extended Protection for Authentication is used for all connections between clients and Exchange servers for this virtual directory. If either the client or server doesn't support Extended Protection for Authentication, the connection between the client and server will fail. If you set this option, you must also set a value for the ExtendedProtectionSPNList parameter. -If you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more SPNs using the parameter ExtendedProtectionSPNList. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. To learn more about Extended Protection for Authentication, see [Understanding Extended Protection for Authentication](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/ff459225(v=exchg.141)). @@ -257,7 +274,6 @@ To learn more about Extended Protection for Authentication, see [Understanding E Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -267,9 +283,12 @@ Accept wildcard characters: False ``` ### -IISAuthenticationMethods + +> Applicable: Exchange Server 2010 + The IISAuthenticationMethods parameter specifies the authentication method that's enabled on the /rpc virtual directory in IIS. You can set the virtual directory to allow Basic authentication or NTLM authentication. Alternatively, you can also set the virtual directory to allow both Basic and NTLM authentication. All other authentication methods are disabled. -You may want to enable both Basic and NTLM authentication if you're using the IIS virtual directory with multiple applications that require different authentication methods. +You might want to enable both Basic and NTLM authentication if you're using the IIS virtual directory with multiple applications that require different authentication methods. When you configure this setting using the IIS interface, you can enable as many authentication methods as you want. @@ -279,7 +298,6 @@ For more information about configuring this parameter with multiple values, see Type: MultiValuedProperty Parameter Sets: CustomIdentity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -289,6 +307,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Client Access server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -300,7 +321,6 @@ The Server parameter specifies the Client Access server where you want to run th Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -310,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-OutlookProtectionRule.md similarity index 79% rename from exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-OutlookProtectionRule.md index 63e2c39801..92310c39a2 100644 --- a/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-outlookprotectionrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-OutlookProtectionRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-outlookprotectionrule +schema: 2.0.0 +title: Enable-OutlookProtectionRule --- # Enable-OutlookProtectionRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS **Note**: This cmdlet is no longer supported in the cloud-based service. -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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Enable-OutlookProtectionRule cmdlet to enable an existing Outlook protection rule. @@ -33,7 +34,7 @@ Enable-OutlookProtectionRule [-Identity] ## DESCRIPTION Outlook protection rules are used to automatically Information Rights Management (IRM)-protect messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example enables the Outlook protection rule Project Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the rule being enabled. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -90,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md b/exchange/exchange-ps/ExchangePowerShell/Enable-PushNotificationProxy.md similarity index 83% rename from exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-PushNotificationProxy.md index e23369448c..e1737bfa73 100644 --- a/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-PushNotificationProxy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-pushnotificationproxy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-PushNotificationProxy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-pushnotificationproxy +schema: 2.0.0 +title: Enable-PushNotificationProxy --- # Enable-PushNotificationProxy @@ -33,7 +34,7 @@ Enable-PushNotificationProxy [-Confirm] ## DESCRIPTION The push notification proxy relays event notifications (for example, new email or calendar updates) for on-premises mailboxes through Microsoft 365 to Outlook on the web for devices on the user's device. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example enables the push notification proxy in the on-premises Exchange org ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -63,7 +67,6 @@ 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 Required: False Position: Named @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Organization parameter specifies the domain name of the Microsoft 365 organization. For example, contoso.onmicrosoft.com. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Uri parameter specifies the push notification service endpoint in Microsoft 365. The default value is . ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Enable-RemoteMailbox.md similarity index 86% rename from exchange/exchange-ps/exchange/Enable-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-RemoteMailbox.md index e2ca574784..46ead9cf77 100644 --- a/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-remotemailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-RemoteMailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-remotemailbox +schema: 2.0.0 +title: Enable-RemoteMailbox --- # Enable-RemoteMailbox @@ -101,7 +102,7 @@ Directory synchronization must be configured correctly for a mailbox to be creat The policies that you apply to recipients in the on-premises Exchange organization, such as Unified Messaging or compliance policies, aren't applied to mailboxes in the service. You must configure policies in the service if you want policies to be applied to recipients in the service. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -134,6 +135,9 @@ To mail-enable an on-premises user, create the associated mailbox in the service ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the existing on-premises user. You can use any value that uniquely identifies the user. For example: - ADObjectID @@ -148,7 +152,6 @@ The Identity parameter specifies the identity of the existing on-premises user. Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -158,6 +161,9 @@ Accept wildcard characters: False ``` ### -Equipment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox. You don't need to specify a value with this switch. Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers). @@ -168,7 +174,6 @@ You can't use this switch with the Room or Shared switches. Type: SwitchParameter Parameter Sets: Equipment, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -178,6 +183,9 @@ Accept wildcard characters: False ``` ### -Room + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Room switch specifies that the mailbox in the service should be created as a room resource mailbox. You don't need to specify a value with this switch. You can't use this switch with the Equipment or Shared switches. @@ -186,7 +194,6 @@ You can't use this switch with the Equipment or Shared switches. Type: SwitchParameter Parameter Sets: Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -196,6 +203,9 @@ Accept wildcard characters: False ``` ### -Shared + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + **Note**: This switch is available only in Exchange 2013 CU21 or later and Exchange 2016 CU10 or later. To use this switch, you also need to run setup.exe /PrepareAD. For more information, see [KB4133605](https://support.microsoft.com/help/4133605). The Shared switch specifies that the mailbox in the service should be created as a shared mailbox. You don't need to specify a value with this switch. @@ -206,7 +216,6 @@ You can't use this switch with the Room or Equipment switches. Type: SwitchParameter Parameter Sets: Shared Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -216,13 +225,15 @@ Accept wildcard characters: False ``` ### -ACLableSyncedObjectEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -232,6 +243,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -256,7 +270,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -266,13 +279,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Archive switch creates an archive mailbox for an existing cloud-based user that already has a mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -282,6 +297,9 @@ Accept wildcard characters: False ``` ### -ArchiveName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). If you don't use this parameter, the following default values are used based on the version of Exchange: @@ -296,7 +314,6 @@ In Outlook, the value of this parameter is ignored. The name of the archive mail Type: MultiValuedProperty Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -306,6 +323,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -315,7 +335,6 @@ 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 Required: False Position: Named @@ -325,13 +344,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisplayName parameter specifies the display name for the mailbox that's created in the service. The display name is visible in the Exchange admin center, address lists and Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -341,13 +362,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,13 +380,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -373,13 +398,15 @@ Accept wildcard characters: False ``` ### -RemoteRoutingAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoteRoutingAddress parameter specifies the SMTP address of the mailbox in the service that this user is associated with. ```yaml Type: ProxyAddress Parameter Sets: Default, Room, Equipment, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -389,13 +416,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-ReportSubmissionRule.md similarity index 84% rename from exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-ReportSubmissionRule.md index 9bf1aa79ac..8cb09e07a1 100644 --- a/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-reportsubmissionrule applicable: Exchange Online -title: Enable-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-reportsubmissionrule +schema: 2.0.0 +title: Enable-ReportSubmissionRule --- # Enable-ReportSubmissionRule @@ -28,7 +29,7 @@ Enable-ReportSubmissionRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,13 +43,15 @@ This example enables the report submission rule if it's already disabled. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission rule that you want to enable. The default rule is named DefaultReportSubmissionRule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-SafeAttachmentRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-SafeAttachmentRule.md index 2642212149..352b045c45 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-safeattachmentrule applicable: Exchange Online -title: Enable-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-safeattachmentrule +schema: 2.0.0 +title: Enable-SafeAttachmentRule --- # Enable-SafeAttachmentRule @@ -30,7 +31,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example enables the disabled safe attachment rule named Marketing Departmen ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the disabled safe attachment rule that you want to enable. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-SafeLinksRule.md similarity index 85% rename from exchange/exchange-ps/exchange/Enable-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-SafeLinksRule.md index 1314b22664..a488f199df 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-safelinksrule applicable: Exchange Online -title: Enable-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-safelinksrule +schema: 2.0.0 +title: Enable-SafeLinksRule --- # Enable-SafeLinksRule @@ -30,7 +31,7 @@ Enable-SafeLinksRule [-Identity] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example enables the disabled Safe Links rule named Marketing Department URL ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the disabled Safe Links rule that you want to enable. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md b/exchange/exchange-ps/ExchangePowerShell/Enable-ServiceEmailChannel.md similarity index 82% rename from exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-ServiceEmailChannel.md index 206921ec6f..3403dbce95 100644 --- a/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-ServiceEmailChannel.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-serviceemailchannel -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-ServiceEmailChannel -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-serviceemailchannel +schema: 2.0.0 +title: Enable-ServiceEmailChannel --- # Enable-ServiceEmailChannel @@ -31,7 +32,7 @@ Enable-ServiceEmailChannel [-Identity] ## DESCRIPTION The .NET service channel enables Microsoft Exchange to store information that it later forwards to applications or devices that aren't permanently connected to the server running Exchange. This cmdlet creates a receive folder in the user's mailbox under the root folder named Service E-mail. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example enables the .NET service channel for the user Tony Smith. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the user for which you want to enable the .NET service channel. The user specified must be a valid user in Active Directory who has an Exchange mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -78,7 +82,6 @@ You can use any value that uniquely identifies the mailbox. For example: Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -97,7 +103,6 @@ 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 Required: False Position: Named @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md b/exchange/exchange-ps/ExchangePowerShell/Enable-SmtpDaneInbound.md similarity index 81% rename from exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-SmtpDaneInbound.md index 84502bb3b4..0198844e56 100644 --- a/exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-SmtpDaneInbound.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-smtpdaneinbound +schema: 2.0.0 +title: Enable-SmtpDaneInbound --- # Enable-SmtpDaneInbound @@ -30,7 +31,7 @@ Enable-SmtpDaneInbound [-DomainName] ## DESCRIPTION For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example enables SMTP DANE for mail sent to contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + 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 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -76,13 +81,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-SweepRule.md similarity index 80% rename from exchange/exchange-ps/exchange/Enable-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-SweepRule.md index a5d16d3d5f..15e4c16b69 100644 --- a/exchange/exchange-ps/exchange/Enable-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-SweepRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-sweeprule -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-SweepRule -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-sweeprule +schema: 2.0.0 +title: Enable-SweepRule --- # Enable-SweepRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Enable-SweepRule cmdlet to enable Sweep rules in mailboxes. @@ -30,7 +31,7 @@ Enable-SweepRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example enables all Sweep rules in the specified mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Sweep rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). @@ -61,7 +65,6 @@ The Identity parameter specifies the Sweep rule that you want to enable. You can Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the rule you want to enable. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +135,6 @@ The Mailbox parameter specifies the mailbox that contains the rule you want to e Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Enable-TransportAgent.md similarity index 81% rename from exchange/exchange-ps/exchange/Enable-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-TransportAgent.md index 1985292cfa..2de9a60680 100644 --- a/exchange/exchange-ps/exchange/Enable-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-transportagent -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-TransportAgent -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-transportagent +schema: 2.0.0 +title: Enable-TransportAgent --- # Enable-TransportAgent @@ -30,7 +31,7 @@ Enable-TransportAgent [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example enables a fictitious application named Test App in the Transport se ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the display name of the transport agent to be enabled. The length of the name can't exceed 64 characters. ```yaml Type: TransportAgentObjectId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -69,7 +75,6 @@ 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 Required: False Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -87,7 +95,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,6 +104,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -109,7 +119,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-TransportRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Enable-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-TransportRule.md index 4f9a620693..7cda6c6bb0 100644 --- a/exchange/exchange-ps/exchange/Enable-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-TransportRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-transportrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Enable-TransportRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-transportrule +schema: 2.0.0 +title: Enable-TransportRule --- # Enable-TransportRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Enable-TransportRule cmdlet to enable transport rules (mail flow rules) in your organization. @@ -32,7 +33,7 @@ Enable-TransportRule [-Identity] ## DESCRIPTION To disable rules that are enabled, use the Disable-TransportRule cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example enables the transport rule named "Require approval of messages to c ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the rule that you want to enable. You can use a Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -82,7 +88,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -102,7 +110,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,19 +119,21 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Mode parameter specifies how the rule operates after it's enabled. Valid values are: -- Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery. +- Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would affect delivery. - AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. - Enforce: All actions specified in the rule are taken. -The value that has already been set in the rule will be persevered, unless -Mode parameter is specified. +If you don't use this parameter, the value already set in the rule is persevered. ```yaml Type: RuleMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMAutoAttendant.md similarity index 84% rename from exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMAutoAttendant.md index b5a6029718..6738fa8dca 100644 --- a/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Enable-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-umautoattendant +schema: 2.0.0 +title: Enable-UMAutoAttendant --- # Enable-UMAutoAttendant @@ -31,7 +32,7 @@ Enable-UMAutoAttendant [-Identity] ## DESCRIPTION The Enable-UMAutoAttendant cmdlet enables the UM auto attendant by modifying its status variable. When you create a UM auto attendant, it isn't enabled by default. For the auto attendant to answer incoming calls, you must first enable it. After this task is completed, the UM auto attendant answers incoming calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example enables the UM auto attendant MyUMAutoAttendant. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM auto attendant being enabled. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -70,7 +76,6 @@ 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 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMCallAnsweringRule.md similarity index 87% rename from exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMCallAnsweringRule.md index 871ebf54fd..d5f4e06300 100644 --- a/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: Enable-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-umcallansweringrule +schema: 2.0.0 +title: Enable-UMCallAnsweringRule --- # Enable-UMCallAnsweringRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Enable-UMCallAnsweringRule cmdlet to enable a call answering rule that has been created within a UM-enabled mailbox. +Use the Enable-UMCallAnsweringRule cmdlet to enable a call answering rule that is created within a UM-enabled mailbox. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -34,7 +35,7 @@ The Enable-UMCallAnsweringRule cmdlet enables the call answering rule by modifyi After this task is completed, the cmdlet sets the parameters and values specified. When you enable a call answering rule, the call answering rule is processed when an incoming call is received. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,13 +63,15 @@ This example enables the call answering rule MyUMCallAnsweringRule in the mailbo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the UM call answering rule in a UM-enabled mailbox that's to be enabled. ```yaml Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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`. @@ -87,7 +93,6 @@ 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 Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox that contains the UM call answering rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -132,7 +142,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMIPGateway.md similarity index 84% rename from exchange/exchange-ps/exchange/Enable-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMIPGateway.md index 2b49427750..257616fe21 100644 --- a/exchange/exchange-ps/exchange/Enable-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Enable-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-umipgateway +schema: 2.0.0 +title: Enable-UMIPGateway --- # Enable-UMIPGateway @@ -33,7 +34,7 @@ The status variable for a UM IP gateway can be used to enable or disable call an After this task is completed, the UM IP gateway answers incoming calls and makes outgoing calls through the IP gateway or IP Private Branch eXchange (PBX). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example enables the UM IP gateway MyUMIPGateway. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM IP gateway being enabled. This parameter is the directory object ID for the UM IP gateway. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMMailbox.md similarity index 83% rename from exchange/exchange-ps/exchange/Enable-UMMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMMailbox.md index 64d7a8d5d7..702bc96be8 100644 --- a/exchange/exchange-ps/exchange/Enable-UMMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Enable-UMMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-ummailbox +schema: 2.0.0 +title: Enable-UMMailbox --- # Enable-UMMailbox @@ -62,7 +63,7 @@ Enable-UMMailbox [-Identity] ## DESCRIPTION When the mailbox is enabled for Unified Messaging, the settings from a UM mailbox policy are applied to the mailbox. After the mailbox is enabled for Unified Messaging, the user can use the UM features that are included in Microsoft Exchange. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,6 +84,9 @@ This example enables Unified Messaging on a SIP-enabled mailbox for tonysmith@co ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the mailbox that you want to enable for Unified Messaging. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -100,7 +104,6 @@ The Identity parameter specifies the mailbox that you want to enable for Unified Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -UMMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMMailboxPolicy parameter specifies the UM mailbox policy that you want to associate with the mailbox. You can use any value that uniquely identifies the policy. For example: - Name @@ -118,9 +124,8 @@ The UMMailboxPolicy parameter specifies the UM mailbox policy that you want to a ```yaml Type: MailboxPolicyIdParameter -Parameter Sets: Identity +Parameter Sets: Identity, CloudVoiceMail Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -129,30 +134,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: CloudVoiceMail -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 +### -AutomaticSpeechRecognitionEnabled -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -### -AutomaticSpeechRecognitionEnabled The AutomaticSpeechRecognitionEnabled parameter specifies whether to enable Automatic Speech Recognition (ASR) for the UM mailbox. Valid values are: -- $true: ASR is enabled for the mailbox. This is the default value. ASR is available only if the user's specified preferred language is installed. +- $true: ASR is enabled for the mailbox. This value is the default. ASR is available only if the user's specified preferred language is installed. - $false: ASR is disabled for the mailbox. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -162,6 +156,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -171,7 +168,6 @@ 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 Required: False Position: Named @@ -181,13 +177,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -197,13 +195,15 @@ Accept wildcard characters: False ``` ### -EnableCloudVoiceMail + +> Applicable: Exchange Server 2016 + The EnableCloudVoiceMail switch specifies whether to enable the mailbox for UM in Skype for Business Online. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: CloudVoiceMail Aliases: -Applicable: Exchange Server 2016 Required: True Position: Named @@ -213,6 +213,9 @@ Accept wildcard characters: False ``` ### -Extensions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Extensions parameter specifies the extension number for the user. Either a single extension number or an array of telephone number extensions can be specified. The user's extension must be unique to the UM dial plan. If you don't use this parameter, the command attempts to use a default telephone number value for the user. If you're using a Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) or E.164 dial plan, you also need to use the SIPResourceIdentifier parameter. @@ -221,7 +224,6 @@ If you don't use this parameter, the command attempts to use a default telephone Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -231,6 +233,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -242,7 +247,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -252,13 +256,15 @@ Accept wildcard characters: False ``` ### -NotifyEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NotifyEmail parameter specifies the email address where the Unified Messaging welcome message is sent. By default, the message is sent to the user's SMTP email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -268,13 +274,15 @@ Accept wildcard characters: False ``` ### -PilotNumber + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PilotNumber parameter specifies the subscriber access number users can dial to gain access to their mailboxes. The default value is the subscriber access number that's specified on the UM dial plan. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -284,6 +292,9 @@ Accept wildcard characters: False ``` ### -PIN + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PIN parameter specifies the value for the initial PIN that's used for the UM mailbox. The PIN is checked against the UM mailbox policy rules. The PIN value must be from 4 through 24 numeric characters. If you don't use this parameter, a system-generated PIN is sent to the user. By default, the PIN generated by the system contains six numeric characters. @@ -292,7 +303,6 @@ If you don't use this parameter, a system-generated PIN is sent to the user. By Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -302,6 +312,9 @@ Accept wildcard characters: False ``` ### -PINExpired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PINExpired parameter specifies whether the PIN is treated as expired. If the PIN isn't supplied, the PIN is treated as expired and users are prompted to reset their PIN the next time they log on. - $true: The user is required to reset their PIN the next time they log on. @@ -311,7 +324,6 @@ The PINExpired parameter specifies whether the PIN is treated as expired. If the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -321,7 +333,10 @@ Accept wildcard characters: False ``` ### -SendWelcomeMail -The SendWelcomeMail parameter specifies whether you want to send a welcome message after the mailbox has been enabled for UM. Valid values are: + +> Applicable: Exchange Server 2016 + +The SendWelcomeMail parameter specifies whether you want to send a welcome message after the mailbox is enabled for UM. Valid values are: - $true: Send the welcome to UM message. - $false: Don't send the welcome to UM message. @@ -330,7 +345,6 @@ The SendWelcomeMail parameter specifies whether you want to send a welcome messa Type: Boolean Parameter Sets: CloudVoiceMail Aliases: -Applicable: Exchange Server 2016 Required: False Position: Named @@ -340,13 +354,15 @@ Accept wildcard characters: False ``` ### -SIPResourceIdentifier + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SIPResourceIdentifier parameter specifies the SIP address or E.164 address for the user. This property is compared to the URI type defined on the UM dial plan. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -356,7 +372,10 @@ Accept wildcard characters: False ``` ### -ValidateOnly -The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. You don't need to specify a value with this switch. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The ValidateOnly switch specifies whether to evaluate the potential success or failure of the command without making changes. You don't need to specify a value with this switch. No changes are made when the ValidateOnly switch is used. @@ -364,7 +383,6 @@ No changes are made when the ValidateOnly switch is used. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -374,13 +392,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMServer.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMServer.md similarity index 82% rename from exchange/exchange-ps/exchange/Enable-UMServer.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMServer.md index 01417d0e76..44f9f235b6 100644 --- a/exchange/exchange-ps/exchange/Enable-UMServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-umserver applicable: Exchange Server 2010 -title: Enable-UMServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-umserver +schema: 2.0.0 +title: Enable-UMServer --- # Enable-UMServer @@ -29,11 +30,11 @@ Enable-UMServer [-Identity] ``` ## DESCRIPTION -The Enable-UMServer cmdlet sets the status of a Unified Messaging server. A UM server has a logical status variable controlled using the enable and disable cmdlets. A UM server won't process any new calls unless it's in the enabled state. With the status variable, you can start or stop call processing on a UM server so the UM server can be brought online or taken offline in a controlled way. +The Enable-UMServer cmdlet sets the status of a Unified Messaging server. A UM server has a logical status variable controlled using the enable and disable cmdlets. A UM server doesn't process any new calls unless it's in the enabled state. With the status variable, you can start or stop call processing on a UM server so the UM server can be brought online or taken offline in a controlled way. After this task is completed, the Unified Messaging server is available to answer incoming calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example enables Unified Messaging on the Unified Messaging server named MyU ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the identifier for the Unified Messaging server being enabled. This is the directory object ID for the UM server. ```yaml Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMService.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMService.md similarity index 82% rename from exchange/exchange-ps/exchange/Enable-UMService.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMService.md index d0441b4357..9804245e88 100644 --- a/exchange/exchange-ps/exchange/Enable-UMService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-umservice applicable: Exchange Server 2013, Exchange Server 2016 -title: Enable-UMService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-umservice +schema: 2.0.0 +title: Enable-UMService --- # Enable-UMService @@ -31,11 +32,11 @@ Enable-UMService [-Identity] ``` ## DESCRIPTION -The Enable-UMService cmdlet sets the status of an Exchange server running the Unified Messaging server role. A UM server has a logical status variable controlled using the enable and disable cmdlets. A UM server won't process any new calls unless it's in the enabled state. With the status variable, you can start or stop call processing on a UM server so the UM server can be brought online or taken offline in a controlled way. +The Enable-UMService cmdlet sets the status of an Exchange server running the Unified Messaging server role. A UM server has a logical status variable controlled using the enable and disable cmdlets. A UM server doesn't process any new calls unless it's in the enabled state. With the status variable, you can start or stop call processing on a UM server so the UM server can be brought online or taken offline in a controlled way. After this task is completed, the UM server is available to answer incoming calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example enables Unified Messaging on the UM server MyUMServer. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the Exchange 2010 UM server that you want to enable. You can use any value that uniquely identifies the UM server. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the Exchange 2010 UM server that you want to en Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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`. @@ -79,7 +85,6 @@ 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 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md similarity index 97% rename from exchange/exchange-ps/exchange/exchange.md rename to exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md index 10208980c0..144bee1b49 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md @@ -1,24 +1,27 @@ --- -Module Name: Exchange PowerShell -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +Locale: en-US +Module Guid: 00000000-0000-0000-0000-000000000000 +Module Name: ExchangePowerShell title: exchange --- # Exchange PowerShell ## Description -Exchange PowerShell is built on Windows PowerShell technology and provides a powerful command-line interface that enables automation of administrative tasks. The following PowerShell environments are available in Exchange: +Exchange PowerShell is built on PowerShell technology to a powerful command-line interface for automation of administrative tasks. The following PowerShell environments are available in Exchange: - [Exchange Server PowerShell (Exchange Management Shell)](https://learn.microsoft.com/powershell/exchange/exchange-management-shell) - [Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell) - [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell) -- [Exchange Online Protection PowerShell](https://learn.microsoft.com/powershell/exchange/exchange-online-protection-powershell) +- [Exchange Online Protection PowerShell for cloud protection of on-premises email environments](https://learn.microsoft.com/powershell/exchange/exchange-online-protection-powershell) > [!NOTE] -> For Exchange Online, Security & Compliance, and Exchange Online Protection, the module from the PowerShell Gallery that you use to connect is [ExchangeOnlineManagement](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/). For more information, see [About the Exchange Online PowerShell module](../../docs-conceptual/exchange-online-powershell-v2.md). +> For cloud environments, use the [ExchangeOnlineManagement](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/) in the PowerShell Gallery. For more information, see [About the Exchange Online PowerShell module](../../docs-conceptual/exchange-online-powershell-v2.md). > -> For Exchange Server, there is no Microsoft-provided module in the PowerShell Gallery. Instead, to use PowerShell in Exchange, you have the following options: +> For Exchange Server, you have the following options: > -> - Use the Exchange Management Shell on an Exchange server or that you've installed locally on your own computer using a **Management tools** only installation of Exchange server. For more information, see [Install the Exchange Server Management Tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools) and [Open the Exchange Management Shell](../../docs-conceptual/open-the-exchange-management-shell.md). +> - Use the Exchange Management Shell: +> - On an Exchange server. For more information, see [Open the Exchange Management Shell](../../docs-conceptual/open-the-exchange-management-shell.md). +> - On a local computer where you did a **Management tools** only installation of Exchange server. For more information, see [Install the Exchange Server Management Tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools) > - Use remote PowerShell from a Windows PowerShell session. For more information, see [Connect to Exchange servers using remote PowerShell](../../docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md). ## active-directory Cmdlets @@ -32,7 +35,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-ADSite](Get-ADSite.md) -### [Get-AdSiteLink](Get-AdSiteLink.md) +### [Get-ADSiteLink](Get-ADSiteLink.md) ### [Get-DomainController](Get-DomainController.md) @@ -50,7 +53,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-ADSite](Set-ADSite.md) -### [Set-AdSiteLink](Set-AdSiteLink.md) +### [Set-ADSiteLink](Set-ADSiteLink.md) ## defender-for-office-365 Cmdlets ### [Disable-AntiPhishRule](Disable-AntiPhishRule.md) @@ -396,7 +399,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-ExoPhishSimOverrideRule](Set-ExoPhishSimOverrideRule.md) -### [Set-ExoSecOpsOverrideRule](Remove-ExoSecOpsOverrideRule.md) +### [Set-ExoSecOpsOverrideRule](Set-ExoSecOpsOverrideRule.md) ### [Set-HostedConnectionFilterPolicy](Set-HostedConnectionFilterPolicy.md) @@ -938,6 +941,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Test-IRMConfiguration](Test-IRMConfiguration.md) +### [Test-M365DataAtRestEncryptionPolicy](Test-M365DataAtRestEncryptionPolicy.md) + ## federation-and-hybrid Cmdlets ### [Add-FederatedDomain](Add-FederatedDomain.md) @@ -1342,8 +1347,12 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-MessageTrace](Get-MessageTrace.md) +### [Get-MessageTraceV2](Get-MessageTraceV2.md) + ### [Get-MessageTraceDetail](Get-MessageTraceDetail.md) +### [Get-MessageTraceDetailV2](Get-MessageTraceDetailV2.md) + ### [Get-MessageTrackingLog](Get-MessageTrackingLog.md) ### [Get-MessageTrackingReport](Get-MessageTrackingReport.md) @@ -1636,8 +1645,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) @@ -1658,6 +1671,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) @@ -1670,6 +1685,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) @@ -1690,10 +1707,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) @@ -1717,6 +1738,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Update-ExchangeHelp](Update-ExchangeHelp.md) ## policy-and-compliance Cmdlets +### [Check-PurviewConfig](Check-PurviewConfig.md) + ### [Disable-JournalArchiving](Disable-JournalArchiving.md) ### [Disable-JournalRule](Disable-JournalRule.md) @@ -1737,8 +1760,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) @@ -1793,8 +1814,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Invoke-ComplianceSecurityFilterAction](Invoke-ComplianceSecurityFilterAction.md) -### [New-ActivityAlert](New-ActivityAlert.md) - ### [New-AutoSensitivityLabelPolicy](New-AutoSensitivityLabelPolicy.md) ### [New-AutoSensitivityLabelRule](New-AutoSensitivityLabelRule.md) @@ -1821,8 +1840,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) @@ -1843,14 +1860,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) @@ -1888,10 +1901,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) @@ -1900,18 +1909,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) @@ -1924,8 +1925,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) @@ -2164,7 +2163,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-FilePlanPropertyReferenceId](Get-FilePlanPropertyReferenceId.md) -### [Get-FilePlanPropertyStructure](Get-FilePlanPropertyStructur.md) +### [Get-FilePlanPropertyStructure](Get-FilePlanPropertyStructure.md) ### [Get-FilePlanPropertySubCategory](Get-FilePlanPropertySubCategory.md) @@ -2258,7 +2257,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-FilePlanPropertyReferenceId](Remove-FilePlanPropertyReferenceId.md) -### [Remove-FilePlanPropertySubCategory](Remove-FilePlanPropertySubCategor.md) +### [Remove-FilePlanPropertySubCategory](Remove-FilePlanPropertySubCategory.md) ### [Remove-HoldCompliancePolicy](Remove-HoldCompliancePolicy.md) @@ -2288,7 +2287,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-ComplianceTag](Set-ComplianceTag.md) -### [Set-FilePlanPropertyAuthority](Set-FilePlanPropertyAuthorit.md) +### [Set-FilePlanPropertyAuthority](Set-FilePlanPropertyAuthority.md) ### [Set-FilePlanPropertyCategory](Set-FilePlanPropertyCategory.md) @@ -2412,7 +2411,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-MailFilterListReport](Get-MailFilterListReport.md) -### [Get-MailflowStatusReport](Get-MailflowStatusReport.md) +### [Get-MailFlowStatusReport](Get-MailFlowStatusReport.md) ### [Get-MailTrafficEncryptionReport](Get-MailTrafficEncryptionReport.md) @@ -2442,7 +2441,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-SupervisoryReviewTopCasesReport](Get-SupervisoryReviewTopCasesReport.md) -### [Test-Message](Test-Message.md] +### [Test-Message](Test-Message.md) ## role-based-access-control Cmdlets ### [Add-ManagementRoleEntry](Add-ManagementRoleEntry.md) @@ -2714,11 +2713,11 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-UMMailbox](Get-UMMailbox.md) -### [Get-UMMailboxPIN](Get-UMMailboxPIN.md) +### [Get-UMMailboxPin](Get-UMMailboxPin.md) ### [Get-UMMailboxPolicy](Get-UMMailboxPolicy.md) -### [Get-UmServer](Get-UmServer.md) +### [Get-UMServer](Get-UMServer.md) ### [Get-UMService](Get-UMService.md) @@ -2764,7 +2763,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-UMMailboxPolicy](Set-UMMailboxPolicy.md) -### [Set-UmServer](Set-UmServer.md) +### [Set-UMServer](Set-UMServer.md) ### [Set-UMService](Set-UMService.md) diff --git a/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md b/exchange/exchange-ps/ExchangePowerShell/Execute-AzureADLabelSync.md similarity index 90% rename from exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md rename to exchange/exchange-ps/ExchangePowerShell/Execute-AzureADLabelSync.md index 8da13825b6..2290b1aed6 100644 --- a/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md +++ b/exchange/exchange-ps/ExchangePowerShell/Execute-AzureADLabelSync.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/execute-azureadlabelsync applicable: Security & Compliance -title: Execute-AzureADLabelSync -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/execute-azureadlabelsync +schema: 2.0.0 +title: Execute-AzureADLabelSync --- # Execute-AzureADLabelSync @@ -34,7 +35,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned Execute-AzureADLabelSync ``` -This example will initialize the synchronization of sensitivity labels into Microsoft Entra ID. +This example initializes the synchronization of sensitivity labels into Microsoft Entra ID. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Expedite-Delicensing.md b/exchange/exchange-ps/ExchangePowerShell/Expedite-Delicensing.md similarity index 81% rename from exchange/exchange-ps/exchange/Expedite-Delicensing.md rename to exchange/exchange-ps/ExchangePowerShell/Expedite-Delicensing.md index f5c2af5041..349d748c48 100644 --- a/exchange/exchange-ps/exchange/Expedite-Delicensing.md +++ b/exchange/exchange-ps/ExchangePowerShell/Expedite-Delicensing.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/expedite-delicensing +schema: 2.0.0 +title: Expedite-Delicensing --- # Expedite-Delicensing @@ -26,7 +27,7 @@ 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,6 +41,9 @@ This example ends the delay for the mailbox license removal request on the speci ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + 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: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the mailbox. For example: Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 diff --git a/exchange/exchange-ps/exchange/Export-ActiveSyncLog.md b/exchange/exchange-ps/ExchangePowerShell/Export-ActiveSyncLog.md similarity index 80% rename from exchange/exchange-ps/exchange/Export-ActiveSyncLog.md rename to exchange/exchange-ps/ExchangePowerShell/Export-ActiveSyncLog.md index 2af091f5e0..34f5758bc8 100644 --- a/exchange/exchange-ps/exchange/Export-ActiveSyncLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-ActiveSyncLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-activesynclog -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-ActiveSyncLog -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-activesynclog +schema: 2.0.0 +title: Export-ActiveSyncLog --- # Export-ActiveSyncLog @@ -36,7 +37,7 @@ Export-ActiveSyncLog -Filename ## DESCRIPTION The Export-ActiveSyncLog cmdlet parses the IIS log files and returns information about Exchange ActiveSync usage. This cmdlet can export the output to a file or display it in the Exchange Management Shell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,13 +65,15 @@ This example exports the Exchange ActiveSync log for the date range 02/01/18 to ## PARAMETERS ### -Filename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filename parameter specifies the name of the input file. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -89,7 +95,6 @@ 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 Required: False Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EndDate parameter specifies the end date of the date range of the report. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -123,7 +133,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -OutputPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OutputPath parameter specifies the name and location for the output file. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -OutputPrefix + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OutputPrefix parameter specifies a prefix to append to the name of the output file. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StartDate parameter specifies the start date of the date range for the report. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +196,9 @@ Accept wildcard characters: False ``` ### -UseGMT + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseGMT switch specifies that Coordinated Universal Time (Greenwich Mean Time) is used for the time in the report output. You don't need to specify a value with this switch. If you don't use this switch, local time is used. @@ -189,7 +207,6 @@ If you don't use this switch, local time is used. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,13 +216,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md b/exchange/exchange-ps/ExchangePowerShell/Export-ActivityExplorerData.md similarity index 84% rename from exchange/exchange-ps/exchange/Export-ActivityExplorerData.md rename to exchange/exchange-ps/ExchangePowerShell/Export-ActivityExplorerData.md index 8d5bf12471..83eee07bc7 100644 --- a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-ActivityExplorerData.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata applicable: Security & Compliance -title: Export-ActivityExplorerData -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-activityexplorerdata +schema: 2.0.0 +title: Export-ActivityExplorerData --- # Export-ActivityExplorerData @@ -178,7 +179,7 @@ This example exports a maximum of 5000 records for the specified date range in J Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -OutputFormat Json ``` -This example exports up to 100 records for the specified date range in Json format. If more than 100 records are available, the value of the LastPage property in the command output will be False. Use the value of the Watermark property as the value of the PageCookie parameter in a new query to get the next set of records. +This example exports up to 100 records for the specified date range in Json format. If more than 100 records are available, the value of the LastPage property in the command output is False. Use the value of the Watermark property as the value of the PageCookie parameter in a new query to get the next set of records. ### Example 3 ```powershell @@ -219,6 +220,9 @@ This example exports up to 100 records for the specified date range in JSON form ## PARAMETERS ### -EndTime + +> Applicable: Security & Compliance + 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". @@ -227,7 +231,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -237,6 +240,9 @@ Accept wildcard characters: False ``` ### -OutputFormat + +> Applicable: Security & Compliance + The OutputFormat parameter specifies the output format. Valid values are: - Csv @@ -247,7 +253,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: csv, json -Applicable: Security & Compliance Required: True Position: Named @@ -257,6 +262,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: Security & Compliance + 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". @@ -265,7 +273,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -275,6 +282,9 @@ Accept wildcard characters: False ``` ### -Filter1 + +> Applicable: Security & Compliance + The Filter1 parameter filters the data to export. This parameter takes a minimum of two values as input: a filter name and at least one filter value. For example, `@("Activity", "LabelApplied")` returns records with the activity value `LabelApplied`. If you specify multiple filter values for the same parameter, OR behavior is used. For example, `@("Activity", "LabelApplied", "LabelRemoved")` returns records with the activity values `LabelApplied` or `LabelRemoved`. @@ -287,7 +297,6 @@ If you use this parameter with other filter parameters, AND behavior is used acr Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -297,6 +306,9 @@ Accept wildcard characters: False ``` ### -Filter2 + +> Applicable: Security & Compliance + The Filter2 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. Use this parameter only if you're also using the Filter1 parameter in the same command. @@ -305,7 +317,6 @@ Use this parameter only if you're also using the Filter1 parameter in the same c Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -315,6 +326,9 @@ Accept wildcard characters: False ``` ### -Filter3 + +> Applicable: Security & Compliance + The Filter3 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. Use this parameter only if you're also using the Filter2 and Filter1 parameters in the same command. @@ -323,7 +337,6 @@ Use this parameter only if you're also using the Filter2 and Filter1 parameters Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -333,6 +346,9 @@ Accept wildcard characters: False ``` ### -Filter4 + +> Applicable: Security & Compliance + The Filter4 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. Use this parameter only if you're also using the Filter3, Filter2, and Filter1 parameters in the same command. @@ -341,7 +357,6 @@ Use this parameter only if you're also using the Filter3, Filter2, and Filter1 p Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -351,6 +366,9 @@ Accept wildcard characters: False ``` ### -Filter5 + +> Applicable: Security & Compliance + The Filter5 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. Use this parameter only if you're also using the Filter4, Filter3, Filter2, and Filter1 parameters in the same command. @@ -359,7 +377,6 @@ Use this parameter only if you're also using the Filter4, Filter3, Filter2, and Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -369,13 +386,15 @@ Accept wildcard characters: False ``` ### -PageCookie + +> Applicable: Security & Compliance + The PageCookie parameter specifies whether to get more data when the value of the LastPage property in the command output is False. If you don't use the PageSize parameter, a maximum of 100 records are returned. If you use the PageSize parameter, a maximum of 5000 records can be returned. To get more records than what as returned in the current command, use the value of the Watermark property from the output of the current command as the value for the PageCookie parameter in a new command with the same date range and filters. The PageCookie value is valid for 120 seconds to fetch the next set of records for same query. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -385,13 +404,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 100. Consider using a smaller PageSize value to avoid PageCookie expiry when exporting large datasets. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -408,6 +429,93 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ## NOTES -- The date-time field exported via this cmdlet is in UTC timezone. +The date-time field exported via this cmdlet is in Coordinated Universal Time (UTC). + +The cmdlet exports following data columns. However, not all columns are present for each activity. For details on exported column for different activities, we recommend checking the activities in [Activity Explorer](https://learn.microsoft.com/purview/data-classification-activity-explorer). + +- Activity +- Application +- ArtifactType +- AssociatedAdminUnits +- AuthorizedGroupId +- AuthorizedGroupName +- ClientIP +- DataState +- DestinationLocationType +- DeviceName +- DlpPolicyMatchId +- EndpointOperation +- EnforcementMode +- EntityProperties +- EvaluationTime +- FalsePositive +- FileExtension +- FilePath +- FileSize +- FileType +- FullUrl +- GroupId +- GroupName +- GroupType +- Happened +- Hidden +- HowApplied +- HowAppliedDetail +- IRMContentId +- IsCorporateNetwork +- IsProtected +- IsProtectedBefore +- JitTriggered +- Justification +- LabelEventType +- Manufacturer +- MatchedWithV1DetailedScheme +- MDATPDeviceId +- Model +- OldRetentionLabel +- OldSensitivityLabel +- OriginatingDomain +- ParentArchiveHash +- Platform +- PolicyId +- PolicyMode +- PolicyName +- PreviousFileName +- PreviousFilePath +- PreviousProtectionOwner +- ProcessName +- ProductVersion +- ProtectionEventType +- ProtectionOwner +- ProtectionType +- Reason +- Receivers +- RecordIdentity +- RetentionLabel +- RMSEncrypted +- RuleActions +- RuleId +- RuleName +- Sender +- SensitiveInfoTypeBucketsData +- SensitiveInfoTypeData +- SensitivityLabel +- SensitivityLabelPolicyId +- SerialNumber +- Sha1 +- Sha256 +- SourceLocationType +- StorageName +- Subject +- TargetDomain +- TargetFilePath +- TargetPrinterName +- TemplateId +- User +- UserSku +- UserType +- VpnNetworkAddress +- VpnServerAddress +- Workload ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md b/exchange/exchange-ps/ExchangePowerShell/Export-AutoDiscoverConfig.md similarity index 78% rename from exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Export-AutoDiscoverConfig.md index 01b6148ebe..ccc78e937b 100644 --- a/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-AutoDiscoverConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-autodiscoverconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-AutoDiscoverConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-autodiscoverconfig +schema: 2.0.0 +title: Export-AutoDiscoverConfig --- # Export-AutoDiscoverConfig @@ -33,9 +34,9 @@ Export-AutoDiscoverConfig -TargetForestDomainController ``` ## DESCRIPTION -The Autodiscover Service Connection Point pointer resides Active Directory in the user account forest and includes the LDAP URL of the resource forest that the client will use to locate the Autodiscover service in the resource forest. +The Autodiscover Service Connection Point pointer resides Active Directory in the user account forest. The pointer includes the LDAP URL of the resource forest that the client uses to locate the Autodiscover service in the resource forest. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,15 +57,17 @@ This example specifies that Exchange is deployed in more than one Active Directo ## PARAMETERS ### -TargetForestDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetForestDomainController parameter specifies the forest or domain controller that you want to export the Autodiscover configuration to. -If the target domain controller requires signing, you'll get the error: "A more secure authentication method is required for this server". Domain controllers that require signing aren't supported. +If the target domain controller requires signing, you get the error: "A more secure authentication method is required for this server". Domain controllers that require signing aren't supported. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -83,7 +89,6 @@ 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 Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DeleteConfig + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeleteConfig parameter causes the command to delete your configuration settings on the service connection point object. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,16 +134,18 @@ Accept wildcard characters: False ``` ### -MultipleExchangeDeployments + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MultipleExchangeDeployments parameter specifies whether multiple Exchange deployments exist. Valid values are: - $true: Exchange is deployed in more than one Active Directory forest, and the forests are connected. The list of authoritative accepted domains for the source forest is written to the Autodiscover service connection point object. Outlook clients use this object to select the most appropriate forest to search for the Autodiscover service. -- $False: Multiple Exchange deployments aren't used. This is the default value. +- $False: Multiple Exchange deployments aren't used. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +155,15 @@ Accept wildcard characters: False ``` ### -PreferredSourceFqdn + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PreferredSourceFqdn parameter specifies the FQDN of the Active Directory domain for the Autodiscover pointer service connection point object. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,6 +173,9 @@ Accept wildcard characters: False ``` ### -SourceForestCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceForestCredential parameter specifies the credentials to use when connecting to the source forest. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -168,7 +184,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,6 +193,9 @@ Accept wildcard characters: False ``` ### -TargetForestCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetForestCredential parameter specifies the credentials to use to connect to the target forest. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -186,7 +204,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,13 +213,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-ContentExplorerData.md b/exchange/exchange-ps/ExchangePowerShell/Export-ContentExplorerData.md similarity index 84% rename from exchange/exchange-ps/exchange/Export-ContentExplorerData.md rename to exchange/exchange-ps/ExchangePowerShell/Export-ContentExplorerData.md index ebe659a855..9f40d2f4b2 100644 --- a/exchange/exchange-ps/exchange/Export-ContentExplorerData.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-ContentExplorerData.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-contentexplorerdata applicable: Security & Compliance -title: Export-ContentExplorerData -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-contentexplorerdata +schema: 2.0.0 +title: Export-ContentExplorerData --- # Export-ContentExplorerData @@ -25,6 +26,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Export-ContentExplorerData [-TagName] [-TagType] [-Aggregate] + [[-ConfidenceLevel] ] [[-PageCookie] ] [[-PageSize] ] [[-SiteUrl] ] @@ -43,11 +45,13 @@ The output of this cmdlet contains the following information: 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. +- 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 the Azure app, add the Content Explorer List Viewer` role group to the Service Principal Identity. To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). @@ -77,6 +81,9 @@ This example exports records for the specified sensitive info type for all workl ## PARAMETERS ### -TagType + +> Applicable: Security & Compliance + The TagType parameter specifies the type of label to export file details from. Valid values are: - Retention @@ -88,7 +95,6 @@ The TagType parameter specifies the type of label to export file details from. V Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 5 @@ -98,21 +104,25 @@ Accept wildcard characters: False ``` ### -Aggregate + +> Applicable: Security & Compliance + +**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: +When you use this switch with the TagName, TagType, and Workload parameters, the command returns the following information: -- SiteUlrs: OneDrive and SharePoint. -- UPNs: Exchange Online and Teams. -- The count of items stamped with that tag. +- 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 @@ -121,14 +131,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConfidenceLevel + +> Applicable: Security & Compliance + +The ConfidenceLevel parameter specifies the confidence level of the match for the file details to export. Valid values are: + +- low +- medium +- high + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: high, medium, low + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PageCookie + +> Applicable: Security & Compliance + The PageCookie parameter specifies whether to get more data when the value of the MorePagesAvailable property in the command output is True. If you don't use the PageSize parameter, a maximum of 100 records are returned. If you use the PageSize parameter, a maximum of 10000 records can be returned. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -138,6 +173,9 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Security & Compliance + 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. @@ -146,7 +184,6 @@ The PageSize parameter specifies the maximum number of records to return in a si Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 2 @@ -156,6 +193,9 @@ Accept wildcard characters: False ``` ### -SiteUrl + +> Applicable: Security & Compliance + The SiteUrl parameter specifies the site URL to export file details from. You use this parameter for SharePoint and OneDrive workloads. @@ -164,7 +204,6 @@ You use this parameter for SharePoint and OneDrive workloads. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 3 @@ -174,13 +213,15 @@ Accept wildcard characters: False ``` ### -TagName + +> Applicable: Security & Compliance + The TagName parameter specifies the name of the label to export file details from. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 4 @@ -190,6 +231,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Security & Compliance + The UserPrincipalName parameter specifies the user account in UPN format to export message details from. An example UPN value is erika@contoso.onmicrosoft.com. You use this parameter for Exchange and Microsoft Teams workloads. @@ -198,7 +242,6 @@ You use this parameter for Exchange and Microsoft Teams workloads. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 6 @@ -208,6 +251,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Security & Compliance + The Workload parameter specifies the location to export file details from. Valid values are: - EXO or Exchange @@ -219,7 +265,6 @@ The Workload parameter specifies the location to export file details from. Valid Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 7 diff --git a/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md b/exchange/exchange-ps/ExchangePowerShell/Export-DlpPolicyCollection.md similarity index 78% rename from exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Export-DlpPolicyCollection.md index 0c2de21c86..9c9512e38c 100644 --- a/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-DlpPolicyCollection.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-dlppolicycollection -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Export-DlpPolicyCollection -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-dlppolicycollection +schema: 2.0.0 +title: Export-DlpPolicyCollection --- # Export-DlpPolicyCollection ## SYNOPSIS -**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). +**Note**: This cmdlet is 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). This cmdlet is functional only in on-premises Exchange. @@ -33,7 +34,7 @@ Export-DlpPolicyCollection [[-Identity] ] ## DESCRIPTION The Export-DlpPolicyCollection cmdlet exports the settings of the DLP policies and the associated transport rules. You use the Import-DlpPolicyCollection to import the DLP policy collection into your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example exports all the elements of the existing DLP policies to the file C ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the DLP policy you want to export. You can use any value that uniquely identifies the DLP policy. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy. ```yaml Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Export-ExchangeCertificate.md similarity index 88% rename from exchange/exchange-ps/exchange/Export-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Export-ExchangeCertificate.md index ec431d5516..6adbf7004e 100644 --- a/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-exchangecertificate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-ExchangeCertificate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-exchangecertificate +schema: 2.0.0 +title: Export-ExchangeCertificate --- # Export-ExchangeCertificate @@ -56,7 +57,7 @@ The Export-ExchangeCertificate cmdlet creates the following types of files: Typically, you export a certificate request file if you need to resubmit the certificate request to the certification authority. You can't import an exported certificate request on another server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -108,6 +109,9 @@ This example exports the same pending certificate request from Example 3. This m ## PARAMETERS ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Thumbprint parameter specifies the certificate or certificate request that you want to export. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. @@ -116,7 +120,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: String Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -126,6 +129,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the certificate or certificate request that you want to export. Valid values are: - `ServerNameOrFQDN\Thumbprint` @@ -141,7 +147,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: ExchangeCertificateIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -151,15 +156,17 @@ Accept wildcard characters: False ``` ### -BinaryEncoded + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BinaryEncoded switch encodes the exported certificate or certificate request file by using Distinguished Encoding Rules (DER). You don't need to specify a value with this switch. -Typically, you use this switch when you export a certificate, because you can store the certificate and its private key or chain of trust in a single binary file when you also use the Password parameter. If you don't use this switch, the exported certificate file is Base64 encoded, and you'll need to export any intermediate or root certificates in the chain of trust separately. +Typically, you use this switch when you export a certificate, because you can store the certificate and its private key or chain of trust in a single binary file when you also use the Password parameter. If you don't use this switch, the exported certificate file is Base64 encoded, and you need to export any intermediate or root certificates in the chain of trust separately. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,6 +176,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -178,7 +188,6 @@ 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 Required: False Position: Named @@ -188,6 +197,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -196,7 +208,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,6 +217,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Exchange Server 2013 + **Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To export the certificate or certificate request to a file without using the FileName parameter, use the methods described in Example 2 and Example 4. This parameter is available only in Exchange 2013. @@ -216,7 +230,6 @@ The FileName parameter specifies the name and path of the exported certificate o Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -226,6 +239,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Password parameter specifies the password for the private key or chain of trust in the exported certificate file. To import the exported certificate file on another server, you need to know the password. You can use the following methods as a value for this parameter: @@ -238,7 +254,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,6 +263,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -263,7 +281,6 @@ You can't use this parameter with the Identity parameter, but you can use it wit Type: ServerIdParameter Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,13 +290,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-FilePlanProperty.md b/exchange/exchange-ps/ExchangePowerShell/Export-FilePlanProperty.md similarity index 93% rename from exchange/exchange-ps/exchange/Export-FilePlanProperty.md rename to exchange/exchange-ps/ExchangePowerShell/Export-FilePlanProperty.md index 91b4a41f26..597a7de70f 100644 --- a/exchange/exchange-ps/exchange/Export-FilePlanProperty.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-FilePlanProperty.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-fileplanproperty applicable: Security & Compliance -title: Export-FilePlanProperty +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-fileplanproperty schema: 2.0.0 +title: Export-FilePlanProperty --- # Export-FilePlanProperty @@ -36,6 +38,9 @@ The example exports the file plan properties. ## PARAMETERS ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -45,7 +50,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -55,13 +59,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -71,13 +77,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Export-JournalRuleCollection.md similarity index 83% rename from exchange/exchange-ps/exchange/Export-JournalRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Export-JournalRuleCollection.md index 0b68ce68f7..d4f3c87368 100644 --- a/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-JournalRuleCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-journalrulecollection -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-JournalRuleCollection -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-journalrulecollection +schema: 2.0.0 +title: Export-JournalRuleCollection --- # Export-JournalRuleCollection @@ -32,7 +33,7 @@ Export-JournalRuleCollection [[-Identity] ] ## DESCRIPTION You can use the Export-JournalRuleCollection cmdlet to export journal rules in your organization to create a backup copy of your rules. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +58,15 @@ In Exchange Server 2010, this example exports legacy journal rules that were cre ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of a journal rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -82,7 +88,6 @@ 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 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -ExportLegacyRules + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ExportLegacyRules switch specifies whether to export Exchange 2007 journal rules. You don't need to specify a value with this switch. @@ -116,7 +126,6 @@ The ExportLegacyRules switch specifies whether to export Exchange 2007 journal r Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md b/exchange/exchange-ps/ExchangePowerShell/Export-MailboxDiagnosticLogs.md similarity index 82% rename from exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md rename to exchange/exchange-ps/ExchangePowerShell/Export-MailboxDiagnosticLogs.md index dada5fa300..825ccbe272 100644 --- a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-MailboxDiagnosticLogs.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-mailboxdiagnosticlogs -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Export-MailboxDiagnosticLogs -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-mailboxdiagnosticlogs +schema: 2.0.0 +title: Export-MailboxDiagnosticLogs --- # Export-MailboxDiagnosticLogs ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Export-MailboxDiagnosticLogs cmdlet to export diagnostic data from user and system mailboxes in your organization. @@ -50,7 +51,7 @@ Export-MailboxDiagnosticLogs [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,6 +72,9 @@ This example retrieves the calendar permissions diagnostic log for the mailbox n ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies that mailbox that contains the diagnostics logs that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -88,7 +92,6 @@ The Identity parameter specifies that mailbox that contains the diagnostics logs Type: GeneralMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -ComponentName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ComponentName parameter specifies the component that you want to retrieve the diagnostic logs for. Valid values depend on the type and location of the mailbox (on-premises Exchange or Exchange Online). Valid values include: - AcceptCalendarSharingInvite @@ -127,7 +133,6 @@ The ComponentName parameter specifies the component that you want to retrieve th Type: String Parameter Sets: MailboxLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -137,13 +142,15 @@ Accept wildcard characters: False ``` ### -ExtendedProperties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExtendedProperties switch specifies whether to retrieve all of the well-known properties from the mailbox table that are useful for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ExtendedProperties Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -153,6 +160,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Archive switch retrieves the diagnostics logs of the archive mailbox instead of the primary mailbox. You don't need to specify a value with this switch. @@ -161,7 +171,6 @@ The Archive switch retrieves the diagnostics logs of the archive mailbox instead Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +180,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -180,7 +192,6 @@ 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 Required: False Position: Named @@ -190,6 +201,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -200,7 +214,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +223,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -218,7 +234,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +243,9 @@ Accept wildcard characters: False ``` ### -IncludeInactiveMailboxes + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeInactiveMailboxes switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch. @@ -238,7 +256,6 @@ An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Ho Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,6 +265,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -260,7 +280,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,13 +289,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -286,13 +307,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-Message.md b/exchange/exchange-ps/ExchangePowerShell/Export-Message.md similarity index 86% rename from exchange/exchange-ps/exchange/Export-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Export-Message.md index 28b6f435c6..4872d122c5 100644 --- a/exchange/exchange-ps/exchange/Export-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-message -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-Message -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-message +schema: 2.0.0 +title: Export-Message --- # Export-Message @@ -30,7 +31,7 @@ Export-Message [-Identity] ## DESCRIPTION The Export-Message cmdlet copies messages from the Delivery queue, the Unreachable queue, or the poison message queue on Mailbox server or an Edge Transport server to a specified file path. Before you export a message, you must first suspend the message. Messages in the poison message queue are already suspended. You can use the Export-Message cmdlet to copy messages to the Replay directory of another Mailbox server for delivery. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,13 +64,15 @@ This example retrieves all messages from the specified queue. The query results ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -88,7 +94,6 @@ 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 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-MigrationReport.md b/exchange/exchange-ps/ExchangePowerShell/Export-MigrationReport.md similarity index 79% rename from exchange/exchange-ps/exchange/Export-MigrationReport.md rename to exchange/exchange-ps/ExchangePowerShell/Export-MigrationReport.md index 4610a82482..22acb5a533 100644 --- a/exchange/exchange-ps/exchange/Export-MigrationReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-MigrationReport.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-migrationreport -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Export-MigrationReport -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-migrationreport +schema: 2.0.0 +title: Export-MigrationReport --- # Export-MigrationReport ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. The Export-MigrationReport is used by the Exchange migration process to enable an administrator to download a CSV file that contains migration errors for a selected migration batch. This cmdlet isn't run by an administrator in Windows PowerShell. @@ -41,7 +42,7 @@ Export-MigrationReport [-Identity] -RowCount Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: MigrationReportIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -CsvStream + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Stream Parameter Sets: StreamBased Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -RowCount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: Paged Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -StartingRowIndex + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: Paged Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -128,7 +140,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -146,7 +160,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +169,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -164,7 +180,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/ExchangePowerShell/Export-QuarantineMessage.md similarity index 82% rename from exchange/exchange-ps/exchange/Export-QuarantineMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Export-QuarantineMessage.md index 08ea9afcf1..28299d4927 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-QuarantineMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-quarantinemessage applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Export-QuarantineMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-quarantinemessage +schema: 2.0.0 +title: Export-QuarantineMessage --- # Export-QuarantineMessage @@ -29,6 +30,7 @@ Export-QuarantineMessage -Identities [-Identity ] [-ForceConversionToMime] [-Password ] + [-PasswordV2 ] [-ReasonForExport ] [-RecipientAddress ] [] @@ -41,13 +43,14 @@ Export-QuarantineMessage -Identity [-EntityType ] [-ForceConversionToMime] [-Password ] + [-PasswordV2 ] [-ReasonForExport ] [-RecipientAddress ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,6 +89,9 @@ This example exports the specified message with attachments that was quarantined ## PARAMETERS ### -Identities + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2...valueN`. Each value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. @@ -96,7 +102,6 @@ When you use this parameter, the Identity parameter is required, but the value i Type: QuarantineMessageIdentity[] Parameter Sets: Identities Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -106,15 +111,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the quarantined message that you want to export. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. ```yaml Type: QuarantineMessageIdentity -Parameter Sets: Identities +Parameter Sets: Identities, IdentityOnly Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -123,20 +130,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: IdentityOnly -Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection +### -CompressOutput -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Security & Compliance, Exchange Online Protection -### -CompressOutput The CompressOutput switch exports the message as a compressed .zip file. You don't need to specify a value with this switch. For exported messages, including messages with attachments, the .zip file contains a folder that's named after the first GUID value in the Identity. The folder contains the .eml message that's named after the second GUID value in the Identity. @@ -145,7 +142,6 @@ For exported messages, including messages with attachments, the .zip file contai Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -155,6 +151,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -166,7 +165,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -176,6 +174,9 @@ Accept wildcard characters: False ``` ### -ForceConversionToMime + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ForceConversionToMime switch converts exported plain text messages to MIME formatting. You don't need to specify a value with this switch. This switch has no effect if the message is already encoded as Base64. @@ -184,7 +185,6 @@ This switch has no effect if the message is already encoded as Base64. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -194,6 +194,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Password parameter specifies the password that's required to open the exported message. You can use the following methods as a value for this parameter: @@ -202,11 +205,30 @@ 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) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordV2 + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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: Required: False Position: Named @@ -216,13 +238,15 @@ Accept wildcard characters: False ``` ### -ReasonForExport + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ReasonForExport parameter specifies why the message was exported. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -232,13 +256,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md b/exchange/exchange-ps/ExchangePowerShell/Export-RecipientDataProperty.md similarity index 81% rename from exchange/exchange-ps/exchange/Export-RecipientDataProperty.md rename to exchange/exchange-ps/ExchangePowerShell/Export-RecipientDataProperty.md index 79ca27c8bb..3ee91c7402 100644 --- a/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-RecipientDataProperty.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-recipientdataproperty -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-RecipientDataProperty -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-recipientdataproperty +schema: 2.0.0 +title: Export-RecipientDataProperty --- # Export-RecipientDataProperty @@ -41,7 +42,7 @@ Export-RecipientDataProperty [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,6 +67,9 @@ This example exports Ayla Kol's picture file to the local computer. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox or mail contact from which you want to export the recipient data. You can use any value that uniquely identifies the user. For example: - Name @@ -79,7 +83,6 @@ The Identity parameter specifies the mailbox or mail contact from which you want Type: MailboxUserContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -98,7 +104,6 @@ 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 Required: False Position: Named @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -Picture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Picture switch specifies that you're exporting the user's picture. You don't need to specify a value with this switch. The user's picture is exported as a JPEG file. @@ -134,7 +144,6 @@ You can't use this switch with the SpokenName switch. Type: SwitchParameter Parameter Sets: ExportPicture Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -SpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SpokenName switch specifies that you're exporting the user's spoken name. You don't need to specify a value with this switch. The user's spoken name is exported as a WMA 9 file. @@ -154,7 +166,6 @@ You can't use this switch with the Picture switch. Type: SwitchParameter Parameter Sets: ExportSpokenName Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Export-TransportRuleCollection.md similarity index 82% rename from exchange/exchange-ps/exchange/Export-TransportRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Export-TransportRuleCollection.md index 1996ade66b..2166bad553 100644 --- a/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-TransportRuleCollection.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-transportrulecollection -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Export-TransportRuleCollection -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-transportrulecollection +schema: 2.0.0 +title: Export-TransportRuleCollection --- # Export-TransportRuleCollection ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Export-TransportRuleCollection cmdlet to export the transport rules in your organization. @@ -35,7 +36,7 @@ The Export-TransportRuleCollection cmdlet can be used to export the transport ru Exporting the rules collection is a two-step process. You first export the rules collection to a variable, and then use the Set-Content cmdlet to write the data to an XML file. For more information, see [Set-Content](https://learn.microsoft.com/powershell/module/microsoft.powershell.management/set-content). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +65,9 @@ You need to run these commands in this example on an Exchange 2010 Hub Transport ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in Exchange Server 2010. The Identity parameter specifies the transport rule that you want to export. You can use any value that uniquely identifies the rule. For example: @@ -76,7 +80,6 @@ The Identity parameter specifies the transport rule that you want to export. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -95,7 +101,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -115,7 +123,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -ExportLegacyRules + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ExportLegacyRules switch is required to export transport rules from Exchange 2007. You don't need to specify a value with this switch. @@ -133,7 +143,6 @@ The ExportLegacyRules switch is required to export transport rules from Exchange Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -Format + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Format parameter specifics the format of the exported transport rule collection. Valid values are: @@ -155,7 +167,6 @@ The Format parameter specifics the format of the exported transport rule collect Type: RuleCollectionFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -165,13 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 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/Export-UMCallDataRecord.md b/exchange/exchange-ps/ExchangePowerShell/Export-UMCallDataRecord.md similarity index 85% rename from exchange/exchange-ps/exchange/Export-UMCallDataRecord.md rename to exchange/exchange-ps/ExchangePowerShell/Export-UMCallDataRecord.md index 29e7f3790d..2cae15c5ab 100644 --- a/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-UMCallDataRecord.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-umcalldatarecord applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Export-UMCallDataRecord -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-umcalldatarecord +schema: 2.0.0 +title: Export-UMCallDataRecord --- # Export-UMCallDataRecord @@ -35,7 +36,7 @@ The Export-UMCallDataRecord cmdlet exports Unified Messaging call data records f After this task is completed, a report is generated that contains Unified Messaging call data records. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,13 +57,15 @@ This example exports all Unified Messaging call data records for February 1, 201 ## PARAMETERS ### -ClientStream + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ClientStream parameter specifies the .NET stream to use to output for the Unified Messaging call data records. ```yaml Type: Stream Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Date + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Date parameter specifies the date of Unified Messaging call data records to retrieve. If there are no call records for the date specified, the report will be empty. ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -97,7 +105,6 @@ 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 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan to export statistics for. If you don't specify a UM dial plan, statistics include all UM dial plans in the organization. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -139,13 +150,15 @@ Accept wildcard characters: False ``` ### -UMIPGateway + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMIPGateway parameter specifies the UM IP gateway to export statistics for. If you don't specify a gateway, statistics include all UM IP gateways in the selected UM dial plan, or if a UM dial plan isn't selected, statistics include all UM IP gateways in the organization. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-UMPrompt.md b/exchange/exchange-ps/ExchangePowerShell/Export-UMPrompt.md similarity index 85% rename from exchange/exchange-ps/exchange/Export-UMPrompt.md rename to exchange/exchange-ps/ExchangePowerShell/Export-UMPrompt.md index 02e8841d44..3e7bdb2f80 100644 --- a/exchange/exchange-ps/exchange/Export-UMPrompt.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-UMPrompt.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-umprompt applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Export-UMPrompt -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-umprompt +schema: 2.0.0 +title: Export-UMPrompt --- # Export-UMPrompt @@ -43,7 +44,7 @@ The Export-UMPrompt cmdlet exports prompts that belong to existing UM dial plan After this task is completed, the UM prompts are displayed or saved. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,13 +69,15 @@ This example exports a custom greeting for the UM auto attendant MyUMAutoAttenda ## PARAMETERS ### -PromptFileName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PromptFileName parameter specifies the name of the custom prompt to export. ```yaml Type: String Parameter Sets: AACustomGreeting, DPCustomGreeting Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -UMAutoAttendant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMAutoAttendant parameter specifies the UM auto attendant ID. This parameter specifies the directory object identifier for the UM auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: AACustomGreeting Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan. ```yaml Type: UMDialPlanIdParameter Parameter Sets: DPCustomGreeting Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -125,7 +135,6 @@ 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 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ADPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-ADPermission.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-ADPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ADPermission.md index 773f0467b4..a41e3a4695 100644 --- a/exchange/exchange-ps/exchange/Get-ADPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ADPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ADPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adpermission +schema: 2.0.0 +title: Get-ADPermission --- # Get-ADPermission @@ -37,9 +38,9 @@ Get-ADPermission [-Identity] ``` ## DESCRIPTION -The ADPermission cmdlets can be used to directly modify Active Directory access control lists (ACLs). Although some Microsoft Exchange features may continue to use the ADPermission cmdlets to manage permissions (for example Send and Receive connectors), Exchange 2013 and later versions no longer use customized ACLs to manage administrative permissions. If you want to grant or deny administrative permissions in Exchange 2013 or later, you need to use Role Based Access Control (RBAC). For more information about RBAC, see [Permissions in Exchange Server](https://learn.microsoft.com/Exchange/permissions/permissions). +The ADPermission cmdlets can be used to directly modify Active Directory access control lists (ACLs). Although some Microsoft Exchange features might continue to use the ADPermission cmdlets to manage permissions (for example Send and Receive connectors), Exchange 2013 and later versions no longer use customized ACLs to manage administrative permissions. If you want to grant or deny administrative permissions in Exchange 2013 or later, you need to use Role Based Access Control (RBAC). For more information about RBAC, see [Permissions in Exchange Server](https://learn.microsoft.com/Exchange/permissions/permissions). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,13 +61,15 @@ This example returns the permissions that have been granted to the user Chris on ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the object for which you're retrieving permissions. You can retrieve the permissions for any Active Directory object using its distinguished name (DN). If the object is an Exchange object, you might be able to use the object's name. If the DN or the object's name contains spaces, enclose the value in quotation marks ("). ```yaml Type: ADRawEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -84,7 +90,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Owner switch returns the owner of the Active Directory object. You don't need to specify a value with this switch. You can't use this switch with the User parameter. @@ -102,7 +110,6 @@ You can't use this switch with the User parameter. Type: SwitchParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The user parameter filters the results who has permissions on the Active Directory object. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -142,7 +152,6 @@ You can't use this parameter with the Owner parameter. Type: SecurityPrincipalIdParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ADServerSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-ADServerSettings.md similarity index 73% rename from exchange/exchange-ps/exchange/Get-ADServerSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ADServerSettings.md index e44f8bd977..d986ca399b 100644 --- a/exchange/exchange-ps/exchange/Get-ADServerSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ADServerSettings.md @@ -1,37 +1,38 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adserversettings -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ADServerSettings -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adserversettings +schema: 2.0.0 +title: Get-ADServerSettings --- -# Get-AdServerSettings +# Get-ADServerSettings ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-AdServerSettings cmdlet to view the Active Directory Domain Services (AD DS) environment settings in the current Exchange Management Shell session. The Get-AdServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. +Use the Get-ADServerSettings cmdlet to view the Active Directory Domain Services (AD DS) environment settings in the current Exchange Management Shell session. The Get-ADServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-AdServerSettings [] +Get-ADServerSettings [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AdServerSettings | Format-List +Get-ADServerSettings | Format-List ``` This example displays the session settings for the current session. diff --git a/exchange/exchange-ps/exchange/Get-ADSite.md b/exchange/exchange-ps/ExchangePowerShell/Get-ADSite.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-ADSite.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ADSite.md index 507afd4a61..cf5940515c 100644 --- a/exchange/exchange-ps/exchange/Get-ADSite.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ADSite.md @@ -1,27 +1,28 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adsite -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ADSite -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adsite +schema: 2.0.0 +title: Get-ADSite --- -# Get-AdSite +# Get-ADSite ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-AdSite cmdlet to display configuration information about one or more Active Directory sites. +Use the Get-ADSite cmdlet to display configuration information about one or more Active Directory sites. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-AdSite [[-Identity] ] +Get-ADSite [[-Identity] ] [-DomainController ] [] ``` @@ -29,13 +30,13 @@ Get-AdSite [[-Identity] ] ## DESCRIPTION Exchange uses Active Directory sites and the costs assigned to the Active Directory site links to make message routing decisions. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AdSite Default-First-Site-Name +Get-ADSite Default-First-Site-Name ``` This example displays the configuration details for the Active Directory site named Default-First-Site-Name. @@ -43,13 +44,15 @@ This example displays the configuration details for the Active Directory site na ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the Active Directory site for which you want to view configuration details. The identity can be expressed as a GUID or the Active Directory site name. If the Active Directory site name includes spaces, enclose the name in quotation marks ("). ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -67,7 +73,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AdSiteLink.md b/exchange/exchange-ps/ExchangePowerShell/Get-ADSiteLink.md similarity index 74% rename from exchange/exchange-ps/exchange/Get-AdSiteLink.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ADSiteLink.md index 11565da45f..b2dc772e31 100644 --- a/exchange/exchange-ps/exchange/Get-AdSiteLink.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ADSiteLink.md @@ -1,33 +1,34 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adsitelink -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AdSiteLink -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adsitelink +schema: 2.0.0 +title: Get-ADSiteLink --- -# Get-AdSiteLink +# Get-ADSiteLink ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-AdSiteLink cmdlet to view configuration information about an Active Directory IP site link. +Use the Get-ADSiteLink cmdlet to view configuration information about an Active Directory IP site link. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-AdSiteLink [[-Identity] ] +Get-ADSiteLink [[-Identity] ] [-DomainController ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,7 +41,7 @@ This example returns a list of all IP site links in your organization. ### Example 2 ```powershell -Get-AdSiteLink | Where {$_.ExchangeCost -ne $null} +Get-ADSiteLink | Where {$_.ExchangeCost -ne $null} ``` This example returns a list of all IP site links in your organization that have a specific Exchange cost assigned. @@ -48,13 +49,15 @@ This example returns a list of all IP site links in your organization that have ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name or GUID of the IP site link for which you want to view configuration information. ```yaml Type: AdSiteLinkIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -72,7 +78,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ATPBuiltInProtectionRule.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ATPBuiltInProtectionRule.md index 714d4981eb..2cb22176b0 100644 --- a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ATPBuiltInProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-atpbuiltinprotectionrule applicable: Exchange Online -title: Get-ATPBuiltInProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-atpbuiltinprotectionrule +schema: 2.0.0 +title: Get-ATPBuiltInProtectionRule --- # Get-ATPBuiltInProtectionRule @@ -27,7 +28,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,6 +42,9 @@ This example shows the rule for the Built-in protection preset security policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -53,7 +57,6 @@ The name of the only rule is ATP Built-In Protection Rule. Type: DehydrateableRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by the state of the rule. Valid values are: - Disabled @@ -75,7 +81,6 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ATPProtectionPolicyRule.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ATPProtectionPolicyRule.md index f0a24d140f..963826fe7e 100644 --- a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-atpprotectionpolicyrule applicable: Exchange Online -title: Get-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-atpprotectionpolicyrule +schema: 2.0.0 +title: Get-ATPProtectionPolicyRule --- # Get-ATPProtectionPolicyRule @@ -29,7 +30,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example returns detailed information about the rule named Strict Preset Sec ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -62,7 +66,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by the state of the rule. Valid values are: - Enabled @@ -82,7 +88,6 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-ATPTotalTrafficReport.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ATPTotalTrafficReport.md index 754759eea3..75dddf8e56 100644 --- a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ATPTotalTrafficReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-atptotaltrafficreport applicable: Exchange Online, Exchange Online Protection -title: Get-ATPTotalTrafficReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-atptotaltrafficreport +schema: 2.0.0 +title: Get-ATPTotalTrafficReport --- # Get-ATPTotalTrafficReport @@ -55,7 +56,7 @@ If the tenant had Safe Attachments or Safe Links policies, the messages would ha By default, the command returns data for the last 14 days. Data for the last 90 days is available. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,6 +70,9 @@ This example returns data for the last 5 days. ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -77,7 +81,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Exchange Online Protection + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -114,7 +122,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -148,7 +160,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -158,13 +169,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -190,13 +205,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -214,7 +234,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -224,6 +243,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online, Exchange Online Protection + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. For this cmdlet, valid values are: @@ -239,7 +261,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-AcceptedDomain.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-AcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AcceptedDomain.md index 7a46a55884..f8e9f88d86 100644 --- a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AcceptedDomain.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-accepteddomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AcceptedDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-accepteddomain +schema: 2.0.0 +title: Get-AcceptedDomain --- # Get-AcceptedDomain ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-AcceptedDomain cmdlet to view the configuration information for the accepted domains in your organization. @@ -28,7 +29,7 @@ Get-AcceptedDomain [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example lists all the authoritative accepted domains in your organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies a string value for the accepted domain. Enter either the GUID or the name of the accepted domain. ```yaml Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -75,7 +81,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -93,7 +101,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-AccessToCustomerDataRequest.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AccessToCustomerDataRequest.md index c42017f450..995c951c19 100644 --- a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AccessToCustomerDataRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-accesstocustomerdatarequest applicable: Exchange Online, Exchange Online Protection -title: Get-AccessToCustomerDataRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-accesstocustomerdatarequest +schema: 2.0.0 +title: Get-AccessToCustomerDataRequest --- # Get-AccessToCustomerDataRequest @@ -30,7 +31,7 @@ Get-AccessToCustomerDataRequest [-ApprovalStatus ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example returns detailed information the Customer Lockbox request EXSR12345 ## PARAMETERS ### -ApprovalStatus + +> Applicable: Exchange Online, Exchange Online Protection + The ApprovalStatus parameter filters the results by approval status. Valid values are: - Approved @@ -69,7 +73,6 @@ The ApprovalStatus parameter filters the results by approval status. Valid value Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -CreatedAfter + +> Applicable: Exchange Online, Exchange Online Protection + The CreatedAfter parameter filters the results by the creation date in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -90,7 +96,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -RequestId + +> Applicable: Exchange Online, Exchange Online Protection + The RequestId parameter filters the results by reference number (for example, EXSR123456). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDevice.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDevice.md index 76afb95c32..e1b5977672 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDevice.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdevice -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDevice -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncdevice +schema: 2.0.0 +title: Get-ActiveSyncDevice --- # Get-ActiveSyncDevice ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ActiveSyncDevice cmdlet to retrieve the list of devices in your organization that have active Exchange ActiveSync partnerships. @@ -49,7 +50,7 @@ Get-ActiveSyncDevice [[-Identity] ] ## DESCRIPTION The Get-ActiveSyncDevice cmdlet returns identification, configuration and status information for each device. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,6 +78,9 @@ This example returns the owner names of all Outlook Mobile apps that synch via H ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the ActiveSync device that you want to view. You can use any value that uniquely identifies the device. For example: - GUID @@ -87,7 +91,6 @@ The Identity parameter specifies the ActiveSync device that you want to view. Yo Type: ActiveSyncDeviceIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that has the associated ActiveSync device that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -114,7 +120,6 @@ The Mailbox parameter specifies the mailbox that has the associated ActiveSync d Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -132,7 +140,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -178,7 +188,6 @@ You can filter by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,6 +197,9 @@ Accept wildcard characters: False ``` ### -Monitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch. @@ -198,7 +210,6 @@ Monitoring mailboxes are associated with managed availability and the Exchange H Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,6 +219,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -219,7 +233,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -229,13 +242,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -245,6 +260,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -271,7 +289,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAccessRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAccessRule.md index d3a5a05c35..0015a845a2 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAccessRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdeviceaccessrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDeviceAccessRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncdeviceaccessrule +schema: 2.0.0 +title: Get-ActiveSyncDeviceAccessRule --- # Get-ActiveSyncDeviceAccessRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ActiveSyncDeviceAccessRule cmdlet to retrieve an access group of Exchange mobile devices along with their access level. @@ -29,7 +30,7 @@ Get-ActiveSyncDeviceAccessRule [[-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the unique identifier for the device access rule. ```yaml Type: ActiveSyncDeviceAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAutoblockThreshold.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAutoblockThreshold.md index 0bb8724eba..05910263be 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAutoblockThreshold.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdeviceautoblockthreshold -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ActiveSyncDeviceAutoblockThreshold -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncdeviceautoblockthreshold +schema: 2.0.0 +title: Get-ActiveSyncDeviceAutoblockThreshold --- # Get-ActiveSyncDeviceAutoblockThreshold @@ -29,7 +30,7 @@ Get-ActiveSyncDeviceAutoblockThreshold [[-Identity] Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the Autoblock threshold rule. ```yaml Type: ActiveSyncDeviceAutoblockThresholdIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceClass.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceClass.md index 56664b5b8c..3759a942e5 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceClass.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdeviceclass -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDeviceClass -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncdeviceclass +schema: 2.0.0 +title: Get-ActiveSyncDeviceClass --- # Get-ActiveSyncDeviceClass ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ActiveSyncDeviceClass cmdlet to retrieve a list of ActiveSync devices that have connected to your organization. The cmdlet returns the mobile device type and model information. @@ -31,7 +32,7 @@ Get-ActiveSyncDeviceClass [[-Identity] ] ## DESCRIPTION You can use this cmdlet to view a list of mobile phones or devices by type. For example, you can return a list of all Android mobile digital devices in the organization or all Windows Phone devices in the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example lists all device types within the organization along with a count o ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the ActiveSync device class that you want to view. You can use any value that uniquely identifies the ActiveSync device class. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the ActiveSync device class that you want to vi Type: ActiveSyncDeviceClassIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -80,7 +86,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -111,7 +119,6 @@ You can filter by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -135,7 +145,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceStatistics.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceStatistics.md index df60827dd4..d5c0c86cbd 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdevicestatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDeviceStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncdevicestatistics +schema: 2.0.0 +title: Get-ActiveSyncDeviceStatistics --- # Get-ActiveSyncDeviceStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ActiveSyncDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices. @@ -45,7 +46,7 @@ Get-ActiveSyncDeviceStatistics -Mailbox ## DESCRIPTION The Get-ActiveSyncDeviceStatistics cmdlet returns a list of statistics about each mobile device. Additionally, it allows you to retrieve logs and send those logs to a recipient for troubleshooting purposes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,13 +78,15 @@ This example retrieves the statistics for the mobile phone configured to synchro ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the user's device ID. If the Mailbox parameter is specified, the Identity parameter is disabled. ```yaml Type: ActiveSyncDeviceIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the user mailbox for which you want to retrieve the mobile phone statistics. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -110,7 +116,6 @@ The Mailbox parameter specifies the user mailbox for which you want to retrieve Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -128,7 +136,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -GetMailboxLog + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GetMailboxLog switch specifies whether to send the mobile device statistics to the email addresses that are specified by the NotificationEmailAddresses parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NotificationEmailAddresses parameter specifies a comma-separated list of email addresses to receive the mobile device statistics when you use the GetMailboxLog switch. This parameter is meaningful only if you also use the GetMailboxLog switch in the same command. @@ -162,7 +174,6 @@ This parameter is meaningful only if you also use the GetMailboxLog switch in th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -ShowRecoveryPassword + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowRecoveryPassword parameter specifies whether to return the recovery password for the mobile phone as one of the displayed statistics. If this parameter is set to $true, the command returns the recovery password for the mobile phone as one of the displayed statistics. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncMailboxPolicy.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncMailboxPolicy.md index c43f7a04a7..f77182f9be 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncmailboxpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncmailboxpolicy +schema: 2.0.0 +title: Get-ActiveSyncMailboxPolicy --- # Get-ActiveSyncMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ActiveSyncMailboxPolicy cmdlet to retrieve the Mobile Device mailbox policy settings for a specific Mobile Device mailbox policy. @@ -31,7 +32,7 @@ Get-ActiveSyncMailboxPolicy [[-Identity] ] ## DESCRIPTION A Mobile Device mailbox policy is a group of settings that specifies how mobile devices enabled for Microsoft Exchange ActiveSync connect to the computer running Exchange. Exchange supports multiple Mobile Device mailbox policies. The Get-ActiveSyncMailboxPolicy cmdlet displays all the policy settings for the specified policy. These settings include password settings, file access settings and attachment settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,13 +60,15 @@ This example returns the policy settings for the Mobile Device mailbox policy na ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the policy name. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -83,7 +89,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncOrganizationSettings.md similarity index 75% rename from exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncOrganizationSettings.md index 554ac124b7..c0fca3521c 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncOrganizationSettings.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncorganizationsettings -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncOrganizationSettings -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncorganizationsettings +schema: 2.0.0 +title: Get-ActiveSyncOrganizationSettings --- # Get-ActiveSyncOrganizationSettings ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ActiveSyncOrganizationSettings cmdlet to view the Microsoft Exchange ActiveSync settings for your organization. @@ -27,7 +28,7 @@ Get-ActiveSyncOrganizationSettings [[-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the ActiveSync organization settings object that you want to view. The default name of this object is Mobile Mailbox Settings. ```yaml Type: ActiveSyncOrganizationSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -65,7 +71,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncVirtualDirectory.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncVirtualDirectory.md index 84a7bede86..789f2035f0 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ActiveSyncVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncvirtualdirectory +schema: 2.0.0 +title: Get-ActiveSyncVirtualDirectory --- # Get-ActiveSyncVirtualDirectory @@ -41,7 +42,7 @@ Get-ActiveSyncVirtualDirectory [[-Identity] ] ## DESCRIPTION Microsoft Exchange servers have a default virtual directory that Exchange ActiveSync mobile devices use to synchronize with the server. You can create multiple virtual directories and assign different devices to different directories. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,6 +70,9 @@ This example returns a summary list of all Exchange ActiveSync virtual directori ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the ActiveSync virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -83,7 +87,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -106,7 +112,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -124,7 +132,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -160,7 +172,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AdaptiveScope.md b/exchange/exchange-ps/ExchangePowerShell/Get-AdaptiveScope.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-AdaptiveScope.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AdaptiveScope.md index 1444986464..1be2c8f35f 100644 --- a/exchange/exchange-ps/exchange/Get-AdaptiveScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AdaptiveScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adaptivescope applicable: Exchange Online, Security & Compliance -title: Get-AdaptiveScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adaptivescope +schema: 2.0.0 +title: Get-AdaptiveScope --- # Get-AdaptiveScope @@ -48,6 +49,9 @@ This example returns detailed information about the adaptive scope named Project ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the adaptive scope that you want to view. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the adaptive scope that you want to view. You c Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 0 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -AdministrativeUnits + +> Applicable: Exchange Online, Security & Compliance + {{ Fill AdministrativeUnits Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -LocationTypes + +> Applicable: Exchange Online, Security & Compliance + {{ Fill LocationTypes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-AddressBookPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-AddressBookPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AddressBookPolicy.md index 83e1de7f90..0b2ce64377 100644 --- a/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AddressBookPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-addressbookpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AddressBookPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-addressbookpolicy +schema: 2.0.0 +title: Get-AddressBookPolicy --- # Get-AddressBookPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-AddressBookPolicy cmdlet to return address book policies that match the specified conditions. @@ -29,7 +30,7 @@ Get-AddressBookPolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +58,15 @@ This example returns information about all address book policies for which the o ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the address book policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -81,7 +87,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/Get-AddressList.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AddressList.md index cf62cd285e..dda29c302b 100644 --- a/exchange/exchange-ps/exchange/Get-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AddressList.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-addresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-addresslist +schema: 2.0.0 +title: Get-AddressList --- # Get-AddressList ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-AddressList cmdlet to view address lists. @@ -46,7 +47,7 @@ Get-AddressList [-SearchText ] ## DESCRIPTION You can pipe the output from the Get-AddressList cmdlet to the Remove-AddressList, Set-AddressList, Update-AddressList and Move-AddressList cmdlets instead of using the Identity parameter with each of those cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example returns detailed information for the address list named building4th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the address list that you want to view. You can use any value that uniquely identifies the address list. For example: - Name @@ -80,7 +84,6 @@ You can't use this parameter with the Container or SearchText parameters. Type: AddressListIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -Container + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Container parameter filters the results based on the location of the address list. Only address lists under the specified path are returned. Valid input for this parameter is the root "\\" (also known as All Address Lists) or an existing address list. You can use any value that uniquely identifies the address list. For example: - Name @@ -103,7 +109,6 @@ You can't use this parameter with the Identity or SearchText parameters. Type: AddressListIdParameter Parameter Sets: Container Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -121,7 +129,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -SearchText + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SearchText parameter filters the results based on the name and display name of the address list. Only address lists whose names or display names that contain the specified text string are returned. If the value contains spaces, enclose the value in quotation marks ("). You can't use this parameter with the Container or Identity parameters. @@ -139,7 +149,6 @@ You can't use this parameter with the Container or Identity parameters. Type: String Parameter Sets: SearchSet 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-AddressRewriteEntry.md b/exchange/exchange-ps/ExchangePowerShell/Get-AddressRewriteEntry.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AddressRewriteEntry.md index 7faa2b133d..0112ac6ebb 100644 --- a/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AddressRewriteEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-addressrewriteentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AddressRewriteEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-addressrewriteentry +schema: 2.0.0 +title: Get-AddressRewriteEntry --- # Get-AddressRewriteEntry @@ -48,13 +49,15 @@ This example returns the detailed configuration of a single address rewrite entr ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the address rewrite entry to be retrieved. The Identity parameter accepts a GUID or the unique address rewrite name. You can omit the Identity parameter label. ```yaml Type: AddressRewriteEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -72,7 +78,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-AdminAuditLogConfig.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AdminAuditLogConfig.md index e9159a5432..915760fcaa 100644 --- a/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AdminAuditLogConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adminauditlogconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-AdminAuditLogConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adminauditlogconfig +schema: 2.0.0 +title: Get-AdminAuditLogConfig --- # Get-AdminAuditLogConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-AdminAuditLogConfig cmdlet to view the administrator audit logging configuration settings. @@ -28,7 +29,7 @@ Get-AdminAuditLogConfig [-DomainController ] ## DESCRIPTION To check the UnifiedAuditLogIngestionEnabled value in the output of this cmdlet, run the command in Exchange Online PowerShell. The value in Security & Compliance PowerShell is always False and the Set-AdminAuditLogConfig cmdlet (and the UnifiedAuditLogIngestionEnabled parameter) is not available to change it. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example displays the administrator audit logging settings. The output of th ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -53,7 +57,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md b/exchange/exchange-ps/ExchangePowerShell/Get-AdministrativeUnit.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-AdministrativeUnit.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AdministrativeUnit.md index 6a2753ab2d..3f34d4e2c3 100644 --- a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AdministrativeUnit.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-administrativeunit -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AdministrativeUnit -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-administrativeunit +schema: 2.0.0 +title: Get-AdministrativeUnit --- # Get-AdministrativeUnit @@ -31,7 +32,7 @@ Get-AdministrativeUnit [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example returns detailed information about the administrative unit with the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the administrative unit that you want to view. You can use any value that uniquely identifies the administrative unit. For example: - Display name (this value is the same in Microsoft Graph PowerShell) @@ -64,7 +68,6 @@ The Identity parameter specifies the administrative unit that you want to view. Type: AdministrativeUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -101,7 +109,6 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,13 +118,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AgentLog.md b/exchange/exchange-ps/ExchangePowerShell/Get-AgentLog.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-AgentLog.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AgentLog.md index 90b89266d4..97f37bc9e7 100644 --- a/exchange/exchange-ps/exchange/Get-AgentLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AgentLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-agentlog -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AgentLog -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-agentlog +schema: 2.0.0 +title: Get-AgentLog --- # Get-AgentLog @@ -29,7 +30,7 @@ Get-AgentLog [-EndDate ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example returns a report that has statistics collected between 09:00 (9 A.M ## PARAMETERS ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -51,7 +55,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -Location + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Location parameter specifies the directory that contains the log files that you can use to build usage reports. The default path is %ExchangeInstallPath%TransportRoles\\Logs\\AgentLog. You need to enclose the file path in quotation marks ("). ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -77,6 +82,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -85,7 +93,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,6 +102,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -107,7 +117,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AggregateZapReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-AggregateZapReport.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-AggregateZapReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AggregateZapReport.md index fd62052590..1a7944c6c3 100644 --- a/exchange/exchange-ps/exchange/Get-AggregateZapReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AggregateZapReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-aggregatezapreport applicable: Exchange Online -title: Get-AggregateZapReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-aggregatezapreport +schema: 2.0.0 +title: Get-AggregateZapReport --- # Get-AggregateZapReport @@ -36,7 +37,7 @@ For the reporting period you specify, the cmdlet returns the following informati - EventType - ZapActionCount -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,6 +58,9 @@ This example retrieves information for the specified date range. ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured 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". @@ -67,7 +71,6 @@ If you use the EndDate parameter, you also need to use the StartDate parameter. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 3 @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". @@ -119,7 +129,6 @@ If you use this parameter, you also need to use the StartDate parameter. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 4 diff --git a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishPolicy.md index 332d193a34..819eba076b 100644 --- a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-antiphishpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-AntiPhishPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-antiphishpolicy +schema: 2.0.0 +title: Get-AntiPhishPolicy --- # Get-AntiPhishPolicy @@ -29,7 +30,7 @@ Get-AntiPhishPolicy [-Identity ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example shows detailed information about the antiphish policy named Office ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the antiphish policy that you want to view. You Type: AntiPhishPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Advanced + +> Applicable: Exchange Online + The Advanced switch filters the properties that are returned to the advanced settings in the policy. For example: - PhishThresholdLevel @@ -83,7 +89,6 @@ Advanced settings are available only in anti-phishing policies in Microsoft Defe Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Impersonation + +> Applicable: Exchange Online + The Impersonation switch filters the properties that are returned to the impersonation settings in the policy. For example: - EnableMailboxIntelligence @@ -123,7 +131,6 @@ Impersonation settings are available only in anti-phishing policies in Microsoft Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -Spoof + +> Applicable: Exchange Online, Exchange Online Protection + The Spoof switch filters the properties that are returned to the spoof settings in the policy. For example: - EnableAntiSpoofEnforcement @@ -144,7 +154,6 @@ You don't need to specify a value with this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishRule.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishRule.md index 9593dd004c..729fd881f2 100644 --- a/exchange/exchange-ps/exchange/Get-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: Get-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-antiphishrule +schema: 2.0.0 +title: Get-AntiPhishRule --- # Get-AntiPhishRule @@ -27,7 +28,7 @@ Get-AntiPhishRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example returns detailed information about the antiphish rule named Researc ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the antiphish rule that you want to view. You c Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online, Exchange Online Protection + The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-App.md b/exchange/exchange-ps/ExchangePowerShell/Get-App.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-App.md rename to exchange/exchange-ps/ExchangePowerShell/Get-App.md index 4d63102688..6fcb3f8850 100644 --- a/exchange/exchange-ps/exchange/Get-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-App.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-app -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-App -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-app +schema: 2.0.0 +title: Get-App --- # Get-App ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-App cmdlet to view installed apps. @@ -32,7 +33,7 @@ Get-App [[-Identity] ] ## DESCRIPTION The Get-App cmdlet returns information about all installed apps or the details of a specific installed app. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,13 +61,15 @@ This example displays the summary list of apps installed by administrators for t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID of the app that you want to view. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. ```yaml Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -84,7 +90,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the identity of the mailbox where the apps are installed. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -115,7 +123,6 @@ You can't use this parameter with the Identity parameter. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -OrganizationApp + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OrganizationApp switch includes apps that are installed for the organization (not bound to a specific user) in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -141,6 +150,9 @@ Accept wildcard characters: False ``` ### -PrivateCatalog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PrivateCatalog switch includes private catalog add-ins in the results. You don't need to specify a value with this switch. You need to use this switch with the OrganizationApp switch. @@ -149,7 +161,6 @@ You need to use this switch with the OrganizationApp switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionCompliancePolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionCompliancePolicy.md index 1feb6b2100..bf1ee91fe5 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-appretentioncompliancepolicy applicable: Security & Compliance -title: Get-AppRetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-appretentioncompliancepolicy +schema: 2.0.0 +title: Get-AppRetentionCompliancePolicy --- # Get-AppRetentionCompliancePolicy @@ -29,7 +30,7 @@ Get-AppRetentionCompliancePolicy [[-Identity] ] ``` ## 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 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 likely need to create one policy per workload. To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). @@ -52,6 +53,9 @@ This example returns detailed information for the app retention compliance polic ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the app retention compliance policy that you wa Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -ErrorPolicyOnly + +> Applicable: Security & Compliance + {{ Fill ErrorPolicyOnly Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -RetentionRuleTypes + +> Applicable: Security & Compliance + The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch. To see the RetentionRuleTypes property, you need to pipe the command to a formatting cmdlet. For example, `Get-AppRetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes`. If you don't use the RetentionRuleTypes switch, the value appears blank. @@ -112,7 +122,6 @@ To see the RetentionRuleTypes property, you need to pipe the command to a format Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionComplianceRule.md index b61fb71ac0..ceca879adc 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-appretentioncompliancerule applicable: Security & Compliance -title: Get-AppRetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-appretentioncompliancerule +schema: 2.0.0 +title: Get-AppRetentionComplianceRule --- # Get-AppRetentionComplianceRule @@ -46,6 +47,9 @@ This example returns detailed information for the app retention compliance rule ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance rule that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the app retention compliance rule that you want Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter filters the app retention compliance rule results by the associated app retention compliance policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -76,7 +82,6 @@ The Policy parameter filters the app retention compliance rule results by the as Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ApplicationAccessPolicy.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ApplicationAccessPolicy.md index 60e3070aa4..e2c7f08d47 100644 --- a/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ApplicationAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection -title: Get-ApplicationAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-applicationaccesspolicy +schema: 2.0.0 +title: Get-ApplicationAccessPolicy --- # Get-ApplicationAccessPolicy @@ -28,7 +29,7 @@ Get-ApplicationAccessPolicy [[-Identity] ] ## DESCRIPTION This feature applies only to apps connecting to the Microsoft Graph API for Outlook resources. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example returns detailed information for the specified application access p ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the application access policy that you want to view. To find the Identity value for the policy, run the command Get-ApplicationAccessPolicy | Format-List Identity,Description,ScopeName,AccessRight,AppID. ```yaml Type: ApplicationAccessPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-ArcConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-ArcConfig.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-ArcConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ArcConfig.md index 84df4c911e..b85c65bf0f 100644 --- a/exchange/exchange-ps/exchange/Get-ArcConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ArcConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-arcconfig applicable: Exchange Online -title: Get-ArcConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-arcconfig +schema: 2.0.0 +title: Get-ArcConfig --- # Get-ArcConfig @@ -27,7 +28,7 @@ Get-ArcConfig [] ## DESCRIPTION Services that modify message content in transit before delivery can invalidate DKIM email signatures and affect the authentication of the message. These services can use ARC to provide details of the original authentication before the modifications occurred. Your organization can then trust these details to help authenticate the message. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions 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-AtpPolicyForO365.md b/exchange/exchange-ps/ExchangePowerShell/Get-AtpPolicyForO365.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AtpPolicyForO365.md index 31818f3779..4ab8b7aacd 100644 --- a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AtpPolicyForO365.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-atppolicyforo365 applicable: Exchange Online -title: Get-AtpPolicyForO365 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-atppolicyforo365 +schema: 2.0.0 +title: Get-AtpPolicyForO365 --- # Get-AtpPolicyForO365 @@ -36,7 +37,7 @@ Safe Documents scans documents and files that are opened in Protected View. For 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example returns detailed information about the default policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the policy that you want to modify. There's only one policy named Default. ```yaml Type: AtpPolicyForO365IdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md b/exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterEntry.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterEntry.md index f9144d58cd..646a49659f 100644 --- a/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-attachmentfilterentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AttachmentFilterEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-attachmentfilterentry +schema: 2.0.0 +title: Get-AttachmentFilterEntry --- # Get-AttachmentFilterEntry @@ -27,7 +28,7 @@ Get-AttachmentFilterEntry [[-Identity] ] ``` ## DESCRIPTION -On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchangepowershell/set-attachmentfilterlistconfig). On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. @@ -57,6 +58,9 @@ This example returns only the attachment filter entries that filter attachments ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies which attachment filter entry the command retrieves. The Identity parameter accepts values in the format Type:Name, where Type is one of the following values: - ContentType: This value matches the attachment filter entry against the MIME content type. @@ -66,7 +70,6 @@ The Identity parameter specifies which attachment filter entry the command retri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -84,7 +90,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterListConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterListConfig.md index f05c82c01c..66ab27f224 100644 --- a/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-attachmentfilterlistconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AttachmentFilterListConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-attachmentfilterlistconfig +schema: 2.0.0 +title: Get-AttachmentFilterListConfig --- # Get-AttachmentFilterListConfig @@ -42,6 +43,9 @@ This example returns detailed information about the Attachment Filtering agent c ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -50,7 +54,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuditConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuditConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-AuditConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuditConfig.md index 65476171dc..764e429abb 100644 --- a/exchange/exchange-ps/exchange/Get-AuditConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuditConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-auditconfig applicable: Security & Compliance -title: Get-AuditConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-auditconfig +schema: 2.0.0 +title: Get-AuditConfig --- # Get-AuditConfig @@ -40,13 +41,15 @@ This example shows the auditing configuration in the Microsoft Purview complianc ## PARAMETERS ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuditLogSearch.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuditLogSearch.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-AuditLogSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuditLogSearch.md index a77201fca0..2045a18d7e 100644 --- a/exchange/exchange-ps/exchange/Get-AuditLogSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuditLogSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-auditlogsearch -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AuditLogSearch -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-auditlogsearch +schema: 2.0.0 +title: Get-AuditLogSearch --- # Get-AuditLogSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-AuditLogSearch cmdlet to return a list of current audit log searches that were created with the New-AdminAuditLogSearch or New-MailboxAuditLogSearch cmdlets. The Get-AuditLogSearch cmdlet also returns audit log searches that are initiated whenever an administrator uses the Exchange admin center (EAC) to export audit logs. @@ -30,9 +31,9 @@ Get-AuditLogSearch [[-Identity] ] ``` ## DESCRIPTION -Run the Get-AuditLogSearch cmdlet to return a list of pending audit log searches. If an audit log search has been completed, it won't be displayed in the list of audit log searches. +Run the Get-AuditLogSearch cmdlet to return a list of pending audit log searches. If an audit log search has completed, it isn't displayed in the list of audit log searches. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example returns a list of current administrator audit log searches. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID for an audit log search. You can run the command Get-AuditLogSearch | Format-List Identity to display the GUIDs for all current audit log searches. ```yaml Type: AuditLogSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -CreatedAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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". @@ -77,7 +83,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -CreatedBefore + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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". @@ -95,7 +103,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Type parameter specifies the type of audit log searches to return. Use the value Admin to return administrator audit log searches or use mailbox to return mailbox audit log searches. If the Type parameter isn't used, the cmdlet returns both administrator and mailbox audit log searches. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuthConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuthConfig.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-AuthConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuthConfig.md index 7acbfbce8c..7bdab82ee5 100644 --- a/exchange/exchange-ps/exchange/Get-AuthConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuthConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-authconfig -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AuthConfig -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-authconfig +schema: 2.0.0 +title: Get-AuthConfig --- # Get-AuthConfig @@ -26,7 +27,7 @@ Get-AuthConfig [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,13 +41,15 @@ This example retrieves the authorization configuration for the Exchange organiza ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuthRedirect.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuthRedirect.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-AuthRedirect.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuthRedirect.md index a1e538e22c..657835080e 100644 --- a/exchange/exchange-ps/exchange/Get-AuthRedirect.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuthRedirect.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-authredirect -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AuthRedirect -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-authredirect +schema: 2.0.0 +title: Get-AuthRedirect --- # Get-AuthRedirect @@ -29,7 +30,7 @@ Get-AuthRedirect [[-Identity] ] ## DESCRIPTION Exchange 2010 Client Access servers don't support OAuth authentication requests. OAuth redirection objects redirect OAuth authentication requests to Exchange servers that are running later versions of Exchange. This cmdlet is only useful if your organization has Exchange 2010 Client Access servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example shows detailed information about the OAuth redirection object named ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the existing OAuth redirection object that you want to view. The object name uses the syntax `AuthRedirect-Bearer-GUID`. ```yaml Type: AuthRedirectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuthServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuthServer.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-AuthServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuthServer.md index ecf577d5a2..a92ebaca89 100644 --- a/exchange/exchange-ps/exchange/Get-AuthServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuthServer.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-authserver -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AuthServer -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-authserver +schema: 2.0.0 +title: Get-AuthServer --- # Get-AuthServer ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-AuthServer cmdlet to view the settings of authorization servers in the Exchange organization. @@ -29,7 +30,7 @@ Get-AuthServer [[-Identity] ] ## DESCRIPTION An authorization server is a server or service that issues tokens trusted by Microsoft Exchange for access by partner applications. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example retrieves detailed information for the authorization server named W ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the authorization server object that you want to view. You can use any value that uniquely identifies the authorization server. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the authorization server object that you want t Type: AuthServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -78,7 +84,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuthenticationPolicy.md similarity index 58% rename from exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuthenticationPolicy.md index 7c9cce1ad9..67391dcc72 100644 --- a/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuthenticationPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-authenticationpolicy -applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AuthenticationPolicy -schema: 2.0.0 +applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-authenticationpolicy +schema: 2.0.0 +title: Get-AuthenticationPolicy --- # Get-AuthenticationPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-AuthenticationPolicy cmdlet to view authentication policies in your organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -27,7 +28,7 @@ Get-AuthenticationPolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ In Exchange Online, this example specifies whether legacy Exchange tokens for Ou ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the authentication policy you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the authentication policy you want to view. You Type: AuthPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyExchangeTokens + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -83,14 +89,13 @@ Legacy Exchange tokens include Exchange user identity and callback tokens. **Important**: -- Currently, the AllowLegacyExchangeTokens switch only specifies whether legacy Exchange tokens are allowed in your organization. For now, disregard the empty Allowed and Blocked arrays returned by the switch. -- Legacy Exchange tokens will eventually be 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). +- Legacy Exchange Online tokens will be turned off for all organizations from August 2025 through September 2025. Once turned off, you can't use the _AllowLegacyExchangeTokens_ switch on the **Set-AuthenticationPolicy** cmdlet to turn on these tokens. You get the warning "Legacy Exchange Online tokens are disabled" when you run the command `Get-AuthenticationPolicy -AllowLegacyExchangeTokens`. You can [contact Microsoft Support to request an exception](https://aka.ms/LegacyTokensByOctober). 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). +- 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). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill TenantId Description }} @@ -108,7 +116,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelPolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelPolicy.md index 47aaff24d4..11abe41196 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-autosensitivitylabelpolicy applicable: Security & Compliance -title: Get-AutoSensitivityLabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-autosensitivitylabelpolicy +schema: 2.0.0 +title: Get-AutoSensitivityLabelPolicy --- # Get-AutoSensitivityLabelPolicy @@ -44,6 +45,9 @@ This example returns detailed information about the autosensitivity label policy ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the auto-labeling policy that you want to view. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -80,16 +85,18 @@ Accept wildcard characters: False ``` ### -ForceValidate + +> Applicable: Security & Compliance + The ForceValidate parameter specifies whether to include details related to the AdminUnits of users, groups, or sites in the policy. Valid values are: - $true: Various properties in the policy include details of the AdminUnits that are associated with current set of selected users, groups, or sites. -- $false: The output doesn't contain the information. This is the default value. +- $false: The output doesn't contain the information. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -99,7 +106,10 @@ Accept wildcard characters: False ``` ### -IncludeProgressFeedback -IncludeProgressFeedback specifies whether to include the labeling progress of files in SharePoint Online or OneDrive for Business. You don't need to specify a value with this switch. + +> Applicable: Security & Compliance + +IncludeProgressFeedback specifies whether to include the labeling progress of files in SharePoint or OneDrive. You don't need to specify a value with this switch. If you use this switch, the command shows the progress of files to be labeled, files labeled in the last 7 days, and total files labeled for enabled auto-labeling policies. @@ -107,7 +117,6 @@ If you use this switch, the command shows the progress of files to be labeled, f Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,6 +126,9 @@ Accept wildcard characters: False ``` ### -IncludeTestModeResults + +> Applicable: Security & Compliance + The IncludeTestModeResults parameter specifies whether to include the status of test mode in the policy details. Valid values are: - $true: Include the status of test mode in the policy details. @@ -126,7 +138,6 @@ The IncludeTestModeResults parameter specifies whether to include the status of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelRule.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelRule.md index ebaea6d9d6..4db72e7ae3 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-autosensitivitylabelrule applicable: Security & Compliance -title: Get-AutoSensitivityLabelRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-autosensitivitylabelrule +schema: 2.0.0 +title: Get-AutoSensitivityLabelRule --- # Get-AutoSensitivityLabelRule @@ -46,6 +47,9 @@ This example displays summary information for all autolabeling rules in the Micr ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the auto-labeling policy rule that you want to Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceValidate + +> Applicable: Security & Compliance + {{ Fill ForceValidate Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,16 +105,18 @@ Accept wildcard characters: False ``` ### -IncludeExecutionRuleGuids + +> Applicable: Security & Compliance + The IncludeExecutionRuleGuids parameter specifies whether to include the execution rule GUID in the rule details. Valid values are: - $true: Include the execution rule GUID in the rule details. -- $false: Don't include the execution rule GUID in the rule details. This is the default value. +- $false: Don't include the execution rule GUID in the rule details. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,16 +126,18 @@ Accept wildcard characters: False ``` ### -IncludeExecutionRuleInformation + +> Applicable: Security & Compliance + The IncludeExecutionRuleInformation parameter specifies whether to include the execution rule information in the rule details. Valid values are: - $true: Include the execution rule information in the rule details. -- $false: Don't include the execution rule information in the rule details. This is the default value. +- $false: Don't include the execution rule information in the rule details. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -136,6 +147,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter filters the auto-labeling policy rule results by the associated auto-labeling policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -146,7 +160,6 @@ The Policy parameter filters the auto-labeling policy rule results by the associ Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -156,13 +169,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-AutodiscoverVirtualDirectory.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AutodiscoverVirtualDirectory.md index e8c693c9bf..d247dcbc5e 100644 --- a/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AutodiscoverVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-autodiscovervirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AutodiscoverVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-autodiscovervirtualdirectory +schema: 2.0.0 +title: Get-AutodiscoverVirtualDirectory --- # Get-AutodiscoverVirtualDirectory @@ -39,7 +40,7 @@ Get-AutodiscoverVirtualDirectory [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example returns a summary list of all Autodiscover virtual directories in t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Autodiscover virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -81,7 +85,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -104,7 +110,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -122,7 +130,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -158,7 +170,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityAddressSpace.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityAddressSpace.md index bfde6fcc4c..5b91b6e32b 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityAddressSpace.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-availabilityaddressspace -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AvailabilityAddressSpace -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-availabilityaddressspace +schema: 2.0.0 +title: Get-AvailabilityAddressSpace --- # Get-AvailabilityAddressSpace ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-AvailabilityAddressSpace cmdlet to view existing availability address space objects that are used to share free/busy data across Exchange organizations. @@ -29,7 +30,7 @@ Get-AvailabilityAddressSpace [[-Identity] ] ## DESCRIPTION In on-premises Exchange organizations, you run the Remove-AvailabilityAddressSpace cmdlet on Exchange servers that have the Client Access server role installed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example returns details information for the availability address space obje ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the availability address space that you want to view. You can use any value that uniquely identifies the object. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the availability address space that you want to Type: AvailabilityAddressSpaceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -78,7 +84,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityConfig.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-AvailabilityConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityConfig.md index 7932aaed30..7a7ef25ed3 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-availabilityconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AvailabilityConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-availabilityconfig +schema: 2.0.0 +title: Get-AvailabilityConfig --- # Get-AvailabilityConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-AvailabilityConfig cmdlet to view information about the sharing of free/busy information between organizations: @@ -30,7 +31,7 @@ Get-AvailabilityConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +47,15 @@ In Exchange Online, this examples returns the tenant IDs that free/busy informat ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -70,7 +76,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityReportOutage.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityReportOutage.md index b73d3f29f3..34915d7e93 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityReportOutage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-availabilityreportoutage applicable: Exchange Server 2010 -title: Get-AvailabilityReportOutage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-availabilityreportoutage +schema: 2.0.0 +title: Get-AvailabilityReportOutage --- # Get-AvailabilityReportOutage @@ -29,7 +30,7 @@ Get-AvailabilityReportOutage [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example returns all outages reported for Microsoft Outlook services at all ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the outage. ```yaml Type: AvailabilityReportOutageIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -ReportDate + +> Applicable: Exchange Server 2010 + The ReportDate parameter specifies the date to query for the outage report. ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ReportingDatabase + +> Applicable: Exchange Server 2010 + The ReportingDatabase specifies the name of the database on the reporting server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -ReportingServer + +> Applicable: Exchange Server 2010 + The ReportingServer parameter specifies the name of the reporting database server to connect to. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-BlockedConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-BlockedConnector.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-BlockedConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-BlockedConnector.md index c6701d3230..e32648d522 100644 --- a/exchange/exchange-ps/exchange/Get-BlockedConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-BlockedConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-blockedconnector applicable: Exchange Online, Exchange Online Protection -title: Get-BlockedConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-blockedconnector +schema: 2.0.0 +title: Get-BlockedConnector --- # Get-BlockedConnector @@ -25,7 +26,7 @@ Get-BlockedConnector [-ConnectorId ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +47,15 @@ This example returns detailed information for the specified blocked connector. ## PARAMETERS ### -ConnectorId + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorId parameter specifies the blocked connector that you want to view. The value is a GUID (for example, 159eb7c4-75d7-43e2-95fe-ced44b3e0a56). ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md b/exchange/exchange-ps/ExchangePowerShell/Get-BlockedSenderAddress.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md rename to exchange/exchange-ps/ExchangePowerShell/Get-BlockedSenderAddress.md index 4a14ad443b..8a230bbf7a 100644 --- a/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-BlockedSenderAddress.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-blockedsenderaddress applicable: Exchange Online, Exchange Online Protection -title: Get-BlockedSenderAddress -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-blockedsenderaddress +schema: 2.0.0 +title: Get-BlockedSenderAddress --- # Get-BlockedSenderAddress @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-BlockedSenderAddress cmdlet to view users in your Microsoft 365 organization that are impacted by the protection system. These users sent multiple messages that were classified as spam, so they're blocked from sending messages. +Use the Get-BlockedSenderAddress cmdlet to view users in your Microsoft 365 organization that are affected by the protection system. These users sent multiple messages that were classified as spam, so they're blocked from sending messages. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -26,7 +27,7 @@ Get-BlockedSenderAddress [-SenderAddress ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example returns information about the blocked sender laura@contoso.com. ## PARAMETERS ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the email address of the blocked user. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CASMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-CASMailbox.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-CASMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CASMailbox.md index 00439ed122..a7e139117d 100644 --- a/exchange/exchange-ps/exchange/Get-CASMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CASMailbox.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-casmailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-CASMailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-casmailbox +schema: 2.0.0 +title: Get-CASMailbox --- # Get-CASMailbox ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-CASMailbox cmdlet to view the Client Access settings that are configured on mailboxes. @@ -65,7 +66,7 @@ Get-CASMailbox [[-Identity] ] ## DESCRIPTION This cmdlet returns a variety of client access settings for one or more mailboxes. These settings include options for Outlook on the web, Exchange ActiveSync, POP3, and IMAP4. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -106,6 +107,9 @@ In Exchange Online, this example filters the cmdlet output to only include share ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -123,7 +127,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -133,6 +136,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncDebugLogging + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActiveSyncDebugLogging switch shows the actual value of the ActiveSyncDebugLogging property for the mailbox. You don't need to specify a value with this switch. If you don't use this switch, the value always appears as $false. @@ -143,7 +149,6 @@ To see this value, you need to use a formatting cmdlet. For example, `Get-CasMai Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -153,13 +158,15 @@ Accept wildcard characters: False ``` ### -ActiveSyncSuppressReadReceipt + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -169,6 +176,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -181,7 +191,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -191,6 +200,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -199,7 +211,6 @@ This parameter requires the creation and passing of a credential object. This cr Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,6 +220,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -217,7 +231,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,6 +240,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -242,7 +258,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -252,6 +267,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -263,7 +281,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -273,6 +290,9 @@ Accept wildcard characters: False ``` ### -Monitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch. @@ -283,7 +303,6 @@ Monitoring mailboxes are associated with managed availability and the Exchange H Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +312,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -304,7 +326,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -314,6 +335,9 @@ Accept wildcard characters: False ``` ### -ProtocolSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings: - ExternalImapSettings @@ -331,7 +355,6 @@ To see these values, you need to use a formatting cmdlet. For example, `Get-CasM Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -341,6 +364,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -353,7 +379,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -363,13 +388,15 @@ Accept wildcard characters: False ``` ### -ReadIsOptimizedForAccessibility + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReadIsOptimizedForAccessibility switch specifies whether to read the value of the IsOptimizedForAccessibility property on the mailbox (whether the mailbox is configured to use the light version of Outlook on the web). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -379,6 +406,9 @@ Accept wildcard characters: False ``` ### -RecalculateHasActiveSyncDevicePartnership + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecalculateHasActiveSyncDevicePartnership switch recalculates the value of the HasActiveSyncDevicePartnership property on the mailbox. You don't need to specify a value with this switch. The value is automatically updated if it's found to be incorrect. @@ -387,7 +417,6 @@ The value is automatically updated if it's found to be incorrect. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -397,6 +426,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are: @@ -418,7 +450,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -428,13 +459,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -444,6 +477,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -458,7 +494,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md b/exchange/exchange-ps/ExchangePowerShell/Get-CASMailboxPlan.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-CASMailboxPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CASMailboxPlan.md index c825898743..6f009eb993 100644 --- a/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CASMailboxPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-casmailboxplan -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CASMailboxPlan -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-casmailboxplan +schema: 2.0.0 +title: Get-CASMailboxPlan --- # Get-CASMailboxPlan @@ -34,7 +35,7 @@ Get-CASMailboxPlan [[-Identity] ] ## DESCRIPTION A CAS mailbox plan is tied to the corresponding mailbox plan that has the same name (and display name). Like mailbox plans, CAS mailbox plans correspond to license types, and are applied to a mailbox when you license the user. The availability of a CAS mailbox plan is determined by your selections when you enroll in the service and the age of your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example returns detailed information about the specified CAS mailbox plan. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the CAS mailbox plan that you want to view. You can use any value that uniquely identifies the CAS mailbox plan. For example: - Name @@ -67,7 +71,6 @@ The display name and name of the CAS mailbox plan is the same as the correspondi Type: MailboxPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -85,7 +91,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -126,7 +136,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -144,7 +156,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,6 +183,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -185,7 +201,6 @@ The results are sorted in ascending order. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticAnalysis.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticAnalysis.md index 497c465e12..0d4e77967b 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticAnalysis.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CalendarDiagnosticAnalysis -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendardiagnosticanalysis +schema: 2.0.0 +title: Get-CalendarDiagnosticAnalysis --- # Get-CalendarDiagnosticAnalysis @@ -59,7 +60,7 @@ The following properties of the calendar item are returned in the default output - SenderEmailAddress - SentRepresentingDisplayName -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,6 +100,9 @@ For basic analysis of the items, don't include the DetailLevel parameter, or use ## PARAMETERS ### -CalendarLogs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CalendarLogs parameter specifies the calendar item that you want to analyze. You identify the calendar item by storing the output of the Get-CalendarDiagnosticLog cmdlet to a variable and using that variable for the value of this parameter. For example, to analyze the meeting with the subject "November Budget Meeting" in Shannon Steele's mailbox, run the command `$Budget = Get-CalendarDiagnosticLog -Identity "Shannon Steele" -Subject "November Budget Meeting" -ExactMatch` and then use the value `$Budget` for this parameter. @@ -111,7 +115,6 @@ You can't use this parameter with the LogLocation parameter. Type: CalendarLog[] Parameter Sets: DefaultSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -121,6 +124,9 @@ Accept wildcard characters: False ``` ### -LogLocation + +> Applicable: Exchange Server 2013, Exchange Online + **Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To specify the calendar items to analyze, use the CalendarLogs parameter. This parameter is functional only in Exchange 2013. @@ -135,7 +141,6 @@ You can't use this parameter with the CalendarLogs parameter. Type: String[] Parameter Sets: LocationSet Aliases: -Applicable: Exchange Server 2013, Exchange Online Required: True Position: Named @@ -145,16 +150,18 @@ Accept wildcard characters: False ``` ### -DetailLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DetailLevel parameter specifies the level of detail you want to see in the analysis output. Valid values are: -- Basic: This is the default value. The calendar item properties that are returned are listed in the Detailed Description. +- Basic: This value is the default. The calendar item properties that are returned are listed in the Detailed Description. - Advanced: 37 additional calendar item properties are returned. You should use this value only for detailed debugging information. ```yaml Type: AnalysisDetailLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,6 +171,9 @@ Accept wildcard characters: False ``` ### -GlobalObjectId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GlobalObjectId parameter specifies the identity of the calendar item you want to analyze. In Exchange 2013, you can use this parameter with the LogLocation parameter to specify the calendar item if the location contains multiple exported .msg files. The GlobalObjectId property of the meeting uses the same format as the CleanGlobalObjectId property (for example, 040000008200E00074C5B7101A82E008000000009421DCCD5046CD0100000000000000001000000010B0349F6B17454685E17D9F9512E71F) and the value of the two properties is likely the same. However, the value of GlobalObjectId might not stay the same for all instances of the same meeting in multiple calendars (for example, different attendees invited to different instances of the same recurring meeting). @@ -172,7 +182,6 @@ The GlobalObjectId property of the meeting uses the same format as the CleanGlob Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,9 +191,12 @@ Accept wildcard characters: False ``` ### -OutputAs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OutputAs parameter specifies the output format of the command. Valid values are: -- CSV (This is the default value) +- CSV (default value) - HTML - XML @@ -192,7 +204,6 @@ The OutputAs parameter specifies the output format of the command. Valid values Type: OutputType Parameter Sets: (All) 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-CalendarDiagnosticLog.md b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticLog.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticLog.md index 38b63df96c..59170cb682 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticlog -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CalendarDiagnosticLog -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendardiagnosticlog +schema: 2.0.0 +title: Get-CalendarDiagnosticLog --- # Get-CalendarDiagnosticLog @@ -64,15 +65,15 @@ Get-CalendarDiagnosticLog [-Identity] -LogLocation ## DESCRIPTION The output of this cmdlet contains the following information: -- IsFileLink: Indicates whether the calendar item has been exported to a .msg file by using the LogLocation parameter. Values are True or False. +- IsFileLink: Indicates whether the calendar item is exported to a .msg file by using the LogLocation parameter. Values are True or False. - Identity: Identifies the mailbox that holds the calendar item. An example value is: excallog://laura@contoso.com/?id=RgAAAACF/h/dHTTkQbdPrk7z+G4SBwCoatc7EmnEQq1iF35p17stAAAAAAFEAACoatc7EmnEQq1iF35p17stAAAAABEIAAAP. - LogDate: The date-time that the calendar item was logged. - NormalizedSubject: The Subject field of the calendar item. - CleanGlobalObjectId: The identifier that's constant throughout the lifetime of the calendar item. For example, 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. -After you run the Get-CalendarDiagnosticLog cmdlet, you can analyze the calendar data using the Get-CalendarDiagnosticAnalysis cmdlet. For more information, see [Get-CalendarDiagnosticAnalysis](https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis). +After you run the Get-CalendarDiagnosticLog cmdlet, you can analyze the calendar data using the Get-CalendarDiagnosticAnalysis cmdlet. For more information, see [Get-CalendarDiagnosticAnalysis](https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendardiagnosticanalysis). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -113,6 +114,9 @@ In **Exchange 2013**, this example exports all calendar items in the Calendar Di ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that contains the calendar items. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -130,7 +134,6 @@ The Identity parameter specifies the mailbox that contains the calendar items. Y Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -140,6 +143,9 @@ Accept wildcard characters: False ``` ### -LogLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Online + **Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. Usage of this cmdlet is now restricted to the local server. This parameter is functional only in Exchange 2010 and Exchange 2013. @@ -154,9 +160,8 @@ In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAna ```yaml Type: String -Parameter Sets: ExportToMsg +Parameter Sets: ExportToMsg, MeetingId, MeetingSubject Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Online Required: True Position: Named @@ -165,20 +170,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: MeetingId, MeetingSubject -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Online +### -MeetingID -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -MeetingID The MeetingID parameter filters the results by the globally unique identifier of the calendar item. The value is the CleanGlobalObjectId property of the calendar item that's available in the output of this cmdlet, or by using other MAPI examination tools. An example value is 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. This value is constant throughout the lifetime of the calendar item. To find this value, it's easiest to first search for the calendar item by using the Subject, StartDate and EndDate parameters. After you find the calendar item that you want, you can use its CleanGlobalObjectId value for the MeetingID parameter in future commands. @@ -187,9 +182,8 @@ Don't use this parameter with the Subject parameter, because the value of the Me ```yaml Type: String -Parameter Sets: MeetingId +Parameter Sets: MeetingId, ExportToMsg Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -198,29 +192,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ExportToMsg -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Subject -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -Subject The Subject parameter identifies the calendar items by the specified text in the Subject field. The text values that you specify aren't case sensitive. If the value contains spaces, enclose the value in quotation marks ("). You can control whether to use exact matching by using the ExactMatch parameter. Don't use this parameter with the MeetingID parameter, because the value of the MeetingID parameter takes precedence. ```yaml Type: String -Parameter Sets: MeetingSubject +Parameter Sets: MeetingSubject, ExportToMsg Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -229,20 +212,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ExportToMsg -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Credential -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Credential This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -253,7 +226,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,6 +235,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -271,7 +246,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,6 +255,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -289,7 +266,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -299,13 +275,15 @@ Accept wildcard characters: False ``` ### -EntryId + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EntryId parameter filters the results by entry ID. You can specify multiple values separated by commas. ```yaml Type: String Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -315,12 +293,15 @@ Accept wildcard characters: False ``` ### -ExactMatch + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExactMatch parameter specifies whether to use an exact match or a partial match for text values that you specify for the Subject parameter. Valid values are: - $true: The subject search uses an exact match and searches all calendar items in the mailbox. For example, if you search for "budget", the search looks for items that have "budget" anywhere in the subject, but not "budgeting". -- $false: The subject search uses a partial match and searches a maximum of 1000 calendar items in the mailbox. For example, if you search for "budget", the search looks for items that have "budget" and "budgeting" anywhere in the subject. This is the default value. +- $false: The subject search uses a partial match and searches a maximum of 1000 calendar items in the mailbox. For example, if you search for "budget", the search looks for items that have "budget" and "budgeting" anywhere in the subject. This value is the default. -A partial subject match search may not return all of the relevant calendar items. Try using an exact subject match search for more accurate results. +A partial subject match search might not return all of the relevant calendar items. Try using an exact subject match search for more accurate results. You only use this parameter with the Subject parameter. @@ -330,7 +311,6 @@ The value of this parameter is ignored when you use the MeetingId parameter. Type: Boolean Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -340,6 +320,9 @@ Accept wildcard characters: False ``` ### -ItemClass + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ItemClass parameter filters the results by the specified MessageClass property value of the calendar item (for example, IPM.Appointment). You can specify multiple values separated by commas. You can only use this parameter with the MeetingID parameter. @@ -348,7 +331,6 @@ You can only use this parameter with the MeetingID parameter. Type: String[] Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -358,13 +340,15 @@ Accept wildcard characters: False ``` ### -ItemIds + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ItemIds parameter filters the results by item ID. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -374,13 +358,15 @@ Accept wildcard characters: False ``` ### -Latest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Latest switch specifies whether to return calendar log data for only the most recent calendar item. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -390,6 +376,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -402,7 +391,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -412,13 +400,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter determines the number of results returned by the cmdlet. The maximum value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -428,6 +418,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -436,7 +429,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: ExportToMsg 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-CalendarDiagnosticObjects.md b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticObjects.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticObjects.md index e01ded63d5..8971b36801 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticObjects.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticobjects applicable: Exchange Online -title: Get-CalendarDiagnosticObjects -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendardiagnosticobjects +schema: 2.0.0 +title: Get-CalendarDiagnosticObjects --- # Get-CalendarDiagnosticObjects @@ -48,7 +49,7 @@ Get-CalendarDiagnosticObjects [-Identity] ## DESCRIPTION Some of the more interesting properties that are returned in the results are: -- AppointmentState: 1 = The appointment is a meeting, 2 = The appointment has been received, 4 = The appointment has been cancelled, and 8 = the appointment is a forwarded appointment. +- AppointmentState: 1 = The appointment is a meeting, 2 = The appointment is received, 4 = The appointment is cancelled, and 8 = the appointment is a forwarded appointment. - CalendarLogTriggerAction: The action that's taken on the item (for example, Create or Update). - ClientInfoString: The entity that made the change (for example, `Client=OWA;`, `Client=WebServices;`;, or `Client=TBA;Service=MSExchangeMailboxAssistants;Action=ELCAssistant;`). - MeetingRequestType: 1 = The meeting message is a meeting request, 65536 = The meeting message is a full update to an existing meeting, 131072 = The meeting message is an informational update to an existing meeting, 262144 = The meeting message is a silent update, 524288 = The update is outdated, or 1048576 = The meeting message is forwarded to a delegate, and the copy is marked as informational. @@ -56,7 +57,7 @@ Some of the more interesting properties that are returned in the results are: - ResponseType: 0 = The organizer hasn't received a response, 1 = The organizer's copy of the meeting, 2 = Tentative, 3 = Accept, 4 = Decline, or 5 = The attendee hasn't responded. - ResponsibleUserName: The LegacyExchangeDN value of the user who made the change (for example, `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=BN6PR11MB1587/cn=Microsoft System Attendant` or `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=696eea97d3c449eab648920d03385efb-admin`). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -93,6 +94,9 @@ This example returns diagnostic information for meetings with the subject Team L ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox or Microsoft 365 Group whose calendar you want to view. You can use any value that uniquely identifies the mailbox or Microsoft 365 Group. For example: - Name @@ -110,7 +114,6 @@ The Identity parameter specifies the mailbox or Microsoft 365 Group whose calend Type: UnifiedGroupOrUserMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -120,13 +123,15 @@ Accept wildcard characters: False ``` ### -AnalyzeExceptionWithOriginalStartDate + +> Applicable: Exchange Online + {{ Fill AnalyzeExceptionWithOriginalStartDate Description }} ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -136,13 +141,15 @@ Accept wildcard characters: False ``` ### -AutoRequeryOnMeetingId + +> Applicable: Exchange Online + {{ Fill AutoRequeryOnMeetingId Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -152,13 +159,15 @@ Accept wildcard characters: False ``` ### -ConfigurationName + +> Applicable: Exchange Online + {{ Fill ConfigurationName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -168,6 +177,9 @@ Accept wildcard characters: False ``` ### -CustomPropertyNames + +> Applicable: Exchange Online + The CustomPropertyNames parameter returns the specified calendar item custom property in the results. For valid values, see [Values for the CustomPropertyNames parameter in Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/values-for-custompropertynames-parameter). You can specify multiple values separated by commas. @@ -176,7 +188,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + 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". @@ -194,7 +208,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -204,13 +217,15 @@ Accept wildcard characters: False ``` ### -EntryId + +> Applicable: Exchange Online + The EntryID parameter filters the results by the specified EntryID property value, which corresponds to the MAPI property PR\_ENTRYID. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -220,13 +235,15 @@ Accept wildcard characters: False ``` ### -EwsId + +> Applicable: Exchange Online + {{ Fill EwsId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -236,12 +253,15 @@ Accept wildcard characters: False ``` ### -ExactMatch + +> Applicable: Exchange Online + The ExactMatch parameter specifies whether to use an exact match or a partial match for text values that you specify for the Subject parameter. Valid values are: - $true: The subject search uses an exact match and searches all calendar items in the mailbox. For example, if you search for "budget", the search looks for items that have "budget" anywhere in the subject, but not "budgeting". -- $false: The subject search uses a partial match and searches a maximum of 1000 calendar items in the mailbox. For example, if you search for "budget", the search looks for items that have "budget" and "budgeting" anywhere in the subject. This is the default value. +- $false: The subject search uses a partial match and searches a maximum of 1000 calendar items in the mailbox. For example, if you search for "budget", the search looks for items that have "budget" and "budgeting" anywhere in the subject. This value is the default. -A partial subject match search may not return all of the relevant calendar items. Try using an exact subject match search for more accurate results. +A partial subject match search might not return all of the relevant calendar items. Try using an exact subject match search for more accurate results. You only use this parameter with the Subject parameter. @@ -251,7 +271,6 @@ The value of this parameter is ignored when you use the MeetingId parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -261,13 +280,15 @@ Accept wildcard characters: False ``` ### -ItemClass + +> Applicable: Exchange Online + The ItemClass parameter filters the results by the specified MessageClass property value of the calendar item (for example, IPM.Appointment). You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -277,13 +298,15 @@ Accept wildcard characters: False ``` ### -ItemIds + +> Applicable: Exchange Online + The ItemIds parameter filters the results by item ID. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -293,13 +316,15 @@ Accept wildcard characters: False ``` ### -MaxResults + +> Applicable: Exchange Online + {{ Fill MaxResults Description }} ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -309,13 +334,15 @@ Accept wildcard characters: False ``` ### -MeetingId + +> Applicable: Exchange Online + The MeetingId parameter filters the results by the globally unique identifier of the calendar item. The value is the CleanGlobalObjectId property of the calendar item that's available in the output of this cmdlet, or by using other MAPI examination tools. An example value is 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. This value is constant throughout the lifetime of the calendar item. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -325,13 +352,15 @@ Accept wildcard characters: False ``` ### -ODataId + +> Applicable: Exchange Online + {{ Fill ODataId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -341,13 +370,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter determines the number of results returned by the cmdlet. The maximum value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -357,16 +388,18 @@ Accept wildcard characters: False ``` ### -ShouldBindToItem + +> Applicable: Exchange Online + The ShouldBindToItem parameter specifies whether to truncate large streamable property values (for example, AppointmentRecurrenceBlob). Valid values are: - $true: The values of large streamable properties aren't truncated, so the full value is returned. -- $false: The values of large streamable properties are truncated. This is the default value. +- $false: The values of large streamable properties are truncated. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -376,13 +409,15 @@ Accept wildcard characters: False ``` ### -ShouldDecodeEnums + +> Applicable: Exchange Online + {{ Fill ShouldDecodeEnums Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -392,13 +427,15 @@ Accept wildcard characters: False ``` ### -ShouldFetchAttendeeCollection + +> Applicable: Exchange Online + {{ Fill ShouldFetchAttendeeCollection Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -408,16 +445,18 @@ Accept wildcard characters: False ``` ### -ShouldFetchRecurrenceExceptions + +> Applicable: Exchange Online + The ShouldFetchRecurrenceExceptions parameter specifies whether to include exceptions to recurring meetings. Valid values are: - $true: Include exceptions to recurring meetings. When you use this value, you also need to use the ItemIds parameter. -- $false: Don't Include exceptions to recurring meetings. This is the default value. +- $false: Don't Include exceptions to recurring meetings. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -427,6 +466,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + 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". @@ -435,7 +477,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -445,13 +486,15 @@ Accept wildcard characters: False ``` ### -Subject + +> Applicable: Exchange Online + The Subject parameter identifies the calendar items by the specified text in the Subject field. The text values that you specify aren't case sensitive. If the value contains spaces, enclose the value in quotation marks. You can control whether to use exact matching by using the ExactMatch parameter ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CalendarNotification.md b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarNotification.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-CalendarNotification.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CalendarNotification.md index 014d7e719e..908c4eb1f9 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarNotification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarNotification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-calendarnotification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-CalendarNotification -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendarnotification +schema: 2.0.0 +title: Get-CalendarNotification --- # Get-CalendarNotification @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-CalendarNotification cmdlet to view calendar text message notification settings for a mailbox. -**Note**: This cmdlet has been deprecated in Exchange Online PowerShell. The text message notification service has been discontinued in Microsoft 365. +**Note**: This cmdlet is deprecated in Exchange Online PowerShell. The text message notification service is discontinued in Microsoft 365. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -34,7 +35,7 @@ Get-CalendarNotification [-Identity] ## DESCRIPTION The Get-CalendarNotification cmdlet retrieves and displays the rules that trigger the calendar agenda notification, reminder notification, or update notification text messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example returns the calendar text message notification settings for Tony's ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -83,7 +89,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -119,7 +129,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CalendarProcessing.md b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarProcessing.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-CalendarProcessing.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CalendarProcessing.md index a38f7b7958..72c4b9ede9 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarProcessing.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarProcessing.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-calendarprocessing -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CalendarProcessing -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendarprocessing +schema: 2.0.0 +title: Get-CalendarProcessing --- # Get-CalendarProcessing ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Get-CalendarProcessing cmdlet to view the calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant and calendar configuration. Note that the settings returned by this cmdlet are editable only on resource mailboxes. +Use the Get-CalendarProcessing cmdlet to view the calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant and calendar configuration. The settings returned by this cmdlet are editable only on resource mailboxes. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -29,9 +30,9 @@ Get-CalendarProcessing [-Identity] ``` ## DESCRIPTION -For details about the properties that are returned in the output of this cmdlet, see [Set-CalendarProcessing](https://learn.microsoft.com/powershell/module/exchange/set-calendarprocessing). +For details about the properties that are returned in the output of this cmdlet, see [Set-CalendarProcessing](https://learn.microsoft.com/powershell/module/exchangepowershell/set-calendarprocessing). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example shows the calendar processing options for the resource mailbox Room ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the resource mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the resource mailbox that you want to view. You Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -80,7 +86,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -102,7 +110,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldPolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldPolicy.md index 54654c842b..e1c850af72 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy applicable: Security & Compliance -title: Get-CaseHoldPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-caseholdpolicy +schema: 2.0.0 +title: Get-CaseHoldPolicy --- # Get-CaseHoldPolicy @@ -51,6 +52,9 @@ This example displays detailed information for the policy named "Regulation 123 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the case hold policy that you want to view. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the case hold policy that you want to view by using the eDiscovery case that's associated with the policy. You can use the following values to identify the eDiscovery case: - Name @@ -82,7 +88,6 @@ You can find these values by running the command: Get-ComplianceCase | Format-Ta Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -92,9 +97,12 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information on the case hold policy. You don't need to specify a value with this switch. -If you don't use this switch, the command won't return information about the current deployment status, and the DistributionStatus property will only show as "Pending". +If you don't use this switch, the command doesn't return information about the current deployment status, and the DistributionStatus property shows as "Pending". The following properties are affected by this switch: @@ -109,7 +117,6 @@ The following properties are affected by this switch: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -IncludeBindings + +> Applicable: Security & Compliance + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -IncludeBindingsOnly + +> Applicable: Security & Compliance + {{ Fill IncludeBindingsOnly Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-CaseHoldRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldRule.md index 632e20fe65..4a8be64d10 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-caseholdrule applicable: Security & Compliance -title: Get-CaseHoldRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-caseholdrule +schema: 2.0.0 +title: Get-CaseHoldRule --- # Get-CaseHoldRule @@ -45,6 +46,9 @@ This example displays detailed information for the case hold rule named "30 Day ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold rule you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the case hold rule you want to view. You can us Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter filters the case hold rule results by the associated case hold policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -77,7 +83,6 @@ You can use this parameter with the Identity parameter in the same command. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Get-ClassificationRuleCollection.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ClassificationRuleCollection.md index b246435ac5..f4eaa39c92 100644 --- a/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ClassificationRuleCollection.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-classificationrulecollection -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ClassificationRuleCollection -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-classificationrulecollection +schema: 2.0.0 +title: Get-ClassificationRuleCollection --- # Get-ClassificationRuleCollection ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ClassificationRuleCollection cmdlet to view the classification rule collections in your organization. @@ -29,7 +30,7 @@ Get-ClassificationRuleCollection [[-Identity] Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the classification rule collection you want to view. You can use any value that uniquely identifies the classification rule collection. For example, you can specify the name, rule collection name or distinguished name (DN) of the classification rule collection. ```yaml Type: ClassificationRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessArray.md b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessArray.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-ClientAccessArray.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessArray.md index c879bde532..1b1d7b33b3 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessArray.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessArray.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-clientaccessarray -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ClientAccessArray -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-clientaccessarray +schema: 2.0.0 +title: Get-ClientAccessArray --- # Get-ClientAccessArray @@ -35,7 +36,7 @@ Changes in the Exchange server architecture that were introduced in Exchange Ser - Outlook clients can't use RPC over TCP to access mailboxes on Exchange Server 2013 or later versions and RPC Client Access arrays only work with RPC over TCP. - Because the Client Access server role is now a stateless proxy, you use different and less complex methods to configure load balancing and high availability for internal and external client connections. For more information, see [Load balancing in Exchange Server](https://learn.microsoft.com/Exchange/architecture/client-access/load-balancing). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,6 +57,9 @@ This example returns detailed information for the Client Access array named CASA ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Client Access array that you want to view. You can use these values: - Name (if the value doesn't contain spaces) @@ -68,7 +72,6 @@ The Identity parameter specifies the Client Access array that you want to view. Type: ClientAccessArrayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Site parameter filters the results by Active Directory site. You can use any value that uniquely identifies the site. For example: - Name @@ -105,7 +113,6 @@ The Site parameter filters the results by Active Directory site. You can use any Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessRule.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ClientAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessRule.md index 0e40aa0d98..954e243ebd 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-clientaccessrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-ClientAccessRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-clientaccessrule +schema: 2.0.0 +title: Get-ClientAccessRule --- # Get-ClientAccessRule @@ -15,7 +16,7 @@ ms.reviewer: > [!NOTE] > Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). -This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ClientAccessRule cmdlet to view client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. @@ -34,7 +35,7 @@ Get-ClientAccessRule [[-Identity] ] ## DESCRIPTION Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example retrieves details about the client access rule named "Block Client ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the client access rule that you want to view. You can use any value that uniquely identifies the client access rule. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the client access rule that you want to view. Y Type: ClientAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -84,7 +90,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -102,7 +110,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessServer.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-ClientAccessServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessServer.md index c3cb98eccc..3feb15fdc8 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-clientaccessserver -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ClientAccessServer -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-clientaccessserver +schema: 2.0.0 +title: Get-ClientAccessServer --- # Get-ClientAccessServer @@ -31,7 +32,7 @@ Get-ClientAccessServer [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example returns detailed information for the server mail.contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server with the Client Access server role installed that you want to view. You can use any value that uniquely identifies the server. For example: @@ -65,7 +69,6 @@ You can use any value that uniquely identifies the server. For example: Type: ClientAccessServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -IncludeAlternateServiceAccountCredentialPassword + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeAlternateServiceAccountCredentialPassword switch specifies whether to include the password of the alternate service account in the results. You don't need to specify a value with this switch. The password is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessServer | Format-List AlternateServiceAccountConfiguration`. @@ -99,7 +107,6 @@ The password is visible in the AlternateServiceAccountConfiguration property. To Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -IncludeAlternateServiceAccountCredentialStatus + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeAlternateServiceAccountCredentialStatus parameter specifies whether to include the status of the alternate service account in the results. You don't need to specify a value with this switch. The status is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessServer | Format-List AlternateServiceAccountConfiguration`. @@ -117,7 +127,6 @@ The status is visible in the AlternateServiceAccountConfiguration property. To s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessService.md b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessService.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-ClientAccessService.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessService.md index 1f3d8c72e4..9045c8e052 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-clientaccessservice -applicable: Exchange Server 2016, Exchange Server 2019 -title: Get-ClientAccessService -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-clientaccessservice +schema: 2.0.0 +title: Get-ClientAccessService --- # Get-ClientAccessService @@ -29,7 +30,7 @@ Get-ClientAccessService [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example returns detailed information for the server mail.contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server with the Client Access server role installed that you want to view. You can use any value that uniquely identifies the server. For example: @@ -63,7 +67,6 @@ You can use any value that uniquely identifies the server. For example: Type: ClientAccessServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -IncludeAlternateServiceAccountCredentialPassword + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeAlternateServiceAccountCredentialPassword switch specifies whether to include the password of the alternate service account in the results. You don't need to specify a value with this switch. The password is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessService | Format-List AlternateServiceAccountConfiguration`. @@ -97,7 +105,6 @@ The password is visible in the AlternateServiceAccountConfiguration property. To Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -IncludeAlternateServiceAccountCredentialStatus + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeAlternateServiceAccountCredentialStatus parameter specifies whether to include the status of the alternate service account in the results. You don't need to specify a value with this switch. The status is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessService | Format-List AlternateServiceAccountConfiguration`. @@ -115,7 +125,6 @@ The status is visible in the AlternateServiceAccountConfiguration property. To s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Clutter.md b/exchange/exchange-ps/ExchangePowerShell/Get-Clutter.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-Clutter.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Clutter.md index abd9f70458..726b83b98e 100644 --- a/exchange/exchange-ps/exchange/Get-Clutter.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Clutter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-clutter applicable: Exchange Online, Exchange Online Protection -title: Get-Clutter -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-clutter +schema: 2.0.0 +title: Get-Clutter --- # Get-Clutter @@ -27,7 +28,7 @@ Get-Clutter -Identity ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,6 +42,9 @@ This example returns the Clutter settings for the user Constancia Pena. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill UseCustomRouting Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md b/exchange/exchange-ps/ExchangePowerShell/Get-CmdletExtensionAgent.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CmdletExtensionAgent.md index 79f88947ca..3a30158c94 100644 --- a/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CmdletExtensionAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-cmdletextensionagent -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-CmdletExtensionAgent -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-cmdletextensionagent +schema: 2.0.0 +title: Get-CmdletExtensionAgent --- # Get-CmdletExtensionAgent @@ -36,9 +37,9 @@ Get-CmdletExtensionAgent [[-Identity] ] ``` ## DESCRIPTION -Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or third-party products can't use cmdlet extension agents. +Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or non-Microsoft products can't use cmdlet extension agents. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example displays detailed information for the Exchange cmdlet extension age ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the cmdlet extension agent that you want to view. You can use any value that uniquely identifies the agent. For example: - Name @@ -69,7 +73,6 @@ The Identity parameter specifies the name of the cmdlet extension agent that you Type: CmdletExtensionAgentIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -Assembly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Assembly parameter filters the results by the specified Assembly property value. The value for the built-in Exchange cmdlet extension agents is Microsoft.Exchange.ProvisioningAgent.dll. ```yaml Type: String Parameter Sets: Filters Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter filters the results by enabled or disabled cmdlet extension agents. Valid values are: - $true: Only enabled agents are included in the results. @@ -122,7 +132,6 @@ If you don't use this parameter, enabled and disabled agents are included in the Type: Boolean Parameter Sets: Filters Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCase.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCase.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ComplianceCase.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCase.md index 74d35075bf..b28065f954 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancecase applicable: Security & Compliance -title: Get-ComplianceCase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancecase +schema: 2.0.0 +title: Get-ComplianceCase --- # Get-ComplianceCase @@ -65,6 +66,9 @@ This example returns a summary list of all DSR cases that the custom role group ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the compliance case that you want to view. You can use any value that uniquely identifies the case. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the compliance case that you want to view. You Type: ComplianceCaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -CaseType + +> Applicable: Security & Compliance + The CaseType parameter specifies the type of compliance case that you want to view. Valid values are: - AdvancedEdiscovery: eDiscovery Premium cases are used to manage legal or other types of investigations. In the Microsoft Purview compliance portal, eDiscovery Premium cases are displayed under **eDiscovery** \> **Premium**. @@ -91,7 +97,7 @@ The CaseType parameter specifies the type of compliance case that you want to vi - ComplianceWorkspace: This value is reserved for internal Microsoft use. - DataInvestigation: Data investigation cases are used to investigate data spillage incidents. In the Microsoft Purview compliance portal, Data investigation cases are displayed on the **Data investigations** page. - DSR: Data Subject Request (DSR) cases are used to manage General Data Protection Regulation (GDPR) DSR investigations. In the Microsoft Purview compliance portal, DSR cases are displayed under **Data privacy** \> **Data subject requests**. -- eDiscovery: eDiscovery (also called eDiscovery Standard) cases are used to manage legal or other types of investigations. In the Microsoft Purview compliance portal, eDiscovery Standard cases are displayed under **eDiscovery** \> **Standard**. This is the default value. +- eDiscovery: eDiscovery (also called eDiscovery Standard) cases are used to manage legal or other types of investigations. In the Microsoft Purview compliance portal, eDiscovery Standard cases are displayed under **eDiscovery** \> **Standard**. This value is the default. - InsiderRisk: Insider risk cases are used to manage insider risk management cases. In the Microsoft Purview compliance portal, insider risk cases are displayed under **Insider risk management** \> **Cases**. Typically, insider risk management cases are manually created in the Microsoft Purview compliance portal to further investigate activity based on a risk alert. - InternalInvestigation: This value is reserved for internal Microsoft use. - SupervisionPolicy: This type of case corresponds to communication compliance policy. In the Microsoft Purview compliance portal, communication compliance policies are displayed under **Communication compliance** \> **Policies**. @@ -100,7 +106,6 @@ The CaseType parameter specifies the type of compliance case that you want to vi Type: ComplianceCaseType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -RecentOnly + +> Applicable: Security & Compliance + The RecentOnly switch returns a list of the most recently modified cases of the specified case type. You don't need to specify a value with this switch. This switch is used to display data in the "Recent cases" widget in the Microsoft Purview compliance portal for some features that use compliance case objects. @@ -134,7 +144,6 @@ This switch is used to display data in the "Recent cases" widget in the Microsof Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -RoleGroup + +> Applicable: Security & Compliance + The RoleGroup parameter returns a list of compliance cases that the specified role group is a member of. If you don't include the CaseType parameter, the cmdlet returns a list of eDiscovery Standard cases that the role group is a member of. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCaseMember.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCaseMember.md index 5588971c20..b99c26448e 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCaseMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancecasemember applicable: Security & Compliance -title: Get-ComplianceCaseMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancecasemember +schema: 2.0.0 +title: Get-ComplianceCaseMember --- # Get-ComplianceCaseMember @@ -52,13 +53,15 @@ This examples shows the members of the eDiscovery case named Fabrikam Litigation ## PARAMETERS ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the name of the eDiscovery case that you want to view. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Security & Compliance + 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: Security & Compliance Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -ShowCaseAdmin + +> Applicable: Security & Compliance + The ShowCaseAdmin switch specifies whether to return the eDiscovery case admin in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEvent.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEvent.md index 4688db4274..06939dc393 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEvent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentionevent applicable: Security & Compliance -title: Get-ComplianceRetentionEvent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-complianceretentionevent +schema: 2.0.0 +title: Get-ComplianceRetentionEvent --- # Get-ComplianceRetentionEvent @@ -51,6 +52,9 @@ This example returns detailed information about the compliance retention event n ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the compliance retention event that you want to view. You can use any value that uniquely identifies the event. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the compliance retention event that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -BeginDateTime + +> Applicable: Security & Compliance + {{ Fill BeginDateTime Description }} ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -EndDateTime + +> Applicable: Security & Compliance + {{ Fill EndDateTime Description }} ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -PreviewOnly + +> Applicable: Security & Compliance + {{ Fill PreviewOnly Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEventType.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEventType.md index 413b3c7aa3..a20b6d4bff 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEventType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentioneventtype applicable: Security & Compliance -title: Get-ComplianceRetentionEventType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-complianceretentioneventtype +schema: 2.0.0 +title: Get-ComplianceRetentionEventType --- # Get-ComplianceRetentionEventType @@ -27,7 +28,7 @@ Get-ComplianceRetentionEventType [-Identity ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example returns detailed information for the retention event type named Fab ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention event type that you want to view. You can use any value that uniquely identifies the retention event type. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the retention event type that you want to view. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -68,15 +71,17 @@ Accept wildcard characters: False ``` ### -LoadTag + +> Applicable: Security & Compliance + The LoadTag switch specifies whether to show the compliance tags that are associated with the retention event types. You don't need to specify a value with this switch. -If you don't use this switch, the ComplianceTag property will always appear empty in the results. +If you don't use this switch, the ComplianceTag property always appears empty in the results. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearch.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearch.md index 95ca1983f2..982edba701 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Get-ComplianceSearch -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancesearch +schema: 2.0.0 +title: Get-ComplianceSearch --- # Get-ComplianceSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ComplianceSearch cmdlet to view estimate compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. After you use the New-ComplianceSearchAction cmdlet to define a preview action for the compliance search, use the Get-ComplianceSearchAction cmdlet to view the results of the compliance search. @@ -29,7 +30,7 @@ Get-ComplianceSearch [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. @@ -54,6 +55,9 @@ This examples show details of the compliance search named Case 1234. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Identity parameter specifies the compliance search that you want to view. You can use any value that uniquely identifies the compliance search. For example: @@ -81,7 +85,6 @@ To view these properties, you need to use the Identity parameter in the command. Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -Case + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. 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. @@ -101,7 +107,6 @@ You can't use this parameter to view compliance searches associated with eDiscov Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -119,7 +127,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +136,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearchAction.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearchAction.md index cd108c7a4f..691fd08ab6 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearchAction.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancesearchaction -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Get-ComplianceSearchAction -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancesearchaction +schema: 2.0.0 +title: Get-ComplianceSearchAction --- # Get-ComplianceSearchAction ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ComplianceSearchAction cmdlet to view information about compliance search actions. @@ -71,7 +72,7 @@ Get-ComplianceSearchAction [-Export] ## DESCRIPTION After you create and run a compliance search using the New-ComplianceSearch cmdlet, and start the search using the Start-ComplianceSearch cmdlet, you assign a search action using the New-ComplianceSearchAction cmdlet. You use the Get-ComplianceSearchAction cmdlet to track the progress of the compliance search action. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. @@ -96,6 +97,9 @@ This example shows details about the compliance search action named "Case 1234_P ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Identity parameter specifies the compliance search action that you want to view. You can use any value that uniquely identifies the compliance search action. For example: - Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"`. For example, `"Case 1234_Preview"`. @@ -115,7 +119,6 @@ When you use the Identity parameter, more details are returned in the results. F Type: ComplianceSearchActionIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: 1 @@ -125,6 +128,9 @@ Accept wildcard characters: False ``` ### -Case + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The Case parameter filters the results by the name of the specified case. If the value contains spaces, enclose the value in quotation marks. @@ -133,7 +139,6 @@ The Case parameter filters the results by the name of the specified case. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -143,13 +148,15 @@ Accept wildcard characters: False ``` ### -Details + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Details switch specifies whether to include detailed information in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -159,6 +166,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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. @@ -167,7 +177,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -177,6 +186,11 @@ Accept wildcard characters: False ``` ### -Export + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +**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. @@ -185,7 +199,6 @@ You can't use this switch with the Identity, Preview, or Purge parameters. Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -195,13 +208,15 @@ Accept wildcard characters: False ``` ### -IncludeCredential + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The IncludeCredential switch specifies whether to include the credential in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -211,7 +226,10 @@ Accept wildcard characters: False ``` ### -Organization -This parameter is available only in the cloud-based organization. + +> Applicable: Security & Compliance + +This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -219,7 +237,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -229,6 +246,9 @@ Accept wildcard characters: False ``` ### -Preview + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Preview switch filters the results by Preview compliance search actions. You don't need to specify a value with this switch. You can't use this switch with the Export, Identity, or Purge parameters. @@ -237,7 +257,6 @@ You can't use this switch with the Export, Identity, or Purge parameters. Type: SwitchParameter Parameter Sets: Preview Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -247,6 +266,9 @@ Accept wildcard characters: False ``` ### -Purge + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + **Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. The Purge switch filters the results by Purge compliance search actions. You don't need to specify a value with this switch. @@ -257,7 +279,6 @@ You can't use this switch with the Export, Identity, or Preview parameters. Type: SwitchParameter Parameter Sets: Purge Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -267,13 +288,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSecurityFilter.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSecurityFilter.md index d87f9ba786..c3f73ba2a2 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSecurityFilter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancesecurityfilter -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Get-ComplianceSecurityFilter -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancesecurityfilter +schema: 2.0.0 +title: Get-ComplianceSecurityFilter --- # Get-ComplianceSecurityFilter @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-ComplianceSecurityFilter cmdlet to view compliance security filters in the Microsoft Purview compliance portal. These filters allow specified users to search only a subset of mailboxes and SharePoint Online or OneDrive for Business sites in your Microsoft 365 organization. +Use the Get-ComplianceSecurityFilter cmdlet to view compliance security filters in the Microsoft Purview compliance portal. These filters allow specified users to search only a subset of mailboxes and SharePoint or OneDrive sites in your Microsoft 365 organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -53,6 +54,9 @@ This example returns detailed information about the compliance security filter n ## PARAMETERS ### -Action + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Action parameter filters the results by the type of search action that a filter is applied to. Valid values are: - Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. @@ -65,7 +69,6 @@ The Action parameter filters the results by the type of search action that a fil Type: ComplianceSecurityFilterActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -84,7 +90,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -FilterName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The FilterName parameter specifies the name of the compliance security filter that you want to view. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The User parameter filters the results by the user who gets a filter applied to their searches. Valid values are: - The alias or email address of a user. @@ -120,7 +130,6 @@ The User parameter filters the results by the user who gets a filter applied to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceTag.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTag.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ComplianceTag.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTag.md index 2c704b8488..6f58f8329b 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancetag applicable: Exchange Online, Security & Compliance -title: Get-ComplianceTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancetag +schema: 2.0.0 +title: Get-ComplianceTag --- # Get-ComplianceTag @@ -49,6 +50,9 @@ This example returns detailed information about the label named HR Content. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the label that you want to view. You can use any value that uniquely identifies the tag. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the label that you want to view. You can use an Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -IncludingLabelState + +> Applicable: Exchange Online, Security & Compliance + {{ Fill IncludingLabelState Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTagStorage.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTagStorage.md index c3aa8eaca3..668ad3eb8a 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTagStorage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancetagstorage applicable: Exchange Online, Security & Compliance -title: Get-ComplianceTagStorage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancetagstorage +schema: 2.0.0 +title: Get-ComplianceTagStorage --- # Get-ComplianceTagStorage @@ -41,6 +42,9 @@ This example confirms that you've created the label policy in your organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the label policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name (GUID value) @@ -53,7 +57,6 @@ However, there can be only one label policy in your organization. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserAggregateReport.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserAggregateReport.md index d26e9e5e0d..265f55aab4 100644 --- a/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserAggregateReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compromiseduseraggregatereport applicable: Exchange Online, Exchange Online Protection -title: Get-CompromisedUserAggregateReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compromiseduseraggregatereport +schema: 2.0.0 +title: Get-CompromisedUserAggregateReport --- # Get-CompromisedUserAggregateReport @@ -37,7 +38,7 @@ This cmdlet returns the following information: - UserCount - Action -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example returns all restricted user accounts for the specified date range. ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the results by the compromised user status. Valid values are: - Restricted @@ -62,7 +66,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -80,7 +86,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -130,7 +142,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserDetailReport.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserDetailReport.md index 07d5d63148..762a182473 100644 --- a/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserDetailReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compromiseduserdetailreport applicable: Exchange Online, Exchange Online Protection -title: Get-CompromisedUserDetailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compromiseduserdetailreport +schema: 2.0.0 +title: Get-CompromisedUserDetailReport --- # Get-CompromisedUserDetailReport @@ -37,7 +38,7 @@ This cmdlet returns the following information: - UserCount - Action -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example returns all suspicious user accounts for the specified date range. ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the results by the compromised user status. Valid values are: - Restricted @@ -62,7 +66,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -80,7 +86,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -132,7 +144,6 @@ A value for this parameter can't be older than 30 days. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md b/exchange/exchange-ps/ExchangePowerShell/Get-ConfigAnalyzerPolicyRecommendation.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ConfigAnalyzerPolicyRecommendation.md index ff118bc38d..4b2485cfbf 100644 --- a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ConfigAnalyzerPolicyRecommendation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-configanalyzerpolicyrecommendation applicable: Exchange Online -title: Get-ConfigAnalyzerPolicyRecommendation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-configanalyzerpolicyrecommendation +schema: 2.0.0 +title: Get-ConfigAnalyzerPolicyRecommendation --- # Get-ConfigAnalyzerPolicyRecommendation @@ -34,11 +35,11 @@ The output of this cmdlet only returns settings that fall below the value that y The output contains the following information for each setting: -- PolicyGroup: The type of policy. The value will be Anti-Spam, Anti-Phishing, Anti-Malware, ATP Safe Links, or ATP Safe Attachments +- PolicyGroup: The type of policy. The value is Anti-Spam, Anti-Phishing, Anti-Malware, ATP Safe Links, or ATP Safe Attachments - SettingName: The name of the setting in the policy. - SettingNameDescription: A description of the setting. - Policy: The name of the policy. -- AppliedTo: The number of users or domains that the policy applies to. If the policy isn't applied to anyone (for example, it's disabled), this value will be blank. +- AppliedTo: The number of users or domains that the policy applies to. If the policy isn't applied to anyone (for example, it's disabled), this value is blank. - CurrentConfiguration: The current value of the setting. - LastModified: When the policy was last modified. - Recommendation: The recommended Standard or Strict value for the setting. @@ -48,7 +49,7 @@ If a setting is configured at or better than the Standard or Strict protection p This cmdlet returns the following output for each setting in each policy that falls below the recommended value. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,13 +63,15 @@ This example runs a comparison using the Strict preset security policy settings ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: ConfigAnalyzerPolicyRecommendationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online + The RecommendedPolicyType parameter specifies the preset security policy that you want to use as a baseline. Valid values are: - Standard @@ -87,7 +93,6 @@ The RecommendedPolicyType parameter specifies the preset security policy that yo Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -IsAppliedToDisabled + +> Applicable: Exchange Online + The IsAppliedToDisabled switch filters the results by policies that aren't applied to anyone (the AppliedTo property is blank). You don't need to specify a value with this switch. If you don't use this switch, the results include policies that are applied to users and policies that aren't applied to anyone. @@ -105,7 +113,6 @@ If you don't use this switch, the results include policies that are applied to u Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md b/exchange/exchange-ps/ExchangePowerShell/Get-ConnectionInformation.md similarity index 97% rename from exchange/exchange-ps/exchange/Get-ConnectionInformation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ConnectionInformation.md index 97f9d3efd2..0f80193cf7 100644 --- a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ConnectionInformation.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.ExoPowershellGalleryModule.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-connectioninformation applicable: Exchange Online -title: Get-ConnectionInformation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.ExoPowershellGalleryModule.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-connectioninformation +schema: 2.0.0 +title: Get-ConnectionInformation --- # Get-ConnectionInformation @@ -87,6 +87,9 @@ This example returns a list of active REST-based connections that are using the ## PARAMETERS ### -ConnectionId + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.2.0 or later of the module. The ConnectionId parameter filters the connections by ConnectionId. ConnectionId is a GUID value in the output of the Get-ConnectionInformation cmdlet that uniquely identifies a connection, even if you have multiple connections open. You can specify multiple ConnectionId values separated by commas. @@ -97,7 +100,6 @@ Don't use this parameter with the ModulePrefix parameter. Type: String[] Parameter Sets: ConnectionId Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -107,6 +109,9 @@ Accept wildcard characters: False ``` ### -ModulePrefix + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.2.0 or later of the module. The ModulePrefix parameter filters the connections by ModulePrefix. When you use the Prefix parameter with the Connect-ExchangeOnline cmdlet, the specified text is added to the names of all Exchange Online cmdlets (for example, Get-InboundConnector becomes Get-ContosoInboundConnector). The ModulePrefix value is visible in the output of the Get-ConnectionInformation cmdlet. You can specify multiple ModulePrefix values separated by commas. @@ -119,7 +124,6 @@ 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-Contact.md b/exchange/exchange-ps/ExchangePowerShell/Get-Contact.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-Contact.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Contact.md index 389fa44712..81424e6505 100644 --- a/exchange/exchange-ps/exchange/Get-Contact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Contact.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-contact -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-Contact -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-contact +schema: 2.0.0 +title: Get-Contact --- # Get-Contact ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-Contact cmdlet to view existing contact objects in your organization. This cmdlet returns contacts and mail contacts. @@ -51,7 +52,7 @@ Get-Contact [[-Identity] ] ## DESCRIPTION The Get-Contact cmdlet returns no mail-related properties for mail contacts. Use the Get-MailContact to view mail-related properties for mail contacts. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,6 +80,9 @@ This example uses the Anr parameter to retrieve all mail-enabled contacts whose ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the contact that you want to view. You can use any value that uniquely identifies the contact. For example: - Name @@ -90,7 +94,6 @@ The Identity parameter specifies the contact that you want to view. You can use Type: ContactIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -112,7 +118,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -132,7 +140,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -150,7 +160,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -175,7 +187,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -185,6 +196,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -198,7 +212,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,6 +221,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -219,7 +235,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -229,6 +244,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -241,7 +259,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified contact subtype. Valid values are: - Contact @@ -263,7 +283,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -273,13 +292,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -289,6 +310,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -306,7 +330,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterConfig.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-ContentFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterConfig.md index 8de0cb720d..0f2fff212e 100644 --- a/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-contentfilterconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ContentFilterConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-contentfilterconfig +schema: 2.0.0 +title: Get-ContentFilterConfig --- # Get-ContentFilterConfig @@ -26,7 +27,7 @@ Get-ContentFilterConfig [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,6 +41,9 @@ This example returns detailed information about the content filter configuration ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -48,7 +52,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md b/exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterPhrase.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterPhrase.md index 1b1f47b29b..0f05d0c960 100644 --- a/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterPhrase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-contentfilterphrase -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ContentFilterPhrase -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-contentfilterphrase +schema: 2.0.0 +title: Get-ContentFilterPhrase --- # Get-ContentFilterPhrase @@ -35,7 +36,7 @@ Get-ContentFilterPhrase [-Phrase ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,6 +64,9 @@ This example returns all custom words and phrases that contain the words free of ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies a custom word or phrase to display. You must enclose the value of the Identity parameter in quotation marks ("). The Identity and Phrase parameters are interchangeable. @@ -71,7 +75,6 @@ The Identity and Phrase parameters are interchangeable. Type: ContentFilterPhraseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -89,7 +95,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Phrase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Phrase parameter specifies a custom word or phrase to display. You must enclose the value of the Phrase parameter in quotation marks ("). The Phrase and Identity parameters are interchangeable. @@ -107,7 +115,6 @@ The Phrase and Identity parameters are interchangeable. Type: ContentFilterPhraseIdParameter Parameter Sets: Phrase Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoAggregateReport.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoAggregateReport.md index 2c884d0e2f..58abe6daed 100644 --- a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoAggregateReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdoaggregatereport applicable: Exchange Online -title: Get-ContentMalwareMdoAggregateReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-contentmalwaremdoaggregatereport +schema: 2.0.0 +title: Get-ContentMalwareMdoAggregateReport --- # Get-ContentMalwareMdoAggregateReport @@ -41,7 +42,7 @@ For the specified reporting period, the cmdlet returns the following information By default, the command returns data for the last 14 days. Data for the last 90 days is available. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example returns the results for OneDrive detections for the specified date ## PARAMETERS ### -DetectionTechnology + +> Applicable: Exchange Online + The DetectionTechnology parameter filters the results by what classified the file as malware. Valid values are: - AntiMalware @@ -67,7 +71,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where 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. @@ -85,7 +91,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -111,13 +118,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -127,6 +136,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + 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. @@ -135,7 +147,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -145,6 +156,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Exchange Online + The Workload parameter filters the results by where the detected file is located. Valid values are: - OneDriveForBusiness @@ -157,7 +171,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoDetailReport.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoDetailReport.md index eb99b53c05..e50714762a 100644 --- a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoDetailReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdodetailreport applicable: Exchange Online -title: Get-ContentMalwareMdoDetailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-contentmalwaremdodetailreport +schema: 2.0.0 +title: Get-ContentMalwareMdoDetailReport --- # Get-ContentMalwareMdoDetailReport @@ -43,7 +44,7 @@ For the specified reporting period, the cmdlet returns the following information By default, the command returns data for the last 14 days. Data for the last 30 days is available. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,6 +58,9 @@ This example returns the results for detections by Safe Attachments for SharePoi ## PARAMETERS ### -DetectionTechnology + +> Applicable: Exchange Online + The DetectionTechnology parameter filters the results by what classified the file as malware. Valid values are: - AntiMalware @@ -69,7 +73,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where 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. @@ -87,7 +93,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + 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. @@ -137,7 +149,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -147,6 +158,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Exchange Online + The Workload parameter filters the results by where the detected file is located. Valid values are: - OneDriveForBusiness @@ -159,7 +173,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DataClassification.md b/exchange/exchange-ps/ExchangePowerShell/Get-DataClassification.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-DataClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DataClassification.md index 9bfe9cc832..5e0a7b3d85 100644 --- a/exchange/exchange-ps/exchange/Get-DataClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DataClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dataclassification -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-DataClassification -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dataclassification +schema: 2.0.0 +title: Get-DataClassification --- # Get-DataClassification @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [Get-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. +In Exchange Online, this cmdlet is replaced by the [Get-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the Get-DataClassification cmdlet to view the data classification rules in your organization. This cmdlet shows built-in data classification rules and rules that you created that use document fingerprints. @@ -39,7 +40,7 @@ Get-DataClassification [[-Identity] ] ## DESCRIPTION Classification rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,13 +68,15 @@ This example returns details of the built-in data classification rule named SWIF ## PARAMETERS ### -ClassificationRuleCollectionIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ClassificationRuleCollectionIdentity parameter filters the results by the name of the data classification rule collection. The data classification rule collection that contains the built-in data classification rules is named Microsoft Rule Package. The data classification that contains new data classification rules that you create that use document fingerprints is named Fingerprint Classification Collection. ```yaml Type: ClassificationRuleCollectionIdParameter Parameter Sets: RuleCollectionIdentity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the data classification rule that you want to view. You can use any value that uniquely identifies the data classification rule. For example: - Name @@ -93,7 +99,6 @@ The Identity parameter specifies the data classification rule that you want to v Type: DataClassificationIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-DataClassificationConfig.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-DataClassificationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DataClassificationConfig.md index 03342c3e31..582c99fd75 100644 --- a/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DataClassificationConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dataclassificationconfig applicable: Exchange Online -title: Get-DataClassificationConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dataclassificationconfig +schema: 2.0.0 +title: Get-DataClassificationConfig --- # Get-DataClassificationConfig @@ -25,7 +26,7 @@ Get-DataClassificationConfig [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES diff --git a/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DataEncryptionPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DataEncryptionPolicy.md index b58632caa0..93b66367bd 100644 --- a/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DataEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dataencryptionpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-DataEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dataencryptionpolicy +schema: 2.0.0 +title: Get-DataEncryptionPolicy --- # Get-DataEncryptionPolicy @@ -33,7 +34,7 @@ Data encryption policy cmdlets are the Exchange Online part of Customer Key. For You can assign a data encryption policy to a mailbox by using the DataEncryptionPolicy parameter on the Set-Mailbox cmdlet in Exchange Online PowerShell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ The example returns detailed information for the data encryption policy named Eu ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the data encryption policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the data encryption policy that you want to vie Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DataRetentionReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-DataRetentionReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DataRetentionReport.md index 1f38d8c687..00ddff31db 100644 --- a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DataRetentionReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dataretentionreport applicable: Exchange Online, Security & Compliance -title: Get-DataRetentionReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dataretentionreport +schema: 2.0.0 +title: Get-DataRetentionReport --- # Get-DataRetentionReport @@ -52,6 +53,9 @@ This example lists the data detections for April, 2018. ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -60,7 +64,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -112,7 +122,6 @@ The StartDate value can't be older than 92 days from today. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroup.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroup.md index 6f519626b5..41cc3f44e7 100644 --- a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-databaseavailabilitygroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DatabaseAvailabilityGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-databaseavailabilitygroup +schema: 2.0.0 +title: Get-DatabaseAvailabilityGroup --- # Get-DatabaseAvailabilityGroup @@ -38,7 +39,7 @@ In addition to obtaining a list of DAG members, the Get-DatabaseAvailabilityGrou Use the Status parameter with the command to include the values for these listed properties. Without the Status parameter, the values returned for these properties are blank. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,13 +60,15 @@ This example displays the properties of the DAG DAG2. Because it includes the St ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the DAG to query. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Status parameter instructs the command to query Active Directory for additional information and to include real-time status information in the output. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroupNetwork.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroupNetwork.md index deb02d5a8e..e98e8e73a5 100644 --- a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroupNetwork.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-databaseavailabilitygroupnetwork -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DatabaseAvailabilityGroupNetwork -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-databaseavailabilitygroupnetwork +schema: 2.0.0 +title: Get-DatabaseAvailabilityGroupNetwork --- # Get-DatabaseAvailabilityGroupNetwork @@ -47,7 +48,7 @@ Valid states for network interfaces - Unavailable: The network interface isn't enabled for replication or use by the DAG, or the DAG member associated with this network interface is inactive or unavailable.The network interface isn't enabled for replication or use by the DAG, or the DAG member associated with this network interface is inactive or unavailable. - Unknown: The system was unable to determine the state of the network interface. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,13 +76,15 @@ This example gets complete configuration and status information for the network ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of a DAG or a DAG network. ```yaml Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -91,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Mailbox server in the DAG to retrieve health information for the DAG network from. You can use any value that uniquely identifies the server. For example: - Name @@ -118,7 +126,6 @@ The Server parameter specifies the Mailbox server in the DAG to retrieve health Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantBriefingConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantBriefingConfig.md index 13ed2a7226..a10b574eb4 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantBriefingConfig.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig applicable: Exchange Online -title: Get-DefaultTenantBriefingConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-defaulttenantbriefingconfig +schema: 2.0.0 +title: Get-DefaultTenantBriefingConfig --- # Get-DefaultTenantBriefingConfig @@ -55,13 +55,15 @@ This example returns the default Briefing email configuration for the organizati ## PARAMETERS ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantMyAnalyticsFeatureConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantMyAnalyticsFeatureConfig.md index 76bb40fd28..7e45af76f7 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig applicable: Exchange Online -title: Get-DefaultTenantMyAnalyticsFeatureConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-defaulttenantmyanalyticsfeatureconfig +schema: 2.0.0 +title: Get-DefaultTenantMyAnalyticsFeatureConfig --- # Get-DefaultTenantMyAnalyticsFeatureConfig @@ -51,13 +51,15 @@ This example returns the default opt-in or opt-out information for the various V ## PARAMETERS ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeliveryAgentConnector.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeliveryAgentConnector.md index 363d35c76f..ebf13c319c 100644 --- a/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeliveryAgentConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-deliveryagentconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DeliveryAgentConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-deliveryagentconnector +schema: 2.0.0 +title: Get-DeliveryAgentConnector --- # Get-DeliveryAgentConnector @@ -29,7 +30,7 @@ Get-DeliveryAgentConnector [[-Identity] ] ## DESCRIPTION Delivery agent connectors are used to route messages addressed to foreign systems that don't use the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://learn.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example retrieves a list of all delivery agent connectors in your organizat ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the GUID or name of the delivery agent connector. ```yaml Type: DeliveryAgentConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -74,7 +80,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DetailZapReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DetailZapReport.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-DetailZapReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DetailZapReport.md index e2332bf377..71c067b620 100644 --- a/exchange/exchange-ps/exchange/Get-DetailZapReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DetailZapReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-detailzapreport applicable: Exchange Online -title: Get-DetailZapReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-detailzapreport +schema: 2.0.0 +title: Get-DetailZapReport --- # Get-DetailZapReport @@ -47,7 +48,7 @@ If you append the command with ` | Format-List`, the following additional inform - Delivery Status - Detection Technology -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,6 +69,9 @@ This example retrieves information for the specified date range. ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured 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". @@ -78,7 +82,6 @@ If you use this parameter, you also need to use the StartDate parameter. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 3 @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". @@ -130,7 +140,6 @@ If you use this parameter, you also need to use the StartDate parameter. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 4 diff --git a/exchange/exchange-ps/exchange/Get-DetailsTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Get-DetailsTemplate.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-DetailsTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DetailsTemplate.md index 71900617a9..769cf1f0e9 100644 --- a/exchange/exchange-ps/exchange/Get-DetailsTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DetailsTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-detailstemplate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DetailsTemplate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-detailstemplate +schema: 2.0.0 +title: Get-DetailsTemplate --- # Get-DetailsTemplate @@ -31,7 +32,7 @@ Get-DetailsTemplate [[-Identity] ] ## DESCRIPTION The Get-DetailsTemplate cmdlet retrieves the attributes for one or more details templates. Wildcard characters can be used when specifying the type and language of the details templates. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example retrieves all attributes for all User details template types in all ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the GUID of the details template or specifies the details template type and language separated by a backslash, for example, en-us\\User. Details template types are: - User @@ -72,7 +76,6 @@ The Identity parameter specifies the GUID of the details template or specifies t Type: DetailsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -91,7 +97,6 @@ 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 Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessPolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessPolicy.md index a79926c166..1992dc68e8 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconditionalaccesspolicy applicable: Exchange Online, Security & Compliance -title: Get-DeviceConditionalAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-deviceconditionalaccesspolicy +schema: 2.0.0 +title: Get-DeviceConditionalAccessPolicy --- # Get-DeviceConditionalAccessPolicy @@ -56,6 +57,9 @@ This example shows details about the mobile device conditional access policy nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the mobile device conditional access policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the mobile device conditional access policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessRule.md index 65fe845674..292589b539 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconditionalaccessrule applicable: Exchange Online, Security & Compliance -title: Get-DeviceConditionalAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-deviceconditionalaccessrule +schema: 2.0.0 +title: Get-DeviceConditionalAccessRule --- # Get-DeviceConditionalAccessRule @@ -58,13 +59,15 @@ This example shows details for the mobile device conditional access rule named S ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the mobile device conditional access rule that you want to view. The name of the rule uses the syntax `{}`. For example, `Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}`. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -CompareToWorkload + +> Applicable: Security & Compliance + The CompareToWorkload switch specifies whether to compare the mobile device conditional access rule to Intune rules. 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 @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationPolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationPolicy.md index 34e6dc1ae0..506cbd4331 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconfigurationpolicy applicable: Exchange Online, Security & Compliance -title: Get-DeviceConfigurationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-deviceconfigurationpolicy +schema: 2.0.0 +title: Get-DeviceConfigurationPolicy --- # Get-DeviceConfigurationPolicy @@ -56,6 +57,9 @@ This example shows details about the mobile device configuration policy named En ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the mobile device configuration policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the mobile device configuration policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationRule.md index 84afa08d75..a0fadfef90 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconfigurationrule applicable: Exchange Online, Security & Compliance -title: Get-DeviceConfigurationRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-deviceconfigurationrule +schema: 2.0.0 +title: Get-DeviceConfigurationRule --- # Get-DeviceConfigurationRule @@ -58,13 +59,15 @@ This example shows details about the mobile device configuration rule named Lega ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the mobile device configuration rule that you want to view. The name of the rule uses the syntax `{}`. For example, `Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}`. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -CompareToWorkload + +> Applicable: Security & Compliance + The CompareToWorkload switch specifies whether to compare the mobile device configuration rule to Intune rules. 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 @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DevicePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DevicePolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-DevicePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DevicePolicy.md index f7cb5c1dce..147936b675 100644 --- a/exchange/exchange-ps/exchange/Get-DevicePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DevicePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-devicepolicy applicable: Exchange Online, Security & Compliance -title: Get-DevicePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-devicepolicy +schema: 2.0.0 +title: Get-DevicePolicy --- # Get-DevicePolicy @@ -56,6 +57,9 @@ This example shows details about the mobile device policy named Engineering Grou ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the mobile device policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the mobile device policy that you want to view. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantPolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantPolicy.md index ce5c1c516e..cadb9db2ee 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-devicetenantpolicy applicable: Exchange Online, Security & Compliance -title: Get-DeviceTenantPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-devicetenantpolicy +schema: 2.0.0 +title: Get-DeviceTenantPolicy --- # Get-DeviceTenantPolicy @@ -49,13 +50,15 @@ This example shows information for your organization's mobile device tenant poli ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the name of the mobile device tenant policy that you want to view, but there's only one in your organization. The name of the policy is a GUID value. For example, a6958701-c82c-4064-ac11-64e40e7f4032. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DeviceTenantRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantRule.md index 3d61488bdc..e97fbba444 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-devicetenantrule applicable: Exchange Online, Security & Compliance -title: Get-DeviceTenantRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-devicetenantrule +schema: 2.0.0 +title: Get-DeviceTenantRule --- # Get-DeviceTenantRule @@ -50,13 +51,15 @@ This example shows information for your organization's mobile device tenant rule ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the name of the mobile device tenant rule that you want to view, but there's only one in your organization. The name of the rule is a GUID value. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroup.md similarity index 69% rename from exchange/exchange-ps/exchange/Get-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroup.md index 8a04e33eba..49bda2ddb0 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-distributiongroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-DistributionGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-distributiongroup +schema: 2.0.0 +title: Get-DistributionGroup --- # Get-DistributionGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-DistributionGroup cmdlet to view existing distribution groups or mail-enabled security groups. To view the members of a group, use the Get-DistributionGroupMember cmdlet. @@ -32,6 +33,7 @@ Get-DistributionGroup [-Anr ] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeManagedByWithDisplayNames] [-IncludeModeratedByWithDisplayNames] [-OrganizationalUnit ] [-ReadFromDomainController] @@ -52,6 +54,7 @@ Get-DistributionGroup [[-Identity] ] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeManagedByWithDisplayNames] [-IncludeModeratedByWithDisplayNames] [-OrganizationalUnit ] [-ReadFromDomainController] @@ -71,6 +74,7 @@ Get-DistributionGroup [-Credential ] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeManagedByWithDisplayNames] [-IncludeModeratedByWithDisplayNames] [-ManagedBy ] [-OrganizationalUnit ] @@ -81,7 +85,7 @@ Get-DistributionGroup [-Credential ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,6 +113,9 @@ This example returns all distribution groups and mail-enabled security groups wh ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group that you want to view. You can use any values that uniquely identifies the group. For example: - Name @@ -122,7 +129,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -132,6 +138,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -144,7 +153,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -154,6 +162,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -162,7 +173,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,6 +182,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -180,7 +193,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,6 +202,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -205,7 +220,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +229,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -228,7 +245,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,15 +254,19 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames + +> Applicable: Exchange Online + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -256,15 +276,19 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -274,15 +298,19 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromWithDisplayNames + +> Applicable: Exchange Online + 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 @@ -292,15 +320,19 @@ Accept wildcard characters: False ``` ### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -{{ Fill IncludeBypassModerationFromSendersOrMembersWithDisplayNames Description }} +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 @@ -310,15 +342,41 @@ Accept wildcard characters: False ``` ### -IncludeGrantSendOnBehalfToWithDisplayNames + +> Applicable: Exchange Online + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeManagedByWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -{{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} +The IncludeManagedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of group owners in the ManagedByWithDisplayNames 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, the ManagedByWithDisplayNames property is empty. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -328,15 +386,19 @@ Accept wildcard characters: False ``` ### -IncludeModeratedByWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -{{ Fill IncludeModeratedByWithDisplayNames Description }} +The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the ModeratedByWithDisplayNames property is empty. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -346,6 +408,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ManagedBy parameter filters the results by the owner of the group. You can use any value that uniquely identifies the owner. For example: - Name @@ -359,7 +424,6 @@ The ManagedBy parameter filters the results by the owner of the group. You can u Type: GeneralRecipientIdParameter Parameter Sets: ManagedBySet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -369,6 +433,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -380,7 +447,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -390,6 +456,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -402,7 +471,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -412,6 +480,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified distribution group subtype. Valid values are: - MailNonUniversalGroup @@ -425,7 +496,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -435,13 +505,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -451,6 +523,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -470,7 +545,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroupMember.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-DistributionGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroupMember.md index 3113e769e2..13fe1b9472 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroupMember.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-distributiongroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-DistributionGroupMember -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-distributiongroupmember +schema: 2.0.0 +title: Get-DistributionGroupMember --- # Get-DistributionGroupMember ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-DistributionGroupMember cmdlet to view the members of distribution groups and mail-enabled security groups. @@ -32,9 +33,9 @@ Get-DistributionGroupMember [-Identity] ``` ## DESCRIPTION -If your organization has multiple Active Directory domains, you may need to run the Set-ADServerSettings cmdlet with the ViewEntireForest parameter set to $true before running the Get-DistributionGroupMember cmdlet to view the entire forest. For more information, see Example 2. +If your organization has multiple Active Directory domains, you might need to run the Set-ADServerSettings cmdlet with the ViewEntireForest parameter set to $true before running the Get-DistributionGroupMember cmdlet to view the entire forest. For more information, see Example 2. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,6 +75,9 @@ In the cloud-based service, this example downloads a comma-separated value (CSV) ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group. You can use any value that uniquely identifies the group. For example: - Name @@ -87,7 +91,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupMemberIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -105,7 +111,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -123,7 +131,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -146,7 +156,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +165,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedObjects + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The IncludeSoftDeletedGroups switch specifies whether to include soft-deleted group members in the results. You don't need to specify a value with this switch. @@ -166,7 +178,6 @@ Soft-deleted group members are deleted Microsoft 365 Groups or mailboxes that ar Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -188,7 +202,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,13 +211,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-DkimSigningConfig.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-DkimSigningConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DkimSigningConfig.md index 9fe8d4bfd8..edabbe60c2 100644 --- a/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DkimSigningConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection -title: Get-DkimSigningConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dkimsigningconfig +schema: 2.0.0 +title: Get-DkimSigningConfig --- # Get-DkimSigningConfig @@ -28,7 +29,7 @@ Get-DkimSigningConfig [[-Identity] ] ## DESCRIPTION DKIM in Microsoft 365 is an email authentication method that uses a public key infrastructure (PKI), message headers and CNAME records in DNS to authenticate the message sender, which is stamped in the DKIM-Signature header field. DKIM helps prevent forged sender email addresses (also known as spoofing) by verifying that the domain in the From address matches the domain in the DKIM-Signature header field. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example shows detailed information for the DKIM signing policy for contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the DKIM signing policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name: The domain name (for example, contoso.com). @@ -59,7 +63,6 @@ The Identity parameter specifies the DKIM signing policy that you want to view. Type: DkimSigningConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpCompliancePolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpCompliancePolicy.md index f5a379ed1b..50f80e0531 100644 --- a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpcompliancepolicy applicable: Security & Compliance -title: Get-DlpCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpcompliancepolicy +schema: 2.0.0 +title: Get-DlpCompliancePolicy --- # Get-DlpCompliancePolicy @@ -69,6 +70,9 @@ This example gets all of the DLP policies in an environment and displays the dis ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -80,7 +84,6 @@ The Identity parameter specifies the DLP policy that you want to view. You can u Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -90,13 +93,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + {{ Fill DisplayName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + 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. @@ -114,7 +122,6 @@ The DistributionDetail switch returns detailed policy distribution information i Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -ForceValidate + +> Applicable: Security & Compliance + {{ Fill ForceValidate Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -IncludeExtendedProperties + +> Applicable: Security & Compliance + {{ Fill IncludeExtendedProperties Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -156,13 +167,15 @@ Accept wildcard characters: False ``` ### -IncludeRulesMetadata + +> Applicable: Security & Compliance + {{ Fill IncludeRulesMetadata Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -IRMUserRiskConfiguredAnyRule + +> Applicable: Security & Compliance + {{ Fill IRMUserRiskConfiguredAnyRule Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -IncludeSimulationResults + +> Applicable: Security & Compliance + {{ Fill IncludeSimulationResults Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -Summary + +> Applicable: Security & Compliance + {{ Fill Summary Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpComplianceRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-DlpComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpComplianceRule.md index 3ec06ed550..0903acec7c 100644 --- a/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpcompliancerule applicable: Security & Compliance -title: Get-DlpComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpcompliancerule +schema: 2.0.0 +title: Get-DlpComplianceRule --- # Get-DlpComplianceRule @@ -57,6 +58,9 @@ This example lists all the rules included in the DLP compliance policy named "PI ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the DLP rule that you want to view. You can use Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + {{ Fill DisplayName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -IncludeExecutionRuleGuids + +> Applicable: Security & Compliance + {{ Fill IncludeExecutionRuleGuids Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the DLP policy that contains the rules. Using this parameter returns all rules that are assigned to the specified policy. Valid input for this parameter is any value that uniquely identifies the policy. For example - Name @@ -121,7 +131,6 @@ The Policy parameter specifies the DLP policy that contains the rules. Using thi Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpDetailReport.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-DlpDetailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpDetailReport.md index 624222fe8e..e210567039 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpDetailReport.md @@ -1,22 +1,23 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpdetailreport applicable: Exchange Online, Security & Compliance -title: Get-DlpDetailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpdetailreport +schema: 2.0.0 +title: Get-DlpDetailReport --- # Get-DlpDetailReport ## SYNOPSIS -**Note**: This cmdlet has been retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. +**Note**: This cmdlet is retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchangepowershell/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. This cmdlet is available only in the cloud-based service. -Use the Get-DlpDetailReport cmdlet to list details about data loss prevention (DLP) rule matches for Exchange Online, SharePoint Online, and OneDrive for Business in your cloud-based organization for the last 30 days. +Use the Get-DlpDetailReport cmdlet to list details about data loss prevention (DLP) rule matches for Exchange Online, SharePoint, and OneDrive in your cloud-based organization for the last 30 days. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -58,9 +59,9 @@ The Get-DlpDetailReport cmdlet returns detailed information about specific DLP r - Recipients - AttachmentNames -To see DLP detection data that's aggregated per day, use the [Get-DlpDetectionsReport](https://learn.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport) cmdlet. +To see DLP detection data that's aggregated per day, use the [Get-DlpDetectionsReport](https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpdetectionsreport) cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,6 +75,9 @@ The following example lists the details of all the DLP policy activities defined ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Security & Compliance + The Action parameter filters the report by the action taken by DLP policies. Valid values are: - BlockAccess @@ -86,7 +90,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Actor + +> Applicable: Exchange Online, Security & Compliance + The Actor parameter filters the report by the user who last modified the item. You can enter multiple users separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -104,7 +110,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -DlpCompliancePolicy + +> Applicable: Exchange Online, Security & Compliance + The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -122,7 +130,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -DlpComplianceRule + +> Applicable: Exchange Online, Security & Compliance + The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -140,7 +150,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -158,7 +170,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -168,6 +179,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Security & Compliance + The EventType parameter filters the report by the event type. Valid values are: - DLPActionHits @@ -186,7 +200,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -196,13 +209,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -212,13 +227,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -228,11 +245,14 @@ Accept wildcard characters: False ``` ### -Source + +> Applicable: Exchange Online, Security & Compliance + The Source parameter filters the report by workload. Valid values are: - EXCH: Exchange Online -- ODB: OneDrive for Business -- SPO: SharePoint Online +- ODB: OneDrive +- SPO: SharePoint You can specify multiple values separated by commas. @@ -240,7 +260,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -250,6 +269,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -258,7 +280,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpDetectionsReport.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpDetectionsReport.md index 0a9115f073..db6246c871 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpDetectionsReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport applicable: Exchange Online, Security & Compliance -title: Get-DlpDetectionsReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpdetectionsreport +schema: 2.0.0 +title: Get-DlpDetectionsReport --- # Get-DlpDetectionsReport @@ -14,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) 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/exchangepowershell/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. -Use the Get-DlpDetectionsReport cmdlet to list a summary of data loss prevention (DLP) rule matches for Exchange Online, SharePoint Online and OneDrive for Business in your cloud-based organization for the last 30 days. +Use the Get-DlpDetectionsReport cmdlet to list a summary of data loss prevention (DLP) rule matches for Exchange Online, SharePoint and OneDrive in your cloud-based organization for the last 30 days. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -52,7 +53,7 @@ To see all of these columns (width issues), write the output to a file. For exam To see detailed information about each DLP rule match, use the Get-DlpDetailReport cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,6 +67,9 @@ This example lists the DLP activities for November, 2018. ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Security & Compliance + The Action parameter filters the report by the action taken by DLP policies. Valid values are: - BlockAccess @@ -78,7 +82,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Security & Compliance + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -DlpCompliancePolicy + +> Applicable: Exchange Online, Security & Compliance + The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -112,7 +120,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -122,6 +129,9 @@ Accept wildcard characters: False ``` ### -DlpComplianceRule + +> Applicable: Exchange Online, Security & Compliance + The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -130,7 +140,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -148,7 +160,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -158,6 +169,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Security & Compliance + The EventType parameter filters the report by the event type. Valid values are: - DataRetentions @@ -183,7 +197,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -Expression + +> Applicable: Security & Compliance + This parameter is available only in Security & Compliance PowerShell This parameter is reserved for internal Microsoft use. @@ -201,7 +217,6 @@ This parameter is reserved for internal Microsoft use. Type: Expression Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -211,13 +226,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -227,13 +244,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -243,11 +262,14 @@ Accept wildcard characters: False ``` ### -Source + +> Applicable: Exchange Online, Security & Compliance + The Source parameter filters the report by workload. Valid values are: - EXCH: Exchange Online -- ODB: OneDrive for Business -- SPO: SharePoint Online +- ODB: OneDrive +- SPO: SharePoint You can specify multiple values separated by commas. @@ -255,7 +277,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -273,7 +297,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -283,6 +306,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online, Security & Compliance + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. For this cmdlet, valid values are: @@ -297,7 +323,6 @@ You can specify multiple values separated by commas. The values that you specify Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpEdmSchema.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DlpEdmSchema.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpEdmSchema.md index d9052762b8..874113548b 100644 --- a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpEdmSchema.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpedmschema applicable: Security & Compliance -title: Get-DlpEdmSchema -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpedmschema +schema: 2.0.0 +title: Get-DlpEdmSchema --- # Get-DlpEdmSchema @@ -47,6 +48,9 @@ This example returns detailed information for the DLP EDM schema named Schema fo ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP EDM schema that you want to view. You can use any value that uniquely identifies the schema. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the DLP EDM schema that you want to view. You c Type: EdmStorageIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpIncidentDetailReport.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpIncidentDetailReport.md index c9eaf7d98e..e5e31d5ac0 100644 --- a/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpIncidentDetailReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpincidentdetailsreport applicable: Exchange Online, Security & Compliance -title: Get-DlpIncidentDetailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpincidentdetailsreport +schema: 2.0.0 +title: Get-DlpIncidentDetailReport --- # Get-DlpIncidentDetailReport @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) instead. +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchangepowershell/export-activityexplorerdata) instead. Use the Get-DlpIncidentDetailReport cmdlet to view the details of incidents that happened in the last 30 days. @@ -65,7 +66,7 @@ The output of the Get-DlpIncidentDetailReport cmdlet includes the following prop - SensitiveInformationCountList - SensitiveInformationConfidenceList -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,6 +80,9 @@ This example lists the details of the all incidents that occurred between the da ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Security & Compliance + The Action parameter filters the report by the action taken by DLP policies. Valid values are: - BlockAccess @@ -91,7 +95,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Actor + +> Applicable: Exchange Online, Security & Compliance + The Actor parameter filters the report by the user who last modified the item. You can enter multiple users separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -109,7 +115,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -DlpCompliancePolicy + +> Applicable: Exchange Online, Security & Compliance + The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -127,7 +135,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -DlpComplianceRule + +> Applicable: Exchange Online, Security & Compliance + The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -145,7 +155,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -155,6 +164,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -163,7 +175,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Security & Compliance + The EventType parameter filters the report by the event type. Valid values are: - DLPByIncidentIdActionHits @@ -190,7 +204,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -200,13 +213,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -216,13 +231,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -232,11 +249,14 @@ Accept wildcard characters: False ``` ### -Source + +> Applicable: Exchange Online, Security & Compliance + The Source parameter filters the report by workload. Valid values are: - EXCH: Exchange Online -- ODB: OneDrive for Business -- SPO: SharePoint Online +- ODB: OneDrive +- SPO: SharePoint - TEAMS You can specify multiple values separated by commas. @@ -245,7 +265,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -255,6 +274,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -263,7 +285,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpKeywordDictionary.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpKeywordDictionary.md index cf21bb85d5..3158241804 100644 --- a/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpKeywordDictionary.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpkeyworddictionary applicable: Exchange Online, Security & Compliance -title: Get-DlpKeywordDictionary -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpkeyworddictionary +schema: 2.0.0 +title: Get-DlpKeywordDictionary --- # Get-DlpKeywordDictionary @@ -47,13 +48,15 @@ This example returns detailed information about the DLP keyword dictionary named ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Security & Compliance + The Name parameter specifies the name of the DLP keyword dictionary that you want to view. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicy.md similarity index 74% rename from exchange/exchange-ps/exchange/Get-DlpPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicy.md index ef75ad1628..879c90089d 100644 --- a/exchange/exchange-ps/exchange/Get-DlpPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlppolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-DlpPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlppolicy +schema: 2.0.0 +title: Get-DlpPolicy --- # Get-DlpPolicy ## SYNOPSIS -**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. +**Note**: This cmdlet is 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. This cmdlet is functional only in on-premises Exchange. @@ -29,7 +30,7 @@ Get-DlpPolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example returns detailed information about the DLP policy named Employee Nu ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the DLP policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the DLP policy that you want to view. You can u Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicyTemplate.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicyTemplate.md index bafb90d765..83bbc7993e 100644 --- a/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicyTemplate.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlppolicytemplate -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-DlpPolicyTemplate -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlppolicytemplate +schema: 2.0.0 +title: Get-DlpPolicyTemplate --- # Get-DlpPolicyTemplate ## SYNOPSIS -**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). +**Note**: This cmdlet is 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). This cmdlet is functional only in on-premises Exchange. @@ -29,7 +30,7 @@ Get-DlpPolicyTemplate [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example returns detailed information about the DLP policy template named GL ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the DLP policy template you want to view. You can use any value that uniquely identifies the DLP policy template. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy template. ```yaml Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationType.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationType.md index 99d0a14db7..601dfddd45 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype applicable: Exchange Online, Security & Compliance -title: Get-DlpSensitiveInformationType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpsensitiveinformationtype +schema: 2.0.0 +title: Get-DlpSensitiveInformationType --- # Get-DlpSensitiveInformationType @@ -53,6 +54,9 @@ This example lists all the properties of the sensitive information type named "C ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitive information type that you want to view. Valid values are: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the sensitive information type that you want to Type: SensitiveInformationTypeIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Capability + +> Applicable: Security & Compliance + {{ Fill Capability Description }} ```yaml Type: ClassificationCapabilityType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -IncludeDetails + +> Applicable: Security & Compliance + {{ Fill IncludeDetails Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -IncludeElements + +> Applicable: Security & Compliance + {{ Fill IncludeElements Description }} ```yaml Type: ClassificationPrimitiveElementType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationTypeRulePackage.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationTypeRulePackage.md index 322925e01f..4cce370d02 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationTypeRulePackage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtyperulepackage applicable: Exchange Online, Security & Compliance -title: Get-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpsensitiveinformationtyperulepackage +schema: 2.0.0 +title: Get-DlpSensitiveInformationTypeRulePackage --- # Get-DlpSensitiveInformationTypeRulePackage @@ -50,6 +51,9 @@ This example returns detailed information for the sensitive information type rul ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the sensitive information type rule package that you want to view. You can use any value that uniquely identifies the rule package. For example: - RuleCollectionName @@ -60,7 +64,6 @@ The Identity parameter specifies the sensitive information type rule package tha Type: SensitiveInformationTypeRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Capability + +> Applicable: Exchange Online, Security & Compliance + {{ Fill Capability Description }} ```yaml Type: ClassificationCapabilityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSiDetectionsReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpSiDetectionsReport.md index b89d2416f2..f66ffd8c70 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSiDetectionsReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpsidetectionsreport applicable: Exchange Online, Security & Compliance -title: Get-DlpSiDetectionsReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpsidetectionsreport +schema: 2.0.0 +title: Get-DlpSiDetectionsReport --- # Get-DlpSiDetectionsReport @@ -14,7 +15,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). -**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchangepowershell/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. Use the Get-DlpSiDetectionsReport cmdlet to view information about data loss prevention (DLP) sensitive information type detections in the Microsoft Purview compliance portal for the last 90 days. @@ -59,6 +60,9 @@ This example returns detections for the sensitive information type 0e9b3178-9678 ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -67,7 +71,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -SensitiveType + +> Applicable: Exchange Online, Security & Compliance + The SensitiveType parameter filters the results by the specified sensitive information type. A valid value is the GUID of the sensitive information type (for example, 0e9b3178-9678-47dd-a509-37222ca96b42). To find the GUID value of a sensitive information type, run this command: Get-DlpSensitiveInformationType. You can enter multiple values separated by commas: `"Value1","Value2",..."ValueN"`. @@ -85,7 +91,6 @@ You can enter multiple values separated by commas: `"Value1","Value2",..."ValueN Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-DnssecStatusForVerifiedDomain.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DnssecStatusForVerifiedDomain.md index f80fd19e6d..db6ed9f581 100644 --- a/exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DnssecStatusForVerifiedDomain.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dnssecstatusforverifieddomain +schema: 2.0.0 +title: Get-DnssecStatusForVerifiedDomain --- # Get-DnssecStatusForVerifiedDomain @@ -33,7 +34,7 @@ Get-DnssecStatusForVerifiedDomain [-DomainName] ## DESCRIPTION For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,13 +98,15 @@ This example contains the output from Example 1 and readable values for the DnsV ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + 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 @@ -113,13 +116,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -129,13 +134,15 @@ Accept wildcard characters: False ``` ### -SkipDnsValidation + +> Applicable: Exchange Online + 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 @@ -145,13 +152,15 @@ Accept wildcard characters: False ``` ### -SkipMtaStsValidation + +> Applicable: Exchange Online + 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 @@ -161,13 +170,15 @@ Accept wildcard characters: False ``` ### -SkipMxValidation + +> Applicable: Exchange Online + 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 @@ -177,13 +188,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named @@ -193,7 +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](http://go.microsoft.com/fwlink/p/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS diff --git a/exchange/exchange-ps/exchange/Get-DomainController.md b/exchange/exchange-ps/ExchangePowerShell/Get-DomainController.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-DomainController.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DomainController.md index b36194819e..4d274a36d3 100644 --- a/exchange/exchange-ps/exchange/Get-DomainController.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DomainController.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-domaincontroller -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DomainController -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-domaincontroller +schema: 2.0.0 +title: Get-DomainController --- # Get-DomainController @@ -39,7 +40,7 @@ Get-DomainController [-DomainName ] The Get-DomainController cmdlet is used by the Exchange admin center to populate fields that display domain controller information. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,13 +60,15 @@ For more information about pipelining and the Format-Table cmdlet, see [About Pi ## PARAMETERS ### -GlobalCatalog + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GlobalCatalog switch specifies whether the command should return a list of global catalog servers. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: GlobalCatalog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -85,7 +91,6 @@ If you use the Forest parameter, the credentials are used to access the forest. Type: NetworkCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainName parameter specifies the fully qualified domain name (FQDN) of the domain for which you want to return a list of domain controllers. ```yaml Type: Fqdn Parameter Sets: DomainController Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,13 +118,15 @@ Accept wildcard characters: False ``` ### -Forest + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Forest parameter specifies the FQDN of the root domain of the forest for which you want to return a list of domain controllers. ```yaml Type: Fqdn Parameter Sets: GlobalCatalog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroup.md similarity index 69% rename from exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroup.md index 0154138fe2..04bd1bfbd6 100644 --- a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-DynamicDistributionGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dynamicdistributiongroup +schema: 2.0.0 +title: Get-DynamicDistributionGroup --- # Get-DynamicDistributionGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-DynamicDistributionGroup cmdlet to view existing dynamic distribution groups. @@ -31,6 +32,7 @@ Get-DynamicDistributionGroup [-Anr ] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeManagedByWithDisplayNames] [-IncludeGrantSendOnBehalfToWithDisplayNames] [-IncludeModeratedByWithDisplayNames] [-IncludeSystemObjects] @@ -53,6 +55,7 @@ Get-DynamicDistributionGroup [[-Identity] ] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeManagedByWithDisplayNames] [-IncludeModeratedByWithDisplayNames] [-IncludeSystemObjects] [-OrganizationalUnit ] @@ -74,6 +77,7 @@ Get-DynamicDistributionGroup [-ManagedBy ] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeManagedByWithDisplayNames] [-IncludeModeratedByWithDisplayNames] [-IncludeSystemObjects] [-OrganizationalUnit ] @@ -86,7 +90,7 @@ Get-DynamicDistributionGroup [-ManagedBy ] ## DESCRIPTION A dynamic distribution group queries mail-enabled objects and builds the group membership based on the results. The group membership is recalculated whenever an email message is sent to the group. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -123,6 +127,9 @@ This example returns the members for the dynamic distribution group named Full T ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the dynamic distribution group that you want to view. You can use any value that uniquely identifies the dynamic distribution group. For example: - Name @@ -136,7 +143,6 @@ The Identity parameter specifies the dynamic distribution group that you want to Type: DynamicGroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -146,6 +152,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -158,7 +167,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,6 +176,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -176,7 +187,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -186,6 +196,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -194,7 +207,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,6 +216,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -219,7 +234,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -229,6 +243,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -242,7 +259,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,15 +268,19 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames + +> Applicable: Exchange Online + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -270,15 +290,19 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -288,15 +312,19 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromWithDisplayNames + +> Applicable: Exchange Online + 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 @@ -306,15 +334,19 @@ Accept wildcard characters: False ``` ### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -{{ Fill IncludeBypassModerationFromSendersOrMembersWithDisplayNames Description }} +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 @@ -324,15 +356,41 @@ Accept wildcard characters: False ``` ### -IncludeGrantSendOnBehalfToWithDisplayNames + +> Applicable: Exchange Online + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeManagedByWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -{{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} +The IncludeManagedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of group owners in the ManagedByWithDisplayNames 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, the ManagedByWithDisplayNames property is empty. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -342,15 +400,19 @@ Accept wildcard characters: False ``` ### -IncludeModeratedByWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -{{ Fill IncludeModeratedByWithDisplayNames Description }} +The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the ModeratedByWithDisplayNames property is empty. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -360,6 +422,9 @@ Accept wildcard characters: False ``` ### -IncludeSystemObjects + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -368,7 +433,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -378,6 +442,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ManagedBy parameter filters the results by the owner of the group. You can use any value that uniquely identifies the owner. For example: - Name @@ -391,7 +458,6 @@ The ManagedBy parameter filters the results by the owner of the group. You can u Type: GeneralRecipientIdParameter Parameter Sets: ManagedBySet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -401,6 +467,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -412,7 +481,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -422,6 +490,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -434,7 +505,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -444,13 +514,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -460,6 +532,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -474,7 +549,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroupMember.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroupMember.md index d93483e17c..52dea07cde 100644 --- a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroupMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroupmember applicable: Exchange Online, Exchange Online Protection -title: Get-DynamicDistributionGroupMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dynamicdistributiongroupmember +schema: 2.0.0 +title: Get-DynamicDistributionGroupMember --- # Get-DynamicDistributionGroupMember @@ -31,7 +32,7 @@ Get-DynamicDistributionGroupMember [-Identity] Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the dynamic distribution group. You can use any value that uniquely identifies the group. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the dynamic distribution group. You can use any Type: DynamicDistributionGroupMemberIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Online, Exchange Online Protection + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -76,7 +82,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedObjects + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeSoftDeletedGroups switch specifies whether to include soft-deleted group members in the results. You don't need to specify a value with this switch. Soft-deleted group members are deleted Microsoft 365 Groups or mailboxes that are still recoverable. @@ -94,7 +102,6 @@ Soft-deleted group members are deleted Microsoft 365 Groups or mailboxes that ar Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + 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 diff --git a/exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-EOPProtectionPolicyRule.md similarity index 74% rename from exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EOPProtectionPolicyRule.md index 6ca809c445..96a4b4e058 100644 --- a/exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: Get-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-eopprotectionpolicyrule +schema: 2.0.0 +title: Get-EOPProtectionPolicyRule --- # Get-EOPProtectionPolicyRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-EOPProtectionPolicyRule cmdlet to view rules for Exchange Online Protection (EOP) protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. +Use the Get-EOPProtectionPolicyRule cmdlet to view rules for default email protections for all cloud mailboxes in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -29,7 +30,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example returns detailed information about the rule named Strict Preset Sec ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -62,7 +66,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online, Exchange Online Protection + The State parameter filters the results by the state of the rule. Valid values are: - Enabled @@ -82,7 +88,6 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOCasMailbox.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-EXOCasMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOCasMailbox.md index 72e7aca6f2..173797cbcd 100644 --- a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOCasMailbox.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exocasmailbox applicable: Exchange Online -title: Get-EXOCasMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exocasmailbox +schema: 2.0.0 +title: Get-EXOCasMailbox --- # Get-EXOCasMailbox @@ -83,6 +83,9 @@ This example returns the values of the following client access settings for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values: - User ID or user principal name (UPN) @@ -104,7 +107,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmt Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -114,6 +116,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -128,7 +133,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, Prima Type: String Parameter Sets: Anr Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,13 +142,15 @@ Accept wildcard characters: False ``` ### -ActiveSyncDebugLogging + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -154,6 +160,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -162,7 +171,6 @@ You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or User Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -172,6 +180,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -187,7 +198,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -197,13 +207,15 @@ Accept wildcard characters: False ``` ### -GetImapProtocolLog + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -213,13 +225,15 @@ Accept wildcard characters: False ``` ### -GetPopProtocolLog + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -229,13 +243,15 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -245,6 +261,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -256,7 +275,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -266,6 +284,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -274,7 +295,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -284,6 +304,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Online + The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. For more information about the available properties, see [Get-EXOCasMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets). @@ -292,7 +315,6 @@ For more information about the available properties, see [Get-EXOCasMailbox prop Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -302,6 +324,9 @@ Accept wildcard characters: False ``` ### -PropertySets + +> Applicable: Exchange Online + The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are: - Minimum (this is the default value) @@ -321,7 +346,6 @@ For more information about the properties that are included in each property set Type: PropertySet[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -331,6 +355,9 @@ Accept wildcard characters: False ``` ### -ProtocolSettings + +> Applicable: Exchange Online + The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings: - ExternalImapSettings @@ -348,7 +375,6 @@ To see these values, you need to use a formatting cmdlet. For example, `Get-CasM Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -358,13 +384,15 @@ Accept wildcard characters: False ``` ### -ReadIsOptimizedForAccessibility + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -374,13 +402,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + 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 @@ -390,13 +420,15 @@ Accept wildcard characters: False ``` ### -SendLogsTo + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -406,6 +438,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or PrimarySmtpAddress parameters. @@ -414,7 +449,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity o Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailbox.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-EXOMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMailbox.md index fb1295de5f..73afabf04d 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailbox.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailbox applicable: Exchange Online -title: Get-EXOMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailbox +schema: 2.0.0 +title: Get-EXOMailbox --- # Get-EXOMailbox @@ -105,6 +105,9 @@ This example returns the specified properties for the mailbox John@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values: - User ID or user principal name (UPN) @@ -126,7 +129,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmt Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -136,6 +138,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -150,7 +155,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, Prima Type: String Parameter Sets: Anr Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -160,13 +164,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Online + The Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -176,13 +182,15 @@ Accept wildcard characters: False ``` ### -Async + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -192,6 +200,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -200,7 +211,6 @@ You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or User Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -210,6 +220,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -225,7 +238,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -235,13 +247,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -251,6 +265,9 @@ Accept wildcard characters: False ``` ### -InactiveMailboxOnly + +> Applicable: Exchange Online + The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch. An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. @@ -261,7 +278,6 @@ To return both active mailboxes and inactive mailboxes in the results, don't use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -271,6 +287,9 @@ Accept wildcard characters: False ``` ### -IncludeInactiveMailbox + +> Applicable: Exchange Online + The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch. An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. @@ -281,7 +300,6 @@ To return only inactive mailboxes in the results, don't use this switch. Instead Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -291,6 +309,9 @@ Accept wildcard characters: False ``` ### -MailboxPlan + +> Applicable: Exchange Online + The MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example: - Name @@ -305,7 +326,6 @@ A mailbox plan specifies the permissions and features available to a mailbox use Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -315,13 +335,15 @@ Accept wildcard characters: False ``` ### -Migration + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -331,6 +353,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -342,7 +367,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -352,6 +376,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -360,7 +387,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -370,6 +396,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Online + The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. For more information about the available properties, see [Get-EXOMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). @@ -378,7 +407,6 @@ For more information about the available properties, see [Get-EXOMailbox propert Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -388,6 +416,9 @@ Accept wildcard characters: False ``` ### -PropertySets + +> Applicable: Exchange Online + The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are: - All @@ -417,7 +448,6 @@ For more information about the properties that are included in each property set Type: PropertySet[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -427,13 +457,15 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -443,11 +475,13 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Online + The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are: - DiscoveryMailbox - EquipmentMailbox -- GroupMailbox - LegacyMailbox - LinkedMailbox - LinkedRoomMailbox @@ -463,7 +497,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -473,13 +506,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + 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 @@ -489,6 +524,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Online + The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch. Soft-deleted mailboxes are deleted mailboxes that are still recoverable. @@ -497,7 +535,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -507,6 +544,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or PrimarySmtpAddress parameters. @@ -515,7 +555,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity o Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderPermission.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderPermission.md index d15ff5ab3c..f4ab5fa2a7 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderPermission.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission applicable: Exchange Online -title: Get-EXOMailboxFolderPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderpermission +schema: 2.0.0 +title: Get-EXOMailboxFolderPermission --- # Get-EXOMailboxFolderPermission @@ -53,6 +53,9 @@ This example returns the permissions for the same folder in John's mailbox, but ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: `:\`. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox. Otherwise, you can use any value that uniquely identifies the mailbox. For example: @@ -70,7 +73,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -80,6 +82,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -88,7 +93,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -98,13 +102,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + The GroupMailbox switch is required to return Microsoft 365 Groups in the results. 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 @@ -114,6 +120,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -122,7 +131,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,6 +140,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example: - Name @@ -141,13 +152,12 @@ The User parameter filters the results by the specified mailbox, mail user, or m - Email address - GUID -**Note**: If you specify a user that doesn't have permission to access the mailbox folder, the command will throw an exception. +**Note**: If you specify a user that doesn't have permission to access the mailbox folder, the command returns an error. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,7 +167,10 @@ Accept wildcard characters: False ``` ### -UserPrincipalName -The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). + +> Applicable: Exchange Online + +The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, `navin@contoso.onmicrosoft.com`). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -165,7 +178,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Pr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -185,10 +197,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderpermission) -[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxfolderpermission) -[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxfolderpermission) -[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderStatistics.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderStatistics.md index b6d21cf8d8..62cc044bb4 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderStatistics.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderstatistics applicable: Exchange Online -title: Get-EXOMailboxFolderStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderstatistics +schema: 2.0.0 +title: Get-EXOMailboxFolderStatistics --- # Get-EXOMailboxFolderStatistics @@ -67,6 +67,9 @@ This example uses the FolderScope parameter to view Inbox folder statistics for ## PARAMETERS ### -Archive + +> Applicable: Exchange Online + The Archive switch specifies whether to return the usage statistics of the archive mailbox that's associated with the mailbox or mail user. You don't need to specify a value with this switch. If you use this switch on a mailbox that doesn't have archiving enabled, an error is returned. @@ -75,7 +78,6 @@ If you use this switch on a mailbox that doesn't have archiving enabled, an erro Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -85,13 +87,15 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -109,7 +116,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -119,6 +125,9 @@ Accept wildcard characters: False ``` ### -Folderscope + +> Applicable: Exchange Online + The FolderScope parameter specifies the scope of the search by folder type. Valid values include: - All @@ -148,7 +157,6 @@ The FolderScope parameter specifies the scope of the search by folder type. Vali Type: ElcFolderType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -158,6 +166,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox. Otherwise, you can use any value that uniquely identifies the mailbox or mail user. For example: @@ -174,7 +185,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -184,13 +194,15 @@ Accept wildcard characters: False ``` ### -IncludeAnalysis + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -200,13 +212,15 @@ Accept wildcard characters: False ``` ### -IncludeOldestAndNewestItems + +> Applicable: Exchange Online + The IncludeOldestAndNewestItems switch specifies whether to return the dates of the oldest and newest items in each folder. 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 @@ -216,6 +230,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Online + The IncludeSoftDeletedRecipients switch specifies whether to include soft-deleted mailboxes in the results. You don't need to specify a value with this switch. Soft-deleted mailboxes are mailboxes that have been deleted, but are still recoverable. @@ -224,7 +241,6 @@ Soft-deleted mailboxes are mailboxes that have been deleted, but are still recov Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -234,6 +250,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -242,7 +261,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -252,6 +270,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -260,7 +281,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Pr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxPermission.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxPermission.md index d008aa8f24..65358472d3 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxPermission.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxpermission applicable: Exchange Online -title: Get-EXOMailboxPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxpermission +schema: 2.0.0 +title: Get-EXOMailboxPermission --- # Get-EXOMailboxPermission @@ -54,7 +54,7 @@ By default, the following permissions are assigned to user mailboxes: - FullAccess and ReadPermission are directly assigned to NT AUTHORITY\SELF. This entry gives a user permission to their own mailbox. - FullAccess is denied to Administrator, Domain Admins, Enterprise Admins and Organization Management. These inherited permissions prevent these users and group members from opening other users' mailboxes. -- ChangeOwner, ChangePermission, DeleteItem, and ReadPermission are allowed for Administrator, Domain Admins, Enterprise Admins and Organization Management. Note that these inherited permission entries also appear to allow FullAccess. However, these users and groups do not have FullAccess to the mailbox because the inherited Deny permission entries override the inherited Allow permission entries. +- ChangeOwner, ChangePermission, DeleteItem, and ReadPermission are allowed for Administrator, Domain Admins, Enterprise Admins and Organization Management. These inherited permission entries also appear to allow FullAccess. However, these users and groups do not have FullAccess to the mailbox because the inherited Deny permission entries override the inherited Allow permission entries. - FullAccess is inherited by NT AUTHORITY\SYSTEM and ReadPermission is inherited by NT AUTHORITY\NETWORK. - FullAccess and ReadPermission are inherited by Exchange Servers, ChangeOwner, ChangePermission, DeleteItem, and ReadPermission are inherited by Exchange Trusted Subsystem and ReadPermission is inherited by Managed Availability Servers. @@ -72,6 +72,9 @@ This example return the permission the user has on mailboxes ## PARAMETERS ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -80,7 +83,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -90,6 +92,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox. Otherwise, you can use any value that uniquely identifies the mailbox. For example: @@ -106,7 +111,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddr Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -116,13 +120,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Online + 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. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,6 +138,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -140,7 +149,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -150,13 +158,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + 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 @@ -166,6 +176,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Online + The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch. Soft-deleted mailboxes are deleted mailboxes that are still recoverable. @@ -174,7 +187,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -184,6 +196,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + The User parameter returns information about the user who has permissions to the mailbox specified by the Identity parameter. The user that you specify for this parameter must be a user or security group (a security principal that can have permissions assigned). You can use any value that uniquely identifies the user. For example: @@ -199,7 +214,6 @@ The user that you specify for this parameter must be a user or security group (a Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -209,6 +223,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -217,7 +234,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Pr Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxStatistics.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxStatistics.md index cbe03cc816..4840704c43 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxStatistics.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxstatistics applicable: Exchange Online -title: Get-EXOMailboxStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxstatistics +schema: 2.0.0 +title: Get-EXOMailboxStatistics --- # Get-EXOMailboxStatistics @@ -61,13 +61,15 @@ This example retrieves the minimum set of properties and the specified propertie ## PARAMETERS ### -Archive + +> Applicable: Exchange Online + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -77,13 +79,15 @@ Accept wildcard characters: False ``` ### -DatabaseGuid + +> Applicable: Exchange Online + The DatabaseGuid parameter filters the results by the GUID of mailbox database that hosts the Mailbox. You can find this property value by using the Get-EXOMailbox cmdlet with the Properties parameter value DatabaseGuid. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,13 +97,15 @@ Accept wildcard characters: False ``` ### -ExchangeGuid + +> Applicable: Exchange Online + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -109,6 +115,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox. Otherwise, you can use any value that uniquely identifies the mailbox. For example: @@ -127,7 +136,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -137,13 +145,15 @@ Accept wildcard characters: False ``` ### -IncludeMoveHistory + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -153,13 +163,15 @@ Accept wildcard characters: False ``` ### -IncludeMoveReport + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -169,6 +181,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Online + The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. Soft-deleted recipients are deleted recipients that are still recoverable. @@ -177,7 +192,6 @@ Soft-deleted recipients are deleted recipients that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -187,6 +201,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -195,7 +212,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -205,6 +221,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Online + The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. For more information about the available properties, see [Get-EXOMailboxStatistics property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets). @@ -213,7 +232,6 @@ For more information about the available properties, see [Get-EXOMailboxStatisti Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -223,6 +241,9 @@ Accept wildcard characters: False ``` ### -PropertySets + +> Applicable: Exchange Online + The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are: - Minimum (this is the default value) @@ -236,7 +257,6 @@ For more information about the properties that are included in each property set Type: PropertySet[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -246,6 +266,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -254,7 +277,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Pr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMobileDeviceStatistics.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMobileDeviceStatistics.md index 91b5ebab64..ac4e8c62b0 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMobileDeviceStatistics.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomobiledevicestatistics applicable: Exchange Online -title: Get-EXOMobileDeviceStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomobiledevicestatistics +schema: 2.0.0 +title: Get-EXOMobileDeviceStatistics --- # Get-EXOMobileDeviceStatistics @@ -72,6 +72,9 @@ This example returns the statistics for active sync devices linked to user with ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mobile device that you want to view. You can use any value that uniquely identifies the mobile device. For example: - GUID @@ -83,7 +86,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, Primar Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,6 +95,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Online + The Mailbox parameter filters the results by the user mailbox that's associated with the mobile device. You can use any value that uniquely identifies the mailbox. For example: - GUID @@ -104,7 +109,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: String Parameter Sets: MobileDeviceIdentity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -114,13 +118,15 @@ Accept wildcard characters: False ``` ### -ActiveSync + +> Applicable: Exchange Online + The ActiveSync switch filters the results by Exchange ActiveSync devices. 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 @@ -130,6 +136,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -138,7 +147,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -148,13 +156,15 @@ Accept wildcard characters: False ``` ### -GetMailboxLog + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -164,13 +174,15 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -180,13 +192,15 @@ Accept wildcard characters: False ``` ### -OWAforDevices + +> Applicable: Exchange Online + The OWAforDevices switch filters the results by devices where Outlook on the web for devices is enabled. 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 @@ -196,6 +210,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -204,7 +221,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -214,13 +230,15 @@ Accept wildcard characters: False ``` ### -RestApi + +> Applicable: Exchange Online + The RestApi switch filters the results by REST API devices. 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 @@ -230,13 +248,15 @@ Accept wildcard characters: False ``` ### -ShowRecoveryPassword + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -246,13 +266,15 @@ Accept wildcard characters: False ``` ### -UniversalOutlook + +> Applicable: Exchange Online + The UniversalOutlook switch filters the results by Mail and Calendar devices. 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 @@ -262,6 +284,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, Identity, or PrimarySmtpAddress parameters. @@ -270,7 +295,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, Identi Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXORecipient.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXORecipient.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-EXORecipient.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXORecipient.md index fd34b10f9d..b4f3f62b24 100644 --- a/exchange/exchange-ps/exchange/Get-EXORecipient.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXORecipient.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exorecipient applicable: Exchange Online -title: Get-EXORecipient -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exorecipient +schema: 2.0.0 +title: Get-EXORecipient --- # Get-EXORecipient @@ -76,6 +76,9 @@ This example returns the recipient attribute details for the user john@contoso.c ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the recipient object that you want to view. For the best performance, we recommend using the following values to identify the recipient: - User ID or user principal name (UPN) @@ -97,7 +100,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmt Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -107,6 +109,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -121,7 +126,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, Prima Type: String Parameter Sets: Anr Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -131,6 +135,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -139,7 +146,6 @@ You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or User Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -149,6 +155,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -164,7 +173,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,6 +182,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Online + The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. Soft-deleted recipients are deleted recipients that are still recoverable. @@ -182,7 +193,6 @@ Soft-deleted recipients are deleted recipients that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -192,6 +202,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -203,7 +216,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -213,6 +225,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the recipient that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or UserPrincipalName parameters. @@ -221,7 +236,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity o Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -231,6 +245,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Online + The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. For more information about the available properties, see [Get-EXORecipient property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets). @@ -239,7 +256,6 @@ For more information about the available properties, see [Get-EXORecipient prope Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -249,6 +265,9 @@ Accept wildcard characters: False ``` ### -PropertySets + +> Applicable: Exchange Online + The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are: - Minimum (this is the default value) @@ -263,7 +282,6 @@ For more information about the properties that are included in each property set Type: PropertySet[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -273,13 +291,15 @@ Accept wildcard characters: False ``` ### -RecipientPreviewFilter + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -289,6 +309,9 @@ Accept wildcard characters: False ``` ### -RecipientType + +> Applicable: Exchange Online + The RecipientType parameter filters the results by the specified recipient type. Valid values are: - DynamicDistributionGroup @@ -306,7 +329,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -316,6 +338,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Online + The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are: - DiscoveryMailbox @@ -349,13 +374,12 @@ The RecipientTypeDetails parameter filters the results by the specified recipien You can specify multiple values separated by commas. -The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You'll receive the error: None of the specified RecipientTypeDetails are included in any specified recipient type. +The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You get the error: None of the specified RecipientTypeDetails are included in any specified recipient type. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -365,13 +389,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + 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 @@ -381,6 +407,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the recipient that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -389,7 +418,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXORecipientPermission.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-EXORecipientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXORecipientPermission.md index 3ec37b7a9d..ec3795b475 100644 --- a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXORecipientPermission.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exorecipientpermission applicable: Exchange Online -title: Get-EXORecipientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exorecipientpermission +schema: 2.0.0 +title: Get-EXORecipientPermission --- # Get-EXORecipientPermission @@ -43,7 +43,7 @@ Get-EXORecipientPermission [[-Identity] ] ``` ## DESCRIPTION -This cmdlet is used to view/manage information about SendAs permissions that are configured for users in a cloud-based organization. Send As permission allows delegates to use the mailbox to send messages. After this permission is assigned to a delegate, any message that the delegate sends from the mailbox will appear to have been sent by the mailbox owner. However, this permission doesn't allow a delegate to sign in to the user's mailbox. It only allows users to open the mailbox. If this permission is assigned to a group, a message sent by the delegate will appear to have been sent by the group. +This cmdlet is used to view/manage information about SendAs permissions that are configured for users in a cloud-based organization. Send As permission allows delegates to use the mailbox to send messages. After this permission is assigned to a delegate, any message that the delegate sends from the mailbox appears to be sent by the mailbox owner. However, this permission doesn't allow a delegate to sign in to the user's mailbox. It only allows users to open the mailbox. If this permission is assigned to a group, a message sent by the delegate appears to be sent by the group. ## EXAMPLES @@ -56,6 +56,9 @@ Above example returns recipient permission for first 100 mailbox users in the na ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter identifies the recipient that you want to view. The user or group specified by the Trustee parameter has Send As permissions on this recipient. You can specify any type of recipient, for example: - Mailboxes @@ -85,7 +88,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddr Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -95,13 +97,15 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Online + The AccessRights parameter filters the results by permission. The only valid value for this parameter is SendAs. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -111,6 +115,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -119,7 +126,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -129,6 +135,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the recipient that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -137,7 +146,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -147,13 +155,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + 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 @@ -163,6 +173,9 @@ Accept wildcard characters: False ``` ### -Trustee + +> Applicable: Exchange Online + The Trustee parameter filters the results by the user or group who has Send As permissions. You can specify the following types of users or groups: - Mailbox users @@ -185,7 +198,6 @@ You need to use this parameter with the Identity, PrimarySmtpAddress, UserPrinci Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -195,6 +207,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the recipient that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -203,7 +218,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Pr Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-EcpVirtualDirectory.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EcpVirtualDirectory.md index 1235c14ba1..088a852375 100644 --- a/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EcpVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ecpvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EcpVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ecpvirtualdirectory +schema: 2.0.0 +title: Get-EcpVirtualDirectory --- # Get-EcpVirtualDirectory @@ -41,7 +42,7 @@ Get-EcpVirtualDirectory [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,6 +70,9 @@ This example returns a summary list of all Exchange Control Panel virtual direct ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the ECP virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -83,7 +87,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -106,7 +112,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -124,7 +132,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -160,7 +172,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EdgeSubscription.md b/exchange/exchange-ps/ExchangePowerShell/Get-EdgeSubscription.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-EdgeSubscription.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EdgeSubscription.md index 4e288d9293..33533e1544 100644 --- a/exchange/exchange-ps/exchange/Get-EdgeSubscription.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EdgeSubscription.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-edgesubscription -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EdgeSubscription -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-edgesubscription +schema: 2.0.0 +title: Get-EdgeSubscription --- # Get-EdgeSubscription @@ -29,7 +30,7 @@ Get-EdgeSubscription [[-Identity] ] ## DESCRIPTION Run the Get-EdgeSubscription cmdlet on an Exchange server in your organization. This cmdlet retrieves the list of Edge Subscriptions. Each Edge Transport server that's subscribed to the Exchange organization has a separate Edge Subscription. You can use this cmdlet to view the Edge Subscription information for a specific Edge Transport server. You can also use this cmdlet to view the Edge Subscription information for all Edge Transport servers subscribed to Active Directory sites. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example retrieves the Edge Subscription information for the Edge Transport ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the Edge Transport server for which you want to retrieve Edge Subscription information. The identity is expressed as the host name of the Edge Transport server. If no identity is specified, all Edge Subscriptions are returned. ```yaml Type: TransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -74,7 +80,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-EdgeSyncServiceConfig.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EdgeSyncServiceConfig.md index fa33987f4c..a9aa2ccf24 100644 --- a/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EdgeSyncServiceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-edgesyncserviceconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EdgeSyncServiceConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-edgesyncserviceconfig +schema: 2.0.0 +title: Get-EdgeSyncServiceConfig --- # Get-EdgeSyncServiceConfig @@ -28,7 +29,7 @@ Get-EdgeSyncServiceConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,13 +43,15 @@ This example reads the configuration of the Microsoft Exchange EdgeSync service ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the Microsoft Exchange EdgeSync service configuration you want to view. ```yaml Type: EdgeSyncServiceConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -58,13 +61,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -74,13 +79,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Site parameter specifies the Active Directory site that EdgeSync connects to for synchronizing configuration and recipient data. ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md b/exchange/exchange-ps/ExchangePowerShell/Get-EligibleDistributionGroupForMigration.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EligibleDistributionGroupForMigration.md index fe9c386e7f..37f3f6bc74 100644 --- a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EligibleDistributionGroupForMigration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-eligibledistributiongroupformigration -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-EligibleDistributionGroupForMigration -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-eligibledistributiongroupformigration +schema: 2.0.0 +title: Get-EligibleDistributionGroupForMigration --- # Get-EligibleDistributionGroupForMigration @@ -37,7 +38,7 @@ Get-EligibleDistributionGroupForMigration [-ManagedBy Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter filters the results by the email address of the specified distribution group. If no results are returned for the specified email address, the group can't be upgraded to a Microsoft 365 Group. You can't use this parameter with the ManagedBy parameter. @@ -59,7 +63,6 @@ You can't use this parameter with the ManagedBy parameter. Type: DistributionGroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ManagedBy parameter filters the results by the manager of the distribution group (the ManagedBy property). You can use any value that uniquely identifies the distribution group manager. For example: - Name @@ -84,7 +90,6 @@ You can't use this parameter with the Identity parameter. Type: GeneralRecipientIdParameter Parameter Sets: ManagedBy Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -105,7 +113,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-EmailAddressPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EmailAddressPolicy.md index 1cb8b5a7a3..e9219c252c 100644 --- a/exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EmailAddressPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-emailaddresspolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-EmailAddressPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-emailaddresspolicy +schema: 2.0.0 +title: Get-EmailAddressPolicy --- # Get-EmailAddressPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-EmailAddressPolicy cmdlet to view email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups. @@ -28,7 +29,7 @@ Get-EmailAddressPolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example returns detailed information for the email address policy named Con ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the email address policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the email address policy that you want to view. Type: EmailAddressPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -77,7 +83,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -IncludeMailboxSettingOnlyPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The IncludeMailboxSettingOnlyPolicy switch retrieves Microsoft Exchange Server 2003 address policies that contain only mailbox management configuration. You don't need to specify a value with this switch. @@ -99,7 +107,6 @@ The attributes of address policies that contain only mailbox management configur Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-EmailTenantSettings.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-EmailTenantSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EmailTenantSettings.md index 025fdca73a..f8e70e2a35 100644 --- a/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EmailTenantSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-emailtenantsettings applicable: Exchange Online -title: Get-EmailTenantSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-emailtenantsettings +schema: 2.0.0 +title: Get-EmailTenantSettings --- # Get-EmailTenantSettings @@ -25,7 +26,7 @@ Get-EmailTenantSettings [[-Identity] ] [ Applicable: Exchange Online + The Identity parameter specifies the settings object that you want to view. The only settings object in the organization is named Default. ```yaml Type: EmailTenantSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-EtrLimits.md b/exchange/exchange-ps/ExchangePowerShell/Get-EtrLimits.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-EtrLimits.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EtrLimits.md index 759a8d045c..9e785a6cc9 100644 --- a/exchange/exchange-ps/exchange/Get-EtrLimits.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EtrLimits.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-etrlimits applicable: Exchange Online, Exchange Online Protection -title: Get-EtrLimits -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-etrlimits +schema: 2.0.0 +title: Get-EtrLimits --- # Get-EtrLimits @@ -25,7 +26,7 @@ Get-EtrLimits [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions 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-EventLogLevel.md b/exchange/exchange-ps/ExchangePowerShell/Get-EventLogLevel.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-EventLogLevel.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EventLogLevel.md index cc925f4f3d..02209e4607 100644 --- a/exchange/exchange-ps/exchange/Get-EventLogLevel.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EventLogLevel.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-eventloglevel -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EventLogLevel -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-eventloglevel +schema: 2.0.0 +title: Get-EventLogLevel --- # Get-EventLogLevel @@ -35,7 +36,7 @@ Get-EventLogLevel [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example displays the event categories and log levels for the server Exchang ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter filters the results by the name of the event category. To see the available event categories, run the following command: Get-EventLogLevel. You can't use this parameter with the Server parameter. @@ -57,7 +61,6 @@ You can't use this parameter with the Server parameter. Type: ECIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -80,7 +86,6 @@ You can't use this parameter with the Identity parameter. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -98,7 +106,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-EventsFromEmailConfiguration.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EventsFromEmailConfiguration.md index 30df67b8a5..52e03a6dbd 100644 --- a/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EventsFromEmailConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-eventsfromemailconfiguration applicable: Exchange Online -title: Get-EventsFromEmailConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-eventsfromemailconfiguration +schema: 2.0.0 +title: Get-EventsFromEmailConfiguration --- # Get-EventsFromEmailConfiguration @@ -28,7 +29,7 @@ Get-EventsFromEmailConfiguration [-Identity] ## DESCRIPTION **Note**: The following output properties have been deprecated: EventReservationProcessingLevel, FoodEstablishmentReservationProcessingLevel, InvoiceProcessingLevel, and ServiceReservationProcessingLevel. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,13 +43,15 @@ This example retrieves all events from email settings for peter@contoso.com's ma ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox that you want to view. You identify the mailbox by email address. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeAssistanceConfig.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeAssistanceConfig.md index d2853de47a..a8a7a89513 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeAssistanceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeassistanceconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeAssistanceConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangeassistanceconfig +schema: 2.0.0 +title: Get-ExchangeAssistanceConfig --- # Get-ExchangeAssistanceConfig @@ -27,7 +28,7 @@ Get-ExchangeAssistanceConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,13 +49,15 @@ This example shows the configuration information for all organizations and forma ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the organization. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -72,7 +78,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeCertificate.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeCertificate.md index eec9e123ff..1e8ea547d3 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangecertificate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeCertificate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangecertificate +schema: 2.0.0 +title: Get-ExchangeCertificate --- # Get-ExchangeCertificate @@ -50,7 +51,7 @@ Get-ExchangeCertificate [[-Thumbprint] ] By default, this cmdlet returns the following certificate properties in the summary list view: - Thumbprint: The unique digest of the certificate data. An example thumbprint value is 78E1BE82F683EE6D8CB9B9266FC1185AE0890C41. -- Services: The Exchange services that the certificate is assigned to by using the Enable-ExchangeCertificate cmdlet. Values are None, Federation, IIS, IMAP, POP, SMTP, UM, and UMCallRouter. You'll see the value None in certificates that aren't used with Exchange (for example, the `WMSvc-` certificate that's used for the IIS Web Management Service). +- Services: The Exchange services that the certificate is assigned to by using the Enable-ExchangeCertificate cmdlet. Values are None, Federation, IIS, IMAP, POP, SMTP, UM, and UMCallRouter. You see the value None in certificates that aren't used with Exchange (for example, the `WMSvc-` certificate that's used for the IIS Web Management Service). - Subject: Contains the X.500 value in the certificate's Subject Name field. The important part is the CN= value. If you append ` | Format-List` to the command, the cmdlet returns these additional certificate properties: @@ -91,7 +92,7 @@ If you append ` | Format-List *` to the command, the cmdlet returns these additi - SubjectName: Typically, this value is System.Security.Cryptography.X509Certificates.X500DistinguishedName. - Version: Typically, this value is 3. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -121,11 +122,14 @@ This example returns all available information for the specified certificate. Get-ExchangeCertificate -DomainName mail.contoso.com ``` -This example shows which certificate Exchange will select for the domain name mail.contoso.com. A Send connector or Receive connector selects the certificate to use based on the fully qualified domain name (FQDN) of the connector. If you have multiple certificates with the same FQDN, you can see which certificate Exchange will select by using the DomainName parameter to specify the FQDN. The first certificate returned is the certificate that Exchange will select. +This example shows which certificate Exchange selects for the domain name mail.contoso.com. A Send connector or Receive connector selects the certificate to use based on the fully qualified domain name (FQDN) of the connector. If you have multiple certificates with the same FQDN, you can see which certificate Exchange selects by using the DomainName parameter to specify the FQDN. The first certificate returned is the certificate that Exchange selects. ## PARAMETERS ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Thumbprint parameter specifies the thumbprint value of the certificate that you want to view. The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. @@ -134,7 +138,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: String Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -144,6 +147,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the certificate that you want to view. Valid values are: - `ServerNameOrFQDN\Thumbprint` @@ -157,7 +163,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: ExchangeCertificateIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -167,6 +172,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -175,7 +183,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,13 +192,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainName parameter filters the results by the fully qualified domain name (FQDN) or server name values in the Subject Name or the Subject Alternative Name fields. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,13 +210,15 @@ Accept wildcard characters: False ``` ### -Instance -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: X509Certificate2 Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,6 +228,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -232,7 +246,6 @@ You can't use this parameter with the Identity parameter, but you can use it wit Type: ServerIdParameter Parameter Sets: Instance, Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeDiagnosticInfo.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeDiagnosticInfo.md index ca36c14478..70cd83db86 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeDiagnosticInfo.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangediagnosticinfo -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeDiagnosticInfo -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.Management-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangediagnosticinfo +schema: 2.0.0 +title: Get-ExchangeDiagnosticInfo --- # Get-ExchangeDiagnosticInfo @@ -30,7 +31,7 @@ Get-ExchangeDiagnosticInfo [-Argument ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example display the XML output of the command in format that's easier to re ## PARAMETERS ### -Argument + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Argument parameter specifies a valid argument to use with the specified Component value. Common Argument values that you can use with virtually Component value are Help and Verbose. @@ -63,7 +67,6 @@ To see the Argument values that are available for a given Component value, run t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Component + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Component parameter returns detailed information for the specified Component of the given Process value. To see the Component values that are available for a given Process value, run the command `Get-ExchangeDiagnosticInfo -Process ProcessName -Argument Help`. @@ -81,7 +87,6 @@ To see the Component values that are available for a given Process value, run th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Process + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Process parameter provides details for the specified Exchange process. Valid values are the name of the process (for example, MSExchangeTransport or Microsoft.Exchange.Directory.TopologyService). To see the list of available Exchange processes, run the command Get-ExchangeDiagnosticInfo. @@ -99,7 +107,6 @@ To see the list of available Exchange processes, run the command Get-ExchangeDia Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -122,7 +132,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -Unlimited + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Unlimited switch tells the command to return all available information. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeFeature.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeFeature.md new file mode 100644 index 0000000000..81225184cb --- /dev/null +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeFeature.md @@ -0,0 +1,142 @@ +--- +applicable: Exchange Server 2019, Exchange Server SE +author: lusassl-msft +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +ms.author: lusassl +ms.reviewer: srvar +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangefeature +schema: 2.0.0 +title: Get-ExchangeFeature +--- + +# 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 article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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 + +> Applicable: Exchange Server 2019, Exchange Server SE + +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: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -FeatureID + +> Applicable: Exchange Server 2019, Exchange Server SE + +The FeatureID parameter specifies the feature you want to query information about. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RingLevel + +> Applicable: Exchange Server 2019, Exchange Server SE + +The RingLevel parameter specifies the ring level you want to query information about. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status + +> Applicable: Exchange Server 2019, Exchange Server SE + +The Status parameter specifies the status you want to query information about. + +```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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServer.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-ExchangeServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServer.md index 4331ccbb63..f9f4549937 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeserver -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeServer -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangeserver +schema: 2.0.0 +title: Get-ExchangeServer --- # Get-ExchangeServer @@ -41,7 +42,7 @@ Get-ExchangeServer [[-Identity] ] ## DESCRIPTION The ExchangeVersion attribute returned is the minimum version of Microsoft Exchange that you can use to manage the returned object. This attribute isn't the same as the version of Exchange displayed in the Exchange admin center when you select Server Configuration. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example returns detailed information about the Exchange server named Mailbo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Exchange server that you want to view. You can use any value that uniquely identifies the Exchange server. For example: - Name @@ -75,7 +79,6 @@ You can't use this parameter with the Domain parameter. Type: ServerIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Domain parameter filters the results by the fully qualified domain name (FQDN) of the domain (for example, contoso.com). You can't use this parameter with the Identity parameter. @@ -93,7 +99,6 @@ You can't use this parameter with the Identity parameter. Type: Fqdn Parameter Sets: Domain Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -111,7 +119,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Status switch specifies whether to include additional property values in the results, for example, the Watson state, StaticDomainControllers, and runtime domain controller usage. You don't need to specify a value with this switch. To see the additional values, you need to pipe the output to a formatting cmdlet, for example, the Format-List cmdlet. @@ -129,7 +139,6 @@ To see the additional values, you need to pipe the output to a formatting cmdlet Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicense.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicense.md index 4d95f68bfd..10296db440 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicense.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeserveraccesslicense -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeServerAccessLicense -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangeserveraccesslicense +schema: 2.0.0 +title: Get-ExchangeServerAccessLicense --- # Get-ExchangeServerAccessLicense @@ -32,7 +33,7 @@ The Get-ExchangeServerAccessLicense cmdlet returns a collection of these license - Exchange Server Standard Edition - Exchange Server Enterprise Edition -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicenseUser.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicenseUser.md index 4c62c163e4..13f0438929 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicenseUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeserveraccesslicenseuser -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeServerAccessLicenseUser -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangeserveraccesslicenseuser +schema: 2.0.0 +title: Get-ExchangeServerAccessLicenseUser --- # Get-ExchangeServerAccessLicenseUser @@ -28,7 +29,7 @@ Get-ExchangeServerAccessLicenseUser -LicenseName ## DESCRIPTION The Get-ExchangeServerAccessLicenseUser cmdlet returns a collection of unique users for the specified license name. The list of unique users represents an estimate of your licenses when you run this cmdlet. Each object contains the FQDN or primary SMTP address of the mailbox and the license name to which it's associated. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example returns the unique users for the license named Exchange Server 2016 ## PARAMETERS ### -LicenseName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LicenseName parameter specifies the license type that you want to view. You can find the available license type values by running the Get-ExchangeServerAccessLicense cmdlet. Valid values are: - `Exchange Server Standard CAL` @@ -55,7 +59,6 @@ The `` value is 2013, 2016, or 2019. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExchangeSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeSettings.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-ExchangeSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeSettings.md index 9088353301..b61081fd3d 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangesettings -applicable: Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeSettings -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangesettings +schema: 2.0.0 +title: Get-ExchangeSettings --- # Get-ExchangeSettings @@ -39,7 +40,7 @@ Get-ExchangeSettings [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +61,9 @@ This example returns a summary list of all Exchange setting objects. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the Exchange setting object. You can use any value that uniquely identifies the object. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the name of the Exchange setting object. You ca Type: ExchangeSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -ConfigName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigName parameter filter the results by the specified property name. The value you specify is visible in the EffectiveSetting property. The available values are determined by the schema of the Exchange setting object. @@ -88,7 +94,6 @@ The available values are determined by the schema of the Exchange setting object Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Database parameter filters the results by mailbox database. You can use any value that uniquely identifies the database. For example: - Name @@ -109,7 +117,6 @@ The Database parameter filters the results by mailbox database. You can use any Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. The detailed information is visible in the DiagnosticInfo property. @@ -129,7 +139,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,13 +148,15 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -179,7 +195,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,13 +204,15 @@ Accept wildcard characters: False ``` ### -GenericScopeName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GenericScopeName parameter filters the results by the scope. The available values are determined by the schema of the Exchange setting object. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -205,13 +222,15 @@ Accept wildcard characters: False ``` ### -GenericScopes + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GenericScopes parameter filters the results by the scope. The available values are determined by the schema of the Exchange setting object. This parameter uses the syntax `"key1=value1","key2=value2", "keyN=valueN`. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -221,13 +240,15 @@ Accept wildcard characters: False ``` ### -GenericScopeValue + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GenericScopeValue parameter filters the results by the value of the scope specified by the GenericScopeName parameter. The available values are determined by the schema of the Exchange setting object. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,13 +258,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,13 +276,15 @@ Accept wildcard characters: False ``` ### -Process + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Process parameter filters the results by the specified process. The available values are determined by the schema of the Exchange setting object. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -269,6 +294,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter filters the results by Exchange server. You can use any value that uniquely identifies the server. For example: - Name @@ -280,7 +308,6 @@ The Server parameter filters the results by Exchange server. You can use any val Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -290,13 +317,15 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The User parameter filters the results by user. You identify the user by their GUID value (for example, 87246450-1b19-4c81-93dc-1a4200eff66c). To find the GUID for a user, run the following command: `Get-User | Format-List Name,GUID`. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierPolicy.md index 08f6210738..39d0c63f23 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierpolicy applicable: Exchange Online -title: Get-ExoInformationBarrierPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exoinformationbarrierpolicy +schema: 2.0.0 +title: Get-ExoInformationBarrierPolicy --- # Get-ExoInformationBarrierPolicy @@ -25,7 +26,7 @@ Get-ExoInformationBarrierPolicy [[-Identity] ] [-ShowF ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example shows detailed information for the specified Exchange Online inform ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Exchange Online information barrier policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the Exchange Online information barrier policy Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -ShowFriendlyValues + +> Applicable: Exchange Online + The ShowFriendlyValues switch specifies whether to show friendly values in the output of the command. You don't need to specify a value with this switch. When you use this switch, the following property values are shown: @@ -78,7 +84,6 @@ When you use this switch, the following property values are shown: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierRelationship.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierRelationship.md index 8e1ddb9d25..1adfb6db00 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierRelationship.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierrelationship applicable: Exchange Online -title: Get-ExoInformationBarrierRelationship -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exoinformationbarrierrelationship +schema: 2.0.0 +title: Get-ExoInformationBarrierRelationship --- # Get-ExoInformationBarrierRelationship @@ -26,7 +27,7 @@ Get-ExoInformationBarrierRelationship -RecipientId1 -Reci ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,6 +41,9 @@ This example shows the Exchange Online information barrier relationship between ## PARAMETERS ### -RecipientId1 + +> Applicable: Exchange Online + The RecipientId1 parameter specifies the first recipient in the Exchange Online barrier relationship. You can use any value that uniquely identifies the recipient. For example: - Name @@ -53,7 +57,6 @@ The RecipientId1 parameter specifies the first recipient in the Exchange Online Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -RecipientId2 + +> Applicable: Exchange Online + The RecipientId2 parameter specifies the second recipient in the Exchange Online barrier relationship. You can use any value that uniquely identifies the recipient. For example: - Name @@ -76,7 +82,6 @@ The RecipientId2 parameter specifies the second recipient in the Exchange Online Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierSegment.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierSegment.md index b0caf1efcb..4abb7a13a8 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierSegment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarriersegment applicable: Exchange Online -title: Get-ExoInformationBarrierSegment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exoinformationbarriersegment +schema: 2.0.0 +title: Get-ExoInformationBarrierSegment --- # Get-ExoInformationBarrierSegment @@ -25,7 +26,7 @@ Get-ExoInformationBarrierSegment [[-Identity] Applicable: Exchange Online + The Identity parameter specifies the Exchange Online information barrier segment that you want to view. You can use any value that uniquely identifies the segment. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the Exchange Online information barrier segment Type: InformationBarrierSegmentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -ShowFriendlyValues + +> Applicable: Exchange Online + The ShowFriendlyValues switch specifies whether to show friendly values in the output of the command. You don't need to specify a value with this switch. When you use this switch, the FriendlyMembershipFilter property value is shown. @@ -75,7 +81,6 @@ When you use this switch, the FriendlyMembershipFilter property value is shown. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExoPhishSimOverrideRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExoPhishSimOverrideRule.md index 0baced66e2..bd2639d1b8 100644 --- a/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExoPhishSimOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exophishsimoverriderule applicable: Exchange Online -title: Get-ExoPhishSimOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exophishsimoverriderule +schema: 2.0.0 +title: Get-ExoPhishSimOverrideRule --- # Get-ExoPhishSimOverrideRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-ExoPhishSimOverrideRule cmdlet to view third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +Use the Get-ExoPhishSimOverrideRule cmdlet to view non-Microsoft phishing simulation override rules that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -30,7 +31,7 @@ Get-ExoPhishSimOverrideRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ Although the previous command should return only one rule, a rule that's pending ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ The name of the rule uses the following syntax: `_Exe:PhishSimOverr:` \[s Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Exchange Online + The Policy parameter filters the results by phishing simulator override policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -119,7 +129,6 @@ The Policy parameter filters the results by phishing simulator override policy. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExoSecOpsOverrideRule.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExoSecOpsOverrideRule.md index 4f8ca933c6..958273ae8c 100644 --- a/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExoSecOpsOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exosecopsoverriderule applicable: Exchange Online -title: Get-ExoSecOpsOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exosecopsoverriderule +schema: 2.0.0 +title: Get-ExoSecOpsOverrideRule --- # Get-ExoSecOpsOverrideRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-ExoSecOpsOverrideRule cmdlet to view SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +Use the Get-ExoSecOpsOverrideRule cmdlet to view SecOps mailbox override rules that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -30,7 +31,7 @@ Get-ExoSecOpsOverrideRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ Although the previous command should return only one rule, a rule that's pending ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ The name of the rule uses the following syntax: `_Exe:SecOpsOverrid:` \[s Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Exchange Online + The Policy parameter filters the results by SecOps mailbox override policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -119,7 +129,6 @@ The Policy parameter filters the results by SecOps mailbox override policy. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExternalInOutlook.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ExternalInOutlook.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExternalInOutlook.md index 451de0b213..4a833e7025 100644 --- a/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExternalInOutlook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-externalinoutlook applicable: Exchange Online, Exchange Online Protection -title: Get-ExternalInOutlook -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-externalinoutlook +schema: 2.0.0 +title: Get-ExternalInOutlook --- # Get-ExternalInOutlook @@ -30,7 +31,7 @@ The important properties that are returned in the output of this cmdlet are: - Enabled: True means the feature is enabled; False means the feature is disabled. - AllowList: The list of exceptions. Messages received from the specified senders or senders in the specified domains don't receive the External icon in the area of subject line. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example returns the settings of the external sender identification feature ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID of the external sender identification object that you want to view. Although this parameter is available, you don't need to use it. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md b/exchange/exchange-ps/ExchangePowerShell/Get-FailedContentIndexDocuments.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FailedContentIndexDocuments.md index 14df25198f..066bbf3c00 100644 --- a/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FailedContentIndexDocuments.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-failedcontentindexdocuments -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-FailedContentIndexDocuments -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-failedcontentindexdocuments +schema: 2.0.0 +title: Get-FailedContentIndexDocuments --- # Get-FailedContentIndexDocuments @@ -70,7 +71,7 @@ After a new filter is installed, only new messages with attachments of the type The cmdlet output provides details about items in a mailbox that couldn't be indexed, including an error code and the reason for failure. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -91,6 +92,9 @@ This example retrieves a list of items that couldn't be indexed by Exchange Sear ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -108,7 +112,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -MailboxDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDatabase parameter specifies the database from which to get the mailbox. You can use any value that uniquely identifies the database. For example: - Name @@ -128,7 +134,6 @@ The MailboxDatabase parameter specifies the database from which to get the mailb Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies a Mailbox server. You can use the following values: - Name @@ -148,7 +156,6 @@ The Server parameter specifies a Mailbox server. You can use the following value Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -158,6 +165,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -167,7 +177,6 @@ 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 Required: False Position: Named @@ -177,13 +186,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +204,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Archive switch restricts the scope of the cmdlet to the user's archive. You don't need to specify a value with this switch. When using the Archive switch, you must also specify the Identity parameter. @@ -201,7 +215,6 @@ When using the Archive switch, you must also specify the Identity parameter. Type: SwitchParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -211,6 +224,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -219,7 +235,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -229,13 +244,15 @@ Accept wildcard characters: False ``` ### -ErrorCode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ErrorCode parameter allows you to retrieve documents that failed indexing with a specific error code. You can use the cmdlet without this parameter to list all failed documents for a mailbox, a mailbox database or a Mailbox server. The output includes the error codes and reason for failure. If required, you can then restrict the output to a specific error code from the results. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -245,6 +262,9 @@ Accept wildcard characters: False ``` ### -FailureMode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FailureMode parameter specifies the type of error. Use the following values. - Transient: Returns items that couldn't be indexed due to transient errors. Exchange Search attempts to index these items again. @@ -255,7 +275,6 @@ The FailureMode parameter specifies the type of error. Use the following values. Type: FailureMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -265,13 +284,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -281,6 +302,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -289,7 +313,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -299,13 +322,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActivityAlert.md b/exchange/exchange-ps/ExchangePowerShell/Get-FeatureConfiguration.md similarity index 50% rename from exchange/exchange-ps/exchange/Remove-ActivityAlert.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FeatureConfiguration.md index b2fb529c09..ae9ba0feae 100644 --- a/exchange/exchange-ps/exchange/Remove-ActivityAlert.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FeatureConfiguration.md @@ -1,51 +1,63 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activityalert applicable: Security & Compliance -title: Remove-ActivityAlert +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-featureconfiguration schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: +title: Get-FeatureConfiguration --- -# 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/defender-office-365/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: + +> Applicable: Security & Compliance + +The Identity policy specifies the feature configuration that you want to view. You can use any value that uniquely identifies the configuration. For example: - Name - Distinguished name (DN) @@ -55,42 +67,44 @@ The Identity parameter specifies the activity alert that you want to remove. You Type: PolicyIdParameter 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. +### -FeatureScenario + +> Applicable: Security & Compliance -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +The 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 -Applicable: Security & Compliance +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ForceDeletion +### -Confirm + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance +Aliases: cf Required: False Position: Named @@ -100,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance PowerShell. + +> Applicable: Security & Compliance + +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md b/exchange/exchange-ps/ExchangePowerShell/Get-FederatedDomainProof.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-FederatedDomainProof.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FederatedDomainProof.md index 498c943b79..42a8bff194 100644 --- a/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FederatedDomainProof.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-federateddomainproof -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-FederatedDomainProof -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-federateddomainproof +schema: 2.0.0 +title: Get-FederatedDomainProof --- # Get-FederatedDomainProof @@ -30,7 +31,7 @@ Get-FederatedDomainProof -DomainName ## DESCRIPTION The Get-FederatedDomainProof cmdlet generates a cryptographically secure string for the domain used for federated sharing. The resulting string is used to manually configure a text (TXT) record in the Domain Name System (DNS) zone for the domain used by the administrator when running the cmdlet. A TXT record needs to be added to DNS for all accepted domains used for federated sharing. If the thumbprint of a certificate isn't provided, the task generates strings for all the certificates currently configured for the federation trust. Upon initial configuration of federated sharing, the proof string generated for the current certificate needs to be put into the TXT record for the federated domain in DNS. We recommend you update the TXT records whenever a new certificate is configured for the federation trust. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,13 +52,15 @@ This example uses a specific certificate for the domain contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainName parameter specifies the domain name for which the cryptographically secure string is generated. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Thumbprint parameter specifies the thumbprint of an existing certificate. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md b/exchange/exchange-ps/ExchangePowerShell/Get-FederatedOrganizationIdentifier.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FederatedOrganizationIdentifier.md index 141f7f644a..0e704f6ca6 100644 --- a/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FederatedOrganizationIdentifier.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-federatedorganizationidentifier -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-FederatedOrganizationIdentifier -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-federatedorganizationidentifier +schema: 2.0.0 +title: Get-FederatedOrganizationIdentifier --- # Get-FederatedOrganizationIdentifier ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-FederatedOrganizationIdentifier cmdlet to retrieve the Exchange organization's federated organization identifier and related details, such as federated domains, organization contact and status. @@ -30,7 +31,7 @@ Get-FederatedOrganizationIdentifier [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,13 +52,15 @@ This example retrieves the Exchange organization's federated organization identi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the organization ID. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -75,7 +81,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -IncludeExtendedDomainInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The IncludeExtendedDomainInfo switch specifies that the command query Microsoft Federation Gateway for the status of each accepted domain that's federated. You don't need to specify a value with this switch. The status is returned with each domain in the Domains property. @@ -93,7 +101,6 @@ The status is returned with each domain in the Domains property. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FederationInformation.md b/exchange/exchange-ps/ExchangePowerShell/Get-FederationInformation.md similarity index 69% rename from exchange/exchange-ps/exchange/Get-FederationInformation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FederationInformation.md index 53be62c5c2..d899966f96 100644 --- a/exchange/exchange-ps/exchange/Get-FederationInformation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FederationInformation.md @@ -1,20 +1,24 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-federationinformation -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-FederationInformation -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-federationinformation +schema: 2.0.0 +title: Get-FederationInformation --- # Get-FederationInformation ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Get-FederationInformation cmdlet to get federation information, including federated domain names and target URLs, from an external Exchange organization. +Use the Get-FederationInformation cmdlet to get federation information from an external Exchange organization. + +> [!TIP] +> For information about changes made to the Get-FederationInformation cmdlet to improve security and privacy, see [Important Update to the Get-FederationInformation Cmdlet in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/important-update-to-the-get-federationinformation-cmdlet-in-exchange-online/4410095). 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,11 +33,9 @@ Get-FederationInformation -DomainName ``` ## DESCRIPTION -The Get-FederationInformation cmdlet retrieves federation information from the domain specified. Results from the cmdlet can be piped to the New-OrganizationRelationship cmdlet to establish an organization relationship with the Exchange organization being queried. - -The domain specified should have federation enabled. +The Get-FederationInformation cmdlet retrieves federation information from the specified domain, which should have federation enabled. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +49,15 @@ This example gets federation information from the domain contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DomainName parameter specifies the domain name for which federation information is to be retrieved. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -63,6 +67,9 @@ Accept wildcard characters: False ``` ### -BypassAdditionalDomainValidation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassAdditionalDomainValidation switch specifies that the command skip validation of domains from the external Exchange organization. You don't need to specify a value with this switch. We recommend that you only use this switch to retrieve federation information in a hybrid deployment between on-premises and Exchange Online organizations. Don't use this switch to retrieve federation information for on-premises Exchange organizations in a cross-organization arrangement. @@ -71,7 +78,6 @@ We recommend that you only use this switch to retrieve federation information in Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,6 +87,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the host name in the Autodiscover endpoint of the domain doesn't match the Secure Sockets Layer (SSL) certificate presented by the endpoint and the host name isn't specified in the TrustedHostnames parameter. @@ -89,7 +98,6 @@ A confirmation prompt warns you if the host name in the Autodiscover endpoint of Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -99,13 +107,15 @@ Accept wildcard characters: False ``` ### -TrustedHostnames + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TrustedHostnames parameter specifies the fully qualified domain name (FQDN) of federation endpoints. Federation endpoints are the client access (frontend) services on Mailbox servers in an organization with federation enabled. Explicitly specifying the TrustedHostnames parameter allows the cmdlet to bypass prompting if the certificate presented by the endpoint doesn't match the domain name specified in the DomainName parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FederationTrust.md b/exchange/exchange-ps/ExchangePowerShell/Get-FederationTrust.md similarity index 74% rename from exchange/exchange-ps/exchange/Get-FederationTrust.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FederationTrust.md index 98175c1a29..7d1bbbde17 100644 --- a/exchange/exchange-ps/exchange/Get-FederationTrust.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FederationTrust.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-federationtrust -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-FederationTrust -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-federationtrust +schema: 2.0.0 +title: Get-FederationTrust --- # Get-FederationTrust ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-FederationTrust cmdlet to view the federation trust configured for the Exchange organization. @@ -27,7 +28,7 @@ Get-FederationTrust [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example retrieves properties of the federation trust configured for the Exc ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies a federation trust ID. If not specified, the cmdlet returns all federation trusts configured for the Exchange organization. ```yaml Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -65,7 +71,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyAuthority.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyAuthority.md index 023b70021a..057baf0d1d 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyAuthority.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertyauthority applicable: Security & Compliance -title: Get-FilePlanPropertyAuthority +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertyauthority schema: 2.0.0 +title: Get-FilePlanPropertyAuthority --- # Get-FilePlanPropertyAuthority @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property au ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property authority that you want to view. You can use any value that uniquely identifies the authority. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property authority that yo Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCategory.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCategory.md index c7b0bab4ef..f3a73dbc1b 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertycategory applicable: Security & Compliance -title: Get-FilePlanPropertyCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +https: //learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertycategory +Locale: en-US +Module Name: ExchangePowerShell schema: 2.0.0 +title: Get-FilePlanPropertyCategory --- # Get-FilePlanPropertyCategory @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property ca ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property category that you want to view. You can use any value that uniquely identifies the category. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property category that you Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCitation.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCitation.md index 9080e6137a..ade6daa96e 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCitation.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertycitation applicable: Security & Compliance -title: Get-FilePlanPropertyCitation +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertycitation schema: 2.0.0 +title: Get-FilePlanPropertyCitation --- # Get-FilePlanPropertyCitation @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property ci ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property citation that you want to view. You can use any value that uniquely identifies the citation. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property citation that you Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyDepartment.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyDepartment.md index 58fc2c7f5e..2a66acd2ef 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyDepartment.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertydepartment applicable: Security & Compliance -title: Get-FilePlanPropertyDepartment +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertydepartment schema: 2.0.0 +title: Get-FilePlanPropertyDepartment --- # Get-FilePlanPropertyDepartment @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property de ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property department that you want to view. You can use any value that uniquely identifies the department. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property department that y Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyReferenceId.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyReferenceId.md index c1ec2f310a..b3fa5d4ebb 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyReferenceId.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertyreferenceid applicable: Security & Compliance -title: Get-FilePlanPropertyReferenceId +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertyreferenceid schema: 2.0.0 +title: Get-FilePlanPropertyReferenceId --- # Get-FilePlanPropertyReferenceId @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property re ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property reference ID that you want to view. You can use any value that uniquely identifies the reference ID. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property reference ID that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyStructure.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyStructure.md index f2e64f89a2..5c212bdc85 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyStructure.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertystructure applicable: Security & Compliance -title: Get-FilePlanPropertyStructure +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertystructure schema: 2.0.0 +title: Get-FilePlanPropertyStructure --- # Get-FilePlanPropertyStructure @@ -36,13 +38,15 @@ This example returns the file plan property structure. ## PARAMETERS ### -IncludeAdditionalInfo + +> Applicable: Security & Compliance + The IncludeAdditionalInfo switch specifies whether to include additional information in the output of the cmdlet. 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 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertySubCategory.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertySubCategory.md index ed2bc3113e..04407cdf4d 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertySubCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertysubcategory applicable: Security & Compliance -title: Get-FilePlanPropertySubCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertysubcategory schema: 2.0.0 +title: Get-FilePlanPropertySubCategory --- # Get-FilePlanPropertySubCategory @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property su ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property subcategory that you want to view. You can use any value that uniquely identifies the subcategory. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property subcategory that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FocusedInbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-FocusedInbox.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-FocusedInbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FocusedInbox.md index c7b5967c67..bf5e31049a 100644 --- a/exchange/exchange-ps/exchange/Get-FocusedInbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FocusedInbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-focusedinbox applicable: Exchange Online, Exchange Online Protection -title: Get-FocusedInbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-focusedinbox +schema: 2.0.0 +title: Get-FocusedInbox --- # Get-FocusedInbox @@ -29,7 +30,7 @@ Get-FocusedInbox -Identity ## DESCRIPTION Focused Inbox is a replacement for Clutter that separates the Inbox into the Focused and Other tabs in Outlook on the web and newer versions of Outlook. Important emails are on the Focused tab while the rest are on the Other tab. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example returns the Focused Inbox configuration for the mailbox of julia@co ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill UseCustomRouting Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ForeignConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-ForeignConnector.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ForeignConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ForeignConnector.md index 1d19d0d26f..807457d46f 100644 --- a/exchange/exchange-ps/exchange/Get-ForeignConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ForeignConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-foreignconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ForeignConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-foreignconnector +schema: 2.0.0 +title: Get-ForeignConnector --- # Get-ForeignConnector @@ -27,7 +28,7 @@ Get-ForeignConnector [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example displays detailed configuration information for the Foreign connect ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Foreign connector that you want to examine. The Identity parameter can take any of the following values for the Foreign connector object: - GUID @@ -58,7 +62,6 @@ The Identity parameter specifies the Foreign connector that you want to examine. Type: ForeignConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -76,7 +82,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FrontendTransportService.md b/exchange/exchange-ps/ExchangePowerShell/Get-FrontendTransportService.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-FrontendTransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FrontendTransportService.md index e768cd1838..61cce09aa7 100644 --- a/exchange/exchange-ps/exchange/Get-FrontendTransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FrontendTransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-frontendtransportservice -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-FrontendTransportService -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-frontendtransportservice +schema: 2.0.0 +title: Get-FrontendTransportService --- # Get-FrontendTransportService @@ -29,7 +30,7 @@ Get-FrontendTransportService [[-Identity] ] ## DESCRIPTION The Front End Transport service acts as a stateless proxy for all inbound and outbound external SMTP traffic for the Exchange organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example retrieves the detailed configuration information for the Front End ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Exchange server with the Client Access server role installed that you want to view. You can use any value that uniquely identifies the server. For example: @@ -63,7 +67,6 @@ You can use any value that uniquely identifies the server. For example: Type: FrontendTransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-GlobalAddressList.md b/exchange/exchange-ps/ExchangePowerShell/Get-GlobalAddressList.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-GlobalAddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Get-GlobalAddressList.md index 0a3a6daa60..bc4c1f9df5 100644 --- a/exchange/exchange-ps/exchange/Get-GlobalAddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-GlobalAddressList.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-globaladdresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-GlobalAddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-globaladdresslist +schema: 2.0.0 +title: Get-GlobalAddressList --- # Get-GlobalAddressList ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-GlobalAddressList cmdlet to view a global address list (GAL) or a set of GALs. @@ -39,7 +40,7 @@ Get-GlobalAddressList [[-Identity] ] ## DESCRIPTION The Get-GlobalAddressList cmdlet is mainly used to populate the GAL property pages in the Exchange admin center. This command doesn't provide a filtering capability. If filtering is required, you should use a WHERE clause with the command. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +61,9 @@ This example returns detailed information about the GAL named GAL\_AgencyB. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the global address list that you want to view. You can use any value that uniquely identifies the GAL. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the global address list that you want to view. Type: GlobalAddressListIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -DefaultOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultOnly switch filters the results so only the default GAL is returned. You don't need to use a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: DefaultOnly Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -104,7 +112,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Get-GlobalMonitoringOverride.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Get-GlobalMonitoringOverride.md index 24e4681b00..a92c1f42de 100644 --- a/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-GlobalMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-globalmonitoringoverride -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-GlobalMonitoringOverride -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-globalmonitoringoverride +schema: 2.0.0 +title: Get-GlobalMonitoringOverride --- # Get-GlobalMonitoringOverride @@ -26,7 +27,7 @@ Get-GlobalMonitoringOverride [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example returns detailed information for the global monitoring overrides th ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -55,7 +59,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Group.md b/exchange/exchange-ps/ExchangePowerShell/Get-Group.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-Group.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Group.md index b940181519..2d55c82323 100644 --- a/exchange/exchange-ps/exchange/Get-Group.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Group.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-group -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-Group -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-group +schema: 2.0.0 +title: Get-Group --- # Get-Group ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. 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. @@ -53,7 +54,7 @@ Get-Group [[-Identity] ] ## DESCRIPTION The Get-Group cmdlet returns no mail-related properties for distribution groups or mail-enabled security groups, and no role group-related properties for role groups. To view the object-specific properties for a group, you need to use the corresponding cmdlet based on the object type (for example, Get-DistributionGroup or Get-RoleGroup). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,6 +82,9 @@ This example uses the Anr parameter to return all groups that begin with "Mar". ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the group object that you want to view. You can use any value that uniquely identifies the group. For example: - Name @@ -92,7 +96,6 @@ The Identity parameter specifies the group object that you want to view. You can Type: GroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -114,7 +120,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -134,7 +142,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -154,7 +164,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -179,7 +191,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -189,6 +200,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -202,7 +216,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -223,7 +239,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +248,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -245,7 +263,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +272,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified group subtype. Valid values are: - MailNonUniversalGroup @@ -271,7 +291,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -281,13 +300,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -297,6 +318,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -310,7 +334,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HealthReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-HealthReport.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-HealthReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HealthReport.md index fb4ff840c9..ac6f437d9e 100644 --- a/exchange/exchange-ps/exchange/Get-HealthReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HealthReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-healthreport -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-HealthReport -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-healthreport +schema: 2.0.0 +title: Get-HealthReport --- # Get-HealthReport @@ -40,7 +41,7 @@ The following list contains the health values that are returned: - Functional - Unavailable -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example retrieves health information for the server named Mailbox01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the Exchange server where you want to run this Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -GroupSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GroupSize parameter determines the size of the group to process against for a rollup. The default value is 12. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -HaImpactingOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The HaImpactingOnly switch filters the results to only the monitors that have HaImpacting set to True. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -HealthSet + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The HealthSet parameter filters the results by the specified health set. Monitors that are similar or are tied to a component's architecture are grouped to form a health set. You can determine the collection of monitors (and associated probes and responders) in a given health set by using the Get-MonitoringItemIdentity cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -MinimumOnlinePercent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MinimumOnlinePercent parameter specifies the number of members in the group to be functioning with rollup information Degraded instead of Unhealthy. The default value is 70 percent. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,13 +150,15 @@ Accept wildcard characters: False ``` ### -RollupGroup + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RollupGroup switch specifies that the health data is rolled up across servers with redundancy limits. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HistoricalSearch.md b/exchange/exchange-ps/ExchangePowerShell/Get-HistoricalSearch.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-HistoricalSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HistoricalSearch.md index 9aa5b5f171..3f1e3f33d2 100644 --- a/exchange/exchange-ps/exchange/Get-HistoricalSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HistoricalSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-historicalsearch applicable: Exchange Online, Exchange Online Protection -title: Get-HistoricalSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-historicalsearch +schema: 2.0.0 +title: Get-HistoricalSearch --- # Get-HistoricalSearch @@ -28,7 +29,7 @@ Get-HistoricalSearch [-JobId ] ## DESCRIPTION A historical search provides message trace and report details in a comma-separated value (CSV) file for messages that are less than 90 days old. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example returns detailed information about the historical search that's in ## PARAMETERS ### -JobId + +> Applicable: Exchange Online, Exchange Online Protection + The JobId parameter specifies the GUID identifier of the historical search that you want to view. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-HoldCompliancePolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HoldCompliancePolicy.md index ec353acb7a..13535a450a 100644 --- a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HoldCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-holdcompliancepolicy applicable: Security & Compliance -title: Get-HoldCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-holdcompliancepolicy +schema: 2.0.0 +title: Get-HoldCompliancePolicy --- # Get-HoldCompliancePolicy @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Get-HoldCompliancePolicy to view existing preservation policies in the Microsoft Purview compliance portal. -**Note**: The Get-HoldCompliancePolicy cmdlet has been replaced by the Get-RetentionCompliancePolicy cmdlet. If you have scripts that use Get-HoldCompliancePolicy, update them to use Get-RetentionCompliancePolicy. +**Note**: The Get-HoldCompliancePolicy cmdlet is replaced by the Get-RetentionCompliancePolicy cmdlet. If you have scripts that use Get-HoldCompliancePolicy, update them to use Get-RetentionCompliancePolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -57,6 +58,9 @@ This example displays detailed information for the policy named "Regulation 123 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -67,7 +71,6 @@ The Identity parameter specifies the preservation policy that you want to view. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-HoldComplianceRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-HoldComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HoldComplianceRule.md index 898c6c476a..7885973ffc 100644 --- a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HoldComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-holdcompliancerule applicable: Security & Compliance -title: Get-HoldComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-holdcompliancerule +schema: 2.0.0 +title: Get-HoldComplianceRule --- # Get-HoldComplianceRule @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Get-HoldComplianceRule to view preservation rules in the Microsoft Purview compliance portal. -**Note**: The Get-HoldComplianceRule cmdlet has been replaced by the Get-RetentionComplianceRule cmdlet. If you have scripts that use Get-HoldComplianceRule, update them to use Get-RetentionComplianceRule. +**Note**: The Get-HoldComplianceRule cmdlet is replaced by the Get-RetentionComplianceRule cmdlet. If you have scripts that use Get-HoldComplianceRule, update them to use Get-RetentionComplianceRule. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -57,6 +58,9 @@ This example displays detailed information for the preservation rule named "30 D ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation rule you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -67,7 +71,6 @@ The Identity parameter specifies the preservation rule you want to view. You can Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter filters the preservation rule results by the associated preservation policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -89,7 +95,6 @@ You can use this parameter with the Identity parameter in the same command. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-HostedConnectionFilterPolicy.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HostedConnectionFilterPolicy.md index 95c62d1b40..6a277a7fed 100644 --- a/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HostedConnectionFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedconnectionfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-HostedConnectionFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hostedconnectionfilterpolicy +schema: 2.0.0 +title: Get-HostedConnectionFilterPolicy --- # Get-HostedConnectionFilterPolicy @@ -26,13 +27,13 @@ Get-HostedConnectionFilterPolicy [[-Identity] Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the connection filter policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -59,7 +63,6 @@ Typically, you only have one connection filter policy: the default policy named Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-HostedContentFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-HostedContentFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterPolicy.md index 855377d33a..ad081ea01c 100644 --- a/exchange/exchange-ps/exchange/Get-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedcontentfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-HostedContentFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hostedcontentfilterpolicy +schema: 2.0.0 +title: Get-HostedContentFilterPolicy --- # Get-HostedContentFilterPolicy @@ -26,7 +27,7 @@ Get-HostedContentFilterPolicy [[-Identity] Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the spam filter policy that you want to view. Y Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterRule.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterRule.md index 0531374eab..e2df6989bd 100644 --- a/exchange/exchange-ps/exchange/Get-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedcontentfilterrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-HostedContentFilterRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hostedcontentfilterrule +schema: 2.0.0 +title: Get-HostedContentFilterRule --- # Get-HostedContentFilterRule @@ -28,7 +29,7 @@ Get-HostedContentFilterRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example retrieves details about the spam filter rule named Contoso Recipien ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the spam filter rule that you want to view. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The State parameter filters the results by the state of the rule. Valid values are: - Enabled: The command returns only enabled rules. @@ -94,7 +102,6 @@ The State parameter filters the results by the state of the rule. Valid values a Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterPolicy.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterPolicy.md index 1e40b52a4d..c1b6455966 100644 --- a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-HostedOutboundSpamFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hostedoutboundspamfilterpolicy +schema: 2.0.0 +title: Get-HostedOutboundSpamFilterPolicy --- # Get-HostedOutboundSpamFilterPolicy @@ -26,7 +27,7 @@ Get-HostedOutboundSpamFilterPolicy [-Identity] Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter policy you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the outbound spam filter policy you want to vie Type: HostedOutboundSpamFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterRule.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterRule.md index 0a620cec54..e5e9fb6b86 100644 --- a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: Get-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hostedoutboundspamfilterrule +schema: 2.0.0 +title: Get-HostedOutboundSpamFilterRule --- # Get-HostedOutboundSpamFilterRule @@ -27,7 +28,7 @@ Get-HostedOutboundSpamFilterRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example returns detailed information for the outbound spam filter rule name ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the outbound spam filter rule that you want to Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online, Exchange Online Protection + The State parameter filters the results by enabled or disabled rules. Valid values are: - Enabled: Only enabled rules are returned. @@ -77,7 +83,6 @@ The State parameter filters the results by enabled or disabled rules. Valid valu Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HybridConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-HybridConfiguration.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-HybridConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HybridConfiguration.md index 426766c54c..9e64f221a2 100644 --- a/exchange/exchange-ps/exchange/Get-HybridConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HybridConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hybridconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-HybridConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hybridconfiguration +schema: 2.0.0 +title: Get-HybridConfiguration --- # Get-HybridConfiguration @@ -26,7 +27,7 @@ Get-HybridConfiguration [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,13 +41,15 @@ This example returns detailed information about the hybrid deployment configurat ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md b/exchange/exchange-ps/ExchangePowerShell/Get-HybridMailflowDatacenterIPs.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HybridMailflowDatacenterIPs.md index 4f793be1a3..47d56b16c7 100644 --- a/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HybridMailflowDatacenterIPs.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hybridmailflowdatacenterips applicable: Exchange Online -title: Get-HybridMailflowDatacenterIPs -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hybridmailflowdatacenterips +schema: 2.0.0 +title: Get-HybridMailflowDatacenterIPs --- # Get-HybridMailflowDatacenterIPs @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -This cmdlet has been deprecated and is no longer used. +This cmdlet is 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). @@ -25,7 +26,7 @@ Get-HybridMailflowDatacenterIPs [] ``` ## DESCRIPTION -This cmdlet has been deprecated and is no longer used. +This cmdlet is deprecated and is no longer used. ## EXAMPLES @@ -34,7 +35,7 @@ This cmdlet has been deprecated and is no longer used. Get-HybridMailflowDatacenterIPs ``` -This cmdlet has been deprecated and is no longer used. +This cmdlet is deprecated and is no longer used. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-IPAllowListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListConfig.md index 0da96065e8..0d1ece03ec 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipallowlistconfig +schema: 2.0.0 +title: Get-IPAllowListConfig --- # Get-IPAllowListConfig @@ -42,6 +43,9 @@ This example returns detailed information about the IP Allow list configuration ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -50,7 +54,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListEntry.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-IPAllowListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListEntry.md index 7221b9e90b..9554627b22 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipallowlistentry +schema: 2.0.0 +title: Get-IPAllowListEntry --- # Get-IPAllowListEntry @@ -58,13 +59,15 @@ This example returns an IP Allow list entry in which the specified IP address is ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity integer value of the IP Allow list entry that you want to view. When you add an entry to the IP Allow list, the Identity value is automatically assigned. ```yaml Type: IPListEntryIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddress parameter specifies an IP address to view in the IP Allow list entry or entries. For example, if you have an IP Allow list entry that specifies a range of IP addresses from 192.168.0.1 through 192.168.0.20, enter any IP address in the IP Allow list IP address range to return the IP Allow list entry. ```yaml Type: IPAddress Parameter Sets: IPAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -121,7 +131,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvider.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-IPAllowListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvider.md index 1d17905936..4c02a98691 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipallowlistprovider +schema: 2.0.0 +title: Get-IPAllowListProvider --- # Get-IPAllowListProvider @@ -48,6 +49,9 @@ This example returns detailed information for the IP Allow list provider named C ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the IP Allow list provider that you want to view. You can use any value that uniquely identifies the IP Allow list provider. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the IP Allow list provider that you want to vie Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -76,7 +82,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvidersConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvidersConfig.md index b56f559df4..76c2a9caf3 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvidersConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistprovidersconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListProvidersConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipallowlistprovidersconfig +schema: 2.0.0 +title: Get-IPAllowListProvidersConfig --- # Get-IPAllowListProvidersConfig @@ -42,6 +43,9 @@ This example returns detailed information about the IP Allow list providers conf ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -50,7 +54,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-IPBlockListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListConfig.md index 517988a7ae..814407a7b2 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipblocklistconfig +schema: 2.0.0 +title: Get-IPBlockListConfig --- # Get-IPBlockListConfig @@ -42,6 +43,9 @@ This example returns detailed information about the IP Block list configuration ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -50,7 +54,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListEntry.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-IPBlockListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListEntry.md index d6a1d41ce8..497fb75329 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipblocklistentry +schema: 2.0.0 +title: Get-IPBlockListEntry --- # Get-IPBlockListEntry @@ -58,13 +59,15 @@ This example returns machine-generated entries in the IP Block list that are ins ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity integer value of the IP Block list entry that you want to view. When you add an entry to the IP Block list, the Identity value is automatically assigned. ```yaml Type: IPListEntryIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddress parameter specifies an IP address to view in the IP Block list entry or entries. For example, if you have an IP Block list entry that specifies a range of IP addresses from 192.168.0.1 through 192.168.0.20, enter any IP address in the IP Block list IP address range to return the IP Block list entry. ```yaml Type: IPAddress Parameter Sets: IPAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -121,7 +131,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvider.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-IPBlockListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvider.md index f8849f592d..dd1c0f63eb 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipblocklistprovider +schema: 2.0.0 +title: Get-IPBlockListProvider --- # Get-IPBlockListProvider @@ -48,6 +49,9 @@ This example returns detailed information for the existing IP Block list provide ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the IP Block list provider that you want to view. You can use any value that uniquely identifies the IP Block list provider. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the IP Block list provider that you want to vie Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -76,7 +82,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvidersConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvidersConfig.md index f7bcc606fa..0360780512 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvidersConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistprovidersconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListProvidersConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipblocklistprovidersconfig +schema: 2.0.0 +title: Get-IPBlockListProvidersConfig --- # Get-IPBlockListProvidersConfig @@ -42,6 +43,9 @@ This example returns detailed information about the IP Block list providers on t ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -50,7 +54,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPv6StatusForAcceptedDomain.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPv6StatusForAcceptedDomain.md index 52922f6862..8315774650 100644 --- a/exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPv6StatusForAcceptedDomain.md @@ -1,12 +1,12 @@ --- -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 +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipv6statusforaccepteddomain +schema: 2.0.0 +title: Get-IPv6StatusForAcceptedDomain --- # Get-IPv6StatusForAcceptedDomain @@ -32,7 +32,7 @@ Use the Get-AcceptedDomain cmdlet to return accepted domains in the Exchange Onl 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or 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] > @@ -42,7 +42,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi > > - If you receive the following error when running Get-Ipv6StatusForAcceptedDomain: > -> WARNING: DNS record has unexpected value….. +> WARNING: DNS record has unexpected value... > > Explicitly enable or disable IPv6 using the Enable-Ipv6ForAcceptedDomain or Disable-Ipv6ForAcceptedDomain cmdlets. @@ -58,13 +58,15 @@ This example returns the status of IPv6 support for mail sent to contoso.com. ## PARAMETERS ### -Domain + +> Applicable: Exchange Online + 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 @@ -74,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -90,13 +94,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IRMConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-IRMConfiguration.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-IRMConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IRMConfiguration.md index 377c44454f..d609d6bd9d 100644 --- a/exchange/exchange-ps/exchange/Get-IRMConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IRMConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-irmconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-IRMConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-irmconfiguration +schema: 2.0.0 +title: Get-IRMConfiguration --- # Get-IRMConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-IRMConfiguration cmdlet to view the Information Rights Management (IRM) configuration in your organization. @@ -28,7 +29,7 @@ Get-IRMConfiguration [-DomainController ] ## DESCRIPTION The Get-IRMConfiguration cmdlet provides details about the current IRM configuration, including whether individual IRM features are enabled or disabled and provides the URLs used for ServiceLocation, PublishingLocation and LicensingLocation. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example retrieves the IRM configuration in your organization. ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -50,7 +54,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ImapSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-ImapSettings.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-ImapSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ImapSettings.md index 78a0faa6d4..aa9e21ca9f 100644 --- a/exchange/exchange-ps/exchange/Get-ImapSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ImapSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-imapsettings -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ImapSettings -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-imapsettings +schema: 2.0.0 +title: Get-ImapSettings --- # Get-ImapSettings @@ -27,7 +28,7 @@ Get-ImapSettings [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example displays the settings and values of the Microsoft Exchange IMAP4 se ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -70,7 +76,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-InboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-InboundConnector.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-InboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-InboundConnector.md index 2447b733ef..cc7b89664c 100644 --- a/exchange/exchange-ps/exchange/Get-InboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-InboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-inboundconnector applicable: Exchange Online, Exchange Online Protection -title: Get-InboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-inboundconnector +schema: 2.0.0 +title: Get-InboundConnector --- # Get-InboundConnector @@ -29,7 +30,7 @@ Get-InboundConnector [[-Identity] ] ## DESCRIPTION Inbound connectors accept email messages from remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example lists all the Inbound connectors configured in your cloud-based org ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the name or GUID of the Inbound connector. If the Identity name contains spaces, enclose the name in quotation marks ("). You can omit the Identity parameter label. ```yaml Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + 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 diff --git a/exchange/exchange-ps/exchange/Get-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-InboxRule.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-InboxRule.md index 5ed6b13784..3428804391 100644 --- a/exchange/exchange-ps/exchange/Get-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-InboxRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-inboxrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-InboxRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-inboxrule +schema: 2.0.0 +title: Get-InboxRule --- # Get-InboxRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-InboxRule cmdlet to view Inbox rule properties. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. @@ -36,7 +37,7 @@ Get-InboxRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). **Note**: This cmdlet doesn't work for members of View-Only Organization Management role group in Exchange Online or the Global Reader role in Microsoft Entra ID. @@ -59,6 +60,9 @@ This example retrieves the Inbox rule ReceivedLastYear from the mailbox joe@cont ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Inbox rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the Inbox rule that you want to view. You can u Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -BypassScopeCheck + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -DescriptionTimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -104,7 +112,6 @@ MM/dd/yyyy, where MM is the 2-digit month, dd is the 2-digit day and yyyy is the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -DescriptionTimeZone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DescriptionTimeZone parameter specifies time zone that's used for time values in the rule description. A valid value for this parameter is a supported time zone key name (for example, "Pacific Standard Time"). @@ -126,7 +136,6 @@ If the value contains spaces, enclose the value in quotation marks ("). The defa Type: ExTimeZoneValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -144,7 +156,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -IncludeHidden + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeHidden switch specifies whether to include hidden Inbox rules in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,6 +183,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -187,7 +203,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,6 +212,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -205,7 +223,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +232,9 @@ Accept wildcard characters: False ``` ### -SkipCount + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} @@ -223,7 +243,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -233,6 +252,9 @@ Accept wildcard characters: False ``` ### -SweepRules + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SweepRules switch specifies whether to return only Sweep rules in the results. You don't need to specify a value with this switch. @@ -243,7 +265,6 @@ Sweep rules run at regular intervals to help keep your Inbox clean. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,6 +274,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -261,7 +285,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPoliciesApplicationStatus.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md rename to exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPoliciesApplicationStatus.md index 4ba383b667..a7e9c553d8 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPoliciesApplicationStatus.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus applicable: Security & Compliance -title: Get-InformationBarrierPoliciesApplicationStatus -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-informationbarrierpoliciesapplicationstatus +schema: 2.0.0 +title: Get-InformationBarrierPoliciesApplicationStatus --- # Get-InformationBarrierPoliciesApplicationStatus @@ -57,13 +58,15 @@ This example returns all applications of information barrier policies by the Sta ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the information barrier policy application that you want to view. This value is a GUID that's displayed when you run the Start-InformationBarrierPoliciesApplication cmdlet (for example, a0551cee-db3d-4002-9fa0-94358035fdf2). You can also find the Identity value by running the command Get-InformationBarrierPoliciesApplicationStatus -All. ```yaml Type: PolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -All + +> Applicable: Security & Compliance + The All switch specifies whether to include all applications of information barrier policies in the results. You don't need to specify a value with this switch. If you don't use this switch, the command only returns the most recent policy application. @@ -81,7 +87,6 @@ If you don't use this switch, the command only returns the most recent policy ap Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPolicy.md index 32c2276297..8afc72a88e 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierpolicy applicable: Security & Compliance -title: Get-InformationBarrierPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-informationbarrierpolicy +schema: 2.0.0 +title: Get-InformationBarrierPolicy --- # Get-InformationBarrierPolicy @@ -57,6 +58,9 @@ This example displays detailed information for the information barrier policy na ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the information barrier policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -69,7 +73,6 @@ You can't use this parameter with the ExOPolicyId parameter. Type: PolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -ExoPolicyId + +> Applicable: Security & Compliance + The ExOPolicyId parameter specifies the information barrier policy that you want to view, but using the GUID part of the ExoPolicyId property value from the output of the Get-InformationBarrierRecipientStatus cmdlet. You can't use this parameter with the Identity parameter. @@ -87,7 +93,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -109,4 +114,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierRecipientStatus.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md rename to exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierRecipientStatus.md index 862519808e..2d332b51d7 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierRecipientStatus.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierrecipientstatus applicable: Security & Compliance -title: Get-InformationBarrierRecipientStatus -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-informationbarrierrecipientstatus +schema: 2.0.0 +title: Get-InformationBarrierRecipientStatus --- # Get-InformationBarrierRecipientStatus @@ -56,6 +57,9 @@ This example returns the information barrier policy relationship for the users m ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the recipient that you want to view the segment and policy assignment information for. You can use any value that uniquely identifies the recipient. For example: - Name @@ -69,7 +73,6 @@ The Identity parameter specifies the recipient that you want to view the segment Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Identity2 + +> Applicable: Security & Compliance + The Identity2 parameter specifies an optional second recipient when you want to view the information barrier policy relationship to the first recipient specified by the Identity parameter. You can use any value that uniquely identifies the second recipient. For example: - Name @@ -96,7 +102,6 @@ You can only use this parameter with the Identity parameter; you can't use it by Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -120,4 +125,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConfiguration.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConfiguration.md index 3178fd949a..09a889529c 100644 --- a/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-intraorganizationconfiguration -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-IntraOrganizationConfiguration -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-intraorganizationconfiguration +schema: 2.0.0 +title: Get-IntraOrganizationConfiguration --- # Get-IntraOrganizationConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-IntraOrganizationConfiguration cmdlet to view the component settings of a hybrid Exchange deployment. @@ -30,7 +31,7 @@ A hybrid Exchange deployment results in one logical organization made up of a nu Hybrid environments are enabled by Intra-Organization connectors. The connectors can be created and managed by cmdlets like New-IntraOrganizationConnector, but we strongly recommend that you use the Hybrid Configuration wizard when configuring a hybrid deployment with an Exchange Online organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,15 +45,17 @@ This example returns the settings of the intra-organization configuration. ## PARAMETERS ### -OrganizationGuid + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The OrganizationGuid parameter specifies the on-premises organization in a hybrid deployment that has multiple on-premises organizations defined. If you don't use the OrganizationGuid parameter for these types of hybrid deployments, the Get-IntraOrganizationConfiguration cmdlet will generate errors. To view the on-premises organization GUID values that are required for this parameter, use the Get-OnPremisesOrganization cmdlet. +The OrganizationGuid parameter specifies the on-premises organization in a hybrid deployment that has multiple on-premises organizations defined. If you don't use the OrganizationGuid parameter for these types of hybrid deployments, the Get-IntraOrganizationConfiguration cmdlet returns errors. To view the on-premises organization GUID values that are required for this parameter, use the Get-OnPremisesOrganization cmdlet. ```yaml Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 diff --git a/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConnector.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConnector.md index d07a069726..7f8893e54e 100644 --- a/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConnector.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-intraorganizationconnector -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-IntraOrganizationConnector -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-intraorganizationconnector +schema: 2.0.0 +title: Get-IntraOrganizationConnector --- # Get-IntraOrganizationConnector ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-IntraOrganizationConnector cmdlet to view the settings of Intra-Organization connectors. @@ -29,7 +30,7 @@ Get-IntraOrganizationConnector [[-Identity] Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Intra-Organization connector that you want to view. You can use any value that uniquely identifies the connector. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the Intra-Organization connector that you want Type: IntraOrganizationConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -78,7 +84,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-JournalRule.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-JournalRule.md index 68b259f8f9..35a9d4bfd9 100644 --- a/exchange/exchange-ps/exchange/Get-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-JournalRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-journalrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-JournalRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-journalrule +schema: 2.0.0 +title: Get-JournalRule --- # Get-JournalRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-JournalRule cmdlet to view the journal rules in your organization. @@ -29,7 +30,7 @@ Get-JournalRule [[-Identity] ] ## DESCRIPTION The Get-JournalRule cmdlet displays journal rules configured in your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example retrieves the specific journal rule Brokerage Communications and pi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the rule you want to view. Enter either the name or the GUID of the journal rule. You can omit the parameter label. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Label.md b/exchange/exchange-ps/ExchangePowerShell/Get-Label.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-Label.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Label.md index b2cf3b4226..7f2a6250ac 100644 --- a/exchange/exchange-ps/exchange/Get-Label.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Label.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-label applicable: Security & Compliance -title: Get-Label -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-label +schema: 2.0.0 +title: Get-Label --- # Get-Label @@ -50,6 +51,9 @@ This example returns detailed information for the sensitivity label named Engine ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitivity label that you want to view. You can use any value that uniquely identifies the label. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the sensitivity label that you want to view. Yo Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -IncludeDetailedLabelActions + +> Applicable: Security & Compliance + The IncludeDetailedLabelActions parameter specifies whether to expand label actions into properties for better readability. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -SkipValidations + +> Applicable: Security & Compliance + {{ Fill SkipValidations Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -ValidateContentTypeRemoval + +> Applicable: Security & Compliance + {{ Fill ValidateContentTypeRemoval Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-LabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-LabelPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-LabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-LabelPolicy.md index 7a90fbaa71..758f9dee87 100644 --- a/exchange/exchange-ps/exchange/Get-LabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-LabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-labelpolicy applicable: Security & Compliance -title: Get-LabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-labelpolicy +schema: 2.0.0 +title: Get-LabelPolicy --- # Get-LabelPolicy @@ -48,6 +49,9 @@ This example returns detailed information for the policy named Engineering Group ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitivity label policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the sensitivity label policy that you want to v Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -ForceValidate + +> Applicable: Security & Compliance + {{ Fill ForceValidate Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-LinkedUser.md b/exchange/exchange-ps/ExchangePowerShell/Get-LinkedUser.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-LinkedUser.md rename to exchange/exchange-ps/ExchangePowerShell/Get-LinkedUser.md index 7407a5f12b..cc39479866 100644 --- a/exchange/exchange-ps/exchange/Get-LinkedUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-LinkedUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-linkeduser applicable: Exchange Online -title: Get-LinkedUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-linkeduser +schema: 2.0.0 +title: Get-LinkedUser --- # Get-LinkedUser @@ -41,7 +42,7 @@ Get-LinkedUser [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example returns a detailed information for the linked for the user laura@co ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the linked user that you want to view. You can use any value that uniquely identifies the linked user. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the linked user that you want to view. You can Type: UserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -95,7 +101,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -120,7 +128,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + 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 @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -179,7 +193,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-LogonStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-LogonStatistics.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-LogonStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-LogonStatistics.md index bfdee00794..a0b449dff7 100644 --- a/exchange/exchange-ps/exchange/Get-LogonStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-LogonStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-logonstatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-LogonStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-logonstatistics +schema: 2.0.0 +title: Get-LogonStatistics --- # Get-LogonStatistics @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in Exchange Server 2010. -The Get-LogonStatistics cmdlet has been deprecated and is no longer used. +The Get-LogonStatistics cmdlet is 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). @@ -44,9 +45,9 @@ Get-LogonStatistics -Server ## DESCRIPTION The Get-LogonStatistics cmdlet retrieves logon information about currently active sessions. On Mailbox servers only, you can use the Get-LogonStatistics cmdlet without parameters. In this case, the cmdlet returns the logon statistics for all mailboxes on all databases on the local server. -Users who log on to their mailboxes using Microsoft Office Outlook Web App aren't continually connected to the Mailbox server. An Outlook Web App client connects to the server, performs tasks, and then disconnects from the server. Therefore, you may see few or no logon statistics for Outlook Web App, even if users are logged on with this client. +Users who log on to their mailboxes using Microsoft Office Outlook Web App aren't continually connected to the Mailbox server. An Outlook Web App client connects to the server, performs tasks, and then disconnects from the server. Therefore, you might see few or no logon statistics for Outlook Web App, even if users are logged on with this client. -You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Recipient Provisioning Permissions" section in the Mailbox Permissions topic. +You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you might not have access to some parameters if they aren't included in the permissions assigned to you. To see what permissions you need, see the "Recipient Provisioning Permissions" section in the Mailbox Permissions topic. ## EXAMPLES @@ -60,6 +61,9 @@ This example returns logon statistics for all users connected to the server Serv ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox to get logon statistics from. You can use one of the following values to identify the mailbox: - GUID @@ -78,7 +82,6 @@ You can't use this parameter with the Database or Server parameters. Type: LogonableObjectIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Database parameter specifies the mailbox database to get logon statistics from (all mailboxes in the specified database). You can use any value that uniquely identifies the mailbox database. For example: - Name @@ -102,7 +108,6 @@ You can't use this parameter with the Identity or Server parameters. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Mailbox server to get logon statistics from (all mailboxes on all databases, including recovery databases, on the specified server). You can use one of the following values to identify the server: - Fully qualified domain name (FQDN) @@ -125,7 +133,6 @@ You can't use this parameter with the Database or Identity parameters. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -135,13 +142,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicy.md index c7992e4955..1208f2a526 100644 --- a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-M365DataAtRestEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-m365dataatrestencryptionpolicy +schema: 2.0.0 +title: Get-M365DataAtRestEncryptionPolicy --- # Get-M365DataAtRestEncryptionPolicy @@ -33,7 +34,7 @@ M365 data-at-rest encryption policy cmdlets are accessible to compliance adminis You can create and assign a Microsoft 365 data-at-rest encryption policy at the tenant level by using the appropriate M365DataAtRestEncryptionPolicy cmdlets 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example returns detailed information about the policy named Contoso Corpora ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 data-at-rest encryption policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the Microsoft 365 data-at-rest encryption polic Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md b/exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicyAssignment.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicyAssignment.md index 486e093215..a069af8112 100644 --- a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicyAssignment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicyassignment applicable: Exchange Online -title: Get-M365DataAtRestEncryptionPolicyAssignment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-m365dataatrestencryptionpolicyassignment +schema: 2.0.0 +title: Get-M365DataAtRestEncryptionPolicyAssignment --- # Get-M365DataAtRestEncryptionPolicyAssignment @@ -27,7 +28,7 @@ Get-M365DataAtRestEncryptionPolicyAssignment [] ## DESCRIPTION This cmdlet lists the Microsoft 365 data-at-rest encryption policy that's currently assigned to the tenant. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,8 @@ Get-M365DataAtRestEncryptionPolicyAssignment | Format-List This example returns detailed information for all Microsoft 365 data-at-rest encryption policy assignments. +## 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). diff --git a/exchange/exchange-ps/exchange/Get-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailContact.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailContact.md index aa00b27a06..e1762e870e 100644 --- a/exchange/exchange-ps/exchange/Get-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailContact.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailcontact -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-MailContact -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailcontact +schema: 2.0.0 +title: Get-MailContact --- # Get-MailContact ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailContact cmdlet to view existing mail contacts. @@ -53,7 +54,7 @@ Get-MailContact [[-Identity] ] ## DESCRIPTION The Get-MailContact cmdlet retrieves all attributes of the specified contact. No parameters are required. If the cmdlet is run without a parameter, a complete list of contacts for the Exchange organization is returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,6 +75,9 @@ This example retrieves detailed information for the mail contact named Arlene. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail contact that you want to view. You can use any value that uniquely identifies the mail contact. For example: - Name @@ -87,7 +91,6 @@ The Identity parameter specifies the mail contact that you want to view. You can Type: MailContactIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -ANR + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -109,7 +115,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -129,7 +137,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -147,7 +157,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -172,7 +184,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -195,7 +209,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -205,6 +218,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -216,7 +232,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,6 +241,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -238,7 +256,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,6 +265,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified mail contact subtype. Valid values are: - MailContact @@ -259,7 +279,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -269,13 +288,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -285,6 +306,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -299,7 +323,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailATPReport.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-MailDetailATPReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailDetailATPReport.md index 5b27ac86dc..39cb412f8d 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailATPReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailatpreport applicable: Exchange Online, Exchange Online Protection -title: Get-MailDetailATPReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-maildetailatpreport +schema: 2.0.0 +title: Get-MailDetailATPReport --- # Get-MailDetailATPReport @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-MailDetailATPReport cmdlet to list details about Exchange Online Protection and Microsoft Defender for Office 365 detections in your cloud-based organization for the last 10 days. +Use the Get-MailDetailATPReport cmdlet to list details about Microsoft Defender for Office 365 detections in your cloud-based organization for the last 10 days. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -64,7 +65,7 @@ For the reporting period you specify, the cmdlet returns the following informati This cmdlet is limited to 10,000 results. If you reach this limit, you can use the available parameters to filter the output. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,18 +74,22 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-MailDetailATPReport -StartDate 7/22/2018 -EndDate 7/31/2018 ``` -This example returns the actions for the last 10 days in July, 2018. (Note: Customers with Defender for Office 365 subscriptions will be able to get up to 30 days of data.) +This example returns the actions for the last 10 days in July, 2018. + +Customers with Defender for Office 365 subscriptions can get up to 30 days of data. ## PARAMETERS ### -DataSource + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill DataSource Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -106,7 +114,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured 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". @@ -140,7 +152,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - Advanced filter @@ -181,7 +195,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -191,6 +204,9 @@ Accept wildcard characters: False ``` ### -MalwareName + +> Applicable: Exchange Online, Exchange Online Protection + The MalwareName parameter filters the results by malware payload. Valid values are: - Excel @@ -207,7 +223,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -217,13 +232,15 @@ 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, ""). + +> Applicable: Exchange Online, Exchange Online Protection + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +250,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). You can specify multiple values separated by commas. @@ -242,14 +262,13 @@ The MessageTraceId value is also available in the output of the following cmdlet - Get-MailDetailDlpPolicyReport - Get-MailDetailEncryptionReport - Get-MailDetailTransportRuleReport -- Get-MessageTrace -- Get-MessageTraceDetail +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -259,13 +278,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,13 +296,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -291,13 +314,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,13 +332,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,13 +350,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -339,6 +368,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". @@ -347,7 +379,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailDlpPolicyReport.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailDetailDlpPolicyReport.md index 370e827191..1318943b53 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailDlpPolicyReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetaildlppolicyreport applicable: Exchange Online -title: Get-MailDetailDlpPolicyReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-maildetaildlppolicyreport +schema: 2.0.0 +title: Get-MailDetailDlpPolicyReport --- # Get-MailDetailDlpPolicyReport @@ -40,7 +41,7 @@ Get-MailDetailDlpPolicyReport [-Action ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example retrieves the details of messages sent by john@contoso.com that mat ## PARAMETERS ### -Action + +> Applicable: Exchange Online + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -62,7 +66,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -83,7 +89,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Online + The DlpPolicy parameter filters the report by the name of the DLP policy. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -133,7 +145,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online + The EventType parameter filters the report by the event type. Valid values are: - DLPActionHits @@ -159,7 +173,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -169,13 +182,15 @@ 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, ""). + +> Applicable: Exchange Online + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). You can specify multiple values separated by commas. @@ -194,14 +212,13 @@ The MessageTraceId value is also available in the output of the following cmdlet - Get-MailDetailATPReport - Get-MailDetailEncryptionReport - Get-MailDetailTransportRuleReport -- Get-MessageTrace -- Get-MessageTraceDetail +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -211,13 +228,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -227,13 +246,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -243,13 +264,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -259,13 +282,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -275,13 +300,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -291,6 +318,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -299,7 +329,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -309,13 +338,15 @@ Accept wildcard characters: False ``` ### -TransportRule + +> Applicable: Exchange Online + The TransportRule parameter filters the report by the name of the transport rule. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailEncryptionReport.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailDetailEncryptionReport.md index 218a792389..986013442c 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailEncryptionReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailencryptionreport applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-MailDetailEncryptionReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-maildetailencryptionreport +schema: 2.0.0 +title: Get-MailDetailEncryptionReport --- # Get-MailDetailEncryptionReport @@ -53,7 +54,7 @@ If you append the command with ` | Format-List`, the following additional inform - Message Size - Subject -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,13 +68,15 @@ This example retrieves encryption details for messages between December 13, 2021 ## PARAMETERS ### -Organization + +> Applicable: Security & Compliance + {{ Fill Organization Description }} ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -83,13 +86,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -110,7 +118,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -144,7 +156,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - EncryptionManual @@ -167,7 +181,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -177,7 +190,10 @@ 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, ""). + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). You can specify multiple values separated by commas. @@ -185,7 +201,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -195,6 +210,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). You can specify multiple values separated by commas. @@ -204,14 +222,13 @@ The MessageTraceId value is also available in the output of the following cmdlet - Get-MailDetailATPReport - Get-MailDetailDlpPolicyReport - Get-MailDetailTransportRuleReport -- Get-MessageTrace -- Get-MessageTraceDetail +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -221,13 +238,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -237,13 +256,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -253,13 +274,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -269,6 +292,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -277,7 +303,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailTransportRuleReport.md similarity index 85% rename from exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailDetailTransportRuleReport.md index 8c7caa8477..21c4bddb6f 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailTransportRuleReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailtransportrulereport applicable: Exchange Online, Exchange Online Protection -title: Get-MailDetailTransportRuleReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-maildetailtransportrulereport +schema: 2.0.0 +title: Get-MailDetailTransportRuleReport --- # Get-MailDetailTransportRuleReport @@ -39,7 +40,7 @@ Get-MailDetailTransportRuleReport [-Action ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example retrieves the details of messages sent by john@contoso.com that mat ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -61,7 +65,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -82,7 +88,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -116,7 +126,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - EncryptionManual @@ -141,7 +153,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,13 +162,15 @@ 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, ""). + +> Applicable: Exchange Online, Exchange Online Protection + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,6 +180,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). You can specify multiple values separated by commas. @@ -176,14 +192,13 @@ The MessageTraceId value is also available in the output of the following cmdlet - Get-MailDetailATPReport - Get-MailDetailDlpPolicyReport - Get-MailDetailEncryptionReport -- Get-MessageTrace -- Get-MessageTraceDetail +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -193,13 +208,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -225,13 +244,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -241,13 +262,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,13 +280,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -273,6 +298,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -283,7 +311,6 @@ Although you can enter a date up to 30 days old, only data from the last 10 days Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -293,13 +320,15 @@ Accept wildcard characters: False ``` ### -TransportRule + +> Applicable: Exchange Online, Exchange Online Protection + The TransportRule parameter filters the report by the name of the transport rule. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailFilterListReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailFilterListReport.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-MailFilterListReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailFilterListReport.md index 4fe3fbe363..3038284e6e 100644 --- a/exchange/exchange-ps/exchange/Get-MailFilterListReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailFilterListReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailfilterlistreport applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-MailFilterListReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailfilterlistreport +schema: 2.0.0 +title: Get-MailFilterListReport --- # Get-MailFilterListReport @@ -30,7 +31,7 @@ Get-MailFilterListReport ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example uses the Get-MailFilterListReport cmdlet to return information abou ## PARAMETERS ### -Domain + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Expression + +> Applicable: Security & Compliance + This parameter is available only in Security & Compliance PowerShell. This parameter is reserved for internal Microsoft use. @@ -68,7 +74,6 @@ This parameter is reserved for internal Microsoft use. Type: Expression Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -94,6 +101,9 @@ Accept wildcard characters: False ``` ### -SelectionTarget + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SelectionTarget parameter filters the report information by object type. Valid values are: - Actions @@ -108,7 +118,6 @@ The SelectionTarget parameter filters the report information by object type. Val Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailFlowStatusReport.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-MailflowStatusReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailFlowStatusReport.md index fef6949dce..fc641edb9e 100644 --- a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailFlowStatusReport.md @@ -1,12 +1,13 @@ --- -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 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailflowstatusreport +schema: 2.0.0 +title: Get-MailFlowStatusReport --- # Get-MailFlowStatusReport @@ -41,7 +42,7 @@ This cmdlet returns the following information: - Event Type - Count -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example returns inbound and outbound messages were classified as GoodMail o ## PARAMETERS ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by the direction of the message. Valid values are: - Inbound @@ -67,7 +71,6 @@ You can specify multiple value separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -101,7 +109,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - EdgeBlockSpam @@ -126,7 +136,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -184,6 +199,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -192,7 +210,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailPublicFolder.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-MailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailPublicFolder.md index 1361e04533..5c3de390b6 100644 --- a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailPublicFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailpublicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailPublicFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailpublicfolder +schema: 2.0.0 +title: Get-MailPublicFolder --- # Get-MailPublicFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailPublicFolder cmdlet to retrieve mail-related information about mail-enabled public folders. If you want information about the basic (not mail-related) settings of mail-enabled public folders, use the Get-PublicFolder cmdlet instead. @@ -27,6 +28,7 @@ Get-MailPublicFolder [-Anr ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-ReadFromDomainController] [-ResultSize ] [-Server ] @@ -40,6 +42,7 @@ Get-MailPublicFolder [[-Identity] ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-ReadFromDomainController] [-ResultSize ] [-Server ] @@ -47,7 +50,7 @@ Get-MailPublicFolder [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,6 +78,9 @@ This example returns all mail-enabled public folders that begin with the word Ma ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -83,7 +89,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: MailPublicFolderIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -105,7 +113,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -123,7 +133,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -141,7 +153,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -166,7 +180,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -176,6 +189,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -187,7 +203,26 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGrantSendOnBehalfToWithDisplayNames + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -197,6 +232,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -209,7 +247,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,13 +256,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -235,6 +274,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: @@ -248,7 +290,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -258,6 +299,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -273,7 +317,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficATPReport.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficATPReport.md index fa4bcf5443..8c4dd7aca1 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficATPReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficatpreport applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficATPReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailtrafficatpreport +schema: 2.0.0 +title: Get-MailTrafficATPReport --- # Get-MailTrafficATPReport @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-MailTrafficATPReport cmdlet to view the results of Exchange Online Protection and Microsoft Defender for Office 365 detections in your cloud-based organization for the last 90 days. +Use the Get-MailTrafficATPReport cmdlet to view the results of Microsoft Defender for Office 365 detections in your cloud-based organization for the last 90 days. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -35,6 +36,7 @@ Get-MailTrafficATPReport [-ProbeTag ] [-StartDate ] [-SummarizeBy ] + [-ThreatClassification ] [] ``` @@ -51,7 +53,7 @@ For the reporting period you specify, the cmdlet returns the following informati - Verdict Source - Message Count -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,6 +74,9 @@ This example retrieves the statistics for outgoing messages on December 25, 2021 ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -80,7 +85,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -90,13 +94,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Exchange Online Protection + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -106,6 +112,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -118,7 +127,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,13 +136,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +154,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end of the date range in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -157,7 +170,6 @@ If you use this parameter, you also need to use the StartDate parameter. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,6 +179,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - Advanced filter @@ -198,7 +213,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,13 +222,15 @@ Accept wildcard characters: False ``` ### -NumberOfRows + +> Applicable: Exchange Online, Exchange Online Protection + The NumberOfRows parameter specifies the number of rows to return in the report. The maximum value is 10000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -224,13 +240,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -240,13 +258,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -256,13 +276,15 @@ Accept wildcard characters: False ``` ### -PivotBy + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill PivotBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -272,13 +294,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -288,6 +312,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start of the date range in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -301,7 +328,6 @@ If you use this parameter, you also need to use the EndDate parameter. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -311,6 +337,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online, Exchange Online Protection + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. For this cmdlet, valid values are: @@ -326,7 +355,24 @@ You can specify multiple values separated by commas. When you specify the values 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 +``` + +### -ThreatClassification + +> Applicable: Exchange Online, Exchange Online Protection + +{{ Fill ThreatClassification Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficEncryptionReport.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficEncryptionReport.md index 8fe274f754..dc8465437c 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficEncryptionReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficencryptionreport applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-MailTrafficEncryptionReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailtrafficencryptionreport +schema: 2.0.0 +title: Get-MailTrafficEncryptionReport --- # Get-MailTrafficEncryptionReport @@ -46,7 +47,7 @@ For the reporting period you specify, the cmdlet returns the following informati - Message Count - Recipient Count -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +61,9 @@ This example retrieves encryption information for incoming messages between Dece ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -68,7 +72,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -105,7 +113,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -139,7 +151,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - EncryptionManual @@ -162,7 +176,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -220,6 +239,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -228,7 +250,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -238,6 +259,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. For this cmdlet, valid values are: @@ -252,7 +276,6 @@ You can specify multiple values separated by commas. When you specify the values Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficPolicyReport.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficPolicyReport.md index f1ab603a7f..a85f525837 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficPolicyReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficpolicyreport applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficPolicyReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailtrafficpolicyreport +schema: 2.0.0 +title: Get-MailTrafficPolicyReport --- # Get-MailTrafficPolicyReport @@ -48,7 +49,7 @@ For the reporting period you specify, the cmdlet returns the following informati - Direction - Message Count -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -76,6 +77,9 @@ This example is similar to the previous example, but now the results are summari ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -84,7 +88,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,13 +97,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Exchange Online Protection + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -121,7 +129,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The DlpPolicy parameter filters the report by the name of the DLP policy. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -171,7 +185,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,6 +194,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - DLPActionHits @@ -199,7 +215,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -225,13 +242,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -241,13 +260,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,6 +278,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -265,7 +289,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,6 +298,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online, Exchange Online Protection + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. For this cmdlet, valid values are: @@ -292,7 +318,6 @@ You can specify multiple values separated by commas. When you specify the values Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -302,13 +327,15 @@ Accept wildcard characters: False ``` ### -TransportRule + +> Applicable: Exchange Online, Exchange Online Protection + The TransportRule parameter filters the report by the name of the transport rule. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficSummaryReport.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficSummaryReport.md index 5ef4d9692a..652e149273 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficSummaryReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficsummaryreport applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficSummaryReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailtrafficsummaryreport +schema: 2.0.0 +title: Get-MailTrafficSummaryReport --- # Get-MailTrafficSummaryReport @@ -40,7 +41,7 @@ This cmdlet has C1, C2 and C3 as header names and the meaning of them depends on - TopSpamRecipient, TopMailSender, TopMailRecipient and TopMalwareRecipient: C1 is the recipient or sender and C2 the quantity of email messages. - TopMalware: C1 is the malware name and C2 the quantity of appearances. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example shows the top spam recipient statistics between June 13, 2015 and J ## PARAMETERS ### -Category + +> Applicable: Exchange Online, Exchange Online Protection + The Category parameter filters the report by category. Valid values are: - InboundDLPHits @@ -84,7 +88,6 @@ The Category parameter filters the report by category. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,13 +97,15 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The DlpPolicy parameter filters the report by the name of the data loss prevention (DLP) policy. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -134,7 +144,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -176,13 +189,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -192,6 +207,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -200,7 +218,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,13 +227,15 @@ Accept wildcard characters: False ``` ### -TransportRule + +> Applicable: Exchange Online, Exchange Online Protection + The TransportRule parameter filters the report by the name of the transport rule. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailUser.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailUser.md index acaf5fe057..92601103eb 100644 --- a/exchange/exchange-ps/exchange/Get-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailUser.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailuser -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-MailUser -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailuser +schema: 2.0.0 +title: Get-MailUser --- # Get-MailUser ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailUser cmdlet to view mail users and also guest users for Microsoft 365 Groups in cloud environments. @@ -78,7 +79,7 @@ Get-MailUser [-HVEAccount] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,6 +100,9 @@ This example returns detailed information for the mail user named Ed. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail user that you want to view. You can use any value that uniquely identifies the mail user. For example: - Name @@ -112,7 +116,6 @@ The Identity parameter specifies the mail user that you want to view. You can us Type: MailUserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -122,6 +125,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -134,7 +140,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -154,7 +162,6 @@ This parameter requires the creation and passing of a credential object. This cr Type: PSCredential Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,6 +171,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -172,7 +182,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,6 +191,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -197,7 +209,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -207,15 +218,17 @@ Accept wildcard characters: False ``` ### -HVEAccount + +> Applicable: Exchange Online, Exchange Online Protection + 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 +Parameter Sets: HVEAccount Aliases: -Applicable: Exchange Online, Exchange Online Protection Position: Named Default value: None @@ -225,6 +238,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -238,7 +254,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,15 +263,17 @@ Accept wildcard characters: False ``` ### -LOBAppAccount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. -{{ Fill LOBAppAccount Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: LOBAppAccount Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -266,6 +283,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -277,7 +297,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -287,6 +306,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -299,7 +321,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,13 +330,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -325,6 +348,9 @@ Accept wildcard characters: False ``` ### -SharedWithMailUser + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill SharedWithMailUser Description }} @@ -333,7 +359,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -343,6 +368,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -358,7 +386,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -368,6 +395,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailUser + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The SoftDeletedMailUser switch specifies whether to include soft-deleted mail users in the results. You don't need to specify a value with this switch. @@ -378,7 +408,6 @@ Soft-deleted mail users are deleted mail users that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-Mailbox.md similarity index 85% rename from exchange/exchange-ps/exchange/Get-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Mailbox.md index 5e1a74512d..f40d64b16c 100644 --- a/exchange/exchange-ps/exchange/Get-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Mailbox.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-Mailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailbox +schema: 2.0.0 +title: Get-Mailbox --- # Get-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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-Mailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks. @@ -39,6 +40,7 @@ Get-Mailbox [-Anr ] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] [-IncludeGrantSendOnBehalfToWithDisplayNames] [-IncludeInactiveMailbox] [-Migration] @@ -97,6 +99,7 @@ Get-Mailbox [[-Identity] ] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] [-IncludeGrantSendOnBehalfToWithDisplayNames] [-IncludeInactiveMailbox] [-Migration] @@ -149,6 +152,7 @@ Get-Mailbox [-MailboxPlan ] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] [-IncludeGrantSendOnBehalfToWithDisplayNames] [-IncludeInactiveMailbox] [-Migration] @@ -164,7 +168,7 @@ Get-Mailbox [-MailboxPlan ] ## DESCRIPTION When you use the Get-Mailbox cmdlet in on-premises Exchange environments to view the quota settings for a mailbox, you first need to check the value of the UseDatabaseQuotaDefaults property. The value True means per-mailbox quota settings are ignored, and you need to use the Get-MailboxDatabase cmdlet to see the actual values. If the UseDatabaseQuotaDefaults property is False, the per-mailbox quota settings are used, so what you see with the Get-Mailbox cmdlet are the actual quota values for the mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -206,6 +210,9 @@ This example returns information about the remote archive mailbox for the user e ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -225,7 +232,6 @@ You can't use this parameter with the Anr, Database, MailboxPlan or Server param Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -235,6 +241,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -247,7 +256,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -257,6 +265,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Arbitration switch specifies whether to return only arbitration mailboxes in the results. You don't need to specify a value with this switch. @@ -269,7 +280,6 @@ To return arbitration mailboxes that are used to store audit log settings or dat Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -279,13 +289,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Archive switch specifies whether to return only mailboxes that have an archive enabled in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -295,6 +307,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuditLog switch specifies whether to return only audit log mailboxes in the results. You don't need to specify a value with this switch. @@ -307,7 +322,6 @@ To return other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,6 +331,9 @@ Accept wildcard characters: False ``` ### -AuxAuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuxAuditLog switch specifies whether to return only auxiliary audit log mailboxes in the results. You don't need to specify a value with this switch. @@ -329,7 +346,6 @@ To return other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -339,6 +355,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -349,7 +368,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -359,6 +377,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Database parameter filters the results by mailbox database. When you use this parameter, only mailboxes on the specified database are included in the results. You can any value that uniquely identifies the database. For example: @@ -373,7 +394,6 @@ You can't use this parameter with the Anr, Identity, or Server parameters. Type: DatabaseIdParameter Parameter Sets: DatabaseSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -383,6 +403,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -391,7 +414,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -401,6 +423,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -416,7 +441,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -426,13 +450,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GroupMailbox switch specifies whether to return only Microsoft 365 Groups in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -442,6 +468,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -455,7 +484,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -465,6 +493,9 @@ Accept wildcard characters: False ``` ### -InactiveMailboxOnly + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch. @@ -477,7 +508,6 @@ To include active and inactive mailboxes in the results, don't use this switch. Type: SwitchParameter Parameter Sets: AnrSet, Identity, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -487,6 +517,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames Description }} @@ -495,7 +528,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -505,6 +537,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames Description }} @@ -513,7 +548,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -523,6 +557,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeAcceptMessagesOnlyFromWithDisplayNames Description }} @@ -531,7 +568,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -541,6 +577,9 @@ Accept wildcard characters: False ``` ### -IncludeEmailAddressDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeEmailAddressDisplayNames Description }} @@ -549,7 +588,26 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeForwardingAddressWithDisplayNames + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill IncludeForwardingAddressWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: Required: False Position: Named @@ -559,6 +617,9 @@ Accept wildcard characters: False ``` ### -IncludeGrantSendOnBehalfToWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} @@ -567,7 +628,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -577,6 +637,9 @@ Accept wildcard characters: False ``` ### -IncludeInactiveMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch. @@ -589,7 +652,6 @@ To return only inactive mailboxes in the results, don't use this switch. Instead Type: SwitchParameter Parameter Sets: AnrSet, Identity, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -599,6 +661,9 @@ Accept wildcard characters: False ``` ### -MailboxPlan + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example: @@ -617,7 +682,6 @@ You can't use this parameter with the Anr or Identity parameters. Type: MailboxPlanIdParameter Parameter Sets: MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -627,13 +691,15 @@ Accept wildcard characters: False ``` ### -Migration + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Migration switch specifies whether to return only migration mailboxes in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -643,6 +709,9 @@ Accept wildcard characters: False ``` ### -Monitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Monitoring switch specifies whether to return only monitoring mailboxes in the results. You don't need to specify a value with this switch. @@ -653,7 +722,6 @@ Monitoring mailboxes are associated with managed availability and the Exchange H Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -663,6 +731,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -674,7 +745,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -684,6 +754,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublicFolder switch specifies whether to return only public folder mailboxes in the results. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -692,7 +765,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -702,6 +774,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -714,7 +789,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -724,6 +798,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are: - DiscoveryMailbox @@ -744,7 +821,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -754,6 +830,9 @@ Accept wildcard characters: False ``` ### -RemoteArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoteArchive switch specifies whether to return only remote archive mailboxes in the results. You don't need to specify a value with this switch. @@ -764,7 +843,6 @@ Remote archive mailboxes are archive mailboxes in the cloud-based service that a Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -774,13 +852,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -790,6 +870,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Server parameter filters the results by Exchange server. When you use this parameter, only mailboxes on the specified Exchange server are included in the results. @@ -803,7 +886,7 @@ You can use any value that uniquely identifies the server. For example: You can't use this parameter with the Anr, Database, or Identity parameters. -The ServerName and ServerLegacyDN properties for a mailbox may not be updated immediately after a mailbox move within a database availability group (DAG). To get the most up-to-date values for these mailbox properties, run the command `Get-Mailbox | Get-MailboxStatistics | Format-List Name,ServerName,ServerLegacyDN`. +The ServerName and ServerLegacyDN properties for a mailbox might not be updated immediately after a mailbox move within a database availability group (DAG). To get the most up-to-date values for these mailbox properties, run the command `Get-Mailbox | Get-MailboxStatistics | Format-List Name,ServerName,ServerLegacyDN`. **Note**: The result from this parameter could be a legacy value before migration. For better results, use the Database parameter instead. @@ -811,7 +894,6 @@ The ServerName and ServerLegacyDN properties for a mailbox may not be updated im Type: ServerIdParameter Parameter Sets: ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -821,6 +903,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SoftDeletedMailbox switch specifies whether to return only soft-deleted mailboxes in the results. You don't need to specify a value with this switch. @@ -831,7 +916,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: AnrSet, Identity, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -841,6 +925,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -857,7 +944,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -867,6 +953,9 @@ Accept wildcard characters: False ``` ### -SupervisoryReviewPolicy + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -875,7 +964,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxAuditBypassAssociation.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxAuditBypassAssociation.md index 52e699b66f..acbf528c80 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxAuditBypassAssociation.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxauditbypassassociation -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxAuditBypassAssociation -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxauditbypassassociation +schema: 2.0.0 +title: Get-MailboxAuditBypassAssociation --- # Get-MailboxAuditBypassAssociation ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Get-MailboxAuditBypassAssociation cmdlet to retrieve information about the AuditBypassEnabled property value for user accounts (on-premises Exchange and the cloud) and computer accounts (on-premises Exchange only). You use the [Set-MailboxAuditBypassAssociation](https://learn.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation) cmdlet to enable this property to bypass mailbox audit logging. +Use the Get-MailboxAuditBypassAssociation cmdlet to retrieve information about the AuditBypassEnabled property value for user accounts (on-premises Exchange and the cloud) and computer accounts (on-premises Exchange only). You use the [Set-MailboxAuditBypassAssociation](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxauditbypassassociation) cmdlet to enable this property to bypass mailbox audit logging. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -30,7 +31,7 @@ Get-MailboxAuditBypassAssociation [[-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the user account or computer account where you want to view the value of the AuditBypassEnabled property. ```yaml Type: MailboxAuditBypassAssociationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -84,7 +90,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxAutoReplyConfiguration.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxAutoReplyConfiguration.md index 2eaf391e3c..2b46e024e2 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxAutoReplyConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxautoreplyconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxAutoReplyConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxautoreplyconfiguration +schema: 2.0.0 +title: Get-MailboxAutoReplyConfiguration --- # Get-MailboxAutoReplyConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxAutoReplyConfiguration cmdlet to retrieve Automatic Replies settings for a specific mailbox. @@ -35,11 +36,11 @@ You can use the Get-MailboxAutoReplyConfiguration cmdlet to retrieve all the mai - Mailbox identity value - Whether Automatic Replies is enabled, scheduled, or disabled for the mailbox -- Start and end date, time during which Automatic Replies will be sent +- Start and end date, time during which Automatic Replies are sent - Whether external senders receive Automatic Replies (none, known senders, or all) - Automatic Replies message to be sent to internal and external senders -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +61,9 @@ This example retrieves Automatic Replies settings for Tony's mailbox at contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -77,7 +81,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -95,7 +101,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -113,7 +121,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -133,7 +143,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,13 +152,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of settings to return. If you want to return all settings that match the command, use unlimited for the value of this parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -159,6 +170,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -167,7 +181,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarConfiguration.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarConfiguration.md index d8966ce18e..253bb2bb1b 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxcalendarconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxCalendarConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxcalendarconfiguration +schema: 2.0.0 +title: Get-MailboxCalendarConfiguration --- # Get-MailboxCalendarConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxCalendarConfiguration cmdlet to show the calendar settings for a specified mailbox. @@ -52,7 +53,7 @@ The Get-MailboxCalendarConfiguration cmdlet returns settings for the calendar of To see all of the settings returned, pipeline the command to the Format-List command. To view a code sample, see "Example 1." -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,6 +81,9 @@ This example requests that the domain controller DC1 retrieves calendar settings ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -95,9 +99,8 @@ The Identity parameter specifies the mailbox that you want to view. You can use ```yaml Type: MailboxIdParameter -Parameter Sets: Default +Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -106,20 +109,10 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -DomainController -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -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. @@ -128,7 +121,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +130,9 @@ Accept wildcard characters: False ``` ### -MailboxLocation + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MailboxLocation Description }} @@ -146,7 +141,6 @@ This parameter is available only in the cloud-based service. Type: MailboxLocationIdParameter Parameter Sets: MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarFolder.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarFolder.md index 075437cc2c..6a4ba7c36a 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxcalendarfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxCalendarFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxcalendarfolder +schema: 2.0.0 +title: Get-MailboxCalendarFolder --- # Get-MailboxCalendarFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxCalendarFolder cmdlet to retrieve the publishing or sharing settings for a specified mailbox calendar folder. @@ -30,7 +31,7 @@ Get-MailboxCalendarFolder [-Identity] ## DESCRIPTION The Get-MailboxCalendarFolder cmdlet retrieves information for the specified calendar folder. This information includes the calendar folder name, whether the folder is currently published or shared, the start and end range of calendar days published, the level of details published for the calendar, whether the published URL of the calendar can be searched on the web and the published URL for the calendar. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example returns all provided publishing information for the specified calen ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the calendar folder that you want to view. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -79,7 +83,6 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Cal Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -97,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -115,7 +123,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabase.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabase.md index 82286a48e4..1f12278e17 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxdatabase -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxDatabase -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxdatabase +schema: 2.0.0 +title: Get-MailboxDatabase --- # Get-MailboxDatabase @@ -54,7 +55,7 @@ The following list describes the properties that are returned in the results. - Recovery: Specifies whether the new database is designated as a recovery database. - ReplicationType: Replication type of the database. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +74,9 @@ This example returns detailed information about the mailbox database named Mailb ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox database that you want to view. You can use any value that uniquely identifies the database. For example: - Name @@ -85,7 +89,6 @@ If you have multiple databases with the same name, the command retrieves all dat Type: DatabaseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter filters the results by the specified Mailbox server. You can use any value that uniquely identifies the server. For example: - Name @@ -108,7 +114,6 @@ You can't use this parameter with the Identity parameter. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -118,13 +123,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -DumpsterStatistics + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DumpsterStatistics switch specifies that transport dumpster statistics be returned with the database status. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -IncludeCorrupted + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -IncludePreExchange2010 + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IncludePreExchange2010 switch specifies whether to return information about Exchange 2007 ore earlier mailbox databases. You don't need to specify a value with this switch. @@ -174,7 +188,6 @@ The IncludePreExchange2010 switch specifies whether to return information about Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -184,13 +197,15 @@ Accept wildcard characters: False ``` ### -IncludePreExchange2013 + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludePreExchange2013 switch specifies whether to return information about Exchange 2010 or earlier mailbox databases. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Status switch specifies whether to retrieve the available free space in the database root and information about the following attributes: - BackupInProgress @@ -214,7 +232,6 @@ If you specify this switch, you should format the output in such a way that you Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabaseCopyStatus.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabaseCopyStatus.md index d58b4dc67d..14fc9d8aa4 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabaseCopyStatus.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxdatabasecopystatus -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxDatabaseCopyStatus -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxdatabasecopystatus +schema: 2.0.0 +title: Get-MailboxDatabaseCopyStatus --- # Get-MailboxDatabaseCopyStatus @@ -46,7 +47,7 @@ Get-MailboxDatabaseCopyStatus [[-Identity] ] ## DESCRIPTION If a database is specified by using the Identity parameter with the command, the status of all copies of the database is returned. If a server is specified by using the Server parameter with the command, information about all database copies on the server is returned. If neither parameter is specified with the command, information about all database copies in the organization is returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,13 +75,15 @@ This example returns the status for the copy of database DB1 on the Mailbox serv ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the database copy for which the command should gather information. The Identity parameter can be specified in the form of `\`. Specifying just `` returns information for all copies of the database. This parameter can't be combined with the Server parameter. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -90,13 +93,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies that a Mailbox server returns status information for all of its mailbox database copies. This parameter can't be combined with the Identity parameter. ```yaml Type: MailboxServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -Active + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Active switch specifies whether to return mailbox database copy status for the active mailbox database copy only. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -ConnectionStatus -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Local switch specifies whether to return mailbox database copy status information from only the local Mailbox server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -ExtendedErrorInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedErrorInfo switch specifies whether to return an output object containing any exception details. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -UseServerCache + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseServerCache switch specifies whether to enable a server-side remote procedure call (RPC) caching of status information for 5 seconds. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequest.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequest.md index 106407e8e1..c9dfe85b03 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxexportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxExportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxexportrequest +schema: 2.0.0 +title: Get-MailboxExportRequest --- # Get-MailboxExportRequest @@ -63,7 +64,7 @@ Get-MailboxExportRequest [-Mailbox ] ## DESCRIPTION The search criteria for the Get-MailboxExportRequest cmdlet is a Boolean And statement. If you use multiple parameters, you narrow your search and reduce your search results. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -93,11 +94,14 @@ This example returns the status of export requests in the Attachment\_CompanyRep Get-MailboxExportRequest -Name "DB01toPST" -Suspend $true ``` -This example returns all export requests that have the name DB01toPST where the export has been suspended. +This example returns all export requests that have the name DB01toPST where the export is suspended. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). If you specified a name for the export request when the request was created using the New-MailboxExportRequest cmdlet, use the following syntax: `Alias\Name`. Exchange automatically precedes the request with the mailbox's alias. This parameter can't be with the following parameters: @@ -113,7 +117,6 @@ This parameter can't be with the following parameters: Type: MailboxExportRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -123,6 +126,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BatchName parameter specifies the name given to a batch export request. You can't use this parameter with the Identity parameter. @@ -131,7 +137,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,6 +146,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Database parameter specifies the database in which the user's mailbox or archive resides. You can use any value that uniquely identifies the database. For example: @@ -155,7 +163,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -165,13 +172,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: - $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. @@ -192,7 +204,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013 + The Mailbox parameter filters the results by the source mailbox where the contents are being exported from. In Exchange 2016 CU7 or later, this parameter is the type MailboxLocationIdParameter, so the easiest value that you can use to identify the mailbox is the Alias value. @@ -223,9 +237,8 @@ You can't use this parameter with the Identity parameter. ```yaml Type: MailboxOrMailUserIdParameter -Parameter Sets: MailboxFiltering +Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -234,20 +247,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: MailboxLocationFiltering -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -Name -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Name The Name parameter specifies that export requests that have the specified name are returned. Use this parameter to search on the name that you provided when you created the export request. @@ -260,7 +263,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,13 +272,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -286,6 +290,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -301,13 +308,12 @@ The Status parameter filters the results based on status. You can use the follow You can't use this parameter with the Identity parameter. -CompletionInProgress and AutoSuspended don't apply to export requests and won't return any information. +CompletionInProgress and AutoSuspended don't apply to export requests and doesn't return any information. ```yaml Type: RequestStatus Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,6 +323,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -325,7 +334,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -335,6 +343,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -347,7 +358,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequestStatistics.md similarity index 85% rename from exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequestStatistics.md index 27ef9ad06f..20454976c2 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequestStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxexportrequeststatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxExportRequestStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxexportrequeststatistics +schema: 2.0.0 +title: Get-MailboxExportRequestStatistics --- # Get-MailboxExportRequestStatistics @@ -57,7 +58,7 @@ Get-MailboxExportRequestStatistics -RequestQueue ## DESCRIPTION You can pipeline the Get-MailboxExportRequestStatistics cmdlet from the Get-MailboxExportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,14 +88,14 @@ This example returns additional information about the export request for Tony Sm Get-MailboxExportRequestStatistics -MRSInstance CAS01.contoso.com ``` -In Exchange Server 2010, this example returns default statistics for an export request being processed by the instance of MRS running on the server CAS01. This command only returns information for export requests that are currently being processed by an instance of MRS. If the request is already finished, it won't be returned. +In Exchange Server 2010, this example returns default statistics for an export request being processed by the instance of MRS running on the server CAS01. This command only returns information for export requests that are currently being processed by an instance of MRS. If the request is already finished, no information is returned. ### Example 5 ```powershell Get-MailboxExportRequestStatistics -RequestQueue MailboxDatabase01 ``` -This example returns default statistics for an export request being processed by the instance of MRS running on the server CAS01. This command only returns information for export requests currently being processed by an instance of MRS. If the request is already finished, it won't be returned. +This example returns default statistics for an export request being processed by the instance of MRS running on the server CAS01. This command only returns information for export requests currently being processed by an instance of MRS. If the request is already finished, no information is returned. ### Example 6 ```powershell @@ -106,6 +107,9 @@ This example returns additional information for all the export requests that hav ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). If you specified a name for the export request when it was created by using the New-MailboxExportRequest cmdlet, use the following syntax: `Alias\Name`. This parameter can't be used with the RequestGuid or RequestQueue parameters. @@ -114,7 +118,6 @@ This parameter can't be used with the RequestGuid or RequestQueue parameters. Type: MailboxExportRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -MRSInstance + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSInstance parameter specifies the fully qualified domain name (FQDN) of the Client Access server on which the Microsoft Exchange Mailbox Replication service (MRS) resides. When using this parameter, all records are returned for this instance of MRS. @@ -134,7 +140,6 @@ You can't use this parameter with the Identity or RequestQueue parameters. Type: Fqdn Parameter Sets: MRSInstance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is for debugging purposes only. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -158,7 +166,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -168,6 +175,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -176,7 +186,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: Identity, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +195,15 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: String Parameter Sets: Identity, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -210,7 +224,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -220,13 +233,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,13 +251,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,13 +269,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -268,13 +287,15 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestGuid parameter specifies the unique identifier for the export request. To find the export request GUID, use the Get-MailboxExportRequest cmdlet. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter. You can't use this parameter with the Identity parameter. ```yaml Type: Guid Parameter Sets: MRSInstance, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolder.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolder.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-MailboxFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolder.md index 3e9a4e5383..682f41b72f 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolder +schema: 2.0.0 +title: Get-MailboxFolder --- # Get-MailboxFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxFolder cmdlet to view folders in your own mailbox. Administrators can't use this cmdlet to view folders in other mailboxes (the cmdlet is available only from the MyBaseOptions user role). @@ -43,7 +44,7 @@ Get-MailboxFolder [[-Identity] ] ## DESCRIPTION This command checks that the mailbox specified in the Identity parameter is a valid Exchange mailbox before retrieving the requested folders. The cmdlet returns all folders if the MailFolderOnly switch isn't specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -85,6 +86,9 @@ This example returns a summary list of all levels of folders under Inbox in your ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox folder that you want to view. The syntax is `[MailboxID]:[\ParentFolder][\SubFolder]`. You can only run this cmdlet on your own mailbox, so you don't need to (or can't) specify a `MailboxID` value. @@ -110,7 +114,6 @@ Example values for this parameter are `john@contoso.com:`, `John:\Inbox`. Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -GetChildren + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GetChildren switch specifies whether to return only the first level of subfolders under the specified parent folder. You don't need to specify a value with this switch. You can't use this switch with the Recurse switch. @@ -128,7 +134,6 @@ You can't use this switch with the Recurse switch. Type: SwitchParameter Parameter Sets: GetChildren Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -Recurse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Recurse switch specifies whether to return the specified parent folder and all of its subfolders. You don't need to specify a value with this switch. You can't use this switch with the GetChildren switch. @@ -146,7 +154,6 @@ You can't use this switch with the GetChildren switch. Type: SwitchParameter Parameter Sets: Recurse Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -156,6 +163,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -164,7 +174,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -174,13 +183,15 @@ Accept wildcard characters: False ``` ### -MailFolderOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailFolderOnly switch specifies whether to return only the mail folders in the specified mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -190,13 +201,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderPermission.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderPermission.md index 1873b6abc7..5ee63ba381 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderPermission.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxFolderPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderpermission +schema: 2.0.0 +title: Get-MailboxFolderPermission --- # Get-MailboxFolderPermission ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxFolderPermission cmdlet to view folder-level permissions in mailboxes. @@ -34,7 +35,7 @@ Get-MailboxFolderPermission [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example returns the permissions for the Calendar folder in John's mailbox, ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox folder that you want to view. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -83,7 +87,6 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Inb Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -101,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,13 +116,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -135,7 +145,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -SkipCount + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} @@ -153,7 +165,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -171,7 +185,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -181,6 +194,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. For the best results, we recommend using the following values: @@ -201,7 +217,6 @@ Otherwise, you can use any value that uniquely identifies the user or group. For Type: MailboxFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -227,10 +242,10 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxfolderpermission) -[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxfolderpermission) -[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderStatistics.md similarity index 85% rename from exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderStatistics.md index 8b201910e4..dfc0f44929 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderstatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxFolderStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderstatistics +schema: 2.0.0 +title: Get-MailboxFolderStatistics --- # Get-MailboxFolderStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxFolderStatistics cmdlet to retrieve information about the folders in a specified mailbox, including the number and size of items in the folder, the folder name and ID, and other information. @@ -67,7 +68,7 @@ Get-MailboxFolderStatistics -Database -StoreMailboxIdentit ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). A mailbox can have hidden items that are never visible to the user and are only used by applications. The Get-MailboxFolderStatistics cmdlet can return hidden items for the following values: FolderSize, FolderAndSubfolderSize, ItemsInFolder and ItemsInFolderAndSubfolders. @@ -115,6 +116,9 @@ This example uses the FolderScope parameter to view inbox folders statistics for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use any value that uniquely identifies the mailbox or mail user. For example: - Name @@ -130,9 +134,8 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c ```yaml Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: Identity +Parameter Sets: Identity, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -141,20 +144,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: AuditLog -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -Database -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -Database This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -163,7 +156,6 @@ This parameter is reserved for internal Microsoft use. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -173,6 +165,9 @@ Accept wildcard characters: False ``` ### -StoreMailboxIdentity + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -181,7 +176,6 @@ This parameter is reserved for internal Microsoft use. Type: StoreMailboxIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -191,13 +185,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Archive switch specifies whether to return the usage statistics of the archive associated with the mailbox or mail user. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -207,6 +203,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -215,7 +214,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: AuditLog Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +223,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -233,7 +234,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -243,6 +243,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -251,7 +254,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Identity, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,6 +263,9 @@ Accept wildcard characters: False ``` ### -FolderScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FolderScope parameter specifies the scope of the search by folder type. Valid parameter values include: - All @@ -289,7 +294,6 @@ The FolderScope parameter specifies the scope of the search by folder type. Vali Type: ElcFolderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -299,6 +303,9 @@ Accept wildcard characters: False ``` ### -IncludeAnalysis + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeAnalysis switch specifies whether to scan all items within a folder and return statistics related to the folder and item size. You don't need to specify a value with this switch. You should use this switch for troubleshooting purposes, because the command might take a long time to complete. @@ -307,7 +314,6 @@ You should use this switch for troubleshooting purposes, because the command mig Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -317,13 +323,15 @@ Accept wildcard characters: False ``` ### -IncludeOldestAndNewestItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeOldestAndNewestItems switch specifies whether to return the dates of the oldest and newest items in each folder. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -333,6 +341,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted mailboxes in the results. You don't need to specify a value with this switch. @@ -343,7 +354,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -353,6 +363,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -361,7 +374,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -371,6 +383,9 @@ Accept wildcard characters: False ``` ### -SkipCount + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} @@ -379,7 +394,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -389,6 +403,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -397,7 +414,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxIRMAccess.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxIRMAccess.md index ca07bcdfd7..a20f74e575 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxIRMAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxirmaccess applicable: Exchange Online -title: Get-MailboxIRMAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxirmaccess +schema: 2.0.0 +title: Get-MailboxIRMAccess --- # Get-MailboxIRMAccess @@ -32,7 +33,7 @@ Get-MailboxIRMAccess [[-Identity] ] > > Delegates with Full Access permission to the mailbox who don't appear in the results of this cmdlet have access to IRM-protected messages. Only Full Access delegates who are blocked from reading IRM-protected messages in the mailbox appear in the results. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,6 +57,9 @@ This example returns information about delegate Chris' access to IRM-protected m ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox where you want to view delegate access to IRM-protected messages. You can use any value that uniquely identifies the mailbox. For example - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the mailbox where you want to view delegate acc Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + The User parameter filters the results in the mailbox by the specified delegate. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: - Name @@ -100,7 +106,6 @@ The User parameter filters the results in the mailbox by the specified delegate. Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequest.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequest.md index 63f31df6ff..4ee78760e3 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboximportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxImportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboximportrequest +schema: 2.0.0 +title: Get-MailboxImportRequest --- # Get-MailboxImportRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxImportRequest cmdlet to view the detailed status of an ongoing import request that was initiated using the New-MailboxImportRequest cmdlet. @@ -65,7 +66,7 @@ Get-MailboxImportRequest ## DESCRIPTION The search criteria for the Get-MailboxImportRequest cmdlet is a Boolean And statement. If you use multiple parameters, you narrow your search and reduce your search results. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -95,11 +96,14 @@ This example returns the status of import requests in the ImportingDB1PSTs batch Get-MailboxImportRequest -Name "Recovered" -Suspend $true ``` -This example returns all import requests that have the name Recovered where the import has been suspended. +This example returns all import requests that have the name Recovered where the import is suspended. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specify a name for the import request, use the following syntax: `Alias\Name`. Microsoft Exchange automatically precedes the request with the mailbox's alias. You can't use this parameter with the following parameters: @@ -115,7 +119,6 @@ You can't use this parameter with the following parameters: Type: MailboxImportRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -125,6 +128,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter specifies the name given to a batch import request. You can't use this parameter with the Identity parameter. @@ -133,7 +139,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,6 +148,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Database parameter specifies the database in which the user's mailbox or archive resides. You can use any value that uniquely identifies the database. For example: @@ -157,7 +165,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -167,6 +174,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -175,7 +185,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,6 +194,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: @@ -198,7 +210,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,6 +219,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is functional only in on-premises Exchange. The Mailbox parameter filters the results by the destination mailbox where the content is being imported to. @@ -231,9 +245,8 @@ You can't use this parameter with the Identity parameter. ```yaml Type: MailboxOrMailUserIdParameter -Parameter Sets: MailboxFiltering +Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -242,20 +255,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: MailboxLocationFiltering -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Name -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -Name The Name parameter specifies that import requests that have the specified name are returned. Use this parameter to search on the name that you provided when you created the import request. If you didn't specify a name when the request was created, the default name is MailboxImportX (where X = 0-9). @@ -266,7 +269,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -276,13 +278,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -292,6 +296,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -307,13 +314,12 @@ The Status parameter filters the results based on status. You can use the follow You can't use this parameter with the Identity parameter. -CompletionInProgress and AutoSuspended don't apply to import requests and won't return any information. +CompletionInProgress and AutoSuspended don't apply to import requests and doesn't return any information. ```yaml Type: RequestStatus Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -323,6 +329,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -331,7 +340,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -341,6 +349,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -355,7 +366,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequestStatistics.md similarity index 85% rename from exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequestStatistics.md index 5803c36890..7712bbbfc7 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequestStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboximportrequeststatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxImportRequestStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboximportrequeststatistics +schema: 2.0.0 +title: Get-MailboxImportRequestStatistics --- # Get-MailboxImportRequestStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxImportRequestStatistics cmdlet to view detailed information about import requests. @@ -66,7 +67,7 @@ Get-MailboxImportRequestStatistics -RequestQueue ## DESCRIPTION You can pipeline the Get-MailboxImportRequestStatistics cmdlet from the Get-MailboxImportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -108,6 +109,9 @@ This example returns additional information for all the import requests that hav ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specified a name when you created the import request, use the following syntax: `Alias\Name`. **Note**: In Exchange Online, the alias of a soft-deleted mailbox might match the alias of an active mailbox. To ensure uniqueness, use the RequestGuid value from the output of the Get-MailboxImportRequest cmdlet for the value of this parameter. @@ -116,7 +120,6 @@ The Identity parameter specifies the identity of the import request. By default, Type: MailboxImportRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -126,6 +129,9 @@ Accept wildcard characters: False ``` ### -MRSInstance + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSInstance parameter specifies the fully qualified domain name (FQDN) of the Client Access server on which the Microsoft Exchange Mailbox Replication service (MRS) resides. When using this parameter, all records are returned for this instance of MRS. @@ -136,7 +142,6 @@ You can't use this parameter with the Identity or RequestQueue parameters. Type: Fqdn Parameter Sets: MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -146,6 +151,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is for debugging purposes only. @@ -162,7 +170,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -172,6 +179,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -182,7 +192,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,6 +201,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -200,7 +212,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +221,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -218,7 +232,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -228,6 +241,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -236,7 +252,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: IdentityOnPremises, MigrationRequestQueue, MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,13 +261,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,6 +279,9 @@ Accept wildcard characters: False ``` ### -IncludeSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeSkippedItems Description }} @@ -270,7 +290,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -280,6 +299,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestGuid parameter (together with the RequestQueue parameter) specifies the unique identifier for the import request. To find the import request GUID, use the Get-MailboxImportRequest cmdlet. @@ -290,7 +312,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationMRSInstance, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,13 +321,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxJunkEmailConfiguration.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxJunkEmailConfiguration.md index bc4b367757..982e3fe365 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxJunkEmailConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxjunkemailconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxJunkEmailConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxjunkemailconfiguration +schema: 2.0.0 +title: Get-MailboxJunkEmailConfiguration --- # Get-MailboxJunkEmailConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxJunkEmailConfiguration cmdlet to view the junk email settings on mailboxes. @@ -34,7 +35,7 @@ The junk email settings on the mailbox are: - Enable or disable the junk email rule: In on-premises Exchange, the junk email rule (a hidden Inbox rule named Junk E-mail Rule) controls the delivery of messages to the Junk Email folder or the Inbox based on the SCL Junk Email Folder threshold (for the organization or the mailbox) and the safelist collection on the mailbox. - In the cloud-based service, the junk email rule has no effect on mail flow. Exchange Online Protection delivers messages to the Junk Email folder based on the actions set in anti-spam policies. The junk email rule on the mailbox still controls what happens to messages after delivery based on the safelist collection of the mailbox. + In the cloud-based service, the junk email rule has no effect on mail flow. Messages are delivered to the Junk Email folder based on the actions set in anti-spam policies. The junk email rule on the mailbox still controls what happens to messages after delivery based on the safelist collection of the mailbox. Users can enable or disable the junk email rule in their own mailbox by using Outlook on the web. @@ -42,7 +43,7 @@ The junk email settings on the mailbox are: Administrators can enable or disable the junk email rule, and configure the safelist collection on a mailbox by using the Set-MailboxJunkEmailConfiguration cmdlet. For more information, see [Configure Exchange antispam settings on mailboxes](https://learn.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-antispam-settings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ To return all mailboxes where the junk email rule is enabled, change the value $ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -86,7 +90,6 @@ You can use the wildcard character (\*) to identify multiple mailboxes. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -96,6 +99,9 @@ Accept wildcard characters: True ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -104,7 +110,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -122,7 +130,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -142,7 +152,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,13 +161,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxLocation.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxLocation.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-MailboxLocation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxLocation.md index ea42b8a024..d731ec4912 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxLocation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxLocation.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxlocation -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxLocation -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxlocation +schema: 2.0.0 +title: Get-MailboxLocation --- # Get-MailboxLocation ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxLocation cmdlet to view mailbox location information in Exchange Online. @@ -52,7 +53,7 @@ Get-MailboxLocation -User ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +74,9 @@ In Exchange Server or Exchange Online, this example returns the mailbox location ## PARAMETERS ### -Database + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Database parameter returns the mailbox location information for all mailboxes on the specified mailbox database. You can use any value that uniquely identifies the database. For example: @@ -87,7 +91,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: DatabaseSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox location object that you want to view. The value uses the either of the following formats: - TenantGUID\\MailboxGUID @@ -112,7 +118,6 @@ You can't use this parameter with the User parameter. Type: MailboxLocationIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The User parameter specifies the user whose mailbox location you want to view. You can use any value that uniquely identifies the user. For example: @@ -137,7 +145,6 @@ You can't use this parameter with the Identity parameter. Type: UserIdParameter Parameter Sets: User Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -156,7 +166,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -IncludePreviousPrimary + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludePreviousPrimary switch specifies whether to include the previous primary mailbox in the results. You don't need to specify a value with this switch. @@ -176,7 +188,6 @@ You can only use this switch with the User parameter. Type: SwitchParameter Parameter Sets: User Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -MailboxLocationType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailboxLocationType filters the results by the type of mailbox. Valid values are: - Aggregated @@ -200,7 +214,6 @@ The MailboxLocationType filters the results by the type of mailbox. Valid values Type: MailboxLocationType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -210,13 +223,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -226,13 +241,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxMessageConfiguration.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxMessageConfiguration.md index fff93d6e2a..f3e799f010 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxMessageConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxmessageconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxMessageConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxmessageconfiguration +schema: 2.0.0 +title: Get-MailboxMessageConfiguration --- # Get-MailboxMessageConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxMessageConfiguration cmdlet to view the Outlook on the web settings that are applied to specific mailboxes. @@ -37,7 +38,7 @@ The Get-MailboxMessageConfiguration cmdlet shows Outlook on the web settings for > [!NOTE] > The SignatureHtml and SignatureText parameters don't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Currently, the only way to make these parameters work again is to open a support ticket and ask to have Outlook roaming signatures disabled in your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example returns the Outlook on the web settings for Tony's mailbox and spec ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -75,7 +79,6 @@ The Identity parameter specifies the mailbox. You can use any value that uniquel Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Credential parameter specifies the username and password to use to access the mailbox. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -93,7 +99,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -111,7 +119,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -131,7 +141,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -141,13 +150,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -SignatureName + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SignatureName Description }} @@ -165,7 +179,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -175,6 +188,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -183,7 +199,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxPermission.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MailboxPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxPermission.md index a0b437a56d..74ca8ef07c 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxPermission.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxpermission +schema: 2.0.0 +title: Get-MailboxPermission --- # Get-MailboxPermission ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxPermission cmdlet to retrieve permissions on a mailbox. @@ -28,6 +29,7 @@ Get-MailboxPermission [-Identity] [-Owner] [-Credential ] [-DomainController ] [-GroupMailbox] + [-IncludeUserWithDisplayName] [-ReadFromDomainController] [-ResultSize ] [-UseCustomRouting] @@ -42,6 +44,7 @@ Get-MailboxPermission [-Identity] [-User ] [-UseCustomRouting] @@ -61,13 +64,13 @@ By default, the following permissions are assigned to user mailboxes: - FullAccess and ReadPermission are directly assigned to NT AUTHORITY\\SELF. This entry gives a user permission to their own mailbox. - FullAccess is denied to Administrator, Domain Admins, Enterprise Admins and Organization Management. These inherited permissions prevent these users and group members from opening other users' mailboxes. -- ChangeOwner, ChangePermission, DeleteItem, and ReadPermission are allowed for Administrator, Domain Admins, Enterprise Admins and Organization Management. Note that these inherited permission entries also appear to allow FullAccess. However, these users and groups do not have FullAccess to the mailbox because the inherited Deny permission entries override the inherited Allow permission entries. +- ChangeOwner, ChangePermission, DeleteItem, and ReadPermission are allowed for Administrator, Domain Admins, Enterprise Admins and Organization Management. These inherited permission entries also appear to allow FullAccess. However, these users and groups do not have FullAccess to the mailbox because the inherited Deny permission entries override the inherited Allow permission entries. - FullAccess is inherited by NT AUTHORITY\\SYSTEM and ReadPermission is inherited by NT AUTHORITY\\NETWORK. - FullAccess and ReadPermission are inherited by Exchange Servers, ChangeOwner, ChangePermission, DeleteItem, and ReadPermission are inherited by Exchange Trusted Subsystem and ReadPermission is inherited by Managed Availability Servers. By default, other security groups and role groups inherit permissions to mailboxes based on their location (on-premises Exchange or Microsoft 365). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -95,6 +98,9 @@ This example returns the owner information for the resource mailbox Room222. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -112,7 +118,6 @@ The Identity parameter specifies the mailbox you want to view. You can use any v Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -130,7 +138,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -148,7 +158,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. @@ -166,7 +178,6 @@ The GroupMailbox switch is required to return Microsoft 365 Groups in the result Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedUserPermissions + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeSoftDeletedUserPermissions switch returns permissions from soft-deleted mailbox users in the results. You don't need to specify a value with this switch. @@ -186,7 +200,6 @@ Soft-deleted mailboxes are mailboxes that have been deleted, but are still recov Type: SwitchParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -IncludeUnresolvedPermissions + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeUnresolvedPermissions switch returns unresolved permissions in the results. You don't need to specify a value with this switch. @@ -204,7 +220,26 @@ The IncludeUnresolvedPermissions switch returns unresolved permissions in the re Type: SwitchParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeUserWithDisplayName + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill IncludeUserWithDisplayName Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -214,6 +249,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. You can't use this switch with the User parameter. @@ -222,7 +260,6 @@ You can't use this switch with the User parameter. Type: SwitchParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -232,6 +269,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -242,7 +282,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -252,13 +291,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -268,6 +309,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch. @@ -278,7 +322,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -288,6 +331,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -296,7 +342,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -306,6 +351,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The User parameter filters the results by who has permissions to the mailbox that's specified by the Identity parameter. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -336,7 +384,6 @@ You can't use this parameter with the Owner switch. Type: SecurityPrincipalIdParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxPlan.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxPlan.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MailboxPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxPlan.md index c1a6bb560a..34dbb6428e 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxplan applicable: Exchange Online -title: Get-MailboxPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxplan +schema: 2.0.0 +title: Get-MailboxPlan --- # Get-MailboxPlan @@ -34,7 +35,7 @@ Get-MailboxPlan [[-Identity] ] ## DESCRIPTION A mailbox plan is a template that automatically configures mailbox properties. Mailbox plans correspond to license types, and are applied when you license the user. The availability of a mailbox plan is determined by your selections when you enroll in the service and the age of your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example returns detailed information for the mailbox plan that has the disp ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox plan that you want to view. You can use any value that uniquely identifies the mailbox plan. For example: - Name @@ -67,7 +71,6 @@ The Identity parameter specifies the mailbox plan that you want to view. You can Type: MailboxPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AllMailboxPlanReleases + +> Applicable: Exchange Online + The AllMailboxPlanReleases switch specifies whether to include mailbox plans that were used in previous versions of the service in the results. You don't need to specify a value with this switch. If you don't use this switch, the command returns only mailbox plans that are used in the current version of the service. This parameter has meaning only for organizations that were enrolled in previous versions of the service. @@ -85,7 +91,6 @@ If you don't use this switch, the command returns only mailbox plans that are us Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -103,7 +111,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -128,7 +138,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + 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 @@ -170,6 +183,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -184,7 +200,6 @@ You can sort by the following attributes: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRegionalConfiguration.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxRegionalConfiguration.md index 0915467f52..0947fd27bf 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRegionalConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxregionalconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxRegionalConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxregionalconfiguration +schema: 2.0.0 +title: Get-MailboxRegionalConfiguration --- # Get-MailboxRegionalConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxRegionalConfiguration cmdlet to view the regional settings of a mailbox. You can view the date format, time format, time zone, and language of the mailbox. @@ -42,9 +43,9 @@ Get-MailboxRegionalConfiguration [-MailboxLocation ] ``` ## DESCRIPTION -To modify the regional settings of a mailbox, use the [Set-MailboxRegionalConfiguration](https://learn.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration) cmdlet. +To modify the regional settings of a mailbox, use the [Set-MailboxRegionalConfiguration](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxregionalconfiguration) cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,6 +73,9 @@ This example returns the regional settings for Alice Jakobsen's mailbox and also ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -87,9 +91,8 @@ The Identity parameter specifies the mailbox that you want to view. You can use ```yaml Type: MailboxIdParameter -Parameter Sets: (All) +Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -98,20 +101,10 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Archive -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -Archive This parameter is available only in the cloud-based service. {{ Fill Archive Description }} @@ -120,7 +113,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,6 +122,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -138,7 +133,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +142,9 @@ Accept wildcard characters: False ``` ### -MailboxLocation + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MailboxLocation Description }} @@ -156,7 +153,6 @@ This parameter is available only in the cloud-based service. Type: MailboxLocationIdParameter Parameter Sets: MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,6 +162,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -174,7 +173,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -184,6 +182,9 @@ Accept wildcard characters: False ``` ### -VerifyDefaultFolderNameLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The VerifyDefaultFolderNameLanguage switch verifies that the default folder names are localized in the language that's specified for the mailbox (the Language property value). You don't need to specify a value with this switch. The results are displayed in the DefaultFolderNameMatchingUserLanguage property. To see this property, you need to pipeline the results of the command to the Format-List or Format-Table cmdlets. For example: @@ -200,7 +201,6 @@ If you view the DefaultFolderNameMatchingUserLanguage property without using the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRepairRequest.md similarity index 85% rename from exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxRepairRequest.md index d247baf12a..2f7356ae9a 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRepairRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxrepairrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxRepairRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxrepairrequest +schema: 2.0.0 +title: Get-MailboxRepairRequest --- # Get-MailboxRepairRequest @@ -51,7 +52,7 @@ The Get-MailboxRepairRequest cmdlet displays information about mailbox repair re - The status of the repair request; values are Queued, Running, Succeeded and Failed. - The date and time when the mailbox repair request was created and when it finished. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,6 +84,9 @@ This example uses the Database and StoreMailbox parameters to display the Identi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox repair request to display information about. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is `DatabaseGuid\RequestGuid\JobGuid`. You can't use this parameter with the Database or Mailbox parameters. @@ -91,7 +95,6 @@ You can't use this parameter with the Database or Mailbox parameters. Type: StoreIntegrityCheckJobIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Database parameter returns mailbox repair requests for all mailboxes on the specified database. You can use any value that uniquely identifies the database. For example: - Name @@ -113,7 +119,6 @@ You can't use this parameter with the Identity or Mailbox parameters. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Mailbox parameter specifies the mailbox that you want to get mailbox repair request information about. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -142,7 +150,6 @@ You can't use this parameter with the Database or Identity parameters. Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -152,6 +159,9 @@ Accept wildcard characters: False ``` ### -StoreMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StoreMailbox parameter specifies the mailbox GUID of the mailbox that you want to get mailbox repair request information about. Use this parameter with the Database parameter. Use the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. @@ -160,7 +170,6 @@ Use the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. Type: StoreMailboxIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 2 @@ -170,6 +179,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Archive switch displays information about the associated archive mailbox if the archive mailbox was included when the mailbox repair request was created. You don't need to specify a value with this switch. If you don't use this switch, only information about the primary mailbox is returned. @@ -180,7 +192,6 @@ You can't use this switch with the Database parameter. Type: SwitchParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,13 +201,15 @@ Accept wildcard characters: False ``` ### -Detailed + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + Use the Detailed parameter to display mailbox-level repair tasks associated with the repair request. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +219,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequest.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequest.md index 307c4af120..cec72542e6 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxrestorerequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxRestoreRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxrestorerequest +schema: 2.0.0 +title: Get-MailboxRestoreRequest --- # Get-MailboxRestoreRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxRestoreRequest cmdlet to view detailed status of an ongoing restore request that was initiated by using the New-MailboxRestoreRequest cmdlet. @@ -45,7 +46,7 @@ Get-MailboxRestoreRequest [-BatchName ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,11 +76,14 @@ This example returns the status of in-progress and queued restore requests that Get-MailboxRestoreRequest -Name "RestoreToMBD01" -Suspend $true ``` -This example returns all restore requests that have the name RestoreToMBD01 where the restore request has been suspended. +This example returns all restore requests that have the name RestoreToMBD01 where the restore request is suspended. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -90,7 +94,6 @@ You can't use this parameter with the Name parameter. Type: MailboxRestoreRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter specifies the name given to a batch of restore requests. You can't use this parameter with the Identity parameter. @@ -108,7 +114,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -126,7 +134,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: - $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. @@ -147,7 +157,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies that any restore request that has the specified name is returned. Use this parameter to search on the name you provided when you created the restore request. @@ -169,7 +181,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -179,6 +190,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -193,7 +207,6 @@ 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 Required: False Position: Named @@ -203,13 +216,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SourceDatabase parameter specifies that the cmdlet should only return restore requests for mailboxes that are being restored from the specified source database. You can use any value that uniquely identifies the database. For example: @@ -233,7 +251,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,6 +260,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -262,7 +282,6 @@ You can't use this parameter with the Identity parameter. Type: RequestStatus Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -272,6 +291,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -280,7 +302,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -290,6 +311,9 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The TargetDatabase parameter specifies that the cmdlet should only return restore requests for mailboxes that reside on the target database. You can use any value that uniquely identifies the database. For example: @@ -304,7 +328,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -314,6 +337,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetMailbox parameter specifies the identity of the target mailbox. You can use the following values: - GUID @@ -330,7 +356,6 @@ You can't use this parameter with the Identity parameter. Type: MailboxOrMailUserIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequestStatistics.md similarity index 85% rename from exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequestStatistics.md index 08a0693b85..0420909f8f 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequestStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxrestorerequeststatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxRestoreRequestStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxrestorerequeststatistics +schema: 2.0.0 +title: Get-MailboxRestoreRequestStatistics --- # Get-MailboxRestoreRequestStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxRestoreRequestStatistics cmdlet to view detailed information about restore requests. @@ -62,7 +63,7 @@ Get-MailboxRestoreRequestStatistics -RequestQueue ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -104,6 +105,9 @@ This example returns additional information for all the restore requests that ha ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -114,7 +118,6 @@ You can't use this parameter with the MRSInstance or RequestQueue parameters. Type: MailboxRestoreRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -MRSInstance + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSInstance parameter specifies the fully qualified domain name (FQDN) of the Client Access server on which the Microsoft Exchange Mailbox Replication service (MRS) resides. When using this parameter, all records are returned for this instance of MRS. @@ -134,7 +140,6 @@ You can't use this parameter with the Identity or RequestQueue parameters. Type: Fqdn Parameter Sets: MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is for debugging purposes only. @@ -160,7 +168,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -170,13 +177,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +195,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestGuid parameter specifies the unique identifier for the restore request. To find the GUID, use the Get-MailboxRestoreRequest cmdlet. @@ -194,7 +206,6 @@ The RequestGuid parameter specifies the unique identifier for the restore reques Type: Guid Parameter Sets: MigrationMRSInstance, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,6 +215,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -214,7 +228,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,6 +237,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -232,7 +248,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -242,6 +257,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -250,7 +268,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -260,6 +277,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -268,7 +288,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: IdentityOnPremises, MigrationMRSInstance, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -278,6 +297,9 @@ Accept wildcard characters: False ``` ### -IncludeSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeSkippedItems Description }} @@ -286,7 +308,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -296,13 +317,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSearch.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxSearch.md index 3051b480ef..98b2f45979 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxSearch -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxsearch +schema: 2.0.0 +title: Get-MailboxSearch --- # Get-MailboxSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxSearch cmdlet to view mailbox searches that are in progress, complete or stopped. @@ -51,7 +52,7 @@ Get-MailboxSearch -InPlaceHoldIdentity ## DESCRIPTION In on-premises Exchange, a mailbox search is used to perform an In-Place eDiscovery or to place users on an In-Place Hold. Use the Get-MailboxSearch cmdlet to retrieve details of either type of mailbox search. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,7 +70,7 @@ Get-MailboxSearch "Project Hamilton" | Format-List This example retrieves all properties for the mailbox search Project Hamilton. -The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). +The Identity parameter is positional, which means you can use it without the -Identity label in the supported location in the command (in this case, first). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). ### Example 3 ```powershell @@ -83,6 +84,9 @@ This example retrieves the In-Place Holds that a user is placed on. The first co ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the search query. If a name isn't provided, all mailbox search queries are returned. To improve the performance of this cmdlet in Exchange Online, some mailbox search properties aren't returned if you don't specify the name of a mailbox search. These properties are: @@ -98,9 +102,8 @@ To view these properties, you have to provide the name of a mailbox search. ```yaml Type: SearchObjectIdParameter -Parameter Sets: EwsStoreObjectIdentity +Parameter Sets: EwsStoreObjectIdentity, SearchObjectIdentity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -109,27 +112,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: SearchObjectIdParameter -Parameter Sets: SearchObjectIdentity -Aliases: -Applicable: Exchange Server 2010 +### -InPlaceHoldIdentity -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -InPlaceHoldIdentity The InPlaceHoldIdentity parameter specifies the GUID of an In-Place Hold. Use this parameter to search for an In-Place Hold that a user is placed on. GUIDs of all In-Place Holds that a user is placed on are added to the user's InPlaceHolds property. You can retrieve the property by using the Get-Mailbox cmdlet. ```yaml Type: String Parameter Sets: InPlaceHoldIdentity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -139,6 +131,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -147,7 +142,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +151,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -173,13 +169,15 @@ Accept wildcard characters: False ``` ### -ShowDeletionInProgressSearches + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: EwsStoreObjectIdentity, InPlaceHoldIdentity 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-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSentItemsConfiguration.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxSentItemsConfiguration.md index 0db5f4e4f3..6ed02a5bdc 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSentItemsConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxsentitemsconfiguration applicable: Exchange Server 2010 -title: Get-MailboxSentItemsConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxsentitemsconfiguration +schema: 2.0.0 +title: Get-MailboxSentItemsConfiguration --- # Get-MailboxSentItemsConfiguration @@ -29,7 +30,7 @@ Get-MailboxSentItemsConfiguration [-DomainController ] ## DESCRIPTION By default, when you use Send As or Send On Behalf Of to send a message from another mailbox, the message is saved in your Sent Items folder (not in the Sent Items folder of the source mailbox). In Microsoft Exchange Server 2010 Service Pack 3 (SP3), you can save copies messages in the Sent Items folder of the sender and the source mailbox. For example, consider a shared mailbox that receives customer feedback and is monitored by multiple users. When someone responds to a message in the shared mailbox, you can save the message in the Sent Items folder of the shared mailbox and the sender's mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example returns the Sent Items configuration for the shared mailbox named " ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the mailbox whose Sent Items configuration you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -76,7 +82,6 @@ The Identity parameter specifies the mailbox whose Sent Items configuration you Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxServer.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-MailboxServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxServer.md index 7b2886ee8a..ec9c99d48b 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxserver -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxServer -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxserver +schema: 2.0.0 +title: Get-MailboxServer --- # Get-MailboxServer @@ -30,7 +31,7 @@ Get-MailboxServer [[-Identity] ] ## DESCRIPTION The ExchangeVersion attribute returned is the minimum version of Microsoft Exchange that you can use to manage the returned object. This attribute isn't the same as the version of Microsoft Exchange that's displayed in the Exchange admin center when you select Server Configuration. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example returns detailed information about the Mailbox server named Server1 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Mailbox server that you want to view. You can use any value that uniquely identifies the Mailbox server. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the Mailbox server that you want to view. You c Type: MailboxServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Status switch specifies whether to include additional property values in the results, for example, the Locale value. You don't need to specify a value with this switch. To see the additional values, you need to pipe the output to a formatting cmdlet, for example, the Format-List cmdlet. @@ -95,7 +103,6 @@ To see the additional values, you need to pipe the output to a formatting cmdlet Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSpellingConfiguration.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxSpellingConfiguration.md index 711e199b87..ba8137229d 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSpellingConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxspellingconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxSpellingConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxspellingconfiguration +schema: 2.0.0 +title: Get-MailboxSpellingConfiguration --- # Get-MailboxSpellingConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxSpellingConfiguration cmdlet to retrieve the Outlook on the web spelling checker settings of a specified user. For example, users can set their dictionary language and configure the spelling checker to ignore mixed digits and words in all uppercase. @@ -34,7 +35,7 @@ The Get-MailboxSpellingConfiguration cmdlet is primarily used to populate the sp - DictionaryLanguage: This setting specifies the dictionary language used when the spelling checker checks the spelling in messages. - IgnoreMixedDigits: This setting specifies whether the spelling checker ignores words that contain numbers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example returns the Outlook on the web spelling checker options for Tony's ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -79,7 +83,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -97,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxStatistics.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-MailboxStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxStatistics.md index 364729d637..6d6ca0714b 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxstatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxstatistics +schema: 2.0.0 +title: Get-MailboxStatistics --- # Get-MailboxStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxStatistics cmdlet to return information about a mailbox, such as the size of the mailbox, the number of messages it contains, and the last time it was accessed. In addition, you can get the move history or a move report of a completed move request. @@ -74,7 +75,7 @@ You can only see move reports and move history for completed move requests. **Note**: We're deprecating the LastUserActionTime property in Exchange Online PowerShell. Don't use the value of that property as the last active time for a mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -134,7 +135,7 @@ $temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveHistory $temp.MoveHistory[0] ``` -This example returns the detailed move history for the completed move request for Ayla Kol's mailbox. This example uses a temporary variable to store the mailbox statistics object. If the mailbox has been moved multiple times, there are multiple move reports. The last move report is always MoveReport[0]. +This example returns the detailed move history for the completed move request for Ayla Kol's mailbox. This example uses a temporary variable to store the mailbox statistics object. If the mailbox is moved multiple times, there are multiple move reports. The last move report is always MoveReport[0]. ### Example 9 ```powershell @@ -148,6 +149,9 @@ This example returns the detailed move history and a verbose detailed move repor ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to return statistics for. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -165,7 +169,6 @@ The Identity parameter specifies the mailbox that you want to return statistics Type: GeneralMailboxOrMailUserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -175,6 +178,9 @@ Accept wildcard characters: False ``` ### -StoreMailboxIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The StoreMailboxIdentity parameter specifies the mailbox identity when used with the Database parameter to return statistics for a single mailbox on the specified database. You can use one of the following values: @@ -188,7 +194,6 @@ Use this syntax to retrieve information about disconnected mailboxes, which don' Type: StoreMailboxIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -198,13 +203,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Archive switch specifies whether to return mailbox statistics for the archive mailbox that's associated with the mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -214,6 +221,9 @@ Accept wildcard characters: False ``` ### -CopyOnServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CopyOnServer parameter is used to retrieve statistics from a specific database copy on the specified server. @@ -231,7 +241,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: Database, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +250,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Database parameter returns statistics for all mailboxes on the specified database. You can use any value that uniquely identifies the database. For example: @@ -255,7 +267,6 @@ This parameter accepts pipeline input from the Get-MailboxDatabase cmdlet. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -265,6 +276,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -273,7 +287,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -283,6 +296,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. @@ -302,7 +318,6 @@ For example, to display all disconnected mailboxes on a specific mailbox databas Type: String Parameter Sets: Database, Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -312,13 +327,15 @@ Accept wildcard characters: False ``` ### -IncludeMoveHistory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeMoveHistory switch specifies whether to return additional information about the mailbox that includes the history of a completed move request, such as status, flags, target database, bad items, start times, end times, duration that the move request was in various stages, and failure codes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -328,6 +345,9 @@ Accept wildcard characters: False ``` ### -IncludeMoveReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeMoveReport switch specifies whether to return a verbose detailed move report for a completed move request, such as server connections and move stages. You don't need to specify a value with this switch. Because the output of this command is verbose, you should send the output to a .CSV file for easier analysis. @@ -336,7 +356,6 @@ Because the output of this command is verbose, you should send the output to a . Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -346,6 +365,9 @@ Accept wildcard characters: False ``` ### -IncludePassive + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IncludePassive switch specifies whether to return statistics from all active and passive database copies. You don't need to specify a value with this switch. @@ -356,7 +378,6 @@ If you don't use this switch, the command retrieves statistics from active datab Type: SwitchParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -366,6 +387,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted mailboxes in the results. You don't need to specify a value with this switch. @@ -376,7 +400,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -386,6 +409,9 @@ Accept wildcard characters: False ``` ### -IncludeQuarantineDetails + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IncludeQuarantineDetails switch specifies whether to return additional quarantine details about the mailbox that aren't otherwise included in the results. You can use these details to determine when and why the mailbox was quarantined. You don't need to specify a value with this switch. @@ -396,7 +422,6 @@ Specifically, this switch returns the values of the QuarantineDescription, Quara Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,6 +431,9 @@ Accept wildcard characters: False ``` ### -NoADLookup + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The NoADLookup switch specifies that information is retrieved from the mailbox database, and not from Active Directory. You don't need to specify a value with this switch. @@ -416,7 +444,6 @@ This switch helps improve cmdlet performance when querying a mailbox database th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -426,6 +453,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Server parameter specifies the server from which you want to obtain mailbox statistics. You can use one of the following values: @@ -439,7 +469,6 @@ When you specify a value for the Server parameter, the command returns statistic Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -449,6 +478,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -457,7 +489,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxTransportService.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxTransportService.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-MailboxTransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxTransportService.md index 4e4beb49a3..6baf5e6e72 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxTransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxTransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxtransportservice -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxTransportService -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxtransportservice +schema: 2.0.0 +title: Get-MailboxTransportService --- # Get-MailboxTransportService @@ -29,7 +30,7 @@ Get-MailboxTransportService [[-Identity] ] ## DESCRIPTION The Mailbox Transport service runs on all Mailbox servers and is responsible for delivering messages to and accepting messages from local mailbox databases using remote procedure calls (RPC). The Mailbox Transport service also uses SMTP to send messages to and from the Transport service that runs on all Mailbox servers for routing their ultimate destinations. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example retrieves the detailed transport configuration information for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server that you want to view. ```yaml Type: MailboxTransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxUserConfiguration.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxUserConfiguration.md index 6487e6dc0e..20cc71b95a 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxUserConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxuserconfiguration -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxUserConfiguration -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxuserconfiguration +schema: 2.0.0 +title: Get-MailboxUserConfiguration --- # Get-MailboxUserConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MailboxUserConfiguration cmdlet to view user configuration items in mailboxes. @@ -29,7 +30,7 @@ Get-MailboxUserConfiguration [-Identity] - ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example returns detailed information for the specified user configuration i ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the user configuration item that you want to view. This parameter uses the syntax MailboxFolder\ItemName: - Valid values for MailboxFolder are folder names (for example, Inbox or Calendar), the value Configuration, or the value Root. Wildcards (\*) aren't supported. @@ -59,7 +63,6 @@ The Identity parameter specifies the user configuration item that you want to vi Type: MailboxUserConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the user configuration items you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -86,7 +92,6 @@ The Mailbox parameter specifies the mailbox that contains the user configuration Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -120,7 +130,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterPolicy.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterPolicy.md index 077860de6f..fe9000d741 100644 --- a/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-malwarefilterpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-MalwareFilterPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-malwarefilterpolicy +schema: 2.0.0 +title: Get-MalwareFilterPolicy --- # Get-MalwareFilterPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MalwareFilterPolicy cmdlet to view the malware filter policies in your organization. @@ -29,7 +30,7 @@ Get-MalwareFilterPolicy [[-Identity] ] ## DESCRIPTION Malware filter policies contain the malware settings and a list of domains to which those settings apply. A domain can't belong to more than one malware filter policy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example retrieves detailed configuration information for the malware filter ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter policy that you want to view. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the malware filter policy. ```yaml Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterRule.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterRule.md index d8b421d6ef..7b16455434 100644 --- a/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-malwarefilterrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-MalwareFilterRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-malwarefilterrule +schema: 2.0.0 +title: Get-MalwareFilterRule --- # Get-MalwareFilterRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Enable-MalwareFilterRule cmdlet to view malware filter rules in your organization. @@ -28,7 +29,7 @@ Get-MalwareFilterRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example retrieves detailed configuration information for the malware filter ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -73,7 +79,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The State parameter filters the results by enabled or disabled malware filter rules. Valid input for this parameter is Enabled or Disabled. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilteringServer.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilteringServer.md index 11a67a8298..53a20c6cae 100644 --- a/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilteringServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-malwarefilteringserver -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MalwareFilteringServer -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-malwarefilteringserver +schema: 2.0.0 +title: Get-MalwareFilteringServer --- # Get-MalwareFilteringServer @@ -27,7 +28,7 @@ Get-MalwareFilteringServer [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example returns the detailed Exchange Malware agent settings on a Mailbox s ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server where you want to view the anti-malware settings. You can use any value that uniquely identifies the server. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the server where you want to view the anti-malw Type: MalwareFilteringServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -77,7 +83,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedContentSettings.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-ManagedContentSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagedContentSettings.md index 543f807e2a..3363cb27c8 100644 --- a/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedContentSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managedcontentsettings applicable: Exchange Server 2010 -title: Get-ManagedContentSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managedcontentsettings +schema: 2.0.0 +title: Get-ManagedContentSettings --- # Get-ManagedContentSettings @@ -39,7 +40,7 @@ The Get-ManagedContentSettings cmdlet retrieves from one to all of the managed c If only the Identity parameter is present, the folder content settings and all associated attributes are returned. If the Identity parameter isn't present, the command returns all content settings. If the FolderName parameter is present, the command returns all content settings contained in the specified managed folder and all the attributes of each setting. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example retrieves the managed content settings for the managed folder Inbox ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the set of managed content settings. When used, this command retrieves the folder content settings and all associated attributes. This parameter can't be used with the FolderName parameter. @@ -75,7 +79,6 @@ This parameter can't be used with the FolderName parameter. Type: ELCContentSettingsIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -FolderName + +> Applicable: Exchange Server 2010 + The FolderName parameter specifies the name or GUID of the managed folder to which the managed content settings apply. When used, this command retrieves all the policies that apply to that folder. This parameter can't be used with the Identity parameter. @@ -109,7 +117,6 @@ This parameter can't be used with the Identity parameter. Type: ELCFolderIdParameter Parameter Sets: FolderName Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagedFolder.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolder.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-ManagedFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolder.md index f7a6302c2b..603b909fa6 100644 --- a/exchange/exchange-ps/exchange/Get-ManagedFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managedfolder applicable: Exchange Server 2010 -title: Get-ManagedFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managedfolder +schema: 2.0.0 +title: Get-ManagedFolder --- # Get-ManagedFolder @@ -43,7 +44,7 @@ The Get-ManagedFolder cmdlet retrieves the specified managed folder attributes: The Get-ManagedFolder cmdlet accepts a ManagedFolder object or an identity string as pipelined input. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +58,15 @@ This example retrieves information about the managed folder MyManagedFolder. The ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder. ```yaml Type: ELCFolderIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010 + The Mailbox parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -108,7 +116,6 @@ This cmdlet retrieves all the folders that apply to the specified mailbox. Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolderMailboxPolicy.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolderMailboxPolicy.md index 773b53f264..04ff9158a5 100644 --- a/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolderMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managedfoldermailboxpolicy applicable: Exchange Server 2010 -title: Get-ManagedFolderMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managedfoldermailboxpolicy +schema: 2.0.0 +title: Get-ManagedFolderMailboxPolicy --- # Get-ManagedFolderMailboxPolicy @@ -29,7 +30,7 @@ Get-ManagedFolderMailboxPolicy [[-Identity] ] ## DESCRIPTION A managed folder mailbox policy is a logical grouping of one or more managed folders. Policies are applied to mailboxes. The Get-ManagedFolderMailboxPolicy cmdlet lists one or more managed folder mailbox policies created in the Microsoft Exchange Server 2010 organization. All policies can be listed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,18 +41,20 @@ Get-ManagedFolderMailboxPolicy "PM Storage Template" This example returns all the attributes of the managed folder mailbox policy PM Storage Template. -The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). +The Identity parameter is positional, which means you can use it without the -Identity label in the supported location in the command (in this case, first). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagementRole.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRole.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-ManagementRole.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagementRole.md index 72a4c467e8..c5b12d0a70 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRole.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managementrole -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-ManagementRole -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managementrole +schema: 2.0.0 +title: Get-ManagementRole --- # Get-ManagementRole ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ManagementRole cmdlet to view management roles that have been created in your organization. @@ -63,7 +64,7 @@ You can view management roles in several ways, from listing all the roles in you For more information about management roles, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -112,13 +113,15 @@ This example lists the immediate children of the Mail Recipients role. Only the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role you want to view. If the role you want to view contains spaces, enclose the name in quotation marks ("). You can use the wildcard character (\*) and a partial role name to match multiple roles. ```yaml Type: RoleIdParameter -Parameter Sets: GetChildren, Recurse +Parameter Sets: GetChildren, Recurse, Identity, Script Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -127,20 +130,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: RoleIdParameter -Parameter Sets: Identity, Script -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection +### -GetChildren -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection -### -GetChildren The GetChildren parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. You don't need to specify a value with this switch. Only the immediate child roles of the parent role are included in the results. @@ -151,7 +144,6 @@ You can use this switch only with the Identity and RoleType parameters. Type: SwitchParameter Parameter Sets: GetChildren Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -161,6 +153,9 @@ Accept wildcard characters: False ``` ### -Recurse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Recurse parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. You don't need to specify a value with this switch. The role specified in the Identity parameter, its child roles, and their children are returned. @@ -171,7 +166,6 @@ You can use this switch only with the Identity and RoleType parameters. Type: SwitchParameter Parameter Sets: Recurse Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -181,13 +175,15 @@ Accept wildcard characters: False ``` ### -Cmdlet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Cmdlet parameter returns a list of all roles that include the specified cmdlet. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -197,13 +193,15 @@ Accept wildcard characters: False ``` ### -CmdletParameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The CmdletParameters parameter returns a list of all roles that include the specified parameter or parameters. You can specify more than one parameter by separating each parameter with a comma. If you specify multiple parameters, only the roles that include all of the specified parameters are returned. ```yaml Type: String[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -213,6 +211,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -221,7 +222,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -231,13 +231,15 @@ Accept wildcard characters: False ``` ### -RoleType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). ```yaml Type: RoleType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -247,13 +249,15 @@ Accept wildcard characters: False ``` ### -Script + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Script parameter returns a list of all roles that include the specified script. ```yaml Type: String Parameter Sets: Script Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -263,13 +267,15 @@ Accept wildcard characters: False ``` ### -ScriptParameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ScriptParameters parameter returns a list of all roles that include the specified parameter or parameters. You can specify more than one parameter by separating each parameter with a comma. If you specify multiple parameters, only the roles that include all of the specified parameters are returned. ```yaml Type: String[] Parameter Sets: Script Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleAssignment.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleAssignment.md index 574baae033..c9ef714304 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleAssignment.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managementroleassignment -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-ManagementRoleAssignment -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managementroleassignment +schema: 2.0.0 +title: Get-ManagementRoleAssignment --- # Get-ManagementRoleAssignment ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ManagementRoleAssignment cmdlet to retrieve management role assignments. @@ -75,7 +76,7 @@ You can retrieve role assignments in a variety of ways including by assignment t For more information about management role assignments, see [Understanding management role assignments](https://learn.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -131,13 +132,15 @@ This example retrieves all the role assignments that can modify the database Con ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the role assignment to retrieve. If the name of the role assignment contains spaces, enclose it in quotation marks ("). If the RoleAssignee parameter is used, you can't use the Identity parameter. ```yaml Type: RoleAssignmentIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -147,6 +150,9 @@ Accept wildcard characters: False ``` ### -AssignmentMethod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AssignmentMethod parameter specifies the type of role assignment to include in the results returned by the cmdlet. You can specify one or more of the following values: - Direct @@ -162,7 +168,6 @@ You must specify a value with the RoleAssignee parameter if you use the Assignme Type: AssignmentMethod[] Parameter Sets: RoleAssignee Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,13 +177,15 @@ Accept wildcard characters: False ``` ### -ConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConfigWriteScope parameter specifies the type of management configuration scope to include in the results returned by the cmdlet. The valid values are None, OrganizationConfig, CustomConfigScope, and ExclusiveConfigScope. ```yaml Type: ConfigWriteScopeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -188,6 +195,9 @@ Accept wildcard characters: False ``` ### -CustomConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CustomConfigWriteScope parameter returns only the regular role assignments that include the specified configuration-based regular scope. @@ -200,7 +210,6 @@ If the scope name contains spaces, enclose it in quotation marks ("). Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +219,9 @@ Accept wildcard characters: False ``` ### -CustomRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomRecipientWriteScope parameter returns only the regular role assignments that include the specified recipient-based regular scope. This parameter can only be used to retrieve regular recipient-based scopes. To retrieve a list of exclusive recipient-based scopes, use the ExclusiveRecipientWriteScope parameter instead. @@ -220,7 +232,6 @@ If the scope name contains spaces, enclose it in quotation marks ("). Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -230,6 +241,9 @@ Accept wildcard characters: False ``` ### -Delegating + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Delegating parameter specifies whether delegating or regular role assignments should be returned. By default, both delegating and regular scopes are returned. To return only delegating role assignments, specify a value of $true. To return only regular role assignments, specify a value of $false. @@ -238,7 +252,6 @@ By default, both delegating and regular scopes are returned. To return only dele Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,6 +261,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -256,7 +272,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -266,13 +281,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether enabled or disabled role assignments should be returned. To return enabled role assignments, specify a value of $true. To return disabled role assignments, specify a value of $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -282,6 +299,9 @@ Accept wildcard characters: False ``` ### -Exclusive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Exclusive parameter specifies whether exclusive or regular role assignments should be returned. By default, both exclusive and regular scopes are returned. To return only exclusive role assignments, specify a value of $true. To return only regular role assignments, specify a value of $false. @@ -290,7 +310,6 @@ By default, both exclusive and regular scopes are returned. To return only exclu Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,6 +319,9 @@ Accept wildcard characters: False ``` ### -ExclusiveConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ExclusiveConfigWriteScope parameter returns only the exclusive role assignments that include the specified configuration-based exclusive scope. @@ -312,7 +334,6 @@ If the scope name contains spaces, enclose it in quotation marks ("). Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,6 +343,9 @@ Accept wildcard characters: False ``` ### -ExclusiveRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExclusiveRecipientWriteScope parameter returns only the exclusive role assignments that include the specified recipient-based exclusive scope. This parameter can only be used to retrieve exclusive recipient-based scopes. To retrieve a list of regular recipient-based scopes, use the CustomRecipientWriteScope parameter instead. @@ -332,7 +356,6 @@ If the scope name contains spaces, enclose it in quotation marks ("). Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -342,6 +365,9 @@ Accept wildcard characters: False ``` ### -GetEffectiveUsers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The GetEffectiveUsers switch specifies that the command should show the list of users in the role groups, role assignment policies, or USGs that are associated with the role assignment. You don't need to specify a value with this switch. Effectively, users are associated with the role assignment through their role group, role assignment policy, or USG memberships. @@ -350,7 +376,6 @@ Effectively, users are associated with the role assignment through their role gr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -360,6 +385,9 @@ Accept wildcard characters: False ``` ### -RecipientAdministrativeUnitScope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The RecipientAdministrativeUnitScope parameter returns only the role assignments that include the specified administrative unit. @@ -370,7 +398,6 @@ Administrative units are Microsoft Entra containers of resources. You can view t Type: AdministrativeUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -380,6 +407,9 @@ Accept wildcard characters: False ``` ### -RecipientGroupScope + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecipientGroupScope parameter returns only the role assignments that are scoped to groups. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, DisplayName. @@ -388,7 +418,6 @@ The RecipientGroupScope parameter returns only the role assignments that are sco Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -398,13 +427,15 @@ Accept wildcard characters: False ``` ### -RecipientOrganizationalUnitScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientOrganizationalUnitScope parameter returns only the role assignments that include the specified organizational unit (OU). If the OU tree contains spaces, enclose it in quotation marks ("). ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -414,13 +445,15 @@ Accept wildcard characters: False ``` ### -RecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientWriteScope parameter returns only the role assignments associated with the recipient scope restriction type specified. The valid values are None, MyGAL, Self, OU, CustomRecipientScope, MyDistributionGroups and ExclusiveRecipientScope. ```yaml Type: RecipientWriteScopeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -430,13 +463,15 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Role parameter returns only the role assignments associated with the specified management role. If the name of the role contains spaces, enclose it in quotation marks ("). ```yaml Type: RoleIdParameter Parameter Sets: RoleAssignee Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -446,6 +481,9 @@ Accept wildcard characters: False ``` ### -RoleAssignee + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RoleAssignee parameter specifies the role group, assignment policy, user, or universal security group (USG) for which you want to view role assignments. If the RoleAssignee parameter is used, you can't use the Identity parameter. By default, the command returns both direct role assignments to the role assignee and indirect role assignments granted to a role assignee through role groups or assignment policies. @@ -456,7 +494,6 @@ If the name of the user or USG contains spaces, enclose it in quotation marks (" Type: RoleAssigneeIdParameter Parameter Sets: RoleAssignee Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -466,13 +503,15 @@ Accept wildcard characters: False ``` ### -RoleAssigneeType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RoleAssigneeType parameter specifies the type of role assignee to return. The valid values are User, SecurityGroup, RoleAssignmentPolicy, ForeignSecurityPrincipal, RoleGroup, LinkedRoleGroup and Computer. ```yaml Type: RoleAssigneeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -482,6 +521,9 @@ Accept wildcard characters: False ``` ### -WritableDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The WritableDatabase parameter specifies the database object you want to test to determine which role assignments allow it to be modified. The command takes into account the roles and scopes associated with each role assignment. You can use any value that uniquely identifies the database. For example: @@ -496,7 +538,6 @@ If you use this parameter with the GetEffectiveUsers switch, all the users who c Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -506,6 +547,9 @@ Accept wildcard characters: False ``` ### -WritableRecipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WritableRecipient parameter specifies the recipient object you want to test to determine which role assignments allow it to be modified. The command takes into account the roles and scopes associated with each role assignment. If the recipient name contains spaces, enclose it in quotation marks ("). If this parameter is used with the GetEffectiveUsers switch, all of the users who can modify the recipient object indirectly through role groups and USGs are also returned. Without the GetEffectiveUsers switch, only the role groups, users and USGs directly assigned the role assignment are returned. @@ -514,7 +558,6 @@ If this parameter is used with the GetEffectiveUsers switch, all of the users wh Type: GeneralRecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -524,6 +567,9 @@ Accept wildcard characters: False ``` ### -WritableServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The WritableServer parameter specifies the server object you want to test to determine which role assignments allow it to be modified. The command takes into account the roles and scopes associated with each role assignment. @@ -541,7 +587,6 @@ If this parameter is used with the GetEffectiveUsers switch, all of the users wh Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleEntry.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleEntry.md index 8ba8cccb05..2653a15989 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleEntry.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managementroleentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-ManagementRoleEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managementroleentry +schema: 2.0.0 +title: Get-ManagementRoleEntry --- # Get-ManagementRoleEntry ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ManagementRoleEntry cmdlet to retrieve management role entries that have been configured on management roles. @@ -35,7 +36,7 @@ The Get-ManagementRoleEntry cmdlet retrieves role entries that have been configu For more information about management role entries, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,6 +64,9 @@ This example retrieves the Tier 2 Help Desk\\Set-Mailbox role entry and pipes th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the role entry that you want to view. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). @@ -75,7 +79,6 @@ If the role entry name contains spaces, enclose the name in quotation marks ("). Type: RoleEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -93,7 +99,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Parameters parameter includes only the role entries that contain the parameters specified. You can specify multiple parameters, separated by commas. You can use the wildcard character (\*) with partial parameter names to retrieve all parameters that match the value you specify. This parameter is useful when you use the wildcard character (\*) with the value you specify in the Identity parameter. @@ -111,7 +119,6 @@ This parameter is useful when you use the wildcard character (\*) with the value Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -PSSnapinName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PSSnapinName parameter specifies the Windows PowerShell snap-in that contains the role entry to return. Use the Get-PSSnapin cmdlet to retrieve a list of available Windows PowerShell snap-ins. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -145,7 +157,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Type parameter specifies the type of role entry to return. The valid values for the Type parameter are any combination of the following parameters, separated by commas: Cmdlet, Script and ApplicationPermission. ```yaml Type: ManagementRoleEntryType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagementScope.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementScope.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-ManagementScope.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagementScope.md index 38673e7eda..3b5949b7df 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementScope.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managementscope -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-ManagementScope -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managementscope +schema: 2.0.0 +title: Get-ManagementScope --- # Get-ManagementScope ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ManagementScope cmdlet to return a list of management scopes. @@ -33,7 +34,7 @@ You can retrieve one scope or many, retrieve only scopes that aren't associated For more information about regular and exclusive scopes, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,13 +69,15 @@ This example retrieves a list of exclusive scopes. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the management scope to return. If the management scope name contains spaces, enclose it in quotation marks ("). ```yaml Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -92,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -Exclusive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Exclusive parameter specifies whether exclusive scopes should be returned. If the Exclusive parameter isn't specified, regular scopes and exclusive scopes are returned. If the Exclusive parameter is set to $True, only exclusive scopes are returned. If the Exclusive parameter is set to $False, only regular scopes are returned. The valid values are $True and $False. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -Orphan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Orphan switch specifies whether to return only management scopes that aren't associated with role assignments. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-MapiVirtualDirectory.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MapiVirtualDirectory.md index 77a025f2c7..572f31c8f5 100644 --- a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MapiVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mapivirtualdirectory -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MapiVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mapivirtualdirectory +schema: 2.0.0 +title: Get-MapiVirtualDirectory --- # Get-MapiVirtualDirectory @@ -39,7 +40,7 @@ Get-MapiVirtualDirectory [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,6 +72,9 @@ This example returns a summary list of all MAPI virtual directories in the clien ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the MAPI virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -85,7 +89,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -108,7 +114,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -126,7 +134,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +143,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. @@ -164,7 +176,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Message.md b/exchange/exchange-ps/ExchangePowerShell/Get-Message.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Message.md index 634425d077..3ce55a4842 100644 --- a/exchange/exchange-ps/exchange/Get-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-message -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-Message -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-message +schema: 2.0.0 +title: Get-Message --- # Get-Message @@ -69,7 +70,7 @@ Get-Message [-Queue ] ## DESCRIPTION You can display messages by including the server name as part of the Identity parameter or the Queue parameter or by including the Server parameter with a filter query. The Identity parameter, Queue parameter, and Filter parameter settings are mutually exclusive. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,13 +98,15 @@ This example displays all messages queued on the server named Server01. The resu ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -113,13 +116,15 @@ Accept wildcard characters: False ``` ### -BookmarkIndex + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BookmarkIndex parameter specifies the position in the result set where the displayed results start. The value of this parameter is a 1-based index in the total result set. The BookmarkIndex parameter can't be used with the BookmarkObject parameter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +134,15 @@ Accept wildcard characters: False ``` ### -BookmarkObject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BookmarkObject parameter specifies the object in the result set where the displayed results start. The BookmarkObject parameter can't be used with the BookmarkIndex parameter. ```yaml Type: ExtensibleMessageInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +152,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -153,7 +163,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,13 +172,15 @@ Accept wildcard characters: False ``` ### -IncludeBookmark + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeBookmark parameter specifies whether to include the bookmark object when the query results are displayed. The IncludeBookmark parameter is valid when it's used with the BookmarkObject or BookmarkIndex parameters. If you don't specify a value for the IncludeBookmark parameter, the default value of $true is used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -179,15 +190,17 @@ Accept wildcard characters: False ``` ### -IncludeComponentLatencyInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeComponentLatencyInfo switch specifies whether the information about component latency is included in the message properties. You don't need to specify a value with this switch. -If you include this switch, the message objects returned will include latency measurements for each Transport component that has contributed to the local server latency for each queued message. +If you include this switch, the message objects returned include latency measurements for each Transport component that has contributed to the local server latency for each queued message. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,6 +210,9 @@ Accept wildcard characters: False ``` ### -IncludeRecipientInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeRecipientInfo switch specifies whether to display the message recipients in the Recipients field. You don't need to specify a value with this switch. If you don't include the IncludeRecipientInfo switch, the Recipients field is blank. @@ -204,9 +220,9 @@ If you don't include the IncludeRecipientInfo switch, the Recipients field is bl Storing the results of a `Get-Message -IncludeRecipientInfo` command in a variable allows you to display additional properties for the message recipients. The following list describes the available recipient properties: - Address: The email address of the recipient. -- Type: The recipient type, which may be External, Mailbox or Distribution Group. Distribution Group is used when the destination is an expansion server. +- Type: The recipient type, which might be External, Mailbox or Distribution Group. Distribution Group is used when the destination is an expansion server. - FinalDestination: The distinguished name (DN) of the object used to route the message. -- Status: The recipient status may be Complete, Ready or Retry. +- Status: The recipient status might be Complete, Ready or Retry. - LastError: The SMTP response after the last delivery attempt or a localized error message if the message is placed in the unreachable queue. For example, to store the recipient information of a message in the contoso.com remote delivery queue that has the MessageIdentity value of 1234 to a variable named $x, use the following command: `$x=Get-Message -Identity "contoso.com\\1234" -IncludeRecipientInfo`. @@ -217,7 +233,6 @@ To display the extended recipient properties that are now stored in the $x varia Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,6 +242,9 @@ Accept wildcard characters: False ``` ### -Queue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Queue parameter specifies the identity of the queue that contains the messages that you want to display. Valid input for this parameter uses the syntax `\` or ``, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). If you use the Queue parameter, you can't use the Identity, Filter or Server parameters. @@ -235,7 +253,6 @@ If you use the Queue parameter, you can't use the Identity, Filter or Server par Type: QueueIdentity Parameter Sets: Queue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,13 +262,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,13 +280,15 @@ Accept wildcard characters: False ``` ### -ReturnPageInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReturnPageInfo parameter is a hidden parameter. Use it to return information about the total number of results and the index of the first object of the current page. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,13 +298,15 @@ Accept wildcard characters: False ``` ### -SearchForward + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SearchForward parameter specifies whether to search forward or backward in the result set. The default value is $true. This value causes the result page to be calculated forward from either the start of the result set or forward from a bookmark if specified. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +316,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -308,7 +334,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -318,6 +343,9 @@ Accept wildcard characters: False ``` ### -SortOrder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SortOrder parameter specifies an array of message properties used to control the sort order of the result set. Separate each property by using a comma. Prepend a plus sign (+) symbol to the beginning of the property name to display the results in ascending order. Prepend a minus sign (-) symbol to the beginning of the property name to display the results in descending order. If you don't specify a sort order, the result set is displayed in ascending order by MessageIdentity integer. @@ -326,7 +354,6 @@ If you don't specify a sort order, the result set is displayed in ascending orde Type: QueueViewerSortOrderEntry[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageCategory.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageCategory.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-MessageCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageCategory.md index 6cebfc35f4..fdd042b6bd 100644 --- a/exchange/exchange-ps/exchange/Get-MessageCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageCategory.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagecategory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MessageCategory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagecategory +schema: 2.0.0 +title: Get-MessageCategory --- # Get-MessageCategory ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MessageCategory cmdlet to retrieve a message category from the specified mailbox. @@ -30,7 +31,7 @@ Get-MessageCategory [[-Identity] ] ## DESCRIPTION The Get-MessageCategory cmdlet is used by the web management interface in Microsoft Exchange to populate fields that display message category information. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example retrieves message categories from the mailbox User1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the message category to be retrieved. ```yaml Type: MessageCategoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -68,7 +74,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -95,7 +103,6 @@ The Mailbox parameter specifies the mailbox that you want to view. You can use a Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageClassification.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageClassification.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-MessageClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageClassification.md index bfb6750a16..b1e4ff3155 100644 --- a/exchange/exchange-ps/exchange/Get-MessageClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageClassification.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messageclassification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MessageClassification -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messageclassification +schema: 2.0.0 +title: Get-MessageClassification --- # Get-MessageClassification ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MessageClassification cmdlet to view existing message classifications in your organization. @@ -28,7 +29,7 @@ Get-MessageClassification [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example lists all message classifications in your organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the message classification that you want to view. You can use any value that uniquely identifies the message classification. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the message classification that you want to vie Type: MessageClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -72,7 +78,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -IncludeLocales + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeLocales switch specifies whether to return message classification locale information in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageTrace.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrace.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MessageTrace.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageTrace.md index 9c5967a9f2..a470a56e43 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrace.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrace.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetrace applicable: Exchange Online, Exchange Online Protection -title: Get-MessageTrace -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetrace +schema: 2.0.0 +title: Get-MessageTrace --- # Get-MessageTrace @@ -14,6 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. +> [!NOTE] +> This cmdlet is replaced by the [Get-MessageTraceV2](https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetracev2) cmdlet and will eventually be deprecated. + Use the Get-MessageTrace cmdlet to trace messages as they pass through the cloud-based organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -40,15 +44,15 @@ Get-MessageTrace ## DESCRIPTION You can use this cmdlet to search message data for the last 10 days. If you run this cmdlet without any parameters, only data from the last 48 hours is returned. -If you enter a start date that is older than 10 days, you will receive an error and the command will return no results. +If you enter a start date that is older than 10 days, you get an error and the command returns no results. To search for message data that is greater than 10 days old, use the Start-HistoricalSearch and Get-HistoricalSearch cmdlets. -By default, this cmdlet returns a maximum of 1000 results, and will timeout on very large queries. If your query returns too many results, consider splitting it up using smaller StartDate and EndDate intervals. +By default, this cmdlet returns a maximum of 1000 results, and times out on very large queries. If your query returns too many results, consider splitting it up using smaller StartDate and EndDate intervals. The time stamps on the output are in UTC time format. That might be different from the time format that you used for the -StartDate and the -EndDate parameters. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +66,9 @@ This example retrieves message trace information for messages sent by john@conto ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -70,7 +77,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -80,13 +86,15 @@ Accept wildcard characters: False ``` ### -FromIP + +> Applicable: Exchange Online, Exchange Online Protection + The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -96,13 +104,15 @@ 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, ""). + +> Applicable: Exchange Online, Exchange Online Protection + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,6 +122,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). The MessageTraceId value is also available in the output of the following cmdlets: @@ -126,7 +139,6 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,13 +148,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -152,13 +166,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,13 +184,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -184,13 +202,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -200,13 +220,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -216,6 +238,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -224,7 +249,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -234,6 +258,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Online, Exchange Online Protection + The Status parameter filters the results by the delivery status of the message. Valid values for this parameter are: - None: The message has no delivery status because it was rejected or redirected to a different recipient. @@ -249,7 +276,6 @@ The Status parameter filters the results by the delivery status of the message. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -259,13 +285,15 @@ Accept wildcard characters: False ``` ### -ToIP + +> Applicable: Exchange Online, Exchange Online Protection + The ToIP parameter filters the results by the destination IP address. For outgoing messages, the value of ToIP is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetail.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MessageTraceDetail.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetail.md index 716d8c1509..fd7c45e868 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetail.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetail applicable: Exchange Online, Exchange Online Protection -title: Get-MessageTraceDetail -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetracedetail +schema: 2.0.0 +title: Get-MessageTraceDetail --- # Get-MessageTraceDetail @@ -14,7 +15,10 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-MessageTraceDetail cmdlet to view the message trace event details for a specific message. Note that these detailed results are returned less quickly than the Get-MessageTrace results. +> [!NOTE] +> This cmdlet is replaced by the [Get-MessageTraceDetailV2](https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetracedetailv2) cmdlet and will eventually be deprecated. + +Use the Get-MessageTraceDetail cmdlet to view the message trace event details for a specific message. These detailed results are returned less quickly than the Get-MessageTrace results. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -35,11 +39,11 @@ Get-MessageTraceDetail -MessageTraceId -RecipientAddress ``` ## DESCRIPTION -You can use this cmdlet to search message data for the last 10 days. If you enter a time period that's older than 10 days, you will receive an error and the command will return no results. +You can use this cmdlet to search message data for the last 10 days. If you enter a time period that's older than 10 days, you get an error and the command returns no results. To search for message data that is greater than 10 days old, use the Start-HistoricalSearch and Get-HistoricalSearch cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +64,9 @@ This example uses the Get-MessageTrace cmdlet to retrieve message trace informat ## PARAMETERS ### -MessageTraceId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). The MessageTraceId value is also available in the output of the following cmdlets: @@ -74,7 +81,6 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -84,13 +90,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -100,6 +108,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -108,7 +119,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -118,6 +128,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -128,7 +141,6 @@ If don't use the StartDate and EndDate parameters, only data from the last 48 ho Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -138,6 +150,9 @@ Accept wildcard characters: False ``` ### -Event + +> Applicable: Exchange Online, Exchange Online Protection + The Event parameter filters the report by the message event. The following are examples of common events: - RECEIVE: The message was received by the service. @@ -146,7 +161,7 @@ The Event parameter filters the report by the message event. The following are e - DELIVER: The message was delivered to a mailbox. - EXPAND: The message was sent to a distribution group that was expanded. - TRANSFER: Recipients were moved to a bifurcated message because of content conversion, message recipient limits, or agents. -- DEFER: The message delivery was postponed and may be re-attempted later. +- DEFER: The message delivery was postponed and might be re-attempted later. You can specify multiple values separated by commas. @@ -154,7 +169,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -164,13 +178,15 @@ 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, ""). + +> Applicable: Exchange Online, Exchange Online Protection + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -180,13 +196,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -196,13 +214,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,13 +232,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -228,13 +250,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -244,6 +268,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -254,7 +281,6 @@ If don't use the StartDate and EndDate parameters, only data from the last 48 ho Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetailV2.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetailV2.md new file mode 100644 index 0000000000..2a3f46266f --- /dev/null +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetailV2.md @@ -0,0 +1,228 @@ +--- +applicable: Exchange Online +author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetracedetailv2 +schema: 2.0.0 +title: Get-MessageTraceDetailV2 +--- + +# Get-MessageTraceDetailV2 + +## SYNOPSIS + +## SYNTAX + +``` +Get-MessageTraceDetailV2 [-MessageTraceId] [-RecipientAddress] + [[-Action] ] + [[-EndDate] ] + [[-Event] ] + [[-MessageId] ] + [[-SenderAddress] ] + [[-StartDate] ] + [] +``` + +## DESCRIPTION +You can use this cmdlet to search message data for the last 90 days. You can only query 10 days worth of data per query. If you enter a timeframe that's older than 90 days, you receive an error and the command returns no results. + +Throttling limit: A maximum of 100 query requests are accepted within a 5 minute running window. Throttling is automatically not applied if the request rate is lower than 100 requests in the last 5 minutes + +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageTraceDetailV2 -MessageTraceId ae5c1219-4c90-41bf-fef5-08d837917e7c -RecipientAddress robert@contoso.com +``` + +This example retrieves detailed message trace information for messages with the message trace ID value ae5c1219-4c90-41bf-fef5-08d837917e7c that were received by `robert@contoso.com`. + +### Example 2 +```powershell +Get-MessageTraceV2 -MessageTraceId 2bbad36aa4674c7ba82f4b307fff549f -SenderAddress john@contoso.com -StartDate 06/13/2025 -EndDate 06/15/2025 | Get-MessageTraceDetailV2 +``` + +This example uses the Get-MessageTraceV2 cmdlet to retrieve message trace information for messages with the Exchange Network Message ID value 2bbad36aa4674c7ba82f4b307fff549f sent by `john@contoso.com` between June 13, 2025 and June 15, 2025, and pipelines the results to the Get-MessageTraceDetailV2 cmdlet. + +## PARAMETERS + +### -MessageTraceId + +> Applicable: Exchange Online + +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecipientAddress + +> Applicable: Exchange Online + +The RecipientAddress parameter filters the results by the recipient's email address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Action + +> Applicable: Exchange Online + +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate + +> Applicable: Exchange Online + +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Event + +> Applicable: Exchange Online + +The Event parameter filters the report by the message event. The following are examples of common events: + +- RECEIVE: The message was received by the service. +- SEND: The message was sent by the service. +- FAIL: The message failed to be delivered. +- DELIVER: The message was delivered to a mailbox. +- EXPAND: The message was sent to a distribution group that was expanded. +- TRANSFER: Recipients were moved to a bifurcated message because of content conversion, message recipient limits, or agents. +- DEFER: The message delivery was postponed and might be re-attempted later. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId + +> Applicable: Exchange Online + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SenderAddress + +> Applicable: Exchange Online + +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDate + +> Applicable: Exchange Online + +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceV2.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceV2.md new file mode 100644 index 0000000000..0e274fc967 --- /dev/null +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceV2.md @@ -0,0 +1,348 @@ +--- +applicable: Exchange Online +author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetracev2 +schema: 2.0.0 +title: Get-MessageTraceV2 +--- + +# Get-MessageTraceV2 + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MessageTraceV2 cmdlet to trace messages as they pass through the cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MessageTraceV2 + [[-EndDate] ] + [[-FromIP] ] + [[-MessageId] ] + [[-MessageTraceId] ] + [[-RecipientAddress] ] + [[-ResultSize] ] + [[-SenderAddress] ] + [[-StartDate] ] + [[-StartingRecipientAddress] ] + [[-Status] ] + [[-SubjectFilterType] ] + [[-Subject] ] + [[-ToIP] ] + [] +``` + +## DESCRIPTION +You can use this cmdlet to search message data for the last 90 days. If you run this cmdlet without any parameters, only data from the last 48 hours is returned. You can only return 10 days worth of data per query. + +By default, this cmdlet returns up to 1000 results, with a maximum of 5000 results. If your data exceeds the result size, query in multiple rounds or use smaller StartDate and EndDate intervals. + +The time stamps on the output are in UTC time format. That might be different from the time format that you used for the -StartDate and the -EndDate parameters. + +Throttling limit: A maximum of 100 query requests are accepted within a 5 minute running window. Throttling is automatically not applied if the request rate is lower than 100 requests in the last 5 minutes + +Pagination isn't supported in this cmdlet. To query subsequent data, use the StartingRecipientAddress and EndDate parameters with the values from the **Recipient address** and **Received Time** properties respectively of the previous result in the next query. + +Best Practices: + +- Use the ResultSize parameter to adjust the size of your results. +- Be as precise as possible. Narrow the gap between StartDate and EndDate and use additional parameters (for example, SenderAddress) where possible. +- Use MessageTraceId where possible (required for messages sent to more than 1000 recipients). + +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageTraceV2 -SenderAddress john@contoso.com -StartDate 06/13/2025 -EndDate 06/15/2025 +``` + +This example retrieves message trace information for messages sent by `john@contoso.com` between June 13, 2025 and June 15, 2025. + +## PARAMETERS + +### -EndDate + +> Applicable: Exchange Online + +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FromIP + +> Applicable: Exchange Online + +The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MessageId + +> Applicable: Exchange Online + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MessageTraceId + +> Applicable: Exchange Online + +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceDetailV2 + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecipientAddress + +> Applicable: Exchange Online + +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResultSize + +> Applicable: Exchange Online + +The ResultSize parameter specifies the maximum number of results to return. A valid value is from 1 to 5000. The default value is 1000. + +**Note**: This parameter replaces the PageSize parameter that was available on the Get-MessageTrace cmdlet. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SenderAddress + +> Applicable: Exchange Online + +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDate + +> Applicable: Exchange Online + +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartingRecipientAddress + +> Applicable: Exchange Online + +The StartingRecipientAddress parameter is used with the EndDate parameter to query subsequent data for partial results while avoiding duplication. Query subsequent data by taking the **Recipient address** and **Received Time** values of the last record of the partial results and using them as the values for the StartingRecipientAddress and EndDate parameters respectively in the next query. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status + +> Applicable: Exchange Online + +The Status parameter filters the results by the delivery status of the message. Valid values are: + +- Delivered: The message was delivered to its destination. +- Expanded: There was no message delivery because the message was addressed to a distribution group and the membership of the distribution was expanded. +- Failed: Message delivery was attempted and it failed. +- FilteredAsSpam: The message was marked as spam. +- GettingStatus: The message is waiting for status update. +- None: The message has no delivery status because it was rejected or redirected to a different recipient. +- Pending: Message delivery is underway or was deferred and is being retried. +- Quarantined: The message was quarantined. + +You can separate multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject + +> Applicable: Exchange Online + +The Subject parameter filters the results by the subject of the message. If the value contains spaces, enclose the value in quotation marks ("). + +You specify how the value is evaluated in the message subject by using the SubjectFilterType parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectFilterType + +> Applicable: Exchange Online + +The SubjectFilterType parameter specifies how the value of the Subject parameter is evaluated. Valid values are: + +- Contains +- EndsWith +- StartsWith + +We recommend using StartsWith or EndsWith instead of Contains whenever possible. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ToIP + +> Applicable: Exchange Online + +The ToIP parameter filters the results by the destination IP address. For outgoing messages, the value of ToIP is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 13 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingLog.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MessageTrackingLog.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingLog.md index 877d2fd0a3..c97f3baf2a 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetrackinglog -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MessageTrackingLog -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetrackinglog +schema: 2.0.0 +title: Get-MessageTrackingLog --- # Get-MessageTrackingLog @@ -53,7 +54,7 @@ For more information about the message tracking log files, see [Message tracking You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding ` > ` to the command. For example: `Get-MessageTrackingLog -Start "03/13/2020 09:00:00" -End "03/13/2020 09:10:00" | ConvertTo-Html > "C:\My Documents\message track.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,6 +75,9 @@ This example searches the message tracking logs on the Mailbox server named Mail ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -82,7 +86,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -End + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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". @@ -100,7 +106,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -EventId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EventId parameter filters the message tracking log entries by the value of the EventId field. The EventId value classifies each message event. Example values include DSN, Defer, Deliver, Send, or Receive. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -InternalMessageId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalMessageId parameter filters the message tracking log entries by the value of the InternalMessageId field. The InternalMessageId value is a message identifier that's assigned by the Exchange server that's currently processing the message. The value of the internal-message-id for a specific message is different in the message tracking log of every Exchange server that's involved in the delivery of the message. @@ -134,7 +144,6 @@ The value of the internal-message-id for a specific message is different in the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -MessageId -The MessageId parameter filters the message tracking log entries by the value of the MessageId field. The value of MessageId corresponds to the value of the Message-Id: header field in the message. If the Message-ID header field is blank or doesn't exist, an arbitrary value is assigned. Be sure to include the full MessageId string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The MessageId parameter filters the message tracking log entries by the value of the MessageId field. The value of MessageId corresponds to the value of the Message-Id: header field in the message. If the Message-ID header field is blank or doesn't exist, an arbitrary value is assigned. Be sure to include the full MessageId string (which might include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -MessageSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageSubject parameter filters the message tracking log entries by the value of the message subject. The value of the MessageSubject parameter automatically supports partial matches without using wildcards or special characters. For example, if you specify the MessageSubject value sea, the results include messages with Seattle in the subject. By default, message subjects are stored in the message tracking logs. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -176,13 +189,15 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,13 +207,15 @@ Accept wildcard characters: False ``` ### -Reference + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Reference parameter filters the message tracking log entries by the value of the Reference field. The Reference field contains additional information for specific types of events. For example, the Reference field value for a DSN message tracking entry contains the InternalMessageId value of the message that caused the DSN. For many types of events, the value of Reference is blank. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,13 +225,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,13 +243,15 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Sender parameter filters the message tracking log entries by the sender's SMTP email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -240,6 +261,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -253,7 +277,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,6 +286,9 @@ Accept wildcard characters: False ``` ### -Start + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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". @@ -271,7 +297,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,13 +306,15 @@ Accept wildcard characters: False ``` ### -NetworkMessageId -The NetworkMessageId parameter filters the message tracking log entries by the value of the NetworkMessageId field. This field contains a unique message ID value that persists across copies of the message that may be created due to bifurcation or distribution group expansion. An example value is 1341ac7b13fb42ab4d4408cf7f55890f. + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The NetworkMessageId parameter filters the message tracking log entries by the value of the NetworkMessageId field. This field contains a unique message ID value that persists across copies of the message that might be created due to bifurcation or distribution group expansion. An example value is 1341ac7b13fb42ab4d4408cf7f55890f. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,13 +324,15 @@ Accept wildcard characters: False ``` ### -Source + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Source parameter filters the message tracking log entries by the value of the Source field. These values indicate the transport component that's responsible for the message tracking event. For more information, see [Source values in the message tracking log](https://learn.microsoft.com/Exchange/mail-flow/transport-logs/message-tracking#source-values-in-the-message-tracking-log). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,13 +342,15 @@ Accept wildcard characters: False ``` ### -TransportTrafficType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportTrafficType parameter filters the message tracking log entries by the value of the TransportTrafficType field. However, this field isn't interesting for on-premises Exchange organizations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingReport.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-MessageTrackingReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingReport.md index 09b3c5d92c..dbe1ef3dea 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetrackingreport -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MessageTrackingReport -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetrackingreport +schema: 2.0.0 +title: Get-MessageTrackingReport --- # Get-MessageTrackingReport @@ -16,7 +17,7 @@ This cmdlet is functional only in on-premises Exchange. Use the Get-MessageTrackingReport cmdlet to return data for a specific message tracking report. This cmdlet is used by the delivery reports feature. -In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets). +In Exchange Online, delivery reports are replaced by message trace (the Get-MessageTraceV2 and Get-MessageTraceDetailV2 cmdlets). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -38,9 +39,9 @@ Get-MessageTrackingReport [-Identity] ``` ## DESCRIPTION -This cmdlet requires the ID for the message tracking report that you want to view. Therefore, first you need to use the Search-MessageTrackingReport cmdlet to find the message tracking report ID for a specific message, and then pass the results to this cmdlet. For more information, see [Search-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchange/search-messagetrackingreport). +This cmdlet requires the ID for the message tracking report that you want to view. Therefore, first you need to use the Search-MessageTrackingReport cmdlet to find the message tracking report ID for a specific message, and then pass the results to this cmdlet. For more information, see [Search-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchangepowershell/search-messagetrackingreport). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,7 +49,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. @@ -65,6 +68,9 @@ This example searches the message tracking data for the specific message trackin ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the message tracking report ID that you want to view. You need to run the Search-MessageTrackingReport cmdlet to find the message tracking report ID for the specific message that you're tracking, and then pass the value of the MessageTrackingReportID field to this parameter. @@ -73,7 +79,6 @@ You need to run the Search-MessageTrackingReport cmdlet to find the message trac Type: MessageTrackingReportId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -BypassDelegateChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BypassDelegateChecking switch allows Help desk staff and administrators to retrieve message tracking reports for any user. You don't need to specify a value with this switch. By default, each user can only see the message tracking reports for messages that they send or receive from their own mailbox. When you use this switch, you can view the message tracking reports for message exchanges among other users. @@ -91,7 +99,6 @@ By default, each user can only see the message tracking reports for messages tha Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -DetailLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DetailLevel parameter specifies the amount of detail to return in the results. Valid values are: - Basic: Simple delivery report information is returned, which is more appropriate for users. @@ -110,7 +120,6 @@ The DetailLevel parameter specifies the amount of detail to return in the result Type: MessageTrackingDetailLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +147,9 @@ Accept wildcard characters: False ``` ### -DoNotResolve + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DoNotResolve switch specifies whether to prevent the resolution of email addresses to display names. You don't need to specify a value with this switch. Using this switch improves performance, but the lack of display names might make the results more difficult to interpret. @@ -144,7 +158,6 @@ Using this switch improves performance, but the lack of display names might make Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -RecipientPathFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientPathFilter parameter specifies the email address of the recipient when you use the ReportTemplate parameter with the value RecipientPath. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,13 +185,15 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Recipients parameter specifies the email addresses of the recipients when you use the ReportTemplate parameter with the value Summary. You can specify multiple email addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +203,9 @@ Accept wildcard characters: False ``` ### -ReportTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReportTemplate parameter specifies a predefined format for the output. Valid values are: - RecipientPath: Returns a detailed tracking report for one recipient of the message. You specify the recipient by using the RecipientPathFilter parameter. @@ -195,7 +215,6 @@ The ReportTemplate parameter specifies a predefined format for the output. Valid Type: ReportTemplate Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -205,13 +224,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -221,6 +242,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Status parameter filters the results by the specified delivery status codes. Valid values are: - Delivered @@ -233,7 +257,6 @@ The Status parameter filters the results by the specified delivery status codes. Type: _DeliveryStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -243,6 +266,9 @@ Accept wildcard characters: False ``` ### -TraceLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TraceLevel parameter specifies the details to include in the results. Valid values are: - Low: Minimal additional data is returned, including servers that were accessed, timing, message tracking search result counts and any error information. @@ -255,7 +281,6 @@ You only need to use this parameter for troubleshooting message tracking issues. Type: TraceLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationBatch.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationBatch.md index ecc0d0aa97..0c0ec8d88d 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationBatch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationbatch -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationBatch -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationbatch +schema: 2.0.0 +title: Get-MigrationBatch --- # Get-MigrationBatch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MigrationBatch cmdlet to retrieve status information about the current migration batch. @@ -77,9 +78,9 @@ The Get-MigrationBatch cmdlet displays status information about the current migr - Migration errors - Date and time when the migration was started and completed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -**Note**: In the cloud-based service, if you don't use the TimeZone parameter in the New-MigrationBatch command, the default time zone for the migration batch is UTC. The CompleteAfter and CompleteAfterUTC properties will contain the same value (as will the StartAfter and StartAfterUTC properties). When you create the migration batch in the Exchange admin center (EAC), the time zone that's used is based on your regional configuration. +**Note**: In the cloud-based service, if you don't use the TimeZone parameter in the New-MigrationBatch command, the default time zone for the migration batch is UTC. The CompleteAfter and CompleteAfterUTC properties contain the same value (and also the StartAfter and StartAfterUTC properties). When you create the migration batch in the Exchange admin center (EAC), the time zone that's used is based on your regional configuration. ## EXAMPLES @@ -100,6 +101,9 @@ This example displays information about all migration batches associated with th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter identifies the name of the current migration batch. The value for this parameter is specified by the Name parameter of the New-MigrationBatch cmdlet. If you use this parameter, you can't include the Endpoint parameter. @@ -108,7 +112,6 @@ If you use this parameter, you can't include the Endpoint parameter. Type: MigrationBatchIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -128,7 +134,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: Identity, BatchesFromEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -146,7 +154,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: Identity, BatchesFromEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +163,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: @@ -184,7 +194,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -194,6 +203,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -202,7 +214,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Identity, BatchesFromEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +223,9 @@ Accept wildcard characters: False ``` ### -Endpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Endpoint parameter returns a list of migration batches associated with the specified migration endpoint. If you use this parameter, you can't include the Identity parameter. @@ -220,7 +234,6 @@ If you use this parameter, you can't include the Identity parameter. Type: MigrationEndpointIdParameter Parameter Sets: BatchesFromEndpoint, BatchesByEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +243,9 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeReport switch returns additional information about the specified migration batch. You don't need to specify a value with this switch. This information is displayed in the Report field. @@ -238,7 +254,6 @@ This information is displayed in the Report field. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -248,6 +263,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -256,7 +274,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -266,6 +283,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -274,7 +294,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -284,6 +303,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Status parameter returns a list of migration batches that have the specified status state. Use one of the following values: - Completed @@ -306,7 +328,6 @@ The Status parameter returns a list of migration batches that have the specified Type: MMigrationBatchStatus Parameter Sets: Identity, BatchesFromEndpoint, BatchesByStatus 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-MigrationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationConfig.md similarity index 59% rename from exchange/exchange-ps/exchange/Get-MigrationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationConfig.md index e324c6af05..e9547ccb5c 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationconfig -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationConfig -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationconfig +schema: 2.0.0 +title: Get-MigrationConfig --- # Get-MigrationConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MigrationConfig cmdlet to retrieve migration configuration settings on Exchange servers. @@ -20,14 +21,28 @@ 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] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,16 +55,58 @@ This example retrieves the settings for the migration configuration. ## PARAMETERS +### -AllPartitions + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill AllPartitions Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AllPartitions +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: Default +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSimplifiedGmailMigrationData + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill IncludeSimplifiedGmailMigrationData Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Partition, AllPartitions Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -59,15 +116,17 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. ```yaml Type: MailboxIdParameter -Parameter Sets: (All) +Parameter Sets: Partition Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationEndpoint.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-MigrationEndpoint.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationEndpoint.md index 8f8f5dd3c9..31f0965b95 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationEndpoint.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationendpoint -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationEndpoint -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationendpoint +schema: 2.0.0 +title: Get-MigrationEndpoint --- # Get-MigrationEndpoint ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MigrationEndpoint cmdlet to retrieve migration endpoint settings for source or destination servers for cutover or staged Exchange migrations, IMAP migrations, and remote moves. @@ -66,7 +67,7 @@ For more information about the different move and migration scenarios, see: - [Mailbox moves in Exchange Server](https://learn.microsoft.com/Exchange/recipients/mailbox-moves) - [Manage on-premises mailbox moves in Exchange Server](https://learn.microsoft.com/Exchange/architecture/mailbox-servers/manage-mailbox-moves) -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,13 +81,15 @@ This example retrieves the settings for the migration endpoint, OnboardingME01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the migration endpoint you want to retrieve settings for. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -ConnectionSettings + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConnectionSettings parameter specifies the configuration settings of source or target servers for which you want to find a matching endpoint. @@ -104,7 +110,6 @@ The ConnectionSettings parameter specifies the configuration settings of source Type: ExchangeConnectionSettings Parameter Sets: ConnectionSettingsFilter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -124,7 +132,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -142,7 +152,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: @@ -180,7 +192,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -190,6 +201,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -198,7 +212,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,6 +221,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -216,7 +232,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -226,6 +241,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Type parameter filters the results by the type of migration. Valid values for this parameter are: - ExchangeOutlookAnywhere: Cutover or staged Exchange migrations @@ -237,7 +255,6 @@ The Type parameter filters the results by the type of migration. Valid values fo Type: MigrationType Parameter Sets: TypeFilter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MigrationStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationStatistics.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MigrationStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationStatistics.md index c397c884ee..316105390a 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationstatistics -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationStatistics -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationstatistics +schema: 2.0.0 +title: Get-MigrationStatistics --- # Get-MigrationStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MigrationStatistics cmdlet to view detailed information about migration requests. @@ -30,7 +31,7 @@ Get-MigrationStatistics [-Diagnostic] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example returns the default statistics for the migration batches. ## PARAMETERS ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -54,7 +58,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -72,7 +78,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: @@ -110,7 +118,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -128,7 +138,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -146,7 +158,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MigrationUser.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationUser.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-MigrationUser.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationUser.md index e379851050..b152b9d8ca 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationUser.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationuser -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationUser -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationuser +schema: 2.0.0 +title: Get-MigrationUser --- # Get-MigrationUser ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MigrationUser cmdlet to view information about move and migration users. @@ -61,7 +62,7 @@ Get-MigrationUser -EmailAddress ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -96,13 +97,15 @@ This example retrieves more detailed information about any ongoing migration for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the particular ongoing migration that you want to retrieve information about. The Identity parameter is usually represented as an email address. ```yaml Type: MigrationUserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -112,13 +115,15 @@ Accept wildcard characters: False ``` ### -MailboxGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailboxGuid parameter specifies the GUID of a mailbox for which you want to view the migration information. ```yaml Type: Guid Parameter Sets: MailboxGuid Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -128,13 +133,15 @@ Accept wildcard characters: False ``` ### -BatchId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchId parameter specifies the name of the migration batch for which you want to return users. ```yaml Type: MigrationBatchIdParameter Parameter Sets: StatusAndBatchId Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -152,7 +162,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,13 +171,15 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Exchange Online + The EmailAddress parameter specifies the particular user that you want to retrieve information about. The EmailAddress parameter is represented as an email address. This parameter is available only in the cloud-based service. ```yaml Type: EmailAddress Parameter Sets: EmailAddress Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -178,6 +189,9 @@ Accept wildcard characters: False ``` ### -IncludeAssociatedUsers + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeAssociatedUsers Description }} @@ -186,7 +200,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -204,7 +220,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -214,13 +229,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +247,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Status parameter returns information about migration users that have the specified status state. Use one of the following values: - Completed @@ -258,7 +278,6 @@ The Status parameter returns information about migration users that have the spe Type: MigrationUserStatus Parameter Sets: StatusAndBatchId Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -268,6 +287,9 @@ Accept wildcard characters: False ``` ### -StatusSummary + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StatusSummary parameter returns abbreviated information about migration users that have the specified status value. Use one of the following values: - Active @@ -280,7 +302,6 @@ The StatusSummary parameter returns abbreviated information about migration user Type: MigrationUserStatusSummary Parameter Sets: StatusAndBatchId 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-MigrationUserStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationUserStatistics.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationUserStatistics.md index 5e64b3de72..8b8cc0bd56 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationUserStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationuserstatistics -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationUserStatistics -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationuserstatistics +schema: 2.0.0 +title: Get-MigrationUserStatistics --- # Get-MigrationUserStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MigrationUserStatistics cmdlet to view detailed information about the migration requested for a specific user. @@ -36,7 +37,7 @@ Get-MigrationUserStatistics [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -85,13 +86,15 @@ In on-premises Exchange, this example uses the Diagnostic parameter to display d ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the user that you want to retrieve migration information about. Use an email address as the value for this parameter. ```yaml Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -111,7 +117,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -129,7 +137,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -147,7 +157,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -165,7 +177,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -IncludeCopilotReport + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeCopilotReport Description }} @@ -183,7 +197,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -193,13 +206,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -IncludeSkippedItems + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeSkippedItems switch specifies whether to include skipped items for the user. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -225,13 +242,15 @@ Accept wildcard characters: False ``` ### -LimitSkippedItemsTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LimitSkippedItemsTo parameter specifies the maximum number of skipped items to display information about in the SkippedItems property in command output. For example, if this parameter is set to 5, the cmdlet returns information for up to five skipped items for the specified user, even if there are more than five skipped items. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -241,6 +260,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -249,7 +271,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -259,13 +280,15 @@ Accept wildcard characters: False ``` ### -SkipSubscription + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipSubscription switch specifies whether to skip loading the subscription for the user. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MobileDevice.md b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDevice.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-MobileDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MobileDevice.md index 7da6e04fbb..0a6ffc561b 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDevice.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mobiledevice -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MobileDevice -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mobiledevice +schema: 2.0.0 +title: Get-MobileDevice --- # Get-MobileDevice ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MobileDevice cmdlet to get the list of devices in your organization that have active partnerships. @@ -55,7 +56,7 @@ Get-MobileDevice [[-Identity] ] ## DESCRIPTION The Get-MobileDevice cmdlet returns identification, configuration, and status information for each mobile device. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,6 +84,9 @@ This example returns detailed information about the specified device on Lila's m ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mobile device that you want to view. You can use the following values that uniquely identifies the mobile device: - Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) @@ -93,7 +97,6 @@ The Identity parameter specifies the mobile device that you want to view. You ca Type: MobileDeviceIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter filters the results by mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -122,7 +128,6 @@ You can't use this parameter with the Identity parameter. Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -132,13 +137,15 @@ Accept wildcard characters: False ``` ### -ActiveSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -148,6 +155,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -156,7 +166,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -202,7 +214,6 @@ You can filter by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +223,9 @@ Accept wildcard characters: False ``` ### -Monitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch. @@ -222,7 +236,6 @@ Monitoring mailboxes are associated with managed availability and the Exchange H Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -232,6 +245,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -243,7 +259,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -253,13 +268,15 @@ Accept wildcard characters: False ``` ### -OWAforDevices + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAforDevices switch filters the results by whether Outlook on the web for devices is enabled for the device. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -269,13 +286,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -285,6 +304,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -311,7 +333,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -321,13 +342,15 @@ Accept wildcard characters: False ``` ### -RestApi + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -337,13 +360,15 @@ Accept wildcard characters: False ``` ### -UniversalOutlook + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceMailboxPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceMailboxPolicy.md index 5a1d4c078b..565645f4d4 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mobiledevicemailboxpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MobileDeviceMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mobiledevicemailboxpolicy +schema: 2.0.0 +title: Get-MobileDeviceMailboxPolicy --- # Get-MobileDeviceMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MobileDeviceMailboxPolicy cmdlet to retrieve the Mobile Device mailbox policy settings for a specific Mobile Device mailbox policy. @@ -29,7 +30,7 @@ Get-MobileDeviceMailboxPolicy [[-Identity] ] ## DESCRIPTION A Mobile Device mailbox policy is a group of settings that specifies how mobile devices connect Exchange. Exchange supports multiple mobile device mailbox policies. The Get-MobileDeviceMailboxPolicy cmdlet displays all the policy settings for the specified policy. These settings include password settings, file access settings and attachment settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example returns the policy settings for the Mobile Device mailbox policy De ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the policy name. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceStatistics.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceStatistics.md index d493f60367..5d6f6c1c20 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mobiledevicestatistics -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MobileDeviceStatistics -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mobiledevicestatistics +schema: 2.0.0 +title: Get-MobileDeviceStatistics --- # Get-MobileDeviceStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MobileDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices. @@ -55,7 +56,7 @@ Get-MobileDeviceStatistics -Mailbox ## DESCRIPTION The Get-MobileDeviceStatistics cmdlet returns a list of statistics about each mobile device. Additionally, it allows you to retrieve logs and send those logs to a recipient for troubleshooting purposes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,6 +88,9 @@ This example retrieves the statistics for the mobile phone that's configured to ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mobile device that you want to view. You can use the following values that uniquely identifies the mobile device: - Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) @@ -99,7 +103,6 @@ You can't use this parameter with the Mailbox parameter. Type: MobileDeviceIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter filters the results by the user mailbox that's associated with the mobile device. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -128,7 +134,6 @@ You can't use this parameter with the Identity parameter. Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -138,13 +143,15 @@ Accept wildcard characters: False ``` ### -ActiveSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,6 +161,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -162,7 +172,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +181,15 @@ Accept wildcard characters: False ``` ### -GetMailboxLog + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GetMailboxLog switch specifies whether to send the mobile device statistics to the email addresses that are specified by the NotificationEmailAddresses parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,6 +199,9 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NotificationEmailAddresses parameter specifies a comma-separated list of email addresses to receive the mobile device statistics when you use the GetMailboxLog switch. This parameter is meaningful only if you also use the GetMailboxLog switch in the same command. @@ -196,7 +210,6 @@ This parameter is meaningful only if you also use the GetMailboxLog switch in th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -206,13 +219,15 @@ Accept wildcard characters: False ``` ### -OWAforDevices + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAforDevices switch filters the results by devices where Outlook on the web for devices is enabled. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -222,13 +237,15 @@ Accept wildcard characters: False ``` ### -ShowRecoveryPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowRecoveryPassword switch specifies whether to return the recovery password for the mobile device as one of the displayed statistics. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -238,13 +255,15 @@ Accept wildcard characters: False ``` ### -RestApi + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -254,13 +273,15 @@ Accept wildcard characters: False ``` ### -UniversalOutlook + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -270,6 +291,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -278,7 +302,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md b/exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemHelp.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemHelp.md index b720090806..0f30abca7c 100644 --- a/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemHelp.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-monitoringitemhelp -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MonitoringItemHelp -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-monitoringitemhelp +schema: 2.0.0 +title: Get-MonitoringItemHelp --- # Get-MonitoringItemHelp @@ -26,7 +27,7 @@ Get-MonitoringItemHelp [-Identity] -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,13 +41,15 @@ This example retrieves health set information for a monitoring item on the serve ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the monitoring item. The parameter uses the syntax: `\[\]`. You can find the available values in the Identity property of the output of the Get-MonitoringItem cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -56,6 +59,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that contains the monitoring item. You can use any value that uniquely identifies the server. For example: - Name @@ -67,7 +73,6 @@ The Server parameter specifies the Exchange server that contains the monitoring Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md b/exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemIdentity.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemIdentity.md index 993413da94..5ed8bba101 100644 --- a/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemIdentity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-monitoringitemidentity -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MonitoringItemIdentity -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-monitoringitemidentity +schema: 2.0.0 +title: Get-MonitoringItemIdentity --- # Get-MonitoringItemIdentity @@ -26,7 +27,7 @@ Get-MonitoringItemIdentity [-Identity] -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,13 +41,15 @@ This example returns information about the health set named OutlookMapiHttp.Prox ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the health set that you want to view. To see the list of available health sets, you can use the Get-ServerHealth or Get-HealthReport cmdlets. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -56,6 +59,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that contains the health set. You can use any value that uniquely identifies the server. For example: - Name @@ -67,7 +73,6 @@ The Server parameter specifies the Exchange server that contains the health set. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-MoveRequest.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MoveRequest.md index 9bd1b19333..7ecd1bd9a6 100644 --- a/exchange/exchange-ps/exchange/Get-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MoveRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-moverequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MoveRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-moverequest +schema: 2.0.0 +title: Get-MoveRequest --- # Get-MoveRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MoveRequest cmdlet to view the detailed status of an ongoing asynchronous mailbox move that was initiated by using the New-MoveRequest cmdlet. @@ -60,7 +61,7 @@ Get-MoveRequest [-BatchName ] ## DESCRIPTION The search criteria for the Get-MoveRequest cmdlet is a Boolean And statement. If you use multiple parameters, it narrows your search and reduces your search results. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -88,6 +89,9 @@ This example retrieves the status of move requests in the FromDB01ToDB02 batch t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the move request, which is the identity of the mailbox or mail user. You can use any value that uniquely identifies the mailbox or mail user. For example: - Name @@ -118,7 +122,6 @@ You can use this parameter with the following parameters: Type: MoveRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -128,6 +131,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter specifies the name that was given to a batch move request. You can't use this parameter with the Identity parameter. @@ -136,7 +142,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,6 +151,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -156,7 +164,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +173,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -174,7 +184,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,7 +193,10 @@ Accept wildcard characters: False ``` ### -Flags -The Flags parameter specifies the move type to retrieve information for. The following values may be used: + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The Flags parameter specifies the move type to retrieve information for. Valid value are: - CrossOrg - HighPriority @@ -207,7 +219,6 @@ The Flags parameter specifies the move type to retrieve information for. The fol Type: RequestFlags Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -217,6 +228,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The HighPriority parameter specifies that the cmdlet returns requests that were created with the HighPriority flag. The HighPriority flag indicates that the request should be processed before other lower priority requests in the queue. @@ -227,7 +241,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,6 +250,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedObjects + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IncludeSoftDeletedObjects parameter specifies whether to return mailboxes that have been soft deleted. This parameter accepts $true or $false. @@ -245,7 +261,6 @@ The IncludeSoftDeletedObjects parameter specifies whether to return mailboxes th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +270,9 @@ Accept wildcard characters: False ``` ### -MoveStatus + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MoveStatus parameter returns move requests in the specified status. You can use the following values: - AutoSuspended @@ -273,7 +291,6 @@ You can't use this parameter with the Identity parameter. Type: RequestStatus Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -283,6 +300,9 @@ Accept wildcard characters: False ``` ### -Offline + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Offline parameter specifies whether to return mailboxes that are being moved in offline mode. This parameter accepts $true or $false. You can't use this parameter with the Identity parameter. @@ -291,7 +311,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -301,6 +320,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -312,7 +334,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,6 +343,9 @@ Accept wildcard characters: False ``` ### -Protect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Protect parameter returns mailboxes being moved in protected mode. This parameter accepts $true or $false. @@ -332,7 +356,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -342,6 +365,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter filters the results by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -361,7 +387,6 @@ The ProxyToMailbox parameter filters the results by the location of the specifie Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -371,6 +396,9 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. You can't use this parameter with the Identity parameter. @@ -379,7 +407,6 @@ You can't use this parameter with the Identity parameter. Type: Fqdn Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -389,13 +416,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -405,6 +434,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -419,7 +451,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -429,6 +460,9 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SourceDatabase parameter returns all mailboxes that are being moved from the specified source mailbox database. You can use any value that uniquely identifies the database. For example: @@ -443,7 +477,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -453,6 +486,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Status parameter filters the results by status. Valid values are: @@ -473,7 +509,6 @@ The Status parameter filters the results by status. Valid values are: Type: RequestStatus Parameter Sets: Filtering Aliases: MoveStatus -Applicable: Exchange Online Required: False Position: Named @@ -483,6 +518,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Suspend parameter specifies whether to return mailboxes with moves that have been suspended. This parameter accepts $true or $false. You can't use this parameter with the Identity parameter. @@ -491,7 +529,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -501,6 +538,9 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendWhenReadytoComplete parameter specifies whether to return mailboxes that have been moved with the New-MoveRequest command and its SuspendWhenReadyToComplete switch. This parameter accepts $true or $false. You can't use this parameter with the Identity parameter. @@ -509,7 +549,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -519,6 +558,9 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The TargetDatabase parameter returns all mailboxes that are being moved to the specified target mailbox database. You can use any value that uniquely identifies the database. For example: @@ -533,7 +575,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MoveRequestStatistics.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MoveRequestStatistics.md index 8f312cf0ae..818b63f0d8 100644 --- a/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MoveRequestStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-moverequeststatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MoveRequestStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-moverequeststatistics +schema: 2.0.0 +title: Get-MoveRequestStatistics --- # Get-MoveRequestStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-MoveRequestStatistics cmdlet to view detailed information about move requests. @@ -66,7 +67,7 @@ Get-MoveRequestStatistics -MRSInstance ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,7 +104,7 @@ This example returns default statistics for all mailboxes whose move requests ar Get-MoveRequestStatistics -MRSInstance CAS01.contoso.com -MailboxGuid b6a6795c-a010-4f67-aaaa-da372d56fcb9 ``` -In Exchange Server 2010, this example returns default statistics for a mailbox that has been moved by the instance of the Microsoft Exchange Mailbox Replication service running on the server CAS01. +In Exchange Server 2010, this example returns default statistics for a mailbox that is moved by the instance of the Microsoft Exchange Mailbox Replication service running on the server CAS01. ### Example 6 ```powershell @@ -115,6 +116,9 @@ This example exports the move request information so you can later import it int ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use one of the following values: - GUID @@ -131,7 +135,6 @@ You can use this parameter with the MoveRequestQueue or MailboxGuid parameters. Type: MoveRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -141,6 +144,9 @@ Accept wildcard characters: False ``` ### -MoveRequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is for debugging purposes only. @@ -157,7 +163,6 @@ You can't use this parameter with the Identity or MRSInstance parameters. Type: DatabaseIdParameter Parameter Sets: MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -167,6 +172,9 @@ Accept wildcard characters: False ``` ### -MRSInstance + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSInstance parameter specifies the fully qualified domain name (FQDN) of the Client Access server on which the Microsoft Exchange Mailbox Replication service (MRS) resides. When using this parameter, all records are returned for this instance of MRS. @@ -177,7 +185,6 @@ You can't use this parameter with the Identity or MoveRequestQueue parameters. Type: Fqdn Parameter Sets: MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -187,6 +194,9 @@ Accept wildcard characters: False ``` ### -Analysis + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Analysis Description }} @@ -195,7 +205,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -205,6 +214,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -215,7 +227,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +236,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -233,7 +247,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: IdentityOnPremises, MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,6 +256,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: @@ -255,7 +271,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -265,6 +280,9 @@ Accept wildcard characters: False ``` ### -DiagnosticOnly + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DiagnosticOnly Description }} @@ -273,7 +291,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -283,6 +300,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -291,7 +311,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: IdentityOnPremises, MigrationMoveRequestQueue, MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -301,13 +320,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -317,6 +338,9 @@ Accept wildcard characters: False ``` ### -MailboxGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MailboxGuid parameter specifies the GUID of a mailbox for which you want to view the move request statistics. @@ -327,7 +351,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationMoveRequestQueue, MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -337,6 +360,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter filters the results by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -356,7 +382,6 @@ The ProxyToMailbox parameter filters the results by the location of the specifie Type: MailboxIdParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -366,13 +391,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MxRecordReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MxRecordReport.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-MxRecordReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MxRecordReport.md index 1600495130..13fa49ad9d 100644 --- a/exchange/exchange-ps/exchange/Get-MxRecordReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MxRecordReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mxrecordreport applicable: Exchange Online, Exchange Online Protection -title: Get-MxRecordReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mxrecordreport +schema: 2.0.0 +title: Get-MxRecordReport --- # Get-MxRecordReport @@ -27,7 +28,7 @@ Get-MxRecordReport [-Domain ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example shows the MX record information for the contoso.com domain. ## PARAMETERS ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter specifies the domain you want to test. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -57,13 +60,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-MyAnalyticsFeatureConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MyAnalyticsFeatureConfig.md index ad5461513b..9e84a9bb8b 100644 --- a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MyAnalyticsFeatureConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-myanalyticsfeatureconfig applicable: Exchange Online -title: Get-MyAnalyticsFeatureConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig +schema: 2.0.0 +title: Get-MyAnalyticsFeatureConfig --- # Get-MyAnalyticsFeatureConfig @@ -60,13 +61,15 @@ This example and the corresponding output shows the MyAnalytics configuration fo ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user you want to view. You identify the user by their email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md b/exchange/exchange-ps/ExchangePowerShell/Get-NetworkConnectionInfo.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md rename to exchange/exchange-ps/ExchangePowerShell/Get-NetworkConnectionInfo.md index 3b753febcb..b405db7a1f 100644 --- a/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-NetworkConnectionInfo.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-networkconnectioninfo -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-NetworkConnectionInfo -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-networkconnectioninfo +schema: 2.0.0 +title: Get-NetworkConnectionInfo --- # Get-NetworkConnectionInfo @@ -35,7 +36,7 @@ This cmdlet retrieves the following configuration information for each network a - AdapterGuid: This field displays the GUID assigned to the network adapter by Windows. - MacAddress: This field displays the media access control (MAC) address of the network adapter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example retrieves network configuration information for all network adapter ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server you want to query. You can use any value that uniquely identifies the server. For example: - Name @@ -62,7 +66,6 @@ If you don't use the Identity parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -80,7 +86,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Notification.md b/exchange/exchange-ps/ExchangePowerShell/Get-Notification.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-Notification.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Notification.md index 45e694f043..b960600134 100644 --- a/exchange/exchange-ps/exchange/Get-Notification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Notification.md @@ -1,18 +1,22 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-notification -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-Notification -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-notification +schema: 2.0.0 +title: Get-Notification --- # Get-Notification ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might 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: @@ -52,7 +56,7 @@ Get-Notification [-ProcessType ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,13 +84,15 @@ This example displays detailed information for the specified notification event. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the notification event that you want to view. You identify the notification event by its AlternativeID property value (a GUID). You can find this value by running the command Get-Notification | Format-List DisplayName,AlternateID,StartTime,Status,Type. ```yaml Type: EwsStoreObjectIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -96,6 +102,9 @@ Accept wildcard characters: False ``` ### -Settings + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Settings switch includes the ProcessType and NotificationEmail property values in the results. You don't need to specify a value with this switch. @@ -108,7 +117,6 @@ You can't use this switch with the Summary switch. Type: SwitchParameter Parameter Sets: Settings Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -118,6 +126,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -126,7 +137,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +146,9 @@ Accept wildcard characters: False ``` ### -ProcessType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ProcessType parameter filters the results by the type of notification event. Valid values are: - CertExpiry @@ -146,9 +159,8 @@ The ProcessType parameter filters the results by the type of notification event. ```yaml Type: AsyncOperationType -Parameter Sets: Settings +Parameter Sets: Settings, Filter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -157,27 +169,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: AsyncOperationType -Parameter Sets: Filter -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -ResultSize -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -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: Filter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -187,6 +188,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -195,7 +199,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -205,6 +208,9 @@ Accept wildcard characters: False ``` ### -Summary + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Summary switch includes only the ProcessType and Status property values in the results. You don't need to specify a value with this switch. You can't use this switch with the Settings switch. @@ -213,7 +219,6 @@ You can't use this switch with the Settings switch. Type: SwitchParameter Parameter Sets: Identity, Filter 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-OMEConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-OMEConfiguration.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-OMEConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OMEConfiguration.md index 801c20e7db..a7361a7e95 100644 --- a/exchange/exchange-ps/exchange/Get-OMEConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OMEConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-omeconfiguration applicable: Exchange Online, Exchange Online Protection -title: Get-OMEConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-omeconfiguration +schema: 2.0.0 +title: Get-OMEConfiguration --- # Get-OMEConfiguration @@ -26,7 +27,7 @@ Get-OMEConfiguration [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example returns detailed information for all OME configurations in the orga ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the OME configuration that you want to get. The default OME configuration has the Identity value "OME Configuration". ```yaml Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md b/exchange/exchange-ps/ExchangePowerShell/Get-OMEMessageStatus.md similarity index 72% rename from exchange/exchange-ps/exchange/Get-OMEMessageStatus.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OMEMessageStatus.md index 1162642bbb..94749431a1 100644 --- a/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OMEMessageStatus.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-omemessagestatus applicable: Exchange Online -title: Get-OMEMessageStatus -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-omemessagestatus +schema: 2.0.0 +title: Get-OMEMessageStatus --- # Get-OMEMessageStatus @@ -26,9 +27,9 @@ Get-OMEMessageStatus -MessageId ``` ## DESCRIPTION -If encryption for the message was successfully revoked, the command will return the message: `The encrypted email with the subject "" and Message ID "" was successfully revoked`. +If encryption for the message was successfully revoked, the command returns the message: `The encrypted email with the subject "" and Message ID "" was successfully revoked`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,7 +43,10 @@ This example returns the encryption revocation status for the specified message. ## PARAMETERS ### -MessageId -The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +> Applicable: Exchange Online + +The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which might include angle brackets) and enclose the value in quotation marks (for example, ""). You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft Purview compliance portal. @@ -50,7 +54,6 @@ You can find the Message ID for a message in Message Trace or the Message Encryp Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-OabVirtualDirectory.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OabVirtualDirectory.md index 274bd7b330..0411b0f962 100644 --- a/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OabVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-oabvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OabVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-oabvirtualdirectory +schema: 2.0.0 +title: Get-OabVirtualDirectory --- # Get-OabVirtualDirectory @@ -39,7 +40,7 @@ Get-OabVirtualDirectory [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example returns detailed information for the OAB virtual directory named "O ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the OAB virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -81,7 +85,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -104,7 +110,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -122,7 +130,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -158,7 +170,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/Get-OfflineAddressBook.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OfflineAddressBook.md index dbf02a696b..b5c271b429 100644 --- a/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OfflineAddressBook.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-offlineaddressbook -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OfflineAddressBook -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-offlineaddressbook +schema: 2.0.0 +title: Get-OfflineAddressBook --- # Get-OfflineAddressBook ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-OfflineAddressBook cmdlet to view offline address books (OABs). @@ -37,7 +38,7 @@ Get-OfflineAddressBook [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,6 +66,9 @@ This example returns specific properties for all existing OABs, including the Ge ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the OAB that you want to view. You can use any value that uniquely identifies the OAB. For example: - Name or \\Name @@ -77,7 +81,6 @@ You can't use this parameter with the Server parameter. Type: OfflineAddressBookIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. **Note**: This parameter isn't relevant in Exchange 2013 or later. The Server property for an OAB is blank, because the OAB is generated by an arbitration mailbox. @@ -105,7 +111,6 @@ You can't use this parameter with the Identity parameter. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -123,7 +131,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md b/exchange/exchange-ps/ExchangePowerShell/Get-OnPremisesOrganization.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OnPremisesOrganization.md index 18d268514c..bb8d46bbe8 100644 --- a/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OnPremisesOrganization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-onpremisesorganization applicable: Exchange Online, Exchange Online Protection -title: Get-OnPremisesOrganization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-onpremisesorganization +schema: 2.0.0 +title: Get-OnPremisesOrganization --- # Get-OnPremisesOrganization @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-OnPremisesOrganization cmdlet to retrieve settings for the OnPremisesOrganization object that has been created for a hybrid deployment. +Use the Get-OnPremisesOrganization cmdlet to retrieve settings for the OnPremisesOrganization object that is created for a hybrid deployment. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -28,9 +29,9 @@ Get-OnPremisesOrganization [[-Identity] ] ## DESCRIPTION The OnPremisesOrganization object represents an on-premises Exchange organization configured for hybrid deployment with a Microsoft 365 organization. It's used with the Hybrid Configuration wizard and is typically created automatically when the hybrid deployment is initially configured by the wizard. You can use the Get-OnPremisesOrganization cmdlet to view the properties of the OnPremisesOrganization object in the Microsoft 365 organization. -Manual modification of this object may result in hybrid deployment misconfiguration. We strongly recommend that you use the Hybrid Configuration wizard to modify this object in the Microsoft 365 organization. +Manual modification of this object might result in hybrid deployment misconfiguration. We strongly recommend that you use the Hybrid Configuration wizard to modify this object in the Microsoft 365 organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example retrieves the on-premises organization settings by using the FQDN o ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - Canonical name @@ -61,7 +65,6 @@ The Identity parameter specifies the identity of the on-premises organization ob Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-OnlineMeetingConfiguration.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OnlineMeetingConfiguration.md index 57d2252911..4cec7f369b 100644 --- a/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OnlineMeetingConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-onlinemeetingconfiguration -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OnlineMeetingConfiguration -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-onlinemeetingconfiguration +schema: 2.0.0 +title: Get-OnlineMeetingConfiguration --- # Get-OnlineMeetingConfiguration @@ -34,7 +35,7 @@ Exchange Online maintains a per-user cache of Skype for Business Online meeting - LastSyncTime: The last time Exchange Online successfully synchronized meeting coordinates from Skype for Business Online. - LastSuccessfulSyncTime: The last time Exchange Online successfully cleaned the cached of used Skype for Business Online meeting coordinates. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example gets the Skype Meetings configuration for the specified mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OrganizationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationConfig.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-OrganizationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OrganizationConfig.md index 0d00218842..2da5c4b45a 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-OrganizationConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-organizationconfig +schema: 2.0.0 +title: Get-OrganizationConfig --- # Get-OrganizationConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-OrganizationConfig cmdlet to get configuration data for an Exchange organization. @@ -26,7 +27,7 @@ Get-OrganizationConfig [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +61,9 @@ If the value of EwsApplicationAccessPolicy is EnforceBlockList, all applications ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -70,7 +74,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationRelationship.md similarity index 72% rename from exchange/exchange-ps/exchange/Get-OrganizationRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OrganizationRelationship.md index 0c2f80f334..4c576ed8d4 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationRelationship.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-OrganizationRelationship -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-organizationrelationship +schema: 2.0.0 +title: Get-OrganizationRelationship --- # Get-OrganizationRelationship ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Get-OrganizationRelationship cmdlet to retrieve settings for an organization relationship that has been created for federated sharing with other federated Exchange organizations or for hybrid deployments with Exchange Online. +Use the Get-OrganizationRelationship cmdlet to retrieve settings for an organization relationship that is created for federated sharing with other federated Exchange organizations or for hybrid deployments with Exchange Online. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -27,7 +28,7 @@ Get-OrganizationRelationship [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example retrieves the organization relationship settings by using the FQDN ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the organizational relationship. You can use the following values: - Canonical name @@ -58,7 +62,6 @@ The Identity parameter specifies the identity of the organizational relationship Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -76,7 +82,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationSegment.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-OrganizationSegment.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OrganizationSegment.md index 12687a5a45..3d309fe6b7 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationSegment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationsegment applicable: Security & Compliance -title: Get-OrganizationSegment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-organizationsegment +schema: 2.0.0 +title: Get-OrganizationSegment --- # Get-OrganizationSegment @@ -55,6 +56,9 @@ This example returns detailed information about the organization segment named E ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the organization segment that you want to view. You can use a value that uniquely identifies the segment. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the organization segment that you want to view. Type: PolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -89,4 +92,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-OrganizationalUnit.md b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationalUnit.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-OrganizationalUnit.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OrganizationalUnit.md index 01e951b29f..0ad6645a48 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationalUnit.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationalUnit.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationalunit -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OrganizationalUnit -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-organizationalunit +schema: 2.0.0 +title: Get-OrganizationalUnit --- # Get-OrganizationalUnit ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-OrganizationalUnit cmdlet to view a list of organizational units (OUs) that exist in your organization. @@ -42,7 +43,7 @@ Get-OrganizationalUnit [-SearchText ] ## DESCRIPTION The Get-OrganizationalUnit cmdlet is used by the Exchange admin center to populate fields that display OU information. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ For more information about pipelining and the Format-Table cmdlet, see [About Pi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the OU or domain that you want to view. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -80,7 +84,6 @@ You can use this parameter with the SearchText parameter. Type: ExtendedOrganizationalUnitIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +104,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -IncludeContainers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeContainers switch instructs the command to return containers in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -SingleNodeOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SingleNodeOnly switch instructs the command to return only the first level child OUs beneath the OU specified in the Identity parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -SearchText + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SearchText parameter enables you to search the names of all OUs in your organization for the specified string. Only the OUs that match the string you specify are returned. If the string you specify contains spaces, enclose it in quotation marks ("). You can't use this parameter with the Identity parameter. @@ -164,7 +178,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Search 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-OutboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnector.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-OutboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnector.md index ef832c3069..882495a3e6 100644 --- a/exchange/exchange-ps/exchange/Get-OutboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-outboundconnector applicable: Exchange Online, Exchange Online Protection -title: Get-OutboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-outboundconnector +schema: 2.0.0 +title: Get-OutboundConnector --- # Get-OutboundConnector @@ -31,7 +32,7 @@ Get-OutboundConnector [[-Identity] ] ## DESCRIPTION Outbound connectors send email messages to remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example displays detailed information about the Outbound connector named Co ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Outbound connector that you want to view. You can use any value that uniquely identifies the connector. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the Outbound connector that you want to view. Y Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -65,10 +68,13 @@ Accept wildcard characters: False ``` ### -IncludeTestModeConnectors + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeTestModeConnectors parameter filters the results by Outbound connectors that are in test mode. Valid values are: - $true: Only Outbound connectors that are in test mode are returned in the results. -- $false: All Outbound connectors that aren't in test mode are returned in the results. This is the default value. +- $false: All Outbound connectors that aren't in test mode are returned in the results. This value is the default. You configure an Outbound connector in test mode by using the TestMode parameter on the New-OutboundConnector or Set-OutboundConnector cmdlets. @@ -76,7 +82,6 @@ You configure an Outbound connector in test mode by using the TestMode parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,10 +91,13 @@ Accept wildcard characters: False ``` ### -IsTransportRuleScoped + +> Applicable: Exchange Online, Exchange Online Protection + The IsTransportRuleScoped parameter filters the results by Outbound connectors that are scoped to transport rules (also known as mail flow rules). Valid values are: - $true: Only Outbound connectors that are scoped to transport rules are returned in the results. -- $false: All Outbound connectors that aren't scoped to transport rules are returned in the results. This is the default value. +- $false: All Outbound connectors that aren't scoped to transport rules are returned in the results. This value is the default. You scope a transport rule to a specific Outbound connector by using the RouteMessageOutboundConnector parameter on the New-TransportRule or Set-TransportRule cmdlets. @@ -97,7 +105,6 @@ You scope a transport rule to a specific Outbound connector by using the RouteMe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + 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 diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnectorReport.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnectorReport.md index a111c53994..7df51454de 100644 --- a/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnectorReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-outboundconnectorreport applicable: Exchange Online, Exchange Online Protection -title: Get-OutboundConnectorReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-outboundconnectorreport +schema: 2.0.0 +title: Get-OutboundConnectorReport --- # Get-OutboundConnectorReport @@ -27,7 +28,7 @@ Get-OutboundConnectorReport [-Domain ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example shows the Outbound connector that's used to deliver mail to the con ## PARAMETERS ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter specifies the domain you want to test. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -57,13 +60,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookAnywhere.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-OutlookAnywhere.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OutlookAnywhere.md index e2189d867d..84da3e4ffd 100644 --- a/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookAnywhere.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-outlookanywhere -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OutlookAnywhere -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-outlookanywhere +schema: 2.0.0 +title: Get-OutlookAnywhere --- # Get-OutlookAnywhere @@ -39,7 +40,7 @@ Get-OutlookAnywhere [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +61,9 @@ This example returns information about the Outlook Anywhere virtual directory na ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Outlook Anywhere virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -74,7 +78,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -97,7 +103,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -115,7 +123,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,6 +150,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -151,7 +163,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookProtectionRule.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OutlookProtectionRule.md index ed2ad0aa94..dbe9cc5f7e 100644 --- a/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-outlookprotectionrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OutlookProtectionRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-outlookprotectionrule +schema: 2.0.0 +title: Get-OutlookProtectionRule --- # Get-OutlookProtectionRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS **Note**: This cmdlet is no longer supported in the cloud-based service. -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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-OutlookProtectionRule cmdlet to retrieve Microsoft Outlook protection rules configured in an organization. @@ -31,7 +32,7 @@ Get-OutlookProtectionRule [[-Identity] ] ## DESCRIPTION Outlook protection rules are used to automatically Information Rights Management (IRM)-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To IRM-protect messages based on message content, use transport protection rules. For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,13 +55,15 @@ The Identity parameter is positional. When used after the cmdlet name, the param ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter identifies an Outlook protection rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -78,7 +84,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OutlookProvider.md b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookProvider.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-OutlookProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OutlookProvider.md index 72b2e977b7..1c4402fee5 100644 --- a/exchange/exchange-ps/exchange/Get-OutlookProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-outlookprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OutlookProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-outlookprovider +schema: 2.0.0 +title: Get-OutlookProvider --- # Get-OutlookProvider @@ -29,7 +30,7 @@ Get-OutlookProvider [[-Identity] ] ## DESCRIPTION The Get-OutlookProvider cmdlet gets the global settings from the AutoDiscoverConfig object in Active Directory and returns an OutlookProvider object to be managed in the Exchange admin center. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example returns detailed information for the Outlook provider named WEB. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the ADIDParameter value of the MAPI protocol that you want to view. Typical values are: - EXCH @@ -60,7 +64,6 @@ The Identity parameter specifies the ADIDParameter value of the MAPI protocol th Type: OutlookProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-OwaMailboxPolicy.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OwaMailboxPolicy.md index d3d81a63ed..835a172b5c 100644 --- a/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OwaMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-owamailboxpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OwaMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-owamailboxpolicy +schema: 2.0.0 +title: Get-OwaMailboxPolicy --- # Get-OwaMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-OwaMailboxPolicy cmdlet to view Outlook on the web mailbox policies in the organization. @@ -27,7 +28,7 @@ Get-OwaMailboxPolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example retrieves the information for the mailbox policy named Corporate fo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the mailbox policy that you want to view. You c Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -83,7 +89,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-OwaVirtualDirectory.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OwaVirtualDirectory.md index 6087a13fe7..1595552983 100644 --- a/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OwaVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-owavirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OwaVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-owavirtualdirectory +schema: 2.0.0 +title: Get-OwaVirtualDirectory --- # Get-OwaVirtualDirectory @@ -43,7 +44,7 @@ The Get-OwaVirtualDirectory cmdlet can be run on a local server or run remotely The Get-OwaVirtualDirectory cmdlet can be run on any server that has the Exchange Server administration tools installed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,6 +72,9 @@ This example returns a summary list of all Outlook on the web virtual directorie ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the OWA virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -85,7 +89,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -108,7 +114,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -126,7 +134,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +143,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -162,7 +174,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PartnerApplication.md b/exchange/exchange-ps/ExchangePowerShell/Get-PartnerApplication.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-PartnerApplication.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PartnerApplication.md index 1e1e76f5db..2c16113aca 100644 --- a/exchange/exchange-ps/exchange/Get-PartnerApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PartnerApplication.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-partnerapplication -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PartnerApplication -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-partnerapplication +schema: 2.0.0 +title: Get-PartnerApplication --- # Get-PartnerApplication ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-PartnerApplication cmdlet to retrieve settings for a partner application. @@ -30,7 +31,7 @@ Get-PartnerApplication [[-Identity] ] ## DESCRIPTION You can configure partner applications such as Microsoft SharePoint to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://learn.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example retrieves settings for all partner applications configured in Excha ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of a partner application. ```yaml Type: PartnerApplicationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -68,7 +74,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -86,7 +94,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md b/exchange/exchange-ps/ExchangePowerShell/Get-PendingDelicenseUser.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PendingDelicenseUser.md index 43ecd543dd..ffc321eb50 100644 --- a/exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PendingDelicenseUser.md @@ -1,15 +1,15 @@ --- -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 +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-pendingdelicenseuser +schema: 2.0.0 +title: Get-PendingDelicenseUser --- - # Get-PendingDelicenseUser ## SYNOPSIS @@ -34,7 +34,7 @@ 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,11 +57,14 @@ This example returns detailed information about the pending mailbox license remo 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. +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 + +> Applicable: Exchange Online, Exchange Online Protection + 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: @@ -80,7 +83,6 @@ You can't use this parameter with the ShowDueObjectsOnly switch. Type: RecipientIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -90,13 +92,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + 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 @@ -106,6 +110,9 @@ Accept wildcard characters: False ``` ### -ShowDueObjectsOnly + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -114,7 +121,6 @@ You can't use this switch with the Identity parameter. Type: SwitchParameter Parameter Sets: TenantLevelParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-PendingFederatedDomain.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PendingFederatedDomain.md index e646d32251..8297d834ea 100644 --- a/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PendingFederatedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-pendingfederateddomain -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PendingFederatedDomain -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-pendingfederateddomain +schema: 2.0.0 +title: Get-PendingFederatedDomain --- # Get-PendingFederatedDomain @@ -25,7 +26,7 @@ Get-PendingFederatedDomain [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES diff --git a/exchange/exchange-ps/exchange/Get-PerimeterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-PerimeterConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-PerimeterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PerimeterConfig.md index 0559a00b0d..84bfae4905 100644 --- a/exchange/exchange-ps/exchange/Get-PerimeterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PerimeterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-perimeterconfig applicable: Exchange Online -title: Get-PerimeterConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-perimeterconfig +schema: 2.0.0 +title: Get-PerimeterConfig --- # Get-PerimeterConfig @@ -40,13 +41,15 @@ This example returns the list of gateway servers and internal email servers in y ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-PhishSimOverridePolicy.md similarity index 68% rename from exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PhishSimOverridePolicy.md index 7cb3d2c953..d32e6822a1 100644 --- a/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PhishSimOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-phishsimoverridepolicy applicable: Exchange Online -title: Get-PhishSimOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-phishsimoverridepolicy +schema: 2.0.0 +title: Get-PhishSimOverridePolicy --- # Get-PhishSimOverridePolicy @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS 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 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). +Use the Get-PhishSimOverridePolicy cmdlet to view non-Microsoft phishing simulation override policies that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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 +26,7 @@ Get-PhishSimOverridePolicy [[-Identity] ] [ ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -39,6 +40,9 @@ This example returns detailed information about the one and only phishing simula ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -50,7 +54,6 @@ The Identity parameter specifies the phishing simulation override policy that yo Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Place.md b/exchange/exchange-ps/ExchangePowerShell/Get-Place.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-Place.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Place.md index c13137555b..cd0df94272 100644 --- a/exchange/exchange-ps/exchange/Get-Place.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Place.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-place applicable: Exchange Online -title: Get-Place -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-place +schema: 2.0.0 +title: Get-Place --- # Get-Place @@ -39,7 +40,7 @@ Get-Place [-Type ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example returns all room mailboxes. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the room mailbox that you want to view. You can use any value that uniquely identifies the room. For example: - Name @@ -82,7 +86,6 @@ You can't use this parameter with the Type parameter. Type: RecipientIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -92,13 +95,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Online + The Type parameter filters the results by the type of room mailbox. Valid values are: - Room @@ -136,7 +146,6 @@ You can't use this parameter with the Identity parameter. Type: GetPlaceType Parameter Sets: AllPlaces Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PolicyConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-PolicyConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-PolicyConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PolicyConfig.md index 7b985e28c4..56021327f8 100644 --- a/exchange/exchange-ps/exchange/Get-PolicyConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PolicyConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-policyconfig applicable: Security & Compliance -title: Get-PolicyConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-policyconfig +schema: 2.0.0 +title: Get-PolicyConfig --- # Get-PolicyConfig @@ -39,13 +40,15 @@ This example returns the endpoint restrictions that are available in the organiz ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-PolicyTipConfig.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-PolicyTipConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PolicyTipConfig.md index 0704474cc3..fddb48a8f3 100644 --- a/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PolicyTipConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-policytipconfig -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PolicyTipConfig -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-policytipconfig +schema: 2.0.0 +title: Get-PolicyTipConfig --- # Get-PolicyTipConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-PolicyTipConfig cmdlet to view the data loss prevention (DLP) Policy Tips in your organization. @@ -37,7 +38,7 @@ Get-PolicyTipConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,6 +66,9 @@ This example returns details about the custom English Policy Tip for the action ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the custom Policy Tip you want to view. You can use any value that uniquely identifies the custom Policy Tip. For example: - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. @@ -78,7 +82,6 @@ You can't use the Identity parameter with the Action, Locale or Original paramet Type: PolicyTipConfigIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Action parameter filters the Policy Tips by action. Valid values for this parameter are: - NotifyOnly @@ -102,7 +108,6 @@ You can't use the Action parameter with the Identity parameter. Type: PolicyTipMessageConfigAction Parameter Sets: Parameters Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -120,7 +128,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Locale parameter specifies a locale-specific version of the Policy Tip. Valid values for this parameter are supported locale codes. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). @@ -140,7 +150,6 @@ You can't use the Locale parameter with the Identity parameter. Type: CultureInfo Parameter Sets: Parameters Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -Original + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Original switch specifies whether to include built-in Policy Tips in the results. You don't need to specify a value with this switch. You can't use the Original switch with the Identity parameter. @@ -158,7 +170,6 @@ You can't use the Original switch with the Identity parameter. Type: SwitchParameter Parameter Sets: Parameters 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-PopSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-PopSettings.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-PopSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PopSettings.md index 4223b39960..706330731d 100644 --- a/exchange/exchange-ps/exchange/Get-PopSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PopSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-popsettings -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PopSettings -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-popsettings +schema: 2.0.0 +title: Get-PopSettings --- # Get-PopSettings @@ -27,7 +28,7 @@ Get-PopSettings [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,13 +49,15 @@ This example returns detailed information for the Microsoft Exchange POP3 servic ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -77,7 +83,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-PowerShellVirtualDirectory.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PowerShellVirtualDirectory.md index b46a6dbd1e..328b56bf0b 100644 --- a/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PowerShellVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-powershellvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PowerShellVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-powershellvirtualdirectory +schema: 2.0.0 +title: Get-PowerShellVirtualDirectory --- # Get-PowerShellVirtualDirectory @@ -39,7 +40,7 @@ Get-PowerShellVirtualDirectory [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example returns a summary list of all PowerShell virtual directories in the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the PowerShell virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -81,7 +85,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -104,7 +110,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -122,7 +130,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -158,7 +170,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md b/exchange/exchange-ps/ExchangePowerShell/Get-ProtectionAlert.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ProtectionAlert.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ProtectionAlert.md index 2e99bc420c..2085c02ebd 100644 --- a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ProtectionAlert.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-protectionalert applicable: Security & Compliance -title: Get-ProtectionAlert -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-protectionalert +schema: 2.0.0 +title: Get-ProtectionAlert --- # Get-ProtectionAlert @@ -48,6 +49,9 @@ This example returns detailed information about the specified alert policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the alert policy that you want to view. You can use any value that uniquely identifies the alert policy. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the alert policy that you want to view. You can Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -IncludeRuleXml + +> Applicable: Security & Compliance + {{ Fill IncludeRuleXml Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolder.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-PublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolder.md index 6236c3d432..6c9add4dfd 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolder +schema: 2.0.0 +title: Get-PublicFolder --- # Get-PublicFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-PublicFolder cmdlet to retrieve the attributes of a public folder or a set of public folders. @@ -69,7 +70,7 @@ Get-PublicFolder [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,13 +119,15 @@ This example returns the public folders that reside in the public folder content ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name and path of the public folder you want to view. A valid value uses the syntax: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. ```yaml Type: PublicFolderIdParameter Parameter Sets: GetChildren, Recurse, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -134,6 +137,9 @@ Accept wildcard characters: False ``` ### -GetChildren + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GetChildren switch specifies whether to return only the children of the folder specified by the Identity parameter. You don't need to specify a value with this switch. You can't use this switch with the Recurse or LostAndFound switches. @@ -142,7 +148,6 @@ You can't use this switch with the Recurse or LostAndFound switches. Type: SwitchParameter Parameter Sets: GetChildren Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -152,6 +157,9 @@ Accept wildcard characters: False ``` ### -Recurse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Recurse switch specifies whether to return the specified public folder and all its children. You don't need to specify a value with this switch. You can't use this switch with the GetChildren or LostAndFound switches. @@ -160,7 +168,6 @@ You can't use this switch with the GetChildren or LostAndFound switches. Type: SwitchParameter Parameter Sets: Recurse Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -170,6 +177,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -178,7 +188,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +197,9 @@ Accept wildcard characters: False ``` ### -LostAndFound + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LostAndFound switch specifies whether to return only orphaned folders that are located in \\NON\_IPM\_SUBTREE\\LOST\_AND\_FOUND. You don't need to specify a value with this switch. The LOST\_AND\_FOUND folder holds missing folders that are recreated by the public folder hierarchy reconciliation process when the folder exists in a secondary public folder mailbox, but not in the primary. @@ -198,7 +210,6 @@ You can't use this switch with the Identity parameter or the Recurse or LostAndF Type: SwitchParameter Parameter Sets: LostAndFound Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -208,6 +219,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the identity of the hierarchy public folder mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -225,7 +239,6 @@ The Mailbox parameter specifies the identity of the hierarchy public folder mail Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -235,6 +248,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -243,7 +259,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,15 +268,17 @@ Accept wildcard characters: False ``` ### -ResidentFolders + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResidentFolders switch specifies whether to return public folders that reside in a specific content public folder mailbox. You don't need to specify a value with this switch. -If you don't use this switch, the command will return only public folders whose contents reside in the primary hierarchy public folder mailbox. +If you don't use this switch, the command returns only public folders whose contents reside in the primary hierarchy public folder mailbox. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -271,13 +288,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. The default maximum is 10,000. For no limit on the returned results, set this parameter to Unlimited. This parameter can only be passed in combination with the Recurse or GetChildren parameters. ```yaml Type: Unlimited Parameter Sets: GetChildren, Recurse, LostAndFound Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,6 +306,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: @@ -300,7 +322,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: GetChildren, Recurse, Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderAdministrativePermission.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderAdministrativePermission.md index 8827234280..b11d5b7b4e 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderAdministrativePermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderadministrativepermission applicable: Exchange Server 2010 -title: Get-PublicFolderAdministrativePermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolderadministrativepermission +schema: 2.0.0 +title: Get-PublicFolderAdministrativePermission --- # Get-PublicFolderAdministrativePermission @@ -37,7 +38,7 @@ Get-PublicFolderAdministrativePermission [-Identity] [ ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,6 +66,9 @@ This example retrieves the owner of the public folder My Public Folder. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -73,7 +77,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -83,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010 + The Owner switch returns the owner of the public folder object. You don't need to specify a value with this switch. You can't use this switch with the User parameter. @@ -107,7 +115,6 @@ You can't use this switch with the User parameter. Type: SwitchParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: - Name @@ -128,7 +138,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010 + The User parameter filters the results by who has admin permissions on the specified public folder. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -163,7 +175,6 @@ You can't use this parameter with the Owner switch. Type: SecurityPrincipalIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderClientPermission.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderClientPermission.md index cbf1b56f79..5eac0aa6f6 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderClientPermission.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderclientpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderClientPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolderclientpermission +schema: 2.0.0 +title: Get-PublicFolderClientPermission --- # Get-PublicFolderClientPermission ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-PublicFolderClientPermission cmdlet to retrieve the user permissions for a public folder. @@ -31,9 +32,9 @@ Get-PublicFolderClientPermission [-Identity] ``` ## DESCRIPTION -To view the permissions that are available on public folders, see [Public folder permissions for Exchange Server](https://support.microsoft.com/help/2573274). +To view the permissions that are available on public folders, see [Public folder permissions for Exchange Server](https://learn.microsoft.com/exchange/troubleshoot/public-folders/public-folder-permissions-for-exchange-server). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example retrieves the permissions for the public folder My Public Folder, f ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -62,7 +66,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -80,7 +86,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -98,7 +106,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All)) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: @@ -121,7 +131,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The User parameter specifies the user for whom you want to view the permissions on the public folder. For the best results, we recommend using the following values: @@ -142,7 +154,6 @@ For the best results, we recommend using the following values: Type: PublicFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the public folder mailbox that you want to view the permissions for. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -171,7 +185,6 @@ By default, the permissions are returned from the primary public folder mailbox. Type: MailboxIdParameter Parameter Sets: (All) 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-PublicFolderDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderDatabase.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderDatabase.md index 163d873ee4..4f590bdc8e 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderdatabase -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PublicFolderDatabase -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolderdatabase +schema: 2.0.0 +title: Get-PublicFolderDatabase --- # Get-PublicFolderDatabase @@ -45,7 +46,7 @@ You can specify either the Server or Identity parameter, but not both. Only the When you run the Get-PublicFolderDatabase cmdlet with no parameters, it returns attributes of all of the public folder databases in the Exchange organization. To return specific database properties (including backup and mount status information) where the Get-PublicFolderDatabase cmdlet has to contact servers directly or perform a complex or slow calculation, make sure you use the Status parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +74,9 @@ This example returns information about all public folders on Server01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the public folder database that you want to view. You can use any value that uniquely identifies the database. For example: - Name @@ -87,7 +91,6 @@ If you have multiple databases with the same name, the cmdlet retrieves all data Type: DatabaseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: - Name @@ -110,7 +116,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -IncludePreExchange2010 + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IncludePreExchange2010 switch specifies whether to include information about Exchange 2003 or Exchange 2007 public folders in the results. You don't need to specify a value with this switch. @@ -146,7 +156,6 @@ This switch isn't useful in commands where you use the Server or Identity parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Status switch specifies whether to include additional backup and mount status information for servers running Exchange 2010. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -IncludeCorrupted + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderItemStatistics.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderItemStatistics.md index 7e8d13e1d4..cbc33d3800 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderItemStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderitemstatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderItemStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolderitemstatistics +schema: 2.0.0 +title: Get-PublicFolderItemStatistics --- # Get-PublicFolderItemStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-PublicFolderItemStatistics cmdlet to view information about items within a specified public folder. Information returned includes subject, last modification time, creation time, attachments, message size, and the type of item. You can use this raw information to better understand the distribution of items and item characteristics across public folders. @@ -30,7 +31,7 @@ Get-PublicFolderItemStatistics [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,13 +65,15 @@ This example exports the output of the Get-PublicFolderItemStatistics command to ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the following format: \\TopLevelPublicFolder\\PublicFolder ```yaml Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -88,7 +94,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the identity of the hierarchy public folder mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -115,7 +123,6 @@ The Mailbox parameter specifies the identity of the hierarchy public folder mail Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -133,7 +143,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All)) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: @@ -156,7 +168,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxDiagnostics.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxDiagnostics.md index d7b0c82238..e818298491 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxDiagnostics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermailboxdiagnostics -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMailboxDiagnostics -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermailboxdiagnostics +schema: 2.0.0 +title: Get-PublicFolderMailboxDiagnostics --- # Get-PublicFolderMailboxDiagnostics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-PublicFolderMailboxDiagnostics cmdlet to view event-level information about a public folder mailbox. This information can be used to troubleshoot public folder issues. @@ -31,7 +32,7 @@ Get-PublicFolderMailboxDiagnostics [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example returns the diagnostic information for the public folder mailbox Sa ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the public folder mailbox. The public folder mailbox is where the content of the public folder resides. You can use any value that uniquely identifies the mailbox. For example: @@ -71,7 +75,6 @@ You can use any value that uniquely identifies the mailbox. For example: Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -90,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -108,7 +116,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -IncludeDumpsterInfo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeDumpsterInfo specifies whether to include diagnostic information for the \\NON\_IPM\_TREE\\DUMPSTER\_ROOT folder (the dumpster for public folder mailboxes is included in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -IncludeHierarchyInfo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeHierarchyInfo switch specifies whether to include folder hierarchy information in the results. You don't need to specify a value with this switch. Using this switch returns the following information: @@ -153,7 +165,6 @@ Using this switch returns the following information: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -163,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequest.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequest.md index 4fe2797ff4..2bf548c962 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMailboxMigrationRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequest +schema: 2.0.0 +title: Get-PublicFolderMailboxMigrationRequest --- # Get-PublicFolderMailboxMigrationRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-PublicFolderMailboxMigrationRequest cmdlet to view the status of individual jobs in public folder migration batches that were created by using the New-MigrationBatch cmdlet. @@ -48,7 +49,7 @@ The Get-PublicFolderMailboxMigrationRequest cmdlet displays the following proper - TargetMailbox: The mailbox being migrated. - Status: The current status of the job. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,6 +84,9 @@ This example returns duplicate public folder migration requests (requests create ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the public folder mailbox migration request that you want to view. The value uses the syntax: `\PublicFolderMailboxMigration` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). You can't use this parameter with the following parameters: @@ -98,7 +102,6 @@ You can't use this parameter with the following parameters: Type: PublicFolderMailboxMigrationRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter filters the results by the friendly BatchName value that was assigned when the batch job was created. The format of this value is: `MigrationService:`. You can't use this parameter with the Identity parameter. @@ -116,7 +122,6 @@ 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, Exchange Online Required: False Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -134,7 +142,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: @@ -157,7 +167,6 @@ 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 Required: False Position: Named @@ -167,6 +176,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the public folder mailbox migration request. If the name was not specified at creation, the default value is `PublicFolderMailboxMigration` (for example, `PublicFolderMailboxMigration2ffdef13-01b9-4586-af2b-d5a5482010a8`). You can't use this parameter with the Identity parameter. @@ -175,7 +187,6 @@ 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, Exchange Online Required: False Position: Named @@ -185,6 +196,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -199,7 +213,6 @@ 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 Required: False Position: Named @@ -209,13 +222,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -225,6 +240,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -244,7 +262,6 @@ 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, Exchange Online Required: False Position: Named @@ -254,6 +271,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -262,7 +282,6 @@ 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, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequestStatistics.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequestStatistics.md index cb164285ad..b2aa35b5b9 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequestStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequeststatistics -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMailboxMigrationRequestStatistics -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequeststatistics +schema: 2.0.0 +title: Get-PublicFolderMailboxMigrationRequestStatistics --- # Get-PublicFolderMailboxMigrationRequestStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-PublicFolderMailboxMigrationRequestStatistics cmdlet to view the detailed status of individual jobs in a public folder migration batch created using New-MigrationBatch cmdlet. @@ -61,7 +62,7 @@ The Get-PublicFolderMailboxMigrationRequestStatistics cmdlet displays the follow - TargetMailbox: The mailbox being migrated. - PercentComplete: The percentage of job completion. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,6 +76,9 @@ This example uses the Identity parameter to return information about the specifi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the public folder mailbox migration request. The default identity value is `\PublicFolderMailboxMigration` (for example, `PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). You can't use this parameter with the RequestQueue and RequestGuid parameters. @@ -83,7 +87,6 @@ You can't use this parameter with the RequestQueue and RequestGuid parameters. Type: PublicFolderMailboxMigrationRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is for debugging purposes only. @@ -109,7 +115,6 @@ 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 Required: True Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -129,7 +137,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -147,7 +157,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -165,7 +177,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -183,7 +197,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,13 +206,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,6 +224,9 @@ Accept wildcard characters: False ``` ### -IncludeSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeSkippedItems Description }} @@ -217,7 +235,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -227,13 +244,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestGuid parameter specifies the unique RequestGuid identifier of the request that you want to view. To find the RequestGuid value, use the Get-PublicFolderMailboxMigrationRequest cmdlet. @@ -253,7 +275,6 @@ If you use this parameter, you also need to use the RequestQueue parameter. You Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequest.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequest.md index c001744a6d..39b9e08d9a 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermigrationrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PublicFolderMigrationRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermigrationrequest +schema: 2.0.0 +title: Get-PublicFolderMigrationRequest --- # Get-PublicFolderMigrationRequest @@ -45,7 +46,7 @@ Get-PublicFolderMigrationRequest [[-Identity] Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the public folder migration request that you want to view. You can use the following values: - GUID @@ -77,7 +81,6 @@ You can't use this parameter with other filtering parameters (BatchName, HighPri Type: PublicFolderMigrationRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BatchName parameter specifies the name that was given to a batch migration request. You can't use this parameter with the Identity parameter. @@ -95,7 +101,6 @@ 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 Required: False Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: - $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. @@ -132,7 +142,6 @@ 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 Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter filters the results by the name of the public folder migration request. You can't use this parameter with the Identity parameter. @@ -150,7 +162,6 @@ 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 Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -172,7 +186,6 @@ 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 Required: False Position: Named @@ -182,13 +195,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -217,7 +235,6 @@ 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 Required: False Position: Named @@ -227,6 +244,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -235,7 +255,6 @@ 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 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequestStatistics.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequestStatistics.md index 2ef492d5cb..500b1ab3dd 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequestStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermigrationrequeststatistics -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PublicFolderMigrationRequestStatistics -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermigrationrequeststatistics +schema: 2.0.0 +title: Get-PublicFolderMigrationRequestStatistics --- # Get-PublicFolderMigrationRequestStatistics @@ -47,7 +48,7 @@ Get-PublicFolderMigrationRequestStatistics -RequestQueue ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,6 +69,9 @@ This example returns additional information about the migration request and expo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the migration request that you want to view. You can use the following values: - Name @@ -79,7 +83,6 @@ You can't use this parameter with the RequestQueue or RequestGuid parameter. Type: PublicFolderMigrationRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is for debugging purposes only. The RequestQueue parameter filters the results by the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -103,7 +109,6 @@ 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 Required: True Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -121,7 +129,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,13 +174,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -179,13 +192,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -195,6 +210,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestGuid parameter specifies the GUID of a migration request. You can't use this parameter with the Identity parameter. @@ -203,7 +221,6 @@ 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 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequest.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequest.md index 5d234a047b..1c8e001ecc 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequest.md @@ -1,18 +1,19 @@ --- -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, Exchange Online -title: Get-PublicFolderMoveRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermoverequest +schema: 2.0.0 +title: Get-PublicFolderMoveRequest --- # Get-PublicFolderMoveRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might 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. @@ -43,7 +44,7 @@ Get-PublicFolderMoveRequest [-BatchName ] [-HighPriority ] [-Na ## DESCRIPTION Public folder move requests are used to move public folders between public folder mailboxes. After the move request is complete, you need to update the hierarchy using the Update-PublicFolderMailbox cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +65,9 @@ This example returns the status of in-progress and queued requests that are on t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the public folder move request. The default identity assigned to public folder move requests is \\PublicFolderMove. You can't use this parameter with the following parameters: @@ -79,7 +83,6 @@ 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, Exchange Online Required: False Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -AccountPartition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AccountPartition Description }} @@ -97,7 +103,6 @@ This parameter is available only in the cloud-based service. Type: AccountPartitionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter specifies the name that was given to a batch public folder move request. You can't use this parameter with the Identity parameter. @@ -115,7 +123,6 @@ 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, Exchange Online Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -133,7 +143,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: - $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. @@ -154,7 +166,6 @@ 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, Exchange Online Required: False Position: Named @@ -164,7 +175,10 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies the name of the public folder move request. If you didn't specify a name when creating the move request, PublicFolderMove will be the default name assigned to the request. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The Name parameter specifies the name of the public folder move request. If you didn't specify a name when creating the move request, PublicFolderMove is the default name assigned to the request. You can't use this parameter with the Identity parameter. @@ -172,7 +186,6 @@ 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, Exchange Online Required: False Position: Named @@ -182,6 +195,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Organization Description }} @@ -190,7 +206,6 @@ This parameter is available only in the cloud-based service. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -212,7 +230,6 @@ 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, Exchange Online Required: False Position: Named @@ -222,13 +239,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -238,6 +257,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -257,7 +279,6 @@ 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, Exchange Online Required: False Position: Named @@ -267,6 +288,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -275,7 +299,6 @@ 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, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequestStatistics.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequestStatistics.md index 475fc29578..69f5e45fee 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequestStatistics.md @@ -1,18 +1,19 @@ --- -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, Exchange Online -title: Get-PublicFolderMoveRequestStatistics -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermoverequeststatistics +schema: 2.0.0 +title: Get-PublicFolderMoveRequestStatistics --- # Get-PublicFolderMoveRequestStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-PublicFolderMoveRequestStatistics cmdlet to view detailed information about public folder move requests. @@ -47,7 +48,7 @@ Get-PublicFolderMoveRequestStatistics -RequestQueue [-Requ ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,6 +69,9 @@ This example returns the detailed statistics for the move request \\PublicFolder ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the public folder move request. The default public folder move request identity is \\PublicFolderMove. This parameter can't be used with the RequestQueue parameter. @@ -76,7 +80,6 @@ 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, Exchange Online Required: True Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is for debugging purposes only. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -100,7 +106,6 @@ 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, Exchange Online Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -118,7 +126,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DiagnosticInfo Description }} @@ -152,7 +164,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -170,7 +184,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,13 +193,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -196,6 +211,9 @@ Accept wildcard characters: False ``` ### -IncludeSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeSkippedItems Description }} @@ -204,7 +222,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -214,13 +231,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +249,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -238,7 +260,6 @@ This parameter can't be used with the Identity parameter. Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderStatistics.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderStatistics.md index 023a6d31c0..d08bcc2f72 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderStatistics.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderstatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolderstatistics +schema: 2.0.0 +title: Get-PublicFolderStatistics --- # Get-PublicFolderStatistics ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-PublicFolderStatistics cmdlet to retrieve statistical information about public folders, such as folder size and last logon time. @@ -30,7 +31,7 @@ Get-PublicFolderStatistics [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example retrieves statistics about the public folder Marketing\\2013\\Pamph ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -52,7 +56,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -70,7 +76,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the identity of the hierarchy public folder mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -97,7 +105,6 @@ The Mailbox parameter specifies the identity of the hierarchy public folder mail Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is available only in on-premises Exchange. 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. @@ -115,7 +125,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: @@ -138,7 +150,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessage.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-QuarantineMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessage.md index 43a8059632..d96f13ebbc 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinemessage applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-QuarantineMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-quarantinemessage +schema: 2.0.0 +title: Get-QuarantineMessage --- # Get-QuarantineMessage @@ -60,7 +61,7 @@ Get-QuarantineMessage ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,6 +103,9 @@ This example returns detailed information for the files protected by Safe Attach ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the quarantined message that you want to view. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). When you identify the quarantine message by using this parameter, the RecipientAddress, QuarantineUser, and ReleasedUser properties are available. To see these values, you need to use a formatting cmdlet. For example, `Get-QuarantineMessage -Identity | Format-List`. @@ -110,7 +114,6 @@ When you identify the quarantine message by using this parameter, the RecipientA Type: QuarantineMessageIdentity Parameter Sets: Details Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -131,7 +137,6 @@ You can specify multiple values separated by commas. Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageDirectionEnum Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -141,13 +146,15 @@ 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. + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -157,17 +164,19 @@ 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. + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +The EndExpiresDate parameter specifies the latest messages that are automatically 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". -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. +For example, if you specify the StartExpiresDate value of today's date and the EndExpiresDate value of the date three days from today, you only see messages that are set to expire from the quarantine in the next three days. ```yaml Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -177,6 +186,9 @@ Accept wildcard characters: False ``` ### -EndReceivedDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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". @@ -185,7 +197,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -195,6 +206,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -206,7 +220,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -216,13 +229,15 @@ Accept wildcard characters: False ``` ### -IncludeMessagesFromBlockedSenderAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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 @@ -232,13 +247,15 @@ 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, `""`). + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 might include angle brackets) and enclose the value in quotation marks (for example, `""`). ```yaml Type: String Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -248,13 +265,15 @@ Accept wildcard characters: False ``` ### -MyItems + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The MyItems switch filters the results by messages where you (the user that's running the command) are the recipient. 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 @@ -264,13 +283,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -280,13 +301,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 1000. The default value is 100. ```yaml Type: Int32 Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -296,7 +319,10 @@ Accept wildcard characters: False ``` ### -PolicyName -The PolicyName parameter filters the results by the protection policy that quarantined the message (for example, the anti-malware policy). You can use any value that uniquely identifies the policy. For example: + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +The PolicyName parameter filters the results by the threat policy that quarantined the message (for example, an anti-malware policy or an anti-spam policy). You can use any value that uniquely identifies the policy. For example: - Name - Distinguished name (DN) @@ -306,7 +332,6 @@ The PolicyName parameter filters the results by the protection policy that quara Type: String Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -316,7 +341,10 @@ Accept wildcard characters: False ``` ### -PolicyTypes -The PolicyTypes parameter filters the results by the type of protection policy that quarantined the message. Valid values are: + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +The PolicyTypes parameter filters the results by the type of threat policy that quarantined the message. Valid values are: - AntiMalwarePolicy - AntiPhishPolicy @@ -331,7 +359,6 @@ You can specify multiple values separated by commas. Type: QuarantinePolicyTypeEnum[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -341,6 +368,9 @@ Accept wildcard characters: False ``` ### -QuarantineTypes + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The QuarantineTypes parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk @@ -363,7 +393,6 @@ For files quarantined by Safe Attachments for SharePoint, OneDrive, and Microsof Type: QuarantineMessageTypeEnum[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -373,13 +402,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: All Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -389,6 +420,9 @@ Accept wildcard characters: False ``` ### -RecipientTag + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -397,7 +431,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -407,6 +440,9 @@ Accept wildcard characters: False ``` ### -ReleaseStatus + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ReleaseStatus parameter filters the results by the release status of the message. Valid values are: - Approved @@ -425,7 +461,6 @@ You can specify multiple values separated by commas. Type: ReleaseStatus[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -435,6 +470,9 @@ Accept wildcard characters: False ``` ### -Reported + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Reported parameter filters the results by messages that have already been reported as false positives. Valid values are: - $true: The command only returns quarantined messages that have already been reported as false positives. @@ -444,7 +482,6 @@ The Reported parameter filters the results by messages that have already been re Type: Boolean Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -454,13 +491,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -470,17 +509,19 @@ 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. + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +The StartExpiresDate parameter specifies the earliest messages that are automatically 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". -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. +For example, if you specify the StartExpiresDate value of today's date and the EndExpiresDate value of the date three days from today, you only see messages that are set to expire from the quarantine in the next three days. ```yaml Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -490,17 +531,19 @@ Accept wildcard characters: False ``` ### -StartReceivedDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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". -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. +By default, if you don't use the StartReceivedDate and EndReceivedDate parameters, the command returns data for the last 16 days. The maximum value for this parameter is 30 days. If you use a value that's older than 30 days, the value is ignored and only data for the last 30 days is returned. ```yaml Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -510,13 +553,15 @@ Accept wildcard characters: False ``` ### -Subject + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Subject parameter filters the results by the subject field of the message. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -526,6 +571,9 @@ Accept wildcard characters: False ``` ### -TeamsConversationTypes + +> Applicable: Security & Compliance + This parameter is available only in Security & Compliance PowerShell. The TeamsConversationTypes parameters filters the results by Microsoft Teams conversation types. Valid values are: @@ -539,7 +587,6 @@ You can specify multiple values separated by commas. Type: Microsoft.Exchange.Management.FfoQuarantine.TeamsConversationType[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -549,6 +596,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Type parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk @@ -568,7 +618,6 @@ For files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageTypeEnum Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessageHeader.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md rename to exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessageHeader.md index 9dac21f945..d3c413a69a 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessageHeader.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinemessageheader applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-QuarantineMessageHeader -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-quarantinemessageheader +schema: 2.0.0 +title: Get-QuarantineMessageHeader --- # Get-QuarantineMessageHeader @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-QuarantineMessageHeader cmdlet to view the message header of a quarantined message. The command will fail if the specified message is not in quarantine. +Use the Get-QuarantineMessageHeader cmdlet to view the message header of a quarantined message. The command fails if the specified message is not in quarantine. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -30,7 +31,7 @@ Get-QuarantineMessageHeader -Identity ## DESCRIPTION Standard SMTP message header syntax is described in RFC 5322. This cmdlet displays the message header exactly as it appears in the message. Individual header fields are not unfolded. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example displays the message header of the first message that's returned by ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the quarantined message that you want to view the header for. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. @@ -61,7 +65,6 @@ You can find the Identity value for a quarantined message by using the Get-Quara Type: QuarantineMessageIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -82,7 +88,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantinePolicy.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-QuarantinePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-QuarantinePolicy.md index 93177a8f2a..e4136578f7 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantinePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinepolicy applicable: Exchange Online, Exchange Online Protection -title: Get-QuarantinePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-quarantinepolicy +schema: 2.0.0 +title: Get-QuarantinePolicy --- # Get-QuarantinePolicy @@ -29,7 +30,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,6 +58,9 @@ This example returns detailed information about the default quarantine policy na ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the quarantine policy you want to view. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -67,7 +71,6 @@ The Identity parameter specifies the quarantine policy you want to view. You can Type: QuarantineTagIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -77,9 +80,12 @@ Accept wildcard characters: False ``` ### -QuarantinePolicyType + +> Applicable: Exchange Online, Exchange Online Protection + The QuarantinePolicyType parameter filters the results by the specified quarantine policy type. Valid values are: -- QuarantinePolicy: This is the default value, and returns built-in and custom quarantine policies. +- QuarantinePolicy: This value is the default, and returns built-in and custom quarantine policies. - GlobalQuarantinePolicy: This value is required to return the global settings (quarantine notification settings) in the quarantine policy named DefaultGlobalTag. ```yaml @@ -87,7 +93,6 @@ Type: QuarantinePolicyType Parameter Sets: (All) Aliases: Accepted values: QuarantinePolicy, GlobalQuarantinePolicy -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Queue.md b/exchange/exchange-ps/ExchangePowerShell/Get-Queue.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-Queue.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Queue.md index 1b83dcd4a3..87030c6e7f 100644 --- a/exchange/exchange-ps/exchange/Get-Queue.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Queue.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-queue -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-Queue -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-queue +schema: 2.0.0 +title: Get-Queue --- # Get-Queue @@ -52,7 +53,7 @@ Get-Queue [-Server ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,13 +88,15 @@ This example lists only the external queues. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -103,13 +106,15 @@ Accept wildcard characters: False ``` ### -BookmarkIndex + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BookmarkIndex parameter specifies the position in the result set where the displayed results start. The value of this parameter is a 1-based index in the total result set. The BookmarkIndex parameter can't be used with the BookmarkObject parameter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,13 +124,15 @@ Accept wildcard characters: False ``` ### -BookmarkObject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BookmarkObject parameter specifies the object in the result set where the displayed results start. The BookmarkObject parameter can't be used with the BookmarkIndex parameter. ```yaml Type: ExtensibleQueueInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -Exclude + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Exclude parameter specifies the types of queues you want to exclude from the results. Valid values for this parameter are: - Internal @@ -145,7 +155,6 @@ The Exclude parameter specifies the types of queues you want to exclude from the Type: QueueViewerIncludesAndExcludes Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,6 +164,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -163,7 +175,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -Include + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Include parameter specifies the types of queues you want to include the results. Valid values for this parameter are: - Internal @@ -183,7 +197,6 @@ The Include parameter specifies the types of queues you want to include the resu Type: QueueViewerIncludesAndExcludes Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,13 +206,15 @@ Accept wildcard characters: False ``` ### -IncludeBookmark + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeBookmark parameter specifies whether to include the bookmark object when the query results are displayed. The IncludeBookmark parameter is valid when it's used with the BookmarkObject or BookmarkIndex parameters. If you don't specify a value for the IncludeBookmark parameter, the default value of $true is used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +242,15 @@ Accept wildcard characters: False ``` ### -ReturnPageInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReturnPageInfo parameter is a hidden parameter. Use it to return information about the total number of results and the index of the first object of the current page. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,13 +260,15 @@ Accept wildcard characters: False ``` ### -SearchForward + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SearchForward parameter specifies whether to search forward or backward in the result set. The default value is $true. This value causes the result page to be calculated forward from either the start of the result set or forward from a bookmark if specified. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,6 +278,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -272,7 +296,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -282,6 +305,9 @@ Accept wildcard characters: False ``` ### -SortOrder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SortOrder parameter specifies an array of message properties used to control the sort order of the result set. Separate each property by using a comma. Prepend a plus sign (+) symbol to the beginning of the property name to display the results in ascending order. Prepend a minus sign (-) symbol to the beginning of the property name to display the results in descending order. If you don't specify a sort order, the result set is displayed in ascending order by QueueIdentity. @@ -290,7 +316,6 @@ If you don't specify a sort order, the result set is displayed in ascending orde Type: QueueViewerSortOrderEntry[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-QueueDigest.md b/exchange/exchange-ps/ExchangePowerShell/Get-QueueDigest.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-QueueDigest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-QueueDigest.md index a45a074bd3..e71a73e68b 100644 --- a/exchange/exchange-ps/exchange/Get-QueueDigest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-QueueDigest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-queuedigest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-QueueDigest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-queuedigest +schema: 2.0.0 +title: Get-QueueDigest --- # Get-QueueDigest @@ -67,7 +68,7 @@ Get-QueueDigest -Site ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -88,6 +89,9 @@ This example returns information about all queues in the DAG named DAG01. ## PARAMETERS ### -Dag + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Dag parameter filters the delivery queue results by DAG. You can specify any value that uniquely identifies the DAG. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). You can't use the Dag parameter with the Server, Site or Forest parameters. @@ -96,7 +100,6 @@ You can't use the Dag parameter with the Server, Site or Forest parameters. Type: MultiValuedProperty Parameter Sets: Dag Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -Forest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Forest switch filters the delivery queue results by Active Directory forest. You don't need to specify a value with the Forest switch. You can't use the Forest switch with the Server, Site or Dag parameters. @@ -114,7 +120,6 @@ You can't use the Forest switch with the Server, Site or Dag parameters. Type: SwitchParameter Parameter Sets: Forest Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter filters the delivery queue results by Exchange server. You can specify any value that uniquely identifies the server. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). You can't use the Server parameter with the Dag, Site or Forest parameters. @@ -132,7 +140,6 @@ You can't use the Server parameter with the Dag, Site or Forest parameters. Type: MultiValuedProperty Parameter Sets: Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Site parameter filters the delivery queue results by Active Directory site. You can specify any value that uniquely identifies the site. You can specify multiple sites separated by commas. You can't use the Site parameter with the Server, Dag or Forest parameters. @@ -150,7 +160,6 @@ You can't use the Site parameter with the Server, Dag or Forest parameters. Type: MultiValuedProperty Parameter Sets: Site Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -160,13 +169,15 @@ Accept wildcard characters: False ``` ### -DetailsLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DetailsLevel parameter specifies the level of detail to display in the results. Valid values for this parameter are None, Normal and Verbose. The default value is Normal. ```yaml Type: DetailsLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -184,7 +198,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -GroupBy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GroupedBy parameter sorts the messages in the delivery queue results. Valid values are: - DeliveryType @@ -210,7 +226,6 @@ The GroupedBy parameter sorts the messages in the delivery queue results. Valid Type: QueueDigestGroupBy Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,13 +235,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter filters the delivery queue results by the number of messages in the queue. Valid input for this parameter is an integer. The default value is 1000. For example, if you specify the value 50, the command displays the 50 queues that contain the most messages. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Timeout parameter specifies the number of seconds before the operation times out. The default value is 10 seconds. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -244,7 +264,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RMSTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Get-RMSTemplate.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-RMSTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RMSTemplate.md index e495368203..b40d1b10ac 100644 --- a/exchange/exchange-ps/exchange/Get-RMSTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RMSTemplate.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-rmstemplate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-RMSTemplate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-rmstemplate +schema: 2.0.0 +title: Get-RMSTemplate --- # Get-RMSTemplate ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-RMSTemplate cmdlet to retrieve the current list of active rights policy templates from the Active Directory Rights Management Services (AD RMS) deployment for the organization. @@ -32,7 +33,7 @@ Get-RMSTemplate [[-Identity] ] ## DESCRIPTION The Get-RMSTemplate cmdlet doesn't return any active rights policy templates if internal licensing isn't enabled. Use the Get-IRMConfiguration cmdlet to check the InternalLicensingEnabled parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example retrieves the Company Confidential RMS template. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the RMS template. ```yaml Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -77,7 +83,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -TrustedPublishingDomain + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The TrustedPublishingDomain parameter specifies the trusted publishing domain you want to search for RMS templates. You can use any value that uniquely identifies the trusted publishing domain, for example: @@ -115,7 +125,6 @@ The TrustedPublishingDomain parameter specifies the trusted publishing domain yo Type: RmsTrustedPublishingDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Type parameter specifies the type of RMS template. Use one of the following values: @@ -137,7 +149,6 @@ The Type parameter specifies the type of RMS template. Use one of the following Type: RmsTemplateType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ReceiveConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-ReceiveConnector.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-ReceiveConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ReceiveConnector.md index f34ec98584..eb4b435b49 100644 --- a/exchange/exchange-ps/exchange/Get-ReceiveConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ReceiveConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-receiveconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ReceiveConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-receiveconnector +schema: 2.0.0 +title: Get-ReceiveConnector --- # Get-ReceiveConnector @@ -37,7 +38,7 @@ Get-ReceiveConnector [-Server ] ## DESCRIPTION You can view Receive connectors on Mailbox servers and Edge Transport servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example displays detailed information for the Receive connector named Recei ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Receive connector that you want to view. You can use any value that uniquely identifies the Receive connector. For example: - Name @@ -71,7 +75,6 @@ You can't use this parameter with the Server parameter. Type: ReceiveConnectorIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -89,7 +95,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter filters the results by the specified Mailbox server or Edge Transport server. You can use any value that uniquely identifies the server. For example: - Name @@ -112,7 +120,6 @@ You can't use this parameter with the Identity parameter. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Recipient.md b/exchange/exchange-ps/ExchangePowerShell/Get-Recipient.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-Recipient.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Recipient.md index 9687412486..a3b965ac4a 100644 --- a/exchange/exchange-ps/exchange/Get-Recipient.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Recipient.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recipient -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-Recipient -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recipient +schema: 2.0.0 +title: Get-Recipient --- # Get-Recipient ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-Recipient cmdlet to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups). @@ -42,6 +43,7 @@ Get-Recipient [-Anr ] [-Capabilities ] [-Database ] [-Properties ] + [-IncludeManagerWithDisplayName] [-IncludeSoftDeletedRecipients] [] ``` @@ -65,6 +67,7 @@ Get-Recipient [[-Identity] ] [-SortBy ] [-Capabilities ] [-Properties ] + [-IncludeManagerWithDisplayName] [-IncludeSoftDeletedRecipients] [] ``` @@ -98,6 +101,7 @@ Get-Recipient [-RecipientPreviewFilter ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeManagerWithDisplayName] [-IncludeSoftDeletedRecipients] [-OrganizationalUnit ] [-Properties ] @@ -111,9 +115,9 @@ Get-Recipient [-RecipientPreviewFilter ] ``` ## DESCRIPTION -The Get-Recipient cmdlet may not return all object-specific properties for a recipient. To view the object-specific properties for a recipient, you need to use the corresponding cmdlet based on the object type (for example, Get-Mailbox, Get-MailUser, or Get-DistributionGroup). +The Get-Recipient cmdlet might not return all object-specific properties for a recipient. To view the object-specific properties for a recipient, you need to use the corresponding cmdlet based on the object type (for example, Get-Mailbox, Get-MailUser, or Get-DistributionGroup). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -141,6 +145,9 @@ This example retrieves information about all the mail contacts in your organizat ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the recipient object that you want to view. You can use any value that uniquely identifies the recipient. For example: - Name @@ -154,7 +161,6 @@ The Identity parameter specifies the recipient object that you want to view. You Type: RecipientIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -164,6 +170,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -176,7 +185,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -186,6 +194,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is available only in the cloud-based service. The AuthenticationType parameter specifies the recipient by authentication type. Use one of the following values: @@ -197,7 +208,6 @@ The AuthenticationType parameter specifies the recipient by authentication type. Type: AuthenticationType Parameter Sets: AnrSet, Identity, RecipientPreviewFilterSet Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -207,13 +217,15 @@ Accept wildcard characters: False ``` ### -BookmarkDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -223,6 +235,9 @@ Accept wildcard characters: False ``` ### -Capabilities + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -231,7 +246,6 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: AnrSet, Identity, RecipientPreviewFilterSet Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -241,6 +255,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -251,7 +268,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,6 +277,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Database parameter return all recipients stored on the specified mailbox database. You can use any value that uniquely identifies the database. For example: @@ -273,7 +292,6 @@ The Database parameter return all recipients stored on the specified mailbox dat Type: DatabaseIdParameter Parameter Sets: DatabaseSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -283,6 +301,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -291,7 +312,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -301,6 +321,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -316,7 +339,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -326,6 +348,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -339,7 +364,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -349,13 +373,35 @@ Accept wildcard characters: False ``` ### -IncludeBookmarkObject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeManagerWithDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is available only in the cloud-based service. + +{{ Fill IncludeManagerWithDisplayName Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, RecipientPreviewFilterSet +Aliases: Required: False Position: Named @@ -365,6 +411,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. Soft-deleted recipients are deleted recipients that are still recoverable. @@ -375,7 +424,6 @@ Soft-deleted recipients are deleted recipients that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -385,6 +433,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -396,7 +447,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -406,13 +456,15 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -422,13 +474,15 @@ Accept wildcard characters: False ``` ### -PropertySet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: PropertySet Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -438,6 +492,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -450,7 +507,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -460,13 +516,15 @@ Accept wildcard characters: False ``` ### -RecipientPreviewFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientPreviewFilter parameter tests a recipient filter that you would use in a dynamic distribution group, address list, or email address policy. This parameter uses the LDAP filter syntax. ```yaml Type: String Parameter Sets: RecipientPreviewFilterSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -476,6 +534,9 @@ Accept wildcard characters: False ``` ### -RecipientType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientType parameter filters the results by the specified recipient type. Valid values are: - DynamicDistributionGroup @@ -493,7 +554,6 @@ You can specify multiple values separated by commas. Type: RecipientType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -503,6 +563,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are: - DiscoveryMailbox @@ -536,13 +599,12 @@ The RecipientTypeDetails parameter filters the results by the specified recipien You can specify multiple values separated by commas. -The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You'll receive the error: None of the specified RecipientTypeDetails are included in any specified recipient type. +The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You get the error: None of the specified RecipientTypeDetails are included in any specified recipient type. ```yaml Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -552,13 +614,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -568,6 +632,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -587,7 +654,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientFilterConfig.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RecipientFilterConfig.md index 76a02ece24..2daa8baa62 100644 --- a/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recipientfilterconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-RecipientFilterConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recipientfilterconfig +schema: 2.0.0 +title: Get-RecipientFilterConfig --- # Get-RecipientFilterConfig @@ -27,7 +28,7 @@ Get-RecipientFilterConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example returns detailed information about the recipient filter configurati ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -65,7 +71,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RecipientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientPermission.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-RecipientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RecipientPermission.md index 985fc7ff66..a5c68f73cf 100644 --- a/exchange/exchange-ps/exchange/Get-RecipientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recipientpermission applicable: Exchange Online -title: Get-RecipientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recipientpermission +schema: 2.0.0 +title: Get-RecipientPermission --- # Get-RecipientPermission @@ -37,7 +38,7 @@ When a user is given SendAs permission to another user or group, the user can se > [!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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example lists the users who have SendAs permission on the mailbox Help Desk ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter identifies the recipient that you want to view. The user or group specified by the Trustee parameter has Send As permissions on this recipient. You can specify any type of recipient, for example: - Mailboxes @@ -79,7 +83,6 @@ You can use any value that uniquely identifies the recipient. For example: Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Online + The AccessRights parameter filters the results by permission. The only valid value for this parameter is SendAs. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Online + The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + 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 @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -Trustee + +> Applicable: Exchange Online + The Trustee parameter filters the results by who has Send As permissions on the specified recipient. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -160,7 +172,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientStatisticsReport.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RecipientStatisticsReport.md index 8f2d888cba..aa8daee7d8 100644 --- a/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientStatisticsReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recipientstatisticsreport applicable: Exchange Online -title: Get-RecipientStatisticsReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recipientstatisticsreport +schema: 2.0.0 +title: Get-RecipientStatisticsReport --- # Get-RecipientStatisticsReport @@ -27,7 +28,7 @@ Get-RecipientStatisticsReport [] ## DESCRIPTION The recipient statistics report provides information about the total number of mailboxes and the total number of active mailboxes in the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES diff --git a/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-RecordReviewNotificationTemplateConfig.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RecordReviewNotificationTemplateConfig.md index 4f413a8bf3..a6dfb25f93 100644 --- a/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RecordReviewNotificationTemplateConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recordreviewnotificationtemplateconfig applicable: Security & Compliance -title: Get-RecordReviewNotificationTemplateConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recordreviewnotificationtemplateconfig +schema: 2.0.0 +title: Get-RecordReviewNotificationTemplateConfig --- # Get-RecordReviewNotificationTemplateConfig diff --git a/exchange/exchange-ps/exchange/Get-RecoverableItems.md b/exchange/exchange-ps/ExchangePowerShell/Get-RecoverableItems.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-RecoverableItems.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RecoverableItems.md index aebb11746e..f7cdee932f 100644 --- a/exchange/exchange-ps/exchange/Get-RecoverableItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RecoverableItems.md @@ -1,17 +1,18 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recoverableitems -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RecoverableItems -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recoverableitems +schema: 2.0.0 +title: Get-RecoverableItems --- # Get-RecoverableItems ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-RecoverableItems items cmdlet to view deleted items in mailboxes. After you find the deleted items, you use the Restore-RecoverableItems cmdlet to restore them. @@ -53,7 +54,7 @@ Get-RecoverableItems -Identity ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,6 +75,9 @@ This example returns all of the available recoverable deleted messages with the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox that contains the deleted items that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -91,9 +95,8 @@ In Exchange Online, you can specify multiple mailboxes separated by commas. If t ```yaml Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: OnPremises +Parameter Sets: OnPremises, Cloud Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -102,20 +105,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: GeneralMailboxOrMailUserIdParameter[] -Parameter Sets: Cloud -Aliases: -Applicable: Exchange Online +### -EntryID -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -EntryID The EntryID parameter specifies the deleted item that you want to restore. The EntryID value for the deleted item is unique in the mailbox. You can find the EntryID for specific items by using other search filters on the Get-RecoverableItems cmdlet (subject, date range, etc.). @@ -124,7 +117,6 @@ You can find the EntryID for specific items by using other search filters on the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -134,6 +126,9 @@ Accept wildcard characters: False ``` ### -FilterEndTime + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -142,7 +137,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,6 +146,9 @@ Accept wildcard characters: False ``` ### -FilterItemType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example: - IPM.Appointment (Meetings and appointments) @@ -164,7 +161,6 @@ The FilterItemType parameter filters the results by the specified MessageClass ( Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,6 +170,9 @@ Accept wildcard characters: False ``` ### -FilterStartTime + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -182,7 +181,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -192,13 +190,15 @@ Accept wildcard characters: False ``` ### -LastParentFolderID + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,6 +208,9 @@ Accept wildcard characters: False ``` ### -MaxParallelSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MaxParallelSize parameter specifies the maximum number of mailboxes that are processed by the command in parallel. A valid value is an integer from 1 to 10. Typically, a higher value decreases the amount of time it takes to complete the command on multiple mailboxes. @@ -218,7 +221,6 @@ The value of this parameter has no effect when the Identity parameter specifies Type: Int32 Parameter Sets: Cloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -228,6 +230,9 @@ Accept wildcard characters: False ``` ### -PolicyTag + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill PolicyTag Description }} @@ -236,7 +241,6 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: Cloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -246,13 +250,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,6 +268,9 @@ Accept wildcard characters: False ``` ### -SkipCount + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} @@ -270,7 +279,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -280,6 +288,9 @@ Accept wildcard characters: False ``` ### -SourceFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: - DeletedItems: The Deleted Items folder. @@ -294,7 +305,6 @@ If you don't use this parameter, the command searches those three folders. Type: RecoverableItemsFolderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -304,13 +314,15 @@ Accept wildcard characters: False ``` ### -SubjectContains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SubjectContains parameter filters the items by the specified text value in the Subject field. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md b/exchange/exchange-ps/ExchangePowerShell/Get-RegulatoryComplianceUI.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RegulatoryComplianceUI.md index 69ceb96099..3b3f107381 100644 --- a/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RegulatoryComplianceUI.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-regulatorycomplianceui applicable: Security & Compliance -title: Get-RegulatoryComplianceUI +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-regulatorycomplianceui schema: 2.0.0 +title: Get-RegulatoryComplianceUI --- # Get-RegulatoryComplianceUI diff --git a/exchange/exchange-ps/exchange/Get-RemoteDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-RemoteDomain.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-RemoteDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RemoteDomain.md index ea01811a75..40f8322e49 100644 --- a/exchange/exchange-ps/exchange/Get-RemoteDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RemoteDomain.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-remotedomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RemoteDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-remotedomain +schema: 2.0.0 +title: Get-RemoteDomain --- # Get-RemoteDomain ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-RemoteDomain cmdlet to view the configuration information for the remote domains configured in your organization. You can view the remote domain configuration from inside the Exchange organization or from an Edge Transport server in the perimeter network. @@ -28,7 +29,7 @@ Get-RemoteDomain [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,6 +57,9 @@ This example returns all domains where Transport Neutral Encapsulation Format (T ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the remote domain that you want to view. You can use any value that uniquely identifies the remote domain. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the remote domain that you want to view. You ca Type: RemoteDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -86,7 +92,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -104,7 +112,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-RemoteMailbox.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RemoteMailbox.md index f40415ec08..98107afa9a 100644 --- a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-remotemailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-RemoteMailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-remotemailbox +schema: 2.0.0 +title: Get-RemoteMailbox --- # Get-RemoteMailbox @@ -51,7 +52,7 @@ Get-RemoteMailbox [[-Identity] ] ## DESCRIPTION The Get-RemoteMailbox cmdlet retrieves the mail-related attributes of a mail user in the on-premises Active Directory. It doesn't retrieve the attributes of the associated cloud-based mailbox. Most of the mail-related attributes of the on-premises mail user and the associated cloud-based mailbox should be the same. However, the cloud-based mailbox has additional attributes that you can't view by using this cmdlet. To view the attributes of the cloud-based mailbox, you need to use the Exchange admin center in the cloud-based service, or connect to your cloud-based organization and run the Get-Mailbox cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,6 +84,9 @@ First, run the following command to prompt you for your credentials and then sto ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the remote mailbox that you want to view. You can use any value that uniquely identifies the remote mailbox. For example: - Name @@ -100,7 +104,6 @@ The Identity parameter specifies the remote mailbox that you want to view. You c Type: RemoteMailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -122,7 +128,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +137,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Archive switch is required to return the user's archive mailbox in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +155,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -156,7 +166,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +175,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -197,7 +211,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +220,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -218,7 +234,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +243,9 @@ Accept wildcard characters: False ``` ### -OnPremisesOrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OnPremisesOrganizationalUnit parameter filters the results by the object's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -241,7 +259,6 @@ Valid input for this parameter is an organizational unit (OU) or domain that's r Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -261,7 +281,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -271,6 +290,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. **Note**: Limitations on domain controllers might affect the number of results returned for the value unlimited. For more information, see [this article](https://learn.microsoft.com/troubleshoot/windows-server/identity/domain-controller-returns-500-values-ldap-response). @@ -279,7 +301,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,6 +310,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -303,7 +327,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md b/exchange/exchange-ps/ExchangePowerShell/Get-ReportExecutionInstance.md similarity index 76% rename from exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ReportExecutionInstance.md index 134a709559..ad948f54d5 100644 --- a/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ReportExecutionInstance.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-reportexecutioninstance applicable: Exchange Online, Exchange Online Protection -title: Get-ReportExecutionInstance -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-reportexecutioninstance +schema: 2.0.0 +title: Get-ReportExecutionInstance --- # Get-ReportExecutionInstance @@ -27,7 +28,7 @@ Get-ReportExecutionInstance [-Identity ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,13 +49,15 @@ This example returns detailed information for the specified report execution ins ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the report execution instance that you want to view. The identity of the instance is a unique GUID value. ```yaml Type: InstanceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -ScheduleId -The ScheduleId parameter filters the results by the specified ScheduleId property value, which is a GUID. Note that multiple report execution instances can have the same ScheduleId value. + +> Applicable: Exchange Online, Exchange Online Protection + +The ScheduleId parameter filters the results by the specified ScheduleId property value, which is a GUID. Multiple report execution instances can have the same ScheduleId value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionPolicy.md index 483f073460..09a5ba4f86 100644 --- a/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-reportsubmissionpolicy applicable: Exchange Online -title: Get-ReportSubmissionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-reportsubmissionpolicy +schema: 2.0.0 +title: Get-ReportSubmissionPolicy --- # Get-ReportSubmissionPolicy @@ -29,7 +30,7 @@ The report submission policy controls most of the settings for user submissions The report submission rule (\*-ReportSubmissionRule cmdlets) controls the email address of the reporting mailbox where user reported messages are delivered. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example returns the settings of the report submission policy in your organi ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission policy that you want to view. The only available policy is named DefaultReportSubmissionPolicy. ```yaml Type: ReportSubmissionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionRule.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionRule.md index f64f8d899b..9761c1326e 100644 --- a/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-reportsubmissionrule applicable: Exchange Online -title: Get-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-reportsubmissionrule +schema: 2.0.0 +title: Get-ReportSubmissionRule --- # Get-ReportSubmissionRule @@ -25,7 +26,7 @@ Get-ReportSubmissionRule [[-Identity] ] [-State ] [< ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -39,13 +40,15 @@ This example returns detailed information about the report submission rule in yo ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission rule that you want to view. The default rule is named DefaultReportSubmissionRule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -55,6 +58,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by whether the report submission rule is enabled or disabled. Valid values are: - Disabled @@ -67,7 +73,6 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ResourceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-ResourceConfig.md similarity index 75% rename from exchange/exchange-ps/exchange/Get-ResourceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ResourceConfig.md index e5087116d5..fc294207d1 100644 --- a/exchange/exchange-ps/exchange/Get-ResourceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ResourceConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-resourceconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ResourceConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-resourceconfig +schema: 2.0.0 +title: Get-ResourceConfig --- # Get-ResourceConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-ResourceConfig cmdlet to view custom room and equipment mailbox properties that you've configured by using the Set-ResourceConfig cmdlet. @@ -27,7 +28,7 @@ Get-ResourceConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,6 +42,9 @@ This example returns all of the available custom room and equipment mailbox prop ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -49,7 +53,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -67,7 +73,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ResubmitRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-ResubmitRequest.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ResubmitRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ResubmitRequest.md index e6837d4223..d5c1c38d27 100644 --- a/exchange/exchange-ps/exchange/Get-ResubmitRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ResubmitRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-resubmitrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ResubmitRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-resubmitrequest +schema: 2.0.0 +title: Get-ResubmitRequest --- # Get-ResubmitRequest @@ -27,7 +28,7 @@ Get-ResubmitRequest [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,13 +49,15 @@ This example returns details about the resubmit request with the identity 1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the resubmit request you want to view. Each resubmit request is identified by an incremented integer value. ```yaml Type: ResubmitRequestIdentityParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -77,7 +83,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionCompliancePolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RetentionCompliancePolicy.md index fbb20052f5..1e0536d222 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy applicable: Security & Compliance -title: Get-RetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentioncompliancepolicy +schema: 2.0.0 +title: Get-RetentionCompliancePolicy --- # Get-RetentionCompliancePolicy @@ -36,7 +37,7 @@ Get-RetentionCompliancePolicy [[-Identity] ] This list describes the properties that are displayed by default. - Name: The unique name of the policy. -- Workload: At the moment, it will show all workloads (Exchange, SharePoint, OneDriveForBusiness, Skype, ModernGroup) and it will not show the actual workload on which the policy is applied. +- Workload: Currently, it shows all workloads (Exchange, SharePoint, OneDriveForBusiness, Skype, ModernGroup). It doesn't show the actual workload on which the policy is applied. - Enabled: The value True means the policy is enabled. - Mode: The current operating mode of the policy. The possible values are Test (the content is tested, but no rules are enforced), AuditAndNotify (when content matches the conditions specified by the policy, the rule is not enforced, but notification emails are sent) or Enforce (all aspects of the policy are enabled and enforced). @@ -61,6 +62,9 @@ This example displays detailed information for the policy named "Regulation 123 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -71,7 +75,6 @@ The Identity parameter specifies the retention policy that you want to view. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. If you don't use this switch, the values of the DistributionStatus and \*Location property values will be inaccurate. @@ -89,7 +95,6 @@ If you don't use this switch, the values of the DistributionStatus and \*Locatio Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -ErrorPolicyOnly + +> Applicable: Security & Compliance + The ErrorPolicyOnly switch specifies whether to show only policies that have distribution errors in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -ExcludeTeamsPolicy + +> Applicable: Security & Compliance + The ExcludeTeamsPolicy switch specifies whether to exclude Teams policies from the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -IncludeTestModeResults + +> Applicable: Security & Compliance + The IncludeTestModeResults switch specifies whether to include the status of test mode in the policy details. You don't need to specify a value with this switch. For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). @@ -139,7 +151,6 @@ For more information about simulation mode, see [Learn about simulation mode](ht Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -165,6 +178,9 @@ Accept wildcard characters: False ``` ### -RetentionRuleTypes + +> Applicable: Security & Compliance + 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 values RetentionRuleTypes appears blank and HasRules appears False. @@ -173,7 +189,6 @@ To see the RetentionRuleTypes property, you need to pipe the command to a format Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -183,13 +198,15 @@ Accept wildcard characters: False ``` ### -TeamsPolicyOnly + +> Applicable: Security & Compliance + The TeamsPolicyOnly switch specifies whether to show only Teams policies in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RetentionComplianceRule.md index 9c1279ce96..4340821384 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-retentioncompliancerule applicable: Security & Compliance -title: Get-RetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentioncompliancerule +schema: 2.0.0 +title: Get-RetentionComplianceRule --- # Get-RetentionComplianceRule @@ -56,6 +57,9 @@ This example displays detailed information for the retention rule named "30 Day ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention rule you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the retention rule you want to view. You can us Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter filters the retention rule results by the associated retention policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -88,7 +94,6 @@ You can use this parameter with the Identity parameter in the same command. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RetentionEvent.md b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionEvent.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-RetentionEvent.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RetentionEvent.md index c650acf830..d80526413b 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionEvent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionEvent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-retentionevent applicable: Exchange Online, Security & Compliance -title: Get-RetentionEvent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentionevent +schema: 2.0.0 +title: Get-RetentionEvent --- # Get-RetentionEvent @@ -28,7 +29,7 @@ Get-RetentionEvent [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example returns detailed information about retention the specified retentio ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the retention event that you want to view. ```yaml Type: EwsStoreObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -AllStatus + +> Applicable: Exchange Online + The AllStatus switch specifies whether to include zero count events in the results. 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 @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicy.md similarity index 69% rename from exchange/exchange-ps/exchange/Get-RetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicy.md index 231c381cff..efc449f3f5 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-retentionpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RetentionPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentionpolicy +schema: 2.0.0 +title: Get-RetentionPolicy --- # Get-RetentionPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-RetentionPolicy cmdlet to retrieve the settings for retention policies. @@ -27,9 +28,9 @@ Get-RetentionPolicy [[-Identity] ] ``` ## DESCRIPTION -A retention policy is associated with a group of retention policy tags that specify retention settings for items in a mailbox. A policy may contain one default policy tag to move items to an archive mailbox, one default policy tag to delete all items, one default policy tag to delete voicemail items and multiple personal tags to move or delete items. A mailbox can have only one retention policy applied to it. The Get-RetentionPolicy cmdlet displays all policy settings associated with the specified policy. +A retention policy is associated with a group of retention policy tags that specify retention settings for items in a mailbox. A policy might contain one default policy tag to move items to an archive mailbox, one default policy tag to delete all items, one default policy tag to delete voicemail items and multiple personal tags to move or delete items. A mailbox can have only one retention policy applied to it. The Get-RetentionPolicy cmdlet displays all policy settings associated with the specified policy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example returns all the properties of the retention policy RP Finance. The ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the policy name. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -67,7 +73,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicyTag.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicyTag.md index 53ece7d08e..d7b2481544 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicyTag.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-retentionpolicytag -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RetentionPolicyTag -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentionpolicytag +schema: 2.0.0 +title: Get-RetentionPolicyTag --- # Get-RetentionPolicyTag ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-RetentionPolicyTag cmdlet to retrieve settings for a retention tag. @@ -48,7 +49,7 @@ Retention tags are used to apply message retention settings to messages or folde Retention policy tags are applied to default folders such as Inbox and Deleted Items. Personal tags are available to users to tag items and folders. The default policy tag is applied to all items that don't have a tag applied by the user or aren't inherited from the folder they're located in. The Get-RetentionPolicyTag cmdlet displays all the settings for the specified tag. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,13 +84,15 @@ This example returns all retention tags of Inbox and All types and pipes the res ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the tag. ```yaml Type: RetentionPolicyTagIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -107,7 +113,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,13 +122,15 @@ Accept wildcard characters: False ``` ### -IncludeSystemTags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeSystemTags switch specifies whether to return any system tags. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter returns the retention tags that are assigned to the retention policy that's applied to the specified mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -152,7 +162,6 @@ This parameter only returns default policy tags (DPTs) and personal tags; it doe Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -OptionalInMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OptionalInMailbox parameter is used with the Mailbox parameter to return any opt-in retention tags that are assigned to the specified mailbox. You don't need to specify a value with this switch. An opt-in retention tag is a personal tag that was explicitly assigned to the mailbox with the Set-RetentionPolicyTag -Mailbox -OptionalInMailbox command. @@ -170,7 +182,6 @@ An opt-in retention tag is a personal tag that was explicitly assigned to the ma Type: SwitchParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +191,9 @@ Accept wildcard characters: False ``` ### -Types + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Types parameter specifies the type of retention tag to return. Valid values include: - Calendar @@ -204,7 +218,6 @@ The parameter accepts multiple values separated by a comma. Type: ElcFolderType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ReviewItems.md b/exchange/exchange-ps/ExchangePowerShell/Get-ReviewItems.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-ReviewItems.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ReviewItems.md index b9fa1c3b40..24f56ac095 100644 --- a/exchange/exchange-ps/exchange/Get-ReviewItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ReviewItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-reviewitems applicable: Exchange Online -title: Get-ReviewItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-reviewitems +schema: 2.0.0 +title: Get-ReviewItems --- # Get-ReviewItems @@ -31,7 +32,7 @@ Get-ReviewItems -TargetLabelId ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). The `Get-ReviewItems` cmdlet can be used to export a list of pending or disposed items from disposition review. To learn more about disposition review, see [Disposition of content](https://learn.microsoft.com/purview/disposition). @@ -84,6 +85,9 @@ This example retrieves all items pending disposition for the label with the immu ## PARAMETERS ### -TargetLabelId + +> Applicable: Exchange Online + The TargetLabelId parameter specifies the label that you want to retrieve review items for. A valid value for this parameter is the immutable ID of the label. To get the immutable ID value of a label, replace \ with the name of the label, and then run the following command in Exchange Online PowerShell: `Get-ComplianceTag -Identity "" | select ImmutableId`. @@ -92,7 +96,6 @@ To get the immutable ID value of a label, replace \ with th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -102,16 +105,18 @@ Accept wildcard characters: False ``` ### -Disposed + +> Applicable: Exchange Online + The Disposed parameter specifies whether to return disposed items instead of items pending disposition. Valid values are: - $true: Return disposed items. -- $false: Return items pending disposition. This is the default value. +- $false: Return items pending disposition. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,16 +126,18 @@ Accept wildcard characters: False ``` ### -IncludeHeaders + +> Applicable: Exchange Online + The IncludeHeaders parameter specifies whether headers are returned as a property with the review items. Valid values are: - $true: Headers are returned as a property with the review items. This option is useful when converting the output to a PSObject in PowerShell or when exporting to CSV. -- $false: Headers are not returned as a property with the review items. This is the default value. +- $false: Headers are not returned as a property with the review items. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -PagingCookie + +> Applicable: Exchange Online + The PagingCookie parameter identifies the page to retrieve. This parameter is useful in the following scenarios: - To avoid throttling while retrieving a large number of items. @@ -151,7 +161,6 @@ The PagingCookie value is returned in the PaginationCookie property each time th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-RoleAssignmentPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RoleAssignmentPolicy.md index 20474cb2b2..b9add7499b 100644 --- a/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RoleAssignmentPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-roleassignmentpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-RoleAssignmentPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-roleassignmentpolicy +schema: 2.0.0 +title: Get-RoleAssignmentPolicy --- # Get-RoleAssignmentPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-RoleAssignmentPolicy cmdlet to view existing management role assignment policies in your organization. @@ -29,7 +30,7 @@ Get-RoleAssignmentPolicy [[-Identity] ] ## DESCRIPTION For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,13 +64,15 @@ For more information about pipelining and the Format-List cmdlet, see [About Pip ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the assignment policy to view. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -89,7 +95,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RoleGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-RoleGroup.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-RoleGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RoleGroup.md index 7e6cfdc324..cc8f06f83a 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RoleGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-rolegroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-RoleGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-rolegroup +schema: 2.0.0 +title: Get-RoleGroup --- # Get-RoleGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-RoleGroup cmdlet to retrieve a list of management role groups. @@ -34,7 +35,7 @@ Get-RoleGroup [[-Identity] ] ## DESCRIPTION For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,6 +70,9 @@ This example retrieves a list of all linked role groups and the Active Directory ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group to retrieve. If the name of the role group contains spaces, enclose the name in quotation marks ("). If the Identity parameter isn't specified, all role groups are returned. @@ -77,7 +81,6 @@ If the Identity parameter isn't specified, all role groups are returned. Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -95,7 +101,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -129,7 +137,6 @@ You can filter on the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -151,7 +161,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,13 +170,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -177,6 +188,9 @@ Accept wildcard characters: False ``` ### -ShowPartnerLinked + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is functional only in the cloud-based service. This ShowPartnerLinked switch specifies whether to return built-in role groups that are of type PartnerRoleGroup. You don't need to specify a value with this switch. @@ -187,7 +201,6 @@ This type of role group is used in the cloud-based service to allow partner serv Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -197,6 +210,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -210,7 +226,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RoleGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Get-RoleGroupMember.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-RoleGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RoleGroupMember.md index 8416becc8f..cb790ab104 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RoleGroupMember.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-rolegroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-RoleGroupMember -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-rolegroupmember +schema: 2.0.0 +title: Get-RoleGroupMember --- # Get-RoleGroupMember ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-RoleGroupMember cmdlet to retrieve a list of members of a management role group. @@ -31,7 +32,7 @@ Get-RoleGroupMember [-Identity] ## DESCRIPTION For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,13 +53,15 @@ This example retrieves a list of all the members of the Organization Administrat ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group for which member information should be retrieved. If the role group name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupMemberIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -76,7 +82,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -98,7 +106,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-RoutingGroupConnector.md similarity index 85% rename from exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RoutingGroupConnector.md index 2f0f384197..7825224008 100644 --- a/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RoutingGroupConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-routinggroupconnector applicable: Exchange Server 2010 -title: Get-RoutingGroupConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-routinggroupconnector +schema: 2.0.0 +title: Get-RoutingGroupConnector --- # Get-RoutingGroupConnector @@ -29,7 +30,7 @@ Get-RoutingGroupConnector [[-Identity] ] ## DESCRIPTION The Get-RoutingGroupConnector cmdlet displays the configuration details of routing group connectors that exist when an organization is running Exchange 2010 and Exchange Server 2003. A routing group connector is used to send and receive messages between Exchange 2010 Hub Transport servers and Exchange 2003 bridgehead servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example displays detailed configuration information for the routing group c ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name or GUID of the routing group connector. The name is expressed as [[Administrative Group Name\\]Routing Group Name]\\Routing Group Connector Name. You can use the wildcard character (\*) as part of the administrative group or routing group name. ```yaml Type: RoutingGroupConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RpcClientAccess.md b/exchange/exchange-ps/ExchangePowerShell/Get-RpcClientAccess.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-RpcClientAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RpcClientAccess.md index adedda699a..cda52a6cce 100644 --- a/exchange/exchange-ps/exchange/Get-RpcClientAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RpcClientAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-rpcclientaccess -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-RpcClientAccess -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-rpcclientaccess +schema: 2.0.0 +title: Get-RpcClientAccess --- # Get-RpcClientAccess @@ -27,7 +28,7 @@ Get-RpcClientAccess [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,13 +49,15 @@ This example returns detailed information for the RPC Client Access service on t ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that you want to view. You can use any value that uniquely identifies the server. For example: @@ -77,7 +83,6 @@ You can use any value that uniquely identifies the server. For example: Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SCInsights.md b/exchange/exchange-ps/ExchangePowerShell/Get-SCInsights.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-SCInsights.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SCInsights.md index 7675f4455f..7482a56503 100644 --- a/exchange/exchange-ps/exchange/Get-SCInsights.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SCInsights.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-scinsights applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-SCInsights -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-scinsights +schema: 2.0.0 +title: Get-SCInsights --- # Get-SCInsights @@ -34,7 +35,7 @@ This cmdlet returns the following output: - InsightSubType: The value All or Archive. - UsersCount: An integer count, or the size in megabytes for the InsightType value. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example return insights data for March 15, 2018. ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. To specify a date/time value for this parameter, use either of the following options: @@ -66,7 +70,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentPolicy.md index 1330056090..e6b721443e 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safeattachmentpolicy applicable: Exchange Online -title: Get-SafeAttachmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safeattachmentpolicy +schema: 2.0.0 +title: Get-SafeAttachmentPolicy --- # Get-SafeAttachmentPolicy @@ -28,7 +29,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example shows detailed information about the safe attachment policy named D ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment policy that you want to view. You can use any value that uniquely identifies the policy. For example: @@ -61,7 +65,6 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentRule.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentRule.md index 0dded56904..d2b729ab89 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safeattachmentrule applicable: Exchange Online -title: Get-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safeattachmentrule +schema: 2.0.0 +title: Get-SafeAttachmentRule --- # Get-SafeAttachmentRule @@ -29,7 +30,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example returns detailed information about the safe attachment rule named R ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment rule that you want to view. You can use any value that uniquely identifies the rule. For example: @@ -62,7 +66,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksAggregateReport.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksAggregateReport.md index 27c72f641a..a44c75426c 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksAggregateReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinksaggregatereport applicable: Exchange Online -title: Get-SafeLinksAggregateReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safelinksaggregatereport +schema: 2.0.0 +title: Get-SafeLinksAggregateReport --- # Get-SafeLinksAggregateReport @@ -31,7 +32,7 @@ Get-SafeLinksAggregateReport ``` ## DESCRIPTION -**Note**: If you run Get-SafeLinksAggregateReport without specifying a date range, the command will return an unspecified error. +**Note**: If you run Get-SafeLinksAggregateReport without specifying a date range, the command returns an unspecified error. 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. @@ -42,7 +43,7 @@ For the reporting period you specify, the cmdlet returns the following informati - MessageCount - RecipientCount -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,6 +57,9 @@ This example returns results summarized by Email Client and Teams results for th ## PARAMETERS ### -Action + +> Applicable: Exchange Online + The Action parameter filters the results by action. Valid values are: - Allowed @@ -73,7 +77,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -AppNameList + +> Applicable: Exchange Online + The AppNameList parameter filters the results by the app where the link was found. Valid values are: - Email Client @@ -95,7 +101,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -115,7 +123,6 @@ Yesterday is the most recent date that you can specify. You can't specify a date Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -135,7 +145,6 @@ Yesterday is the most recent date that you can specify. You can't specify a date Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of Action or AppNameList on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that specific Action or App on one row in the report. For this cmdlet, valid values are: @@ -156,7 +168,6 @@ For this cmdlet, valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksDetailReport.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksDetailReport.md index ef6379a4e6..1bc37e0c2f 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksDetailReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinksdetailreport applicable: Exchange Online -title: Get-SafeLinksDetailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safelinksdetailreport +schema: 2.0.0 +title: Get-SafeLinksDetailReport --- # Get-SafeLinksDetailReport @@ -34,7 +35,7 @@ Get-SafeLinksDetailReport ``` ## DESCRIPTION -**Note**: If you run Get-SafeLinksDetailReport without specifying a date range, the command will return an unspecified error. +**Note**: If you run Get-SafeLinksDetailReport without specifying a date range, the command returns an unspecified error. 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. @@ -55,7 +56,7 @@ This cmdlet returns the following information: - UrlType (currently empty) - Flags (0: Allowed 1: Blocked 2: ClickedEvenBlocked 3: ClickedDuringScan) -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,6 +76,9 @@ This example returns filters the results by the following information: ## PARAMETERS ### -Action + +> Applicable: Exchange Online + The Action parameter filters the results by action. Valid values are: - Allowed: URL was allowed due to a "Good" verdict. @@ -94,7 +98,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -AppNameList + +> Applicable: Exchange Online + The AppNameList parameter filters the results by the app where the link was found. Valid values are: - Email Client @@ -116,7 +122,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online + The Domain parameter filters the results by the domain in the URL. You can specify multiple values separated by commas. @@ -134,7 +142,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -154,7 +164,6 @@ Yesterday is the most recent date that you can specify. You can't specify a date Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -164,13 +173,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -180,13 +191,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. @@ -204,7 +220,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -214,6 +229,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -224,7 +242,6 @@ Yesterday is the most recent date that you can specify. You can't specify a date Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksPolicy.md index 63a24625de..57e426f923 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinkspolicy applicable: Exchange Online -title: Get-SafeLinksPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safelinkspolicy +schema: 2.0.0 +title: Get-SafeLinksPolicy --- # Get-SafeLinksPolicy @@ -28,7 +29,7 @@ Get-SafeLinksPolicy [[-Identity] ] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example shows detailed information about the Safe Links policy named Contos ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links policy that you want to view. You can use any value that uniquely identifies the policy. For example: @@ -61,7 +65,6 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksRule.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksRule.md index 279ebc68cd..bf94afdaa2 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinksrule applicable: Exchange Online -title: Get-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safelinksrule +schema: 2.0.0 +title: Get-SafeLinksRule --- # Get-SafeLinksRule @@ -29,7 +30,7 @@ Get-SafeLinksRule [[-Identity] ] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example returns detailed information about the Safe Links rule named Resear ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links rule that you want to view. You can use any value that uniquely identifies the rule. For example: @@ -62,7 +66,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md b/exchange/exchange-ps/ExchangePowerShell/Get-SearchDocumentFormat.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SearchDocumentFormat.md index 562980e971..3c75cb6c59 100644 --- a/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SearchDocumentFormat.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-searchdocumentformat -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-SearchDocumentFormat -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-searchdocumentformat +schema: 2.0.0 +title: Get-SearchDocumentFormat --- # Get-SearchDocumentFormat ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-SearchDocumentFormat cmdlet to retrieve details of file formats supported by Exchange Search. @@ -29,7 +30,7 @@ Get-SearchDocumentFormat [[-Identity] ] ## DESCRIPTION Exchange Search includes built-in support for indexing many file formats. Output from the Get-SearchDocumentFormat cmdlet includes details about each supported file format, including whether content indexing is enabled for the file format, the format handler and the file extension (such as .docx). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example retrieves all properties of the docx file format. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of a file format. ```yaml Type: SearchDocumentFormatId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -81,7 +87,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-SecOpsOverridePolicy.md similarity index 71% rename from exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SecOpsOverridePolicy.md index 31c46f8403..88e85ee0b6 100644 --- a/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SecOpsOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-secopsoverridepolicy applicable: Exchange Online -title: Get-SecOpsOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-secopsoverridepolicy +schema: 2.0.0 +title: Get-SecOpsOverridePolicy --- # Get-SecOpsOverridePolicy @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS 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 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). +Use the Get-SecOpsOverridePolicy cmdlet to view SecOps mailbox override policies that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -27,7 +28,7 @@ Get-SecOpsOverridePolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,6 +42,9 @@ This example returns detailed information about the one and only SecOps mailbox ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the SecOps override policy that you want to mod Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md b/exchange/exchange-ps/ExchangePowerShell/Get-SecurityPrincipal.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-SecurityPrincipal.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SecurityPrincipal.md index 458dcbe1b3..3028fa32a9 100644 --- a/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SecurityPrincipal.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-securityprincipal -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-SecurityPrincipal -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-securityprincipal +schema: 2.0.0 +title: Get-SecurityPrincipal --- # Get-SecurityPrincipal ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-SecurityPrincipal cmdlet to return a list of security principals. Security principals are entities, such as users or security groups, which can be assigned permissions and user rights. @@ -35,7 +36,7 @@ Get-SecurityPrincipal [[-Identity] ] ## DESCRIPTION The Get-SecurityPrincipal cmdlet is used by the Exchange admin center to populate fields that display recipient information. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,13 +71,15 @@ This example retrieves well-known security principals and displays only the Name ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the security principal. When the security principal is explicitly specified by using this parameter, no additional security principals are returned. ```yaml Type: ExtendedSecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -94,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -119,7 +127,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -IncludeDomainLocalFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IncludeDomainLocalFrom parameter specifies whether to return domain local groups from the FQDN of the specified Active Directory domain (for example, contoso.com) in the results. @@ -139,7 +149,6 @@ Don't use this parameter with the Filter or Identity parameters. Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -160,7 +172,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: ExtendedOrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -170,13 +181,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -RoleGroupAssignable + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The RoleGroupAssignable switch filters security principals by returning only objects that can be assigned to an RBAC role group. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -Types + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Types parameter filters the results by object type. Valid values are: - Computer @@ -217,7 +235,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SendConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-SendConnector.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-SendConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SendConnector.md index b285afa86f..2f89d0aed1 100644 --- a/exchange/exchange-ps/exchange/Get-SendConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SendConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sendconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SendConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sendconnector +schema: 2.0.0 +title: Get-SendConnector --- # Get-SendConnector @@ -27,7 +28,7 @@ Get-SendConnector [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example displays detailed information about the Send connector named Contos ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name, or GUID of the Send connector. If the Identity name contains spaces, enclose the name in quotation marks ("). You can omit the Identity parameter label. You can also include the server name by using the format ServerName\\ConnectorName. ```yaml Type: SendConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -65,7 +71,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-SenderFilterConfig.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-SenderFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SenderFilterConfig.md index b89a8e9412..0640040e6e 100644 --- a/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SenderFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-senderfilterconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SenderFilterConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-senderfilterconfig +schema: 2.0.0 +title: Get-SenderFilterConfig --- # Get-SenderFilterConfig @@ -27,7 +28,7 @@ Get-SenderFilterConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example returns detailed information about the Sender Filter configuration ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -65,7 +71,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SenderIdConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-SenderIdConfig.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-SenderIdConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SenderIdConfig.md index 1e0dad4cd1..81bcb35fbc 100644 --- a/exchange/exchange-ps/exchange/Get-SenderIdConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SenderIdConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-senderidconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SenderIdConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-senderidconfig +schema: 2.0.0 +title: Get-SenderIdConfig --- # Get-SenderIdConfig @@ -26,7 +27,7 @@ Get-SenderIdConfig [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,6 +41,9 @@ This example returns detailed information about the Sender ID configuration on t ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -48,7 +52,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-SenderReputationConfig.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-SenderReputationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SenderReputationConfig.md index 83288be5e1..e4512448d3 100644 --- a/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SenderReputationConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-senderreputationconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SenderReputationConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-senderreputationconfig +schema: 2.0.0 +title: Get-SenderReputationConfig --- # Get-SenderReputationConfig @@ -26,7 +27,7 @@ Get-SenderReputationConfig [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,6 +41,9 @@ This example returns detailed information about the sender reputation configurat ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -48,7 +52,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServerComponentState.md b/exchange/exchange-ps/ExchangePowerShell/Get-ServerComponentState.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-ServerComponentState.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ServerComponentState.md index 2008d37985..8f7f96e303 100644 --- a/exchange/exchange-ps/exchange/Get-ServerComponentState.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ServerComponentState.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-servercomponentstate -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ServerComponentState -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-servercomponentstate +schema: 2.0.0 +title: Get-ServerComponentState --- # Get-ServerComponentState @@ -28,7 +29,7 @@ Get-ServerComponentState [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example returns detailed information for the component state of the Unified ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Exchange server where you want to view the configuration settings. You can use the following values: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the Exchange server where you want to view the Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -Component + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Component parameter specifies the component or endpoint for which you want to retrieve the state. To see the available values, run the following command: `Get-ServerComponentState `. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -93,7 +101,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServerHealth.md b/exchange/exchange-ps/ExchangePowerShell/Get-ServerHealth.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ServerHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ServerHealth.md index 329cfe409b..5b71ddbc7c 100644 --- a/exchange/exchange-ps/exchange/Get-ServerHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ServerHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-serverhealth -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ServerHealth -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-serverhealth +schema: 2.0.0 +title: Get-ServerHealth --- # Get-ServerHealth @@ -28,11 +29,11 @@ Get-ServerHealth [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). The cmdlet returns health values that you can use to determine the state of the server. See [Server health and performance in Exchange Server](https://learn.microsoft.com/Exchange/server-health/server-health) for related information. -The cmdlet also returns an alert value that provides the specific state of your server. The following values may be returned: +The cmdlet also returns an alert value that provides the specific state of your server. The following values might be returned: - Degraded - Unhealthy @@ -53,6 +54,9 @@ This example returns the server health for server Server01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the Exchange server where you want to run this Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -HaImpactingOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The HaImpactingOnly switch specifies whether the cmdlet must roll up only the monitors that have HaImpacting set to True. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -HealthSet + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The HealthSet parameter returns the health state of a group of monitors. Monitors that are similar or are tied to a component's architecture are grouped to form a health set. You can determine the collection of monitors (and associated probes and responders) in a given health set by using the Get-MonitoringItemIdentity cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Get-ServerMonitoringOverride.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ServerMonitoringOverride.md index 2986dafdb9..720886c80d 100644 --- a/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ServerMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-servermonitoringoverride -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ServerMonitoringOverride -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-servermonitoringoverride +schema: 2.0.0 +title: Get-ServerMonitoringOverride --- # Get-ServerMonitoringOverride @@ -26,7 +27,7 @@ Get-ServerMonitoringOverride -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,6 +41,9 @@ This example retrieves all monitoring overrides for the Exch01 server. ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -53,7 +57,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-ServiceDeliveryReport.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ServiceDeliveryReport.md index 842dc2fa11..2b0bbce739 100644 --- a/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ServiceDeliveryReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-servicedeliveryreport applicable: Exchange Online, Exchange Online Protection -title: Get-ServiceDeliveryReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-servicedeliveryreport +schema: 2.0.0 +title: Get-ServiceDeliveryReport --- # Get-ServiceDeliveryReport @@ -27,7 +28,7 @@ Get-ServiceDeliveryReport [-ProbeTag ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example shows the delivery path information for the recipient chris@contoso ## PARAMETERS ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -57,13 +60,15 @@ Accept wildcard characters: False ``` ### -Recipient + +> Applicable: Exchange Online, Exchange Online Protection + The Recipient parameter specifies the email address of the recipient you want to test. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md b/exchange/exchange-ps/ExchangePowerShell/Get-ServicePrincipal.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-ServicePrincipal.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ServicePrincipal.md index ee06d9d363..f8d118cd49 100644 --- a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ServicePrincipal.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-serviceprincipal applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-ServicePrincipal -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-serviceprincipal +schema: 2.0.0 +title: Get-ServicePrincipal --- # Get-ServicePrincipal @@ -31,7 +32,7 @@ Service principals exist in Microsoft Entra ID to define what apps can do, who c 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example returns detailed information about the service principal with the O ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the service principal that you want to view. You can use any value that uniquely identifies the service principal. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the service principal that you want to view. Yo Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 0 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SettingOverride.md b/exchange/exchange-ps/ExchangePowerShell/Get-SettingOverride.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-SettingOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SettingOverride.md index dec2d72019..017e066e64 100644 --- a/exchange/exchange-ps/exchange/Get-SettingOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SettingOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-settingoverride -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SettingOverride -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-settingoverride +schema: 2.0.0 +title: Get-SettingOverride --- # Get-SettingOverride @@ -31,7 +32,7 @@ Get-SettingOverride [[-Identity] ] ## DESCRIPTION Setting overrides configure and store Exchange server customizations in Active Directory. The settings can be organization-wide or server-specific, and they persist in Active Directory across Exchange Cumulative Updates (CUs). Exchange customizations in web.config or exe.config XML application configuration files are server-specific, and are lost when you install the next Exchange CU. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example displays a detailed information for the setting override object nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the setting override that you want to view. You can use any value that uniquely identifies the override. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the setting override that you want to view. You Type: SettingOverrideIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SharingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-SharingPolicy.md similarity index 70% rename from exchange/exchange-ps/exchange/Get-SharingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SharingPolicy.md index a9e5d5b87f..86326ea869 100644 --- a/exchange/exchange-ps/exchange/Get-SharingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SharingPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sharingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-SharingPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sharingpolicy +schema: 2.0.0 +title: Get-SharingPolicy --- # Get-SharingPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-SharingPolicy cmdlet to view existing sharing policies that control how users inside your organization can share free/busy and contact information with users outside your organization. @@ -27,9 +28,9 @@ Get-SharingPolicy [[-Identity] ] ``` ## DESCRIPTION -Users can only share free/busy and contact information after federation has been configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing settings for the mailbox. +Users can only share free/busy and contact information after federation is configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing settings for the mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example retrieves the full information for the sharing policy Fabrikam. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the sharing policy that you want to view. You can use one of the following values: - ADObjectID @@ -61,7 +65,6 @@ The Identity parameter specifies the sharing policy that you want to view. You c Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -79,7 +85,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SiteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailbox.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-SiteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SiteMailbox.md index a35a4f6e0c..e6cecbe607 100644 --- a/exchange/exchange-ps/exchange/Get-SiteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sitemailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SiteMailbox -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sitemailbox +schema: 2.0.0 +title: Get-SiteMailbox --- # Get-SiteMailbox @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-SiteMailbox cmdlet to view information about site mailboxes. This cmdlet is primarily used by Microsoft SharePoint and Exchange to display information to users in the user interface. However, you may find it helpful for discovering information such as the site mailbox's owners, members, and lifecycle status. +Use the Get-SiteMailbox cmdlet to view information about site mailboxes. This cmdlet is primarily used by Microsoft SharePoint and Exchange to display information to users in the user interface. However, you mightht find it helpful for discovering information such as the site mailbox's owners, members, and lifecycle status. Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). @@ -36,7 +37,7 @@ Get-SiteMailbox [[-Identity] ] ## DESCRIPTION If you aren't a member or owner of the site mailbox that you want to view the diagnostics information for, you must use the BypassOwnerCheck parameter when running this cmdlet. If you aren't a member or owner of the site mailbox and you run this cmdlet without using the BypassOwnerCheck parameter, the command fails with an "object not found" error. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +65,9 @@ This example queries for site mailboxes that are marked for deletion and removes ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the site mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -77,7 +81,6 @@ The Identity parameter specifies the identity of the site mailbox. You can use a Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -99,7 +105,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -BypassOwnerCheck + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. @@ -117,7 +125,6 @@ If you don't use this switch, and you aren't a member or owner of the site mailb Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,15 +134,17 @@ Accept wildcard characters: False ``` ### -DeletedSiteMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeletedSiteMailbox switch returns site mailboxes that have been marked for pending deletion. You don't need to specify a value with this switch. -When the lifecycle application in SharePoint closes a site mailbox, the site mailbox is retained for the period specified in the lifecycle policy in the closed state. The mailbox can then be reactivated by an end user or by a SharePoint administrator. After the retention period, the Exchange site mailbox that's housed in the mailbox database will have its name prepended with MDEL: to indicate that it has been marked for deletion. To free storage space and the alias, use the Remove-Mailbox cmdlet to manually remove these site mailboxes from the mailbox database. +When the lifecycle application in SharePoint closes a site mailbox, the site mailbox is retained for the period specified in the lifecycle policy in the closed state. The mailbox can then be reactivated by an end user or by a SharePoint administrator. After the retention period, the name of the Exchange site mailbox housed in the mailbox database is prepended with `MDEL:` to indicate it's marked for deletion. To free storage space and the alias, use the Remove-Mailbox cmdlet to manually remove these site mailboxes from the mailbox database. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,13 +154,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -171,7 +185,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxDiagnostics.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxDiagnostics.md index a79fefc2f8..d1fc25520b 100644 --- a/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxDiagnostics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sitemailboxdiagnostics -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SiteMailboxDiagnostics -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sitemailboxdiagnostics +schema: 2.0.0 +title: Get-SiteMailboxDiagnostics --- # Get-SiteMailboxDiagnostics @@ -34,7 +35,7 @@ Get-SiteMailboxDiagnostics [-Identity] ## DESCRIPTION If you aren't a member or owner of the site mailbox that you want to view the diagnostics information for, you must use the BypassOwnerCheck parameter when running this cmdlet. If you aren't a member or owner of the site mailbox and you run this cmdlet without using the BypassOwnerCheck parameter, the command fails with an "object not found" error. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example returns the event information for the Marketing Events 2015 site ma ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the site mailbox that you want to view. You can use any value that uniquely identifies the site mailbox. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the site mailbox that you want to view. You can Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -BypassOwnerCheck + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. If you don't use this switch and you aren't a member or owner of the site mailbox, the command will fail. @@ -86,7 +92,6 @@ If you don't use this switch and you aren't a member or owner of the site mailbo Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -105,7 +113,6 @@ 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 Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -SendMeEmail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendMeEmail switch specifies that the diagnostic information is sent to the primary SMTP email address of the user account that's running the command. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxProvisioningPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxProvisioningPolicy.md index 1e107e4c93..5f5dcbe69b 100644 --- a/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxProvisioningPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sitemailboxprovisioningpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SiteMailboxProvisioningPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sitemailboxprovisioningpolicy +schema: 2.0.0 +title: Get-SiteMailboxProvisioningPolicy --- # Get-SiteMailboxProvisioningPolicy @@ -31,7 +32,7 @@ Get-SiteMailboxProvisioningPolicy [[-Identity] ] ## DESCRIPTION Site mailboxes allow access to both Microsoft SharePoint documents and Exchange email using the same client interface. Site mailbox provisioning policies apply settings to new site mailboxes that you create. You can create multiple site mailbox provisioning policies, but only the default policy is followed when users create site mailboxes. The default site mailbox provisioning policy is named Default. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example returns detailed information about the site mailbox provisioning po ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the site mailbox provisioning policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the site mailbox provisioning policy that you w Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SmimeConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-SmimeConfig.md similarity index 72% rename from exchange/exchange-ps/exchange/Get-SmimeConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SmimeConfig.md index 94acefe7bf..ba46b91d68 100644 --- a/exchange/exchange-ps/exchange/Get-SmimeConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SmimeConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-smimeconfig -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-SmimeConfig -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-smimeconfig +schema: 2.0.0 +title: Get-SmimeConfig --- # Get-SmimeConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-SmimeConfig cmdlet to view the S/MIME configuration for Outlook on the web (formerly known as Outlook Web App). @@ -26,7 +27,7 @@ Get-SmimeConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,13 +41,15 @@ This example shows the S/MIME configuration that's used with Outlook on the web. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md b/exchange/exchange-ps/ExchangePowerShell/Get-SmtpDaneInboundStatus.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SmtpDaneInboundStatus.md index 2bc72a8f55..68031aabf0 100644 --- a/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SmtpDaneInboundStatus.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-smtpdaneinboundstatus applicable: Exchange Online -title: Get-SmtpDaneInboundStatus -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-smtpdaneinboundstatus +schema: 2.0.0 +title: Get-SmtpDaneInboundStatus --- # Get-SmtpDaneInboundStatus @@ -27,7 +28,7 @@ Get-SmtpDaneInboundStatus [-DomainName] [] ## DESCRIPTION For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example checks the DANE status for the accepted domain contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md b/exchange/exchange-ps/ExchangePowerShell/Get-SpoofIntelligenceInsight.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SpoofIntelligenceInsight.md index 01335195b4..424b908c26 100644 --- a/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SpoofIntelligenceInsight.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-spoofintelligenceinsight applicable: Exchange Online, Exchange Online Protection -title: Get-SpoofIntelligenceInsight -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-spoofintelligenceinsight +schema: 2.0.0 +title: Get-SpoofIntelligenceInsight --- # Get-SpoofIntelligenceInsight @@ -34,7 +35,7 @@ The Get-SpoofIntelligenceInsight cmdlet returns the following information: - SpoofType: Indicates whether the domain is internal to your organization or external. - Action: The two possible values are Allow (messages that contain any spoofed sender email addresses in your organization are allowed from the source email server), and Block (messages that contain any spoofed sender email addresses in your organization are not allowed from the source email server). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +58,15 @@ This example exports the same list of spoofed senders to a CSV file. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter is available but isn't used. ```yaml Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SpoofMailReport.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-SpoofMailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SpoofMailReport.md index 312ec706dc..404128c301 100644 --- a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SpoofMailReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-spoofmailreport applicable: Exchange Online, Exchange Online Protection -title: Get-SpoofMailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-spoofmailreport +schema: 2.0.0 +title: Get-SpoofMailReport --- # Get-SpoofMailReport @@ -40,7 +41,7 @@ The Get-SpoofMailReport cmdlet returns the following information: - Direction: This value is Inbound. - Domain: The sender domain. This corresponds to one of your organization's accepted domains. - Spoofed User: The sending email address if the domain is one of your organization's domains, or the sending domain if the domain is external. -- True Sender: The organizational domain of the PTR record, or pointer record, of the sending IP address, also known as the reverse DNS address. If the sending IP address does not have a PTR record, this field will be blank and the Sender IP column will be filled in. Both columns will not be filled in at the same time. +- True Sender: The organizational domain of the PTR record, or pointer record, of the sending IP address, also known as the reverse DNS address. If the sending IP address does not have a PTR record, this field is blank and the Sender IP column is filled in. Both columns aren't filled in at the same time. - Sending Infrastructure: The true sending domain that's found in the DNS record of the source email server. If no domain is found, the source email server's IP address is shown. - Count: The number of spoofed messages that were sent to your organization from the source messaging server during the specified time period. - Spoof Type: The relationship between the sender and recipient domain of the spoof mail. If both belong to same domain (including subdomains) or domain owned by the same organization, then Spoof Type is intra-org or Internal. If both belong to different domains, then Spoof Type is cross-org or External. @@ -51,7 +52,7 @@ The Get-SpoofMailReport cmdlet returns the following information: - DKIM - DMARC -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,6 +66,9 @@ This example shows the insider spoofing detections in your organization during t ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -75,7 +79,6 @@ Common values for this report are GoodMail and CaughtAsSpam. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming messages. The valid value for this parameter is Inbound. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -109,7 +117,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. The only valid value for this parameter is SpoofMail. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,13 +180,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,6 +198,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -191,7 +209,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-StoreUsageStatistics.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-StoreUsageStatistics.md index 4a09b7af84..8fb4dd1461 100644 --- a/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-StoreUsageStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-storeusagestatistics -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-StoreUsageStatistics -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-storeusagestatistics +schema: 2.0.0 +title: Get-StoreUsageStatistics --- # Get-StoreUsageStatistics @@ -50,7 +51,7 @@ Get-StoreUsageStatistics -Server ## DESCRIPTION The Microsoft Exchange Information Store collects per-user information on latency, input/output (I/O), page counts, processor usage, and TimeInServer. The TimeInServer metric represents the total time that synchronous and asynchronous requests spend in the Microsoft Exchange Information Store for a user's mailbox. You can retrieve this resource information in the Microsoft Exchange Information Store for the 25 highest usage accounts on a specified database. Usage of a mailbox is defined as the amount of server time spent in performing operations for that mailbox. The cmdlet reports the top 25 users for every one-minute period for the last 10 minutes (250 objects per ten-minute interval). The resource usage is an indicator of the load that different users are placing on the server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,6 +79,9 @@ This example retrieves store usage statistics for database DB1 and sorts the out ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox to get usage statistics from. You can use one of the following values to identify the mailbox: - GUID @@ -96,7 +100,6 @@ You can't use this parameter with the Database or Server parameters. Type: GeneralMailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Database parameter specifies the name of the mailbox database to get usage statistics from (the top 25 largest mailboxes on the specified mailbox database). You can use any value that uniquely identifies the mailbox database. For example: - Name @@ -118,7 +124,6 @@ You can't use this parameter with the Identity or Server parameters. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Mailbox server to get usage statistics from (the top 25 mailboxes on all active databases on the specified server). You can use one of the following values to identify the server: - Fully qualified domain name (FQDN) @@ -139,7 +147,6 @@ You can't use this parameter with the Database or Identity parameters. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -149,6 +156,9 @@ Accept wildcard characters: False ``` ### -CopyOnServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CopyOnServer parameter specifies the mailbox database copy to get usage statistics from. You can use any value that uniquely identifies the mailbox database. For example: - Name @@ -161,7 +171,6 @@ You use this parameter with the Server or Identity parameters. Type: ServerIdParameter Parameter Sets: Database, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +180,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,6 +198,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -202,7 +216,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -IncludePassive + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludePassive switch specifies whether to include usage statistics from active and passive copies of mailbox databases on the Mailbox server you specified with the Server parameter. You don't need to specify a value with this switch. If you don't use this switch, only statistics from active copies of mailbox databases are included in the results. @@ -220,7 +236,6 @@ If you don't use this switch, only statistics from active copies of mailbox data Type: SwitchParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewActivity.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewActivity.md index 420045a251..a8f88c2678 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewActivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewactivity applicable: Exchange Online, Security & Compliance -title: Get-SupervisoryReviewActivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewactivity +schema: 2.0.0 +title: Get-SupervisoryReviewActivity --- # Get-SupervisoryReviewActivity @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-SupervisoryReviewActivity cmdlet to view all activities performed by a reviewer for a specific supervision policy. This information may be useful if reviewer activities are required in regulatory compliance audits or in litigation. +Use the Get-SupervisoryReviewActivity cmdlet to view all activities performed by a reviewer for a specific supervision policy. This information might be useful if reviewer activities are required in regulatory compliance audits or in litigation. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -26,7 +27,7 @@ Get-SupervisoryReviewActivity -EndDate -PolicyId -StartDat ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example exports all the supervisory review activities for a policy to a .cs ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -55,7 +59,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: True Position: Named @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -PolicyId + +> Applicable: Exchange Online, Security & Compliance + {{ Fill PolicyId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: True Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -89,7 +97,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewOverallProgressReport.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewOverallProgressReport.md index 3a432c1505..dbc52974fd 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewOverallProgressReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewoverallprogressreport applicable: Security & Compliance -title: Get-SupervisoryReviewOverallProgressReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewoverallprogressreport +schema: 2.0.0 +title: Get-SupervisoryReviewOverallProgressReport --- # Get-SupervisoryReviewOverallProgressReport @@ -43,6 +44,9 @@ This example returns a list of the total number of supervised communications cla ## PARAMETERS ### -EndDate + +> Applicable: Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -51,7 +55,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -93,6 +100,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -101,7 +111,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyReport.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyReport.md index d3982ce31b..34eb1e064a 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyreport applicable: Exchange Online, Security & Compliance -title: Get-SupervisoryReviewPolicyReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewpolicyreport +schema: 2.0.0 +title: Get-SupervisoryReviewPolicyReport --- # Get-SupervisoryReviewPolicyReport @@ -60,6 +61,9 @@ This example returns the supervisory review policy events for the policy named E ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -68,7 +72,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Policies + +> Applicable: Exchange Online, Security & Compliance + The Policies parameter filters the results by the supervisory review policy. You can specify multiple values separated by commas. @@ -118,7 +128,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -136,7 +148,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyV2.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyV2.md index cc356b57a5..a6b4994a08 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyV2.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyv2 applicable: Exchange Online, Security & Compliance -title: Get-SupervisoryReviewPolicyV2 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewpolicyv2 +schema: 2.0.0 +title: Get-SupervisoryReviewPolicyV2 --- # Get-SupervisoryReviewPolicyV2 @@ -47,6 +48,9 @@ This example returns detailed information for the supervisory review policy name ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the supervisory review policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the supervisory review policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewReport.md index 5e1a033aa5..c5358a7103 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewreport applicable: Exchange Online, Security & Compliance -title: Get-SupervisoryReviewReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewreport +schema: 2.0.0 +title: Get-SupervisoryReviewReport --- # Get-SupervisoryReviewReport @@ -52,6 +53,9 @@ This example returns the supervisory review events for the policy named US Broke ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -60,7 +64,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -Policies + +> Applicable: Exchange Online, Security & Compliance + The Policies parameter filters the results by the supervisory review policy. You can specify multiple values separated by commas. @@ -110,7 +120,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Reviewers + +> Applicable: Exchange Online, Security & Compliance + The Reviewers parameter filters the results by the reviewers of the supervisory review policy. You can specify multiple values separated by commas. @@ -128,7 +140,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -146,7 +160,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewRule.md index ac82f7525f..135c9a1e38 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewrule applicable: Exchange Online, Security & Compliance -title: Get-SupervisoryReviewRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewrule +schema: 2.0.0 +title: Get-SupervisoryReviewRule --- # Get-SupervisoryReviewRule @@ -22,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-SupervisoryReviewRule [[-Identity] ] + [-IncludeRuleXml] [-Policy ] [] ``` @@ -55,6 +57,9 @@ This example returns the rule that assigned to the supervisory review policy nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the supervisory review rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +70,6 @@ The Identity parameter specifies the supervisory review rule that you want to vi Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -74,7 +78,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -IncludeRuleXml + +> Applicable: Security & Compliance + +{{ Fill IncludeRuleXml Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Policy + +> Applicable: Exchange Online, Security & Compliance + 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: - Name @@ -85,7 +110,6 @@ The Policy parameter filters the results by supervisory review policy that's ass Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewTopCasesReport.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewTopCasesReport.md index f630b5e84b..b6ff38b992 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewTopCasesReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewtopcasesreport applicable: Security & Compliance -title: Get-SupervisoryReviewTopCasesReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewtopcasesreport +schema: 2.0.0 +title: Get-SupervisoryReviewTopCasesReport --- # Get-SupervisoryReviewTopCasesReport @@ -42,6 +43,9 @@ This example returns detailed information on supervisory policies, including the ## PARAMETERS ### -EndDate + +> Applicable: Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -50,7 +54,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -76,13 +81,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -92,6 +99,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -100,7 +110,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-SweepRule.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SweepRule.md index ceab5bc86d..da057d7310 100644 --- a/exchange/exchange-ps/exchange/Get-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SweepRule.md @@ -1,18 +1,19 @@ --- -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, Exchange Online Protection -title: Get-SweepRule -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sweeprule +schema: 2.0.0 +title: Get-SweepRule --- # Get-SweepRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-SweepRule cmdlet to view Sweep rules in mailboxes. Sweep rules run at regular intervals to help keep your Inbox clean. @@ -31,7 +32,7 @@ Get-SweepRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example returns detailed information for the Sweep rule with the specified ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Sweep rule that you want to view. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). @@ -69,7 +73,6 @@ The Identity parameter specifies the Sweep rule that you want to view. You can u Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -BypassScopeCheck + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -103,7 +111,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter filters the results by the specified mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -130,7 +140,6 @@ The Mailbox parameter filters the results by the specified mailbox. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -Provider + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Provider parameter filters the results by the specified provider. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -164,7 +178,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -SkipCount + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} @@ -182,7 +198,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SystemMessage.md b/exchange/exchange-ps/ExchangePowerShell/Get-SystemMessage.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-SystemMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SystemMessage.md index ba18ccc28c..e1fe24a3eb 100644 --- a/exchange/exchange-ps/exchange/Get-SystemMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SystemMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-systemmessage -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SystemMessage -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-systemmessage +schema: 2.0.0 +title: Get-SystemMessage --- # Get-SystemMessage @@ -37,7 +38,7 @@ Get-SystemMessage [-Original] ## DESCRIPTION NDRs are issued to the senders of email messages that haven't reached their intended recipients. Quota messages are issued to users whose mailboxes or public folders have reached the specific warning, prohibit send, or prohibit receive quotas. Custom NDRs and quota messages replace the default messages that are included with Exchange. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,11 +70,14 @@ Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language, This example outputs the list of all default system messages in all languages to an HTML file named C:\\My Documents\\Default System Messages.html. -You should output the list to a file, because the list is very long, and you'll receive errors if you don't have the required language packs installed. +You should output the list to a file, because the list is very long, and you get errors if you don't have the required language packs installed. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the custom system message that you want to view. You can use any value that uniquely identifies the system message. For example: - Identity @@ -131,7 +135,6 @@ Maximum number of levels (depth) in a mailbox folder: Type: SystemMessageIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -141,6 +144,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -149,7 +155,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +164,9 @@ Accept wildcard characters: False ``` ### -Original + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Original switch filters the results by the default system messages that are included with Exchange. You don't need to specify a value with this switch. You can't use this switch with the Identity parameter. @@ -167,7 +175,6 @@ You can't use this switch with the Identity parameter. Type: SwitchParameter Parameter Sets: Original Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicy.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicy.md index 4f520c8a57..eb40e3fa30 100644 --- a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-teamsprotectionpolicy applicable: Exchange Online -title: Get-TeamsProtectionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-teamsprotectionpolicy +schema: 2.0.0 +title: Get-TeamsProtectionPolicy --- # Get-TeamsProtectionPolicy @@ -26,7 +27,7 @@ Get-TeamsProtectionPolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,13 +41,15 @@ This example shows detailed information about the Teams protection policy in the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Teams protection policy that you want to view. There's only one Teams protection policy in an organization named Teams Protection Policy. ```yaml Type: TeamsProtectionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicyRule.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicyRule.md index 5aba335ec7..25bfac1144 100644 --- a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-teamsprotectionpolicyrule applicable: Exchange Online -title: Get-TeamsProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-teamsprotectionpolicyrule +schema: 2.0.0 +title: Get-TeamsProtectionPolicyRule --- # Get-TeamsProtectionPolicyRule @@ -27,7 +28,7 @@ Get-TeamsProtectionPolicyRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example shows detailed information about the Teams protection policy in the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Teams protection policy rule that you want to view. There's only one Teams protection policy rule in an organization named Teams Protection Policy Rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by the State value of the rule. Valid values are: - Enabled @@ -66,7 +72,6 @@ The State parameter filters the results by the State value of the rule. Valid va Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md b/exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListItems.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListItems.md index f2a8862ef7..cf8b01b151 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-tenantallowblocklistitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-TenantAllowBlockListItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-tenantallowblocklistitems +schema: 2.0.0 +title: Get-TenantAllowBlockListItems --- # Get-TenantAllowBlockListItems @@ -43,7 +44,7 @@ Get-TenantAllowBlockListItems -ListType [-NoExpiration] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,11 +67,14 @@ 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 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). +This example returns information for all allowed non-Microsoft phishing simulation URLs. For more information, see [Configure the advanced delivery policy for non-Microsoft phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). ## PARAMETERS ### -ListType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListType parameter specifies the list to view. Valid values are: - FileHash @@ -82,7 +86,6 @@ The ListType parameter specifies the list to view. Valid values are: Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -Entry + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Entry parameter filters the results based on the ListType parameter value. Valid values are: - FileHash: The exact SHA256 file hash value. @@ -105,7 +111,6 @@ This value is shown in the Value property of the entry in the output of the Get- Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -NoExpiration + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The NoExpiration switch filters the results by entries that are set to never expire. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: NoExpiration Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -Allow + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Allow switch filters the results for allow entries. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -Block + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Block switch filters the results for block entries. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -ExpirationDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ExpirationDate parameter filters the results by expiration date in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -174,7 +188,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: Expiration Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -184,16 +197,18 @@ Accept wildcard characters: False ``` ### -ListSubType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListSubType parameter filters the results by subtype. Valid values are: - AdvancedDelivery -- Tenant: This is the default value. +- Tenant: This value is the default. ```yaml Type: ListSubType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -203,6 +218,9 @@ Accept wildcard characters: False ``` ### -OutputJson + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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. You use this switch to prevent the command from halting on the first entry that contains a syntax error. @@ -211,7 +229,6 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListSpoofItems.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListSpoofItems.md index a77fd3036a..ce29b5cd5d 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListSpoofItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-tenantallowblocklistspoofitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-TenantAllowBlockListSpoofItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-tenantallowblocklistspoofitems +schema: 2.0.0 +title: Get-TenantAllowBlockListSpoofItems --- # Get-TenantAllowBlockListSpoofItems @@ -30,13 +31,13 @@ Get-TenantAllowBlockListSpoofItems [[-Identity] Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter is available but isn't used. ```yaml Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 0 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Action parameter filters the results by action type. Valid values are: - Allow @@ -96,7 +102,6 @@ The Action parameter filters the results by action type. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -SpoofType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SpoofType parameter filters the results by spoof type. Valid values are: - External @@ -115,7 +123,6 @@ The SpoofType parameter filters the results by spoof type. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md b/exchange/exchange-ps/ExchangePowerShell/Get-TextMessagingAccount.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-TextMessagingAccount.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TextMessagingAccount.md index 11e102c7e7..6991b2a2b4 100644 --- a/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TextMessagingAccount.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-textmessagingaccount -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-TextMessagingAccount -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-textmessagingaccount +schema: 2.0.0 +title: Get-TextMessagingAccount --- # Get-TextMessagingAccount ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-TextMessagingAccount cmdlet to view the text notification settings on mailboxes. @@ -32,7 +33,7 @@ Get-TextMessagingAccount [-Identity] ## DESCRIPTION When text messaging notifications are enabled on a mailbox, you can configure calendar notifications, voice mail notifications, and email notifications using an inbox rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example finds all user mailboxes where text messaging notifications are ena ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -72,7 +76,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -90,7 +96,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -108,7 +116,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -128,7 +138,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicy.md index 5299f4079b..3425dedb68 100644 --- a/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-throttlingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ThrottlingPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-throttlingpolicy +schema: 2.0.0 +title: Get-ThrottlingPolicy --- # Get-ThrottlingPolicy @@ -34,7 +35,7 @@ The Get-ThrottlingPolicy cmdlet returns the client throttling settings for one o For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example displays the parameters and values for throttling policy Throttling ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter identifies the name of the throttling policy that you want to return settings for. ```yaml Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -79,7 +85,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -Diagnostics + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Diagnostics switch specifies whether you want the output to include the diagnostics string. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -Explicit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Explicit switch specifies whether to return only the policy settings that have been directly assigned using this policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicyScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ThrottlingPolicyScope parameter specifies the scope of the throttling policy. You can use the following values: - Global @@ -133,7 +145,6 @@ For information about each of these policy scopes, see [User workload management Type: ThrottlingPolicyScopeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicyAssociation.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicyAssociation.md index 6850db5cc9..96ab8b7745 100644 --- a/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicyAssociation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-throttlingpolicyassociation -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ThrottlingPolicyAssociation -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-throttlingpolicyassociation +schema: 2.0.0 +title: Get-ThrottlingPolicyAssociation --- # Get-ThrottlingPolicyAssociation @@ -43,7 +44,7 @@ Get-ThrottlingPolicyAssociation [[-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the throttling policy association that you want to view. You can use any value that uniquely identifies the throttling policy association. For example: - Name @@ -91,7 +95,6 @@ The Identity parameter specifies the throttling policy association that you want Type: ThrottlingPolicyAssociationIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -113,7 +119,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -131,7 +139,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,13 +148,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +166,15 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ThrottlingPolicy parameter filters the results by throttling policy. You can use any value that uniquely identifies the throttling policy. For example: - Name @@ -183,7 +197,6 @@ The ThrottlingPolicy parameter filters the results by throttling policy. You can Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportAgent.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportAgent.md index 8efaaf32bc..6d15812ff3 100644 --- a/exchange/exchange-ps/exchange/Get-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportagent -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportAgent -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportagent +schema: 2.0.0 +title: Get-TransportAgent --- # Get-TransportAgent @@ -28,7 +29,7 @@ Get-TransportAgent [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example displays detailed information about the Transport Rule agent that's ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the display name of the transport agent to be displayed. The length of the name can't exceed 64 characters. ```yaml Type: TransportAgentObjectId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -73,7 +79,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -95,7 +103,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportConfig.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-TransportConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportConfig.md index 3357a4be56..aae5714bfc 100644 --- a/exchange/exchange-ps/exchange/Get-TransportConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-TransportConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportconfig +schema: 2.0.0 +title: Get-TransportConfig --- # Get-TransportConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-TransportConfig cmdlet to view organization-wide transport configuration settings. @@ -29,7 +30,7 @@ Get-TransportConfig [[-Identity] ] ## DESCRIPTION The Get-TransportConfig cmdlet displays configuration information for global transport settings applied across the organization when the cmdlet is run on a Mailbox server. When this cmdlet is run on an Edge Transport server, only the transportation configuration settings for the local computer are shown. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example lists all delivery status notification-related (DSN) configuration ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -58,7 +62,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -78,7 +84,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportPipeline.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportPipeline.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-TransportPipeline.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportPipeline.md index 8366b7fc1a..75dccf9a86 100644 --- a/exchange/exchange-ps/exchange/Get-TransportPipeline.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportPipeline.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportpipeline -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportPipeline -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportpipeline +schema: 2.0.0 +title: Get-TransportPipeline --- # Get-TransportPipeline @@ -34,7 +35,7 @@ The Get-TransportPipeline cmdlet enables you to view all the transport agents th The associated transport service must be started and at least one email message must be sent through the server since the last service restart before the transport pipeline can be viewed. Only the transport events and agents that were involved in the processing of email messages since the associated service was last started are returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example returns a list of agents registered in the transport pipeline, with ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -63,7 +67,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRule.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportRule.md index d55f8756f4..8a2eecaadb 100644 --- a/exchange/exchange-ps/exchange/Get-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-TransportRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportrule +schema: 2.0.0 +title: Get-TransportRule --- # Get-TransportRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-TransportRule cmdlet to view transport rules (mail flow rules) in your organization. @@ -34,7 +35,7 @@ Get-TransportRule [[-Identity] ] ## DESCRIPTION On Mailbox servers, this cmdlet returns all rules in the Exchange organization that are stored in Active Directory. On an Edge Transport server, this cmdlet only returns rules that are configured on the local server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,6 +72,9 @@ In on-premises Exchange, this example returns a summary list of all rules that e ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -81,7 +85,6 @@ The Identity parameter specifies the rule that you want to view. You can use any Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -101,7 +107,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The State parameter specifies filters the results by enabled or disabled rules. Valid values are: - Enabled: Only enabled rules are returned in the results. @@ -122,7 +130,6 @@ If you don't use this parameter, the command returns all rules, both enabled and Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This parameter is functional only in on-premises Exchange. The DlpPolicy parameter filters the results by the name of the specified data loss prevention (DLP) policy. If the value contains spaces, enclose the value in quotation marks ("). @@ -142,7 +152,6 @@ DLP policies in your organization allow you to prevent unintentional disclosure Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,18 +161,20 @@ Accept wildcard characters: False ``` ### -ExcludeConditionActionDetails + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ExcludeConditionActionDetails parameter specifies whether to hide specific details from the results. Valid values are: - $true: The Description, Conditions, and Actions properties, as well as any configured condition, exception and action property values are blank. -- $false: No properties or property values are hidden. This is the default value. +- $false: No properties or property values are hidden. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Filter parameter filters the results by using an OPATH. This parameter searches the Description property, which includes the conditions, exceptions, actions and the associated values of a transport rule. This parameter uses the syntax `"Description -like 'Text*'"`. For example, `"Description -like '192.168.1.1*'"`. @@ -183,7 +197,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -193,13 +206,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportRuleAction.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRuleAction.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-TransportRuleAction.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportRuleAction.md index a7052dc127..e68c4223b8 100644 --- a/exchange/exchange-ps/exchange/Get-TransportRuleAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRuleAction.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportruleaction -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-TransportRuleAction -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportruleaction +schema: 2.0.0 +title: Get-TransportRuleAction --- # Get-TransportRuleAction ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-TransportRuleAction cmdlet to view the actions that are available for transport rules (mail flow rules). @@ -28,7 +29,7 @@ Get-TransportRuleAction [[-Name] ] ## DESCRIPTION In on-premises Exchange, the actions that are available on Mailboxes servers and Edge Transports server are different. Also, the names of some of the actions that are returned by this cmdlet are different than the corresponding parameter names in the New-TransportRule and Set-TransportRule cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,13 +52,15 @@ For more information about pipelining, see [About Pipelines](https://learn.micro ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the action that you want to view. To see the list of available names, run the command Get-TransportRuleAction. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRulePredicate.md similarity index 81% rename from exchange/exchange-ps/exchange/Get-TransportRulePredicate.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportRulePredicate.md index 1781b502e3..bf8df73ee2 100644 --- a/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRulePredicate.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportrulepredicate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-TransportRulePredicate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportrulepredicate +schema: 2.0.0 +title: Get-TransportRulePredicate --- # Get-TransportRulePredicate ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-TransportRulePredicate cmdlet to view the predicates (conditions and exceptions) that are available for transport rules (mal flow rules). @@ -30,7 +31,7 @@ Collectively, the conditions and exceptions in rules are known as predicates, be In on-premises Exchange, the predicates that are available on Mailboxes servers and Edge Transports server are different. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,13 +63,15 @@ For more information about how to work with the output of a command, see [Workin ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the predicate that you want to view. To see the list of available names, run the command Get-TransportRulePredicate. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-TransportServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportServer.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-TransportServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportServer.md index 9e6bfd34f4..03fbc9ba82 100644 --- a/exchange/exchange-ps/exchange/Get-TransportServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportserver -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportServer -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportserver +schema: 2.0.0 +title: Get-TransportServer --- # Get-TransportServer @@ -29,7 +30,7 @@ Get-TransportServer [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example retrieves the detailed transport configuration information for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Transport server that you want to view. You can use any value that uniquely identifies the server. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the Transport server that you want to view. You Type: TransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -79,7 +85,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportService.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportService.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-TransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportService.md index de2c585879..dde404dc0d 100644 --- a/exchange/exchange-ps/exchange/Get-TransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportservice -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportService -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportservice +schema: 2.0.0 +title: Get-TransportService --- # Get-TransportService @@ -27,7 +28,7 @@ Get-TransportService [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example retrieves the detailed transport configuration information for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Mailbox server that hosts the Transport service configuration you want to view. You can use any value that uniquely identifies the server. For example: - Name @@ -61,7 +65,6 @@ You can't use this parameter on an Edge Transport server. Type: TransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -79,7 +85,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Trust.md b/exchange/exchange-ps/ExchangePowerShell/Get-Trust.md similarity index 77% rename from exchange/exchange-ps/exchange/Get-Trust.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Trust.md index 06c4e8a053..0ebb762b37 100644 --- a/exchange/exchange-ps/exchange/Get-Trust.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Trust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-trust -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-Trust -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-trust +schema: 2.0.0 +title: Get-Trust --- # Get-Trust @@ -28,7 +29,7 @@ Get-Trust [-DomainName ] ## DESCRIPTION The Get-Trust cmdlet is used by the Exchange admin center in to populate fields that display recipient information. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,13 +43,15 @@ This example enumerates all trusts for the domain Contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainName parameter specifies that trusts returned are restricted to the domain name specified. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMActiveCalls.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMActiveCalls.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-UMActiveCalls.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMActiveCalls.md index ad6d739107..3b5c18f829 100644 --- a/exchange/exchange-ps/exchange/Get-UMActiveCalls.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMActiveCalls.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umactivecalls applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMActiveCalls -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umactivecalls +schema: 2.0.0 +title: Get-UMActiveCalls --- # Get-UMActiveCalls @@ -55,7 +56,7 @@ When a Mailbox server is process cycling, the Get-UMActiveCalls cmdlet doesn't r After this task is completed, you can see the list of active calls being processed by a Mailbox server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,6 +91,9 @@ This example displays a list of active calls associated with the UM dial plan My ## PARAMETERS ### -DialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DialPlan parameter specifies the UM dial plan for which you want to retrieve active calls. You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command. @@ -98,7 +102,6 @@ You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in t Type: UMDialPlanIdParameter Parameter Sets: DialPlan Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -InstanceServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InstanceServer parameter specifies the Mailbox server running the Microsoft Exchange Unified Messaging service for which you want to retrieve active calls. You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command. @@ -116,7 +122,6 @@ You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in t Type: UMServer Parameter Sets: ServerInstance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -IPGateway + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IPGateway parameter specifies the UM IP gateway for which you want to retrieve active calls. You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command. @@ -134,7 +142,6 @@ You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in t Type: UMIPGatewayIdParameter Parameter Sets: UMIPGateway Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -144,13 +151,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Server parameter filters the results by the specified Unified Messaging server. You can use any value that uniquely identifies the server. For example: - Name @@ -173,7 +185,6 @@ You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in t Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMAutoAttendant.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMAutoAttendant.md index 4ae3dced8b..573e07b1cb 100644 --- a/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umautoattendant +schema: 2.0.0 +title: Get-UMAutoAttendant --- # Get-UMAutoAttendant @@ -32,7 +33,7 @@ The Get-UMAutoAttendant cmdlet retrieves the properties for a single UM auto att After this task is completed, if no parameter is supplied with the cmdlet, the cmdlet returns all UM auto attendants in the Active Directory forest. Or, if the UM dial plan ID is supplied but no name is supplied, the cmdlet returns all UM auto attendants linked to the UM dial plan. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,13 +61,15 @@ This examples displays all the UM auto attendants associated with the UM dial pl ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM auto attendant that's being viewed. This is the directory object ID for the UM auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies whether to display all the UM auto attendants that are associated with the UM dial plan that's specified. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallAnsweringRule.md similarity index 79% rename from exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMCallAnsweringRule.md index e469e77136..bc5e76e829 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: Get-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umcallansweringrule +schema: 2.0.0 +title: Get-UMCallAnsweringRule --- # Get-UMCallAnsweringRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-UMCallAnsweringRule cmdlet to view the properties of a Unified Messaging (UM) call answering rule that has been created within a UM-enabled mailbox. +Use the Get-UMCallAnsweringRule cmdlet to view the properties of a Unified Messaging (UM) call answering rule that is created within a UM-enabled mailbox. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -28,11 +29,11 @@ Get-UMCallAnsweringRule [[-Identity] ] ``` ## DESCRIPTION -The Get-UMCallAnsweringRule cmdlet enables you to view the properties of a call answering rule that has been created in a UM-enabled user's mailbox. It allows you to retrieve the properties for a single call answering rule or a list of call answering rules in a UM-enabled user's mailbox. +The Get-UMCallAnsweringRule cmdlet enables you to view the properties of a call answering rule that is created in a UM-enabled user's mailbox. It allows you to retrieve the properties for a single call answering rule or a list of call answering rules in a UM-enabled user's mailbox. After this task is completed, the cmdlet returns the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example displays the properties of the call answering rule MyUMCallAnswerin ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for a call answering rule being viewed. ```yaml Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox that contains the UM call answering rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -104,7 +112,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallDataRecord.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-UMCallDataRecord.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMCallDataRecord.md index 868677c8f0..194e7797f1 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallDataRecord.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umcalldatarecord applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMCallDataRecord -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umcalldatarecord +schema: 2.0.0 +title: Get-UMCallDataRecord --- # Get-UMCallDataRecord @@ -30,7 +31,7 @@ Get-UMCallDataRecord -Mailbox The Get-UMCallDataRecord cmdlet displays UM call data records for the last 90 days for a UM-enabled mailbox that you specify. Each UM call data record provides detailed information about all calls either placed to or received by the specified user. The following list details each of the properties that are returned: - Date: Date and time of the Mailbox server running the Microsoft Exchange Unified Messaging service that took the call in the Coordinated Universal Time (UTC) format. -- Duration: Total duration of this call. For Find Me calls, this will always be zero because the call is being transferred and won't be handled by Unified Messaging any longer. +- Duration: Total duration of this call. For Find Me calls, this value is always zero because the call is being transferred and is no longer handled by Unified Messaging. - AudioCodec: Audio codec used for the call including G.711 or Group System Mobile (GSM). - DialPlan: Name of the UM dial plan handling the call. - CallType: Type of the call (localized in the user's language): Call Answering Voice Message, Call Answering Missed Call, , Auto Attendant, Subscriber Access, Fax, PlayOnPhone, Find Me, None, UnauthenticatedPilotNumber, or PromptProvisioning. @@ -44,7 +45,7 @@ The Get-UMCallDataRecord cmdlet displays UM call data records for the last 90 da - RoundTripMilliseconds: Round trip time for Real Time Control Protocol (RTCP) statistics in milliseconds. - BurstLossDurationMilliseconds: Average duration of packet loss during bursts during the call. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example displays the UM call data records for the UM-enabled user Tony. ## PARAMETERS ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox that UM call data records are displayed for. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -75,7 +79,6 @@ The Mailbox parameter specifies the UM-enabled mailbox that UM call data records Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallRouterSettings.md similarity index 85% rename from exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMCallRouterSettings.md index 44123198a3..52e4f24797 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallRouterSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umcallroutersettings applicable: Exchange Server 2013, Exchange Server 2016 -title: Get-UMCallRouterSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umcallroutersettings +schema: 2.0.0 +title: Get-UMCallRouterSettings --- # Get-UMCallRouterSettings @@ -29,7 +30,7 @@ Get-UMCallRouterSettings [[-Server] ] ## DESCRIPTION When the cmdlet is used for a single server, it returns the UM call router properties including MaxCalls, MaxFaxCalls and UMDialPlans. The properties and their values are stored in the Unified Messaging section of the Microsoft Exchange configuration object in Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example displays detailed information for the Microsoft Exchange Unified Me ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -63,7 +67,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallSummaryReport.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMCallSummaryReport.md index 87b5ea88f8..07ada2f752 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallSummaryReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umcallsummaryreport applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMCallSummaryReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umcallsummaryreport +schema: 2.0.0 +title: Get-UMCallSummaryReport --- # Get-UMCallSummaryReport @@ -51,7 +52,7 @@ The Get-UMCallSummaryReport cmdlet displays the aggregated statistics about all - Burst loss Duration: Average duration of packet loss during bursts of losses for the selected UM dial plan or UM IP gateway. - Number of samples: Number of calls sampled, when calculating the averages. A sample refers to any call data record that contains at least one of the audio quality metrics. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,6 +87,9 @@ This example displays the statistics for calls received or placed by Mailbox ser ## PARAMETERS ### -GroupBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The GroupBy parameter specifies how to return the results. Valid values are: - Day: Daily statistics for the last 90 days. @@ -96,7 +100,6 @@ The GroupBy parameter specifies how to return the results. Valid values are: Type: GroupBy Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the Unified Messaging (UM) dial plan to show statistics for. If you don't specify a dial plan, statistics are included for all dial plans in the organization. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -UMIPGateway -The UMIPGateway parameter specifies the UM IP gateway to show statistics for. If you don't specify a UM IP gateway, statistics are included for all UM IP gateways for a selected dial plan, or, if no dial plan is selected, results will be returned for all UM IP gateways in the organization. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The UMIPGateway parameter specifies the UM IP gateway to show statistics for. If you don't specify a UM IP gateway, statistics are included for all UM IP gateways for a selected dial plan, or, if no dial plan is selected, results are returned for all UM IP gateways in the organization. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMDialPlan.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMDialPlan.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-UMDialPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMDialPlan.md index fe86e9ee42..c81063f4c2 100644 --- a/exchange/exchange-ps/exchange/Get-UMDialPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMDialPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMDialPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umdialplan +schema: 2.0.0 +title: Get-UMDialPlan --- # Get-UMDialPlan @@ -31,7 +32,7 @@ The Get-UMDialPlan cmdlet displays all properties for a UM dial plan. After this task is completed, when you specify the Identity parameter, you can view the values set. When the Get-UMDialPlan cmdlet is run, if no parameter is supplied, the cmdlet returns all UM dial plans in the Active Directory forest. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,13 +53,15 @@ This example displays a formatted list of properties for the UM dial plan MyUMDi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the UM dial plan ID. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMHuntGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMHuntGroup.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-UMHuntGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMHuntGroup.md index d1a7328d41..825cf9cf9b 100644 --- a/exchange/exchange-ps/exchange/Get-UMHuntGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMHuntGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umhuntgroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMHuntGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umhuntgroup +schema: 2.0.0 +title: Get-UMHuntGroup --- # Get-UMHuntGroup @@ -32,7 +33,7 @@ The Get-UMHuntGroup cmdlet retrieves the properties for a single UM hunt group o After this task is completed, if the Identity parameter is specified, the properties for the UM hunt group are returned. If neither the Identity nor the UMDialPlan parameter is specified, all UM hunt groups in the Active Directory forest are returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,13 +61,15 @@ This example displays all of the UM hunt groups associated with the UM dial plan ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM hunt group being viewed. This is the directory object ID for the UM hunt group. ```yaml Type: UMHuntGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan associated with a UM hunt group. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMIPGateway.md similarity index 85% rename from exchange/exchange-ps/exchange/Get-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMIPGateway.md index f027b0d0a4..5efbaf5ed9 100644 --- a/exchange/exchange-ps/exchange/Get-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umipgateway +schema: 2.0.0 +title: Get-UMIPGateway --- # Get-UMIPGateway @@ -34,7 +35,7 @@ When you're using the Get-UMIPGateway cmdlet, you can't enter the IP address con After this task is completed, you can view the list of properties and values for a specific UM IP gateway. Or, if the Identity parameter isn't used, the cmdlet returns a list of all UM IP gateways in the forest. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,13 +63,15 @@ This example displays all the UM IP gateways including IP gateway simulators in ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM IP gateway being viewed. This parameter is the directory object ID for the UM IP gateway. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -IncludeSimulator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IncludeSimulator switch retrieves the simulator of the UM IP gateway being viewed. You don't need to specify a value with this switch. A simulator allows a client to connect to the Mailbox server. @@ -102,7 +110,6 @@ A simulator allows a client to connect to the Mailbox server. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailbox.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-UMMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMMailbox.md index 215a6b501d..67e9225252 100644 --- a/exchange/exchange-ps/exchange/Get-UMMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ummailbox +schema: 2.0.0 +title: Get-UMMailbox --- # Get-UMMailbox @@ -49,7 +50,7 @@ Get-UMMailbox [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,6 +71,9 @@ This example displays detailed information for the UM-enabled mailbox for tonysm ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the UM-enabled mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -87,7 +91,6 @@ The Identity parameter specifies the UM-enabled mailbox that you want to view. Y Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -109,7 +115,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -127,7 +135,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -137,13 +144,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -168,7 +180,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -178,6 +189,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -189,7 +203,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -199,6 +212,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -210,7 +226,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -220,6 +235,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -230,7 +248,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -240,13 +257,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -256,6 +275,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -270,7 +292,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPin.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-UMMailboxPIN.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPin.md index c3eb5e4cc0..ad7fbff753 100644 --- a/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPin.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ummailboxpin applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMMailboxPIN -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ummailboxpin +schema: 2.0.0 +title: Get-UMMailboxPin --- # Get-UMMailboxPin @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-UMMailboxPIN cmdlet to return information from a Unified Messaging (UM)-enabled user's mailbox. +Use the Get-UMMailboxPin cmdlet to return information from a Unified Messaging (UM)-enabled user's mailbox. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -32,24 +33,24 @@ Get-UMMailboxPin [[-Identity] ] ``` ## DESCRIPTION -The Get-UMMailboxPIN cmdlet returns information calculated from the PIN data stored in encrypted form in the user's mailbox. This cmdlet also shows whether the mailbox or user access has been locked out. +The Get-UMMailboxPIN cmdlet returns information calculated from the PIN data encrypted and stored in the user's mailbox. This cmdlet also shows whether the mailbox or user access is locked out. After this task is completed, you can view information on a user's mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-UMMailboxPIN +Get-UMMailboxPin ``` This example displays the UM mailbox PIN-related properties for all UM-enabled users. ### Example 2 ```powershell -Get-UMMailboxPIN -Identity tonysmith@contoso.com +Get-UMMailboxPin -Identity tonysmith@contoso.com ``` This example displays the UM mailbox PIN-related properties for tonysmith@contoso.com. @@ -57,6 +58,9 @@ This example displays the UM mailbox PIN-related properties for tonysmith@contos ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -92,7 +98,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -129,7 +139,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -IgnoreErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreErrors switch specifies whether to ignore errors. You don't need to specify a value with this switch. When you use this switch, errors that occur are written as warnings. @@ -147,7 +159,6 @@ When you use this switch, errors that occur are written as warnings. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -167,7 +181,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPolicy.md index d3e95a0446..17e4fcbc3d 100644 --- a/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ummailboxpolicy +schema: 2.0.0 +title: Get-UMMailboxPolicy --- # Get-UMMailboxPolicy @@ -32,7 +33,7 @@ The Get-UMMailboxPolicy cmdlet retrieves the configuration properties and values After this task is completed, if the Identity parameter is supplied, the properties and values for the specified UM mailbox policy object are returned. If no parameter is specified at the command prompt, all UM mailbox policies in the Active Directory forest are returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,13 +61,15 @@ This examples displays all the UM mailbox policies associated with the UM dial p ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM mailbox policy being viewed. This is the directory object ID for the UM mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies that all UM mailbox policies associated with the UM dial plan are displayed. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UmServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMServer.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-UmServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMServer.md index 0ba48166ad..416a8f2674 100644 --- a/exchange/exchange-ps/exchange/Get-UmServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umserver applicable: Exchange Server 2010 -title: Get-UmServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umserver +schema: 2.0.0 +title: Get-UMServer --- # Get-UMServer @@ -33,7 +34,7 @@ The ExchangeVersion attribute that's returned is the minimum version of Microsof After this task is completed, you can view the parameters and values for a single Unified Messaging server or a list of all of the Unified Messaging servers in Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example returns detailed information for the Unified Messaging server named ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Unified Messaging server that you want to view. You can use any value that uniquely identifies the server. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the Unified Messaging server that you want to v Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMService.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMService.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-UMService.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMService.md index 6551e952a2..9089d7734c 100644 --- a/exchange/exchange-ps/exchange/Get-UMService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umservice applicable: Exchange Server 2013, Exchange Server 2016 -title: Get-UMService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umservice +schema: 2.0.0 +title: Get-UMService --- # Get-UMService @@ -31,7 +32,7 @@ When the cmdlet is used for a single Exchange server, it returns the Unified Mes The ExchangeVersion attribute that's returned is the minimum version of Exchange you can use to manage the returned object. This attribute isn't the same as the version of Exchange that's displayed in the Exchange admin center when you select Server Configuration. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example displays detailed information for the Microsoft Exchange Unified Me ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the Mailbox server that hosts the Unified Messaging service configuration you want to view. You can use any value that uniquely identifies the server. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the Mailbox server that hosts the Unified Messa Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedAuditLogRetentionPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UnifiedAuditLogRetentionPolicy.md index 07a961fcf8..9156191778 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedAuditLogRetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedauditlogretentionpolicy applicable: Security & Compliance -title: Get-UnifiedAuditLogRetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-unifiedauditlogretentionpolicy +schema: 2.0.0 +title: Get-UnifiedAuditLogRetentionPolicy --- # Get-UnifiedAuditLogRetentionPolicy @@ -53,6 +54,9 @@ This example lists the configurable properties for all audit log retention polic ## PARAMETERS ### -Operation + +> Applicable: Security & Compliance + The Operations parameter filters the results by the operations that are specified in the policy. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -61,7 +65,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -RecordType + +> Applicable: Security & Compliance + The RecordType parameter filters the results by the record types that are defined in the policy. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). ```yaml Type: AuditRecordType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter filters the policy results by the retention duration specified in the policy. Valid values are: - ThreeMonths @@ -100,7 +108,6 @@ Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears -Applicable: Security & Compliance Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -UserId + +> Applicable: Security & Compliance + The UserIds parameter filters the policy results by the ID of the users who are specified in the policy. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -118,7 +128,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroup.md similarity index 71% rename from exchange/exchange-ps/exchange/Get-UnifiedGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroup.md index f7d00bb7cd..a6d99d02f5 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup applicable: Exchange Online, Exchange Online Protection -title: Get-UnifiedGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-unifiedgroup +schema: 2.0.0 +title: Get-UnifiedGroup --- # Get-UnifiedGroup @@ -55,7 +56,7 @@ Get-UnifiedGroup [-Anr ] ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,6 +104,9 @@ This example returns Microsoft 365 Groups that are created when a Microsoft Team ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to view. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -118,7 +122,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to view. Type: UnifiedGroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -128,13 +131,15 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -159,7 +167,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -169,13 +176,17 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames -{{ Fill IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames Description }} + +> Applicable: Exchange Online, Exchange Online Protection + +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 @@ -185,6 +196,9 @@ Accept wildcard characters: False ``` ### -IncludeAllProperties + +> Applicable: Exchange Online, Exchange Online Protection + 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. If you don't use this switch, the values of some properties (for example, CalendarMemberReadOnly, CalendarUrl, InboxUrl, PeopleUrl, and PhotoUrl) might appear blank. @@ -193,7 +207,6 @@ If you don't use this switch, the values of some properties (for example, Calend Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,13 +216,17 @@ Accept wildcard characters: False ``` ### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames -{{ Fill IncludeBypassModerationFromSendersOrMembersWithDisplayNames Description }} + +> Applicable: Exchange Online, Exchange Online Protection + +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 @@ -219,13 +236,17 @@ Accept wildcard characters: False ``` ### -IncludeGrantSendOnBehalfToWithDisplayNames -{{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} + +> Applicable: Exchange Online, Exchange Online Protection + +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 @@ -235,13 +256,17 @@ Accept wildcard characters: False ``` ### -IncludeModeratedByWithDisplayNames -{{ Fill IncludeModeratedByWithDisplayNames Description }} + +> Applicable: Exchange Online, Exchange Online Protection + +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 @@ -251,13 +276,17 @@ Accept wildcard characters: False ``` ### -IncludeRejectMessagesFromSendersOrMembersWithDisplayNames -{{ Fill IncludeRejectMessagesFromSendersOrMembersWithDisplayNames Description }} + +> Applicable: Exchange Online, Exchange Online Protection + +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 @@ -267,6 +296,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedGroups + +> Applicable: Exchange Online, Exchange Online Protection + 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. Soft-deleted Microsoft 365 Groups are deleted groups that are still recoverable. @@ -275,7 +307,6 @@ Soft-deleted Microsoft 365 Groups are deleted groups that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -285,13 +316,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + 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 @@ -301,6 +334,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -315,7 +351,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroupLinks.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroupLinks.md index e47851e9e1..889457c6de 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroupLinks.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedgrouplinks applicable: Exchange Online, Exchange Online Protection -title: Get-UnifiedGroupLinks -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-unifiedgrouplinks +schema: 2.0.0 +title: Get-UnifiedGroupLinks --- # Get-UnifiedGroupLinks @@ -29,7 +30,7 @@ Get-UnifiedGroupLinks [-Identity] -LinkType ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example show the members of the Microsoft 365 Group named Human Resources D ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to view. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to view. Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -LinkType + +> Applicable: Exchange Online, Exchange Online Protection + The LinkType parameter filters the results by recipient roles in the Microsoft 365 Group. Valid values are: - Members: Participate in conversations, create Teams channels, collaborate on files, and edit the connected SharePoint site. @@ -76,7 +82,6 @@ The LinkType parameter filters the results by recipient roles in the Microsoft 3 Type: LinkType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + 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 diff --git a/exchange/exchange-ps/exchange/Get-User.md b/exchange/exchange-ps/ExchangePowerShell/Get-User.md similarity index 80% rename from exchange/exchange-ps/exchange/Get-User.md rename to exchange/exchange-ps/ExchangePowerShell/Get-User.md index 8e8520af67..6d70b49b80 100644 --- a/exchange/exchange-ps/exchange/Get-User.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-User.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-user -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-User -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-user +schema: 2.0.0 +title: Get-User --- # Get-User ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-User cmdlet to view existing user objects in your organization. This cmdlet returns all objects that have user accounts (for example, user mailboxes, mail users, and user accounts). @@ -30,6 +31,7 @@ Get-User [-Anr ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeDirectReportsWithDisplayNames] [-IsVIP] [-OrganizationalUnit ] [-PublicFolder] @@ -51,6 +53,7 @@ Get-User [[-Identity] ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeDirectReportsWithDisplayNames] [-IsVIP] [-OrganizationalUnit ] [-PublicFolder] @@ -65,7 +68,7 @@ Get-User [[-Identity] ] ## DESCRIPTION The Get-User cmdlet returns no mail-related properties for mailboxes or mail users. To view the mail-related properties for a user, you need to use the corresponding cmdlet based on the object type (for example, Get-Mailbox or Get-MailUser). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -100,7 +103,10 @@ This example uses the Filter parameter to retrieve information about all users t ## PARAMETERS ### -Identity -The Identity parameter the user that you want to view. You can use any value that uniquely identifies the user. For example: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + +The Identity parameter specifies the user that you want to view. You can use any value that uniquely identifies the user. For example: - Name - User principal name (UPN) @@ -112,7 +118,6 @@ The Identity parameter the user that you want to view. You can use any value tha Type: UserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -134,7 +142,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Arbitration switch is required to return arbitration mailboxes in the results. You don't need to specify a value with this switch. @@ -156,7 +166,6 @@ To return arbitration mailboxes that are used to store audit log settings or dat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuditLog switch is required to return audit log mailboxes in the results. You don't need to specify a value with this switch. @@ -178,7 +190,6 @@ To return other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +199,9 @@ Accept wildcard characters: False ``` ### -AuxAuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuxAuditLog switch is required to return auxiliary audit log mailboxes in the results. You don't need to specify a value with this switch. @@ -200,7 +214,6 @@ To return other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +223,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -220,7 +236,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,6 +245,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -238,7 +256,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,6 +265,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -263,7 +283,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -273,6 +292,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -286,7 +308,26 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDirectReportsWithDisplayNames + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is available only in the cloud-based service. + +{{ Fill IncludeDirectReportsWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet +Aliases: Required: False Position: Named @@ -296,6 +337,9 @@ Accept wildcard characters: False ``` ### -IsVIP + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The IsVIP switch filters the results by priority accounts. You don't need to specify a value with this switch. @@ -306,7 +350,6 @@ For more information about priority accounts, see [Manage and monitor priority a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -316,6 +359,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -327,7 +373,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,6 +382,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + The PublicFolder switch is required to return public folder mailboxes in the results. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -345,7 +393,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -355,6 +402,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -367,7 +417,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -377,6 +426,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified user subtype. Valid values are: - DisabledUser @@ -409,7 +461,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -419,13 +470,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -435,6 +488,9 @@ Accept wildcard characters: False ``` ### -Sortby + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -452,7 +508,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -462,6 +517,9 @@ Accept wildcard characters: False ``` ### -SupervisoryReviewPolicy + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -470,7 +528,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-UserBriefingConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-UserBriefingConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UserBriefingConfig.md index 6c04f88148..4053998bbe 100644 --- a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UserBriefingConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-userbriefingconfig applicable: Exchange Online -title: Get-UserBriefingConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-userbriefingconfig +schema: 2.0.0 +title: Get-UserBriefingConfig --- # Get-UserBriefingConfig @@ -51,13 +52,15 @@ This example returns the Briefing configuration for the user lila@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user that you want to view (for example, lila@contoso.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UserPhoto.md b/exchange/exchange-ps/ExchangePowerShell/Get-UserPhoto.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-UserPhoto.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UserPhoto.md index 5314df112d..14e09ae227 100644 --- a/exchange/exchange-ps/exchange/Get-UserPhoto.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UserPhoto.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-userphoto -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-UserPhoto -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-userphoto +schema: 2.0.0 +title: Get-UserPhoto --- # Get-UserPhoto @@ -59,7 +60,7 @@ Get-UserPhoto [[-Identity] ] ## DESCRIPTION The user photos feature allows users to associate a picture with their account. User photos are stored in the user's Active Directory account and in the root directory of the user's Exchange mailbox. The user photo feature must be set for a user before you can run the Get-UserPhoto cmdlet to view information about the user's photo. Otherwise, you get an error message saying the user photo doesn't exist for the specified users. Administrators use the Set-UserPhoto cmdlet or the Exchange admin center (EAC) to configure user photos. Users can upload, preview, and save a user photo to their account by using the Outlook on the web Options page. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,6 +81,9 @@ This example displays information about the user photo that was uploaded to Pila ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the user account. You can use any value that uniquely identifies the user account. For example: - Name @@ -97,7 +101,6 @@ The Identity parameter specifies the user account. You can use any value that un Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -119,7 +125,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +134,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -137,7 +145,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +154,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -178,7 +190,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +199,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,6 +217,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -215,7 +231,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +240,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -236,7 +254,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,13 +263,15 @@ Accept wildcard characters: False ``` ### -PhotoType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,6 +281,9 @@ Accept wildcard characters: False ``` ### -Preview + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Preview switch filters the results by preview photos. You don't need to specify a value with this switch. A preview photo is a photo that was uploaded to the user's account, but wasn't saved, for example, if a user uploads a photo in Outlook on the web Options, but doesn't save it. If you use the Preview switch after a user photo is saved, this cmdlet returns an error saying the preview photo doesn't exist. @@ -270,7 +292,6 @@ A preview photo is a photo that was uploaded to the user's account, but wasn't s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -290,7 +314,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,13 +323,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,6 +341,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -326,7 +354,6 @@ You can sort by the Id property. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md b/exchange/exchange-ps/ExchangePowerShell/Get-UserPrincipalNamesSuffix.md similarity index 82% rename from exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UserPrincipalNamesSuffix.md index b9afdf3095..6430bf259d 100644 --- a/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UserPrincipalNamesSuffix.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-userprincipalnamessuffix -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-UserPrincipalNamesSuffix -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-userprincipalnamessuffix +schema: 2.0.0 +title: Get-UserPrincipalNamesSuffix --- # Get-UserPrincipalNamesSuffix @@ -32,7 +33,7 @@ The default UPN is contained in the Canonical Name attribute on the Partitions c If you create user accounts by using Active Directory Users and Computers, every user must have a UPN. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example returns all UPN suffixes for the Active Directory forest. ## PARAMETERS ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -57,7 +61,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: ExtendedOrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-VivaInsightsSettings.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-VivaInsightsSettings.md index bbfd395ab1..3e9042e558 100644 --- a/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-VivaInsightsSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivainsightssettings applicable: Exchange Online -title: Get-VivaInsightsSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivainsightssettings +schema: 2.0.0 +title: Get-VivaInsightsSettings --- # Get-VivaInsightsSettings @@ -58,13 +59,15 @@ This example shows the configuration of Microsoft Viva Insights in Microsoft Tea ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user that you want to view. You identify the user by their User Principal Name (UPN) (for example, roy@contoso.onmicrosoft.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Feature + +> Applicable: Exchange Online + The Feature parameter filters the results by the specified Microsoft Viva Insights feature. Valid values are: - Headspace: Represents all features of Headspace. @@ -83,7 +89,6 @@ The Feature parameter filters the results by the specified Microsoft Viva Insigh Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeature.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-VivaModuleFeature.md rename to exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeature.md index b2787501f8..3cff28b979 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeature.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature applicable: Exchange Online -title: Get-VivaModuleFeature -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivamodulefeature +schema: 2.0.0 +title: Get-VivaModuleFeature --- # Get-VivaModuleFeature @@ -56,13 +56,15 @@ This example returns the details of the Reflection feature in Viva Insights. ## PARAMETERS ### -ModuleId + +> Applicable: Exchange Online + The ModuleId parameter specifies the Viva module of the features that you want to view. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -72,6 +74,9 @@ Accept wildcard characters: False ``` ### -FeatureId + +> Applicable: Exchange Online + The FeatureId parameter specifies the specific feature in the Viva module that you want to view. You can view details about all the features in a Viva module that support feature access controls by running the cmdlet without the FeatureId parameter. These details include the identifiers of all features in a Viva module that support feature access controls. @@ -80,7 +85,6 @@ You can view details about all the features in a Viva module that support featur Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Positional @@ -90,13 +94,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeatureEnablement.md similarity index 98% rename from exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md rename to exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeatureEnablement.md index 8fed8e655e..47a20bcf39 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeatureEnablement.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeatureenablement applicable: Exchange Online -title: Get-VivaModuleFeatureEnablement -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivamodulefeatureenablement +schema: 2.0.0 +title: Get-VivaModuleFeatureEnablement --- # Get-VivaModuleFeatureEnablement diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeaturePolicy.md similarity index 68% rename from exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeaturePolicy.md index 8d03457b9e..bebd8abdc5 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeaturePolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeaturepolicy applicable: Exchange Online -title: Get-VivaModuleFeaturePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivamodulefeaturepolicy +schema: 2.0.0 +title: Get-VivaModuleFeaturePolicy --- # Get-VivaModuleFeaturePolicy @@ -15,9 +15,7 @@ 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**: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available. - -Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module or category in Viva. Policies are used to restrict or grant access to the specified feature or category 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). @@ -25,26 +23,24 @@ For information about the parameter sets in the Syntax section below, see [Excha ### FeaturePolicy ``` -Get-VivaModuleFeaturePolicy -FeatureId -ModuleId - [[-PolicyId] ] +Get-VivaModuleFeaturePolicy -FeatureId -ModuleId [[-PolicyId] ] [-ResultSize ] [] ``` -### CategoryPolicy +### FeaturePolicyWithMembers ``` -Get-VivaModuleFeaturePolicy -CategoryId - [[-PolicyId] ] +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 or a category in Viva. +Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva. -Support for categories is available in version 3.5.0-Preview2 or later of the module. +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 or a category in Viva. To view a specific policy, you can include the PolicyId parameter. +The cmdlet can filter policies based on MemberIds, allowing admins to view policies specific to certain users or groups. You need to use the Connect-ExchangeOnline cmdlet to authenticate. @@ -77,34 +73,32 @@ This example returns details about a specific policy added for the Reflection fe ### Example 3 ```powershell -Get-VivaModuleFeaturePolicy -CategoryId +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -MemberIds user1@contoso.com ``` -This example returns details about all the policies added for the `` category in Viva. +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 -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b +Get-VivaModuleFeaturePolicy -ModuleId * -FeatureId * -MemberIds user1@contoso.com,group1@contoso.com ``` -This example returns details about a specific policy added for the `` category in Viva. +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 -### -CategoryId -This parameter is available in version 3.5.0-Preview2 or later of the module. +### -FeatureId -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. +> Applicable: Exchange Online -The CategoryId parameter specifies the category that you want to view the policies for. +The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. -To view details about the categories in Viva that support feature access controls, refer to the Get-VivaFeatureCategory cmdlet. The details provided by the Get-VivaFeatureCategory cmdlet include the category identifier. +To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. ```yaml Type: String -Parameter Sets: CategoryPolicy +Parameter Sets: FeaturePolicy, FeaturePolicyWithMembers Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -113,16 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FeatureId -The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. +### -ModuleId -To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. +> Applicable: Exchange Online + +The ModuleId parameter specifies the Viva module of the feature policies that you want to view. ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -131,48 +125,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ModuleId -The ModuleId parameter specifies the Viva module of the feature policies that you want to view. +### -PolicyId + +> Applicable: Exchange Online + +The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view. + +To view details about all policies for a feature in a Viva module, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module. ```yaml Type: String Parameter Sets: FeaturePolicy Aliases: -Applicable: Exchange Online -Required: True -Position: Named +Required: False +Position: Positional Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyId -The PolicyId parameter specifies the specific policy for the feature in the Viva module or the category that you want to view. +### -MemberIds + +> Applicable: Exchange Online + +The MemberIds parameter specifies the specific users or groups for which you want to view the policies for the feature in the Viva module. -To view details about all policies for a feature in a Viva module or a category, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module or a category. +You can provide up to three member IDs. Use the \* character to specify all modules or features. ```yaml -Type: String -Parameter Sets: (All) +Type: String[] +Parameter Sets: FeaturePolicyWithMembers Aliases: -Applicable: Exchange Online Required: False -Position: Positional +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/ExchangePowerShell/Get-VivaOrgInsightsDelegatedRole.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md rename to exchange/exchange-ps/ExchangePowerShell/Get-VivaOrgInsightsDelegatedRole.md index dd36f02024..b4d9ec3c12 100644 --- a/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-VivaOrgInsightsDelegatedRole.md @@ -1,18 +1,18 @@ --- -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 +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivaorginsightsdelegatedrole +schema: 2.0.0 +title: Get-VivaOrgInsightsDelegatedRole --- # Get-VivaOrgInsightsDelegatedRole ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module v3.7.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). +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. @@ -49,6 +49,9 @@ This example filters the results by the specified delegator. ## PARAMETERS ### -Delegator + +> Applicable: Exchange Online + 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. @@ -57,7 +60,6 @@ A valid value for this parameter is the ObjectID value of the delegator account. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -67,13 +69,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-WebServicesVirtualDirectory.md similarity index 84% rename from exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-WebServicesVirtualDirectory.md index 1345ae232f..9d9c09075b 100644 --- a/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-WebServicesVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-webservicesvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-WebServicesVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-webservicesvirtualdirectory +schema: 2.0.0 +title: Get-WebServicesVirtualDirectory --- # Get-WebServicesVirtualDirectory @@ -43,7 +44,7 @@ The Get-WebServicesVirtualDirectory cmdlet can be run on a local server or run r The Get-WebServicesVirtualDirectory cmdlet can be run on any server that has the Exchange administration tools installed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,6 +72,9 @@ This example returns a summary list of all virtual directories in the client acc ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the EWS virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -85,7 +89,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -108,7 +114,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -126,7 +134,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +143,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -162,7 +174,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-X400AuthoritativeDomain.md similarity index 78% rename from exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-X400AuthoritativeDomain.md index 3be7ea0728..c236807d50 100644 --- a/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-X400AuthoritativeDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-x400authoritativedomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-X400AuthoritativeDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-x400authoritativedomain +schema: 2.0.0 +title: Get-X400AuthoritativeDomain --- # Get-X400AuthoritativeDomain @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-X400AuthoritativeDomain cmdlet to view the configuration information for the X.400 authoritative domains configured in your organization. For more information about how to configure an X.400 authoritative domain, see [Set-X400AuthoritativeDomain](https://learn.microsoft.com/powershell/module/exchange/set-x400authoritativedomain). +Use the Get-X400AuthoritativeDomain cmdlet to view the configuration information for the X.400 authoritative domains configured in your organization. For more information about how to configure an X.400 authoritative domain, see [Set-X400AuthoritativeDomain](https://learn.microsoft.com/powershell/module/exchangepowershell/set-x400authoritativedomain). 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,7 +28,7 @@ Get-X400AuthoritativeDomain [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example displays detailed information about the X.400 authoritative domain ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies a string value for the X.400 authoritative domain. Enter either the GUID or the name of the remote domain. ```yaml Type: X400AuthoritativeDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -65,7 +71,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/ExchangePowerShell/Get-eDiscoveryCaseAdmin.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md rename to exchange/exchange-ps/ExchangePowerShell/Get-eDiscoveryCaseAdmin.md index 2af5f1721a..b5742b5617 100644 --- a/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-eDiscoveryCaseAdmin.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ediscoverycaseadmin applicable: Security & Compliance -title: Get-eDiscoveryCaseAdmin -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ediscoverycaseadmin +schema: 2.0.0 +title: Get-eDiscoveryCaseAdmin --- # Get-eDiscoveryCaseAdmin @@ -43,13 +44,15 @@ This example returns a summary list of all eDiscovery Administrators. ## PARAMETERS ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Security & Compliance + 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: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md b/exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyCollection.md similarity index 79% rename from exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyCollection.md index bdec677fd8..bbfb2641f2 100644 --- a/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyCollection.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-dlppolicycollection -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Import-DlpPolicyCollection -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-dlppolicycollection +schema: 2.0.0 +title: Import-DlpPolicyCollection --- # Import-DlpPolicyCollection ## SYNOPSIS -**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). +**Note**: This cmdlet is 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). This cmdlet is functional only in on-premises Exchange. @@ -36,7 +37,7 @@ The Import-DlpPolicyCollection cmdlet imports all the settings of the DLP polici Importing a DLP policy collection from an XML file removes or overwrites all pre-existing DLP policies that were defined in your organization. Make sure that you have a backup of your current DLP policy collection before you import and overwrite your current DLP policies. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example imports the DLP policy collection in the file C:\\My Documents\\DLP ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the DLP policy you want to import. The DLP policy must exist in the XML file you specify with the FileData parameter. ```yaml Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FileData parameter specifies the DLP policy collection file you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -74,7 +80,6 @@ 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, Exchange Online Required: True Position: 1 @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -93,7 +101,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -127,7 +139,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -137,13 +148,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyTemplate.md similarity index 82% rename from exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyTemplate.md index 41752441f8..1399990e4d 100644 --- a/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-dlppolicytemplate -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Import-DlpPolicyTemplate -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-dlppolicytemplate +schema: 2.0.0 +title: Import-DlpPolicyTemplate --- # Import-DlpPolicyTemplate @@ -28,7 +29,7 @@ Import-DlpPolicyTemplate [-FileData] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example imports the DLP policy template file C:\\My Documents\\External DLP ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FileData parameter specifies the DLP policy template file you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -50,7 +54,6 @@ 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 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -69,7 +75,6 @@ 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 Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Import-ExchangeCertificate.md similarity index 87% rename from exchange/exchange-ps/exchange/Import-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Import-ExchangeCertificate.md index f9175f98ff..69bbc1e97c 100644 --- a/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-exchangecertificate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Import-ExchangeCertificate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-exchangecertificate +schema: 2.0.0 +title: Import-ExchangeCertificate --- # Import-ExchangeCertificate @@ -71,7 +72,7 @@ There are many factors to consider when you configure certificates for Transport Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). For more information, see [Exchange Server TLS configuration best practices](https://learn.microsoft.com/Exchange/exchange-tls-configuration). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -101,6 +102,9 @@ This example imports a chain of certificates from the PKCS #7 file C:\\Certifica ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FileData parameter specifies the contents of the certificate file that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -115,7 +119,6 @@ If the value contains spaces, enclose the value in quotation marks ("). Type: Byte[] Parameter Sets: FileData Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -125,6 +128,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Exchange Server 2013 + **Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To import a certificate file without using the FileName parameter, use the FileData parameter. This parameter is available only in Exchange 2013. @@ -139,7 +145,6 @@ If the value contains spaces, enclose the value in quotation marks ("). Type: String Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2013 Required: True Position: Named @@ -149,13 +154,15 @@ Accept wildcard characters: False ``` ### -Instance -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: String[] Parameter Sets: FileName Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -165,6 +172,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -174,7 +184,6 @@ 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 Required: False Position: Named @@ -184,6 +193,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -192,7 +204,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -FriendlyName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FriendlyName parameter specifies a friendly name for the certificate. The value must be less than 64 characters. The friendly name value is descriptive text and doesn't affect the functionality of the certificate. @@ -210,7 +224,6 @@ The friendly name value is descriptive text and doesn't affect the functionality Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,6 +233,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Password parameter specifies the password that's required to import the certificate. You can use the following methods as a value for this parameter: @@ -232,7 +248,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -242,16 +257,18 @@ Accept wildcard characters: False ``` ### -PrivateKeyExportable + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PrivateKeyExportable parameter specifies whether the certificate has an exportable private key and controls whether you can export the certificate from this server. Valid values are: - $true: The private key is exportable, so you can export the certificate from this server. -- $false: The private key isn't exportable, so you can't export the certificate from this server. This is the default value. +- $false: The private key isn't exportable, so you can't export the certificate from this server. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,6 +278,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -274,7 +294,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,13 +303,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-FilePlanProperty.md b/exchange/exchange-ps/ExchangePowerShell/Import-FilePlanProperty.md similarity index 92% rename from exchange/exchange-ps/exchange/Import-FilePlanProperty.md rename to exchange/exchange-ps/ExchangePowerShell/Import-FilePlanProperty.md index 0a64f7f630..9065fc4a6c 100644 --- a/exchange/exchange-ps/exchange/Import-FilePlanProperty.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-FilePlanProperty.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-fileplanproperty applicable: Security & Compliance -title: Import-FilePlanProperty +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-fileplanproperty schema: 2.0.0 +title: Import-FilePlanProperty --- # Import-FilePlanProperty @@ -42,13 +44,15 @@ This example imports the specified CSV file. ## PARAMETERS ### -RawCsv + +> Applicable: Security & Compliance + The RawCsv parameter specifies the CSV file to import. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -58,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -67,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -77,13 +83,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -93,6 +101,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -101,7 +112,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -111,13 +121,15 @@ Accept wildcard characters: False ``` ### -ValidateOnly + +> Applicable: Security & Compliance + The ValidateOnly switch validates the CSV file without importing. 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 @@ -127,13 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Import-JournalRuleCollection.md similarity index 81% rename from exchange/exchange-ps/exchange/Import-JournalRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Import-JournalRuleCollection.md index 535e6e67f0..103cbbca56 100644 --- a/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-JournalRuleCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-journalrulecollection -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Import-JournalRuleCollection -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-journalrulecollection +schema: 2.0.0 +title: Import-JournalRuleCollection --- # Import-JournalRuleCollection @@ -33,9 +34,9 @@ The Import-JournalRuleCollection cmdlet imports a journal rule collection you pr Importing a journal rule collection from an XML file removes or overwrites all pre-existing journal rules in your organization. Make sure that you have a backup of your current journal rule collection before you import and overwrite your current journal rules. -For more information about how to export a journal rule collection to an XML file, see [Export-JournalRuleCollection](https://learn.microsoft.com/powershell/module/exchange/export-journalrulecollection). +For more information about how to export a journal rule collection to an XML file, see [Export-JournalRuleCollection](https://learn.microsoft.com/powershell/module/exchangepowershell/export-journalrulecollection). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example imports journal rules from the XML file named ExportedJournalRules. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of a journal rule to be imported. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FileData parameter specifies the XML file that contains the exported journal rule collection from the Export-JournalRuleCollection cmdlet. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -73,7 +79,6 @@ 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 Required: True Position: 1 @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -92,7 +100,6 @@ 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 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md b/exchange/exchange-ps/ExchangePowerShell/Import-RecipientDataProperty.md similarity index 80% rename from exchange/exchange-ps/exchange/Import-RecipientDataProperty.md rename to exchange/exchange-ps/ExchangePowerShell/Import-RecipientDataProperty.md index 3c8ed062fd..abff75dbab 100644 --- a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-RecipientDataProperty.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-recipientdataproperty -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Import-RecipientDataProperty -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-recipientdataproperty +schema: 2.0.0 +title: Import-RecipientDataProperty --- # Import-RecipientDataProperty @@ -41,7 +42,7 @@ Import-RecipientDataProperty [-Identity] -FileDa ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example imports the picture file for Ayla Kol. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox or contact that you're adding the picture or spoken name file to. You can use any value that uniquely identifies the user. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the mailbox or contact that you're adding the p Type: MailboxUserContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FileData parameter specifies the picture or spoken name file that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -95,7 +101,6 @@ To import a spoken name, use the SpokenName switch. A valid spoken name file is Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -114,7 +122,6 @@ 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 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -132,7 +142,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -Picture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Picture switch specifies that you're importing the user's picture file. You don't need to specify a value with this switch. You can't use this switch with the SpokenName switch. @@ -150,7 +162,6 @@ You can't use this switch with the SpokenName switch. Type: SwitchParameter Parameter Sets: ImportPicture Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -SpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SpokenName switch specifies that you're importing the user's spoken name file. You don't need to specify a value with this switch. You can't use this switch with the Picture switch. @@ -168,7 +182,6 @@ You can't use this switch with the Picture switch. Type: SwitchParameter Parameter Sets: ImportSpokenName Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Import-TransportRuleCollection.md similarity index 80% rename from exchange/exchange-ps/exchange/Import-TransportRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Import-TransportRuleCollection.md index 30fae12016..8da3bcf345 100644 --- a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-TransportRuleCollection.md @@ -1,12 +1,13 @@ --- -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, Exchange Online, Exchange Online Protection -title: Import-TransportRuleCollection -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-transportrulecollection +schema: 2.0.0 +title: Import-TransportRuleCollection --- # Import-TransportRuleCollection @@ -34,9 +35,9 @@ Import-TransportRuleCollection [[-Identity] ] [-FileData] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in Exchange Server 2010. The Identity parameter specifies the transport rule that you want to import. You can use any value that uniquely identifies the rule. For example: @@ -62,7 +66,6 @@ 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, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The FileData parameter specifies the XML file that contains the exported transport rule collection from the Export-TransportRuleCollection cmdlet. 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`). @@ -80,7 +86,6 @@ 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, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -99,7 +107,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -119,7 +129,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -137,7 +149,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 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/Import-UMPrompt.md b/exchange/exchange-ps/ExchangePowerShell/Import-UMPrompt.md similarity index 86% rename from exchange/exchange-ps/exchange/Import-UMPrompt.md rename to exchange/exchange-ps/ExchangePowerShell/Import-UMPrompt.md index 5f34ab73ab..69b9d8c936 100644 --- a/exchange/exchange-ps/exchange/Import-UMPrompt.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-UMPrompt.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-umprompt applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Import-UMPrompt -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-umprompt +schema: 2.0.0 +title: Import-UMPrompt --- # Import-UMPrompt @@ -61,7 +62,7 @@ The Import-UMPrompt cmdlet imports custom greeting audio files into UM dial plan After this task is completed, the custom audio file can be used by a UM dial plan or auto attendant. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -89,6 +90,9 @@ This example imports the welcome greeting file AfterHoursWelcomeGreeting.wav fro ## PARAMETERS ### -PromptFileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PromptFileData parameter specifies the byte array of the custom prompt. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -97,7 +101,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: UploadDialPlanPrompts, UploadAutoAttendantPrompts Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -PromptFileName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PromptFileName parameter specifies the name of the custom prompt. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -123,13 +128,15 @@ Accept wildcard characters: False ``` ### -PromptFileStream -The PromptFileStream parameter specifies whether the audio file will be uploaded or imported as an audio stream and not a byte array. The default setting is for the audio file to imported as a byte array. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The PromptFileStream parameter specifies whether the audio file is uploaded or imported as an audio stream and not a byte array. The default setting is for the audio file to imported as a byte array. ```yaml Type: Stream Parameter Sets: UploadAutoAttendantPromptsStream, UploadDialPlanPromptsStream Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -139,13 +146,15 @@ Accept wildcard characters: False ``` ### -UMAutoAttendant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMAutoAttendant parameter specifies the UM auto attendant ID. This parameter specifies the directory object identifier for the UM auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: UploadAutoAttendantPrompts, UploadAutoAttendantPromptsStream Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -155,13 +164,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan. ```yaml Type: UMDialPlanIdParameter Parameter Sets: UploadDialPlanPrompts, UploadDialPlanPromptsStream Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -171,6 +182,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -180,7 +194,6 @@ 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 Required: False Position: Named @@ -190,13 +203,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Install-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Install-TransportAgent.md similarity index 79% rename from exchange/exchange-ps/exchange/Install-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Install-TransportAgent.md index 9e51b2aaa8..cabaefff7e 100644 --- a/exchange/exchange-ps/exchange/Install-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Install-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/install-transportagent -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Install-TransportAgent -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/install-transportagent +schema: 2.0.0 +title: Install-TransportAgent --- # Install-TransportAgent @@ -30,9 +31,9 @@ Install-TransportAgent [-Name] -AssemblyPath -TransportAgentFa ``` ## DESCRIPTION -Transport agents have full access to all email messages that they encounter. Exchange puts no restrictions on a transport agent's behavior. Transport agents that are unstable or contain security flaws may affect the stability and security of Exchange. Therefore, you need to only install transport agents that you fully trust and that have been fully tested. +Transport agents have full access to all email messages that they encounter. Exchange puts no restrictions on a transport agent's behavior. Transport agents that are unstable or contain security flaws might affect the stability and security of Exchange. Therefore, you need to only install transport agents that you fully trust and that have been fully tested. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +47,15 @@ This example shows how a fictitious application named Test App is installed in t ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the display name of the transport agent to be installed. The length of the name can't exceed 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -AssemblyPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AssemblyPath parameter specifies the location of the transport agent Microsoft.NET assembly. Universal Naming Convention (UNC) file paths can't be used. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -TransportAgentFactory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportAgentFactory parameter specifies the Microsoft.NET class type of the transport agent factory. The developer of the transport agent being installed provides the transport agent factory and related information. For more information, see the documentation provided by the developer of the transport agent. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -94,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -103,7 +113,6 @@ 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 Required: False Position: Named @@ -113,6 +122,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -121,7 +133,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +142,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -143,7 +157,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md b/exchange/exchange-ps/ExchangePowerShell/Install-UnifiedCompliancePrerequisite.md similarity index 87% rename from exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md rename to exchange/exchange-ps/ExchangePowerShell/Install-UnifiedCompliancePrerequisite.md index a2d41f3043..81065e9097 100644 --- a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md +++ b/exchange/exchange-ps/ExchangePowerShell/Install-UnifiedCompliancePrerequisite.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/install-unifiedcomplianceprerequisite applicable: Security & Compliance -title: Install-UnifiedCompliancePrerequisite -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/install-unifiedcomplianceprerequisite +schema: 2.0.0 +title: Install-UnifiedCompliancePrerequisite --- # Install-UnifiedCompliancePrerequisite @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Install-UnifiedCompliancePrerequisite cmdlet to view, create, or configure the Compliance Policy Center in Microsoft SharePoint Online. The Compliance Policy Center is a site collection that's used by the Microsoft Purview compliance portal to store preservation policies that act on content in SharePoint Online sites. +Use the Install-UnifiedCompliancePrerequisite cmdlet to view, create, or configure the Compliance Policy Center in Microsoft SharePoint. The Compliance Policy Center is a site collection that's used by the Microsoft Purview compliance portal to store preservation policies that act on content in SharePoint sites. Typically, you don't need to run this cmdlet. You use this cmdlet for troubleshooting and diagnostics. @@ -52,7 +53,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned Install-UnifiedCompliancePrerequisite ``` -This example creates the Compliance Policy Center in SharePoint Online. If it has already been created, the command displays the current configuration information. +This example creates the Compliance Policy Center in SharePoint. If it has already been created, the command displays the current configuration information. ### Example 2 ```powershell @@ -71,6 +72,9 @@ This example recreates the Compliance Policy Center, even if the site has alread ## PARAMETERS ### -ForceInitialize + +> Applicable: Security & Compliance + The ForceInitialize switch recreates the Compliance Policy Center, even if it has already been created. You don't specify a value with this switch. You can't use this switch with the LoadOnly switch. @@ -79,7 +83,6 @@ You can't use this switch with the LoadOnly switch. Type: SwitchParameter Parameter Sets: Initialize Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -LoadOnly + +> Applicable: Security & Compliance + The LoadOnly switch loads the current settings of the Compliance Policy Center. You don't specify a value with this switch. You can't use this switch with the ForceInitialize switch. @@ -97,7 +103,6 @@ You can't use this switch with the ForceInitialize switch. Type: SwitchParameter Parameter Sets: LoadOnly Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -PolicyCenterSiteOwner + +> Applicable: Security & Compliance + The PolicyCenterSiteOwner parameter specifies the email address of the owner of the Compliance Policy Center. You can use this parameter by itself or with the ForceInitialize switch. ```yaml Type: SmtpAddress Parameter Sets: Initialize Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md b/exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSearchActionStep.md similarity index 78% rename from exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md rename to exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSearchActionStep.md index d208ed10b8..e32f56a522 100644 --- a/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md +++ b/exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSearchActionStep.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/invoke-compliancesearchactionstep -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance -title: Invoke-ComplianceSearchActionStep -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/invoke-compliancesearchactionstep +schema: 2.0.0 +title: Invoke-ComplianceSearchActionStep --- # Invoke-ComplianceSearchActionStep ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. This cmdlet is reserved for internal Microsoft use. @@ -40,13 +41,15 @@ This cmdlet is reserved for internal Microsoft use. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + This cmdlet is reserved for internal Microsoft use. ```yaml Type: ComplianceSearchActionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: 1 @@ -56,13 +59,15 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + This cmdlet is reserved for internal Microsoft use. ```yaml Type: PSObject Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: True Position: Named @@ -72,13 +77,15 @@ Accept wildcard characters: False ``` ### -Step + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + This cmdlet is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md b/exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSecurityFilterAction.md similarity index 94% rename from exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md rename to exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSecurityFilterAction.md index 8dfa0fe098..43023c90bc 100644 --- a/exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSecurityFilterAction.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/invoke-compliancesecurityfilteraction +schema: 2.0.0 +title: Invoke-ComplianceSecurityFilterAction --- # Invoke-ComplianceSecurityFilterAction @@ -51,7 +52,7 @@ This example returns the status of a OneDrive site to indicate it's associated t ### Example 2 ```powershell -PS C:\> Invoke-ComplianceSecurityFi1terAction Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "nina@contoso.onmicrosoft.com" +PS C:\> Invoke-ComplianceSecurityFi1terAction -Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "nina@contoso.onmicrosoft.com" SiteUrlOrEmailAddress : nina@contoso.onmicrosoft.com BoundaryType : UserMailbox @@ -108,6 +109,9 @@ This example sets the boundary of the specified OneDrive site to the specified C ## PARAMETERS ### -Action + +> Applicable: Security & Compliance + The Action parameter specifies the action for the command. Valid values are: - GetStatus @@ -117,7 +121,6 @@ The Action parameter specifies the action for the command. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -127,6 +130,9 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Security & Compliance + The EmailAddress parameter specifies the the affected user mailbox. You can use the following values to uniquely identify the mailbox: - Name @@ -140,7 +146,6 @@ If the value contains spaces, enclose the value in quotation marks. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 2 @@ -150,6 +155,9 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: Security & Compliance + 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 @@ -160,7 +168,6 @@ Use the PropertyValue parameter to set the compliance boundary. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 3 @@ -170,13 +177,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: Security & Compliance + 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 @@ -186,13 +195,15 @@ Accept wildcard characters: False ``` ### -SiteUrl + +> Applicable: Security & Compliance + 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 @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -211,7 +225,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -221,13 +234,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md b/exchange/exchange-ps/ExchangePowerShell/Invoke-HoldRemovalAction.md similarity index 93% rename from exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md rename to exchange/exchange-ps/ExchangePowerShell/Invoke-HoldRemovalAction.md index b8dd5956b3..ebf40db69c 100644 --- a/exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Invoke-HoldRemovalAction.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/invoke-holdremovalaction applicable: Security & Compliance -title: Invoke-HoldRemovalAction -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/invoke-holdremovalaction +schema: 2.0.0 +title: Invoke-HoldRemovalAction --- # Invoke-HoldRemovalAction @@ -60,6 +61,9 @@ This example displays all hold removals that have been done using this cmdlet. ## PARAMETERS ### -Action + +> Applicable: Security & Compliance + The Action parameter specifies the mode that the cmdlet operates in. Valid values are: - GetHoldRemovals: Shows all hold removals that were done using this cmdlet. @@ -70,7 +74,6 @@ The Action parameter specifies the mode that the cmdlet operates in. Valid value Type: HoldRemovalActionType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -89,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the email address of the mailbox that contains the holds to view or remove. This parameter is required when you use the value GetHolds or RemoveHold for the Action parameter. @@ -107,7 +115,6 @@ This parameter is required when you use the value GetHolds or RemoveHold for the Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to force remove the hold even when the policy is active. Instead, you should remove the hold from the case hold policy. @@ -125,7 +135,6 @@ You can use this switch to force remove the hold even when the policy is active. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -HoldId + +> Applicable: Security & Compliance + The HoldId parameter specifies the hold that you want to view or remove. To find valid values for this parameter, use this cmdlet with the Action parameter value GetHolds and look for the HoldId property in the output. @@ -143,7 +155,6 @@ To find valid values for this parameter, use this cmdlet with the Action paramet Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -153,7 +164,10 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the URL of the SharePoint Online site that contains the holds to view or remove. + +> Applicable: Security & Compliance + +The SharePointLocation parameter specifies the URL of the SharePoint site that contains the holds to view or remove. This parameter is required when you use the value GetHolds or RemoveHold for the Action parameter. @@ -161,7 +175,6 @@ This parameter is required when you use the value GetHolds or RemoveHold for the Type: String Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md b/exchange/exchange-ps/ExchangePowerShell/Invoke-MonitoringProbe.md similarity index 71% rename from exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md rename to exchange/exchange-ps/ExchangePowerShell/Invoke-MonitoringProbe.md index 858171d8c8..62251f7198 100644 --- a/exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md +++ b/exchange/exchange-ps/ExchangePowerShell/Invoke-MonitoringProbe.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/invoke-monitoringprobe -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Invoke-MonitoringProbe -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/invoke-monitoringprobe +schema: 2.0.0 +title: Invoke-MonitoringProbe --- # Invoke-MonitoringProbe @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Invoke-MonitoringProbe cmdlet to run a Managed Availability probe on a selected server. -This cmdlet cannot be used to run every Managed Availability probe. Only some probes (mainly the deep test probes) can be run manually using this cmdlet. Probes that cannot be run with this cmdlet will generate an error message when Invoke-MonitoringProbe is used to run them. +This cmdlet can't be used to run every Managed Availability probe. Only some probes (mainly the deep test probes) can be run manually using this cmdlet. Probes that can't be run with this cmdlet return error messages when you use Invoke-MonitoringProbe to run them. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -37,7 +38,7 @@ Invoke-MonitoringProbe [-Identity] -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,13 +52,15 @@ This example creates an Exchange ActiveSync monitoring probe on the EX1 server. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the monitoring probe to run. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -80,7 +86,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Account -The Account parameter specifies the identity of the mailbox or user account that will run the monitoring probe. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Account parameter specifies the identity of the mailbox or user account that's used to run the monitoring probe. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -Endpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Endpoint parameter specifies the name of the monitoring probe endpoint to connect to, for example, contoso.mail.com. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -ItemTargetExtension -The ItemTargetExtension parameter specifies cmdlet extension data that you can pass to the monitoring probe. The probe that runs on the server may require specific data for its execution. This data is presented to the probe on execution in an XML format. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ItemTargetExtension parameter specifies cmdlet extension data that you can pass to the monitoring probe. The probe that runs on the server might require specific data for its execution. This data is presented to the probe on execution in an XML format. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -Password -The Password parameter specifies the password of the mailbox or user account that will run the monitoring probe. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Password parameter specifies the password of the mailbox or user account that's used to run the monitoring probe. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -PropertyOverride + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PropertyOverride parameter specifies a property that you want to override, for example, to set the time-out value to be extended beyond the default value. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,13 +185,15 @@ Accept wildcard characters: False ``` ### -SecondaryAccount -The SecondaryAccount parameter specifies the identity of the delegate mailbox or user account that will run the monitoring probe. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The SecondaryAccount parameter specifies the identity of the delegate mailbox or user account that's used to run the monitoring probe. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +203,15 @@ Accept wildcard characters: False ``` ### -SecondaryEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SecondaryEndpoint parameter specifies the name of the secondary monitoring probe endpoint to connect to, for example, contoso.mail.fabrikam.com. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,13 +221,15 @@ Accept wildcard characters: False ``` ### -SecondaryPassword -The SecondaryPassword parameter specifies the password of the delegate mailbox or user account that will run the monitoring probe. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The SecondaryPassword parameter specifies the password of the delegate mailbox or user account that's used to run the monitoring probe. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -218,13 +239,15 @@ Accept wildcard characters: False ``` ### -TimeOutSeconds + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TimeOutSeconds parameter specifies the monitoring operation time-out period. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Mount-Database.md b/exchange/exchange-ps/ExchangePowerShell/Mount-Database.md similarity index 80% rename from exchange/exchange-ps/exchange/Mount-Database.md rename to exchange/exchange-ps/ExchangePowerShell/Mount-Database.md index 8d6dc5909a..ab7bc9a6e9 100644 --- a/exchange/exchange-ps/exchange/Mount-Database.md +++ b/exchange/exchange-ps/ExchangePowerShell/Mount-Database.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/mount-database -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Mount-Database -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/mount-database +schema: 2.0.0 +title: Mount-Database --- # Mount-Database @@ -32,7 +33,7 @@ Mount-Database [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example mounts the database MyDatabase. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies mailbox database that you want to mount. You can use any value that uniquely identifies the database. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies mailbox database that you want to mount. You ca Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -AcceptDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AcceptDataLoss switch specifies that you accept the data loss caused by missing committed transaction log files without asking for confirmation. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -91,7 +99,6 @@ 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 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +126,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to mount an empty database, or to override any errors or warnings that are encountered during the database mount. @@ -125,7 +137,6 @@ Use this switch to mount an empty database, or to override any errors or warning Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -NewCapacity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NewCapacity switch specifies that you want to trigger the forced creation of a database only if all copies of the database don't have an .edb file. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,13 +164,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Move-ActiveMailboxDatabase.md similarity index 76% rename from exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Move-ActiveMailboxDatabase.md index c59b2bf565..f5020e52c7 100644 --- a/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Move-ActiveMailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/move-activemailboxdatabase -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-ActiveMailboxDatabase -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/move-activemailboxdatabase +schema: 2.0.0 +title: Move-ActiveMailboxDatabase --- # Move-ActiveMailboxDatabase @@ -99,7 +100,7 @@ Move-ActiveMailboxDatabase [-Identity] [-ActivateOnServer] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -129,11 +130,14 @@ This example performs a switchover of the database DB3 to the Mailbox server MBX Move-ActiveMailboxDatabase -Server MBX1 ``` -This example performs a server switchover for the Mailbox server MBX1. All active mailbox database copies on MBX1 will be activated on one or more other Mailbox servers with healthy copies of the active databases on MBX1. +This example performs a server switchover for the Mailbox server MBX1. All active mailbox database copies on MBX1 are activated on one or more other Mailbox servers with healthy copies of the active databases on MBX1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox database that you want to activate. You can use any value that uniquely identifies the database. For example: - Name @@ -146,7 +150,6 @@ You can't use this parameter with the Server parameter Type: DatabaseIdParameter Parameter Sets: Identity, SkipAllChecks Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -156,6 +159,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the server that you want to move all active mailbox databases from. You can use any value that uniquely identifies the server. For example: - Name @@ -169,7 +175,6 @@ You can't use this parameter with the Identity parameter Type: MailboxServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -179,6 +184,9 @@ Accept wildcard characters: False ``` ### -ActivatePreferredOnServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActivatePreferredOnServer parameter specifies the Mailbox server where you want to activate all mailbox databases that have copies with an ActivationPreference value of 1. You can use any value that uniquely identifies the server. For example: - Name @@ -192,7 +200,6 @@ You can use this parameter as part of ending maintenance mode on a Mailbox serve Type: MailboxServerIdParameter Parameter Sets: ActivatePreferred Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -202,13 +209,15 @@ Accept wildcard characters: False ``` ### -ActivateOnServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActivateOnServer parameter specifies the name of the Mailbox server on which the mailbox database copy should be activated. ```yaml Type: MailboxServerIdParameter Parameter Sets: Identity, Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 2 @@ -218,6 +227,9 @@ Accept wildcard characters: False ``` ### -SkipAllChecks + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipAllChecks switch specifies whether to skip all checks. You don't need to specify a value with this switch. This switch is equivalent to specifying all of the individual skip parameters that are available on this cmdlet. @@ -228,7 +240,6 @@ You can only use this switch with the ActivateOnServer parameter. Type: SwitchParameter Parameter Sets: SkipAllChecks Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -238,6 +249,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -247,7 +261,6 @@ 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 Required: False Position: Named @@ -257,13 +270,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,19 +288,21 @@ Accept wildcard characters: False ``` ### -MountDialOverride -The MountDialOverride parameter is used to override the auto database mount dial (AutoDatabaseMountDial) setting for the target server and specify an alternate setting. The following are possible values: -- None: When using this value, the currently configured auto database mount dial setting on the target server will be used. -- Lossless: This is the default value. When using this value, the database doesn't automatically mount until all log files that were generated on the original active copy have been copied to the passive copy. -- GoodAvailability: If you specify this value, the database automatically mounts immediately after a failover if the copy queue length is less than or equal to 6. If the copy queue length is greater than 6, the database doesn't automatically mount. When the copy queue length is less than or equal to 6, Microsoft Exchange attempts to replicate the remaining logs to the passive copy and then mounts the database. -- BestEffort: If you specify this value, the database automatically mounts regardless of the size of the copy queue length. Because the database will mount with any amount of log loss, using this value could result in a large amount of data loss. -- BestAvailability: If you specify this value, the database automatically mounts immediately after a failover if the copy queue length is less than or equal to 12. The copy queue length is the number of logs recognized by the passive copy that needs to be replicated. If the copy queue length is more than 12, the database doesn't automatically mount. When the copy queue length is less than or equal to 12, Exchange attempts to replicate the remaining logs to the passive copy and then mounts the database. +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The MountDialOverride parameter is used to override the auto database mount dial (AutoDatabaseMountDial) setting for the target server and specify an alternate setting. Valid value are: + +- None: The currently configured auto database mount dial setting on the target server is used. +- Lossless: This value is the default. The database doesn't automatically mount until all log files that were generated on the original active copy have been copied to the passive copy. +- GoodAvailability: The database automatically mounts immediately after a failover if the copy queue length is less than or equal to 6. If the copy queue length is greater than 6, the database doesn't automatically mount. When the copy queue length is less than or equal to 6, Microsoft Exchange attempts to replicate the remaining logs to the passive copy and then mounts the database. +- BestEffort: The database automatically mounts regardless of the size of the copy queue length. Because the database mounts with any amount of log loss, using this value could result in a large amount of data loss. +- BestAvailability: The database automatically mounts immediately after a failover if the copy queue length is less than or equal to 12. The copy queue length is the number of logs recognized by the passive copy that needs to be replicated. If the copy queue length is more than 12, the database doesn't automatically mount. When the copy queue length is less than or equal to 12, Exchange attempts to replicate the remaining logs to the passive copy and then mounts the database. ```yaml Type: DatabaseMountDialOverride Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -295,13 +312,15 @@ Accept wildcard characters: False ``` ### -MoveAllDatabasesOrNone + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MoveAllDatabasesOrNone switch specifies whether to prevent any databases from moving if a single active database on the server can't be moved. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -311,13 +330,15 @@ Accept wildcard characters: False ``` ### -MoveComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MoveComment parameter specifies an optional administrative reason for the move operation. The comment is recorded in the Event log. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -327,6 +348,9 @@ Accept wildcard characters: False ``` ### -SkipActiveCopyChecks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipActiveCopyChecks switch specifies whether to skip checking the current active copy to see if it's currently a seeding source for any passive databases. You don't need to specify a value with this switch. **Note**: When you use this switch, you can move a database that's currently a seeding source, which cancels the seed operation. @@ -335,7 +359,6 @@ The SkipActiveCopyChecks switch specifies whether to skip checking the current a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -345,15 +368,17 @@ Accept wildcard characters: False ``` ### -SkipClientExperienceChecks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipClientExperienceChecks switch specifies whether to skip the search catalog (content index) state check to see if the search catalog is healthy and up to date. You don't need to specify a value with this switch. -If the search catalog for the database copy you're activating is in an unhealthy or unusable state and you use this parameter to skip the search catalog health check and activate the database copy, you will need to either re-crawl or reseed the search catalog. +If the search catalog for the database copy you're activating is in an unhealthy or unusable state and you use this parameter to skip the search catalog health check and activate the database copy, you need to either re-crawl or reseed the search catalog. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -363,13 +388,15 @@ Accept wildcard characters: False ``` ### -SkipCpuChecks + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipCpuChecks switch specifies whether to skip the high CPU utilization checks. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -379,6 +406,9 @@ Accept wildcard characters: False ``` ### -SkipHealthChecks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipHealthChecks switch specifies whether to bypass passive copy health checks. You don't need to specify a value with this switch. When you use this switch, you can move the active copy to a database copy that's in the Failed state. You should only use this switch if the initial attempt to move the active database has failed. This is because the SkipHealthChecks switch performs additional validation to ensure that the log files are consistent, which can take a considerable amount of time. @@ -387,7 +417,6 @@ When you use this switch, you can move the active copy to a database copy that's Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -397,13 +426,15 @@ Accept wildcard characters: False ``` ### -SkipLagChecks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipLagChecks switch specifies whether to allow a copy to be activated that has replay and copy queues outside of the configured criteria. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -413,15 +444,17 @@ Accept wildcard characters: False ``` ### -SkipMaximumActiveDatabasesChecks + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipMaximumActiveDatabasesChecks switch specifies whether to skip checking the value of MaximumPreferredActiveDatabases during the best copy and server selection (BCSS) process. You don't need to specify a value with this switch. -Any configured value for MaximumActiveDatabases will still be honored during the BCSS process and by the Information Store. +Any configured value for MaximumActiveDatabases is honored during the BCSS process and by the Information Store. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -431,13 +464,15 @@ Accept wildcard characters: False ``` ### -SkipMoveSuppressionChecks + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipMoveSuppressionChecks switch specifies whether to skip the move suppression checks. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -447,13 +482,15 @@ Accept wildcard characters: False ``` ### -TerminateOnWarning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TerminateOnWarning switch specifies whether to terminate the task and output an error message if a warning is encountered during the switchover operation. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -463,13 +500,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Move-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/Move-AddressList.md similarity index 81% rename from exchange/exchange-ps/exchange/Move-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Move-AddressList.md index d2c70381c6..9892cff13c 100644 --- a/exchange/exchange-ps/exchange/Move-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Move-AddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/move-addresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-AddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/move-addresslist +schema: 2.0.0 +title: Move-AddressList --- # Move-AddressList @@ -29,7 +30,7 @@ Move-AddressList [-Identity] -Target Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the address list that you want to move. You can use any value that uniquely identifies the address list. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the address list that you want to move. You can Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Container parameter specifies where to move the address list. Valid input for this parameter is under the root "\\" (also known as All Address Lists) or under an existing address list. You can use any value that uniquely identifies the address list. For example: - Name @@ -75,7 +81,6 @@ The Container parameter specifies where to move the address list. Valid input fo Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -96,7 +104,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Move-DatabasePath.md b/exchange/exchange-ps/ExchangePowerShell/Move-DatabasePath.md similarity index 82% rename from exchange/exchange-ps/exchange/Move-DatabasePath.md rename to exchange/exchange-ps/ExchangePowerShell/Move-DatabasePath.md index 88ab1bea84..bd0bd4b690 100644 --- a/exchange/exchange-ps/exchange/Move-DatabasePath.md +++ b/exchange/exchange-ps/ExchangePowerShell/Move-DatabasePath.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/move-databasepath -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-DatabasePath -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/move-databasepath +schema: 2.0.0 +title: Move-DatabasePath --- # Move-DatabasePath @@ -40,7 +41,7 @@ When you use the Move-DatabasePath cmdlet, consider the following: - In Exchange 2013 or earlier, you can only run this cmdlet on the affected Mailbox server. If you include the ConfigurationOnly parameter with the value $true, you can run the cmdlet on an administrator's workstation. This does not apply to Exchange 2016 or later (you can run the cmdlet anywhere). - This cmdlet can't be run against replicated mailbox databases. To move the path of a replicated database, you must first remove all replicated copies, and then you can perform the move operation. After the move operation is complete, you can add copies of the mailbox database. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example sets a new path for the mailbox database specified by the mailbox d ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the database that you want to move. You can use any value that uniquely identifies the database. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the database that you want to move. You can use Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigurationOnly switch specifies whether to change the configuration of the database without moving any files. You don't need to specify a value with this switch. If you don't use this switch, the configuration of the database changes and the files are moved. @@ -82,7 +88,6 @@ If you don't use this switch, the configuration of the database changes and the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -103,7 +111,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -EDBFilePath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EdbFilePath parameter specifies a new file path for the database. All current database files are moved to this location. The default location is `%ExchangeInstallPath%Mailbox\LocalCopies\MBDatabase.edb`. This file path can't be the same as the path for the backup copy of the database. ```yaml Type: EdbFilePath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +156,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -153,7 +167,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -LogFolderPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogFolderPath parameter specifies the folder where log files are stored. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -195,13 +212,15 @@ Accept wildcard characters: False ``` ### -EDBFilePath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EdbFilePath parameter specifies a new file path for the database. All current database files are moved to this location. The default location is ``%ExchangeInstallPath%Mailbox\LocalCopies\MBDatabase.edb`. This file path can't be the same as the path for the backup copy of the database. ```yaml Type: EdbFilePath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Move-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/Move-OfflineAddressBook.md similarity index 81% rename from exchange/exchange-ps/exchange/Move-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/Move-OfflineAddressBook.md index 52e6b27ad3..68e4449b9b 100644 --- a/exchange/exchange-ps/exchange/Move-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Move-OfflineAddressBook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/move-offlineaddressbook -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-OfflineAddressBook -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/move-offlineaddressbook +schema: 2.0.0 +title: Move-OfflineAddressBook --- # Move-OfflineAddressBook @@ -30,7 +31,7 @@ Move-OfflineAddressBook [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example moves OAB generation in Exchange 2010 to the server named Server1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the GUID, distinguished name (DN), or OAB name that represents a specific OAB. You can also include the path by using the format Server\\OfflineAddressBookName. You can omit the parameter label so that only the OAB name or GUID is supplied. @@ -52,7 +56,6 @@ You can omit the parameter label so that only the OAB name or GUID is supplied. Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -112,7 +122,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ATPBuiltInProtectionRule.md similarity index 91% rename from exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ATPBuiltInProtectionRule.md index 85953675d6..1f49fba1f2 100644 --- a/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ATPBuiltInProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-atpbuiltinprotectionrule applicable: Exchange Online -title: New-ATPBuiltInProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-atpbuiltinprotectionrule +schema: 2.0.0 +title: New-ATPBuiltInProtectionRule --- # New-ATPBuiltInProtectionRule @@ -40,7 +41,7 @@ For more information about preset security policies in PowerShell, see [Preset s > [!IMPORTANT] > Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This cmdlet creates the rule for the Built-in protection preset security policy. ## PARAMETERS ### -SafeAttachmentPolicy + +> Applicable: Exchange Online + The SafeAttachmentPolicy parameter specifies the Safe Attachments policy that's associated with the Built-in preset security policy. Use the following command to identify the policy: `Get-SafeAttachmentPolicy | Where-Object -Property IsBuiltInProtection -eq -Value "True"`. The name of the default Safe Attachments policy that's used for the Built-in protection preset security policy is Built-In Protection Policy. @@ -62,7 +66,6 @@ The name of the default Safe Attachments policy that's used for the Built-in pro Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -SafeLinksPolicy + +> Applicable: Exchange Online + The SafeLinksPolicy parameter specifies the Safe Links policy that's associated with the Built-in preset security policy. Use the following command to identify the policy: `Get-SafeLinksPolicy | Where-Object -Property IsBuiltInProtection -eq -Value "True"`. The name of the default Safe Links policy that's used for the Built-in protection preset security policy is Built-In Protection Policy. @@ -80,7 +86,6 @@ The name of the default Safe Links policy that's used for the Built-in protectio Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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. @@ -115,7 +125,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -141,6 +152,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -156,7 +170,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -183,7 +199,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -193,6 +208,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. The name of the only rule is ATP Built-In Protection Rule. @@ -201,7 +219,6 @@ The name of the only rule is ATP Built-In Protection Rule. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -211,13 +228,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ATPProtectionPolicyRule.md similarity index 91% rename from exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ATPProtectionPolicyRule.md index 9397716f14..5ad446e0c5 100644 --- a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-atpprotectionpolicyrule applicable: Exchange Online -title: New-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-atpprotectionpolicyrule +schema: 2.0.0 +title: New-ATPProtectionPolicyRule --- # New-ATPProtectionPolicyRule @@ -44,7 +45,7 @@ For more information about preset security policies in PowerShell, see [Preset s > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example creates the rule for the Standard preset security policy. No restri ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. Since you don't need to create rules other than those used by the Standard preset security policy or the Strict preset security policy, we highly recommend that you use the default rule names for clarity and consistency. @@ -66,7 +70,6 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -76,9 +79,12 @@ Accept wildcard characters: False ``` ### -SafeAttachmentPolicy + +> Applicable: Exchange Online + The SafeAttachmentPolicy parameter specifies the existing Safe Attachments policy that's associated with the preset security policy. -If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the Safe Attachments policy will be one of the following values: +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the Safe Attachments policy is one of the following values: - Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650008019`. - Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034872546`. @@ -89,7 +95,6 @@ You can find the Safe Attachments policy that's used by the Standard or Strict p Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -99,9 +104,12 @@ Accept wildcard characters: False ``` ### -SafeLinksPolicy + +> Applicable: Exchange Online + The SafeLinksPolicy parameter specifies the existing Safe Links policy that's associated with the preset security policy. -If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the Safe Attachments policy will be one of the following values: +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the Safe Attachments policy is one of the following values: - Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650008534`. - Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034873192`. @@ -112,7 +120,6 @@ You can find the Safe Links policy that's used by the Standard or Strict preset Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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. @@ -147,7 +159,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -157,9 +168,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the rule is enabled. Valid values are: -- $true: The rule is enabled. The State value of the rule is Enabled. This is the default value. +- $true: The rule is enabled. The State value of the rule is Enabled. This value is the default. - $false: The rule is disabled. The State value of the rule is Disabled. After you create the rule, you turn on or turn off the preset security policy using one of the following commands: @@ -171,7 +185,6 @@ After you create the rule, you turn on or turn off the preset security policy us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -197,6 +212,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -212,7 +230,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -222,6 +239,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -239,7 +259,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Required: False Position: Named @@ -249,6 +268,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. @@ -259,7 +281,6 @@ When you create the policy, you must use the default value. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -269,13 +290,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -285,6 +308,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -300,7 +326,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -310,6 +335,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -327,7 +355,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -337,13 +364,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-AcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/New-AcceptedDomain.md similarity index 81% rename from exchange/exchange-ps/exchange/New-AcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/New-AcceptedDomain.md index 157ffaec81..06426431a7 100644 --- a/exchange/exchange-ps/exchange/New-AcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AcceptedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-accepteddomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AcceptedDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-accepteddomain +schema: 2.0.0 +title: New-AcceptedDomain --- # New-AcceptedDomain @@ -30,7 +31,7 @@ New-AcceptedDomain [-Name] -DomainName ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example creates the new authoritative accepted domain Contoso. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a unique name for the accepted domain object. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,15 +63,17 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainName parameter specifies the SMTP domain that you want to establish as an accepted domain. Valid input for the DomainName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. -However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. The domain name string may not contain more than 256 characters. +However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. The domain name string might not contain more than 256 characters. ```yaml Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -87,7 +95,6 @@ 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 Required: False Position: Named @@ -97,6 +104,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -105,7 +115,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +124,9 @@ Accept wildcard characters: False ``` ### -DomainType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainType parameter specifies the type of accepted domain that you want to configure. Valid values are Authoritative, InternalRelay or ExternalRelay. You must set at least one value. In an authoritative domain, messages are delivered to a recipient that has a domain account in your Exchange organization. In an internal relay domain, messages are relayed to a server outside your Exchange organization, but still under the authority of your company or IT department. Use the internal relay domain if you want to treat the messages to this domain as internal messages. In an external relay domain, messages are relayed to an email server, outside your organization, which you don't control. @@ -125,7 +137,6 @@ The default value is Authoritative. Type: AcceptedDomainType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncDeviceAccessRule.md similarity index 79% rename from exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncDeviceAccessRule.md index 136f962987..f8372ace21 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncDeviceAccessRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-activesyncdeviceaccessrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-ActiveSyncDeviceAccessRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-activesyncdeviceaccessrule +schema: 2.0.0 +title: New-ActiveSyncDeviceAccessRule --- # New-ActiveSyncDeviceAccessRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-ActiveSyncDeviceAccessRule cmdlet to define the access levels for Exchange ActiveSync devices based on the identity of the device. @@ -31,7 +32,7 @@ New-ActiveSyncDeviceAccessRule -AccessLevel -Characteristic ## DESCRIPTION You can create multiple rules that define groups of devices: Allowed devices, blocked devices and quarantined devices. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,13 +53,15 @@ This example creates a device access rule that uses the UserAgent characteristic ## PARAMETERS ### -AccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AccessLevel parameter specifies the access level of devices that are defined by the rule. Valid values for this parameter are Allow, Block and Quarantine. ```yaml Type: DeviceAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Characteristic + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Characteristic parameter specifies the device characteristic or category that's used by the rule. Valid values for this parameter are: - DeviceModel @@ -80,7 +86,6 @@ The Characteristic parameter specifies the device characteristic or category tha Type: DeviceAccessCharacteristic Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -QueryString + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The QueryString parameter specifies the device identifier that's used by the rule. This parameter uses a text value that's used with Characteristic parameter value to define the device. Wildcards or partial matches aren't allowed. You can use the Get-MobileDevice cmdlet to find the text values that you can use with the QueryString parameter. For example: Get-MobileDevice | Format-List DeviceOS,DeviceModel,DeviceType. @@ -98,7 +106,6 @@ You can use the Get-MobileDevice cmdlet to find the text values that you can use Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -117,7 +127,6 @@ 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 Required: False Position: Named @@ -127,6 +136,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -135,7 +147,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,13 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncMailboxPolicy.md similarity index 76% rename from exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncMailboxPolicy.md index e194e62483..139dad571a 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-activesyncmailboxpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-ActiveSyncMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-activesyncmailboxpolicy +schema: 2.0.0 +title: New-ActiveSyncMailboxPolicy --- # New-ActiveSyncMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-ActiveSyncMailboxPolicy cmdlet to create a Microsoft Mobile Device mailbox policy object. @@ -88,7 +89,7 @@ The New-ActiveSyncMailboxPolicy cmdlet creates a Mobile Device mailbox policy fo Some Mobile Device mailbox policy settings require the mobile device to have certain built-in features that enforce these security and device management settings. If your organization allows all devices, you must set the AllowNonProvisionableDevices parameter to $true. This allows devices that can't enforce all policy settings to synchronize with your server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -111,18 +112,20 @@ This example creates the Mobile Device mailbox policy Management that has severa New-ActiveSyncMailboxPolicy -Name:"Contoso" -DevicePasswordEnabled:$true -AlphanumericDevicePasswordRequired:$true -PasswordRecoveryEnabled:$true -MinDevicePasswordComplexCharacters:3 -IsDefault:$true -DevicePasswordHistory:10 ``` -This example creates the Mobile Device mailbox policy Contoso that has several preconfigured values. This policy is configured to be the default policy for the organization. The default policy will be assigned to all new users. +This example creates the Mobile Device mailbox policy Contoso that has several preconfigured values. This policy is configured to be the default policy for the organization. The default policy is assigned to all new users. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -132,6 +135,9 @@ Accept wildcard characters: False ``` ### -AllowApplePushNotifications + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowApplePushNotifications parameter specifies whether push notifications are allowed for Apple mobile devices. The default value is $true. @@ -140,7 +146,6 @@ The AllowApplePushNotifications parameter specifies whether push notifications a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -150,13 +155,15 @@ Accept wildcard characters: False ``` ### -AllowBluetooth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowBluetooth parameter specifies whether the Bluetooth capabilities of the mobile phone are allowed. The available options are Disable, HandsfreeOnly, and Allow. The default value is Allow. ```yaml Type: BluetoothType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -166,13 +173,15 @@ Accept wildcard characters: False ``` ### -AllowBrowser -The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect third-party browsers. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect non-Microsoft browsers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,13 +191,15 @@ Accept wildcard characters: False ``` ### -AllowCamera + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -198,13 +209,15 @@ Accept wildcard characters: False ``` ### -AllowConsumerEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowConsumerEmail parameter specifies whether the mobile phone user can configure a personal email account on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -214,13 +227,15 @@ Accept wildcard characters: False ``` ### -AllowDesktopSync + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,13 +245,15 @@ Accept wildcard characters: False ``` ### -AllowExternalDeviceManagement + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the device. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,13 +263,15 @@ Accept wildcard characters: False ``` ### -AllowHTMLEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowHTMLEmail parameter specifies whether HTML email is enabled on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,13 +281,15 @@ Accept wildcard characters: False ``` ### -AllowInternetSharing + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowInternetSharing parameter specifies whether the mobile phone can be used as a modem to connect a computer to the Internet. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -278,13 +299,15 @@ Accept wildcard characters: False ``` ### -AllowIrDA + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -294,13 +317,15 @@ Accept wildcard characters: False ``` ### -AllowMobileOTAUpdate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowMobileOTAUpdate parameter specifies whether certain updates are seen by devices that implemented support for this restricting functionality. Further control can be specified via the MobileOTAUpdateMode parameter. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -310,13 +335,15 @@ Accept wildcard characters: False ``` ### -AllowNonProvisionableDevices + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + When set to $true, the AllowNonProvisionableDevices parameter enables all devices to synchronize with the computer running Exchange, regardless of whether the device can enforce all the specific settings established in the Mobile Device mailbox policy. This also includes devices managed by a separate device management system. When set to $false, this parameter blocks these devices that aren't provisioned from synchronizing with the server running Exchange. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -326,13 +353,15 @@ Accept wildcard characters: False ``` ### -AllowPOPIMAPEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -342,13 +371,15 @@ Accept wildcard characters: False ``` ### -AllowRemoteDesktop + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -358,13 +389,15 @@ Accept wildcard characters: False ``` ### -AllowSimpleDevicePassword + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSimpleDevicePassword parameter specifies whether a simple device password is allowed. A simple device password is a password that has a specific pattern, such as 1111 or 1234. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -374,13 +407,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMEEncryptionAlgorithmNegotiation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSMIMEEncryptionAlgorithmNegotiation parameter specifies whether the messaging application on the device can negotiate the encryption algorithm in case a recipient's certificate doesn't support the specified encryption algorithm. ```yaml Type: SMIMEEncryptionAlgorithmNegotiationType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -390,13 +425,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMESoftCerts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -406,13 +443,15 @@ Accept wildcard characters: False ``` ### -AllowStorageCard + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowStorageCard parameter specifies whether the device can access information stored on a storage card. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -422,13 +461,15 @@ Accept wildcard characters: False ``` ### -AllowTextMessaging + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowTextMessaging parameter specifies whether text messaging is allowed from the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -438,13 +479,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedApplications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -454,13 +497,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedInstallationPackages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be run on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -470,13 +515,15 @@ Accept wildcard characters: False ``` ### -AllowWiFi + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowWiFi parameter specifies whether wireless Internet access is allowed on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -486,13 +533,15 @@ Accept wildcard characters: False ``` ### -AlphanumericDevicePasswordRequired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlphanumericDevicePasswordRequired parameter specifies whether the device password must be alphanumeric. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -502,13 +551,15 @@ Accept wildcard characters: False ``` ### -ApprovedApplicationList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApprovedApplicationList parameter specifies a list of approved applications for the device. ```yaml Type: ApprovedApplicationCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -518,13 +569,15 @@ Accept wildcard characters: False ``` ### -AttachmentsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AttachmentsEnabled parameter specifies whether the user can download attachments. When set to $false, the user is blocked from downloading attachments. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -534,6 +587,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -543,7 +599,6 @@ 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 Required: False Position: Named @@ -553,13 +608,15 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeviceEncryptionEnabled parameter, when set to $true, enables device encryption on the mobile phone. The default value is $false. Currently, only the storage card can be encrypted on devices running Windows Mobile 6.0 or later. We recommend that you don't use this setting and use the RequireStorageCardEncryption parameter instead. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -569,13 +626,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + When set to $true, the DevicePasswordEnabled parameter specifies that the user set a password for the device. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -585,13 +644,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordExpiration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DevicePasswordExpiration parameter specifies the length of time, in days, that a password can be used. After this length of time, a new password must be created. The format of the parameter is dd.hh.mm:ss, for example, 24.00:00 = 24 hours. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -601,13 +662,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordHistory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DevicePasswordHistory parameter specifies the number of previously used passwords to store. When a user creates a password, the user can't reuse a stored password that was previously used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -617,13 +680,15 @@ Accept wildcard characters: False ``` ### -DevicePolicyRefreshInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DevicePolicyRefreshInterval parameter specifies how often the policy is sent from the server to the mobile phone ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -633,6 +698,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -641,7 +709,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -651,13 +718,15 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -667,13 +736,15 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault parameter specifies whether this policy is the default Mobile Device mailbox policy. The default value is $false. If another policy is currently set as the default, setting this parameter replaces the old default policy with this policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -683,13 +754,15 @@ Accept wildcard characters: False ``` ### -IsDefaultPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault parameter specifies whether this policy is the default Mobile Device mailbox policy. The default value is $false. If another policy is currently set as the default, setting this parameter replaces the old default policy with this policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -699,13 +772,15 @@ Accept wildcard characters: False ``` ### -MaxAttachmentSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile phone. The default value is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -715,6 +790,9 @@ Accept wildcard characters: False ``` ### -MaxCalendarAgeFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the device. Valid values are: - All @@ -727,7 +805,6 @@ The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days Type: CalendarAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -737,13 +814,15 @@ Accept wildcard characters: False ``` ### -MaxDevicePasswordFailedAttempts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxDevicePasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the device. You can enter any number from 4 through 16. The default value is 8. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -753,6 +832,9 @@ Accept wildcard characters: False ``` ### -MaxEmailAgeFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the device. Possible values are: @@ -770,7 +852,6 @@ Possible values are: Type: EmailAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -780,13 +861,15 @@ Accept wildcard characters: False ``` ### -MaxEmailBodyTruncationSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the device. The value is specified in kilobytes (KB). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -796,13 +879,15 @@ Accept wildcard characters: False ``` ### -MaxEmailHTMLBodyTruncationSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are synchronized to the device. The value is specified in KB. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -812,13 +897,15 @@ Accept wildcard characters: False ``` ### -MaxInactivityTimeDeviceLock + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxInactivityTimeDeviceLock parameter specifies the length of time that the device can be inactive before the password is required to reactivate the device. You can enter any interval between 30 seconds and 1 hour. The default value is 15 minutes. The format of the parameter is hh.mm:ss, for example, 15:00 = 15 minutes. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -828,13 +915,15 @@ Accept wildcard characters: False ``` ### -MinDevicePasswordComplexCharacters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MinDevicePasswordComplexCharacters parameter specifies the minimum number of complex characters required in a device password. A complex character isn't a letter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -844,13 +933,15 @@ Accept wildcard characters: False ``` ### -MinDevicePasswordLength + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MinDevicePasswordLength parameter specifies the minimum number of characters in the device password. You can enter any number from 1 through 16. The maximum length a password can be is 16 characters. The default value is 4. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -860,13 +951,15 @@ Accept wildcard characters: False ``` ### -PasswordRecoveryEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PasswordRecoveryEnabled parameter specifies whether you can store the recovery password for the device on an Exchange server. When set to $true, you can store the recovery password for the device on an Exchange server. The default value is $false. The recovery password can be viewed from either Outlook on the web or the Exchange admin center. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -876,13 +969,15 @@ Accept wildcard characters: False ``` ### -RequireDeviceEncryption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -892,13 +987,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptedSMIMEMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -908,13 +1005,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptionSMIMEAlgorithm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message. ```yaml Type: EncryptionSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -924,13 +1023,15 @@ Accept wildcard characters: False ``` ### -RequireManualSyncWhenRoaming + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireManualSyncWhenRoaming parameter specifies whether the device must synchronize manually while roaming. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -940,13 +1041,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEAlgorithm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message. ```yaml Type: SignedSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -956,13 +1059,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSignedSMIMEMessages parameter specifies whether the device must send signed S/MIME messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -972,13 +1077,15 @@ Accept wildcard characters: False ``` ### -RequireStorageCardEncryption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireStorageCardEncryption parameter specifies whether encryption of a storage card is required. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -988,13 +1095,15 @@ Accept wildcard characters: False ``` ### -UnapprovedInROMApplicationList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1004,13 +1113,15 @@ Accept wildcard characters: False ``` ### -UNCAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled. Access to specific shares is configured on the Microsoft Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1020,13 +1131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1036,13 +1149,15 @@ Accept wildcard characters: False ``` ### -WSSAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled. Access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncVirtualDirectory.md similarity index 82% rename from exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncVirtualDirectory.md index 03c846da01..57c9747043 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-activesyncvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ActiveSyncVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-activesyncvirtualdirectory +schema: 2.0.0 +title: New-ActiveSyncVirtualDirectory --- # New-ActiveSyncVirtualDirectory @@ -44,7 +45,7 @@ New-ActiveSyncVirtualDirectory [-ApplicationRoot ] ## DESCRIPTION The New-ActiveSyncVirtualDirectory cmdlet creates an Exchange ActiveSync virtual directory on the specified server under the specified website. The Exchange ActiveSync virtual directory created is named Microsoft-Server-ActiveSync. Only one Exchange ActiveSync virtual directory can exist in each Exchange ActiveSync website. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,13 +73,15 @@ This example creates an Exchange ActiveSync virtual directory for the company Fo ## PARAMETERS ### -ApplicationRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ApplicationRoot parameter specifies the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -AppPoolId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AppPoolId parameter specifies the IIS application pool in which the virtual directory runs. We recommend that you leave this parameter at its default setting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -113,7 +121,6 @@ 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 Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,19 +148,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,16 +172,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,10 +193,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -192,7 +208,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -ExternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalAuthenticationMethods parameter restricts the authentication methods that can be used to connect to the virtual directory from outside the firewall. Valid values are: - Adfs @@ -233,7 +251,6 @@ The default value is blank ($null), which means all available authentication met Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,13 +260,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,13 +278,15 @@ Accept wildcard characters: False ``` ### -InstallProxySubDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InstallProxySubDirectory parameter was used to create an subdirectory that was required for proxying ActiveSync connections with Exchange 2007. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,6 +296,9 @@ Accept wildcard characters: False ``` ### -InternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalAuthenticationMethods parameter restricts the authentication methods that can be used to connect to the virtual directory from inside the firewall. Valid values are: - Adfs @@ -306,7 +330,6 @@ The default value is blank ($null), which means all available authentication met Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,13 +339,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,13 +357,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -348,6 +375,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -359,7 +389,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -369,6 +398,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -380,7 +412,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -390,13 +421,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,13 +439,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AdaptiveScope.md b/exchange/exchange-ps/ExchangePowerShell/New-AdaptiveScope.md similarity index 94% rename from exchange/exchange-ps/exchange/New-AdaptiveScope.md rename to exchange/exchange-ps/ExchangePowerShell/New-AdaptiveScope.md index 88433a9deb..793c5eec68 100644 --- a/exchange/exchange-ps/exchange/New-AdaptiveScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AdaptiveScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-adaptivescope applicable: Security & Compliance -title: New-AdaptiveScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-adaptivescope +schema: 2.0.0 +title: New-AdaptiveScope --- # New-AdaptiveScope @@ -56,13 +57,15 @@ This example create an adaptive query scope named Project X with the following d ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the adaptive scope. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -FilterConditions + +> Applicable: Security & Compliance + The FilterConditions parameter specifies the conditions that are included in the dynamic boundary. Valid syntax and values depend of the value of the LocationType parameter: - User or Group: Active Directory attributes. For example, for the condition "('Country or region' equals 'US' or 'Canada') and 'Department' equals 'Finance'", use the following syntax: `@{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "Canada"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "Equals"; "Name" = "Department"}); "Conjunction" = "And"}` @@ -83,7 +89,6 @@ You can't use this parameter with the RawQuery parameter. Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -LocationType + +> Applicable: Security & Compliance + The LocationType parameter specifies the location where the adaptive scope filter is defined. Valid values are: - User @@ -104,7 +112,6 @@ Type: DynamicBoundaryLocationType Parameter Sets: (All) Aliases: Accepted values: Unknown, User, Group, Site -Applicable: Security & Compliance Required: True Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -RawQuery + +> Applicable: Security & Compliance + The RawQuery parameter switches the scope to advanced query mode. You use OPATH filter syntax for advanced query mode. You can't use this parameter with the FilterConditions parameter. @@ -122,7 +132,6 @@ You can't use this parameter with the FilterConditions parameter. Type: String Parameter Sets: AdaptiveScopeRawQuery Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -AdministrativeUnit + +> Applicable: Security & Compliance + {{ Fill AdministrativeUnit Description }} ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-AddressBookPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-AddressBookPolicy.md similarity index 68% rename from exchange/exchange-ps/exchange/New-AddressBookPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-AddressBookPolicy.md index 4bade089b4..f9491f7295 100644 --- a/exchange/exchange-ps/exchange/New-AddressBookPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AddressBookPolicy.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-addressbookpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-AddressBookPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-addressbookpolicy +schema: 2.0.0 +title: New-AddressBookPolicy --- # New-AddressBookPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the New-AddressBookPolicy cmdlet to create an address book policy. Address book policies define the global address list (GAL), offline address book (OAB), room list, and address lists that will be displayed to mailbox users who are assigned the policy. +Use the New-AddressBookPolicy cmdlet to create an address book policy. Address book policies define the global address list (GAL), offline address book (OAB), room list, and address lists shown to mailbox users who are assigned the policy. In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -31,7 +32,7 @@ New-AddressBookPolicy [-Name] -AddressLists ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,13 +52,15 @@ This example creates an address book policy with the following settings: ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the address book policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -67,13 +70,23 @@ Accept wildcard characters: False ``` ### -AddressLists -The AddressLists parameter specifies the address lists that will be used by mailbox users who are assigned this address book policy. This parameter accepts multiple values, which should be separated by a comma. For example, "\\Mr. Munson's Class","Mrs. McKay's Class","Mrs. Count's Class". + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AddressLists parameter specifies the address lists for mailbox users who are assigned this address book policy. You can use any value that uniquely identifies the address list. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can find the identify values of address lists by using the Get-AddressList cmdlet. ```yaml Type: AddressListIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -83,13 +96,23 @@ Accept wildcard characters: False ``` ### -GlobalAddressList -The GlobalAddressList parameter specifies the identity of the GAL that will be used by mailbox users who are assigned this address book policy. You can specify only one GAL for each address book policy. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The GlobalAddressList parameter specifies the GAL for mailbox users who are assigned this address book policy. You can use any value that uniquely identifies the GAL. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can find the identify values of GALs by using the Get-GlobalAddressList cmdlet. + +You can specify only one GAL for each address book policy. ```yaml Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -99,13 +122,23 @@ Accept wildcard characters: False ``` ### -OfflineAddressBook -The OfflineAddressBook parameter specifies the identity of the OAB that will be used by mailbox users who are assigned this address book policy. You can specify only one OAB for each address book policy. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The OfflineAddressBook parameter specifies the OAB for mailbox users who are assigned this address book policy. You can use any value that uniquely identifies the OAB. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can find the identify values of OABs by using the Get-OfflineAddressBook cmdlet. + +You can specify only one OAB for each address book policy. ```yaml Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -115,9 +148,12 @@ Accept wildcard characters: False ``` ### -RoomList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 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/exchangepowershell/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: @@ -133,7 +169,6 @@ A valid value for this parameter is one address list. You can use any value that Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -143,6 +178,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -152,7 +190,6 @@ 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 Required: False Position: Named @@ -162,6 +199,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -170,7 +210,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,13 +219,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/New-AddressList.md similarity index 86% rename from exchange/exchange-ps/exchange/New-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/New-AddressList.md index 540855b553..a87dfe3fdd 100644 --- a/exchange/exchange-ps/exchange/New-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AddressList.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-addresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-AddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-addresslist +schema: 2.0.0 +title: New-AddressList --- # New-AddressList ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-AddressList cmdlet to create address lists and apply them to recipients. @@ -73,7 +74,7 @@ The Conditional parameters that are used with the IncludedRecipients parameter a To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPATH filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -101,13 +102,15 @@ This example creates the address list AL\_AgencyB that includes mailboxes that h ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name for the new address list. The maximum length is 64 characters, and it can't include a carriage return or a backslash (\\). If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -117,6 +120,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -134,7 +140,6 @@ You need to use this parameter when you use any Conditional parameters as part o Type: WellKnownRecipientType Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -161,7 +169,6 @@ You can't use this parameter in combination with the IncludedRecipients paramete Type: String Parameter Sets: CustomFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -171,6 +178,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -181,7 +191,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -191,6 +200,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -201,7 +213,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -211,6 +222,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -221,7 +235,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -231,6 +244,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -241,7 +257,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -251,6 +266,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -261,7 +279,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -271,6 +288,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -281,7 +301,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -291,6 +310,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -301,7 +323,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -311,6 +332,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -321,7 +345,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -331,6 +354,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -341,7 +367,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -351,6 +376,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -361,7 +389,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -371,6 +398,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -381,7 +411,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -391,6 +420,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -401,7 +433,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,6 +442,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -421,7 +455,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -431,6 +464,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -441,7 +477,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -451,6 +486,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -461,7 +499,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -471,6 +508,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -481,7 +521,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -491,6 +530,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -501,7 +543,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -511,6 +552,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -521,7 +565,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -531,6 +574,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -540,7 +586,6 @@ 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 Required: False Position: Named @@ -550,6 +595,9 @@ Accept wildcard characters: False ``` ### -Container + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Container parameter specifies where to create the address list. Valid input for this parameter is under the root "\\" (also known as All Address Lists) or under an existing address list. You can use any value that uniquely identifies the address list. For example: - Name @@ -563,7 +611,6 @@ If you don't use this parameter,the address list is created under the root (\\). Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -573,6 +620,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DisplayName parameter specifies the display name of the address list. The display name is visible in the Exchange admin center and Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -581,7 +631,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -591,6 +640,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -599,7 +651,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -609,6 +660,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -624,7 +678,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -634,13 +687,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md b/exchange/exchange-ps/ExchangePowerShell/New-AddressRewriteEntry.md similarity index 88% rename from exchange/exchange-ps/exchange/New-AddressRewriteEntry.md rename to exchange/exchange-ps/ExchangePowerShell/New-AddressRewriteEntry.md index 1c5c9541bd..6512dfd601 100644 --- a/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AddressRewriteEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-addressrewriteentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AddressRewriteEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-addressrewriteentry +schema: 2.0.0 +title: New-AddressRewriteEntry --- # New-AddressRewriteEntry @@ -59,13 +60,15 @@ This example creates an address rewrite entry that rewrites all email addresses ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a unique name for this address rewrite entry. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -ExternalAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalAddress parameter specifies the final email addresses that you want. If the InternalAddress parameter specifies a single email address (chris@contoso.com), the ExternalAddress parameter must also specify a single email address (support@contoso.com). If the InternalAddress parameter specifies a single domain (contoso.com) or a domain and all subdomains (\*.contoso.com), the ExternalAddress parameter must specify a single domain (fabrikam.com). You can't use the wildcard character (\*) with the ExternalAddress parameter. @@ -83,7 +89,6 @@ You can't use the wildcard character (\*) with the ExternalAddress parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -InternalAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalAddress parameter specifies the original email addresses that you want to change. You can use the following values: - Single email address: david@contoso.com @@ -103,7 +111,6 @@ The InternalAddress parameter specifies the original email addresses that you wa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -122,7 +132,6 @@ 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 Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -140,7 +152,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -ExceptionList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExceptionList parameter specifies the email address domains that shouldn't be rewritten when the InternalAddress parameter contains the wildcard character to rewrite addresses in a domain and all subdomains (\*.contoso.com). You can enter multiple domain values in the ExceptionList parameter separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -OutboundOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OutboundOnly parameter enables or disables outbound-only address rewriting. Valid input for this parameter is $true or $false. The value $true means address rewriting occurs in outbound mail only. The value $false means address rewriting occurs on outbound mail and also on inbound mail (rewritten email addresses are changed back to the original email addresses in inbound mail). The default value is $false. You must set this parameter to $true if the InternalAddress parameter contains the wildcard character to rewrite addresses in a domain and all subdomains (\*.contoso.com). @@ -176,7 +192,6 @@ Also, when you configure outbound-only address rewriting, you need to configure Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md b/exchange/exchange-ps/ExchangePowerShell/New-AdminAuditLogSearch.md similarity index 78% rename from exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md rename to exchange/exchange-ps/ExchangePowerShell/New-AdminAuditLogSearch.md index 1059619e55..19b0cf5723 100644 --- a/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AdminAuditLogSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-adminauditlogsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: New-AdminAuditLogSearch -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-adminauditlogsearch +schema: 2.0.0 +title: New-AdminAuditLogSearch --- # New-AdminAuditLogSearch @@ -15,7 +16,7 @@ ms.reviewer: > [!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. +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might 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. @@ -40,7 +41,7 @@ New-AdminAuditLogSearch -EndDate -StartDate -StatusMai ## DESCRIPTION After the New-AdminAuditLogSearch cmdlet is run, the report is delivered to the mailboxes you specify within 15 minutes. The log is included as an XML attachment on the report email message. The maximum size of the log that can be generated is 10 megabytes (MB). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,6 +67,9 @@ This example returns entries in the administrator audit log of an Exchange Onlin ## PARAMETERS ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -74,7 +78,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named Default value: None @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -91,7 +97,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named Default value: None @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -StatusMailRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The StatusMailRecipients parameter specifies the recipients that should receive the administrator audit log report. The recipient must be a valid SMTP address. If you want to specify more than one recipient, separate each SMTP address with a comma. @@ -108,7 +116,6 @@ If you want to specify more than one recipient, separate each SMTP address with Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named Default value: None @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Cmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Cmdlets parameter specifies the cmdlets you want to search for in the administrator audit log. Only the log entries that contain the cmdlets you specify are returned. If you want to specify more than one cmdlet, separate each cmdlet with a comma. @@ -125,7 +135,6 @@ If you want to specify more than one cmdlet, separate each cmdlet with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -143,7 +155,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -160,7 +174,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -ExternalAccess + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ExternalAccess parameter returns only audit log entries for cmdlets that were run by a user outside of your organization. In Exchange Online, use this parameter to return audit log entries for cmdlets run by Microsoft datacenter administrators. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Name parameter specifies the name of the administrator audit log search. The name is shown in the subject line of the audit log report email message. If the name of the report contains spaces, enclose the name in quotation marks ("). @@ -193,7 +211,6 @@ If the name of the report contains spaces, enclose the name in quotation marks ( Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -202,6 +219,9 @@ Accept wildcard characters: False ``` ### -ObjectIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ObjectIds parameter specifies that only administrator audit log entries that contain the specified changed objects should be returned. This parameter accepts a variety of objects, such as mailboxes, aliases, Send connector names and so on. If you want to specify more than one object ID, separate each ID with a comma. @@ -210,7 +230,6 @@ If you want to specify more than one object ID, separate each ID with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Parameters parameter specifies the parameters you want to search for in the administrator audit log. Only the log entries that contain the parameters you specify are returned. You can only use this parameter if you use the Cmdlets parameter. If you want to specify more than one parameter, separate each parameter with a comma. @@ -227,7 +249,6 @@ If you want to specify more than one parameter, separate each parameter with a c Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -236,6 +257,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The UserIds parameter specifies that only the administrator audit log entries that contain the specified ID of the user who ran the cmdlet should be returned. If you want to specify more than one user ID, separate each ID with a comma. @@ -244,7 +268,6 @@ If you want to specify more than one user ID, separate each ID with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -253,6 +276,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -261,7 +287,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-AntiPhishPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/New-AntiPhishPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-AntiPhishPolicy.md index 412a2a5340..697abf3319 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AntiPhishPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-antiphishpolicy applicable: Exchange Online, Exchange Online Protection -title: New-AntiPhishPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-antiphishpolicy +schema: 2.0.0 +title: New-AntiPhishPolicy --- # New-AntiPhishPolicy @@ -71,7 +72,7 @@ Phishing messages contain fraudulent links or spoofed domains in an effort to ge New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the AntiPhishPolicy parameter on the New-AntiPhishRule or Set-AntiPhishRule cmdlets to associate the policy with a rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -91,13 +92,15 @@ In Microsoft Defender for Office 365, this example creates and enables an antiph ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the antiphish policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -123,18 +128,20 @@ Accept wildcard characters: False ``` ### -AuthenticationFailAction + +> Applicable: Exchange Online, Exchange Online Protection + 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 Junk Email folder in the recipient's mailbox. +- MoveToJmf: This value is the default. 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -153,7 +163,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,12 +172,15 @@ Accept wildcard characters: False ``` ### -DmarcQuarantineAction + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`. Valid values are: - MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. -- Quarantine: Deliver the message to quarantine. This is the default value. +- Quarantine: Deliver the message to quarantine. This value is the default. This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. @@ -176,7 +188,6 @@ This parameter is meaningful only when the HonorDmarcPolicy parameter is set to Type: SpoofDmarcQuarantineAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -186,12 +197,15 @@ Accept wildcard characters: False ``` ### -DmarcRejectAction + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The DmarcRejectAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=reject`. Valid values are: - Quarantine: Deliver the message to quarantine. -- Reject: Reject the message. This is the default value. +- Reject: Reject the message. This value is the default. This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. @@ -199,7 +213,6 @@ This parameter is meaningful only when the HonorDmarcPolicy parameter is set to Type: SpoofDmarcRejectAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -209,6 +222,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. To create a disabled anti-phishing policy (the combination of the antiphish rule and the associated antiphish policy), use `-Enabled $false` on the **New-AntiPhishRule** cmdlet. @@ -221,7 +237,6 @@ In the output of the **Get-AntiPhishRule** cmdlet, whether the anti-phishing pol Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -231,16 +246,18 @@ Accept wildcard characters: False ``` ### -EnableFirstContactSafetyTips + +> Applicable: Exchange Online, Exchange Online Protection + The EnableFirstContactSafetyTips parameter specifies whether to enable or disable the safety tip that's shown when recipients first receive an email from a sender or do not often receive email from a sender. Valid values are: - $true: First contact safety tips are enabled. -- $false: First contact safety tips are disabled. This is the default value. +- $false: First contact safety tips are disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -250,18 +267,20 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligence + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence, which is artificial intelligence (AI) that determines user email patterns with their frequent contacts. Mailbox intelligence helps distinguish between messages from legitimate and impersonated senders based on a recipient's previous communication history. Valid values are: -- $true: Mailbox intelligence is enabled. This is the default value. +- $true: Mailbox intelligence is enabled. This value is the default. - $false: Mailbox intelligence is disabled. The values of the EnableMailboxIntelligenceProtection and MailboxIntelligenceProtectionAction parameters are ignored. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -271,12 +290,15 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligenceProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligenceProtection specifies whether to enable or disable taking action for impersonation detections from mailbox intelligence results. Valid values are: - $true: Take action for impersonation detections from mailbox intelligence results. Use the MailboxIntelligenceProtectionAction parameter to specify the action. -- $false: Don't take action for impersonation detections from mailbox intelligence results. The value of the MailboxIntelligenceProtectionAction parameter is ignored. This is the default value. +- $false: Don't take action for impersonation detections from mailbox intelligence results. The value of the MailboxIntelligenceProtectionAction parameter is ignored. This value is the default. This parameter is meaningful only if the EnableMailboxIntelligence parameter is set to the value $true. @@ -286,7 +308,6 @@ If you set this parameter to the value $false when the value of the EnableMailbo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -296,18 +317,20 @@ Accept wildcard characters: False ``` ### -EnableOrganizationDomainsProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Microsoft 365 organization. Valid values are: - $true: Domain impersonation protection is enabled for all registered domains in the Microsoft 365 organization. -- $false: Domain impersonation protection isn't enabled for all registered domains in the Microsoft 365 organization. This is the default value. You can enable protection for specific domains by using the EnableTargetedDomainsProtection and TargetedDomainsToProtect parameters. +- $false: Domain impersonation protection isn't enabled for all registered domains in the Microsoft 365 organization. This value is the default. You can enable protection for specific domains by using the EnableTargetedDomainsProtection and TargetedDomainsToProtect parameters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -317,18 +340,20 @@ Accept wildcard characters: False ``` ### -EnableSimilarDomainsSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for domain impersonation detections. Valid values are: - $true: Safety tips for similar domains are enabled. -- $false: Safety tips for similar domains are disabled. This is the default value. +- $false: Safety tips for similar domains are disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -338,18 +363,20 @@ Accept wildcard characters: False ``` ### -EnableSimilarUsersSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for user impersonation detections. Valid values are: - $true: Safety tips for similar users are enabled. -- $false: Safety tips for similar users are disabled. This is the default value. +- $false: Safety tips for similar users are disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -359,6 +386,9 @@ Accept wildcard characters: False ``` ### -EnableSpoofIntelligence + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableSpoofIntelligence parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: @@ -370,7 +400,6 @@ The EnableSpoofIntelligence parameter specifies whether to enable or disable ant Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -380,18 +409,20 @@ Accept wildcard characters: False ``` ### -EnableTargetedDomainsProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableTargetedDomainsProtection parameter specifies whether to enable domain impersonation protection for a list of specified domains. Valid values are: - $true: Domain impersonation protection is enabled for the domains specified by the TargetedDomainsToProtect parameter. -- $false: The TargetedDomainsToProtect parameter isn't used. This is the default value. +- $false: The TargetedDomainsToProtect parameter isn't used. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -401,18 +432,20 @@ Accept wildcard characters: False ``` ### -EnableTargetedUserProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for a list of specified users. Valid values are: - $true: User impersonation protection is enabled for the users specified by the TargetedUsersToProtect parameter. -- $false: The TargetedUsersToProtect parameter isn't used. This is the default value. +- $false: The TargetedUsersToProtect parameter isn't used. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -422,11 +455,14 @@ Accept wildcard characters: False ``` ### -EnableUnauthenticatedSender + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableUnauthenticatedSender parameter enables or disables unauthenticated sender identification in Outlook. Valid values are: -- $true: This is the default value. A question mark (?) is applied to the sender's photo if the message does not pass SPF or DKIM checks AND the message does not pass DMARC or composite authentication. +- $true: This value is the default. A question mark (?) is applied to the sender's photo if the message does not pass SPF or DKIM checks AND the message does not pass DMARC or composite authentication. - $false: A question mark is never applied to the sender's photo. To prevent these identifiers from being added to messages from specific senders, you have the following options: @@ -438,7 +474,6 @@ To prevent these identifiers from being added to messages from specific senders, Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -448,18 +483,20 @@ Accept wildcard characters: False ``` ### -EnableUnusualCharactersSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for unusual characters in domain and user impersonation detections. Valid values are: - $true: Safety tips for unusual characters are enabled. -- $false: Safety tips for unusual characters are disabled. This is the default value. +- $false: Safety tips for unusual characters are disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -469,11 +506,14 @@ Accept wildcard characters: False ``` ### -EnableViaTag + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableViaTag parameter enables or disables adding the via tag to the From address in Outlook (chris@contso.com via fabrikam.com). Valid values are: -- $true: The via tag is added to the From address (the message sender that's displayed in email clients) if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. This is the default value. +- $true: The via tag is added to the From address (the message sender that's displayed in email clients) if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. This value is the default. - $false: The via tag is not added to the From address. To prevent the via tag from being added to messages from specific senders, you have the following options: @@ -485,7 +525,6 @@ To prevent the via tag from being added to messages from specific senders, you h Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -495,6 +534,9 @@ Accept wildcard characters: False ``` ### -ExcludedDomains + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. @@ -507,7 +549,6 @@ The maximum number of entries is approximately 1000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -517,6 +558,9 @@ Accept wildcard characters: False ``` ### -ExcludedSenders + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. @@ -527,7 +571,6 @@ The maximum number of entries is approximately 1000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -537,18 +580,20 @@ Accept wildcard characters: False ``` ### -HonorDmarcPolicy + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The HonorDmarcPolicy enables or disables using the sender's DMARC policy to determine what to do to messages that fail DMARC checks. Valid values are: -- $true: If a message fails DMARC and the sender's DMARC policy is `p=quarantine` or `p=reject`, the DmarcQuarantineAction or DmarcRejectAction parameters specify the action to take on the message. This is the default value. +- $true: If a message fails DMARC and the sender's DMARC policy is `p=quarantine` or `p=reject`, the DmarcQuarantineAction or DmarcRejectAction parameters specify the action to take on the message. This value is the default. - $false: If the message fails DMARC, ignore the action in the sender's DMARC policy. The AuthenticationFailAction parameter specifies the action to take on the message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -558,19 +603,21 @@ Accept wildcard characters: False ``` ### -ImpersonationProtectionState + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ImpersonationProtectionState parameter specifies the configuration of impersonation protection. Valid values are: -- Automatic: This is the default value in the default policy named Office365 AntiPhish Policy. -- Manual: This is the default value in custom policies that you create. +- Automatic: This value is the default in the default policy named Office365 AntiPhish Policy. +- Manual: This value is the default in custom policies that you create. - Off ```yaml Type: ImpersonationProtectionState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -580,11 +627,14 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionAction parameter specifies what to do with messages that fail mailbox intelligence protection. Valid values are: -- NoAction: This is the default value. Note that this value has the same result as setting the EnableMailboxIntelligenceProtection parameter to $false when the EnableMailboxIntelligence parameter is $true. +- NoAction: This value is the default. 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 Junk Email folder in the recipient's mailbox. @@ -597,7 +647,6 @@ This parameter is meaningful only if the EnableMailboxIntelligence and EnableMai Type: ImpersonationAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -607,6 +656,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionActionRecipients parameter specifies the recipients to add to detected messages when the MailboxIntelligenceProtectionAction parameter is set to the value Redirect or BccMessage. @@ -617,7 +669,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -627,6 +678,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by mailbox intelligence (the MailboxIntelligenceProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -645,7 +699,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -655,6 +708,9 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Online, Exchange Online Protection + The MakeDefault switch makes this antiphish policy the default antiphish policy. You don't need to specify a value with this switch. The default antiphish policy is applied to everyone (no corresponding antiphish rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). @@ -663,7 +719,6 @@ The default antiphish policy is applied to everyone (no corresponding antiphish Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -673,11 +728,14 @@ Accept wildcard characters: False ``` ### -PhishThresholdLevel + +> Applicable: Exchange Online + This setting is part of advanced settings and is available only in Microsoft Defender for Office 365. The PhishThresholdLevel parameter specifies the tolerance level that's used by machine learning in the handling of phishing messages. Valid values are: -- 1: Standard: This is the default value. The severity of the action that's taken on the message depends on the degree of confidence that the message is phishing (low, medium, high, or very high confidence). For example, messages that are identified as phishing with a very high degree of confidence have the most severe actions applied, while messages that are identified as phishing with a low degree of confidence have less severe actions applied. +- 1: Standard: This value is the default. The severity of the action that's taken on the message depends on the degree of confidence that the message is phishing (low, medium, high, or very high confidence). For example, messages that are identified as phishing with a very high degree of confidence have the most severe actions applied, while messages that are identified as phishing with a low degree of confidence have less severe actions applied. - 2: Aggressive: Messages that are identified as phishing with a high degree of confidence are treated as if they were identified with a very high degree of confidence. - 3: More aggressive: Messages that are identified as phishing with a medium or high degree of confidence are treated as if they were identified with a very high degree of confidence. - 4: Most aggressive: Messages that are identified as phishing with a low, medium, or high degree of confidence are treated as if they were identified with a very high degree of confidence. @@ -686,7 +744,6 @@ The PhishThresholdLevel parameter specifies the tolerance level that's used by m Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -696,13 +753,15 @@ Accept wildcard characters: False ``` ### -PolicyTag + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -712,13 +771,15 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online, Exchange Online Protection + The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -728,13 +789,15 @@ Accept wildcard characters: False ``` ### -SimilarUsersSafetyTipsCustomText + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -744,6 +807,9 @@ Accept wildcard characters: False ``` ### -SpoofQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The SpoofQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by spoof intelligence (the AuthenticationFailAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -760,7 +826,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -770,6 +835,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. @@ -780,7 +848,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -790,11 +857,14 @@ Accept wildcard characters: False ``` ### -TargetedDomainProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: -- NoAction: This is the default value. +- NoAction: This value is the default. - 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 Junk Email folder in the recipient's mailbox. @@ -805,7 +875,6 @@ The TargetedDomainProtectionAction parameter specifies the action to take on det Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -815,6 +884,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by domain impersonation protection (the TargetedDomainProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -833,7 +905,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -843,6 +914,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainsToProtect + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. @@ -853,7 +927,6 @@ You can specify multiple domains separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -863,6 +936,9 @@ Accept wildcard characters: False ``` ### -TargetedUserActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. @@ -873,7 +949,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -883,11 +958,14 @@ Accept wildcard characters: False ``` ### -TargetedUserProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: -- NoAction: This is the default value. +- NoAction: This value is the default. - 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 Junk Email folder in the recipient's mailbox. @@ -898,7 +976,6 @@ The TargetedUserProtectionAction parameter specifies the action to take on detec Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -908,6 +985,9 @@ Accept wildcard characters: False ``` ### -TargetedUserQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by user impersonation protection (the TargetedUserProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -926,7 +1006,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -936,6 +1015,9 @@ Accept wildcard characters: False ``` ### -TargetedUsersToProtect + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. @@ -950,7 +1032,6 @@ This parameter uses the syntax: "DisplayName;EmailAddress". Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -960,13 +1041,15 @@ Accept wildcard characters: False ``` ### -UnusualCharactersSafetyTipsCustomText + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -976,13 +1059,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/New-AntiPhishRule.md similarity index 88% rename from exchange/exchange-ps/exchange/New-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-AntiPhishRule.md index 79afcd0346..c51ee1499b 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: New-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-antiphishrule +schema: 2.0.0 +title: New-AntiPhishRule --- # New-AntiPhishRule @@ -42,7 +43,7 @@ You need to add the antiphish rule to an existing policy by using the AntiPhishP > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Common policy settings](https://learn.microsoft.com/defender-office-365/anti-phishing-policies-about#common-policy-settings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,13 +60,15 @@ This example creates an antiphish rule named Research Department with the follow ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the antiphish rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AntiPhishPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The AntiPhishPolicy parameter specifies the antiphish policy that's associated with the antiphish rule. You can use any value that uniquely identifies the policy. For example: @@ -89,7 +95,6 @@ You can't specify the default antiphish policy. And, you can't specify an antiph Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -124,7 +134,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -134,9 +143,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the rule is enabled. Valid values are: -- $true: The rule is enabled. This is the default value. +- $true: The rule is enabled. This value is the default. - $false: The rule is disabled. In the properties of the rule, the value of this parameter is visible in the State property. @@ -145,7 +157,6 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -186,7 +202,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -196,6 +211,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -213,7 +231,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -223,6 +240,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -237,7 +257,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -247,13 +266,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -263,6 +284,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -278,7 +302,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -288,6 +311,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -305,7 +331,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -315,13 +340,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-App.md b/exchange/exchange-ps/ExchangePowerShell/New-App.md similarity index 82% rename from exchange/exchange-ps/exchange/New-App.md rename to exchange/exchange-ps/ExchangePowerShell/New-App.md index 12f88e9b57..30d95ae4f1 100644 --- a/exchange/exchange-ps/exchange/New-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-App.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-app -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-App -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-app +schema: 2.0.0 +title: New-App --- # New-App ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-App cmdlet to install apps for Outlook. @@ -125,7 +126,7 @@ If the app is enabled for the entire organization, users can activate the new ap For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://learn.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://learn.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -134,7 +135,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi New-App -FileData ([System.IO.File]::ReadAllBytes('C:\Apps\FinanceTestApp.xml')) ``` -This example installs the Finance Test app manifest file that has been copied to the local hard disk. +This example installs the Finance Test app manifest file that is copied to the local hard disk. ### Example 2 ```powershell @@ -146,6 +147,9 @@ This example installs the Contoso CRM app manifest.xml from a URL on the Contoso ## PARAMETERS ### -AddInOverrides + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AddInOverrides Description }} @@ -154,7 +158,6 @@ This parameter is available only in the cloud-based service. Type: AddInOverrides Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -164,13 +167,15 @@ Accept wildcard characters: False ``` ### -AllowReadWriteMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowReadWriteMailbox switch specifies whether the app allows read/write mailbox permission. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +185,9 @@ Accept wildcard characters: False ``` ### -AllowSetting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AllowSetting Description }} @@ -188,7 +196,6 @@ This parameter is available only in the cloud-based service. Type: AllowSetting Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -198,6 +205,9 @@ Accept wildcard characters: False ``` ### -AppState + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AppState Description }} @@ -206,7 +216,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,6 +225,9 @@ Accept wildcard characters: False ``` ### -AppType + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AppType Description }} @@ -224,7 +236,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -234,6 +245,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -243,7 +257,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,10 +266,13 @@ Accept wildcard characters: False ``` ### -DefaultStateForUser + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultStateForUser parameter specifies the default initial state of an organization app. Valid values are: - Enabled: The organization app is enabled by default. -- Disabled: The organization app is disabled by default. This is the default value. +- Disabled: The organization app is disabled by default. This value is the default. - AlwaysEnabled: The organization app is enabled and users can't disable it. You need to use the OrganizationApp switch when you use this parameter. @@ -265,7 +281,6 @@ You need to use the OrganizationApp switch when you use this parameter. Type: DefaultStateForUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -275,6 +290,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -283,7 +301,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +310,9 @@ Accept wildcard characters: False ``` ### -DownloadOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DownloadOnly switch specifies whether to get the app manifest file and prompt the user for confirmation before committing to actual installation. You don't need to specify a value with this switch. When you use this switch, the cmdlet only downloads the app manifest file and displays the app properties without installing the app. @@ -301,7 +321,6 @@ When you use this switch, the cmdlet only downloads the app manifest file and di Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -311,9 +330,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter specifies whether the app is available to users in the organization. Valid values are: -- $true: The app is available to the specified users. This is the default value. +- $true: The app is available to the specified users. This value is the default. - $false: The app is hidden from all users in the organization. This setting overrides the ProvidedTo, UserList and DefaultStateForUser settings. This setting doesn't prevent users from installing their own instance of the app if they have install permissions. @@ -322,7 +344,6 @@ This setting overrides the ProvidedTo, UserList and DefaultStateForUser settings Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -332,13 +353,15 @@ Accept wildcard characters: False ``` ### -Etoken + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -348,6 +371,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FileData parameter specifies the location of the app manifest file. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -356,7 +382,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: ExtensionFileData Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -366,13 +391,15 @@ Accept wildcard characters: False ``` ### -FileStream + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FileStream parameter is used only by the Exchange admin center to support the app file uploader. Don't use this parameter to specify the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url or FileData parameter. ```yaml Type: Stream Parameter Sets: ExtensionFileStream Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -382,6 +409,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Identity Description }} @@ -390,7 +420,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -400,6 +429,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox where you want to install the app. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -417,7 +449,6 @@ The Mailbox parameter specifies the mailbox where you want to install the app. Y Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -427,13 +458,15 @@ Accept wildcard characters: False ``` ### -MarketplaceAssetID + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MarketplaceAssetID parameter specifies the Office Store identifier for the app. You need to use this parameter if you use theMarketplaceServicesUrl parameter. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -443,13 +476,15 @@ Accept wildcard characters: False ``` ### -MarketplaceCorrelationID + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MarketplaceCorrelationID parameter specifies the Office Store correlation identifier for the app. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -459,13 +494,15 @@ Accept wildcard characters: False ``` ### -MarketplaceQueryMarket + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MarketplaceQueryMarket parameter specifies the locale that an app is filed under at the office marketplace. For example, an app for the United States market in English uses the value en-US. The default value is en-US. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -475,13 +512,15 @@ Accept wildcard characters: False ``` ### -MarketplaceServicesUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MarketplaceServicesUrl parameter specifies the full services URL for the app. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url or FileData parameter. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -491,13 +530,15 @@ Accept wildcard characters: False ``` ### -MarketplaceUserProfileType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MarketplaceUserProfileType parameter specifies the user profile type for the Office Store. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -507,13 +548,15 @@ Accept wildcard characters: False ``` ### -OrganizationApp + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OrganizationApp switch specifies that the scope of the app is organizational (not bound to a specific user). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -523,13 +566,15 @@ Accept wildcard characters: False ``` ### -PrivateCatalog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PrivateCatalog switch specifies whether the app is located in a private catalog. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -539,10 +584,13 @@ Accept wildcard characters: False ``` ### -ProvidedTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ProvidedTo parameter specifies the availability of the app in your organization. Valid values are: -- Everyone: This is the default value. This app is provided to every user in the organization. Every user sees this app listed in the installed apps list in Outlook on the web Options. When an app in the installed apps list is enabled, users can use the features of this app in their email. All users are blocked from installing their own instances of this app, including but not limited to users with install apps permissions. -- SpecificUsers: This app is provided to only the users specified by the UserList parameter. All other users don't see this organizational app in their management view, nor will it activate in their mail or calendar items. The specified users are also blocked from installing their own instance of this app. Unlisted users aren't blocked from installing their own instance of this app. +- Everyone: This value is the default. This app is provided to every user in the organization. Every user sees this app listed in the installed apps list in Outlook on the web Options. When an app in the installed apps list is enabled, users can use the features of this app in their email. All users are blocked from installing their own instances of this app, including but not limited to users with install apps permissions. +- SpecificUsers: This app is provided to only the users specified by the UserList parameter. All other users don't see this organizational app in their management view, nor does it activate in their mail or calendar items. The specified users are also blocked from installing their own instance of this app. Unlisted users aren't blocked from installing their own instance of this app. You use this parameter with the OrganizationApp switch. @@ -550,7 +598,6 @@ You use this parameter with the OrganizationApp switch. Type: ClientExtensionProvidedTo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -560,6 +607,9 @@ Accept wildcard characters: False ``` ### -UpdateAppState + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UpdateAppState Description }} @@ -568,7 +618,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -578,6 +627,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Url parameter specifies the full URL location of the app manifest file that you want to install. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url or FileData parameter. **Note**: URLs with redirections are not supported in Exchange Server 2016, Exchange Server 2019, and Exchange Online. Use a direct URL to the manifest. @@ -586,7 +638,6 @@ The Url parameter specifies the full URL location of the app manifest file that Type: Uri Parameter Sets: ExtensionPrivateURL Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -596,6 +647,9 @@ Accept wildcard characters: False ``` ### -UserList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://learn.microsoft.com/office/dev/add-ins/publish/centralized-deployment). Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. For example: @@ -619,7 +673,6 @@ You use this parameter with the OrganizationApp switch. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -629,6 +682,9 @@ Accept wildcard characters: False ``` ### -Version + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Version Description }} @@ -637,7 +693,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -647,13 +702,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-AppRetentionCompliancePolicy.md similarity index 78% rename from exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-AppRetentionCompliancePolicy.md index c3787439cd..ff23d6c486 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AppRetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-appretentioncompliancepolicy applicable: Security & Compliance -title: New-AppRetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-appretentioncompliancepolicy +schema: 2.0.0 +title: New-AppRetentionCompliancePolicy --- # New-AppRetentionCompliancePolicy @@ -50,7 +51,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). @@ -68,13 +71,15 @@ After you create the retention policy, use the New-AppRetentionComplianceRule cm ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the app retention compliance policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -AdaptiveScopeLocation + +> Applicable: Security & Compliance + The AdaptiveScopeLocation parameter specifies the adaptive scope location to include in the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -94,7 +102,6 @@ The AdaptiveScopeLocation parameter specifies the adaptive scope location to inc Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -104,19 +111,39 @@ 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: -- ExchangeLocation -- ModernGroupLocation -- AdaptiveScopeLocation +> Applicable: Security & Compliance + +The Applications parameter specifies the applications to include in the policy. + +This parameter uses the following syntax: `"LocationType:App1,LocationType:App2,...LocationType:AppN`: + +`LocationType` is User or Group. + +`App` is a supported value as shown in the following examples. + +- **Microsoft 365 apps**: For example: + + `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:VivaEngage"` + +- **Microsoft Copilot experiences**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"` + + **Note**: Even though you must use `CopilotinBusinessApplicationplatformsSales` and `SQLCopilot`, those values are currently irrelevant. + +- **Enterprise AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"` + +- **Other AI apps**: Currently in Preview. You must use *all* of the following values at the same time: -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:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"` ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -126,13 +153,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -142,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -151,7 +183,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -161,16 +192,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter enables or disables the policy. Valid values are: -- $true: The policy is enabled. This is the default value. +- $true: The policy is enabled. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -180,6 +213,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - A mailbox @@ -199,7 +235,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -209,6 +244,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocationException + +> Applicable: Security & Compliance + The ExchangeLocationException parameter specifies the mailboxes exclude from the policy when you use the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -227,7 +265,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -237,6 +274,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -245,7 +285,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -255,6 +294,9 @@ Accept wildcard characters: False ``` ### -ModernGroupLocation + +> Applicable: Security & Compliance + The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. Valid values are: - A Microsoft 365 Group @@ -273,7 +315,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -283,6 +324,9 @@ Accept wildcard characters: False ``` ### -ModernGroupLocationException + +> Applicable: Security & Compliance + The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude from the policy when you use the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -298,7 +342,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -308,6 +351,11 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + +**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. @@ -316,7 +364,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -326,12 +373,15 @@ Accept wildcard characters: False ``` ### -RestrictiveRetention + +> Applicable: Security & Compliance + The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: - $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. -- $false: Preservation Lock isn't enabled for the policy. This is the default value. +- $false: Preservation Lock isn't enabled for the policy. This value is the default. -After a policy has been locked, no one can turn off or disable it, or remove apps from the policy. The only ways that you can modify the policy are by adding apps to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. +After a policy is locked, no one can turn off or disable it, or remove apps from the policy. The only ways that you can modify the policy are by adding apps to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. Therefore, before you lock a policy, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need. @@ -339,7 +389,6 @@ Therefore, before you lock a policy, it's critical that you understand your orga Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -349,13 +398,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/New-AppRetentionComplianceRule.md similarity index 89% rename from exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-AppRetentionComplianceRule.md index 9cf40c975c..677746709d 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AppRetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-appretentioncompliancerule applicable: Security & Compliance -title: New-AppRetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-appretentioncompliancerule +schema: 2.0.0 +title: New-AppRetentionComplianceRule --- # New-AppRetentionComplianceRule @@ -63,13 +64,15 @@ This example creates a new retention rule named RetUnlimited and adds it to the ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the app retention compliance rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the app retention compliance policy that contains the app retention compliance policy rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -89,7 +95,6 @@ The Policy parameter specifies the app retention compliance policy that contains Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -124,7 +134,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -144,7 +156,6 @@ Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information Type: PswsHashtable[] Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -162,7 +176,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: Default, ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,7 +185,10 @@ Accept wildcard characters: False ``` ### -ExcludedItemClasses -The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: + +> Applicable: Security & Compliance + +The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter doesn't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: - IPM.Note.Microsoft.Conversation - IPM.Note.Microsoft.Conversation.Voice @@ -183,7 +199,7 @@ The ExcludedItemClasses parameter specifies the types of messages to exclude fro - IPM.Note.Microsoft.Voicemail.UM - IPM.Note.Microsoft.Voicemail.UM.CA -Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or non-Microsoft message classes. The values you specify aren't validated, so the parameter accepts any text value. You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. @@ -191,7 +207,6 @@ You can specify multiple item class values by using the following syntax: `"Valu Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -201,6 +216,9 @@ Accept wildcard characters: False ``` ### -ExpirationDateOption + +> Applicable: Security & Compliance + The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: - CreationAgeInDays @@ -210,7 +228,6 @@ The ExpirationDateOption parameter specifies whether the expiration date is calc Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -220,13 +237,15 @@ Accept wildcard characters: False ``` ### -MachineLearningModelIDs + +> Applicable: Security & Compliance + {{ Fill MachineLearningModelIDs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -236,6 +255,9 @@ Accept wildcard characters: False ``` ### -RetentionComplianceAction + +> Applicable: Security & Compliance + The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - Delete @@ -246,7 +268,6 @@ The RetentionComplianceAction parameter specifies the retention action for the r Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -256,6 +277,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - An integer: The hold duration in days. @@ -265,7 +289,6 @@ The RetentionDuration parameter specifies the hold duration for the retention ru Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -275,20 +298,22 @@ Accept wildcard characters: False ``` ### -RetentionDurationDisplayHint + +> Applicable: Security & Compliance + The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. - Days - Months - Years -For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal displays 1 year as the content hold duration. ```yaml Type: HoldDurationHint Parameter Sets: Default Aliases: Accepted values: Days, Months, Years -Applicable: Security & Compliance Required: False Position: Named @@ -298,13 +323,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-ApplicationAccessPolicy.md similarity index 85% rename from exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-ApplicationAccessPolicy.md index fde925d045..0e3793c107 100644 --- a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ApplicationAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection -title: New-ApplicationAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-applicationaccesspolicy +schema: 2.0.0 +title: New-ApplicationAccessPolicy --- # New-ApplicationAccessPolicy @@ -14,14 +15,14 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. +> [!IMPORTANT] +> App Access Policies will soon be replaced by Role Based Access Control for Applications. To learn more, see [Role Based Access Control for Exchange Applications](https://learn.microsoft.com/exchange/permissions-exo/application-rbac). + Use the New-ApplicationAccessPolicy cmdlet to restrict or deny access to a specific set of mailboxes by an application that uses APIs (Outlook REST, Microsoft Graph, or Exchange Web Services (EWS)). These policies are complementary to the permission scopes that are declared by the application. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). -**Note:** App Access Policies will soon be replaced by Roles Based Access Control for Applications. To learn more, see [Roles Based Access Control for Exchange Applications](https://learn.microsoft.com/exchange/permissions-exo/application-rbac). - ## SYNTAX - ``` New-ApplicationAccessPolicy -AccessRight -AppId -PolicyScopeGroupId [-Confirm] @@ -31,9 +32,9 @@ New-ApplicationAccessPolicy -AccessRight -AppId < ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -You can create a limited number of policies in your organization based on a fixed amount of space. If your organization runs out of space for these policies, you'll see the error: "The total size of App Access Policies exceeded the limit." To maximize the number of policies and reduce the amount of space that's consumed by the policies, set a one space character description for the policy. This method will allow approximately 300 policies (versus a previous limit of 100 policies). +You can create a limited number of policies in your organization based on a fixed amount of space. If your organization runs out of space for these policies, you get the error: "The total size of App Access Policies exceeded the limit." To maximize the number of policies and reduce the amount of space that's consumed by the policies, set a one space character description for the policy. This method allows approximately 300 policies (versus a previous limit of 100 policies). While scope-based resource access like Mail.Read or Calendar.Read is effective to ensure that the application can only read email or events within a mailbox and not do anything else, application access policies allow admins to enforce limits that are based on a list of mailboxes. For example, apps developed for one country/region shouldn't have access to data from other countries/regions. Or, or a CRM integration application should only access calendars in the Sales organization and no other departments. @@ -86,6 +87,9 @@ This example creates a new application access policy with the following settings ## PARAMETERS ### -AccessRight + +> Applicable: Exchange Online, Exchange Online Protection + The AccessRight parameter specifies the restriction type that you want to assign in the application access policy. Valid values are: - RestrictAccess: Allows the associated app to only access data that's associated with mailboxes specified by the PolicyScopeGroupID parameter. @@ -95,7 +99,6 @@ The AccessRight parameter specifies the restriction type that you want to assign Type: ApplicationAccessPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -AppId + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID of the apps to include in the policy. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. You can specify multiple app GUID values separated by commas or you can specify * to indicate all applications. @@ -113,7 +119,6 @@ You can specify multiple app GUID values separated by commas or you can specify Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -PolicyScopeGroupID + +> Applicable: Exchange Online, Exchange Online Protection + 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) @@ -139,7 +147,7 @@ You can use any value that uniquely identifies the recipient. For example: To verify that a recipient is a security principal, run either of the following commands: `Get-Recipient -Identity | Select-Object IsValidSecurityPrincipal` or `Get-Recipient -ResultSize unlimited | Format-Table -Auto Name,RecipientType,RecipientTypeDetails,IsValidSecurityPrincipal`. -You can't use recipients that aren't security principals with this parameter. For example, the following types of recipients won't work: +You can specify only security principals with this parameter. For example, the following types of recipients don't work: - Discovery mailboxes (DiscoveryMailbox) - Dynamic distribution groups (DynamicDistributionGroup) @@ -156,7 +164,6 @@ If you need to scope the policy to shared mailboxes, you can add the shared mail Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -166,6 +173,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -175,7 +185,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -185,13 +194,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online, Exchange Online Protection + The Description parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -201,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AuthRedirect.md b/exchange/exchange-ps/ExchangePowerShell/New-AuthRedirect.md similarity index 80% rename from exchange/exchange-ps/exchange/New-AuthRedirect.md rename to exchange/exchange-ps/ExchangePowerShell/New-AuthRedirect.md index d885bf6957..d1e633e1c3 100644 --- a/exchange/exchange-ps/exchange/New-AuthRedirect.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AuthRedirect.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-authredirect -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AuthRedirect -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-authredirect +schema: 2.0.0 +title: New-AuthRedirect --- # New-AuthRedirect @@ -31,7 +32,7 @@ New-AuthRedirect -AuthScheme -TargetUrl ## DESCRIPTION Exchange 2010 Client Access servers don't support OAuth authentication requests. Use this cmdlet to redirect OAuth authentication requests to Exchange servers that are running later versions of Exchange. This cmdlet is only useful if your organization has Exchange 2010 Client Access servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,13 +49,15 @@ This example creates an OAuth redirection object with the following settings: ## PARAMETERS ### -AuthScheme + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AuthScheme parameter specifies the authentication scheme that's used by the authentication redirection object. Typically, this value is Bearer. ```yaml Type: AuthScheme Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -TargetUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetUrl parameter specifies the FQDN of the Exchange Client Access Server that's responsible for processing the redirected OAuth authentication requests. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -89,7 +97,6 @@ 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 Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AuthServer.md b/exchange/exchange-ps/ExchangePowerShell/New-AuthServer.md similarity index 74% rename from exchange/exchange-ps/exchange/New-AuthServer.md rename to exchange/exchange-ps/ExchangePowerShell/New-AuthServer.md index 937034caeb..5099979d85 100644 --- a/exchange/exchange-ps/exchange/New-AuthServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AuthServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-authserver -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AuthServer -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-authserver +schema: 2.0.0 +title: New-AuthServer --- # New-AuthServer @@ -47,6 +48,7 @@ New-AuthServer [-Name] -AuthMetadataUrl -Type ### AppSecret ``` New-AuthServer [-Name] -Type + [-ApplicationIdentifier ] [-Confirm] [-DomainController ] [-DomainName ] @@ -58,7 +60,7 @@ New-AuthServer [-Name] -Type ## DESCRIPTION Partner applications authorized by Exchange can access their resources after they're authenticated using server-to-server authentication. A partner application can authenticate by using self-issued tokens trusted by Exchange or by using an authorization server trusted by Exchange. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,13 +74,15 @@ This command creates an authorization server object with the specified settings. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a unique name for the authorization server object. 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: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,13 +92,15 @@ Accept wildcard characters: False ``` ### -AuthMetadataUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AuthMetadataUrl parameter specifies the URL for the Microsoft 365 authorization server for your cloud-based organization. ```yaml Type: String Parameter Sets: AuthMetadataUrl, NativeClientAuthServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Type parameter specifies the type of authorization tokens that are issued by the authorization server. Valid values are: - ADFS @@ -116,7 +125,6 @@ The Type parameter specifies the type of authorization tokens that are issued by Type: AuthServerType Parameter Sets: NativeClientAuthServer, AppSecret Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -125,7 +133,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ApplicationIdentifier + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -135,7 +166,6 @@ 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 Required: False Position: Named @@ -145,13 +175,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,13 +193,19 @@ Accept wildcard characters: False ``` ### -DomainName -{{ Fill DomainName Description }} + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is available only in Exchange Server 2016 (CU18 or higher) and Exchange Server 2019 (CU7 or higher). + +The DomainName parameter links a cloud-based organization to the corresponding AuthServer object in the Multi-Tenant Exchange Hybrid. This parameter uses the syntax: "domain.onmicrosoft.com". + +For example, if the DomainName value is contoso.onmicrosoft.com, the AuthServer object is associated with the contoso cloud-based organization. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,16 +215,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the authorization server is enabled. Valid values are: -- $true: Authorization tokens that are issued by the authorization server are accepted. This is the default value +- $true: Authorization tokens that are issued by the authorization server are accepted. This value is the default - $false: Authorization tokens that are issued by the authorization server are not accepted. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,6 +236,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. We don't recommend using this switch in a production environment. @@ -204,7 +247,6 @@ We don't recommend using this switch in a production environment. Type: SwitchParameter Parameter Sets: AuthMetadataUrl, NativeClientAuthServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -214,13 +256,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-AuthenticationPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/New-AuthenticationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-AuthenticationPolicy.md index 4c06f72d1a..7859c4f25f 100644 --- a/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AuthenticationPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-authenticationpolicy -applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-AuthenticationPolicy -schema: 2.0.0 +applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-authenticationpolicy +schema: 2.0.0 +title: New-AuthenticationPolicy --- # New-AuthenticationPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-AuthenticationPolicy cmdlet to create authentication policies in your organization. @@ -56,7 +57,7 @@ New-AuthenticationPolicy [[-Name] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,13 +78,15 @@ In Exchange 2019, this example creates a new authentication policy named Researc ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name for the authentication policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthActiveSync + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthActiveSync switch specifies whether to allow Basic authentication with Exchange ActiveSync. You don't need to specify a value with this switch. @@ -103,7 +109,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthAutodiscover + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthAutodiscover switch specifies whether to allow Basic authentication with Autodiscover. You don't need to specify a value with this switch. @@ -123,7 +131,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthImap + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthImap switch specifies whether to allow Basic authentication with IMAP. You don't need to specify a value with this switch. @@ -143,7 +153,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthMapi + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthMapi switch specifies whether to allow Basic authentication with MAPI. You don't need to specify a value with this switch. @@ -163,7 +175,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthOfflineAddressBook + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthOfflineAddressBook switch specifies whether to allow Basic authentication with Offline Address Books. You don't need to specify a value with this switch. @@ -183,7 +197,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthOutlookService + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthOutlookService switch specifies whether to allow Basic authentication with the Outlook service. You don't need to specify a value with this switch. @@ -203,7 +219,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -213,6 +228,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthPop + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthPop switch specifies whether to allow Basic authentication with POP. You don't need to specify a value with this switch. @@ -223,7 +241,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +250,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthPowershell + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthPowerShell switch specifies whether to allow Basic authentication with PowerShell. You don't need to specify a value with this switch. @@ -243,7 +263,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,6 +272,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthReportingWebServices + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthReporting Web Services switch specifies whether to allow Basic authentication with reporting web services. You don't need to specify a value with this switch. @@ -263,7 +285,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -273,6 +294,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthRpc + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthRpc switch specifies whether to allow Basic authentication with RPC. You don't need to specify a value with this switch. @@ -283,7 +307,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -293,6 +316,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthSmtp + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthSmtp switch specifies whether to allow Basic authentication with SMTP. You don't need to specify a value with this switch. @@ -303,7 +329,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,6 +338,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthWebServices + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthWebServices switch specifies whether to allow Basic authentication with Exchange Web Services (EWS). You don't need to specify a value with this switch. @@ -323,7 +351,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -333,6 +360,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthActiveSync + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthActiveSync switch specifies whether to allow only modern authentication with Exchange ActiveSync in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -349,7 +379,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -359,6 +388,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthAutodiscover + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthAutodiscover switch specifies whether to allow only modern authentication with Autodiscover in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -375,7 +407,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -385,6 +416,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthImap + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthImap switch specifies whether to allow only modern authentication with IMAP in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -401,7 +435,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -411,6 +444,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthMapi + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthMapi switch specifies whether to allow only modern authentication with MAPI in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -427,7 +463,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -437,6 +472,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthOfflineAddressBook + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthOfflineAddressBook switch specifies whether to allow only modern authentication with Offline Address Books in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -453,7 +491,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -463,6 +500,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthPop + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthPop switch specifies whether to allow only modern authentication with POP in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -479,7 +519,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -489,6 +528,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthRpc + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthRpc switch specifies whether to allow only modern authentication with RPC in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -505,7 +547,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -515,6 +556,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthWebServices + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthWebServices switch specifies whether to allow only modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -531,7 +575,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -541,6 +584,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthActiveSync + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -549,7 +595,6 @@ The BlockModernAuthActiveSync switch specifies whether to block modern authentic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -559,6 +604,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthAutodiscover + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -567,7 +615,6 @@ The BlockModernAuthAutodiscover switch specifies whether to block modern authent Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -577,6 +624,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthImap + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -585,7 +635,6 @@ The BlockModernAuthImap switch specifies whether to block modern authentication Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -595,6 +644,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthMapi + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -603,7 +655,6 @@ The BlockModernAuthMapi switch specifies whether to block modern authentication Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -613,6 +664,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthOfflineAddressBook + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -621,7 +675,6 @@ The BlockModernAuthOfflineAddressBook switch specifies whether to block modern a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -631,6 +684,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthPop + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -639,7 +695,6 @@ The BlockModernAuthPop switch specifies whether to block modern authentication w Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -649,6 +704,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthRpc + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -657,7 +715,6 @@ The BlockModernAuthRpc switch specifies whether to block modern authentication w Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -667,6 +724,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthWebServices + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -675,7 +735,6 @@ The BlockModernAuthWebServices switch specifies whether to block modern authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -685,6 +744,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -694,7 +756,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -704,13 +765,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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: Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelPolicy.md index 3cf6734ddf..506ad13cb3 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-autosensitivitylabelpolicy applicable: Security & Compliance -title: New-AutoSensitivityLabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-autosensitivitylabelpolicy +schema: 2.0.0 +title: New-AutoSensitivityLabelPolicy --- # New-AutoSensitivityLabelPolicy @@ -66,18 +67,20 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned New-AutoSensitivityLabelPolicy -Name "GlobalPolicy" -Comment "Primary policy" -SharePointLocation "https://my.url","https://my.url2" -OneDriveLocation "https://my.url3","https://my.url4" -Mode TestWithoutNotifications -ApplySensitivityLabel "Test" ``` -This example creates an auto-labeling policy named GlobalPolicy for the specified SharePoint Online and OneDrive for Business locations with the label "Test". The new policy has a descriptive comment and will be in simulation mode on creation. +This example creates an auto-labeling policy named GlobalPolicy for the specified SharePoint and OneDrive locations with the label "Test". The new policy has a descriptive comment and is created in simulation mode. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the auto-labeling policy. If the value contains spaces, enclose the value with quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -ApplySensitivityLabel + +> Applicable: Security & Compliance + The ApplySensitivityLabel parameter specifies the label to use for the auto-labeling policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -128,7 +138,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -138,9 +147,12 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedBy -The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the 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). -To use this parameter, OneDrive for Business sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). +> Applicable: Security & Compliance + +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -150,7 +162,6 @@ You can't use this parameter with the OneDriveSharedBy parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf + +> Applicable: Security & Compliance + {{ Fill ExceptIfOneDriveSharedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -176,13 +189,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -192,13 +207,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -208,6 +225,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies whether to include email messages in the policy. The valid value for this parameter is All. If you don't want to include email messages in the policy, don't use this parameter (the default value is blank or $null). You can use this parameter in the following procedures: @@ -228,7 +248,6 @@ You can't specify inclusions and exclusions in the same policy. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -238,6 +257,9 @@ Accept wildcard characters: False ``` ### -ExchangeSender + +> Applicable: Security & Compliance + The ExchangeSender parameter specifies the users whose email is included in the policy. You identify the users by email address. You can specify internal or external email addresses. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -250,7 +272,6 @@ You can't use this parameter with the ExchangeSenderException or ExchangeSenderM Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -260,6 +281,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderException + +> Applicable: Security & Compliance + The ExchangeSenderException parameter specifies the internal users whose email is excluded from the policy. You identify the users by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -272,7 +296,6 @@ You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf p Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -282,6 +305,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf + +> Applicable: Security & Compliance + The ExchangeSenderMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -296,7 +322,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -306,6 +331,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException + +> Applicable: Security & Compliance + The ExchangeSenderMemberOfException parameter specifies the distribution groups or mail-enabled security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -320,7 +348,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -330,6 +357,9 @@ Accept wildcard characters: False ``` ### -ExternalMailRightsManagementOwner + +> Applicable: Security & Compliance + The ExternalMailRightsManagementOwner parameter specifies the email address of a user mailbox that's used to encrypt incoming email messages from external senders using RMS. This parameter works only on Exchange locations, and the policy must apply a label that has an encryption action. @@ -338,7 +368,6 @@ This parameter works only on Exchange locations, and the policy must apply a lab Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -348,6 +377,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -356,7 +388,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -366,13 +397,15 @@ Accept wildcard characters: False ``` ### -Locations + +> Applicable: Security & Compliance + {{ Fill Locations Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -382,9 +415,12 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Security & Compliance + The Mode parameter specifies the action and notification level of the auto-labeling policy. Valid values are: -- Enable: The policy is enabled for actions and notifications. This is the default value. +- Enable: The policy is enabled for actions and notifications. This value is the default. - 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. @@ -394,7 +430,6 @@ Type: PolicyMode Parameter Sets: (All) Aliases: Accepted values: Enable, TestWithNotifications, TestWithoutNotifications, Disable, PendingDeletion -Applicable: Security & Compliance Required: False Position: Named @@ -404,13 +439,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -420,13 +457,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -436,7 +475,10 @@ Accept wildcard characters: False ``` ### -OneDriveLocation -The OneDriveLocation parameter specifies the OneDrive for Business sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites. + +> Applicable: Security & Compliance + +The OneDriveLocation parameter specifies the OneDrive sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -444,7 +486,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -454,7 +495,10 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException -This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +This parameter specifies the OneDrive sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -462,7 +506,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -472,9 +515,12 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy -The OneDriveSharedBy parameter specifies the users to include in the 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). -To use this parameter, OneDrive for Business sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). +> Applicable: Security & Compliance + +The OneDriveSharedBy parameter specifies the users to include in the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -484,7 +530,6 @@ You can't use this parameter with the ExceptIfOneDriveSharedBy parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -494,13 +539,15 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf + +> Applicable: Security & Compliance + {{ Fill OneDriveSharedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -510,10 +557,13 @@ Accept wildcard characters: False ``` ### -OverwriteLabel + +> Applicable: Security & Compliance + The OverwriteLabel parameter specifies whether to overwrite a manual label. Valid values are: - $true: Overwrite the manual label. -- $false: Don't overwrite the manual label. This is the default value. +- $false: Don't overwrite the manual label. This value is the default. This parameter works only on Exchange locations. @@ -521,7 +571,6 @@ This parameter works only on Exchange locations. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -531,6 +580,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + 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. @@ -539,7 +591,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -549,13 +600,15 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -565,13 +618,15 @@ Accept wildcard characters: False ``` ### -Priority -The Priority parameter specifies the priority of the policy. The highest priority policy will take action over lower priority policies if two policies are applicable for a file. + +> Applicable: Security & Compliance + +The Priority parameter specifies the priority of the policy. The highest priority policy takes precedence over lower priority policies if two policies are applicable for a file. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -581,13 +636,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -597,13 +654,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -613,15 +672,17 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to a policy until they have been indexed. +> Applicable: Security & Compliance + +The SharePointLocation parameter specifies the SharePoint sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint sites can't be added to a policy until they have been indexed. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -631,7 +692,10 @@ Accept wildcard characters: False ``` ### -SharePointLocationException -This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +This parameter specifies the SharePoint sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -639,7 +703,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -649,13 +712,15 @@ Accept wildcard characters: False ``` ### -UnifiedAuditLogEnabled + +> Applicable: Security & Compliance + {{ Fill UnifiedAuditLogEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -665,13 +730,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md b/exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelRule.md similarity index 92% rename from exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelRule.md index 5b058fa5c7..e8a9aa3f46 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-autosensitivitylabelrule applicable: Security & Compliance -title: New-AutoSensitivityLabelRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-autosensitivitylabelrule +schema: 2.0.0 +title: New-AutoSensitivityLabelRule --- # New-AutoSensitivityLabelRule @@ -97,13 +98,15 @@ This example creates an autolabeling rule named "SocialSecurityRule" that is ass ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the auto-labeling policy rule. If the value contains spaces, enclose the value with quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Security & Compliance + The Workload parameter specifies the workload. Valid values are: - Exchange @@ -124,7 +130,6 @@ Type: Workload Parameter Sets: (All) Aliases: Accepted values: Exchange, SharePoint, OneDriveForBusiness -Applicable: Security & Compliance Required: True Position: Named @@ -134,6 +139,9 @@ Accept wildcard characters: False ``` ### -AccessScope + +> Applicable: Security & Compliance + The AccessScope parameter specifies a condition for the auto-labeling policy rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule is applied to content that's accessible inside the organization. @@ -145,7 +153,6 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Required: False Position: Named @@ -155,13 +162,15 @@ Accept wildcard characters: False ``` ### -ActivationDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -171,6 +180,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The AnyOfRecipientAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -185,7 +197,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -195,6 +206,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -205,7 +219,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -215,13 +228,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -240,7 +258,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -250,15 +267,21 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"; minCount="1"; minConfidence="85"})`. +Exact Data Match sensitive information types are supported only groups. For example: + +`@(@{operator="And"; groups=@(@{name="Default"; operator="Or"; sensitivetypes=@(@{id="<>"; name="<>"; maxcount="-1"; classifiertype="ExactMatch"; mincount="100"; confidencelevel="Medium"})})})` + ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -268,13 +291,15 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ContentExtensionMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for words in file name extensions. You can specify multiple words separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -284,6 +309,9 @@ Accept wildcard characters: False ``` ### -ContentPropertyContainsWords + +> Applicable: Security & Compliance + The ContentPropertyContainsWords parameter specifies a condition for the auto-labeling policy rule that's based on a property match in content. The rule is applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -292,7 +320,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -302,16 +329,18 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the auto-labeling policy rule is enabled or disabled. Valid values are: - $true: The rule is disabled. -- $false: The rule is enabled. This is the default value. +- $false: The rule is enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -321,13 +350,15 @@ Accept wildcard characters: False ``` ### -DocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill DocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -337,6 +368,9 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected + +> Applicable: Security & Compliance + The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -346,7 +380,6 @@ The DocumentIsPasswordProtected parameter specifies a condition for the auto-lab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -356,6 +389,9 @@ Accept wildcard characters: False ``` ### -DocumentIsUnsupported + +> Applicable: Security & Compliance + The DocumentIsUnsupported parameter specifies a condition for the auto-labeling policy rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -365,7 +401,6 @@ The DocumentIsUnsupported parameter specifies a condition for the auto-labeling Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -375,6 +410,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesWords + +> Applicable: Security & Compliance + The DocumentNameMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -387,7 +425,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -397,6 +434,9 @@ Accept wildcard characters: False ``` ### -DocumentSizeOver + +> Applicable: Security & Compliance + The DocumentSizeOver parameter specifies a condition for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -407,7 +447,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this condition in auto-labeling policy rules that are scoped only to Exchange. @@ -415,7 +455,6 @@ You can use this condition in auto-labeling policy rules that are scoped only to Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -425,6 +464,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAccessScope + +> Applicable: Security & Compliance + The ExceptIfAccessScopeAccessScope parameter specifies an exception for the auto-labeling policy rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule isn't applied to content that's accessible inside the organization. @@ -436,7 +478,6 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Required: False Position: Named @@ -446,6 +487,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. - Single word: `"no_reply"` @@ -460,7 +504,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -470,6 +513,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -480,7 +526,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -490,6 +535,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the auto-labeling policy rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -498,7 +546,6 @@ This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minC Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -508,13 +555,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words in file name extensions. You can specify multiple words separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -524,6 +573,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentPropertyContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentPropertyContainsWords parameter specifies an exception for the auto-labeling policy rule that's based on a property match in content. The rule is not applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -532,7 +584,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -542,13 +593,15 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill ExceptIfDocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -558,6 +611,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected + +> Applicable: Security & Compliance + The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -567,7 +623,6 @@ The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -577,6 +632,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsUnsupported + +> Applicable: Security & Compliance + The ExceptIfDocumentIsUnsupported parameter specifies an exception for the auto-labeling policy rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -586,7 +644,6 @@ The ExceptIfDocumentIsUnsupported parameter specifies an exception for the auto- Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -596,6 +653,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesWords + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -608,7 +668,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -618,6 +677,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentSizeOver + +> Applicable: Security & Compliance + The ExceptIfDocumentSizeOver parameter specifies an exception for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -628,7 +690,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this exception in auto-labeling policy rules that are scoped only to Exchange. @@ -636,7 +698,6 @@ You can use this exception in auto-labeling policy rules that are scoped only to Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -646,6 +707,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + The ExceptIfFrom parameter specifies an exception for the auto-labeling policy rule that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -659,7 +723,6 @@ The ExceptIfFrom parameter specifies an exception for the auto-labeling policy r Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -669,6 +732,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfFromAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -683,7 +749,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -693,6 +758,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -703,7 +771,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -713,6 +780,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Security & Compliance + The ExceptIfFromMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent by group members. You identify the group members by their 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"`. @@ -721,7 +791,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -731,6 +800,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -739,7 +811,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -749,6 +820,9 @@ Accept wildcard characters: False ``` ### -ExceptIfProcessingLimitExceeded + +> Applicable: Security & Compliance + The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule that looks for files where scanning couldn't complete. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -758,7 +832,6 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the aut Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -768,13 +841,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -784,6 +859,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + The ExceptIfSenderDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -792,7 +870,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -802,6 +879,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIPRanges + +> Applicable: Security & Compliance + The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -814,7 +894,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -824,6 +903,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + The ExceptIfSentTo parameter specifies an exception for the auto-labeling policy rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -841,7 +923,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -851,6 +932,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Security & Compliance + The ExceptIfSentToMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -859,7 +943,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -869,6 +952,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -879,7 +965,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -889,13 +974,15 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -905,13 +992,15 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -921,6 +1010,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Security & Compliance + The FromAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -935,7 +1027,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -945,6 +1036,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Security & Compliance + The FromAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -955,7 +1049,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -965,13 +1058,15 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -981,6 +1076,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -989,7 +1087,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -999,13 +1096,15 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1015,6 +1114,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the auto-labeling policy that contains the auto-labeling policy rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -1025,7 +1127,6 @@ The Policy parameter specifies the auto-labeling policy that contains the auto-l Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -1035,13 +1136,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1051,6 +1154,9 @@ Accept wildcard characters: False ``` ### -ProcessingLimitExceeded + +> Applicable: Security & Compliance + The ProcessingLimitExceeded parameter specifies a condition for the auto-labeling policy rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -1060,7 +1166,6 @@ The ProcessingLimitExceeded parameter specifies a condition for the auto-labelin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1070,13 +1175,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Security & Compliance + The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1086,10 +1193,13 @@ Accept wildcard characters: False ``` ### -ReportSeverityLevel + +> Applicable: Security & Compliance + The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: - None: You can't select this value if the rule has no actions configured. -- Low: This is the default value. +- Low: This value is the default. - Medium - High @@ -1098,7 +1208,6 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Required: False Position: Named @@ -1108,18 +1217,20 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Security & Compliance + The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - Ignore - RetryThenBlock -- Blank (the value $null): This is the default value. +- Blank (the value $null): This value is the default. ```yaml Type: PolicyRuleErrorAction Parameter Sets: (All) Aliases: Accepted values: Ignore, RetryThenBlock -Applicable: Security & Compliance Required: False Position: Named @@ -1129,6 +1240,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Security & Compliance + The SenderDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -1137,7 +1251,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1147,6 +1260,9 @@ Accept wildcard characters: False ``` ### -SenderIPRanges + +> Applicable: Security & Compliance + The SenderIpRanges parameter specifies a condition for the auto-sensitivity policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -1159,7 +1275,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1169,6 +1284,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + The SentTo parameter specifies a condition for the auto-sensitivity policy rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1186,7 +1304,6 @@ You can use this condition in auto-sensitivity policies that are scoped only to Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1196,6 +1313,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Security & Compliance + The SentToMemberOf parameter specifies a condition for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -1204,7 +1324,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1214,13 +1333,15 @@ Accept wildcard characters: False ``` ### -SourceType + +> Applicable: Security & Compliance + {{ Fill SourceType Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1230,6 +1351,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Security & Compliance + The SubjectMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -1240,7 +1364,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1250,13 +1373,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-AutodiscoverVirtualDirectory.md similarity index 79% rename from exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-AutodiscoverVirtualDirectory.md index d79e23f643..b1efe2e9ee 100644 --- a/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AutodiscoverVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-autodiscovervirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AutodiscoverVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-autodiscovervirtualdirectory +schema: 2.0.0 +title: New-AutodiscoverVirtualDirectory --- # New-AutodiscoverVirtualDirectory @@ -48,7 +49,7 @@ If your organization has multiple email domains and each requires its own Autodi When you're creating an Autodiscover virtual directory, we recommend that you enable Secure Sockets Layer (SSL) for the Autodiscover service. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,13 +63,15 @@ This example creates the virtual directory autodiscover under the website autodi ## PARAMETERS ### -ApplicationRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ApplicationRoot parameter specifies the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AppPoolId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AppPoolId parameter specifies the IIS application pool in which the virtual directory runs. We recommend that you leave this parameter at its default setting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,16 +99,18 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: -- $true: Basic authentication is enabled. This is the default value. +- $true: Basic authentication is enabled. This value is the default. - $false: Basic authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -122,7 +132,6 @@ 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 Required: False Position: Named @@ -132,16 +141,18 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. -- $false: Digest authentication is disabled. This is the default value. +- $false: Digest authentication is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,19 +180,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,16 +204,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,10 +225,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -220,7 +240,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,6 +249,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ExternalUrl parameter specifies the URL used to connect to the virtual directory from outside the network firewall. @@ -238,7 +260,6 @@ The ExternalUrl parameter specifies the URL used to connect to the virtual direc Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -248,6 +269,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The InternalUrl parameter specifies the URL used to connect to the virtual directory from inside the network firewall. @@ -256,7 +280,6 @@ The InternalUrl parameter specifies the URL used to connect to the virtual direc Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -266,16 +289,18 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OAuthAuthentication parameter specifies whether OAuth authentication is enabled on the virtual directory. Valid values are: -- $true: OAuth authentication is enabled. This is the default value. +- $true: OAuth authentication is enabled. This value is the default. - $false: OAuth authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -285,13 +310,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -301,6 +328,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -312,7 +342,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,6 +351,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -333,7 +365,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -343,13 +374,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -359,13 +392,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -375,16 +410,18 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: -- $true: Integrated Windows authentication is enabled. This is the default value. +- $true: Integrated Windows authentication is enabled. This value is the default. - $false: Integrated Windows authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -394,16 +431,18 @@ Accept wildcard characters: False ``` ### -WSSecurityAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are: -- $true: WS-Security authentication is enabled. This is the default value. +- $true: WS-Security authentication is enabled. This value is the default. - $false: WS-Security authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AvailabilityConfig.md b/exchange/exchange-ps/ExchangePowerShell/New-AvailabilityConfig.md similarity index 87% rename from exchange/exchange-ps/exchange/New-AvailabilityConfig.md rename to exchange/exchange-ps/ExchangePowerShell/New-AvailabilityConfig.md index 7019d149b7..d9d4f7cd86 100644 --- a/exchange/exchange-ps/exchange/New-AvailabilityConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AvailabilityConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-availabilityconfig applicable: Exchange Online -title: New-AvailabilityConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-availabilityconfig +schema: 2.0.0 +title: New-AvailabilityConfig --- # New-AvailabilityConfig @@ -30,7 +31,7 @@ New-AvailabilityConfig ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example creates a new availability configuration to share free/busy informa ## PARAMETERS ### -AllowedTenantIds + +> Applicable: Exchange Online + 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: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -OrgWideAccount + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -95,13 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md b/exchange/exchange-ps/ExchangePowerShell/New-AvailabilityReportOutage.md similarity index 87% rename from exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md rename to exchange/exchange-ps/ExchangePowerShell/New-AvailabilityReportOutage.md index 4c31737bf7..031e3b3e2f 100644 --- a/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AvailabilityReportOutage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-availabilityreportoutage applicable: Exchange Server 2010 -title: New-AvailabilityReportOutage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-availabilityreportoutage +schema: 2.0.0 +title: New-AvailabilityReportOutage --- # New-AvailabilityReportOutage @@ -31,7 +32,7 @@ New-AvailabilityReportOutage [-SiteName] -Comment -DowntimeMin ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example creates a timed injected outage scoped to site Site1 on the selecte ## PARAMETERS ### -SiteName + +> Applicable: Exchange Server 2010 + The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010 + The Comment parameter specifies why the outage was inserted. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -DowntimeMinutes + +> Applicable: Exchange Server 2010 + The DowntimeMinutes parameter specifies the number of minutes of downtime to insert into the outage report. ```yaml Type: Double Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -93,13 +100,15 @@ Accept wildcard characters: False ``` ### -ReportDate + +> Applicable: Exchange Server 2010 + The ReportDate parameter specifies the date to query for the outage report. ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -109,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -118,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -128,6 +139,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010 + 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. @@ -136,7 +150,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -146,13 +159,15 @@ Accept wildcard characters: False ``` ### -ReportingDatabase + +> Applicable: Exchange Server 2010 + The ReportingDatabase parameter specifies the name of the database on the reporting server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -162,13 +177,15 @@ Accept wildcard characters: False ``` ### -ReportingServer + +> Applicable: Exchange Server 2010 + The ReportingServer parameter specifies the name of the reporting database server to connect to. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -178,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-CaseHoldPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/New-CaseHoldPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-CaseHoldPolicy.md index 0564008fde..c401cd7ed0 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-CaseHoldPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-caseholdpolicy applicable: Security & Compliance -title: New-CaseHoldPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-caseholdpolicy +schema: 2.0.0 +title: New-CaseHoldPolicy --- # New-CaseHoldPolicy @@ -17,9 +18,9 @@ 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] -> 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**. +> 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 isn't created, and content locations aren't 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). +> 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/exchangepowershell/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). @@ -48,20 +49,22 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned New-CaseHoldPolicy -Name "Regulation 123 Compliance" -Case "123 Compliance Case" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" ``` -This example creates a case hold policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint Online site for the eDiscovery case named "123 Compliance Case". +This example creates a case hold policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint site for the eDiscovery case named "123 Compliance Case". Remember, after you create the policy, you need to create a rule for the policy by using the New-CaseHoldRule cmdlet. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the case hold policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the eDiscovery case that you want to associate with the case hold policy. You can use the following values to identify the eDiscovery case: - Name @@ -82,7 +88,6 @@ You can find these values by running the command: Get-ComplianceCase | Format-Ta Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -117,7 +127,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -127,16 +136,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: -- $true: The policy is enabled. This is the default value. +- $true: The policy is enabled. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - A mailbox @@ -165,7 +179,6 @@ If no mailboxes are specified, then no mailboxes are placed on hold. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -175,6 +188,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -183,7 +199,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -193,13 +208,15 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + The PublicFolderLocation parameter specifies that you want to include all public folders in the case hold policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -209,7 +226,10 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online and OneDrive for Business sites to include. You identify a site by its URL value. + +> Applicable: Security & Compliance + +The SharePointLocation parameter specifies the SharePoint and OneDrive sites to include. You identify a site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -219,7 +239,6 @@ Sites can't be added to the policy until they have been indexed. If no sites are Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -229,13 +248,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-CaseHoldRule.md b/exchange/exchange-ps/ExchangePowerShell/New-CaseHoldRule.md similarity index 93% rename from exchange/exchange-ps/exchange/New-CaseHoldRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-CaseHoldRule.md index c169c5dfff..40f1e04187 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-CaseHoldRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-caseholdrule applicable: Security & Compliance -title: New-CaseHoldRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-caseholdrule +schema: 2.0.0 +title: New-CaseHoldRule --- # New-CaseHoldRule @@ -54,13 +55,15 @@ This example places email messages received by the recipients between December 1 ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the case hold rule. 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 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the case hold policy that contains the rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -80,7 +86,6 @@ The Policy parameter specifies the case hold policy that contains the rule. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -115,7 +125,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. Use this parameter to create a query-based hold so only the content that matches the specified search query is placed on hold. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -133,7 +145,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -143,16 +154,18 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the case hold rule is enabled or disabled. Valid values are: - $true: The rule is disabled. -- $false: The rule is enabled. This is the default value. +- $false: The rule is enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -162,13 +175,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/New-ClassificationRuleCollection.md similarity index 81% rename from exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/New-ClassificationRuleCollection.md index 2f589a0ceb..66d655e57c 100644 --- a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ClassificationRuleCollection.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-classificationrulecollection -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-ClassificationRuleCollection -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-classificationrulecollection +schema: 2.0.0 +title: New-ClassificationRuleCollection --- # New-ClassificationRuleCollection ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-ClassificationRuleCollection cmdlet to import new classification rule collections into your organization. @@ -31,7 +32,7 @@ New-ClassificationRuleCollection [-FileData] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example imports the classification rule collection file C:\\My Documents\\E ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FileData parameter specifies the classification rule collection file you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -53,7 +57,6 @@ 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, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -74,7 +80,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ClientAccessArray.md b/exchange/exchange-ps/ExchangePowerShell/New-ClientAccessArray.md similarity index 90% rename from exchange/exchange-ps/exchange/New-ClientAccessArray.md rename to exchange/exchange-ps/ExchangePowerShell/New-ClientAccessArray.md index 93bc940c38..17f59324a8 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessArray.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ClientAccessArray.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-clientaccessarray applicable: Exchange Server 2010 -title: New-ClientAccessArray -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-clientaccessarray +schema: 2.0.0 +title: New-ClientAccessArray --- # New-ClientAccessArray @@ -33,7 +34,7 @@ The New-ClientAccessArray cmdlet creates an object that represents a load balanc Client Access arrays allow Outlook clients in an Active Directory site to access the Client Access servers in the array by using RPC over TCP to a single, unified, fully qualified domain name (FQDN). The RpcClientAccessServer property of new mailbox databases is automatically populated with the FQDN of the Client Access array and this value is used during the creation of Outlook profiles for mailboxes in those databases. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example creates a Client Access array named China CAS Array with the FQDN v ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the descriptive name of the Client Access array. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). If the value contains spaces, you can't use the Name value to identify the Client Access array for the Get-ClientAccessArray, Remove-ClientAccessArray, or Set-ClientAccessArray cmdlets. If you don't use this parameter, the default value is the host part of the Fqdn parameter value. For example, if the Fqdn value is casarray01.contoso.com, the default name value is casarray01. @@ -62,7 +66,6 @@ If you don't use this parameter, the default value is the host part of the Fqdn Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010 + The Fqdn parameter specifies the fully qualified domain name of the Client Access array (for example, casarray01.contoso.com). This is the value that RPC over TCP clients use to connect to the Client Access servers in the array. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010 + The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: - Name @@ -100,7 +108,6 @@ To see a list of available sites, use the Get-ADSite cmdlet. Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -119,7 +129,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -145,13 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ClientAccessRule.md similarity index 85% rename from exchange/exchange-ps/exchange/New-ClientAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ClientAccessRule.md index af5e934438..23ba2b0095 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ClientAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-clientaccessrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-ClientAccessRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-clientaccessrule +schema: 2.0.0 +title: New-ClientAccessRule --- # New-ClientAccessRule @@ -15,7 +16,7 @@ ms.reviewer: > [!NOTE] > Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). -This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-ClientAccessRule cmdlet to create client access rules. Client access rules help you control access to your organization based on the properties of the connection. @@ -70,7 +71,7 @@ Protocols that don't support authentication type filters: - REST - UniversalOutlook -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,7 +80,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi New-ClientAccessRule -Name AllowRemotePS -Action Allow -AnyOfProtocols RemotePowerShell -Priority 1 ``` -This example creates a highest priority rule that allows access to remote PowerShell. This rule is an important safeguard to preserve access to your organization. Without this rule, if you create rules that block your access to remote PowerShell, or that block all protocols for everyone, you'll lose the ability to fix the rules yourself (you'll need to call Microsoft Customer Service and Support). +This example creates a highest priority rule that allows access to remote PowerShell. This rule is an important safeguard to preserve access to your organization. Without this rule, if you create rules that block your access to remote PowerShell, or that block all protocols for everyone, you lose the ability to fix the rules yourself (you need to call Microsoft Customer Service and Support). ### Example 2 ```powershell @@ -91,13 +92,15 @@ This example creates a new client access rule named Block ActiveSync that blocks ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the client access rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. ```yaml Type: ClientAccessRulesAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -AnyOfAuthenticationTypes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The AnyOfAuthenticationTypes parameter specifies a condition for the client access rule that's based on the client's authentication type. @@ -143,7 +151,6 @@ You can enter multiple values separated by commas. Don't use quotation marks. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -153,6 +160,9 @@ Accept wildcard characters: False ``` ### -AnyOfClientIPAddressesOrRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AnyOfClientIPAddressesOrRanges parameter specifies a condition for the client access rule that's based on the client's IPv4 or IPv6 address. Valid values are: - Single IP address: For example, 192.168.1.1 or 2001:DB8::2AA:FF:C0A8:640A. @@ -167,7 +177,6 @@ For more information about IPv6 addresses and syntax, see this Exchange 2013 top Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -177,6 +186,9 @@ Accept wildcard characters: False ``` ### -AnyOfProtocols + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AnyOfProtocols parameter specifies a condition for the client access rule that's based on the client's protocol. Valid values for this parameter are: @@ -202,7 +214,6 @@ You can enter multiple values separated by commas. Don't use quotation marks. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,13 +223,15 @@ Accept wildcard characters: False ``` ### -AnyOfSourceTcpPortNumbers + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -228,6 +241,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -239,7 +255,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -249,6 +264,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -257,7 +275,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -267,13 +284,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the client access rule is enabled or disabled. Valid values for this parameter are $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -283,6 +302,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfAuthenticationTypes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptAnyOfAuthenticationTypes parameter specifies an exception for the client access rule that's based on the client's authentication type. @@ -303,7 +325,6 @@ You can enter multiple values separated by commas. Don't use quotation marks. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,6 +334,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfClientIPAddressesOrRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExceptAnyOfClientIPAddressesOrRanges parameter specifies an exception for the client access rule that's based on the client's IPv4 or IPv6 address. Valid values are: - Single IP address: For example, 192.168.1.1 or 2001:DB8::2AA:FF:C0A8:640A. @@ -327,7 +351,6 @@ For more information about IPv6 addresses and syntax, see this Exchange 2013 top Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,6 +360,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfProtocols + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptAnyOfProtocols parameter specifies an exception for the client access rule that's based on the client's protocol. @@ -362,7 +388,6 @@ You can enter multiple values separated by commas. Don't use quotation marks. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -372,13 +397,15 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfSourceTcpPortNumbers + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -388,13 +415,15 @@ Accept wildcard characters: False ``` ### -ExceptUserIsMemberOf + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -404,6 +433,9 @@ Accept wildcard characters: False ``` ### -ExceptUsernameMatchesAnyOfPatterns + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. @@ -414,7 +446,6 @@ You can enter multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -424,6 +455,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -438,7 +472,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -448,6 +481,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Scope parameter specifies the scope of the client access rule. Valid values are: - Users: The rule only applies to end-user connections. @@ -457,7 +493,6 @@ The Scope parameter specifies the scope of the client access rule. Valid values Type: ClientAccessRulesScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -467,13 +502,15 @@ Accept wildcard characters: False ``` ### -UserIsMemberOf + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -483,6 +520,9 @@ Accept wildcard characters: False ``` ### -UsernameMatchesAnyOfPatterns + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. This parameter does not work with the -AnyOfProtocols UniversalOutlook parameter. @@ -493,7 +533,6 @@ You can enter multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -503,6 +542,9 @@ Accept wildcard characters: True ``` ### -UserRecipientFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPATH filter syntax to identify the user based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties. @@ -542,7 +584,6 @@ For detailed information about OPATH filter syntax in Exchange, see [Additional Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -552,13 +593,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceCase.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceCase.md similarity index 93% rename from exchange/exchange-ps/exchange/New-ComplianceCase.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceCase.md index 6366bff3d0..a92b1a421c 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceCase.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceCase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancecase applicable: Security & Compliance -title: New-ComplianceCase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancecase +schema: 2.0.0 +title: New-ComplianceCase --- # New-ComplianceCase @@ -55,13 +56,15 @@ This example creates a new eDiscovery Premium case named Coho Case 03082020 and ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the compliance case. 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 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -CaseType + +> Applicable: Security & Compliance + The CaseType parameter specifies the type of compliance case that you want to create. Valid values are: - AdvancedEdiscovery: eDiscovery Premium cases are used to manage legal or other types of investigations. @@ -78,7 +84,7 @@ The CaseType parameter specifies the type of compliance case that you want to cr - ComplianceWorkspace: This value is reserved for internal Microsoft use. - DataInvestigation: Data investigation cases are used to investigate data spillage incidents. - DSR: Data Subject Request (DSR) cases are used to manage General Data Protection Regulation (GDPR) DSR investigations. -- eDiscovery: eDiscovery (also called eDiscovery Standard) cases are used to manage legal or other types of investigations. This is the default value. +- eDiscovery: eDiscovery (also called eDiscovery Standard) cases are used to manage legal or other types of investigations. This value is the default. - InsiderRisk: Insider risk cases are use to manage insider risk management cases. Typically, insider risk management cases are manually created in the Microsoft Purview compliance portal to further investigate activity based on a risk alert. - InternalInvestigation: This value is reserved for internal Microsoft use. - SupervisionPolicy: This type of case corresponds to communication compliance policy. @@ -87,7 +93,6 @@ The CaseType parameter specifies the type of compliance case that you want to cr Type: ComplianceCaseType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -106,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the compliance case. The maximum length is 256 characters. 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 @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -ExternalId + +> Applicable: Security & Compliance + The ExternalId parameter specifies an optional ID or external case number that you can associate with the new compliance case. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -164,13 +177,15 @@ Accept wildcard characters: False ``` ### -SecondaryCaseType + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -180,13 +195,15 @@ Accept wildcard characters: False ``` ### -SourceCaseType + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -196,13 +213,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEvent.md similarity index 89% rename from exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEvent.md index 8cb6b6f70b..5c071cf02f 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEvent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentionevent applicable: Security & Compliance -title: New-ComplianceRetentionEvent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-complianceretentionevent +schema: 2.0.0 +title: New-ComplianceRetentionEvent --- # New-ComplianceRetentionEvent @@ -55,13 +56,15 @@ This example creates a compliance retention event named Research Project Employe ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the compliance retention event. 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 @@ -71,7 +74,10 @@ Accept wildcard characters: False ``` ### -AssetId -The AssetId parameter specifies the Property:Value pair found in the properties of SharePoint or OneDrive for Business documents that's used for retention. For example: + +> Applicable: Security & Compliance + +The AssetId parameter specifies the Property:Value pair found in the properties of SharePoint or OneDrive documents that's used for retention. For example: - Product codes that you can use to retain content for only a specific product. - Project codes that you can use to retain content for only a specific project. @@ -81,7 +87,6 @@ The AssetId parameter specifies the Property:Value pair found in the properties Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -116,7 +126,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -EventDateTime + +> Applicable: Security & Compliance + 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". @@ -150,7 +164,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -160,6 +173,9 @@ Accept wildcard characters: False ``` ### -EventTags + +> Applicable: Security & Compliance + The EventTags parameter specifies the GUID value of the labels that are associated with the compliance retention event. Run the following command to see the available GUID values: `Get-ComplianceTag | Format-Table Name,GUID`. You can specify multiple values separated by commas. @@ -168,7 +184,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -178,13 +193,15 @@ Accept wildcard characters: False ``` ### -EventType -The EventType parameter specifies the GUID value of the event that will start the retention period for labels that use this event type. Run the following command to see the available GUID values: `Get-ComplianceRetentionEventType | Format-Table Name,GUID`. + +> Applicable: Security & Compliance + +The EventType parameter specifies the GUID value of the event that starts the retention period for labels that use this event type. Run the following command to see the available GUID values: `Get-ComplianceRetentionEventType | Format-Table Name,GUID`. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -194,13 +211,15 @@ Accept wildcard characters: False ``` ### -ExchangeAssetIdQuery + +> Applicable: Security & Compliance + The ExchangeAssetIdQuery parameter specifies the keywords that are used to scope Exchange content for the compliance retention event. For details, see [Keyword queries and search conditions for Content Search](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -210,13 +229,15 @@ Accept wildcard characters: False ``` ### -PreviewOnly + +> Applicable: Security & Compliance + {{ Fill PreviewOnly Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -226,13 +247,15 @@ Accept wildcard characters: False ``` ### -SharePointAssetIdQuery -The SharePointAssetIdQuery parameter specifies one or more the Property:Value pairs that you've specified in the properties (also known as Columns) of SharePoint and OneDrive for Business documents to scope the compliance retention event. + +> Applicable: Security & Compliance + +The SharePointAssetIdQuery parameter specifies one or more the Property:Value pairs that you've specified in the properties (also known as Columns) of SharePoint and OneDrive documents to scope the compliance retention event. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -242,13 +265,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEventType.md similarity index 93% rename from exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEventType.md index f8097fbf29..6d4515cd3e 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEventType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentioneventtype applicable: Security & Compliance -title: New-ComplianceRetentionEventType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-complianceretentioneventtype +schema: 2.0.0 +title: New-ComplianceRetentionEventType --- # New-ComplianceRetentionEventType @@ -43,13 +44,15 @@ This example creates a new retention event type name Fabrikam Project ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the retention event type. 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 @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -75,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -84,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearch.md similarity index 81% rename from exchange/exchange-ps/exchange/New-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearch.md index c3cd46e78f..1d65d88cca 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: New-ComplianceSearch -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancesearch +schema: 2.0.0 +title: New-ComplianceSearch --- # New-ComplianceSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-ComplianceSearch cmdlet to create compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. You use this cmdlet to define the search criteria. @@ -49,7 +50,7 @@ A compliance search requires at least one location. For example, mailboxes using After you create a compliance search using the New-ComplianceSearch cmdlet, you run the search using the Start-ComplianceSearch cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. @@ -81,6 +82,9 @@ This example creates a new compliance search named AnnBeebe-InactiveMailbox that ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Name parameter specifies the name of the compliance search. If the value contains spaces, enclose the value in quotation marks. Don't use spaces in the value of this parameter if you plan on using the Case parameter. If the Name parameter contains spaces, the value of the ExchangeLocation parameter is cleared when you use the Case parameter. @@ -89,7 +93,6 @@ Don't use spaces in the value of this parameter if you plan on using the Case pa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -99,10 +102,13 @@ Accept wildcard characters: False ``` ### -AllowNotFoundExchangeLocationsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The AllowNotFoundExchangeLocationsEnabled parameter specifies whether to include mailboxes other than regular user mailboxes in the compliance search. Valid values are: - $true: The search doesn't try to validate the existence of the mailbox before proceeding. This value is required if you want to search mailboxes that don't resolve as regular mailboxes. -- $false: The search tries to validate the existence of the mailbox before proceeding. If you specify a mailbox that isn't a regular user mailbox, the search will fail. This is the default value. +- $false: The search tries to validate the existence of the mailbox before proceeding. If you specify a mailbox that isn't a regular user mailbox, the search will fail. This value is the default. The mailbox types that are affected by the value of this parameter include: @@ -115,7 +121,6 @@ The mailbox types that are affected by the value of this parameter include: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -125,6 +130,9 @@ Accept wildcard characters: False ``` ### -Case + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. 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. @@ -137,7 +145,6 @@ If the Name parameter contains spaces, the value of the ExchangeLocation paramet Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -156,7 +166,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -174,7 +186,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -184,13 +195,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Description parameter specifies an optional description for the compliance search. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -200,6 +213,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include. Valid values are: - A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Microsoft 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. @@ -212,7 +228,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -222,6 +237,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocationExclusion + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -235,7 +253,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -245,6 +262,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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. @@ -253,7 +273,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -263,17 +282,19 @@ Accept wildcard characters: False ``` ### -HoldNames + +> Applicable: Security & Compliance + 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 specified eDiscovery case will be searched. You use the value All for this parameter. You also need to specify the name of an eDiscovery case by using the Case parameter. +The HoldNames parameter specifies the content locations placed on hold in the specified eDiscovery case are searched. You use the value All for this parameter. You also need to specify the name of an eDiscovery case by using the Case parameter. -Also, if a content location was placed on a query-based case hold, only items that are on hold will be searched when you run 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. +Also, if a content location was placed on a query-based case hold, only items that are on hold are searched when you run 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. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -283,13 +304,15 @@ Accept wildcard characters: False ``` ### -IncludeOrgContent + +> Applicable: Security & Compliance + {{ Fill IncludeOrgContent Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -299,18 +322,20 @@ Accept wildcard characters: False ``` ### -IncludeUserAppContent + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The IncludeUserAppContent parameter specifies that you want to search the cloud-based storage location for users who don't have a regular Microsoft 365 user account in your organization. These types of users include users without an Exchange Online license who use Office applications, Microsoft 365 guest users, and on-premises users whose identity is synchronized with your Microsoft 365 organization. Valid values are: -- $true: The cloud-based storage location for the users specified in the ExchangeLocation parameter will be included in the search. If you use the value All for the ExchangeLocation parameter, the cloud-based storage location for any guest or on-premises user will be included in the search. -- $false: The cloud-based storage location for the users specified in the ExchangeLocation parameter won't be included in the search. This is the default value. +- $true: The cloud-based storage location for the users specified in the ExchangeLocation parameter are included in the search. If you use the value All for the ExchangeLocation parameter, the cloud-based storage location for any guest or on-premises user are included in the search. +- $false: The cloud-based storage location for the users specified in the ExchangeLocation parameter isn't included in the search. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -320,6 +345,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Language parameter specifies the language for the compliance search. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -328,7 +356,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -338,6 +365,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -346,7 +376,6 @@ This parameter is reserved for internal Microsoft use. Type: ComplianceJobLogLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,6 +385,9 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The PublicFolderLocation parameter specifies that you want to include all public folders in the search. You use the value All for this parameter. @@ -364,7 +396,6 @@ The PublicFolderLocation parameter specifies that you want to include all public Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -374,6 +405,9 @@ Accept wildcard characters: False ``` ### -RefinerNames + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -382,7 +416,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -392,9 +425,12 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. +The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -402,7 +438,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -412,6 +447,9 @@ Accept wildcard characters: False ``` ### -SharePointLocationExclusion + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -420,7 +458,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -430,6 +467,9 @@ Accept wildcard characters: False ``` ### -StatusMailRecipients + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -438,7 +478,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -448,13 +487,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearchAction.md similarity index 71% rename from exchange/exchange-ps/exchange/New-ComplianceSearchAction.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearchAction.md index 74634f84e1..e8e407d23b 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearchAction.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancesearchaction -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: New-ComplianceSearchAction -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancesearchaction +schema: 2.0.0 +title: New-ComplianceSearchAction --- # New-ComplianceSearchAction ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-ComplianceSearchAction cmdlet to create actions for content searches in Exchange Server and in the Microsoft Purview compliance portal. @@ -98,7 +99,7 @@ After you create a content search using the New-ComplianceSearch cmdlet and run In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In Microsoft 365, the account that you use to run this cmdlet must have a valid Microsoft 365 license assigned. @@ -120,12 +121,14 @@ 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 ``` -This example deletes the search results returned by a content search named Remove Phishing Message. Note that unindexed items aren't deleted when you use the Purge parameter. +This example deletes the search results returned by a content search named Remove Phishing Message. Unindexed items aren't deleted when you use the Purge parameter. ### Example 4 ```powershell @@ -134,9 +137,14 @@ 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 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The SearchName parameter specifies the name of the existing content search to associate with the content search action. You can specify multiple content searches separated by commas. You can find the content search by running the command Get-ComplianceSearch | Format-Table -Auto Name,Status. @@ -145,7 +153,6 @@ You can find the content search by running the command Get-ComplianceSearch | Fo Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -155,6 +162,9 @@ Accept wildcard characters: False ``` ### -ActionName + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The ActionName parameter specifies a name for the content search action. You use this parameter only when you specify multiple content searches in the SearchName parameter. @@ -163,7 +173,6 @@ The ActionName parameter specifies a name for the content search action. You use Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -173,7 +182,10 @@ Accept wildcard characters: False ``` ### -ArchiveFormat -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +This parameter is deprecated and no longer used. To specify the format for Exchange search results, use the ExchangeArchiveFormat parameter. To specify the format for SharePoint and OneDrive search results, use the SharePointArchiveFormat parameter. @@ -181,7 +193,6 @@ To specify the format for Exchange search results, use the ExchangeArchiveFormat Type: ComplianceExportArchiveFormat Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -202,7 +216,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -212,13 +225,17 @@ Accept wildcard characters: False ``` ### -EnableDedupe + +> Applicable: Security & Compliance + +This parameter is available only in the cloud-based service. + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: Export Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -228,6 +245,11 @@ Accept wildcard characters: False ``` ### -ExchangeArchiveFormat + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + This parameter is functional only in the cloud-based service. This parameter requires the Export role in Security & Compliance PowerShell. By default, this role is assigned only to the eDiscovery Manager role group. @@ -237,7 +259,7 @@ The ExchangeArchiveFormat parameter specifies how to export Exchange search resu - PerUserPst: One PST file for each mailbox. - SinglePst: One PST file that contains all exported messages. - SingleFolderPst: One PST file with a single root folder for the entire export. -- IndividualMessage: Export each message as an .msg message file. This is the default value. +- IndividualMessage: Export each message as an .msg message file. This value is the default. - PerUserZip: One ZIP file for each mailbox. Each ZIP file contains the exported .msg message files from the mailbox. - SingleZip: One ZIP file for all mailboxes. The ZIP file contains all exported .msg message files from all mailboxes. This output setting is available only in PowerShell. @@ -247,7 +269,6 @@ To specify the format for SharePoint and OneDrive search results, use the ShareP Type: ComplianceExportArchiveFormat Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -257,6 +278,11 @@ Accept wildcard characters: False ``` ### -Export + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +**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. @@ -269,7 +295,6 @@ To only return the information about each detected item in a report, use the Rep Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -279,13 +304,17 @@ Accept wildcard characters: False ``` ### -FileTypeExclusionsForUnindexedItems + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + The FileTypeExclusionsForUnindexedItems specifies the file types to exclude because they can't be indexed. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -295,6 +324,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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. @@ -303,7 +335,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -313,6 +344,9 @@ Accept wildcard characters: False ``` ### -Format + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + In Security & Compliance PowerShell, this parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. The Format parameter specifies the format of the search results when you use the Export switch. Valid values are: @@ -325,7 +359,6 @@ The Format parameter specifies the format of the search results when you use the Type: ComplianceDataTransferFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -335,13 +368,15 @@ Accept wildcard characters: False ``` ### -IncludeCredential + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The IncludeCredential switch specifies whether to include the credential in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -351,18 +386,22 @@ Accept wildcard characters: False ``` ### -IncludeSharePointDocumentVersions + +> Applicable: Security & Compliance + +**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: - $true: Export all versions of the document. -- $false: Export only the current published version of the topic. This is the default value. +- $false: Export only the current published version of the topic. This value is the default. ```yaml Type: Boolean Parameter Sets: Export Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -372,13 +411,15 @@ Accept wildcard characters: False ``` ### -JobOptions + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -388,6 +429,11 @@ Accept wildcard characters: False ``` ### -NotifyEmail + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +**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. @@ -398,7 +444,6 @@ The recipient you specify is in the To: field of the message. Type: String Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -408,6 +453,11 @@ Accept wildcard characters: False ``` ### -NotifyEmailCC + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +**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. @@ -418,7 +468,6 @@ The recipient you specify is in the Cc: field of the message. Type: String Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -428,6 +477,9 @@ Accept wildcard characters: False ``` ### -Preview + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + In Security & Compliance PowerShell, this parameter requires the Preview role. By default, this role is assigned only to the eDiscovery Manager role group. The Preview switch specifies the action for the content search is to preview the results that match the search criteria. You don't need to specify a value with this switch. @@ -436,7 +488,6 @@ The Preview switch specifies the action for the content search is to preview the Type: SwitchParameter Parameter Sets: Preview Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -446,6 +497,9 @@ Accept wildcard characters: False ``` ### -Purge + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + **Note**: In Security & Compliance PowerShell, this switch is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. 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. @@ -454,7 +508,7 @@ The Purge switch specifies the action for the content search is to remove items **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). +- 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 need 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. @@ -462,7 +516,6 @@ The Purge switch specifies the action for the content search is to remove items Type: SwitchParameter Parameter Sets: Purge Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -472,18 +525,20 @@ Accept wildcard characters: False ``` ### -PurgeType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + **Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. The PurgeType parameter specifies how to remove items when the action is Purge. Valid values are: - SoftDelete: Purged items are recoverable by users until the deleted item retention period expires. -- HardDelete (cloud only): Purged items are marked for permanent removal from the mailbox and will be permanently removed the next time the mailbox is processed by the Managed Folder Assistant. If single item recovery is enabled on the mailbox, purged items will be permanently removed after the deleted item retention period expires. +- HardDelete (cloud only): Purged items are marked for permanent removal from the mailbox and are permanently removed the next time the mailbox is processed by the Managed Folder Assistant. If single item recovery is enabled on the mailbox, purged items are permanently removed after the deleted item retention period expires. ```yaml Type: ComplianceDestroyType Parameter Sets: Purge Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -493,13 +548,15 @@ Accept wildcard characters: False ``` ### -ReferenceActionName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -509,13 +566,15 @@ Accept wildcard characters: False ``` ### -Region + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -525,6 +584,11 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +**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. @@ -533,7 +597,6 @@ The Report switch specifies the action for the content search is to export a rep Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -543,13 +606,17 @@ Accept wildcard characters: False ``` ### -RetentionReport + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + The RetentionReport switch specifies the action for the content search is to export a retention report. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -559,13 +626,15 @@ Accept wildcard characters: False ``` ### -RetryOnError + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The RetryOnError switch specifies whether to retry the action on any items that failed without re-running the entire action all over again. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -575,22 +644,24 @@ Accept wildcard characters: False ``` ### -Scenario + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + In Security & Compliance PowerShell, this parameter requires the Preview role. By default, this role is assigned only to the eDiscovery Manager role group. -The Scenario parameter specifies the scenario type when you use the Export switch. Valid values are: +The Scenario parameter specifies the scenario type. Valid values are: - AnalyzeWithZoom: Prepare the search results for processing in Microsoft Purview eDiscovery Premium. -- General: Exports the search results to the local computer. Emails are exported to .pst files. SharePoint and OneDrive for Business documents are exported in their native Office formats. -- GenerateReportsOnly: -- Inventory: -- RetentionReports: -- TriagePreview: +- General: Exports the search results to the local computer. Emails are exported to .pst files. SharePoint and OneDrive documents are exported in their native Office formats. +- GenerateReportsOnly +- Inventory +- RetentionReports +- TriagePreview ```yaml Type: ComplianceSearchActionScenario Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -600,6 +671,11 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +**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 @@ -610,7 +686,6 @@ The Scope parameter specifies the items to include when the action is Export. Va Type: ComplianceExportScope Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -620,6 +695,9 @@ Accept wildcard characters: False ``` ### -SearchNames + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The SearchNames parameter specifies the names of the existing content searches to associate with the content search action. You separate the content search names by commas. @@ -630,7 +708,6 @@ You can find content search names by running the command Get-ComplianceSearch | Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -640,13 +717,18 @@ Accept wildcard characters: False ``` ### -SharePointArchiveFormat + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + +**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. The SharePointArchiveFormat parameter specifies how to export SharePoint and OneDrive search results. Valid values are: -- IndividualMessage: Export the files uncompressed. This is the default value. +- IndividualMessage: Export the files uncompressed. This value is the default. - PerUserZip: One ZIP file for each user. Each ZIP file contains the exported files for the user. - SingleZip: One ZIP file for all users. The ZIP file contains all exported files from all users. This output setting is available only in PowerShell. @@ -656,7 +738,6 @@ To specify the format for Exchange search results, use the ExchangeArchiveFormat Type: ComplianceExportArchiveFormat Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -666,13 +747,19 @@ Accept wildcard characters: False ``` ### -ShareRootPath + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 Type: String Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -682,13 +769,15 @@ Accept wildcard characters: False ``` ### -Version + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -698,6 +787,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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. @@ -706,7 +798,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSecurityFilter.md similarity index 83% rename from exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceSecurityFilter.md index 49ac31e0d9..f5a9a1faf0 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSecurityFilter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancesecurityfilter -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: New-ComplianceSecurityFilter -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancesecurityfilter +schema: 2.0.0 +title: New-ComplianceSecurityFilter --- # New-ComplianceSecurityFilter @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-ComplianceSecurityFilter cmdlet to create compliance security filters in the Microsoft Purview compliance portal. These filters allow specified users to search only a subset of mailboxes and SharePoint Online or OneDrive for Business sites in your Microsoft 365 organization. +Use the New-ComplianceSecurityFilter cmdlet to create compliance security filters in the Microsoft Purview compliance portal. These filters allow specified users to search only a subset of mailboxes and SharePoint or OneDrive sites in your Microsoft 365 organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -75,6 +76,9 @@ This example prevents the user from performing any compliance search actions on ## PARAMETERS ### -Action + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Action parameter specifies that type of search action that the filter is applied to. Valid values are: - Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. @@ -87,7 +91,6 @@ The Action parameter specifies that type of search action that the filter is app Type: ComplianceSecurityFilterActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -FilterName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The FilterName parameter specifies the name for the compliance security filter. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Users + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Users parameter specifies the user who gets this filter applied to their searches. Valid values are: - One or more users: Identify users by their alias or email address. You can specify multiple values separated by commas. @@ -125,7 +133,6 @@ You can't specify distribution groups with this parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -144,7 +154,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -154,13 +163,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Description parameter specifies a description for the compliance security filter. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -170,11 +181,14 @@ Accept wildcard characters: False ``` ### -Filters + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Filters parameter specifies the search criteria for the compliance security filter. The filters are applied to the users specified by the Users parameter. You can create three different types of filters: - Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is `Mailbox_`, where `` is a mailbox property value. For example,`"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"` allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). - Mailbox content filter: Specifies the mailbox content the assigned users can search for. Valid syntax is `MailboxContent_`, where `` specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example, `"MailboxContent_Recipients -like 'contoso.com'"` allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable email properties, see [Keyword queries for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions#searchable-email-properties). -- Site and site content filter: There are two SharePoint Online and OneDrive for Business site-related filters that you can create: `Site_` (specifies site-related properties. For example,`"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"` allows users to only search for content in the `https://contoso.sharepoint.com/sites/doctors` site collection) and `SiteContent_` (specifies content-related properties. For example, `"SiteContent_FileExtension -eq 'docx'"` allows users to only search for Word documents). For a list of searchable site properties, see [Overview of crawled and managed properties in SharePoint Server](https://learn.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. +- Site and site content filter: There are two SharePoint and OneDrive site-related filters that you can create: `Site_` (specifies site-related properties. For example,`"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"` allows users to only search for content in the `https://contoso.sharepoint.com/sites/doctors` site collection) and `SiteContent_` (specifies content-related properties. For example, `"SiteContent_FileExtension -eq 'docx'"` allows users to only search for Word documents). For a list of searchable site properties, see [Overview of crawled and managed properties in SharePoint Server](https://learn.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. You can specify multiple filters of the same type. For example, `"Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'"`. @@ -184,7 +198,6 @@ You need to create a search permissions filter to explicitly prevent users from Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -Region + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Region parameter specifies the satellite location for multi-geo tenants to conduct eDiscovery searches in. Valid values are: - APC: Asia-Pacific @@ -213,7 +229,6 @@ If you don't use this parameter in a multi-geo tenant, eDiscovery searches are p Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -223,13 +238,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceTag.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceTag.md similarity index 89% rename from exchange/exchange-ps/exchange/New-ComplianceTag.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceTag.md index 9de8c0fca4..a1340d5858 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancetag applicable: Security & Compliance -title: New-ComplianceTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancetag +schema: 2.0.0 +title: New-ComplianceTag --- # New-ComplianceTag @@ -75,13 +76,15 @@ This example creates a new label named HR Content with the following settings: ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the label. 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 @@ -91,13 +94,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: PriorityCleanup Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -RetentionAction + +> Applicable: Security & Compliance + The RetentionAction parameter specifies the action for the label. Valid values are: - Delete @@ -115,9 +123,8 @@ The RetentionAction parameter specifies the action for the label. Valid values a ```yaml Type: String -Parameter Sets: PriorityCleanup +Parameter Sets: Default, PriorityCleanup Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -126,20 +133,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance +### -RetentionDuration -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Security & Compliance -### -RetentionDuration The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - A positive integer. @@ -147,9 +144,8 @@ The RetentionDuration parameter specifies the number of days to retain the conte ```yaml Type: Unlimited -Parameter Sets: PriorityCleanup +Parameter Sets: Default, PriorityCleanup Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -158,20 +154,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Unlimited -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance +### -RetentionType -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Security & Compliance -### -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 @@ -181,9 +167,8 @@ The RetentionType parameter specifies whether the retention duration is calculat ```yaml Type: String -Parameter Sets: PriorityCleanup +Parameter Sets: Default, PriorityCleanup Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -192,27 +177,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance +### -AutoApprovalPeriod -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Security & Compliance -### -AutoApprovalPeriod {{ Fill AutoApprovalPeriod Description }} ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -222,13 +196,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -238,13 +214,15 @@ Accept wildcard characters: False ``` ### -ComplianceTagForNextStage + +> Applicable: Security & Compliance + {{ Fill ComplianceTagForNextStage Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -254,6 +232,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -263,7 +244,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -273,6 +253,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Security & Compliance + The EventType specifies the retention rule that's associated with the label. You can use any value that uniquely identifies the rule. For example: - Name @@ -285,7 +268,6 @@ You can use the Get-RetentionComplianceRule cmdlet to view the available retenti Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -295,6 +277,9 @@ Accept wildcard characters: False ``` ### -FilePlanProperty + +> Applicable: Security & Compliance + The FilePlanProperty parameter specifies the file plan properties to include in the label. To view the file plan property names that you need to use in this parameter, run the following commands: - `Get-FilePlanPropertyAuthority | Format-List Name` @@ -328,7 +313,6 @@ You use the second variable as the value for this parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -338,6 +322,9 @@ Accept wildcard characters: False ``` ### -FlowId + +> Applicable: Security & Compliance + **Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. The FlowId parameter specifies the Power Automate flow to run at the end of the retention period. A valid value for this parameter is the GUID value of the flow. @@ -351,7 +338,6 @@ You can find the GUID value of the flow by using either of the following methods Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -361,6 +347,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -369,7 +358,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -379,16 +367,18 @@ Accept wildcard characters: False ``` ### -IsRecordLabel + +> Applicable: Security & Compliance + The IsRecordLabel parameter specifies whether the label is a record label. Valid values are: - $true: The label is a record label. Once the label is applied to content, the label can't be removed. -- $false: The label isn't a record label. This is the default value. +- $false: The label isn't a record label. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -398,13 +388,15 @@ Accept wildcard characters: False ``` ### -IsRecordUnlockedAsDefault + +> Applicable: Security & Compliance + {{ Fill IsRecordUnlockedAsDefault Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -414,6 +406,9 @@ Accept wildcard characters: False ``` ### -MultiStageReviewProperty + +> Applicable: Security & Compliance + The MultiStageReviewProperty parameter specifies the multi-stage review properties to include in the label. This parameter uses the following syntax: `'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'` @@ -428,7 +423,6 @@ This syntax is a JSON object that defines each review stage id, review stage nam Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -438,13 +432,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Security & Compliance + The Notes parameter specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -454,13 +450,15 @@ Accept wildcard characters: False ``` ### -Regulatory + +> Applicable: Security & Compliance + {{ Fill Regulatory Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -470,13 +468,15 @@ Accept wildcard characters: False ``` ### -ReviewerEmail + +> Applicable: Security & Compliance + 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. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -486,13 +486,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DataClassification.md b/exchange/exchange-ps/ExchangePowerShell/New-DataClassification.md similarity index 79% rename from exchange/exchange-ps/exchange/New-DataClassification.md rename to exchange/exchange-ps/ExchangePowerShell/New-DataClassification.md index ee21f6fc1a..814dda3ec9 100644 --- a/exchange/exchange-ps/exchange/New-DataClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DataClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dataclassification -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-DataClassification -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dataclassification +schema: 2.0.0 +title: New-DataClassification --- # New-DataClassification @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [New-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. +In Exchange Online, this cmdlet is replaced by the [New-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the New-DataClassification cmdlet to create data classification rules that use document fingerprints. @@ -35,7 +36,7 @@ New-DataClassification [-Name] -Description -Fingerprints Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Description parameter specifies a description for the data classification rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -Fingerprints -The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-fingerprint) or the Examples section. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a name for the data classification rule. The value must be less than 256 characters. The value of this parameter is used in the Policy Tip that's presented to users in Outlook on the web. @@ -97,7 +105,6 @@ The value of this parameter is used in the Policy Tip that's presented to users Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -ClassificationRuleCollectionIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: ClassificationRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -123,6 +132,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -132,7 +144,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -158,6 +171,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Locale parameter specifies the language that's associated with the data classification rule. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -168,7 +184,6 @@ You can add additional language translations to the data classification rule by Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -178,13 +193,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DataEncryptionPolicy.md similarity index 87% rename from exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DataEncryptionPolicy.md index fb8c9ddfeb..b38fc22108 100644 --- a/exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DataEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dataencryptionpolicy applicable: Exchange Online -title: New-DataEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dataencryptionpolicy +schema: 2.0.0 +title: New-DataEncryptionPolicy --- # New-DataEncryptionPolicy @@ -35,7 +36,7 @@ Data encryption policy cmdlets are the Exchange Online part of Customer Key. For You can assign a data encryption policy to a mailbox by using the DataEncryptionPolicy parameter on the Set-Mailbox cmdlet in Exchange Online PowerShell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example creates a data encryption policy named US Mailboxes with the specif ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -AzureKeyIDs + +> Applicable: Exchange Online + The AzureKeyIDs parameter specifies the URI values of the Azure Key Vault keys to associate with the data encryption policy. You need to specify at least two Azure Key Vault keys separated by commas. For example, `"https://contosoWestUSvault01.vault.azure.net/keys/USA_Key_01","https://contosoEastUSvault01.vault.azure.net/keys/USA_Key_02"`. To find the URI value for an Azure Key Vault, replace `` with the name of the vault, and run this command in Azure Rights Management PowerShell: `Get-AzureKeyVaultKey -VaultName ).id`. For more information, see [About Azure Key Vault](https://learn.microsoft.com/azure/key-vault/general/overview). @@ -73,7 +79,6 @@ To find the URI value for an Azure Key Vault, replace `` with the nam Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -92,7 +100,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online + The Description parameter specifies an optional description for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -134,16 +145,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter enables or disable the data encryption policy. Valid values are: -- $true: The policy is enabled. This is the default value. +- $true: The policy is enabled. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -153,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroup.md similarity index 83% rename from exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroup.md index 8b05d74e98..ef1b7794e4 100644 --- a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-databaseavailabilitygroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-DatabaseAvailabilityGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-databaseavailabilitygroup +schema: 2.0.0 +title: New-DatabaseAvailabilityGroup --- # New-DatabaseAvailabilityGroup @@ -51,9 +52,9 @@ The following combinations of options and behaviors are available: If the witness server that you specify isn't an Exchange server, you need to add the Exchange Trusted Subsystem universal security group (USG) to the local Administrators group on the witness server. If the witness server is a directory server, you need to add the Exchange Trusted Subsystem USG to the Builtin\\Administrators group. These security permissions are necessary to ensure that Exchange can create a directory and share on the witness server as needed. -In Windows Server 2012 R2 or later, a DAG is created without a cluster administrative access point by default. In this scenario, you don't need to provide any IP addresses to the DAG. However, in all supported versions of Windows, you have the option of assigning static IP addresses to the DAG by using the DatabaseAvailabilityGroupIpAddresses parameter. If you specify Any or 0.0.0.0, the task attempts to use Dynamic Host Configuration Protocol (DHCP) to obtain IP addresses. If you omit this parameter or configure the parameter with a value of None or 255.255.255.255, the DAG will not have a cluster administrative access point. +In Windows Server 2012 R2 or later, a DAG is created without a cluster administrative access point by default. In this scenario, you don't need to provide any IP addresses to the DAG. However, in all supported versions of Windows, you have the option of assigning static IP addresses to the DAG by using the DatabaseAvailabilityGroupIpAddresses parameter. If you specify Any or 0.0.0.0, the task attempts to use Dynamic Host Configuration Protocol (DHCP) to obtain IP addresses. If you omit this parameter or configure the parameter with a value of None or 255.255.255.255, the DAG doesn't have a cluster administrative access point. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -76,18 +77,20 @@ This example creates the DAG named DAG2 with a witness server named SERVER2. The New-DatabaseAvailabilityGroup -Name DAG3 -WitnessServer SERVER1 -WitnessDirectory C:\DAG3 -DatabaseAvailabilityGroupIpAddresses 10.0.0.8,192.168.0.8 ``` -This example creates a DAG named DAG3. DAG3 is configured to use SERVER1 for the witness server, and a witness directory on SERVER1 of C:\\DAG3. DAG3 is assigned multiple static IP addresses because the MAPI network for the DAG contains or will contain multiple subnets (10.0.0.x and 192.168.0.x). +This example creates a DAG named DAG3. DAG3 is configured to use SERVER1 for the witness server, and a witness directory on SERVER1 of C:\\DAG3. DAG3 is assigned multiple static IP addresses because the MAPI network for the DAG contains multiple subnets (10.0.0.x and 192.168.0.x). ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a unique name for the new DAG of up to 15 characters. The name you use must not conflict with any computer name in the organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -ActivityState + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ActivityStateOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -122,7 +130,6 @@ 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 Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -DagConfiguration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: DatabaseAvailabilityGroupConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,13 +157,15 @@ Accept wildcard characters: False ``` ### -DatabaseAvailabilityGroupIpAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DatabaseAvailabilityGroupIpAddresses parameter specifies one or more static IPv4 addresses to the DAG when a Mailbox server is added to a DAG. If you specify the value Any or 0.0.0.0, the system attempts to lease one or more IPv4 addresses from a DHCP server to assign to the DAG. If you don't use this parameter, or if you specify the value 255.255.255.255 or None, the DAG is created without a cluster administrative access point. ```yaml Type: IPAddress[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -FileSystem + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FileSystem parameter specifies the file system that's used for the DAG. Valid values are: - NTFS @@ -189,7 +205,6 @@ The FileSystem parameter specifies the file system that's used for the DAG. Vali Type: FileSystemMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -ThirdPartyReplication -The ThirdPartyReplication parameter specifies to configure and enable a DAG to use third-party replication that leverages the Exchange Third Party Replication API instead of the built-in continuous replication. Valid values are Enabled and Disabled. After this mode is enabled, it can't be changed. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ThirdPartyReplication parameter specifies to configure and enable a DAG to use non-Microsoft replication that leverages the Exchange Third Party Replication API instead of the built-in continuous replication. Valid values are Enabled and Disabled. After this mode is enabled, it can't be changed. ```yaml Type: ThirdPartyReplicationMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,13 +232,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -231,13 +250,15 @@ Accept wildcard characters: False ``` ### -WitnessDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WitnessDirectory parameter specifies the name of the directory on the witness server used to store file share witness data. The directory and share should be hosted on an Exchange server other than any of the Mailbox servers in the DAG. This allows an Exchange administrator to maintain operational control over the directory. The specified directory can't be used by any other DAGs, or used for any purpose other than for the witness server. If you don't use this parameter, the default witness directory is used. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -247,13 +268,15 @@ Accept wildcard characters: False ``` ### -WitnessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WitnessServer parameter specifies the name of a server used as a quorum witness when the DAG contains an even number of members. The specified server can't be a member of the DAG that's configured to use it. A stand-alone Mailbox server, or a Mailbox server in another DAG is recommended. ```yaml Type: FileShareWitnessServerName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroupNetwork.md similarity index 77% rename from exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroupNetwork.md index cdf95fa60f..03792b5b80 100644 --- a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroupNetwork.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-databaseavailabilitygroupnetwork -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-DatabaseAvailabilityGroupNetwork -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-databaseavailabilitygroupnetwork +schema: 2.0.0 +title: New-DatabaseAvailabilityGroupNetwork --- # New-DatabaseAvailabilityGroupNetwork @@ -33,7 +34,7 @@ New-DatabaseAvailabilityGroupNetwork [-Name] [-DatabaseAvailabilityGrou ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example creates the DAG network DAG1Repl in the DAG DAG1. A subnet of 10.0. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of the DAG network being created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -DatabaseAvailabilityGroup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DatabaseAvailabilityGroup parameter specifies the name of the DAG that'll use the network being created. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 2 @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -88,7 +96,6 @@ 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 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Description parameter specifies an optional description of up to 256 characters for the DAG network being created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +123,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +141,15 @@ Accept wildcard characters: False ``` ### -IgnoreNetwork + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreNetwork parameter excludes the DAG network from use by the DAG. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,13 +159,15 @@ Accept wildcard characters: False ``` ### -ReplicationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplicationEnabled parameter specifies whether the DAG network being created is enabled for continuous replication. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,13 +177,15 @@ Accept wildcard characters: False ``` ### -Subnets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Subnets parameter specifies the subnets for the DAG network being created. ```yaml Type: DatabaseAvailabilityGroupSubnetId[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-DeliveryAgentConnector.md similarity index 81% rename from exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeliveryAgentConnector.md index 42534c6c9d..40b22a450d 100644 --- a/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeliveryAgentConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-deliveryagentconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-DeliveryAgentConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-deliveryagentconnector +schema: 2.0.0 +title: New-DeliveryAgentConnector --- # New-DeliveryAgentConnector @@ -38,7 +39,7 @@ New-DeliveryAgentConnector [-Name] -AddressSpaces ## DESCRIPTION Delivery agent connectors are used to route messages addressed to foreign systems that don't utilize the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in the Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://learn.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,13 +63,15 @@ The address space for the connector is c=US;a=Fabrikam;p=Contoso. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AddressSpaces parameter specifies the domain names that the delivery agent connector is responsible for. The complete syntax for entering an address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. Enclose each address space in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -DeliveryProtocol + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -135,7 +147,6 @@ 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 Required: False Position: Named @@ -145,6 +156,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -153,7 +167,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +176,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the delivery agent connector is enabled. The default value is $true. @@ -171,7 +187,6 @@ The default value is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +196,15 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. If the value of this parameter is $false, the connector can be used by all Mailbox servers in your organization. If the value of this parameter is $true, the connector can only be used by Mailbox servers in the same Active Directory site. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,13 +214,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConcurrentConnections parameter specifies the maximum number of concurrent connections this connector accepts from a specific IP address. The default value is 5. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -213,6 +232,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxMessageSize parameter specifies the maximum size of a message that's allowed to pass through this connector. When you enter a value, qualify the value with one of the following units: - B (bytes) @@ -226,7 +248,6 @@ Unqualified values are treated as bytes. The valid input range for this paramete Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,13 +257,15 @@ Accept wildcard characters: False ``` ### -MaxMessagesPerConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxMessagesPerConnection parameter specifies the maximum number of messages this connector accepts per connection. The connector terminates the connection after this limit is reached, and the sending server has to initiate a new connection to send more messages. The default value is 20. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,6 +275,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceTransportServers parameter specifies the list of Mailbox servers that host this connector. You can specify more than one server by separating their names with commas. By default, only the local server on which the command is executed is added to this parameter. @@ -260,7 +286,6 @@ By default, only the local server on which the command is executed is added to t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,13 +295,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessPolicy.md index b8386092bb..e43f3ef571 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconditionalaccesspolicy applicable: Security & Compliance -title: New-DeviceConditionalAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-deviceconditionalaccesspolicy +schema: 2.0.0 +title: New-DeviceConditionalAccessPolicy --- # New-DeviceConditionalAccessPolicy @@ -54,13 +55,15 @@ This example creates a new mobile device conditional access policy named Human R ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the policy. If the value contains spaces, enclose the value in double quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -105,16 +112,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -132,7 +144,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessRule.md similarity index 85% rename from exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessRule.md index 102c007035..a2aff5f1c4 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconditionalaccessrule applicable: Security & Compliance -title: New-DeviceConditionalAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-deviceconditionalaccessrule +schema: 2.0.0 +title: New-DeviceConditionalAccessRule --- # New-DeviceConditionalAccessRule @@ -103,6 +104,9 @@ This example creates a new mobile device conditional access rule with the follow ## PARAMETERS ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the mobile device conditional access policy that this rule is associated with. You can use any value that uniquely identifies the policy. For example: - Name @@ -113,7 +117,6 @@ The Policy parameter specifies the mobile device conditional access policy that Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -123,6 +126,9 @@ Accept wildcard characters: False ``` ### -TargetGroups + +> Applicable: Security & Compliance + The TargetGroups parameter specifies the security groups that this rule applies to. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. You can specify multiple groups separated by commas. @@ -131,7 +137,6 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -141,16 +146,18 @@ Accept wildcard characters: False ``` ### -AccountName + +> Applicable: Security & Compliance + The AccountName parameter specifies the account name. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -160,16 +167,18 @@ Accept wildcard characters: False ``` ### -AccountUserName + +> Applicable: Security & Compliance + The AccountUserName parameter specifies the account user name. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -179,11 +188,14 @@ Accept wildcard characters: False ``` ### -AllowAppStore + +> Applicable: Security & Compliance + The AllowAppStore parameter specifies whether to allow access to the app store on devices. Valid values for this parameter are: - $true: Access to the app store is allowed. - $false: Access to the app store isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -194,7 +206,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -204,11 +215,14 @@ Accept wildcard characters: False ``` ### -AllowAssistantWhileLocked + +> Applicable: Security & Compliance + The AllowAssistantWhileLocked parameter specifies whether to allow the use of the voice assistant while devices are locked. Valid values for this parameter are: - $true: The voice assistant can be used while devices are locked. - $false: The voice assistant can't be used while devices are locked. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -216,7 +230,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -226,11 +239,14 @@ Accept wildcard characters: False ``` ### -AllowConvenienceLogon + +> Applicable: Security & Compliance + The AllowConvenienceLogon parameter specifies whether to allow convenience logons on devices. Valid values for this parameter are: - $true: Convenience logons are allowed. - $false: Convenience logons aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -238,7 +254,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -248,11 +263,14 @@ Accept wildcard characters: False ``` ### -AllowDiagnosticSubmission + +> Applicable: Security & Compliance + The AllowDiagnosticSubmission parameter specifies whether to allow diagnostic submissions from devices. Valid values for this parameter are: - $true: Diagnostic submissions are allowed. - $false: Diagnostic submissions aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -264,7 +282,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -274,11 +291,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudBackup + +> Applicable: Security & Compliance + The AllowiCloudBackup parameter specifies whether to allow Apple iCloud Backup from devices. Valid values for this parameter are: - $true: iCloud Backup is allowed. - $false: iCloud Backup isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -289,7 +309,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -299,11 +318,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudDocSync + +> Applicable: Security & Compliance + The AllowiCloudDocSync parameter specifies whether to allow Apple iCloud Documents & Data sync on devices. Valid values for this parameter are: - $true: iCloud Documents & Data sync is allowed. - $false: iCloud Documents & Data sync isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -314,7 +336,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -324,11 +345,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudPhotoSync + +> Applicable: Security & Compliance + The AllowiCloudPhotoSync parameter specifies whether to allow Apple iCloud Photos sync on devices. Valid values for this parameter are: - $true: iCloud Photos sync is allowed. - $false: iCloud Photo sync isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -339,7 +363,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -349,11 +372,14 @@ Accept wildcard characters: False ``` ### -AllowJailbroken + +> Applicable: Security & Compliance + The AllowJailbroken parameter specifies whether to allow access to your organization by jailbroken or rooted devices. - $true: Jailbroken devices are allowed. - $false: Jailbroken devices aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -364,7 +390,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -374,11 +399,14 @@ Accept wildcard characters: False ``` ### -AllowPassbookWhileLocked + +> Applicable: Security & Compliance + The AllowPassbookWhileLocked parameter specifies whether to allow the use of Apple Passbook while devices are locked. Valid values for this parameter are: - $true: Passbook is available while devices are locked. - $false: Passbook isn't available while devices are locked. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -386,7 +414,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -396,11 +423,14 @@ Accept wildcard characters: False ``` ### -AllowScreenshot + +> Applicable: Security & Compliance + The AllowScreenshot parameter specifies whether to allow screenshots on devices. Valid values for this parameter are: - $true: Screenshots are allowed. - $false: Screenshots aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -411,7 +441,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -421,11 +450,14 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Security & Compliance + The AllowSimplePassword parameter specifies whether to allow simple or non-complex passwords on devices. Valid values for this parameter are: - $true: Simple passwords are allowed. - $false: Simple passwords aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -437,7 +469,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -447,11 +478,14 @@ Accept wildcard characters: False ``` ### -AllowVideoConferencing + +> Applicable: Security & Compliance + The AllowVideoConferencing parameter specifies whether to allow video conferencing on devices. Valid values for this parameter are: - $true: Video conferencing is allowed. - $false: Video conferencing isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -459,7 +493,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -469,11 +502,14 @@ Accept wildcard characters: False ``` ### -AllowVoiceAssistant + +> Applicable: Security & Compliance + The AllowVoiceAssistant parameter specifies whether to allow using the voice assistant on devices. Valid values for this parameter are: - $true: The voice assistant is allowed. - $false: The voice assistant isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -481,7 +517,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -491,11 +526,14 @@ Accept wildcard characters: False ``` ### -AllowVoiceDialing + +> Applicable: Security & Compliance + The AllowVoiceDialing parameter specifies whether to allow voice-activated telephone dialing. Valid values for this parameter are: - $true: Voice dialing is allowed. - $false: Voice dialing isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -503,7 +541,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -513,10 +550,13 @@ Accept wildcard characters: False ``` ### -AntiVirusSignatureStatus + +> Applicable: Security & Compliance + The AntiVirusSignatureStatus parameter specifies the antivirus signature status. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -524,7 +564,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -534,10 +573,13 @@ Accept wildcard characters: False ``` ### -AntiVirusStatus + +> Applicable: Security & Compliance + The AntiVirusStatus parameter specifies the antivirus status. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -545,7 +587,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -555,6 +596,9 @@ Accept wildcard characters: False ``` ### -AppsRating + +> Applicable: Security & Compliance + The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - AllowAll @@ -562,7 +606,7 @@ The AppsRating parameter species the maximum or most restrictive rating of apps - Rating9plus - Rating12plus - Rating17plus -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -570,7 +614,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -580,6 +623,9 @@ Accept wildcard characters: False ``` ### -AutoUpdateStatus + +> Applicable: Security & Compliance + The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - AutomaticCheckForUpdates @@ -587,7 +633,7 @@ The AutoUpdateStatus parameter specifies the update settings for devices. Valid - AutomaticUpdatesRequired - DeviceDefault - NeverCheckUpdates -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -595,7 +641,6 @@ This setting is available only on Windows 8.1 RT devices. Type: CAAutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -605,11 +650,14 @@ Accept wildcard characters: False ``` ### -BluetoothEnabled + +> Applicable: Security & Compliance + The BluetoothEnabled parameter specifies whether to enable or disable Bluetooth on devices. Valid values for this parameter are: - $true: Bluetooth is enabled. - $false: Bluetooth is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows Phone 8.1 devices. @@ -617,7 +665,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -627,11 +674,14 @@ Accept wildcard characters: False ``` ### -CameraEnabled + +> Applicable: Security & Compliance + The CameraEnabled parameter specifies whether to enable or disable cameras on devices. Valid values for this parameter are: - $true: Cameras are enabled. - $false: Cameras are disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -643,7 +693,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -653,6 +702,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -662,7 +714,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -672,13 +723,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -688,16 +741,18 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Security & Compliance + The EmailAddress parameter specifies the email address. Valid values are: - An email address: For example, julia@contoso.com. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -707,11 +762,14 @@ Accept wildcard characters: False ``` ### -EnableRemovableStorage + +> Applicable: Security & Compliance + The EnableRemovableStorage parameter specifies whether removable storage can be used by devices. Valid values for this parameter are: - $true: Removable storage can be used. - $false: Removable storage can't be used. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows Phone 8.1 devices. @@ -719,7 +777,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -729,16 +786,18 @@ Accept wildcard characters: False ``` ### -ExchangeActiveSyncHost + +> Applicable: Security & Compliance + The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -748,10 +807,13 @@ Accept wildcard characters: False ``` ### -FirewallStatus + +> Applicable: Security & Compliance + The FirewallStatus parameter specifies the acceptable firewall status values on devices. Valid values for this parameter are: - Required -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -759,7 +821,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -769,11 +830,14 @@ Accept wildcard characters: False ``` ### -ForceAppStorePassword + +> Applicable: Security & Compliance + The ForceAppStorePassword parameter specifies whether to require a password to use the app store on devices. Valid values for this parameter are: - $true: App store passwords are required. - $false: App store passwords aren't required. -- $null (blank): The feature isn't allowed or blocked by the rule. This is the default value. +- $null (blank): The feature isn't allowed or blocked by the rule. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -781,7 +845,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -791,11 +854,14 @@ Accept wildcard characters: False ``` ### -ForceEncryptedBackup + +> Applicable: Security & Compliance + The ForceEncryptedBackup parameter specifies whether to force encrypted backups for devices. Valid values for this parameter are: - $true: Encrypted backups are required. - $false: Encrypted backups aren't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -806,7 +872,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -816,10 +881,13 @@ Accept wildcard characters: False ``` ### -MaxPasswordAttemptsBeforeWipe + +> Applicable: Security & Compliance + The MaxPasswordAttemptsBeforeWipe parameter specifies the number of incorrect password attempts that cause devices to be automatically wiped. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -832,7 +900,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -842,6 +909,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordGracePeriod + +> Applicable: Security & Compliance + The MaxPasswordGracePeriod parameter specifies the length of time users are allowed to reset expired passwords on devices. This setting is available only on Apple iOS 6+ devices. @@ -852,7 +922,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -862,13 +931,16 @@ Accept wildcard characters: False ``` ### -MoviesRating + +> Applicable: Security & Compliance + The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: - AllowAll: All movies are allowed, regardless of their rating. - DontAllow: No movies are allowed, regardless of their rating. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. Australia @@ -952,7 +1024,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -962,16 +1033,18 @@ Accept wildcard characters: False ``` ### -PasswordComplexity + +> Applicable: Security & Compliance + The PasswordComplexity parameter specifies the password complexity. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -981,10 +1054,13 @@ Accept wildcard characters: False ``` ### -PasswordExpirationDays + +> Applicable: Security & Compliance + The PasswordExpirationDays parameter specifies the number of days that the same password can be used on devices before users are required to change their passwords . Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -997,7 +1073,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1007,10 +1082,13 @@ Accept wildcard characters: False ``` ### -PasswordHistoryCount + +> Applicable: Security & Compliance + The PasswordHistoryCount parameter specifies the minimum number of unique new passwords that are required on devices before an old password can be reused. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1023,7 +1101,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1033,16 +1110,18 @@ Accept wildcard characters: False ``` ### -PasswordMinComplexChars + +> Applicable: Security & Compliance + The PasswordMinComplexChars parameter specifies the minimum number of complex characters that are required for device passwords. A complex character isn't a letter. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1052,10 +1131,13 @@ Accept wildcard characters: False ``` ### -PasswordMinimumLength + +> Applicable: Security & Compliance + The PasswordMinimumLength parameter specifies the minimum number of characters that are required for device passwords. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1068,7 +1150,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1078,12 +1159,15 @@ Accept wildcard characters: False ``` ### -PasswordQuality + +> Applicable: Security & Compliance + The PasswordQuality parameter specifies the minimum password quality rating that's required for device passwords. Password quality is a numeric scale that indicates the security and complexity of the password. A higher quality value indicates a more secure password. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Android 4+ devices. @@ -1091,7 +1175,6 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1101,11 +1184,14 @@ Accept wildcard characters: False ``` ### -PasswordRequired + +> Applicable: Security & Compliance + The PasswordRequired parameter specifies whether a password is required to access devices. Valid values for this parameter are: - $true: Device passwords are required. - $false: Device passwords aren't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1117,7 +1203,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1127,6 +1212,9 @@ Accept wildcard characters: False ``` ### -PasswordTimeout + +> Applicable: Security & Compliance + The PasswordTimeout parameter specifies the length of time that devices can be inactive before a password is required to reactivate them. This setting is available on the following types of devices: @@ -1142,7 +1230,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1152,11 +1239,14 @@ Accept wildcard characters: False ``` ### -PhoneMemoryEncrypted + +> Applicable: Security & Compliance + The PhoneMemoryEncrypted parameter specifies whether to encrypt the memory on devices. Valid values for this parameter are: - $true: Memory is encrypted. - $false: Memory isn't encrypted. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1167,7 +1257,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1177,11 +1266,14 @@ Accept wildcard characters: False ``` ### -RegionRatings + +> Applicable: Security & Compliance + The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. - au: Australia - ca: Canada - de: Germany @@ -1198,7 +1290,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1208,17 +1299,19 @@ Accept wildcard characters: False ``` ### -RequireEmailProfile + +> Applicable: Security & Compliance + The RequireEmailProfile parameter specifies whether an email profile is required on devices. Valid values for this parameter are: - $true: An email profile is required. This value is required for selective wipe on iOS devices. - $false: An email profile isn't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1228,11 +1321,14 @@ Accept wildcard characters: False ``` ### -SmartScreenEnabled + +> Applicable: Security & Compliance + The SmartScreenEnabled parameter specifies whether to requireWindows SmartScreen on devices. Valid values for this parameter are: - $true: SmartScreen is enabled. - $false: SmartScreen is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -1240,7 +1336,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1250,11 +1345,14 @@ Accept wildcard characters: False ``` ### -SystemSecurityTLS + +> Applicable: Security & Compliance + The SystemSecurityTLS parameter specifies whether TLS encryption is used on devices. Valid values for this parameter are: - $true: TLS encryption is used. - $false: TLS encryption isn't used. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -1262,7 +1360,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1272,13 +1369,16 @@ Accept wildcard characters: False ``` ### -TVShowsRating + +> Applicable: Security & Compliance + The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: - AllowAll: All television shows are allowed, regardless of their rating. - DontAllow: No televisions shows are allowed, regardless of their rating. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. Australia @@ -1351,7 +1451,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1361,9 +1460,12 @@ Accept wildcard characters: False ``` ### -UserAccountControlStatus + +> Applicable: Security & Compliance + The UserAccountControlStatus parameter specifies how User Account Control messages are presented on devices. Valid values for this parameter are: -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. - AlwaysNotify - NeverNotify - NotifyAppChanges @@ -1375,7 +1477,6 @@ This setting is available only on Windows 8.1 RT devices. Type: CAUserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1385,13 +1486,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -1401,11 +1504,14 @@ Accept wildcard characters: False ``` ### -WLANEnabled + +> Applicable: Security & Compliance + The WLANEnabled parameter specifies whether Wi-Fi is enabled devices. Valid values for this parameter are: - $true: Wi-Fi is enabled. - $false: Wi-Fi is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Microsoft Windows Phone 8.1 devices. @@ -1413,7 +1519,6 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1423,6 +1528,9 @@ Accept wildcard characters: False ``` ### -WorkFoldersSyncUrl + +> Applicable: Security & Compliance + The WorkFoldersSyncUrl parameter specifies the URL that's used to synchronize company data on devices. Valid input for this parameter a URL. For example, `https://workfolders.contoso.com`. @@ -1433,7 +1541,6 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationPolicy.md index 67e19df788..09a319872c 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconfigurationpolicy applicable: Security & Compliance -title: New-DeviceConfigurationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-deviceconfigurationpolicy +schema: 2.0.0 +title: New-DeviceConfigurationPolicy --- # New-DeviceConfigurationPolicy @@ -54,13 +55,15 @@ This example creates a new mobile device configuration policy named Engineering ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the policy. If the value contains spaces, enclose the value in double quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -105,16 +112,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -132,7 +144,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationRule.md similarity index 85% rename from exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationRule.md index e4505ceb8f..73b027f3ff 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconfigurationrule applicable: Security & Compliance -title: New-DeviceConfigurationRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-deviceconfigurationrule +schema: 2.0.0 +title: New-DeviceConfigurationRule --- # New-DeviceConfigurationRule @@ -102,6 +103,9 @@ This example creates a new mobile device configuration rule with the following s ## PARAMETERS ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the mobile device configuration policy that this rule is associated with. You can use any value that uniquely identifies the policy. For example: - Name @@ -112,7 +116,6 @@ The Policy parameter specifies the mobile device configuration policy that this Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -122,6 +125,9 @@ Accept wildcard characters: False ``` ### -TargetGroups + +> Applicable: Security & Compliance + The TargetGroups parameter specifies the security groups that this rule applies to. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. You can specify multiple groups separated by commas. @@ -130,7 +136,6 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -140,16 +145,18 @@ Accept wildcard characters: False ``` ### -AccountName + +> Applicable: Security & Compliance + The AccountName parameter specifies the account name. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -159,16 +166,18 @@ Accept wildcard characters: False ``` ### -AccountUserName + +> Applicable: Security & Compliance + The AccountUserName parameter specifies the account user name. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -178,11 +187,14 @@ Accept wildcard characters: False ``` ### -AllowAppStore + +> Applicable: Security & Compliance + The AllowAppStore parameter specifies whether to allow access to the app store on devices. Valid values for this parameter are: - $true: Access to the app store is allowed. - $false: Access to the app store isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -193,7 +205,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -203,11 +214,14 @@ Accept wildcard characters: False ``` ### -AllowAssistantWhileLocked + +> Applicable: Security & Compliance + The AllowAssistantWhileLocked parameter specifies whether to allow the use of the voice assistant while devices are locked. Valid values for this parameter are: - $true: The voice assistant can be used while devices are locked. - $false: The voice assistant can't be used while devices are locked. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -215,7 +229,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -225,11 +238,14 @@ Accept wildcard characters: False ``` ### -AllowConvenienceLogon + +> Applicable: Security & Compliance + The AllowConvenienceLogon parameter specifies whether to allow convenience logons on devices. Valid values for this parameter are: - $true: Convenience logons are allowed. - $false: Convenience logons aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -237,7 +253,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -247,11 +262,14 @@ Accept wildcard characters: False ``` ### -AllowDiagnosticSubmission + +> Applicable: Security & Compliance + The AllowDiagnosticSubmission parameter specifies whether to allow diagnostic submissions from devices. Valid values for this parameter are: - $true: Diagnostic submissions are allowed. - $false: Diagnostic submissions aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -263,7 +281,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -273,11 +290,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudBackup + +> Applicable: Security & Compliance + The AllowiCloudBackup parameter specifies whether to allow Apple iCloud Backup from devices. Valid values for this parameter are: - $true: iCloud Backup is allowed. - $false: iCloud Backup isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -288,7 +308,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -298,11 +317,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudDocSync + +> Applicable: Security & Compliance + The AllowiCloudDocSync parameter specifies whether to allow Apple iCloud Documents & Data sync on devices. Valid values for this parameter are: - $true: iCloud Documents & Data sync is allowed. - $false: iCloud Documents & Data sync isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -313,7 +335,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -323,11 +344,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudPhotoSync + +> Applicable: Security & Compliance + The AllowiCloudPhotoSync parameter specifies whether to allow Apple iCloud Photos sync on devices. Valid values for this parameter are: - $true: iCloud Photos sync is allowed. - $false: iCloud Photo sync isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -338,7 +362,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -348,11 +371,14 @@ Accept wildcard characters: False ``` ### -AllowPassbookWhileLocked + +> Applicable: Security & Compliance + The AllowPassbookWhileLocked parameter specifies whether to allow the use of Apple Passbook while devices are locked. Valid values for this parameter are: - $true: Passbook is available while devices are locked. - $false: Passbook isn't available while devices are locked. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -360,7 +386,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -370,11 +395,14 @@ Accept wildcard characters: False ``` ### -AllowScreenshot + +> Applicable: Security & Compliance + The AllowScreenshot parameter specifies whether to allow screenshots on devices. Valid values for this parameter are: - $true: Screenshots are allowed. - $false: Screenshots aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -385,7 +413,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -395,11 +422,14 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Security & Compliance + The AllowSimplePassword parameter specifies whether to allow simple or non-complex passwords on devices. Valid values for this parameter are: - $true: Simple passwords are allowed. - $false: Simple passwords aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -411,7 +441,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -421,11 +450,14 @@ Accept wildcard characters: False ``` ### -AllowVideoConferencing + +> Applicable: Security & Compliance + The AllowVideoConferencing parameter specifies whether to allow video conferencing on devices. Valid values for this parameter are: - $true: Video conferencing is allowed. - $false: Video conferencing isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -433,7 +465,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -443,11 +474,14 @@ Accept wildcard characters: False ``` ### -AllowVoiceAssistant + +> Applicable: Security & Compliance + The AllowVoiceAssistant parameter specifies whether to allow using the voice assistant on devices. Valid values for this parameter are: - $true: The voice assistant is allowed. - $false: The voice assistant isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -455,7 +489,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -465,11 +498,14 @@ Accept wildcard characters: False ``` ### -AllowVoiceDialing + +> Applicable: Security & Compliance + The AllowVoiceDialing parameter specifies whether to allow voice-activated telephone dialing. Valid values for this parameter are: - $true: Voice dialing is allowed. - $false: Voice dialing isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -477,7 +513,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -487,10 +522,13 @@ Accept wildcard characters: False ``` ### -AntiVirusSignatureStatus + +> Applicable: Security & Compliance + The AntiVirusSignatureStatus parameter specifies the antivirus signature status. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -498,7 +536,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -508,10 +545,13 @@ Accept wildcard characters: False ``` ### -AntiVirusStatus + +> Applicable: Security & Compliance + The AntiVirusStatus parameter specifies the antivirus status. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -519,7 +559,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -529,6 +568,9 @@ Accept wildcard characters: False ``` ### -AppsRating + +> Applicable: Security & Compliance + The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - AllowAll @@ -536,7 +578,7 @@ The AppsRating parameter species the maximum or most restrictive rating of apps - Rating9plus - Rating12plus - Rating17plus -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -544,7 +586,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -554,6 +595,9 @@ Accept wildcard characters: False ``` ### -AutoUpdateStatus + +> Applicable: Security & Compliance + The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - AutomaticCheckForUpdates @@ -561,7 +605,7 @@ The AutoUpdateStatus parameter specifies the update settings for devices. Valid - AutomaticUpdatesRequired - DeviceDefault - NeverCheckUpdates -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -569,7 +613,6 @@ This setting is available only on Windows 8.1 RT devices. Type: AutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -579,11 +622,14 @@ Accept wildcard characters: False ``` ### -BluetoothEnabled + +> Applicable: Security & Compliance + The BluetoothEnabled parameter specifies whether to enable or disable Bluetooth on devices. Valid values for this parameter are: - $true: Bluetooth is enabled. - $false: Bluetooth is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows Phone 8.1 devices. @@ -591,7 +637,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -601,11 +646,14 @@ Accept wildcard characters: False ``` ### -CameraEnabled + +> Applicable: Security & Compliance + The CameraEnabled parameter specifies whether to enable or disable cameras on devices. Valid values for this parameter are: - $true: Cameras are enabled. - $false: Cameras are disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -617,7 +665,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -627,6 +674,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -636,7 +686,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -646,13 +695,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -662,16 +713,18 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Security & Compliance + The EmailAddress parameter specifies the email address. Valid values are: - An email address: For example, julia@contoso.com. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -681,11 +734,14 @@ Accept wildcard characters: False ``` ### -EnableRemovableStorage + +> Applicable: Security & Compliance + The EnableRemovableStorage parameter specifies whether removable storage can be used by devices. Valid values for this parameter are: - $true: Removable storage can be used. - $false: Removable storage can't be used. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows Phone 8.1 devices. @@ -693,7 +749,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -703,16 +758,18 @@ Accept wildcard characters: False ``` ### -ExchangeActiveSyncHost + +> Applicable: Security & Compliance + The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -722,10 +779,13 @@ Accept wildcard characters: False ``` ### -FirewallStatus + +> Applicable: Security & Compliance + The FirewallStatus parameter specifies the acceptable firewall status values on devices. Valid values for this parameter are: - Required -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -733,7 +793,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -743,11 +802,14 @@ Accept wildcard characters: False ``` ### -ForceAppStorePassword + +> Applicable: Security & Compliance + The ForceAppStorePassword parameter specifies whether to require a password to use the app store on devices. Valid values for this parameter are: - $true: App store passwords are required. - $false: App store passwords aren't required. -- $null (blank): The feature isn't allowed or blocked by the rule. This is the default value. +- $null (blank): The feature isn't allowed or blocked by the rule. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -755,7 +817,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -765,11 +826,14 @@ Accept wildcard characters: False ``` ### -ForceEncryptedBackup + +> Applicable: Security & Compliance + The ForceEncryptedBackup parameter specifies whether to force encrypted backups for devices. Valid values for this parameter are: - $true: Encrypted backups are required. - $false: Encrypted backups aren't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -780,7 +844,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -790,10 +853,13 @@ Accept wildcard characters: False ``` ### -MaxPasswordAttemptsBeforeWipe + +> Applicable: Security & Compliance + The MaxPasswordAttemptsBeforeWipe parameter specifies the number of incorrect password attempts that cause devices to be automatically wiped. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -806,7 +872,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -816,6 +881,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordGracePeriod + +> Applicable: Security & Compliance + The MaxPasswordGracePeriod parameter specifies the length of time users are allowed to reset expired passwords on devices. This setting is available only on Apple iOS 6+ devices. @@ -826,7 +894,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -836,13 +903,16 @@ Accept wildcard characters: False ``` ### -MoviesRating + +> Applicable: Security & Compliance + The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: - AllowAll: All movies are allowed, regardless of their rating. - DontAllow: No movies are allowed, regardless of their rating. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. Australia @@ -926,7 +996,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -936,16 +1005,18 @@ Accept wildcard characters: False ``` ### -PasswordComplexity + +> Applicable: Security & Compliance + The PasswordComplexity parameter specifies the password complexity. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -955,10 +1026,13 @@ Accept wildcard characters: False ``` ### -PasswordExpirationDays + +> Applicable: Security & Compliance + The PasswordExpirationDays parameter specifies the number of days that the same password can be used on devices before users are required to change their passwords . Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -971,7 +1045,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -981,10 +1054,13 @@ Accept wildcard characters: False ``` ### -PasswordHistoryCount + +> Applicable: Security & Compliance + The PasswordHistoryCount parameter specifies the minimum number of unique new passwords that are required on devices before an old password can be reused. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -997,7 +1073,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1007,16 +1082,18 @@ Accept wildcard characters: False ``` ### -PasswordMinComplexChars + +> Applicable: Security & Compliance + The PasswordMinComplexChars parameter specifies the minimum number of complex characters that are required for device passwords. A complex character isn't a letter. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1026,10 +1103,13 @@ Accept wildcard characters: False ``` ### -PasswordMinimumLength + +> Applicable: Security & Compliance + The PasswordMinimumLength parameter specifies the minimum number of characters that are required for device passwords. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1042,7 +1122,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1052,12 +1131,15 @@ Accept wildcard characters: False ``` ### -PasswordQuality + +> Applicable: Security & Compliance + The PasswordQuality parameter specifies the minimum password quality rating that's required for device passwords. Password quality is a numeric scale that indicates the security and complexity of the password. A higher quality value indicates a more secure password. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Android 4+ devices. @@ -1065,7 +1147,6 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1075,11 +1156,14 @@ Accept wildcard characters: False ``` ### -PasswordRequired + +> Applicable: Security & Compliance + The PasswordRequired parameter specifies whether a password is required to access devices. Valid values for this parameter are: - $true: Device passwords are required. - $false: Device passwords aren't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1091,7 +1175,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1101,6 +1184,9 @@ Accept wildcard characters: False ``` ### -PasswordTimeout + +> Applicable: Security & Compliance + The PasswordTimeout parameter specifies the length of time that devices can be inactive before a password is required to reactivate them. This setting is available on the following types of devices: @@ -1116,7 +1202,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1126,11 +1211,14 @@ Accept wildcard characters: False ``` ### -PhoneMemoryEncrypted + +> Applicable: Security & Compliance + The PhoneMemoryEncrypted parameter specifies whether to encrypt the memory on devices. Valid values for this parameter are: - $true: Memory is encrypted. - $false: Memory isn't encrypted. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1141,7 +1229,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1151,11 +1238,14 @@ Accept wildcard characters: False ``` ### -RegionRatings + +> Applicable: Security & Compliance + The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. - au: Australia - ca: Canada - de: Germany @@ -1172,7 +1262,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1182,17 +1271,19 @@ Accept wildcard characters: False ``` ### -RequireEmailProfile + +> Applicable: Security & Compliance + The RequireEmailProfile parameter specifies whether an email profile is required on devices. Valid values for this parameter are: - $true: An email profile is required. This value is required for selective wipe on iOS devices. - $false: An email profile isn't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1202,11 +1293,14 @@ Accept wildcard characters: False ``` ### -SmartScreenEnabled + +> Applicable: Security & Compliance + The SmartScreenEnabled parameter specifies whether to requireWindows SmartScreen on devices. Valid values for this parameter are: - $true: SmartScreen is enabled. - $false: SmartScreen is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -1214,7 +1308,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1224,11 +1317,14 @@ Accept wildcard characters: False ``` ### -SystemSecurityTLS + +> Applicable: Security & Compliance + The SystemSecurityTLS parameter specifies whether TLS encryption is used on devices. Valid values for this parameter are: - $true: TLS encryption is used. - $false: TLS encryption isn't used. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -1236,7 +1332,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1246,13 +1341,16 @@ Accept wildcard characters: False ``` ### -TVShowsRating + +> Applicable: Security & Compliance + The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: - AllowAll: All television shows are allowed, regardless of their rating. - DontAllow: No televisions shows are allowed, regardless of their rating. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. Australia @@ -1325,7 +1423,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1335,9 +1432,12 @@ Accept wildcard characters: False ``` ### -UserAccountControlStatus + +> Applicable: Security & Compliance + The UserAccountControlStatus parameter specifies how User Account Control messages are presented on devices. Valid values for this parameter are: -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. - AlwaysNotify - NeverNotify - NotifyAppChanges @@ -1349,7 +1449,6 @@ This setting is available only on Windows 8.1 RT devices. Type: UserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1359,13 +1458,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -1375,11 +1476,14 @@ Accept wildcard characters: False ``` ### -WLANEnabled + +> Applicable: Security & Compliance + The WLANEnabled parameter specifies whether Wi-Fi is enabled devices. Valid values for this parameter are: - $true: Wi-Fi is enabled. - $false: Wi-Fi is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Microsoft Windows Phone 8.1 devices. @@ -1387,7 +1491,6 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1397,6 +1500,9 @@ Accept wildcard characters: False ``` ### -WorkFoldersSyncUrl + +> Applicable: Security & Compliance + The WorkFoldersSyncUrl parameter specifies the URL that's used to synchronize company data on devices. Valid input for this parameter a URL. For example, `https://workfolders.contoso.com`. @@ -1407,7 +1513,6 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantPolicy.md index 13317afc2d..e41f6654c8 100644 --- a/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-devicetenantpolicy applicable: Security & Compliance -title: New-DeviceTenantPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-devicetenantpolicy +schema: 2.0.0 +title: New-DeviceTenantPolicy --- # New-DeviceTenantPolicy @@ -53,13 +54,15 @@ This example creates your organization's mobile device tenant policy. You can ha ## PARAMETERS ### -Comment + +> Applicable: Security & Compliance + 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 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -88,16 +93,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -115,7 +125,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DeviceTenantRule.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantRule.md similarity index 95% rename from exchange/exchange-ps/exchange/New-DeviceTenantRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantRule.md index 214a1d7524..6cde541a4c 100644 --- a/exchange/exchange-ps/exchange/New-DeviceTenantRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-devicetenantrule applicable: Security & Compliance -title: New-DeviceTenantRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-devicetenantrule +schema: 2.0.0 +title: New-DeviceTenantRule --- # New-DeviceTenantRule @@ -56,6 +57,9 @@ You can have only one mobile device tenant rule in your organization. ## PARAMETERS ### -ApplyPolicyTo + +> Applicable: Security & Compliance + The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: - ExchangeOnline @@ -66,7 +70,6 @@ The ApplyPolicyTo parameter specifies where to apply the policy in your organiza Type: PolicyResourceScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -BlockUnsupportedDevices + +> Applicable: Security & Compliance + The BlockUnsupportedDevices parameter specifies whether to block access to your organization by unsupported devices. Valid values for this parameter are: - $true: Unsupported devices are blocked. @@ -85,7 +91,6 @@ The BlockUnsupportedDevices parameter specifies whether to block access to your Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -104,7 +112,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -ExclusionList + +> Applicable: Security & Compliance + The ExclusionList parameter specifies the security groups to exclude from this policy. Members of the specified security groups who have non-compliant devices are not affected by block access actions. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. @@ -140,7 +152,6 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-DistributionGroup.md similarity index 82% rename from exchange/exchange-ps/exchange/New-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-DistributionGroup.md index de47db246c..d42dea38c6 100644 --- a/exchange/exchange-ps/exchange/New-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DistributionGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-distributiongroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-DistributionGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-distributiongroup +schema: 2.0.0 +title: New-DistributionGroup --- # New-DistributionGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-DistributionGroup cmdlet to create distribution groups and mail-enabled security groups. @@ -59,7 +60,7 @@ You can use the New-DistributionGroup cmdlet to create the following types of gr Distribution groups are used to consolidate groups of recipients into a single point of contact for email messages. Distribution groups aren't security principals, and therefore can't be assigned permissions. However, you can assign permissions to mail-enabled security groups. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. @@ -84,6 +85,9 @@ This example creates a distribution group named ITDepartment and specifies the m ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the group. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). This value is also used for the DisplayName property if you don't use the DisplayName parameter. @@ -92,7 +96,6 @@ This value is also used for the DisplayName property if you don't use the Displa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -126,7 +132,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -155,7 +163,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,18 +172,20 @@ Accept wildcard characters: False ``` ### -BccBlocked + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The BccBlocked parameter specifies whether members of the group don't receive messages if the group is used in the Bcc line. Valid values are: - $true: If the group is used in the Bcc line, members of the group don't receive the message, and the sender receives a non-delivery report (also known as an NDR or bounce message). Other recipients of the message aren't blocked. If an external sender uses the group in the Bcc line, members of the group aren't blocked. For nested groups, the message is blocked only for members of the top-level group. -- $false: There are no restrictions for using the group in the Bcc line of messages. This is the default value. +- $false: There are no restrictions for using the group in the Bcc line of messages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -186,10 +195,13 @@ Accept wildcard characters: False ``` ### -BypassNestedModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ByPassNestedModerationEnabled parameter specifies how to handle message approval when a moderated group contains other moderated groups as members. Valid values are: - $true: After a moderator approves a message sent to the group, the message is automatically approved for all other moderated groups that are members of the group. -- $false: After a moderator approves a message sent to the group, separate approval is required for each moderated group that's a member of the group. This is the default value. +- $false: After a moderator approves a message sent to the group, separate approval is required for each moderated group that's a member of the group. This value is the default. This parameter can be used only by top-level organization and tenant administrators. @@ -197,7 +209,6 @@ This parameter can be used only by top-level organization and tenant administrat Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -207,6 +218,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -216,7 +230,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -226,13 +239,15 @@ Accept wildcard characters: False ``` ### -CopyOwnerToMember + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CopyOwnerToMember switch specifies whether group owners specified by the ManagedBy parameter are also members of the group. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -242,6 +257,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill Description Description }} @@ -250,7 +268,6 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -260,6 +277,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -270,7 +290,6 @@ If a group naming policy is enforced in your organization, users need to follow Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,6 +299,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -288,7 +310,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -298,6 +319,9 @@ Accept wildcard characters: False ``` ### -HiddenGroupMembershipEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. 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. @@ -310,7 +334,6 @@ You can use this setting to help comply with regulations that require you to hid Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -320,6 +343,9 @@ Accept wildcard characters: False ``` ### -IgnoreNamingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The IgnoreNamingPolicy switch specifies whether to prevent this group from being affected by your organization's group naming policy. You don't need to specify a value with this switch. The group naming policy is defined by the DistributionGroupNamingPolicy and DistributionGroupNameBlockedWordList parameters on the Set-OrganizationConfig cmdlet. @@ -328,7 +354,6 @@ The group naming policy is defined by the DistributionGroupNamingPolicy and Dist Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -338,6 +363,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies an owner for the group. A group must have at least one owner. If you don't use this parameter to specify the owner when you create the group, the user account that created the group is the owner. The group owner is able to: - Modify the properties of the group @@ -376,7 +404,6 @@ Owners that you specify with this parameter are not automatically added as group Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -386,16 +413,18 @@ Accept wildcard characters: False ``` ### -MemberDepartRestriction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MemberDepartRestriction parameter specifies the restrictions that you put on requests to leave the group. Valid values are: -- Open: Members can leave the group without approval from one of the group owners. This is the default value for universal distribution groups. You can't use this value on universal security groups. -- Closed: Members can't remove themselves from the group, and requests to leave the group are rejected automatically. Group membership is controlled by the group owners. This is the default value for universal security groups. +- Open: Members can leave the group without approval from one of the group owners. This value is the default for universal distribution groups. You can't use this value on universal security groups. +- Closed: Members can't remove themselves from the group, and requests to leave the group are rejected automatically. Group membership is controlled by the group owners. This value is the default for universal security groups. ```yaml Type: MemberUpdateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -405,17 +434,19 @@ Accept wildcard characters: False ``` ### -MemberJoinRestriction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MemberJoinRestriction parameter specifies the restrictions that you put on requests to join the group. Valid values are: - Open: Users can add themselves to the group without approval from a group owner. You can't use this value on universal security groups. -- Closed: Users can't add themselves to the group, and requests to join the group are rejected automatically. Group membership is controlled by the group owners. This is the default value on universal security groups and universal distribution groups. +- Closed: Users can't add themselves to the group, and requests to join the group are rejected automatically. Group membership is controlled by the group owners. This value is the default on universal security groups and universal distribution groups. - ApprovalRequired: Users can request to join the group. The user is added to the group after the request is approved by one of the group owners. Although you can use this value on universal security groups, user requests to join the group aren't sent to the group owners, so this setting is only effective on universal distribution groups. ```yaml Type: MemberUpdateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -425,6 +456,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Members parameter specifies the recipients (mail-enabled objects) that are members of the group. You can use any value that uniquely identifies the recipient. For example: - Name @@ -438,7 +472,7 @@ You can enter multiple values separated by commas. If the values contain spaces After you create the group, you use the Get-DistributionGroupMember cmdlet to view the group members, and the Add-DistributionGroupMember, Remove-DistributionGroupMember, and Update-DistributionGroupMember cmdlets to manage group membership. -Although it isn't required, it's a good idea to add only security principals (for example, mailboxes and mail users with user accounts or other mail-enabled security groups) to mail-enabled security groups. If you assign permissions to a mail-enabled security group, any members that aren't security principals (for example, mail contacts or distribution groups) won't have the permissions assigned. +Although it isn't required, it's a good idea to add only security principals (for example, mailboxes and mail users with user accounts or other mail-enabled security groups) to mail-enabled security groups. If you assign permissions to a mail-enabled security group, any members that aren't security principals (for example, mail contacts or distribution groups) don't have the permissions assigned. The maximum number of entries for this parameter is 10000. @@ -446,7 +480,6 @@ The maximum number of entries for this parameter is 10000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -456,6 +489,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this group. A moderator approves messages sent to the group before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -475,7 +511,6 @@ For distribution groups, if you set the ModerationEnabled parameter to the value Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -485,10 +520,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -496,7 +534,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -506,13 +543,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -522,6 +561,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter specifies the location in Active Directory where the group is created. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -535,7 +577,6 @@ Valid input for this parameter is an organizational unit (OU) or domain that's r Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -545,13 +586,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -561,6 +604,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -572,7 +618,6 @@ The default value is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -582,6 +627,9 @@ Accept wildcard characters: False ``` ### -RoomList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RoomList switch specifies that all members of this distribution group are room mailboxes. You don't need to specify a value with this switch. You can create a distribution group for an office building in your organization and add all rooms in that building to the distribution group. Room list distribution groups are used to generate a list of building locations for meeting requests in Outlook 2010 or later. Room lists allow a user to select a building and get availability information for all rooms in that building, without having to add each room individually. @@ -590,7 +638,6 @@ You can create a distribution group for an office building in your organization Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -600,15 +647,17 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -618,9 +667,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -630,7 +682,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -640,9 +691,12 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Type parameter specifies the type of group that you want to create. Valid values are: -- Distribution: A distribution group. These groups can't have permissions assigned. This is the default value. +- Distribution: A distribution group. These groups can't have permissions assigned. This value is the default. - Security: A mail-enabled security group. These groups can have permissions assigned. The group's scope is always Universal. @@ -651,7 +705,6 @@ The group's scope is always Universal. Type: GroupType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -661,13 +714,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DkimSigningConfig.md b/exchange/exchange-ps/ExchangePowerShell/New-DkimSigningConfig.md similarity index 85% rename from exchange/exchange-ps/exchange/New-DkimSigningConfig.md rename to exchange/exchange-ps/ExchangePowerShell/New-DkimSigningConfig.md index 5bd296a8ba..66fa40daa5 100644 --- a/exchange/exchange-ps/exchange/New-DkimSigningConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DkimSigningConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection -title: New-DkimSigningConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dkimsigningconfig +schema: 2.0.0 +title: New-DkimSigningConfig --- # New-DkimSigningConfig @@ -34,7 +35,7 @@ New-DkimSigningConfig [-DomainName] [-Enabled] Applicable: Exchange Online, Exchange Online Protection + The DomainName parameter specifies the domain in your organization that you want to enable DKIM message signing for. By default, DKIM message signing is enabled for the initial \*.onmicrosoft.com domain in the organization (for example, contoso.onmicrosoft.com). @@ -58,7 +62,6 @@ For custom domains that don't have DKIM messaging signing enabled, the DKIM sign Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. @@ -77,7 +83,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 2 @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -103,16 +110,18 @@ Accept wildcard characters: False ``` ### -BodyCanonicalization + +> Applicable: Exchange Online, Exchange Online Protection + The BodyCanonicalization parameter specifies the canonicalization algorithm that's used to create and verify the message body part of the DKIM signature. This value effectively controls the sensitivity of DKIM to changes to the message body in transit. Valid values are: -- Relaxed: Changes in whitespace and changes in empty lines at the end of the message body are tolerated. This is the default value. +- Relaxed: Changes in whitespace and changes in empty lines at the end of the message body are tolerated. This value is the default. - Simple: Only changes in empty lines at the end of the message body are tolerated. ```yaml Type: CanonicalizationType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -131,7 +143,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -141,16 +152,18 @@ Accept wildcard characters: False ``` ### -HeaderCanonicalization + +> Applicable: Exchange Online, Exchange Online Protection + The HeaderCanonicalization parameter specifies the canonicalization algorithm that's used to create and verify the message header part of the DKIM signature. This value effectively controls the sensitivity of DKIM to changes to the message headers in transit. Valid values are: -- Relaxed: Common modifications to the message header are tolerated (for example, Header field line rewrapping, changes in unnecessary whitespace or empty lines, and changes in case for header fields). This is the default value. +- Relaxed: Common modifications to the message header are tolerated (for example, Header field line rewrapping, changes in unnecessary whitespace or empty lines, and changes in case for header fields). This value is the default. - Simple: No changes to the header fields are tolerated. ```yaml Type: CanonicalizationType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,6 +173,9 @@ Accept wildcard characters: False ``` ### -KeySize + +> Applicable: Exchange Online, Exchange Online Protection + The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are: - 1024 (this is the default value) @@ -171,7 +187,6 @@ RSA keys are supported. Ed25519 keys aren't supported. Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpCompliancePolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpCompliancePolicy.md index cb3907cc99..e3be4ce80a 100644 --- a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpcompliancepolicy applicable: Security & Compliance -title: New-DlpCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpcompliancepolicy +schema: 2.0.0 +title: New-DlpCompliancePolicy --- # New-DlpCompliancePolicy @@ -29,6 +30,7 @@ New-DlpCompliancePolicy [-Name] [-EndpointDlpExtendedLocations ] [-EndpointDlpLocation ] [-EndpointDlpLocationException ] + [-EnforcementPlanes ] [-ExceptIfOneDriveSharedBy ] [-ExceptIfOneDriveSharedByMemberOf ] [-ExchangeAdaptiveScopes ] @@ -78,21 +80,21 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned New-DlpCompliancePolicy -Name "GlobalPolicy" -SharePointLocation All ``` -This example creates a DLP policy named GlobalPolicy that will be enforced across all SharePoint Online locations. +This example creates a DLP policy named GlobalPolicy that's enforced across all SharePoint locations. ### Example 2 ```powershell New-DlpCompliancePolicy -Name "GlobalPolicy" -Comment "Primary policy" -SharePointLocation "https://my.url","https://my.url2" -OneDriveLocation "https://my.url3","https://my.url4" -Mode Enable ``` -This example creates a DLP policy named GlobalPolicy for the specified SharePoint Online and OneDrive for Business locations. The new policy has a descriptive comment and will be enabled on creation. +This example creates a DLP policy named GlobalPolicy for the specified SharePoint and OneDrive locations. The new policy has a descriptive comment and is 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. +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 is enabled on creation. ### Example 4 ```powershell @@ -152,13 +154,15 @@ This example creates a DLP policy for Microsoft 365 Copilot (Preview) in several ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the DLP policy. 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 @@ -168,13 +172,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -184,6 +190,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -193,7 +202,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -203,13 +211,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill EndpointDlpAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -219,13 +229,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill EndpointDlpAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -235,13 +247,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpExtendedLocations + +> Applicable: Security & Compliance + {{ Fill EndpointDlpExtendedLocations Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -251,6 +265,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpLocation + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The EndpointDLPLocation parameter specifies the user accounts to include in the DLP policy for Endpoint DLP when they are logged on to an onboarded device. You identify the account by name or email address. You can use the value All to include all user accounts. @@ -263,7 +280,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -273,6 +289,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The EndpointDlpLocationException parameter specifies the user accounts to exclude from Endpoint DLP when you use the value All for the EndpointDlpLocation parameter. You identify the account by name or email address. @@ -285,7 +304,31 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcementPlanes + +> Applicable: Security & Compliance + +The EnforcementPlanes parameter defines the layer where policy actions are run. This parameter uses the following syntax: + +`-EnforcementPlanes @("")`. + +Currently, supported values are: + +- Entra: For use with policies applied to Entra-registered enterprise applications in the organization. +- Browser: For use with policies applied to unmanaged cloud apps in Edge for Business. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -295,9 +338,12 @@ 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). -To use this parameter, OneDrive for Business sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). +> Applicable: Security & Compliance + +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -307,7 +353,6 @@ You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMember Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -317,9 +362,12 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf -The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to exclude from the DLP policy (the OneDrive for Business sites of group members are excluded from the policy). You identify the groups by email address. -To use this parameter, OneDrive for Business sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). +> Applicable: Security & Compliance + +The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to exclude from the DLP policy (the OneDrive sites of group members are excluded from the policy). You identify the groups by email address. + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -331,7 +379,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -341,13 +388,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -357,13 +406,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -373,6 +424,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies whether to include email messages in the DLP policy. The valid value for this parameter is All. If you don't want to include email messages in the policy, don't use this parameter (the default value is blank or $null). You can use this parameter in the following procedures: @@ -389,7 +443,6 @@ You can't specify inclusions and exclusions in the same policy. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -399,6 +452,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf + +> Applicable: Security & Compliance + The ExchangeSenderMemberOf parameter specifies the distribution groups or security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -413,7 +469,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -423,6 +478,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException + +> Applicable: Security & Compliance + The ExchangeSenderMemberOfException parameter specifies the distribution groups or security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -437,7 +495,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -447,6 +504,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -455,7 +515,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -465,13 +524,15 @@ Accept wildcard characters: False ``` ### -IsFromSmartInsights + +> Applicable: Security & Compliance + {{ Fill IsFromSmartInsights Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -481,6 +542,9 @@ Accept wildcard characters: False ``` ### -Locations + +> Applicable: Security & Compliance + 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`. @@ -508,7 +572,6 @@ After you create the `$loc` variable as shown in the previous examples, use the Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -518,9 +581,12 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Security & Compliance + 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. +- Enable: The policy is enabled for actions and notifications. This value is the default. - Disable: The policy is disabled. - 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. @@ -529,7 +595,6 @@ The Mode parameter specifies the action and notification level of the DLP policy Type: PolicyMode Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -539,13 +604,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -555,13 +622,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -571,7 +640,10 @@ Accept wildcard characters: False ``` ### -OneDriveLocation -The OneDriveLocation parameter specifies whether to include OneDrive for Business sites in the policy. A valid value for this parameter is All, which is also the default value. + +> Applicable: Security & Compliance + +The OneDriveLocation parameter specifies whether to include OneDrive sites in the policy. A valid value for this parameter is All, which is also the default value. You can use this parameter in the following procedures: @@ -583,7 +655,7 @@ You can use this parameter in the following procedures: - To exclude sites of specific group members from the policy, use the ExceptIfOneDriveSharedByMemberOf parameter to specify the groups. Only sites of members of the specified groups are excluded from the policy. -- If you use `-OneDriveLocation $null`, the policy does not apply to OneDrive for Business sites. +- If you use `-OneDriveLocation $null`, the policy does not apply to OneDrive sites. You can't specify inclusions and exclusions in the same policy. @@ -593,7 +665,6 @@ You can't specify inclusions and exclusions in the same policy. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named Default value: None @@ -602,13 +673,15 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException + +> Applicable: Security & Compliance + Don't use this parameter. See the OneDriveLocation parameter for an explanation. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named Default value: None @@ -617,9 +690,12 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy -The OneDriveSharedBy parameter specifies the users to include in the DLP policy (the sites of the OneDrive for Business user accounts are included in the policy). You identify the users by UPN (laura@contoso.onmicrosoft.com). -To use this parameter, OneDrive for Business sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). +> Applicable: Security & Compliance + +The OneDriveSharedBy parameter specifies the users to include in the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -629,7 +705,6 @@ You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDri Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -639,9 +714,12 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf -The OneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the DLP policy (the OneDrive for Business sites of group members are included in the policy). You identify the groups by email address. -To use this parameter, OneDrive for Business sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). +> Applicable: Security & Compliance + +The OneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the DLP policy (the OneDrive sites of group members are included in the policy). You identify the groups by email address. + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -653,7 +731,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -663,6 +740,9 @@ Accept wildcard characters: False ``` ### -OnPremisesScannerDlpLocation + +> Applicable: Security & Compliance + The OnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to include in the DLP policy. You can use the value All to include all on-premises file shares and SharePoint document libraries and folders. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -673,7 +753,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -683,6 +762,9 @@ Accept wildcard characters: False ``` ### -OnPremisesScannerDlpLocationException + +> Applicable: Security & Compliance + The OnPremisesScannerDlpLocationException parameter specifies the on-premises file shares and SharePoint document libraries and folders to exclude from the DLP policy if you use the value All for the OnPremisesScannerDlpLocation parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -693,7 +775,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -703,6 +784,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + 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. @@ -711,7 +795,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -721,6 +804,9 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + The PolicyTemplateInfo specifies the built-in or custom DLP policy templates to use in the DLP policy. For more information about DLP policy templates, see [What the DLP policy templates include](https://learn.microsoft.com/purview/what-the-dlp-policy-templates-include). @@ -729,7 +815,6 @@ For more information about DLP policy templates, see [What the DLP policy templa Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -739,6 +824,9 @@ Accept wildcard characters: False ``` ### -PowerBIDlpLocation + +> Applicable: Security & Compliance + The PowerBIDlpLocation parameter specifies the Power BI workspace IDs to include in the DLP policy. Only workspaces hosted in Premium Gen2 capacities are permitted. You can use the value All to include all supported workspaces. You can find the workspace ID using any of the following procedures: @@ -755,7 +843,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The PowerBIDlpLocationException parameter specifies the Power BI workspace IDs to exclude from the DLP policy when you use the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. You can find the workspace ID using any of the following procedures: @@ -779,7 +869,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and policies can't have the same priority value. Valid values and the default value depend on the number of existing policies. For example, if there are 5 existing policies: @@ -803,7 +895,6 @@ If you modify the priority value of a policy, the position of the policy in the Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -813,13 +904,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -829,13 +922,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -845,9 +940,12 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include in the DLP police. You identify the site by its URL value, or you can use the value All to include all sites. -You can't add SharePoint Online sites to the policy until they have been indexed. +> Applicable: Security & Compliance + +The SharePointLocation parameter specifies the SharePoint sites to include in the DLP policy. You identify the site by its URL value, or you can use the value All to include all sites. + +You can't add SharePoint sites to the policy until they have been indexed. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -855,7 +953,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The SharePointLocationException parameter specifies the SharePoint sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. + +You can't add SharePoint sites to the policy until they have been indexed. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -875,7 +975,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + {{ Fill TeamsAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -901,13 +1002,15 @@ Accept wildcard characters: False ``` ### -TeamsAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill TeamsAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -917,6 +1020,9 @@ Accept wildcard characters: False ``` ### -TeamsLocation + +> Applicable: Security & Compliance + The TeamsLocation parameter specifies the Teams chat and channel messages to include in the DLP policy. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. You can use the value All to include all accounts, distribution groups, and mail-enabled security groups. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -925,7 +1031,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The TeamsLocation parameter specifies the Teams chat and channel messages to exclude from the DLP policy when you use the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -943,7 +1051,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The ThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to include in the DLP policy. You can use the value All to include all connected apps. @@ -965,7 +1075,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -975,6 +1084,9 @@ Accept wildcard characters: False ``` ### -ThirdPartyAppDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The ThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps to exclude from the DLP policy when you use the value All for the ThirdPartyAppDlpLocation parameter. @@ -987,7 +1099,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -997,13 +1108,15 @@ Accept wildcard characters: False ``` ### -ValidatePolicy + +> Applicable: Security & Compliance + {{ Fill ValidatePolicy Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1013,13 +1126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpComplianceRule.md similarity index 91% rename from exchange/exchange-ps/exchange/New-DlpComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpComplianceRule.md index 91e358ea91..cd6695eb76 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpcompliancerule applicable: Security & Compliance -title: New-DlpComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpcompliancerule +schema: 2.0.0 +title: New-DlpComplianceRule --- # New-DlpComplianceRule @@ -53,6 +54,7 @@ New-DlpComplianceRule [-Name] -Policy [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] [-DocumentSizeOver ] + [-DomainCountOver ] [-EncryptRMSTemplate ] [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] @@ -127,6 +129,7 @@ New-DlpComplianceRule [-Name] -Policy [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] [-NotifyEmailExchangeIncludeAttachment ] + [-NotifyEmailOnedriveRemediationActions ] [-NotifyEndpointUser ] [-NotifyOverrideRequirements ] [-NotifyPolicyTipCustomDialog ] @@ -143,6 +146,7 @@ New-DlpComplianceRule [-Name] -Policy [-Quarantine ] [-RecipientADAttributeContainsWords ] [-RecipientADAttributeMatchesPatterns ] + [-RecipientCountOver ] [-RecipientDomainIs ] [-RedirectMessageTo ] [-RemoveHeader ] @@ -304,16 +308,34 @@ 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 + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the new DLP rule. 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 @@ -323,7 +345,10 @@ Accept wildcard characters: False ``` ### -Policy -The Policy parameter specifies the existing DLP policy that will contain the new DLP rule. You can use any value that uniquely identifies the policy. For example: + +> Applicable: Security & Compliance + +The Policy parameter specifies the existing DLP policy that contains the new DLP rule. You can use any value that uniquely identifies the policy. For example: - Name - Distinguished name (DN) @@ -334,7 +359,6 @@ The Policy parameter specifies the existing DLP policy that will contain the new Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -344,6 +368,9 @@ Accept wildcard characters: False ``` ### -AccessScope + +> Applicable: Security & Compliance + The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule is applied to content that's accessible or delivered to a recipient inside the organization. @@ -354,7 +381,6 @@ The AccessScope parameter specifies a condition for the DLP rule that's based on Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -364,13 +390,15 @@ Accept wildcard characters: False ``` ### -ActivationDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -380,6 +408,9 @@ Accept wildcard characters: False ``` ### -AddRecipients + +> Applicable: Security & Compliance + The AddRecipients parameter specifies an action for the DLP rule that adds the specified recipients to email messages. This parameter uses the following syntax: - `@{ = "emailaddress"}`. For example, `@{AddToRecipients = "laura@contoso.com"}` or `@{BlindCopyTo = "julia@contoso.com"}`. @@ -391,7 +422,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -401,6 +431,9 @@ Accept wildcard characters: False ``` ### -AdvancedRule + +> Applicable: Security & Compliance + The AdvancedRule parameter uses complex rule syntax that supports multiple AND, OR, and NOT operators and nested groups. This parameter uses JSON syntax that's similar to the traditional advanced syntax in Example 2, but read from a file that contains additional operators and combinations that aren't traditionally supported. @@ -411,7 +444,6 @@ For syntax details, see Example 3. Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -421,13 +453,15 @@ Accept wildcard characters: False ``` ### -AlertProperties + +> Applicable: Security & Compliance + {{ Fill AlertProperties Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -437,6 +471,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The AnyOfRecipientAddressContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -451,7 +488,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -461,6 +497,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -471,7 +510,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -481,6 +519,9 @@ Accept wildcard characters: False ``` ### -ApplyBrandingTemplate + +> Applicable: Security & Compliance + The ApplyBrandingTemplate parameter specifies an action for the DLP rule that applies a custom branding template for messages encrypted by Microsoft Purview Message Encryption. You identify the custom branding template by name. If the name contains spaces, enclose the name in quotation marks ("). Use the EnforcePortalAccess parameter to control whether external users are required to use the encrypted message portal to view encrypted messages. @@ -489,7 +530,6 @@ Use the EnforcePortalAccess parameter to control whether external users are requ Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -499,6 +539,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimer + +> Applicable: Security & Compliance + The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = ; FallbackAction = }`. - Text: Specifies the disclaimer text to add. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. @@ -511,7 +554,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -521,13 +563,15 @@ Accept wildcard characters: False ``` ### -AttachmentIsNotLabeled + +> Applicable: Security & Compliance + {{ Fill AttachmentIsNotLabeled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -537,16 +581,18 @@ Accept wildcard characters: False ``` ### -BlockAccess + +> Applicable: Security & Compliance + 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: - $true: Blocks further access to the source item that matched the rule. The owner, author, and site owner can still access the item. -- $false: Allows access to the source item that matched the rule. This is the default value. +- $false: Allows access to the source item that matched the rule. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -556,6 +602,9 @@ Accept wildcard characters: False ``` ### -BlockAccessScope + +> Applicable: Security & Compliance + The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - All: Blocks access to everyone except the owner and the last modifier. @@ -566,7 +615,6 @@ The BlockAccessScope parameter specifies the scope of the block access action. V Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -576,13 +624,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -592,6 +642,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -601,7 +654,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -611,6 +663,9 @@ Accept wildcard characters: False ``` ### -ContentCharacterSetContainsWords + +> Applicable: Security & Compliance + The ContentCharacterSetContainsWords parameter specifies a condition for the rule that looks for character set names in messages. You can specify multiple values separated by commas. Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874`. @@ -619,7 +674,6 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -629,6 +683,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. @@ -641,7 +698,6 @@ For an example of advanced syntax, see Example 2 in this topic. Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -651,13 +707,15 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -667,13 +725,15 @@ Accept wildcard characters: False ``` ### -ContentFileTypeMatches + +> Applicable: Security & Compliance + {{ Fill ContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -683,6 +743,9 @@ Accept wildcard characters: False ``` ### -ContentIsNotLabeled + +> Applicable: Security & Compliance + 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. @@ -694,7 +757,6 @@ In Exchange, this condition is matched only if both the attachment and the messa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -704,6 +766,9 @@ Accept wildcard characters: False ``` ### -ContentIsShared + +> Applicable: Security & Compliance + 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. @@ -715,7 +780,6 @@ In Exchange, this condition is matched only if both the attachment and the messa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -725,6 +789,9 @@ Accept wildcard characters: False ``` ### -ContentPropertyContainsWords + +> Applicable: Security & Compliance + The ContentPropertyContainsWords parameter specifies a condition for the DLP rule that's based on a property match in content. The rule is applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -733,7 +800,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -743,16 +809,18 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: - $true: The rule is disabled. -- $false: The rule is enabled. This is the default value. +- $false: The rule is enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -762,6 +830,9 @@ Accept wildcard characters: False ``` ### -DocumentContainsWords + +> Applicable: Security & Compliance + The DocumentContainsWords parameter specifies a condition for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -772,7 +843,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -782,6 +852,9 @@ Accept wildcard characters: False ``` ### -DocumentCreatedBy + +> Applicable: Security & Compliance + 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. @@ -790,7 +863,6 @@ This parameter applies to Sharepoint and Onedrive workloads. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -800,6 +872,9 @@ Accept wildcard characters: False ``` ### -DocumentCreatedByMemberOf + +> Applicable: Security & Compliance + 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. @@ -808,7 +883,6 @@ This parameter applies to Sharepoint and Onedrive workloads. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -818,6 +892,9 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected + +> Applicable: Security & Compliance + The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -827,7 +904,6 @@ The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -837,6 +913,9 @@ Accept wildcard characters: False ``` ### -DocumentIsUnsupported + +> Applicable: Security & Compliance + The DocumentIsUnsupported parameter specifies a condition for the DLP rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -846,7 +925,6 @@ The DocumentIsUnsupported parameter specifies a condition for the DLP rule that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -856,6 +934,9 @@ Accept wildcard characters: False ``` ### -DocumentMatchesPatterns + +> Applicable: Security & Compliance + The DocumentMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -866,7 +947,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -876,6 +956,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesPatterns + +> Applicable: Security & Compliance + The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -884,7 +967,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -894,6 +976,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesWords + +> Applicable: Security & Compliance + The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -906,7 +991,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -916,6 +1000,9 @@ Accept wildcard characters: False ``` ### -DocumentSizeOver + +> Applicable: Security & Compliance + The DocumentSizeOver parameter specifies a condition for the DLP rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -926,7 +1013,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -934,7 +1021,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -942,8 +1028,29 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -DomainCountOver + +> Applicable: Security & Compliance +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -EncryptRMSTemplate + +> Applicable: Security & Compliance + 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 ("). Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. @@ -952,7 +1059,6 @@ Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -962,13 +1068,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpBrowserRestrictions + +> Applicable: Security & Compliance + {{ Fill EndpointDlpBrowserRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -978,6 +1086,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpRestrictions + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The EndpointDlpRestrictions parameter specifies the restricted endpoints for Endpoint DLP. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. @@ -1006,7 +1117,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1016,6 +1126,9 @@ Accept wildcard characters: False ``` ### -EnforcePortalAccess + +> Applicable: Security & Compliance + The EnforcePortalAccess parameter specifies whether external recipients are required to view encrypted mail using the encrypted message portal when the ApplyBrandingTemplate action is also specified. Valid values are: - $true: External recipients are required to use the encrypted message portal to view encrypted messages. @@ -1025,7 +1138,6 @@ The EnforcePortalAccess parameter specifies whether external recipients are requ Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1035,6 +1147,9 @@ Accept wildcard characters: False ``` ### -EvaluateRulePerComponent + +> Applicable: Security & Compliance + 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). @@ -1053,7 +1168,6 @@ This parameter works with the following conditions or exceptions only: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1063,6 +1177,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAccessScope + +> Applicable: Security & Compliance + The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule isn't applied to content that's accessible or delivered to a recipient inside the organization. @@ -1073,7 +1190,6 @@ The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1083,6 +1199,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. - Single word: `"no_reply"` @@ -1097,7 +1216,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1107,6 +1225,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1117,7 +1238,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1127,6 +1247,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentCharacterSetContainsWords parameter specifies an exception for the rule that looks for character set names in messages. To specify multiple words, this parameter uses the syntax: `Word1,word2,...wordN`. Don't use leading or trailing spaces. @@ -1137,7 +1260,6 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1147,6 +1269,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. @@ -1157,7 +1282,6 @@ Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1167,13 +1291,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1183,13 +1309,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentFileTypeMatches + +> Applicable: Security & Compliance + {{ Fill ExceptIfContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1199,6 +1327,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentIsShared + +> Applicable: Security & Compliance + 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. @@ -1210,7 +1341,6 @@ In Exchange, this condition is matched only if both the attachment and the messa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1220,6 +1350,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentPropertyContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentPropertyContainsWords parameter specifies an exception for the DLP rule that's based on a property match in content. The rule is not applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -1228,7 +1361,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1238,6 +1370,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentContainsWords + +> Applicable: Security & Compliance + The ExceptIfDocumentContainsWords parameter specifies an exception for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1248,7 +1383,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1258,6 +1392,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedBy + +> Applicable: Security & Compliance + 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. @@ -1266,7 +1403,6 @@ This parameter applies to Sharepoint and Onedrive workloads. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1276,6 +1412,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedByMemberOf + +> Applicable: Security & Compliance + 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. @@ -1284,7 +1423,6 @@ This parameter applies to Sharepoint and Onedrive workloads. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1294,6 +1432,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected + +> Applicable: Security & Compliance + The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -1303,7 +1444,6 @@ The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1313,6 +1453,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsUnsupported + +> Applicable: Security & Compliance + The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -1322,7 +1465,6 @@ The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1332,6 +1474,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1340,7 +1485,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1350,6 +1494,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfDocumentMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -1360,7 +1507,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1370,6 +1516,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesWords + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1382,7 +1531,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1392,6 +1540,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentSizeOver + +> Applicable: Security & Compliance + The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -1402,7 +1553,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1410,7 +1561,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1420,6 +1570,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + The ExceptIfFrom parameter specifies an exception for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1428,7 +1581,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1438,6 +1590,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfFromAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1452,7 +1607,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1462,6 +1616,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1472,7 +1629,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1482,6 +1638,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Security & Compliance + The FromMemberOf parameter specifies an exception for the DLP rule that looks for messages sent by group members. You identify the group by its email address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -1490,7 +1649,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1500,6 +1658,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope + +> Applicable: Security & Compliance + The ExceptIfFromScope parameter specifies an exception for the rule that looks for the location of message senders. Valid values are: - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. @@ -1511,7 +1672,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1521,6 +1681,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride + +> Applicable: Security & Compliance + The ExceptIfHasSenderOverride parameter specifies an exception for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: - $true: Look for messages where the sender took action to override a DLP policy. @@ -1532,7 +1695,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1542,6 +1704,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Security & Compliance + The HeaderContainsWords parameter specifies an exception for the DLP rule that looks for words in a header field. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1552,7 +1717,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1562,6 +1726,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1570,7 +1737,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1580,6 +1746,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver + +> Applicable: Security & Compliance + The ExceptIfMessageSizeOver parameter specifies an exception for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. When you enter a value, qualify the value with one of the following units: @@ -1590,7 +1759,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1598,7 +1767,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1608,6 +1776,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Security & Compliance + The ExceptIfMessageTypeMatches parameter specifies an exception for the rule that looks for messages of the specified type. Valid values are: - ApprovalRequest: Moderation request messages sent to moderators. @@ -1625,7 +1796,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1635,6 +1805,9 @@ Accept wildcard characters: False ``` ### -ExceptIfProcessingLimitExceeded + +> Applicable: Security & Compliance + The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP rule that looks for files where scanning couldn't complete. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -1644,7 +1817,6 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1654,6 +1826,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords + +> Applicable: Security & Compliance + The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: - City @@ -1694,7 +1869,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1704,6 +1878,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -1744,7 +1921,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1754,13 +1930,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1770,6 +1948,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords + +> Applicable: Security & Compliance + The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: - City @@ -1810,7 +1991,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1820,6 +2000,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -1860,7 +2043,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1870,6 +2052,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + The ExceptIfSenderDomainIs parameter specifies an exception for the DLP rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1878,7 +2063,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1888,6 +2072,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIPRanges + +> Applicable: Security & Compliance + The ExceptIfSenderIpRanges parameter specifies an exception for the DLP rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -1900,7 +2087,6 @@ You can specify values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1910,6 +2096,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + The ExceptIfSentTo parameter specifies an exception for the DLP rule that looks for recipients in messages. You identify the recipients by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1918,7 +2107,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1928,6 +2116,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Security & Compliance + The ExceptIfSentToMemberOf parameter specifies an exception for the DLP rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1936,7 +2127,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1946,6 +2136,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Security & Compliance + The ExceptIfSubjectContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in the Subject field of messages. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1960,7 +2153,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1970,6 +2162,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1980,7 +2175,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1990,6 +2184,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Security & Compliance + The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the rule that looks for words in the Subject field or body of messages. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -2000,7 +2197,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2010,6 +2206,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in DLP policies that are scoped only to Exchange. @@ -2018,7 +2217,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2028,6 +2226,9 @@ Accept wildcard characters: False ``` ### -ExceptIfUnscannableDocumentExtensionIs + +> Applicable: Security & Compliance + The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -2036,7 +2237,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2046,6 +2246,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Security & Compliance + The ExceptIfWithImportance parameter specifies an exception for the rule that looks for messages with the specified importance level. Valid values are: - Low @@ -2058,7 +2261,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2068,13 +2270,15 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2084,6 +2288,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + The From parameter specifies a condition for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2092,7 +2299,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2102,6 +2308,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Security & Compliance + The FromAddressContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -2116,7 +2325,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2126,6 +2334,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Security & Compliance + The FromAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -2136,7 +2347,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2146,6 +2356,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Security & Compliance + The FromMemberOf parameter specifies a condition for the DLP rule that looks for messages sent by group members. You identify the group by its email address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -2154,7 +2367,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2164,6 +2376,9 @@ Accept wildcard characters: False ``` ### -FromScope + +> Applicable: Security & Compliance + The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. @@ -2175,7 +2390,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2185,6 +2399,9 @@ Accept wildcard characters: False ``` ### -GenerateAlert + +> Applicable: Security & Compliance + The GenerateAlert parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2198,7 +2415,6 @@ The email message that's generated by this action contains a link to detailed in Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2208,6 +2424,9 @@ Accept wildcard characters: False ``` ### -GenerateIncidentReport + +> Applicable: Security & Compliance + The GenerateIncidentReport parameter specifies an action for the DLP rule that sends an incident report to the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2219,7 +2438,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2229,6 +2447,9 @@ Accept wildcard characters: False ``` ### -HasSenderOverride + +> Applicable: Security & Compliance + The SenderOverride parameter specifies a condition for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: - $true: Look for messages where the sender took action to override a DLP policy. @@ -2240,7 +2461,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2250,6 +2470,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Security & Compliance + The HeaderContainsWords parameter specifies a condition for the DLP rule that looks for words in a header field. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -2260,7 +2483,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2270,6 +2492,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2278,7 +2503,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2288,13 +2512,15 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2304,6 +2530,9 @@ Accept wildcard characters: False ``` ### -IncidentReportContent + +> Applicable: Security & Compliance + The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: - All @@ -2333,7 +2562,6 @@ Therefore, any additional values that you use with the value "Default" are ignor Type: ReportContentOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2343,13 +2571,15 @@ Accept wildcard characters: False ``` ### -MessageIsNotLabeled + +> Applicable: Security & Compliance + {{ Fill MessageIsNotLabeled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2359,6 +2589,9 @@ Accept wildcard characters: False ``` ### -MessageSizeOver + +> Applicable: Security & Compliance + 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. When you enter a value, qualify the value with one of the following units: @@ -2369,7 +2602,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2377,7 +2610,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2387,6 +2619,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Security & Compliance + The MessageTypeMatches parameter specifies a condition for the rule that looks for messages of the specified type. Valid values are: - ApprovalRequest: Moderation request messages sent to moderators. @@ -2404,7 +2639,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2414,13 +2648,15 @@ Accept wildcard characters: False ``` ### -MipRestrictAccess + +> Applicable: Security & Compliance + {{ Fill MipRestrictAccess Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2430,6 +2666,9 @@ Accept wildcard characters: False ``` ### -Moderate + +> Applicable: Security & Compliance + The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = "emailaddress1,emailaddress2,...emailaddressN"}`. You can use this action in DLP policies that are scoped only to Exchange. @@ -2438,7 +2677,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2448,6 +2686,9 @@ Accept wildcard characters: False ``` ### -ModifySubject + +> Applicable: Security & Compliance + The ModifySubject parameter uses regular expressions to find text patterns in the subject of the email message, and then modifies the subject with the text that you specify. This parameter uses the syntax: `@{Patterns="RegEx1","RegEx2",..."RegEx10}"; SubjectText="Replacement Text"; ReplaceStrategy="Value"}`. The `ReplaceStrategy=` property uses one of the following values: @@ -2462,7 +2703,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2472,6 +2712,9 @@ Accept wildcard characters: False ``` ### -NonBifurcatingAccessScope + +> Applicable: Security & Compliance + The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule that looks for recipients in the specified access scope. The rule is applied to all copies of the message. Valid values are: - HasInternal: At least one recipient is inside the organization. @@ -2484,7 +2727,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2494,6 +2736,9 @@ Accept wildcard characters: False ``` ### -NotifyAllowOverride + +> Applicable: Security & Compliance + The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - FalsePositive: Allows overrides in the case of false positives. @@ -2507,7 +2752,6 @@ You can specify multiple values separated by commas. The values WithoutJustifica Type: OverrideOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2517,13 +2761,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomSenderDisplayName + +> Applicable: Security & Compliance + {{ Fill NotifyEmailCustomSenderDisplayName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2533,13 +2779,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomSubject + +> Applicable: Security & Compliance + The NotifyEmailCustomSubject parameter specifies the custom text in the subject line of email notification message that's sent to recipients when the conditions of the rule are met. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2549,12 +2797,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomText + +> Applicable: Security & Compliance + The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. This parameter has a 5000 character limit, and supports plain text, HTML tags, and the following tokens (variables): - %%AppliedActions%%: The actions applied to the content. -- %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive for Business site. +- %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive site. - %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. - %%BlockedMessageInfo%%: The details of the message that was blocked. Use this token to inform people of the details of the message that was blocked. @@ -2562,7 +2813,6 @@ This parameter has a 5000 character limit, and supports plain text, HTML tags, a Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2572,13 +2822,33 @@ Accept wildcard characters: False ``` ### -NotifyEmailExchangeIncludeAttachment + +> Applicable: Security & Compliance + {{ Fill NotifyEmailExchangeIncludeAttachment Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailOnedriveRemediationActions + +> Applicable: Security & Compliance + +{{ Fill NotifyEmailOnedriveRemediationActions Description }} + +```yaml +Type: NotifyEmailRemediationActions +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -2588,6 +2858,9 @@ Accept wildcard characters: False ``` ### -NotifyEndpointUser + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. {{ Fill NotifyEndpointUser Description }} @@ -2598,7 +2871,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2608,13 +2880,15 @@ Accept wildcard characters: False ``` ### -NotifyOverrideRequirements + +> Applicable: Security & Compliance + {{ Fill NotifyOverrideRequirements Description }} ```yaml Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2624,13 +2898,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomDialog + +> Applicable: Security & Compliance + {{ Fill NotifyPolicyTipCustomDialog Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2640,13 +2916,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomText + +> Applicable: Security & Compliance + The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2656,6 +2934,9 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomTextTranslations + +> Applicable: Security & Compliance + The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax `CultureCode:Text`. Valid culture codes are supported values from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -2666,7 +2947,6 @@ To enter multiple values, use the following syntax: `"Value1","Value2",..."Value Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2676,16 +2956,18 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipDisplayOption + +> Applicable: Security & Compliance + The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: -- Tip: Displays policy tip at the top of the mail. This is the default value. +- Tip: Displays policy tip at the top of the mail. This value is the default. - Dialog: Displays policy tip at the top of the mail and as a popup dialog. (exchange only) ```yaml Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2695,13 +2977,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipUrl + +> Applicable: Security & Compliance + The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2711,6 +2995,9 @@ Accept wildcard characters: False ``` ### -NotifyUser + +> Applicable: Security & Compliance + The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2724,7 +3011,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2734,6 +3020,9 @@ Accept wildcard characters: False ``` ### -NotifyUserType + +> Applicable: Security & Compliance + The NotifyUserType parameter specifies the type of notification that's used for the rule. Valid values are: - NotSet @@ -2745,7 +3034,6 @@ The NotifyUserType parameter specifies the type of notification that's used for Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.NotifyUserType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2755,13 +3043,15 @@ Accept wildcard characters: False ``` ### -OnPremisesScannerDlpRestrictions + +> Applicable: Security & Compliance + {{ Fill OnPremisesScannerDlpRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2771,6 +3061,9 @@ Accept wildcard characters: False ``` ### -PrependSubject + +> Applicable: Security & Compliance + The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is text that you specify. If the text contains spaces, enclose the value in quotation marks ("). Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. @@ -2781,7 +3074,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2791,6 +3083,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: @@ -2805,7 +3100,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2815,6 +3109,9 @@ Accept wildcard characters: False ``` ### -ProcessingLimitExceeded + +> Applicable: Security & Compliance + The ProcessingLimitExceeded parameter specifies a condition for the DLP rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -2824,7 +3121,6 @@ The ProcessingLimitExceeded parameter specifies a condition for the DLP rule tha Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2834,6 +3130,9 @@ Accept wildcard characters: False ``` ### -Quarantine + +> Applicable: Security & Compliance + This parameter specifies an action or part of an action for the rule. The Quarantine parameter specifies an action that quarantines messages. Valid values are: @@ -2845,7 +3144,6 @@ The Quarantine parameter specifies an action that quarantines messages. Valid va Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2855,6 +3153,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeContainsWords + +> Applicable: Security & Compliance + The RecipientADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: - City @@ -2895,7 +3196,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2905,6 +3205,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The RecipientADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -2945,7 +3248,26 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientCountOver + +> Applicable: Security & Compliance + +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: Required: False Position: Named @@ -2955,13 +3277,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Security & Compliance + The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2971,6 +3295,9 @@ Accept wildcard characters: False ``` ### -RedirectMessageTo + +> Applicable: Security & Compliance + The RedirectMessageTo parameter specifies an action for the DLP rule that redirects the message to the specified email address. You can specify multiple values separated by commas. You can use this action in DLP policies that are scoped only to Exchange. @@ -2979,7 +3306,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2989,6 +3315,9 @@ Accept wildcard characters: False ``` ### -RemoveHeader + +> Applicable: Security & Compliance + The RemoveHeader parameter specifies an action for the DLP rule that removes a header field from the message header. This parameter uses the syntax `HeaderName` or `"HeaderName:HeaderValue"`.You can specify multiple header names or header name and value pairs separated by commas: `HeaderName1,"HeaderName2:HeaderValue2",HeaderName3,..."HeaderNameN:HeaderValueN"`. The maximum header name length is 64 characters, and header names can't contains spaces or colons ( : ). The maximum header value length is 128 characters. @@ -2999,7 +3328,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3009,6 +3337,9 @@ Accept wildcard characters: False ``` ### -RemoveRMSTemplate + +> Applicable: Security & Compliance + The RemoveRMSTemplate parameter specifies an action for the DLP rule that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: - $true: The message and attachments are decrypted. @@ -3020,7 +3351,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3030,10 +3360,13 @@ Accept wildcard characters: False ``` ### -ReportSeverityLevel + +> Applicable: Security & Compliance + The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: - None: You can't select this value if the rule has no actions configured. -- Low: This is the default value. +- Low: This value is the default. - Medium - High @@ -3041,7 +3374,6 @@ The ReportSeverityLevel parameter specifies the severity level of the incident r Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3051,13 +3383,15 @@ Accept wildcard characters: False ``` ### -RestrictAccess + +> Applicable: Security & Compliance + {{ Fill RestrictAccess Description }} ```yaml Type: System.Collections.Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3067,13 +3401,15 @@ Accept wildcard characters: False ``` ### -RestrictBrowserAccess + +> Applicable: Security & Compliance + {{ Fill RestrictBrowserAccess Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3083,17 +3419,19 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Security & Compliance + The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - Ignore - RetryThenBlock -- Blank (the value $null): This is the default value. +- Blank (the value $null): This value is the default. ```yaml Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3103,6 +3441,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeContainsWords + +> Applicable: Security & Compliance + The SenderADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: - City @@ -3143,7 +3484,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3153,6 +3493,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -3193,7 +3536,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3203,13 +3545,16 @@ Accept wildcard characters: False ``` ### -SenderAddressLocation + +> Applicable: Security & Compliance + The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: -- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. +- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This value is the default. - Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). - HeaderOrEnvelope: Examine senders in the message header and the message envelope. -Note that message envelope searching is available only for the following conditions and exceptions: +Message envelope searching is available only for the following conditions and exceptions: - From and ExceptIfFrom - FromAddressContainsWords and ExceptIfFromAddressContainsWords @@ -3221,7 +3566,6 @@ Note that message envelope searching is available only for the following conditi Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicySenderAddressLocation Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3231,6 +3575,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Security & Compliance + The SenderDomainIs parameter specifies a condition for the DLP rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3239,7 +3586,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3249,6 +3595,9 @@ Accept wildcard characters: False ``` ### -SenderIPRanges + +> Applicable: Security & Compliance + The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -3261,7 +3610,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3271,6 +3619,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + The SentTo parameter specifies a condition for the DLP rule that looks for recipients in messages. You identify the recipients by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3279,7 +3630,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3289,6 +3639,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Security & Compliance + The SentToMemberOf parameter specifies a condition for the DLP rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3297,7 +3650,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3307,6 +3659,9 @@ Accept wildcard characters: False ``` ### -SetHeader + +> Applicable: Security & Compliance + The SetHeader parameter specifies an action for the DLP rule that adds or modifies a header field and value in the message header. This parameter uses the syntax `"HeaderName:HeaderValue"`. You can specify multiple header name and value pairs separated by commas: `"HeaderName1:HeaderValue1",HeaderName2:HeaderValue2",..."HeaderNameN:HeaderValueN"`. The maximum header name length is 64 characters, and header names can't contains spaces or colons ( : ). The maximum header value length is 128 characters. @@ -3317,7 +3672,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3327,11 +3681,14 @@ Accept wildcard characters: False ``` ### -SharedByIRMUserRisk -The SharedByIRMUserRisk paramter specifies the risk category of the user performing the violating action. Valid values are: -- Elevated Risk Level -- Moderate Risk Level -- Minor Risk Level +> Applicable: Security & Compliance + +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. @@ -3339,7 +3696,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3349,6 +3705,9 @@ Accept wildcard characters: False ``` ### -StopPolicyProcessing + +> Applicable: Security & Compliance + The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: - $true: Stop processing more rules. @@ -3358,7 +3717,6 @@ The StopPolicyProcessing parameter specifies an action that stops processing mor Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3368,6 +3726,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Security & Compliance + The SubjectContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in the Subject field of messages. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -3382,7 +3743,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3392,6 +3752,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Security & Compliance + The SubjectMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -3402,7 +3765,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3412,6 +3774,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Security & Compliance + The SubjectOrBodyContainsWords parameter specifies a condition for the rule that looks for words in the Subject field or body of messages. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -3422,7 +3787,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3432,6 +3796,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyMatchesPatterns + +> Applicable: Security & Compliance + The SubjectOrBodyMatchesPatterns parameter specifies a condition for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3440,7 +3807,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3450,13 +3816,15 @@ Accept wildcard characters: False ``` ### -ThirdPartyAppDlpRestrictions + +> Applicable: Security & Compliance + {{ Fill ThirdPartyAppDlpRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3466,13 +3834,15 @@ Accept wildcard characters: False ``` ### -TriggerPowerAutomateFlow + +> Applicable: Security & Compliance + {{ Fill TriggerPowerAutomateFlow Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3482,6 +3852,9 @@ Accept wildcard characters: False ``` ### -UnscannableDocumentExtensionIs + +> Applicable: Security & Compliance + The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -3490,7 +3863,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3500,13 +3872,15 @@ Accept wildcard characters: False ``` ### -ValidateRule + +> Applicable: Security & Compliance + {{ Fill ValidateRule Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3516,13 +3890,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -3532,6 +3908,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Security & Compliance + The WithImportance parameter specifies a condition for the rule that looks for messages with the specified importance level. Valid values are: - Low @@ -3544,7 +3923,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpEdmSchema.md similarity index 95% rename from exchange/exchange-ps/exchange/New-DlpEdmSchema.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpEdmSchema.md index 27c440830a..a4d2cedc0c 100644 --- a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpEdmSchema.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpedmschema applicable: Security & Compliance -title: New-DlpEdmSchema -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpedmschema +schema: 2.0.0 +title: New-DlpEdmSchema --- # New-DlpEdmSchema @@ -44,6 +45,9 @@ This example creates a new DLP EDM schema using the file named edm.xml in the fo ## PARAMETERS ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the DLP EDM schema that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -52,7 +56,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DlpFingerprint.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpFingerprint.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DlpFingerprint.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpFingerprint.md index cbd457cd29..3acf20af84 100644 --- a/exchange/exchange-ps/exchange/New-DlpFingerprint.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpFingerprint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint applicable: Security & Compliance -title: New-DlpFingerprint -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpfingerprint +schema: 2.0.0 +title: New-DlpFingerprint --- # New-DlpFingerprint @@ -48,6 +49,9 @@ This example creates a new document fingerprint based on the file C:\\My Documen ## PARAMETERS ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the file to use as a document fingerprint. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -56,7 +60,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the document fingerprint. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -91,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -IsExact + +> Applicable: Security & Compliance + {{ Fill IsExact Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -ThresholdConfig + +> Applicable: Security & Compliance + {{ Fill ThresholdConfig Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -133,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpKeywordDictionary.md similarity index 92% rename from exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpKeywordDictionary.md index 10ac021e60..b788cd9e15 100644 --- a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpKeywordDictionary.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpkeyworddictionary applicable: Security & Compliance -title: New-DlpKeywordDictionary -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpkeyworddictionary +schema: 2.0.0 +title: New-DlpKeywordDictionary --- # New-DlpKeywordDictionary @@ -32,7 +33,7 @@ New-DlpKeywordDictionary -Name ``` ## DESCRIPTION -After you create a custom sensitive information type that specifies the identity (GUID value) of the DLP keyword dictionary, the dictionary will appear in your list of sensitive information types, and you can use it in policies. +After you create a custom sensitive information type that specifies the identity (GUID value) of the DLP keyword dictionary, the dictionary appears in your list of sensitive information types, and you can use it in policies. To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). @@ -63,13 +64,15 @@ This example creates a DLP keyword dictionary named Inappropriate Language from ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the DLP keyword dictionary. 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 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -88,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies descriptive text for the DLP keyword dictionary. 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 @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -DoNotPersistKeywords + +> Applicable: Security & Compliance + {{ Fill DoNotPersistKeywords Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF-16. For more information, see the examples in this topic. ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -146,13 +157,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + {{ Fill Organization Description }} ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -162,13 +175,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DlpPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpPolicy.md similarity index 77% rename from exchange/exchange-ps/exchange/New-DlpPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpPolicy.md index 705a5e5e46..fb92390c12 100644 --- a/exchange/exchange-ps/exchange/New-DlpPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlppolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-DlpPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlppolicy +schema: 2.0.0 +title: New-DlpPolicy --- # New-DlpPolicy ## SYNOPSIS -**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. +**Note**: This cmdlet is 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. This cmdlet is functional only in on-premises Exchange. @@ -37,7 +38,7 @@ New-DlpPolicy [[-Name] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,13 +55,15 @@ This example creates a new DLP policy named Contoso PII with the following value ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a descriptive name for the DLP policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Description parameter specifies an optional description for the DLP policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mode parameter specifies the action and notification level of the DLP policy. Valid values for this parameter are: - Audit: The actions specified by the DLP policy aren't enforced when a message matches the conditions specified by the policy, and the Policy Tip isn't displayed to the user. @@ -133,7 +145,6 @@ By default, the value of this parameter is set to Audit when you create a new DL Type: RuleMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,7 +154,10 @@ Accept wildcard characters: False ``` ### -Parameters -The Parameters parameter specifies the parameter values that are required by the DLP policy template that you specify using the Template or TemplateData parameters. DLP policy templates may contain parameters that need to be populated with values from your organization. For example, a DLP policy template may include an exception group that defines users who are exempt from the DLP policy. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The Parameters parameter specifies the parameter values that are required by the DLP policy template that you specify using the Template or TemplateData parameters. DLP policy templates might contain parameters that need to be populated with values from your organization. For example, a DLP policy template might include an exception group that defines users who are exempt from the DLP policy. This parameter uses the syntax: `@{Parameter1="Value1";Parameter2="Value2"...}`. @@ -151,7 +165,6 @@ This parameter uses the syntax: `@{Parameter1="Value1";Parameter2="Value2"...}`. Type: Hashtable Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -161,13 +174,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The State parameter enables or disables the DLP policy. Valid input for this parameter is Enabled or Disabled. By default, a new DLP policy that you create is enabled. If you want to create a disabled DLP policy, specify the value Disabled for this parameter. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -177,13 +192,15 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Template parameter specifies the existing DLP policy template from which you can create a new DLP policy. You can't use the Template and TemplateData parameters in the same command. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -193,6 +210,9 @@ Accept wildcard characters: False ``` ### -TemplateData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TemplateData parameter specifies an external DLP policy template file from which you can create a new DLP policy. You can't use the TemplateData and Template parameters in the same command. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -201,7 +221,6 @@ 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, Exchange Online Required: False Position: Named @@ -211,13 +230,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationType.md similarity index 92% rename from exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationType.md index 961c0d2e48..ce313eca7d 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype applicable: Security & Compliance -title: New-DlpSensitiveInformationType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpsensitiveinformationtype +schema: 2.0.0 +title: New-DlpSensitiveInformationType --- # New-DlpSensitiveInformationType @@ -58,6 +59,9 @@ This example creates a new sensitive information type rule named "Contoso Employ ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a name for the sensitive information type rule. The value must be less than 256 characters. The value of this parameter is used in the Policy Tip that's presented to users in Outlook on the web. @@ -66,7 +70,6 @@ The value of this parameter is used in the Policy Tip that's presented to users Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Fingerprints -The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. + +> Applicable: Security & Compliance + +The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-fingerprint) or the Examples section. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the sensitive information type rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Security & Compliance + {{ Fill FileData Description }} ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -133,7 +145,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -IsExact + +> Applicable: Security & Compliance + {{ Fill IsExact Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -159,6 +172,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Security & Compliance + The Locale parameter specifies the language that's associated with the sensitive information type rule. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -169,7 +185,6 @@ You can add additional language translations to the sensitive information type r Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -ThresholdConfig + +> Applicable: Security & Compliance + {{ Fill ThresholdConfig Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -195,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationTypeRulePackage.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationTypeRulePackage.md index ff65bcc045..caee5727d4 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationTypeRulePackage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage applicable: Security & Compliance -title: New-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpsensitiveinformationtyperulepackage +schema: 2.0.0 +title: New-DlpSensitiveInformationTypeRulePackage --- # New-DlpSensitiveInformationTypeRulePackage @@ -45,6 +46,9 @@ This example imports the sensitive information type rule package C:\\My Document ## PARAMETERS ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the sensitive information type rule package that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -53,7 +57,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -MigrationId + +> Applicable: Security & Compliance + {{ Fill MigrationId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-DynamicDistributionGroup.md similarity index 84% rename from exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-DynamicDistributionGroup.md index 548bcc5965..4cf94192f6 100644 --- a/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DynamicDistributionGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dynamicdistributiongroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-DynamicDistributionGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dynamicdistributiongroup +schema: 2.0.0 +title: New-DynamicDistributionGroup --- # New-DynamicDistributionGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-DynamicDistributionGroup cmdlet to create dynamic distribution groups. A dynamic distribution group queries mail-enabled objects and builds the group membership based on the results. The group membership is recalculated whenever an email message is sent to the group. @@ -85,7 +86,7 @@ The Conditional parameters that are used with the IncludedRecipients parameter a To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -106,6 +107,9 @@ This example creates a dynamic distribution group named Washington Management Te ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the dynamic distribution group. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). This value is also used for the DisplayName property if you don't use the DisplayName parameter. @@ -114,7 +118,6 @@ This value is also used for the DisplayName property if you don't use the Displa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -141,7 +147,6 @@ You need to use this parameter when you use any Conditional parameters as part o Type: WellKnownRecipientType Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -151,6 +156,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -170,7 +178,6 @@ The maximum length for the RecipientFilter property is 2048 characters, includin Type: String Parameter Sets: CustomFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -180,6 +187,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -204,7 +214,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -214,6 +223,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -233,7 +245,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,6 +254,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -253,7 +267,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -263,6 +276,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -273,7 +289,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -283,6 +298,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -293,7 +311,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -303,6 +320,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -313,7 +333,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,6 +342,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -333,7 +355,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -343,6 +364,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -353,7 +377,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -363,6 +386,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -373,7 +399,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -383,6 +408,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -393,7 +421,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -403,6 +430,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -413,7 +443,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -423,6 +452,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -433,7 +465,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -443,6 +474,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -453,7 +487,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -463,6 +496,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -473,7 +509,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -483,6 +518,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -493,7 +531,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -503,6 +540,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -513,7 +553,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -523,6 +562,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -533,7 +575,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -543,6 +584,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -553,7 +597,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -563,6 +606,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -573,7 +619,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -583,6 +628,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -593,7 +641,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -603,6 +650,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -612,7 +662,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -622,6 +671,9 @@ Accept wildcard characters: False ``` ### -DirectMembershipOnly + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -630,7 +682,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -640,6 +691,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the dynamic distribution group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -648,7 +702,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -658,6 +711,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -666,7 +722,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -676,6 +731,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -693,7 +751,6 @@ You use this parameter to specify at least one moderator when you set the Modera Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -703,10 +760,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -714,7 +774,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -724,6 +783,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter specifies the organizational unit (OU) where the dynamic distribution group is created. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -743,7 +805,6 @@ If you don't use the RecipientContainer parameter, the location of the dynamic d Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -753,13 +814,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -769,6 +832,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -778,7 +844,7 @@ The RecipientContainer parameter specifies a filter that's based on the recipien If you don't use this parameter, the default value is the OU where the object was created. -Note that the RecipientContainer property can't be blank. The group is always limited to looking for recipients in a specific location (the value you specify for this parameter, or the location where the group was created). +The RecipientContainer property can't be blank. The group is always limited to looking for recipients in a specific location (the value you specify for this parameter, or the location where the group was created). **Note**: Although this parameter is available in Exchange Online, there's only one usable OU in an Exchange Online organization, so using this parameter has no effect. @@ -786,7 +852,6 @@ Note that the RecipientContainer property can't be blank. The group is always li Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -796,9 +861,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -808,7 +876,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -818,13 +885,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/New-EOPProtectionPolicyRule.md similarity index 87% rename from exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-EOPProtectionPolicyRule.md index 0f0e180485..02b42f2322 100644 --- a/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: New-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-eopprotectionpolicyrule +schema: 2.0.0 +title: New-EOPProtectionPolicyRule --- # New-EOPProtectionPolicyRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the New-EOPProtectionPolicyRule cmdlet to create rules for Exchange Online Protection (EOP) protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. +Use the New-EOPProtectionPolicyRule cmdlet to create rules for default email protections for all cloud mailboxes in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. **Note**: Unless you manually removed a rule using the Remove-EOPProtectionPolicyRule cmdlet, we don't recommend using this cmdlet to create rules. To create the rule, you need to specify the existing individual security policies that are associated with the preset security policy. We never recommend creating these required individual security policies manually. Turning on the preset security policy for the first time in the Microsoft Defender portal automatically creates the required individual security policies, but also creates the associated rules using this cmdlet. So, if the rules already exist, you don't need to use this cmdlet to create them. @@ -43,7 +44,7 @@ For more information about preset security policies in PowerShell, see [Preset s > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,6 +58,9 @@ This example creates the rule for the Standard preset security policy. No restri ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. Since you don't need to create rules other than those used by the Standard preset security policy or the Strict preset security policy, we highly recommend that you use the default rule names for clarity and consistency. @@ -65,7 +69,6 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -75,9 +78,12 @@ Accept wildcard characters: False ``` ### -AntiPhishPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The AntiPhishPolicy parameter specifies the existing anti-phishing policy that's associated with the preset security policy. -If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-phishing policy will be one of the following values: +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-phishing policy is one of the following values: - Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650005393`. - Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034844713`. @@ -88,7 +94,6 @@ You can find the anti-phishing policy that's used by the Standard or Strict pres Type: AntiPhishPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -98,9 +103,12 @@ Accept wildcard characters: False ``` ### -HostedContentFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedContentFilterPolicy parameter specifies the existing anti-spam policy that's associated with the preset security policy. -If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-spam policy will be one of the following values: +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-spam policy is one of the following values: - Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650006407`. - Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034847393`. @@ -111,7 +119,6 @@ You can find the anti-spam policy that's used by the Standard or Strict preset s Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -121,9 +128,12 @@ Accept wildcard characters: False ``` ### -MalwareFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedContentFilterPolicy parameter specifies the existing anti-malware policy that's associated with the preset security policy. -If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-malware policy will be one of the following values: +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-malware policy is one of the following values: - Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650007658`. - Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034871908`. @@ -134,7 +144,6 @@ You can find the anti-malware policy that's used by the Standard or Strict prese Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -169,7 +183,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -179,9 +192,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the rule is enabled. Valid values are: -- $true: The rule is enabled. The State value of the rule is Enabled. This is the default value. +- $true: The rule is enabled. The State value of the rule is Enabled. This value is the default. - $false: The rule is disabled. The State value of the rule is Disabled. After you create the rule, you turn on or turn off the preset security policy using one of the following commands: @@ -193,7 +209,6 @@ After you create the rule, you turn on or turn off the preset security policy us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,13 +218,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,6 +236,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -234,7 +254,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -244,6 +263,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -261,7 +283,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -271,6 +292,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. @@ -281,7 +305,6 @@ When you create the policy, you must use the default value. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -291,13 +314,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,6 +332,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -322,7 +350,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -332,6 +359,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -349,7 +379,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -359,13 +388,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-EcpVirtualDirectory.md similarity index 81% rename from exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-EcpVirtualDirectory.md index d888a64122..825155ed1e 100644 --- a/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-EcpVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-ecpvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-EcpVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-ecpvirtualdirectory +schema: 2.0.0 +title: New-EcpVirtualDirectory --- # New-EcpVirtualDirectory @@ -40,7 +41,7 @@ New-EcpVirtualDirectory [-AppPoolId ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,13 +55,15 @@ This example creates the ECP virtual directory on the Exchange server named Serv ## PARAMETERS ### -AppPoolId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AppPoolId parameter sets the IIS application pool where the ECP virtual directory runs. We recommend that you leave this parameter at its default setting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -79,7 +85,6 @@ 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 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,19 +112,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,16 +136,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,10 +157,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -158,7 +172,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +181,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. You need to set this parameter to allow the Autodiscover service to return the URL for the ECP virtual directory. @@ -176,7 +192,6 @@ This setting is important when Secure Sockets Layer (SSL) is used. You need to s Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,6 +201,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is important when SSL is used. You need to set this parameter to allow the Autodiscover service to return the URL for the ECP virtual directory. @@ -194,7 +212,6 @@ This setting is important when SSL is used. You need to set this parameter to al Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Path parameter sets the file system path of the ECP virtual directory. This parameter should be used with care and only when you must use a different file system path than the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,6 +239,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -231,7 +253,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +262,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -254,7 +278,6 @@ You can't create an ECP virtual directory remotely. You can only create an ECP v Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +287,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WebSiteName parameter specifies the name of the IIS website where the ECP virtual directory is created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +305,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-EdgeSubscription.md b/exchange/exchange-ps/ExchangePowerShell/New-EdgeSubscription.md similarity index 83% rename from exchange/exchange-ps/exchange/New-EdgeSubscription.md rename to exchange/exchange-ps/ExchangePowerShell/New-EdgeSubscription.md index e7c67b1d70..4732c31488 100644 --- a/exchange/exchange-ps/exchange/New-EdgeSubscription.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-EdgeSubscription.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-edgesubscription -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-EdgeSubscription -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-edgesubscription +schema: 2.0.0 +title: New-EdgeSubscription --- # New-EdgeSubscription @@ -35,9 +36,9 @@ New-EdgeSubscription [-AccountExpiryDuration ] ``` ## DESCRIPTION -The Edge Transport server doesn't have access to Active Directory. All configuration and recipient information is stored in the Active Directory Lightweight Directory Services (AD LDS) instance. The New-EdgeSubscription cmdlet creates the Edge Subscription file that will be imported on a Mailbox server in the Active Directory site to which you want to subscribe this Edge Transport server. +The Edge Transport server doesn't have access to Active Directory. All configuration and recipient information is stored in the Active Directory Lightweight Directory Services (AD LDS) instance. The New-EdgeSubscription cmdlet creates the Edge Subscription file to import on a Mailbox server in the Active Directory site where you want to subscribe this Edge Transport server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,7 +70,10 @@ This example also imports the Edge Subscription file generated in Example 1 to t ## PARAMETERS ### -AccountExpiryDuration -The AccountExpiryDuration parameter specifies how soon the EdgeSync bootstrap replication account (ESBRA) created by this command will expire. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The AccountExpiryDuration parameter specifies how soon the EdgeSync bootstrap replication account (ESBRA) created by this command expires. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -79,7 +83,6 @@ The value for this parameter must be a minimum of 00:02:00 or 2 minutes. The def Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -98,7 +104,6 @@ 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 Required: False Position: Named @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -CreateInboundSendConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CreateInboundSendConnector parameter specifies whether to create the Send connector to connect the Edge Transport server and the Hub Transport servers. The default value is $true. The Send connector address space is set to "--", the smart hosts are set to "--", the Edge Transport server is set as the source server and Domain Name System (DNS) routing is disabled. This parameter is only used when you run the command on the Hub Transport server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -CreateInternetSendConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CreateInternetSendConnector parameter specifies whether to create the Send connector to connect to the Internet. The default value is $true. The Send connector address space is set to all domains (\*), the Edge Transport server is set as the source server, and DNS routing is enabled. This parameter is only used when you run the command on the Hub Transport server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -148,7 +160,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -158,6 +169,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FileData parameter specifies the byte-encoded data object that contains the Edge Subscription file information. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -168,7 +182,6 @@ You can only use this parameter when you're running the command on a Mailbox ser Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FileName parameter specifies the full path of the Edge Subscription file. You can only use this parameter when you're running this command on an Edge Transport server. @@ -186,7 +202,6 @@ You can only use this parameter when you're running this command on an Edge Tran Type: LongPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,6 +211,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. This switch is useful in the following scenarios: @@ -207,7 +225,6 @@ This switch is useful in the following scenarios: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,13 +234,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Site parameter specifies the name of the Active Directory site that contains the Mailbox servers with which the Edge Transport servers are associated. This parameter is used and required only when you run the command on a Mailbox server. ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,13 +252,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md b/exchange/exchange-ps/ExchangePowerShell/New-EdgeSyncServiceConfig.md similarity index 81% rename from exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/New-EdgeSyncServiceConfig.md index f961f43a6f..3558c79196 100644 --- a/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-EdgeSyncServiceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-edgesyncserviceconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-EdgeSyncServiceConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-edgesyncserviceconfig +schema: 2.0.0 +title: New-EdgeSyncServiceConfig --- # New-EdgeSyncServiceConfig @@ -42,7 +43,7 @@ New-EdgeSyncServiceConfig [-ConfigurationSyncInterval ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,6 +62,9 @@ This example creates EdgeSync service settings with the following configuration: ## PARAMETERS ### -ConfigurationSyncInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigurationSyncInterval parameter specifies how frequently the EdgeSync service synchronizes configuration data. The default value is 3 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. @@ -69,7 +73,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -88,7 +94,6 @@ 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 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -CookieValidDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CookieValidDuration parameter specifies how long a cookie record is valid. The default value is 21 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -106,7 +114,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -FailoverDCInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FailoverDCInterval parameter specifies how long EdgeSync waits before failing over to another domain controller if it can't read configuration data from Active Directory. 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. @@ -140,7 +152,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -LockDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LockDuration parameter specifies how long an instance of the EdgeSync service can maintain an exclusive lock on the synchronization rights. While an EdgeSync service maintains an exclusive lock on synchronization rights, no other EdgeSync service can take over synchronization. The default value is 6 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. @@ -158,7 +172,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +181,9 @@ Accept wildcard characters: False ``` ### -LockRenewalDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LockRenewalDuration parameter specifies how long before the expiry of an exclusive lock an EdgeSync service can renew the lock. The default value is 4 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. @@ -176,7 +192,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -LogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogEnabled parameter enables or disables the EdgeSync log. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,9 +219,12 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogLevel parameter specifies the EdgeSync logging level. Valid values are: -- None (This is the default value) +- None (default value) - Low - Medium - High @@ -213,7 +233,6 @@ The LogLevel parameter specifies the EdgeSync logging level. Valid values are: Type: EdgeSyncLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -223,6 +242,9 @@ Accept wildcard characters: False ``` ### -LogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogMaxAge parameter specifies the maximum duration in days to keep the EdgeSyncLog files. Log files older than the specified value can be overwritten. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -231,7 +253,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +262,9 @@ Accept wildcard characters: False ``` ### -LogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogMaxDirectorySize parameter specifies the maximum amount of disk space the EdgeSyncLog directory can use. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -251,7 +275,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the LogMaxFileSize parameter must be less than or equal to the value of the LogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the EdgeSyncLLog directory. @@ -259,7 +283,6 @@ The value of the LogMaxFileSize parameter must be less than or equal to the valu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -269,6 +292,9 @@ Accept wildcard characters: False ``` ### -LogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogMaxFileSize parameter specifies the maximum log file size for the EdgeSyncLog files. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -279,7 +305,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the LogMaxFileSize parameter must be less than or equal to the value of the LogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the EdgeSyncLog files. @@ -287,7 +313,6 @@ The value of the LogMaxFileSize parameter must be less than or equal to the valu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,13 +322,15 @@ Accept wildcard characters: False ``` ### -LogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogPath parameter specifies the default location for the EdgeSyncLog files. The default value is TransportRoles\\Logs\\EdgeSync\\. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,6 +340,9 @@ Accept wildcard characters: False ``` ### -OptionDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OptionDuration parameter specifies how long an instance of the EdgeSync service can maintain an optional lock on synchronization rights. While an EdgeSync service maintains an optional lock on synchronization rights, another EdgeSync service can take over synchronization after the optional lock has expired if it's initiated using the Start-EdgeSynchronization command. The default value is 30 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. @@ -321,7 +351,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -331,6 +360,9 @@ Accept wildcard characters: False ``` ### -RecipientSyncInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecipientSyncInterval parameter specifies how frequently the EdgeSync service synchronizes recipient data from the global catalog. 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. @@ -339,7 +371,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -349,13 +380,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Site parameter specifies the Active Directory site that EdgeSync connects to for synchronizing configuration and recipient data. ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -365,13 +398,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-EmailAddressPolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/New-EmailAddressPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-EmailAddressPolicy.md index 966babe33d..47015880ec 100644 --- a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-EmailAddressPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-emailaddresspolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-EmailAddressPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-emailaddresspolicy +schema: 2.0.0 +title: New-EmailAddressPolicy --- # New-EmailAddressPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-EmailAddressPolicy cmdlet to create email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups. @@ -140,7 +141,7 @@ The Conditional parameters that are used with the IncludedRecipients parameter a To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPATH filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -173,13 +174,15 @@ This example creates an email address policy in an on-premises Exchange organiza ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name of the email address policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -189,6 +192,9 @@ Accept wildcard characters: False ``` ### -EnabledEmailAddressTemplates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EnabledEmailAddressTemplates parameter specifies the rules in the email address policy that are used to generate email addresses for recipients. Valid syntax for this parameter is `Type:AddressFormat`: @@ -208,7 +214,6 @@ In Exchange Online PowerShell, you can't use variables in the email address temp Type: ProxyAddressTemplateCollection Parameter Sets: AllTemplatesWithPrecannedFilter, AllTemplatesWithCustomFilter, AllTemplatesForUnifiedGroupRecipientsFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -218,6 +223,9 @@ Accept wildcard characters: False ``` ### -EnabledPrimarySMTPAddressTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EnabledPrimarySMTPAddressTemplate parameter specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. @@ -230,7 +238,6 @@ In Exchange Online PowerShell, you can't use variables in the email address temp Type: String Parameter Sets: SMTPTemplateWithPrecannedFilter, SMTPTemplateWithCustomFilter, SMTPTemplateForUnifiedGroupRecipientsFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -240,6 +247,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: @@ -259,7 +269,6 @@ You need to use this parameter when you use any Conditional parameters as part o Type: WellKnownRecipientType Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -269,6 +278,9 @@ Accept wildcard characters: False ``` ### -IncludeUnifiedGroupRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeUnifiedGroupRecipients switch specifies that the email address policy applies only to Microsoft 365 Groups. You don't need to specify a value with this switch. @@ -279,7 +291,6 @@ In Exchange Online PowerShell, you always need to use this switch, because email Type: SwitchParameter Parameter Sets: AllTemplatesForUnifiedGroupRecipientsFilter, SMTPTemplateForUnifiedGroupRecipientsFilter Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -289,6 +300,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. @@ -308,7 +322,6 @@ You can't use this parameter in combination with the IncludedRecipients paramete Type: String Parameter Sets: AllTemplatesWithCustomFilter, SMTPTemplateWithCustomFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -318,6 +331,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. You can specify multiple values separated by commas. @@ -330,7 +346,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,6 +355,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. @@ -352,7 +370,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -362,6 +379,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. @@ -374,7 +394,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -384,6 +403,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. @@ -396,7 +418,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,6 +427,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. @@ -418,7 +442,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -428,6 +451,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. @@ -440,7 +466,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -450,6 +475,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. @@ -462,7 +490,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -472,6 +499,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. @@ -484,7 +514,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -494,6 +523,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. @@ -506,7 +538,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -516,6 +547,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. @@ -528,7 +562,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -538,6 +571,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. @@ -550,7 +586,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -560,6 +595,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. @@ -572,7 +610,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -582,6 +619,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. @@ -594,7 +634,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -604,6 +643,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. @@ -616,7 +658,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -626,6 +667,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. @@ -638,7 +682,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -648,6 +691,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. @@ -660,7 +706,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -670,6 +715,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. @@ -682,7 +730,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -692,6 +739,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. @@ -704,7 +754,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -714,6 +763,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -723,7 +775,6 @@ 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 Required: False Position: Named @@ -733,13 +784,16 @@ Accept wildcard characters: False ``` ### -DisabledEmailAddressTemplates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DisabledEmailAddressTemplates parameter specifies the proxy email addresses templates that are included in an email address policy, but aren't used to configure the email addresses of recipients. Valid syntax for this parameter is `Type:AddressFormat`: -- Type: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. +- Type: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. You can't use SMTP to specify a disabled primary SMTP email address. - AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. You can specify multiple disabled email address templates separated by commas: `"[Type1:]EmailAddress1","[Type2:]EmailAddress2",..."[TypeN:]EmailAddressN"`. @@ -748,7 +802,6 @@ You can specify multiple disabled email address templates separated by commas: ` Type: ProxyAddressTemplateCollection Parameter Sets: AllTemplatesWithPrecannedFilter, AllTemplatesWithCustomFilter, AllTemplatesForUnifiedGroupRecipientsFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -758,6 +811,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -766,7 +822,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -776,6 +831,9 @@ Accept wildcard characters: False ``` ### -ManagedByFilter + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ManagedByFilter parameter specifies the email address policies to apply to Microsoft 365 Groups based on the properties of the users who create the Microsoft 365 Groups. @@ -798,7 +856,6 @@ You can only use this parameter in Exchange Online PowerShell with the IncludeUn Type: String Parameter Sets: AllTemplatesForUnifiedGroupRecipientsFilter, SMTPTemplateForUnifiedGroupRecipientsFilter Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -808,6 +865,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Priority parameter specifies the order that the email address policies are evaluated. By default, every time that you add a new email address policy, the policy is assigned a priority of N+1, where N is the number of email address policies that you've created. If you set this parameter to a value that's the same as another email address policy, the priority of the policy that you added first is incremented by 1. @@ -818,7 +878,6 @@ If you set this parameter to a value that's the same as another email address po Type: EmailAddressPolicyPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -828,6 +887,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -843,7 +905,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -853,13 +914,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/New-ExchangeCertificate.md similarity index 89% rename from exchange/exchange-ps/exchange/New-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/New-ExchangeCertificate.md index 5d957d9ce7..34bd153ff5 100644 --- a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-exchangecertificate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ExchangeCertificate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-exchangecertificate +schema: 2.0.0 +title: New-ExchangeCertificate --- # New-ExchangeCertificate @@ -71,7 +72,7 @@ There are many factors to consider when you configure certificates for Transport Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center, and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). To find out why you should disable the SSL protocol and switch to TLS, check out [Protecting you against the SSL 3.0 vulnerability](https://azure.microsoft.com/blog/protecting-against-the-ssl-3-0-vulnerability/). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -180,6 +181,9 @@ This example creates a new DER encoded (binary) certificate renewal request file ## PARAMETERS ### -BinaryEncoded + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BinaryEncoded switch specifies whether to encode the new certificate request by using Distinguished Encoding Rules (DER). You don't need to specify a value with this switch. If you don't use this switch, the request is Base64 encoded. @@ -192,7 +196,6 @@ For Base64 encoded requests, you send the contents of the file to the certificat Type: SwitchParameter Parameter Sets: Request Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +205,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -211,7 +217,6 @@ 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 Required: False Position: Named @@ -221,6 +226,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -229,7 +237,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,6 +246,9 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainName parameter specifies one or more FQDNs or server names for theSubject Alternative Name field (also known as the Subject Alt Name or SAN field) of the certificate request or self-signed certificate. If the value in the certificate's Subject field doesn't match the destination server name or FQDN, the requestor looks for a match in the Subject Alternative Name field. @@ -254,7 +264,6 @@ The default value includes the name and FQDN of the Exchange server when both of Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,6 +273,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. By default, when you create a self-signed certificate that's enabled for SMTP (no Services parameter, or the Services parameter contains the value SMTP), you're prompted to replace the existing default SMTP certificate with the new one that you're creating. If you use the Force switch, the new SMTP certificate automatically replaces the existing SMTP certificate without asking. @@ -272,7 +284,6 @@ By default, when you create a self-signed certificate that's enabled for SMTP (n Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -282,6 +293,9 @@ Accept wildcard characters: False ``` ### -FriendlyName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FriendlyName parameter specifies a friendly name for the certificate request or self-signed certificate. The value must be less than 64 characters. The default value is Microsoft Exchange. The friendly name value is descriptive text, and doesn't affect the functionality of the certificate. @@ -290,7 +304,6 @@ The default value is Microsoft Exchange. The friendly name value is descriptive Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,6 +313,9 @@ Accept wildcard characters: False ``` ### -GenerateRequest + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GenerateRequest switch specifies that you're creating a certificate request for a certification authority (CA). You don't need to specify a value with this switch. Using this switch and exporting the output to a file generates a PKCS #10 certificate request that you send to the CA. How you send the information depends on the CA, but typically, for Base64 encoded requests, you paste the contents in an email message or in the request form on the CA's web site. @@ -312,7 +328,6 @@ If you don't use this switch, the command creates a new self-signed certificate Type: SwitchParameter Parameter Sets: Request Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,6 +337,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptedDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeAcceptedDomains switch specifies that all accepted domains in the Exchange organization are included in the Subject Alternative Name field of the certificate request or self-signed certificate. You don't need to specify a value with this switch. When you use this switch: @@ -333,7 +351,6 @@ When you use this switch: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -343,6 +360,9 @@ Accept wildcard characters: False ``` ### -IncludeAutoDiscover + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeAutoDiscover switch specifies whether to add a Subject Alternative Namevalue with the prefix autodiscover for each accepted domain in the Exchange organization. You don't need to specify a value with this switch. For example, if the organization has the accepted domains woodgrovebank.com and woodgrovebank.co.uk, using this switch results in the addition of the following values in the Subject Alternative Name field: @@ -359,7 +379,6 @@ When you use this switch: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -369,6 +388,9 @@ Accept wildcard characters: False ``` ### -IncludeServerFQDN + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeServerFQDN switch specifies that the FQDN of the Exchange server is included in the Subject Alternative Name field of the new certificate request or self-signed certificate. You don't need to specify a value with this switch. When you use this switch, and you've already included the server's FQDN in the DomainName parameter, the value isn't duplicated in the Subject Alternative Name field. @@ -377,7 +399,6 @@ When you use this switch, and you've already included the server's FQDN in the D Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -387,6 +408,9 @@ Accept wildcard characters: False ``` ### -IncludeServerNetBIOSName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeServerNetBIOSName switch specifies that the NetBIOS name of the Exchange server is included in the Subject Alternative Name field of the new certificate request or self-signed certificate. You don't need to specify a value with this switch When you use this switch, and you've already included the server's NetBIOS name in the DomainName parameter, the value isn't duplicated in the Subject Alternative Name field. @@ -395,7 +419,6 @@ When you use this switch, and you've already included the server's NetBIOS name Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -405,13 +428,15 @@ Accept wildcard characters: False ``` ### -Instance -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: X509Certificate2 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -421,17 +446,19 @@ Accept wildcard characters: False ``` ### -KeySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The KeySize parameter specifies the size (in bits) of the RSA public key that's associated with the new certificate request or self-signed certificate. Valid values are: - 1024 -- 2048 (This is the default value) +- 2048 (default value) - 4096 ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -441,16 +468,18 @@ Accept wildcard characters: False ``` ### -PrivateKeyExportable + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PrivateKeyExportable parameter specifies whether the certificate has an exportable private key, and controls whether you can export the certificate from the server (and import the certificate on other servers). Valid values are: - $true: The private key is exportable, so you can export the certificate from the server. -- $false: The private key isn't exportable, so you can't export the certificate. This is the default value. +- $false: The private key isn't exportable, so you can't export the certificate. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -460,6 +489,9 @@ Accept wildcard characters: False ``` ### -RequestFile + +> Applicable: Exchange Server 2013 + **Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To export the certificate request to a file without using the RequestFile parameter, see Example 4 and Example 5 (new) or Example 7 and Example 8 (renew). This parameter is available only in Exchange 2013. @@ -474,7 +506,6 @@ You can use this parameter only when you use the GenerateRequest switch. Type: String Parameter Sets: Request Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -484,6 +515,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -497,7 +531,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -507,6 +540,9 @@ Accept wildcard characters: False ``` ### -Services + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Services parameter specifies the Exchange services that the new self-signed certificate is enabled for. Valid values are: - None: You can enable the certificate for Exchange services later by using the Enable-ExchangeCertificate cmdlet. @@ -528,7 +564,6 @@ Once you enable a certificate for a service, you can't remove the service from t Type: AllowedServices Parameter Sets: Certificate Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -538,13 +573,15 @@ Accept wildcard characters: False ``` ### -SubjectKeyIdentifier + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SubjectKeyIdentifier parameter specifies the unique subject key identifier for a newself-signed certificate. For example, run the command: $ski = [System.Guid]::NewGuid().ToString("N"), and use the value $ski for this parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -554,6 +591,9 @@ Accept wildcard characters: False ``` ### -SubjectName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SubjectName parameter specifies the Subject field of the certificate request or self-signed certificate. Every certificate requires a value for the Subject field, and only one value is allowed. The requestor attempts to match the destination server name or FQDN with the common name (CN) value of subject. @@ -576,7 +616,6 @@ For a wildcard certificate, use a SubjectName value that contains the wildcard c Type: X500DistinguishedName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -586,13 +625,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ExchangeSettings.md b/exchange/exchange-ps/ExchangePowerShell/New-ExchangeSettings.md similarity index 81% rename from exchange/exchange-ps/exchange/New-ExchangeSettings.md rename to exchange/exchange-ps/ExchangePowerShell/New-ExchangeSettings.md index abedc962ae..8341371024 100644 --- a/exchange/exchange-ps/exchange/New-ExchangeSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ExchangeSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-exchangesettings -applicable: Exchange Server 2016, Exchange Server 2019 -title: New-ExchangeSettings -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-exchangesettings +schema: 2.0.0 +title: New-ExchangeSettings --- # New-ExchangeSettings @@ -30,7 +31,7 @@ New-ExchangeSettings [-Name] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example creates a new Exchange settings object for the Audit configuration ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of a valid Exchange configuration schema that you want to create an Exchange settings object for. Valid values are - ADDriver @@ -60,7 +64,6 @@ The Name parameter specifies the name of a valid Exchange configuration schema t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +112,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -113,7 +123,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ExoPhishSimOverrideRule.md similarity index 77% rename from exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ExoPhishSimOverrideRule.md index cc46098b0a..89aac16ff6 100644 --- a/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ExoPhishSimOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-exophishsimoverriderule applicable: Exchange Online -title: New-ExoPhishSimOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-exophishsimoverriderule +schema: 2.0.0 +title: New-ExoPhishSimOverrideRule --- # New-ExoPhishSimOverrideRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the New-ExoPhishSimOverrideRule cmdlet to create third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +Use the New-ExoPhishSimOverrideRule cmdlet to create non-Microsoft phishing simulation override rules that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -33,7 +34,7 @@ New-ExoPhishSimOverrideRule -Policy -SenderIpRanges ` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). +This example creates a new phishing simulation override rule with the specified settings. Regardless of the Name value specified, the rule name is `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). ## PARAMETERS ### -Policy + +> Applicable: Exchange Online + The Policy parameter specifies the phishing simulation override policy that's associated with the rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -58,7 +62,6 @@ The Policy parameter specifies the phishing simulation override policy that's as Type: PolicyIdParameter Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -68,7 +71,10 @@ Accept wildcard characters: False ``` ### -SenderIpRanges -The SenderIpRanges parameter specifies the source IP address that's used by the third-party phishing simulation. Valid values are: + +> Applicable: Exchange Online + +The SenderIpRanges parameter specifies the source IP address that's used by the non-Microsoft phishing simulation. Valid values are: - Single IP address: For example, 192.168.1.1. - IP address range: For example, 192.168.0.1-192.168.0.254. @@ -82,7 +88,6 @@ A phishing simulation entry requires at least one IP address in this parameter a Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -117,7 +127,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -143,7 +154,10 @@ Accept wildcard characters: False ``` ### -Domains -The Domains parameter specifies the email domain that's used by the third-party phishing simulation. You can use either of the following values: + +> Applicable: Exchange Online + +The Domains parameter specifies the email domain that's used by the non-Microsoft phishing simulation. You can use either of the following values: - The `5321.MailFrom` address (also known as the MAIL FROM address, P1 sender, or envelope sender). - The DKIM domain. @@ -156,7 +170,6 @@ A phishing simulation requires at least one domain from this parameter and at le Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies the name for the policy. Regardless of the value you specify, the name will be `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +> Applicable: Exchange Online + +The Name parameter specifies the name for the policy. Regardless of the value you specify, the name is `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -182,13 +197,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ExoSecOpsOverrideRule.md similarity index 72% rename from exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ExoSecOpsOverrideRule.md index 7abc967735..675ba08cc7 100644 --- a/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ExoSecOpsOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-exosecopsoverriderule applicable: Exchange Online -title: New-ExoSecOpsOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-exosecopsoverriderule +schema: 2.0.0 +title: New-ExoSecOpsOverrideRule --- # New-ExoSecOpsOverrideRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the New-ExoSecOpsOverrideRule cmdlet to create SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +Use the New-ExoSecOpsOverrideRule cmdlet to create SecOps mailbox override rules that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -32,7 +33,7 @@ New-ExoSecOpsOverrideRule -Policy ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,11 +42,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi New-ExoSecOpsOverrideRule -Name SecOpsOverrideRule -Policy SecOpsOverridePolicy ``` -This example creates the SecOps mailbox override rule with the specified settings. Regardless of the Name value specified, the rule name will be `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977efb). +This example creates the SecOps mailbox override rule with the specified settings. Regardless of the Name value specified, the rule name is `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977efb). ## PARAMETERS ### -Policy + +> Applicable: Exchange Online + The Policy parameter specifies the phishing simulation override policy that's associated with the rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Policy parameter specifies the phishing simulation override policy that's as Type: PolicyIdParameter Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -115,13 +124,15 @@ 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). + +> Applicable: Exchange Online + +The Name parameter specifies the name for the policy. Regardless of the value you specify, the name is `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977ef). ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -131,13 +142,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/ExchangePowerShell/New-FeatureConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/New-FeatureConfiguration.md new file mode 100644 index 0000000000..bb04d6b1e3 --- /dev/null +++ b/exchange/exchange-ps/ExchangePowerShell/New-FeatureConfiguration.md @@ -0,0 +1,236 @@ +--- +applicable: Security & Compliance +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-featureconfiguration +schema: 2.0.0 +title: New-FeatureConfiguration +--- + +# 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 + +> Applicable: Security & Compliance + +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: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureScenario + +> Applicable: Security & Compliance + +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: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode + +> Applicable: Security & Compliance + +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: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScenarioConfig + +> Applicable: Security & Compliance + +The ScenarioConfig parameter specifies additional information about the feature configuration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment + +> Applicable: Security & Compliance + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Security & Compliance + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations + +> Applicable: Security & Compliance + +The locations parameter specifies where the feature configuration applies. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Security & Compliance + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FederationTrust.md b/exchange/exchange-ps/ExchangePowerShell/New-FederationTrust.md similarity index 82% rename from exchange/exchange-ps/exchange/New-FederationTrust.md rename to exchange/exchange-ps/ExchangePowerShell/New-FederationTrust.md index b1f50c5c62..3068107b6d 100644 --- a/exchange/exchange-ps/exchange/New-FederationTrust.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FederationTrust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-federationtrust -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-FederationTrust -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-federationtrust +schema: 2.0.0 +title: New-FederationTrust --- # New-FederationTrust @@ -50,7 +51,7 @@ Federation trusts are trusts created between an Exchange organization and the Mi For more information, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,13 +65,15 @@ This example creates the federation trust Microsoft Federation Gateway with a ce ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a friendly name for the federation trust. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -ApplicationUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ApplicationUri parameter specifies the primary domain used for the federated organization identifier. If you specify the ApplicationUri parameter, you must use the SkipNamespaceProviderProvisioning switch and also specify the AdministratorProvisioningId and ApplicationIdentifier parameters. @@ -88,7 +94,6 @@ If you specify the ApplicationUri parameter, you must use the SkipNamespaceProvi Type: String Parameter Sets: SkipNamespaceProviderProvisioning Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -SkipNamespaceProviderProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipNamespaceProviderProvisioning switch specifies that the trust and federated organization identifier are provisioned externally without using federation functionality in Microsoft Exchange. You don't need to specify a value with this switch. If you use this switch, you must specify the ApplicationIdentifier, ApplicationUri and AdministratorProvisioningId parameters. @@ -106,7 +114,6 @@ If you use this switch, you must specify the ApplicationIdentifier, ApplicationU Type: SwitchParameter Parameter Sets: SkipNamespaceProviderProvisioning Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Thumbprint parameter specifies the thumbprint of a certificate issued by a public certification authority (CA) trusted by the Microsoft Federation Gateway. For more details, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -AdministratorProvisioningId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AdministratorProvisioningId parameter specifies the provisioning key returned by the Microsoft Federation Gateway when an organization has already registered a SiteID or ApplicationID. If you specify the AdministratorProvisioningId parameter, you must use the SkipNamespaceProviderProvisioning switch and also specify the ApplicationIdentifier and ApplicationUri parameters. @@ -140,7 +152,6 @@ If you specify the AdministratorProvisioningId parameter, you must use the SkipN Type: String Parameter Sets: SkipNamespaceProviderProvisioning Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -ApplicationIdentifier + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ApplicationIdentifier parameter specifies the SiteID or ApplicationID when an organization has already registered a SiteID or ApplicationID. If you specify the ApplicationIdentifier parameter, you must use the SkipNamespaceProviderProvisioning switch and also specify the AdministratorProvisioningId and ApplicationUri parameters. @@ -158,7 +172,6 @@ If you specify the ApplicationIdentifier parameter, you must use the SkipNamespa Type: String Parameter Sets: SkipNamespaceProviderProvisioning Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +181,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -177,7 +193,6 @@ 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 Required: False Position: Named @@ -187,13 +202,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,13 +220,15 @@ Accept wildcard characters: False ``` ### -MetadataUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MetadataUrl parameter specifies the URL where WS-FederationMetadata is published by the Microsoft Federation Gateway. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -SuppressDnsWarning + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The SuppressDNSWarning switch specifies whether to display the DNS warning message for creating TXT records in your public DNS when running the New-FederationTrust cmdlet. You don't need to specify a value with this switch. @@ -229,7 +251,6 @@ This switch is used automatically by the Hybrid Configuration wizard. We don't r Type: SwitchParameter Parameter Sets: FederationTrust Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -239,6 +260,9 @@ Accept wildcard characters: False ``` ### -UseLegacyProvisioningService + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseLegacyProvisioningService switch specifies that the legacy interface on the Microsoft Federation Gateway is used for managing the federation trust, including federated domains, certificates, and federation metadata. You don't need to specify a value with this switch. When using a self-signed certificate for configuring a federation trust with the Microsoft Federation Gateway, the trust needs to be created using this switch. After the federation trust is created, this behavior can't be changed and requires the deletion and re-creation of the federation trust. @@ -247,7 +271,6 @@ When using a self-signed certificate for configuring a federation trust with the Type: SwitchParameter Parameter Sets: FederationTrust Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,13 +280,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyAuthority.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyAuthority.md index 4d11d7b876..08dece03d0 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyAuthority.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertyauthority applicable: Security & Compliance -title: New-FilePlanPropertyAuthority +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertyauthority schema: 2.0.0 +title: New-FilePlanPropertyAuthority --- # New-FilePlanPropertyAuthority @@ -39,13 +41,15 @@ This example creates a new file plan property authority named Contoso Authority. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property authority. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,6 +59,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -64,7 +71,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +80,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCategory.md index acdefd1244..4f7f68b402 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertycategor applicable: Security & Compliance -title: New-FilePlanPropertyCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertycategor schema: 2.0.0 +title: New-FilePlanPropertyCategory --- # New-FilePlanPropertyCategory @@ -39,13 +41,15 @@ This example creates a new file plan property category named Contoso Category. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property category. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,6 +59,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -64,7 +71,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +80,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCitation.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCitation.md index 80625e0af9..aa14c036c8 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCitation.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertycitation applicable: Security & Compliance -title: New-FilePlanPropertyCitation +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertycitation schema: 2.0.0 +title: New-FilePlanPropertyCitation --- # New-FilePlanPropertyCitation @@ -39,13 +41,15 @@ This example creates a new file plan property citation named Contoso-0001. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property citation. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,13 +59,15 @@ Accept wildcard characters: False ``` ### -CitationUrl + +> Applicable: Security & Compliance + The CitationJurisdiction parameter specifies the jurisdiction for the file plan property citation. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -71,13 +77,15 @@ Accept wildcard characters: False ``` ### -CitationJurisdiction + +> Applicable: Security & Compliance + The CitationJurisdiction parameter specifies the URL for the file plan property citation. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 2 @@ -87,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -96,7 +107,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -106,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyDepartment.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyDepartment.md index 8d084f8c09..99d970af33 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyDepartment.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertydepartment applicable: Security & Compliance -title: New-FilePlanPropertyDepartment +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertydepartment schema: 2.0.0 +title: New-FilePlanPropertyDepartment --- # New-FilePlanPropertyDepartment @@ -39,13 +41,15 @@ This example creates a new file plan property department named Contoso HR. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property department. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,6 +59,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -64,7 +71,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +80,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyReferenceId.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyReferenceId.md index f32d9f3ac4..81702c562c 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyReferenceId.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertyreferenceid applicable: Security & Compliance -title: New-FilePlanPropertyReferenceId +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertyreferenceid schema: 2.0.0 +title: New-FilePlanPropertyReferenceId --- # New-FilePlanPropertyReferenceId @@ -39,13 +41,15 @@ This example creates a new file plan property reference ID named Contoso-0001. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property reference ID. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,6 +59,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -64,7 +71,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +80,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertySubCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertySubCategory.md index ceff1b7f3e..2488a54aa6 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertySubCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertysubcategory applicable: Security & Compliance -title: New-FilePlanPropertySubCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertysubcategory schema: 2.0.0 +title: New-FilePlanPropertySubCategory --- # New-FilePlanPropertySubCategory @@ -39,13 +41,15 @@ This example creates a new file plan property subcategory named US Tax that's a ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property subcategory. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,6 +59,9 @@ Accept wildcard characters: False ``` ### -ParentId + +> Applicable: Security & Compliance + The ParentId parameter specifies parent file plan property category for this subcategory. You can use any value that uniquely identifies the parent category. For example: - Name @@ -65,7 +72,6 @@ The ParentId parameter specifies parent file plan property category for this sub Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -75,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -84,7 +93,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-Fingerprint.md b/exchange/exchange-ps/ExchangePowerShell/New-Fingerprint.md similarity index 79% rename from exchange/exchange-ps/exchange/New-Fingerprint.md rename to exchange/exchange-ps/ExchangePowerShell/New-Fingerprint.md index b2d1f80558..1e126802d1 100644 --- a/exchange/exchange-ps/exchange/New-Fingerprint.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-Fingerprint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fingerprint -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-Fingerprint -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fingerprint +schema: 2.0.0 +title: New-Fingerprint --- # New-Fingerprint @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -**Note**: In Exchange Online, this cmdlet has been replaced by the [New-DlpFingerPrint](https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint) cmdlet in Security & Compliance PowerShell. +**Note**: In Exchange Online, this cmdlet is replaced by the [New-DlpFingerPrint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpfingerprint) cmdlet in Security & Compliance PowerShell. Use the New-Fingerprint cmdlet to create document fingerprints that are used with data classification rules. Because the results of New-Fingerprint are not stored outside of the data classification rule, you always run New-Fingerprint and New-DataClassification or Set-DataClassification in the same PowerShell session. @@ -32,7 +33,7 @@ New-Fingerprint [[-FileData] ] -Description ## DESCRIPTION Classification rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example creates a new document fingerprint based on the file C:\\My Documen ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FileData parameter specifies the file to use as a document fingerprint. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -56,7 +60,6 @@ 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, Exchange Online Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Description parameter specifies a description for the document fingerprint. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -91,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ForeignConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-ForeignConnector.md similarity index 78% rename from exchange/exchange-ps/exchange/New-ForeignConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-ForeignConnector.md index 07676050af..7903f6f0e9 100644 --- a/exchange/exchange-ps/exchange/New-ForeignConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ForeignConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-foreignconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ForeignConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-foreignconnector +schema: 2.0.0 +title: New-ForeignConnector --- # New-ForeignConnector @@ -31,9 +32,9 @@ New-ForeignConnector [-Name] -AddressSpaces ``` ## DESCRIPTION -A Foreign connector uses a Drop directory in the Transport service of a Mailbox server to send messages to a local messaging server that doesn't use SMTP as its primary transport mechanism. These messaging servers are known as foreign gateway servers. Third-party fax gateway servers are examples of foreign gateway servers. The address spaces assigned to a Foreign connector can be SMTP or non-SMTP. +A Foreign connector uses a Drop directory in the Transport service of a Mailbox server to send messages to a local messaging server that doesn't use SMTP as its primary transport mechanism. These messaging servers are known as foreign gateway servers. Non-Microsoft fax gateway servers are examples of foreign gateway servers. The address spaces assigned to a Foreign connector can be SMTP or non-SMTP. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example creates a Foreign connector with the following properties: ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name for the Foreign connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,9 +72,12 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. -- AddressSpaceType: The address space type may be SMTP, X400, or any other text string. If you omit the address space type, an SMTP address space type is assumed. +- AddressSpaceType: The address space type might be SMTP, X400, or any other text string. If you omit the address space type, an SMTP address space type is assumed. - AddressSpace: For SMTP address space types, the address space that you enter must be RFC 1035-compliant. For example, \*, \*.com, and \*.contoso.com are permitted, but \*contoso.com isn't permitted. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such as o=MySite;p=MyOrg;a=adatum;c=us. For all other values of an address type, you can enter any text for the address space. - AddressSpaceCost: The valid input range for the cost is from 1 through 100. A lower cost indicates a better route. If you omit the address space cost, a cost of 1 is assumed. If you enter a non-SMTP address space that contains the semicolon character (;), you must specify the address space cost. @@ -82,13 +88,12 @@ If you specify the address space type or the address space cost, you must enclos - "SMTP:contoso.com" - contoso.com -You may specify multiple address spaces by separating the address spaces with commas, for example: `contoso.com,fabrikam.com`. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("), for example: `"contoso.com;2","fabrikam.com;3"`. +You might specify multiple address spaces by separating the address spaces with commas, for example: `contoso.com,fabrikam.com`. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("), for example: `"contoso.com;2","fabrikam.com;3"`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -107,7 +115,6 @@ 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 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -125,7 +135,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. When the value of this parameter is $false, the connector can be used by all Mailbox servers in the Exchange organization. When the value of this parameter is $true, the connector can be used only by Mailbox servers in the same Active Directory site. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceTransportServers parameter specifies the names of the Mailbox servers that use this Foreign connector. Having a single Foreign connector homed on multiple servers provides fault tolerance and high availability if one of the Mailbox servers fails. The default value of this parameter is the name of the server on which this Foreign connector is first installed. 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"`. @@ -159,7 +173,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,13 +182,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-GlobalAddressList.md b/exchange/exchange-ps/ExchangePowerShell/New-GlobalAddressList.md similarity index 86% rename from exchange/exchange-ps/exchange/New-GlobalAddressList.md rename to exchange/exchange-ps/ExchangePowerShell/New-GlobalAddressList.md index 990ae4ba24..2bdd854f7b 100644 --- a/exchange/exchange-ps/exchange/New-GlobalAddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-GlobalAddressList.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-globaladdresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-GlobalAddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-globaladdresslist +schema: 2.0.0 +title: New-GlobalAddressList --- # New-GlobalAddressList ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-GlobalAddressList cmdlet to create a global address list (GAL). @@ -69,7 +70,7 @@ The Conditional parameters that are used with the IncludedRecipients parameter a To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPATH filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,13 +91,15 @@ This example creates the GAL named GAL\_AgencyB by using the RecipientFilter par ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a unique name for the global address list. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -123,7 +129,6 @@ You need to use this parameter when you use any Conditional parameters as part o Type: WellKnownRecipientType Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -133,6 +138,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -150,7 +158,6 @@ You can't use this parameter in combination with the IncludedRecipients paramete Type: String Parameter Sets: CustomFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -160,6 +167,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -170,7 +180,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +189,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -190,7 +202,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -200,6 +211,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -210,7 +224,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -220,6 +233,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -230,7 +246,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -240,6 +255,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -250,7 +268,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -260,6 +277,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -270,7 +290,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -280,6 +299,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -290,7 +312,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -300,6 +321,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -310,7 +334,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -320,6 +343,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -330,7 +356,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -340,6 +365,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -350,7 +378,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -360,6 +387,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -370,7 +400,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -380,6 +409,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -390,7 +422,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -400,6 +431,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -410,7 +444,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -420,6 +453,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -430,7 +466,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -440,6 +475,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -450,7 +488,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -460,6 +497,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -470,7 +510,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -480,6 +519,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -490,7 +532,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -500,6 +541,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -510,7 +554,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -520,6 +563,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -529,7 +575,6 @@ 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 Required: False Position: Named @@ -539,6 +584,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -547,7 +595,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -557,6 +604,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -572,7 +622,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -582,13 +631,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-HoldCompliancePolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-HoldCompliancePolicy.md index d216931189..38416ce39a 100644 --- a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HoldCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-holdcompliancepolicy applicable: Security & Compliance -title: New-HoldCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-holdcompliancepolicy +schema: 2.0.0 +title: New-HoldCompliancePolicy --- # New-HoldCompliancePolicy @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the New-HoldCompliancePolicy cmdlet to create new preservation policies in the Microsoft Purview compliance portal. -**Note**: The New-HoldCompliancePolicy cmdlet has been replaced by the New-RetentionCompliancePolicy cmdlet. If you have scripts that use New-HoldCompliancePolicy, update them to use New-RetentionCompliancePolicy. +**Note**: The New-HoldCompliancePolicy cmdlet is replaced by the New-RetentionCompliancePolicy cmdlet. If you have scripts that use New-HoldCompliancePolicy, update them to use New-RetentionCompliancePolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -36,7 +37,7 @@ New-HoldCompliancePolicy [-Name] ``` ## DESCRIPTION -New policies are not valid and will not be applied until a preservation rule is added to the policy. +New policies are not valid and aren't applied until a preservation rule is added to the policy. To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). @@ -47,18 +48,20 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned New-HoldCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" ``` -This example creates a preservation policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint Online site. +This example creates a preservation policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint site. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the preservation policy. 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 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -93,7 +101,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -103,16 +110,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: -- $true: The policy is enabled. This is the default value. +- $true: The policy is enabled. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - A mailbox @@ -142,7 +154,6 @@ If no mailboxes are specified, then no mailboxes are placed on hold. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -160,7 +174,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + The PublicFolderLocation parameter specifies that you want to include all public folders in the preservation policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -186,17 +201,19 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. + +> Applicable: Security & Compliance + +The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. +SharePoint sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -206,13 +223,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/New-HoldComplianceRule.md similarity index 90% rename from exchange/exchange-ps/exchange/New-HoldComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-HoldComplianceRule.md index 9ebebdb7c5..8dab017d8b 100644 --- a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HoldComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-holdcompliancerule applicable: Security & Compliance -title: New-HoldComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-holdcompliancerule +schema: 2.0.0 +title: New-HoldComplianceRule --- # New-HoldComplianceRule @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the New-HoldComplianceRule cmdlet to create new preservation rules in the Microsoft Purview compliance portal. -**Note**: The New-HoldComplianceRule cmdlet has been replaced by the New-RetentionComplianceRule cmdlet. If you have scripts that use New-HoldComplianceRule, update them to use New-RetentionComplianceRule. +**Note**: The New-HoldComplianceRule cmdlet is replaced by the New-RetentionComplianceRule cmdlet. If you have scripts that use New-HoldComplianceRule, update them to use New-RetentionComplianceRule. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -48,18 +49,20 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned New-HoldComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -ContentDateFrom "09/10/14 5:00 PM" -ContentDateTo "09/10/15 5:00 PM" -HoldContent Unlimited ``` -This example creates a new preservation rule named SeptOneYear and adds it to the existing preservation policy named "Internal Company Policy". Content created or updated between the specified dates will be held indefinitely. +This example creates a new preservation rule named SeptOneYear and adds it to the existing preservation policy named "Internal Company Policy". Content created or updated between the specified dates is held indefinitely. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the preservation rule. 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 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the policy to contain the rule. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -110,7 +120,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -ContentDateFrom + +> Applicable: Security & Compliance + 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". @@ -128,7 +140,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -ContentDateTo + +> Applicable: Security & Compliance + 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". @@ -146,7 +160,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -156,6 +169,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -164,7 +180,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the preservation rule is enabled or disabled. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -190,6 +207,9 @@ Accept wildcard characters: False ``` ### -HoldContent + +> Applicable: Security & Compliance + The HoldContent parameter specifies the hold duration for the preservation rule. Valid values are: - An integer: The hold duration in days. @@ -199,7 +219,6 @@ The HoldContent parameter specifies the hold duration for the preservation rule. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -209,19 +228,21 @@ Accept wildcard characters: False ``` ### -HoldDurationDisplayHint + +> Applicable: Security & Compliance + The HoldDurationDisplayHint parameter specifies the units that are used to display the preservation duration in the Microsoft Purview compliance portal. Valid values are: - Days - Months - Years -For example, if this parameter is set to the value Years, and the HoldContent parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. +For example, if this parameter is set to the value Years, and the HoldContent parameter is set to the value 365, the Microsoft Purview compliance portal displays 1 year as the content hold duration. ```yaml Type: HoldDurationHint Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -231,13 +252,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterPolicy.md similarity index 85% rename from exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterPolicy.md index ef6356928d..94dea10d3e 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedcontentfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: New-HostedContentFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-hostedcontentfilterpolicy +schema: 2.0.0 +title: New-HostedContentFilterPolicy --- # New-HostedContentFilterPolicy @@ -83,7 +84,7 @@ New-HostedContentFilterPolicy [-Name] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). For more information about the limits for allowed and blocked senders, see [Exchange Online Protection Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-protection-service-description/exchange-online-protection-limits). @@ -102,6 +103,9 @@ This example creates a spam filter policy named Contoso Executives with the foll ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the spam filter policy. If the value contains spaces, enclose the value in quotation marks ("). Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. @@ -110,7 +114,6 @@ Don't use the following characters in the name value: `\ % & * + / = ? { } | < > Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -AddXHeaderValue + +> Applicable: Exchange Online, Exchange Online Protection + The AddXHeaderValue parameter specifies the X-header name (not value) to add to spam messages when a spam filtering verdict parameter is set to the value AddXHeader. The following spam filtering verdict parameters can use the AddXHeader action: - BulkSpamAction @@ -133,13 +139,12 @@ For example, if you enter the value `X-This-is-my-custom-header`, the X-header t If you enter a value that contains spaces or colons (:), the value is ignored, and the default X-header is added to the message (`X-This-Is-Spam: This message appears to be spam.`). -Note that this setting is independent of the AddXHeader value of the TestModeAction parameter. +This setting is independent of the AddXHeader value of the TestModeAction parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -149,13 +154,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -165,6 +172,9 @@ Accept wildcard characters: False ``` ### -AllowedSenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/create-safe-sender-lists-in-office-365). @@ -177,7 +187,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,6 +196,9 @@ Accept wildcard characters: False ``` ### -AllowedSenders + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/create-safe-sender-lists-in-office-365). @@ -199,7 +211,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -209,6 +220,9 @@ Accept wildcard characters: False ``` ### -BlockedSenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/create-block-sender-lists-in-office-365). @@ -221,7 +235,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -231,6 +244,9 @@ Accept wildcard characters: False ``` ### -BlockedSenders + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/create-block-sender-lists-in-office-365). @@ -243,7 +259,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,6 +268,9 @@ Accept wildcard characters: False ``` ### -BulkQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The BulkQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as bulk email (the BulkSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -269,7 +287,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -279,12 +296,15 @@ Accept wildcard characters: False ``` ### -BulkSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The BulkSpamAction parameter specifies the action to take on messages that are marked as bulk email (also known as gray mail) based on the bulk complaint level (BCL) of the message, and the BCL threshold you configure in the BulkThreshold parameter. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: This is the default value. Deliver the message to the 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). +- MoveToJmf: This value is the default. Deliver the message to the Junk Email folder in the recipient's mailbox. Hybrid environments need mail flow rules in the 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: 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. @@ -293,7 +313,6 @@ The BulkSpamAction parameter specifies the action to take on messages that are m Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -303,7 +322,10 @@ 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. + +> Applicable: Exchange Online, Exchange Online Protection + +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 trigger the action 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/defender-office-365/anti-spam-bulk-complaint-level-bcl-about). @@ -311,7 +333,6 @@ A higher BCL indicates the message is more likely to generate complaints (and is Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -321,6 +342,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -330,7 +354,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -340,13 +363,15 @@ Accept wildcard characters: False ``` ### -DownloadLink -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -356,13 +381,15 @@ Accept wildcard characters: False ``` ### -EnableEndUserSpamNotifications -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -372,16 +399,18 @@ Accept wildcard characters: False ``` ### -EnableLanguageBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The EnableLanguageBlockList parameter enables or disables marking messages that were written in specific languages as spam. Valid values are: - $true: Mark messages hat were written in the languages specified by the LanguageBlockList parameter as spam. -- $false: Don't mark messages as spam solely based on their languages. This is the default value. +- $false: Don't mark messages as spam solely based on their languages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -391,16 +420,18 @@ Accept wildcard characters: False ``` ### -EnableRegionBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The EnableRegionBlockList parameter enables or disables marking messages that are sent from specific countries or regions as spam. Valid values are: - $true: Mark messages from senders in the RegionBlockList parameter as spam. -- $false: Don't mark messages as spam solely based on the source country or region. This is the default value. +- $false: Don't mark messages as spam solely based on the source country or region. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -410,13 +441,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -426,13 +459,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromName -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -442,13 +477,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomSubject -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -458,13 +495,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -474,13 +513,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLanguage -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: EsnLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -490,13 +531,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLimit + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -506,6 +549,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishAction + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. @@ -515,7 +561,6 @@ The HighConfidencePhishAction parameter specifies the action to take on messages Type: PhishFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -525,6 +570,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence phishing (the HighConfidencePhishAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -541,7 +589,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -551,12 +598,15 @@ Accept wildcard characters: False ``` ### -HighConfidenceSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidenceSpamAction parameter specifies the action to take on messages that are marked as high confidence spam (not spam, bulk email, phishing, or high confidence phishing). Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: Deliver the message to the 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). +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. Hybrid environments need mail flow rules in the 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. @@ -564,7 +614,6 @@ The HighConfidenceSpamAction parameter specifies the action to take on messages Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -574,6 +623,9 @@ Accept wildcard characters: False ``` ### -HighConfidenceSpamQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence spam (the HighConfidenceSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -590,7 +642,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -600,17 +651,19 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithBizOrInfoUrls + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Not all messages that match this setting will be marked as spam. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. +- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Not all messages that match this setting are marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -620,17 +673,19 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithImageLinks + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain image links to remote websites are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. Not all messages that match this setting will be marked as spam. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. +- On: The setting is enabled. Messages that contain image links to remote websites are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. Not all messages that match this setting are marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -640,17 +695,19 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithNumericIps + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to IP addresses are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. Note that not all messages which matches the setting will be marked as spam. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. +- On: The setting is enabled. Messages that contain links to IP addresses are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. Not all messages which matches the setting are marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -660,17 +717,19 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithRedirectToOtherPort + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. Note that not all messages which matches the setting will be marked as spam. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. +- On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. Not all messages that match this setting are marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -680,16 +739,18 @@ Accept wildcard characters: False ``` ### -InlineSafetyTipsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The InlineSafetyTipsEnabled parameter specifies whether to enable or disable safety tips that are shown to recipients in messages. Valid values are: -- $true: Safety tips are enabled. This is the default value. +- $true: Safety tips are enabled. This value is the default. - $false: Safety tips are disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -699,9 +760,12 @@ Accept wildcard characters: False ``` ### -IntraOrgFilterState + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- Default: This value is the default. Currently, this value is the same as HighConfidencePhish. - HighConfidencePhish - Phish: Includes phishing and high confidence phishing. - HighConfidenceSpam: Includes high confidence spam, phishing, and high confidence phishing. @@ -712,7 +776,6 @@ The IntraOrgFilterState parameter specifies whether to enable anti-spam filterin Type: IntraOrgFilterState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -722,6 +785,9 @@ Accept wildcard characters: False ``` ### -LanguageBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported uppercase ISO 639-1 two-letter language code: AF, AR, AZ, BE, BG, BN, BR, BS, CA, CS, CY, DA, DE, EL, EN, EO, ES, ET, EU, FA, FI, FO, FR, FY, GA, GL, GU, HA, HE, HI, HR, HU, HY, ID, IS, IT, JA, KA, KK, KL, KN, KO, KU, KY, LA, LB, LT, LV, MI, MK, ML, MN, MR, MS, MT, NB, NL, NN, PA, PL, PS, PT, RM, RO, RU, SE, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TL, TR, UK, UR, UZ, VI, WEN, YI, ZH-CN, ZH-TW, and ZU. @@ -734,7 +800,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -744,17 +809,19 @@ Accept wildcard characters: False ``` ### -MarkAsSpamBulkMail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamBulkMail parameter allows spam filtering to act on bulk email messages. Valid values are: - Off: The message is stamped with the BCL, but no action is taken for a bulk email filtering verdict. In effect, the values of the BulkThreshold and BulkSpamAction parameters are irrelevant. -- On: This is the default value. A BCL that's greater than the BulkThreshold value is converted to an SCL 6 that corresponds to a filtering verdict of spam, and the BulkSpamAction value is taken on the message. +- On: This value is the default. A BCL that's greater than the BulkThreshold value is converted to an SCL 6 that corresponds to a filtering verdict of spam, and the BulkSpamAction value is taken on the message. - Test: This value is available, but isn't used for this parameter. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -764,9 +831,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmbedTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain HTML \ tags are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Embed tag in html` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -774,7 +844,6 @@ The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -784,9 +853,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmptyMessages + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Empty messages are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Empty Message` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -794,7 +866,6 @@ The MarkAsSpamEmptyMessages parameter marks a message as spam when the message c Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -804,9 +875,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFormTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain HTML \ tags are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Form tag in html` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -814,7 +888,6 @@ The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -824,9 +897,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFramesInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML \ or \ tags. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain HTML \ or \ tags are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: IFRAME or FRAME in HTML` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -834,7 +910,6 @@ The MarkAsSpamFramesInHtml parameter marks a message as spam when the message co Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -844,16 +919,18 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFromAddressAuthFail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages where Sender ID filtering encounters a hard fail are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: SPF From Record Fail` is added to the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -863,9 +940,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamJavaScriptInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain JavaScript or VBScript are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Javascript or VBscript tags in HTML` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -873,7 +953,6 @@ The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the messag Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -883,16 +962,18 @@ Accept wildcard characters: False ``` ### -MarkAsSpamNdrBackscatter + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as *backscatter*). Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Backscatter is given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Backscatter NDR` is added to the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -902,9 +983,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamObjectTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain HTML \ tags are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Object tag in html` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -912,7 +996,6 @@ The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the messag Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -922,9 +1005,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSensitiveWordList + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain words from the sensitive word list in the subject or message body are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Sensitive word in subject/body` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -932,7 +1018,6 @@ The MarkAsSpamSensitiveWordList parameter marks a message as spam when the messa Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -942,16 +1027,18 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSpfRecordHardFail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages sent from an IP address that isn't specified in the SPF Sender Policy Framework (SPF) record in DNS are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: SPF Record Fail` is added to the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -961,9 +1048,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamWebBugsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain web bugs are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Web bug` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -971,7 +1061,6 @@ The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message c Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -981,6 +1070,9 @@ Accept wildcard characters: False ``` ### -ModifySubjectValue + +> Applicable: Exchange Online, Exchange Online Protection + The ModifySubjectValue parameter specifies the text to prepend to the existing subject of messages when a spam filtering verdict parameter is set to the value ModifySubject. The following spam filtering verdict parameters can use the ModifySubject action: - BulkSpamAction @@ -994,7 +1086,6 @@ If the value contains spaces, enclose the value in quotation marks ("). Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1004,6 +1095,9 @@ Accept wildcard characters: False ``` ### -PhishQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The PhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as phishing (the PhishSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -1020,7 +1114,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1030,13 +1123,16 @@ Accept wildcard characters: False ``` ### -PhishSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The PhishSpamAction parameter specifies the action to take on messages that are marked as phishing (not high confidence phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - MoveToJmf: Deliver the message to the 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 the quarantine. This value is the default. The quarantined message is available to the intended recipients (as of April, 2020) and admins. - Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as phishing are available to admins and (as of April 2020) the intended recipients. Or, you can use the PhishQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. @@ -1044,7 +1140,6 @@ The PhishSpamAction parameter specifies the action to take on messages that are Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1054,9 +1149,12 @@ Accept wildcard characters: False ``` ### -PhishZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The PhishZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect phishing in already delivered messages in Exchange Online mailboxes. Valid values are: -- $true: ZAP for phishing messages is enabled. This is the default value. The result depends on the spam filtering verdict action for phishing messages: MoveToJmf = Read and unread phishing messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Read and unread phishing messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. +- $true: ZAP for phishing messages is enabled. This value is the default. The result depends on the spam filtering verdict action for phishing messages: MoveToJmf = Read and unread phishing messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Read and unread phishing messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. - $false: ZAP for phishing messages is disabled. You configure ZAP for spam with the SpamZapEnabled parameter. @@ -1065,7 +1163,6 @@ You configure ZAP for spam with the SpamZapEnabled parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1075,6 +1172,9 @@ Accept wildcard characters: False ``` ### -QuarantineRetentionPeriod + +> Applicable: Exchange Online, Exchange Online Protection + The QuarantineRetentionPeriod parameter specifies the number of days that spam messages remain in quarantine when a spam filtering verdict parameter is set to the value Quarantine. All spam filtering verdict parameters can use the Quarantine action: - BulkSpamAction @@ -1091,7 +1191,6 @@ After the time period expires, the message is deleted. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1101,13 +1200,15 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online, Exchange Online Protection + The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1117,6 +1218,9 @@ Accept wildcard characters: False ``` ### -RedirectToRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The RedirectToRecipients parameter specifies the email addresses of replacement recipients when a spam filtering verdict parameter is set to the value Redirect. The following spam filtering verdict parameters can use the Redirect action: - BulkSpamAction @@ -1130,7 +1234,6 @@ You can specify multiple email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1140,6 +1243,9 @@ Accept wildcard characters: False ``` ### -RegionBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The RegionBlockList parameter specifies the source countries or regions that are marked as spam when the EnableRegionBlockList parameter value is $true. A valid value is a supported ISO 3166-1 two-letter country code: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XE, XJ, XS, YE, YT, ZA, ZM, and ZW. @@ -1156,7 +1262,6 @@ To empty the list, use the value $null. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1166,12 +1271,15 @@ Accept wildcard characters: False ``` ### -SpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The SpamAction parameter specifies the action to take on messages that are marked as spam (not high confidence spam, bulk email, phishing, or high confidence phishing). Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete : Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: 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). +- MoveToJmf: This value is the default. Deliver the message to the Junk Email folder in the recipient's mailbox. Hybrid environments need mail flow rules in the 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. @@ -1179,7 +1287,6 @@ The SpamAction parameter specifies the action to take on messages that are marke Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1189,6 +1296,9 @@ Accept wildcard characters: False ``` ### -SpamQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The SpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as spam (the SpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -1205,7 +1315,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1215,9 +1324,12 @@ Accept wildcard characters: False ``` ### -SpamZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SpamZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect spam in already delivered messages in Exchange Online mailboxes. Valid values are: -- $true: ZAP for spam is enabled. This is the default value. The result depends on the spam filtering verdict action for spam messages: MoveToJmf = Unread spam messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Unread spam messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. +- $true: ZAP for spam is enabled. This value is the default. The result depends on the spam filtering verdict action for spam messages: MoveToJmf = Unread spam messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Unread spam messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. - $false: ZAP for spam is disabled. You configure ZAP for phishing messages with the PhishZapEnabled parameter. @@ -1226,7 +1338,6 @@ You configure ZAP for phishing messages with the PhishZapEnabled parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1236,9 +1347,12 @@ Accept wildcard characters: False ``` ### -TestModeAction + +> Applicable: Exchange Online, Exchange Online Protection + The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\* or MarkAsSpam\* ASF parameters are set to the value Test. Valid values are: -- None: This is the default value, and we recommend that you don't change it. +- None: This value is the default, and we recommend that you don't change it. - AddXHeader: The X-header value `X-CustomSpam: This message was filtered by the custom spam filter option` is added to the message. - BccMessage: Redirect the message to the recipients specified by the TestModeBccToRecipients parameter. @@ -1246,7 +1360,6 @@ The TestModeAction parameter specifies the additional action to take on messages Type: SpamFilteringTestModeAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1257,6 +1370,8 @@ Accept wildcard characters: False ### -TestModeBccToRecipients +> Applicable: Exchange Online, Exchange Online Protection + The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. Valid input for this parameter is an email address. Separate multiple email addresses with commas. @@ -1267,7 +1382,6 @@ This parameter is meaningful only when the value of the TestModeAction parameter Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1277,13 +1391,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterRule.md similarity index 89% rename from exchange/exchange-ps/exchange/New-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterRule.md index 427202c583..4560b98a1b 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection -title: New-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-hostedcontentfilterrule +schema: 2.0.0 +title: New-HostedContentFilterRule --- # New-HostedContentFilterRule @@ -40,7 +41,7 @@ New-HostedContentFilterRule [-Name] -HostedContentFilterPolicy [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Use the Microsoft Defender portal to create anti-spam policies](https://learn.microsoft.com/defender-office-365/anti-spam-policies-configure#use-the-microsoft-defender-portal-to-create-anti-spam-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example creates a new spam filter rule named Contoso Recipients with the fo ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. @@ -62,7 +66,6 @@ Don't use the following characters in the name value: `\ % & * + / = ? { } | < > Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -HostedContentFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedContentFilterPolicy parameter specifies the spam filter policy (content filter policy) that's associated with the rule. You can use any value that uniquely identifies the policy. For example: @@ -86,7 +92,6 @@ You can't specify the default spam filter policy, and you can't specify a spam f Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -121,7 +131,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter enables or disables the rule. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,6 +176,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception for the rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -178,7 +194,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -188,6 +203,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception for the rule that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -205,7 +223,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +232,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -229,7 +249,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -239,13 +258,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,6 +276,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition for the rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -270,7 +294,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,6 +303,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -297,7 +323,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,13 +332,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterPolicy.md similarity index 73% rename from exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterPolicy.md index d9cd0ce28f..944b15fa76 100644 --- a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: New-HostedOutboundSpamFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-hostedoutboundspamfilterpolicy +schema: 2.0.0 +title: New-HostedOutboundSpamFilterPolicy --- # New-HostedOutboundSpamFilterPolicy @@ -39,7 +40,7 @@ New-HostedOutboundSpamFilterPolicy [-Name] ## DESCRIPTION New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the HostedOutboundSpamFilterPolicy parameter on the New-HostedOutboundSpamFilterRule or Set-HostedOutboundSpamFilterRule cmdlets to associate the policy with a rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,13 +57,15 @@ This example creates a new outbound spam filter policy named Contoso Executives ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the outbound spam filter policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -72,18 +75,20 @@ Accept wildcard characters: False ``` ### -ActionWhenThresholdReached + +> Applicable: Exchange Online, Exchange Online Protection + The ActionWhenThresholdReach parameter specifies the action to take when any of the limits specified in the policy are reached. Valid values are: - Alert: No action, alert only. - BlockUser: Prevent the user from sending email messages. -- BlockUserForToday: Prevent the user from sending email messages until the following day. This is the default value. +- BlockUserForToday: Prevent the user from sending email messages until the following day. This value is the default. ```yaml Type: OutboundRecipientLimitsExceededAction Parameter Sets: (All) Aliases: Accepted values: Alert, BlockUserForToday, BlockUser -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,20 +116,22 @@ Accept wildcard characters: False ``` ### -AutoForwardingMode + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/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 value is the default. 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 Parameter Sets: (All) Aliases: Accepted values: Automatic, Off, On -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -BccSuspiciousOutboundAdditionalRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The BccSuspiciousOutboundAdditionalRecipients parameter specifies an email address to add to the Bcc field of outgoing spam messages. You can specify multiple email addresses separated by commas. The specified recipients are added to the Bcc field of outgoing spam messages when the value of the BccSuspiciousOutboundMail parameter is $true. @@ -140,7 +152,6 @@ The specified recipients are added to the Bcc field of outgoing spam messages wh Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -150,16 +161,18 @@ Accept wildcard characters: False ``` ### -BccSuspiciousOutboundMail + +> Applicable: Exchange Online, Exchange Online Protection + The BccSuspiciousOutboundMail parameter specifies whether to add recipients to the Bcc field of outgoing spam messages. Valid values are: - $true: The recipients specified by the BccSuspiciousOutboundAdditionalRecipients parameter are added to outgoing spam messages. -- $false: No additional messages are added to outgoing spam messages. This is the default value. +- $false: No additional messages are added to outgoing spam messages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -169,18 +182,20 @@ 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/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). + +> Applicable: Exchange Online, Exchange Online Protection + +**Note**: This setting is 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: - $true: Notify the admins specified by the NotifyOutboundSpamRecipients parameter. -- $false: Don't send notifications. This is the default value. +- $false: Don't send notifications. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -190,7 +205,10 @@ 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/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). + +> Applicable: Exchange Online, Exchange Online Protection + +**Note**: This setting is 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. @@ -200,7 +218,6 @@ The specified recipients receive notifications when the value of the NotifyOutbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,13 +227,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitExternalPerHour + +> Applicable: Exchange Online, Exchange Online Protection + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,13 +245,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitInternalPerHour + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -242,13 +263,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitPerDay + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientLimitInternalPerHour parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -258,13 +281,15 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online, Exchange Online Protection + The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterRule.md similarity index 87% rename from exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterRule.md index 721a9bd38a..423016b19a 100644 --- a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: New-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-hostedoutboundspamfilterrule +schema: 2.0.0 +title: New-HostedOutboundSpamFilterRule --- # New-HostedOutboundSpamFilterRule @@ -37,7 +38,7 @@ New-HostedOutboundSpamFilterRule [-Name] -HostedOutboundSpamFilterPolic ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example creates a new outbound spam filter rule named Contoso Executives th ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the outbound spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). Don't use the following characters: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. @@ -59,7 +63,6 @@ Don't use the following characters: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -HostedOutboundSpamFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedOutboundSpamFilterPolicy parameter specifies the outbound spam filter policy that's associated with the outbound spam filter rule. You can use any value that uniquely identifies the policy. For example: @@ -83,7 +89,6 @@ You can't specify the default outbound spam filter policy, and you can't specify Type: HostedOutboundSpamFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -118,7 +128,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,9 +137,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the rule is enabled. Valid values are: -- $true: The rule is enabled. This is the default value. +- $true: The rule is enabled. This value is the default. - $false: The rule is disabled. In the properties of the rule, the value of this parameter is visible in the State property. @@ -139,7 +151,6 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfFrom parameter specifies an exception that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -164,7 +178,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfFromMemberOf parameter specifies an exception that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: - Name @@ -189,7 +205,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +232,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Online, Exchange Online Protection + The From parameter specifies a condition that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -230,7 +250,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -240,6 +259,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The FromMemberOf parameter specifies a condition that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: - Name @@ -255,7 +277,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -279,7 +303,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -289,13 +312,15 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -305,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/ExchangePowerShell/New-HybridConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/New-HybridConfiguration.md new file mode 100644 index 0000000000..2d22f8387f --- /dev/null +++ b/exchange/exchange-ps/ExchangePowerShell/New-HybridConfiguration.md @@ -0,0 +1,422 @@ +--- +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE +author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-hybridconfiguration +schema: 2.0.0 +title: New-HybridConfiguration +--- + +# New-HybridConfiguration + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the New-HybridConfiguration cmdlet to manually create the HybridConfiguration object and manually set up a hybrid deployment between your on-premises Exchange organization and Exchange Online in Microsoft 365 for enterprises. + +> [!NOTE] +> We strongly recommend that you use the Hybrid Configuration wizard to create the HybridConfiguration object and configure your hybrid deployment with Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-HybridConfiguration + [-ClientAccessServers ] + [-Confirm] + [-DomainController ] + [-Domains ] + [-EdgeTransportServers ] + [-ExternalIPAddresses ] + [-Features ] + [-OnPremisesSmartHost ] + [-ReceivingTransportServers ] + [-SecureMailCertificateThumbprint ] + [-SendingTransportServers ] + [-ServiceInstance ] + [-TlsCertificateName ] + [-TransportServers ] + [-WhatIf] + [] +``` + +## DESCRIPTION +A hybrid deployment offers organizations the ability to extend the feature-rich experience and administrative control they have with their existing on-premises Exchange organization to the cloud. + +The available settings in this cmdlet are configured when the Hybrid Configuration Wizard initially creates the the HybridConfiguration object. + +For more information, see [Exchange Server hybrid deployments](https://learn.microsoft.com/exchange/exchange-hybrid). + +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-HybridConfiguration +``` + +This example creates the hybrid configuration named Hybrid Configuration with the default hybrid configuration settings. + +## PARAMETERS + +### -ClientAccessServers + +> Applicable: Exchange Server 2010 + +This parameter is available only in Exchange Server 2010. + +The ClientAccessServers parameter specifies the Hub Transport servers in Exchange Server 2010 SP2 or later that are configured to support hybrid deployment features. You need to specify at least one Client Access server that's accessible from the internet on TCP ports 80 and 443. The servers are configured to enable the following features: + +- Mailbox Replication Service (MRS) Proxy: Enable the MRS Proxy service configuration. +- Virtual Directories: Host the default web sites for Exchange Web Services (EWS), offline address books, and ActiveSync services. +- Outlook Anywhere: Enabled. + +You can specify multiple servers separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Domains parameter specifies the domain namespaces used in the hybrid deployment. These domains must be configured as accepted domains in either on-premises Exchange or Exchange Online. The domains are used in configuring the organization relationships and Send and Receive connectors used by the hybrid configuration. + +You can specify multiple domains separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -EdgeTransportServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The EdgeTransportServers parameter specifies the Edge Transport servers that are configured to support the hybrid deployment features. The Edge Transport server must be accessible from the internet on port 25. Valid values are: + +- The Edge Transport server FQDN (for example, edge.corp.contoso.com). +- The Edge Transport server host name (for example, EDGE). + +You can specify multiple server separated by commas. + +If you use this parameter, don't use the the ReceivingTransportServers and SendingTransportServers parameters (their values must be blank or $null). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ExternalIPAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ExternalIPAddresses parameter is a legacy parameter that specifies the publicly accessible inbound IP address of Microsoft Exchange Server 2010 Hub Transport servers. + +You should use this parameter to change or clear legacy Exchange 2010 Hub Transport server IP address values only. IPv6 addresses aren't supported. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Features + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Features parameter specifies the features that are enabled for the hybrid configuration. Valid values are: + +- OnlineArchive: Enables the Exchange Online archive for on-premises Exchange and Exchange Online users. +- FreeBusy: Enables calendar free/busy sharing between on-premises Exchange and Exchange Online users. +- MailTips: Enables MailTips between on-premises Exchange and Exchange Online users. +- MessageTracking: Enables message tracking between on-premises Exchange and Exchange Online. +- OWARedirection: Enables automatic Outlook on the web (formerly known as Outlook Web App or OWA) redirection to on-premises Exchange or Exchange Online, depending on where the user mailbox is located. +- SecureMail: Enables secure message transport via Transport Layer Security (TLS) between on-premises Exchange and Exchange Online. +- Centralized: Enables the on-premises Exchange servers to handle all message transport between on-premises Exchange and Exchange Online, including message delivery to the internet for both organizations. If you don't use this value, on-premises Exchange and Exchange Online are each responsible for their own internet message delivery. +- Photos: Enables the sharing of user photo data between the on-premises Exchange and Exchange Online. This feature works in tandem with the PhotosEnabled parameter in the OrganizationRelationship cmdlets in a hybrid deployment. If you use this value, the PhotosEnabled parameter is automatically set to $true. If you don't use this value, the PhotosEnabled parameter is automatically set to $false. + +You can specify multiple values separated by commas. When you use the Hybrid Configuration wizard, all features are enabled by default. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -OnPremisesSmartHost + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The OnPremisesSmartHost parameter specifies the FQDN of the on-premises Exchange Mailbox server used for secure mail transport between on-premises Exchange and Exchange Online. + +```yaml +Type: SmtpDomain +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ReceivingTransportServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ReceivingTransportServers parameter specifies the Mailbox servers defined in the outbound connector configuration in Exchange Online. Valid values are: + +- The Mailbox server FQDN (for example, mbx.corp.contoso.com). +- The Mailbox server host name (for example, MBX). + +You can specify multiple servers specified by commas. + +The specified servers receive secure email messages from Exchange Online to on-premises Exchange in a hybrid deployment. You need to specify at least one publicly accessible Mailbox server to enable secure mail. + +Don't use this parameter with the EdgeTransportServers parameter. The value of this parameter must be blank ($null) when you use the EdgeTransportServers parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -SecureMailCertificateThumbprint + +> Applicable: Exchange Server 2010 + +This parameter is available only in Exchange Server 2010. + +The SecureMailCertificateThumbprint parameter specifies the thumbprint of the X.509 certificate to use as the certificate for hybrid deployment secure message transport. This certificate can't be self-signed, must be obtained from a trusted certification authority (CA), and must be installed on all Hub Transport servers specified in the TransportServers parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -SendingTransportServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The SendingTransportServers parameter specifies the Mailbox servers defined in the inbound connector configuration in Exchange Online. Valid values are: + +- The Mailbox server FQDN (for example, mbx.corp.contoso.com). +- The Mailbox server host name (for example, MBX). + +You can specify multiple servers specified by commas. + +The specified servers send secure email messages from on-premises Exchange to Exchange Online in a hybrid deployment. You need to specify at least one publicly accessible Mailbox server to enable secure mail. + +Don't use this parameter with the EdgeTransportServers parameter. The value of this parameter must be blank ($null) when you use the EdgeTransportServers parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ServiceInstance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is meaningful only in Office 365 operated by 21Vianet in China. + +To manually configure a hybrid deployment with Office 365 operated by 21Vianet in China, set the value of this parameter to 1. Otherwise, the default value is 0. + +All other Microsoft 365 organizations should use the Hybrid Configuration wizard to configure a hybrid deployment. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. Valid syntax for this parameter is `"X.500IssuerX.500Subject"`: + +- `X.500Issuer`: The value in the certificate's Issuer field. +- `X.500Subject`: The value in the certificate's Subject field. + +You can find these values by running the Get-ExchangeCertificate cmdlet. + +Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, use the thumbprint value in the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value `$TLSCertName` for this parameter. + +```yaml +Type: SmtpX509Identifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -TransportServers + +> Applicable: Exchange Server 2010 + +This parameter is available only in Exchange Server 2010. + +The TransportServers parameter specifies the Hub Transport servers in Exchange Server 2010 SP2 or later that are configured to support hybrid deployment features. + +You need to specify at least one Hub Transport server that's accessible from the internet for secure mail between on-premises Exchange and Exchange Online. + +You can specify multiple servers separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/New-InboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-InboundConnector.md similarity index 88% rename from exchange/exchange-ps/exchange/New-InboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-InboundConnector.md index ab3f7a8b2d..8c1f5d800e 100644 --- a/exchange/exchange-ps/exchange/New-InboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-InboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-inboundconnector applicable: Exchange Online, Exchange Online Protection -title: New-InboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-inboundconnector +schema: 2.0.0 +title: New-InboundConnector --- # New-InboundConnector @@ -52,7 +53,7 @@ New-InboundConnector [-Name] -SenderDomains ## DESCRIPTION Inbound connectors accept email messages from remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -76,13 +77,15 @@ This example creates the Inbound connector named Contoso Inbound Secure Connecto ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a descriptive name for the connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -SenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -100,7 +106,6 @@ You can specify multiple domains separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -AssociatedAcceptedDomains + +> Applicable: Exchange Online, Exchange Online Protection + The AssociatedAcceptedDomains parameter restricts the source domains that use the connector to the specified accepted domains. A valid value is an SMTP domain that's configured as an accepted domain in your Microsoft 365 organization. You can specify multiple values separated by commas. @@ -118,7 +126,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -ClientHostNames + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill ClientHostNames Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,20 +153,22 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. Valid values are: -- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This is the default value for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. +- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This value is the default for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. - $false: The connector isn't used for mail flow in hybrid organizations, so any cross-premises headers are removed from messages that flow through the connector. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,6 +196,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -192,7 +208,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -202,9 +217,12 @@ Accept wildcard characters: False ``` ### -ConnectorSource + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorSource parameter specifies how the connector is created. Valid input for this parameter includes the following values: -- Default: The connector is manually created. This is the default value. +- Default: The connector is manually created. This value is the default. - HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. - Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. @@ -214,7 +232,6 @@ We recommended that you don't change this value. Type: TenantConnectorSource Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -224,6 +241,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorType parameter specifies the category for the source domains that the connector accepts messages for. Valid values are: - Partner: External partners or services. @@ -233,7 +253,6 @@ The ConnectorType parameter specifies the category for the source domains that t Type: TenantConnectorType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -EFSkipIPs + +> Applicable: Exchange Online, Exchange Online Protection + the EFSkipIPs parameter specifies the source IP addresses to skip in Enhanced Filtering for Connectors when the EFSkipLastIP parameter value is $false. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -255,7 +277,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,16 +286,18 @@ Accept wildcard characters: False ``` ### -EFSkipLastIP + +> Applicable: Exchange Online, Exchange Online Protection + The EFSkipIPs parameter specifies the behavior of Enhanced Filtering for Connectors. Valid values are: - $true: Only the last message source is skipped. -- $false: Skip the source IP addresses specified by the EFSkipIPs parameter. If no IP addresses are specified, Enhanced Filtering for Connectors is disabled on the connector. This is the default value. +- $false: Skip the source IP addresses specified by the EFSkipIPs parameter. If no IP addresses are specified, Enhanced Filtering for Connectors is disabled on the connector. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -284,13 +307,15 @@ Accept wildcard characters: False ``` ### -EFSkipMailGateway + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,13 +325,15 @@ Accept wildcard characters: False ``` ### -EFTestMode + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -316,6 +343,9 @@ Accept wildcard characters: False ``` ### -EFUsers + +> Applicable: Exchange Online, Exchange Online Protection + The EFUsers parameter specifies the recipients that Enhanced Filtering for Connectors applies to. The default value is blank ($null), which means Enhanced Filtering for Connectors is applied to all recipients. You can specify multiple recipient email addresses separated by commas. @@ -324,7 +354,6 @@ You can specify multiple recipient email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -334,16 +363,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter enables or disables the connector. Valid values are: -- $true: The connector is enabled. This is the default value. +- $true: The connector is enabled. This value is the default. - $false: The connector is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -353,9 +384,12 @@ Accept wildcard characters: False ``` ### -RequireTls + +> Applicable: Exchange Online, Exchange Online Protection + 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 +- $true: Reject messages if they aren't sent over TLS. This value is the default - $false: Allow messages if they aren't sent over TLS. **Note**: This parameter applies only to Partner type connectors. @@ -364,7 +398,6 @@ The RequireTLS parameter specifies whether to require TLS transmission for all m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -374,10 +407,13 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToCertificate + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- $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 value is the default. **Note**: This parameter applies only to Partner type connectors. @@ -385,7 +421,6 @@ The RestrictDomainsToCertificate parameter specifies whether the Subject value o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -395,10 +430,13 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToIPAddresses + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- $false: Don't automatically reject mail from domains that are specified by the SenderDomains parameter based on the source IP address. This value is the default. **Note**: This parameter applies only to Partner type connectors. @@ -406,7 +444,6 @@ The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -416,13 +453,15 @@ Accept wildcard characters: False ``` ### -ScanAndDropRecipients + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -432,6 +471,9 @@ Accept wildcard characters: False ``` ### -SenderIPAddresses + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -447,7 +489,6 @@ IPv6 addresses are not supported. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -457,13 +498,15 @@ Accept wildcard characters: False ``` ### -TlsSenderCertificateName + +> Applicable: Exchange Online, Exchange Online Protection + The TlsSenderCertificateName parameter specifies the TLS certificate that's used when the value of the RequireTls parameter is $true. A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com is not valid). ```yaml Type: TlsCertificate Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -473,10 +516,13 @@ Accept wildcard characters: False ``` ### -TreatMessagesAsInternal + +> Applicable: Exchange Online, Exchange Online Protection + The TreatMessagesAsInternal parameter specifies an alternative method to identify messages sent from an on-premises organization as internal messages. You should only consider using this parameter when your on-premises organization doesn't use Exchange. Valid values are: - $true: Messages are considered internal if the sender's domain matches a domain that's configured in Microsoft 365. This setting allows internal mail flow between Microsoft 365 and on-premises organizations that don't have Exchange Server 2010 or later installed. However, this setting has potential security risks (for example, internal messages bypass antispam filtering), so use caution when configuring this setting. -- $false: Messages aren't considered internal. This is the default value. +- $false: Messages aren't considered internal. This value is the default. In hybrid environments, you don't need to use this parameter, because the Hybrid Configuration wizard automatically configures the required settings on the Inbound connector in Microsoft 365 and the Send connector in the on-premises Exchange organization (the CloudServicesMailEnabled parameter). @@ -489,7 +535,6 @@ In hybrid environments, you don't need to use this parameter, because the Hybrid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -499,6 +544,9 @@ Accept wildcard characters: False ``` ### -TrustedOrganizations + +> Applicable: Exchange Online, Exchange Online Protection + The TrustedOrganizations parameter specifies other Microsoft 365 organizations that are trusted mail sources (for example, after acquisitions and mergers). You can specify multiple Microsoft 365 organizations separated by commas. This parameter works only for mail flow between two Microsoft 365 organizations, so no other parameters are used. @@ -507,7 +555,6 @@ This parameter works only for mail flow between two Microsoft 365 organizations, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -517,13 +564,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/New-InboxRule.md similarity index 81% rename from exchange/exchange-ps/exchange/New-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-InboxRule.md index 3814d8b0da..435d789401 100644 --- a/exchange/exchange-ps/exchange/New-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-InboxRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-inboxrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-InboxRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-inboxrule +schema: 2.0.0 +title: New-InboxRule --- # New-InboxRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-InboxRule cmdlet to create Inbox rules in mailboxes. Inbox rules process messages in the Inbox based on conditions and take actions such as moving a message to a specified folder or deleting a message. @@ -116,13 +117,13 @@ When you create, modify, remove, enable, or disable an Inbox rule in Exchange Po Parameters that are used for conditions also have corresponding exception parameters. When conditions specified in an exception are matched, the rule isn't applied to the message. Exception parameters begin with ExceptIf. For example, the exception parameter for SubjectOrBodyContainsWords is ExceptIfSubjectOrBodyContainsWords. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-InboxRule "CheckActionRequired" -MyNameInToBox $true -FlaggedForAction Any -MarkImportance "High" +New-InboxRule -Mailbox chris@contoso.com -Name "CheckActionRequired" -MyNameInToBox $true -FlaggedForAction Any -MarkImportance "High" ``` This example raises the message importance to High if the mailbox owner is in the To field. In addition, the message is flagged for action. @@ -130,13 +131,15 @@ This example raises the message importance to High if the mailbox owner is in th ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -146,6 +149,9 @@ Accept wildcard characters: False ``` ### -FromMessageId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FromMessageId parameter specifies the message that's used to create the Inbox rule. The rule is based on the properties of the message. You identify the message by its Base64-encoded StoreObjectId property value. For example: - MailboxId\\StoreObjectId @@ -161,7 +167,6 @@ When you use this parameter to create an Inbox rule, the following message prope Type: MailboxStoreObjectIdParameter Parameter Sets: FromMessage Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -171,13 +176,15 @@ Accept wildcard characters: False ``` ### -ValidateOnly -The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. No changes are made when the ValidateOnly switch is used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The ValidateOnly switch specifies whether to evaluate the potential success or failure of the command without making changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: FromMessage Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -187,13 +194,15 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -203,6 +212,9 @@ Accept wildcard characters: False ``` ### -ApplyCategory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApplyCategory parameter specifies an action for the Inbox rule that applies the specified category to messages. A valid value is any text value that you want to define as a category. You can specify multiple categories separated by commas. If the value contains spaces, enclose the value in quotation marks ("). The categories that you specify for this parameter are defined in the mailbox (they aren't shared between mailboxes). @@ -211,7 +223,6 @@ The categories that you specify for this parameter are defined in the mailbox (t Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -221,6 +232,9 @@ Accept wildcard characters: False ``` ### -ApplySystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApplySystemCategory parameter specifies an action for the Inbox rule that applies the specified system category to messages. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -254,7 +268,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -264,6 +277,9 @@ Accept wildcard characters: False ``` ### -BodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -276,7 +292,6 @@ The corresponding exception parameter to this condition is ExceptIfBodyContainsW Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -286,6 +301,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -295,7 +313,6 @@ 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 Required: False Position: Named @@ -305,6 +322,9 @@ Accept wildcard characters: False ``` ### -CopyToFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CopyToFolder parameter specifies an action for the Inbox rule that copies messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -326,7 +346,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -336,6 +355,9 @@ Accept wildcard characters: False ``` ### -DeleteMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeleteMessage parameter specifies an action for the Inbox rule that sends messages to the Deleted Items folder. Valid values are: - $true: Messages that match the conditions of the rule are moved to the Deleted Items folder. @@ -345,7 +367,6 @@ The DeleteMessage parameter specifies an action for the Inbox rule that sends me Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -355,6 +376,9 @@ Accept wildcard characters: False ``` ### -DeleteSystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeleteSystemCategory parameter specifies an action for the Inbox rule that deletes the specified system category from messages. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -388,7 +412,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -398,6 +421,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -406,7 +432,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -416,6 +441,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -428,7 +456,6 @@ The corresponding condition parameter to this exception is BodyContainsWords. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -438,6 +465,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFlaggedForAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfFlaggedForAction parameter specifies an exception for the Inbox rule that looks messages with the specified message flag. Valid values are: - Any @@ -458,7 +488,6 @@ The corresponding condition parameter to this exception is FlaggedForAction. Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -468,6 +497,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: - Name @@ -485,7 +517,6 @@ The corresponding condition parameter to this exception is From. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -495,6 +526,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -507,7 +541,6 @@ The corresponding condition parameter to this exception is FromAddressContainsWo Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -517,6 +550,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasAttachment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfHasAttachment parameter specifies an exception for the Inbox rule that looks for messages with attachments. Valid values are: - $true: The rule action isn't applied to messages that have attachments. @@ -528,7 +564,6 @@ The corresponding condition parameter to this exception is HasAttachment. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -538,6 +573,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfHasClassification parameter specifies an exception for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. The corresponding condition parameter to this exception is HasClassification. @@ -546,7 +584,6 @@ The corresponding condition parameter to this exception is HasClassification. Type: MessageClassificationIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -556,6 +593,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -568,7 +608,6 @@ The corresponding condition parameter to this exception is HeaderContainsWords. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -578,6 +617,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfMessageTypeMatches parameter specifies an exception for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply @@ -598,7 +640,6 @@ The corresponding condition parameter to this exception is MessageTypeMatches. Type: InboxRuleMessageType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -608,6 +649,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfMyNameInCcBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the Cc field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is in the Cc field. @@ -619,7 +663,6 @@ The corresponding condition parameter to this exception is MyNameInCcBox. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -629,6 +672,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfMyNameInToBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the To field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is in the To field. @@ -640,7 +686,6 @@ The corresponding condition parameter to this exception is MyNameInToBox. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -650,6 +695,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInToOrCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfMyNameInToOrCcBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the To or Cc fields Valid values are. - $true: The rule action isn't applied to messages where the mailbox owner is in the To or Cc fields. @@ -661,7 +709,6 @@ The corresponding condition parameter to this exception is MyNameInToOrCcBox. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -671,6 +718,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameNotInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfMyNameNotInToBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner isn't in the To field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner isn't in the To field. @@ -682,7 +732,6 @@ The corresponding condition parameter to this exception is MyNameNotInToBox. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -692,6 +741,9 @@ Accept wildcard characters: False ``` ### -ExceptIfReceivedAfterDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -702,7 +754,6 @@ The corresponding condition parameter to this exception is ReceivedAfterDate. Type: ExDateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -712,6 +763,9 @@ Accept wildcard characters: False ``` ### -ExceptIfReceivedBeforeDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -722,7 +776,6 @@ The corresponding condition parameter to this exception is ReceivedBeforeDate. Type: ExDateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -732,6 +785,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfRecipientAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in recipient email addresses. You can specify multiple values separated by commas. The maximum length of this parameter is 255 characters. @@ -742,7 +798,6 @@ The corresponding condition parameter to this exception is RecipientAddressConta Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -752,6 +807,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentOnlyToMe + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfSentOnlyToMe parameter specifies an exception for the Inbox rule that looks for messages where the only recipient is the mailbox owner. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is the only recipient. @@ -763,7 +821,6 @@ The corresponding condition parameter to this exception is SentOnlyToMe. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -773,6 +830,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -790,7 +850,6 @@ The corresponding condition parameter to this exception is SentTo. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -800,6 +859,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -812,7 +874,6 @@ The corresponding condition parameter to this exception is SubjectContainsWords. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -822,6 +883,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -834,7 +898,6 @@ The corresponding condition parameter to this exception is SubjectOrBodyContains Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -844,6 +907,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfWithImportance parameter specifies an exception for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High @@ -856,7 +922,6 @@ The corresponding condition parameter to this exception is WithImportance. Type: Importance Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -866,6 +931,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithinSizeRangeMaximum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfWithinSizeRangeMaximum parameter specifies part of an exception for the Inbox rule that looks for messages that smaller than specified maximum size. When you enter a value, qualify the value with one of the following units: @@ -876,7 +944,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You need to use this parameter with the ExceptIfWithinSizeRangeMinimum parameter, and the value of this parameter must be greater than the value of ExceptIfWithinSizeRangeMinimum. @@ -886,7 +954,6 @@ The corresponding condition parameter to this exception is WithinSizeRangeMaximu Type: ByteQuantifiedSize Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -896,6 +963,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithinSizeRangeMinimum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfWithinSizeRangeMinimum parameter specifies part of an exception for the Inbox rule that looks for messages that are larger than the specified minimum size. When you enter a value, qualify the value with one of the following units: @@ -906,7 +976,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You need to use this parameter with the ExceptIfWithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of ExceptIfWithinSizeRangeMaximum. @@ -916,7 +986,6 @@ The corresponding condition parameter to this exception is WithinSizeRangeMinimu Type: ByteQuantifiedSize Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -926,6 +995,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithSensitivity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfWithSensitivity parameter specifies an exception for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal @@ -939,7 +1011,6 @@ The corresponding condition parameter to this exception is WithSensitivity. Type: Sensitivity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -949,6 +1020,9 @@ Accept wildcard characters: False ``` ### -FlaggedForAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FlaggedForAction parameter specifies a condition for the Inbox rule that looks for messages with the specified message flag. Valid values are: - Any @@ -967,7 +1041,6 @@ The FlaggedForAction parameter specifies a condition for the Inbox rule that loo Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -977,15 +1050,17 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. +A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules are removed by the actions of this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -995,6 +1070,9 @@ Accept wildcard characters: False ``` ### -ForwardAsAttachmentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForwardAsAttachmentTo parameter specifies an action for the Inbox rule that forwards the message to the specified recipient as an attachment. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1010,7 +1088,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1020,6 +1097,9 @@ Accept wildcard characters: False ``` ### -ForwardTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForwardTo parameter specifies an action for the Inbox rule that forwards the message to the specified recipient. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1035,7 +1115,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1045,6 +1124,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The From parameter specifies a condition for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: - Name @@ -1062,7 +1144,6 @@ The corresponding exception parameter to this condition is ExceptIfFrom. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1072,6 +1153,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1084,7 +1168,6 @@ The corresponding exception parameter to this condition is ExceptIfFromAddressCo Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1094,6 +1177,9 @@ Accept wildcard characters: False ``` ### -HasAttachment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HasAttachment parameter specifies a condition for the Inbox rule that looks for messages with attachments. Valid values are: - $true: The rule action is applied to messages that have attachments. @@ -1105,7 +1191,6 @@ The corresponding exception parameter to this condition is ExceptIfHasAttachment Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1115,6 +1200,9 @@ Accept wildcard characters: False ``` ### -HasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HasClassification parameter specifies a condition for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. The corresponding exception parameter to this condition is ExceptIfHasClassification. @@ -1123,7 +1211,6 @@ The corresponding exception parameter to this condition is ExceptIfHasClassifica Type: MessageClassificationIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1133,6 +1220,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1145,7 +1235,6 @@ The corresponding exception parameter to this condition is ExceptIfHeaderContain Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1155,6 +1244,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -1172,7 +1264,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1182,6 +1273,9 @@ Accept wildcard characters: False ``` ### -MarkAsRead + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MarkAsRead parameter specifies an action for the Inbox rule that marks messages as read. Valid values are: - $true: Messages that match the conditions of the rule are marked as read. @@ -1191,7 +1285,6 @@ The MarkAsRead parameter specifies an action for the Inbox rule that marks messa Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1201,6 +1294,9 @@ Accept wildcard characters: False ``` ### -MarkImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MarkImportance parameter specifies an action for the Inbox rule that marks messages with the specified importance flag. Valid values are: - Low @@ -1211,7 +1307,6 @@ The MarkImportance parameter specifies an action for the Inbox rule that marks m Type: Importance Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1221,6 +1316,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MessageTypeMatches parameter specifies a condition for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply @@ -1241,7 +1339,6 @@ The corresponding exception parameter to this condition is ExceptIfMessageTypeMa Type: InboxRuleMessageType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1251,6 +1348,9 @@ Accept wildcard characters: False ``` ### -MoveToFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MoveToFolder parameter specifies an action for the Inbox rule that moves messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -1272,7 +1372,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1282,6 +1381,9 @@ Accept wildcard characters: False ``` ### -MyNameInCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MyNameInCcBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the Cc field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is in the Cc field. @@ -1293,7 +1395,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInCcBox Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1303,6 +1404,9 @@ Accept wildcard characters: False ``` ### -MyNameInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MyNameInToBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the To field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is in the To field. @@ -1314,7 +1418,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInToBox Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1324,6 +1427,9 @@ Accept wildcard characters: False ``` ### -MyNameInToOrCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MyNameInToOrCcBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the To or Cc fields Valid values are. - $true: The rule action is applied to messages where the mailbox owner is in the To or Cc fields. @@ -1335,7 +1441,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInToOrC Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1345,6 +1450,9 @@ Accept wildcard characters: False ``` ### -MyNameNotInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MyNameNotInToBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner isn't in the To field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner isn't in the To field. @@ -1356,7 +1464,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameNotInTo Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1366,6 +1473,9 @@ Accept wildcard characters: False ``` ### -PinMessage + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PinMessage parameter specifies an action for the Inbox rule that pins messages to the top of the Inbox. Valid values are: - $true: Message that match the conditions of the rule are pinned to the top of the Inbox. @@ -1375,7 +1485,6 @@ The PinMessage parameter specifies an action for the Inbox rule that pins messag Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1385,13 +1494,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Priority parameter specifies a priority for the Inbox rule that determines the order of rule processing. A lower integer value indicates a higher priority, ```yaml Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1401,6 +1512,9 @@ Accept wildcard characters: False ``` ### -ReceivedAfterDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -1411,7 +1525,6 @@ The corresponding exception parameter to this condition is ExceptIfReceivedAfter Type: ExDateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1421,6 +1534,9 @@ Accept wildcard characters: False ``` ### -ReceivedBeforeDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -1431,7 +1547,6 @@ The corresponding exception parameter to this condition is ExceptIfReceivedBefor Type: ExDateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1441,6 +1556,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in recipient email addresses. You can specify multiple values separated by commas. The maximum length of this parameter is 255 characters. @@ -1451,7 +1569,6 @@ The corresponding exception parameter to this condition is ExceptIfRecipientAddr Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1461,6 +1578,9 @@ Accept wildcard characters: False ``` ### -RedirectTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RedirectTo parameter specifies an action for the Inbox rule that redirects the message to the specified recipient. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1476,7 +1596,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1486,6 +1605,9 @@ Accept wildcard characters: False ``` ### -SendTextMessageNotificationTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SendTextMessageNotificationTo parameter specifies an action for the Inbox rule that send a text message notification to the specified telephone number. @@ -1496,7 +1618,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1506,6 +1627,9 @@ Accept wildcard characters: False ``` ### -SentOnlyToMe + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SentOnlyToMe parameter specifies a condition for the Inbox rule that looks for messages where the only recipient is the mailbox owner. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is the only recipient. @@ -1517,7 +1641,6 @@ The corresponding exception parameter to this condition is ExceptIfSentOnlyToMe. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1527,6 +1650,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SentTo parameter specifies a condition for the Inbox rule that looks for messages with the specified recipients. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1544,7 +1670,6 @@ The corresponding exception parameter to this condition is ExceptIfSentTo. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1554,6 +1679,9 @@ Accept wildcard characters: False ``` ### -SoftDeleteMessage + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SoftDeleteMessage Description }} @@ -1562,7 +1690,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1572,6 +1699,9 @@ Accept wildcard characters: False ``` ### -StopProcessingRules + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StopProcessingRules parameter specifies an action for the Inbox rule that stops processing additional rules if the conditions of this Inbox rule are met. Valid values are:If set to $true, the StopProcessingRules parameter instructs Exchange to stop processing additional rules if the conditions of this Inbox rule are met. - $true: Stop processing more rules. @@ -1581,7 +1711,6 @@ The StopProcessingRules parameter specifies an action for the Inbox rule that st Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1591,6 +1720,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1603,7 +1735,6 @@ The corresponding exception parameter to this condition is ExceptIfSubjectContai Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1613,6 +1744,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1625,7 +1759,6 @@ The corresponding exception parameter to this condition is ExceptIfSubjectOrBody Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1635,13 +1768,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1651,6 +1786,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WithImportance parameter specifies a condition for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High @@ -1663,7 +1801,6 @@ The corresponding exception parameter to this condition is ExceptIfWithImportanc Type: Importance Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1673,6 +1810,9 @@ Accept wildcard characters: False ``` ### -WithinSizeRangeMaximum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WithinSizeRangeMaximum parameter specifies part of a condition for the Inbox rule that looks for messages that are smaller than specified maximum size. When you enter a value, qualify the value with one of the following units: @@ -1683,7 +1823,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You need to use this parameter with the WithinSizeRangeMinimum parameter, and the value of this parameter must be greater than the value of WithinSizeRangeMinimum. @@ -1693,7 +1833,6 @@ The corresponding exception parameter to this condition is ExceptIfWithinSizeRan Type: ByteQuantifiedSize Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1703,6 +1842,9 @@ Accept wildcard characters: False ``` ### -WithinSizeRangeMinimum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WithinSizeRangeMinimum parameter specifies part of a condition for the Inbox rule that looks for messages that are larger than the specified minimum size. When you enter a value, qualify the value with one of the following units: @@ -1713,7 +1855,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You need to use this parameter with the WithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of WithinSizeRangeMaximum. @@ -1723,7 +1865,6 @@ The corresponding exception parameter to this condition is ExceptIfWithinSizeRan Type: ByteQuantifiedSize Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1733,6 +1874,9 @@ Accept wildcard characters: False ``` ### -WithSensitivity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WithSensitivity parameter specifies a condition for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal @@ -1746,7 +1890,6 @@ The corresponding exception parameter to this condition is ExceptIfWithSensitivi Type: Sensitivity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-InformationBarrierPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-InformationBarrierPolicy.md index 0e1826be8c..9937381641 100644 --- a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-InformationBarrierPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy applicable: Security & Compliance -title: New-InformationBarrierPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy +schema: 2.0.0 +title: New-InformationBarrierPolicy --- # New-InformationBarrierPolicy @@ -90,13 +91,15 @@ This example creates a policy that allows the *Research* segment to communicate ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the information barrier policy that you want to create. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -AssignedSegment + +> Applicable: Security & Compliance + The AssignedSegment parameter specifies the Name value of segment that you want to include in the information barrier policy. You can find existing segments by running the following command: `Get-OrganizationSegment | Format-List Name,UserGroupFilter`. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -SegmentAllowedFilter + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: OrganizationSegmentAllowedFilter Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -SegmentsAllowed + +> Applicable: Security & Compliance + 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. You identify the segment by its Name value. If the value contains spaces, enclose the value in quotation marks ("). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). @@ -148,7 +158,6 @@ You can't use this parameter with the SegmentsBlocked parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsAllowed Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -SegmentsBlocked + +> Applicable: Security & Compliance + The SegmentsBlocked parameter specifies the segments that aren't allowed to communicate with the segment in this policy (users defined by the AssignedSegment parameter). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). You identify the segment by its Name value. If the value contains spaces, enclose the value in quotation marks ("). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). @@ -168,7 +180,6 @@ You can't use this parameter with the SegmentsAllowed parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsBlocked Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -178,13 +189,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -194,13 +207,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -210,6 +225,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -218,7 +236,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -228,13 +245,15 @@ Accept wildcard characters: False ``` ### -ModerationAllowed + +> Applicable: Security & Compliance + {{ Fill ModerationAllowed Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -244,17 +263,19 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Security & Compliance + The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: - Active -- Inactive (This is the default value.) +- Inactive (This value is the default.) ```yaml Type: EopInformationBarrierPolicyState Parameter Sets: (All) Aliases: Accepted values: Inactive, Active -Applicable: Security & Compliance Required: False Position: Named @@ -264,13 +285,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-IntraOrganizationConnector.md similarity index 79% rename from exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-IntraOrganizationConnector.md index 4e22683783..20404af3e4 100644 --- a/exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-IntraOrganizationConnector.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-intraorganizationconnector -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-IntraOrganizationConnector -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-intraorganizationconnector +schema: 2.0.0 +title: New-IntraOrganizationConnector --- # New-IntraOrganizationConnector ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-IntraOrganizationConnector cmdlet to create an Intra-Organization connector between two on-premises Exchange forests in an organization, between an Exchange on-premises organization and an Exchange Online organization, or between two Exchange Online organizations. This connector enables feature availability and service connectivity across the organizations using a common connector and connection endpoints. @@ -35,7 +36,7 @@ The New-IntraOrganizationConnector cmdlet is used to create a connection for fea For hybrid deployments between on-premises Exchange and Exchange Online organizations, the New-IntraOrganizationConnector cmdlet is used by the Hybrid Configuration wizard. Typically, the Intra-Organization connector is configured when the hybrid deployment is initially created by the wizard. We strongly recommend that you use the Hybrid Configuration wizard to create the Intra-Organization connector when configuring a hybrid deployment with an Exchange Online organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example creates an Intra-Organization connector named "MainCloudConnector" ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a friendly name for the Intra-Organization connector. If the value contains spaces, enclose the value in double quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -DiscoveryEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DiscoveryEndpoint parameter specifies the externally-accessible URL that's used for the Autodiscover service for the domain that's configured in the Intra-Organization connector. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -81,7 +86,10 @@ Accept wildcard characters: False ``` ### -TargetAddressDomains -The TargetAddressDomains parameter specifies the domain namespaces that will be used in the Intra-organization connector. These domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The TargetAddressDomains parameter specifies the domain namespaces to use in the Intra-organization connector. These domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity. You specify multiple domain values separated by commas. @@ -89,7 +97,6 @@ You specify multiple domain values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -108,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -126,7 +138,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +147,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter enables or disabled the Intra-organization connector. The valid values for this parameter are $true or $false. The default value is $true. When you set the value to $false, you completely stop connectivity for the specific connection. @@ -144,7 +158,6 @@ When you set the value to $false, you completely stop connectivity for the speci Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,15 +167,17 @@ Accept wildcard characters: False ``` ### -TargetSharingEpr + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services that will be used in the Intra-Organization connector. +The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services to use in the Intra-Organization connector. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -172,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/New-JournalRule.md similarity index 79% rename from exchange/exchange-ps/exchange/New-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-JournalRule.md index 2812bcf0ef..86bcf47960 100644 --- a/exchange/exchange-ps/exchange/New-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-JournalRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-journalrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-JournalRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-journalrule +schema: 2.0.0 +title: New-JournalRule --- # New-JournalRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-JournalRule cmdlet to create a journal rule in your organization. @@ -34,9 +35,9 @@ New-JournalRule -Name -JournalEmailAddress ## DESCRIPTION The New-JournalRule cmdlet creates a journal rule in your organization. -By default, new journal rules are disabled unless the Enabled parameter is set to $true. For more information about how to enable a new journal rule that was created in a disabled state, see [Enable-JournalRule](https://learn.microsoft.com/powershell/module/exchange/enable-journalrule). +By default, new journal rules are disabled unless the Enabled parameter is set to $true. For more information about how to enable a new journal rule that was created in a disabled state, see [Enable-JournalRule](https://learn.microsoft.com/powershell/module/exchangepowershell/enable-journalrule). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example creates and enables a journal rule. The rule applies to all email m ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters long. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -JournalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The JournalEmailAddress parameter specifies a recipient object to which journal reports are sent. You can use any value that uniquely identifies the recipient. For example: - Name @@ -79,7 +85,6 @@ The JournalEmailAddress parameter specifies a recipient object to which journal Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -98,7 +106,6 @@ 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 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter specifies whether the journal rule is enabled or disabled. If the rule is disabled, it isn't applied to any email messages. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -Recipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or from a recipient are journaled. To journal messages from all recipients, don't use this parameter. @@ -150,7 +164,6 @@ To journal messages from all recipients, don't use this parameter. Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,6 +173,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Scope parameter specifies the scope of email messages to which the journal rule is applied. Valid values for this parameter are as follows: - Global: Global rules process all email messages that pass through a Transport service. This includes email messages that were already processed by the external and internal rules. The default value is Global. @@ -170,7 +186,6 @@ The Scope parameter specifies the scope of email messages to which the journal r Type: JournalRuleScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-Label.md b/exchange/exchange-ps/ExchangePowerShell/New-Label.md similarity index 93% rename from exchange/exchange-ps/exchange/New-Label.md rename to exchange/exchange-ps/ExchangePowerShell/New-Label.md index 19223c0362..a7369fefac 100644 --- a/exchange/exchange-ps/exchange/New-Label.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-Label.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/policy-and-compliance/new-label applicable: Security & Compliance -title: New-Label -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/policy-and-compliance/new-label +schema: 2.0.0 +title: New-Label --- # New-Label @@ -117,13 +118,15 @@ This example create a new label named "New Label" with a display name "My New La ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the sensitivity label. 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 @@ -133,13 +136,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name for the sensitivity label. The display name appears in any client that supports sensitivity labels. This includes Word, Excel, PowerPoint, Outlook, SharePoint, Teams, and Power BI. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -149,13 +154,15 @@ Accept wildcard characters: False ``` ### -Tooltip + +> Applicable: Security & Compliance + The ToolTip parameter specifies the default tooltip and sensitivity label description that's seen by users. It the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -165,6 +172,9 @@ Accept wildcard characters: False ``` ### -AdvancedSettings + +> Applicable: Security & Compliance + The AdvancedSettings parameter enables specific features and capabilities for a sensitivity label. Specify this parameter with the identity (name or GUID) of the sensitivity label, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. @@ -173,7 +183,7 @@ Some of the settings that you configure with this parameter are supported only b 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). +- **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 affects 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). @@ -195,7 +205,6 @@ Supported settings for built-in labeling: Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -205,6 +214,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterAlignment + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterAlignment parameter specifies the footer alignment. Valid values are: - Left @@ -217,7 +229,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -227,6 +238,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterEnabled + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterEnabled parameter enables or disables the Apply Content Marking Footer action for the label. Valid values are: - $true: The Apply Content Marking Footer action is enabled. @@ -236,7 +250,6 @@ The ApplyContentMarkingFooterEnabled parameter enables or disables the Apply Con Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -246,6 +259,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontColor + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontColor parameter specifies the color of the footer text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -254,7 +270,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -264,6 +279,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontName + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontName parameter specifies the font of the footer text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -274,7 +292,6 @@ This parameter is supported only by the Azure Information Protection unified lab Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -284,6 +301,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontSize + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontSize parameter specifies the font size (in points) of the footer text. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -292,7 +312,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -302,6 +321,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterMargin + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterMargin parameter specifies the size (in points) of the footer margin. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -312,7 +334,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -322,6 +343,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterText + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterText parameter specifies the footer text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -330,7 +354,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -340,6 +363,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderAlignment + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderAlignment parameter specifies the header alignment. Valid values are: - Left @@ -352,7 +378,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -362,6 +387,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderEnabled + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderEnabled parameter enables or disables the Apply Content Marking Header action for the label. Valid values are: - $true: The Apply Content Marking Header action is enabled. @@ -371,7 +399,6 @@ The ApplyContentMarkingHeaderEnabled parameter enables or disables the Apply Con Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -381,6 +408,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontColor + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontColor parameter specifies the color of the header text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -389,7 +419,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -399,6 +428,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontName + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontName parameter specifies the font of the header text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -407,7 +439,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -417,6 +448,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontSize + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontSize parameter specifies the font size (in points) of the header text. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -425,7 +459,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -435,6 +468,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderMargin + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderMargin parameter specifies the size (in points) of the header margin. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -445,7 +481,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -455,6 +490,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderText + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderText parameter specifies the header text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -463,7 +501,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -473,7 +510,10 @@ Accept wildcard characters: False ``` ### -ApplyDynamicWatermarkingEnabled -**Note**: This parameter is currently in Public Preview, isn't available in all organizations, and is subject to change. + +> Applicable: Security & Compliance + +**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: @@ -486,7 +526,6 @@ You set the watermark text with the DynamicWatermarkDisplay parameter. For more Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -496,6 +535,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingEnabled + +> Applicable: Security & Compliance + The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarking Header action for the label. Valid values are: - $true: The Apply Watermarking Header action is enabled. @@ -505,7 +547,6 @@ The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarkin Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -515,6 +556,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontColor + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontColor parameter specifies the color of the watermark text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -523,7 +567,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -533,6 +576,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontName + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontName parameter specifies the font of the watermark text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -541,7 +587,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -551,6 +596,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontSize + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontSize parameter specifies the font size (in points) of the watermark text. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -559,7 +607,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -569,6 +616,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingLayout + +> Applicable: Security & Compliance + The ApplyWaterMarkingLayout parameter specifies the watermark alignment. Valid values are: - Horizontal @@ -580,7 +630,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -590,6 +639,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingText + +> Applicable: Security & Compliance + The ApplyWaterMarkingText parameter specifies the watermark text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -598,7 +650,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -608,13 +659,15 @@ Accept wildcard characters: False ``` ### -ColumnAssetCondition + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -624,13 +677,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -640,13 +695,15 @@ Accept wildcard characters: False ``` ### -Conditions + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MulitValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -656,6 +713,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -665,7 +725,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -675,6 +734,9 @@ Accept wildcard characters: False ``` ### -ContentType + +> Applicable: Security & Compliance + The ContentType parameter specifies where the sensitivity label can be applied. Valid values are: - File @@ -691,7 +753,6 @@ Values can be combined, for example: "File, Email, PurviewAssets". Type: MipLabelContentType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -701,13 +762,15 @@ Accept wildcard characters: False ``` ### -DefaultContentLabel + +> Applicable: Security & Compliance + The DefaultContentLabel specifies a label that can be automatically applied to meetings created in a labeled Teams channel. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -717,7 +780,10 @@ Accept wildcard characters: False ``` ### -DynamicWatermarkDisplay -**Note**: This parameter is currently in Public Preview, isn't available in all organizations, and is subject to change. + +> Applicable: Security & Compliance + +**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: @@ -730,7 +796,6 @@ This parameter is meaningful only when the ApplyDynamicWatermarkingEnabled param Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -740,6 +805,9 @@ Accept wildcard characters: False ``` ### -EncryptionAipTemplateScopes + +> Applicable: Security & Compliance + 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']"`. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -748,7 +816,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -758,6 +825,9 @@ Accept wildcard characters: False ``` ### -EncryptionContentExpiredOnDateInDaysOrNever + +> Applicable: Security & Compliance + The EncryptionContentExpiredOnDateInDaysOrNever parameter specifies when the encrypted content expires. Valid values are: - An integer (number of days) @@ -769,7 +839,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -779,6 +848,9 @@ Accept wildcard characters: False ``` ### -EncryptionDoNotForward + +> Applicable: Security & Compliance + The EncryptionDoNotForward parameter specifies whether the Do Not Forward template is applied. Valid values are: - $true: The Do Not Forward template is applied. @@ -790,7 +862,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -800,11 +871,14 @@ Accept wildcard characters: False ``` ### -EncryptionDoubleKeyEncryptionUrl + +> Applicable: Security & Compliance + The feature for this parameter is currently in Public Preview, and is not available to everyone. The EncryptionDoubleKeyEncryptionUrl parameter specifies the Double Key Encryption endpoint URL. -You can't remove the URL after the label has been created; you can only modify it. +You can't remove the URL after the label is created; you can only modify it. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -812,7 +886,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -822,6 +895,9 @@ Accept wildcard characters: False ``` ### -EncryptionEnabled + +> Applicable: Security & Compliance + The EncryptionEnabled parameter specifies whether encryption in enabled. Valid values are: - $true: Encryption is enabled. @@ -831,7 +907,6 @@ The EncryptionEnabled parameter specifies whether encryption in enabled. Valid v Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -841,6 +916,9 @@ Accept wildcard characters: False ``` ### -EncryptionEncryptOnly + +> Applicable: Security & Compliance + The EncryptionEncryptOnly parameter specifies whether the encrypt-only template is applied. Valid values are: - $true: The encrypt-only template is applied. @@ -852,7 +930,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -862,13 +939,15 @@ Accept wildcard characters: False ``` ### -EncryptionLinkedTemplateId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -878,6 +957,9 @@ Accept wildcard characters: False ``` ### -EncryptionOfflineAccessDays + +> Applicable: Security & Compliance + The EncryptionOfflineAccessDays parameter specifies the number of days that offline access is allowed. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -886,7 +968,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -896,6 +977,9 @@ Accept wildcard characters: False ``` ### -EncryptionPromptUser + +> Applicable: Security & Compliance + The EncryptionPromptUser parameter specifies whether to set the label with user defined permission in Word, Excel, and PowerPoint. Valid values are: - $true: The label is set with user defined permissions in Word, Excel and PowerPoint. @@ -907,7 +991,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -917,6 +1000,9 @@ Accept wildcard characters: False ``` ### -EncryptionProtectionType + +> Applicable: Security & Compliance + The EncryptionProtectionType parameter specifies the protection type for encryption. Valid values are: - Template @@ -929,7 +1015,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -939,6 +1024,9 @@ Accept wildcard characters: False ``` ### -EncryptionRightsDefinitions + +> Applicable: Security & Compliance + The EncryptionRightsDefinitions parameter specifies the rights users have when accessing protected. This parameter uses the syntax `Identity1:Rights1,Rights2;Identity2:Rights3,Rights4`. For example, `john@contoso.com:VIEW,EDIT;microsoft.com:VIEW`. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false and the EncryptionProtectionType parameter value is Template. @@ -947,7 +1035,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: EncryptionRightsDefinitionsParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -957,6 +1044,9 @@ Accept wildcard characters: False ``` ### -EncryptionRightsUrl + +> Applicable: Security & Compliance + The EncryptionRightsUrl parameter specifies the URL for hold your own key (HYOK) protection. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -965,7 +1055,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -975,6 +1064,9 @@ Accept wildcard characters: False ``` ### -EncryptionTemplateId + +> Applicable: Security & Compliance + The EncryptionTemplateId parameter lets you convert an existing protection template from Azure Information Protection to a new sensitivity label. Specify the template by its ID that you can identify by running the [Get-AipServiceTemplate](https://learn.microsoft.com/powershell/module/aipservice/get-aipservicetemplate) cmdlet from the [AIPService PowerShell module](https://learn.microsoft.com/powershell/module/aipservice). This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -983,7 +1075,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -993,13 +1084,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Security & Compliance + The Identity parameter is used to migrate an existing Azure Information Protection label by specifying a GUID value. ```yaml Type: MasterIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1009,13 +1102,15 @@ Accept wildcard characters: False ``` ### -LabelActions + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1025,6 +1120,9 @@ Accept wildcard characters: False ``` ### -LocaleSettings + +> Applicable: Security & Compliance + The LocaleSettings parameter specifies one or more localized label names or label Tooltips in different languages. Regions include all region codes supported in Office Client applications. Valid values use the following syntax: - Label display names: `{"localeKey":"DisplayName","Settings":[{"Key":"en-us","Value":"English display name"},{"Key":"de-de","Value":"Deutscher Anzeigename"},{"Key":"es-es","Value":"Nombre para mostrar en español"}]}` @@ -1034,7 +1132,6 @@ The LocaleSettings parameter specifies one or more localized label names or labe Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1044,13 +1141,15 @@ Accept wildcard characters: False ``` ### -MigrationId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1060,6 +1159,9 @@ Accept wildcard characters: False ``` ### -ParentId + +> Applicable: Security & Compliance + The ParentId parameter specifies the parent label that you want this label to be under (a sublabel). You can use any value that uniquely identifies the parent sensitivity label. For example: - Name @@ -1070,7 +1172,6 @@ The ParentId parameter specifies the parent label that you want this label to be Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1080,13 +1181,15 @@ Accept wildcard characters: False ``` ### -SchematizedDataCondition + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1096,13 +1199,15 @@ Accept wildcard characters: False ``` ### -Setting + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1112,13 +1217,15 @@ Accept wildcard characters: False ``` ### -Settings + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1128,6 +1235,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowAccessToGuestUsers + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowAccessToGuestUsers parameter enables or disables access to guest users. Valid values are: - $true: Guest access is enabled. @@ -1139,7 +1249,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1149,6 +1258,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowEmailFromGuestUsers + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowEmailFromGuestUsers parameter enables or disables email from guest users. Valid values are: - $true: Email from guest users is enabled. @@ -1160,7 +1272,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1170,6 +1281,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowFullAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowFullAccess parameter enables or disables full access. Valid values are: - $true: Full access is enabled. @@ -1181,7 +1295,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1191,6 +1304,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowLimitedAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowLimitedAccess parameter enables or disables limited access. Valid values are: - $true: Limited access is enabled. @@ -1202,7 +1318,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1212,6 +1327,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionBlockAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionBlockAccess parameter blocks access. Valid values are: - $true: Access is blocked. @@ -1223,7 +1341,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1233,6 +1350,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionEnabled + +> Applicable: Security & Compliance + The SiteAndGroupProtectionEnabled parameter enables or disables the Site and Group Protection action for the label. Valid values are: - $true: The Site and Group Protection action is enabled. @@ -1242,7 +1362,6 @@ The SiteAndGroupProtectionEnabled parameter enables or disables the Site and Gro Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1252,13 +1371,15 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionLevel + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SiteAndGroupProtectionLevelParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1268,6 +1389,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionPrivacy + +> Applicable: Security & Compliance + The SiteAndGroupProtectionPrivacy parameter specifies the privacy level for the labe. Valid values are: - Public @@ -1279,7 +1403,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+GroupProtectionPrivacy Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1289,6 +1412,9 @@ Accept wildcard characters: False ``` ### -SiteExternalSharingControlType + +> Applicable: Security & Compliance + The SiteExternalSharingControlType parameter specifies the external user sharing setting for the label. Valid values are: - ExternalUserAndGuestSharing @@ -1307,7 +1433,6 @@ These correspond to the following settings through the admin center: Type: Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1317,6 +1442,9 @@ Accept wildcard characters: False ``` ### -TeamsAllowedPresenters + +> Applicable: Security & Compliance + The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Valid values are: - Everyone @@ -1329,7 +1457,6 @@ The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AllowedPresenters Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1339,6 +1466,9 @@ Accept wildcard characters: False ``` ### -TeamsAllowMeetingChat + +> Applicable: Security & Compliance + The TeamsAllowMeetingChat parameter controls whether chat is available in Teams meetings. Valid values are: - Enabled @@ -1350,7 +1480,6 @@ The TeamsAllowMeetingChat parameter controls whether chat is available in Teams Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.MeetingChatMode Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1360,13 +1489,15 @@ Accept wildcard characters: False ``` ### -TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch + +> Applicable: Security & Compliance + {{ Fill TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1376,6 +1507,9 @@ Accept wildcard characters: False ``` ### -TeamsBypassLobbyForDialInUsers + +> Applicable: Security & Compliance + The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for dial-in users who join Teams meetings. Valid values are: - $true: Dial in users bypass the lobby when joining Teams meetings. @@ -1386,7 +1520,6 @@ The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for d Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1396,13 +1529,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelProtectionEnabled + +> Applicable: Security & Compliance + {{ Fill TeamsChannelProtectionEnabled Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1412,13 +1547,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithExternalTenants + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithExternalTenants Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1428,13 +1565,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithPrivateTeamsOnly + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1444,13 +1583,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithSameLabelOnly + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithSameLabelOnly Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1460,6 +1601,9 @@ Accept wildcard characters: False ``` ### -TeamsCopyRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: - $true: Chat messages can be copied to the clipboard. @@ -1471,7 +1615,6 @@ The value $null (blank) allows users to configure this setting in the Teams app. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1481,6 +1624,9 @@ Accept wildcard characters: False ``` ### -TeamsEndToEndEncryptionEnabled + +> Applicable: Security & Compliance + The TeamsEndToEndEncryptionEnabled parameter controls video stream encryption in Teams meetings. Valid values are: - $true: Video stream encryption is enabled. @@ -1493,7 +1639,6 @@ The value $null (blank) allows users to configure this setting in the Teams app. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1503,6 +1648,9 @@ Accept wildcard characters: False ``` ### -TeamsLobbyBypassScope + +> Applicable: Security & Compliance + The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Teams meetings. Valid values are: - Everyone @@ -1517,7 +1665,6 @@ The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.LobbyBypassScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1527,6 +1674,9 @@ Accept wildcard characters: False ``` ### -TeamsLobbyRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass the lobby when joining Teams meetings. Valid values are: - $true: Users bypass the lobby when joining Teams meetings. @@ -1537,7 +1687,6 @@ The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1547,6 +1696,9 @@ Accept wildcard characters: False ``` ### -TeamsPresentersRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsPresentersRestrictionEnforced parameter controls whether presenter restrictions are enabled in Teams meetings. Valid values are: - $true: Presenter restrictions are enabled in Teams meetings. @@ -1557,7 +1709,6 @@ The TeamsPresentersRestrictionEnforced parameter controls whether presenter rest Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1567,6 +1718,9 @@ Accept wildcard characters: False ``` ### -TeamsProtectionEnabled + +> Applicable: Security & Compliance + The TeamsProtectionEnabled parameter controls whether Teams protection is enabled in Teams meetings. Valid values are: - $true: Teams protection is enabled in Teams meetings. @@ -1576,7 +1730,6 @@ The TeamsProtectionEnabled parameter controls whether Teams protection is enable Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1586,6 +1739,9 @@ Accept wildcard characters: False ``` ### -TeamsRecordAutomatically + +> Applicable: Security & Compliance + The TeamsRecordAutomatically parameter controls whether Teams meetings are automatically recorded after they start. Valid values are: - $true: Teams meetings are automatically recorded after they start. @@ -1596,7 +1752,6 @@ The TeamsRecordAutomatically parameter controls whether Teams meetings are autom Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1606,6 +1761,9 @@ Accept wildcard characters: False ``` ### -TeamsVideoWatermark + +> Applicable: Security & Compliance + The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams meetings. Valid values are: - None @@ -1617,7 +1775,6 @@ The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WaterMarkProtectionValues Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1627,6 +1784,9 @@ Accept wildcard characters: False ``` ### -TeamsWhoCanRecord + +> Applicable: Security & Compliance + The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid values are: - Organizer @@ -1638,7 +1798,6 @@ The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid va Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WhoCanRecordOptions Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1648,13 +1807,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-LabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-LabelPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/New-LabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-LabelPolicy.md index ce59ac07c5..c4edd6a938 100644 --- a/exchange/exchange-ps/exchange/New-LabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-LabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-labelpolicy applicable: Security & Compliance -title: New-LabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-labelpolicy +schema: 2.0.0 +title: New-LabelPolicy --- # New-LabelPolicy @@ -60,13 +61,15 @@ This example creates the sensitivity label policy named Research and Development ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + 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 ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Labels + +> Applicable: Security & Compliance + The Labels parameter specifies the sensitivity labels that are associated with the policy. You can use any value that uniquely identifies the label. For example: - Name @@ -88,7 +94,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -AdvancedSettings + +> Applicable: Security & Compliance + The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. Specify this parameter with the identity (name or GUID) of the policy, with key/value pairs in a [hash table](https://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. @@ -122,7 +130,7 @@ Supported settings for built-in labeling: - **teamworkdefaultlabelid**: Outlook and Teams apps that support this setting apply a default label, or no label for meetings. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{teamworkdefaultlabelid="General"}`. For more information about labeling meetings, see [Use sensitivity labels to protect calendar items, Teams meetings, and chat](https://learn.microsoft.com/purview/sensitivity-labels-meetings). -- **HideBarByDefault**: For Office apps that support the sensitivity bar, don't display the sensitivity label name on the window bar title so that there's more space to display long file names. Just the label icon and color (if configured) will be displayed. Users can't revert this setting in the app. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{HideBarByDefault="True"}` +- **HideBarByDefault**: For Office apps that support the sensitivity bar, don't display the sensitivity label name on the window bar title so that there's more space to display long file names. Just the label icon and color (if configured) are displayed. Users can't revert this setting in the app. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{HideBarByDefault="True"}` Additionally, for Power BI: @@ -134,7 +142,6 @@ Additionally, for Power BI: Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -144,13 +151,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -169,7 +181,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -179,6 +190,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include in the policy. A valid value is a mailbox. To specify the mailbox, you can use any value that uniquely identifies it. For example: @@ -194,7 +208,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -204,6 +217,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocationException + +> Applicable: Security & Compliance + The ExchangeLocationException parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter. A valid value is a mailbox. To specify the mailbox, you can use any value that uniquely identifies it. For example: @@ -219,7 +235,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -229,6 +244,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -237,7 +255,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -247,13 +264,15 @@ Accept wildcard characters: False ``` ### -MigrationId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -263,6 +282,9 @@ Accept wildcard characters: False ``` ### -ModernGroupLocation + +> Applicable: Security & Compliance + The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. To identify the Microsoft 365 Group, you must use the primary SMTP address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -271,7 +293,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -281,13 +302,15 @@ Accept wildcard characters: False ``` ### -ModernGroupLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -297,13 +320,15 @@ Accept wildcard characters: False ``` ### -OneDriveLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -313,13 +338,15 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -329,6 +356,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + 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. @@ -337,7 +367,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -347,13 +376,15 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -363,13 +394,15 @@ Accept wildcard characters: False ``` ### -Setting + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -379,13 +412,15 @@ Accept wildcard characters: False ``` ### -Settings + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -395,13 +430,15 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -411,13 +448,15 @@ Accept wildcard characters: False ``` ### -SharePointLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -427,13 +466,15 @@ Accept wildcard characters: False ``` ### -SkypeLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -443,13 +484,15 @@ Accept wildcard characters: False ``` ### -SkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -459,13 +502,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-M365DataAtRestEncryptionPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-M365DataAtRestEncryptionPolicy.md index 1182270b7a..2554ec465a 100644 --- a/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-M365DataAtRestEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-m365dataatrestencryptionpolicy applicable: Exchange Online -title: New-M365DataAtRestEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-m365dataatrestencryptionpolicy +schema: 2.0.0 +title: New-M365DataAtRestEncryptionPolicy --- # New-M365DataAtRestEncryptionPolicy @@ -33,7 +34,7 @@ New-M365DataAtRestEncryptionPolicy [-Name] -AzureKeyIDs Applicable: Exchange Online + The Name parameter specifies a unique name for the Microsoft 365 data-at-rest encryption policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -AzureKeyIDs + +> Applicable: Exchange Online + The AzureKeyIDs parameter specifies the URL of the encryption key in the Azure Key Vault that's used for encryption. For example, `https://contoso.vault.azure.net/keys/key1/`. You can specify multiple values separated by commas using the following syntax: `"AzureKeyID1","AzureKeyID2",..."AzureKeyIDN"`. @@ -71,7 +77,6 @@ You can specify multiple values separated by commas using the following syntax: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -90,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online + The Description parameter specifies an optional description for the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,16 +143,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: -- $true: The policy is enabled. This is the default value. +- $true: The policy is enabled. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -151,13 +164,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/New-MailContact.md similarity index 79% rename from exchange/exchange-ps/exchange/New-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailContact.md index fcccb631e5..e6db45960c 100644 --- a/exchange/exchange-ps/exchange/New-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailContact.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailcontact -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MailContact -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailcontact +schema: 2.0.0 +title: New-MailContact --- # New-MailContact ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MailContact cmdlet to create mail contacts. @@ -44,7 +45,7 @@ New-MailContact -Name -ExternalEmailAddress ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example creates a new mail contact named Chris Ashton. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the mail contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). This value is also used for the DisplayName property if you don't use the DisplayName parameter. @@ -66,7 +70,6 @@ This value is also used for the DisplayName property if you don't use the Displa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. @@ -84,7 +90,6 @@ In on-premises environments, you can use the PrimarySMTPAddress parameter to set Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -118,7 +126,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,6 +135,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -147,7 +157,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -166,7 +178,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the mail contact. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -184,7 +198,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -202,7 +218,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,13 +227,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -228,13 +245,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -244,13 +263,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -260,9 +281,12 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: -- BinHex (This is the default value) +- BinHex (default value) - UuEncode - AppleSingle - AppleDouble @@ -276,7 +300,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -286,11 +309,14 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text - Html -- TextAndHtml (This is the default value) +- TextAndHtml (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -301,7 +327,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -311,11 +336,14 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text - Html -- TextAndHtml (This is the default value) +- TextAndHtml (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -326,7 +354,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -336,6 +363,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this mail contact. A moderator approves messages sent to the mail contact before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -353,7 +383,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -363,10 +392,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -374,7 +406,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -384,6 +415,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter specifies the location in Active Directory where the new contact is created. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -397,7 +431,6 @@ Valid input for this parameter is an organizational unit (OU) or domain that's r Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -407,6 +440,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. @@ -419,7 +455,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -429,9 +464,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -441,7 +479,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -451,16 +488,18 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are: - $true: Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact. -- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This is the default value. +- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -470,13 +509,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailMessage.md b/exchange/exchange-ps/ExchangePowerShell/New-MailMessage.md similarity index 81% rename from exchange/exchange-ps/exchange/New-MailMessage.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailMessage.md index c016c6ef01..c27f6e123b 100644 --- a/exchange/exchange-ps/exchange/New-MailMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailMessage.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailmessage -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailMessage -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailmessage +schema: 2.0.0 +title: New-MailMessage --- # New-MailMessage ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MailMessage cmdlet to create an email message for the specified user mailbox and place the email message in the Drafts folder of the user's mailbox. @@ -34,7 +35,7 @@ New-MailMessage ## DESCRIPTION If the cmdlet is run without specifying the Subject or Body parameters, an empty email message is placed in the user's Drafts folder. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,13 +84,15 @@ This example creates an email message in the Drafts folder with the subject and ## PARAMETERS ### -Body + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Body parameter specifies the content of the body section of the new email message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -BodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BodyFormat parameter specifies the format of the message body. The values can be PlainText, Rtf (Rich Text Format), or Html. By default, if the BodyFormat parameter isn't specified when the Body parameter is used, the message body is rendered in plain text. ```yaml Type: MailBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -124,7 +132,6 @@ 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 Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -142,7 +152,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,13 +161,15 @@ Accept wildcard characters: False ``` ### -Subject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Subject parameter specifies the content of the subject field of the new email message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -168,13 +179,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/New-MailUser.md similarity index 83% rename from exchange/exchange-ps/exchange/New-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailUser.md index 27ea5d62e4..5f25229c09 100644 --- a/exchange/exchange-ps/exchange/New-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailUser.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailuser -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MailUser -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailuser +schema: 2.0.0 +title: New-MailUser --- # New-MailUser ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MailUser cmdlet to create mail users. Mail users (also known as mail-enabled users) have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. Email messages sent to mail users are delivered to the specified external email address. @@ -220,7 +221,7 @@ New-MailUser [-Name] -MicrosoftOnlineServicesID -Passwo ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -234,6 +235,9 @@ This example creates a new mail user for Ed Meadows in the contoso.com cloud-bas ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the mail user. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). This value is also used for the DisplayName property if you don't use the DisplayName parameter. @@ -242,7 +246,6 @@ This value is also used for the DisplayName property if you don't use the Displa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -252,15 +255,17 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. ```yaml Type: ProxyAddress -Parameter Sets: DisabledUser, EnabledUser +Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -269,20 +274,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: ProxyAddress -Parameter Sets: FederatedUser, MicrosoftOnlineServicesID -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +### -FederatedIdentity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online, Exchange Online Protection -### -FederatedIdentity This parameter is available only in the cloud-based service. The FederatedIdentity parameter associates an on-premises Active Directory user with a user in the cloud. @@ -291,7 +286,6 @@ The FederatedIdentity parameter associates an on-premises Active Directory user Type: String Parameter Sets: FederatedUser, MicrosoftOnlineServicesFederatedUser Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -301,13 +295,15 @@ Accept wildcard characters: False ``` ### -MicrosoftOnlineServicesID + +> Applicable: Exchange Online, Exchange Online Protection + The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments. ```yaml Type: WindowsLiveId -Parameter Sets: MicrosoftOnlineServicesID, MicrosoftOnlineServicesFederatedUser +Parameter Sets: MicrosoftOnlineServicesID, MicrosoftOnlineServicesFederatedUser, EnableRoomMailboxAccount Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -316,20 +312,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: WindowsLiveId -Parameter Sets: EnableRoomMailboxAccount -Aliases: -Applicable: Exchange Online, Exchange Online Protection +### -Password -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection -### -Password The Password parameter specifies the password for the user's account. You can use the following methods as a value for this parameter: @@ -342,7 +328,6 @@ You can use the following methods as a value for this parameter: Type: SecureString 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 Required: True Position: Named @@ -352,6 +337,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UserPrincipalName parameter specifies the name of a system user in an email address format (for example, ed@contoso.com). @@ -360,7 +348,6 @@ The UserPrincipalName parameter specifies the name of a system user in an email Type: String Parameter Sets: EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -370,6 +357,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -394,7 +384,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -404,6 +393,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -423,7 +415,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +424,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -442,7 +436,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -452,6 +445,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -460,7 +456,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -470,6 +465,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -478,7 +476,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -488,13 +485,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -504,6 +503,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -512,7 +514,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -522,13 +523,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -538,13 +541,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -554,6 +559,9 @@ Accept wildcard characters: False ``` ### -HVEAccount + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -562,7 +570,6 @@ The HVEAccount switch specifies that this mail user account is specifically used Type: SwitchParameter Parameter Sets: HVEAccount Aliases: -Applicable: Exchange Online, Exchange Online Protection Position: Named Default value: None @@ -572,15 +579,17 @@ Accept wildcard characters: False ``` ### -LOBAppAccount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. -{{ Fill LOBAppAccount Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: LOBAppAccount Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -590,9 +599,12 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: -- BinHex (This is the default value) +- BinHex (default value) - UuEncode - AppleSingle - AppleDouble @@ -606,7 +618,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: DisabledUser, EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -616,6 +627,9 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service This parameter is reserved for internal Microsoft use. @@ -624,7 +638,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -634,11 +647,14 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text - Html -- TextAndHtml (This is the default value) +- TextAndHtml (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -649,7 +665,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: DisabledUser, EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -659,10 +674,13 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are: - Text -- Mime (This is the default value) +- Mime (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -675,7 +693,6 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: DisabledUser, EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -685,6 +702,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -702,7 +722,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -712,10 +731,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -723,7 +745,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -733,6 +754,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter specifies the location in Active Directory where the new mail user is created. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -746,7 +770,6 @@ Valid input for this parameter is an organizational unit (OU) or domain that's r Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -756,6 +779,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. @@ -768,7 +794,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -778,9 +803,12 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. +- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This value is the default. - $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. @@ -791,7 +819,6 @@ A user's experience in any of these management interfaces is still controlled by Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -801,18 +828,20 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ResetPasswordOnNextLogon parameter specifies whether the user must change their password the next time they log on. Valid values are: - $true: The user is required to change their password the next time they log on. -- $false: The user isn't required to change their password the next time they log on. This is the default value. +- $false: The user isn't required to change their password the next time they log on. This value is the default. ```yaml Type: Boolean Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -822,15 +851,17 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -840,9 +871,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -852,7 +886,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -862,16 +895,18 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are: - $true: Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact. -- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This is the default value. +- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This value is the default. ```yaml Type: Boolean Parameter Sets: DisabledUser, EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -881,13 +916,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/New-Mailbox.md similarity index 88% rename from exchange/exchange-ps/exchange/New-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/New-Mailbox.md index 81327a5382..a8af131a6d 100644 --- a/exchange/exchange-ps/exchange/New-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-Mailbox.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-Mailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailbox +schema: 2.0.0 +title: New-Mailbox --- # New-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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-Mailbox cmdlet to create mailboxes and user accounts at the same time. @@ -119,6 +120,7 @@ New-Mailbox [-Name] [-Arbitration] [-Password ] [-UserPri [-MailboxRegion ] [-OrganizationalUnit ] [-PrimarySmtpAddress ] + [-ProxyEmailAddress ] [-RemotePowerShellEnabled ] [-ResetPasswordOnNextLogon ] [-RetentionPolicy ] @@ -762,7 +764,7 @@ New-Mailbox [-Name] [-SupervisoryReviewPolicy] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. @@ -800,13 +802,16 @@ Set-Mailbox -Identity Sales -GrantSendOnBehalfTo MarketingSG Add-MailboxPermission -Identity Sales -User MarketingSG -AccessRights FullAccess -InheritanceType All ``` -This example creates the shared mailbox "Sales Department" and grants Full Access and Send on Behalf permissions for the security group "MarketingSG". Users who are members of the security group will be granted the permissions to the mailbox. +This example creates the shared mailbox "Sales Department" and grants Full Access and Send on Behalf permissions for the security group "MarketingSG". Users who are members of the security group are granted the permissions to the mailbox. This example assumes that you've already created a mail-enabled security group named "MarketingSG" by using the New-DistributionGroup cmdlet. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). In the cloud-based service, many special characters aren't allowed in the Name value (for example, ö, ü, or ä). For more information, see [Error when you try to create a username that contains a special character in Microsoft 365](https://learn.microsoft.com/office/troubleshoot/office-suite-issues/username-contains-special-character). @@ -815,7 +820,6 @@ In the cloud-based service, many special characters aren't allowed in the Name v Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -825,6 +829,9 @@ Accept wildcard characters: False ``` ### -AccountDisabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AccountDisabled switch specifies that the user account associated with the mailbox is disabled. You don't need to specify a value with this switch. @@ -835,7 +842,6 @@ The mailbox is created, and the associated account is created, but the account i Type: SwitchParameter Parameter Sets: DisabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -845,6 +851,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Arbitration switch is required to create arbitration mailboxes. You don't need to specify a value with this switch. @@ -855,9 +864,8 @@ To create arbitration mailboxes that are used to store audit log settings or dat ```yaml Type: SwitchParameter -Parameter Sets: Arbitration +Parameter Sets: Arbitration, Migration Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -866,20 +874,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: Migration -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -ArchiveDomain -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -ArchiveDomain This parameter is available only in on-premises Exchange. The ArchiveDomain parameter specifies the domain in the cloud-based service where the archive that's associated with this mailbox exists. For example, if the SMTP email address of the user is tony@contoso.com, the SMTP domain could be archive.contoso.com. @@ -890,7 +888,6 @@ Only use this parameter if the archive is hosted in the cloud-based service. Type: SmtpDomain Parameter Sets: RemoteArchive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -900,6 +897,9 @@ Accept wildcard characters: False ``` ### -Discovery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Discovery switch is required to create Discovery mailboxes. You don't need to specify a value with this switch. Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be repurposed or converted to another type of mailbox. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). @@ -908,7 +908,6 @@ Discovery mailboxes are created as target mailboxes for Discovery searches. Afte Type: SwitchParameter Parameter Sets: Discovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -918,6 +917,9 @@ Accept wildcard characters: False ``` ### -EnableRoomMailboxAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: @@ -935,7 +937,6 @@ A room mailbox in Exchange Online is created with associated an account that has Type: Boolean Parameter Sets: EnableRoomMailboxAccount Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -945,6 +946,9 @@ Accept wildcard characters: False ``` ### -Equipment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Equipment switch is required to create equipment mailboxes. You don't need to specify a value with this switch. Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers). @@ -953,7 +957,6 @@ Equipment mailboxes are resource mailboxes that aren't associated with a specifi Type: SwitchParameter Parameter Sets: Equipment Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -963,6 +966,9 @@ Accept wildcard characters: False ``` ### -FederatedIdentity + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FederatedIdentity parameter associates an on-premises Active Directory user with a user in the cloud. @@ -971,7 +977,6 @@ The FederatedIdentity parameter associates an on-premises Active Directory user Type: String Parameter Sets: FederatedUser, MicrosoftOnlineServicesFederatedUser Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -981,15 +986,17 @@ Accept wildcard characters: False ``` ### -InactiveMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The InactiveMailbox parameter specifies the inactive mailbox that you want to recover. To find inactive mailboxes, run the command `Get-Mailbox -InactiveMailboxOnly | Format-List Name,PrimarySmtpAddress,DistinguishedName,ExchangeGuid` and then use the DistinguishedName or ExchangeGuid property values to identify the inactive mailbox for this parameter (only those values are guaranteed to be unique for inactive mailboxes). ```yaml Type: MailboxIdParameter -Parameter Sets: InactiveMailbox +Parameter Sets: InactiveMailbox, User Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -998,20 +1005,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: MailboxIdParameter -Parameter Sets: User -Aliases: -Applicable: Exchange Online +### -LinkedDomainController -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -LinkedDomainController This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if the mailbox is a linked mailbox. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter. Use the fully qualified domain name (FQDN) of the domain controller that you want to use as the value for this parameter. @@ -1022,7 +1019,6 @@ This parameter is required only if you're creating a linked mailbox. Type: String Parameter Sets: Linked, LinkedRoomMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1032,6 +1028,9 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: @@ -1045,7 +1044,6 @@ The LinkedMasterAccount parameter specifies the master account in the forest whe Type: UserIdParameter Parameter Sets: Linked, LinkedRoomMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1055,6 +1053,9 @@ Accept wildcard characters: False ``` ### -LinkedRoom + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedRoom switch is required to create linked resource mailboxes. You don't need to specify a value with this switch. @@ -1065,7 +1066,6 @@ A linked resource mailbox is useful in a scenario where you have an account in a Type: SwitchParameter Parameter Sets: LinkedRoomMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1075,15 +1075,17 @@ Accept wildcard characters: False ``` ### -MicrosoftOnlineServicesID + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter applies only to objects in the cloud-based service and is used instead of the UserPrincipalName parameter. The MicrosoftOnlineServicesID parameter isn't available in on-premises deployments. ```yaml Type: WindowsLiveId -Parameter Sets: MicrosoftOnlineServicesFederatedUser, MicrosoftOnlineServicesFederatedUser +Parameter Sets: MicrosoftOnlineServicesFederatedUser, MicrosoftOnlineServicesFederatedUser, EnableRoomMailboxAccount Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -1092,27 +1094,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: WindowsLiveId -Parameter Sets: EnableRoomMailboxAccount -Aliases: -Applicable: Exchange Online +### -Migration -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -Migration The Migration switch is required to create migration mailboxes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Migration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1122,6 +1113,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Password parameter specifies the password for the mailbox (the user account that's associated with the mailbox). This parameter isn't required if you're creating a linked mailbox, resource mailbox, or shared mailbox, because the associated user accounts are disabled for these types of mailboxes. You can use the following methods as a value for this parameter: @@ -1132,9 +1126,8 @@ You can use the following methods as a value for this parameter: ```yaml Type: SecureString -Parameter Sets: User, MicrosoftOnlineServicesID, RemoteArchive +Parameter Sets: User, MicrosoftOnlineServicesID, RemoteArchive, Arbitration, DisabledUser, Discovery, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1143,20 +1136,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecureString -Parameter Sets: Arbitration, DisabledUser, Discovery, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration RemovedMailbox, Room, Shared -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -PublicFolder -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -PublicFolder The PublicFolder switch is required to create public folder mailboxes. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -1167,7 +1150,6 @@ The first public folder mailbox created in your Exchange organization is the pri Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1177,6 +1159,9 @@ Accept wildcard characters: False ``` ### -RemovedMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1185,7 +1170,6 @@ This parameter is reserved for internal Microsoft use. Type: RemovedMailboxIdParameter Parameter Sets: RemovedMailbox Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -1195,6 +1179,9 @@ Accept wildcard characters: False ``` ### -Room + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Room switch is required to create room mailboxes. You don't need to specify a value with this switch. Room mailboxes are resource mailboxes that are associated with a specific location (for example, conference rooms). @@ -1207,7 +1194,6 @@ When you use this switch in Exchange Online, an account with a random, unknown p Type: SwitchParameter Parameter Sets: EnableRoomMailboxAccount, Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1217,6 +1203,9 @@ Accept wildcard characters: False ``` ### -Shared + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Shared switch is required to create shared mailboxes. You don't need to specify a value with this switch. A shared mailbox is a mailbox where multiple users can log on to access the mailbox contents. The mailbox isn't associated with any of the users that can log on. It's associated with a disabled user account. @@ -1225,7 +1214,6 @@ A shared mailbox is a mailbox where multiple users can log on to access the mail Type: SwitchParameter Parameter Sets: Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1235,6 +1223,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. @@ -1243,9 +1234,8 @@ In the cloud-based service, use the MicrosoftOnlineServicesID parameter instead. ```yaml Type: String -Parameter Sets: User, Arbitration, AuditLog, RemoteArchive +Parameter Sets: User, Arbitration, AuditLog, RemoteArchive, AuxAuditLog, DisabledUser,Discovery, EnableRoomMailboxAccount, Equipment, Linked, LinkedRoomMailbox, Migration, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1254,20 +1244,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: AuxAuditLog, DisabledUser,Discovery, EnableRoomMailboxAccount, Equipment, Linked, LinkedRoomMailbox, Migration, Room, Shared, SupervisoryReviewPolicyMailbox -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -ActiveSyncMailboxPolicy -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -ActiveSyncMailboxPolicy The ActiveSyncMailboxPolicy parameter specifies the mobile device mailbox policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example:. - Name @@ -1280,7 +1260,6 @@ If you don't use this parameter, the default mobile device mailbox policy is use Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1290,6 +1269,9 @@ Accept wildcard characters: False ``` ### -AddressBookPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AddressBookPolicy parameter specifies the address book policy that's applied to the mailbox. You can use any value that uniquely identifies the address book policy. For example: @@ -1304,7 +1286,6 @@ For more information about address book policies, see [Address book policies in Type: AddressBookMailboxPolicyIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, MicrosoftOnlineServicesFederatedUser, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1314,6 +1295,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -1338,7 +1322,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1348,6 +1331,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -1367,7 +1353,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, DisabledUser, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1377,13 +1362,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Archive switch specifies that an archive mailbox is created for this mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1393,6 +1380,9 @@ Accept wildcard characters: False ``` ### -ArchiveDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArchiveDatabase parameter specifies the Exchange database that contains the archive that's associated with this mailbox. You can use any value that uniquely identifies the database. For example: @@ -1405,7 +1395,6 @@ The ArchiveDatabase parameter specifies the Exchange database that contains the Type: DatabaseIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1415,6 +1404,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuditLog switch is required to create audit log mailboxes. You don't need to specify a value with this switch. @@ -1427,7 +1419,6 @@ To create other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: AuditLog Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1437,6 +1428,9 @@ Accept wildcard characters: False ``` ### -AuxAuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuxAuditLog switch is required to create auxiliary audit log mailboxes. You don't need to specify a value with this switch. @@ -1449,7 +1443,6 @@ To create other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: AuxAuditLog Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1459,6 +1452,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -1468,7 +1464,6 @@ 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 Required: False Position: Named @@ -1478,6 +1473,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Database parameter specifies the mailbox database that contains the mailbox. You can use any value that uniquely identifies the database. For example: @@ -1492,7 +1490,6 @@ Use the Get-MailboxDatabase cmdlet to see the available mailbox databases. Type: DatabaseIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1502,6 +1499,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -1510,7 +1510,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1520,6 +1519,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -1528,7 +1530,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1538,13 +1539,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1554,6 +1557,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -1562,7 +1568,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1572,17 +1577,19 @@ Accept wildcard characters: False ``` ### -HoldForMigration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HoldForMigration switch specifies whether to prevent any client or user, except the Microsoft Exchange Mailbox Replication service (MRS) process, from logging on to a public folder mailbox. You don't need to specify a value with this switch. You need to use this parameter when you create the first public folder, which is called the hierarchy mailbox, in your organization. -Use this parameter only if you plan to migrate legacy Exchange 2010 public folders to Exchange 2016. If you use this switch but don't have legacy public folders to migrate, you won't be able to create any public folders. +Use this parameter only if you plan to migrate legacy Exchange 2010 public folders to Exchange 2016. If you use this switch but don't have legacy public folders to migrate, you can't create any public folders. ```yaml Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1592,6 +1599,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -1600,7 +1610,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1610,13 +1619,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1626,13 +1637,15 @@ Accept wildcard characters: False ``` ### -IsExcludedFromServingHierarchy -The IsExcludedFromServingHierarchy parameter prevents users from accessing the public folder hierarchy on this public folder mailbox. For load-balancing purposes, users are equally distributed across public folder mailboxes by default. When this parameter is set on a public folder mailbox, that mailbox isn't included in this automatic load-balancing and won't be accessed by users to retrieve the public folder hierarchy. However, if an administrator has set the DefaultPublicFolderMailbox property on a user mailbox to a specific public folder mailbox, the user will still access the specified public folder mailbox even if the IsExcludedFromServingHierarchy parameter is set for that public folder mailbox. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The IsExcludedFromServingHierarchy parameter prevents users from accessing the public folder hierarchy on this public folder mailbox. For load-balancing purposes, users are equally distributed across public folder mailboxes by default. When this parameter is set on a public folder mailbox, that mailbox isn't included in this automatic load-balancing and can't be accessed by users to retrieve the public folder hierarchy. However, if an administrator has set the DefaultPublicFolderMailbox property on a user mailbox to a specific public folder mailbox, the user can still access the specified public folder mailbox, even if the IsExcludedFromServingHierarchy parameter is set for that public folder mailbox. ```yaml Type: Boolean Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1642,13 +1655,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1658,6 +1673,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies credentials to use to access the domain controller specified by the LinkedDomainController parameter. This parameter is optional, even if you're enabling a linked mailbox. @@ -1668,7 +1686,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: Linked, LinkedRoomMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1678,6 +1695,9 @@ Accept wildcard characters: False ``` ### -MailboxPlan + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxPlan parameter specifies the mailbox plan to apply to the mailbox. You can use any value that uniquely identifies the mailbox plan. For example: @@ -1696,7 +1716,6 @@ You can see the available mailbox plans by using the Get-MailboxPlan cmdlet. Type: MailboxPlanIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, DisabledUser, FederatedUser, InactiveMailbox, MicrosoftOnlineServicesFederatedUser, RemoteArchive, RemovedMailbox Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1706,6 +1725,9 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxRegion parameter specifies the geo location for the mailbox in multi-geo environments. @@ -1718,7 +1740,6 @@ To see the list of configured geo locations in Microsoft 365 Multi-Geo, run the Type: String Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, MicrosoftOnlineServicesFederatedUser, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1728,6 +1749,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicy + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox policy to enable for the mailbox that you create. @@ -1736,7 +1760,6 @@ The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox po Type: MailboxPolicyIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1746,6 +1769,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicyAllowed + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ManagedFolderMailboxPolicyAllowed switch specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for clients using versions of Microsoft Outlook earlier than Office Outlook 2007. You don't need to specify a value with this switch. @@ -1758,7 +1784,6 @@ Outlook 2003 Service Pack 3 clients are supported but are provided limited funct Type: SwitchParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1768,6 +1793,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1785,7 +1813,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1795,10 +1822,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -1806,7 +1836,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1816,13 +1845,15 @@ Accept wildcard characters: False ``` ### -Office + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Office parameter specifies the user's physical office name or number. ```yaml Type: String Parameter Sets: LinkedRoomMailbox, Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1832,6 +1863,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OrganizationalUnit parameter specifies the location in Active Directory where the new mailbox is created. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -1845,7 +1879,6 @@ Valid input for this parameter is an organizational unit (OU) or domain that's r Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1855,13 +1888,15 @@ Accept wildcard characters: False ``` ### -Phone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Phone parameter specifies the user's telephone number. ```yaml Type: String Parameter Sets: LinkedRoomMailbox, Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1871,6 +1906,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If you use the PrimarySmtpAddress parameter to specify the primary email address, the command sets the EmailAddressPolicyEnabled property of the mailbox to False, which means the email addresses of the mailbox aren't automatically updated by email address policies. @@ -1879,7 +1917,26 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyEmailAddress + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill ProxyEmailAddress Description }} + +```yaml +Type: Object +Parameter Sets: Arbitration +Aliases: Required: False Position: Named @@ -1889,6 +1946,9 @@ Accept wildcard characters: False ``` ### -RemoteArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoteArchive switch specifies that a remote archive mailbox is created for this mailbox. A remote archive exists in the cloud-based service. You don't need to specify a value with this switch. @@ -1897,7 +1957,6 @@ The RemoteArchive switch specifies that a remote archive mailbox is created for Type: SwitchParameter Parameter Sets: RemoteArchive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1907,9 +1966,12 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. +- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This value is the default. - $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. @@ -1920,7 +1982,6 @@ A user's experience in any of these management interfaces is still controlled by Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1930,16 +1991,18 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResetPasswordOnNextLogon parameter specifies whether the user is required to change their password the next time they log on to their mailbox. Valid values are: - $true: The user is required to change their password the next time they log on to their mailbox. -- $false: The user isn't required to change their password the next time they log on to their mailbox. This is the default value. +- $false: The user isn't required to change their password the next time they log on to their mailbox. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1949,13 +2012,15 @@ Accept wildcard characters: False ``` ### -ResourceCapacity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResourceCapacity parameter specifies the capacity of the resource mailbox. For example, you can use this parameter to identify the number of seats in a conference room (room mailbox) or in a vehicle (equipment mailbox). A valid value is an integer. ```yaml Type: Int32 Parameter Sets: Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1965,6 +2030,9 @@ Accept wildcard characters: False ``` ### -RetentionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RetentionPolicy parameter specifies the retention policy that you want applied to this mailbox. You can use any value that uniquely identifies the policy. For example: @@ -1983,7 +2051,6 @@ If you don't use this parameter, the retention policy named Default MRM Policy i Type: MailboxPolicyIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1993,6 +2060,9 @@ Accept wildcard characters: False ``` ### -RoleAssignmentPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RoleAssignmentPolicy parameter specifies the role assignment policy that's applied to the mailbox. You can use any value that uniquely identifies the role assignment policy. For example: - Name @@ -2007,7 +2077,6 @@ Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment pol Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2017,6 +2086,9 @@ Accept wildcard characters: False ``` ### -RoomMailboxPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. Use the RoomMailboxPassword parameter to configure the password for the account that's associated with the room mailbox when that account is enabled and able to log in (the EnableRoomMailboxAccount parameter is set to the value $true). @@ -2041,7 +2113,6 @@ To configure the password for a room mailbox account in Exchange Online, use [Up Type: SecureString Parameter Sets: EnableRoomMailboxAccount Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2051,15 +2122,17 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2069,9 +2142,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -2081,7 +2157,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2091,6 +2166,9 @@ Accept wildcard characters: False ``` ### -SharingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SharingPolicy parameter specifies the sharing policy that's applied to the mailbox. You can use any value that uniquely identifies the sharing policy. For example: @@ -2107,7 +2185,6 @@ If you don't use this parameter, the sharing policy named Default Sharing Policy Type: SharingPolicyIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2117,6 +2194,9 @@ Accept wildcard characters: False ``` ### -SupervisoryReviewPolicy + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -2125,7 +2205,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -2135,6 +2214,9 @@ Accept wildcard characters: False ``` ### -TargetAllMDBs + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2143,7 +2225,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, MicrosoftOnlineServicesFederatedUser, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2153,6 +2234,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ThrottlingPolicy parameter specifies the throttling policy that's applied to the mailbox. You can use any value that uniquely identifies the throttling policy. For example: @@ -2169,7 +2253,6 @@ By default, no throttling policy is applied to the mailbox. Type: ThrottlingPolicyIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2179,13 +2262,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxAuditLogSearch.md similarity index 82% rename from exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxAuditLogSearch.md index 38f9329045..a23fd4ffa8 100644 --- a/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxAuditLogSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxauditlogsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxAuditLogSearch -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxauditlogsearch +schema: 2.0.0 +title: New-MailboxAuditLogSearch --- # New-MailboxAuditLogSearch @@ -15,7 +16,7 @@ ms.reviewer: > [!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. +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might 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. @@ -44,7 +45,7 @@ The New-MailboxAuditLogSearch cmdlet performs an asynchronous search of mailbox To search mailbox audit logs for a single mailbox and have the results displayed in the Exchange Management Shell window, use the Search-MailboxAuditLog cmdlet instead. To learn more about mailbox audit logging, see [Mailbox audit logging in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mailbox-audit-logging/mailbox-audit-logging). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,6 +66,9 @@ This example returns entries from the mailbox audit logs of all users in organiz ## PARAMETERS ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -73,7 +77,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -91,7 +97,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -StatusMailRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StatusMailRecipients parameter specifies the email address where the search results are sent. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -126,7 +136,6 @@ 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 Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -144,7 +156,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,17 +165,19 @@ Accept wildcard characters: False ``` ### -ExternalAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalAccess parameter specifies whether to return only audit log entries for mailbox access by users that are outside of your organization. In Exchange Online, this parameter returns audit log entries for mailbox access by Microsoft datacenter administrators. Valid values are: $true: Audit log entries for mailbox access by external users or Microsoft datacenter administrators are returned. -$false: Audit log entries for mailbox access by external users or Microsoft datacenter administrators are ignored. This is the default value. +$false: Audit log entries for mailbox access by external users or Microsoft datacenter administrators are ignored. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to include Microsoft 365 Groups in the search. You don't need to specify a value with this switch. @@ -182,7 +198,6 @@ The GroupMailbox switch is required to include Microsoft 365 Groups in the searc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -192,6 +207,9 @@ Accept wildcard characters: False ``` ### -HasAttachments + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HasAttachments parameter filters the search by messages that have attachments. Valid values are: - $true: Only messages with attachments are included in the search. @@ -201,7 +219,6 @@ The HasAttachments parameter filters the search by messages that have attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -211,6 +228,9 @@ Accept wildcard characters: False ``` ### -LogonTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LogonTypes parameter specifies the type of logons. Valid values are: - Admin: Audit log entries for mailbox access by administrator logons are returned. @@ -224,7 +244,6 @@ You can enter multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -234,6 +253,9 @@ Accept wildcard characters: False ``` ### -Mailboxes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailboxes parameter specifies the mailbox to retrieve mailbox audit log entries from. 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"`. @@ -244,7 +266,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -254,13 +275,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a name for the search. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -270,6 +293,9 @@ Accept wildcard characters: False ``` ### -Operations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Operations parameter filters the search results by the operations that are logged by mailbox audit logging. Valid values are: - Copy @@ -291,7 +317,6 @@ You can enter multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -301,13 +326,15 @@ Accept wildcard characters: False ``` ### -ShowDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowDetails switch specifies that details of each log entry are retrieved. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -317,13 +344,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxDatabase.md similarity index 79% rename from exchange/exchange-ps/exchange/New-MailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxDatabase.md index a16092d137..53a44cc183 100644 --- a/exchange/exchange-ps/exchange/New-MailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxdatabase -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MailboxDatabase -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxdatabase +schema: 2.0.0 +title: New-MailboxDatabase --- # New-MailboxDatabase @@ -52,7 +53,7 @@ New-MailboxDatabase [[-Name] ] -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,13 +67,15 @@ This example creates the mailbox database DB1 on the Mailbox server named Server ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of the new mailbox database. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String -Parameter Sets: NonRecovery +Parameter Sets: NonRecovery, Recovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,27 +84,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Recovery -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Recovery -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Recovery The Recovery switch specifies that the new database is designated as a recovery database. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Recovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -111,6 +103,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -122,7 +117,6 @@ The Server parameter specifies the Exchange server where you want to run this co Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -132,13 +126,15 @@ Accept wildcard characters: False ``` ### -AutoDagExcludeFromMonitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDagExcludeFromMonitoring parameter specifies that the database being created should not be monitored by managed availability. ```yaml Type: Boolean Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +144,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -157,7 +156,6 @@ 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 Required: False Position: Named @@ -167,13 +165,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,13 +183,15 @@ Accept wildcard characters: False ``` ### -EdbFilePath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EdbFilePath parameter specifies the path to the database files. The default location is `%ExchangeInstallPath%Mailbox\\.edb`. ```yaml Type: EdbFilePath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,6 +201,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromInitialProvisioning + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsExcludedFromInitialProvisioning switch specifies that this database is temporarily not considered by the mailbox provisioning load balancer. You don't need to specify a value with this switch. If you use this switch, new mailboxes aren't added automatically to this database. @@ -207,7 +212,6 @@ If you use this switch, new mailboxes aren't added automatically to this databas Type: SwitchParameter Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,13 +221,15 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsExcludedFromProvisioning parameter specifies whether this database is considered by the mailbox provisioning load balancer. If the IsExcludedFromProvisioning parameter is set to $true, no new mailboxes are automatically added to this database. ```yaml Type: Boolean Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,13 +239,15 @@ Accept wildcard characters: False ``` ### -IsSuspendedFromProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsSuspendedFromProvisioning parameter specifies whether this database is temporarily considered by the mailbox provisioning load balancer. ```yaml Type: Boolean Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -249,13 +257,15 @@ Accept wildcard characters: False ``` ### -LogFolderPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogFolderPath parameter specifies the folder location for log files.The default location is `%ExchangeInstallPath%Mailbox\` ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -265,13 +275,15 @@ Accept wildcard characters: False ``` ### -OfflineAddressBook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OfflineAddressBook parameter specifies the associated offline address book (OAB) for the new mailbox database. ```yaml Type: OfflineAddressBookIdParameter Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,6 +293,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PublicFolderDatabase parameter specifies the associated public folder database for the new mailbox database. You can use any value that uniquely identifies the public folder database. For example: - Name @@ -291,7 +306,6 @@ The PublicFolderDatabase parameter specifies the associated public folder databa Type: DatabaseIdParameter Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -301,13 +315,15 @@ Accept wildcard characters: False ``` ### -SkipDatabaseLogFolderCreation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxExportRequest.md similarity index 84% rename from exchange/exchange-ps/exchange/New-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxExportRequest.md index 56a97e1c20..2341ba1ddd 100644 --- a/exchange/exchange-ps/exchange/New-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxexportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MailboxExportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxexportrequest +schema: 2.0.0 +title: New-MailboxExportRequest --- # New-MailboxExportRequest @@ -119,14 +120,14 @@ New-MailboxExportRequest [-Mailbox] -ComplianceStor ## DESCRIPTION You can create more than one mailbox export request per mailbox, and each mailbox export request must have a unique name. Microsoft Exchange automatically generates up to 10 unique names for a mailbox export request. However, to create more than 10 export requests for a mailbox, you need to specify a unique name when creating the export request. You can remove existing export requests with the Remove-MailboxExportRequest cmdlet before starting a new request with the default request name `\MailboxExportX` (where X = 0-9). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). You need to grant the following permission to the group Exchange Trusted Subsystem to the network share where you want to export or import PST files: - To import PST files from the share: Read permission - To save exported PST files to the share: Read/Write permission. -If you don't grant this permission, you will receive an error message stating that Exchange is unable to establish a connection to the PST file on the network share. +If you don't grant this permission, you get an error message stating that Exchange is unable to establish a connection to the PST file on the network share. ## EXAMPLES @@ -161,6 +162,9 @@ This example exports all messages from Kweku's Inbox to the .pst file InPlaceHol ## PARAMETERS ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013 + The Mailbox parameter specifies the source mailbox where the contents are being exported from. In Exchange 2016 CU7 or later, this parameter is the type MailboxLocationIdParameter, so the easiest value that you can use to identify the mailbox is the Alias value. @@ -180,9 +184,8 @@ In Exchange 2016 CU6 or earlier, this parameter is the type MailboxOrMailUserIdP ```yaml Type: MailboxOrMailUserIdParameter -Parameter Sets: Mailbox +Parameter Sets: Mailbox, MailboxExportRequest, MailboxComplianceExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: True Position: 1 @@ -191,27 +194,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: MailboxExportRequest, MailboxComplianceExportRequest -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -ComplianceStorePath -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -ComplianceStorePath This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: MailboxComplianceExportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -221,6 +213,9 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FilePath parameter specifies the network share path of the .pst file to which data is exported, for example, \\\\SERVER01\\PST Files\\exported.pst. You need to grant the following permission to the group Exchange Trusted Subsystem to the network share where you want to export or import PST files: @@ -228,13 +223,12 @@ You need to grant the following permission to the group Exchange Trusted Subsyst - To import PST files from the share: Read permission - To save exported PST files to the share: Read/Write permission. -If you don't grant this permission, you will receive an error message stating that Exchange is unable to establish a connection to the PST file on the network share. +If you don't grant this permission, you get an error message stating that Exchange is unable to establish a connection to the PST file on the network share. ```yaml Type: LongPath Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -244,13 +238,15 @@ Accept wildcard characters: False ``` ### -RemoteCredential + +> Applicable: Exchange Server 2013, Exchange Server 2016 + This parameter is reserved for internal Microsoft use. ```yaml Type: PSCredential -Parameter Sets: Mailbox, MailboxExportRequest +Parameter Sets: Mailbox, MailboxExportRequest, MailboxComplianceExportRequest Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -259,20 +255,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: PSCredential -Parameter Sets: MailboxComplianceExportRequest -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -AcceptLargeDataLoss -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -AcceptLargeDataLoss The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -283,7 +269,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +278,9 @@ Accept wildcard characters: False ``` ### -AssociatedMessagesCopyOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AssociatedMessagesCopyOption parameter specifies whether associated messages are copied when the request is processed. Associated messages are special messages that contain hidden data with information about rules, views, and forms. By default, associated messages are copied. This parameter accepts the following values: - DoNotCopy: The associated messages aren't copied. @@ -305,7 +293,6 @@ Content filtering doesn't apply to associated messages. Type: FAICopyOption Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -315,6 +302,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -325,7 +315,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -335,13 +324,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BatchName parameter specifies a descriptive name for exporting a batch of mailboxes. You can use the name in the BatchName parameter as a string search when you use the Get-MailboxExportRequest cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -351,13 +342,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit -The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit is 30 days. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The CompletedRequestAgeLimit parameter specifies how long the request is kept after completion before it's automatically removed. The default value is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -367,6 +360,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -376,7 +372,6 @@ 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 Required: False Position: Named @@ -386,12 +381,15 @@ Accept wildcard characters: False ``` ### -ConflictResolutionOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConflictResolutionOption parameter specifies what to do if there are multiple matching messages in the target. Valid values are: - ForceCopy - KeepAll - KeepLatestItem -- KeepSourceItem (This is the default value.) +- KeepSourceItem (This value is the default.) - KeepTargetItem - UpdateFromSource @@ -399,7 +397,6 @@ The ConflictResolutionOption parameter specifies what to do if there are multipl Type: ConflictResolutionOption Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -409,9 +406,12 @@ 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'"`. +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +**Important**: You can't use this parameter to export between two dates. 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 are exported into the .pst file. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. For filterable properties, see [Filterable properties for the ContentFilter parameter](https://learn.microsoft.com/exchange/filterable-properties-for-the-contentfilter-parameter). @@ -426,7 +426,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -436,6 +435,9 @@ Accept wildcard characters: False ``` ### -ContentFilterLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -444,7 +446,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -454,13 +455,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -470,6 +473,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpster + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: @@ -482,7 +488,6 @@ If you don't use this switch, the Recoverable Items folder is copied with the fo Type: SwitchParameter Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -492,6 +497,9 @@ Accept wildcard characters: False ``` ### -ExcludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExcludeFolders parameter specifies the list of folders to exclude during the export. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -528,7 +536,6 @@ To exclude the Recoverable Items folder, you must use the ExcludeDumpster parame Type: String[] Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -538,6 +545,9 @@ Accept wildcard characters: False ``` ### -IncludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeFolders parameter specifies the list of folders to include during the export. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -574,7 +584,6 @@ The Recoverable Items folder is always included if you don't use the ExcludeDump Type: String[] Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -584,13 +593,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -600,13 +611,15 @@ Accept wildcard characters: False ``` ### -IsArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsArchive switch specifies that you're exporting from the user's archive. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -616,6 +629,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -631,7 +647,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -641,6 +656,9 @@ Accept wildcard characters: False ``` ### -MRSServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSServer parameter specifies the FQDN of the Client Access server on which the instance of the Microsoft Exchange Mailbox Replication service (MRS) is running. This parameter is used for debugging purposes only. Use this parameter only if directed by support personnel. @@ -649,7 +667,6 @@ The MRSServer parameter specifies the FQDN of the Client Access server on which Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -659,6 +676,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of the specific request for tracking and display purposes. Because you can have multiple export requests per mailbox, Exchange precedes the name with the mailbox's alias. For example, if you create an export request for a user's mailbox that has the alias Kweku and specify the value of this parameter as PC1toArchive, the identity of this export request is Kweku\\PC1toArchive. If you don't specify a name using this parameter, Exchange generates up to 10 request names per mailbox, which is MailboxExportX (where X = 0-9). The identity of the request is displayed and searchable as `\MailboxExportX`. @@ -667,7 +687,6 @@ If you don't specify a name using this parameter, Exchange generates up to 10 re Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -677,13 +696,15 @@ Accept wildcard characters: False ``` ### -PreferredMessageFormat + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: MessageCopyFormat Parameter Sets: MailboxComplianceExportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -693,11 +714,14 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: - Lower - Low -- Normal (This is the default value.) +- Normal (This value is the default.) - High - Higher - Highest @@ -707,7 +731,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -717,13 +740,15 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -733,6 +758,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -746,7 +774,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: MailboxComplianceExportRequest, MailboxExportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -756,13 +783,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipMerging parameter specifies steps in the export that should be skipped. This parameter is used primarily for debugging purposes. ```yaml Type: SkippableMergeComponent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -772,13 +801,15 @@ Accept wildcard characters: False ``` ### -SourceRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceRootFolder parameter specifies the root folder of the mailbox from which data is exported. If this parameter isn't specified, the command exports all folders. ```yaml Type: String Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -788,15 +819,17 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. -If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. +If you use this switch, the request is queued, but the request doesn't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -806,13 +839,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -822,13 +857,15 @@ Accept wildcard characters: False ``` ### -TargetRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetRootFolder parameter specifies the top-level folder in which to export data. If you don't specify this parameter, the command exports folders to the top of the folder structure in the target .pst file. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. ```yaml Type: String Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -838,13 +875,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -854,13 +893,15 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: RequestWorkloadType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxFolder.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxFolder.md similarity index 80% rename from exchange/exchange-ps/exchange/New-MailboxFolder.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxFolder.md index 8edb27513b..234aa513a8 100644 --- a/exchange/exchange-ps/exchange/New-MailboxFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxfolder +schema: 2.0.0 +title: New-MailboxFolder --- # New-MailboxFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MailboxFolder cmdlet to create folders in your own mailbox. Administrators can't use this cmdlet to create folders in other mailboxes (the cmdlet is available only from the MyBaseOptions user role). @@ -31,7 +32,7 @@ New-MailboxFolder [-Name] -Parent ## DESCRIPTION If no parent folder is specified, the cmdlet creates a mail folder in the root folder hierarchy of the mailbox. If the mailbox isn't specified, the cmdlet creates the folder in the mailbox of the user currently running the task. When run, the cmdlet returns the new folder name and the folder path as the output. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). . +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). . ## EXAMPLES @@ -52,13 +53,15 @@ This example creates the folder named Personal in the root folder hierarchy of y ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the new folder. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Parent parameter specifies where to create the new mailbox folder. The syntax is `[MailboxID]:\[ParentFolder][\SubFolder]`. You can only run this cmdlet on your own mailbox, so you don't need to (or can't) specify a `MailboxID` value. @@ -95,7 +101,6 @@ Example values for this parameter are `john@contoso.com:`, `John:\Inbox` Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -114,7 +122,6 @@ 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 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -132,7 +142,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxImportRequest.md similarity index 86% rename from exchange/exchange-ps/exchange/New-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxImportRequest.md index f037f6aba2..a97de519b4 100644 --- a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxImportRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboximportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxImportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboximportrequest +schema: 2.0.0 +title: New-MailboxImportRequest --- # New-MailboxImportRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MailboxImportRequest cmdlet to begin the process of importing a .pst file to a mailbox or archive. @@ -132,7 +133,7 @@ In on-premises Exchange, you need to grant the following permission to the group - To import PST files from the share: Read permission - To save exported PST files to the share: Read/Write permission. -If you don't grant this permission, you will receive an error message stating that Exchange is unable to establish a connection to the PST file on the network share. +If you don't grant this permission, you get an error message stating that Exchange is unable to establish a connection to the PST file on the network share. ## EXAMPLES @@ -160,6 +161,9 @@ This example imports all of the .pst files on a shared folder. Each .pst file na ## PARAMETERS ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013 + The Mailbox parameter specifies the destination mailbox where the content is being imported to. In Exchange 2016 CU7 or later, this parameter is the type MailboxLocationIdParameter, so the easiest value that you can use to identify the mailbox is the Alias value. @@ -179,9 +183,8 @@ In Exchange 2016 CU6 or earlier, this parameter is the type MailboxOrMailUserIdP ```yaml Type: MailboxOrMailUserIdParameter -Parameter Sets: Mailbox +Parameter Sets: Mailbox, MailboxLocationId Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: True Position: 1 @@ -190,20 +193,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: MailboxLocationId -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +### -AzureBlobStorageAccountUri -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -AzureBlobStorageAccountUri This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -212,7 +205,6 @@ This parameter is reserved for internal Microsoft use. Type: Uri Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -222,6 +214,9 @@ Accept wildcard characters: False ``` ### -AzureSharedAccessSignatureToken + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -230,7 +225,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -240,6 +234,9 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The FilePath parameter specifies the network share path of the .pst file from which data is imported, for example, \\\\SERVER01\\PST Files\\ToImport.pst. @@ -249,13 +246,12 @@ You need to grant the following permission to the group Exchange Trusted Subsyst - To import PST files from the share: Read permission - To save exported PST files to the share: Read/Write permission. -If you don't grant this permission, you will receive an error message stating that Exchange is unable to establish a connection to the PST file on the network share. +If you don't grant this permission, you get an error message stating that Exchange is unable to establish a connection to the PST file on the network share. ```yaml Type: LongPath Parameter Sets: Mailbox, MailboxLocationId Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -265,6 +261,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -275,7 +274,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -285,6 +283,9 @@ Accept wildcard characters: False ``` ### -AssociatedMessagesCopyOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AssociatedMessagesCopyOption parameter specifies whether associated messages are copied when the request is processed. Associated messages are special messages that contain hidden data with information about rules, views, and forms. By default, associated messages are copied. This parameter accepts the following values: - DoNotCopy: The associated messages aren't copied. @@ -297,7 +298,6 @@ Content filtering doesn't apply to associated messages. Type: FAICopyOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -307,6 +307,9 @@ Accept wildcard characters: False ``` ### -AzureStatusPublishEndpointInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -315,7 +318,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -325,6 +327,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -335,7 +340,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -345,13 +349,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter specifies a descriptive name for importing a batch of mailboxes. You can use the name in the BatchName parameter as a string search when you use the Get-MailboxImportRequest cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -361,13 +367,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit -The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default value of the CompletedRequestAgeLimit parameter is 30 days. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The CompletedRequestAgeLimit parameter specifies how long the request is kept after completion before being automatically removed. The default value is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -377,6 +385,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -386,7 +397,6 @@ 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 Required: False Position: Named @@ -396,12 +406,15 @@ Accept wildcard characters: False ``` ### -ConflictResolutionOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConflictResolutionOption parameter specifies what to do if there are multiple matching messages in the target. Valid values are: - ForceCopy (Exchange 2016 or later) - KeepAll - KeepLatestItem -- KeepSourceItem (This is the default value) +- KeepSourceItem (default value) - KeepTargetItem (Exchange 2016 or later) - UpdateFromSource (Exchange 2016 or later) @@ -409,7 +422,6 @@ The ConflictResolutionOption parameter specifies what to do if there are multipl Type: ConflictResolutionOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -419,13 +431,15 @@ Accept wildcard characters: False ``` ### -ContentCodePage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ContentCodePage parameter specifies the specific code page to use for an ANSI pst file. ANSI pst files are used in Outlook 97 to Outlook 2002. You can find the valid values in the [Code Page Identifiers](https://learn.microsoft.com/windows/win32/intl/code-page-identifiers) topic. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -435,6 +449,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -443,7 +460,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -453,6 +469,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpster + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: @@ -465,7 +484,6 @@ If you don't use this switch, the Recoverable Items folder is copied with the fo Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -475,6 +493,9 @@ Accept wildcard characters: False ``` ### -ExcludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExcludeFolders parameter specifies the list of folders to exclude during the import. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -511,7 +532,6 @@ If the TargetRootFolder parameter isn't specified when the Recoverable Items fol Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -521,6 +541,9 @@ Accept wildcard characters: False ``` ### -IncludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeFolders parameter specifies the list of folders to include during the import. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -555,7 +578,6 @@ Wildcard characters can't be used in folder names. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -565,6 +587,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -573,7 +598,6 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: Mailbox, MailboxLocationId Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -583,13 +607,15 @@ Accept wildcard characters: False ``` ### -IsArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsArchive switch specifies that you're importing the .pst file into the user's archive. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -599,6 +625,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -614,7 +643,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -624,6 +652,9 @@ Accept wildcard characters: False ``` ### -MigrationBatch + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use @@ -632,7 +663,6 @@ This parameter is reserved for internal Microsoft use Type: MigrationBatchIdParameter Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -642,13 +672,15 @@ Accept wildcard characters: False ``` ### -MigrationMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: MailboxIdParameter, AzureImportRequest Parameter Sets: MailboxLocationId Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -658,6 +690,9 @@ Accept wildcard characters: False ``` ### -MigrationUser + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -666,7 +701,6 @@ This parameter is reserved for internal Microsoft use. Type: MigrationUserIdParameter Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -676,6 +710,9 @@ Accept wildcard characters: False ``` ### -MRSContentFilterSasUri + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -684,7 +721,6 @@ This parameter is reserved for internal Microsoft use. Type: Uri Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -694,6 +730,9 @@ Accept wildcard characters: False ``` ### -MRSServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSServer parameter specifies the FQDN of the Client Access server on which the instance of the Microsoft Exchange Mailbox Replication service (MRS) is running. This parameter is used for debugging purposes only. Use this parameter only if directed by support personnel. @@ -702,7 +741,6 @@ The MRSServer parameter specifies the FQDN of the Client Access server on which Type: Fqdn Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -712,6 +750,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the specific request for tracking and display purposes. Because you can have multiple import requests per mailbox, Exchange precedes the name with the mailbox's alias. For example, if you create an import request for a user's mailbox that has the alias Kweku and specify the value of this parameter as PC1toArchive, the identity of this import request is Kweku\\PC1toArchive. If you don't specify a name using this parameter, Exchange generates up to 10 request names per mailbox, which is MailboxImportX (where X = 0-9). The identity of the request is displayed and searchable as `\MailboxImportX`. @@ -720,7 +761,6 @@ If you don't specify a name using this parameter, Exchange generates up to 10 re Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -730,6 +770,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Priority parameter specifies the order in which this request should be processed in the request queue. Requests are processed in order, based on server health, status, priority and last update time. @@ -738,7 +781,6 @@ The Priority parameter specifies the order in which this request should be proce Type: RequestPriority Parameter Sets: Mailbox, MailboxLocationId Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -748,6 +790,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -761,7 +806,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: MailboxLocationId, AzureImportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -771,6 +815,9 @@ Accept wildcard characters: False ``` ### -SkipInitialConnectionValidation + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -779,7 +826,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -789,13 +835,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipMerging parameter specifies steps in the import that should be skipped. This parameter is used primarily for debugging purposes. ```yaml Type: SkippableMergeComponent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -805,13 +853,15 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: MailboxLocationId, AzureImportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -821,13 +871,15 @@ Accept wildcard characters: False ``` ### -SourceRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceRootFolder parameter specifies the root folder of the .pst file from which data is imported. When specified, the folder hierarchy outside the value of the SourceRootFolder parameter isn't imported, and the SourceRootFolder parameter is mapped to the TargetRootFolder parameter. If this parameter isn't specified, the command imports all folders. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -837,15 +889,17 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. -If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. +If you use this switch, the request is queued, but the request doesn't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -855,13 +909,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -871,13 +927,15 @@ Accept wildcard characters: False ``` ### -TargetRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetRootFolder parameter specifies the top-level mailbox folder that the imported content is placed in. If you don't specify this parameter, the command imports folders to the top of the folder structure in the target mailbox or archive. If the folder already exists, content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -887,13 +945,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -903,6 +963,9 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -911,7 +974,6 @@ This parameter is reserved for internal Microsoft use. Type: RequestWorkloadType Parameter Sets: Mailbox, MailboxLocationId Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxRepairRequest.md similarity index 86% rename from exchange/exchange-ps/exchange/New-MailboxRepairRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxRepairRequest.md index b5e267cdc2..0c6bc785d5 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxRepairRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxrepairrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MailboxRepairRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxrepairrequest +schema: 2.0.0 +title: New-MailboxRepairRequest --- # New-MailboxRepairRequest @@ -50,7 +51,7 @@ After you begin a repair request, you can't stop it unless you dismount the data To avoid performance problems, only one request can be active on a server for a database-level repair, or up to 100 requests can be active on a server for a mailbox-level repair. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -94,6 +95,9 @@ This example creates a variable that identifies Ann Beebe's mailbox and then use ## PARAMETERS ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Database parameter repairs or detects corruption in all mailboxes in the specified database. You can use any value that uniquely identifies the database. For example: - Name @@ -108,7 +112,6 @@ To avoid performance issues, you're limited to one active database repair reques Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Mailbox parameter specifies the mailbox that you want to repair or detect corruption in. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -137,7 +143,6 @@ You can't use this parameter with the Database parameter. Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -147,6 +152,9 @@ Accept wildcard characters: False ``` ### -StoreMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StoreMailbox parameter specifies the mailbox GUID of the mailbox you want to repair or detect corruption in. Use this parameter with the Database parameter. Run the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. @@ -155,7 +163,6 @@ Run the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. Type: StoreMailboxIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 2 @@ -165,6 +172,9 @@ Accept wildcard characters: False ``` ### -CorruptionType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CorruptionType parameter specifies the type of corruption that you want to detect and repair. You can use the following values: - AbandonedMoveDestination\*: Exchange 2016 or later, but only with the Database parameter, not the Mailbox parameter. @@ -215,7 +225,6 @@ You can specify multiple values separated by commas. Type: MailboxStoreCorruptionType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -225,6 +234,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Archive switch specifies whether to repair or detect corruption the archive mailbox that's associated with the specified mailbox. You don't need to specify a value with this switch. If you don't use this switch, only the primary mailbox is included. @@ -235,7 +247,6 @@ You can't use this switch with the Database parameter. Type: SwitchParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,6 +256,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -254,7 +268,6 @@ 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 Required: False Position: Named @@ -264,13 +277,15 @@ Accept wildcard characters: False ``` ### -DetectOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DetectOnly switch specifies that you want to report errors, but not fix them. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +295,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,6 +313,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. This switch runs the command immediately without waiting to be dispatched by workload management. @@ -304,7 +324,6 @@ This switch runs the command immediately without waiting to be dispatched by wor Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -314,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxRestoreRequest.md similarity index 86% rename from exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxRestoreRequest.md index 43a1b13892..095d7d0fc6 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxRestoreRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxrestorerequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxRestoreRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxrestorerequest +schema: 2.0.0 +title: New-MailboxRestoreRequest --- # New-MailboxRestoreRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MailboxRestoreRequest cmdlet to restore a soft-deleted or disconnected mailbox. This cmdlet starts the process of moving content from the soft-deleted mailbox, disabled mailbox, or any mailbox in a recovery database into a connected primary or archive mailbox. @@ -219,15 +220,15 @@ To view soft-deleted mailboxes, run the Get-MailboxStatistics cmdlet against a d A mailbox is marked as Disabled a short time after the Disable-Mailbox or Remove-Mailbox command completes. -The mailbox won't be marked as Disabled until the Microsoft Exchange Information Store service determines that Active Directory has been updated with the disabled mailbox's information. You can expedite the process by running the Update-StoreMailboxState cmdlet against that database. +The mailbox isn't marked as Disabled until the Microsoft Exchange Information Store service determines that Active Directory is updated with the disabled mailbox's information. You can expedite the process by running the Update-StoreMailboxState cmdlet against that database. Exchange retains disabled mailboxes in the mailbox database based on the deleted mailbox retention settings configured for that mailbox database. After the specified period of time, the mailbox is permanently deleted. To view disabled mailboxes, run the Get-MailboxStatistics cmdlet against a database and look for results that have a DisconnectReason with a value of Disabled. For more information, see Examples 2 and 3 later in this topic. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -**Note**: To restore the contents of a primary mailbox to an archive mailbox, use the TargetRootFolder parameter to specify the archive mailbox folders to migrate the content to. This content will be visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. +**Note**: To restore the contents of a primary mailbox to an archive mailbox, use the TargetRootFolder parameter to specify the archive mailbox folders to migrate the content to. This content is visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. ## EXAMPLES @@ -263,6 +264,9 @@ In Exchange Online, this example restores the content of the inactive, disconnec ## PARAMETERS ### -CrossTenantRestore + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -271,7 +275,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: CrossTenantRestore Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -281,6 +284,9 @@ Accept wildcard characters: False ``` ### -RemoteCredential + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -289,7 +295,6 @@ This parameter is reserved for internal Microsoft use. Type: PSCredential Parameter Sets: SourceMailbox Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -299,6 +304,9 @@ Accept wildcard characters: False ``` ### -RemoteDatabaseGuid + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -307,7 +315,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: SourceMailbox Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -317,6 +324,9 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -325,7 +335,6 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: SourceMailbox Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -335,6 +344,9 @@ Accept wildcard characters: False ``` ### -RemoteRestoreType + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -343,7 +355,6 @@ This parameter is reserved for internal Microsoft use. Type: RemoteRestoreType Parameter Sets: SourceMailbox Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -353,6 +364,9 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SourceDatabase parameter specifies the identity of the database from which you're restoring the soft-deleted or disconnected mailbox. You can use any value that uniquely identifies the database. For example: @@ -365,7 +379,6 @@ The SourceDatabase parameter specifies the identity of the database from which y Type: DatabaseIdParameter Parameter Sets: Default, MigrationLocalMailboxRestore Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -375,6 +388,9 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -383,7 +399,6 @@ This parameter is reserved for internal Microsoft use. Type: MigrationEndpointIdParameter Parameter Sets: CrossTenantRestore Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -393,6 +408,9 @@ Accept wildcard characters: False ``` ### -SourceExchangeGuid + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -401,7 +419,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: CrossTenantRestore Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -411,13 +428,15 @@ Accept wildcard characters: False ``` ### -SourceMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceMailbox parameter specifies the soft-deleted mailbox that you want to restore. The best way to identify the soft-deleted mailbox is by its GUID value. You can find the GUID value by running the following command: Get-Mailbox -SoftDeletedMailbox. ```yaml Type: SourceMailbox Parameter Sets: SourceMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -427,6 +446,9 @@ Accept wildcard characters: False ``` ### -SourceStoreMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The SourceStoreMailbox parameter specifies the MailboxGUID of the source mailbox that you want to restore content from. @@ -437,7 +459,6 @@ You can find the MailboxGUID by running the Get-MailboxStatistics cmdlet. Type: StoreMailboxIdParameter Parameter Sets: Default, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -447,6 +468,9 @@ Accept wildcard characters: False ``` ### -SourceTenant + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -455,7 +479,6 @@ This parameter is reserved for internal Microsoft use. Type: SmtpDomain Parameter Sets: CrossTenantRestore Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -465,6 +488,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetMailbox parameter specifies the GUID of the target mailbox or mail user where you want to restore content to. The target mailbox or mail user needs to exist before you can run this command successfully. You can find the GUID value for the mailbox or mail user by running the Get-Mailbox or Get-MailUser cmdlets. @@ -475,9 +501,8 @@ In Exchange 2013 or earlier, this parameter is the type MailboxOrMailUserIdParam ```yaml Type: MailboxLocationIdParameter -Parameter Sets: CrossTenantRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Parameter Sets: Default, RemoteMailboxRestoreMailboxId, CrossTenantRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -486,20 +511,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxOrMailUserIdParameter -Parameter Sets: Default, RemoteMailboxRestoreMailboxId -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 +### -AcceptLargeDataLoss -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -AcceptLargeDataLoss The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later or Exchange Online, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -510,7 +525,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -520,6 +534,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyDNMismatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowLegacyDNMismatch switch specifies that the operation should continue if the LegacyExchangeDN of the source physical mailbox and the target mailbox don't match. You don't need to specify a value with this switch. By default, this cmdlet checks to make sure that the LegacyExchangeDN on the source physical mailbox is present on the target user in the form of the LegacyExchangeDN or an X500 proxy address that corresponds to the LegacyExchangeDN. This check prevents you from accidentally restoring a source mailbox into the incorrect target mailbox. @@ -530,7 +547,6 @@ By default, this cmdlet checks to make sure that the LegacyExchangeDN on the sou Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -540,11 +556,14 @@ Accept wildcard characters: False ``` ### -AssociatedMessagesCopyOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AssociatedMessagesCopyOption parameter specifies whether associated messages are copied when the request is processed. Associated messages are special messages that contain hidden data with information about rules, views, and forms. Valid values are: - DoNotCopy: The associated messages aren't copied. - MapByMessageClass: Find the associated message by looking up the MessageClass attribute of the source message. If there's an associated message of this class in both source and target folders, it overwrites the associated message in the target. If there isn't an associated message in the target, it creates a copy in the target. -- Copy: Copy associated messages from the source to the target. If the same message type exists both in the source and the target location, these associated messages are duplicated. This is the default value. +- Copy: Copy associated messages from the source to the target. If the same message type exists both in the source and the target location, these associated messages are duplicated. This value is the default. Content filtering doesn't apply to associated messages. @@ -552,7 +571,6 @@ Content filtering doesn't apply to associated messages. Type: FAICopyOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -562,19 +580,21 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. In Exchange 2010, if you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -584,13 +604,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter specifies a descriptive name for restoring a batch of mailboxes. You can use the name in the BatchName parameter as a string search when you use the Get-MailboxRestoreRequest cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -600,13 +622,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the status of a completed restore request is set to Completed. If this parameter is set to a value of 0, the status is cleared immediately instead of being changed to Completed. ```yaml Type: Unlimited Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -616,6 +640,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -625,7 +652,6 @@ 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 Required: False Position: Named @@ -635,12 +661,15 @@ Accept wildcard characters: False ``` ### -ConflictResolutionOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConflictResolutionOption parameter specifies what to do if there are multiple matching messages in the target. Valid values are: - ForceCopy - KeepAll - KeepLatestItem -- KeepSourceItem (This is the default value.) +- KeepSourceItem (This value is the default.) - KeepTargetItem - UpdateFromSource @@ -648,7 +677,6 @@ The ConflictResolutionOption parameter specifies what to do if there are multipl Type: ConflictResolutionOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -658,9 +686,12 @@ Accept wildcard characters: False ``` ### -ContentFilter + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The ContentFilter parameter uses OPATH filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter will be restored. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The ContentFilter parameter uses OPATH filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter are restored. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. For filterable properties, see [Filterable properties for the ContentFilter parameter](https://learn.microsoft.com/exchange/filterable-properties-for-the-contentfilter-parameter). @@ -675,7 +706,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -685,6 +715,9 @@ Accept wildcard characters: False ``` ### -ContentFilterLanguage + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. @@ -695,7 +728,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -705,6 +737,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -713,7 +748,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -723,6 +757,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpster + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: @@ -735,7 +772,6 @@ If you don't use this switch, the Recoverable Items folder is copied with the fo Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -745,6 +781,9 @@ Accept wildcard characters: False ``` ### -ExcludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExcludeFolders parameter specifies the list of folders to exclude during the restore request. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -779,7 +818,6 @@ Wildcard characters can't be used in folder names. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -789,6 +827,9 @@ Accept wildcard characters: False ``` ### -IncludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeFolders parameter specifies the list of folder to include during the restore request. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -823,7 +864,6 @@ Wildcard characters can't be used in folder names. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -833,6 +873,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -841,7 +884,6 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -851,6 +893,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -862,13 +907,12 @@ Valid input for this parameter is an integer or the value unlimited. The default If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -878,6 +922,9 @@ Accept wildcard characters: False ``` ### -MRSServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSServer parameter specifies the FQDN of the Client Access server on which the instance of the Microsoft Exchange Mailbox Replication service (MRS) is running. This parameter is used for debugging purposes only. Use this parameter only if directed by support personnel. @@ -886,7 +933,6 @@ The MRSServer parameter specifies the FQDN of the Client Access server on which Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -896,6 +942,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the specific request for tracking and display purposes. Because you can have multiple restore requests per mailbox, Exchange precedes the name with the mailbox's alias. For example, if you create an export request for a user's mailbox that has the alias Kweku and specify the value of this parameter as RestoreFailedMoves, the identity of this export request is Kweku\\RestoreFailedMoves. If you didn't specify a name for the restore request when it was created, Exchange automatically generates the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -904,7 +953,6 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -914,6 +962,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -921,7 +972,7 @@ The Priority parameter specifies the order in which the request should be proces - Lowest - Lower - Low -- Normal (This is the default value.) +- Normal (This value is the default.) - High - Higher - Highest @@ -931,7 +982,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: Default, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -941,6 +991,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: @@ -956,7 +1009,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -966,6 +1018,9 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipMerging parameter specifies folder-related items to skip when restoring the mailbox. Use one of the following values: - FolderACLs @@ -979,7 +1034,6 @@ Use this parameter only if a restore request fails because of folder rules, fold Type: SkippableMergeComponent[] Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -989,6 +1043,9 @@ Accept wildcard characters: False ``` ### -SourceIsArchive + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceIsArchive switch specifies that the source mailbox is an archive mailbox. You don't need to specify a value with this switch. You can use this switch only with the SourceMailbox parameter. @@ -997,7 +1054,6 @@ You can use this switch only with the SourceMailbox parameter. Type: SwitchParameter Parameter Sets: SourceMailboxMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1007,13 +1063,15 @@ Accept wildcard characters: False ``` ### -SourceRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceRootFolder parameter specifies the root folder of the mailbox from which data is restored. If this parameter isn't specified, the command restores all folders. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1023,15 +1081,17 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. -If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. +If you use this switch, the request is queued, but the request doesn't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1041,13 +1101,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1057,13 +1119,15 @@ Accept wildcard characters: False ``` ### -TargetIsArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetIsArchive switch specifies that the content is restored into the specified target mailbox's archive. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1073,15 +1137,17 @@ Accept wildcard characters: False ``` ### -TargetRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetRootFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. -**Note**: To restore the contents of a primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders to migrate the content to. This content will be visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. +**Note**: To restore the contents of a primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders to migrate the content to. This content is visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1091,17 +1157,19 @@ Accept wildcard characters: False ``` ### -TargetType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetType parameter specifies the type of mailbox that's the target for the restore operation. Valid values are: - Archive - MailboxLocation -- Primary (This is the default value) +- Primary (default value) ```yaml Type: TargetTypeComponent Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1111,13 +1179,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1127,6 +1197,9 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1135,7 +1208,6 @@ This parameter is reserved for internal Microsoft use. Type: RequestWorkloadType Parameter Sets: MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxSearch.md similarity index 82% rename from exchange/exchange-ps/exchange/New-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxSearch.md index 8c7db70175..9a3283d0a7 100644 --- a/exchange/exchange-ps/exchange/New-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MailboxSearch -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxsearch +schema: 2.0.0 +title: New-MailboxSearch --- # New-MailboxSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MailboxSearch cmdlet to create a mailbox search and either get an estimate of search results, place search results on In-Place Hold or copy them to a Discovery mailbox. You can also place all contents in a mailbox on hold by not specifying a search query, which accomplishes similar results as Litigation Hold. @@ -61,7 +62,7 @@ By default, mailbox searches are performed across all Exchange 2013 or later Mai For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and [In-Place Hold and Litigation Hold in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/holds/holds). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,6 +104,9 @@ In on-premises Exchange, this example creates an In-Place Hold named Hold for al ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a friendly name for the search. If the value contains spaces, enclose the value in quotation marks ("). The value of this parameter is used to create the top-level folder that holds the search results in the target mailbox that's specified by the TargetMailbox parameter. @@ -111,7 +115,6 @@ The value of this parameter is used to create the top-level folder that holds th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -121,16 +124,18 @@ Accept wildcard characters: False ``` ### -AllPublicFolderSources + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllPublicFolderSources parameter specifies whether to include all public folders in the organization in the search. Valid values are: - $true: All public folders are included in the search. This value is required when the value of the AllSourceMailboxes parameter is $false and you don't specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value is blank [$null]). -- $false: No public folders are included in the search. This is the default value. You can use this value when the value of the AllSourceMailboxes parameter is $true or you specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value isn't blank [$null]). +- $false: No public folders are included in the search. This value is the default. You can use this value when the value of the AllSourceMailboxes parameter is $true or you specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value isn't blank [$null]). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -140,16 +145,18 @@ Accept wildcard characters: False ``` ### -AllSourceMailboxes + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllSourceMailboxes parameter specifies whether to include all mailboxes in the search. Valid values are: - $true: All mailboxes are included in the search. This value is required when the value of the AllPublicFolderSources parameter is $false and you don't specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value is blank [$null]). -- $false: All mailboxes aren't included in the search. This is the default value. You can use this value when the value of the AllPublicFolderSources parameter is $true or you specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value isn't blank [$null]). +- $false: All mailboxes aren't included in the search. This value is the default. You can use this value when the value of the AllPublicFolderSources parameter is $true or you specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value isn't blank [$null]). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -159,6 +166,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -168,7 +178,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -178,13 +187,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Description parameter specifies a description for the search. The description isn't displayed to users. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -194,6 +205,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -202,7 +216,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -DoNotIncludeArchive + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The DoNotIncludeArchive switch specifies that archive mailboxes are not included in the search. You don't need to specify a value with this switch. @@ -222,7 +238,6 @@ By default, archive mailboxes are included in the search. To exclude archive mai Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -232,6 +247,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -240,7 +258,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -250,7 +267,10 @@ Accept wildcard characters: False ``` ### -EstimateOnly -The EstimateOnly switch specifies that only an estimate of the number of items that will be returned is provided. You don't need to specify a value with this switch. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The EstimateOnly switch specifies that only an estimate of the number of items to be returned is provided. You don't need to specify a value with this switch. If you don't use this switch, messages are copied to the target mailbox. @@ -258,7 +278,6 @@ If you don't use this switch, messages are copied to the target mailbox. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -268,16 +287,18 @@ Accept wildcard characters: False ``` ### -ExcludeDuplicateMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExcludeDuplicateMessages parameter eliminates duplication of messages in search results. Valid values are: -- $true: Copy a single instance of a message if the same message exists in multiple folders or mailboxes. This is the default value. +- $true: Copy a single instance of a message if the same message exists in multiple folders or mailboxes. This value is the default. - $false: Copy all instances of a message if the same message exists in multiple folders or mailboxes. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,6 +308,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -295,7 +319,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -305,13 +328,15 @@ Accept wildcard characters: False ``` ### -IncludeKeywordStatistics + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeKeywordStatistics switch returns keyword statistics (number of instances for each keyword) in search results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -321,6 +346,9 @@ Accept wildcard characters: False ``` ### -IncludeUnsearchableItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeUnsearchableItems switch specifies that items that couldn't be indexed by Exchange Search should be included in the results. You don't need to specify a value with this switch. Unsearchable items aren't placed on hold for a query-based In-Place Hold. If you need to place unsearchable items on hold, you need to create an indefinite hold (a hold without specifying any search parameters, which provides functionality similar to Litigation Hold. @@ -329,7 +357,6 @@ Unsearchable items aren't placed on hold for a query-based In-Place Hold. If you Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -339,20 +366,22 @@ Accept wildcard characters: False ``` ### -InPlaceHoldEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The InPlaceHoldEnabled parameter specifies whether to set an In-Place Hold on items in the search results. Valid values are: - $true: In-Place Hold is enabled on the search results. -- $false: In-Place Hold isn't enabled on the search results. This is the default value. +- $false: In-Place Hold isn't enabled on the search results. This value is the default. You can't set an In-Place Hold on the search results when the AllSourceMailboxes parameter is $true. -If you attempt to place a hold but don't specify mailboxes using the SourceMailboxes parameter, the command may succeed but the mailboxes are not placed on In-Place Hold. +If you attempt to place a hold but don't specify mailboxes using the SourceMailboxes parameter, the command might succeed but the mailboxes are not placed on In-Place Hold. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -362,13 +391,15 @@ Accept wildcard characters: False ``` ### -InPlaceHoldIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -378,16 +409,18 @@ Accept wildcard characters: False ``` ### -ItemHoldPeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold onthe mailbox items (all mailbox items or the items that are returned in the search query results). The duration is calculated from the time the item is received or created in the mailbox. Valid values are: - An integer. -- The value unlimited. This is the default value. Items are held until you remove the In-Place Hold by removing the search by using the Remove-MailboxSearch cmdlet, removing the source mailbox from the search by using the Set-MailboxSearch cmdlet and the SourceMailboxes parameter, or in on-premises Exchange, you remove all public folders from the search by using the Set-MailboxSearch cmdlet to change the AllPublicFolderSources parameter from $true to $false. +- The value unlimited. This value is the default. Items are held until you remove the In-Place Hold by removing the search by using the Remove-MailboxSearch cmdlet, removing the source mailbox from the search by using the Set-MailboxSearch cmdlet and the SourceMailboxes parameter, or in on-premises Exchange, you remove all public folders from the search by using the Set-MailboxSearch cmdlet to change the AllPublicFolderSources parameter from $true to $false. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -397,6 +430,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Language parameter specifies a locale for the search. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -405,7 +441,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -415,17 +450,19 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LogLevel parameter specifies the logging level for the search. Valid values are: - Suppress: No logs are kept. -- Basic: Basic information about the query and who ran it is kept. This is the default value. +- Basic: Basic information about the query and who ran it is kept. This value is the default. - Full: In addition to the information kept by the Basic log level, the Full log level adds a complete list of search results. ```yaml Type: LoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -435,6 +472,9 @@ Accept wildcard characters: False ``` ### -MessageTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MessageTypes parameter specifies the message types to include in the search query. Valid values are: - Contacts @@ -454,7 +494,6 @@ The default value is blank ($null), which means all message types are included. Type: KindKeyword[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -464,6 +503,9 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Recipients parameter specifies one or more recipients to include in the search query. Messages that have the specified recipients in the To, Cc, and Bcc fields are returned in the search results. You can specify multiple recipients separated by commas. @@ -472,7 +514,6 @@ You can specify multiple recipients separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -482,6 +523,9 @@ Accept wildcard characters: False ``` ### -SearchDumpster + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The SearchDumpster switch specifies whether the dumpster is searched. You don't need to specify a value with this switch. @@ -492,7 +536,6 @@ The dumpster is a storage area in the mailbox where deleted items are temporaril Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -502,6 +545,9 @@ Accept wildcard characters: False ``` ### -SearchQuery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). If you use this parameter with other search query parameters, the query combines these parameters by using the AND operator. @@ -518,7 +564,6 @@ The other search query parameters are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -528,6 +573,9 @@ Accept wildcard characters: False ``` ### -Senders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Senders parameter specifies one or more senders to include in the search query. Messages that have the specified sender are returned in the search results. Senders can include users, distribution groups (messages sent by members of the group), SMTP addresses, or domains. You can specify multiple senders separated by commas. If the value contains spaces, enclose the value in quotation marks ("). @@ -536,7 +584,6 @@ You can specify multiple senders separated by commas. If the value contains spac Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -546,6 +593,9 @@ Accept wildcard characters: False ``` ### -SourceMailboxes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceMailboxes parameter specifies the identity of one or more mailboxes to be searched. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -570,7 +620,6 @@ To enable In-Place Hold on the search results, you need to set the AllSourceMail Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -580,6 +629,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -588,7 +640,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -598,6 +649,9 @@ Accept wildcard characters: False ``` ### -StatusMailRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StatusMailRecipients parameter specifies one or more recipients to receive a status email message upon completion of the search. You can use any value that uniquely identifies the recipient. For example: - Name @@ -613,7 +667,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -623,6 +676,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetMailbox parameter specifies the destination mailbox where the search results are copied. You can use any value that uniquely identifies themailbox. For example: - Name @@ -640,7 +696,6 @@ The TargetMailbox parameter specifies the destination mailbox where the search r Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -650,13 +705,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterPolicy.md index 0dd0822a20..2e11030806 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-malwarefilterpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MalwareFilterPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-malwarefilterpolicy +schema: 2.0.0 +title: New-MalwareFilterPolicy --- # New-MalwareFilterPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MalwareFilterPolicy cmdlet to create malware filter policies in your organization. @@ -55,7 +56,7 @@ New-MalwareFilterPolicy [-Name] ## DESCRIPTION New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the MalwareFilterPolicy parameter on the New-MalwareFilterRule or Set-MalwareFilterRule cmdlets to associate the policy with a rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,13 +73,15 @@ This example creates a new malware filter policy named Contoso Malware Filter Po ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -88,11 +91,14 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Action parameter specifies the action to take when malware is detected in a message. Valid values are: -- DeleteMessage: Handles the message without notifying the recipients. This is the default value. +- DeleteMessage: Handles the message without notifying the recipients. This value is the default. - DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. - DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. @@ -100,7 +106,6 @@ The Action parameter specifies the action to take when malware is detected in a Type: MalwareFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,18 +133,20 @@ Accept wildcard characters: False ``` ### -BypassInboundMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BypassInboundMessages parameter enables or disables malware filtering on incoming messages (messages entering the organization). Valid values are: - $true: Malware filtering is disabled on inbound messages. -- $false: Malware filtering is enabled on inbound messages. This is the default value. +- $false: Malware filtering is enabled on inbound messages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,18 +156,20 @@ Accept wildcard characters: False ``` ### -BypassOutboundMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BypassOutboundMessages parameter enables or disables malware filtering on outgoing messages (messages leaving the organization). Valid values are: - $true: Malware filtering is disabled on outbound messages. -- $false: Malware filtering is enabled on outbound messages. This is the default value. +- $false: Malware filtering is enabled on outbound messages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +179,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -177,7 +191,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,6 +200,9 @@ Accept wildcard characters: False ``` ### -CustomAlertText + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). @@ -197,7 +213,6 @@ This parameter is meaningful only when the value of the Action parameter is Dele Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +222,9 @@ Accept wildcard characters: False ``` ### -CustomExternalBody + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -218,7 +236,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -CustomExternalSubject + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomExternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is 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: @@ -239,7 +259,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -249,6 +268,9 @@ Accept wildcard characters: False ``` ### -CustomFromAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomFromAddress parameter specifies the custom From address to use in notification messages for malware detections in messages from internal or external senders. This parameter is 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: @@ -262,7 +284,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -272,6 +293,9 @@ Accept wildcard characters: False ``` ### -CustomFromName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomFromName parameter specifies the custom From name to use in notification messages for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is 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: @@ -285,7 +309,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -295,6 +318,9 @@ Accept wildcard characters: False ``` ### -CustomInternalBody + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomInternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is 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: @@ -306,7 +332,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -316,6 +341,9 @@ Accept wildcard characters: False ``` ### -CustomInternalSubject + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomInternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is 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: @@ -327,7 +355,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,6 +364,9 @@ Accept wildcard characters: False ``` ### -CustomNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomNotifications parameter enables or disables the customization of notification messages for malware detections. Valid values are: - $true: Replace the default values used in notification messages with the values of the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. @@ -353,7 +383,6 @@ This parameter is meaningful only when the value of at least one of the followin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -363,6 +392,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -371,7 +403,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -381,10 +412,13 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderAdminNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: - $true: When malware attachments are detected in messages from external senders, a notification messages is sent to the email address that's specified by the ExternalSenderAdminAddress parameter. -- $false: Notifications aren't sent for malware attachment detections in messages from external senders. This is the default value. +- $false: Notifications aren't sent for malware attachment detections in messages from external senders. This value is the default. **Note**: Admin notifications are sent only for _attachments_ that are classified as malware. @@ -392,7 +426,6 @@ The EnableExternalSenderAdminNotifications parameter enables or disables sending Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -402,18 +435,20 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EnableExternalSenderNotifications parameter enables or disables sending notification messages to external senders for malware detections in their messages. Valid values are: - $true: When malware is detected in a message from an external sender, send them a notification message. -- $false: Don't send malware detection notification messages to external message senders. This is the default value. +- $false: Don't send malware detection notification messages to external message senders. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -423,11 +458,14 @@ Accept wildcard characters: False ``` ### -EnableFileFilter + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The EnableFileFilter parameter enables or disables the common attachments filter (also known as common attachment blocking). Valid values are: -- $true: The common attachments filter is enabled. This is the default value. +- $true: The common attachments filter is enabled. This value is the default. - $false: The common attachments filter is disabled. You specify the file types using the FileTypes parameter. A default list of values is automatically provided, but you can customize it. @@ -438,7 +476,6 @@ You specify the action for detected files using the FileTypeAction parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -448,10 +485,13 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderAdminNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EnableInternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: - $true: When malware attachments are detected in messages from internal senders, a notification messages is sent to the email address that's specified by the InternalSenderAdminAddress parameter. -- $false: Notifications aren't sent for malware attachment detections in messages from internal senders. This is the default value. +- $false: Notifications aren't sent for malware attachment detections in messages from internal senders. This value is the default. **Note**: Admin notifications are sent only for _attachments_ that are classified as malware. @@ -459,7 +499,6 @@ The EnableInternalSenderAdminNotifications parameter enables or disables sending Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -469,18 +508,20 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EnableInternalSenderNotifications parameter enables or disables sending notification messages to internal senders for malware detections in their messages. Valid values are: - $true: When malware is detected in a message from an internal sender, send them a notification message. -- $false: Don't send malware detection notification messages to internal message senders. This is the default value. +- $false: Don't send malware detection notification messages to internal message senders. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -490,6 +531,9 @@ Accept wildcard characters: False ``` ### -ExternalSenderAdminAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from external senders. This parameter is meaningful only if the value of the EnableExternalSenderAdminNotifications parameter is $true. @@ -498,7 +542,6 @@ This parameter is meaningful only if the value of the EnableExternalSenderAdminN Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,12 +551,15 @@ Accept wildcard characters: False ``` ### -FileTypeAction + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The FileTypeAction parameter specifies what happens to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: - Quarantine: Quarantine the message. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the malware filter policy by the QuarantineTag parameter. -- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This is the default value. +- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This value is the default. This parameter is meaningful only when the value of the EnableFileFilter parameter is $true. @@ -521,7 +567,6 @@ This parameter is meaningful only when the value of the EnableFileFilter paramet Type: FileTypeFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -531,6 +576,9 @@ Accept wildcard characters: False ``` ### -FileTypes + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The FileTypes parameter specifies the file types that are automatically blocked by the common attachments filter, regardless of content. The default values are: @@ -549,7 +597,6 @@ To add or remove file types without affecting the other file type entries, see t Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -559,6 +606,9 @@ Accept wildcard characters: False ``` ### -InternalSenderAdminAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The InternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from internal senders. This parameter is meaningful only if the value of the EnableInternalSenderAdminNotifications parameter is $true. @@ -567,7 +617,6 @@ This parameter is meaningful only if the value of the EnableInternalSenderAdminN Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -577,6 +626,9 @@ Accept wildcard characters: False ``` ### -QuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware. You can use any value that uniquely identifies the quarantine policy. For example: @@ -595,7 +647,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -605,6 +656,9 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/preset-security-policies). Don't use this parameter yourself. @@ -613,7 +667,6 @@ The RecommendedPolicyType parameter is used for Standard and Strict policy creat Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -623,13 +676,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -639,18 +694,20 @@ Accept wildcard characters: False ``` ### -ZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware in cloud mailboxes. ZAP detects malware in unread messages that have already been delivered to the user's Inbox. Valid values are: -- $true: ZAP for malware is enabled. Unread messages in the user's Inbox that contain malware are moved to the Junk Email folder. This is the default value. +- $true: ZAP for malware is enabled. Unread messages in the user's Inbox that contain malware are moved to the Junk Email folder. This value is the default. - $false: ZAP for malware is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterRule.md similarity index 80% rename from exchange/exchange-ps/exchange/New-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterRule.md index ad4f6ad019..cdd83af3d6 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-malwarefilterrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MalwareFilterRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-malwarefilterrule +schema: 2.0.0 +title: New-MalwareFilterRule --- # New-MalwareFilterRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MalwareFilterRule cmdlet to create malware filter rules in your organization. @@ -41,7 +42,7 @@ New-MalwareFilterRule [-Name] -MalwareFilterPolicy [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Anti-malware policies](https://learn.microsoft.com/defender-office-365/anti-malware-protection-about#anti-malware-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example creates a new malware filter rule named Contoso Recipients with the ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the malware filter rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -MalwareFilterPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule. You can use any value that uniquely identifies the policy. For example: @@ -85,7 +91,6 @@ You can't specify the default malware filter policy, and you can't specify a pol Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -120,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -138,7 +150,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Enabled parameter enables or disables the malware filter rule. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -164,13 +177,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -180,6 +195,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -195,7 +213,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -205,6 +222,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -222,7 +242,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -232,6 +251,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -246,7 +268,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -256,13 +277,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -272,6 +295,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -287,7 +313,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -297,6 +322,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -314,7 +342,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -324,13 +351,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagedContentSettings.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagedContentSettings.md similarity index 91% rename from exchange/exchange-ps/exchange/New-ManagedContentSettings.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagedContentSettings.md index 1d10f3fbcb..18d380d7d6 100644 --- a/exchange/exchange-ps/exchange/New-ManagedContentSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagedContentSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managedcontentsettings applicable: Exchange Server 2010 -title: New-ManagedContentSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managedcontentsettings +schema: 2.0.0 +title: New-ManagedContentSettings --- # New-ManagedContentSettings @@ -45,7 +46,7 @@ Managed content settings are settings that you associate with managed folders to For more information about managed content settings, see [Messaging Records Management](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123507(v=exchg.141)). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,7 +55,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi New-ManagedContentSettings -Name "CS-Exec-DeletedItems" -FolderName "Exec-DeletedItems" -MessageClass * -RetentionEnabled $true -RetentionAction DeleteAndAllowRecovery -AgeLimitForRetention 30.00:00:00 -TriggerForRetention WhenDelivered ``` -This example creates managed content settings for the managed default folder Exec-DeletedItems. When added to a managed folder mailbox policy and applied to a mailbox, items in the Deleted Items folder will be permanently deleted 30 days from the date of delivery. +This example creates managed content settings for the managed default folder Exec-DeletedItems. When added to a managed folder mailbox policy and applied to a mailbox, items in the Deleted Items folder are permanently deleted 30 days from the date of delivery. ### Example 2 ```powershell @@ -66,13 +67,15 @@ This example creates managed content settings CS-Exec-Calendar for the Calendar ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies a unique name for the managed content settings. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -FolderName + +> Applicable: Exchange Server 2010 + The FolderName parameter specifies the name or GUID of the managed folder to which the managed content settings apply. ```yaml Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -MessageClass + +> Applicable: Exchange Server 2010 + The MessageClass parameter specifies the message type to which any expiration and journaling configuration settings within these content settings apply. The parameter value can be a well-known message type such as Calendar items, a specific message class such as IPM.NOTE.SMIME, or a custom message class. The following well-known message types can be used: @@ -130,7 +138,6 @@ Valid parameter values for custom message classes include: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -AddressForJournaling + +> Applicable: Exchange Server 2010 + The AddressForJournaling parameter specifies the journaling recipient where journaled messages are sent. You can use any value that uniquely identifies the recipient. For example: - Name @@ -155,7 +165,6 @@ This parameter is required if the JournalingEnabled parameter is set to $true. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -AgeLimitForRetention + +> Applicable: Exchange Server 2010 + The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -190,7 +204,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -200,13 +213,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -216,13 +231,15 @@ Accept wildcard characters: False ``` ### -JournalingEnabled + +> Applicable: Exchange Server 2010 + The JournalingEnabled parameter specifies that journaling is enabled when set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -232,13 +249,15 @@ Accept wildcard characters: False ``` ### -LabelForJournaling + +> Applicable: Exchange Server 2010 + The LabelForJournaling parameter specifies a label that's attached to an item. This label is used by the destination store to determine the content of the item and enforce the appropriate policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -248,6 +267,9 @@ Accept wildcard characters: False ``` ### -MessageFormatForJournaling + +> Applicable: Exchange Server 2010 + The MessageFormatForJournaling parameter specifies the message format that an item should be journaled in. You can use the following values: - UseMsg Outlook .msg format @@ -257,7 +279,6 @@ The MessageFormatForJournaling parameter specifies the message format that an it Type: JournalingFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -267,6 +288,9 @@ Accept wildcard characters: False ``` ### -MoveToDestinationFolder + +> Applicable: Exchange Server 2010 + The MoveToDestinationFolder parameter specifies the destination folder for a move action. The destination folder must be an existing managed custom folder. If it isn't, an error is returned. If the MoveToDestinationFolder parameter isn't present, and the value of the RetentionAction parameter is MoveToFolder, an error is returned. @@ -275,7 +299,6 @@ The destination folder must be an existing managed custom folder. If it isn't, a Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -285,6 +308,9 @@ Accept wildcard characters: False ``` ### -RetentionAction + +> Applicable: Exchange Server 2010 + The RetentionAction parameter specifies one of the following actions: - Mark as past retention limit @@ -299,7 +325,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -309,13 +334,15 @@ Accept wildcard characters: False ``` ### -RetentionEnabled + +> Applicable: Exchange Server 2010 + The RetentionEnabled parameter specifies that retention is enabled when set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -325,6 +352,9 @@ Accept wildcard characters: False ``` ### -TriggerForRetention + +> Applicable: Exchange Server 2010 + The TriggerForRetention parameter specifies the date that's considered as the start date for the retention period. An item can reach its retention limit a specific number of days after the item was delivered or after it was moved to a folder. Valid values include: @@ -332,7 +362,7 @@ Valid values include: - WhenDelivered - WhenMoved -This value corresponds to the 0x4 bit of the msExchELCFlags attribute in Active Directory. The flag is set to $true if the item will expire based on the date it was moved and $false if the item will expire based on the delivery date. +This value corresponds to the 0x4 bit of the msExchELCFlags attribute in Active Directory. The flag is set to $true if the item expires based on the date it was moved and $false if the item expires based on the delivery date. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. @@ -340,7 +370,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionDateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -350,13 +379,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagedFolder.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagedFolder.md similarity index 92% rename from exchange/exchange-ps/exchange/New-ManagedFolder.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagedFolder.md index da5d39bc23..826712ca3c 100644 --- a/exchange/exchange-ps/exchange/New-ManagedFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagedFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managedfolder applicable: Exchange Server 2010 -title: New-ManagedFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managedfolder +schema: 2.0.0 +title: New-ManagedFolder --- # New-ManagedFolder @@ -61,7 +62,7 @@ The New-ManagedFolder cmdlet creates a new managed folder in Active Directory. A By default, managed custom folders are created with this cmdlet. However, you can also create additional copies of managed default folders using the DefaultFolderType parameter to specify which type of default folder to create (for example, an additional Inbox folder). When you create multiple copies of a managed default folder, you can assign different content settings to each one. For example, you could have two Inbox folders, one named InboxSixMonths and another named InboxOneYear. Then, you could assign a retention time of six months to the first folder and one year to the second folder with the New-ManagedContentSettings cmdlet (or using the New Managed Content Settings wizard in the Exchange Management Console). You must assign a unique name (using the Name parameter) to each of the managed default folders that you create. Users, however, always see the unaltered default folder name. In the example, whether users are assigned an InboxSixMonths folder or an InboxOneYear folder, the Inbox that they see in their mailbox is labeled Inbox. Although the folder names that users see in their mailboxes can be reassigned for managed custom folders (using the Set-ManagedFolder command FolderName parameter), the folder names seen by users for managed default folders can't be changed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -89,6 +90,9 @@ This example creates an instance of the default folder Inbox. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies a unique name for the managed folder object in Active Directory. The name can have up to 65 characters. Whereas the FolderName parameter specifies the folder name as displayed to users in clients, the Name parameter is used by Exchange administration tools to represent the managed folder object. The Name parameter shouldn't be confused with the FolderName parameter. @@ -97,7 +101,6 @@ The Name parameter shouldn't be confused with the FolderName parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -DefaultFolderType + +> Applicable: Exchange Server 2010 + The DefaultFolderType parameter specifies the type of default folder to create, such as Inbox or Deleted Items. A managed folder mailbox policy can have only one managed folder of each default folder type. Additional default folders of a particular type, such as Inbox, can be created and added to different mailbox policies. This allows you to assign different managed content settings for a particular default folder type for different sets of users. @@ -138,7 +144,6 @@ The default folder types that you can specify are: Type: DefaultManagedFolderType Parameter Sets: ManagedDefaultFolder Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -148,6 +153,9 @@ Accept wildcard characters: False ``` ### -FolderName + +> Applicable: Exchange Server 2010 + The FolderName parameter specifies the folder name as it appears in users' mailboxes. The folder name can have up to 255 characters. You can't set the FolderName parameter for managed default folders, such as Inbox. The FolderName parameter shouldn't be confused with the Name parameter. @@ -156,7 +164,6 @@ The FolderName parameter shouldn't be confused with the Name parameter. Type: String Parameter Sets: ManagedCustomFolder Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -166,13 +173,15 @@ Accept wildcard characters: False ``` ### -BaseFolderOnly + +> Applicable: Exchange Server 2010 + The BaseFolderOnly parameter specifies whether the managed content settings should be applied only to the managed folder or to the folder and all its subfolders. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -182,13 +191,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010 + The Comment parameter specifies the default administrator comment to be displayed with the folder in Microsoft Office Outlook 2007 and Microsoft Office Outlook Web App. The comment can have up to 255 characters, including spaces. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -198,6 +209,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -207,7 +221,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -217,13 +230,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -233,13 +248,15 @@ Accept wildcard characters: False ``` ### -LocalizedComment + +> Applicable: Exchange Server 2010 + The LocalizedComment parameter specifies localized administrator comments and their languages. When the language setting of Outlook 2007 matches one of the locales specified in this parameter, the corresponding localized comment is displayed. Comments must be in the form ISOLanguageCode:Comment (for example, -LocalizedComment EN-US:"This is a localized comment in U.S. English"). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -249,13 +266,15 @@ Accept wildcard characters: False ``` ### -LocalizedFolderName + +> Applicable: Exchange Server 2010 + The LocalizedFolderName parameter specifies the localized folder names and their languages. When the language setting of Outlook 2007 matches one of the locales specified in this parameter, the corresponding localized folder name is displayed. Folder names must be in the form ISOLanguageCode:FolderName (for example, -LocalizedFolderName EN-US:"Business Critical"). ```yaml Type: MultiValuedProperty Parameter Sets: ManagedCustomFolder Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -265,13 +284,15 @@ Accept wildcard characters: False ``` ### -MustDisplayCommentEnabled + +> Applicable: Exchange Server 2010 + The MustDisplayCommentEnabled parameter specifies whether to set a flag used by Outlook 2007 to prevent users from minimizing a folder comment (that's visible in Outlook 2007 and Outlook Web App). If the MustDisplayCommentEnabled parameter is present and set to $true, the parameter sets a flag used by Outlook 2007 to prevent users from minimizing a folder comment. If the parameter isn't present or is set to $false, users can minimize the comment. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -281,13 +302,15 @@ Accept wildcard characters: False ``` ### -StorageQuota -The StorageQuota parameter specifies the storage size limit for the mailbox folder. When the folder size exceeds this limit, no additional items may be added. Storage size limits can be specified in kilobytes (KB) or megabytes (MB), for example, 100 KB or 5 MB. + +> Applicable: Exchange Server 2010 + +The StorageQuota parameter specifies the storage size limit for the mailbox folder. When the folder size exceeds this limit, no additional items might be added. Storage size limits can be specified in kilobytes (KB) or megabytes (MB), for example, 100 KB or 5 MB. ```yaml Type: Unlimited Parameter Sets: ManagedCustomFolder Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -297,13 +320,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagedFolderMailboxPolicy.md similarity index 87% rename from exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagedFolderMailboxPolicy.md index 0a4c872b09..5a615b5bc8 100644 --- a/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagedFolderMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managedfoldermailboxpolicy applicable: Exchange Server 2010 -title: New-ManagedFolderMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managedfoldermailboxpolicy +schema: 2.0.0 +title: New-ManagedFolderMailboxPolicy --- # New-ManagedFolderMailboxPolicy @@ -32,7 +33,7 @@ New-ManagedFolderMailboxPolicy [-Name] ## DESCRIPTION Managed folder mailbox policies are applied to user mailboxes to control message retention settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). Managed custom folders are a premium feature of messaging records management (MRM). Mailboxes with policies that include managed custom folders require an Exchange Server Enterprise client access license (CAL). @@ -48,13 +49,15 @@ This example creates the managed folder mailbox policy My Managed Folder Mailbox ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the name of the new managed folder mailbox policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -ManagedFolderLinks + +> Applicable: Exchange Server 2010 + The ManagedFolderLinks parameter specifies the list of managed folders to which the managed folder mailbox policy is to be linked. ```yaml Type: ELCFolderIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagementRole.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagementRole.md similarity index 81% rename from exchange/exchange-ps/exchange/New-ManagementRole.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagementRole.md index 84f1b34a67..8384bfbed8 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagementRole.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managementrole -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-ManagementRole -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managementrole +schema: 2.0.0 +title: New-ManagementRole --- # New-ManagementRole ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-ManagementRole cmdlet to create a management role based on an existing role or create an unscoped management role. @@ -47,7 +48,7 @@ New-ManagementRole [-Name] ## DESCRIPTION You can either create a management role based on an existing role, or you can create an unscoped role that's empty. If you create a role based on an existing role, you start with the management role entries that exist on the existing role. You can then remove entries to customize the role. If you create an unscoped role, the role can contain custom scripts or cmdlets that aren't part of Exchange. -An unscoped role doesn't have any scope restrictions applied. Scripts or third-party cmdlets included in an unscoped role can view or modify any object in the Exchange organization. +An unscoped role doesn't have any scope restrictions applied. Scripts or non-Microsoft cmdlets included in an unscoped role can view or modify any object in the Exchange organization. The ability to create an unscoped management role isn't granted by default. To create an unscoped management role, you must assign the management role named Unscoped Role Management to a role group you're a member of. For more information about how to create an unscoped management role, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). @@ -55,7 +56,7 @@ After you create a role, you can change the management role entries on the role For more information about management roles, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,18 +81,20 @@ For more information about pipelining and the Where cmdlet, see the following to New-ManagementRole -Name "In-house scripts" -UnScopedTopLevel ``` -In on-premises Exchange, this example creates the unscoped management role In-house scripts. Note that the UnScopedTopLevel switch requires the Unscoped Role Management role, which isn't assigned to any role group by default. +In on-premises Exchange, this example creates the unscoped management role In-house scripts. The UnScopedTopLevel switch requires the Unscoped Role Management role, which isn't assigned to any role group by default. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the role. The maximum length of the name is 64 characters. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -101,13 +104,15 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Parent parameter specifies the identity of the role to copy. If the name of the role contains spaces, enclose the name in quotation marks ("). If you specify the Parent parameter, you can't use the UnScopedTopLevel switch. ```yaml Type: RoleIdParameter Parameter Sets: NewDerivedRole Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -131,7 +139,6 @@ You can't use this switch with the Parent parameter. Type: SwitchParameter Parameter Sets: UnScopedTopLevelRole Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -150,7 +160,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -160,13 +169,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Description parameter specifies the description that's displayed when the management role is viewed using the Get-ManagementRole cmdlet. Enclose the description in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -184,7 +198,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -EnabledCmdlets + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EnabledCmdlets parameter specifies the cmdlets that are copied from the parent role. You can specify multiple values separated by commas. You can only use this parameter with the Parent parameter when you copy a role. @@ -202,7 +218,6 @@ You can only use this parameter with the Parent parameter when you copy a role. Type: String[] Parameter Sets: NewDerivedRole Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -222,7 +240,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -232,13 +249,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagementRoleAssignment.md similarity index 85% rename from exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagementRoleAssignment.md index 9cd0581b13..6ba6506e29 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagementRoleAssignment.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managementroleassignment -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-ManagementRoleAssignment -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managementroleassignment +schema: 2.0.0 +title: New-ManagementRoleAssignment --- # New-ManagementRoleAssignment ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-ManagementRoleAssignment cmdlet to assign a management role to a management role group, management role assignment policy, user, or universal security group (USG). @@ -117,7 +118,7 @@ You can create custom management scopes using the New-ManagementScope cmdlet and For more information about management role assignments, see [Understanding management role assignments](https://learn.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -137,7 +138,7 @@ New-ManagementRoleAssignment -Role "MyVoiceMail" -Policy "Sales end-users" This example assigns the MyVoiceMail role to the "Sales end-users" role assignment policy. First, the IsEndUserRole property on the MyVoiceMail role is verified to be sure it's set to $true, indicating it's an end-user role. -After the role has been verified to be an end-user role, the role is assigned to the "Sales end-users" role assignment policy. +After the role is verified to be an end-user role, the role is assigned to the "Sales end-users" role assignment policy. ### Example 3 ```powershell @@ -177,13 +178,15 @@ This example assigns the Mail Recipients role to the Contoso Sub - Seattle role ## PARAMETERS ### -Name -The Name parameter specifies a name for the new management role assignment. The maximum length of the name is 64 characters. If the management role assignment name contains spaces, enclose the name in quotation marks ("). If you don't specify a name, one will be created automatically. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + +The Name parameter specifies a name for the new management role assignment. The maximum length of the name is 64 characters. If the management role assignment name contains spaces, enclose the name in quotation marks ("). If you don't specify a name, a name is created automatically. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -193,6 +196,9 @@ Accept wildcard characters: False ``` ### -App + +> Applicable: Exchange Online, Exchange Online Protection + 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). @@ -205,7 +211,6 @@ You can't use this parameter with the SecurityGroup, Policy, or User cmdlets. Type: ServicePrincipalIdParameter Parameter Sets: App Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -215,6 +220,9 @@ Accept wildcard characters: False ``` ### -Computer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Computer parameter specifies the name of the computer to assign the management role to. @@ -225,7 +233,6 @@ You can't use this parameter with the SecurityGroup, User, or Policy parameters. Type: ComputerIdParameter Parameter Sets: Computer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -235,6 +242,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Policy parameter specifies the name of the management role assignment policy to assign the management role to. If the value contains spaces, enclose the value in quotation marks ("). The IsEndUserRole property of the role you specify using the Role parameter must be set to $true. @@ -245,7 +255,6 @@ You can't use this parameter with the App, SecurityGroup, Computer, or User para Type: MailboxPolicyIdParameter Parameter Sets: Policy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -255,6 +264,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Role parameter specifies the existing role to assign. You can use any value that uniquely identifies the role. For example: - Name @@ -269,7 +281,6 @@ If you use the App parameter, you can't specify admin or user roles; you can onl Type: RoleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -279,6 +290,9 @@ Accept wildcard characters: False ``` ### -SecurityGroup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SecurityGroup parameter specifies the name of the management role group or mail-enabled universal security group to assign the management role to. If the value contains spaces, enclose the value in quotation marks ("). You can't use this parameter with the App, Policy, Computer, or User parameters. @@ -287,7 +301,6 @@ You can't use this parameter with the App, Policy, Computer, or User parameters. Type: SecurityGroupIdParameter Parameter Sets: SecurityGroup Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -297,6 +310,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The User parameter specifies the user to assign the management role to. For the best results, we recommend using the following values: @@ -310,7 +326,6 @@ You can't use this parameter with the App, SecurityGroup, Computer, or Policy pa Type: UserIdParameter Parameter Sets: User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -320,6 +335,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -329,7 +347,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -339,6 +356,9 @@ Accept wildcard characters: False ``` ### -CustomConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CustomConfigWriteScope parameter specifies the existing configuration scope to associate with this management role assignment. If you use the CustomConfigWriteScope parameter you can't use the ExclusiveConfigWriteScope parameter. If the management scope name contains spaces, enclose the name in quotation marks ("). @@ -347,7 +367,6 @@ The CustomConfigWriteScope parameter specifies the existing configuration scope Type: ManagementScopeIdParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,13 +376,15 @@ Accept wildcard characters: False ``` ### -CustomRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomRecipientWriteScope parameter specifies the existing recipient-based management scope to associate with this management role assignment. If the management scope name contains spaces, enclose the name in quotation marks ("). If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope or ExclusiveRecipientWriteScope parameters. ```yaml Type: ManagementScopeIdParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -373,6 +394,9 @@ Accept wildcard characters: False ``` ### -CustomResourceScope + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The CustomResourceScope parameter specifies the custom management scope to associate with this management role assignment. You can use any value that uniquely identifies the management scope. For example: @@ -389,7 +413,6 @@ You use this parameter with the App parameter to assign permissions to service p Type: ManagementScopeIdParameter Parameter Sets: App Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -399,13 +422,15 @@ Accept wildcard characters: False ``` ### -Delegating + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Delegating switch specifies whether the user or USG assigned to the role can delegate the role to other users or groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: SecurityGroup, User, App Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -415,6 +440,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -423,7 +451,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +460,9 @@ Accept wildcard characters: False ``` ### -ExclusiveConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ExclusiveConfigWriteScope parameter specifies the exclusive configuration-based management scope to associate with the new role assignment. If you use the ExclusiveConfigWriteScope parameter, you can't use the CustomConfigWriteScope parameter. If the scope name contains spaces, enclose the name in quotation marks ("). @@ -441,7 +471,6 @@ The ExclusiveConfigWriteScope parameter specifies the exclusive configuration-ba Type: ManagementScopeIdParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -451,13 +480,15 @@ Accept wildcard characters: False ``` ### -ExclusiveRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExclusiveRecipientWriteScope parameter specifies the exclusive recipient-based management scope to associate with the new role assignment. If you use the ExclusiveRecipientWriteScope parameter, you can't use the CustomRecipientWriteScope or RecipientOrganizationalUnitScope parameters. If the scope name contains spaces, enclose the name in quotation marks ("). ```yaml Type: ManagementScopeIdParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -467,6 +498,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -477,7 +511,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -487,6 +520,9 @@ Accept wildcard characters: False ``` ### -RecipientAdministrativeUnitScope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the new role assignment to. @@ -497,7 +533,6 @@ Administrative units are Microsoft Entra containers of resources. You can view t Type: AdministrativeUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -507,6 +542,9 @@ Accept wildcard characters: False ``` ### -RecipientGroupScope + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecipientGroupScope parameter specifies a group to consider for scoping the role assignment. Individual members of the specified group (not nested groups) are considered as in scope for the assignment. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, or DisplayName. @@ -515,7 +553,6 @@ The RecipientGroupScope parameter specifies a group to consider for scoping the Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -525,13 +562,15 @@ Accept wildcard characters: False ``` ### -RecipientOrganizationalUnitScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope or ExclusiveRecipientWriteScope parameters. To specify an OU, use the syntax: domain/ou. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -541,6 +580,9 @@ Accept wildcard characters: False ``` ### -RecipientRelativeWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientRelativeWriteScope parameter specifies the type of restriction to apply to a recipient scope. The available types are None, Organization, MyGAL, Self, and MyDistributionGroups. The RecipientRelativeWriteScope parameter is automatically set when the CustomRecipientWriteScope or RecipientOrganizationalUnitScope parameters are used. Even though the NotApplicable, OU, MyDirectReports, CustomRecipientScope, MyExecutive, MailboxICanDelegate and ExclusiveRecipientScope values appear in the syntax block for this parameter, they can't be used directly on the command line. They are used internally by the cmdlet. @@ -549,7 +591,6 @@ Even though the NotApplicable, OU, MyDirectReports, CustomRecipientScope, MyExec Type: RecipientWriteScopeType Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -559,6 +600,9 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -571,7 +615,6 @@ Unscoped top-level management roles can only contain custom scripts or non-Excha Type: SwitchParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -581,13 +624,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagementScope.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagementScope.md similarity index 87% rename from exchange/exchange-ps/exchange/New-ManagementScope.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagementScope.md index 30292ebbdd..3fea608e67 100644 --- a/exchange/exchange-ps/exchange/New-ManagementScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagementScope.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managementscope -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-ManagementScope -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managementscope +schema: 2.0.0 +title: New-ManagementScope --- # New-ManagementScope ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-ManagementScope cmdlet to create a regular or exclusive management scope. @@ -81,7 +82,7 @@ After you create a regular or exclusive scope, you need to associate the scope w For more information about regular and exclusive scopes, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -127,13 +128,15 @@ This example creates the Seattle Databases scope and sets a database restriction ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the management scope. The name can be up to 64 characters. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -143,6 +146,9 @@ Accept wildcard characters: False ``` ### -DatabaseList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DatabaseList parameter specifies a list of databases to which the scope should be applied. You can use any value that uniquely identifies the database. For example: @@ -159,7 +165,6 @@ You can't use this parameter with the DatabaseRestrictionFilter, ServerList, Rec Type: DatabaseIdParameter[] Parameter Sets: DatabaseList Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -169,6 +174,9 @@ Accept wildcard characters: False ``` ### -DatabaseRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DatabaseRestrictionFilter parameter uses OPATH filter syntax to specify the databases that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. @@ -188,7 +196,6 @@ You can't use this parameter with the RecipientRestrictionFilter, ServerRestrict Type: String Parameter Sets: DatabaseFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -198,6 +205,9 @@ Accept wildcard characters: False ``` ### -RecipientRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientRestrictionFilter parameter uses OPATH filter syntax to specify the recipients that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -215,7 +225,6 @@ You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, S Type: String Parameter Sets: RecipientFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -225,6 +234,9 @@ Accept wildcard characters: False ``` ### -ServerList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ServerList parameter specifies a list of servers to which the scope should be applied. You can use any value that uniquely identifies the server. For example: @@ -242,7 +254,6 @@ You can't use this parameter with the RecipientRestrictionFilter, RecipientRoot, Type: ServerIdParameter[] Parameter Sets: ServerList Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -252,6 +263,9 @@ Accept wildcard characters: False ``` ### -ServerRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ServerRestrictionFilter parameter uses OPATH filter syntax to specify the servers that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. @@ -271,7 +285,6 @@ You can't use this parameter wit the RecipientRestrictionFilter, RecipientRoot, Type: String Parameter Sets: ServerFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -281,6 +294,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -290,7 +306,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -300,6 +315,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -308,7 +326,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -318,6 +335,9 @@ Accept wildcard characters: False ``` ### -Exclusive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Exclusive switch specifies that the role should be an exclusive scope. You don't need to specify a value with this switch. When you create exclusive management scopes, only users or universal security groups (USG) assigned exclusive scopes that contain objects to be modified can access those objects. Users or USGs that aren't assigned an exclusive scope that contains the objects immediately lose access to those objects. @@ -326,7 +346,6 @@ When you create exclusive management scopes, only users or universal security gr Type: SwitchParameter Parameter Sets: DatabaseList, DatabaseFilter, RecipientFilter, ServerList, ServerFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -336,6 +355,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to create an exclusive scope without showing the warning that the exclusive scope takes effect immediately. @@ -344,7 +366,6 @@ Use this switch to create an exclusive scope without showing the warning that th Type: SwitchParameter Parameter Sets: DatabaseList, DatabaseFilter, RecipientFilter, ServerList, ServerFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -354,6 +375,9 @@ Accept wildcard characters: False ``` ### -RecipientRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 @@ -367,7 +391,6 @@ You can't use this parameter with the ServerRestrictionFilter or DatabaseRestric Type: OrganizationalUnitIdParameter Parameter Sets: RecipientFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -377,13 +400,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -406,5 +431,6 @@ To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Ty To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES +Use two-letter country codes (ISO 3166-1 alpha-2) instead of the full country name in filters. For example, use `-RecipientRestrictionFilter "UsageLocation -eq 'FR'"` for France. ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-MapiVirtualDirectory.md similarity index 84% rename from exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-MapiVirtualDirectory.md index 54765cae91..63de2bf232 100644 --- a/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MapiVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mapivirtualdirectory -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MapiVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mapivirtualdirectory +schema: 2.0.0 +title: New-MapiVirtualDirectory --- # New-MapiVirtualDirectory @@ -38,7 +39,7 @@ New-MapiVirtualDirectory ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example creates a new MAPI virtual directory that has the following configu ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -64,7 +68,6 @@ 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 Required: False Position: Named @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,19 +95,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,16 +119,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,10 +140,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -143,7 +155,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,6 +164,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. This parameter uses the syntax: `https:///mapi`. For example, `https://external.contoso.com/mapi`. @@ -163,7 +177,6 @@ When you use the InternalUrl or ExternalUrl parameters, you need to specify one Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +186,9 @@ Accept wildcard characters: False ``` ### -IISAuthenticationMethods + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IISAuthenticationMethods parameter specifies the authentication methods that are enabled on the virtual directory in Internet Information Services (IIS). Valid values for this parameter are: - Basic @@ -190,7 +206,6 @@ For more information about the different authentication methods, see [Understand Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. This parameter uses the syntax: `https:///mapi`. For example, `https://internal.contoso.com/mapi`. @@ -210,7 +228,6 @@ When you use the InternalUrl or ExternalUrl parameters, you need to specify one Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,6 +237,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The Role parameter species the configuration for the virtual directory. Valid values are: @@ -233,7 +253,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -254,7 +276,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +285,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +303,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MessageClassification.md b/exchange/exchange-ps/ExchangePowerShell/New-MessageClassification.md similarity index 80% rename from exchange/exchange-ps/exchange/New-MessageClassification.md rename to exchange/exchange-ps/ExchangePowerShell/New-MessageClassification.md index 2692993652..552bd2da44 100644 --- a/exchange/exchange-ps/exchange/New-MessageClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MessageClassification.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-messageclassification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MessageClassification -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-messageclassification +schema: 2.0.0 +title: New-MessageClassification --- # New-MessageClassification ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MessageClassification cmdlet to create a message classification instance in your organization. @@ -49,7 +50,7 @@ After you create a new message classification, you can specify the message class When you create a message classification, it has no locale. By default, the new message classification is used for all locales. After a default message classification is defined, you can add new locales of the classification by running the New-MessageClassification cmdlet and by specifying the default message classification identity that you want to localize. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,13 +74,15 @@ In on-premises Exchange, this example creates a locale-specific (Spanish - Spain ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name for the message classification. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DisplayName parameter specifies the title of the message classification that's displayed in Outlook and selected by users. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). The message classification XML file must be present on the sender's computer for the display name to be displayed. @@ -97,7 +103,6 @@ The message classification XML file must be present on the sender's computer for Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional on in on-premises Exchange. The Locale parameter specifies a locale-specific version of an existing message classification. You use the -Name parameter to identify the existing message classification, and the SenderDescription parameter to specify the descriptive text in another language. @@ -117,7 +125,6 @@ A valid value for this parameter is a supported culture code value from the Micr Type: CultureInfo Parameter Sets: Localized Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -127,13 +134,15 @@ Accept wildcard characters: False ``` ### -SenderDescription + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SenderDescription parameter specifies the detailed text that's shown to Outlook senders when they select a message classification to apply to a message before they send the message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -ClassificationID + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ClassificationID parameter specifies the classification ID (GUID) of an existing message classification that you want to import and use in your Exchange organization. Use this parameter if you're configuring message classifications that span two Exchange forests in the same organization. To find the ClassificationID value of the message classification, replace `` with the name of the message classification and run the following command: `Get-MessageClassification -Identity ""`. @@ -151,7 +163,6 @@ To find the ClassificationID value of the message classification, replace ` Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -170,7 +184,6 @@ 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 Required: False Position: Named @@ -180,25 +193,27 @@ Accept wildcard characters: False ``` ### -DisplayPrecedence -The DisplayPrecedence parameter specifies the relative precedence of the message classification to other message classifications that may be applied to a specified message. Valid values are: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The DisplayPrecedence parameter specifies the relative precedence of the message classification to other message classifications that might be applied to a specified message. Valid values are: - Highest - Higher - High - MediumHigh -- Medium (This is the default value) +- Medium (default value) - MediumLow - Low - Lower - Lowest -Although Outlook only lets a user specify a single classification for a message, transport rules may apply other classifications to a message. The classification with the highest precedence is shown first and the subsequent classifications, which are those with lesser precedence as defined by this parameter, are appended in the appropriate order thereafter. +Although Outlook only lets a user specify a single classification for a message, transport rules might apply other classifications to a message. The classification with the highest precedence is shown first and the subsequent classifications, which are those with lesser precedence as defined by this parameter, are appended in the appropriate order thereafter. ```yaml Type: ClassificationDisplayPrecedenceLevel Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,6 +223,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -218,7 +236,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,16 +245,18 @@ Accept wildcard characters: False ``` ### -PermissionMenuVisible + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PermissionMenuVisible parameter specifies whether the values that you entered for the DisplayName and RecipientDescription parameters are displayed in Outlook as the user composes a message. Valid values are: -- $true: Users can assign the message classification to messages before they're sent, and the classification information is displayed. This is the default value. +- $true: Users can assign the message classification to messages before they're sent, and the classification information is displayed. This value is the default. - $false: Users can't assign the message classification to messages before they're sent, However, messages received with this message classification still display the classification information. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,6 +266,9 @@ Accept wildcard characters: False ``` ### -RecipientDescription + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientDescription parameter specifies the detailed text that's shown to Outlook recipient when they receive a message that has the message classification applied. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use this parameter, the value of the SenderDescription parameter is used. @@ -255,7 +277,6 @@ If you don't use this parameter, the value of the SenderDescription parameter is Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -RetainClassificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetainClassificationEnabled parameter specifies whether the message classification should persist with the message if the message is forwarded or replied to. The default value is $true. @@ -273,7 +297,6 @@ The default value is $true. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -283,13 +306,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/New-MigrationBatch.md similarity index 87% rename from exchange/exchange-ps/exchange/New-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/New-MigrationBatch.md index f0c57ea06f..c7ee0db4cd 100644 --- a/exchange/exchange-ps/exchange/New-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MigrationBatch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-migrationbatch -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MigrationBatch -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-migrationbatch +schema: 2.0.0 +title: New-MigrationBatch --- # New-MigrationBatch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MigrationBatch cmdlet to submit a new migration request for a batch of users. @@ -55,6 +56,7 @@ New-MigrationBatch -Name -CSVData [-Analyze] [-NotificationEmails ] [-Partition ] [-ReportInterval ] + [-SkipDetails] [-SkipReports] [-SourceEndpoint ] [-StartAfter ] @@ -245,6 +247,7 @@ New-MigrationBatch -Name [-CSVData ] [-DisallowExistingUsers] [ [-Confirm] [-ContentFilter ] [-ContentFilterLanguage ] + [-DataFusion] [-DomainController ] [-ExcludeDumpsters] [-ExcludeFolders ] @@ -451,12 +454,12 @@ Onboarding and offboarding in Exchange Online Both onboarding and offboarding remote move migrations are initiated from your Exchange Online organization. -- Cutover Exchange migration: This is another type of onboarding migration and is used to migrate all mailboxes in an on-premises Exchange organization to Exchange Online. You can migrate a maximum of 1,000 Exchange Server 2003, Exchange Server 2007, or Exchange Server 2010 mailboxes using a cutover migration. Mailboxes will be automatically provisioned in Exchange Online when you perform a cutover Exchange migration. For more information, see Example 5. +- Cutover Exchange migration: This is another type of onboarding migration and is used to migrate all mailboxes in an on-premises Exchange organization to Exchange Online. You can migrate a maximum of 1,000 Exchange Server 2003, Exchange Server 2007, or Exchange Server 2010 mailboxes using a cutover migration. Mailboxes are automatically provisioned in Exchange Online when you perform a cutover Exchange migration. For more information, see Example 5. - Staged Exchange migration: You can also migrate a subset of mailboxes from an on-premises Exchange organization to Exchange Online. This is another type of onboarding migration. Migrating mailboxes from Exchange 2010 or later versions of Exchange isn't supported using a staged migration. Prior to running a staged migration, you have to use directory synchronization or some other method to provision mail users in your Exchange Online organization. For more information, see Example 6. - IMAP migration: This onboarding migration type migrates mailbox data from an IMAP server (including Exchange) to Exchange Online. For an IMAP migration, you must first provision mailboxes in Exchange Online before you can migrate mailbox data. For more information, see Example 7. - Google Workspace (formerly G Suite) migration: This onboarding migration type migrates mailbox data from a Google Workspace organization to Exchange Online. For a Google Workspace migration, you must first provision mail users (or mailboxes) in Exchange Online before you can migrate mailbox data. For more information, see Example 10. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -467,7 +470,7 @@ New-MigrationBatch -Local -Name LocalMove1 -CSVData ([System.IO.File]::ReadAllBy Start-MigrationBatch -Identity LocalMove1 ``` -This example creates a migration batch for a local move, where the mailboxes in the specified CSV file are moved to a different mailbox database. This CSV file contains a single column with the email address for the mailboxes that will be moved. The header for this column must be named EmailAddress. The migration batch in this example must be started manually by using the Start-MigrationBatch cmdlet or the Exchange admin center. Alternatively, you can use the AutoStart parameter to start the migration batch automatically. +This example creates a migration batch for a local move, where the mailboxes in the specified CSV file are moved to a different mailbox database. This CSV file contains a single column with the email address for the mailboxes to be moved. The header for this column must be named EmailAddress. The migration batch in this example must be started manually by using the Start-MigrationBatch cmdlet or the Exchange admin center. Alternatively, you can use the AutoStart parameter to start the migration batch automatically. ### Example 2 ```powershell @@ -480,7 +483,7 @@ $CrossForestBatch = New-MigrationBatch -Name CrossForestBatch1 -SourceEndpoint $ Start-MigrationBatch -Identity $CrossForestBatch.Identity ``` -This example creates a migration batch for a cross-forest enterprise move, where the mailboxes for the mail users specified in the CSV file are moved to a different forest. A new migration endpoint is created, which identifies the domain where the mailboxes are currently located. The endpoint is used to create the migration batch. Then the migration batch is started with the Start-MigrationBatch cmdlet. Note that cross-forest moves are initiated from the target forest, which is the forest that you want to move the mailboxes to. +This example creates a migration batch for a cross-forest enterprise move, where the mailboxes for the mail users specified in the CSV file are moved to a different forest. A new migration endpoint is created, which identifies the domain where the mailboxes are currently located. The endpoint is used to create the migration batch. Then the migration batch is started with the Start-MigrationBatch cmdlet. Cross-forest moves are initiated from the target forest, which is the forest that you want to move the mailboxes to. ### Example 3 ```powershell @@ -493,7 +496,7 @@ $OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $M Start-MigrationBatch -Identity $OnboardingBatch.Identity.Name ``` -This example creates a migration batch for an onboarding remote move migration from an on-premises Exchange organization to Exchange Online. The syntax is similar to that of a cross-forest move, but it's initiated from the Exchange Online organization. A new migration endpoint is created, which points to the on-premises organization as the source location of the mailboxes that will be migrated. This endpoint is used to create the migration batch. Then the migration batch is started with the Start-MigrationBatch cmdlet. +This example creates a migration batch for an onboarding remote move migration from an on-premises Exchange organization to Exchange Online. The syntax is similar to that of a cross-forest move, but it's initiated from the Exchange Online organization. A new migration endpoint is created, which points to the on-premises organization as the source location of the mailboxes to be migrated. This endpoint is used to create the migration batch. Then the migration batch is started with the Start-MigrationBatch cmdlet. ### Example 4 ```powershell @@ -552,7 +555,7 @@ $OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $M Start-MigrationBatch -Identity $OnboardingBatch.Identity ``` -This example is the same as Example 3, but the CompleteAfter parameter is also used. Data migration for the batch will start, but won't complete until 09/01/2018 7:00 PM (UTC). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Coordinated Universal Time. +This example is the same as Example 3, but the CompleteAfter parameter is also used. Data migration for the batch starts but doesn't complete until 09/01/2018 7:00 PM (UTC). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Coordinated Universal Time. ### Example 9 ```powershell @@ -565,7 +568,7 @@ $OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $M Start-MigrationBatch -Identity $OnboardingBatch.Identity ``` -This example is the same as Example 8, but the TimeZone parameter is also used. Data migration for the batch will start, but won't complete until 09/01/2018 7:00 PM (PST). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Pacific Standard Time. +This example is the same as Example 8, but the TimeZone parameter is also used. Data migration for the batch starts but doesn't complete until 09/01/2018 7:00 PM (PST). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Pacific Standard Time. ### Example 10 ```powershell @@ -583,6 +586,9 @@ A Google Workspace migration batch is created that uses the CSV migration file g ## PARAMETERS ### -UserIds + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UserIds parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify a user by email address or by their Guid property value from the Get-MigrationUser cmdlet. You can specify multiple users separated by commas. The users that you specify for this parameter must be defined in an existing migration batch. @@ -593,7 +599,6 @@ To disable the migration of the users in the original migration batch, use the D Type: MultiValuedProperty Parameter Sets: PreexistingUserIds Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -603,6 +608,9 @@ Accept wildcard characters: False ``` ### -Users + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Users parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify the users by using the Get-MigrationUser cmdlet. For example: $Failed = Get-MigrationUser -Status Failed @@ -617,7 +625,6 @@ To disable the migration of the users in the original migration batch, use the D Type: MultiValuedProperty Parameter Sets: Preexisting, PreexistingUsers Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -627,6 +634,9 @@ Accept wildcard characters: False ``` ### -Analyze + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Analyze Description }} @@ -635,7 +645,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Analysis Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -645,6 +654,9 @@ Accept wildcard characters: False ``` ### -ManagedGmailTeams + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ManagedGmailTeams Description }} @@ -653,7 +665,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ManagedGmailTeams Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -663,13 +674,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -679,17 +692,19 @@ Accept wildcard characters: False ``` ### -CSVData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see [CSV files for mailbox migration](https://learn.microsoft.com/exchange/csv-files-for-mailbox-migration-exchange-2013-help). A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). -**Note**: This parameter doesn't validate the availability of the mailboxes based on RBAC scope. All mailboxes that are specified in the CSV file will be migrated, even if they are outside of the RBAC scope (for example, an OU) that gives the admin permissions to migrate mailboxes. +**Note**: This parameter doesn't validate the availability of the mailboxes based on RBAC scope. All mailboxes specified in the CSV file will be migrated, even if they are outside of the RBAC scope (for example, an OU) that gives the admin permissions to migrate mailboxes. ```yaml Type: Byte[] -Parameter Sets: Abch, Analysis, FolderMove, Local, LocalPublicFolder, Offboarding, XO1, PublicFolderToUnifiedGroup, GoogleResourceOnboarding, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery +Parameter Sets: Abch, Analysis, FolderMove, Local, LocalPublicFolder, Offboarding, XO1, PublicFolderToUnifiedGroup, GoogleResourceOnboarding, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery, Onboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -698,20 +713,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Byte[] -Parameter Sets: Onboarding -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Local -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Local This parameter is available only in on-premises Exchange. The Local switch specifies a local move (mailboxes are moved to a different mailbox database in the same Active Directory forest). You don't need to specify a value with this switch. @@ -720,7 +725,6 @@ The Local switch specifies a local move (mailboxes are moved to a different mail Type: SwitchParameter Parameter Sets: Local Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -730,6 +734,9 @@ Accept wildcard characters: False ``` ### -SourcePublicFolderDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SourcePublicFolderDatabase parameter specifies the source public folder database that's used in a public folder migration. You can use any value that uniquely identifies the database. For example: @@ -742,7 +749,6 @@ The SourcePublicFolderDatabase parameter specifies the source public folder data Type: DatabaseIdParameter Parameter Sets: LocalPublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -752,6 +758,9 @@ Accept wildcard characters: False ``` ### -AdoptPreexisting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AdoptPreexisting Description }} @@ -760,7 +769,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding, Local, Offboarding, GoogleResourceOnboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -770,18 +778,20 @@ Accept wildcard characters: False ``` ### -AllowIncrementalSyncs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AllowIncrementalSyncs parameter specifies whether to enable or disable incremental synchronization. Valid values are: -- $true: Incremental synchronization is enabled. Any new messages that are sent to the source mailbox are copied to the corresponding target mailbox once every 24 hours. This is the default value. -- $false: Incremental synchronization is disabled. The migration batch will go into the Stopped state after the initial synchronization is complete. To complete a migration batch for local moves, cross-forest moves, or remote move migrations, you need to enable incremental synchronization by using the Set-MigrationBatch cmdlet. +- $true: Incremental synchronization is enabled. Any new messages that are sent to the source mailbox are copied to the corresponding target mailbox once every 24 hours. This value is the default. +- $false: Incremental synchronization is disabled. The migration batch goes into the Stopped state after the initial synchronization is complete. To complete a migration batch for local moves, cross-forest moves, or remote move migrations, you need to enable incremental synchronization by using the Set-MigrationBatch cmdlet. ```yaml Type: Boolean Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -791,16 +801,18 @@ Accept wildcard characters: False ``` ### -AllowUnknownColumnsInCsv + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowUnknownColumnsInCsv parameter specifies whether to allow extra columns in the CSV file that aren't used by migration. Valid values are: - $true: The migration ignores (silently skips) unknown columns in the CSV file (including optional columns with misspelled column headers). All unknown columns are treated like extra columns that aren't used by migration. -- $false: The migration fails if there are any unknown columns in the CSV file.This setting protects against spelling errors in column headers. This is the default value. +- $false: The migration fails if there are any unknown columns in the CSV file.This setting protects against spelling errors in column headers. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -810,6 +822,9 @@ Accept wildcard characters: False ``` ### -ArchiveDomain + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ArchiveDomain Description }} @@ -818,7 +833,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: Onboarding, Offboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -828,6 +842,9 @@ Accept wildcard characters: False ``` ### -ArchiveOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ArchiveOnly switch specifies that only archive mailboxes are migrated for the users in the migration batch (primary mailboxes aren't migrated). You don't need to specify a value with this switch. You can only use this switch for local moves and remote move migrations. @@ -838,7 +855,6 @@ You can use the TargetArchiveDatabases parameter to specify the database to migr Type: SwitchParameter Parameter Sets: Local, Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -848,6 +864,9 @@ Accept wildcard characters: False ``` ### -AutoComplete + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AutoComplete switch forces the finalization of the individual mailboxes as soon as the mailbox has completed initial synchronization. You don't need to specify a value with this switch. You can only use this switch for local moves and remote move migrations. @@ -858,7 +877,6 @@ If you don't use this switch, you need to run the Complete-MigrationBatch cmdlet Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -868,6 +886,9 @@ Accept wildcard characters: False ``` ### -AutoProvisioning + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AutoProvisioning Description }} @@ -876,7 +897,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -886,6 +906,9 @@ Accept wildcard characters: False ``` ### -AutoRetryCount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AutoRetryCount parameter specifies the number of attempts to restart the migration batch to migrate mailboxes that encountered errors. @@ -894,7 +917,6 @@ The AutoRetryCount parameter specifies the number of attempts to restart the mig Type: Int32 Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -904,6 +926,9 @@ Accept wildcard characters: False ``` ### -AutoStart + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AutoStart switch immediately starts the processing of the new migration batch. You don't need to specify a value with this switch. If you don't use this switch, you need to manually start the migration batch by using the Start-MigrationBatch cmdlet. @@ -912,7 +937,6 @@ If you don't use this switch, you need to manually start the migration batch by Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -922,6 +946,9 @@ Accept wildcard characters: False ``` ### -AvoidMergeOverlap + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AvoidMergeOverlap Description }} @@ -930,7 +957,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -940,17 +966,19 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the migration request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the migration request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the migration request again. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if neither the BadItemLimit or LargeItemLimit parameters are specified, the migration will use Skipped Item approval semantics instead of BadItemLimit semantics. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if neither the BadItemLimit or LargeItemLimit parameters are specified, the migration uses Skipped Item approval semantics instead of BadItemLimit semantics. ```yaml Type: Unlimited Parameter Sets: Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, FolderMove Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -960,22 +988,24 @@ Accept wildcard characters: False ``` ### -CompleteAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. +The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch starts, but completion doesn'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". 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: - Specify the date/time value in UTC: For example, `"7/30/2020 9:00PM Z"`. -- Specify the date/time value in your local time zone: For example, `"7/30/2020 9:00PM -700"`. The value will be converted to UTC if you don't use the TimeZone parameter. +- Specify the date/time value in your local time zone: For example, `"7/30/2020 9:00PM -700"`. The value is converted to UTC if you don't use the TimeZone parameter. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -985,6 +1015,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -994,7 +1027,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1004,9 +1036,12 @@ Accept wildcard characters: False ``` ### -ContentFilter + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service for IMAP migration and Google Workspace migration. -The ContentFilter parameter uses OPATH filter syntax to filter the messages by Received time. Only content that match the ContentFilter parameter will be moved to Exchange online. For example: +The ContentFilter parameter uses OPATH filter syntax to filter the messages by Received time. Only content that matches the ContentFilter parameter is moved to Exchange online. For example: - `"Received -gt '8/23/2020'"` - `"Received -le '2019/01/01'"` @@ -1018,7 +1053,6 @@ You can specify the language by using the ContentFilterLanguage parameter. Type: String Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1028,6 +1062,9 @@ Accept wildcard characters: False ``` ### -ContentFilterLanguage + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service for IMAP migration and Google Workspace migration. The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. @@ -1038,7 +1075,26 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFusion + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill DataFusion Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: Required: False Position: Named @@ -1048,13 +1104,15 @@ Accept wildcard characters: False ``` ### -DisableOnCopy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DisableOnCopy switch disables the original migration job item for a user if you're copying users from an existing batch to a new batch by using the UserIds or Users parameters. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: PreexistingUserIds, Preexisting, PreexistingUsers Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1064,6 +1122,9 @@ Accept wildcard characters: False ``` ### -DisallowExistingUsers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DisallowExistingUsers switch prevents the migration of mailboxes that are currently defined in a different migration batch. You don't need to specify a value with this switch. @@ -1074,7 +1135,6 @@ A validation warning is displayed for any pre-existing mailbox in the target des Type: SwitchParameter Parameter Sets: Local, Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1084,6 +1144,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -1092,7 +1155,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1102,6 +1164,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpsters + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExcludeDumpsters switch specifies whether to migrate public folder mailboxes without including the contents of the Recoverable Items folder (formerly known as the dumpster). You don't need to specify a value with this switch. @@ -1112,7 +1177,6 @@ You use this switch only in public folder migrations from Exchange 2013 or later Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1122,6 +1186,9 @@ Accept wildcard characters: False ``` ### -ExcludeFolders + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration or Google Workspace migration, the ExcludeFolders parameter specifies mailbox folders that you don't want to migrate from the source email system to the cloud-based mailboxes. Specify the value as a string array and separate multiple folder names with commas. @@ -1157,7 +1224,6 @@ Wildcard characters can't be used in folder names. Type: MultiValuedProperty Parameter Sets: Onboarding, Analysis Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1167,6 +1233,9 @@ Accept wildcard characters: False ``` ### -ForwardingDisposition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ForwardingDisposition Description }} @@ -1175,7 +1244,6 @@ This parameter is available only in the cloud-based service. Type: GmailForwardingDisposition Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1185,13 +1253,15 @@ Accept wildcard characters: False ``` ### -GoogleResource + +> Applicable: Exchange Online + {{ Fill GoogleResource Description }} ```yaml Type: SwitchParameter Parameter Sets: GoogleResourceOnboarding Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -1201,6 +1271,9 @@ Accept wildcard characters: False ``` ### -IncludeFolders + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration or Google Workspace migration, the IncludeFolders parameter specifies mailbox folders that you want to migrate from the on-premises email system to the cloud-based mailboxes. Specify the value as a string array and separate multiple folder names with commas. @@ -1236,7 +1309,6 @@ Wildcard characters can't be used in folder names. Type: MultiValuedProperty Parameter Sets: Onboarding, Analysis Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1246,6 +1318,9 @@ Accept wildcard characters: False ``` ### -IncludeOtherContacts + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeOtherContacts Description }} @@ -1254,7 +1329,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1264,6 +1338,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. For more information about maximum message size values, see the following topics: @@ -1273,13 +1350,12 @@ For more information about maximum message size values, see the following topics Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: Onboarding, Offboarding, LocalPublicFolder, PublicFolderToUnifiedGroup, FolderMove Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1289,6 +1365,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Locale parameter specifies the language for the migration batch. @@ -1299,7 +1378,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1309,6 +1387,9 @@ Accept wildcard characters: False ``` ### -MigrateTasks + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MigrateTasks Description }} @@ -1317,7 +1398,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1327,6 +1407,9 @@ Accept wildcard characters: False ``` ### -MoveOptions + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MoveOptions parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. Don't use this parameter with the SkipMoving parameter. @@ -1335,7 +1418,6 @@ Don't use this parameter with the SkipMoving parameter. Type: MultiValuedProperty Parameter Sets: Onboarding, Local, Offboarding, FolderMove Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1345,6 +1427,9 @@ Accept wildcard characters: False ``` ### -NotificationEmails + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NotificationEmails parameter specifies one or more email addresses that migration status reports are sent to. Specify the value as a string array, and separate multiple email addresses with commas. If you don't use this parameter, the status report isn't sent. @@ -1353,7 +1438,6 @@ If you don't use this parameter, the status report isn't sent. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1363,6 +1447,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1371,7 +1458,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: PreexistingUserIds, Onboarding, Local, Offboarding, PublicFolderToUnifiedGroup, WorkflowTemplate, PreexistingUsers, GoogleResourceOnboarding, FolderMove, Analysis, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1381,6 +1467,9 @@ Accept wildcard characters: False ``` ### -PrimaryOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PrimaryOnly switch specifies that only primary mailboxes are migrated for the users in the migration batch that also have archive mailboxes (archive mailboxes aren't migrated). You don't need to specify a value with this switch. You can only use this switch for local moves and remote move migrations. @@ -1391,7 +1480,6 @@ You can only use this switch for local moves and remote move migrations. Type: SwitchParameter Parameter Sets: Local, Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1401,6 +1489,9 @@ Accept wildcard characters: False ``` ### -PublicFolderToUnifiedGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The PublicFolderToUnifiedGroup switch specifies a migration from public folders to Microsoft 365 Groups. You don't need to specify a value with this switch. @@ -1409,7 +1500,6 @@ The PublicFolderToUnifiedGroup switch specifies a migration from public folders Type: SwitchParameter Parameter Sets: PublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1419,6 +1509,9 @@ Accept wildcard characters: False ``` ### -RemoveOnCopy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RemoveOnCopy Description }} @@ -1427,7 +1520,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding, Local, Offboarding, GoogleResourceOnboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1437,6 +1529,9 @@ Accept wildcard characters: False ``` ### -RenamePrimaryCalendar + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RenamePrimaryCalendar Description }} @@ -1445,7 +1540,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1455,6 +1549,9 @@ Accept wildcard characters: False ``` ### -ReportInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReportInterval parameter specifies how frequently emailed reports should be sent to the email addresses listed within NotificationEmails. By default, emailed reports are sent every 24 hours for a batch. Setting this value to 0 indicates that reports should never be sent for this batch. @@ -1465,7 +1562,6 @@ This parameter should only be used in the cloud-based service. Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1475,6 +1571,9 @@ Accept wildcard characters: False ``` ### -Restore + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Restore Description }} @@ -1483,7 +1582,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1493,6 +1591,9 @@ Accept wildcard characters: False ``` ### -SimplifiedSwitchOver + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SimplifiedSwitchOver Description }} @@ -1501,7 +1602,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1511,6 +1611,9 @@ Accept wildcard characters: False ``` ### -SkipCalendar + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SkipCalendar switch specifies that you want to skip calendar migration during Google Workspace onboarding. You don't need to specify a value with this switch. @@ -1519,7 +1622,6 @@ The SkipCalendar switch specifies that you want to skip calendar migration durin Type: SwitchParameter Parameter Sets: Onboarding, ManagedGmailTeams Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1529,6 +1631,9 @@ Accept wildcard characters: False ``` ### -SkipContacts + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SkipContacts switch specifies that you want to skip contact migration during Google Workspace onboarding. You don't need to specify a value with this switch. @@ -1537,7 +1642,6 @@ The SkipContacts switch specifies that you want to skip contact migration during Type: SwitchParameter Parameter Sets: Onboarding, ManagedGmailTeams Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1547,6 +1651,9 @@ Accept wildcard characters: False ``` ### -SkipDelegates + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipDelegates Description }} @@ -1555,7 +1662,26 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding, GoogleResourceOnboarding Aliases: -Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDetails + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill SkipDetails Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Analysis +Aliases: Required: False Position: Named @@ -1565,6 +1691,9 @@ Accept wildcard characters: False ``` ### -SkipMail + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SkipMail switch specifies that you want to skip mail migration during Google Workspace onboarding. You don't need to specify a value with this switch. @@ -1573,7 +1702,6 @@ The SkipMail switch specifies that you want to skip mail migration during Google Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1583,13 +1711,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipMerging parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. ```yaml Type: MultiValuedProperty Parameter Sets: Onboarding, Offboarding, LocalPublicFolder, XO1, GoogleResourceOnboarding Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1599,7 +1729,10 @@ Accept wildcard characters: False ``` ### -SkipMoving -This parameter has been replaced by the MoveOptions parameter. + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +This parameter is replaced by the MoveOptions parameter. The SkipMoving parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. @@ -1607,7 +1740,6 @@ The SkipMoving parameter specifies the stages of the migration that you want to Type: MultiValuedProperty Parameter Sets: Local, Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1617,6 +1749,9 @@ Accept wildcard characters: False ``` ### -SkipProvisioning + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipProvisioning Description }} @@ -1625,7 +1760,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding, GoogleResourceOnboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1635,13 +1769,15 @@ Accept wildcard characters: False ``` ### -SkipReports + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipReports switch specifies that you want to skip automatic reporting for the migration. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1651,6 +1787,9 @@ Accept wildcard characters: False ``` ### -SkipRules + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SkipRules switch specifies that you want to skip rule migration during Google Workspace onboarding. You don't need to specify a value with this switch. @@ -1659,7 +1798,6 @@ The SkipRules switch specifies that you want to skip rule migration during Googl Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1669,11 +1807,14 @@ Accept wildcard characters: False ``` ### -SkipSteps + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SkipSteps parameter specifies the steps in the staged Exchange migration that you want to skip. Valid values are: -- None (This is the default value) +- None (default value) - SettingTargetAddress: Don't set the target email address on the source mailbox. This setting prevents mail from being forwarded from the original mailbox to the new migrated mailbox. This parameter is only enforced for staged Exchange migrations. @@ -1682,7 +1823,6 @@ This parameter is only enforced for staged Exchange migrations. Type: SkippableMigrationSteps[] Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1692,6 +1832,9 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceEndpoint parameter specifies the migration endpoint to use for the source of the migration batch. You create the migration endpoint by using the New-MigrationEndpoint cmdlet. You can use any value that uniquely identifies the migration endpoint. For example: - Name (the Identity property value) @@ -1703,7 +1846,6 @@ This parameter defines the settings that are used to connect to the server where Type: MigrationEndpointIdParameter Parameter Sets: Onboarding, PublicFolderToUnifiedGroup, GoogleResourceOnboarding, Analysis Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1713,6 +1855,9 @@ Accept wildcard characters: False ``` ### -SourcePFPrimaryMailboxGuid + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SourcePFPrimaryMailboxGuid Description }} @@ -1721,7 +1866,6 @@ This parameter is available only in the cloud-based service. Type: Guid Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1731,20 +1875,22 @@ 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. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The migration is prepared, but the actual data migration for the user doesn'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". 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: - Specify the date/time value in UTC: For example, `"7/30/2020 9:00PM Z"`. -- Specify the date/time value in your local time zone. For example, `"7/30/2020 9:00PM -700"`. The value will be converted to UTC if you don't use the TimeZone parameter. +- Specify the date/time value in your local time zone. For example, `"7/30/2020 9:00PM -700"`. The value is converted to UTC if you don't use the TimeZone parameter. ```yaml Type: DateTime Parameter Sets: Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1754,7 +1900,10 @@ Accept wildcard characters: False ``` ### -TargetArchiveDatabases -The TargetArchiveDatabases parameter specifies the database where the archive mailboxes specified in the migration batch will be migrated to. You can use any value that uniquely identifies the database. For example: + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The TargetArchiveDatabases parameter specifies the database where the archive mailboxes specified in the migration batch are migrated to. You can use any value that uniquely identifies the database. For example: - Name - Distinguished name (DN) @@ -1770,7 +1919,6 @@ You can only use this parameter for local moves and remote move migrations. Type: MultiValuedProperty Parameter Sets: Local, Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1780,6 +1928,9 @@ Accept wildcard characters: False ``` ### -TargetDatabases + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetDatabases parameter specifies the identity of the database that you're moving mailboxes to. You can use any value that uniquely identifies the database. For example: - Name @@ -1798,7 +1949,6 @@ If you don't use this parameter for a local move, the cmdlet uses the automatic Type: MultiValuedProperty Parameter Sets: Onboarding, Local, Offboarding, XO1, Abch Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1808,6 +1958,9 @@ Accept wildcard characters: False ``` ### -TargetDeliveryDomain + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the migration batch is complete. This parameter is required for remote move onboarding and remote offboarding migration batches @@ -1816,7 +1969,6 @@ This parameter is required for remote move onboarding and remote offboarding mig Type: String Parameter Sets: Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1826,6 +1978,9 @@ Accept wildcard characters: False ``` ### -TargetEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetEndpoint parameter specifies the migration endpoint to use for the destination of the migration batch. You create the migration endpoint by using the New-MigrationEndpoint cmdlet. You can use any value that uniquely identifies the migration endpoint. For example: - Name (the Identity property value) @@ -1837,7 +1992,6 @@ This parameter defines the settings that are used to connect to the destination Type: MigrationEndpointIdParameter Parameter Sets: Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1847,6 +2001,9 @@ Accept wildcard characters: False ``` ### -TimeZone + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TimeZone parameter specifies the time zone of the administrator who submits the migration batch. A valid value for this parameter is a supported time zone key name (for example, `"Pacific Standard Time"`). @@ -1863,7 +2020,6 @@ In Exchange Online, the default value is `UTC`. Type: ExTimeZoneValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1873,13 +2029,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1889,9 +2047,12 @@ Accept wildcard characters: False ``` ### -WorkflowControlFlags + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WorkflowControlFlags parameter specifies advanced controls for the steps that are performed in the migration. Valid values are: -- None (This is the default value) +- None (default value) - InjectAndForget - SkipSwitchover @@ -1901,7 +2062,6 @@ Don't use this parameter unless you're directed to do so by Microsoft Customer S Type: MigrationWorkflowControlFlags Parameter Sets: Local, Onboarding Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1911,13 +2071,15 @@ Accept wildcard characters: False ``` ### -WorkflowTemplate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WorkflowTemplate parameter specifies advanced controls for the steps that are performed in the migration. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. ```yaml Type: String Parameter Sets: WorkflowTemplate Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1927,6 +2089,9 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1935,7 +2100,6 @@ This parameter is reserved for internal Microsoft use. Type: RequestWorkloadType Parameter Sets: Local Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1945,6 +2109,9 @@ Accept wildcard characters: False ``` ### -XMLData + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill XMLData Description }} @@ -1953,7 +2120,6 @@ This parameter is available only in the cloud-based service. Type: Byte[] Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md b/exchange/exchange-ps/ExchangePowerShell/New-MigrationEndpoint.md similarity index 84% rename from exchange/exchange-ps/exchange/New-MigrationEndpoint.md rename to exchange/exchange-ps/ExchangePowerShell/New-MigrationEndpoint.md index f7429f506d..d71d215217 100644 --- a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MigrationEndpoint.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-migrationendpoint -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MigrationEndpoint -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-migrationendpoint +schema: 2.0.0 +title: New-MigrationEndpoint --- # New-MigrationEndpoint ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MigrationEndpoint cmdlet to configure the connection settings for cross-forests moves, remote move migrations, cutover or staged Exchange migrations, IMAP migrations, and Google Workspace (formerly G Suite) migrations. @@ -244,7 +245,7 @@ The New-MigrationEndpoint cmdlet configures the connection settings for differen Moving mailboxes between different servers or databases within a single on-premises Exchange forest (called a local move) doesn't require a migration endpoint. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -269,23 +270,23 @@ $Credentials = Get-Credential New-MigrationEndpoint -ExchangeOutlookAnywhere -Name EXCH-AutoDiscover -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials ``` -This example creates an Outlook Anywhere migration endpoint by using the Autodiscover parameter to detect the connection settings to the on-premises organization. Outlook Anywhere endpoints are used for cutover and staged Exchange migrations. The Get-Credential cmdlet is used to obtain the credentials for an on-premises account that has the necessary administrative privileges in the domain and that can access the mailboxes that will be migrated. When prompted for the user name, you can use either the email address or the domain\\username format for the administrator account. This account can be the same one that is specified by the EmailAddress parameter. +This example creates an Outlook Anywhere migration endpoint by using the Autodiscover parameter to detect the connection settings to the on-premises organization. Outlook Anywhere endpoints are used for cutover and staged Exchange migrations. The Get-Credential cmdlet is used to obtain the credentials for an on-premises account that has the necessary administrative privileges in the domain and that can access the migrated mailboxes. When prompted for the user name, you can use either the email address or the domain\\username format for the administrator account. This account can be the same one that is specified by the EmailAddress parameter. ### Example 4 ```powershell New-MigrationEndpoint -ExchangeOutlookAnywhere -Name EXCH_Manual -ExchangeServer EXCH-01-MBX.contoso.com -RPCProxyServer EXCH-02-CAS.contoso.com -Credentials (Get-Credential administrator@contoso.com) -EmailAddress annb@contoso.com ``` -This example creates an Outlook Anywhere migration endpoint by specifying the connection settings manually. Outlook Anywhere endpoints are used for cutover and staged Exchange migrations. The value for the ExchangeServer parameter specifies the on-premises Exchange server that hosts the mailboxes that will be migrated. The value for the RPCProxyServer parameter specifies the Exchange server in the on-premises organization that has the Client Access server role installed that directly accepts and proxies client connections. The EmailAddress parameter can specify any mailbox in the on-premises domain. +This example creates an Outlook Anywhere migration endpoint by specifying the connection settings manually. Outlook Anywhere endpoints are used for cutover and staged Exchange migrations. The value for the ExchangeServer parameter specifies the on-premises Exchange server that hosts the migrated mailboxes. The value for the RPCProxyServer parameter specifies the Exchange server in the on-premises organization that has the Client Access server role installed that directly accepts and proxies client connections. The EmailAddress parameter can specify any mailbox in the on-premises domain. -It's recommended that you use a migration endpoint created with connection settings that are automatically discovered (see Example 3) because the Autodiscover service will be used to connect to each user mailbox in the migration batch. If you manually specify the connection settings for the endpoint and a user mailbox isn't located on the server specified by the ExchangeServer parameter, the migration for that user will fail. This is important if you have multiple on-premises Outlook Anywhere servers. Otherwise, you may need to create different migration endpoints that correspond to each on-premises server. +We recommend that you use a migration endpoint created with connection settings that are automatically discovered (see Example 3) because the Autodiscover service is used to connect to each user mailbox in the migration batch. If you manually specify the connection settings for the endpoint and a user mailbox isn't located on the server specified by the ExchangeServer parameter, the migration for that user will fail. This is important if you have multiple on-premises Outlook Anywhere servers. Otherwise, you might need to create different migration endpoints that correspond to each on-premises server. ### Example 5 ```powershell New-MigrationEndpoint -IMAP -Name IMAPEndpoint -RemoteServer imap.contoso.com -Port 993 -Security Ssl ``` -This example creates an IMAP migration endpoint. The value for the RemoteServer parameter specifies the FQDN of the IMAP server that hosts the mailboxes that will be migrated. The endpoint is configured to use port 993 for SSL encryption. +This example creates an IMAP migration endpoint. The value for the RemoteServer parameter specifies the FQDN of the IMAP server that hosts the migrated mailboxes. The endpoint is configured to use port 993 for SSL encryption. ### Example 6 ```powershell @@ -297,13 +298,15 @@ This example creates an IMAP migration endpoint that supports 50 concurrent migr ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name you give to the new migration endpoint. You can use the Name parameter when you run the New-MigrationBatch cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -313,13 +316,15 @@ Accept wildcard characters: False ``` ### -Autodiscover + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + For an Exchange migration, the Autodiscover switch specifies whether to get other connection settings for the on-premises server from the Autodiscover service. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -329,13 +334,15 @@ Accept wildcard characters: False ``` ### -Compliance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Compliance switch specifies that the endpoint type is compliance. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Compliance Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -345,15 +352,17 @@ Accept wildcard characters: False ``` ### -Credentials + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, LegacyPublicFolderToUnifiedGroup +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, LegacyPublicFolderToUnifiedGroup, ExchangeRemoteMove, PSTImport Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -362,27 +371,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: PSCredential -Parameter Sets: ExchangeRemoteMove, PSTImport -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -EmailAddress -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -EmailAddress The EmailAddress parameter specifies the email address used by the Autodiscover service or in some cases used to validate the endpoint when you specify the connection settings manually. ```yaml Type: SmtpAddress -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -391,20 +389,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SmtpAddress -Parameter Sets: ExchangeOutlookAnywhere, Gmail -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -ExchangeOutlookAnywhere -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -ExchangeOutlookAnywhere This parameter is available only in the cloud-based service. The ExchangeOutlookAnywhere switch specifies the type of endpoint for staged and cutover migrations. You don't need to specify a value with this switch. @@ -413,7 +401,6 @@ The ExchangeOutlookAnywhere switch specifies the type of endpoint for staged and Type: SwitchParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -423,13 +410,15 @@ Accept wildcard characters: False ``` ### -ExchangeRemoteMove + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExchangeRemoteMove switch specifies the type of endpoint for cross-forest moves and remote move migrations in a hybrid deployment. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeRemoteMove Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -439,6 +428,9 @@ Accept wildcard characters: False ``` ### -Gmail + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Gmail switch specifies the type of endpoint for Google Workspace migrations. You don't need to specify a value with this switch. @@ -447,7 +439,6 @@ The Gmail switch specifies the type of endpoint for Google Workspace migrations. Type: SwitchParameter Parameter Sets: Gmail Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -457,6 +448,9 @@ Accept wildcard characters: False ``` ### -IMAP + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IMAP switch specifies the type of endpoint for IMAP migrations. You don't need to specify a value with this switch. @@ -465,7 +459,6 @@ The IMAP switch specifies the type of endpoint for IMAP migrations. You don't ne Type: SwitchParameter Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -475,6 +468,9 @@ Accept wildcard characters: False ``` ### -OAuthCode + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill OAuthCode Description }} @@ -483,7 +479,6 @@ This parameter is available only in the cloud-based service. Type: SecureString Parameter Sets: GoogleMarketplaceApp Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -493,6 +488,9 @@ Accept wildcard characters: False ``` ### -PSTImport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -501,7 +499,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: PSTImport Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -511,6 +508,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -519,7 +519,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: PublicFolder, MrsProxyPublicFolder Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -529,6 +528,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabaseServerLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -537,7 +539,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -547,13 +548,15 @@ Accept wildcard characters: False ``` ### -PublicFolderToUnifiedGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublicFolderToUnifiedGroup switch specifies that the endpoint type is public folders to Microsoft 365 Groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -563,6 +566,9 @@ Accept wildcard characters: False ``` ### -RemoteServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoteServer parameter specifies the FQDN of the remote server, which depends on the protocol type for moves: - For cross-forest moves and remote move migrations, this parameter refers to the Exchange server in the on-premises organization that has the Client Access server role installed that directly accepts and proxies client connections. @@ -572,7 +578,6 @@ The RemoteServer parameter specifies the FQDN of the remote server, which depend Type: Fqdn Parameter Sets: ExchangeRemoteMove, PSTImport, IMAP, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -582,17 +587,19 @@ Accept wildcard characters: False ``` ### -RpcProxyServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The RpcProxyServer parameter specifies the FQDN of the Exchange server in the on-premises Exchange organization that has the Client Access server role installed that directly accepts and proxies client connections. This parameter is used when you create an Outlook Anywhere migration endpoint for cutover and staged Exchange migrations. Typically, this FQDN will be the same as your Outlook on the web URL; for example, mail.contoso.com. This is also the URL for the proxy server that Outlook uses to connect to an Exchange server. +The RpcProxyServer parameter specifies the FQDN of the Exchange server in the on-premises Exchange organization that has the Client Access server role installed that directly accepts and proxies client connections. This parameter is used when you create an Outlook Anywhere migration endpoint for cutover and staged Exchange migrations. Typically, this FQDN wis the same as your Outlook on the web URL. For example, mail.contoso.com. This is also the URL for the proxy server that Outlook uses to connect to an Exchange server. This parameter is required only when you don't use the Autodiscover parameter. ```yaml Type: Fqdn -Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup +Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -601,23 +608,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Fqdn -Parameter Sets: ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online +### -ServiceAccountKeyFileData -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -ServiceAccountKeyFileData This parameter is available only in the cloud-based service. -The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. +The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that is granted access to your remote tenant is created. 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`). @@ -625,7 +622,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: Gmail Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -635,15 +631,17 @@ Accept wildcard characters: False ``` ### -SourceMailboxLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SourceMailboxLegacyDN parameter specifies the LegacyExchangeDN value of an on-premises mailbox that's used to test the ability of the migration service to create a connection using this endpoint. The cmdlet tries to access this mailbox using the credentials for the administrator account specified in the command. ```yaml Type: String -Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup +Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -652,20 +650,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online +### -AcceptUntrustedCertificates -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -AcceptUntrustedCertificates This parameter is available only in the cloud-based service. {{ Fill AcceptUntrustedCertificates Description }} @@ -674,7 +662,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, IMAP Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -684,6 +671,9 @@ Accept wildcard characters: False ``` ### -ApplicationId + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ApplicationId Description }} @@ -692,7 +682,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ExchangeRemoteMove Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -702,6 +691,9 @@ Accept wildcard characters: False ``` ### -AppSecretKeyVaultUrl + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AppSecretKeyVaultUrl Description }} @@ -710,7 +702,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ExchangeRemoteMove Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -720,6 +711,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Authentication parameter specifies the authentication method used by the on-premises mail server. If you don't include this parameter, Basic authentication is used. @@ -728,7 +722,6 @@ The Authentication parameter specifies the authentication method used by the on- Type: AuthenticationMethod Parameter Sets: ExchangeOutlookAnywhere, IMAP, PublicFolder, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -738,6 +731,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -747,7 +743,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -757,6 +752,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -765,7 +763,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, ExchangeRemoteMove, PSTImport, IMAP, Gmail, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -775,9 +772,12 @@ Accept wildcard characters: False ``` ### -ExchangeServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The ExchangeServer parameter specifies the FQDN of the on-premises Exchange server that hosts the mailboxes that will be migrated. This parameter is used when you create an Outlook Anywhere migration endpoint for cutover and staged Exchange migrations. +The ExchangeServer parameter specifies the FQDN of the on-premises Exchange server that hosts the migrated mailboxes. This parameter is used when you create an Outlook Anywhere migration endpoint for cutover and staged Exchange migrations. This parameter is required only when you don't use the Autodiscover parameter. @@ -785,7 +785,6 @@ This parameter is required only when you don't use the Autodiscover parameter. Type: String Parameter Sets: ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -795,6 +794,9 @@ Accept wildcard characters: False ``` ### -MailboxPermission + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxPermission parameter specifies what permissions to use to access the source mailbox during Outlook Anywhere onboarding (staged Exchange migration and cutover Exchange migration). @@ -802,7 +804,7 @@ The MailboxPermission parameter specifies what permissions to use to access the The migration administrator account specified for the endpoint must have one of the following permissions: - Admin: The account is a domain administrator who can access any mailbox they want to migrate. -- FullAccess: The account is assigned either the Full Access permission to the mailboxes they want to migrate or the Receive As permission to the mailbox database that hosts the mailboxes that will be migrated. +- FullAccess: The account is assigned either the Full Access permission to the mailboxes they want to migrate or the Receive As permission to the mailbox database that hosts the migrated mailboxes. If this parameter isn't specified, the cmdlet tries to access source mailboxes using the domain administrator permission and if that fails, it then tries to access the source mailboxes using the Full Access or Receive As permissions. @@ -812,7 +814,6 @@ This parameter can't be used for creating non-Outlook Anywhere migration endpoin Type: MigrationMailboxPermission Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -822,13 +823,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentIncrementalSyncs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -838,13 +841,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMigrations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxConcurrentMigrations parameter specifies the maximum number of mailboxes that are migrated during initial sync. This parameter is applicable for all migration types. The default value is 100. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -854,6 +859,9 @@ Accept wildcard characters: False ``` ### -NspiServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The NspiServer parameter specifies the remote Name Service Provider Interface (NSPI) server location for cutover and staged migrations. You must provide the FQDN of the server. @@ -862,7 +870,6 @@ The NspiServer parameter specifies the remote Name Service Provider Interface (N Type: String Parameter Sets: ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -872,6 +879,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -880,7 +890,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -890,6 +899,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration, the Port parameter specifies the TCP port number used by the migration process to connect to the remote server. This parameter is required when you want to migrate data from an on-premises IMAP server to cloud-based mailboxes. @@ -898,7 +910,6 @@ For an IMAP migration, the Port parameter specifies the TCP port number used by Type: Int32 Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -908,6 +919,9 @@ Accept wildcard characters: False ``` ### -RedirectUri + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RedirectUri Description }} @@ -916,7 +930,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: GoogleMarketplaceApp Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -926,6 +939,9 @@ Accept wildcard characters: False ``` ### -RemoteTenant + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RemoteTenant Description }} @@ -934,7 +950,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ExchangeRemoteMove Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -944,6 +959,9 @@ Accept wildcard characters: False ``` ### -Security + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl. @@ -952,7 +970,6 @@ For an IMAP migration, the Security parameter specifies the encryption method us Type: IMAPSecurityMechanism Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -962,13 +979,15 @@ Accept wildcard characters: False ``` ### -SkipVerification + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipVerification switch specifies whether to skip verifying that the remote server is reachable when creating a migration endpoint. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -978,6 +997,9 @@ Accept wildcard characters: False ``` ### -TestMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The TestMailbox parameter specifies an Exchange Online mailbox used as the target by the migration service to verify the connection using this endpoint. You can use any value that uniquely identifies the mailbox. For example: @@ -1001,7 +1023,6 @@ This parameter is only used to create Outlook Anywhere migration endpoints. Type: MailboxIdParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail, GoogleMarketplaceApp, PublicFolder, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1011,13 +1032,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-MobileDeviceMailboxPolicy.md similarity index 82% rename from exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-MobileDeviceMailboxPolicy.md index a091ad8d3d..863ff11d57 100644 --- a/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MobileDeviceMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mobiledevicemailboxpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MobileDeviceMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mobiledevicemailboxpolicy +schema: 2.0.0 +title: New-MobileDeviceMailboxPolicy --- # New-MobileDeviceMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MobileDeviceMailboxPolicy cmdlet to create mobile device mailbox policies. @@ -89,7 +90,7 @@ Some mobile device mailbox policy settings require the mobile device to have cer Some settings in this cmdlet are supported by Outlook for iOS and Android. For more information, see [Leveraging Exchange Online mobile device policies](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/secure-outlook-for-ios-and-android#leveraging-exchange-online-mobile-device-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -117,6 +118,9 @@ This example creates the mobile device mailbox policy Contoso Policy that has se ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the mobile device mailbox policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -129,7 +133,6 @@ The name of the built-in mobile device mailbox policy is Default. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -139,6 +142,9 @@ Accept wildcard characters: False ``` ### -AllowApplePushNotifications + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowApplePushNotifications parameter specifies whether push notifications are allowed for Apple mobile devices. Valid input for this parameter is $true or $false. The default value is $true. @@ -147,7 +153,6 @@ The AllowApplePushNotifications parameter specifies whether push notifications a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +162,9 @@ Accept wildcard characters: False ``` ### -AllowBluetooth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile device. Valid values are: - Allow (this is the default value). @@ -171,7 +179,6 @@ The value Disable disables synchronization between Outlook for Android and the O Type: BluetoothType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -181,13 +188,15 @@ Accept wildcard characters: False ``` ### -AllowBrowser -The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect third-party browsers. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect non-Microsoft browsers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,13 +206,15 @@ Accept wildcard characters: False ``` ### -AllowCamera + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowCamera parameter specifies whether the mobile device's camera is allowed. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -213,13 +224,15 @@ Accept wildcard characters: False ``` ### -AllowConsumerEmail -The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using third-party mobile device email programs. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using non-Microsoft mobile device email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -229,13 +242,15 @@ Accept wildcard characters: False ``` ### -AllowDesktopSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowDesktopSync parameter specifies whether the mobile device can synchronize with a desktop computer through a cable. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -245,13 +260,15 @@ Accept wildcard characters: False ``` ### -AllowExternalDeviceManagement + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the mobile device. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -261,6 +278,9 @@ Accept wildcard characters: False ``` ### -AllowGooglePushNotifications + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowGooglePushNotifications parameter controls whether the user can receive push notifications from Google for Outlook on the web for devices. Valid input for this parameter is $true or $false. The default value is $true. @@ -269,7 +289,6 @@ The AllowGooglePushNotifications parameter controls whether the user can receive Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -279,13 +298,15 @@ Accept wildcard characters: False ``` ### -AllowHTMLEmail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowHTMLEmail parameter specifies whether HTML-formatted email is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. If set to $false, all email is converted to plain text before synchronization occurs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -295,13 +316,15 @@ Accept wildcard characters: False ``` ### -AllowInternetSharing + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowInternetSharing parameter specifies whether the mobile device can be used as a modem to connect a computer to the Internet. This process is also known as tethering. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -311,13 +334,15 @@ Accept wildcard characters: False ``` ### -AllowIrDA + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -327,6 +352,9 @@ Accept wildcard characters: False ``` ### -AllowMicrosoftPushNotifications + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowMicrosoftPushNotifications parameter specifies whether push notifications are enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. @@ -335,7 +363,6 @@ The AllowMicrosoftPushNotifications parameter specifies whether push notificatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -345,13 +372,15 @@ Accept wildcard characters: False ``` ### -AllowMobileOTAUpdate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowMobileOTAUpdate parameter specifies whether the policy can be sent to the mobile device over a cellular data connection. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -361,6 +390,9 @@ Accept wildcard characters: False ``` ### -AllowNonProvisionableDevices + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowNonProvisionableDevices parameter specifies whether all mobile devices can synchronize with Exchange. Valid input for this parameter is $true or $false. The default value is $true. When set to $true, this parameter enables all mobile devices to synchronize with Exchange, regardless of whether the device can enforce all settings that are defined by the policy. This also includes mobile devices managed by a separate device management system. When set to $false, this parameter blocks mobile devices that aren't provisioned from synchronizing with Exchange. @@ -369,7 +401,6 @@ When set to $true, this parameter enables all mobile devices to synchronize with Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -379,13 +410,15 @@ Accept wildcard characters: False ``` ### -AllowPOPIMAPEmail -The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by third-party email programs. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by non-Microsoft email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -395,13 +428,15 @@ Accept wildcard characters: False ``` ### -AllowRemoteDesktop + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowRemoteDesktop parameter specifies whether the mobile device can initiate a remote desktop connection. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,13 +446,15 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSimplePassword parameter specifies whether a simple password is allowed on the mobile device. A simple password is a password that has a specific pattern, such as 1111 or 1234. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -427,6 +464,9 @@ Accept wildcard characters: False ``` ### -AllowSMIMEEncryptionAlgorithmNegotiation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSMIMEEncryptionAlgorithmNegotiation parameter specifies whether the messaging application on the mobile device can negotiate the encryption algorithm if a recipient's certificate doesn't support the specified encryption algorithm. Valid values for this parameter are: - AllowAnyAlgorithmNegotiation @@ -439,7 +479,6 @@ The default value is AllowAnyAlgorithmNegotiation. Type: SMIMEEncryptionAlgorithmNegotiationType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -449,13 +488,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMESoftCerts + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -465,13 +506,15 @@ Accept wildcard characters: False ``` ### -AllowStorageCard + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowStorageCard parameter specifies whether the mobile device can access information stored on a storage card. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -481,13 +524,15 @@ Accept wildcard characters: False ``` ### -AllowTextMessaging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowTextMessaging parameter specifies whether text messaging is allowed from the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -497,13 +542,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedApplications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -513,13 +560,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedInstallationPackages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages are allowed to run on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -529,13 +578,15 @@ Accept wildcard characters: False ``` ### -AllowWiFi + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowWiFi parameter specifies whether wireless Internet access is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -545,13 +596,15 @@ Accept wildcard characters: False ``` ### -AlphanumericPasswordRequired + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlphanumericPasswordRequired parameter specifies whether the password for the mobile device must be alphanumeric. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -561,13 +614,15 @@ Accept wildcard characters: False ``` ### -ApprovedApplicationList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApprovedApplicationList parameter specifies a configured list of approved applications for the device. ```yaml Type: ApprovedApplicationCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -577,6 +632,9 @@ Accept wildcard characters: False ``` ### -AttachmentsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AttachmentsEnabled parameter specifies whether attachments can be downloaded on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. When set to $false, this parameter blocks the user from downloading attachments on the mobile device. @@ -585,7 +643,6 @@ When set to $false, this parameter blocks the user from downloading attachments Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -595,6 +652,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -604,7 +664,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -614,6 +673,9 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This setting is supported by Outlook for iOS and Android. The DeviceEncryptionEnabled parameter specifies whether encryption is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. @@ -624,7 +686,6 @@ When this parameter is set to $true, device encryption is enabled on the mobile Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -634,6 +695,9 @@ Accept wildcard characters: False ``` ### -DevicePolicyRefreshInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DevicePolicyRefreshInterval parameter specifies how often the policy is sent to the mobile device. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -644,7 +708,6 @@ The default value is Unlimited. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -654,6 +717,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -662,7 +728,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -672,13 +737,15 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -688,6 +755,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault parameter specifies whether this policy is the default mobile device mailbox policy. Valid input for this parameter is $true or $false. The default value for the built-in mobile device mailbox policy named Default is $true. The default value for new mobile device mailbox policies that you create is $false. There can be only one default policy. If another policy is currently set as the default, and you set this parameter to $true, this policy becomes the default policy. The value of this parameter on the other policy is automatically changed to $false, and that policy is no longer the default policy. @@ -696,7 +766,6 @@ There can be only one default policy. If another policy is currently set as the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -706,6 +775,9 @@ Accept wildcard characters: False ``` ### -MaxAttachmentSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile device. Valid input for this parameter is a size value between 0 and 2147482624 bytes (approximately 2 GB), or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4096 or 4KB. @@ -720,7 +792,6 @@ The maximum value is 1024 bytes (one kilobyte) less than two gigabytes (2\*1024^ Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -730,6 +801,9 @@ Accept wildcard characters: False ``` ### -MaxCalendarAgeFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the mobile device. Valid values for this parameter are: - All @@ -744,7 +818,6 @@ The default value is All. Type: CalendarAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -754,6 +827,9 @@ Accept wildcard characters: False ``` ### -MaxEmailAgeFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the mobile device. Valid values for this parameter are: - All @@ -769,7 +845,6 @@ The default value is All. Type: EmailAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -779,6 +854,9 @@ Accept wildcard characters: False ``` ### -MaxEmailBodyTruncationSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. @@ -787,7 +865,6 @@ Unqualified values are treated as bytes. You can qualify the value with KB (kilo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -797,6 +874,9 @@ Accept wildcard characters: False ``` ### -MaxEmailHTMLBodyTruncationSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. @@ -805,7 +885,6 @@ Unqualified values are treated as bytes. You can qualify the value with KB (kilo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -815,16 +894,18 @@ Accept wildcard characters: False ``` ### -MaxInactivityTimeLock + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxInactivityTimeLock parameter specifies the length of time that the mobile device can be inactive before the password is required to reactivate it. Valid values are: - A timespan: hh:mm:ss, where hh = hours, mm = minutes and ss= seconds. The valid input range is 00:01:00 to 01:00:00 (one minute to one hour). -- The value Unlimited. This is the default value. +- The value Unlimited. This value is the default. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -834,6 +915,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordFailedAttempts + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxPasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile device. You can enter any number from 4 through 16 or the value Unlimited. The default value is Unlimited. @@ -842,7 +926,6 @@ You can enter any number from 4 through 16 or the value Unlimited. The default v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -852,6 +935,9 @@ Accept wildcard characters: False ``` ### -MinPasswordComplexCharacters + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MinPasswordComplexCharacters parameter specifies the character sets that are required in the password of the mobile device. The character sets are: - Lower case letters. @@ -874,7 +960,6 @@ For Windows Phone 10 devices, the value specifies the following password complex Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -884,6 +969,9 @@ Accept wildcard characters: False ``` ### -MinPasswordLength + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This setting is supported by Outlook for Android. The MinPasswordLength parameter specifies the minimum number of characters in the mobile device password. @@ -894,7 +982,6 @@ You can enter any number from 1 through 16 or the value $null. The default value Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -904,6 +991,9 @@ Accept wildcard characters: False ``` ### -PasswordEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PasswordEnabled parameter specifies whether a password is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. When set to $true, this parameter requires the user to set a password on the mobile device. @@ -912,7 +1002,6 @@ When set to $true, this parameter requires the user to set a password on the mob Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -922,16 +1011,18 @@ Accept wildcard characters: False ``` ### -PasswordExpiration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PasswordExpiration parameter specifies how long a password can be used on a mobile device before the user is forced to change the password. Valid values are: - A timespan: ddd.hh:mm:ss, where ddd = days, hh = hours, mm = minutes and ss= seconds. The valid input range is 1.00:00:00 to 730.00:00:00 (one day to two years). -- The value Unlimited. This is the default value +- The value Unlimited. This value is the default ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -941,6 +1032,9 @@ Accept wildcard characters: False ``` ### -PasswordHistory + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PasswordHistory parameter specifies the number of unique new passwords that need to be created on the mobile device before an old password can be reused. You can enter any number from 0 through 50. The default value is 0. @@ -949,7 +1043,6 @@ You can enter any number from 0 through 50. The default value is 0. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -959,6 +1052,9 @@ Accept wildcard characters: False ``` ### -PasswordRecoveryEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile device is stored in Exchange. Valid input for this parameter is $true or $false. The default value is $false. When set to $true, this parameter enables you to store the recovery password for the mobile device in Exchange. The recovery password can be viewed from Outlook on the web or the Exchange admin center. @@ -967,7 +1063,6 @@ When set to $true, this parameter enables you to store the recovery password for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -977,13 +1072,15 @@ Accept wildcard characters: False ``` ### -RequireDeviceEncryption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireDeviceEncryption parameter specifies whether encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -993,13 +1090,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptedSMIMEMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireEncryptedSMIMEMessages parameter specifies whether the mobile device must send encrypted S/MIME messages. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1009,6 +1108,9 @@ Accept wildcard characters: False ``` ### -RequireEncryptionSMIMEAlgorithm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireEncryptionSMIMEAlgorithm parameter specifies the algorithm that's required to encrypt S/MIME messages on a mobile device. The valid values for this parameter are: - DES @@ -1023,7 +1125,6 @@ The default value is TripleDES. Type: EncryptionSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1033,13 +1134,15 @@ Accept wildcard characters: False ``` ### -RequireManualSyncWhenRoaming + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireManualSyncWhenRoaming parameter specifies whether the mobile device must synchronize manually while roaming. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1049,6 +1152,9 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEAlgorithm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to sign S/MIME messages on the mobile device. Valid values for this parameter are SHA1 or MD5. The default value is SHA1. @@ -1057,7 +1163,6 @@ Valid values for this parameter are SHA1 or MD5. The default value is SHA1. Type: SignedSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1067,13 +1172,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSignedSMIMEMessages parameter specifies whether the mobile device must send signed S/MIME messages. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1083,6 +1190,9 @@ Accept wildcard characters: False ``` ### -RequireStorageCardEncryption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireStorageCardEncryption parameter specifies whether storage card encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. @@ -1091,7 +1201,6 @@ Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1101,13 +1210,15 @@ Accept wildcard characters: False ``` ### -UnapprovedInROMApplicationList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM on the mobile device. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1117,13 +1228,15 @@ Accept wildcard characters: False ``` ### -UNCAccessEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled from the mobile device. In on-premises Exchange organizations, access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1133,13 +1246,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1149,13 +1264,15 @@ Accept wildcard characters: False ``` ### -WSSAccessEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled from the mobile device. In on-premises Exchange organizations, access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-MoveRequest.md similarity index 83% rename from exchange/exchange-ps/exchange/New-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-MoveRequest.md index 85f5f280eb..82a5bb8174 100644 --- a/exchange/exchange-ps/exchange/New-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MoveRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-moverequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MoveRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-moverequest +schema: 2.0.0 +title: New-MoveRequest --- # New-MoveRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-MoveRequest cmdlet to begin the process of an asynchronous mailbox or personal archive move. You can also check mailbox readiness to be moved by using the WhatIf parameter. @@ -255,7 +256,7 @@ New-MoveRequest [-Identity] -TargetDeliveryDomain ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -283,6 +284,9 @@ This example creates a batch move request for all mailboxes on the database DB01 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - GUID @@ -297,7 +301,6 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c Type: MailboxOrMailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -307,6 +310,9 @@ Accept wildcard characters: False ``` ### -Outbound + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Outbound switch specifies that this mailbox move is a cross-forest move and is being initiated from the source forest. You don't need to specify a value with this switch. You can't use this switch with the Remote switch. @@ -315,7 +321,6 @@ You can't use this switch with the Remote switch. Type: SwitchParameter Parameter Sets: MigrationOutbound, MigrationOutboundCrossTenant Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -325,6 +330,9 @@ Accept wildcard characters: False ``` ### -Remote + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Remote switch specifies that the move is outside of your organization and is being initiated from the target forest. You don't need to specify a value with this switch. You can't use this switch with the Outbound switch. @@ -333,7 +341,6 @@ You can't use this switch with the Outbound switch. Type: SwitchParameter Parameter Sets: MigrationRemote, MigrationRemoteCrossTenant Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -343,15 +350,17 @@ Accept wildcard characters: False ``` ### -RemoteCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoteCredential parameter specifies the username and password of an administrator who has permission to perform the mailbox move. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential -Parameter Sets: MigrationRemoteLegacy +Parameter Sets: MigrationRemoteLegacy, MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -360,27 +369,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: PSCredential -Parameter Sets: MigrationOutbound, MigrationRemote -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -RemoteGlobalCatalog -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -RemoteGlobalCatalog The RemoteGlobalCatalog parameter specifies the fully qualified domain name (FQDN) of the global catalog server for the remote forest. ```yaml Type: Fqdn -Parameter Sets: MigrationRemoteLegacy +Parameter Sets: MigrationRemoteLegacy, MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -389,27 +387,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Fqdn -Parameter Sets: MigrationOutbound, MigrationRemote -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -RemoteHostName -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -RemoteHostName The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. ```yaml Type: Fqdn Parameter Sets: MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -419,6 +406,9 @@ Accept wildcard characters: False ``` ### -RemoteLegacy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoteLegacy switch specifies that this mailbox move is from a remote forest that has only Exchange 2010 servers installed. You don't need to specify a value with this switch. @@ -427,7 +417,6 @@ The RemoteLegacy switch specifies that this mailbox move is from a remote forest Type: SwitchParameter Parameter Sets: MigrationRemoteLegacy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -437,13 +426,15 @@ Accept wildcard characters: False ``` ### -TargetDeliveryDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the move request is complete. This parameter is allowed only when performing remote moves with the Remote, RemoteLegacy, or Outbound parameter. ```yaml Type: Fqdn -Parameter Sets: MigrationOutboundCrossTenant, MigrationRemoteCrossTenant +Parameter Sets: MigrationOutboundCrossTenant, MigrationRemoteCrossTenant, MigrationOutbound, MigrationRemote, MigrationRemoteLegacy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -452,20 +443,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Fqdn -Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -AcceptLargeDataLoss -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -AcceptLargeDataLoss The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later or Exchange Online, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -476,7 +457,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -486,6 +466,9 @@ Accept wildcard characters: False ``` ### -AllowLargeItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AllowLargeItems switch specifies that items larger than the target mailbox limits are copied without failure. You don't need to specify a value with this switch. @@ -496,7 +479,6 @@ You can't use this switch with the LargeItemLimit parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -506,13 +488,15 @@ Accept wildcard characters: False ``` ### -ArchiveDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ArchiveDomain parameter specifies the FQDN of the external domain to which you're moving the archive. This parameter is used for moving the archive to a cloud-based service. ```yaml Type: String Parameter Sets: MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -522,6 +506,9 @@ Accept wildcard characters: False ``` ### -ArchiveOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ArchiveOnly switch specifies that you're moving only the personal archive associated with the mailbox. You don't need to specify a value with this switch. You can't use this switch with the PrimaryOnly switch. @@ -530,7 +517,6 @@ You can't use this switch with the PrimaryOnly switch. Type: SwitchParameter Parameter Sets: MigrationOutbound, MigrationRemote, MigrationLocal Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -540,6 +526,9 @@ Accept wildcard characters: False ``` ### -ArchiveTargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArchiveTargetDatabase parameter specifies the destination mailbox database for the personal archive. You can use any value that uniquely identifies the database. For example: @@ -554,7 +543,6 @@ If you don't use this parameter, the archive is moved to the same database as th Type: DatabaseIdParameter Parameter Sets: MigrationRemote, MigrationLocal, MigrationRemoteCrossTenant Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -564,19 +552,21 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. In Exchange 2010, if you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -586,13 +576,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter specifies a descriptive name for moving a batch of mailboxes. You can then use the name in the BatchName parameter as a search string when you use the Get-MoveRequest cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -602,6 +594,9 @@ Accept wildcard characters: False ``` ### -CompleteAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -617,7 +612,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -627,13 +621,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit -The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The CompletedRequestAgeLimit parameter specifies how long the request are kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -643,6 +639,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -652,7 +651,6 @@ 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 Required: False Position: Named @@ -662,6 +660,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -670,7 +671,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -680,6 +680,9 @@ Accept wildcard characters: False ``` ### -DoNotPreserveMailboxSignature + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DoNotPreserveMailboxSignature switch specifies that the move doesn't preserve the mailbox mapping signature. You don't need to specify a value with this switch. @@ -690,7 +693,6 @@ We recommend that you use this switch only if the move request fails because the Type: SwitchParameter Parameter Sets: MigrationLocal Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -700,15 +702,17 @@ Accept wildcard characters: False ``` ### -ForceOffline + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForceOffline switch forces the mailbox move to be performed in offline mode. You don't need to specify a value with this switch. -Moving a mailbox in offline mode means the user will have no access to email during the mailbox move. +Moving a mailbox in offline mode means the user has no access to email during the mailbox move. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -718,6 +722,9 @@ Accept wildcard characters: False ``` ### -ForcePull + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ForcePull switch specifies that the type of local move should be a Pull move. You don't need to specify a value with this switch. @@ -728,7 +735,6 @@ You use this parameter only for local moves. Type: SwitchParameter Parameter Sets: MigrationLocal Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -738,6 +744,9 @@ Accept wildcard characters: False ``` ### -ForcePush + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ForcePush switch specifies that the type of local move should be a Push move. You don't need to specify a value with this switch. @@ -748,7 +757,6 @@ You use this parameter only for local moves. Type: SwitchParameter Parameter Sets: MigrationLocal Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -758,6 +766,9 @@ Accept wildcard characters: False ``` ### -IgnoreRuleLimitErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013 The IgnoreRuleLimitErrors switch specifies that the command doesn't move the user's rules to the target server running Exchange. You don't need to specify a value with this switch. @@ -766,7 +777,6 @@ The IgnoreRuleLimitErrors switch specifies that the command doesn't move the use Type: SwitchParameter Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy, MigrationLocal Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -776,7 +786,10 @@ Accept wildcard characters: False ``` ### -IncrementalSyncInterval -The IncrementalSyncInterval parameter specifies the wait time between incremental syncs. This parameter is used together with the CompleteAfter parameter to create a move request that will do periodic incremental syncs after the initial sync is complete. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The IncrementalSyncInterval parameter specifies the wait time between incremental syncs. Use this parameter with the CompleteAfter parameter to create a move request that does periodic incremental syncs after the initial sync is complete. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -786,7 +799,6 @@ Valid values are from 00:00:00 to 120.00:00:00 (120 days). The default value is Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -796,6 +808,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -804,7 +819,6 @@ 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 Required: False Position: Named @@ -814,6 +828,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -825,13 +842,12 @@ Valid input for this parameter is an integer or the value unlimited. The default If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -841,6 +857,9 @@ Accept wildcard characters: False ``` ### -MoveOptions + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MoveOptions parameter specifies the stages of the move that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. Don't use this parameter with the SkipMoving parameter. @@ -849,7 +868,6 @@ Don't use this parameter with the SkipMoving parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -859,6 +877,9 @@ Accept wildcard characters: False ``` ### -MRSServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSServer parameter specifies the FQDN of the Client Access server on which the instance of the Microsoft Exchange Mailbox Replication service (MRS) is running. This parameter is used for debugging purposes only. Use this parameter only if directed by support personnel. @@ -867,7 +888,6 @@ The MRSServer parameter specifies the FQDN of the Client Access server on which Type: Fqdn Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy, MigrationLocal Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -877,6 +897,9 @@ Accept wildcard characters: False ``` ### -PreventCompletion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PreventCompletion switch specifies whether to run the move request, but not allow it to complete. You don't need to specify a value with this switch. Instead of this switch, we recommend using the CompleteAfter parameter. @@ -885,7 +908,6 @@ Instead of this switch, we recommend using the CompleteAfter parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -895,6 +917,9 @@ Accept wildcard characters: False ``` ### -PrimaryOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PrimaryOnly switch specifies that the command should only move the primary mailbox (the personal archive isn't moved). You don't need to specify a value with this switch. You use this switch only if the user has a personal archive that you don't want to move. If the user doesn't have personal archive, don't use this switch. @@ -905,7 +930,6 @@ You can't use this switch with the ArchiveOnly sitch. Type: SwitchParameter Parameter Sets: MigrationOutbound, MigrationRemote, MigrationLocal Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -915,6 +939,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -922,7 +949,7 @@ The Priority parameter specifies the order in which the request should be proces - Lowest - Lower - Low -- Normal: This is the default value. +- Normal: This value is the default. - High - Higher - Highest @@ -932,7 +959,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -942,6 +968,9 @@ Accept wildcard characters: False ``` ### -Protect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -950,7 +979,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -960,6 +988,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter specifies the move destination by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -979,7 +1010,6 @@ The ProxyToMailbox parameter specifies the move destination by the location of t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -989,6 +1019,9 @@ Accept wildcard characters: False ``` ### -RemoteArchiveTargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoteArchiveTargetDatabase parameter specifies the name of the target database in the remote forest to which you're moving the personal archive. Use this parameter when moving users with archives from the local forest to a remote forest. For moves from a remote forest to the local forest, use the ArchiveTargetDatabase parameter. If you use this parameter, you must specify the Remote or RemoteLegacy parameter. @@ -997,7 +1030,6 @@ If you use this parameter, you must specify the Remote or RemoteLegacy parameter Type: String Parameter Sets: MigrationOutbound Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1007,13 +1039,15 @@ Accept wildcard characters: False ``` ### -RemoteOrganizationName + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1023,6 +1057,9 @@ Accept wildcard characters: False ``` ### -RemoteTargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoteTargetDatabase parameter specifies the name of the target database in the remote forest. Use this parameter when moving mailboxes from the local forest to a remote forest. For moves from a remote forest to the local forest, use the TargetDatabase parameter. If you use this parameter, you must specify the Remote or RemoteLegacy parameter. @@ -1031,7 +1068,6 @@ If you use this parameter, you must specify the Remote or RemoteLegacy parameter Type: String Parameter Sets: MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1041,6 +1077,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -1054,7 +1093,6 @@ 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, Exchange Online Required: False Position: Named @@ -1064,7 +1102,10 @@ Accept wildcard characters: False ``` ### -SkipMoving -This parameter has been replaced by the MoveOptions parameter. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +This parameter is replaced by the MoveOptions parameter. The SkipMoving parameter specifies the stages of the move that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. @@ -1072,7 +1113,6 @@ The SkipMoving parameter specifies the stages of the move that you want to skip Type: SkippableMoveComponent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1082,6 +1122,9 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SourceEndpoint Description }} @@ -1090,7 +1133,6 @@ This parameter is available only in the cloud-based service. Type: MigrationEndpointIdParameter Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy, MigrationLocal, MigrationRemoteCrossTenant Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1100,6 +1142,9 @@ Accept wildcard characters: False ``` ### -StartAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -1115,7 +1160,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1125,15 +1169,17 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. -If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. +If you use this switch, the request is queued, but the request doesn't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1143,13 +1189,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1159,6 +1207,9 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendWhenReadyToComplete switch specifies whether to suspend the move request before it reaches the status of CompletionInProgress. You don't need to specify a value with this switch. Instead of this switch, we recommend that you use the CompleteAfter parameter. @@ -1167,7 +1218,6 @@ Instead of this switch, we recommend that you use the CompleteAfter parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1177,6 +1227,9 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The TargetDatabase parameter specifies the destination mailbox database for the mailbox. You can use any value that uniquely identifies the database. For example: @@ -1185,13 +1238,12 @@ The TargetDatabase parameter specifies the destination mailbox database for the - Distinguished name (DN) - GUID -If you don't use this parameter, the automatic distribution logic will select a random database in the Active Directory site where you are running the command. +If you don't use this parameter, the automatic distribution logic selects a random database in the Active Directory site where you are running the command. ```yaml Type: DatabaseIdParameter Parameter Sets: MigrationRemote, MigrationRemoteLegacy, MigrationLocal, MigrationRemoteCrossTenant Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1201,6 +1253,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. You can use this switch to test a mailbox's readiness to be moved, and to view any errors that will occur without adding the mailbox to the move request queue. @@ -1209,7 +1264,6 @@ You can use this switch to test a mailbox's readiness to be moved, and to view a Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1219,6 +1273,9 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1227,7 +1284,6 @@ This parameter is reserved for internal Microsoft use. Type: RequestWorkloadType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OMEConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/New-OMEConfiguration.md similarity index 86% rename from exchange/exchange-ps/exchange/New-OMEConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/New-OMEConfiguration.md index 8be7fb364c..1453b4cf91 100644 --- a/exchange/exchange-ps/exchange/New-OMEConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OMEConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-omeconfiguration applicable: Exchange Online -title: New-OMEConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-omeconfiguration +schema: 2.0.0 +title: New-OMEConfiguration --- # New-OMEConfiguration @@ -39,7 +40,7 @@ New-OMEConfiguration [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example creates a new OME configuration named "Contoso Marketing" with the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies a unique name for the OME configuration object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -69,11 +72,14 @@ Accept wildcard characters: False ``` ### -BackgroundColor + +> Applicable: Exchange Online + The BackgroundColor parameter specifies the background color. Valid values are: - An available HTML hexadecimal (hex triplet) color code value (for example, `0x000000` is white). - An available text value (for example, `yellow` is 0x00FFFF00). -- $null (blank). This is the default value. +- $null (blank). This value is the default. For more information, see [Add your organization's brand to your encrypted messages](https://learn.microsoft.com/purview/add-your-organization-brand-to-encrypted-messages). @@ -81,7 +87,6 @@ For more information, see [Add your organization's brand to your encrypted messa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -DisclaimerText + +> Applicable: Exchange Online + The DisclaimerText parameter specifies the disclaimer text in the email that contains the encrypted message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -EmailText + +> Applicable: Exchange Online + The EmailText parameter specifies the default text that accompanies encrypted email messages. The default text appears above the instructions for viewing encrypted messages. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -139,9 +150,12 @@ Accept wildcard characters: False ``` ### -ExternalMailExpiryInDays + +> Applicable: Exchange Online + This parameter is available only with a Microsoft 365 Advanced Message Encryption subscription. -The ExternalMailExpiryInDays parameter specifies the number of days that the encrypted message is available to external recipients in the Microsoft 365 portal. A valid value is an integer from 0 to 730. The value 0 means the messages will never expire. The default value is 0. +The ExternalMailExpiryInDays parameter specifies the number of days that the encrypted message is available to external recipients in the Microsoft 365 portal. A valid value is an integer from 0 to 730. The value 0 means the messages never expire. The default value is 0. In the output of the Get-OMEConfiguration cmdlet, the value of this parameter is displayed in the ExternalMailExpiryInterval property. @@ -149,7 +163,6 @@ In the output of the Get-OMEConfiguration cmdlet, the value of this parameter is Type: String Parameter Sets: Int32 Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -159,7 +172,10 @@ Accept wildcard characters: False ``` ### -Image -The Image parameter identifies and uploads an image that will be displayed in the email message and in the Microsoft 365 admin center. + +> Applicable: Exchange Online + +The Image parameter identifies and uploads an image that's displayed in the email message and in the Microsoft 365 admin center. 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`). @@ -171,7 +187,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -181,13 +196,15 @@ Accept wildcard characters: False ``` ### -IntroductionText + +> Applicable: Exchange Online + The IntroductionText parameter specifies the default text that accompanies encrypted email messages. The default text appears below the recipient email address for viewing the encrypted message. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -197,16 +214,18 @@ Accept wildcard characters: False ``` ### -OTPEnabled + +> Applicable: Exchange Online + The OTPEnabled parameter specifies whether to allow recipients to use a one-time passcode to view encrypted messages. Valid values are: -- $true: Recipients can use a one-time passcode to view encrypted messages. This is the default value. +- $true: Recipients can use a one-time passcode to view encrypted messages. This value is the default. - $false: Recipients can't use a one-time passcode to view encrypted messages. The recipient is required to sign in using a Microsoft 365 work or school account. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,13 +235,15 @@ Accept wildcard characters: False ``` ### -PortalText + +> Applicable: Exchange Online + The PortalText parameter specifies the text that appears at the top of the encrypted email viewing portal. The maximum length is 128 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -232,13 +253,15 @@ Accept wildcard characters: False ``` ### -PrivacyStatementUrl + +> Applicable: Exchange Online + {{ Fill PrivacyStatementUrl Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,13 +271,15 @@ Accept wildcard characters: False ``` ### -ReadButtonText + +> Applicable: Exchange Online + The ReadButtonText parameter specifies the text that appears on the "Read Message" button. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -264,16 +289,18 @@ Accept wildcard characters: False ``` ### -SocialIdSignIn + +> Applicable: Exchange Online + The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Microsoft 365 admin center using their own social network id (Google, Yahoo, etc). Valid values are: -- $true: Social network ID sign in is allowed. This is the default value. +- $true: Social network ID sign in is allowed. This value is the default. - $false: Social network ID sign in is not allowed. Whether the recipient can use a one-time passcode or their Microsoft 365 work or school account is controlled by the OTPEnabled parameter. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -283,13 +310,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-OabVirtualDirectory.md similarity index 79% rename from exchange/exchange-ps/exchange/New-OabVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-OabVirtualDirectory.md index 7732f3db5a..33a5604517 100644 --- a/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OabVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-oabvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-OabVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-oabvirtualdirectory +schema: 2.0.0 +title: New-OabVirtualDirectory --- # New-OabVirtualDirectory @@ -44,7 +45,7 @@ The New-OABVirtualDirectory cmdlet configures a web distribution point for an OA You have to manually create the file system folder on the server that hosts the OAB files. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example creates an OAB virtual directory on CASServer01 and configures the ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -67,7 +71,6 @@ 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 Required: False Position: Named @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,19 +98,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,16 +122,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,11 +143,14 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. -- Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. +- Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection fails. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -146,7 +158,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +167,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -PollInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PollInterval parameter specifies the time interval in minutes that the distribution service polls the offline address book generation server for updates. The default value is 480 minutes (8 hours). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,13 +239,15 @@ Accept wildcard characters: False ``` ### -Recovery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,16 +257,18 @@ Accept wildcard characters: False ``` ### -RequireSSL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireSSL parameter specifies whether the client connection to the virtual directory requires Secure Sockets Layer (SSL) encryption. Valid values are: -- $true: SSL encryption is required to connect to the virtual directory. This is the default value. +- $true: SSL encryption is required to connect to the virtual directory. This value is the default. - $false: SSL encryption isn't required to connect to the virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +278,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -266,7 +292,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,6 +301,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -287,7 +315,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,13 +324,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,13 +342,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/New-OfflineAddressBook.md similarity index 87% rename from exchange/exchange-ps/exchange/New-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/New-OfflineAddressBook.md index cc267ae497..b2ca657dd6 100644 --- a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OfflineAddressBook.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-offlineaddressbook -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-OfflineAddressBook -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-offlineaddressbook +schema: 2.0.0 +title: New-OfflineAddressBook --- # New-OfflineAddressBook ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-OfflineAddressBook cmdlet to create offline address books (OABs). @@ -43,7 +44,7 @@ New-OfflineAddressBook [-Name] -AddressLists Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name of the OAB. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -AddressLists + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AddressLists parameter specifies the address lists or global address lists that are included in the OAB. You can use any value that uniquely identifies the address list. For example: - Name @@ -119,7 +125,6 @@ You can find the identify values of address lists and global address lists by us Type: AddressBookBaseIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -129,6 +134,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -138,7 +146,6 @@ 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 Required: False Position: Named @@ -148,13 +155,15 @@ Accept wildcard characters: False ``` ### -DiffRetentionPeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DiffRetentionPeriod parameter specifies the number of days that the OAB difference files are stored on the server. Valid values are integers from 7 to 1825, or the value unlimited. The default value is 30. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -172,7 +184,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -GeneratingMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The GeneratingMailbox parameter specifies the arbitration mailbox where the OAB is generated. Specifically, the arbitration mailbox must contain the OrganizationCapabilityOABGen value for the PersistedCapability property. An arbitration mailbox with this capability is also known as an organization mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -205,7 +219,6 @@ A single organization mailbox can generate multiple OABs (you can use the same v Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,12 +228,15 @@ Accept wildcard characters: False ``` ### -GlobalWebDistributionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The GlobalWebDistributionEnabled parameter specifies whether all OAB virtual directories in the organization can accept requests to download the OAB. These locations are advertised by the Autodiscover service. Valid values are: - $true: Any OAB virtual directory in the organization can accept requests to download the OAB. You can't use this setting with the VirtualDirectories parameter. -- $false: Only the OAB virtual directories that are specified by the VirtualDirectories parameter accept requests to download the OAB. This is the default value. +- $false: Only the OAB virtual directories that are specified by the VirtualDirectories parameter accept requests to download the OAB. This value is the default. In Exchange 2013 CU7 or later, we recommend that you use the value $true for this parameter. The Client Access services on any Mailbox server can proxy incoming OAB download requests to the correct location. @@ -228,7 +244,6 @@ In Exchange 2013 CU7 or later, we recommend that you use the value $true for thi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,16 +253,18 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault parameter specifies whether the OAB is used by all mailboxes and mailbox databases that don't have an OAB specified. Valid values are: - $true: The OAB is the default OAB. -- $false: The OAB is isn't the default OAB. This is the default value. +- $false: The OAB is isn't the default OAB. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -257,6 +274,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabase + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The PublicFolderDatabase parameter specifies the public folder database that's used to distribute the OAB. You can use any value that uniquely identifies the database. For example: @@ -271,7 +291,6 @@ To use this parameter, the PublicFolderDistributionEnabled parameter must be set Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -281,6 +300,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDistributionEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The PublicFolderDistributionEnabled parameter specifies whether the OAB is distributed via public folders. If the value of the PublicFolderDistributionEnabled parameter is $true, the OAB is distributed via public folders. @@ -289,7 +311,6 @@ The PublicFolderDistributionEnabled parameter specifies whether the OAB is distr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -299,6 +320,9 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Schedule parameter specifies the interval for generating the OAB in Exchange 2010 or earlier. @@ -327,7 +351,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -337,6 +360,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -352,7 +378,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -362,12 +387,15 @@ Accept wildcard characters: False ``` ### -ShadowMailboxDistributionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ShadowMailboxDistributionEnabled parameter specifies whether a read only copy of the OAB (also known as a shadow copy) is distributed to all other OAB generation mailboxes (also known as organization mailboxes). This allows additional Mailbox servers to be endpoints for requests to download the OAB, which can help prevent users from downloading the OAB across slow WAN links. Valid values are: - $true: The OAB is distributed to all other organization mailboxes. -- $false: The OAB is isn't distributed to other organization mailboxes. This is the default value. +- $false: The OAB is isn't distributed to other organization mailboxes. This value is the default. The value of this parameter is only meaningful if you have multiple organization mailboxes, and is only beneficial in Exchange organizations that have multiple Active Directory sites. @@ -375,7 +403,6 @@ The value of this parameter is only meaningful if you have multiple organization Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -385,6 +412,9 @@ Accept wildcard characters: False ``` ### -SkipPublicFolderInitialization + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The SkipPublicFolderInitialization switch specifies whether to skip the immediate creation of the OAB public folders if you're creating an OAB that uses public folder distribution. You don't need to specify a value with this switch. @@ -395,7 +425,6 @@ The OAB isn't available for download until the next site folder maintenance cycl Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -405,6 +434,9 @@ Accept wildcard characters: False ``` ### -Versions + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Versions parameter specifies the OAB versions that are generated for client download. Valid values are: @@ -417,7 +449,6 @@ The Versions parameter specifies the OAB versions that are generated for client Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -427,6 +458,9 @@ Accept wildcard characters: False ``` ### -VirtualDirectories + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The VirtualDirectories parameter specifies the OAB virtual directories that accept requests to download the OAB. These locations are advertised in the Autodiscover service. @@ -449,7 +483,6 @@ In Exchange 2013 CU7 or later, we recommend that you set the GlobalWebDistributi Type: VirtualDirectoryIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -459,13 +492,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md b/exchange/exchange-ps/ExchangePowerShell/New-OnPremisesOrganization.md similarity index 82% rename from exchange/exchange-ps/exchange/New-OnPremisesOrganization.md rename to exchange/exchange-ps/ExchangePowerShell/New-OnPremisesOrganization.md index a8a5a4ed57..9acf6fb82a 100644 --- a/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OnPremisesOrganization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-onpremisesorganization applicable: Exchange Online, Exchange Online Protection -title: New-OnPremisesOrganization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-onpremisesorganization +schema: 2.0.0 +title: New-OnPremisesOrganization --- # New-OnPremisesOrganization @@ -31,9 +32,9 @@ New-OnPremisesOrganization [-Name] -HybridDomains ``` ## DESCRIPTION -The OnPremisesOrganization object represents an on-premises Microsoft Exchange organization configured for hybrid deployment with a Microsoft 365 organization. It's used with the Hybrid Configuration wizard and is typically created automatically when the hybrid deployment is initially configured by the wizard. Manual modification of this object may result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Microsoft 365 organization. +The OnPremisesOrganization object represents an on-premises Microsoft Exchange organization configured for hybrid deployment with a Microsoft 365 organization. It's used with the Hybrid Configuration wizard and is typically created automatically when the hybrid deployment is initially configured by the wizard. Manual modification of this object might result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Microsoft 365 organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example creates the OnPremisesOrganization object ExchangeMail in a Microso ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a friendly name for the on-premises Exchange organization object in the Microsoft 365 organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -HybridDomains -The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between a Microsoft 365 organization and an on-premises Exchange organization. The domains specified in this parameter must match the domains listed in the HybridConfiguration object for the on-premises Exchange organization configured by the Hybrid Configuration wizard. Multiple domains may be listed and must be separated by a comma, for example, "contoso.com, sales.contoso.com". + +> Applicable: Exchange Online, Exchange Online Protection + +The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between a Microsoft 365 organization and an on-premises Exchange organization. The domains specified in this parameter must match the domains listed in the HybridConfiguration object for the on-premises Exchange organization configured by the Hybrid Configuration wizard. Multiple domains might be listed and must be separated by a comma, for example, "contoso.com, sales.contoso.com". ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -InboundConnector -The InboundConnector parameter specifies the name of the inbound connector configured on the Microsoft Exchange Online Protection (EOP) service for a hybrid deployment configured with an on-premises Exchange organization. + +> Applicable: Exchange Online, Exchange Online Protection + +The InboundConnector parameter specifies the name of the inbound connector configured in Microsoft 365 for a hybrid deployment configured with an on-premises Exchange organization. ```yaml Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -95,13 +102,15 @@ Accept wildcard characters: False ``` ### -OrganizationGuid + +> Applicable: Exchange Online, Exchange Online Protection + The OrganizationGuid parameter specifies the globally unique identifier (GUID) of the on-premises Exchange organization object in the Microsoft 365 organization. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -111,13 +120,15 @@ Accept wildcard characters: False ``` ### -OutboundConnector + +> Applicable: Exchange Online, Exchange Online Protection + The OutboundConnector parameter specifies the name of the outbound connector configured on the EOP service for a hybrid deployment configured with an on-premises Exchange organization. ```yaml Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -127,13 +138,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -143,6 +156,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -152,7 +168,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -162,13 +177,15 @@ Accept wildcard characters: False ``` ### -OrganizationName + +> Applicable: Exchange Online, Exchange Online Protection + The OrganizationName parameter specifies the Active Directory object name of the on-premises Exchange organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -178,13 +195,15 @@ Accept wildcard characters: False ``` ### -OrganizationRelationship + +> Applicable: Exchange Online, Exchange Online Protection + The OrganizationRelationship parameter specifies the organization relationship configured by the Hybrid Configuration wizard on the Microsoft 365 organization as part of a hybrid deployment with an on-premises Exchange organization. This organization relationship defines the federated sharing features enabled on the Microsoft 365 organization. ```yaml Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -194,13 +213,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OrganizationRelationship.md b/exchange/exchange-ps/ExchangePowerShell/New-OrganizationRelationship.md similarity index 75% rename from exchange/exchange-ps/exchange/New-OrganizationRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/New-OrganizationRelationship.md index 8fe6d28c4a..2bacdcf096 100644 --- a/exchange/exchange-ps/exchange/New-OrganizationRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OrganizationRelationship.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-OrganizationRelationship -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-organizationrelationship +schema: 2.0.0 +title: New-OrganizationRelationship --- # New-OrganizationRelationship ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-OrganizationRelationship cmdlet to create organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments. @@ -50,7 +51,7 @@ New-OrganizationRelationship [-Name] -DomainNames ## DESCRIPTION Before you can create an organization relationship, you must first create a federation trust. For more information, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,7 +66,11 @@ Free/busy access is enabled. The requesting organization receives time, subject, and location information from the target organization. -This example attempts to automatically discover configuration information from the external organization by using the domain names provided in the Get-FederationInformation command. If you use this method to create your organization relationship, you must first ensure that you've created an organization identifier by using the Set-FederationOrganizationIdentifier cmdlet. +This example creates the organization relationship using only the domain name specified in the Get-FederationInformation command. + +Before you use this method to create an organization relationship, use the Get-FederatedOrganizationIdentifier cmdlet to verify you created an organization identifier using the Set-FederationOrganizationIdentifier cmdlet. Then you can add any additional domains used by the target organization. + +**Tip**: For information about changes made to the Get-FederationInformation cmdlet to improve security and privacy, see [Important Update to the Get-FederationInformation Cmdlet in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/important-update-to-the-get-federationinformation-cmdlet-in-exchange-online/4410095). ### Example 2 ```powershell @@ -87,13 +92,15 @@ The requesting organization only receives free/busy information with the time. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the organization relationship. The maximum length is 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -DomainNames + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DomainNames parameter specifies the SMTP domains of the external organization. You can specify multiple domains separated by commas (for example, "contoso.com","northamerica.contoso.com"), limited to 238 domains in one request. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -119,16 +128,18 @@ Accept wildcard characters: False ``` ### -ArchiveAccessEnabled -The ArchiveAccessEnabled parameter specifies whether the organization relationship has been configured to provide remote archive access. Valid values are: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + +The ArchiveAccessEnabled parameter specifies whether the organization relationship is configured to provide remote archive access. Valid values are: - $true: The external organization provides remote access to mailbox archives. -- $false: The external organization doesn't provide remote access to mailbox archives. This is the default value. +- $false: The external organization doesn't provide remote access to mailbox archives. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -147,7 +161,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -157,18 +170,20 @@ Accept wildcard characters: False ``` ### -DeliveryReportEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DeliveryReportEnabled parameter specifies whether Delivery Reports should be shared over the organization relationship. Valid values are: - $true: Delivery Reports should be shared over the organization relationship. This value means the organization has agreed to share all Delivery Reports with the external organization, and the organization relationship should be used to retrieve Delivery Report information from the external organization. -- $false: Delivery Reports shouldn't be shared over the organization relationship. This is the default value +- $false: Delivery Reports shouldn't be shared over the organization relationship. This value is the default -For message tracking to work in a cross-premises Exchange scenario, this parameter must be set to $true on both sides of the organization relationship. If the value of this parameter is set to $false on one or both sides of the organization relationship, message tracking between the organizations won't work in either direction. +For message tracking to work in a cross-premises Exchange scenario, this parameter must be set to $true on both sides of the organization relationship. If the value of this parameter is set to $false on one or both sides of the organization relationship, message tracking between the organizations doesn't work in either direction. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -178,6 +193,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -186,7 +204,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,16 +213,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether to enable the organization relationship. Valid values are: -- $true: The organization relationship is enabled. This is the default value. +- $true: The organization relationship is enabled. This value is the default. - $false: The organization relationship is disabled. This value completely stops sharing for the organization relationship. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,10 +234,13 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The FreeBusyAccessEnabled parameter specifies whether the organization relationship should be used to retrieve free/busy information from the external organization. Valid values are: - $true: Free/busy information is retrieved from the external organization. -- $false: Free/busy information isn't retrieved from the external organization. This is the default value. +- $false: Free/busy information isn't retrieved from the external organization. This value is the default. You control the free/busy access level and scope by using the FreeBusyAccessLevel and FreeBusyAccessScope parameters. @@ -226,7 +248,6 @@ You control the free/busy access level and scope by using the FreeBusyAccessLeve Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -236,6 +257,9 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization. Valid values are: - None: No free/busy access. @@ -248,7 +272,6 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: FreeBusyAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -258,7 +281,10 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessScope -The FreeBusyAccessScope parameter specifies a mail-enabled security group in the internal organization that contains users whose free/busy information is accessible by an external organization. You can use any value that uniquely identifies the group. For example: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + +The FreeBusyAccessScope parameter specifies an internal mail-enabled security group where member free/busy information is accessible by the external organization. For best performance, the group should have less than 10,000 members. You can use any value that uniquely identifies the group. For example: - Name - Distinguished name (DN) @@ -271,7 +297,6 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -281,6 +306,9 @@ Accept wildcard characters: False ``` ### -MailboxMoveCapability + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The MailboxMoveCapability parameter is used in cross-tenant mailbox migrations. Valid values are: @@ -296,7 +324,6 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MailboxMoveCapability Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -306,16 +333,18 @@ Accept wildcard characters: False ``` ### -MailboxMoveEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailboxMoveEnabled parameter specifies whether the organization relationship enables moving mailboxes to or from the external organization. Valid values are: - $true: Mailbox moves to or from the external organization are allowed. -- $false: Mailbox moves to or from the external organization aren't allowed. This is the default value. +- $false: Mailbox moves to or from the external organization aren't allowed. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -325,6 +354,9 @@ Accept wildcard characters: False ``` ### -MailboxMovePublishedScopes + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The MailboxMovePublishedScopes parameter is used in cross-tenant mailbox migrations to specify the mail-enabled security groups whose members are allowed to migrate. You can use any value that uniquely identifies the group. For example: @@ -342,7 +374,6 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -352,10 +383,13 @@ Accept wildcard characters: False ``` ### -MailTipsAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTipsAccessEnabled parameter specifies whether MailTips for users in this organization are returned over this organization relationship. Valid values are: - $true: MailTips for users in this organization are returned over the organization relationship. -- $false: MailTips for users in this organization aren't returned over the organization relationship. This is the default value. +- $false: MailTips for users in this organization aren't returned over the organization relationship. This value is the default. You control the MailTips access level by using the MailTipsAccessLevel parameter. @@ -363,7 +397,6 @@ You control the MailTips access level by using the MailTipsAccessLevel parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -373,11 +406,14 @@ Accept wildcard characters: False ``` ### -MailTipsAccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTipsAccessLevel parameter specifies the level of MailTips data that's externally shared over this organization relationship. This parameter can have the following values: - All: All MailTips are returned, but the recipients in the remote organization are considered external. For the Auto Reply MailTip, the external Auto Reply message is returned. -- Limited: Only those MailTips that could prevent a non-delivery report (NDR) or an Auto Reply are returned. Custom MailTips, the Large Audience MailTip, and Moderated Recipient MailTips won't be returned. -- None: No MailTips are returned to the remote organization. This is the default value. +- Limited: Only those MailTips that could prevent a non-delivery report (NDR) or an Auto Reply are returned. Custom MailTips, the Large Audience MailTip, and Moderated Recipient MailTips aren't returned. +- None: No MailTips are returned to the remote organization. This value is the default. This parameter is only meaningful when the MailTipsAccessEnabled parameter value is $true. @@ -385,7 +421,6 @@ This parameter is only meaningful when the MailTipsAccessEnabled parameter value Type: MailTipsAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -395,6 +430,9 @@ Accept wildcard characters: False ``` ### -MailTipsAccessScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTipsAccessScope parameter specifies a mail-enabled security group in the internal organization that contains users whose free/busy information is accessible by an external organization. You can use any value that uniquely identifies the group. For example: - Name @@ -418,7 +456,6 @@ This restriction only applies to mailboxes, mail users, and mail contacts. It do Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -428,6 +465,9 @@ Accept wildcard characters: False ``` ### -OAuthApplicationId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the application ID of the mailbox migration app that you consented to. For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). @@ -436,7 +476,6 @@ The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -446,13 +485,15 @@ Accept wildcard characters: False ``` ### -OrganizationContact + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationContact parameter specifies the email address that can be used to contact the external organization (for example, administrator@fourthcoffee.com). ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -462,16 +503,18 @@ Accept wildcard characters: False ``` ### -PhotosEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PhotosEnabled parameter specifies whether photos for users in the internal organization are returned over the organization relationship. Valid values are: - $true: Photos for users in this organization are returned over the organization relationship. -- $false: Photos for users in this organization aren't returned over the organization relationship. This is the default value. +- $false: Photos for users in this organization aren't returned over the organization relationship. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -481,13 +524,15 @@ Accept wildcard characters: False ``` ### -TargetApplicationUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TargetApplicationUri parameter specifies the target Uniform Resource Identifier (URI) of the external organization. The TargetApplicationUri parameter is specified by Exchange when requesting a delegated token for the external organization to fetch free and busy information, for example, mail.contoso.com. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -497,13 +542,15 @@ Accept wildcard characters: False ``` ### -TargetAutodiscoverEpr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, `https://contoso.com/autodiscover/autodiscover.svc/wssecurity`. Exchange uses the Autodiscover service to automatically detect the correct Exchange server endpoint to use for external requests. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -513,13 +560,15 @@ Accept wildcard characters: False ``` ### -TargetOwaURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TargetOwaURL parameter specifies the Outlook on the web (formerly Outlook Web App) URL of the external organization defined in the organization relationship. It's used for Outlook on the web redirection in a cross-premise Exchange scenario. Configuring this attribute enables users in the organization to use their current Outlook on the web URL to access Outlook on the web in the external organization. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -529,6 +578,9 @@ Accept wildcard characters: False ``` ### -TargetSharingEpr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services for the external organization. If you use this parameter, this URL is always used to reach the external Exchange server. The URL that's specified by the TargetAutodiscoverEpr parameter isn't used to locate the external Exchange server. @@ -537,7 +589,6 @@ If you use this parameter, this URL is always used to reach the external Exchang Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -547,13 +598,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OrganizationSegment.md b/exchange/exchange-ps/ExchangePowerShell/New-OrganizationSegment.md similarity index 96% rename from exchange/exchange-ps/exchange/New-OrganizationSegment.md rename to exchange/exchange-ps/ExchangePowerShell/New-OrganizationSegment.md index a8a7015875..ec027b30d2 100644 --- a/exchange/exchange-ps/exchange/New-OrganizationSegment.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OrganizationSegment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-organizationsegment applicable: Security & Compliance -title: New-OrganizationSegment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-organizationsegment +schema: 2.0.0 +title: New-OrganizationSegment --- # New-OrganizationSegment @@ -58,13 +59,15 @@ In this example, we defined a segment called LocalFTE that includes people who a ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the organization segment. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -UserGroupFilter + +> Applicable: Security & Compliance + The UserGroupFilter parameter uses OPATH filter syntax to specify the members of the organization segment. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"MemberOf -eq 'Engineering Department'"` or `"ExtensionAttribute1 -eq 'DayTrader'"`). - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -108,7 +116,6 @@ Use the same property for all of your segments, and verify that your segments do Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-OutboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-OutboundConnector.md similarity index 87% rename from exchange/exchange-ps/exchange/New-OutboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-OutboundConnector.md index 2121c66207..539c5c9b79 100644 --- a/exchange/exchange-ps/exchange/New-OutboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OutboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-outboundconnector applicable: Exchange Online, Exchange Online Protection -title: New-OutboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-outboundconnector +schema: 2.0.0 +title: New-OutboundConnector --- # New-OutboundConnector @@ -46,7 +47,7 @@ New-OutboundConnector [-Name] ## DESCRIPTION Outbound connectors send email messages to remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,13 +64,15 @@ This example creates the Outbound connector named Contoso Outbound Connector wit ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name for the connector. 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: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -79,10 +82,13 @@ Accept wildcard characters: False ``` ### -AllAcceptedDomains + +> Applicable: Exchange Online, Exchange Online Protection + The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: - $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. This setting requires OnPremises for the ConnectorType value. -- $false: The Outbound connector isn't used in hybrid organizations. This is the default value. +- $false: The Outbound connector isn't used in hybrid organizations. This value is the default. This parameter is effective only for OnPremises connectors. @@ -90,7 +96,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,20 +105,22 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. Valid values are: -- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This is the default value for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. +- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This value is the default for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. - $false: The connector isn't used for mail flow in hybrid organizations, so any cross-premises headers are removed from messages that flow through the connector. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -148,7 +160,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -158,9 +169,12 @@ Accept wildcard characters: False ``` ### -ConnectorSource + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorSource parameter specifies how the connector is created. Valid values are: -- Default: The connector is manually created. This is the default value when you use this cmdlet, and we recommend that you don't change this value. +- Default: The connector is manually created. This value is the default when you use this cmdlet, and we recommend that you don't change this value. - HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. - Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. @@ -168,7 +182,6 @@ The ConnectorSource parameter specifies how the connector is created. Valid valu Type: TenantConnectorSource Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid values are: - Partner: The connector services domains that are external to your organization. @@ -187,7 +203,6 @@ The ConnectorType parameter specifies a category for the domains that are servic Type: TenantConnectorType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -197,16 +212,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether to enable or disable the Outbound connector. Valid values are: -- $true: The connector is enabled. This is the default value. +- $true: The connector is enabled. This value is the default. - $false: The connector is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -216,10 +233,13 @@ Accept wildcard characters: False ``` ### -IsTransportRuleScoped + +> Applicable: Exchange Online, Exchange Online Protection + The IsTransportRuleScoped parameter specifies whether the Outbound connector is associated with a transport rule (also known as a mail flow rule). Valid values are: - $true: The connector is associated with a transport rule. -- $false: The connector isn't associated with a transport rule. This is the default value. +- $false: The connector isn't associated with a transport rule. This value is the default. You scope a transport rule to an Outbound connector by using the RouteMessageOutboundConnector parameter on the New-TransportRule or Set-TransportRule cmdlets. Messages that match the conditions of the transport rule are routed to their destinations by using the specified Outbound connector. @@ -227,7 +247,6 @@ You scope a transport rule to an Outbound connector by using the RouteMessageOut Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -237,13 +256,15 @@ Accept wildcard characters: False ``` ### -LinkForModifiedConnector + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,6 +274,9 @@ Accept wildcard characters: False ``` ### -RecipientDomains + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomains parameter specifies the domains that the Outbound connector routes mail to. You can specify multiple domains separated by commas. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. @@ -261,7 +285,6 @@ You can use a wildcard character to specify all subdomains of a specified domain Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -271,10 +294,13 @@ Accept wildcard characters: False ``` ### -RouteAllMessagesViaOnPremises + +> Applicable: Exchange Online, Exchange Online Protection + The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises email system in hybrid organizations. Valid values are: - $true: Messages are routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. -- $false: Messages aren't routed through the on-premises email system. This is the default value. +- $false: Messages aren't routed through the on-premises email system. This value is the default. This parameter is effective only for OnPremises connectors. @@ -282,7 +308,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -292,10 +317,13 @@ Accept wildcard characters: False ``` ### -SenderRewritingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SenderRewritingEnabled parameter specifies that all messages that normally qualify for SRS rewriting are rewritten for routing through the on-premises email system. Valid values are: - $true: Messages are rewritten by SRS as needed before being routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. -- $false: Messages aren't rewritten by SRS before being routed through the on-premises email system. This is the default value. +- $false: Messages aren't rewritten by SRS before being routed through the on-premises email system. This value is the default. This parameter is effective only for OnPremises connectors. @@ -303,7 +331,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,6 +340,9 @@ Accept wildcard characters: False ``` ### -SmartHosts + +> Applicable: Exchange Online, Exchange Online Protection + The SmartHosts parameter specifies the smart host that the Outbound connector uses to route mail. Valid values are: - FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record: For example, mail.contoso.com. @@ -327,7 +357,6 @@ This parameter is required if you use the value $false for the UseMxRecord param Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,16 +366,18 @@ Accept wildcard characters: False ``` ### -TestMode + +> Applicable: Exchange Online, Exchange Online Protection + The TestMode parameter specifies whether you want to enabled or disable test mode for the Outbound connector. Valid values are: - $true: Test mode is enabled. -- $false: Test mode is disabled. This is the default value. +- $false: Test mode is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -356,6 +387,9 @@ Accept wildcard characters: False ``` ### -TlsDomain + +> Applicable: Exchange Online, Exchange Online Protection + The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. A valid value for this parameter is an SMTP domain. Wildcards are supported to specify all subdomains of a domain (for example, \*.contoso.com), but you can't embed the wildcard character within the domain (for example, domain.\*.contoso.com). @@ -366,7 +400,6 @@ This parameter meaningful only when the TlsSettings value is DomainValidation. Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -376,18 +409,20 @@ Accept wildcard characters: False ``` ### -TlsSettings + +> Applicable: Exchange Online, Exchange Online Protection + The TlsSettings parameter specifies the TLS authentication level that's used for outbound TLS connections established by this Outbound connector. Valid values are: - EncryptionOnly: TLS is used only to encrypt the communication channel. No certificate authentication is performed. - CertificateValidation: TLS is used to encrypt the channel and certificate chain validation and revocation lists checks are performed. - DomainValidation: In addition to channel encryption and certificate validation, the Outbound connector also verifies that the FQDN of the target certificate matches the domain specified in the TlsDomain parameter. -- $null (blank): This is the default value. +- $null (blank): This value is the default. ```yaml Type: TlsAuthLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -397,16 +432,18 @@ Accept wildcard characters: False ``` ### -UseMXRecord + +> Applicable: Exchange Online, Exchange Online Protection + The UseMXRecord parameter enables or disables DNS routing for the connector. Valid values are: -- $true: The connector uses DNS routing (MX records in DNS) to deliver email. This is the default value. +- $true: The connector uses DNS routing (MX records in DNS) to deliver email. This value is the default. - $false: The connector delivers email to one or more smart hosts. This setting requires one or more smart hosts for the SmartHosts value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -416,13 +453,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/New-OutlookProtectionRule.md similarity index 78% rename from exchange/exchange-ps/exchange/New-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-OutlookProtectionRule.md index 871a1233f5..a315c1af86 100644 --- a/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-outlookprotectionrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-OutlookProtectionRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-outlookprotectionrule +schema: 2.0.0 +title: New-OutlookProtectionRule --- # New-OutlookProtectionRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS **Note**: This cmdlet is no longer supported in the cloud-based service. -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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-OutlookProtectionRule cmdlet to create a Microsoft Outlook protection rule. @@ -44,7 +45,7 @@ For more information, see [Outlook protection rules](https://learn.microsoft.com Outlook protection rules created without a condition apply to all messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,13 +59,15 @@ This example applies the AD RMS template named Template-Contoso to messages sent ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a name for the rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApplyRightsProtectionTemplate parameter specifies the AD RMS template to apply to the message. An AD RMS template can be specified using the template name. Use the Get-RMSTemplate cmdlet to retrieve templates from your AD RMS server. ```yaml Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -99,7 +107,6 @@ 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 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -117,7 +127,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter specifies whether the Outlook protection rules are enabled. New Outlook protection rules are enabled by default. To create a rule without enabling it, set the Enabled parameter to $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you create rules without any conditions (rules without conditions apply to all messages). @@ -151,7 +165,6 @@ Use this switch to hide the confirmation prompt when you create rules without an Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -161,13 +174,15 @@ Accept wildcard characters: False ``` ### -FromDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FromDepartment parameter specifies the sender's department as a condition. The user's department property is compared with the value specified. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -177,13 +192,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Priority parameter specifies whether to set the order of processing of Outlook protection rules. Rules with a lower priority value are executed first. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -193,6 +210,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SentTo parameter specifies one or more recipients as a rule condition. You can use any value that uniquely identifies the internal recipient. For example: - Name @@ -214,7 +234,6 @@ This parameter doesn't accept wildcard characters. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -224,6 +243,9 @@ Accept wildcard characters: False ``` ### -SentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SentToScope parameter specifies the message scope as a condition. You can use one of the following values: - InOrganization: This value is for messages sent to recipients within the organization. @@ -233,7 +255,6 @@ The SentToScope parameter specifies the message scope as a condition. You can us Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -243,13 +264,15 @@ Accept wildcard characters: False ``` ### -UserCanOverride + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UserCanOverride parameter specifies whether users can override actions taken by Outlook protection rules. By default, users can override actions taken by Outlook protection rules. When set to $false, the UserCanOverride parameter prevents the user from overriding the rule when sending the message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -259,13 +282,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OutlookProvider.md b/exchange/exchange-ps/ExchangePowerShell/New-OutlookProvider.md similarity index 80% rename from exchange/exchange-ps/exchange/New-OutlookProvider.md rename to exchange/exchange-ps/ExchangePowerShell/New-OutlookProvider.md index 8552c51259..c3553a8334 100644 --- a/exchange/exchange-ps/exchange/New-OutlookProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OutlookProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-outlookprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-OutlookProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-outlookprovider +schema: 2.0.0 +title: New-OutlookProvider --- # New-OutlookProvider @@ -31,7 +32,7 @@ New-OutlookProvider [-Name] ## DESCRIPTION The New-OutlookProvider cmdlet creates the AutoDiscoverConfig object under the Global Settings object in Active Directory and sets the attributes specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,13 +53,15 @@ This example creates the AutoDiscoverConfig object Autodiscover1 and the specifi ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter provides the common name of the AutoDiscoverConfig object. This can be a user-friendly name for identification. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -77,7 +83,6 @@ 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 Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-OwaMailboxPolicy.md similarity index 75% rename from exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-OwaMailboxPolicy.md index 4b789db3d6..af02008a4c 100644 --- a/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OwaMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-owamailboxpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-OwaMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-owamailboxpolicy +schema: 2.0.0 +title: New-OwaMailboxPolicy --- # New-OwaMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-OwaMailboxPolicy cmdlet to create Outlook on the web mailbox policies. @@ -32,9 +33,9 @@ New-OwaMailboxPolicy [-Name] ## DESCRIPTION Use the Set-OwaMailboxPolicy cmdlet to configure the new policy. -Changes to Outlook on the web mailbox polices may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). +Changes to Outlook on the web mailbox policies might take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,13 +49,15 @@ This example creates the Outlook on the web mailbox policy named Corporate. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a name for the new policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -73,7 +79,6 @@ 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 Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -91,7 +99,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IsDefault switch specifies whether the policy is the default policy. You don't need to specify a value with this switch. @@ -111,7 +121,6 @@ If another policy is currently set as the default, using this switch replaces th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-OwaVirtualDirectory.md similarity index 81% rename from exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-OwaVirtualDirectory.md index 703e02a8bd..e8751f9b9f 100644 --- a/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OwaVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-owavirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-OwaVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-owavirtualdirectory +schema: 2.0.0 +title: New-OwaVirtualDirectory --- # New-OwaVirtualDirectory @@ -44,7 +45,7 @@ New-OwaVirtualDirectory ## DESCRIPTION By default, when Exchange is installed, the Outlook on the web virtual directory owa is created in the default IIS website on the server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example creates the Outlook on the web virtual directory in an IIS website ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -66,7 +70,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -ApplicationRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ApplicationRoot parameter specifies the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -AppPoolId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AppPoolId parameter specifies the IIS application pool in which the virtual directory runs. We recommend that you leave this parameter at its default setting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -117,7 +127,6 @@ 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 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,19 +154,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,16 +178,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,10 +199,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication works, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -196,7 +214,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -ExternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalAuthenticationMethods parameter restricts the authentication methods that can be used to connect to the virtual directory from outside the firewall. Valid values are: - Adfs @@ -235,7 +255,6 @@ Although you can specify any of these values, whether or not the authentication Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,13 +264,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,13 +282,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is important when SSL is used. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,13 +300,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +318,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -304,7 +332,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -314,6 +341,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -325,7 +355,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -335,13 +364,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -351,13 +382,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PartnerApplication.md b/exchange/exchange-ps/ExchangePowerShell/New-PartnerApplication.md similarity index 83% rename from exchange/exchange-ps/exchange/New-PartnerApplication.md rename to exchange/exchange-ps/ExchangePowerShell/New-PartnerApplication.md index d0ef93326f..272bdff3c4 100644 --- a/exchange/exchange-ps/exchange/New-PartnerApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PartnerApplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-partnerapplication -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PartnerApplication -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-partnerapplication +schema: 2.0.0 +title: New-PartnerApplication --- # New-PartnerApplication @@ -59,7 +60,7 @@ You can configure partner applications such as Microsoft SharePoint to access Ex We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,13 +74,15 @@ This example creates a new HRApp partner application named HRApp. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a name for the partner application. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -ApplicationIdentifier + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApplicationIdentifier parameter specifies a unique application identifier for the partner application that uses an authorization server. When specifying a value for the ApplicationIdentifier parameter, you must also use the UseAuthServer parameter. ```yaml Type: String Parameter Sets: ACSTrustApplication Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -AuthMetadataUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuthMetadataUrl parameter specifies the URL that Exchange can retrieve the AuthMetadata document from for a partner application that doesn't use an authorization server. When specifying the AuthMetadataUrl parameter for a partner application, you can't specify the ApplicationIdentifier and UseAuthServer parameters. @@ -113,7 +121,6 @@ The AuthMetadataUrl parameter specifies the URL that Exchange can retrieve the A Type: String Parameter Sets: AuthMetadataUrl Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -AcceptSecurityIdentifierInformation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptSecurityIdentifierInformation parameter specifies whether Exchange should accept security identifiers (SIDs) from another trusted Active Directory forest for the partner application. By default, new partner applications are configured to not accept SIDs from another forest. If you're in deployment with a trusted forest, set the parameter to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -139,16 +148,18 @@ Accept wildcard characters: False ``` ### -AccountType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AccountType parameter specifies the type of Microsoft account that's required for the partner application. Valid values are: -- OrganizationalAccount (This is the default value) +- OrganizationalAccount (default value) - ConsumerAccount ```yaml Type: SupportedAccountType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -158,6 +169,9 @@ Accept wildcard characters: False ``` ### -ActAsPermissions + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -166,7 +180,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -176,6 +189,9 @@ Accept wildcard characters: False ``` ### -AppOnlyPermissions + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -184,7 +200,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -194,6 +209,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -203,7 +221,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -213,6 +230,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -221,7 +241,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -231,13 +250,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter specifies whether the partner application is enabled. By default, new partner applications are enabled. Set the parameter to $false to create the application configuration in a disabled state. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,6 +268,9 @@ Accept wildcard characters: False ``` ### -IssuerIdentifier + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -255,7 +279,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -265,13 +288,15 @@ Accept wildcard characters: False ``` ### -LinkedAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LinkedAccount parameter specifies a linked Active Directory user account for the application. Exchange evaluates Role Based Access Control (RBAC) permissions for the linked account when authorizing a token used to perform a task. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -281,6 +306,9 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Realm parameter specifies a security realm for the partner application. If the token is from a domain that's not an accepted domain, Exchange checks the realm specified in the token. In such a scenario, only tokens with the same realm specified in the partner application can access Exchange resources. @@ -289,7 +317,6 @@ The Realm parameter specifies a security realm for the partner application. If t Type: String Parameter Sets: ACSTrustApplication Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -299,6 +326,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. @@ -309,7 +339,6 @@ We don't recommend using this switch in a production environment. Type: SwitchParameter Parameter Sets: AuthMetadataUrl Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -319,13 +348,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-PhishSimOverridePolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-PhishSimOverridePolicy.md index 4d6de2ee03..fda8e38416 100644 --- a/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PhishSimOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-phishsimoverridepolicy applicable: Exchange Online -title: New-PhishSimOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-phishsimoverridepolicy +schema: 2.0.0 +title: New-PhishSimOverridePolicy --- # New-PhishSimOverridePolicy @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS 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 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). +Use the New-PhishSimOverridePolicy cmdlet to create non-Microsoft phishing simulation override policies that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -32,7 +33,7 @@ New-PhishSimOverridePolicy [-Name] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +47,15 @@ This example creates the phishing simulation override policy named PhishSimOverr ## PARAMETERS ### -Name -The Name parameter specifies the name for the phishing simulation override policy. Regardless of the value you specify, the name will be PhishSimOverridePolicy. + +> Applicable: Exchange Online + +The Name parameter specifies the name for the phishing simulation override policy. Regardless of the value you specify, the name is PhishSimOverridePolicy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -87,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -97,13 +104,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -113,16 +122,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,6 +143,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + 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. @@ -140,7 +154,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -150,6 +163,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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. @@ -158,7 +174,6 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PolicyTipConfig.md b/exchange/exchange-ps/ExchangePowerShell/New-PolicyTipConfig.md similarity index 82% rename from exchange/exchange-ps/exchange/New-PolicyTipConfig.md rename to exchange/exchange-ps/ExchangePowerShell/New-PolicyTipConfig.md index c32359ad77..8fbaed382c 100644 --- a/exchange/exchange-ps/exchange/New-PolicyTipConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PolicyTipConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-policytipconfig -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PolicyTipConfig -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-policytipconfig +schema: 2.0.0 +title: New-PolicyTipConfig --- # New-PolicyTipConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-PolicyTipConfig cmdlet to create custom Policy Tips in your organization. @@ -29,7 +30,7 @@ New-PolicyTipConfig [-Name] -Value ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example sets the informational URL in Policy Tips to the value `https://www ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the custom Policy Tip you want to modify. Valid input for this parameter is one of the following values: - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. @@ -65,7 +69,6 @@ There can be only one custom Policy Tip with the value Url for the Name paramete Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -Value + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Value parameter specifies the text that's displayed by the Policy Tip. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -100,7 +108,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -118,7 +128,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-PowerShellVirtualDirectory.md similarity index 81% rename from exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-PowerShellVirtualDirectory.md index fd597096d0..e81c361881 100644 --- a/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PowerShellVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-powershellvirtualdirectory -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-PowerShellVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-powershellvirtualdirectory +schema: 2.0.0 +title: New-PowerShellVirtualDirectory --- # New-PowerShellVirtualDirectory @@ -41,7 +42,7 @@ New-PowerShellVirtualDirectory [-Name] ## DESCRIPTION Although it's possible to create a Windows PowerShell virtual directory, we recommend that you only do so at the request of Microsoft Customer Service and Support. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example creates a Windows PowerShell virtual directory and configures it to ## PARAMETERS ### -Name -The Name parameter specifies the name of the new PowerShell virtual directory. The name you provide will have the name of the website it's created under appended to it. If the name you provide contains spaces, enclose the name in quotation marks ("). + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Name parameter specifies the name of the new PowerShell virtual directory. The name you provide has the name of the website it's created under appended to it. If the name you provide contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the PowerShell virtual directory. The valid values are $true and $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -96,7 +104,6 @@ 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 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,19 +131,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,16 +155,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,10 +176,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -175,7 +191,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,13 +200,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalUrl parameter specifies the external URL that the PowerShell virtual directory points to. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,13 +218,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalUrl parameter specifies the internal URL that the PowerShell virtual directory points to. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,13 +236,15 @@ Accept wildcard characters: False ``` ### -RequireSSL + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireSSL parameter specifies whether the PowerShell virtual directory should require that the client connection be made using Secure Sockets Layer (SSL). The valid values are $true and $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,6 +254,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -244,7 +268,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,6 +277,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -265,7 +291,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,13 +300,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -291,13 +318,15 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the PowerShell virtual directory. The valid values are $true and $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ProtectionAlert.md b/exchange/exchange-ps/ExchangePowerShell/New-ProtectionAlert.md similarity index 86% rename from exchange/exchange-ps/exchange/New-ProtectionAlert.md rename to exchange/exchange-ps/ExchangePowerShell/New-ProtectionAlert.md index 91713c3de6..f52a7470fb 100644 --- a/exchange/exchange-ps/exchange/New-ProtectionAlert.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ProtectionAlert.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-protectionalert applicable: Security & Compliance -title: New-ProtectionAlert -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-protectionalert +schema: 2.0.0 +title: New-ProtectionAlert --- # New-ProtectionAlert @@ -14,7 +15,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). @@ -67,6 +78,9 @@ This example creates an alert policy that triggers an alert whenever anyone in t ## PARAMETERS ### -Category + +> Applicable: Security & Compliance + The Category parameter specifies a category for the alert policy. Valid values are: - AccessGovernance @@ -84,7 +98,6 @@ When an activity occurs that matches the conditions of the alert policy, the ale Type: AlertRuleCategory Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -94,13 +107,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the alert policy. 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 @@ -110,13 +125,15 @@ Accept wildcard characters: False ``` ### -NotifyUser + +> Applicable: Security & Compliance + The NotifyUser parameter specifies the SMTP address of the user who receives notification messages for the alert policy. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -126,6 +143,9 @@ Accept wildcard characters: False ``` ### -ThreatType + +> Applicable: Security & Compliance + The ThreatType parameter specifies the type of activities that are monitored by the alert policy. Valid values are: - Activity @@ -139,7 +159,6 @@ You can't change this value after you create the alert policy. Type: ThreatAlertType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -149,17 +168,19 @@ Accept wildcard characters: False ``` ### -AggregationType + +> Applicable: Security & Compliance + The AggregationType parameter specifies the how the alert policy triggers alerts for multiple occurrences of monitored activity. Valid values are: - None: Alerts are triggered for every occurrence of the activity. -- SimpleAggregation: Alerts are triggered based on the volume of activity in a given time window (the values of the Threshold and TimeWindow parameters). This is the default value. -- AnomalousAggregation: Alerts are triggered when the volume of activity reaches unusual levels (greatly exceeds the normal baseline that's established for the activity). Note that it can take up to 7 days for Microsoft 365 to establish the baseline. During the baseline calculation period, no alerts are generated for the activity. +- SimpleAggregation: Alerts are triggered based on the volume of activity in a given time window (the values of the Threshold and TimeWindow parameters). This value is the default. +- AnomalousAggregation: Alerts are triggered when the volume of activity reaches unusual levels (greatly exceeds the normal baseline that's established for the activity). It can take up to 7 days for Microsoft 365 to establish the baseline. During the baseline calculation period, no alerts are generated for the activity. ```yaml Type: AlertAggregationType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -169,6 +190,9 @@ Accept wildcard characters: False ``` ### -AlertBy + +> Applicable: Security & Compliance + The AlertBy parameter specifies the scope for aggregated alert policies. Valid values are determined by the ThreatType parameter value: - Activity: Valid values are User or $null (blank, which is the default value). If you don't use the value User, the scope of the alert policy is the entire organization. @@ -176,11 +200,12 @@ The AlertBy parameter specifies the scope for aggregated alert policies. Valid v You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). +**Note**: This parameter is required to show entities in alerts. Without it, alerts trigger without showing entities. We strongly recommend specifying a value for this parameter. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -190,13 +215,15 @@ Accept wildcard characters: False ``` ### -AlertFor + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -206,13 +233,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -222,6 +251,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -231,7 +263,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -241,13 +272,15 @@ Accept wildcard characters: False ``` ### -CorrelationPolicyId + +> Applicable: Security & Compliance + {{ Fill CorrelationPolicyId Description }} ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -257,13 +290,15 @@ Accept wildcard characters: False ``` ### -CustomProperties + +> Applicable: Security & Compliance + {{ Fill CustomProperties Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -273,13 +308,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies descriptive text for the alert policy. 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 @@ -289,16 +326,18 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter enables or disables the alert policy. Valid values are: - $true: The alert policy is disabled. -- $false: The alert policy is enabled. This is the default value. +- $false: The alert policy is enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -308,6 +347,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Security & Compliance + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -366,7 +408,6 @@ Malware Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -376,13 +417,15 @@ Accept wildcard characters: False ``` ### -LogicalOperationName + +> Applicable: Security & Compliance + {{ Fill LogicalOperationName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -392,6 +435,9 @@ Accept wildcard characters: False ``` ### -NotificationCulture + +> Applicable: Security & Compliance + The NotificationCulture parameter specifies the language or locale that's used for notifications. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -400,7 +446,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -410,13 +455,15 @@ Accept wildcard characters: False ``` ### -NotificationEnabled + +> Applicable: Security & Compliance + {{ Fill NotificationEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -426,10 +473,13 @@ Accept wildcard characters: False ``` ### -NotifyUserOnFilterMatch + +> Applicable: Security & Compliance + The NotifyUserOnFilterMatch parameter specifies whether to trigger an alert for a single event when the alert policy is configured for aggregated activity. Valid values are: - $true: Even though the alert is configured for aggregated activity, a notification is triggered during a match for the activity (basically, an early warning). -- $false: Alerts are triggered according to the specified aggregation type. This is the default value. +- $false: Alerts are triggered according to the specified aggregation type. This value is the default. You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). @@ -437,7 +487,6 @@ You can't use this parameter when the AggregationType parameter value is None (a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -447,6 +496,9 @@ Accept wildcard characters: False ``` ### -NotifyUserSuppressionExpiryDate + +> Applicable: Security & Compliance + 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". @@ -455,7 +507,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -465,16 +516,18 @@ Accept wildcard characters: False ``` ### -NotifyUserThrottleThreshold -The NotifyUserThrottleThreshold parameter specifies the maximum number of notifications for the alert policy within the time period specified by the NotifyUserThrottleWindow parameter. Once the maximum number of notifications has been reached in the time period, no more notifications are sent for the alert. Valid values are: + +> Applicable: Security & Compliance + +The NotifyUserThrottleThreshold parameter specifies the maximum number of notifications for the alert policy within the time period specified by the NotifyUserThrottleWindow parameter. Once the maximum number of notifications is reached in the time period, no more notifications are sent for the alert. Valid values are: - An integer. -- The value $null. This is the default value (no maximum number of notifications for an alert). +- The value $null. This value is the default (no maximum number of notifications for an alert). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -484,16 +537,18 @@ Accept wildcard characters: False ``` ### -NotifyUserThrottleWindow + +> Applicable: Security & Compliance + The NotifyUserThrottleWindow parameter specifies the time interval in minutes that's used by the NotifyUserThrottleThreshold parameter. Valid values are: - An integer. -- The value $null. This is the default value (no interval for notification throttling). +- The value $null. This value is the default (no interval for notification throttling). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -503,6 +558,9 @@ Accept wildcard characters: False ``` ### -Operation + +> Applicable: Security & Compliance + The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. @@ -513,7 +571,6 @@ You can only use this parameter when the ThreatType parameter has the value Acti Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -523,13 +580,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypes + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -539,13 +598,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypesForCounting + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypesForCounting Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -555,13 +616,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypesThreshold + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypesThreshold Description }} ```yaml Type: System.UInt64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -571,9 +634,12 @@ Accept wildcard characters: False ``` ### -Severity + +> Applicable: Security & Compliance + The Severity parameter specifies the severity of the detection. Valid values are: -- Low (This is the default value) +- Low (default value) - Medium - High @@ -581,7 +647,6 @@ The Severity parameter specifies the severity of the detection. Valid values are Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -591,6 +656,9 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: Security & Compliance + The Threshold parameter specifies the number of detections that trigger the alert policy within the time period specified by the TimeWindow parameter. A valid value is an integer that's greater than or equal to 3. You can only use this parameter when the AggregationType parameter value is SimpleAggregation. @@ -599,7 +667,6 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -609,6 +676,9 @@ Accept wildcard characters: False ``` ### -TimeWindow + +> Applicable: Security & Compliance + The TimeWindow parameter specifies the time interval in minutes for number of detections specified by the Threshold parameter. A valid value is an integer that's greater than 60 (one hour). You can only use this parameter when the AggregationType parameter value is SimpleAggregation. @@ -617,7 +687,6 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -627,13 +696,15 @@ Accept wildcard characters: False ``` ### -UseCreatedDateTime + +> Applicable: Security & Compliance + {{ Fill UseCreatedDateTime Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -643,13 +714,15 @@ Accept wildcard characters: False ``` ### -VolumeThreshold + +> Applicable: Security & Compliance + {{ Fill VolumeThreshold Description }} ```yaml Type: System.UInt64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -659,13 +732,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-PublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolder.md similarity index 81% rename from exchange/exchange-ps/exchange/New-PublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/New-PublicFolder.md index 71c11a5ab5..736e45e5a7 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PublicFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-publicfolder +schema: 2.0.0 +title: New-PublicFolder --- # New-PublicFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-PublicFolder cmdlet to create a public folder with the specified name. @@ -33,7 +34,7 @@ New-PublicFolder [-Name] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,13 +69,15 @@ This example creates the public folder Support in the North\_America hierarchy p ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name for the public folder. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -93,7 +99,6 @@ 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 Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -111,7 +119,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -EformsLocaleId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the hierarchy public folder mailbox where you want this public folder created. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -154,7 +166,6 @@ The Mailbox parameter specifies the hierarchy public folder mailbox where you wa Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Path parameter specifies the location of the folder in the folder hierarchy, for example, \\Legal\\Cases. ```yaml Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Mailbox server where you want to create the new public folder. You can use any value that uniquely identifies the server. For example: @@ -195,7 +211,6 @@ If you don't use this parameter, the command is run on the local server if the s Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -205,13 +220,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabase.md similarity index 88% rename from exchange/exchange-ps/exchange/New-PublicFolderDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabase.md index 992f21daac..a22d12b805 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfolderdatabase applicable: Exchange Server 2010 -title: New-PublicFolderDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-publicfolderdatabase +schema: 2.0.0 +title: New-PublicFolderDatabase --- # New-PublicFolderDatabase @@ -33,7 +34,7 @@ New-PublicFolderDatabase [-Name] -Server ## DESCRIPTION The new database must be mounted after it's created. For more information about mounting databases, see [Mount a Database](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123587(v=exchg.141)). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example creates the public folder database PFDB01. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the name of the new public folder database. The name must be unique to your entire organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Mailbox server where you want to create the new public folder database. You can use any value that uniquely identifies the server. For example: - Name @@ -76,7 +82,6 @@ A server can have only one public folder database. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -EdbFilePath + +> Applicable: Exchange Server 2010 + The EdbFilePath parameter specifies the full path of the public folder database files. The default location is `%ExchangeInstallPath%Mailbox\\.edb` ```yaml Type: EdbFilePath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -137,13 +148,15 @@ Accept wildcard characters: False ``` ### -LogFolderPath + +> Applicable: Exchange Server 2010 + The LogFolderPath parameter specifies the folder location for log files. The default location is `%ExchangeInstallPath%Mailbox\`. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -153,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabaseRepairRequest.md similarity index 88% rename from exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabaseRepairRequest.md index 332ac3deec..b7047a7953 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabaseRepairRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfolderdatabaserepairrequest applicable: Exchange Server 2010 -title: New-PublicFolderDatabaseRepairRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-publicfolderdatabaserepairrequest +schema: 2.0.0 +title: New-PublicFolderDatabaseRepairRequest --- # New-PublicFolderDatabaseRepairRequest @@ -34,7 +35,7 @@ Public folders on the public folder database can still be accessed while the req After you begin the repair request, it can't be stopped unless you dismount the database. For more information, see [Dismount a Database](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123903(v=exchg.141)). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example only detects and reports on replication issues on public folder dat ## PARAMETERS ### -Database + +> Applicable: Exchange Server 2010 + The Database parameter specifies the public folder database that you want to repair. You can use any value that uniquely identifies the database. For example: - Name @@ -65,7 +69,6 @@ The Database parameter specifies the public folder database that you want to rep Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -CorruptionType + +> Applicable: Exchange Server 2010 + The CorruptionType parameter specifies the type of corruption that you want to detect and repair. The only available value is ReplState. ```yaml Type: PublicFolderDatabaseCorruptionType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -100,7 +108,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -DetectOnly + +> Applicable: Exchange Server 2010 + The DetectOnly switch specifies that you want this command to report errors, but not fix them. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMigrationRequest.md similarity index 84% rename from exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMigrationRequest.md index 8707577d81..9aaa4ac222 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfoldermigrationrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-PublicFolderMigrationRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-publicfoldermigrationrequest +schema: 2.0.0 +title: New-PublicFolderMigrationRequest --- # New-PublicFolderMigrationRequest @@ -49,7 +50,7 @@ New-PublicFolderMigrationRequest [[-Name] ] -SourceDatabase Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of the public folder migration request. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceDatabase parameter specifies the target database for the public folders. You can use any value that uniquely identifies the database. For example: - Name @@ -89,7 +95,6 @@ The SourceDatabase parameter specifies the target database for the public folder Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -107,7 +115,6 @@ 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 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -125,7 +135,6 @@ 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 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BatchName parameter specifies a descriptive name for the public folder migration batch. You can use the BatchName parameter as a search string when you use the Get-PublicFolderMigrationRequest cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,6 +180,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -176,7 +192,6 @@ 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 Required: False Position: Named @@ -186,6 +201,9 @@ Accept wildcard characters: False ``` ### -CSVData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CSVData parameter specifies the mapping file output generated by the PublicFoldertoMailboxMapGenerator.ps1 script. Use this parameter for local migrations. 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`). @@ -196,7 +214,6 @@ You can't use this parameter with the CSVStream parameter, but you need to use i Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -CSVStream + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CSVStream parameter specifies the mapping file output generated by the PublicFoldertoMailboxMapGenerator.ps1 script. Use this parameter for remote migrations. You can't use this parameter with the CSVData parameter, but you need to use it if you don't use CSVData parameter. @@ -214,7 +234,6 @@ You can't use this parameter with the CSVData parameter, but you need to use it Type: Stream Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,13 +243,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -240,13 +261,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -256,6 +279,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -271,7 +297,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,13 +306,15 @@ Accept wildcard characters: False ``` ### -MigrationMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,12 +324,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: - Lowest - Lower - Low -- Normal: This is the default value. +- Normal: This value is the default. - High - Higher - Highest @@ -312,7 +342,6 @@ 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 Required: False Position: Named @@ -322,6 +351,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -335,7 +367,6 @@ 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 Required: False Position: Named @@ -345,13 +376,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipMerging parameter specifies whether certain stages of a public folder migration are skipped for debugging purposes. Don't use this parameter unless directed to do so by a Microsoft Customer Service and Support or specific documentation. ```yaml Type: SkippableMergeComponent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -361,13 +394,15 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -377,15 +412,17 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. -If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. +If you use this switch, the request is queued, but the request doesn't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -395,13 +432,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -411,13 +450,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -427,13 +468,15 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: RequestWorkloadType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMoveRequest.md similarity index 78% rename from exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMoveRequest.md index 435cac68b3..49ddc0d274 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMoveRequest.md @@ -1,22 +1,23 @@ --- -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, Exchange Online -title: New-PublicFolderMoveRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-publicfoldermoverequest +schema: 2.0.0 +title: New-PublicFolderMoveRequest --- # New-PublicFolderMoveRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-PublicFolderMoveRequest cmdlet to begin the process of moving public folder contents between public folder mailboxes. Moving public folders only moves the physical contents of the public folder; it doesn't change the logical hierarchy. When the move request is completed, you must run the Remove-PublicFolderMoveRequest cmdlet to remove the request or wait until the time specified in the CompletedRequestAgeLimit parameter has passed. The request must be removed before you can run another move request. -Be aware that the target public folder mailbox will be locked while the move request is active. For more information, see the Description section. +Be aware that the target public folder mailbox wis locked while the move request is active. For more information, see the Description section. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -44,11 +45,11 @@ New-PublicFolderMoveRequest -Folders -TargetMailbox ``` ## DESCRIPTION -The New-PublicFolderMoveRequest cmdlet moves public folders from a source public folder mailbox to a target public folder mailbox. While the move request is active, the target public folder mailbox will be locked. As a result, public folders already residing in the target public folder mailbox will be inaccessible until the move request is complete. Therefore, before you begin the move request, you should ensure that no users are accessing public folder data in that target public folder mailbox. +The New-PublicFolderMoveRequest cmdlet moves public folders from a source public folder mailbox to a target public folder mailbox. While the move request is active, the target public folder mailbox is locked. As a result, public folders already residing in the target public folder mailbox are inaccessible until the move request is complete. Therefore, before you begin the move request, you should ensure that no users are accessing public folder data in that target public folder mailbox. To move the public folder mailbox to another mailbox database, use the New-MoveRequest cmdlet. To ensure that this folder is already in the target public folder mailbox, run the Update-PublicFolderMailbox cmdlet against the target public folder mailbox. You can only perform one move request at a time. You can also move public folders by using the Move-PublicFolderBranch.ps1 script. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,13 +81,15 @@ This example moves all public folders from public folder mailbox Pub1 to public ## PARAMETERS ### -Folders -The Folders parameter specifies the public folders that you want to move. If the public folder has child public folders, these child public folders won't be moved unless you explicitly state them in the command. You can move multiple public folders by separating them with a comma, for example, \\Dev\\CustomerEngagements,\\Dev\\RequestsforChange,\\Dev\\Usability. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The Folders parameter specifies the public folders that you want to move. If the public folder has child public folders, these child public folders aren't moved unless you explicitly state them in the command. You can move multiple public folders by separating them with a comma, for example, \\Dev\\CustomerEngagements,\\Dev\\RequestsforChange,\\Dev\\Usability. ```yaml Type: PublicFolderIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetMailbox parameter specifies the target public folder mailbox that you want to move the public folders to. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -113,7 +119,6 @@ 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, Exchange Online Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptLargeDataLoss switch specifies that the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -131,7 +139,6 @@ 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, Exchange Online Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -AllowLargeItems + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowLargeItems switch specifies that you can move large items only when they're encountered. You don't need to specify a value with this switch. Large items are email messages with a maximum of 1,023 attachments. @@ -149,7 +159,6 @@ 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, Exchange Online Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to be completed. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means that the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so that the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and then try the request again. @@ -167,7 +179,6 @@ 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, Exchange Online Required: False Position: Named @@ -177,13 +188,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit -The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has been completed before being automatically removed. The default value for this parameter is 30 days. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The CompletedRequestAgeLimit parameter specifies how long the request is kept after completion before being automatically removed. The default value for this parameter is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -202,7 +218,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -220,7 +238,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,13 +247,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,13 +265,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the public folder move request. If you don't specify a name, the default name is PublicFolderMove. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,6 +283,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Organization Description }} @@ -270,7 +294,6 @@ This parameter is available only in the cloud-based service. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 7 @@ -280,12 +303,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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: - Lowest - Lower - Low -- Normal: This is the default value. +- Normal: This value is the default. - High - Higher - Highest @@ -295,7 +321,6 @@ 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, Exchange Online Required: False Position: Named @@ -305,6 +330,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -318,7 +346,6 @@ 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, Exchange Online Required: False Position: Named @@ -328,15 +355,17 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. -If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. +If you use this switch, the request is queued, but the request doesn't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -346,13 +375,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -362,6 +393,9 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -372,7 +406,6 @@ After the move is suspended, it has a status of AutoSuspended. You can then manu Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -382,13 +415,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -398,13 +433,15 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WorkloadType parameter is reserved for internal Microsoft use. ```yaml Type: RequestWorkloadType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-QuarantinePermissions.md b/exchange/exchange-ps/ExchangePowerShell/New-QuarantinePermissions.md similarity index 86% rename from exchange/exchange-ps/exchange/New-QuarantinePermissions.md rename to exchange/exchange-ps/ExchangePowerShell/New-QuarantinePermissions.md index fc7ecd94ee..07e69cfb7f 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePermissions.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-QuarantinePermissions.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-quarantinepermissions applicable: Exchange Online, Exchange Online Protection -title: New-QuarantinePermissions -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-quarantinepermissions +schema: 2.0.0 +title: New-QuarantinePermissions --- # New-QuarantinePermissions @@ -38,7 +39,7 @@ New-QuarantinePermissions ## DESCRIPTION The default value for any parameters that you don't use is $false, so you only need to use parameters (permissions) that you want to set to $true. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,16 +73,18 @@ In the same PowerShell session, you can use `$FullAccess` for the _EndUserQuaran ## PARAMETERS ### -PermissionToAllowSender -The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are: + +> Applicable: Exchange Online, Exchange Online Protection + +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. +- $false: Allow sender isn't available for affected messages in quarantine. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -91,16 +94,18 @@ Accept wildcard characters: False ``` ### -PermissionToBlockSender + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are: - $true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine. -- $false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This is the default value. +- $false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 2 @@ -110,16 +115,18 @@ Accept wildcard characters: False ``` ### -PermissionToDelete + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are: - $true: Delete messages and Delete from quarantine are available for affected messages in quarantine. -- $false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This is the default value. +- $false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 3 @@ -129,10 +136,13 @@ Accept wildcard characters: False ``` ### -PermissionToDownload + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToDownload parameter specifies whether users are allowed to download messages from quarantine. Valid values are: - $true: The permission is enabled. -- $false: The permission is disabled. This is the default value. +- $false: The permission is disabled. This value is the default. 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. @@ -140,7 +150,6 @@ Currently, this value has no effect on the available actions in quarantine notif Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 4 @@ -150,16 +159,18 @@ Accept wildcard characters: False ``` ### -PermissionToPreview + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are: - $true: Preview message is available for affected messages in quarantine. -- $false: Preview message isn't available for affected messages in quarantine. This is the default value. +- $false: Preview message isn't available for affected messages in quarantine. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 5 @@ -169,6 +180,9 @@ Accept wildcard characters: False ``` ### -PermissionToRelease + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are: - $true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine. @@ -180,7 +194,6 @@ Don't set this parameter and the _PermissionToRequestRelease_ parameter to $true Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 6 @@ -190,6 +203,9 @@ Accept wildcard characters: False ``` ### -PermissionToRequestRelease + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are: - $true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine. @@ -201,7 +217,6 @@ Don't set this parameter and the _PermissionRelease_ parameter to $true. Set one Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 7 @@ -211,10 +226,13 @@ Accept wildcard characters: False ``` ### -PermissionToViewHeader + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToViewHeader parameter specifies whether users are allowed to view the message headers of quarantined messages. Valid values are: - $true: The permission is enabled. -- $false: The permission is disabled. This is the default value. +- $false: The permission is disabled. This value is the default. 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. @@ -222,7 +240,6 @@ Currently, this value has no effect on the available actions in quarantine notif Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 8 diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-QuarantinePolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/New-QuarantinePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-QuarantinePolicy.md index 1d12b70c98..6cfaa0b09b 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-QuarantinePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-quarantinepolicy applicable: Exchange Online, Exchange Online Protection -title: New-QuarantinePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-quarantinepolicy +schema: 2.0.0 +title: New-QuarantinePolicy --- # New-QuarantinePolicy @@ -50,7 +51,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,13 +67,15 @@ To assign Limited access permissions, use the value 27. To assign Full access pe ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the quarantine policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the quarantine policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -AdminNotificationFrequencyInDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -AdminNotificationLanguage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml @@ -121,7 +131,6 @@ Type: EsnLanguage Parameter Sets: (All) Aliases: Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -AdminNotificationsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -AdminQuarantinePermissionsList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -CustomDisclaimer + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -195,6 +212,9 @@ Accept wildcard characters: False ``` ### -EndUserQuarantinePermissions + +> Applicable: Exchange Online, Exchange Online Protection + **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. @@ -205,7 +225,6 @@ For example, run the following command to store the required permissions in a va Type: QuarantinePermissions Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +234,9 @@ Accept wildcard characters: False ``` ### -EndUserQuarantinePermissionsValue + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy. This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1): @@ -242,7 +264,6 @@ For custom permissions, get the binary value that corresponds to the permissions Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -252,6 +273,9 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. If you don't use this parameter, the default sender is quarantine@messaging.microsoft.com. @@ -260,7 +284,6 @@ If you don't use this parameter, the default sender is quarantine@messaging.micr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -270,6 +293,9 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserSpamNotificationFrequency parameter specifies how often quarantine notifications are sent to users. Valid values are: - 04:00:00 (4 hours) @@ -280,7 +306,6 @@ The EndUserSpamNotificationFrequency parameter specifies how often quarantine no Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -290,13 +315,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequencyInDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -306,6 +333,9 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLanguage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml @@ -313,7 +343,6 @@ Type: EsnLanguage Parameter Sets: (All) Aliases: Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,6 +352,9 @@ Accept wildcard characters: False ``` ### -EsnCustomSubject + +> Applicable: Exchange Online, Exchange Online Protection + The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications. You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. @@ -335,7 +367,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: MultiValuedProperty Parameter Sets: (All) Aliases: MultiValuedProperty -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -345,10 +376,13 @@ Accept wildcard characters: False ``` ### -ESNEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: - $true: Quarantine notifications are enabled. -- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value. +- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This value is the default. **Note**: If the value of this parameter is $true and the value of the EndUserQuarantinePermissionsValue parameter is 0 (No access where all permissions are turned off), users can see their messages in quarantine, but the only available action for the messages is **View message header**. @@ -356,7 +390,6 @@ The ESNEnabled parameter specifies whether to enable quarantine notifications (f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -366,16 +399,18 @@ Accept wildcard characters: False ``` ### -IncludeMessagesFromBlockedSenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- $false: Recipients don't get quarantine notifications for affected messages from blocked senders. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -385,13 +420,15 @@ Accept wildcard characters: False ``` ### -MultiLanguageCustomDisclaimer + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -401,13 +438,15 @@ Accept wildcard characters: False ``` ### -MultiLanguageSenderName + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -417,13 +456,15 @@ Accept wildcard characters: False ``` ### -MultiLanguageSetting + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -433,13 +474,15 @@ Accept wildcard characters: False ``` ### -OrganizationBrandingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -449,13 +492,15 @@ Accept wildcard characters: False ``` ### -QuarantineRetentionDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -465,6 +510,9 @@ Accept wildcard characters: False ``` ### -QuarantinePolicyType + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml @@ -472,7 +520,6 @@ Type: QuarantinePolicyType Parameter Sets: (All) Aliases: Accepted values: QuarantinePolicy, GlobalQuarantinePolicy -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ReceiveConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-ReceiveConnector.md similarity index 85% rename from exchange/exchange-ps/exchange/New-ReceiveConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-ReceiveConnector.md index a053087232..62c23c91b2 100644 --- a/exchange/exchange-ps/exchange/New-ReceiveConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ReceiveConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-receiveconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ReceiveConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-receiveconnector +schema: 2.0.0 +title: New-ReceiveConnector --- # New-ReceiveConnector @@ -383,7 +384,7 @@ On Mailbox servers, you can create Receive connectors in the Front End Transport For more information about Receive connector usage types, permission groups, and authentication methods, see [Receive connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/receive-connectors). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -401,13 +402,15 @@ It accepts incoming SMTP connections only from the IP range 192.168.0.1-192.168. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name for the Receive connector. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -417,6 +420,9 @@ Accept wildcard characters: False ``` ### -Bindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax `"IPv4Address:TCPPort","IPv6Address:TCPPort"`. You can specify an IPv4 address and port, an IPv6 address and port, or both. The IP address values 0.0.0.0 or `[::]` indicate that the Receive connector uses all available local IPv4 or all IPv6 addresses. You need to specify a valid local IP address from the network adapters of the Exchange server. If you specify an invalid local IP address, the Microsoft Exchange Transport service might fail to start when the service is restarted. @@ -439,9 +445,8 @@ The values for this parameter must satisfy one of the following uniqueness requi ```yaml Type: MultiValuedProperty -Parameter Sets: Custom, Internet, Partner +Parameter Sets: Custom, Internet, Partner, Internal, Client, UsageType Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -450,20 +455,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MultiValuedProperty -Parameter Sets: Internal, Client, UsageType -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Client -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Client The Client switch specifies the Client usage type for the Receive connector. You don't need to specify a value with this switch. This usage type assigns the following default permission groups and authentication methods: @@ -479,7 +474,6 @@ You can't use this switch with any other usage type parameters (Internal, Intern Type: SwitchParameter Parameter Sets: Client Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -489,6 +483,9 @@ Accept wildcard characters: False ``` ### -Internal + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Internal switch specifies the Internal usage type for the Receive connector. You don't need to specify a value with this switch. This usage type assigns the following default permission groups and authentication methods: @@ -504,7 +501,6 @@ You can't use this switch with any other usage type parameters (Client, Internet Type: SwitchParameter Parameter Sets: Internal Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -514,6 +510,9 @@ Accept wildcard characters: False ``` ### -Internet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Internet switch specifies the Internet usage type for the Receive connector. You don't need to specify a value with this switch. This usage type assigns the following default permission groups and authentication methods: @@ -529,7 +528,6 @@ You can't use this switch with any other usage type parameters (Client, Internal Type: SwitchParameter Parameter Sets: Internet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -539,6 +537,9 @@ Accept wildcard characters: False ``` ### -Partner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Partner switch specifies the Partner usage type for the Receive connector. You don't need to specify a value with this switch. This usage type assigns the following default permission groups and authentication methods: @@ -554,7 +555,6 @@ You can't use this switch with any other usage type parameters (Client, Internal Type: SwitchParameter Parameter Sets: Partner Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -564,6 +564,9 @@ Accept wildcard characters: False ``` ### -RemoteIPRanges + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoteIPRanges parameter specifies the remote IP addresses that the Receive connector accepts messages from. Valid values are: - Single IP address: For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11. @@ -591,9 +594,8 @@ You can't use this parameter with the Internet usage type (the default value is ```yaml Type: MultiValuedProperty -Parameter Sets: Custom, Partner, Internal, Client +Parameter Sets: Custom, Partner, Internal, Client, Internet, UsageType Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -602,20 +604,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MultiValuedProperty -Parameter Sets: Internet, UsageType -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Usage -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Usage The Usage parameter specifies the default permission groups and authentication methods that are assigned to the Receive connector. Valid values are: - Client @@ -645,7 +637,6 @@ You can't use this parameter with any other usage type switches (Client, Interna Type: UsageType Parameter Sets: UsageType Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -655,16 +646,18 @@ Accept wildcard characters: False ``` ### -AdvertiseClientSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AdvertiseClientSettings parameter specifies whether the SMTP server name, port number, and authentication settings for the Receive connector are displayed to users in the options of Outlook on the web. Valid values are: - $true: The SMTP values are displayed in Outlook on the web. Typically, you would only use this setting for a Receive connector with the usage type Client (authenticated SMTP connections on TCP port 587 for POP3 and IMAP4 clients). -- $false: The SMTP values are displayed in Outlook on the web. This is the default value. +- $false: The SMTP values are displayed in Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -674,6 +667,9 @@ Accept wildcard characters: False ``` ### -AuthMechanism + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AuthMechanism parameter specifies the advertised and accepted authentication mechanisms for the Receive connector. Valid values are: - None @@ -696,7 +692,6 @@ You can specify multiple values separated by commas, but some values have depend Type: AuthMechanisms Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -706,7 +701,10 @@ Accept wildcard characters: False ``` ### -AuthTarpitInterval -The AuthTarpitInterval parameter specifies the period of time to delay responses to failed authentication attempts from remote servers that may be abusing the connection. The default value is 5 seconds. + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The AuthTarpitInterval parameter specifies the period of time to delay responses to failed authentication attempts from remote servers that might be abusing the connection. The default value is 5 seconds. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -718,7 +716,6 @@ You can configure the delay for other SMTP failure responses by using the Tarpit Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -728,6 +725,9 @@ Accept wildcard characters: False ``` ### -Banner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Banner parameter specifies a custom SMTP 220 banner that's displayed to remote messaging servers that connect to the Receive connector. When you specify a value, enclose the value in quotation marks, and start the value with 220 (the default "Service ready" SMTP response code). The default value of this parameter is blank ($null), which uses the following SMTP banner: @@ -738,7 +738,6 @@ The default value of this parameter is blank ($null), which uses the following S Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -748,9 +747,12 @@ Accept wildcard characters: False ``` ### -BinaryMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BinaryMimeEnabled parameter specifies whether the BINARYMIME Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: BINARYMIME is enabled and is advertised in the EHLO response. This setting requires that the ChunkingEnabled parameter is also set to the value $true. This is the default value. +- $true: BINARYMIME is enabled and is advertised in the EHLO response. This setting requires that the ChunkingEnabled parameter is also set to the value $true. This value is the default. - $false: BINARYMIME is disabled and isn't advertised in the EHLO response. The binary MIME extension is defined in RFC 3030. @@ -759,7 +761,6 @@ The binary MIME extension is defined in RFC 3030. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -769,9 +770,12 @@ Accept wildcard characters: False ``` ### -ChunkingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ChunkingEnabled parameter specifies whether the CHUNKING Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: CHUNKING is enabled and is advertised in the EHLO response. This is the default value. +- $true: CHUNKING is enabled and is advertised in the EHLO response. This value is the default. - $false: CHUNKING is disabled and isn't advertised in the EHLO response. Chunking is defined in RFC 3030. @@ -780,7 +784,6 @@ Chunking is defined in RFC 3030. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -790,13 +793,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -806,6 +811,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -815,7 +823,6 @@ 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 Required: False Position: Named @@ -825,6 +832,9 @@ Accept wildcard characters: False ``` ### -ConnectionInactivityTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectionInactivityTimeout parameter specifies the maximum amount of idle time before a connection to the Receive connector is closed. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -839,7 +849,6 @@ The value of this parameter must be less than the value of the ConnectionTimeout Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -849,6 +858,9 @@ Accept wildcard characters: False ``` ### -ConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectionTimeout parameter specifies the maximum time that the connection to the Receive connector can remain open, even if the connection is actively transmitting data. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -863,7 +875,6 @@ The value of this parameter must be greater than the value of the ConnectionInac Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -873,6 +884,9 @@ Accept wildcard characters: False ``` ### -Custom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Custom switch specifies the Custom usage type for the Receive connector. You don't need to specify a value with this switch. This usage type assigns the following default permission groups and authentication methods: @@ -882,7 +896,7 @@ This usage type assigns the following default permission groups and authenticati When you use this switch, you also need to use the Bindings and RemoteIPRanges parameters. -If you don't also use the PermissionGroups parameter to assign at least one permission group, you'll need to use the PermissionGroups parameter on the Set-ReceiveConnector cmdlet after you create the Receive connector (otherwise, the Receive connector can't accept inbound SMTP connections). +If you don't also use the PermissionGroups parameter to assign at least one permission group, you need to use the PermissionGroups parameter on the Set-ReceiveConnector cmdlet after you create the Receive connector (otherwise, the Receive connector can't accept inbound SMTP connections). You can't use this switch with any other usage type parameters (Client, Internal, Internet, Partner, or Usage). @@ -890,7 +904,6 @@ You can't use this switch with any other usage type parameters (Client, Internal Type: SwitchParameter Parameter Sets: Custom Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -900,6 +913,9 @@ Accept wildcard characters: False ``` ### -DefaultDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DefaultDomain parameter specifies the default accepted domain to use for the Exchange organization. You can use any value that uniquely identifies the accepted domain. For example: - Name @@ -916,7 +932,6 @@ Although you can configure any accepted domain as the default domain, you typica Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -926,9 +941,12 @@ Accept wildcard characters: False ``` ### -DeliveryStatusNotificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeliveryStatusNotificationEnabled parameter specifies whether the DSN (delivery status notification) Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: DSN is enabled and is advertised in the EHLO response. This is the default value. +- $true: DSN is enabled and is advertised in the EHLO response. This value is the default. - $false: DSN is disabled and isn't advertised in the EHLO response. Delivery status notifications are defined in RFC 3461. @@ -937,7 +955,6 @@ Delivery status notifications are defined in RFC 3461. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -947,6 +964,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -955,7 +975,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -965,12 +984,15 @@ Accept wildcard characters: False ``` ### -DomainSecureEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainSecureEnabled parameter specifies whether to enable or disable mutual Transport Layer Security (TLS) authentication (also known as Domain Secure) for the domains that are serviced by the Receive connector. Valid values are: - $true: Mutual TLS authentication is enabled. - $false: Mutual TLS authentication is disabled. -Note that setting this parameter to the value $true is only part of the requirements for enabling mutual TLS authentication: +Setting this parameter to the value $true is only part of the requirements for enabling mutual TLS authentication: - The AuthMechanism parameter must contain the value Tls, and can't contain the value ExternalAuthoritative. - The domain that's used for mutual TLS authentication must be configured in the following locations: @@ -982,7 +1004,6 @@ Note that setting this parameter to the value $true is only part of the requirem Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -992,9 +1013,12 @@ Accept wildcard characters: False ``` ### -EightBitMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EightBitMimeEnabled parameter specifies whether the 8BITMIME Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: 8BITMIME is enabled and is advertised in the EHLO response. This is the default value. +- $true: 8BITMIME is enabled and is advertised in the EHLO response. This value is the default. - $false: 8BITMIME is disabled and isn't advertised in the EHLO response. 8-bit data transmission is defined in RFC 6152. @@ -1003,7 +1027,6 @@ The EightBitMimeEnabled parameter specifies whether the 8BITMIME Extended SMTP e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1013,6 +1036,9 @@ Accept wildcard characters: False ``` ### -EnableAuthGSSAPI + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnableAuthGSSAPI parameter enables or disables Kerberos when Integrated Windows authentication is available on the Receive connector (the AuthMechanism parameter contains the value Integrated). Valid values are: - $true: Kerberos is enabled. The Extended SMTP keyword AUTH GSSAPI NTLM is advertised in the EHLO response. Clients can use Kerberos or NTLM for Integrated Windows authentication. @@ -1024,7 +1050,6 @@ The Generic Security Services application programming interface (GSSAPI) is an I Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1034,16 +1059,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether to enable or disable the Receive connector. Valid values are: -- $true: The Receive connector is enabled. This is the default value. +- $true: The Receive connector is enabled. This value is the default. - $false: The Receive connector is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1053,9 +1080,12 @@ Accept wildcard characters: False ``` ### -EnhancedStatusCodesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnhancedStatusCodesEnabled parameter specifies whether the ENHANCEDSTATUSCODES Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: ENHANCEDSTATUSCODES is enabled and is advertised in the EHLO response. This is the default value. +- $true: ENHANCEDSTATUSCODES is enabled and is advertised in the EHLO response. This value is the default. - $false: ENHANCEDSTATUSCODES is disabled and isn't advertised in the EHLO response. Enhanced status codes are defined in RFC 2034. @@ -1064,7 +1094,6 @@ Enhanced status codes are defined in RFC 2034. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1074,9 +1103,12 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionPolicy parameter specifies how Extended Protection for Authentication is implemented on the Receive connector. Valid values are: -- None: Extended Protection for Authentication isn't used. This is the default value. +- None: Extended Protection for Authentication isn't used. This value is the default. - Allow: Extended Protection for Authentication is used only if the connecting host supports it. Otherwise, connections are established without Extended Protection for Authentication. - Require: Extended Protection for Authentication is required for all incoming connections to this Receive connector. If the connecting host doesn't support Extended Protection for Authentication, the connection is rejected. @@ -1086,7 +1118,6 @@ Extended Protection for Authentication enhances the protection and handling of c Type: ExtendedProtectionPolicySetting Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1096,6 +1127,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Fqdn parameter specifies the destination FQDN that's shown to connected messaging servers. This value is used in the following locations: - In the default SMTP banner of the Receive connector. @@ -1109,7 +1143,6 @@ The default value is the FQDN of theExchange server that contains the Receive co Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1119,10 +1152,13 @@ Accept wildcard characters: False ``` ### -LongAddressesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LongAddressesEnabled parameter specifies whether the Receive connector accepts long X.400 email addresses. The X.400 email addresses are encapsulated in SMTP email addresses by using the Internet Mail Connector Encapsulated Address (IMCEA) encapsulation method. Valid values are - $true: X.400 email addresses can be up to 1,860 characters long after IMCEA encapsulation. -- $false: The maximum length of a complete SMTP email address is 571 characters. This is the default value. +- $false: The maximum length of a complete SMTP email address is 571 characters. This value is the default. When you set this parameter to the value $true, the following changes are made to the Receive connector: @@ -1136,7 +1172,6 @@ You can only configure this parameter on Receive connectors in the Transport ser Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1146,9 +1181,12 @@ Accept wildcard characters: False ``` ### -MaxAcknowledgementDelay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 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. +The MaxAcknowledgementDelay parameter specifies the maximum period the transport server delays acknowledgment until it verifies that the message is successfully delivered to all recipients. When receiving messages from a host that doesn't support shadow redundancy, an Exchange Server 2010 transport server delays issuing an acknowledgment until it verifies that the message is successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server times 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. @@ -1158,7 +1196,6 @@ The default value is 30 seconds. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1168,6 +1205,9 @@ Accept wildcard characters: False ``` ### -MaxHeaderSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxHeaderSize parameter specifies the maximum size of the SMTP message header before the Receive connector closes the connection. The default value is 256 kilobytes (262144 bytes). When you enter a value, qualify the value with one of the following units: @@ -1177,7 +1217,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is from 1 to 2147483647 bytes. @@ -1185,7 +1225,6 @@ A valid value is from 1 to 2147483647 bytes. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1195,6 +1234,9 @@ Accept wildcard characters: False ``` ### -MaxHopCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxHopCount parameter specifies the maximum number of hops that a message can take before the message is rejected by the Receive connector. The maximum number of hops is determined by the number of Received header fields that exist in a submitted message. A valid value is from 1 to 500. The default value is 30. @@ -1203,7 +1245,6 @@ A valid value is from 1 to 500. The default value is 30. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1213,6 +1254,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxInboundConnection parameter specifies the maximum number of inbound connections that this Receive connector serves at the same time. A valid value is from 1 to 2147483647, or the value unlimited. The default value is 5000. @@ -1223,7 +1267,6 @@ To disable the inbound connection limit on a Receive connector, enter a value of Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1233,6 +1276,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnectionPercentagePerSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxInboundConnectionPercentagePerSource parameter specifies the maximum number of connections that a Receive connector serves at the same time from a single IP address, expressed as the percentage of available remaining connections on a Receive connector. A valid value is from 1 to 100 without the percent sign (%). The default value is 2 percent. @@ -1241,7 +1287,6 @@ A valid value is from 1 to 100 without the percent sign (%). The default value i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1251,6 +1296,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnectionPerSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxInboundConnectionPerSource parameter specifies the maximum number of connections that this Receive connector serves at the same time from a single IP address. A valid value is from 1 to 10000, or the value unlimited. The default value is 20. @@ -1261,7 +1309,6 @@ To disable the inbound connection per source limit on a Receive connector, enter Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1271,6 +1318,9 @@ Accept wildcard characters: False ``` ### -MaxLocalHopCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxLocalHopCount parameter specifies the maximum number of local hops that a message can take before the message is rejected by the Receive connector. The maximum number of local hops is determined by the number of Received headers with local server addresses in a submitted message. A valid value is from 0 to 50. The default value is 8. @@ -1281,7 +1331,6 @@ When you specify the value 0, the message is never rejected based on the number Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1291,6 +1340,9 @@ Accept wildcard characters: False ``` ### -MaxLogonFailures + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxLogonFailures parameter specifies the number of logon failures that the Receive connector retries before it closes the connection. A valid value is from 0 to 10. The default value is 3. @@ -1301,7 +1353,6 @@ When you specify the value 0, the connection is never closed because of logon fa Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1311,6 +1362,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxMessageSize parameter specifies the maximum size of a message that's allowed through the Receive connector. The default value is 36 MB, which results in a realistic maximum message size of 25 MB. When you enter a value, qualify the value with one of the following units: @@ -1320,7 +1374,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value for this parameter is from 65536 to 2147483647 bytes. @@ -1330,7 +1384,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1340,6 +1393,9 @@ Accept wildcard characters: False ``` ### -MaxProtocolErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxProtocolErrors parameter specifies the maximum number of SMTP protocol errors that the Receive connector accepts before closing the connection. A valid value is from 0 to 2147483647, or the value unlimited. The default value is 5. @@ -1350,7 +1406,6 @@ When you specify the value unlimited, a connection is never closed because of pr Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1360,6 +1415,9 @@ Accept wildcard characters: False ``` ### -MaxRecipientsPerMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxRecipientsPerMessage parameter specifies the maximum number of recipients per message that the Receive connector accepts before closing the connection. A valid value is from 1 to 512000. The default value is 200. @@ -1368,7 +1426,6 @@ A valid value is from 1 to 512000. The default value is 200. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1378,6 +1435,9 @@ Accept wildcard characters: False ``` ### -MessageRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageRateLimit parameter specifies the maximum number of messages that can be sent by a single client IP address per minute. A valid value is from 1 to 2147483647, or the value unlimited. @@ -1390,7 +1450,6 @@ The default value for Receive connectors on Mailbox servers is unlimited. The de Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1400,6 +1459,9 @@ Accept wildcard characters: False ``` ### -MessageRateSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageRateSource parameter specifies how the message submission rate is calculated. Valid values are: - None: The message submission rate isn't calculated. @@ -1411,7 +1473,6 @@ The MessageRateSource parameter specifies how the message submission rate is cal Type: MessageRateSourceFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1421,10 +1482,13 @@ Accept wildcard characters: False ``` ### -OrarEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OrarEnabled parameter enables or disables Originator Requested Alternate Recipient (ORAR) on the Receive connector. Valid values are: - $true: ORAR is enabled and is advertised in the XORAR keyword in the EHLO response. The actual ORAR information is transmitted in the RCPT TO SMTP command. -- $false: ORAR is disabled and is isn't advertised in the EHLO response. This is the default value. +- $false: ORAR is disabled and is isn't advertised in the EHLO response. This value is the default. If the email address specified in the ORAR information is a long X.400 email address, you need to set the LongAddressesEnabled parameter to the value $true. @@ -1432,7 +1496,6 @@ If the email address specified in the ORAR information is a long X.400 email add Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1442,6 +1505,9 @@ Accept wildcard characters: False ``` ### -PermissionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PermissionGroups parameter specifies the well-known security principals who are authorized to use the Receive connector, and the permissions that are assigned to them. Valid values are: - None @@ -1462,7 +1528,6 @@ For more information about the default permissions and security principals for p Type: PermissionGroups Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1472,9 +1537,12 @@ Accept wildcard characters: False ``` ### -PipeliningEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PipeliningEnabled parameter specifies whether the PIPELINING Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: PIPELINING is enabled and is advertised in the EHLO response. This is the default value. +- $true: PIPELINING is enabled and is advertised in the EHLO response. This value is the default. - $false: PIPELINING is disabled and isn't advertised in the EHLO response. Pipelining is defined in RFC 2920. @@ -1483,7 +1551,6 @@ Pipelining is defined in RFC 2920. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1493,9 +1560,12 @@ Accept wildcard characters: False ``` ### -ProtocolLoggingLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProtocolLoggingLevel parameter specifies whether to enable or disable protocol logging for the Receive connector. Valid values are: -- None: Protocol logging is disabled on the Receive connector. This is the default value. +- None: Protocol logging is disabled on the Receive connector. This value is the default. - Verbose: Protocol logging is enabled on the Receive connector. For more information about protocol logging, see [Protocol logging](https://learn.microsoft.com/Exchange/mail-flow/connectors/protocol-logging). @@ -1504,7 +1574,6 @@ For more information about protocol logging, see [Protocol logging](https://lear Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1514,16 +1583,18 @@ Accept wildcard characters: False ``` ### -RejectReservedSecondLevelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectReservedSecondLevelRecipientDomains parameter specifies whether to reject connections that contain recipients in reserved second-level domains as specified in RFC 2606 (example.com, example.net, or example.org). Valid value are: - $true: RCPT TO commands that contain reserved second-level domains are rejected. -- $false: RCPT TO commands that contain reserved second-level domains aren't rejected. This is the default value. +- $false: RCPT TO commands that contain reserved second-level domains aren't rejected. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1533,16 +1604,18 @@ Accept wildcard characters: False ``` ### -RejectReservedTopLevelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectReservedTopLevelRecipientDomains parameter specifies whether to reject connections that contain recipients in reserved top-level domains (TLDs) as specified in RFC 2606 (.test, .example, .invalid, or .localhost). Valid value are: - $true: RCPT TO commands that contain reserved TLDs are rejected. -- $false: RCPT TO commands that contain reserved TLDs aren't rejected. This is the default value. +- $false: RCPT TO commands that contain reserved TLDs aren't rejected. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1552,16 +1625,18 @@ Accept wildcard characters: False ``` ### -RejectSingleLabelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectSingleLabelRecipientDomains parameter specifies whether to reject connections that contain recipients in single-label domains (for example, chris@contoso instead of chris@contoso.com). Valid values are: - $true: RCPT TO commands that contain single-label domains are rejected. -- $false: RCPT TO commands that contain single-label domains aren't rejected. This is the default value. +- $false: RCPT TO commands that contain single-label domains aren't rejected. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1571,16 +1646,18 @@ Accept wildcard characters: False ``` ### -RequireEHLODomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireEHLODomain parameter specifies whether the client must provide a domain name in the EHLO handshake after the SMTP connection is established. Valid values are: - $true: The client must provide a domain name in the EHLO handshake. If it doesn't, the SMTP connection is closed. -- $false: The client isn't required to provide a domain name in the EHLO handshake. This is the default value. +- $false: The client isn't required to provide a domain name in the EHLO handshake. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1590,16 +1667,18 @@ Accept wildcard characters: False ``` ### -RequireTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireTLS parameter specifies whether to require TLS transmission for inbound messages on the Receive connector. Valid values are: - $true: Inbound messages on the Receive connector require TLS transmission. -- $false: Inbound messages on the Receive connector don't require TLS transmission. This is the default value. +- $false: Inbound messages on the Receive connector don't require TLS transmission. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1609,6 +1688,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -1622,7 +1704,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1632,13 +1713,15 @@ Accept wildcard characters: False ``` ### -ServiceDiscoveryFqdn + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ServiceDiscoveryFqdn parameter specifies the service discovery fully-qualified domain name (FQDN) for the Receive connector. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1648,9 +1731,12 @@ Accept wildcard characters: False ``` ### -SizeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SizeEnabled parameter specifies how the SIZE Extended SMTP extension is used on the Receive connector. Valid values are: -- Enabled: SIZE is enabled and is advertised in the EHLO response along with the value of the MaxMessageSize parameter. If the size of the inbound message exceeds the specified value, the Receive connector closes the connection with an error code. This is the default value. +- Enabled: SIZE is enabled and is advertised in the EHLO response along with the value of the MaxMessageSize parameter. If the size of the inbound message exceeds the specified value, the Receive connector closes the connection with an error code. This value is the default. - Disabled: SIZE is disabled and isn't advertised in the EHLO response. - EnabledwithoutValue: SIZE is enabled and is advertised in the EHLO response, but the value of the MaxMessageSize parameter isn't disclosed in the EHLO response. This setting allows messages to bypass message size checks for authenticated connections between Mailbox servers. @@ -1660,7 +1746,6 @@ SIZE is defined in RFC 1870. Type: SizeMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1670,10 +1755,13 @@ Accept wildcard characters: False ``` ### -SuppressXAnonymousTls + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuppressXAnonymousTls parameter specifies whether the X-ANONYMOUSTLS Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: X-ANONYMOUSTLS is disabled and isn't advertised in the EHLO response. This setting also requires that you set the UseDownGradedExchangeServerAuth parameter to the value $true on the Set-TransportService cmdlet on the server. -- $false: X-ANONYMOUSTLS is enabled and is advertised in the EHLO response. This is the default value. +- $false: X-ANONYMOUSTLS is enabled and is advertised in the EHLO response. This value is the default. The X-ANONYMOUSTLS extension is important when the AuthMechanism parameter contains the value ExchangeServer. @@ -1681,7 +1769,6 @@ The X-ANONYMOUSTLS extension is important when the AuthMechanism parameter conta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1691,7 +1778,10 @@ Accept wildcard characters: False ``` ### -TarpitInterval -The TarpitInterval parameter specifies the amount of time to delay an SMTP response to a remote server that may be abusing the connection. The default value is 00:00:05 (5 seconds.). + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The TarpitInterval parameter specifies the amount of time to delay an SMTP response to a remote server that might be abusing the connection. The default value is 00:00:05 (5 seconds). To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1703,7 +1793,6 @@ You can configure the delay for authentication failure responses by using the Au Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1713,13 +1802,15 @@ Accept wildcard characters: False ``` ### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1729,6 +1820,9 @@ Accept wildcard characters: False ``` ### -TlsDomainCapabilities + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TlsDomainCapabilities parameter specifies the capabilities that the Receive connector makes available to specific hosts outside of the organization. Remote hosts are authenticated with TLS with certificate validation before these capabilities are offered. This parameter uses the following syntax: @@ -1750,7 +1844,6 @@ For example, `"contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptCloudServices Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1760,6 +1853,9 @@ Accept wildcard characters: False ``` ### -TransportRole + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportRole parameter specifies the transport service on the Mailbox server where the Receive connector is created. Valid values are: - FrontendTransport: The Front End Transport service where client or external SMTP connections occur. @@ -1769,7 +1865,6 @@ The TransportRole parameter specifies the transport service on the Mailbox serve Type: ServerRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1779,13 +1874,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RemoteDomain.md b/exchange/exchange-ps/ExchangePowerShell/New-RemoteDomain.md similarity index 79% rename from exchange/exchange-ps/exchange/New-RemoteDomain.md rename to exchange/exchange-ps/ExchangePowerShell/New-RemoteDomain.md index d482738214..3a98055162 100644 --- a/exchange/exchange-ps/exchange/New-RemoteDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RemoteDomain.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-remotedomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-RemoteDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-remotedomain +schema: 2.0.0 +title: New-RemoteDomain --- # New-RemoteDomain ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-RemoteDomain cmdlet to create a managed connection for a remote domain. When you create a remote domain, you can control mail flow with more precision, apply message formatting and messaging policies and specify acceptable character sets for messages sent to and received from the remote domain. @@ -29,7 +30,7 @@ New-RemoteDomain [-Name] -DomainName ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example creates the remote domain named Contoso for the domain contoso.com ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a unique name for the remote domain object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DomainName parameter specifies the SMTP domain that you want to establish as a remote domain. A valid value is an SMTP domain (for example, contoso.com). The maximum length is 256 characters. You can use the wildcard character (\*) to specify a domain and all subdomains (for example: \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com). @@ -67,7 +73,6 @@ You can use the wildcard character (\*) to specify a domain and all subdomains ( Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -77,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -86,7 +94,6 @@ 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 Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -106,7 +116,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/New-RemoteMailbox.md similarity index 84% rename from exchange/exchange-ps/exchange/New-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/New-RemoteMailbox.md index 2647a103bb..f6ce23c884 100644 --- a/exchange/exchange-ps/exchange/New-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-remotemailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-RemoteMailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-remotemailbox +schema: 2.0.0 +title: New-RemoteMailbox --- # New-RemoteMailbox @@ -157,7 +158,7 @@ Directory synchronization must be configured correctly for a mailbox to be creat The policies that you apply to recipients in the on-premises Exchange organization, such as Unified Messaging or compliance policies, aren't applied to mailboxes in the service. You must configure policies in the service if you want policies to be applied to recipients in the service. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -168,7 +169,7 @@ $Credentials = Get-Credential New-RemoteMailbox -Name "Kim Akers" -Password $Credentials.Password -UserPrincipalName kim@corp.contoso.com ``` -This example creates an on-premises mail user and its associated mailbox in the service. The remote routing address doesn't need to be specified because mail flow between the on-premises organization and the service has been configured. Using this configuration, the New-RemoteMailbox cmdlet automatically calculates the SMTP address of the mailbox to be used with the RemoteRoutingAddress parameter. This example also assumes directory synchronization has been configured. +This example creates an on-premises mail user and its associated mailbox in the service. The remote routing address doesn't need to be specified because mail flow between the on-premises organization and the service is configured. Using this configuration, the New-RemoteMailbox cmdlet automatically calculates the SMTP address of the mailbox to be used with the RemoteRoutingAddress parameter. This example also assumes directory synchronization is configured. The first command stores the password to use with the new remote mailbox in a variable by using the Get-Credential cmdlet. The last command creates the mail user. @@ -194,13 +195,15 @@ As in Example 1, this example assumes that mail flow and directory synchronizati ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name of the on-premises mail user and the associated mailbox in the service. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -210,13 +213,15 @@ Accept wildcard characters: False ``` ### -AccountDisabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AccountDisabled switch specifies whether to create the mail user in a disabled state. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AccountDisabled Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -226,6 +231,9 @@ Accept wildcard characters: False ``` ### -Equipment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox. You don't need to specify a value with this switch. Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers). @@ -236,7 +244,6 @@ You can't use this switch with the Room switch. Type: SwitchParameter Parameter Sets: Equipment Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -246,6 +253,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Password parameter specifies the password used by the mail user to secure his or her account and associated mailbox in the service. You can use the following methods as a value for this parameter: @@ -256,9 +266,8 @@ You can use the following methods as a value for this parameter: ```yaml Type: SecureString -Parameter Sets: AccountDisabled, Equipment, Room, Shared +Parameter Sets: Default, AccountDisabled, Equipment, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -267,20 +276,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecureString -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Room -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Room The Room switch specifies that the mailbox in the service should be created as a room resource mailbox. You don't need to specify a value with this switch. You can't use the Room switch if you specified the Equipment switch. @@ -289,7 +288,6 @@ You can't use the Room switch if you specified the Equipment switch. Type: SwitchParameter Parameter Sets: Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -299,6 +297,9 @@ Accept wildcard characters: False ``` ### -Shared + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + **Note**: This switch is available only in Exchange 2013 CU21 or later and Exchange 2016 CU10 or later. To use this switch, you also need to run setup.exe /PrepareAD. For more information, see [KB4133605](https://support.microsoft.com/help/4133605). The Shared switch specifies that the mailbox in the service should be created as a shared mailbox. You don't need to specify a value with this switch. @@ -309,7 +310,6 @@ You can't use this switch with the Room or Equipment switches. Type: SwitchParameter Parameter Sets: Shared Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -319,13 +319,15 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. ```yaml Type: String -Parameter Sets: AccountDisabled, Equipment, Room, Shared +Parameter Sets: Default, AccountDisabled, Equipment, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -334,27 +336,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -ACLableSyncedObjectEnabled -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -ACLableSyncedObjectEnabled The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -364,6 +355,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -388,7 +382,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -398,13 +391,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Archive switch specifies whether to also create an archive mailbox in the service. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -414,6 +409,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -423,7 +421,6 @@ 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 Required: False Position: Named @@ -433,6 +430,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisplayName parameter specifies the display name of the mail user and the associated mailbox in the service. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -441,7 +441,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -451,13 +450,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -467,13 +468,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -483,6 +486,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -491,7 +497,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -501,13 +506,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -517,13 +524,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -533,6 +542,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -550,7 +562,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -560,10 +571,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -571,7 +585,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -581,6 +594,9 @@ Accept wildcard characters: False ``` ### -OnPremisesOrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OnPremisesOrganizationalUnit parameter specifies the organizational unit (OU) in the on-premises organization in which the new mailbox is added (for example, redmond.contoso.com/Users). Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -596,7 +612,6 @@ This parameter has no effect on the mailbox in the service. Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -606,13 +621,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -622,9 +639,12 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. +- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This value is the default. - $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. @@ -635,7 +655,6 @@ A user's experience in any of these management interfaces is still controlled by Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -645,6 +664,9 @@ Accept wildcard characters: False ``` ### -RemoteRoutingAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoteRoutingAddress parameter specifies the SMTP address of the mailbox in the service that this user is associated with. This address is created automatically when the service is initially configured in the format of `.mail.onmicrosoft.com`. If you've configured mail flow between the on-premises organization and the service, such as in a hybrid deployment, you don't need to specify this parameter. The remote routing address is calculated automatically and assigned to the email address policy for the on-premises organization by the Hybrid Configuration wizard. @@ -653,7 +675,6 @@ If you've configured mail flow between the on-premises organization and the serv Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -663,16 +684,18 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResetPasswordOnNextLogon parameter specifies whether the user must change their password the next time they log on. Valid values are: - $true: The user is required to change their password the next time they log on. -- $false: The user isn't required to change their password the next time they log on. This is the default value. +- $false: The user isn't required to change their password the next time they log on. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -682,13 +705,15 @@ Accept wildcard characters: False ``` ### -SamAccountName -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -698,9 +723,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -710,7 +738,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -720,13 +747,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionPolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionPolicy.md index 6ae7128ad5..ed307ad3f4 100644 --- a/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-reportsubmissionpolicy applicable: Exchange Online -title: New-ReportSubmissionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-reportsubmissionpolicy +schema: 2.0.0 +title: New-ReportSubmissionPolicy --- # New-ReportSubmissionPolicy @@ -82,9 +83,9 @@ The report submission rule (\*-ReportSubmissionRule cmdlets) controls the email When you set the email address of the reporting mailbox in the Microsoft Defender portal at , the same email address is also set in the following parameters in the \*-ReportSubmissionPolicy cmdlets: - Microsoft integrated reporting using Microsoft reporting tools in Outlook: The ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses parameters. -- Microsoft integrated reporting using third-party tools in Outlook: The ThirdPartyReportAddresses parameter. +- Microsoft integrated reporting using non-Microsoft tools in Outlook: The ThirdPartyReportAddresses parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -132,22 +133,25 @@ New-ReportSubmissionPolicy -EnableReportToMicrosoft $false -EnableThirdPartyAddr New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub ``` -This example creates the report submission policy with the following values: reporting in Outlook is on and third-party reporting tools in Outlook are used to send reported messages to the specified reporting mailbox in Exchange Online. +This example creates the report submission policy with the following values: reporting in Outlook is on and non-Microsoft reporting tools in Outlook are used to send reported messages to the specified reporting mailbox in Exchange Online. ### Example 5 ```powershell New-ReportSubmissionPolicy -EnableReportToMicrosoft $false ``` -This example creates the report submission policy with the following values: reporting in Outlook is off. Microsoft reporting tools in Outlook are not available to users and messages reported by third-party tools in Outlook are not available on the Submissions page in the Microsoft Defender portal. +This example creates the report submission policy with the following values: reporting in Outlook is off. Microsoft reporting tools in Outlook are not available to users and messages reported by non-Microsoft tools in Outlook are not available on the Submissions page in the Microsoft Defender portal. ## PARAMETERS ### -DisableQuarantineReportingOption + +> Applicable: Exchange Online + The DisableQuarantineReportingOption parameter allows or prevents users from reporting messages in quarantine. Valid values are: - $true: Users can't report quarantined messages from quarantine. -- $false: Users can report quarantined messages from quarantine. This is the default value. +- $false: Users can report quarantined messages from quarantine. This value is the default. This parameter is meaningful only reporting in Outlook is enabled as described in the EnableReportToMicrosoft parameter. @@ -155,7 +159,6 @@ This parameter is meaningful only reporting in Outlook is enabled as described i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -165,13 +168,15 @@ Accept wildcard characters: False ``` ### -DisableUserSubmissionOptions + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -181,13 +186,15 @@ Accept wildcard characters: False ``` ### -EnableCustomizedMsg + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -197,10 +204,13 @@ Accept wildcard characters: False ``` ### -EnableCustomNotificationSender + +> Applicable: Exchange Online + The EnableCustomNotificationSender parameter specifies whether a custom sender email address is used for result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Use a custom Microsoft 365 sender email address. -- $false: Use the default sender email address. This is the default value. +- $false: Use the default sender email address. This value is the default. You specify the sender email address using the NotificationSenderAddress parameter. @@ -208,7 +218,6 @@ You specify the sender email address using the NotificationSenderAddress paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -218,6 +227,9 @@ Accept wildcard characters: False ``` ### -EnableOrganizationBranding + +> Applicable: Exchange Online + The EnableOrganizationBranding parameter specifies whether to show the company logo in the footer of result messages that users receive after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Use the company logo in the footer text instead of the Microsoft logo. @@ -229,7 +241,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -239,6 +250,9 @@ Accept wildcard characters: False ``` ### -EnableReportToMicrosoft + +> Applicable: Exchange Online + The EnableReportToMicrosoft parameter specifies whether Microsoft integrated reporting experience is enabled or disabled. Valid values are $true or $false. The value $true for this parameter enables reporting in Outlook. The following configurations are possible: @@ -249,7 +263,7 @@ The value $true for this parameter enables reporting in Outlook. The following c The value $false for this parameter disables reporting in Outlook. The following configurations are possible: - **Microsoft reporting tools are available in Outlook, but reported messages are sent only to the reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. -- **Reporting in Outlook is disabled. Microsoft reporting tools are not available in Outlook. Any messages reported by users in Outlook with third-party reporting tools aren't visible on the Submissions page in the Microsoft Defender portal**: The EnableThirdPartyAddress, ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. +- **Reporting in Outlook is disabled. Microsoft reporting tools are not available in Outlook. Any messages reported by users in Outlook with non-Microsoft reporting tools aren't visible on the Submissions page in the Microsoft Defender portal**: The EnableThirdPartyAddress, ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. This parameter is required to create the report submission policy only if you set the value to $false (the default value is $true). @@ -257,7 +271,6 @@ This parameter is required to create the report submission policy only if you se Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -267,10 +280,13 @@ Accept wildcard characters: False ``` ### -EnableThirdPartyAddress -The EnableThirdPartyAddress parameter specifies whether you're using third-party reporting tools in Outlook instead of Microsoft tools to send messages to the reporting mailbox in Exchange Online. Valid values are: -- $true: Reporting in Outlook is enabled, but third-party tools in Outlook send reported messages to the reporting mailbox in Exchange Online. You also need to set the EnableReportToMicrosoft parameter value to $false. To create the policy, use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. -- $false: Third-party reporting tools in Outlook aren't used. +> Applicable: Exchange Online + +The EnableThirdPartyAddress parameter specifies whether you're using non-Microsoft reporting tools in Outlook instead of Microsoft tools to send messages to the reporting mailbox in Exchange Online. Valid values are: + +- $true: Reporting in Outlook is enabled, but non-Microsoft 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: Non-Microsoft reporting tools in Outlook aren't used. This parameter is required to create the report submission policy only if you set the value to $true (the default value is $false). @@ -278,7 +294,6 @@ This parameter is required to create the report submission policy only if you se Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -288,6 +303,9 @@ Accept wildcard characters: False ``` ### -EnableUserEmailNotification + +> Applicable: Exchange Online + The EnableUserEmailNotification parameter species whether users receive result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Customized admin review result messages are sent. @@ -303,7 +321,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -313,6 +330,9 @@ Accept wildcard characters: False ``` ### -JunkReviewResultMessage + +> Applicable: Exchange Online + The JunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as junk. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -325,7 +345,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -335,6 +354,9 @@ Accept wildcard characters: False ``` ### -NotJunkReviewResultMessage + +> Applicable: Exchange Online + The NotJunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as not junk. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -347,7 +369,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -357,6 +378,9 @@ Accept wildcard characters: False ``` ### -NotificationFooterMessage + +> Applicable: Exchange Online + The NotificationFooterMessage parameter specifies the custom footer text to use in email notifications after an admin reviews and marks the reported messages as junk, not junk, or phishing. If the value contains spaces, enclose the value in quotation marks. You can use the EnableOrganizationBranding parameter to include your company logo in the message footer. @@ -367,7 +391,6 @@ This parameter is meaningful only when the value of the EnableUserEmailNotificat Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -377,6 +400,9 @@ Accept wildcard characters: False ``` ### -NotificationSenderAddress + +> Applicable: Exchange Online + The NotificationSenderAddress parameter specifies the sender email address to use in result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. The email address must be in Exchange Online. This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -385,7 +411,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -395,13 +420,15 @@ Accept wildcard characters: False ``` ### -NotificationsForCleanSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -411,13 +438,15 @@ Accept wildcard characters: False ``` ### -NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -427,13 +456,15 @@ Accept wildcard characters: False ``` ### -NotificationsForSpamSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -443,13 +474,15 @@ Accept wildcard characters: False ``` ### -NotificationsForSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -459,13 +492,15 @@ Accept wildcard characters: False ``` ### -OnlyShowPhishingDisclaimer + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -475,6 +510,9 @@ Accept wildcard characters: False ``` ### -PhishingReviewResultMessage + +> Applicable: Exchange Online + The PhishingReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as phishing. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -487,7 +525,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -497,6 +534,9 @@ Accept wildcard characters: False ``` ### -PostSubmitMessage + +> Applicable: Exchange Online + The PostSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message title using the PostSubmitMessageTitle parameter. @@ -507,7 +547,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -517,13 +556,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageEnabled + +> Applicable: Exchange Online + {{ Fill PostSubmitMessageEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -533,13 +574,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -549,13 +592,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -565,13 +610,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -581,6 +628,9 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitle + +> Applicable: Exchange Online + The PostSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message text using the PostSubmitMessage parameter. @@ -591,7 +641,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -601,13 +650,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -617,13 +668,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -633,13 +686,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -649,6 +704,9 @@ Accept wildcard characters: False ``` ### -PreSubmitMessage + +> Applicable: Exchange Online + The PreSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message title using the PreSubmitMessageTitle parameter. @@ -659,7 +717,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -669,13 +726,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageEnabled + +> Applicable: Exchange Online + {{ Fill PreSubmitMessageEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -685,13 +744,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -701,13 +762,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -717,13 +780,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -733,6 +798,9 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitle + +> Applicable: Exchange Online + The PreSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the pop-up message text using the PreSubmitMessage parameter. @@ -743,7 +811,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -753,13 +820,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -769,13 +838,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -785,13 +856,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -801,13 +874,15 @@ Accept wildcard characters: False ``` ### -ReportChatMessageEnabled + +> Applicable: Exchange Online + {{ Fill ReportChatMessageEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -817,13 +892,15 @@ Accept wildcard characters: False ``` ### -ReportChatMessageToCustomizedAddressEnabled + +> Applicable: Exchange Online + {{ Fill ReportChatMessageToCustomizedAddressEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -833,7 +910,10 @@ Accept wildcard characters: False ``` ### -ReportJunkAddresses -The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +> Applicable: Exchange Online + +The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. This parameter is required to create the report submission policy if the ReportJunkToCustomizedAddress parameter value is $true. @@ -845,7 +925,6 @@ You also need to specify the same email address in the SentTo parameter on the N Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -855,7 +934,10 @@ Accept wildcard characters: False ``` ### -ReportJunkToCustomizedAddress -The ReportJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +> Applicable: Exchange Online + +The ReportJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. - $false: User reported messages are not sent to the reporting mailbox. @@ -868,7 +950,6 @@ This parameter is required to create the report submission policy if you're usin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -878,7 +959,10 @@ Accept wildcard characters: False ``` ### -ReportNotJunkAddresses -The ReportNotJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +> Applicable: Exchange Online + +The ReportNotJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. This parameter is required to create the report submission policy if the ReportNotJunkToCustomizedAddress parameter value is $true. @@ -890,7 +974,6 @@ You also need to specify the same email address in the SentTo parameter on the N Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -900,7 +983,10 @@ Accept wildcard characters: False ``` ### -ReportNotJunkToCustomizedAddress -The ReportNotJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +> Applicable: Exchange Online + +The ReportNotJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. - $false: User reported messages are not sent to the reporting mailbox. @@ -913,7 +999,6 @@ This parameter is required to create the report submission policy if you're usin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -923,7 +1008,10 @@ Accept wildcard characters: False ``` ### -ReportPhishAddresses -The ReportPhishAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +> Applicable: Exchange Online + +The ReportPhishAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. This parameter is required to create the report submission policy if the ReportPhishToCustomizedAddress parameter value is $true. @@ -935,7 +1023,6 @@ You also need to specify the same email address in the SentTo parameter on the N Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -945,7 +1032,10 @@ Accept wildcard characters: False ``` ### -ReportPhishToCustomizedAddress -The ReportPhishToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +> Applicable: Exchange Online + +The ReportPhishToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. - $false: User reported messages are not sent to the reporting mailbox. @@ -958,7 +1048,6 @@ This parameter is required to create the report submission policy if you're usin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -968,15 +1057,17 @@ Accept wildcard characters: False ``` ### -ThirdPartyReportAddresses -Use the ThirdPartyReportAddresses parameter to specify the email address of the reporting mailbox in Exchange Online when you're using a third-party product for user submissions instead of reporting in Outlook. -This parameter is required to create the report submission policy if you've disabled reporting in Outlook (`-EnableReportToMicrosoft $false`) and you're using the reporting mailbox with third-party tools (`-EnableThirdPartyAddress $true`). +> Applicable: Exchange Online + +Use the ThirdPartyReportAddresses parameter to specify the email address of the reporting mailbox in Exchange Online when you're using a non-Microsoft product for user submissions instead of reporting in Outlook. + +This parameter is required to create the report submission policy if you've disabled reporting in Outlook (`-EnableReportToMicrosoft $false`) and you're using the reporting mailbox with non-Microsoft tools (`-EnableThirdPartyAddress $true`). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -986,13 +1077,15 @@ Accept wildcard characters: False ``` ### -UserSubmissionOptions + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1002,13 +1095,15 @@ Accept wildcard characters: False ``` ### -UserSubmissionOptionsMessage + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionRule.md similarity index 84% rename from exchange/exchange-ps/exchange/New-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionRule.md index 9128905359..277ab07e3d 100644 --- a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-reportsubmissionrule applicable: Exchange Online -title: New-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-reportsubmissionrule +schema: 2.0.0 +title: New-ReportSubmissionRule --- # New-ReportSubmissionRule @@ -38,16 +39,16 @@ You can use this cmdlet only if the following statements are true: - The report submission rule doesn't exist (the Get-ReportSubmissionRule cmdlet returns no output). - The report submission policy exists (the Get-ReportSubmissionPolicy cmdlet returns output). -The SentTo parameter identifies the email address of the reporting mailbox. Your organization needs a report submission rule only to send user reported messages to the reporting mailbox using Microsoft or third-party reporting tools in Outlook (reporting in Outlook is turned on). +The SentTo parameter identifies the email address of the reporting mailbox. Your organization needs a report submission rule only to send user reported messages to the reporting mailbox using Microsoft or non-Microsoft reporting tools in Outlook (reporting in Outlook is turned on). When you set the email address of the reporting mailbox in the Microsoft Defender portal at , the same email address is also set in the *\-ReportSubmissionPolicy cmdlets: - Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). -- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. +- Microsoft integrated reporting using non-Microsoft reporting tools in Outlook: ThirdPartyReportAddresses. When you use this cmdlet to set the email address of the reporting mailbox, the corresponding parameters in the *\-ReportSubmissionPolicy cmdlets are not updated. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,13 +62,15 @@ This example creates the report submission rule. The reporting mailbox is userre ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the name of the report submission rule. When the rule is automatically created, the name of the rule is DefaultReportSubmissionRule. We recommend using this value to avoid confusion. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -ReportSubmissionPolicy + +> Applicable: Exchange Online + The ReportSubmissionPolicy parameter specifies the report submission policy that's associated with this rule. The only available policy is named DefaultReportSubmissionPolicy. ```yaml Type: ReportSubmissionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -118,7 +128,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -128,9 +137,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the rule is enabled or disabled. Valid values are: -- $true: The rule is enabled. This is the default value. +- $true: The rule is enabled. This value is the default. - $false: The rule is disabled. After you create the rule, use the Enable-ReportSubmissionRule and Disable-ReportSubmissionRule cmdlets to enable or disable the rule. @@ -139,7 +151,6 @@ After you create the rule, use the Enable-ReportSubmissionRule and Disable-Repor Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -149,17 +160,20 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies the email address of the reporting mailbox in Exchange Online where user reported messages are sent. The value of this parameter is meaningful only if reporting in Outlook is enabled, and user reported messages are sent to a reporting mailbox as configured in the \*-ReportSubmissionPolicy cmdlets (either of the following scenarios): - Microsoft integrated reporting is enabled using Microsoft reporting tools in Outlook: `-EnableThirdPartyAddress $false -ReportJunkToCustomizedAddress $true -ReportNotJunkToCustomizedAddress $true -ReportPhishToCustomizedAddress $true`. -- Microsoft integrated reporting is enabled using third-party reporting tools in Outlook: `-EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ReportJunkToCustomizedAddress $false -ReportNotJunkToCustomizedAddress $false -ReportPhishToCustomizedAddress $false`. +- Microsoft integrated reporting is enabled using non-Microsoft reporting tools in Outlook: `-EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ReportJunkToCustomizedAddress $false -ReportNotJunkToCustomizedAddress $false -ReportPhishToCustomizedAddress $false`. If you set the email address of the reporting mailbox in the Microsoft Defender portal, the following parameters in the *\-ReportSubmissionPolicy cmdlets are set to the same value: - Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). -- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. +- Microsoft integrated reporting using non-Microsoft reporting tools in Outlook: ThirdPartyReportAddresses. When you use this cmdlet to set the email address of the reporting mailbox, the related parameter values in the *\-ReportSubmissionPolicy cmdlets are not updated, which doesn't affect the functionality of the reporting mailbox. You should update the related values in the \*-ReportSubmissionPolicy cmdlets for consistency and to avoid confusion. @@ -167,7 +181,6 @@ When you use this cmdlet to set the email address of the reporting mailbox, the Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-RetentionCompliancePolicy.md similarity index 85% rename from exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-RetentionCompliancePolicy.md index 8258bfaf6b..bf34b33313 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-retentioncompliancepolicy applicable: Security & Compliance -title: New-RetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-retentioncompliancepolicy +schema: 2.0.0 +title: New-RetentionCompliancePolicy --- # New-RetentionCompliancePolicy @@ -88,7 +89,7 @@ New-RetentionCompliancePolicy [-Name] -AdaptiveScopeLocation Applicable: Security & Compliance + The Name parameter specifies the unique name of the retention policy. 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 @@ -131,6 +134,9 @@ Accept wildcard characters: False ``` ### -AdaptiveScopeLocation + +> Applicable: Security & Compliance + The AdaptiveScopeLocation parameter specifies the adaptive scope location to include in the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -141,7 +147,6 @@ The AdaptiveScopeLocation parameter specifies the adaptive scope location to inc Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -151,18 +156,20 @@ Accept wildcard characters: False ``` ### -Applications + +> Applicable: Security & Compliance + The Applications parameter specifies the target when Microsoft 365 Groups are included in the policy (the ModernGroups parameter is set). Valid values are: - `Group:Exchange` for the mailbox that's connected to the Microsoft 365 Group. - `Group:SharePoint` for the SharePoint site that's connected to the Microsoft 365 Group. - `"Group:Exchange,SharePoint"` for both the mailbox and the SharePoint site that are connected to the Microsoft 365 Group. -- blank (`$null`): This is the default value, and is functionally equivalent to the value `"Group:Exchange,SharePoint"`. +- blank (`$null`): This value is the default, and is functionally equivalent to the value `"Group:Exchange,SharePoint"`. ```yaml Type: MultiValuedProperty Parameter Sets: Default, AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,13 +179,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -188,6 +197,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -197,7 +209,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -207,16 +218,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: -- $true: The policy is enabled. This is the default value. +- $true: The policy is enabled. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -226,6 +239,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - A mailbox @@ -247,7 +263,6 @@ If no mailboxes are specified, then no mailboxes are placed on hold. Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -257,6 +272,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocationException + +> Applicable: Security & Compliance + The ExchangeLocationException parameter specifies the mailboxes to exclude from the policy when you use the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -275,7 +293,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -285,6 +302,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -293,7 +313,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -303,6 +322,9 @@ Accept wildcard characters: False ``` ### -IsSimulation + +> Applicable: Security & Compliance + The IsSimulation switch specifies the policy is created in simulation mode. You don't need to specify a value with this switch. For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). @@ -311,7 +333,6 @@ For more information about simulation mode, see [Learn about simulation mode](ht Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -321,6 +342,9 @@ Accept wildcard characters: False ``` ### -ModernGroupLocation + +> Applicable: Security & Compliance + The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. Valid values are: - A Microsoft 365 Group @@ -339,7 +363,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -349,6 +372,9 @@ Accept wildcard characters: False ``` ### -ModernGroupLocationException + +> Applicable: Security & Compliance + The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude from the policy when you use the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -364,7 +390,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -374,7 +399,10 @@ Accept wildcard characters: False ``` ### -OneDriveLocation -The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value, or you can use the value All to include all sites. + +> Applicable: Security & Compliance + +The OneDriveLocation parameter specifies the OneDrive sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -382,7 +410,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -392,7 +419,10 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException -This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +This parameter specifies the OneDrive sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -400,7 +430,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -410,6 +439,11 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + +**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. @@ -418,7 +452,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -428,13 +461,15 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -444,13 +479,17 @@ Accept wildcard characters: False ``` ### -PriorityCleanup -{{ Fill PriorityCleanup Description }} + +> Applicable: Security & Compliance + +The PriorityCleanup switch specifies whether to create a Priority cleanup policy. You don't need to specify a value with this switch. + +Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -460,13 +499,15 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + The PublicFolderLocation parameter specifies that you want to include all public folders in the retention policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -476,12 +517,15 @@ Accept wildcard characters: False ``` ### -RestrictiveRetention + +> Applicable: Security & Compliance + The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: - $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. -- $false: Preservation Lock isn't enabled for the policy. This is the default value. +- $false: Preservation Lock isn't enabled for the policy. This value is the default. -After a policy has been locked, no one can turn off or disable it, or remove content from the policy. And it's not possible to modify or delete content that's subject to the policy during the retention period. The only ways that you can modify the retention policy are by adding content to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. +After a policy is locked, no one can turn off or disable it, or remove content from the policy. And it's not possible to modify or delete content that's subject to the policy during the retention period. The only ways that you can modify the retention policy are by adding content to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. Therefore, before you lock a retention policy, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need. @@ -489,7 +533,6 @@ Therefore, before you lock a retention policy, it's critical that you understand Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -499,12 +542,15 @@ Accept wildcard characters: False ``` ### -RetainCloudAttachment + +> Applicable: Security & Compliance + **Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. The RetainCloudAttachment parameter specifies that this is a cloud attachment policy. Valid values are: - $true: The policy is a cloud attachment policy. -- $false: The policy is not a cloud attachment policy. This is the default value. +- $false: The policy is not a cloud attachment policy. This value is the default. For the value $true, you can only use the following location parameters: @@ -520,7 +566,6 @@ The RetainCloudAttachment parameter is not available on the Set-RetentionComplia Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -530,17 +575,19 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. + +> Applicable: Security & Compliance + +The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. +SharePoint sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. ```yaml Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -550,7 +597,10 @@ Accept wildcard characters: False ``` ### -SharePointLocationException -This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +This parameter specifies the SharePoint sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -558,7 +608,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -568,13 +617,15 @@ Accept wildcard characters: False ``` ### -SkipPriorityCleanupConfirmation + +> Applicable: Security & Compliance + {{ Fill SkipPriorityCleanupConfirmation Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -584,6 +635,9 @@ Accept wildcard characters: False ``` ### -SkypeLocation + +> Applicable: Security & Compliance + The SkypeLocation parameter specifies the Skype for Business Online users to include in the policy. You can use any value that uniquely identifies the user. For example: @@ -599,7 +653,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -609,13 +662,15 @@ Accept wildcard characters: False ``` ### -SkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -625,6 +680,9 @@ Accept wildcard characters: False ``` ### -TeamsChannelLocation + +> Applicable: Security & Compliance + The TeamsChannelLocation parameter specifies the Teams to include in the policy. You can use any value that uniquely identifies the team. For example: @@ -639,7 +697,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -649,6 +706,9 @@ Accept wildcard characters: False ``` ### -TeamsChannelLocationException + +> Applicable: Security & Compliance + The TeamsChannelLocationException parameter specifies the Teams to exclude when you use the value All for the TeamsChannelLocation parameter. You can use any value that uniquely identifies the team. For example: - Name @@ -661,7 +721,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -671,6 +730,9 @@ Accept wildcard characters: False ``` ### -TeamsChatLocation + +> Applicable: Security & Compliance + The TeamsChatLocation parameter specifies the Teams users to include in the policy. You can use any value that uniquely identifies the user. For example: @@ -686,7 +748,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -696,6 +757,9 @@ Accept wildcard characters: False ``` ### -TeamsChatLocationException + +> Applicable: Security & Compliance + The TeamsChatLocationException parameter specifies the Teams users to exclude when you use the value All for the TeamsChatLocation parameter. You can use any value that uniquely identifies the user. For example: - Name @@ -709,7 +773,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -719,13 +782,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/New-RetentionComplianceRule.md similarity index 87% rename from exchange/exchange-ps/exchange/New-RetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-RetentionComplianceRule.md index c7471abe72..5744f9b2f0 100644 --- a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-retentioncompliancerule applicable: Security & Compliance -title: New-RetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-retentioncompliancerule +schema: 2.0.0 +title: New-RetentionComplianceRule --- # New-RetentionComplianceRule @@ -74,18 +75,21 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned New-RetentionComplianceRule -Name InternalCompanyRule -Policy "Internal Company Policy" -RetentionDuration Unlimited ``` -This example creates a new case hold rule named InternalCompanyRule and adds it to the existing case hold policy named "Internal Company Policy". Content will be held indefinitely. +This example creates a new case hold rule named InternalCompanyRule and adds it to the existing case hold policy named "Internal Company Policy". Content is held indefinitely. ### Example 2 ```powershell New-RetentionComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -RetentionDuration 365 -RetentionComplianceAction KeepAndDelete -ExpirationDateOption ModificationAgeInDays ``` -This example creates a new retention rule named SeptOneYear and adds it to the existing retention policy named "Internal Company Policy". Content will be held for one year from the day content was last modified before it is deleted. +This example creates a new retention rule named SeptOneYear and adds it to the existing retention policy named "Internal Company Policy". Content is held for one year from the day content was last modified before it is deleted. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the retention rule. If the value contains spaces, enclose the value in quotation marks. You can't use this parameter with the ApplyComplianceTag or PublishComplianceTag parameters. @@ -94,7 +98,6 @@ You can't use this parameter with the ApplyComplianceTag or PublishComplianceTag Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -ApplyComplianceTag + +> Applicable: Security & Compliance + The ApplyComplianceTag parameter specifies the label that's applied to email messages or documents by the rule (which affects how long the content is retained). A valid value for this parameter is the name of an existing label. If the value contains spaces, enclose the value in quotation marks. You view and create labels by using the Get-ComplianceTag and New-ComplianceTag cmdlets. @@ -116,7 +122,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -126,13 +131,15 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the policy to contain the rule. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -142,13 +149,17 @@ Accept wildcard characters: False ``` ### -PriorityCleanup -{{ Fill PriorityCleanup Description }} + +> Applicable: Security & Compliance + +The PriorityCleanup switch specifies whether to create a rule associated with a Priority cleanup policy. You don't need to specify a value with this switch. + +Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -158,6 +169,9 @@ Accept wildcard characters: False ``` ### -PublishComplianceTag + +> Applicable: Security & Compliance + 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. You view and create labels by using the Get-ComplianceTag and New-ComplianceTag cmdlets. @@ -172,7 +186,6 @@ You can't use this parameter in the following scenarios: Type: String Parameter Sets: PublishComplianceTag Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -182,13 +195,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -207,7 +225,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -217,6 +234,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -231,7 +251,6 @@ You can't use this parameter for Teams retention rules. Type: PswsHashtable[] Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -241,6 +260,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -251,7 +273,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: ComplianceTag, Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -261,7 +282,10 @@ Accept wildcard characters: False ``` ### -ExcludedItemClasses -The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: + +> Applicable: Security & Compliance + +The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter doesn't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: - IPM.Note.Microsoft.Conversation - IPM.Note.Microsoft.Conversation.Voice @@ -272,7 +296,7 @@ The ExcludedItemClasses parameter specifies the types of messages to exclude fro - IPM.Note.Microsoft.Voicemail.UM - IPM.Note.Microsoft.Voicemail.UM.CA -Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or non-Microsoft message classes. The values you specify aren't validated, so the parameter accepts any text value. You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. @@ -282,7 +306,6 @@ You can't use this parameter for Teams retention rules. Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -292,6 +315,9 @@ Accept wildcard characters: False ``` ### -ExpirationDateOption + +> Applicable: Security & Compliance + The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: - CreationAgeInDays @@ -303,7 +329,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -313,13 +338,15 @@ Accept wildcard characters: False ``` ### -IRMRiskyUserProfiles + +> Applicable: Security & Compliance + {{ Fill IRMRiskyUserProfiles Description }} ```yaml Type: String Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -329,13 +356,15 @@ Accept wildcard characters: False ``` ### -MachineLearningModelIDs + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -345,6 +374,9 @@ Accept wildcard characters: False ``` ### -RetentionComplianceAction + +> Applicable: Security & Compliance + The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - Delete @@ -357,7 +389,6 @@ If you don't use this parameter, the retention policy is created as an "UniH" po Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -367,6 +398,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - An integer: The hold duration in days. @@ -376,7 +410,6 @@ The RetentionDuration parameter specifies the hold duration for the retention ru Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -386,13 +419,16 @@ Accept wildcard characters: False ``` ### -RetentionDurationDisplayHint + +> Applicable: Security & Compliance + The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are: - Days - Months - Years -For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal displays 1 year as the content hold duration. You can't use this parameter for Teams retention rules. @@ -400,7 +436,6 @@ You can't use this parameter for Teams retention rules. Type: HoldDurationHint Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -410,13 +445,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-RetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/New-RetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicy.md index a6a970985e..de98de144a 100644 --- a/exchange/exchange-ps/exchange/New-RetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-retentionpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-RetentionPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-retentionpolicy +schema: 2.0.0 +title: New-RetentionPolicy --- # New-RetentionPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-RetentionPolicy cmdlet to create a retention policy. @@ -35,7 +36,7 @@ New-RetentionPolicy [-Name] ## DESCRIPTION Retention policy tags are associated with a retention policy. When a retention policy is applied to a mailbox, tags associated with the policy are available to the mailbox user. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,13 +59,15 @@ The second retention tag, which is named Legal, is also enclosed in quotation ma ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the policy name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -83,7 +89,6 @@ 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 Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -101,7 +109,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,18 +118,21 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IsDefault switch specifies that this retention policy is the default retention policy. You don't need to specify a value with this switch. -When you use this switch, you'll get a warning that this retention policy will replace the current default retention policy (the policy where the IsDefault property value is currently True) as the default. By default, the default retention policy is named Default MRM Policy. +When you use this switch, you get a warning that this retention policy replaces the current default retention policy (the policy where the IsDefault property value is currently True) as the default. By default, the default retention policy is named Default MRM Policy. **Note**: Changing which retention policy is the default might or might not affect new and existing mailboxes based on the value of the RetentionPolicy parameter on all mailbox plans: - $null (blank): Changes to which retention policy is the default are continually reflected in new and existing mailboxes. - A retention policy is specified: The value of the RetentionPolicy parameter for all mailbox plans should be $null (blank) or match the Exchange retention policy that's configured as default policy for the organization. Otherwise, the experience might be inconsistent when creating new mailboxes, enabling disabled mailboxes, and changing licenses. For more information see [Mailbox plans in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/mailbox-plans). -If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox will be overwritten when changing licenses and will need to be manually reset to the original value. +If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox is overwritten when changing licenses. You need to manually reset the RetentionPolicy to the original value. Changes to the default retention policy that affect existing mailboxes can potentially saturate the network if there are hundreds or thousands of mailboxes that require updates. @@ -130,7 +140,6 @@ Changes to the default retention policy that affect existing mailboxes can poten Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -IsDefaultArbitrationMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. You don't need to specify a value with this switch. @@ -148,7 +160,6 @@ The IsDefaultArbitrationMailbox switch configures this policy as the default ret Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -158,13 +169,15 @@ Accept wildcard characters: False ``` ### -RetentionId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionId parameter specifies the identity of the retention policy to ensure mailboxes moved from an on-premises Exchange deployment to the cloud continue to have the same retention policy applied to them. The RetentionId parameter is used in cross-premises deployments. You don't need to specify this parameter in on-premises-only deployments. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -RetentionPolicyTagLinks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionPolicyTagLinks parameter specifies the names of retention policy tags to be associated with this policy. ```yaml Type: RetentionPolicyTagIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -190,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md b/exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicyTag.md similarity index 80% rename from exchange/exchange-ps/exchange/New-RetentionPolicyTag.md rename to exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicyTag.md index a320464cfa..3756a19d8b 100644 --- a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicyTag.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-retentionpolicytag -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-RetentionPolicyTag -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-retentionpolicytag +schema: 2.0.0 +title: New-RetentionPolicyTag --- # New-RetentionPolicyTag ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-RetentionPolicyTag cmdlet to create a retention tag. @@ -71,7 +72,7 @@ Retention tags are used to apply message retention settings to folders and items Retention tags support a display of the tag name and an optional comment in localized languages. Language culture codes from the CultureInfo class are used for this purpose. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,7 +88,7 @@ This example creates the retention policy tag Finance-DeletedItems for the Delet New-RetentionPolicyTag "Finance-Default" -Type All -RetentionEnabled $true -AgeLimitForRetention 365 -RetentionAction PermanentlyDelete ``` -This example creates the default policy tag Finance-Default. When applied to a mailbox as part of a retention policy, the tag permanently deletes all items without a retention tag within 365 days. Items of a particular message class such as Voicemail, for which a default tag (a retention tag of type All) exists, aren't impacted. +This example creates the default policy tag Finance-Default. When applied to a mailbox as part of a retention policy, the tag permanently deletes all items without a retention tag within 365 days. Items of a particular message class such as Voicemail, for which a default tag (a retention tag of type All) exists, aren't affected. ### Example 3 ```powershell @@ -99,13 +100,15 @@ This example creates the retention tag Business Critical of type Personal. When ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the tag. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -115,6 +118,9 @@ Accept wildcard characters: False ``` ### -AddressForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -123,7 +129,6 @@ This parameter is reserved for internal Microsoft use. Type: RecipientIdParameter Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -133,13 +138,15 @@ Accept wildcard characters: False ``` ### -AgeLimitForRetention + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml Type: EnhancedTimeSpan Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -149,13 +156,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Comment parameter specifies a comment for the tag. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,6 +174,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -174,7 +186,6 @@ 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 Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -192,7 +206,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +215,9 @@ Accept wildcard characters: False ``` ### -IsDefaultAutoGroupPolicyTag + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -210,7 +226,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -220,6 +235,9 @@ Accept wildcard characters: False ``` ### -IsDefaultModeratedRecipientsPolicyTag + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -228,7 +246,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -238,6 +255,9 @@ Accept wildcard characters: False ``` ### -JournalingEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -246,7 +266,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -256,6 +275,9 @@ Accept wildcard characters: False ``` ### -LabelForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -264,7 +286,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -274,13 +295,15 @@ Accept wildcard characters: False ``` ### -LocalizedComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LocalizedComment parameter specifies localized comments and their languages. When the user's language setting matches a language specified for this parameter, Microsoft Outlook and Outlook on the web display the corresponding localized comment. Comments are specified in the form of ISO Language Code:Comment, for example, LocalizedComment EN-US:"This is a localized comment in U.S. English". ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -290,13 +313,15 @@ Accept wildcard characters: False ``` ### -LocalizedRetentionPolicyTagName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LocalizedRetentionPolicyTagName parameter specifies localized tag names and their languages. When the user's language setting matches a language specified for this parameter, Outlook and Outlook on the web display the corresponding localized tag name. Names are specified in the form of ISO Language Code:Name, for example, LocalizedRetentionPolicyTagName EN-US:"Business Critical". ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -306,6 +331,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderToUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ManagedFolderToUpgrade parameter specifies the name of a managed folder to use as a template for a retention tag. @@ -314,7 +342,6 @@ The ManagedFolderToUpgrade parameter specifies the name of a managed folder to u Type: ELCFolderIdParameter Parameter Sets: UpgradeManagedFolder Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,6 +351,9 @@ Accept wildcard characters: False ``` ### -MessageClass + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MessageClass parameter specifies the message type to which the tag applies. If not specified, the default value is set to \*. With the exception of a default policy tag (DPT) for voicemail, Exchange doesn't support retention tags for different message types. Only tags with a MessageClass of \* are supported, and they apply to all message types. @@ -336,7 +366,6 @@ A DPT for voice mail messages applies only to Microsoft Exchange Unified Messagi Type: String Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -346,6 +375,9 @@ Accept wildcard characters: False ``` ### -MessageFormatForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -354,7 +386,6 @@ This parameter is reserved for internal Microsoft use. Type: JournalingFormat Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -364,13 +395,15 @@ Accept wildcard characters: False ``` ### -MustDisplayCommentEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -380,12 +413,15 @@ Accept wildcard characters: False ``` ### -RetentionAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionAction parameter specifies the action for the retention policy. Valid values are: - DeleteAndAllowRecovery: Deletes a message and allows recovery from the Recoverable Items folder. - MarkAsPastRetentionLimit: Messages are marked as past the retention limit. - MoveToArchive: Moves a message to the user's archive mailbox. You can use this action for retention tags of type All, Personal and RecoverableItems. -- PermanentlyDelete: Permanently deletes a message. A message that has been permanently deleted can't be recovered using the Recoverable Items folder. Permanently deleted messages aren't returned in a Discovery search, unless litigation hold is enabled for the mailbox. +- PermanentlyDelete: Permanently deletes a message. A message that is permanently deleted can't be recovered using the Recoverable Items folder. Permanently deleted messages aren't returned in a Discovery search, unless litigation hold is enabled for the mailbox. The MoveToDeletedItems and MoveToFolder actions are available, but don't work. These actions are available for upgrades from messaging records management (MRM) 1.0 (managed folders) to MRM 2.0 (retention policies). MRM 2.0 was introduced in Exchange 2010 Service Pack 1 (SP1). @@ -395,7 +431,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionAction Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -405,17 +440,19 @@ Accept wildcard characters: False ``` ### -RetentionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionEnabled parameter specifies whether the tag is enabled. When set to $false, the tag is disabled, and no retention action is taken on messages that have the tag applied. Messages with a disabled tag are still considered tagged, so any tags of the same type as the disabled tag in the user's retention policy aren't applied to such messages. -When you set the RetentionEnabled parameter to $false, the retention period for the tag is shown as Never. Users may apply this tag to items they want to indicate should never be deleted or should never be moved to the archive. Enabling the tag later may result in unintentional deletion or archiving of items. To avoid this situation, if a retention policy is disabled temporarily, it may be advisable to change the name of that tag so that users are discouraged from using it, such as `DISABLED_`. +When you set the RetentionEnabled parameter to $false, the retention period for the tag is shown as Never. Users might apply this tag to items they want to indicate should never be deleted or should never be moved to the archive. Enabling the tag later might result in unintentional deletion or archiving of items. To avoid this situation, if a retention policy is disabled temporarily, it might be advisable to change the name of that tag so that users are discouraged from using it, such as `DISABLED_`. ```yaml Type: Boolean Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -425,13 +462,15 @@ Accept wildcard characters: False ``` ### -RetentionId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionId parameter specifies an alternate tag ID to make sure the retention tag found on mailbox items tagged in an on-premises deployment matches the tag when the mailbox is moved to the cloud, or mailbox items tagged in the cloud match the tag when the mailbox is moved to an on-premises Exchange server. The parameter is used in cross-premises deployments. You don't need to specify this parameter in on-premises-only deployments. ```yaml Type: Guid Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -441,13 +480,15 @@ Accept wildcard characters: False ``` ### -SystemTag + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SystemTag parameter specifies that the tag is created for internal Exchange functionality. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -457,6 +498,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Type parameter specifies the type of retention tag being created. Valid values include: - All @@ -487,7 +531,6 @@ To create a default policy tag (DPT), specify type All. For tags of type Recover Type: ElcFolderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -497,13 +540,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-RoleAssignmentPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-RoleAssignmentPolicy.md index 37d991b855..eef83073bd 100644 --- a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RoleAssignmentPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-roleassignmentpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-RoleAssignmentPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-roleassignmentpolicy +schema: 2.0.0 +title: New-RoleAssignmentPolicy --- # New-RoleAssignmentPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-RoleAssignmentPolicy cmdlet to create management role assignment policies in your organization. @@ -34,11 +35,11 @@ New-RoleAssignmentPolicy [-Name] ## DESCRIPTION When you create an assignment policy, you can assign it to users using the New-Mailbox, Set-Mailbox, or Enable-Mailbox cmdlets. If you make the new assignment policy the default assignment policy, it's assigned to all new mailboxes that don't have an explicit assignment policy assigned to them. -You can add management roles to the new assignment policy when you create it, or you can create the assignment policy and add roles later. You must assign at least one management role to the new assignment policy for it to apply permissions to a mailbox. Without any roles assigned to the new assignment policy, users assigned to it won't be able to manage their mailbox configuration. To assign a management role after the assignment policy has been created, use the New-ManagementRoleAssignment cmdlet. For more information, see [Manage role assignment policies](https://learn.microsoft.com/Exchange/permissions/role-assignment-policies). +You can add management roles to the new assignment policy when you create it, or you can create the assignment policy and add roles later. You must assign at least one management role to the new assignment policy for it to apply permissions to a mailbox. Without any roles assigned to the new assignment policy, users assigned to it can't manage their mailbox configuration. To assign a management role after the assignment policy is created, use the New-ManagementRoleAssignment cmdlet. For more information, see [Manage role assignment policies](https://learn.microsoft.com/Exchange/permissions/role-assignment-policies). For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,13 +75,15 @@ Because setting the new role assignment as default applies only to new mailboxes ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the new assignment policy. If the assignment policy name contains spaces, enclose the name in quotation marks ("). The maximum length of the name is 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -99,7 +105,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Description parameter specifies the description that's displayed when the role assignment policy is viewed using the Get-RoleAssignmentPolicy cmdlet. Enclose the description in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -135,7 +145,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The IsDefault switch makes the assignment policy the default assignment policy. You don't need to specify a value with this switch. New mailboxes or mailboxes moved from previous versions of Exchange are assigned the default assignment policy when an explicit assignment policy isn't provided. @@ -155,7 +167,6 @@ Setting an assignment policy as default doesn't change the role assignment on ex Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -165,6 +176,9 @@ Accept wildcard characters: False ``` ### -Roles + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Roles parameter specifies the management roles to assign to the role assignment policy when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. For a list of built-in management roles that you can assign to a role group, see [Built-in management roles](https://learn.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). @@ -173,7 +187,6 @@ For a list of built-in management roles that you can assign to a role group, see Type: RoleIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RoleGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-RoleGroup.md similarity index 83% rename from exchange/exchange-ps/exchange/New-RoleGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-RoleGroup.md index 308719a319..35d6bdc6ef 100644 --- a/exchange/exchange-ps/exchange/New-RoleGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RoleGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-rolegroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: New-RoleGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-rolegroup +schema: 2.0.0 +title: New-RoleGroup --- # New-RoleGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-RoleGroup cmdlet to create management role groups. @@ -68,7 +69,7 @@ When you create a role group, you can create the group and add members to it dir For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -127,6 +128,9 @@ This example removes the role assignment between the Distribution Groups managem ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Name parameter specifies the name of the new role group. The name can have a maximum of 64 characters. If the name contains spaces, enclose the name in quotation marks ("). **Note**: If you create a linked role group, we recommend that you include the name of the foreign forest in the name of the role group so that you can more easily associate the linked role group and the associated foreign forest. This is especially important if you have multiple forests. @@ -135,7 +139,6 @@ The Name parameter specifies the name of the new role group. The name can have a Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -145,6 +148,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the fully qualified domain name (FQDN) or IP address of the domain controller in the forest where the foreign USG resides. The domain controller you specify is used to get security information for the foreign USG specified by the LinkedForeignGroup parameter. @@ -155,7 +161,6 @@ If you use the LinkedDomainController parameter, you must specify a foreign USG Type: String Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -165,6 +170,9 @@ Accept wildcard characters: False ``` ### -LinkedForeignGroup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedForeignGroup parameter specifies the name of the foreign USG you want to link this role group to. If the foreign USG name contains spaces, enclose the name in quotation marks ("). @@ -175,7 +183,6 @@ If you use the LinkedForeignGroup parameter, you must specify a domain controlle Type: UniversalSecurityGroupIdParameter Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -185,6 +192,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -194,7 +204,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -204,6 +213,9 @@ Accept wildcard characters: False ``` ### -CustomConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CustomConfigWriteScope parameter specifies the existing configuration-based management scope to associate with management role assignments created with this role group. If the management scope name contains spaces, enclose the name in quotation marks ("). Use the Get-ManagementScope cmdlet to retrieve a list of existing management scopes. @@ -212,7 +224,6 @@ The CustomConfigWriteScope parameter specifies the existing configuration-based Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +233,9 @@ Accept wildcard characters: False ``` ### -CustomRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomRecipientWriteScope parameter specifies the existing recipient-based management scope to associate with management role assignments created with this role group. If the management scope name contains spaces, enclose the name in quotation marks ("). Use the Get-ManagementScope cmdlet to retrieve a list of existing management scopes. @@ -232,7 +246,6 @@ If you use the CustomRecipientWriteScope parameter, you can't use the RecipientO Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -242,13 +255,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Description parameter specifies the description that's displayed when the role group is viewed using the Get-RoleGroup cmdlet. Enclose the description in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -258,13 +273,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter has a maximum length of 256 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -274,6 +291,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -282,7 +302,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -292,6 +311,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -302,7 +324,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -312,6 +333,9 @@ Accept wildcard characters: False ``` ### -Id + +> Applicable: Security & Compliance + This parameter is available only in Security & Compliance PowerShell. This parameter is reserved for internal Microsoft use. @@ -320,7 +344,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -330,6 +353,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. @@ -340,7 +366,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -350,6 +375,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies the users or USGs who can modify the configuration of a role group or add and remove members to or from a role group. You can use the name, distinguished name (DN), or primary SMTP address of the user or USG that you want to add. If the name of the user or USG contains spaces, enclose the name in quotation marks ("). @@ -360,7 +388,6 @@ If you want to add more than one user or USG, separate them using commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -370,6 +397,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Members parameter specifies the mailboxes or mail-enabled USGs to add as a member of the role group. You can identify the user or group by the name, DN, or primary SMTP address value. You can specify multiple members separated by commas (`Value1,Value2,...ValueN`). If the value contains spaces, enclose the value in quotation marks (`"Value 1","Value 2",..."Value N"`). If you use the Members parameter, you can't use the LinkedForeignGroup, LinkedDomainController or LinkedCredential parameters. @@ -378,7 +408,6 @@ If you use the Members parameter, you can't use the LinkedForeignGroup, LinkedDo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -388,6 +417,9 @@ Accept wildcard characters: False ``` ### -RecipientOrganizationalUnitScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecipientOrganizationalUnitScope parameter specifies the organizational unit (OU) scope added to the role assignments created when the role group is created. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope parameter. To specify an OU, use the syntax: domain/ou. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). @@ -396,7 +428,6 @@ The RecipientOrganizationalUnitScope parameter specifies the organizational unit Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,6 +437,9 @@ Accept wildcard characters: False ``` ### -Roles + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Roles parameter specifies the management roles to assign to the role group when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. For a list of built-in management roles that you can assign to a role group, see [Built-in management roles](https://learn.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). @@ -414,7 +448,6 @@ For a list of built-in management roles that you can assign to a role group, see Type: RoleIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -424,15 +457,17 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -442,6 +477,9 @@ Accept wildcard characters: False ``` ### -WellKnownObject + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill WellKnownObject Description }} @@ -450,7 +488,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -460,6 +497,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -468,7 +508,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-RoutingGroupConnector.md similarity index 90% rename from exchange/exchange-ps/exchange/New-RoutingGroupConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-RoutingGroupConnector.md index 4fd4b16fbf..61483c3359 100644 --- a/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RoutingGroupConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-routinggroupconnector applicable: Exchange Server 2010 -title: New-RoutingGroupConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-routinggroupconnector +schema: 2.0.0 +title: New-RoutingGroupConnector --- # New-RoutingGroupConnector @@ -36,7 +37,7 @@ The New-RoutingGroupConnector cmdlet creates a new routing group connector betwe To create the routing group connector, you must specify the source servers from the originating routing group and the target servers in the destination routing group. The routing group connector is created in the routing group of which the source server is a member. By using the Bidirectional parameter, you can specify whether the connector is used for one-way or two-way mail flow. If you specify a two-way connector, a reciprocal connector is created in the target routing group. The source and target servers must be Exchange 2010 Hub Transport servers or Exchange 2003 bridgehead servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example creates the routing group connector Interop RGC with the following ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the name to assign to the routing group connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010 + The SourceTransportServers parameter specifies the host name or fully qualified domain name (FQDN) of the transport servers used to send messages to the target transport servers. You can specify more than one server by separating each entry with a comma. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -TargetTransportServers + +> Applicable: Exchange Server 2010 + The TargetTransportServers parameter specifies the host name or FQDN of the transport servers that receive messages from the source transport servers. You can specify more than one server by separating each entry with a comma. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -BiDirectional + +> Applicable: Exchange Server 2010 + The BiDirectional parameter specifies whether this is a one-way or two-way connector. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -128,7 +140,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -Cost + +> Applicable: Exchange Server 2010 + The Cost parameter specifies a cost to the connector. Transport servers use the connector cost to determine the least cost routing path from a source server to the destination server for message delivery. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -170,13 +185,15 @@ Accept wildcard characters: False ``` ### -PublicFolderReferralsEnabled + +> Applicable: Exchange Server 2010 + The PublicFolderReferralsEnabled parameter specifies whether users can use this routing group connector to access a public folder replica located in the routing group of the target servers when an instance of that public folder isn't available in the same routing group as the user's mailbox. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -186,13 +203,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RpcClientAccess.md b/exchange/exchange-ps/ExchangePowerShell/New-RpcClientAccess.md similarity index 89% rename from exchange/exchange-ps/exchange/New-RpcClientAccess.md rename to exchange/exchange-ps/ExchangePowerShell/New-RpcClientAccess.md index 183a022952..a64f68eb70 100644 --- a/exchange/exchange-ps/exchange/New-RpcClientAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RpcClientAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-rpcclientaccess applicable: Exchange Server 2010 -title: New-RpcClientAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-rpcclientaccess +schema: 2.0.0 +title: New-RpcClientAccess --- # New-RpcClientAccess @@ -34,7 +35,7 @@ New-RpcClientAccess -Server ## DESCRIPTION After you run this command, you must start the Exchange RPC Client Access service on the Exchange Client Access server to enable RPC client access. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example creates configuration information for the Exchange RPC Client Acces ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Client Access server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -59,7 +63,6 @@ The Server parameter specifies the Client Access server where you want to run th Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -BlockedClientVersions + +> Applicable: Exchange Server 2010 + The BlockedClientVersions parameter specifies which versions of Microsoft Outlook are restricted from connecting. The Exchange RPC Client Access service rejects Outlook connections if versions are in the range specified. This setting affects MAPI and Outlook Anywhere client connections. The value must be less than 256 characters in length. Versions should be single numbers in the format X.Y.Z where X is a major version number, Y is the minor revision number, and Z specifies the build, and ranges should be delimited by semicolons (for example, 0.0.0-5.9.9; 7.0.0-65535.65535.65535). @@ -77,7 +83,6 @@ Versions should be single numbers in the format X.Y.Z where X is a major version Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -96,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -EncryptionRequired + +> Applicable: Exchange Server 2010 + The EncryptionRequired parameter specifies whether to require Outlook connections to be encrypted. The Exchange RPC Client Access service rejects unencrypted Outlook connections if this parameter is set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -MaximumConnections + +> Applicable: Exchange Server 2010 + The MaximumConnections parameter specifies the maximum number of concurrent connections allowed. The Exchange RPC Client Access service reads and limits connections based on this property. This parameter has a range from 1 through 65535. @@ -148,7 +162,6 @@ Although you can configure a non-default value for this parameter, changes to th Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -158,13 +171,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentPolicy.md index 7bd53126c9..39965ff971 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-safeattachmentpolicy applicable: Exchange Online -title: New-SafeAttachmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-safeattachmentpolicy +schema: 2.0.0 +title: New-SafeAttachmentPolicy --- # New-SafeAttachmentPolicy @@ -42,7 +43,7 @@ New safe attachment policies that you create using this cmdlet aren't applied to A safe attachment policy can be assigned to only one safe attachment rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,21 +54,23 @@ New-SafeAttachmentPolicy -Name "Marketing Block Attachments" -Enable $true -Redi This example creates a new safe attachment policy named Marketing Block Attachments with the following options: -- The action is Block. This is the default value of the Action parameter, so you don't need to specify it. -- The value $true for the Enable parameter is required so the policy will actually use the default Action parameter value of Block (or any other Action parameter value). -- Enable redirection for detected malware attachments and send the messages to admin@contoso.com. +- The action is Block. This value is the default of the Action parameter, so you don't need to specify it. +- The value $true for the Enable parameter is required so the policy actually uses the default Action parameter value of Block (or any other Action parameter value). +- Enable redirection for detected malware attachments and send the messages to `admin@contoso.com`. - If Safe Attachments scanning isn't available or encounters errors, don't deliver the message as normal. The default value of the ActionOnError parameter is $true, so you don't need to specify it. ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the safe attachment policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -77,10 +80,13 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online + 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 Microsoft Defender portal. -- Block: Block the email message that contains the malware attachment. This is the default value. +- Block: Block the email message that contains the malware attachment. This value is the default. - 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). @@ -93,7 +99,6 @@ The results of all actions are available in message trace. Type: SafeAttachmentAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -128,7 +138,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -138,10 +147,13 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: Exchange Online + The Enable parameter works with the Action parameter to specify the action for the safe attachment policy. Valid values are: - $true: The Action parameter specifies the action for the Safe Attachment policy. -- $false: This is the default value. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. This value corresponds to the **Off** selection for the **Safe Attachments unknown malware response** setting of the policy in the Microsoft Defender portal. +- $false: This value is the default. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. This value corresponds to the **Off** selection for the **Safe Attachments unknown malware response** setting of the policy in the Microsoft Defender portal. To enable or disable a complete Safe Attachments policy in the Microsoft Defender portal (the combination of the rule and the corresponding associated policy in PowerShell), use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. @@ -149,7 +161,6 @@ To enable or disable a complete Safe Attachments policy in the Microsoft Defende Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -159,13 +170,15 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection + +> Applicable: Exchange Online + The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this switch yourself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -175,6 +188,9 @@ Accept wildcard characters: False ``` ### -QuarantineTag + +> Applicable: Exchange Online + The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware by Safe Attachments. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -191,7 +207,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -201,13 +216,15 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online + The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -217,16 +234,18 @@ Accept wildcard characters: False ``` ### -Redirect + +> Applicable: Exchange Online + The Redirect parameter specifies whether to deliver messages to an alternate email address if malware is detected in an attachment. Valid values are: - $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is 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. +- $false: Messages that contain malware attachments aren't delivered to another email address. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -236,6 +255,9 @@ Accept wildcard characters: False ``` ### -RedirectAddress + +> Applicable: Exchange Online + The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. The value of this parameter is meaningful only when value of the Redirect parameter is $true and the value of the Action parameter is Allow. @@ -244,7 +266,6 @@ The value of this parameter is meaningful only when value of the Redirect parame Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -254,13 +275,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentRule.md similarity index 91% rename from exchange/exchange-ps/exchange/New-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentRule.md index 373513e1c0..2edb57afa5 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-safeattachmentrule applicable: Exchange Online -title: New-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-safeattachmentrule +schema: 2.0.0 +title: New-SafeAttachmentRule --- # New-SafeAttachmentRule @@ -46,7 +47,7 @@ Safe Attachments is a feature in Microsoft Defender for Office 365 that opens em > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Safe Attachments policy settings](https://learn.microsoft.com/defender-office-365/safe-attachments-about#safe-attachments-policy-settings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,13 +65,15 @@ This example creates a new safe attachment rule named Research Department Attach ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the safe attachment rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -SafeAttachmentPolicy + +> Applicable: Exchange Online + The SafeAttachmentPolicy parameter specifies the safe attachment policy that's associated with this safe attachment rule. The rule defines the conditions, and the policy defines the actions. You can use any value that uniquely identifies the policy. For example: @@ -94,7 +100,6 @@ You can't specify a safe attachment policy that's already associated with anothe Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -129,7 +139,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -139,9 +148,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the rule is enabled. Valid values are: -- $true: The rule is enabled. This is the default value. +- $true: The rule is enabled. This value is the default. - $false: The rule is disabled. In the properties of the rule, the value of this parameter is visible in the State property. @@ -150,7 +162,6 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -176,6 +189,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -191,7 +207,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -201,6 +216,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -218,7 +236,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -242,7 +262,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -252,13 +271,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -268,6 +289,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -283,7 +307,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -293,6 +316,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -310,7 +336,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -320,13 +345,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-SafeLinksPolicy.md similarity index 87% rename from exchange/exchange-ps/exchange/New-SafeLinksPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-SafeLinksPolicy.md index 07d98d9dab..3ab8987a5c 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SafeLinksPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-safelinkspolicy applicable: Exchange Online -title: New-SafeLinksPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-safelinkspolicy +schema: 2.0.0 +title: New-SafeLinksPolicy --- # New-SafeLinksPolicy @@ -48,7 +49,7 @@ Safe Links is a feature in Microsoft Defender for Office 365 that checks links t New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the SafeLinksPolicy parameter on the New-SafeLinksRule or Set-SafeLinksRule cmdlets to associate the policy with a rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,18 +62,20 @@ This example creates a new Safe Links policy named Marketing Block URL with the - The policy is enabled. - Users aren't allowed to click through to the original URL. -- User clicks on URLs are tracked. This is the default value of the TrackClicks parameter, so you don't need to specify it. +- User clicks on URLs are tracked. This value is the default of the TrackClicks parameter, so you don't need to specify it. ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the Safe Links policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -AllowClickThrough + +> Applicable: Exchange Online + The AllowClickThrough parameter specifies whether users are allowed to click through to the original URL on warning pages. Valid values are: - $true: The user is allowed to click through to the original URL. @@ -109,7 +117,6 @@ In PowerShell, the default value is $false. In new Safe Links policies created i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -128,7 +138,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -CustomNotificationText + +> Applicable: Exchange Online + The custom notification text specifies the customized notification text to show to users. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -154,16 +165,18 @@ Accept wildcard characters: False ``` ### -DeliverMessageAfterScan + +> Applicable: Exchange Online + The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: -- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. This is the default value. +- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. This value is the default. - $false: If Safe Links scanning can't complete, deliver the message anyway. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -173,10 +186,13 @@ Accept wildcard characters: False ``` ### -DisableUrlRewrite + +> Applicable: Exchange Online + The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: - $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). -- $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. This is the default value. +- $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. This value is the default. In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft Defender portal, the default value is $true. @@ -184,7 +200,6 @@ In PowerShell, the default value is $false. In new Safe Links policies created i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -194,6 +209,9 @@ Accept wildcard characters: False ``` ### -DoNotRewriteUrls + +> Applicable: Exchange Online + The DoNotRewriteUrls parameter specifies the URLs that are not rewritten by Safe Links scanning. The list of entries allows users who are included in the policy to access the specified URLs that would otherwise be blocked by Safe Links. 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"`. @@ -206,7 +224,6 @@ For details about the entry syntax, see [Entry syntax for the "Do not rewrite th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,16 +233,18 @@ Accept wildcard characters: False ``` ### -EnableForInternalSenders + +> Applicable: Exchange Online + The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: -- $true: The policy is applied to internal and external senders. This is the default value. +- $true: The policy is applied to internal and external senders. This value is the default. - $false: The policy is applied only to external senders. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -235,16 +254,18 @@ Accept wildcard characters: False ``` ### -EnableOrganizationBranding + +> Applicable: Exchange Online + The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: - $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. -- $false: Organization branding is not displayed on Safe Links warning and notification pages. This is the default value. +- $false: Organization branding is not displayed on Safe Links warning and notification pages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -254,16 +275,18 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForEmail + +> Applicable: Exchange Online + The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: -- $true: Safe Links is enabled for email. This is the default value. When a user clicks a link in an email, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $true: Safe Links is enabled for email. This value is the default. When a user clicks a link in an email, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - $false: Safe Links isn't enabled for email. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -273,18 +296,20 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForOffice + +> Applicable: Exchange Online + The EnableSafeLinksForOffice parameter specifies whether to enable Safe Links protection for supported Office desktop, mobile, or web apps. Valid values are: -- $true: Safe Links scanning is enabled in Office apps. This is the default value. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $true: Safe Links scanning is enabled in Office apps. This value is the default. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - $false: Safe Links isn't enabled for Office apps. -Note that this protection applies to links in Office documents, not links in email messages. +This protection applies to links in Office documents, not links in email messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -294,16 +319,18 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForTeams + +> Applicable: Exchange Online + The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: -- $true: Safe Links is enabled for Teams. This is the default value. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $true: Safe Links is enabled for Teams. This value is the default. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - $false: Safe Links isn't enabled for Teams. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -313,13 +340,15 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection + +> Applicable: Exchange Online + The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this switch yourself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -329,13 +358,15 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online + The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -345,16 +376,18 @@ Accept wildcard characters: False ``` ### -ScanUrls + +> Applicable: Exchange Online + The ScanUrls parameter specifies whether to enable or disable real-time scanning of clicked links in email messages. Valid values are: -- $true: Real-time scanning of clicked links, including links that point to files, is enabled. This is the default value. +- $true: Real-time scanning of clicked links, including links that point to files, is enabled. This value is the default. - $false: Real-time scanning of clicked links, including links that point to files, is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -364,16 +397,18 @@ Accept wildcard characters: False ``` ### -TrackClicks + +> Applicable: Exchange Online + The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links. Valid values are: -- $true: User clicks messages are tracked. This is the default value. +- $true: User clicks messages are tracked. This value is the default. - $false: User clicks messages aren't tracked. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -383,16 +418,18 @@ Accept wildcard characters: False ``` ### -UseTranslatedNotificationText + +> Applicable: Exchange Online + The UseTranslatedNotificationText specifies whether to use Microsoft Translator to automatically localize the custom notification text that you specified with the CustomNotificationText parameter. Valid values are: - $true: Translate custom notification text to the user's language. -- $false: Don't translate custom notification text to the user's language. This is the default value. +- $false: Don't translate custom notification text to the user's language. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -402,13 +439,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/New-SafeLinksRule.md similarity index 92% rename from exchange/exchange-ps/exchange/New-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-SafeLinksRule.md index 33a08f67c7..b097258420 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-safelinksrule applicable: Exchange Online -title: New-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-safelinksrule +schema: 2.0.0 +title: New-SafeLinksRule --- # New-SafeLinksRule @@ -44,7 +45,7 @@ Safe Links is a feature in Microsoft Defender for Office 365 that checks links i > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Recipient filters in Safe Links policies](https://learn.microsoft.com/defender-office-365/safe-links-about#recipient-filters-in-safe-links-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,13 +88,15 @@ This example is similar to Example 2, but in this example, the rule applies to r ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the Safe Links rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -SafeLinksPolicy + +> Applicable: Exchange Online + The SafeLinksPolicy parameter specifies the Safe Links policy that's associated with this Safe Links rule. The rule defines the conditions and the policy defines the actions. You can use any value that uniquely identifies the policy. For example: @@ -117,7 +123,6 @@ You can't specify a Safe Links policy that's already associated with another Saf Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -127,13 +132,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -143,6 +150,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -152,7 +162,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -162,9 +171,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the rule is enabled. Valid values are: -- $true: The rule is enabled. This is the default value. +- $true: The rule is enabled. This value is the default. - $false: The rule is disabled. In the properties of the rule, the value of this parameter is visible in the State property. @@ -173,7 +185,6 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -183,13 +194,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -199,6 +212,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -214,7 +230,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -224,6 +239,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -241,7 +259,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -265,7 +285,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -275,13 +294,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -291,6 +312,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -306,7 +330,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -316,6 +339,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -333,7 +359,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -343,13 +368,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md b/exchange/exchange-ps/ExchangePowerShell/New-SearchDocumentFormat.md similarity index 79% rename from exchange/exchange-ps/exchange/New-SearchDocumentFormat.md rename to exchange/exchange-ps/ExchangePowerShell/New-SearchDocumentFormat.md index 2f54d72235..c8313cb96b 100644 --- a/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SearchDocumentFormat.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-searchdocumentformat -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SearchDocumentFormat -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-searchdocumentformat +schema: 2.0.0 +title: New-SearchDocumentFormat --- # New-SearchDocumentFormat @@ -30,9 +31,11 @@ New-SearchDocumentFormat [-Identity] -Extension Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter uniquely identifies the new search document format. For example, an identity of "PropSCT" might specify a proprietary document format which is supported by a custom IFilter. The Identity parameter must be unique within the search document formats. ```yaml Type: SearchDocumentFormatId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,13 +67,15 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Extension parameter specifies the file type to be processed by the filter and is designated by the common file extension associated with the file type. Examples include .MP3, .JPG and .PNG. Note the leading period. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -78,13 +85,15 @@ Accept wildcard characters: False ``` ### -MimeType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MimeType parameter specifies the MIME type of the format. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -94,13 +103,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name specifies a friendly name for the format, but does not need to be unique. For example, you might have several different formats (supported by custom IFilters) that are used to index output from a proprietary system called "My Business Output". You could use the Name parameter to create a category of formats called "My Business Output Formats" and uniquely identify each format within that group using the Identity parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -110,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -119,7 +133,6 @@ 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 Required: False Position: Named @@ -129,6 +142,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the new format is enabled at creation. Valid input for this parameter is $true or $false. The default is $true. @@ -137,7 +153,6 @@ Valid input for this parameter is $true or $false. The default is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,6 +162,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -160,7 +178,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-SecOpsOverridePolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-SecOpsOverridePolicy.md index e24f5206c9..5c0f20c3ed 100644 --- a/exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SecOpsOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-secopsoverridepolicy applicable: Exchange Online -title: New-SecOpsOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-secopsoverridepolicy +schema: 2.0.0 +title: New-SecOpsOverridePolicy --- # New-SecOpsOverridePolicy @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS 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 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). +Use the New-SecOpsOverridePolicy cmdlet to create SecOps mailbox override policies that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -32,7 +33,7 @@ New-SecOpsOverridePolicy [-Name] -SentTo ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +47,15 @@ This example creates the SecOps mailbox override policy with the specified setti ## PARAMETERS ### -Name -The Name parameter specifies the name for the SecOps mailbox override policy. Regardless of the value you specify, the name will be SecOpsOverridePolicy. + +> Applicable: Exchange Online + +The Name parameter specifies the name for the SecOps mailbox override policy. Regardless of the value you specify, the name is SecOpsOverridePolicy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies the email address of the SecOps mailbox. Groups are not allowed. You can specify multiple email addresses separated by commas. @@ -70,7 +76,6 @@ You can specify multiple email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -105,7 +115,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -131,16 +142,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -150,6 +163,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + 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. @@ -158,7 +174,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -168,13 +183,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SendConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-SendConnector.md similarity index 84% rename from exchange/exchange-ps/exchange/New-SendConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-SendConnector.md index bb0b4fa218..cf81fd379f 100644 --- a/exchange/exchange-ps/exchange/New-SendConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SendConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-sendconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SendConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-sendconnector +schema: 2.0.0 +title: New-SendConnector --- # New-SendConnector @@ -105,7 +106,7 @@ New-SendConnector [-Name] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -137,13 +138,15 @@ To assign a specific authentication credential for the Send connector, you must ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a descriptive name for the connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -153,9 +156,12 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. -- AddressSpaceType: On an Edge server, the address space type must be SMTP. In the Transport service on a Mailbox server, the address space type may be SMTP, X400, or any other text string. If you omit the address space type, SMTP is assumed. +- AddressSpaceType: On an Edge server, the address space type must be SMTP. In the Transport service on a Mailbox server, the address space type might be SMTP, X400, or any other text string. If you omit the address space type, SMTP is assumed. - AddressSpace: For SMTP address space types, the address space that you enter must be RFC 1035-compliant. For example, \*, \*.com, and \*.contoso.com are permitted, but \*contoso.com is not. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such as o=MySite;p=MyOrg;a=adatum;c=us. For all other values of address space type, you can enter any text for the address space. - AddressSpaceCost: The valid input range for the cost is from 1 through 100. A lower cost indicates a better route. This parameter is optional. If you omit the address space cost, a cost of 1 is assumed. If you enter a non-SMTP address space that contains the semicolon character (;), you must specify the address space cost. @@ -166,20 +172,19 @@ If you specify the address space type or the address space cost, you must enclos - "SMTP:contoso.com" - contoso.com -You may specify multiple address spaces by separating the address spaces with commas, for example: contoso.com,fabrikam.com. If you specify the address space type or the address space cost, enclose the address space in quotation marks ("), for example: "contoso.com;2","fabrikam.com;3". +You might specify multiple address spaces by separating the address spaces with commas, for example: contoso.com,fabrikam.com. If you specify the address space type or the address space cost, enclose the address space in quotation marks ("), for example: "contoso.com;2","fabrikam.com;3". If you specify a non-SMTP address space type on a Send connector configured in the Transport service on a Mailbox server, you must configure the following parameters: - The SmartHosts parameter must be set to a value that specifies a smart host. - The DNSRoutingEnabled parameter must be set to $false. -Although you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as third-party fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see [Foreign connectors](https://learn.microsoft.com/exchange/foreign-connectors-exchange-2013-help). +Although you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as non-Microsoft fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see [Foreign connectors](https://learn.microsoft.com/exchange/foreign-connectors-exchange-2013-help). ```yaml Type: MultiValuedProperty Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -189,6 +194,9 @@ Accept wildcard characters: False ``` ### -AuthenticationCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AuthenticationCredential parameter specifies the username and password that's required to use the connector. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -197,7 +205,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,20 +214,22 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. Valid values are: -- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This is the default value for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. +- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This value is the default for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. - $false: The connector isn't used for mail flow in hybrid organizations, so any cross-premises headers are removed from messages that flow through the connector. ```yaml Type: Boolean Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,13 +239,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,6 +257,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -255,7 +269,6 @@ 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 Required: False Position: Named @@ -265,6 +278,9 @@ Accept wildcard characters: False ``` ### -ConnectionInactivityTimeOut + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectionInactivityTimeOut parameter specifies the maximum time an idle connection can remain open. The default value is ten 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. @@ -275,7 +291,6 @@ For example, to specify fifteen minutes, set it to 00:15:00. The valid input ran Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -285,16 +300,18 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectorType parameter specifies whether the connector is used in hybrid deployments to send messages to Microsoft 365. Valid values are: -- Default: The connector isn't used to send messages to Microsoft 365. This is the default value. +- Default: The connector isn't used to send messages to Microsoft 365. This value is the default. - XPremises: The connector is used to send messages to Microsoft 365. ```yaml Type: TenantConnectorType Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,6 +321,9 @@ Accept wildcard characters: False ``` ### -Custom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Custom switch specifies the Custom usage type. You don't need to specify a value with this switch. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Custom switch, you can't use any of the following parameters: @@ -319,7 +339,6 @@ For more information about Send connector usage types, permissions, and authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -329,13 +348,15 @@ Accept wildcard characters: False ``` ### -DNSRoutingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DNSRoutingEnabled parameter specifies whether the Send connector uses Domain Name System (DNS) to route mail. Valid values for this parameter are $true or $false. The default value is $true. If you specify a SmartHosts parameter, the DNSRoutingEnabled parameter must be $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -345,6 +366,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -353,7 +377,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -363,6 +386,9 @@ Accept wildcard characters: False ``` ### -DomainSecureEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainSecureEnabled parameter enables mutual Transport Layer Security (TLS) authentication for the domains serviced by the Send connector when set to $true. Mutual TLS authentication functions correctly only if the following conditions are met: - DomainSecureEnabled is set to $true. @@ -382,7 +408,6 @@ The default value is $true for a default Send connector defined on an Edge serve Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -392,13 +417,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether to enable the Send connector to process email messages. Valid values are $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -408,6 +435,9 @@ Accept wildcard characters: False ``` ### -ErrorPolicies + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ErrorPolicies parameter specifies how communication errors are treated. Possible values are the following: - Default: A non-delivery report (NDR) is generated for communication errors. @@ -423,7 +453,6 @@ Specify a value other than Default for this parameter only if this Send connecto Type: ErrorPolicies Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +462,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -441,7 +473,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -451,13 +482,15 @@ Accept wildcard characters: False ``` ### -ForceHELO + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForceHELO parameter specifies whether HELO is sent instead of the default EHLO. Valid values are $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -467,6 +500,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Fqdn parameter specifies the FQDN used as the source server for connected messaging servers that use the Send connector to receive outgoing messages. The value of this parameter is displayed to connected messaging servers whenever a source server name is required, as in the following examples: - In the EHLO/HELO command when the Send connector communicates with the next hop messaging server @@ -479,7 +515,6 @@ The default value of the Fqdn parameter is $null. This means the default FQDN va Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -489,13 +524,15 @@ Accept wildcard characters: False ``` ### -FrontendProxyEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FrontendProxyEnabled parameter routes outbound messages through the CAS server, where destination specific routing, such as DNS or IP address, is set, when the parameter is set to $true. ```yaml Type: Boolean Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -505,13 +542,15 @@ Accept wildcard characters: False ``` ### -IgnoreSTARTTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreSTARTTLS parameter specifies whether to ignore the StartTLS option offered by a remote sending server. This parameter is used with remote domains. This parameter must be set to $false if the RequireTLS parameter is set to $true. Valid values for this parameter are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -521,6 +560,9 @@ Accept wildcard characters: False ``` ### -Internal + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Internal switch specifies the Internal usage type. You don't need to specify a value with this switch. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internal switch, you can't use any of the following parameters: @@ -536,7 +578,6 @@ For more information about Send connector usage types, permissions, and authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -546,6 +587,9 @@ Accept wildcard characters: False ``` ### -Internet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Internet switch specifies the Internet usage type. You don't need to specify a value with this switch. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internet switch, you can't use any of the following parameters: @@ -561,7 +605,6 @@ For more information about Send connector usage types, permissions, and authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -571,6 +614,9 @@ Accept wildcard characters: False ``` ### -IsCoexistenceConnector + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IsCoexistenceConnector parameter specifies whether this Send connector is used for secure mail flow between your on-premises deployment and your Microsoft 365 organization. The default value is $false. @@ -579,7 +625,6 @@ The IsCoexistenceConnector parameter specifies whether this Send connector is us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -589,13 +634,15 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers with the Transport service. When the value of this parameter is $false, the connector can be used by all Mailbox servers in the Exchange organization. When the value of this parameter is $true, the connector can only be used by Transport service on Mailbox servers in the same Active Directory site. The default value is $false. ```yaml Type: Boolean Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -605,6 +652,9 @@ Accept wildcard characters: False ``` ### -LinkedReceiveConnector + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The LinkedReceiveConnector parameter specifies whether to force all messages received by the specified Receive connector out through this Send connector. The value of LinkedReceivedConnector can use any of the following identifiers to specify the Receive connector: @@ -626,7 +676,6 @@ When you use the LinkedReceiveConnector parameter, you can't use the AddressSpac Type: ReceiveConnectorIdParameter Parameter Sets: LinkedReceiveConnector Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -636,6 +685,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxMessageSize parameter specifies the maximum size of a message that can pass through a connector. The default value is 25 MB. When you enter a value, qualify the value with one of the following units: @@ -646,7 +698,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. Values entered in bytes are rounded up to nearest kilobyte. The valid input range for this parameter is 0 to 2147483647 bytes. To remove the message size limit on a Send connector, enter a value of unlimited. @@ -654,7 +706,6 @@ Values entered in bytes are rounded up to nearest kilobyte. The valid input rang Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -664,6 +715,9 @@ Accept wildcard characters: False ``` ### -Partner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Partner switch specifies the Partner usage type. You don't need to specify a value with this switch. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Partner switch, you can't use any of the following parameters: @@ -679,7 +733,6 @@ For more information about Send connector usage types, permissions, and authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -689,13 +742,15 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Port parameter specifies the port number for smart host forwarding, if you specify a value in the SmartHosts parameter. The valid input range is an integer from 0 through 65535. The default value is 25. In most organizations, the port number is set to 25. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -705,13 +760,15 @@ Accept wildcard characters: False ``` ### -ProtocolLoggingLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProtocolLoggingLevel parameter specifies whether to enable protocol logging. Verbose enables protocol logging. None disables protocol logging. The location of the Send connector protocol logs for all Send connectors configured in the Transport service on a Mailbox server or on an Edge server is specified with the SendProtocolLogPath parameter of the Set-TransportService cmdlet. ```yaml Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -721,13 +778,15 @@ Accept wildcard characters: False ``` ### -RequireOorg + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -737,13 +796,15 @@ Accept wildcard characters: False ``` ### -RequireTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireTLS parameter specifies whether all messages sent through this connector must be transmitted using TLS. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -753,13 +814,15 @@ Accept wildcard characters: False ``` ### -SmartHostAuthMechanism + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SmartHostAuthMechanism parameter specifies the smart host authentication mechanism to use for authentication with a remote server. Use this parameter only when a smart host is configured and the DNSRoutingEnabled parameter is set to $false. Valid values are None, BasicAuth, BasicAuthRequireTLS, ExchangeServer, and ExternalAuthoritative. All values are mutually exclusive. If you select BasicAuth or BasicAuthRequireTLS, you must use the AuthenticationCredential parameter to specify the authentication credential. ```yaml Type: AuthMechanisms Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -769,6 +832,9 @@ Accept wildcard characters: False ``` ### -SmartHosts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. 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"`. @@ -777,7 +843,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -787,13 +852,15 @@ Accept wildcard characters: False ``` ### -SmtpMaxMessagesPerConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SmtpMaxMessagesPerConnection parameter specifies the maximum number of messages the server can send per connection. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -803,13 +870,15 @@ Accept wildcard characters: False ``` ### -SourceIPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceIPAddress parameter specifies the local IP address to use as the endpoint for an SMTP connection to a remote messaging server. The default IP address is 0.0.0.0. This value means that the server can use any available local IP address. This parameter is valid only for Send connectors configured on an Edge server. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -819,6 +888,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceTransportServers parameter specifies the names of the Mailbox servers that can use this Send connector. This parameter isn't valid for Send connectors configured on an Edge server. 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"`. @@ -827,7 +899,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -837,6 +908,9 @@ Accept wildcard characters: False ``` ### -TlsAuthLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TlsAuthLevel parameter specifies the TLS authentication level that is used for outbound TLS connections established by this Send connector. Valid values are: - EncryptionOnly: TLS is used only to encrypt the communication channel. No certificate authentication is performed. @@ -849,7 +923,6 @@ You can't specify a value for this parameter if the IgnoreSTARTTLS parameter is Type: TlsAuthLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -859,13 +932,15 @@ Accept wildcard characters: False ``` ### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -875,6 +950,9 @@ Accept wildcard characters: False ``` ### -TlsDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TlsDomain parameter specifies the domain name that the Send connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is used only if the TlsAuthLevel parameter is set to DomainValidation. @@ -888,7 +966,6 @@ A value for this parameter is required if: Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -898,6 +975,9 @@ Accept wildcard characters: False ``` ### -Usage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Usage parameter specifies the default permissions and authentication methods assigned to the Send connector. The valid values are as follows: Custom, Internal, Internet, or Partner. The default is Custom. If you use the Usage parameter, you can't use any of the following parameters: @@ -913,7 +993,6 @@ For more information about Send connector usage types, permissions, and authenti Type: UsageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -923,13 +1002,15 @@ Accept wildcard characters: False ``` ### -UseExternalDNSServersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseExternalDNSServersEnabled parameter specifies whether this Send connector uses the external DNS list specified by the ExternalDNSServers parameter of the Set-TransportService cmdlet. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -939,13 +1020,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ServicePrincipal.md b/exchange/exchange-ps/ExchangePowerShell/New-ServicePrincipal.md similarity index 85% rename from exchange/exchange-ps/exchange/New-ServicePrincipal.md rename to exchange/exchange-ps/ExchangePowerShell/New-ServicePrincipal.md index 6e59edbe3e..6189996d80 100644 --- a/exchange/exchange-ps/exchange/New-ServicePrincipal.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ServicePrincipal.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-serviceprincipal applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: New-ServicePrincipal -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-serviceprincipal +schema: 2.0.0 +title: New-ServicePrincipal --- # New-ServicePrincipal @@ -35,7 +36,7 @@ Service principals exist in Microsoft Entra ID to define what apps can do, who c 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example create a new service principal in Exchange Online with the specifie ## PARAMETERS ### -AppId + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The AppId parameter specifies the unique AppId GUID value for the service principal. For example, ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1. A valid value for this parameter is available in the following locations: @@ -60,7 +64,6 @@ A valid value for this parameter is available in the following locations: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -ObjectId + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ObjectId parameter specifies the unique ObjectId GUID value for the service principal. For example, 7c7599b2-23af-45e3-99ff-0025d148e929. A valid value for this parameter is available in the following locations: @@ -81,7 +87,6 @@ A valid value for this parameter is available in the following locations: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -ServiceId + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is being deprecated. Use the ObjectId parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -116,7 +126,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The DisplayName parameter specifies the friendly name of the service principal. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -158,13 +171,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SettingOverride.md b/exchange/exchange-ps/ExchangePowerShell/New-SettingOverride.md similarity index 84% rename from exchange/exchange-ps/exchange/New-SettingOverride.md rename to exchange/exchange-ps/ExchangePowerShell/New-SettingOverride.md index 6ffa158c1c..1d19d09a98 100644 --- a/exchange/exchange-ps/exchange/New-SettingOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SettingOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-settingoverride -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SettingOverride -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-settingoverride +schema: 2.0.0 +title: New-SettingOverride --- # New-SettingOverride @@ -37,7 +38,7 @@ New-SettingOverride [-Name] -Component -Parameters Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name of the setting override. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Component + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Component parameter specifies the component that the setting override is applied to. For example: - TimeBasedAssistants @@ -87,7 +93,6 @@ The Component parameter specifies the component that the setting override is app Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Parameters parameter specifies one or more parameters for the override that are available for the combination of the Component and Section parameter values. This parameter uses the syntax: `@("Parameter1=Value1","Parameter2=Value2"...)`. For example: - `@("Enabled=true")` @@ -106,7 +114,6 @@ The Parameters parameter specifies one or more parameters for the override that Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -Reason + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Reason parameter specifies why you are creating the setting override. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -Section + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Section parameter specifies the name of the section for which the override is created. The available values for this parameter depend on the value of the Component parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -148,6 +159,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -157,7 +171,6 @@ 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 Required: False Position: Named @@ -167,13 +180,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,6 +198,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -191,7 +209,6 @@ 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 Required: False Position: Named @@ -201,6 +218,9 @@ Accept wildcard characters: False ``` ### -MaxVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxVersion parameter specifies the latest version of Exchange 2016 that this override applies to (up to and including the specified value). Valid input for this parameter is an Exchange 2016 version value in the format 15.1.xxx.xx. You can use values with leading zeros, but the leading zeros are removed from the results. For example, 15.01.0225.042 is stored as 15.1.225.42. @@ -211,7 +231,6 @@ The default value is blank ($null), which means the override applies to all vers Type: Version Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -221,6 +240,9 @@ Accept wildcard characters: False ``` ### -MinVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MinVersion parameter specifies the earliest version of Exchange 2016 that this override applies to (up to and including the specified value). Valid input for this parameter is an Exchange 2016 version value in the format 15.1.xxx.xx. You can use values with leading zeros, but the leading zeros are removed from the results. For example, 15.01.0225.042 is stored as 15.1.225.42. @@ -231,7 +253,6 @@ The default value is blank ($null), which means the override applies to all vers Type: Version Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +262,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the name of the Exchange 2016 server where you want the override applied. You can specify a single Exchange 2016 server name, or an array of Exchange 2016 server name wildcards. For example, if you have three Exchange 2016 servers named Exchange01, Exchange02 and Exchange03, specify the value Exchange\* to apply the override to all of them. If you don't use this parameter to specify a server, the override applies to all Exchange 2016 servers in the Active Directory forest. @@ -249,7 +273,6 @@ If you don't use this parameter to specify a server, the override applies to all Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,13 +282,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SharingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-SharingPolicy.md similarity index 73% rename from exchange/exchange-ps/exchange/New-SharingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-SharingPolicy.md index 45baa07e69..ab74be08f1 100644 --- a/exchange/exchange-ps/exchange/New-SharingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SharingPolicy.md @@ -1,22 +1,23 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-sharingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-SharingPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-sharingpolicy +schema: 2.0.0 +title: New-SharingPolicy --- # New-SharingPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the New-SharingPolicy cmdlet to create a sharing policy to regulate how users inside your organization can share calendar and contact information with users outside the organization. Users can only share this information after federation has been configured in Exchange. After federation is configured, users can send sharing invitations that comply with a sharing policy to external recipients in other Exchange Server 2010 or later organizations that have federation enabled. A sharing policy needs to get assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the level of sharing permitted for this mailbox. +Use the New-SharingPolicy cmdlet to create a sharing policy to regulate how users inside your organization can share calendar and contact information with users outside the organization. Users can only share this information after federation is configured in Exchange. After federation is configured, users can send sharing invitations that comply with a sharing policy to external recipients in other Exchange Server 2010 or later organizations that have federation enabled. A sharing policy needs to get assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the level of sharing permitted for this mailbox. -Sharing policies provide user-established, people-to-people sharing of both calendar and contact information with different types of external users. Sharing polices allow users to share both their free/busy and contact information (including the Calendar and Contacts folders) with recipients in other external federated Exchange organizations. For recipients that aren't in an external federated organization or are in non-Exchange organizations, sharing policies allow people-to-people sharing of their calendar information with anonymous users through the use of Internet Calendar Publishing. +Sharing policies provide user-established, people-to-people sharing of both calendar and contact information with different types of external users. Sharing policies allow users to share both their free/busy and contact information (including the Calendar and Contacts folders) with recipients in other external federated Exchange organizations. For recipients that aren't in an external federated organization or are in non-Exchange organizations, sharing policies allow people-to-people sharing of their calendar information with anonymous users through the use of Internet Calendar Publishing. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -33,7 +34,7 @@ New-SharingPolicy [-Name] -Domains ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,13 +55,15 @@ This example creates a default sharing policy, which is applied to all mailboxes ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the new sharing policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Domains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Domains parameter specifies the domains and the associated sharing options for those domains in the sharing policy. Values for this parameter use the basic syntax: `'Domain: SharingPolicyAction'`. You can use the following values for `Domain`: @@ -91,7 +97,6 @@ You can specify multiple `'Domain: SharingPolicyAction'` values separated by com Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -110,7 +118,6 @@ 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 Required: False Position: Named @@ -120,15 +127,17 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Default switch specifies that this sharing policy is the default sharing policy for all mailboxes. You don't need to specify a value with this switch. -If no sharing policy has been applied to a mailbox, the default policy is automatically applied. If you want to disable sharing across your organization, you can set the default policy as disabled. +If no sharing policy is applied to a mailbox, the default policy is automatically applied. If you want to disable sharing across your organization, you can set the default policy as disabled. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -146,7 +158,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter specifies whether to enable the new sharing policy. Valid input for this parameter is $true or $false. The default is $true. When the sharing policy is disabled, users who are provisioned to use this policy continue to share information until the sharing policy assistant runs and removes the permissions on the shared folder. The frequency with which the sharing policy assistant runs is assigned in the Set-MailboxServer cmdlet using the SharingPolicySchedule parameter. @@ -164,7 +178,6 @@ When the sharing policy is disabled, users who are provisioned to use this polic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SiteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/New-SiteMailbox.md similarity index 80% rename from exchange/exchange-ps/exchange/New-SiteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/New-SiteMailbox.md index 21fd001892..16c70bd0be 100644 --- a/exchange/exchange-ps/exchange/New-SiteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SiteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-sitemailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SiteMailbox -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-sitemailbox +schema: 2.0.0 +title: New-SiteMailbox --- # New-SiteMailbox @@ -37,7 +38,7 @@ New-SiteMailbox [[-DisplayName] ] -SharePointUrl ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,13 +52,15 @@ You can't run this cmdlet from the Exchange Management Shell. Use SharePoint to ## PARAMETERS ### -DisplayName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisplayName parameter specifies the display name that displays in the user's global address list and on SharePoint. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -SharePointUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SharePointUrl parameter specifies the SharePoint URL where the site mailbox is hosted, for example, "https://myserver/teams/edu". ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Alias parameter specifies the alias of the site mailbox. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -108,7 +118,6 @@ 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 Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Database parameter specifies the mailbox database that holds the mailbox data for the site mailbox. You can use any value that uniquely identifies the database. For example: - Name @@ -128,7 +140,6 @@ The Database parameter specifies the mailbox database that holds the mailbox dat Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,6 +167,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. This switch tests that site mailbox provisioning is working independently of the SharePoint deployment. We recommend that you never use this switch for production site mailboxes. @@ -162,7 +178,6 @@ This switch tests that site mailbox provisioning is working independently of the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +187,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of the site mailbox. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +205,15 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OrganizationalUnit parameter specifies the organizational unit in which the site mailbox resides. ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,13 +223,15 @@ Accept wildcard characters: False ``` ### -OverrideRecipientQuotas + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,13 +241,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-SiteMailboxProvisioningPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-SiteMailboxProvisioningPolicy.md index 2766674f44..34c86fc233 100644 --- a/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SiteMailboxProvisioningPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-sitemailboxprovisioningpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SiteMailboxProvisioningPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-sitemailboxprovisioningpolicy +schema: 2.0.0 +title: New-SiteMailboxProvisioningPolicy --- # New-SiteMailboxProvisioningPolicy @@ -39,7 +40,7 @@ New-SiteMailboxProvisioningPolicy [-Name] ## DESCRIPTION Site mailboxes allow access to both Microsoft SharePoint documents and Exchange email using the same client interface. Site mailbox provisioning policies apply settings to new site mailboxes that you create. You can create multiple site mailbox provisioning policies, but only the default policy is followed when users create site mailboxes. The default site mailbox provisioning policy is named Default. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,13 +72,15 @@ This example creates the default provisioning policy named SM\_DefaultPolicy and ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name of the site mailbox provisioning policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -87,16 +90,18 @@ Accept wildcard characters: False ``` ### -AliasPrefix + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AliasPrefix parameter specifies the custom text prefix to add to the aliases of new site mailboxes. Valid values are: - A text string that's 8 characters or less. When you specify a text value, the value of the DefaultAliasPrefixEnabled parameter ignored and aliases get the text prefix you specified. -- The value $null. This is the default value. The results of this value depend on the DefaultAliasPrefixEnabled parameter value. When it's $true, aliases get the default prefix text. When it's $false, aliases don't get any prefix text. +- The value $null. This value is the default. The results of this value depend on the DefaultAliasPrefixEnabled parameter value. When it's $true, aliases get the default prefix text. When it's $false, aliases don't get any prefix text. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -115,7 +123,6 @@ 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 Required: False Position: Named @@ -125,9 +132,12 @@ Accept wildcard characters: False ``` ### -DefaultAliasPrefixEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DefaultAliasPrefixEnabled parameter specifies whether new site mailboxes have the default prefix text added to the alias. Valid values are: -- $true: Aliases get the default prefix text. This is the default value. In Microsoft 365, the default prefix text is `SMO-` (for example, the alias value `BugBash_2016` becomes `SMO-BugBash_2016`). In on-premises Exchange, the default prefix text is `SM-` (for example, the alias value `BugBash_2016` becomes `SM-BugBash_2016`). +- $true: Aliases get the default prefix text. This value is the default. In Microsoft 365, the default prefix text is `SMO-` (for example, the alias value `BugBash_2016` becomes `SMO-BugBash_2016`). In on-premises Exchange, the default prefix text is `SM-` (for example, the alias value `BugBash_2016` becomes `SM-BugBash_2016`). - $false: Aliases don't get the default prefix text. The value of this parameter is related to the value of the AliasPrefix parameter. If you specify a text string for AliasPrefix, the DefaultAliasPrefixEnabled value is ignored. Specifying a text value for AliasPrefix automatically sets the value to $false, but even if you set it to $true, the default alias prefix text isn't used. @@ -136,7 +146,6 @@ The value of this parameter is related to the value of the AliasPrefix parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsDefault switch specifies that the site mailbox provisioning policy is the default policy. You don't need to specify a value with this switch. You can have multiple policies, but only the default policy is followed when users create site mailboxes. @@ -170,7 +184,6 @@ You can have multiple policies, but only the default policy is followed when use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -190,7 +206,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The IssueWarningQuota value must be less than or equal to the ProhibitSendReceiveQuota value. @@ -200,7 +216,6 @@ The default value is 49 GB. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +225,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the site mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -219,7 +237,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the value unlimited. The default value is 36 MB. @@ -227,7 +245,6 @@ A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the val Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,6 +254,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -247,7 +267,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. @@ -257,7 +277,6 @@ The default value is 50 GB. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -267,13 +286,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewPolicyV2.md similarity index 87% rename from exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md rename to exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewPolicyV2.md index e598d096c9..7d1af9bad2 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewPolicyV2.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-supervisoryreviewpolicyv2 applicable: Security & Compliance -title: New-SupervisoryReviewPolicyV2 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-supervisoryreviewpolicyv2 +schema: 2.0.0 +title: New-SupervisoryReviewPolicyV2 --- # New-SupervisoryReviewPolicyV2 @@ -27,6 +28,7 @@ New-SupervisoryReviewPolicyV2 [-Name] -Reviewers [-Enabled ] [-Force] [-PolicyRBACScopes ] + [-PreservationPeriodInDays ] [-UserReportingWorkloads ] [-WhatIf] [] @@ -47,13 +49,15 @@ This example creates a new supervisory review policy named EU Brokers Policy. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the supervisory review policy. The name can't exceed 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 @@ -63,13 +67,15 @@ Accept wildcard characters: False ``` ### -Reviewers + +> Applicable: Security & Compliance + The Reviewers parameter specifies the SMTP addresses of the reviewers for the supervisory review policy. You can specify multiple email addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -95,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -104,7 +115,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -114,13 +124,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + {{ Fill Enabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -130,6 +142,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -138,7 +153,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -148,13 +162,33 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + {{ 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 + +> Applicable: Security & Compliance + +{{ Fill PreservationPeriodInDays Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -164,13 +198,15 @@ Accept wildcard characters: False ``` ### -UserReportingWorkloads + +> Applicable: Security & Compliance + {{ Fill UserReportingWorkloads Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -180,13 +216,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md b/exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewRule.md similarity index 87% rename from exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewRule.md index d087a6ab50..c9b43118c5 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-supervisoryreviewrule applicable: Security & Compliance -title: New-SupervisoryReviewRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-supervisoryreviewrule +schema: 2.0.0 +title: New-SupervisoryReviewRule --- # New-SupervisoryReviewRule @@ -22,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` New-SupervisoryReviewRule [-Name] -Policy + [-AdvancedRule ] [-CcsiDataModelOperator ] [-Condition ] [-Confirm] @@ -39,6 +41,7 @@ New-SupervisoryReviewRule [-Name] -Policy [-IncludeAdaptiveScopes ] [-InPurviewFilter ] [-Ocr ] + [-PolicyRBACScopes ] [-SamplingRate ] [-SentTo ] [-WhatIf] @@ -65,13 +68,15 @@ This example creates a new supervisory review rule named EU Brokers Rule with th ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the supervisory review rule. The name can't exceed 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 @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the supervisory review policy that's assigned to the rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -91,7 +99,6 @@ The Policy parameter specifies the supervisory review policy that's assigned to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -100,14 +107,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AdvancedRule + +> Applicable: Security & Compliance + +{{ Fill AdvancedRule Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CcsiDataModelOperator + +> Applicable: Security & Compliance + {{ Fill CcsiDataModelOperator Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,6 +144,9 @@ Accept wildcard characters: False ``` ### -Condition + +> Applicable: Security & Compliance + The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: - User or group communications to supervise: `"((Reviewee:) -OR (Reviewee:)...)"`. Exceptions use the syntax `"(NOT((Reviewee:) -OR (Reviewee:)...))"`. @@ -133,7 +163,6 @@ The Condition parameter specifies the conditions and exceptions for the rule. Th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -143,6 +172,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -152,7 +184,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -162,13 +193,15 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + {{ Fill ContentContainsSensitiveInformation Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -178,13 +211,15 @@ Accept wildcard characters: False ``` ### -ContentMatchesDataModel + +> Applicable: Security & Compliance + {{ Fill ContentMatchesDataModel Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -194,13 +229,15 @@ Accept wildcard characters: False ``` ### -ContentSources + +> Applicable: Security & Compliance + {{ Fill ContentSources Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -210,13 +247,15 @@ Accept wildcard characters: False ``` ### -DayXInsights + +> Applicable: Security & Compliance + {{ Fill DayXInsights Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -226,13 +265,15 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + {{ Fill ExceptIfFrom Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -242,13 +283,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfRecipientDomainIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -258,13 +301,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRevieweeIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfRevieweeIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -274,13 +319,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfSenderDomainIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -290,13 +337,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + {{ Fill ExceptIfSentTo Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -306,13 +355,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Security & Compliance + {{ Fill ExceptIfSubjectOrBodyContainsWords Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -322,13 +373,15 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + {{ Fill From Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -338,13 +391,15 @@ Accept wildcard characters: False ``` ### -IncludeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill IncludeAdaptiveScopes Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -354,13 +409,15 @@ Accept wildcard characters: False ``` ### -InPurviewFilter + +> Applicable: Security & Compliance + {{ Fill InPurviewFilter Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -370,13 +427,33 @@ Accept wildcard characters: False ``` ### -Ocr + +> Applicable: Security & Compliance + {{ Fill Ocr Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes + +> Applicable: Security & Compliance + +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -386,13 +463,15 @@ Accept wildcard characters: False ``` ### -SamplingRate + +> Applicable: Security & Compliance + The SamplingRate parameter specifies the percentage of communications for review. If you want reviewers to review all detected items, use the value 100. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -402,13 +481,15 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + {{ Fill SentTo Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -418,13 +499,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/New-SweepRule.md similarity index 84% rename from exchange/exchange-ps/exchange/New-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-SweepRule.md index 6aa53c55aa..6de7b9487a 100644 --- a/exchange/exchange-ps/exchange/New-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SweepRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-sweeprule -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-SweepRule -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-sweeprule +schema: 2.0.0 +title: New-SweepRule --- # New-SweepRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-SweepRule cmdlet to create Sweep rules in mailboxes. Sweep rules run at regular intervals to help keep your Inbox clean. @@ -39,7 +40,7 @@ New-SweepRule [-Name] -Provider ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,13 +67,15 @@ This example creates a new Sweep rule named "From Jeff" in Felipe Apodaca's mail ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the Sweep rule. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Provider + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Provider parameter specifies the provider for the Sweep rule. If the value contains spaces, enclose the value in quotation marks. For Sweep rules that you create in Outlook on the web, the default value is Exchange16. @@ -90,7 +96,6 @@ For Sweep rules that you create in Outlook on the web, the default value is Exch Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -109,7 +117,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -DestinationFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -140,7 +150,6 @@ Example values for this parameter are `john@contoso.com:\Unimportant` or `John:\ Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -158,7 +170,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,9 +179,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter specifies whether the Sweep rule is enabled or disabled. Valid values are: -- $true: The rule is enabled. This is the default value. +- $true: The rule is enabled. This value is the default. - $false: The rule is disabled. After you create the rule, you can enable or disable it by using the Enable-SweepRule and Disable-SweepRule cmdlets. @@ -179,7 +193,6 @@ After you create the rule, you can enable or disable it by using the Enable-Swee Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -189,6 +202,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFlagged + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: @@ -214,7 +230,6 @@ The typical message flag values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,6 +239,9 @@ Accept wildcard characters: False ``` ### -ExceptIfPinned + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: @@ -235,7 +253,6 @@ 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 Required: False Position: Named @@ -245,6 +262,9 @@ Accept wildcard characters: False ``` ### -KeepForDays + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The KeepForDays parameter specifies an action for the Sweep rule that specifies the number of days to keep messages that match the conditions of the rule. After the number of days have passed, the messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). You can't use this parameter with the KeepLatest parameter and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. @@ -253,7 +273,6 @@ You can't use this parameter with the KeepLatest parameter and the Sweep rule mu Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -263,6 +282,9 @@ Accept wildcard characters: False ``` ### -KeepLatest + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The KeepLatest parameter specifies an action for the Sweep rule that specifies the number of messages to keep that match the conditions of the rule. After the number of messages is exceeded, the oldest messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). You can't use this parameter with the KeepForDays parameter and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. @@ -271,7 +293,6 @@ You can't use this parameter with the KeepForDays parameter and the Sweep rule m Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -281,6 +302,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox where you want to create the Sweep rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -298,7 +322,6 @@ The Mailbox parameter specifies the mailbox where you want to create the Sweep r Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -308,6 +331,9 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Sender parameter specifies a condition for the Sweep rule that looks for the specified sender in messages. For internal senders, you can use any value that uniquely identifies the sender. For example: - Name @@ -323,7 +349,6 @@ For external senders, use their email address. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -333,6 +358,9 @@ Accept wildcard characters: False ``` ### -SourceFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -354,7 +382,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -364,6 +391,9 @@ Accept wildcard characters: False ``` ### -SystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SystemCategory parameter specifies a condition for the sweep rule that looks for messages with the specified system category. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -395,7 +425,6 @@ The SystemCategory parameter specifies a condition for the sweep rule that looks Type: SystemCategoryType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -405,13 +434,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/New-SyncMailPublicFolder.md similarity index 86% rename from exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/New-SyncMailPublicFolder.md index 8084e8b744..26111affea 100644 --- a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SyncMailPublicFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-syncmailpublicfolder -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-SyncMailPublicFolder -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-syncmailpublicfolder +schema: 2.0.0 +title: New-SyncMailPublicFolder --- # New-SyncMailPublicFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. The New-SyncMailPublicFolder cmdlet is used by the Import-MailPublicFoldersForMigration.ps1 and Sync-MailPublicFolders.ps1 scripts to create mail-enabled public folder recipient objects in Exchange Online (the scripts synchronize mail-enabled public folder objects from the source on-premises Exchange organization to Exchange Online). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation. @@ -62,7 +63,7 @@ New-SyncMailPublicFolder [-Name] [-Alias] -EntryId ## DESCRIPTION This cmdlet is only used by the Import-MailPublicFoldersForMigration.ps1 and Sync-MailPublicFolders.ps1 scripts. Don't run this cmdlet in the Exchange Management Shell or in Exchange Online PowerShell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -76,6 +77,9 @@ This cmdlet is only used by the Import-MailPublicFoldersForMigration.ps1 and Syn ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name of the mail-enabled public folder. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). This value is also used for the DisplayName property if you don't use the DisplayName parameter. @@ -84,7 +88,6 @@ This value is also used for the DisplayName property if you don't use the Displa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -118,7 +124,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -128,13 +133,15 @@ Accept wildcard characters: False ``` ### -EntryId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -165,7 +175,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: DeliveryRecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -175,6 +184,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -184,7 +196,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -194,6 +205,9 @@ Accept wildcard characters: False ``` ### -Contacts + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Contacts parameter specifies the contacts for the public folder. Contacts are persons about whom you can save several types of information, such as addresses, telephone numbers, and web page URLs. Valid values for this parameter are recipients in your organization. You can use any value that uniquely identifies the recipient. For example: @@ -211,7 +225,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -221,13 +234,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -237,13 +252,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -253,13 +270,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -269,13 +288,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -285,13 +306,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -301,13 +324,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -317,13 +342,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -333,13 +360,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -349,13 +378,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -365,13 +396,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -381,13 +414,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -397,13 +432,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -413,13 +450,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -429,13 +468,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -445,13 +486,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -461,10 +504,13 @@ Accept wildcard characters: False ``` ### -DeliverToMailboxAndForward + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeliverToMailboxAndForward parameter specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress parameter. Valid values are: - $true: Messages are delivered to this mail-enabled public folder and forwarded to the specified recipient or email address. -- $false: If a forwarding recipient is configured, messages are delivered only to the specified recipient, and messages aren't delivered to this mail-enabled public folder. If no forwarding recipient is configured, messages are delivered only to this mailbox. This is the default value. +- $false: If a forwarding recipient is configured, messages are delivered only to the specified recipient, and messages aren't delivered to this mail-enabled public folder. If no forwarding recipient is configured, messages are delivered only to this mailbox. This value is the default. The default value is $false. This parameter is meaningful only if you configure a forwarding recipient by using the ForwardingAddress parameter. @@ -472,7 +518,6 @@ The default value is $false. This parameter is meaningful only if you configure Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -482,6 +527,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DisplayName parameter specifies the display name of the mail-enabled public folder. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -490,7 +538,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -500,6 +547,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -508,7 +558,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -518,6 +567,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -539,7 +591,6 @@ To specify the primary SMTP email address, you can use any of the following meth Type: ProxyAddress[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -549,13 +600,15 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalEmailAddress parameter specifies an email address outside the organization. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -565,6 +618,9 @@ Accept wildcard characters: False ``` ### -ForwardingAddress + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForwardingAddress parameter specifies a forwarding address for messages that are sent to this mail-enabled public folder. A valid value for this parameter is a recipient in your organization. You can use any value that uniquely identifies the recipient. For example: - Name @@ -585,7 +641,6 @@ The default value is blank ($null), which means no forwarding recipient is confi Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -595,6 +650,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mail-enabled public folder. Although messages send on behalf of the public folder clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the public folder, not the sender. The sender 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 sender. For example: @@ -614,7 +672,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -624,13 +681,15 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HiddenFromAddressListsEnabled switch specifies that this recipient is not visible in address lists. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -640,6 +699,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail-enabled public folder. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -649,7 +711,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -659,7 +721,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -669,6 +730,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail-enabled public folder. When you enter a value, qualify the value with one of the following units: @@ -678,7 +742,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -688,7 +752,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -698,13 +761,15 @@ Accept wildcard characters: False ``` ### -OnPremisesObjectId + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OnPremisesObjectId parameter specifies the GUID of the on-premises mail-enabled public folder that's used to create the mail-enabled public folder object in Exchange Online. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -714,13 +779,15 @@ Accept wildcard characters: False ``` ### -OverrideRecipientQuotas + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -730,6 +797,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -751,7 +821,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: DeliveryRecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -761,6 +830,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -770,7 +842,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -780,13 +851,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -796,6 +869,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -807,7 +883,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SystemMessage.md b/exchange/exchange-ps/ExchangePowerShell/New-SystemMessage.md similarity index 87% rename from exchange/exchange-ps/exchange/New-SystemMessage.md rename to exchange/exchange-ps/ExchangePowerShell/New-SystemMessage.md index 05d97b7970..5adbdc6072 100644 --- a/exchange/exchange-ps/exchange/New-SystemMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SystemMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-systemmessage -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SystemMessage -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-systemmessage +schema: 2.0.0 +title: New-SystemMessage --- # New-SystemMessage @@ -41,7 +42,7 @@ New-SystemMessage -Language -QuotaMessageType - ## DESCRIPTION NDRs are issued to the senders of email messages that haven't reached their intended recipients. Quota messages are issued to users whose mailboxes or public folders have reached the specific warning, prohibit send, or prohibit receive quotas. Custom NDRs and quota messages replace the default messages that are included with Exchange. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example creates a custom English quota message for mailboxes that exceed th ## PARAMETERS ### -DsnCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DsnCode parameter specifies the enhanced status code for the custom system message. Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. You can specify a default code that's included with Exchange, or you can specify a custom code. @@ -76,7 +80,6 @@ You can't use this parameter with the QuotaMessageType parameter. Type: EnhancedStatusCode Parameter Sets: Dsn Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Internal + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Internal parameter specifies whether the system message is displayed to internal or external users. Valid values are: - $true: The NDR is displayed to internal senders. @@ -99,7 +105,6 @@ You can't use this parameter with the QuotaMessageType parameter. Type: Boolean Parameter Sets: Dsn Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Language parameter specifies the language of the message (for example, en for English or ja for Japanese). For the list of supported language codes, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). You need to use this parameter with the DsnCode or QuotaMessageType parameters. @@ -117,7 +125,6 @@ You need to use this parameter with the DsnCode or QuotaMessageType parameters. Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -QuotaMessageType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QuotaMessageType parameter specifies the quota for the custom system message. Valid values are: Mailbox size quotas: @@ -171,7 +181,6 @@ You can't use this parameter with the DsnCode or Internal parameters. Type: QuotaMessageType Parameter Sets: Quota Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -Text + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Text parameter specifies the text in the custom system message. The text should explain why the system message was sent, and any actions that the user should take. You need to use this parameter with the DsnCode or QuotaMessageType parameters. @@ -193,7 +205,7 @@ The following HTML tags are available: - `` and `` (italic) - `
` (line break) - `

` and `

` (paragraph) -- `` and `` (hyperlink). **Note**: You need to use single quotation marks (not double quotation marks) around the complete text string if you use this tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). +- `` and `` (hyperlink). **Note**: You need to use single quotation marks (not double quotation marks) around the complete text string if you use this tag. Otherwise, you get an error (because of the double quotation marks in the tag). Use the following escape codes for these special characters: @@ -210,7 +222,6 @@ Here's an example value for this parameter that uses HTML tags and special chara Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -220,6 +231,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -229,7 +243,6 @@ 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 Required: False Position: Named @@ -239,6 +252,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -247,7 +263,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,13 +272,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicy.md index 18775fc30b..0968adb205 100644 --- a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-teamsprotectionpolicy applicable: Exchange Online -title: New-TeamsProtectionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-teamsprotectionpolicy +schema: 2.0.0 +title: New-TeamsProtectionPolicy --- # New-TeamsProtectionPolicy @@ -34,7 +35,7 @@ New-TeamsProtectionPolicy [-Name] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,13 +49,15 @@ This example creates the Teams protection policy with the default values. ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the unique name of the Teams protection policy. If the value contains spaces, enclose the value in quotation marks. The default name of the Teams protection policy in an organization is Teams Protection Policy. We recommend using this value. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -64,6 +67,12 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + + +> Applicable: Exchange Online + 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`. @@ -73,8 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online -Applicable: Exchange Online Required: False Position: Named @@ -84,6 +91,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishQuarantineTag + +> Applicable: Exchange Online + The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as high confidence phishing by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -98,7 +108,6 @@ If you don't use this parameter, the default quarantine policy that's used is na Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,6 +117,9 @@ Accept wildcard characters: False ``` ### -MalwareQuarantineTag + +> Applicable: Exchange Online + The MalwareQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as malware by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -122,7 +134,6 @@ If you don't use this parameter, the default quarantine policy that's used is na Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,13 +143,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -148,13 +161,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 @@ -164,16 +179,18 @@ Accept wildcard characters: False ``` ### -ZapEnabled + +> Applicable: Exchange Online + The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware and high confidence phishing messages in Teams messages. Valid values are: -- $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This is the default value. +- $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This value is the default. - $false: ZAP for malware and high confidence phishing messages in Teams is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicyRule.md similarity index 90% rename from exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicyRule.md index b2a9f0c731..dae92b700a 100644 --- a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-teamsprotectionpolicyrule applicable: Exchange Online -title: New-TeamsProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-teamsprotectionpolicyrule +schema: 2.0.0 +title: New-TeamsProtectionPolicyRule --- # New-TeamsProtectionPolicyRule @@ -44,7 +45,7 @@ You can use this cmdlet only if the following statements are true: > [!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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,13 +59,15 @@ This example creates the Teams protection policy rule with members of the group ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the unique name of the Teams protection policy rule. If the value contains spaces, enclose the value in quotation marks. The default name of the Teams protection policy rule in an organization is Teams Protection Policy Rule. We recommend using this value. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -TeamsProtectionPolicy + +> Applicable: Exchange Online + The TeamsProtectionPolicy parameter specifies the Teams protection policy that's associated with this rule. The only available policy is named Teams Protection Policy. ```yaml Type: TeamsProtectionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -115,7 +125,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -141,13 +152,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +170,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -172,7 +188,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -182,6 +197,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception to ZAP for Teams protection that looks for Teams messages sent to members of distribution groups or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -199,7 +217,6 @@ If you remove the group after you create the rule, no exception is made for Team Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -225,13 +244,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListItems.md similarity index 73% rename from exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md rename to exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListItems.md index c107708874..f4de39cad9 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-tenantallowblocklistitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: New-TenantAllowBlockListItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-tenantallowblocklistitems +schema: 2.0.0 +title: New-TenantAllowBlockListItems --- # New-TenantAllowBlockListItems @@ -49,7 +50,7 @@ New-TenantAllowBlockListItems -Entries -ListType [-NoExpir ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,11 +73,23 @@ 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 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). +This example adds a URL allow entry for the specified non-Microsoft phishing simulation URL with no expiration. For more information, see [Configure the advanced delivery policy for non-Microsoft 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 + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Entries parameter specifies the values that you want to add to the Tenant Allow/Block List based on the ListType parameter value: - FileHash: Use the SHA256 hash value of the file. You can find the SHA256 hash value by running the following command in PowerShell: `Get-FileHash -Path "\" -Algorithm SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. @@ -94,9 +107,9 @@ To enter multiple values, use the following syntax: `"Value1","Value2",..."Value 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. +- **Organizations without Microsoft Defender for Office 365**: The maximum number of allow entries is 500, and the maximum number of block entries is 500. +- **Organizations with Defender for Office 365 Plan 1**: The maximum number of allow entries is 1000, and the maximum number of block entries is 1000. +- **Organizations with 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. @@ -108,7 +121,6 @@ In most cases, you can't modify the sender, URL, file, or IP address values afte Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -118,6 +130,9 @@ Accept wildcard characters: False ``` ### -ExpirationDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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: @@ -131,7 +146,6 @@ You can't use this parameter with the NoExpiration or RemoveAfter parameters. Type: DateTime Parameter Sets: Expiration Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -141,6 +155,9 @@ Accept wildcard characters: False ``` ### -ListType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListType parameter specifies the type of entry to add. Valid values are: - FileHash @@ -152,7 +169,6 @@ The ListType parameter specifies the type of entry to add. Valid values are: Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -162,6 +178,9 @@ Accept wildcard characters: False ``` ### -NoExpiration + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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 in the following scenarios: @@ -176,7 +195,6 @@ You can't use this switch with the ExpirationDate or RemoveAfter parameter. Type: SwitchParameter Parameter Sets: NoExpiration Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -186,19 +204,21 @@ Accept wildcard characters: False ``` ### -Allow + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Allow switch specifies that you're creating an allow entry. You don't need to specify a value with this switch. You can't use this switch with the Block switch. **Note**: See [Allow entries in the Tenant Allow/Block List](https://learn.microsoft.com/defender-office-365/tenant-allow-block-list-about#allow-entries-in-the-tenant-allowblock-list), before you try to create an allow entry. -You can also use allow entries for third-party phishing simulation URLs with no expiration. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +You can also use allow entries for non-Microsoft phishing simulation URLs with no expiration. For more information, see [Configure the advanced delivery policy for non-Microsoft phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -208,6 +228,9 @@ Accept wildcard characters: False ``` ### -Block + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Allow switch specifies that you're creating a block entry. You don't need to specify a value with this switch. You can't use this switch with the Allow switch. @@ -216,7 +239,6 @@ You can't use this switch with the Allow switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -226,16 +248,18 @@ Accept wildcard characters: False ``` ### -ListSubType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListSubType parameter specifies the subtype for this entry. Valid values are: -- AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). -- Tenant: This is the default value. +- AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the advanced delivery policy for non-Microsoft phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +- Tenant: This value is the default. ```yaml Type: ListSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -245,13 +269,15 @@ Accept wildcard characters: False ``` ### -LogExtraDetails + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill LogExtraDetails Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -261,13 +287,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -277,17 +305,21 @@ Accept wildcard characters: False ``` ### -RemoveAfter + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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 @@ -297,6 +329,9 @@ Accept wildcard characters: False ``` ### -OutputJson + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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. You use this switch to prevent the command from halting on the first entry that contains a syntax error. @@ -305,7 +340,6 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -315,13 +349,15 @@ Accept wildcard characters: False ``` ### -SubmissionID + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListSpoofItems.md similarity index 83% rename from exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md rename to exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListSpoofItems.md index 48976dd565..049fb245fe 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListSpoofItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-tenantallowblocklistspoofitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: New-TenantAllowBlockListSpoofItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-tenantallowblocklistspoofitems +schema: 2.0.0 +title: New-TenantAllowBlockListSpoofItems --- # New-TenantAllowBlockListSpoofItems @@ -30,7 +31,7 @@ New-TenantAllowBlockListSpoofItems [-Identity] Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter uses the value Default. ```yaml Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -SendingInfrastructure + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SendingInfrastructure parameter specifies the source of the messages sent by the spoofed sender that's defined in the SpoofedUser parameter. Valid values are: - An email domain (for example contoso.com). The domain is found in the reverse DNS lookup (PTR record) of the source email server's IP address. @@ -70,7 +76,6 @@ The SendingInfrastructure parameter specifies the source of the messages sent by Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: True ``` ### -SpoofedUser + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SpoofedUser parameter specifies the email address or domain for the spoofed sender entry. - For domains outside your organization (cross-org), use the domain of the email address that appears in the From field of the message. @@ -91,7 +99,6 @@ For spoofed senders, the maximum number of entries is 1024. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: True ``` ### -SpoofType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SpoofType parameter specifies whether this is an internal or external spoofed sender entry. Valid values are: - External @@ -110,7 +120,6 @@ The SpoofType parameter specifies whether this is an internal or external spoofe Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Action parameter specifies whether is an allowed or blocked spoofed sender entry. Valid values are: - Allow @@ -129,7 +141,6 @@ The Action parameter specifies whether is an allowed or blocked spoofed sender e Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -139,6 +150,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -148,7 +162,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -158,13 +171,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-ThrottlingPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/New-ThrottlingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-ThrottlingPolicy.md index 4b540a9784..4cdeb36baf 100644 --- a/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ThrottlingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-throttlingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ThrottlingPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-throttlingpolicy +schema: 2.0.0 +title: New-ThrottlingPolicy --- # New-ThrottlingPolicy @@ -177,7 +178,7 @@ By default, there is one default throttling policy named `GlobalThrottlingPolicy For more information about how to control how resources are consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -233,13 +234,15 @@ This example creates a throttling policy that restricts a user to be able to onl ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of the object in Active Directory. The default policy is named `DefaultThrottlingPolicy`. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -249,13 +252,15 @@ Accept wildcard characters: False ``` ### -AnonymousCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnonymousCutoffBalance parameter specifies the resource consumption limits for an anonymous user before the user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -265,13 +270,15 @@ Accept wildcard characters: False ``` ### -AnonymousMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnonymousMaxBurst parameter specifies the amount of time that an anonymous user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,13 +288,15 @@ Accept wildcard characters: False ``` ### -AnonymousMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnonymousMaxConcurrency parameter specifies how many anonymous connections can be made to a user's calendar data at the same time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If anonymous users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The AnonymousMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 1. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,6 +306,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInAD parameter specifies the percentage of a minute that anonymous users can spend executing LDAP requests (PercentTimeInAD) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -305,7 +317,6 @@ The AnonymousPercentTimeInAD parameter specifies the percentage of a minute that Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -315,6 +326,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInCAS parameter specifies the percentage of a minute that anonymous users can spend executing CAS code (PercentTimeInCAS) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -323,7 +337,6 @@ The AnonymousPercentTimeInCAS parameter specifies the percentage of a minute tha Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -333,6 +346,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInMailboxRPC parameter specifies the percentage of a minute that anonymous users can spend executing mailbox RPC requests (PercentTimeInMailboxRPC) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -341,7 +357,6 @@ The AnonymousPercentTimeInMailboxRPC parameter specifies the percentage of a min Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -351,13 +366,15 @@ Accept wildcard characters: False ``` ### -AnonymousRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnonymousRechargeRate parameter specifies the rate at which an anonymous user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -367,13 +384,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -383,13 +402,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -399,13 +420,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -415,13 +438,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -431,13 +456,15 @@ Accept wildcard characters: False ``` ### -ComplianceMaxExpansionDGRecipients + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ComplianceMaxExpansionDGRecipients parameter specifies the maximum number of recipients to expand in distribution groups when a discovery search is looking for a specified recipient. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -447,13 +474,15 @@ Accept wildcard characters: False ``` ### -ComplianceMaxExpansionNestedDGs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ComplianceMaxExpansionNestedDGs parameter specifies the maximum number of nested distribution groups to expand when a discovery search is looking for a specified recipient. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -463,6 +492,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -472,7 +504,6 @@ 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 Required: False Position: Named @@ -482,13 +513,15 @@ Accept wildcard characters: False ``` ### -ConsensusCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -498,13 +531,15 @@ Accept wildcard characters: False ``` ### -ConsensusMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -514,13 +549,15 @@ Accept wildcard characters: False ``` ### -ConsensusMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -530,13 +567,15 @@ Accept wildcard characters: False ``` ### -ConsensusRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -546,13 +585,15 @@ Accept wildcard characters: False ``` ### -CpaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CpaCutoffBalance parameter specifies the resource consumption limits for a cross-premises user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -562,13 +603,15 @@ Accept wildcard characters: False ``` ### -CpaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CpaMaxBurst parameter specifies the amount of time that a cross-premises user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -578,13 +621,15 @@ Accept wildcard characters: False ``` ### -CPAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CpaMaxConcurrency parameter specifies how many concurrent connections a cross-premises user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The CpaMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -594,13 +639,15 @@ Accept wildcard characters: False ``` ### -CPAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + The CPAPercentTimeInCAS parameter specifies the percentage of a minute that a cross-premises user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -610,6 +657,9 @@ Accept wildcard characters: False ``` ### -CPAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CPAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that a cross-premises user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -618,7 +668,6 @@ The CPAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -628,13 +677,15 @@ Accept wildcard characters: False ``` ### -CpaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CpaRechargeRate parameter specifies the rate at which a cross premises user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -644,6 +695,9 @@ Accept wildcard characters: False ``` ### -CPUStartPercent + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CPUStartPercent parameter specifies the per-process CPU percentage at which users governed by this policy begin to be backed off. Valid values are from 0 through 100. Use $null to turn off CPU percentage-based throttling for this policy. @@ -652,7 +706,6 @@ The CPUStartPercent parameter specifies the per-process CPU percentage at which Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -662,13 +715,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxConcurrency parameter specifies the number of concurrent discovery search executions that a user can have at the same time. To modify the discovery throttling parameters, create a new policy and name it "DiscoveryThrottlingPolicy". ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -678,13 +733,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxKeywords -The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchange/search-mailbox). + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchangepowershell/search-mailbox). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -694,13 +751,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxKeywordsPerPage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxKeywordsPerPage parameter specifies the number of keywords for which to show statistics on a single page in the EAC. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -710,13 +769,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxMailboxes parameter specifies the maximum number of source mailboxes that a user can include in a discovery search. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -726,13 +787,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxPreviewSearchMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxPreviewSearchMailboxes parameter specifies the maximum number of mailboxes that a user can include in eDiscovery Search Preview. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -742,13 +805,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxRefinerResults -This parameter isn't used and will be removed. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -758,13 +823,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxSearchQueueDepth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxSearchQueueDepth parameter specifies the maximum number of concurrent discovery search threads that can be active at the same time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -774,13 +841,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxStatsSearchMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxStatsSearchMailboxes parameter specifies the maximum number of mailboxes that a user can search in an In-Place eDiscovery search without being able to view the statistics. When the number of mailboxes configured with the DiscoveryMaxStatsSearchMailboxes parameter is exceeded, the user must copy the search results to a discovery mailbox to view the statistics for the discovery search. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -790,13 +859,15 @@ Accept wildcard characters: False ``` ### -DiscoveryPreviewSearchResultsPageSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryPreviewSearchResultsPageSize parameter specifies the number of messages displayed on a single page in eDiscovery Search Preview. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -806,13 +877,15 @@ Accept wildcard characters: False ``` ### -DiscoverySearchTimeoutPeriod -The DiscoverySearchTimeoutPeriod parameter specifies the number of minutes that a discovery search will run before it times out. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The DiscoverySearchTimeoutPeriod parameter specifies the number of minutes that a discovery search runs before it times out. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -822,6 +895,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -830,7 +906,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -840,13 +915,15 @@ Accept wildcard characters: False ``` ### -EasCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasCutoffBalance parameter specifies the resource consumption limits for an Exchange ActiveSync user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -856,13 +933,15 @@ Accept wildcard characters: False ``` ### -EasMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasMaxBurst parameter specifies the amount of time that an Exchange ActiveSync user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -872,13 +951,15 @@ Accept wildcard characters: False ``` ### -EASMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasMaxConcurrency parameter specifies how many concurrent connections an Exchange ActiveSync user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The EasMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 10. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -888,13 +969,15 @@ Accept wildcard characters: False ``` ### -EASMaxDeviceDeletesPerMonth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasMaxDeviceDeletesPerMonth parameter specifies a limit to the number of Exchange ActiveSync partnerships that a user can delete per month. By default, each user can delete a maximum of 20 partnerships per calendar month. When the limit is reached, the partnership deletion attempt fails and an error message is displayed to the user. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -904,13 +987,15 @@ Accept wildcard characters: False ``` ### -EASMaxDevices + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasMaxDevices parameter specifies a limit to the number of Exchange ActiveSync partnerships that a user can have at one time. By default, each user can create 100 Exchange ActiveSync partnerships with their Exchange account. After users exceed the limit, they must delete one of their existing partnerships before they can create any more new partnerships. An email error message describing the limitation is sent to the user when the limit is exceeded. Additionally, an event is logged in the Application log when a user exceeds the limit. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -920,13 +1005,15 @@ Accept wildcard characters: False ``` ### -EasMaxInactivityForDeviceCleanup -The EasMaxInactivityForDeviceCleanup parameter specifies the length of time that a user's device partnerships will remain active. By default, there is no limit to the number of days that a user's device partnerships will remain active. Use this value if you want to minimize the amount of inactive device partnerships in your organization. To use this setting, specify a value in days since the user's last sync time to cause the device partnership to be removed. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The EasMaxInactivityForDeviceCleanup parameter specifies the length of time that a user's device partnerships remain active. By default, there is no limit to the number of days that a user's device partnerships remain active. Use this value if you want to minimize the amount of inactive device partnerships in your organization. To use this setting, specify a value in days since the user's last sync time to cause the device partnership to be removed. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -936,6 +1023,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInAD parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -944,7 +1034,6 @@ The EASPercentTimeInAD parameter specifies the percentage of a minute that an Ex Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -954,6 +1043,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInCAS parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -962,7 +1054,6 @@ The EASPercentTimeInCAS parameter specifies the percentage of a minute that an E Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -972,6 +1063,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -980,7 +1074,6 @@ The EASPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -990,13 +1083,15 @@ Accept wildcard characters: False ``` ### -EasRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasRechargeRate parameter specifies the rate at which an Exchange ActiveSync user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1006,13 +1101,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1022,13 +1119,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1038,13 +1137,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1054,13 +1155,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1070,13 +1173,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1086,13 +1191,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1102,13 +1209,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1118,13 +1227,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1134,13 +1245,15 @@ Accept wildcard characters: False ``` ### -EwsCostThreshold + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsCostThreshold parameter specifies the cost threshold for Exchange Web Services users. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1150,13 +1263,15 @@ Accept wildcard characters: False ``` ### -EwsCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsCutoffBalance parameter specifies the resource consumption limits for an Exchange Web Services user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1166,13 +1281,15 @@ Accept wildcard characters: False ``` ### -EwsMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsMaxBurst parameter specifies the amount of time that an Exchange Web Services user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1182,6 +1299,9 @@ Accept wildcard characters: False ``` ### -EWSFastSearchTimeoutInSeconds + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSFastSearchTimeoutInSeconds parameter specifies the amount of time that searches made using Exchange Web Services continue before they time out. If the search takes more than the time indicated by the policy value, the search stops and an error is returned. The default value of this setting is 60 seconds. @@ -1190,7 +1310,6 @@ The EWSFastSearchTimeoutInSeconds parameter specifies the amount of time that se Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1200,6 +1319,9 @@ Accept wildcard characters: False ``` ### -EWSFindCountLimit + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSFindCountLimit parameter specifies the maximum result size of FindItem or FindFolder calls that can exist in memory on the Client Access server at the same time for this user in this current process. If an attempt is made to find more items or folders than your policy limit allows, an error is returned. However, the limit isn't strictly enforced if the call is made within the context of an indexed page view. Specifically, in this scenario, the search results are truncated to include the number of items and folders that fit within the policy limit. You can then continue paging into your results set via further FindItem or FindFolder calls. @@ -1208,7 +1330,6 @@ The EWSFindCountLimit parameter specifies the maximum result size of FindItem or Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1218,13 +1339,15 @@ Accept wildcard characters: False ``` ### -EWSMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsMaxConcurrency parameter specifies how many concurrent connections an Exchange Web Services user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The EwsMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 10. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1234,13 +1357,15 @@ Accept wildcard characters: False ``` ### -EWSMaxSubscriptions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsMaxSubscriptions parameter specifies the maximum number of active push and pull subscriptions that an Exchange Web Services user can have on a specified Exchange server at the same time. If a user tries to create more subscriptions than the configured maximum, the subscription fails, and an event is logged in Event Viewer. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1250,6 +1375,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInAD parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1258,7 +1386,6 @@ The EWSPercentTimeInAD parameter specifies the percentage of a minute that an Ex Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1268,6 +1395,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInCAS parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1276,7 +1406,6 @@ The EWSPercentTimeInCAS parameter specifies the percentage of a minute that an E Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1286,6 +1415,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1294,7 +1426,6 @@ The EWSPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1304,13 +1435,15 @@ Accept wildcard characters: False ``` ### -EwsRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsRechargeRate parameter specifies the rate at which an Exchange Web Services user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1320,6 +1453,9 @@ Accept wildcard characters: False ``` ### -ExchangeMaxCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExchangeMaxCmdlets parameter specifies the number of cmdlets that can be executed within a specific time period before their execution is slowed down. The value specified by this parameter should be less than the value specified by the PowerShellMaxCmdlets parameter. The time period used for this limit is specified by the PowerShellMaxCmdletsTimePeriod parameter. We recommend that you set values for both parameters at the same time. @@ -1328,7 +1464,6 @@ The time period used for this limit is specified by the PowerShellMaxCmdletsTime Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1338,13 +1473,15 @@ Accept wildcard characters: False ``` ### -ForwardeeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForwardeeLimit parameter specifies the limits for the number of recipients that can be configured in Inbox Rules when using the forward or redirect action. This parameter doesn't limit the number of messages that can be forwarded or redirected to the recipients that are configured. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1354,13 +1491,15 @@ Accept wildcard characters: False ``` ### -ImapCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ImapCutoffBalance parameter specifies the resource consumption limits for an IMAP user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1370,13 +1509,15 @@ Accept wildcard characters: False ``` ### -ImapMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ImapMaxBurst parameter specifies the amount of time that an IMAP user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1386,13 +1527,15 @@ Accept wildcard characters: False ``` ### -IMAPMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ImapMaxConcurrency parameter specifies how many concurrent connections an IMAP user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The ImapMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1402,6 +1545,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInAD parameter specifies the percentage of a minute that an IMAP user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1410,7 +1556,6 @@ The IMAPPercentTimeInAD parameter specifies the percentage of a minute that an I Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1420,6 +1565,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInCAS parameter specifies the percentage of a minute that an IMAP user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1428,7 +1576,6 @@ The IMAPPercentTimeInCAS parameter specifies the percentage of a minute that an Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1438,6 +1585,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an IMAP user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1446,7 +1596,6 @@ The IMAPPercentTimeInMailboxRPC parameter specifies the percentage of a minute t Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1456,13 +1605,15 @@ Accept wildcard characters: False ``` ### -ImapRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ImapRechargeRate parameter specifies the rate at which the IMAP user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1472,6 +1623,9 @@ Accept wildcard characters: False ``` ### -IsServiceAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsServiceAccount switch specifies that the user accounts associated with this policy are moderated by per-user thresholds and the health of system resources (for example, overall CPU usage). You don't need to specify a value with this switch. You might want to use this switch if you intend to associate this policy with user accounts that require higher throttling limits (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). @@ -1482,7 +1636,6 @@ By using this switch, work done by these accounts is moderated by the higher use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1492,13 +1645,15 @@ Accept wildcard characters: False ``` ### -MessageRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageRateLimit parameter specifies the number of messages per minute that can be submitted to transport by POP3 or IMAP4 clients that use SMTP. Clients receive a transient error if they submit messages at a rate that exceeds the value of this parameter. Exchange attempts to connect and send the messages at a later time. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1508,13 +1663,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1524,13 +1681,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1540,13 +1699,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1556,13 +1717,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSocketConnectionsPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1572,13 +1735,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSocketConnectionsPerUser + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1588,13 +1753,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSubscriptions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1604,13 +1771,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1620,13 +1789,15 @@ Accept wildcard characters: False ``` ### -OwaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaCutoffBalance parameter specifies the resource consumption limits for an Outlook on the web user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1636,13 +1807,15 @@ Accept wildcard characters: False ``` ### -OwaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaMaxBurst parameter specifies the amount of time that an Outlook on the web user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1652,6 +1825,9 @@ Accept wildcard characters: False ``` ### -OWAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaMaxConcurrency parameter specifies how many concurrent connections an Outlook on the web user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. A valid value for this parameter is an integer from 0 through 2147483647 inclusive. The default value is 5. To indicate that the number of concurrent connections should be unthrottled (no limit), use the value $null. @@ -1662,7 +1838,6 @@ A valid value for this parameter is an integer from 0 through 2147483647 inclusi Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1672,6 +1847,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInAD parameter specifies the percentage of a minute that an Outlook Web App user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1680,7 +1858,6 @@ The OWAPercentTimeInAD parameter specifies the percentage of a minute that an Ou Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1690,6 +1867,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInCAS parameter specifies the percentage of a minute that an Outlook Web App user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1698,7 +1878,6 @@ The OWAPercentTimeInCAS parameter specifies the percentage of a minute that an O Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1708,6 +1887,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Outlook Web App user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1716,7 +1898,6 @@ The OWAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1726,13 +1907,15 @@ Accept wildcard characters: False ``` ### -OwaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaRechargeRate parameter specifies the rate at which an Outlook on the web user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1742,13 +1925,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaVoiceCutoffBalance parameter specifies the resource consumption limits for an Outlook on the web voice user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1758,13 +1943,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaVoiceMaxBurst parameter specifies the amount of time that an Outlook on the web voice user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1774,13 +1961,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaVoiceMaxConcurrency parameter specifies how many concurrent connections an Outlook on the web voice user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The OwaVoiceMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 5. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1790,13 +1979,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaVoiceRechargeRate parameter specifies the rate at which an Outlook on the web voice user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1806,13 +1997,15 @@ Accept wildcard characters: False ``` ### -PopCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PopCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1822,13 +2015,15 @@ Accept wildcard characters: False ``` ### -PopMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PopMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1838,13 +2033,15 @@ Accept wildcard characters: False ``` ### -POPMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PopMaxConcurrency parameter specifies how many concurrent connections a POP user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The PopMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 20. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1854,6 +2051,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInAD parameter specifies the percentage of a minute a POP user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1862,7 +2062,6 @@ The POPPercentTimeInAD parameter specifies the percentage of a minute a POP user Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1872,6 +2071,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInCAS parameter specifies the percentage of a minute a POP user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1880,7 +2082,6 @@ The POPPercentTimeInCAS parameter specifies the percentage of a minute a POP use Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1890,6 +2091,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInMailboxRPC parameter specifies the percentage of a minute a POP user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1898,7 +2102,6 @@ The POPPercentTimeInMailboxRPC parameter specifies the percentage of a minute a Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1908,13 +2111,15 @@ Accept wildcard characters: False ``` ### -PopRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PopRechargeRate parameter specifies the rate at which the user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1924,13 +2129,15 @@ Accept wildcard characters: False ``` ### -PowerShellCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1940,13 +2147,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1956,13 +2165,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdletQueueDepth -The PowerShellMaxCmdletQueueDepth parameter specifies the number of operations allowed to be executed by the user. This value directly affects the behavior of the PowerShellMaxCmdlets and PowerShellMaxConcurrency parameters. For example, the PowerShellMaxConcurrency parameter consumes at least two operations defined by the PowerShellMaxCmdletQueueDepth parameter but additional operations are also consumed per cmdlet execution. The number of operations depends on the cmdlets executed. We recommend that the value for the PowerShellMaxCmdletQueueDepth parameter be at least three times larger than the value of the PowerShellMaxConcurrency parameter. This parameter won't affect Exchange admin center operations or Exchange Web Services operations. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PowerShellMaxCmdletQueueDepth parameter specifies the number of operations allowed to be executed by the user. This value directly affects the behavior of the PowerShellMaxCmdlets and PowerShellMaxConcurrency parameters. For example, the PowerShellMaxConcurrency parameter consumes at least two operations defined by the PowerShellMaxCmdletQueueDepth parameter but additional operations are also consumed per cmdlet execution. The number of operations depends on the cmdlets executed. We recommend that the value for the PowerShellMaxCmdletQueueDepth parameter be at least three times larger than the value of the PowerShellMaxConcurrency parameter. This parameter doesn't affect Exchange admin center operations or Exchange Web Services operations. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1972,13 +2183,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxCmdlets parameter specifies the number of cmdlets that can be executed within a specific time period before their execution is stopped. The value specified by this parameter should be more than the value specified by the ExchangeMaxCmdlets parameter. The time period used for this limit is specified by the PowerShellMaxCmdletsTimePeriod parameter. Both values should be set at the same time. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1988,13 +2201,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdletsTimePeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxCmdletsTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine whether the number of cmdlets being executed exceeds the limits specified by the PowerShellMaxCmdlets and ExchangeMaxCmdlets parameters. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2004,6 +2219,9 @@ Accept wildcard characters: False ``` ### -PowerShellMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxConcurrency parameter specifies different information depending on context: - In the context of remote PowerShell, the PowerShellMaxConcurrency parameter specifies the maximum number of remote PowerShell sessions that a remote PowerShell user can have open at the same time. @@ -2015,7 +2233,6 @@ This parameter value doesn't necessarily correlate to the number of browsers ope Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2025,7 +2242,10 @@ Accept wildcard characters: False ``` ### -PowerShellMaxDestructiveCmdlets -The PowerShellMaxDestructiveCmdlets parameter specifies the number of destructive cmdlets that can be executed within a specific time period before their execution is stopped. Destructive cmdlets are cmdlets that can make significant changes to user data and configuration settings in your Exchange organization. Throttling these cmdlets may help prevent accidental data loss. The following cmdlets are designated as destructive: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PowerShellMaxDestructiveCmdlets parameter specifies the number of destructive cmdlets that can be executed within a specific time period before their execution is stopped. Destructive cmdlets are cmdlets that can make significant changes to user data and configuration settings in your Exchange organization. Throttling these cmdlets might help prevent accidental data loss. The following cmdlets are designated as destructive: - Disable-Mailbox - Move-ActiveMailboxDatabase @@ -2043,7 +2263,6 @@ The time period used for this limit is specified by the PowerShellMaxDestructive Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2053,13 +2272,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxDestructiveCmdletsTimePeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxDestructiveCmdletsTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine how many destructive cmdlets can be run. You set a value for this parameter when you set the PowerShellMaxDestructiveCmdlets parameter. Both values should be set at the same time. For more information, see the description for the PowerShellMaxDestructiveCmdlets parameter. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2069,13 +2290,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxOperations -The PowerShellMaxOperations parameter specifies the protocol-level operations that are used to send and receive data. If the execution of a cmdlet results in a significant number of operations (for example, if there is a lot of input/output occurring), throttling may occur. The default setting is Unlimited. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PowerShellMaxOperations parameter specifies the protocol-level operations that are used to send and receive data. If the execution of a cmdlet results in a significant number of operations (for example, if there is a lot of input/output occurring), throttling might occur. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2085,13 +2308,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxRunspaces + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxRunspaces parameter specifies the number of concurrent Windows PowerShell sessions that a user is allowed to have. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2101,13 +2326,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxRunspacesTimePeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxRunspacesTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine how many Windows PowerShell sessions can be run. You set this value when you set the PowerShellMaxRunspaces parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2117,6 +2344,9 @@ Accept wildcard characters: False ``` ### -PowerShellMaxTenantConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxTenantConcurrency parameter limits the number of concurrent Windows PowerShell connections per tenant organization. By default, the limit for concurrent Windows PowerShell connections per tenant organization is set to 9. If users in a tenant organization try to make more concurrent requests than the limit set by the PowerShellMaxTenantConcurrency parameter, the new connection attempt fails. However, the existing connections remain valid. This limit is enforced even if a single user hasn't exceeded the per-user limit set by the PowerShellMaxConcurrency parameter. The PowerShellMaxTenantConcurrency parameter has a valid range from 0 through 100 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. This property can only be set for the default throttling policy. @@ -2125,7 +2355,6 @@ This property can only be set for the default throttling policy. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2135,13 +2364,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxTenantRunspaces + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxTenantRunspaces parameter specifies the number of concurrent Windows PowerShell sessions that a tenant is allowed to have. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2151,13 +2382,15 @@ Accept wildcard characters: False ``` ### -PowerShellRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellRechargeRate parameter specifies the rate at which the user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2167,6 +2400,9 @@ Accept wildcard characters: False ``` ### -PswsMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PswsMaxConcurrency parameter specifies how many concurrent connections a Windows PowerShell Web Services user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The PswsMaxConcurrency parameter has a default value of 18. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. @@ -2175,7 +2411,6 @@ The PswsMaxConcurrency parameter has a default value of 18. To indicate that the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2185,13 +2420,15 @@ Accept wildcard characters: False ``` ### -PswsMaxRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PswsMaxRequest parameter specifies how many requests a Windows PowerShell Web Services user can have against an Exchange server at one time. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2201,13 +2438,15 @@ Accept wildcard characters: False ``` ### -PswsMaxRequestTimePeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PswsMaxRequestTimePeriod parameter specifies the period of time, in seconds, that the throttling policy uses to determine how many requests can be run. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2217,13 +2456,15 @@ Accept wildcard characters: False ``` ### -PushNotificationCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2233,13 +2474,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2249,13 +2492,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxBurstPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2265,13 +2510,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2281,13 +2528,15 @@ Accept wildcard characters: False ``` ### -PushNotificationRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2297,13 +2546,15 @@ Accept wildcard characters: False ``` ### -PushNotificationRechargeRatePerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2313,13 +2564,15 @@ Accept wildcard characters: False ``` ### -PushNotificationSamplingPeriodPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2329,13 +2582,15 @@ Accept wildcard characters: False ``` ### -RcaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2345,13 +2600,15 @@ Accept wildcard characters: False ``` ### -RcaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2361,6 +2618,9 @@ Accept wildcard characters: False ``` ### -RCAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaMaxConcurrency parameter specifies how many concurrent connections an RPC Client Access user can have against an Exchange server at one time. A connection is held from the moment a request is received until the connection is closed or the connection is otherwise disconnected (for example, if the user goes offline). If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. A valid value is an integer from 0 through 4294967295, or the value unlimited. The default value is 40. @@ -2371,7 +2631,6 @@ To indicate that the number of concurrent connections should be unthrottled (no Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2381,6 +2640,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInAD parameter specifies the percentage of a minute that an Outlook user can spend executing directory requests. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2389,7 +2651,6 @@ The RCAPercentTimeInAD parameter specifies the percentage of a minute that an Ou Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2399,6 +2660,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInCAS parameter specifies the percentage of a minute that an Outlook user can spend executing CAS mailbox requests. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2407,7 +2671,6 @@ The RCAPercentTimeInCAS parameter specifies the percentage of a minute that an O Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2417,6 +2680,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an RPC Client Access user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2425,7 +2691,6 @@ The RCAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2435,13 +2700,15 @@ Accept wildcard characters: False ``` ### -RcaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaRechargeRate parameter specifies the rate at which the budget for the user is charged (how much the budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2451,13 +2718,15 @@ Accept wildcard characters: False ``` ### -RcaSharedCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaSharedCutoffBalance parameter specifies the resource consumption limits for all users before they're completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2467,13 +2736,15 @@ Accept wildcard characters: False ``` ### -RcaSharedMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaShardMaxBurst parameter specifies the amount of time that all users can consume elevated amounts of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2483,6 +2754,9 @@ Accept wildcard characters: False ``` ### -RcaSharedMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaSharedMaxConcurrency parameter specifies how many concurrent connections all RPC Client Access users can have against an Exchange server at one time. A connection is held from the moment a request is received until the connection is closed or the connection is otherwise disconnected (for example, if users go offline). If there are more concurrent requests than the policy allows, new connection attempts fail. However, the existing connections remain valid. The default value is unlimited, which means the limit is controlled individually for each user by the RcaMaxConcurrency parameter. @@ -2491,7 +2765,6 @@ The default value is unlimited, which means the limit is controlled individually Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2501,13 +2774,15 @@ Accept wildcard characters: False ``` ### -RcaSharedRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaSharedRechargeRate parameter specifies the rate at which the budget for all users is charged (how much the budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2517,13 +2792,15 @@ Accept wildcard characters: False ``` ### -RecipientRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecipientRateLimit parameter specifies the limits on the number of recipients that a user can address in a 24-hour period. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2533,13 +2810,15 @@ Accept wildcard characters: False ``` ### -SchedulesCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2549,13 +2828,15 @@ Accept wildcard characters: False ``` ### -SchedulesMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2565,13 +2846,15 @@ Accept wildcard characters: False ``` ### -SchedulesMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2581,13 +2864,15 @@ Accept wildcard characters: False ``` ### -SchedulesRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2597,13 +2882,15 @@ Accept wildcard characters: False ``` ### -SuiteCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2613,13 +2900,15 @@ Accept wildcard characters: False ``` ### -SuiteMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2629,13 +2918,15 @@ Accept wildcard characters: False ``` ### -SuiteMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2645,13 +2936,15 @@ Accept wildcard characters: False ``` ### -SuiteRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2661,6 +2954,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicyScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ThrottlingPolicyScope parameter specifies the scope of the throttling policy. You can use the following values. - Regular: Specifies a custom policy that applies to specific users. @@ -2673,7 +2969,6 @@ For more information about throttling policy scopes, see [User workload manageme Type: ThrottlingPolicyScopeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2683,13 +2978,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/New-TransportRule.md similarity index 85% rename from exchange/exchange-ps/exchange/New-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-TransportRule.md index 97c913ad9b..f05877d0a4 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-TransportRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-transportrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-TransportRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-transportrule +schema: 2.0.0 +title: New-TransportRule --- # New-TransportRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the New-TransportRule cmdlet to create transport rules (mail flow rules) in your organization. @@ -210,9 +211,9 @@ New-TransportRule [-Name] ## DESCRIPTION In on-premises Exchange organizations, rules created on Mailbox servers are stored in Active Directory. All Mailbox servers in the organization have access to the same set of rules. On Edge Transport servers, rules are saved in the local copy of Active Directory Lightweight Directory Services (AD LDS). Rules aren't shared or replicated between Edge Transport servers or between Mailbox servers and Edge Transport servers. Also, some conditions and actions are exclusive to each server role. -The search for words or text patterns in the subject or other header fields in the message occurs after the message has been decoded from the MIME content transfer encoding method that was used to transmit the binary message between SMTP servers in ASCII text. You can't use conditions or exceptions to search for the raw (typically, Base64) encoded values of the subject or other header fields in messages. +The search for words or text patterns in the subject or other header fields in the message occurs after the message is decoded from the MIME content transfer encoding method that was used to transmit the binary message between SMTP servers in ASCII text. You can't use conditions or exceptions to search for the raw (typically, Base64) encoded values of the subject or other header fields in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -225,19 +226,21 @@ This example creates a rule with the following settings: - Name: Ethical Wall - Sales and Brokerage Departments - Conditions: Messages that are sent between members of the groups named Sales Department and Brokerage Department. -- Actions: The message is rejected, and the custom rejection text is Messages sent between the Sales and Brokerage departments are strictly prohibited. Note that the default enhanced status code 5.7.1 is used, because we didn't use the RejectMessageEnhancedStatusCode parameter. +- Actions: The message is rejected, and the custom rejection text is Messages sent between the Sales and Brokerage departments are strictly prohibited. The default enhanced status code 5.7.1 is used, because we didn't use the RejectMessageEnhancedStatusCode parameter. - Exceptions: The Subject field contains the phrases Press Release or Corporate Communication or the message was sent by Tony Smith or Pilar Ackerman. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the rule. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -247,7 +250,10 @@ 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. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + +The ActivationDate parameter specifies when the rule starts processing messages. The rule doesn'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". @@ -255,7 +261,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,6 +270,9 @@ Accept wildcard characters: False ``` ### -ADComparisonAttribute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -307,7 +315,6 @@ If you don't use the ADComparisonOperator parameter, the default comparison oper Type: ADAttribute Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -317,20 +324,22 @@ Accept wildcard characters: False ``` ### -ADComparisonOperator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. The ADComparisonOperator parameter specifies the comparison operator for the ADComparisonAttribute parameter. Valid values are: -- Equal (This is the default value) +- Equal (default value) - NotEqual ```yaml Type: Evaluation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -340,6 +349,9 @@ Accept wildcard characters: False ``` ### -AddManagerAsRecipientType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -357,7 +369,6 @@ This action only works if the sender's Manager attribute is defined. Type: AddedRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -367,6 +378,9 @@ Accept wildcard characters: False ``` ### -AddToRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -386,7 +400,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -396,6 +409,9 @@ Accept wildcard characters: False ``` ### -AnyOfCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -419,7 +435,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -429,6 +444,9 @@ Accept wildcard characters: False ``` ### -AnyOfCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -452,7 +470,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -462,6 +479,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -476,7 +496,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -486,6 +505,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -500,7 +522,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -510,6 +531,9 @@ Accept wildcard characters: False ``` ### -AnyOfToCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -533,7 +557,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -543,6 +566,9 @@ Accept wildcard characters: False ``` ### -AnyOfToCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -566,7 +592,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -576,6 +601,9 @@ Accept wildcard characters: False ``` ### -AnyOfToHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -599,7 +627,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -609,6 +636,9 @@ Accept wildcard characters: False ``` ### -AnyOfToHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -632,7 +662,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -642,6 +671,9 @@ Accept wildcard characters: False ``` ### -ApplyClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -654,7 +686,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -664,13 +695,16 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerFallbackAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be applied to a message (for example, encrypted or signed messages where the contents can't be altered). Valid values are: -- Wrap: This is the default value. A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. +- Wrap: This value is the default. A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. If you want other rules to examine and act on the original message (which is now an attachment in the new message), make sure those rules are applied _before_ the disclaimer rule by using a lower priority for the disclaimer rule and higher priority for other rules. @@ -687,7 +721,6 @@ If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the Type: DisclaimerFallbackAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -697,13 +730,16 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 ApplyHtmlDisclaimerLocation parameter specifies where to insert the HTML disclaimer text in the body of messages. Valid values are: -- Append: The disclaimer is added to the end of the message body. This is the default value. +- Append: The disclaimer is added to the end of the message body. This value is the default. - Prepend: The disclaimer is inserted at the beginning of the message body. If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Append is used. @@ -712,7 +748,6 @@ If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the Type: DisclaimerLocation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -722,6 +757,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -762,7 +800,6 @@ You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the Type: DisclaimerText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -772,6 +809,9 @@ Accept wildcard characters: False ``` ### -ApplyOME + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -785,7 +825,6 @@ The ApplyOME parameter specifies an action that encrypts messages and their atta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -795,6 +834,9 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionCustomizationTemplate + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -805,7 +847,6 @@ The ApplyRightsProtectionCustomizationTemplate parameter specifies an action tha Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -815,6 +856,9 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -831,7 +875,6 @@ For more information, see [Transport protection rules](https://learn.microsoft.c Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -841,6 +884,9 @@ Accept wildcard characters: False ``` ### -AttachmentContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -853,7 +899,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -863,6 +908,9 @@ Accept wildcard characters: False ``` ### -AttachmentExtensionMatchesWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -875,7 +923,6 @@ The AttachmentExtensionMatchesWords parameter specifies a condition that looks f Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -885,6 +932,9 @@ Accept wildcard characters: False ``` ### -AttachmentHasExecutableContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -900,7 +950,6 @@ The system inspects the file properties rather than relying on the file's extens Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -910,6 +959,9 @@ Accept wildcard characters: False ``` ### -AttachmentIsPasswordProtected + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -923,7 +975,6 @@ The AttachmentIsPasswordProtected parameter specifies a condition that looks for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -933,6 +984,9 @@ Accept wildcard characters: False ``` ### -AttachmentIsUnsupported + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -952,7 +1006,6 @@ In Exchange 2010, to extend the list of supported file types, see [Register Filt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -962,6 +1015,9 @@ Accept wildcard characters: False ``` ### -AttachmentMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -976,7 +1032,6 @@ Only the first 150 kilobytes (KB) of the attachment is scanned when trying to ma Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -986,6 +1041,9 @@ Accept wildcard characters: False ``` ### -AttachmentNameMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -996,7 +1054,6 @@ The AttachmentNameMatchesPatterns parameter specifies a condition that looks for Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1006,6 +1063,9 @@ Accept wildcard characters: False ``` ### -AttachmentProcessingLimitExceeded + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1021,7 +1081,6 @@ You use this condition to create rules that work together with other attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1031,11 +1090,14 @@ Accept wildcard characters: False ``` ### -AttachmentPropertyContainsWords + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. -The AttachmentPropertyContainsWords parameter specifies a condition that looks for words in the properties of attached Office documents. This condition helps integrate mail flow rules (transport rules) with the File Classification Infrastructure (FCI) in Windows Server 2012 R2 or later, SharePoint, or a third-party classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: +The AttachmentPropertyContainsWords parameter specifies a condition that looks for words in the properties of attached Office documents. This condition helps integrate mail flow rules (transport rules) with the File Classification Infrastructure (FCI) in Windows Server 2012 R2 or later, SharePoint, or a non-Microsoft classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: - Business Impact - Compliancy @@ -1060,7 +1122,6 @@ When you specify multiple properties, or multiple values for the same property, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1070,6 +1131,9 @@ Accept wildcard characters: False ``` ### -AttachmentSizeOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -1084,15 +1148,14 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. -The embedded images are treated as attachments (for example, messages with a picture in the signature); for this reason, we do not recommend using a very small value since unexpected messages will be blocked. +The embedded images are treated as attachments (for example, messages with a picture in the signature); for this reason, we do not recommend using a very small value since unexpected messages are blocked. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1102,6 +1165,9 @@ Accept wildcard characters: False ``` ### -BetweenMemberOf1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1121,7 +1187,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1131,6 +1196,9 @@ Accept wildcard characters: False ``` ### -BetweenMemberOf2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1150,7 +1218,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1160,6 +1227,9 @@ Accept wildcard characters: False ``` ### -BlindCopyTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1179,7 +1249,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1189,13 +1258,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Comments parameter specifies optional descriptive text for the rule (for example, what the rule is used for, or how it has changed over time). The length of the comment can't exceed 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1205,6 +1276,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -1214,7 +1288,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -1224,6 +1297,9 @@ Accept wildcard characters: False ``` ### -ContentCharacterSetContainsWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1236,7 +1312,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1246,6 +1321,9 @@ Accept wildcard characters: False ``` ### -CopyTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1265,7 +1343,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1275,6 +1352,9 @@ Accept wildcard characters: False ``` ### -DeleteMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1288,7 +1368,6 @@ The DeleteMessage parameter specifies an action that silently drops messages wit Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1298,6 +1377,9 @@ Accept wildcard characters: False ``` ### -Disconnect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -1311,7 +1393,6 @@ The Disconnect parameter specifies an action that ends the SMTP connection betwe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1321,6 +1402,9 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This parameter is functional only in on-premises Exchange. The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see [Data loss prevention in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). @@ -1329,7 +1413,6 @@ The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's a Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1339,6 +1422,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -1349,7 +1435,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1359,9 +1444,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the new rule is created as enabled or disabled. Valid values are: -- $true: The new rule is enabled. This is the default value. +- $true: The new rule is enabled. This value is the default. - $false: The new rule is disabled. To enable or disable a rule after you create it, use the Enable-TransportRule and Disable-TransportRule cmdlets. @@ -1370,7 +1458,6 @@ To enable or disable a rule after you create it, use the Enable-TransportRule an Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1380,6 +1467,9 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonAttribute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1422,7 +1512,6 @@ If you don't use the ExceptIfADComparisonOperator parameter, the default compari Type: ADAttribute Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1432,20 +1521,22 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonOperator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfADComparisonOperator parameter specifies the comparison operator for the ExceptIfADComparisonAttribute parameter. Valid values are: -- Equal (This is the default value) +- Equal (default value) - NotEqual ```yaml Type: Evaluation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1455,6 +1546,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1478,7 +1572,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1488,6 +1581,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1511,7 +1607,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1521,6 +1616,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1535,7 +1633,6 @@ A match for this exception prevents the rule action from being applied to all re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1545,6 +1642,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1559,7 +1659,6 @@ A match for this exception prevents the rule action from being applied to all re Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1569,6 +1668,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1592,7 +1694,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1602,6 +1703,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1625,7 +1729,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1635,6 +1738,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1658,7 +1764,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1668,6 +1773,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1691,7 +1799,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1701,6 +1808,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1713,7 +1823,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1723,6 +1832,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentExtensionMatchesWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1735,7 +1847,6 @@ The ExceptIfAttachmentExtensionMatchesWords parameter specifies an exception tha Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1745,6 +1856,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentHasExecutableContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1760,7 +1874,6 @@ The system inspects the file properties rather than relying on the file extensio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1770,6 +1883,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsPasswordProtected + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1783,7 +1899,6 @@ The ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1793,6 +1908,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsUnsupported + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1812,7 +1930,6 @@ In Exchange 2010, to extend the list of supported file types, see [Register Filt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1822,6 +1939,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1836,7 +1956,6 @@ Only the first 150 KB of the attachment is scanned when trying to match a text p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1846,6 +1965,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentNameMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1856,7 +1978,6 @@ The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1866,6 +1987,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentProcessingLimitExceeded + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1881,7 +2005,6 @@ You use this exception to create rules that work together with other attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1891,11 +2014,14 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentPropertyContainsWords + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. -The ExceptIfAttachmentPropertyContainsWords parameter specifies an exception that looks for words in the properties of attached Office documents. This condition helps integrate rules with the File Classification Infrastructure (FCI) in Windows Server 2012 R2 or later, SharePoint, or a third-party classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: +The ExceptIfAttachmentPropertyContainsWords parameter specifies an exception that looks for words in the properties of attached Office documents. This condition helps integrate rules with the File Classification Infrastructure (FCI) in Windows Server 2012 R2 or later, SharePoint, or a non-Microsoft classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: - Business Impact - Compliancy @@ -1920,7 +2046,6 @@ When you specify multiple properties, or multiple values for the same property, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1930,6 +2055,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentSizeOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1944,13 +2072,12 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1960,6 +2087,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1979,7 +2109,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1989,6 +2118,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2008,7 +2140,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2018,6 +2149,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2030,7 +2164,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2040,6 +2173,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2061,7 +2197,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2071,6 +2206,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2083,7 +2221,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2093,6 +2230,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2107,7 +2247,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2117,6 +2256,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2138,7 +2280,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2148,6 +2289,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2161,7 +2305,6 @@ The ExceptIfFromScope parameter specifies an exception that looks for the locati Type: FromUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2171,6 +2314,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2187,7 +2333,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2197,6 +2342,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasNoClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2210,7 +2358,6 @@ The ExceptIfHasNoClassification parameter specifies an exception that looks for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2220,6 +2367,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. @@ -2235,7 +2385,6 @@ The ExceptIfHasSenderOverride parameter specifies an exception that looks for me Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2245,6 +2394,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2255,7 +2407,6 @@ The ExceptIfHeaderContainsMessageHeader parameter specifies the name of header f Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2265,6 +2416,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2279,7 +2433,6 @@ You specify the header field to search by using the ExceptIfHeaderContainsMessag Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2289,6 +2442,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2299,7 +2455,6 @@ The ExceptIfHeaderMatchesMessageHeader parameter specifies the name of header fi Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2309,6 +2464,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2321,7 +2479,6 @@ You specify the header field to search by using the ExceptIfHeaderMatchesMessage Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2331,6 +2488,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2352,7 +2512,6 @@ You specify if you want to look for these users as managers of senders or recipi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2362,6 +2521,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerForEvaluatedUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2377,7 +2539,6 @@ You specify the users to look for by using the ExceptIfManagerAddresses paramete Type: EvaluatedUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2387,6 +2548,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageContainsDataClassifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. @@ -2403,7 +2567,6 @@ For a list of sensitive information types available, see [Sensitive information Type: Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2413,6 +2576,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2427,13 +2593,12 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2443,6 +2608,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2450,7 +2618,7 @@ In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this exception **will not** match during mail flow rule evaluation. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message is forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this exception **does not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -2463,7 +2631,6 @@ The ExceptIfMessageTypeMatches parameter specifies an exception that looks for m Type: MessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2473,6 +2640,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2519,7 +2689,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2529,6 +2698,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2573,7 +2745,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2583,6 +2754,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2593,7 +2767,6 @@ The ExceptIfRecipientAddressContainsWords parameter specifies an exception that Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2603,6 +2776,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2615,7 +2791,6 @@ This parameter works when the recipient is an individual user. This parameter do Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2625,6 +2800,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2637,7 +2815,6 @@ This exception matches domains and subdomains. For example, "contoso.com" matche Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2647,6 +2824,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientInSenderList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2655,7 +2835,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2665,6 +2844,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2680,7 +2862,6 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2690,6 +2871,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2736,7 +2920,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2746,6 +2929,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2790,7 +2976,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2800,6 +2985,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2814,7 +3002,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2824,6 +3011,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderInRecipientList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2832,7 +3022,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2842,6 +3031,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIpRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2854,13 +3046,12 @@ The ExceptIfSenderIpRanges parameter specifies an exception that looks for sende You can specify multiple values separated by commas. -In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. +In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if non-Microsoft software is used during message transport. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2870,6 +3061,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderManagementRelationship + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2883,7 +3077,6 @@ The ExceptIfSenderManagementRelationship parameter specifies an exception that l Type: ManagementRelationship Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2893,6 +3086,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2912,7 +3108,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2922,6 +3117,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: @@ -2939,7 +3137,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2949,6 +3146,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2964,7 +3164,6 @@ The ExceptIfSentToScope parameter specifies an exception that looks for the loca Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2974,6 +3173,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2988,7 +3190,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2998,6 +3199,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3008,7 +3212,6 @@ The ExceptIfSubjectMatchesPatterns parameter specifies an exception that looks f Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3018,6 +3221,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3032,7 +3238,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3042,6 +3247,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3052,7 +3260,6 @@ The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception that l Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3062,6 +3269,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -3076,7 +3286,6 @@ The ExceptIfWithImportance parameter specifies an exception that looks for messa Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3086,9 +3295,12 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. +The ExpiryDate parameter specifies when this rule stops processing messages. The rule doesn'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". @@ -3096,7 +3308,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3106,6 +3317,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3127,7 +3341,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3137,6 +3350,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3149,7 +3365,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3159,6 +3374,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3173,7 +3391,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3183,6 +3400,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3204,7 +3424,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3214,6 +3433,9 @@ Accept wildcard characters: False ``` ### -FromScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3227,7 +3449,6 @@ The FromScope parameter specifies a condition that looks for the location of mes Type: FromUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3237,6 +3458,9 @@ Accept wildcard characters: False ``` ### -GenerateIncidentReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -3256,7 +3480,6 @@ The GenerateIncidentReport parameter specifies where to send the incident report Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3266,6 +3489,9 @@ Accept wildcard characters: False ``` ### -GenerateNotification + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -3287,7 +3513,6 @@ The maximum number of characters is 5120. Type: DisclaimerText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3297,6 +3522,9 @@ Accept wildcard characters: False ``` ### -HasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3313,7 +3541,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3323,6 +3550,9 @@ Accept wildcard characters: False ``` ### -HasNoClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3336,7 +3566,6 @@ The HasNoClassification parameter specifies a condition that looks for messages Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3346,6 +3575,9 @@ Accept wildcard characters: False ``` ### -HasSenderOverride + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. @@ -3361,7 +3593,6 @@ The HasSenderOverride parameter specifies a condition that looks for messages wh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3371,6 +3602,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3381,7 +3615,6 @@ The HeaderContainsMessageHeader parameter specifies the name of header field in Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3391,6 +3624,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3405,7 +3641,6 @@ You specify the header field to search by using the HeaderContainsMessageHeader Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3415,6 +3650,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3425,7 +3663,6 @@ The HeaderMatchesMessageHeader parameter specifies the name of header field in t Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3435,6 +3672,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3447,7 +3687,6 @@ You specify the header field to search by using the HeaderMatchesMessageHeader p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3457,6 +3696,9 @@ Accept wildcard characters: False ``` ### -IncidentReportContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -3464,10 +3706,10 @@ In on-premises Exchange, this action is available only on Mailbox servers. The IncidentReportContent parameter specifies the message properties that are included in the incident report. Valid values are: - Sender: The sender of the message. -- Recipients: The recipients in the To field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. +- Recipients: The recipients in the To field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients are displayed. - Subject: The Subject field of the message. -- CC: The recipients in the Cc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. -- BCC: The recipients in the Bcc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. +- CC: The recipients in the Cc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients are displayed. +- BCC: The recipients in the Bcc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients are displayed. - Severity: The audit severity of the rule that was triggered. If the message was processed by more than one rule, the highest severity is displayed. - RuleDetections: The list of rules that the message triggered. - FalsePositive: The false positive if the sender marked the message as a false positive for a PolicyTip. @@ -3484,7 +3726,6 @@ You use this parameter with the GenerateIncidentReport parameter. Type: IncidentReportContent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3494,15 +3735,18 @@ Accept wildcard characters: False ``` ### -IncidentReportOriginalMail + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. -This parameter has been deprecated and is no longer used. Use the IncidentReportContent parameter instead. The value AttachOriginalMail on the IncidentReportContent parameter is equivalent to setting this parameter to the value IncludeOriginalMail. +This parameter is deprecated and no longer used. Use the IncidentReportContent parameter instead. The value AttachOriginalMail on the IncidentReportContent parameter is equivalent to setting this parameter to the value IncludeOriginalMail. 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 IncidentReportOriginalMail parameter specifies whether to include the original message with the incident report. This parameter is used together with the GenerateIncidentReport parameter. Valid values are: +The IncidentReportOriginalMail parameter specifies whether to include the original message with the incident report. Use this parameter with the GenerateIncidentReport parameter. Valid values are: - IncludeOriginalMail - DoNotIncludeOriginalMail (this is the default value) @@ -3511,7 +3755,6 @@ The IncidentReportOriginalMail parameter specifies whether to include the origin Type: IncidentReportOriginalMail Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -3521,6 +3764,9 @@ Accept wildcard characters: False ``` ### -LogEventText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -3539,7 +3785,6 @@ The entry contains the following information: Type: EventLogText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3549,6 +3794,9 @@ Accept wildcard characters: False ``` ### -ManagerAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3570,7 +3818,6 @@ You specify if you want to look for these users as managers of senders or recipi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3580,6 +3827,9 @@ Accept wildcard characters: False ``` ### -ManagerForEvaluatedUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3595,7 +3845,6 @@ You specify the users to look for by using the ManagerAddresses parameter. Type: EvaluatedUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3605,6 +3854,9 @@ Accept wildcard characters: False ``` ### -MessageContainsDataClassifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. @@ -3623,7 +3875,6 @@ You can specify the notification options by using the NotifySender parameter. Type: Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3633,6 +3884,9 @@ Accept wildcard characters: False ``` ### -MessageSizeOver + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3647,13 +3901,12 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3663,6 +3916,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3670,7 +3926,7 @@ In on-premises Exchange, this condition is available only on Mailbox servers. The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this condition **will not** match during mail flow rule evaluation. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message is forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this condition **does not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -3683,7 +3939,6 @@ The MessageTypeMatches parameter specifies a condition that looks for messages o Type: MessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3693,17 +3948,19 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Mode parameter specifies how the rule operates. Valid values are: -- Audit: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport action occurs. -- AuditAndNotify: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport and GenerateNotification actions occur. -- Enforce: All actions specified in the rule are taken. This is the default value. +- Audit: The actions that the rule would have taken are written to the message tracking log, but no action that affects message delivery is taken on the message. The GenerateIncidentReport action occurs. +- AuditAndNotify: The actions that the rule would have taken are written to the message tracking log, but no action that affects message delivery is taken on the message. The GenerateIncidentReport and GenerateNotification actions occur. +- Enforce: All actions specified in the rule are taken. This value is the default. ```yaml Type: RuleMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3713,6 +3970,9 @@ Accept wildcard characters: False ``` ### -ModerateMessageByManager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -3728,7 +3988,6 @@ This action only works if the sender's Manager attribute is defined. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3738,6 +3997,9 @@ Accept wildcard characters: False ``` ### -ModerateMessageByUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -3759,7 +4021,6 @@ You can't use a distribution group as a moderator. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3769,6 +4030,9 @@ Accept wildcard characters: False ``` ### -NotifySender + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -3787,13 +4051,12 @@ For all values except NotifyOnly, you can specify an enhanced status code and a If you use this parameter, you also need to specify a condition that looks for sensitive information types in messages by using the MessageContainsDataClassifications parameter. -This action is applicable to messages sent by internal users only. External senders will not receive notifications. +This action is applicable to messages sent by internal users only. External senders don't receive notifications. ```yaml Type: NotifySenderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3803,6 +4066,9 @@ Accept wildcard characters: False ``` ### -PrependSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -3815,7 +4081,6 @@ Consider ending the value for this parameter with a colon (:) and a space, or at Type: SubjectPrefix Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3825,6 +4090,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -3839,7 +4107,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3849,6 +4116,9 @@ Accept wildcard characters: False ``` ### -Quarantine + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Edge Transport servers. @@ -3864,7 +4134,6 @@ If this action is in a rule that's not the last rule in the list, rule evaluatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3874,6 +4143,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3920,7 +4192,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3930,6 +4201,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3974,7 +4248,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3984,6 +4257,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3994,7 +4270,6 @@ The RecipientAddressContainsWords parameter specifies a condition that looks for Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4004,6 +4279,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4016,7 +4294,6 @@ This parameter works when the recipient is an individual user. This parameter do Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4026,18 +4303,20 @@ Accept wildcard characters: False ``` ### -RecipientAddressType + +> Applicable: Exchange Online, Exchange Online Protection + 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 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. +- Resolved: The rule checks the recipient's primary SMTP email address without checking any proxy addresses. This value is the default. ```yaml Type: RecipientAddressType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4047,6 +4326,9 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4059,7 +4341,6 @@ This condition matches domains and subdomains. For example, "contoso.com" matche Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4069,6 +4350,9 @@ Accept wildcard characters: False ``` ### -RecipientInSenderList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -4077,7 +4361,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4087,6 +4370,9 @@ Accept wildcard characters: False ``` ### -RedirectMessageTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4106,7 +4392,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4116,6 +4401,9 @@ Accept wildcard characters: False ``` ### -RejectMessageEnhancedStatusCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -4132,7 +4420,6 @@ To further customize the NDR (for example, multiple languages), you need to crea Type: RejectEnhancedStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4142,6 +4429,9 @@ Accept wildcard characters: False ``` ### -RejectMessageReasonText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -4162,7 +4452,6 @@ To further customize the NDR (for example, multiple languages), you need to crea Type: RejectText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4172,6 +4461,9 @@ Accept wildcard characters: False ``` ### -RemoveHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4182,7 +4474,6 @@ The RemoveHeader parameter specifies an action that removes a header field from Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4192,6 +4483,9 @@ Accept wildcard characters: False ``` ### -RemoveOME + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4205,7 +4499,6 @@ The RemoveOME parameter specifies an action that removes the previous version of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4215,6 +4508,9 @@ Accept wildcard characters: False ``` ### -RemoveOMEv2 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4228,7 +4524,6 @@ The RemoveOMEv2 parameter specifies an action that removes Microsoft Purview Mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4238,6 +4533,9 @@ Accept wildcard characters: False ``` ### -RemoveRMSAttachmentEncryption + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4253,7 +4551,6 @@ The RemoveRMSAttachmentEncryption parameter specifies an action that removes Mic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4263,6 +4560,9 @@ Accept wildcard characters: False ``` ### -RouteMessageOutboundConnector + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4277,7 +4577,6 @@ The RouteMessageOutboundConnector parameter specifies an action that routes mess Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4287,6 +4586,9 @@ Accept wildcard characters: False ``` ### -RouteMessageOutboundRequireTls + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -4300,7 +4602,6 @@ The RouteMessageOutboundRequireTls parameter specifies an action that uses Trans Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4310,16 +4611,18 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RuleErrorAction parameter specifies what to do if rule processing can't be completed on messages. Valid values are: -- Ignore: The message is sent anyway. This is the default value. +- Ignore: The message is sent anyway. This value is the default. - Defer: The message is deferred so the rules engine can attempt to process the message again. ```yaml Type: RuleErrorAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4329,16 +4632,18 @@ Accept wildcard characters: False ``` ### -RuleSubType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RuleSubType parameter specifies the rule type. Valid values are: - Dlp: The rule is associated with a DLP policy. This value is meaningful only in on-premises Exchange. -- None: The rule is a regular transport rule. This is the default value. +- None: The rule is a regular transport rule. This value is the default. ```yaml Type: RuleSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4348,6 +4653,9 @@ Accept wildcard characters: False ``` ### -SCLOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4363,7 +4671,6 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4373,6 +4680,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4419,7 +4729,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4429,6 +4738,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4473,7 +4785,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4483,9 +4794,12 @@ Accept wildcard characters: False ``` ### -SenderAddressLocation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 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 value is the default, 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. @@ -4501,7 +4815,6 @@ Message envelope searching is available only for the following conditions and ex Type: SenderAddressLocation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4511,6 +4824,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4525,7 +4841,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4535,6 +4850,9 @@ Accept wildcard characters: False ``` ### -SenderInRecipientList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -4543,7 +4861,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4553,6 +4870,9 @@ Accept wildcard characters: False ``` ### -SenderIpRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4565,13 +4885,12 @@ The SenderIpRanges parameter specifies a condition that looks for senders whose You can specify multiple values separated by commas. -In Exchange Online, the IP address that's used during evaluation of this condition is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. +In Exchange Online, the IP address that's used during evaluation of this condition is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if non-Microsoft software is used during message transport. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4581,6 +4900,9 @@ Accept wildcard characters: False ``` ### -SenderManagementRelationship + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4594,7 +4916,6 @@ The SenderManagementRelationship parameter specifies a condition that looks for Type: ManagementRelationship Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4604,6 +4925,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4623,7 +4947,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4633,6 +4956,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4654,7 +4980,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4664,6 +4989,9 @@ Accept wildcard characters: False ``` ### -SentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4679,7 +5007,6 @@ The SentToScope parameter specifies a condition that looks for the location of r Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4689,6 +5016,9 @@ Accept wildcard characters: False ``` ### -SetAuditSeverity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -4704,7 +5034,6 @@ The SetAuditSeverity parameter specifies an action that sets the severity level Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4714,6 +5043,9 @@ Accept wildcard characters: False ``` ### -SetHeaderName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4724,7 +5056,6 @@ The SetHeaderName parameter specifies an action that adds or modifies a header f Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4734,6 +5065,9 @@ Accept wildcard characters: False ``` ### -SetHeaderValue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4744,7 +5078,6 @@ The SetHeaderValue parameter specifies an action that adds or modifies a header Type: HeaderValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4754,6 +5087,9 @@ Accept wildcard characters: False ``` ### -SetSCL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4767,7 +5103,6 @@ The SetSCL parameter specifies an action that adds or modifies the SCL value of Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4777,6 +5112,9 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectStatusCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4789,7 +5127,6 @@ You can use this parameter with the SmtpRejectMessageRejectText parameter. If yo Type: RejectStatusCode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4799,6 +5136,9 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4811,7 +5151,6 @@ You can use this parameter with the SmtpRejectMessageRejectStatusCode parameter. Type: RejectText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4821,6 +5160,9 @@ Accept wildcard characters: False ``` ### -StopRuleProcessing + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4834,7 +5176,6 @@ The StopRuleProcessing parameter specifies an action that stops processing more Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4844,6 +5185,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4858,7 +5202,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4868,6 +5211,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4878,7 +5224,6 @@ The SubjectMatchesPatterns parameter specifies a condition that looks for text p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4888,6 +5233,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4902,7 +5250,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4912,6 +5259,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4922,7 +5272,6 @@ The SubjectOrBodyMatchesPatterns parameter specifies a condition that looks for Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4932,6 +5281,9 @@ Accept wildcard characters: False ``` ### -UseLegacyRegex + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The UseLegacyRegex parameter specifies whether the rule uses regular expression syntax that's compatible with Exchange Server 2010. Valid values are: - $true: Regular expression syntax that's compatible with Exchange 2010. @@ -4941,7 +5293,6 @@ The UseLegacyRegex parameter specifies whether the rule uses regular expression Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4951,13 +5302,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4967,6 +5320,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4981,7 +5337,6 @@ The WithImportance parameter specifies a condition that looks for messages with Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/New-UMAutoAttendant.md similarity index 83% rename from exchange/exchange-ps/exchange/New-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMAutoAttendant.md index 7f9922c4c4..dbd81be6da 100644 --- a/exchange/exchange-ps/exchange/New-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: New-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-umautoattendant +schema: 2.0.0 +title: New-UMAutoAttendant --- # New-UMAutoAttendant @@ -37,7 +38,7 @@ The New-UMAutoAttendant cmdlet creates one or more UM auto attendants. UM auto a After this task is completed, a UM auto attendant is created. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,13 +59,15 @@ This example creates the speech-enabled UM auto attendant MyUMAutoAttendant usin ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the UM auto attendant. The display name for the UM auto attendant can contain as many as 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan identifier for the UM dial plan to be associated with this UM auto attendant. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -99,7 +107,6 @@ 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 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -DTMFFallbackAutoAttendant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DTMFFallbackAutoAttendant parameter specifies a secondary UM auto attendant. A secondary UM auto attendant can be used only if the SpeechEnabled parameter is set to $true. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -141,13 +152,15 @@ Accept wildcard characters: False ``` ### -PilotIdentifierList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PilotIdentifierList parameter specifies a list of one or more pilot numbers. Pilot numbers route incoming calls to Mailbox servers. The calls are then answered by the UM auto attendant. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -157,13 +170,15 @@ Accept wildcard characters: False ``` ### -SpeechEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SpeechEnabled parameter specifies whether the UM auto attendant is speech-enabled. The default value is $true. If this parameter is omitted, or if the value is $false, the UM auto attendant isn't speech-enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -173,16 +188,18 @@ Accept wildcard characters: False ``` ### -Status -The Status parameter specifies whether the UM auto attendant being created will be enabled. Valid values are: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The Status parameter specifies whether the UM auto attendant is enabled. Valid values are: - Enabled -- Disabled (This is the default value) +- Disabled (default value) ```yaml Type: StatusEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -192,13 +209,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/New-UMCallAnsweringRule.md similarity index 86% rename from exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMCallAnsweringRule.md index 4fa9e1f46e..4c24b04506 100644 --- a/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: New-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-umcallansweringrule +schema: 2.0.0 +title: New-UMCallAnsweringRule --- # New-UMCallAnsweringRule @@ -53,7 +54,7 @@ You can also specify the following actions: After this task is completed, the cmdlet sets the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -92,10 +93,10 @@ This example creates the call answering rule MyCallAnsweringRule in the mailbox - Sets the priority of the call answering rule to 2. - Creates key mappings for the call answering rule. -If the caller reaches the voice mail for the user and the status of the user is set to Busy, the caller can: +If the caller reaches the voice mail for the user and the status of the user is set to Busy, the caller can take the following actions: -- Press the 1 key and be transferred to a receptionist at extension 45678. -- Press the 2 key and the Find Me feature will be used for urgent issues and ring extension 23456 first, and then 45671. +- Press the 1 key to be transferred to a receptionist at extension 45678. +- Press the 2 key to use the Find Me feature for urgent issues and ring extension 23456 first, and then 45671. ### Example 5 ```powershell @@ -120,13 +121,15 @@ This example creates the call answering rule MyCallAnsweringRule in the mailbox ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the name of the Unified Messaging (UM) call answering rule or Call Answering Rule ID being modified. The call answering ID or name must be unique per the user's UM-enabled mailbox. The name or ID for the call answering rule can contain up to 255 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -136,13 +139,15 @@ Accept wildcard characters: False ``` ### -CallerIds + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CallerIds parameter specifies an entry for the "If the Caller is" condition. Each entry for this parameter can contain a phone number, an Active Directory contact, a personal contact, or the personal Contacts folder. The parameter can contain 50 phone numbers or contact entries and no more than one entry for specifying the default Contacts folder. If the CallerIds parameter doesn't contain a condition, the condition isn't set and is ignored. The default value is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -152,13 +157,15 @@ Accept wildcard characters: False ``` ### -CallersCanInterruptGreeting + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CallersCanInterruptGreeting parameter specifies whether a caller can interrupt the voice mail greeting while it's being played. The default is $null. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -168,13 +175,15 @@ Accept wildcard characters: False ``` ### -CheckAutomaticReplies + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CheckAutomaticReplies parameter specifies an entry for the "If My Automatic Replies are Enabled" condition. The default is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -184,6 +193,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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`. @@ -193,7 +205,6 @@ 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 Required: False Position: Named @@ -203,13 +214,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named @@ -219,13 +232,15 @@ Accept wildcard characters: False ``` ### -ExtensionsDialed + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The ExtensionsDialed parameter specifies an entry for the "If the Caller Dials" condition. Each entry must be unique per call answering rule. Each extension must correspond to existing extension numbers assigned to UM-enabled users. The default is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -235,13 +250,15 @@ Accept wildcard characters: False ``` ### -KeyMappings + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The KeyMappings parameter specifies a key mapping entry for a call answering rule. The key mappings are those menu options offered to callers if the call answering rule is set to $true. You can configure a maximum of 10 entries. None of the defined key mappings can overlap. The default is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule is created. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -270,7 +290,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -280,13 +299,17 @@ Accept wildcard characters: False ``` ### -Priority -The Priority parameter specifies the order that the call answering rule will be evaluated against other existing call answering rules. Call answering rules are processed in order of increasing priority values. The priority must be unique between all call answering rules in the UM-enabled mailbox. The priority on the call answering rule must be between 1 (highest) and 9 (lowest). The default is 9. + +> Applicable: Exchange Server 2013, Exchange Server 2016 + +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, and rules can't have the same priority value. + +A valid value is an integer from 1 (highest priority) to 9 (lowest priority). The default value is 9. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -296,6 +319,9 @@ Accept wildcard characters: False ``` ### -ScheduleStatus + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The ScheduleStatus parameter specifies an entry for the "If my Schedule show that I am" condition. Users can specify their free/busy status to be checked. This parameter can be set from 0 through 15 and is interpreted as a 4-bit mask that represents the calendar status including Free, Tentative, Busy, and Out of Office. The following settings can be used to set the schedule status: - None = 0x0 @@ -310,7 +336,6 @@ The default setting is $null. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -320,13 +345,15 @@ Accept wildcard characters: False ``` ### -TimeOfDay + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The TimeOfDay parameter specifies an entry for the "If the Call Arrives During" condition for the call answering rule. You can specify working hours, non-working hours, or custom hours. The default is $null. ```yaml Type: TimeOfDay Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -336,13 +363,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMDialPlan.md b/exchange/exchange-ps/ExchangePowerShell/New-UMDialPlan.md similarity index 85% rename from exchange/exchange-ps/exchange/New-UMDialPlan.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMDialPlan.md index 5b47dbb7ad..ec35aabbf5 100644 --- a/exchange/exchange-ps/exchange/New-UMDialPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMDialPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: New-UMDialPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-umdialplan +schema: 2.0.0 +title: New-UMDialPlan --- # New-UMDialPlan @@ -41,7 +42,7 @@ After the new UM dial plan is created, a UM IP gateway and a Mailbox server must After this task is completed, a new UM dial plan is created. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,13 +70,15 @@ This example creates the unsecured UM dial plan MyUMDialPlan that supports E.164 ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name of the UM dial plan. This description is presented to the administrator when a user is enabled for Unified Messaging. The UM dial plan name field can contain as many as 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -CountryOrRegionCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is located. For example, 1 is the code used for North America and 44 is the code used for the United Kingdom. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -NumberOfDigitsInExtension + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NumberOfDigitsInExtension parameter specifies the fixed number of digits in an extension number. The range for this parameter is from 1 through 20 digits. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -AccessTelephoneNumbers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AccessTelephoneNumbers parameter specifies the telephone number or numbers used for subscriber access. These numbers are sometimes referred to as pilot or pilot ID numbers. The telephone number is limited to 32 characters. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -142,7 +154,6 @@ 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 Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -DefaultLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DefaultLanguage parameter specifies the default language of the system. This default language is selected from the list of available languages. If there are no other UM language packs installed, the default value is en-US. ```yaml Type: UMLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -184,13 +199,15 @@ Accept wildcard characters: False ``` ### -FaxEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The FaxEnabled parameter specifies whether the Mailbox servers associated with the dial plan answer and process incoming fax calls. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -200,13 +217,15 @@ Accept wildcard characters: False ``` ### -GenerateUMMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The GenerateUMMailboxPolicy parameter specifies whether a default UM mailbox policy is created when the UM dial plan is created. The default setting is to create a UM mailbox when the UM dial plan is created. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -216,13 +235,15 @@ Accept wildcard characters: False ``` ### -URIType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The URIType parameter specifies the URI type to be sent and received with SIP messages from the Private Branch eXchange (PBX). ```yaml Type: UMURIType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -232,13 +253,15 @@ Accept wildcard characters: False ``` ### -VoIPSecurity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoIPSecurity parameter specifies whether the signaling channel is encrypted using mutual Transport Layer Security (TLS). The default setting is Unsecured. ```yaml Type: UMVoIPSecurityType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -248,13 +271,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMHuntGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-UMHuntGroup.md similarity index 84% rename from exchange/exchange-ps/exchange/New-UMHuntGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMHuntGroup.md index c471f60d1e..db2ed984de 100644 --- a/exchange/exchange-ps/exchange/New-UMHuntGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMHuntGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-umhuntgroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: New-UMHuntGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-umhuntgroup +schema: 2.0.0 +title: New-UMHuntGroup --- # New-UMHuntGroup @@ -34,7 +35,7 @@ The New-UMHuntGroup cmdlet creates a UM hunt group in Active Directory. Running After this task is completed, a new UM hunt group is created. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example creates the UM hunt group MyUMHuntGroup that has multiple pilot ide ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the UM hunt group name used for display purposes. This string can contain as many as 64 characters and it must be unique. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan used with the UM hunt group. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -UMIPGateway + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMIPGateway parameter specifies the UM IP gateway to be associated with the UM hunt group. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -112,7 +122,6 @@ 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 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -PilotIdentifier + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PilotIdentifier parameter specifies the number string used to uniquely identify the pilot access number for the specified IP gateway. This number must match the subscriber access number configured in the UM dial plan. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/New-UMIPGateway.md similarity index 82% rename from exchange/exchange-ps/exchange/New-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMIPGateway.md index 3e03d94273..f9dca59459 100644 --- a/exchange/exchange-ps/exchange/New-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: New-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-umipgateway +schema: 2.0.0 +title: New-UMIPGateway --- # New-UMIPGateway @@ -35,7 +36,7 @@ A UM IP gateway has organization-wide scope and references a single physical IP This cmdlet is scheduled to be removed from Exchange Online on December 1, 2019. For more information, see this [blog post](https://techcommunity.microsoft.com/t5/Exchange-Team-Blog/New-date-for-discontinuation-of-support-for-Session-Border/ba-p/607853). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,13 +64,15 @@ This example creates the UM IP gateway MyUMIPGateway that enables a Mailbox serv ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the UM IP gateway. The name for the new UM IP gateway can contain up to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -Address + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Address parameter specifies the IP address configured on the IP gateway or SIP-enabled IP PBX. ```yaml Type: UMSmartHost Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -104,7 +112,6 @@ 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 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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. @@ -122,7 +132,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -132,17 +141,19 @@ Accept wildcard characters: False ``` ### -IPAddressFamily -The IPAddressFamily parameter specifies whether the UM IP gateway will use Internet Protocol version 4 (IPv4), IPv6, or both to communicate. Valid values are: -- IPv4Only: The UM IP gateway will only use IPv4 to communicate. This is the default value. -- IPv6Only: The UM IP gateway will only use IPv6. -- Any: IPv6 will be used first, and then if necessary, it will fall back to IPv4. +> Applicable: Exchange Server 2013, Exchange Server 2016 + +The IPAddressFamily parameter specifies the Internet Protocol (IP) version to use. Valid values are: + +- IPv4Only: The UM IP gateway uses only IPv4 to communicate. This value is the default. +- IPv6Only: The UM IP gateway uses only IPv6. +- Any: IPv6 is used first. If IPv6 isn't available, IPV4 is used. ```yaml Type: IPAddressFamily Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan to be associated with the UM IP gateway. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-UMMailboxPolicy.md similarity index 85% rename from exchange/exchange-ps/exchange/New-UMMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMMailboxPolicy.md index 3ab4d1f26f..996149bc7e 100644 --- a/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: New-UMMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-ummailboxpolicy +schema: 2.0.0 +title: New-UMMailboxPolicy --- # New-UMMailboxPolicy @@ -33,7 +34,7 @@ The New-UMMailboxPolicy cmdlet creates a UM mailbox policy that has organization After this task is completed, a new UM mailbox policy is created. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example creates the UM mailbox policy MyUMMailboxPolicy associated with the ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the UM mailbox policy. The name for the UM mailbox policy can contain as many as 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the identifier for the UM dial plan to be associated with the UM mailbox policy. This parameter is the directory object ID for the UM dial plan. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -88,7 +96,6 @@ 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 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -114,13 +123,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-UnifiedAuditLogRetentionPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-UnifiedAuditLogRetentionPolicy.md index 2196b0f833..b0062846ba 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UnifiedAuditLogRetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-unifiedauditlogretentionpolicy applicable: Security & Compliance -title: New-UnifiedAuditLogRetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-unifiedauditlogretentionpolicy +schema: 2.0.0 +title: New-UnifiedAuditLogRetentionPolicy --- # New-UnifiedAuditLogRetentionPolicy @@ -55,13 +56,15 @@ This example creates an audit log retention policy that retains all audit logs f ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the audit log retention policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -71,17 +74,19 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A higher integer value indicates a lower priority. The value 1 is the highest priority, and the value 10000 is the lowest priority. No two policies can have the same priority value. This parameter is required when you create an audit log retention policy, and you must use a unique priority value. -Any custom audit log retention policy that you create will take precedence over the default audit log retention policy. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). +Any custom audit log retention policy that you create take precedence over the default audit log retention policy. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies how long audit log records are kept. Valid values are: - ThreeMonths @@ -104,7 +112,6 @@ Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears -Applicable: Security & Compliance Required: True Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -123,7 +133,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the audit log retention policy. The maximum length is 256 characters. 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 @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -Operations + +> Applicable: Security & Compliance + The Operations parameter specifies the audit log operations that are retained by the policy. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -159,7 +173,6 @@ If you use this parameter, you must also use the RecordTypes parameter to specif Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -RecordTypes + +> Applicable: Security & Compliance + The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). You can specify multiple values separated by commas. If you specify more than one value, you can't use the Operations parameter. @@ -177,7 +193,6 @@ You can specify multiple values separated by commas. If you specify more than on Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Security & Compliance + The UserIds parameter specifies the audit logs that are retained by the policy based on the ID of the user who performed the action. 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"`. @@ -195,7 +213,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -205,13 +222,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/New-UnifiedGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-UnifiedGroup.md similarity index 89% rename from exchange/exchange-ps/exchange/New-UnifiedGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-UnifiedGroup.md index 301fefe446..840c3aec79 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UnifiedGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup applicable: Exchange Online, Exchange Online Protection -title: New-UnifiedGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-unifiedgroup +schema: 2.0.0 +title: New-UnifiedGroup --- # New-UnifiedGroup @@ -126,7 +127,7 @@ New-UnifiedGroup -DlIdentity ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -140,6 +141,9 @@ This example creates a new Microsoft 365 Group named Engineering Department. ## PARAMETERS ### -DisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the name of the Microsoft 365 Group. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). For Microsoft 365 Groups, the DisplayName value is used in the unique Name property. However, because the DisplayName value doesn't need to be unique, the DisplayName value is appended with an underscore character (\_) and a short GUID value when it's used for the Name property. @@ -148,7 +152,6 @@ For Microsoft 365 Groups, the DisplayName value is used in the unique Name prope Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -158,6 +161,9 @@ Accept wildcard characters: False ``` ### -DlIdentity + +> Applicable: Exchange Online, Exchange Online Protection + The DlIdentity parameter specifies the distribution group (also known as a distribution list or DL) that you want to migrate to a Microsoft 365 Group. The distribution group must be a universal distribution group (the RecipientTypeDetails property value is MailUniversalDistributionGroup). You can use any value that uniquely identifies the distribution group. For example: - Name @@ -177,7 +183,6 @@ Microsoft 365 Groups don't have ReportToManager and ReportToOriginator parameter Type: DistributionGroupIdParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -187,9 +192,12 @@ Accept wildcard characters: False ``` ### -AccessType + +> Applicable: Exchange Online, Exchange Online Protection + The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Valid values are: -- Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. This is the default value. +- Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. This value is the default. - Private: The group content and conversations are available only to members of the group, and joining the group requires approval from a group owner. You can change the privacy type at any point in the lifecycle of the group. @@ -200,7 +208,6 @@ You can change the privacy type at any point in the lifecycle of the group. Type: ModernGroupTypeInfo Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,6 +217,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Microsoft 365 Group. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -219,7 +229,7 @@ The Alias value can contain letters, numbers and the following characters: - Periods (.) must be surrounded by other valid characters (for example, `help.desk`). - Unicode characters U+00A1 to U+00FF. -If you don't use the Alias parameter when you create a Microsoft 365 Group, the value of the DisplayName parameter is used for the Alias value. Spaces are removed, unsupported characters are converted to question marks (?), and numbers may be added to maintain the uniqueness of the Alias value. +If you don't use the Alias parameter when you create a Microsoft 365 Group, the value of the DisplayName parameter is used for the Alias value. Spaces are removed, unsupported characters are converted to question marks (?), and numbers might be added to maintain the uniqueness of the Alias value. When you create a Microsoft 365 Group without using the EmailAddresses parameter, the Alias value is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. @@ -229,7 +239,6 @@ The Alias value is appended with the ExternalDirectoryObjectId property value an Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -239,10 +248,13 @@ Accept wildcard characters: False ``` ### -AlwaysSubscribeMembersToCalendarEvents + +> Applicable: Exchange Online, Exchange Online Protection + The AlwaysSubscribeMembersToCalendarEvents switch controls the default subscription settings of new members that are added to the Microsoft 365 Group. -- If you use this switch without a value, all future members that are added to the group will have their subscriptions set to ReplyAndEvents. -- If you use this exact syntax: `-AlwaysSubscribeMembersToCalendarEvents:$false`, all future members that are added to the group will have their subscriptions set to ReplyOnly. +- If you use this switch without a value, all future members that are added to the group have their subscriptions set to ReplyAndEvents. +- If you use this exact syntax: `-AlwaysSubscribeMembersToCalendarEvents:$false`, all future members that are added to the group have their subscriptions set to ReplyOnly. Group members can change their own subscription settings, which can override your intended use of this switch. @@ -252,7 +264,6 @@ The AutoSubscribeNewMembers switch overrides this switch. Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -262,6 +273,9 @@ Accept wildcard characters: False ``` ### -AutoSubscribeNewMembers + +> Applicable: Exchange Online, Exchange Online Protection + The AutoSubscribeNewMembers switch specifies whether to automatically subscribe new members that are added to the Microsoft 365 Group to conversations and calendar events. You don't need to specify a value with this switch. You need to use this switch with the SubscriptionEnabled switch. @@ -270,7 +284,6 @@ You need to use this switch with the SubscriptionEnabled switch. Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,13 +293,15 @@ Accept wildcard characters: False ``` ### -Classification + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -296,6 +311,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -305,7 +323,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -315,11 +332,14 @@ Accept wildcard characters: False ``` ### -ConvertClosedDlToPrivateGroup + +> Applicable: Exchange Online, Exchange Online Protection + The ConvertClosedDlToPrivateGroup switch specifies whether to migrate the closed distribution group to a private Microsoft 365 Group. You don't need to specify a value with this switch. By default, this switch is always applied when migrating closed distribution groups, and is no longer required. -If the distribution group has the value Closed for the MemberDepartRestriction or MemberJoinRestriction parameters, the distribution group will always be migrated to a private Microsoft 365 Group. For open distribution groups, the migrated Microsoft 365 Group is always public, not private. +If the distribution group has the value Closed for the MemberDepartRestriction or MemberJoinRestriction parameters, the distribution group is always migrated to a private Microsoft 365 Group. For open distribution groups, the migrated Microsoft 365 Group is always public, not private. You can only use this switch with the DlIdentity parameter. @@ -327,7 +347,6 @@ You can only use this switch with the DlIdentity parameter. Type: SwitchParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,6 +356,9 @@ Accept wildcard characters: False ``` ### -DataEncryptionPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The DataEncryptionPolicy parameter specifies the data encryption policy that's applied to the Microsoft 365 Group. You can use any value that uniquely identifies the policy. For example: - Name @@ -347,7 +369,6 @@ The DataEncryptionPolicy parameter specifies the data encryption policy that's a Type: DataEncryptionPolicyIdParameter Parameter Sets: Identity, SegmentationOption, ProvisioningOptions Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -357,6 +378,9 @@ Accept wildcard characters: False ``` ### -DeleteDlAfterMigration + +> Applicable: Exchange Online, Exchange Online Protection + The DeleteDlAfterMigration switch specifies whether to delete the distribution group after it's migrated to a Microsoft 365 Group. You don't need to specify a value with this switch. You can only use this switch with the DlIdentity parameter. @@ -365,7 +389,6 @@ You can only use this switch with the DlIdentity parameter. Type: SwitchParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -375,13 +398,16 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the Microsoft 365 Group, including the primary SMTP address. In cloud-based organizations, the primary SMTP address and other proxy addresses for Microsoft 365 Groups are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the Microsoft 365 Group. Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. -- SPO: SharePoint Online email address. +- SPO: SharePoint email address. If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. @@ -395,7 +421,6 @@ To specify the primary SMTP email address, you can use any of the following meth Type: ProxyAddressCollection Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -405,13 +430,15 @@ Accept wildcard characters: False ``` ### -ExecutingUser + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -421,6 +448,9 @@ Accept wildcard characters: False ``` ### -ExoErrorAsWarning + +> Applicable: Exchange Online, Exchange Online Protection + The ExoErrorAsWarning switch specifies that Exchange Online errors that you encounter while creating the Microsoft 365 Group are treated as warnings, not errors. You don't need to specify a value with this switch. Creating Microsoft 365 Groups involves background operations in Microsoft Entra ID and Exchange Online. Errors that you might encounter in Exchange Online don't prevent the creation of the group (and therefore aren't really errors), because the group object in Microsoft Entra ID is synchronized back to Exchange Online. @@ -429,7 +459,6 @@ Creating Microsoft 365 Groups involves background operations in Microsoft Entra Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -439,17 +468,19 @@ Accept wildcard characters: False ``` ### -HiddenGroupMembershipEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the Microsoft 365 Group from users who aren't members of the group. You don't need to specify a value with this switch. You can use this setting to help comply with regulations that require you to hide group membership from outsiders (for example, a Microsoft 365 Group 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. In addition, any Microsoft 365 Groups with this setting will not be supported in sensitivity labeling policies. +**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. Also, any Microsoft 365 Groups with hidden group membership aren't supported in sensitivity labeling policies. ```yaml Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -459,13 +490,15 @@ Accept wildcard characters: False ``` ### -IsMemberAllowedToEditContent + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill IsMemberAllowedToEditContent Description }} ```yaml Type: System.Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -475,6 +508,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Online, Exchange Online Protection + The Language parameter specifies the language preference for the Microsoft 365 Group. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -483,7 +519,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -493,13 +528,15 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online, Exchange Online Protection + The MailboxRegion parameter specifies the preferred data location (PDL) for the Microsoft 365 Group in multi-geo environments. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -509,13 +546,15 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -525,6 +564,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Online, Exchange Online Protection + The Members parameter specifies the recipients (mail-enabled objects) that are members of the Microsoft 365 Group. You can use any value that uniquely identifies the recipient. For example: - Name @@ -540,7 +582,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -550,7 +591,10 @@ Accept wildcard characters: False ``` ### -Name -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. Previously, if you specified a value for this parameter, a random GUID value was added and used as the Name property value for the Microsoft 365 Group (`Name_`). Now, the value of the Name property is populated by the Alias parameter value and the ExternalDirectoryObjectId property value (`_`). @@ -558,7 +602,6 @@ Previously, if you specified a value for this parameter, a random GUID value was Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -568,13 +611,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Online, Exchange Online Protection + The Notes parameter specifies the description of the Microsoft 365 Group. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -584,6 +629,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Online, Exchange Online Protection + The Owner parameter specifies the for the Microsoft 365 Group. An owner is a group member who has certain privileges, such as the ability to edit group properties. The owner you specify for this parameter must be a mailbox or mail user (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example: @@ -599,7 +647,6 @@ The owner you specify for this parameter must be a mailbox or mail user (a mail- Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -609,13 +656,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. ```yaml Type: SmtpAddress Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -625,6 +674,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -634,7 +686,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -644,6 +695,9 @@ Accept wildcard characters: False ``` ### -SensitivityLabelId + +> Applicable: Exchange Online, Exchange Online Protection + The SensitivityLabelId parameter specifies the GUID value of the sensitivity label that's assigned to the Microsoft 365 Group. **Note**: In the output of the Get-UnifiedGroup cmdlet, this property is named SensitivityLabel, not SensitivityLabelId. @@ -652,7 +706,6 @@ The SensitivityLabelId parameter specifies the GUID value of the sensitivity lab Type: System.Guid Parameter Sets: Identity, SegmentationOption, ProvisioningOptions Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -662,13 +715,15 @@ Accept wildcard characters: False ``` ### -SubscriptionEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SubscriptionEnabled switch specifies whether subscriptions to conversations and calendar events are enabled for the Microsoft 365 Group. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -678,13 +733,15 @@ Accept wildcard characters: False ``` ### -SuppressWarmupMessage -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. ```yaml Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -694,13 +751,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-WebServicesVirtualDirectory.md similarity index 77% rename from exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-WebServicesVirtualDirectory.md index f99ae64e15..5fd6367dd4 100644 --- a/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-WebServicesVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-webservicesvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-WebServicesVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-webservicesvirtualdirectory +schema: 2.0.0 +title: New-WebServicesVirtualDirectory --- # New-WebServicesVirtualDirectory @@ -52,7 +53,7 @@ New-WebServicesVirtualDirectory [-ApplicationRoot ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,13 +67,15 @@ This example creates a virtual directory under the non-default website www.conto ## PARAMETERS ### -ApplicationRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ApplicationRoot parameter specifies the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -AppPoolId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AppPoolId parameter specifies the IIS application pool in which the virtual directory runs. We recommend that you leave this parameter at its default setting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -AppPoolIdForManagement + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AppPoolIdForManagement parameter specifies the pool of programs that manages the virtual directory. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,16 +121,18 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: -- $true: Basic authentication is enabled. This is the default value. +- $true: Basic authentication is enabled. This value is the default. - $false: Basic authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -142,7 +154,6 @@ 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 Required: False Position: Named @@ -152,16 +163,18 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. -- $false: Digest authentication is disabled. This is the default value. +- $false: Digest authentication is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,19 +202,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,16 +226,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,10 +247,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -240,7 +262,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -250,6 +271,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. @@ -258,7 +282,6 @@ This setting is important when Secure Sockets Layer (SSL) is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -268,6 +291,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -276,7 +302,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -286,10 +311,13 @@ Accept wildcard characters: False ``` ### -GzipLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GzipLevel parameter sets the Gzip configuration for the Exchange Web Services virtual directory. Valid values are: - Off: No compression. -- Low: Static compression only. This is the default value. This value has the same result as the Off value, because Exchange Web Services content is dynamic. +- Low: Static compression only. This value is the default. This value has the same result as the Off value, because Exchange Web Services content is dynamic. - High: Static and dynamic compression. Content from Exchange Web Services is compressed if clients indicate support for Gzip compression in their requests. - Error: Identifies errors in the Gzip compression configuration. @@ -297,7 +325,6 @@ The GzipLevel parameter sets the Gzip configuration for the Exchange Web Service Type: GzipLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -307,6 +334,9 @@ Accept wildcard characters: False ``` ### -InternalNLBBypassUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalNLBBypassUrl parameter specifies the URL of the Exchange server that has the Client Access server role installed, regardless of whether it's behind a Network Load Balancing (NLB) array or not. When you set the InternalUrl parameter to the URL of the NLB array, you should set the InternalNLBBypassUrl parameter to the URL of the Client Access server itself. @@ -315,7 +345,6 @@ When you set the InternalUrl parameter to the URL of the NLB array, you should s Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,6 +354,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is important when SSL is used. @@ -333,7 +365,6 @@ This setting is important when SSL is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -343,13 +374,15 @@ Accept wildcard characters: False ``` ### -MRSProxyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MRSProxyEnabled parameter specifies whether to enable MRSProxy for the Mailbox server. MRSProxy is a service that runs on Mailbox servers in a remote forest and helps to proxy a mailbox move. For more information, see [Mailbox moves in Exchange Server](https://learn.microsoft.com/Exchange/recipients/mailbox-moves). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -359,15 +392,17 @@ Accept wildcard characters: False ``` ### -MRSProxyMaxConnections + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. -The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy will accept. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). +The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy accepts. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -377,16 +412,18 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OAuthAuthentication parameter specifies whether OAuth authentication is enabled on the virtual directory. Valid values are: -- $true: OAuth authentication is enabled. This is the default value. +- $true: OAuth authentication is enabled. This value is the default. - $false: OAuth authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -396,13 +433,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Path parameter sets the path of the virtual directory in the metabase. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -412,6 +451,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -423,7 +465,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +474,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -444,7 +488,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -454,13 +497,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WebSiteName parameter specifies the name of the website under which to create the virtual directory. This parameter shouldn't be used when you're creating a virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -470,13 +515,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -486,16 +533,18 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: -- $true: Integrated Windows authentication is enabled. This is the default value. +- $true: Integrated Windows authentication is enabled. This value is the default. - $false: Integrated Windows authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -505,16 +554,18 @@ Accept wildcard characters: False ``` ### -WSSecurityAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are: -- $true: WS-Security authentication is enabled. This is the default value. +- $true: WS-Security authentication is enabled. This value is the default. - $false: WS-Security authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md b/exchange/exchange-ps/ExchangePowerShell/New-X400AuthoritativeDomain.md similarity index 83% rename from exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md rename to exchange/exchange-ps/ExchangePowerShell/New-X400AuthoritativeDomain.md index c18e6668eb..076d4f9729 100644 --- a/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-X400AuthoritativeDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-x400authoritativedomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-X400AuthoritativeDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-x400authoritativedomain +schema: 2.0.0 +title: New-X400AuthoritativeDomain --- # New-X400AuthoritativeDomain @@ -64,7 +65,7 @@ organizational unit name - Abbreviation: OU1 to OU4 - Maximum character length: 32 -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -85,13 +86,15 @@ This example creates an external relay domain for the X.400 namespace Europe org ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name for the X.400 authoritative domain. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -X400DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The X400DomainName parameter specifies the X.400 namespace, which can only include the X.400 organizational components. Specifically, only the following attribute types are supported: - C (Country) @@ -118,7 +124,6 @@ Separate the address attributes with semicolons and enclose the entire address i Type: X400Domain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -137,7 +145,6 @@ 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 Required: False Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -155,7 +165,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +192,15 @@ Accept wildcard characters: False ``` ### -X400ExternalRelay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The X400ExternalRelay parameter specifies authoritative domain an external relay domain. If you set the X400ExternalRelay parameter to $true, Microsoft Exchange routes email to the external address and doesn't treat resolution failures to this subdomain as an error. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/ExchangePowerShell/Preview-QuarantineMessage.md similarity index 81% rename from exchange/exchange-ps/exchange/Preview-QuarantineMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Preview-QuarantineMessage.md index 655b0da6f5..d111fb6995 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Preview-QuarantineMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/preview-quarantinemessage applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Preview-QuarantineMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/preview-quarantinemessage +schema: 2.0.0 +title: Preview-QuarantineMessage --- # Preview-QuarantineMessage @@ -28,7 +29,7 @@ Preview-QuarantineMessage -Identity ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example previews the quarantined message that has the specified Identity va ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the quarantined message that you want to preview. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. @@ -57,7 +61,6 @@ You can find the Identity value for a quarantined message by using the Get-Quara Type: QuarantineMessageIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -78,7 +84,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Redirect-Message.md b/exchange/exchange-ps/ExchangePowerShell/Redirect-Message.md similarity index 82% rename from exchange/exchange-ps/exchange/Redirect-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Redirect-Message.md index 1a0354a5bc..05f186c4c4 100644 --- a/exchange/exchange-ps/exchange/Redirect-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Redirect-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/redirect-message -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Redirect-Message -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/redirect-message +schema: 2.0.0 +title: Redirect-Message --- # Redirect-Message @@ -32,9 +33,9 @@ When a message queue is drained, the active messages in the queues on the source - Only active messages are drained. Shadow queues aren't drained. - Messages in the poison message queue aren't drained. -- The source server won't accept new messages while the queues are drained. +- The source server doesn't accept new messages while the queues are drained. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example drains the active messages from the delivery queues on the Mailbox ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the source Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -59,7 +63,6 @@ The Server parameter specifies the source Exchange server where you want to run Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Target parameter specifies the target Mailbox server where you want to transfer the messages from the drained delivery queues. Enter the server name as a fully qualified domain name (FQDN). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -94,7 +102,6 @@ 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 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/ExchangePowerShell/Release-QuarantineMessage.md similarity index 85% rename from exchange/exchange-ps/exchange/Release-QuarantineMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Release-QuarantineMessage.md index 17f3d5590b..211696a797 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Release-QuarantineMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/release-quarantinemessage applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Release-QuarantineMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/release-quarantinemessage +schema: 2.0.0 +title: Release-QuarantineMessage --- # Release-QuarantineMessage @@ -77,7 +78,7 @@ Release-QuarantineMessage -Identity ## DESCRIPTION Consider the following scenario: john@gmail.com sends a message to faith@contoso.com and john@subsidiary.contoso.com. Gmail bifurcates this message into two copies that are both routed to quarantine as phishing in Microsoft. An admin releases both of these messages to admin@contoso.com. The first released message that reaches the admin mailbox is delivered. The second released message is identified as duplicate delivery and is skipped. Message are identified as duplicates if they have the same message ID and received time. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -114,6 +115,9 @@ This example releases a file that was quarantined as part of Safe Attachments fo ## PARAMETERS ### -Identities + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2,...valueN`. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. @@ -122,9 +126,8 @@ When you use this parameter, the Identity parameter is required, but the value i ```yaml Type: QuarantineMessageIdentity[] -Parameter Sets: Identities +Parameter Sets: Identities, OrgReleaseToAll, OrgReleaseToUser Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -133,29 +136,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: QuarantineMessageIdentity[] -Parameter Sets: OrgReleaseToAll, OrgReleaseToUser -Aliases: -Applicable: Exchange Online, Exchange Online Protection +### -Identity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection -### -Identity The Identity parameter specifies the quarantined message that you want to release. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. ```yaml Type: QuarantineMessageIdentity -Parameter Sets: Identities, OrgReleaseToAll, OrgReleaseToUser +Parameter Sets: Identities, OrgReleaseToAll, OrgReleaseToUser, IdentityOnly Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -164,20 +156,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: IdentityOnly -Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection +### -ReleaseToAll -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection -### -ReleaseToAll The ReleaseToAll switch releases the quarantined message to all original recipients. You don't need to specify a value with this switch. This switch is required for the quarantine type SPOMalware. @@ -190,7 +172,6 @@ You can't use the ReleaseToAll switch and the User parameter in the same command Type: SwitchParameter Parameter Sets: OrgReleaseToAll Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -200,6 +181,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The User parameter specifies the email address of the user to whom you want to release the quarantined message. You can specify multiple email addresses separated by commas. You can use this parameter to release the message to recipients of the original message, or to any other email addresses in the organization. @@ -210,7 +194,6 @@ If you previously used the ReleaseToAll switch to release the quarantined messag Type: String[] Parameter Sets: OrgReleaseToUser Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -220,6 +203,9 @@ Accept wildcard characters: False ``` ### -ActionType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ActionType parameter specifies the release action type. Valid values are: - Deny @@ -230,7 +216,6 @@ The ActionType parameter specifies the release action type. Valid values are: Type: ReleaseActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -240,7 +225,10 @@ Accept wildcard characters: False ``` ### -AllowSender -The AllowSender switch specifies that all future messages from the sender won't be quarantined. You don't need to specify a value with this switch. + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +The AllowSender switch specifies that all future messages from the sender isn't quarantined. You don't need to specify a value with this switch. If the message was quarantined because of a transport rule or blocked sender, messages from the sender can still be blocked in the future. @@ -248,7 +236,6 @@ If the message was quarantined because of a transport rule or blocked sender, me Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -258,6 +245,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -267,7 +257,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -277,6 +266,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -288,7 +280,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -298,6 +289,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch whenever you attempt to re-release previously released messages from quarantine. @@ -306,7 +300,6 @@ Use this switch whenever you attempt to re-release previously released messages Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -316,6 +309,9 @@ Accept wildcard characters: False ``` ### -ReportFalsePositive + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ReportFalsePositive switch specifies whether to report the message as a false positive to Microsoft (good message marked as bad). You don't need to specify a value with this switch. This switch is available only for quarantined spam messages. @@ -324,7 +320,6 @@ This switch is available only for quarantined spam messages. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -334,6 +329,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -342,7 +340,6 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ADPermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ADPermission.md similarity index 77% rename from exchange/exchange-ps/exchange/Remove-ADPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ADPermission.md index 13ca24fb1e..f51aa603d1 100644 --- a/exchange/exchange-ps/exchange/Remove-ADPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ADPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-adpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ADPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-adpermission +schema: 2.0.0 +title: Remove-ADPermission --- # Remove-ADPermission @@ -63,9 +64,9 @@ Remove-ADPermission [[-Identity] ] -Instance Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the object from which the permission should be removed. You can specify either the distinguished name (DN) of the object or the object's name if it's unique. If the DN or name contains spaces, enclose the name in quotation marks ("). ```yaml Type: ADRawEntryIdParameter -Parameter Sets: AccessRights, Owner +Parameter Sets: AccessRights, Owner, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -103,27 +106,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: ADRawEntryIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Instance -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Instance The Instance parameter enables you to pass an entire object to the command to be processed. It's mainly used in scripts where an entire object must be passed to the command. ```yaml Type: ADAcePresentationObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -133,6 +125,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The User parameter specifies whose permissions are being removed from the Active Directory object. You can specify the following types of users or groups: - Mailbox users @@ -159,9 +154,8 @@ Otherwise, you can use any value that uniquely identifies the user or group. For ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -170,20 +164,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -AccessRights -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -AccessRights The AccessRights parameter specifies the rights that you want to remove from the user on the Active Directory object. Valid values include: - CreateChild @@ -212,7 +196,6 @@ You can specify multiple values separated by commas. Type: ActiveDirectoryRights[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +205,9 @@ Accept wildcard characters: False ``` ### -ChildObjectTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ChildObjectTypes parameter specifies what type of object the permission should be removed from. The ChildObjectTypes parameter can only be used if the AccessRights parameter is set to CreateChild or DeleteChild. @@ -230,7 +216,6 @@ The ChildObjectTypes parameter can only be used if the AccessRights parameter is Type: ADSchemaObjectIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -240,6 +225,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -249,7 +237,6 @@ 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 Required: False Position: Named @@ -259,13 +246,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Deny switch specifies that the permissions you're removing are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,6 +264,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -283,7 +275,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +284,15 @@ Accept wildcard characters: False ``` ### -ExtendedRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedRights parameter specifies the extended rights to remove. ```yaml Type: ExtendedRightIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,6 +302,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InheritanceType parameter specifies how permissions are inherited. Valid values are: - None @@ -321,7 +317,6 @@ The InheritanceType parameter specifies how permissions are inherited. Valid val Type: ActiveDirectorySecurityInheritance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -331,13 +326,15 @@ Accept wildcard characters: False ``` ### -InheritedObjectType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InheritedObjectType parameter specifies what kind of object inherits this access control entry (ACE). ```yaml Type: ADSchemaObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -347,6 +344,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Properties parameter specifies what properties the object contains. The Properties parameter can only be used if the AccessRights parameter is set to ReadProperty, WriteProperty, or Self. @@ -355,7 +355,6 @@ The Properties parameter can only be used if the AccessRights parameter is set t Type: ADSchemaObjectIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -365,13 +364,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ATPProtectionPolicyRule.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ATPProtectionPolicyRule.md index 47ada3944f..5a8ea95946 100644 --- a/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-atpprotectionpolicyrule applicable: Exchange Online -title: Remove-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-atpprotectionpolicyrule +schema: 2.0.0 +title: Remove-ATPProtectionPolicyRule --- # Remove-ATPProtectionPolicyRule @@ -16,7 +17,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-ATPProtectionPolicyRule cmdlet to remove rules from Microsoft Defender for Office 365 protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. -**Note**: Use this cmdlet to remove a rule only if you plan to immediately recreate the rule using the New-ATPProtectionPolicyRule cmdlet. The affected preset security policy won't function without a corresponding rule. +**Note**: Use this cmdlet to remove a rule only if you plan to immediately recreate the rule using the New-ATPProtectionPolicyRule cmdlet. The affected preset security policy doesn't function without a corresponding rule. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -32,7 +33,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example removes the existing rule for Defender for Office 365 protections i ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AcceptedDomain.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-AcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AcceptedDomain.md index 5339aa412e..e52512ac6c 100644 --- a/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AcceptedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-accepteddomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AcceptedDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-accepteddomain +schema: 2.0.0 +title: Remove-AcceptedDomain --- # Remove-AcceptedDomain @@ -29,7 +30,7 @@ Remove-AcceptedDomain [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example removes the accepted domain Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the accepted domain you want to remove. Enter either the GUID or the name of the remote domain. ```yaml Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -68,7 +74,6 @@ 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 Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -86,7 +94,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDevice.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDevice.md index 5ec58a6bb4..e999d2e4a6 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDevice.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncdevice -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-ActiveSyncDevice -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-activesyncdevice +schema: 2.0.0 +title: Remove-ActiveSyncDevice --- # Remove-ActiveSyncDevice ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-ActiveSyncDevice cmdlet to remove mobile device partnerships that identify the devices that are configured to synchronize with user mailboxes. @@ -33,7 +34,7 @@ Remove-ActiveSyncDevice [-Identity] ## DESCRIPTION The Remove-ActiveSyncDevice cmdlet is useful for removing mobile devices that no longer synchronize successfully with the server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,13 +62,15 @@ This example removes the mobile device partnership for the device named Tablet\_ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter uniquely identifies the specific device partnership to be removed. ```yaml Type: ActiveSyncDeviceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -86,7 +92,6 @@ 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 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -104,7 +112,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceAccessRule.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceAccessRule.md index 5e56ff683d..749904cbf9 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceAccessRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncdeviceaccessrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-ActiveSyncDeviceAccessRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-activesyncdeviceaccessrule +schema: 2.0.0 +title: Remove-ActiveSyncDeviceAccessRule --- # Remove-ActiveSyncDeviceAccessRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-ActiveSyncDeviceAccessRule cmdlet to remove any existing device access rule. @@ -31,7 +32,7 @@ Remove-ActiveSyncDeviceAccessRule [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the device access rule. ```yaml Type: ActiveSyncDeviceAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -77,7 +83,6 @@ 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 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -95,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceClass.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceClass.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceClass.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceClass.md index fee0ac4e53..ae96896997 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceClass.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceClass.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncdeviceclass -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ActiveSyncDeviceClass -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-activesyncdeviceclass +schema: 2.0.0 +title: Remove-ActiveSyncDeviceClass --- # Remove-ActiveSyncDeviceClass @@ -31,7 +32,7 @@ Remove-ActiveSyncDeviceClass [-Identity] ## DESCRIPTION The Remove-ActiveSyncDeviceClass cmdlet cleans up the list of devices that are associated with your organization. Mobile phones and devices that are inactive or have been remote wiped are removed from the list and the Microsoft Exchange ActiveSync process regenerates the list with the current mobile phones and devices. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example retrieves the list of devices connecting to Microsoft Exchange and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the group of devices on which to scope the task. ```yaml Type: ActiveSyncDeviceClassIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -70,7 +76,6 @@ 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 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncMailboxPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncMailboxPolicy.md index faa170542f..d800c7776c 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncmailboxpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-ActiveSyncMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-activesyncmailboxpolicy +schema: 2.0.0 +title: Remove-ActiveSyncMailboxPolicy --- # Remove-ActiveSyncMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-ActiveSyncMailboxPolicy cmdlet to remove mobile device mailbox policies. @@ -34,7 +35,7 @@ Remove-ActiveSyncMailboxPolicy [-Identity] ## DESCRIPTION A mobile device mailbox policy is a group of settings that specifies how mobile phones connect to Exchange. Exchange supports multiple mobile device mailbox policies. If any users are assigned to the policy when you attempt to remove it, the command fails. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example removes the mobile device mailbox policy named Management and bypas ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mobile device mailbox policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the mobile device mailbox policy that you want Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -84,7 +90,6 @@ 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 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -102,7 +110,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -120,7 +130,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncVirtualDirectory.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncVirtualDirectory.md index a45a5a2bd8..0d298379c4 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ActiveSyncVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-activesyncvirtualdirectory +schema: 2.0.0 +title: Remove-ActiveSyncVirtualDirectory --- # Remove-ActiveSyncVirtualDirectory @@ -31,7 +32,7 @@ Remove-ActiveSyncVirtualDirectory [-Identity] ## DESCRIPTION When the Exchange ActiveSync virtual directory is removed from a specified server and website, the virtual directory is also removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example removes a custom Exchange ActiveSync virtual directory from the ser ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Exchange ActiveSync virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -71,7 +75,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -90,7 +96,6 @@ 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 Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AdaptiveScope.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-AdaptiveScope.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AdaptiveScope.md index 6716aabc5e..45e8996990 100644 --- a/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AdaptiveScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-adaptivescope applicable: Security & Compliance -title: Remove-AdaptiveScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-adaptivescope +schema: 2.0.0 +title: Remove-AdaptiveScope --- # Remove-AdaptiveScope @@ -43,6 +44,9 @@ This example removes the adaptive scope named Project X. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the adaptive scope that you want to remove. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the adaptive scope that you want to remove. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the adaptive scope. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressBookPolicy.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AddressBookPolicy.md index f2bac7b9a2..a074082f24 100644 --- a/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressBookPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-addressbookpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-AddressBookPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-addressbookpolicy +schema: 2.0.0 +title: Remove-AddressBookPolicy --- # Remove-AddressBookPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-AddressBookPolicy cmdlet to delete an address book policy. You can't remove the address book policy if it's still assigned to a user's mailbox. @@ -35,7 +36,7 @@ You can't delete an address book policy if it's assigned to a user. To determine `Get-Mailbox -ResultSize unlimited -Filter "AddressBookPolicy -eq '$((Get-AddressBookPolicy "Murchison's Class").DistinguishedName)'"` -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example deletes the address book policy Murchison's Class. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the address book policy that you want to remove. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -74,7 +80,6 @@ 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 Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressList.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AddressList.md index a77eb38489..9def5d8847 100644 --- a/exchange/exchange-ps/exchange/Remove-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressList.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-addresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-AddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-addresslist +schema: 2.0.0 +title: Remove-AddressList --- # Remove-AddressList ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-AddressList cmdlet to remove existing address lists. @@ -37,7 +38,7 @@ You can use the Remove-AddressList cmdlet with the Get-AddressList cmdlet in the - Use the Get-AddressList cmdlet to get address list information, and then pipe the output to the Format-List cmdlet to get the GUID, distinguished name (DN), or path and name of an existing address list. - Use the Get-AddressList cmdlet to get a specific existing address list, and then pipe the output directly to the Remove-AddressList cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example removes the address list named AddressList1 and all of its child ad ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the address list that you want to remove. You can use any value that uniquely identifies the address list. For example: - Name @@ -64,7 +68,6 @@ If the address list has child address lists that you also want to remove, you ne Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -83,7 +89,6 @@ 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 Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -101,7 +109,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Recursive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Recursive switch specifies whether to remove all child address lists. You don't need to specify a value for this switch. If you don't use this switch, and the address list has child address lists, the command will fail. @@ -119,7 +129,6 @@ If you don't use this switch, and the address list has child address lists, the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressRewriteEntry.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AddressRewriteEntry.md index 8eb9950d2e..63385b48ca 100644 --- a/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressRewriteEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-addressrewriteentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AddressRewriteEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-addressrewriteentry +schema: 2.0.0 +title: Remove-AddressRewriteEntry --- # Remove-AddressRewriteEntry @@ -54,13 +55,15 @@ This example removes all address rewrite entries that include contoso.com in the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the address rewrite entry you want to remove. The Identity parameter accepts a GUID or the unique address rewrite name. You can omit the Identity parameter label. ```yaml Type: AddressRewriteEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -79,7 +85,6 @@ 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 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -97,7 +105,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishPolicy.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishPolicy.md index 6bff81fad7..4c0519e57b 100644 --- a/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-antiphishpolicy applicable: Exchange Online, Exchange Online Protection -title: Remove-AntiPhishPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-antiphishpolicy +schema: 2.0.0 +title: Remove-AntiPhishPolicy --- # Remove-AntiPhishPolicy @@ -29,7 +30,7 @@ Remove-AntiPhishPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example removes the antiphish policy named Quarantine Policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the antiphish policy that you want to remove. Y Type: AntiPhishPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -90,7 +98,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishRule.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishRule.md index 77562bbd26..6977beb97b 100644 --- a/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: Remove-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-antiphishrule +schema: 2.0.0 +title: Remove-AntiPhishRule --- # Remove-AntiPhishRule @@ -28,7 +29,7 @@ Remove-AntiPhishRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This examples removes the antiphish rule named Research Department Phishing Rule ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the antiphish rule that you want to remove. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-App.md b/exchange/exchange-ps/ExchangePowerShell/Remove-App.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-App.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-App.md index c24c1658e5..0d998b170b 100644 --- a/exchange/exchange-ps/exchange/Remove-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-App.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-app -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-App -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-app +schema: 2.0.0 +title: Remove-App --- # Remove-App ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-App cmdlet to uninstall an app. @@ -33,9 +34,9 @@ Remove-App [-Identity] ``` ## DESCRIPTION -The Remove-App cmdlet requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet. Apps installed by default can't be uninstalled, but they can be disabled. +The Remove-App cmdlet requires that the specified app has already been installed (for example, that the app is installed with the New-App cmdlet. Apps installed by default can't be uninstalled, but they can be disabled. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example removes the Finance Test app installed for user Tony. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the AppID (GUID value) of the app that you want to remove. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. ```yaml Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -AppType + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AppType Description }} @@ -73,7 +79,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -92,7 +100,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -110,7 +120,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -137,7 +149,6 @@ The Mailbox parameter specifies the mailbox that you want to modify. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -147,6 +158,9 @@ Accept wildcard characters: False ``` ### -OrganizationApp + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OrganizationApp switch specifies that the scope of the app is organizational. You don't need to specify a value with this switch. This switch is required if the targeted app is installed for the organization. @@ -155,7 +169,6 @@ This switch is required if the targeted app is installed for the organization. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -PrivateCatalog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PrivateCatalog switch specifies that the app you want to remove is located in a private catalog. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -181,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionCompliancePolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionCompliancePolicy.md index c470a3f9f2..5be985ef9e 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-appretentioncompliancepolicy applicable: Security & Compliance -title: Remove-AppRetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-appretentioncompliancepolicy +schema: 2.0.0 +title: Remove-AppRetentionCompliancePolicy --- # Remove-AppRetentionCompliancePolicy @@ -43,6 +44,9 @@ This example removes the app retention compliance policy named Contoso Viva Enga ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the app retention compliance policy that you wa Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionComplianceRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionComplianceRule.md index 724cda7063..13b5fa09f8 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-appretentioncompliancerule applicable: Security & Compliance -title: Remove-AppRetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-appretentioncompliancerule +schema: 2.0.0 +title: Remove-AppRetentionComplianceRule --- # Remove-AppRetentionComplianceRule @@ -43,6 +44,9 @@ This example removes the app retention compliance policy rule Contoso Viva Engag ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance rule that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the app retention compliance rule that you want Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ApplicationAccessPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ApplicationAccessPolicy.md index 9b1bae6a1a..484f3eeee3 100644 --- a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ApplicationAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection -title: Remove-ApplicationAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-applicationaccesspolicy +schema: 2.0.0 +title: Remove-ApplicationAccessPolicy --- # Remove-ApplicationAccessPolicy @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Remove-ApplicationAccessPolicy cmdlet to remove application access policies. These changes may take up to 30 minutes to go live. +Use the Remove-ApplicationAccessPolicy cmdlet to remove application access policies. These changes might take up to 30 minutes to go live. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -28,7 +29,7 @@ Remove-ApplicationAccessPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,13 +43,15 @@ This example removes the specified policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the application access policy that you want to remove. To find the Identity value for the policy, run the command Get-ApplicationAccessPolicy | Format-List Identity,Description,ScopeName,AccessRight,AppID. ```yaml Type: ApplicationAccessPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AttachmentFilterEntry.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AttachmentFilterEntry.md index a166c59fe8..ea755ecb19 100644 --- a/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AttachmentFilterEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-attachmentfilterentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AttachmentFilterEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-attachmentfilterentry +schema: 2.0.0 +title: Remove-AttachmentFilterEntry --- # Remove-AttachmentFilterEntry @@ -29,7 +30,7 @@ Remove-AttachmentFilterEntry [-Identity] ``` ## DESCRIPTION -On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchangepowershell/set-attachmentfilterlistconfig). On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. @@ -52,6 +53,9 @@ This example removes the attachment filter entry that filters attachments that h ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the type of attachment that this filter entry removes. The Identity parameter accepts values in the format Type:Name, where Type is one of the following two values: - ContentType: This value matches the attachment filter entry against the MIME content type. @@ -63,7 +67,6 @@ In Type:Name, Name can be either the file name of the attachment filter entry to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -82,7 +88,6 @@ 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 Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -100,7 +108,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AuthRedirect.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthRedirect.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-AuthRedirect.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AuthRedirect.md index 5472c1ac64..2b6f344d38 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthRedirect.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthRedirect.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-authredirect -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AuthRedirect -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-authredirect +schema: 2.0.0 +title: Remove-AuthRedirect --- # Remove-AuthRedirect @@ -29,7 +30,7 @@ Remove-AuthRedirect [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example removes all existing OAuth redirection objects from your organizati ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the existing OAuth redirection object that you want to remove. The object name uses the syntax `AuthRedirect-Bearer-GUID`. The easiest way to find the name of the OAuth redirection object is to run Get-AuthRedirect. ```yaml Type: AuthRedirectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -75,7 +81,6 @@ 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 Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AuthServer.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthServer.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-AuthServer.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AuthServer.md index 826c25a07f..7fb750f295 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-authserver -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AuthServer -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-authserver +schema: 2.0.0 +title: Remove-AuthServer --- # Remove-AuthServer @@ -29,7 +30,7 @@ Remove-AuthServer [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example removes the authorization server named AMC. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the authorization server object that you want to remove. You can use any value that uniquely identifies the authorization server. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the authorization server object that you want t Type: AuthServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthenticationPolicy.md similarity index 72% rename from exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AuthenticationPolicy.md index ee48f9b65e..c6053a0e63 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthenticationPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-authenticationpolicy -applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-AuthenticationPolicy -schema: 2.0.0 +applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-authenticationpolicy +schema: 2.0.0 +title: Remove-AuthenticationPolicy --- # Remove-AuthenticationPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-AuthenticationPolicy cmdlet to remove authentication policies from your organization. @@ -30,7 +31,7 @@ Remove-AuthenticationPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,11 +47,14 @@ This example removes the authentication policy named "Engineering Group". 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. +In Exchange Online, this example enables legacy Exchange tokens to be issued to Outlook add-ins. This switch applies to the entire organization. The Identity parameter is required, and its value must be set to "LegacyExchangeTokens". Specific authentication policies can't be applied. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the authentication policy you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the authentication policy you want to remove. Y Type: AuthPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -71,26 +74,28 @@ Accept wildcard characters: False ``` ### -AllowLegacyExchangeTokens + +> Applicable: Exchange Online, Exchange Online Protection + 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. +This switch applies to the entire organization. The Identity parameter is required, and its value must be set to "LegacyExchangeTokens". Specific authentication policies can't be applied. **Important**: +- Legacy Exchange Online tokens will be turned off for all organizations from August 2025 through September 2025. Once turned off, you can't use the _AllowLegacyExchangeTokens_ switch on the **Set-AuthenticationPolicy** cmdlet to turn on these tokens. You get the warning "Legacy Exchange Online tokens are disabled" when you run the command `Get-AuthenticationPolicy -AllowLegacyExchangeTokens`. You can [contact Microsoft Support to request an exception](https://aka.ms/LegacyTokensByOctober). 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). - 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. -- Legacy Exchange tokens will eventually be 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 @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -109,7 +117,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill TenantId Description }} @@ -127,7 +137,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -137,13 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelPolicy.md index d6b2940550..4b08056b03 100644 --- a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelpolicy applicable: Security & Compliance -title: Remove-AutoSensitivityLabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-autosensitivitylabelpolicy +schema: 2.0.0 +title: Remove-AutoSensitivityLabelPolicy --- # Remove-AutoSensitivityLabelPolicy @@ -42,6 +43,9 @@ This example removes the policy named Marketing Group. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the auto-labeling policy that you want to remov Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelRule.md index f779597117..91e0471d61 100644 --- a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelrule applicable: Security & Compliance -title: Remove-AutoSensitivityLabelRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-autosensitivitylabelrule +schema: 2.0.0 +title: Remove-AutoSensitivityLabelRule --- # Remove-AutoSensitivityLabelRule @@ -42,6 +43,9 @@ This example removes the rule named Social Security Rule. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the auto-labeling policy rule that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AutodiscoverVirtualDirectory.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AutodiscoverVirtualDirectory.md index 948dcc21f7..d8cc8b9d69 100644 --- a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AutodiscoverVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-autodiscovervirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AutodiscoverVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-autodiscovervirtualdirectory +schema: 2.0.0 +title: Remove-AutodiscoverVirtualDirectory --- # Remove-AutodiscoverVirtualDirectory @@ -29,7 +30,7 @@ Remove-AutodiscoverVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example removes the Autodiscover virtual directory from the site autodiscov ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Autodiscover virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -55,7 +59,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -74,7 +80,6 @@ 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 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityAddressSpace.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityAddressSpace.md index 97bf6ead5a..3fb0f0cda6 100644 --- a/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityAddressSpace.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-availabilityaddressspace -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-AvailabilityAddressSpace -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-availabilityaddressspace +schema: 2.0.0 +title: Remove-AvailabilityAddressSpace --- # Remove-AvailabilityAddressSpace ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-AvailabilityAddressSpace cmdlet to remove existing availability address space objects and the associated credentials that were used to share free/busy data across Exchange organizations. @@ -31,7 +32,7 @@ Remove-AvailabilityAddressSpace [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the availability address that you want to remove. You can use any value that uniquely identifies the object. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the availability address that you want to remov Type: AvailabilityAddressSpaceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -81,7 +87,6 @@ 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 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityConfig.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityConfig.md index f51da6fded..f5d7462be5 100644 --- a/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-availabilityconfig applicable: Exchange Online -title: Remove-AvailabilityConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-availabilityconfig +schema: 2.0.0 +title: Remove-AvailabilityConfig --- # Remove-AvailabilityConfig @@ -28,7 +29,7 @@ Remove-AvailabilityConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,13 +43,15 @@ This example removes the existing availability configuration. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityReportOutage.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityReportOutage.md index 8e66eefd7a..24ba21761f 100644 --- a/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityReportOutage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-availabilityreportoutage applicable: Exchange Server 2010 -title: Remove-AvailabilityReportOutage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-availabilityreportoutage +schema: 2.0.0 +title: Remove-AvailabilityReportOutage --- # Remove-AvailabilityReportOutage @@ -31,7 +32,7 @@ Remove-AvailabilityReportOutage [-SiteName] -ReportDate ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example removes a manually injected site-scoped outage for a specified day. ## PARAMETERS ### -SiteName + +> Applicable: Exchange Server 2010 + The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -ReportDate + +> Applicable: Exchange Server 2010 + The ReportDate parameter specifies the date to query for the outage report. ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -77,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -86,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010 + 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. @@ -104,7 +114,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -114,13 +123,15 @@ Accept wildcard characters: False ``` ### -ReportingDatabase + +> Applicable: Exchange Server 2010 + The ReportingDatabase parameter specifies the name of the database on the reporting server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -130,13 +141,15 @@ Accept wildcard characters: False ``` ### -ReportingServer + +> Applicable: Exchange Server 2010 + The ReportingServer parameter specifies the name of the reporting database server to connect to. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -146,13 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-BlockedConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-BlockedConnector.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-BlockedConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-BlockedConnector.md index 6520e630b3..b89de490a5 100644 --- a/exchange/exchange-ps/exchange/Remove-BlockedConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-BlockedConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-blockedconnector applicable: Exchange Online, Exchange Online Protection -title: Remove-BlockedConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-blockedconnector +schema: 2.0.0 +title: Remove-BlockedConnector --- # Remove-BlockedConnector @@ -25,7 +26,7 @@ Remove-BlockedConnector -ConnectorId [-Reason ] [ Applicable: Exchange Online, Exchange Online Protection + The ConnectorId parameter specifies the blocked connector that you want to unblock. The value is a GUID (for example, 159eb7c4-75d7-43e2-95fe-ced44b3e0a56). You can find this value from the output of the Get-BlockedConnector command. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -55,13 +58,15 @@ Accept wildcard characters: False ``` ### -Reason + +> Applicable: Exchange Online, Exchange Online Protection + The Reason parameter specifies comments about why you're unblocking the blocked connector. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md b/exchange/exchange-ps/ExchangePowerShell/Remove-BlockedSenderAddress.md similarity index 75% rename from exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-BlockedSenderAddress.md index ce007bf146..0e9b5b1757 100644 --- a/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-BlockedSenderAddress.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-blockedsenderaddress applicable: Exchange Online, Exchange Online Protection -title: Remove-BlockedSenderAddress -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-blockedsenderaddress +schema: 2.0.0 +title: Remove-BlockedSenderAddress --- # Remove-BlockedSenderAddress @@ -14,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Remove-BlockedSenderAddress cmdlet to unblock users in your Microsoft 365 organization that were impacted by the protection system. These users sent multiple messages that were classified as spam, so they were blocked from sending messages. +Use the Remove-BlockedSenderAddress cmdlet to unblock users in your Microsoft 365 organization that were affected by the protection system. These users sent multiple messages that were classified as spam, so they were blocked from sending messages. -**Note**: There's a limit to the number of times you can unblock a Microsoft 365 account. If you exceed the unblock limit for a user, you'll receive an error, and you'll need to contact support to unblock the user. +**Note**: There's a limit to the number of times you can unblock a Microsoft 365 account. If you exceed the unblock limit for a user, you get an error, and you need to contact Microsoft Support to unblock the user. 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 +30,7 @@ Remove-BlockedSenderAddress -SenderAddress ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example unblocks the user julia@contoso.com. ## PARAMETERS ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter specifies the email address of the user that you want to unblock. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -Reason + +> Applicable: Exchange Online, Exchange Online Protection + The Reason parameter specifies the reason the user was blocked (the Reason property value). If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-CalendarEvents.md b/exchange/exchange-ps/ExchangePowerShell/Remove-CalendarEvents.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-CalendarEvents.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-CalendarEvents.md index c199b24fec..bee5da9ccb 100644 --- a/exchange/exchange-ps/exchange/Remove-CalendarEvents.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-CalendarEvents.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-calendarevents -applicable: Exchange Server 2019, Exchange Online -title: Remove-CalendarEvents -schema: 2.0.0 +applicable: Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-calendarevents +schema: 2.0.0 +title: Remove-CalendarEvents --- # Remove-CalendarEvents ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-CalendarEvents cmdlet to cancel future meetings in user or resource mailboxes. Cancelling future meetings removes them from attendee and resource calendars (for example, you're going to remove the mailbox, or the user is going on a leave of absence). @@ -34,7 +35,7 @@ Remove-CalendarEvents [-Identity] -QueryWindowInDays Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -79,7 +83,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -QueryWindowInDays + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online + The QueryWindowInDays parameter specifies the number of days after the QueryStartDate parameter value to look for meetings that you want to cancel. If an instance of a recurring meeting occurs during the specified time period, the entire series is cancelled (not just the instances during the time period). @@ -99,7 +105,6 @@ If an instance of a recurring meeting occurs during the specified time period, t Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: True Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -CancelOrganizedMeetings + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online + The CancelOrganizedMeetings switch specifies whether to cancel meetings in the mailbox. You don't need to specify a value with this switch. To cancel meetings in the mailbox, you need to use this switch. @@ -117,7 +125,6 @@ To cancel meetings in the mailbox, you need to use this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -136,7 +146,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -PreviewOnly + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online + The PreviewOnly switch specifies whether to preview the results of the command without actually cancelling any meetings. You don't need to specify a value with this switch. You use this switch with the Verbose switch. @@ -154,7 +166,6 @@ You use this switch with the Verbose switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,6 +175,9 @@ Accept wildcard characters: False ``` ### -QueryStartDate + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -176,7 +190,6 @@ You use the QueryWindowInDays parameter to specify the end date. Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +199,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -194,7 +210,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -204,13 +219,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online + 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, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldPolicy.md index 0a3fbdb087..57e20b4c41 100644 --- a/exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-caseholdpolicy applicable: Security & Compliance -title: Remove-CaseHoldPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-caseholdpolicy +schema: 2.0.0 +title: Remove-CaseHoldPolicy --- # Remove-CaseHoldPolicy @@ -45,6 +46,9 @@ This example removes the case hold policy named "Regulation 123 Compliance". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold policy to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the case hold policy to remove. You can use any Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-CaseHoldRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldRule.md index cb7f9417bd..b5478bff5e 100644 --- a/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-caseholdrule applicable: Security & Compliance -title: Remove-CaseHoldRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-caseholdrule +schema: 2.0.0 +title: Remove-CaseHoldRule --- # Remove-CaseHoldRule @@ -45,6 +46,9 @@ This example removes the case hold rule named "One Year Standard". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold rule to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the case hold rule to remove. You can use any v Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ClassificationRuleCollection.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ClassificationRuleCollection.md index 9e0c0ef4af..0ff6b967a2 100644 --- a/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ClassificationRuleCollection.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-classificationrulecollection -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-ClassificationRuleCollection -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-classificationrulecollection +schema: 2.0.0 +title: Remove-ClassificationRuleCollection --- # Remove-ClassificationRuleCollection ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-ClassificationRuleCollection to remove classification rule collections from your organization. @@ -31,7 +32,7 @@ Remove-ClassificationRuleCollection [-Identity] Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the classification rule collection you want to remove. You can use any value that uniquely identifies the classification rule collection. For example, you can specify the name, rule collection name or distinguished name (DN) of the classification rule collection. ```yaml Type: ClassificationRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -88,7 +96,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ClientAccessArray.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessArray.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-ClientAccessArray.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessArray.md index 24930a04a7..5f4132e715 100644 --- a/exchange/exchange-ps/exchange/Remove-ClientAccessArray.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessArray.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-clientaccessarray applicable: Exchange Server 2010 -title: Remove-ClientAccessArray -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-clientaccessarray +schema: 2.0.0 +title: Remove-ClientAccessArray --- # Remove-ClientAccessArray @@ -29,7 +30,7 @@ Remove-ClientAccessArray [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example removes the existing Client Access array with the FQDN value casarr ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Client Access array that you want to remove. You can use these values: - Name (if the value doesn't contain spaces) @@ -55,7 +59,6 @@ The Identity parameter specifies the Client Access array that you want to remove Type: ClientAccessArrayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessRule.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-ClientAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessRule.md index df3b17ddf9..834cc6b4ad 100644 --- a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-clientaccessrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-ClientAccessRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-clientaccessrule +schema: 2.0.0 +title: Remove-ClientAccessRule --- # Remove-ClientAccessRule @@ -15,7 +16,7 @@ ms.reviewer: > [!NOTE] > Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). -This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-ClientAccessRule cmdlet to remove client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. @@ -34,7 +35,7 @@ Remove-ClientAccessRule [-Identity] ## DESCRIPTION Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example removes the existing client access rule named "Block Connections fr ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the client access rule that you want to remove. You can use any value that uniquely identifies the client access rule. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the client access rule that you want to remove. Type: ClientAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -95,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceCase.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCase.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-ComplianceCase.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCase.md index a636d54a72..462cc01319 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceCase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancecase applicable: Security & Compliance -title: Remove-ComplianceCase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancecase +schema: 2.0.0 +title: Remove-ComplianceCase --- # Remove-ComplianceCase @@ -43,6 +44,9 @@ This example removes the compliance case named Case 5150 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the compliance case that you want to remove. You can use any value that uniquely identifies the case. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the compliance case that you want to remove. Yo Type: ComplianceCaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -97,13 +104,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCaseMember.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCaseMember.md index 2a22dd2318..dea20c13e0 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCaseMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancecasemember applicable: Security & Compliance -title: Remove-ComplianceCaseMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancecasemember +schema: 2.0.0 +title: Remove-ComplianceCaseMember --- # Remove-ComplianceCaseMember @@ -42,6 +43,9 @@ This example removes Jan Dryml from the eDiscovery case named Case OU812. ## PARAMETERS ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the name of the eDiscovery case that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. @@ -50,7 +54,6 @@ To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Security & Compliance + The Member parameter specifies the user that you want to remove from the eDiscovery case. You can use any value that uniquely identifies the user. For example: - Name @@ -71,7 +77,6 @@ The Member parameter specifies the user that you want to remove from the eDiscov Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -90,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceRetentionEventType.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceRetentionEventType.md index fdca44b480..22edb5ed6a 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceRetentionEventType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-complianceretentioneventtype applicable: Security & Compliance -title: Remove-ComplianceRetentionEventType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-complianceretentioneventtype +schema: 2.0.0 +title: Remove-ComplianceRetentionEventType --- # Remove-ComplianceRetentionEventType @@ -29,7 +30,7 @@ Remove-ComplianceRetentionEventType -Identity ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example remove the retention event type name Fabrikam Project ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention event type that you want to remove. You can use any value that uniquely identifies the retention event type. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the retention event type that you want to remov Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the retention event type. 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 @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearch.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearch.md index 92fdcfc7a7..7c9d9fe70d 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Remove-ComplianceSearch -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancesearch +schema: 2.0.0 +title: Remove-ComplianceSearch --- # Remove-ComplianceSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-ComplianceSearch cmdlet to remove compliance searches from Exchange Server 2016 and from the Microsoft Purview compliance portal. The searches must be stopped or completed. @@ -28,7 +29,7 @@ Remove-ComplianceSearch [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. @@ -46,6 +47,9 @@ This example removes the compliance search named Case 1234 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Identity parameter specifies the compliance search that you want to remove. You can use any value that uniquely identifies the compliance search. For example: @@ -59,7 +63,6 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -96,7 +104,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearchAction.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearchAction.md index 8140168e36..8da7c36b6c 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearchAction.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancesearchaction applicable: Security & Compliance -title: Remove-ComplianceSearchAction -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancesearchaction +schema: 2.0.0 +title: Remove-ComplianceSearchAction --- # Remove-ComplianceSearchAction @@ -42,6 +43,9 @@ This example removes the compliance search action named `Case 1234_Preview`. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the compliance search action that you want to remove. You can use any value that uniquely identifies the compliance search action. For example: - Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"` . For example, `"Case 1234_Preview"`. @@ -51,7 +55,6 @@ The Identity parameter specifies the compliance search action that you want to r Type: ComplianceSearchActionIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSecurityFilter.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSecurityFilter.md index 8b38b2ba8a..c5d810d5e4 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSecurityFilter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancesecurityfilter -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Remove-ComplianceSecurityFilter -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancesecurityfilter +schema: 2.0.0 +title: Remove-ComplianceSecurityFilter --- # Remove-ComplianceSecurityFilter @@ -42,13 +43,15 @@ This example removes the compliance security filter named HR Filter. ## PARAMETERS ### -FilterName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The FilterName parameter specifies the name of the compliance security filter that you want to remove. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceTag.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-ComplianceTag.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceTag.md index 46c293ddf7..58954fa68c 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancetag applicable: Security & Compliance -title: Remove-ComplianceTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancetag +schema: 2.0.0 +title: Remove-ComplianceTag --- # Remove-ComplianceTag @@ -44,6 +45,9 @@ This example removes the label named HR Content. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the label that you want to remove. You can use any value that uniquely identifies the tag. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the label that you want to remove. You can use Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the label. 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 @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ContentFilterPhrase.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ContentFilterPhrase.md index 88836574db..70e9dfa355 100644 --- a/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ContentFilterPhrase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-contentfilterphrase -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ContentFilterPhrase -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-contentfilterphrase +schema: 2.0.0 +title: Remove-ContentFilterPhrase --- # Remove-ContentFilterPhrase @@ -39,7 +40,7 @@ Remove-ContentFilterPhrase [-Phrase ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example removes the custom phrase Free credit report from the list of phras ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies a custom word or phrase to remove. You must enclose the value of the Identity parameter in quotation marks ("). For this command, the Identity parameter performs the same actions as the Phrase parameter. The Identity and Phrase parameters are interchangeable. You can't use the Phrase parameter if the Identity parameter is used. @@ -61,7 +65,6 @@ For this command, the Identity parameter performs the same actions as the Phrase Type: ContentFilterPhraseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -80,7 +86,6 @@ 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 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -98,7 +106,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Phrase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Phrase parameter specifies a custom word or phrase to remove. You must enclose the value of the Phrase parameter in quotation marks ("). For this command, the Phrase parameter performs the same actions as the Identity parameter. The Phrase and Identity parameters are interchangeable. You can't use the Identity parameter if the Phrase parameter is used. @@ -116,7 +126,6 @@ For this command, the Phrase parameter performs the same actions as the Identity Type: ContentFilterPhraseIdParameter Parameter Sets: Phrase Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DataClassification.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DataClassification.md similarity index 77% rename from exchange/exchange-ps/exchange/Remove-DataClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DataClassification.md index c89fd96ca0..18bff51df5 100644 --- a/exchange/exchange-ps/exchange/Remove-DataClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DataClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dataclassification -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-DataClassification -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dataclassification +schema: 2.0.0 +title: Remove-DataClassification --- # Remove-DataClassification @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [Remove-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. +In Exchange Online, this cmdlet is replaced by the [Remove-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the Remove-DataClassification cmdlet to remove data classification rules that use document fingerprints. You can't use this cmdlet to remove built-in data classification rules. @@ -33,7 +34,7 @@ Remove-DataClassification [-Identity] ## DESCRIPTION Classification rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example removes the data classification rule named "Contoso Confidential". ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the data classification rule that you want to remove. You can use any value that uniquely identifies the data classification rule. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the data classification rule that you want to r Type: DataClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroup.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroup.md index 2311d1505f..5438ddd878 100644 --- a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DatabaseAvailabilityGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-databaseavailabilitygroup +schema: 2.0.0 +title: Remove-DatabaseAvailabilityGroup --- # Remove-DatabaseAvailabilityGroup @@ -29,7 +30,7 @@ Remove-DatabaseAvailabilityGroup [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the DAG to be removed. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -68,7 +74,6 @@ 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 Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupNetwork.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupNetwork.md index 2a130fd882..aa5781d103 100644 --- a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupNetwork.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroupnetwork -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DatabaseAvailabilityGroupNetwork -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-databaseavailabilitygroupnetwork +schema: 2.0.0 +title: Remove-DatabaseAvailabilityGroupNetwork --- # Remove-DatabaseAvailabilityGroupNetwork @@ -29,7 +30,7 @@ Remove-DatabaseAvailabilityGroupNetwork [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the network being removed. ```yaml Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -68,7 +74,6 @@ 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 Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupServer.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupServer.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupServer.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupServer.md index dfb283d873..ee1ceedf9a 100644 --- a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroupserver -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DatabaseAvailabilityGroupServer -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-databaseavailabilitygroupserver +schema: 2.0.0 +title: Remove-DatabaseAvailabilityGroupServer --- # Remove-DatabaseAvailabilityGroupServer @@ -31,7 +32,7 @@ Remove-DatabaseAvailabilityGroupServer [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the DAG from which you're removing the server. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxServer parameter specifies the Mailbox server to remove from the DAG. You can use any value that uniquely identifies the server. For example: - Name @@ -79,7 +85,6 @@ The MailboxServer parameter specifies the Mailbox server to remove from the DAG. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 2 @@ -89,17 +94,19 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigurationOnly switch remove the Mailbox server from the DAG object in Active Directory. You don't need to specify a value with this switch. If the Mailbox server is offline but the DAG has quorum, the Mailbox server is evicted from the DAG's cluster and removed from the DAG object in Active Directory. -You should use this switch only if the Mailbox server has been lost and can no longer be contacted, or in situations when the Mailbox server can't be restored to operational service before the messaging service is needed. +You should use this switch only if the Mailbox server is lost and can no longer be contacted, or in situations when the Mailbox server can't be restored to operational service before the messaging service is needed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -118,7 +128,6 @@ 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 Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +155,15 @@ Accept wildcard characters: False ``` ### -SkipDagValidation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when removing members from the DAG. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,13 +173,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DeliveryAgentConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeliveryAgentConnector.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-DeliveryAgentConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeliveryAgentConnector.md index ff7ae195fd..3194730264 100644 --- a/exchange/exchange-ps/exchange/Remove-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeliveryAgentConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-deliveryagentconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DeliveryAgentConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-deliveryagentconnector +schema: 2.0.0 +title: Remove-DeliveryAgentConnector --- # Remove-DeliveryAgentConnector @@ -31,7 +32,7 @@ Remove-DeliveryAgentConnector [-Identity] ## DESCRIPTION Delivery agent connectors are used to route messages addressed to foreign systems that don't use the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://learn.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example removes the delivery agent connector named Contoso Delivery Agent C ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the GUID or name of the delivery agent connector. ```yaml Type: DeliveryAgentConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -70,7 +76,6 @@ 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 Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -88,7 +96,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessPolicy.md index 12423d67fd..cc5f2d8775 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccesspolicy applicable: Security & Compliance -title: Remove-DeviceConditionalAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-deviceconditionalaccesspolicy +schema: 2.0.0 +title: Remove-DeviceConditionalAccessPolicy --- # Remove-DeviceConditionalAccessPolicy @@ -51,6 +52,9 @@ This example removes the mobile device conditional access policy named Human Res ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device conditional access policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the mobile device conditional access policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessRule.md index 08e72f3b32..8721d2db9c 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccessrule applicable: Security & Compliance -title: Remove-DeviceConditionalAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-deviceconditionalaccessrule +schema: 2.0.0 +title: Remove-DeviceConditionalAccessRule --- # Remove-DeviceConditionalAccessRule @@ -51,13 +52,15 @@ This example removes the mobile device conditional access rule named Secure Emai ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device conditional access rule that you want to view. The name of the rule uses the syntax `{}`. For example, `Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}`. You can find the name value by running the command: Get-DeviceConditionalAccessRule | Format-List Name. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationPolicy.md index 913547d5a2..ba392b693a 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconfigurationpolicy applicable: Security & Compliance -title: Remove-DeviceConfigurationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-deviceconfigurationpolicy +schema: 2.0.0 +title: Remove-DeviceConfigurationPolicy --- # Remove-DeviceConfigurationPolicy @@ -51,6 +52,9 @@ This example removes the mobile device configuration policy named Engineering Gr ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device configuration policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the mobile device configuration policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationRule.md index d3ab49229c..b412b6f044 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconfigurationrule applicable: Security & Compliance -title: Remove-DeviceConfigurationRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-deviceconfigurationrule +schema: 2.0.0 +title: Remove-DeviceConfigurationRule --- # Remove-DeviceConfigurationRule @@ -51,13 +52,15 @@ This example removes the mobile device configuration rule named Legal Team{58b50 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device configuration rule that you want to view. The name of the rule uses the syntax `{}`. For example, `Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}`. You can find the name values by running the command: Get-DeviceConfigurationRule | Format-List Name. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantPolicy.md index 919b43271d..f736b9a2f7 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-devicetenantpolicy applicable: Security & Compliance -title: Remove-DeviceTenantPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-devicetenantpolicy +schema: 2.0.0 +title: Remove-DeviceTenantPolicy --- # Remove-DeviceTenantPolicy @@ -50,13 +51,15 @@ This example removes your organization's mobile device tenant policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the mobile device tenant policy that you want to remove, but there's only one in your organization. The name of the policy is a GUID value. For example, a6958701-c82c-4064-ac11-64e40e7f4032. You can find this value by running the command: `Get-DeviceTenantPolicy | Format-List Name`. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantRule.md similarity index 96% rename from exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantRule.md index 0fe5232d12..bf650c0eed 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-devicetenantrule applicable: Security & Compliance -title: Remove-DeviceTenantRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-devicetenantrule +schema: 2.0.0 +title: Remove-DeviceTenantRule --- # Remove-DeviceTenantRule @@ -51,13 +52,15 @@ This example removes the mobile device tenant rule from your organization. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the mobile device tenant rule that you want to remove, but there's only one in your organization. The name of the rule is a GUID. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. You can find the name value by running the command `Get-DeviceTenantRule | Format-List Name`. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroup.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroup.md index b35ddb9a2a..383997a66e 100644 --- a/exchange/exchange-ps/exchange/Remove-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-distributiongroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-DistributionGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-distributiongroup +schema: 2.0.0 +title: Remove-DistributionGroup --- # Remove-DistributionGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-DistributionGroup cmdlet to remove distribution groups and mail-enabled security groups. @@ -31,7 +32,7 @@ Remove-DistributionGroup [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example removes the distribution group named Temporary Staff. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group that you want to remove. You can use any value that uniquely identifies the group. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -79,7 +85,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -98,7 +106,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -139,7 +151,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroupMember.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroupMember.md index 0f323c30da..48f4e68cfb 100644 --- a/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroupMember.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-distributiongroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-DistributionGroupMember -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-distributiongroupmember +schema: 2.0.0 +title: Remove-DistributionGroupMember --- # Remove-DistributionGroupMember ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-DistributionGroupMember cmdlet to remove a single member from distribution groups or mail-enabled security groups. To replace all members, use the Update-DistributionGroupMember cmdlet. @@ -33,7 +34,7 @@ Remove-DistributionGroupMember [-Identity] ## DESCRIPTION You can't use the Remove-DistributionGroupMember cmdlet to remove the member of a dynamic distribution group. A dynamic distribution group's membership is calculated from query results. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example removes Jan Dryml from the distribution group named Technical Suppo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -81,7 +87,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -100,7 +108,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -118,7 +128,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Member parameter specifies the recipient that you want to remove from the group. You can use any value that uniquely identifies the recipient. For example: - Name @@ -141,7 +153,6 @@ The Member parameter specifies the recipient that you want to remove from the gr Type: GeneralRecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpCompliancePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpCompliancePolicy.md index 86f93677d8..02a2668fed 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpcompliancepolicy applicable: Security & Compliance -title: Remove-DlpCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpcompliancepolicy +schema: 2.0.0 +title: Remove-DlpCompliancePolicy --- # Remove-DlpCompliancePolicy @@ -49,6 +50,9 @@ This example removes a DLP policy specified by its name. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the DLP policy that you want to remove. You can Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpComplianceRule.md index cbbfa8b856..a615ba84e4 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpcompliancerule applicable: Security & Compliance -title: Remove-DlpComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpcompliancerule +schema: 2.0.0 +title: Remove-DlpComplianceRule --- # Remove-DlpComplianceRule @@ -42,6 +43,9 @@ This example removes the DLP rule named "PII SS# Custom". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the DLP rule that you want to remove. You can u Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpEdmSchema.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpEdmSchema.md index f32281feb1..3cca43e30a 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpEdmSchema.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpedmschema applicable: Security & Compliance -title: Remove-DlpEdmSchema -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpedmschema +schema: 2.0.0 +title: Remove-DlpEdmSchema --- # Remove-DlpEdmSchema @@ -42,6 +43,9 @@ This example removes the DLP EDM schema named Schema for Patient Records. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP EDM schema that you want to remove. You can use any value that uniquely identifies the schema. For example: - Name @@ -51,7 +55,6 @@ The Identity parameter specifies the DLP EDM schema that you want to remove. You Type: EdmStorageIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpKeywordDictionary.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpKeywordDictionary.md index 9497d5484f..2704bf769c 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpKeywordDictionary.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpkeyworddictionary applicable: Security & Compliance -title: Remove-DlpKeywordDictionary -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpkeyworddictionary +schema: 2.0.0 +title: Remove-DlpKeywordDictionary --- # Remove-DlpKeywordDictionary @@ -49,13 +50,15 @@ This example removes all the DLP keyword dictionaries with a Confirm on each rem ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the DLP keyword dictionary that you want to remove. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: SensitiveInformationTypeIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicy.md similarity index 75% rename from exchange/exchange-ps/exchange/Remove-DlpPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicy.md index e7591b41e1..95997ba529 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlppolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-DlpPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlppolicy +schema: 2.0.0 +title: Remove-DlpPolicy --- # Remove-DlpPolicy ## SYNOPSIS -**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. +**Note**: This cmdlet is 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. This cmdlet is functional only in on-premises Exchange. @@ -31,7 +32,7 @@ Remove-DlpPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example removes the existing DLP policy named Contoso PII. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the DLP policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the DLP policy that you want to remove. You can Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicyTemplate.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicyTemplate.md index 6ec3166bac..dad0fa5c40 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicyTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlppolicytemplate -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DlpPolicyTemplate -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlppolicytemplate +schema: 2.0.0 +title: Remove-DlpPolicyTemplate --- # Remove-DlpPolicyTemplate @@ -29,7 +30,7 @@ Remove-DlpPolicyTemplate [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example removes the DLP policy template named External DLP Policy Template. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the DLP policy template you want to remove. You can use any value that uniquely identifies the DLP policy template. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy template. ```yaml Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -68,7 +74,6 @@ 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 Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationType.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationType.md index 248e930c45..309c5e9e1a 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype applicable: Security & Compliance -title: Remove-DlpSensitiveInformationType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtype +schema: 2.0.0 +title: Remove-DlpSensitiveInformationType --- # Remove-DlpSensitiveInformationType @@ -46,6 +47,9 @@ This example removes the sensitive information type rule named "Contoso Confiden ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitive information type rule that you want to remove. You can use any value that uniquely identifies the sensitive information type rule. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the sensitive information type rule that you wa Type: DataClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationTypeRulePackage.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationTypeRulePackage.md index dcf39f5bd5..1bc9fb2d59 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationTypeRulePackage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage applicable: Security & Compliance -title: Remove-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtyperulepackage +schema: 2.0.0 +title: Remove-DlpSensitiveInformationTypeRulePackage --- # Remove-DlpSensitiveInformationTypeRulePackage @@ -41,11 +42,14 @@ $Rule = Get-DlpSensitiveInformationTypeRulePackage -Identity "Contoso Rule Pack" $Rule | Remove-DlpSensitiveInformationTypeRulePackage ``` -This example removes the third-party sensitive information type rule package named Contoso Rule Pack. The first command stores the identity of the rule package in a variable. The second command pipes the variable to the Remove-DlpSensitiveInformationTypeRulePackage cmdlet. +This example removes the non-Microsoft sensitive information type rule package named Contoso Rule Pack. The first command stores the identity of the rule package in a variable. The second command pipes the variable to the Remove-DlpSensitiveInformationTypeRulePackage cmdlet. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitive information type rule package that you want to remove. You can use any value that uniquely identifies the rule package. For example: - RuleCollectionName @@ -56,7 +60,6 @@ The Identity parameter specifies the sensitive information type rule package tha Type: SensitiveInformationTypeRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-DynamicDistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DynamicDistributionGroup.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-DynamicDistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DynamicDistributionGroup.md index 3c76cd90a3..d39e9ff8ea 100644 --- a/exchange/exchange-ps/exchange/Remove-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DynamicDistributionGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dynamicdistributiongroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-DynamicDistributionGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dynamicdistributiongroup +schema: 2.0.0 +title: Remove-DynamicDistributionGroup --- # Remove-DynamicDistributionGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-DynamicDistributionGroup cmdlet to delete dynamic distribution groups. @@ -30,7 +31,7 @@ Remove-DynamicDistributionGroup [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example deletes the dynamic distribution group named Test Users. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the dynamic distribution group that you want to remove. You can use any value that uniquely identifies the dynamic distribution group. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the dynamic distribution group that you want to Type: DynamicGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -76,7 +82,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -117,7 +127,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-EOPProtectionPolicyRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-EOPProtectionPolicyRule.md index ba11d899b1..5c64c8e9df 100644 --- a/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: Remove-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-eopprotectionpolicyrule +schema: 2.0.0 +title: Remove-EOPProtectionPolicyRule --- # Remove-EOPProtectionPolicyRule @@ -14,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Remove-EOPProtectionPolicyRule cmdlet to remove rules from Exchange Online Protection (EOP) protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. +Use the Remove-EOPProtectionPolicyRule cmdlet to remove rules for default email protections for all cloud mailboxes in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. -**Note**: Use this cmdlet to remove a rule only if you plan to immediately recreate the rule using the New-EOPProtectionPolicyRule cmdlet. The affected preset security policy won't function without a corresponding rule. +**Note**: Use this cmdlet to remove a rule only if you plan to immediately recreate the rule using the New-EOPProtectionPolicyRule cmdlet. The affected preset security policy can't function without a corresponding rule. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -32,7 +33,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example removes the existing rule for EOP protections in the Standard prese ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-EcpVirtualDirectory.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-EcpVirtualDirectory.md index 07f4762142..675fe966a7 100644 --- a/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-EcpVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ecpvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-EcpVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ecpvirtualdirectory +schema: 2.0.0 +title: Remove-EcpVirtualDirectory --- # Remove-EcpVirtualDirectory @@ -31,7 +32,7 @@ Remove-EcpVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example removes the ECP virtual directory named ecp located on the default ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the ECP virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -59,7 +63,6 @@ Remote removal of an ECP virtual directory isn't supported. You need run this co Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -78,7 +84,6 @@ 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 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md b/exchange/exchange-ps/ExchangePowerShell/Remove-EdgeSubscription.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-EdgeSubscription.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-EdgeSubscription.md index e792a7e0b9..be87832098 100644 --- a/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-EdgeSubscription.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-edgesubscription -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-EdgeSubscription -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-edgesubscription +schema: 2.0.0 +title: Remove-EdgeSubscription --- # Remove-EdgeSubscription @@ -37,7 +38,7 @@ When you remove an Edge Subscription, the following changes are made: - The Edge Transport server is removed from the list of source servers for any Send connector. - If the Edge Transport server is the only source server for any Send connector, the Send connector is removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,13 +52,15 @@ This example removes Edge Subscription for the Edge Transport server named Edge1 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the Edge Transport server for which you want to remove Edge Subscription. The identity is expressed as the host name of the Edge Transport server. ```yaml Type: TransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -76,7 +82,6 @@ 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 Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -94,7 +102,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,15 +111,17 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -If you don't use this switch, the command will inform you that the removal of the replicated recipient data from AD LDS can take a long time and will give you the option to cancel the operation. +If you don't use this switch, the command informs you that the removal of the replicated recipient data from AD LDS can take a long time and gives you the option to cancel the operation. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-EmailAddressPolicy.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-EmailAddressPolicy.md index 8389a40fd5..6c2632e510 100644 --- a/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-EmailAddressPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-emailaddresspolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-EmailAddressPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-emailaddresspolicy +schema: 2.0.0 +title: Remove-EmailAddressPolicy --- # Remove-EmailAddressPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-EmailAddressPolicy cmdlet to remove existing email address policies and update the affected recipients. In Exchange Online, email address policies are available only for Microsoft 365 Groups. @@ -29,7 +30,7 @@ Remove-EmailAddressPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example removes the email address policy named Southwest Executives. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the email address policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the email address policy that you want to remov Type: EmailAddressPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -90,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ExchangeCertificate.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ExchangeCertificate.md index e6a35f7f1c..d0baf2ebd7 100644 --- a/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-exchangecertificate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ExchangeCertificate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-exchangecertificate +schema: 2.0.0 +title: Remove-ExchangeCertificate --- # Remove-ExchangeCertificate @@ -46,7 +47,7 @@ There are many factors to consider when you configure certificates for Transport Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). For more information, see [Exchange Server TLS configuration best practices](https://learn.microsoft.com/Exchange/exchange-tls-configuration). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example uses the same settings, but removes the certificate from the server ## PARAMETERS ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Thumbprint parameter specifies the certificate that you want to remove. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. @@ -75,7 +79,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: String Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the certificate that you want to remove. Valid values are: - `ServerNameOrFQDN\Thumbprint` @@ -100,7 +106,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: ExchangeCertificateIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -119,7 +127,6 @@ 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 Required: False Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -137,7 +147,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,6 +156,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -162,7 +174,6 @@ You can't use this parameter with the Identity parameter, but you can use it wit Type: ServerIdParameter Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ExoPhishSimOverrideRule.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ExoPhishSimOverrideRule.md index 57130dbbe8..cca2ee0b20 100644 --- a/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ExoPhishSimOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-exophishsimoverriderule applicable: Exchange Online -title: Remove-ExoPhishSimOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-exophishsimoverriderule +schema: 2.0.0 +title: Remove-ExoPhishSimOverrideRule --- # Remove-ExoPhishSimOverrideRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Remove-ExoPhishSimOverrideRule cmdlet to remove third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +Use the Remove-ExoPhishSimOverrideRule cmdlet to remove non-Microsoft phishing simulation override rules that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -29,7 +30,7 @@ Remove-ExoPhishSimOverrideRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example removes the specified phishing simulation override rule. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + 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 @@ -63,7 +67,6 @@ Use the Get-ExoPhishSimOverrideRule cmdlet to find the values. The rule name syn Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ExoSecOpsOverrideRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ExoSecOpsOverrideRule.md index b127bd5c6f..78b46cde3f 100644 --- a/exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ExoSecOpsOverrideRule.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-exosecopsoverriderule +schema: 2.0.0 +title: Remove-ExoSecOpsOverrideRule --- # Remove-ExoSecOpsOverrideRule @@ -14,7 +15,7 @@ ms.reviewer: ## 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). +Use the Remove-ExoSecOpsOverrideRule cmdlet to remove SecOps mailbox override rules that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -29,7 +30,7 @@ Remove-ExoSecOpsOverrideRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example removes the specified SecOps mailbox override rule. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + 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 @@ -63,7 +67,6 @@ Use the Get-ExoSecOpsMailboxRule cmdlet to find these values. The name of the ru Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AuditConfigurationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FeatureConfiguration.md similarity index 63% rename from exchange/exchange-ps/exchange/New-AuditConfigurationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FeatureConfiguration.md index a12fd702b9..e010be3fb0 100644 --- a/exchange/exchange-ps/exchange/New-AuditConfigurationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FeatureConfiguration.md @@ -1,68 +1,77 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-auditconfigurationpolicy applicable: Security & Compliance -title: New-AuditConfigurationPolicy +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-featureconfiguration schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: +title: Remove-FeatureConfiguration --- -# 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 + +> Applicable: Security & Compliance + +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 ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -72,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,30 +89,16 @@ 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 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Security & Compliance -### -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 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FederatedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FederatedDomain.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-FederatedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FederatedDomain.md index c0cbc63696..e9808471ac 100644 --- a/exchange/exchange-ps/exchange/Remove-FederatedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FederatedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-federateddomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-FederatedDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-federateddomain +schema: 2.0.0 +title: Remove-FederatedDomain --- # Remove-FederatedDomain @@ -36,7 +37,7 @@ Remove-FederatedDomain [[-Identity] ] -DomainName Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainName parameter specifies the federated domain name to be removed from the federated organization identifier. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -91,7 +99,6 @@ 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 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +126,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Force switch specifies whether to suppress warning or confirmation messages when removing a federated domain. You don't need to specify a value with this switch. You can use this switch when the removal of the federated domain from the cloud fails, but the configuration of this domain as a federated domain in Exchange should be removed regardless. @@ -125,7 +137,6 @@ You can use this switch when the removal of the federated domain from the cloud Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FederationTrust.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FederationTrust.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-FederationTrust.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FederationTrust.md index 86132d007a..cc5b1d537f 100644 --- a/exchange/exchange-ps/exchange/Remove-FederationTrust.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FederationTrust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-federationtrust -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-FederationTrust -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-federationtrust +schema: 2.0.0 +title: Remove-FederationTrust --- # Remove-FederationTrust @@ -31,7 +32,7 @@ Remove-FederationTrust [-Identity] ## DESCRIPTION Federation trusts are set up with Microsoft Federation Gateway to enable calendar sharing and free/busy sharing with external Exchange organizations or individuals. The Remove-FederationTrust cmdlet removes a federation trust. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example removes the federation trust Microsoft Federation Gateway. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the federation trust being removed. ```yaml Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -70,7 +76,6 @@ 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 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyAuthority.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyAuthority.md index 6de6ae8679..65133d9e06 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyAuthority.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertyauthority applicable: Security & Compliance -title: Remove-FilePlanPropertyAuthority +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertyauthority schema: 2.0.0 +title: Remove-FilePlanPropertyAuthority --- # Remove-FilePlanPropertyAuthority @@ -40,6 +42,9 @@ This example removes the custom file plan property authority named Contoso Autho ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property authority that you want to remove. You can use any value that uniquely identifies the authority. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property authority that yo Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property authority. 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 @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCategory.md index e5e7d1c7fa..0653a2eb21 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertycategory applicable: Security & Compliance -title: Remove-FilePlanPropertyCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertycategory schema: 2.0.0 +title: Remove-FilePlanPropertyCategory --- # Remove-FilePlanPropertyCategory @@ -40,6 +42,9 @@ This example removes the custom file plan property category named Contoso Catego ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property category that you want to remove. You can use any value that uniquely identifies the category. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property category that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property category. 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 @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCitation.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCitation.md index 70c1f29a20..9f6392cdd1 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCitation.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertycitation applicable: Security & Compliance -title: Remove-FilePlanPropertyCitation +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertycitation schema: 2.0.0 +title: Remove-FilePlanPropertyCitation --- # Remove-FilePlanPropertyCitation @@ -40,6 +42,9 @@ This example removes the custom file plan property citation named Contoso Citati ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property citation that you want to remove. You can use any value that uniquely identifies the citation. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property citation that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property citation. 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 @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyDepartment.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyDepartment.md index 630bbe64a4..db1ba02dff 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyDepartment.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertydepartment applicable: Security & Compliance -title: Remove-FilePlanPropertyDepartment +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertydepartment schema: 2.0.0 +title: Remove-FilePlanPropertyDepartment --- # Remove-FilePlanPropertyDepartment @@ -40,6 +42,9 @@ This example removes the custom file plan property department named Contoso HR. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property department that you want to remove. You can use any value that uniquely identifies the department. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property department that y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property department. 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 @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyReferenceId.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyReferenceId.md index 7548cc4cf3..02bbbaa8f0 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyReferenceId.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertyreferenceid applicable: Security & Compliance -title: Remove-FilePlanPropertyReferenceId +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertyreferenceid schema: 2.0.0 +title: Remove-FilePlanPropertyReferenceId --- # Remove-FilePlanPropertyReferenceId @@ -40,6 +42,9 @@ This example removes the custom file plan property reference ID named Contoso-00 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property reference ID that you want to remove. You can use any value that uniquely identifies the reference ID. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property reference ID that Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property reference ID. 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 @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertySubCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertySubCategory.md index 5e45a1faf5..fdcb06a76b 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertySubCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertysubcategory applicable: Security & Compliance -title: Remove-FilePlanPropertySubCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertysubcategory schema: 2.0.0 +title: Remove-FilePlanPropertySubCategory --- # Remove-FilePlanPropertySubCategory @@ -40,6 +42,9 @@ This example removes the custom file plan property subcategory named US Tax. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property subcategory that you want to movidy. You can use any value that uniquely identifies the subcategory. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property subcategory that Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property subcategory. 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 @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-ForeignConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ForeignConnector.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-ForeignConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ForeignConnector.md index d43ea4b717..96bc0488fc 100644 --- a/exchange/exchange-ps/exchange/Remove-ForeignConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ForeignConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-foreignconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ForeignConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-foreignconnector +schema: 2.0.0 +title: Remove-ForeignConnector --- # Remove-ForeignConnector @@ -31,9 +32,9 @@ Remove-ForeignConnector [-Identity] ## DESCRIPTION The Remove-ForeignConnector cmdlet deletes the object and the configuration information for a Foreign connector. -Although a Foreign connector is configured on a local Mailbox server, if you delete a Foreign connector, you may affect mail flow throughout the organization. +Although a Foreign connector is configured on a local Mailbox server, if you delete a Foreign connector, you might affect mail flow throughout the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example deletes the Foreign connector named Fax Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the GUID or connector name of a specific Foreign connector. You can also include the server name by using the format ServerName\\ConnectorName. ```yaml Type: ForeignConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -90,7 +98,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md b/exchange/exchange-ps/ExchangePowerShell/Remove-GlobalAddressList.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-GlobalAddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-GlobalAddressList.md index 2307a60bef..fa78078f11 100644 --- a/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-GlobalAddressList.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-globaladdresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-GlobalAddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-globaladdresslist +schema: 2.0.0 +title: Remove-GlobalAddressList --- # Remove-GlobalAddressList ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-GlobalAddressList cmdlet to remove an existing global address list (GAL). @@ -31,7 +32,7 @@ Remove-GlobalAddressList [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example removes the GAL named OldGAL. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the global address list that you want to remove. You can use any value that uniquely identifies the GAL. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the global address list that you want to remove Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -74,7 +80,6 @@ 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 Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Remove-GlobalMonitoringOverride.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-GlobalMonitoringOverride.md index 6bdf488dfa..c940398a59 100644 --- a/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-GlobalMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-globalmonitoringoverride -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-GlobalMonitoringOverride -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-globalmonitoringoverride +schema: 2.0.0 +title: Remove-GlobalMonitoringOverride --- # Remove-GlobalMonitoringOverride @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Remove-GlobalMonitoringOverride cmdlet to remove a managed availability global override that has been configured for a probe, monitor or responder. +Use the Remove-GlobalMonitoringOverride cmdlet to remove a managed availability global override that is configured for a probe, monitor or responder. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -31,7 +32,7 @@ Remove-GlobalMonitoringOverride [-Identity] -ItemType Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the monitoring item that was overridden. The value is in the form of HealthSet\\MonitoringItem or HealthSet\\MonitoringItem\\TargetResource. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -ItemType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ItemType parameter specifies the item type that you want to remove. It can be any of the following values: - Probe @@ -78,7 +84,6 @@ The ItemType parameter specifies the item type that you want to remove. It can b Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PropertyName parameter specifies the property for the override you want to remove. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -BuildRange + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -129,7 +141,6 @@ 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 Required: False Position: Named @@ -139,6 +150,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -147,7 +161,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +170,15 @@ Accept wildcard characters: False ``` ### -Roles + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,13 +188,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HoldCompliancePolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HoldCompliancePolicy.md index f4e942a974..242c392d15 100644 --- a/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HoldCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-holdcompliancepolicy applicable: Security & Compliance -title: Remove-HoldCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-holdcompliancepolicy +schema: 2.0.0 +title: Remove-HoldCompliancePolicy --- # Remove-HoldCompliancePolicy @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Remove-HoldCompliancePolicy cmdlet to remove preservation policies from the Microsoft Purview compliance portal. -**Note**: The Remove-HoldCompliancePolicy cmdlet has been replaced by the Remove-RetentionCompliancePolicy cmdlet. If you have scripts that use Remove-HoldCompliancePolicy, update them to use Remove-RetentionCompliancePolicy. +**Note**: The Remove-HoldCompliancePolicy cmdlet is replaced by the Remove-RetentionCompliancePolicy cmdlet. If you have scripts that use Remove-HoldCompliancePolicy, update them to use Remove-RetentionCompliancePolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -47,6 +48,9 @@ This example removes the preservation policy named "Regulation 123 Compliance". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation policy to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the preservation policy to remove. You can use Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HoldComplianceRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HoldComplianceRule.md index 5b0fea9c47..a035716833 100644 --- a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HoldComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-holdcompliancerule applicable: Security & Compliance -title: Remove-HoldComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-holdcompliancerule +schema: 2.0.0 +title: Remove-HoldComplianceRule --- # Remove-HoldComplianceRule @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Remove-HoldComplianceRule cmdlet to remove preservation rules from the Microsoft Purview compliance portal. -**Note**: The Remove-HoldComplianceRule cmdlet has been replaced by the Remove-RetentionComplianceRule cmdlet. If you have scripts that use Remove-HoldComplianceRule, update them to use Remove-RetentionComplianceRule. +**Note**: The Remove-HoldComplianceRule cmdlet is replaced by the Remove-RetentionComplianceRule cmdlet. If you have scripts that use Remove-HoldComplianceRule, update them to use Remove-RetentionComplianceRule. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -47,6 +48,9 @@ This example removes the preservation rule named "One Year Standard". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation rule to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the preservation rule to remove. You can use an Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterPolicy.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterPolicy.md index b94bb23bff..2de6203b68 100644 --- a/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-hostedcontentfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Remove-HostedContentFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-hostedcontentfilterpolicy +schema: 2.0.0 +title: Remove-HostedContentFilterPolicy --- # Remove-HostedContentFilterPolicy @@ -30,7 +31,7 @@ Remove-HostedContentFilterPolicy [-Identity] Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the spam filter policy that you want to remove. Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterRule.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterRule.md index 473b44deb4..1a10fd29d9 100644 --- a/exchange/exchange-ps/exchange/Remove-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection -title: Remove-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-hostedcontentfilterrule +schema: 2.0.0 +title: Remove-HostedContentFilterRule --- # Remove-HostedContentFilterRule @@ -28,7 +29,7 @@ Remove-HostedContentFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example removes the spam filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the spam filter rule that you want to remove. Y Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterPolicy.md index 20e3e3eb7f..0d328a1aaa 100644 --- a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Remove-HostedOutboundSpamFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterpolicy +schema: 2.0.0 +title: Remove-HostedOutboundSpamFilterPolicy --- # Remove-HostedOutboundSpamFilterPolicy @@ -29,7 +30,7 @@ Remove-HostedOutboundSpamFilterPolicy [-Identity] Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter policy you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the outbound spam filter policy you want to rem Type: HostedOutboundSpamFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -71,7 +77,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterRule.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterRule.md index cc89753dc3..928860c35e 100644 --- a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: Remove-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterrule +schema: 2.0.0 +title: Remove-HostedOutboundSpamFilterRule --- # Remove-HostedOutboundSpamFilterRule @@ -28,7 +29,7 @@ Remove-HostedOutboundSpamFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example removes the outbound spam filter rule named Contoso Executives. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the outbound spam filter rule that you want to Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HybridConfiguration.md similarity index 73% rename from exchange/exchange-ps/exchange/Remove-HybridConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HybridConfiguration.md index ed6b8d990c..7d69254dc4 100644 --- a/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HybridConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-hybridconfiguration -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-HybridConfiguration -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-hybridconfiguration +schema: 2.0.0 +title: Remove-HybridConfiguration --- # Remove-HybridConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-HybridConfiguration cmdlet to delete the HybridConfigurationActive Directory object for your on-premises Exchange organization. @@ -28,9 +29,9 @@ Remove-HybridConfiguration [-Confirm] ``` ## DESCRIPTION -Removing a HybridConfiguration object should typically only be performed in circumstances where the hybrid deployment state is corrupt and under the direction of Microsoft Customer Service and Support. After removing the HybridConfiguration object, your existing hybrid deployment configuration settings aren't disabled or removed. However, when the Hybrid Configuration wizard is run again after removing the HybridConfiguration object, the wizard won't have a hybrid configuration reference point for your existing feature settings. As a result, it will automatically create a HybridConfiguration object and record the new hybrid deployment configuration feature values defined in the wizard. The feature settings associated with the hybrid deployment, such as organization relationship or Send and Receive connector parameters, which were configured with the HybridConfiguration object that's removed, aren't removed or modified until the Hybrid Configuration wizard is run again. +Removing a HybridConfiguration object should typically only be performed in circumstances where the hybrid deployment state is corrupt and under the direction of Microsoft Customer Service and Support. After removing the HybridConfiguration object, your existing hybrid deployment configuration settings aren't disabled or removed. However, when the Hybrid Configuration wizard is run again after removing the HybridConfiguration object, the wizard don't have a hybrid configuration reference point for your existing feature settings. As a result, it automatically creates a HybridConfiguration object and record the new hybrid deployment configuration feature values defined in the wizard. The feature settings associated with the hybrid deployment, such as organization relationship or Send and Receive connector parameters, which were configured with the HybridConfiguration object that's removed, aren't removed or modified until the Hybrid Configuration wizard is run again. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example removes the HybridConfiguration object for the hybrid deployment. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -53,7 +57,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -71,7 +77,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListEntry.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListEntry.md index 07022d05d8..2ef113d683 100644 --- a/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipallowlistentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-IPAllowListEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ipallowlistentry +schema: 2.0.0 +title: Remove-IPAllowListEntry --- # Remove-IPAllowListEntry @@ -50,13 +51,15 @@ This example removes the IP address range 192.168.0.0/24 from the IP Allow list. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the integer value of the IP Allow list entry that you want to remove. When you add an entry to the IP Allow list, the Identity value is automatically assigned. To find the Identity value of an IP Allow list entry, use the Get-IPAllowListEntry cmdlet. ```yaml Type: IPListEntryIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -75,7 +81,6 @@ 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 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -100,7 +108,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListProvider.md similarity index 87% rename from exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListProvider.md index 530652a8e2..ee2fc3e4c7 100644 --- a/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipallowlistprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-IPAllowListProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ipallowlistprovider +schema: 2.0.0 +title: Remove-IPAllowListProvider --- # Remove-IPAllowListProvider @@ -43,6 +44,9 @@ This example removes the IP Allow list provider named Contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the IP Allow list provider that you want to remove. You can use any value that uniquely identifies the IP Allow list provider. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the IP Allow list provider that you want to rem Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -90,7 +98,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListEntry.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListEntry.md index 81f9179a23..ced2083df8 100644 --- a/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListEntry.md @@ -1,15 +1,16 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipblocklistentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-IPBlockListEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ipblocklistentry +schema: 2.0.0 +title: Remove-IPBlockListEntry --- -# Remove-IPBlocklistEntry +# Remove-IPBlockListEntry ## SYNOPSIS This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. @@ -21,7 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Remove-IPBlocklistEntry [-Identity] +Remove-IPBlockListEntry [-Identity] [-Confirm] [-Server ] [-WhatIf] @@ -50,13 +51,15 @@ This example removes the IP address range 192.168.0.0/24 from the IP Block list. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the integer value of the IP Block list entry that you want to remove. When you add an entry to the IP Block list, the Identity value is automatically assigned. To find the Identity value of an IP Block list entry, use the Get-IPBlockListEntry cmdlet. ```yaml Type: IPListEntryIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -75,7 +81,6 @@ 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 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -100,7 +108,6 @@ You can't use this command to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListProvider.md similarity index 87% rename from exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListProvider.md index 27e5a41a87..b8322e65f5 100644 --- a/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipblocklistprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-IPBlockListProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ipblocklistprovider +schema: 2.0.0 +title: Remove-IPBlockListProvider --- # Remove-IPBlockListProvider @@ -43,6 +44,9 @@ This example removes the IP Block list provider named Contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the IP Block list provider that you want to remove. You can use any value that uniquely identifies the IP Block list provider. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the IP Block list provider that you want to rem Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -90,7 +98,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-InboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-InboundConnector.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-InboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-InboundConnector.md index 643afa3df0..b75c6d0852 100644 --- a/exchange/exchange-ps/exchange/Remove-InboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-InboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-inboundconnector applicable: Exchange Online, Exchange Online Protection -title: Remove-InboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-inboundconnector +schema: 2.0.0 +title: Remove-InboundConnector --- # Remove-InboundConnector @@ -30,7 +31,7 @@ Remove-InboundConnector [-Identity] ## DESCRIPTION Inbound connectors accept email messages from remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example deletes the Inbound connector named Contoso Inbound Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Inbound connector you want to remove. ```yaml Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-InboxRule.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-InboxRule.md index 78a9af6e7b..7045da5bf1 100644 --- a/exchange/exchange-ps/exchange/Remove-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-InboxRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-inboxrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-InboxRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-inboxrule +schema: 2.0.0 +title: Remove-InboxRule --- # Remove-InboxRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-InboxRule cmdlet to remove an Inbox rule. @@ -34,7 +35,7 @@ Remove-InboxRule [-Identity] ## DESCRIPTION When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example removes all Inbox rules from the mailbox Joe@Contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Inbox rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the Inbox rule that you want to remove. You can Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -101,7 +109,6 @@ 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 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -119,7 +129,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,15 +138,17 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. +A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules are removed by the actions of this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -147,6 +158,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -164,7 +178,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-InformationBarrierPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-InformationBarrierPolicy.md index daac4a22b1..f8a2f0c819 100644 --- a/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-InformationBarrierPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-informationbarrierpolicy applicable: Security & Compliance -title: Remove-InformationBarrierPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-informationbarrierpolicy +schema: 2.0.0 +title: Remove-InformationBarrierPolicy --- # Remove-InformationBarrierPolicy @@ -45,6 +46,9 @@ This example removes the information barrier policy named HR-Sales. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the information barrier policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the information barrier policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the information barrier policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -128,4 +137,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-IntraOrganizationConnector.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-IntraOrganizationConnector.md index 6f4cb23daa..c46d33b773 100644 --- a/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-IntraOrganizationConnector.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-intraorganizationconnector -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-IntraOrganizationConnector -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-intraorganizationconnector +schema: 2.0.0 +title: Remove-IntraOrganizationConnector --- # Remove-IntraOrganizationConnector ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-IntraOrganizationConnector cmdlet to remove existing Intra-Organization connectors. @@ -33,7 +34,7 @@ Intra-Organizational connectors enable features and services between divisions i The Remove-IntraOrganizationConnector cmdlet removes the connector objects. To stop feature or service connectivity without removing the connector object, run the command: `Set-IntraOrganizationConnector -Enabled $false`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example removes the existing Intra-Organization connector named "Contoso On ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Intra-Organization connector that you want to remove. You can use any value that uniquely identifies the connector. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the Intra-Organization connector that you want Type: IntraOrganizationConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-JournalRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Remove-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-JournalRule.md index da555a20f0..c5c9c43c0b 100644 --- a/exchange/exchange-ps/exchange/Remove-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-JournalRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-journalrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-JournalRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-journalrule +schema: 2.0.0 +title: Remove-JournalRule --- # Remove-JournalRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-JournalRule cmdlet to remove an existing journal rule. @@ -31,7 +32,7 @@ Remove-JournalRule [-Identity] ## DESCRIPTION The Remove-JournalRule cmdlet removes the specified journal rule from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example removes the journal rule Brokerage Communications that's no longer ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the rule you want to remove. Enter either name or the GUID of the journal rule. You can omit the parameter label. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -70,7 +76,6 @@ 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 Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -88,7 +96,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-Label.md b/exchange/exchange-ps/ExchangePowerShell/Remove-Label.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-Label.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-Label.md index 7b1812a00e..300aa387d9 100644 --- a/exchange/exchange-ps/exchange/Remove-Label.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-Label.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-label applicable: Security & Compliance -title: Remove-Label -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-label +schema: 2.0.0 +title: Remove-Label --- # Remove-Label @@ -42,6 +43,9 @@ This example removes the sensitivity label named Marketing Group. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitivity label that you want to remove. You can use any value that uniquely identifies the label. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the sensitivity label that you want to remove. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-LabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-LabelPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-LabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-LabelPolicy.md index 2289247216..5760314b03 100644 --- a/exchange/exchange-ps/exchange/Remove-LabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-LabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-labelpolicy applicable: Security & Compliance -title: Remove-LabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-labelpolicy +schema: 2.0.0 +title: Remove-LabelPolicy --- # Remove-LabelPolicy @@ -42,6 +43,9 @@ This example removes the policy named Marketing Group. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the policy that you want to remove. You can use Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailContact.md similarity index 77% rename from exchange/exchange-ps/exchange/Remove-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailContact.md index 8a14dbb711..83b6c22e1f 100644 --- a/exchange/exchange-ps/exchange/Remove-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailContact.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailcontact -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-MailContact -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailcontact +schema: 2.0.0 +title: Remove-MailContact --- # Remove-MailContact ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MailContact cmdlet to delete existing mail contacts. @@ -30,7 +31,7 @@ Remove-MailContact [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example removes the mail contact named John. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail contact that you want to remove. You can use any value that uniquely identifies the mail contact. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the mail contact that you want to remove. You c Type: MailContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -76,7 +82,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -117,7 +127,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailUser.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailUser.md index 022d16da1d..27bdf66632 100644 --- a/exchange/exchange-ps/exchange/Remove-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailUser.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailuser -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-MailUser -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailuser +schema: 2.0.0 +title: Remove-MailUser --- # Remove-MailUser ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MailUser cmdlet to remove existing mail users. @@ -32,7 +33,7 @@ Remove-MailUser [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example removes the mail user named Ed Meadows. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail user that you want to remove. You can use any value that uniquely identifies the mail user. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the mail user that you want to remove. You can Type: MailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -78,7 +84,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -96,7 +104,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -119,7 +129,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. @@ -141,7 +153,6 @@ After you disable or remove a mailbox, you can't include it in a discovery searc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -PermanentlyDelete + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PermanentlyDelete switch immediately and permanently deletes (purges) the mail user, which prevents you from recovering or restoring the mail user. You don't need to specify a value with this switch. @@ -164,7 +178,6 @@ The PermanentlyDelete switch immediately and permanently deletes (purges) the ma Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Remove-Mailbox.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-Mailbox.md index 27447b1e7a..a5ec1e6026 100644 --- a/exchange/exchange-ps/exchange/Remove-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-Mailbox.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-Mailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailbox +schema: 2.0.0 +title: Remove-Mailbox --- # Remove-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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-Mailbox cmdlet to delete mailboxes and the associated user accounts. @@ -80,7 +81,7 @@ Use the Identity and Permanent parameters to disconnect the mailbox from the use Use the Disable-Mailbox cmdlet to disconnect the mailbox from the user account, but keep the user account. The mailbox is retained until the deleted mailbox retention period for the database or the mailbox expires, and then the mailbox is permanently deleted (purged). Or, you can immediately purge the disconnected mailbox by using the Database and StoreMailboxIdentity parameters on the Remove-Mailbox cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -105,7 +106,7 @@ $Temp = Get-Mailbox | Where {$_.DisplayName -eq 'John Rodman'} Remove-Mailbox -Database Server01\Database01 -StoreMailboxIdentity $Temp.MailboxGuid ``` -In on-premises Exchange, this example removes John Rodman's mailbox from the mailbox database after the mailbox has been disconnected from the user account. The example uses the Get-Mailbox cmdlet to retrieve the mailbox GUID value of the disconnected mailbox, which is required by the StoreMailboxIdentity parameter. +In on-premises Exchange, this example removes John Rodman's mailbox from the mailbox database after the mailbox is disconnected from the user account. The example uses the Get-Mailbox cmdlet to retrieve the mailbox GUID value of the disconnected mailbox, which is required by the StoreMailboxIdentity parameter. ### Example 4 ```powershell @@ -117,6 +118,9 @@ In Exchange Online, this example removes the specified soft-deleted mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter identifies the mailbox that you want to remove. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -136,7 +140,6 @@ You can't use this parameter with the Database parameter. Type: MailboxIdParameter Parameter Sets: Identity, Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -146,6 +149,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Database parameter specifies the Exchange database that contains the mailbox that you want to remove. You can use any value that uniquely identifies the database. For example: @@ -162,7 +168,6 @@ If you've disconnected a mailbox from its associated user and want to remove the Type: DatabaseIdParameter Parameter Sets: StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -172,6 +177,9 @@ Accept wildcard characters: False ``` ### -StoreMailboxIdentity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The StoreMailboxIdentity parameter specifies the mailbox that you want to remove. When you use this parameter, you identify the mailbox by its MailboxGUID value. You can find the GUID value by using the Get-Mailbox or Get-MailboxStatistics cmdlets. @@ -184,7 +192,6 @@ If you've disconnected a mailbox from its associated user and want to remove the Type: StoreMailboxIdParameter Parameter Sets: StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -194,6 +201,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Arbitration switch is required to remove arbitration mailboxes. You don't need to specify a value with this switch. @@ -206,7 +216,6 @@ To remove arbitration mailboxes that are used to store audit log settings or dat Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -216,6 +225,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuditLog switch is required to remove audit log mailboxes. You don't need to specify a value with this switch. @@ -228,7 +240,6 @@ To remove other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,6 +249,9 @@ Accept wildcard characters: False ``` ### -AuxAuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuxAuditLog switch is required to remove auxiliary audit log mailboxes. You don't need to specify a value with this switch. @@ -250,7 +264,6 @@ To remove other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,6 +273,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -269,7 +285,6 @@ 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 Required: False Position: Named @@ -279,6 +294,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -287,7 +305,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,6 +314,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -305,7 +325,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -315,6 +334,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -328,7 +350,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -338,6 +359,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. @@ -350,7 +374,6 @@ After you disable or remove a mailbox, you can't include it in a discovery searc Type: SwitchParameter Parameter Sets: Identity, StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -360,13 +383,15 @@ Accept wildcard characters: False ``` ### -Migration + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Migration switch is required to remove migration mailboxes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -376,18 +401,20 @@ Accept wildcard characters: False ``` ### -Permanent + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Permanent parameter specifies whether to permanently delete the mailbox from the mailbox database. Valid values are: - $true: The mailbox is immediately and permanently deleted (purged). You can't reconnect or restore the mailbox. -- $false: The mailbox disabled and retained until the deleted mailbox retention period expires. You can reconnect or restore the mailbox until the deleted mailbox retention period expires. This is the default value. +- $false: The mailbox disabled and retained until the deleted mailbox retention period expires. You can reconnect or restore the mailbox until the deleted mailbox retention period expires. This value is the default. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -397,6 +424,9 @@ Accept wildcard characters: False ``` ### -PermanentlyDelete + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PermanentlyDelete switch immediately and permanently deletes (purges) the mailbox, which prevents you from recovering or restoring the mailbox. You don't need to specify a value with this switch. @@ -410,7 +440,6 @@ The PermanentlyDelete switch immediately and permanently deletes (purges) the ma Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -420,6 +449,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublicFolder switch is required to remove public folder mailboxes. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -428,7 +460,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -438,6 +469,9 @@ Accept wildcard characters: False ``` ### -RemoveArbitrationMailboxWithOABsAllowed + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoveArbitrationMailboxWithOABsAllowed switch specifies whether to bypass the checks for offline address books (OABs) within the specified arbitration mailbox that is being removed. You don't need to specify a value with this switch. @@ -448,7 +482,6 @@ When you use this switch, the arbitration mailbox is removed even if OABs are pr Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -458,6 +491,9 @@ Accept wildcard characters: False ``` ### -RemoveCNFPublicFolderMailboxPermanently + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RemoveCNFPublicFolderMailboxPermanently Description }} @@ -466,7 +502,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -476,6 +511,9 @@ Accept wildcard characters: False ``` ### -RemoveLastArbitrationMailboxAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoveLastArbitrationMailboxAllowed switch specifies whether to remove the specified mailbox, even if it's the last arbitration mailbox in the organization. You don't need to specify a value with this switch. @@ -486,7 +524,6 @@ If you remove the last arbitration mailbox in the organization, you can't have u Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -496,6 +533,9 @@ Accept wildcard characters: False ``` ### -SupervisoryReviewPolicy + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -504,7 +544,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: Identity, StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -514,13 +553,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabase.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-MailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabase.md index 3e424e0421..7170bc25ba 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxdatabase -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MailboxDatabase -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxdatabase +schema: 2.0.0 +title: Remove-MailboxDatabase --- # Remove-MailboxDatabase @@ -33,7 +34,7 @@ If the mailbox database has a database copy, the Remove-MailboxDatabase cmdlet a The Remove-MailboxDatabase cmdlet removes only the database object from Active Directory. It doesn't remove the physical database files. You must remove the database files manually after you run the Remove-MailboxDatabase cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example removes the mailbox database MailboxDatabase01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox database that you want to remove. You can use any value that uniquely identifies the database. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the mailbox database that you want to remove. Y Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -76,7 +82,6 @@ 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 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabaseCopy.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabaseCopy.md index 6fd45481ac..50ce155e83 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxdatabasecopy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MailboxDatabaseCopy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxdatabasecopy +schema: 2.0.0 +title: Remove-MailboxDatabaseCopy --- # Remove-MailboxDatabaseCopy @@ -32,11 +33,11 @@ Remove-MailboxDatabaseCopy [-Identity] To use the Remove-MailboxDatabaseCopy cmdlet to remove a mailbox database copy, the following criteria must be met: - The database availability group (DAG) hosting the mailbox database must have quorum and all cluster and network functions must be healthy. -- If you're removing the last passive copy of the database, continuous replication circular logging (CRCL) must not be enabled for the specified mailbox database. If CRCL is enabled, you must first disable it. After the mailbox database copy has been removed, circular logging can be enabled. After enabling circular logging for a non-replicated mailbox database, JET circular logging is used instead of CRCL. If you aren't removing the last passive copy of a database, CRCL can remain enabled. +- If you're removing the last passive copy of the database, continuous replication circular logging (CRCL) must not be enabled for the specified mailbox database. If CRCL is enabled, you must first disable it. After the mailbox database copy is removed, circular logging can be enabled. After enabling circular logging for a non-replicated mailbox database, JET circular logging is used instead of CRCL. If you aren't removing the last passive copy of a database, CRCL can remain enabled. You can't use this cmdlet to remove the active copy of a mailbox database. To remove the active copy of a mailbox database, you must first remove all passive copies of the database and then use the Remove-MailboxDatabase cmdlet to remove the active copy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). Running this cmdlet removes the mailbox database copy configuration, but doesn't delete the database copy's files. If necessary, you can manually delete those files. @@ -52,13 +53,15 @@ This example removes a copy of mailbox database DB1 from the Mailbox server MBX3 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the mailbox database whose copy is being removed. When using this parameter, specify a format of DatabaseName\\ServerName. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -77,7 +83,6 @@ 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 Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxExportRequest.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxExportRequest.md index 6f850b68be..672fbac9b9 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxexportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MailboxExportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxexportrequest +schema: 2.0.0 +title: Remove-MailboxExportRequest --- # Remove-MailboxExportRequest @@ -48,7 +49,7 @@ The parameter set that requires the Identity parameter allows you to remove a fu The parameter set that requires the RequestGuid and RequestQueue parameters is used for Microsoft Exchange Mailbox Replication service (MRS) debugging purposes only. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -76,6 +77,9 @@ This example cancels the export request by using the RequestGuid parameter for a ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). Use the following syntax: `Alias\Name`. You can't use this parameter with the RequestGuid parameter. @@ -84,7 +88,6 @@ You can't use this parameter with the RequestGuid parameter. Type: MailboxExportRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -94,13 +97,15 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestGuid parameter specifies the unique identifier for the export request. To find the export request GUID, use the Get-MailboxExportRequest cmdlet. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter. You can't use this parameter with the Identity parameter. ```yaml Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -122,7 +130,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -141,7 +151,6 @@ 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 Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -175,7 +189,6 @@ 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 Required: False Position: Named @@ -185,13 +198,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxFolderPermission.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxFolderPermission.md index 3dccb1d13c..cf2be3023b 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxFolderPermission.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxFolderPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxfolderpermission +schema: 2.0.0 +title: Remove-MailboxFolderPermission --- # Remove-MailboxFolderPermission ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MailboxFolderPermission cmdlet to remove folder-level permissions for users in mailboxes. @@ -52,7 +53,7 @@ Remove-MailboxFolderPermission [-Identity] [-ResetDel ## DESCRIPTION You can't use this cmdlet to selectively remove permissions from a user on a mailbox folder. The cmdlet removes all permissions that are assigned to the user on the specified folder. To modify the permissions that are assigned to the user on a mailbox folder, use the Set-MailboxFolderPermission cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,11 +69,14 @@ This example removes John's permissions to the Training folder in Kim's mailbox. Remove-MailboxFolderPermission -Identity kim@contoso.com:\Calendar -ResetDelegateUserCollection ``` -This example will clear any corrupted delegate information from Kim's mailbox. +This example clears any corrupted delegate information from Kim's mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the target mailbox and folder. The syntax is `Mailbox:\Folder`. For the value of Mailbox, you can use any value that uniquely identifies the mailbox. For example: - Name @@ -92,7 +96,6 @@ Example values for the Identity parameter are `john@contoso.com:\Calendar` or `J Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. For the best results, we recommend using the following values: @@ -122,7 +128,6 @@ Otherwise, you can use any value that uniquely identifies the user or group. For Type: MailboxFolderUserIdParameter Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -132,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -141,7 +149,6 @@ 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 Required: False Position: Named @@ -151,6 +158,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -159,7 +169,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,6 +178,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -179,7 +191,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity, ResetDelegateUserCollection Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -189,9 +200,12 @@ Accept wildcard characters: False ``` ### -ResetDelegateUserCollection + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. +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 need to grant delegate permissions again using `-SharingPermissionFlag Delegate`. When you use this switch, the value of Identity should be the user's primary calendar folder (for example, `kim@contoso.com:\Calendar`). @@ -199,7 +213,6 @@ When you use this switch, the value of Identity should be the user's primary cal Type: SwitchParameter Parameter Sets: ResetDelegateUserCollection Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,12 +222,15 @@ Accept wildcard characters: False ``` ### -SendNotificationToUser + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SendNotificationToUser parameter specifies whether to send a notification to the user when you remove their calendar permissions. Valid values are: - $true: A notification is sent. -- $false: No notification is sent. This is the default value. +- $false: No notification is sent. This value is the default. This parameter only applies to calendar folders. @@ -222,7 +238,6 @@ This parameter only applies to calendar folders. Type: Boolean Parameter Sets: Identity, ResetDelegateUserCollection Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -232,13 +247,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -264,10 +281,10 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderpermission) -[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxfolderpermission) -[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxIRMAccess.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxIRMAccess.md index 688966ba55..ff233167dc 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxIRMAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxirmaccess applicable: Exchange Online -title: Remove-MailboxIRMAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxirmaccess +schema: 2.0.0 +title: Remove-MailboxIRMAccess --- # Remove-MailboxIRMAccess @@ -29,7 +30,7 @@ Remove-MailboxIRMAccess [-Identity] -User [!NOTE] > This cmdlet works only for delegates who already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example removes the restriction from IRM-protected messages in Lynette's ma ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + **Note**: Delegates that you specify with this parameter must already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). The User parameter specifies the delegate who is no longer blocked from reading IRM-protected messages in the mailbox. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: @@ -89,7 +95,6 @@ The User parameter specifies the delegate who is no longer blocked from reading Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxImportRequest.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxImportRequest.md index e4a36d24de..56619c7c57 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxImportRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboximportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxImportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboximportrequest +schema: 2.0.0 +title: Remove-MailboxImportRequest --- # Remove-MailboxImportRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MailboxImportRequest cmdlet to remove fully or partially completed import requests. Completed import requests aren't automatically cleared. Requests need to be removed by using the Remove-MailboxImportRequest cmdlet. Multiple import requests can exist against the same mailbox if you provide a distinct import request name. @@ -20,7 +21,7 @@ NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst fi This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -Removing a partially completed import request removes the request from the Microsoft Exchange Mailbox Replication service (MRS) job queue. Any import progress that was made until the removal won't be reverted. +Removing a partially completed import request removes the request from the Microsoft Exchange Mailbox Replication service (MRS) job queue. Any import progress made before the removal isn't reverted. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -50,7 +51,7 @@ The parameter set that requires the Identity parameter allows you to remove a fu The parameter set that requires the RequestGuid and RequestQueue parameters is used for MRS debugging purposes only. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,6 +79,9 @@ This example removes all completed import requests. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you created the request using the Name parameter, use the following syntax: `Alias\Name`. You can't use this parameter with the RequestGuid parameter. @@ -86,7 +90,6 @@ You can't use this parameter with the RequestGuid parameter. Type: MailboxImportRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestGuid parameter (together with the RequestQueue parameter) specifies the unique identifier for the import request. To find the import request GUID, use the Get-MailboxImportRequest cmdlet. @@ -106,7 +112,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -130,7 +138,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -149,7 +159,6 @@ 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 Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -167,7 +179,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,6 +188,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -185,7 +199,6 @@ 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, Exchange Online Required: False Position: Named @@ -195,13 +208,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxPermission.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-MailboxPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxPermission.md index b6e76be563..adbba4c33c 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxPermission.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxpermission +schema: 2.0.0 +title: Remove-MailboxPermission --- # Remove-MailboxPermission ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MailboxPermission cmdlet to remove permissions from a user's mailbox or from an Exchange Server 2016, Exchange Server 2019 or Exchange Online mail user. @@ -86,7 +87,7 @@ Remove-MailboxPermission [-Identity] [-ResetDefault] ## DESCRIPTION The Remove-MailboxPermission cmdlet allows you to remove permissions from a user's mailbox, for example, removing full access to another user's mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -107,6 +108,9 @@ In Exchange Online, this example excludes the HR Project mailbox from auto-mappi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox where you are removing permissions. You can use any value that uniquely identifies the mailbox: For example: - Name @@ -124,7 +128,6 @@ The Identity parameter specifies the mailbox where you are removing permissions. Type: MailboxIdParameter Parameter Sets: AccessRights, Owner, ClearAutoMapping, ResetDefault Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -134,6 +137,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AccessRights parameter specifies the permission that you want to remove from the user on the mailbox. Valid values are: - FullAccess @@ -148,9 +154,8 @@ You can specify multiple values separated by commas. ```yaml Type: MailboxRights[] -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -159,33 +164,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxRights[] -Parameter Sets: Instance -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 -``` - -```yaml -Type: MailboxIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Instance -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Instance This parameter is available only in on-premises Exchange. The Instance parameter enables you to pass an entire object to the command to be processed. It's mainly used in scripts where an entire object must be passed to the command. @@ -194,7 +176,6 @@ The Instance parameter enables you to pass an entire object to the command to be Type: MailboxAcePresentationObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -204,6 +185,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The User parameter specifies whose permissions are being removed from the specified mailbox. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -230,9 +214,8 @@ Otherwise, you can use any value that uniquely identifies the user or group. For ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -241,20 +224,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -ClearAutoMapping -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -ClearAutoMapping This parameter is functional only in the cloud-based service. The ClearAutoMapping parameter excludes the mailbox from the auto-mapping feature in Microsoft Outlook. You don't need to specify a value with this switch. @@ -269,7 +242,6 @@ You can't use this switch with the User or AccessRights parameters. Type: SwitchParameter Parameter Sets: ClearAutoMapping Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -279,6 +251,9 @@ Accept wildcard characters: False ``` ### -ResetDefault + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The ResetDefault switch resets the default security descriptor of the mailbox. You don't need to specify a value with this switch. @@ -297,7 +272,6 @@ You can't use this switch with the User for AccessRights parameters. Type: SwitchParameter Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -307,6 +281,9 @@ Accept wildcard characters: False ``` ### -BypassMasterAccountSid + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BypassMasterAccountSid switch suppresses the following error: `Can't remove the access control entry on the object "User" for the user account because the ACE doesn't exist on the object.` You don't need to specify a value with this switch. @@ -317,7 +294,6 @@ Typically, you only need to use this switch in Office 365 Dedicated or ITAR lega Type: SwitchParameter Parameter Sets: AccessRights, Owner, ClearAutoMapping Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -327,6 +303,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -336,7 +315,6 @@ 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 Required: False Position: Named @@ -346,13 +324,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Deny switch specifies that the permissions you're removing are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -362,6 +342,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -370,7 +353,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -380,6 +362,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to remove permissions from a Microsoft 365 Group mailbox. You don't need to specify a value with this switch. @@ -388,7 +373,6 @@ The GroupMailbox switch is required to remove permissions from a Microsoft 365 G Type: SwitchParameter Parameter Sets: AccessRights, Owner, Instance Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -398,6 +382,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -409,7 +396,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -419,6 +405,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InheritanceType parameter specifies whether permissions are inherited to folders within the mailbox. Valid values are: - None @@ -431,7 +420,6 @@ The InheritanceType parameter specifies whether permissions are inherited to fol Type: ActiveDirectorySecurityInheritance Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -441,6 +429,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SoftDeletedMailbox switch is required to remove permissions from a soft-deleted mailbox. You don't need to specify a value with this switch. @@ -451,7 +442,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -461,13 +451,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRepairRequest.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRepairRequest.md index c9037afa2f..59a4597166 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRepairRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxrepairrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MailboxRepairRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxrepairrequest +schema: 2.0.0 +title: Remove-MailboxRepairRequest --- # Remove-MailboxRepairRequest @@ -29,9 +30,9 @@ Remove-MailboxRepairRequest [-Identity] ``` ## DESCRIPTION -You can run the Remove-MailboxRepairRequest cmdlet to remove all mailbox repair requests for a specific database, for a group of related mailbox repair requests, or for a specific mailbox repair request. Mailbox repair requests are identified by a complex GUID with the following format: `DatabaseGuid\RequestGuid\JobGuid`. The DatabaseGuid identifies the mailbox database where the mailbox being repaired is located. The RequestGuid identifies related requests that may contain more than one job if the request runs more than one task or targets more than one mailbox. The JobGuid identifies a unique job. See the examples to remove all requests on a mailbox database, remove a group of related requests that share the same RequestGuid, or remove a specific request by specifying the complete `DatabaseGuid\RequestGuid\JobGuid` value. +You can run the Remove-MailboxRepairRequest cmdlet to remove all mailbox repair requests for a specific database, for a group of related mailbox repair requests, or for a specific mailbox repair request. Mailbox repair requests are identified by a complex GUID with the following format: `DatabaseGuid\RequestGuid\JobGuid`. The DatabaseGuid identifies the mailbox database where the mailbox being repaired is located. The RequestGuid identifies related requests that might contain more than one job if the request runs more than one task or targets more than one mailbox. The JobGuid identifies a unique job. See the examples to remove all requests on a mailbox database, remove a group of related requests that share the same RequestGuid, or remove a specific request by specifying the complete `DatabaseGuid\RequestGuid\JobGuid` value. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,13 +64,15 @@ This example deletes a specific mailbox repair request by specifying the unique ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox repair request to remove. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is `DatabaseGuid\RequestGuid\JobGuid`. Use the Get-MailboxRepairRequest cmdlet to find the identity of a mailbox repair request. ```yaml Type: StoreIntegrityCheckJobIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -88,7 +94,6 @@ 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 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRestoreRequest.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRestoreRequest.md index 96cc00e783..df18d3ae1e 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRestoreRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxrestorerequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxRestoreRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxrestorerequest +schema: 2.0.0 +title: Remove-MailboxRestoreRequest --- # Remove-MailboxRestoreRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MailboxRestoreRequest cmdlet to remove fully or partially completed restore requests. @@ -44,7 +45,7 @@ The parameter set that requires the Identity parameter allows you to remove a fu The parameter set that requires the RequestGuid and RequestQueue parameters is used for Microsoft Exchange Mailbox Replication service (MRS) debugging purposes only. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,6 +73,9 @@ This example cancels the restore request by using the RequestGuid parameter for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated a default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -80,7 +84,6 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: MailboxRestoreRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestGuid parameter specifies the unique identifier for the restore request. To find the GUID, use the Get-MailboxRestoreRequest cmdlet. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter. @@ -100,7 +106,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestQueue parameter specifies the target mailbox database on which the mailbox or archive of the request resides. You can use any value that uniquely identifies the database. For example: @@ -124,7 +132,6 @@ You must use this parameter with the RequestGuid parameter. You can't use this p Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -143,7 +153,6 @@ 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 Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -161,7 +173,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +182,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -179,7 +193,6 @@ 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, Exchange Online Required: False Position: Named @@ -189,13 +202,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxSearch.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxSearch.md index eca5f3db04..74941b143a 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxSearch -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxsearch +schema: 2.0.0 +title: Remove-MailboxSearch --- # Remove-MailboxSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MailboxSearch cmdlet to remove a mailbox search. @@ -33,7 +34,7 @@ Remove-MailboxSearch [-Identity] ## DESCRIPTION In on-premises Exchange, mailbox searches are used for In-Place eDiscovery and In-Place Hold. You can't remove an In-Place Hold without first disabling the hold. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example removes the mailbox search Project Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the mailbox search. ```yaml Type: SearchObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -90,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxUserConfiguration.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxUserConfiguration.md index 723d1efc08..96c9e86507 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxUserConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxuserconfiguration -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxUserConfiguration -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxuserconfiguration +schema: 2.0.0 +title: Remove-MailboxUserConfiguration --- # Remove-MailboxUserConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MailboxUserConfiguration cmdlet to remove user configuration items from mailboxes. Typically, after you delete a user configuration item, it's automatically recreated the next time the user uses that feature in their mailbox. @@ -29,7 +30,7 @@ Remove-MailboxUserConfiguration [-Identity] Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the user configuration item that you want to remove. This parameter uses the syntax MailboxFolder\ItemName: - Valid values for MailboxFolder are folder names (for example, Inbox or Calendar), the value Configuration, or the value Root. Wildcards (\*) aren't supported. @@ -52,7 +56,6 @@ The Identity parameter specifies the user configuration item that you want to re Type: MailboxUserConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the user configuration items you want to remove. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -79,7 +85,6 @@ The Mailbox parameter specifies the mailbox that contains the user configuration Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MalwareFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-MalwareFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterPolicy.md index a5c3c84db4..cde2352cac 100644 --- a/exchange/exchange-ps/exchange/Remove-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-malwarefilterpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-MalwareFilterPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-malwarefilterpolicy +schema: 2.0.0 +title: Remove-MalwareFilterPolicy --- # Remove-MalwareFilterPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MalwareFilterPolicy cmdlet to remove malware filter policies from your organization. @@ -32,7 +33,7 @@ Remove-MalwareFilterPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +47,15 @@ This example removes the malware filter policy named Contoso Malware Filter Poli ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter policy you want to remove. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the malware filter policy. ```yaml Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -89,7 +97,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -109,7 +119,6 @@ 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 Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterRule.md similarity index 77% rename from exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterRule.md index 4171ff3c01..c04a2ceb8f 100644 --- a/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-malwarefilterrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-MalwareFilterRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-malwarefilterrule +schema: 2.0.0 +title: Remove-MalwareFilterRule --- # Remove-MalwareFilterRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MalwareFilterRule cmdlet to remove malware filter rules from your organization. @@ -29,7 +30,7 @@ Remove-MalwareFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example removes the malware filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter rule that you want to remove. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -86,7 +94,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedContentSettings.md similarity index 87% rename from exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagedContentSettings.md index 3ec37d8684..ece20ad599 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedContentSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managedcontentsettings applicable: Exchange Server 2010 -title: Remove-ManagedContentSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managedcontentsettings +schema: 2.0.0 +title: Remove-ManagedContentSettings --- # Remove-ManagedContentSettings @@ -31,7 +32,7 @@ Remove-ManagedContentSettings [-Identity] ## DESCRIPTION When managed content settings are removed from a managed folder, the folder effectively ceases to be a managed folder, and folder contents are no longer under messaging records management (MRM). Removing managed content settings disables any retention and journaling policies for the folder. It doesn't affect whether you can move, delete, or rename the folder, or whether the folder has a quota or policy statement that's displayed in Microsoft Outlook or Microsoft Office Outlook Web App. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example deletes the managed content settings MyManagedContentSettings. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed content settings. ```yaml Type: ELCContentSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagedFolder.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolder.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-ManagedFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolder.md index 7b68957f99..3c1c9a65e9 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagedFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managedfolder applicable: Exchange Server 2010 -title: Remove-ManagedFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managedfolder +schema: 2.0.0 +title: Remove-ManagedFolder --- # Remove-ManagedFolder @@ -31,7 +32,7 @@ Remove-ManagedFolder [-Identity] ## DESCRIPTION The Remove-ManagedFolder cmdlet accepts a managed folder object or a mailbox identity as pipelined input. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example removes the managed folder MyManagedFolder. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder. ```yaml Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolderMailboxPolicy.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolderMailboxPolicy.md index 4cd1f7a86c..67fa7e4aa1 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolderMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managedfoldermailboxpolicy applicable: Exchange Server 2010 -title: Remove-ManagedFolderMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managedfoldermailboxpolicy +schema: 2.0.0 +title: Remove-ManagedFolderMailboxPolicy --- # Remove-ManagedFolderMailboxPolicy @@ -30,9 +31,9 @@ Remove-ManagedFolderMailboxPolicy [-Identity] ``` ## DESCRIPTION -If you remove a managed folder mailbox policy that's applied to users' mailboxes, the affected mailboxes may no longer have retention settings. Therefore, before using this cmdlet to remove a policy, you should determine if the managed folder mailbox policy is applied to any users, and apply another policy to those users. +If you remove a managed folder mailbox policy that's applied to users' mailboxes, the affected mailboxes might no longer have retention settings. Therefore, before using this cmdlet to remove a policy, you should determine if the managed folder mailbox policy is applied to any users, and apply another policy to those users. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +47,15 @@ This example removes the managed folder mailbox policy My Managed Folder Mailbox ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -97,6 +104,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. This switch hides the confirmation prompt when the managed folder mailbox policy that's being removed is assigned to a mailbox user. @@ -105,7 +115,6 @@ This switch hides the confirmation prompt when the managed folder mailbox policy Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRole.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRole.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-ManagementRole.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRole.md index 60ed3913e0..7c272978a2 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRole.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementrole -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-ManagementRole -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managementrole +schema: 2.0.0 +title: Remove-ManagementRole --- # Remove-ManagementRole ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-ManagementRole cmdlet to remove custom management roles that you don't need anymore. @@ -34,7 +35,7 @@ Remove-ManagementRole [-Identity] ## DESCRIPTION You need to remove all the management role assignments from a role before you delete it. If the role is the parent of child roles, the child roles must be removed before you remove the parent role, or you must use the Recurse parameter when you remove the parent role. You can only remove custom roles. Built-in roles, such as the Mail Recipients role, can't be removed. For more information about how to remove a custom role, see [Remove a role](https://learn.microsoft.com/exchange/remove-a-role-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,20 +67,22 @@ This example uses the Get-ManagementRole cmdlet to get a list of roles that cont Remove-ManagementRole "In-house scripts" -UnScopedTopLevel ``` -In on-premises Exchange, this example removes the In-house scripts unscoped top-level management role. Because this is an unscoped top-level role, the UnScopedTopLevel switch must be used. Note that the UnScopedTopLevel switch requires the UnScoped Role Management role, which isn't assigned to any role groups by default. +In on-premises Exchange, this example removes the In-house scripts unscoped top-level management role. Because this is an unscoped top-level role, the UnScopedTopLevel switch must be used. The UnScopedTopLevel switch requires the UnScoped Role Management role, which isn't assigned to any role groups by default. For more information about unscoped top-level management roles, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the custom role to remove. If the name of the role contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -98,7 +104,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -108,6 +113,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -116,7 +124,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -136,7 +146,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -Recurse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Recurse switch removes the specified role and all child roles of the specified role. You don't need to specify a value with this switch. We recommend that you test the command with the WhatIf switch to confirm that the results will be correct. @@ -154,7 +166,6 @@ We recommend that you test the command with the WhatIf switch to confirm that th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -164,6 +175,9 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -176,7 +190,6 @@ Unscoped top-level management roles can only contain custom scripts or non-Excha Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleAssignment.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleAssignment.md index 7540ec48ac..e26f54ba29 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleAssignment.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementroleassignment -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-ManagementRoleAssignment -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managementroleassignment +schema: 2.0.0 +title: Remove-ManagementRoleAssignment --- # Remove-ManagementRoleAssignment ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-ManagementRoleAssignment cmdlet to remove management role assignments. @@ -32,7 +33,7 @@ Remove-ManagementRoleAssignment [-Identity] ## DESCRIPTION When you remove a role assignment, the management role group, management role assignment, user, or universal security group (USG) that was assigned the associated role can no longer access the cmdlets or parameters made available by the role. For more information about management role assignments, see [Understanding management role assignments](https://learn.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ After the list of role assignments to be removed is confirmed, remove the WhatIf ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the role assignment to remove. If the role assignment name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleAssignmentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -80,7 +86,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -118,7 +128,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleEntry.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleEntry.md index a6d8a1d54c..7e6c993a43 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleEntry.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementroleentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-ManagementRoleEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managementroleentry +schema: 2.0.0 +title: Remove-ManagementRoleEntry --- # Remove-ManagementRoleEntry ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-ManagementRoleEntry cmdlet to remove existing management role entries. @@ -34,7 +35,7 @@ The Remove-ManagementRoleEntry cmdlet removes existing role entries. However, yo For more information about management role entries, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example forces you to acknowledge the command before proceeding (we didn't ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the role entry that you want to remove. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). @@ -69,7 +73,6 @@ If the role entry name contains spaces, enclose the name in quotation marks ("). Type: RoleEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -88,7 +94,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -106,7 +114,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -126,7 +136,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagementScope.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementScope.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-ManagementScope.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagementScope.md index ec73842594..cbd3a39ac5 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementScope.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementscope -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-ManagementScope -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managementscope +schema: 2.0.0 +title: Remove-ManagementScope --- # Remove-ManagementScope ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-ManagementScope cmdlet to remove an existing management scope. @@ -32,7 +33,7 @@ Remove-ManagementScope [-Identity] ## DESCRIPTION You can't remove a management scope if it's associated with a management role assignment. Use the Get-ManagementScope cmdlet to retrieve a list of orphaned scopes. For more information about regular and exclusive scopes, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ After you verify that the scopes to be removed are correct, run the command agai ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the scope to remove. You can't remove a scope if it's in use by a management role assignment. ```yaml Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -80,7 +86,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -118,7 +128,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MapiVirtualDirectory.md similarity index 83% rename from exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MapiVirtualDirectory.md index 936faaf305..89601355c0 100644 --- a/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MapiVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mapivirtualdirectory -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MapiVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mapivirtualdirectory +schema: 2.0.0 +title: Remove-MapiVirtualDirectory --- # Remove-MapiVirtualDirectory @@ -29,7 +30,7 @@ Remove-MapiVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example removes the MAPI virtual directory from the local server named Cont ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the MAPI virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -55,7 +59,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -74,7 +80,6 @@ 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 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-Message.md b/exchange/exchange-ps/ExchangePowerShell/Remove-Message.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-Message.md index ecf08727f1..30235da2fe 100644 --- a/exchange/exchange-ps/exchange/Remove-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-message -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-Message -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-message +schema: 2.0.0 +title: Remove-Message --- # Remove-Message @@ -41,7 +42,7 @@ Remove-Message [-Identity] ## DESCRIPTION A message being transmitted to multiple recipients might be located in multiple queues. If you specify an Identity parameter, the message is removed from a single queue if that identity matches only a single message. If the identity matches more than one message, you receive an error. To remove a message from more than one queue in a single operation, you must use the Filter parameter. If you try to remove a message currently being delivered, the message status changes to PendingDelete. Message delivery isn't interrupted, but if the delivery fails and causes the message to re-enter the queue, it's then removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,13 +59,15 @@ This example removes all messages that meet the following criteria without gener ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -82,7 +88,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -101,7 +109,6 @@ 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 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -126,7 +136,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -WithNDR + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WithNDR parameter specifies whether a non-delivery report (NDR) is returned to the sender of a message. The default value is $true. This parameter can be used with both the Identity parameter and Filter parameter sets. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MessageClassification.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MessageClassification.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-MessageClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MessageClassification.md index 430c30d775..02a6b28f61 100644 --- a/exchange/exchange-ps/exchange/Remove-MessageClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MessageClassification.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-messageclassification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MessageClassification -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-messageclassification +schema: 2.0.0 +title: Remove-MessageClassification --- # Remove-MessageClassification ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MessageClassification cmdlet to delete an existing message classification instance from your organization. @@ -29,7 +30,7 @@ Remove-MessageClassification [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example removes the message classification named "My Message Classification ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the message classification that you want to remove. You can use any value that uniquely identifies the message classification. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the message classification that you want to rem Type: MessageClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -92,7 +100,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -130,4 +139,6 @@ To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Ty ### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +## NOTES + ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationBatch.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MigrationBatch.md index 7a3f08fc37..5a7633aaa7 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationBatch.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-migrationbatch -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MigrationBatch -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-migrationbatch +schema: 2.0.0 +title: Remove-MigrationBatch --- # Remove-MigrationBatch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Remove-MigrationBatch cmdlet to delete a migration batch that either isn't running or has been completed. If necessary, you can run the Get-MigrationBatch cmdlet to determine the status of a migration batch before you remove it. +Use the Remove-MigrationBatch cmdlet to delete a migration batch that either isn't running or is completed. If necessary, you can run the Get-MigrationBatch cmdlet to determine the status of a migration batch before you remove it. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -35,7 +36,7 @@ The Remove-MigrationBatch cmdlet removes a migration batch. All subscriptions ar If you use the Force switch with this cmdlet, the individual user requests and subscriptions that were part of the removed migration batch aren't removed. You need to remove the individual migration user requests with the command: `Remove-MigrationUser -Force`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,13 +57,15 @@ This example removes the corrupted migration batch LocalMove1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter identifies the migration batch that you want to remove. The value for this parameter is the name that was specified when the migration batch was created. ```yaml Type: MigrationBatchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -121,7 +131,6 @@ If you use this switch to remove a corrupted migration batch, the individual use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -139,7 +151,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationEndpoint.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MigrationEndpoint.md index 9484d7d7e2..2de85027b8 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationEndpoint.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-migrationendpoint -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MigrationEndpoint -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-migrationendpoint +schema: 2.0.0 +title: Remove-MigrationEndpoint --- # Remove-MigrationEndpoint ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MigrationEndpoint cmdlet to remove existing migration endpoints for source or destination servers for cutover or staged Exchange migrations, IMAP migrations and remote moves. @@ -32,9 +33,9 @@ Remove-MigrationEndpoint [-Identity] ## DESCRIPTION Use the Remove-MigrationEndpoint cmdlet to remove an existing migration endpoint. -For more information about migration endpoints, see [Set-MigrationEndpoint](https://learn.microsoft.com/powershell/module/exchange/set-migrationendpoint) and [New-MigrationEndpoint](https://learn.microsoft.com/powershell/module/exchange/new-migrationendpoint). +For more information about migration endpoints, see [Set-MigrationEndpoint](https://learn.microsoft.com/powershell/module/exchangepowershell/set-migrationendpoint) and [New-MigrationEndpoint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-migrationendpoint). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,13 +49,15 @@ This example removes the migration endpoint CrossForestME01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the migration endpoint you want to remove. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -91,7 +99,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -109,7 +119,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MigrationUser.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationUser.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-MigrationUser.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MigrationUser.md index 61036e2269..38fe6a43eb 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationUser.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-migrationuser -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MigrationUser -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-migrationuser +schema: 2.0.0 +title: Remove-MigrationUser --- # Remove-MigrationUser ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MigrationUser cmdlet to remove a migration user from a batch. @@ -31,7 +32,7 @@ Remove-MigrationUser [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example removes the migration user Tony Smith from a migration batch. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the user that you want to remove from the migration batch. ```yaml Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -88,7 +96,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -108,7 +118,6 @@ Use this switch to work around user or data corruption issues. Specific checks a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -126,7 +138,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -136,13 +147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MobileDevice.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MobileDevice.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-MobileDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MobileDevice.md index dc6843cec8..f4d11ef44f 100644 --- a/exchange/exchange-ps/exchange/Remove-MobileDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MobileDevice.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mobiledevice -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MobileDevice -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mobiledevice +schema: 2.0.0 +title: Remove-MobileDevice --- # Remove-MobileDevice ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MobileDevice cmdlet to remove mobile device partnerships that identify the devices that are configured to synchronize with user mailboxes. @@ -31,7 +32,7 @@ Remove-MobileDevice [-Identity] ## DESCRIPTION The Remove-MobileDevice cmdlet is useful for removing mobile devices that no longer synchronize successfully with the server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example removes the mobile device partnership for the specified device and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mobile device partnership that you want to remove. You can use the following values that uniquely identifies the mobile device: - Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) @@ -62,7 +66,6 @@ The Identity parameter specifies the mobile device partnership that you want to Type: MobileDeviceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MobileDeviceMailboxPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MobileDeviceMailboxPolicy.md index 24f850cef1..c238b63ed8 100644 --- a/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MobileDeviceMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mobiledevicemailboxpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MobileDeviceMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mobiledevicemailboxpolicy +schema: 2.0.0 +title: Remove-MobileDeviceMailboxPolicy --- # Remove-MobileDeviceMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MobileDeviceMailboxPolicy cmdlet to remove mobile device mailbox policies from Exchange servers. @@ -32,7 +33,7 @@ Remove-MobileDeviceMailboxPolicy [-Identity] ## DESCRIPTION A Mobile Device mailbox policy is a group of settings that specifies how mobile phones connect to Exchange. Exchange supports multiple mobile device mailbox policies. The Remove-MobileDeviceMailboxPolicy cmdlet removes a specific mobile device mailbox policy. If any users are assigned to the policy when you remove it, the Remove-MobileDeviceMailboxPolicy cmdlet fails. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +61,9 @@ This example removes the mobile device mailbox policy named Management and bypas ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mobile device mailbox policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the mobile device mailbox policy that you want Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -89,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -107,7 +115,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -125,7 +135,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MoveRequest.md similarity index 83% rename from exchange/exchange-ps/exchange/Remove-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MoveRequest.md index ff8f5e3203..b414be957f 100644 --- a/exchange/exchange-ps/exchange/Remove-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MoveRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-moverequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MoveRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-moverequest +schema: 2.0.0 +title: Remove-MoveRequest --- # Remove-MoveRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-MoveRequest cmdlet to cancel a mailbox move initiated using the New-MoveRequest cmdlet. @@ -48,7 +49,7 @@ In Exchange 2010, you need to use the Remove-MoveRequest cmdlet on completed mov The MoveRequestQueue and MailboxGuid parameters are for debugging purposes only. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,6 +72,9 @@ The MailboxGuid and MoveRequestQueue parameters are for debugging purposes only. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - GUID @@ -87,7 +91,6 @@ You can't use this parameter with the MailboxGuid or MoveRequestQueue parameters Type: MoveRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -MailboxGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MailboxGuid parameter specifies the GUID of the mailbox for which you want to remove the move request. If you specify the MailboxGuid parameter, you must also specify the MoveRequestQueue parameter. @@ -107,7 +113,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -MoveRequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MoveRequestQueue parameter specifies the database on which the move request is queued. You can use any value that uniquely identifies the database. For example: @@ -131,7 +139,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -150,7 +160,6 @@ 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 Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -168,7 +180,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,6 +189,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -186,7 +200,6 @@ 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, Exchange Online Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter specifies the move destination by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -215,7 +231,6 @@ The ProxyToMailbox parameter specifies the move destination by the location of t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -225,13 +240,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OMEConfiguration.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-OMEConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OMEConfiguration.md index 20d726ee54..11da253b2d 100644 --- a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OMEConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-omeconfiguration applicable: Exchange Online -title: Remove-OMEConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-omeconfiguration +schema: 2.0.0 +title: Remove-OMEConfiguration --- # Remove-OMEConfiguration @@ -28,7 +29,7 @@ Remove-OMEConfiguration [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,13 +43,15 @@ This example removes the custom OME configuration named Contoso Marketing. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the custom OME configuration that you want to remove. You can use the Get-OMEConfiguration cmdlet to see the available values. If the value contains spaces, enclose the value in quotation marks ```yaml Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OabVirtualDirectory.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OabVirtualDirectory.md index 24791b7b37..3b6d435a81 100644 --- a/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OabVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-oabvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-OabVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-oabvirtualdirectory +schema: 2.0.0 +title: Remove-OabVirtualDirectory --- # Remove-OabVirtualDirectory @@ -32,7 +33,7 @@ Remove-OabVirtualDirectory [-Identity] ## DESCRIPTION Some situations require the removal of an OAB virtual directory. For example, to uninstall an Exchange server that contains an OAB distribution points list, you need to remove the OAB virtual directory and then re-create it on another server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example removes the default OAB virtual directory from Server1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the OAB virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -65,7 +69,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -84,7 +90,6 @@ 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 Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -118,7 +128,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OfflineAddressBook.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OfflineAddressBook.md index b9d780e4f5..a4eadbf4de 100644 --- a/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OfflineAddressBook.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-offlineaddressbook -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-OfflineAddressBook -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-offlineaddressbook +schema: 2.0.0 +title: Remove-OfflineAddressBook --- # Remove-OfflineAddressBook ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-OfflineAddressBook cmdlet to remove (delete) offline address books (OABs). @@ -34,7 +35,7 @@ Remove-OfflineAddressBook [-Identity] ## DESCRIPTION If you remove the default OAB, you need to configure another OAB as the default by using the IsDefault parameter on the New-OfflineAddressBook or Set-OfflineAddressBook cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example removes the OAB named Contoso Executives. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the OAB that you want to remove. You can use any value that uniquely identifies the OAB. For example: - Name or \\Name @@ -58,7 +62,6 @@ The Identity parameter specifies the OAB that you want to remove. You can use an Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -77,7 +83,6 @@ 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 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -95,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +112,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -113,7 +123,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OnPremisesOrganization.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OnPremisesOrganization.md index a6196d357b..1c96267990 100644 --- a/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OnPremisesOrganization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-onpremisesorganization applicable: Exchange Online -title: Remove-OnPremisesOrganization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-onpremisesorganization +schema: 2.0.0 +title: Remove-OnPremisesOrganization --- # Remove-OnPremisesOrganization @@ -28,9 +29,9 @@ Remove-OnPremisesOrganization [-Identity] ``` ## DESCRIPTION -Removing an OnPremisesOrganization object should only be used in circumstances where the hybrid deployment state is corrupt and under the direction and supervision of Microsoft Customer Service and Support. After removing the OnPremisesOrganization object, any related hybrid deployment configured with this object won't be functional and will need to be re-created and reconfigured. +Removing an OnPremisesOrganization object should only be used in circumstances where the hybrid deployment state is corrupt and under the direction and supervision of Microsoft Customer Service and Support. After removing the OnPremisesOrganization object, any related hybrid deployment configured with this object aren't functional and need to be re-created and reconfigured. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example removes the ExchangeMail OnPremisesOrganization object in a Microso ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - Canonical name @@ -54,7 +58,6 @@ The Identity parameter specifies the identity of the on-premises organization ob Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationRelationship.md similarity index 77% rename from exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationRelationship.md index 0598e9d220..f60fdee79e 100644 --- a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationRelationship.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-OrganizationRelationship -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-organizationrelationship +schema: 2.0.0 +title: Remove-OrganizationRelationship --- # Remove-OrganizationRelationship ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-OrganizationRelationship cmdlet to remove the organization relationship with an external Exchange organization. @@ -31,7 +32,7 @@ Remove-OrganizationRelationship [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the organization relationship that you want to remove. You can use one of the following values: - Canonical name @@ -55,7 +59,6 @@ The Identity parameter specifies the identity of the organization relationship t Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -74,7 +80,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OrganizationSegment.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationSegment.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-OrganizationSegment.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationSegment.md index 0d1f0c04fb..04629a5b84 100644 --- a/exchange/exchange-ps/exchange/Remove-OrganizationSegment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationSegment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-organizationsegment applicable: Security & Compliance -title: Remove-OrganizationSegment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-organizationsegment +schema: 2.0.0 +title: Remove-OrganizationSegment --- # Remove-OrganizationSegment @@ -42,6 +43,9 @@ This example removes the organization segment named Engineering Group. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the organization segment that you want to remove. You can use any value that uniquely identifies the segment. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the organization segment that you want to remov Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -111,4 +118,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Remove-OutboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OutboundConnector.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-OutboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OutboundConnector.md index 7cfabaff38..9a4192bf4c 100644 --- a/exchange/exchange-ps/exchange/Remove-OutboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OutboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-outboundconnector applicable: Exchange Online, Exchange Online Protection -title: Remove-OutboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-outboundconnector +schema: 2.0.0 +title: Remove-OutboundConnector --- # Remove-OutboundConnector @@ -30,7 +31,7 @@ Remove-OutboundConnector [-Identity] ## DESCRIPTION Outbound connectors send email messages to remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example deletes the Outbound connector named Contoso Outbound Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the connector you want to remove. ```yaml Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProtectionRule.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProtectionRule.md index 2fd3e45e05..bb92d3a648 100644 --- a/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-outlookprotectionrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-OutlookProtectionRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-outlookprotectionrule +schema: 2.0.0 +title: Remove-OutlookProtectionRule --- # Remove-OutlookProtectionRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS **Note**: This cmdlet is no longer supported in the cloud-based service. -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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-OutlookProtectionRule cmdlet to remove Outlook protection rules. @@ -33,7 +34,7 @@ Remove-OutlookProtectionRule [-Identity] ## DESCRIPTION Outlook protection rules use an Active Directory Rights Management Services (AD RMS) rights template to automatically apply Information Rights Management (IRM) protection to messages before they're sent. For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,13 +55,15 @@ This example removes all Outlook protection rules from the organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the Outlook protection rule that you want to remove. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -79,7 +85,6 @@ 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 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -97,7 +105,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OutlookProvider.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProvider.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-OutlookProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProvider.md index 1d6410cdd9..7b4a6ee9a5 100644 --- a/exchange/exchange-ps/exchange/Remove-OutlookProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-outlookprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-OutlookProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-outlookprovider +schema: 2.0.0 +title: Remove-OutlookProvider --- # Remove-OutlookProvider @@ -31,7 +32,7 @@ Remove-OutlookProvider [-Identity] ## DESCRIPTION The Remove-OutlookProvider cmdlet deletes the AutoDiscoverConfig object under the Global Settings object in Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example deletes the AutoDiscoverConfig object named Test Object from Active ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the AutoDiscoverConfig object to remove from Active Directory. ```yaml Type: OutlookProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -70,7 +76,6 @@ 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 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OwaMailboxPolicy.md similarity index 76% rename from exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OwaMailboxPolicy.md index 7546c5ba67..af5b2cd99a 100644 --- a/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OwaMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-owamailboxpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-OwaMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-owamailboxpolicy +schema: 2.0.0 +title: Remove-OwaMailboxPolicy --- # Remove-OwaMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-OwaMailboxPolicy cmdlet to remove Outlook on the web mailbox policies from the organization. @@ -30,9 +31,9 @@ Remove-OwaMailboxPolicy [-Identity] ``` ## DESCRIPTION -Changes to Outlook on the web mailbox polices may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). +Changes to Outlook on the web mailbox policies might take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +61,9 @@ This example removes the mailbox policy named Corporate for the tenant Contoso i ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the mailbox policy that you want to remove. You Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -89,7 +95,6 @@ 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 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -107,7 +115,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -125,7 +135,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OwaVirtualDirectory.md similarity index 83% rename from exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OwaVirtualDirectory.md index f97d5d7436..d89f980954 100644 --- a/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OwaVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-owavirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-OwaVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-owavirtualdirectory +schema: 2.0.0 +title: Remove-OwaVirtualDirectory --- # Remove-OwaVirtualDirectory @@ -36,7 +37,7 @@ You might be required to use the Remove-OwaVirtualDirectory cmdlet in the follow Remove-OwaVirtualDirectory permanently removes an Outlook on the web virtual directory or directories. When you use this cmdlet, make sure that you don't accidentally delete the default Outlook on the web virtual directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example removes the specified Outlook on the web virtual directory from the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the OWA virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -62,7 +66,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -81,7 +87,6 @@ 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 Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PartnerApplication.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PartnerApplication.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-PartnerApplication.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PartnerApplication.md index 2eb9caf5e4..edeb804c3f 100644 --- a/exchange/exchange-ps/exchange/Remove-PartnerApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PartnerApplication.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-partnerapplication -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PartnerApplication -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-partnerapplication +schema: 2.0.0 +title: Remove-PartnerApplication --- # Remove-PartnerApplication ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-PartnerApplication cmdlet to remove a partner application configuration. @@ -33,7 +34,7 @@ You can configure partner applications such as Microsoft SharePoint to access Ex We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This command removes the HRApp partner application. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the partner application. ```yaml Type: PartnerApplicationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -90,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PhishSimOverridePolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PhishSimOverridePolicy.md index 590d704a0c..3943fd117f 100644 --- a/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PhishSimOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-phishsimoverridepolicy applicable: Exchange Online -title: Remove-PhishSimOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-phishsimoverridepolicy +schema: 2.0.0 +title: Remove-PhishSimOverridePolicy --- # Remove-PhishSimOverridePolicy @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS 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 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). +Use the Remove-PhishSimOverridePolicy cmdlet to remove non-Microsoft phishing simulation override policies that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -30,7 +31,7 @@ Remove-PhishSimOverridePolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example removes the phishing simulation override policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ Use the Get-PhishSimOverridePolicy cmdlet to find the values. The only available Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Exchange Online + 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 @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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. @@ -126,7 +138,6 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PolicyTipConfig.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PolicyTipConfig.md index 45d9e9b72c..7c5b735090 100644 --- a/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PolicyTipConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-policytipconfig -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PolicyTipConfig -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-policytipconfig +schema: 2.0.0 +title: Remove-PolicyTipConfig --- # Remove-PolicyTipConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-PolicyTipConfig cmdlet to remove custom data loss prevention (DLP) Policy Tips from your organization. You can't remove built-in Policy Tips. @@ -29,7 +30,7 @@ Remove-PolicyTipConfig [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example removes all the custom Russian Policy Tips. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the custom Policy Tip you want to remove. You can use any value that uniquely identifies the custom Policy Tip. For example: - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. @@ -61,7 +65,6 @@ The Identity parameter specifies the custom Policy Tip you want to remove. You c Type: PolicyTipConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PowerShellVirtualDirectory.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PowerShellVirtualDirectory.md index 56801944fd..de97083644 100644 --- a/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PowerShellVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-powershellvirtualdirectory -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-PowerShellVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-powershellvirtualdirectory +schema: 2.0.0 +title: Remove-PowerShellVirtualDirectory --- # Remove-PowerShellVirtualDirectory @@ -31,7 +32,7 @@ Remove-PowerShellVirtualDirectory [-Identity] ## DESCRIPTION Although it's possible to remove a Windows PowerShell virtual directory, we recommend that you only do so at the request of Microsoft Customer Service and Support. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,11 +43,14 @@ Remove-PowerShellVirtualDirectory "Internal (Default Web Site)" -Confirm:$False This example removes a Windows PowerShell virtual directory without confirmation. -Be careful when using the Remove-PowerShellVirtualDirectory cmdlet without confirmation. You won't be prompted before the virtual directory is deleted. +Be careful when using the Remove-PowerShellVirtualDirectory cmdlet without confirmation. You aren't prompted before the virtual directory is deleted. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the PowerShell virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -59,7 +63,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -78,7 +84,6 @@ 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 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ProtectionAlert.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-ProtectionAlert.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ProtectionAlert.md index f4edc74c13..130ac00c79 100644 --- a/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ProtectionAlert.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-protectionalert applicable: Security & Compliance -title: Remove-ProtectionAlert -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-protectionalert +schema: 2.0.0 +title: Remove-ProtectionAlert --- # Remove-ProtectionAlert @@ -43,6 +44,9 @@ This example removes the specified alert policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the alert policy that you want to remove. You can use any value that uniquely identifies the alert policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the alert policy that you want to remove. You c Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the alert policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolder.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-PublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolder.md index 036d6a15da..8dfac0ab45 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PublicFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfolder +schema: 2.0.0 +title: Remove-PublicFolder --- # Remove-PublicFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-PublicFolder cmdlet to remove an existing public folder. @@ -34,7 +35,7 @@ Remove-PublicFolder [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example deletes the public folder Directory Folder and all its child public ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name and path of the public folder you want to remove. A valid value uses the syntax: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. ```yaml Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -80,7 +86,6 @@ 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 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Mailbox Description }} @@ -116,7 +126,6 @@ This parameter is available only in the cloud-based service. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -Recurse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Recurse switch specifies whether all subfolders of the specified folder should also be removed. You don't need to specify a value with this switch. If you don't use this switch and the public folder has subfolders, the command doesn't run and an error message is returned. @@ -134,7 +146,6 @@ If you don't use this switch and the public folder has subfolders, the command d Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -144,6 +155,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -159,7 +173,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -169,13 +182,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderAdministrativePermission.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderAdministrativePermission.md index b1b0afb2e2..8a8bf774bd 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderAdministrativePermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolderadministrativepermission applicable: Exchange Server 2010 -title: Remove-PublicFolderAdministrativePermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfolderadministrativepermission +schema: 2.0.0 +title: Remove-PublicFolderAdministrativePermission --- # Remove-PublicFolderAdministrativePermission @@ -47,7 +48,7 @@ Remove-PublicFolderAdministrativePermission [[-Identity] Applicable: Exchange Server 2010 + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -69,7 +73,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010 + The AccessRights parameter specifies the rights being removed. Valid values include: - None The administrator doesn't have any rights to modify public folder attributes. @@ -96,9 +102,8 @@ You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty -Parameter Sets: Identity +Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -107,40 +112,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MultiValuedProperty -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 +### -Instance -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -Instance The Instance parameter specifies whether to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command. ```yaml Type: PublicFolderAdministrativeAceObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -150,6 +131,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010 + The User parameter specifies whose admin permissions are being removed from the specified public folder. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -171,9 +155,8 @@ You can use any value that uniquely identifies the user or group. For example: ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: Identity +Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -182,20 +165,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -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`. @@ -205,7 +178,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -215,13 +187,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010 + The Deny switch specifies that the permissions you're removing are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -231,13 +205,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -247,6 +223,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010 + The InheritanceType parameter specifies the type of inheritance. Valid values are: - None @@ -259,7 +238,6 @@ The InheritanceType parameter specifies the type of inheritance. Valid values ar Type: ActiveDirectorySecurityInheritance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -269,6 +247,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -282,7 +263,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -292,13 +272,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderClientPermission.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderClientPermission.md index 726354e79b..96e7dc9d38 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderClientPermission.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolderclientpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PublicFolderClientPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfolderclientpermission +schema: 2.0.0 +title: Remove-PublicFolderClientPermission --- # Remove-PublicFolderClientPermission ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-PublicFolderClientPermission cmdlet to remove permissions from public folders. @@ -30,7 +31,7 @@ Remove-PublicFolderClientPermission [-Identity] -Acces ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example removes permission for the user Chris to the public folder My Publi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path by using the format \\TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -59,7 +63,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AccessRights parameter specifies the rights that you want to remove from the user on the public folder. @@ -104,7 +110,6 @@ In addition to the access rights, you can create rights based upon roles, which Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The User parameter specifies the user whose permissions are being removed. For the best results, we recommend using the following values: @@ -125,7 +133,6 @@ For the best results, we recommend using the following values: Type: PublicFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -144,7 +154,6 @@ 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 Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -162,7 +174,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +183,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -187,7 +201,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -197,13 +210,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderDatabase.md similarity index 87% rename from exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderDatabase.md index 1da34f3a54..8f6803762a 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolderdatabase applicable: Exchange Server 2010 -title: Remove-PublicFolderDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfolderdatabase +schema: 2.0.0 +title: Remove-PublicFolderDatabase --- # Remove-PublicFolderDatabase @@ -30,7 +31,7 @@ Remove-PublicFolderDatabase [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). Removing a public folder database can have a broad range of serious consequences. (This is particularly true when removing the last public folder database in the organization.) For more information, see [Remove Public Folder Databases](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd876883(v=exchg.141)). @@ -46,6 +47,9 @@ This example removes the database Public Folder Database after all the prerequis ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the public folder database that you want to remove. You can use any value that uniquely identifies the database. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the public folder database that you want to rem Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -RemoveLastAllowed + +> Applicable: Exchange Server 2010 + The RemoveLastAllowed switch allows the removal of the last public folder database in the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMailboxMigrationRequest.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMailboxMigrationRequest.md index 647e00554d..df99edf198 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMailboxMigrationRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfoldermailboxmigrationrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PublicFolderMailboxMigrationRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfoldermailboxmigrationrequest +schema: 2.0.0 +title: Remove-PublicFolderMailboxMigrationRequest --- # Remove-PublicFolderMailboxMigrationRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-PublicFolderMailboxMigrationRequest cmdlet to remove individual jobs from public folder migration batches that were created by using the New-MigrationBatch cmdlet. @@ -40,7 +41,7 @@ Remove-PublicFolderMailboxMigrationRequest -RequestGuid -RequestQueue Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the public folder mailbox migration request that you want to remove. This value uses the syntax `\PublicFolderMailboxMigration` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). You can't use this parameter with the RequestGuid or RequestQueue parameters. @@ -76,7 +80,6 @@ You can't use this parameter with the RequestGuid or RequestQueue parameters. Type: PublicFolderMailboxMigrationRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestGuid parameter specifies the unique RequestGuid identifier of the request. To find the RequestGuid value, use the Get-PublicFolderMailboxMigrationRequest cmdlet. @@ -96,7 +102,6 @@ If you use this parameter, you also need to use the RequestQueue parameter. You Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -120,7 +128,6 @@ 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 Required: True Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -139,7 +149,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -157,7 +169,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -175,7 +189,6 @@ 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, Exchange Online Required: False Position: Named @@ -185,13 +198,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMigrationRequest.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMigrationRequest.md index c85f9d9a62..374dd15017 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfoldermigrationrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-PublicFolderMigrationRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfoldermigrationrequest +schema: 2.0.0 +title: Remove-PublicFolderMigrationRequest --- # Remove-PublicFolderMigrationRequest @@ -44,7 +45,7 @@ Remove-PublicFolderMigrationRequest -RequestGuid -RequestQueue Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the migration request that you want to remove. You can use the following values: - Name @@ -78,7 +82,6 @@ You can't use this parameter with the RequestGuid or RequestQueue parameters. Type: PublicFolderMigrationRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestGuid parameter identifies the migration request to remove by its RequestGUID value. This parameter also requires the RequestQueue parameter. You can't use this parameter with the Identity parameter. @@ -96,7 +102,6 @@ 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 Required: True Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestQueue parameter identifies the migration request by the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -120,7 +128,6 @@ 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 Required: True Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -139,7 +149,6 @@ 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 Required: False Position: Named @@ -149,13 +158,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,6 +176,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -173,7 +187,6 @@ 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 Required: False Position: Named @@ -183,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMoveRequest.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMoveRequest.md index b32e757add..8627acb82c 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMoveRequest.md @@ -1,20 +1,21 @@ --- -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, Exchange Online -title: Remove-PublicFolderMoveRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfoldermoverequest +schema: 2.0.0 +title: Remove-PublicFolderMoveRequest --- # Remove-PublicFolderMoveRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might 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. +Use the Remove-PublicFolderMoveRequest cmdlet to cancel a mailbox move initiated using the New-MoveRequest cmdlet. After the move is finalized, you can't undo the move request. 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 +43,7 @@ Remove-PublicFolderMoveRequest -RequestGuid -RequestQueue Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the public folder move request. The default identity is \\PublicFolderMove. You can't use this parameter with the RequestGuid or RequestQueue parameter. @@ -73,7 +77,6 @@ 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, Exchange Online Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestGuid parameter specifies the GUID of the public folder move request. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter. You can't use this parameter with the Identity parameter. @@ -91,7 +97,6 @@ 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, Exchange Online Required: True Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -113,7 +121,6 @@ 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, Exchange Online Required: True Position: Named @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -132,7 +142,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -150,7 +162,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -168,7 +182,6 @@ 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, Exchange Online Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-QuarantinePolicy.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-QuarantinePolicy.md index 6c828f12bb..4661faef74 100644 --- a/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-QuarantinePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-quarantinepolicy applicable: Exchange Online, Exchange Online Protection -title: Remove-QuarantinePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-quarantinepolicy +schema: 2.0.0 +title: Remove-QuarantinePolicy --- # Remove-QuarantinePolicy @@ -29,7 +30,7 @@ Remove-QuarantinePolicy [-Identity] ## DESCRIPTION You can't remove the built-in quarantine policies named AdminOnlyAccessPolicy or DefaultFullAccessPolicy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example removes the quarantine policy named Contoso Engineering. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the quarantine policy you want to remove. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the quarantine policy you want to remove. You c Type: QuarantineTagIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ReceiveConnector.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-ReceiveConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ReceiveConnector.md index 16d1194f04..75dbe3dc79 100644 --- a/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ReceiveConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-receiveconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ReceiveConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-receiveconnector +schema: 2.0.0 +title: Remove-ReceiveConnector --- # Remove-ReceiveConnector @@ -31,7 +32,7 @@ Remove-ReceiveConnector [-Identity] ## DESCRIPTION Removing a Receive connector from the server might affect mail flow throughout the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example removes the Receive connector named Contoso.com Receive Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Receive connector that you want to remove. You can use any value that uniquely identifies the Receive connector. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the Receive connector that you want to remove. Type: ReceiveConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -75,7 +81,6 @@ 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 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -93,7 +101,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RecipientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RecipientPermission.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-RecipientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RecipientPermission.md index 0e5ed346d2..ac050e0a57 100644 --- a/exchange/exchange-ps/exchange/Remove-RecipientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RecipientPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-recipientpermission applicable: Exchange Online -title: Remove-RecipientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-recipientpermission +schema: 2.0.0 +title: Remove-RecipientPermission --- # Remove-RecipientPermission @@ -24,6 +25,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Remove-RecipientPermission [-Identity] -AccessRights -Trustee [-Confirm] [-Deny] + [-MultiTrustees ] [-SkipDomainValidationForMailContact] [-SkipDomainValidationForMailUser] [-SkipDomainValidationForSharedMailbox] @@ -34,7 +36,7 @@ Remove-RecipientPermission [-Identity] -AccessRights Applicable: Exchange Online + The Identity parameter specifies the target recipient. The user or group specified by the Trustee parameter can no longer operate on this recipient. You can specify any type of recipient, for example: @@ -71,7 +76,6 @@ You can use any value that uniquely identifies the recipient. For example: Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -81,13 +85,15 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Online + The AccessRights parameter specifies the permission that you want to remove from the trustee on the target recipient. The only valid value for this parameter is SendAs. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -Trustee + +> Applicable: Exchange Online + The Trustee parameter specifies whose Send As permissions are being removing from the specified target recipient. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -120,7 +129,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -130,6 +138,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -139,7 +150,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -149,13 +159,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Online + {{ Fill Deny Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -164,14 +176,34 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -MultiTrustees + +> Applicable: Exchange Online + +{{ Fill MultiTrustees Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SkipDomainValidationForMailContact + +> Applicable: Exchange Online + The SkipDomainValidationForMailContact switch skips the check that confirms the proxy addresses of the external contact specified by the Identity parameter are in an accepted domain of the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -181,13 +213,15 @@ Accept wildcard characters: False ``` ### -SkipDomainValidationForMailUser + +> Applicable: Exchange Online + The SkipDomainValidationForMailUser switch skips the check that confirms the proxy addresses of the mail user specified by the Identity parameter are in an accepted domain of the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -197,13 +231,15 @@ Accept wildcard characters: False ``` ### -SkipDomainValidationForSharedMailbox + +> Applicable: Exchange Online + The SkipDomainValidationForSharedMailbox switch skips the check that confirms the proxy addresses of the shared mailbox specified by the Identity parameter are in an accepted domain of the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -213,13 +249,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-RemoteDomain.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RemoteDomain.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-RemoteDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RemoteDomain.md index bc7601b802..66d775fc09 100644 --- a/exchange/exchange-ps/exchange/Remove-RemoteDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RemoteDomain.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-remotedomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-RemoteDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-remotedomain +schema: 2.0.0 +title: Remove-RemoteDomain --- # Remove-RemoteDomain ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-RemoteDomain cmdlet to remove a remote domain. When you remove a remote domain, the remote domain object is deleted. Removing a remote domain doesn't disable mail flow to that domain. @@ -29,7 +30,7 @@ Remove-RemoteDomain [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example removes the remote domain object named Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the remote domain that you want to remove. You can use any value that uniquely identifies the remote domain. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the remote domain that you want to remove. You Type: RemoteDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -92,7 +100,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RemoteMailbox.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RemoteMailbox.md index 1795e792f9..ff92a0cad0 100644 --- a/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-remotemailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-RemoteMailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-remotemailbox +schema: 2.0.0 +title: Remove-RemoteMailbox --- # Remove-RemoteMailbox @@ -35,7 +36,7 @@ With the Remove-RemoteMailbox cmdlet, you can remove an on-premises mail-enabled Directory synchronization must be configured correctly for a mailbox to be removed from the service. Removal of the mailbox from the service isn't immediate and depends on the directory synchronization schedule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,11 +45,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Remove-RemoteMailbox "Kim Akers" ``` -This example removes the on-premises mail-enabled user Kim Akers and the associated mailbox from the service. This example assumes directory synchronization has been configured. +This example removes the on-premises mail-enabled user Kim Akers and the associated mailbox from the service. This example assumes directory synchronization is configured. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter identifies the mail-enabled user and the associated mailbox in the service that you want to remove. You can use one of the following values: - ADObjectID @@ -64,7 +68,6 @@ The Identity parameter identifies the mail-enabled user and the associated mailb Type: RemoteMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -83,7 +89,6 @@ 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 Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -120,7 +130,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreLegalHold switch ignores the legal hold status of the remote user. You don't need to specify a value with this switch. This switch removes the instance of the remote object in the on-premises organization, and the request to remove the mailbox is synchronized to the cloud. The Microsoft Entra object is removed, but if the mailbox is on hold, the mailbox is converted into an inactive mailbox and remains on hold. @@ -138,7 +150,6 @@ This switch removes the instance of the remote object in the on-premises organiz Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionPolicy.md index bdcd81de21..37601a5812 100644 --- a/exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-reportsubmissionpolicy applicable: Exchange Online -title: Remove-ReportSubmissionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-reportsubmissionpolicy +schema: 2.0.0 +title: Remove-ReportSubmissionPolicy --- # Remove-ReportSubmissionPolicy @@ -27,7 +28,7 @@ Remove-ReportSubmissionPolicy [-Identity] [< ## DESCRIPTION There's only one report submission policy in an organization, and it's named DefaultReportSubmissionPolicy. You can remove the policy and then use the New-ReportSubmissionPolicy cmdlet to recreate it with the default settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,13 +42,15 @@ This example removes the report submission policy from your organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission policy that you want to remove. The only available policy is named DefaultReportSubmissionPolicy. ```yaml Type: ReportSubmissionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 diff --git a/exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionRule.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionRule.md index 7c7b4a7d97..40faf43a7b 100644 --- a/exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-reportsubmissionrule applicable: Exchange Online -title: Remove-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-reportsubmissionrule +schema: 2.0.0 +title: Remove-ReportSubmissionRule --- # Remove-ReportSubmissionRule @@ -30,7 +31,7 @@ Remove-ReportSubmissionRule [-Identity] ## DESCRIPTION To disable the report submission rule without deleting it, use the Disable-ReportSubmissionRule cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example removes the report submission rule from your organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission rule that you want to remove. The default rule is named DefaultReportSubmissionRule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-ResubmitRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ResubmitRequest.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-ResubmitRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ResubmitRequest.md index 6b01e58449..4ece31ad16 100644 --- a/exchange/exchange-ps/exchange/Remove-ResubmitRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ResubmitRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-resubmitrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ResubmitRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-resubmitrequest +schema: 2.0.0 +title: Remove-ResubmitRequest --- # Remove-ResubmitRequest @@ -29,7 +30,7 @@ Remove-ResubmitRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example removes all resubmit requests. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the resubmit request you want to remove. Each resubmit request is identified by an incremented integer value. ```yaml Type: ResubmitRequestIdentityParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -75,7 +81,6 @@ 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 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -98,7 +106,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionCompliancePolicy.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RetentionCompliancePolicy.md index 586520eb81..05ea204006 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentioncompliancepolicy applicable: Security & Compliance -title: Remove-RetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-retentioncompliancepolicy +schema: 2.0.0 +title: Remove-RetentionCompliancePolicy --- # Remove-RetentionCompliancePolicy @@ -44,6 +45,9 @@ This example removes the retention policy named "Regulation 123 Compliance". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the retention policy that you want to remove. Y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -99,13 +106,17 @@ Accept wildcard characters: False ``` ### -PriorityCleanup -{{ Fill PriorityCleanup Description }} + +> Applicable: Security & Compliance + +The PriorityCleanup switch specifies whether to remove a Priority cleanup policy. You don't need to specify a value with this switch. + +Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -115,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionComplianceRule.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RetentionComplianceRule.md index fd33677240..a48e83973e 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentioncompliancerule applicable: Security & Compliance -title: Remove-RetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-retentioncompliancerule +schema: 2.0.0 +title: Remove-RetentionComplianceRule --- # Remove-RetentionComplianceRule @@ -46,6 +47,9 @@ This example removes the retention rule named "One Year Standard". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention rule to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the retention rule to remove. You can use any v Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -101,13 +108,17 @@ Accept wildcard characters: False ``` ### -PriorityCleanup -{{ Fill PriorityCleanup Description }} + +> Applicable: Security & Compliance + +The PriorityCleanup switch specifies whether to remove the rule associated with a Priority cleanup policy. You don't need to specify a value with this switch. + +Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,13 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicy.md similarity index 75% rename from exchange/exchange-ps/exchange/Remove-RetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicy.md index 3606e9995c..010d3880a8 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentionpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-RetentionPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-retentionpolicy +schema: 2.0.0 +title: Remove-RetentionPolicy --- # Remove-RetentionPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-RetentionPolicy cmdlet to remove a retention policy. @@ -32,9 +33,9 @@ Remove-RetentionPolicy [-Identity] ## DESCRIPTION Retention policies are used to apply message retention settings to folders and items in a mailbox. The Remove-RetentionPolicy cmdlet removes an existing retention policy. -If you remove a retention policy that's assigned to users and they don't have another retention policy assigned, messages in those mailboxes may never expire. This may be a violation of the organization's messaging retention policies. When you attempt to remove a policy that's assigned to users, Microsoft Exchange displays a confirmation message indicating that the policy is assigned to users. Note that this message is in addition to the confirmation prompt displayed when removing a retention policy. +If you remove a retention policy that's assigned to users and they don't have another retention policy assigned, messages in those mailboxes might never expire. This might be a violation of the organization's messaging retention policies. When you attempt to remove a policy that's assigned to users, Microsoft Exchange displays a confirmation message indicating that the policy is assigned to users. This message is in addition to the confirmation prompt displayed when removing a retention policy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,13 +63,15 @@ This example removes the retention policy Business Critical, which is assigned t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the retention policy name. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -87,7 +93,6 @@ 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 Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -105,7 +113,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you remove a retention policy that's assigned to users. Removing a policy that's assigned to users results in those users not having any retention policy. @@ -123,7 +133,6 @@ Use this switch to hide the confirmation prompt when you remove a retention poli Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicyTag.md similarity index 77% rename from exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicyTag.md index 03f3e9a59f..fc50717840 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicyTag.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentionpolicytag -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-RetentionPolicyTag -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-retentionpolicytag +schema: 2.0.0 +title: Remove-RetentionPolicyTag --- # Remove-RetentionPolicyTag ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-RetentionPolicyTag cmdlet to remove a retention tag. @@ -31,11 +32,11 @@ Remove-RetentionPolicyTag [-Identity] ## DESCRIPTION Retention tags are added to a retention policy, which is applied to a mailbox. -When you use the Remove-RetentionPolicyTag cmdlet to remove a retention tag, it removes the tag definition stored in Active Directory. The next time the Managed Folder Assistant runs, it processes all items that have the removed tag applied and restamps them. Depending on the number of mailboxes and messages, this process may result in significant resource consumption on all Mailbox servers that contain mailboxes with a retention policy that includes the removed tag. +When you use the Remove-RetentionPolicyTag cmdlet to remove a retention tag, it removes the tag definition stored in Active Directory. The next time the Managed Folder Assistant runs, it processes all items that have the removed tag applied and restamps them. Depending on the number of mailboxes and messages, this process might result in significant resource consumption on all Mailbox servers that contain mailboxes with a retention policy that includes the removed tag. For more information about retention tags, see [Retention tags and retention policies in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example removes the retention tag Finance-DeletedItems. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the retention policy tag. ```yaml Type: RetentionPolicyTagIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -74,7 +80,6 @@ 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 Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleAssignmentPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RoleAssignmentPolicy.md index 30fc9c2297..ee27eb7529 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleAssignmentPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-roleassignmentpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-RoleAssignmentPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-roleassignmentpolicy +schema: 2.0.0 +title: Remove-RoleAssignmentPolicy --- # Remove-RoleAssignmentPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-RoleAssignmentPolicy cmdlet to remove existing management role assignment policies from your organization. @@ -37,7 +38,7 @@ The assignment policy you want to remove can't be assigned to any mailboxes or m For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,13 +68,15 @@ For more information about the Where cmdlet and pipelining, see [Working with co ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the assignment policy to remove. If the assignment policy name has spaces, enclose the name in quotation marks ("). ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -92,7 +98,6 @@ 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 Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -112,7 +120,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RoleGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroup.md similarity index 76% rename from exchange/exchange-ps/exchange/Remove-RoleGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroup.md index ed3cddf995..e70371f1c6 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-rolegroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Remove-RoleGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-rolegroup +schema: 2.0.0 +title: Remove-RoleGroup --- # Remove-RoleGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-RoleGroup cmdlet to remove a management role group. @@ -35,11 +36,11 @@ When you remove a role group, all the management role assignments assigned manag You can't remove built-in role groups. -If the ManagedBy property has been populated with role group managers, the user removing the role group must be a role group manager. Alternately, if the user is a member of the Organization Management role group or is directly or indirectly assigned the Role Management role, the BypassSecurityGroupManagerCheck switch can be used to override the security group management check. +If the ManagedBy property is populated with role group managers, the user removing the role group must be a role group manager. Alternately, if the user is a member of the Organization Management role group or is directly or indirectly assigned the Role Management role, the BypassSecurityGroupManagerCheck switch can be used to override the security group management check. For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,13 +61,15 @@ This example removes the Vancouver Recipient Administrators role group. Because ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group to remove. If the role group name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -87,7 +93,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -106,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -124,7 +134,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -144,7 +156,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -162,7 +176,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroupMember.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-RoleGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroupMember.md index 34807f1679..b6fcbbf46e 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroupMember.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-rolegroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Remove-RoleGroupMember -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-rolegroupmember +schema: 2.0.0 +title: Remove-RoleGroupMember --- # Remove-RoleGroupMember ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-RoleGroupMember cmdlet to remove a member of a management role group. @@ -32,13 +33,13 @@ Remove-RoleGroupMember [-Identity] -Member Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group that you want to remove a member from. If the role group name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Member parameter specifies who to remove from the role group. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -113,7 +119,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -134,7 +142,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -153,7 +163,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -171,7 +183,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -189,7 +203,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RoutingGroupConnector.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RoutingGroupConnector.md index e34b39e341..9c6e3d0b0e 100644 --- a/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RoutingGroupConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-routinggroupconnector applicable: Exchange Server 2010 -title: Remove-RoutingGroupConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-routinggroupconnector +schema: 2.0.0 +title: Remove-RoutingGroupConnector --- # Remove-RoutingGroupConnector @@ -33,7 +34,7 @@ A routing group connector is used to send and receive messages between computers The Exchange 2003 servers used as source servers for the specified routing group connector are automatically removed from the ExchangeLegacyInterop universal security group. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example removes the routing group connector Ex2010 to Ex2003 RGC. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name or GUID of the routing group connector. The name is expressed as [[Administrative Group Name\\]Routing Group Name\\]Routing Group Connector Name. ```yaml Type: RoutingGroupConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RpcClientAccess.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-RpcClientAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RpcClientAccess.md index 869e6560c5..1b204769fa 100644 --- a/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RpcClientAccess.md @@ -1,15 +1,16 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-rpcclientaccess applicable: Exchange Server 2010 -title: Remove-RpcClientAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-rpcclientaccess +schema: 2.0.0 +title: Remove-RpcClientAccess --- -# Remove-RPCClientAccess +# Remove-RpcClientAccess ## SYNOPSIS This cmdlet is available only in Exchange Server 2010. @@ -21,7 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Remove-RPCClientAccess -Server +Remove-RpcClientAccess -Server [-Confirm] [-DomainController ] [-WhatIf] @@ -29,9 +30,9 @@ Remove-RPCClientAccess -Server ``` ## DESCRIPTION -Disabling RPC client access on a server blocks all RPC access through the specified Client Access server. Therefore, RPC clients (for example, clients running Microsoft Office Outlook 2007) with mailboxes on any mailbox databases configured to use the specified Client Access server won't be able to connect. +Disabling RPC client access on a server blocks all RPC access through the specified Client Access server. Therefore, RPC clients (for example, clients running Microsoft Office Outlook 2007) with mailboxes on any mailbox databases configured to use the specified Client Access server can't connect. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example removes the configuration information for the Exchange RPC Client A ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Client Access server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -56,7 +60,6 @@ The Server parameter specifies the Client Access server where you want to run th Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentPolicy.md index 857607a82b..97148431b9 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-safeattachmentpolicy applicable: Exchange Online -title: Remove-SafeAttachmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-safeattachmentpolicy +schema: 2.0.0 +title: Remove-SafeAttachmentPolicy --- # Remove-SafeAttachmentPolicy @@ -31,7 +32,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example removes the safe attachment policy named Block Attachments Policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment policy that you want to remove. You can use any value that uniquely identifies the policy. For example: @@ -57,7 +61,6 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + 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. @@ -94,7 +102,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentRule.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentRule.md index e442e79efb..28b2b0c067 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-safeattachmentrule applicable: Exchange Online -title: Remove-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-safeattachmentrule +schema: 2.0.0 +title: Remove-SafeAttachmentRule --- # Remove-SafeAttachmentRule @@ -30,7 +31,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/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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This examples removes the safe attachment rule named Research Department Attachm ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment rule that you want to remove. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksPolicy.md index 287856fcc5..40c1b76e66 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-safelinkspolicy applicable: Exchange Online -title: Remove-SafeLinksPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-safelinkspolicy +schema: 2.0.0 +title: Remove-SafeLinksPolicy --- # Remove-SafeLinksPolicy @@ -33,7 +34,7 @@ You can't remove the default Safe Links policy (the policy where the IsDefault p Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example remove the Safe Links policy named Engineering Department URL Polic ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links policy that you want to remove. You can use any value that uniquely identifies the policy. For example: @@ -59,7 +63,6 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + 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. @@ -96,7 +104,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksRule.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksRule.md index 472e9e9324..3fd4cb00d9 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-safelinksrule applicable: Exchange Online -title: Remove-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-safelinksrule +schema: 2.0.0 +title: Remove-SafeLinksRule --- # Remove-SafeLinksRule @@ -30,7 +31,7 @@ Remove-SafeLinksRule [-Identity] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This examples removes the Safe Links rule named Research Department URL Rule. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links rule that you want to remove. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SearchDocumentFormat.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SearchDocumentFormat.md index b15bec5d2b..734253fba9 100644 --- a/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SearchDocumentFormat.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-searchdocumentformat -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SearchDocumentFormat -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-searchdocumentformat +schema: 2.0.0 +title: Remove-SearchDocumentFormat --- # Remove-SearchDocumentFormat @@ -29,9 +30,11 @@ Remove-SearchDocumentFormat [-Identity] ``` ## DESCRIPTION -After running the Remove-SearchDocumentFormat cmdlet, your must run the following cmdlet to restart the search service. There will be a brief search outage. +After running the Remove-SearchDocumentFormat cmdlet, you must run the following cmdlet to restart the search service. There will be a brief search outage. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +`Restart-Service HostControllerService` + +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +48,15 @@ This example removes the search document format with an identity equal to "sct". ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter uniquely identifies the format to be removed. You can use the Get-SearchDocumentFormat cmdlet to view the identities of the installed formats. ```yaml Type: SearchDocumentFormatId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -70,7 +78,6 @@ 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 Required: False Position: Named @@ -80,6 +87,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -93,7 +103,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SecOpsOverridePolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SecOpsOverridePolicy.md index 116c6c915a..a8094fee23 100644 --- a/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SecOpsOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-secopsoverridepolicy applicable: Exchange Online -title: Remove-SecOpsOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-secopsoverridepolicy +schema: 2.0.0 +title: Remove-SecOpsOverridePolicy --- # Remove-SecOpsOverridePolicy @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS 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 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). +Use the Remove-SecOpsOverridePolicy cmdlet to remove SecOps mailbox override policies that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -30,7 +31,7 @@ Remove-SecOpsOverridePolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example removes the SecOps mailbox override policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the SecOps override policy that you want to rem Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Exchange Online + 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 @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SendConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SendConnector.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-SendConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SendConnector.md index e1ce45ac63..e76cacedf7 100644 --- a/exchange/exchange-ps/exchange/Remove-SendConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SendConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-sendconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SendConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-sendconnector +schema: 2.0.0 +title: Remove-SendConnector --- # Remove-SendConnector @@ -31,9 +32,9 @@ Remove-SendConnector [-Identity] ## DESCRIPTION The Remove-SendConnector cmdlet deletes the object and the configuration settings for the Send connector. -Although a Send connector is configured locally in the Transport service on a Mailbox server or on an Edge server, deleting a Send connector may affect mail flow throughout the organization. +Although a Send connector is configured locally in the Transport service on a Mailbox server or on an Edge server, deleting a Send connector might affect mail flow throughout the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example deletes the Send connector named Contoso.com Send Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name, or GUID of the Send connector. If the Identity name contains spaces, enclose the name in quotation marks ("). You can omit the Identity parameter label. You can also include the server name by using the format ServerName\\ConnectorName. ```yaml Type: SendConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -90,7 +98,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ServerMonitoringOverride.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ServerMonitoringOverride.md index dff6213508..2df2f375d2 100644 --- a/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ServerMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-servermonitoringoverride -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ServerMonitoringOverride -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-servermonitoringoverride +schema: 2.0.0 +title: Remove-ServerMonitoringOverride --- # Remove-ServerMonitoringOverride @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Remove-ServerMonitoringOverride cmdlet to remove a managed availability local server override that has been configured for a probe, monitor or responder. +Use the Remove-ServerMonitoringOverride cmdlet to remove a managed availability local server override that is configured for a probe, monitor or responder. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -28,7 +29,7 @@ Remove-ServerMonitoringOverride [-Identity] -ItemType Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the monitoring item that was overridden. The value is in the form of HealthSet\\MonitoringItem or HealthSet\\MonitoringItem\\TargetResource. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -ItemType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ItemType parameter specifies the item type of the override that you want to remove. It can be any of the following values: - Probe @@ -75,7 +81,6 @@ The ItemType parameter specifies the item type of the override that you want to Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PropertyName parameter specifies the property for the override you want to remove. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server that contains the override that you want to remove. You can use any value that uniquely identifies the server. For example: - Name @@ -112,7 +122,6 @@ The Server parameter specifies the Exchange server that contains the override th Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -131,7 +143,6 @@ 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 Required: False Position: Named @@ -141,13 +152,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ServicePrincipal.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-ServicePrincipal.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ServicePrincipal.md index 855f9df7b6..c335f5b35f 100644 --- a/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ServicePrincipal.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-serviceprincipal applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Remove-ServicePrincipal -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-serviceprincipal +schema: 2.0.0 +title: Remove-ServicePrincipal --- # Remove-ServicePrincipal @@ -28,7 +29,7 @@ Remove-ServicePrincipal [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example removes the specified service principal. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the service principal that you want to remove. You can use any value that uniquely identifies the service principal. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the service principal that you want to remove. Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SettingOverride.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SettingOverride.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-SettingOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SettingOverride.md index c3488fbb4e..3553943047 100644 --- a/exchange/exchange-ps/exchange/Remove-SettingOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SettingOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-settingoverride -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SettingOverride -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-settingoverride +schema: 2.0.0 +title: Remove-SettingOverride --- # Remove-SettingOverride @@ -33,7 +34,7 @@ Remove-SettingOverride [-Identity] ## DESCRIPTION Setting overrides configure and store Exchange server customizations in Active Directory. The settings can be organization-wide or server-specific, and they persist in Active Directory across Exchange Cumulative Updates (CUs). Exchange customizations in web.config or exe.config XML application configuration files are server-specific, and they're lost when you install the next Exchange CU. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example removes the setting override named IM Server Integration. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the setting override that you want to remove. You can use any value that uniquely identifies the override. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the setting override that you want to remove. Y Type: SettingOverrideIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -76,7 +82,6 @@ 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 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SharingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SharingPolicy.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-SharingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SharingPolicy.md index ac9dbb8159..df9b839429 100644 --- a/exchange/exchange-ps/exchange/Remove-SharingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SharingPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-sharingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-SharingPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-sharingpolicy +schema: 2.0.0 +title: Remove-SharingPolicy --- # Remove-SharingPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-SharingPolicy cmdlet to remove a sharing policy. Before you can remove a sharing policy, you must ensure that no mailbox users are provisioned to use that policy. @@ -29,7 +30,7 @@ Remove-SharingPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example removes the sharing policy Contoso and suppresses the confirmation ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the sharing policy that you want to remove. You can use one of the following values: - ADObjectID @@ -61,7 +65,6 @@ The Identity parameter specifies the identity of the sharing policy that you wan Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -80,7 +86,6 @@ 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 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SiteMailboxProvisioningPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SiteMailboxProvisioningPolicy.md index 3b226be32b..8ce50bb76a 100644 --- a/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SiteMailboxProvisioningPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-sitemailboxprovisioningpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SiteMailboxProvisioningPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-sitemailboxprovisioningpolicy +schema: 2.0.0 +title: Remove-SiteMailboxProvisioningPolicy --- # Remove-SiteMailboxProvisioningPolicy @@ -33,7 +34,7 @@ Remove-SiteMailboxProvisioningPolicy [-Identity] ## DESCRIPTION You can't delete the default site mailbox provisioning policy. You need to create a new default policy by using the New-SiteMailboxProvisioningPolicy cmdlet or designate an existing policy as the default policy by using the Set-SiteMailboxProvisioningPolicy cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example deletes the site mailbox policy named Default that was created when ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the site mailbox provisioning policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the site mailbox provisioning policy that you w Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -76,7 +82,6 @@ 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 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-StoreMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Remove-StoreMailbox.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-StoreMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-StoreMailbox.md index 4faccccab2..0b0ae0b641 100644 --- a/exchange/exchange-ps/exchange/Remove-StoreMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-StoreMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-storemailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-StoreMailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-storemailbox +schema: 2.0.0 +title: Remove-StoreMailbox --- # Remove-StoreMailbox @@ -36,7 +37,7 @@ A mailbox is marked as Disabled immediately after the Disable-Mailbox or Remove- To view disabled mailboxes, run the Get-MailboxStatistics cmdlet against a database using the property DisconnectReason with a value of Disabled. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +65,9 @@ This example permanently purges all soft-deleted mailboxes from mailbox database ## PARAMETERS ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Database parameter specifies the mailbox database that contains the mailbox to remove. You can use any value that uniquely identifies the database. For example: - Name @@ -74,7 +78,6 @@ The Database parameter specifies the mailbox database that contains the mailbox Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the mailbox that you want to remove. Use the mailbox GUID as the value for this parameter. Run the following command to obtain the mailbox GUID and other information for all mailboxes in your organization: Get-MailboxDatabase | Get-MailboxStatistics | Format-List DisplayName,MailboxGuid,Database,DisconnectReason,DisconnectDate. @@ -92,7 +98,6 @@ Run the following command to obtain the mailbox GUID and other information for a Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -MailboxState + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxState parameter specifies the mailbox state on the source mailbox database. This parameter accepts the following values: - Disabled @@ -111,7 +119,6 @@ The MailboxState parameter specifies the mailbox state on the source mailbox dat Type: MailboxStateParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -130,7 +140,6 @@ 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 Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SupervisoryReviewPolicyV2.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SupervisoryReviewPolicyV2.md index 1bbb2eaf31..1be5daac3b 100644 --- a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SupervisoryReviewPolicyV2.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-supervisoryreviewpolicyv2 applicable: Security & Compliance -title: Remove-SupervisoryReviewPolicyV2 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-supervisoryreviewpolicyv2 +schema: 2.0.0 +title: Remove-SupervisoryReviewPolicyV2 --- # Remove-SupervisoryReviewPolicyV2 @@ -43,6 +44,9 @@ This example removes the supervisory review policy named EU Brokers Policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the supervisory review policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the supervisory review policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SweepRule.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SweepRule.md index 5a20fe05fc..59f9f6fb22 100644 --- a/exchange/exchange-ps/exchange/Remove-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SweepRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-sweeprule -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-SweepRule -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-sweeprule +schema: 2.0.0 +title: Remove-SweepRule --- # Remove-SweepRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-SweepRule cmdlet to remove Sweep rules from mailboxes. @@ -30,7 +31,7 @@ Remove-SweepRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example removes all Sweep rules in the specified mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Sweep rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). @@ -61,7 +65,6 @@ The Identity parameter specifies the Sweep rule that you want to remove. You can Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the rule you want to remove. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +135,6 @@ The Mailbox parameter specifies the mailbox that contains the rule you want to r Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SyncMailPublicFolder.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SyncMailPublicFolder.md index b48470c51b..820d10e781 100644 --- a/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SyncMailPublicFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-syncmailpublicfolder -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-SyncMailPublicFolder -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-syncmailpublicfolder +schema: 2.0.0 +title: Remove-SyncMailPublicFolder --- # Remove-SyncMailPublicFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. The Remove-SyncMailPublicFolder cmdlet is used by the Sync-MailPublicFolders.ps1 script to remove mail-enabled public folder recipient objects from Exchange Online (the script synchronizes mail-enabled public folder objects from the source on-premises Exchange organization to Exchange Online). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation. @@ -31,7 +32,7 @@ Remove-SyncMailPublicFolder [-Identity] ## DESCRIPTION This cmdlet is only used by the Sync-MailPublicFolders.ps1 script. Don't run this cmdlet in the Exchange Management Shell or in Exchange Online PowerShell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This cmdlet is only used by the Sync-MailPublicFolders.ps1 script. Don't run thi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mail-enabled public folder object that you want to remove from Exchange Online. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the mail-enabled public folder object that you Type: MailPublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -93,7 +101,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SystemMessage.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SystemMessage.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-SystemMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SystemMessage.md index c61753f2b5..1213f6465d 100644 --- a/exchange/exchange-ps/exchange/Remove-SystemMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SystemMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-systemmessage -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SystemMessage -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-systemmessage +schema: 2.0.0 +title: Remove-SystemMessage --- # Remove-SystemMessage @@ -31,7 +32,7 @@ Remove-SystemMessage [-Identity] ## DESCRIPTION You can't remove a default system message that's included with Exchange. When you remove a custom system message, the message text reverts to the text in the corresponding system message (if any) that's included with Exchange. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example removes the specified custom quota message (combination of language ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the custom system message that you want to remove. You can use any value that uniquely identifies the system message. For example: - Identity @@ -107,7 +111,6 @@ Maximum number of levels (depth) in a mailbox folder: Type: SystemMessageIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -117,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -126,7 +132,6 @@ 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 Required: False Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -144,7 +152,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +161,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md b/exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListItems.md similarity index 77% rename from exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListItems.md index 131df513a6..98cf2e12da 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Remove-TenantAllowBlockListItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-tenantallowblocklistitems +schema: 2.0.0 +title: Remove-TenantAllowBlockListItems --- # Remove-TenantAllowBlockListItems @@ -37,7 +38,7 @@ Remove-TenantAllowBlockListItems -Ids -ListType ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,11 +54,14 @@ 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 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). +This example removes the URL allow entry for the specified non-Microsoft phishing simulation URL. For more information, see [Configure the advanced delivery policy for non-Microsoft phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). ## PARAMETERS ### -Entries + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Entries parameter specifies the entries that you want to remove based on the ListType parameter value. Valid values are: - FileHash: The exact SHA256 file hash value. @@ -75,7 +79,6 @@ You can't use this parameter with the Ids parameter. Type: String[] Parameter Sets: Entries Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Ids + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Ids parameter specifies the entries that you want to remove. This value is shown in the Identity property in the output of the Get-TenantAllowBlockListItems cmdlet. An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. @@ -95,7 +101,6 @@ You can't use this parameter with the Entries parameter. Type: String[] Parameter Sets: Ids Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -ListType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListType parameter specifies the type of entry that you want to remove. Valid values are: - FileHash @@ -116,7 +124,6 @@ The ListType parameter specifies the type of entry that you want to remove. Vali Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -126,16 +133,18 @@ Accept wildcard characters: False ``` ### -ListSubType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListSubType specifies further specifies the type of entry that you want to remove. Valid values are: - AdvancedDelivery: Use this value for phishing simulation URLs. -- Tenant: This is the default value. +- Tenant: This value is the default. ```yaml Type: ListSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -OutputJson + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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. You use this switch to prevent the command from halting on the first entry that contains a syntax error. @@ -153,7 +165,6 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListSpoofItems.md similarity index 82% rename from exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListSpoofItems.md index dffc5da8d0..8e2392eaba 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListSpoofItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistspoofitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Remove-TenantAllowBlockListSpoofItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-tenantallowblocklistspoofitems +schema: 2.0.0 +title: Remove-TenantAllowBlockListSpoofItems --- # Remove-TenantAllowBlockListSpoofItems @@ -30,7 +31,7 @@ Remove-TenantAllowBlockListSpoofItems [-Identity] Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + Use the value `domain.com\Default` for this parameter. The spoofed sender that you want to remove is really identified by the Ids parameter. ```yaml Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -Ids + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Ids parameter specifies the spoof pair that you want to remove. A valid value for this parameter is the Identity property value from the output of the Get-TenantAllowBlockListSpoofItems cmdlet. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -76,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -85,7 +93,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -95,13 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ThrottlingPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ThrottlingPolicy.md index 98949a3787..094ae1ab94 100644 --- a/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ThrottlingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-throttlingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ThrottlingPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-throttlingpolicy +schema: 2.0.0 +title: Remove-ThrottlingPolicy --- # Remove-ThrottlingPolicy @@ -34,7 +35,7 @@ You can't remove the default client throttling policy. Also, you can't remove a For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,13 +64,15 @@ You can't remove a policy that's associated with any users. This example reassig ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter identifies the throttling policy you want to remove. Use the name that matches the name of the policy in Active Directory. ```yaml Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -88,7 +94,6 @@ 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 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -106,7 +114,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -124,7 +134,6 @@ 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 Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-TransportRule.md similarity index 78% rename from exchange/exchange-ps/exchange/Remove-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-TransportRule.md index 110d9f1322..91eb6434d2 100644 --- a/exchange/exchange-ps/exchange/Remove-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-TransportRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-transportrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-TransportRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-transportrule +schema: 2.0.0 +title: Remove-TransportRule --- # Remove-TransportRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Remove-TransportRule cmdlet to remove transport rules (mail flow rules) from your organization. @@ -33,7 +34,7 @@ On Mailbox servers, this cmdlet removes the rule from Active Directory. On an Ed To temporarily disable a transport rule without removing it, use the Disable-TransportRule cmdlet instead. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example removes the rule named "Redirect messages from kim@contoso.com to l ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the rule that you want to remove. You can use a Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -76,7 +82,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -96,7 +104,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMAutoAttendant.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMAutoAttendant.md index 902c636055..3fd7891ce3 100644 --- a/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Remove-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-umautoattendant +schema: 2.0.0 +title: Remove-UMAutoAttendant --- # Remove-UMAutoAttendant @@ -33,7 +34,7 @@ The Remove-UMAutoAttendant cmdlet deletes an existing UM auto attendant from Act After this task is completed, the UM auto attendant is removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example deletes the UM auto attendant MyUMAutoAttendant. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM auto attendant being deleted. This is the directory object ID for the UM auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMCallAnsweringRule.md similarity index 83% rename from exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMCallAnsweringRule.md index 85003d4509..26d0991f60 100644 --- a/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: Remove-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-umcallansweringrule +schema: 2.0.0 +title: Remove-UMCallAnsweringRule --- # Remove-UMCallAnsweringRule @@ -30,11 +31,11 @@ Remove-UMCallAnsweringRule [-Identity] ``` ## DESCRIPTION -The Remove-UMCallAnsweringRule cmdlet removes an existing UM call answering rule that has been created and stored in a UM-enabled user's mailbox. When you remove an existing call answering rule, all of the remaining call answering rules are still processed in order of their priority. +The Remove-UMCallAnsweringRule cmdlet removes an existing UM call answering rule that is created and stored in a UM-enabled user's mailbox. When you remove an existing call answering rule, all of the remaining call answering rules are still processed in order of their priority. After this task is completed, the cmdlet sets the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example removes the call answering rule MyUMCallAnsweringRule from the mail ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for a call answering rule being removed. ```yaml Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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`. @@ -80,7 +86,6 @@ 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 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule is changed. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +135,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMDialPlan.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMDialPlan.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-UMDialPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMDialPlan.md index 15968a4562..8f422da9ef 100644 --- a/exchange/exchange-ps/exchange/Remove-UMDialPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMDialPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Remove-UMDialPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-umdialplan +schema: 2.0.0 +title: Remove-UMDialPlan --- # Remove-UMDialPlan @@ -33,7 +34,7 @@ The Remove-UMDialPlan cmdlet deletes an existing UM dial plan from Active Direct After this task is completed, the UM dial plan is removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example deletes the existing UM dial plan MyUMDialPlan. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM dial plan being deleted. This is the directory object ID for the UM dial plan. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMHuntGroup.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-UMHuntGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMHuntGroup.md index 0923af3a69..6966e94209 100644 --- a/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMHuntGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-umhuntgroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Remove-UMHuntGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-umhuntgroup +schema: 2.0.0 +title: Remove-UMHuntGroup --- # Remove-UMHuntGroup @@ -33,7 +34,7 @@ The Remove-UMHuntGroup cmdlet deletes an existing UM hunt group from Active Dire After this task is completed, the UM hunt group is removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example deletes the UM hunt group MyUMHuntGroup. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM hunt group being deleted. This is the directory object ID for the UM hunt group object. ```yaml Type: UMHuntGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMIPGateway.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMIPGateway.md index e19873e3a1..2eb54404fe 100644 --- a/exchange/exchange-ps/exchange/Remove-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Remove-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-umipgateway +schema: 2.0.0 +title: Remove-UMIPGateway --- # Remove-UMIPGateway @@ -35,7 +36,7 @@ The Remove-UMIPGateway cmdlet should be run only by an administrator who fully u After this task is completed, the UM IP gateway is removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example deletes the UM IP gateway MyUMIPGateway. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM IP gateway being deleted. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -74,7 +80,6 @@ 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 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMMailboxPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMMailboxPolicy.md index 56d19d3378..47622239c9 100644 --- a/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Remove-UMMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ummailboxpolicy +schema: 2.0.0 +title: Remove-UMMailboxPolicy --- # Remove-UMMailboxPolicy @@ -33,7 +34,7 @@ The Remove-UMMailboxPolicy cmdlet deletes or removes a UM mailbox policy. If the After this task is completed, the UM mailbox policy is removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example deletes the UM mailbox policy MyUMMailboxPolicy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM mailbox policy being deleted. This parameter is the directory object ID for the UM mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedAuditLogRetentionPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedAuditLogRetentionPolicy.md index ed810f1d9c..ca5df022a4 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedAuditLogRetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedauditlogretentionpolicy applicable: Security & Compliance -title: Remove-UnifiedAuditLogRetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-unifiedauditlogretentionpolicy +schema: 2.0.0 +title: Remove-UnifiedAuditLogRetentionPolicy --- # Remove-UnifiedAuditLogRetentionPolicy @@ -46,6 +47,9 @@ This example deletes the audit log retention policy named "SearchQueryPerformed ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + 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 @@ -56,7 +60,6 @@ The Identity parameter specifies the audit log retention policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroup.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-UnifiedGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroup.md index 8c186032fb..28b72dc892 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedgroup applicable: Exchange Online, Exchange Online Protection -title: Remove-UnifiedGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-unifiedgroup +schema: 2.0.0 +title: Remove-UnifiedGroup --- # Remove-UnifiedGroup @@ -33,7 +34,7 @@ Remove-UnifiedGroup [-Identity] ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example removes the Microsoft 365 Group named Research Department. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to remove. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to remove Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -97,7 +105,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroupLinks.md similarity index 67% rename from exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroupLinks.md index 621b33dcb8..494ea656fd 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroupLinks.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedgrouplinks applicable: Exchange Online, Exchange Online Protection -title: Remove-UnifiedGroupLinks -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-unifiedgrouplinks +schema: 2.0.0 +title: Remove-UnifiedGroupLinks --- # Remove-UnifiedGroupLinks @@ -14,9 +15,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). @@ -32,7 +34,7 @@ Remove-UnifiedGroupLinks [-Identity] -Links Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to modify. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -59,7 +64,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to modify Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -69,7 +73,10 @@ 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. + +> Applicable: Exchange Online, Exchange Online Protection + +The Links parameter specifies the recipients to remove from the Microsoft 365 Group. You specify whether these recipients were members, owners, or subscribers by using the LinkType parameter. You can use any value that uniquely identifies the recipient. For example: @@ -82,13 +89,12 @@ You can use any value that uniquely identifies the recipient. For example: You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -You must use this parameter with the LinkType parameter, which means the specified recipients will all be removed from the same role in the Microsoft 365 Group (you can't remove different roles from specific recipients in the same command). +You must use this parameter with the LinkType parameter, which means the specified recipients are removed from the same role in the Microsoft 365 Group (you can't remove recipients from different roles in the same command). ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -98,19 +104,21 @@ Accept wildcard characters: False ``` ### -LinkType + +> Applicable: Exchange Online, Exchange Online Protection + The LinkType parameter specifies the recipient's role in the Microsoft 365 Group that you want to remove. Valid values are: - Members: Participate in conversations, create Teams channels, collaborate on files, and edit the connected SharePoint site. - Owners: Add or remove members, delete conversations, changes Team settings, delete the Team, and full control of the connected SharePoint site. A group must have at least one owner. -- Subscribers: Members who receive conversation and calendar event notifications from the group. All subscribers are members of the group, but all members aren't necessarily subscribers (depending on the AutoSubscribeNewMembers property value of the group and when the member was added). +- Subscribers: Existing group members who receive conversation and calendar event notifications from the group. All subscribers are members of the group, but all members aren't necessarily subscribers (depending on the AutoSubscribeNewMembers property value of the group and when the member was added). -You must use this parameter with the LinkType parameter. +You must use this parameter with the Links parameter. ```yaml Type: LinkType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -120,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -129,7 +140,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -139,13 +149,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UserPhoto.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UserPhoto.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-UserPhoto.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UserPhoto.md index fa074e42db..28cf153f71 100644 --- a/exchange/exchange-ps/exchange/Remove-UserPhoto.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UserPhoto.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-userphoto -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-UserPhoto -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-userphoto +schema: 2.0.0 +title: Remove-UserPhoto --- # Remove-UserPhoto @@ -49,9 +50,9 @@ Remove-UserPhoto [-Identity] Use the Remove-UserPhoto cmdlet to delete the user photo currently associated with a user's account. This cmdlet removes the photo from user's Exchange mailbox root. In on-premises Exchange, it also removes the user's photo from their Active Directory account. Administrators can also use the Exchange admin center (EAC) to delete user photos by accessing the Options page in the user's mailbox in Outlook on the web. -**Notes**: Changes to the user photo won't appear in SharePoint until the affected user visits their profile page (My Site) or any SharePoint page that shows their large thumbnail image. +**Notes**: Changes to the user photo don't appear in SharePoint until the affected user visits their profile page (My Site) or any SharePoint page that shows their large thumbnail image. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,6 +66,9 @@ This example deletes the photo associated with Ann Beebe's user account. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the user. You can use any value that uniquely identifies the user. For example: - Name @@ -82,7 +86,6 @@ The Identity parameter specifies the identity of the user. You can use any value Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -ClearMailboxPhotoRecord + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClearMailboxPhoto switch specifies that a deleted mailbox photo is considered blank instead of deleted. You don't need to specify a value with this switch. By default, when a user deletes their mailbox photo, a flag is set on the mailbox that causes subsequent photo requests to: @@ -105,7 +111,6 @@ Using this switch allows photo requests to search Active Directory for a photo. Type: SwitchParameter Parameter Sets: ClearMailboxPhoto Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -124,7 +132,6 @@ 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 Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ClearMailboxPhoto Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -177,7 +191,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,13 +200,15 @@ Accept wildcard characters: False ``` ### -PhotoType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: ClearMailboxPhoto Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,13 +218,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-VivaModuleFeaturePolicy.md similarity index 74% rename from exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-VivaModuleFeaturePolicy.md index 77b55f5a7c..fe576b5f2d 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-VivaModuleFeaturePolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivamodulefeaturepolicy applicable: Exchange Online -title: Remove-VivaModuleFeaturePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-vivamodulefeaturepolicy +schema: 2.0.0 +title: Remove-VivaModuleFeaturePolicy --- # Remove-VivaModuleFeaturePolicy @@ -15,15 +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**: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available. - -Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module or a category in Viva. 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 can't 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 - -### FeaturePolicy ``` Remove-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId [-Confirm] @@ -32,19 +28,8 @@ Remove-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId [] ``` -### CategoryPolicy -``` -Remove-VivaModuleFeaturePolicy -CategoryId -PolicyId - [-Confirm] - [-ResultSize ] - [-WhatIf] - [] -``` - ## DESCRIPTION -Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module or a category in Viva. - -Support for categories is available in version 3.5.0-Preview2 or later of the 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. @@ -68,47 +53,20 @@ Remove-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Pol This example deletes the specified policy for the Reflection feature in Viva Insights. -### Example 2 -```powershell -Remove-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da032w -``` - -This example deletes the specified policy for the `` category in Viva. - ## PARAMETERS -### -CategoryId -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. - -The CategoryId parameter specifies the category that you want to remove the policy from. - -To view details about the categories that support feature access controls, use the Get-VivaFeatureCategory cmdlet. The CategoryId value is returned in the output of the cmdlet. - -```yaml -Type: String -Parameter Sets: CategoryPolicy -Aliases: -Applicable: Exchange Online +### -FeatureId -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -118,13 +76,15 @@ Accept wildcard characters: False ``` ### -ModuleId + +> Applicable: Exchange Online + The ModuleId parameter specifies the Viva module of the feature that you want to remove the policy from. ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -134,6 +94,9 @@ Accept wildcard characters: False ``` ### -PolicyId + +> Applicable: Exchange Online + The PolicyId parameter specifies the policy for the feature in the Viva module that you want to remove. To view details about the added policies for a feature in a Viva module, refer to the Get-VivaModuleFeaturePolicy cmdlet. The details provided by the Get-VivaModuleFeaturePolicy cmdlet include the policy identifier. @@ -142,7 +105,6 @@ To view details about the added policies for a feature in a Viva module, refer t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -152,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -161,7 +126,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -171,13 +135,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -187,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/ExchangePowerShell/Remove-VivaOrgInsightsDelegatedRole.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-VivaOrgInsightsDelegatedRole.md index 23d68dd810..e23790f4ae 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-VivaOrgInsightsDelegatedRole.md @@ -1,18 +1,18 @@ --- -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 +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-vivaorginsightsdelegatedrole +schema: 2.0.0 +title: Remove-VivaOrgInsightsDelegatedRole --- # Remove-VivaOrgInsightsDelegatedRole ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module v3.7.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). +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). @@ -41,7 +41,7 @@ To run this cmdlet, you need to be a member of one of the following role groups ### Example 1 ```powershell -Remove-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +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. @@ -49,6 +49,9 @@ This example removes the organization insights viewing capability of the specifi ## PARAMETERS ### -Delegate + +> Applicable: Exchange Online + 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. @@ -57,7 +60,6 @@ A valid value for this parameter is the Microsoft Entra ObjectId value of the de Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -67,6 +69,9 @@ Accept wildcard characters: False ``` ### -Delegator + +> Applicable: Exchange Online + 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. @@ -75,7 +80,6 @@ A valid value for this parameter is the ObjectID value of the delegator account. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -85,13 +89,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-WebServicesVirtualDirectory.md similarity index 81% rename from exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-WebServicesVirtualDirectory.md index f4f42ba089..d095b5cdae 100644 --- a/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-WebServicesVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-webservicesvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-WebServicesVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-webservicesvirtualdirectory +schema: 2.0.0 +title: Remove-WebServicesVirtualDirectory --- # Remove-WebServicesVirtualDirectory @@ -32,7 +33,7 @@ Remove-WebServicesVirtualDirectory [-Identity] ## DESCRIPTION You can remove the default Exchange Web Services virtual directory or another Exchange Web Services virtual directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example removes the Exchange Web Services virtual directory named Sales fro ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the EWS virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -58,7 +62,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -77,7 +83,6 @@ 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 Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -111,7 +121,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md b/exchange/exchange-ps/ExchangePowerShell/Remove-X400AuthoritativeDomain.md similarity index 80% rename from exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-X400AuthoritativeDomain.md index f6c5c5dddd..37a5815f57 100644 --- a/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-X400AuthoritativeDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-x400authoritativedomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-X400AuthoritativeDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-x400authoritativedomain +schema: 2.0.0 +title: Remove-X400AuthoritativeDomain --- # Remove-X400AuthoritativeDomain @@ -29,7 +30,7 @@ Remove-X400AuthoritativeDomain [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,13 +44,15 @@ This example removes the X.400 authoritative domain object for the X.400 authori ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies a string value for the X.400 authoritative domain. Enter either the GUID or the name of the X.400 authoritative domain. ```yaml Type: X400AuthoritativeDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -68,7 +74,6 @@ 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 Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -86,7 +94,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/ExchangePowerShell/Remove-eDiscoveryCaseAdmin.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-eDiscoveryCaseAdmin.md index 828137cfb4..aa6488dbbb 100644 --- a/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-eDiscoveryCaseAdmin.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ediscoverycaseadmin applicable: Security & Compliance -title: Remove-eDiscoveryCaseAdmin -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ediscoverycaseadmin +schema: 2.0.0 +title: Remove-eDiscoveryCaseAdmin --- # Remove-eDiscoveryCaseAdmin @@ -46,6 +47,9 @@ This example removes an eDiscovery Administrator. ## PARAMETERS ### -User + +> Applicable: Security & Compliance + The User parameter specifies the user that you want to remove from the list of eDiscovery Administrators. You can use any value that uniquely identifies the user. For example: - Name @@ -57,7 +61,6 @@ The User parameter specifies the user that you want to remove from the list of e Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md b/exchange/exchange-ps/ExchangePowerShell/Reset-ProvisioningCache.md similarity index 83% rename from exchange/exchange-ps/exchange/Reset-ProvisioningCache.md rename to exchange/exchange-ps/ExchangePowerShell/Reset-ProvisioningCache.md index 0c541d75c8..810db51c98 100644 --- a/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md +++ b/exchange/exchange-ps/ExchangePowerShell/Reset-ProvisioningCache.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/reset-provisioningcache -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Reset-ProvisioningCache -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/reset-provisioningcache +schema: 2.0.0 +title: Reset-ProvisioningCache --- # Reset-ProvisioningCache @@ -46,7 +47,7 @@ The Reset-ProvisioningCache cmdlet is for diagnostic purposes only and is rarely The Reset-ProvisioningCache cmdlet clears the Windows PowerShell provisioning cache of frequently used Active Directory objects. To reduce Active Directory requests, a provisioning cache is initialized in each Windows PowerShell runspace and is used to cache common objects that are frequently used by cmdlets and provisioning handlers. During Exchange cmdlet execution, the provisioning cache loads configuration objects from Active Directory to help run a cmdlet. For example, when you create a mailbox, the New-Mailbox cmdlet obtains properties from Active Directory. When running cmdlets, configuration objects such as database containers, administrative role groups, and LegacyDNs are retrieved from Active Directory. Because these types of objects are stable and don't change for months or years after they're created, they're stored in the provisioning cache used by Windows PowerShell. This increases provisioning efficiency and significantly improves cmdlet performance. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,13 +68,15 @@ This example runs in a multi-tenant deployment by a data center administrator to ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the fully qualified domain name (FQDN) of the server that the application you want to reset is running on. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Application + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Application parameter specifies the specific administrative application to reset the provisioning cache for. You can use the following values: - Powershell @@ -96,7 +102,6 @@ The Application parameter specifies the specific administrative application to r Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -GlobalCache + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GlobalCache switch clears all cache keys. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: GlobalCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -122,6 +129,9 @@ Accept wildcard characters: False ``` ### -CacheKeys + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CacheKeys parameter specifies the value for the cache key that you want to clear. The format for the values should contain 32 digits separated by four dashes: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Use the Dump-ProvisioningCache cmdlet to return a list of cache keys. @@ -130,7 +140,6 @@ Use the Dump-ProvisioningCache cmdlet to return a list of cache keys. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -149,7 +161,6 @@ 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 Required: False Position: Named @@ -159,13 +170,15 @@ Accept wildcard characters: False ``` ### -CurrentOrganization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CurrentOrganization switch resets the provision cache for the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: OrganizationCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,13 +188,15 @@ Accept wildcard characters: False ``` ### -Organizations -The Organizations parameter specifies the organizations that the provisioning cache will be reset. This parameter is used in multi-tenant deployments. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Organizations parameter specifies the organizations where the provisioning cache is reset. Use this parameter in multi-tenant deployments. ```yaml Type: MultiValuedProperty Parameter Sets: OrganizationCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +206,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Restore-DatabaseAvailabilityGroup.md similarity index 84% rename from exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Restore-DatabaseAvailabilityGroup.md index e7ed934cf1..05ca97870d 100644 --- a/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Restore-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/restore-databaseavailabilitygroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Restore-DatabaseAvailabilityGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/restore-databaseavailabilitygroup +schema: 2.0.0 +title: Restore-DatabaseAvailabilityGroup --- # Restore-DatabaseAvailabilityGroup @@ -44,7 +45,7 @@ The Restore-DatabaseAvailabilityGroup cmdlet performs several operations that af - Forcibly evicts the servers listed on the StoppedMailboxServers list from the DAG's cluster, thereby reestablishing quorum for the cluster enabling the surviving DAG members to start and provide service. - Configures the DAG to use the alternate witness server if there is an even number of surviving DAG members, or a single surviving DAG member. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,13 +66,15 @@ This example activates member servers in the DAG DAG1 for the Active Directory s ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the DAG being manipulated. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectorySite + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveDirectorySite parameter specifies the site containing the DAG members to be restored. ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -AlternateWitnessDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AlternateWitnessDirectory parameter specifies the name of an alternate directory used to store witness data. The specified directory must not be in use by any other DAGs or used for any other purpose. This value can be populated ahead by using the Set-DatabaseAvailabilityGroup cmdlet. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -AlternateWitnessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AlternateWitnessServer parameter specifies the name of a new witness server for the DAG as part of a site activation process. This value can be populated ahead by using the Set-DatabaseAvailabilityGroup cmdlet. ```yaml Type: FileShareWitnessServerName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -140,7 +152,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -UsePrimaryWitnessServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UsePrimaryWitnessServer switch specifies that the DAG's currently configured witness server should be used if a witness is needed by the DAG members that are being activated. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,13 +197,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Restore-DetailsTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Restore-DetailsTemplate.md similarity index 80% rename from exchange/exchange-ps/exchange/Restore-DetailsTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Restore-DetailsTemplate.md index c064436cf5..fa1f5da099 100644 --- a/exchange/exchange-ps/exchange/Restore-DetailsTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Restore-DetailsTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/restore-detailstemplate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Restore-DetailsTemplate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/restore-detailstemplate +schema: 2.0.0 +title: Restore-DetailsTemplate --- # Restore-DetailsTemplate @@ -31,7 +32,7 @@ Restore-DetailsTemplate [-Identity] ## DESCRIPTION Details templates can't be created or deleted, but this task restores the specified template to its default state. All user changes are lost. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example restores the default attributes to the User details template for th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the GUID or specifies the details template type and language separated by a backslash, for example, en-us\\User. Details template types include: - User @@ -58,7 +62,6 @@ The Identity parameter specifies the GUID or specifies the details template type Type: DetailsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -79,7 +85,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Restore-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Restore-Mailbox.md similarity index 87% rename from exchange/exchange-ps/exchange/Restore-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Restore-Mailbox.md index 8e775b1697..88fdd90071 100644 --- a/exchange/exchange-ps/exchange/Restore-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Restore-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/restore-mailbox applicable: Exchange Server 2010 -title: Restore-Mailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/restore-mailbox +schema: 2.0.0 +title: Restore-Mailbox --- # Restore-Mailbox @@ -48,7 +49,7 @@ Restore-Mailbox [-Identity] -RecoveryDatabase Applicable: Exchange Server 2010 + The Identity parameter specifies the mailbox that you want to restore. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -100,7 +104,6 @@ The Identity parameter specifies the mailbox that you want to restore. You can u Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -RecoveryDatabase + +> Applicable: Exchange Server 2010 + The RecoveryDatabase parameter specifies the recovery database where you are restoring the mailbox from. You can use any value that uniquely identifies the database. For example: - Name @@ -120,7 +126,6 @@ The RecoveryDatabase parameter specifies the recovery database where you are res Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -RecoveryMailbox + +> Applicable: Exchange Server 2010 + The RecoveryMailbox parameter specifies the mailbox to be used as the source mailbox. This parameter is required if the source mailbox is different from the target mailbox. You identify the mailbox by its GUID value. You can find the GUID value by using the Get-Mailbox or Get-MailboxStatistics cmdlets. @@ -138,7 +146,6 @@ You identify the mailbox by its GUID value. You can find the GUID value by using Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -148,13 +155,15 @@ Accept wildcard characters: False ``` ### -TargetFolder + +> Applicable: Exchange Server 2010 + The TargetFolder parameter specifies the mailbox folder that's created on the mailbox specified. This parameter is required if the mailbox being restored is different from the target mailbox. (For example, the value specified with the Identity parameter isn't the same as the value specified with the RecoveryMailbox parameter.) In this case, the Restore-Mailbox command performs a merge. If the values are the same, the TargetFolder parameter isn't required. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -AllowDuplicates + +> Applicable: Exchange Server 2010 + The AllowDuplicates switch copies mail items without checking if they're duplicates of existing items and without removing duplicate items. You don't need to specify a value with this switch. We recommend that you use this switch with the IncludeFolders parameter. @@ -172,7 +184,6 @@ We recommend that you use this switch with the IncludeFolders parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -AllContentKeywords + +> Applicable: Exchange Server 2010 + The AllContentKeywords parameter specifies the filters for all of the following: - Subject @@ -194,7 +208,6 @@ This allows an OR search of all these fields. If your search criteria are part o Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -204,13 +217,15 @@ Accept wildcard characters: False ``` ### -AttachmentFilenames + +> Applicable: Exchange Server 2010 + The AttachmentFilenames parameter specifies the filter for the attachment file name. You can use wildcard characters in the string. For example, you can use \*.txt to export items that have a .txt extension. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -220,13 +235,15 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010 + The BadItemLimit parameter specifies the number of corrupted items in a mailbox to skip before the export operation fails. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -245,7 +265,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -255,13 +274,15 @@ Accept wildcard characters: False ``` ### -ContentKeywords + +> Applicable: Exchange Server 2010 + The ContentKeywords parameter specifies the keyword filters for the message body and content of attachments in the source mailbox. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -271,13 +292,15 @@ 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. + +> Applicable: Exchange Server 2010 + +The EndDate parameter specifies the end date for filtering content to 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -287,13 +310,15 @@ Accept wildcard characters: False ``` ### -ExcludeFolders + +> Applicable: Exchange Server 2010 + The ExcludeFolders parameter specifies the list of folders to exclude during the export. Folders are excluded as they're entered. They aren't localized. For example, excluding calendar only excludes calendar in English because calendar in other languages is a different word. ```yaml Type: MapiFolderPath[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -303,13 +328,15 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Exchange Server 2010 + The GlobalCatalog parameter specifies the global catalog to use to search for the target mailbox. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -319,13 +346,15 @@ Accept wildcard characters: False ``` ### -IncludeFolders + +> Applicable: Exchange Server 2010 + The IncludeFolders parameter specifies the list of folders to include during the export. Folders are included as they're entered. They aren't localized. For example, including calendar only includes calendar in English because calendar in other languages is a different word. ```yaml Type: MapiFolderPath[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -335,13 +364,15 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2010 + The Locale parameter specifies the locale setting on a message to restore. With this filter set, only messages with the specified locale setting are extracted. ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -351,13 +382,15 @@ Accept wildcard characters: False ``` ### -MaxThreads + +> Applicable: Exchange Server 2010 + The MaxThreads parameter specifies the maximum number of threads to use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -367,13 +400,15 @@ Accept wildcard characters: False ``` ### -RecipientKeywords + +> Applicable: Exchange Server 2010 + The RecipientKeywords parameter specifies the keyword filters for recipients of items in the source mailbox. This filter finds the search string even if it's part of a word. This isn't a whole word search. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -383,13 +418,15 @@ Accept wildcard characters: False ``` ### -SenderKeywords + +> Applicable: Exchange Server 2010 + The SenderKeywords parameter specifies the keyword filters for senders of items in the source mailbox. This filter finds the search string even if it's part of a word. This isn't a whole word search. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -399,13 +436,15 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010 + The StartDate parameter specifies the start date. The start date must be before the end date. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -415,13 +454,15 @@ Accept wildcard characters: False ``` ### -SubjectKeywords + +> Applicable: Exchange Server 2010 + The SubjectKeywords parameter specifies the keyword filters for subjects of items in the source mailbox. This filter finds the search string even if it's part of a word. This isn't a whole word search. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -431,15 +472,15 @@ Accept wildcard characters: False ``` ### -ValidateOnly -The ValidateOnly switch tells the command to evaluate the conditions and requirements necessary to perform the operation, and then report whether the operation will succeed or fail. You don't need to specify a value with this switch. -No changes are made when you use this switch. +> Applicable: Exchange Server 2010 + +The ValidateOnly switch specifies whether to evaluate the potential success or failure of the command without making changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -449,13 +490,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/ExchangePowerShell/Restore-RecoverableItems.md similarity index 86% rename from exchange/exchange-ps/exchange/Restore-RecoverableItems.md rename to exchange/exchange-ps/ExchangePowerShell/Restore-RecoverableItems.md index 9c55a7b97c..a4fa08974d 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Restore-RecoverableItems.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/restore-recoverableitems -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Restore-RecoverableItems -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/restore-recoverableitems +schema: 2.0.0 +title: Restore-RecoverableItems --- # Restore-RecoverableItems ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Restore-RecoverableItems items cmdlet to restore deleted items in mailboxes. You use the Get-RecoverableItems cmdlet to find the deleted items to recover. @@ -57,7 +58,7 @@ Restore-RecoverableItems -Identity ## DESCRIPTION Items are restored to the original folder location if the information is available for the item. If the information can't be found, the item is restored to the default folder for the item type (Inbox for messages, Calendar for meetings and appointments, etc.). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -119,6 +120,9 @@ This example bulk restores all the recoverable items for administrator. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox that contains the deleted items that you want to restore. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -136,9 +140,8 @@ In Exchange Online, you can specify multiple mailboxes separated by commas. If t ```yaml Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: OnPremises +Parameter Sets: OnPremises, Cloud Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -147,20 +150,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: GeneralMailboxOrMailUserIdParameter[] -Parameter Sets: Cloud -Aliases: -Applicable: Exchange Online +### -EntryID -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -EntryID The EntryID parameter specifies the deleted item that you want to restore. The EntryID value for the deleted item is unique in the mailbox. You can find the EntryID for specific items by using other search filters on the Get-RecoverableItems cmdlet (subject, date range, etc.). @@ -169,7 +162,6 @@ You can find the EntryID for specific items by using other search filters on the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -179,6 +171,9 @@ Accept wildcard characters: False ``` ### -FilterEndTime + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -187,7 +182,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,6 +191,9 @@ Accept wildcard characters: False ``` ### -FilterItemType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example: - IPM.Appointment (Meetings and appointments) @@ -209,7 +206,6 @@ The FilterItemType parameter filters the results by the specified MessageClass ( Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +215,9 @@ Accept wildcard characters: False ``` ### -FilterStartTime + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -227,7 +226,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -237,13 +235,15 @@ Accept wildcard characters: False ``` ### -LastParentFolderID + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -253,6 +253,9 @@ Accept wildcard characters: False ``` ### -MaxParallelSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MaxParallelSize parameter specifies the maximum number of mailboxes that are processed by the command in parallel. A valid value is an integer from 1 to 10. Typically, a higher value decreases the amount of time it takes to complete the command on multiple mailboxes. @@ -263,7 +266,6 @@ The value of this parameter has no effect when the Identity parameter specifies Type: Int32 Parameter Sets: Cloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -273,6 +275,9 @@ Accept wildcard characters: False ``` ### -NoOutput + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The NoOutput switch restores the deleted items directly without any command output in the console. You don't need to specify a value with this switch. @@ -281,7 +286,6 @@ The NoOutput switch restores the deleted items directly without any command outp Type: SwitchParameter Parameter Sets: Cloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -291,6 +295,9 @@ Accept wildcard characters: False ``` ### -PolicyTag + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill PolicyTag Description }} @@ -299,7 +306,6 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -309,11 +315,14 @@ Accept wildcard characters: False ``` ### -RestoreTargetFolder + +> Applicable: Exchange Online + 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 is created if it does not exist. Valid paths are: - `/` - `/folder1` @@ -321,13 +330,12 @@ This parameter is required for archives and optional for primary mailboxes. A de - `folder1` - `folder1/folder2` -The preceding or trailing `/` will be ignored. Then, it will be treated as the relative path of the IPM sub-tree: `/Top Of Information Store`. +The preceding or trailing `/` are ignored. Then, it's treated as the relative path of the IPM sub-tree: `/Top Of Information Store`. ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -337,13 +345,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -353,6 +363,9 @@ Accept wildcard characters: False ``` ### -SourceFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: - DeletedItems: The Deleted Items folder. @@ -367,7 +380,6 @@ If you don't use this parameter, the command searches those three folders. Type: RecoverableItemsFolderType Parameter Sets: OnPrem Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -377,13 +389,15 @@ Accept wildcard characters: False ``` ### -SubjectContains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SubjectContains parameter filters the deleted items by the specified text value in the Subject field. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxDatabaseCopy.md similarity index 82% rename from exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-MailboxDatabaseCopy.md index fd5c0c4ae9..8665313ed1 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboxdatabasecopy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-MailboxDatabaseCopy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-mailboxdatabasecopy +schema: 2.0.0 +title: Resume-MailboxDatabaseCopy --- # Resume-MailboxDatabaseCopy @@ -44,7 +45,7 @@ Resume-MailboxDatabaseCopy [-Identity] ## DESCRIPTION The Resume-MailboxDatabaseCopy cmdlet resumes replication and replay from a suspended state. If a database copy was suspended without administrator intervention, it's because the database copy is in a bad state. You can use the Get-MailboxDatabaseCopyStatus cmdlet to see if there are any messages indicating a failure. If the copy of the database is in a bad state, resuming the copy causes replication to fail and the mailbox database copy to return to a suspended state. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,13 +66,15 @@ This example resumes replication and replay activity for the copy of the databas ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the database whose copying is being resumed. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -90,7 +96,6 @@ 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 Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -DisableReplayLag + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisableReplayLag switch disables any configured replay lag time for the database copy when the passive copy is resumed. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: DisableReplayLag Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -DisableReplayLagReason + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisableReplayLagReason parameter is used with the DisableReplayLag parameter to specify an administrative reason for disabling replay lag time for a passive copy. ```yaml Type: String Parameter Sets: DisableReplayLag Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -ReplicationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplicationOnly switch resumes replication without affecting the activation setting (for example, the ActivationSuspended property for the database copy remains set to True). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +177,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxExportRequest.md similarity index 82% rename from exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-MailboxExportRequest.md index 48f67e84d6..b3adf7bcd2 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboxexportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-MailboxExportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-mailboxexportrequest +schema: 2.0.0 +title: Resume-MailboxExportRequest --- # Resume-MailboxExportRequest @@ -33,7 +34,7 @@ Resume-MailboxExportRequest [-Identity] ## DESCRIPTION The Resume-MailboxExportRequest cmdlet can be pipelined with the Get-MailboxExportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,13 +55,15 @@ This example resumes any failed export move requests. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). Use the following syntax: `Alias\Name`. ```yaml Type: MailboxExportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -79,7 +85,6 @@ 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 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxImportRequest.md similarity index 80% rename from exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-MailboxImportRequest.md index f1d190bae5..84b68f065c 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxImportRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboximportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Resume-MailboxImportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-mailboximportrequest +schema: 2.0.0 +title: Resume-MailboxImportRequest --- # Resume-MailboxImportRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Resume-MailboxImportRequest cmdlet to resume an import request that was suspended or failed. @@ -35,7 +36,7 @@ Resume-MailboxImportRequest [-Identity] ## DESCRIPTION This cmdlet can be pipelined with the Get-MailboxImportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,13 +57,15 @@ This example resumes all failed import requests. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you created the request using the Name parameter, use the following syntax: `Alias\Name`. ```yaml Type: MailboxImportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -81,7 +87,6 @@ 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 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxRestoreRequest.md similarity index 79% rename from exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-MailboxRestoreRequest.md index b7faf00b00..e724a01e35 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxRestoreRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboxrestorerequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Resume-MailboxRestoreRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-mailboxrestorerequest +schema: 2.0.0 +title: Resume-MailboxRestoreRequest --- # Resume-MailboxRestoreRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Resume-MailboxRestoreRequest cmdlet to resume a restore request that was suspended or failed. @@ -29,7 +30,7 @@ Resume-MailboxRestoreRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example resumes any restore request with the status of Failed. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -58,7 +62,6 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: MailboxRestoreRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -77,7 +83,6 @@ 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 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -95,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-Message.md b/exchange/exchange-ps/ExchangePowerShell/Resume-Message.md similarity index 83% rename from exchange/exchange-ps/exchange/Resume-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-Message.md index 3015c97f9a..8e12b6fcb9 100644 --- a/exchange/exchange-ps/exchange/Resume-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-message -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-Message -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-message +schema: 2.0.0 +title: Resume-Message --- # Resume-Message @@ -40,7 +41,7 @@ Resume-Message [-Identity] ## DESCRIPTION A message being sent to multiple recipients might be located in multiple queues. If you specify an Identity parameter, the message is resumed in a single queue if that identity matches only a single message. If the identity matches more than one message, you receive an error. To resume a message in more than one queue in a single operation, you must use the Filter parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,18 +54,20 @@ This example resumes delivery of all messages in a suspended state and for which - The messages were sent by the sender kweku@contoso.com. - The messages are queued on the server Server1. -- The messages will expire before 15:00 on January 5, 2018. +- The messages expire before 15:00 on January 5, 2018. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -82,7 +88,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -101,7 +109,6 @@ 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 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -126,7 +136,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-MoveRequest.md similarity index 79% rename from exchange/exchange-ps/exchange/Resume-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-MoveRequest.md index a29ecedb28..04cf94c12d 100644 --- a/exchange/exchange-ps/exchange/Resume-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-MoveRequest.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-moverequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Resume-MoveRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-moverequest +schema: 2.0.0 +title: Resume-MoveRequest --- # Resume-MoveRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Resume-MoveRequest cmdlet to resume a move request that has been suspended or has failed. +Use the Resume-MoveRequest cmdlet to resume a move request that is suspended or has failed. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -31,7 +32,7 @@ Resume-MoveRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,7 +52,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." @@ -59,6 +60,9 @@ This example resumes any move requests that have the suspend comment "Resume aft ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - GUID @@ -73,7 +77,6 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c Type: MoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -92,7 +98,6 @@ 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 Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -110,7 +118,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter specifies the move destination by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -139,7 +149,6 @@ The ProxyToMailbox parameter specifies the move destination by the location of t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendWhenReadyToComplete switch suspends the move request before it reaches the status of CompletionInProgress. You don't need to specify a value with this switch. Instead of this switch, we recommend using the Set-MoveRequest cmdlet with the CompleteAfter parameter. @@ -157,7 +169,6 @@ Instead of this switch, we recommend using the Set-MoveRequest cmdlet with the C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMigrationRequest.md similarity index 83% rename from exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMigrationRequest.md index 42768b7cfb..be2acbe60f 100644 --- a/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-publicfoldermigrationrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-PublicFolderMigrationRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-publicfoldermigrationrequest +schema: 2.0.0 +title: Resume-PublicFolderMigrationRequest --- # Resume-PublicFolderMigrationRequest @@ -31,7 +32,7 @@ Resume-PublicFolderMigrationRequest [-Identity] Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the migration request that you want to resume. You can use the following values: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the migration request that you want to resume. Type: PublicFolderMigrationRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -80,7 +86,6 @@ 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 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMoveRequest.md similarity index 79% rename from exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMoveRequest.md index 0fb437beb2..829cf0927e 100644 --- a/exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-publicfoldermoverequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-PublicFolderMoveRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-publicfoldermoverequest +schema: 2.0.0 +title: Resume-PublicFolderMoveRequest --- # Resume-PublicFolderMoveRequest @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Resume-PublicFolderMoveRequest cmdlet to resume a public folder move request that has been suspended or has failed. +Use the Resume-PublicFolderMoveRequest cmdlet to resume a public folder move request that is suspended or has failed. 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 +30,7 @@ Resume-PublicFolderMoveRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,7 +50,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." @@ -57,13 +58,15 @@ This example resumes a move request that has the suspend comment "Resume after 1 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the public folder move request. The default identity is \\PublicFolderMove. ```yaml Type: PublicFolderMoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -82,7 +88,6 @@ 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 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderReplication.md similarity index 85% rename from exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderReplication.md index a781b34c89..a5ee4bc606 100644 --- a/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderReplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-publicfolderreplication applicable: Exchange Server 2010 -title: Resume-PublicFolderReplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-publicfolderreplication +schema: 2.0.0 +title: Resume-PublicFolderReplication --- # Resume-PublicFolderReplication @@ -28,7 +29,7 @@ Resume-PublicFolderReplication [-Confirm] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example resumes content replication for the entire organization. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -51,7 +55,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-Queue.md b/exchange/exchange-ps/ExchangePowerShell/Resume-Queue.md similarity index 83% rename from exchange/exchange-ps/exchange/Resume-Queue.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-Queue.md index 43bb312d87..8accbc01e9 100644 --- a/exchange/exchange-ps/exchange/Resume-Queue.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-Queue.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-queue -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-Queue -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-queue +schema: 2.0.0 +title: Resume-Queue --- # Resume-Queue @@ -40,7 +41,7 @@ Resume-Queue [-Identity] ## DESCRIPTION If you use the Identity parameter, the queue is resumed only if that identity matches a single queue. If the identity matches more than one queue, you receive an error. To resume more than one queue in a single operation, you must use the Filter parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,13 +55,15 @@ This example resumes processing of all queues where the NextHopDomain is Fourthc ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -78,7 +84,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -97,7 +105,6 @@ 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 Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -122,7 +132,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Retry-Queue.md b/exchange/exchange-ps/ExchangePowerShell/Retry-Queue.md similarity index 83% rename from exchange/exchange-ps/exchange/Retry-Queue.md rename to exchange/exchange-ps/ExchangePowerShell/Retry-Queue.md index c34b537241..211362d848 100644 --- a/exchange/exchange-ps/exchange/Retry-Queue.md +++ b/exchange/exchange-ps/ExchangePowerShell/Retry-Queue.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/retry-queue -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Retry-Queue -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/retry-queue +schema: 2.0.0 +title: Retry-Queue --- # Retry-Queue @@ -42,7 +43,7 @@ Retry-Queue [-Identity] ## DESCRIPTION The Retry-Queue cmdlet forces a connection attempt for a queue that has a status of Retry. The cmdlet establishes a connection to the next hop if possible. If a connection isn't established, a new retry time is set. To use this command to retry delivery of messages in the Unreachable queue, you must include the Resubmit parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,13 +61,15 @@ This example forces a connection attempt for all queues that meet the following ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -84,7 +90,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -103,7 +111,6 @@ 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 Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -Resubmit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Resubmit parameter specifies whether the queue contents should be resubmitted to the categorizer before a connection is established. Valid input for this parameter is $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -144,7 +156,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md b/exchange/exchange-ps/ExchangePowerShell/Rotate-DkimSigningConfig.md similarity index 84% rename from exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Rotate-DkimSigningConfig.md index d424e6898b..14fd8444d3 100644 --- a/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Rotate-DkimSigningConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/rotate-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection -title: Rotate-DkimSigningConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/rotate-dkimsigningconfig +schema: 2.0.0 +title: Rotate-DkimSigningConfig --- # Rotate-DkimSigningConfig @@ -29,7 +30,7 @@ Rotate-DkimSigningConfig [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example rotates the DKIM signing policy for the contoso.com domain. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the DKIM signing policy that you want to rotate. You can use any value that uniquely identifies the policy. For example: - Name: The domain name (for example, contoso.com). @@ -53,7 +57,6 @@ The Identity parameter specifies the DKIM signing policy that you want to rotate Type: DkimSigningConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -KeySize + +> Applicable: Exchange Online, Exchange Online Protection + The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are: - 1024 @@ -95,7 +103,6 @@ RSA keys are supported. Ed25519 keys aren't supported. Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md b/exchange/exchange-ps/ExchangePowerShell/Search-AdminAuditLog.md similarity index 80% rename from exchange/exchange-ps/exchange/Search-AdminAuditLog.md rename to exchange/exchange-ps/ExchangePowerShell/Search-AdminAuditLog.md index f42ad8e781..870d841fbc 100644 --- a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Search-AdminAuditLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/search-adminauditlog -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Search-AdminAuditLog -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/search-adminauditlog +schema: 2.0.0 +title: Search-AdminAuditLog --- # Search-AdminAuditLog @@ -15,7 +16,7 @@ ms.reviewer: > [!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. +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might 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). @@ -44,11 +45,11 @@ If you run the Search-AdminAuditLog cmdlet without any parameters, up to 1,000 l In Exchange Online PowerShell, if you don't use the StartDate or EndDate parameters, only results from the last 14 days are returned. -In Exchange Online PowerShell, data is available for the last 90 days. You can enter dates older than 90 days, but only data from the last 90 days will be returned. +In Exchange Online PowerShell, data is available for the last 90 days. You can enter dates older than 90 days, but only data from the last 90 days are returned. For more information about the structure and properties of the audit log, see [Administrator audit log structure](https://learn.microsoft.com/Exchange/policy-and-compliance/admin-audit-logging/log-structure). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -94,6 +95,9 @@ This example returns entries in the administrator audit log of an Exchange Onlin ## PARAMETERS ### -Cmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Cmdlets parameter filters the results by the cmdlets that were used. You can specify multiple cmdlets separated by commas. In the results of this cmdlet, this property is named **CmdletName**. @@ -102,7 +106,6 @@ In the results of this cmdlet, this property is named **CmdletName**. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -112,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -120,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -145,7 +153,6 @@ In the results of this cmdlet, the date/time when the change was made (the cmdle Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -155,6 +162,9 @@ Accept wildcard characters: False ``` ### -ExternalAccess + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ExternalAccess parameter filters the results by changes that were made (cmdlets that were run) by users outside of your organization. Valid values are: - $true: Only return audit log entries where the change was made by an external user. In Exchange Online, use value to return audit log entries for changes that were made by Microsoft datacenter administrators. @@ -164,7 +174,6 @@ The ExternalAccess parameter filters the results by changes that were made (cmdl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -174,6 +183,9 @@ Accept wildcard characters: False ``` ### -IsSuccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The IsSuccess parameter filters the results by whether the changes were successful. Valid values are: - $true: Only return audit log entries where the change was successful (in other words, the cmdlet ran successfully). @@ -185,7 +197,6 @@ In the results of this cmdlet, this property is named **Succeeded**. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -195,13 +206,16 @@ Accept wildcard characters: False ``` ### -ObjectIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ObjectIds parameter filters the results by the object that was modified (the mailbox, public folder, Send connector, transport rule, accepted domain, etc. that the cmdlet operated on). A valid value depends on how the object is represented in the audit log. For example: - Name - Canonical distinguished name (for example, contoso.com/Users/Akia Al-Zuhairi) - Public folder identity (for example, \\Engineering\\Customer Discussion) -You'll likely need to use other filtering parameters on this cmdlet to narrow down the results and identify the types of objects that you're interested in. In the results of this cmdlet, this property is named **ObjectModified**. +You likely need to use other filtering parameters on this cmdlet to narrow down the results and identify the types of objects that you're interested in. In the results of this cmdlet, this property is named **ObjectModified**. 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"`. @@ -209,7 +223,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -219,6 +232,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Parameters parameter filters the results by the parameters that were used. You can only use this parameter with the Cmdlets parameter (you can't use it by itself). You can specify multiple parameters separated by commas. In the results of this cmdlet, this property is named **CmdletParameters** @@ -227,7 +243,6 @@ In the results of this cmdlet, this property is named **CmdletParameters** Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -237,6 +252,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. The default value is 1000. The maximum results to return is 250,000. @@ -245,7 +263,6 @@ The maximum results to return is 250,000. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -255,6 +272,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -270,7 +290,6 @@ In the results of this cmdlet, the date/time when the change was made (the cmdle Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -280,13 +299,15 @@ Accept wildcard characters: False ``` ### -StartIndex + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The StartIndex parameter specifies the position in the result set where the displayed results start. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -296,6 +317,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The UserIds parameter filters the results by the user who made the change (who ran the cmdlet). A typical value for this parameter is the user principal name (UPN; for example, helpdesk@contoso.com). But, updates that were made by system accounts without email addresses might use the Domain\\Username syntax (for example, NT AUTHORITY\SYSTEM (MSExchangeHMHost)). @@ -308,7 +332,6 @@ In the results of this cmdlet, this property is named **Caller** Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Search-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Search-Mailbox.md similarity index 86% rename from exchange/exchange-ps/exchange/Search-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Search-Mailbox.md index 942951ea8b..f9a7bd3a44 100644 --- a/exchange/exchange-ps/exchange/Search-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Search-Mailbox.md @@ -1,12 +1,13 @@ --- -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 -title: Search-Mailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/search-mailbox +schema: 2.0.0 +title: Search-Mailbox --- # Search-Mailbox @@ -16,7 +17,7 @@ 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 was 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/exchangepowershell/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). @@ -115,6 +116,9 @@ This example searches all mailboxes in your organization for messages that conta ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the mailbox to search. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -132,7 +136,6 @@ 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 Required: True Position: 1 @@ -142,6 +145,9 @@ Accept wildcard characters: False ``` ### -EstimateResultOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EstimateResultOnly switch returns only an estimate of the total number and size of messages. Messages aren't copied to the target mailbox. You don't need to specify a value with this switch. You can't use this switch with the TargetMailbox parameter. @@ -150,7 +156,6 @@ 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 Required: True Position: Named @@ -160,13 +165,15 @@ Accept wildcard characters: False ``` ### -TargetFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetFolder parameter specifies a folder name in which search results are saved in the target mailbox. The folder is created in the target mailbox upon execution. ```yaml Type: String Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -176,6 +183,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetMailbox parameter specifies the destination mailbox where search results are copied. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -195,7 +205,6 @@ 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 Required: True Position: Named @@ -205,6 +214,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -214,7 +226,6 @@ 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 Required: False Position: Named @@ -224,6 +235,9 @@ Accept wildcard characters: False ``` ### -DeleteContent + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + **Note**: You need to be assigned the Mailbox Import Export management role to use this switch. By default, this role isn't assigned to any role group (including Organization Management). Typically, you assign a role to a built-in or custom role group. The DeleteContent switch specifies that the messages returned by the search be permanently deleted from the source mailbox. You don't need to specify a value with this switch. @@ -236,7 +250,6 @@ 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 Required: False Position: Named @@ -246,13 +259,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,6 +277,9 @@ Accept wildcard characters: False ``` ### -DoNotIncludeArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DoNotIncludeArchive switch specifies that the user's archive mailbox shouldn't be included in the search. You don't need to specify a value for this switch. By default, the archive mailbox is always searched. @@ -272,7 +290,6 @@ 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 Required: False Position: Named @@ -282,6 +299,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you use the DeleteContent switch to permanently delete messages. @@ -290,7 +310,6 @@ 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 Required: False Position: Named @@ -300,13 +319,15 @@ Accept wildcard characters: False ``` ### -IncludeUnsearchableItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeUnsearchableItems switch includes items that couldn't be indexed by Exchange Search in the search results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,6 +337,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogLevel parameter specifies the logging level for the search. It can have one of the following values: - Suppress: No logs are kept. @@ -324,13 +348,12 @@ The LogLevel parameter specifies the logging level for the search. It can have o The default log level is Basic. -When you included this parameter, an email message is created and sent to the mailbox specified by the TargetMailbox parameter. The log file (which is a CSV-formatted file named Search Results.csv) is attached to this email message, and will be located in the folder specified by the TargetFolder parameter. The log file contains a row for each message that's included in the search results when you run the Search-Mailbox cmdlet. +When you included this parameter, an email message is created and sent to the mailbox specified by the TargetMailbox parameter. The log file (which is a CSV-formatted file named Search Results.csv) is attached to this email message, and is located in the folder specified by the TargetFolder parameter. The log file contains a row for each message that's included in the search results when you run the Search-Mailbox cmdlet. ```yaml Type: LoggingLevel Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,6 +363,9 @@ Accept wildcard characters: False ``` ### -LogOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogOnly switch performs a search, but only generates a log. Messages returned by the search aren't copied to the target mailbox. You don't need to specify a value with this switch. The logging level is specified by using the LogLevel parameter. @@ -348,7 +374,6 @@ 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 Required: False Position: Named @@ -358,6 +383,9 @@ Accept wildcard characters: False ``` ### -SearchDumpster + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SearchDumpster switch specifies whether to include the Recoverable Items folder in the search. The Recoverable items folder stores items that were deleted from the Deleted Items folder or items that were hard-deleted until they're purged from the mailbox database. By default, the Recoverable Items folder is always included in the search. To exclude the Recoverable Items folder from the search, use this exact syntax: `-SearchDumpster:$false`. @@ -366,7 +394,6 @@ 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 Required: False Position: Named @@ -376,6 +403,9 @@ Accept wildcard characters: False ``` ### -SearchDumpsterOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SearchDumpsterOnly switch specifies that only the Recoverable Items folder of the specified mailbox is searched. You don't need to specify a value with this switch. The Recoverable items folder stores items that were deleted from the Deleted Items folder or items that were hard-deleted until they're purged from the mailbox database. @@ -386,7 +416,6 @@ 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 Required: False Position: Named @@ -396,6 +425,9 @@ Accept wildcard characters: False ``` ### -SearchQuery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). For more information about KQL in Exchange, see [Message properties and search operators for In-Place eDiscovery](https://learn.microsoft.com/exchange/security-and-compliance/in-place-ediscovery/message-properties-and-search-operators). If this parameter is empty, all messages are returned. @@ -406,7 +438,6 @@ 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 Required: False Position: Named @@ -416,13 +447,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 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/ExchangePowerShell/Search-MailboxAuditLog.md similarity index 85% rename from exchange/exchange-ps/exchange/Search-MailboxAuditLog.md rename to exchange/exchange-ps/ExchangePowerShell/Search-MailboxAuditLog.md index f6ff4a429a..d94d150151 100644 --- a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Search-MailboxAuditLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/search-mailboxauditlog -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Search-MailboxAuditLog -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/search-mailboxauditlog +schema: 2.0.0 +title: Search-MailboxAuditLog --- # Search-MailboxAuditLog @@ -15,7 +16,7 @@ ms.reviewer: > [!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. +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Search-MailboxAuditLog cmdlet to search mailbox audit log entries matching the specified search terms. @@ -61,7 +62,7 @@ The Search-MailboxAuditLog cmdlet performs a synchronous search of mailbox audit In multi-geo environments, when you run this cmdlet in a different region from the mailbox that you're trying to search, you might receive the error, "An error occurred while trying to access the audit log." In this scenario, you need to anchor the PowerShell session to a user in the same region as the mailbox as described in [Connect directly to a geo location using Exchange Online PowerShell](https://learn.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo#connect-directly-to-a-geo-location-using-exchange-online-powershell). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -89,6 +90,9 @@ This example retrieves mailbox audit log entries for Ken Kwok's mailbox for acti ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies a single mailbox to retrieve mailbox audit log entries from. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -106,7 +110,6 @@ The Identity parameter specifies a single mailbox to retrieve mailbox audit log Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -116,6 +119,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -124,7 +130,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,6 +139,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -142,7 +150,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,17 +159,19 @@ Accept wildcard characters: False ``` ### -ExternalAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalAccess parameter specifies whether to return only audit log entries for mailbox access by users that are outside of your organization. In Exchange Online, this parameter returns audit log entries for mailbox access by Microsoft datacenter administrators. Valid values are: $true: Audit log entries for mailbox access by external users or Microsoft datacenter administrators are returned. -$false: Audit log entries for mailbox access by external users or Microsoft datacenter administrators are ignored. This is the default value. +$false: Audit log entries for mailbox access by external users or Microsoft datacenter administrators are ignored. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -172,6 +181,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to include Microsoft 365 Groups in the search. You don't need to specify a value with this switch. @@ -180,7 +192,6 @@ The GroupMailbox switch is required to include Microsoft 365 Groups in the searc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -190,6 +201,9 @@ Accept wildcard characters: False ``` ### -HasAttachments + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HasAttachments parameter filters the search by messages that have attachments. Valid values are: - $true: Only messages with attachments are included in the search. @@ -199,7 +213,6 @@ The HasAttachments parameter filters the search by messages that have attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,6 +222,9 @@ Accept wildcard characters: False ``` ### -IncludeInactiveMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeInactiveMailbox Description }} @@ -217,7 +233,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -227,6 +242,9 @@ Accept wildcard characters: False ``` ### -LogonTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LogonTypes parameter specifies the type of logons. Valid values are: - Admin: Audit log entries for mailbox access by administrator logons are returned. @@ -237,7 +255,6 @@ The LogonTypes parameter specifies the type of logons. Valid values are: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,6 +264,9 @@ Accept wildcard characters: False ``` ### -Mailboxes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailboxes parameter specifies the mailboxes to retrieve mailbox audit log entries from. You can use this parameter to search audit logs for multiple mailboxes. You enter multiple mailboxes separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -257,7 +277,6 @@ You can't use this parameter with the ShowDetails switch. Type: MultiValuedProperty Parameter Sets: MultipleMailboxesSearch Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -267,6 +286,9 @@ Accept wildcard characters: False ``` ### -Operations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Operations parameter filters the search results by the mailbox actions that are logged by mailbox audit logging. Valid values are: - AddFolderPermissions (Exchange 2019 and Exchange Online only. Although this value is accepted, it's already included in the UpdateFolderPermissions action and isn't audited separately.) @@ -299,7 +321,6 @@ You can enter multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -309,13 +330,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of mailbox audit log entries to return. Valid values include an integer from 1 through 250000. By default, 1000 entries are returned. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -325,6 +348,9 @@ Accept wildcard characters: False ``` ### -ShowDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowDetails switch retrieves the details of each log entry from the mailbox. You don't need to specify a value with this switch. By default, all fields for each returned log entry are displayed in a list view. @@ -335,7 +361,6 @@ You can't use this switch with the Mailboxes parameter. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -345,6 +370,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -353,7 +381,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md b/exchange/exchange-ps/ExchangePowerShell/Search-MessageTrackingReport.md similarity index 78% rename from exchange/exchange-ps/exchange/Search-MessageTrackingReport.md rename to exchange/exchange-ps/ExchangePowerShell/Search-MessageTrackingReport.md index 2044c603f3..6f8d6c7f06 100644 --- a/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Search-MessageTrackingReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/search-messagetrackingreport -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Search-MessageTrackingReport -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/search-messagetrackingreport +schema: 2.0.0 +title: Search-MessageTrackingReport --- # Search-MessageTrackingReport @@ -14,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see [Get-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchange/get-messagetrackingreport). The message tracking report cmdlets are used by the delivery reports feature. +Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see [Get-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetrackingreport). The message tracking report cmdlets are used by the delivery reports feature. -In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets). +In Exchange Online, delivery reports are replaced by message trace (the Get-MessageTraceV2 and Get-MessageTraceDetailV2 cmdlets). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -56,7 +57,7 @@ Search-MessageTrackingReport [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,6 +80,9 @@ This example returns the message tracking reports that the Help desk can analyze ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter scopes the search to the specified mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -100,7 +104,6 @@ When you use this parameter with the Sender parameter, the specified mailbox is Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Sender parameter specifies the email address of the message sender for messages that are sent to the mailbox that's specified by the Identity parameter. You need to use this parameter with the Identity parameter. @@ -118,7 +124,6 @@ You need to use this parameter with the Identity parameter. Type: SmtpAddress Parameter Sets: SearchAsSender Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -BypassDelegateChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BypassDelegateChecking switch allows Help desk staff and administrators to track messages for any user. You don't need to specify a value with this switch. By default, users can only track messages that they send or receive from their own mailbox. @@ -136,7 +144,6 @@ By default, users can only track messages that they send or receive from their o Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,6 +153,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -155,7 +165,6 @@ 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 Required: False Position: Named @@ -165,6 +174,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -173,7 +185,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,6 +194,9 @@ Accept wildcard characters: False ``` ### -DoNotResolve + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DoNotResolve switch specifies whether to prevent the resolution of email addresses to display names. You don't need to specify a value with this switch. Using this switch improves performance, but the lack of display names might make the results more difficult to interpret. @@ -191,7 +205,6 @@ Using this switch improves performance, but the lack of display names might make Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -201,13 +214,15 @@ Accept wildcard characters: False ``` ### -MessageEntryId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -217,13 +232,15 @@ 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, ""). + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -233,6 +250,9 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Recipients parameter filters the results by the email addresses of the specified recipients. You can specify multiple email addresses separated by commas. You can't use this parameter with the Sender parameter. @@ -241,7 +261,6 @@ You can't use this parameter with the Sender parameter. Type: SmtpAddress[] Parameter Sets: SearchAsRecipient Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -251,13 +270,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -267,13 +288,15 @@ Accept wildcard characters: False ``` ### -Subject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Subject parameter searches for messages with the specified Subject field value. If the value contains spaces, enclosed the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -283,6 +306,9 @@ Accept wildcard characters: False ``` ### -TraceLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TraceLevel parameter specifies the details to include in the results. Valid values are: - Low: Minimal additional data is returned, including servers that were accessed, timing, message tracking search result counts, and any error information. @@ -295,7 +321,6 @@ You only need to use this parameter for troubleshooting message tracking issues. Type: TraceLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -305,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md b/exchange/exchange-ps/ExchangePowerShell/Search-UnifiedAuditLog.md similarity index 87% rename from exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md rename to exchange/exchange-ps/ExchangePowerShell/Search-UnifiedAuditLog.md index a6e9e07249..6c403ffeeb 100644 --- a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Search-UnifiedAuditLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/search-unifiedauditlog applicable: Exchange Online, Exchange Online Protection -title: Search-UnifiedAuditLog -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/search-unifiedauditlog +schema: 2.0.0 +title: Search-UnifiedAuditLog --- # Search-UnifiedAuditLog @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Search-UnifiedAuditLog cmdlet to search the unified audit log. This log contains events from Exchange Online, SharePoint Online, OneDrive for Business, Microsoft Entra ID, Microsoft Teams, Power BI, and other Microsoft 365 services. You can search for all events in a specified date range, or you can filter the results based on specific criteria, such as the user who performed the action, the action, or the target object. +Use the Search-UnifiedAuditLog cmdlet to search the unified audit log. This log contains events from Exchange Online, SharePoint, OneDrive, Microsoft Entra ID, Microsoft Teams, Power BI, and other Microsoft 365 services. You can search for all events in a specified date range, or you can filter the results based on specific criteria, such as the user who performed the action, the action, or the target object. **Note**: By default, this cmdlet returns a subset of results containing up to 100 records. Use SessionCommand parameter with the ReturnLargeSet value to exhaustively search up to 50,000 results. The SessionCommand parameter causes the cmdlet to return unsorted data. @@ -47,13 +48,13 @@ The Search-UnifiedAuditLog cmdlet is available in Exchange Online PowerShell. Yo If you want to programmatically download data from the Microsoft 365 audit log, we recommend that you use the Microsoft 365 Management Activity API instead of using the Search-UnifiedAuditLog cmdlet in a PowerShell script. The Microsoft 365 Management Activity API is a REST web service that you can use to develop operations, security, and compliance monitoring solutions for your organization. For more information, see [Management Activity API reference](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-reference). -This cmdlet is available in Office 365 operated by 21Vianet, but it won't return any results. +This cmdlet is available in Office 365 operated by 21Vianet, but it doesn't return any results. The OutVariable parameter accepts objects of type ArrayList. Here's an example of how to use it: `$start = (Get-Date).AddDays(-1); $end = (Get-Date).AddDays(-0.5); $auditData = New-Object System.Collections.ArrayList; Search-UnifiedAuditLog -StartDate $start -EndDate $end -OutVariable +auditData | Out-Null` -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,7 +74,7 @@ Search-UnifiedAuditLog -StartDate "6/1/2023 8:00 AM" -EndDate "6/1/2023 6:00 PM" This example searches the unified audit log for all Exchange admin events from 8:00 AM to 6:00 PM on June 1, 2023. -**Note** If you use the same date for the StartDate and EndDate parameters, you need to include a timestamp; otherwise, no results will be returned because the date and time for the start and end dates will be the same. +**Note** If you use the same date for the StartDate and EndDate parameters, you need to include a timestamp; otherwise, no results are returned because the date and time for the start and end dates are the same. ### Example 3 ```powershell @@ -89,7 +90,7 @@ This example searches the unified audit log for all events from May 1, 2023 to M Search-UnifiedAuditLog -StartDate 5/1/2023 -EndDate 5/8/2023 -RecordType SharePointFileOperation -Operations FileAccessed -SessionId "WordDocs_SharepointViews" -SessionCommand ReturnLargeSet ``` -This example searches the unified audit log for any files accessed in SharePoint Online from May 1, 2023 to May 8, 2023. The data is returned in pages as the command is rerun sequentially while using the same SessionId value. +This example searches the unified audit log for any files accessed in SharePoint from May 1, 2023 to May 8, 2023. The data is returned in pages as the command is rerun sequentially while using the same SessionId value. ### Example 5 ```powershell @@ -101,6 +102,9 @@ This example searches the unified audit log from May 1, 2023 to May 8, 2023 for ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Entries are stored in the unified audit log in Coordinated Universal Time (UTC). If you specify a date/time value without a time zone, the value is in UTC. To specify a date/time value for this parameter, use either of the following options: @@ -114,7 +118,6 @@ If you don't include a timestamp in the value for this parameter, the default ti Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Entries are stored in the unified audit log in Coordinated Universal Time (UTC). If you specify a date/time value without a time zone, the value is in UTC. To specify a date/time value for this parameter, use either of the following options: @@ -137,7 +143,6 @@ If you don't include a timestamp in the value for this parameter, the default ti Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -147,6 +152,9 @@ Accept wildcard characters: False ``` ### -Formatted + +> Applicable: Exchange Online, Exchange Online Protection + The Formatted switch causes attributes that are normally returned as integers (for example, RecordType and Operation) to be formatted as descriptive strings. You don't need to specify a value with this switch. In addition, this switch makes AuditData more readable. @@ -155,7 +163,6 @@ In addition, this switch makes AuditData more readable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -165,13 +172,15 @@ Accept wildcard characters: False ``` ### -FreeText + +> Applicable: Exchange Online, Exchange Online Protection + The FreeText parameter filters the log entries by the specified text string. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -HighCompleteness + +> Applicable: Exchange Online, Exchange Online Protection + **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. @@ -191,7 +203,6 @@ When you use this switch, the query returns more complete search results but mig Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -201,13 +212,15 @@ Accept wildcard characters: False ``` ### -IPAddresses + +> Applicable: Exchange Online, Exchange Online Protection + The IPAddresses parameter filters the log entries by the specified IP addresses. You specify multiple IP addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -217,13 +230,15 @@ Accept wildcard characters: False ``` ### -LongerRetentionEnabled + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill LongerRetentionEnabled Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +248,9 @@ Accept wildcard characters: False ``` ### -ObjectIds + +> Applicable: Exchange Online, Exchange Online Protection + The ObjectIds parameter filters the log entries by object ID. The object ID is the target object that was acted upon, and depends on the RecordType and Operations values of the event. For example, for SharePoint operations, the object ID is the URL path to a file, folder, or site. To search logs in a site, add a wildcard (\*) in front of the site URL (for example, `"https://contoso.sharepoint.com/sites/test/*"`). @@ -247,7 +265,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,6 +274,9 @@ Accept wildcard characters: False ``` ### -Operations + +> Applicable: Exchange Online, Exchange Online Protection + The Operations parameter filters the log entries by operation. The available values for this parameter depend on the RecordType value. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -265,7 +285,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,13 +294,15 @@ Accept wildcard characters: False ``` ### -RecordType + +> Applicable: Exchange Online, Exchange Online Protection + The RecordType parameter filters the log entries by record type. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). ```yaml Type: AuditRecordType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -291,13 +312,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. The default value is 100, maximum is 5,000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,9 +330,12 @@ Accept wildcard characters: False ``` ### -SessionCommand + +> Applicable: Exchange Online, Exchange Online Protection + The SessionCommand parameter specifies how much information is returned and how it's organized. This parameter is required if you want to retrieve more than the default limit of 100 results. Valid values are: -- ReturnLargeSet: This value causes the cmdlet to return unsorted data. By using paging, you can access a maximum of 50,000 results. This is the recommended value if an ordered result is not required and has been optimized for search latency. +- ReturnLargeSet: This value causes the cmdlet to return unsorted data. By using paging, you can access a maximum of 50,000 results. This is the recommended value if an ordered result is not required and is optimized for search latency. - ReturnNextPreviewPage: This value causes the cmdlet to return data sorted on date. The maximum number of records returned through use of either paging or the ResultSize parameter is 5,000 records. **Note**: Always use the same SessionCommand value for a given SessionId value. Don't switch between ReturnLargeSet and ReturnNextPreviewPage for the same session ID. Otherwise, the output is limited to 10,000 results. @@ -318,7 +344,6 @@ The SessionCommand parameter specifies how much information is returned and how Type: UnifiedAuditSessionCommand Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -328,9 +353,12 @@ Accept wildcard characters: False ``` ### -SessionId -The SessionId parameter specifies an ID you provide in the form of a string to identify a command (the cmdlet and its parameters) that will be run multiple times to return paged data. The SessionId can be any string value you choose. -When the cmdlet is run sequentially with the same session ID, the cmdlet will return the data in sequential blocks of the size specified by ResultSize. +> Applicable: Exchange Online, Exchange Online Protection + +The SessionId parameter specifies an ID string to identify a command (the cmdlet and its parameters) that's run multiple times to return paged data. The SessionId can be any string value you choose. + +When the cmdlet is run sequentially with the same session ID, the cmdlet returns the data in sequential blocks of the size specified by ResultSize. For a given session ID, if you use the SessionCommand value ReturnLargeSet, and then you use the SessionCommand value ReturnNextPreviewPage, the results are limited to 10,000 records. To have all 50,000 records available, always use the ReturnLargeSet value each time your run the cmdlet for the same session ID. @@ -338,7 +366,6 @@ For a given session ID, if you use the SessionCommand value ReturnLargeSet, and Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -348,6 +375,9 @@ Accept wildcard characters: False ``` ### -SiteIds + +> Applicable: Exchange Online, Exchange Online Protection + 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 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`. @@ -356,7 +386,6 @@ To obtain the SiteId for a SharePoint site, append `/_api/site/id` to the URL of Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -366,6 +395,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Exchange Online, Exchange Online Protection + The UserIds parameter filters the log entries by the account (UserPrincipalName) of the user who performed the action. For example, laura@contoso.onmicrosoft.com. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -374,7 +406,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md b/exchange/exchange-ps/ExchangePowerShell/Send-TextMessagingVerificationCode.md similarity index 80% rename from exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md rename to exchange/exchange-ps/ExchangePowerShell/Send-TextMessagingVerificationCode.md index dd6524d3fd..6571b18577 100644 --- a/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md +++ b/exchange/exchange-ps/ExchangePowerShell/Send-TextMessagingVerificationCode.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/send-textmessagingverificationcode -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Send-TextMessagingVerificationCode -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/send-textmessagingverificationcode +schema: 2.0.0 +title: Send-TextMessagingVerificationCode --- # Send-TextMessagingVerificationCode ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Send-TextMessagingVerificationCode cmdlet to send a text messaging verification as part of configuring text message notifications on the mailbox. @@ -31,7 +32,7 @@ Send-TextMessagingVerificationCode [[-Identity] ] ## DESCRIPTION The Send-TextMessagingVerificationCode cmdlet generates a verification code and sends it to a user's mobile phone. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). This cmdlet returns an error if the user requests a verification code more than three times within a 24-hour period. @@ -61,6 +62,9 @@ This example sends the text messaging verification code to Tony Smith's mobile p ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox where you are trying to enable text messaging notifications. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -78,7 +82,6 @@ The Identity parameter specifies the mailbox where you are trying to enable text Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -97,7 +103,6 @@ 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 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -115,7 +123,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ADServerSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-ADServerSettings.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-ADServerSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ADServerSettings.md index fbc8c31fba..f1c61d1cfa 100644 --- a/exchange/exchange-ps/exchange/Set-ADServerSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ADServerSettings.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-adserversettings -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ADServerSettings -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/Set-ADServerSettings +schema: 2.0.0 +title: Set-ADServerSettings --- -# Set-AdServerSettings +# Set-ADServerSettings ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-AdServerSettings cmdlet to manage the Active Directory Domain Services (AD DS) environment in the current Exchange Management Shell session. The Set-AdServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. +Use the Set-ADServerSettings cmdlet to manage the Active Directory Domain Services (AD DS) environment in the current Exchange Management Shell session. The Set-ADServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -22,7 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ### Instance ``` -Set-AdServerSettings -RunspaceServerSettings +Set-ADServerSettings -RunspaceServerSettings [-Confirm] [-WhatIf] [] @@ -30,7 +31,7 @@ Set-AdServerSettings -RunspaceServerSettings ] +Set-ADServerSettings [-ConfigurationDomainController ] [-PreferredGlobalCatalog ] [-RecipientViewRoot ] [-SetPreferredDomainControllers ] @@ -42,7 +43,7 @@ Set-AdServerSettings [-ConfigurationDomainController ] ### SingleDC ``` -Set-AdServerSettings [[-PreferredServer] ] +Set-ADServerSettings [[-PreferredServer] ] [-RecipientViewRoot ] [-ViewEntireForest ] [-Confirm] @@ -51,20 +52,20 @@ Set-AdServerSettings [[-PreferredServer] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AdServerSettings -RecipientViewRoot "contoso.com/Marketing Users" +Set-ADServerSettings -RecipientViewRoot "contoso.com/Marketing Users" ``` This example sets the recipient scope to the Marketing Users OU in the contoso.com domain for the current session. ### Example 2 ```powershell -Set-AdServerSettings -ViewEntireForest $true -PreferredGlobalCatalog gc1.contoso.com +Set-ADServerSettings -ViewEntireForest $true -PreferredGlobalCatalog gc1.contoso.com ``` This example sets the scope of the current session to the entire forest and designates gc1.contoso.com as the preferred global catalog server. @@ -72,13 +73,15 @@ This example sets the scope of the current session to the entire forest and desi ## PARAMETERS ### -PreferredServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PreferredServer parameter specifies the FQDN of the domain controller to be used for this session. ```yaml Type: Fqdn Parameter Sets: SingleDC Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -RunspaceServerSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RunspaceServerSettings parameter specifies whether to pass an entire configuration object to the command to be processed. This parameter is useful in scripts where an entire object must be passed to the command. ```yaml Type: RunspaceServerSettingsPresentationObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -ConfigurationDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigurationDomainController parameter specifies the fully qualified domain name (FQDN) of the configuration domain controller to be used for reading Exchange configuration information in this session. ```yaml Type: Fqdn Parameter Sets: FullParams Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -129,7 +139,6 @@ 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 Required: False Position: Named @@ -139,13 +148,15 @@ Accept wildcard characters: False ``` ### -PreferredGlobalCatalog + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PreferredGlobalCatalog parameter specifies the FQDN of the global catalog server to be used for reading recipient information in this session. ```yaml Type: Fqdn Parameter Sets: FullParams Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -RecipientViewRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecipientViewRoot parameter specifies the organizational unit (OU) to include in the recipient scope for this session. When you specify a recipient scope with this parameter, only the recipients included in the scope are returned. To specify an OU, use the syntax `/`. ```yaml Type: String Parameter Sets: SingleDC, FullParams Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -SetPreferredDomainControllers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SetPreferredDomainControllers parameter specifies the list of domain controllers used to read information from Active Directory in this session. You must specify the FQDN of the domain controllers. Separate multiple domain controllers using commas. ```yaml Type: MultiValuedProperty Parameter Sets: FullParams Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -ViewEntireForest + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ViewEntireForest parameter specifies whether all the objects in the forest are viewed and managed in this session. Valid values are $true and $false. When you specify a value of $true, the value stored in the RecipientViewRoot parameter is removed and all of the recipients in the forest can be viewed and managed. @@ -195,7 +213,6 @@ When you specify a value of $true, the value stored in the RecipientViewRoot par Type: Boolean Parameter Sets: SingleDC, FullParams Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -205,13 +222,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ADSite.md b/exchange/exchange-ps/ExchangePowerShell/Set-ADSite.md similarity index 71% rename from exchange/exchange-ps/exchange/Set-ADSite.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ADSite.md index b2769997e3..d944da297f 100644 --- a/exchange/exchange-ps/exchange/Set-ADSite.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ADSite.md @@ -1,27 +1,28 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-adsite -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ADSite -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-adsite +schema: 2.0.0 +title: Set-ADSite --- -# Set-AdSite +# Set-ADSite ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-AdSite cmdlet to configure the Exchange settings of Active Directory sites. +Use the Set-ADSite cmdlet to configure the Exchange settings of Active Directory sites. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-AdSite [-Identity] +Set-ADSite [-Identity] [-Confirm] [-DomainController ] [-HubSiteEnabled ] @@ -32,13 +33,13 @@ Set-AdSite [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AdSite Default-First-Site-Name -HubSiteEnabled $true +Set-ADSite Default-First-Site-Name -HubSiteEnabled $true ``` This example configures the Active Directory site named Default-First-Site-Name as a hub site. @@ -46,13 +47,15 @@ This example configures the Active Directory site named Default-First-Site-Name ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the Active Directory site you want to modify. You can use any value that uniquely identifies the site. For example, you can use the name, GUID or distinguished name (DN) of the Active Directory site. ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -71,7 +77,6 @@ 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 Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,13 +104,15 @@ Accept wildcard characters: False ``` ### -HubSiteEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The HubSiteEnabled parameter specifies whether this site acts as a hub site. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,15 +122,18 @@ Accept wildcard characters: False ``` ### -InboundMailEnabled -The InboundMailEnabled parameter enables or disables receiving incoming messages for all the Exchange located in the Active Directory site. Typically, this parameter is used after Active Directory site failover or maintenance. -Valid input for this parameter is $true or $false. The default value is $true. If you set the value to $false, none of the Exchange servers in the Active Directory site will be able to receive incoming messages. +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The InboundMailEnabled parameter enables or disables receiving incoming messages for all Exchange servers located in the Active Directory site. Typically, you use this parameter after Active Directory site failover or maintenance. Valid values are: + +- $true: All Exchange servers in the Active Directory site can receive incoming email messages. This value is the default. +- $false: No Exchange servers in the Active Directory site can receive incoming email messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +143,15 @@ Accept wildcard characters: False ``` ### -PartnerId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +161,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AdSiteLink.md b/exchange/exchange-ps/ExchangePowerShell/Set-ADSiteLink.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-AdSiteLink.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ADSiteLink.md index 0bdcffba25..8714158ab8 100644 --- a/exchange/exchange-ps/exchange/Set-AdSiteLink.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ADSiteLink.md @@ -1,27 +1,28 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-adsitelink -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AdSiteLink -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/Set-ADSitelink +schema: 2.0.0 +title: Set-ADSiteLink --- -# Set-AdSiteLink +# Set-ADSiteLink ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to an Active Directory IP site link. You can also use this cmdlet to configure the maximum message size that can pass across an Active Directory IP site link. +Use the Set-ADSiteLink cmdlet to assign an Exchange-specific cost to an Active Directory IP site link. You can also use this cmdlet to configure the maximum message size that can pass across an Active Directory IP site link. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-AdSiteLink [-Identity] +Set-ADSiteLink [-Identity] [-Confirm] [-DomainController ] [-ExchangeCost ] @@ -32,15 +33,15 @@ Set-AdSiteLink [-Identity] ``` ## DESCRIPTION -By default, Microsoft Exchange determines the least cost routing path by using the cost assigned to the Active Directory IP site link. You can use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to the Active Directory IP site link. The Exchange-specific cost is a separate attribute used instead of the Active Directory-assigned cost to determine the least cost routing path. +By default, Microsoft Exchange determines the least cost routing path by using the cost assigned to the Active Directory IP site link. You can use the Set-ADSiteLink cmdlet to assign an Exchange-specific cost to the Active Directory IP site link. The Exchange-specific cost is a separate attribute used instead of the Active Directory-assigned cost to determine the least cost routing path. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-AdSiteLink DEFAULT_IP_SITE_LINK -ExchangeCost 25 -MaxMessageSize 10MB +Set-ADSiteLink DEFAULT_IP_SITE_LINK -ExchangeCost 25 -MaxMessageSize 10MB ``` This example assigns an Exchange-specific cost of 25 to the IP site link DEFAULT\_IP\_SITE\_LINK and configures a maximum message size limit of 10 MB on the IP site link. @@ -48,13 +49,15 @@ This example assigns an Exchange-specific cost of 25 to the IP site link DEFAULT ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name or GUID of the IP site link you want to modify. ```yaml Type: AdSiteLinkIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -73,7 +79,6 @@ 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 Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -91,7 +99,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -ExchangeCost + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExchangeCost parameter specifies an Exchange-specific cost for the IP site link. This cost is used instead of the Active Directory-assigned cost. To clear the value of the ExchangeCost parameter and revert to using the cost of the IP site link specified in Active Directory, set the value of the ExchangeCost parameter to $null. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +126,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxMessageSize parameter specifies the maximum size of a message that can pass across the Active Directory IP site link. The default value is unlimited. When you enter a value, qualify the value with one of the following units: @@ -127,7 +139,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 64 KB through Int64. To remove the message size limit on an Active Directory IP site link, enter a value of unlimited. @@ -135,7 +147,6 @@ The valid input range for this parameter is from 64 KB through Int64. To remove Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,13 +156,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a unique name for the IP site link. The name that you assign overwrites the current identity of the IP site link. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ATPBuiltInProtectionRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ATPBuiltInProtectionRule.md index cb0c15498e..d5c9dd43e2 100644 --- a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ATPBuiltInProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-atpbuiltinprotectionrule applicable: Exchange Online -title: Set-ATPBuiltInProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-atpbuiltinprotectionrule +schema: 2.0.0 +title: Set-ATPBuiltInProtectionRule --- # Set-ATPBuiltInProtectionRule @@ -37,7 +38,7 @@ For more information about preset security policies in PowerShell, see [Preset s > [!IMPORTANT] > Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,6 +66,9 @@ This example remove all exceptions from the Built-in protection preset security ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -77,7 +81,6 @@ The name of the only rule is ATP Built-In Protection Rule. Type: DehydrateableRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -112,7 +120,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -153,7 +165,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -182,7 +196,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -192,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ATPProtectionPolicyRule.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ATPProtectionPolicyRule.md index a2820af421..b623a6b8de 100644 --- a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-atpprotectionpolicyrule applicable: Exchange Online -title: Set-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-atpprotectionpolicyrule +schema: 2.0.0 +title: Set-ATPProtectionPolicyRule --- # Set-ATPProtectionPolicyRule @@ -42,7 +43,7 @@ For more information about preset security policies in PowerShell, see [Preset s > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,6 +64,9 @@ This example removes all conditions and exceptions from the Standard preset secu ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -75,7 +79,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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. @@ -110,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -151,7 +163,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -178,7 +192,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. We highly recommend that you use the default rule names for clarity and consistency. @@ -196,7 +212,6 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -206,6 +221,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. @@ -216,7 +234,6 @@ You must use the default value for the rule. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -226,13 +243,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -242,6 +261,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -257,7 +279,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -267,6 +288,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -284,7 +308,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -294,13 +317,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Set-AcceptedDomain.md similarity index 74% rename from exchange/exchange-ps/exchange/Set-AcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AcceptedDomain.md index 36e0eb7998..79b84fb443 100644 --- a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AcceptedDomain.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-accepteddomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-AcceptedDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-accepteddomain +schema: 2.0.0 +title: Set-AcceptedDomain --- # Set-AcceptedDomain ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-AcceptedDomain cmdlet to modify existing accepted domains in your organization. An accepted domain is any SMTP namespace for which an Exchange organization sends and receives email. @@ -41,7 +42,7 @@ Set-AcceptedDomain [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example makes the accepted domain Contoso the default accepted domain. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the accepted domain you want to modify. You can use any value that uniquely identifies the accepted domain object. For example, you can use the name, GUID or distinguished name (DN) of the accepted domain. ```yaml Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -AddressBookEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AddressBookEnabled parameter specifies whether to enable recipient filtering for this accepted domain. The default values are: @@ -83,7 +89,6 @@ The AddressBookEnabled parameter specifies whether to enable recipient filtering Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -CanHaveCloudCache + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill CanHaveCloudCache Description }} @@ -101,7 +109,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -120,7 +130,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -140,7 +152,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,9 +161,12 @@ Accept wildcard characters: False ``` ### -DomainType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DomainType parameter specifies the accepted domain type. Valid values are: -- Authoritative: This is the default value. Your organization is completely responsible for delivering email to recipients in the domain, and for generating non-delivery reports (also known as an NDRs, delivery system notifications, DSNs, or bounce messages) for unresolved recipients. +- Authoritative: This value is the default. Your organization is completely responsible for delivering email to recipients in the domain, and for generating non-delivery reports (also known as an NDRs, delivery system notifications, DSNs, or bounce messages) for unresolved recipients. - InternalRelay: This is a type of non-authoritative domain. Your organization receives email that's sent to recipients in the domain, but the messages are relayed to an external email system that's under your control. The external email system is responsible for generating NDRs for unresolved recipients. Use this value to treat messages that are sent to the domain as internal messages. - ExternalRelay: This is a type of non-authoritative domain that's available only in on-premises Exchange organizations. Your organization receives email that's sent to recipients in the domain, but the messages are relayed to an external email system that's completely outside of your control. The external email system is responsible for generating NDRs for unresolved recipients. @@ -162,7 +176,6 @@ The DomainType parameter specifies the accepted domain type. Valid values are: Type: AcceptedDomainType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,6 +185,9 @@ Accept wildcard characters: False ``` ### -EnableNego2Authentication + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -180,7 +196,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -190,11 +205,14 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MakeDefault parameter specifies whether the accepted domain is the default domain. Valid values are: $true or $false. -- $true: The accepted domain is the default domain. This is the default value for first accepted domain that's created in the organization. +- $true: The accepted domain is the default domain. This value is the default for first accepted domain that's created in the organization. - $false: The accepted domain isn't the default domain. This the default value for subsequent accepted domains. The default accepted domain is used in sender email addresses when the senders have only non-SMTP email addresses (for example, X.400 addresses). Non-SMTP email addresses are encapsulated in SMTP email addresses by using the Internet Mail Connector Encapsulated Address (IMCEA) encapsulation method. IMCEA encapsulation uses the default domain value in the SMTP email address. @@ -205,7 +223,6 @@ If you don't use non-SMTP email addresses in your organization, you don't need t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,13 +232,15 @@ Accept wildcard characters: False ``` ### -MatchSubDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MatchSubDomains parameter enables mail to be sent by and received from users on any subdomain of this accepted domain. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -231,6 +250,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Name parameter specifies a unique name for the accepted domain object. The default value is the DomainName property value. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -239,7 +261,6 @@ The Name parameter specifies a unique name for the accepted domain object. The d Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -249,17 +270,19 @@ Accept wildcard characters: False ``` ### -OutboundOnly + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The OutboundOnly parameter specifies whether this accepted domain is an internal relay domain for the on-premises deployment for organizations that have coexistence with a cloud-based organization. -The authoritative accepted domain for the on-premises deployment is configured as an internal relay accepted domain on the cloud side. If the on-premises deployment is using Exchange Online Protection, you need to set this parameter to $true for the accepted domain that represents your on-premises deployment. This parameter is used only if the DomainType parameter is set to Authoritative or InternalRelay. The default value is $false. +The authoritative accepted domain for the on-premises deployment is configured as an internal relay accepted domain on the cloud side. If the on-premises deployment is using cloud email protection, you need to set this parameter to $true for the accepted domain that represents your on-premises deployment. This parameter is used only if the DomainType parameter is set to Authoritative or InternalRelay. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -269,6 +292,9 @@ Accept wildcard characters: False ``` ### -PendingCompletion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -277,7 +303,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -287,6 +312,9 @@ Accept wildcard characters: False ``` ### -PendingRemoval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -295,7 +323,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -305,15 +332,22 @@ Accept wildcard characters: False ``` ### -SendingFromDomainDisabled + +> Applicable: Exchange Online, Exchange Online Protection + 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 @@ -323,15 +357,22 @@ Accept wildcard characters: False ``` ### -SendingToDomainDisabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. -{{ Fill SendingToDomainDisabled Description }} +The SendingToDomainDisabled specifies whether to prevent delivery of messages sent to recipients in the domain. Valid values are: + +- $true: Email sent to recipients in the domain is blocked. +- $false: Email sent to recipients in the domain isn't blocked. + +A common scenario is to prevent email delivery to recipients in your unused Micorost Online Email Routing Address (MOERA) domain (for example, contoso.onmicrosoft.com). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -341,13 +382,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-AccessToCustomerDataRequest.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AccessToCustomerDataRequest.md index a8ff53f2c3..aaedd38eb6 100644 --- a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AccessToCustomerDataRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-accesstocustomerdatarequest applicable: Exchange Online, Exchange Online Protection -title: Set-AccessToCustomerDataRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-accesstocustomerdatarequest +schema: 2.0.0 +title: Set-AccessToCustomerDataRequest --- # Set-AccessToCustomerDataRequest @@ -30,7 +31,7 @@ Set-AccessToCustomerDataRequest -ApprovalDecision Applicable: Exchange Online, Exchange Online Protection + The ApprovalDecision parameter specifies the approval decision for the customer lockbox request. Valid values are: - Approve @@ -54,7 +58,6 @@ The ApprovalDecision parameter specifies the approval decision for the customer Type: AccessToCustomerDataApproverDecision Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -RequestId + +> Applicable: Exchange Online, Exchange Online Protection + The RequestId parameter specifies the reference number of the customer lockbox request that you want to approve, deny, or cancel (for example, EXSR123456). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -ServiceName + +> Applicable: Exchange Online, Exchange Online Protection + The ServiceName parameter specifies the related service. Valid values are: - EOP @@ -107,7 +117,6 @@ The ServiceName parameter specifies the related service. Valid values are: Type: Microsoft.Exchange.Management.AccessToCustomerDataApproval.AccessToCustomerDataRequestServiceName Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAccessRule.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAccessRule.md index 3649c7062d..bf13bff81e 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAccessRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncdeviceaccessrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ActiveSyncDeviceAccessRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-activesyncdeviceaccessrule +schema: 2.0.0 +title: Set-ActiveSyncDeviceAccessRule --- # Set-ActiveSyncDeviceAccessRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-ActiveSyncDeviceAccessRule cmdlet to set the level of access for the rule. @@ -32,7 +33,7 @@ Set-ActiveSyncDeviceAccessRule [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the device access rule. ```yaml Type: ActiveSyncDeviceAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -AccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AccessLevel parameter specifies whether the devices are allowed, blocked or quarantined. ```yaml Type: DeviceAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -94,7 +102,6 @@ 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 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -112,7 +122,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAutoblockThreshold.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAutoblockThreshold.md index ba3b345abe..7eedcada2e 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAutoblockThreshold.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncdeviceautoblockthreshold -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ActiveSyncDeviceAutoblockThreshold -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-activesyncdeviceautoblockthreshold +schema: 2.0.0 +title: Set-ActiveSyncDeviceAutoblockThreshold --- # Set-ActiveSyncDeviceAutoblockThreshold @@ -35,20 +36,20 @@ Set-ActiveSyncDeviceAutoblockThreshold [-Identity] Your device has been blocked. "] +Set-ActiveSyncDeviceAutoblockThreshold -Identity "UserAgentChanges" BehaviorTypeIncidenceLimit 2 -BehaviorTypeIncidenceDuration 1440 -DeviceBlockDuration 1440 -AdminEmailInsert "Your device is blocked. "] ``` This example sets the autoblock threshold rule UserAgentChanges with several settings. It limits the number of accepted UserAgent changes to 2, specifies that the incidence duration is 1440 minutes and blocks the mobile device for 1440 minutes. Lastly, it inserts a message into the administrative email message sent to the user. ### Example 2 ```powershell -Set-ActiveSyncDeviceAutoblockThreshold -Identity "RecentCommands" BehaviorTypeIncidenceLimit 5 -BehaviorTypeIncidenceDuration 720 -DeviceBlockDuration 720 -AdminEmailInsert "Your device has been blocked. "] +Set-ActiveSyncDeviceAutoblockThreshold -Identity "RecentCommands" BehaviorTypeIncidenceLimit 5 -BehaviorTypeIncidenceDuration 720 -DeviceBlockDuration 720 -AdminEmailInsert "Your device is blocked. "] ``` This example sets the autoblock threshold rule RecentCommands with several settings. It limits the number of accepted RecentCommands changes to 5, specifies that the incidence duration is 720 minutes and blocks the mobile device for 720 minutes. Lastly, it inserts a message into the administrative email message sent to the user. @@ -56,13 +57,15 @@ This example sets the autoblock threshold rule RecentCommands with several setti ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the autoblock threshold rule. ```yaml Type: ActiveSyncDeviceAutoblockThresholdIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -AdminEmailInsert + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AdminEmailInsert parameter specifies the text to include in the email sent to the user when a mobile device triggers an autoblock threshold rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -BehaviorTypeIncidenceDuration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BehaviorTypeIncidenceDuration parameter specifies the interval (in minutes) within which the BehaviorType must occur to trigger the autoblock rule. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -BehaviorTypeIncidenceLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BehaviorTypeIncidenceLimit parameter specifies the number of occurrences of the behavior type needed to trigger blocking. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -129,7 +141,6 @@ 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 Required: False Position: Named @@ -139,13 +150,15 @@ Accept wildcard characters: False ``` ### -DeviceBlockDuration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeviceBlockDuration parameter specifies the length of time (in minutes) that the mobile device is blocked. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +186,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncMailboxPolicy.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncMailboxPolicy.md index 6a74c4ad63..eb05bd85e3 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncmailboxpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ActiveSyncMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-activesyncmailboxpolicy +schema: 2.0.0 +title: Set-ActiveSyncMailboxPolicy --- # Set-ActiveSyncMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-ActiveSyncMailboxPolicy cmdlet to apply a variety of Mobile Device mailbox policy settings to a server. You can set any of the parameters by using one command. @@ -89,7 +90,7 @@ With the Set-ActiveSyncMailboxPolicy cmdlet, you can set each parameter in a mai Some Microsoft Mobile Device mailbox policy settings require the mobile device to have specific built-in features that enforce these security and device management settings. If your organization allows all devices, you must set the AllowNonProvisionableDevices parameter to $true. This applies to devices that can't enforce all policy settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -117,13 +118,15 @@ This example sets several policy settings for the Mobile Device mailbox policy D ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Mobile Device mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -133,6 +136,9 @@ Accept wildcard characters: False ``` ### -AllowApplePushNotifications + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowApplePushNotifications parameter specifies whether push notifications are allowed to Apple mobile devices. @@ -141,7 +147,6 @@ The AllowApplePushNotifications parameter specifies whether push notifications a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -151,13 +156,15 @@ Accept wildcard characters: False ``` ### -AllowBluetooth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile phone. The available options are Disable, HandsfreeOnly, and Allow. The default value is Allow. ```yaml Type: BluetoothType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,13 +174,15 @@ Accept wildcard characters: False ``` ### -AllowBrowser -The AllowBrowser parameter indicates whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect third-party browsers. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AllowBrowser parameter indicates whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect non-Microsoft browsers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -183,13 +192,15 @@ Accept wildcard characters: False ``` ### -AllowCamera + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -199,13 +210,15 @@ Accept wildcard characters: False ``` ### -AllowConsumerEmail -The AllowConsumerEmail parameter specifies whether the mobile phone user can configure a personal email account on the mobile phone. The default value is $true. This parameter doesn't control access to emails using third-party mobile phone email programs. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AllowConsumerEmail parameter specifies whether the mobile phone user can configure a personal email account on the mobile phone. The default value is $true. This parameter doesn't control access to emails using non-Microsoft mobile phone email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -215,13 +228,15 @@ Accept wildcard characters: False ``` ### -AllowDesktopSync + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -231,13 +246,15 @@ Accept wildcard characters: False ``` ### -AllowExternalDeviceManagement + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the mobile phone. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,13 +264,15 @@ Accept wildcard characters: False ``` ### -AllowHTMLEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowHTMLEmail parameter specifies whether HTML email is enabled on the mobile phone. The default value is $true. If set to $false, all email is converted to plain text before synchronization occurs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -263,13 +282,15 @@ Accept wildcard characters: False ``` ### -AllowInternetSharing + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowInternetSharing parameter specifies whether the mobile phone can be used as a modem to connect a computer to the Internet. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -279,13 +300,15 @@ Accept wildcard characters: False ``` ### -AllowIrDA + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -295,13 +318,15 @@ Accept wildcard characters: False ``` ### -AllowMobileOTAUpdate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowMobileOTAUpdate parameter specifies whether the Exchange ActiveSync mailbox policy can be sent to the mobile phone over a cellular data connection. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -311,13 +336,15 @@ Accept wildcard characters: False ``` ### -AllowNonProvisionableDevices + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowNonProvisionableDevices parameter specifies whether all mobile phones can synchronize with the server running Exchange. When set to $true, the AllowNonProvisionableDevices parameter enables all mobile phones to synchronize with the Exchange server, regardless of whether the phone can enforce all the specific settings established in the Mobile Device mailbox policy. This also includes mobile phones managed by a separate device management system. When set to $false, this parameter blocks mobile phones that aren't provisioned from synchronizing with the Exchange server. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -327,13 +354,15 @@ Accept wildcard characters: False ``` ### -AllowPOPIMAPEmail -The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile phone. The default value is $true. This parameter doesn't control access by third-party email programs. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile phone. The default value is $true. This parameter doesn't control access by non-Microsoft email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -343,13 +372,15 @@ Accept wildcard characters: False ``` ### -AllowRemoteDesktop + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -359,13 +390,15 @@ Accept wildcard characters: False ``` ### -AllowSimpleDevicePassword + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSimpleDevicePassword parameter specifies whether a simple device password is allowed. A simple device password is a password that has a specific pattern, such as 1111 or 1234. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -375,13 +408,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMEEncryptionAlgorithmNegotiation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSMIMEEncryptionAlgorithmNegotiation parameter specifies whether the messaging application on the mobile phone can negotiate the encryption algorithm if a recipient's certificate doesn't support the specified encryption algorithm. ```yaml Type: SMIMEEncryptionAlgorithmNegotiationType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -391,13 +426,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMESoftCerts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -407,13 +444,15 @@ Accept wildcard characters: False ``` ### -AllowStorageCard + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowStorageCard parameter specifies whether the mobile phone can access information stored on a storage card. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -423,13 +462,15 @@ Accept wildcard characters: False ``` ### -AllowTextMessaging + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowTextMessaging parameter specifies whether text messaging is allowed from the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -439,13 +480,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedApplications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -455,13 +498,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedInstallationPackages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be executed on the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -471,13 +516,15 @@ Accept wildcard characters: False ``` ### -AllowWiFi + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowWiFi parameter specifies whether wireless Internet access is allowed on the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -487,13 +534,15 @@ Accept wildcard characters: False ``` ### -AlphanumericDevicePasswordRequired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlphanumericDevicePasswordRequired parameter specifies whether the password for the mobile phone must be alphanumeric. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -503,13 +552,15 @@ Accept wildcard characters: False ``` ### -ApprovedApplicationList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApprovedApplicationList parameter specifies a list of approved applications for the mobile phone. ```yaml Type: ApprovedApplicationCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -519,13 +570,15 @@ Accept wildcard characters: False ``` ### -AttachmentsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AttachmentsEnabled parameter specifies whether attachments can be downloaded. When set to $false, the AttachmentsEnabled parameter blocks the user from downloading attachments. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -535,6 +588,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -544,7 +600,6 @@ 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 Required: False Position: Named @@ -554,13 +609,15 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeviceEncryptionEnabled parameter specifies whether encryption is enabled. The DeviceEncryptionEnabled parameter, when set to $true, enables device encryption on the mobile phone. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -570,13 +627,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DevicePasswordEnabled parameter specifies whether a password is required. When set to $true, the DevicePasswordEnabled parameter requires that the user set a password for the mobile phone. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -586,13 +645,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordExpiration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DevicePasswordExpiration parameter specifies the length of time, in days, that a password can be used. After this length of time, a new password must be created. The format of the parameter is dd.hh.mm:ss, for example, 24.00:00 = 24 hours. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -602,13 +663,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordHistory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DevicePasswordHistory parameter specifies the number of previously used passwords to store. When a user creates a password, the user can't reuse a stored password that was previously used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -618,13 +681,15 @@ Accept wildcard characters: False ``` ### -DevicePolicyRefreshInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DevicePolicyRefreshInterval parameter specifies how often the policy is sent from the server to the mobile phone. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -634,6 +699,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -642,7 +710,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -652,13 +719,15 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -668,13 +737,15 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault parameter specifies whether this policy is the default Mobile Device mailbox policy. The default value is $false. If another policy is currently set as the default, setting this parameter replaces the old default policy with this policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -684,13 +755,15 @@ Accept wildcard characters: False ``` ### -IsDefaultPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault parameter specifies whether this policy is the default Mobile Device mailbox policy. The default value is $false. If another policy is currently set as the default, setting this parameter replaces the old default policy with this policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -700,13 +773,15 @@ Accept wildcard characters: False ``` ### -MaxAttachmentSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile phone. The default value is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -716,6 +791,9 @@ Accept wildcard characters: False ``` ### -MaxCalendarAgeFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the device. The value is specified by entering one of the following values: - All @@ -729,7 +807,6 @@ The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days Type: CalendarAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -739,13 +816,15 @@ Accept wildcard characters: False ``` ### -MaxDevicePasswordFailedAttempts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxDevicePasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile phone. You can enter any number from 4 through 16. The default value is 8. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -755,6 +834,9 @@ Accept wildcard characters: False ``` ### -MaxEmailAgeFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the mobile phone. The value is specified by entering one of the following values. - All @@ -768,7 +850,6 @@ The MaxEmailAgeFilter parameter specifies the maximum number of days of email it Type: EmailAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -778,13 +859,15 @@ Accept wildcard characters: False ``` ### -MaxEmailBodyTruncationSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile phone. The value is specified in kilobytes (KB). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -794,13 +877,15 @@ Accept wildcard characters: False ``` ### -MaxEmailHTMLBodyTruncationSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are synchronized to the mobile phone. The value is specified in KB. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -810,13 +895,15 @@ Accept wildcard characters: False ``` ### -MaxInactivityTimeDeviceLock + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxInactivityTimeDeviceLock parameter specifies the length of time that the mobile phone can be inactive before the password is required to reactivate it. You can enter any interval between 30 seconds and 1 hour. The default value is 15 minutes. The format of the parameter is hh.mm:ss, for example, 15:00 = 15 minutes. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -826,13 +913,15 @@ Accept wildcard characters: False ``` ### -MinDevicePasswordComplexCharacters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MinDevicePasswordComplexCharacters parameter specifies the minimum number of complex characters required in a mobile phone password. A complex character isn't a letter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -842,13 +931,15 @@ Accept wildcard characters: False ``` ### -MinDevicePasswordLength + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MinDevicePasswordLength parameter specifies the minimum number of characters in the device password. You can enter any number from 1 through 16. The maximum length a password can be is 16 characters. The default value is 4. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -858,13 +949,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the friendly name of the Mobile Device mailbox policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -874,13 +967,15 @@ Accept wildcard characters: False ``` ### -PasswordRecoveryEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile phone is stored on an Exchange server. When set to $true, the PasswordRecoveryEnabled parameter enables you to store the recovery password for the mobile phone on an Exchange server. The default value is $false. The recovery password can be viewed from either Outlook on the web or the Exchange admin center. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -890,13 +985,15 @@ Accept wildcard characters: False ``` ### -RequireDeviceEncryption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -906,13 +1003,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptedSMIMEMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -922,13 +1021,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptionSMIMEAlgorithm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message. ```yaml Type: EncryptionSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -938,13 +1039,15 @@ Accept wildcard characters: False ``` ### -RequireManualSyncWhenRoaming + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireManualSyncWhenRoaming parameter specifies whether the mobile phone must synchronize manually while roaming. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -954,13 +1057,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEAlgorithm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message. ```yaml Type: SignedSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -970,13 +1075,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSignedSMIMEMessages parameter specifies whether the mobile phone must send signed S/MIME messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -986,13 +1093,15 @@ Accept wildcard characters: False ``` ### -RequireStorageCardEncryption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireStorageCardEncryption parameter specifies whether storage card encryption is enabled for the mailbox policy. Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1002,13 +1111,15 @@ Accept wildcard characters: False ``` ### -UnapprovedInROMApplicationList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UnapprovedInROMApplicationList parameter contains a list of applications that can't be run in ROM. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1018,13 +1129,15 @@ Accept wildcard characters: False ``` ### -UNCAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled. Access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1034,13 +1147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1050,13 +1165,15 @@ Accept wildcard characters: False ``` ### -WSSAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled. Access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncOrganizationSettings.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncOrganizationSettings.md index 78b5bcd932..c020f0c314 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncOrganizationSettings.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncorganizationsettings -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ActiveSyncOrganizationSettings -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-activesyncorganizationsettings +schema: 2.0.0 +title: Set-ActiveSyncOrganizationSettings --- # Set-ActiveSyncOrganizationSettings ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-ActiveSyncOrganizationSettings cmdlet to set the Exchange ActiveSync settings for the organization. @@ -37,7 +38,7 @@ Set-ActiveSyncOrganizationSettings [[-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the ActiveSync organization settings object that you want to modify. The default name of this object is Mobile Mailbox Settings. ```yaml Type: ActiveSyncOrganizationSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -AdminMailRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AdminMailRecipients parameter specifies the email addresses of the administrators for reporting purposes. 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"`. @@ -77,7 +83,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -AllowAccessForUnSupportedPlatform + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -103,18 +110,20 @@ Accept wildcard characters: False ``` ### -AllowRMSSupportForUnenlightenedApps + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The AllowRMSSupportForUnenlightenedApps parameter specifies whether to allow Rights Management Services (RMS) protected messages for ActiveSync clients that don't support RMS. Valid values are: - $true -- $false (This is the default value) +- $false (default value) ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -133,7 +145,6 @@ 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 Required: False Position: Named @@ -143,9 +154,12 @@ Accept wildcard characters: False ``` ### -DefaultAccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultAccessLevel parameter specifies the access level for new and existing device partnerships. Valid values are: -- Allow (This is the default value) +- Allow (default value) - Block - Quarantine @@ -155,7 +169,6 @@ If you change this value from Allow to Block or Quarantine, all existing connect Type: DeviceAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,6 +178,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -173,7 +189,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,6 +198,9 @@ Accept wildcard characters: False ``` ### -EnableMobileMailboxPolicyWhenCAInplace + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill EnableMobileMailboxPolicyWhenCAInplace Description }} @@ -191,7 +209,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -201,6 +218,9 @@ Accept wildcard characters: False ``` ### -OtaNotificationMailInsert + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OtaNotificationMailInsert parameter specifies the text to include in an email message that's sent to users who need to update their older devices to use the new Exchange ActiveSync features in Microsoft Exchange. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -209,7 +229,6 @@ The maximum length is 256 characters. If the value contains spaces, enclose the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -TenantAdminPreference + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill TenantAdminPreference Description }} @@ -227,7 +249,6 @@ This parameter is available only in the cloud-based service. Type: TenantAdminPreference Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -237,6 +258,9 @@ Accept wildcard characters: False ``` ### -UserMailInsert + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UserMailInsert parameter specifies an informational footer that's added to the email message sent to users when their mobile device isn't synchronized because the device is quarantined. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -245,7 +269,6 @@ The maximum length is 256 characters. If the value contains spaces, enclose the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -255,13 +278,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncVirtualDirectory.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncVirtualDirectory.md index e46e295975..70e34052a8 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ActiveSyncVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-activesyncvirtualdirectory +schema: 2.0.0 +title: Set-ActiveSyncVirtualDirectory --- # Set-ActiveSyncVirtualDirectory @@ -54,7 +55,7 @@ Set-ActiveSyncVirtualDirectory [-Identity] ## DESCRIPTION The Set-ActiveSyncVirtualDirectory cmdlet configures a variety of settings on the virtual directory used for Exchange ActiveSync including security, authentication, and internal and external URL settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,6 +83,9 @@ This example configures the external URL on the default Exchange ActiveSync virt ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the ActiveSync virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -94,7 +98,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -104,13 +107,15 @@ Accept wildcard characters: False ``` ### -ActiveSyncServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveSyncServer parameter specifies the URL of the Mailbox server. This value is in the following format: https://servername/Microsoft-Server-ActiveSync. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -BadItemReportingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BadItemReportingEnabled parameter specifies whether items that can't be synchronized should be reported to the user. If set to $true, the user receives a notification when an item can't be synchronized to the mobile phone. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,16 +143,18 @@ Accept wildcard characters: False ``` ### -BasicAuthEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: -- $true: Basic authentication is enabled. This is the default value. +- $true: Basic authentication is enabled. This value is the default. - $false: Basic authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +164,15 @@ Accept wildcard characters: False ``` ### -ClientCertAuth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClientCertAuth parameter specifies the status of client certificate authentication. By default, client certificate authentication is disabled. The default setting is Ignore. ```yaml Type: ClientCertAuthTypes Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +182,15 @@ Accept wildcard characters: False ``` ### -CompressionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CompressionEnabled parameter is a Boolean value that identifies the compression applied to the specified Exchange ActiveSync virtual directory. The default setting is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,6 +200,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -196,7 +212,6 @@ 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 Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,19 +239,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -244,16 +263,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,10 +284,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -275,7 +299,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -285,6 +308,9 @@ Accept wildcard characters: False ``` ### -ExternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalAuthenticationMethods parameter restricts the authentication methods that can be used to connect to the virtual directory from outside the firewall. Valid values are: - Adfs @@ -314,7 +340,6 @@ Although you can specify any of these values, whether or not the authentication Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,13 +349,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,13 +367,15 @@ Accept wildcard characters: False ``` ### -InstallIsapiFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InstallIsapiFilter parameter specifies whether the Internet Server API (ISAPI) filter is installed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +385,15 @@ Accept wildcard characters: False ``` ### -InternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalAuthenticationMethods parameter specifies the authentication methods supported by the server that contains the virtual directory when access is requested from inside the network firewall. If this parameter isn't set, all authentication methods can be used. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -372,13 +403,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -388,13 +421,15 @@ Accept wildcard characters: False ``` ### -MobileClientCertificateAuthorityURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MobileClientCertificateAuthorityURL parameter specifies the URL for the certification authority (CA) used by the mobile phone. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -404,13 +439,15 @@ Accept wildcard characters: False ``` ### -MobileClientCertificateProvisioningEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MobileClientCertificateProvisioningEnabled parameter specifies whether the Autodiscover service returns the Certificate Services server URL in the XML file. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -420,13 +457,15 @@ Accept wildcard characters: False ``` ### -MobileClientCertTemplateName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MobileClientCertTemplateName parameter specifies the template name for the client certificate. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -436,13 +475,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of the Exchange ActiveSync virtual directory. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -452,13 +493,15 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsActionForUnknownServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoteDocumentsActionForUnknownServers parameter specifies the action that occurs when a Microsoft Windows SharePoint Services or Microsoft Windows file share request comes in via Exchange ActiveSync. When a request arrives, Exchange ActiveSync looks for the requested host name in the Allow and Block lists. If the host name isn't found in either list, the action specified in this parameter, either Block or Allow, is performed. ```yaml Type: RemoteDocumentsActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,13 +511,15 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsAllowedServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoteDocumentsAllowedServers parameter is a multivalued property that lists all the allowed servers for remote document access. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -484,13 +529,15 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsBlockedServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoteDocumentsBlockedServers parameter is a multivalued property that lists all the blocked servers for remote document access. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -500,13 +547,15 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsInternalDomainSuffixList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoteDocumentsInternalDomainSuffixList parameter is used in organizations that don't run Windows Internet Name Service (WINS) in their network. In these environments, you can specify one or more FQDNs that Exchange ActiveSync treats as internal when a request for remote file access is received. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -516,13 +565,15 @@ Accept wildcard characters: False ``` ### -SendWatsonReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendWatsonReport parameter specifies whether a Watson report is sent for errors and events. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -532,13 +583,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -548,13 +601,15 @@ Accept wildcard characters: False ``` ### -WindowsAuthEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsAuthEnabled parameter specifies whether Integrated Windows authentication is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AdaptiveScope.md b/exchange/exchange-ps/ExchangePowerShell/Set-AdaptiveScope.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-AdaptiveScope.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AdaptiveScope.md index 6560f5f4ab..e4178c71f3 100644 --- a/exchange/exchange-ps/exchange/Set-AdaptiveScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AdaptiveScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-adaptivescope applicable: Security & Compliance -title: Set-AdaptiveScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-adaptivescope +schema: 2.0.0 +title: Set-AdaptiveScope --- # Set-AdaptiveScope @@ -58,6 +59,9 @@ This example modifies the filter in exiting adaptive scope named Project X. The ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the adaptive scope that you want to modify. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the adaptive scope that you want to modify. You Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AdministrativeUnit + +> Applicable: Security & Compliance + {{ Fill AdministrativeUnit Description }} ```yaml Type: Guid -Parameter Sets: AdministrativeUnit +Parameter Sets: Default, AdaptiveScopeRawQuery, AdministrativeUnit Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -93,20 +98,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Guid -Parameter Sets: Default, AdaptiveScopeRawQuery -Aliases: -Applicable: Security & Compliance +### -FilterConditions -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Security & Compliance -### -FilterConditions The FilterConditions parameter specifies the conditions that are included in the dynamic boundary. Valid syntax and values depend of the value of the LocationType parameter: - User or Group: Active Directory attributes. For example, for the condition "('Country or region' equals 'US' or 'Canada') and 'Department' equals 'Finance'", use the following syntax: `@{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "Canada"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "Equals"; "Name" = "Department"}); "Conjunction" = "And"}` @@ -118,7 +113,6 @@ You can't use this parameter with the RawQuery parameter. Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -128,6 +122,9 @@ Accept wildcard characters: False ``` ### -RawQuery + +> Applicable: Security & Compliance + The RawQuery parameter switches the scope to advanced query mode. You use OPATH filter syntax for advanced query mode. You can't use this parameter with the FilterConditions parameter. @@ -136,7 +133,6 @@ You can't use this parameter with the FilterConditions parameter. Type: String Parameter Sets: AdaptiveScopeRawQuery Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -146,13 +142,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-AddressBookPolicy.md similarity index 68% rename from exchange/exchange-ps/exchange/Set-AddressBookPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AddressBookPolicy.md index 6438ed69a2..d9cbb93845 100644 --- a/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AddressBookPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-addressbookpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-AddressBookPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-addressbookpolicy +schema: 2.0.0 +title: Set-AddressBookPolicy --- # Set-AddressBookPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-AddressBookPolicy cmdlet to change the settings of an address book policy. @@ -36,7 +37,7 @@ Set-AddressBookPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example changes the OAB that the address book policy All Fabrikam ABP uses ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the address book policy that you want to modify. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -66,13 +69,23 @@ Accept wildcard characters: False ``` ### -AddressLists -The AddressLists parameter specifies the address lists that will be used by mailbox users who are assigned this address book policy. This parameter accepts multiple values, which should be separated by a comma. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AddressLists parameter specifies the address lists for mailbox users who are assigned this address book policy. You can use any value that uniquely identifies the address list. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +You can find the identify values of address lists by using the Get-AddressList cmdlet. ```yaml Type: AddressListIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -82,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -91,7 +107,6 @@ 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 Required: False Position: Named @@ -101,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -109,7 +127,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,13 +136,23 @@ Accept wildcard characters: False ``` ### -GlobalAddressList -The GlobalAddressList parameter specifies the identity of the global address list (GAL) that will be used by mailbox users who are assigned this address book policy. You can specify only one GAL for each address book policy. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The GlobalAddressList parameter specifies the GAL for mailbox users who are assigned this address book policy. You can use any value that uniquely identifies the GAL. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can find the identify values of GALs by using the Get-GlobalAddressList cmdlet. + +You can specify only one GAL for each address book policy. ```yaml Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +162,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name that you want this address book policy to be called. Use this parameter to change the name of the address book policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -151,13 +180,23 @@ Accept wildcard characters: False ``` ### -OfflineAddressBook -The OfflineAddressBook parameter specifies the identity of the offline address book (OAB) that will be used by mailbox users who are assigned this address book policy. You can specify only one OAB for each address book policy. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The OfflineAddressBook parameter specifies the OAB for mailbox users who are assigned this address book policy. You can use any value that uniquely identifies the OAB. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can find the identify values of OABs by using the Get-OfflineAddressBook cmdlet. + +You can specify only one OAB for each address book policy. ```yaml Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,9 +206,12 @@ Accept wildcard characters: False ``` ### -RoomList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 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/exchangepowershell/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: @@ -185,7 +227,6 @@ A valid value for this parameter is one address list. You can use any value that Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -195,13 +236,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/Set-AddressList.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AddressList.md index 686f5b3185..bb34e97f03 100644 --- a/exchange/exchange-ps/exchange/Set-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AddressList.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-addresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-AddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-addresslist +schema: 2.0.0 +title: Set-AddressList --- # Set-AddressList ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-AddressList cmdlet to modify existing address lists. @@ -67,7 +68,7 @@ To create flexible filters that use any available recipient property and that ar You can't use this cmdlet to replace a precanned filter with a custom OPATH filter, or vice-versa. You can only modify the existing filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -88,6 +89,9 @@ This example modifies the type of recipients and the department of the recipient ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the address list that you want to modify. You can use any value that uniquely identifies the address list. For example: - Name @@ -99,7 +103,6 @@ The Identity parameter specifies the address list that you want to modify. You c Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -121,7 +127,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -131,6 +136,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -143,7 +151,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -153,6 +160,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -165,7 +175,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -175,6 +184,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -187,7 +199,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,6 +208,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -209,7 +223,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +232,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -231,7 +247,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -241,6 +256,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -253,7 +271,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -263,6 +280,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -275,7 +295,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -285,6 +304,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -297,7 +319,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -307,6 +328,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -319,7 +343,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -329,6 +352,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -341,7 +367,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -351,6 +376,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -363,7 +391,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -373,6 +400,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -385,7 +415,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -395,6 +424,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -407,7 +439,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -417,6 +448,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -429,7 +463,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -439,6 +472,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -451,7 +487,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -461,6 +496,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -473,7 +511,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -483,6 +520,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -495,7 +535,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -505,6 +544,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -514,7 +556,6 @@ 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 Required: False Position: Named @@ -524,13 +565,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -540,6 +583,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -548,7 +594,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -558,6 +603,9 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. @@ -566,7 +614,6 @@ The ForceUpgrade switch suppresses the confirmation message that appears if the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -576,6 +623,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -591,7 +641,6 @@ You can specify multiple values separated by commas. When you use multiple value Type: WellKnownRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -601,13 +650,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a unique name for the address list. The maximum length is 64 characters, and it can't include a carriage return or a backslash (\\). If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -617,6 +668,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -632,7 +686,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -642,6 +695,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -657,7 +713,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -667,13 +722,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md b/exchange/exchange-ps/ExchangePowerShell/Set-AddressRewriteEntry.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AddressRewriteEntry.md index 09836f6007..8fef843742 100644 --- a/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AddressRewriteEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-addressrewriteentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AddressRewriteEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-addressrewriteentry +schema: 2.0.0 +title: Set-AddressRewriteEntry --- # Set-AddressRewriteEntry @@ -59,13 +60,15 @@ This example changes the existing address rewrite entry named "Address entry for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the address rewrite entry you want to modify. You can specify the name or GUID of the address rewrite entry. ```yaml Type: AddressRewriteEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -84,7 +90,6 @@ 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 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -102,7 +110,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -ExceptionList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExceptionList parameter specifies the domain names that should be excluded from address rewriting when the InternalAddress parameter contains a value that specifies multiple domain names. You can separate multiple domain names included with the ExceptionList parameter with commas. For more information about how to add values to or remove values from multivalued properties, see [Modifying multivalued properties](https://learn.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -ExternalAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalAddress parameter specifies the final email addresses that you want. If the InternalAddress parameter specifies a single email address (chris@contoso.com), the ExternalAddress parameter must also specify a single email address (support@contoso.com). If the InternalAddress parameter specifies a single domain (contoso.com) or a domain and all subdomains (\*.contoso.com), the ExternalAddress parameter must specify a single domain (fabrikam.com). You can't use the wildcard character (\*) with the ExternalAddress parameter. @@ -136,7 +148,6 @@ You can't use the wildcard character (\*) with the ExternalAddress parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -InternalAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalAddress parameter specifies the original email addresses that you want to change. You can use the following values: - Single email address: david@contoso.com @@ -156,7 +170,6 @@ The InternalAddress parameter specifies the original email addresses that you wa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a unique name for this address rewrite entry. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,6 +197,9 @@ Accept wildcard characters: False ``` ### -OutboundOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OutboundOnly parameter enables or disables outbound-only address rewriting. Valid input for this parameter is $true or $false. The value $true means address rewriting occurs in outbound mail only. The value $false means address rewriting occurs on outbound mail and also on inbound mail (rewritten email addresses are changed back to the original email addresses in inbound mail). The default value is $false. You must set this parameter to $true if the InternalAddress parameter contains the wildcard character to rewrite addresses in a domain and all subdomains (\*.contoso.com). @@ -192,7 +210,6 @@ Also, when you configure outbound-only address rewriting, you need to configure Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,13 +219,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-AdminAuditLogConfig.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AdminAuditLogConfig.md index 6812c3cc6d..0a6ed0dac7 100644 --- a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AdminAuditLogConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-adminauditlogconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-AdminAuditLogConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-adminauditlogconfig +schema: 2.0.0 +title: Set-AdminAuditLogConfig --- # Set-AdminAuditLogConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-AdminAuditLogConfig cmdlet to configure the administrator audit logging configuration settings. @@ -43,11 +44,11 @@ When audit logging is enabled, a log entry is created for each cmdlet run, exclu The Set-AdminAuditLogConfig, Enable-CmdletExtensionAgent, and Disable-CmdletExtensionAgent cmdlets are logged when they're run regardless of whether administrator audit logging is enabled or disabled. -Administrator audit logging relies on Active Directory replication to replicate the configuration settings you specify to the domain controllers in your organization. Depending on your replication settings, the changes you make may not be immediately applied to all Exchange servers in your organization. +Administrator audit logging relies on Active Directory replication to replicate the configuration settings you specify to the domain controllers in your organization. Depending on your replication settings, the changes you make might not be immediately applied to all Exchange servers in your organization. -Changes to the audit log configuration may take up to 60 minutes to be applied on computers that have the Exchange Management Shell open at the time a configuration change is made. If you want to apply the changes immediately, close and reopen the Exchange Management Shell on each computer. +Changes to the audit log configuration might take up to 60 minutes to be applied on computers that have the Exchange Management Shell open at the time a configuration change is made. If you want to apply the changes immediately, close and reopen the Exchange Management Shell on each computer. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,6 +76,9 @@ This example enables administrator audit logging only for specific parameters th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -83,7 +87,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AdminAuditLogAgeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AdminAuditLogAgeLimit parameter specifies how long each log entry should be kept before it's deleted. The default age limit is 90 days. @@ -109,7 +115,6 @@ Setting the age limit to 0 purges the audit log of all entries. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -AdminAuditLogCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AdminAuditLogCmdlets parameter specifies which cmdlets should be audited. You can specify one or more cmdlets, separated by commas. You can also use the wildcard character (\*) to match multiple cmdlets in one or more of the entries in the cmdlet list. To audit all cmdlets, specify only the wildcard character (\*). @@ -127,7 +135,6 @@ The AdminAuditLogCmdlets parameter specifies which cmdlets should be audited. Yo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,11 +144,14 @@ Accept wildcard characters: False ``` ### -AdminAuditLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AdminAuditLogEnabled parameter specifies whether administrator audit logging is enabled. Valid values are: -- $true: Administrator audit logging is enabled. This is the default value. +- $true: Administrator audit logging is enabled. This value is the default. - $false: Administrator audit logging is disabled. You must specify an administrator audit log mailbox before you enable logging. @@ -152,7 +162,6 @@ Changes to the administrator audit log configuration are always logged, regardle Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -AdminAuditLogExcludedCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AdminAuditLogExcludedCmdlets parameter specifies which cmdlets should be excluded from auditing. Use this parameter if you want to exclude specific cmdlets you don't want to audit even if they match a wildcard string specified in the AdminAuditLogCmdlets parameter. @@ -174,7 +186,6 @@ If you want to clear the list, specify a value of $null. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -AdminAuditLogParameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AdminAuditLogParameters parameter specifies which parameters should be audited on the cmdlets you specified using the AdminAuditLogCmdlets parameter. You can specify one or more parameters, separated by commas. You can also use the wildcard character (\*) to match multiple parameters in one or more of the entries in the parameters list. To audit all parameters, specify only the wildcard character (\*). @@ -192,7 +206,6 @@ The AdminAuditLogParameters parameter specifies which parameters should be audit Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +215,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -211,7 +227,6 @@ 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, Exchange Online Protection Required: False Position: Named Default value: None @@ -220,6 +235,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -228,7 +246,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,6 +255,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -246,7 +266,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named Default value: None @@ -255,18 +274,20 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LogLevel parameter specifies whether additional properties should be included in the log entries. Valid values are: -- None: The CmdletName, ObjectName, Parameters (values), and the Caller, Succeeded and RunDate properties are included in log entries. This is the default value. +- None: The CmdletName, ObjectName, Parameters (values), and the Caller, Succeeded and RunDate properties are included in log entries. This value is the default. - Verbose: The ModifiedProperties (old and new) and ModifiedObjectResolvedName properties are also included in log entries. ```yaml Type: AuditLogLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,6 +297,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Name parameter specifies the name of the AdminAuditLogConfig object. @@ -286,7 +310,6 @@ You don't need to specify this parameter when you configure administrator audit Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,12 +319,15 @@ Accept wildcard characters: False ``` ### -TestCmdletLoggingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The TestCmdletLoggingEnabled parameter specifies whether test cmdlets (cmdlet names that begin with the verb Test) results are included in admin audit logging. Valid values are: - $true: Test cmdlets are included in admin audit logging. -- $false: Test cmdlets aren't included in admin audit logging. This is the default value. +- $false: Test cmdlets aren't included in admin audit logging. This value is the default. Test cmdlets can produce a large amount of information. As such, you should only enable logging of test cmdlets for a short period of time. @@ -309,7 +335,6 @@ Test cmdlets can produce a large amount of information. As such, you should only Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -319,18 +344,20 @@ Accept wildcard characters: False ``` ### -UnifiedAuditLogIngestionEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The UnifiedAuditLogIngestionEnabled parameter specifies whether to enable or disable the recording of user and admin activities in the Microsoft 365 audit log. Valid values are: -- $true: User and admin activities are recorded in the Microsoft 365 audit log, and admins can search the Microsoft 365 audit log. This is the default value. +- $true: User and admin activities are recorded in the Microsoft 365 audit log, and admins can search the Microsoft 365 audit log. This value is the default. - $false: User and admin activities aren't recorded in the Microsoft 365 audit log, and admins can't search the Microsoft 365 audit log. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named Default value: None @@ -339,13 +366,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named Default value: None diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishPolicy.md index a552fa50b5..4cfb21fc4b 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-antiphishpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-AntiPhishPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-antiphishpolicy +schema: 2.0.0 +title: Set-AntiPhishPolicy --- # Set-AntiPhishPolicy @@ -64,7 +65,7 @@ Set-AntiPhishPolicy -Identity ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,6 +91,9 @@ In Microsoft Defender for Office 365, this example modifies the default antiphis ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -100,7 +104,6 @@ The Identity parameter specifies the antiphish policy that you want to modify. Y Type: AntiPhishPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -110,13 +113,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,18 +131,20 @@ Accept wildcard characters: False ``` ### -AuthenticationFailAction + +> Applicable: Exchange Online, Exchange Online Protection + 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 Junk Email folder in the recipient's mailbox. +- MoveToJmf: This value is the default. 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -156,7 +166,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -166,18 +175,20 @@ Accept wildcard characters: False ``` ### -DmarcQuarantineAction + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`. Valid values are: - MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. -- Quarantine: Deliver the message to quarantine. This is the default value. +- Quarantine: Deliver the message to quarantine. This value is the default. ```yaml Type: SpoofDmarcQuarantineAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,12 +198,15 @@ Accept wildcard characters: False ``` ### -DmarcRejectAction + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The DmarcRejectAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=reject`. Valid values are: - Quarantine: Deliver the message to quarantine. -- Reject: Reject the message. This is the default value. +- Reject: Reject the message. This value is the default. This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. @@ -200,7 +214,6 @@ This parameter is meaningful only when the HonorDmarcPolicy parameter is set to Type: SpoofDmarcRejectAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,6 +223,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. To enable or disable an existing anti-phishing policy (the combination of the antiphish rule and the associated antiphish policy), use the **Enable-AntiPhishRule** or **Disable-AntiPhishRule** cmdlets. @@ -222,7 +238,6 @@ In the output of the **Get-AntiPhishRule** cmdlet, whether the anti-phishing pol Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -232,16 +247,18 @@ Accept wildcard characters: False ``` ### -EnableFirstContactSafetyTips + +> Applicable: Exchange Online, Exchange Online Protection + The EnableFirstContactSafetyTips parameter specifies whether to enable or disable the safety tip that's shown when recipients first receive an email from a sender or do not often receive email from a sender. Valid values are: - $true: First contact safety tips are enabled. -- $false: First contact safety tips are disabled. This is the default value. +- $false: First contact safety tips are disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -251,18 +268,20 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligence + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence, which is artificial intelligence (AI) that determines user email patterns with their frequent contacts. Mailbox intelligence helps distinguish between messages from legitimate and impersonated senders based on a recipient's previous communication history. Valid values are: -- $true: Mailbox intelligence is enabled. This is the default value. +- $true: Mailbox intelligence is enabled. This value is the default. - $false: Mailbox intelligence is disabled. The values of the EnableMailboxIntelligenceProtection and MailboxIntelligenceProtectionAction parameters are ignored. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -272,12 +291,15 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligenceProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligenceProtection specifies whether to enable or disable taking action for impersonation detections from mailbox intelligence results. Valid values are: - $true: Take action for impersonation detections from mailbox intelligence results. Use the MailboxIntelligenceProtectionAction parameter to specify the action. -- $false: Don't take action for impersonation detections from mailbox intelligence results. The value of the MailboxIntelligenceProtectionAction parameter is ignored. This is the default value. +- $false: Don't take action for impersonation detections from mailbox intelligence results. The value of the MailboxIntelligenceProtectionAction parameter is ignored. This value is the default. This parameter is meaningful only if the EnableMailboxIntelligence parameter is set to the value $true. @@ -287,7 +309,6 @@ If you set this parameter to the value $false when the value of the EnableMailbo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -297,18 +318,20 @@ Accept wildcard characters: False ``` ### -EnableOrganizationDomainsProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Microsoft 365 organization. Valid values are: - $true: Domain impersonation protection is enabled for all registered domains in the Microsoft 365 organization. -- $false: Domain impersonation protection isn't enabled for all registered domains in the Microsoft 365 organization. This is the default value. You can enable protection for specific domains by using the EnableTargetedDomainsProtection and TargetedDomainsToProtect parameters. +- $false: Domain impersonation protection isn't enabled for all registered domains in the Microsoft 365 organization. This value is the default. You can enable protection for specific domains by using the EnableTargetedDomainsProtection and TargetedDomainsToProtect parameters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -318,18 +341,20 @@ Accept wildcard characters: False ``` ### -EnableSimilarDomainsSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for domain impersonation detections. Valid values are: - $true: Safety tips for similar domains are enabled. -- $false: Safety tips for similar domains are disabled. This is the default value. +- $false: Safety tips for similar domains are disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -339,18 +364,20 @@ Accept wildcard characters: False ``` ### -EnableSimilarUsersSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for user impersonation detections. Valid values are: - $true: Safety tips for similar users are enabled. -- $false: Safety tips for similar users are disabled. This is the default value. +- $false: Safety tips for similar users are disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -360,6 +387,9 @@ Accept wildcard characters: False ``` ### -EnableSpoofIntelligence + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableSpoofIntelligence parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: @@ -371,7 +401,6 @@ The EnableSpoofIntelligence parameter specifies whether to enable or disable ant Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -381,18 +410,20 @@ Accept wildcard characters: False ``` ### -EnableTargetedDomainsProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableTargetedDomainsProtection parameter specifies whether to enable domain impersonation protection for a list of specified domains. Valid values are: - $true: Domain impersonation protection is enabled for the domains specified by the TargetedDomainsToProtect parameter. -- $false: The TargetedDomainsToProtect parameter isn't used. This is the default value. +- $false: The TargetedDomainsToProtect parameter isn't used. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -402,18 +433,20 @@ Accept wildcard characters: False ``` ### -EnableTargetedUserProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for a list of specified users. Valid values are: - $true: User impersonation protection is enabled for the users specified by the TargetedUsersToProtect parameter. -- $false: The TargetedUsersToProtect parameter isn't used. This is the default value. +- $false: The TargetedUsersToProtect parameter isn't used. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -423,11 +456,14 @@ Accept wildcard characters: False ``` ### -EnableUnauthenticatedSender + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableUnauthenticatedSender parameter enables or disables unauthenticated sender identification in Outlook. Valid values are: -- $true: This is the default value. A question mark (?) is applied to the sender's photo if the message does not pass SPF or DKIM checks AND the message does not pass DMARC or composite authentication. +- $true: This value is the default. A question mark (?) is applied to the sender's photo if the message does not pass SPF or DKIM checks AND the message does not pass DMARC or composite authentication. - $false: A question mark is never applied to the sender's photo. To prevent these identifiers from being added to messages from specific senders, you have the following options: @@ -439,7 +475,6 @@ To prevent these identifiers from being added to messages from specific senders, Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -449,18 +484,20 @@ Accept wildcard characters: False ``` ### -EnableUnusualCharactersSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for unusual characters in domain and user impersonation detections. Valid values are: - $true: Safety tips for unusual characters are enabled. -- $false: Safety tips for unusual characters are disabled. This is the default value. +- $false: Safety tips for unusual characters are disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -470,11 +507,14 @@ Accept wildcard characters: False ``` ### -EnableViaTag + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableViaTag parameter enables or disables adding the via tag to the From address in Outlook (chris@contso.com via fabrikam.com). Valid values are: -- $true: The via tag is added to the From address (the message sender that's displayed in email clients) if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. This is the default value. +- $true: The via tag is added to the From address (the message sender that's displayed in email clients) if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. This value is the default. - $false: The via tag is not added to the From address. To prevent the via tag from being added to messages from specific senders, you have the following options: @@ -486,7 +526,6 @@ To prevent the via tag from being added to messages from specific senders, you h Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -496,6 +535,9 @@ Accept wildcard characters: False ``` ### -ExcludedDomains + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. @@ -508,7 +550,6 @@ The maximum number of entries is approximately 1000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -518,6 +559,9 @@ Accept wildcard characters: False ``` ### -ExcludedSenders + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. @@ -528,7 +572,6 @@ The maximum number of entries is approximately 1000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -538,18 +581,20 @@ Accept wildcard characters: False ``` ### -HonorDmarcPolicy + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The HonorDmarcPolicy enables or disables using the sender's DMARC policy to determine what to do to messages that fail DMARC checks. Valid values are: -- $true: If a message fails DMARC and the sender's DMARC policy is `p=quarantine` or `p=reject`, the DmarcQuarantineAction or DmarcRejectAction parameters specify the action to take on the message. This is the default value. +- $true: If a message fails DMARC and the sender's DMARC policy is `p=quarantine` or `p=reject`, the DmarcQuarantineAction or DmarcRejectAction parameters specify the action to take on the message. This value is the default. - $false: If the message fails DMARC, ignore the action in the sender's DMARC policy. The AuthenticationFailAction parameter specifies the action to take on the message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -559,19 +604,21 @@ Accept wildcard characters: False ``` ### -ImpersonationProtectionState + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ImpersonationProtectionState parameter specifies the configuration of impersonation protection. Valid values are: -- Automatic: This is the default value in the default policy named Office365 AntiPhish Policy. -- Manual: This is the default value in custom policies that you create. +- Automatic: This value is the default in the default policy named Office365 AntiPhish Policy. +- Manual: This value is the default in custom policies that you create. - Off ```yaml Type: ImpersonationProtectionState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -581,11 +628,14 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionAction parameter specifies what to do with messages that fail mailbox intelligence protection. Valid values are: -- NoAction: This is the default value. Note that this value has the same result as setting the EnableMailboxIntelligenceProtection parameter to $false when the EnableMailboxIntelligence parameter is $true. +- NoAction: This value is the default. 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 Junk Email folder in the recipient's mailbox. @@ -598,7 +648,6 @@ This parameter is meaningful only if the EnableMailboxIntelligence and EnableMai Type: ImpersonationAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -608,6 +657,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionActionRecipients parameter specifies the recipients to add to detected messages when the MailboxIntelligenceProtectionAction parameter is set to the value Redirect or BccMessage. @@ -618,7 +670,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -628,6 +679,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by mailbox intelligence (the MailboxIntelligenceProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -646,7 +700,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -656,6 +709,9 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Online, Exchange Online Protection + The MakeDefault switch makes this antiphish policy the default antiphish policy. You don't need to specify a value with this switch. The default antiphish policy is applied to everyone (no corresponding antiphish rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). @@ -664,7 +720,6 @@ The default antiphish policy is applied to everyone (no corresponding antiphish Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -674,11 +729,14 @@ Accept wildcard characters: False ``` ### -PhishThresholdLevel + +> Applicable: Exchange Online + This setting is part of advanced settings and is available only in Microsoft Defender for Office 365. The PhishThresholdLevel parameter specifies the tolerance level that's used by machine learning in the handling of phishing messages. Valid values are: -- 1: Standard: This is the default value. The severity of the action that's taken on the message depends on the degree of confidence that the message is phishing (low, medium, high, or very high confidence). For example, messages that are identified as phishing with a very high degree of confidence have the most severe actions applied, while messages that are identified as phishing with a low degree of confidence have less severe actions applied. +- 1: Standard: This value is the default. The severity of the action that's taken on the message depends on the degree of confidence that the message is phishing (low, medium, high, or very high confidence). For example, messages that are identified as phishing with a very high degree of confidence have the most severe actions applied, while messages that are identified as phishing with a low degree of confidence have less severe actions applied. - 2: Aggressive: Messages that are identified as phishing with a high degree of confidence are treated as if they were identified with a very high degree of confidence. - 3: More aggressive: Messages that are identified as phishing with a medium or high degree of confidence are treated as if they were identified with a very high degree of confidence. - 4: Most aggressive: Messages that are identified as phishing with a low, medium, or high degree of confidence are treated as if they were identified with a very high degree of confidence. @@ -687,7 +745,6 @@ The PhishThresholdLevel parameter specifies the tolerance level that's used by m Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -697,13 +754,15 @@ Accept wildcard characters: False ``` ### -PolicyTag + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -713,6 +772,9 @@ Accept wildcard characters: False ``` ### -SpoofQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The SpoofQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by spoof intelligence (the AuthenticationFailAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -729,7 +791,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -739,6 +800,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. @@ -749,7 +813,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -759,11 +822,14 @@ Accept wildcard characters: False ``` ### -TargetedDomainProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: -- NoAction: This is the default value. +- NoAction: This value is the default. - 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 Junk Email folder in the recipient's mailbox. @@ -774,7 +840,6 @@ The TargetedDomainProtectionAction parameter specifies the action to take on det Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -784,6 +849,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by domain impersonation protection (the TargetedDomainProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -802,7 +870,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -812,6 +879,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainsToProtect + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. @@ -822,7 +892,6 @@ You can specify multiple domains separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -832,6 +901,9 @@ Accept wildcard characters: False ``` ### -TargetedUserActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. @@ -842,7 +914,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -852,11 +923,14 @@ Accept wildcard characters: False ``` ### -TargetedUserProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: -- NoAction: This is the default value. +- NoAction: This value is the default. - 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. @@ -867,7 +941,6 @@ The TargetedUserProtectionAction parameter specifies the action to take on detec Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -877,6 +950,9 @@ Accept wildcard characters: False ``` ### -TargetedUserQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by user impersonation protection (the TargetedUserProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -895,7 +971,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -905,6 +980,9 @@ Accept wildcard characters: False ``` ### -TargetedUsersToProtect + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. @@ -920,7 +998,6 @@ This parameter uses the syntax: "DisplayName;EmailAddress". Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -930,13 +1007,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishRule.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishRule.md index 9d41dff174..e84298092e 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: Set-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-antiphishrule +schema: 2.0.0 +title: Set-AntiPhishRule --- # Set-AntiPhishRule @@ -41,7 +42,7 @@ Set-AntiPhishRule [-Identity] > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Common policy settings](https://learn.microsoft.com/defender-office-365/anti-phishing-policies-about#common-policy-settings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example modifies the existing antiphish rule named Engineering Department P ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the antiphish rule that you want to modify. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AntiPhishPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The AntiPhishPolicy parameter specifies the antiphish policy that's associated with the antiphish rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -85,7 +91,6 @@ The AntiPhishPolicy parameter specifies the antiphish policy that's associated w Type: AntiPhishPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -120,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -161,7 +175,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -186,7 +202,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -196,13 +211,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the antiphish rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,6 +229,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -226,7 +246,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -236,13 +255,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -252,6 +273,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -267,7 +291,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -277,6 +300,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -294,7 +320,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -304,13 +329,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-App.md b/exchange/exchange-ps/ExchangePowerShell/Set-App.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-App.md rename to exchange/exchange-ps/ExchangePowerShell/Set-App.md index af5a021961..ac6e743d11 100644 --- a/exchange/exchange-ps/exchange/Set-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-App.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-app -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-App -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-app +schema: 2.0.0 +title: Set-App --- # Set-App ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-App cmdlet to modify the availability of organization apps. @@ -35,13 +36,13 @@ Set-App [-Identity] ``` ## DESCRIPTION -The Set-App cmdlet can only be used when configuring the availability of an organization app. This task requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet, or that it's a default app for Outlook). +The Set-App cmdlet can only be used when configuring the availability of an organization app. This task requires that the specified app has already been installed (for example, that the app is installed with the New-App cmdlet, or that it's a default app for Outlook). Default apps in Outlook on the web and apps that you've installed for use by users in your organization are known as organization apps. Organization apps can't be removed by end users, but can be enabled or disabled. If an app is an organization app (scope default or organization), the delete control on the toolbar is disabled for end users. Administrators are able to remove organization apps. Administrators can't remove default apps, but they can disable them for the entire organization. For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://learn.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://learn.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,13 +65,15 @@ This example disables the organization app named FinanceTestApp across the organ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the AppID (GUID value) of the app that you want to modify. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. ```yaml Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -89,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -99,10 +104,13 @@ Accept wildcard characters: False ``` ### -DefaultStateForUser + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultStateForUser parameter specifies the default initial state of the organization app for the specified users. Valid values are: - Enabled: The organization app is enabled. -- Disabled: The organization app is disabled. This is the default value. +- Disabled: The organization app is disabled. This value is the default. - AlwaysEnabled: The organization app is enabled, and users can't disable it. You use this parameter with the OrganizationApp switch. @@ -111,7 +119,6 @@ You use this parameter with the OrganizationApp switch. Type: DefaultStateForUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -129,7 +139,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,9 +148,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter specifies whether the app is available to users in the organization. Valid values are: -- $true: The app is enabled for the specified users. This is the default value. +- $true: The app is enabled for the specified users. This value is the default. - $false: The app isn't enabled for any users in the organization. This hides the app from user view for all users. This setting overrides the ProvidedTo, UserList, and DefaultStateForUser settings. This setting doesn't prevent users from installing their own instance of the app if they have install permissions. @@ -150,7 +162,6 @@ This setting overrides the ProvidedTo, UserList, and DefaultStateForUser setting Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -OrganizationApp + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OrganizationApp switch specifies that the scope of the app is organizational (not bound to a specific user). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -176,13 +189,15 @@ Accept wildcard characters: False ``` ### -PrivateCatalog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PrivateCatalog switch specifies that the app you want to modify is located in a private catalog. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -192,10 +207,13 @@ Accept wildcard characters: False ``` ### -ProvidedTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ProvidedTo parameter specifies the availability of the app in your organization. Valid value are: -- Everyone: The app is provided to every user in the organization. This is the default value. Every user sees this app listed in the installed apps list in Outlook on the web Options. When an app in the installed apps list is enabled, users can use the features of this app in their email. All users are blocked from installing their own instances of this app, including but not limited to users with install apps permissions. -- SpecificUsers: This app is provided to only the users specified by the UserList parameter. All other users don't see this organizational app in their management view, nor will it activate in their mail or calendar items. The specified users are also blocked from installing their own instance of this app. Unlisted users aren't blocked from installing their own instance of this app. +- Everyone: The app is provided to every user in the organization. This value is the default. Every user sees this app listed in the installed apps list in Outlook on the web Options. When an app in the installed apps list is enabled, users can use the features of this app in their email. All users are blocked from installing their own instances of this app, including but not limited to users with install apps permissions. +- SpecificUsers: This app is provided to only the users specified by the UserList parameter. All other users don't see this organizational app in their management view, nor does it activate in their mail or calendar items. The specified users are also blocked from installing their own instance of this app. Unlisted users aren't blocked from installing their own instance of this app. You use this parameter with the OrganizationApp switch. @@ -203,7 +221,6 @@ You use this parameter with the OrganizationApp switch. Type: ClientExtensionProvidedTo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -213,6 +230,9 @@ Accept wildcard characters: False ``` ### -UserList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://learn.microsoft.com/office/dev/add-ins/publish/centralized-deployment). Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. For example: @@ -236,7 +256,6 @@ You use this parameter with the OrganizationApp switch. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,13 +265,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionCompliancePolicy.md similarity index 72% rename from exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionCompliancePolicy.md index f3e8af0e26..8d42672ef9 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancepolicy applicable: Security & Compliance -title: Set-AppRetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-appretentioncompliancepolicy +schema: 2.0.0 +title: Set-AppRetentionCompliancePolicy --- # Set-AppRetentionCompliancePolicy @@ -108,6 +109,10 @@ Set-AppRetentionCompliancePolicy [-Identity] ``` ## 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 @@ -119,9 +124,44 @@ 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 + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -132,7 +172,6 @@ The Identity parameter specifies the app retention compliance policy that you wa Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -142,6 +181,9 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + The RetryDistribution switch specifies whether to redistribute the policy to all locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -152,7 +194,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistributionParameterSet Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -162,6 +203,9 @@ Accept wildcard characters: False ``` ### -AddAdaptiveScopeLocation + +> Applicable: Security & Compliance + The AddAdaptiveScopeLocation parameter specifies the adaptive scope location to add to the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -174,7 +218,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -184,6 +227,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -202,7 +248,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -212,6 +257,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocationException + +> Applicable: Security & Compliance + The AddExchangeLocationException parameter specifies the mailboxes to add to the list of excluded mailboxes when you're using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -230,7 +278,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -240,6 +287,9 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocation + +> Applicable: Security & Compliance + The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups when you aren't using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -255,7 +305,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -265,6 +314,9 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocationException + +> Applicable: Security & Compliance + The AddModernGroupLocationException parameter specifies the Microsoft 365 Groups to add to the list of excluded Microsoft 365 Groups when you're using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -280,7 +332,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -290,19 +341,39 @@ Accept wildcard characters: False ``` ### -Applications -The Applications parameter specifies the applications to include and is relevant only for the following location parameters: -- ExchangeLocation -- ModernGroupLocation -- AdaptiveScopeLocation +> Applicable: Security & Compliance + +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"` -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 Copilot experiences**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"` + + **Note**: Even though you must use `CopilotinBusinessApplicationplatformsSales` and `SQLCopilot`, those values are currently irrelevant. + +- **Enterprise AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"` + +- **Other AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"` ```yaml Type: String[] Parameter Sets: Identity, AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -312,13 +383,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -328,6 +401,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -337,7 +413,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -347,13 +422,23 @@ Accept wildcard characters: False ``` ### -DeletedResources -{{ Fill DeletedResources Description }} + +> Applicable: Security & Compliance + +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 are also 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 @@ -363,16 +448,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter enables or disables the policy. Valid values are: -- $true: The policy is enabled. This is the default value. +- $true: The policy is enabled. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -382,6 +469,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -390,7 +480,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation, InformationBarrierDefault Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -400,6 +489,11 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + +**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. @@ -408,7 +502,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -418,6 +511,9 @@ Accept wildcard characters: False ``` ### -RemoveAdaptiveScopeLocation + +> Applicable: Security & Compliance + The RemoveAdaptiveScopeLocation parameter specifies the adaptive scope location to remove from the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -430,7 +526,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -440,6 +535,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -458,7 +556,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -468,6 +565,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocationException + +> Applicable: Security & Compliance + The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -486,7 +586,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -496,6 +595,9 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocation + +> Applicable: Security & Compliance + The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups when you aren't using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -511,7 +613,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -521,6 +622,9 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocationException + +> Applicable: Security & Compliance + The RemoveModernGroupLocationException parameter specifies the Microsoft 365 Groups to remove from the list of excluded groups when you're using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -536,7 +640,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -546,12 +649,15 @@ Accept wildcard characters: False ``` ### -RestrictiveRetention + +> Applicable: Security & Compliance + The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: - $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. -- $false: Preservation Lock isn't enabled for the policy. This is the default value. +- $false: Preservation Lock isn't enabled for the policy. This value is the default. -After a policy has been locked, no one can turn off or disable it, or remove apps from the policy. The only ways that you can modify the policy are by adding apps to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. +After a policy is locked, no one can turn off or disable it, or remove apps from the policy. The only ways that you can modify the policy are by adding apps to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. Therefore, before you lock a policy, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need. @@ -559,7 +665,6 @@ Therefore, before you lock a policy, it's critical that you understand your orga Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -569,13 +674,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionComplianceRule.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionComplianceRule.md index a6b2925a84..1e3923865e 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancerule applicable: Security & Compliance -title: Set-AppRetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-appretentioncompliancerule +schema: 2.0.0 +title: Set-AppRetentionComplianceRule --- # Set-AppRetentionComplianceRule @@ -52,6 +53,9 @@ This example updates the length of the retention duration for a rule named 563 M ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance rule that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the app retention compliance rule that you want Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -117,7 +127,6 @@ Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -ContentDateFrom + +> Applicable: Security & Compliance + {{ Fill ContentDateFrom Description }} ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -ContentDateTo + +> Applicable: Security & Compliance + {{ Fill ContentDateTo Description }} ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -159,6 +172,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -167,7 +183,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -177,7 +192,10 @@ Accept wildcard characters: False ``` ### -ExcludedItemClasses -The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: + +> Applicable: Security & Compliance + +The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter doesn't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: - IPM.Note.Microsoft.Conversation - IPM.Note.Microsoft.Conversation.Voice @@ -188,7 +206,7 @@ The ExcludedItemClasses parameter specifies the types of messages to exclude fro - IPM.Note.Microsoft.Voicemail.UM - IPM.Note.Microsoft.Voicemail.UM.CA -Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or non-Microsoft message classes. The values you specify aren't validated, so the parameter accepts any text value. You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. @@ -196,7 +214,6 @@ You can specify multiple item class values by using the following syntax: `"Valu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -ExpirationDateOption + +> Applicable: Security & Compliance + The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: - CreationAgeInDays @@ -215,7 +235,6 @@ The ExpirationDateOption parameter specifies whether the expiration date is calc Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -225,6 +244,9 @@ Accept wildcard characters: False ``` ### -RetentionComplianceAction + +> Applicable: Security & Compliance + The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - Delete @@ -235,7 +257,6 @@ The RetentionComplianceAction parameter specifies the retention action for the r Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -245,6 +266,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - An integer: The hold duration in days. @@ -254,7 +278,6 @@ The RetentionDuration parameter specifies the hold duration for the retention ru Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -264,20 +287,22 @@ Accept wildcard characters: False ``` ### -RetentionDurationDisplayHint + +> Applicable: Security & Compliance + The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. - Days - Months - Years -For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal displays 1 year as the content hold duration. ```yaml Type: HoldDurationHint Parameter Sets: (All) Aliases: Accepted values: Days, Months, Years -Applicable: Security & Compliance Required: False Position: Named @@ -287,13 +312,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-ApplicationAccessPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ApplicationAccessPolicy.md index dd98f50127..b2e7429a58 100644 --- a/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ApplicationAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection -title: Set-ApplicationAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-applicationaccesspolicy +schema: 2.0.0 +title: Set-ApplicationAccessPolicy --- # Set-ApplicationAccessPolicy @@ -31,7 +32,7 @@ Set-ApplicationAccessPolicy [-Identity] ## DESCRIPTION This feature applies only to apps connecting to the Microsoft Graph API for Outlook resources. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example modifies the description of the specified policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the application access policy that you want to modify. To find the Identity value for the policy, run the command Get-ApplicationAccessPolicy | Format-List Identity,Description,ScopeName,AccessRight,AppID. ```yaml Type: ApplicationAccessPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online, Exchange Online Protection + The Description parameter modifies the description of the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -77,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -86,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ArcConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-ArcConfig.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-ArcConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ArcConfig.md index 1513542a3c..9bbb3811d5 100644 --- a/exchange/exchange-ps/exchange/Set-ArcConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ArcConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-arcconfig applicable: Exchange Online, Exchange Online Protection -title: Set-ArcConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-arcconfig +schema: 2.0.0 +title: Set-ArcConfig --- # Set-ArcConfig @@ -30,7 +31,7 @@ Set-ArcConfig [-Identity] -ArcTrustedS ## DESCRIPTION Services that modify message content in transit before delivery can invalidate DKIM email signatures and affect the authentication of the message. These services can use ARC to provide details of the original authentication before the modifications occurred. Your organization can then trust these details to help authenticate the message. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,9 +74,33 @@ 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 + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the trusted ARC sealers list that you want to modify. Use one of the following values: - Default for your own organization. @@ -85,7 +110,6 @@ The Identity parameter specifies the trusted ARC sealers list that you want to m Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -95,19 +119,23 @@ Accept wildcard characters: False ``` ### -ArcTrustedSealers + +> Applicable: Exchange Online, Exchange Online Protection + The ArcTrustedSealers parameter specifies the domain name of the ARC sealers that you want to add. The domain name must match the domain that's shown in the `d` tag in the **ARC-Seal** and **ARC-Message-Signature** headers in affected email messages (for example, fabrikam.com). You can use Outlook to see these headers. -To replace the existing list of ARC sealers with the values you specify, use the syntax `Domain1,Domain2,...DomainN`. To preserve existing values, be sure to include the 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 file types without affecting the other file type entries, see the Examples section in this topic. +To add or remove values without affecting the other entries, see the Examples section in this article. + +To empty the list, use the value `" "` (a space enclosed in double quotation marks). ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -117,6 +145,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -126,7 +157,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md b/exchange/exchange-ps/ExchangePowerShell/Set-AtpPolicyForO365.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AtpPolicyForO365.md index 397fe84e2c..4b4654ecbd 100644 --- a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AtpPolicyForO365.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-atppolicyforo365 applicable: Exchange Online -title: Set-AtpPolicyForO365 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-atppolicyforo365 +schema: 2.0.0 +title: Set-AtpPolicyForO365 --- # Set-AtpPolicyForO365 @@ -41,7 +42,7 @@ Safe Documents scans documents and files that are opened in Protected View. For 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example enables Safe Documents and Safe Attachments for SharePoint, OneDriv ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the policy that you want to modify. There's only one policy named Default. ```yaml Type: AtpPolicyForO365IdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -71,9 +74,12 @@ Accept wildcard characters: False ``` ### -AllowSafeDocsOpen + +> Applicable: Exchange Online + The AllowSafeDocsOpen parameter specifies whether users can click through and bypass the Protected View container even when Safe Documents identifies a file as malicious. Valid values are: -- $true: Users are allowed to exit the Protected View container even if the document has been identified as malicious. +- $true: Users are allowed to exit the Protected View container even if the document is identified as malicious. - $false: Users aren't allowed to exit Protected View in case of a malicious detection. This parameter is meaningful only when the EnableSafeDocs parameter value is $true. @@ -82,7 +88,6 @@ This parameter is meaningful only when the EnableSafeDocs parameter value is $tr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -101,7 +109,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -111,16 +118,18 @@ Accept wildcard characters: False ``` ### -EnableATPForSPOTeamsODB + +> Applicable: Exchange Online + The EnableATPForSPOTeamsODB parameter enables or disables Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. Valid values are: -- $true: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is enabled. SharePoint Online admins can use the DisallowInfectedFileDownload parameter on the [Set-SPOTenant](https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOTenant) cmdlet to control whether users are allowed to download files that are found to be malicious. -- $false: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is disabled. This is the default value. +- $true: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is enabled. SharePoint admins can use the DisallowInfectedFileDownload parameter on the [Set-SPOTenant](https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOTenant) cmdlet to control whether users are allowed to download files that are found to be malicious. +- $false: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,10 +139,13 @@ Accept wildcard characters: False ``` ### -EnableSafeDocs + +> Applicable: Exchange Online + The EnableSafeDocs parameter enables or disables Safe Documents in organizations with Microsoft 365 A5 or Microsoft 365 E5 Security licenses. Valid values are: -- $true: Safe Documents is enabled and will upload user files to Microsoft Defender for Endpoint for scanning and verification. -- $false: Safe Documents is disabled. This is the default value. +- $true: Safe Documents is enabled and uploads user files to Microsoft Defender for Endpoint for scanning and verification. +- $false: Safe Documents is disabled. This value is the default. 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) @@ -141,7 +153,6 @@ For more information about Safe Documents, see [Safe Documents in Microsoft 365 Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-AttachmentFilterListConfig.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AttachmentFilterListConfig.md index 0bc5e542b8..87b10a0fa8 100644 --- a/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AttachmentFilterListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AttachmentFilterListConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-attachmentfilterlistconfig +schema: 2.0.0 +title: Set-AttachmentFilterListConfig --- # Set-AttachmentFilterListConfig @@ -49,9 +50,12 @@ This example modifies the action that the Attachment Filtering agent takes on an ## PARAMETERS ### -Action + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Action parameter specifies how the Attachment Filtering agent handles an attachment that matches an entry on the attachment filter list. Valid values are: -- Reject: This value prevents both the email message and attachment from being delivered to the recipient and issues a non-delivery report (NDR) to the sender. This is the default value. +- Reject: This value prevents both the email message and attachment from being delivered to the recipient and issues a non-delivery report (NDR) to the sender. This value is the default. - Strip: This value removes the offending attachment from the email message and allows the message and other attachments that don't match an entry on the attachment filter list through. A notification that the attachment was removed is added to the email message. - SilentDelete: This value prevents both the email message and the attachment from being delivered to the recipient. No notification that the email message and attachment were blocked is sent to the sender. @@ -59,7 +63,6 @@ The Action parameter specifies how the Attachment Filtering agent handles an att Type: FilterActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -AdminMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AdminMessage parameter specifies the content of a text file that replaces attachments removed by the Attachment Filtering agent. The AdminMessage parameter only appears when the Attachment Filtering agent is configured to remove an attachment that's been identified as bad. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -94,7 +102,6 @@ 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 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -112,7 +122,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -ExceptionConnectors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExceptionConnectors parameter specifies a list of connectors that should be excluded from attachment filtering. Attachment filters aren't applied to email messages received through these connectors. You must use the connector GUID to specify the ExceptionConnectors parameter value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -RejectResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectResponse parameter specifies the message body that you want delivered in the NDR to senders whose messages contain an attachment that's blocked. The RejectResponse parameter is required only if you set the Action parameter to Reject. Don't exceed 240 characters in the parameter argument. When you pass an argument, you must enclose the RejectResponse parameter value in quotation marks (") if the phrase contains spaces, for example: "Message rejected". The default setting is Message rejected due to unacceptable attachments. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AuditConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-AuditConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-AuditConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AuditConfig.md index e2c5d20cfd..7c5c15ef4d 100644 --- a/exchange/exchange-ps/exchange/Set-AuditConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AuditConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-auditconfig applicable: Security & Compliance -title: Set-AuditConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-auditconfig +schema: 2.0.0 +title: Set-AuditConfig --- # Set-AuditConfig @@ -42,13 +43,15 @@ This example sets the auditing configuration for Exchange and SharePoint. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Security & Compliance + The Workload parameter specifies where auditing is allowed. Valid values are: - Exchange @@ -71,7 +77,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -97,13 +104,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AuthConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-AuthConfig.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-AuthConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AuthConfig.md index a6ffa805ac..08daf7b0f5 100644 --- a/exchange/exchange-ps/exchange/Set-AuthConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AuthConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-authconfig -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AuthConfig -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-authconfig +schema: 2.0.0 +title: Set-AuthConfig --- # Set-AuthConfig @@ -69,7 +70,7 @@ Set-AuthConfig [-Realm ] ## DESCRIPTION The Set-AuthConfig parameter defines Microsoft Exchange as a partner application for server-to-server authentication with other partner applications such as Microsoft SharePoint 2013 and Microsoft Lync 2013 or Skype for Business Server 2015, including the certificate used for signing tokens. It's generally not required for this configuration to be modified except in some cases where you must use a different certificate instead of the self-signed certificate created by Exchange Setup or to use a new certificate after the old one has expired. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,7 +79,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-AuthConfig -NewCertificateThumbprint DB821B4FCA2A5DA9593B9DE00C86BC5EA35D0FC0 -NewCertificateEffectiveDate 4/17/2014 ``` -This example specifies a new certificate and a date when the certificate will become effective. +This example specifies a new certificate and a date when the certificate is effective. ### Example 2 ```powershell @@ -90,13 +91,15 @@ This example immediately rolls over the certificate configured as the next certi ## PARAMETERS ### -CertificateThumbprint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CertificateThumbprint parameter specifies the thumbprint of the certificate to be used by Exchange for server-to-server authentication. ```yaml Type: String Parameter Sets: CurrentCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -ClearPreviousCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClearPreviousCertificate switch clears the certificate that was saved as the previous certificate in the authorization configuration. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: PublishAuthCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -131,7 +139,6 @@ 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 Required: False Position: Named @@ -141,13 +148,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -165,7 +177,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: CurrentCertificateParameter, PublishAuthCertificateParameter, NewCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,13 +186,15 @@ Accept wildcard characters: False ``` ### -NewCertificateEffectiveDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NewCertificateEffectiveDate parameter specifies a date when the certificate configured as the next certificate should be used. ```yaml Type: DateTime Parameter Sets: NewCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +204,15 @@ Accept wildcard characters: False ``` ### -NewCertificateThumbprint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NewCertificateThumbprint parameter specifies the thumbprint of the new certificate to be used as the next certificate in the authorization configuration. ```yaml Type: String Parameter Sets: NewCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +222,9 @@ Accept wildcard characters: False ``` ### -PublishCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PublishCertificate switch immediately rolls over the specified certificate as the current certificate. You don't need to specify a value with this switch. The certificate is immediately deployed to all Client Access servers. @@ -215,7 +233,6 @@ The certificate is immediately deployed to all Client Access servers. Type: SwitchParameter Parameter Sets: PublishAuthCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +242,15 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Realm parameter specifies a security realm for partner applications. If a service or user presents a token from a domain that's not an accepted domain in the Exchange organization, the token must contain the specified realm to gain access to resources. ```yaml Type: String Parameter Sets: AuthConfigSettings Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,13 +260,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter isn't available in this release. ```yaml Type: ServerIdParameter Parameter Sets: CurrentCertificateParameter, NewCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,6 +278,9 @@ Accept wildcard characters: False ``` ### -ServiceName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ServiceName parameter identifies Microsoft Exchange to other partner applications such as SharePoint 2013. Exchange Setup configures the ServiceName parameter with a specific constant value. You shouldn't change this parameter. Changing the ServiceName parameter can result in server-to-server authentication with partner applications not functioning. @@ -265,7 +289,6 @@ Exchange Setup configures the ServiceName parameter with a specific constant val Type: String Parameter Sets: AuthConfigSettings Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,6 +298,9 @@ Accept wildcard characters: False ``` ### -SkipImmediateCertificateDeployment + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipImmediateCertificateDeployment switch specifies that the certificate shouldn't be used immediately. You don't need to specify a value with this switch. We don't recommend using this switch in a production environment. @@ -283,7 +309,6 @@ We don't recommend using this switch in a production environment. Type: SwitchParameter Parameter Sets: CurrentCertificateParameter, NewCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +318,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AuthRedirect.md b/exchange/exchange-ps/ExchangePowerShell/Set-AuthRedirect.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-AuthRedirect.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AuthRedirect.md index e39dde30f7..0629cf6d1d 100644 --- a/exchange/exchange-ps/exchange/Set-AuthRedirect.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AuthRedirect.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-authredirect -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AuthRedirect -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-authredirect +schema: 2.0.0 +title: Set-AuthRedirect --- # Set-AuthRedirect @@ -30,7 +31,7 @@ Set-AuthRedirect [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,13 +52,15 @@ This example sets the TargetURL value for all existing OAuth redirection objects ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the existing OAuth redirection object that you want to modify. The object name uses the syntax `AuthRedirect-Bearer-GUID`. The easiest way to find the name of the OAuth redirection object is to run Get-AuthRedirect. ```yaml Type: AuthRedirectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -76,7 +82,6 @@ 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 Required: True Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -TargetUrl -The TargetUrl parameter specifies the FQDN of the Exchange 2013 Client Access server that will process the Oauth request. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The TargetUrl parameter specifies the FQDN of the Exchange 2013 Client Access server that processes the Oauth request. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AuthServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-AuthServer.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-AuthServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AuthServer.md index 63a2517793..ad946cfe01 100644 --- a/exchange/exchange-ps/exchange/Set-AuthServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AuthServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-authserver -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AuthServer -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-authserver +schema: 2.0.0 +title: Set-AuthServer --- # Set-AuthServer @@ -62,12 +63,25 @@ Set-AuthServer [-Identity] [] ``` +### AppSecret +``` +Set-AuthServer [-Identity] + [-ApplicationIdentifier ] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Enabled ] + [-Name ] + [-WhatIf] + [] +``` + ## DESCRIPTION Partner applications authorized by Exchange can access their resources after they're authenticated using server-to-server authentication. A partner application can authenticate by using self-issued tokens trusted by Exchange or by using an authorization server trusted by Exchange. You can use the New-AuthServer cmdlet to create a trusted authorization server object in Exchange, which allows it to trust tokens issued by the authorization server. Use the Set-AuthServer cmdlet to enable or disable the authorization server, change the AuthMetadataUrl parameter or refresh authorization metadata. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,6 +95,9 @@ This command disables the authorization server ACS. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the authorization server object that you want to modify. You can use any value that uniquely identifies the authorization server. For example: - Name @@ -91,7 +108,6 @@ The Identity parameter specifies the authorization server object that you want t Type: AuthServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -100,14 +116,36 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -ApplicationIdentifier + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AuthMetadataUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AuthMetadataUrl parameter specifies the URL of the authorization server. This can be the AuthMetadataUrl of your Exchange Online organization. ```yaml Type: String Parameter Sets: AuthMetadataUrl, NativeClientAuthServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +155,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -126,7 +167,6 @@ 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 Required: False Position: Named @@ -136,13 +176,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,17 +194,19 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in Exchange Server 2016 (CU18 or higher) and Exchange Server 2019 (CU7 or higher). -The DomainName parameter specifies the tenant domain that's linked with the AuthServer object. This parameter uses the syntax: "tenantname.onmicrosoft.com". +The DomainName parameter links a cloud-based organization to the corresponding AuthServer object in the Multi-Tenant Exchange Hybrid. This parameter uses the syntax: "domain.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. +For example, if the DomainName value is contoso.onmicrosoft.com, the AuthServer object is associated with the contoso cloud-based organization. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,18 +216,20 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the authorization server is enabled. Only enabled authorization servers can issue and accept tokens. Disabling the authorization server prevents any partner applications configured to use the authorization server from getting a token. The Enabled parameter specifies whether the authorization server is enabled. Valid values are: -- $true: Authorization tokens that are issued by the authorization server are accepted. This is the default value +- $true: Authorization tokens that are issued by the authorization server are accepted. This value is the default - $false: The authorization server does not issue or accept authorization tokens. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +239,9 @@ Accept wildcard characters: False ``` ### -IsDefaultAuthorizationEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsDefaultAuthorizationEndpoint parameter specifies whether this server is the default authorization endpoint. Valid values are: $true: The authorization server's URL is advertised to calling partner applications and applications that need to get their OAuth access tokens from the authorization server. @@ -203,7 +252,6 @@ $false: The authorization server's URL is not advertised. The default value is $ Type: Boolean Parameter Sets: NativeClientAuthServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -213,13 +261,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a unique name for the authorization server object. 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: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -229,13 +279,15 @@ Accept wildcard characters: False ``` ### -RefreshAuthMetadata + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RefreshAuthMetadata switch specifies whether Exchange should refresh the auth metadata from the specified URL. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: RefreshAuthMetadata Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,6 +297,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. We don't recommend using this switch in a production environment. @@ -253,7 +308,6 @@ We don't recommend using this switch in a production environment. Type: SwitchParameter Parameter Sets: AuthMetadataUrl, NativeClientAuthServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,13 +317,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-AuthenticationPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AuthenticationPolicy.md index 5badd29be6..41d628b916 100644 --- a/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AuthenticationPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-authenticationpolicy -applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-AuthenticationPolicy -schema: 2.0.0 +applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-authenticationpolicy +schema: 2.0.0 +title: Set-AuthenticationPolicy --- # Set-AuthenticationPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-AuthenticationPolicy cmdlet to modify authentication policies in your organization. @@ -59,7 +60,7 @@ Set-AuthenticationPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,11 +83,14 @@ In Exchange 2019, this example re-enables Basic authentication for Exchange Repo 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. +In Exchange Online, this example blocks legacy Exchange tokens from being issued to Outlook add-ins. The switch applies to the entire organization, and the Identity parameter must be set to the value "LegacyExchangeTokens". Specific authentication policies can't be applied. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the authentication policy you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -97,7 +101,6 @@ The Identity parameter specifies the authentication policy you want to modify. Y Type: AuthPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthActiveSync + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthActiveSync switch specifies whether to allow Basic authentication with Exchange Active Sync. @@ -118,7 +124,6 @@ The AllowBasicAuthActiveSync switch specifies whether to allow Basic authenticat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthAutodiscover + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthAutodiscover switch specifies whether to allow Basic authentication with Autodiscover. @@ -139,7 +147,6 @@ The AllowBasicAuthAutodiscover switch specifies whether to allow Basic authentic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -149,6 +156,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthImap + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthImap switch specifies whether to allow Basic authentication with IMAP. @@ -160,7 +170,6 @@ The AllowBasicAuthImap switch specifies whether to allow Basic authentication wi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -170,6 +179,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthMapi + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthMapi switch specifies whether to allow Basic authentication with MAPI. @@ -181,7 +193,6 @@ The AllowBasicAuthMapi switch specifies whether to allow Basic authentication wi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthOfflineAddressBook + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthOfflineAddressBook switch specifies whether to allow Basic authentication with Offline Address Books. @@ -202,7 +216,6 @@ The AllowBasicAuthOfflineAddressBook switch specifies whether to allow Basic aut Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthOutlookService + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthOutlookService switch specifies whether to allow Basic authentication with the Outlook service. @@ -223,7 +239,6 @@ The AllowBasicAuthOutlookService switch specifies whether to allow Basic authent Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +248,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthPop + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthPop switch specifies whether to allow Basic authentication with POP. @@ -244,7 +262,6 @@ The AllowBasicAuthPop switch specifies whether to allow Basic authentication wit Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -254,6 +271,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthPowershell + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthPowerShell switch specifies whether to allow Basic authentication with PowerShell. @@ -265,7 +285,6 @@ The AllowBasicAuthPowerShell switch specifies whether to allow Basic authenticat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,6 +294,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthReportingWebServices + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthReporting Web Services switch specifies whether to allow Basic authentication with reporting web services. @@ -286,7 +308,6 @@ The AllowBasicAuthReporting Web Services switch specifies whether to allow Basic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -296,6 +317,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthRpc + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthRpc switch specifies whether to allow Basic authentication with RPC. @@ -307,7 +331,6 @@ The AllowBasicAuthRpc switch specifies whether to allow Basic authentication wit Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -317,6 +340,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthSmtp + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthSmtp switch specifies whether to allow Basic authentication with SMTP. @@ -328,7 +354,6 @@ The AllowBasicAuthSmtp switch specifies whether to allow Basic authentication wi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -338,6 +363,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthWebServices + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthWebServices switch specifies whether to allow Basic authentication with Exchange Web Services (EWS). @@ -349,7 +377,6 @@ The AllowBasicAuthWebServices switch specifies whether to allow Basic authentica Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -359,25 +386,27 @@ Accept wildcard characters: False ``` ### -AllowLegacyExchangeTokens + +> Applicable: Exchange Online, Exchange Online Protection + 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. +The switch applies to the entire organization. The Identity parameter is required and must be set to the value "LegacyExchangeTokens". Specific authentication policies can't be applied. **Important**: +- Legacy Exchange Online tokens will be turned off for all organizations from August 2025 through September 2025. Once turned off, you can't use the _AllowLegacyExchangeTokens_ switch on the **Set-AuthenticationPolicy** cmdlet to turn on these tokens. You get the warning "Legacy Exchange Online tokens are disabled" when you run the command `Get-AuthenticationPolicy -AllowLegacyExchangeTokens`. You can [contact Microsoft Support to request an exception](https://aka.ms/LegacyTokensByOctober). 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). - 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 will eventually be 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 @@ -387,6 +416,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthActiveSync + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthActiveSync switch specifies whether to allow only modern authentication with Exchange ActiveSync in Exchange 2019 CU2 or later hybrid environments. @@ -398,7 +430,6 @@ The BlockLegacyAuthActiveSync switch specifies whether to allow only modern auth Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -408,6 +439,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthAutodiscover + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthAutodiscover switch specifies whether to allow only modern authentication with Autodiscover in Exchange 2019 CU2 or later hybrid environments. @@ -419,7 +453,6 @@ The BlockLegacyAuthAutodiscover switch specifies whether to allow only modern au Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -429,6 +462,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthImap + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthImap switch specifies whether to allow only modern authentication with IMAP in Exchange 2019 CU2 or later hybrid environments. @@ -440,7 +476,6 @@ The BlockLegacyAuthImap switch specifies whether to allow only modern authentica Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -450,6 +485,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthMapi + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthMapi switch specifies whether to allow only modern authentication with MAPI in Exchange 2019 CU2 or later hybrid environments. @@ -461,7 +499,6 @@ The BlockLegacyAuthMapi switch specifies whether to allow only modern authentica Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -471,6 +508,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthOfflineAddressBook + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthOfflineAddressBook switch specifies whether to allow only modern authentication with Offline Address Books in Exchange 2019 CU2 or later hybrid environments. @@ -482,7 +522,6 @@ The BlockLegacyAuthOfflineAddressBook switch specifies whether to allow only mod Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -492,6 +531,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthPop + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthPop switch specifies whether to allow only modern authentication with POP in Exchange 2019 CU2 or later hybrid environments. @@ -503,7 +545,6 @@ The BlockLegacyAuthPop switch specifies whether to allow only modern authenticat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -513,6 +554,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthRpc + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthRpc switch specifies whether to allow only modern authentication with RPC in Exchange 2019 CU2 or later hybrid environments. @@ -524,7 +568,6 @@ The BlockLegacyAuthRpc switch specifies whether to allow only modern authenticat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -534,6 +577,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthWebServices + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BlockLegacyAuthWebServices switch specifies whether to allow only modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU2 or later hybrid environments. @@ -545,7 +591,6 @@ The BlockLegacyAuthWebServices switch specifies whether to allow only modern aut Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -555,27 +600,29 @@ Accept wildcard characters: False ``` ### -BlockLegacyExchangeTokens + +> Applicable: Exchange Online, Exchange Online Protection + 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. +The switch applies to the entire organization. The Identity parameter is required and must be set to the value "LegacyExchangeTokens". Specific authentication policies can't be applied. **Important**: +- Legacy Exchange Online tokens will be turned off for all organizations from August 2025 through September 2025. Once turned off, you can't use the _AllowLegacyExchangeTokens_ switch on the **Set-AuthenticationPolicy** cmdlet to turn on these tokens. You get the warning "Legacy Exchange Online tokens are disabled" when you run the command `Get-AuthenticationPolicy -AllowLegacyExchangeTokens`. You can [contact Microsoft Support to request an exception](https://aka.ms/LegacyTokensByOctober). 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). - 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. +- Legacy Exchange tokens issued to Outlook add-ins before token blocking was implemented in your organization 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. -- Legacy Exchange tokens will eventually be 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 @@ -585,6 +632,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthActiveSync + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -593,7 +643,6 @@ The BlockModernAuthActiveSync switch specifies whether to block modern authentic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -603,6 +652,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthAutodiscover + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -611,7 +663,6 @@ The BlockModernAuthAutodiscover switch specifies whether to block modern authent Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -621,6 +672,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthImap + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -629,7 +683,6 @@ The BlockModernAuthImap switch specifies whether to block modern authentication Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -639,6 +692,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthMapi + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -647,7 +703,6 @@ The BlockModernAuthMapi switch specifies whether to block modern authentication Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -657,6 +712,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthOfflineAddressBook + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -665,7 +723,6 @@ The BlockModernAuthOfflineAddressBook switch specifies whether to block modern a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -675,6 +732,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthPop + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -683,7 +743,6 @@ The BlockModernAuthPop switch specifies whether to block modern authentication w Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -693,6 +752,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthRpc + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -701,7 +763,6 @@ The BlockModernAuthRpc switch specifies whether to block modern authentication w Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -711,6 +772,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthWebServices + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -719,7 +783,6 @@ The BlockModernAuthWebServices switch specifies whether to block modern authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -729,6 +792,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -738,7 +804,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -748,6 +813,9 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill TenantId Description }} @@ -756,7 +824,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -766,13 +833,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelPolicy.md index 0bfb1b4949..e8c95a366c 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-autosensitivitylabelpolicy applicable: Security & Compliance -title: Set-AutoSensitivityLabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-autosensitivitylabelpolicy +schema: 2.0.0 +title: Set-AutoSensitivityLabelPolicy --- # Set-AutoSensitivityLabelPolicy @@ -98,11 +99,14 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned Set-AutoSensitivityLabelPolicy -Identity "Main PII" -AddSharePointLocation "https://my.url1","https://my.url2" -AddOneDriveLocation "https://my.url3","https://my.url4" ``` -This example adds the specified URLs to the SharePoint Online and OneDrive for Business locations for the autolabeling policy named Main PII without affecting the existing URL values. +This example adds the specified URLs to the SharePoint and OneDrive locations for the autolabeling policy named Main PII without affecting the existing URL values. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -113,7 +117,6 @@ The Identity parameter specifies the auto-labeling policy that you want to modif Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -123,7 +126,10 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation -The AddExchangeLocation parameter adds email messages to the policy if they're not already included. The valid value for this parameter is All. + +> Applicable: Security & Compliance + +The AddExchangeLocation parameter adds email messages to the policy if they aren't already included. The valid value for this parameter is All. If the policy doesn't already include email messages (in the output of the Get-AutoSensitivityLabelPolicy cmdlet, the ExchangeLocation property value is blank), you can use this parameter in the following procedures: @@ -143,7 +149,6 @@ You can't specify inclusions and exclusions in the same policy. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -153,7 +158,10 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation -The AddOneDriveLocation parameter specifies the OneDrive for Business sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +The AddOneDriveLocation parameter specifies the OneDrive sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -161,7 +169,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The AddOneDriveLocationException parameter specifies the OneDrive sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -179,7 +189,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. + +SharePoint sites can't be added to the policy until they have been indexed. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -199,7 +211,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The AddSharePointLocationException parameter specifies the SharePoint sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -217,7 +231,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The ApplySensitivityLabel parameter selects the label to use for the policy. This value overrides the previous label on the policy. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -243,6 +258,9 @@ Accept wildcard characters: False ``` ### -AutoEnableAfter + +> Applicable: Security & Compliance + 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. @@ -255,7 +273,6 @@ You must use this parameter with the -StartSimulation parameter. Type: System.TimeSpan Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -265,13 +282,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -281,6 +300,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -290,7 +312,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -300,16 +321,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter enables or disables the policy. Valid values are: -- $true: The policy is enabled. This is the default value. +- $true: The policy is enabled. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -319,11 +342,14 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedBy -The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the 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). + +> Applicable: Security & Compliance + +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, one of the following statements must be true: -- The policy already includes OneDrive for Business sites (in the output of Get-AutoSensitivityLabelPolicy, the OneDriveLocation property value is All, which is the default value). +- The policy already includes OneDrive sites (in the output of Get-AutoSensitivityLabelPolicy, the OneDriveLocation property value is All, which is the default value). - Use `-AddOneDriveLocation All` in the same command with this parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -334,7 +360,6 @@ You can't use this parameter with the OneDriveSharedBy parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -344,13 +369,15 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf + +> Applicable: Security & Compliance + {{ Fill ExceptIfOneDriveSharedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -360,13 +387,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -376,13 +405,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -392,6 +423,9 @@ Accept wildcard characters: False ``` ### -ExchangeSender + +> Applicable: Security & Compliance + The ExchangeSender parameter specifies the users whose email is included in the policy. You specify the users by email address. You can specify internal or external email addresses. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -407,7 +441,6 @@ You can't use this parameter with the ExchangeSenderException or ExchangeSenderM Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -417,6 +450,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderException + +> Applicable: Security & Compliance + The ExchangeSenderException parameter specifies the internal users whose email is excluded from the policy. You identify the users by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -432,7 +468,6 @@ You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf p Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -442,6 +477,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf + +> Applicable: Security & Compliance + The ExchangeSenderMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -459,7 +497,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -469,6 +506,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException + +> Applicable: Security & Compliance + The ExchangeSenderMemberOfException parameter specifies the distribution groups or mail-enabled security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -486,7 +526,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -496,6 +535,9 @@ Accept wildcard characters: False ``` ### -ExternalMailRightsManagementOwner + +> Applicable: Security & Compliance + The ExternalMailRightsManagementOwner parameter specifies the email address of a user mailbox that's used to encrypt incoming email messages from external senders using RMS. This parameter works only on Exchange locations, and the policy must apply a label that has an encryption action. @@ -506,7 +548,6 @@ To clear an existing email address, use the value $null. Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -516,6 +557,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -524,7 +568,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -534,13 +577,15 @@ Accept wildcard characters: False ``` ### -Locations + +> Applicable: Security & Compliance + {{ Fill Locations Description }} ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -550,6 +595,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Security & Compliance + The Mode parameter specifies the action and notification level of the auto-labeling policy. Valid values are: - Enable: The policy is enabled for actions and notifications. @@ -562,7 +610,6 @@ Type: PolicyMode Parameter Sets: (All) Aliases: Accepted values: Enable, TestWithNotifications, TestWithoutNotifications, Disable, PendingDeletion -Applicable: Security & Compliance Required: False Position: Named @@ -572,13 +619,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -588,13 +637,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -604,11 +655,14 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy -The OneDriveSharedBy parameter specifies the users to include in the 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). + +> Applicable: Security & Compliance + +The OneDriveSharedBy parameter specifies the users to include in the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, one of the following statements must be true: -- The policy already includes OneDrive for Business sites (in the output of Get-AutoSensitivityLabelPolicy, the OneDriveLocation property value is All, which is the default value). +- The policy already includes OneDrive sites (in the output of Get-AutoSensitivityLabelPolicy, the OneDriveLocation property value is All, which is the default value). - Use `-AddOneDriveLocation All` in the same command with this parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -619,7 +673,6 @@ You can't use this parameter with the ExceptIfOneDriveSharedBy parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -629,13 +682,15 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf + +> Applicable: Security & Compliance + {{ Fill OneDriveSharedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -645,10 +700,13 @@ Accept wildcard characters: False ``` ### -OverwriteLabel + +> Applicable: Security & Compliance + The OverwriteLabel parameter specifies whether to overwrite a manual label. Valid values are: - $true: Overwrite the manual label. -- $false: Don't overwrite the manual label. This is the default value. +- $false: Don't overwrite the manual label. This value is the default. This parameter works only on Exchange locations. @@ -656,7 +714,6 @@ This parameter works only on Exchange locations. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -666,6 +723,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + 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. @@ -674,7 +734,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -684,13 +743,15 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -700,6 +761,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and policies can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing policies. For example, if there are 5 existing policies: @@ -714,7 +778,6 @@ If you modify the priority value of a policy, the position of the policy in the Type: System.Int32 Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -724,6 +787,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter removes email messages from the policy if they're already included. The valid value for this parameter is All. If the policy already includes email messages (in the output of the Get-AutoSensitivityLabelPolicy cmdlet, the ExchangeLocation property value is All), you can use `-RemoveExchangeLocation All` to prevent the policy from applying to email messages. @@ -734,7 +800,6 @@ You can't use this parameter if email (the value Exchange) is used by any of the Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -744,7 +809,10 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation -The RemoveOneDriveLocation parameter specifies the OneDrive for Business sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +The RemoveOneDriveLocation parameter specifies the OneDrive sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -752,7 +820,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +This RemoveOneDriveLocationException parameter specifies the OneDrive sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -770,7 +840,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -788,7 +860,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The RemoveSharePointLocationException parameter specifies the SharePoint sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -806,7 +880,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The RetryDistribution switch redistributes the policy to all OneDrive and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -826,7 +902,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistributionParameterSet Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -836,13 +911,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -852,13 +929,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -868,6 +947,9 @@ Accept wildcard characters: False ``` ### -SpoAipIntegrationEnabled + +> Applicable: Security & Compliance + The SpoAipIntegrationEnabled parameter enables or disables built-in labeling for supported Office files in SharePoint and OneDrive. Valid values are: - $true: Users can apply your sensitivity labels in Office for the web. Users see the Sensitivity button on the ribbon so they can apply labels, and they see the name of any applied label on the status bar. @@ -877,7 +959,6 @@ The SpoAipIntegrationEnabled parameter enables or disables built-in labeling for Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -887,16 +968,18 @@ Accept wildcard characters: False ``` ### -StartSimulation + +> Applicable: Security & Compliance + Use the StartSimulation parameter to restart the simulation for updated results. Valid values are: - $true: Restart the simulation for updated results. **Any edits to an auto-labeling policy require restarting the simulation by using this value.** -- $false: This is the default value +- $false: This value is the default ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -906,13 +989,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelRule.md index f573b3a19e..ee05901854 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-autosensitivitylabelrule applicable: Security & Compliance -title: Set-AutoSensitivityLabelRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-autosensitivitylabelrule +schema: 2.0.0 +title: Set-AutoSensitivityLabelRule --- # Set-AutoSensitivityLabelRule @@ -98,6 +99,9 @@ This example changes the rule property "Comment" with the rule name "SocialSecur ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -108,7 +112,6 @@ The Identity parameter specifies the auto-labeling policy rule that you want to Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -AccessScope + +> Applicable: Security & Compliance + The AccessScope parameter specifies a condition for the auto-labeling policy rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule is applied to content that's accessible inside the organization. @@ -129,7 +135,6 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Required: False Position: Named @@ -139,13 +144,15 @@ Accept wildcard characters: False ``` ### -ActivationDate + +> Applicable: Security & Compliance + {{ Fill ActivationDate Description }} ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -155,6 +162,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The AnyOfRecipientAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -169,7 +179,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -179,6 +188,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -189,7 +201,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -199,13 +210,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -215,6 +228,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -224,7 +240,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -234,15 +249,21 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"; minCount="1"; minConfidence="85"})`. +Exact Data Match sensitive types are not supported outside of Groups. + +To use groups: `@(@{operator="And"; groups=@(@{name="Default"; operator="Or"; sensitivetypes=@(@{id="<>"; name="<>"; maxcount="-1"; classifiertype="ExactMatch"; mincount="100"; confidencelevel="Medium"})})})` + ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -252,13 +273,15 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ContentExtensionMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for words in file name extensions. You can specify multiple words separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -268,6 +291,9 @@ Accept wildcard characters: False ``` ### -ContentPropertyContainsWords + +> Applicable: Security & Compliance + The ContentPropertyContainsWords parameter specifies a condition for the auto-labeling policy rule that's based on a property match in content. The rule is applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -276,7 +302,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -286,13 +311,15 @@ Accept wildcard characters: False ``` ### -DefaultSpoDocLibraryHasLabel + +> Applicable: Security & Compliance + {{ Fill DefaultSpoDocLibraryHasLabel Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -302,16 +329,18 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the case hold rule is enabled or disabled. Valid values are: - $true: The rule is disabled. -- $false: The rule is enabled. This is the default value. +- $false: The rule is enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -321,13 +350,15 @@ Accept wildcard characters: False ``` ### -DocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill DocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -337,6 +368,9 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected + +> Applicable: Security & Compliance + The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -346,7 +380,6 @@ The DocumentIsPasswordProtected parameter specifies a condition for the auto-lab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -356,6 +389,9 @@ Accept wildcard characters: False ``` ### -DocumentIsUnsupported + +> Applicable: Security & Compliance + The DocumentIsUnsupported parameter specifies a condition for the auto-labeling policy rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -365,7 +401,6 @@ The DocumentIsUnsupported parameter specifies a condition for the auto-labeling Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -375,19 +410,20 @@ 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. + +> Applicable: Security & Compliance + +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 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -397,6 +433,9 @@ Accept wildcard characters: False ``` ### -DocumentSizeOver + +> Applicable: Security & Compliance + The DocumentSizeOver parameter specifies a condition for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -407,7 +446,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this condition in auto-labeling policy rules that are scoped only to Exchange. @@ -415,7 +454,6 @@ You can use this condition in auto-labeling policy rules that are scoped only to Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -425,6 +463,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAccessScope + +> Applicable: Security & Compliance + The ExceptIfAccessScopeAccessScope parameter specifies an exception for the auto-labeling policy rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule isn't applied to content that's accessible inside the organization. @@ -436,7 +477,6 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Required: False Position: Named @@ -446,6 +486,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. - Single word: `"no_reply"` @@ -460,7 +503,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -470,6 +512,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -480,7 +525,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -490,6 +534,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the auto-labeling policy rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -498,7 +545,6 @@ This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minC Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -508,13 +554,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words in file name extensions. You can specify multiple words separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -524,6 +572,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentPropertyContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentPropertyContainsWords parameter specifies an exception for the auto-labeling policy rule that's based on a property match in content. The rule is not applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -532,7 +583,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -542,13 +592,15 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill ExceptIfDocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -558,6 +610,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected + +> Applicable: Security & Compliance + The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -567,7 +622,6 @@ The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -577,6 +631,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsUnsupported + +> Applicable: Security & Compliance + The ExceptIfDocumentIsUnsupported parameter specifies an exception for the auto-labeling policy rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -586,7 +643,6 @@ The ExceptIfDocumentIsUnsupported parameter specifies an exception for the auto- Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -596,6 +652,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesWords + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -608,7 +667,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -618,6 +676,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentSizeOver + +> Applicable: Security & Compliance + The ExceptIfDocumentSizeOver parameter specifies an exception for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -628,7 +689,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this exception in auto-labeling policy rules that are scoped only to Exchange. @@ -636,7 +697,6 @@ You can use this exception in auto-labeling policy rules that are scoped only to Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -646,6 +706,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + The ExceptIfFrom parameter specifies an exception for the auto-labeling policy rule that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -659,7 +722,6 @@ The ExceptIfFrom parameter specifies an exception for the auto-labeling policy r Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -669,6 +731,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfFromAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -683,7 +748,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -693,6 +757,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -703,7 +770,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -713,6 +779,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Security & Compliance + The ExceptIfFromMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent by group members. You identify the group members by their 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"`. @@ -721,7 +790,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -731,6 +799,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -739,7 +810,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -749,6 +819,9 @@ Accept wildcard characters: False ``` ### -ExceptIfProcessingLimitExceeded + +> Applicable: Security & Compliance + The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule that looks for files where scanning couldn't complete. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -758,7 +831,6 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the aut Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -768,13 +840,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -784,6 +858,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + The ExceptIfSenderDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -792,7 +869,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -802,6 +878,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIPRanges + +> Applicable: Security & Compliance + The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -814,7 +893,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -824,6 +902,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + The ExceptIfSentTo parameter specifies an exception for the auto-labeling policy rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -841,7 +922,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -851,6 +931,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Security & Compliance + The ExceptIfSentToMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -859,7 +942,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -869,6 +951,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -879,7 +964,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -889,13 +973,15 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -905,13 +991,15 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -921,6 +1009,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Security & Compliance + The FromAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -935,7 +1026,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -945,6 +1035,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Security & Compliance + The FromAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -955,7 +1048,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -965,13 +1057,15 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -981,6 +1075,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -989,7 +1086,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -999,13 +1095,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1015,6 +1113,9 @@ Accept wildcard characters: False ``` ### -ProcessingLimitExceeded + +> Applicable: Security & Compliance + The ProcessingLimitExceeded parameter specifies a condition for the auto-labeling policy rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -1024,7 +1125,6 @@ The ProcessingLimitExceeded parameter specifies a condition for the auto-labelin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1034,13 +1134,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Security & Compliance + The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1050,10 +1152,13 @@ Accept wildcard characters: False ``` ### -ReportSeverityLevel + +> Applicable: Security & Compliance + The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: - None: You can't select this value if the rule has no actions configured. -- Low: This is the default value. +- Low: This value is the default. - Medium - High @@ -1062,7 +1167,6 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Required: False Position: Named @@ -1072,18 +1176,20 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Security & Compliance + The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - Ignore - RetryThenBlock -- Blank (the value $null): This is the default value. +- Blank (the value $null): This value is the default. ```yaml Type: PolicyRuleErrorAction Parameter Sets: (All) Aliases: Accepted values: Ignore, RetryThenBlock -Applicable: Security & Compliance Required: False Position: Named @@ -1093,6 +1199,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Security & Compliance + The SenderDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -1101,7 +1210,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1111,6 +1219,9 @@ Accept wildcard characters: False ``` ### -SenderIPRanges + +> Applicable: Security & Compliance + The SenderIpRanges parameter specifies a condition for the auto-sensitivity policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -1123,7 +1234,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1133,6 +1243,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + The SentTo parameter specifies a condition for the auto-sensitivity policy rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1150,7 +1263,6 @@ You can use this condition in auto-sensitivity policies that are scoped only to Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1160,6 +1272,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Security & Compliance + The SentToMemberOf parameter specifies a condition for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -1168,7 +1283,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1178,13 +1292,15 @@ Accept wildcard characters: False ``` ### -SourceType + +> Applicable: Security & Compliance + {{ Fill SourceType Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1194,6 +1310,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Security & Compliance + The SubjectMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -1204,7 +1323,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1214,13 +1332,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -1230,6 +1350,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Security & Compliance + The Workload parameter specifies the workload. Valid values are: - Exchange @@ -1241,7 +1364,6 @@ Type: Workload Parameter Sets: (All) Aliases: Accepted values: Exchange, SharePoint, OneDriveForBusiness -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-AutodiscoverVirtualDirectory.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AutodiscoverVirtualDirectory.md index 21d6376337..1691eb2ac3 100644 --- a/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AutodiscoverVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-autodiscovervirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AutodiscoverVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-autodiscovervirtualdirectory +schema: 2.0.0 +title: Set-AutodiscoverVirtualDirectory --- # Set-AutodiscoverVirtualDirectory @@ -39,7 +40,7 @@ Set-AutodiscoverVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example sets Integrated Windows authentication for the Autodiscover virtual ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Autodiscover virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -79,7 +83,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,16 +92,18 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: -- $true: Basic authentication is enabled. This is the default value. +- $true: Basic authentication is enabled. This value is the default. - $false: Basic authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -117,7 +125,6 @@ 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 Required: False Position: Named @@ -127,16 +134,18 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. -- $false: Digest authentication is disabled. This is the default value. +- $false: Digest authentication is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,19 +173,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,16 +197,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,10 +218,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -215,7 +233,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +242,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ExternalUrl parameter specifies the URL used to connect to the virtual directory from outside the network firewall. @@ -233,7 +253,6 @@ The ExternalUrl parameter specifies the URL used to connect to the virtual direc Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The InternalUrl parameter specifies the URL used to connect to the virtual directory from inside the network firewall. @@ -251,7 +273,6 @@ The InternalUrl parameter specifies the URL used to connect to the virtual direc Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -261,16 +282,18 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OAuthAuthentication parameter specifies whether OAuth authentication is enabled on the virtual directory. Valid values are: -- $true: OAuth authentication is enabled. This is the default value. +- $true: OAuth authentication is enabled. This value is the default. - $false: OAuth authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +303,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,16 +321,18 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: -- $true: Integrated Windows authentication is enabled. This is the default value. +- $true: Integrated Windows authentication is enabled. This value is the default. - $false: Integrated Windows authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -315,16 +342,18 @@ Accept wildcard characters: False ``` ### -WSSecurityAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are: -- $true: WS-Security authentication is enabled. This is the default value. +- $true: WS-Security authentication is enabled. This value is the default. - $false: WS-Security authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityConfig.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-AvailabilityConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityConfig.md index 7fc266524e..dad6108eeb 100644 --- a/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-availabilityconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-AvailabilityConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-availabilityconfig +schema: 2.0.0 +title: Set-AvailabilityConfig --- # Set-AvailabilityConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-AvailabilityConfig cmdlet to set the access level for free/busy information. @@ -38,7 +39,7 @@ For cross-forest availability services to retrieve free/busy information in the 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,6 +67,9 @@ In Exchange Online, this example allows free/busy sharing only with the specifie ## PARAMETERS ### -AllowedTenantIds + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowedTenantIds parameter specifies the tenant ID values of Microsoft 365 organization that you want to share free/busy information with (for example, d6b0a40e-029b-43f2-9852-f3724f68ead9). You can specify multiple values separated by commas. A maximum of 25 values are allowed. @@ -78,7 +82,6 @@ To add or remove tenant IDs without affecting other existing values, use the fol Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -97,7 +103,6 @@ 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 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -115,7 +123,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -OrgWideAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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: @@ -150,7 +160,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -PerUserAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -181,7 +193,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +202,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md b/exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityReportOutage.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityReportOutage.md index 051ad1654f..6920c4e782 100644 --- a/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityReportOutage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-availabilityreportoutage applicable: Exchange Server 2010 -title: Set-AvailabilityReportOutage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-availabilityreportoutage +schema: 2.0.0 +title: Set-AvailabilityReportOutage --- # Set-AvailabilityReportOutage @@ -45,7 +46,7 @@ Set-AvailabilityReportOutage [-Identity] - ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,13 +60,15 @@ This example overrides the specified outage with a new downtime value of 40 minu ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the outage to add to the outage reporting. ```yaml Type: AvailabilityReportOutageIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010 + The Comment parameter describes the outage that was inserted. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -ReportDate + +> Applicable: Exchange Server 2010 + The ReportDate parameter specifies the date to query for the outage report. ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -ResetToOriginal + +> Applicable: Exchange Server 2010 + The ResetToOriginal switch resets the previously selected outage value to the default value. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ResetToOriginal Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -123,6 +132,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -132,7 +144,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -DowntimeMinutes + +> Applicable: Exchange Server 2010 + The DowntimeMinutes parameter specifies the number of minutes of downtime to insert into the outage report. ```yaml Type: Double Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -158,6 +171,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010 + 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. @@ -166,7 +182,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -176,13 +191,15 @@ Accept wildcard characters: False ``` ### -ReportingDatabase + +> Applicable: Exchange Server 2010 + The ReportingDatabase parameter specifies the name of the database on the reporting server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -192,13 +209,15 @@ Accept wildcard characters: False ``` ### -ReportingServer + +> Applicable: Exchange Server 2010 + The ReportingServer parameter specifies the name of the reporting database server to connect to. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -208,13 +227,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CASMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-CASMailbox.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-CASMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CASMailbox.md index c7a16a5f1a..07ac50c1d5 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CASMailbox.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-casmailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-CASMailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-casmailbox +schema: 2.0.0 +title: Set-CASMailbox --- # Set-CASMailbox ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-CASMailbox cmdlet to configure client access settings on a mailbox. For example, you can configure settings for Exchange ActiveSync, Outlook, Outlook on the web, POP3, and IMAP4. @@ -80,7 +81,7 @@ Set-CASMailbox [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -108,6 +109,9 @@ This example sets the display name and disables Outlook Anywhere access for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to configure. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +129,6 @@ The Identity parameter specifies the mailbox that you want to configure. You can Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -135,6 +138,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncAllowedDeviceIDs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + TheActiveSyncAllowedDeviceIDs parameter specifies one or more Exchange ActiveSync device IDs that are allowed to synchronize with the mailbox. A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have Exchange ActiveSync partnerships with the mailbox. 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"`. @@ -147,7 +153,6 @@ To clear the list of device IDs, use the value $null for this parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -157,6 +162,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncBlockedDeviceIDs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActiveSyncBlockedDeviceIDs parameter specifies one or more Exchange ActiveSync device IDs that aren't allowed to synchronize with the mailbox. A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have Exchange ActiveSync partnerships with the mailbox. 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"`. @@ -169,7 +177,6 @@ To clear the list of device IDs, use the value $null for this parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -179,16 +186,18 @@ Accept wildcard characters: False ``` ### -ActiveSyncDebugLogging + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActiveSyncDebugLogging parameter enables or disables Exchange ActiveSync debug logging for the mailbox. Valid values are: - $true: ActiveSync debug logging is enabled for 48 hours in Exchange Online, and 72 hours in Exchange Server. After the time period expires, the value reverts to $false. -- $false: ActiveSync debug logging is disabled. This is the default value +- $false: ActiveSync debug logging is disabled. This value is the default ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -198,9 +207,12 @@ Accept wildcard characters: False ``` ### -ActiveSyncEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActiveSyncEnabled parameter enables or disables access to the mailbox using Exchange ActiveSync. Valid values are: -- $true: Access to the mailbox using ActiveSync is enabled. This is the default value. +- $true: Access to the mailbox using ActiveSync is enabled. This value is the default. - $false. Access to the mailbox using ActiveSync is disabled. Other ActiveSync settings in this cmdlet are ignored. For more information, see [Enable or disable Exchange ActiveSync for a mailbox in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-exchange-activesync), or [Enable or disable Exchange ActiveSync access to mailboxes in Exchange Server](https://learn.microsoft.com/exchange/clients/exchange-activesync/activesync-mailbox-access). @@ -209,7 +221,6 @@ For more information, see [Enable or disable Exchange ActiveSync for a mailbox i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +230,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActiveSyncMailboxPolicy parameter specifies the Exchange ActiveSync mailbox policy for the mailbox. You can use any value that uniquely identifies the Exchange ActiveSync mailbox policy. For example: - Name @@ -231,7 +245,6 @@ The name of the default Exchange ActiveSync mailbox policy is Default. However, Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -241,16 +254,18 @@ Accept wildcard characters: False ``` ### -ActiveSyncSuppressReadReceipt + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActiveSyncSuppressReadReceipt parameter controls the behavior of read receipts for Exchange ActiveSync clients that access the mailbox. Valid values are: - $true: Read receipts are not automatically returned when the user opens a message sent with a read receipt request. -- $false: A read receipt is automatically returned when the user opens a message sent with a read receipt request. This is the default value. +- $false: A read receipt is automatically returned when the user opens a message sent with a read receipt request. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -260,6 +275,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -269,7 +287,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -279,6 +296,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -287,7 +307,6 @@ The DisplayName parameter specifies the display name of the mailbox. The display Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,6 +316,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -305,7 +327,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -315,18 +336,20 @@ Accept wildcard characters: False ``` ### -ECPEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ECPEnabled parameter enables or disables access the Exchange admin center (EAC) or the Exchange Control Panel (ECP) for the specified user. Valid values are: -- $true: Access to the EAC or ECP is enabled. This is the default value. +- $true: Access to the EAC or ECP is enabled. This value is the default. - $false: Access to the EAC or ECP is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -336,6 +359,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). @@ -363,7 +389,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -373,16 +398,18 @@ Accept wildcard characters: False ``` ### -EwsAllowEntourage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsAllowEntourage parameter enables or disables access to the mailbox by Microsoft Entourage clients that use Exchange Web Services (for example, Entourage 2008 for Mac, Web Services Edition). -- $true: Access to the mailbox using Microsoft Entourage is enabled. This is the default value. +- $true: Access to the mailbox using Microsoft Entourage is enabled. This value is the default. - $false: Access to the mailbox using Microsoft Entourage is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -392,6 +419,9 @@ Accept wildcard characters: False ``` ### -EwsAllowList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsAllowList parameter specifies the Exchange Web Services applications (user agent strings) that are allowed to access the mailbox. 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"`. @@ -404,7 +434,6 @@ This parameter is meaningful only when the EwsEnabled parameter is set to $true, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -414,9 +443,12 @@ Accept wildcard characters: False ``` ### -EwsAllowMacOutlook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsAllowMacOutlook parameter enables or disables access to the mailbox by Outlook for Mac clients that use Exchange Web Services (for example, Outlook for Mac 2011 or later). Valid values are: -- $true: Outlook for Mac clients that use EWS are allowed to access the mailbox. This is the default value. +- $true: Outlook for Mac clients that use EWS are allowed to access the mailbox. This value is the default. - $false: Outlook for Mac clients that use EWS are not allowed to access the mailbox. In the cloud-based service, access for Outlook for Mac clients that use Microsoft Sync technology is controlled by the MacOutlookEnabled parameter. @@ -425,7 +457,6 @@ In the cloud-based service, access for Outlook for Mac clients that use Microsof Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -435,6 +466,9 @@ Accept wildcard characters: False ``` ### -EwsAllowOutlook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsAllowOutlook parameter enables or disables access to the mailbox by Outlook clients that use Exchange Web Services. Outlook uses Exchange Web Services for free/busy, out-of-office settings, and calendar sharing. Valid values are: - $true: Access to the mailbox using EWS in Outlook clients is enabled. @@ -444,7 +478,6 @@ The EwsAllowOutlook parameter enables or disables access to the mailbox by Outlo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -454,6 +487,9 @@ Accept wildcard characters: False ``` ### -EwsApplicationAccessPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsApplicationAccessPolicy parameter controls access to the mailbox using Exchange Web Services applications. Valid values for this parameter are: @@ -467,7 +503,6 @@ This parameter doesn't affect access to the mailbox using Entourage, Outlook for Type: EwsApplicationAccessPolicy Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -477,6 +512,9 @@ Accept wildcard characters: False ``` ### -EwsBlockList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsBlockList parameter specifies the Exchange Web Services applications (user agent strings) that aren't allowed to access the mailbox using Exchange Web Services. 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"`. @@ -489,7 +527,6 @@ This parameter is meaningful only when the EwsEnabled parameter is set to $true, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -499,25 +536,32 @@ Accept wildcard characters: False ``` ### -EwsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. +- $true: Access to the mailbox using EWS is enabled. This value is the default. +- $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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### -HasActiveSyncDevicePartnership + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The HasActiveSyncDevicePartnership parameter specifies whether the mailbox has an Exchange ActiveSync device partnership established. Valid values are: @@ -529,7 +573,6 @@ The HasActiveSyncDevicePartnership parameter specifies whether the mailbox has a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -539,6 +582,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -552,7 +598,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -562,9 +607,12 @@ Accept wildcard characters: False ``` ### -ImapEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ImapEnabled parameter enables or disables access to the mailbox using IMAP4 clients. Valid values are: -- $true: Access to the mailbox using IMAP4 is enabled. This is the default value. +- $true: Access to the mailbox using IMAP4 is enabled. This value is the default. - $fale: Access to the mailbox using IMAP4 is disabled. The other IMAP4 settings in this cmdlet are ignored. For more information, see [Enable or Disable POP3 or IMAP4 access for a user in Exchange Online](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://learn.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). @@ -573,7 +621,6 @@ For more information, see [Enable or Disable POP3 or IMAP4 access for a user in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -583,12 +630,15 @@ Accept wildcard characters: False ``` ### -ImapEnableExactRFC822Size + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ImapEnableExactRFC822Size parameter specifies how message sizes are presented to IMAP4 clients that access the mailbox. Valid values are: - $true: Calculate the exact message size. -- $false: Use an estimated message size. This is the default value. +- $false: Use an estimated message size. This value is the default. We don't recommend changing this value unless you determine that the default setting causes problems for IMAP4 clients. To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false. @@ -596,7 +646,6 @@ We don't recommend changing this value unless you determine that the default set Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -606,10 +655,13 @@ Accept wildcard characters: False ``` ### -ImapForceICalForCalendarRetrievalOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ImapForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to IMAP4 clients that access the mailbox. Valid values are: - $true: All meeting requests are in the iCal format. -- $false: All meeting requests appear as Outlook on the web links. This is the default value. +- $false: All meeting requests appear as Outlook on the web links. This value is the default. To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false. @@ -617,7 +669,6 @@ To change the value of this parameter, you also need to set the value of the Ima Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -627,6 +678,9 @@ Accept wildcard characters: False ``` ### -ImapMessagesRetrievalMimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ImapMessagesRetrievalMimeFormat parameter specifies the message format for IMAP4 clients that access the mailbox. You can use an integer or a text value. Valid values are: - 0: TextOnly @@ -643,7 +697,6 @@ To change the value of this parameter, you also need to set the value of the Ima Type: MimeTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -653,10 +706,13 @@ Accept wildcard characters: False ``` ### -ImapSuppressReadReceipt + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ImapSuppressReadReceipt parameter controls the behavior of read receipts for IMAP4 clients that access the mailbox. Valid values are: - $true: The user receives a read receipt when the recipient opens the message. -- $false: The user receives two read receipts: one when the message is downloaded and another when the message is opened. This is the default value. +- $false: The user receives two read receipts: one when the message is downloaded and another when the message is opened. This value is the default. To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false. @@ -664,7 +720,6 @@ To change the value of this parameter, you also need to set the value of the Ima Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -674,9 +729,12 @@ Accept wildcard characters: False ``` ### -ImapUseProtocolDefaults + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ImapUseProtocolDefaults parameter specifies whether to use the IMAP4 protocol defaults for the mailbox. Valid values are: -- $true: Use the protocol defaults for IMAP4 access to the mailbox. This is the default value. +- $true: Use the protocol defaults for IMAP4 access to the mailbox. This value is the default. - $false: Use custom protocol settings for IMAP4 access to the mailbox. You need to set this parameter to $false when you use any of the following IMAP4 parameters: @@ -690,7 +748,6 @@ You need to set this parameter to $false when you use any of the following IMAP4 Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -700,6 +757,9 @@ Accept wildcard characters: False ``` ### -IsOptimizedForAccessibility + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The IsOptimizedForAccessibility parameter specifies whether the mailbox is configured to use the light version of Outlook on the web. Valid values are: @@ -711,7 +771,6 @@ The IsOptimizedForAccessibility parameter specifies whether the mailbox is confi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -721,11 +780,14 @@ Accept wildcard characters: False ``` ### -MacOutlookEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MacOutlookEnabled parameter enables or disables access to the mailbox using Outlook for Mac clients that use Microsoft Sync technology. Valid values are: -- $true: Access to the mailbox using Outlook for Mac clients is enabled. This is the default value. +- $true: Access to the mailbox using Outlook for Mac clients is enabled. This value is the default. - $false: Access to the mailbox using Outlook for Mac clients is disabled. Access for older Outlook for Mac clients that use Exchange Web Services is controlled by the EwsAllowMacOutlook parameter. @@ -734,7 +796,6 @@ Access for older Outlook for Mac clients that use Exchange Web Services is contr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -744,18 +805,20 @@ Accept wildcard characters: False ``` ### -MAPIBlockOutlookNonCachedMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MAPIBlockOutlookNonCachedMode parameter controls access to the mailbox using Outlook in online or offline mode. Valid values are: - $true: Only Outlook clients that are configured to use Cached Exchange Mode (offline mode) are allowed to access the mailbox. -- $false: The state of the Cached Exchange Mode setting isn't checked before Outlook clients are allowed to access the mailbox (online mode and offline mode are allowed). This is the default value. +- $false: The state of the Cached Exchange Mode setting isn't checked before Outlook clients are allowed to access the mailbox (online mode and offline mode are allowed). This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -765,6 +828,9 @@ Accept wildcard characters: False ``` ### -MAPIBlockOutlookExternalConnectivity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MAPIBlockOutlookExternalConnectivity parameter enables or disables external access to the mailbox in Outlook by removing the external URLs from the Autodiscover response. This setting affects Outlook Anywhere, MAPI over HTTP, and Exchange Web Services (EWS). Valid values are: @@ -772,13 +838,12 @@ The MAPIBlockOutlookExternalConnectivity parameter enables or disables external - $true: External Outlook clients can't use Outlook Anywhere, MAPI over HTTP, or EWS to access the mailbox. - $false: External Outlook clients can use Outlook Anywhere, MAPI over HTTP, or EWS to access the mailbox. -**Note**: If your organization uses the same Autodiscover URL values for internal and external clients, setting this parameter to $true won't block access for external clients. +**Note**: If your organization uses the same Autodiscover URL values for internal and external clients, setting this parameter to $true doesn't block access for external clients. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -788,18 +853,20 @@ Accept wildcard characters: False ``` ### -MAPIBlockOutlookRpcHttp + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MAPIBlockOutlookRpcHttp parameter enables or disables access to the mailbox in Outlook using Outlook Anywhere. Valid values are: - $true: Access to the mailbox using Outlook Anywhere is disabled. -- $false: Access to the mailbox using Outlook Anywhere is enabled. This is the default value. +- $false: Access to the mailbox using Outlook Anywhere is enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -809,6 +876,9 @@ Accept wildcard characters: False ``` ### -MAPIBlockOutlookVersions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MAPIBlockOutlookVersions parameter blocks access to the mailbox for specific versions of Outlook. @@ -821,7 +891,6 @@ The default value is blank. To reset this parameter, use the value $null. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -831,9 +900,12 @@ Accept wildcard characters: False ``` ### -MAPIEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MAPIEnabled parameter enables or disables access to the mailbox using MAPI clients (for example, Outlook). Valid values are: -- $true: Access to the mailbox using MAPI clients is enabled. This is the default value. +- $true: Access to the mailbox using MAPI clients is enabled. This value is the default. - $false: Access to the mailbox using MAPI clients is disabled. The other MAPI settings in this cmdlet are ignored. For more information, see[Enable or disable MAPI for a mailbox in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-mapi), or [Enable or disable MAPI access to mailboxes in Exchange Server](https://learn.microsoft.com/exchange/clients/mapi-mailbox-access). @@ -842,7 +914,6 @@ For more information, see[Enable or disable MAPI for a mailbox in Exchange Onlin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -852,19 +923,21 @@ Accept wildcard characters: False ``` ### -MapiHttpEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MapiHttpEnabled parameter enables or disables access to the mailbox in Outlook using MAPI over HTTP. Valid values are: - $true: Access to the mailbox using MAPI over HTTP is enabled. - $false: Access to the mailbox using MAPI over HTTP is disabled. -- $null (blank): The setting isn't configured. The mailbox uses the organization setting for MAPI over HTTP (the MapiHttpEnabled parameter on the Set-OrganizationConfig cmdlet). This is the default value. +- $null (blank): The setting isn't configured. The mailbox uses the organization setting for MAPI over HTTP (the MapiHttpEnabled parameter on the Set-OrganizationConfig cmdlet). This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -874,6 +947,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -882,7 +958,6 @@ The Name parameter specifies the unique name of the mailbox. The maximum length Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -892,19 +967,21 @@ Accept wildcard characters: False ``` ### -OneWinNativeOutlookEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OneWinNativeOutlookEnabled parameter enables or disables access to the mailbox using the new Outlook for Windows. Valid values are: -- $true: Access to the mailbox using the new Outlook for Windows is enabled. This is the default value. +- $true: Access to the mailbox using the new Outlook for Windows is enabled. This value is the default. - $false: Access to the mailbox using the new Outlook for Windows is disabled. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -914,18 +991,20 @@ Accept wildcard characters: False ``` ### -OutlookMobileEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookMobileEnabled parameter enables or disables access to the mailbox using Outlook for iOS and Android. Valid values are: -- $true: Access to the mailbox using Outlook for iOS and Android is enabled. This is the default value. +- $true: Access to the mailbox using Outlook for iOS and Android is enabled. This value is the default. - $false: Access to the mailbox using Outlook for iOS and Android is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -935,9 +1014,12 @@ Accept wildcard characters: False ``` ### -OWAEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAEnabled parameter enables or disables access to the mailbox using Outlook on the web (formerly known as Outlook Web App or OWA) and the new Outlook for Windows. Valid values are: -- $true: Access to the mailbox using Outlook on the web is enabled. This is the default value. +- $true: Access to the mailbox using Outlook on the web is enabled. This value is the default. - $false: Access to the mailbox using Outlook on the web and the new Outlook for Windows is disabled. The other Outlook on the web settings in this cmdlet are ignored. For more information, see [Enable or disable Outlook on the web for a mailbox in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-outlook-web-app), or [Enable or disable Outlook on the web access to mailboxes in Exchange Server](https://learn.microsoft.com/exchange/clients/outlook-on-the-web/mailbox-access). @@ -946,7 +1028,6 @@ For more information, see [Enable or disable Outlook on the web for a mailbox in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -956,16 +1037,18 @@ Accept wildcard characters: False ``` ### -OWAforDevicesEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAforDevicesEnabled parameter enables or disables access to the mailbox using the older Outlook Web App (OWA) app on iOS and Android devices. Valid values are: -- $true: Access to the mailbox using OWA for Devices is enabled. This is the default value. +- $true: Access to the mailbox using OWA for Devices is enabled. This value is the default. - $false: Access to the mailbox using OWA for Devices is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -975,6 +1058,9 @@ Accept wildcard characters: False ``` ### -OwaMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OwaMailboxPolicy parameter specifies the Outlook on the web mailbox policy for the mailbox. You can use any value that uniquely identifies the Outlook on the web mailbox policy. For example: - Name @@ -987,7 +1073,6 @@ The name of the default Outlook on the web mailbox policy is Default. Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -997,9 +1082,12 @@ Accept wildcard characters: False ``` ### -PopEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PopEnabled parameter enables or disables access to the mailbox using POP3 clients. Valid values are: -- $true: Access to the mailbox using POP3 clients is enabled. This is the default value. +- $true: Access to the mailbox using POP3 clients is enabled. This value is the default. - $false: Access to the mailbox using POP3 clients is disabled. The other POP3 settings in this cmdlet are ignored. For more information, see [Enable or Disable POP3 or IMAP4 access for a user in Exchange Online](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://learn.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). @@ -1008,7 +1096,6 @@ For more information, see [Enable or Disable POP3 or IMAP4 access for a user in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1018,12 +1105,15 @@ Accept wildcard characters: False ``` ### -PopEnableExactRFC822Size + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PopEnableExactRFC822Size parameter specifies how message sizes are presented to POP3 clients that access the mailbox. Valid values are: - $true: Calculate the exact message size. -- $false: Use an estimated message size. This is the default value +- $false: Use an estimated message size. This value is the default We don't recommend changing this value unless you determine that the default setting causes problems for POP3 clients. To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false. @@ -1031,7 +1121,6 @@ We don't recommend changing this value unless you determine that the default set Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1041,10 +1130,13 @@ Accept wildcard characters: False ``` ### -PopForceICalForCalendarRetrievalOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PopForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to POP3 clients that access the mailbox. Valid values are: - $true: All meeting requests are in the iCal format. -- $false: All meeting requests appear as Outlook on the web links. This is the default value. +- $false: All meeting requests appear as Outlook on the web links. This value is the default. To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false. @@ -1052,7 +1144,6 @@ To change the value of this parameter, you also need to set the value of the Pop Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1062,6 +1153,9 @@ Accept wildcard characters: False ``` ### -PopMessagesRetrievalMimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PopMessagesRetrievalMimeFormat parameter specifies the message format for POP3 clients that access the mailbox. You can use an integer or a text value. Valid values are: - 0: TextOnly @@ -1078,7 +1172,6 @@ To change the value of this parameter, you also need to set the value of the Pop Type: MimeTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1088,10 +1181,13 @@ Accept wildcard characters: False ``` ### -PopSuppressReadReceipt + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PopSuppressReadReceipt parameter controls the behavior of read receipts for POP3 clients that access the mailbox. Valid values are: - $true: The user receives a read receipt when the recipient opens the message. -- $false: The user receives two read receipts: one when the message is downloaded and another when the message is opened. This is the default value. +- $false: The user receives two read receipts: one when the message is downloaded and another when the message is opened. This value is the default. To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false. @@ -1099,7 +1195,6 @@ To change the value of this parameter, you also need to set the value of the Pop Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1109,9 +1204,12 @@ Accept wildcard characters: False ``` ### -PopUseProtocolDefaults + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PopUseProtocolDefaults parameter specifies whether to use the POP3 protocol defaults for the mailbox. Valid values are: -- $true: Use the protocol defaults for POP3 access to the mailbox. This is the default value. +- $true: Use the protocol defaults for POP3 access to the mailbox. This value is the default. - $false: Use custom protocol settings for POP3 access to the mailbox. You need to set this parameter to $false when you use any of following parameters: @@ -1125,7 +1223,6 @@ You need to set this parameter to $false when you use any of following parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1135,6 +1232,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. @@ -1143,7 +1243,6 @@ The PrimarySmtpAddress parameter specifies the primary return email address that Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1153,16 +1252,18 @@ Accept wildcard characters: False ``` ### -PublicFolderClientAccess + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: - $true: The user can access public folders in Outlook if the value of the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is $true (the default value is $false). -- $false: The user can't access public folders in Outlook if the value of the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is $true. This is the default value. +- $false: The user can't access public folders in Outlook if the value of the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is $true. This value is the default. ```yaml Type: Boolean Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1172,6 +1273,9 @@ Accept wildcard characters: False ``` ### -ResetAutoBlockedDevices + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ResetAutoBlockedDevices switch resets the status of blocked mobile devices that have exceeded the limits defined by the Set-ActiveSyncDeviceAutoblockThreshold cmdlet. You don't need to specify a value with this switch. @@ -1180,7 +1284,6 @@ The ResetAutoBlockedDevices switch resets the status of blocked mobile devices t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1190,15 +1293,17 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1208,16 +1313,18 @@ Accept wildcard characters: False ``` ### -ShowGalAsDefaultView + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowGalAsDefaultView parameter specifies whether the global address list (GAL) is the default recipient picker for messages. Valid values are: -- $true: Use the GAL as the primary address picker. This is the default value. +- $true: Use the GAL as the primary address picker. This value is the default. - $false: Don't use the GAL as the primary address picker. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1227,6 +1334,9 @@ Accept wildcard characters: False ``` ### -SmtpClientAuthenticationDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SmtpClientAuthenticationDisabled parameter specifies whether to disable authenticated SMTP (SMTP AUTH) for the mailbox. Examples of clients and services that require authenticated SMTP to send email messages include: @@ -1240,7 +1350,7 @@ Valid values for this parameter are: - $true: Authenticated SMTP is disabled for the mailbox. - $false: Authenticated SMTP is enabled for the mailbox. -- blank ($null): This is the default value. The authenticated SMTP setting for the mailbox is controlled by the corresponding SmtpClientAuthenticationDisabled parameter on the Set-TransportConfig cmdlet for the whole organization. +- blank ($null): This value is the default. The authenticated SMTP setting for the mailbox is controlled by the corresponding SmtpClientAuthenticationDisabled parameter on the Set-TransportConfig cmdlet for the whole organization. To selectively enable authenticated SMTP for specific mailboxes only: disable authenticated SMTP at the organizational level ($true), enable it for the specific mailboxes ($false), and leave the rest of the mailboxes with their default value ($null). @@ -1248,7 +1358,6 @@ To selectively enable authenticated SMTP for specific mailboxes only: disable au Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1258,18 +1367,20 @@ Accept wildcard characters: False ``` ### -UniversalOutlookEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The UniversalOutlookEnabled parameter enables or disables access to the mailbox using Windows 10 Mail and Calendar. Valid values are: -- $true: Access to the mailbox using Windows 10 Mail and Calendar is enabled. This is the default value. +- $true: Access to the mailbox using Windows 10 Mail and Calendar is enabled. This value is the default. - $false: Access to the mailbox using Windows 10 Mail and Calendar is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1279,13 +1390,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md b/exchange/exchange-ps/ExchangePowerShell/Set-CASMailboxPlan.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-CASMailboxPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CASMailboxPlan.md index 5901e16225..d7570a544d 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CASMailboxPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-casmailboxplan applicable: Exchange Online, Exchange Online Protection -title: Set-CASMailboxPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-casmailboxplan +schema: 2.0.0 +title: Set-CASMailboxPlan --- # Set-CASMailboxPlan @@ -38,7 +39,7 @@ Set-CASMailboxPlan [-Identity] ## DESCRIPTION A CAS mailbox plan is tied to the corresponding mailbox plan that has the same name (and display name). Like mailbox plans, CAS mailbox plans correspond to license types, and are applied to a mailbox when you license the user. The availability of a CAS mailbox plan is determined by your selections when you enroll in the service and the age of your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example disables Exchange ActiveSync and POP3 access to mailboxes in the CA ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the CAS mailbox plan that you want to modify. You can use any value that uniquely identifies the CAS mailbox plan. For example: - Name @@ -64,7 +68,6 @@ The display name and name of the CAS mailbox plan is the same as the correspondi Type: MailboxPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -74,16 +77,18 @@ Accept wildcard characters: False ``` ### -ActiveSyncEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ActiveSyncEnabled parameter enables or disables access to the mailbox by using Exchange Active Sync (EAS). Valid values are: -- $true: ActiveSync access to the mailbox is enabled. This is the default value. +- $true: ActiveSync access to the mailbox is enabled. This value is the default. - $false: ActiveSync access to the mailbox is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -102,7 +110,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -ECPEnabled + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill ECPEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -EwsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill EwsEnabled Description }} ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +155,9 @@ Accept wildcard characters: False ``` ### -ImapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ImapEnabled parameter enables or disables access to the mailbox by using IMAP4 clients. Valid values are: - $true: IMAP4 access to the mailbox is enabled. This is default value for all CAS mailbox plans except ExchangeOnlineDeskless. @@ -153,7 +167,6 @@ The ImapEnabled parameter enables or disables access to the mailbox by using IMA Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -MAPIEnabled + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill MAPIEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -OWAEnabled + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill OWAEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -195,6 +212,9 @@ Accept wildcard characters: False ``` ### -OwaMailboxPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The OwaMailboxPolicy parameter specifies the Outlook on the web (formerly known as Outlook Web App) mailbox policy for the mailbox. You can use any value that uniquely identifies the policy. For example: - Name @@ -209,7 +229,6 @@ You can use the Get-OwaMailboxPolicy cmdlet to view the available Outlook on the Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,16 +238,18 @@ Accept wildcard characters: False ``` ### -PopEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The PopEnabled parameter enables or disables access to the mailbox by using POP3 clients. Valid values are: -- $true: POP3 access to the mailbox is enabled. This is the default value. +- $true: POP3 access to the mailbox is enabled. This value is the default. - $false: POP3 access to the mailbox is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -238,13 +259,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CalendarNotification.md b/exchange/exchange-ps/ExchangePowerShell/Set-CalendarNotification.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-CalendarNotification.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CalendarNotification.md index 29fe0d712f..f2b894c1dd 100644 --- a/exchange/exchange-ps/exchange/Set-CalendarNotification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CalendarNotification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-calendarnotification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-CalendarNotification -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-calendarnotification +schema: 2.0.0 +title: Set-CalendarNotification --- # Set-CalendarNotification @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. The Set-CalendarNotification cmdlet allows users to set text message notification options for calendar events in their own calendar. By default, the MyTextMessaging end-user role gives access to this cmdlet, so admins can't configure text messaging notification for calendar events in user calendars. -**Note**: This cmdlet has been deprecated in Exchange Online PowerShell. The text message notification service has been discontinued in Microsoft 365. +**Note**: This cmdlet is deprecated in Exchange Online PowerShell. The text message notification service is discontinued in Microsoft 365. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -41,7 +42,7 @@ Set-CalendarNotification [-Identity] ## DESCRIPTION Users can receive text message notifications of changes to calendar events and daily agendas. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example configures the calendar in Tony's mailbox to send the following tex ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -76,7 +80,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -86,16 +89,18 @@ Accept wildcard characters: False ``` ### -CalendarUpdateNotification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarUpdateNotification parameter specifies whether calendar update text message notifications are sent to the user's mobile device. Valid values are: - $true: Calendar update text message notifications are enabled. -- $false: Calendar update text message notifications aren't enabled. This is the default value. +- $false: Calendar update text message notifications aren't enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,16 +110,18 @@ Accept wildcard characters: False ``` ### -CalendarUpdateSendDuringWorkHour + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarUpdateSendDuringWorkHour parameter specifies whether calendar update text notifications are sent to the user's mobile device during working hours only. Valid values are: - $true: Calendar update text message notifications are sent during working hours only. -- $false: Calendar update text message notifications are sent anytime. This is the default value. +- $false: Calendar update text message notifications are sent anytime. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -133,7 +143,6 @@ 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 Required: False Position: Named @@ -143,16 +152,18 @@ Accept wildcard characters: False ``` ### -DailyAgendaNotification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DailyAgendaNotification parameter specifies whether daily agenda text message notifications are sent to the user's mobile device. Valid values are: - $true: Daily agenda text message notifications are sent. -- $false: Daily agenda text message notifications aren't sent. This is the default value. +- $false: Daily agenda text message notifications aren't sent. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -DailyAgendaNotificationSendTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DailyAgendaNotificationSendTime parameter specifies the time to send daily agenda text message notifications to the user's mobile device. To specify a value, enter it as a time span: hh:mm:ss where hh = hours, mm = minutes and ss = seconds. @@ -172,7 +186,6 @@ The default value is 08:00:00. Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,13 +195,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,13 +213,15 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -214,16 +231,18 @@ Accept wildcard characters: False ``` ### -MeetingReminderNotification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MeetingReminderNotification parameter specifies whether meeting reminder text message notifications are sent to the user's mobile device. Valid values are: - $true: Meeting reminder text message notifications are sent. -- $false: Meeting reminder text message notifications aren't sent. This is the default value. +- $false: Meeting reminder text message notifications aren't sent. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,16 +252,18 @@ Accept wildcard characters: False ``` ### -MeetingReminderSendDuringWorkHour + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MeetingReminderSendDuringWorkHour parameter specifies whether meeting reminder text message notifications are sent to the user's mobile device during working hours only. Valid values are: - $true: Meeting update notifications are sent during working hours only. -- $false: Meeting update notifications are sent anytime. This is the default value. +- $false: Meeting update notifications are sent anytime. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,13 +273,15 @@ Accept wildcard characters: False ``` ### -NextDays + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NextDays parameter specifies how many days should be sent in the daily agenda text message notification to the user's mobile device. A valid value is an integer between 1 and 7. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -268,13 +291,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md b/exchange/exchange-ps/ExchangePowerShell/Set-CalendarProcessing.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-CalendarProcessing.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CalendarProcessing.md index edc2b0bc9a..2412c29cdc 100644 --- a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CalendarProcessing.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-calendarprocessing -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-CalendarProcessing -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-calendarprocessing +schema: 2.0.0 +title: Set-CalendarProcessing --- # Set-CalendarProcessing ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Set-CalendarProcessing cmdlet to modify calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant, and calendar configuration. Note that this cmdlet is effective only on resource mailboxes. +Use the Set-CalendarProcessing cmdlet to modify calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant, and calendar configuration. This cmdlet is effective only on resource 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). @@ -68,7 +69,7 @@ Set-CalendarProcessing [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -156,6 +157,9 @@ This example rejects meeting requests from any user who isn't a member of the Ex ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the resource mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -173,7 +177,6 @@ The Identity parameter specifies the resource mailbox that you want to modify. Y Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -183,10 +186,13 @@ Accept wildcard characters: False ``` ### -AddAdditionalResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AddAdditionalResponse parameter specifies whether additional information (the value of the AdditionalResponse parameter) is added to meeting request responses. Valid values are: - $true: Text from the AdditionalResponse parameter is added to meeting request responses. -- $false: No additional text is added to meeting request responses (any text in the AddAdditionalResponse parameter isn't used). This is the default value. +- $false: No additional text is added to meeting request responses (any text in the AddAdditionalResponse parameter isn't used). This value is the default. This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. @@ -194,7 +200,6 @@ This parameter is used only on resource mailboxes where the AutomateProcessing p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -204,13 +209,15 @@ Accept wildcard characters: False ``` ### -AdditionalResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AdditionalResponse parameter specifies the additional information to be included in responses to meeting requests when the value of the AddAdditionalResponse parameter is $true. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -220,16 +227,18 @@ Accept wildcard characters: False ``` ### -AddNewRequestsTentatively + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AddNewRequestsTentatively parameter specifies whether new meeting requests are added to the calendar as tentative. Valid values are: -- $true: New calendar items are added to the calendar as tentative. This is the default value. +- $true: New calendar items are added to the calendar as tentative. This value is the default. - $false: Only existing calendar items are updated by the Calendar Attendant. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -239,9 +248,12 @@ Accept wildcard characters: False ``` ### -AddOrganizerToSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AddOrganizerToSubject parameter specifies whether the meeting organizer's name is used as the subject of the meeting request. Valid values are: -- $true: The meeting organizer's name replaces any existing Subject value for the meeting request. This is the default value. +- $true: The meeting organizer's name replaces any existing Subject value for the meeting request. This value is the default. - $false: The original Subject value is preserved. This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. @@ -252,7 +264,6 @@ This parameter is used only on resource mailboxes where the AutomateProcessing p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,16 +273,18 @@ Accept wildcard characters: False ``` ### -AllBookInPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllBookInPolicy parameter specifies whether to automatically approve in-policy requests from all users to the resource mailbox. Valid values are: -- $true: In-policy requests from all users are automatically approved. This is the default value. +- $true: In-policy requests from all users are automatically approved. This value is the default. - $false: In-policy requests from all users aren't automatically approved (approval by a delegate is required). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -281,20 +294,22 @@ Accept wildcard characters: False ``` ### -AllowConflicts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowConflicts parameter specifies whether to allow conflicting meeting requests. Valid values are: - $true: Conflicts are allowed. A recurring meeting series is accepted regardless of whether any occurrences conflict with existing bookings. The values of the ConflictPercentageAllowed or MaximumConflictInstances parameters are ignored. -- $false: Conflicts aren't allowed. This is the default value. Whether an entire series is declined depends on the amount of conflicts in the series: +- $false: Conflicts aren't allowed. This value is the default. Whether an entire series is declined depends on the amount of conflicts in the series: • The series is declined if the number or percentage of conflicts is higher than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. - • The series is accepted, but conflicting occurrences are declined if the number or percentage of conflicts is lower than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. If the EnableResponseDetails parameter value is $true, the organizer will receive a notification email for each declined occurrence. + • The series is accepted, but conflicting occurrences are declined if the number or percentage of conflicts is lower than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. If the EnableResponseDetails parameter value is $true, the organizer receives a notification email for each declined occurrence. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -304,16 +319,18 @@ Accept wildcard characters: False ``` ### -AllowRecurringMeetings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowRecurringMeetings parameter specifies whether to allow recurring meetings in meeting requests. Valid values are: -- $true: Recurring meetings are allowed. This is the default value. +- $true: Recurring meetings are allowed. This value is the default. - $false: Recurring meetings aren't allowed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -323,16 +340,18 @@ Accept wildcard characters: False ``` ### -AllRequestInPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllRequestInPolicy parameter specifies whether to allow all users to submit in-policy requests to the resource mailbox. Valid values are: - $true: All users are allowed to submit in-policy requests to the resource mailbox. These requests require approval by a resource mailbox delegate if the AllBookInPolicy parameter is set to $false (the default value of AllBookInPolicy is $true). -- $false: All users can't submit in-policy requests to the resource mailbox. This is the default value. +- $false: All users can't submit in-policy requests to the resource mailbox. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -342,16 +361,18 @@ Accept wildcard characters: False ``` ### -AllRequestOutOfPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllRequestOutOfPolicy parameter specifies whether to allow all users to submit out-of-policy requests to the resource mailbox. Valid values are: - $true: All users are allowed to submit out-of-policy requests to the resource mailbox. Out-of-policy requests require approval by a resource mailbox delegate. -- $false: All users can't submit out-of-policy requests to the resource mailbox. This is the default value. +- $false: All users can't submit out-of-policy requests to the resource mailbox. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -361,6 +382,9 @@ Accept wildcard characters: False ``` ### -AutomateProcessing + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AutomateProcessing parameter enables or disables calendar processing on the mailbox. Valid values are: - None: Calendar processing is disabled on the mailbox. Both the resource booking attendant and the Calendar Attendant are disabled on the mailbox. @@ -377,7 +401,6 @@ The default value for user mailboxes is AutoUpdate, but you can't change the val Type: CalendarProcessingFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -387,18 +410,20 @@ Accept wildcard characters: False ``` ### -BookingType + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingType parameter specifies how reservations work on the resource mailbox. Valid values are: -- Standard: The resource can be reserved based on the other settings in this cmdlet. This is the default value +- Standard: The resource can be reserved based on the other settings in this cmdlet. This value is the default - Reserved: The resource can't be reserved. ```yaml Type: Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -408,13 +433,15 @@ Accept wildcard characters: False ``` ### -BookingWindowInDays + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BookingWindowInDays parameter specifies the maximum number of days in advance that the resource can be reserved. A valid value is an integer from 0 through 1080. The default value is 180 days. The value 0 means today. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -424,6 +451,9 @@ Accept wildcard characters: False ``` ### -BookInPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BookInPolicy parameter specifies users or groups who are allowed to submit in-policy meeting requests to the resource mailbox that are automatically approved. You can use any value that uniquely identifies the user or group. For example: - Name @@ -445,7 +475,6 @@ To add users or groups without affecting the other entries, see Example 7. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -455,6 +484,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -464,7 +496,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -474,6 +505,9 @@ Accept wildcard characters: False ``` ### -ConflictPercentageAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConflictPercentageAllowed parameter specifies the maximum percentage of meeting conflicts for new recurring meeting requests. A valid value is an integer from 0 through 100. The default value is 0. If a new recurring meeting request conflicts with existing reservations for the resource more than the percentage specified by this parameter, the recurring meeting request is automatically declined. When the value is 0, no conflicts are permitted for new recurring meeting requests. @@ -482,7 +516,6 @@ If a new recurring meeting request conflicts with existing reservations for the Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -492,9 +525,12 @@ Accept wildcard characters: False ``` ### -DeleteAttachments + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeleteAttachments parameter specifies whether to remove attachments from all incoming messages. Valid values are: -- $true: Remove any attachments in incoming messages. This is the default value. +- $true: Remove any attachments in incoming messages. This value is the default. - $false: Preserve any attachments in incoming messages. This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. @@ -503,7 +539,6 @@ This parameter is used only on resource mailboxes where the AutomateProcessing p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -513,9 +548,12 @@ Accept wildcard characters: False ``` ### -DeleteComments + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeleteComments parameter specifies whether to remove or keep any text in the message body of incoming meeting requests. Valid values are: -- $true: Remove any text in the message body of incoming meeting requests. This is the default value. +- $true: Remove any text in the message body of incoming meeting requests. This value is the default. - $false: Preserve any text in the message body of incoming meeting requests. This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. @@ -524,7 +562,6 @@ This parameter is used only on resource mailboxes where the AutomateProcessing p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -534,16 +571,18 @@ Accept wildcard characters: False ``` ### -DeleteNonCalendarItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeleteNonCalendarItems parameter specifies whether to remove or keep all non-calendar-related messages that are received by the resource mailbox. Valid values are: -- $true: Non-calendar messages are deleted. This is the default value. +- $true: Non-calendar messages are deleted. This value is the default. - $false: Non-calendar messages are preserved. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -553,9 +592,12 @@ Accept wildcard characters: False ``` ### -DeleteSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeleteSubject parameter specifies whether to remove or keep the subject of incoming meeting requests. Valid values are: -- $true: Remove the Subject value of incoming meeting requests. This is the default value. +- $true: Remove the Subject value of incoming meeting requests. This value is the default. - $false: Preserve The Subject value of incoming meeting requests. This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. @@ -564,7 +606,6 @@ This parameter is used only on resource mailboxes where the AutomateProcessing p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -574,6 +615,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -582,7 +626,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -592,6 +635,9 @@ Accept wildcard characters: False ``` ### -EnableAutoRelease + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill EnableAutoRelease Description }} @@ -600,7 +646,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -610,16 +655,18 @@ Accept wildcard characters: False ``` ### -EnableResponseDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EnableResponseDetails parameter specifies whether to include the reasons for accepting or declining a meeting in the response email message. Valid values are: -- $true: The reasons for accepting or declining a meeting are included in the response message. This is the default value. +- $true: The reasons for accepting or declining a meeting are included in the response message. This value is the default. - $false: The reasons for accepting or declining a meeting aren't included in the response message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -629,18 +676,20 @@ Accept wildcard characters: False ``` ### -EnforceCapacity + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EnforceCapacity parameter specifies whether to restrict the number of attendees to the capacity of the workspace. For example, if capacity is set to 10, then only 10 people can book the workspace. Valid values are: - $true: Capacity is enforced. -- $false: Capacity is not enforced. This is the default value. +- $false: Capacity is not enforced. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -650,16 +699,18 @@ Accept wildcard characters: False ``` ### -EnforceSchedulingHorizon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EnforceSchedulingHorizon parameter controls the behavior of recurring meetings that extend beyond the date specified by the BookingWindowInDays parameter. Valid values are: -- $true: A recurring meeting request is automatically declined if the meetings start on or before the date specified by the BookingWindowInDays parameter, and the meetings extend beyond the specified date. This is the default value. -- $false: A recurring meeting request is automatically accepted if the meetings start on or before the date specified by the BookingWindowInDays parameter, and the meetings extend beyond the specified date. However, the number of meetings is automatically reduced so meetings won't occur after the specified date. +- $true: A recurring meeting request is automatically declined if the meetings start on or before the date specified by the BookingWindowInDays parameter, and the meetings extend beyond the specified date. This value is the default. +- $false: A recurring meeting request is automatically accepted if the meetings start on or before the date specified by the BookingWindowInDays parameter, and the meetings extend beyond the specified date. However, the number of meetings is automatically reduced so meetings don't occur after the specified date. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -669,16 +720,18 @@ Accept wildcard characters: False ``` ### -ForwardRequestsToDelegates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForwardRequestsToDelegates parameter specifies whether to forward incoming meeting requests to the delegates that are configured for the resource mailbox. Valid values are: -- $true: Forward incoming meeting requests to the delegates. This is the default value. +- $true: Forward incoming meeting requests to the delegates. This value is the default. - $false: Don't forward incoming meeting requests to the delegates. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -688,6 +741,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -699,7 +755,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -709,6 +764,9 @@ Accept wildcard characters: False ``` ### -MaximumConflictInstances + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaximumConflictInstances parameter specifies the maximum number of conflicts for new recurring meeting requests when the AllowRecurringMeetings parameter is set to $true. A valid value is an integer from 0 through INT32 (2147483647). The default value is 0. If a new recurring meeting request conflicts with existing reservations for the resource more than the number of times specified by the MaximumConflictInstances parameter value, the recurring meeting request is automatically declined. When the value is 0, no conflicts are permitted for new recurring meeting requests. @@ -717,7 +775,6 @@ If a new recurring meeting request conflicts with existing reservations for the Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -727,6 +784,9 @@ Accept wildcard characters: False ``` ### -MaximumDurationInMinutes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaximumDurationInMinutes parameter specifies the maximum duration in minutes for meeting requests. A valid value is an integer from 0 through INT32 (2147483647). The default value is 1440 (24 hours). When the value is set to 0, the maximum duration of a meeting is unlimited. For recurring meetings, the value of this parameter applies to the length of an individual meeting instance. @@ -735,7 +795,6 @@ When the value is set to 0, the maximum duration of a meeting is unlimited. For Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -745,6 +804,9 @@ Accept wildcard characters: False ``` ### -MinimumDurationInMinutes + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MinimumDurationInMinutes parameter specifies the minimum duration in minutes for meeting requests in workspace mailboxes. A valid value is an integer from 0 through INT32 (2147483647). The default value is 0, which means there is no minimum duration. @@ -757,7 +819,6 @@ This parameter only works on workspace mailboxes. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -767,16 +828,18 @@ Accept wildcard characters: False ``` ### -OrganizerInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OrganizerInfo parameter specifies whether the resource mailbox sends organizer information when a meeting request is declined because of conflicts. Valid values are: -- $true: Organizer information is sent when a meeting request is declined because of conflicts. This is the default value. +- $true: Organizer information is sent when a meeting request is declined because of conflicts. This value is the default. - $false: Organizer information isn't sent when a meeting request is declined because of conflicts. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -786,6 +849,9 @@ Accept wildcard characters: False ``` ### -PostReservationMaxClaimTimeInMinutes + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill PostReservationMaxClaimTimeInMinutes Description }} @@ -794,7 +860,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -804,16 +869,18 @@ Accept wildcard characters: False ``` ### -ProcessExternalMeetingMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ProcessExternalMeetingMessages parameter specifies whether to process meeting requests that originate outside the Exchange organization. Valid values are: - $true: Meeting requests from external senders are processed. -- $false: Meeting requests from external senders are rejected. This is the default value. +- $false: Meeting requests from external senders are rejected. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -823,18 +890,20 @@ Accept wildcard characters: False ``` ### -RemoveCanceledMeetings + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The RemoveCanceledMeetings parameter specifies whether to automatically delete meetings that were cancelled by the organizer from the resource mailbox's calendar. Valid values are: - $true: Canceled meetings are deleted. -- $false: Canceled meetings aren't deleted. This is the default value. +- $false: Canceled meetings aren't deleted. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -844,16 +913,18 @@ Accept wildcard characters: False ``` ### -RemoveForwardedMeetingNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoveForwardedMeetingNotifications parameter specifies whether forwarded meeting notifications are moved to the Deleted Items folder after they're processed by the Calendar Attendant. Valid values are: - $true: Processed forwarded meeting notifications are deleted (moved to the Deleted Items folder). -- $false: Processed forwarded meeting notifications aren't deleted. This is the default value. +- $false: Processed forwarded meeting notifications aren't deleted. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -863,16 +934,18 @@ Accept wildcard characters: False ``` ### -RemoveOldMeetingMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoveOldMeetingMessages parameter specifies whether the Calendar Attendant removes old and redundant updates and responses. Valid values are: -- $true: Outdated and redundant meeting messages are deleted. This is the default value. +- $true: Outdated and redundant meeting messages are deleted. This value is the default. - $false: Outdated and redundant meeting messages aren't deleted. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -882,16 +955,18 @@ Accept wildcard characters: False ``` ### -RemovePrivateProperty + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemovePrivateProperty parameter specifies whether to clear the private flag for incoming meetings that were sent by the organizer in the original requests. Valid values are: -- $true: The private flag for incoming meeting requests is cleared (the meeting is no longer private). This is the default value. +- $true: The private flag for incoming meeting requests is cleared (the meeting is no longer private). This value is the default. - $false: The private flag for incoming meeting requests is preserved (private meetings stay private). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -901,6 +976,9 @@ Accept wildcard characters: False ``` ### -RequestInPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestInPolicy parameter specifies users who are allowed to submit in-policy meeting requests to the resource mailbox that require approval by a resource mailbox delegate. You can use any value that uniquely identifies the user. For example: - Name @@ -916,7 +994,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -926,6 +1003,9 @@ Accept wildcard characters: False ``` ### -RequestOutOfPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestOutOfPolicy parameter specifies users who are allowed to submit out-of-policy requests that require approval by a resource mailbox delegate. You can use any value that uniquely identifies the user. For example: - Name @@ -941,7 +1021,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -951,6 +1030,9 @@ Accept wildcard characters: False ``` ### -ResourceDelegates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResourceDelegates parameter specifies users can approve or reject requests that are sent to the resource mailbox. You can use any value that uniquely identifies the user. For example: - Name @@ -966,7 +1048,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -976,10 +1057,13 @@ Accept wildcard characters: False ``` ### -ScheduleOnlyDuringWorkHours + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ScheduleOnlyDuringWorkHours parameter specifies whether to allow meetings to be scheduled outside of the working hours that are defined for the resource mailbox. Valid values are: - $true: Meeting requests that are outside of working hours are automatically rejected. -- $false: Meeting requests that are outside of working hours aren't automatically rejected. This is the default value. +- $false: Meeting requests that are outside of working hours aren't automatically rejected. This value is the default. You configure the working hours of the resource mailbox by using the WorkDays, WorkingHoursStartTime, WorkingHoursEndTime and WorkingHoursTimeZone parameters on the Set-MailboxCalendarConfiguration cmdlet. @@ -987,7 +1071,6 @@ You configure the working hours of the resource mailbox by using the WorkDays, W Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -997,16 +1080,18 @@ Accept wildcard characters: False ``` ### -TentativePendingApproval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TentativePendingApproval parameter specifies whether to mark pending requests as tentative on the calendar. Valid values are: -- $true: Meeting requests that are awaiting approval from a delegate appear in the calendar as tentative. This is the default value. +- $true: Meeting requests that are awaiting approval from a delegate appear in the calendar as tentative. This value is the default. - $false: Meeting requests that are awaiting approval appear in the calendar as free. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1016,13 +1101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldPolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldPolicy.md index 496d25d22f..d6849d6df6 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-caseholdpolicy applicable: Security & Compliance -title: Set-CaseHoldPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-caseholdpolicy +schema: 2.0.0 +title: Set-CaseHoldPolicy --- # Set-CaseHoldPolicy @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Set-CaseHoldPolicy cmdlet to modify existing case hold policies in the Microsoft Purview compliance portal. -**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. If you need to update a policy multiple times, make all changes in a single call of the cmdlet. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy). +**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. If you need to update a policy multiple times, make all changes in a single call of the cmdlet. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/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). @@ -63,13 +64,16 @@ Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "K This example makes the following changes to the existing case hold policy named "Regulation 123 Compliance": - Adds the mailbox for the user named Kitty Petersen. -- Adds the SharePoint Online site `https://contoso.sharepoint.com/sites/teams/finance`. +- Adds the SharePoint site `https://contoso.sharepoint.com/sites/teams/finance`. - Removes public folders. - Updates the comment. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -80,7 +84,6 @@ The Identity parameter specifies the case hold policy that you want to modify. Y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -90,7 +93,10 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. + +> Applicable: Security & Compliance + +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -100,7 +106,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes. Valid values are: - A mailbox @@ -127,7 +135,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -137,13 +144,15 @@ Accept wildcard characters: False ``` ### -AddPublicFolderLocation + +> Applicable: Security & Compliance + The AddPublicFolderLocation parameter specifies that you want to add all public folders to the case hold policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -153,17 +162,19 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation -The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -SharePoint Online sites can't be added to the policy until they have been indexed. +SharePoint sites can't be added to the policy until they have been indexed. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -173,13 +184,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -189,6 +202,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -198,7 +214,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -208,16 +223,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -227,6 +244,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -235,7 +255,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -245,6 +264,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter specifies the existing mailboxes to remove from the policy. Valid values are: - A mailbox @@ -262,7 +284,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -272,13 +293,15 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation + +> Applicable: Security & Compliance + The RemovePublicFolderLocation parameter specifies that you want to remove all public folders from the case hold policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -288,7 +311,10 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation -The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -296,7 +322,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -306,13 +331,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-CaseHoldRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldRule.md index 3935336a80..b608519c55 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-caseholdrule applicable: Security & Compliance -title: Set-CaseHoldRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-caseholdrule +schema: 2.0.0 +title: Set-CaseHoldRule --- # Set-CaseHoldRule @@ -45,6 +46,9 @@ This example disables the enabled case hold rule named "Internal Company Rule". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the case hold rule that you want to modify. You Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -90,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -108,7 +118,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -118,16 +127,18 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the case hold rule is enabled or disabled. Valid values are: - $true: The rule is disabled. -- $false: The rule is enabled. This is the default value. +- $false: The rule is enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -137,13 +148,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Set-ClassificationRuleCollection.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ClassificationRuleCollection.md index 1848e06aee..2d0a4b5f89 100644 --- a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ClassificationRuleCollection.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-classificationrulecollection -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ClassificationRuleCollection -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-classificationrulecollection +schema: 2.0.0 +title: Set-ClassificationRuleCollection --- # Set-ClassificationRuleCollection ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-ClassificationRuleCollection cmdlet to update existing classification rule collections in your organization. @@ -31,7 +32,7 @@ Set-ClassificationRuleCollection [-FileData] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example imports the classification rule collection file C:\\My Documents\\E ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FileData parameter specifies the classification rule collection file you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -53,7 +57,6 @@ 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, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -74,7 +80,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessArray.md b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessArray.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-ClientAccessArray.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessArray.md index caa657f795..527bdc1924 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessArray.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessArray.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessarray applicable: Exchange Server 2010 -title: Set-ClientAccessArray -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-clientaccessarray +schema: 2.0.0 +title: Set-ClientAccessArray --- # Set-ClientAccessArray @@ -32,7 +33,7 @@ Set-ClientAccessArray [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +61,9 @@ This example associates the existing Client Access array named ContosoArray with ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Client Access array that you want to modify. You can use these values: - Name (if the value doesn't contain spaces) @@ -72,7 +76,6 @@ The Identity parameter specifies the Client Access array that you want to modify Type: ClientAccessArrayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -91,7 +97,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010 + The Fqdn parameter specifies the fully qualified domain name of the Client Access array (for example, casarray01.contoso.com). This is the value that RPC over TCP clients use to connect to the Client Access servers in the array. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the descriptive name of the Client Access array. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). If the value contains spaces, you can't use the Name value to identify the Client Access array for the Get-ClientAccessArray, Remove-ClientAccessArray, or Set-ClientAccessArray cmdlets. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010 + The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: - Name @@ -161,7 +175,6 @@ To see a list of available sites, use the Get-ADSite cmdlet. Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-ClientAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessRule.md index 9a82144d26..35a73dec35 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-ClientAccessRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-clientaccessrule +schema: 2.0.0 +title: Set-ClientAccessRule --- # Set-ClientAccessRule @@ -15,7 +16,7 @@ ms.reviewer: > [!NOTE] > Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). -This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-ClientAccessRule cmdlet to modify existing client access rules. Client access rules help you control access to your organization based on the properties of the connection. @@ -72,7 +73,7 @@ Protocols that don't support authentication type filters: - REST - UniversalOutlook -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,6 +87,9 @@ This example adds the IP address range 172.17.17.27/16 to the existing client ac ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the client access rule that you want to modify. You can use any value that uniquely identifies the client access rule. For example: - Name @@ -96,7 +100,6 @@ The Identity parameter specifies the client access rule that you want to modify. Type: ClientAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. ```yaml Type: ClientAccessRulesAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -AnyOfAuthenticationTypes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The AnyOfAuthenticationTypes parameter specifies a condition for the client access rule that's based on the client's authentication type. @@ -144,7 +152,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -154,6 +161,9 @@ Accept wildcard characters: False ``` ### -AnyOfClientIPAddressesOrRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AnyOfClientIPAddressesOrRanges parameter specifies a condition for the client access rule that's based on the client's IPv4 or IPv6 address. Valid values are: - Single IP address: For example, 192.168.1.1 or 2001:DB8::2AA:FF:C0A8:640A. @@ -170,7 +180,6 @@ For more information about IPv6 addresses and syntax, see this Exchange 2013 top Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -180,6 +189,9 @@ Accept wildcard characters: False ``` ### -AnyOfProtocols + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AnyOfProtocols parameter specifies a condition for the client access rule that's based on the client's protocol. Valid values for this parameter are: @@ -207,7 +219,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -217,13 +228,15 @@ Accept wildcard characters: False ``` ### -AnyOfSourceTcpPortNumbers + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -233,6 +246,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -242,7 +258,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -252,6 +267,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -260,7 +278,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,13 +287,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the client access rule is enabled or disabled. Valid values for this parameter are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -286,6 +305,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfAuthenticationTypes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptAnyOfAuthenticationTypes parameter specifies an exception for the client access rule that's based on the client's authentication type. @@ -308,7 +330,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -318,6 +339,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfClientIPAddressesOrRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExceptAnyOfClientIPAddressesOrRanges parameter specifies an exception for the client access rule that's based on the client's IPv4 or IPv6 address. Valid values are: - Single IP address: For example, 192.168.1.1 or 2001:DB8::2AA:FF:C0A8:640A. @@ -334,7 +358,6 @@ For more information about IPv6 addresses and syntax, see this Exchange 2013 top Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -344,6 +367,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfProtocols + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptAnyOfProtocols parameter specifies an exception for the client access rule that's based on the client's protocol. @@ -371,7 +397,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -381,13 +406,15 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfSourceTcpPortNumbers + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -397,13 +424,15 @@ Accept wildcard characters: False ``` ### -ExceptUserIsMemberOf + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -413,6 +442,9 @@ Accept wildcard characters: False ``` ### -ExceptUsernameMatchesAnyOfPatterns + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. @@ -425,7 +457,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -435,13 +466,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the client access rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -451,13 +484,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the client access rule. A lower integer value indicates a higher priority, and a higher priority rule is evaluated before a lower priority rule. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -467,6 +502,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Scope parameter specifies the scope of the client access rule. Valid values are: - Users: The rule only applies to end-user connections. @@ -476,7 +514,6 @@ The Scope parameter specifies the scope of the client access rule. Valid values Type: ClientAccessRulesScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -486,13 +523,15 @@ Accept wildcard characters: False ``` ### -UserIsMemberOf + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -502,6 +541,9 @@ Accept wildcard characters: False ``` ### -UsernameMatchesAnyOfPatterns + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. @@ -514,7 +556,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -524,6 +565,9 @@ Accept wildcard characters: False ``` ### -UserRecipientFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPATH filter syntax to identify the user based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties. @@ -563,7 +607,6 @@ For detailed information about OPATH filter syntax in Exchange, see [Additional Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -573,13 +616,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessServer.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-ClientAccessServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessServer.md index 343bf8d337..0c106a7e10 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessserver -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ClientAccessServer -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-clientaccessserver +schema: 2.0.0 +title: Set-ClientAccessServer --- # Set-ClientAccessServer @@ -59,7 +60,7 @@ Set-ClientAccessServer [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +74,9 @@ This example configures the internal Autodiscover URL for the Active Directory s ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -84,7 +88,6 @@ The Identity parameter specifies the server that you want to modify. You can use Type: ClientAccessServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AlternateServiceAccountCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AlternateServiceAccountCredential parameter specifies an alternative service account username and password that's typically used for Kerberos authentication in Exchange Server 2010 coexistence environments. You can specify multiple values separated by commas. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -102,7 +108,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential[] Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,13 +117,15 @@ Accept wildcard characters: False ``` ### -Array + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ClientAccessArrayIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -AutoDiscoverServiceInternalUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDiscoverServiceInternalUri parameter specifies the internal URL of the Autodiscover service. ```yaml Type: Uri Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverSiteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDiscoverSiteScope parameter specifies the Active Directory site that the Autodiscover service is authoritative for. Clients that connect to the Autodiscover service by using the internal URL need to exist in the specified site. To see the available Active Directory sites, use the Get-ADSite cmdlet. @@ -154,7 +166,6 @@ To specify multiple values, use the following syntax: `Value1,Value2,...ValueN`. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -CleanUpInvalidAlternateServiceAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CleanUpInvalidAlternateServiceAccountCredentials switch specifies whether to remove a previously configured alternate service account that's no longer valid. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -189,7 +205,6 @@ 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 Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,6 +232,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogEnabled parameter specifies whether logging is enabled for Information Rights Management (IRM). Valid values are $true or $false. The default value is $true. @@ -223,7 +243,6 @@ The IrmLogEnabled parameter specifies whether logging is enabled for Information Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -233,6 +252,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxAge parameter specifies the max age for IRM logs. Logs older than the specified value are deleted. @@ -245,7 +267,6 @@ For example, to specify a 15-hour interval, enter 15:00:00. The default value is Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -255,6 +276,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxDirectorySize parameter specifies the maximum directory size for IRM logs. When the maximum directory size is reached, the server deletes the old log files first. @@ -269,13 +293,12 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -285,6 +308,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxFileSize parameter specifies the maximum size of the IRM log. This value can't be larger than the IrmLogMaxDirectorySize parameter value. @@ -298,7 +324,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be less than or equal to the value of the ReceiveProtocolLogMaxDirectorySize parameter. @@ -306,7 +332,6 @@ The value of this parameter must be less than or equal to the value of the Recei Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -316,15 +341,19 @@ Accept wildcard characters: False ``` ### -IrmLogPath + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogPath parameter specifies the location of the IRM log files. The default location is %ExchangeInstallPath%Logging\\IRMLogs. +If you set the value of this parameter to $null, you effectively disable IRM logging. However, if the value of the IrmLogEnabled parameter is $true, Exchange adds errors to the Application event log. The preferred way to disable IRM logging is to set the IrmLogEnabled parameter to $false. + ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -334,6 +363,9 @@ Accept wildcard characters: False ``` ### -IsOutOfService + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -342,7 +374,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -352,13 +383,15 @@ Accept wildcard characters: False ``` ### -RemoveAlternateServiceAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoveAlternateServiceAccountCredentials switch specifies whether to remove a previously distributed alternate service account. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -368,13 +401,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessService.md b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessService.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-ClientAccessService.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessService.md index bff2cc0183..67d8e44f47 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessservice -applicable: Exchange Server 2016, Exchange Server 2019 -title: Set-ClientAccessService -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-clientaccessservice +schema: 2.0.0 +title: Set-ClientAccessService --- # Set-ClientAccessService @@ -45,7 +46,7 @@ Set-ClientAccessService [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example configures the internal Autodiscover URL for the Active Directory s ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the server that you want to modify. You can use Type: ClientAccessServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AlternateServiceAccountCredential + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AlternateServiceAccountCredential parameter specifies an alternative service account that's typically used for Kerberos authentication in Exchange Server 2010 coexistence environments. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -88,7 +94,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential[] Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -Array + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ClientAccessArrayIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -AutoDiscoverServiceInternalUri + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDiscoverServiceInternalUri parameter specifies the internal URL of the Autodiscover service. ```yaml Type: Uri Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverSiteScope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDiscoverSiteScope parameter specifies the Active Directory site that the Autodiscover service is authoritative for. Clients that connect to the Autodiscover service by using the internal URL need to exist in the specified site. To see the available Active Directory sites, use the Get-ADSite cmdlet. @@ -140,7 +152,6 @@ To specify multiple values, use the following syntax: `Value1,Value2,...ValueN`. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -CleanUpInvalidAlternateServiceAccountCredentials + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CleanUpInvalidAlternateServiceAccountCredentials switch specifies whether to remove a previously configured alternate service account that's no longer valid. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -175,7 +191,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,13 +200,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,13 +218,15 @@ Accept wildcard characters: False ``` ### -RemoveAlternateServiceAccountCredentials + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoveAlternateServiceAccountCredentials switch specifies whether to remove a previously distributed alternate service account. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,13 +236,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Clutter.md b/exchange/exchange-ps/ExchangePowerShell/Set-Clutter.md similarity index 77% rename from exchange/exchange-ps/exchange/Set-Clutter.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Clutter.md index 980d6d409c..69a1410858 100644 --- a/exchange/exchange-ps/exchange/Set-Clutter.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Clutter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-clutter applicable: Exchange Online, Exchange Online Protection -title: Set-Clutter -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-clutter +schema: 2.0.0 +title: Set-Clutter --- # Set-Clutter @@ -28,7 +29,7 @@ Set-Clutter -Identity ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example disables Clutter for the user Alexander Martinez. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -69,16 +72,18 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: Exchange Online, Exchange Online Protection + The Enable parameter specifies whether to enable or disable Clutter for the mailbox. Valid values are: -- $true: Clutter is enabled for the mailbox. This is the default value. +- $true: Clutter is enabled for the mailbox. This value is the default. - $false: Clutter is disabled for the mailbox. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill UseCustomRouting Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md b/exchange/exchange-ps/ExchangePowerShell/Set-CmdletExtensionAgent.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CmdletExtensionAgent.md index 4fcef9f94d..4ce86eaea0 100644 --- a/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CmdletExtensionAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-cmdletextensionagent -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-CmdletExtensionAgent -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-cmdletextensionagent +schema: 2.0.0 +title: Set-CmdletExtensionAgent --- # Set-CmdletExtensionAgent @@ -31,11 +32,11 @@ Set-CmdletExtensionAgent [-Identity] ``` ## DESCRIPTION -Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or third-party products can't use cmdlet extension agents. +Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or non-Microsoft products can't use cmdlet extension agents. The changes that you make by using the Set-CmdletExtensionAgent cmdlet are applied to every Exchange server in the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example changes the priority of the fictitious "Validation Agent" cmdlet ex ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the cmdlet extension agent that you want to modify. You can use any value that uniquely identifies the agent. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the cmdlet extension agent that you want to mod Type: CmdletExtensionAgentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -78,7 +84,6 @@ 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 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name of the cmdlet extension agent. The maximum length of the agent name is 64 characters. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Priority parameter specifies the priority of the cmdlet extension agent. Higher priority agents are applied before lower priority agents. A valid value is an integer from 0 to 255. Lower integer values indicate higher priority. ```yaml Type: Byte Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ComplianceCase.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceCase.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-ComplianceCase.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceCase.md index 2975872e51..def617a424 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceCase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceCase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancecase applicable: Security & Compliance -title: Set-ComplianceCase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-compliancecase +schema: 2.0.0 +title: Set-ComplianceCase --- # Set-ComplianceCase @@ -49,6 +50,9 @@ This example adds a description and case Id to the existing eDiscovery case name ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the compliance case that you want to modify. You can use any value that uniquely identifies the case. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the compliance case that you want to modify. Yo Type: ComplianceCaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -CaseType + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: ComplianceCaseType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -Close + +> Applicable: Security & Compliance + The Close switch specifies that you want to close the compliance case. 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 @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -109,7 +119,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the compliance case. The maximum length is 256 characters. 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 @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -151,13 +164,15 @@ Accept wildcard characters: False ``` ### -ExternalId + +> Applicable: Security & Compliance + The ExternalId parameter specifies an optional ID or external case number that you can associate with the compliance case. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -167,13 +182,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the compliance case. 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: False Position: Named @@ -183,13 +200,15 @@ Accept wildcard characters: False ``` ### -Reopen + +> Applicable: Security & Compliance + The Reopen switch specifies that you want to re-open a closed compliance case. 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 @@ -199,13 +218,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceRetentionEventType.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceRetentionEventType.md index 095fd20c7a..336c84486c 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceRetentionEventType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-complianceretentioneventtype applicable: Security & Compliance -title: Set-ComplianceRetentionEventType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-complianceretentioneventtype +schema: 2.0.0 +title: Set-ComplianceRetentionEventType --- # Set-ComplianceRetentionEventType @@ -29,7 +30,7 @@ Set-ComplianceRetentionEventType -Identity ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example add a comment to the retention event type named Fabrikam Project ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention event type that you want to modify. You can use any value that uniquely identifies the retention event type. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the retention event type that you want to modif Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -88,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearch.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearch.md index fa19fdd7d3..1cc1cdb8a1 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Set-ComplianceSearch -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-compliancesearch +schema: 2.0.0 +title: Set-ComplianceSearch --- # Set-ComplianceSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-ComplianceSearch cmdlet to modify non-running compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. @@ -52,7 +53,7 @@ Set-ComplianceSearch [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. @@ -86,6 +87,9 @@ You might have to change the language setting if you're using non-English keywor ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Identity parameter specifies the compliance search that you want to modify. You can use any value that uniquely identifies the compliance search. For example: @@ -99,7 +103,6 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Microsoft 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. @@ -120,7 +126,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocationExclusion + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to add to the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -143,7 +151,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -153,9 +160,12 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. -The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -163,7 +173,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -173,6 +182,9 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationExclusion + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -181,7 +193,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -191,10 +202,13 @@ Accept wildcard characters: False ``` ### -AllowNotFoundExchangeLocationsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The AllowNotFoundExchangeLocationsEnabled parameter specifies whether to include mailboxes other than regular user mailboxes in the compliance search. Valid values are: - $true: The search doesn't try to validate the existence of the mailbox before proceeding. This value is required if you want to search mailboxes that don't resolve as regular mailboxes. -- $false: The search tries to validate the existence of the mailbox before proceeding. If you specify a mailbox that isn't a regular user mailbox, the search will fail. This is the default value. +- $false: The search tries to validate the existence of the mailbox before proceeding. If you specify a mailbox that isn't a regular user mailbox, the search will fail. This value is the default. The mailbox types that are affected by the value of this parameter include: @@ -207,7 +221,6 @@ The mailbox types that are affected by the value of this parameter include: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -217,6 +230,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -226,7 +242,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -236,6 +251,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -244,7 +262,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -254,13 +271,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Description parameter specifies a description for the compliance search. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -270,6 +289,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include. Valid values are: - A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Microsoft 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. @@ -284,7 +306,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -294,6 +315,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocationExclusion + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -307,7 +331,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -317,6 +340,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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. @@ -325,7 +351,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -335,19 +360,21 @@ Accept wildcard characters: False ``` ### -HoldNames + +> Applicable: Security & Compliance + 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. +The HoldNames parameter specifies the content locations placed on hold in the specified eDiscovery case are 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 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. +Also, if a content location was placed on a query-based case hold, only items that are on hold are 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. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -357,13 +384,15 @@ Accept wildcard characters: False ``` ### -IncludeOrgContent + +> Applicable: Security & Compliance + {{ Fill IncludeOrgContent Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -373,18 +402,20 @@ Accept wildcard characters: False ``` ### -IncludeUserAppContent + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The IncludeUserAppContent parameter specifies that you want to search the cloud-based storage location for users who don't have a regular Microsoft 365 user account in your organization. These types of users include users without an Exchange Online license who use Office applications, Microsoft 365 guest users, and on-premises users whose identity is synchronized with your Microsoft 365 organization. Valid values are: -- $true: The cloud-based storage location for the users specified in any of the Exchange location parameters will be included in the search. If you use the value All for the ExchangeLocation parameter, the cloud-based storage location for any guest or on-premises user will be included in the search. -- $false: The cloud-based storage location for the users specified in the ExchangeLocation parameter won't be included in the search. This is the default value. +- $true: The cloud-based storage location for the users specified in any of the Exchange location parameters are included in the search. If you use the value All for the ExchangeLocation parameter, the cloud-based storage location for any guest or on-premises user are included in the search. +- $false: The cloud-based storage location for the users specified in the ExchangeLocation parameter isn't included in the search. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -394,6 +425,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Language parameter specifies the language for the compliance search. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -402,7 +436,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -412,13 +445,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -428,6 +463,9 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The PublicFolderLocation parameter specifies that you want to include all public folders in the search. You use the value All for this parameter. @@ -436,7 +474,6 @@ The PublicFolderLocation parameter specifies that you want to include all public Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -446,6 +483,9 @@ Accept wildcard characters: False ``` ### -RefinerNames + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -454,7 +494,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -464,6 +503,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -475,7 +517,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -485,6 +526,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocationExclusion + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -498,7 +542,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -508,6 +551,9 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -516,7 +562,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -526,9 +571,12 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. -The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -536,7 +584,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -546,6 +593,9 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationExclusion + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -554,7 +604,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -564,9 +613,12 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. +The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -574,7 +626,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -584,6 +635,9 @@ Accept wildcard characters: False ``` ### -SharePointLocationExclusion + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -592,7 +646,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -602,6 +655,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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. @@ -610,7 +666,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearchAction.md similarity index 75% rename from exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearchAction.md index bb8e2af626..60be06c85d 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearchAction.md @@ -1,17 +1,21 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancesearchaction -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Set-ComplianceSearchAction -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-compliancesearchaction +schema: 2.0.0 +title: Set-ComplianceSearchAction --- # 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. @@ -30,7 +34,7 @@ Set-ComplianceSearchAction [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. @@ -46,6 +50,9 @@ This example changes the export key on the export compliance search action named ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Identity parameter specifies the compliance search action that you want to modify. You can use any value that uniquely identifies the compliance search action. For example: - Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"` (for example, `"Case 1234_Preview`). @@ -55,7 +62,6 @@ The Identity parameter specifies the compliance search action that you want to m Type: ComplianceSearchActionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -65,6 +71,9 @@ Accept wildcard characters: False ``` ### -ChangeExportKey + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The ChangeExportKey switch creates a new export key for the compliance search action. You don't need to specify a value with this switch. This switch is meaningful only on export compliance search actions. @@ -73,7 +82,6 @@ This switch is meaningful only on export compliance search actions. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -83,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -92,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -102,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -118,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSecurityFilter.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSecurityFilter.md index 4f490b5f0f..f69d0441f0 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSecurityFilter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancesecurityfilter -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Set-ComplianceSecurityFilter -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-compliancesecurityfilter +schema: 2.0.0 +title: Set-ComplianceSecurityFilter --- # Set-ComplianceSecurityFilter @@ -62,13 +63,15 @@ This example removes user annb@contoso.com to the compliance security filter nam ## PARAMETERS ### -FilterName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The FilterName parameter specifies the name of the compliance security filter that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Action parameter specifies that type of search action that the filter is applied to. A valid value for this parameter is All, which means the filter is applied to all search actions. - Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. @@ -90,7 +96,6 @@ The Action parameter specifies that type of search action that the filter is app Type: ComplianceSecurityFilterActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -109,7 +117,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Description parameter specifies a description for the compliance security filter. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -135,11 +144,14 @@ Accept wildcard characters: False ``` ### -Filters + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Filters parameter specifies the search criteria for the compliance security filter. You can create three different types of filters: - Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is `Mailbox_`, where `` is a mailbox property value. For example,`"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"` allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). - Mailbox content filter: Specifies the mailbox content the assigned users can search for. Valid syntax is `MailboxContent_`, where `` specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example, `"MailboxContent_Recipients -like 'contoso.com'"` allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable email properties, see [Keyword queries for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions#searchable-email-properties). -- Site and site content filter: There are two SharePoint Online and OneDrive for Business site-related filters that you can create: `Site_` (specifies site-related properties. For example,`"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"` allows users to only search for content in the `https://contoso.sharepoint.com/sites/doctors` site collection) and `SiteContent_` (specifies content-related properties. For example, `"SiteContent_FileExtension -eq 'docx'"` allows users to only search for Word documents). For a list of searchable site properties, see [Overview of crawled and managed properties in SharePoint Server](https://learn.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. +- Site and site content filter: There are two SharePoint and OneDrive site-related filters that you can create: `Site_` (specifies site-related properties. For example,`"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"` allows users to only search for content in the `https://contoso.sharepoint.com/sites/doctors` site collection) and `SiteContent_` (specifies content-related properties. For example, `"SiteContent_FileExtension -eq 'docx'"` allows users to only search for Word documents). For a list of searchable site properties, see [Overview of crawled and managed properties in SharePoint Server](https://learn.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. You can specify multiple filters of the same type. For example, `"Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'"`. @@ -147,7 +159,6 @@ You can specify multiple filters of the same type. For example, `"Mailbox_Custom Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -Region + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Region parameter specifies the satellite location for multi-geo tenants to conduct eDiscovery searches in. Valid values are: - APC: Asia-Pacific @@ -176,7 +190,6 @@ If you don't use this parameter in a multi-geo tenant, eDiscovery searches are p Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -186,6 +199,9 @@ Accept wildcard characters: False ``` ### -Users + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Users parameter specifies the user who gets this filter applied to their searches. Valid values are: - One or more users: Identify users by their alias or email address. You can specify multiple values separated by commas. @@ -194,13 +210,12 @@ The Users parameter specifies the user who gets this filter applied to their sea You can't specify distribution groups with this parameter. -The values you specify will overwrite any existing entries. See the Examples section to add or remove users without affecting other existing entries. +The values you specify overwrite any existing entries. See the Examples section to add or remove users without affecting other existing entries. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -210,13 +225,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ComplianceTag.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceTag.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-ComplianceTag.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceTag.md index ef1e0e1fd7..49c0584557 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancetag applicable: Security & Compliance -title: Set-ComplianceTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-compliancetag +schema: 2.0.0 +title: Set-ComplianceTag --- # Set-ComplianceTag @@ -67,6 +68,9 @@ This example modifies the existing label named HR Content by modifying the reten ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the label that you want to modify. You can use any value that uniquely identifies the tag. For example: - Name @@ -77,7 +81,6 @@ The Identity parameter specifies the label that you want to modify. You can use Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -AutoApprovalPeriod + +> Applicable: Security & Compliance + {{ Fill AutoApprovalPeriod Description }} ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -ComplianceTagForNextStage + +> Applicable: Security & Compliance + {{ Fill ComplianceTagForNextStage Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -144,7 +156,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Security & Compliance + The EventType specifies the retention rule that's associated with the label. You can use any value that uniquely identifies the rule. For example: - Name @@ -166,7 +180,6 @@ You can use the Get-RetentionComplianceRule cmdlet to view the available retenti Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -176,6 +189,9 @@ Accept wildcard characters: False ``` ### -FilePlanProperty + +> Applicable: Security & Compliance + The FilePlanProperty parameter specifies the file plan properties to include in the label. To view the file plan property names that you need to use in this parameter, run the following commands: - `Get-FilePlanPropertyAuthority | Format-List Name` @@ -209,7 +225,6 @@ You use the second variable as the value for this parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -FlowId + +> Applicable: Security & Compliance + **Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. The FlowId parameter specifies the Power Automate flow to run at the end of the retention period. A valid value for this parameter is the GUID value of the flow. @@ -232,7 +250,6 @@ You can find the GUID value of the flow by using either of the following methods Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -242,6 +259,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -250,7 +270,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -260,6 +279,9 @@ Accept wildcard characters: False ``` ### -MultiStageReviewProperty + +> Applicable: Security & Compliance + The MultiStageReviewProperty parameter specifies the multi-stage review properties to include in the label. This parameter uses the following syntax: `'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'` @@ -274,7 +296,6 @@ This syntax is a JSON object that defines each review stage id, review stage nam Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -284,13 +305,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Security & Compliance + The Notes parameter specifies an optional note. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is a user note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -300,13 +323,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: PriorityCleanup Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -316,6 +341,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - A positive integer. @@ -325,7 +353,6 @@ The RetentionDuration parameter specifies the number of days to retain the conte Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -335,13 +362,15 @@ Accept wildcard characters: False ``` ### -ReviewerEmail + +> Applicable: Security & Compliance + 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. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -351,13 +380,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-Contact.md b/exchange/exchange-ps/ExchangePowerShell/Set-Contact.md similarity index 73% rename from exchange/exchange-ps/exchange/Set-Contact.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Contact.md index a173246fe3..835d80fec1 100644 --- a/exchange/exchange-ps/exchange/Set-Contact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Contact.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-contact -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-Contact -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-contact +schema: 2.0.0 +title: Set-Contact --- # Set-Contact ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-Contact cmdlet to modify contact object settings. If the contact is a mail contact, you can use the Set-MailContact cmdlet to modify other Microsoft Exchange settings that aren't available by using the Set-Contact cmdlet. @@ -67,7 +68,7 @@ Set-Contact [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -85,6 +86,9 @@ Change the Company parameter value to Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the contact that you want to modify. You can use any value that uniquely identifies the contact. For example: - Name @@ -96,7 +100,6 @@ The Identity parameter specifies the contact that you want to modify. You can us Type: ContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -AllowUMCallsFromNonUsers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AllowUMCallsFromNonUsers parameter specifies whether to exclude the contact from Unified Messaging directory searches. @@ -114,7 +120,6 @@ The AllowUMCallsFromNonUsers parameter specifies whether to exclude the contact Type: AllowUMCallsFromNonUsersFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,13 +129,15 @@ Accept wildcard characters: False ``` ### -AssistantName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AssistantName parameter specifies the name of the contact's assistant. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -140,13 +147,15 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The City parameter specifies the contact's city. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -Company + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Company parameter specifies the contact's company. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,6 +183,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -181,7 +195,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -191,6 +204,9 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CountryOrRegion parameter specifies the contact's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name). A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). @@ -201,7 +217,6 @@ The friendly name is returned in the CountryOrRegion property value by the Get-C Type: CountryInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -211,18 +226,20 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: -- $true: A DTMF map is created for the recipient. This is the default value. +- $true: A DTMF map is created for the recipient. This value is the default. - $false: A DTMF map isn't created for the recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -232,13 +249,15 @@ Accept wildcard characters: False ``` ### -Department + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Department parameter specifies the contact's department. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,6 +267,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the contact. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only if the contact is mail-enabled. @@ -256,7 +278,6 @@ This parameter is meaningful only if the contact is mail-enabled. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -266,6 +287,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -274,7 +298,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,13 +307,15 @@ Accept wildcard characters: False ``` ### -Fax + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Fax parameter specifies the contact's fax number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,13 +325,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -316,6 +343,9 @@ Accept wildcard characters: False ``` ### -GeoCoordinates + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The GeoCoordinates parameter specifies the contact's location in latitude, longitude and (optionally) altitude coordinates. A valid value for this parameter uses one of the following formats: - Latitude and longitude: For example, "47.644125;-122.122411" @@ -327,7 +357,6 @@ The GeoCoordinates parameter specifies the contact's location in latitude, longi Type: GeoCoordinates Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,13 +366,15 @@ Accept wildcard characters: False ``` ### -HomePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The HomePhone parameter specifies the contact's home telephone number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -353,6 +384,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -366,7 +400,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -376,13 +409,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -392,13 +427,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -408,13 +445,15 @@ Accept wildcard characters: False ``` ### -Manager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Manager parameter specifies the contact's manager. ```yaml Type: UserContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -424,13 +463,15 @@ Accept wildcard characters: False ``` ### -MobilePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MobilePhone parameter specifies the contact's primary mobile phone number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -440,13 +481,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the contact. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -456,13 +499,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -472,13 +517,15 @@ Accept wildcard characters: False ``` ### -Office + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Office parameter specifies the user's physical office name or number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -488,13 +535,15 @@ Accept wildcard characters: False ``` ### -OtherFax + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OtherFax parameter specifies the contact's alternative fax number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -504,13 +553,15 @@ Accept wildcard characters: False ``` ### -OtherHomePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OtherHomePhone parameter specifies the contact's alternative home telephone number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -520,13 +571,15 @@ Accept wildcard characters: False ``` ### -OtherTelephone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OtherTelephone parameter specifies the contact's alternative office telephone number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -536,13 +589,15 @@ Accept wildcard characters: False ``` ### -Pager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Pager parameter specifies the contact's pager number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -552,13 +607,15 @@ Accept wildcard characters: False ``` ### -Phone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Phone parameter specifies the contact's office telephone number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -568,13 +625,15 @@ Accept wildcard characters: False ``` ### -PhoneticDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -584,13 +643,15 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PostalCode parameter specifies the contact's postal code. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -600,13 +661,15 @@ Accept wildcard characters: False ``` ### -PostOfficeBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PostOfficeBox parameter specifies the contact's post office box number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -616,13 +679,15 @@ Accept wildcard characters: False ``` ### -SeniorityIndex -The SeniorityIndex parameter specifies the order in which this contact will display in a hierarchical address book. A contact with a value of 2 will display higher in an address book than a contact with a value of 1. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + +The SeniorityIndex parameter specifies the order in which this contact displays in a hierarchical address book. A contact with a value of 2 displays higher in an address book than a contact with a value of 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -632,6 +697,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -646,7 +714,6 @@ This parameter is meaningful only if the contact is mail-enabled. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -656,13 +723,15 @@ Accept wildcard characters: False ``` ### -StateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The StateOrProvince parameter specifies the contact's state or province. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -672,13 +741,15 @@ Accept wildcard characters: False ``` ### -StreetAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The StreetAddress parameter specifies the contact's physical address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -688,13 +759,15 @@ Accept wildcard characters: False ``` ### -TelephoneAssistant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TelephoneAssistant parameter specifies the telephone number of the contact's assistant. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -704,13 +777,15 @@ Accept wildcard characters: False ``` ### -Title + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Title parameter specifies the contact's title. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -720,15 +795,17 @@ Accept wildcard characters: False ``` ### -UMCallingLineIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The UMCallingLineIds parameter specifies telephone numbers or extensions that can be mapped to a Unified Messaging (UM)-enabled user. You can specify more than one telephone number for each user, separated by a comma. Values for this parameter must be less than 128 characters in length and may include an optional plus sign (+) that precedes the numbers. Each UM-enabled user must have a unique UMCallingLineIds parameter value. +The UMCallingLineIds parameter specifies telephone numbers or extensions that can be mapped to a Unified Messaging (UM)-enabled user. You can specify more than one telephone number for each user, separated by a comma. Values for this parameter must be less than 128 characters in length and might include an optional plus sign (+) that precedes the numbers. Each UM-enabled user must have a unique UMCallingLineIds parameter value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -738,6 +815,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -758,7 +838,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -768,13 +847,15 @@ Accept wildcard characters: False ``` ### -WebPage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WebPage parameter specifies the contact's web page. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -784,13 +865,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -800,6 +883,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -811,7 +897,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-ContentFilterConfig.md similarity index 64% rename from exchange/exchange-ps/exchange/Set-ContentFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ContentFilterConfig.md index 3b447709c5..a7340abe9d 100644 --- a/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ContentFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-contentfilterconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ContentFilterConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-contentfilterconfig +schema: 2.0.0 +title: Set-ContentFilterConfig --- # Set-ContentFilterConfig @@ -43,7 +44,7 @@ Set-ContentFilterConfig [-BypassedRecipients ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,20 +64,24 @@ 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. +It defines two users for whom the Content Filter doesn'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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,13 +91,17 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +111,17 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,6 +131,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -127,7 +143,6 @@ 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 Required: False Position: Named @@ -137,6 +152,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -145,7 +163,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +172,18 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 value is the default. +- $false: The Content Filter agent is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +193,18 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 value is the default. +- $false: Messages from unauthenticated connections aren't processed by the Content Filter agent. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,13 +214,18 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,13 +235,23 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,13 +261,15 @@ Accept wildcard characters: False ``` ### -QuarantineMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QuarantineMailbox parameter specifies an SMTP address to be used as a spam quarantine mailbox. A spam quarantine mailbox is required when you set the SCLQuarantineEnabled parameter to $true. All messages that meet or exceed the value set in the SCLQuarantineThreshold parameter are sent to the SMTP address that you set in this parameter. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -235,13 +279,15 @@ Accept wildcard characters: False ``` ### -RejectionResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectionResponse parameter specifies the message body that you want delivered in the non-delivery report (NDR) to senders whose messages meet or exceed the SCLRejectThreshold value. The RejectionResponse parameter is required if you set the SCLRejectEnabled parameter to $true. The RejectionResponse parameter takes a string. Don't exceed 240 characters in the argument. When you pass an argument, you must enclose the RejectionResponse parameter in quotation marks (") if the phrase contains spaces, for example: "Message rejected". The default setting is Message rejected due to content restrictions. ```yaml Type: AsciiString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,13 +297,18 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -267,13 +318,15 @@ Accept wildcard characters: False ``` ### -SCLDeleteThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SCLDeleteThreshold parameter specifies an integer value from 1 through 9. This value represents the SCL rating that a particular message must meet or exceed for the Content Filter agent to delete the message and not send an NDR. To enable this functionality, you must set the SCLDeleteEnabled parameter to $true. The default setting is 9. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -283,13 +336,18 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -299,13 +357,15 @@ Accept wildcard characters: False ``` ### -SCLQuarantineThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SCLQuarantineThreshold parameter specifies an integer value from 1 through 9. This value represents the SCL rating that a particular message must meet or exceed for the Content Filter agent to quarantine the message. To enable quarantine functionality, you must set the SCLQuarantineEnabled parameter to $true, and provide a valid SMTP address in the QuarantineMailbox parameter. The default setting is 9. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -315,13 +375,18 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -331,13 +396,15 @@ Accept wildcard characters: False ``` ### -SCLRejectThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SCLRejectThreshold parameter specifies an integer value from 1 through 9. This value represents the SCL rating that a particular message must meet or exceed for the Content Filter agent to reject the message and send an NDR to the sender. To enable the delete functionality, you must set the SCLDeleteEnabled parameter to $true. Also, you can revise the default NDR message by editing the RejectionResponse parameter. The default setting is 7. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -347,13 +414,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DataClassification.md b/exchange/exchange-ps/ExchangePowerShell/Set-DataClassification.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-DataClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DataClassification.md index a31254e845..eb9441e324 100644 --- a/exchange/exchange-ps/exchange/Set-DataClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DataClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dataclassification -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-DataClassification -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dataclassification +schema: 2.0.0 +title: Set-DataClassification --- # Set-DataClassification @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [Set-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. +In Exchange Online, this cmdlet is replaced by the [Set-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the Set-DataClassification cmdlet to modify data classification rules that use document fingerprints. @@ -38,7 +39,7 @@ Set-DataClassification [-Identity] ## DESCRIPTION Classification rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -93,6 +94,9 @@ The first three commands return the list of document fingerprints in the data cl ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the data classification rule that you want to modify. You can use any value that uniquely identifies the data classification rule. For example: - Name @@ -103,7 +107,6 @@ The Identity parameter specifies the data classification rule that you want to m Type: DataClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -122,7 +128,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -132,13 +137,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Description parameter specifies a description for the data classification rule. You use the Description parameter with the Locale and Name parameters to specify descriptions for the data classification rule in different languages. The localized values of Description appear in the AllLocalizedDescriptions property of the data classification rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -148,13 +155,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +173,15 @@ Accept wildcard characters: False ``` ### -Fingerprints -The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the data classification rule. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing data classification rule, see the Examples section. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the data classification rule. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-fingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing data classification rule, see the Examples section. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +191,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault switch is used with the Locale parameter to specify the default language for the data classification rule. You don't need to specify a value with this switch. The default Locale value is stored in the DefaultCulture property. @@ -190,7 +204,6 @@ When you change the default Locale value, the Name value of the data classificat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -200,6 +213,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Locale parameter adds or removes languages that are associated with the data classification rule. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -210,7 +226,6 @@ Typically, you use the Locale parameter with the Name and Description parameters Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -220,6 +235,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a name for the data classification rule. The value must be less than 256 characters. You use the Name parameter with the Locale and Description parameters to specify names for the data classification rule in different languages. The localized values of Name appear in the AllLocalizedNames property of the data classification rule. @@ -230,7 +248,6 @@ The value of the Name parameter is used in the Policy Tip that's presented to us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -240,13 +257,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DataEncryptionPolicy.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DataEncryptionPolicy.md index 729b74f9f7..737d608e85 100644 --- a/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DataEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dataencryptionpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-DataEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dataencryptionpolicy +schema: 2.0.0 +title: Set-DataEncryptionPolicy --- # Set-DataEncryptionPolicy @@ -61,7 +62,7 @@ Set-DataEncryptionPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,11 +78,14 @@ This example disabled the data encryption policy named US Mailboxes. Set-DataEncryptionPolicy -Identity "Europe Mailboxes" -Refresh ``` -This example updates the data encryption policy named Europe Mailboxes after one of the associated keys has been rotated in the Azure Key Vault. +This example updates the data encryption policy named Europe Mailboxes after one of the associated keys is rotated in the Azure Key Vault. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the data encryption policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -92,7 +96,6 @@ The Identity parameter specifies the data encryption policy that you want to mod Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -102,15 +105,17 @@ Accept wildcard characters: False ``` ### -PermanentDataPurgeContact + +> Applicable: Exchange Online, Exchange Online Protection + The PermanentDataPurgeContact parameter specifies a contact for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks. You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeReason parameters. ```yaml Type: String -Parameter Sets: TenantAdminPurgeKeyRequest +Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -119,20 +124,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: DCAdminPurgeKeyRequest -Aliases: -Applicable: Exchange Online, Exchange Online Protection +### -PermanentDataPurgeReason -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online, Exchange Online Protection -### -PermanentDataPurgeReason The PermanentDataPurgeReason parameter specifies a descriptive reason for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks. You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeContact parameters. @@ -141,7 +136,6 @@ You need to use this parameter with the PermanentDataPurgeRequested and Permanen Type: String Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -151,6 +145,9 @@ Accept wildcard characters: False ``` ### -PermanentDataPurgeRequested + +> Applicable: Exchange Online, Exchange Online Protection + The PermanentDataPurgeRequested switch specifies whether to initiate the deletion of all data that's encrypted by the data encryption policy. You don't need to specify a value with this switch. You need to use this switch with the PermanentDataPurgeReason and PermanentDataPurgeContact parameters. @@ -161,7 +158,6 @@ After you use this switch, you can't assign the data encryption policy to other Type: SwitchParameter Parameter Sets: TenantAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -171,13 +167,15 @@ Accept wildcard characters: False ``` ### -Refresh + +> Applicable: Exchange Online + Use the Refresh switch to update the data encryption policy in Exchange Online after you rotate any of the associated keys in the Azure Key Vault. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: RefreshKey Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -187,6 +185,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -198,7 +199,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,13 +208,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online + The Description parameter specifies an optional description for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -224,13 +226,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -240,6 +244,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter enables or disable the data encryption policy. Valid values are: - $true: The policy is enabled. @@ -249,7 +256,6 @@ The Enabled parameter enables or disable the data encryption policy. Valid value Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -259,6 +265,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to delete all data that's encrypted by the data encryption policy (the PermanentDataPurgeRequested switch), but the associated Azure Key Vault has also been deleted. @@ -267,7 +276,6 @@ Use this switch to delete all data that's encrypted by the data encryption polic Type: SwitchParameter Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -277,13 +285,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -293,13 +303,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroup.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroup.md index d5e6a1b952..1e2ff17c90 100644 --- a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-databaseavailabilitygroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-DatabaseAvailabilityGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-databaseavailabilitygroup +schema: 2.0.0 +title: Set-DatabaseAvailabilityGroup --- # Set-DatabaseAvailabilityGroup @@ -68,7 +69,7 @@ DAG property values are stored in both Active Directory and the cluster database - NetworkEncryption - DiscoverNetworks -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -133,13 +134,15 @@ This example configures the DAG DAG1 for AutoReseed using custom mount point pat ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the DAG that you want to modify. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -149,13 +152,15 @@ Accept wildcard characters: False ``` ### -ActivityState + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ActivityStateOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,13 +170,15 @@ Accept wildcard characters: False ``` ### -AllowCrossSiteRpcClientAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +188,15 @@ Accept wildcard characters: False ``` ### -AlternateWitnessDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AlternateWitnessDirectory parameter specifies the name of an alternate directory that's used to store file share witness data. The specified directory must not be in use by any other DAGs or used for any other purpose. This parameter is used only as part of a datacenter switchover process. If the DAG is extended across multiple datacenters in a site resilience configuration, we recommend preconfiguring the alternate witness server and directory. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,13 +206,15 @@ Accept wildcard characters: False ``` ### -AlternateWitnessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AlternateWitnessServer parameter specifies the name of an alternate server that's used to store file share witness data. The specified server must not be a member of the DAG that's configured to use it. This parameter is used only as part of a datacenter switchover process. If the DAG is extended across multiple datacenters in a site resilience configuration, we recommend preconfiguring the alternate witness server and directory. ```yaml Type: FileShareWitnessServerName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -213,13 +224,15 @@ Accept wildcard characters: False ``` ### -AutoDagAllServersInstalled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -229,13 +242,15 @@ Accept wildcard characters: False ``` ### -AutoDagAutoRedistributeEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDagAutoRedistributeEnabled parameter specifies whether automatic DAG redistribution is enabled or disabled during AutoReseed. The default value is $true (enabled). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,13 +260,15 @@ Accept wildcard characters: False ``` ### -AutoDagAutoReseedEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDagAutoReseedEnabled is used to enable or disable Autoreseed. The default value is $true (enabled). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,13 +278,15 @@ Accept wildcard characters: False ``` ### -AutoDagBitlockerEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDagBitlockerEnabled parameter ensures that Disk Reclaimer handles spare disks correctly and encrypts them with BitLocker. If Bitlocker is used to encrypt database disks, set the value of this parameter to $true on all Mailbox servers in the DAG after they are all running Exchange 2013 CU13 or later, or Exchange 2016 CU2 or later. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,13 +296,15 @@ Accept wildcard characters: False ``` ### -AutoDagDatabaseCopiesPerDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +314,15 @@ Accept wildcard characters: False ``` ### -AutoDagDatabaseCopiesPerVolume + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDagDatabaseCopiesPerVolume parameter is used to specify the configured number of database copies per volume. This parameter is used only with AutoReseed. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,13 +332,15 @@ Accept wildcard characters: False ``` ### -AutoDagDatabasesRootFolderPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDagDatabasesRootFolderPath parameter specifies the directory containing the database mount points when using AutoReseed. This parameter is required when using AutoReseed. AutoReseed uses a default path of C:\\ExchangeDatabases. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,13 +350,15 @@ Accept wildcard characters: False ``` ### -AutoDagDiskReclaimerEnabled -The AutoDagDiskReclaimerEnabled is used to enable or disable the volume formatting functions used by Autoreseed. The default value is $true (enabled). If you set this to $false, you will need to manually format the volume before the database(s) can be reseeded. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The AutoDagDiskReclaimerEnabled is used to enable or disable the volume formatting functions used by Autoreseed. The default value is $true (enabled). If you set this to $false, you need to manually format the volume before the database(s) can be reseeded. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -341,13 +368,15 @@ Accept wildcard characters: False ``` ### -AutoDagTotalNumberOfDatabases + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,13 +386,15 @@ Accept wildcard characters: False ``` ### -AutoDagTotalNumberOfServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -373,13 +404,15 @@ Accept wildcard characters: False ``` ### -AutoDagVolumesRootFolderPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDagVolumesRootFolderPath parameter specifies the volume containing the mount points for all disks, including spare disks, when using the AutoReseed feature of the DAG. This parameter is required when using AutoReseed. AutoReseed uses a default path of C:\\ExchangeVolumes. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -389,6 +422,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -398,7 +434,6 @@ 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 Required: False Position: Named @@ -408,13 +443,15 @@ Accept wildcard characters: False ``` ### -DagConfiguration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: DatabaseAvailabilityGroupConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -424,13 +461,15 @@ Accept wildcard characters: False ``` ### -DatabaseAvailabilityGroupIpAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DatabaseAvailabilityGroupIpAddresses parameter specifies one or more static IP addresses to the DAG when a Mailbox server is added to a DAG. If you omit the DatabaseAvailabilityGroupIpAddresses parameter when creating a DAG, the system attempts to lease one or more IP addresses from a Dynamic Host Configuration Protocol (DHCP) server in your organization to assign to the DAG. You must specify this parameter each time an additional IP address is added to the DAG, such as in the case of multi-subnet DAGs. You must also specify all IP addresses previously assigned to the DAG each time the DatabaseAvailabilityGroupIpAddresses parameter is used. Setting the DatabaseAvailabilityGroupIpAddresses parameter to a value of 0.0.0.0 automatically configures the DAG to use DHCP. ```yaml Type: IPAddress[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -440,6 +479,9 @@ Accept wildcard characters: False ``` ### -DatacenterActivationMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DatacenterActivationMode parameter specifies the datacenter activation mode for the DAG. Valid values are: - Off: Datacenter activation mode is disabled. @@ -449,7 +491,6 @@ The DatacenterActivationMode parameter specifies the datacenter activation mode Type: DatacenterActivationModeOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -459,6 +500,9 @@ Accept wildcard characters: False ``` ### -DiscoverNetworks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoverNetworks switch specifies whether to force a rediscovery of the network and network interfaces. You don't need to specify a value with this switch. By default, internal network heartbeats are sent between DAG members on the same subnet. If there's no response to the heartbeats, network discovery is performed automatically by the system. If you add or remove networks or change DAG network subnets, you can force rediscovery of all DAG networks by using the DiscoverNetworks switch. @@ -467,7 +511,6 @@ By default, internal network heartbeats are sent between DAG members on the same Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -477,13 +520,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -493,6 +538,9 @@ Accept wildcard characters: False ``` ### -FileSystem + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FileSystem parameter specifies the file system that's used for the DAG. Valid values are: - NTFS @@ -502,7 +550,6 @@ The FileSystem parameter specifies the file system that's used for the DAG. Vali Type: FileSystemMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -512,13 +559,15 @@ Accept wildcard characters: False ``` ### -ManualDagNetworkConfiguration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ManualDagNetworkConfiguration parameter specifies whether DAG networks should be automatically configured. If this parameter is set to $false, DAG networks are automatically configured. If this parameter is set to $true, you must manually configure DAG networks. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -528,13 +577,15 @@ Accept wildcard characters: False ``` ### -MetaCacheDatabaseVolumesPerServer + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -544,6 +595,9 @@ Accept wildcard characters: False ``` ### -NetworkCompression + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NetworkCompression parameter specifies the network compression option for the DAG. Valid values are: - Disabled: Network compression is disabled on all networks. @@ -555,7 +609,6 @@ The NetworkCompression parameter specifies the network compression option for th Type: NetworkOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -565,6 +618,9 @@ Accept wildcard characters: False ``` ### -NetworkEncryption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NetworkEncryption parameter specifies the network encryption option for the DAG. Valid values are: - Disabled: Network encryption is disabled on all networks. @@ -576,7 +632,6 @@ The NetworkEncryption parameter specifies the network encryption option for the Type: NetworkOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -586,19 +641,21 @@ Accept wildcard characters: False ``` ### -PreferenceMoveFrequency + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PreferenceMoveFrequency parameter specifies how frequently the Microsoft Exchange Replication service inspects and automatically rebalances the database copies. If the most preferred database copy (ActivationPreference value of 1) isn't the active copy, the most preferred database copy is activated by performing a lossless switchover. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. The default value is 01:00:00 (1 hour). To disable this feature, specify the value `([System.Threading.Timeout]::InfiniteTimeSpan)`. -**Important**: Don't specify a value larger than 49.7 days. A larger value will crash MSExchangeRepl.exe with an ArgumentOutOfRangeException error on all DAG members. +**Important**: Don't specify a value larger than 49.7 days. A larger value crashes MSExchangeRepl.exe with an ArgumentOutOfRangeException error on all DAG members. ```yaml Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -608,13 +665,15 @@ Accept wildcard characters: False ``` ### -ReplayLagManagerEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplayLagManagerEnabled parameter specifies whether to disable the automatic playdown of log files for a lagged database copy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -624,13 +683,15 @@ Accept wildcard characters: False ``` ### -ReplicationPort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplicationPort parameter specifies a Transmission Control Protocol (TCP) port for replication (log shipping and seeding) activity. If this parameter isn't specified, the default port for replication is TCP 64327. ```yaml Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -640,13 +701,15 @@ Accept wildcard characters: False ``` ### -SkipDagValidation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when configuring the DAG. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -656,13 +719,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -672,13 +737,15 @@ Accept wildcard characters: False ``` ### -WitnessDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WitnessDirectory parameter specifies the name of the directory on the server that's used to store file share witness data. The specified directory must not be in use by any other DAGs. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -688,13 +755,15 @@ Accept wildcard characters: False ``` ### -WitnessServer -The WitnessServer parameter specifies the name of a server that will act as a witness for the DAG. The server specified can't be a member of the DAG. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The WitnessServer parameter specifies the name of a server that acts as a witness for the DAG. The server specified can't be a member of the DAG. ```yaml Type: FileShareWitnessServerName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroupNetwork.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroupNetwork.md index 1cf2e33f62..0679873a53 100644 --- a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroupNetwork.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-databaseavailabilitygroupnetwork -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-DatabaseAvailabilityGroupNetwork -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-databaseavailabilitygroupnetwork +schema: 2.0.0 +title: Set-DatabaseAvailabilityGroupNetwork --- # Set-DatabaseAvailabilityGroupNetwork @@ -36,7 +37,7 @@ Set-DatabaseAvailabilityGroupNetwork [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the DAG network being configured. ```yaml Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -82,7 +88,6 @@ 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 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Description parameter specifies an optional description for the DAG network. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,13 +133,15 @@ Accept wildcard characters: False ``` ### -IgnoreNetwork + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreNetwork parameter indicates that the specified network should be ignored and not used by the DAG. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter provides a name for the DAG network. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +169,15 @@ Accept wildcard characters: False ``` ### -ReplicationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplicationEnabled parameter specifies whether the network can be used for replication activity. If this parameter isn't specified, the default behavior is to enable the network for replication. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +187,15 @@ Accept wildcard characters: False ``` ### -Subnets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Subnets parameter specifies one or more subnets that are associated with the DAG network. ```yaml Type: DatabaseAvailabilityGroupSubnetId[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantBriefingConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantBriefingConfig.md index 82ecf059aa..624d0d94d3 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantBriefingConfig.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig applicable: Exchange Online -title: Set-DefaultTenantBriefingConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-defaulttenantbriefingconfig +schema: 2.0.0 +title: Set-DefaultTenantBriefingConfig --- # Set-DefaultTenantBriefingConfig @@ -53,10 +53,13 @@ This example sets the default Briefing email configuration for the organization ## PARAMETERS ### -IsEnabledByDefault + +> Applicable: Exchange Online + The IsEnabledByDefault parameter specifies the default Briefing email configuration for the organization. Valid values are: - Opt-in: By default, all users in the organization are subscribed to receive the Briefing email. -- Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This is the default value. +- Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This value is the default. This setting affects the following users: @@ -69,7 +72,6 @@ This setting does not affect users who've already updated their user settings to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -79,13 +81,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantMyAnalyticsFeatureConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 9c1ba06bb4..4bbfbdba3d 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig applicable: Exchange Online -title: Set-DefaultTenantMyAnalyticsFeatureConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-defaulttenantmyanalyticsfeatureconfig +schema: 2.0.0 +title: Set-DefaultTenantMyAnalyticsFeatureConfig --- # Set-DefaultTenantMyAnalyticsFeatureConfig @@ -70,6 +70,9 @@ This example sets the meeting effectiveness survey sampling rate to 20%. ## PARAMETERS ### -Feature + +> Applicable: Exchange Online + The Feature parameter specifies the Viva Insights feature to enable or disable. Valid values are: - Add-in @@ -85,7 +88,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: Dashboard, Add-in, Digest-email, Meeting-effectiveness-survey, Scheduled-send, All -Applicable: Exchange Online Required: False Position: Named @@ -95,6 +97,9 @@ Accept wildcard characters: False ``` ### -IsEnabled + +> Applicable: Exchange Online + The IsEnabled parameter enables or disables the Viva Insights feature specified by the Feature parameter. Valid values are: - $true: The feature is enabled. @@ -104,7 +109,6 @@ The IsEnabled parameter enables or disables the Viva Insights feature specified Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -114,13 +118,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,6 +136,9 @@ Accept wildcard characters: False ``` ### -SamplingRate + +> Applicable: Exchange Online + This parameter is available only in version 3.2.0 or later. The SamplingRate parameter specifies the meeting effectiveness survey sampling rate. The percentage value is expressed a a decimal (for example, 0.1 indicates 10%). A valid value is from 0.1 to 0.7. @@ -138,7 +147,6 @@ The SamplingRate parameter specifies the meeting effectiveness survey sampling r Type: Double Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeliveryAgentConnector.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeliveryAgentConnector.md index e1280caf99..dd3062b215 100644 --- a/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeliveryAgentConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-deliveryagentconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-DeliveryAgentConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-deliveryagentconnector +schema: 2.0.0 +title: Set-DeliveryAgentConnector --- # Set-DeliveryAgentConnector @@ -42,7 +43,7 @@ Set-DeliveryAgentConnector [-Identity] ## DESCRIPTION Delivery agent connectors are used to route messages addressed to foreign systems that don't use the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://learn.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,13 +74,15 @@ This example uses the temporary variable $ConnectorConfig to add the address spa ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the GUID or name of the delivery agent connector. ```yaml Type: DeliveryAgentConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AddressSpaces parameter specifies the domain names that the delivery agent connector is responsible for. The complete syntax for entering an address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. Enclose each address space in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -130,7 +140,6 @@ 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 Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -DeliveryProtocol + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -164,7 +178,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the delivery agent connector is enabled. The default value is $true. @@ -182,7 +198,6 @@ The default value is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,6 +207,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -200,7 +218,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +227,9 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. If the value of this parameter is $false, the connector can be used by all Mailbox servers in your organization. If the value of this parameter is $true, the connector can only be used by Mailbox servers in the same Active Directory site. The default value is $false. @@ -218,7 +238,6 @@ The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +247,9 @@ Accept wildcard characters: False ``` ### -MaxConcurrentConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConcurrentConnections parameter specifies the maximum number of concurrent connections this connector accepts from a specific IP address. The default value is 5. @@ -236,7 +258,6 @@ The default value is 5. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,6 +267,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxMessageSize parameter specifies the maximum size of a message that's allowed to pass through this connector. When you enter a value, qualify the value with one of the following units: - B (bytes) @@ -261,7 +285,6 @@ The default value is unlimited. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -271,6 +294,9 @@ Accept wildcard characters: False ``` ### -MaxMessagesPerConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxMessagesPerConnection parameter specifies the maximum number of messages this connector accepts per connection. The connector terminates the connection after this limit is reached and the sending server has to initiate a new connection to send more messages. The default value is 20. @@ -279,7 +305,6 @@ The default value is 20. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,13 +314,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -305,6 +332,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceTransportServers parameter specifies the list of Mailbox servers that host this connector. You can specify more than one server by separating their names with commas. By default, only the local server on which the command is executed is added to this parameter. @@ -313,7 +343,6 @@ By default, only the local server on which the command is executed is added to t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -323,13 +352,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DetailsTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Set-DetailsTemplate.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-DetailsTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DetailsTemplate.md index dfeb2f1c61..3afb7ff226 100644 --- a/exchange/exchange-ps/exchange/Set-DetailsTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DetailsTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-detailstemplate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-DetailsTemplate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-detailstemplate +schema: 2.0.0 +title: Set-DetailsTemplate --- # Set-DetailsTemplate @@ -30,7 +31,7 @@ Set-DetailsTemplate [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example sets attributes for the User details template for the U.S. English ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the details template using a GUID or specifies a template type and language separated by a slash. The following is an example of the user template type and U.S. English language: en-us\\User. Details template types include: - User @@ -57,7 +61,6 @@ The Identity parameter specifies the details template using a GUID or specifies Type: DetailsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -76,7 +82,6 @@ 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 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -Pages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessPolicy.md index 0bbba58e9e..807af383b6 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconditionalaccesspolicy applicable: Security & Compliance -title: Set-DeviceConditionalAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-deviceconditionalaccesspolicy +schema: 2.0.0 +title: Set-DeviceConditionalAccessPolicy --- # Set-DeviceConditionalAccessPolicy @@ -64,6 +65,9 @@ This example disables the existing mobile device conditional access policy named ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device conditional access policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the mobile device conditional access policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -125,7 +135,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -135,16 +144,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -162,7 +176,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessRule.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessRule.md index f9e793ed4e..4f2b1cd162 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconditionalaccessrule applicable: Security & Compliance -title: Set-DeviceConditionalAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-deviceconditionalaccessrule +schema: 2.0.0 +title: Set-DeviceConditionalAccessRule --- # Set-DeviceConditionalAccessRule @@ -100,13 +101,15 @@ This example modifies the specified mobile device conditional access rule to blo ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device conditional access rule that you want to modify. The name of the rule uses the syntax `{}`. For example, `Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}`. You can find the name value by running the command: Get-DeviceConfigurationRule | Format-List Name. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -116,6 +119,9 @@ Accept wildcard characters: False ``` ### -TargetGroups + +> Applicable: Security & Compliance + The TargetGroups parameter specifies the security groups that this rule applies to. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. You can specify multiple groups separated by commas. @@ -124,7 +130,6 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -134,16 +139,18 @@ Accept wildcard characters: False ``` ### -AccountName + +> Applicable: Security & Compliance + The AccountName parameter specifies the account name. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -153,16 +160,18 @@ Accept wildcard characters: False ``` ### -AccountUserName + +> Applicable: Security & Compliance + The AccountUserName parameter specifies the account user name. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,11 +181,14 @@ Accept wildcard characters: False ``` ### -AllowAppStore + +> Applicable: Security & Compliance + The AllowAppStore parameter specifies whether to allow access to the app store on devices. Valid values for this parameter are: - $true: Access to the app store is allowed. - $false: Access to the app store isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -187,7 +199,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -197,11 +208,14 @@ Accept wildcard characters: False ``` ### -AllowAssistantWhileLocked + +> Applicable: Security & Compliance + The AllowAssistantWhileLocked parameter specifies whether to allow the use of the voice assistant while devices are locked. Valid values for this parameter are: - $true: The voice assistant can be used while devices are locked. - $false: The voice assistant can't be used while devices are locked. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -209,7 +223,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -219,11 +232,14 @@ Accept wildcard characters: False ``` ### -AllowConvenienceLogon + +> Applicable: Security & Compliance + The AllowConvenienceLogon parameter specifies whether to allow convenience logons on devices. Valid values for this parameter are: - $true: Convenience logons are allowed. - $false: Convenience logons aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -231,7 +247,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -241,11 +256,14 @@ Accept wildcard characters: False ``` ### -AllowDiagnosticSubmission + +> Applicable: Security & Compliance + The AllowDiagnosticSubmission parameter specifies whether to allow diagnostic submissions from devices. Valid values for this parameter are: - $true: Diagnostic submissions are allowed. - $false: Diagnostic submissions aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -257,7 +275,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -267,11 +284,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudBackup + +> Applicable: Security & Compliance + The AllowiCloudBackup parameter specifies whether to allow Apple iCloud Backup from devices. Valid values for this parameter are: - $true: iCloud Backup is allowed. - $false: iCloud Backup isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -282,7 +302,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -292,11 +311,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudDocSync + +> Applicable: Security & Compliance + The AllowiCloudDocSync parameter specifies whether to allow Apple iCloud Documents & Data sync on devices. Valid values for this parameter are: - $true: iCloud Documents & Data sync is allowed. - $false: iCloud Documents & Data sync isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -307,7 +329,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -317,11 +338,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudPhotoSync + +> Applicable: Security & Compliance + The AllowiCloudPhotoSync parameter specifies whether to allow Apple iCloud Photos sync on devices. Valid values for this parameter are: - $true: iCloud Photos sync is allowed. - $false: iCloud Photo sync isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -332,7 +356,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -342,11 +365,14 @@ Accept wildcard characters: False ``` ### -AllowJailbroken + +> Applicable: Security & Compliance + The AllowJailbroken parameter specifies whether to allow access to your organization by jailbroken or rooted devices. - $true: Jailbroken devices are allowed. - $false: Jailbroken devices aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -357,7 +383,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -367,11 +392,14 @@ Accept wildcard characters: False ``` ### -AllowPassbookWhileLocked + +> Applicable: Security & Compliance + The AllowPassbookWhileLocked parameter specifies whether to allow the use of Apple Passbook while devices are locked. Valid values for this parameter are: - $true: Passbook is available while devices are locked. - $false: Passbook isn't available while devices are locked. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -379,7 +407,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -389,11 +416,14 @@ Accept wildcard characters: False ``` ### -AllowScreenshot + +> Applicable: Security & Compliance + The AllowScreenshot parameter specifies whether to allow screenshots on devices. Valid values for this parameter are: - $true: Screenshots are allowed. - $false: Screenshots aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -404,7 +434,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -414,11 +443,14 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Security & Compliance + The AllowSimplePassword parameter specifies whether to allow simple or non-complex passwords on devices. Valid values for this parameter are: - $true: Simple passwords are allowed. - $false: Simple passwords aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -430,7 +462,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -440,11 +471,14 @@ Accept wildcard characters: False ``` ### -AllowVideoConferencing + +> Applicable: Security & Compliance + The AllowVideoConferencing parameter specifies whether to allow video conferencing on devices. Valid values for this parameter are: - $true: Video conferencing is allowed. - $false: Video conferencing isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -452,7 +486,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -462,11 +495,14 @@ Accept wildcard characters: False ``` ### -AllowVoiceAssistant + +> Applicable: Security & Compliance + The AllowVoiceAssistant parameter specifies whether to allow using the voice assistant on devices. Valid values for this parameter are: - $true: The voice assistant is allowed. - $false: The voice assistant isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -474,7 +510,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -484,11 +519,14 @@ Accept wildcard characters: False ``` ### -AllowVoiceDialing + +> Applicable: Security & Compliance + The AllowVoiceDialing parameter specifies whether to allow voice-activated telephone dialing. Valid values for this parameter are: - $true: Voice dialing is allowed. - $false: Voice dialing isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -496,7 +534,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -506,10 +543,13 @@ Accept wildcard characters: False ``` ### -AntiVirusSignatureStatus + +> Applicable: Security & Compliance + The AntiVirusSignatureStatus parameter specifies the antivirus signature status. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -517,7 +557,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -527,10 +566,13 @@ Accept wildcard characters: False ``` ### -AntiVirusStatus + +> Applicable: Security & Compliance + The AntiVirusStatus parameter specifies antivirus status. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -538,7 +580,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -548,6 +589,9 @@ Accept wildcard characters: False ``` ### -AppsRating + +> Applicable: Security & Compliance + The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - AllowAll @@ -555,7 +599,7 @@ The AppsRating parameter species the maximum or most restrictive rating of apps - Rating9plus - Rating12plus - Rating17plus -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -563,7 +607,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -573,6 +616,9 @@ Accept wildcard characters: False ``` ### -AutoUpdateStatus + +> Applicable: Security & Compliance + The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - AutomaticCheckForUpdates @@ -580,7 +626,7 @@ The AutoUpdateStatus parameter specifies the update settings for devices. Valid - AutomaticUpdatesRequired - DeviceDefault - NeverCheckUpdates -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -588,7 +634,6 @@ This setting is available only on Windows 8.1 RT devices. Type: CAAutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -598,11 +643,14 @@ Accept wildcard characters: False ``` ### -BluetoothEnabled + +> Applicable: Security & Compliance + The BluetoothEnabled parameter specifies whether to enable or disable Bluetooth on devices. Valid values for this parameter are: - $true: Bluetooth is enabled. - $false: Bluetooth is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows Phone 8.1 devices. @@ -610,7 +658,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -620,11 +667,14 @@ Accept wildcard characters: False ``` ### -CameraEnabled + +> Applicable: Security & Compliance + The CameraEnabled parameter specifies whether to enable or disable cameras on devices. Valid values for this parameter are: - $true: Cameras are enabled. - $false: Cameras are disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -636,7 +686,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -646,6 +695,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -655,7 +707,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -665,13 +716,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -681,16 +734,18 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Security & Compliance + The EmailAddress parameter specifies the email address. Valid values are: - An email address: For example, julia@contoso.com. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -700,11 +755,14 @@ Accept wildcard characters: False ``` ### -EnableRemovableStorage + +> Applicable: Security & Compliance + The EnableRemovableStorage parameter specifies whether removable storage can be used by devices. Valid values for this parameter are: - $true: Removable storage can be used. - $false: Removable storage can't be used. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows Phone 8.1 devices. @@ -712,7 +770,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -722,16 +779,18 @@ Accept wildcard characters: False ``` ### -ExchangeActiveSyncHost + +> Applicable: Security & Compliance + The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -741,10 +800,13 @@ Accept wildcard characters: False ``` ### -FirewallStatus + +> Applicable: Security & Compliance + The FirewallStatus parameter specifies the acceptable firewall status values on devices. Valid values for this parameter are: - Required -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -752,7 +814,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -762,11 +823,14 @@ Accept wildcard characters: False ``` ### -ForceAppStorePassword + +> Applicable: Security & Compliance + The ForceAppStorePassword parameter specifies whether to require a password to use the app store on devices. Valid values for this parameter are: - $true: App store passwords are required. - $false: App store passwords aren't required. -- $null (blank): The feature isn't allowed or blocked by the rule. This is the default value. +- $null (blank): The feature isn't allowed or blocked by the rule. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -774,7 +838,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -784,11 +847,14 @@ Accept wildcard characters: False ``` ### -ForceEncryptedBackup + +> Applicable: Security & Compliance + The ForceEncryptedBackup parameter specifies whether to force encrypted backups for devices. Valid values for this parameter are: - $true: Encrypted backups are required. - $false: Encrypted backups aren't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -799,7 +865,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -809,10 +874,13 @@ Accept wildcard characters: False ``` ### -MaxPasswordAttemptsBeforeWipe + +> Applicable: Security & Compliance + The MaxPasswordAttemptsBeforeWipe parameter specifies the number of incorrect password attempts that cause devices to be automatically wiped. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -825,7 +893,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -835,6 +902,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordGracePeriod + +> Applicable: Security & Compliance + The MaxPasswordGracePeriod parameter specifies the length of time users are allowed to reset expired passwords on devices. This setting is available only on Apple iOS 6+ devices. @@ -845,7 +915,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -855,13 +924,16 @@ Accept wildcard characters: False ``` ### -MoviesRating + +> Applicable: Security & Compliance + The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: - AllowAll: All movies are allowed, regardless of their rating. - DontAllow: No movies are allowed, regardless of their rating. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. Australia @@ -945,7 +1017,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -955,16 +1026,18 @@ Accept wildcard characters: False ``` ### -PasswordComplexity + +> Applicable: Security & Compliance + The PasswordComplexity parameter specifies the password complexity. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -974,10 +1047,13 @@ Accept wildcard characters: False ``` ### -PasswordExpirationDays + +> Applicable: Security & Compliance + The PasswordExpirationDays parameter specifies the number of days that the same password can be used on devices before users are required to change their passwords . Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -990,7 +1066,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1000,10 +1075,13 @@ Accept wildcard characters: False ``` ### -PasswordHistoryCount + +> Applicable: Security & Compliance + The PasswordHistoryCount parameter specifies the minimum number of unique new passwords that are required on devices before an old password can be reused. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1016,7 +1094,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1026,16 +1103,18 @@ Accept wildcard characters: False ``` ### -PasswordMinComplexChars + +> Applicable: Security & Compliance + The PasswordMinComplexChars parameter specifies the minimum number of complex characters that are required for device passwords. A complex character isn't a letter. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1045,10 +1124,13 @@ Accept wildcard characters: False ``` ### -PasswordMinimumLength + +> Applicable: Security & Compliance + The PasswordMinimumLength parameter specifies the minimum number of characters that are required for device passwords. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1061,7 +1143,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1071,12 +1152,15 @@ Accept wildcard characters: False ``` ### -PasswordQuality + +> Applicable: Security & Compliance + The PasswordQuality parameter specifies the minimum password quality rating that's required for device passwords. Password quality is a numeric scale that indicates the security and complexity of the password. A higher quality value indicates a more secure password. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Android 4+ devices. @@ -1084,7 +1168,6 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1094,11 +1177,14 @@ Accept wildcard characters: False ``` ### -PasswordRequired + +> Applicable: Security & Compliance + The PasswordRequired parameter specifies whether a password is required to access devices. Valid values for this parameter are: - $true: Device passwords are required. - $false: Device passwords aren't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1110,7 +1196,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1120,6 +1205,9 @@ Accept wildcard characters: False ``` ### -PasswordTimeout + +> Applicable: Security & Compliance + The PasswordTimeout parameter specifies the length of time that devices can be inactive before a password is required to reactivate them. This setting is available on the following types of devices: @@ -1135,7 +1223,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1145,11 +1232,14 @@ Accept wildcard characters: False ``` ### -PhoneMemoryEncrypted + +> Applicable: Security & Compliance + The PhoneMemoryEncrypted parameter specifies whether to encrypt the memory on devices. Valid values for this parameter are: - $true: Memory is encrypted. - $false: Memory isn't encrypted. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1160,7 +1250,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1170,11 +1259,14 @@ Accept wildcard characters: False ``` ### -RegionRatings + +> Applicable: Security & Compliance + The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. - au: Australia - ca: Canada - de: Germany @@ -1191,7 +1283,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1201,17 +1292,19 @@ Accept wildcard characters: False ``` ### -RequireEmailProfile + +> Applicable: Security & Compliance + The RequireEmailProfile parameter specifies whether an email profile is required on devices. Valid values for this parameter are: - $true: An email profile is required. This value is required for selective wipe on iOS devices. - $false: An email profile isn't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1221,11 +1314,14 @@ Accept wildcard characters: False ``` ### -SmartScreenEnabled + +> Applicable: Security & Compliance + The SmartScreenEnabled parameter specifies whether to requireWindows SmartScreen on devices. Valid values for this parameter are: - $true: SmartScreen is enabled. - $false: SmartScreen is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -1233,7 +1329,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1243,11 +1338,14 @@ Accept wildcard characters: False ``` ### -SystemSecurityTLS + +> Applicable: Security & Compliance + The SystemSecurityTLS parameter specifies whether TLS encryption is used on devices. Valid values for this parameter are: - $true: TLS encryption is used. - $false: TLS encryption isn't used. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -1255,7 +1353,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1265,13 +1362,16 @@ Accept wildcard characters: False ``` ### -TVShowsRating + +> Applicable: Security & Compliance + The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: - AllowAll: All television shows are allowed, regardless of their rating. - DontAllow: No televisions shows are allowed, regardless of their rating. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. Australia @@ -1344,7 +1444,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1354,9 +1453,12 @@ Accept wildcard characters: False ``` ### -UserAccountControlStatus + +> Applicable: Security & Compliance + The UserAccountControlStatus parameter specifies how User Account Control messages are presented on devices. Valid values for this parameter are: -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. - AlwaysNotify - NeverNotify - NotifyAppChanges @@ -1368,7 +1470,6 @@ This setting is available only on Windows 8.1 RT devices. Type: CAUserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1378,13 +1479,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -1394,11 +1497,14 @@ Accept wildcard characters: False ``` ### -WLANEnabled + +> Applicable: Security & Compliance + The WLANEnabled parameter specifies whether Wi-Fi is enabled devices. Valid values for this parameter are: - $true: Wi-Fi is enabled. - $false: Wi-Fi is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Microsoft Windows Phone 8.1 devices. @@ -1406,7 +1512,6 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1416,6 +1521,9 @@ Accept wildcard characters: False ``` ### -WorkFoldersSyncUrl + +> Applicable: Security & Compliance + The WorkFoldersSyncUrl parameter specifies the URL that's used to synchronize company data on devices. Valid input for this parameter a URL. For example, `https://workfolders.contoso.com`. @@ -1426,7 +1534,6 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationPolicy.md index ed19ba795f..68bf9001ec 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconfigurationpolicy applicable: Security & Compliance -title: Set-DeviceConfigurationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-deviceconfigurationpolicy +schema: 2.0.0 +title: Set-DeviceConfigurationPolicy --- # Set-DeviceConfigurationPolicy @@ -64,6 +65,9 @@ This example disables the mobile device configuration policy named Engineering G ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device configuration policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the mobile device configuration policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -125,7 +135,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -135,16 +144,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -162,7 +176,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationRule.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationRule.md index 3ea511f71e..ca87acb7a7 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconfigurationrule applicable: Security & Compliance -title: Set-DeviceConfigurationRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-deviceconfigurationrule +schema: 2.0.0 +title: Set-DeviceConfigurationRule --- # Set-DeviceConfigurationRule @@ -99,13 +100,15 @@ This example modifies the specified mobile device configuration rule to block sc ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device configuration rule that you want to modify. The name of the rule uses the syntax ` Applicable: Security & Compliance + The TargetGroups parameter specifies the security groups that this rule applies to. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. You can specify multiple groups separated by commas. @@ -123,7 +129,6 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -133,16 +138,18 @@ Accept wildcard characters: False ``` ### -AccountName + +> Applicable: Security & Compliance + The AccountName parameter specifies the account name. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -152,16 +159,18 @@ Accept wildcard characters: False ``` ### -AccountUserName + +> Applicable: Security & Compliance + The AccountUserName parameter specifies the account user name. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -171,11 +180,14 @@ Accept wildcard characters: False ``` ### -AllowAppStore + +> Applicable: Security & Compliance + The AllowAppStore parameter specifies whether to allow access to the app store on devices. Valid values for this parameter are: - $true: Access to the app store is allowed. - $false: Access to the app store isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -186,7 +198,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -196,11 +207,14 @@ Accept wildcard characters: False ``` ### -AllowAssistantWhileLocked + +> Applicable: Security & Compliance + The AllowAssistantWhileLocked parameter specifies whether to allow the use of the voice assistant while devices are locked. Valid values for this parameter are: - $true: The voice assistant can be used while devices are locked. - $false: The voice assistant can't be used while devices are locked. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -208,7 +222,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -218,11 +231,14 @@ Accept wildcard characters: False ``` ### -AllowConvenienceLogon + +> Applicable: Security & Compliance + The AllowConvenienceLogon parameter specifies whether to allow convenience logons on devices. Valid values for this parameter are: - $true: Convenience logons are allowed. - $false: Convenience logons aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -230,7 +246,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -240,11 +255,14 @@ Accept wildcard characters: False ``` ### -AllowDiagnosticSubmission + +> Applicable: Security & Compliance + The AllowDiagnosticSubmission parameter specifies whether to allow diagnostic submissions from devices. Valid values for this parameter are: - $true: Diagnostic submissions are allowed. - $false: Diagnostic submissions aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -256,7 +274,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -266,11 +283,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudBackup + +> Applicable: Security & Compliance + The AllowiCloudBackup parameter specifies whether to allow Apple iCloud Backup from devices. Valid values for this parameter are: - $true: iCloud Backup is allowed. - $false: iCloud Backup isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -281,7 +301,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -291,11 +310,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudDocSync + +> Applicable: Security & Compliance + The AllowiCloudDocSync parameter specifies whether to allow Apple iCloud Documents & Data sync on devices. Valid values for this parameter are: - $true: iCloud Documents & Data sync is allowed. - $false: iCloud Documents & Data sync isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -306,7 +328,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -316,11 +337,14 @@ Accept wildcard characters: False ``` ### -AllowiCloudPhotoSync + +> Applicable: Security & Compliance + The AllowiCloudPhotoSync parameter specifies whether to allow Apple iCloud Photos sync on devices. Valid values for this parameter are: - $true: iCloud Photos sync is allowed. - $false: iCloud Photo sync isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -331,7 +355,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -341,11 +364,14 @@ Accept wildcard characters: False ``` ### -AllowPassbookWhileLocked + +> Applicable: Security & Compliance + The AllowPassbookWhileLocked parameter specifies whether to allow the use of Apple Passbook while devices are locked. Valid values for this parameter are: - $true: Passbook is available while devices are locked. - $false: Passbook isn't available while devices are locked. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -353,7 +379,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -363,11 +388,14 @@ Accept wildcard characters: False ``` ### -AllowScreenshot + +> Applicable: Security & Compliance + The AllowScreenshot parameter specifies whether to allow screenshots on devices. Valid values for this parameter are: - $true: Screenshots are allowed. - $false: Screenshots aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -378,7 +406,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -388,11 +415,14 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Security & Compliance + The AllowSimplePassword parameter specifies whether to allow simple or non-complex passwords on devices. Valid values for this parameter are: - $true: Simple passwords are allowed. - $false: Simple passwords aren't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -404,7 +434,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -414,11 +443,14 @@ Accept wildcard characters: False ``` ### -AllowVideoConferencing + +> Applicable: Security & Compliance + The AllowVideoConferencing parameter specifies whether to allow video conferencing on devices. Valid values for this parameter are: - $true: Video conferencing is allowed. - $false: Video conferencing isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -426,7 +458,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -436,11 +467,14 @@ Accept wildcard characters: False ``` ### -AllowVoiceAssistant + +> Applicable: Security & Compliance + The AllowVoiceAssistant parameter specifies whether to allow using the voice assistant on devices. Valid values for this parameter are: - $true: The voice assistant is allowed. - $false: The voice assistant isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -448,7 +482,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -458,11 +491,14 @@ Accept wildcard characters: False ``` ### -AllowVoiceDialing + +> Applicable: Security & Compliance + The AllowVoiceDialing parameter specifies whether to allow voice-activated telephone dialing. Valid values for this parameter are: - $true: Voice dialing is allowed. - $false: Voice dialing isn't allowed. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -470,7 +506,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -480,10 +515,13 @@ Accept wildcard characters: False ``` ### -AntiVirusSignatureStatus + +> Applicable: Security & Compliance + The AntiVirusSignatureStatus parameter specifies the antivirus signature status. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -491,7 +529,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -501,10 +538,13 @@ Accept wildcard characters: False ``` ### -AntiVirusStatus + +> Applicable: Security & Compliance + The AntiVirusStatus parameter specifies the antivirus status. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -512,7 +552,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -522,6 +561,9 @@ Accept wildcard characters: False ``` ### -AppsRating + +> Applicable: Security & Compliance + The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - AllowAll @@ -529,7 +571,7 @@ The AppsRating parameter species the maximum or most restrictive rating of apps - Rating9plus - Rating12plus - Rating17plus -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -537,7 +579,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -547,6 +588,9 @@ Accept wildcard characters: False ``` ### -AutoUpdateStatus + +> Applicable: Security & Compliance + The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - AutomaticCheckForUpdates @@ -554,7 +598,7 @@ The AutoUpdateStatus parameter specifies the update settings for devices. Valid - AutomaticUpdatesRequired - DeviceDefault - NeverCheckUpdates -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -562,7 +606,6 @@ This setting is available only on Windows 8.1 RT devices. Type: AutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -572,11 +615,14 @@ Accept wildcard characters: False ``` ### -BluetoothEnabled + +> Applicable: Security & Compliance + The BluetoothEnabled parameter specifies whether to enable or disable Bluetooth on devices. Valid values for this parameter are: - $true: Bluetooth is enabled. - $false: Bluetooth is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows Phone 8.1 devices. @@ -584,7 +630,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -594,11 +639,14 @@ Accept wildcard characters: False ``` ### -CameraEnabled + +> Applicable: Security & Compliance + The CameraEnabled parameter specifies whether to enable or disable cameras on devices. Valid values for this parameter are: - $true: Cameras are enabled. - $false: Cameras are disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -610,7 +658,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -620,6 +667,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -629,7 +679,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -639,13 +688,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -655,16 +706,18 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Security & Compliance + The EmailAddress parameter specifies the email address. Valid values are: - An email address: For example, julia@contoso.com. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -674,11 +727,14 @@ Accept wildcard characters: False ``` ### -EnableRemovableStorage + +> Applicable: Security & Compliance + The EnableRemovableStorage parameter specifies whether removable storage can be used by devices. Valid values for this parameter are: - $true: Removable storage can be used. - $false: Removable storage can't be used. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows Phone 8.1 devices. @@ -686,7 +742,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -696,16 +751,18 @@ Accept wildcard characters: False ``` ### -ExchangeActiveSyncHost + +> Applicable: Security & Compliance + The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Valid values for this parameter are: - A text value. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -715,10 +772,13 @@ Accept wildcard characters: False ``` ### -FirewallStatus + +> Applicable: Security & Compliance + The FirewallStatus parameter specifies the acceptable firewall status values on devices. Valid values for this parameter are: - Required -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -726,7 +786,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -736,11 +795,14 @@ Accept wildcard characters: False ``` ### -ForceAppStorePassword + +> Applicable: Security & Compliance + The ForceAppStorePassword parameter specifies whether to require a password to use the app store on devices. Valid values for this parameter are: - $true: App store passwords are required. - $false: App store passwords aren't required. -- $null (blank): The feature isn't allowed or blocked by the rule. This is the default value. +- $null (blank): The feature isn't allowed or blocked by the rule. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -748,7 +810,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -758,11 +819,14 @@ Accept wildcard characters: False ``` ### -ForceEncryptedBackup + +> Applicable: Security & Compliance + The ForceEncryptedBackup parameter specifies whether to force encrypted backups for devices. Valid values for this parameter are: - $true: Encrypted backups are required. - $false: Encrypted backups aren't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -773,7 +837,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -783,10 +846,13 @@ Accept wildcard characters: False ``` ### -MaxPasswordAttemptsBeforeWipe + +> Applicable: Security & Compliance + The MaxPasswordAttemptsBeforeWipe parameter specifies the number of incorrect password attempts that cause devices to be automatically wiped. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -799,7 +865,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -809,6 +874,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordGracePeriod + +> Applicable: Security & Compliance + The MaxPasswordGracePeriod parameter specifies the length of time users are allowed to reset expired passwords on devices. This setting is available only on Apple iOS 6+ devices. @@ -819,7 +887,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -829,13 +896,16 @@ Accept wildcard characters: False ``` ### -MoviesRating + +> Applicable: Security & Compliance + The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: - AllowAll: All movies are allowed, regardless of their rating. - DontAllow: No movies are allowed, regardless of their rating. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. Australia @@ -919,7 +989,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -929,16 +998,18 @@ Accept wildcard characters: False ``` ### -PasswordComplexity + +> Applicable: Security & Compliance + The PasswordComplexity parameter specifies the password complexity. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -948,10 +1019,13 @@ Accept wildcard characters: False ``` ### -PasswordExpirationDays + +> Applicable: Security & Compliance + The PasswordExpirationDays parameter specifies the number of days that the same password can be used on devices before users are required to change their passwords . Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -964,7 +1038,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -974,10 +1047,13 @@ Accept wildcard characters: False ``` ### -PasswordHistoryCount + +> Applicable: Security & Compliance + The PasswordHistoryCount parameter specifies the minimum number of unique new passwords that are required on devices before an old password can be reused. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -990,7 +1066,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1000,16 +1075,18 @@ Accept wildcard characters: False ``` ### -PasswordMinComplexChars + +> Applicable: Security & Compliance + The PasswordMinComplexChars parameter specifies the minimum number of complex characters that are required for device passwords. A complex character isn't a letter. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1019,10 +1096,13 @@ Accept wildcard characters: False ``` ### -PasswordMinimumLength + +> Applicable: Security & Compliance + The PasswordMinimumLength parameter specifies the minimum number of characters that are required for device passwords. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1035,7 +1115,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1045,12 +1124,15 @@ Accept wildcard characters: False ``` ### -PasswordQuality + +> Applicable: Security & Compliance + The PasswordQuality parameter specifies the minimum password quality rating that's required for device passwords. Password quality is a numeric scale that indicates the security and complexity of the password. A higher quality value indicates a more secure password. Valid values for this parameter are: - An integer. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Android 4+ devices. @@ -1058,7 +1140,6 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1068,11 +1149,14 @@ Accept wildcard characters: False ``` ### -PasswordRequired + +> Applicable: Security & Compliance + The PasswordRequired parameter specifies whether a password is required to access devices. Valid values for this parameter are: - $true: Device passwords are required. - $false: Device passwords aren't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1084,7 +1168,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1094,6 +1177,9 @@ Accept wildcard characters: False ``` ### -PasswordTimeout + +> Applicable: Security & Compliance + The PasswordTimeout parameter specifies the length of time that devices can be inactive before a password is required to reactivate them. This setting is available on the following types of devices: @@ -1109,7 +1195,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1119,11 +1204,14 @@ Accept wildcard characters: False ``` ### -PhoneMemoryEncrypted + +> Applicable: Security & Compliance + The PhoneMemoryEncrypted parameter specifies whether to encrypt the memory on devices. Valid values for this parameter are: - $true: Memory is encrypted. - $false: Memory isn't encrypted. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available on the following types of devices: @@ -1134,7 +1222,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1144,11 +1231,14 @@ Accept wildcard characters: False ``` ### -RegionRatings + +> Applicable: Security & Compliance + The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. - au: Australia - ca: Canada - de: Germany @@ -1165,7 +1255,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1175,17 +1264,19 @@ Accept wildcard characters: False ``` ### -RequireEmailProfile + +> Applicable: Security & Compliance + The RequireEmailProfile parameter specifies whether an email profile is required on devices. Valid values for this parameter are: - $true: An email profile is required. This value is required for selective wipe on iOS devices. - $false: An email profile isn't required. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1195,11 +1286,14 @@ Accept wildcard characters: False ``` ### -SmartScreenEnabled + +> Applicable: Security & Compliance + The SmartScreenEnabled parameter specifies whether to requireWindows SmartScreen on devices. Valid values for this parameter are: - $true: SmartScreen is enabled. - $false: SmartScreen is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Windows 8.1 RT devices. @@ -1207,7 +1301,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1217,11 +1310,14 @@ Accept wildcard characters: False ``` ### -SystemSecurityTLS + +> Applicable: Security & Compliance + The SystemSecurityTLS parameter specifies whether TLS encryption is used on devices. Valid values for this parameter are: - $true: TLS encryption is used. - $false: TLS encryption isn't used. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Apple iOS 6+ devices. @@ -1229,7 +1325,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1239,13 +1334,16 @@ Accept wildcard characters: False ``` ### -TVShowsRating + +> Applicable: Security & Compliance + The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: - AllowAll: All television shows are allowed, regardless of their rating. - DontAllow: No televisions shows are allowed, regardless of their rating. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. Australia @@ -1318,7 +1416,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1328,9 +1425,12 @@ Accept wildcard characters: False ``` ### -UserAccountControlStatus + +> Applicable: Security & Compliance + The UserAccountControlStatus parameter specifies how User Account Control messages are presented on devices. Valid values for this parameter are: -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. - AlwaysNotify - NeverNotify - NotifyAppChanges @@ -1342,7 +1442,6 @@ This setting is available only on Windows 8.1 RT devices. Type: UserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1352,13 +1451,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -1368,11 +1469,14 @@ Accept wildcard characters: False ``` ### -WLANEnabled + +> Applicable: Security & Compliance + The WLANEnabled parameter specifies whether Wi-Fi is enabled devices. Valid values for this parameter are: - $true: Wi-Fi is enabled. - $false: Wi-Fi is disabled. -- $null (blank): The setting isn't configured. This is the default value. +- $null (blank): The setting isn't configured. This value is the default. This setting is available only on Microsoft Windows Phone 8.1 devices. @@ -1380,7 +1484,6 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1390,6 +1493,9 @@ Accept wildcard characters: False ``` ### -WorkFoldersSyncUrl + +> Applicable: Security & Compliance + The WorkFoldersSyncUrl parameter specifies the URL that's used to synchronize company data on devices. Valid input for this parameter a URL. For example, `https://workfolders.contoso.com`. @@ -1400,7 +1506,6 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantPolicy.md index 4642570323..7882d265a4 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-devicetenantpolicy applicable: Security & Compliance -title: Set-DeviceTenantPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-devicetenantpolicy +schema: 2.0.0 +title: Set-DeviceTenantPolicy --- # Set-DeviceTenantPolicy @@ -64,13 +65,15 @@ This example disables your organization's mobile device tenant policy. ## PARAMETERS ### -RetryDistribution + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -105,7 +113,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -115,16 +122,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -142,7 +154,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the mobile device tenant policy that you want to modify, but there's only one in your organization. The name of the policy is a GUID value. For example, a6958701-c82c-4064-ac11-64e40e7f4032. You can find this value by running the command: Get-DeviceTenantPolicy | Format-List Name. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-DeviceTenantRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantRule.md index e931196275..d878367c08 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-devicetenantrule applicable: Security & Compliance -title: Set-DeviceTenantRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-devicetenantrule +schema: 2.0.0 +title: Set-DeviceTenantRule --- # Set-DeviceTenantRule @@ -55,13 +56,15 @@ This example modifies your organization's mobile device tenant rule by replacing ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the mobile device tenant rule that you want to modify, but there's only one in your organization. The name of the rule is a GUID. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. You can find the name value by running the command Get-DeviceTenantRule | Format-List Name. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -ApplyPolicyTo + +> Applicable: Security & Compliance + The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: - ExchangeOnline @@ -81,7 +87,6 @@ The ApplyPolicyTo parameter specifies where to apply the policy in your organiza Type: PolicyResourceScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -BlockUnsupportedDevices + +> Applicable: Security & Compliance + The BlockUnsupportedDevices parameter specifies whether to block access to your organization by unsupported devices. Valid values for this parameter are: - $true: Unsupported devices are blocked. @@ -100,7 +108,6 @@ The BlockUnsupportedDevices parameter specifies whether to block access to your Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -119,7 +129,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -145,6 +156,9 @@ Accept wildcard characters: False ``` ### -ExclusionList + +> Applicable: Security & Compliance + The ExclusionList parameter specifies the security groups to exclude from this policy. Members of the specified security groups who have non-compliant devices are not affected by block access actions. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. @@ -155,7 +169,6 @@ To enter multiple values and overwrite any existing entries, use the following s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Set-DistributionGroup.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DistributionGroup.md index 7d84dcf397..0a06420b0c 100644 --- a/exchange/exchange-ps/exchange/Set-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DistributionGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-distributiongroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-DistributionGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-distributiongroup +schema: 2.0.0 +title: Set-DistributionGroup --- # Set-DistributionGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-DistributionGroup cmdlet to modify the settings of existing distribution groups or mail-enabled security groups. To add or remove group members, use the Add-DistributionGroupMember, Remove-DistributionGroupMember or Update-DistributionGroupMember cmdlets. @@ -98,7 +99,7 @@ Set-DistributionGroup [-Identity] ## DESCRIPTION Distribution groups are used to consolidate groups of recipients into a single point of contact for email messages. Distribution groups aren't security principals, and therefore can't be assigned permissions. However, you can assign permissions to mail-enabled security groups. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -126,6 +127,9 @@ This example changes the name of an existing distribution group from Ed\_DirectR ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name @@ -139,7 +143,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -149,6 +152,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -172,7 +178,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -182,6 +187,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -205,7 +213,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +222,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -240,7 +250,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -250,6 +259,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -274,7 +286,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -284,6 +295,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -303,7 +317,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,18 +326,20 @@ Accept wildcard characters: False ``` ### -BccBlocked + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The BccBlocked parameter specifies whether members of the group don't receive messages if the group is used in the Bcc line. Valid values are: - $true: If the group is used in the Bcc line, members of the group don't receive the message, and the sender receives a non-delivery report (also known as an NDR or bounce message). Other recipients of the message aren't blocked. If an external sender uses the group in the Bcc line, members of the group aren't blocked. For nested groups, the message is blocked only for members of the top-level group. -- $false: There are no restrictions for using the group in the Bcc line of messages. This is the default value. +- $false: There are no restrictions for using the group in the Bcc line of messages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -334,6 +349,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -355,7 +373,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -365,16 +382,18 @@ Accept wildcard characters: False ``` ### -BypassNestedModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ByPassNestedModerationEnabled parameter specifies how to handle message approval when a moderated group contains other moderated groups as members. Valid values are: - $true: After a moderator approves a message sent to the group, the message is automatically approved for all other moderated groups that are members of the group. -- $false: After a moderator approves a message sent to the group, separate approval is required for each moderated group that's a member of the group. This is the default value. +- $false: After a moderator approves a message sent to the group, separate approval is required for each moderated group that's a member of the group. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -384,6 +403,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -395,7 +417,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -405,6 +426,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -414,7 +438,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -424,18 +447,20 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: -- $true: A DTMF map is created for the recipient. This is the default value. +- $true: A DTMF map is created for the recipient. This value is the default. - $false: A DTMF map isn't created for the recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -445,13 +470,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -461,13 +488,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -477,13 +506,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -493,13 +524,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -509,13 +542,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -525,13 +560,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -541,13 +578,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -557,13 +596,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -573,13 +614,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -589,13 +632,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -605,13 +650,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -621,13 +668,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -637,13 +686,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -653,13 +704,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -669,13 +722,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -685,6 +740,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Description parameter specifies an optional description for the distribution group. If the value contains spaces, enclose the value in quotation marks. @@ -693,7 +751,6 @@ The Description parameter specifies an optional description for the distribution Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -703,6 +760,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If a group naming policy is enforced in your organization, users need to follow the naming constraints as specified by the DistributionGroupNameBlockedWordList parameter on the Set-OrganizationConfig cmdlet. To bypass this requirement, use the IgnoreNamingPolicy switch. @@ -711,7 +771,6 @@ If a group naming policy is enforced in your organization, users need to follow Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -721,6 +780,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -729,7 +791,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -739,6 +800,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -766,7 +830,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -776,18 +839,20 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: -- $true: Email address policies are applied to this recipient. This is the default value. +- $true: Email address policies are applied to this recipient. This value is the default. - $false: Email address policies aren't applied to this recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -797,6 +862,9 @@ Accept wildcard characters: False ``` ### -ExpansionServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ExpansionServer parameter specifies the Exchange server that's used to expand the distribution group. The default value is blank ($null), which means expansion happens on the closest available Exchange server. If you specify an expansion server, and that server is unavailable, any messages that are sent to the distribution group can't be delivered. @@ -812,7 +880,6 @@ When you specify an expansion server, use the ExchangeLegacyDN. You can find thi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -822,19 +889,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -844,19 +913,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -866,19 +937,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -888,19 +961,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -910,19 +985,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -932,13 +1009,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -948,6 +1027,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this group. Although messages send on behalf of the group clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the group, not the sender. The sender you specify for this parameter must 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 sender. For example: @@ -973,7 +1055,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -983,16 +1064,18 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. -- $false: The recipient is visible in address lists. This is the default value. +- $false: The recipient is visible in address lists. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1002,6 +1085,9 @@ Accept wildcard characters: False ``` ### -HiddenGroupMembershipEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. 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. @@ -1014,7 +1100,6 @@ You can use this setting to help comply with regulations that require you to hid Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1024,6 +1109,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -1037,7 +1125,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1047,6 +1134,9 @@ Accept wildcard characters: False ``` ### -IgnoreNamingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The IgnoreNamingPolicy switch specifies whether to prevent this group from being affected by your organization's group naming policy. You don't need to specify a value with this switch. The group naming policy is defined by the DistributionGroupNamingPolicy and DistributionGroupNameBlockedWordList parameters on the Set-OrganizationConfig cmdlet. @@ -1055,7 +1145,6 @@ The group naming policy is defined by the DistributionGroupNamingPolicy and Dist Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1065,6 +1154,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -1076,7 +1168,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1086,6 +1177,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -1100,7 +1194,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1110,6 +1203,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies an owner for the group. A group must have at least one owner. If you don't use this parameter to specify the owner when you create the group, the user account that created the group is the owner. The group owner is able to: - Modify the properties of the group @@ -1148,7 +1244,6 @@ Owners that you specify with this parameter are not added as group members. You Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1158,6 +1253,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxReceiveSize parameter specifies the maximum size of an email message that can be sent to this group. Messages that exceed the maximum size are rejected by the group. @@ -1169,7 +1267,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -1179,7 +1277,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1189,6 +1286,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxSendSize parameter specifies the maximum size of an email message that can be sent by this group. @@ -1200,7 +1300,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -1210,7 +1310,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1220,16 +1319,18 @@ Accept wildcard characters: False ``` ### -MemberDepartRestriction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MemberDepartRestriction parameter specifies the restrictions that you put on requests to leave the group. Valid values are: -- Open: Members can leave the group without approval from one of the group owners. This is the default value for universal distribution groups. You can't use this value on universal security groups. -- Closed: Members can't remove themselves from the group, and requests to leave the group are rejected automatically. Group membership is controlled by the group owners. This is the default value for universal security groups. +- Open: Members can leave the group without approval from one of the group owners. This value is the default for universal distribution groups. You can't use this value on universal security groups. +- Closed: Members can't remove themselves from the group, and requests to leave the group are rejected automatically. Group membership is controlled by the group owners. This value is the default for universal security groups. ```yaml Type: MemberUpdateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1239,17 +1340,19 @@ Accept wildcard characters: False ``` ### -MemberJoinRestriction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MemberJoinRestriction parameter specifies the restrictions that you put on requests to join the group. Valid values are: - Open: Users can add themselves to the group without approval from a group owner. You can't use this value on universal security groups. -- Closed: Users can't add themselves to the group, and requests to join the group are rejected automatically. Group membership is controlled by the group owners. This is the default value on universal security groups and universal distribution groups. +- Closed: Users can't add themselves to the group, and requests to join the group are rejected automatically. Group membership is controlled by the group owners. This value is the default on universal security groups and universal distribution groups. - ApprovalRequired: Users can request to join the group. The user is added to the group after the request is approved by one of the group owners. Although you can use this value on universal security groups, user requests to join the group aren't sent to the group owners, so this setting is only effective on universal distribution groups. ```yaml Type: MemberUpdateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1259,6 +1362,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1280,7 +1386,6 @@ For distribution groups, if you set the ModerationEnabled parameter to the value Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1290,10 +1395,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -1301,7 +1409,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1311,13 +1418,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the group. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1327,6 +1436,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the group are no longer automatically updated by email address policies. @@ -1337,7 +1449,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1347,6 +1458,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1370,7 +1484,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1380,6 +1493,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1403,7 +1519,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1413,6 +1528,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1438,7 +1556,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1448,10 +1565,13 @@ Accept wildcard characters: False ``` ### -ReportToManagerEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 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. +- $false: Delivery status notifications aren't sent to the owner (first one listed if more than one) of the group. This value is the default. 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. @@ -1459,7 +1579,6 @@ The ReportToManagerEnabled and ReportToOriginatorEnabled parameters affect the r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1469,9 +1588,12 @@ Accept wildcard characters: False ``` ### -ReportToOriginatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ReportToOriginatorEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to senders who send messages to this group. Valid values are: -- $true: Delivery status notifications are sent to the message senders. This is the default value. +- $true: Delivery status notifications are sent to the message senders. This value is the default. - $false: Delivery status notifications aren't sent to the message senders. 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. @@ -1480,7 +1602,6 @@ The ReportToManagerEnabled and ReportToOriginatorEnabled parameters affect the r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1490,6 +1611,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1499,7 +1623,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1509,6 +1632,9 @@ Accept wildcard characters: False ``` ### -ResetMigrationToUnifiedGroup + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResetMigrationToUnifiedGroup switch specifies whether you want to reset the flag that indicates the migration of the distribution group to a Microsoft 365 Group is in progress. You don't need to specify a value with this switch. @@ -1517,7 +1643,6 @@ The ResetMigrationToUnifiedGroup switch specifies whether you want to reset the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1527,6 +1652,9 @@ Accept wildcard characters: False ``` ### -RoomList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RoomList switch specifies that all members of this distribution group are room mailboxes. You don't need to specify a value with this switch. You can create a distribution group for an office building in your organization and add all rooms in that building to the distribution group. Room list distribution groups are used to generate a list of building locations for meeting requests in Outlook 2010 or later. Room lists allow a user to select a building and get availability information for all rooms in that building, without having to add each room individually. @@ -1535,7 +1663,6 @@ You can create a distribution group for an office building in your organization Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1545,15 +1672,17 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1563,9 +1692,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -1575,7 +1707,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1585,16 +1716,18 @@ Accept wildcard characters: False ``` ### -SendOofMessageToOriginatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SendOofMessageToOriginatorEnabled parameter specifies how to handle out of office (OOF) messages for members of the group. Valid values are: - $true: When messages are sent to the group, OOF messages for any of the group members are sent to the message sender. -- $false: When messages are sent to the group, OOF messages for any of the group members aren't sent to the message sender. This is the default value. +- $false: When messages are sent to the group, OOF messages for any of the group members aren't sent to the message sender. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1604,6 +1737,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -1616,7 +1752,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1626,6 +1761,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -1646,7 +1784,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1656,6 +1793,9 @@ Accept wildcard characters: False ``` ### -UpdateMemberCount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill UpdateMemberCount Description }} @@ -1664,7 +1804,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1674,13 +1813,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1690,6 +1831,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -1701,7 +1845,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-DkimSigningConfig.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-DkimSigningConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DkimSigningConfig.md index f2b0ed064b..91d0b4e1e1 100644 --- a/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DkimSigningConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection -title: Set-DkimSigningConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dkimsigningconfig +schema: 2.0.0 +title: Set-DkimSigningConfig --- # Set-DkimSigningConfig @@ -33,7 +34,7 @@ Set-DkimSigningConfig [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example disables the DKIM signing policy for the contoso.com domain. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the DKIM signing policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name: The domain name (for example, contoso.com). @@ -57,7 +61,6 @@ The Identity parameter specifies the DKIM signing policy that you want to modify Type: DkimSigningConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,16 +88,18 @@ Accept wildcard characters: False ``` ### -BodyCanonicalization + +> Applicable: Exchange Online, Exchange Online Protection + The BodyCanonicalization parameter specifies the canonicalization algorithm that's used to create and verify the message body part of the DKIM signature. This value effectively controls the sensitivity of DKIM to changes to the message body in transit. Valid values are: -- Relaxed: Changes in whitespace and changes in empty lines at the end of the message body are tolerated. This is the default value. +- Relaxed: Changes in whitespace and changes in empty lines at the end of the message body are tolerated. This value is the default. - Simple: Only changes in empty lines at the end of the message body are tolerated. ```yaml Type: CanonicalizationType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -111,7 +121,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -121,16 +130,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -140,16 +151,18 @@ Accept wildcard characters: False ``` ### -HeaderCanonicalization + +> Applicable: Exchange Online, Exchange Online Protection + The HeaderCanonicalization parameter specifies the canonicalization algorithm that's used to create and verify the message header part of the DKIM signature. This value effectively controls the sensitivity of DKIM to changes to the message headers in transit. Valid values are: -- Relaxed: Common modifications to the message header are tolerated (for example, header field line rewrapping, changes in unnecessary whitespace or empty lines, and changes in case for header fields). This is the default value. +- Relaxed: Common modifications to the message header are tolerated (for example, header field line rewrapping, changes in unnecessary whitespace or empty lines, and changes in case for header fields). This value is the default. - Simple: No changes to the header fields are tolerated. ```yaml Type: CanonicalizationType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -159,6 +172,9 @@ Accept wildcard characters: False ``` ### -PublishTxtRecords + +> Applicable: Exchange Online, Exchange Online Protection + The PublishTxtRecords switch publishes the required data for the selected domain so the correct DKIM records can be created in DNS. You don't need to specify a value with this switch. If you're using a third party DNS service, you still need to create the CNAME records that point to the DKIM records that have been created for you. @@ -167,7 +183,6 @@ If you're using a third party DNS service, you still need to create the CNAME re Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -177,13 +192,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpCompliancePolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpCompliancePolicy.md index 24bb0ce5cc..4abc2dd131 100644 --- a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpcompliancepolicy applicable: Security & Compliance -title: Set-DlpCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpcompliancepolicy +schema: 2.0.0 +title: Set-DlpCompliancePolicy --- # Set-DlpCompliancePolicy @@ -43,6 +44,7 @@ Set-DlpCompliancePolicy [-Identity] [-EndpointDlpAdaptiveScopes ] [-EndpointDlpAdaptiveScopesException ] [-EndpointDlpExtendedLocations ] + [-EnforcementPlanes ] [-ExceptIfOneDriveSharedBy ] [-ExceptIfOneDriveSharedByMemberOf ] [-ExchangeAdaptiveScopes ] @@ -104,7 +106,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned Set-DlpCompliancePolicy -Identity "Main PII" -AddSharePointLocation "https://my.url1","https://my.url2" -AddOneDriveLocation "https://my.url3","https://my.url4" ``` -This example adds the specified URLs to the SharePoint Online and OneDrive for Business locations for the DLP policy named Main PII without affecting the existing URL values. +This example adds the specified URLs to the SharePoint and OneDrive locations for the DLP policy named Main PII without affecting the existing URL values. ### Example 2 ```powershell @@ -123,6 +125,9 @@ This example adds the specified workspace IDs to the Power BI location for the D ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -134,7 +139,6 @@ The Identity parameter specifies the DLP policy that you want to modify. You can Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -144,7 +148,10 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch redistributes the policy to all Exchange, OneDrive for Business, and SharePoint Online locations. You don't need to specify a value with this switch. + +> Applicable: Security & Compliance + +The RetryDistribution switch redistributes the policy to all Exchange, OneDrive, and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported if you used this switch. @@ -154,7 +161,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -164,6 +170,9 @@ Accept wildcard characters: False ``` ### -AddEndpointDlpLocation + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The AddEndpointDLPLocation parameter specifies the user accounts to add to the list of included accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. @@ -176,7 +185,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -186,6 +194,9 @@ Accept wildcard characters: False ``` ### -AddEndpointDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The AddEndpointDlpLocationException parameter specifies the user accounts to add to the list of excluded accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. @@ -198,7 +209,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -208,7 +218,10 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation -The AddExchangeLocation parameter adds email messages to the DLP policy if they're not already included. The valid value for this parameter is All. + +> Applicable: Security & Compliance + +The AddExchangeLocation parameter adds email messages to the DLP policy if they aren't already included. The valid value for this parameter is All. If the policy doesn't already include email messages (in the output of the Get-DlpCompliancePolicy cmdlet, the ExchangeLocation property value is blank), you can use this parameter in the following procedures: @@ -222,7 +235,6 @@ If the policy doesn't already include email messages (in the output of the Get-D Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -232,11 +244,14 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation -The AddOneDriveLocation parameter adds OneDrive for Business sites to the DLP policy if they're not already included. The valid value for this parameter is All. -If the policy doesn't already include OneDrive for Business sites (in the output of the Get-DlpCompliancePolicy cmdlet, the OneDriveLocation property value is blank), you can use this parameter in the following procedures: +> Applicable: Security & Compliance + +The AddOneDriveLocation parameter adds OneDrive sites to the DLP policy if they aren't already included. The valid value for this parameter is All. + +If the policy doesn't already include OneDrive sites (in the output of the Get-DlpCompliancePolicy cmdlet, the OneDriveLocation property value is blank), you can use this parameter in the following procedures: -- If you use `-AddOneDriveLocation All` by itself, the policy applies to all OneDrive for Business sites. +- If you use `-AddOneDriveLocation All` by itself, the policy applies to all OneDrive sites. - To include sites of specific OneDrive accounts in the policy, use `-AddOneDriveLocation All` and the OneDriveSharedBy parameter to specify the users. Only the sites of the specified users are included in the policy. @@ -254,7 +269,6 @@ You can't specify inclusions and exclusions in the same policy. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -264,13 +278,15 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocationException + +> Applicable: Security & Compliance + Don't use this parameter. See the AddOneDriveLocation parameter for an explanation. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -280,6 +296,9 @@ Accept wildcard characters: False ``` ### -AddOnPremisesScannerDlpLocation + +> Applicable: Security & Compliance + The AddOnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to add to the list of included repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -290,7 +309,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -300,6 +318,9 @@ Accept wildcard characters: False ``` ### -AddOnPremisesScannerDlpLocationException + +> Applicable: Security & Compliance + The AddOnPremisesScannerDlpLocationExclusion parameter specifies the on-premises file shares and SharePoint document libraries and folders to add to the list of excluded repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -310,7 +331,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -320,6 +340,9 @@ Accept wildcard characters: False ``` ### -AddPowerBIDlpLocation + +> Applicable: Security & Compliance + The AddPowerBIDlpLocation parameter specifies the Power BI workspace IDs to add to the list of included workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. You can find the workspace ID using one of the following procedures: @@ -334,7 +357,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddPowerBIDlpLocationException parameter specifies the Power BI workspace IDs to add to the list of excluded workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. You can find the workspace ID using one of the following procedures: @@ -358,7 +383,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites if you used the value All for the SharePointLocation parameter. You identify the site by its URL value. + +You can't add SharePoint sites to the policy until they have been indexed. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -378,7 +405,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The AddSharePointLocationException parameter specifies the SharePoint sites to add to the list of excluded sites if you used the value All for the SharePointLocation parameter. You identify the site by its URL value. + +You can't add SharePoint sites to the policy until they have been indexed. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -398,7 +427,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddTeamsLocation parameter specifies the accounts, distribution groups, or mail-enabled security groups to add to the list of included Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -416,7 +447,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddTeamsLocationException parameter specifies the accounts, distribution groups, or mail-enabled security groups to add to the list of excluded Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -434,7 +467,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The AddThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to add to the list of included apps if you used the value All for the ThirdPartyAppDlpLocation parameter. @@ -456,7 +491,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -466,6 +500,9 @@ Accept wildcard characters: False ``` ### -AddThirdPartyAppDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The AddThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps to add to the list of excluded apps if you used the value All for the ThirdPartyAppDlpLocation parameter. @@ -478,7 +515,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -488,13 +524,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -504,6 +542,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -513,7 +554,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -523,13 +563,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill EndpointDlpAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -539,13 +581,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill EndpointDlpAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -555,13 +599,40 @@ Accept wildcard characters: False ``` ### -EndpointDlpExtendedLocations + +> Applicable: Security & Compliance + {{ 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 + +> Applicable: Security & Compliance + +The EnforcementPlanes parameter defines the layer where policy actions are run. This parameter uses the following syntax: + +`-EnforcementPlanes @("")`. + +Currently, supported values are: + +- Entra: For use with policies applied to Entra-registered enterprise applications in the organization. +- Browser: For use with policies applied to unmanaged cloud apps in Edge for Business. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -571,11 +642,14 @@ 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). + +> Applicable: Security & Compliance + +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, one of the following statements must be true: -- The policy already includes OneDrive for Business sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- The policy already includes OneDrive sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). - Use `-AddOneDriveLocation All` in the same command with this parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -586,7 +660,6 @@ You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMember Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -596,11 +669,14 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf -The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to exclude from the DLP policy (the OneDrive for Business sites of group members are excluded from the policy). You identify the groups by email address. + +> Applicable: Security & Compliance + +The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to exclude from the DLP policy (the OneDrive sites of group members are excluded from the policy). You identify the groups by email address. To use this parameter, one of the following statements must be true: -- The policy already includes OneDrive for Business sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- The policy already includes OneDrive sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). - Use `-AddOneDriveLocation All` in the same command with this parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -613,7 +689,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -623,13 +698,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -639,13 +716,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -655,6 +734,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf + +> Applicable: Security & Compliance + The ExchangeSenderMemberOf parameter specifies the distribution groups or security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -672,7 +754,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -682,6 +763,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException + +> Applicable: Security & Compliance + The ExchangeSenderMemberOfException parameter specifies the distribution groups or security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -699,7 +783,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -709,6 +792,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -717,7 +803,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -727,13 +812,15 @@ Accept wildcard characters: False ``` ### -IsFromSmartInsights + +> Applicable: Security & Compliance + {{ Fill IsFromSmartInsights Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -743,6 +830,9 @@ Accept wildcard characters: False ``` ### -Locations + +> Applicable: Security & Compliance + 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`. @@ -770,7 +860,6 @@ After you create the `$loc` variable as shown in the previous examples, use the Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -780,9 +869,12 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Security & Compliance + 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. +- Enable: The policy is enabled for actions and notifications. This value is the default. - Disable: The policy is disabled. - 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. @@ -791,7 +883,6 @@ The Mode parameter specifies the action and notification level of the DLP policy Type: PolicyMode Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -801,13 +892,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -817,13 +910,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -833,11 +928,14 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy -The OneDriveSharedBy parameter specifies the users to include in the DLP policy (the sites of the OneDrive for Business user accounts are included in the policy). You identify the users by UPN (laura@contoso.onmicrosoft.com). + +> Applicable: Security & Compliance + +The OneDriveSharedBy parameter specifies the users to include in the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, one of the following statements must be true: -- The policy already includes OneDrive for Business sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- The policy already includes OneDrive sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). - Use `-AddOneDriveLocation All` in the same command with this parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -848,7 +946,6 @@ You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDri Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -858,11 +955,14 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf -The OneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the DLP policy (the OneDrive for Business sites of group members are included in the policy). You identify the groups by email address. + +> Applicable: Security & Compliance + +The OneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the DLP policy (the OneDrive sites of group members are included in the policy). You identify the groups by email address. To use this parameter, one of the following statements must be true: -- The policy already includes OneDrive for Business sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- The policy already includes OneDrive sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). - Use `-AddOneDriveLocation All` in the same command with this parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -875,7 +975,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -885,6 +984,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + 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. @@ -893,7 +995,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -903,6 +1004,9 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + The PolicyTemplateInfo specifies the built-in or custom DLP policy templates to use in the DLP policy. For more information about DLP policy templates, see [What the DLP policy templates include](https://learn.microsoft.com/purview/what-the-dlp-policy-templates-include). @@ -911,7 +1015,6 @@ For more information about DLP policy templates, see [What the DLP policy templa Type: PswsHashtable Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -921,6 +1024,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and policies can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing policies. For example, if there are 5 existing policies: @@ -935,7 +1041,6 @@ If you modify the priority value of a policy, the position of the policy in the Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -945,6 +1050,9 @@ Accept wildcard characters: False ``` ### -RemoveEndpointDlpLocation + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The RemoveEndpointDlpLocation parameter specifies the user accounts to remove from the list of included accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You specify the account by name or email address. @@ -957,7 +1065,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -967,6 +1074,9 @@ Accept wildcard characters: False ``` ### -RemoveEndpointDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The RemoveEndpointDlpLocation parameter specifies the user accounts to remove from the list of excluded accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You specify the account by name or email address. @@ -979,7 +1089,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -989,6 +1098,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter removes email messages from the DLP policy if they're already included. The valid value for this parameter is All. If the policy already includes email messages (in the output of the Get-DlpCompliancePolicy cmdlet, the ExchangeLocation property value is All), you can use `-RemoveExchangeLocation All` to prevent the policy from applying to email messages. @@ -997,7 +1109,6 @@ If the policy already includes email messages (in the output of the Get-DlpCompl Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1007,9 +1118,12 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation -The RemoveOneDriveLocation parameter removes OneDrive for Business sites from the DLP policy if they're already included. The valid value for this parameter is All. -If the policy already includes OneDrive for Business sites (in the output of the Get-DlpCompliancePolicy cmdlet, the OneDriveLocation property value is All), you can use `-RemoveOneDriveLocation All` to prevent the policy from applying to OneDrive for Business sites. +> Applicable: Security & Compliance + +The RemoveOneDriveLocation parameter removes OneDrive sites from the DLP policy if they're already included. The valid value for this parameter is All. + +If the policy already includes OneDrive sites (in the output of the Get-DlpCompliancePolicy cmdlet, the OneDriveLocation property value is All), you can use `-RemoveOneDriveLocation All` to prevent the policy from applying to OneDrive sites. **Note**: Although this parameter accepts site URLs, don't specify site URLs values. Use the OneDriveSharedBy, ExceptIfOneDriveShareBy, OneDriveSharedByMemberOf, and ExceptIfOneDriveSharedByMemberOf parameters instead. In the DLP policy settings in the Microsoft Defender portal, you can't specify sites to include or exclude by URL; you specify sites to include or exclude only by users or groups. @@ -1017,7 +1131,6 @@ If the policy already includes OneDrive for Business sites (in the output of the Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1027,13 +1140,15 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocationException + +> Applicable: Security & Compliance + Don't use this parameter. See the RemoveOneDriveLocation parameter for an explanation. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1043,6 +1158,9 @@ Accept wildcard characters: False ``` ### -RemoveOnPremisesScannerDlpLocation + +> Applicable: Security & Compliance + The RemoveOnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to remove from the list of included repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1053,7 +1171,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1063,6 +1180,9 @@ Accept wildcard characters: False ``` ### -RemoveOnPremisesScannerDlpLocationException + +> Applicable: Security & Compliance + The RemoveOnPremisesScannerDlpLocationException parameter specifies the on-premises file shares and SharePoint document libraries and folders to remove from the list of excluded repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1073,7 +1193,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1083,6 +1202,9 @@ Accept wildcard characters: False ``` ### -RemovePowerBIDlpLocation + +> Applicable: Security & Compliance + The RemovePowerBIDlpLocation parameter specifies the Power BI workspace IDs to remove from the list of included workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. You can find the workspace ID using one of the following procedures: @@ -1097,7 +1219,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The RemovePowerBIDlpLocationException parameter specifies the Power BI workspace IDs to remove the list of excluded workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. You can find the workspace ID using one of the following procedures: @@ -1121,7 +1245,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites if you used the value All for the SharePointLocation parameter. You specify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1139,7 +1265,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + +The RemoveSharePointLocationException parameter specifies the SharePoint sites to remove from the list of excluded sites if you used the value All for the SharePointLocation parameter. You specify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1157,7 +1285,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + 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: `"","",...""`. @@ -1175,7 +1305,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The RemoveTeamsLocationException parameter specifies the accounts, distribution groups, or mail-enabled security groups to remove from the list of excluded Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1193,7 +1325,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The RemoveThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to remove from the list of included apps if you used the value All for the ThirdPartyAppDlpLocation parameter. @@ -1215,7 +1349,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1225,6 +1358,9 @@ Accept wildcard characters: False ``` ### -RemoveThirdPartyAppDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The RemoveThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps tp remove from the list of excluded apps if you used the value All for the ThirdPartyAppDlpLocation parameter. @@ -1237,7 +1373,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1247,13 +1382,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1263,13 +1400,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1279,13 +1418,15 @@ Accept wildcard characters: False ``` ### -StartSimulation + +> Applicable: Security & Compliance + {{ Fill StartSimulation Description }} ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1295,13 +1436,15 @@ Accept wildcard characters: False ``` ### -TeamsAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill TeamsAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1311,13 +1454,15 @@ Accept wildcard characters: False ``` ### -TeamsAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill TeamsAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1327,13 +1472,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpComplianceRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-DlpComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpComplianceRule.md index 2db025a422..31fbb3026c 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpcompliancerule applicable: Security & Compliance -title: Set-DlpComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpcompliancerule +schema: 2.0.0 +title: Set-DlpComplianceRule --- # Set-DlpComplianceRule @@ -53,6 +54,7 @@ Set-DlpComplianceRule [-Identity] [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] [-DocumentSizeOver ] + [-DomainCountOver ] [-EncryptRMSTemplate ] [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] @@ -126,6 +128,7 @@ Set-DlpComplianceRule [-Identity] [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] [-NotifyEmailExchangeIncludeAttachment ] + [-NotifyEmailOnedriveRemediationActions ] [-NotifyEndpointUser ] [-NotifyOverrideRequirements ] [-NotifyPolicyTipCustomDialog ] @@ -142,6 +145,7 @@ Set-DlpComplianceRule [-Identity] [-Quarantine ] [-RecipientADAttributeContainsWords ] [-RecipientADAttributeMatchesPatterns ] + [-RecipientCountOver ] [-RecipientDomainIs ] [-RedirectMessageTo ] [-RemoveHeader ] @@ -186,7 +190,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", @@ -256,6 +260,9 @@ This example uses the AdvancedRule parameter to read the following complex condi ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -267,7 +274,6 @@ The Identity parameter specifies the DLP rule that you want to modify. You can u Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -277,6 +283,9 @@ Accept wildcard characters: False ``` ### -AccessScope + +> Applicable: Security & Compliance + The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule is applied to content that's accessible or delivered to a recipient inside the organization. @@ -287,7 +296,6 @@ The AccessScope parameter specifies a condition for the DLP rule that's based on Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -297,13 +305,15 @@ Accept wildcard characters: False ``` ### -ActivationDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -313,6 +323,9 @@ Accept wildcard characters: False ``` ### -AddRecipients + +> Applicable: Security & Compliance + The AddRecipients parameter specifies an action for the DLP rule that adds the specified recipients to email messages. This parameter uses the following syntax: - `@{ = "emailaddress"}`. For example, `@{AddToRecipients = "laura@contoso.com"}` or `@{BlindCopyTo = "julia@contoso.com"}`. @@ -324,7 +337,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -334,6 +346,9 @@ Accept wildcard characters: False ``` ### -AdvancedRule + +> Applicable: Security & Compliance + The AdvancedRule parameter uses complex rule syntax that supports multiple AND, OR, and NOT operators and nested groups. This parameter uses JSON syntax that's similar to the traditional advanced syntax, but is read from a file that contains additional operators and combinations that aren't traditionally supported. @@ -344,7 +359,6 @@ For syntax details, see Example 2. Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -354,13 +368,15 @@ Accept wildcard characters: False ``` ### -AlertProperties + +> Applicable: Security & Compliance + {{ Fill AlertProperties Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -370,6 +386,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The AnyOfRecipientAddressContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -384,7 +403,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -394,6 +412,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -404,7 +425,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -414,6 +434,9 @@ Accept wildcard characters: False ``` ### -ApplyBrandingTemplate + +> Applicable: Security & Compliance + The ApplyBrandingTemplate parameter specifies an action for the DLP rule that applies a custom branding template for messages encrypted by Microsoft Purview Message Encryption. You identify the custom branding template by name. If the name contains spaces, enclose the name in quotation marks ("). Use the EnforcePortalAccess parameter to control whether external users are required to use the encrypted message portal to view encrypted messages. @@ -422,7 +445,6 @@ Use the EnforcePortalAccess parameter to control whether external users are requ Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -432,6 +454,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimer + +> Applicable: Security & Compliance + The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = ; FallbackAction = }`. - Text: Specifies the disclaimer text to add. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. @@ -444,7 +469,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -454,13 +478,15 @@ Accept wildcard characters: False ``` ### -AttachmentIsNotLabeled + +> Applicable: Security & Compliance + {{ Fill AttachmentIsNotLabeled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -470,16 +496,18 @@ Accept wildcard characters: False ``` ### -BlockAccess + +> Applicable: Security & Compliance + 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: - $true: Blocks further access to the source item that matched the rule. The owner, author, and site owner can still access the item. -- $false: Allows access to the source item that matched the rule. This is the default value. +- $false: Allows access to the source item that matched the rule. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -489,6 +517,9 @@ Accept wildcard characters: False ``` ### -BlockAccessScope + +> Applicable: Security & Compliance + The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - All: Blocks access to everyone except the owner and the last modifier. @@ -499,7 +530,6 @@ The BlockAccessScope parameter specifies the scope of the block access action. V Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -509,13 +539,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -525,6 +557,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -536,7 +571,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -546,6 +580,9 @@ Accept wildcard characters: False ``` ### -ContentCharacterSetContainsWords + +> Applicable: Security & Compliance + The ContentCharacterSetContainsWords parameter specifies a condition for the rule that looks for character set names in messages. You can specify multiple values separated by commas. Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874`. @@ -554,7 +591,6 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -564,6 +600,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information types, the parameter can also be applied to files that contain sensitivity labels. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for a sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. @@ -574,7 +613,6 @@ Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -584,13 +622,15 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -600,13 +640,15 @@ Accept wildcard characters: False ``` ### -ContentFileTypeMatches + +> Applicable: Security & Compliance + {{ Fill ContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -616,13 +658,15 @@ Accept wildcard characters: False ``` ### -ContentIsNotLabeled + +> Applicable: Security & Compliance + {{ Fill ContentIsNotLabeled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -632,13 +676,15 @@ Accept wildcard characters: False ``` ### -ContentIsShared + +> Applicable: Security & Compliance + {{ Fill ContentIsShared Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -648,6 +694,9 @@ Accept wildcard characters: False ``` ### -ContentPropertyContainsWords + +> Applicable: Security & Compliance + The ContentPropertyContainsWords parameter specifies a condition for the DLP rule that's based on a property match in content. The rule is applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -656,7 +705,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -666,16 +714,18 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: - $true: The rule is disabled. -- $false: The rule is enabled. This is the default value. +- $false: The rule is enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -685,6 +735,9 @@ Accept wildcard characters: False ``` ### -DocumentContainsWords + +> Applicable: Security & Compliance + The DocumentContainsWords parameter specifies a condition for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -695,7 +748,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -705,13 +757,15 @@ Accept wildcard characters: False ``` ### -DocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill DocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -721,13 +775,15 @@ Accept wildcard characters: False ``` ### -DocumentCreatedByMemberOf + +> Applicable: Security & Compliance + {{ Fill DocumentCreatedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -737,6 +793,9 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected + +> Applicable: Security & Compliance + The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -746,7 +805,6 @@ The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -756,6 +814,9 @@ Accept wildcard characters: False ``` ### -DocumentIsUnsupported + +> Applicable: Security & Compliance + The DocumentIsUnsupported parameter specifies a condition for the DLP rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -765,7 +826,6 @@ The DocumentIsUnsupported parameter specifies a condition for the DLP rule that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -775,6 +835,9 @@ Accept wildcard characters: False ``` ### -DocumentMatchesPatterns + +> Applicable: Security & Compliance + The DocumentMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -785,7 +848,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -795,6 +857,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesPatterns + +> Applicable: Security & Compliance + The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -803,7 +868,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -813,6 +877,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesWords + +> Applicable: Security & Compliance + The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -825,7 +892,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -835,6 +901,9 @@ Accept wildcard characters: False ``` ### -DocumentSizeOver + +> Applicable: Security & Compliance + The DocumentSizeOver parameter specifies a condition for the DLP rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -845,7 +914,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -853,7 +922,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -862,7 +930,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DomainCountOver + +> Applicable: Security & Compliance + +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: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EncryptRMSTemplate + +> Applicable: Security & Compliance + 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 ("). Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. @@ -871,7 +961,6 @@ Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -881,13 +970,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpBrowserRestrictions + +> Applicable: Security & Compliance + {{ Fill EndpointDlpBrowserRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -897,6 +988,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpRestrictions + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The EndpointDlpRestrictions parameter specifies the restricted endpoints for Endpoint DLP. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. @@ -925,7 +1019,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -935,6 +1028,9 @@ Accept wildcard characters: False ``` ### -EnforcePortalAccess + +> Applicable: Security & Compliance + The EnforcePortalAccess parameter specifies whether external recipients are required to view encrypted mail using the encrypted message portal when the ApplyBrandingTemplate action is also specified. Valid values are: - $true: External recipients are required to use the encrypted message portal to view encrypted messages. @@ -944,7 +1040,6 @@ The EnforcePortalAccess parameter specifies whether external recipients are requ Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -954,6 +1049,9 @@ Accept wildcard characters: False ``` ### -EvaluateRulePerComponent + +> Applicable: Security & Compliance + 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). @@ -972,7 +1070,6 @@ This parameter works with the following conditions or exceptions only: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -982,6 +1079,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAccessScope + +> Applicable: Security & Compliance + The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule isn't applied to content that's accessible or delivered to a recipient inside the organization. @@ -992,7 +1092,6 @@ The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1002,6 +1101,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. - Single word: `"no_reply"` @@ -1016,7 +1118,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1026,6 +1127,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1036,7 +1140,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1046,6 +1149,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentCharacterSetContainsWords parameter specifies an exception for the rule that looks for character set names in messages. To specify multiple words, this parameter uses the syntax: `Word1,word2,...wordN`. Don't use leading or trailing spaces. @@ -1056,7 +1162,6 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1066,6 +1171,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information types, the parameter can also be applied to files that contain sensitivity labels. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for a sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. @@ -1076,7 +1184,6 @@ Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1086,13 +1193,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1102,13 +1211,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentFileTypeMatches + +> Applicable: Security & Compliance + {{ Fill ExceptIfContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1118,13 +1229,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentIsShared + +> Applicable: Security & Compliance + {{ Fill ExceptIfContentIsShared Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1134,6 +1247,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentPropertyContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentPropertyContainsWords parameter specifies an exception for the DLP rule that's based on a property match in content. The rule is not applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -1142,7 +1258,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1152,6 +1267,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentContainsWords + +> Applicable: Security & Compliance + The ExceptIfDocumentContainsWords parameter specifies an exception for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1162,7 +1280,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1172,13 +1289,15 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill ExceptIfDocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1188,13 +1307,15 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedByMemberOf + +> Applicable: Security & Compliance + {{ Fill ExceptIfDocumentCreatedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1204,6 +1325,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected + +> Applicable: Security & Compliance + The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -1213,7 +1337,6 @@ The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1223,6 +1346,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsUnsupported + +> Applicable: Security & Compliance + The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -1232,7 +1358,6 @@ The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1242,6 +1367,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfDocumentMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -1252,7 +1380,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1262,6 +1389,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1270,7 +1400,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1280,6 +1409,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesWords + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1292,7 +1424,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1302,6 +1433,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentSizeOver + +> Applicable: Security & Compliance + The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -1312,7 +1446,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1320,7 +1454,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1330,6 +1463,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + The ExceptIfFrom parameter specifies an exception for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1338,7 +1474,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1348,6 +1483,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfFromAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1362,7 +1500,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1372,6 +1509,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1382,7 +1522,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1392,6 +1531,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Security & Compliance + The FromMemberOf parameter specifies an exception for the DLP rule that looks for messages sent by group members. You identify the group by its email address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -1400,7 +1542,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1410,6 +1551,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope + +> Applicable: Security & Compliance + The ExceptIfFromScope parameter specifies an exception for the rule that looks for the location of message senders. Valid values are: - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. @@ -1421,7 +1565,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1431,6 +1574,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride + +> Applicable: Security & Compliance + The ExceptIfHasSenderOverride parameter specifies an exception for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: - $true: Look for messages where the sender took action to override a DLP policy. @@ -1442,7 +1588,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1452,6 +1597,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Security & Compliance + The HeaderContainsWords parameter specifies an exception for the DLP rule that looks for words in a header field. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1462,7 +1610,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1472,6 +1619,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1480,7 +1630,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1490,6 +1639,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver + +> Applicable: Security & Compliance + The ExceptIfMessageSizeOver parameter specifies an exception for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. When you enter a value, qualify the value with one of the following units: @@ -1500,7 +1652,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, although small values might be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1508,7 +1660,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1518,6 +1669,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Security & Compliance + The ExceptIfMessageTypeMatches parameter specifies an exception for the rule that looks for messages of the specified type. Valid values are: - ApprovalRequest: Moderation request messages sent to moderators. @@ -1535,7 +1689,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1545,6 +1698,9 @@ Accept wildcard characters: False ``` ### -ExceptIfProcessingLimitExceeded + +> Applicable: Security & Compliance + The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP rule that looks for files where scanning couldn't complete. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -1554,7 +1710,6 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1564,6 +1719,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords + +> Applicable: Security & Compliance + The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: - City @@ -1604,7 +1762,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1614,6 +1771,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -1654,7 +1814,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1664,13 +1823,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1680,6 +1841,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords + +> Applicable: Security & Compliance + The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: - City @@ -1720,7 +1884,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1730,6 +1893,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -1770,7 +1936,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1780,6 +1945,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + The ExceptIfSenderDomainIs parameter specifies an exception for the DLP rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1788,7 +1956,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1798,6 +1965,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIPRanges + +> Applicable: Security & Compliance + The ExceptIfSenderIpRanges parameter specifies an exception for the DLP rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -1810,7 +1980,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1820,6 +1989,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + The ExceptIfSentTo parameter specifies an exception for the DLP rule that looks for recipients in messages. You identify the recipients by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1828,7 +2000,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1838,6 +2009,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Security & Compliance + The ExceptIfSentToMemberOf parameter specifies an exception for the DLP rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1846,7 +2020,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1856,6 +2029,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Security & Compliance + The ExceptIfSubjectContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in the Subject field of messages. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1870,7 +2046,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1880,6 +2055,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1890,7 +2068,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1900,6 +2077,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Security & Compliance + The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the rule that looks for words in the Subject field or body of messages. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1910,7 +2090,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1920,6 +2099,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1928,7 +2110,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1938,6 +2119,9 @@ Accept wildcard characters: False ``` ### -ExceptIfUnscannableDocumentExtensionIs + +> Applicable: Security & Compliance + The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -1946,7 +2130,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1956,6 +2139,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Security & Compliance + The ExceptIfWithImportance parameter specifies an exception for the rule that looks for messages with the specified importance level. Valid values are: - Low @@ -1968,7 +2154,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1978,13 +2163,15 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1994,6 +2181,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + The From parameter specifies a condition for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2002,7 +2192,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2012,6 +2201,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Security & Compliance + The FromAddressContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -2026,7 +2218,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2036,6 +2227,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Security & Compliance + The FromAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -2046,7 +2240,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2056,6 +2249,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Security & Compliance + The FromMemberOf parameter specifies a condition for the DLP rule that looks for messages sent by group members. You identify the group by its email address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -2064,7 +2260,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2074,6 +2269,9 @@ Accept wildcard characters: False ``` ### -FromScope + +> Applicable: Security & Compliance + The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. @@ -2085,7 +2283,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2095,6 +2292,9 @@ Accept wildcard characters: False ``` ### -GenerateAlert + +> Applicable: Security & Compliance + The GenerateAlert parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2108,7 +2308,6 @@ The email message that's generated by this action contains a link to detailed in Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2118,6 +2317,9 @@ Accept wildcard characters: False ``` ### -GenerateIncidentReport + +> Applicable: Security & Compliance + The GenerateIncidentReport parameter specifies an action for the DLP rule that sends an incident report to the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2129,7 +2331,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2139,6 +2340,9 @@ Accept wildcard characters: False ``` ### -HasSenderOverride + +> Applicable: Security & Compliance + The SenderOverride parameter specifies a condition for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: - $true: Look for messages where the sender took action to override a DLP policy. @@ -2150,7 +2354,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2160,6 +2363,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Security & Compliance + The HeaderContainsWords parameter specifies a condition for the DLP rule that looks for words in a header field. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -2170,7 +2376,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2180,6 +2385,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2188,7 +2396,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2198,6 +2405,9 @@ Accept wildcard characters: False ``` ### -IncidentReportContent + +> Applicable: Security & Compliance + The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: - All @@ -2226,7 +2436,6 @@ Therefore, any additional values that you use with the value "Default" are ignor Type: ReportContentOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2236,13 +2445,15 @@ Accept wildcard characters: False ``` ### -MessageIsNotLabeled + +> Applicable: Security & Compliance + {{ Fill MessageIsNotLabeled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2252,6 +2463,9 @@ Accept wildcard characters: False ``` ### -MessageSizeOver + +> Applicable: Security & Compliance + 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. When you enter a value, qualify the value with one of the following units: @@ -2262,7 +2476,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2270,7 +2484,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2280,6 +2493,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Security & Compliance + The MessageTypeMatches parameter specifies a condition for the rule that looks for messages of the specified type. Valid values are: - ApprovalRequest: Moderation request messages sent to moderators. @@ -2297,7 +2513,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2307,13 +2522,15 @@ Accept wildcard characters: False ``` ### -MipRestrictAccess + +> Applicable: Security & Compliance + {{ Fill MipRestrictAccess Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2323,6 +2540,9 @@ Accept wildcard characters: False ``` ### -Moderate + +> Applicable: Security & Compliance + The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = "emailaddress1,emailaddress2,...emailaddressN"}`. You can use this action in DLP policies that are scoped only to Exchange. @@ -2331,7 +2551,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2341,6 +2560,9 @@ Accept wildcard characters: False ``` ### -ModifySubject + +> Applicable: Security & Compliance + The ModifySubject parameter uses regular expressions to find text patterns in the subject of the email message, and then modifies the subject with the text that you specify. This parameter uses the syntax: `@{Patterns="RegEx1","RegEx2",..."RegEx10}"; SubjectText="Replacement Text"; ReplaceStrategy="Value"}`. The `ReplaceStrategy=` property uses one of the following values: @@ -2355,7 +2577,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2365,6 +2586,9 @@ Accept wildcard characters: False ``` ### -NonBifurcatingAccessScope + +> Applicable: Security & Compliance + The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule that looks for recipients in the specified access scope. The rule is applied to all copies of the message. Valid values are: - HasInternal: At least one recipient is inside the organization. @@ -2377,7 +2601,6 @@ You can use this condition in DLP policies that are scoped only to Exchange Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2387,6 +2610,9 @@ Accept wildcard characters: False ``` ### -NotifyAllowOverride + +> Applicable: Security & Compliance + The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - FalsePositive: Allows overrides in the case of false positives. @@ -2400,7 +2626,6 @@ You can specify multiple values separated by commas. The values WithoutJustifica Type: OverrideOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2410,13 +2635,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomSenderDisplayName + +> Applicable: Security & Compliance + {{ Fill NotifyEmailCustomSenderDisplayName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2426,13 +2653,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomSubject + +> Applicable: Security & Compliance + The NotifyEmailCustomSubject parameter specifies the custom text in the subject line of email notification message that's sent to recipients when the conditions of the rule are met. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2442,12 +2671,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomText + +> Applicable: Security & Compliance + The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. This parameter has a 5000 character limit, and supports plain text, HTML tags and the following tokens (variables): - %%AppliedActions%%: The actions applied to the content. -- %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive for Business site. +- %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive site. - %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. - %%BlockedMessageInfo%%: The details of the message that was blocked. Use this token to inform people of the details of the message that was blocked. @@ -2455,7 +2687,6 @@ This parameter has a 5000 character limit, and supports plain text, HTML tags an Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2465,13 +2696,33 @@ Accept wildcard characters: False ``` ### -NotifyEmailExchangeIncludeAttachment + +> Applicable: Security & Compliance + {{ Fill NotifyEmailExchangeIncludeAttachment Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailOnedriveRemediationActions + +> Applicable: Security & Compliance + +{{ Fill NotifyEmailOnedriveRemediationActions Description }} + +```yaml +Type: NotifyEmailRemediationActions +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -2481,6 +2732,9 @@ Accept wildcard characters: False ``` ### -NotifyEndpointUser + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. {{ Fill NotifyEndpointUser Description }} @@ -2491,7 +2745,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2501,13 +2754,15 @@ Accept wildcard characters: False ``` ### -NotifyOverrideRequirements + +> Applicable: Security & Compliance + {{ Fill NotifyOverrideRequirements Description }} ```yaml Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2517,13 +2772,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomDialog + +> Applicable: Security & Compliance + {{ Fill NotifyPolicyTipCustomDialog Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2533,13 +2790,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomText + +> Applicable: Security & Compliance + The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2549,6 +2808,9 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomTextTranslations + +> Applicable: Security & Compliance + The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax `CultureCode:Text`. Valid culture codes are supported values from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -2559,7 +2821,6 @@ To enter multiple values and overwrite any existing entries, use the following s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2569,16 +2830,18 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipDisplayOption + +> Applicable: Security & Compliance + The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: -- Tip: Displays policy tip at the top of the mail. This is the default value. +- Tip: Displays policy tip at the top of the mail. This value is the default. - Dialog: Displays policy tip at the top of the mail and as a popup dialog. (exchange only) ```yaml Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2588,13 +2851,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipUrl + +> Applicable: Security & Compliance + The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2604,6 +2869,9 @@ Accept wildcard characters: False ``` ### -NotifyUser + +> Applicable: Security & Compliance + The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2617,7 +2885,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2627,6 +2894,9 @@ Accept wildcard characters: False ``` ### -NotifyUserType + +> Applicable: Security & Compliance + The NotifyUserType parameter specifies the type of notification that's used for the rule. Valid values are: - NotSet @@ -2638,7 +2908,6 @@ The NotifyUserType parameter specifies the type of notification that's used for Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.NotifyUserType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2648,13 +2917,15 @@ Accept wildcard characters: False ``` ### -OnPremisesScannerDlpRestrictions + +> Applicable: Security & Compliance + {{ Fill OnPremisesScannerDlpRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2664,6 +2935,9 @@ Accept wildcard characters: False ``` ### -PrependSubject + +> Applicable: Security & Compliance + The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you specify. If the text contains spaces, enclose the value in quotation marks ("). Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. @@ -2674,7 +2948,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2684,6 +2957,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: @@ -2698,7 +2974,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2708,6 +2983,9 @@ Accept wildcard characters: False ``` ### -ProcessingLimitExceeded + +> Applicable: Security & Compliance + The ProcessingLimitExceeded parameter specifies a condition for the DLP rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -2717,7 +2995,6 @@ The ProcessingLimitExceeded parameter specifies a condition for the DLP rule tha Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2727,6 +3004,9 @@ Accept wildcard characters: False ``` ### -Quarantine + +> Applicable: Security & Compliance + This parameter specifies an action or part of an action for the rule. The Quarantine parameter specifies an action that quarantines messages. Valid values are: @@ -2738,7 +3018,6 @@ The Quarantine parameter specifies an action that quarantines messages. Valid va Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2748,6 +3027,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeContainsWords + +> Applicable: Security & Compliance + The RecipientADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: - City @@ -2788,7 +3070,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2798,6 +3079,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The RecipientADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -2838,7 +3122,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2847,14 +3130,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RecipientCountOver + +> Applicable: Security & Compliance + +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: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecipientDomainIs + +> Applicable: Security & Compliance + The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2864,6 +3168,9 @@ Accept wildcard characters: False ``` ### -RedirectMessageTo + +> Applicable: Security & Compliance + The RedirectMessageTo parameter specifies an action for the DLP rule that redirects the message to the specified email address. You can specify multiple values separated by commas. You can use this action in DLP policies that are scoped only to Exchange. @@ -2872,7 +3179,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2882,6 +3188,9 @@ Accept wildcard characters: False ``` ### -RemoveHeader + +> Applicable: Security & Compliance + The RemoveHeader parameter specifies an action for the DLP rule that removes a header field from the message header. This parameter uses the syntax `HeaderName` or `"HeaderName:HeaderValue"`.You can specify multiple header names or header name and value pairs separated by commas: `HeaderName1,"HeaderName2:HeaderValue2",HeaderName3,..."HeaderNameN:HeaderValueN"`. The maximum header name length is 64 characters, and header names can't contain spaces or colons ( : ). The maximum header value length is 128 characters. @@ -2892,7 +3201,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2902,6 +3210,9 @@ Accept wildcard characters: False ``` ### -RemoveRMSTemplate + +> Applicable: Security & Compliance + The RemoveRMSTemplate parameter specifies an action for the DLP rule that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: - $true: The message and attachments are decrypted. @@ -2913,7 +3224,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2923,10 +3233,13 @@ Accept wildcard characters: False ``` ### -ReportSeverityLevel + +> Applicable: Security & Compliance + The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: - None: You can't select this value if the rule has no actions configured. -- Low: This is the default value. +- Low: This value is the default. - Medium - High @@ -2934,7 +3247,6 @@ The ReportSeverityLevel parameter specifies the severity level of the incident r Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2944,13 +3256,15 @@ Accept wildcard characters: False ``` ### -RestrictAccess + +> Applicable: Security & Compliance + {{ Fill RestrictAccess Description }} ```yaml Type: System.Collections.Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2960,13 +3274,15 @@ Accept wildcard characters: False ``` ### -RestrictBrowserAccess + +> Applicable: Security & Compliance + {{ Fill RestrictBrowserAccess Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2976,17 +3292,19 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Security & Compliance + The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - Ignore: Ignore the failure of the rule and thereby any actions in that rule and move to the next rule. - RetryThenBlock: Do a maximum of 5 retries of the rule with an increasing time gap of 10 min (i.e, 1st retry happens after 10 min, 2nd retry after 20 min, etc.). After the failure of the fifth retry, the message is dropped and we send a non-delivery report (also known as an NDR or bounce messages). -- Blank (the value $null): Defer the delivery of the message and keep retrying the rule. This is the default value. +- Blank (the value $null): Defer the delivery of the message and keep retrying the rule. This value is the default. ```yaml Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2996,6 +3314,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeContainsWords + +> Applicable: Security & Compliance + The SenderADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: - City @@ -3036,7 +3357,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3046,6 +3366,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -3086,7 +3409,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3096,13 +3418,16 @@ Accept wildcard characters: False ``` ### -SenderAddressLocation + +> Applicable: Security & Compliance + The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: -- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. +- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This value is the default. - Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). - HeaderOrEnvelope: Examine senders in the message header and the message envelope. -Note that message envelope searching is available only for the following conditions and exceptions: +Message envelope searching is available only for the following conditions and exceptions: - From and ExceptIfFrom - FromAddressContainsWords and ExceptIfFromAddressContainsWords @@ -3114,7 +3439,6 @@ Note that message envelope searching is available only for the following conditi Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicySenderAddressLocation Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3124,6 +3448,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Security & Compliance + The SenderDomainIs parameter specifies a condition for the DLP rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3132,7 +3459,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3142,6 +3468,9 @@ Accept wildcard characters: False ``` ### -SenderIPRanges + +> Applicable: Security & Compliance + The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -3154,7 +3483,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3164,6 +3492,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + The SentTo parameter specifies a condition for the DLP rule that looks for recipients in messages. You identify the recipients by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3172,7 +3503,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3182,6 +3512,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Security & Compliance + The SentToMemberOf parameter specifies a condition for the DLP rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3190,7 +3523,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3200,6 +3532,9 @@ Accept wildcard characters: False ``` ### -SetHeader + +> Applicable: Security & Compliance + The SetHeader parameter specifies an action for the DLP rule that adds or modifies a header field and value in the message header. This parameter uses the syntax `"HeaderName:HeaderValue"`. You can specify multiple header name and value pairs separated by commas: `"HeaderName1:HeaderValue1",HeaderName2:HeaderValue2",..."HeaderNameN:HeaderValueN"`. The maximum header name length is 64 characters, and header names can't contains spaces or colons ( : ). The maximum header value length is 128 characters. @@ -3210,7 +3545,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3220,13 +3554,21 @@ Accept wildcard characters: False ``` ### -SharedByIRMUserRisk -{{ Fill SharedByIRMUserRisk Description }} + +> Applicable: Security & Compliance + +The SharedByIRMUserRisk parameter specifies the risk category of the user performing the violating action. Valid values are: + +- FCB9FA93-6269-4ACF-A756-832E79B36A2A (Elevated Risk Level) +- 797C4446-5C73-484F-8E58-0CCA08D6DF6C (Moderate Risk Level) +- 75A4318B-94A2-4323-BA42-2CA6DB29AAFE (Minor Risk Level) + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: All Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3236,6 +3578,9 @@ Accept wildcard characters: False ``` ### -StopPolicyProcessing + +> Applicable: Security & Compliance + The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: - $true: Stop processing more rules. @@ -3245,7 +3590,6 @@ The StopPolicyProcessing parameter specifies an action that stops processing mor Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3255,6 +3599,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Security & Compliance + The SubjectContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in the Subject field of messages. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -3269,7 +3616,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3279,6 +3625,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Security & Compliance + The SubjectMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -3289,7 +3638,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3299,6 +3647,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Security & Compliance + The SubjectOrBodyContainsWords parameter specifies a condition for the rule that looks for words in the Subject field or body of messages. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -3309,7 +3660,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3319,6 +3669,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyMatchesPatterns + +> Applicable: Security & Compliance + The SubjectOrBodyMatchesPatterns parameter specifies a condition for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3327,7 +3680,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3337,13 +3689,15 @@ Accept wildcard characters: False ``` ### -ThirdPartyAppDlpRestrictions + +> Applicable: Security & Compliance + {{ Fill ThirdPartyAppDlpRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3353,13 +3707,15 @@ Accept wildcard characters: False ``` ### -TriggerPowerAutomateFlow + +> Applicable: Security & Compliance + {{ Fill TriggerPowerAutomateFlow Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3369,6 +3725,9 @@ Accept wildcard characters: False ``` ### -UnscannableDocumentExtensionIs + +> Applicable: Security & Compliance + The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -3377,7 +3736,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3387,13 +3745,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -3403,6 +3763,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Security & Compliance + The WithImportance parameter specifies a condition for the rule that looks for messages with the specified importance level. Valid values are: - Low @@ -3415,7 +3778,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpEdmSchema.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-DlpEdmSchema.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpEdmSchema.md index be8d02a43c..29d9c6a526 100644 --- a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpEdmSchema.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpedmschema applicable: Security & Compliance -title: Set-DlpEdmSchema -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpedmschema +schema: 2.0.0 +title: Set-DlpEdmSchema --- # Set-DlpEdmSchema @@ -44,6 +45,9 @@ This example modifies a DLP EDM schema using the edm.xml file in the C:\\My Docu ## PARAMETERS ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the DLP EDM schema that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -52,7 +56,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpKeywordDictionary.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpKeywordDictionary.md index aa9f4a5616..252eb72c74 100644 --- a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpKeywordDictionary.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpkeyworddictionary applicable: Security & Compliance -title: Set-DlpKeywordDictionary -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpkeyworddictionary +schema: 2.0.0 +title: Set-DlpKeywordDictionary --- # Set-DlpKeywordDictionary @@ -107,13 +108,15 @@ After you use Notepad to modify the terms and save the file, the last four comma ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the DLP keyword dictionary that you want to modify. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: SensitiveInformationTypeIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -123,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -132,7 +138,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -142,13 +147,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies descriptive text for the DLP keyword dictionary. 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 @@ -158,13 +165,15 @@ Accept wildcard characters: False ``` ### -DoNotPersistKeywords + +> Applicable: Security & Compliance + {{ Fill DoNotPersistKeywords Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -174,6 +183,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF-16. For more information, see the examples in this topic. The maximum file size is up to 1 MB of terms after compression. The organization limit for all dictionaries is also 1 MB after compression. @@ -182,7 +194,6 @@ The maximum file size is up to 1 MB of terms after compression. The organization Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -192,13 +203,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the DLP keyword dictionary. 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 @@ -208,13 +221,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-DlpPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpPolicy.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-DlpPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpPolicy.md index 74002da4a2..40a9e4886b 100644 --- a/exchange/exchange-ps/exchange/Set-DlpPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlppolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-DlpPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlppolicy +schema: 2.0.0 +title: Set-DlpPolicy --- # Set-DlpPolicy ## SYNOPSIS -**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. +**Note**: This cmdlet is 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. This cmdlet is functional only in on-premises Exchange. @@ -35,7 +36,7 @@ Set-DlpPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example disables the DLP policy named Employee Numbers. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the DLP policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the DLP policy that you want to modify. You can Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Description parameter specifies an optional description for the DLP policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mode parameter specifies the action and notification level of the DLP policy. Valid values for this parameter are: - Audit: When a message matches the conditions specified by the DLP policy, the actions specified by the policy aren't enforced and no notification emails are sent. @@ -132,7 +144,6 @@ If the State parameter is set to Disabled, the value of the Mode parameter is ir Type: RuleMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a unique name for the DLP policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -158,13 +171,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The State parameter enables or disables the DLP policy. Valid input for this parameter is Enabled or Disabled. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationType.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationType.md index e6a09ab1b6..7b6975cbdd 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationType.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype applicable: Security & Compliance -title: Set-DlpSensitiveInformationType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpsensitiveinformationtype +schema: 2.0.0 +title: Set-DlpSensitiveInformationType --- # Set-DlpSensitiveInformationType ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-DlpSensitiveInformationType cmdlet to modify sensitive information type rules that use document fingerprints. @@ -38,7 +39,7 @@ Set-DlpSensitiveInformationType [-Identity] Applicable: Security & Compliance + The Identity parameter specifies the sensitive information type rule that you want to modify. You can use any value that uniquely identifies the sensitive information type rule. For example: - Name @@ -103,7 +107,6 @@ The Identity parameter specifies the sensitive information type rule that you wa Type: SensitiveInformationTypeIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -124,7 +130,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -134,13 +139,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the sensitive information type rule. You use the Description parameter with the Locale and Name parameters to specify descriptions for the sensitive information type rule in different languages. The localized values of Description appear in the AllLocalizedDescriptions property of the sensitive information type rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -150,13 +157,15 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Security & Compliance + {{ Fill FileData Description }} ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -166,13 +175,15 @@ Accept wildcard characters: False ``` ### -Fingerprints -The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the sensitive information type rule. For instructions on how to import documents to use as templates for fingerprints, see [New-DlpFingerprint](https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing sensitive information type rule, see the Examples section. + +> Applicable: Security & Compliance + +The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the sensitive information type rule. For instructions on how to import documents to use as templates for fingerprints, see [New-DlpFingerprint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpfingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing sensitive information type rule, see the Examples section. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -182,13 +193,15 @@ Accept wildcard characters: False ``` ### -IsExact + +> Applicable: Security & Compliance + {{ Fill IsExact Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Security & Compliance + The Locale parameter adds or removes languages that are associated with the sensitive information type rule. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -208,7 +224,6 @@ Typically, you use the Locale parameter with the Name and Description parameters Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -218,6 +233,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a name for the sensitive information type rule. The value must be less than 256 characters. You use the Name parameter with the Locale and Description parameters to specify names for the sensitive information type rule in different languages. The localized values of Name appear in the AllLocalizedNames property of the sensitive information type rule. @@ -228,7 +246,6 @@ The value of the Name parameter is used in the Policy Tip that's presented to us Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -238,13 +255,15 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: Security & Compliance + {{ Fill Threshold Description }} ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -254,13 +273,15 @@ Accept wildcard characters: False ``` ### -ThresholdConfig + +> Applicable: Security & Compliance + {{ Fill ThresholdConfig Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -270,13 +291,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationTypeRulePackage.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationTypeRulePackage.md index 944203816e..83ed95ed5b 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationTypeRulePackage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtyperulepackage applicable: Security & Compliance -title: Set-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpsensitiveinformationtyperulepackage +schema: 2.0.0 +title: Set-DlpSensitiveInformationTypeRulePackage --- # Set-DlpSensitiveInformationTypeRulePackage @@ -44,6 +45,9 @@ This example imports the sensitive information type rule package C:\\My Document ## PARAMETERS ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the sensitive information type rule package that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -52,7 +56,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Set-DynamicDistributionGroup.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DynamicDistributionGroup.md index 4b26f36939..436da59675 100644 --- a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DynamicDistributionGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dynamicdistributiongroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-DynamicDistributionGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dynamicdistributiongroup +schema: 2.0.0 +title: Set-DynamicDistributionGroup --- # Set-DynamicDistributionGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-DynamicDistributionGroup cmdlet to modify existing dynamic distribution groups. @@ -122,7 +123,7 @@ To create flexible filters that use any available recipient property and that ar You can't use this cmdlet to replace a precanned filter with a custom OPATH filter, or vice-versa. You can only modify the existing filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -151,6 +152,9 @@ This example applies the following changes to the existing dynamic distribution ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the dynamic distribution group that you want to modify. You can use any value that uniquely identifies the dynamic distribution group. For example: - Name @@ -164,7 +168,6 @@ The Identity parameter specifies the dynamic distribution group that you want to Type: DynamicGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -174,6 +177,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -197,7 +203,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -207,6 +212,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -230,7 +238,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -240,6 +247,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -265,7 +275,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,6 +284,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -299,7 +311,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -309,6 +320,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -328,7 +342,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -338,6 +351,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -359,7 +375,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -369,6 +384,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -381,7 +399,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -391,6 +408,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -403,7 +423,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -413,6 +432,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -425,7 +447,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -435,6 +456,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -447,7 +471,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -457,6 +480,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -469,7 +495,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -479,6 +504,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -491,7 +519,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -501,6 +528,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -513,7 +543,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -523,6 +552,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -535,7 +567,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -545,6 +576,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -557,7 +591,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -567,6 +600,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -579,7 +615,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -589,6 +624,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -601,7 +639,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -611,6 +648,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -623,7 +663,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -633,6 +672,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -645,7 +687,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -655,6 +696,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -667,7 +711,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -677,6 +720,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -689,7 +735,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -699,6 +744,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -711,7 +759,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -721,6 +768,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -733,7 +783,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -743,6 +792,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -755,7 +807,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -765,6 +816,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -774,7 +828,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -784,18 +837,20 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: -- $true: A DTMF map is created for the recipient. This is the default value. +- $true: A DTMF map is created for the recipient. This value is the default. - $false: A DTMF map isn't created for the recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -805,13 +860,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -821,13 +878,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -837,13 +896,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -853,13 +914,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -869,13 +932,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -885,13 +950,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -901,13 +968,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -917,13 +986,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -933,13 +1004,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -949,13 +1022,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -965,13 +1040,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -981,13 +1058,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -997,13 +1076,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1013,13 +1094,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1029,13 +1112,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1045,6 +1130,9 @@ Accept wildcard characters: False ``` ### -DirectMembershipOnly + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1053,7 +1141,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1063,13 +1150,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the dynamic distribution group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1079,6 +1168,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -1087,7 +1179,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1097,6 +1188,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -1124,7 +1218,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1134,18 +1227,20 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: -- $true: Email address policies are applied to this recipient. This is the default value. +- $true: Email address policies are applied to this recipient. This value is the default. - $false: Email address policies aren't applied to this recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1155,6 +1250,9 @@ Accept wildcard characters: False ``` ### -ExpansionServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ExpansionServer parameter specifies the Exchange server that's used to expand the distribution group. The default value is blank ($null), which means expansion happens on the closest available Exchange server. If you specify an expansion server, and that server is unavailable, any messages that are sent to the distribution group can't be delivered. @@ -1170,7 +1268,6 @@ When you specify an expansion server, use the ExchangeLegacyDN. You can find thi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1180,19 +1277,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1202,19 +1301,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1224,19 +1325,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1246,19 +1349,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1268,19 +1373,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1290,6 +1397,9 @@ Accept wildcard characters: False ``` ### -ForceMembershipRefresh + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill ForceMembershipRefresh Description }} @@ -1298,7 +1408,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1308,13 +1417,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1324,6 +1435,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this dynamic distribution group. Although messages send on behalf of the group clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the group, not the sender. The sender you specify for this parameter must 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 sender. For example: @@ -1349,7 +1463,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1359,16 +1472,18 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. -- $false: The recipient is visible in address lists. This is the default value. +- $false: The recipient is visible in address lists. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1378,6 +1493,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -1391,7 +1509,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1401,6 +1518,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -1416,7 +1536,6 @@ You can specify multiple values separated by commas. When you use multiple value Type: WellKnownRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1426,6 +1545,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -1437,7 +1559,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1447,6 +1568,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -1461,7 +1585,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1471,6 +1594,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies an owner for the group. A dynamic group can only have one owner. The group owner is able to: - Modify the properties of the group @@ -1494,7 +1620,6 @@ The owner you specify for this parameter must be a mailbox, mail user or mail-en Type: GeneralRecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1504,6 +1629,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxReceiveSize parameter specifies the maximum allowed email message size that can be sent to this group. @@ -1515,7 +1643,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -1525,7 +1653,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1535,6 +1662,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxSendSize parameter specifies the maximum allowed email message size that can be sent from this group. @@ -1546,7 +1676,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -1556,7 +1686,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1566,6 +1695,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1585,7 +1717,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1595,10 +1726,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -1606,7 +1740,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1616,13 +1749,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the dynamic distribution group. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1632,13 +1767,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1648,13 +1785,15 @@ Accept wildcard characters: False ``` ### -PhoneticDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1664,6 +1803,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the group are no longer automatically updated by email address policies. @@ -1674,7 +1816,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1684,6 +1825,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -1693,13 +1837,12 @@ The RecipientContainer parameter specifies a filter that's based on the recipien If you don't use this parameter, the default value is the OU where the object was created. -Note that the RecipientContainer property can't be blank. The group is always limited to looking for recipients in a specific location (the value you specify for this parameter, or the location where the group was created). +The RecipientContainer property can't be blank. The group is always limited to looking for recipients in a specific location (the value you specify for this parameter, or the location where the group was created). ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1709,6 +1852,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -1724,7 +1870,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1734,6 +1879,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1757,7 +1905,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1767,6 +1914,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1790,7 +1940,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1800,6 +1949,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1825,7 +1977,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1835,10 +1986,13 @@ Accept wildcard characters: False ``` ### -ReportToManagerEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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: - $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. +- $false: Delivery status notifications aren't sent to the owners of the group. This value is the default. 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. @@ -1846,7 +2000,6 @@ The ReportToManagerEnabled and ReportToOriginatorEnabled parameters affect the r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1856,9 +2009,12 @@ Accept wildcard characters: False ``` ### -ReportToOriginatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ReportToOriginatorEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to senders who send messages to this group. Valid values are: -- $true: Delivery status notifications are sent to the message senders. This is the default value. +- $true: Delivery status notifications are sent to the message senders. This value is the default. - $false: Delivery status notifications aren't sent to the message senders. 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. @@ -1867,7 +2023,6 @@ The ReportToManagerEnabled and ReportToOriginatorEnabled parameters affect the r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1877,6 +2032,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1886,7 +2044,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1896,9 +2053,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -1908,7 +2068,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1918,16 +2077,18 @@ Accept wildcard characters: False ``` ### -SendOofMessageToOriginatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SendOofMessageToOriginatorEnabled parameter specifies how to handle out of office (OOF) messages for members of the group. Valid values are: -- $true: When messages are sent to the group, OOF messages for any of the group members are sent to the message sender. This is the default value. +- $true: When messages are sent to the group, OOF messages for any of the group members are sent to the message sender. This value is the default. - $false: When messages are sent to the group, OOF messages for any of the group members aren't sent to the message sender. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1937,6 +2098,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -1949,7 +2113,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1959,6 +2122,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -1979,7 +2145,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1989,6 +2154,9 @@ Accept wildcard characters: False ``` ### -UpdateMemberCount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill UpdateMemberCount Description }} @@ -1997,7 +2165,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2007,13 +2174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2023,6 +2192,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -2034,7 +2206,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-EOPProtectionPolicyRule.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EOPProtectionPolicyRule.md index 2f487200f3..158f4efa73 100644 --- a/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: Set-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-eopprotectionpolicyrule +schema: 2.0.0 +title: Set-EOPProtectionPolicyRule --- # Set-EOPProtectionPolicyRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-EOPProtectionPolicyRule cmdlet to modify rules that are associated with Exchange Online Protection (EOP) protections in preset security policies. +Use the Set-EOPProtectionPolicyRule cmdlet to modify rules associated with default email protections for all cloud mailboxes in preset security policies. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -42,7 +43,7 @@ For more information about preset security policies in PowerShell, see [Preset s > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,6 +64,9 @@ This example removes all conditions and exceptions from the Standard preset secu ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -75,7 +79,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -110,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -151,7 +163,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -178,7 +192,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. We highly recommend that you use the default rule names for clarity and consistency. @@ -196,7 +212,6 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -206,6 +221,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. @@ -216,7 +234,6 @@ You must use the default value for the rule. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,13 +243,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -242,6 +261,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -257,7 +279,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -267,6 +288,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -284,7 +308,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -294,13 +317,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-EcpVirtualDirectory.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EcpVirtualDirectory.md index 3383449510..7ef6fa85ed 100644 --- a/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EcpVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ecpvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-EcpVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ecpvirtualdirectory +schema: 2.0.0 +title: Set-EcpVirtualDirectory --- # Set-EcpVirtualDirectory @@ -46,7 +47,7 @@ Set-EcpVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example turns off the Internet access to the EAC on server named Server01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the ECP virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -81,7 +85,6 @@ To manage the first ECP virtual directory created in an Exchange organization, y Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -AdfsAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AdfsAuthentication parameter specifies that the ECP virtual directory allows users to authenticate through Active Directory Federation Services (AD FS) authentication. This parameter accepts $true or $false. The default value is $false. The ADFS authentication settings for Set-OwaVirtualDirectory and Set-EcpVirtualDirectory are related. You need to set the AdfsAuthentication parameter on Set-EcpVirtualDirectory to $true before you can set the AdfsAuthentication parameter on Set-OwaVirtualDirectory to $true. Likewise, you need to set the AdfsAuthentication parameter on Set-OwaVirtualDirectory to $false before you can set the AdfsAuthentication parameter on Set-EcpVirtualDirectory to $false. @@ -99,7 +105,6 @@ The ADFS authentication settings for Set-OwaVirtualDirectory and Set-EcpVirtualD Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -AdminEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AdminEnabled parameter specifies that the EAC isn't able to be accessed through the Internet. For more information, see [Turn off access to the Exchange admin center](https://learn.microsoft.com/Exchange/architecture/client-access/disable-exchange-admin-center-access). This parameter accepts $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,9 +132,12 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: -- $true: Basic authentication is enabled. This is the default value. +- $true: Basic authentication is enabled. This value is the default. - $false: Basic authentication is disabled. This parameter can be used with the FormsAuthentication parameter or with the DigestAuthentication and WindowsAuthentication parameters. @@ -136,7 +146,6 @@ This parameter can be used with the FormsAuthentication parameter or with the Di Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -155,7 +167,6 @@ 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 Required: False Position: Named @@ -165,16 +176,18 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. -- $false: Digest authentication is disabled. This is the default value. +- $false: Digest authentication is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,13 +197,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,19 +215,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,16 +239,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,10 +260,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -253,7 +275,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,13 +284,15 @@ Accept wildcard characters: False ``` ### -ExternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalAuthenticationMethods parameter specifies the authentication methods supported on the Exchange server from outside the firewall. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -279,6 +302,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used. You need to set this parameter to allow the Autodiscover service to return the URL for the ECP virtual directory. @@ -287,7 +313,6 @@ This setting is also important when Secure Sockets Layer (SSL) is used. You need Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,6 +322,9 @@ Accept wildcard characters: False ``` ### -FormsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FormsAuthentication parameter specifies whether forms-based authentication is enabled on the ECP virtual directory. Valid values are: - $true: Forms authentication is enabled. The BasicAuthentication parameter is set to $true, and the DigestAuthentication and WindowsAuthentication parameters are set to $false. @@ -306,7 +334,6 @@ The FormsAuthentication parameter specifies whether forms-based authentication i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,13 +343,15 @@ Accept wildcard characters: False ``` ### -GzipLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GzipLevel parameter sets Gzip configuration information for the ECP virtual directory. ```yaml Type: GzipLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,6 +361,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is also important when SSL is used. You need to set this parameter to allow the Autodiscover service to return the URL for the ECP virtual directory. @@ -340,7 +372,6 @@ This setting is also important when SSL is used. You need to set this parameter Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -350,13 +381,15 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2019, Exchange Server SE + {{ Fill OAuthAuthentication Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -366,13 +399,15 @@ 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. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 might want to disable access if your organization uses non-Microsoft provider tools. This parameter accepts $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -382,13 +417,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -398,16 +435,18 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: -- $true: Integrated Windows authentication is enabled. This is the default value. +- $true: Integrated Windows authentication is enabled. This value is the default. - $false: Integrated Windows authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-EdgeSyncServiceConfig.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EdgeSyncServiceConfig.md index e63e09bc66..12e35df0ce 100644 --- a/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EdgeSyncServiceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-edgesyncserviceconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-EdgeSyncServiceConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-edgesyncserviceconfig +schema: 2.0.0 +title: Set-EdgeSyncServiceConfig --- # Set-EdgeSyncServiceConfig @@ -43,7 +44,7 @@ Set-EdgeSyncServiceConfig [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,13 +66,15 @@ The log files are kept for 3 days. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the Microsoft Exchange EdgeSync service you want to configure. ```yaml Type: EdgeSyncServiceConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -ConfigurationSyncInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigurationSyncInterval parameter specifies how frequently the Microsoft Exchange EdgeSync service synchronizes configuration data. The default value is 3 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. @@ -89,7 +95,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -108,7 +116,6 @@ 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 Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -CookieValidDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CookieValidDuration parameter specifies how long a cookie record is valid. The default value is 21 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -126,7 +136,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -FailoverDCInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FailoverDCInterval parameter specifies how long EdgeSync waits before failing over to another domain controller if it can't read configuration data from Active Directory. 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. @@ -160,7 +174,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,6 +183,9 @@ Accept wildcard characters: False ``` ### -LockDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LockDuration parameter specifies how long an instance of the Microsoft Exchange EdgeSync service can maintain an exclusive lock on the synchronization rights. While an EdgeSync service maintains an exclusive lock on synchronization rights, no other EdgeSync service can take over synchronization. The default value is 6 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. @@ -178,7 +194,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +203,9 @@ Accept wildcard characters: False ``` ### -LockRenewalDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LockRenewalDuration parameter specifies how long before the expiry of an exclusive lock an EdgeSync service can renew the lock. The default value is 4 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. @@ -196,7 +214,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +223,15 @@ Accept wildcard characters: False ``` ### -LogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogEnabled parameter specifies enables or disables the EdgeSyncLog. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,9 +241,12 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogLevel parameter specifies the EdgeSync logging level. Valid values are: -- None (This is the default value) +- None (default value) - Low - Medium - High @@ -233,7 +255,6 @@ The LogLevel parameter specifies the EdgeSync logging level. Valid values are: Type: EdgeSyncLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,6 +264,9 @@ Accept wildcard characters: False ``` ### -LogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogMaxAge parameter specifies the maximum duration in days to keep the EdgeSyncLog files. Log files older than the specified value can be overwritten. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -251,7 +275,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,6 +284,9 @@ Accept wildcard characters: False ``` ### -LogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogMaxDirectorySize specifies the maximum amount of disk space the EdgeSyncLog directory can use. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -271,7 +297,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the LogMaxFileSize parameter must be less than or equal to the value of the LogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the EdgeSyncLog directory. @@ -279,7 +305,6 @@ The value of the LogMaxFileSize parameter must be less than or equal to the valu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,6 +314,9 @@ Accept wildcard characters: False ``` ### -LogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogMaxFileSize parameter specifies the maximum log file size for the EdgeSyncLog files. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -299,7 +327,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the LogMaxFileSize parameter must be less than or equal to the value of the LogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the EdgeSyncLog files. @@ -307,7 +335,6 @@ The value of the LogMaxFileSize parameter must be less than or equal to the valu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,13 +344,15 @@ Accept wildcard characters: False ``` ### -LogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogPath parameter specifies the disk location to store the EdgeSyncLog files. The default value is TransportRoles\\Logs\\EdgeSync\\. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -333,13 +362,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a unique name for the EdgeSync service configuration. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -349,6 +380,9 @@ Accept wildcard characters: False ``` ### -OptionDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OptionDuration parameter specifies how long an instance of the Microsoft Exchange EdgeSync service can maintain an optional lock on the synchronization rights. While an EdgeSync service maintains an optional lock on synchronization rights, another EdgeSync service can take over synchronization after the optional lock has expired if it's initiated using the Start-EdgeSynchronization command. The default value is 30 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. @@ -357,7 +391,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -367,6 +400,9 @@ Accept wildcard characters: False ``` ### -RecipientSyncInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecipientSyncInterval parameter specifies how frequently the Microsoft Exchange EdgeSync service synchronizes recipient data from the global catalog. 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. @@ -375,7 +411,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -385,13 +420,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-EmailAddressPolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EmailAddressPolicy.md index 3d157d6042..0e369a50c4 100644 --- a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EmailAddressPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-emailaddresspolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-EmailAddressPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-emailaddresspolicy +schema: 2.0.0 +title: Set-EmailAddressPolicy --- # Set-EmailAddressPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-EmailAddressPolicy cmdlet to modify email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups. @@ -68,7 +69,7 @@ To create flexible filters that use any available recipient property and that ar You can't use this cmdlet to replace a precanned filter with a custom OPATH filter, or vice-versa. You can only modify the existing filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -96,6 +97,9 @@ In Exchange Online, this example modifies the existing email address policy name ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the email address policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -106,7 +110,6 @@ The Identity parameter specifies the email address policy that you want to modif Type: EmailAddressPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -116,6 +119,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. @@ -130,7 +136,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,6 +145,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. @@ -154,7 +162,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,6 +171,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. @@ -178,7 +188,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +197,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. @@ -202,7 +214,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +223,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. @@ -226,7 +240,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +249,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. @@ -250,7 +266,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,6 +275,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. @@ -274,7 +292,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,6 +301,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. @@ -298,7 +318,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -308,6 +327,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. @@ -322,7 +344,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,6 +353,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. @@ -346,7 +370,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,6 +379,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. @@ -370,7 +396,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -380,6 +405,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. @@ -394,7 +422,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -404,6 +431,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. @@ -418,7 +448,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -428,6 +457,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. @@ -442,7 +474,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -452,6 +483,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. @@ -466,7 +500,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -476,6 +509,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. @@ -490,7 +526,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -500,6 +535,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. @@ -514,7 +552,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -524,6 +561,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. @@ -538,7 +578,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -548,6 +587,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -557,7 +599,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -567,13 +608,16 @@ Accept wildcard characters: False ``` ### -DisabledEmailAddressTemplates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DisabledEmailAddressTemplates parameter specifies the proxy email addresses templates that are included in an email address policy, but aren't used to configure the email addresses of recipients. Valid syntax for this parameter is `Type:AddressFormat`: -- Type: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. +- Type: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. You can't use SMTP to specify a disabled primary SMTP email address. - AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. You can specify multiple disabled email address templates separated by commas: `"[Type1:]EmailAddress1","[Type2:]EmailAddress2",..."[TypeN:]EmailAddressN"`. @@ -584,7 +628,6 @@ Typically, this property is only populated by values after a migration from a pr Type: ProxyAddressTemplateCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -594,6 +637,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -602,7 +648,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -612,6 +657,9 @@ Accept wildcard characters: False ``` ### -EnabledEmailAddressTemplates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EnabledEmailAddressTemplates parameter specifies the rules in the email address policy that are used to generate email addresses for recipients. Valid syntax for this parameter is `Type:AddressFormat`: @@ -631,7 +679,6 @@ In Exchange Online PowerShell, if you use this parameter with the IncludeUnified Type: ProxyAddressTemplateCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -641,6 +688,9 @@ Accept wildcard characters: False ``` ### -EnabledPrimarySMTPAddressTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EnabledPrimarySMTPAddressTemplate parameter specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. @@ -653,7 +703,6 @@ In Exchange Online PowerShell, if you use this parameter with the IncludeUnified Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -663,13 +712,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -679,6 +730,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: @@ -696,7 +750,6 @@ You can specify multiple values separated by commas. When you use multiple value Type: WellKnownRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -706,13 +759,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name for the email address policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -722,6 +777,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Priority parameter specifies the order that the email address policies are evaluated. By default, every time that you add a new email address policy, the policy is assigned a priority of N+1, where N is the number of email address policies that you've created. If you set this parameter to a value that's the same as another email address policy, the priority of the policy that you added first is incremented by 1. @@ -732,7 +790,6 @@ If you set this parameter to a value that's the same as another email address po Type: EmailAddressPolicyPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -742,6 +799,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -757,7 +817,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -767,6 +826,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. @@ -783,7 +845,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -793,13 +854,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-EmailTenantSettings.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-EmailTenantSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EmailTenantSettings.md index 795f69bb1f..efcc915182 100644 --- a/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EmailTenantSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-emailtenantsettings applicable: Exchange Online -title: Set-EmailTenantSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-emailtenantsettings +schema: 2.0.0 +title: Set-EmailTenantSettings --- # Set-EmailTenantSettings @@ -31,7 +32,7 @@ Set-EmailTenantSettings [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example enables priority account protection in the organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the settings object that you want to modify. The only settings object in the organization is named Default. ```yaml Type: EmailTenantSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -EnablePriorityAccountProtection + +> Applicable: Exchange Online + The EnablePriorityAccountProtection parameter enables or disable priority account protection in the organization. Valid values are: - $true: Priority account protection is enabled. @@ -105,7 +115,6 @@ The EnablePriorityAccountProtection parameter enables or disable priority accoun Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -IgnoreDehydratedFlag + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -131,13 +142,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-EventLogLevel.md b/exchange/exchange-ps/ExchangePowerShell/Set-EventLogLevel.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-EventLogLevel.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EventLogLevel.md index 4b819c2bb3..cf382d401a 100644 --- a/exchange/exchange-ps/exchange/Set-EventLogLevel.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EventLogLevel.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-eventloglevel -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-EventLogLevel -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-eventloglevel +schema: 2.0.0 +title: Set-EventLogLevel --- # Set-EventLogLevel @@ -28,7 +29,7 @@ Set-EventLogLevel [-Identity] -Level ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -39,18 +40,20 @@ Set-EventLogLevel -Identity "Exchange01\MSExchangeTransport\SmtpReceive" -Level This example sets the event log level to High for the MSExchangeTransport\\SmtpReceive event logging category on the Exchange server Exchange01. -**Note**: Run the Get-EventLogLevel cmdlet to retrieve a list of the event categories on your server. For more information, see [Get-EventLogLevel](https://learn.microsoft.com/powershell/module/exchange/get-eventloglevel). +**Note**: Run the Get-EventLogLevel cmdlet to retrieve a list of the event categories on your server. For more information, see [Get-EventLogLevel](https://learn.microsoft.com/powershell/module/exchangepowershell/get-eventloglevel). ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the event logging category for which you want to set the event logging level. ```yaml Type: ECIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Level parameter specifies the log level for the specific event logging category. The valid values are: - Lowest @@ -72,7 +78,6 @@ The Level parameter specifies the log level for the specific event logging categ Type: ECIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -91,7 +99,6 @@ 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 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-EventsFromEmailConfiguration.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EventsFromEmailConfiguration.md index 77225894de..f2f9e6efff 100644 --- a/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EventsFromEmailConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-eventsfromemailconfiguration applicable: Exchange Online -title: Set-EventsFromEmailConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-eventsfromemailconfiguration +schema: 2.0.0 +title: Set-EventsFromEmailConfiguration --- # Set-EventsFromEmailConfiguration @@ -43,7 +44,7 @@ Set-EventsFromEmailConfiguration [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,13 +72,15 @@ This example resets Events from Email settings for the user. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox that you want to modify. You identify the mailbox by email address. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -87,16 +90,18 @@ Accept wildcard characters: False ``` ### -CreateEventsFromEmailAsPrivate + +> Applicable: Exchange Online + The CreateEventsFromEmailAsPrivate parameter specifies whether to create the events discovered from messages as normal or private events. Valid values are: -- $true: The events are crated as private events. This is the default value. +- $true: The events are crated as private events. This value is the default. - $false: The events are created as normal events. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -EventReservationProcessingLevel -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Online + +This parameter is deprecated and no longer used. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -122,19 +129,21 @@ Accept wildcard characters: False ``` ### -FlightReservationProcessingLevel + +> Applicable: Exchange Online + The FlightReservationProcessingLevel parameter specifies whether flight reservations are automatically discovered from messages, and whether these reservations are automatically added to the user's calendar. Valid values are: - Disabled: Do not discover flight reservations from messages. - Email: Discover flight reservations from messages, but don't automatically add them to the user's calendar. -- Calendar: Discover flight reservations from messages and automatically add them to the user's calendar. This is the default value. +- Calendar: Discover flight reservations from messages and automatically add them to the user's calendar. This value is the default. -Note that these values are case sensitive. +These values are case sensitive. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -FoodEstablishmentReservationProcessingLevel -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Online + +This parameter is deprecated and no longer used. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -InvoiceProcessingLevel -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Online + +This parameter is deprecated and no longer used. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -176,17 +189,19 @@ Accept wildcard characters: False ``` ### -LodgingReservationProcessingLevel + +> Applicable: Exchange Online + The LodgingReservationProcessingLevel parameter specifies whether lodging reservations are automatically discovered from messages, and whether these reservations are automatically added to the user's calendar. Valid values are: - Disabled: Do not discover lodging reservations from messages. - Email: Discover lodging reservations from messages however do not automatically add these to the user's calendar. -- Calendar: Discover lodging reservations from messages and automatically add them to the user's calendar. This is the default value. +- Calendar: Discover lodging reservations from messages and automatically add them to the user's calendar. This value is the default. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -196,17 +211,19 @@ Accept wildcard characters: False ``` ### -ParcelDeliveryProcessingLevel + +> Applicable: Exchange Online + The ParcelDeliveryProcessingLevel parameter specifies whether parcel deliveries are automatically discovered from messages, and whether these reservations are automatically added to the user's calendar. Valid values are: - Disabled: Do not discover parcel deliveries from messages. - Email: Discover parcel deliveries from messages however do not automatically add these to the user's calendar. -- Calendar: Discover parcel deliveries from messages and automatically add them to the user's calendar. This is the default value. +- Calendar: Discover parcel deliveries from messages and automatically add them to the user's calendar. This value is the default. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,17 +233,19 @@ Accept wildcard characters: False ``` ### -RentalCarReservationProcessingLevel + +> Applicable: Exchange Online + The RentalCarReservationProcessingLevel parameter specifies whether rental car reservations are automatically discovered from messages, and whether these reservations are automatically added to the user's calendar. Valid values are: - Disabled: Do not discover rental car reservations from messages. - Email: Discover rental car reservations from messages, but don't automatically add them to the user's calendar. -- Calendar: Discover rental car reservations from messages and automatically add them to the user's calendar. This is the default value. +- Calendar: Discover rental car reservations from messages and automatically add them to the user's calendar. This value is the default. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -236,13 +255,15 @@ Accept wildcard characters: False ``` ### -ResetSettings + +> Applicable: Exchange Online + The ResetSettings switch specifies whether to return all of the reservation discovery settings to their default values. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ResetSettings Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -252,13 +273,15 @@ Accept wildcard characters: False ``` ### -ServiceReservationProcessingLevel -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Online + +This parameter is deprecated and no longer used. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeAssistanceConfig.md similarity index 75% rename from exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExchangeAssistanceConfig.md index 69e2cfccc7..42f439b1a1 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeAssistanceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangeassistanceconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ExchangeAssistanceConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-exchangeassistanceconfig +schema: 2.0.0 +title: Set-ExchangeAssistanceConfig --- # Set-ExchangeAssistanceConfig @@ -46,7 +47,7 @@ Set-ExchangeAssistanceConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,13 +61,15 @@ This example changes the Help location for the Exchange admin center. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -CommunityLinkDisplayEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -CommunityURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -117,7 +127,6 @@ 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 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -ControlPanelFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -ControlPanelFeedbackURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,13 +172,15 @@ Accept wildcard characters: False ``` ### -ControlPanelHelpURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ControlPanelHelpURL parameter specifies the URL where help for the Exchange admin center (EAC) is hosted. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,6 +190,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -183,7 +201,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,16 +210,18 @@ Accept wildcard characters: False ``` ### -ExchangeHelpAppOnline + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExchangeHelpAppOnline specifies whether your organization uses the public help that's hosted by Microsoft. Valid values are: -- $true: Your organization uses the help that's hosted by Microsoft. This is the default value. +- $true: Your organization uses the help that's hosted by Microsoft. This value is the default. - $false: Your organization doesn't use the help that's hosted by Microsoft. You need to use the ControlPanelHelpURL, ManagementConsoleHelpURL, OWAHelpURL, and OWALightHelpURL parameters to configure the URLs where the help files are hosted. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,13 +231,15 @@ Accept wildcard characters: False ``` ### -ManagementConsoleFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,13 +249,15 @@ Accept wildcard characters: False ``` ### -ManagementConsoleFeedbackURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -244,13 +267,15 @@ Accept wildcard characters: False ``` ### -ManagementConsoleHelpURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ManagementConsoleHelpURL parameter specifies the URL where help for the Exchange Management Console (EMC) is hosted. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,13 +285,15 @@ Accept wildcard characters: False ``` ### -OWAFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,13 +303,15 @@ Accept wildcard characters: False ``` ### -OWAFeedbackURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -292,13 +321,15 @@ Accept wildcard characters: False ``` ### -OWAHelpURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OWAHelpURL parameter specifies the URL for where help for the standard version of Outlook on the web is hosted. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -308,13 +339,15 @@ Accept wildcard characters: False ``` ### -OWALightFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,13 +357,15 @@ Accept wildcard characters: False ``` ### -OWALightFeedbackURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,13 +375,15 @@ Accept wildcard characters: False ``` ### -OWALightHelpURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OWALightHelpURL parameter specifies the URL for where help for the light version of Outlook on the web is hosted. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +393,15 @@ Accept wildcard characters: False ``` ### -PrivacyLinkDisplayEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -372,13 +411,15 @@ Accept wildcard characters: False ``` ### -PrivacyStatementURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -388,13 +429,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeFeature.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeFeature.md new file mode 100644 index 0000000000..a2e2cc0c75 --- /dev/null +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeFeature.md @@ -0,0 +1,190 @@ +--- +applicable: Exchange Server 2019, Exchange Server SE +author: lusassl-msft +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +ms.author: lusassl +ms.reviewer: srvar +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-exchangefeature +schema: 2.0.0 +title: Set-ExchangeFeature +--- + +# 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 article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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 + +> Applicable: Exchange Server 2019, Exchange Server SE + +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: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Approve + +> Applicable: Exchange Server 2019, Exchange Server SE + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Block + +> Applicable: Exchange Server 2019, Exchange Server SE + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Exchange Server 2019, Exchange Server SE + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureID + +> Applicable: Exchange Server 2019, Exchange Server SE + +The FeatureID parameter specifies the feature you want to control. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Exchange Server 2019, Exchange Server SE + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more 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/ExchangePowerShell/Set-ExchangeServer.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-ExchangeServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExchangeServer.md index 34505a7f63..81bec36dcd 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangeserver -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ExchangeServer -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-exchangeserver +schema: 2.0.0 +title: Set-ExchangeServer --- # Set-ExchangeServer @@ -34,6 +35,7 @@ Set-ExchangeServer [-Identity] [-MitigationsEnabled ] [-MonitoringGroup ] [-ProductKey ] + [-RingLevel ] [-StaticConfigDomainController ] [-StaticDomainControllers ] [-StaticExcludedDomainControllers ] @@ -45,7 +47,7 @@ Set-ExchangeServer [-Identity] ## DESCRIPTION The Set-ExchangeServer cmdlet sets generic Exchange attributes in Active Directory for a specified computer. You can only use this task on one server at a time. If you want to bulk manage your servers running Microsoft Exchange, add this task to a script. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +75,9 @@ This example removes an Exchange server from the Customer Experience Improvement ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 @@ -84,7 +89,6 @@ The Identity parameter specifies the Exchange server that you want to modify. Yo Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -94,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -103,7 +110,6 @@ 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 Required: False Position: Named @@ -113,13 +119,15 @@ Accept wildcard characters: False ``` ### -CustomerFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CustomerFeedbackEnabled parameter specifies whether the Exchange server is enrolled in the Microsoft Customer Experience Improvement Program (CEIP). The CEIP collects anonymous information about how you use Exchange and problems that you might encounter. If you decide not to participate in the CEIP, the servers are opted-out automatically. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,7 +137,10 @@ Accept wildcard characters: False ``` ### -DataCollectionEnabled -The DataCollectionEnabled parameter specifies whether the EM Service will collect and send diagnostic data to Microsoft using OCS. Valid values are: + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The DataCollectionEnabled parameter specifies whether the EM Service collects and send diagnostic data to Microsoft using OCS. Valid values are: - $true: The EM Service collects and sends diagnostic data to Microsoft using OCS. - $false: Data collection is disabled. @@ -138,7 +149,6 @@ The DataCollectionEnabled parameter specifies whether the EM Service will collec Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +158,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -156,7 +169,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +178,15 @@ Accept wildcard characters: False ``` ### -ErrorReportingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ErrorReportingEnabled parameter specifies whether error reporting is enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,6 +196,9 @@ Accept wildcard characters: False ``` ### -InternetWebProxy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternetWebProxy parameter specifies the web proxy server that the Exchange server uses to reach the internet. A valid value for this parameter is the URL of the web proxy server. In Exchange 2016 or later, to configure a list of servers that bypass the web proxy server and connect to the internet directly, use the InternetWebProxyBypassList parameter. @@ -190,7 +207,6 @@ In Exchange 2016 or later, to configure a list of servers that bypass the web pr Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,6 +216,9 @@ Accept wildcard characters: False ``` ### -InternetWebProxyBypassList + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternetWebProxyBypassList parameter specifies a list of servers that bypass the web proxy server specified by the InternetWebProxy parameter. You identify the servers by their FQDN (for example, server01.contoso.com). To enter multiple values and overwrite any existing FQDN entries, use the following syntax: @("host1.contoso.com","host2.contoso.com","host3.contoso.com"). @@ -210,7 +229,6 @@ The maximum number of servers you can enter with this parameter is 100. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,13 +238,15 @@ Accept wildcard characters: False ``` ### -MitigationsApplied + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + Do not use this parameter. The EM service uses this parameter to store and track mitigation status. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +256,9 @@ Accept wildcard characters: False ``` ### -MitigationsBlocked + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MitigationsBlocked parameter specifies a list of mitigations that are blocked. The Mitigation IDs present in this list are not applied by EM service in its hourly run. To enter multiple values and overwrite any existing Mitigation entries, use the following syntax: `@("Entry1","Entry2",..."EntryN")`. @@ -244,7 +267,6 @@ To enter multiple values and overwrite any existing Mitigation entries, use the Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,6 +276,9 @@ Accept wildcard characters: False ``` ### -MitigationsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MitigationsEnabled parameter specifies whether the Exchange Emergency Mitigation service (EM service) automatically applies mitigations on the Exchange server. Valid values are: - $true: The EM Service automatically applies mitigations on the Exchange server. @@ -265,7 +290,6 @@ For more information, see [Exchange Emergency Mitigation (EM) service](https://l Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,13 +299,15 @@ Accept wildcard characters: False ``` ### -MonitoringGroup + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringGroup parameter specifies how to add your Exchange servers to monitoring groups. You can add your servers to an existing group or create a monitoring group based on location or deployment, or to partition monitoring responsibility among your servers. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -291,13 +317,33 @@ Accept wildcard characters: False ``` ### -ProductKey + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProductKey parameter specifies the server product key. ```yaml Type: ProductKey Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RingLevel + +> Applicable: Exchange Server 2019, Exchange Server SE + +The RingLevel parameter specifies the server ring level that's used by the Feature Flighting feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -307,13 +353,15 @@ Accept wildcard characters: False ``` ### -StaticConfigDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StaticConfigDomainController parameter specifies whether to configure a domain controller to be used by the server via Directory Service Access (DSAccess). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -323,13 +371,15 @@ Accept wildcard characters: False ``` ### -StaticDomainControllers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StaticDomainControllers parameter specifies whether to configure a list of domain controllers to be used by the server via DSAccess. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -339,13 +389,15 @@ Accept wildcard characters: False ``` ### -StaticExcludedDomainControllers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StaticExcludedDomainControllers parameter specifies whether to exclude a list of domain controllers from being used by the server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -355,13 +407,15 @@ Accept wildcard characters: False ``` ### -StaticGlobalCatalogs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StaticGlobalCatalogs parameter specifies whether to configure a list of global catalogs to be used by the server via DSAccess. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -371,13 +425,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeSettings.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-ExchangeSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExchangeSettings.md index 436392e2c0..844d0b9c78 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangesettings -applicable: Exchange Server 2016, Exchange Server 2019 -title: Set-ExchangeSettings -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-exchangesettings +schema: 2.0.0 +title: Set-ExchangeSettings --- # Set-ExchangeSettings @@ -193,7 +194,7 @@ Set-ExchangeSettings [-Identity] -Reason ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -207,6 +208,9 @@ This example allows users to see the results of Unified Audit Logging. This exam ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the existing Exchange settings object that contains the Exchange settings that you want to configure. The value of this parameter is the value of the Name parameter on the New-ExchangeSetting cmdlet when the Exchange settings object was created. @@ -215,7 +219,6 @@ The value of this parameter is the value of the Name parameter on the New-Exchan Type: ExchangeSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -225,13 +228,15 @@ Accept wildcard characters: False ``` ### -ClearHistory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClearHistory switch specifies that you want to clear the entries in the modification history for the Exchange setting object. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ClearHistory Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -241,6 +246,9 @@ Accept wildcard characters: False ``` ### -ConfigName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigName parameter specifies the available Exchange setting that you want to add, remove, or update in the Exchange settings object. Valid values for this parameter are determined by the configuration schema that was specified by the Name parameter on the New-ExchangeSettings cmdlet. For add and update operations, you also need to use the ConfigValue parameter to specify the actual value for the setting. You can't use the ConfigName parameter with the ConfigPairs parameter. @@ -249,7 +257,6 @@ For add and update operations, you also need to use the ConfigValue parameter to Type: String Parameter Sets: UpdateSetting, RemoveSetting Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -259,15 +266,17 @@ Accept wildcard characters: False ``` ### -ConfigPairs + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigName parameter specifies the available Exchange setting that you want to add, remove, or update in the Exchange settings object. Valid values for this parameter are determined by the configuration schema that was specified by the Name parameter on the New-ExchangeSettings cmdlet. The syntax for a value is `=`. You can separate multiple values separated by commas. You can't use the ConfigPairs parameter with the ConfigName or ConfigValue parameters. ```yaml Type: String[] -Parameter Sets: RemoveMultipleSettings, UpdateMultipleSettings +Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric, RemoveMultipleSettings, UpdateMultipleSettings Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -276,20 +285,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String[] -Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -ConfigValue -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -ConfigValue The ConfigValue parameter specifies the value for the Exchange setting that you specified with the ConfigName parameter. The values are determined by the type of setting (a number, a timespan, $true or $false, etc.). You can't use the ConfigValue parameter with the ConfigPairs parameter. @@ -298,7 +297,6 @@ You can't use the ConfigValue parameter with the ConfigPairs parameter. Type: String Parameter Sets: UpdateSetting Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -308,6 +306,9 @@ Accept wildcard characters: False ``` ### -CreateSettingsGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CreateSettingsGroup switch specifies that you're creating an Exchange settings group, which is a group of related Exchange settings. You don't need to specify a value with this switch. Depending on how you want to configure the settings group, you use either the GroupName parameter or the SettingsGroup parameter to specify the name of the Exchange settings group. Choose carefully, because you can't rename an existing settings group. @@ -316,7 +317,6 @@ Depending on how you want to configure the settings group, you use either the Gr Type: SwitchParameter Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupAdvanced, CreateSettingsGroupGeneric Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -326,6 +326,9 @@ Accept wildcard characters: False ``` ### -ExpirationDate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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". @@ -334,9 +337,8 @@ You can only use the ExpirationDate parameter with the CreateSettingsGroup or Up ```yaml Type: DateTime -Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric +Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric, UpdateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -345,20 +347,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: DateTime -Parameter Sets: UpdateSettingsGroup -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -GuidMatch -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -GuidMatch The GuidMatch parameter specifies the scope of an Exchange settings group based on the GUID of the object (for example, the GUID of the mailbox database). This parameter is available for use with all Scope parameter values other than Forest. You use the GuidMatch parameter only when you create Exchange settings groups by using the CreateSettingsGroup switch with the GroupName parameter. @@ -369,7 +361,6 @@ You can't use this parameter with the GenericScopeName, GenericScopeValue, MaxVe Type: Guid Parameter Sets: CreateSettingsGroupGuid Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -379,13 +370,15 @@ Accept wildcard characters: False ``` ### -Reason + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Reason parameter specifies a description for why the Exchange setting or settings group was created or modified. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -395,6 +388,9 @@ Accept wildcard characters: False ``` ### -RemoveSetting + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoveSetting switch specifies that you're removing an existing Exchange setting from an Exchange settings object. You don't need to specify a value with this switch. You use the ConfigPairs parameter or the ConfigName parameter to specify the setting that you want to remove. @@ -403,7 +399,6 @@ You use the ConfigPairs parameter or the ConfigName parameter to specify the set Type: SwitchParameter Parameter Sets: RemoveSetting, RemoveMultipleSettings Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -413,6 +408,9 @@ Accept wildcard characters: False ``` ### -RemoveSettingsGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoveSettingsGroup switch specifies that you're removing an Exchange settings group. You don't need to specify a value with this switch. You use the GroupName parameter to specify the Exchange settings group that you want to remove. @@ -421,7 +419,6 @@ You use the GroupName parameter to specify the Exchange settings group that you Type: SwitchParameter Parameter Sets: RemoveSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -431,6 +428,9 @@ Accept wildcard characters: False ``` ### -SettingsGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SettingsGroup parameter specifies an existing Exchange settings group that's used to create a new settings group, or modify an existing settings group. You can't use the SettingsGroup parameter with the GroupName parameter. @@ -439,7 +439,6 @@ You can't use the SettingsGroup parameter with the GroupName parameter. Type: String Parameter Sets: CreateSettingsGroupAdvanced, UpdateSettingsGroupAdvanced Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -449,6 +448,9 @@ Accept wildcard characters: False ``` ### -UpdateSetting + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UpdateSetting switch specifies that you're updating an Exchange setting in an existing Exchange settings object. You don't need to specify a value with this switch. You use the ConfigPairs parameter or the ConfigName and ConfigValue parameters to configure the Exchange setting. @@ -457,7 +459,6 @@ You use the ConfigPairs parameter or the ConfigName and ConfigValue parameters t Type: SwitchParameter Parameter Sets: UpdateSetting, UpdateMultipleSettings Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -467,6 +468,9 @@ Accept wildcard characters: False ``` ### -UpdateSettingsGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UpdateSettingsGroup switch specifies that you're modifying an Exchange settings group. You don't need to specify a value with this switch. Depending on how you want to configure the settings group, you use either the GroupName parameter or the SettingsGroup parameter to specify the Exchange settings group that you want to modify. @@ -475,7 +479,6 @@ Depending on how you want to configure the settings group, you use either the Gr Type: SwitchParameter Parameter Sets: UpdateSettingsGroup, UpdateSettingsGroupAdvanced Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -485,6 +488,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -496,7 +502,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -506,6 +511,9 @@ Accept wildcard characters: False ``` ### -Disable + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Disable switch specifies that the Exchange settings group is disabled. You don't need to specify a value with this switch. You can only use this switch with the CreateSettingsGroup switch. @@ -516,7 +524,6 @@ To use this switch to enable an Exchange settings group, use this exact syntax ` Type: SwitchParameter Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -526,6 +533,9 @@ Accept wildcard characters: False ``` ### -DisableGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisableGroup parameter specifies the name of the enabled Exchange settings group that you want to disable. If the value contains spaces, enclose the value in quotation marks ("). You can use the DisableGroup and EnableGroup parameters together in the same command to enable and disable different Exchange settings groups at the same time. @@ -534,7 +544,6 @@ You can use the DisableGroup and EnableGroup parameters together in the same com Type: String Parameter Sets: EnableSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -544,13 +553,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -560,6 +571,9 @@ Accept wildcard characters: False ``` ### -EnableGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnableGroup parameter specifies the name of the disabled Exchange settings group that you want to enable. If the value contains spaces, enclose the value in quotation marks ("). You can use the DisableGroup and EnableGroup parameters together in the same command to enable and disable different Exchange settings groups at the same time. @@ -568,7 +582,6 @@ You can use the DisableGroup and EnableGroup parameters together in the same com Type: String Parameter Sets: EnableSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -578,6 +591,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -586,7 +602,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -596,13 +611,15 @@ Accept wildcard characters: False ``` ### -GenericScopeName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GenericScopeName parameter specifies the name of the scope. The available values are determined by the schema of the Exchange setting object. ```yaml Type: String Parameter Sets: CreateSettingsGroupGeneric Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -612,13 +629,15 @@ Accept wildcard characters: False ``` ### -GenericScopeValue + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GenericScopeValue parameter specifies the value of the scope specified by the GenericScopeName parameter. The available values are determined by the schema of the Exchange setting object. ```yaml Type: String Parameter Sets: CreateSettingsGroupGeneric Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -628,6 +647,9 @@ Accept wildcard characters: False ``` ### -GroupName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GroupName parameter specifies the name of the Exchange settings group in group operations. For example: - Create Exchange settings groups and simultaneously configure the group scope and priority. @@ -641,7 +663,6 @@ If the value contains spaces, enclose the value in quotation marks ("). Type: String Parameter Sets: UpdateSetting, RemoveSetting, CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric, UpdateSettingsGroup, RemoveMultipleSettings, RemoveSettingsGroup, UpdateMultipleSettings Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -651,6 +672,9 @@ Accept wildcard characters: False ``` ### -MaxVersion + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxVersion parameter specifies the scope of an Exchange settings group based on the version of the object (for example, the version of Exchange that's installed on the server). This parameter is available for use with all Scope parameter values other than Forest. You use the MaxVersion parameter together with the MinVersion parameter only when you create Exchange settings groups by using the CreateSettingsGroup switch with the GroupName parameter. @@ -661,7 +685,6 @@ You can't use this parameter with the GuidMatch, GenericScopeName, or GenericSco Type: String Parameter Sets: CreateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -671,6 +694,9 @@ Accept wildcard characters: False ``` ### -MinVersion + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MinVersion parameter specifies the scope of an Exchange settings group based on the version of the object (for example, the version of Exchange that's installed on the server). This parameter is available for use with all Scope parameter values other than Forest. You use the MinVersion parameter together with the MaxVersion parameter only when you create Exchange settings groups by using the CreateSettingsGroup switch with the GroupName parameter. @@ -681,7 +707,6 @@ You can't use this parameter with GuidMatch, GenericScopeName, or GenericScopeVa Type: String Parameter Sets: CreateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -691,6 +716,9 @@ Accept wildcard characters: False ``` ### -NameMatch + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NameMatch parameter specifies the scope of an Exchange settings group based on the name of the object (for example, the process name). This parameter is available for use with all Scope parameter values other than Forest. You use the NameMatch parameter only when you create Exchange settings groups by using the CreateSettingsGroup switch with the GroupName parameter. @@ -701,7 +729,6 @@ You can't use this parameter with the GuidMatch, GenericScopeName, or GenericSco Type: String Parameter Sets: CreateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -711,13 +738,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Priority parameter specifies the priority of an Exchange settings group. The priority value for every group must be unique. A lower priority value indicates a higher priority. ```yaml Type: Int32 Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric, UpdateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -727,6 +756,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Scope parameter specifies the scope of the Exchange settings object. Valid values are: - Dag @@ -742,7 +774,6 @@ The Scope parameter specifies the scope of the Exchange settings object. Valid v Type: ExchangeSettingsScope Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -752,6 +783,9 @@ Accept wildcard characters: False ``` ### -ScopeFilter + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ScopeFilter parameter uses OPATH filter syntax to specify the scope of an Exchange settings group based. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"ServerRole -like 'Mailbox*'"`). - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -771,7 +805,6 @@ You use this parameter only when you update Exchange settings groups by using th Type: String Parameter Sets: CreateSettingsGroup, UpdateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -781,13 +814,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExoPhishSimOverrideRule.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExoPhishSimOverrideRule.md index 2b5d969329..42a575f418 100644 --- a/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExoPhishSimOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-exophishsimoverriderule applicable: Exchange Online -title: Set-ExoPhishSimOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-exophishsimoverriderule +schema: 2.0.0 +title: Set-ExoPhishSimOverrideRule --- # Set-ExoPhishSimOverrideRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-ExoPhishSimOverrideRule cmdlet to modify third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +Use the Set-ExoPhishSimOverrideRule cmdlet to modify non-Microsoft phishing simulation override rules that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -34,7 +35,7 @@ Set-ExoPhishSimOverrideRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,6 +58,9 @@ This example modifies the specified phishing simulation override rule with the s ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -70,7 +74,6 @@ Use the Get-ExoPhishSimOverrideRule cmdlet to find the values. The name of the r Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -80,7 +83,10 @@ Accept wildcard characters: False ``` ### -AddDomains -The AddDomains parameter specifies an existing entry to add to the list of email domains that are used by the third-party phishing simulation. + +> Applicable: Exchange Online + +The AddDomains parameter specifies an existing entry to add to the list of email domains that are used by the non-Microsoft phishing simulation. You can specify multiple values separated by commas. A maximum of 20 entries are allowed in the list. @@ -88,7 +94,6 @@ You can specify multiple values separated by commas. A maximum of 20 entries are Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -98,7 +103,10 @@ Accept wildcard characters: False ``` ### -AddSenderIpRanges -The AddSenderIpRanges parameter specifies an existing entry to add to the list of source IP addresses that are used by the third-party phishing simulation. Valid values are: + +> Applicable: Exchange Online + +The AddSenderIpRanges parameter specifies an existing entry to add to the list of source IP addresses that are used by the non-Microsoft phishing simulation. Valid values are: - Single IP address: For example, 192.168.1.1. - IP address range: For example, 192.168.0.1-192.168.0.254. @@ -112,7 +120,6 @@ A maximum of 10 entries are allowed in the list. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -147,7 +159,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -157,13 +168,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -173,7 +186,10 @@ 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. + +> Applicable: Exchange Online + +The RemoveDomains parameter specifies an existing entry to remove from the list of email domains that are used by the non-Microsoft phishing simulation. You can specify multiple values separated by commas. @@ -181,7 +197,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -191,7 +206,10 @@ Accept wildcard characters: False ``` ### -RemoveSenderIpRanges -The RemoveSenderIpRanges parameter specifies an existing entry to remove from the list of source IP addresses that are used by the third-party phishing simulation. Valid values are: + +> Applicable: Exchange Online + +The RemoveSenderIpRanges parameter specifies an existing entry to remove from the list of source IP addresses that are used by the non-Microsoft phishing simulation. Valid values are: - Single IP address: For example, 192.168.1.1. - IP address range: For example, 192.168.0.1-192.168.0.254. @@ -203,7 +221,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -213,13 +230,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExoSecOpsOverrideRule.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExoSecOpsOverrideRule.md index b20f1787e3..adba6e057d 100644 --- a/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExoSecOpsOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exosecopsoverriderule applicable: Exchange Online -title: set-ExoSecOpsOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exosecopsoverriderule +schema: 2.0.0 +title: set-ExoSecOpsOverrideRule --- # Set-ExoSecOpsOverrideRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-ExoSecOpsOverrideRule cmdlet to modify SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +Use the Set-ExoSecOpsOverrideRule cmdlet to modify SecOps mailbox override rules that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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. @@ -32,7 +33,7 @@ Set-ExoSecOpsOverrideRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example adds a comment to the specified SecOps mailbox override rule. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ Use the Get-ExoSecOpsMailboxRule cmdlet to find these values. The name of the ru Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -101,7 +109,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -111,13 +118,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExternalInOutlook.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-ExternalInOutlook.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExternalInOutlook.md index cfe5f7c057..682e01d1e0 100644 --- a/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExternalInOutlook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-externalinoutlook applicable: Exchange Online, Exchange Online Protection -title: Set-ExternalInOutlook -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-externalinoutlook +schema: 2.0.0 +title: Set-ExternalInOutlook --- # Set-ExternalInOutlook @@ -30,7 +31,7 @@ Set-ExternalInOutlook [[-Identity] ] ## DESCRIPTION If your organization already uses mail flow rules (also known as transport rules) to add text to the subject line of messages from external senders, you should disable those rules before you enable this feature to avoid duplication. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,13 +59,19 @@ 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. + +> Applicable: Exchange Online, Exchange Online Protection + +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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -74,6 +81,9 @@ Accept wildcard characters: False ``` ### -AllowList + +> Applicable: Exchange Online + The AllowList parameter specifies exceptions to external sender identification in supported versions of Outlook. Messages received from the specified senders or senders in the specified domains don't receive native External sender identification. The allow list uses the `5322.From` address (also known as the **From** address or P2 sender). Valid values are an individual domain (contoso.com), a domain and all subdomains (*.contoso.com) or email addresses (admin@contoso.com). @@ -90,7 +100,6 @@ The maximum number of entries is 50, and the total size of all entries can't exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -100,6 +109,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter enables or disables external sender identification in supported versions of Outlook. Valid values are: - $true: External sender identification in Outlook is enabled. An External icon is added in the area of the subject line of messages from external senders. To exempt specific senders or sender domains from this identification, use the AllowList parameter. @@ -111,7 +123,6 @@ After an admin enables this setting, it can take between 24 and 48 hours for use Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -131,4 +142,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-OrganizationConfig](https://learn.microsoft.com/powershell/module/exchange/set-organizationconfig) +[Set-OrganizationConfig](https://learn.microsoft.com/powershell/module/exchangepowershell/set-organizationconfig) diff --git a/exchange/exchange-ps/ExchangePowerShell/Set-FeatureConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-FeatureConfiguration.md new file mode 100644 index 0000000000..70bc6decf7 --- /dev/null +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FeatureConfiguration.md @@ -0,0 +1,211 @@ +--- +applicable: Security & Compliance +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-featureconfiguration +schema: 2.0.0 +title: Set-FeatureConfiguration +--- + +# 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 + +> Applicable: Security & Compliance + +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: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comment + +> Applicable: Security & Compliance + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Security & Compliance + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations + +> Applicable: Security & Compliance + +The locations parameter specifies where the feature configuration applies. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode + +> Applicable: Security & Compliance + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScenarioConfig + +> Applicable: Security & Compliance + +The ScenarioConfig parameter specifies additional information about the feature configuration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Security & Compliance + +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md b/exchange/exchange-ps/ExchangePowerShell/Set-FederatedOrganizationIdentifier.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FederatedOrganizationIdentifier.md index 92e99bb1fe..3af3c01013 100644 --- a/exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FederatedOrganizationIdentifier.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-federatedorganizationidentifier -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-FederatedOrganizationIdentifier -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-federatedorganizationidentifier +schema: 2.0.0 +title: Set-FederatedOrganizationIdentifier --- # Set-FederatedOrganizationIdentifier ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-FederatedOrganizationIdentifier cmdlet to configure the federated organization identifier for the Exchange organization. @@ -40,7 +41,7 @@ You must configure a federated organization identifier to create an account name You can temporarily disable federation by disabling the organization identifier. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,13 +69,15 @@ This example enables the organization identifier. This enables federation for th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the federated organization identifier. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -AccountNamespace + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AccountNamespace parameter specifies the federated domain to be used to establish the organization identifier with the Microsoft Federation Gateway. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -109,7 +117,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -DefaultDomain + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DefaultDomain parameter specifies the federated domain used for delegation tokens issued by the Microsoft Federation Gateway for user accounts in the Exchange organization. If the DefaultDomain parameter isn't set, the primary SMTP domain for each user account is used in delegation tokens issued by the Microsoft Federation Gateway. Only a single domain or subdomain for the Exchange organization should be configured, and it applies to all delegation tokens issued for the Exchange organization, for example, contoso.com. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -DelegationFederationTrust + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DelegationFederationTrust parameter specifies the identity of the federation trust to be used by the organization identifier. ```yaml Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -159,7 +173,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the organization identifier is enabled. Valid values include $true or $false. Setting the parameter to $false disables federation. @@ -177,7 +193,6 @@ Setting the parameter to $false disables federation. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,13 +202,15 @@ Accept wildcard characters: False ``` ### -OrganizationContact + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationContact parameter specifies the SMTP address of the federation contact. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,13 +220,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FederationTrust.md b/exchange/exchange-ps/ExchangePowerShell/Set-FederationTrust.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-FederationTrust.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FederationTrust.md index 5a6e6a3d8a..1f2bdd24ad 100644 --- a/exchange/exchange-ps/exchange/Set-FederationTrust.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FederationTrust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-federationtrust -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-FederationTrust -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-federationtrust +schema: 2.0.0 +title: Set-FederationTrust --- # Set-FederationTrust @@ -58,7 +59,7 @@ Set-FederationTrust [-Identity] ## DESCRIPTION You can use the Set-FederationTrust cmdlet to manage the certificates used for the federation trust. You can also use the Set-FederationTrust cmdlet to refresh the metadata document from the Microsoft Federation Gateway and download its certificate. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -88,6 +89,9 @@ Before you configure a federation trust to use the next certificate as the curre ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the federation trust being modified. **Note**: For Exchange Online organizations, use the value "Microsoft Entra authentication". @@ -96,7 +100,6 @@ The Identity parameter specifies the name of the federation trust being modified Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -ApplicationUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ApplicationUri parameter specifies the primary domain used for the federation organization identifier. ```yaml Type: String Parameter Sets: ApplicationUri Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -PublishFederationCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PublishFederationCertificate switch specifies the next certificate as the current certificate for the federation trust and publishes it to the Microsoft Federation Gateway. You don't need to specify a value with this switch. The certificate is used to encrypt tokens with the Microsoft Federation Gateway. @@ -132,7 +140,6 @@ Before setting the next certificate to be used as the current certificate, ensur Type: SwitchParameter Parameter Sets: PublishFederationCertificate Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -151,7 +161,6 @@ 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 Required: False Position: Named @@ -161,13 +170,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +188,15 @@ Accept wildcard characters: False ``` ### -MetadataUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MetadataUrl parameter specifies the URL where WS-FederationMetadata is published by the Microsoft Federation Gateway. ```yaml Type: Uri Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,13 +206,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a name for the federation trust. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -RefreshMetadata + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RefreshMetadata switch specifies that the metadata document and certificate is retrieved again from the Microsoft Federation Gateway. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +242,15 @@ Accept wildcard characters: False ``` ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Thumbprint parameter specifies the thumbprint of the X.509 certificate to be configured as the next certificate for the federation trust. After the certificate is deployed on all Exchange servers in the organization, you can use the PublishFederationCertificate switch to configure the trust to use this certificate. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,13 +260,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyAuthority.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyAuthority.md index 2c6319179c..2f500c9bff 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyAuthority.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertyauthority applicable: Security & Compliance -title: Set-FilePlanPropertyAuthority +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertyauthority schema: 2.0.0 +title: Set-FilePlanPropertyAuthority --- # Set-FilePlanPropertyAuthority @@ -39,6 +41,9 @@ This example modifies the display name for the custom file plan property authori ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property authority that you want to modify. You can use any value that uniquely identifies the authority. For example: - Name @@ -49,7 +54,6 @@ The Identity parameter specifies the custom file plan property authority that yo Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -59,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -68,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -78,13 +84,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property authority. 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 @@ -94,13 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCategory.md index c997f07927..7643afcc0f 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertycategory applicable: Security & Compliance -title: Set-FilePlanPropertyCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertycategory schema: 2.0.0 +title: Set-FilePlanPropertyCategory --- # Set-FilePlanPropertyCategory @@ -37,6 +39,9 @@ This example modifies the display name for the custom file plan property categor ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property category that you want to modify. You can use any value that uniquely identifies the category. For example: - Name @@ -47,7 +52,6 @@ The Identity parameter specifies the custom file plan property category that you Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -57,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -66,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -76,13 +82,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property category. 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 @@ -92,13 +100,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCitation.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCitation.md index 78ebda0733..fe10f51f45 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCitation.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertycitation applicable: Security & Compliance -title: Set-FilePlanPropertyCitation +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertycitation schema: 2.0.0 +title: Set-FilePlanPropertyCitation --- # Set-FilePlanPropertyCitation @@ -42,6 +44,9 @@ This example modifies the citation URL for the custom file plan property citatio ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property citation that you want to modify. You can use any value that uniquely identifies the citation. For example: - Name @@ -52,7 +57,6 @@ The Identity parameter specifies the custom file plan property citation that you Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -62,13 +66,15 @@ Accept wildcard characters: False ``` ### -CitationJurisdiction + +> Applicable: Security & Compliance + The CitationJurisdiction parameter specifies the jurisdiction for the file plan property citation. 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 @@ -78,13 +84,15 @@ Accept wildcard characters: False ``` ### -CitationUrl + +> Applicable: Security & Compliance + The CitationJurisdiction parameter specifies the URL for the file plan property citation. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -94,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -103,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -113,13 +123,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property citation. 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 @@ -129,13 +141,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyDepartment.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyDepartment.md index 40d312c5a8..aa1f144242 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyDepartment.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertydepartment applicable: Security & Compliance -title: Set-FilePlanPropertyDepartment +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertydepartment schema: 2.0.0 +title: Set-FilePlanPropertyDepartment --- # Set-FilePlanPropertyDepartment @@ -44,6 +46,9 @@ This example modifies the display name for the custom file plan property departm ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property department that you want to modify. You can use any value that uniquely identifies the department. For example: - Name @@ -54,7 +59,6 @@ The Identity parameter specifies the custom file plan property department that y Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -64,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -73,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -83,13 +89,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property department. 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 @@ -99,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyReferenceId.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyReferenceId.md index 0be4986969..9f9b2aa030 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyReferenceId.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertyreferenceid applicable: Security & Compliance -title: Set-FilePlanPropertyReferenceId +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertyreferenceid schema: 2.0.0 +title: Set-FilePlanPropertyReferenceId --- # Set-FilePlanPropertyReferenceId @@ -40,6 +42,9 @@ This example modifies the display name for the custom file plan property referen ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property reference ID that you want to modify. You can use any value that uniquely identifies the reference ID. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property reference ID that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property reference ID. 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 @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertySubCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertySubCategory.md index 384fa72ff4..d5177695be 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertySubCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertysubcategory applicable: Security & Compliance -title: Set-FilePlanPropertySubCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertysubcategory schema: 2.0.0 +title: Set-FilePlanPropertySubCategory --- # Set-FilePlanPropertySubCategory @@ -40,6 +42,9 @@ This example modifies the display name for the custom file plan property subcate ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property subcategory that you want to modify. You can use any value that uniquely identifies the subcategory. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property subcategory that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property subcategory. 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 @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-FocusedInbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-FocusedInbox.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-FocusedInbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FocusedInbox.md index daebaa21e2..7aca252699 100644 --- a/exchange/exchange-ps/exchange/Set-FocusedInbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FocusedInbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-focusedinbox applicable: Exchange Online, Exchange Online Protection -title: Set-FocusedInbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-focusedinbox +schema: 2.0.0 +title: Set-FocusedInbox --- # Set-FocusedInbox @@ -30,7 +31,7 @@ Set-FocusedInbox -Identity ## DESCRIPTION Focused Inbox is a replacement for Clutter that separates the Inbox into the Focused and Other tabs in Outlook on the web and newer versions of Outlook. Important emails are on the Focused tab while the rest are on the Other tab. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example disables Focused Inbox for the mailbox of laura@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -71,16 +74,18 @@ Accept wildcard characters: False ``` ### -FocusedInboxOn + +> Applicable: Exchange Online, Exchange Online Protection + The FocusedInboxOn parameter enables or disables Focused Inbox for the mailbox. Valid values are: -- $true: Focused Inbox is enabled. This is the default value. +- $true: Focused Inbox is enabled. This value is the default. - $false: Focused Inbox is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill UseCustomRouting Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ForeignConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-ForeignConnector.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-ForeignConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ForeignConnector.md index 8ce9583a9c..6c5fbc08ee 100644 --- a/exchange/exchange-ps/exchange/Set-ForeignConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ForeignConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-foreignconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ForeignConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-foreignconnector +schema: 2.0.0 +title: Set-ForeignConnector --- # Set-ForeignConnector @@ -40,9 +41,9 @@ Set-ForeignConnector [-Identity] ``` ## DESCRIPTION -A Foreign connector uses a Drop directory in the Transport service of a Mailbox server to send messages to a local messaging server that doesn't use SMTP as its primary transport mechanism. These messaging servers are known as foreign gateway servers. Third-party fax gateway servers are examples of foreign gateway servers. The address spaces assigned to a Foreign connector can be SMTP or non-SMTP. +A Foreign connector uses a Drop directory in the Transport service of a Mailbox server to send messages to a local messaging server that doesn't use SMTP as its primary transport mechanism. These messaging servers are known as foreign gateway servers. Non-Microsoft fax gateway servers are examples of foreign gateway servers. The address spaces assigned to a Foreign connector can be SMTP or non-SMTP. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,6 +57,9 @@ This example configures a 10 MB message size limit on the existing Foreign conne ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Foreign connector that you want to modify. The Identity parameter can take any of the following values for the Foreign connector object: - GUID @@ -66,7 +70,6 @@ The Identity parameter specifies the Foreign connector that you want to modify. Type: ForeignConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -76,9 +79,12 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. -- AddressSpaceType: The address space type may be SMTP, X400, or any other text string. If you omit the address space type, an SMTP address space type is assumed. +- AddressSpaceType: The address space type might be SMTP, X400, or any other text string. If you omit the address space type, an SMTP address space type is assumed. - AddressSpace: For SMTP address space types, the address space that you enter must be RFC 1035-compliant. For example, \*, \*.com, and \*.contoso.com are permitted, but \*contoso.com isn't permitted. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such as o=MySite;p=MyOrg;a=adatum;c=us. For all other values of address type, you can enter any text for the address space. - AddressSpaceCost : The valid input range for the cost is from 1 through 100. A lower cost indicates a better route. If you omit the address space cost, a cost of 1 is assumed. If you enter a non-SMTP address space that contains a semicolon (;), you must specify the address space cost. @@ -89,7 +95,7 @@ If you specify the address space type or the address space cost, you must enclos - "SMTP:contoso.com" - contoso.com -You may specify multiple address spaces by separating the address spaces with commas, for example: `contoso.com,fabrikam.com`. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("), for example: `"contoso.com;2","fabrikam.com;3"`. +You might specify multiple address spaces by separating the address spaces with commas, for example: `contoso.com,fabrikam.com`. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("), for example: `"contoso.com;2","fabrikam.com;3"`. To add or remove one or more address space values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. @@ -97,7 +103,6 @@ To add or remove one or more address space values without affecting any existing Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -132,7 +142,6 @@ 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 Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -150,7 +162,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,9 +171,12 @@ Accept wildcard characters: False ``` ### -DropDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DropDirectory parameter specifies the name of the Drop directory used by this Foreign connector. All outbound messages sent to address spaces defined by this Foreign connector are put in the specified Drop directory. The location of the Drop directory for each Foreign connector is controlled by the following two items: -- RootDropDirectoryPath parameter in the Set-TransportService cmdlet: This option is used for all Foreign connectors that exist on the Mailbox server. The value of the RootDropDirectoryPath parameter may be a local path or a Universal Naming Convention (UNC) path to a remote server. +- RootDropDirectoryPath parameter in the Set-TransportService cmdlet: This option is used for all Foreign connectors that exist on the Mailbox server. The value of the RootDropDirectoryPath parameter might be a local path or a Universal Naming Convention (UNC) path to a remote server. - DropDirectory parameter in the Set-ForeignConnector cmdlet: This value is set for each Foreign Connector that exists on the server. By default, the RootDropDirectoryPath parameter is blank. This indicates the value of RootDropDirectoryPath is the Exchange 2010 installation folder. The default Exchange 2010 installation folder is C:\\Program Files\\Microsoft\\Exchange Server\\. By default, the value of the DropDirectory parameter is the name of the Foreign connector. @@ -181,7 +195,6 @@ The Drop directory must have the following permissions assigned to it: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,6 +204,9 @@ Accept wildcard characters: False ``` ### -DropDirectoryQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DropDirectoryQuota parameter specifies the maximum size of all message files in the Drop directory. When the specified value is reached, no new message files can be copied into the Drop directory until the existing messages are delivered and deleted. When you enter a value, qualify the value with one of the following units: @@ -201,7 +217,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 1 through 2147483647 bytes. If you enter a value of unlimited, no message size limit is imposed on the Drop directory. The default value is unlimited. @@ -209,7 +225,6 @@ The valid input range for this parameter is from 1 through 2147483647 bytes. If Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,13 +234,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether to enable the Foreign connector. The valid values are $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -235,6 +252,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -243,7 +263,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,13 +272,15 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. When the value of this parameter is $false, the connector can be used by all Mailbox servers in the Exchange organization. When the value of this parameter is $true, the connector can be used only by Mailbox servers in the same Active Directory site. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -269,6 +290,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxMessageSize parameter specifies the maximum size of a message that can pass through this Foreign connector. When you enter a value, qualify the value with one of the following units: @@ -279,7 +303,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. If you enter a value of unlimited, no message size limit is imposed on this Foreign connector. The default value is unlimited. The valid input range for this parameter is from 0 through 2147483647 kilobytes. If you set the value of the MaxMessageSize parameter to 0, you effectively disable the Foreign connector. However, if you set the value of the MaxMessageSize parameter to 0 when the value of the Enabled attribute is $true, you generate event log errors. The preferred method to disable the Foreign connector is to use the Enabled parameter. @@ -287,7 +311,6 @@ If you enter a value of unlimited, no message size limit is imposed on this Fore Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,13 +320,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a descriptive name for the Foreign connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,13 +338,15 @@ Accept wildcard characters: False ``` ### -RelayDsnRequired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RelayDsnRequired parameter specifies whether a Relay delivery status notification (DSN) is required by the Foreign connector when messages are written to the Drop directory. The valid input values for this parameter are $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -329,6 +356,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceTransportServers parameter specifies the names of the Mailbox servers that use this Foreign connector. Having a single Foreign connector homed on multiple Mailbox servers running the Transport service provides fault tolerance and high availability if one of the servers fails. The default value of this parameter is the name of the Mailbox server on which this Foreign connector was first installed. 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"`. @@ -339,7 +369,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -349,13 +378,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FrontendTransportService.md b/exchange/exchange-ps/ExchangePowerShell/Set-FrontendTransportService.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-FrontendTransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FrontendTransportService.md index 1332c4a436..bdbf2666e0 100644 --- a/exchange/exchange-ps/exchange/Set-FrontendTransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FrontendTransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-frontendtransportservice -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-FrontendTransportService -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-frontendtransportservice +schema: 2.0.0 +title: Set-FrontendTransportService --- # Set-FrontendTransportService @@ -71,7 +72,7 @@ Set-FrontendTransportService [-Identity] ## DESCRIPTION The Front End Transport service runs on all Mailbox servers and acts as a stateless proxy for all inbound and outbound external SMTP traffic for the Exchange organization. The Front End Transport service only communicates with the Transport service on a Mailbox server, and doesn't queue any messages locally. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -92,13 +93,15 @@ This example sets the ReceiveProtocolLogPath parameter to C:\\SMTP Protocol Logs ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server that you want to modify. ```yaml Type: FrontendTransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -108,13 +111,15 @@ Accept wildcard characters: False ``` ### -AgentLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogMaxAge parameter specifies the maximum age for the agent log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -134,7 +142,6 @@ Setting the value of the AgentLogMaxAge parameter to 00:00:00 prevents the autom Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogMaxDirectorySize parameter specifies the maximum size of all agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -154,7 +164,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the AgentLogMaxFileSize parameter must be less than or equal to the value of the AgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log directory. @@ -162,7 +172,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +181,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogMaxFileSize parameter specifies the maximum size of each agent log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -182,7 +194,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the AgentLogMaxFileSize parameter must be less than or equal to the value of the AgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log files. @@ -190,7 +202,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,13 +211,15 @@ Accept wildcard characters: False ``` ### -AgentLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogPath parameter specifies the default agent log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\AgentLog. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the AgentLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -216,6 +229,9 @@ Accept wildcard characters: False ``` ### -AntispamAgentsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AntispamAgentsEnabled parameter specifies whether anti-spam agents are installed on the server specified with the Identity parameter. The default value is $false for the Front End Transport service. You set this parameter by using a script. You shouldn't modify this parameter manually. @@ -224,7 +240,6 @@ You set this parameter by using a script. You shouldn't modify this parameter ma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -234,6 +249,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -243,7 +261,6 @@ 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 Required: False Position: Named @@ -253,13 +270,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -269,6 +288,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxAge parameter specifies the maximum age for the connectivity log file. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -279,7 +301,6 @@ For example, to specify 25 days for this parameter, use 25.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,6 +310,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all connectivity logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 1000 MB. When you enter a value, qualify the value with one of the following units: @@ -299,7 +323,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ConnectivityLogMaxFileSize parameter must be less than or equal to the value of the ConnectivityLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the connectivity log directory. @@ -307,7 +331,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,6 +340,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxFileSize parameter specifies the maximum size of each connectivity log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -327,7 +353,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ConnectivityLogMaxFileSize parameter must be less than or equal to the value of the ConnectivityLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the connectivity log files. @@ -335,7 +361,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -345,13 +370,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\Connectivity. Setting the value of this parameter to $null disables connectivity logging. However, setting this parameter to $null when the value of the ConnectivityLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -361,13 +388,15 @@ Accept wildcard characters: False ``` ### -DnsLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -377,6 +406,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogMaxAge parameter specifies the maximum age for the DNS log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -387,7 +419,6 @@ Setting the value of the DnsLogMaxAge parameter to 00:00:00 prevents the automat Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -397,6 +428,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogMaxDirectorySize parameter specifies the maximum size of all DNS logs in the DNS log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 100 MB. When you enter a value, qualify the value with one of the following units: @@ -407,7 +441,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the DnsLogMaxFileSize parameter must be less than or equal to the value of the DnsLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the DNS log directory. @@ -415,7 +449,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -425,6 +458,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogMaxFileSize parameter specifies the maximum size of each DNS log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -435,7 +471,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the DnsLogMaxFileSize parameter must be less than or equal to the value of the DnsLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the DNS log files. @@ -443,7 +479,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -453,13 +488,15 @@ Accept wildcard characters: False ``` ### -DnsLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogPath parameter specifies the DNS log directory location. The default value is blank ($null), which indicates no location is configured. If you enable DNS logging, you need to specify a local file path for the DNS log files by using this parameter. If the path contains spaces, enclose the entire path value in quotation marks ("). ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -469,13 +506,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -485,13 +524,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalDNSAdapterEnabled parameter specifies one or more Domain Name System (DNS) servers that Exchange uses for external DNS lookups. When the ExternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations outside the Exchange organization are performed by using the DNS settings of the external network adapter specified by the value of the ExternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for external Exchange DNS lookups only, you must specify the DNS servers by using the ExternalDNSServers parameter, and you must also set the value of the ExternalDNSAdapterEnabled parameter to $false. The default value of the ExternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -501,7 +542,10 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterGuid -The ExternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of destinations that exist outside the Exchange organization. The concept of an external network adapter and an internal network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and external DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for external DNS lookups. The default value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ExternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of destinations that exist outside the Exchange organization. The concept of an external network adapter and an internal network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and external DNS lookups are performed by using the DNS settings of any available network adapter. You might enter the GUID of a specific network adapter to use for external DNS lookups. The default value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the value of the ExternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the ExternalDNSServers parameter is used. @@ -509,7 +553,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -519,13 +562,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSProtocolOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalDNSProtocolOption parameter specifies which protocol to use when querying external DNS servers. The valid options for this parameter are Any, UseTcpOnly, and UseUdpOnly. The default value is Any. ```yaml Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -535,6 +580,9 @@ Accept wildcard characters: False ``` ### -ExternalDNSServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. You must separate IP addresses by using commas. The default value is an empty list ({}). If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the ExternalDNSServers parameter and its list of DNS servers isn't used. @@ -543,7 +591,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the Ext Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -553,13 +600,15 @@ Accept wildcard characters: False ``` ### -ExternalIPAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalIPAddress parameter specifies the IP address used in the Received message header field for every message that travels through the Front End Transport service. The IP address in the Received header field is used for hop count and routing loop detection. The IP address specified by the ExternalIPAddress parameter overrides the external network adapter's actual IP address. Typically, you would want to set the value of the ExternalIPAddress parameter to match the value of your domain's public MX record. The default value of the ExternalIPAddress parameter is blank. This means the actual IP address of the external network adapter is used in the Received header field. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -569,13 +618,15 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalDNSAdapterEnabled parameter specifies one or more DNS servers that Exchange uses for internal DNS lookups. When the InternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations inside the Exchange organization are performed by using the DNS settings of the internal network adapter specified by the value of the InternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for internal Exchange DNS lookups only, you must specify the DNS servers by using the InternalDNSServers parameter, and you must also set the value of the InternalDNSAdapterEnabled parameter to $false. The default value of the InternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -585,7 +636,10 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterGuid -The InternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of servers that exist inside the Exchange organization. The concept of an internal network adapter and an external network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and internal DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for internal DNS lookups. The default value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The InternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of servers that exist inside the Exchange organization. The concept of an internal network adapter and an external network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and internal DNS lookups are performed by using the DNS settings of any available network adapter. You might enter the GUID of a specific network adapter to use for internal DNS lookups. The default value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the InternalDNSAdapterEnabled parameter is set to $false, the value of the InternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the InternalDNSServers parameter is used. @@ -593,7 +647,6 @@ If the value of the InternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -603,6 +656,9 @@ Accept wildcard characters: False ``` ### -InternalDNSProtocolOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalDNSProtocolOption parameter specifies which protocol to use when you query internal DNS servers. Valid options for this parameter are Any, UseTcpOnly, or UseUdpOnly. The default value is Any. @@ -611,7 +667,6 @@ The default value is Any. Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -621,6 +676,9 @@ Accept wildcard characters: False ``` ### -InternalDNSServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalDNSServers parameter specifies the list of DNS servers that should be used when resolving a domain name. DNS servers are specified by IP address and are separated by commas. The default value is any empty list ({}). If the InternalDNSAdapterGuid parameter is set, and the value of the InternalDNSAdapterEnabled parameter is set to $true, the InternalDNSServers parameter and its list of DNS servers isn't used. @@ -629,7 +687,6 @@ If the InternalDNSAdapterGuid parameter is set, and the value of the InternalDNS Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -639,16 +696,18 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorProtocolLoggingLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging on the implicit and invisible intra-organization Send connector In the Front End Transport service. Valid values are: - None: Protocol logging is disabled for the intra-organization Send connector in the Front End Transport service. -- Verbose: Protocol logging is enabled for the intra-organization Send connector in the Front End Transport service. This is the default value. The location of the log files is controlled by the SendProtocolLogPath parameter. +- Verbose: Protocol logging is enabled for the intra-organization Send connector in the Front End Transport service. This value is the default. The location of the log files is controlled by the SendProtocolLogPath parameter. ```yaml Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -658,13 +717,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionRatePerMinute + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConnectionRatePerMinute parameter specifies the maximum rate that connections are allowed to be opened with the transport service. If many connections are attempted with the transport service at the same time, the MaxConnectionRatePerMinute parameter limits the rate that the connections are opened so that the server's resources aren't overwhelmed. The default value is 1200 connections per minute. The valid input range for this parameter is from 1 through 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -674,6 +735,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Receive connectors in the Transport service on the server. Log files that are older than the specified value are automaticallydeleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -686,7 +750,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -696,6 +759,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Receive connectors in the Front End Transport service on the server. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -708,7 +774,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be greater than or equal to the value of the ReceiveProtocolLogMaxFileSize parameter. @@ -718,7 +784,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -728,6 +793,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all Receive connectors in the Front End Transport service on the server. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -740,7 +808,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be less than or equal to the value of the ReceiveProtocolLogMaxDirectorySize parameter. @@ -750,7 +818,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -760,6 +827,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogPath parameter specifies the location of the protocol log directory for all Receive connectors in the Front End Transport service on the server. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\ProtocolLog\\SmtpReceive. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for any Receive connector in the Front End Transport service. To disable protocol logging for Receive connectors, use the value None for the ProtocolLoggingLevel parameter on the Set-ReceiveConnector cmdlet for each Receive connector in the Front End Transport service. @@ -768,7 +838,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -778,6 +847,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxAge + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogMaxAge parameter specifies the maximum routing table log age. Log files older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -788,7 +860,6 @@ For example, to specify 5 days for this parameter, use 5.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -798,6 +869,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxDirectorySize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the routing table log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -808,7 +882,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the routing table log directory. @@ -816,7 +890,6 @@ The valid input range for this parameter is from 1 through 9223372036854775807 b Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -826,13 +899,15 @@ Accept wildcard characters: False ``` ### -RoutingTableLogPath + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\Routing. Setting this parameter to $null disables routing table logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -842,6 +917,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Send connectors in the Front End Transport service that have this server configured as a source server. Log files that are older than the specified value are deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -854,7 +932,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -864,6 +941,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Send connectors in the Front End Transport service that have this server configured as a source server. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -876,7 +956,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be greater than or equal to the value of the SendProtocolLogMaxDirectorySize parameter. @@ -886,7 +966,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -896,6 +975,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all the Send connectors in the Front End Transport service that have this server configured as a source server. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -908,7 +990,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be less than or equal to the value of the SendProtocolLogMaxDirectorySize parameter. @@ -918,7 +1000,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -928,6 +1009,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogPath parameter specifies the location of the protocol log directory for all Send connectors in the Front End Transport service that have this server configured as a source server. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\ProtocolLog\\SmtpSend. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for any Send connector in the Front End Transport service that has this server configured as a source server. To disable protocol logging for these Send connectors, use the value None for the following parameters: @@ -939,7 +1023,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -949,13 +1032,15 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryCount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransientFailureRetryCount parameter specifies the maximum number of immediate connection retries attempted when the server encounters a connection failure with a remote server. The default value is 6. The valid input range for this parameter is from 0 through 15. When the value of this parameter is set to 0, the server doesn't immediately attempt to retry an unsuccessful connection. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -965,6 +1050,9 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransientFailureRetryInterval parameter controls the connection interval between each connection attempt specified by the TransientFailureRetryCount parameter. For the Front End Transport service, the default value of the TransientFailureRetryInterval parameter 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. @@ -975,7 +1063,6 @@ For example, to specify 8 minutes for this parameter, use 00:08:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -985,13 +1072,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-GlobalAddressList.md b/exchange/exchange-ps/ExchangePowerShell/Set-GlobalAddressList.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-GlobalAddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Set-GlobalAddressList.md index b4bbb3747e..427add54fe 100644 --- a/exchange/exchange-ps/exchange/Set-GlobalAddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-GlobalAddressList.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-globaladdresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-GlobalAddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-globaladdresslist +schema: 2.0.0 +title: Set-GlobalAddressList --- # Set-GlobalAddressList ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-GlobalAddressList cmdlet to modify an existing global address list (GAL). @@ -64,7 +65,7 @@ To create flexible filters that use any available recipient property and that ar You can't use this cmdlet to replace a precanned filter with a custom OPATH filter, or vice-versa. You can only modify the existing filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,6 +79,9 @@ This example assigns a new name, GALwithNewName, to the GAL with the GUID 96d0c5 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the global address list that you want to modify. You can use any value that uniquely identifies the GAL. For example: - Name @@ -88,7 +92,6 @@ The Identity parameter specifies the global address list that you want to modify Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -110,7 +116,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -132,7 +140,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -154,7 +164,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -176,7 +188,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -198,7 +212,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,6 +221,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -220,7 +236,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +245,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -242,7 +260,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -252,6 +269,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -264,7 +284,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -274,6 +293,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -286,7 +308,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -296,6 +317,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -308,7 +332,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -318,6 +341,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -330,7 +356,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -340,6 +365,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -352,7 +380,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -362,6 +389,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -374,7 +404,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -384,6 +413,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -396,7 +428,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -406,6 +437,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -418,7 +452,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -428,6 +461,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -440,7 +476,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -450,6 +485,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -462,7 +500,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -472,6 +509,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -484,7 +524,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -494,6 +533,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -503,7 +545,6 @@ 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 Required: False Position: Named @@ -513,6 +554,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -521,7 +565,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -531,6 +574,9 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. @@ -539,7 +585,6 @@ The ForceUpgrade switch suppresses the confirmation message that appears if the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -549,6 +594,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -564,7 +612,6 @@ You can specify multiple values separated by commas. When you use multiple value Type: WellKnownRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -574,13 +621,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name of the GAL. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -590,6 +639,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -605,7 +657,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -615,6 +666,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientFilter parameter specifies an OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -630,7 +684,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -640,13 +693,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Group.md b/exchange/exchange-ps/ExchangePowerShell/Set-Group.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-Group.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Group.md index 25c66b6124..3e23d3c7be 100644 --- a/exchange/exchange-ps/exchange/Set-Group.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Group.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-group -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-Group -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-group +schema: 2.0.0 +title: Set-Group --- # Set-Group ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-Group cmdlet to modify group object settings. If the group is a mail-enabled security group or a distribution group, you can use the Set-DistributionGroup cmdlet to modify other Microsoft Exchange settings that aren't available by using the Set-Group cmdlet. @@ -44,7 +45,7 @@ Set-Group [-Identity] ## DESCRIPTION You can't use the Set-Group cmdlet to modify dynamic distribution groups. To modify dynamic distribution groups, use the Set-DynamicDistributionGroup cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,11 +65,14 @@ Add a Notes parameter value of verified. Set-Group -Identity "Human Resources" -IsHierarchicalGroup $true -SeniorityIndex 1 ``` -This example specifies that the group Human Resources is a hierarchical group and will display last within its hierarchy because its index number is 1. +This example specifies that the group Human Resources is a hierarchical group and displays last within its hierarchy because its index number is 1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name @@ -80,7 +84,6 @@ The Identity parameter specifies the group that you want to modify. You can use Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -101,7 +107,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -120,7 +128,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill Description Description }} @@ -138,7 +148,6 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only if the group is mail-enabled. @@ -156,7 +168,6 @@ This parameter is meaningful only if the group is mail-enabled. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -176,7 +190,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,6 +199,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -199,7 +215,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -IsHierarchicalGroup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The IsHierarchicalGroup parameter specifies whether the group is part of a hierarchical address book. Valid values are $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -225,6 +242,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies an owner for the group. A group must have at least one owner. If you don't use this parameter to specify the owner when you create the group, the user account that created the group is the owner. The group owner is able to: - Modify the properties of the group @@ -258,7 +278,6 @@ Owners that you specify with this parameter are not added as group members. You Type: GeneralRecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -268,13 +287,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the group. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -284,13 +305,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,13 +323,15 @@ Accept wildcard characters: False ``` ### -PhoneticDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -316,13 +341,15 @@ Accept wildcard characters: False ``` ### -SeniorityIndex -The SeniorityIndex parameter specifies the order in which this group will display in a hierarchical address book. A group with a value of 2 will display higher in an address book than a group with a value of 1. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + +The SeniorityIndex parameter specifies the order in which this group displays in a hierarchical address book. A group with a value of 2 displays higher in an address book than a group with a value of 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -332,6 +359,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -346,7 +376,6 @@ This parameter is meaningful only if the group is mail-enabled. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -356,13 +385,15 @@ Accept wildcard characters: False ``` ### -Universal + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Universal switch changes the scope of the group from Global or DomainLocal to Universal. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -372,13 +403,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -388,6 +421,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -399,7 +435,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-HoldCompliancePolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HoldCompliancePolicy.md index 58775d1fd5..275525196e 100644 --- a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HoldCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-holdcompliancepolicy applicable: Security & Compliance -title: Set-HoldCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-holdcompliancepolicy +schema: 2.0.0 +title: Set-HoldCompliancePolicy --- # Set-HoldCompliancePolicy @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Set-HoldCompliancePolicy cmdlet to modify existing preservation policies in the Microsoft Purview compliance portal. -**Note**: The Set-HoldCompliancePolicy cmdlet has been replaced by the Set-RetentionCompliancePolicy cmdlet. If you have scripts that use Set-HoldCompliancePolicy, update them to use Set-RetentionCompliancePolicy. +**Note**: The Set-HoldCompliancePolicy cmdlet is replaced by the Set-RetentionCompliancePolicy cmdlet. If you have scripts that use Set-HoldCompliancePolicy, update them to use Set-RetentionCompliancePolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -63,13 +64,16 @@ Set-HoldCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchangeLocat This example makes the following changes to the existing preservation policy named "Regulation 123 Compliance": - Adds the mailbox for the user named Kitty Petersen. -- Adds the SharePoint Online site `https://contoso.sharepoint.com/sites/teams/finance`. +- Adds the SharePoint site `https://contoso.sharepoint.com/sites/teams/finance`. - Removes public folders. - Updates the comment. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -80,7 +84,6 @@ The Identity parameter specifies the preservation policy that you want to modify Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -90,7 +93,10 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. + +> Applicable: Security & Compliance + +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -100,7 +106,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes. Valid values are: - A mailbox @@ -128,7 +136,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -AddPublicFolderLocation + +> Applicable: Security & Compliance + The AddPublicFolderLocation parameter specifies that you want to add all public folders to the preservation policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -154,17 +163,19 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation -The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -SharePoint Online sites can't be added to the policy until they have been indexed. +SharePoint sites can't be added to the policy until they have been indexed. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -174,13 +185,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -190,6 +203,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -199,7 +215,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -209,16 +224,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -236,7 +256,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -246,6 +265,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter specifies the existing mailboxes to remove from the policy. Valid values are: - A mailbox @@ -264,7 +286,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -274,13 +295,15 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation + +> Applicable: Security & Compliance + The RemovePublicFolderLocation parameter specifies that you want to remove all public folders from the preservation policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -290,7 +313,10 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation -The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -298,7 +324,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -308,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-HoldComplianceRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-HoldComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HoldComplianceRule.md index e86f4d51b9..bebc71dc17 100644 --- a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HoldComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-holdcompliancerule applicable: Security & Compliance -title: Set-HoldComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-holdcompliancerule +schema: 2.0.0 +title: Set-HoldComplianceRule --- # Set-HoldComplianceRule @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Set-HoldComplianceRule cmdlet to modify existing preservation rules in the Microsoft Purview compliance portal. -**Note**: The Set-HoldComplianceRule cmdlet has been replaced by the Set-RetentionComplianceRule cmdlet. If you have scripts that use Set-HoldComplianceRule, update them to use Set-RetentionComplianceRule. +**Note**: The Set-HoldComplianceRule cmdlet is replaced by the Set-RetentionComplianceRule cmdlet. If you have scripts that use Set-HoldComplianceRule, update them to use Set-RetentionComplianceRule. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -51,6 +52,9 @@ This example changes the hold duration for the existing preservation rule named ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the preservation rule that you want to modify. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -96,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -ContentDateFrom + +> Applicable: Security & Compliance + 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". @@ -114,7 +124,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -ContentDateTo + +> Applicable: Security & Compliance + 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". @@ -132,7 +144,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -150,7 +164,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -160,13 +173,15 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the preservation rule is enabled or disabled. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -176,6 +191,9 @@ Accept wildcard characters: False ``` ### -HoldContent + +> Applicable: Security & Compliance + The HoldContent parameter specifies the hold duration for the preservation rule. Valid values are: - An integer: The hold duration in days. @@ -185,7 +203,6 @@ The HoldContent parameter specifies the hold duration for the preservation rule. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -195,19 +212,21 @@ Accept wildcard characters: False ``` ### -HoldDurationDisplayHint + +> Applicable: Security & Compliance + The HoldDurationDisplayHint parameter specifies the units that are used to display the preservation duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. - Days - Months - Years -For example, if this parameter is set to the value Years, and the HoldContent parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal displays 1 year as the content hold duration. ```yaml Type: HoldDurationHint Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -217,13 +236,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-HostedConnectionFilterPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HostedConnectionFilterPolicy.md index 83888c656c..015064fe09 100644 --- a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HostedConnectionFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedconnectionfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-HostedConnectionFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hostedconnectionfilterpolicy +schema: 2.0.0 +title: Set-HostedConnectionFilterPolicy --- # Set-HostedConnectionFilterPolicy @@ -34,7 +35,7 @@ Set-HostedConnectionFilterPolicy [-Identity] Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the connection filter policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -73,7 +77,6 @@ Typically, you only have one connection filter policy: the default policy named Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -83,13 +86,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). The maximum length is 255 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -ConfigurationXmlRaw + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -124,7 +134,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -134,17 +143,15 @@ Accept wildcard characters: False ``` ### -EnableSafeList -The EnableSafeList parameter enables or disables use of the safe list. The safe list is a dynamic allow list in the Microsoft datacenter that requires no customer configuration. Valid values are: -$true: Use the safe list to skip spam filtering on messages from trusted senders that are identified by various third-party sources that Microsoft subscribes to. +> Applicable: Exchange Online, Exchange Online Protection -$false: Don't use the safe list. This is the default value. +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -154,7 +161,9 @@ Accept wildcard characters: False ``` ### -IPAllowList -The IPAllowList parameter specifies IP addresses from which messages are always allowed. Messages from the IP addresses you specify won't be identified as spam, despite any other spam characteristics of the messages. Valid values are: +> Applicable: Exchange Online, Exchange Online Protection + +The IPAllowList parameter specifies IP addresses from which messages are always allowed. Messages from the IP addresses you specify aren't identified as spam, despite any other spam characteristics of the messages. Valid values are: - Single IP address: For example, 192.168.1.1. - IP address range: You can use an IP address range, for example, 192.168.0.1-192.168.0.254. The maximum number of addresses in the range is 256. @@ -168,7 +177,6 @@ You can specify multiple IP addresses of the same type separated by commas. For Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -178,6 +186,9 @@ Accept wildcard characters: False ``` ### -IPBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The IPBlockList parameter specifies IP addresses from which messages are never allowed. Messages from the IP addresses you specify are blocked without any further spam scanning. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -192,7 +203,6 @@ You can specify multiple IP addresses of the same type separated by commas. For Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -202,13 +212,15 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -218,13 +230,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterPolicy.md index 64de11808a..65a16298ad 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedcontentfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-HostedContentFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hostedcontentfilterpolicy +schema: 2.0.0 +title: Set-HostedContentFilterPolicy --- # Set-HostedContentFilterPolicy @@ -83,7 +84,7 @@ Set-HostedContentFilterPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). For more information about the limits for allowed and blocked senders, see [Exchange Online Protection Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-protection-service-description/exchange-online-protection-limits). @@ -102,6 +103,9 @@ This example modifies the spam filter policy named Contoso Executives with the f ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -112,7 +116,6 @@ The Identity parameter specifies the spam filter policy that you want to modify. Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -122,6 +125,9 @@ Accept wildcard characters: False ``` ### -AddXHeaderValue + +> Applicable: Exchange Online, Exchange Online Protection + The AddXHeaderValue parameter specifies the X-header name (not value) to add to spam messages when a spam filtering verdict parameter is set to the value AddXHeader. The following spam filtering verdict parameters can use the AddXHeader action: - BulkSpamAction @@ -135,13 +141,12 @@ For example, if you enter the value `This-is-my-custom-header`, the X-header tha If you enter a value that contains spaces or colons (:), the value is ignored, and the default X-header is added to the message (`X-This-Is-Spam: This message appears to be spam.`). -Note that this setting is independent of the AddXHeader value of the TestModeAction parameter. +This setting is independent of the AddXHeader value of the TestModeAction parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,13 +156,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,6 +174,9 @@ Accept wildcard characters: False ``` ### -AllowedSenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/create-safe-sender-lists-in-office-365). @@ -179,7 +189,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -189,6 +198,9 @@ Accept wildcard characters: False ``` ### -AllowedSenders + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/create-safe-sender-lists-in-office-365). @@ -201,7 +213,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -211,6 +222,9 @@ Accept wildcard characters: False ``` ### -BlockedSenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/create-block-sender-lists-in-office-365). @@ -223,7 +237,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +246,9 @@ Accept wildcard characters: False ``` ### -BlockedSenders + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/create-block-sender-lists-in-office-365). @@ -245,7 +261,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,6 +270,9 @@ Accept wildcard characters: False ``` ### -BulkQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The BulkQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as bulk email (the BulkSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -271,7 +289,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -281,12 +298,15 @@ Accept wildcard characters: False ``` ### -BulkSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The BulkSpamAction parameter specifies the action to take on messages that are marked as bulk email (also known as gray mail) based on the bulk complaint level (BCL) of the message, and the BCL threshold you configure in the BulkThreshold parameter. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: This is the default value. Deliver the message to the 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). +- MoveToJmf: This value is the default. Deliver the message to the Junk Email folder in the recipient's mailbox. Hybrid environments need mail flow rules in the 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: 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. @@ -295,7 +315,6 @@ The BulkSpamAction parameter specifies the action to take on messages that are m Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -305,7 +324,10 @@ 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. + +> Applicable: Exchange Online, Exchange Online Protection + +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 triggers the action 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/defender-office-365/anti-spam-bulk-complaint-level-bcl-about). @@ -313,7 +335,6 @@ A higher BCL indicates the message is more likely to generate complaints (and is Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,6 +344,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -332,7 +356,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -342,13 +365,15 @@ Accept wildcard characters: False ``` ### -DownloadLink -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -358,13 +383,15 @@ Accept wildcard characters: False ``` ### -EnableEndUserSpamNotifications -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -374,16 +401,18 @@ Accept wildcard characters: False ``` ### -EnableLanguageBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The EnableLanguageBlockList parameter enables or disables marking messages that were written in specific languages as spam. Valid values are: - $true: Mark messages hat were written in the languages specified by the LanguageBlockList parameter as spam. -- $false: Don't mark messages as spam solely based on their languages. This is the default value. +- $false: Don't mark messages as spam solely based on their languages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -393,16 +422,18 @@ Accept wildcard characters: False ``` ### -EnableRegionBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The EnableRegionBlockList parameter enables or disables marking messages that are sent from specific countries or regions as spam. Valid values are: - $true: Mark messages from senders in the RegionBlockList parameter as spam. -- $false: Don't mark messages as spam solely based on the source country or region. This is the default value. +- $false: Don't mark messages as spam solely based on the source country or region. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -412,13 +443,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -428,13 +461,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromName -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -444,13 +479,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomSubject -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -460,12 +497,14 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -475,13 +514,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLanguage -This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is deprecated and no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: EsnLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -491,13 +532,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLimit + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -507,6 +550,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishAction + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. @@ -516,7 +562,6 @@ The HighConfidencePhishAction parameter specifies the action to take on messages Type: PhishFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -526,6 +571,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence phishing (the HighConfidencePhishAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -542,7 +590,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -552,12 +599,15 @@ Accept wildcard characters: False ``` ### -HighConfidenceSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidenceSpamAction parameter specifies the action to take on messages that are marked as high confidence spam (not spam, bulk email, phishing, or high confidence phishing). Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: Deliver the message to the 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). +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. Hybrid environments need mail flow rules in the 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. @@ -565,7 +615,6 @@ The HighConfidenceSpamAction parameter specifies the action to take on messages Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -575,6 +624,9 @@ Accept wildcard characters: False ``` ### -HighConfidenceSpamQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence spam (the HighConfidenceSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -591,7 +643,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -601,17 +652,19 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithBizOrInfoUrls + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Not all messages that match this setting will be marked as spam. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. +- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Not all messages that match this setting are marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -621,17 +674,19 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithImageLinks + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain image links to remote websites are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. Not all messages that match this setting will be marked as spam. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. +- On: The setting is enabled. Messages that contain image links to remote websites are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. Not all messages that match this setting aree marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -641,9 +696,12 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithNumericIps + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain links to IP addresses are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -651,7 +709,6 @@ The IncreaseScoreWithNumericIps parameter increases the spam score of messages t Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -661,9 +718,12 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithRedirectToOtherPort + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -671,7 +731,6 @@ The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of m Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -681,16 +740,18 @@ Accept wildcard characters: False ``` ### -InlineSafetyTipsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The InlineSafetyTipsEnabled parameter specifies whether to enable or disable safety tips that are shown to recipients in messages. Valid values are: -- $true: Safety tips are enabled. This is the default value. +- $true: Safety tips are enabled. This value is the default. - $false: Safety tips are disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -700,9 +761,12 @@ Accept wildcard characters: False ``` ### -IntraOrgFilterState + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- Default: This value is the default. Currently, HighConfidencePhish. - HighConfidencePhish - Phish: Includes phishing and high confidence phishing. - HighConfidenceSpam: Includes high confidence spam, phishing, and high confidence phishing. @@ -713,7 +777,6 @@ The IntraOrgFilterState parameter specifies whether to enable anti-spam filterin Type: IntraOrgFilterState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -723,6 +786,9 @@ Accept wildcard characters: False ``` ### -LanguageBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported uppercase ISO 639-1 two-letter language code: AF, AR, AZ, BE, BG, BN, BR, BS, CA, CS, CY, DA, DE, EL, EN, EO, ES, ET, EU, FA, FI, FO, FR, FY, GA, GL, GU, HA, HE, HI, HR, HU, HY, ID, IS, IT, JA, KA, KK, KL, KN, KO, KU, KY, LA, LB, LT, LV, MI, MK, ML, MN, MR, MS, MT, NB, NL, NN, PA, PL, PS, PT, RM, RO, RU, SE, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TL, TR, UK, UR, UZ, VI, WEN, YI, ZH-CN, ZH-TW, and ZU. @@ -739,7 +805,6 @@ To empty the list, use the value $null. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -749,6 +814,9 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Online, Exchange Online Protection + The MakeDefault switch makes the specified spam filter policy the default spam filter policy. You don't need to specify a value with this switch. The default spam filter policy is applied to everyone (no corresponding spam filter rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). @@ -757,7 +825,6 @@ The default spam filter policy is applied to everyone (no corresponding spam fil Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -767,17 +834,19 @@ Accept wildcard characters: False ``` ### -MarkAsSpamBulkMail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamBulkMail parameter allows spam filtering to act on bulk email messages. Valid values are: - Off: The message is stamped with the BCL, but no action is taken for a bulk email filtering verdict. In effect, the values of the BulkThreshold and BulkSpamAction parameters are irrelevant. -- On: This is the default value. A BCL that's greater than the BulkThreshold value is converted to an SCL 6 that corresponds to a filtering verdict of spam, and the BulkSpamAction value is taken on the message. +- On: This value is the default. A BCL that's greater than the BulkThreshold value is converted to an SCL 6 that corresponds to a filtering verdict of spam, and the BulkSpamAction value is taken on the message. - Test: This value is available, but isn't used for this parameter. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -787,9 +856,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmbedTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain HTML \ tags are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Embed tag in html` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -797,7 +869,6 @@ The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -807,9 +878,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmptyMessages + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Empty messages are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Empty Message` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -817,7 +891,6 @@ The MarkAsSpamEmptyMessages parameter marks a message as spam when the message c Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -827,9 +900,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFormTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain HTML \ tags are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Form tag in html` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -837,7 +913,6 @@ The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -847,9 +922,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFramesInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML \ or \ tags. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain HTML \ or \ tags are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: IFRAME or FRAME in HTML` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -857,7 +935,6 @@ The MarkAsSpamFramesInHtml parameter marks a message as spam when the message co Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -867,16 +944,18 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFromAddressAuthFail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages where Sender ID filtering encounters a hard fail are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: SPF From Record Fail` is added to the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -886,9 +965,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamJavaScriptInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain JavaScript or VBScript are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Javascript or VBscript tags in HTML` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -896,7 +978,6 @@ The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the messag Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -906,16 +987,18 @@ Accept wildcard characters: False ``` ### -MarkAsSpamNdrBackscatter + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as *backscatter*). Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Backscatter is given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Backscatter NDR` is added to the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -925,9 +1008,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamObjectTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain HTML \ tags are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Object tag in html` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -935,7 +1021,6 @@ The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the messag Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -945,9 +1030,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSensitiveWordList + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain words from the sensitive word list in the subject or message body are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Sensitive word in subject/body` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -955,7 +1043,6 @@ The MarkAsSpamSensitiveWordList parameter marks a message as spam when the messa Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -965,16 +1052,18 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSpfRecordHardFail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages sent from an IP address that isn't specified in the SPF Sender Policy Framework (SPF) record in DNS are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: SPF Record Fail` is added to the message. ```yaml Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -984,9 +1073,12 @@ Accept wildcard characters: False ``` ### -MarkAsSpamWebBugsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: -- Off: The setting is disabled. This is the default value, and we recommend that you don't change it. +- Off: The setting is disabled. This value is the default, and we recommend that you don't change it. - On: The setting is enabled. Messages that contain web bugs are given the SCL 9 (high confidence spam), and the X-header `X-CustomSpam: Web bug` is added to the message. - Test: The action specified by the TestModeAction parameter is taken on the message. @@ -994,7 +1086,6 @@ The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message c Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1004,6 +1095,9 @@ Accept wildcard characters: False ``` ### -ModifySubjectValue + +> Applicable: Exchange Online, Exchange Online Protection + The ModifySubjectValue parameter specifies the text to prepend to the existing subject of messages when a spam filtering verdict parameter is set to the value ModifySubject. The following spam filtering verdict parameters can use the ModifySubject action: - BulkSpamAction @@ -1017,7 +1111,6 @@ If the value contains spaces, enclose the value in quotation marks ("). Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1027,6 +1120,9 @@ Accept wildcard characters: False ``` ### -PhishQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The PhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as phishing (the PhishSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -1043,7 +1139,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1053,6 +1148,9 @@ Accept wildcard characters: False ``` ### -PhishSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The PhishSpamAction parameter specifies the action to take on messages that are marked as phishing (not high confidence phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. @@ -1066,7 +1164,6 @@ The PhishSpamAction parameter specifies the action to take on messages that are Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1076,9 +1173,12 @@ Accept wildcard characters: False ``` ### -PhishZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The PhishZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect phishing in already delivered messages in Exchange Online mailboxes. Valid values are: -- $true: ZAP for phishing messages is enabled. This is the default value. The result depends on the spam filtering verdict action for phishing messages: MoveToJmf = Read and unread phishing messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Read and unread phishing messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. +- $true: ZAP for phishing messages is enabled. This value is the default. The result depends on the spam filtering verdict action for phishing messages: MoveToJmf = Read and unread phishing messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Read and unread phishing messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. - $false: ZAP for phishing messages is disabled. You configure ZAP for spam with the SpamZapEnabled parameter. @@ -1087,7 +1187,6 @@ You configure ZAP for spam with the SpamZapEnabled parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1097,6 +1196,9 @@ Accept wildcard characters: False ``` ### -QuarantineRetentionPeriod + +> Applicable: Exchange Online, Exchange Online Protection + The QuarantineRetentionPeriod parameter specifies the number of days that spam messages remain in quarantine when a spam filtering verdict parameter is set to the value Quarantine. All spam filtering verdict parameters can use the Quarantine action: - BulkSpamAction @@ -1113,7 +1215,6 @@ After the time period expires, the message is deleted. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1123,6 +1224,9 @@ Accept wildcard characters: False ``` ### -RedirectToRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The RedirectToRecipients parameter specifies the email addresses of replacement recipients when a spam filtering verdict parameter is set to the value Redirect. The following spam filtering verdict parameters can use the Redirect action: - BulkSpamAction @@ -1136,7 +1240,6 @@ You can specify multiple email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1146,6 +1249,9 @@ Accept wildcard characters: False ``` ### -RegionBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The RegionBlockList parameter specifies the source countries or regions that are marked as spam when the EnableRegionBlockList parameter value is $true. A valid value is a supported ISO 3166-1 two-letter country code: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XE, XJ, XS, YE, YT, ZA, ZM, and ZW. @@ -1162,7 +1268,6 @@ To empty the list, use the value $null. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1172,12 +1277,15 @@ Accept wildcard characters: False ``` ### -SpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The SpamAction parameter specifies the action to take on messages that are marked as spam (not high confidence spam, bulk email, phishing, or high confidence phishing). Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete : Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: 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). +- MoveToJmf: This value is the default. Deliver the message to the Junk Email folder in the recipient's mailbox. Hybrid environments need mail flow rules in the 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. @@ -1185,7 +1293,6 @@ The SpamAction parameter specifies the action to take on messages that are marke Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1195,6 +1302,9 @@ Accept wildcard characters: False ``` ### -SpamQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The SpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as spam (the SpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -1211,7 +1321,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1221,9 +1330,12 @@ Accept wildcard characters: False ``` ### -SpamZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SpamZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect spam in already delivered messages in Exchange Online mailboxes. Valid values are: -- $true: ZAP for spam is enabled. This is the default value. The result depends on the spam filtering verdict action for spam messages: MoveToJmf = Unread spam messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Unread spam messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. +- $true: ZAP for spam is enabled. This value is the default. The result depends on the spam filtering verdict action for spam messages: MoveToJmf = Unread spam messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Unread spam messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. - $false: ZAP for spam is disabled. You configure ZAP for phishing messages with the PhishZapEnabled parameter. @@ -1232,7 +1344,6 @@ You configure ZAP for phishing messages with the PhishZapEnabled parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1242,9 +1353,12 @@ Accept wildcard characters: False ``` ### -TestModeAction + +> Applicable: Exchange Online, Exchange Online Protection + The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\* or MarkAsSpam\* ASF parameters are set to the value Test. Valid values are: -- None: This is the default value, and we recommend that you don't change it. +- None: This value is the default, and we recommend that you don't change it. - AddXHeader: The X-header value `X-CustomSpam: This message was filtered by the custom spam filter option` is added to the message. - BccMessage: Redirect the message to the recipients specified by the TestModeBccToRecipients parameter. @@ -1252,7 +1366,6 @@ The TestModeAction parameter specifies the additional action to take on messages Type: SpamFilteringTestModeAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1262,6 +1375,9 @@ Accept wildcard characters: False ``` ### -TestModeBccToRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. Valid input for this parameter is an email address. Separate multiple email addresses with commas. @@ -1272,7 +1388,6 @@ This parameter is meaningful only when the value of the TestModeAction parameter Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1282,13 +1397,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterRule.md index 991cf73ca1..d2689d5311 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection -title: Set-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hostedcontentfilterrule +schema: 2.0.0 +title: Set-HostedContentFilterRule --- # Set-HostedContentFilterRule @@ -41,7 +42,7 @@ Set-HostedContentFilterRule [-Identity] > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Use the Microsoft Defender portal to create anti-spam policies](https://learn.microsoft.com/defender-office-365/anti-spam-policies-configure#use-the-microsoft-defender-portal-to-create-anti-spam-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example adds an exception to the spam filter rule named Contoso Recipients ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the spam filter rule that you want to modify. Y Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -100,7 +108,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception for the rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -141,7 +153,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception for the rule that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -168,7 +182,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -HostedContentFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedContentFilterPolicy parameter specifies the spam filter policy (content filter policy) that's associated with the rule. You can use any value that uniquely identifies the policy. For example, you can specify the name, GUID, or distinguished name (DN) of the spam filter policy. @@ -188,7 +204,6 @@ You can't specify the default spam filter policy. And, you can't specify a spam Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. @@ -206,7 +224,6 @@ Don't use the following characters in the name value: `\ % & * + / = ? { } | < > Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -216,6 +233,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -230,7 +250,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -240,13 +259,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -256,6 +277,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition for the rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -271,7 +295,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -281,6 +304,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -298,7 +324,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -308,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterPolicy.md similarity index 75% rename from exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterPolicy.md index b97b7a0c6f..bc15d5b3d0 100644 --- a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-HostedOutboundSpamFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hostedoutboundspamfilterpolicy +schema: 2.0.0 +title: Set-HostedOutboundSpamFilterPolicy --- # Set-HostedOutboundSpamFilterPolicy @@ -38,7 +39,7 @@ Set-HostedOutboundSpamFilterPolicy [-Identity] Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter policy you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the outbound spam filter policy you want to mod Type: HostedOutboundSpamFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -75,18 +78,20 @@ Accept wildcard characters: False ``` ### -ActionWhenThresholdReached + +> Applicable: Exchange Online, Exchange Online Protection + The ActionWhenThresholdReach parameter specifies the action to take when any of the limits specified in the policy are reached. Valid values are: - Alert: No action, alert only. - BlockUser: Prevent the user from sending email messages. -- BlockUserForToday: Prevent the user from sending email messages until the following day. This is the default value. +- BlockUserForToday: Prevent the user from sending email messages until the following day. This value is the default. ```yaml Type: OutboundRecipientLimitsExceededAction Parameter Sets: (All) Aliases: Accepted values: Alert, BlockUserForToday, BlockUser -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,20 +119,22 @@ Accept wildcard characters: False ``` ### -AutoForwardingMode + +> Applicable: Exchange Online, Exchange Online Protection + 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/defender-office-365/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 value is the default. 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 Parameter Sets: (All) Aliases: Accepted values: Automatic, Off, On -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -BccSuspiciousOutboundAdditionalRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The BccSuspiciousOutboundAdditionalRecipients parameter specifies an email address to add to the Bcc field of outgoing spam messages. You can specify multiple email addresses separated by commas. The specified recipients are added to the Bcc field of outgoing spam messages when the value of the BccSuspiciousOutboundMail parameter is $true. @@ -143,7 +155,6 @@ The specified recipients are added to the Bcc field of outgoing spam messages wh Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -153,16 +164,18 @@ Accept wildcard characters: False ``` ### -BccSuspiciousOutboundMail + +> Applicable: Exchange Online, Exchange Online Protection + The BccSuspiciousOutboundMail parameter specifies whether to add recipients to the Bcc field of outgoing spam messages. Valid values are: - $true: The recipients specified by the BccSuspiciousOutboundAdditionalRecipients parameter are added to outgoing spam messages. -- $false: No additional messages are added to outgoing spam messages. This is the default value. +- $false: No additional messages are added to outgoing spam messages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,6 +185,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -181,7 +197,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -191,18 +206,20 @@ 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/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). + +> Applicable: Exchange Online, Exchange Online Protection + +**Note**: This setting is 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: - $true: Notify the admins specified by the NotifyOutboundSpamRecipients parameter. -- $false: Don't send notifications. This is the default value. +- $false: Don't send notifications. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,7 +229,10 @@ 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/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). + +> Applicable: Exchange Online, Exchange Online Protection + +**Note**: This setting is 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. @@ -222,7 +242,6 @@ The specified recipients receive notifications when the value of the NotifyOutbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -232,13 +251,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitExternalPerHour + +> Applicable: Exchange Online, Exchange Online Protection + 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](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,13 +269,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitInternalPerHour + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -264,13 +287,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitPerDay + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientLimitInternalPerHour parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,13 +305,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterRule.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterRule.md index fd8d912dd6..d5d7fc9ec7 100644 --- a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: Set-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hostedoutboundspamfilterrule +schema: 2.0.0 +title: Set-HostedOutboundSpamFilterRule --- # Set-HostedOutboundSpamFilterRule @@ -38,7 +39,7 @@ Set-HostedOutboundSpamFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example adds an exception to the existing rule named Contoso Executives. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the outbound spam filter rule that you want to Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfFrom parameter specifies an exception that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -122,7 +132,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfFromMemberOf parameter specifies an exception that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: - Name @@ -147,7 +159,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -157,13 +168,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -173,6 +186,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Online, Exchange Online Protection + The From parameter specifies a condition that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -188,7 +204,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The FromMemberOf parameter specifies a condition that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: - Name @@ -213,7 +231,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -223,6 +240,9 @@ Accept wildcard characters: False ``` ### -HostedOutboundSpamFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedOutboundSpamFilterPolicy parameter specifies the outbound spam filter policy that's associated with the outbound spam filter rule. You can use any value that uniquely identifies the policy. For example: @@ -237,7 +257,6 @@ You can't specify the default outbound spam filter policy, and you can't specify Type: HostedOutboundSpamFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -247,6 +266,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the outbound spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). Don't use the following characters: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. @@ -255,7 +277,6 @@ Don't use the following characters: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -279,7 +303,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -289,13 +312,15 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -305,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HybridConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-HybridConfiguration.md similarity index 50% rename from exchange/exchange-ps/exchange/Set-HybridConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HybridConfiguration.md index 5811e49d7f..020664f802 100644 --- a/exchange/exchange-ps/exchange/Set-HybridConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HybridConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hybridconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-HybridConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hybridconfiguration +schema: 2.0.0 +title: Set-HybridConfiguration --- # Set-HybridConfiguration @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-HybridConfiguration cmdlet to modify the hybrid deployment between your on-premises Exchange organization and Exchange Online in a Microsoft 365 for enterprises organization. +Use the Set-HybridConfiguration cmdlet to modify the hybrid deployment between your on-premises Exchange organization and Exchange Online in Microsoft 365 for enterprises. 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,9 +43,9 @@ Set-HybridConfiguration ``` ## DESCRIPTION -The Set-HybridConfiguration cmdlet modifies the hybrid configuration features, such as enabling secure mail, designating a specific Mailbox server for hybrid functionality, or enabling or disabling free/busy information sharing and message tracking between the on-premises Exchange and Exchange Online organizations. +The Set-HybridConfiguration cmdlet modifies the hybrid configuration features, such as enabling secure mail, designating a specific Mailbox server for hybrid functionality, or enabling or disabling free/busy sharing between on-premises Exchange and Exchange Online. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,7 +54,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-HybridConfiguration -SecureMailCertificateThumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 ``` -In Exchange Server 2010, this example specifies that the hybrid configuration will use the certificate with the thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 as the certificate for Secure Mail messaging. +In Exchange Server 2010, this example specifies the hybrid configuration uses the certificate with the thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 as the certificate for Secure Mail messaging. ### Example 2 ```powershell @@ -72,19 +73,23 @@ This example specifies that the hybrid deployment uses a defined TLS certificate ## PARAMETERS ### -ClientAccessServers -This parameter is functional only in Exchange Server 2010. -The ClientAccessServers parameter specifies the Exchange 2010 SP2 or later servers with the Client Access server role installed that will be configured to support the hybrid deployment features. At least one Client Access server must be defined and be externally accessible from the Internet on ports 80 and 443. The servers will be configured to enable the following: +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is available only in Exchange Server 2010. + +The ClientAccessServers parameter specifies the Hub Transport servers in Exchange Server 2010 SP2 or later that are configured to support hybrid deployment features. You need to specify at least one Client Access server that's accessible from the internet on TCP ports 80 and 443. The servers are configured to enable the following features: -- Mailbox Replication Service (MRS) Proxy The MRS Proxy service configuration on the Client Access servers will be enabled. -- Virtual Directories The Client Access servers will host the default Web sites for the Exchange Web Services (EWS), offline address books, and ActiveSync services. -- Outlook Anywhere The Client Access servers will have Outlook Anywhere enabled. +- Mailbox Replication Service (MRS) Proxy: Enable the MRS Proxy service configuration. +- Virtual Directories: Host the default web sites for Exchange Web Services (EWS), offline address books, and ActiveSync services. +- Outlook Anywhere: Enabled. + +You can specify multiple servers separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -103,7 +111,6 @@ 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 Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +138,17 @@ Accept wildcard characters: False ``` ### -Domains -The Domains parameter specifies the domain namespaces that will be used in the hybrid deployment. These domains must be configured as accepted domains in either the on-premises Exchange organization or the Exchange Online organization. The domains will be used in configuring the organization relationships and Send and Receive connectors used by the hybrid configuration. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Domains parameter specifies the domain namespaces used in the hybrid deployment. These domains must be configured as accepted domains in either on-premises Exchange or Exchange Online. The domains are used in configuring the organization relationships and Send and Receive connectors used by the hybrid configuration. + +You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,13 +158,17 @@ Accept wildcard characters: False ``` ### -ExternalIPAddresses -The ExternalIPAddresses parameter is a legacy parameter that specifies the publicly accessible inbound IP address of Microsoft Exchange Server 2010 Hub Transport servers. The only configuration change that should be made with this parameter is to change or clear the legacy Exchange 2010 Hub Transport server IP address value. The IP address must be Internet Protocol version 4 (IPv4) based only. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ExternalIPAddresses parameter is a legacy parameter that specifies the publicly accessible inbound IP address of Microsoft Exchange Server 2010 Hub Transport servers. + +You should use this parameter to change or clear legacy Exchange 2010 Hub Transport server IP address values only. IPv6 addresses aren't supported. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,22 +178,26 @@ Accept wildcard characters: False ``` ### -Features -The Features parameter specifies the features enabled for the hybrid configuration. One or more of the following values separated by commas can be entered. When using the Hybrid Configuration wizard, all features are enabled by default. -- Centralized: Enables transport servers to handle all message transport between the on-premises Exchange and Exchange Online organizations, including external message delivery to the Internet for both organizations. If this value is $false, the on-premises transport servers and Exchange Online organization are each responsible for their own Internet message delivery. -- FreeBusy: Enables free/busy calendar information to be shared between on-premises Exchange and Exchange Online organization users. -- MailTips: Enables MailTips information to be shared between on-premises Exchange and Exchange Online organization users. -- MessageTracking: Enables message tracking information to be shared between on-premises Exchange and Exchange Online organization users. -- OnlineArchive: Enables the Exchange Online archive feature so that Exchange Online supports hosting archive mailboxes for on-premises users. -- OWARedirection: Enables automatic Microsoft Outlook on the web redirection to either the on-premises Exchange or Exchange Online organizations depending on where the user mailbox is located. -- SecureMail: Enables secure message transport via Transport Layer Security (TLS) between the on-premises Exchange and Exchange Online organizations. -- Photos: Enables the sharing of user photo data between the on-premises Exchange and Exchange Online organizations. This feature works in tandem with the PhotosEnabled parameter in the OrganizationRelationship cmdlets in a hybrid deployment. If the Photos parameter is $true, the PhotosEnabled parameter is automatically set to $true. If the Photos parameter is $false, the PhotosEnabled parameter is automatically set to $false. When running the Hybrid Configuration wizard for the first time, the default value is $true. +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Features parameter specifies the features that are enabled for the hybrid configuration. Valid values are: + +- OnlineArchive: Enables the Exchange Online archive for on-premises Exchange and Exchange Online users. +- FreeBusy: Enables calendar free/busy sharing between on-premises Exchange and Exchange Online users. +- MailTips: Enables MailTips between on-premises Exchange and Exchange Online users. +- MessageTracking: Enables message tracking between on-premises Exchange and Exchange Online. +- OWARedirection: Enables automatic Outlook on the web (formerly known as Outlook Web App or OWA) redirection to on-premises Exchange or Exchange Online, depending on where the user mailbox is located. +- SecureMail: Enables secure message transport via Transport Layer Security (TLS) between on-premises Exchange and Exchange Online. +- Centralized: Enables the on-premises Exchange servers to handle all message transport between on-premises Exchange and Exchange Online, including message delivery to the internet for both organizations. If you don't use this value, on-premises Exchange and Exchange Online are each responsible for their own internet message delivery. +- Photos: Enables the sharing of user photo data between the on-premises Exchange and Exchange Online. This feature works in tandem with the PhotosEnabled parameter in the OrganizationRelationship cmdlets in a hybrid deployment. If you use this value, the PhotosEnabled parameter is automatically set to $true. If you don't use this value, the PhotosEnabled parameter is automatically set to $false. + +You can specify multiple values separated by commas. When you use the Hybrid Configuration wizard, all features are enabled by default. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,7 +207,10 @@ Accept wildcard characters: False ``` ### -Name -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. There can be only one HybridConfiguration object in an Exchange organization. @@ -194,7 +218,6 @@ There can be only one HybridConfiguration object in an Exchange organization. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,13 +227,15 @@ Accept wildcard characters: False ``` ### -OnPremisesSmartHost -The OnPremisesSmartHost parameter specifies the FQDN of the on-premises Mailbox servers used for secure mail transport for messages sent between the on-premises Exchange and Exchange Online organizations. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The OnPremisesSmartHost parameter specifies the FQDN of the on-premises Exchange Mailbox server used for secure mail transport between on-premises Exchange and Exchange Online. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,15 +245,24 @@ Accept wildcard characters: False ``` ### -ReceivingTransportServers -The ReceivingTransportServers parameter specifies the Mailbox servers that are defined in the outbound connector configuration of the Microsoft Exchange Online Protection (EOP) service included as part of the Microsoft 365 tenant. The servers defined in the ReceivingTransportServers parameter are designated as the receiving servers for secure mail messages sent from the Exchange Online organization to the on-premises Exchange organization in a hybrid deployment. At least one Mailbox server must be defined and be externally accessible from the Internet for secure mail to be enabled between the on-premises Exchange and Exchange Online organizations. The accepted values for the ReceivingTransportServers parameter are either the full or short computer name of a Mailbox server, for example, either mbx.corp.contoso.com or MBX. Separate server names with a comma if defining more than one Mailbox server. -If configuring the EdgeTransportServers parameter in the hybrid deployment, the ReceivingTransportServers parameter value must be $null. +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ReceivingTransportServers parameter specifies the Mailbox servers defined in the outbound connector configuration in Exchange Online. Valid values are: + +- The Mailbox server FQDN (for example, mbx.corp.contoso.com). +- The Mailbox server host name (for example, MBX). + +You can specify multiple servers specified by commas. + +The specified servers receive secure email messages from Exchange Online to on-premises Exchange in a hybrid deployment. You need to specify at least one publicly accessible Mailbox server to enable secure mail. + +The value of this parameter must be blank ($null) when you use the EdgeTransportServers parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,15 +272,17 @@ Accept wildcard characters: False ``` ### -SecureMailCertificateThumbprint + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. -The SecureMailCertificateThumbprint parameter specifies the thumbprint of the X.509 certificate to be used as the certificate for hybrid deployment secure message transport. This certificate cannot be self-signed, must be obtained from a trusted certificate authority (CA), and must be installed on all Hub Transport servers defined in the TransportServers parameter. +The SecureMailCertificateThumbprint parameter specifies the thumbprint of the X.509 certificate to be used as the certificate for hybrid deployment secure message transport. This certificate can't be self-signed, must be obtained from a trusted certificate authority (CA), and must be installed on all Hub Transport servers defined in the TransportServers parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -256,15 +292,24 @@ Accept wildcard characters: False ``` ### -SendingTransportServers -The SendingTransportServers parameter specifies the Mailbox servers that are defined in the inbound connector configuration of the EOP service included as part of the Microsoft 365 tenant. The servers defined in the SendingTransportServers parameter are designated as the receiving servers for secure mail messages sent from the on-premise organization to the Exchange Online organization in a hybrid deployment. At least one Mailbox server must be defined and be externally accessible from the Internet for secure mail to be enabled between the on-premises Exchange and Exchange Online organizations. The accepted values for the SendingTransportServers parameter are either the full or short computer name of a Mailbox server, for example, either mbx.corp.contoso.com or MBX. Separate server names with a comma if defining more than one Mailbox server. -If configuring the EdgeTransportServers parameter in the hybrid deployment, the SendingTransportServers parameter value must be $null. +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The SendingTransportServers parameter specifies the Mailbox servers defined in the inbound connector configuration in Exchange Online. Valid values are: + +- The Mailbox server FQDN (for example, mbx.corp.contoso.com). +- The Mailbox server host name (for example, MBX). + +You can specify multiple servers specified by commas. + +The specified servers send secure email messages from on-premises Exchange to Exchange Online in a hybrid deployment. You need to specify at least one publicly accessible Mailbox server to enable secure mail. + +The value of this parameter must be blank ($null) when you use the EdgeTransportServers parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -274,13 +319,19 @@ Accept wildcard characters: False ``` ### -ServiceInstance -The ServiceInstance parameter should only be used by organizations manually configuring hybrid deployments with Office 365 operated by 21Vianet in China. All other organizations should use the Hybrid Configuration wizard to configure a hybrid deployment with Microsoft 365. The valid values for this parameter are 0 (null) or 1. The default value is 0 (null). For organizations connecting with Office 365 operated by 21Vianet in China, set this value to 1 when manually configuring your hybrid deployment. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is meaningful only in Office 365 operated by 21Vianet in China. + +To manually configure a hybrid deployment with Office 365 operated by 21Vianet in China, set the value of this parameter to 1. Otherwise, the default value is 0. + +All other Microsoft 365 organizations should use the Hybrid Configuration wizard to configure a hybrid deployment. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -290,13 +341,22 @@ Accept wildcard characters: False ``` ### -TlsCertificateName -The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. Valid syntax for this parameter is `"X.500IssuerX.500Subject"`: + +- `X.500Issuer`: The value in the certificate's Issuer field. +- `X.500Subject`: The value in the certificate's Subject field. + +You can find these values by running the Get-ExchangeCertificate cmdlet. + +Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, use the thumbprint value in the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value `$TLSCertName` for this parameter. ```yaml Type: SmtpX509Identifier Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -306,15 +366,21 @@ Accept wildcard characters: False ``` ### -TransportServers + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. -The TransportServers parameter specifies the Exchange Server 2010 SP2 servers with the Hub Transport server role installed that will be configured to support the hybrid deployment features. At least one Hub Transport server must be defined and be externally accessible from the Internet for secure mail to be enabled between the on-premises and cloud-based organizations. +The TransportServers parameter specifies the Hub Transport servers in Exchange Server 2010 SP2 or later that are configured to support hybrid deployment features. + +You need to specify at least one Hub Transport server that's accessible from the internet for secure mail between on-premises Exchange and Exchange Online. + +You can specify multiple servers separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -324,13 +390,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,6 +408,9 @@ Accept wildcard characters: False ``` ### -EdgeTransportServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EdgeTransportServers parameter specifies the Edge Transport servers that are configured to support the hybrid deployment features. The Edge Transport server must be externally accessible from the Internet on port 25. The accepted values for the EdgeTransportServers parameter are either the full or short computer name of an Edge Transport server, for example, either edge.corp.contoso.com or EDGE. Separate server names with a comma if defining more than one Edge Transport server. When configuring the EdgeTransportServers parameter, you must configure the ReceivingTransportServers and SendingTransportServers parameter values to $null. @@ -348,7 +419,6 @@ When configuring the EdgeTransportServers parameter, you must configure the Rece Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListConfig.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-IPAllowListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListConfig.md index 0c7a6349a0..1d6d73bd21 100644 --- a/exchange/exchange-ps/exchange/Set-IPAllowListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipallowlistconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPAllowListConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipallowlistconfig +schema: 2.0.0 +title: Set-IPAllowListConfig --- # Set-IPAllowListConfig @@ -47,6 +48,9 @@ This example configures connection filtering to use the IP Allow list on message ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -56,7 +60,6 @@ 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 Required: False Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -74,7 +80,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the IP Allow list is used for content filtering. Valid input for this parameter is $true or $false. The default value is $true. By default, the IP Allow list is used for content filtering. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalMailEnabled parameter specifies whether messages from connections outside of the Exchange organization are evaluated by the IP Allow list. Valid input for this parameter is $true or $false. The default value is $true. By default, messages from external connections are evaluated by the IP Allow list. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalMailEnabled parameter specifies whether messages from connections inside the Exchange organization are evaluated by the IP Allow list. Valid input for this parameter is $true or $false. The default value is $false. By default, messages from internal connections are not evaluated by the IP Allow list. Authenticated partner messages aren't considered internal mail. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvider.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-IPAllowListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvider.md index 4ede592a05..ef60d3134a 100644 --- a/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipallowlistprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPAllowListProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipallowlistprovider +schema: 2.0.0 +title: Set-IPAllowListProvider --- # Set-IPAllowListProvider @@ -57,6 +58,9 @@ This example sets the priority to 1 for the existing IP Allow list provider name ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the IP Allow list provider that you want to modify. You can use any value that uniquely identifies the IP Allow list provider. For example: - Name @@ -67,7 +71,6 @@ The Identity parameter specifies the IP Allow list provider that you want to mod Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -AnyMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnyMatch parameter specifies whether any response by the allow list provider is treated as a match. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, and connection filtering sends the IP address of the connecting SMTP server to the allow list provider, any response code returned by the allow list provider causes connection filtering to allow messages from that source. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -BitmaskMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BitmaskMatch parameter specifies the bit mask status code that's returned by the allow list provider. Use this parameter if the allow list provider returns bitmask responses. Valid input for this parameter is a single IP address in the format 127.0.0.1. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -118,7 +128,6 @@ 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 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -136,7 +148,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,13 +157,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the Connection Filtering agent queries the IP Allow list provider according to the priority set for this IP Allow list provider configuration. Valid input for this parameter is $true or $false. The default value is $true. By default, the Connection Filtering agent queries the IP Allow list provider according to the priority set for this IP Allow list provider configuration. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +175,9 @@ Accept wildcard characters: False ``` ### -IPAddressesMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddressesMatch parameter specifies the IP address status codes that are returned by the allow list provider. Use this parameter if the allow list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. 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"`. @@ -172,7 +188,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,13 +197,15 @@ Accept wildcard characters: False ``` ### -LookupDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LookupDomain parameter specifies the host name that's required to use the allow list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An example value is allowlist.spamservice.com. The actual value you need to use is provided by the allow list provider. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,13 +215,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a descriptive name for the IP Allow list provider. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -214,6 +233,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Priority parameter specifies the order that the Connection Filtering agent queries the IP Allow list providers that you've configured. By default, every time that you add a new IP Allow list provider, the entry is assigned a priority of N+1, where N is the number of IP Allow list providers you've configured. If you set the Priority parameter to a value that's the same as another IP Allow list provider, the priority of the IP Allow list provider that you added first is incremented by 1. @@ -222,7 +244,6 @@ If you set the Priority parameter to a value that's the same as another IP Allow Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -232,13 +253,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvidersConfig.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvidersConfig.md index 214711a0f1..b302367695 100644 --- a/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvidersConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipallowlistprovidersconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPAllowListProvidersConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipallowlistprovidersconfig +schema: 2.0.0 +title: Set-IPAllowListProvidersConfig --- # Set-IPAllowListProvidersConfig @@ -47,6 +48,9 @@ This example configures connection filtering to use IP Allow list providers on m ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -56,7 +60,6 @@ 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 Required: False Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -74,7 +80,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether IP Allow list providers are used for content filtering. Valid input for this parameter is $true or $false. The default value is $true. The default value is $true. By default, IP Allow list providers are used for content filtering. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalMailEnabled parameter specifies whether messages from connections outside of the Exchange organization are evaluated by IP Allow list providers. Valid input for this parameter is $true or $false. The default value is $true. By default, messages from external connections are evaluated by IP Allow list providers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalMailEnabled parameter specifies whether messages from connections inside the Exchange organization are evaluated by IP Allow list providers. Valid input for this parameter is $true or $false. The default value is $false. By default, messages from internal connections are not evaluated by IP Allow list providers. Authenticated partner messages aren't considered internal mail. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListConfig.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-IPBlockListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListConfig.md index af8ccda55d..52a84ea0f0 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipblocklistconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPBlockListConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipblocklistconfig +schema: 2.0.0 +title: Set-IPBlockListConfig --- # Set-IPBlockListConfig @@ -49,6 +50,9 @@ This example configures connection filtering to use the IP Block list on message ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -58,7 +62,6 @@ 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 Required: False Position: Named @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -76,7 +82,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the IP Block list is used for content filtering. Valid input for this parameter is $true or $false. The default value is $true. By default, the IP Block list is used for content filtering. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalMailEnabled parameter specifies whether messages from connections outside of the Exchange organization are evaluated by the IP Block list. Valid input for this parameter is $true or $false. The default value is $true. By default, messages from external connections are evaluated by the IP Block list. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalMailEnabled parameter specifies whether messages from connections inside the Exchange organization are evaluated by the IP Block list. Valid input for this parameter is $true or $false. The default value is $false. By default, messages from internal connections are not evaluated by the IP Block list. Authenticated partner messages aren't considered internal mail. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +145,15 @@ Accept wildcard characters: False ``` ### -MachineEntryRejectionResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MachineEntryRejectionResponse parameter specifies customized text in the non-delivery report (NDR) for messages that are blocked by connection filtering due to IP addresses in the IP Block list that were added by sender reputation. The value can't exceed 240 characters. If the value contains spaces, enclose the value in double quotation marks ("). ```yaml Type: AsciiString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +163,15 @@ Accept wildcard characters: False ``` ### -StaticEntryRejectionResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The StaticEntryRejectionResponse parameter specifies a customized text in the NDR for messages that are blocked by connection filtering due to IP addresses in the IP Block list. The value can't exceed 240 characters. If the value contains spaces, enclose the value in double quotation marks ("). ```yaml Type: AsciiString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +181,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvider.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-IPBlockListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvider.md index f7394da090..cbfed7d8a3 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipblocklistprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPBlockListProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipblocklistprovider +schema: 2.0.0 +title: Set-IPBlockListProvider --- # Set-IPBlockListProvider @@ -58,6 +59,9 @@ This example sets the priority value to 1 for the IP Block list provider named C ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the IP Block list provider that you want to modify. You can use any value that uniquely identifies the IP Block list provider. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the IP Block list provider that you want to mod Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AnyMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnyMatch parameter specifies whether any response by the block list provider is treated as a match. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true and connection filtering sends the IP address of the connecting SMTP server to the block list provider, any response code returned by the block list provider causes connection filtering to block messages from that source. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -BitmaskMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BitmaskMatch parameter specifies the bit mask status code that's returned by the block list provider. Use this parameter if the block list provider returns bitmask responses. Valid input for this parameter is a single IP address in the format 127.0.0.1. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -119,7 +129,6 @@ 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 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -137,7 +149,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the connection filtering uses this IP Block list provider. Valid input for this parameter is $true or $false. The default value is $true. By default, connection filtering uses new IP Block list providers that you create. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +176,9 @@ Accept wildcard characters: False ``` ### -IPAddressesMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddressesMatch parameter specifies the IP address status codes that are returned by the block list provider. Use this parameter if the block list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. 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"`. @@ -173,7 +189,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,13 +198,15 @@ Accept wildcard characters: False ``` ### -LookupDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LookupDomain parameter specifies the host name that's required to use the block list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An example value is blocklist.spamservice.com. The actual value you need to use is provided by the block list provider. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,13 +216,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a descriptive name for the IP Block list provider. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,6 +234,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Priority parameter specifies the order that the Connection Filtering agent queries the IP Block list providers. A lower priority integer value indicates a higher priority. By default, every time that you add a new IP Block list provider, the entry is assigned a priority of N+1, where N is the number of IP Block list provider services that you have configured. If you set the Priority parameter to a value that's the same as another IP Block list provider service, the priority of the IP Block list provider that you add first is incremented by 1. @@ -223,7 +245,6 @@ If you set the Priority parameter to a value that's the same as another IP Block Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,6 +254,9 @@ Accept wildcard characters: False ``` ### -RejectionResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectionResponse parameter specifies the text that you want to include in the SMTP rejection response when messages are blocked by connection filtering. The argument can't exceed 240 characters. If the value contains spaces, enclose the value in quotation marks ("). You should always specify the block list provider in the response so that legitimate senders can contact the block list provider for removal instructions. For example, "Source IP address is listed at the Contoso.com block list provider". @@ -241,7 +265,6 @@ You should always specify the block list provider in the response so that legiti Type: AsciiString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,13 +274,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvidersConfig.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvidersConfig.md index 50419ac6d6..2fcbad285d 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvidersConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipblocklistprovidersconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPBlockListProvidersConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipblocklistprovidersconfig +schema: 2.0.0 +title: Set-IPBlockListProvidersConfig --- # Set-IPBlockListProvidersConfig @@ -58,6 +59,9 @@ This example makes the following changes to the list of bypassed recipients: ## PARAMETERS ### -BypassedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BypassedRecipients parameter specifies the email addresses of internal recipients that are exempted from filtering by IP Block list providers. 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"`. @@ -68,7 +72,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -87,7 +93,6 @@ 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 Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -105,7 +113,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether IP Block list providers are used for content filtering. Valid input for this parameter is $true or $false. The default value is $true. The default value is $true. By default, IP Block list providers are used for content filtering. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalMailEnabled parameter specifies whether messages from connections outside of the Exchange organization are evaluated by IP Block list providers. Valid input for this parameter is $true or $false. The default value is $true. By default, messages from external connections are evaluated by IP Bock list providers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalMailEnabled parameter specifies whether messages from connections inside the Exchange organization are evaluated by IP Block list providers. Valid input for this parameter is $true or $false. The default value is $false. By default, messages from internal connections are not evaluated by IP Block list providers. Authenticated partner messages aren't considered internal mail. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-IRMConfiguration.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-IRMConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IRMConfiguration.md index e28eae6e83..5c112c0342 100644 --- a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IRMConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-irmconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-IRMConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-irmconfiguration +schema: 2.0.0 +title: Set-IRMConfiguration --- # Set-IRMConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-IRMConfiguration cmdlet to configure Information Rights Management (IRM) features on your organization. @@ -53,7 +54,7 @@ Set-IRMConfiguration [-Identity ] ## DESCRIPTION IRM requires the use of an on-premises AD RMS server or the ILS service. IRM features can be selectively enabled or disabled. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,6 +82,9 @@ This example enables licensing for external messages. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Identity parameter specifies the organization's IRM configuration object to modify. The valid value for this parameter is "ControlPoint Configuration". @@ -89,7 +93,6 @@ The Identity parameter specifies the organization's IRM configuration object to Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -99,18 +102,20 @@ Accept wildcard characters: False ``` ### -AutomaticServiceUpdateEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AutomaticServiceUpdateEnabled parameter specifies whether to allow the automatic addition of new features within Azure Information Protection for your cloud-based organization. Valid values are: -- $true: New Azure Information Protection features announced through Microsoft 365 message center will be enabled automatically in your cloud-based organization. +- $true: New Azure Information Protection features announced through Microsoft 365 message center are enabled automatically in your cloud-based organization. - $false: Prevents new Azure Information Protection features from automatically being introduced into your tenant organization. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -AzureRMSLicensingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AzureRMSLicensingEnabled parameter specifies whether the Exchange Online organization can to connect directly to Azure Rights Management. Valid values are: @@ -131,7 +139,6 @@ The AzureRMSLicensingEnabled parameter specifies whether the Exchange Online org Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -141,18 +148,20 @@ Accept wildcard characters: False ``` ### -ClientAccessServerEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ClientAccessServerEnabled parameter specifies whether Exchange Client Access servers are allowed to authenticate clients that do not have direct access to AD RMS (for example, Outlook on the web, Exchange ActiveSync or remote Outlook Anywhere clients). Valid values are: -- $true: Client Access servers are allowed to authenticate clients. This is the default value. Note that enabling IRM in Outlook on the web requires additional configuration on AD RMS servers. For more information, see [Information Rights Management in Outlook Web App](https://learn.microsoft.com/exchange/information-rights-management-in-outlook-web-app-exchange-2013-help). +- $true: Client Access servers are allowed to authenticate clients. This value is the default. Enabling IRM in Outlook on the web requires additional configuration on AD RMS servers. For more information, see [Information Rights Management in Outlook Web App](https://learn.microsoft.com/exchange/information-rights-management-in-outlook-web-app-exchange-2013-help). - $false: Client Access servers aren't allowed to authenticate clients. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -171,7 +183,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -181,12 +192,15 @@ Accept wildcard characters: False ``` ### -DecryptAttachmentForEncryptOnly + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The DecryptAttachmentForEncryptOnly parameter specifies whether mail recipients have unrestricted rights on the attachment or not for Encrypt-only mails sent using Microsoft Purview Message Encryption. Valid values are: -- $true: The recipients will have unrestricted rights on attachments sent using Encrypt-Only policy. -- $false: The recipients will not have unrestricted rights on attachments sent using Encrypt-Only policy. +- $true: The recipients have unrestricted rights on attachments sent using Encrypt-Only policy. +- $false: The recipients don't have unrestricted rights on attachments sent using Encrypt-Only policy. This parameter replaces the deprecated DecryptAttachmentFromPortal parameter. @@ -194,7 +208,6 @@ This parameter replaces the deprecated DecryptAttachmentFromPortal parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -204,6 +217,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -212,7 +228,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +237,9 @@ Accept wildcard characters: False ``` ### -EDiscoverySuperUserEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EDiscoverySuperUserEnabled parameter specifies whether members of the Discovery Management role group can access IRM-protected messages in a discovery mailbox that were returned by a discovery search. Valid values are: - $true: Members of the Discovery Management role group can access IRM-protected messages in discovery mailboxes. @@ -233,7 +251,6 @@ For more information about In-Place eDiscovery and IRM-protected messages, see [ Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,6 +260,9 @@ Accept wildcard characters: False ``` ### -EnablePdfEncryption + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The EnablePdfEncryption parameter specifies whether to enable the encryption of PDF attachments using Microsoft Purview Message Encryption. Valid values are: @@ -254,7 +274,6 @@ The EnablePdfEncryption parameter specifies whether to enable the encryption of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -264,6 +283,9 @@ Accept wildcard characters: False ``` ### -EnablePortalTrackingLogs + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. **Note**: This parameter is available only in organizations with Microsoft Purview Advanced Message Encryption. For more information, see [Advanced Message Encryption](https://learn.microsoft.com/purview/ome-advanced-message-encryption). @@ -277,7 +299,6 @@ The EnablePortalTrackingLogs parameter specifies whether to turn on auditing for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -287,20 +308,22 @@ Accept wildcard characters: False ``` ### -ExternalLicensingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The ExternalLicensingEnabled parameter specifies whether Exchange will try to acquire licenses from clusters other than the one it is configured to use. Without this setting, if Exchange receives many messages protected with a random key, the server will devote excessive resources to validating signatures and decrypting messages, even if the keys aren't valid. +The ExternalLicensingEnabled parameter specifies whether Exchange tries to acquire licenses from clusters other than the one it is configured to use. Without this setting, if Exchange receives many messages protected with a random key, the server devotes excessive resources to validating signatures and decrypting messages, even if the keys aren't valid. Valid values are: -- $true: Exchange will try to acquire licenses from clusters other than the one it is configured to use. This value can help prevent denial of service (DoS) attacks. -- $false: Exchange will try to acquire licenses only from clusters that it is configured to use. This is the default value. The *LicensingLocation* parameter specifies the list of allowed clusters. +- $true: Exchange tries to acquire licenses from clusters other than the one it is configured to use. This value can help prevent denial of service (DoS) attacks. +- $false: Exchange tries to acquire licenses only from clusters that it is configured to use. This value is the default. The *LicensingLocation* parameter specifies the list of allowed clusters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -310,6 +333,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you modify the InternalLicensingEnabled parameter. @@ -318,7 +344,6 @@ Use this switch to hide the confirmation prompt when you modify the InternalLice Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -328,18 +353,20 @@ Accept wildcard characters: False ``` ### -InternalLicensingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + **Note**: In Exchange Online, this parameter affects both internal and external messages. In on-premises Exchange, this parameter only affects internal messages. The InternalLicensingEnabled parameter specifies whether to enable IRM features for messages that are sent to internal recipients. Valid values are: -- $true: IRM features are enabled for internal messages. This is the default value in Exchange Online. -- $false: IRM features are disabled for internal messages. This is the default value in on-premises Exchange. Note that this value causes the Get-RMSTemplate to return no AD RMS templates. +- $true: IRM features are enabled for internal messages. This value is the default in Exchange Online. +- $false: IRM features are disabled for internal messages. This value is the default in on-premises Exchange. This value causes the Get-RMSTemplate to return no AD RMS templates. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -349,16 +376,18 @@ Accept wildcard characters: False ``` ### -JournalReportDecryptionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The JournalReportDecryptionEnabled parameter specifies whether to enable journal report decryption. Valid values are: -- $true: Journal report encryption is enabled. A decrypted copy of the IRM-protected message is attached to the journal report. This is the default value. Note that journal report decryption requires additional configuration on AD RMS servers. For more information, see [Journal report decryption](https://learn.microsoft.com/exchange/journal-report-decryption-exchange-2013-help). +- $true: Journal report encryption is enabled. A decrypted copy of the IRM-protected message is attached to the journal report. This value is the default. Journal report decryption requires additional configuration on AD RMS servers. For more information, see [Journal report decryption](https://learn.microsoft.com/exchange/journal-report-decryption-exchange-2013-help). - $false: Journal report decryption is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -368,15 +397,19 @@ Accept wildcard characters: False ``` ### -LicensingLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The LicensingLocation parameter specifies the RMS licensing URLs. You can specify multiple URL values separated by commas. 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 don't function properly. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -386,6 +419,9 @@ Accept wildcard characters: False ``` ### -RefreshServerCertificates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RefreshServerCertificates switch clears all Rights Account Certificates (RACs), Computer Licensor Certificates (CLCs), and cached AD RMS templates from all Exchange servers in the organization. You don't need to specify a value with this switch. @@ -396,7 +432,6 @@ Clearing RACs, CLCs, and cached templates might be required during troubleshooti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,6 +441,9 @@ Accept wildcard characters: False ``` ### -RejectIfRecipientHasNoRights + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RejectIfRecipientHasNoRights Description }} @@ -414,7 +452,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -424,6 +461,9 @@ Accept wildcard characters: False ``` ### -RMSOnlineKeySharingLocation + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RMSOnlineKeySharingLocation parameter specifies the Azure Rights Management URL that's used to get the trusted publishing domain (TPD) for the Exchange Online organization. @@ -432,7 +472,6 @@ The RMSOnlineKeySharingLocation parameter specifies the Azure Rights Management Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -442,16 +481,18 @@ Accept wildcard characters: False ``` ### -SearchEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SearchEnabled parameter specifies whether to enable searching of IRM-encrypted messages in Outlook on the web (formerly known as Outlook Web App). Valid values are: -- $true: Searching IRM-encrypted messages in Outlook on the web is enabled. This is the default value. +- $true: Searching IRM-encrypted messages in Outlook on the web is enabled. This value is the default. - $false: Searching IRM-encrypted messages in Outlook on the web is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -461,6 +502,9 @@ Accept wildcard characters: False ``` ### -SimplifiedClientAccessDoNotForwardDisabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The SimplifiedClientAccessDoNotForwardDisabled parameter specifies whether to disable **Do not forward** in Outlook on the web. Valid values are: @@ -472,7 +516,6 @@ The SimplifiedClientAccessDoNotForwardDisabled parameter specifies whether to di Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -482,18 +525,20 @@ Accept wildcard characters: False ``` ### -SimplifiedClientAccessEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The SimplifiedClientAccessEnabled parameter specifies whether to enable the Protect button in Outlook on the web. Valid values are: - $true: The Protect button is enabled in Outlook on the web. -- $false: The Protect button is disabled in Outlook on the web. This is the default value. +- $false: The Protect button is disabled in Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -503,6 +548,9 @@ Accept wildcard characters: False ``` ### -SimplifiedClientAccessEncryptOnlyDisabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The SimplifiedClientAccessEncryptOnlyDisabled parameter specifies whether to disable **Encrypt only** in Outlook on the web. Valid values are: @@ -514,7 +562,6 @@ The SimplifiedClientAccessEncryptOnlyDisabled parameter specifies whether to dis Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -524,17 +571,19 @@ Accept wildcard characters: False ``` ### -TransportDecryptionSetting + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TransportDecryptionSetting parameter specifies the transport decryption configuration. Valid values are: - Disabled: Transport decryption is disabled for internal and external messages. - Mandatory: Messages that can't be decrypted are rejected with a non-delivery report (also known as an NDR or bounce message). -- Optional: Messages are decrypted if possible, but are delivered even if decryption fails. This is the default value. +- Optional: Messages are decrypted if possible, but are delivered even if decryption fails. This value is the default. ```yaml Type: TransportDecryptionSetting Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -544,13 +593,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ImapSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-ImapSettings.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-ImapSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ImapSettings.md index d6a70cad13..7dbf537398 100644 --- a/exchange/exchange-ps/exchange/Set-ImapSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ImapSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-imapsettings -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ImapSettings -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-imapsettings +schema: 2.0.0 +title: Set-ImapSettings --- # Set-ImapSettings @@ -58,7 +59,7 @@ Set-ImapSettings [-AuthenticatedConnectionTimeout ] ## DESCRIPTION You can run the Set-ImapSettings cmdlet for a single Exchange server that's running the Microsoft Exchange IMAP4 service, or for all Exchange servers that are running the Microsoft Exchange IMAP4 service. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,11 +98,14 @@ Set-ImapSettings -X509CertificateName mail.contoso.com This example specifies the certificate that contains mail.contoso.com is used to encrypt IMAP4 client connections. -**Note**: For single subject certificates or a SAN certificates, you also need to assign the certificate to the Exchange IMAP service by using the Enable-ExchangeCertificate cmdlet. For wildcard certificates, you don't need to assign the certificate to the Exchange IMAP service (you'll receive an error if you try). +**Note**: For single subject certificates or a SAN certificates, you also need to assign the certificate to the Exchange IMAP service by using the Enable-ExchangeCertificate cmdlet. For wildcard certificates, you don't need to assign the certificate to the Exchange IMAP service (you get an error if you try). ## PARAMETERS ### -AuthenticatedConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AuthenticatedConnectionTimeout parameter specifies the period of time to wait before closing an idle authenticated connection. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -112,7 +116,6 @@ Valid values are 00:00:30 to 1:00:00. The default setting is 00:30:00 (30 minute Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +125,15 @@ Accept wildcard characters: False ``` ### -Banner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Banner parameter specifies the text string that's displayed to connecting IMAP4 clients. The default value is: The Microsoft Exchange IMAP4 service is ready. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,9 +143,12 @@ Accept wildcard characters: False ``` ### -CalendarItemRetrievalOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarItemRetrievalOption parameter specifies how calendar items are presented to IMAP4 clients. Valid values are: -- 0 or iCalendar. This is the default value. +- 0 or iCalendar. This value is the default. - 1 or IntranetUrl - 2 or InternetUrl - 3 or Custom @@ -151,7 +159,6 @@ If you specify 3 or Custom, you need to specify a value for the OwaServerUrl par Type: CalendarItemRetrievalOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,6 +168,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -170,7 +180,6 @@ 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 Required: False Position: Named @@ -180,13 +189,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,16 +207,18 @@ Accept wildcard characters: False ``` ### -EnableExactRFC822Size + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnableExactRFC822Size parameter specifies how message sizes are presented to IMAP4 clients. Valid values are: - $true: Calculate the exact message size. Because this setting can negatively affect performance, you should configure it only if it's required by your IMAP4 clients. -- $false: Use an estimated message size. This is the default value. +- $false: Use an estimated message size. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,16 +228,18 @@ Accept wildcard characters: False ``` ### -EnableGSSAPIAndNTLMAuth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnableGSSAPIAndNTLMAuth parameter specifies whether connections can use Integrated Windows authentication (NTLM) using the Generic Security Services application programming interface (GSSAPI). This setting applies to connections where Transport Layer Security (TLS) is disabled. Valid values are: -- $true: NTLM for IMAP4 connections is enabled. This is the default value. +- $true: NTLM for IMAP4 connections is enabled. This value is the default. - $false: NTLM for IMAP4 connections is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -234,18 +249,20 @@ Accept wildcard characters: False ``` ### -EnforceCertificateErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnforceCertificateErrors parameter specifies whether to enforce valid Secure Sockets Layer (SSL) certificate validation failures. Valid values are: The default setting is $false. - $true: If the certificate isn't valid or doesn't match the target IMAP4 server's FQDN, the connection attempt fails. -- $false: The server doesn't deny IMAP4 connections based on certificate errors. This is the default value. +- $false: The server doesn't deny IMAP4 connections based on certificate errors. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,9 +272,12 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionPolicy parameter specifies how Extended Protection for Authentication is used. Valid values are: -- None: Extended Protection for Authentication isn't used. This is the default value. +- None: Extended Protection for Authentication isn't used. This value is the default. - Allow: Extended Protection for Authentication is used only if it's supported by the incoming IMAP4 connection. If it's not, Extended Protection for Authentication isn't used. - Require: Extended Protection for Authentication is required for all IMAP4 connections. If the incoming IMAP4 connection doesn't support it, the connection is rejected. @@ -267,7 +287,6 @@ Extended Protection for Authentication enhances the protection and handling of c Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,6 +296,9 @@ Accept wildcard characters: False ``` ### -ExternalConnectionSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by external IMAP4 clients (IMAP4 connections from outside your corporate network). This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). @@ -293,7 +315,6 @@ The combination of encryption methods and ports that are specified for this para Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -303,6 +324,9 @@ Accept wildcard characters: False ``` ### -InternalConnectionSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by internal IMAP4 clients (IMAP4 connections from inside your corporate network). This setting is also used when a IMAP4 connection is forwarded to another Exchange server that's running the Microsoft Exchange IMAP4 service. This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). @@ -319,7 +343,6 @@ The combination of encryption methods and ports that are specified for this para Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -329,6 +352,9 @@ Accept wildcard characters: False ``` ### -LogFileLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogFileLocation parameter specifies the location for the IMAP4 protocol log files. The default location is %ExchangeInstallPath%Logging\\Imap4. This parameter is only meaningful when the ProtocolLogEnabled parameter value is $true. @@ -337,7 +363,6 @@ This parameter is only meaningful when the ProtocolLogEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -347,10 +372,13 @@ Accept wildcard characters: False ``` ### -LogFileRollOverSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogFileRollOverSettings parameter specifies how frequently IMAP4 protocol logging creates a new log file. Valid values are: -- 1 or Hourly. This is the default value in Exchange 2019 and Exchange 2016. -- 2 or Daily. This is the default value in Exchange 2013 and Exchange 2010. +- 1 or Hourly. This value is the default in Exchange 2019 and Exchange 2016. +- 2 or Daily. This value is the default in Exchange 2013 and Exchange 2010. - 3 or Weekly. - 4 or Monthly. @@ -360,7 +388,6 @@ This parameter is only meaningful when the LogPerFileSizeQuota parameter value i Type: LogFileRollOver Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -370,17 +397,19 @@ Accept wildcard characters: False ``` ### -LoginType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LoginType parameter specifies the authentication method for IMAP4 connections. Valid values are: - 1 or PlainTextLogin. - 2 or PlainTextAuthentication. -- 3 or SecureLogin. This is the default value. +- 3 or SecureLogin. This value is the default. ```yaml Type: LoginOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -390,6 +419,9 @@ Accept wildcard characters: False ``` ### -LogPerFileSizeQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogPerFileSizeQuota parameter specifies the maximum size of a IMAP4 protocol log file. When you enter a value, qualify the value with one of the following units: @@ -400,7 +432,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The default value is 0, which means a new IMAP4 protocol log file is created at the frequency that's specified by the LogFileRollOverSettings parameter. @@ -410,7 +442,6 @@ This parameter is only meaningful when the ProtocolLogEnabled parameter value is Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -420,13 +451,15 @@ Accept wildcard characters: False ``` ### -MaxCommandSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxCommandSize parameter specifies the maximum size in bytes of a single IMAP4 command. Valid values are from 1024 through 16384. The default value is 10240. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -436,13 +469,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionFromSingleIP + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConnectionFromSingleIP parameter specifies the maximum number of IMAP4 connections that are accepted by the Exchange server from a single IP address. Valid values are from 1 through 2147483647. The default value is 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -452,13 +487,15 @@ Accept wildcard characters: False ``` ### -MaxConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConnections parameter specifies the maximum number of IMAP4 connections that are accepted by the Exchange server. Valid values are from 1 through 2147483647. The default value is 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,13 +505,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionsPerUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConnectionsPerUser parameter specifies the maximum number of IMAP4 connections that are allowed for each user. Valid values are from 1 through 2147483647. The default value is 16. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -484,6 +523,9 @@ Accept wildcard characters: False ``` ### -MessageRetrievalMimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages. Valid values are: - 0 or TextOnly. @@ -491,14 +533,13 @@ The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages - 2 or HtmlAndTextAlternative. - 3 or TextEnrichedOnly. - 4 or TextEnrichedAndTextAlternative. -- 5 or BestBodyFormat. This is the default value. +- 5 or BestBodyFormat. This value is the default. - 6 or Tnef. ```yaml Type: MimeTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -508,13 +549,15 @@ Accept wildcard characters: False ``` ### -OwaServerUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaServerUrl parameter specifies the URL that's used to retrieve calendar information for instances of custom Outlook on the web calendar items. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -524,6 +567,9 @@ Accept wildcard characters: False ``` ### -PreAuthenticatedConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PreAuthenticatedConnectionTimeout parameter specifies the period of time to wait before closing an idle IMAP4 connection that isn't authenticated. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -534,7 +580,6 @@ Valid values are00:00:30 to 1:00:00. The default value is 00:01:00 (one minute). Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -544,16 +589,18 @@ Accept wildcard characters: False ``` ### -ProtocolLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProtocolLogEnabled parameter specifies whether to enable protocol logging for IMAP4. Valid values are: - $true: IMAP4 protocol logging is enabled. -- $false: IMAP4 protocol logging is disabled. This is the default value. +- $false: IMAP4 protocol logging is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -563,13 +610,15 @@ Accept wildcard characters: False ``` ### -ProxyTargetPort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProxyTargetPort parameter specifies the port on the Microsoft Exchange IMAP4 Backend service that listens for client connections that are proxied from the Microsoft Exchange IMAP4 service. The default value is 1993. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -579,6 +628,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -592,7 +644,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -602,16 +653,18 @@ Accept wildcard characters: False ``` ### -ShowHiddenFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ShowHiddenFoldersEnabled parameter specifies whether hidden mailbox folders are visible. Valid values are: - $true: Hidden folders are visible. -- $false: Hidden folders aren't visible. This is the default value. +- $false: Hidden folders aren't visible. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -621,6 +674,9 @@ Accept wildcard characters: False ``` ### -SSLBindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SSLBindings parameter specifies the IP address and TCP port that's used for IMAP4 connection that's always encrypted by SSL/TLS. This parameter uses the syntax `IPv4OrIPv6Address:Port`. The default value is `[::]:993,0.0.0.0:993`. @@ -633,7 +689,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -643,16 +698,18 @@ Accept wildcard characters: False ``` ### -SuppressReadReceipt + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuppressReadReceipt parameter specifies whether to stop duplicate read receipts from being sent to IMAP4 clients that have the Send read receipts for messages I send setting configured in their IMAP4 email program. Valid values are: - $true: The sender receives a read receipt only when the recipient opens the message. -- $false: The sender receives a read receipt when the recipient downloads the message, and when the recipient opens the message. This is the default value. +- $false: The sender receives a read receipt when the recipient downloads the message, and when the recipient opens the message. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -662,6 +719,9 @@ Accept wildcard characters: False ``` ### -UnencryptedOrTLSBindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UnencryptedOrTLSBindings parameter specifies the IP address and TCP port that's used for unencrypted IMAP4 connections, or IMAP4 connections that are encrypted by using opportunistic TLS (STARTTLS) after the initial unencrypted protocol handshake. This parameter uses the syntax `IPv4OrIPv6Address:Port`. The default value is `[::]:143,0.0.0.0:143`. @@ -674,7 +734,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -684,13 +743,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -700,6 +761,9 @@ Accept wildcard characters: False ``` ### -X509CertificateName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The X509CertificateName parameter specifies the certificate that's used for encrypting IMAP4 client connections. A valid value for this parameter is the FQDN from the ExternalConnectionSettings or InternalConnectionSettings parameters (for example, mail.contoso.com or mailbox01.contoso.com). @@ -712,7 +776,6 @@ If you use a wildcard certificate, you don't need to assign the certificate to t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-InboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-InboundConnector.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-InboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-InboundConnector.md index 285ba184d1..cd67b28eb5 100644 --- a/exchange/exchange-ps/exchange/Set-InboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-InboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-inboundconnector applicable: Exchange Online, Exchange Online Protection -title: Set-InboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-inboundconnector +schema: 2.0.0 +title: Set-InboundConnector --- # Set-InboundConnector @@ -51,7 +52,7 @@ Set-InboundConnector [-Identity] ## DESCRIPTION Inbound connectors accept email messages from remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,13 +70,15 @@ Require that the TLS certificate that is used to encrypt communications contain ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Inbound connector you want to change. ```yaml Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssociatedAcceptedDomains + +> Applicable: Exchange Online, Exchange Online Protection + The AssociatedAcceptedDomains parameter restricts the source domains that use the connector to the specified accepted domains. A valid value is an SMTP domain that's configured as an accepted domain in your Microsoft 365 organization. You can specify multiple values separated by commas. @@ -93,7 +99,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -103,20 +108,22 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. Valid values are: -- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This is the default value for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. +- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This value is the default for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. - $false: The connector isn't used for mail flow in hybrid organizations, so any cross-premises headers are removed from messages that flow through the connector. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,13 +133,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -151,7 +163,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -161,9 +172,12 @@ Accept wildcard characters: False ``` ### -ConnectorSource + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorSource parameter specifies how the connector is created. Valid input for this parameter includes the following values: -- Default: The connector is manually created. This is the default value. +- Default: The connector is manually created. This value is the default. - HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. - Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. @@ -173,7 +187,6 @@ We recommended that you don't change this value. Type: TenantConnectorSource Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,6 +196,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -192,7 +208,6 @@ The ConnectorType parameter specifies a category for the domains that are servic Type: TenantConnectorType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -EFSkipIPs + +> Applicable: Exchange Online, Exchange Online Protection + the EFSkipIPs parameter specifies the source IP addresses to skip in Enhanced Filtering for Connectors when the EFSkipLastIP parameter value is $false. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -214,7 +232,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -224,16 +241,18 @@ Accept wildcard characters: False ``` ### -EFSkipLastIP + +> Applicable: Exchange Online, Exchange Online Protection + The EFSkipIPs parameter specifies the behavior of Enhanced Filtering for Connectors. Valid values are: - $true: Only the last message source is skipped. -- $false: Skip the source IP addresses specified by the EFSkipIPs parameter. If no IP addresses are specified, Enhanced Filtering for Connectors is disabled on the connector. This is the default value. +- $false: Skip the source IP addresses specified by the EFSkipIPs parameter. If no IP addresses are specified, Enhanced Filtering for Connectors is disabled on the connector. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,13 +262,15 @@ Accept wildcard characters: False ``` ### -EFSkipMailGateway + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -259,13 +280,15 @@ Accept wildcard characters: False ``` ### -EFTestMode + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,6 +298,9 @@ Accept wildcard characters: False ``` ### -EFUsers + +> Applicable: Exchange Online, Exchange Online Protection + The EFUsers parameter specifies the recipients that Enhanced Filtering for Connectors applies to. The default value is blank ($null), which means Enhanced Filtering for Connectors is applied to all recipients. You can specify multiple recipient email addresses separated by commas. @@ -283,7 +309,6 @@ You can specify multiple recipient email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -293,16 +318,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter enables or disables the connector. Valid values are: -- $true: The connector is enabled. This is the default value. +- $true: The connector is enabled. This value is the default. - $false: The connector is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -312,13 +339,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a descriptive name for the connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -328,9 +357,12 @@ Accept wildcard characters: False ``` ### -RequireTls + +> Applicable: Exchange Online, Exchange Online Protection + 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 +- $true: Reject messages if they aren't sent over TLS. This value is the default - $false: Allow messages if they aren't sent over TLS. **Note**: This parameter applies only to Partner type connectors. @@ -339,7 +371,6 @@ The RequireTLS parameter specifies whether to require TLS transmission for all m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -349,10 +380,13 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToCertificate + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- $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 value is the default. **Note**: This parameter applies only to Partner type connectors. @@ -360,7 +394,6 @@ The RestrictDomainsToCertificate parameter specifies whether the Subject value o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -370,10 +403,13 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToIPAddresses + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- $false: Don't automatically reject mail from domains that are specified by the SenderDomains parameter based on the source IP address. This value is the default. **Note**: This parameter applies only to Partner type connectors. @@ -381,7 +417,6 @@ The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -391,13 +426,15 @@ Accept wildcard characters: False ``` ### -ScanAndDropRecipients + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -407,6 +444,9 @@ Accept wildcard characters: False ``` ### -SenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -415,7 +455,6 @@ You can specify multiple domains separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -425,6 +464,9 @@ Accept wildcard characters: False ``` ### -SenderIPAddresses + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -439,7 +481,6 @@ IPv6 addresses are not supported. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -449,13 +490,15 @@ Accept wildcard characters: False ``` ### -TlsSenderCertificateName + +> Applicable: Exchange Online, Exchange Online Protection + The TlsSenderCertificateName parameter specifies the TLS certificate that's used when the value of the RequireTls parameter is $true. A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com is not valid). ```yaml Type: TlsCertificate Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -465,10 +508,13 @@ Accept wildcard characters: False ``` ### -TreatMessagesAsInternal + +> Applicable: Exchange Online, Exchange Online Protection + The TreatMessagesAsInternal parameter specifies an alternative method to identify messages sent from an on-premises organization as internal messages. You should only consider using this parameter when your on-premises organization doesn't use Exchange. Valid values are: - $true: Messages are considered internal if the sender's domain matches a domain that's configured in Microsoft 365. This setting allows internal mail flow between Microsoft 365 and on-premises organizations that don't have Exchange Server 2010 or later installed. However, this setting has potential security risks (for example, internal messages bypass antispam filtering), so use caution when configuring this setting. -- $false: Messages aren't considered internal. This is the default value. +- $false: Messages aren't considered internal. This value is the default. In hybrid environments, you don't need to use this parameter, because the Hybrid Configuration wizard automatically configures the required settings on the Inbound connector in Microsoft 365 and the Send connector in the on-premises Exchange organization (the CloudServicesMailEnabled parameter). @@ -481,7 +527,6 @@ In hybrid environments, you don't need to use this parameter, because the Hybrid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -491,6 +536,9 @@ Accept wildcard characters: False ``` ### -TrustedOrganizations + +> Applicable: Exchange Online, Exchange Online Protection + The TrustedOrganizations parameter specifies other Microsoft 365 organizations that are trusted mail sources (for example, after acquisitions and mergers). This parameter works only for mail flow between two Microsoft 365 organizations, so no other parameters are used. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -501,7 +549,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -511,13 +558,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-InboxRule.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-InboxRule.md index 7a07f0767d..88e296d6ef 100644 --- a/exchange/exchange-ps/exchange/Set-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-InboxRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-inboxrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-InboxRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-inboxrule +schema: 2.0.0 +title: Set-InboxRule --- # Set-InboxRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-InboxRule cmdlet to modify existing Inbox rules in mailboxes. Inbox rules process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. @@ -99,13 +100,13 @@ The Set-InboxRule cmdlet allows you to modify the rule conditions, exceptions, a When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-InboxRule ProjectContoso -MarkImportance "High" +Set-InboxRule -Mailbox chris@contoso.com -Name ProjectContoso -MarkImportance "High" ``` This example modifies the action of the existing Inbox rule ProjectContoso. The MarkImportance parameter is used to mark the message with high importance. @@ -113,6 +114,9 @@ This example modifies the action of the existing Inbox rule ProjectContoso. The ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Inbox rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -124,7 +128,6 @@ The Identity parameter specifies the Inbox rule that you want to modify. You can Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -134,13 +137,15 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -150,6 +155,9 @@ Accept wildcard characters: False ``` ### -ApplyCategory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApplyCategory parameter specifies an action for the Inbox rule that applies the specified category to messages. A valid value is any text value that you want to define as a category. You can specify multiple categories separated by commas. If the value contains spaces, enclose the value in quotation marks ("). The categories that you specify for this parameter are defined in the mailbox (they aren't shared between mailboxes). @@ -158,7 +166,6 @@ The categories that you specify for this parameter are defined in the mailbox (t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -168,6 +175,9 @@ Accept wildcard characters: False ``` ### -ApplySystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApplySystemCategory parameter specifies an action for the Inbox rule that applies the specified system category to messages. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -203,7 +213,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -213,6 +222,9 @@ Accept wildcard characters: False ``` ### -BodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -227,7 +239,6 @@ The corresponding exception parameter to this condition is ExceptIfBodyContainsW Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -237,6 +248,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -246,7 +260,6 @@ 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 Required: False Position: Named @@ -256,6 +269,9 @@ Accept wildcard characters: False ``` ### -CopyToFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CopyToFolder parameter specifies an action for the Inbox rule that copies messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -277,7 +293,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,6 +302,9 @@ Accept wildcard characters: False ``` ### -DeleteSystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeleteSystemCategory parameter specifies an action for the Inbox rule that deletes the specified system category from messages. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -320,7 +338,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -330,6 +347,9 @@ Accept wildcard characters: False ``` ### -DeleteMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeleteMessage parameter specifies an action for the Inbox rule that sends messages to the Deleted Items folder. Valid values are: - $true: Messages that match the conditions of the rule are moved to the Deleted Items folder. @@ -339,7 +359,6 @@ The DeleteMessage parameter specifies an action for the Inbox rule that sends me Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -349,6 +368,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -357,7 +379,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -367,6 +388,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -381,7 +405,6 @@ The corresponding condition parameter to this exception is BodyContainsWords. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -391,6 +414,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFlaggedForAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfFlaggedForAction parameter specifies an exception for the Inbox rule that looks messages with the specified message flag. Valid values are: - Any @@ -411,7 +437,6 @@ The corresponding condition parameter to this exception is FlaggedForAction. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -421,6 +446,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: - Name @@ -438,7 +466,6 @@ The corresponding condition parameter to this exception is From. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -448,6 +475,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -462,7 +492,6 @@ The corresponding condition parameter to this exception is FromAddressContainsWo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -472,6 +501,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasAttachment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfHasAttachment parameter specifies an exception for the Inbox rule that looks for messages with attachments. Valid values are: - $true: The rule action isn't applied to messages that have attachments. @@ -483,7 +515,6 @@ The corresponding condition parameter to this exception is HasAttachment. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -493,6 +524,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfHasClassification parameter specifies an exception for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. The corresponding condition parameter to this exception is HasClassification. @@ -501,7 +535,6 @@ The corresponding condition parameter to this exception is HasClassification. Type: MessageClassificationIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -511,6 +544,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -525,7 +561,6 @@ The corresponding condition parameter to this exception is HeaderContainsWords. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -535,6 +570,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfMessageTypeMatches parameter specifies an exception for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply @@ -555,7 +593,6 @@ The corresponding condition parameter to this exception is MessageTypeMatches. Type: InboxRuleMessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -565,6 +602,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfMyNameInCcBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the Cc field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is in the Cc field. @@ -576,7 +616,6 @@ The corresponding condition parameter to this exception is MyNameInCcBox. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -586,6 +625,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfMyNameInToBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the To field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is in the To field. @@ -597,7 +639,6 @@ The corresponding condition parameter to this exception is MyNameInToBox. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -607,6 +648,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInToOrCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfMyNameInToOrCcBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the To or Cc fields Valid values are. - $true: The rule action isn't applied to messages where the mailbox owner is in the To or Cc fields. @@ -618,7 +662,6 @@ The corresponding condition parameter to this exception is MyNameInToOrCcBox. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -628,6 +671,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameNotInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfMyNameNotInToBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner isn't in the To field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner isn't in the To field. @@ -639,7 +685,6 @@ The corresponding condition parameter to this exception is MyNameNotInToBox. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -649,6 +694,9 @@ Accept wildcard characters: False ``` ### -ExceptIfReceivedAfterDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -659,7 +707,6 @@ The corresponding condition parameter to this exception is ReceivedAfterDate. Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -669,6 +716,9 @@ Accept wildcard characters: False ``` ### -ExceptIfReceivedBeforeDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -679,7 +729,6 @@ The corresponding condition parameter to this exception is ReceivedBeforeDate. Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -689,6 +738,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfRecipientAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in recipient email addresses. 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"`. @@ -703,7 +755,6 @@ The corresponding condition parameter to this exception is RecipientAddressConta Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -713,6 +764,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentOnlyToMe + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfSentOnlyToMe parameter specifies an exception for the Inbox rule that looks for messages where the only recipient is the mailbox owner. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is the only recipient. @@ -724,7 +778,6 @@ The corresponding condition parameter to this exception is SentOnlyToMe. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -734,6 +787,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -751,7 +807,6 @@ The corresponding condition parameter to this exception is SentTo. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -761,6 +816,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -775,7 +833,6 @@ The corresponding condition parameter to this exception is SubjectContainsWords. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -785,6 +842,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -799,7 +859,6 @@ The corresponding condition parameter to this exception is SubjectOrBodyContains Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -809,6 +868,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfWithImportance parameter specifies an exception for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High @@ -821,7 +883,6 @@ The corresponding condition parameter to this exception is WithImportance. Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -831,6 +892,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithinSizeRangeMaximum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfWithinSizeRangeMaximum parameter specifies part of an exception for the Inbox rule that looks for messages that smaller than specified maximum size. When you enter a value, qualify the value with one of the following units: @@ -841,7 +905,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You need to use this parameter with the ExceptIfWithinSizeRangeMinimum parameter, and the value of this parameter must be greater than the value of ExceptIfWithinSizeRangeMinimum. @@ -851,7 +915,6 @@ The corresponding condition parameter to this exception is WithinSizeRangeMaximu Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -861,6 +924,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithinSizeRangeMinimum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfWithinSizeRangeMinimum parameter specifies part of an exception for the Inbox rule that looks for messages that are larger than the specified minimum size. When you enter a value, qualify the value with one of the following units: @@ -871,7 +937,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You need to use this parameter with the ExceptIfWithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of ExceptIfWithinSizeRangeMaximum. @@ -881,7 +947,6 @@ The corresponding condition parameter to this exception is WithinSizeRangeMinimu Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -891,6 +956,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithSensitivity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExceptIfWithSensitivity parameter specifies an exception for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal @@ -904,7 +972,6 @@ The corresponding condition parameter to this exception is WithSensitivity. Type: Sensitivity Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -914,6 +981,9 @@ Accept wildcard characters: False ``` ### -FlaggedForAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FlaggedForAction parameter specifies a condition for the Inbox rule that looks for messages with the specified message flag. Valid values are: - Any @@ -932,7 +1002,6 @@ The FlaggedForAction parameter specifies a condition for the Inbox rule that loo Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -942,15 +1011,17 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. +A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules are removed by the actions of this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -960,6 +1031,9 @@ Accept wildcard characters: False ``` ### -ForwardAsAttachmentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForwardAsAttachmentTo parameter specifies an action for the Inbox rule that forwards the message to the specified recipient as an attachment. You can use any value that uniquely identifies the recipient. For example: - Name @@ -975,7 +1049,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -985,6 +1058,9 @@ Accept wildcard characters: False ``` ### -ForwardTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForwardTo parameter specifies an action for the Inbox rule that forwards the message to the specified recipient. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1000,7 +1076,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1010,6 +1085,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The From parameter specifies a condition for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: - Name @@ -1027,7 +1105,6 @@ The corresponding exception parameter to this condition is ExceptIfFrom. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1037,6 +1114,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1051,7 +1131,6 @@ The corresponding exception parameter to this condition is ExceptIfFromAddressCo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1061,6 +1140,9 @@ Accept wildcard characters: False ``` ### -HasAttachment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HasAttachment parameter specifies a condition for the Inbox rule that looks for messages with attachments. Valid values are: - $true: The rule action is applied to messages that have attachments. @@ -1072,7 +1154,6 @@ The corresponding exception parameter to this condition is ExceptIfHasAttachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1082,6 +1163,9 @@ Accept wildcard characters: False ``` ### -HasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HasClassification parameter specifies a condition for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. The corresponding exception parameter to this condition is ExceptIfHasClassification. @@ -1090,7 +1174,6 @@ The corresponding exception parameter to this condition is ExceptIfHasClassifica Type: MessageClassificationIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1100,6 +1183,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1114,7 +1200,6 @@ The corresponding exception parameter to this condition is ExceptIfHeaderContain Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1124,6 +1209,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -1141,7 +1229,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1151,6 +1238,9 @@ Accept wildcard characters: False ``` ### -MarkAsRead + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MarkAsRead parameter specifies an action for the Inbox rule that marks messages as read. Valid values are: - $true: Messages that match the conditions of the rule are marked as read. @@ -1160,7 +1250,6 @@ The MarkAsRead parameter specifies an action for the Inbox rule that marks messa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1170,6 +1259,9 @@ Accept wildcard characters: False ``` ### -MarkImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MarkImportance parameter specifies an action for the Inbox rule that marks messages with the specified importance flag. Valid values are: - Low @@ -1180,7 +1272,6 @@ The MarkImportance parameter specifies an action for the Inbox rule that marks m Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1190,6 +1281,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MessageTypeMatches parameter specifies a condition for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply @@ -1210,7 +1304,6 @@ The corresponding exception parameter to this condition is ExceptIfMessageTypeMa Type: InboxRuleMessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1220,6 +1313,9 @@ Accept wildcard characters: False ``` ### -MoveToFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MoveToFolder parameter specifies an action for the Inbox rule that moves messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -1241,7 +1337,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1251,6 +1346,9 @@ Accept wildcard characters: False ``` ### -MyNameInCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MyNameInCcBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the Cc field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is in the Cc field. @@ -1262,7 +1360,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInCcBox Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1272,6 +1369,9 @@ Accept wildcard characters: False ``` ### -MyNameInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MyNameInToBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the To field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is in the To field. @@ -1283,7 +1383,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInToBox Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1293,6 +1392,9 @@ Accept wildcard characters: False ``` ### -MyNameInToOrCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MyNameInToOrCcBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the To or Cc fields Valid values are. - $true: The rule action is applied to messages where the mailbox owner is in the To or Cc fields. @@ -1304,7 +1406,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInToOrC Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1314,6 +1415,9 @@ Accept wildcard characters: False ``` ### -MyNameNotInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MyNameNotInToBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner isn't in the To field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner isn't in the To field. @@ -1325,7 +1429,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameNotInTo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1335,13 +1438,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1351,6 +1456,9 @@ Accept wildcard characters: False ``` ### -PinMessage + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PinMessage parameter specifies an action for the Inbox rule that pins messages to the top of the Inbox. Valid values are: - $true: Message that match the conditions of the rule are pinned to the top of the Inbox. @@ -1360,7 +1468,6 @@ The PinMessage parameter specifies an action for the Inbox rule that pins messag Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1370,13 +1477,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Priority parameter specifies a priority for the Inbox rule that determines the order of rule processing. A lower integer value indicates a higher priority, ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1386,6 +1495,9 @@ Accept wildcard characters: False ``` ### -ReceivedAfterDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -1396,7 +1508,6 @@ The corresponding exception parameter to this condition is ExceptIfReceivedAfter Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1406,6 +1517,9 @@ Accept wildcard characters: False ``` ### -ReceivedBeforeDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -1416,7 +1530,6 @@ The corresponding exception parameter to this condition is ExceptIfReceivedBefor Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1426,6 +1539,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in recipient email addresses. 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"`. @@ -1440,7 +1556,6 @@ The corresponding exception parameter to this condition is ExceptIfRecipientAddr Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1450,6 +1565,9 @@ Accept wildcard characters: False ``` ### -RedirectTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RedirectTo parameter specifies an action for the Inbox rule that redirects the message to the specified recipient. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1465,7 +1583,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1475,6 +1592,9 @@ Accept wildcard characters: False ``` ### -SendTextMessageNotificationTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SendTextMessageNotificationTo parameter specifies an action for the Inbox rule that send a text message notification to the specified telephone number. @@ -1487,7 +1607,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1497,6 +1616,9 @@ Accept wildcard characters: False ``` ### -SentOnlyToMe + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SentOnlyToMe parameter specifies a condition for the Inbox rule that looks for messages where the only recipient is the mailbox owner. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is the only recipient. @@ -1508,7 +1630,6 @@ The corresponding exception parameter to this condition is ExceptIfSentOnlyToMe. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1518,6 +1639,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SentTo parameter specifies a condition for the Inbox rule that looks for messages with the specified recipients. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1535,7 +1659,6 @@ The corresponding exception parameter to this condition is ExceptIfSentTo. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1545,6 +1668,9 @@ Accept wildcard characters: False ``` ### -SoftDeleteMessage + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SoftDeleteMessage Description }} @@ -1553,7 +1679,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1563,6 +1688,9 @@ Accept wildcard characters: False ``` ### -StopProcessingRules + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StopProcessingRules parameter specifies an action for the Inbox rule that stops processing additional rules if the conditions of this Inbox rule are met. Valid values are:If set to $true, the StopProcessingRules parameter instructs Exchange to stop processing additional rules if the conditions of this Inbox rule are met. - $true: Stop processing more rules. @@ -1572,7 +1700,6 @@ The StopProcessingRules parameter specifies an action for the Inbox rule that st Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1582,6 +1709,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1596,7 +1726,6 @@ The corresponding exception parameter to this condition is ExceptIfSubjectContai Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1606,6 +1735,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1620,7 +1752,6 @@ The corresponding exception parameter to this condition is ExceptIfSubjectOrBody Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1630,13 +1761,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1646,6 +1779,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WithImportance parameter specifies a condition for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High @@ -1658,7 +1794,6 @@ The corresponding exception parameter to this condition is ExceptIfWithImportanc Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1668,6 +1803,9 @@ Accept wildcard characters: False ``` ### -WithinSizeRangeMaximum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WithinSizeRangeMaximum parameter specifies part of a condition for the Inbox rule that looks for messages that are smaller than specified maximum size. When you enter a value, qualify the value with one of the following units: @@ -1678,7 +1816,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You need to use this parameter with the WithinSizeRangeMinimum parameter, and the value of this parameter must be greater than the value of WithinSizeRangeMinimum. @@ -1688,7 +1826,6 @@ The corresponding exception parameter to this condition is ExceptIfWithinSizeRan Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1698,6 +1835,9 @@ Accept wildcard characters: False ``` ### -WithinSizeRangeMinimum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WithinSizeRangeMinimum parameter specifies part of a condition for the Inbox rule that looks for messages that are larger than the specified minimum size. When you enter a value, qualify the value with one of the following units: @@ -1708,7 +1848,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. You need to use this parameter with the WithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of WithinSizeRangeMaximum. @@ -1718,7 +1858,6 @@ The corresponding exception parameter to this condition is ExceptIfWithinSizeRan Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1728,6 +1867,9 @@ Accept wildcard characters: False ``` ### -WithSensitivity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WithSensitivity parameter specifies a condition for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal @@ -1741,7 +1883,6 @@ The corresponding exception parameter to this condition is ExceptIfWithSensitivi Type: Sensitivity Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-InformationBarrierPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-InformationBarrierPolicy.md index 2fbe4dd044..f9a9ae0ea5 100644 --- a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-InformationBarrierPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-informationbarrierpolicy applicable: Security & Compliance -title: Set-InformationBarrierPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-informationbarrierpolicy +schema: 2.0.0 +title: Set-InformationBarrierPolicy --- # Set-InformationBarrierPolicy @@ -81,6 +82,9 @@ This example activates the specified inactive information barrier policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the information barrier policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -91,7 +95,6 @@ The Identity parameter specifies the information barrier policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -101,13 +104,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -117,13 +122,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -141,7 +151,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -ModerationAllowed + +> Applicable: Security & Compliance + {{ Fill ModerationAllowed Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -SegmentsAllowed + +> Applicable: Security & Compliance + 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. You identify the segment by its Name value. If the value contains spaces, enclose the value in quotation marks ("). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). @@ -177,7 +191,6 @@ You can't use this parameter with the SegmentsBlocked parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsAllowed Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -187,13 +200,15 @@ Accept wildcard characters: False ``` ### -SegmentAllowedFilter + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: OrganizationSegmentAllowedFilter Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -203,6 +218,9 @@ Accept wildcard characters: False ``` ### -SegmentsBlocked + +> Applicable: Security & Compliance + The SegmentsBlocked parameter specifies the segments that aren't allowed to communicate with the segment in this policy (users defined by the AssignedSegment parameter). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). You identify the segment by its Name value. If the value contains spaces, enclose the value in quotation marks ("). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). @@ -213,7 +231,6 @@ You can't use this parameter with the SegmentsAllowed parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsBlocked Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -223,6 +240,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Security & Compliance + The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: - Active @@ -233,7 +253,6 @@ Type: EopInformationBarrierPolicyState Parameter Sets: (All) Aliases: Accepted values: Inactive, Active -Applicable: Security & Compliance Required: False Position: Named @@ -243,13 +262,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -271,4 +292,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-IntraOrganizationConnector.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IntraOrganizationConnector.md index 5216746dff..a1f7a1c74d 100644 --- a/exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IntraOrganizationConnector.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-intraorganizationconnector -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-IntraOrganizationConnector -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-intraorganizationconnector +schema: 2.0.0 +title: Set-IntraOrganizationConnector --- # Set-IntraOrganizationConnector ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-IntraOrganizationConnector cmdlet to modify an existing Intra-Organization connector between two on-premises Exchange forests in an organization, between an on-premises Exchange organization and an Exchange Online organization or between two Exchange Online organizations. @@ -35,7 +36,7 @@ Set-IntraOrganizationConnector [-Identity] Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the Intra-Organization connector that you want to modify. You can use any value that uniquely identifies the connector. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the Intra-Organization connector that you want Type: IntraOrganizationConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DiscoveryEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DiscoveryEndpoint parameter specifies the externally accessible URL used for the Autodiscover service for the domain configured in the IntraOrganization Connector. This parameter is automatically populated with the TargetAutodiscoverEpr value from the Get-FederationInformation cmdlet for the defined domain. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -112,7 +122,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter enables or disabled the Intra-organization connector. The valid values for this parameter are $true or $false. The default value is $true. When you set the value to $false, you completely stop connectivity for the specific connection. @@ -130,7 +142,6 @@ When you set the value to $false, you completely stop connectivity for the speci Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -TargetAddressDomains -The TargetAddressDomains parameter specifies the domain namespaces that will be used in the Intra-Organization connector. The domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The TargetAddressDomains parameter specifies the domain namespaces to be used in the Intra-Organization connector. The domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -156,15 +169,17 @@ Accept wildcard characters: False ``` ### -TargetSharingEpr + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services that will be used in the Intra-Organization connector. +The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services to be used in the Intra-Organization connector. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-JournalRule.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-JournalRule.md index 3c8d9f1233..05448cdeb4 100644 --- a/exchange/exchange-ps/exchange/Set-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-JournalRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-journalrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-JournalRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-journalrule +schema: 2.0.0 +title: Set-JournalRule --- # Set-JournalRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-JournalRule cmdlet to modify an existing journal rule in your organization. @@ -35,7 +36,7 @@ Set-JournalRule [-Identity] ## DESCRIPTION The Set-JournalRule cmdlet modifies an existing journal rule used in your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,8 @@ Set-JournalRule "Consolidated Messenger" -JournalEmailAddress "ArchiveMailbox@co This example modifies the journal email address to which journal reports are sent by the existing journal rule Consolidated Messenger. +The Identity parameter is positional, which means you can use it without the -Identity label in the supported location in the command (in this case, first). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). + ### Example 2 ```powershell Get-JournalRule | Set-JournalRule -JournalEmailAddress "Archive Mailbox" @@ -56,15 +59,15 @@ This example modifies the journal email address for all journal rules. The Get-J ## PARAMETERS ### -Identity -The Identity parameter specifies the name or GUID of the rule you want to modify. -The Identity parameter is a positional parameter. When using positional parameters in a command, you can omit the parameter label. +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The Identity parameter specifies the name or GUID of the rule you want to modify. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -83,7 +89,6 @@ 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 Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -101,7 +109,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -JournalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The JournalEmailAddress parameter specifies a journal recipient. Journal reports for the specified rule are sent to the journal recipient. You can use any value that uniquely identifies the recipient. For example: - Name @@ -124,7 +134,6 @@ The JournalEmailAddress parameter specifies a journal recipient. Journal reports Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -Recipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or received from a recipient are journaled. To journal messages from all recipients, use the value $null for this parameter. @@ -158,7 +172,6 @@ To journal messages from all recipients, use the value $null for this parameter. Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -168,6 +181,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Scope parameter specifies the scope of email messages to which the journal rule is applied. You can use the following values: - Global: Global rules process all email messages that pass through a Transport service. This includes email messages that were already processed by the external and internal rules. @@ -178,7 +194,6 @@ The Scope parameter specifies the scope of email messages to which the journal r Type: JournalRuleScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Label.md b/exchange/exchange-ps/ExchangePowerShell/Set-Label.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-Label.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Label.md index dee92d9e01..9afee26214 100644 --- a/exchange/exchange-ps/exchange/Set-Label.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Label.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/policy-and-compliance/set-label applicable: Security & Compliance -title: Set-Label -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/policy-and-compliance/set-label +schema: 2.0.0 +title: Set-Label --- # Set-Label @@ -125,6 +126,9 @@ This example removes the localized label name and label Tooltips for "Label1" in ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitivity label that you want to modify. You can use any value that uniquely identifies the label. For example: - Name @@ -135,7 +139,6 @@ The Identity parameter specifies the sensitivity label that you want to modify. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -145,6 +148,9 @@ Accept wildcard characters: False ``` ### -AdvancedSettings + +> Applicable: Security & Compliance + The AdvancedSettings parameter enables specific features and capabilities for a sensitivity label. Specify this parameter with the identity (name or GUID) of the sensitivity label, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. @@ -153,7 +159,7 @@ Some of the settings that you configure with this parameter are supported only b 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). +- **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 affects 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). @@ -177,7 +183,6 @@ For more information to help you configure advanced settings for a label, see [P Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -187,6 +192,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterAlignment + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterAlignment parameter specifies the footer alignment. Valid values are: - Left @@ -199,7 +207,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -209,6 +216,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterEnabled + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterEnabled parameter enables or disables the Apply Content Marking Footer action for the label. Valid values are: - $true: The Apply Content Marking Footer action is enabled. @@ -218,7 +228,6 @@ The ApplyContentMarkingFooterEnabled parameter enables or disables the Apply Con Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -228,6 +237,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontColor + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontColor parameter specifies the color of the footer text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -236,7 +248,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -246,6 +257,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontName + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontName parameter specifies the font of the footer text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -256,7 +270,6 @@ This parameter is supported only by the Azure Information Protection unified lab Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -266,6 +279,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontSize + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontSize parameter specifies the font size (in points) of the footer text. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -274,7 +290,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -284,17 +299,19 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterMargin + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterMargin parameter specifies the size (in points) of the footer margin. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. -**Note**: In Microsoft Word and PowerPoint, the specified value is used as a bottom margin and left margin or right margin for left-aligned or right-aligned content marks. A minimum value of 15 points is required. Word also adds a constant offset of 5 points to the left margin for left-aligned content marks, or to the right margin for right-aligned content marks. +**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 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -304,6 +321,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterText + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterText parameter specifies the footer text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -312,7 +332,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -322,6 +341,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderAlignment + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderAlignment parameter specifies the header alignment. Valid values are: - Left @@ -334,7 +356,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -344,6 +365,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderEnabled + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderEnabled parameter enables or disables the Apply Content Marking Header action for the label. Valid values are: - $true: The Apply Content Marking Header action is enabled. @@ -353,7 +377,6 @@ The ApplyContentMarkingHeaderEnabled parameter enables or disables the Apply Con Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -363,6 +386,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontColor + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontColor parameter specifies the color of the header text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -371,7 +397,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -381,6 +406,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontName + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontName parameter specifies the font of the header text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -389,7 +417,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -399,6 +426,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontSize + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontSize parameter specifies the font size (in points) of the header text. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -407,7 +437,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -417,6 +446,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderMargin + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderMargin parameter specifies the size (in points) of the header margin. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -427,7 +459,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -437,6 +468,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderText + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderText parameter specifies the header text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -445,7 +479,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -455,7 +488,10 @@ Accept wildcard characters: False ``` ### -ApplyDynamicWatermarkingEnabled -**Note**: This parameter is currently in Public Preview, isn't available in all organizations, and is subject to change. + +> Applicable: Security & Compliance + +**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: @@ -468,7 +504,6 @@ You set the watermark text with the DynamicWatermarkDisplay parameter. For more Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -478,6 +513,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingEnabled + +> Applicable: Security & Compliance + The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarking Header action for the label. Valid values are: - $true: The Apply Watermarking Header action is enabled. @@ -487,7 +525,6 @@ The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarkin Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -497,6 +534,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontColor + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontColor parameter specifies the color of the watermark text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -505,7 +545,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -515,6 +554,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontName + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontName parameter specifies the font of the watermark text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -523,7 +565,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -533,6 +574,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontSize + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontSize parameter specifies the font size (in points) of the watermark text. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -541,7 +585,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -551,6 +594,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingLayout + +> Applicable: Security & Compliance + The ApplyWaterMarkingLayout parameter specifies the watermark alignment. Valid values are: - Horizontal @@ -562,7 +608,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -572,6 +617,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingText + +> Applicable: Security & Compliance + The ApplyWaterMarkingText parameter specifies the watermark text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -580,7 +628,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -590,13 +637,15 @@ Accept wildcard characters: False ``` ### -ColumnAssetCondition + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -606,13 +655,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -622,13 +673,15 @@ Accept wildcard characters: False ``` ### -Conditions + +> Applicable: Security & Compliance + The Conditions parameter is used for automatic labeling of files and email for data in use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -638,6 +691,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -647,7 +703,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -657,6 +712,9 @@ Accept wildcard characters: False ``` ### -ContentType + +> Applicable: Security & Compliance + The ContentType parameter specifies where the sensitivity label can be applied. Valid values are: - File @@ -673,7 +731,6 @@ Values can be combined, for example: "File, Email, PurviewAssets". Type: MipLabelContentType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -683,13 +740,15 @@ Accept wildcard characters: False ``` ### -DefaultContentLabel + +> Applicable: Security & Compliance + The DefaultContentLabel specifies a label that can be automatically applied to meetings created in a labeled Teams channel. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -699,13 +758,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name for the sensitivity label. The display name appears in any client that supports sensitivity labels. This includes Word, Excel, PowerPoint, Outlook, SharePoint, Teams, and Power BI. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -715,7 +776,10 @@ Accept wildcard characters: False ``` ### -DynamicWatermarkDisplay -**Note**: This parameter is currently in Public Preview, isn't available in all organizations, and is subject to change. + +> Applicable: Security & Compliance + +**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: @@ -730,7 +794,6 @@ This parameter is meaningful only when the ApplyDynamicWatermarkingEnabled param Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -740,6 +803,9 @@ Accept wildcard characters: False ``` ### -EncryptionContentExpiredOnDateInDaysOrNever + +> Applicable: Security & Compliance + The EncryptionContentExpiredOnDateInDaysOrNever parameter specifies when the encrypted content expires. Valid values are: - An integer (number of days) @@ -751,7 +817,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -761,6 +826,9 @@ Accept wildcard characters: False ``` ### -EncryptionDoNotForward + +> Applicable: Security & Compliance + The EncryptionDoNotForward parameter specifies whether the Do Not Forward template is applied. Valid values are: - $true: The Do Not Forward template is applied. @@ -772,7 +840,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -782,13 +849,15 @@ Accept wildcard characters: False ``` ### -EncryptionDoubleKeyEncryptionUrl + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -798,6 +867,9 @@ Accept wildcard characters: False ``` ### -EncryptionEnabled + +> Applicable: Security & Compliance + The EncryptionEnabled parameter specifies whether encryption in enabled. Valid values are: - $true: Encryption is enabled. @@ -807,7 +879,6 @@ The EncryptionEnabled parameter specifies whether encryption in enabled. Valid v Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -817,6 +888,9 @@ Accept wildcard characters: False ``` ### -EncryptionEncryptOnly + +> Applicable: Security & Compliance + The EncryptionEncryptOnly parameter specifies whether the encrypt-only template is applied. Valid values are: - $true: The encrypt-only template is applied. @@ -828,7 +902,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -838,6 +911,9 @@ Accept wildcard characters: False ``` ### -EncryptionOfflineAccessDays + +> Applicable: Security & Compliance + The EncryptionOfflineAccessDays parameter specifies the number of days that offline access is allowed. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -846,7 +922,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -856,6 +931,9 @@ Accept wildcard characters: False ``` ### -EncryptionPromptUser + +> Applicable: Security & Compliance + The EncryptionPromptUser parameter specifies whether to set the label with user defined permission in Word, Excel, and PowerPoint. Valid values are: - $true: The label is set with user defined permissions in Word, Excel and PowerPoint. @@ -867,7 +945,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -877,6 +954,9 @@ Accept wildcard characters: False ``` ### -EncryptionProtectionType + +> Applicable: Security & Compliance + The EncryptionProtectionType parameter specifies the protection type for encryption. Valid values are: - Template @@ -889,7 +969,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -899,6 +978,9 @@ Accept wildcard characters: False ``` ### -EncryptionRightsDefinitions + +> Applicable: Security & Compliance + The EncryptionRightsDefinitions parameter specifies the rights users have when accessing protected. This parameter uses the syntax `Identity1:Rights1,Rights2;Identity2:Rights3,Rights4`. For example, `john@contoso.com:VIEW,EDIT;microsoft.com:VIEW`. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false and the EncryptionProtectionType parameter value is Template. @@ -907,7 +989,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: EncryptionRightsDefinitionsParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -917,6 +998,9 @@ Accept wildcard characters: False ``` ### -EncryptionRightsUrl + +> Applicable: Security & Compliance + The EncryptionRightsUrl parameter specifies the URL for hold your own key (HYOK) protection. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -925,7 +1009,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -935,13 +1018,15 @@ Accept wildcard characters: False ``` ### -LabelActions + +> Applicable: Security & Compliance + The LabelActions parameter is used to specify actions that can be performed on labels. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -951,6 +1036,9 @@ Accept wildcard characters: False ``` ### -LocaleSettings + +> Applicable: Security & Compliance + The LocaleSettings parameter specifies one or more localized label names and label Tooltips in different languages. Regions include all region codes supported in Office Client applications. Valid values use the following syntax (JSON): - Label display names: `{"localeKey":"DisplayName","Settings":[{"Key":"en-us","Value":"English display name"},{"Key":"de-de","Value":"Deutscher Anzeigename"},{"Key":"es-es","Value":"Nombre para mostrar en Español"}]}` @@ -962,7 +1050,6 @@ To remove a language, you need to enter an empty value for that language. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -972,13 +1059,15 @@ Accept wildcard characters: False ``` ### -MigrationId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -988,13 +1077,15 @@ Accept wildcard characters: False ``` ### -NextLabel + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1004,6 +1095,9 @@ Accept wildcard characters: False ``` ### -ParentId + +> Applicable: Security & Compliance + The ParentId parameter specifies the parent label that you want this label to be under (a sublabel). You can use any value that uniquely identifies the parent sensitivity label. For example: - Name @@ -1014,7 +1108,6 @@ The ParentId parameter specifies the parent label that you want this label to be Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1024,13 +1117,15 @@ Accept wildcard characters: False ``` ### -PreviousLabel + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1040,13 +1135,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the sensitivity label that determines the order of label processing. A higher integer value indicates a higher priority. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1056,13 +1153,15 @@ Accept wildcard characters: False ``` ### -SchematizedDataCondition + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1072,13 +1171,15 @@ Accept wildcard characters: False ``` ### -Setting + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1088,13 +1189,15 @@ Accept wildcard characters: False ``` ### -Settings + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1104,6 +1207,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowAccessToGuestUsers + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowAccessToGuestUsers parameter enables or disables access to guest users. Valid values are: - $true: Guest access is enabled. @@ -1115,7 +1221,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1125,6 +1230,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowEmailFromGuestUsers + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowEmailFromGuestUsers parameter enables or disables email from guest users. Valid values are: - $true: Email from guest users is enabled. @@ -1136,7 +1244,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1146,6 +1253,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowFullAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowFullAccess parameter enables or disables full access. Valid values are: - $true: Full access is enabled. @@ -1157,7 +1267,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1167,6 +1276,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowLimitedAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowLimitedAccess parameter enables or disables limited access. Valid values are: - $true: Limited access is enabled. @@ -1178,7 +1290,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1188,6 +1299,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionBlockAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionBlockAccess parameter blocks access. Valid values are: - $true: Access is blocked. @@ -1199,7 +1313,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1209,6 +1322,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionEnabled + +> Applicable: Security & Compliance + The SiteAndGroupProtectionEnabled parameter enables or disables the Site and Group Protection action for the label. Valid values are: - $true: The Site and Group Protection action is enabled. @@ -1218,7 +1334,6 @@ The SiteAndGroupProtectionEnabled parameter enables or disables the Site and Gro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1228,13 +1343,15 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionLevel + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SiteAndGroupProtectionLevelParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1244,6 +1361,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionPrivacy + +> Applicable: Security & Compliance + The SiteAndGroupProtectionPrivacy parameter specifies the privacy level for the labe. Valid values are: - Public @@ -1255,7 +1375,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1265,6 +1384,9 @@ Accept wildcard characters: False ``` ### -SiteExternalSharingControlType + +> Applicable: Security & Compliance + The SiteExternalSharingControlType parameter specifies the external user sharing setting for the label. Valid values are: - ExternalUserAndGuestSharing @@ -1283,7 +1405,6 @@ These correspond to the following settings through the admin center: Type: Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1293,6 +1414,9 @@ Accept wildcard characters: False ``` ### -TeamsAllowedPresenters + +> Applicable: Security & Compliance + The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Valid values are: - Everyone @@ -1305,7 +1429,6 @@ The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AllowedPresenters Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1315,6 +1438,9 @@ Accept wildcard characters: False ``` ### -TeamsAllowMeetingChat + +> Applicable: Security & Compliance + The TeamsAllowMeetingChat parameter controls whether chat is available in Teams meetings. Valid values are: - Enabled @@ -1326,7 +1452,6 @@ The TeamsAllowMeetingChat parameter controls whether chat is available in Teams Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.MeetingChatMode Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1336,13 +1461,15 @@ Accept wildcard characters: False ``` ### -TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch + +> Applicable: Security & Compliance + {{ Fill TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1352,6 +1479,9 @@ Accept wildcard characters: False ``` ### -TeamsBypassLobbyForDialInUsers + +> Applicable: Security & Compliance + The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for dial-in users who join Teams meetings. Valid values are: - $true: Dial in users bypass the lobby when joining Teams meetings. @@ -1362,7 +1492,6 @@ The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for d Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1372,13 +1501,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelProtectionEnabled + +> Applicable: Security & Compliance + {{ Fill TeamsChannelProtectionEnabled Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1388,13 +1519,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithExternalTenants + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithExternalTenants Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1404,13 +1537,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithPrivateTeamsOnly + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1420,13 +1555,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithSameLabelOnly + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithSameLabelOnly Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1436,6 +1573,9 @@ Accept wildcard characters: False ``` ### -TeamsCopyRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: - $true: Chat messages can be copied to the clipboard. @@ -1445,7 +1585,6 @@ The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Tea Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1455,6 +1594,9 @@ Accept wildcard characters: False ``` ### -TeamsEndToEndEncryptionEnabled + +> Applicable: Security & Compliance + The TeamsEndToEndEncryptionEnabled parameter controls video stream encryption in Teams meetings. Valid values are: - $true: Video stream encryption is enabled. @@ -1465,7 +1607,6 @@ The TeamsEndToEndEncryptionEnabled parameter controls video stream encryption in Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1475,6 +1616,9 @@ Accept wildcard characters: False ``` ### -TeamsLobbyBypassScope + +> Applicable: Security & Compliance + The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Teams meetings. Valid values are: - Everyone @@ -1489,7 +1633,6 @@ The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.LobbyBypassScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1499,6 +1642,9 @@ Accept wildcard characters: False ``` ### -TeamsLobbyRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass the lobby when joining Teams meetings. Valid values are: - $true: Users bypass the lobby when joining Teams meetings. @@ -1509,7 +1655,6 @@ The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1519,6 +1664,9 @@ Accept wildcard characters: False ``` ### -TeamsPresentersRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsPresentersRestrictionEnforced parameter controls whether presenter restrictions are enabled in Teams meetings. Valid values are: - $true: Presenter restrictions are enabled in Teams meetings. @@ -1529,7 +1677,6 @@ The TeamsPresentersRestrictionEnforced parameter controls whether presenter rest Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1539,6 +1686,9 @@ Accept wildcard characters: False ``` ### -TeamsProtectionEnabled + +> Applicable: Security & Compliance + The TeamsProtectionEnabled parameter controls whether Teams protection is enabled in Teams meetings. Valid values are: - $true: Teams protection is enabled in Teams meetings. @@ -1548,7 +1698,6 @@ The TeamsProtectionEnabled parameter controls whether Teams protection is enable Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1558,6 +1707,9 @@ Accept wildcard characters: False ``` ### -TeamsRecordAutomatically + +> Applicable: Security & Compliance + The TeamsRecordAutomatically parameter controls whether Teams meetings are automatically recorded after they start. Valid values are: - $true: Teams meetings are automatically recorded after they start. @@ -1568,7 +1720,6 @@ The TeamsRecordAutomatically parameter controls whether Teams meetings are autom Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1578,6 +1729,9 @@ Accept wildcard characters: False ``` ### -TeamsVideoWatermark + +> Applicable: Security & Compliance + The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams meetings. Valid values are: - None @@ -1589,7 +1743,6 @@ The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WaterMarkProtectionValues Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1599,6 +1752,9 @@ Accept wildcard characters: False ``` ### -TeamsWhoCanRecord + +> Applicable: Security & Compliance + The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid values are: - Organizer @@ -1610,7 +1766,6 @@ The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid va Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WhoCanRecordOptions Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1620,13 +1775,15 @@ Accept wildcard characters: False ``` ### -Tooltip + +> Applicable: Security & Compliance + The ToolTip parameter specifies the default tooltip and sensitivity label description that's seen by users. It the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1636,13 +1793,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -1662,4 +1821,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-Label](https://learn.microsoft.com/powershell/module/exchange/new-label) +[New-Label](https://learn.microsoft.com/powershell/module/exchangepowershell/new-label) diff --git a/exchange/exchange-ps/exchange/Set-LabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-LabelPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-LabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-LabelPolicy.md index 5b190d2637..7d14426eaa 100644 --- a/exchange/exchange-ps/exchange/Set-LabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-LabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-labelpolicy applicable: Security & Compliance -title: Set-LabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-labelpolicy +schema: 2.0.0 +title: Set-LabelPolicy --- # Set-LabelPolicy @@ -104,6 +105,9 @@ This example configures the specified advanced setting for the sensitivity label ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -114,7 +118,6 @@ The Identity parameter specifies the policy that you want to view. You can use a Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -134,7 +140,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. A valid value is a mailbox. To specify the mailbox, you can use any value that uniquely identifies it. For example: @@ -159,7 +167,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -169,6 +176,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocationException + +> Applicable: Security & Compliance + The AddExchangeLocationException parameter specifies the mailboxes to add to the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. A valid value is a mailbox. To specify the mailbox, you can use any value that uniquely identifies it. For example: @@ -184,7 +194,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -194,6 +203,9 @@ Accept wildcard characters: False ``` ### -AddLabels + +> Applicable: Security & Compliance + The AddLabels parameter specifies the sensitivity labels that you want to add to the policy. You can use any value that uniquely identifies the label. For example: - Name @@ -206,7 +218,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -216,6 +227,9 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocation + +> Applicable: Security & Compliance + The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups. To identify the Microsoft 365 Group, you must use the primary SMTP address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -224,7 +238,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -234,13 +247,15 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -250,13 +265,15 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -266,13 +283,15 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -282,13 +301,15 @@ Accept wildcard characters: False ``` ### -AddPublicFolderLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -298,13 +319,15 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -314,13 +337,15 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -330,13 +355,15 @@ Accept wildcard characters: False ``` ### -AddSkypeLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -346,13 +373,15 @@ Accept wildcard characters: False ``` ### -AddSkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -362,6 +391,9 @@ Accept wildcard characters: False ``` ### -AdvancedSettings + +> Applicable: Security & Compliance + The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. Specify this parameter with the identity (name or GUID) of the policy, with key/value pairs in a [hash table](https://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. @@ -384,7 +416,7 @@ Supported settings for built-in labeling: - **teamworkdefaultlabelid**: Outlook and Teams apps that support this setting apply a default label, or no label for meetings. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{teamworkdefaultlabelid="General"}`. For more information about labeling meetings, see [Use sensitivity labels to protect calendar items, Teams meetings, and chat](https://learn.microsoft.com/purview/sensitivity-labels-meetings). -- **HideBarByDefault**: For Office apps that support the sensitivity bar, don't display the sensitivity label name on the window bar title so that there's more space to display long file names. Just the label icon and color (if configured) will be displayed. Users can't revert this setting in the app. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{HideBarByDefault="True"}` +- **HideBarByDefault**: For Office apps that support the sensitivity bar, don't display the sensitivity label name on the window bar title so that there's more space to display long file names. Just the label icon and color (if configured) are displayed. Users can't revert this setting in the app. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{HideBarByDefault="True"}` - **DisableShowSensitiveContent**: For Office apps that highlight the sensitive content that caused a label to be recommended, turn off these highlights and corresponding indications about the sensitive content. For more information, see [Sensitivity labels are automatically applied or recommended for your files and emails in Office](https://support.microsoft.com/office/sensitivity-labels-are-automatically-applied-or-recommended-for-your-files-and-emails-in-office-622e0d9c-f38c-470a-bcdb-9e90b24d71a1). Supported apps: Word for Windows (version 2311+). Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableShowSensitiveContent="True"}` @@ -398,7 +430,6 @@ Additionally, for Power BI: Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -408,13 +439,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity, AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -424,6 +457,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -433,7 +469,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -443,6 +478,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -451,7 +489,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -461,13 +498,15 @@ Accept wildcard characters: False ``` ### -MigrationId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -477,6 +516,9 @@ Accept wildcard characters: False ``` ### -NextLabelPolicy + +> Applicable: Security & Compliance + The NextLabelPolicy parameter updates the policy order so the policy that's specified by this parameter is after the current policy that you're modifying. You can use any value that uniquely identifies the policy. For example: - Name @@ -487,7 +529,6 @@ The NextLabelPolicy parameter updates the policy order so the policy that's spec Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -497,6 +538,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + 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. @@ -505,7 +549,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -515,6 +558,9 @@ Accept wildcard characters: False ``` ### -PreviousLabelPolicy + +> Applicable: Security & Compliance + The PreviousLabelPolicy parameter updates the policy order so the policy that's specified by this parameter is before the current policy that you're modifying. You can use any value that uniquely identifies the policy. For example: - Name @@ -525,7 +571,6 @@ The PreviousLabelPolicy parameter updates the policy order so the policy that's Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -535,6 +580,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -553,7 +601,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -563,6 +610,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocationException + +> Applicable: Security & Compliance + The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you're using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -581,7 +631,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -591,6 +640,9 @@ Accept wildcard characters: False ``` ### -RemoveLabels + +> Applicable: Security & Compliance + The RemoveLabels parameter specifies the sensitivity labels that you want to remove from the policy. You can use any value that uniquely identifies the label. For example: - Name @@ -603,7 +655,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -613,6 +664,9 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocation + +> Applicable: Security & Compliance + The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups. To identify the Microsoft 365 Group, you must use the primary SMTP address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -621,7 +675,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -631,13 +684,15 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -647,13 +702,15 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -663,13 +720,15 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -679,13 +738,15 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -695,13 +756,15 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -711,13 +774,15 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -727,13 +792,15 @@ Accept wildcard characters: False ``` ### -RemoveSkypeLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -743,13 +810,15 @@ Accept wildcard characters: False ``` ### -RemoveSkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -759,13 +828,15 @@ Accept wildcard characters: False ``` ### -Setting + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -775,13 +846,15 @@ Accept wildcard characters: False ``` ### -Settings + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -791,13 +864,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-LinkedUser.md b/exchange/exchange-ps/ExchangePowerShell/Set-LinkedUser.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-LinkedUser.md rename to exchange/exchange-ps/ExchangePowerShell/Set-LinkedUser.md index ab7afd569b..5b19885817 100644 --- a/exchange/exchange-ps/exchange/Set-LinkedUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-LinkedUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-linkeduser applicable: Exchange Online, Exchange Online Protection -title: Set-LinkedUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-linkeduser +schema: 2.0.0 +title: Set-LinkedUser --- # Set-LinkedUser @@ -31,7 +32,7 @@ Set-LinkedUser [-Identity] ## DESCRIPTION The OLSync service account is the only linked user in your organization. By default, the account is named GALSync-ServiceAccount. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example modifies the certificate subject for the linked user "GALSync-Servi ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the linked user. You can use any value that uniquely identifies the linked user, for example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the linked user. You can use any value that uni Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -CertificateSubject + +> Applicable: Exchange Online + The CertificateSubject parameter specifies the value of the subject field of the user's digital certificate. The syntax of the CertificateSubject value is `X509:IssuerSubject`. The values of Issuer and Subject are required and must be in X.500 format. To remove the value of CertificateSubject, specify the value $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -89,7 +97,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicy.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicy.md index db10ad8518..4d44abfb09 100644 --- a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-M365DataAtRestEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-m365dataatrestencryptionpolicy +schema: 2.0.0 +title: Set-M365DataAtRestEncryptionPolicy --- # Set-M365DataAtRestEncryptionPolicy @@ -45,7 +46,7 @@ Set-M365DataAtRestEncryptionPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,11 +62,14 @@ This example disabled the Microsoft 365 data-at-rest encryption policy named Ten Set-M365DataAtRestEncryptionPolicy -Identity "Tenant Default Policy" -Refresh ``` -This example updates the Microsoft 365 data-at-rest encryption policy named Tenant Default Policy after one of the associated keys has been rotated in the Azure Key Vault. +This example updates the Microsoft 365 data-at-rest encryption policy named Tenant Default Policy after one of the associated keys is rotated in the Azure Key Vault. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the data-at-rest encryption policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -76,7 +80,6 @@ The Identity parameter specifies the data-at-rest encryption policy that you wan Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -95,7 +101,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online + The Description parameter specifies an optional description for the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -137,16 +146,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: -- $true: The policy is enabled. This is the default value. +- $true: The policy is enabled. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -164,7 +178,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: DCAdminPurgeKeyRequest, TenantAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the Microsoft 365 data-at-rest encryption policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -190,13 +205,15 @@ Accept wildcard characters: False ``` ### -Refresh + +> Applicable: Exchange Online + Use the Refresh switch to update the Microsoft 365 data-at-rest encryption policy in Exchange Online after you rotate any of the associated keys in the Azure Key Vault. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: RefreshKey Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -206,13 +223,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md b/exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicyAssignment.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicyAssignment.md index d5a82bfdda..321d855a48 100644 --- a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicyAssignment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicyassignment applicable: Exchange Online -title: Set-M365DataAtRestEncryptionPolicyAssignment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-m365dataatrestencryptionpolicyassignment +schema: 2.0.0 +title: Set-M365DataAtRestEncryptionPolicyAssignment --- # Set-M365DataAtRestEncryptionPolicyAssignment @@ -25,7 +26,7 @@ Set-M365DataAtRestEncryptionPolicyAssignment -DataEncryptionPolicy Applicable: Exchange Online + The DataEncryptionPolicy parameter specifies the Microsoft 365 data-at-rest encryption policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -49,7 +53,6 @@ The DataEncryptionPolicy parameter specifies the Microsoft 365 data-at-rest encr Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailContact.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailContact.md index e699c9dec7..2b06f8b281 100644 --- a/exchange/exchange-ps/exchange/Set-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailContact.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailcontact -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailContact -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailcontact +schema: 2.0.0 +title: Set-MailContact --- # Set-MailContact ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailContact cmdlet to modify existing mail contacts. @@ -92,7 +93,7 @@ Set-MailContact [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -106,6 +107,9 @@ This example sets John Rodman's external email address to john@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail contact that you want to modify. You can use any value that uniquely identifies the mail contact. For example: - Name @@ -119,7 +123,6 @@ The Identity parameter specifies the mail contact that you want to modify. You c Type: MailContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -129,6 +132,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -152,7 +158,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -162,6 +167,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -185,7 +193,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -195,6 +202,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -220,7 +230,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -230,6 +239,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -254,7 +266,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -264,6 +275,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -283,7 +297,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +306,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -314,7 +330,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -324,6 +339,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -333,7 +351,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -343,18 +360,20 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: -- $true: A DTMF map is created for the recipient. This is the default value. +- $true: A DTMF map is created for the recipient. This value is the default. - $false: A DTMF map isn't created for the recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -364,13 +383,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -380,13 +401,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -396,13 +419,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -412,13 +437,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -428,13 +455,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -444,13 +473,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -460,13 +491,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -476,13 +509,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -492,13 +527,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,13 +545,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -524,13 +563,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -540,13 +581,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -556,13 +599,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -572,13 +617,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -588,13 +635,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -604,13 +653,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the mail contact. The display name is visible in the Exchange admin center (EAC) and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -620,6 +671,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -628,7 +682,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -638,6 +691,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -665,7 +721,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -675,18 +730,20 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: -- $true: Email address policies are applied to this recipient. This is the default value. +- $true: Email address policies are applied to this recipient. This value is the default. - $false: Email address policies aren't applied to this recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -696,19 +753,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -718,19 +777,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -740,19 +801,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -762,19 +825,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -784,19 +849,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -806,6 +873,9 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. @@ -816,7 +886,6 @@ When you use the ExternalEmailAddress parameter to change the external email add Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -826,13 +895,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -842,6 +913,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mail contact. Although messages sent on behalf of the mail contact clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the mail contact, not the sender. The sender you specify for this parameter must 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 sender. For example: @@ -867,7 +941,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -877,16 +950,18 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. -- $false: The recipient is visible in address lists. This is the default value. +- $false: The recipient is visible in address lists. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -896,6 +971,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -909,7 +987,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -919,9 +996,12 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: -- BinHex (This is the default value) +- BinHex (default value) - UuEncode - AppleSingle - AppleDouble @@ -935,7 +1015,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -945,6 +1024,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -956,7 +1038,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -966,6 +1047,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -980,7 +1064,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -990,6 +1073,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail contact. Messages larger than the maximum size are rejected. @@ -1001,7 +1087,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited. @@ -1013,7 +1099,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1023,6 +1108,9 @@ Accept wildcard characters: False ``` ### -MaxRecipientPerMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxRecipientPerMessage parameter specifies the maximum number of recipients allowed in messages sent by the mail contact. @@ -1035,7 +1123,6 @@ The value unlimited indicates the maximum number of recipients per message for t Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1045,6 +1132,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail contact. @@ -1056,7 +1146,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited. @@ -1068,7 +1158,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1078,11 +1167,14 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text - Html -- TextAndHtml (This is the default value) +- TextAndHtml (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -1093,7 +1185,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1103,10 +1194,13 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are: - Text -- Mime (This is the default value) +- Mime (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -1119,7 +1213,6 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1129,6 +1222,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1148,7 +1244,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1158,10 +1253,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -1169,7 +1267,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1179,13 +1276,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the mail contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1195,6 +1294,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. @@ -1209,7 +1311,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1219,6 +1320,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1242,7 +1346,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1252,6 +1355,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1275,7 +1381,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1285,6 +1390,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1310,7 +1418,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1320,6 +1427,9 @@ Accept wildcard characters: False ``` ### -RemovePicture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemovePicture switch removes the picture from the mail contact. You don't need to specify a value with this switch. @@ -1330,7 +1440,6 @@ You can add a picture to a mail contact by using the Import-RecipientDataPropert Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1340,6 +1449,9 @@ Accept wildcard characters: False ``` ### -RemoveSpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoveSpokenName switch removes the spoken name from the mail contact. You don't need to specify a value with this switch. @@ -1350,7 +1462,6 @@ You can add a sound file to a mail contact by using the Import-RecipientDataProp Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1360,6 +1471,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1369,7 +1483,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1379,6 +1492,9 @@ Accept wildcard characters: False ``` ### -SecondaryAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SecondaryAddress parameter specifies the secondary address that's used by the Unified Messaging (UM)-enabled mail contact. @@ -1387,7 +1503,6 @@ The SecondaryAddress parameter specifies the secondary address that's used by th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1397,6 +1512,9 @@ Accept wildcard characters: False ``` ### -SecondaryDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. @@ -1405,7 +1523,6 @@ The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1415,9 +1532,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -1427,7 +1547,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1437,6 +1556,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -1449,7 +1571,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1459,6 +1580,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -1479,7 +1603,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1489,6 +1612,9 @@ Accept wildcard characters: False ``` ### -UseMapiRichTextFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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: - Always: TNEF is used for all messages sent to the mail user or mail contact. @@ -1501,7 +1627,6 @@ The default value is UseDefaultSettings. Type: UseMapiRichTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1511,16 +1636,18 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are: - $true: Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact. -- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This is the default value. +- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1530,6 +1657,9 @@ Accept wildcard characters: False ``` ### -UserCertificate + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -1538,7 +1668,6 @@ The UserCertificate parameter specifies the digital certificate used to sign a u Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1548,6 +1677,9 @@ Accept wildcard characters: False ``` ### -UserSMimeCertificate + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -1556,7 +1688,6 @@ The UserSMimeCertificate parameter specifies the S/MIME certificate that's used Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1566,13 +1697,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1582,6 +1715,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -1593,7 +1729,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailPublicFolder.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-MailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailPublicFolder.md index 8dd27b3503..1b5c034778 100644 --- a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailPublicFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailpublicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailPublicFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailpublicfolder +schema: 2.0.0 +title: Set-MailPublicFolder --- # Set-MailPublicFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailPublicFolder cmdlet to configure the mail-related settings of mail-enabled public folders. If you want to configure basic settings that aren't mail-related, use the Set-PublicFolder cmdlet. @@ -90,7 +91,7 @@ Set-MailPublicFolder [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,6 +121,9 @@ This example removes the secondary email address MyPublicFolder@fabrikam.com fro ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -128,7 +132,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: MailPublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -138,6 +141,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -161,7 +167,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -171,6 +176,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -194,7 +202,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -204,6 +211,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -229,7 +239,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -239,6 +248,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -263,7 +275,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -273,6 +284,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ArbitrationMailbox parameter specifies the mailbox used to manage the moderation process. You can use any value that uniquely identifies the mailbox. For example: @@ -292,7 +306,6 @@ The ArbitrationMailbox parameter specifies the mailbox used to manage the modera Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -302,6 +315,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -323,7 +339,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -333,6 +348,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -342,7 +360,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -352,6 +369,9 @@ Accept wildcard characters: False ``` ### -Contacts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Contacts parameter specifies the contacts for the public folder. Contacts are persons about whom you can save several types of information, such as addresses, telephone numbers, and web page URLs. Valid values for this parameter are recipients in your organization. You can use any value that uniquely identifies the recipient. For example: @@ -369,7 +389,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -379,13 +398,15 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010 + The CreateDTMFMap parameter specifies that a dual tone multi-frequency (DTMF) map be created for the user. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -395,13 +416,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,13 +434,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -427,13 +452,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -443,13 +470,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -459,13 +488,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -475,13 +506,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -491,13 +524,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -507,13 +542,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -523,13 +560,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -539,13 +578,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -555,13 +596,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -571,13 +614,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -587,13 +632,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -603,13 +650,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -619,13 +668,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -635,6 +686,9 @@ Accept wildcard characters: False ``` ### -DeliverToMailboxAndForward + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeliverToMailboxAndForward parameter specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress or ForwardingSmtpAddress parameters. Valid values are: - $true: Messages are delivered to this public folder and forwarded to the specified recipient or email address. @@ -646,7 +700,6 @@ The default value is $false. The value of this parameter is meaningful only if y Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -656,13 +709,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DisplayName parameter specifies the display name of the Public Folder Proxy object. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -672,6 +727,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -680,7 +738,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -690,6 +747,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -717,7 +777,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -727,16 +786,18 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: -- $true: Email address policies are applied to this recipient. This is the default value. +- $true: Email address policies are applied to this recipient. This value is the default. - $false: Email address policies aren't applied to this recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -746,13 +807,15 @@ Accept wildcard characters: False ``` ### -EntryId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EntryId parameter specifies the EntryID value for the public folder. You use this parameter to correct an existing EntryID that points to a folder that can't be found. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -762,19 +825,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -784,19 +849,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -806,19 +873,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -828,19 +897,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -850,19 +921,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -872,13 +945,15 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalEmailAddress parameter specifies an email address outside the organization. ```yaml Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -888,6 +963,9 @@ Accept wildcard characters: False ``` ### -ForwardingAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForwardingAddress parameter specifies a forwarding address for messages that are sent to this public folder. A valid value for this parameter is a recipient in your organization. You can use any value that uniquely identifies the recipient. For example: - Name @@ -908,7 +986,6 @@ The default value is blank ($null), which means no forwarding recipient is confi Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -918,6 +995,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this public folder. Although messages sent on behalf of the mail user clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the public folder, not the sender. The sender you specify for this parameter must 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 sender. For example: @@ -943,7 +1023,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -953,16 +1032,18 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. -- $false: The recipient is visible in address lists. This is the default value. +- $false: The recipient is visible in address lists. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -972,6 +1053,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -983,7 +1067,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -993,16 +1076,18 @@ Accept wildcard characters: False ``` ### -IgnoreMissingFolderLink + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreMissingFolderLink parameter specifies whether to exclude the mail-enabled public folder from a specific validation check that's used during a public folder migration. Valid values are: - $true: Skip the validation check. If the Active Directory object for the mail-enabled public folder doesn't have EntryId or ContentMailbox property values, the public folder is ignored, and the public folder migration can continue. -- $false: Don't skip the validation check. If the Active Directory object for the mail-enabled public folder doesn't have EntryId or ContentMailbox property values, the entire public folder migration will fail. This is the default value. +- $false: Don't skip the validation check. If the Active Directory object for the mail-enabled public folder doesn't have EntryId or ContentMailbox property values, the entire public folder migration will fail. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1012,6 +1097,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -1023,7 +1111,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1033,6 +1120,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -1047,7 +1137,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1057,6 +1146,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the public folder. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -1066,7 +1158,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -1076,7 +1168,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1086,6 +1177,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxSendSize parameter specifies the maximum size of a message that can be sent by the public folder. When you enter a value, qualify the value with one of the following units: @@ -1095,7 +1189,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -1105,7 +1199,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1115,6 +1208,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1134,7 +1230,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1144,10 +1239,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -1155,7 +1253,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1165,13 +1262,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name of the public folder. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1181,13 +1280,15 @@ Accept wildcard characters: False ``` ### -OnPremisesObjectId + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OnPremisesObjectId parameter specifies the ObjectID (GUID) value of the mail-enabled public folder from the on-premises environment. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1197,13 +1298,15 @@ Accept wildcard characters: False ``` ### -PhoneticDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1213,6 +1316,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the public folder are no longer automatically updated by email address policies. @@ -1223,7 +1329,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1233,6 +1338,9 @@ Accept wildcard characters: False ``` ### -PublicFolderType + +> Applicable: Exchange Server 2010 + The PublicFolderType parameter specifies which of the following four types is assigned to the public folder: - GeneralPurpose @@ -1244,7 +1352,6 @@ The PublicFolderType parameter specifies which of the following four types is as Type: PublicFolderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1254,6 +1361,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1277,7 +1387,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1287,6 +1396,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1310,7 +1422,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1320,6 +1431,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1345,7 +1459,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1355,6 +1468,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1364,7 +1480,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1374,9 +1489,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -1386,7 +1504,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1396,6 +1513,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -1409,7 +1529,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1419,6 +1538,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -1431,7 +1553,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1441,6 +1562,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The UMDtmfMap parameter specifies if you want to create a user-defined DTMF map for the UM-enabled user. @@ -1449,7 +1573,6 @@ The UMDtmfMap parameter specifies if you want to create a user-defined DTMF map Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1459,13 +1582,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1475,6 +1600,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -1486,7 +1614,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailUser.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailUser.md index d63d4b1527..fcdc2c27d6 100644 --- a/exchange/exchange-ps/exchange/Set-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailUser.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailuser -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailUser -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailuser +schema: 2.0.0 +title: Set-MailUser --- # Set-MailUser ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailUser cmdlet to modify mail users. Mail users (also known as mail-enabled users) have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. @@ -868,8 +869,83 @@ 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -878,11 +954,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-MailUser -Identity "John Woods" -ExternalEmailAddress john@tailspintoys.com ``` -This example modifies the external email address for the mail user named John Woods. Note that the original external email address isn't kept as a proxy address. +This example modifies the external email address for the mail user named John Woods. The original external email address isn't kept as a proxy address. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail user that you want to modify. You can use any value that uniquely identifies the mail user. For example: - Name @@ -896,7 +975,6 @@ The Identity parameter specifies the mail user that you want to modify. You can Type: MailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -906,6 +984,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -929,7 +1010,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -939,6 +1019,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -962,7 +1045,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -972,6 +1054,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -997,7 +1082,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1007,6 +1091,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -1031,7 +1118,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1041,6 +1127,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -1060,7 +1149,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1070,13 +1158,15 @@ Accept wildcard characters: False ``` ### -ArchiveGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1086,6 +1176,9 @@ Accept wildcard characters: False ``` ### -ArchiveName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1094,7 +1187,6 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1104,6 +1196,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -1125,7 +1220,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1135,6 +1229,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -1144,7 +1241,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -1154,18 +1250,20 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: -- $true: A DTMF map is created for the recipient. This is the default value. +- $true: A DTMF map is created for the recipient. This value is the default. - $false: A DTMF map isn't created for the recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1175,13 +1273,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1191,13 +1291,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1207,13 +1309,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1223,13 +1327,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1239,13 +1345,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1255,13 +1363,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1271,13 +1381,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1287,13 +1399,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1303,13 +1417,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1319,13 +1435,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1335,13 +1453,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1351,13 +1471,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1367,13 +1489,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1383,13 +1507,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1399,13 +1525,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1415,6 +1543,9 @@ Accept wildcard characters: False ``` ### -DataEncryptionPolicy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DataEncryptionPolicy parameter specifies the data encryption policy that's applied to the mail user. You can use any value that uniquely identifies the policy. For example: @@ -1427,9 +1558,8 @@ 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 Required: False Position: Named @@ -1439,13 +1569,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1455,6 +1587,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -1463,7 +1598,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1473,6 +1607,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -1500,7 +1637,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1510,18 +1646,20 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: -- $true: Email address policies are applied to this recipient. This is the default value. +- $true: Email address policies are applied to this recipient. This value is the default. - $false: Email address policies aren't applied to this recipient. ```yaml Type: Boolean Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1531,6 +1669,9 @@ Accept wildcard characters: False ``` ### -EnableLitigationHoldForMigration + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The EnableLitigationHoldForMigration switch is used in cross-tenant mailbox migrations to increase the quota on the Recoverable Items folder to 100 GB (and also enable Litigation Hold) prior to migration. You don't need to specify a value with this switch. @@ -1541,7 +1682,6 @@ This feature is not available in hybrid tenants. Type: SwitchParameter Parameter Sets: EnableLitigationHoldForMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -1551,13 +1691,15 @@ Accept wildcard characters: False ``` ### -ExchangeGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1567,15 +1709,23 @@ Accept wildcard characters: False ``` ### -ExcludeFromAllOrgHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. -{{ Fill ExcludeFromAllOrgHolds Description }} +The ExcludeFromAllOrgHolds switch specifies whether to exclude the soft-deleted mail user from all organization-wide Microsoft 365 retention policies. You don't need to specify a value with this switch. + +When you use this switch, use one of the following values to uniquely identify the soft-deleted mail user in the Identity parameter: + +- DistinguishedName +- Guid +- ExchangeGuid ```yaml Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1585,6 +1735,9 @@ Accept wildcard characters: False ``` ### -ExcludeFromOrgHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill ExcludeFromOrgHolds Description }} @@ -1593,7 +1746,6 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: ExcludeFromOrgHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1603,19 +1755,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1625,19 +1779,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1647,19 +1803,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1669,19 +1827,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1691,19 +1851,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1713,6 +1875,9 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. @@ -1723,7 +1888,6 @@ When you use the ExternalEmailAddress parameter to change the external email add Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1733,6 +1897,9 @@ Accept wildcard characters: False ``` ### -FederatedIdentity + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The FederatedIdentity parameter associates an on-premises Active Directory user with a user in the cloud. @@ -1741,7 +1908,6 @@ The FederatedIdentity parameter associates an on-premises Active Directory user Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1751,13 +1917,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1767,6 +1935,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mail user. Although messages sent on behalf of the mail user clearly show the sender in the From field (` on behalf of `, replies to these messages are delivered to the mail user, not the sender. The sender you specify for this parameter must 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 sender. For example: @@ -1792,7 +1963,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1802,16 +1972,18 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. -- $false: The recipient is visible in address lists. This is the default value. +- $false: The recipient is visible in address lists. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1821,15 +1993,17 @@ Accept wildcard characters: False ``` ### -HVEAccount + +> Applicable: Exchange Online, Exchange Online Protection + 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 +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 @@ -1839,6 +2013,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -1852,7 +2029,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1862,6 +2038,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -1870,7 +2049,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1880,15 +2058,17 @@ Accept wildcard characters: False ``` ### -JournalArchiveAddress + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. 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 Required: False Position: Named @@ -1898,15 +2078,17 @@ Accept wildcard characters: False ``` ### -LOBAppAccount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. -{{ Fill LOBAppAccount Description }} +This parameter is reserved for internal Microsoft use. ```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 Required: False Position: Named @@ -1916,9 +2098,12 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: -- BinHex (This is the default value) +- BinHex (default value) - UuEncode - AppleSingle - AppleDouble @@ -1932,7 +2117,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1942,15 +2126,17 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. 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 Required: False Position: Named @@ -1960,6 +2146,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -1971,7 +2160,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1981,6 +2169,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -1995,7 +2186,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2005,6 +2195,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail user. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -2014,7 +2207,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -2024,7 +2217,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2034,6 +2226,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail user. When you enter a value, qualify the value with one of the following units: @@ -2043,7 +2238,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -2053,7 +2248,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2063,11 +2257,14 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text - Html -- TextAndHtml (This is the default value) +- TextAndHtml (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -2078,7 +2275,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2088,10 +2284,13 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are: - Text -- Mime (This is the default value) +- Mime (default value) The MessageFormat and MessageBodyFormat parameters are interdependent: @@ -2104,7 +2303,6 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2114,15 +2312,17 @@ Accept wildcard characters: False ``` ### -MicrosoftOnlineServicesID + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments. ```yaml Type: 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 Required: False Position: Named @@ -2132,6 +2332,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -2151,7 +2354,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2161,10 +2363,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -2172,7 +2377,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2182,13 +2386,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the mail user. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2198,6 +2404,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Password parameter allows users to change their own password. You can use the following methods as a value for this parameter: @@ -2212,7 +2421,6 @@ You can't use this parameter to change another user's password (the parameter is Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2222,6 +2430,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. @@ -2236,7 +2447,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2246,6 +2456,9 @@ Accept wildcard characters: False ``` ### -RecalculateInactiveMailUser + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RecalculateInactiveMailUser Description }} @@ -2254,7 +2467,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailUser Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2264,6 +2476,9 @@ Accept wildcard characters: False ``` ### -RecipientLimits + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The RecipientLimits parameter specifies the maximum number of recipients allowed in messages sent by the mail user. @@ -2276,7 +2491,6 @@ The value unlimited indicates the maximum number of recipients per message for t Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2286,6 +2500,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder for a mail user that has a corresponding remote mailbox or remote archive mailbox in the cloud-based service. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages. @@ -2298,7 +2515,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 30 gigabytes (32212254720 bytes). @@ -2308,7 +2525,6 @@ The RecoverableItemsQuota value must be greater than or equal to the Recoverable Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2318,6 +2534,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for a mail user that has a corresponding remote mailbox or remote archive mailbox in the cloud-based service. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log. @@ -2330,7 +2549,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 20 gigabytes (21474836480 bytes). @@ -2340,7 +2559,6 @@ The RecoverableItemsQuota value must be greater than or equal to the Recoverable Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2350,6 +2568,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -2373,7 +2594,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2383,6 +2603,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -2406,7 +2629,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2416,6 +2638,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -2441,7 +2666,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2451,6 +2675,9 @@ Accept wildcard characters: False ``` ### -RemoveComplianceTagHoldApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveComplianceTagHoldApplied Description }} @@ -2459,7 +2686,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveComplianceTagHoldApplied Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2469,6 +2695,9 @@ Accept wildcard characters: False ``` ### -RemoveDelayHoldApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveDelayHoldApplied Description }} @@ -2477,7 +2706,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveDelayHoldApplied Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2487,6 +2715,9 @@ Accept wildcard characters: False ``` ### -RemoveDelayReleaseHoldApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveDelayReleaseHoldApplied Description }} @@ -2495,7 +2726,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveDelayReleaseHoldApplied Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2505,15 +2735,17 @@ Accept wildcard characters: False ``` ### -RemoveDisabledArchive + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. -{{ Fill RemoveDisabledArchive Description }} +The RemoveDisabledArchive switch specifies whether to remove the disabled archive that's associated with the mail user. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: RemoveDisabledArchive Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2523,6 +2755,9 @@ Accept wildcard characters: False ``` ### -RemoveLitigationHoldEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. 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. @@ -2533,7 +2768,6 @@ This switch is useful in scenarios where admins can't permanently delete mail us Type: SwitchParameter Parameter Sets: RemoveLitigationHoldEnabled Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2543,15 +2777,17 @@ Accept wildcard characters: False ``` ### -RemoveMailboxProvisioningConstraint + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveMailboxProvisioningConstraint Description }} ```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 Required: False Position: Named @@ -2561,6 +2797,9 @@ Accept wildcard characters: False ``` ### -RemoveOrphanedHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveOrphanedHolds Description }} @@ -2569,7 +2808,6 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2579,6 +2817,9 @@ Accept wildcard characters: False ``` ### -RemovePicture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemovePicture switch removes the picture from the mail user. You don't need to specify a value with this switch. @@ -2589,7 +2830,6 @@ You can add a picture to a mail user by using the Import-RecipientDataProperty c Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2599,6 +2839,9 @@ Accept wildcard characters: False ``` ### -RemoveSpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoveSpokenName switch removes the spoken name from the mail user. You don't need to specify a value with this switch. @@ -2609,7 +2852,6 @@ You can add a sound file to a mail user by using the Import-RecipientDataPropert Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2619,6 +2861,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -2628,7 +2873,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2638,12 +2882,15 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResetPasswordOnNextLogon parameter allows users to require themselves to change their password the next time they log on. Valid values are: - $true: The user is required to change their password then next time they successfully log on. -- $false: The user isn't required to change their password then next time they successfully log on. This is the default value. +- $false: The user isn't required to change their password then next time they successfully log on. This value is the default. You can't use this parameter to require another user to change their password (the parameter is available only via the MyBaseOptions user role). You need to use the ForceChangePasswordNextSignIn value in the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. @@ -2651,7 +2898,6 @@ You can't use this parameter to require another user to change their password (t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2661,15 +2907,17 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2679,6 +2927,9 @@ Accept wildcard characters: False ``` ### -SecondaryAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE Online Protection + This parameter is available only in on-premises Exchange. The SecondaryAddress parameter specifies the secondary address used by the Unified Messaging (UM)-enabled user. @@ -2687,7 +2938,6 @@ The SecondaryAddress parameter specifies the secondary address used by the Unifi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Online Protection Required: False Position: Named @@ -2697,6 +2947,9 @@ Accept wildcard characters: False ``` ### -SecondaryDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. @@ -2705,7 +2958,6 @@ The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2715,9 +2967,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -2727,7 +2982,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2737,6 +2991,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -2749,7 +3006,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2759,6 +3015,9 @@ Accept wildcard characters: False ``` ### -SkipDualWrite + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in Exchange 2016 or later. This parameter is reserved for internal Microsoft use. @@ -2767,7 +3026,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2777,6 +3035,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -2797,7 +3058,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2806,7 +3066,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UnblockForwardSyncPostCrossTenantMigration + +> Applicable: Exchange Online, Exchange Online Protection + +This parameter is available only in the cloud-based service. + +{{ Fill UnblockForwardSyncPostCrossTenantMigration Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: UnblockForwardSyncPostCrossTenantMigration +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UseMapiRichTextFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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: - Always: TNEF is used for all messages sent to the mail user or mail contact. @@ -2819,7 +3102,6 @@ The default value is UseDefaultSettings. Type: UseMapiRichTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2829,16 +3111,18 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are: - $true: Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact. -- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This is the default value. +- $false: Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2848,13 +3132,15 @@ Accept wildcard characters: False ``` ### -UserCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2864,6 +3150,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. @@ -2872,7 +3161,6 @@ The UserPrincipalName parameter specifies the logon name for the user account. T Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2882,13 +3170,15 @@ Accept wildcard characters: False ``` ### -UserSMimeCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2898,13 +3188,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2914,6 +3206,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -2925,7 +3220,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-Mailbox.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Mailbox.md index f24e40f01c..0ecd97ae8d 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Mailbox.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-Mailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailbox +schema: 2.0.0 +title: Set-Mailbox --- # Set-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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-Mailbox cmdlet to modify the settings of existing mailboxes. @@ -1123,7 +1124,7 @@ Set-Mailbox [-Identity] ## DESCRIPTION You can use this cmdlet for one mailbox at a time. To perform bulk management, you can pipeline the output of various Get- cmdlets (for example, the Get-Mailbox or Get-User cmdlets) and configure several mailboxes in a single-line command. You can also use the Set-Mailbox cmdlet in scripts. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -1190,6 +1191,9 @@ In Exchange Online, this example removes the delay hold that's applied to Asraf' ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -1207,16 +1211,18 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 Default value: None -Accept pipeline input: True +Accept pipeline input: True (byPropertyName) Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1240,7 +1246,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1250,6 +1255,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1273,7 +1281,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1283,6 +1290,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -1308,7 +1318,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1318,6 +1327,9 @@ Accept wildcard characters: False ``` ### -AccountDisabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The AccountDisabled parameter specifies whether to disable the account that's associated with the mailbox. Valid values are: @@ -1329,7 +1341,6 @@ The AccountDisabled parameter specifies whether to disable the account that's as Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1339,6 +1350,9 @@ Accept wildcard characters: False ``` ### -AddressBookPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AddressBookPolicy parameter specifies the address book policy that's applied to the mailbox. You can use any value that uniquely identifies the address book policy. For example: - Name @@ -1351,7 +1365,6 @@ For more information about address book policies, see [Address book policies in Type: AddressBookMailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1361,6 +1374,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -1385,7 +1401,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1395,18 +1410,20 @@ Accept wildcard characters: False ``` ### -AntispamBypassEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AntispamBypassEnabled parameter specifies whether to skip anti-spam processing on the mailbox. Valid values are: - $true: Anti-spam processing is skipped on the mailbox. -- $false: Anti-spam processing occurs on the mailbox. This is the default value +- $false: Anti-spam processing occurs on the mailbox. This value is the default ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1416,6 +1433,9 @@ Accept wildcard characters: False ``` ### -ApplyMandatoryProperties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApplyMandatoryProperties switch specifies whether to update the msExchVersion attribute of the mailbox. You don't need to specify a value with this switch. You might need to use this switch to fix inaccessible mailboxes or mailboxes that were created in previous versions of Exchange. @@ -1424,7 +1444,6 @@ You might need to use this switch to fix inaccessible mailboxes or mailboxes tha Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1434,6 +1453,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Arbitration switch is required to modify arbitration mailboxes. You don't need to specify a value with this switch. @@ -1446,7 +1468,6 @@ To modify arbitration mailboxes that are used to store audit log settings or dat Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1456,6 +1477,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -1475,7 +1499,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1485,6 +1508,9 @@ Accept wildcard characters: False ``` ### -ArchiveDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArchiveDatabase parameter specifies the Exchange database that contains the archive that's associated with this mailbox. You can use any value that uniquely identifies the database. For example: @@ -1497,7 +1523,6 @@ The ArchiveDatabase parameter specifies the Exchange database that contains the Type: DatabaseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1507,6 +1532,9 @@ Accept wildcard characters: False ``` ### -ArchiveDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArchiveDomain parameter specifies the domain in the cloud-based service where the archive that's associated with this mailbox exists. For example, if the SMTP email address of the user is tony@contoso.com, the SMTP domain could be archive.contoso.com. @@ -1517,7 +1545,6 @@ Only use this parameter if the archive is hosted in the cloud-based service. Type: SmtpDomain Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1527,6 +1554,9 @@ Accept wildcard characters: False ``` ### -ArchiveName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). In on-premises Exchange, the following default values are used based on the version of Exchange: @@ -1543,7 +1573,6 @@ In Outlook in Exchange Online, the value of this parameter is ignored. The name Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1553,6 +1582,9 @@ Accept wildcard characters: False ``` ### -ArchiveQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArchiveQuota parameter specifies the maximum size for the user's archive mailbox. If the archive mailbox reaches or exceeds this size, it no longer accepts messages. @@ -1565,7 +1597,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The ArchiveQuota value must be greater than or equal to the ArchiveWarningQuota value. @@ -1573,7 +1605,6 @@ The ArchiveQuota value must be greater than or equal to the ArchiveWarningQuota Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1583,6 +1614,9 @@ Accept wildcard characters: False ``` ### -ArchiveStatus + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This cmdlet is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1591,7 +1625,6 @@ This parameter is reserved for internal Microsoft use. Type: ArchiveStatusFlags Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1601,6 +1634,9 @@ Accept wildcard characters: False ``` ### -ArchiveWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArchiveWarningQuota parameter specifies the warning threshold for the size of the user's archive mailbox. If the archive mailbox reaches or exceeds this size, the user receives a descriptive warning message. @@ -1613,7 +1649,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The ArchiveWarningQuota value must be less than or equal to the ArchiveQuota value. @@ -1621,7 +1657,6 @@ The ArchiveWarningQuota value must be less than or equal to the ArchiveQuota val Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1631,6 +1666,9 @@ Accept wildcard characters: False ``` ### -AttributesToClear + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1639,7 +1677,6 @@ This parameter is reserved for internal Microsoft use. Type: SetMailbox+ClearableADAttributes[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1649,6 +1686,9 @@ Accept wildcard characters: False ``` ### -AuditAdmin + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AuditAdmin parameter specifies the mailbox operations to log for administrators as part of mailbox audit logging. Valid values are: - None @@ -1658,7 +1698,7 @@ The AuditAdmin parameter specifies the mailbox operations to log for administrat - Create (Enabled by default.) - FolderBind (Enabled by default in on-premises Exchange 2010 or later.) - HardDelete (Enabled by default.) -- MessageBind (This has been deprecated in the cloud-based service.) +- MessageBind (This is deprecated in the cloud-based service.) - ModifyFolderPermissions (Available only in Exchange 2019 and the cloud-based service.) - Move (Enabled by default in on-premises Exchange 2010 or later.) - MoveToDeletedItems (Enabled by default.) @@ -1682,7 +1722,6 @@ The AuditEnabled parameter must be set to $true to enable mailbox audit logging. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1692,6 +1731,9 @@ Accept wildcard characters: False ``` ### -AuditDelegate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AuditDelegate parameter specifies the mailbox operations to log for delegate users as part of mailbox audit logging. Valid values are: - None @@ -1722,7 +1764,6 @@ The AuditEnabled parameter must be set to $true to enable mailbox audit logging. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1732,10 +1773,13 @@ Accept wildcard characters: False ``` ### -AuditEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AuditEnabled parameter specifies whether to enable or disable mailbox audit logging for the mailbox. If auditing is enabled, actions specified in the AuditAdmin, AuditDelegate, and AuditOwner parameters are logged. Valid values are: - $true: Mailbox audit logging is enabled. -- $false: Mailbox audit logging is disabled. This is the default value. +- $false: Mailbox audit logging is disabled. This value is the default. **Note**: In Exchange Online, mailbox auditing on by default was enabled for all organizations in January, 2019. For more information, see [Manage mailbox auditing](https://learn.microsoft.com/purview/audit-mailboxes). @@ -1743,7 +1787,6 @@ The AuditEnabled parameter specifies whether to enable or disable mailbox audit Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1753,6 +1796,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuditLog switch is required to modify audit log mailboxes. You don't need to specify a value with this switch. @@ -1765,7 +1811,6 @@ To modify other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1775,6 +1820,9 @@ Accept wildcard characters: False ``` ### -AuditLogAgeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AuditLogAgeLimit parameter specifies the maximum age of audit log entries for the mailbox. Log entries older than the specified value are removed. The default value is 90 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1785,7 +1833,6 @@ For example, to specify 60 days for this parameter, use 60.00:00:00. Setting thi Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1795,9 +1842,12 @@ Accept wildcard characters: False ``` ### -AuditOwner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AuditOwner parameter specifies the mailbox operations to log for mailbox owners as part of mailbox audit logging. Valid values include: -- None (This is the default value in Exchange 2010, Exchange 2013, and Exchange 2016.) +- None (This value is the default in Exchange 2010, Exchange 2013, and Exchange 2016.) - AddFolderPermissions (Available only in Exchange 2019 and the cloud-based service.) - ApplyRecord (Available only in the cloud-based service.) - Create @@ -1826,7 +1876,6 @@ The AuditEnabled parameter must be set to $true to enable mailbox audit logging. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1836,6 +1885,9 @@ Accept wildcard characters: False ``` ### -AuxAuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuxAuditLog switch is required to modify auxiliary audit log mailboxes. You don't need to specify a value with this switch. @@ -1848,7 +1900,6 @@ To modify other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1858,6 +1909,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -1879,7 +1933,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1889,6 +1942,9 @@ Accept wildcard characters: False ``` ### -CalendarLoggingQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CalendarLoggingQuota parameter specifies the maximum size of the log in the Recoverable Items folder of the mailbox that stores changes to calendar items. When the log exceeds this size, calendar logging is disabled until messaging records management (MRM) removes older calendar logs to free up more space. @@ -1903,7 +1959,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be less than or equal to the value of the RecoverableItemsQuota parameter. @@ -1913,7 +1969,6 @@ When the UseDatabaseQuotaDefaults parameter on the mailbox is set to the value $ Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1923,16 +1978,18 @@ Accept wildcard characters: False ``` ### -CalendarRepairDisabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CalendarRepairDisabled parameter specifies whether to prevent calendar items in the mailbox from being repaired by the Calendar Repair Assistant. Valid values are: - $true: The Calendar Repair Assistant doesn't repair calendar items in the mailbox. -- $false: The Calendar Repair Assistant repairs calendars items in the mailbox. This is the default value. +- $false: The Calendar Repair Assistant repairs calendars items in the mailbox. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1942,16 +1999,18 @@ Accept wildcard characters: False ``` ### -CalendarVersionStoreDisabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CalendarVersionStoreDisabled parameter specifies whether to prevent calendar changes in the mailbox from being logged. Valid values are: - $true: Changes to a calendar item aren't recorded. -- $false: Changes to a calendar item are recorded. This keeps older versions of meetings and appointments. This is the default value. +- $false: Changes to a calendar item are recorded. This keeps older versions of meetings and appointments. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1961,6 +2020,9 @@ Accept wildcard characters: False ``` ### -ClearThrottlingPolicyAssignment + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ClearThrottlingPolicyAssignment switch specifies whether to clear any throttling policy assignments for the mailbox. You don't need to specify a value with this switch. @@ -1971,7 +2033,6 @@ Admins can contact Microsoft Support to assign a throttling policy to a mailbox, Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1981,9 +2042,12 @@ Accept wildcard characters: False ``` ### -ClientExtensions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The ClientExtensions parameter specifies whether the organization-wide client extensions (also called Apps for Outlook) will be installed in the arbitration mailbox (also called the organization mailbox). Only one arbitration mailbox in the organization can be configured to store client extensions. You can use this parameter only on an arbitration mailbox. +The ClientExtensions parameter specifies whether the organization-wide client extensions (also called Apps for Outlook) are installed in the arbitration mailbox (also called the organization mailbox). Only one arbitration mailbox in the organization can be configured to store client extensions. You can use this parameter only on an arbitration mailbox. Valid values are $true or $false. @@ -1991,7 +2055,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2001,6 +2064,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -2010,7 +2076,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -2020,18 +2085,20 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: -- $true: A DTMF map is created for the recipient. This is the default value. +- $true: A DTMF map is created for the recipient. This value is the default. - $false: A DTMF map isn't created for the recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2041,13 +2108,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2057,13 +2126,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2073,13 +2144,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2089,13 +2162,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2105,13 +2180,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2121,13 +2198,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2137,13 +2216,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2153,13 +2234,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2169,13 +2252,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2185,13 +2270,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2201,13 +2288,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2217,13 +2306,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2233,13 +2324,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2249,13 +2342,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2265,13 +2360,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2281,6 +2378,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Database parameter specifies the mailbox database that contains the mailbox. You can use any value that uniquely identifies the database. For example: @@ -2295,7 +2395,6 @@ Use the Get-MailboxDatabase cmdlet to see the available mailbox databases. Type: DatabaseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2305,6 +2404,9 @@ Accept wildcard characters: False ``` ### -DataEncryptionPolicy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DataEncryptionPolicy parameter specifies the data encryption policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example: @@ -2319,7 +2421,6 @@ You can use the Get-DataEncryptionPolicy cmdlet to view the available policies. Type: DataEncryptionPolicyIdParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2329,6 +2430,9 @@ Accept wildcard characters: False ``` ### -DefaultAuditSet + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DefaultAuditSet parameter specifies whether to revert the mailbox operations that are logged in the mailbox audit log back to the set of default operations for the specified logon type. Valid values are: @@ -2337,13 +2441,12 @@ The DefaultAuditSet parameter specifies whether to revert the mailbox operations - Delegate: Reverts the mailbox operations to log for delegate users back to the default list of operations. - Owner: Reverts the mailbox operations to log for mailbox owners back to the default list of operations. -With on-by-default mailbox auditing in the cloud-based service, a set of mailbox operations are logged by default for each logon type. This list of operations is managed by Microsoft, who will automatically add new operations to be audited when they are released. If you change the list of mailbox operations for any logon type (by using the AuditAdmin, AuditDelegate, or AuditOwner parameters), any new mailbox operation released by Microsoft will not be audited; you'll need to explicitly add new mailbox operations to the list of operations for a logon type. Use this parameter to revert the mailbox back to the Microsoft-managed list of mailbox operations that are audited for a logon type. For more information about on-by-default mailbox auditing, see [Manage mailbox auditing](https://learn.microsoft.com/purview/audit-mailboxes). +With on-by-default mailbox auditing in the cloud-based service, a set of mailbox operations are logged by default for each logon type. This list of operations is managed by Microsoft, and new mailbox operations are automatically added to auditing as they're released. If you change the list of mailbox operations for any logon type (by using the AuditAdmin, AuditDelegate, or AuditOwner parameters), any new mailbox operation released by Microsoft aren't audited. You need to explicitly add new mailbox operations to the list of operations for a logon type. Use this parameter to revert the mailbox back to the Microsoft-managed list of mailbox operations that are audited for a logon type. For more information about on-by-default mailbox auditing, see [Manage mailbox auditing](https://learn.microsoft.com/purview/audit-mailboxes). ```yaml Type: MultiValuedProperty Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2353,6 +2456,9 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultPublicFolderMailbox parameter assigns a specific public folder mailbox to the user. You can use any value that uniquely identifies the public folder mailbox. For example: - Name @@ -2368,7 +2474,6 @@ By default, the public folder mailbox used by a user is automatically selected b Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2378,6 +2483,9 @@ Accept wildcard characters: False ``` ### -DeliverToMailboxAndForward + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeliverToMailboxAndForward parameter specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress or ForwardingSmtpAddress parameters. Valid values are: - $true: Messages are delivered to this mailbox and forwarded to the specified recipient or email address. @@ -2389,7 +2497,6 @@ The default value is $false. The value of this parameter is meaningful only if y Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2399,18 +2506,20 @@ Accept wildcard characters: False ``` ### -DisableThrottling + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DisableThrottling parameter enables or disables sender rate throttling for the mailbox. Valid values are: -- $true: Messages sent by this mailbox will not be throttled by Sender Rate Control. We only recommend this value for moderation mailboxes. -- $false: Messages will be throttled after the threshold is exceeded. This is the default value. +- $true: Messages sent by this mailbox aren't throttled by Sender Rate Control. We only recommend this value for moderation mailboxes. +- $false: Messages are throttled after the threshold is exceeded. This value is the default. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2420,13 +2529,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2436,6 +2547,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -2444,7 +2558,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2454,18 +2567,20 @@ Accept wildcard characters: False ``` ### -DowngradeHighPriorityMessagesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DowngradeHighPriorityMessagesEnabled parameter specifies whether to prevent the mailbox from sending high priority messages to an X.400 mail system. Valid values are: - $true: High priority messages sent to X.400 recipients are changed to normal priority. -- $false: High priority messages set to X.400 recipients remain high priority. This is the default value. +- $false: High priority messages set to X.400 recipients remain high priority. This value is the default. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2475,6 +2590,9 @@ Accept wildcard characters: False ``` ### -DumpsterMessagesPerFolderCountReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DumpsterMessagesPerFolderCountReceiveQuota parameter specifies the maximum number of messages that can be contained in each folder in the Recoverable Items folder (called the dumpster in previous versions of Exchange). When a folder exceeds this limit, it can't store new messages. For example, if the Deletions folder in the Recoverable Items folder has exceeded the message count limit and the mailbox owner attempts to permanently delete items from their mailbox, the deletion will fail. @@ -2485,7 +2603,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2495,6 +2612,9 @@ Accept wildcard characters: False ``` ### -DumpsterMessagesPerFolderCountWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DumpsterMessagesPerFolderCountWarningQuota parameters specifies the number of messages that each folder in the Recoverable Items folder (called the dumpster in previous versions of Exchange) 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. @@ -2505,7 +2625,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2515,18 +2634,20 @@ Accept wildcard characters: False ``` ### -ElcProcessingDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ElcProcessingDisabled parameter specifies whether to prevent the Managed Folder Assistant from processing the mailbox. Valid values are: -- $true: The Managed Folder Assistant isn't allowed to process the mailbox. Note that this setting will be ignored if a retention policy that has Preservation Lock enabled is applied to the mailbox. -- $false: The Managed Folder Assistant is allowed to process the mailbox. This is the default value. +- $true: The Managed Folder Assistant isn't allowed to process the mailbox. This setting is ignored if a retention policy that has Preservation Lock enabled is applied to the mailbox. +- $false: The Managed Folder Assistant is allowed to process the mailbox. This value is the default. ```yaml Type: Boolean Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2536,6 +2657,9 @@ Accept wildcard characters: False ``` ### -EmailAddressDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill EmailAddressDisplayNames Description }} @@ -2544,7 +2668,6 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2554,6 +2677,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -2581,7 +2707,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2591,18 +2716,20 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: -- $true: Email address policies are applied to this recipient. This is the default value. +- $true: Email address policies are applied to this recipient. This value is the default. - $false: Email address policies aren't applied to this recipient. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2612,6 +2739,9 @@ Accept wildcard characters: False ``` ### -EnableRoomMailboxAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: @@ -2627,7 +2757,6 @@ A room mailbox in Exchange Online is created with associated an account that has Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2637,9 +2766,12 @@ Accept wildcard characters: False ``` ### -EndDateForRetentionHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EndDateForRetentionHold parameter specifies the end date for retention hold for messaging records management (MRM). To use this parameter, you need to set the RetentionHoldEnabled parameter to the value $true. -**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. +**Important**: Using this parameter does not change the _RetentionHoldEnabled_ value to $false after the specified date. The _RetentionHoldEnabled_ is still $true on the mailbox after the specified date, but MRM starts 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". @@ -2647,7 +2779,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2657,6 +2788,9 @@ Accept wildcard characters: False ``` ### -EnforcedTimestamps + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill EnforcedTimestamps Description }} @@ -2665,7 +2799,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2675,6 +2808,9 @@ Accept wildcard characters: False ``` ### -ExcludeFromAllOrgHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in Exchange Online. The ExcludeFromAllOrgHolds switch excludes the mailbox from all organization-wide Microsoft 365 retention policies. This switch can only be used for inactive mailboxes. You don't need to specify a value with this switch. @@ -2685,7 +2821,6 @@ When you use this switch, use the DistinguishedName or ExchangeGuid property val Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2695,9 +2830,12 @@ Accept wildcard characters: False ``` ### -ExcludeFromOrgHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in Exchange Online. -The ExcludeFromOrgHolds parameter excludes the mailbox from one or more organization-wide Microsoft 365 retention policies. This parameter can only be used for inactive mailboxes. A valid value for this parameter is the GUID of the organization-wide Microsoft 365 retention policy that the inactive mailbox is excluded from. To find the GUID values of organization-wide Microsoft 365 retention policies, run the command Get-OrganizationConfig | Format-List InplaceHolds. Note that retention policies assigned to mailboxes are prefaced by 'mbx'. +The ExcludeFromOrgHolds parameter excludes the mailbox from one or more organization-wide Microsoft 365 retention policies. This parameter can only be used for inactive mailboxes. A valid value for this parameter is the GUID of the organization-wide Microsoft 365 retention policy that the inactive mailbox is excluded from. To find the GUID values of organization-wide Microsoft 365 retention policies, run the command Get-OrganizationConfig | Format-List InplaceHolds. Retention policies assigned to mailboxes are prefaced by 'mbx'. You can specify multiple values by using the syntax: "GUID1","GUID2",..."GUIDX". @@ -2707,7 +2845,6 @@ When you use this parameter, use the DistinguishedName or ExchangeGuid property Type: String[] Parameter Sets: ExcludeFromOrgHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2717,6 +2854,9 @@ Accept wildcard characters: False ``` ### -ExtendedPropertiesCountQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ExtendedPropertiesCountQuota property is used to configure the Named Properties and NonMAPI Named Properties quotas for a mailbox. This should typically only be done if you are experiencing QuotaExceededException or MapiExceptionNamedPropsQuotaExceeded errors. @@ -2725,7 +2865,6 @@ The ExtendedPropertiesCountQuota property is used to configure the Named Propert Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2735,19 +2874,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2757,19 +2898,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2779,19 +2922,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2801,19 +2946,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2823,19 +2970,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2845,16 +2994,18 @@ Accept wildcard characters: False ``` ### -ExternalOofOptions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalOofOptions parameter specifies the automatic replies or Out of Office (also known OOF) message options that are available for the mailbox. Valid values are: -- External: Automatic replies can be configured for external senders. This is the default value. +- External: Automatic replies can be configured for external senders. This value is the default. - InternalOnly: Automatic replies can be configured only for internal senders. ```yaml Type: ExternalOofOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2864,9 +3015,12 @@ Accept wildcard characters: False ``` ### -FolderHierarchyChildrenCountReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The FolderHierarchyChildrenCountReceiveQuota parameter specifies the maximum number of subfolders that can be created in a mailbox folder. The mailbox owner won't be able to create a new subfolder when this limit is reached. +The FolderHierarchyChildrenCountReceiveQuota parameter specifies the maximum number of subfolders that can be created in a mailbox folder. The mailbox owner can't create a new subfolder when this limit is reached. To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FolderHierarchyChildrenCountReceiveQuota`. @@ -2874,7 +3028,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2884,6 +3037,9 @@ Accept wildcard characters: False ``` ### -FolderHierarchyChildrenCountWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The FolderHierarchyChildrenCountWarningQuota parameter specifies the number of subfolders that can be created in a mailbox folder 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. @@ -2894,7 +3050,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2904,9 +3059,12 @@ Accept wildcard characters: False ``` ### -FolderHierarchyDepthReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The FolderHierarchyDepthReceiveQuota parameter specifies the maximum number of levels in the folder hierarchy of a mailbox folder. The mailbox owner won't be able to create another level in the folder hierarchy of the mailbox folder when this limit is reached. +The FolderHierarchyDepthReceiveQuota parameter specifies the maximum number of levels in the folder hierarchy of a mailbox folder. The mailbox owner can't create another level in the folder hierarchy of the mailbox folder when this limit is reached. To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FolderHierarchyDepthReceiveQuota`. @@ -2914,7 +3072,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2924,6 +3081,9 @@ Accept wildcard characters: False ``` ### -FolderHierarchyDepthWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The FolderHierarchyDepthWarningQuota parameter specifies the number of levels in the folder hierarchy of a mailbox folder that can be created 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. @@ -2934,7 +3094,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2944,9 +3103,12 @@ Accept wildcard characters: False ``` ### -FoldersCountReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The FoldersCountReceiveQuota parameter is used to specify a maximum number of folders within a mailbox, typically a public folder mailbox. If this value is configured and the limit is reached, no new folders will be able to be created. +The FoldersCountReceiveQuota parameter is used to specify a maximum number of folders within a mailbox, typically a public folder mailbox. If this value is configured and the limit is reached, you can't create new folders in the mailbox. To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FoldersCountReceiveQuota`. @@ -2954,7 +3116,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2964,6 +3125,9 @@ Accept wildcard characters: False ``` ### -FoldersCountWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The FoldersCountWarningQuota parameter is used to display a warning message that the folder hierarchy is full when the value specified for this parameter is reached. This parameter is typically used for public folder mailboxes. @@ -2974,7 +3138,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2984,6 +3147,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -2992,7 +3158,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3002,6 +3167,9 @@ Accept wildcard characters: False ``` ### -ForwardingAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForwardingAddress parameter specifies a forwarding address in your organization for messages that are sent to this mailbox. You can use any value that uniquely identifies the internal recipient. For example: - Name @@ -3024,7 +3192,6 @@ If you configure values for both the ForwardingAddress and ForwardingSmtpAddress Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3034,6 +3201,9 @@ Accept wildcard characters: False ``` ### -ForwardingSmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForwardingSmtpAddress parameter specifies a forwarding SMTP address for messages that are sent to this mailbox. Typically, you use this parameter to specify external email addresses that aren't validated. How messages are delivered and forwarded is controlled by the DeliverToMailboxAndForward parameter. @@ -3049,7 +3219,6 @@ If you configure values for both the ForwardingAddress and ForwardingSmtpAddress Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3059,6 +3228,9 @@ Accept wildcard characters: False ``` ### -GMGen + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The GMGen parameter specifies whether the arbitration mailbox (also called an organization mailbox) is used for group metrics generation for the organization. In MailTips, group metrics information is used to indicate the number of recipients in a message or whether recipients are outside your organization. You can use this parameter only on an arbitration mailbox. @@ -3069,7 +3241,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3079,6 +3250,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mailbox. Although messages send on behalf of the mailbox clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the mailbox, not the sender. The sender you specify for this parameter must 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 sender. For example: @@ -3104,7 +3278,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3114,6 +3287,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. @@ -3122,7 +3298,6 @@ The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't ne Type: MailboxIdParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3132,16 +3307,18 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. -- $false: The recipient is visible in address lists. This is the default value. +- $false: The recipient is visible in address lists. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3151,6 +3328,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -3164,7 +3344,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3174,6 +3353,9 @@ Accept wildcard characters: False ``` ### -ImListMigrationCompleted + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ImListMigrationCompleted parameter specifies whether a user's Lync or Skype for Business contact list is stored in their mailbox. @@ -3181,17 +3363,16 @@ The ImListMigrationCompleted parameter specifies whether a user's Lync or Skype Valid values are: - $true: The user's Lync or Skype for Business contact list is stored in their Exchange 2016 mailbox. This prevents you from migrating the mailbox back to an Exchange 2010 server. -- $false: The user's Lync or Skype for Business contact list is stored on a Lync or Skype for Business server. This doesn't prevent you from migrating the mailbox back to an Exchange 2010 server. This is the default value. +- $false: The user's Lync or Skype for Business contact list is stored on a Lync or Skype for Business server. This doesn't prevent you from migrating the mailbox back to an Exchange 2010 server. This value is the default. Lync Server 2013 and Skype for Business Server 2015 support storing the user's contact list in their Exchange 2016 mailbox. This feature is known as the unified contact store (UCS), and it allows applications to show a consistent, up-to-date contact list. However, Exchange 2010 doesn't support the unified contact store. Therefore, before you migrate a user's Exchange 2016 mailbox back to Exchange 2010, you need to move the user's Lync or Skype for Business contact list from the unified contact store back to a Lync 2013 or Skype for Business server. For more information, see [Configuring Microsoft Lync Server 2013 to use the unified contact store](https://learn.microsoft.com/lyncserver/lync-server-2013-configuring-lync-server-to-use-the-unified-contact-store). -If you migrate an Exchange 2013 mailbox back to Exchange 2010 while the user's Lync or Skype for Business contact list is stored in the unified contact store, the user could permanently lose access to those contacts. After you verify the user's Lync or Skype for Business contact list has been moved back to a Lync 2013 or Skype for Business server, you should be able to complete the mailbox migration. If you need to migrate the mailbox despite the potential for data loss, you can manually set the ImListMigrationCompleted parameter to $false. +If you migrate an Exchange 2013 mailbox back to Exchange 2010 while the user's Lync or Skype for Business contact list is stored in the unified contact store, the user could permanently lose access to those contacts. After you verify the user's Lync or Skype for Business contact list is moved back to a Lync 2013 or Skype for Business server, you should be able to complete the mailbox migration. If you need to migrate the mailbox despite the potential for data loss, you can manually set the ImListMigrationCompleted parameter to $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3201,6 +3382,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -3209,7 +3393,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3219,6 +3402,9 @@ Accept wildcard characters: False ``` ### -InactiveMailbox + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The InactiveMailbox switch specifies that the mailbox is an inactive mailbox. You don't need to specify a value with this switch. @@ -3235,7 +3421,6 @@ You can't use this switch to modify other properties on inactive mailboxes. Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3245,7 +3430,10 @@ Accept wildcard characters: False ``` ### -IsExcludedFromServingHierarchy -The IsExcludedFromServingHierarchy parameter prevents users from accessing the public folder hierarchy on this public folder mailbox. For load-balancing purposes, users are equally distributed across public folder mailboxes by default. When this parameter is set on a public folder mailbox, that mailbox isn't included in this automatic load-balancing and won't be accessed by users to retrieve the public folder hierarchy. However, if an administrator has set the DefaultPublicFolderMailbox property on a user mailbox to a specific public folder mailbox, the user will still access the specified public folder mailbox even if the IsExcludedFromServingHierarchy parameter is set for that public folder mailbox. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The IsExcludedFromServingHierarchy parameter prevents users from accessing the public folder hierarchy on this public folder mailbox. For load-balancing purposes, users are equally distributed across public folder mailboxes by default. When this parameter is set on a public folder mailbox, that mailbox isn't included in this automatic load-balancing and can't be accessed by users to retrieve the public folder hierarchy. However, if an administrator has set the DefaultPublicFolderMailbox property on a user mailbox to a specific public folder mailbox, the user can still access the specified public folder mailbox even if the IsExcludedFromServingHierarchy parameter is set for that public folder mailbox. You should use this parameter only during public folder migrations. Don't use this parameter once the initial migration validation is complete. @@ -3253,7 +3441,6 @@ You should use this parameter only during public folder migrations. Don't use th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3263,6 +3450,9 @@ Accept wildcard characters: False ``` ### -IsHierarchyReady + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -3271,7 +3461,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3281,6 +3470,9 @@ Accept wildcard characters: False ``` ### -IsHierarchySyncEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -3289,7 +3481,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3299,6 +3490,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -3309,11 +3503,11 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The IssueWarningQuota value must be less than or equal to the ProhibitSendReceiveQuota value. -In Exchange Online, the quota value is determined by the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. You can lower the quota value, and you may be able to raise the quota, but you can't exceed the maximum value that's allowed by the subscription or license. In Exchange Online, you can't use this parameter on public folder mailboxes. +In Exchange Online, the quota value is determined by the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. You can lower the quota value, and you might be able to raise the quota, but you can't exceed the maximum value that's allowed by the subscription or license. In Exchange Online, you can't use this parameter on public folder mailboxes. In on-premises Exchange, the default value of this parameter is unlimited. When the UseDatabaseQuotaDefaults parameter on the mailbox is set to $true (the default value), the value of the this parameter is ignored, and the mailbox uses the IssueWarningQuota value from the mailbox database. To use this parameter to enforce a specific quota value for the mailbox, you need to set the UseDatabaseQuotaDefaults parameter to the value $false. @@ -3321,7 +3515,6 @@ In on-premises Exchange, the default value of this parameter is unlimited. When Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3331,6 +3524,9 @@ Accept wildcard characters: False ``` ### -JournalArchiveAddress + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -3339,7 +3535,6 @@ This parameter is reserved for internal Microsoft use. Type: SmtpAddress Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3349,6 +3544,9 @@ Accept wildcard characters: False ``` ### -Languages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -3361,7 +3559,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3371,6 +3568,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the credentials used to access the domain controller specified by the LinkedDomainController parameter. @@ -3381,7 +3581,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3391,6 +3590,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if the mailbox is a linked mailbox. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter. Use the fully qualified domain name (FQDN) of the domain controller that you want to use as the value for this parameter. @@ -3399,7 +3601,6 @@ The LinkedDomainController parameter specifies the domain controller in the fore Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3409,6 +3610,9 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: @@ -3422,7 +3626,6 @@ The LinkedMasterAccount parameter specifies the master account in the forest whe Type: UserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3432,6 +3635,9 @@ Accept wildcard characters: False ``` ### -LitigationHoldDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LitigationHoldDate parameter specifies the date that the mailbox is placed on litigation hold. The parameter is populated automatically when you place a mailbox on litigation hold. The date you specify can be used for informational or reporting purposes. When you use the LitigationHoldEnabled parameter to place the mailbox on litigation hold, you can specify any date using the LitigationHoldDate parameter. However, the mailbox is actually placed on litigation hold when you run the command to place the mailbox on litigation hold. @@ -3440,7 +3646,6 @@ When you use the LitigationHoldEnabled parameter to place the mailbox on litigat Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3450,6 +3655,9 @@ Accept wildcard characters: False ``` ### -LitigationHoldDuration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The LitigationHoldDuration parameter specifies how long mailbox items are held if the mailbox is placed on litigation hold. The duration is calculated from the date a mailbox item is received or created. A valid value is an integer that represents the number of days, or the value unlimited. The default value is unlimited, which means items are held indefinitely or until the hold is removed. @@ -3458,7 +3666,6 @@ A valid value is an integer that represents the number of days, or the value unl Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3468,10 +3675,13 @@ Accept wildcard characters: False ``` ### -LitigationHoldEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The LitigationHoldEnabled parameter specifies whether to place the mailbox on litigation hold. Valid values are: - $true: The mailbox is on litigation hold. -- $false: The mailbox isn't on litigation hold. This is the default value. +- $false: The mailbox isn't on litigation hold. This value is the default. After a mailbox is placed on litigation hold, messages can't be deleted from the mailbox. Deleted items and all versions of changed items are retained in the Recoverable Items folder. Items that are purged from the dumpster are also retained and the items are held indefinitely. If you enable litigation hold, single-item recovery quotas aren't applied. @@ -3481,7 +3691,6 @@ Placing public folder mailboxes on Litigation Hold isn't supported. To place pub Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3491,13 +3700,15 @@ Accept wildcard characters: False ``` ### -LitigationHoldOwner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The LitigationHoldOwner parameter specifies the user who placed the mailbox on litigation hold. If you don't use this parameter when you place the mailbox on litigation hold, the value is populated automatically. If you use this parameter when you place the mailbox on litigation hold, you can specify a text value. If the value contains spaces, include the value in quotation marks ("). You can use this value for informational and reporting purposes. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3507,6 +3718,9 @@ Accept wildcard characters: False ``` ### -MailboxMessagesPerFolderCountReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -3519,7 +3733,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3529,6 +3742,9 @@ Accept wildcard characters: False ``` ### -MailboxMessagesPerFolderCountWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -3541,7 +3757,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3551,6 +3766,9 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxRegion parameter specifies the geo location for the mailbox in multi-geo environments. @@ -3563,7 +3781,6 @@ To see the list of configured geo locations in Microsoft 365 Multi-Geo, run the Type: String Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3573,6 +3790,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -3584,7 +3804,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3594,6 +3813,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -3608,7 +3830,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3618,6 +3839,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicy + +> Applicable: Exchange Server 2010 + This parameter is functional only in Exchange Server 2010. The ManagedFolderMailboxPolicy parameter specifies a managed folder mailbox policy that controls MRM for the mailbox. If the parameter is set to $null, Exchange removes the managed folder mailbox policy from the mailbox but any managed folders in the mailbox remain. @@ -3626,7 +3850,6 @@ The ManagedFolderMailboxPolicy parameter specifies a managed folder mailbox poli Type: MailboxPolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -3636,6 +3859,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicyAllowed + +> Applicable: Exchange Server 2010 + This parameter is functional only in Exchange Server 2010. The ManagedFolderMailboxPolicyAllowed switch bypasses the warning that MRM features aren't supported for clients running versions of Outlook earlier than Outlook 2007. You don't need to specify a value with this switch. @@ -3648,7 +3874,6 @@ Although Outlook 2003 Service Pack 3 clients are supported, they have limited MR Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -3658,6 +3883,9 @@ Accept wildcard characters: False ``` ### -Management + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Management parameter specifies whether the arbitration mailbox (also call an organization mailbox) is used to manage mailbox moves and mailbox migrations. You can use this parameter only on an arbitration mailbox. @@ -3668,7 +3896,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3678,6 +3905,9 @@ Accept wildcard characters: False ``` ### -MaxBlockedSenders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxBlockedSenders parameter specifies the maximum number of senders that can be included in the blocked senders list. Blocked senders are senders that are considered junk senders by the mailbox and are used in junk email rules. This parameter is validated only when the junk email rules are updated using Outlook on the web or Exchange Web Services. @@ -3686,7 +3916,6 @@ The MaxBlockedSenders parameter specifies the maximum number of senders that can Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3696,6 +3925,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -3705,11 +3937,11 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. -In Exchange Online, the value is determined by the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. You can lower the value, and you may be able to raise the value, but you can't exceed the maximum value that's allowed by the subscription or license. +In Exchange Online, the value is determined by the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. You can lower the value, and you might be able to raise the value, but you can't exceed the maximum value that's allowed by the subscription or license. In Exchange Online, you use this parameter to configure the MaxReceiveSize value on existing mailboxes. Use the Set-MailboxPlan cmdlet to change the MaxReceiveSize value for all new mailboxes that you create in the future. @@ -3721,7 +3953,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3731,6 +3962,9 @@ Accept wildcard characters: False ``` ### -MaxSafeSenders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxSafeSenders parameter specifies the maximum number of senders that can be included in the safe senders list. Safe senders are senders that are trusted by the mailbox and are used in junk email rules. This parameter is validated only when the junk email rules are updated using cloud-based organizations or services. @@ -3739,7 +3973,6 @@ The MaxSafeSenders parameter specifies the maximum number of senders that can be Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3749,6 +3982,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mailbox. When you enter a value, qualify the value with one of the following units: @@ -3758,11 +3994,11 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. -In Exchange Online, the value is determined by the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. You can lower the value, and you may be able to raise the value, but you can't exceed the maximum value that's allowed by the subscription or license. +In Exchange Online, the value is determined by the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. You can lower the value, and you might be able to raise the value, but you can't exceed the maximum value that's allowed by the subscription or license. In Exchange Online, you use this parameter to configure the MaxSendSize value on existing mailboxes. Use the Set-MailboxPlan cmdlet to change the MaxSendSize value for all new mailboxes that you create in the future. @@ -3774,7 +4010,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3784,12 +4019,15 @@ Accept wildcard characters: False ``` ### -MessageCopyForSendOnBehalfEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: Previously, this parameter was available only for shared mailboxes. In Exchange Online or Exchange 2016 CU6 or later, this parameter is also available for user mailboxes. This parameter is not available for linked user mailboxes. The MessageCopyForSendOnBehalfEnabled parameter specifies whether to copy the sender for messages that are sent from a mailbox by users that have the "send on behalf of" permission. Valid values are: - $true: When a user sends a message from the mailbox by using the "send on behalf of" permission, a copy of the message is sent to the sender's mailbox. -- $false: When a user sends a message from the mailbox by using the "send on behalf of" permission, a copy of the message isn't sent to the sender's mailbox. This is the default value. +- $false: When a user sends a message from the mailbox by using the "send on behalf of" permission, a copy of the message isn't sent to the sender's mailbox. This value is the default. You give users permission to send on behalf of a mailbox by using the GrantSendOnBehalfTo parameter on the mailbox. @@ -3797,7 +4035,6 @@ You give users permission to send on behalf of a mailbox by using the GrantSendO Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3807,12 +4044,15 @@ Accept wildcard characters: False ``` ### -MessageCopyForSentAsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: Previously, this parameter was available only for shared mailboxes. In Exchange Online or Exchange 2016 CU6 or later, this parameter is also available for user mailboxes. This parameter is not available for linked user mailboxes. The MessageCopyForSentAsEnabled parameter specifies whether to copy the sender for messages that are sent from a mailbox by users that have the "send as" permission. Valid values are: - $true: When a user sends a message from the mailbox by using the "send as" permission, a copy of the message is sent to the sender's mailbox. -- $false: When a user sends a message from the mailbox by using the "send as" permission, a copy of the message isn't sent to the sender's mailbox. This is the default value. +- $false: When a user sends a message from the mailbox by using the "send as" permission, a copy of the message isn't sent to the sender's mailbox. This value is the default. In Exchange Online, you give a user permission to send as a mailbox by running this command: `Add-RecipientPermission -AccessRights SendAs -Trustee `. @@ -3822,7 +4062,6 @@ In on-premises Exchange, you give a user permission to send as a mailbox by runn Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3832,18 +4071,20 @@ Accept wildcard characters: False ``` ### -MessageCopyForSMTPClientSubmissionEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MessageCopyForSMTPClientSubmissionEnabled parameter specifies whether to copy the sender for messages that are sent using SMTP client submission (SMTP AUTH). Valid values are: -- $true: When the user's account sends messages using SMTP AUTH, a copy of the message is sent to the users's mailbox. This is the default value. +- $true: When the user's account sends messages using SMTP AUTH, a copy of the message is sent to the users's mailbox. This value is the default. - $false: When the user's account sends messages using SMTP AUTH, a copy of the message isn't sent to the users's mailbox. ```yaml Type: Boolean Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3853,6 +4094,9 @@ Accept wildcard characters: False ``` ### -MessageTracking + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MessageTracking parameter specifies whether the arbitration mailbox (also called an organization mailbox) is the anchor mailbox that's used for cross-organizational message tracking scenarios. By default, the message tracking organizational capability is assigned to the arbitration mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}. You can use this parameter only on an arbitration mailbox. @@ -3863,26 +4107,27 @@ Valid values are$true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: FalseNamed -Position: +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -MessageTrackingReadStatusEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MessageTrackingReadStatusEnabled parameter specifies whether to include detailed information in delivery reports for messages sent to the mailbox. Valid values are: -- $true: The read status of the message and the date-time that the message was delivered is shown in the delivery report for messages sent to this mailbox. This is the default value. +- $true: The read status of the message and the date-time that the message was delivered is shown in the delivery report for messages sent to this mailbox. This value is the default. - $false: The read status of the message isn't displayed in the delivery report for messages sent to this mailbox. Only the date-time that the message was delivered is shown in the delivery report. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3892,6 +4137,9 @@ Accept wildcard characters: False ``` ### -MicrosoftOnlineServicesID + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MicrosoftOnlineServicesID parameter specifies the Microsoft work or school account for the mailbox (for example, lila@contoso.onmicrosoft.com). @@ -3900,7 +4148,6 @@ The MicrosoftOnlineServicesID parameter specifies the Microsoft work or school a Type: SmtpAddress Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3910,6 +4157,9 @@ Accept wildcard characters: False ``` ### -Migration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Migration switch is required to modify migration mailboxes. You don't need to specify a value with this switch. @@ -3918,7 +4168,6 @@ The Migration switch is required to modify migration mailboxes. You don't need t Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3928,6 +4177,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -3947,7 +4199,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3957,10 +4208,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -3968,7 +4222,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3978,6 +4231,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). In the cloud-based service, many special characters aren't allowed in the Name value (for example, ö, ü, or ä). For more information, see [Error when you try to create a username that contains a special character in Microsoft 365](https://learn.microsoft.com/office/troubleshoot/office-suite-issues/username-contains-special-character). @@ -3986,7 +4242,6 @@ In the cloud-based service, many special characters aren't allowed in the Name v Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3996,6 +4251,9 @@ Accept wildcard characters: False ``` ### -NewPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The NewPassword parameter is used with the OldPassword parameter when a user changes their own password in Outlook on the web. By default, the NewPassword and OldPassword parameters are also available to members of the Help Desk and Organization Management role groups via the User Options role. However, administrators use the Password parameter to reset a user's password, because that parameter doesn't require the user's current password. @@ -4010,7 +4268,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4020,6 +4277,9 @@ Accept wildcard characters: False ``` ### -NonCompliantDevices + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill NonCompliantDevices Description }} @@ -4028,7 +4288,6 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4038,6 +4297,9 @@ Accept wildcard characters: False ``` ### -OABGen + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The OABGen parameter specifies whether the arbitration mailbox (also called an organization mailbox) is used for offline address book (OAB) file generation and storage for the organization. OAB requests are sent to the server where this arbitration mailbox is located. You can use this parameter only on an arbitration mailbox. @@ -4048,7 +4310,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4058,13 +4319,15 @@ Accept wildcard characters: False ``` ### -Office + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Office parameter specifies the user's physical office name or number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4074,6 +4337,9 @@ Accept wildcard characters: False ``` ### -OfflineAddressBook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The OfflineAddressBook parameter specifies the offline address book (OAB) that's associated with the mailbox. You can use any value that uniquely identifies the OAB. For example: @@ -4088,7 +4354,6 @@ Use the Get-OfflineAddressBook cmdlet to see the available offline address books Type: OfflineAddressBookIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4098,6 +4363,9 @@ Accept wildcard characters: False ``` ### -OldPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The OldPassword parameter is used with the NewPassword parameter when a user changes their own password in Outlook on the web. By default, the NewPassword and OldPassword parameters are also available to members of the Help Desk and Organization Management role groups via the User Options role. However, administrators typically use the Password parameter to reset a user's password, because that parameter doesn't require the user's current password. @@ -4112,7 +4380,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4122,6 +4389,9 @@ Accept wildcard characters: False ``` ### -OMEncryption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -4130,7 +4400,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4140,6 +4409,9 @@ Accept wildcard characters: False ``` ### -OMEncryptionStore + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. PARAMVALUE: Boolean @@ -4148,7 +4420,6 @@ PARAMVALUE: Boolean Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4158,6 +4429,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Password parameter resets the password of the user account that's associated with the mailbox to the value you specify. To use this parameter on a mailbox other than your own, consider the following options: - Exchange Online: You can't use this parameter to change another user's password. Use the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. @@ -4173,7 +4447,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4183,6 +4456,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. @@ -4195,7 +4471,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4205,6 +4480,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ProhibitSendQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send new messages, and the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -4215,11 +4493,11 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The ProhibitSendQuota value must be less than or equal to the ProhibitSendReceiveQuota value. -In Exchange Online, the quota value is determined by the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. You can lower the quota value, and you may be able to raise the quota, but you can't exceed the maximum value that's allowed by the subscription or license. In Exchange Online, you can't use this parameter on public folder mailboxes. +In Exchange Online, the quota value is determined by the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. You can lower the quota value, and you might be able to raise the quota, but you can't exceed the maximum value that's allowed by the subscription or license. In Exchange Online, you can't use this parameter on public folder mailboxes. In on-premises Exchange, the default value of this parameter is unlimited. When the UseDatabaseQuotaDefaults parameter on the mailbox is set to the value $true (the default value), the value of the this parameter is ignored, and the mailbox uses the ProhibitSendQuota value from the mailbox database. To use this parameter to enforce a specific quota value for the mailbox, you need to set the UseDatabaseQuotaDefaults parameter to the value $false. @@ -4227,7 +4505,6 @@ In on-premises Exchange, the default value of this parameter is unlimited. When Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4237,6 +4514,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -4247,7 +4527,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. @@ -4259,7 +4539,6 @@ In on-premises Exchange, the default value of this parameter is unlimited. When Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4269,6 +4548,9 @@ Accept wildcard characters: False ``` ### -ProvisionedForOfficeGraph + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -4277,7 +4559,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -4287,6 +4568,9 @@ Accept wildcard characters: False ``` ### -PstProvider + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -4295,7 +4579,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4305,6 +4588,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublicFolder switch is required to modify public folder mailboxes. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -4313,7 +4599,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4323,6 +4608,9 @@ Accept wildcard characters: False ``` ### -QueryBaseDN + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -4331,7 +4619,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationalUnitIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4341,6 +4628,9 @@ Accept wildcard characters: False ``` ### -RecalculateInactiveMailbox + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecalculateInactiveMailbox switch specifies whether to recalculate the hold status of an inactive mailbox. You don't need to specify a value with this switch. @@ -4353,7 +4643,6 @@ You use this switch with the InactiveMailbox switch and the Identity parameter ( Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4363,6 +4652,9 @@ Accept wildcard characters: False ``` ### -RecipientLimits + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientLimits parameter specifies the maximum number of recipients allowed in messages sent by the mailbox. In on-premises Exchange, a valid value is an integer or the value unlimited. The default value is unlimited, which indicates the maximum number of recipients per message for the mailbox is controlled elsewhere (for example, organization, server, or connector limits). @@ -4373,7 +4665,6 @@ In the cloud-based service, a valid value is an integer from 1 to 1000. The defa Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4383,6 +4674,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder of the mailbox. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages. @@ -4397,7 +4691,7 @@ When you enter a number, you can qualify it with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. @@ -4407,7 +4701,6 @@ When the UseDatabaseQuotaDefaults parameter is set to the value $true (the defau Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4417,6 +4710,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for the mailbox. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log. @@ -4431,7 +4727,7 @@ When you enter a number, you can qualify it with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value. @@ -4441,7 +4737,6 @@ When the UseDatabaseQuotaDefaults parameter is set to the value $true (the defau Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4451,6 +4746,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -4474,7 +4772,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4484,6 +4781,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -4507,7 +4807,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4517,6 +4816,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -4542,7 +4844,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4552,6 +4853,9 @@ Accept wildcard characters: False ``` ### -RemoteRecipientType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -4560,7 +4864,6 @@ This parameter is reserved for internal Microsoft use. Type: RemoteRecipientType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4570,6 +4873,9 @@ Accept wildcard characters: False ``` ### -RemoveDelayHoldApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RemoveDelayHoldApplied switch specifies whether to remove delay holds on email-related data (generated by Outlook or Outlook on the web) from the mailbox. You don't need to specify a value with this switch. @@ -4583,7 +4889,6 @@ For more information, see [Managing mailboxes on delay hold](https://learn.micro Type: SwitchParameter Parameter Sets: RemoveDelayHoldApplied Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4593,6 +4898,9 @@ Accept wildcard characters: False ``` ### -RemoveDelayReleaseHoldApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RemoveDelayReleaseHoldApplied switch specifies whether to remove delay holds on cloud data generated by non-Exchange apps (such as Teams, Forms, and Viva Engage) from the mailbox. Data generated by a non-Exchange cloud-based app is typically stored in a hidden folder in the mailbox. You don't need to specify a value with this switch. @@ -4607,7 +4915,6 @@ For more information, see [Managing mailboxes on delay hold](https://learn.micro Type: SwitchParameter Parameter Sets: RemoveDelayReleaseHoldApplied Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4617,6 +4924,9 @@ Accept wildcard characters: False ``` ### -RemoveDisabledArchive + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The RemoveDisabledArchive switch specifies whether to remove the disabled archive that's associated with the mailbox. You don't need to specify a value with this switch. @@ -4625,7 +4935,6 @@ The RemoveDisabledArchive switch specifies whether to remove the disabled archiv Type: SwitchParameter Parameter Sets: RemoveDisabledArchive Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -4635,6 +4944,9 @@ Accept wildcard characters: False ``` ### -RemoveMailboxProvisioningConstraint + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveMailboxProvisioningConstraint Description }} @@ -4643,7 +4955,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4653,6 +4964,9 @@ Accept wildcard characters: False ``` ### -RemoveManagedFolderAndPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoveManagedFolderAndPolicy switch specifies whether to remove all MRM policies and attributes from a mailbox. You don't need to specify a value with this switch. @@ -4661,7 +4975,6 @@ The RemoveManagedFolderAndPolicy switch specifies whether to remove all MRM poli Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4671,19 +4984,21 @@ Accept wildcard characters: False ``` ### -RemoveOrphanedHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RemoveOrphanedHolds parameter is used to remove the mailbox (typically, an inactive mailbox) from In-Place Holds that no longer exist, but are still applied to the mailbox. You identify the In-Place Hold by using its GUID value. You can specify multiple GUID values separated by commas. -If you use the GUID value of an In-Place Hold that still exists as a value for this parameter, the command will return an error. If that happens, you'll need to remove the mailbox (or inactive mailbox) from the In-Place Hold. +If you use the GUID value of an In-Place Hold that still exists as a value for this parameter, the command returns an error. If that happens, you need to remove the mailbox (or inactive mailbox) from the In-Place Hold. -In an Exchange hybrid deployment, In-Place Holds that are created in the on-premises organization can be applied to cloud-based mailboxes. In this scenario, it's possible that the hold object hasn't been synced to the cloud-based organization, and using this parameter will remove the specified hold from the cloud-based mailbox even though the hold may still exist. To prevent this from happening, make sure the hold doesn't exist in the on-premises organization before you use this parameter. +In an Exchange hybrid deployment, In-Place Holds that are created in the on-premises organization can be applied to cloud-based mailboxes. In this scenario, it's possible that the hold object hasn't been synced to the cloud-based organization, and using this parameter removes the specified hold from the cloud-based mailbox even though the hold might still exist. To prevent this from happening, make sure the hold doesn't exist in the on-premises organization before you use this parameter. ```yaml Type: String[] Parameter Sets: RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4693,6 +5008,9 @@ Accept wildcard characters: False ``` ### -RemovePicture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemovePicture switch specifies whether to remove the picture from the mailbox. You don't need to specify a value with this switch. @@ -4703,7 +5021,6 @@ You can add a picture to a mailbox by using the Import-RecipientDataProperty cmd Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4713,6 +5030,9 @@ Accept wildcard characters: False ``` ### -RemoveSpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RemoveSpokenName parameter specifies whether to remove the spoken name from the mailbox. You don't need to specify a value with this switch. @@ -4723,7 +5043,6 @@ You can add a sound file to a mailbox by using the Import-RecipientDataProperty Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4733,6 +5052,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -4742,7 +5064,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4752,12 +5073,15 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ResetPasswordOnNextLogon parameter specifies whether the user is required to change their password the next time they log on to their mailbox. Valid values are: - $true: The user is required to change their password the next time they log on to their mailbox. -- $false: The user isn't required to change their password the next time they log on to their mailbox. This is the default value. +- $false: The user isn't required to change their password the next time they log on to their mailbox. This value is the default. In Exchange Online, administrators can require users to reset their password the next time they log on by using the ResetPasswordOnNextLogon parameter on the Set-User cmdlet. @@ -4765,7 +5089,6 @@ In Exchange Online, administrators can require users to reset their password the Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4775,13 +5098,15 @@ Accept wildcard characters: False ``` ### -ResourceCapacity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResourceCapacity parameter specifies the capacity of the resource mailbox. For example, you can use this parameter to identify the number of seats in a conference room (room mailbox) or in a vehicle (equipment mailbox). A valid value is an integer. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4791,6 +5116,9 @@ Accept wildcard characters: False ``` ### -ResourceCustom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResourceCustom parameter specifies one or more custom resource properties to add to the resource mailbox. You can use this parameter only on resource mailboxes. You use the Set-ResourceConfig and Get-ResourceConfig cmdlets to create and view custom resource properties. @@ -4805,7 +5133,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4815,6 +5142,9 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsFor + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetainDeletedItemsFor parameter specifies the length of time to keep soft-deleted items for the mailbox. Soft-deleted items are items that have been deleted by using any of these methods: - Deleting items from the Deleted Items folder. @@ -4837,7 +5167,6 @@ In on-premises Exchange, when the UseDatabaseQuotaDefaults parameter on the mail Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4847,12 +5176,15 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsUntilBackup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RetainDeletedItemsUntilBackup parameter specifies whether to keep items in the Recoverable Items\\Deletions folder of the mailbox until the next database backup occurs. Valid values are: - $true: Deleted items are kept until the next mailbox database backup. This value could effectively override the DeletedItemRetention and RecoverableItemsQuota parameter values. -- $false: This is the default value. Retention of deleted items in mailboxes is controlled by the DeletedItemRetention and RecoverableItemsQuota parameter values. +- $false: This value is the default. Retention of deleted items in mailboxes is controlled by the DeletedItemRetention and RecoverableItemsQuota parameter values. When the UseDatabaseRetentionDefaults parameter on the mailbox is set to the value $true (the default value), the value of the this parameter is ignored, and the mailbox uses the RetainDeletedItemsUntilBackup parameter value from the mailbox database. To use the RetainDeletedItemsUntilBackup parameter on the mailbox, you need to set the UseDatabaseRetentionDefaults parameter to the value $false. @@ -4862,7 +5194,6 @@ For more information, see [Recoverable Items folder in Exchange Server](https:// Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4872,6 +5203,9 @@ Accept wildcard characters: False ``` ### -RetentionComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RetentionComment parameter specifies a comment that's displayed in Outlook regarding the user's retention hold status. In on-premises Exchange, you can only use this parameter if the RetentionHoldEnabled parameter is set to $true. @@ -4884,7 +5218,6 @@ This comment should be localized to the user's preferred language. If the commen Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4894,10 +5227,13 @@ Accept wildcard characters: False ``` ### -RetentionHoldEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionHoldEnabled parameter specifies whether the mailbox is placed on retention hold. Placing the mailbox on retention hold temporarily suspends the processing of retention policies or managed folder mailbox policies for the mailbox (for example, when the user is on vacation). Valid values are: - $true: The mailbox is placed on retention hold. Retention policies and managed folder policies are suspended for the mailbox, and purging items from the mailbox isn't possible (even using MFCMapi). -- $false: The retention hold is removed from the mailbox. The mailbox is subject to retention policies and managed folder policies. This is the default value. +- $false: The retention hold is removed from the mailbox. The mailbox is subject to retention policies and managed folder policies. This value is the default. To set the start date for retention hold, use the StartDateForRetentionHold parameter. @@ -4905,7 +5241,6 @@ To set the start date for retention hold, use the StartDateForRetentionHold para Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4915,6 +5250,9 @@ Accept wildcard characters: False ``` ### -RetentionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionPolicy parameter specifies the retention policy that you want applied to this mailbox. You can use any value that uniquely identifies the policy. For example: - Name @@ -4929,7 +5267,6 @@ Use the Get-RetentionPolicy cmdlet to see the available retention policies. Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4939,6 +5276,9 @@ Accept wildcard characters: False ``` ### -RetentionUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RetentionUrl parameter specifies the URL or an external web page with additional details about the organization's messaging retention policies. This URL can be used to expose details regarding retention policies in general, which is usually a customized legal or IT website for the company. @@ -4947,7 +5287,6 @@ This URL can be used to expose details regarding retention policies in general, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4957,6 +5296,9 @@ Accept wildcard characters: False ``` ### -RoleAssignmentPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RoleAssignmentPolicy parameter specifies the role assignment policy that's assigned to the mailbox. You can use any value that uniquely identifies the role assignment policy. For example: - Name @@ -4971,7 +5313,6 @@ Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment pol Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4981,6 +5322,9 @@ Accept wildcard characters: False ``` ### -RoomMailboxPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. Use the RoomMailboxPassword parameter to configure the password for the account that's associated with the room mailbox when that account is enabled and able to log in (the EnableRoomMailboxAccount parameter is set to the value $true). @@ -5005,7 +5349,6 @@ To configure the password for a room mailbox account in Exchange Online, use the Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5015,6 +5358,9 @@ Accept wildcard characters: False ``` ### -RulesQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RulesQuota parameter specifies the limit for the size of Inbox rules for the mailbox. When you enter a value, qualify the value with one of the following: A valid value is a number from 32 to 256 kilobytes (32768 to 262144 bytes). When you enter a value, qualify the value with one of the following units: @@ -5022,7 +5368,7 @@ A valid value is a number from 32 to 256 kilobytes (32768 to 262144 bytes). When - B (bytes) - KB (kilobytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. In Exchange Online, Exchange 2019, Exchange 2016, and Exchange 2013, the default value is 256 kilobytes (262,144 bytes). @@ -5034,7 +5380,6 @@ The quota for Inbox rules applies only to enabled rules. There is no restriction Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5044,15 +5389,17 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5062,6 +5409,9 @@ Accept wildcard characters: False ``` ### -SchedulerAssistant + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SchedulerAssistant Description }} @@ -5070,7 +5420,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -5080,19 +5429,21 @@ Accept wildcard characters: False ``` ### -SCLDeleteEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 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. +- $null (blank): The value isn't configured. This value is the default. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5102,6 +5453,9 @@ Accept wildcard characters: False ``` ### -SCLDeleteThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SCLDeleteThreshold parameter specifies the SCL delete threshold. When the SCLDeleteEnabled parameter is set to $true, messages with an SCL greater than or equal to the specified value are silently deleted. @@ -5112,7 +5466,6 @@ A valid value is an integer from 0 through 9. This value should be greater than Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5122,19 +5475,21 @@ Accept wildcard characters: False ``` ### -SCLJunkEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SCLJunkEnabled parameter specifies whether messages that exceed(not meet) the SCL specified by the SCLJunkThreshold parameter are moved to the Junk Email folder. Valid values are: - $true: Messages that exceed the SCLJunkThreshold value are moved to the Junk Email folder. Messages that meet the SCLJunkThreshold value aren't moved to the Junk Email folder. - $false: Messages that meet or exceed the SCLJunkThreshold value aren't moved to the Junk Email folder. -- $null (blank): The value isn't configured. This is the default value. +- $null (blank): The value isn't configured. This value is the default. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5144,6 +5499,9 @@ Accept wildcard characters: False ``` ### -SCLJunkThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SCLJunkThreshold parameter specifies the SCL Junk Email folder threshold. When the SCLJunkEnabled parameter is set to $true, messages with an SCL greater than (not equal to) the specified value are moved to the Junk Email folder. @@ -5154,7 +5512,6 @@ A valid value is an integer from 0 through 9. This value should be less than the Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5164,13 +5521,16 @@ Accept wildcard characters: False ``` ### -SCLQuarantineEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SCLQuarantineEnabled parameter specifies whether messages that meet or exceed the SCL specified by the SCLQuarantineThreshold parameter are quarantined. If a message is quarantined, it's sent to the quarantine mailbox where administrators can review it. Valid values are: - $true: Messages that meet or exceed the SCLQuarantineThreshold value are sent to the quarantine mailbox. - $false: Messages that meet or exceed the SCLQuarantineThreshold value aren't sent to the quarantine mailbox. -- $null (blank): The value isn't configured. This is the default value. +- $null (blank): The value isn't configured. This value is the default. To configure the quarantine mailbox, see [Configure a spam quarantine mailbox](https://learn.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-quarantine-mailboxes). @@ -5178,7 +5538,6 @@ To configure the quarantine mailbox, see [Configure a spam quarantine mailbox](h Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5188,6 +5547,9 @@ Accept wildcard characters: False ``` ### -SCLQuarantineThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SCLQuarantineThreshold parameter specifies the SCL quarantine threshold. When the SCLQuarantineEnabled parameter is set to $true, messages with an SCL greater than or equal to the specified value are quarantined. @@ -5198,7 +5560,6 @@ A valid value is an integer from 0 through 9. This value should be less than the Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5208,19 +5569,21 @@ Accept wildcard characters: False ``` ### -SCLRejectEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SCLRejectEnabled parameter specifies whether messages that meet or exceed the SCL specified by the SCLRejectThreshold parameter are rejected. Valid values are: - $true: Messages that meet or exceed the SCLRejectThreshold value are rejected, and an NDR is sent to the sender. - $false: Messages that meet or exceed the SCLRejectThreshold value aren't rejected. -- $null (blank): The value isn't configured. This is the default value. +- $null (blank): The value isn't configured. This value is the default. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5230,6 +5593,9 @@ Accept wildcard characters: False ``` ### -SCLRejectThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SCLRejectThreshold parameter specifies the SCL reject threshold. When the SCLRejectEnabled parameter is set to $true, messages with an SCL greater than or equal to the specified value are rejected, and an NDR is sent to the sender. @@ -5240,7 +5606,6 @@ A valid value is an integer from 0 through 9. This value should be less than the Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5250,6 +5615,9 @@ Accept wildcard characters: False ``` ### -SecondaryAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. @@ -5258,7 +5626,6 @@ The SecondaryAddress parameter specifies the secondary address used by the UM-en Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5268,6 +5635,9 @@ Accept wildcard characters: False ``` ### -SecondaryDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. @@ -5276,7 +5646,6 @@ The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5286,9 +5655,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -5298,7 +5670,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5308,6 +5679,9 @@ Accept wildcard characters: False ``` ### -SharingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SharingPolicy parameter specifies the sharing policy that's assigned to the mailbox. You can use any value that uniquely identifies the sharing policy. For example: - Name @@ -5320,7 +5694,6 @@ Use the Get-SharingPolicy cmdlet to see the available sharing policies. Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5330,6 +5703,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -5342,7 +5718,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5352,16 +5727,18 @@ Accept wildcard characters: False ``` ### -SingleItemRecoveryEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SingleItemRecoveryEnabled parameter specifies whether to prevent the Recoverable Items folder from being purged. Valid values are: -- $true: Single item recovery is enabled. The Recoverable Items folder can't be purged, and deleted or edited items can't be removed. This is the default value in Exchange Online. For more information, see [Enable or disable single item recovery for a mailbox in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-single-item-recovery). -- $false: Single item recovery isn't enabled. The Recoverable Items folder can be purged, and deleted or edited items can be removed. This is the default value in Exchange Server. For more information, see [Enable or disable single item recovery for a mailbox](https://learn.microsoft.com/exchange/recipients/user-mailboxes/single-item-recovery). +- $true: Single item recovery is enabled. The Recoverable Items folder can't be purged, and deleted or edited items can't be removed. This value is the default in Exchange Online. For more information, see [Enable or disable single item recovery for a mailbox in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-single-item-recovery). +- $false: Single item recovery isn't enabled. The Recoverable Items folder can be purged, and deleted or edited items can be removed. This value is the default in Exchange Server. For more information, see [Enable or disable single item recovery for a mailbox](https://learn.microsoft.com/exchange/recipients/user-mailboxes/single-item-recovery). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5371,6 +5748,9 @@ Accept wildcard characters: False ``` ### -SkipDualWrite + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange This parameter is reserved for internal Microsoft use. @@ -5379,7 +5759,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5389,6 +5768,9 @@ Accept wildcard characters: False ``` ### -StartDateForRetentionHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -5399,7 +5781,6 @@ To use this parameter, you need to set the RetentionHoldEnabled parameter to val Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5409,13 +5790,15 @@ Accept wildcard characters: False ``` ### -StsRefreshTokensValidFrom + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5425,6 +5808,9 @@ Accept wildcard characters: False ``` ### -SystemMessageSizeShutoffQuota + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -5433,7 +5819,6 @@ This parameter is reserved for internal Microsoft use. Type: Int64 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5443,6 +5828,9 @@ Accept wildcard characters: False ``` ### -SystemMessageSizeWarningQuota + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -5451,7 +5839,6 @@ This parameter is reserved for internal Microsoft use. Type: Int64 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5461,6 +5848,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ThrottlingPolicy parameter specifies the throttling policy that's assigned to the mailbox. You can use any value that uniquely identifies the throttling policy. For example: @@ -5475,7 +5865,6 @@ Use the Get-ThrottlingPolicy cmdlet to see the available throttling policies. Type: ThrottlingPolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5485,6 +5874,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Type parameter specifies the mailbox type for the mailbox. Valid values are: - Equipment @@ -5498,7 +5890,6 @@ The Type parameter specifies the mailbox type for the mailbox. Valid values are: Type: ConvertibleMailboxSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5508,6 +5899,9 @@ Accept wildcard characters: False ``` ### -UMDataStorage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UMDataStorage parameter specifies whether the arbitration mailbox (also called an organization mailbox) is used to store UM call data records and UM custom prompts. This capability can be assigned to only one arbitration mailbox for the organization. You can use this parameter only on an arbitration mailbox. @@ -5518,7 +5912,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5528,6 +5921,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -5548,7 +5944,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5558,9 +5953,12 @@ Accept wildcard characters: False ``` ### -UMGrammar + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The UMGrammar parameter specifies whether the arbitration mailbox (also called an organization mailbox) is used for UM directory speech grammar generation for the organization. UM directory speech grammars will be generated and used on the Mailbox server of this arbitration mailbox. UM directory speech grammars are used in speech-enabled directory search features, such as UM auto attendants. You can use this parameter only on an arbitration mailbox. +The UMGrammar parameter specifies whether the arbitration mailbox (also called an organization mailbox) is used for UM directory speech grammar generation for the organization. UM directory speech grammars are generated and used on the Mailbox server of this arbitration mailbox. UM directory speech grammars are used in speech-enabled directory search features, such as UM auto attendants. You can use this parameter only on an arbitration mailbox. Valid values are $true or $false. @@ -5568,7 +5966,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5578,6 +5975,9 @@ Accept wildcard characters: False ``` ### -UpdateEnforcedTimestamp + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill UpdateEnforcedTimestamp Description }} @@ -5586,7 +5986,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5596,6 +5995,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseQuotaDefaults + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UseDatabaseQuotaDefaults parameter specifies whether applicable quotas for the mailbox are determined by the quota values on the mailbox or the corresponding quota values on the mailbox database (not all mailbox quotas are configurable on the mailbox database). Valid values are: - $true: The mailbox uses the applicable quota values that are configured on the mailbox database. Any corresponding quotas that are configured on the mailbox are ignored. In on-premises Exchange, this is the default value. @@ -5614,7 +6016,6 @@ The following quotas are affected by this parameter: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5624,11 +6025,14 @@ Accept wildcard characters: False ``` ### -UseDatabaseRetentionDefaults + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The UseDatabaseRetentionDefaults parameter specifies whether the retention settings for items in the Recoverable Items folder in the mailbox are determined by the settings on the mailbox or the corresponding settings on the mailbox database. Valid values are: -- $true: The mailbox uses the applicable retention settings that are configured on the mailbox database. Any corresponding settings that are configured on the mailbox are ignored. This is the default value. +- $true: The mailbox uses the applicable retention settings that are configured on the mailbox database. Any corresponding settings that are configured on the mailbox are ignored. This value is the default. - $false: The mailbox uses its own values for the applicable retention settings. Any corresponding settings that are configured on the mailbox database are ignored. The following retention settings are affected by this parameter: @@ -5636,7 +6040,7 @@ The following retention settings are affected by this parameter: - DeletedItemRetention - RetainDeletedItemsUntilBackup -**Note**: If you set the RetainDeletedItemsUntilBackup parameter on the mailbox database to the value $true when the value of the UseDatabaseRetentionDefaults parameter on a mailbox is also $true (the default value), the value of the UseDatabaseRetentionDefaults property in the output of the Get-Mailbox cmdlet will erroneously appear as False. To verify the value of the UseDatabaseRetentionDefaults property on the mailbox, do the following steps in the Exchange Management Shell: +**Note**: If you set the RetainDeletedItemsUntilBackup parameter on the mailbox database to the value $true when the value of the UseDatabaseRetentionDefaults parameter on a mailbox is also $true (the default value), the value of the UseDatabaseRetentionDefaults property in the output of the Get-Mailbox cmdlet erroneously appears as False. To verify the value of the UseDatabaseRetentionDefaults property on the mailbox, do the following steps in the Exchange Management Shell: - Run the following command: `Import-Module ActiveDirectory`. - Replace \ with the Alias value of the mailbox, and run the following command: `Get-ADUser -Properties mDBUseDefaults | Format-List mDBUseDefaults`. @@ -5645,7 +6049,6 @@ The following retention settings are affected by this parameter: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5655,13 +6058,15 @@ Accept wildcard characters: False ``` ### -UserCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5671,6 +6076,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. @@ -5679,7 +6087,6 @@ The UserPrincipalName parameter specifies the logon name for the user account. T Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5689,13 +6096,15 @@ Accept wildcard characters: False ``` ### -UserSMimeCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5705,13 +6114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5721,6 +6132,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -5732,7 +6146,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxAuditBypassAssociation.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxAuditBypassAssociation.md index bf087d92fa..e902549d46 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxAuditBypassAssociation.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxAuditBypassAssociation -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxauditbypassassociation +schema: 2.0.0 +title: Set-MailboxAuditBypassAssociation --- # Set-MailboxAuditBypassAssociation ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailboxAuditBypassAssociation cmdlet to configure mailbox audit logging bypass for user or computer accounts such as service accounts for applications that access mailboxes frequently. @@ -31,9 +32,9 @@ Set-MailboxAuditBypassAssociation [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies a user or computer account to be bypassed from mailbox audit logging. ```yaml Type: MailboxAuditBypassAssociationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -AuditBypassEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AuditBypassEnabled parameter specifies whether audit bypass is enabled for the user or computer. Valid values include the following: - $true: Enables mailbox audit logging bypass @@ -79,7 +85,6 @@ The AuditBypassEnabled parameter specifies whether audit bypass is enabled for t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -98,7 +106,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxAutoReplyConfiguration.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxAutoReplyConfiguration.md index 24d0f4377e..eae06dedc4 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxAutoReplyConfiguration.md @@ -1,19 +1,20 @@ --- +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection +author: chrisda external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxautoreplyconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxAutoReplyConfiguration +Locale: en-US +Module Name: ExchangePowerShell +ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxautoreplyconfiguration schema: 2.0.0 search.appverid: MET150 -author: chrisda -ms.author: chrisda -ms.reviewer: +title: Set-MailboxAutoReplyConfiguration --- # Set-MailboxAutoReplyConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailboxAutoReplyConfiguration cmdlet to configure Automatic Replies settings for a specific mailbox. @@ -46,7 +47,7 @@ Set-MailboxAutoReplyConfiguration [-Identity] ## DESCRIPTION You can disable Automatic Replies for a specified mailbox or organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +68,9 @@ This example configures Automatic Replies for Tony's mailbox to be sent, specifi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -84,7 +88,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -94,12 +97,15 @@ Accept wildcard characters: False ``` ### -AutoDeclineFutureRequestsWhenOOF + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The AutoDeclineFutureRequestsWhenOOF parameter specifies whether to automatically decline new meeting requests that are sent to the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: - $true: New meeting requests that are received during the scheduled time period are automatically declined. -- $false: Meeting requests received during the scheduled time period aren't automatically declined. This is the default value. +- $false: Meeting requests received during the scheduled time period aren't automatically declined. This value is the default. You can use this parameter only when the AutoReplyState parameter is set to Scheduled. @@ -107,7 +113,6 @@ You can use this parameter only when the AutoReplyState parameter is set to Sche Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -117,10 +122,13 @@ Accept wildcard characters: False ``` ### -AutoReplyState + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AutoReplyState parameter specifies whether the mailbox is enabled for Automatic Replies. Valid values are: - Enabled: Automatic Replies are sent for the mailbox. -- Disabled: Automatic Replies aren't sent for the mailbox. This is the default value. +- Disabled: Automatic Replies aren't sent for the mailbox. This value is the default. - Scheduled: Automatic Replies are sent for the mailbox during the time period that's specified by the StartTime and EndTime parameters. The Enabled and Scheduled values require these additional settings: @@ -132,7 +140,6 @@ The Enabled and Scheduled values require these additional settings: Type: OofState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -151,7 +161,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -161,18 +170,20 @@ Accept wildcard characters: False ``` ### -CreateOOFEvent + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The CreateOOFEvent parameter specifies whether to create a calendar event that corresponds to the scheduled time period when Automatic Replies are being sent for the mailbox. Valid values are: - $true: When you configure a scheduled time period for Automatic Replies by using the value Scheduled for the AutoReplyState parameter, a calendar event is created in the mailbox for those dates. You can specify the subject for the event by using the OOFEventSubject parameter. -- $false: When you configure a scheduled time period for Automatic Replies by using the value Scheduled for the AutoReplyState parameter, no calendar event is created for those dates. This is the default value. +- $false: When you configure a scheduled time period for Automatic Replies by using the value Scheduled for the AutoReplyState parameter, no calendar event is created for those dates. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,12 +193,15 @@ Accept wildcard characters: False ``` ### -DeclineAllEventsForScheduledOOF + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The DeclineAllEventsForScheduledOOF parameter specifies whether to decline all existing calendar events in the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: - $true: Existing calendar events in the mailbox that occur during the scheduled time period are declined and removed from the calendar. If the mailbox is the meeting organizer, the events are cancelled for all other attendees. -- $false: Existing calendar events in the mailbox that occur during the scheduled time period remain in the calendar. This is the default value. +- $false: Existing calendar events in the mailbox that occur during the scheduled time period remain in the calendar. This value is the default. You can use this parameter only when the DeclineEventsForScheduledOOF parameter is set to $true. @@ -197,7 +211,6 @@ You can't use this parameter with the EventsToDeleteIDs parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -207,6 +220,9 @@ Accept wildcard characters: False ``` ### -DeclineEventsForScheduledOOF + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The DeclineEventsForScheduledOOF parameter specifies whether it's possible to decline existing calendar events in the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: @@ -215,7 +231,7 @@ The DeclineEventsForScheduledOOF parameter specifies whether it's possible to de To decline specific events during the scheduled time period, use the EventsToDeleteIDs parameter. To decline all events during the scheduled time period, use the DeclineAllEventsForScheduledOOF parameter. -- $false: Existing calendar events in the mailbox that occur during the scheduled time period remain in the calendar. This is the default value. +- $false: Existing calendar events in the mailbox that occur during the scheduled time period remain in the calendar. This value is the default. You can use this parameter only when the AutoReplyState parameter is set to Scheduled. @@ -223,7 +239,6 @@ You can use this parameter only when the AutoReplyState parameter is set to Sche Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -233,6 +248,9 @@ Accept wildcard characters: False ``` ### -DeclineMeetingMessage + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The DeclineMeetingMessage parameter specifies the text in the message when meetings requests that are sent to the mailbox are automatically declined. For example: @@ -248,7 +266,6 @@ To clear the value of this parameter, use the value $null. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -258,6 +275,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -266,7 +286,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,6 +295,9 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -284,7 +306,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -294,6 +315,9 @@ Accept wildcard characters: False ``` ### -EventsToDeleteIDs + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The EventsToDeleteIDs parameter specifies the calendar events to delete from the mailbox when the DeclineEventsForScheduledOOF parameter is set to $true. @@ -306,7 +330,6 @@ You can't use this parameter with the DeclineAllEventsForScheduledOOF parameter. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -316,11 +339,14 @@ Accept wildcard characters: False ``` ### -ExternalAudience + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalAudience parameter specifies whether Automatic Replies are sent to external senders. Valid values are: - None: Automatic Replies aren't sent to any external senders. - Known: Automatic Replies are sent only to external senders that are specified in the Contact list of the mailbox. -- All: Automatic Replies are sent to all external senders. This is the default value. +- All: Automatic Replies are sent to all external senders. This value is the default. The value of this parameter is meaningful only when the AutoReplyState parameter is set to Enabled or Scheduled. @@ -328,7 +354,6 @@ The value of this parameter is meaningful only when the AutoReplyState parameter Type: ExternalAudience Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -338,6 +363,9 @@ Accept wildcard characters: False ``` ### -ExternalMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalMessage parameter specifies the Automatic Replies message that's sent to external senders or senders outside the organization. If the value contains spaces, enclose the value in quotation marks ("). HTML tags are automatically added to the text. For example, if you enter the text, "I'm on vacation", the value automatically becomes: `I'm on vacation`. Additional HTML tags are supported if you enclose the value in quotation marks. For example, `"I'm on vacation. I'll respond when I return."`. @@ -353,7 +381,6 @@ To clear the value of this parameter when it's no longer required (for example, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -363,6 +390,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -374,7 +404,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -384,6 +413,9 @@ Accept wildcard characters: False ``` ### -InternalMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InternalMessage parameter specifies the Automatic Replies message that's sent to internal senders or senders within the organization. If the value contains spaces, enclose the value in quotation marks ("). HTML tags are automatically added to the text. For example, if you enter the text: "I'm on vacation", the value automatically becomes: `I'm on vacation`. Additional HTML tags are supported if you enclose the value in quotation marks. For example, `"I'm on vacation. Please contact my manager."`. @@ -396,7 +428,6 @@ To clear the value of this parameter when it's no longer required (for example, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -406,6 +437,9 @@ Accept wildcard characters: False ``` ### -OOFEventSubject + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The OOFEventSubject parameter specifies the subject for the calendar event that's automatically created when the CreateOOFEvent parameter is set to $true. @@ -416,7 +450,6 @@ If the value contains spaces, enclose the value in quotation marks ("). To clear Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -426,6 +459,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -434,7 +470,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -444,13 +479,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarConfiguration.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarConfiguration.md index 78d43a57d3..3c37bb9ac5 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxcalendarconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxCalendarConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxcalendarconfiguration +schema: 2.0.0 +title: Set-MailboxCalendarConfiguration --- # Set-MailboxCalendarConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailboxCalendarConfiguration cmdlet to modify mailbox calendar settings for Outlook on the web. This affects how the user's calendar looks and how reminders work in Outlook on the web. This also affects settings that define how meeting invitations, responses, and notifications are sent to the user. @@ -157,7 +158,7 @@ Set-MailboxCalendarConfiguration [-MailboxLocation ] ## DESCRIPTION The Set-MailboxCalendarConfiguration cmdlet primarily allows users to manage their own calendar settings in Outlook on the web Options. However, administrators who are members of the Organization Management or Recipient Management role groups can configure the calendar settings for users by using this cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -185,6 +186,9 @@ This example sets the working day's starting hour to 7 A.M. for the calendar of ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -202,7 +206,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -212,13 +215,15 @@ Accept wildcard characters: False ``` ### -AgendaMailEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -228,6 +233,9 @@ Accept wildcard characters: False ``` ### -AgendaMailIntroductionEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AgendaMailIntroductionEnabled Description }} @@ -236,7 +244,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -246,6 +253,9 @@ Accept wildcard characters: False ``` ### -AgendaPaneEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -254,7 +264,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -264,6 +273,9 @@ Accept wildcard characters: False ``` ### -AutoDeclineWhenBusy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AutoDeclineWhenBusy Description }} @@ -272,7 +284,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -282,6 +293,9 @@ Accept wildcard characters: False ``` ### -CalendarFeedsPreferredLanguage + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The CalendarFeedsPreferredLanguage parameter specifies the preferred language for calendar feeds. A valid value is an ISO 639-1 lowercase two-letter language code (for example, en for English). @@ -290,7 +304,6 @@ The CalendarFeedsPreferredLanguage parameter specifies the preferred language fo Type: String Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -300,6 +313,9 @@ Accept wildcard characters: False ``` ### -CalendarFeedsPreferredRegion + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The CalendarFeedsPreferredRegion specifies the preferred region for calendar feeds. A valid value is an ISO 3166-1 two-letter country code (for example, AU for Australia). @@ -310,7 +326,6 @@ A reference for two-letter country codes is available at [Country Codes List](ht Type: String Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -320,6 +335,9 @@ Accept wildcard characters: False ``` ### -CalendarFeedsRootPageId + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The CalendarFeedsRootPageId parameter specifies the root page ID for calendar feeds. @@ -328,7 +346,6 @@ The CalendarFeedsRootPageId parameter specifies the root page ID for calendar fe Type: String Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -338,6 +355,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -347,7 +367,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -357,16 +376,18 @@ Accept wildcard characters: False ``` ### -ConversationalSchedulingEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConversationalSchedulingEnabled parameter specifies whether to enable or disable conversational scheduling. Valid values are: -- $true: Conversational scheduling is enabled. This is the default value. +- $true: Conversational scheduling is enabled. This value is the default. - $false: Conversational scheduling is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -376,18 +397,20 @@ Accept wildcard characters: False ``` ### -CreateEventsFromEmailAsPrivate + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The CreateEventsFromEmailAsPrivate parameter specifies whether to create events from email messages as Normal or Private. Valid values are: -- $true: Events from email are created as Private. This is the default value. +- $true: Events from email are created as Private. This value is the default. - $false: Events from email are created as Normal (public). ```yaml Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -397,13 +420,15 @@ Accept wildcard characters: False ``` ### -DailyAgendaMailSchedule + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: AgendaMailSchedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -413,13 +438,15 @@ Accept wildcard characters: False ``` ### -DefaultMeetingDuration + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -429,6 +456,9 @@ Accept wildcard characters: False ``` ### -DefaultMinutesToReduceLongEventsBy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DefaultMinutesToReduceLongEventsBy Description }} @@ -437,7 +467,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -447,6 +476,9 @@ Accept wildcard characters: False ``` ### -DefaultMinutesToReduceShortEventsBy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DefaultMinutesToReduceShortEventsBy Description }} @@ -455,7 +487,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -465,6 +496,9 @@ Accept wildcard characters: False ``` ### -DefaultOnlineMeetingProvider + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DefaultOnlineMeetingProvider parameter specifies the default provider for online meetings. Valid values are: @@ -482,7 +516,7 @@ The DefaultOnlineMeetingProvider parameter specifies the default provider for on - RingCentral - SkypeForBusiness - SkypeForConsumer -- TeamsForBusiness (This is the default value.) +- TeamsForBusiness (This value is the default.) - Webex - Zoom @@ -490,7 +524,6 @@ The DefaultOnlineMeetingProvider parameter specifies the default provider for on Type: OnlineMeetingProviderType Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -500,16 +533,19 @@ Accept wildcard characters: False ``` ### -DefaultReminderTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. -Note that the value can't contain seconds. Valid values are: +The value can't contain seconds. Valid values are: - 00:00:00 - 00:05:00 (5 minutes) - 00:10:00 (10 minutes) -- 00:15:00 (15 minutes) This is the default value. +- 00:15:00 (15 minutes) This value is the default. - 00:30:00 (30 minutes) - 01:00:00 (1 hour) - 02:00:00 (2 hours) @@ -529,7 +565,6 @@ This parameter is ignored when the RemindersEnabled parameter is set to $false. Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -539,6 +574,9 @@ Accept wildcard characters: False ``` ### -DeleteMeetingRequestOnRespond + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DeleteMeetingRequestOnRespond Description }} @@ -547,7 +585,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -557,11 +594,14 @@ Accept wildcard characters: False ``` ### -DiningEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DiningEventsFromEmailEnabled parameter specifies whether to create dining reservation events from email messages. Valid values are: -- $true: Create dining reservation events from email messages. This is the default value. +- $true: Create dining reservation events from email messages. This value is the default. - $false: Don't create dining reservation events from email messages. This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). @@ -570,7 +610,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -580,6 +619,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -588,7 +630,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -598,11 +639,14 @@ Accept wildcard characters: False ``` ### -EntertainmentEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EntertainmentEventsFromEmailEnabled parameter specifies whether to create entertainment reservation events from email messages. Valid values are: -- $true: Create entertainment reservation events from email messages. This is the default value. +- $true: Create entertainment reservation events from email messages. This value is the default. - $false: Don't create entertainment reservation events from email messages. This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). @@ -611,7 +655,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -621,11 +664,14 @@ Accept wildcard characters: False ``` ### -EventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EventsFromEmailEnabled parameter specifies whether to enable events to be created from email messages. Valid values are: -- $true: Creating events from email messages is enabled. This is the default value. +- $true: Creating events from email messages is enabled. This value is the default. - $false: Creating events from email messages is disabled. When this setting is enabled, you can enable or disable creating specific types of events from email messages by using the following parameters: @@ -641,7 +687,6 @@ When this setting is enabled, you can enable or disable creating specific types Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -651,12 +696,15 @@ Accept wildcard characters: False ``` ### -FirstWeekOfYear + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FirstWeekOfYear parameter specifies the first week of the year. Valid values are: -- FirstDay: Week numbers start on the first day of the year. This is the default value. +- FirstDay: Week numbers start on the first day of the year. This value is the default. - FirstFourDayWeek: Week numbers start on the first week that has at least four days. - FirstFullWeek: Week numbers start on the first week that has seven days. -- LegacyNotSet: You can't set this value. This is a null value that appears only when the mailbox has been moved from an earlier version of Exchange. +- LegacyNotSet: You can't set this value. This is a null value that appears only when the mailbox is moved from an earlier version of Exchange. You configure the first day of the week by using the WeekStartDay parameter. @@ -664,7 +712,6 @@ You configure the first day of the week by using the WeekStartDay parameter. Type: FirstWeekRules Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -674,11 +721,14 @@ Accept wildcard characters: False ``` ### -FlightEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FlightEventsFromEmailEnabled parameter specifies whether to create flight reservation events from email messages. Valid values are: -- $true: Create flight reservation events from email messages. This is the default value. +- $true: Create flight reservation events from email messages. This value is the default. - $false: Don't create flight reservation events from email messages. This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). @@ -687,7 +737,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -697,11 +746,14 @@ Accept wildcard characters: False ``` ### -HotelEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The HotelEventsFromEmailEnabled parameter specifies whether to create hotel reservation events from email messages. Valid values are: -- $true: Create hotel reservation events from email messages. This is the default value. +- $true: Create hotel reservation events from email messages. This value is the default. - $false: Don't create hotel reservation events from email messages. This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). @@ -710,7 +762,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -720,18 +771,20 @@ Accept wildcard characters: False ``` ### -InvoiceEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The InvoiceEventsFromEmailEnabled parameter specifies whether to allow creating invoices from email messages. Valid values are: -- $true: Creating invoices from messages is enabled. This is the default value. +- $true: Creating invoices from messages is enabled. This value is the default. - $false: Creating invoices from messages is disabled. ```yaml Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -741,19 +794,21 @@ Accept wildcard characters: False ``` ### -LocationDetailsInFreeBusy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The LocationDetailsInFreeBusy parameter specifies the level of work location information that's returned as part of a user's availability. Work location information is visible across several Microsoft 365 application experiences, and the level of location information that's shown to other users in the organization is controlled by this parameter. Valid values are: - None: No location information is returned. - Building: Only Office or Remote are returned as work location information, if provided. -- Desk: All work location information is returned, including Building and Desk, if provided. This is the default value. +- Desk: All work location information is returned, including Building and Desk, if provided. This value is the default. ```yaml Type: LocationDetailsPermissionInFreeBusy Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -763,6 +818,9 @@ Accept wildcard characters: False ``` ### -MailboxLocation + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill MailboxLocation Description }} @@ -771,7 +829,6 @@ This parameter is available only in the cloud-based service. Type: MailboxLocationIdParameter Parameter Sets: MailboxLocation Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -781,9 +838,12 @@ Accept wildcard characters: False ``` ### -OnlineMeetingsByDefaultEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetings as Teams or Skype for Business by default during meeting creation. Currently, this parameter sets the default value, so if the user has already directly interacted with this setting from an Outlook client, this default value will be ignored. Eventually, this parameter will override the Outlook-configured setting. +The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetings as Teams or Skype for Business by default during meeting creation. Currently, this parameter sets the default value, so if the user has already directly interacted with this setting from an Outlook client, this default value is ignored. Eventually, this parameter will override the Outlook-configured setting. Valid values are: @@ -797,7 +857,6 @@ Setting this parameter enables the display of the **Add online meeting to all me Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -807,12 +866,15 @@ Accept wildcard characters: False ``` ### -PackageDeliveryEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PackageDeliveryEventsFromEmailEnabled parameter specifies whether to create package delivery events from email messages. Valid values are: - $true: Create package delivery events from email messages. -- $false: Don't create package delivery events from email messages. This is the default value. +- $false: Don't create package delivery events from email messages. This value is the default. This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). @@ -820,7 +882,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -830,6 +891,9 @@ Accept wildcard characters: False ``` ### -PreserveDeclinedMeetings + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill PreserveDeclinedMeetings Description }} @@ -838,7 +902,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -848,9 +911,12 @@ Accept wildcard characters: False ``` ### -RemindersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemindersEnabled parameter enables or disables reminders for calendar items. Valid values are: -- $true: Reminders are enabled. This is the default value. +- $true: Reminders are enabled. This value is the default. - $false: Reminders are disabled. When the reminder is first displayed is controlled by the DefaultReminderTime parameter. @@ -859,7 +925,6 @@ When the reminder is first displayed is controlled by the DefaultReminderTime pa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -869,9 +934,12 @@ Accept wildcard characters: False ``` ### -ReminderSoundEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReminderSoundEnabled parameter specifies whether a sound is played along with the reminder. Valid values are: -- $true: A sound is played with the reminder. This is the default value. +- $true: A sound is played with the reminder. This value is the default. - $false: No sound is played with the reminder. This parameter is ignored when the RemindersEnabled parameter is set to $false. @@ -880,7 +948,6 @@ This parameter is ignored when the RemindersEnabled parameter is set to $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -890,11 +957,14 @@ Accept wildcard characters: False ``` ### -RentalCarEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The RentalCarEventsFromEmailEnabled parameter specifies whether to create rental car reservation events from email messages. Valid values are: -- $true: Create rental car reservation events from email messages. This is the default value. +- $true: Create rental car reservation events from email messages. This value is the default. - $false: Don't create rental car reservation events from email messages. This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). @@ -903,7 +973,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -913,6 +982,9 @@ Accept wildcard characters: False ``` ### -ServiceAppointmentEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ServiceAppointmentEventsFromEmailEnabled Description }} @@ -921,7 +993,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -931,6 +1002,9 @@ Accept wildcard characters: False ``` ### -ShortenEventScopeDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ShortenEventScopeDefault Description }} @@ -939,7 +1013,6 @@ This parameter is available only in the cloud-based service. Type: ShortenEventScopeOption Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -949,16 +1022,18 @@ Accept wildcard characters: False ``` ### -ShowWeekNumbers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowWeekNumbers parameter specifies whether the week number is displayed in the Outlook on the web calendar. Valid values are: - $true: The week number is displayed. -- $false: The week number isn't displayed. This is the default value. +- $false: The week number isn't displayed. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -968,13 +1043,15 @@ Accept wildcard characters: False ``` ### -SkipAgendaMailOnFreeDays + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -984,16 +1061,18 @@ Accept wildcard characters: False ``` ### -TimeIncrement + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TimeIncrement parameter specifies the scale that the Outlook on the web calendar uses to show time. Valid values are: - FifteenMinutes -- ThirtyMinutes (This is the default value) +- ThirtyMinutes (default value) ```yaml Type: HourIncrement Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1003,16 +1082,18 @@ Accept wildcard characters: False ``` ### -UseBrightCalendarColorThemeInOwa + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UseBrightCalendarColorThemeInOwa parameter specifies whether to use light colors or bright colors for the calendar in Outlook on the web. Valid values are: - $true: Use bright colors in the calendar. -- $false: Use light colors in the calendar. This is the default value. +- $false: Use light colors in the calendar. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1022,11 +1103,14 @@ Accept wildcard characters: False ``` ### -WeatherEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WeatherEnabled specifies whether weather is displayed in the calendar in Outlook on the web. Valid values are: -- FirstRun (This is the default value) +- FirstRun (default value) - Disabled: Hide weather on the calendar. - Enabled: Show weather on the calendar. @@ -1034,7 +1118,6 @@ The WeatherEnabled specifies whether weather is displayed in the calendar in Out Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1044,6 +1127,9 @@ Accept wildcard characters: False ``` ### -WeatherLocationBookmark + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WeatherLocationBookmark parameter specifies the default weather information that's displayed in the calendar in Outlook on the web. This parameter is based on an index value of the configured weather locations. The first weather location has the index value 0, the second weather location has the index value 1, and so on. @@ -1054,7 +1140,6 @@ A valid value for this parameter depends on the number of weather locations that Type: Int32 Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1064,6 +1149,9 @@ Accept wildcard characters: False ``` ### -WeatherLocations + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WeatherLocations parameter specifies one or more locations to display the weather for in the calendar in Outlook on the web. @@ -1082,7 +1170,6 @@ You can configure a maximum of 5 weather locations. Type: MultiValuedProperty Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1092,11 +1179,14 @@ Accept wildcard characters: False ``` ### -WeatherUnit + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WeatherUnit parameter specifies the temperature scale that's used to display the weather in the calendar in Outlook on the web. Valid values are: -- Default (This is the default value) +- Default (default value) - Celsius - Fahrenheit @@ -1104,7 +1194,6 @@ The WeatherUnit parameter specifies the temperature scale that's used to display Type: WeatherTemperatureUnit Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1114,9 +1203,12 @@ Accept wildcard characters: False ``` ### -WeekStartDay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WeekStartDay parameter specifies the first day of the week. Valid values are: -- Sunday (This is the default value) +- Sunday (default value) - Monday - Tuesday - Wednesday @@ -1128,7 +1220,6 @@ The WeekStartDay parameter specifies the first day of the week. Valid values are Type: DayOfWeek Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1138,13 +1229,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1154,11 +1247,14 @@ Accept wildcard characters: False ``` ### -WorkDays + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WorkDays parameter specifies the work days in the calendar. Valid values are: - None - AllDays -- Weekdays (This is the default value) +- Weekdays (default value) - WeekEndDays - Sunday - Monday @@ -1174,7 +1270,6 @@ You can specify multiple values separated by commas, but redundant values are ig Type: DaysOfWeek Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1184,6 +1279,9 @@ Accept wildcard characters: False ``` ### -WorkingHoursEndTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WorkingHoursEndTime parameter specifies the time that the work day ends. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1194,7 +1292,6 @@ The default value is 17:00:00 (5:00 P.M.). Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1204,6 +1301,9 @@ Accept wildcard characters: False ``` ### -WorkingHoursStartTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WorkingHoursStartTime parameter specifies the time that the work day starts. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1214,7 +1314,6 @@ The default value is 08:00:00(8:00 A.M.). Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1224,6 +1323,9 @@ Accept wildcard characters: False ``` ### -WorkingHoursTimeZone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WorkingHoursTimeZone parameter specifies the time zone that's used by the WorkingHoursStartTime and WorkingHoursEndTime parameters. A valid value for this parameter is a supported time zone key name (for example, "Pacific Standard Time"). @@ -1236,7 +1338,6 @@ If the value contains spaces, enclose the value in quotation marks ("). The defa Type: ExTimeZoneValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1246,6 +1347,9 @@ Accept wildcard characters: False ``` ### -WorkspaceUserEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill WorkspaceUserEnabled Description }} @@ -1254,7 +1358,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarFolder.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarFolder.md index 7a30ee7341..dd3821709f 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxcalendarfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxCalendarFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxcalendarfolder +schema: 2.0.0 +title: Set-MailboxCalendarFolder --- # Set-MailboxCalendarFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailboxCalendarFolder cmdlet to configure calendar publishing or sharing settings on a mailbox for the visibility of calendar information to external users. To add or modify the permissions so internal users can access the calendar, use the Add-MailboxFolderPermission or Set-MailboxFolderPermission cmdlets. @@ -45,7 +46,7 @@ The Set-MailboxCalendarFolder cmdlet configures calendar publishing information. - Level of detail to publish for the calendar - Whether the published URL of the calendar is enabled for search on the web -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,6 +67,9 @@ This example enables the calendar in Kai's mailbox to be searchable on the web. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the calendar folder that you want to modify. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -87,7 +91,6 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Cal Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -106,7 +112,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -DetailLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DetailLevel parameter specifies the level of calendar detail that's published and available to anonymous users. Valid values are: - AvailabilityOnly (default) @@ -128,7 +136,6 @@ This parameter is meaningful only when the PublishEnabled parameter value is $tr Type: DetailLevelEnumType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -146,7 +156,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +165,16 @@ Accept wildcard characters: False ``` ### -PublishDateRangeFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublishDateRangeFrom parameter specifies the start date of calendar information to publish (past information). Valid values are: - OneDay - ThreeDays - OneWeek - OneMonth -- ThreeMonths (This is the default value) +- ThreeMonths (default value) - SixMonths - OneYear @@ -172,7 +184,6 @@ This parameter is meaningful only when the PublishEnabled parameter value is $tr Type: DateRangeEnumType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,13 +193,16 @@ Accept wildcard characters: False ``` ### -PublishDateRangeTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublishDateRangeTo parameter specifies the end date of calendar information to publish (future information). Valid values are: - OneDay - ThreeDays - OneWeek - OneMonth -- ThreeMonths (This is the default value) +- ThreeMonths (default value) - SixMonths - OneYear @@ -198,7 +212,6 @@ This parameter is meaningful only when the PublishEnabled parameter value is $tr Type: DateRangeEnumType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,16 +221,18 @@ Accept wildcard characters: False ``` ### -PublishEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublishEnabled parameter specifies whether to publish the specified calendar information. Valid values are: - $true: The calendar information is published. -- $false: The calendar information is not published. This is the default value. +- $false: The calendar information is not published. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -227,13 +242,15 @@ Accept wildcard characters: False ``` ### -ResetUrl -The ResetUrl switch replaces the existing non-public URL with a new URL for a calendar that has been published without being publicly searchable. You don't need to specify a value with this switch. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The ResetUrl switch replaces the existing non-public URL with a new URL for a calendar that is published without being publicly searchable. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -243,10 +260,13 @@ Accept wildcard characters: False ``` ### -SearchableUrlEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SearchableUrlEnabled parameter specifies whether the published calendar URL is discoverable on the web. - $true: The published calendar URL is discoverable on the web. -- $false: The published calendar URL is not discoverable on the web. This is the default value. +- $false: The published calendar URL is not discoverable on the web. This value is the default. This parameter is meaningful only when the PublishEnabled parameter value is $true. @@ -254,7 +274,6 @@ This parameter is meaningful only when the PublishEnabled parameter value is $tr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -264,13 +283,15 @@ Accept wildcard characters: False ``` ### -SetAsSharingSource + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SetAsSharingSource switch specifies whether to set the calendar folder as a sharing source. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -SharedCalendarSyncStartDate + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. **Note**: This parameter is supported only for shared calendars that have been upgraded as described in [Calendar sharing in Microsoft 365](https://support.microsoft.com/office/365-b576ecc3-0945-4d75-85f1-5efafb8a37b4), and is not applicable to any other type of calendar or mailbox folder. @@ -302,7 +326,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -312,6 +335,9 @@ Accept wildcard characters: False ``` ### -UseHttps + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UseHttps switch specifies whether to use HTTPS for the published URL of the calendar folder. You don't need to specify a value with this switch. This switch is meaningful only when the PublishEnabled parameter value is $true. @@ -320,7 +346,6 @@ This switch is meaningful only when the PublishEnabled parameter value is $true. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -330,13 +355,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabase.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-MailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabase.md index bf3cb3151f..2512649f93 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxdatabase -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxDatabase -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxdatabase +schema: 2.0.0 +title: Set-MailboxDatabase --- # Set-MailboxDatabase @@ -62,7 +63,7 @@ Set-MailboxDatabase [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,11 +81,14 @@ Set-MailboxDatabase -RpcClientAccessServer Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox database that you want to modify. You can use any value that uniquely identifies the database. For example: - Name @@ -95,7 +99,6 @@ The Identity parameter specifies the mailbox database that you want to modify. Y Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -105,16 +108,18 @@ Accept wildcard characters: False ``` ### -AllowFileRestore + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AllowFileRestore parameter specifies whether to allow a database to be restored from a backup. Valid values are: - $true: You can replace an existing database with a newly-created database. You can mount a database that doesn't match the database entry in Active Directory. -- $false: You can't replace an existing database with a newly-created database. You can't mount a database that doesn't match the database entry in Active Directory. This is the default value. +- $false: You can't replace an existing database with a newly-created database. You can't mount a database that doesn't match the database entry in Active Directory. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,16 +129,18 @@ Accept wildcard characters: False ``` ### -AutoDagExcludeFromMonitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDagExcludedFromMonitoring parameter specifies whether to exclude the mailbox database from the ServerOneCopyMonitor, which alerts an administrator when a replicated database has only one healthy copy available. Valid values are: - $true: No alert is issued when there's only one healthy copy of the replicated database. -- $false: An alert is issued when there's only one healthy copy of the replicated database. This is the default value. +- $false: An alert is issued when there's only one healthy copy of the replicated database. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,13 +150,15 @@ Accept wildcard characters: False ``` ### -AutoDatabaseMountDial + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: AutoDatabaseMountDial Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,16 +168,18 @@ Accept wildcard characters: False ``` ### -BackgroundDatabaseMaintenance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BackgroundDatabaseMaintenance parameter specifies whether the Extensible Storage Engine (ESE) performs database maintenance. Valid values are: -- $true: The mailbox database reads the object during database mount and initializes the database to perform background maintenance. This is the default value. +- $true: The mailbox database reads the object during database mount and initializes the database to perform background maintenance. This value is the default. - $false: The mailbox database reads the object during database mount and initializes the database without the option to perform background maintenance. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,6 +189,9 @@ Accept wildcard characters: False ``` ### -CalendarLoggingQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarLoggingQuota parameter specifies the maximum size of the log in the Recoverable Items folder of the mailbox that stores changes to calendar items. When the log exceeds this size, calendar logging is disabled until messaging records management (MRM) removes older calendar logs to free up more space. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 6 gigabytes (6442450944 bytes). @@ -190,7 +204,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be less than or equal to the value of the RecoverableItemsQuota parameter. @@ -200,7 +214,6 @@ This setting applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,10 +223,13 @@ Accept wildcard characters: False ``` ### -CircularLoggingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CircularLoggingEnabled parameter specifies whether circular logging is enabled for the database. Valid values are: - $true: Circular logging is enabled. -- $false: Circular logging is disabled. This is the default value. +- $false: Circular logging is disabled. This value is the default. For more information about circular logging, see [Exchange Native Data Protection](https://learn.microsoft.com/exchange/backup-restore-and-disaster-recovery-exchange-2013-help#exchange-native-data-protection). @@ -221,7 +237,6 @@ For more information about circular logging, see [Exchange Native Data Protectio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -240,7 +258,6 @@ 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 Required: False Position: Named @@ -250,13 +267,15 @@ Accept wildcard characters: False ``` ### -DatabaseGroup + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -266,6 +285,9 @@ Accept wildcard characters: False ``` ### -DataMoveReplicationConstraint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DataMoveReplicationConstraint parameter specifies the throttling behavior for high availability mailbox moves. Valid values are: - None: Moves shouldn't be throttled to ensure high availability. Use this setting if the database isn't part of a database availability group (DAG). @@ -274,7 +296,7 @@ The DataMoveReplicationConstraint parameter specifies the throttling behavior fo - CINoReplication (Exchange 2013 or later): Moves shouldn't be throttled to ensure high availability, but the content indexing service must be up to date. - CISecondCopy (Exchange 2013 or later): At least one passive mailbox database copy must have the most recent changes synchronized, and the content indexing service must be up to date. Use this setting to indicate that the database is replicated to one or more mailbox database copies. - CISecondDatacenter (Exchange 2013 or later): At least one passive mailbox database copy in another Active Directory site must have the most recent changes replicated, and the content indexing service must be up to date. Use this setting to indicate that the database is replicated to database copies in multiple Active Directory sites. -- SecondCopy: At least one passive mailbox database copy must have the most recent changes synchronized. This is the default value. Use this setting to indicate that the database is replicated to one or more mailbox database copies. +- SecondCopy: At least one passive mailbox database copy must have the most recent changes synchronized. This value is the default. Use this setting to indicate that the database is replicated to one or more mailbox database copies. - SecondDatacenter: At least one passive mailbox database copy in another Active Directory site must have the most recent changes replicated. Use this setting to indicate that the database is replicated to database copies in multiple Active Directory sites. Any value other than None enables the Microsoft Exchange Mailbox Replication service to coordinate with Active Manager. For more information, see [Active Manager](https://learn.microsoft.com/Exchange/high-availability/database-availability-groups/active-manager). @@ -283,7 +305,6 @@ Any value other than None enables the Microsoft Exchange Mailbox Replication ser Type: DataMoveReplicationConstraintParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +314,9 @@ Accept wildcard characters: False ``` ### -DeletedItemRetention + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeletedItemRetention parameter specifies the length of time to keep deleted items in the Recoverable Items\\Deletions folder in mailboxes. Items are moved to this folder when the user deletes items from the Deleted Items folder, empties the Deleted Items folder, or deletes items by using Shift+Delete. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -307,7 +331,6 @@ For more information, see [Recoverable Items folder in Exchange Server](https:// Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,13 +340,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -333,6 +358,9 @@ Accept wildcard characters: False ``` ### -EventHistoryRetentionPeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EventHistoryRetentionPeriod parameter specifies the length of time to keep event data. This event data is stored in the event history table in the Exchange store. It includes information about changes to various objects in the mailbox database. You can use this parameter to prevent the event history table from becoming too large and using too much disk space. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -343,7 +371,6 @@ Valid values are 00:00:01 to 30.00:00:00. The default value is 7.00:00:00 (7 day Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -353,18 +380,20 @@ Accept wildcard characters: False ``` ### -IndexEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange 2016 or earlier. The IndexEnabled parameter specifies whether Exchange Search indexes the mailbox database. Valid values are: -- $true: Exchange Search indexes the mailbox database. This is the default value. +- $true: Exchange Search indexes the mailbox database. This value is the default. - $false: Exchange Search doesn't index the mailbox database. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -374,13 +403,15 @@ Accept wildcard characters: False ``` ### -IsExcludedFromInitialProvisioning + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -390,10 +421,13 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsExcludedFromProvisioning parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases. Valid values are: - $true: The database is excluded from new or move mailbox operations when you don't specify the target mailbox database. -- $false: The database can be used in new or move mailbox operations when you don't specify the target mailbox database. This is the default value. +- $false: The database can be used in new or move mailbox operations when you don't specify the target mailbox database. This value is the default. The value is automatically set to $true when you set the IsExcludedFromProvisioningDueToLogicalCorruption parameter to $true, and isn't changed back to $false when you set the IsExcludedFromProvisioningDueToLogicalCorruption parameter back to $false. In the case of database corruption, you should set the IsExcludedFromProvisioning parameter back to $false only after you fix the corruption issue or recreate the database. @@ -401,7 +435,6 @@ The value is automatically set to $true when you set the IsExcludedFromProvision Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -411,14 +444,17 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioningByOperator + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IIsExcludedFromProvisioningByOperator parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases. Valid values are: - $true: Indicates that you manually excluded the database. The database is excluded from new or move mailbox operations when you don't specify the target mailbox database. -- $false: The database can be used in new or move mailbox operations when you don't specify the target mailbox database. This is the default value. +- $false: The database can be used in new or move mailbox operations when you don't specify the target mailbox database. This value is the default. -Note that setting this parameter to the value $true has these additional effects on the database: +Setting this parameter to the value $true has these additional effects on the database: - The IsExcludedFromProvisioningReason parameter requires a value if it doesn't already have one. - The unmodifiable IsExcludedFromProvisioningBy property is populated with your user account. @@ -427,7 +463,6 @@ Note that setting this parameter to the value $true has these additional effects Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -437,14 +472,17 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioningDueToLogicalCorruption + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsExcludedFromProvisioningDueToLogicalCorruption parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases. Valid values are: - $true: Indicates that you excluded the database due to database corruption. The database is excluded from new or move mailbox operations when you don't specify the target mailbox database. -- $false: This is the default value. The database can be used in new or move mailbox operations when you don't specify the target mailbox database. You should manually configure this value only after the database corruption is fixed, or after the database is recreated. +- $false: This value is the default. The database can be used in new or move mailbox operations when you don't specify the target mailbox database. You should manually configure this value only after the database corruption is fixed, or after the database is recreated. -Note that setting this parameter to the value $true has these additional effects on the database: +Setting this parameter to the value $true has these additional effects on the database: - The IsExcludedFromProvisioningReason parameter requires a value if it doesn't already have one. - The unmodifiable IsExcludedFromProvisioningBy property is populated with your user account. @@ -454,7 +492,6 @@ Note that setting this parameter to the value $true has these additional effects Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -464,6 +501,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioningReason + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsExcludedFromProvisioningReason parameter specifies the reason why you excluded the mailbox database from the mailbox provisioning load balancer. If the value contains spaces, enclose the value in quotation marks ("). The value must contain at least 10 characters. This parameter requires a value when you set any of the following parameters to $true: @@ -476,7 +516,6 @@ This parameter requires a value when you set any of the following parameters to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -486,6 +525,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -496,7 +538,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The IssueWarningQuota value must be less than or equal to the ProhibitSendReceiveQuota value. @@ -506,7 +548,6 @@ This setting applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -516,12 +557,15 @@ Accept wildcard characters: False ``` ### -IsSuspendedFromProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsSuspendedFromProvisioning parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases. Valid values are: - $true: Indicates that you don't want the exclusion to be permanent. The database is excluded from new or move mailbox operations when you don't specify the target mailbox database. -- $false: The database can be used in new or move mailbox operations when you don't specify the target mailbox database. This is the default value. +- $false: The database can be used in new or move mailbox operations when you don't specify the target mailbox database. This value is the default. -Note that setting this parameter to the value $true has these additional effects on the database: +Setting this parameter to the value $true has these additional effects on the database: - The IsExcludedFromProvisioningReason parameter requires a value if it doesn't already have one. - The unmodifiable IsExcludedFromProvisioningBy property is populated with your user account. @@ -530,7 +574,6 @@ Note that setting this parameter to the value $true has these additional effects Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -540,6 +583,9 @@ Accept wildcard characters: False ``` ### -JournalRecipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The JournalRecipient parameter specifies the journal recipient to use for per-database journaling for all mailboxes on the database. You can use any value that uniquely identifies the recipient. For example: - Name @@ -553,7 +599,6 @@ The JournalRecipient parameter specifies the journal recipient to use for per-da Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -563,6 +608,9 @@ Accept wildcard characters: False ``` ### -MailboxRetention + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxRetention parameter specifies the length of time to keep deleted mailboxes before they are permanently deleted or purged. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -573,7 +621,6 @@ Valid values are 00:00:00 to 24855.03:14:07. The default value is 30.00:00:00 (3 Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -583,9 +630,12 @@ Accept wildcard characters: False ``` ### -MaintenanceSchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. -The MaintenanceSchedule parameter specifies when maintenance will be performed on the mailbox database. Maintenance includes online defragmentation, removing items that have passed their retention period, removing unused indexes and other cleanup tasks. +The MaintenanceSchedule parameter specifies when maintenance is performed on the mailbox database. Maintenance includes online defragmentation, removing items that have passed their retention period, removing unused indexes and other cleanup tasks. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. @@ -611,7 +661,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -621,6 +670,9 @@ Accept wildcard characters: False ``` ### -MetaCacheDatabaseMaxCapacityInBytes + +> Applicable: Exchange Server 2019, Exchange Server SE + The MetaCacheDatabaseMaxCapacityInBytes parameter specifies the size of the metacache database in bytes. To convert gigabytes to bytes, multiply the value by 1024^3. For terabytes to bytes, multiply by 1024^4. The default value is blank ($null). @@ -629,7 +681,6 @@ The default value is blank ($null). Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -639,16 +690,18 @@ Accept wildcard characters: False ``` ### -MountAtStartup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MountAtStartup parameter specifies whether to mount the mailbox database when the Microsoft Exchange Information Store service starts. Valid values are: -- $true: The database is mounted when the service starts. This is the default value. +- $true: The database is mounted when the service starts. This value is the default. - $false: The database isn't mounted when the service starts. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -658,13 +711,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name of the mailbox database. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -674,6 +729,9 @@ Accept wildcard characters: False ``` ### -OfflineAddressBook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OfflineAddressBook parameter specifies the offline address book that's associated with the mailbox database. You can use any value that uniquely identifies the offline address book. For example: - Name @@ -686,7 +744,6 @@ By default, this setting is blank ($null). Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -696,6 +753,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProhibitSendQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send new messages, and the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -706,7 +766,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The ProhibitSendQuota value must be less than or equal to the ProhibitSendReceiveQuota value. @@ -716,7 +776,6 @@ This settings applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -726,6 +785,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -736,7 +798,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. @@ -746,7 +808,6 @@ This setting applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -756,6 +817,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The PublicFolderDatabase parameter specifies the associated public folder database for this mailbox database. You can use any value that uniquely identifies the public folder database. For example: @@ -768,7 +832,6 @@ The PublicFolderDatabase parameter specifies the associated public folder databa Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -778,6 +841,9 @@ Accept wildcard characters: False ``` ### -QuotaNotificationSchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The QuotaNotificationSchedule parameter specifies when quota messages are sent to mailboxes that have reached one of the quota values. @@ -806,7 +872,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -816,6 +881,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder of the mailbox. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 30 gigabytes (32212254720 bytes). @@ -828,7 +896,7 @@ When you enter a number, you can qualify it with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. @@ -838,7 +906,6 @@ This settings applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -848,6 +915,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for the mailbox. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 20 gigabytes (21474836480 bytes). @@ -860,7 +930,7 @@ When you enter a number, you can qualify it with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value. @@ -870,7 +940,6 @@ This settings applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -880,16 +949,19 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsUntilBackup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RetainDeletedItemsUntilBackup parameter specifies whether to keep items in the Recoverable Items\\Deletions folder of the mailbox until the next database backup occurs. Valid values are: - $true: Deleted items in mailboxes are kept until the next mailbox database backup. This value could effectively override the deleted DeletedItemRetention and RecoverableItemsQuota parameter values. -- $false: This is the default value. Retention of deleted items in mailboxes is controlled by the DeletedItemRetention and RecoverableItemsQuota parameters. +- $false: This value is the default. Retention of deleted items in mailboxes is controlled by the DeletedItemRetention and RecoverableItemsQuota parameters. This settings applies to all mailboxes in the database that don't have their own RetainDeletedItemsUntilBackup value configured. For more information, see [Recoverable Items folder in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). -**Note**: If you set the value of this parameter to $true when the value of the UseDatabaseRetentionDefaults parameter on a specific mailbox is also $true (the default value), the value of the UseDatabaseRetentionDefaults property in the output of the Get-Mailbox cmdlet will erroneously appear as False. To verify the value of the UseDatabaseRetentionDefaults property on the mailbox, do the following steps in the Exchange Management Shell: +**Note**: If you set the value of this parameter to $true when the value of the UseDatabaseRetentionDefaults parameter on a specific mailbox is also $true (the default value), the value of the UseDatabaseRetentionDefaults property in the output of the Get-Mailbox cmdlet erroneously appears as False. To verify the value of the UseDatabaseRetentionDefaults property on the mailbox, do the following steps in the Exchange Management Shell: - Run the following command: `Import-Module ActiveDirectory`. - Replace \ with the Alias value of the mailbox, and run the following command: `Get-ADUser -Properties mDBUseDefaults | Format-List mDBUseDefaults`. @@ -898,7 +970,6 @@ For more information, see [Recoverable Items folder in Exchange Server](https:// Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -908,17 +979,19 @@ Accept wildcard characters: False ``` ### -RpcClientAccessServer + +> Applicable: Exchange Server 2010 + This parameter is functional only in Exchange Server 2010. The RpcClientAccessServer parameter specifies the Client Access server or Client Access server array through which RPC clients (for example, Microsoft Office Outlook 2007 clients) access their mailboxes. This feature is supported for all versions of Outlook. -When connecting with Outlook 2003 clients, RPC encryption is disabled by default. Unless RPC encryption is enabled on Outlook 2003 or disabled on the server, Outlook 2003 clients won't be able to connect. For more information, see [Understanding RPC Client Access](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/ee332317(v=exchg.141)). +When connecting with Outlook 2003 clients, RPC encryption is disabled by default. Unless RPC encryption is enabled on Outlook 2003 or disabled on the server, Outlook 2003 clients can't connect. For more information, see [Understanding RPC Client Access](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/ee332317(v=exchg.141)). ```yaml Type: ClientAccessServerOrArrayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -928,13 +1001,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabaseCopy.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabaseCopy.md index 7a63396766..e85cf0fabf 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxdatabasecopy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxDatabaseCopy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxdatabasecopy +schema: 2.0.0 +title: Set-MailboxDatabaseCopy --- # Set-MailboxDatabaseCopy @@ -36,7 +37,7 @@ Set-MailboxDatabaseCopy [-Identity] ## DESCRIPTION With this cmdlet, you can configure the replay lag time, truncation lag time, and activation preference value for a mailbox database copy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +58,15 @@ This example configures an activation preference of 3 for the copy of the databa ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the database whose copy is being modified. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -ActivationPreference + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActivationPreference parameter value is used as part of Active Manager's best copy selection process and to redistribute active mailbox databases throughout the database availability group (DAG) when using the RedistributeActiveDatabases.ps1 script. The value for the ActivationPreference parameter is a number equal to or greater than 1, where 1 is at the top of the preference order. The position number can't be larger than the number of database copies of the mailbox database. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -98,7 +106,6 @@ 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 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -ReplayLagTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplayLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service should wait before replaying log files that have been copied to the passive database copy. Setting this parameter to a value greater than 0 creates a lagged database copy. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -136,7 +148,6 @@ For example, to specify a 14-day replay lag period, enter 14.00:00:00. The defau Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,7 +157,10 @@ Accept wildcard characters: False ``` ### -TruncationLagTime -The TruncationLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service should wait before truncating log files that have replayed into the passive copy of the database. The time period begins after the log has been successfully replayed into the copy of the database. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The TruncationLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service should wait before truncating log files that have replayed into the passive copy of the database. The time period begins after the log is successfully replayed into the copy of the database. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -156,7 +170,6 @@ The default value is 00.00:00:00, which specifies that there's no truncation lag Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,13 +197,15 @@ Accept wildcard characters: False ``` ### -DatabaseCopyAutoActivationPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: DatabaseCopyAutoActivationPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,19 +215,21 @@ Accept wildcard characters: False ``` ### -ReplayLagMaxDelay + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplayLagMaxDelay parameter specifies the maximum delay for lagged database copy play down (also known as deferred lagged copy play down). If the disk read IO latency is greater than 25 ms, lagged copy play down is delayed up to the value of this parameter. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. The default value is 24:00:00 (24 hours). To disable deferred lagged copy play down, specify the value ([TimeSpan]::Zero). -Note that when the disk is running out of space, the value of this parameter is ignored, and lagged copy play down occurs without delay. +When the disk is running out of space, the value of this parameter is ignored, and lagged copy play down occurs without delay. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxExportRequest.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxExportRequest.md index 400403f687..fe5b9cea85 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxexportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxExportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxexportrequest +schema: 2.0.0 +title: Set-MailboxExportRequest --- # Set-MailboxExportRequest @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-MailboxExportRequest cmdlet to change export request options after the request has been created. You can use the Set-MailboxExportRequest cmdlet to recover from failed export requests. +Use the Set-MailboxExportRequest cmdlet to change export request options after the request is created. You can use the Set-MailboxExportRequest cmdlet to recover from failed export requests. This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -56,7 +57,7 @@ Set-MailboxExportRequest [-Identity] ## DESCRIPTION You can pipeline the Set-MailboxExportRequest cmdlet from the Get-MailboxExportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,13 +71,15 @@ This example changes the second export request Ayla\\MailboxExport1 to accept up ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). If you specify a name for the export request, use the following syntax: `Alias\Name`. ```yaml Type: MailboxExportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -96,7 +102,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -116,7 +124,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,13 +133,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BatchName parameter specifies the name of the batch. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -151,7 +163,6 @@ 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 Required: False Position: Named @@ -161,13 +172,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit -The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default value is 30 days. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default value is 30 days. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,13 +208,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,6 +226,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -216,7 +236,7 @@ For more information about maximum message size values, see the following topics - Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) - Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) -Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. +Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request fails if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. @@ -224,7 +244,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -234,12 +253,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: - Lowest - Lower - Low -- Normal: This is the default value. +- Normal: This value is the default. - High - Higher - Highest @@ -249,7 +271,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,6 +280,9 @@ Accept wildcard characters: False ``` ### -RehomeRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RehomeRequest switch tells the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox that's being exported. You don't need to specify a value with this switch. This switch is used primarily for debugging purposes. @@ -267,7 +291,6 @@ This switch is used primarily for debugging purposes. Type: SwitchParameter Parameter Sets: Rehome Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -277,13 +300,15 @@ Accept wildcard characters: False ``` ### -RemoteCredential + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: PSCredential Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +318,15 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,13 +336,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipMerging parameter specifies steps in the export that should be skipped. This parameter is used primarily for debugging purposes. ```yaml Type: SkippableMergeComponent[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,6 +354,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -338,7 +370,6 @@ 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 Required: False Position: Named @@ -348,13 +379,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxFolderPermission.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxFolderPermission.md index 52df63f5f3..72c6e76489 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxFolderPermission.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxFolderPermission -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxfolderpermission +schema: 2.0.0 +title: Set-MailboxFolderPermission --- # Set-MailboxFolderPermission ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailboxFolderPermission cmdlet to modify folder-level permissions for users in mailboxes. This cmdlet differs from the Add-MailboxFolderPermission cmdlet in that it modifies existing permission entries. To configure calendar publishing or sharing settings for a mailbox so calendar information is visible to external users, use the Set-MailboxCalendarFolder cmdlet. @@ -31,9 +32,9 @@ Set-MailboxFolderPermission [-Identity] -AccessRights ``` ## DESCRIPTION -In Exchange Online PowerShell, if you don't use the SendNotificationToUser or SharingPermissionFlags parameters, there are no changes to the functionality of the cmdlet. For example, if the user is an existing delegate, and you change their permissions to Editor without using the SendNotificationToUser or SharingPermissionFlags parameters, the user remains a delegate. But, if you use the SendNotificationToUser parameter ($true or $false), the SharingPermissionFlags parameter has the default value None, which can affect delegate access for existing users. For example, you change an existing delegate's permission to Editor, and you use SendNotificationToUser with the value $true. The user will no longer be a delegate and will only have Editor permissions to the folder. +In Exchange Online PowerShell, if you don't use the SendNotificationToUser or SharingPermissionFlags parameters, there are no changes to the functionality of the cmdlet. For example, if the user is an existing delegate, and you change their permissions to Editor without using the SendNotificationToUser or SharingPermissionFlags parameters, the user remains a delegate. But, if you use the SendNotificationToUser parameter ($true or $false), the SharingPermissionFlags parameter has the default value None, which can affect delegate access for existing users. For example, you change an existing delegate's permission to Editor, and you use SendNotificationToUser with the value $true. The user is no longer a delegate and has only Editor permissions to the folder. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,6 +83,9 @@ In Exchange Online, this example changes an existing user's permissions to Edito ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the target mailbox and folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -103,7 +107,6 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Inb Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AccessRights parameter specifies the permissions that you want to modify for the user on the mailbox folder. The values that you specify replace the existing permissions for the user on the folder. You can specify individual folder permissions or roles, which are combinations of permissions. You can specify multiple permissions and roles separated by commas. @@ -153,7 +159,6 @@ When the Editor role is applied to calendar folders, delegates can accept or dec Type: MailboxFolderAccessRight[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -163,6 +168,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. For the best results, we recommend using the following values: @@ -183,7 +191,6 @@ Otherwise, you can use any value that uniquely identifies the user or group. For Type: MailboxFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -193,6 +200,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -202,7 +212,6 @@ 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 Required: False Position: Named @@ -212,6 +221,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -220,7 +232,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,12 +241,15 @@ Accept wildcard characters: False ``` ### -SendNotificationToUser + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The SendNotificationToUser parameter specifies whether to send a sharing invitation to the user when you modify their calendar permissions. The message will be a normal calendar sharing invitation that can be accepted by the recipient. Valid values are: +The SendNotificationToUser parameter specifies whether to send a sharing invitation to the user when you modify their calendar permissions. The message is a normal calendar sharing invitation that can be accepted by the recipient. Valid values are: - $true: A sharing invitation is sent. -- $false: No sharing invitation is sent. This is the default value. +- $false: No sharing invitation is sent. This value is the default. This parameter only applies to calendar folders and can only be used with the following AccessRights parameter values: @@ -248,7 +262,6 @@ This parameter only applies to calendar folders and can only be used with the fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -258,12 +271,15 @@ Accept wildcard characters: False ``` ### -SharingPermissionFlags + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SharingPermissionFlags parameter assigns calendar delegate permissions. This parameter only applies to calendar folders and can only be used when the AccessRights parameter value is Editor. Valid values are: -- None: Removes delegate permissions and updates the meeting message rule so the user stops receiving meeting invites and responses for the mailbox. This is the default value when you use the SendNotificationToUser parameter without specifying a value for the SharingPermissionFlags parameter. -- Delegate: The user is made a calendar delegate, which includes receiving meeting invites and responses. If there are no other delegates, this value will create the meeting message rule. If there are existing delegates, the user is added to the meeting message rule without changing how delegate messages are sent. +- None: Removes delegate permissions and updates the meeting message rule so the user stops receiving meeting invites and responses for the mailbox. This value is the default when you use the SendNotificationToUser parameter without specifying a value for the SharingPermissionFlags parameter. +- Delegate: The user is made a calendar delegate, which includes receiving meeting invites and responses. If there are no other delegates, this value creates the meeting message rule. If there are existing delegates, the user is added to the meeting message rule without changing how delegate messages are sent. - CanViewPrivateItems: The user can access private items on the calendar. You must use this value with the Delegate value. You can specify multiple values separated by commas. @@ -272,7 +288,6 @@ You can specify multiple values separated by commas. Type: MailboxFolderPermissionFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -282,13 +297,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -314,10 +331,10 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderpermission) -[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxfolderpermission) -[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxIRMAccess.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxIRMAccess.md index aab760df38..f4f0e60e87 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxIRMAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxirmaccess applicable: Exchange Online -title: Set-MailboxIRMAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxirmaccess +schema: 2.0.0 +title: Set-MailboxIRMAccess --- # Set-MailboxIRMAccess @@ -28,7 +29,7 @@ Set-MailboxIRMAccess -AccessLevel [-Identity] [!NOTE] > This cmdlet works only for delegates who already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example prevents delegate Chris from reading IRM-protected messages in Lyne ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AccessLevel + +> Applicable: Exchange Online + The AccessLevel parameter specifies what delegates can do to IRM-protected messages in the mailbox that's specified by the Identity parameter. The only value for this parameter is Block, which means you can only use this cmdlet to block delegate access to IRM-protected messages in the mailbox. @@ -80,7 +86,6 @@ Type: IRMAccessLevel Parameter Sets: (All) Aliases: Accepted values: Block -Applicable: Exchange Online Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + **Note**: Delegates that you specify with this parameter must already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). The User parameter specifies the delegate who is blocked from reading IRM-protected messages in the mailbox. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: @@ -109,7 +117,6 @@ The User parameter specifies the delegate who is blocked from reading IRM-protec Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxImportRequest.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxImportRequest.md index 07b606b809..fb66c38f42 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxImportRequest.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboximportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxImportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboximportrequest +schema: 2.0.0 +title: Set-MailboxImportRequest --- # Set-MailboxImportRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Set-MailboxImportRequest cmdlet to change import request options after the request has been created. You can use the Set-MailboxImportRequest cmdlet to recover from failed import requests. +Use the Set-MailboxImportRequest cmdlet to change import request options after the request is created. You can use the Set-MailboxImportRequest cmdlet to recover from failed import requests. This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -57,7 +58,7 @@ Set-MailboxImportRequest [-Identity] [-RehomeR ## DESCRIPTION You can pipeline the Set-MailboxImportRequest cmdlet from the Get-MailboxImportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,13 +79,15 @@ This example finds all import requests that have a status of Suspended, and then ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specified a name for the import request with the New-MailboxImportRequest cmdlet, use the following syntax: `Alias\Name`. ```yaml Type: MailboxImportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AzureSharedAccessSignatureToken + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -102,7 +108,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later or Exchange Online, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -122,7 +130,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -132,19 +139,21 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. In Exchange 2010, if you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,13 +163,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter specifies the name of the batch. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,13 +181,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +199,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -195,7 +211,6 @@ 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 Required: False Position: Named @@ -205,6 +220,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -213,7 +231,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -223,6 +240,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -231,7 +251,6 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +260,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -252,13 +274,12 @@ Valid input for this parameter is an integer or the value unlimited. The default If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -268,6 +289,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -275,7 +299,7 @@ The Priority parameter specifies the order in which the request should be proces - Lowest - Lower - Low -- Normal: This is the default value. +- Normal: This value is the default. - High - Higher - Highest @@ -285,7 +309,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -295,6 +318,9 @@ Accept wildcard characters: False ``` ### -RehomeRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RehomeRequest parameter tells the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox being imported. You don't need to specify a value with this switch. @@ -305,7 +331,6 @@ This switch is used primarily for debugging purposes. Type: SwitchParameter Parameter Sets: Rehome Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -315,6 +340,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -328,7 +356,6 @@ 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, Exchange Online Required: False Position: Named @@ -338,6 +365,9 @@ Accept wildcard characters: False ``` ### -SkipInitialConnectionValidation + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service This parameter is reserved for internal Microsoft use. @@ -346,7 +376,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -356,13 +385,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipMerging parameter specifies the steps in the import that should be skipped. This parameter is used primarily for debugging purposes. ```yaml Type: SkippableMergeComponent[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -372,6 +403,9 @@ Accept wildcard characters: False ``` ### -SkippedItemApprovalTime + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service This parameter is reserved for internal Microsoft use. @@ -380,7 +414,6 @@ This parameter is reserved for internal Microsoft use. Type: System.DateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -390,13 +423,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxJunkEmailConfiguration.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxJunkEmailConfiguration.md index 7392f0f33e..264b0132ca 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxJunkEmailConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxjunkemailconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxJunkEmailConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxjunkemailconfiguration +schema: 2.0.0 +title: Set-MailboxJunkEmailConfiguration --- # Set-MailboxJunkEmailConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailboxJunkEmailConfiguration cmdlet to configure the junk email settings on mailboxes. @@ -42,7 +43,7 @@ This cmdlet controls the following junk email settings on the mailbox: - Enable or disable the junk email rule: In on-premises Exchange, the junk email rule (a hidden Inbox rule named Junk E-mail Rule) controls the delivery of messages to the Junk Email folder or the Inbox based on the SCL Junk Email Folder threshold (for the organization or the mailbox) and the safelist collection on the mailbox. - In the cloud-based service, the junk email rule has no effect on mail flow. Exchange Online Protection delivers messages to the Junk Email folder based on the actions set in anti-spam policies. The junk email rule on the mailbox still controls what happens to messages after delivery based on the safelist collection of the mailbox. + In the cloud-based service, the junk email rule has no effect on mail flow. Messages are delivered to the Junk Email folder based on the actions set in anti-spam policies. The junk email rule on the mailbox still controls what happens to messages after delivery based on the safelist collection of the mailbox. Users can enable or disable the junk email rule in their own mailbox by using Outlook on the web. @@ -50,7 +51,7 @@ This cmdlet controls the following junk email settings on the mailbox: For more information, see [Configure Exchange antispam settings on mailboxes](https://learn.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-antispam-settings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,6 +82,9 @@ This example identifies mailboxes where contacts are treated as trusted senders ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -98,7 +102,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -BlockedSendersAndDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BlockedSendersAndDomains parameter specifies the Blocked Senders list, which is a list of sender email addresses and domains whose messages are automatically sent to the Junk Email folder. This parameter corresponds to the Outlook on the web setting: Move email from these senders or domains to my Junk Email folder. 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"`. @@ -118,7 +124,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -137,7 +145,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -147,16 +154,18 @@ Accept wildcard characters: False ``` ### -ContactsTrusted + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ContactsTrusted parameter specifies whether the contacts in the Contacts folder are treated as trusted senders. This parameter corresponds to the Outlook on the web setting: Trust email from my contacts. Valid values are: - $true: Messages from contacts in the Contacts folder that reach the mailbox are never delivered to the Junk Email folder, regardless of the content. -- $false: Messages from contacts in the Contacts folder aren't treated as trusted senders. The email address is a trusted sender only if it's defined in the Safe Senders list. This is the default value. +- $false: Messages from contacts in the Contacts folder aren't treated as trusted senders. The email address is a trusted sender only if it's defined in the Safe Senders list. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -174,7 +186,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,9 +195,12 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter enables or disables the junk email rule on the mailbox (a hidden Inbox rule named Junk E-mail Rule). Valid values are: -- $true: The junk email rule is enabled in the mailbox. This value corresponds to the Outlook on the web setting: Automatically filter junk email. This is the default value. +- $true: The junk email rule is enabled in the mailbox. This value corresponds to the Outlook on the web setting: Automatically filter junk email. This value is the default. In on-premises Exchange, the safelist collection of the mailbox (the Safe Senders list, Safe Recipients list, and Blocked Senders list), and the SCL Junk Email folder threshold (for the organization or the mailbox) delivers messages to the Inbox or the Junk Email folder. @@ -209,7 +223,6 @@ The state of the junk email rule on the mailbox doesn't affect the client-side j Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +232,9 @@ Accept wildcard characters: False ``` ### -FailOnError + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill FailOnError Description }} @@ -227,7 +243,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -237,6 +252,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -248,7 +266,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -258,6 +275,9 @@ Accept wildcard characters: False ``` ### -SenderScreeningEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SenderScreeningEnabled Description }} @@ -266,7 +286,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -276,16 +295,18 @@ Accept wildcard characters: False ``` ### -TrustedListsOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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: - $true: Only messages from email address or domain entries in the Safe Senders list and the Safe Recipients list are delivered to the Inbox. All other messages are automatically delivered to the Junk Email folder. -- $false: Messages from other senders, recipients, and domains aren't automatically treated as junk email, and are evaluated individually. This is the default value. +- $false: Messages from other senders, recipients, and domains aren't automatically treated as junk email, and are evaluated individually. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -295,13 +316,15 @@ Accept wildcard characters: False ``` ### -TrustedRecipientsAndDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -311,6 +334,9 @@ Accept wildcard characters: False ``` ### -TrustedSendersAndDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TrustedSendersAndDomains parameter specifies the Safe Senders list and Safe Recipients list, which are lists of email addresses and domains. Messages from these senders that reach the mailbox are never delivered to the Junk Email folder, regardless of the content. This parameter corresponds to the Outlook on the web setting: Don't move email from these senders or domains to my Junk Email folder. 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"`. @@ -329,7 +355,6 @@ To empty the list of email addresses and domains, use the value $null. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -339,13 +364,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxMessageConfiguration.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxMessageConfiguration.md index 047f4af452..22c5f6ec9a 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxMessageConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxmessageconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxMessageConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxmessageconfiguration +schema: 2.0.0 +title: Set-MailboxMessageConfiguration --- # Set-MailboxMessageConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailboxMessageConfiguration cmdlet to configure the Outlook on the web settings that are applied to specific mailboxes. @@ -93,7 +94,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. 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -114,6 +115,9 @@ This example sets the compose email message form to always show the Bcc field in ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -131,7 +135,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -141,6 +144,9 @@ Accept wildcard characters: False ``` ### -AfterMoveOrDeleteBehavior + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AfterMoveOrDeleteBehavior parameter specifies the behavior after moving or deleting an email item in Outlook on the web. You can use the following values: - OpenPreviousItem @@ -153,7 +159,6 @@ The default value is OpenNextItem. Type: AfterMoveOrDeleteBehavior Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -163,6 +168,9 @@ Accept wildcard characters: False ``` ### -AlwaysShowBcc + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlwaysShowBcc parameter shows or hides the blind carbon copy (Bcc) field when the user creates messages in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -171,7 +179,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -181,6 +188,9 @@ Accept wildcard characters: False ``` ### -AlwaysShowFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlwaysShowFrom parameter shows or hides the From field when the user creates messages in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -189,7 +199,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -199,6 +208,9 @@ Accept wildcard characters: False ``` ### -AutoAddSignature + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. The AutoAddSignature parameter specifies whether to automatically add signatures to new email messages created in Outlook on the web. Valid values are: @@ -212,7 +224,6 @@ The email signature specified by the SignatureText parameter is added to plain t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -222,6 +233,9 @@ Accept wildcard characters: False ``` ### -AutoAddSignatureOnMobile + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. The AutoAddSignatureOnMobile parameter automatically adds the signature specified by the SignatureTextOnMobile parameter to messages when the user creates messages in Outlook on the web for devices. @@ -232,7 +246,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -242,6 +255,9 @@ Accept wildcard characters: False ``` ### -AutoAddSignatureOnReply + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AutoAddSignature parameter specifies whether to automatically add signatures to reply email messages created in Outlook on the web. Valid values are: - $true: Email signatures are automatically added to reply messages. @@ -253,7 +269,6 @@ The email signature specified by the SignatureText parameter is added to plain t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -263,6 +278,9 @@ Accept wildcard characters: False ``` ### -CheckForForgottenAttachments + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CheckForForgottenAttachments parameter shows or hides the attachment warning prompt when the user creates messages in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $true. @@ -273,7 +291,6 @@ For example, the user creates a message that includes the text "Please see the a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -283,6 +300,9 @@ Accept wildcard characters: False ``` ### -CheckForReportJunkDialog + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill CheckForReportJunkDialog Description }} @@ -291,7 +311,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -301,6 +320,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -310,7 +332,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -320,6 +341,9 @@ Accept wildcard characters: False ``` ### -ConversationSortOrder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConversationSortOrder parameter specifies the sorting of messages in the reading pane in Conversation view for the user in Outlook on the web. You can use the following values: - Chronological @@ -336,7 +360,6 @@ The default value is ChronologicalNewestOnTop. Type: ConversationSortOrder Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -346,6 +369,9 @@ Accept wildcard characters: False ``` ### -DefaultFontColor + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultFontColor parameter specifies the default text color when the user creates messages in Outlook on the web. This parameter accepts a hexadecimal color code value in the format #xxxxxx. The default value is #000000. If the string value is unrecognized, the browser application uses a default font color to display the text. @@ -354,7 +380,6 @@ If the string value is unrecognized, the browser application uses a default font Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -364,6 +389,9 @@ Accept wildcard characters: False ``` ### -DefaultFontFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultFontFlags parameter specifies the default text effect when the user creates messages in Outlook on the web. You can use the following values: - Normal @@ -378,7 +406,6 @@ The default value is Normal. Type: FontFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -388,6 +415,9 @@ Accept wildcard characters: False ``` ### -DefaultFontName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultFontName parameter specifies the default font when the user creates messages in Outlook on the web. The default value is Calibri. If the font name value is unrecognized, the browser application uses a default font to display the text. @@ -396,7 +426,6 @@ The default value is Calibri. If the font name value is unrecognized, the browse Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -406,6 +435,9 @@ Accept wildcard characters: False ``` ### -DefaultFontSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultFontSize parameter specifies the default text size when the user creates messages in Outlook on the web. Valid input for this parameter is an integer between 1 and 7. The default value is 3, which corresponds to a 12 point font size. @@ -414,7 +446,6 @@ Valid input for this parameter is an integer between 1 and 7. The default value Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -424,13 +455,15 @@ Accept wildcard characters: False ``` ### -DefaultFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultFormat parameter specifies the default message format when the user creates messages in Outlook on the web. Accepted values are Html and PlainText. The default value is Html. ```yaml Type: MailFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -440,6 +473,9 @@ Accept wildcard characters: False ``` ### -DefaultSignature + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DefaultSignature Description }} @@ -448,7 +484,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -458,6 +493,9 @@ Accept wildcard characters: False ``` ### -DefaultSignatureOnReply + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DefaultSignatureOnReply Description }} @@ -466,7 +504,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -476,6 +513,9 @@ Accept wildcard characters: False ``` ### -DeleteSignatureName + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DeleteSignatureName Description }} @@ -484,7 +524,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -494,6 +533,9 @@ Accept wildcard characters: False ``` ### -DisplayDensityMode + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DisplayDensityMode Description }} @@ -502,7 +544,6 @@ This parameter is available only in the cloud-based service. Type: DisplayDensityMode Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -512,6 +553,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -520,7 +564,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -530,18 +573,20 @@ Accept wildcard characters: False ``` ### -EchoGroupMessageBackToSubscribedSender + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EchoGroupMessageBackToSubscribedSender parameter controls whether subscribed members of Microsoft 365 Groups receive copies of messages that they send to those Groups. Valid values are: - $true: If a subscribed member of a Microsoft 365 Group sends a message to that Group, they'll receive a copy of the message in their Inbox. -- $false: Subscribed members of a Microsoft 365 Group don't receive their own copies of messages that they send to the Group. This is the default value. +- $false: Subscribed members of a Microsoft 365 Group don't receive their own copies of messages that they send to the Group. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -551,18 +596,20 @@ Accept wildcard characters: False ``` ### -EmailComposeMode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The EmailComposeMode parameter specifies how the user creates messages in Outlook on the web. You can use the following values: -- Inline: New messages and replies are created in the preview pane. This is the default value. +- Inline: New messages and replies are created in the preview pane. This value is the default. - SeparateForm: New messages and replies are created in a new browser window. ```yaml Type: EmailComposeMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -572,6 +619,9 @@ Accept wildcard characters: False ``` ### -EmptyDeletedItemsOnLogoff + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EmptyDeletedItemsOnLogoff parameter specifies whether to delete items from the Deleted Items folder when the user logs out of Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -580,7 +630,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -590,6 +639,9 @@ Accept wildcard characters: False ``` ### -FavoritesBitFlags + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill FavoritesBitFlags Description }} @@ -598,7 +650,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -608,19 +659,21 @@ Accept wildcard characters: False ``` ### -GlobalReadingPanePosition + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in Exchange 2016 or later. It doesn't work in Exchange Online. The GlobalReadingPanePosition specifies the default location of the reading pane in Outlook on the web. Valid values are: - Off - Bottom -- Right (This is the default value) +- Right (default value) ```yaml Type: MailReadingPanePosition Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -630,6 +683,9 @@ Accept wildcard characters: False ``` ### -HideDeletedItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HideDeletedItems parameter shows or hides deleted messages in Conversation view for the user in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -638,7 +694,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -648,6 +703,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -659,7 +717,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -669,6 +726,9 @@ Accept wildcard characters: False ``` ### -IsDarkModeTheme + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IsDarkModeTheme Description }} @@ -677,7 +737,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -687,16 +746,18 @@ Accept wildcard characters: False ``` ### -IsFavoritesFolderTreeCollapsed + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsFavoritesFolderTreeCollapsed parameter specifies whether to collapse the Favorites folder tree by default in Outlook on the web. Valid values are: - $true: The Favorites folder tree is collapsed by default. -- $false: The Favorites folder tree isn't collapsed by default. This is the default value +- $false: The Favorites folder tree isn't collapsed by default. This value is the default ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -706,6 +767,9 @@ Accept wildcard characters: False ``` ### -IsFocusedInboxEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IsFocusedInboxEnabled Description }} @@ -714,7 +778,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -724,16 +787,18 @@ Accept wildcard characters: False ``` ### -IsMailRootFolderTreeCollapsed + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsMailRootFolderTreeCollapsed parameter specifies whether to collapse the Mail root folder tree by default in Outlook on the web. Valid values are: - $true: The Mail root folder tree is collapsed by default. -- $false: The Mail root folder tree isn't collapsed by default. This is the default value +- $false: The Mail root folder tree isn't collapsed by default. This value is the default ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -743,16 +808,18 @@ Accept wildcard characters: False ``` ### -IsReplyAllTheDefaultResponse + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsReplyAllTheDefaultResponse parameter specifies whether Reply All is the default response for messages in Outlook on the web. Valid values are: -- $true: Reply All is the default response option for messages in the reading pane. This is the default value. +- $true: Reply All is the default response option for messages in the reading pane. This value is the default. - $false: Reply All isn't the default response option for messages in the reading pane. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -762,9 +829,12 @@ Accept wildcard characters: False ``` ### -LinkPreviewEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LinkPreviewEnabled parameter specifies whether link preview of URLs in email messages is enabled for the user in Outlook on the web. Valid values are: -- $true: Link preview of URLs in email messages is enabled for the user. This is the default value. +- $true: Link preview of URLs in email messages is enabled for the user. This value is the default. - $false: Link preview of URLs in email messages is disabled for the user. This parameter depends on the value of the LinkPreviewEnabled parameter on the Set-OrganizationConfig cmdlet, which controls the link preview behavior in Outlook on the web for the entire organization. If link preview is disabled for the organization, users can't enable it for themselves. @@ -773,7 +843,6 @@ This parameter depends on the value of the LinkPreviewEnabled parameter on the S Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -783,16 +852,18 @@ Accept wildcard characters: False ``` ### -MailFolderPaneExpanded + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailFolderPaneExpanded parameter specifies whether the Mail folder pane is expanded by default in Outlook on the web. Valid values are: -- $true: The Mail folder pane is expanded by default. This is the default value. +- $true: The Mail folder pane is expanded by default. This value is the default. - $false: The Mail folder pane isn't expanded by default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -802,6 +873,9 @@ Accept wildcard characters: False ``` ### -MailSendUndoInterval + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MailSendUndoInterval Description }} @@ -810,7 +884,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -820,6 +893,9 @@ Accept wildcard characters: False ``` ### -ManuallyPickCertificate + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ManuallyPickCertificate Description }} @@ -828,7 +904,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -838,6 +913,9 @@ Accept wildcard characters: False ``` ### -NavigationBarWidth + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill NavigationBarWidth Description }} @@ -846,7 +924,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -856,9 +933,12 @@ Accept wildcard characters: False ``` ### -NavigationPaneViewOption + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NavigationPaneViewOption parameter specifies the default navigation pane view in Outlook on the web. Valid values are: -- Default: This is the default value +- Default: This value is the default - MailFolders - PeopleFolders - Groups @@ -868,7 +948,6 @@ The NavigationPaneViewOption parameter specifies the default navigation pane vie Type: NavigationPaneView Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -878,6 +957,9 @@ Accept wildcard characters: False ``` ### -NewEnabledPonts + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill NewEnabledPonts Description }} @@ -886,7 +968,6 @@ This parameter is available only in the cloud-based service. Type: PontType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -896,6 +977,9 @@ Accept wildcard characters: False ``` ### -NewItemNotification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NewItemNotification parameter specifies how to provide notification for the arrival of new items for the user in Outlook on the web. You can use the following values: - Sound @@ -911,7 +995,6 @@ The default value is All. Type: NewItemNotification Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -921,16 +1004,18 @@ Accept wildcard characters: False ``` ### -PreferAccessibleContent + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PreferAccessibleContent parameter specifies whether to prefer accessible content in Outlook on the web. Valid values are: - $true: Prefer accessible content. -- $false: Don't prefer accessible content. This is the default value. +- $false: Don't prefer accessible content. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -940,6 +1025,9 @@ Accept wildcard characters: False ``` ### -PreviewMarkAsReadBehavior + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PreviewMarkAsReadBehavior parameter specifies the options for marking an item as Read in the reading pane for the user in Outlook on the web. You can use the following values: - Delayed: This value uses the delay interval specified by the PreviewMarkAsReadDelaytime parameter. @@ -952,7 +1040,6 @@ The default value is OnSelectionChange. Type: PreviewMarkAsReadBehavior Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -962,6 +1049,9 @@ Accept wildcard characters: False ``` ### -PreviewMarkAsReadDelaytime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PreviewMarkAsReadDelaytime parameter specifies the time in seconds to wait before marking an item as Read for the user in Outlook on the web. Valid input for this parameter is an integer between 0 and 30. The default value is 5 seconds. @@ -972,7 +1062,6 @@ This parameter is meaningful only if you set the PreviewMarkAsReadBehavior param Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -982,6 +1071,9 @@ Accept wildcard characters: False ``` ### -ReadReceiptResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReadReceiptResponse parameter specifies how to respond to requests for read receipts for the user in Outlook on the web. You can use the following values: - DoNotAutomaticallySend @@ -994,7 +1086,6 @@ The default value is DoNotAutomaticallySend. Type: ReadReceiptResponse Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1004,6 +1095,9 @@ Accept wildcard characters: False ``` ### -ReportJunkSelected + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ReportJunkSelected Description }} @@ -1012,7 +1106,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1022,6 +1115,9 @@ Accept wildcard characters: False ``` ### -SendAddressDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SendAddressDefault parameter specifies the default From email address when the user has POP, IMAP, or Hotmail subscriptions configured on their mailbox. Users can override the default From address when they create an email message in Outlook on the web. @@ -1043,7 +1139,6 @@ You can find the available values for SendAddressDefault on a mailbox by running Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1053,6 +1148,9 @@ Accept wildcard characters: False ``` ### -ShowConversationAsTree + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowConversationAsTree parameter specifies how to sort messages in the list view in an expanded conversation for the user in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -1061,7 +1159,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1071,6 +1168,9 @@ Accept wildcard characters: False ``` ### -ShowInlinePreviews + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ShowInlinePreviews Description }} @@ -1079,7 +1179,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1089,6 +1188,9 @@ Accept wildcard characters: False ``` ### -ShowNotificationBar + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ShowNotificationBar Description }} @@ -1097,7 +1199,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1107,16 +1208,18 @@ Accept wildcard characters: False ``` ### -ShowPreviewTextInListView + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowPreviewTextInListView parameter specifies whether to show preview text for messages in list view in Outlook on the web. Valid values are: -- $true: Show preview text for messages in list view. This is the default value. +- $true: Show preview text for messages in list view. This value is the default. - $false: Don't show preview text for messages in list view. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1126,16 +1229,18 @@ Accept wildcard characters: False ``` ### -ShowReadingPaneOnFirstLoad + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowReadingPaneOnFirstLoad parameter specifies whether to show the reading pane when the user opens in Outlook on the web for the first time. Valid values are: - $true: Show the reading pane when the user opens Outlook on the web for the first time. -- $false: Don't show the reading pane when the user opens Outlook on the web for the first time. This is the default value. +- $false: Don't show the reading pane when the user opens Outlook on the web for the first time. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1145,16 +1250,18 @@ Accept wildcard characters: False ``` ### -ShowSenderOnTopInListView + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowSenderOnTopInListView parameter specifies whether to show the message sender on top in list view in Outlook on the web. Valid values are: -- $true: Show the message sender on top in list view. This is the default value. +- $true: Show the message sender on top in list view. This value is the default. - $false: Don't show the message sender on top in list view. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1164,16 +1271,18 @@ Accept wildcard characters: False ``` ### -ShowUpNext + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ShowUpNext parameter specifies whether the next upcoming event should be shown above the mail list view in Outlook on the web. Valid values are: -- $true: Show the next upcoming event above the mail list view. This is the default value. +- $true: Show the next upcoming event above the mail list view. This value is the default. - $false: Don't show the next upcoming event above the mail list view. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1183,6 +1292,9 @@ Accept wildcard characters: False ``` ### -SignatureHtml + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. The SignatureHtml parameter specifies the email signature that's available to the user in HTML-formatted messages in Outlook on the web. You can use plain text or text with HTML tags. However, any JavaScript code is removed. @@ -1193,7 +1305,6 @@ To automatically add this email signature to HTML-formatted messages created by Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1203,6 +1314,9 @@ Accept wildcard characters: False ``` ### -SignatureHtmlBody + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SignatureHtmlBody Description }} @@ -1211,7 +1325,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1221,6 +1334,9 @@ Accept wildcard characters: False ``` ### -SignatureName + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SignatureName Description }} @@ -1229,7 +1345,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1239,6 +1354,9 @@ Accept wildcard characters: False ``` ### -SignatureText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. The SignatureText parameter specifies the email signature that's available to the user in plain text messages in Outlook on the web. This parameter supports all Unicode characters. @@ -1249,7 +1367,6 @@ To automatically add the email signature to plain text messages created by the u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1259,6 +1376,9 @@ Accept wildcard characters: False ``` ### -SignatureTextOnMobile + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. The SignatureTextOnMobile parameter specifies the email signature that's available in messages created by the user in Outlook on the web for devices. This parameter supports all Unicode characters. @@ -1269,7 +1389,6 @@ To automatically add the email signature to messages created by the user in Outl Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1279,6 +1398,9 @@ Accept wildcard characters: False ``` ### -SigningCertificateId + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SigningCertificateId Description }} @@ -1287,7 +1409,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1297,6 +1418,9 @@ Accept wildcard characters: False ``` ### -SigningCertificateSubject + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SigningCertificateSubject Description }} @@ -1305,7 +1429,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1315,6 +1438,9 @@ Accept wildcard characters: False ``` ### -SmimeEncrypt + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SmimeEncrypt Description }} @@ -1323,7 +1449,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1333,6 +1458,9 @@ Accept wildcard characters: False ``` ### -SmimeSign + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SmimeSign Description }} @@ -1341,7 +1469,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1351,6 +1478,9 @@ Accept wildcard characters: False ``` ### -UseDefaultSignatureOnMobile + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UseDefaultSignatureOnMobile parameter specifies whether to add the default email signature to messages created by the user in Outlook on the web for devices. The user configures the default signature in Outlook. Valid input for this parameter is $true or $false. The default value is $false. @@ -1359,7 +1489,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1369,6 +1498,9 @@ Accept wildcard characters: False ``` ### -WebSuggestedRepliesEnabledForUser + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill WebSuggestedRepliesEnabledForUser Description }} @@ -1377,7 +1509,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1387,13 +1518,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxPlan.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxPlan.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-MailboxPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxPlan.md index 96b60c149b..746b24f47e 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxplan applicable: Exchange Online, Exchange Online Protection -title: Set-MailboxPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxplan +schema: 2.0.0 +title: Set-MailboxPlan --- # Set-MailboxPlan @@ -41,11 +42,11 @@ Set-MailboxPlan [-Identity] ## DESCRIPTION A mailbox plan is a template that automatically configures mailbox properties. Mailbox plans correspond to license types, and are applied when you license the user. The availability of a mailbox plan is determined by your selections when you enroll in the service and the age of your organization. -Modifying the settings in a mailbox plan doesn't affect existing mailboxes that were created using the mailbox plan. The only way to use a mailbox plan to modify the settings on an existing mailbox is to assign a different license to the user, which will apply the corresponding mailbox plan to the mailbox. +Modifying the settings in a mailbox plan doesn't affect existing mailboxes that were created using the mailbox plan. The only way to use a mailbox plan to modify the settings on an existing mailbox is to assign a different license to the user, which applies the corresponding mailbox plan to the mailbox. Each mailbox plan has a corresponding Client Access services (CAS) mailbox plan with the same name and display name value. You can use the Set-CasMailboxPlan cmdlet to enable or disable POP3, IMAP4 or Exchange ActiveSync (EAS) access to new or newly-enabled mailboxes, and you can specify the Outlook on the web (formerly known as Outlook Web App) mailbox policy for the mailboxes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example lowers the default mailbox quotas in the mailbox plan named Exchang ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox plan that you want to modify. You can use any value that uniquely identifies the mailbox plan. For example: - Name @@ -71,7 +75,6 @@ The Identity parameter specifies the mailbox plan that you want to modify. You c Type: MailboxPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -90,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + 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. @@ -108,7 +116,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Online + The IsDefault switch specifies that the mailbox plan is the default mailbox plan. You don't need to specify a value with this switch. New and newly-enabled mailboxes receive the settings in the default mailbox plan. @@ -126,7 +136,6 @@ New and newly-enabled mailboxes receive the settings in the default mailbox plan Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Online + The IssueWarningQuota parameter specifies the warning threshold for the size of the mailboxes that are created or enabled using the mailbox plan. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -146,17 +158,16 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The IssueWarningQuota value must be less than or equal to the ProhibitSendReceiveQuota value. -The maximum value is determined by the mailbox plan. You can lower the value, and you may be able to raise the value, but you can't exceed the maximum value that's specified by the subscription or license that corresponds to the mailbox plan. +The maximum value is determined by the mailbox plan. You can lower the value, and you might be able to raise the value, but you can't exceed the maximum value that's specified by the subscription or license that corresponds to the mailbox plan. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Online + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -174,11 +188,11 @@ When you enter a value, qualify the value with one of the following units: - KB (kilobytes) - MB (megabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 150 MB. The default value is 36 MB. -The maximum value is determined by the mailbox plan (subscriptions and licenses). You can lower the value, and you may be able to raise the value, but you can't exceed the maximum value that's specified by the subscription or license that corresponds to the mailbox plan. +The maximum value is determined by the mailbox plan (subscriptions and licenses). You can lower the value, and you might be able to raise the value, but you can't exceed the maximum value that's specified by the subscription or license that corresponds to the mailbox plan. Use this parameter to change the MaxReceiveSize value for new mailboxes that you create. Use the MaxReceiveSize parameter on the Set-Mailbox cmdlet to configure the value on existing mailboxes. @@ -188,7 +202,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Online + The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mailbox. When you enter a value, qualify the value with one of the following units: @@ -206,11 +222,11 @@ When you enter a value, qualify the value with one of the following units: - KB (kilobytes) - MB (megabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 150 MB. The default value is 35 MB. -The maximum value is determined by the mailbox plan (subscriptions and licenses). You can lower the value, and you may be able to raise the value, but you can't exceed the maximum value that's specified by the subscription or license that corresponds to the mailbox plan. +The maximum value is determined by the mailbox plan (subscriptions and licenses). You can lower the value, and you might be able to raise the value, but you can't exceed the maximum value that's specified by the subscription or license that corresponds to the mailbox plan. Use this parameter to change the MaxSendSize value for new mailboxes that you create. Use the MaxSendSize parameter on the Set-Mailbox cmdlet to configure the value on existing mailboxes. @@ -220,7 +236,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -230,6 +245,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendQuota + +> Applicable: Exchange Online + The ProhibitSendQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send new messages, and the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -240,17 +258,16 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The ProhibitSendQuota value must be less than or equal to the ProhibitSendReceiveQuota value. -The maximum value is determined by the mailbox plan. You can lower the value, and you may be able to raise the value, but you can't exceed the maximum value that's specified by the subscription or license that corresponds to the mailbox plan. +The maximum value is determined by the mailbox plan. You can lower the value, and you might be able to raise the value, but you can't exceed the maximum value that's specified by the subscription or license that corresponds to the mailbox plan. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -260,6 +277,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota + +> Applicable: Exchange Online + The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -270,7 +290,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. @@ -280,7 +300,6 @@ The maximum value is determined by the mailbox plan. You can lower the value, bu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -290,13 +309,15 @@ Accept wildcard characters: False ``` ### -RecipientLimits + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -306,6 +327,9 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsFor + +> Applicable: Exchange Online + The RetainDeletedItemsFor parameter specifies the length of time to keep soft-deleted items for the mailbox. Soft-deleted items are items that have been deleted by using any of these methods: - Deleting items from the Deleted Items folder. @@ -324,7 +348,6 @@ The default value is 14 days (14.00:00:00). In Exchange Online, you can increase Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -334,6 +357,9 @@ Accept wildcard characters: False ``` ### -RetentionPolicy + +> Applicable: Exchange Online + The RetentionPolicy parameter specifies the retention policy that's applied to new mailboxes that you create. You can use any value that uniquely identifies the policy. For example: - Name @@ -349,7 +375,7 @@ If you don't set a value for this parameter, existing mailboxes are also updated **Note**: Specifying a value for this parameter has the following potential issues: - If the value of this parameter is not blank ($null), then the specified retention policy must be the default Exchange retention policy that's configured for the organization. Otherwise, the experience might be inconsistent when creating new mailboxes, enabling disabled mailboxes, and changing licenses. -- If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox will be overwritten when changing licenses and will need to be manually reset to the original value. +- If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox is overwritten when changing licenses. You need to manually reset the RetentionPolicy to the original value. - Changes to the default retention policy that affect existing mailboxes can potentially saturate the network if there are hundreds or thousands of mailboxes that require updates. For more information, see [Mailbox plans in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/mailbox-plans). @@ -358,7 +384,6 @@ For more information, see [Mailbox plans in Exchange Online](https://learn.micro Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -368,6 +393,9 @@ Accept wildcard characters: False ``` ### -RoleAssignmentPolicy + +> Applicable: Exchange Online + The RoleAssignmentPolicy parameter specifies the role assignment policy that's applied to the mailbox. You can use any value that uniquely identifies the role assignment policy. For example: - Name @@ -382,7 +410,6 @@ To see the available role assignment policies, use the Get-RoleAssignmentPolicy Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -392,13 +419,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxRegionalConfiguration.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxRegionalConfiguration.md index ef75fd3f02..ba7752e06d 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxRegionalConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxRegionalConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxregionalconfiguration +schema: 2.0.0 +title: Set-MailboxRegionalConfiguration --- # Set-MailboxRegionalConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailboxRegionalConfiguration cmdlet to modify the regional settings of a mailbox. You can modify the date format, time format, time zone and language of the mailbox. @@ -62,7 +63,7 @@ Set-MailboxRegionalConfiguration [-MailboxLocation ] ## DESCRIPTION As shown in Example 5, you might need to set the DateFormat and TimeFormat parameter values to $null when you change the Language parameter value and you receive an error about invalid DateFormat values. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -104,6 +105,9 @@ This example sets Megan Bowen mailbox language to Spanish Argentina, sets the da ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -121,7 +125,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -131,6 +134,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Archive Description }} @@ -139,7 +145,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -149,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -158,7 +166,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -168,9 +175,12 @@ Accept wildcard characters: False ``` ### -DateFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DateFormat parameter specifies a valid date format based on the current or specified language for the mailbox. For example, if the language is set to en-US, valid DateFormat parameter values include: -- M/d/yyyy: This is the default value for en-US. +- M/d/yyyy: This value is the default for en-US. - M/d/yy - MM/dd/yy - MM/dd/yyyy @@ -184,7 +194,6 @@ For more information about the date format strings, see [Standard Date and Time Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -194,6 +203,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -202,7 +214,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +223,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Language parameter specifies the language for the mailbox. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -220,7 +234,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +243,9 @@ Accept wildcard characters: False ``` ### -MailboxLocation + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill MailboxLocation Description }} @@ -238,7 +254,6 @@ This parameter is available only in the cloud-based service. Type: MailboxLocationIdParameter Parameter Sets: MailboxLocation Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,13 +263,15 @@ Accept wildcard characters: False ``` ### -LocalizeDefaultFolderName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LocalizeDefaultFolderName switch localizes the default folder names of the mailbox in the current or specified language. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -264,9 +281,12 @@ Accept wildcard characters: False ``` ### -TimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TimeFormat parameter specifies a valid time format based on the current or specified language value for the mailbox. For example, if the language is set to en-us, valid TimeFormat parameter values include: -- h:mm tt: This is the default value for en-US. +- h:mm tt: This value is the default for en-US. - hh:mm tt - H:mm - HH:mm @@ -277,7 +297,6 @@ For more information about the time format strings, see [Standard Date and Time Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,6 +306,9 @@ Accept wildcard characters: False ``` ### -TimeZone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TimeZone parameter specifies the time zone for the mailbox. A valid value for this parameter is a supported time zone key name (for example, "Pacific Standard Time"). @@ -299,7 +321,6 @@ If the value contains spaces, enclose the value in quotation marks ("). The defa Type: ExTimeZoneValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -309,6 +330,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -317,7 +341,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -327,13 +350,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxRestoreRequest.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxRestoreRequest.md index a874cb3a60..699f3b7b49 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxRestoreRequest.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxrestorerequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxRestoreRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxrestorerequest +schema: 2.0.0 +title: Set-MailboxRestoreRequest --- # Set-MailboxRestoreRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Set-MailboxRestoreRequest cmdlet to change restore request options after the request has been created. You can use this cmdlet to recover from failed restore requests. +Use the Set-MailboxRestoreRequest cmdlet to change restore request options after the request is created. You can use this cmdlet to recover from failed restore requests. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -60,7 +61,7 @@ Set-MailboxRestoreRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,6 +82,9 @@ This example changes the first restore request for Kweku's mailbox to skip 100 c ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name` If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -89,7 +93,6 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: MailboxRestoreRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later or Exchange Online, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -109,7 +115,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -119,19 +124,21 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. In Exchange 2010, if you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter specifies the name of the batch. Use this parameter to change, create, or remove a batch name. To remove a batch name, set the BatchName parameter value to an empty string or to null, for example, -BatchName "" or -BatchName $null. @@ -149,7 +159,6 @@ To remove a batch name, set the BatchName parameter value to an empty string or Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -159,13 +168,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the status of a completed restore request is set to Completed. If this parameter is set to a value of 0, the status is cleared immediately instead of changing it to Completed. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -184,7 +198,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -202,7 +218,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -220,7 +238,6 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +247,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -241,13 +261,12 @@ Valid input for this parameter is an integer or the value unlimited. The default If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -257,6 +276,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -264,7 +286,7 @@ The Priority parameter specifies the order in which the request should be proces - Lowest - Lower - Low -- Normal: This is the default value. +- Normal: This value is the default. - High - Higher - Highest @@ -274,7 +296,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -284,6 +305,9 @@ Accept wildcard characters: False ``` ### -RehomeRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The RehomeRequest switch moves the mailbox restore request to a different mailbox database. You don't need to specify a value with this switch. @@ -294,7 +318,6 @@ Use this switch to edit a mailbox restore request in the case where the source m Type: SwitchParameter Parameter Sets: Rehome Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -304,13 +327,15 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -320,6 +345,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -333,7 +361,6 @@ 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, Exchange Online Required: False Position: Named @@ -343,6 +370,9 @@ Accept wildcard characters: False ``` ### -SkipInitialConnectionValidation + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -351,7 +381,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -361,6 +390,9 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipMerging parameter specifies folder-related items to skip when restoring the mailbox. Use one of the following values: - FolderACLs @@ -374,7 +406,6 @@ Use this parameter only if a restore request fails because of folder rules, fold Type: SkippableMergeComponent[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -384,6 +415,9 @@ Accept wildcard characters: False ``` ### -SkippedItemApprovalTime + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -392,7 +426,6 @@ This parameter is reserved for internal Microsoft use. Type: DateTime Parameter Sets: Identity, Rehome Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -402,6 +435,9 @@ Accept wildcard characters: False ``` ### -SourceWlmLevel + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SourceWlmLevel Description }} @@ -410,7 +446,6 @@ This parameter is available only in the cloud-based service. Type: WlmLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -420,6 +455,9 @@ Accept wildcard characters: False ``` ### -TargetWlmLevel + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill TargetWlmLevel Description }} @@ -428,7 +466,6 @@ This parameter is available only in the cloud-based service. Type: WlmLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -438,13 +475,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSearch.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxSearch.md index ee2ec50572..7506c5c6b8 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxSearch -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/Set-MailboxSearch +schema: 2.0.0 +title: Set-MailboxSearch --- -# Set-Mailboxsearch +# Set-MailboxSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailboxSearch cmdlet to modify an existing mailbox search. @@ -23,7 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Set-Mailboxsearch [-Identity] +Set-MailboxSearch [-Identity] [-AllPublicFolderSources ] [-AllSourceMailboxes ] [-Confirm] @@ -64,7 +65,7 @@ If the In-Place eDiscovery search you want to modify is running, stop it before For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and [In-Place Hold and Litigation Hold in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/holds/holds). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,13 +88,15 @@ In on-premises Exchange, this example adds all public folders to the existing ma ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the mailbox search that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: SearchObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -103,16 +106,18 @@ Accept wildcard characters: False ``` ### -AllPublicFolderSources + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllPublicFolderSources parameter specifies whether to include all public folders in the organization in the search. Valid values are: - $true: All public folders are included in the search. This value is required when the value of the AllSourceMailboxes parameter is $falseand you don't specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value is blank [$null]). -- $false: No public folders are included in the search. This is the default value. You can use this value when the value of the AllSourceMailboxes parameter is $trueor you specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value isn't blank [$null]). +- $false: No public folders are included in the search. This value is the default. You can use this value when the value of the AllSourceMailboxes parameter is $trueor you specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value isn't blank [$null]). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -122,16 +127,18 @@ Accept wildcard characters: False ``` ### -AllSourceMailboxes + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllSourceMailboxes parameter specifies whether to include all mailboxes in the search. Valid values are: - $true: All mailboxes are included in the search. This value is required when the value of the AllPublicFolderSources parameter is $falseand you don't specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value is blank [$null]). -- $false: All mailboxes aren't included in the search. This is the default value. You can use this value when the value of the AllPublicFolderSources parameter is $trueor you specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value isn't blank [$null]). +- $false: All mailboxes aren't included in the search. This value is the default. You can use this value when the value of the AllPublicFolderSources parameter is $trueor you specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value isn't blank [$null]). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -150,7 +160,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -160,13 +169,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Description parameter specifies a description for the search. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -184,7 +198,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -DoNotIncludeArchive + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The DoNotIncludeArchive switch excludes items in the user's Archive mailbox from mailbox searches. You don't need to specify a value with this switch. @@ -204,7 +220,6 @@ By default, items in the user's Archive mailbox are included in mailbox searches Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -214,6 +229,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -224,7 +242,6 @@ To clear the end date, use the value $null. Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -234,13 +251,15 @@ Accept wildcard characters: False ``` ### -EstimateOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EstimateOnly switch provides only an estimate of the number of items that will be returned without copying message to the target mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -250,16 +269,18 @@ Accept wildcard characters: False ``` ### -ExcludeDuplicateMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExcludeDuplicateMessages parameter eliminates duplication of messages across mailboxes in an In-Place eDiscovery search. Valid values are: -- $true: Copy a single instance of a message if the same message exists in multiple folders or mailboxes. This is the default value. +- $true: Copy a single instance of a message if the same message exists in multiple folders or mailboxes. This value is the default. - $false: Copy all instances of a message if the same message exists in multiple folders or mailboxes. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -269,6 +290,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this to switch to hide the confirmation prompt that indicates the previous search results will be removed from the target mailbox, and that the search will be restarted. @@ -277,7 +301,6 @@ Use this to switch to hide the confirmation prompt that indicates the previous s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,13 +310,15 @@ Accept wildcard characters: False ``` ### -IncludeKeywordStatistics + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeKeywordStatistics switch returns keyword statistics (number of instances for each keyword). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -303,10 +328,13 @@ Accept wildcard characters: False ``` ### -IncludeUnsearchableItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IncludeUnsearchableItems parameter specifies whether items that couldn't be indexed by Exchange Search should be included in the results. Valid values are: - $true: Unsearchable items are included in the results. -- $false: Unsearchable items aren't included in the results. This is the default value. +- $false: Unsearchable items aren't included in the results. This value is the default. Unsearchable items aren't placed on hold for a query-based In-Place Hold. If you need to place unsearchable items on hold, you need to create an indefinite hold (a hold without specifying any search parameters, which provides functionality similar to Litigation Hold. @@ -314,7 +342,6 @@ Unsearchable items aren't placed on hold for a query-based In-Place Hold. If you Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -324,20 +351,22 @@ Accept wildcard characters: False ``` ### -InPlaceHoldEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The InPlaceHoldEnabled parameter specifies whether to set an In-Place Hold on items in the search results. Valid values are: - $true: In-Place Hold is enabled on the search results. -- $false: In-Place Hold isn't enabled on the search results. This is the default value. +- $false: In-Place Hold isn't enabled on the search results. This value is the default. You can't set an In-Place Hold on the search results when the AllSourceMailboxes parameter is $true. -If you attempt to place a hold but don't specify mailboxes using the SourceMailboxes parameter, the command may succeed but the mailboxes are not placed on In-Place Hold. +If you attempt to place a hold but don't specify mailboxes using the SourceMailboxes parameter, the command might succeed but the mailboxes are not placed on In-Place Hold. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -347,16 +376,18 @@ Accept wildcard characters: False ``` ### -ItemHoldPeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold onthe mailbox items (all items or the mailbox items that are returned in the search query results). You use this parameter with the InPlaceHoldEnabled parameter to set an In-Place Hold. The duration is calculated from the time the item is received or created in the mailbox. Valid values are: - An integer. -- The value unlimited. This is the default value. Items are held until you remove the In-Place Hold by removing the search by using the Remove-MailboxSearch cmdlet, removing the source mailbox from the search by using the Set-MailboxSearch cmdlet and the SourceMailboxes parameter, or in on-premises Exchange, you remove all public folders from the search by using the Set-MailboxSearch cmdlet to change the AllPublicFolderSources parameter from $true to $false. +- The value unlimited. This value is the default. Items are held until you remove the In-Place Hold by removing the search by using the Remove-MailboxSearch cmdlet, removing the source mailbox from the search by using the Set-MailboxSearch cmdlet and the SourceMailboxes parameter, or in on-premises Exchange, you remove all public folders from the search by using the Set-MailboxSearch cmdlet to change the AllPublicFolderSources parameter from $true to $false. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -366,6 +397,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Language parameter specifies a locale for the mailbox search. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -374,7 +408,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -384,9 +417,12 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LogLevel parameter specifies a logging level for the mailbox search. Valid values are: -- Basic: Basic details of the search are kept. This is the default value. +- Basic: Basic details of the search are kept. This value is the default. - Full: In addition to details in the Basic logging level, a full list of all messages returned is included. - Suppress: Logging is suppressed. No logs are kept. @@ -394,7 +430,6 @@ The LogLevel parameter specifies a logging level for the mailbox search. Valid v Type: LoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -404,6 +439,9 @@ Accept wildcard characters: False ``` ### -MessageTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MessageTypes parameter specifies the message types to include in the search query. Valid values are: - Contacts @@ -423,7 +461,6 @@ The default value is blank ($null), which means all message types are included. Type: KindKeyword[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -433,6 +470,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a name for the search. If the value contains spaces, enclose the value in quotation marks ("). The value of this parameter is used to create the top-level folder that holds the search results in the target mailbox that's specified by the TargetMailbox parameter. @@ -441,7 +481,6 @@ The value of this parameter is used to create the top-level folder that holds th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -451,6 +490,9 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Recipients parameter specifies one or more recipients include in the search query. Messages that have the specified recipients in the To, Cc, and Bcc fields are returned in the search results. You can specify multiple recipients separated by commas. If the value contains spaces, enclose the value in quotation marks ("). @@ -461,7 +503,6 @@ To clear the recipients, use the value $null. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -471,6 +512,9 @@ Accept wildcard characters: False ``` ### -SearchDumpster + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The SearchDumpster parameter specifies whether the dumpster is searched. The dumpster is a storage area in the mailbox where deleted items are temporarily stored after being deleted or removed from the Deleted Items folder, or after being hard-deleted and before being purged from the mailbox based on Deleted Item Retention settings. @@ -481,7 +525,6 @@ Set the value to $true to enable searching the dumpster, or set to $false to dis Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -491,6 +534,9 @@ Accept wildcard characters: False ``` ### -SearchQuery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). If you use this parameter with other search query parameters, the query combines these parameters by using the AND operator. @@ -507,7 +553,6 @@ The other search query parameters are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -517,6 +562,9 @@ Accept wildcard characters: False ``` ### -Senders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Senders parameter specifies one or more senders to include in the search query. Messages that have the specified sender are returned in the search results. Senders can include users, distribution groups (messages sent by members of the group), SMTP addresses, or domains. You can specify multiple senders separated by commas. If the value contains spaces, enclose the value in quotation marks ("). @@ -527,7 +575,6 @@ To clear the senders, use the value $null. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -537,6 +584,9 @@ Accept wildcard characters: False ``` ### -SourceMailboxes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceMailboxes parameter specifies the mailboxes to be searched. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -561,7 +611,6 @@ To enable In-Place Hold on the search results, you need to set the AllSourceMail Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -571,6 +620,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -581,7 +633,6 @@ To clear start date, use the value $null. Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -591,13 +642,15 @@ Accept wildcard characters: False ``` ### -StatisticsStartIndex + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StatisticsStartIndex parameter is used by the Exchange admin center (EAC) to retrieve keyword statistics in a paged operation. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -607,6 +660,9 @@ Accept wildcard characters: False ``` ### -StatusMailRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StatusMailRecipients parameter specifies one or more recipients to receive a status email message upon completion of the search. You can use any value that uniquely identifies the recipient. For example: - Name @@ -622,7 +678,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -632,6 +687,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetMailbox parameter specifies the destination mailbox where the search results are copied. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -649,7 +707,6 @@ The TargetMailbox parameter specifies the destination mailbox where the search r Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -659,13 +716,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSentItemsConfiguration.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxSentItemsConfiguration.md index fc78cfa732..7a2d21ab4e 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSentItemsConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxsentitemsconfiguration applicable: Exchange Server 2010 -title: Set-MailboxSentItemsConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxsentitemsconfiguration +schema: 2.0.0 +title: Set-MailboxSentItemsConfiguration --- # Set-MailboxSentItemsConfiguration @@ -33,7 +34,7 @@ Set-MailboxSentItemsConfiguration [-Confirm] ## DESCRIPTION By default, when you use Send As or Send On Behalf Of to send a message from another mailbox, the message is saved in your Sent Items folder (not in the Sent Items folder of the source mailbox). In Microsoft Exchange Server 2010 Service Pack 3 (SP3), you can save copies messages in the Sent Items folder of the sender and the source mailbox. For example, consider a shared mailbox that receives customer feedback and is monitored by multiple users. When someone responds to a message in the shared mailbox, you can save the message in the Sent Items folder of the shared mailbox and the sender's mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example configures the shared mailbox named "Customer Support Feedback" so ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -56,7 +60,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the mailbox whose Sent Items configuration you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -99,7 +107,6 @@ The Identity parameter specifies the mailbox whose Sent Items configuration you Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -109,16 +116,18 @@ Accept wildcard characters: False ``` ### -SendAsItemsCopiedTo + +> Applicable: Exchange Server 2010 + The SendAsItemsCopiedTo parameter specifies where messages that are sent from the mailbox using Send As permission are saved. Valid values are: -- Sender: Messages sent from the mailbox are saved in the Sent Items folder of the user who sent the message. This is the default value. +- Sender: Messages sent from the mailbox are saved in the Sent Items folder of the user who sent the message. This value is the default. - SenderAndFrom: Messages sent from the mailbox are saved in the Sent Items folder of the user who sent the message, and in the Sent Items folder of the mailbox. ```yaml Type: SentItemsCopiedTo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -128,16 +137,18 @@ Accept wildcard characters: False ``` ### -SendOnBehalfOfItemsCopiedTo + +> Applicable: Exchange Server 2010 + The SendOnBehalfOfItemsCopiedTo parameter specifies where messages that are sent from the mailbox using Send On Behalf Of permission are saved. Valid values are: -- Sender: Messages sent from the mailbox are saved in the Sent Items folder of the user who sent the message. This is the default value. +- Sender: Messages sent from the mailbox are saved in the Sent Items folder of the user who sent the message. This value is the default. - SenderAndFrom: Messages sent from the mailbox are saved in the Sent Items folder of the user who sent the message, and in the Sent Items folder of the mailbox. ```yaml Type: SentItemsCopiedTo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxServer.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-MailboxServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxServer.md index dc2d9df659..3b965ef2fd 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxserver -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxServer -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxserver +schema: 2.0.0 +title: Set-MailboxServer --- # Set-MailboxServer @@ -130,7 +131,7 @@ Set-MailboxServer [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -139,7 +140,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-MailboxServer -Identity MBX02 -CalendarRepairWorkCycle 7.00:00:00 -CalendarRepairWorkCycleCheckpoint 7.00:00:00 ``` -In Exchange 2013, this example throttles the Calendar Repair Assistant to detect and repair calendar inconsistencies for the Mailbox server MBX02 in a 7-day period. During that 7-day period, all mailboxes will be scanned, and at the end of the period, the process will start over. +In Exchange 2013, this example throttles the Calendar Repair Assistant to detect and repair calendar inconsistencies for the Mailbox server MBX02 in a 7-day period. During that 7-day period, all mailboxes are scanned, and at the end of the period, the process starts over. ### Example 2 ```powershell @@ -153,46 +154,49 @@ This example changes some of the default settings of the Calendar Repair Assista Set-MailboxServer -Identity MBX02 -CalendarRepairWorkCycle 7.00:00:00 -CalendarRepairWorkCycleCheckpoint 7.00:00:00 ``` -In Exchange 2010, this example throttles the Calendar Repair Assistant to detect and repair calendar inconsistencies for the Mailbox server MBX02 in a 7-day period. During that 7-day period, all mailboxes will be scanned, and at the end of the period, the process will start over. +In Exchange 2010, this example throttles the Calendar Repair Assistant to detect and repair calendar inconsistencies for the Mailbox server MBX02 in a 7-day period. During that 7-day period, all mailboxes are scanned, and at the end of the period, the process starts over. ### Example 4 ```powershell Set-MailboxServer -Identity MBX02 -ManagedFolderWorkCycle 10.00:00:00 -ManagedFolderWorkCycleCheckpoint 10.00:00:00 ``` -In Exchange 2013, this example throttles the Managed Folder Assistant, which applies message retention settings to all mailboxes for the Mailbox server MBX02 in a 10-day period. During that 10-day period, all mailboxes will be scanned, and at the end of the period, the process will start over. +In Exchange 2013, this example throttles the Managed Folder Assistant, which applies message retention settings to all mailboxes for the Mailbox server MBX02 in a 10-day period. During that 10-day period, all mailboxes are scanned, and at the end of the period, the process starts over. ### Example 5 ```powershell Set-MailboxServer -Identity MBX02 -ManagedFolderWorkCycle 10.00:00:00 -ManagedFolderWorkCycleCheckpoint 10.00:00:00 ``` -In Exchange 2010, this example throttles the Managed Folder Assistant, which applies message retention settings to all mailboxes for the Mailbox server MBX02 in a 10-day period. During that 10-day period, all mailboxes will be scanned, and at the end of the period, the process will start over. +In Exchange 2010, this example throttles the Managed Folder Assistant, which applies message retention settings to all mailboxes for the Mailbox server MBX02 in a 10-day period. During that 10-day period, all mailboxes are scanned, and at the end of the period, the process starts over. ### Example 6 ```powershell Set-MailboxServer -Identity MBX02 -SharingPolicyWorkCycle 7.00:00:00 -SharingPolicyWorkCycleCheckpoint 7.00:00:00 -SharingSyncWorkCycle 7.00:00:00 -SharingSyncWorkCycleCheckpoint 7.00:00:00 ``` -In Exchange 2013, this example throttles the Sharing Policy and Sharing Sync Assistants to apply sharing policies, sync shared calendars, and free/busy information for the mailboxes on server MBX02 in a 7-day period. During that 7-day period, all mailboxes will be scanned, and at the end of the period, the process will start over. +In Exchange 2013, this example throttles the Sharing Policy and Sharing Sync Assistants to apply sharing policies, sync shared calendars, and free/busy information for the mailboxes on server MBX02 in a 7-day period. During that 7-day period, all mailboxes are scanned, and at the end of the period, the process starts over. ### Example 7 ```powershell Set-MailboxServer -Identity MBX02 -SharingPolicyWorkCycle 7.00:00:00 -SharingPolicyWorkCycleCheckpoint 7.00:00:00 -SharingSyncWorkCycle 7.00:00:00 -SharingSyncWorkCycleCheckpoint 7.00:00:00 ``` -In Exchange 2010, this example throttles the Sharing Policy and Sharing Sync Assistants to apply sharing policies, sync shared calendars, and free/busy information for the mailboxes on server MBX02 in a 7-day period. During that 7-day period, all mailboxes will be scanned, and at the end of the period, the process will start over. +In Exchange 2010, this example throttles the Sharing Policy and Sharing Sync Assistants to apply sharing policies, sync shared calendars, and free/busy information for the mailboxes on server MBX02 in a 7-day period. During that 7-day period, all mailboxes are scanned, and at the end of the period, the process starts over. ### Example 8 ```powershell Set-MailboxServer -Identity MBX02 -TopNWorkCycle 10.00:00:00 -TopNWorkCycleCheckpoint 10.00:00:00 -UMReportingWorkCycle 10.00:00:00 -UMReportingWorkCycleCheckpoint 10.00:00:00 ``` -In Exchange 2010, this example throttles the TopN Words Assistant and the Unified Messaging Reporting Assistant for mailboxes that reside on the Mailbox server MBX02 in a 10-day period. During that 10-day period, all mailboxes that have Unified Messaging enabled will be scanned, and at the end of the period, the process will start over. +In Exchange 2010, this example throttles the TopN Words Assistant and the Unified Messaging Reporting Assistant for mailboxes that reside on the Mailbox server MBX02 in a 10-day period. During that 10-day period, all mailboxes that have Unified Messaging enabled are scanned, and at the end of the period, the process starts over. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Mailbox server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -203,7 +207,6 @@ The Identity parameter specifies the Mailbox server that you want to modify. You Type: MailboxServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -213,13 +216,15 @@ Accept wildcard characters: False ``` ### -AutoDagServerConfigured + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -229,19 +234,21 @@ Accept wildcard characters: False ``` ### -AutoDatabaseMountDial + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDatabaseMountDial parameter specifies the automatic database mount behavior for a continuous replication environment after a database failover on the Mailbox server. You can use the following values: - BestAvailability: The database automatically mounts immediately after a failover if the copy queue length is less than or equal to 12. The copy queue length is the number of logs recognized by the passive copy that needs to be replicated. If the copy queue length is more than 12, the database doesn't automatically mount. When the copy queue length is less than or equal to 12, Exchange attempts to replicate the remaining logs to the passive copy and mounts the database. - GoodAvailability: The database automatically mounts immediately after a failover if the copy queue length is less than or equal to six. The copy queue length is the number of logs recognized by the passive copy that needs to be replicated. If the copy queue length is more than six, the database doesn't automatically mount. When the copy queue length is less than or equal to six, Exchange attempts to replicate the remaining logs to the passive copy and mounts the database. - Lossless: The database doesn't automatically mount until all logs that were generated on the active copy have been copied to the passive copy. This setting also causes Active Manager's best copy selection algorithm to sort potential candidates for activation based on the database copy's activation preference value and not its copy queue length. -The default value is GoodAvailability. If you specify either BestAvailability or GoodAvailability, and all of the logs from the active copy haven't been replicated to the passive copy, you may lose some mailbox data. However, the Safety Net feature, (which is enabled by default) helps protect against data loss by resubmitting messages that are in Safety Net. +The default value is GoodAvailability. If you specify either BestAvailability or GoodAvailability, and all of the logs from the active copy haven't been replicated to the passive copy, you might lose some mailbox data. However, the Safety Net feature, (which is enabled by default) helps protect against data loss by resubmitting messages that are in Safety Net. ```yaml Type: AutoDatabaseMountDial Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,6 +258,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairIntervalEndWindow + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarRepairIntervalEndWindow parameter specifies the number of days into the future to repair calendar items in mailboxes on the Mailbox server. The default value in Exchange 2016 and Exchange 2019 is 7. This value means the Calendar Repair Assistant repairs meetings in calendars up to 7 days from now. Meetings that are scheduled to occur more than 7 days in the future aren't repaired. @@ -261,7 +271,6 @@ The default value in Exchange 2013 and Exchange 2010 is 30. This value means the Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -271,6 +280,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairLogDirectorySizeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarRepairLogDirectorySizeLimit parameter specifies the maximum size of calendar repair log directory on the Mailbox server. When the directory reaches its maximum size, the server deletes the oldest log files first. Calendar repair log files begin with the name prefix CRA. The maximum size of the calendar repair log directory is calculated as the total size of all log files that have the CRA name prefix. Other files aren't counted in the total directory size calculation. Renaming old log files or copying other files into the calendar repair log directory could cause the directory to exceed its specified maximum size. @@ -285,7 +297,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. If you enter the value unlimited, no size limit is imposed on the calendar repair log directory. @@ -293,7 +305,6 @@ If you enter the value unlimited, no size limit is imposed on the calendar repai Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -303,6 +314,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarRepairLogEnabled parameter specifies whether the Calendar Repair Attendant logs items that it repairs on the Mailbox server. The repair log doesn't contain failed repair attempts. Valid input for this parameter is $true or $false. The default value is $true. @@ -318,7 +332,6 @@ The value of this parameter affects the following parameters: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -328,6 +341,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairLogFileAgeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarRepairLogFileAgeLimit parameter specifies the calendar repair log maximum file age on the Mailbox server. Log files older than the specified value are deleted. The default value is 10 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -338,7 +354,6 @@ For example, to specify 30 days, enter 30.00:00:00. The value 00:00:00 prevents Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -348,13 +363,15 @@ Accept wildcard characters: False ``` ### -CalendarRepairLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarRepairLogPath parameter specifies the location of the calendar repair log files on the Mailbox server. The default value is %ExchangeInstallPath%Logging\\Calendar Repair Assistant. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -364,13 +381,15 @@ Accept wildcard characters: False ``` ### -CalendarRepairLogSubjectLoggingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarRepairLogSubjectLoggingEnabled parameter specifies whether to include the subject of repaired calendar items in the calendar repair log on the Mailbox server. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -380,13 +399,15 @@ Accept wildcard characters: False ``` ### -CalendarRepairMissingItemFixDisabled -The CalendarRepairMissingItemFixDisabled parameter specifies whether the Calendar Repair Assistant won't fix missing calendar items in mailboxes on the Mailbox server.Valid input for this parameter is $true or $false. The default value is $false. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The CalendarRepairMissingItemFixDisabled parameter specifies whether the Calendar Repair Assistant fixes missing calendar items in mailboxes on the Mailbox server.Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -396,13 +417,15 @@ Accept wildcard characters: False ``` ### -CalendarRepairMode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarRepairMode parameter specifies the Calendar Repair Assistant mode on the Mailbox server. Valid values for this parameter are ValidateOnly or RepairAndValidate. The default value is RepairAndValidate. ```yaml Type: CalendarRepairType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -412,6 +435,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairSchedule + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CalendarRepairSchedule parameter specifies the intervals each week during which the Calendar Repair Assistant applies checks for calendar failures. @@ -441,7 +467,6 @@ Here are some examples: Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -451,21 +476,23 @@ Accept wildcard characters: False ``` ### -CalendarRepairWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The CalendarRepairWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be scanned by the Calendar Repair Assistant. The default value is 1 day. +The CalendarRepairWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server are scanned by the Calendar Repair Assistant. The default value is 1 day. -Calendars that have inconsistencies will be flagged and repaired according to the interval specified by the CalendarRepairWorkCycleCheckpoint parameter. +Calendars that have inconsistencies are flagged and repaired according to the interval specified by the CalendarRepairWorkCycleCheckpoint parameter. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. -For example, to specify 2 days for this parameter, use 2.00:00:00. The Calendar Repair Assistant will then process all mailboxes on this server every 2 days. +For example, to specify 2 days for this parameter, use 2.00:00:00. The Calendar Repair Assistant then processes all mailboxes on this server every 2 days. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -475,19 +502,21 @@ Accept wildcard characters: False ``` ### -CalendarRepairWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The CalendarRepairWorkCycleCheckpoint parameter specifies the time span at which all mailboxes on the Mailbox server will be identified as needing work completed on them. The default value is 1 day. +The CalendarRepairWorkCycleCheckpoint parameter specifies the time span at which all mailboxes on the Mailbox server are identified as needing work completed on them. The default value is 1 day. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. -For example, to specify 2 days for this parameter, use 2.00:00:00. The Calendar Repair Assistant will then process all mailboxes on this server every 2 days. +For example, to specify 2 days for this parameter, use 2.00:00:00. The Calendar Repair Assistant then processes all mailboxes on this server every 2 days. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -497,6 +526,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -506,7 +538,6 @@ 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 Required: False Position: Named @@ -516,6 +547,9 @@ Accept wildcard characters: False ``` ### -DarTaskStoreTimeBasedAssistantWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -524,7 +558,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -534,6 +567,9 @@ Accept wildcard characters: False ``` ### -DarTaskStoreTimeBasedAssistantWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -542,7 +578,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -552,17 +587,19 @@ Accept wildcard characters: False ``` ### -DatabaseCopyActivationDisabledAndMoveNow -The DatabaseCopyActivationDisabledAndMoveNow parameter specifies whether to prevent databases from being mounted on this Mailbox server if there are other healthy copies of the databases on other Mailbox servers. It will also immediately move any mounted databases on the server to other servers if copies exist and are healthy. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The DatabaseCopyActivationDisabledAndMoveNow parameter specifies whether to prevent databases from being mounted on this Mailbox server if there are other healthy copies of the databases on other Mailbox servers. It also immediately moves any mounted databases on the server to other servers if copies exist and are healthy. Valid input for this parameter is $true or $false. The default value is $false. -Setting this parameter to $true won't cause databases to move to a server that has the DatabaseCopyAutoActivationPolicy parameter set to Blocked. +Setting this parameter to $true doesn't cause databases to move to a server that has the DatabaseCopyAutoActivationPolicy parameter set to Blocked. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -572,17 +609,19 @@ Accept wildcard characters: False ``` ### -DatabaseCopyAutoActivationPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DatabaseCopyAutoActivationPolicy parameter specifies the type of automatic activation available for mailbox database copies on the specified Mailbox server. Valid values for this parameter are: -- Blocked: Databases can't be automatically activated on the specified Mailbox server. In Exchange 2013 prior to Cumulative Update 7 (CU7), this setting stops server locator requests to the specified server, which prevents all client access to manually activated databases on the server if all DAG members are configured with a value of Blocked. In Exchange 2013 CU7 or later versions of Exchange, server locator requests are sent to a blocked server if no other Mailbox servers are available, thus client access is not impacted. +- Blocked: Databases can't be automatically activated on the specified Mailbox server. In Exchange 2013 prior to Cumulative Update 7 (CU7), this setting stops server locator requests to the specified server, which prevents all client access to manually activated databases on the server if all DAG members are configured with a value of Blocked. In Exchange 2013 CU7 or later versions of Exchange, server locator requests are sent to a blocked server if no other Mailbox servers are available, thus client access isn't affected. - IntrasiteOnly: The database copy is allowed to be activated only on Mailbox servers in the same Active Directory site. This prevents cross-site failover and activation. -- Unrestricted: There are no special restrictions on activating mailbox database copies on the specified Mailbox server. This is the default value. +- Unrestricted: There are no special restrictions on activating mailbox database copies on the specified Mailbox server. This value is the default. ```yaml Type: DatabaseCopyAutoActivationPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -592,6 +631,9 @@ Accept wildcard characters: False ``` ### -DirectoryProcessorWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -600,7 +642,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -610,6 +651,9 @@ Accept wildcard characters: False ``` ### -DirectoryProcessorWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -618,7 +662,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -628,13 +671,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -644,13 +689,15 @@ Accept wildcard characters: False ``` ### -FaultZone + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -660,6 +707,9 @@ Accept wildcard characters: False ``` ### -FolderLogForManagedFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The FolderLogForManagedFoldersEnabled parameter specifies whether managed folder logging is enabled on the Mailbox server. Valid input for this parameter is$true or $false. The default value is $false. @@ -680,7 +730,6 @@ The value of this parameter affects the following parameters: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -690,6 +739,9 @@ Accept wildcard characters: False ``` ### -ForceGroupMetricsGeneration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForceGroupMetricsGeneration parameter specifies that group metrics information must be generated on the Mailbox server regardless of whether that server generates an offline address book (OAB). Valid input for this parameter is $true or $false. The default value is $false. By default, group metrics are generated only on servers that generate OABs. Group metrics information is used by MailTips to inform senders about how many recipients their messages will be sent to. You need to set this parameter to $true if your organization doesn't generate OABs and you want the group metrics data to be available. @@ -698,7 +750,6 @@ By default, group metrics are generated only on servers that generate OABs. Grou Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -708,6 +759,9 @@ Accept wildcard characters: False ``` ### -GroupMailboxWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -716,7 +770,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -726,6 +779,9 @@ Accept wildcard characters: False ``` ### -GroupMailboxWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -734,7 +790,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -744,6 +799,9 @@ Accept wildcard characters: False ``` ### -GroupMetricsGenerationTime + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The GroupMetricsGenerationTime parameter specifies the time of day when group metrics data is generated on a Mailbox server. You must use the 24-hour clock notation (HH:MM) when specifying the generation time. @@ -752,7 +810,6 @@ The GroupMetricsGenerationTime parameter specifies the time of day when group me Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -762,6 +819,9 @@ Accept wildcard characters: False ``` ### -InferenceDataCollectionWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -770,7 +830,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -780,6 +839,9 @@ Accept wildcard characters: False ``` ### -InferenceDataCollectionWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -788,7 +850,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -798,6 +859,9 @@ Accept wildcard characters: False ``` ### -InferenceTrainingWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -806,7 +870,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -816,6 +879,9 @@ Accept wildcard characters: False ``` ### -InferenceTrainingWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -824,7 +890,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -834,6 +899,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogEnabled parameter enables or disables logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: @@ -845,7 +913,6 @@ The IrmLogEnabled parameter enables or disables logging of Information Rights Ma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -855,6 +922,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days. @@ -867,7 +937,6 @@ Setting the value of the IrmLogMaxAge parameter to 00:00:00 prevents the automat Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -877,6 +946,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 megabytes (MB). When you enter a value, qualify the value with one of the following units: @@ -895,7 +967,6 @@ The valid input range for either parameter is from 1 through 9223372036854775807 Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -905,6 +976,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -921,7 +995,6 @@ Unqualified values are treated as bytes. The value of the IrmLogMaxFileSize para Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -931,17 +1004,19 @@ Accept wildcard characters: False ``` ### -IrmLogPath + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. -The IrmLogPath parameter specifies the default IRM log directory location. The default value is C:\\Program Files\\Microsoft\\Exchange Server\\ v14\\Logging\\IRMLogs. +The IrmLogPath parameter specifies the default IRM log directory location. The default value is %ExchangeInstallPath%Logging\\IRMLogs. -If you set the value of the IrmLogPath parameter to $null, you effectively disable IRM logging. However, if you set the value of the IrmLogPath parameter to $null when the value of the IrmLogEnabled parameter is $true, Exchange will log errors in the Application event log. The preferred way for disabling IRM logging is to set the IrmLogEnabled parameter to $false. +If you set the value of this parameter to $null, you effectively disable IRM logging. However, if the value of the IrmLogEnabled parameter is $true, Exchange adds errors to the Application event log. The preferred way to disable IRM logging is to set the IrmLogEnabled parameter to $false. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -951,15 +1026,18 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioning -The IsExcludedFromProvisioning parameter specifies that the Mailbox server isn't considered by the OAB provisioning load balancer. Valid input for this parameter is $true or $false. The default value is $false. -If you specify$true, the server won't be used for provisioning a new OAB or for moving existing OABs. +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The IsExcludedFromProvisioning parameter specifies that the Mailbox server isn't considered by the OAB provisioning load balancer. Valid values are: + +- $true: The server isn't used for provisioning new OABs or for moving existing OABs. +- $false: The server can be used for provisioning new OABs or for moving existing OABs. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -969,6 +1047,9 @@ Accept wildcard characters: False ``` ### -JournalingLogForManagedFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The JournalingLogForManagedFoldersEnabled parameter specifies whether journaling activity is recorded in the managed folder log on the Mailbox server.Valid input for this parameter is$true or $false. The default value is $false. If you specify $true, information about messages that were journaled in managed folders is logged. The managed folder log directory is specified by the LogPathForManagedFolders parameter. @@ -977,7 +1058,6 @@ If you specify $true, information about messages that were journaled in managed Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -987,6 +1067,9 @@ Accept wildcard characters: False ``` ### -JunkEmailOptionsCommitterWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -995,7 +1078,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1005,6 +1087,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Locale parameter specifies the locale of the Mailbox server. A locale is a collection of language-related user preferences such as writing system, calendar, and date format. The following are examples: - en-US (English - United States) @@ -1021,7 +1106,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1031,6 +1115,9 @@ Accept wildcard characters: False ``` ### -LogDirectorySizeLimitForManagedFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The LogDirectorySizeLimitForManagedFolders parameter specifies the maximum size of all managed folder logs from a single mailbox database in the managed folder log directory on the Mailbox server. When a set of log files reaches its maximum size, the server deletes the oldest log files first. @@ -1045,7 +1132,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The default value is unlimited, which means no size limit is imposed on the managed folder log directory. @@ -1053,7 +1140,6 @@ The default value is unlimited, which means no size limit is imposed on the mana Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1063,6 +1149,9 @@ Accept wildcard characters: False ``` ### -LogFileAgeLimitForManagedFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The LogFileAgeLimitForManagedFolders parameter specifies how long to retain managed folder logs on the Mailbox server. Log files older than the specified value are deleted. @@ -1075,7 +1164,6 @@ For example, to specify a 30 days, enter 30.00:00:00. The default value is 00:00 Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1085,6 +1173,9 @@ Accept wildcard characters: False ``` ### -LogFileSizeLimitForManagedFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The LogFileSizeLimitForManagedFolders parameter specifies the maximum size for each managed folder log file on the Mailbox server. When a log file reaches its maximum size, a new log file is created. The default value is 10 megabytes (MB). @@ -1097,7 +1188,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. If you enter the value unlimited, no size limit is imposed on a managed folder log file. @@ -1105,7 +1196,6 @@ If you enter the value unlimited, no size limit is imposed on a managed folder l Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1115,6 +1205,9 @@ Accept wildcard characters: False ``` ### -LogPathForManagedFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The LogPathForManagedFolders parameter specifies the location of the managed folder log files on the Mailbox server. The default value is %ExchangeInstallPath%Logging\\ Managed Folder Assistant. @@ -1123,7 +1216,6 @@ The LogPathForManagedFolders parameter specifies the location of the managed fol Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1133,6 +1225,9 @@ Accept wildcard characters: False ``` ### -MailboxAssociationReplicationWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1141,7 +1236,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1151,6 +1245,9 @@ Accept wildcard characters: False ``` ### -MailboxAssociationReplicationWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1159,7 +1256,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1169,6 +1265,9 @@ Accept wildcard characters: False ``` ### -MailboxProcessorWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The MailboxProcessorWorkCycle parameter specifies how often to scan for locked mailboxes on the Mailbox server. The default value is 1 day. @@ -1179,7 +1278,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hou Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1189,6 +1287,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderAssistantSchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + **Note**: Although this parameter is available in Exchange 2016 and Exchange 2019, it's only used for coexistence with previous versions of Exchange. For more information, see [Configure and run the Managed Folder Assistant in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mrm/configure-managed-folder-assistant). The ManagedFolderAssistantSchedule parameter specifies the intervals each week during which the Managed Folder Assistant applies messaging records management (MRM) settings to managed folders in mailboxes on the Mailbox server. @@ -1220,7 +1321,6 @@ If the Managed Folder Assistant doesn't finish processing the mailboxes on the s Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1230,21 +1330,23 @@ Accept wildcard characters: False ``` ### -ManagedFolderWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The ManagedFolderWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be processed by the Managed Folder Assistant. The default value is 1 day. +The ManagedFolderWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server are processed by the Managed Folder Assistant. The default value is 1 day. The Managed Folder Assistant applies retention policies according to the ManagedFolderWorkCycleCheckpoint interval. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. -For example, to specify 2 days for this parameter, use 2.00:00:00. The Managed Folder Assistant will then process all mailboxes on this server every 2 days. +For example, to specify 2 days for this parameter, use 2.00:00:00. The Managed Folder Assistant then processes all mailboxes on this server every 2 days. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1254,11 +1356,14 @@ Accept wildcard characters: False ``` ### -ManagedFolderWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The ManagedFolderWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 1 day. +The ManagedFolderWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved are part of the work queue. The default value is 1 day. -Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle. +Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time are placed higher in the queue and have a greater chance of being processed again in the same work cycle. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. @@ -1268,7 +1373,6 @@ For example, to specify 2 days for this parameter, use 2.00:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1278,13 +1382,15 @@ Accept wildcard characters: False ``` ### -MAPIEncryptionRequired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MAPIEncryptionRequired parameter specifies whether Exchange blocks MAPI client connections to the Mailbox server that don't use encrypted remote procedure calls (RPCs). Valid input for this parameter is$true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1294,9 +1400,12 @@ Accept wildcard characters: False ``` ### -MaximumActiveDatabases + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaximumActiveDatabases parameter specifies the maximum number of databases that can be mounted on the Mailbox server. -When the maximum number is reached, the database copies on the server won't be activated if a failover or switchover occurs. If the copies are already active on a server, the Information Store on the server won't allow databases to be mounted. +When the maximum number is reached, the database copies on the server isn't activated if a failover or switchover occurs. If the copies are already active on a server, the Information Store on the server doesn't allow databases to be mounted. The default value is blank ($null), which means no maximum value is configured. @@ -1304,7 +1413,6 @@ The default value is blank ($null), which means no maximum value is configured. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1314,6 +1422,9 @@ Accept wildcard characters: False ``` ### -MaximumPreferredActiveDatabases + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaximumPreferredActiveDatabases parameter specifies a preferred maximum number of databases that theMailbox server should have. This value is different from the actual maximum, which is configured using the MaximumActiveDatabases parameter. The value of MaximumPreferredActiveDatabases is only honored during best copy and server selection, database and server switchovers, and when rebalancing the DAG. The default value is blank ($null), which means no maximum value is configured. @@ -1322,7 +1433,6 @@ The default value is blank ($null), which means no maximum value is configured. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1332,6 +1442,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogEnabled parameter specifies whether message tracking is enabled. The default value is $true. @@ -1340,7 +1453,6 @@ The MessageTrackingLogEnabled parameter specifies whether message tracking is en Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1350,6 +1462,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxAge + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogMaxAge parameter specifies the message tracking log maximum file age. Log files older than the specified value are deleted. The default value is 30 days. @@ -1362,7 +1477,6 @@ The valid input range for this parameter is 00:00:00 to 24855.03:14:07. Setting Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1372,6 +1486,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxDirectorySize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogMaxDirectorySize parameter specifies the maximum size of the message tracking log directory. When the maximum directory size is reached, the server deletes the oldest log files first. @@ -1394,7 +1511,6 @@ Unqualified values are treated as bytes. The value of the MessageTrackingLogMaxF Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1404,6 +1520,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxFileSize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogMaxFileSize parameter specifies the maximum size of the message tracking log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1419,7 +1538,6 @@ Unqualified values are treated as bytes. The value of the MessageTrackingLogMaxF Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1429,6 +1547,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogPath + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogPath parameter specifies the location of the message tracking logs. The default location is C:\\Program Files\\Microsoft\\Exchange Server TransportRoles\\Logs\\MessageTracking. If you set the value of the MessageTrackingLogPath parameter to $null, you effectively disable message tracking. However, if you set the value of the MessageTrackingLogPath parameter to $null when the value of the MessageTrackingLogEnabled attribute is $true, event log errors occur. The preferred method to disable message tracking is to use the MessageTrackingLogEnabled parameter. @@ -1437,7 +1558,6 @@ The MessageTrackingLogPath parameter specifies the location of the message track Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1447,6 +1567,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogSubjectLoggingEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogSubjectLoggingEnabled parameter specifies if the message subject should be included in the message tracking log. The default value is $true. @@ -1455,7 +1578,6 @@ The MessageTrackingLogSubjectLoggingEnabled parameter specifies if the message s Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1465,13 +1587,15 @@ Accept wildcard characters: False ``` ### -MigrationLogFilePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1481,13 +1605,15 @@ Accept wildcard characters: False ``` ### -MigrationLogLoggingLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: MigrationEventType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1497,13 +1623,15 @@ Accept wildcard characters: False ``` ### -MigrationLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1513,13 +1641,15 @@ Accept wildcard characters: False ``` ### -MigrationLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1529,13 +1659,15 @@ Accept wildcard characters: False ``` ### -MigrationLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1545,9 +1677,12 @@ Accept wildcard characters: False ``` ### -OABGeneratorWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. -The OABGeneratorWorkCycle parameter specifies the time span in which the OAB generation on the Mailbox server will be processed. The default value is 8 hours. +The OABGeneratorWorkCycle parameter specifies the time span in which the OAB generation on the Mailbox server are processed. The default value is 8 hours. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. @@ -1557,7 +1692,6 @@ For example, to specify 16 hours for this parameter, use 16:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1567,6 +1701,9 @@ Accept wildcard characters: False ``` ### -OABGeneratorWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The OABGeneratorWorkCycleCheckpoint parameter specifies the time span at which to run OAB generation on the Mailbox server. The default value is 1 hour. @@ -1579,7 +1716,6 @@ For example, to specify 2 hours for this parameter, use 02:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1589,6 +1725,9 @@ Accept wildcard characters: False ``` ### -PeopleCentricTriageWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1597,7 +1736,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1607,6 +1745,9 @@ Accept wildcard characters: False ``` ### -PeopleCentricTriageWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1615,7 +1756,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1625,6 +1765,9 @@ Accept wildcard characters: False ``` ### -PeopleRelevanceWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1633,7 +1776,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1643,6 +1785,9 @@ Accept wildcard characters: False ``` ### -PeopleRelevanceWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1651,7 +1796,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1661,6 +1805,9 @@ Accept wildcard characters: False ``` ### -ProbeTimeBasedAssistantWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1669,7 +1816,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1679,6 +1825,9 @@ Accept wildcard characters: False ``` ### -ProbeTimeBasedAssistantWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1687,7 +1836,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1697,6 +1845,9 @@ Accept wildcard characters: False ``` ### -PublicFolderWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The PublicFolderWorkCycle parameter is used by the public folder assistant to determine how often the mailboxes in a database are processed by the assistant on the Mailbox server. The default value is 1 day. @@ -1707,7 +1858,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hou Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1717,6 +1867,9 @@ Accept wildcard characters: False ``` ### -PublicFolderWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The PublicFolderWorkCycleCheckpoint determines how often the mailbox list for a database is evaluated on the Mailbox server. The processing speed is also calculated. The default value is 1 day. @@ -1727,7 +1880,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hou Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1737,6 +1889,9 @@ Accept wildcard characters: False ``` ### -RetentionLogForManagedFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The RetentionLogForManagedFoldersEnabled parameter specifies whether retention policy activity is recorded in the managed folder log on the Mailbox server. Valid input for this parameter is$true or $false. The default value is $false. @@ -1747,7 +1902,6 @@ If you specify $true, information about messages in managed folders that have be Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1757,6 +1911,9 @@ Accept wildcard characters: False ``` ### -SearchIndexRepairTimeBasedAssistantWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1765,7 +1922,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1775,6 +1931,9 @@ Accept wildcard characters: False ``` ### -SearchIndexRepairTimeBasedAssistantWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1783,7 +1942,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1793,6 +1951,9 @@ Accept wildcard characters: False ``` ### -SharePointSignalStoreWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1801,7 +1962,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1811,6 +1971,9 @@ Accept wildcard characters: False ``` ### -SharePointSignalStoreWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1819,7 +1982,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1829,6 +1991,9 @@ Accept wildcard characters: False ``` ### -SharingPolicySchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SharingPolicySchedule parameter specifies the intervals each week during which the sharing policy runs on the Mailbox server. The Sharing Policy Assistant checks permissions on shared calendar items and contact folders in users' mailboxes against the assigned sharing policy. The assistant lowers or removes permissions according to the policy. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. @@ -1856,7 +2021,6 @@ Here are some examples: Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1866,21 +2030,23 @@ Accept wildcard characters: False ``` ### -SharingPolicyWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The SharingPolicyWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be scanned by the Sharing Policy Assistant. The default value is 1 day. +The SharingPolicyWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server are scanned by the Sharing Policy Assistant. The default value is 1 day. -The Sharing Policy Assistant scans all mailboxes and enables or disables sharing polices according to the interval specified by the SharingPolicyWorkCycle. +The Sharing Policy Assistant scans all mailboxes and enables or disables sharing policies according to the interval specified by the SharingPolicyWorkCycle. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. -For example, to specify 2 days for this parameter, use 2.00:00:00. The Sharing Policy Assistant will then process all mailboxes on this server every 2 days. +For example, to specify 2 days for this parameter, use 2.00:00:00. The Sharing Policy Assistant then processes all mailboxes on this server every 2 days. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1890,21 +2056,23 @@ Accept wildcard characters: False ``` ### -SharingPolicyWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The SharingPolicyWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 1 day. +The SharingPolicyWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved are part of the work queue. The default value is 1 day. -Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle. +Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time are placed higher in the queue and have a greater chance of being processed again in the same work cycle. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. -For example, to specify 2 days for this parameter, use 2.00:00:00. The Sharing Policy Assistant will then process all mailboxes on this server every 2 days. +For example, to specify 2 days for this parameter, use 2.00:00:00. The Sharing Policy Assistant then processes all mailboxes on this server every 2 days. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1914,21 +2082,23 @@ Accept wildcard characters: False ``` ### -SharingSyncWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The SharingSyncWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be synced to the cloud-based service by the Sharing Sync Assistant. The default value is 3 hours. +The SharingSyncWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server are synced to the cloud-based service by the Sharing Sync Assistant. The default value is 3 hours. -Mailboxes that require syncing will be synced according to the interval specified by the SharingSyncWorkCycleCheckpoint parameter. +Mailboxes that require syncing are synced according to the interval specified by the SharingSyncWorkCycleCheckpoint parameter. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. -For example, to specify 8 hours for this parameter, use 08:00:00. The Sharing Sync Assistant will then process all mailboxes on this server every 8 hours. +For example, to specify 8 hours for this parameter, use 08:00:00. The Sharing Sync Assistant then processes all mailboxes on this server every 8 hours. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1938,21 +2108,23 @@ Accept wildcard characters: False ``` ### -SharingSyncWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The SharingSyncWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 3 hours. +The SharingSyncWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved are part of the work queue. The default value is 3 hours. -Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle. +Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time are placed higher in the queue and have a greater chance of being processed again in the same work cycle. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. -For example, to specify 8 hours for this parameter, use 08:00:00. The Sharing Sync Assistant will then process all mailboxes on this server every 8 hours. +For example, to specify 8 hours for this parameter, use 08:00:00. The Sharing Sync Assistant then processes all mailboxes on this server every 8 hours. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1962,9 +2134,12 @@ Accept wildcard characters: False ``` ### -SiteMailboxWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. -The SiteMailboxWorkCycle parameter specifies the time span in which the site mailbox information on the Mailbox server will be processed. The default value is 6 hours. +The SiteMailboxWorkCycle parameter specifies the time span in which the site mailbox information on the Mailbox server are processed. The default value is 6 hours. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. @@ -1974,7 +2149,6 @@ For example, to specify 8 hours for this parameter, use 08:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1984,6 +2158,9 @@ Accept wildcard characters: False ``` ### -SiteMailboxWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The SiteMailboxWorkCycleCheckpoint parameter specifies the time span at which to refresh the site mailbox workcycle on the Mailbox server. The default value is 6 hours. @@ -1996,7 +2173,6 @@ For example, to specify 8 hours for this parameter, use 08:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2006,6 +2182,9 @@ Accept wildcard characters: False ``` ### -StoreDsMaintenanceWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2014,7 +2193,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2024,6 +2202,9 @@ Accept wildcard characters: False ``` ### -StoreDsMaintenanceWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2032,7 +2213,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2042,6 +2222,9 @@ Accept wildcard characters: False ``` ### -StoreIntegrityCheckWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2050,7 +2233,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2060,6 +2242,9 @@ Accept wildcard characters: False ``` ### -StoreIntegrityCheckWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2068,7 +2253,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2078,6 +2262,9 @@ Accept wildcard characters: False ``` ### -StoreMaintenanceWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2086,7 +2273,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2096,6 +2282,9 @@ Accept wildcard characters: False ``` ### -StoreMaintenanceWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2104,7 +2293,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2114,6 +2302,9 @@ Accept wildcard characters: False ``` ### -StoreScheduledIntegrityCheckWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2122,7 +2313,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2132,6 +2322,9 @@ Accept wildcard characters: False ``` ### -StoreScheduledIntegrityCheckWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2140,7 +2333,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2150,6 +2342,9 @@ Accept wildcard characters: False ``` ### -StoreUrgentMaintenanceWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2158,7 +2353,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2168,6 +2362,9 @@ Accept wildcard characters: False ``` ### -StoreUrgentMaintenanceWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2176,7 +2373,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2186,6 +2382,9 @@ Accept wildcard characters: False ``` ### -SubjectLogForManagedFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The SubjectLogForManagedFoldersEnabled parameter specifies whether to include the subject of messages in the managed folder logs on the Mailbox server. Valid input for this parameter is$true or $false. The default value is $false. @@ -2196,7 +2395,6 @@ By default, the subject of messages is blank in the managed folder log. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2206,13 +2404,15 @@ Accept wildcard characters: False ``` ### -SubmissionServerOverrideList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2222,21 +2422,23 @@ Accept wildcard characters: False ``` ### -TopNWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The TopNWorkCycle parameter specifies the time span in which all mailboxes that have Unified Messaging on the Mailbox server will be scanned by the TopN Words Assistant. The default value is 7 days. +The TopNWorkCycle parameter specifies the time span in which all mailboxes that have Unified Messaging on the Mailbox server are scanned by the TopN Words Assistant. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. The TopN Words Assistant scans voice mail for the most frequently used words to aid in transcription. The most common words are then indexed according to the interval specified by the TopNWorkCycleCheckpoint parameter. -For example, to specify 10 days for this parameter, use 10.00:00:00. The TopN Words Assistant will then process all mailboxes on which Unified Messaging is enabled on this server every 10 days. +For example, to specify 10 days for this parameter, use 10.00:00:00. The TopN Words Assistant then processes all mailboxes on which Unified Messaging is enabled on this server every 10 days. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2246,21 +2448,23 @@ Accept wildcard characters: False ``` ### -TopNWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The TopNWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 1 day. +The TopNWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved are part of the work queue. The default value is 1 day. -Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle. +Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time are placed higher in the queue and have a greater chance of being processed again in the same work cycle. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. -For example, to specify 2 days for this parameter, use 2.00:00:00. The TopN Words Assistant will then process all mailboxes on this server every 2 days. +For example, to specify 2 days for this parameter, use 2.00:00:00. The TopN Words Assistant then processes all mailboxes on this server every 2 days. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2270,23 +2474,25 @@ Accept wildcard characters: False ``` ### -UMReportingWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The UMReportingWorkCycle parameter specifies the time span in which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} on the Mailbox server will be scanned by the Unified Messaging Reporting Assistant. The default value is 1 day. +The UMReportingWorkCycle parameter specifies the time span in which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} on the Mailbox server are scanned by the Unified Messaging Reporting Assistant. The default value is 1 day. The Unified Messaging Reporting Assistant updates the Call Statistics reports by reading Unified Messaging call data records for an organization on a regular basis. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. -For example, to specify 2 days for this parameter, use 2.00:00:00. The Unified Messaging Reporting Assistant will then process all mailboxes that have Unified Messaging enabled on this server every 2 days. +For example, to specify 2 days for this parameter, use 2.00:00:00. The Unified Messaging Reporting Assistant then processes all mailboxes that have Unified Messaging enabled on this server every 2 days. -Changing the default work cycle for this assistant might impact the performance of the Mailbox server. +Changing the default work cycle for this assistant might affect the performance of the Mailbox server. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2296,9 +2502,12 @@ Accept wildcard characters: False ``` ### -UMReportingWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. -The UMReportingWorkCycleCheckpoint parameter specifies the time span at which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} on the Mailbox server will be marked by processing. The default value is 1 day. +The UMReportingWorkCycleCheckpoint parameter specifies the time span at which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} on the Mailbox server are marked by processing. The default value is 1 day. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. @@ -2308,7 +2517,6 @@ For example, to specify 2 days for this parameter, use 2.00:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2318,6 +2526,9 @@ Accept wildcard characters: False ``` ### -WacDiscoveryEndpoint + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WacDiscoveryEndpoint parameter specifies the discovery endpoint for Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server) for all mailboxes on the server. For example, `https://oos.internal.contoso.com/hosting/discovery`. Office Online Server enables users to view supported file attachments in Outlook on the web (formerly known as Outlook Web App). @@ -2326,7 +2537,6 @@ Office Online Server enables users to view supported file attachments in Outlook Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2336,13 +2546,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSpellingConfiguration.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxSpellingConfiguration.md index 975a5bcb45..21303b2650 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSpellingConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxspellingconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxSpellingConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxspellingconfiguration +schema: 2.0.0 +title: Set-MailboxSpellingConfiguration --- # Set-MailboxSpellingConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MailboxSpellingConfiguration cmdlet to modify Outlook on the web spelling checker options for a specified user. For example, you can set the dictionary language and configure the spelling checker to ignore mixed digits or words in all uppercase. @@ -33,7 +34,7 @@ Set-MailboxSpellingConfiguration [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example sets the spelling checker to ignore words containing numbers for me ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -71,7 +75,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -CheckBeforeSend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CheckBeforeSend parameter specifies whether Outlook on the web checks the spelling for every message when the user clicks Send in the new message form. Valid values are$true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -106,7 +114,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -DictionaryLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DictionaryLanguage parameter specifies the dictionary language to use when the spelling checker checks the spelling in messages. Valid values are: - Arabic @@ -144,7 +154,6 @@ The DictionaryLanguage parameter specifies the dictionary language to use when t Type: SpellCheckerSupportedLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -162,7 +174,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -IgnoreMixedDigits + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreMixedDigits parameter specifies whether the spelling checker ignores words that contain numbers. Valid values are $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -IgnoreUppercase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreUppercase parameter specifies whether the spelling checker ignores words that contain only uppercase letters, for example, acronyms. Valid values are $true or $false. The default value is $false. @@ -196,7 +212,6 @@ Valid values are $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxTransportService.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxTransportService.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-MailboxTransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxTransportService.md index ae787b004f..d36117eb6e 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxTransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxTransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxtransportservice -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxTransportService -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxtransportservice +schema: 2.0.0 +title: Set-MailboxTransportService --- # Set-MailboxTransportService @@ -71,7 +72,7 @@ Set-MailboxTransportService [-Identity] ## DESCRIPTION The Mailbox Transport service runs on all Mailbox servers and is responsible for delivering messages to and accepting messages from local mailbox databases using a remote procedure call (RPC). The Mailbox Transport service also uses SMTP to send messages to and from the Transport service that runs on all Mailbox servers for routing messages to their ultimate destinations. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -85,13 +86,15 @@ This example sets the ReceiveProtocolLogPath parameter to C:\\SMTP Protocol Logs ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server that you want to modify. ```yaml Type: MailboxTransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -110,7 +116,6 @@ 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 Required: False Position: Named @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxAge parameter specifies the maximum age for the connectivity log file. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -146,7 +156,6 @@ For example, to specify 25 days for this parameter, use 25.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +165,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all connectivity logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 1000 MB. When you enter a value, qualify the value with one of the following units: @@ -166,7 +178,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ConnectivityLogMaxFileSize parameter must be less than or equal to the value of the ConnectivityLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the connectivity log directory. @@ -174,7 +186,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxFileSize parameter specifies the maximum size of each connectivity log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -194,7 +208,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ConnectivityLogMaxFileSize parameter must be less than or equal to the value of the ConnectivityLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the connectivity log files. @@ -202,7 +216,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,13 +225,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\Connectivity. Setting the value of this parameter to $null disables connectivity logging. However, setting this parameter to $null when the value of the ConnectivityLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +243,9 @@ Accept wildcard characters: False ``` ### -ContentConversionTracingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service or in the Mailbox Transport service on the Mailbox server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of email messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: - Administrators: Full Control @@ -238,7 +256,6 @@ The ContentConversionTracingEnabled parameter specifies whether content conversi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,13 +265,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +283,15 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryAgentLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryAgentLogEnabled parameter specifies whether the agent log for the Mailbox Transport Delivery service is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryAgentLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryAgentLogMaxAge parameter specifies the maximum age for the agent log file of the Mailbox Transport Delivery service. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -290,7 +314,6 @@ Setting the value of the MailboxDeliveryAgentLogMaxAge parameter to 00:00:00 pre Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,6 +323,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryAgentLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryAgentLogMaxDirectorySize parameter specifies the maximum size of all Mailbox Transport Delivery service agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -310,7 +336,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the MailboxDeliveryAgentLogMaxFileSize parameter must be less than or equal to the value of the MailboxDeliveryAgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log directory. @@ -318,7 +344,6 @@ The value of the MailboxDeliveryAgentLogMaxFileSize parameter must be less than Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -328,6 +353,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryAgentLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryAgentLogMaxFileSize parameter specifies the maximum size of each agent log file for the Mailbox Transport Delivery service. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -338,7 +366,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the MailboxDeliveryAgentLogMaxFileSize parameter must be less than or equal to the value of the MailboxDeliveryAgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log files. @@ -346,7 +374,6 @@ The value of the MailboxDeliveryAgentLogMaxFileSize parameter must be less than Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +383,15 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryAgentLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryAgentLogPath parameter specifies the default agent log directory location for the Mailbox Transport Delivery service. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\AgentLog\\Delivery. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the MailboxDeliveryAgentLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -372,13 +401,15 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryConnectorMaxInboundConnection + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryConnectorMaxInboundConnection parameter specifies the maximum number of inbound connections for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. The default value is 5000. If you enter the value unlimited, no connection limit is imposed on the mailbox delivery Receive connector. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -388,16 +419,18 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryConnectorProtocolLoggingLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. Valid values are: -- None: Protocol logging is disabled for the mailbox delivery Receive connector. This is the default value. +- None: Protocol logging is disabled for the mailbox delivery Receive connector. This value is the default. - Verbose: Protocol logging is enabled for the mailbox delivery Receive connector. The location of the log files is controlled by the ReceiveProtocolLogPath parameter. ```yaml Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -407,16 +440,18 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryConnectorSmtpUtf8Enabled + +> Applicable: Exchange Server 2019, Exchange Server SE + The MailboxDeliveryConnectorSmtpUtf8Enabled parameters or disables email address internationalization (EAI) support for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. Valid values are: -- $true: Mail can be delivered to local mailboxes that have international characters in email addresses. This is the default value +- $true: Mail can be delivered to local mailboxes that have international characters in email addresses. This value is the default - $false: Mail can't be delivered to local mailboxes that have international characters in email addresses. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -426,13 +461,15 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryThrottlingLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryThrottlingLogEnabled parameter specifies whether the mailbox delivery throttling log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -442,6 +479,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryThrottlingLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryThrottlingLogMaxAge parameter specifies the maximum age for the mailbox delivery throttling log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -452,7 +492,6 @@ Setting the value of the MailboxDeliveryThrottlingLogMaxAge parameter to 00:00:0 Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -462,6 +501,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryThrottlingLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryThrottlingLogMaxDirectorySize parameter specifies the maximum size of all mailbox delivery throttling logs in the mailbox delivery throttling log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 200 MB. When you enter a value, qualify the value with one of the following units: @@ -472,7 +514,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the MailboxDeliveryThrottlingLogMaxFileSize parameter must be less than or equal to the value of the MailboxDeliveryThrottlingLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the mailbox delivery throttling log directory. @@ -480,7 +522,6 @@ The value of the MailboxDeliveryThrottlingLogMaxFileSize parameter must be less Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -490,6 +531,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryThrottlingLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryThrottlingLogMaxFileSize parameter specifies the maximum size of each mailbox delivery throttling log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -500,7 +544,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the MailboxDeliveryThrottlingLogMaxFileSize parameter must be less than or equal to the value of the MailboxDeliveryThrottlingLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the mailbox delivery throttling log files. @@ -508,7 +552,6 @@ The value of the MailboxDeliveryThrottlingLogMaxFileSize parameter must be less Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -518,13 +561,15 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryThrottlingLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxDeliveryThrottlingLogPath parameter specifies the default mailbox delivery throttling log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Throttling\\Delivery. Setting the value of this parameter to $null disables mailbox delivery throttling logging. However, setting this parameter to $null when the value of the MailboxDeliveryThrottlingLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -534,13 +579,15 @@ Accept wildcard characters: False ``` ### -MailboxSubmissionAgentLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxSubmissionAgentLogEnabled parameter specifies whether the agent log is enabled for the Mailbox Transport Submission service. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -550,6 +597,9 @@ Accept wildcard characters: False ``` ### -MailboxSubmissionAgentLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxSubmissionAgentLogMaxAge parameter specifies the maximum age for the agent log file of the Mailbox Transport Submission service. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -560,7 +610,6 @@ Setting the value of the MailboxSubmissionAgentLogMaxAge parameter to 00:00:00 p Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -570,6 +619,9 @@ Accept wildcard characters: False ``` ### -MailboxSubmissionAgentLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxSubmissionAgentLogMaxDirectorySize parameter specifies the maximum size of all Mailbox Transport Submission service agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -580,7 +632,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the MailboxSubmissionAgentLogMaxFileSize parameter must be less than or equal to the value of the MailboxSubmissionAgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log directory. @@ -588,7 +640,6 @@ The value of the MailboxSubmissionAgentLogMaxFileSize parameter must be less tha Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -598,6 +649,9 @@ Accept wildcard characters: False ``` ### -MailboxSubmissionAgentLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxSubmissionAgentLogMaxFileSize parameter specifies the maximum size of each agent log file for the Mailbox Transport Submission service. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -608,7 +662,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the MailboxSubmissionAgentLogMaxFileSize parameter must be less than or equal to the value of the MailboxSubmissionAgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log files. @@ -616,7 +670,6 @@ The value of the MailboxSubmissionAgentLogMaxFileSize parameter must be less tha Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -626,13 +679,15 @@ Accept wildcard characters: False ``` ### -MailboxSubmissionAgentLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxSubmissionAgentLogPath parameter specifies the default agent log directory location for the Mailbox Transport Submission service. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\AgentLog\\Submission. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the MailboxSubmissionAgentLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -642,13 +697,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxDeliveries + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConcurrentMailboxDeliveries parameter specifies the maximum number of delivery threads that the transport service can have open at the same time to deliver messages to mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. We recommend that you don't modify the default value unless Microsoft Customer Service and Support advises you to do this. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -658,13 +715,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxSubmissions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConcurrentMailboxSubmissions parameter specifies the maximum number of submission threads that the transport service can have open at the same time to send messages from mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -674,13 +733,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PipelineTracingEnabled parameter specifies whether to enable pipeline tracing. Pipeline tracing captures message snapshot files that record the changes made to the message by each transport agent configured in the transport service on the server. Pipeline tracing creates verbose log files that accumulate quickly. Pipeline tracing should only be enabled for a short time to provide in-depth diagnostic information that enables you to troubleshoot problems. In addition to troubleshooting, you can use pipeline tracing to validate changes that you make to the configuration of the transport service where you enable pipeline tracing. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -690,6 +751,9 @@ Accept wildcard characters: False ``` ### -PipelineTracingPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PipelineTracingPath parameter specifies the location of the pipeline tracing logs. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\PipelineTracing. The path must be local to the Exchange server. Setting this parameter to the value $null disables pipeline tracing. However, setting this parameter to $null when the value of the PipelineTracingEnabled attribute is $true generates event log errors. The preferred method to disable pipeline tracing is to use the PipelineTracingEnabled parameter. @@ -704,7 +768,6 @@ Pipeline tracing captures the complete contents of email messages to the path sp Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -714,13 +777,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingSenderAddress -The PipelineTracingSenderAddress parameter specifies the sender email address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PipelineTracingSenderAddress parameter specifies the sender email address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you might have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -730,6 +795,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxAge parameter specifies the maximum age of a protocol log file for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. Log files that are older than the specified value are automatically deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -744,7 +812,6 @@ This parameter is only meaningful when the MailboxDeliveryConnectorProtocolLoggi Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -754,6 +821,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -766,7 +836,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be greater than or equal to the value of the ReceiveProtocolLogMaxFileSize parameter. @@ -776,7 +846,6 @@ This parameter is only meaningful when the MailboxDeliveryConnectorProtocolLoggi Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -786,6 +855,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -798,7 +870,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be less than or equal to the value of the ReceiveProtocolLogMaxDirectorySize parameter. @@ -808,7 +880,6 @@ This parameter is only meaningful when the MailboxDeliveryConnectorProtocolLoggi Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -818,6 +889,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogPath parameter specifies the location of the protocol log directory for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\ProtocolLog\\SmtpReceive. The log files are automatically stored in the Delivery subdirectory. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for the mailbox delivery Receive connector. To disable protocol logging for this connector, use the value None for the MailboxDeliveryConnectorProtocolLoggingLevel parameter. @@ -826,7 +900,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -836,6 +909,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxAge + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogMaxAge parameter specifies the maximum routing table log age. Log files older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -846,7 +922,6 @@ For example, to specify 5 days for this parameter, use 5.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -856,6 +931,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxDirectorySize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the routing table log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -866,7 +944,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the routing table log directory. @@ -874,7 +952,6 @@ The valid input range for this parameter is from 1 through 9223372036854775807 b Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -884,13 +961,15 @@ Accept wildcard characters: False ``` ### -RoutingTableLogPath + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\Routing. Setting this parameter to $null disables routing table logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -900,6 +979,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxAge parameter specifies the maximum age of a protocol log file for the implicit and invisible intra-organization Send connector in the Mailbox Transport Submission service. Log files that are older than the specified value are automatically deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -912,7 +994,6 @@ This parameter is only meaningful when the IntraOrgConnectorProtocolLoggingLevel Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -922,6 +1003,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory for the implicit and invisible intra-organization Send connector in the Mailbox Transport Submission service. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -934,7 +1018,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be less than or equal to the value of the SendProtocolLogMaxDirectorySize parameter. @@ -944,7 +1028,6 @@ This parameter is only meaningful when the IntraOrgConnectorProtocolLoggingLevel Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -954,6 +1037,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file for the implicit and invisible intra-organization Send connector in the Mailbox Transport Submission service. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -966,7 +1052,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value this parameter must be less than or equal to the value of the SendProtocolLogMaxDirectorySize parameter. @@ -976,7 +1062,6 @@ This parameter is only meaningful when the IntraOrgConnectorProtocolLoggingLevel Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -986,6 +1071,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogPath parameter specifies the location of the protocol log directory for the implicit and invisible intra-organization Send connector in the Mailbox Transport Submission service. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\ProtocolLog\\SmtpSend. Log files are automatically stored in the following subdirectories: - Submission: Protocol log files for the intra-organization Send connector in the Mailbox Transport Submission service. @@ -997,7 +1085,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1007,13 +1094,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterPolicy.md index 97910b18d9..4bcf5151bb 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-malwarefilterpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MalwareFilterPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-malwarefilterpolicy +schema: 2.0.0 +title: Set-MalwareFilterPolicy --- # Set-MalwareFilterPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MalwareFilterPolicy cmdlet to modify malware filter policies in your organization. @@ -54,7 +55,7 @@ Set-MalwareFilterPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,6 +103,9 @@ The last two commands remove the seventh file type that's displayed in the list. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter policy you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -112,7 +116,6 @@ The Identity parameter specifies the malware filter policy you want to modify. Y Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -122,11 +125,14 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Action parameter specifies the action to take when malware is detected in a message. Valid values are: -- DeleteMessage: Handles the message without notifying the recipients. This is the default value. +- DeleteMessage: Handles the message without notifying the recipients. This value is the default. - DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. - DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. @@ -134,7 +140,6 @@ The Action parameter specifies the action to take when malware is detected in a Type: MalwareFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +149,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,18 +167,20 @@ Accept wildcard characters: False ``` ### -BypassInboundMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BypassInboundMessages parameter enables or disables malware filtering on incoming messages (messages entering the organization). Valid values are: - $true: Malware filtering is disabled on inbound messages. -- $false: Malware filtering is enabled on inbound messages. This is the default value. +- $false: Malware filtering is enabled on inbound messages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,18 +190,20 @@ Accept wildcard characters: False ``` ### -BypassOutboundMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The BypassOutboundMessages parameter enables or disables malware filtering on outgoing messages (messages leaving the organization). Valid values are: - $true: Malware filtering is disabled on outbound messages. -- $false: Malware filtering is enabled on outbound messages. This is the default value. +- $false: Malware filtering is enabled on outbound messages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -211,7 +225,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -221,6 +234,9 @@ Accept wildcard characters: False ``` ### -CustomAlertText + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). @@ -231,7 +247,6 @@ This parameter is meaningful only when the value of the Action parameter is Dele Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +256,9 @@ Accept wildcard characters: False ``` ### -CustomExternalBody + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -252,7 +270,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -262,6 +279,9 @@ Accept wildcard characters: False ``` ### -CustomExternalSubject + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomExternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is 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: @@ -273,7 +293,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -283,6 +302,9 @@ Accept wildcard characters: False ``` ### -CustomFromAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomFromAddress parameter specifies the custom From address to use in notification messages for malware detections in messages from internal or external senders. This parameter is 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: @@ -296,7 +318,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -306,6 +327,9 @@ Accept wildcard characters: False ``` ### -CustomFromName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomFromName parameter specifies the custom From name to use in notification messages for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is 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: @@ -319,7 +343,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -329,6 +352,9 @@ Accept wildcard characters: False ``` ### -CustomInternalBody + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomInternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is 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: @@ -340,7 +366,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -350,6 +375,9 @@ Accept wildcard characters: False ``` ### -CustomInternalSubject + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomInternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is 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: @@ -361,7 +389,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -371,6 +398,9 @@ Accept wildcard characters: False ``` ### -CustomNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomNotifications parameter enables or disables the customization of notification messages for malware detections. Valid values are: - $true: Replace the default values used in notification messages with the values of the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. @@ -387,7 +417,6 @@ This parameter is meaningful only when the value of at least one of the followin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -397,6 +426,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -405,7 +437,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -415,10 +446,13 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderAdminNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: - $true: When malware attachments are detected in messages from external senders, a notification messages is sent to the email address that's specified by the ExternalSenderAdminAddress parameter. -- $false: Notifications aren't sent for malware attachment detections in messages from external senders. This is the default value. +- $false: Notifications aren't sent for malware attachment detections in messages from external senders. This value is the default. **Note**: Admin notifications are sent only for _attachments_ that are classified as malware. @@ -426,7 +460,6 @@ The EnableExternalSenderAdminNotifications parameter enables or disables sending Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -436,18 +469,20 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EnableExternalSenderNotifications parameter enables or disables sending notification messages to external senders for malware detections in their messages. Valid values are: - $true: When malware is detected in a message from an external sender, send them a notification message. -- $false: Don't send malware detection notification messages to external message senders. This is the default value. +- $false: Don't send malware detection notification messages to external message senders. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -457,11 +492,14 @@ Accept wildcard characters: False ``` ### -EnableFileFilter + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The EnableFileFilter parameter enables or disables the common attachments filter (also known as common attachment blocking). Valid values are: -- $true: The common attachments filter is enabled. This is the default value. +- $true: The common attachments filter is enabled. This value is the default. - $false: The common attachments filter is disabled. You specify the file types using the FileTypes parameter. @@ -472,7 +510,6 @@ You specify the action for detected files using the FileTypeAction parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -482,10 +519,13 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderAdminNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The EnableInternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: - $true: When malware attachments are detected in messages from internal senders, a notification messages is sent to the email address that's specified by the InternalSenderAdminAddress parameter. -- $false: Notifications aren't sent for malware attachment detections in messages from internal senders. This is the default value. +- $false: Notifications aren't sent for malware attachment detections in messages from internal senders. This value is the default. **Note**: Admin notifications are sent only for _attachments_ that are classified as malware. @@ -493,7 +533,6 @@ The EnableInternalSenderAdminNotifications parameter enables or disables sending Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -503,18 +542,20 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EnableInternalSenderNotifications parameter enables or disables sending notification messages to internal senders for malware detections in their messages. Valid values are: - $true: When malware is detected in a message from an internal sender, send them a notification message. -- $false: Don't send malware detection notification messages to internal message senders. This is the default value. +- $false: Don't send malware detection notification messages to internal message senders. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -524,6 +565,9 @@ Accept wildcard characters: False ``` ### -ExternalSenderAdminAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from external senders. This parameter is meaningful only if the value of the EnableExternalSenderAdminNotifications parameter is $true. @@ -532,7 +576,6 @@ This parameter is meaningful only if the value of the EnableExternalSenderAdminN Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -542,12 +585,15 @@ Accept wildcard characters: False ``` ### -FileTypeAction + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The FileTypeAction parameter specifies what happens to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: - Quarantine: Quarantine the message. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the malware filter policy by the QuarantineTag parameter. -- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This is the default value. +- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This value is the default. This parameter is meaningful only when the value of the EnableFileFilter parameter is $true. @@ -555,7 +601,6 @@ This parameter is meaningful only when the value of the EnableFileFilter paramet Type: FileTypeFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -565,6 +610,9 @@ Accept wildcard characters: False ``` ### -FileTypes + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The FileTypes parameter specifies the file types that are automatically blocked by the common attachments filter, regardless of content. The default values are: @@ -583,7 +631,6 @@ To add or remove file types without affecting the other file type entries, see t Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -593,6 +640,9 @@ Accept wildcard characters: False ``` ### -InternalSenderAdminAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The InternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from internal senders. This parameter is meaningful only if the value of the EnableInternalSenderAdminNotifications parameter is $true. @@ -601,7 +651,6 @@ This parameter is meaningful only if the value of the EnableInternalSenderAdminN Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -611,13 +660,15 @@ Accept wildcard characters: False ``` ### -IsPolicyOverrideApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -627,6 +678,9 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MakeDefault switch makes this malware filter policy the default policy. You don't need to specify a value with this switch. The default malware filter policy has no recipient filters (is applied to everyone) and has the Priority value Lowest. @@ -635,7 +689,6 @@ The default malware filter policy has no recipient filters (is applied to everyo Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -645,6 +698,9 @@ Accept wildcard characters: False ``` ### -QuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware. You can use any value that uniquely identifies the quarantine policy. For example: @@ -663,7 +719,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -673,13 +728,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -689,18 +746,20 @@ Accept wildcard characters: False ``` ### -ZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ZapEnabled parameter enables or disables zero-hour auto purge (ZAP) for malware in cloud mailboxes. ZAP detects malware in unread messages that have already been delivered to the user's Inbox. Valid values are: -- $true: ZAP for malware is enabled. This is the default value. In Exchange Server, unread messages in the user's Inbox that contain malware are moved to the Junk Email folder. In the cloud-based service, the messages are quarantined. +- $true: ZAP for malware is enabled. This value is the default. In Exchange Server, unread messages in the user's Inbox that contain malware are moved to the Junk Email folder. In the cloud-based service, the messages are quarantined. - $false: ZAP for malware is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterRule.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterRule.md index 9589a6fc72..4d1d9b9479 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-malwarefilterrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MalwareFilterRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-malwarefilterrule +schema: 2.0.0 +title: Set-MalwareFilterRule --- # Set-MalwareFilterRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MalwareFilterRule cmdlet to modify malware filter rules in your organization. @@ -42,7 +43,7 @@ Set-MalwareFilterRule [-Identity] > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Anti-malware policies](https://learn.microsoft.com/defender-office-365/anti-malware-protection-about#anti-malware-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,13 +57,15 @@ This example adds an exception to the malware filter rule named Contoso Recipien ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID, or distinguished name (DN) of the malware filter rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -115,7 +125,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -141,6 +152,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -156,7 +170,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -183,7 +199,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -193,6 +208,9 @@ Accept wildcard characters: False ``` ### -MalwareFilterPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule. You can use any value that uniquely identifies the policy. For example: @@ -207,7 +225,6 @@ You can't specify the default malware filter policy, and you can't specify a pol Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -217,13 +234,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the malware filter rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +252,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -247,7 +269,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,13 +278,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -273,6 +296,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -288,7 +314,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -298,6 +323,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -315,7 +343,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -325,13 +352,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilteringServer.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilteringServer.md index 5766c7970f..fa0f636452 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilteringServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-malwarefilteringserver -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MalwareFilteringServer -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-malwarefilteringserver +schema: 2.0.0 +title: Set-MalwareFilteringServer --- # Set-MalwareFilteringServer @@ -40,7 +41,7 @@ Set-MalwareFilteringServer [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,6 +58,9 @@ This example sets the following Malware agent settings on the Mailbox server nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server where you want to configure the anti-malware settings. You can use any value that uniquely identifies the server. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the server where you want to configure the anti Type: MalwareFilteringServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -BypassFiltering + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BypassFiltering parameter temporarily bypasses malware filtering without disabling the Malware agent on the server. The Malware agent is still active, and the agent is still called for every message, but no malware filtering is actually performed. This allows you to temporarily disable and then enable malware filtering on the server without disrupting mail flow by restarting the Microsoft Exchange Transport service. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -103,7 +111,6 @@ 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 Required: False Position: Named @@ -113,15 +120,17 @@ Accept wildcard characters: False ``` ### -DeferAttempts + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeferAttempts parameter specifies the maximum number of times to defer a message that can't be scanned by the Malware agent. Valid input for this parameter is an integer between 1 and 5. The default value is 3. -After the maximum number of deferrals is reached, the action taken by the Malware agent depends on the error. For scan timeouts and engine errors, the action is to fail the message and return a non-delivery report (NDR) to the sender immediately after the last defer attempt. For all other errors, the message is retried for up to 48 hours, with each retry attempt taking place one hour longer than the last one. For example, starting after the last defer attempt, the first retry attempt will occur in 1 hour, the next retry attempt will occur 2 hours after that, the next retry attempt will occur 3 hours after the second retry attempt, and so on for up to 48 hours. After 48 hours have elapsed, the action is to fail the message and return a non-delivery report (NDR) to the sender. +After the maximum number of deferrals is reached, the action taken by the Malware agent depends on the error. For scan timeouts and engine errors, the action is to fail the message and return a non-delivery report (NDR) to the sender immediately after the last defer attempt. For all other errors, the message is retried for up to 48 hours, with each retry attempt taking place one hour longer than the last one. For example, starting after the last defer attempt, the first retry attempt occurs in 1 hour, the next retry attempt occurs 2 hours after that, the next retry attempt occurs 3 hours after the second retry attempt, and so on for up to 48 hours. After 48 hours have elapsed, the action is to fail the message and return a non-delivery report (NDR) to the sender. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -DeferWaitTime + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeferWaitTime parameter specifies the time period in minutes to increase the interval to resubmit messages for malware filtering in an effort to reduce the workload on the server. For example, the first retry after the original failed scan occurs after the interval specified by the DeferWaitTime parameter. The second retry after the first retry occurs after two times the value of the DeferWaitTime parameter. The third retry after the second retry occurs after three times the value of the DeferWaitTime parameter and so on. The maximum number of retries is controlled by the DeferAttempts parameter. @@ -141,7 +153,6 @@ Valid input for this parameter is an integer between 0 and 15. The default value Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -159,7 +173,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,13 +182,18 @@ Accept wildcard characters: False ``` ### -ForceRescan -The ForceRescan parameter specifies that messages should be scanned by the malware agent, even if the message was already scanned by Exchange Online Protection. Valid input for this parameter is $true or $false. The default value is $false. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ForceRescan parameter specifies that messages should be scanned by the malware agent, even if the message was already scanned by cloud-based protection. Valid values are: + +- $true: Messages from cloud-based organizations are scanned by the malware agent. +- $false: Messages from cloud-based organizations aren't scanned by the malware agent. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,13 +203,15 @@ Accept wildcard characters: False ``` ### -MinimumSuccessfulEngineScans + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,13 +221,15 @@ Accept wildcard characters: False ``` ### -PrimaryUpdatePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PrimaryUpdatePath parameter specifies where to download malware scanning engine updates. The default value is `http://forefrontdl.microsoft.com/server/scanengineupdate`. The location specified by the PrimaryUpdatePath parameter is always tried first. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,13 +239,15 @@ Accept wildcard characters: False ``` ### -ScanErrorAction + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ScanErrorAction parameter specifies the action to take when a message can't be scanned by the malware filter. Valid values for this parameter are Block or Allow. The default value is Block. ```yaml Type: MalwareScanErrorAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,13 +257,15 @@ Accept wildcard characters: False ``` ### -ScanTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ScanTimeout parameter specifies the timeout interval in seconds for messages that can't be scanned by the malware filter. Valid input for this parameter is an integer between 10 and 900. The default value is 300 (5 minutes). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -249,6 +275,9 @@ Accept wildcard characters: False ``` ### -SecondaryUpdatePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SecondaryUpdatePath parameter specifies an alternate download location for malware scanning engine updates. The default values is blank ($null). This means no alternate download location is specified. The alternate download location is used when the location specified by the PrimaryUpdatePath parameter is unavailable for the time period specified by the UpdateTimeout parameter. On the next malware scanning engine update, the location specified by the PrimaryUpdate path parameter is tried first. @@ -257,7 +286,6 @@ The alternate download location is used when the location specified by the Prima Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -267,13 +295,15 @@ Accept wildcard characters: False ``` ### -UpdateFrequency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UpdateFrequency parameter specifies the frequency interval in minutes to check for malware scanning engine updates. Valid input for this parameter is an integer between 1 and 38880 (27 days). The default value is 60 (one hour). The locations to check for updates are specified by the PrimaryUpdatePath and SecondaryUpdatePath parameters. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -283,6 +313,9 @@ Accept wildcard characters: False ``` ### -UpdateTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UpdateTimeout parameter specifies the timeout interval in seconds to use when checking for malware scanning engine updates. Valid input for this parameter is an integer between 60 and 300. The default value is 150 seconds (2.5 minutes). If the location specified by the PrimaryUpdatePath parameter is unavailable for the time period specified by the UpdateTimeout parameter value, the location specified by the SecondaryUpdatePath parameter is used. @@ -291,7 +324,6 @@ If the location specified by the PrimaryUpdatePath parameter is unavailable for Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -301,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedContentSettings.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-ManagedContentSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagedContentSettings.md index 9606389193..575e6d948f 100644 --- a/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedContentSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managedcontentsettings applicable: Exchange Server 2010 -title: Set-ManagedContentSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managedcontentsettings +schema: 2.0.0 +title: Set-ManagedContentSettings --- # Set-ManagedContentSettings @@ -41,9 +42,9 @@ Set-ManagedContentSettings [-Identity] ## DESCRIPTION Managed content settings are settings that you apply to managed folders to control the lifespan of items in users' mailboxes. For more information about managed content settings, see [Messaging Records Management](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123507(v=exchg.141)). -Although the New-ManagedContentSettings cmdlet has the MessageClass parameter, the Set-ManagedContentSettings cmdlet doesn't. If you want to change the message type to which content settings apply, you must delete and then re-create the content settings. For more information about the MessageClass parameter, see [New-ManagedContentSettings](https://learn.microsoft.com/powershell/module/exchange/new-managedcontentsettings). +Although the New-ManagedContentSettings cmdlet has the MessageClass parameter, the Set-ManagedContentSettings cmdlet doesn't. If you want to change the message type to which content settings apply, you must delete and then re-create the content settings. For more information about the MessageClass parameter, see [New-ManagedContentSettings](https://learn.microsoft.com/powershell/module/exchangepowershell/new-managedcontentsettings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +58,15 @@ This example specifies the address of the journaling recipient that's the destin ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed content settings. ```yaml Type: ELCContentSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -AddressForJournaling + +> Applicable: Exchange Server 2010 + The AddressForJournaling parameter specifies the journaling recipient where journaled messages are sent. You can use any value that uniquely identifies the recipient. For example: - Name @@ -86,7 +92,6 @@ The AddressForJournaling parameter specifies the journaling recipient where jour Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -AgeLimitForRetention + +> Applicable: Exchange Server 2010 + The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date that the item was delivered or the date that an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. @@ -104,7 +112,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -123,7 +133,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -JournalingEnabled + +> Applicable: Exchange Server 2010 + The JournalingEnabled parameter specifies that journaling is enabled when it's set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -LabelForJournaling + +> Applicable: Exchange Server 2010 + The LabelForJournaling parameter specifies a label that's attached to an item. This label is used by the destination store to determine the content of the item and enforce the appropriate policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -181,6 +196,9 @@ Accept wildcard characters: False ``` ### -MessageFormatForJournaling + +> Applicable: Exchange Server 2010 + The MessageFormatForJournaling parameter specifies the format in which an item should be journaled in. You can use the following values: - UseMsg Microsoft Outlook .MSG format @@ -190,7 +208,6 @@ The MessageFormatForJournaling parameter specifies the format in which an item s Type: JournalingFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -200,13 +217,15 @@ Accept wildcard characters: False ``` ### -MoveToDestinationFolder + +> Applicable: Exchange Server 2010 + The MoveToDestinationFolder parameter specifies the name of the destination folder for a retention action. ```yaml Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -216,13 +235,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies a unique name for the managed content settings. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -232,6 +253,9 @@ Accept wildcard characters: False ``` ### -RetentionAction + +> Applicable: Exchange Server 2010 + The RetentionAction parameter specifies one of the following actions to take when an item reaches its retention age limit, specified by the AgeLimitForRetention parameter. The following retention actions can be used: - Mark as past retention limit @@ -246,7 +270,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -256,13 +279,15 @@ Accept wildcard characters: False ``` ### -RetentionEnabled + +> Applicable: Exchange Server 2010 + The RetentionEnabled parameter specifies that retention is enabled when it's set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -272,6 +297,9 @@ Accept wildcard characters: False ``` ### -TriggerForRetention + +> Applicable: Exchange Server 2010 + The TriggerForRetention parameter specifies the date that's considered as the start date of the retention period. An item can reach its retention limit a specific number of days after the item was delivered or after it was moved into a specific folder. Valid values include: @@ -285,7 +313,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionDateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -295,13 +322,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagedFolder.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolder.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-ManagedFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolder.md index aef4960fcd..a184b0b51e 100644 --- a/exchange/exchange-ps/exchange/Set-ManagedFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managedfolder applicable: Exchange Server 2010 -title: Set-ManagedFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managedfolder +schema: 2.0.0 +title: Set-ManagedFolder --- # Set-ManagedFolder @@ -41,7 +42,7 @@ The Set-ManagedFolder cmdlet modifies the specified parameters of a managed fold The Set-ManagedFolder cmdlet accepts a managed custom folder or an identity string as pipelined input. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example sets the storage quota for the managed folder MyManagedFolder to 10 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder. ```yaml Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -BaseFolderOnly + +> Applicable: Exchange Server 2010 + The BaseFolderOnly parameter specifies whether the managed content settings should be applied only to the managed folder or to the folder and all its subfolders. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010 + The Comment parameter specifies the default administrator comment to be displayed with the folder in Microsoft Office Outlook 2007. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -112,7 +122,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -FolderName + +> Applicable: Exchange Server 2010 + The FolderName parameter specifies the name of the folder object as it appears in users' mailboxes. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -LocalizedComment + +> Applicable: Exchange Server 2010 + The LocalizedComment parameter specifies localized administrator comments and their languages. Localized comments are displayed instead of the default comment when the language setting of any client that displays comments matches a language specified for this parameter value. Comments must be in the form ISOLanguageCode:Comment, for example, -LocalizedComment EN-US:"This is a localized comment in U.S. English." ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -170,13 +185,15 @@ Accept wildcard characters: False ``` ### -LocalizedFolderName + +> Applicable: Exchange Server 2010 + The LocalizedFolderName parameter specifies localized folder names and their languages. Localized folder names are displayed instead of the default folder name when the language setting of Outlook 2007 matches a language specified for this parameter value. Comments must be in the form ISOLanguageCode:Comment, for example, -LocalizedFolderName EN-US:"This is a localized folder name in U.S. English." ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -186,13 +203,15 @@ Accept wildcard characters: False ``` ### -MustDisplayCommentEnabled + +> Applicable: Exchange Server 2010 + The MustDisplayCommentEnabled parameter specifies whether to set a flag that's used by any client that displays comments and accepts this setting. If this parameter is set to $true, a flag is set that prevents users from minimizing a folder comment, which is visible in Outlook 2007 only. If the parameter isn't present or is set to $false, users can minimize the comment. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -202,13 +221,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies a unique name for the content settings. The Name parameter doesn't appear in users' mailboxes. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -218,13 +239,15 @@ Accept wildcard characters: False ``` ### -StorageQuota -The StorageQuota parameter specifies the storage size limit for the mailbox folder. When the folder size exceeds this limit, no additional items may be added. Mailbox sizes can be specified in kilobytes (KB) or megabytes (MB), for example, as 100KB or 5MB. The StorageQuota parameter is valid for managed custom folders in Outlook 2007. + +> Applicable: Exchange Server 2010 + +The StorageQuota parameter specifies the storage size limit for the mailbox folder. When the folder size exceeds this limit, no additional items might be added. Mailbox sizes can be specified in kilobytes (KB) or megabytes (MB), for example, as 100KB or 5MB. The StorageQuota parameter is valid for managed custom folders in Outlook 2007. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -234,13 +257,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolderMailboxPolicy.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolderMailboxPolicy.md index 4e82b118b4..171f044fc0 100644 --- a/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolderMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managedfoldermailboxpolicy applicable: Exchange Server 2010 -title: Set-ManagedFolderMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managedfoldermailboxpolicy +schema: 2.0.0 +title: Set-ManagedFolderMailboxPolicy --- # Set-ManagedFolderMailboxPolicy @@ -31,7 +32,7 @@ Set-ManagedFolderMailboxPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,7 +43,7 @@ Set-ManagedFolderMailboxPolicy "PM Storage Template1" -Name "PM Storage Template This example changes the name of the managed folder mailbox policy PM Storage Template1 to PM Storage Template2. -The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). +The Identity parameter is positional, which means you can use it without the -Identity label in the supported location in the command (in this case, first). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). ### Example 2 ```powershell @@ -54,13 +55,19 @@ This example links the managed custom folders Custom Folder 1 and Custom Folder ## PARAMETERS ### -Identity -The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder mailbox policy. + +> Applicable: Exchange Server 2010 + +The Identity parameter specifies the managed folder mailbox policy that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -70,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -79,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -89,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -105,13 +116,15 @@ Accept wildcard characters: False ``` ### -ManagedFolderLinks + +> Applicable: Exchange Server 2010 + The ManagedFolderLinks parameter specifies managed folders to which the managed folder mailbox policy is to be linked. The managed folders that you link to a policy appear in all mailboxes to which the policy is applied. ```yaml Type: ELCFolderIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -121,13 +134,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies a unique name for the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -137,13 +152,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleAssignment.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleAssignment.md index 44d3d2ad77..3b5d137088 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleAssignment.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managementroleassignment -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-ManagementRoleAssignment -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managementroleassignment +schema: 2.0.0 +title: Set-ManagementRoleAssignment --- # Set-ManagementRoleAssignment ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-ManagementRoleAssignment cmdlet to modify existing management role assignments. @@ -105,7 +106,7 @@ You can create custom management scopes using the New-ManagementScope cmdlet and For more information about management role assignments, see [Understanding management role assignments](https://learn.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -140,13 +141,15 @@ This example restricts the Distribution Groups\_Cairns Admins role assignment us ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the management role assignment to modify. If the name of the management role contains spaces, enclose it in quotation marks ("). ```yaml Type: RoleAssignmentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -156,6 +159,9 @@ Accept wildcard characters: False ``` ### -RecipientAdministrativeUnitScope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the role assignment to. @@ -168,7 +174,6 @@ You can't use this parameter with any of the other scope parameters. Type: AdministrativeUnitIdParameter Parameter Sets: RecipientAdministrativeUnitScope Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -178,6 +183,9 @@ Accept wildcard characters: False ``` ### -RecipientGroupScope + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecipientGroupScope parameter specifies a group to consider for scoping the role assignment. Individual members of the specified group (not nested groups) are considered as in scope for the assignment. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, or DisplayName. @@ -186,7 +194,6 @@ The RecipientGroupScope parameter specifies a group to consider for scoping the Type: GroupIdParameter Parameter Sets: RecipientGroupScope Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -196,6 +203,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -205,7 +215,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -215,6 +224,9 @@ Accept wildcard characters: False ``` ### -CustomConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CustomConfigWriteScope parameter specifies the existing configuration management scope to associate with this management role assignment. If the management scope name contains spaces, enclose it in quotation marks ("). @@ -227,7 +239,6 @@ To remove a scope, specify a value of $null. Type: ManagementScopeIdParameter Parameter Sets: RelativeRecipientWriteScope, CustomRecipientWriteScope, RecipientOrganizationalUnitScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,6 +248,9 @@ Accept wildcard characters: False ``` ### -CustomRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CustomRecipientWriteScope parameter specifies the existing recipient-based management scope to associate with this management role assignment. If the management scope name contains spaces, enclose it in quotation marks ("). If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope, RecipientRelativeWriteScope, or ExclusiveRecipientWriteScope parameters, and any configured OU or predefined scope on the role assignment is overwritten. @@ -247,7 +261,6 @@ To remove a scope, specify a value of $null. Type: ManagementScopeIdParameter Parameter Sets: CustomRecipientWriteScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,6 +270,9 @@ Accept wildcard characters: False ``` ### -CustomResourceScope + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The CustomResourceScope parameter specifies the custom management scope to associate with this management role assignment. You can use any value that uniquely identifies the management scope. For example: @@ -273,7 +289,6 @@ You use this parameter with the App parameter to assign permissions to service p Type: ManagementScopeIdParameter Parameter Sets: App Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -283,6 +298,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -291,7 +309,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: RelativeRecipientWriteScope, CustomRecipientWriteScope, RecipientOrganizationalUnitScope, ExclusiveScope, RecipientAdministrativeUnitScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -301,13 +318,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the management role assignment is enabled or disabled. The valid values are $true and $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -317,6 +336,9 @@ Accept wildcard characters: False ``` ### -ExclusiveConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ExclusiveConfigWriteScope parameter specifies the existing configuration exclusive management scope to associate with this management role assignment. If the management scope name contains spaces, enclose it in quotation marks ("). @@ -329,7 +351,6 @@ To remove a scope, specify a value of $null. Type: ManagementScopeIdParameter Parameter Sets: ExclusiveScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -339,6 +360,9 @@ Accept wildcard characters: False ``` ### -ExclusiveRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ExclusiveRecipientWriteScope parameter specifies the existing recipient-based exclusive management scope to associate with this management role assignment. If the management scope name contains spaces, enclose it in quotation marks ("). If you use the ExclusiveRecipientWriteScope parameter, you can't use the CustomRecipientWriteScope, RecipientOrganizationalUnitScope, or RecipientRelativeWriteScope parameters and any configured OU or predefined scope on the role assignment is overwritten. @@ -349,7 +373,6 @@ To remove a scope, specify a value of $null. Type: ManagementScopeIdParameter Parameter Sets: ExclusiveScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -359,6 +382,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -369,7 +395,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -379,6 +404,9 @@ Accept wildcard characters: False ``` ### -RecipientOrganizationalUnitScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope, ExclusiveRecipientWriteScope, or RecipientRelativeWriteScope parameters and any predefined scopes or custom scopes on the role assignment are overwritten. @@ -389,7 +417,6 @@ To specify an OU, use the syntax: domain/ou. To remove an OU, specify a value of Type: OrganizationalUnitIdParameter Parameter Sets: RecipientOrganizationalUnitScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -399,6 +426,9 @@ Accept wildcard characters: False ``` ### -RecipientRelativeWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientRelativeWriteScope parameter specifies the type of restriction to apply to a recipient scope. If you use the RecipientRelativeWriteScope parameter, you can't use the CustomRecipientWriteScope, ExclusiveRecipientWriteScope, or RecipientOrganizationalUnitScope parameters. @@ -411,7 +441,6 @@ Even though the NotApplicable, OU, MyDirectReports, CustomRecipientScope, MyExec Type: RecipientWriteScopeType Parameter Sets: RelativeRecipientWriteScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -421,13 +450,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleEntry.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleEntry.md index ee811f9b5f..d44f3a41d9 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleEntry.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managementroleentry -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-ManagementRoleEntry -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managementroleentry +schema: 2.0.0 +title: Set-ManagementRoleEntry --- # Set-ManagementRoleEntry ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-ManagementRoleEntry cmdlet to change the available parameters on an existing management role entry. @@ -38,7 +39,7 @@ The Set-ManagementRoleEntry cmdlet changes the available parameters on an existi For more information about management role entries, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,11 +69,14 @@ This example adds the DisplayName and ForwardingAddress parameters to the Set-Ma Set-ManagementRoleEntry "IT Scripts\MailboxAudit" -Parameters Location -AddParameter -UnScopedTopLevel ``` -In on-premises Exchange, this example adds the Location parameter to the MailboxAudit custom script on the IT Scripts unscoped top level role. Note that the UnScopedTopLevel switch requires the UnScoped Role Management role, which isn't assigned to any role groups by default. +In on-premises Exchange, this example adds the Location parameter to the MailboxAudit custom script on the IT Scripts unscoped top level role. The UnScopedTopLevel switch requires the UnScoped Role Management role, which isn't assigned to any role groups by default. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the role entry that you want to modify. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). @@ -83,7 +87,6 @@ If the role entry name contains spaces, enclose it in quotation marks ("). Type: RoleEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AddParameter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AddParameter switch specifies that you're adding parameters to the specified role entry. You don't need to specify a value with this switch. Use the Parameters parameter to specify the parameters to add. @@ -103,7 +109,6 @@ You can't use the AddParameter switch and the RemoveParameter switch together in Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -122,7 +130,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -140,7 +150,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -160,7 +172,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Parameters parameter specifies the parameters to be added to or removed from the role entry. The Parameters parameter has the following modes: @@ -184,7 +198,6 @@ You can specify multiple parameters, separated with commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -RemoveParameter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RemoveParameter switch specifies that you're removing parameters to the specified role entry. You don't need to specify a value with this switch. Use the Parameters parameter to specify the parameters to remove. @@ -204,7 +220,6 @@ You can't use the AddParameter switch and the RemoveParameter switch together in Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -214,6 +229,9 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -226,7 +244,6 @@ Unscoped top-level management roles can only contain custom scripts or non-Excha Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,13 +253,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagementScope.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementScope.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-ManagementScope.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagementScope.md index 23361eef8f..cb4707ab96 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementScope.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managementscope -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-ManagementScope -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managementscope +schema: 2.0.0 +title: Set-ManagementScope --- # Set-ManagementScope ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-ManagementScope cmdlet to change an existing management scope. @@ -56,11 +57,11 @@ Set-ManagementScope [-Identity] ``` ## DESCRIPTION -If you change a scope that has been associated with management role assignments using the New-ManagementRoleAssignment cmdlet, the updated scope applies to all the associated role assignments. For more information about changing scopes, see [Change a role scope](https://learn.microsoft.com/exchange/change-a-role-scope-exchange-2013-help). +If you change a scope that is associated with management role assignments using the New-ManagementRoleAssignment cmdlet, the updated scope applies to all the associated role assignments. For more information about changing scopes, see [Change a role scope](https://learn.microsoft.com/exchange/change-a-role-scope-exchange-2013-help). For more information about regular and exclusive scopes, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -88,13 +89,15 @@ This example changes the Active Directory site used in the server restriction fi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the management scope to modify. If the name contains spaces, enclose it in quotation marks ("). ```yaml Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -DatabaseRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DatabaseRestrictionFilter parameter uses OPATH filter syntax to specify the databases that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. @@ -123,7 +129,6 @@ You can't use this parameter with the RecipientRestrictionFilter, ServerRestrict Type: String Parameter Sets: DatabaseFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -133,6 +138,9 @@ Accept wildcard characters: False ``` ### -ServerRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ServerRestrictionFilter parameter uses OPATH filter syntax to specify the servers that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. @@ -152,7 +160,6 @@ You can't use this parameter wit the RecipientRestrictionFilter, RecipientRoot, Type: String Parameter Sets: ServerFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -162,6 +169,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -171,7 +181,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -189,7 +201,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,6 +210,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -209,7 +223,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,13 +232,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the management scope. The management scope name can be a maximum of 64 characters. If the name contains spaces, enclose it in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -235,6 +250,9 @@ Accept wildcard characters: False ``` ### -RecipientRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RecipientRestrictionFilter parameter uses OPATH filter syntax to specify the recipients that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -252,7 +270,6 @@ You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, S Type: String Parameter Sets: RecipientFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -262,6 +279,9 @@ Accept wildcard characters: False ``` ### -RecipientRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 @@ -275,7 +295,6 @@ You can't use this parameter with the ServerRestrictionFilter or DatabaseRestric Type: OrganizationalUnitIdParameter Parameter Sets: RecipientFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -285,13 +304,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -314,5 +335,6 @@ To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Ty To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES +Use two-letter country codes (ISO 3166-1 alpha-2) instead of the full country name in filters. For example, use `-RecipientRestrictionFilter "UsageLocation -eq 'FR'"` for France. ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-MapiVirtualDirectory.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MapiVirtualDirectory.md index ec322afd70..cd48e72f02 100644 --- a/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MapiVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mapivirtualdirectory -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MapiVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mapivirtualdirectory +schema: 2.0.0 +title: Set-MapiVirtualDirectory --- # Set-MapiVirtualDirectory @@ -36,7 +37,7 @@ Set-MapiVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example makes the following configuration changes to the MAPI virtual direc ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the MAPI virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -65,7 +69,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -ApplyDefaults + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ApplyDefaults switch specifies whether to apply the correct defaults to the related internal IIS application settings. Typically, this switch is used only by Exchange Setup during the installation of Exchange Cumulative Updates or Service Packs and you shouldn't need to use it. This switch doesn't affect the values you configure by using the IISAuthenticationMethods, InternalUrl or ExternalUrl parameters. @@ -83,7 +89,6 @@ This switch doesn't affect the values you configure by using the IISAuthenticati Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -102,7 +110,6 @@ 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 Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,19 +137,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,16 +161,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,10 +182,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -181,7 +197,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,6 +206,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax `https:///mapi`(for example, `https://external.contoso.com/mapi`). @@ -201,7 +219,6 @@ When you use the InternalUrl or ExternalUrl parameters, you need to specify one Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,6 +228,9 @@ Accept wildcard characters: False ``` ### -IISAuthenticationMethods + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IISAuthenticationMethods parameter specifies the authentication methods that are enabled on the virtual directory in Internet Information Services (IIS). Valid values are: - Basic @@ -228,7 +248,6 @@ For more information about the different authentication methods, see [Understand Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,6 +257,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax `https:///mapi` (for example, `https://internal.contoso.com/mapi`). @@ -248,7 +270,6 @@ When you use the InternalUrl or ExternalUrl parameters, you need to specify one Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -258,13 +279,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MessageClassification.md b/exchange/exchange-ps/ExchangePowerShell/Set-MessageClassification.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-MessageClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MessageClassification.md index 4c48abce78..c2760e2c2a 100644 --- a/exchange/exchange-ps/exchange/Set-MessageClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MessageClassification.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-messageclassification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MessageClassification -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-messageclassification +schema: 2.0.0 +title: Set-MessageClassification --- # Set-MessageClassification ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MessageClassification cmdlet to configure an existing message classification instance in your organization. @@ -37,7 +38,7 @@ Set-MessageClassification [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example makes the following configuration changes to the message classifica ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the message classification that you want to modify. You can use any value that uniquely identifies the message classification. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the message classification that you want to mod Type: MessageClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -ClassificationID + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ClassificationID parameter specifies the classification ID (GUID) of an existing message classification that you want to import and use in your Exchange organization. Use this parameter if you're configuring message classifications that span two Exchange forests in the same organization. To find the ClassificationID value of the message classification, replace `` with the name of the message classification and run the following command: `Get-MessageClassification -Identity ""`. @@ -82,7 +88,6 @@ To find the ClassificationID value of the message classification, replace ` Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -101,7 +109,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DisplayName parameter specifies the title of the message classification that's displayed in Outlook and selected by users. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). The message classification XML file must be present on the sender's computer for the display name to be displayed. @@ -119,7 +129,6 @@ The message classification XML file must be present on the sender's computer for Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -129,25 +138,27 @@ Accept wildcard characters: False ``` ### -DisplayPrecedence -The DisplayPrecedence parameter specifies the relative precedence of the message classification to other message classifications that may be applied to a specified message. Valid values are: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The DisplayPrecedence parameter specifies the relative precedence of the message classification to other message classifications that might be applied to a specified message. Valid values are: - Highest - Higher - High - MediumHigh -- Medium (This is the default value) +- Medium (default value) - MediumLow - Low - Lower - Lowest -Although Outlook only lets a user specify a single classification for a message, transport rules may apply other classifications to a message. The classification with the highest precedence is shown first and the subsequent classifications, which are those with lesser precedence as defined by this parameter, are appended in the appropriate order thereafter. +Although Outlook only lets a user specify a single classification for a message, transport rules might apply other classifications to a message. The classification with the highest precedence is shown first and the subsequent classifications, which are those with lesser precedence as defined by this parameter, are appended in the appropriate order thereafter. ```yaml Type: ClassificationDisplayPrecedenceLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -167,7 +181,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name for the message classification. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -193,16 +208,18 @@ Accept wildcard characters: False ``` ### -PermissionMenuVisible + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PermissionMenuVisible parameter specifies whether the values that you entered for the DisplayName and RecipientDescription parameters are displayed in Outlook as the user composes a message. Valid values are: -- $true: Users can assign the message classification to messages before they're sent, and the classification information is displayed. This is the default value. +- $true: Users can assign the message classification to messages before they're sent, and the classification information is displayed. This value is the default. - $false: Users can't assign the message classification to messages before they're sent, However, messages received with this message classification still display the classification information. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,13 +229,15 @@ Accept wildcard characters: False ``` ### -RecipientDescription + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RecipientDescription parameter specifies the detailed text that's shown to Outlook recipient when they receive a message that has the message classification applied. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -228,6 +247,9 @@ Accept wildcard characters: False ``` ### -RetainClassificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetainClassificationEnabled parameter specifies whether the message classification should persist with the message if the message is forwarded or replied to. The default value is $true. @@ -236,7 +258,6 @@ The default value is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,13 +267,15 @@ Accept wildcard characters: False ``` ### -SenderDescription + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SenderDescription parameter specifies the detailed text that's shown to Outlook senders when they select a message classification to apply to a message before they send the message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,13 +285,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationBatch.md similarity index 77% rename from exchange/exchange-ps/exchange/Set-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MigrationBatch.md index 17981b8c20..16801ba5be 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationBatch.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationbatch -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationBatch -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-migrationbatch +schema: 2.0.0 +title: Set-MigrationBatch --- # Set-MigrationBatch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see [New-MigrationBatch](https://learn.microsoft.com/powershell/module/exchange/new-migrationbatch). +Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see [New-MigrationBatch](https://learn.microsoft.com/powershell/module/exchangepowershell/new-migrationbatch). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -59,9 +60,9 @@ The Set-MigrationBatch cmdlet configures your existing migration batches to migr - IMAP migration - Google Workspace (formerly G Suite) migration -Some settings can be applied both to the batch as well as to individual users within the batch. It is important to note that when a setting is applied to a user it will override any corresponding setting on the batch. +Some settings can be applied both to the batch as well as to individual users within the batch. A setting applied to a user overrides any corresponding setting on the batch. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,6 +76,9 @@ This example updates MigrationBatch01 by approving all of the skipped items for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the migration batch that you want to modify. You can use any value that uniquely identifies the migration batch. For example: - Name (the Identity property value) @@ -84,7 +88,6 @@ The Identity parameter specifies the migration batch that you want to modify. Yo Type: MigrationBatchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AddUsers + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AddUsers Description }} @@ -102,7 +108,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -112,18 +117,20 @@ Accept wildcard characters: False ``` ### -AllowIncrementalSyncs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AllowIncrementalSyncs parameter specifies whether to enable or disable incremental synchronization. Valid values are: - $true: Incremental synchronization is enabled. Any new messages that are sent to the source mailbox are copied to the corresponding target mailbox once every 24 hours. -- $false: Incremental synchronization is disabled. The migration batch will go into the Stopped state after the initial synchronization is complete. To complete a migration batch for local moves, cross-forest moves, or remote move migrations, you need to enable incremental synchronization. +- $false: Incremental synchronization is disabled. The migration batch enters the Stopped state after the initial synchronization is complete. To complete a migration batch for local moves, cross-forest moves, or remote move migrations, you need to enable incremental synchronization. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,16 +140,18 @@ Accept wildcard characters: False ``` ### -AllowUnknownColumnsInCsv + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowUnknownColumnsInCsv parameter specifies whether to allow extra columns in the CSV file that aren't used by migration. Valid values are: - $true: The migration ignores (silently skips) unknown columns in the CSV file (including optional columns with misspelled column headers). All unknown columns are treated like extra columns that aren't used by migration. -- $false: The migration fails if there are any unknown columns in the CSV file. This setting protects against spelling errors in column headers. This is the default value. +- $false: The migration fails if there are any unknown columns in the CSV file. This setting protects against spelling errors in column headers. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,11 +161,14 @@ Accept wildcard characters: False ``` ### -ApproveSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ApproveSkippedItems switch marks all of the skipped items that were discovered prior to the current time as approved. You don't need to specify a value with this switch. -If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. +If the data loss that was detected during this migration is significant, the migration can't complete without approving skipped items. Items might have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. For more information about maximum message size values, see the following topic [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). @@ -164,7 +176,6 @@ For more information about maximum message size values, see the following topic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,6 +185,9 @@ Accept wildcard characters: False ``` ### -AutoRetryCount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AutoRetryCount parameter specifies the number of attempts to restart the migration batch to migrate mailboxes that encountered errors. @@ -182,7 +196,6 @@ The AutoRetryCount parameter specifies the number of attempts to restart the mig Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,17 +205,19 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the migration request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the migration request is ready to complete. -Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the migration request again. +Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request fails if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the migration request again. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,22 +227,24 @@ Accept wildcard characters: False ``` ### -CompleteAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. +The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch starts, but completion doesn'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". 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: - Specify the date/time value in UTC: For example, `"7/30/2020 9:00PM Z"`. -- Specify the date/time value in your local time zone. For example, `"7/30/2020 9:00PM -700"`. The value will be converted to UTC if you don't use the TimeZone parameter. +- Specify the date/time value in your local time zone. For example, `"7/30/2020 9:00PM -700"`. The value is converted to UTC if you don't use the TimeZone parameter. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -237,6 +254,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -246,7 +266,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -256,17 +275,19 @@ Accept wildcard characters: False ``` ### -CSVData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`). -**Note**: This parameter doesn't validate the availability of the mailboxes based on RBAC scope. All mailboxes that are specified in the CSV file will be migrated, even if they are outside of the RBAC scope (for example, an OU) that gives the admin permissions to migrate mailboxes. +**Note**: This parameter doesn't validate the availability of the mailboxes based on RBAC scope. All mailboxes specified in the CSV file are migrated, even if they're outside of the RBAC scope (for example, an OU) that gives the admin permissions to migrate mailboxes. ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -276,6 +297,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -284,7 +308,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -294,6 +317,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. For more information about maximum message size values, see the following topics: @@ -303,13 +329,12 @@ For more information about maximum message size values, see the following topics Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -319,6 +344,9 @@ Accept wildcard characters: False ``` ### -MoveOptions + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MoveOptions parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. Don't use this parameter with the SkipMoving parameter. @@ -327,7 +355,6 @@ Don't use this parameter with the SkipMoving parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -337,6 +364,9 @@ Accept wildcard characters: False ``` ### -NotificationEmails + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NotificationEmails parameter specifies one or more email addresses that migration status reports are sent to. If you don't use this parameter, the status report isn't sent. @@ -347,7 +377,6 @@ To enter multiple values and overwrite any existing entries, use the following s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -357,6 +386,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -365,7 +397,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -375,6 +406,9 @@ Accept wildcard characters: False ``` ### -ReportInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReportInterval parameter specifies how frequently emailed reports should be sent to the email addresses listed within NotificationEmails. By default, emailed reports are sent every 24 hours for a batch. Setting this value to 0 indicates that reports should never be sent for this batch. @@ -385,7 +419,6 @@ This parameter should only be used in the cloud-based service. Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -395,13 +428,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipMerging parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,7 +446,10 @@ Accept wildcard characters: False ``` ### -SkipMoving -This parameter has been replaced by the MoveOptions parameter. + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +This parameter is replaced by the MoveOptions parameter. The SkipMoving parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. @@ -419,7 +457,6 @@ The SkipMoving parameter specifies the stages of the migration that you want to Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -429,13 +466,15 @@ Accept wildcard characters: False ``` ### -SkipReports + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipReports switch specifies that you want to skip automatic reporting for the migration. You don't need to specify a value with this switch. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -445,6 +484,9 @@ Accept wildcard characters: False ``` ### -SourcePublicFolderDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SourcePublicFolderDatabase parameter specifies the source public folder database that's used in a public folder migration. You can use any value that uniquely identifies the database. For example: @@ -457,7 +499,6 @@ The SourcePublicFolderDatabase parameter specifies the source public folder data Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -467,20 +508,22 @@ 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. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The migration is prepared, but the actual data migration for users within the batch doesn'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". 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: - Specify the date/time value in UTC: For example, `"7/30/2020 9:00PM Z"`. -- Specify the date/time value in your local time zone. For example, `"7/30/2020 9:00PM -700"`. The value will be converted to UTC if you don't use the TimeZone parameter. +- Specify the date/time value in your local time zone. For example, `"7/30/2020 9:00PM -700"`. The value is converted to UTC if you don't use the TimeZone parameter. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -490,6 +533,9 @@ Accept wildcard characters: False ``` ### -SyncNow + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SyncNow switch starts an immediate sync for users that have already reached Synced status, but doesn't resume any Failed users. You don't need to specify a value with this switch. You can use this switch to speed up onboarding moves by using the switch just before the completion of the move. For IMAP migrations, you can use this switch after MX record switchover. @@ -498,7 +544,6 @@ You can use this switch to speed up onboarding moves by using the switch just be Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -508,6 +553,9 @@ Accept wildcard characters: False ``` ### -Update + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Update switch sets the Update flag on the migration batch. You don't need to specify a value with this switch. The Update flag triggers the Migration Service to reapply all of the settings from the endpoint, batch, and user to the migration process. @@ -516,7 +564,6 @@ The Update flag triggers the Migration Service to reapply all of the settings fr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -526,13 +573,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MigrationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationConfig.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-MigrationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MigrationConfig.md index 99bb6f912b..cfcd6935cd 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationconfig -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationConfig -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-migrationconfig +schema: 2.0.0 +title: Set-MigrationConfig --- # Set-MigrationConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MigrationConfig cmdlet to edit migration configurations on Exchange servers. @@ -33,7 +34,7 @@ Set-MigrationConfig ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example sets the migration system to only allow 100 concurrent migrations. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -63,7 +67,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -81,7 +87,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Features + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Features parameter specifies the set of features to enable for the migration system. Use one of the following values: @@ -104,7 +112,6 @@ The Features parameter specifies the set of features to enable for the migration Type: MigrationFeature Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMigrations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxConcurrentMigrations parameter specifies the maximum number of active migrations that your organization can run at any specific time. @@ -122,7 +132,6 @@ The MaxConcurrentMigrations parameter specifies the maximum number of active mig Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -MaxNumberOfBatches + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxNumberOfBatches parameter specifies the maximum number of batches that your organization can migrate at any time. @@ -140,7 +152,6 @@ The MaxNumberOfBatches parameter specifies the maximum number of batches that yo Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -158,7 +172,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationEndpoint.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-MigrationEndpoint.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MigrationEndpoint.md index cade570874..be05400cb8 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationEndpoint.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationendpoint -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationEndpoint -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-migrationendpoint +schema: 2.0.0 +title: Set-MigrationEndpoint --- # Set-MigrationEndpoint ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MigrationEndpoint cmdlet to edit settings for cutover or staged Exchange migrations, IMAP migrations, Google Workspace (formerly G Suite) migrations, and remote moves. @@ -66,7 +67,7 @@ For more information about the different move and migration scenarios, see: Changes made to an endpoint that affect the individual users within the batch are applied starting at the next time that the batch is processed. If you are running this cmdlet in the cloud-based service and wish to speed up the application of these settings, consider running the Set-MigrationBatch cmdlet with the -Update parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,13 +88,15 @@ This example changes the MaxConcurrentMigrations setting to 10 on the Onboarding ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the migration endpoint you want to configure. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -AcceptUntrustedCertificates + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AcceptUntrustedCertificates Description }} @@ -111,7 +117,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -ApplicationId + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ApplicationId Description }} @@ -129,7 +137,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -AppSecretKeyVaultUrl + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AppSecretKeyVaultUrl Description }} @@ -147,7 +157,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Authentication parameter specifies the authentication method used by the remote mail server. @@ -165,7 +177,6 @@ The Authentication parameter specifies the authentication method used by the rem Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -184,7 +198,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -Credentials + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Credentials parameter specifies the username and password for connecting to the remote endpoint. Credentials should be used when creating either a staged or cutover Exchange endpoint or a RemoteMove endpoint. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -202,7 +218,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -220,7 +238,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,6 +247,9 @@ Accept wildcard characters: False ``` ### -ExchangeServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeServer parameter specifies the on-premises source Exchange server for cutover and staged migrations. This parameter is applicable only to staged and cutover Exchange endpoints which don't use Autodiscovery. @@ -238,7 +258,6 @@ The ExchangeServer parameter specifies the on-premises source Exchange server fo Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,6 +267,9 @@ Accept wildcard characters: False ``` ### -MailboxPermission + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxPermission parameter specifies what permissions should be used to access the source mailbox during OutlookAnywhere onboarding (Staged Exchange Migration and Cutover Exchange Migration). This parameter is not for non-OutlookAnywhere migrations. @@ -261,7 +283,6 @@ The account specified must have the following permissions: Type: MigrationMailboxPermission Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -271,13 +292,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentIncrementalSyncs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed for this endpoint at a specified time. This value must be less or equal to MaxConcurrentMigrations parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,13 +310,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMigrations -The MaxConcurrentMigrations parameter specifies the maximum number of mailboxes that will be migrated for this endpoint at a specified time. This parameter is applicable for all migration types. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The MaxConcurrentMigrations parameter specifies the maximum number of migrated mailboxes for this endpoint at a specified time. This parameter is applicable for all migration types. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -303,6 +328,9 @@ Accept wildcard characters: False ``` ### -NspiServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The NspiServer parameter specifies the FQDN of the remote Name Service Provider Interface (NSPI) server. This parameter is only applicable to staged and cutover Exchange endpoints that don't use Autodiscovery. @@ -311,7 +339,6 @@ The NspiServer parameter specifies the FQDN of the remote Name Service Provider Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -321,6 +348,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -329,7 +359,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -339,6 +368,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration, the Port parameter specifies the TCP port number used by the migration process to connect to the remote server. @@ -347,7 +379,6 @@ For an IMAP migration, the Port parameter specifies the TCP port number used by Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -357,6 +388,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabaseServerLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -365,7 +399,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -375,6 +408,9 @@ Accept wildcard characters: False ``` ### -RemoteServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoteServer parameter specifies the remote server depending on the protocol type for moves: - Exchange server moves: The FQDN of an Exchange server that has the Client Access role installed, a Client Access server array, or a group of Client Access servers that are located behind a supported network load balancer. @@ -384,7 +420,6 @@ The RemoteServer parameter specifies the remote server depending on the protocol Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -394,6 +429,9 @@ Accept wildcard characters: False ``` ### -RpcProxyServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For a staged Exchange migration, the RpcProxyServer parameter specifies the FQDN of the RPC proxy server for the on-premises Exchange server. This parameter is only applicable to staged and cutover Exchange endpoints that don't use Autodiscovery @@ -402,7 +440,6 @@ For a staged Exchange migration, the RpcProxyServer parameter specifies the FQDN Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -412,6 +449,9 @@ Accept wildcard characters: False ``` ### -Security + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl. @@ -420,7 +460,6 @@ For an IMAP migration, the Security parameter specifies the encryption method us Type: IMAPSecurityMechanism Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -430,9 +469,12 @@ Accept wildcard characters: False ``` ### -ServiceAccountKeyFileData + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. +The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that is granted access to your remote tenant is created. 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`). @@ -440,7 +482,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -450,13 +491,15 @@ Accept wildcard characters: False ``` ### -SkipVerification + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SkipVerification switch skips verifying that the remote server is reachable when creating a migration endpoint. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -466,6 +509,9 @@ Accept wildcard characters: False ``` ### -SourceMailboxLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SourceMailboxLegacyDN parameter specifies a mailbox on the target server. Use the LegacyExchangeDN for the on-premises test mailbox as the value for this parameter. The cmdlet tries to access this mailbox using the credentials for the administrator account on the target server. @@ -474,7 +520,6 @@ The SourceMailboxLegacyDN parameter specifies a mailbox on the target server. Us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -484,6 +529,9 @@ Accept wildcard characters: False ``` ### -TestMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The TestMailbox parameter specifies a mailbox on the target server. Use the primary SMTP address as the value for this parameter. The cmdlet tries to access this mailbox using the credentials for the administrator account on the target server. @@ -492,7 +540,6 @@ The TestMailbox parameter specifies a mailbox on the target server. Use the prim Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -502,13 +549,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MigrationUser.md b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationUser.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-MigrationUser.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MigrationUser.md index 9a4d3dc9f8..b5bd1e1a1a 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationuser -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationUser -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-migrationuser +schema: 2.0.0 +title: Set-MigrationUser --- # Set-MigrationUser @@ -36,9 +37,9 @@ Set-MigrationUser [-Identity] ``` ## DESCRIPTION -Some settings can be applied both to the batch as well as to individual users within the batch. It is important to note that when a setting is applied to a user it will override any corresponding setting on the batch. +Some settings can be applied both to the batch as well as to individual users within the batch. A setting applied to a user overrides any corresponding setting on the batch. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example approves all of the skipped items encountered for the user laura@co ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the email address of the user that's being migrated. You can also identify the user by the GUID value in the MigrationUser property from the output of the Get-MigrationUser cmdlet. This identification method is useful if you accidentally submitted the same user in multiple batches. @@ -67,7 +71,6 @@ You can also identify the user by the GUID value in the MigrationUser property f Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -77,11 +80,14 @@ Accept wildcard characters: False ``` ### -ApproveSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ApproveSkippedItems switch marks all of the skipped items that were discovered prior to the current time as approved. You don't need to specify a value with this switch. -If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. +If the data loss that was detected during this migration is significant, the migration can't complete without approving skipped items. Items might have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. For more information about maximum message size values, see the following topic [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). @@ -91,7 +97,6 @@ You don't need to specify a value with this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -101,17 +106,19 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the migration request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the migration request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the migration request again. -**Note**: This parameter is being deprecated. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -121,9 +128,12 @@ Accept wildcard characters: False ``` ### -CompleteAfter + +> Applicable: Exchange Online + 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. +The CompleteAfter parameter specifies a delay before the user is completed. Data migration for the user starts but doesn'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". @@ -138,7 +148,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -157,7 +169,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -175,7 +189,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,6 +198,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. For more information about maximum message size values, see the following topics: @@ -194,13 +210,12 @@ For more information about maximum message size values, see the following topics Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. -**Note**: This parameter is being deprecated. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -210,6 +225,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -218,7 +236,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -228,9 +245,12 @@ Accept wildcard characters: False ``` ### -StartAfter + +> Applicable: Exchange Online + 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. +The StartAfter parameter specifies a delay before the data migration for the user is started. The migration is prepared, but the actual data migration for the user doesn'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". @@ -245,7 +265,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -255,6 +274,9 @@ Accept wildcard characters: False ``` ### -SyncNow + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SyncNow switch specifies whether to trigger an incremental sync for the migrated user. You don't need to specify a value with this switch. An incremental sync copies any recent changes from the source mailbox to the target mailbox. You can perform an incremental sync before you complete the migration batch to reduce the time that's required for the completion. @@ -263,7 +285,6 @@ An incremental sync copies any recent changes from the source mailbox to the tar Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -273,13 +294,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-MobileDeviceMailboxPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MobileDeviceMailboxPolicy.md index 1a4006943c..4a8c96d67e 100644 --- a/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MobileDeviceMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mobiledevicemailboxpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MobileDeviceMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mobiledevicemailboxpolicy +schema: 2.0.0 +title: Set-MobileDeviceMailboxPolicy --- # Set-MobileDeviceMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-MobileDeviceMailboxPolicy cmdlet to modify mobile device mailbox policies. @@ -90,7 +91,7 @@ Some mobile device mailbox policy settings require the mobile device to have spe Some settings in this cmdlet are supported by Outlook for iOS and Android. For more information, see [Leveraging Exchange Online mobile device policies](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/secure-outlook-for-ios-and-android#leveraging-exchange-online-mobile-device-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,6 +119,9 @@ This example sets several policy settings for the mobile device mailbox policy D ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mobile device mailbox policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -130,7 +134,6 @@ The name of the built-in mobile device mailbox policy is Default. Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -140,6 +143,9 @@ Accept wildcard characters: False ``` ### -AllowApplePushNotifications + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowApplePushNotifications parameter specifies whether push notifications are allowed for Apple mobile devices. Valid input for this parameter is $true or $false. The default value is $true. @@ -148,7 +154,6 @@ The AllowApplePushNotifications parameter specifies whether push notifications a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -158,6 +163,9 @@ Accept wildcard characters: False ``` ### -AllowBluetooth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile device. Valid values are: - Allow (this is the default value). @@ -172,7 +180,6 @@ The value Disable disables synchronization between Outlook for Android and the O Type: BluetoothType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,13 +189,15 @@ Accept wildcard characters: False ``` ### -AllowBrowser -The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect third-party browsers. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect non-Microsoft browsers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -198,13 +207,15 @@ Accept wildcard characters: False ``` ### -AllowCamera + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowCamera parameter specifies whether the mobile device's camera is allowed. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -214,13 +225,15 @@ Accept wildcard characters: False ``` ### -AllowConsumerEmail -The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using third-party mobile device email programs. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using non-Microsoft mobile device email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,13 +243,15 @@ Accept wildcard characters: False ``` ### -AllowDesktopSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowDesktopSync parameter specifies whether the mobile device can synchronize with a desktop computer through a cable. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,13 +261,15 @@ Accept wildcard characters: False ``` ### -AllowExternalDeviceManagement + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the mobile device. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,6 +279,9 @@ Accept wildcard characters: False ``` ### -AllowGooglePushNotifications + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowGooglePushNotifications parameter controls whether the user can receive push notifications from Google for Outlook on the web for devices. Valid input for this parameter is $true or $false. The default value is $true. @@ -270,7 +290,6 @@ The AllowGooglePushNotifications parameter controls whether the user can receive Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,13 +299,15 @@ Accept wildcard characters: False ``` ### -AllowHTMLEmail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowHTMLEmail parameter specifies whether HTML-formatted email is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. If set to $false, all email is converted to plain text before synchronization occurs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -296,13 +317,15 @@ Accept wildcard characters: False ``` ### -AllowInternetSharing + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowInternetSharing parameter specifies whether the mobile device can be used as a modem to connect a computer to the Internet. This process is also known as tethering. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -312,13 +335,15 @@ Accept wildcard characters: False ``` ### -AllowIrDA + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -328,6 +353,9 @@ Accept wildcard characters: False ``` ### -AllowMicrosoftPushNotifications + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowMicrosoftPushNotifications parameter specifies whether push notifications are enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. @@ -336,7 +364,6 @@ The AllowMicrosoftPushNotifications parameter specifies whether push notificatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -346,13 +373,15 @@ Accept wildcard characters: False ``` ### -AllowMobileOTAUpdate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowMobileOTAUpdate parameter specifies whether the policy can be sent to the mobile device over a cellular data connection. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -362,6 +391,9 @@ Accept wildcard characters: False ``` ### -AllowNonProvisionableDevices + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowNonProvisionableDevices parameter specifies whether all mobile devices can synchronize with Exchange. Valid input for this parameter is $true or $false. The default value is $true. When set to $true, this parameter enables all mobile devices to synchronize with Exchange, regardless of whether the device can enforce all settings that are defined by the policy. This also includes mobile devices managed by a separate device management system. When set to $false, this parameter blocks mobile devices that aren't provisioned from synchronizing with Exchange. @@ -370,7 +402,6 @@ When set to $true, this parameter enables all mobile devices to synchronize with Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -380,13 +411,15 @@ Accept wildcard characters: False ``` ### -AllowPOPIMAPEmail -The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by third-party email programs. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by non-Microsoft email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -396,13 +429,15 @@ Accept wildcard characters: False ``` ### -AllowRemoteDesktop + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowRemoteDesktop parameter specifies whether the mobile device can initiate a remote desktop connection. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -412,13 +447,15 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSimplePassword parameter specifies whether a simple password is allowed on the mobile device. A simple password is a password that has a specific pattern, such as 1111 or 1234. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -428,6 +465,9 @@ Accept wildcard characters: False ``` ### -AllowSMIMEEncryptionAlgorithmNegotiation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSMIMEEncryptionAlgorithmNegotiation parameter specifies whether the messaging application on the mobile device can negotiate the encryption algorithm if a recipient's certificate doesn't support the specified encryption algorithm. Valid values for this parameter are: - AllowAnyAlgorithmNegotiation @@ -440,7 +480,6 @@ The default value is AllowAnyAlgorithmNegotiation. Type: SMIMEEncryptionAlgorithmNegotiationType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -450,13 +489,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMESoftCerts + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -466,13 +507,15 @@ Accept wildcard characters: False ``` ### -AllowStorageCard + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowStorageCard parameter specifies whether the mobile device can access information stored on a storage card. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -482,13 +525,15 @@ Accept wildcard characters: False ``` ### -AllowTextMessaging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowTextMessaging parameter specifies whether text messaging is allowed from the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -498,13 +543,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedApplications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -514,13 +561,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedInstallationPackages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be executed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -530,13 +579,15 @@ Accept wildcard characters: False ``` ### -AllowWiFi + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowWiFi parameter specifies whether wireless Internet access is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -546,13 +597,15 @@ Accept wildcard characters: False ``` ### -AlphanumericPasswordRequired + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AlphanumericPasswordRequired parameter specifies whether the password for the mobile device must be alphanumeric. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -562,13 +615,15 @@ Accept wildcard characters: False ``` ### -ApprovedApplicationList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApprovedApplicationList parameter specifies a configured list of approved applications for the device. ```yaml Type: ApprovedApplicationCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -578,6 +633,9 @@ Accept wildcard characters: False ``` ### -AttachmentsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AttachmentsEnabled parameter specifies whether attachments can be downloaded on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. When set to $false, this parameter blocks the user from downloading attachments on the mobile device. @@ -586,7 +644,6 @@ When set to $false, this parameter blocks the user from downloading attachments Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -596,6 +653,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -605,7 +665,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -615,6 +674,9 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This setting is supported by Outlook for iOS and Android. The DeviceEncryptionEnabled parameter specifies whether encryption is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. @@ -625,7 +687,6 @@ When this parameter is set to $true, device encryption is enabled on the mobile Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -635,6 +696,9 @@ Accept wildcard characters: False ``` ### -DevicePolicyRefreshInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DevicePolicyRefreshInterval parameter specifies how often the policy is sent to the mobile device. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -645,7 +709,6 @@ The default value is Unlimited. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -655,6 +718,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -663,7 +729,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -673,13 +738,15 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -689,6 +756,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault parameter specifies whether this policy is the default mobile device mailbox policy. Valid input for this parameter is $true or $false. The default value for the built-in mobile device mailbox policy named Default is $true. The default value for new mobile device mailbox policies that you create is $false. There can be only one default policy. If another policy is currently set as the default, and you set this parameter to $true, this policy becomes the default policy. The value of this parameter on the other policy is automatically changed to $false, and that policy is no longer the default policy. @@ -697,7 +767,6 @@ There can be only one default policy. If another policy is currently set as the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -707,6 +776,9 @@ Accept wildcard characters: False ``` ### -MaxAttachmentSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile device. Valid input for this parameter is a size value between 0 and 2147482624 bytes (approximately 2 GB), or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4096 or 4KB. @@ -721,7 +793,6 @@ The maximum value is 1024 bytes (one kilobyte) less than two gigabytes (2\*1024^ Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -731,6 +802,9 @@ Accept wildcard characters: False ``` ### -MaxCalendarAgeFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the mobile device. Valid values for this parameter are: - All @@ -745,7 +819,6 @@ The default value is All. Type: CalendarAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -755,6 +828,9 @@ Accept wildcard characters: False ``` ### -MaxEmailAgeFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the mobile device. Valid values for this parameter are: - All @@ -770,7 +846,6 @@ The default value is All. Type: EmailAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -780,6 +855,9 @@ Accept wildcard characters: False ``` ### -MaxEmailBodyTruncationSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. @@ -788,7 +866,6 @@ Unqualified values are treated as bytes. You can qualify the value with KB (kilo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -798,6 +875,9 @@ Accept wildcard characters: False ``` ### -MaxEmailHTMLBodyTruncationSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. @@ -806,7 +886,6 @@ Unqualified values are treated as bytes. You can qualify the value with KB (kilo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -816,16 +895,18 @@ Accept wildcard characters: False ``` ### -MaxInactivityTimeLock + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxInactivityTimeLock parameter specifies the length of time that the mobile device can be inactive before the password is required to reactivate it. Valid values are: - A timespan: hh:mm:ss, where hh = hours, mm = minutes and ss= seconds. The valid input range is 00:01:00 to 01:00:00 (one minute to one hour). -- The value Unlimited. This is the default value. +- The value Unlimited. This value is the default. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -835,6 +916,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordFailedAttempts + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxPasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile device. You can enter any number from 4 through 16 or the value Unlimited. The default value is Unlimited. @@ -843,7 +927,6 @@ You can enter any number from 4 through 16 or the value Unlimited. The default v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -853,6 +936,9 @@ Accept wildcard characters: False ``` ### -MinPasswordComplexCharacters + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MinPasswordComplexCharacters parameter specifies the character sets that are required in the password of the mobile device. The character sets are: - Lower case letters. @@ -875,7 +961,6 @@ For Windows Phone 10 devices, the value specifies the following password complex Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -885,6 +970,9 @@ Accept wildcard characters: False ``` ### -MinPasswordLength + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This setting is supported by Outlook for Android. The MinPasswordLength parameter specifies the minimum number of characters in the mobile device password. @@ -895,7 +983,6 @@ You can enter any number from 1 through 16 or the value $null. The default value Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -905,13 +992,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the friendly name of the mobile device mailbox policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -921,6 +1010,9 @@ Accept wildcard characters: False ``` ### -PasswordEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PasswordEnabled parameter specifies whether a password is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. When set to $true, this parameter requires the user to set a password on the mobile device. @@ -929,7 +1021,6 @@ When set to $true, this parameter requires the user to set a password on the mob Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -939,16 +1030,18 @@ Accept wildcard characters: False ``` ### -PasswordExpiration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PasswordExpiration parameter specifies how long a password can be used on a mobile device before the user is forced to change the password. Valid values are: - A timespan: ddd.hh:mm:ss, where ddd = days, hh = hours, mm = minutes and ss= seconds. The valid input range is 1.00:00:00 to 730.00:00:00 (one day to two years). -- The value Unlimited. This is the default value +- The value Unlimited. This value is the default ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -958,6 +1051,9 @@ Accept wildcard characters: False ``` ### -PasswordHistory + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PasswordHistory parameter specifies the number of unique new passwords that need to be created on the mobile device before an old password can be reused. You can enter any number from 0 through 50. The default value is 0. @@ -966,7 +1062,6 @@ You can enter any number from 0 through 50. The default value is 0. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -976,6 +1071,9 @@ Accept wildcard characters: False ``` ### -PasswordRecoveryEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile device is stored in Exchange. Valid input for this parameter is $true or $false. The default value is $false. When set to $true, this parameter enables you to store the recovery password for the mobile device in Exchange. The recovery password can be viewed in Outlook on the web or the Exchange admin center. @@ -984,7 +1082,6 @@ When set to $true, this parameter enables you to store the recovery password for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -994,13 +1091,15 @@ Accept wildcard characters: False ``` ### -RequireDeviceEncryption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireDeviceEncryption parameter specifies whether encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1010,13 +1109,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptedSMIMEMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireEncryptedSMIMEMessages parameter specifies whether the mobile device must send encrypted S/MIME messages. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1026,6 +1127,9 @@ Accept wildcard characters: False ``` ### -RequireEncryptionSMIMEAlgorithm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireEncryptionSMIMEAlgorithm parameter specifies the algorithm that's required to encrypt S/MIME messages on a mobile device. The valid values for this parameter are: - DES @@ -1040,7 +1144,6 @@ The default value is TripleDES. Type: EncryptionSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1050,13 +1153,15 @@ Accept wildcard characters: False ``` ### -RequireManualSyncWhenRoaming + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireManualSyncWhenRoaming parameter specifies whether the mobile device must synchronize manually while roaming. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1066,6 +1171,9 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEAlgorithm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to sign S/MIME messages on the mobile device. Valid values for this parameter are SHA1 or MD5. The default value is SHA1. @@ -1074,7 +1182,6 @@ Valid values for this parameter are SHA1 or MD5. The default value is SHA1. Type: SignedSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1084,13 +1191,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireSignedSMIMEMessages parameter specifies whether the mobile device must send signed S/MIME messages. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1100,6 +1209,9 @@ Accept wildcard characters: False ``` ### -RequireStorageCardEncryption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequireStorageCardEncryption parameter specifies whether storage card encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. @@ -1108,7 +1220,6 @@ Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1118,13 +1229,15 @@ Accept wildcard characters: False ``` ### -UnapprovedInROMApplicationList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM on the mobile device. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1134,13 +1247,15 @@ Accept wildcard characters: False ``` ### -UNCAccessEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled from the mobile device. In on-premises Exchange organizations, access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1150,13 +1265,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1166,13 +1283,15 @@ Accept wildcard characters: False ``` ### -WSSAccessEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled from the mobile device. In on-premises Exchange organizations, access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-MoveRequest.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MoveRequest.md index 1d1ecd41fb..47f81b815c 100644 --- a/exchange/exchange-ps/exchange/Set-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MoveRequest.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-moverequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MoveRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-moverequest +schema: 2.0.0 +title: Set-MoveRequest --- # Set-MoveRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Set-MoveRequest cmdlet to change move request options after the move request has been created. You can use the Set-MoveRequest cmdlet to recover from failed move requests. +Use the Set-MoveRequest cmdlet to change move request options after the move request is created. You can use the Set-MoveRequest cmdlet to recover from failed move requests. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -56,7 +57,7 @@ Set-MoveRequest [-Identity] ## DESCRIPTION You can pipeline the Set-MoveRequest cmdlet from the Get-MoveRequestStatistics, Get-MoveRequest, or Get-Mailbox cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,6 +78,9 @@ This example changes the move request for Sruthi to approve all skipped items en ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - GUID @@ -91,7 +95,6 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c Type: MoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later or Exchange Online, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -111,7 +117,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -ArchiveTargetDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ArchiveTargetDatabase parameter specifies the target mailbox database for the personal archive. You can use any value that uniquely identifies the database. For example: @@ -135,7 +143,6 @@ You can use this parameter to change the target database only if the move reques Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,19 +152,21 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. In Exchange 2010, if you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,13 +176,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BatchName parameter specifies a different name for a batch. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -183,6 +194,9 @@ Accept wildcard characters: False ``` ### -CompleteAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -198,7 +212,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,13 +221,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -224,6 +239,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -233,7 +251,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -243,6 +260,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -251,7 +271,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,13 +280,15 @@ Accept wildcard characters: False ``` ### -IgnoreRuleLimitErrors -The IgnoreRuleLimitErrors parameter specifies that the command won't move the user's rules to the target server running Microsoft Exchange. + +> Applicable: Exchange Server 2010, Exchange Server 2013 + +The IgnoreRuleLimitErrors parameter specifies whether the command moves the user's rules to the target server running Microsoft Exchange. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -277,7 +298,10 @@ Accept wildcard characters: False ``` ### -IncrementalSyncInterval -The IncrementalSyncInterval parameter specifies the wait time between incremental syncs. This parameter is used together with the CompleteAfter parameter to create a move request that will do periodic incremental syncs after the initial sync is complete. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The IncrementalSyncInterval parameter specifies the wait time between incremental syncs. Use this parameter with the CompleteAfter parameter to create a move request that does periodic incremental syncs after the initial sync is complete. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -287,7 +311,6 @@ Valid values are from 00:00:00 to 120.00:00:00 (120 days). The default value is Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -297,6 +320,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -305,7 +331,6 @@ 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 Required: False Position: Named @@ -315,6 +340,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -326,13 +354,12 @@ Valid input for this parameter is an integer or the value unlimited. The default If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail. -**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics will be used instead. +**Note**: This parameter is being deprecated in the cloud-based service. In the future, if you don't use this parameter, Skipped Item approval semantics are used instead. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -342,6 +369,9 @@ Accept wildcard characters: False ``` ### -MoveOptions + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MoveOptions parameter specifies the stages of the move that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. Don't use this parameter with the SkipMoving parameter. @@ -350,7 +380,6 @@ Don't use this parameter with the SkipMoving parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -360,16 +389,18 @@ Accept wildcard characters: False ``` ### -PreventCompletion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PreventCompletion parameter specifies whether to run the move request, but not allow it to complete. Valid values are: - $true: The move request is run, but is not allowed to complete. Instead of this value, we recommend using the CompleteAfter parameter. -- $false: This is the default value. The move request is run and allowed to complete. If you created the move request with the SuspendWhenReadyToComplete or PreventCompletion switches, set this parameter to $false before you run the Resume-MoveRequest cmdlet to complete the move request. +- $false: This value is the default. The move request is run and allowed to complete. If you created the move request with the SuspendWhenReadyToComplete or PreventCompletion switches, set this parameter to $false before you run the Resume-MoveRequest cmdlet to complete the move request. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -379,6 +410,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -386,7 +420,7 @@ The Priority parameter specifies the order in which the request should be proces - Lowest - Lower - Low -- Normal: This is the default value. +- Normal: This value is the default. - High - Higher - Highest @@ -396,7 +430,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,6 +439,9 @@ Accept wildcard characters: False ``` ### -Protect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -414,7 +450,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -424,6 +459,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter specifies the move destination by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -443,7 +481,6 @@ The ProxyToMailbox parameter specifies the move destination by the location of t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -453,6 +490,9 @@ Accept wildcard characters: False ``` ### -RemoteCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoteCredential parameter specifies the username and password an administrator who has permission to perform the mailbox move. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -461,7 +501,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -471,13 +510,15 @@ Accept wildcard characters: False ``` ### -RemoteGlobalCatalog + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoteGlobalCatalog parameter specifies the FQDN of the global catalog server for the remote forest. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -487,13 +528,15 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -503,6 +546,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -516,7 +562,6 @@ 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, Exchange Online Required: False Position: Named @@ -526,7 +571,10 @@ Accept wildcard characters: False ``` ### -SkipMoving -This parameter has been replaced by the MoveOptions parameter. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +This parameter is replaced by the MoveOptions parameter. The SkipMoving parameter specifies the stages of the move that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. @@ -534,7 +582,6 @@ The SkipMoving parameter specifies the stages of the move that you want to skip Type: SkippableMoveComponent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -544,6 +591,9 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SourceEndpoint Description }} @@ -552,7 +602,6 @@ This parameter is available only in the cloud-based service. Type: MigrationEndpointIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -562,6 +611,9 @@ Accept wildcard characters: False ``` ### -StartAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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". @@ -577,7 +629,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -587,9 +638,12 @@ Accept wildcard characters: False ``` ### -SkippedItemApprovalTime + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The SkippedItemApprovalTime parameter marks all of the skipped items discovered prior to the specified time as approved. If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. +The SkippedItemApprovalTime parameter marks all of the skipped items discovered prior to the specified time as approved. If the data loss that was detected during this migration is significant, the migration can't complete without approving skipped items. Items might have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. For more information about maximum message size values, see the following topic [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). @@ -602,7 +656,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -612,13 +665,15 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendWhenReadyToComplete parameter specifies whether to suspend the move request before it reaches the status of CompletionInProgress. Instead of this parameter, we recommend using CompleteAfter parameter. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -628,6 +683,9 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The TargetDatabase parameter specifies the target mailbox database for the mailbox. You can use any value that uniquely identifies the database. For example: @@ -642,7 +700,6 @@ You can use this parameter to change the target database only if the move reques Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -652,13 +709,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-MyAnalyticsFeatureConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MyAnalyticsFeatureConfig.md index 68c9290d33..e20c354134 100644 --- a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MyAnalyticsFeatureConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-myanalyticsfeatureconfig applicable: Exchange Online -title: Set-MyAnalyticsFeatureConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-myanalyticsfeatureconfig +schema: 2.0.0 +title: Set-MyAnalyticsFeatureConfig --- # Set-MyAnalyticsFeatureConfig @@ -71,13 +72,15 @@ This example disables the digest email feature for Akshath. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user you want to view. You identify the user by their email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Feature + +> Applicable: Exchange Online + The Feature parameter specifies the MyAnalytics features to enable or disable for the user. Valid values are: - all (this is the default value) @@ -101,7 +107,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: dashboard, add-in, digest-email, all -Applicable: Exchange Online Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -IsEnabled + +> Applicable: Exchange Online + The IsEnabled parameter specifies whether to enable or disable the feature that's specified by the Feature parameter. Valid values are: - $true: The specified feature is enabled. @@ -120,7 +128,6 @@ The IsEnabled parameter specifies whether to enable or disable the feature that' Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -PrivacyMode + +> Applicable: Exchange Online + The PrivacyMode parameter specifies whether to enable or disable MyAnalytics for the specified user. Valid values are: -opt-in: MyAnalytics is enabled for the user. Use the Feature and IsEnabled parameters to enable or disable specific MyAnalytics features. @@ -140,7 +150,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: opt-in, opt-out -Applicable: Exchange Online Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Notification.md b/exchange/exchange-ps/ExchangePowerShell/Set-Notification.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-Notification.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Notification.md index e123223d6b..d128aa3891 100644 --- a/exchange/exchange-ps/exchange/Set-Notification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Notification.md @@ -1,18 +1,22 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-notification -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-Notification -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-notification +schema: 2.0.0 +title: Set-Notification --- # Set-Notification ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might 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: @@ -45,7 +49,7 @@ Set-Notification -NotificationEmails -ProcessType Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the notification event that you want to modify. You identify the notification event by its AlternativeID property value (a GUID). You can find this value by running the command: `Get-Notification | Format-List DisplayName,AlternativeID,StartTime,Status,Type`. -Typically, it only makes sense to modify notification recipients for events that haven't completed (if the event has completed, no more notification messages will be sent). +Typically, it only makes sense to modify notification recipients for events that haven't completed (if the event has completed, no more notification messages are sent). You can't use this parameter with the ProcessType parameter. @@ -76,7 +83,6 @@ You can't use this parameter with the ProcessType parameter. Type: EwsStoreObjectIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -86,6 +92,9 @@ Accept wildcard characters: False ``` ### -NotificationEmails + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NotificationEmails parameter specifies the recipients for notification emails related to notification events. You can specify multiple recipients separated by commas. You need to use this parameter with either the ProcessType or Identity parameters: @@ -99,7 +108,6 @@ For Migration events, you can also use the NotificationEmails parameter on the N Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -109,6 +117,9 @@ Accept wildcard characters: False ``` ### -ProcessType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ProcessType parameter specifies the notification event type that sends notification emails to users (specified by the required NotificationEmails parameter). The users receive email notification messages for all events of the specified type. The only valid value for this is parameter is CertExpiry. @@ -119,7 +130,6 @@ You can't use this parameter with the Identity parameter. Type: AsyncOperationType Parameter Sets: Settings Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -129,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -138,7 +151,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -148,6 +160,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -156,7 +171,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +180,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OMEConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-OMEConfiguration.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-OMEConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OMEConfiguration.md index 5e1079d1bc..90b01174f8 100644 --- a/exchange/exchange-ps/exchange/Set-OMEConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OMEConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-omeconfiguration applicable: Exchange Online, Exchange Online Protection -title: Set-OMEConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-omeconfiguration +schema: 2.0.0 +title: Set-OMEConfiguration --- # Set-OMEConfiguration @@ -39,7 +40,7 @@ Set-OMEConfiguration [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example configures the specified values for the default OME configuration n ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the OME configuration that you want to modify. The default OME configuration has the Identity value "OME Configuration". ```yaml Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -69,17 +72,19 @@ Accept wildcard characters: False ``` ### -BackgroundColor + +> Applicable: Exchange Online, Exchange Online Protection + The BackgroundColor parameter specifies the background color. Valid values are: - An HTML hexadecimal color code value (#RRGGBB) enclosed in quotation marks. For example, `"#FFFFFF"` is white. - A valid color name value. For example, `yellow` is #ffff00. For a list of the valid color names, see [Background color reference](https://learn.microsoft.com/purview/add-your-organization-brand-to-encrypted-messages#background-color-reference). -- $null (blank). This is the default value. +- $null (blank). This value is the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DisclaimerText + +> Applicable: Exchange Online, Exchange Online Protection + The DisclaimerText parameter specifies the disclaimer text in the email that contains the encrypted message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). To remove existing text and use the default value, use the value $null for this parameter. @@ -116,7 +126,6 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -EmailText + +> Applicable: Exchange Online, Exchange Online Protection + The EmailText parameter specifies the default text that accompanies encrypted email messages. The default text appears above the instructions for viewing encrypted messages. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). To remove existing text and use the default value, use the value $null for this parameter. @@ -134,7 +146,6 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,9 +155,12 @@ Accept wildcard characters: False ``` ### -ExternalMailExpiryInDays + +> Applicable: Exchange Online + This parameter is available only with a Microsoft 365 Advanced Message Encryption subscription. -The ExternalMailExpiryInDays parameter specifies the number of days that the encrypted message is available to external recipients in the Microsoft 365 portal. A valid value is an integer from 0 to 730. The value 0 means the messages will never expire. The default value is 0. +The ExternalMailExpiryInDays parameter specifies the number of days that the encrypted message is available to external recipients in the Microsoft 365 portal. A valid value is an integer from 0 to 730. The value 0 means the messages never expire. The default value is 0. You can't update the value of this parameter in the default OME configuration. You can only modify this value in a customized configuration. @@ -156,7 +170,6 @@ In the output of the Get-OMEConfiguration cmdlet, the value of this parameter is Type: String Parameter Sets: Int32 Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,7 +179,10 @@ Accept wildcard characters: False ``` ### -Image -The Image parameter identifies and uploads an image that will be displayed in the email message and in the Microsoft 365 admin center. + +> Applicable: Exchange Online, Exchange Online Protection + +The Image parameter identifies and uploads an image to be displayed in the email message and in the Microsoft 365 admin center. 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`). @@ -180,7 +196,6 @@ To remove an existing image and use the default image, use the value $null for t Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -IntroductionText + +> Applicable: Exchange Online, Exchange Online Protection + The IntroductionText parameter specifies the text that appears next to the sender's name and email address. If the value contains spaces, enclose the value in quotation marks ("). To remove existing text and use the default value, use the value $null for this parameter. @@ -198,7 +216,6 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,16 +225,18 @@ Accept wildcard characters: False ``` ### -OTPEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The OTPEnabled parameter specifies whether to allow recipients to use a one-time passcode to view encrypted messages. Valid values are: -- $true: Recipients can use a one-time passcode to view encrypted messages. This is the default value. +- $true: Recipients can use a one-time passcode to view encrypted messages. This value is the default. - $false: Recipients can't use a one-time passcode to view encrypted messages. The recipient is required to sign in using a Microsoft 365 work or school account. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -227,6 +246,9 @@ Accept wildcard characters: False ``` ### -PortalText + +> Applicable: Exchange Online, Exchange Online Protection + The PortalText parameter specifies the text that appears at the top of the encrypted mail viewing portal. The maximum length is 128 characters. If the value contains spaces, enclose the value in quotation marks ("). To remove existing text and use the default value, use the value $null for this parameter. @@ -235,7 +257,6 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -245,6 +266,9 @@ Accept wildcard characters: False ``` ### -PrivacyStatementUrl + +> Applicable: Exchange Online, Exchange Online Protection + The PrivacyStatementUrl parameter specifies the Privacy Statement link in the encrypted email notification message. If you don't use this parameter, the Privacy Statement link goes to the default Microsoft privacy statement. @@ -253,7 +277,6 @@ If you don't use this parameter, the Privacy Statement link goes to the default Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -263,6 +286,9 @@ Accept wildcard characters: False ``` ### -ReadButtonText + +> Applicable: Exchange Online, Exchange Online Protection + The ReadButtonText parameter specifies the text that appears on the "Read the message" button. If the value contains spaces, enclose the value in quotation marks ("). To remove existing text and use the default value, use the value $null for this parameter. @@ -271,7 +297,6 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -281,16 +306,18 @@ Accept wildcard characters: False ``` ### -SocialIdSignIn + +> Applicable: Exchange Online, Exchange Online Protection + The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Microsoft 365 admin center using their own social network id (Google, Yahoo, and Microsoft account). Valid values are: -- $true: Social network ID sign in is allowed. This is the default value. +- $true: Social network ID sign in is allowed. This value is the default. - $false: Social network ID sign in is not allowed. Whether the recipient can use a one-time passcode or their Microsoft 365 work or school account is controlled by the OTPEnabled parameter. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,13 +327,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md b/exchange/exchange-ps/ExchangePowerShell/Set-OMEMessageRevocation.md similarity index 73% rename from exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OMEMessageRevocation.md index d08012a2ab..7b7c845e23 100644 --- a/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OMEMessageRevocation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-omemessagerevocation applicable: Exchange Online -title: Set-OMEMessageRevocation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-omemessagerevocation +schema: 2.0.0 +title: Set-OMEMessageRevocation --- # Set-OMEMessageRevocation @@ -26,11 +27,11 @@ Set-OMEMessageRevocation -MessageId -Revoke ``` ## DESCRIPTION -When an email has been revoked, the recipient will get the following error when they try to view the encrypted message in the OME portal: "The message has been revoked by the sender". +When an email is revoked, the recipient gets the following error when they try to view the encrypted message in the OME portal: "The message is revoked by the sender". You can revoke encrypted messages if the recipient received a link-based, branded encrypted email message. If the recipient received a native inline experience in a supported Outlook client, then you can't revoke encryption for the message. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,7 +45,10 @@ This example revokes encryption for the specified message. ## PARAMETERS ### -MessageId -The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +> Applicable: Exchange Online + +The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which might include angle brackets) and enclose the value in quotation marks (for example, ""). You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft Purview compliance portal. @@ -52,7 +56,6 @@ You can find the Message ID for a message in Message Trace or the Message Encryp Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -62,16 +65,18 @@ Accept wildcard characters: False ``` ### -Revoke + +> Applicable: Exchange Online + The Revoke parameter specifies whether to revoke encryption for the message. Valid values are: -- $true: Encryption for the specified message is revoked. The recipient will get an error when they try to view the encrypted message in the OME portal -- $false: Encryption for the specified message isn't revoked. This is the default value. +- $true: Encryption for the specified message is revoked. The recipient gets an error when they try to view the encrypted message in the OME portal +- $false: Encryption for the specified message isn't revoked. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-OabVirtualDirectory.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OabVirtualDirectory.md index 23e45c17c1..c998400e9a 100644 --- a/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OabVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-oabvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-OabVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-oabvirtualdirectory +schema: 2.0.0 +title: Set-OabVirtualDirectory --- # Set-OabVirtualDirectory @@ -39,7 +40,7 @@ Set-OabVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example changes the external URL of the OAB virtual directory OAB (Default ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the OAB virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -65,7 +69,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,9 +78,12 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: -- $true: Basic authentication is enabled. This is the default value. +- $true: Basic authentication is enabled. This value is the default. - $false: Basic authentication is disabled. You can use this parameter with the WindowsAuthentication parameter. @@ -86,7 +92,6 @@ You can use this parameter with the WindowsAuthentication parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -105,7 +113,6 @@ 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 Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,19 +140,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,16 +164,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,10 +185,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -184,7 +200,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,13 +209,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,13 +227,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -226,13 +245,15 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -242,6 +263,9 @@ Accept wildcard characters: False ``` ### -PollInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange 2010. The PollInterval parameter specifies the time interval in minutes that the distribution service should poll the offline address book generation server for updates. @@ -250,7 +274,6 @@ The PollInterval parameter specifies the time interval in minutes that the distr Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,16 +283,18 @@ Accept wildcard characters: False ``` ### -RequireSSL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireSSL parameter specifies whether the client connection to the virtual directory requires Secure Sockets Layer (SSL) encryption. Valid values are: -- $true: SSL encryption is required to connect to the virtual directory. This is the default value. +- $true: SSL encryption is required to connect to the virtual directory. This value is the default. - $false: SSL encryption isn't required to connect to the virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -279,13 +304,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -295,9 +322,12 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: -- $true: Integrated Windows authentication is enabled. This is the default value. +- $true: Integrated Windows authentication is enabled. This value is the default. - $false: Integrated Windows authentication is disabled. You can use this parameter with the BasicAuthentication parameter. @@ -306,7 +336,6 @@ You can use this parameter with the BasicAuthentication parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/Set-OfflineAddressBook.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OfflineAddressBook.md index b6bd614d26..985662bed9 100644 --- a/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OfflineAddressBook.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-offlineaddressbook -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-OfflineAddressBook -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-offlineaddressbook +schema: 2.0.0 +title: Set-OfflineAddressBook --- # Set-OfflineAddressBook ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-OfflineAddressBook cmdlet to modify offline address book (OAB) settings. @@ -52,7 +53,7 @@ Set-OfflineAddressBook [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +74,9 @@ This example changes the organization mailbox that's responsible for generating ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the OAB that you want to modify. You can use any value that uniquely identifies the OAB. For example: - Name or \\Name @@ -83,7 +87,6 @@ The Identity parameter specifies the OAB that you want to modify. You can use an Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AddressLists + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AddressLists parameter specifies the address lists or global address lists that are included in the OAB. You can use any value that uniquely identifies the address list. For example: - Name @@ -107,7 +113,6 @@ You can find the identify values of address lists and global address lists by us Type: AddressBookBaseIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -ApplyMandatoryProperties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApplyMandatoryProperties switch specifies whether to update the mandatory properties of a legacy OAB. You don't need to specify a value with this switch. This switch was used in coexistence environments when an OAB was migrated from Exchange 2003. @@ -125,7 +133,6 @@ This switch was used in coexistence environments when an OAB was migrated from E Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -ConfiguredAttributes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConfiguredAttributes parameter specifies the recipient MAPI properties that are available in the OAB. This parameter uses the syntax: `"Name1,Type1","Name2,Type2",..."NameN,TypeN"` where Name is the name of the MAPI property (for example, MobileTelephoneNumber), and Type is the value ANR (ambiguous name resolution), Value, or Indicator. To reset this parameter back to the default values, use the UseDefaultAttributes switch. @@ -143,7 +153,6 @@ To reset this parameter back to the default values, use the UseDefaultAttributes Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -162,7 +174,6 @@ 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 Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -DiffRetentionPeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DiffRetentionPeriod parameter specifies the number of days that the OAB difference files are stored on the server. Valid values are integers from 7 to 1825, or the value unlimited. The default value is 30. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -196,7 +212,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -FullOabDownloadPreventionThreshold + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -222,6 +239,9 @@ Accept wildcard characters: False ``` ### -GeneratingMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The GeneratingMailbox parameter specifies the arbitration mailbox where the OAB is generated. Specifically, the arbitration mailbox must contain the OrganizationCapabilityOABGen value for the PersistedCapability property. An arbitration mailbox with this capability is also known as an organization mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -245,7 +265,6 @@ A single organization mailbox can generate multiple OABs (you can use the same v Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,12 +274,15 @@ Accept wildcard characters: False ``` ### -GlobalWebDistributionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The GlobalWebDistributionEnabled parameter specifies whether all OAB virtual directories in the organization can accept requests to download the OAB. These locations are advertised by the Autodiscover service. Valid values are: - $true: Any OAB virtual directory in the organization can accept requests to download the OAB. You can't use this setting with the VirtualDirectories parameter. -- $false: Only the OAB virtual directories that are specified by the VirtualDirectories parameter accept requests to download the OAB. This is the default value. +- $false: Only the OAB virtual directories that are specified by the VirtualDirectories parameter accept requests to download the OAB. This value is the default. In Exchange 2013 CU7 or later, we recommend that you use the value $true for this parameter. The Client Access services on any Mailbox server can proxy incoming OAB download requests to the correct location. @@ -268,7 +290,6 @@ In Exchange 2013 CU7 or later, we recommend that you use the value $true for thi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -278,6 +299,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault parameter specifies whether the OAB is used by all mailboxes and mailbox databases that don't have an OAB specified. Valid values are: - $true: The OAB is the default OAB. @@ -287,7 +311,6 @@ The IsDefault parameter specifies whether the OAB is used by all mailboxes and m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -297,6 +320,9 @@ Accept wildcard characters: False ``` ### -MaxBinaryPropertySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxBinaryPropertySize parameter specifies the maximum size in bytes for binary attributes in the OAB before they're truncated. Valid values are integers from 0 to 999999999. The default value is 65536. @@ -305,7 +331,6 @@ The MaxBinaryPropertySize parameter specifies the maximum size in bytes for bina Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -315,6 +340,9 @@ Accept wildcard characters: False ``` ### -MaxMultivaluedBinaryPropertySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxMultivaluedBinaryPropertySize parameter specifies the maximum size in bytes for multivalued binary attributes in the OAB before they're truncated. Valid values are integers from 0 to 999999999. The default value is 65536 (64 kilobytes). @@ -323,7 +351,6 @@ The MaxMultivaluedBinaryPropertySize parameter specifies the maximum size in byt Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -333,6 +360,9 @@ Accept wildcard characters: False ``` ### -MaxMultivaluedStringPropertySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxMultivaluedStringPropertySize parameter specifies the maximum size for multivalued string attributes in the OAB before they're truncated. Valid values are integers from 0 to 999999999. The default value is 65536 (64 kilobytes). @@ -341,7 +371,6 @@ The MaxMultivaluedStringPropertySize parameter specifies the maximum size for mu Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -351,6 +380,9 @@ Accept wildcard characters: False ``` ### -MaxStringPropertySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxStringPropertySize parameter specifies the maximum size in bytes for string attributes before they're truncated. Valid values are integers from 0 to 999999999. The default value is 3400. @@ -359,7 +391,6 @@ The MaxStringPropertySize parameter specifies the maximum size in bytes for stri Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -369,13 +400,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name of the OAB. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -385,6 +418,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDistributionEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The PublicFolderDistributionEnabled parameter specifies whether the OAB is to be distributed via public folders. Setting the PublicFolderDistributionEnabled parameter to a value of $true sets the OAB to be distributed via public folders. The default value is $true. @@ -393,7 +429,6 @@ The PublicFolderDistributionEnabled parameter specifies whether the OAB is to be Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -403,6 +438,9 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in Exchange 2010. In Exchange 2013 or later, this parameter is no longer responsible for the OAB generation schedule. For more information, see [Change the offline address book generation schedule in Exchange](https://learn.microsoft.com/Exchange/plan-and-deploy/post-installation-tasks/change-oab-generation-schedule). @@ -435,7 +473,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -445,12 +482,15 @@ Accept wildcard characters: False ``` ### -ShadowMailboxDistributionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ShadowMailboxDistributionEnabled parameter specifies whether a read only copy of the OAB (also known as a shadow copy) is distributed to all other OAB generation mailboxes (also known as organization mailboxes). This allows additional Mailbox servers to be endpoints for requests to download the OAB, which can help prevent users from downloading the OAB across slow WAN links. Valid values are: - $true: The OAB is distributed to all other organization mailboxes. -- $false: The OAB is isn't distributed to other organization mailboxes. This is the default value. +- $false: The OAB is isn't distributed to other organization mailboxes. This value is the default. The value of this parameter is only meaningful if you have multiple organization mailboxes, and is only beneficial in Exchange organizations that have multiple Active Directory sites. @@ -458,7 +498,6 @@ The value of this parameter is only meaningful if you have multiple organization Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,13 +507,15 @@ Accept wildcard characters: False ``` ### -UpgradeFromE14 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -484,6 +525,9 @@ Accept wildcard characters: False ``` ### -UseDefaultAttributes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UseDefaultAttributes switch specifies whether to revert the recipient MAPI properties that are available in the OAB to the default list. You don't need to specify a value with this switch. You can use this switch to undo changes that you've made to the default list by using the ConfiguredAttributes parameter. @@ -492,7 +536,6 @@ You can use this switch to undo changes that you've made to the default list by Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -502,6 +545,9 @@ Accept wildcard characters: False ``` ### -Versions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Versions parameter specifies the OAB versions that are generated for client download. Valid values are: - Version2 (requires public folder distribution) @@ -512,7 +558,6 @@ The Versions parameter specifies the OAB versions that are generated for client Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -522,6 +567,9 @@ Accept wildcard characters: False ``` ### -VirtualDirectories + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The VirtualDirectories parameter specifies the OAB virtual directories that accept requests to download the OAB. These locations are advertised in the Autodiscover service. @@ -544,7 +592,6 @@ In Exchange 2013 CU7 or later, we recommend that you set this parameter to $null Type: VirtualDirectoryIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -554,13 +601,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -570,16 +619,18 @@ Accept wildcard characters: False ``` ### -ZipOabFilesBeforeUploading + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ZipOabFilesBeforeUploading specifies whether to use ZIP file compression on the OAB files before uploading them to the server. Valid values are: - $true: ZIP the OAB files. -- $false: Don't ZIP the OAB files. This is the default value. +- $false: Don't ZIP the OAB files. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md b/exchange/exchange-ps/ExchangePowerShell/Set-OnPremisesOrganization.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OnPremisesOrganization.md index 666358469d..a6c3d1ea65 100644 --- a/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OnPremisesOrganization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-onpremisesorganization applicable: Exchange Online, Exchange Online Protection -title: Set-OnPremisesOrganization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-onpremisesorganization +schema: 2.0.0 +title: Set-OnPremisesOrganization --- # Set-OnPremisesOrganization @@ -34,9 +35,9 @@ Set-OnPremisesOrganization [-Identity] ``` ## DESCRIPTION -The OnPremisesOrganization object represents an on-premises Exchange organization configured for hybrid deployment with a Microsoft 365 organization. Typically, this object is only modified and updated by the Hybrid Configuration wizard. Manual modification of this object may result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Microsoft 365 organization. +The OnPremisesOrganization object represents an on-premises Exchange organization configured for hybrid deployment with a Microsoft 365 organization. Typically, this object is only modified and updated by the Hybrid Configuration wizard. Manual modification of this object might result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Microsoft 365 organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example adds a third domain legal.contoso.com to the ExchangeMail OnPremise ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - Canonical name @@ -60,7 +64,6 @@ The Identity parameter specifies the identity of the on-premises organization ob Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -HybridDomains -The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between a Microsoft 365 organization and an on-premises Exchange organization. The domains specified in this parameter must match the domains listed in the HybridConfiguration Active Directory object for the on-premises Exchange organization configured by the Hybrid Configuration wizard. Multiple domains may be listed and must be separated by a comma, for example, "contoso.com, sales.contoso.com". + +> Applicable: Exchange Online + +The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between a Microsoft 365 organization and an on-premises Exchange organization. The domains specified in this parameter must match the domains listed in the HybridConfiguration Active Directory object for the on-premises Exchange organization configured by the Hybrid Configuration wizard. Multiple domains might be listed and must be separated by a comma, for example, "contoso.com, sales.contoso.com". ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -InboundConnector -The InboundConnector parameter specifies the name of the inbound connector configured on the Microsoft Exchange Online Protection (EOP) service for a hybrid deployment configured with an on-premises Exchange organization. + +> Applicable: Exchange Online + +The InboundConnector parameter specifies the name of the inbound connector configured in Microsoft 365 for a hybrid deployment configured with an on-premises Exchange organization. ```yaml Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -137,13 +148,15 @@ Accept wildcard characters: False ``` ### -OrganizationName + +> Applicable: Exchange Online + The OrganizationName parameter specifies the Active Directory object name of the on-premises Exchange organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -153,13 +166,15 @@ Accept wildcard characters: False ``` ### -OrganizationRelationship + +> Applicable: Exchange Online + The OrganizationRelationship parameter specifies the organization relationship configured by the Hybrid Configuration wizard on the Microsoft 365 organization as part of a hybrid deployment with an on-premises Exchange organization. This organization relationship defines the federated sharing features enabled on the Microsoft 365 organization. ```yaml Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -169,13 +184,15 @@ Accept wildcard characters: False ``` ### -OutboundConnector + +> Applicable: Exchange Online + The OutboundConnector parameter specifies the name of the outbound connector configured on the EOP service for a hybrid deployment configured with an on-premises Exchange organization. ```yaml Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -185,13 +202,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationConfig.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-OrganizationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OrganizationConfig.md index f5b5873ef4..76d5771931 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-OrganizationConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-organizationconfig +schema: 2.0.0 +title: Set-OrganizationConfig --- # Set-OrganizationConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-OrganizationConfig cmdlet to configure various settings of an Exchange organization. @@ -24,6 +25,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Set-OrganizationConfig -ShortenEventScopeDefault [-AcceptedDomainApprovedSendersEnabled ] + [-ActionableMessagesExtenalAccessTokenEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] @@ -143,6 +145,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-SharedDomainEmailAddressFlowEnabled ] [-SiteMailboxCreationURL ] [-SmtpActionableMessagesEnabled ] + [-TwoClickMailPreviewEnabled ] [-UnblockUnsafeSenderPromptEnabled ] [-VisibleMeetingUpdateProperties ] [-WebPushNotificationsDisabled ] @@ -326,6 +329,7 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] ``` Set-OrganizationConfig [-DelayedDelicensingEnabled ] [-EndUserMailNotificationForDelayedDelicensingEnabled ] [-TenantAdminNotificationForDelayedDelicensingEnabled ] [-AcceptedDomainApprovedSendersEnabled ] + [-ActionableMessagesExtenalAccessTokenEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] @@ -438,6 +442,7 @@ Set-OrganizationConfig [-DelayedDelicensingEnabled ] [-EndUserMailNotif [-SharedDomainEmailAddressFlowEnabled ] [-SiteMailboxCreationURL ] [-SmtpActionableMessagesEnabled ] + [-TwoClickMailPreviewEnabled ] [-UnblockUnsafeSenderPromptEnabled ] [-VisibleMeetingUpdateProperties ] [-WebPushNotificationsDisabled ] @@ -500,7 +505,7 @@ Set-OrganizationConfig > [!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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -511,11 +516,11 @@ Set-OrganizationConfig -DistributionGroupDefaultOU Users\Groups -DistributionGro This example creates a distribution group naming policy using the following configuration: -Distribution groups will be created in the Users\\Groups container. +Distribution groups are created in the Users\\Groups container. -The words curse, bad, and offensive will be blocked from being used in distribution group names. +The words curse, bad, and offensive are blocked from being used in distribution group names. -All distribution groups will be prefixed with `DL_` and suffixed with an underscore (\_\) and the user's department and country code. +All distribution groups are prefixed with `DL_` and suffixed with an underscore (\_\) and the user's department and country code. ### Example 2 ```powershell @@ -555,11 +560,14 @@ In Exchange Online, this example results in meeting updates being auto-processed ## PARAMETERS ### -ShortenEventScopeDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ShortenEventScopeDefault parameter specifies whether calendar events start late or end early in the organization. Valid values are: -- 0 or None: Calendar events in the organization don't automatically start late or end early. This is the default value. +- 0 or None: Calendar events in the organization don't automatically start late or end early. This value is the default. - 1 or EndEarly: By default, the end time of all calendar events is reduced by the number of minutes as specified by the values of the DefaultMinutesToReduceLongEventsBy and DefaultMinutesToReduceShortEventsBy parameters. - 2 or StartLate: By default, the start time of all calendar events is delayed by the number of minutes as specified by the values of the DefaultMinutesToReduceLongEventsBy and DefaultMinutesToReduceShortEventsBy parameters. @@ -567,7 +575,6 @@ The ShortenEventScopeDefault parameter specifies whether calendar events start l Type: ShortenEventScopeMode Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -577,6 +584,9 @@ Accept wildcard characters: False ``` ### -AcceptedDomainApprovedSendersEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AcceptedDomainApprovedSendersEnabled Description }} @@ -585,7 +595,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -595,6 +604,9 @@ Accept wildcard characters: False ``` ### -ACLableSyncedObjectEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ACLableSyncedObjectEnabled parameter specifies whether remote mailboxes in hybrid environments are stamped as ACLableSyncedMailboxUser. @@ -603,7 +615,26 @@ The ACLableSyncedObjectEnabled parameter specifies whether remote mailboxes in h Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionableMessagesExtenalAccessTokenEnabled + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill ActionableMessagesExtenalAccessTokenEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: Required: False Position: Named @@ -613,9 +644,12 @@ Accept wildcard characters: False ``` ### -ActivityBasedAuthenticationTimeoutEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActivityBasedAuthenticationTimeoutEnabled parameter enables or disables the inactivity interval for automatic logoff in Outlook on the web (formerly known as Outlook Web App). Valid values are: -- $true: The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity that causes logoff in Outlook on the web. This is the default value. +- $true: The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity that causes logoff in Outlook on the web. This value is the default. - $false: Automatic logoff based on a period of inactivity in Outlook on the web is disabled. If you're using single sign-on, use the ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter. @@ -624,7 +658,6 @@ If you're using single sign-on, use the ActivityBasedAuthenticationTimeoutWithSi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -634,6 +667,9 @@ Accept wildcard characters: False ``` ### -ActivityBasedAuthenticationTimeoutInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity that causes an automatic logoff in Outlook on the web. You enter this value as a time span: hh:mm:ss where hh = hours, mm = minutes and ss = seconds. @@ -648,7 +684,6 @@ For more information about the activity-based timeout in Outlook on the web, see Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -658,9 +693,12 @@ Accept wildcard characters: False ``` ### -ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter enables or disables the inactivity interval for automatic logoff for single sign-on in Outlook on the Web. Valid values are: -- $true: The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity in Outlook on the web that causes logoff for single sign-on. This is the default value. +- $true: The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity in Outlook on the web that causes logoff for single sign-on. This value is the default. - $false: Automatic logoff based on a period of inactivity in Outlook on the web is disabled for single sign-on. If you aren't using single sign-on, use the ActivityBasedAuthenticationTimeoutEnabled parameter. @@ -669,7 +707,6 @@ If you aren't using single sign-on, use the ActivityBasedAuthenticationTimeoutEn Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -679,6 +716,9 @@ Accept wildcard characters: False ``` ### -AdfsAudienceUris + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AdfsAudienceUris parameter specifies one or more external URLs that are used for Active Directory Federation Services (AD FS) claims-based authentication. For example, the external Outlook on the web and external Exchange admin center (EAC) URLs. @@ -693,7 +733,6 @@ For more information about configuring AD FS claims based authentication in Exch Type: MultiValuedProperty Parameter Sets: AdfsAuthenticationParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -703,6 +742,9 @@ Accept wildcard characters: False ``` ### -AdfsAuthenticationConfiguration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -711,7 +753,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -721,6 +762,9 @@ Accept wildcard characters: False ``` ### -AdfsEncryptCertificateThumbprint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -729,7 +773,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AdfsAuthenticationParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -739,6 +782,9 @@ Accept wildcard characters: False ``` ### -AdfsIssuer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AdfsIssuer parameter specifies URL of the AD FS server that's used for AD FS claims-based authentication. This is the URL where AD FS relying parties send users for authentication. @@ -749,7 +795,6 @@ To get this value, open Windows PowerShell on the AD FS server and run the comma Type: Uri Parameter Sets: AdfsAuthenticationParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -759,6 +804,9 @@ Accept wildcard characters: False ``` ### -AdfsSignCertificateThumbprints + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AdfsSignCertificateThumbprints parameter specifies one or more X.509 token-signing certificates that are used for AD FS claims-based authentication. This parameter uses certificate thumbprint values (GUIDs) to identify the certificates. @@ -773,7 +821,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: AdfsAuthenticationParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -783,13 +830,15 @@ Accept wildcard characters: False ``` ### -AppsForOfficeEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AppsForOfficeEnabled parameter specifies whether to enable apps for Outlook features. By default, the parameter is set to $true. If the flag is set to $false, no new apps can be activated for any user in the organization. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -799,16 +848,18 @@ Accept wildcard characters: False ``` ### -AsyncSendEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AsyncSendEnabled parameter specifies whether to enable or disable async send in Outlook on the web. Valid values are: -- $true: Async send is enabled. This is the default value. +- $true: Async send is enabled. This value is the default. - $false: Async send is disabled. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -818,18 +869,20 @@ Accept wildcard characters: False ``` ### -AuditDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AuditDisabled parameter specifies whether to disable or enable mailbox auditing for the organization. Valid values are: - $true: Mailbox auditing is disabled for the organization. -- $false: Allow mailbox auditing in the organization. This is the default value. +- $false: Allow mailbox auditing in the organization. This value is the default. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -839,17 +892,24 @@ Accept wildcard characters: False ``` ### -AutodiscoverPartialDirSync + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The AutodiscoverPartialDirSync parameter is for scenarios where tenants have Directory Synced some of their Active Directory users into the cloud, but still have on-premises Exchange users that are not Directory Synced. Setting this parameter to $true will cause unknown users to be redirected to the on-premises endpoint and will allow on-premises users to discover their mailbox automatically. Online email addresses will be susceptible to enumeration. We recommend full Directory Sync for all Active Directory users and leaving this parameter with the default $false. +The AutodiscoverPartialDirSync parameter is for scenarios where tenants have Directory Synced some of their Active Directory users into the cloud, but still have on-premises Exchange users that are not Directory Synced. Valid values are: + +- $true: Unknown users are redirected to the on-premises endpoint and on-premises users are allowed to discover their mailbox automatically. +- $false: This value is the default. -After you enable AutodiscoverPartialDirSync, it will take approximately 3 hours to fully saturate across the cloud. +We recommend full Directory Sync for all Active Directory users and leaving this parameter with the default value $false. + +After you enable AutodiscoverPartialDirSync, it takes approximately 3 hours to fully saturate across the cloud. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -859,15 +919,20 @@ Accept wildcard characters: False ``` ### -AutoEnableArchiveMailbox + +> Applicable: Exchange Online + 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, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -877,17 +942,19 @@ Accept wildcard characters: False ``` ### -AutoExpandingArchive + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AutoExpandingArchive switch enables the auto-expanding archiving feature in an Exchange Online organization. You don't need to specify a value with this switch. -After you enable auto-expanding archiving, additional storage space is automatically added to a user's archive mailbox when it approaches the storage limit. Note that a user's archive mailbox has to be enabled before auto-expanding archiving can take effect. Also note that after you enable auto-expanding archiving for your organization, it can't be disabled. +After you enable auto-expanding archiving, additional storage space is automatically added to a user's archive mailbox when it approaches the storage limit. A user's archive mailbox has to be enabled before auto-expanding archiving can take effect. Also note that after you enable auto-expanding archiving for your organization, it can't be disabled. ```yaml Type: SwitchParameter Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -897,6 +964,9 @@ Accept wildcard characters: False ``` ### -AutomaticForcedReadReceiptEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AutomaticForcedReadReceiptEnabled Description }} @@ -905,7 +975,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -915,12 +984,15 @@ Accept wildcard characters: False ``` ### -BlockMoveMessagesForGroupFolders + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The BlockMoveMessagesForGroupFolders parameter specifies whether to prevent group owners or group members from moving messages between folders in Microsoft 365 Groups. Valid values are: - $true: Group owners or group members can't move messages between folders in Microsoft 365 groups (manually or vial Inbox rules). -- $false: Group owners or group members can move messages between folders in Microsoft 365 groups. This is the default value. +- $false: Group owners or group members can move messages between folders in Microsoft 365 groups. This value is the default. The value of this parameter is meaningful only when the value of the IsGroupFoldersAndRulesEnabled parameter is $true. @@ -935,7 +1007,6 @@ For more information, see [Manage Folders and Rules feature in Microsoft 365 Gro Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -945,6 +1016,9 @@ Accept wildcard characters: False ``` ### -BookingsAddressEntryRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsAddressEntryRestricted parameter specifies whether addresses can be collected from Bookings customers. Valid values are: @@ -956,7 +1030,6 @@ The BookingsAddressEntryRestricted parameter specifies whether addresses can be Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -966,6 +1039,9 @@ Accept wildcard characters: False ``` ### -BookingsAuthEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsAuthEnabled parameter specifies whether to enforce authentication to access all published Bookings pages. Valid values are: @@ -977,7 +1053,6 @@ The BookingsAuthEnabled parameter specifies whether to enforce authentication to Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -987,6 +1062,9 @@ Accept wildcard characters: False ``` ### -BookingsBlockedWordsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsBlockedWordsEnabled Description }} @@ -995,7 +1073,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1005,6 +1082,9 @@ Accept wildcard characters: False ``` ### -BookingsCreationOfCustomQuestionsRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsCreationOfCustomQuestionsRestricted parameter specifies whether Bookings admins can add custom questions. Valid values are: @@ -1016,7 +1096,6 @@ The BookingsCreationOfCustomQuestionsRestricted parameter specifies whether Book Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1026,12 +1105,15 @@ Accept wildcard characters: False ``` ### -BookingsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsEnabled parameter specifies whether to enable Microsoft Bookings in an organization. Valid values are: - $true: Bookings is enabled. -- $false: Bookings is disabled. This is the default value. +- $false: Bookings is disabled. This value is the default. Microsoft Bookings is an online and mobile app for small businesses who provide appointment services to customers. @@ -1039,7 +1121,6 @@ Microsoft Bookings is an online and mobile app for small businesses who provide Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1049,6 +1130,9 @@ Accept wildcard characters: False ``` ### -BookingsExposureOfStaffDetailsRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsExposureOfStaffDetailsRestricted parameter specifies whether the attributes of internal Bookings staff members (for example, email addresses) are visible to external Bookings customers. Valid values are: @@ -1060,7 +1144,6 @@ The BookingsExposureOfStaffDetailsRestricted parameter specifies whether the att Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1070,6 +1153,9 @@ Accept wildcard characters: False ``` ### -BookingsMembershipApprovalRequired + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsMembershipApprovalRequired parameter enables a membership approval requirement when new staff members are added to Bookings calendars. Valid values are: @@ -1081,7 +1167,6 @@ The BookingsMembershipApprovalRequired parameter enables a membership approval r Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1091,6 +1176,9 @@ Accept wildcard characters: False ``` ### -BookingsNamingPolicyEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsNamingPolicyEnabled Description }} @@ -1099,7 +1187,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1109,6 +1196,9 @@ Accept wildcard characters: False ``` ### -BookingsNamingPolicyPrefix + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsNamingPolicyPrefix Description }} @@ -1117,7 +1207,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1127,6 +1216,9 @@ Accept wildcard characters: False ``` ### -BookingsNamingPolicyPrefixEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsNamingPolicyPrefixEnabled Description }} @@ -1135,7 +1227,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1145,6 +1236,9 @@ Accept wildcard characters: False ``` ### -BookingsNamingPolicySuffix + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsNamingPolicySuffix Description }} @@ -1153,7 +1247,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1163,6 +1256,9 @@ Accept wildcard characters: False ``` ### -BookingsNamingPolicySuffixEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsNamingPolicySuffixEnabled Description }} @@ -1171,7 +1267,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1181,6 +1276,9 @@ Accept wildcard characters: False ``` ### -BookingsNotesEntryRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsNotesEntryRestricted parameter specifies whether appointment notes can be collected from Bookings customers. Valid values are: @@ -1192,7 +1290,6 @@ The BookingsNotesEntryRestricted parameter specifies whether appointment notes c Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1202,18 +1299,20 @@ Accept wildcard characters: False ``` ### -BookingsPaymentsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsPaymentsEnabled parameter specifies whether to enable the online payment node inside Bookings. Valid values are: - $true: Online payments are enabled. -- $false: Online payments are disabled. This is the default value. +- $false: Online payments are disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1223,6 +1322,9 @@ Accept wildcard characters: False ``` ### -BookingsPhoneNumberEntryRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsPhoneNumberEntryRestricted parameter specifies whether phone numbers can be collected from Bookings customers. Valid values are: @@ -1234,7 +1336,6 @@ The BookingsPhoneNumberEntryRestricted parameter specifies whether phone numbers Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1244,6 +1345,9 @@ Accept wildcard characters: False ``` ### -BookingsSearchEngineIndexDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsSearchEngineIndexDisabled Description }} @@ -1252,7 +1356,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1262,6 +1365,9 @@ Accept wildcard characters: False ``` ### -BookingsSmsMicrosoftEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsSmsMicrosoftEnabled Description }} @@ -1270,7 +1376,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1280,18 +1385,20 @@ Accept wildcard characters: False ``` ### -BookingsSocialSharingRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsSocialSharingRestricted parameter specifies whether users can see the social sharing options inside Bookings. Valid values are: - $true: Social sharing options are restricted. -- $false: Users can see social sharing options inside Bookings. This is the default value. +- $false: Users can see social sharing options inside Bookings. This value is the default. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1301,6 +1408,9 @@ Accept wildcard characters: False ``` ### -ByteEncoderTypeFor7BitCharsets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ByteEncoderTypeFor7BitCharsets parameter specifies the 7-bit transfer encoding method for MIME format for messages sent to this remote domain. The valid values for this parameter are: - 0: Always use default 7-bit transfer encoding for HTML and plain text. @@ -1317,7 +1427,6 @@ If no value is specified, Exchange always uses QP encoding for HTML and plain te Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1327,6 +1436,9 @@ Accept wildcard characters: False ``` ### -CalendarVersionStoreEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1335,7 +1447,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1345,6 +1456,9 @@ Accept wildcard characters: False ``` ### -ComplianceMLBgdCrawlEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ComplianceMLBgdCrawlEnabled Description }} @@ -1353,7 +1467,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1363,6 +1476,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -1372,7 +1488,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -1382,9 +1497,12 @@ Accept wildcard characters: False ``` ### -ConnectorsActionableMessagesEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConnectorsActionableMessagesEnabled parameter specifies whether to enable or disable actionable buttons in messages (connector cards) from connected apps on Outlook on the web. Valid values are: -- $true: Action buttons in connector cards are enabled, which allows you to take quick actions directly from Outlook on the web (for example, Like or Comment). This is the default value. +- $true: Action buttons in connector cards are enabled, which allows you to take quick actions directly from Outlook on the web (for example, Like or Comment). This value is the default. - $false: Action buttons in connector cards are disabled. For more information about actionable messages in connected apps, see [Connect apps to your inbox in Outlook on the web](https://support.microsoft.com/office/3d41b99c-bf8d-47d4-bc7a-97758b74689d). @@ -1393,7 +1511,6 @@ For more information about actionable messages in connected apps, see [Connect a Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1403,9 +1520,12 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ConnectorsEnabled parameter specifies whether to enable or disable all connected apps in organization. Valid values are: -- $true: Connectors are enabled. This is the default value. +- $true: Connectors are enabled. This value is the default. - $false: Connectors are disabled. The workloads that are affected by this parameter are Outlook, SharePoint, Teams, and Viva Engage. @@ -1414,7 +1534,6 @@ The workloads that are affected by this parameter are Outlook, SharePoint, Teams Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1424,11 +1543,14 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabledForOutlook + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ConnectorsEnabledForOutlook parameter specifies whether to enable or disable connected apps in Outlook on the web. Valid values are: -- $true: Connectors are enabled. This is the default value. +- $true: Connectors are enabled. This value is the default. - $false: Connectors are disabled. To enable and disable the ability to use connectors on specific Microsoft 365 Groups, set the value of this parameter to $true, and then use the ConnectorsEnabled switch on the Set-UnifiedGroup cmdlet. @@ -1439,7 +1561,6 @@ For more information about connectors for Outlook on the web, see [Connect apps Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1449,18 +1570,20 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabledForSharepoint + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ConnectorsEnabledForSharepoint parameter specifies whether to enable or disable connected apps on SharePoint. Valid values are: -- $true: Connectors are enabled. This is the default value. +- $true: Connectors are enabled. This value is the default. - $false: Connectors are disabled. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1470,18 +1593,20 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabledForTeams + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ConnectorsEnabledForTeams parameter specifies whether to enable or disable connected apps on Teams. Valid values are: -- $true: Connectors are enabled. This is the default value. +- $true: Connectors are enabled. This value is the default. - $false: Connectors are disabled. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1491,18 +1616,20 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabledForYammer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ConnectorsEnabledForYammer parameter specifies whether to enable or disable connected apps on Viva Engage. Valid values are: -- $true: Connectors are enabled. This is the default value. +- $true: Connectors are enabled. This value is the default. - $false: Connectors are disabled. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1512,6 +1639,9 @@ Accept wildcard characters: False ``` ### -CustomerFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CustomerFeedbackEnabled parameter specifies whether the Exchange server is enrolled in the Microsoft Customer Experience Improvement Program. @@ -1520,7 +1650,6 @@ The CustomerFeedbackEnabled parameter specifies whether the Exchange server is e Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1530,6 +1659,9 @@ Accept wildcard characters: False ``` ### -CustomerLockboxEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1538,7 +1670,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1548,6 +1679,9 @@ Accept wildcard characters: False ``` ### -DataClassifications + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1556,7 +1690,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1566,6 +1699,9 @@ Accept wildcard characters: False ``` ### -DefaultAuthenticationPolicy + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DefaultAuthenticationPolicy parameter specifies the authentication policy that's used for the whole organization. You can use any value that uniquely identifies the policy. For example: - Name @@ -1580,7 +1716,6 @@ You create authentication policies with the New-AuthenticationPolicy cmdlet to b Type: AuthPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1590,6 +1725,9 @@ Accept wildcard characters: False ``` ### -DefaultGroupAccessType + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DefaultGroupAccessType parameter specifies the default access type for Microsoft 365 Groups. Valid values are: @@ -1601,7 +1739,6 @@ The DefaultGroupAccessType parameter specifies the default access type for Micro Type: ModernGroupObjectType Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1611,6 +1748,9 @@ Accept wildcard characters: False ``` ### -DefaultMinutesToReduceLongEventsBy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DefaultMinutesToReduceLongEventsBy parameter specifies the number of minutes to reduce calendar events by if the events are 60 minutes or longer. A valid value is an integer from 0 to 29. The default value is 10. @@ -1623,7 +1763,6 @@ Whether long events start late or end early by the specified number of minutes d Type: Int32 Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named Default value: None @@ -1632,6 +1771,9 @@ Accept wildcard characters: False ``` ### -DefaultMinutesToReduceShortEventsBy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DefaultMinutesToReduceShortEventsBy parameter specifies the number of minutes to reduce calendar events by if the events are less than 60 minutes long. A valid value is an integer from 0 to 29. The default value is 5. @@ -1644,7 +1786,6 @@ Whether short events start late or end early by the specified number of minutes Type: Int32 Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named Default value: None @@ -1653,6 +1794,9 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultPublicFolderAgeLimit parameter specifies the default age limit for the contents of public folders across the entire organization. Content in a public folder is automatically deleted when this age limit is exceeded. This attribute applies to all public folders in the organization that don't have their own AgeLimit setting. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. Or, enter the value $null. The default value is blank ($null). @@ -1661,7 +1805,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hou Type: EnhancedTimeSpan Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1671,13 +1814,15 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderDeletedItemRetention + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultPublicFolderDeletedItemRetention parameter specifies the default value of the length of time to retain deleted items for public folders across the entire organization. This attribute applies to all public folders in the organization that don't have their own RetainDeletedItemsFor attribute set. ```yaml Type: EnhancedTimeSpan Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1687,6 +1832,9 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderIssueWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultPublicFolderIssueWarningQuota parameter specifies the default value across the entire organization for the public folder size at which a warning message is sent to this folder's owners, warning that the public folder is almost full. This attribute applies to all public folders within the organization that don't have their own warning quota attribute set. The default value of this attribute is unlimited. When you enter a value, qualify the value with one of the following units: @@ -1697,7 +1845,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 0 through 2199023254529 bytes(2 TB). If you enter a value of unlimited, no size limit is imposed on the public folder. @@ -1705,7 +1853,6 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes(2 Type: Unlimited Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1715,6 +1862,9 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderMaxItemSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultPublicFolderMaxItemSize parameter specifies the default maximum size for posted items within public folders across the entire organization. Items larger than the value of the DefaultPublicFolderMaxItemSize parameter are rejected. This attribute applies to all public folders within the organization that don't have their own MaxItemSize attribute set. The default value of this attribute is unlimited. When you enter a value, qualify the value with one of the following units: @@ -1725,7 +1875,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 0 through 2199023254529 bytes (2 TB). If you enter a value of unlimited, no size limit is imposed on the public folder. @@ -1733,7 +1883,6 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes ( Type: Unlimited Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1743,15 +1892,17 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderMovedItemRetention + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultPublicFolderMovedItemRetention parameter specifies how long items that have been moved between mailboxes are kept in the source mailbox for recovery purposes before being removed by the Public Folder Assistant. -When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see [Set-PublicFolder](https://learn.microsoft.com/powershell/module/exchange/set-publicfolder). +When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see [Set-PublicFolder](https://learn.microsoft.com/powershell/module/exchangepowershell/set-publicfolder). ```yaml Type: EnhancedTimeSpan Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1761,6 +1912,9 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderProhibitPostQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultPublicFolderProhibitPostQuota parameter specifies the size of a public folder at which users are notified that the public folder is full. Users can't post to a folder whose size is larger than the DefaultPublicFolderProhibitPostQuota parameter value. The default value of this attribute is unlimited. When you enter a value, qualify the value with one of the following units: @@ -1771,7 +1925,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 0 through 2199023254529 bytes (2 TB). If you enter a value of unlimited, no size limit is imposed on the public folder. @@ -1779,7 +1933,6 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes ( Type: Unlimited Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1789,12 +1942,15 @@ Accept wildcard characters: False ``` ### -DelayedDelicensingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- $false: Exchange Online license removals from mailboxes aren't delayed. This value is the default. 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). @@ -1812,7 +1968,6 @@ When you set the value of the DelayedDelicensingEnabled parameter to $false, the Type: Boolean Parameter Sets: DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1822,18 +1977,20 @@ Accept wildcard characters: False ``` ### -DirectReportsGroupAutoCreationEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DirectReportsGroupAutoCreationEnabled parameter specifies whether to enable or disable the automatic creation of direct report Microsoft 365 Groups. Valid values are: - $true: The automatic creation of direct report Microsoft 365 Groups is enabled. -- $false: The automatic creation of direct report Microsoft 365 Groups is disabled. This is the default value. +- $false: The automatic creation of direct report Microsoft 365 Groups is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1843,6 +2000,9 @@ Accept wildcard characters: False ``` ### -DisablePlusAddressInRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DisablePlusAddressInRecipients parameter specifies whether to enable or disable plus addressing (also known as subaddressing) for Exchange Online mailboxes. Valid values are: @@ -1856,7 +2016,6 @@ For more information about plus addressing, see [Plus addressing in Exchange Onl Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1866,13 +2025,15 @@ Accept wildcard characters: False ``` ### -DistributionGroupDefaultOU + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DistributionGroupDefaultOU parameter specifies the container where distribution groups are created by default. ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1882,13 +2043,15 @@ Accept wildcard characters: False ``` ### -DistributionGroupNameBlockedWordsList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DistributionGroupNameBlockedWordsList parameter specifies words that can't be included in the Display Name values of distribution groups that are created by users. Separate multiple values with commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1898,6 +2061,9 @@ Accept wildcard characters: False ``` ### -DistributionGroupNamingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DistributionGroupNamingPolicy parameter specifies the additional text that's applied to the Display Name value of distribution groups created by users. You can require a prefix, a suffix, or both. The prefix and suffix can be text strings, user attribute values from the person who created the group, or a combination of text strings and attributes. The basic syntax for this parameter is `"prefixsuffix"`. The value `` is a literal value that you must always include. @@ -1921,7 +2087,6 @@ For example: `"DL__"`, `"-- Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -1941,7 +2109,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1951,18 +2118,20 @@ Accept wildcard characters: False ``` ### -ElcProcessingDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ElcProcessingDisabled parameter specifies whether to enable or disable the processing of mailboxes by the Managed Folder Assistant. Valid values are: -- $true: The Managed Folder Assistant isn't allowed to process mailboxes in the organization. Note that this setting will be ignored on a mailbox if a retention policy that has Preservation Lock enabled is applied to that mailbox. -- $false: The Managed Folder Assistant is allowed to process mailboxes in the organization. This is the default value. +- $true: The Managed Folder Assistant isn't allowed to process mailboxes in the organization. This setting is ignored on a mailbox if a retention policy that has Preservation Lock enabled is applied to that mailbox. +- $false: The Managed Folder Assistant is allowed to process mailboxes in the organization. This value is the default. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1972,6 +2141,9 @@ Accept wildcard characters: False ``` ### -EmptyAddressBookForNonExchangeUsers + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. {{ Fill EmptyAddressBookForNonExchangeUsers Description }} @@ -1980,7 +2152,6 @@ This parameter is available only in on-premises Exchange. Type: SwitchParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1990,6 +2161,9 @@ Accept wildcard characters: False ``` ### -EnableAuthAdminReadSession + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EnableAuthAdminReadSession switch enables a recipient read session in Exchange 2016 CU17 or later, or in Exchange 2019 CU6 or later. You don't need to specify a value with this switch. @@ -1998,7 +2172,6 @@ The EnableAuthAdminReadSession switch enables a recipient read session in Exchan Type: SwitchParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2008,12 +2181,15 @@ Accept wildcard characters: False ``` ### -EnableDownloadDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The EnableDownloadDomains parameter specifies that Outlook on the web downloads inline images from a different domain than the rest of Outlook on the web. Valid values are: - $true: Outlook on the web uses a different download domain for inline images (for example, downloads.contoso.com). Before you enable this setting, you need to create a CNAME record and certificate for this domain, and add the domain to the ExternalDownloadHostName and InternalDownloadHostName parameters on the Set-OwaVirtualDirectory cmdlet. -- $false: The setting is disabled. This is the default value. +- $false: The setting is disabled. This value is the default. For more information about the security vulnerability that's addressed by this parameter, and for detailed configuration instructions, see [CVE 2021 1730](https://msrc.microsoft.com/update-guide/vulnerability/CVE-2021-1730). @@ -2021,7 +2197,6 @@ For more information about the security vulnerability that's addressed by this p Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2031,6 +2206,9 @@ Accept wildcard characters: False ``` ### -EnableForwardingAddressSyncForMailboxes + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2039,7 +2217,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2049,6 +2226,9 @@ Accept wildcard characters: False ``` ### -EnableOrgWidePermissionOnScopedRoles + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. {{ Fill EnableOrgWidePermissionOnScopedRoles Description }} @@ -2057,7 +2237,6 @@ This parameter is available only in on-premises Exchange. Type: SwitchParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2067,18 +2246,20 @@ Accept wildcard characters: False ``` ### -EnableOutlookEvents + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EnableOutlookEvents parameter specifies whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to user calendars. Valid values are: - $true: Discovery of events from email messages is enabled. -- $false: Discovery of events from email messages is disabled. This is the default value. +- $false: Discovery of events from email messages is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2088,18 +2269,20 @@ Accept wildcard characters: False ``` ### -EndUserDLUpgradeFlowsDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EndUserDLUpgradeFlowsDisabled parameter specifies whether to prevent users from upgrading their own distribution groups to Microsoft 365 Groups in an Exchange Online organization. Valid values are: - $true: Users can upgrade distribution groups that they own to Microsoft 365 Groups. -- $false: Users can't upgrade distribution groups that they own to Microsoft 365 Groups. This is the default value. +- $false: Users can't upgrade distribution groups that they own to Microsoft 365 Groups. This value is the default. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2109,12 +2292,15 @@ Accept wildcard characters: False ``` ### -EndUserMailNotificationForDelayedDelicensingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- $false: Affected users don't receive periodic email notifications about losing access to their mailbox. This value is the default. The value of this parameter is meaningful on when the value of the DelayedDelicensingEnabled parameter is $true. @@ -2124,7 +2310,6 @@ Use the TenantAdminNotificationForDelayedDelicensingEnabled parameter to turn on Type: Boolean Parameter Sets: DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2134,13 +2319,15 @@ Accept wildcard characters: False ``` ### -EwsAllowEntourage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2150,6 +2337,9 @@ Accept wildcard characters: False ``` ### -EwsAllowList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsAllowList parameter specifies the applications that are allowed to access EWS or REST when the EwsApplicationAccessPolicy parameter is set to EwsAllowList. Other applications that aren't specified by this parameter aren't allowed to access EWS or REST. You identify the application by its user agent string value. Wildcard characters (\*) are supported. 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"`. @@ -2162,7 +2352,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2172,13 +2361,15 @@ Accept wildcard characters: False ``` ### -EwsAllowMacOutlook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsAllowMacOutlook parameter enables or disables access to mailboxes by Outlook for Mac clients that use Exchange Web Services (for example, Outlook for Mac 2011 or later). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2188,13 +2379,15 @@ Accept wildcard characters: False ``` ### -EwsAllowOutlook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsAllowOutlook parameter enables or disables access to mailboxes by Outlook clients that use Exchange Web Services. Outlook uses Exchange Web Services for free/busy, out-of-office settings, and calendar sharing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2204,18 +2397,20 @@ Accept wildcard characters: False ``` ### -EwsApplicationAccessPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsApplicationAccessPolicy parameter specifies the client applications that have access to EWS and REST. Valid values are: - EnforceAllowList: Only applications specified by the EwsAllowList parameter are allowed to access EWS and REST. Access by other applications is blocked. - EnforceBlockList: All applications are allowed to access EWS and REST, except for the applications specified by the EwsBlockList parameter. -Note that if the EwsAllowEntourage, EwsAllowMacOutlook or EwsAllowOutlook parameters are set to a true or false value, they take precedence for access to EWS by Entourage, Mac Outlook, or Outlook, respectively. +If the EwsAllowEntourage, EwsAllowMacOutlook or EwsAllowOutlook parameters are set to a true or false value, they take precedence for access to EWS by Entourage, Mac Outlook, or Outlook, respectively. ```yaml Type: EwsApplicationAccessPolicy Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2225,6 +2420,9 @@ Accept wildcard characters: False ``` ### -EwsBlockList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsBlockList parameter specifies the applications that aren't allowed to access EWS or REST when the EwsApplicationAccessPolicy parameter is set to EnforceBlockList. All other applications that aren't specified by this parameter are allowed to access EWS or REST. You identify the application by its user agent string value. Wildcard characters (\*) are supported. 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"`. @@ -2235,7 +2433,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2245,11 +2442,14 @@ Accept wildcard characters: False ``` ### -EwsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EwsEnabled parameter specifies whether to globally enable or disable EWS access for the entire organization, regardless of what application is making the request. Valid values are: - $true: All EWS access is enabled. - $false: All EWS access is disabled. -- $null (blank): The setting isn't configured. Access to EWS is controlled individually by the related EWS parameters (for example EwsAllowEntourage). This is the default value. +- $null (blank): The setting isn't configured. Access to EWS is controlled individually by the related EWS parameters (for example EwsAllowEntourage). This value is the default. This parameter has no affect on access to REST. @@ -2257,7 +2457,6 @@ This parameter has no affect on access to REST. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2267,6 +2466,9 @@ Accept wildcard characters: False ``` ### -ExchangeNotificationEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeNotificationEnabled parameter enables or disables Exchange notifications sent to administrators regarding their organizations. Valid input for this parameter is $true or $false. @@ -2275,7 +2477,6 @@ The ExchangeNotificationEnabled parameter enables or disables Exchange notificat Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2285,6 +2486,9 @@ Accept wildcard characters: False ``` ### -ExchangeNotificationRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeNotificationRecipients parameter specifies the recipients for Exchange notifications sent to administrators regarding their organizations. If the ExchangeNotificationEnabled parameter is set to $false, no notification messages are sent. Be sure to enclose values that contain spaces in quotation marks (") and separate multiple values with commas. If this parameter isn't set, Exchange notifications are sent to all administrators. @@ -2293,7 +2497,6 @@ The ExchangeNotificationRecipients parameter specifies the recipients for Exchan Type: MultiValuedProperty Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2303,6 +2506,9 @@ Accept wildcard characters: False ``` ### -FindTimeAttendeeAuthenticationEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FindTimeAttendeeAuthenticationEnabled parameter controls whether attendees are required to verify their identity in meeting polls using the FindTime Outlook add-in. Valid values are: @@ -2318,7 +2524,6 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2328,6 +2533,9 @@ Accept wildcard characters: False ``` ### -FindTimeAutoScheduleDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FindTimeAutoScheduleDisabled parameter controls automatically scheduling the meeting once a consensus is reached in meeting polls using the FindTime Outlook add-in. Valid values are: @@ -2343,7 +2551,6 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2353,11 +2560,14 @@ Accept wildcard characters: False ``` ### -FindTimeLockPollForAttendeesEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FindTimeLockPollForAttendeesEnabled controls whether the **Lock poll for attendees** setting is managed by the organization. Valid values are: -- $true: **Lock poll for attendees** is on. Attendees will not be able to suggest new times or edit other attendees. The meeting organizer can't turn off this setting (always on). +- $true: **Lock poll for attendees** is on. Attendees can't suggest new times or edit other attendees. The meeting organizer can't turn off this setting (always on). - $false: By default, **Lock poll for attendees** is off (initial default) or on (the user saved settings from last poll), but the meeting organizer is allowed to turn the setting off or on to allow or prevent attendees from suggesting new times or editing attendees. This setting overrides individual user settings. @@ -2368,7 +2578,6 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2378,11 +2587,14 @@ Accept wildcard characters: False ``` ### -FindTimeOnlineMeetingOptionDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FindTimeOnlineMeetingOptionDisabled parameter controls the availability of the **Online meeting** checkbox for Teams or Skype in meeting polls using the FindTime Outlook add-in. Valid values are: -- $true: The **Online meeting** checkbox is not available in the meeting poll in FindTime, and the meeting organizer can't change this setting. If your organization uses a third-party online meeting provider, the meeting organizer can make the meeting online using the third-party provider while creating the meeting based on the FindTime poll results. +- $true: The **Online meeting** checkbox is not available in the meeting poll in FindTime, and the meeting organizer can't change this setting. If your organization uses a non-Microsoft online meeting provider, the meeting organizer can make the meeting online using the non-Microsoft provider while creating the meeting based on the FindTime poll results. - $false: The **Online meeting** checkbox is available in the meeting poll in FindTime, so the meeting organizer can choose to select or not select this setting. This setting overrides individual user settings. @@ -2393,7 +2605,6 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2403,6 +2614,9 @@ Accept wildcard characters: False ``` ### -FocusedInboxOn + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FocusedInboxOn parameter enables or disables Focused Inbox for the organization. Valid values are: @@ -2418,7 +2632,6 @@ Focused Inbox is a replacement for Clutter that separates the Inbox into the Foc Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2428,6 +2641,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -2438,7 +2654,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2448,6 +2663,9 @@ Accept wildcard characters: False ``` ### -HierarchicalAddressBookRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HierarchicalAddressBookRoot parameter specifies the user, contact, or group to be used as the root organization for a hierarchical address book in the Exchange organization. You can use any value that uniquely identifies the recipient. For example: - Name @@ -2463,7 +2681,6 @@ The default value is blank. To reset this parameter, use the value $null. Type: UserContactGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2473,6 +2690,9 @@ Accept wildcard characters: False ``` ### -HybridRSVPEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The HybridRSVPEnabled parameter enables or disables Hybrid RSVP for your organization. Hybrid RSVP allows users the option to indicate if they will attend a meeting in-person or virtually when responding to a meeting invitation on Outlook. Valid values are: @@ -2484,7 +2704,6 @@ The HybridRSVPEnabled parameter enables or disables Hybrid RSVP for your organiz Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2494,6 +2713,9 @@ Accept wildcard characters: False ``` ### -Industry + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Industry parameter specifies the industry that best represents your organization. @@ -2502,7 +2724,6 @@ The Industry parameter specifies the industry that best represents your organiza Type: IndustryType Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2512,6 +2733,9 @@ Accept wildcard characters: False ``` ### -IPListBlocked + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter only affects Basic authentication connections. @@ -2534,7 +2758,6 @@ Changes to this parameter might take up to 4 hours to fully propagate across the Type: MultiValuedProperty Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2544,13 +2767,15 @@ Accept wildcard characters: False ``` ### -IsAgendaMailEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2560,6 +2785,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromOffboardMigration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IsExcludedFromOffboardMigration parameter specifies that no new moves from the cloud to your on-premises organization are permitted. When this flag is set, no offboarding move requests are allowed. @@ -2568,7 +2796,6 @@ The IsExcludedFromOffboardMigration parameter specifies that no new moves from t Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2578,6 +2805,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromOnboardMigration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IsExcludedFromOnboardMigration parameter specifies that no new moves from your on-premises organization to the cloud are permitted. When this flag is set, no onboarding move requests are allowed. @@ -2586,7 +2816,6 @@ The IsExcludedFromOnboardMigration parameter specifies that no new moves from yo Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2596,6 +2825,9 @@ Accept wildcard characters: False ``` ### -IsFfoMigrationInProgress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -2604,7 +2836,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2614,12 +2845,15 @@ Accept wildcard characters: False ``` ### -IsGroupFoldersAndRulesEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The IsGroupFoldersAndRulesEnabled specifies whether group owners (by default) can create folders and move messages (manually or by using Inbox rules) in Microsoft 365 Groups. Valid values are: - $true: Group owners can create folders and move messages between folders in Microsoft 365 Groups. -- $false: Group owners can't create folders or move messages between folders in Microsoft 365 Groups. This is the default value. +- $false: Group owners can't create folders or move messages between folders in Microsoft 365 Groups. This value is the default. To allow group owners to allow group users to create folders and moved messages in Microsoft 365 Groups, use the IsGroupMemberAllowedToEditContent parameter. @@ -2629,7 +2863,6 @@ For more information, see [Manage Folders and Rules feature in Microsoft 365 Gro Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2639,6 +2872,9 @@ Accept wildcard characters: False ``` ### -IsGroupMemberAllowedToEditContent + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The IsGroupMemberAllowedToEditContent parameter specifies whether group owners can allow group members to manage folders and messages in Microsoft 365 Groups. Valid values are: @@ -2651,7 +2887,7 @@ The IsGroupMemberAllowedToEditContent parameter specifies whether group owners c • 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. +- $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 value is the default. The value of this parameter is meaningful only when the value of the IsGroupFoldersAndRulesEnabled parameter is $true. @@ -2663,7 +2899,6 @@ For more information, see [Manage Folders and Rules feature in Microsoft 365 Gro Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2673,10 +2908,13 @@ Accept wildcard characters: False ``` ### -LeanPopoutEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LeanPopoutEnabled parameter specifies whether to enable faster loading of pop-out messages in Outlook on the web for Internet Explorer and Microsoft Edge. Valid values are: - $true: Lean pop-outs are enabled. -- $false: Lean pop-outs are disabled. This is the default value. +- $false: Lean pop-outs are disabled. This value is the default. **Notes**: @@ -2687,7 +2925,6 @@ The LeanPopoutEnabled parameter specifies whether to enable faster loading of po Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2697,16 +2934,18 @@ Accept wildcard characters: False ``` ### -LinkPreviewEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LinkPreviewEnabled parameter specifies whether link preview of URLs in email messages is allowed for the organization. Valid values are: -- $true: Link preview of URLs in email messages is allowed. Users can enable or disable link preview in their Outlook on the web settings. This is the default value. +- $true: Link preview of URLs in email messages is allowed. Users can enable or disable link preview in their Outlook on the web settings. This value is the default. - $false: Link preview of URLs in email messages is not allowed. Users can't enable link preview in their Outlook on the web settings. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2716,6 +2955,9 @@ Accept wildcard characters: False ``` ### -MailboxDataEncryptionEnabled + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. {{ Fill MailboxDataEncryptionEnabled Description }} @@ -2724,7 +2966,6 @@ This parameter is available only in on-premises Exchange. Type: SwitchParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -2734,13 +2975,15 @@ Accept wildcard characters: False ``` ### -MailTipsAllTipsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailTipsAllTipsEnabled parameter specifies whether MailTips are enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2750,13 +2993,15 @@ Accept wildcard characters: False ``` ### -MailTipsExternalRecipientsTipsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailTipsExternalRecipientsTipsEnabled parameter specifies whether MailTips for external recipients are enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2766,13 +3011,15 @@ Accept wildcard characters: False ``` ### -MailTipsGroupMetricsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailTipsGroupMetricsEnabled parameter specifies whether MailTips that rely on group metrics data are enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2782,13 +3029,15 @@ Accept wildcard characters: False ``` ### -MailTipsLargeAudienceThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailTipsLargeAudienceThreshold parameter specifies what a large audience is. The default value is 25. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2798,13 +3047,15 @@ Accept wildcard characters: False ``` ### -MailTipsMailboxSourcedTipsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailTipsMailboxSourcedTipsEnabled parameter specifies whether MailTips that rely on mailbox data (out-of-office or full mailbox) are enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2814,6 +3065,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderHomepage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ManagedFolderHomepage parameter specifies the URL of the web page that's displayed when users click the Managed Folders folder in Outlook. If a URL isn't specified, Outlook doesn't display a managed folders home page. @@ -2822,7 +3076,6 @@ The ManagedFolderHomepage parameter specifies the URL of the web page that's dis Type: String Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2832,11 +3085,14 @@ Accept wildcard characters: False ``` ### -MapiHttpEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MapiHttpEnabled parameter enables or disables access to mailboxes in Outlook by using MAPI over HTTP. Valid values are: -- $true: Access to mailboxes by using MAPI over HTTP is enabled. This is the default value. +- $true: Access to mailboxes by using MAPI over HTTP is enabled. This value is the default. - $false: Access to mailboxes by using MAPI over HTTP is disabled. You can use the MapiHttpEnabled parameter on the Set-CASMailbox cmdlet to override the global MAPI over HTTP settings for individual users. @@ -2845,7 +3101,6 @@ You can use the MapiHttpEnabled parameter on the Set-CASMailbox cmdlet to overri Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2855,6 +3110,9 @@ Accept wildcard characters: False ``` ### -MaskClientIpInReceivedHeadersEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MaskClientIpInReceivedHeadersEnabled Description }} @@ -2863,7 +3121,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2873,6 +3130,9 @@ Accept wildcard characters: False ``` ### -MatchSenderOrganizerProperties + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MatchSenderOrganizerProperties Description }} @@ -2881,7 +3141,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2891,6 +3150,9 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMigrations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxConcurrentMigrations parameter specifies the maximum number of concurrent migrations that your organization can configure at any specific time. @@ -2899,7 +3161,6 @@ The MaxConcurrentMigrations parameter specifies the maximum number of concurrent Type: Unlimited Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2909,6 +3170,9 @@ Accept wildcard characters: False ``` ### -MessageHighlightsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MessageHighlightsEnabled Description }} @@ -2917,7 +3181,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2927,6 +3190,9 @@ Accept wildcard characters: False ``` ### -MessageRecallAlertRecipientsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MessageRecallAlertRecipientsEnabled Description }} @@ -2935,7 +3201,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2945,6 +3210,9 @@ Accept wildcard characters: False ``` ### -MessageRecallAlertRecipientsReadMessagesOnlyEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MessageRecallAlertRecipientsReadMessagesOnlyEnabled Description }} @@ -2953,7 +3221,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2963,6 +3230,9 @@ Accept wildcard characters: False ``` ### -MessageRecallEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MessageRecallEnabled Description }} @@ -2971,7 +3241,6 @@ This parameter is available only in the cloud-based service. Type: System.Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2981,13 +3250,15 @@ Accept wildcard characters: False ``` ### -MessageRecallMaxRecallableAge + +> Applicable: Exchange Online + {{ Fill MessageRecallMaxRecallableAge Description }} ```yaml Type: Microsoft.Exchange.Data.EnhancedTimeSpan Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2997,6 +3268,9 @@ Accept wildcard characters: False ``` ### -MessageRemindersEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MessageRemindersEnabled parameter enables or disables the message reminders feature in the organization. Valid values are: @@ -3008,7 +3282,6 @@ The MessageRemindersEnabled parameter enables or disables the message reminders Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3018,9 +3291,12 @@ Accept wildcard characters: False ``` ### -MicrosoftExchangeRecipientEmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The MicrosoftExchangeRecipientEmailAddresses parameter specifies one or more email addresses for the recipient. All valid Microsoft Exchange email address types may be used. You can specify multiple values for this parameter as a comma-delimited list. If the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter is set to $true, the email addresses are automatically generated by the default email address policy. This means you can't use the MicrosoftExchangeRecipientEmailAddresses parameter. +The MicrosoftExchangeRecipientEmailAddresses parameter specifies one or more email addresses for the recipient. All valid Microsoft Exchange email address types might be used. You can specify multiple values for this parameter as a comma-delimited list. If the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter is set to $true, the email addresses are automatically generated by the default email address policy. This means you can't use the MicrosoftExchangeRecipientEmailAddresses parameter. Email addresses that you specify by using the MicrosoftExchangeRecipientEmailAddresses parameter replace any existing email addresses already configured. @@ -3028,7 +3304,6 @@ Email addresses that you specify by using the MicrosoftExchangeRecipientEmailAdd Type: ProxyAddressCollection Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3038,6 +3313,9 @@ Accept wildcard characters: False ``` ### -MicrosoftExchangeRecipientEmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter specifies whether the default email address policy is automatically applied to the Exchange recipient. The default value is $true. If this parameter is set to $true, Exchange automatically adds new email addresses to the Exchange recipient when email address policies are added or modified in the Exchange organization. If this parameter is set to $false, you must manually add new email addresses to the Exchange recipient when email address policies are added or modified. @@ -3048,7 +3326,6 @@ If you change the value of the MicrosoftExchangeRecipientEmailAddressPolicyEnabl Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3058,6 +3335,9 @@ Accept wildcard characters: False ``` ### -MicrosoftExchangeRecipientPrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MicrosoftExchangeRecipientPrimarySmtpAddress parameter specifies the primary return SMTP email address for the Exchange recipient. If the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter is set to $true, you can't use the MicrosoftExchangeRecipientPrimarySmtpAddress parameter. @@ -3070,7 +3350,6 @@ The MicrosoftExchangeRecipientPrimarySmtpAddress parameter is meaningful only if Type: SmtpAddress Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3080,6 +3359,9 @@ Accept wildcard characters: False ``` ### -MicrosoftExchangeRecipientReplyRecipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MicrosoftExchangeRecipientReplyRecipient parameter specifies the recipient that should receive messages sent to the Exchange recipient. Typically, you would configure a mailbox to receive the messages sent to the Exchange recipient. You can use any value that uniquely identifies the recipient: For example: @@ -3095,7 +3377,6 @@ The MicrosoftExchangeRecipientReplyRecipient parameter specifies the recipient t Type: RecipientIdParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3105,6 +3386,9 @@ Accept wildcard characters: False ``` ### -MitigationsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MitigationsEnabled parameter specifies whether the Exchange Emergency Mitigation service (EM service) is enabled in the organization. Valid values are: @@ -3118,7 +3402,6 @@ For more information, see [Exchange Emergency Mitigation (EM) service](https://l Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3128,20 +3411,20 @@ Accept wildcard characters: False ``` ### -MobileAppEducationEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MobileAppEducationEnabled specifies whether to show or hide the Outlook for iOS and Android education reminder in Outlook on the web (formerly known as Outlook Web App). Valid values are: -- $true: Outlook on the web and Outlook desktop will show the education reminder to users who aren't using Outlook for iOS and Android to check their company email and calendar events. This is the default value. +- $true: Outlook on the web and Outlook desktop show the education reminder to users who aren't using Outlook for iOS and Android to check their company email and calendar events. This value is the default. - $false: The Outlook for iOS and Android education reminder is disabled. -This setting will affect Outlook desktop at some point in the future. - ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3151,6 +3434,9 @@ Accept wildcard characters: False ``` ### -OabShadowDistributionOldestFileAgeLimit + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. {{ Fill OabShadowDistributionOldestFileAgeLimit Description }} @@ -3159,7 +3445,6 @@ This parameter is available only in on-premises Exchange. Type: EnhancedTimeSpan Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -3169,12 +3454,15 @@ Accept wildcard characters: False ``` ### -OAuth2ClientProfileEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OAuth2ClientProfileEnabled parameter enables or disables modern authentication in the Exchange organization. Valid values are: - $true: modern authentication is enabled. - $false: modern authentication is disabled. -modern authentication is based on the Active Directory Authentication Library (ADAL) and OAuth 2.0, and enables authentication features like multi-factor authentication (MFA), certificate-based authentication (CBA), and third-party SAML identity providers. +modern authentication is based on the Active Directory Authentication Library (ADAL) and OAuth 2.0, and enables authentication features like multi-factor authentication (MFA), certificate-based authentication (CBA), and non-Microsoft SAML identity providers. When you enable modern authentication in Exchange Online, we recommend that you also enable it in Skype for Business Online. For more information, see [Skype for Business Online: Enable your tenant for modern authentication](https://aka.ms/SkypeModernAuth). @@ -3182,7 +3470,6 @@ When you enable modern authentication in Exchange Online, we recommend that you Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3192,6 +3479,9 @@ Accept wildcard characters: False ``` ### -OnlineMeetingsByDefaultEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetings as Teams or Skype for Business by default during meeting creation. Valid values are: @@ -3200,13 +3490,12 @@ The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetin - $false: All meetings are not online by default. - $null: If the organization value has not been specified, the default behavior is for meetings to be online. -If a user has already directly interacted with this setting in Outlook or Outlook on the web (formerly known as Outlook Web App or OWA), the value of this parameter is ignored. Eventually, this parameter will override the Outlook-configured setting. +If a user has already directly interacted with this setting in Outlook or Outlook on the web (formerly known as Outlook Web App or OWA), the value of this parameter is ignored. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3216,6 +3505,9 @@ Accept wildcard characters: False ``` ### -OrganizationSummary + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The OrganizationSummary parameter specifies a summarized description that best represents your organization. @@ -3224,7 +3516,6 @@ The OrganizationSummary parameter specifies a summarized description that best r Type: MultiValuedProperty Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3234,18 +3525,20 @@ Accept wildcard characters: False ``` ### -OutlookGifPickerDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookGifPickerDisabled parameter disables the GIF Search (powered by Bing) feature that's built into the Compose page in Outlook on the web. Valid values are: - $true: GIF Search in Outlook on the web is disabled. -- $false: GIF Search in Outlook on the web is enabled. This is the default value. +- $false: GIF Search in Outlook on the web is enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3255,17 +3548,20 @@ Accept wildcard characters: False ``` ### -OutlookMobileGCCRestrictionsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookMobileGCCRestrictionsEnabled parameter specifies whether to enable or disable features within Outlook for iOS and Android that are not FedRAMP compliant for Microsoft 365 US Government Community Cloud (GCC) customers. Valid values are: -- $true: Disable features that aren't FedRAMP compliant for GCC customers. This is the default value for all GCC customers. +- $true: Disable features that aren't FedRAMP compliant for GCC customers. This value is the default for all GCC customers. - $false: Enable features that aren't FedRAMP compliant for GCC customers. The Outlook for iOS and Android feature and services that are not FedRAMP compliant for Microsoft 365 US Government customers include: - Multi-account support -- Third-party services +- Non-Microsoft services - HelpShift and in-app support - Any Microsoft services that are outside the Microsoft 365 US Government Community Cloud (for example, Bing and Cortana). @@ -3275,7 +3571,6 @@ The Outlook for iOS and Android feature and services that are not FedRAMP compli Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3285,6 +3580,9 @@ Accept wildcard characters: False ``` ### -OutlookMobileHelpShiftEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -3293,7 +3591,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3303,6 +3600,9 @@ Accept wildcard characters: False ``` ### -OutlookMobileSingleAccountEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -3311,7 +3611,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3321,6 +3620,9 @@ Accept wildcard characters: False ``` ### -OutlookPayEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookPayEnabled parameter enables or disables Microsoft Pay in the Microsoft 365 organization. Valid values are: @@ -3332,7 +3634,6 @@ The OutlookPayEnabled parameter enables or disables Microsoft Pay in the Microso Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3342,6 +3643,9 @@ Accept wildcard characters: False ``` ### -OutlookTextPredictionDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill OutlookTextPredictionDisabled Description }} @@ -3350,7 +3654,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3360,12 +3663,15 @@ Accept wildcard characters: False ``` ### -PermanentlyDeleteDisabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The PermanentlyDeleteDisabled parameter specifies whether to disable the PermanentlyDelete retention action for messaging records management (MRM). Valid values are: -- $true The PermanentlyDelete retention action is disabled. This setting only prevents items from being permanently deleted. It doesn't modify existing polices, block the creation of policies with the PermanentlyDelete action or notify users that thePermanentlyDelete action won't actually take effect. -- $false The PermanentlyDelete retention action is enabled. This is the default value. +- $true The PermanentlyDelete retention action is disabled. This setting only prevents items from being permanently deleted. It doesn't modify existing policies, block the creation of policies with the PermanentlyDelete action, or notify users that thePermanentlyDelete action doesn't actually take effect. +- $false The PermanentlyDelete retention action is enabled. This value is the default. A message that's permanently deleted can't be recovered by using the Recoverable Items folder. Additionally, permanently deleted messages aren't returned by a Discovery search, unless litigation hold or single item recovery is enabled for the mailbox. @@ -3373,7 +3679,6 @@ A message that's permanently deleted can't be recovered by using the Recoverable Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -3383,15 +3688,17 @@ Accept wildcard characters: False ``` ### -PerTenantSwitchToESTSEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -This parameter has been deprecated and is no longer used. +This parameter is deprecated and no longer used. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3401,6 +3708,9 @@ Accept wildcard characters: False ``` ### -PostponeRoamingSignaturesUntilLater + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PostponeRoamingSignaturesUntilLater parameter controls whether roaming signatures are enabled or disabled in Outlook on the web (formerly known as Outlook Web App or OWA) and the new Outlook for Windows. Valid values are: @@ -3409,7 +3719,7 @@ The PostponeRoamingSignaturesUntilLater parameter controls whether roaming signa 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. +- $false: Roaming signatures are enabled for Outlook on the web and the new Outlook for Windows. This value is the default. 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). @@ -3420,7 +3730,6 @@ We have no plans to support roaming signature management in the Microsoft Graph Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3430,13 +3739,15 @@ Accept wildcard characters: False ``` ### -PreferredInternetCodePageForShiftJis + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3446,13 +3757,15 @@ Accept wildcard characters: False ``` ### -PublicComputersDetectionEnabled -The PublicComputersDetectionEnabled parameter specifies whether Outlook on the web will detect when a user signs from a public or private computer or network, and then enforces the attachment handling settings from public networks. The default is $false. However, if you set this parameter to $true, Outlook on the web will determine if the user is signing in from a public computer, and all public attachment handling rules will be applied and enforced. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The PublicComputersDetectionEnabled parameter specifies whether Outlook on the web detects when a user signs from a public or private computer or network, and then enforces the attachment handling settings from public networks. The default is $false. However, if you set this parameter to $true, Outlook on the web determines if the user is signing in from a public computer, and all public attachment handling rules are applied and enforced. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3462,6 +3775,9 @@ Accept wildcard characters: False ``` ### -PublicFolderContentReplicationDisabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The PublicFolderContentReplicationDisabled parameter is used during public folder migration. When you set the PublicFolderContentReplicationDisabled parameter to $true, public folder content is not replicated to Exchange during the initial migration. The default value is $false. @@ -3470,7 +3786,6 @@ The PublicFolderContentReplicationDisabled parameter is used during public folde Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -3480,18 +3795,20 @@ Accept wildcard characters: False ``` ### -PublicFolderMailboxesLockedForNewConnections + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PublicFolderMailboxesLockedForNewConnections parameter specifies whether users are allowed to make new connections to public folder mailboxes. Valid values are: - $true: Users aren't allowed to make new connections to public folder mailboxes. You use this setting during the final stages of public folder migrations. -- $false: Users are allowed to make new connections to public folder mailboxes. This is the default value. +- $false: Users are allowed to make new connections to public folder mailboxes. This value is the default. ```yaml Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3501,18 +3818,20 @@ Accept wildcard characters: False ``` ### -PublicFolderMailboxesMigrationComplete + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PublicFolderMailboxesMigrationComplete parameter is used during public folder migration. - $true: Queued messages are rerouted to the new destination. -- $false (This is the default value) +- $false (default value) ```yaml Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3522,6 +3841,9 @@ Accept wildcard characters: False ``` ### -PublicFolderMigrationComplete + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PublicFolderMigrationComplete parameter is used during public folder migration. When you set the PublicFolderMigrationComplete parameter to $true, transport starts rerouting the queued messages to a new destination. The default value is $false. @@ -3530,7 +3852,6 @@ The PublicFolderMigrationComplete parameter is used during public folder migrati Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3540,6 +3861,9 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublicFoldersEnabled parameter specifies how public folders are deployed in your organization. Valid values are: - Local: The public folders are deployed locally in your organization. @@ -3550,7 +3874,6 @@ The PublicFoldersEnabled parameter specifies how public folders are deployed in Type: PublicFoldersDeployment Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3560,16 +3883,18 @@ Accept wildcard characters: False ``` ### -PublicFolderShowClientControl + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublicFolderShowClientControl parameter enables or disables the control access feature for public folders in Microsoft Outlook. Valid values are: - $true: User access to public folders in Outlook is controlled by the value of the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet (the default value is $false). -- $false: This is the default value. User access to public folders in Outlook is enabled (the control access feature is disabled). The value of the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet is meaningless. +- $false: This value is the default. User access to public folders in Outlook is enabled (the control access feature is disabled). The value of the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet is meaningless. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3579,6 +3904,9 @@ Accept wildcard characters: False ``` ### -PublicFoldersLockedForMigration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PublicFoldersLockedForMigration parameter specifies whether users are locked out from accessing down level public folder servers. When you set the PublicFoldersLockedForMigration parameter to $true, users are locked out from accessing down level public folder servers. This is used for public folder migration during final stages. The default value is $false, which means that the user is able to access public folder servers. @@ -3587,7 +3915,6 @@ The PublicFoldersLockedForMigration parameter specifies whether users are locked Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3597,13 +3924,15 @@ Accept wildcard characters: False ``` ### -ReadTrackingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReadTrackingEnabled parameter specifies whether the tracking for read status for messages in an organization is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3613,6 +3942,9 @@ Accept wildcard characters: False ``` ### -RecallReadMessagesEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RecallReadMessagesEnabled Description }} @@ -3621,7 +3953,6 @@ This parameter is available only in the cloud-based service. Type: System.Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3631,13 +3962,15 @@ Accept wildcard characters: False ``` ### -RefreshSessionEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3647,6 +3980,9 @@ Accept wildcard characters: False ``` ### -RejectDirectSend + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RejectDirectSend Description }} @@ -3655,7 +3991,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3665,13 +4000,15 @@ Accept wildcard characters: False ``` ### -RemotePublicFolderMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3681,13 +4018,15 @@ Accept wildcard characters: False ``` ### -RequiredCharsetCoverage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3697,6 +4036,9 @@ Accept wildcard characters: False ``` ### -SCLJunkThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SCLJunkThreshold parameter specifies the spam confidence level (SCL) threshold. Messages with an SCL greater than the value that you specify for the SCLJunkThreshold parameter are moved to the Junk Email folder. Valid values are integers from 0 through 9, inclusive. @@ -3705,7 +4047,6 @@ The SCLJunkThreshold parameter specifies the spam confidence level (SCL) thresho Type: Int32 Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3715,12 +4056,15 @@ Accept wildcard characters: False ``` ### -SendFromAliasEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SendFromAliasEnabled parameter allows mailbox users to send messages using aliases (proxy addresses). Valid values are: -- $true: Aliases on messages will no longer be rewritten to their primary SMTP addresses. Compatible Outlook clients will allow sending from aliases and replying to aliases. Even without an updated Outlook client, users might see changes in behavior because the setting affects all messages sent and received by a mailbox. -- $false: Aliases on messages sent or received will be rewritten to their primary email address. This is the default value. +- $true: Aliases on messages are no longer rewritten to their primary SMTP addresses. Compatible Outlook clients allow sending from aliases and replying to aliases. Even without an updated Outlook client, users might see changes in behavior because the setting affects all messages sent and received by a mailbox. +- $false: Aliases on messages sent or received are rewritten to their primary email address. This value is the default. For more information about the availability of the feature in Outlook on the web, see the [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Exchange&searchterms=59437). For Outlook for Windows, see this [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Outlook&searchterms=64123). @@ -3728,7 +4072,6 @@ For more information about the availability of the feature in Outlook on the web Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3738,6 +4081,9 @@ Accept wildcard characters: False ``` ### -SharedDomainEmailAddressFlowEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SharedDomainEmailAddressFlowEnabled Description }} @@ -3746,7 +4092,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3756,13 +4101,15 @@ Accept wildcard characters: False ``` ### -SiteMailboxCreationURL + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SiteMailboxCreationURL parameter specifies the URL that's used to create site mailboxes. Site mailboxes improve collaboration and user productivity by allowing access to both SharePoint documents and Exchange email in Outlook 2013 or later. ```yaml Type: Uri Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3772,16 +4119,18 @@ Accept wildcard characters: False ``` ### -SmtpActionableMessagesEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SmtpActionableMessagesEnabled parameter specifies whether to enable or disable action buttons in email messages in Outlook on the web. Valid values are: -- $true: Action buttons in email messages are enabled. This is the default value. +- $true: Action buttons in email messages are enabled. This value is the default. - $false: Action buttons in email messages are disabled. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3791,12 +4140,15 @@ Accept wildcard characters: False ``` ### -TenantAdminNotificationForDelayedDelicensingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- $false: Disable weekly Service Health advisory notifications about the number of Exchange Online delicensed users. This value is the default. For more information about Service Health, see [How to check Microsoft 365 service health](https://learn.microsoft.com/microsoft-365/enterprise/view-service-health). @@ -3808,7 +4160,26 @@ Use the EndUserMailNotificationForDelayedDelicensingEnabled to send affected use 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 + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill TwoClickMailPreviewEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: Required: False Position: Named @@ -3818,15 +4189,17 @@ Accept wildcard characters: False ``` ### -UMAvailableLanguages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -This parameter has been deprecated and is no longer used. +This parameter is deprecated and no longer used. ```yaml Type: MultiValuedProperty Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3836,13 +4209,15 @@ Accept wildcard characters: False ``` ### -UnblockUnsafeSenderPromptEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3852,6 +4227,9 @@ Accept wildcard characters: False ``` ### -UseIcsSyncStateStreaming + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. {{ Fill UseIcsSyncStateStreaming Description }} @@ -3860,7 +4238,6 @@ This parameter is available only in on-premises Exchange. Type: SwitchParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3870,9 +4247,12 @@ Accept wildcard characters: False ``` ### -VisibleMeetingUpdateProperties + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The VisibleMeetingUpdateProperties parameter specifies whether meeting message updates will be auto-processed on behalf of attendees. Auto-processed updates are applied to the attendee's calendar item, and then the meeting message is moved to the deleted items. The attendee never sees the update in their inbox, but their calendar is updated. +The VisibleMeetingUpdateProperties parameter specifies whether meeting message updates are auto-processed on behalf of attendees. Auto-processed updates are applied to the attendee's calendar item, and then the meeting message is moved to the deleted items. The attendee never sees the update in their inbox, but their calendar is updated. This parameter uses the syntax: `"MeetingProperty1:MeetingStartTimeWithinXMinutes1,MeetingProperty2:MeetingStartTimeWithinXMinutes2,...MeetingPropertyN:MeetingStartTimeWithinXMinutesN"`. @@ -3890,11 +4270,11 @@ The valid meeting properties to monitor for updates are: - Reminder: The reminder time. - AllProperties: Any meeting change. -If you don't specify a MeetingStartTimeWithinXMinutes value for the meeting property, any change to the meeting property will result in visible meeting update messages (regardless of how soon or how far away the meeting is). For updates to recurring meetings, the meeting start time is the start time of the next occurrence in the series. +If you don't specify a MeetingStartTimeWithinXMinutes value for the meeting property, any change to the meeting property results in visible meeting update messages (regardless of how soon or how far away the meeting is). For updates to recurring meetings, the meeting start time is the start time of the next occurrence in the series. The default value is `"Location,AllProperties:15"`: changes to the meeting location at any time, or changes to other meeting properties within 15 minutes of the meeting start time results in visible meeting update messages. -In the following scenarios, meeting update messages are not auto-processed, regardless of the values specified in this parameter. In these scenarios, attendees will always see meeting update messages in their Inbox: +In the following scenarios, meeting update messages are not auto-processed, regardless of the values specified in this parameter. In these scenarios, attendees always see meeting update messages in their Inbox: - The update contains a change to the meeting date, time, or recurrence pattern. - The meeting message is received for a delegated shared calendar. @@ -3905,7 +4285,6 @@ In the following scenarios, meeting update messages are not auto-processed, rega Type: String Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3915,6 +4294,9 @@ Accept wildcard characters: False ``` ### -WACDiscoveryEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The WacDiscoveryEndpoint parameter specifies the discovery endpoint for Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server) for all mailboxes in the organization. For example, `https://oos.internal.contoso.com/hosting/discovery`. @@ -3925,7 +4307,6 @@ Office Online Server enables users to view supported file attachments in Outlook Type: String Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3935,18 +4316,20 @@ Accept wildcard characters: False ``` ### -WebPushNotificationsDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WebPushNotificationsDisabled parameter specifies whether to enable or disable Web Push Notifications in Outlook on the Web. This feature provides web push notifications which appear on a user's desktop while the user is not using Outlook on the Web. This brings awareness of incoming messages while they are working elsewhere on their computer. Valid values are: - $true: Web Push Notifications are disabled. -- $false: Web Push Notifications are enabled. This is the default value. +- $false: Web Push Notifications are enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3956,18 +4339,20 @@ Accept wildcard characters: False ``` ### -WebSuggestedRepliesDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WebSuggestedRepliesDisabled parameter specifies whether to enable or disable Suggested Replies in Outlook on the web. This feature provides suggested replies to emails so users can easily and quickly respond to messages. Valid values are: - $true: Suggested Replies are disabled. -- $false: Suggested Replies are enabled. This is the default value. +- $false: Suggested Replies are enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3977,13 +4362,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3993,6 +4380,9 @@ Accept wildcard characters: False ``` ### -WorkspaceTenantEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WorkspaceTenantEnabled parameter enables or disables workspace booking in the organization. Valid values are: @@ -4004,7 +4394,6 @@ The WorkspaceTenantEnabled parameter enables or disables workspace booking in th Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationRelationship.md similarity index 77% rename from exchange/exchange-ps/exchange/Set-OrganizationRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OrganizationRelationship.md index f21e2920e4..34afdbd64c 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationRelationship.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-OrganizationRelationship -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-organizationrelationship +schema: 2.0.0 +title: Set-OrganizationRelationship --- # Set-OrganizationRelationship ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-OrganizationRelationship cmdlet to modify existing organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments. @@ -51,7 +52,7 @@ Set-OrganizationRelationship [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,6 +73,9 @@ This example disables the organization relationship with Contoso ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the organization relationship that you want to modify. You can use any value that uniquely identifies the organization relationship. For example: - Name @@ -82,7 +86,6 @@ The Identity parameter specifies the organization relationship that you want to Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -92,16 +95,18 @@ Accept wildcard characters: False ``` ### -ArchiveAccessEnabled -The ArchiveAccessEnabled parameter specifies whether the organization relationship has been configured to provide remote archive access. Valid values are: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + +The ArchiveAccessEnabled parameter specifies whether the organization relationship is configured to provide remote archive access. Valid values are: - $true: The external organization provides remote access to mailbox archives. -- $false: The external organization doesn't provide remote access to mailbox archives. This is the default value +- $false: The external organization doesn't provide remote access to mailbox archives. This value is the default ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -120,7 +128,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -130,18 +137,20 @@ Accept wildcard characters: False ``` ### -DeliveryReportEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DeliveryReportEnabled parameter specifies whether Delivery Reports should be shared over the organization relationship. Valid values are: - $true: Delivery Reports should be shared over the organization relationship. This value means the organization has agreed to share all Delivery Reports with the external organization, and the organization relationship should be used to retrieve Delivery Report information from the external organization. -- $false: Delivery Reports shouldn't be shared over the organization relationship. This is the default value +- $false: Delivery Reports shouldn't be shared over the organization relationship. This value is the default -For message tracking to work in a cross-premises Exchange scenario, this parameter must be set to $true on both sides of the organization relationship. If the value of this parameter is set to $false on one or both sides of the organization relationship, message tracking between the organizations won't work in either direction. +For message tracking to work in a cross-premises Exchange scenario, this parameter must be set to $true on both sides of the organization relationship. If the value of this parameter is set to $false on one or both sides of the organization relationship, message tracking between the organizations doesn't work in either direction. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,6 +160,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -159,7 +171,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,13 +180,15 @@ Accept wildcard characters: False ``` ### -DomainNames + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DomainNames parameter specifies the SMTP domains of the external organization. You can specify multiple domains separated by commas (for example, "contoso.com","northamerica.contoso.com"). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -185,16 +198,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether to enable the organization relationship. Valid values are: -- $true: The organization relationship is enabled. This is the default value. +- $true: The organization relationship is enabled. This value is the default. - $false: The organization relationship is disabled. This value completely stops sharing for the organization relationship. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -204,6 +219,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -212,7 +230,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -222,10 +239,13 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The FreeBusyAccessEnabled parameter specifies whether the organization relationship should be used to retrieve free/busy information from the external organization. Valid values are: - $true: Free/busy information is retrieved from the external organization. -- $false: Free/busy information isn't retrieved from the external organization. This is the default value. +- $false: Free/busy information isn't retrieved from the external organization. This value is the default. You control the free/busy access level and scope by using the FreeBusyAccessLevel and FreeBusyAccessScope parameters. @@ -233,7 +253,6 @@ You control the free/busy access level and scope by using the FreeBusyAccessLeve Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization. Valid values are: - None: No free/busy access. @@ -255,7 +277,6 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: FreeBusyAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The FreeBusyAccessScope parameter specifies a mail-enabled security group in the internal organization that contains users whose free/busy information is accessible by an external organization. You can use any value that uniquely identifies the group. For example: - Name @@ -278,7 +302,6 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -288,6 +311,9 @@ Accept wildcard characters: False ``` ### -MailboxMoveCapability + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The MailboxMoveCapability parameter is used in cross-tenant mailbox migrations. Valid values are: @@ -303,7 +329,6 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MailboxMoveCapability Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,16 +338,18 @@ Accept wildcard characters: False ``` ### -MailboxMoveEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailboxMoveEnabled parameter specifies whether the organization relationship enables moving mailboxes to or from the external organization. Valid values are: - $true: Mailbox moves to or from the external organization are allowed. -- $false: Mailbox moves to from the external organization aren't allowed. This is the default value. +- $false: Mailbox moves to from the external organization aren't allowed. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -332,6 +359,9 @@ Accept wildcard characters: False ``` ### -MailboxMovePublishedScopes + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The MailboxMovePublishedScopes parameter is used in cross-tenant mailbox migrations to specify the mail-enabled security groups whose members are allowed to migrate. You can use any value that uniquely identifies the group. For example: @@ -351,7 +381,6 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -361,10 +390,13 @@ Accept wildcard characters: False ``` ### -MailTipsAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTipsAccessEnabled parameter specifies whether MailTips for users in this organization are returned over this organization relationship. Valid values are: - $true: MailTips for users in this organization are returned over the organization relationship. -- $false: MailTips for users in this organization aren't returned over the organization relationship. This is the default value. +- $false: MailTips for users in this organization aren't returned over the organization relationship. This value is the default. You control the MailTips access level by using the MailTipsAccessLevel parameter. @@ -372,7 +404,6 @@ You control the MailTips access level by using the MailTipsAccessLevel parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -382,11 +413,14 @@ Accept wildcard characters: False ``` ### -MailTipsAccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTipsAccessLevel parameter specifies the level of MailTips data externally shared over this organization relationship. This parameter can have the following values: - All: All MailTips are returned, but the recipients in the remote organization are considered external. For the Auto Reply MailTip, the external Auto Reply message is returned. -- Limited: Only those MailTips that could prevent a non-delivery report (NDR) or an Auto Reply are returned. Custom MailTips, the Large Audience MailTip, and Moderated Recipient MailTips won't be returned. -- None: No MailTips are returned to the remote organization. This is the default value. +- Limited: Only those MailTips that could prevent a non-delivery report (NDR) or an Auto Reply are returned. Custom MailTips, the Large Audience MailTip, and Moderated Recipient MailTips aren't returned. +- None: No MailTips are returned to the remote organization. This value is the default. This parameter is only meaningful when the MailTipsAccessEnabled parameter value is $true. @@ -394,7 +428,6 @@ This parameter is only meaningful when the MailTipsAccessEnabled parameter value Type: MailTipsAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -404,6 +437,9 @@ Accept wildcard characters: False ``` ### -MailTipsAccessScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MailTipsAccessScope parameter specifies a mail-enabled security group in the internal organization that contains users whose free/busy information is accessible by an external organization. You can use any value that uniquely identifies the group. For example: - Name @@ -427,7 +463,6 @@ This restriction only applies to mailboxes, mail users, and mail contacts. It do Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -437,13 +472,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the organization relationship. The maximum length is 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -453,6 +490,9 @@ Accept wildcard characters: False ``` ### -OAuthApplicationId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the application ID of the mailbox migration app that you consented to. For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). @@ -461,7 +501,6 @@ The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -471,13 +510,15 @@ Accept wildcard characters: False ``` ### -OrganizationContact + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OrganizationContact parameter specifies the email address that can be used to contact the external organization (for example, administrator@fourthcoffee.com). ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -487,16 +528,18 @@ Accept wildcard characters: False ``` ### -PhotosEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PhotosEnabled parameter specifies whether photos for users in the internal organization are returned over the organization relationship. Valid values are: - $true: Photos for users in this organization are returned over the organization relationship. -- $false: Photos for users in this organization aren't returned over the organization relationship. This is the default value. +- $false: Photos for users in this organization aren't returned over the organization relationship. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -506,13 +549,15 @@ Accept wildcard characters: False ``` ### -TargetApplicationUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TargetApplicationUri parameter specifies the target Uniform Resource Identifier (URI) of the external organization. The TargetApplicationUri parameter is specified by Exchange when requesting a delegated token to retrieve free and busy information, for example, mail.contoso.com. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -522,13 +567,15 @@ Accept wildcard characters: False ``` ### -TargetAutodiscoverEpr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, `https://contoso.com/autodiscover/autodiscover.svc/wssecurity`. Exchange uses Autodiscover to automatically detect the correct Exchange server endpoint to use for external requests. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -538,13 +585,15 @@ Accept wildcard characters: False ``` ### -TargetOwaURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TargetOwaURL parameter specifies the Outlook on the web (formerly Outlook Web App) URL of the external organization that's defined in the organization relationship. It is used for Outlook on the web redirection in a cross-premise Exchange scenario. Configuring this attribute enables users in the organization to use their current Outlook on the web URL to access Outlook on the web in the external organization. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -554,6 +603,9 @@ Accept wildcard characters: False ``` ### -TargetSharingEpr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services for the external organization. If you use this parameter, this URL is always used to reach the external Exchange server. TheURL that's specified by the TargetAutoDiscoverEpr parameter isn't used to locate the external Exchange server. @@ -562,7 +614,6 @@ If you use this parameter, this URL is always used to reach the external Exchang Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -572,13 +623,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OrganizationSegment.md b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationSegment.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-OrganizationSegment.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OrganizationSegment.md index 49cf493921..89cb5abe15 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationSegment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationSegment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationsegment applicable: Security & Compliance -title: Set-OrganizationSegment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-organizationsegment +schema: 2.0.0 +title: Set-OrganizationSegment --- # Set-OrganizationSegment @@ -43,6 +44,9 @@ In this example, for the segment that has the GUID c96e0837-c232-4a8a-841e-ef457 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the organization segment that you want to modify. You can use any value that uniquely identifies the segment. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the organization segment that you want to modif Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -UserGroupFilter + +> Applicable: Security & Compliance + The UserGroupFilter parameter uses OPATH filter syntax to specify the members of the organization segment. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"MemberOf -eq 'Engineering Department'"` or `"ExtensionAttribute1 -eq 'DayTrader'"`). - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -76,7 +82,6 @@ Use the same property for all of your segments, and verify that your segments do Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -100,4 +105,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Set-OutboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-OutboundConnector.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-OutboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OutboundConnector.md index a73f8dfcd5..aa46e84863 100644 --- a/exchange/exchange-ps/exchange/Set-OutboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OutboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-outboundconnector applicable: Exchange Online, Exchange Online Protection -title: Set-OutboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-outboundconnector +schema: 2.0.0 +title: Set-OutboundConnector --- # Set-OutboundConnector @@ -49,7 +50,7 @@ Set-OutboundConnector [-Identity] ## DESCRIPTION Outbound connectors send email messages to remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,6 +64,9 @@ This example changes the settings of the existing Outbound connector named Conto ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the connector you want to modify. You can use any value that uniquely identifies the connector. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the connector you want to modify. You can use a Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -83,10 +86,13 @@ Accept wildcard characters: False ``` ### -AllAcceptedDomains + +> Applicable: Exchange Online, Exchange Online Protection + The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: - $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. This setting requires OnPremises for the ConnectorType value. -- $false: The Outbound connector isn't used in hybrid organizations. This is the default value. +- $false: The Outbound connector isn't used in hybrid organizations. This value is the default. This parameter is effective only for OnPremises connectors. @@ -94,7 +100,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -104,20 +109,22 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. Valid values are: -- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This is the default value for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. +- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This value is the default for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. - $false: The connector isn't used for mail flow in hybrid organizations, so any cross-premises headers are removed from messages that flow through the connector. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -127,13 +134,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -152,7 +164,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -162,9 +173,12 @@ Accept wildcard characters: False ``` ### -ConnectorSource + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorSource parameter specifies how the connector is created. Valid values are: -- Default: The connector is manually created. This is the default value for manually created connectors, and we recommend that you don't change this value. +- Default: The connector is manually created. This value is the default for manually created connectors, and we recommend that you don't change this value. - HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. - Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. @@ -172,7 +186,6 @@ The ConnectorSource parameter specifies how the connector is created. Valid valu Type: TenantConnectorSource Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -182,6 +195,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid values are: - Partner: The connector services domains that are external to your organization. @@ -191,7 +207,6 @@ The ConnectorType parameter specifies a category for the domains that are servic Type: TenantConnectorType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -201,16 +216,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether to enable or disable the Outbound connector. Valid values are: -- $true: The connector is enabled. This is the default value. +- $true: The connector is enabled. This value is the default. - $false: The connector is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -220,10 +237,13 @@ Accept wildcard characters: False ``` ### -IsTransportRuleScoped + +> Applicable: Exchange Online, Exchange Online Protection + The IsTransportRuleScoped parameter specifies whether the Outbound connector is associated with a transport rule (also known as a mail flow rule). Valid values are: - $true: The connector is associated with a transport rule. -- $false: The connector isn't associated with a transport rule. This is the default value. +- $false: The connector isn't associated with a transport rule. This value is the default. You scope a transport rule to an Outbound connector by using the RouteMessageOutboundConnector parameter on the New-TransportRule or Set-TransportRule cmdlets. Messages that match the conditions of the transport rule are routed to their destinations by using the specified Outbound connector. @@ -231,7 +251,6 @@ You scope a transport rule to an Outbound connector by using the RouteMessageOut Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -241,10 +260,13 @@ Accept wildcard characters: False ``` ### -IsValidated -The IsValidated parameter specifies whether the Outbound connector has been validated. Valid values are: -- $true: The connector has been validated, -- $false: The connector hasn't been validated. This is the default value. +> Applicable: Exchange Online, Exchange Online Protection + +The IsValidated parameter specifies whether the Outbound connector is validated. Valid values are: + +- $true: The connector is validated, +- $false: The connector hasn't been validated. This value is the default. Use the Validate-OutboundConnector cmdlet to validate the connector. @@ -252,7 +274,6 @@ Use the Validate-OutboundConnector cmdlet to validate the connector. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -262,6 +283,9 @@ Accept wildcard characters: False ``` ### -LastValidationTimestamp + +> Applicable: Exchange Online, Exchange Online Protection + The LastValidationTimestamp parameter specifies the date/time that the Outbound connector was validated. To specify a date/time value for this parameter, use either of the following options: @@ -275,7 +299,6 @@ Use the Validate-OutboundConnector cmdlet to validate the connector. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -285,13 +308,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name for the connector. 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: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -301,6 +326,9 @@ Accept wildcard characters: False ``` ### -RecipientDomains + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomains parameter specifies the domain that the Outbound connector routes mail to. You can specify multiple domains separated by commas. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. @@ -309,7 +337,6 @@ You can use a wildcard character to specify all subdomains of a specified domain Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -319,10 +346,13 @@ Accept wildcard characters: False ``` ### -RouteAllMessagesViaOnPremises + +> Applicable: Exchange Online, Exchange Online Protection + The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises email system. Valid values are: - $true: Messages are routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. -- $false: Messages aren't routed through the on-premises email system. This is the default value. +- $false: Messages aren't routed through the on-premises email system. This value is the default. This parameter is effective only for OnPremises connectors. @@ -330,7 +360,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -340,10 +369,13 @@ Accept wildcard characters: False ``` ### -SenderRewritingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SenderRewritingEnabled parameter specifies that all messages that normally qualify for SRS rewriting are rewritten for routing through the on-premises email system. Valid values are: - $true: Messages are rewritten by SRS as needed before being routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. -- $false: Messages aren't rewritten by SRS before being routed through the on-premises email system. This is the default value. +- $false: Messages aren't rewritten by SRS before being routed through the on-premises email system. This value is the default. This parameter is effective only for OnPremises connectors. @@ -351,7 +383,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -361,6 +392,9 @@ Accept wildcard characters: False ``` ### -SmartHosts + +> Applicable: Exchange Online, Exchange Online Protection + The SmartHosts parameter specifies the smart host that the Outbound connector uses to route mail. Valid values are: - FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record: For example, mail.contoso.com. @@ -375,7 +409,6 @@ This parameter is required if you use the value $false for the UseMxRecord param Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -385,16 +418,18 @@ Accept wildcard characters: False ``` ### -TestMode + +> Applicable: Exchange Online, Exchange Online Protection + The TestMode parameter specifies whether you want to enabled or disable test mode for the Outbound connector. Valid values are: - $true: Test mode is enabled. -- $false: Test mode is disabled. This is the default value. +- $false: Test mode is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -404,6 +439,9 @@ Accept wildcard characters: False ``` ### -TlsDomain + +> Applicable: Exchange Online, Exchange Online Protection + The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. A valid value for this parameter is an SMTP domain. Wildcards are supported to specify all subdomains of a domain (for example, \*.contoso.com), but you can't embed the wildcard character within the domain (for example, domain.\*.contoso.com). @@ -414,7 +452,6 @@ This parameter meaningful only when the TlsSettings value is DomainValidation. Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -424,18 +461,20 @@ Accept wildcard characters: False ``` ### -TlsSettings + +> Applicable: Exchange Online, Exchange Online Protection + The TlsSettings parameter specifies the TLS authentication level that's used for outbound TLS connections established by this Outbound connector. Valid values are: - EncryptionOnly: TLS is used only to encrypt the communication channel. No certificate authentication is performed. - CertificateValidation: TLS is used to encrypt the channel and certificate chain validation and revocation lists checks are performed. - DomainValidation: In addition to channel encryption and certificate validation, the Outbound connector also verifies that the FQDN of the target certificate matches the domain specified in the TlsDomain parameter. -- $null (blank): This is the default value. +- $null (blank): This value is the default. ```yaml Type: TlsAuthLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -445,16 +484,18 @@ Accept wildcard characters: False ``` ### -UseMXRecord + +> Applicable: Exchange Online, Exchange Online Protection + The UseMXRecord parameter enables or disables DNS routing for the connector. Valid values are: -- $true: The connector uses DNS routing (MX records in DNS) to deliver email. This is the default value. +- $true: The connector uses DNS routing (MX records in DNS) to deliver email. This value is the default. - $false: The connector delivers email to one or more smart hosts. This setting requires one or more smart hosts for the SmartHosts value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -464,13 +505,15 @@ Accept wildcard characters: False ``` ### -ValidationRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The ValidationRecipients parameter specifies the email addresses of the validation recipients for the Outbound connector. You can specify multiple email addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -480,13 +523,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookAnywhere.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-OutlookAnywhere.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OutlookAnywhere.md index bdc199f0c5..a4498d90ac 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookAnywhere.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-outlookanywhere -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-OutlookAnywhere -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-outlookanywhere +schema: 2.0.0 +title: Set-OutlookAnywhere --- # Set-OutlookAnywhere @@ -45,7 +46,7 @@ Set-OutlookAnywhere [-Identity] ## DESCRIPTION For more information about the different authentication methods that you can see in this article, see [Understanding HTTP Authentication](https://learn.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,6 +88,9 @@ In Exchange 2010 and Exchange 2013, this example sets the available authenticati ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Outlook Anywhere virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -99,7 +103,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -ClientAuthenticationMethod + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ClientAuthenticationMethod parameter specifies the authentication method that the Autodiscover service provides to the Outlook Anywhere clients to authenticate to the Client Access server. Valid values are: @@ -116,13 +122,12 @@ The ClientAuthenticationMethod parameter specifies the authentication method tha - Basic - Ntlm -Although you can use this parameter to set only one authentication method, the command won't return an error if you include multiple values. +Although you can use this parameter to set only one authentication method, the command doesn't return an error if you include multiple values. ```yaml Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -132,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -141,7 +149,6 @@ 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 Required: False Position: Named @@ -151,6 +158,9 @@ Accept wildcard characters: False ``` ### -DefaultAuthenticationMethod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DefaultAuthenticationMethod parameter specifies the default authentication method for Outlook Anywhere. This parameter replaces the existing ExternalClientAuthenticationMethod, InternalClientAuthenticationMethod and IISAuthenticationMethods property values with the value you specify. Valid values are: - Basic @@ -163,7 +173,6 @@ You can't use this parameter with the ExternalClientAuthenticationMethod, Intern Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,13 +182,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,19 +200,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,16 +224,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,10 +245,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -242,7 +260,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,11 +269,14 @@ Accept wildcard characters: False ``` ### -ExternalClientAuthenticationMethod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalClientAuthenticationMethod parameter specifies the authentication method that's used to authenticate external Outlook Anywhere clients. Valid values are: - Basic - Ntlm -- Negotiate (This is the default value) +- Negotiate (default value) You can't use this parameter with the DefaultAuthenticationMethods parameter. @@ -264,7 +284,6 @@ You can't use this parameter with the DefaultAuthenticationMethods parameter. Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -274,10 +293,13 @@ Accept wildcard characters: False ``` ### -ExternalClientsRequireSsl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalClientsRequireSsl parameter specifies whether external Outlook Anywhere clients are required to use Secure Sockets Layer (SSL). Valid values are: - $true: Clients connecting via Outlook Anywhere from outside the organization are required to use SSL. -- $false: Clients connecting via Outlook Anywhere from outside the organization aren't required to use SSL. This is the default value. +- $false: Clients connecting via Outlook Anywhere from outside the organization aren't required to use SSL. This value is the default. The value of this parameter is related to the value of the SSLOffloading parameter. @@ -285,7 +307,6 @@ The value of this parameter is related to the value of the SSLOffloading paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -295,13 +316,15 @@ Accept wildcard characters: False ``` ### -ExternalHostname + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalHostname parameter specifies the external hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com. ```yaml Type: Hostname Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -311,6 +334,9 @@ Accept wildcard characters: False ``` ### -IISAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IISAuthenticationMethods parameter specifies the authentication method that's used on the Outlook Anywhere virtual directory in IIS. Valid values are: - Basic @@ -325,7 +351,6 @@ You can't use this parameter with the DefaultAuthenticationMethods parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -335,10 +360,13 @@ Accept wildcard characters: False ``` ### -InternalClientAuthenticationMethod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalClientAuthenticationMethod parameter specifies the authentication method that's used to authenticate internal Outlook Anywhere clients. Valid values are: - Basic -- Ntlm (This is the default value) +- Ntlm (default value) - Negotiate You can't use this parameter with the DefaultAuthenticationMethods parameter. @@ -347,7 +375,6 @@ You can't use this parameter with the DefaultAuthenticationMethods parameter. Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,10 +384,13 @@ Accept wildcard characters: False ``` ### -InternalClientsRequireSsl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalClientsRequireSsl parameter specifies whether internal Outlook Anywhere clients are required to use SSL. Valid values are: - $true: Clients connecting via Outlook Anywhere from inside the organization are required to use SSL. -- $false: Clients connecting via Outlook Anywhere from inside the organization aren't required to use SSL. This is the default value. +- $false: Clients connecting via Outlook Anywhere from inside the organization aren't required to use SSL. This value is the default. The value of this parameter is related to the value of the SSLOffloading parameter. @@ -368,7 +398,6 @@ The value of this parameter is related to the value of the SSLOffloading paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -378,13 +407,15 @@ Accept wildcard characters: False ``` ### -InternalHostname + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalHostname parameter specifies the internal hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -394,13 +425,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of the Outlook Anywhere virtual directory. The default value is Rpc (Default Web Site). If the value you specify contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -410,12 +443,15 @@ Accept wildcard characters: False ``` ### -SSLOffloading + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SSLOffloading parameter specifies whether a network device accepts SSL connections and decrypts them before proxying the connections to the Outlook Anywhere virtual directory on the Exchange server. Valid values are: -- $true: Outlook Anywhere clients using SSL don't maintain an SSL connection along the entire network path to the Exchange server. A network device in front of the server decrypts the SSL connections and proxies the unencrypted (HTTP) client connections to the Outlook Anywhere virtual directory. The network segment where HTTP is used should be a secured network. This is the default value. +- $true: Outlook Anywhere clients using SSL don't maintain an SSL connection along the entire network path to the Exchange server. A network device in front of the server decrypts the SSL connections and proxies the unencrypted (HTTP) client connections to the Outlook Anywhere virtual directory. The network segment where HTTP is used should be a secured network. This value is the default. - $false: Outlook Anywhere clients using SSL maintain an SSL connection along the entire network path to the Exchange server. Only SSL connections are allowed to the Outlook Anywhere virtual directory. -This parameter configures the Require SSL value on the Outlook Anywhere virtual directory. When you set this parameter to $true, Require SSL is disabled. When you set this parameter to $fase, Require SSL is enabled. However, it may take several minutes before the change is visible in IIS Manager. +This parameter configures the Require SSL value on the Outlook Anywhere virtual directory. When you set this parameter to $true, Require SSL is disabled. When you set this parameter to $fase, Require SSL is enabled. However, it might take several minutes before the change is visible in IIS Manager. You need to use the value $true for this parameter if you don't require SSL connections for internal or external Outlook Anywhere clients. @@ -425,7 +461,6 @@ The value of this parameter is related to the values of the ExternalClientsRequi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -435,13 +470,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookProtectionRule.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OutlookProtectionRule.md index 9e222994d5..69da8ab7fc 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-outlookprotectionrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-OutlookProtectionRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-outlookprotectionrule +schema: 2.0.0 +title: Set-OutlookProtectionRule --- # Set-OutlookProtectionRule @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS **Note**: This cmdlet is no longer supported in the cloud-based service. -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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-OutlookProtectionRule cmdlet to modify an existing Microsoft Outlook protection rule. @@ -43,7 +44,7 @@ Outlook protection rules are used to automatically rights-protect email messages Not specifying any conditions results in an Outlook protection rule being applied to all messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,13 +65,15 @@ This example sets the priority of the Outlook protection rule OPR-DG-Finance to ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApplyRightsProtectionTemplate parameter specifies an RMS template to be applied to messages matching the conditions. ```yaml Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -105,7 +113,6 @@ 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 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -123,7 +133,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to suppress the confirmation prompt that appears when you modify a rule with no conditions (the rule applies to all messages). @@ -141,7 +153,6 @@ Use this switch to suppress the confirmation prompt that appears when you modify Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -FromDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FromDepartment parameter specifies a department name. The rule is applied to messages where the sender's department attribute matches this value. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,13 +180,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a name for the rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -183,6 +198,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Priority parameter specifies a priority for the Outlook protection rule. Rule priority values can range from 0 through n-1, where n is the total number of existing Outlook protection rules. Any existing rules with priority equal to or higher than the priority being set have their priority incremented by 1. @@ -191,7 +209,6 @@ Any existing rules with priority equal to or higher than the priority being set Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -201,6 +218,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SentTo parameter specifies one or more recipients. External recipients can be specified using the SMTP address. Internal recipients can be specified using any of the following values: @@ -216,7 +236,6 @@ Internal recipients can be specified using any of the following values: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -226,6 +245,9 @@ Accept wildcard characters: False ``` ### -SentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SentToScope parameter specifies the scope of messages to which the rule applies. Valid values include: - All: Applies to all messages. @@ -237,7 +259,6 @@ If not specified, the parameter defaults to All. Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,6 +268,9 @@ Accept wildcard characters: False ``` ### -UserCanOverride + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UserCanOverride parameter specifies whether the Outlook user can override the rule behavior, either by using a different RMS template, or by removing rights protection before sending the message. Valid values include: - $true: User can override rule action. @@ -256,7 +280,6 @@ The UserCanOverride parameter specifies whether the Outlook user can override th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -266,13 +289,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OutlookProvider.md b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookProvider.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-OutlookProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OutlookProvider.md index 3d9413c338..166c2ab25e 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-outlookprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-OutlookProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-outlookprovider +schema: 2.0.0 +title: Set-OutlookProvider --- # Set-OutlookProvider @@ -37,7 +38,7 @@ Set-OutlookProvider [-Identity] ## DESCRIPTION The Set-OutlookProvider cmdlet creates the global settings for the Autodiscover service. It sets the AutoDiscoverConfig object under the Global Settings object in Active Directory and sets the attributes specified in the parameters listed in the Parameters section. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,13 +52,15 @@ This example changes the duration that the Autodiscover service settings are val ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the ADIDParameter value of the MAPI protocol for which you want to set global settings. ```yaml Type: OutlookProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -CertPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CertPrincipalName parameter specifies the Secure Sockets Layer (SSL) certificate principal name required for connecting to Exchange from an external location. This parameter is only used for Outlook Anywhere clients. @@ -75,7 +81,6 @@ This parameter is only used for Outlook Anywhere clients. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -94,7 +102,6 @@ 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 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a common name for the Outlook Provider Configuration object. This can be a user-friendly name for identification. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +147,15 @@ Accept wildcard characters: False ``` ### -OutlookProviderFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OutlookProviderFlags parameter specifies how Outlook clients should connect to the Exchange server. The value can be set to ServerExclusiveConnect, ExternalClientsRequireSSL, InternalClientsRequireSSL or to None to clear the flags. The recommended value is None, which is also the default setting. ```yaml Type: OutlookProviderFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,11 +165,14 @@ Accept wildcard characters: False ``` ### -RequiredClientVersions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequiredClientVersions parameter specifies the minimum version of Microsoft Outlook that's allowed to connect to the Exchange server. This information is in the Autodiscover response to the client connection request. This parameter uses the syntax `"MinimumVersion, ExpirationDate"`. MinimumVersion is the version of Outlook in the format xx.x.xxxx.xxxx. For example, to specify Outlook 2010 Service Pack 2 (SP2), use the value 14.0.7012.1000. -ExpirationDate is the UTC date-time when connections by older versions of Outlook will be blocked. The UTC date-time is represented in the ISO 8601 date-time format: yyyy-MM-ddThh:mm:ss.fffZ, where yyyy = year, MM = month, dd = day, T indicates the beginning of the time component, hh = hour, mm = minute, ss = second, fff = fractions of a second and Z signifies Zulu, which is another way to denote UTC. +ExpirationDate is the UTC date-time when connections by older versions of Outlook are 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"`. @@ -164,7 +180,6 @@ An example of a valid value for this parameter is `"14.0.7012.1000, 2020-01-01T1 Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Mailbox server to use for Outlook Anywhere clients. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,6 +207,9 @@ Accept wildcard characters: False ``` ### -TTL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TTL parameter specifies the duration (in hours) that the specified settings are valid. If a value is specified, the settings are rediscovered via the Autodiscover service after the duration specified with this parameter. A value of 0 indicates that no rediscovery is required. The default value is 1 hour. @@ -198,7 +218,6 @@ If a value is specified, the settings are rediscovered via the Autodiscover serv Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,13 +227,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-OwaMailboxPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OwaMailboxPolicy.md index 3ba9314494..164572be01 100644 --- a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OwaMailboxPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-owamailboxpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-OwaMailboxPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-owamailboxpolicy +schema: 2.0.0 +title: Set-OwaMailboxPolicy --- # Set-OwaMailboxPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-OwaMailboxPolicy cmdlet to configure existing Outlook on the web mailbox policies. @@ -85,6 +86,7 @@ Set-OwaMailboxPolicy [-Identity] [-LocalEventsEnabled ] [-LogonAndErrorLanguage ] [-MessagePreviewsDisabled ] + [-MonthlyUpdatesEnabled ] [-Name ] [-NotesEnabled ] [-NpsSurveysEnabled ] @@ -161,9 +163,9 @@ Set-OwaMailboxPolicy [-Identity] ## DESCRIPTION In on-premises Exchange, the default Outlook on the web mailbox policy is named Default. In Exchange Online, the default Outlook on the web mailbox policy is named OwaMailboxPolicy-Default. -Changes to Outlook on the web mailbox polices may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (`Stop-Service WAS -Force` and `Start-Service W3SVC`). +Changes to Outlook on the web mailbox policies might take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (`Stop-Service WAS -Force` and `Start-Service W3SVC`). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -198,6 +200,9 @@ This example disables Outlook UserVoice for the default mailbox policy in Micros ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Outlook on the web mailbox policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -208,7 +213,6 @@ The Identity parameter specifies the Outlook on the web mailbox policy that you Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -218,6 +222,9 @@ Accept wildcard characters: False ``` ### -AccountTransferEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -226,7 +233,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -236,9 +242,12 @@ Accept wildcard characters: False ``` ### -ActionForUnknownFileAndMIMETypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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: -- Allow (This is the default value.) +- Allow (This value is the default.) - ForceSave - Block @@ -246,7 +255,6 @@ The ActionForUnknownFileAndMIMETypes parameter specifies how to handle file type Type: AttachmentBlockingActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -256,18 +264,20 @@ Accept wildcard characters: False ``` ### -AdditionalStorageProvidersAvailable + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AdditionalStorageProvidersAvailable parameter specifies whether to allow additional storage providers (for example, Box, Dropbox, Facebook, Google Drive, Egnyte, personal OneDrive) attachments in Outlook on the web. Valid values are: -- $true: Additional storage providers are enabled in Outlook on the web. Users can connect their additional storage providers and share files over email. This is the default value. +- $true: Additional storage providers are enabled in Outlook on the web. Users can connect their additional storage providers and share files over email. This value is the default. - $false: Additional storage providers are disabled in Outlook on the web. Users can't connect their additional storage providers or share files over email. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -277,16 +287,18 @@ Accept wildcard characters: False ``` ### -ActiveSyncIntegrationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActiveSyncIntegrationEnabled parameter specifies whether to enable or disable Exchange ActiveSync settings in Outlook on the web. Valid values are: -- $true: ActiveSync is available in Outlook on the web. This is the default value. +- $true: ActiveSync is available in Outlook on the web. This value is the default. - $false: ActiveSync isn't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -296,9 +308,12 @@ Accept wildcard characters: False ``` ### -AdditionalAccountsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -This parameter has been deprecated and is no longer used. +This parameter is deprecated and no longer used. To enable or disable personal accounts in the new Outlook for Windows, use the PersonalAccountsEnabled parameter. @@ -306,7 +321,6 @@ To enable or disable personal accounts in the new Outlook for Windows, use the P Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -316,16 +330,18 @@ Accept wildcard characters: False ``` ### -AllAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllAddressListsEnabled parameter specifies which address lists are available in Outlook on the web. Valid values are: -- $true: All address lists are visible in Outlook on the web. This is the default value. +- $true: All address lists are visible in Outlook on the web. This value is the default. - $false: Only the global address list is visible in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -335,16 +351,18 @@ Accept wildcard characters: False ``` ### -AllowCopyContactsToDeviceAddressBook + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowCopyContactsToDeviceAddressBook parameter specifies whether users can copy the contents of their Contacts folder to a mobile device's native address book when using Outlook on the web for devices. Valid values are: -- $true: Contacts can be copied to the device's address book in Outlook on the web for devices. This is the default value. +- $true: Contacts can be copied to the device's address book in Outlook on the web for devices. This value is the default. - $false: Contacts can't be copied to the device's address book in Outlook on the web for devices. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -354,6 +372,9 @@ Accept wildcard characters: False ``` ### -AllowedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowedFileTypes parameter specifies the attachment file types (file extensions) that can be saved locally or viewed from Outlook on the web. The default values are: .avi, .bmp, .doc, .docm, .docx, .gif, .jpg, .mp3, .one, .pdf, .png, .ppsm, .ppsx, .ppt, .pptm, .pptx, .pub, .rpmsg, .rtf, .tif, .tiff, .txt, .vsd, .wav, .wma, .wmv, .xls, .xlsb, .xlsm, .xlsx, .zip @@ -371,7 +392,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -381,6 +401,9 @@ Accept wildcard characters: False ``` ### -AllowedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowedMimeTypes parameter specifies the MIME extensions of attachments that allow the attachments to be saved locally or viewed from Outlook on the web. The default values are: - image/bmp @@ -401,7 +424,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,6 +433,9 @@ Accept wildcard characters: False ``` ### -AllowedOrganizationAccountDomains + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowedOrganizationAccountDomains parameter specifies domains where users can add work or school email accounts in the new Outlook for Windows. The default value is blank ($null), which allows work or school accounts from any domain. Setting this parameter to an empty list ([]) prevents any work or school accounts from being added. @@ -419,7 +444,6 @@ The AllowedOrganizationAccountDomains parameter specifies domains where users ca Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -429,13 +453,16 @@ Accept wildcard characters: False ``` ### -AllowOfflineOn + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The AllowOfflineOn parameter specifies when Outlook Web App in offline mode is available for supported web browsers. Valid values are: - PrivateComputersOnly: Offline mode is available in private computer sessions. By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true on the Set-OwaVirtualDirectory cmdlet). - NoComputers: Offline mode is disabled. -- AllComputers: Offline mode is available for public and private computer sessions. This is the default value. +- AllComputers: Offline mode is available for public and private computer sessions. This value is the default. When offline mode is available, users can turn offline mode on or off themselves in Outlook Web App. For more information, see [Use offline settings in Outlook on the web](https://support.microsoft.com/office/a34c9d9d-16ac-4020-b730-ffa7c7540ae7). @@ -443,7 +470,6 @@ When offline mode is available, users can turn offline mode on or off themselves Type: AllowOfflineOnEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -453,6 +479,9 @@ Accept wildcard characters: False ``` ### -BizBarEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BizBarEnabled Description }} @@ -461,7 +490,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -471,9 +499,12 @@ Accept wildcard characters: False ``` ### -BlockedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BlockedFileTypes parameter specifies a list of attachment file types (file extensions) that can't be saved locally or viewed from Outlook on the web. The default values are: -.ade, .adp, .apk, .app, .appx, .appcontent-ms, .appref-ms, .asp, .aspx, .asx, .bas, .bat, .cdxml, .cer, .chm, .cmd, .cnt, .com, .cpl, .crt, .csh, .der, .diagcab, .exe, .fxp, .gadget, .grp, .hlp, .hpj, .hta, .htc, .inf, .ins, .isp, .its, .jar, .jnlp, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mcf, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .mht, .mhtml, .msc, .msh, .msh1, .msh1xml, .msh2, .msh2xml, .mshxml, .msi, .msp, .mst, .msu, .ops, .osd, .pcd, .pif, .pl, .plg, .prf, .prg, .printerexport, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .psd1, .psdm1, .pssc, .pst, .py, .pyc, .pyo, .pyw, .pyz, .pyzw, .reg, .scf, .scr, .sct, .settingcontent-ms, .shb, .shs, .theme, .tmp, .udl, .url, .vb, .vbe, .vbp, .vbs, .vsmacros, .vsw, .webpnp, .website, .ws, .wsb, .wsc, .wsf, .wsh, .xbap, .xll, .xnk +.ade, .adp, .apk, .app, .appcontent-ms, .application, .appref-ms, .appx, .asp, .aspx, .asx, .bas, .bat, .bgi, .cab, .cdxml, .cer, .chm, .cmd, .cnt, .com, .cpl, .crt, .csh, .der, .diagcab, .exe, .fxp, .gadget, .grp, .hlp, .hpj, .hta, .htc, .img, .inf, .ins, .iso, .isp, .its, .jar, .jnlp, .js, .jse, .ksh, .library-ms, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mcf, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .mht, .mhtml, .msc, .msh, .msh1, .msh1xml, .msh2, .msh2xml, .mshxml, .msi, .msp, .mst, .msu, .ops, .osd, .pcd, .pif, .pl, .plg, .prf, .prg, .printerexport, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .psd1, .psdm1, .pssc, .pst, .py, .pyc, .pyo, .pyw, .pyz, .pyzw, .reg, .scf, .scr, .sct, .search-ms, .settingcontent-ms, .shb, .shs, .theme, .tmp, .udl, .url, .vb, .vbe, .vbp, .vbs, .vhd, .vhdx, .vsmacros, .vsw, .webpnp, .website, .ws, .wsb, .wsc, .wsf, .wsh, .xbap, .xll, .xnk 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"`. @@ -488,7 +519,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -498,6 +528,9 @@ Accept wildcard characters: False ``` ### -BlockedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The BlockedMimeTypes parameter specifies MIME extensions in attachments that prevent the attachments from being saved locally or viewed from Outlook on the web. The default values are: - application/hta @@ -522,7 +555,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -532,6 +564,9 @@ Accept wildcard characters: False ``` ### -BookingsMailboxCreationEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsMailboxCreationEnabled parameter allows you disable Microsoft Bookings. @@ -540,7 +575,6 @@ The BookingsMailboxCreationEnabled parameter allows you disable Microsoft Bookin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -550,6 +584,9 @@ Accept wildcard characters: False ``` ### -BookingsMailboxDomain + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsMailboxDomain Description }} @@ -558,7 +595,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -568,6 +604,9 @@ Accept wildcard characters: False ``` ### -BoxAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -576,7 +615,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -586,18 +624,20 @@ Accept wildcard characters: False ``` ### -CalendarEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The CalendarEnabled parameter specifies whether to enable or disable the calendar in Outlook Web App. Valid values are: -- $true: The Calendar is available in Outlook Web App. This is the default value. +- $true: The Calendar is available in Outlook Web App. This value is the default. - $false: The Calendar isn't available in Outlook Web App. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -607,18 +647,20 @@ Accept wildcard characters: False ``` ### -ChangePasswordEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The ChangePasswordEnabled parameter specifies whether users can change their passwords from inside Outlook on the web. Valid values are: -- $true: The Change password option is available in Outlook on the web. This is the default value in on-premises Exchange. +- $true: The Change password option is available in Outlook on the web. This value is the default in on-premises Exchange. - $false: The Change password option isn't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -628,11 +670,14 @@ Accept wildcard characters: False ``` ### -ChangeSettingsAccountEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ChangeSettingsAccountEnabled parameter specifies whether users can change the email account where app-wide settings (for example, theme and privacy settings) are associated in the new Outlook for Windows. Valid values are: -- $true: Users can change their settings account in the new Outlook for Windows. This is the default value. +- $true: Users can change their settings account in the new Outlook for Windows. This value is the default. - $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. @@ -641,7 +686,6 @@ The ChangeSettingsAccountEnabled parameter specifies whether users can change th Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -651,16 +695,18 @@ Accept wildcard characters: False ``` ### -ClassicAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ClassicAttachmentsEnabled parameter specifies whether users can attach local files as regular email attachments in Outlook on the web. Valid values are: -- $true: Users can attach local files to email messages in Outlook on the web. This is the default value. +- $true: Users can attach local files to email messages in Outlook on the web. This value is the default. - $false: Users can't attach local files to email messages in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -670,15 +716,18 @@ Accept wildcard characters: False ``` ### -ConditionalAccessPolicy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ConditionalAccessPolicy parameter specifies the Outlook on the Web Policy for limited access. For this feature to work properly, you also need to configure a Conditional Access policy in the Microsoft Entra admin center. -**Note**: When you enable a Conditional Access policy, users will no longer be able to access the light version of Outlook on the web. An error message will direct them to use the default premium experience. +**Note**: When you enable a Conditional Access policy, users can no longer access the light version of Outlook on the web. An error message directs them to use the default premium experience. Valid values are: -- Off: No conditional access policy is applied to Outlook on the web. This is the default value. +- Off: No conditional access policy is applied to Outlook on the web. This value is the default. - 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. @@ -686,7 +735,6 @@ Valid values are: Type: PolicyEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -696,6 +744,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -705,7 +756,6 @@ 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 Required: False Position: Named @@ -715,18 +765,20 @@ Accept wildcard characters: False ``` ### -ContactsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The ContactsEnabled parameter specifies whether to enable or disable Contacts in Outlook Web App. Valid values are: -- $true: Contacts are available in Outlook Web App. This is the default value. +- $true: Contacts are available in Outlook Web App. This value is the default. - $false: Contacts aren't available in Outlook Web App. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -736,13 +788,15 @@ Accept wildcard characters: False ``` ### -DefaultClientLanguage -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +This parameter is deprecated and no longer used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -752,15 +806,17 @@ Accept wildcard characters: False ``` ### -DefaultTheme + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://learn.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). -Note that this parameter is a text string, and the value you specify isn't validated against the list of available themes. +This parameter is a text string, and the value you specify isn't validated against the list of available themes. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -770,18 +826,20 @@ Accept wildcard characters: False ``` ### -DelegateAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The DelegateAccessEnabled parameter specifies whether delegates can use Outlook on the web or Outlook Web App to open folders that they have delegate access to. Valid values are: -- $true: Delegates can open the mailbox in Outlook on the web. This is the default value. +- $true: Delegates can open the mailbox in Outlook on the web. This value is the default. - $false: Delegates can't open the mailbox in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -791,10 +849,13 @@ Accept wildcard characters: False ``` ### -DirectFileAccessOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DirectFileAccessOnPrivateComputersEnabled parameter specifies the left-click options for attachments in Outlook on the web for private computer sessions. Valid values are: -- $true: Open is available for attachments in Outlook on the web for private computer sessions. This is the default value. -- $false: Open isn't available for attachments in Outlook on the web for private computer sessions. Note that Office and .pdf documents can still be previewed in Outlook on the web. +- $true: Open is available for attachments in Outlook on the web for private computer sessions. This value is the default. +- $false: Open isn't available for attachments in Outlook on the web for private computer sessions. Office and .pdf documents can still be previewed in Outlook on the web. By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. @@ -802,7 +863,6 @@ By default in Exchange 2013 or later and Exchange Online, all Outlook on the web Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -812,10 +872,13 @@ Accept wildcard characters: False ``` ### -DirectFileAccessOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DirectFileAccessOnPublicComputersEnabled parameter specifies the left-click options for attachments in Outlook on the web for public computer sessions. Valid values are: -- $true: Open is available for attachments in Outlook on the web for public computer sessions. This is the default value. -- $false: Open isn't available for attachments in Outlook on the web for public computer sessions. Note that Office and .pdf documents can still be previewed in Outlook on the web. +- $true: Open is available for attachments in Outlook on the web for public computer sessions. This value is the default. +- $false: Open isn't available for attachments in Outlook on the web for public computer sessions. Office and .pdf documents can still be previewed in Outlook on the web. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true on the Set-OwaVirtualDirectory cmdlet). @@ -823,7 +886,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -833,6 +895,9 @@ Accept wildcard characters: False ``` ### -DisableFacebook + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. **Note**: Facebook integration is no longer available. For more information, see [Facebook Connect is no longer available](https://support.microsoft.com/office/facebook-connect-is-no-longer-available-f31c8107-7b5a-4e3d-8a22-e506dacb6db6). @@ -848,7 +913,6 @@ The value of this switch is stored in the FacebookEnabled property in the output Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -858,16 +922,18 @@ Accept wildcard characters: False ``` ### -DisplayPhotosEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DisplayPhotosEnabled parameter specifies whether users see sender photos in Outlook on the web. Valid values are: -- $true: Users see sender photos in Outlook on the web. This is the default value. +- $true: Users see sender photos in Outlook on the web. This value is the default. - $false: Users don't see sender photos in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -877,6 +943,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -885,7 +954,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -895,6 +963,9 @@ Accept wildcard characters: False ``` ### -DropboxAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -903,7 +974,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -913,6 +983,9 @@ Accept wildcard characters: False ``` ### -EmptyStateEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill EmptyStateEnabled Description }} @@ -921,7 +994,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -931,18 +1003,20 @@ Accept wildcard characters: False ``` ### -ExplicitLogonEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The ExplicitLogonEnabled parameter specifies whether to allow a user to open someone else's mailbox in Outlook on the web (provided that user has permissions to the mailbox). Valid values are: -- $true: A user with the required permissions is able to open someone else's mailbox in Outlook on the web. This is the default value. +- $true: A user with the required permissions is able to open someone else's mailbox in Outlook on the web. This value is the default. - $false: A user with the required permissions isn't able to open someone else's mailbox in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -952,18 +1026,20 @@ Accept wildcard characters: False ``` ### -ExternalImageProxyEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExternalImageProxyEnabled parameter specifies whether to load all external images through the Outlook external image proxy. Valid values are: -- $true: All external images are loaded through the Outlook external image proxy. This is the default value. +- $true: All external images are loaded through the Outlook external image proxy. This value is the default. - $false: All external images are loaded through the web browser. This is potentially unsafe, as the images could have mixed content or malformed images that ask for user credentials. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -973,15 +1049,17 @@ Accept wildcard characters: False ``` ### -ExternalSPMySiteHostURL + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalSPMySiteHostURL specifies the My Site Host URL for external users (for example, `https://sp01.contoso.com`). -This parameter is part of rich document collaboration that allows links to documents in OneDrive for Business to appear as regular file attachments in messages. +This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -991,11 +1069,14 @@ Accept wildcard characters: False ``` ### -FeedbackEnabled + +> Applicable: Exchange Online + This cmdlet is available only in the cloud-based service. The FeedbackEnabled parameter specifies whether to enable or disable inline feedback surveys in Outlook on the web. Valid values are: -- $true: Inline feedback surveys are enabled. This is the default value. +- $true: Inline feedback surveys are enabled. This value is the default. - $false: Inline feedback surveys are disabled. Surveys allow users to provide feedback on specific features. For example, for the text predictions feature, the inline feedback "Are the above autocomplete suggestions helpful (yes/no)?" is shown. If a user chooses "no" they can provide specific feedback. @@ -1004,7 +1085,6 @@ The FeedbackEnabled parameter specifies whether to enable or disable inline feed Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1014,16 +1094,18 @@ Accept wildcard characters: False ``` ### -ForceSaveAttachmentFilteringEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForceSaveAttachmentFilteringEnabled parameter specifies whether files are filtered before they can be saved from Outlook on the web. Valid values are: - $true: The attachments specified by the ForceSaveFileTypes parameter are filtered before they can be saved from Outlook on the web. -- $false: The attachments aren't filtered before they're saved. This is the default value. +- $false: The attachments aren't filtered before they're saved. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1033,6 +1115,9 @@ Accept wildcard characters: False ``` ### -ForceSaveFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForceSaveFileTypes parameter specifies the attachment file types (file extensions) that can only be saved from Outlook on the web (not opened). The default values are: .ade, .adp, .app, .asp, .aspx, .asx, .bas, .bat, .cer, .chm, .cmd, .com, .cpl, .crt, .csh, .dcr, .dir, .exe, .fxp, .gadget, .hlp, .hta, .htm, .html, .inf, .ins, .isp, .its, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .msc, .msh, .mshxml, .msi, .msp, .mst, .ops, .pcd, .pif, .plg, .prf, .prg, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .pst, .reg, .scf, .scr, .sct, .shb, .shs, .spl, .swf, .tmp, .url, .vb, .vbe, .vbs, .vsmacro, .vss, .vst, .vsw, .ws, .wsc, .wsf, .wsh @@ -1050,7 +1135,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1060,6 +1144,9 @@ Accept wildcard characters: False ``` ### -ForceSaveMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForceSaveMimeTypes parameter specifies the MIME extensions in attachments that only allow the attachments to be saved locally (not opened). The default values are: - Application/futuresplash @@ -1081,7 +1168,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1091,10 +1177,13 @@ Accept wildcard characters: False ``` ### -ForceWacViewingFirstOnPrivateComputers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForceWacViewingFirstOnPrivateComputers parameter specifies whether private computers must first preview an Office file as a web page in Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server) before opening the file in the local application. Valid values are: - $true: Private computers must first preview an Office file as a web page in Office Online Server before opening the file. -- $false: Private computers aren't required to preview an Office file as a web page in Office Online Server before opening the file. This is the default value. +- $false: Private computers aren't required to preview an Office file as a web page in Office Online Server before opening the file. This value is the default. By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. @@ -1102,7 +1191,6 @@ By default in Exchange 2013 or later and Exchange Online, all Outlook on the web Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1112,10 +1200,13 @@ Accept wildcard characters: False ``` ### -ForceWacViewingFirstOnPublicComputers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForceWacViewingFirstOnPublicComputers parameter specifies whether public computers must first preview an Office file as a web page in Office Online Server before opening the file in the local application. Valid values are: - $true: Public computers must first preview an Office file as a web page in Office Online Server before opening the file. -- $false: Public computers aren't required to preview an Office file as a web page in Office Online Server before opening the file. This is the default value. +- $false: Public computers aren't required to preview an Office file as a web page in Office Online Server before opening the file. This value is the default. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true on the Set-OwaVirtualDirectory cmdlet). @@ -1123,7 +1214,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1133,12 +1223,15 @@ Accept wildcard characters: False ``` ### -ForceWebReadyDocumentViewingFirstOnPrivateComputers + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The ForceWebReadyDocumentViewingFirstOnPrivateComputers parameter specifies whether private computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file from Outlook Web App. Valid values are: - $true: Private computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file. -- $false: Private computers aren't required to preview an Office file as a web page in WebReady Document Viewing before opening the file. This is the default value. +- $false: Private computers aren't required to preview an Office file as a web page in WebReady Document Viewing before opening the file. This value is the default. By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. @@ -1146,7 +1239,6 @@ By default in Exchange 2013 or later and Exchange Online, all Outlook on the web Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1156,12 +1248,15 @@ Accept wildcard characters: False ``` ### -ForceWebReadyDocumentViewingFirstOnPublicComputers + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The ForceWebReadyDocumentViewingFirstOnPublicComputers parameter specifies whether Public computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file from Outlook Web App. Valid values are: - $true: Public computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file. -- $false: Public computers aren't required to preview an Office file as a web page in WebReady Document Viewing before opening the file. This is the default value. +- $false: Public computers aren't required to preview an Office file as a web page in WebReady Document Viewing before opening the file. This value is the default. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true on the Set-OwaVirtualDirectory cmdlet). @@ -1169,7 +1264,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1179,6 +1273,9 @@ Accept wildcard characters: False ``` ### -FreCardsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1187,7 +1284,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1197,16 +1293,18 @@ Accept wildcard characters: False ``` ### -GlobalAddressListEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The GlobalAddressListEnabled parameter specifies whether the global address list is available in Outlook on the web. Valid values are: -- $true: The global address list is visible in Outlook on the web. This is the default value. +- $true: The global address list is visible in Outlook on the web. This value is the default. - $false: The global address list isn't visible in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1216,6 +1314,9 @@ Accept wildcard characters: False ``` ### -GoogleDriveAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1224,7 +1325,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1234,18 +1334,20 @@ Accept wildcard characters: False ``` ### -GroupCreationEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The GroupCreationEnabled parameter specifies whether Microsoft 365 Group creation is available in Outlook and Outlook on the web. Valid values are: -- $true: Users can create Microsoft 365 Groups in Outlook and Outlook on the web. This is the default value. +- $true: Users can create Microsoft 365 Groups in Outlook and Outlook on the web. This value is the default. - $false: Users can't create Microsoft 365 Groups in Outlook and Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1255,18 +1357,20 @@ Accept wildcard characters: False ``` ### -HideClassicOutlookToggleOut + +> Applicable: Exchange Online + 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. +- $false: The toggle to switch back to classic Outlook isn't hidden in new Outlook for Windows. This value is the default. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1276,16 +1380,18 @@ Accept wildcard characters: False ``` ### -InstantMessagingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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: -- $true: Instant messaging is available in Outlook on the web. This is the default value. +- $true: Instant messaging is available in Outlook on the web. This value is the default. - $false: Instant messaging isn't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1295,16 +1401,18 @@ Accept wildcard characters: False ``` ### -InstantMessagingType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InstantMessagingType parameter specifies the type of instant messaging provider in Outlook on the web. Valid values are: -- None: This is the default value in on-premises Exchange. -- Ocs: Lync or Skype (formerly known as Office Communication Server). This is the default value in Exchange Online. +- None: This value is the default in on-premises Exchange. +- Ocs: Lync or Skype (formerly known as Office Communication Server). This value is the default in Exchange Online. ```yaml Type: InstantMessagingTypeOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1314,18 +1422,20 @@ Accept wildcard characters: False ``` ### -InterestingCalendarsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The InterestingCalendarsEnabled parameter specifies whether interesting calendars are available in Outlook on the web. Valid values are: -- $true: Interesting calendars are available in Outlook on thew web. This is the default value. +- $true: Interesting calendars are available in Outlook on thew web. This value is the default. - $false: Interesting calendars aren't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1335,15 +1445,17 @@ Accept wildcard characters: False ``` ### -InternalSPMySiteHostURL + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InternalSPMySiteHostURL specifies the My Site Host URL for internal users (for example, `https://sp01.contoso.com`). -This parameter is part of rich document collaboration that allows links to documents in OneDrive for Business to appear as regular file attachments in messages. +This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1353,16 +1465,18 @@ Accept wildcard characters: False ``` ### -IRMEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IRMEnabled parameter specifies whether Information Rights Management (IRM) features are available in Outlook on the web. Valid values are: -- $true: IRM is available in Outlook on the web. This is the default value. +- $true: IRM is available in Outlook on the web. This value is the default. - $false: IRM isn't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1372,17 +1486,19 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault switch specifies whether the Outlook on the web policy is the default policy that's used to configure the Outlook on the web settings for new mailboxes. You don't need to specify a value with this switch. If another policy is currently set as the default, this switch replaces the old default policy with this policy. -**Note**: In Exchange Online - and excluding resource mailboxes - this value will be superseded by the **OwaMailboxPolicy** parameter in each organization's [CASMailboxPlan](https://learn.microsoft.com/powershell/module/exchange/set-casmailboxplan). That value will instead be applied per each mailbox's SKU. +**Note**: In Exchange Online - and excluding resource mailboxes - this value is superseded by the _OwaMailboxPolicy_ parameter on the [Set- CASMailboxPlan](https://learn.microsoft.com/powershell/module/exchangepowershell/set-casmailboxplan) cmdlet. That value is applied instead per each mailbox's license. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1392,12 +1508,15 @@ Accept wildcard characters: False ``` ### -ItemsToOtherAccountsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ItemsToOtherAccountsEnabled parameter specifies whether users can move or copy email messages between accounts. Valid values are: - $true: Users can move and copy messages to and from external accounts. -- $false: Users can't move or copy messages to and from external accounts. This is the default value. +- $false: Users can't move or copy messages to and from external accounts. This value is the default. **Note:** This policy doesn't affect moving or copying messages between Microsoft 365 Groups and shared mailboxes within the organization. @@ -1405,7 +1524,6 @@ The ItemsToOtherAccountsEnabled parameter specifies whether users can move or co Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1415,16 +1533,18 @@ Accept wildcard characters: False ``` ### -JournalEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The JournalEnabled parameter specifies whether the Journal folder is available in Outlook on the web. Valid values are: -- $true: The Journal folder is visible in Outlook on the web. This is the default value. +- $true: The Journal folder is visible in Outlook on the web. This value is the default. - $false: The Journal folder isn't visible in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1434,18 +1554,20 @@ Accept wildcard characters: False ``` ### -JunkEmailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The JunkEmailEnabled parameter specifies whether the Junk Email folder and junk email management are available in Outlook on the web. Valid values are: -- $true: The Junk Email folder and junk email management are available in Outlook on the web. This is the default value. +- $true: The Junk Email folder and junk email management are available in Outlook on the web. This value is the default. - $false: The Junk Email folder and junk email management aren't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1455,6 +1577,9 @@ Accept wildcard characters: False ``` ### -LinkedInEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. LinkedIn integration is no longer supported. @@ -1463,7 +1588,6 @@ LinkedIn integration is no longer supported. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1473,18 +1597,20 @@ Accept wildcard characters: False ``` ### -LocalEventsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The LocalEventsEnabled parameter specifies whether local events calendars are available in Outlook on the web. Valid values are: - $true: Local events are available in Outlook on the web. -- $false: Local events aren't available in Outlook on the web. This is the default value. +- $false: Local events aren't available in Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1494,6 +1620,9 @@ Accept wildcard characters: False ``` ### -LogonAndErrorLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LogonAndErrorLanguage parameter specifies the language that used in Outlook on the web for forms-based authentication and for error messages when a user's current language setting can't be read. A valid value is a supported Microsoft Windows Language Code Identifier (LCID). For example, 1033 is US English. @@ -1504,7 +1633,6 @@ The default value is 0, which means the logon and error language selection is un Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1514,6 +1642,9 @@ Accept wildcard characters: False ``` ### -MessagePreviewsDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MessagePreviewsDisabled Description }} @@ -1522,7 +1653,26 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthlyUpdatesEnabled + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +{{ Fill MonthlyUpdatesEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -1532,13 +1682,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1548,16 +1700,18 @@ Accept wildcard characters: False ``` ### -NotesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NotesEnabled parameter specifies whether the Notes folder is available in Outlook on the web. Valid values are: -- $true: The Notes folder is visible in Outlook on the web. This is the default value. +- $true: The Notes folder is visible in Outlook on the web. This value is the default. - $false: The Notes folder isn't visible in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1567,18 +1721,20 @@ Accept wildcard characters: False ``` ### -NpsSurveysEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The NpsSurveysEnabled parameter specifies whether to enable or disable the Net Promoter Score (NPS) survey in Outlook on the web. The survey allows users to rate Outlook on the web on a scale of 1 to 5, and to provide feedback and suggested improvements in free text. Valid values are: -- $true: The NPS survey is available in Outlook on the web. This is the default value. +- $true: The NPS survey is available in Outlook on the web. This value is the default. - $false: The NPS survey isn't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1588,11 +1744,14 @@ Accept wildcard characters: False ``` ### -OfflineEnabledWeb + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OfflineEnabledWeb parameter specifies whether offline capabilities are available in Outlook on the web, including saving items to the local device (view items without an internet connection). Valid values are: -- $true: Users can manage offline capabilities in Outlook on the web. This is the default value. +- $true: Users can manage offline capabilities in Outlook on the web. This value is the default. - $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. @@ -1601,7 +1760,6 @@ When offline capabilities are available, users can turn offline capabilities on Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1611,11 +1769,14 @@ Accept wildcard characters: False ``` ### -OfflineEnabledWin + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OfflineEnabledWin parameter specifies whether offline capabilities are available in the new Outlook for Windows, including saving items to the local device (view items without an internet connection). Valid values are: -- $true: Users can manage offline capabilities in the new Outlook for Windows. This is the default value. +- $true: Users can manage offline capabilities in the new Outlook for Windows. This value is the default. - $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. @@ -1624,7 +1785,6 @@ When offline capabilities are available, users can turn offline capabilities on Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1634,7 +1794,10 @@ Accept wildcard characters: False ``` ### -OneDriveAttachmentsEnabled -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +This parameter is deprecated and no longer used. To enable or disable personal OneDrive in Outlook on the web, use the AdditionalStorageProvidersAvailable parameter. @@ -1642,7 +1805,6 @@ To enable or disable personal OneDrive in Outlook on the web, use the Additional Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1652,18 +1814,20 @@ Accept wildcard characters: False ``` ### -OneWinNativeOutlookEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OneWinNativeOutlookEnabled parameter controls the availability of the new Outlook for Windows App. Valid values are: -- $true: The New Outlook for Windows App is available. This is the default value. +- $true: The New Outlook for Windows App is available. This value is the default. - $false: The new Outlook for Windows App isn't available. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named Default value: None @@ -1672,16 +1836,18 @@ Accept wildcard characters: False ``` ### -OnSendAddinsEnabled -The OnSendAddinsEnabled parameter specifies whether to enable or disable on send add-ins in Outlook on the web (add-ins that support events when a user clicks Send). Valid values are: + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The OnSendAddinsEnabled parameter specifies whether a mail item can be edited while an on-send add-in is processing it in Outlook on the web or the new Outlook on Windows. Valid values are: - $true: On send add-ins are enabled. -- $false: On send add-ins are disabled. This is the default value. +- $false: On send add-ins are disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1691,13 +1857,15 @@ Accept wildcard characters: False ``` ### -OrganizationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + When the OrganizationEnabled parameter is set to $false, the Automatic Reply option doesn't include external and internal options, the address book doesn't show the organization hierarchy, and the Resources tab in Calendar forms is disabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1707,9 +1875,12 @@ Accept wildcard characters: False ``` ### -OutboundCharset + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OutboundCharset parameter specifies the character set that's used for outgoing messages in Outlook on the web. Valid values are: -- AutoDetect: Examine the first 2 kilobytes (KB) of text in the message to determine the character set that's used in outgoing messages. This is the default value. +- AutoDetect: Examine the first 2 kilobytes (KB) of text in the message to determine the character set that's used in outgoing messages. This value is the default. - AlwaysUTF8: Always use UTF-8 encoded Unicode characters in outgoing messages, regardless of the detected text in the message, or the user's language choice in Outlook on the web. Use this value if replies to UTF-8 encoded messages aren't being encoded in UTF-8. - UserLanguageChoice: Use the user's language choice in Outlook on the web to encode outgoing messages. @@ -1717,7 +1888,6 @@ The OutboundCharset parameter specifies the character set that's used for outgoi Type: OutboundCharsetOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1727,18 +1897,20 @@ Accept wildcard characters: False ``` ### -OutlookBetaToggleEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookBetaToggleEnabled parameter specifies whether to enable or disable the Outlook on the web Preview toggle. The Preview toggle allows users to try the new Outlook on the web experience. Valid values are: -- $true: The Outlook on the web Preview toggle is enabled. Users can easily switch back and forth between both experiences. This is the default value. +- $true: The Outlook on the web Preview toggle is enabled. Users can easily switch back and forth between both experiences. This value is the default. - $false: Outlook on the web Preview is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1748,15 +1920,22 @@ Accept wildcard characters: False ``` ### -OutlookNewslettersAccessLevel + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -{{ Fill OutlookNewslettersAccessLevel Description }} +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 value is the default. Currently, this value is equivalent to NoAccess. ```yaml Type: OutlookNewslettersAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1766,11 +1945,14 @@ Accept wildcard characters: False ``` ### -OutlookDataFile + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The OutlookDataFile paramater specifies what users can do with .pst files in the new Outlook for Windows. Valid values are: +The OutlookDataFile parameter specifies what users can do with .pst files in the new Outlook for Windows. Valid values are: -- Allow: The defaul 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. +- 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. @@ -1781,7 +1963,6 @@ The OutlookDataFile paramater specifies what users can do with .pst files in the Type: OutlookDataFileFeatureState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1791,15 +1972,22 @@ Accept wildcard characters: False ``` ### -OutlookNewslettersReactions + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -{{ Fill OutlookNewslettersReactions Description }} +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 value is the default. ```yaml Type: OutlookNewslettersFeatureState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1809,15 +1997,24 @@ Accept wildcard characters: False ``` ### -OutlookNewslettersShowMore + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -{{ Fill OutlookNewslettersShowMore Description }} +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 value is the default. + +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 @@ -1827,16 +2024,18 @@ Accept wildcard characters: False ``` ### -OWALightEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. +- $true: The light version of Outlook on the web is available. This value is the default. +- $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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1846,18 +2045,20 @@ Accept wildcard characters: False ``` ### -OWAMiniEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAMiniEnabled parameter controls the availability of the mini version of Outlook Web App. Valid values are: -- $true: The mini version of Outlook Web App is available. This is the default value. +- $true: The mini version of Outlook Web App is available. This value is the default. - $false: The mini version of Outlook Web App isn't available. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1867,18 +2068,20 @@ Accept wildcard characters: False ``` ### -PersonalAccountCalendarsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PersonalAccountCalendarsEnabled parameter specifies whether to allow users to connect to their personal Outlook.com or Google Calendar in Outlook on the web. Valid values are: -- $true: Users can connect to their Outlook.com or Google Calendar to see those events in their Outlook on the web calendar. This is the default value. +- $true: Users can connect to their Outlook.com or Google Calendar to see those events in their Outlook on the web calendar. This value is the default. - $false: Users can't connect to their Outlook.com or Google Calendar in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1888,18 +2091,20 @@ Accept wildcard characters: False ``` ### -PersonalAccountsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PersonalAccountsEnabled parameter specifies whether to allow users to add their personal accounts (for example, Outlook.com, Gmail, or Yahoo!) in the new Outlook for Windows. Valid values are: -- $true: Users can add their personal accounts in the new Outlook for Windows. This is the default value. +- $true: Users can add their personal accounts in the new Outlook for Windows. This value is the default. - $false: Users can't add their personal accounts in the new Outlook for Windows. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1909,13 +2114,15 @@ Accept wildcard characters: False ``` ### -PhoneticSupportEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PhoneticSupportEnabled parameter specifies phonetically spelled entries in the address book. This parameter is available for use in Japan. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1925,18 +2132,20 @@ Accept wildcard characters: False ``` ### -PlacesEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PlacesEnabled parameter specifies whether to enable or disable Places in Outlook on the web. Places lets users search, share, and map location details by using Bing. Valid values are: -- $true: Places is enabled. This is the default value. +- $true: Places is enabled. This value is the default. - $false: Places is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1946,16 +2155,18 @@ Accept wildcard characters: False ``` ### -PremiumClientEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PremiumClientEnabled parameter controls the availability of the full version of Outlook Web App. Valid values are: -- $true: The full version of Outlook Web App is available for supported browsers. This is the default value. +- $true: The full version of Outlook Web App is available for supported browsers. This value is the default. - $false: The full version of Outlook Web App isn't available. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1965,18 +2176,20 @@ Accept wildcard characters: False ``` ### -PrintWithoutDownloadEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PrintWithoutDownloadEnabled specifies whether to allow printing of supported files without downloading the attachment in Outlook on the web. Valid values are: -- $true: Supported files can be printed without being downloaded in Outlook on the web. This is the default value. +- $true: Supported files can be printed without being downloaded in Outlook on the web. This value is the default. - $false: Supported files must be downloaded before they can be printed in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1986,6 +2199,9 @@ Accept wildcard characters: False ``` ### -ProjectMocaEnabled + +> Applicable: Exchange Online + **Note**: The feature that's associated with this parameter is currently in Preview, is not available to all organizations, and is subject to change. This parameter is available only in the cloud-based service. @@ -1993,13 +2209,12 @@ This parameter is available only in the cloud-based service. The ProjectMocaEnabled parameter enables or disables access to Project Moca in Outlook on the web. Valid values are: - $true: Access to Project Moca is enabled in Outlook on the web. -- $false: Access to Project Moca is disabled in Outlook on the web. This is the default value. +- $false: Access to Project Moca is disabled in Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2009,18 +2224,20 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in Exchange Server 2010. The PublicFoldersEnabled parameter specifies whether a user can browse or read items in public folders in Outlook Web App. Valid values are: -- $true: Public folders are available in Outlook Web App. This is the default value. +- $true: Public folders are available in Outlook Web App. This value is the default. - $false: Public folders aren't available in Outlook Web App. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2030,18 +2247,20 @@ Accept wildcard characters: False ``` ### -RecoverDeletedItemsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in Exchange Server 2010. The RecoverDeletedItemsEnabled parameter specifies whether a user can use Outlook Web App to view, recover, or delete permanently items that have been deleted from the Deleted Items folder. Valid values are: -- $true: Users can view, recover, or permanently delete items in Outlook Web App. This is the default value. +- $true: Users can view, recover, or permanently delete items in Outlook Web App. This value is the default. - $false: Users can't view, recover, or permanently delete items in Outlook Web App. Items deleted from the Deleted Items folder in Outlook Web App are still retained. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2051,16 +2270,18 @@ Accept wildcard characters: False ``` ### -ReferenceAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReferenceAttachmentsEnabled parameter specifies whether users can attach files from the cloud as linked attachments in Outlook on the web. Valid values are: -- $true: Users can attach files that are stored in the cloud as linked attachments. If the file hasn't been uploaded to the cloud yet, the users can attach and upload the file in the same step. This is the default value. +- $true: Users can attach files that are stored in the cloud as linked attachments. If the file hasn't been uploaded to the cloud yet, the users can attach and upload the file in the same step. This value is the default. - $false: Users can't share files in the cloud as linked attachments. They need to download a local copy of the file before attaching the file to the email message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2070,9 +2291,12 @@ Accept wildcard characters: False ``` ### -RemindersAndNotificationsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemindersAndNotificationsEnabled parameter specifies whether notifications and reminders are enabled in Outlook on the web. Valid values are: -- $true: Notifications and reminders are enabled in Outlook on the web. This is the default value. +- $true: Notifications and reminders are enabled in Outlook on the web. This value is the default. - $false: Notifications and reminders are disabled in Outlook on the web. This parameter doesn't apply to the light version of Outlook Web App. @@ -2081,7 +2305,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2091,11 +2314,14 @@ Accept wildcard characters: False ``` ### -ReportJunkEmailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: In Exchange Online, this parameter does not affect the ability of users to report messages. Whether a user is able to report messages and where is controlled in the Microsoft Defender portal as described in [User reported message settings](https://learn.microsoft.com/defender-office-365/submissions-user-reported-messages-custom-mailbox). The ReportJunkEmailEnabled parameter specifies whether users can report messages as junk or not junk to Microsoft in Outlook on the web. Valid values are: -- $true: This is the default value. Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox and gives users the option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk folder** moves the message to the Junk Email folder and gives users the option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. +- $true: This value is the default. Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox and gives users the option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk folder** moves the message to the Junk Email folder and gives users the option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. - $false: Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox with no option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk** moves the message to the Junk Email folder with no option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. This parameter is meaningful only when the JunkEmailEnabled parameter is set to $true. @@ -2104,7 +2330,6 @@ This parameter is meaningful only when the JunkEmailEnabled parameter is set to Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2114,16 +2339,18 @@ Accept wildcard characters: False ``` ### -RulesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RulesEnabled parameter specifies whether a user can view, create, or modify server-side rules in Outlook on the web. Valid values are: -- $true: Users can view, create, or modify server-side rules in Outlook on the web. This is the default value. +- $true: Users can view, create, or modify server-side rules in Outlook on the web. This value is the default. - $false: Users can't view, create, or modify server-side rules in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2133,16 +2360,18 @@ Accept wildcard characters: False ``` ### -SatisfactionEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SatisfactionEnabled parameter specifies whether to enable or disable the satisfaction survey. Valid values are: -- $true: The satisfaction survey is enabled. This is the default value. +- $true: The satisfaction survey is enabled. This value is the default. - $false: The satisfaction survey is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2152,16 +2381,18 @@ Accept wildcard characters: False ``` ### -SaveAttachmentsToCloudEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SaveAttachmentsToCloudEnabled parameter specifies whether users can save regular email attachments to the cloud. Valid values are: -- $true: Users can save regular email attachments to the cloud. This is the default value. +- $true: Users can save regular email attachments to the cloud. This value is the default. - $false: Users can only save regular email attachments locally. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2171,16 +2402,18 @@ Accept wildcard characters: False ``` ### -SearchFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SearchFoldersEnabled parameter specifies whether Search Folders are available in Outlook on the web. Valid values are: -- $true: Search Folders are visible in Outlook on the Web. This is the default value. +- $true: Search Folders are visible in Outlook on the Web. This value is the default. - $false: Search Folders aren't visible in Outlook on the Web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2190,16 +2423,20 @@ Accept wildcard characters: False ``` ### -SetPhotoEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SetPhotoEnabled parameter specifies whether users can add, change, and remove their sender photo in Outlook on the web. Valid values are: -- $true: Users can manage their photos in Outlook on the web. This is the default value. +- $true: Users can manage their photos in Outlook on the web. This value is the default. - $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) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2209,13 +2446,15 @@ Accept wildcard characters: False ``` ### -SetPhotoURL -The SetPhotoURL parameter controls where users go to select their photo. Note that you can't specify a URL that contains one or more picture files, as there is no mechanism to copy a URL photo to the properties of the users' Exchange Online mailboxes. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The SetPhotoURL parameter controls where users go to select their photo. You can't specify a URL that contains one or more picture files, as there's no mechanism to copy a URL photo to the properties of Exchange Online mailboxes. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2225,6 +2464,9 @@ Accept wildcard characters: False ``` ### -ShowOnlineArchiveEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ShowOnlineArchiveEnabled Description }} @@ -2233,7 +2475,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2243,16 +2484,18 @@ Accept wildcard characters: False ``` ### -SignaturesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SignaturesEnabled parameter specifies whether to enable or disable the use of signatures in Outlook on the web. Valid values are: -- $true: Signatures are available in Outlook on the web. This is the default value. +- $true: Signatures are available in Outlook on the web. This value is the default. - $false: Signatures aren't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2262,18 +2505,20 @@ Accept wildcard characters: False ``` ### -SilverlightEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in Exchange Server 2010. The SilverlightEnabled parameter specifies whether a user can use Microsoft Silverlight features in Outlook Web App. Valid values are: -- $true: Silverlight features are available in Outlook Web App. This is the default value. +- $true: Silverlight features are available in Outlook Web App. This value is the default. - $false: Silverlight features aren't available in Outlook Web App. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2283,18 +2528,20 @@ Accept wildcard characters: False ``` ### -SkipCreateUnifiedGroupCustomSharepointClassification + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The SkipCreateUnifiedGroupCustomSharepointClassification parameter specifies whether to skip a custom SharePoint page during the creation of Microsoft 365 Groups in Outlook on the web. Valid values are: -- $true: The custom SharePoint page is skipped when a user creates a Microsoft 365 Group in Outlook on the web. This is the default value. +- $true: The custom SharePoint page is skipped when a user creates a Microsoft 365 Group in Outlook on the web. This value is the default. - $false: The custom SharePoint page is shown when a user creates a Microsoft 365 Group in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2304,11 +2551,14 @@ Accept wildcard characters: False ``` ### -SMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The SMimeEnabled parameter specifies whether users can download the S/MIME control for Outlook Web App and use it to read and compose signed and encrypted messages. Valid values are: -- $true: Users can read and compose S/MIME signed and encrypted messages in Outlook Web App. This is the default value. +- $true: Users can read and compose S/MIME signed and encrypted messages in Outlook Web App. This value is the default. - $false: Users can't read or compose messages in Outlook Web App that are opaque-signed or encrypted by using S/MIME. Messages that are clear-signed can be read but not composed, and their signatures aren't validated. **Note**: In Exchange 2013 or later, use the Get-SmimeConfig and Set-SmimeConfig cmdlets to configure the S/MIME settings in Outlook on the web. For more information, see [S/MIME for message signing and encryption](https://learn.microsoft.com/Exchange/policy-and-compliance/smime). @@ -2317,7 +2567,6 @@ The SMimeEnabled parameter specifies whether users can download the S/MIME contr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2327,6 +2576,9 @@ Accept wildcard characters: False ``` ### -SMimeSuppressNameChecksEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SMimeSuppressNameChecksEnabled switch specifies whether to suppress name check in S/MIME messages. You don't need to specify a value with this switch. @@ -2335,7 +2587,6 @@ The SMimeSuppressNameChecksEnabled switch specifies whether to suppress name che Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2345,11 +2596,14 @@ Accept wildcard characters: False ``` ### -SpellCheckerEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in Exchange Server 2010. The SpellCheckerEnabled parameter specifies whether to enable or disable the built-in Outlook Web App spell checker in the full version of Outlook Web App. Valid values are: -- $true: Spell checking is available in Outlook Web App. This is the default value. +- $true: Spell checking is available in Outlook Web App. This value is the default. - $false: Spell checking isn't available in Outlook Web App. This parameter doesn't apply to the light version of Outlook Web App. @@ -2358,7 +2612,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2368,11 +2621,14 @@ Accept wildcard characters: False ``` ### -TasksEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The TasksEnabled parameter specifies whether Tasks folder is available in Outlook Web App. Valid values are: -- $true: The Tasks folder is available in Outlook Web App. This is the default value. +- $true: The Tasks folder is available in Outlook Web App. This value is the default. - $false: The Tasks folder isn't available in Outlook Web App. This parameter doesn't apply to the light version of Outlook Web App. @@ -2381,7 +2637,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2391,18 +2646,20 @@ Accept wildcard characters: False ``` ### -TeamSnapCalendarsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The TeamSnapCalendarsEnabled parameter specifies whether to allow users to connect to their personal TeamSnap calendars in Outlook on the web. Valid values are: -- $true: Users can connect to their TeamSnap calendars to see those events in their Outlook on the web calendar. This is the default value. +- $true: Users can connect to their TeamSnap calendars to see those events in their Outlook on the web calendar. This value is the default. - $false: Users can't connect to their TeamSnap calendars in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2412,9 +2669,12 @@ Accept wildcard characters: False ``` ### -TextMessagingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TextMessagingEnabled parameter specifies whether users can send and receive text messages in Outlook on the web. Valid values are: -- $true: Text messaging is available in Outlook on the web. This is the default value. +- $true: Text messaging is available in Outlook on the web. This value is the default. - $false: Text messaging isn't available in Outlook on the web. This parameter doesn't apply to the light version of Outlook on the web. @@ -2423,7 +2683,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2433,16 +2692,18 @@ Accept wildcard characters: False ``` ### -ThemeSelectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ThemeSelectionEnabled parameter specifies whether users can change the theme in Outlook on the web. Valid values are: -- $true: Users can specify the theme in Outlook on the web. This is the default value. +- $true: Users can specify the theme in Outlook on the web. This value is the default. - $false: Users can't specify or change the theme in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2452,6 +2713,9 @@ Accept wildcard characters: False ``` ### -ThirdPartyAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -2460,7 +2724,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2470,12 +2733,15 @@ Accept wildcard characters: False ``` ### -UMIntegrationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UMIntegrationEnabled parameter specifies whether Unified Messaging (UM) integration is enabled in Outlook on the web. Valid values are: -- $true: UM integration is enabled in Outlook on the web. This is the default value. +- $true: UM integration is enabled in Outlook on the web. This value is the default. - $false: UM integration is disabled in Outlook on the web. -This setting applies only if Unified Messaging has been enabled for a user (for example, bu using the Enable-UMMailbox cmdlet). +This setting applies only if Unified Messaging is enabled for a user (for example, bu using the Enable-UMMailbox cmdlet). This parameter doesn't apply to the light version of Outlook on the web. @@ -2483,7 +2749,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2493,15 +2758,17 @@ Accept wildcard characters: False ``` ### -UNCAccessOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -This parameter has been deprecated and is no longer used. +This parameter is deprecated and no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2511,15 +2778,17 @@ Accept wildcard characters: False ``` ### -UNCAccessOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -This parameter has been deprecated and is no longer used. +This parameter is deprecated and no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2529,16 +2798,18 @@ Accept wildcard characters: False ``` ### -UseGB18030 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UseGB18030 parameter specifies whether to use the GB18030 character set instead of GB2312 in Outlook on the web. Valid values are: - $true: GB18030 is used wherever GB2312 would have been used in Outlook on the web. -- $false: GB2312 isn't replaced by GB18030 in Outlook on the web. This is the default value. +- $false: GB2312 isn't replaced by GB18030 in Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2548,16 +2819,18 @@ Accept wildcard characters: False ``` ### -UseISO885915 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UseISO885915 parameter specifies whether to use the character set ISO8859-15 instead of ISO8859-1 in Outlook on the web. Valid values are: - $true: ISO8859-15 is used wherever ISO8859-1 would have been used in Outlook on the web. -- $false: ISO8859-1 isn't replaced by GB18030 in Outlook on the web. This is the default value. +- $false: ISO8859-1 isn't replaced by GB18030 in Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2567,18 +2840,20 @@ Accept wildcard characters: False ``` ### -UserVoiceEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The UserVoiceEnabled parameter specifies whether to enable or disable Outlook UserVoice in Outlook on the web. Outlook UserVoice is a customer feedback area that's available in Microsoft 365. Valid values are: -- $true: Outlook UserVoice is enabled. This is the default value. +- $true: Outlook UserVoice is enabled. This value is the default. - $false: Outlook UserVoice is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2588,16 +2863,18 @@ Accept wildcard characters: False ``` ### -WacEditingEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WacEditingEnabled parameter specifies whether to enable or disable editing documents in Outlook on the web by using Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server). Valid values are: -- $true: Users can edit supported documents in Outlook on the web. This is the default value. +- $true: Users can edit supported documents in Outlook on the web. This value is the default. - $false: Users can't edit supported documents in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2607,16 +2884,18 @@ Accept wildcard characters: False ``` ### -WacExternalServicesEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WacExternalServicesEnabled parameter specifies whether to enable or disable external services when viewing documents in Outlook on the web (for example, machine translation) by using Office Online Server. Valid values are: -- $true: External services are enabled when viewing supported documents in Outlook on the web. This is the default value. +- $true: External services are enabled when viewing supported documents in Outlook on the web. This value is the default. - $false: External services are disabled when viewing supported documents in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2626,16 +2905,18 @@ Accept wildcard characters: False ``` ### -WacOMEXEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WacOMEXEnabled parameter specifies whether to enable or disable apps for Outlook in Outlook on the web in Office Online Server. Valid values are: - $true: apps for Outlook are enabled in Outlook on the web. -- $false: apps for Outlook are disabled in Outlook on the web. This is the default value. +- $false: apps for Outlook are disabled in Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2645,9 +2926,12 @@ Accept wildcard characters: False ``` ### -WacViewingOnPrivateComputersEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WacViewingOnPrivateComputersEnabled parameter specifies whether to enable or disable web viewing of supported Office documents private computer sessions in Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server). By default, all Outlook on the web sessions are considered to be on private computers. Valid values are: -- $true: In private computer sessions, users can view supported Office documents in the web browser. This is the default value. +- $true: In private computer sessions, users can view supported Office documents in the web browser. This value is the default. - $false: In private computer sessions, users can't view supported Office documents in the web browser. Users can still open the file in a supported application or save the file locally. By default in Exchange 2013 or later and Exchange Online, all Outlook on the web sessions are considered to be on private computers. @@ -2656,7 +2940,6 @@ By default in Exchange 2013 or later and Exchange Online, all Outlook on the web Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2666,9 +2949,12 @@ Accept wildcard characters: False ``` ### -WacViewingOnPublicComputersEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WacViewingOnPublicComputersEnabled parameter specifies whether to enable or disable web viewing of supported Office documents in public computer sessions in Office Online Server. Valid values are: -- $true: In public computer sessions, users can view supported Office documents in the web browser. This is the default value. +- $true: In public computer sessions, users can view supported Office documents in the web browser. This value is the default. - $false: In public computer sessions, users can't view supported Office documents in the web browser. Users can still open the file in a supported application or save the file locally. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true on the Set-OwaVirtualDirectory cmdlet). @@ -2677,7 +2963,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2687,18 +2972,20 @@ Accept wildcard characters: False ``` ### -WeatherEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WeatherEnabled parameter specifies whether to enable or disable weather information in the calendar in Outlook on the web. Valid values are: -- $true: Weather is enabled. This is the default value. +- $true: Weather is enabled. This value is the default. - $false: Weather is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2708,17 +2995,19 @@ Accept wildcard characters: False ``` ### -WebPartsFrameOptionsType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WebPartsFrameOptionsType parameter specifies what sources can access web parts in IFRAME or FRAME elements in Outlook on the web. Valid values are: - None: There are no restrictions on displaying Outlook on the web content in a frame. -- SameOrigin: This is the default value and the recommended value. Display Outlook on the web content only in a frame that has the same origin as the content. +- SameOrigin: This value is the default and the recommended value. Display Outlook on the web content only in a frame that has the same origin as the content. - Deny: Blocks display of Outlook on the web content in a frame, regardless of the origin of the site attempting to access it. ```yaml Type: WebPartsFrameOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2728,18 +3017,20 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingForAllSupportedTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingForAllSupportedTypes parameter specifies whether to enable WebReady Document Viewing for all supported file and MIME types. Valid values are: -- $true: All supported attachment types are available for WebReady Document Viewing. This is the default value. +- $true: All supported attachment types are available for WebReady Document Viewing. This value is the default. - $false: Only the attachment types that are specified by the WebReadyFileTypes and WebReadyMimeTypes parameters are available for WebReady Document Viewing (you can remove values from the lists). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2749,11 +3040,14 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingOnPrivateComputersEnabled parameter specifies whether WebReady Document Viewing is available in private computer sessions. Valid values are: -- $true: WebReady Document Viewing is available in private computer sessions. This is the default value. +- $true: WebReady Document Viewing is available in private computer sessions. This value is the default. - $false: WebReady Document Viewing isn't available in private computer sessions. By default in Exchange 2013, all Outlook on the web sessions are considered to be on private computers. @@ -2762,7 +3056,6 @@ By default in Exchange 2013, all Outlook on the web sessions are considered to b Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2772,11 +3065,14 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingOnPublicComputersEnabled parameter specifies whether WebReady Document Viewing is in public computer sessions. Valid values are: -- $true: WebReady Document Viewing is available for public computer sessions. This is the default value. +- $true: WebReady Document Viewing is available for public computer sessions. This value is the default. - $false: WebReady Document Viewing isn't available for public computer sessions. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true on the Set-OwaVirtualDirectory cmdlet). @@ -2785,7 +3081,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2795,6 +3090,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingSupportedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. This is a read-only parameter that can't be modified; use the WebReadyFileTypes parameter instead. @@ -2803,7 +3101,6 @@ This is a read-only parameter that can't be modified; use the WebReadyFileTypes Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2813,6 +3110,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingSupportedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. This is a read-only parameter that can't be modified; use the WebReadyMimeTypes parameter instead. @@ -2821,7 +3121,6 @@ This is a read-only parameter that can't be modified; use the WebReadyMimeTypes Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2831,6 +3130,9 @@ Accept wildcard characters: False ``` ### -WebReadyFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyFileTypes parameter specifies the attachment file types (file extensions) that can be viewed by WebReady Document Viewing in Outlook on the web. The default value is all supported file types: @@ -2858,7 +3160,6 @@ This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parame Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2868,6 +3169,9 @@ Accept wildcard characters: False ``` ### -WebReadyMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyMimeTypes parameter specifies the MIME extensions of attachments that allow the attachments to be viewed by WebReady Document Viewing in Outlook on the web. The default value is all supported MIME types: @@ -2894,7 +3198,6 @@ This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parame Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2904,13 +3207,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2920,13 +3225,14 @@ Accept wildcard characters: False ``` ### -WSSAccessOnPrivateComputersEnabled -This parameter has been deprecated and is no longer used. +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +This parameter is deprecated and no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2936,13 +3242,15 @@ Accept wildcard characters: False ``` ### -WSSAccessOnPublicComputersEnabled -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +This parameter is deprecated and no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2968,10 +3276,10 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[New-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchange/new-owamailboxpolicy) +[New-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-owamailboxpolicy) -[Get-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchange/get-owamailboxpolicy) +[Get-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/get-owamailboxpolicy) -[Set-CASMailbox](https://learn.microsoft.com/powershell/module/exchange/set-casmailbox) +[Set-CASMailbox](https://learn.microsoft.com/powershell/module/exchangepowershell/set-casmailbox) [Outlook on the web mailbox policy procedures in Exchange Online](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-on-the-web/outlook-web-app-mailbox-policy-procedures) diff --git a/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-OwaVirtualDirectory.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OwaVirtualDirectory.md index 1480d1435c..921ca5f56c 100644 --- a/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OwaVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-owavirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-OwaVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-owavirtualdirectory +schema: 2.0.0 +title: Set-OwaVirtualDirectory --- # Set-OwaVirtualDirectory @@ -155,13 +156,13 @@ Before you run the Set-OwaVirtualDirectory cmdlet, consider the following items: - You must have Write access to virtual directory objects in Active Directory. If you don't have the necessary permissions and you try to run the Set-OwaVirtualDirectory cmdlet on the Active Directory virtual directory object, the cmdlet fails. - You must have Write access to virtual directory objects in the metabase for some properties, such as Authentication and GZip. If you don't have the necessary permissions to run the Set-OwaVirtualDirectory cmdlet on a metabase virtual directory object or on a parameter that writes to the metabase, the cmdlet fails. -- Verify that the data source can be read. Depending on the properties that you want to set on an Outlook on the web virtual directory, you may want to run the cmdlet in a test environment on the Outlook on the web virtual directory object in Active Directory, the metabase, or both. +- Verify that the data source can be read. Depending on the properties that you want to set on an Outlook on the web virtual directory, you might want to run the cmdlet in a test environment on the Outlook on the web virtual directory object in Active Directory, the metabase, or both. - You can run the Set-OwaVirtualDirectory cmdlet on any server that has the Exchange Server administration tools installed. - Several parameters for the Set-OwaVirtualDirectory cmdlet can contain more than one value. These are known as multivalued properties. Make sure that you modify multivalued properties correctly. For information, see [Modifying multivalued properties](https://learn.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). - Many of the Outlook on the web virtual directory settings require you to restart IIS (Stop-Service WAS -Force and Start-Service W3SVC) before the change takes effect. For example, when you enable or disable forms-based authentication, or when you enable or disable the Private computer option on the sign-in page. - To switch from forms-based authentication to Basic authentication, you must first disable forms-based authentication, and then as a separate task, enable Basic authentication. You can't disable forms-based authentication and enable Basic authentication in a single task. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -182,6 +183,9 @@ This example sets the ActionForUnknownFileAndMIMETypes parameter to Block on the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the OWA virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -194,7 +198,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -204,9 +207,12 @@ Accept wildcard characters: False ``` ### -ActionForUnknownFileAndMIMETypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: -- Allow (This is the default value.) +- Allow (This value is the default.) - ForceSave - Block @@ -214,7 +220,6 @@ The ActionForUnknownFileAndMIMETypes parameter specifies how to handle file type Type: AttachmentBlockingActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,16 +229,18 @@ Accept wildcard characters: False ``` ### -ActiveSyncIntegrationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveSyncIntegrationEnabled parameter specifies whether to enable or disable Exchange ActiveSync settings in Outlook on the web. Valid values are: -- $true: ActiveSync is available in Outlook on the web. This is the default value. +- $true: ActiveSync is available in Outlook on the web. This value is the default. - $false: ActiveSync isn't available in Outlook on the web ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,16 +250,18 @@ Accept wildcard characters: False ``` ### -AdfsAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AdfsAuthentication parameter enables or disables Active Directory Federation Services (ADFS) authentication on the Outlook on the web virtual directory. Valid values are: - $true: ADFS authentication is enabled. You need to set the AdfsAuthentication parameter on Set-EcpVirtualDirectory to $true before you can use this value. -- $false: ADFS authentication is disabled. This is the default value. You need to set the AdfsAuthentication parameter on Set-EcpVirtualDirectory to $false before you can use this value. +- $false: ADFS authentication is disabled. This value is the default. You need to set the AdfsAuthentication parameter on Set-EcpVirtualDirectory to $false before you can use this value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,16 +271,18 @@ Accept wildcard characters: False ``` ### -AllAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AllAddressListsEnabled parameter specifies which address lists are available in Outlook on the web. Valid values are: -- $true: All address lists are visible in Outlook on the web. This is the default value. +- $true: All address lists are visible in Outlook on the web. This value is the default. - $false: Only the global address list is visible in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,16 +292,18 @@ Accept wildcard characters: False ``` ### -AllowCopyContactsToDeviceAddressBook + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AllowCopyContactsToDeviceAddressBook parameter specifies whether users can copy the contents of their Contacts folder to a mobile device's native address book when using Outlook on the web for devices. Valid values are: -- $true: Contacts can be copied to the device's address book in Outlook on the web for devices. This is the default value. +- $true: Contacts can be copied to the device's address book in Outlook on the web for devices. This value is the default. - $false: Contacts can't be copied to the device's address book in Outlook on the web for devices. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,6 +313,9 @@ Accept wildcard characters: False ``` ### -AllowedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AllowedFileTypes parameter specifies the attachment file types (file extensions) that can be saved locally or viewed from Outlook on the web. The default values are: .avi, .bmp, .doc, .docm, .docx, .gif, .jpg, .mp3, .one, .pdf, .png, .ppsm, .ppsx, .ppt, .pptm, .pptx, .pub, .rpmsg, .rtf, .tif, .tiff, .txt, .vsd, .wav, .wma, .wmv, .xls, .xlsb, .xlsm, .xlsx, .zip @@ -317,7 +333,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -327,6 +342,9 @@ Accept wildcard characters: False ``` ### -AllowedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AllowedMimeTypes parameter specifies the MIME extensions of attachments that allow the attachments to be saved locally or viewed from Outlook on the web. The default values are: - image/bmp @@ -347,7 +365,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,11 +374,14 @@ Accept wildcard characters: False ``` ### -AllowOfflineOn + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AllowOfflineOn parameter specifies when Outlook on the web in offline mode is available for supported web browsers. Valid values are: - PrivateComputersOnly: Offline mode is available in private computer sessions. By default in Exchange 2013 or later, all Outlook on the web sessions are considered to be on private computers. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true). - NoComputers: Offline mode is disabled. -- AllComputers: Offline mode is available for public and private computer sessions. This is the default value. +- AllComputers: Offline mode is available for public and private computer sessions. This value is the default. When offline mode is available, users can turn offline mode on or off themselves in Outlook on the web. For more information, see [Use offline settings in Outlook on the web](https://support.microsoft.com/office/a34c9d9d-16ac-4020-b730-ffa7c7540ae7). @@ -369,7 +389,6 @@ When offline mode is available, users can turn offline mode on or off themselves Type: AllowOfflineOnEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -379,16 +398,18 @@ Accept wildcard characters: False ``` ### -AnonymousFeaturesEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnonymousFeaturesEnabled parameter specifies whether you want to allow Outlook on the web users that are logged on anonymously to access specific features. Valid values are: -- $true: Features are enabled for anonymous users. For example, anonymous users can view and change meeting content. This is the default value. +- $true: Features are enabled for anonymous users. For example, anonymous users can view and change meeting content. This value is the default. - $false: Features are disabled for anonymous users. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -398,9 +419,12 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: -- $true: Basic authentication is enabled. This is the default value. +- $true: Basic authentication is enabled. This value is the default. - $false: Basic authentication is disabled. This parameter can be used with the FormsAuthentication parameter or with the DigestAuthentication and WindowsAuthentication parameters. @@ -409,7 +433,6 @@ This parameter can be used with the FormsAuthentication parameter or with the Di Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -419,6 +442,9 @@ Accept wildcard characters: False ``` ### -BlockedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BlockedFileTypes parameter specifies a list of attachment file types (file extensions) that can't be saved locally or viewed from Outlook on the web. The default values are: .ade, .adp, .app, .appcontent-ms, .asp, .aspx, .asx, .bas, .bat, .cer, .chm, .cmd, .cnt, .com, .cpl, .crt, .csh, .der, .diagcab, .exe, .fxp, .gadget, .grp, .hlp, .hpj, .hta, .htc, .inf, .ins, .isp, .its, .jar, .jnlp, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mcf, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .mht, .mhtml, .msc, .msh, .msh1, .msh1xml, .msh2, .msh2xml, .mshxml, .msi, .msp, .mst, .msu, .ops, .osd, .pcd, .pif, .pl, .plg, .prf, .prg, .printerexport, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .psd1, .psdm1, .pst, .reg, .scf, .scr, .sct, .settingcontent-ms, .shb, .shs, .theme, .tmp, .url, .vb, .vbe, .vbp, .vbs, .vsmacros, .vsw, .webpnp, .website, .ws, .wsc, .wsf, .wsh, .xbap, .xll, .xnk @@ -436,7 +462,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -446,6 +471,9 @@ Accept wildcard characters: False ``` ### -BlockedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BlockedMimeTypes parameter specifies MIME extensions in attachments that prevent the attachments from being saved locally or viewed from Outlook on the web. The default values are: - application/hta @@ -470,7 +498,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -480,13 +507,15 @@ Accept wildcard characters: False ``` ### -BoxAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -496,16 +525,18 @@ Accept wildcard characters: False ``` ### -CalendarEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarEnabled parameter specifies whether to enable or disable the calendar in Outlook on the web. Valid values are: -- $true: The Calendar is available in Outlook on the web. This is the default value. +- $true: The Calendar is available in Outlook on the web. This value is the default. - $false: The Calendar isn't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -515,18 +546,20 @@ Accept wildcard characters: False ``` ### -CalendarPublishingEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CalendarPublishingEnabled parameter specifies whether users can publish their calendar from Outlook Web App. Valid values are: -- $true: Calendar publishing is enabled. This is the default value. +- $true: Calendar publishing is enabled. This value is the default. - $false: Calendar publishing is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -536,16 +569,18 @@ Accept wildcard characters: False ``` ### -ChangePasswordEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ChangePasswordEnabled parameter specifies whether users can change their passwords from inside Outlook on the web. Valid values are: -- $true: The Change password option is available in Outlook on the web. This is the default value in on-premises Exchange. +- $true: The Change password option is available in Outlook on the web. This value is the default in on-premises Exchange. - $false: The Change password option isn't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -555,16 +590,18 @@ Accept wildcard characters: False ``` ### -ClassicAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClassicAttachmentsEnabled parameter specifies whether users can attach local files as regular email attachments in Outlook on the web. Valid values are: -- $true: Users can attach local files to email messages in Outlook on the web. This is the default value. +- $true: Users can attach local files to email messages in Outlook on the web. This value is the default. - $false: Users can't attach local files to email messages in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -574,10 +611,13 @@ Accept wildcard characters: False ``` ### -ClientAuthCleanupLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClientAuthCleanupLevel parameter specifies how much of the cache is cleared when the user logs off from Outlook on the web. Valid values are: - Low -- High (This is the default value) +- High (default value) This parameter doesn't apply to the light version of Outlook on the web. @@ -585,7 +625,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: ClientAuthCleanupLevels Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -595,6 +634,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -604,7 +646,6 @@ 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 Required: False Position: Named @@ -614,16 +655,18 @@ Accept wildcard characters: False ``` ### -ContactsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ContactsEnabled parameter specifies whether to enable or disable Contacts in Outlook on the web. Valid values are: -- $true: Contacts are available in Outlook on the web. This is the default value. +- $true: Contacts are available in Outlook on the web. This value is the default. - $false: Contacts aren't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -633,6 +676,9 @@ Accept wildcard characters: False ``` ### -CrossSiteRedirectType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CrossSiteRedirectType parameter controls how a Client Access server redirects Outlook Web App to the Client Access server infrastructure in another Active Directory site. Valid values are: @@ -646,7 +692,6 @@ The default value is Manual. Type: LegacyRedirectTypeOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -656,13 +701,15 @@ Accept wildcard characters: False ``` ### -DefaultClientLanguage -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -672,13 +719,15 @@ Accept wildcard characters: False ``` ### -DefaultDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DefaultDomain parameter specifies which domain to use when the LogonFormat parameter is set to UserName (for example, contoso.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -688,15 +737,17 @@ Accept wildcard characters: False ``` ### -DefaultTheme + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://learn.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). -Note that this parameter is a text string, and the value you specify isn't validated against the list of available themes. +This parameter is a text string, and the value you specify isn't validated against the list of available themes. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -706,18 +757,20 @@ Accept wildcard characters: False ``` ### -DelegateAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The DelegateAccessEnabled parameter specifies whether delegates can use Outlook Web App to open folders that they have delegate access to. Valid values are: -- $true: Delegates can open the mailbox in Outlook Web App. This is the default value. +- $true: Delegates can open the mailbox in Outlook Web App. This value is the default. - $false: Delegates can't open the mailbox in Outlook Web App. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -727,10 +780,13 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. -- $false: Digest authentication is disabled. This is the default value. +- $false: Digest authentication is disabled. This value is the default. You can use this parameter with the FormsAuthentication parameter. @@ -738,7 +794,6 @@ You can use this parameter with the FormsAuthentication parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -748,10 +803,13 @@ Accept wildcard characters: False ``` ### -DirectFileAccessOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DirectFileAccessOnPrivateComputersEnabled parameter specifies the left-click options for attachments in Outlook on the web for private computer sessions. Valid values are: -- $true: Open is available for attachments in Outlook on the web for private computer sessions. This is the default value. -- $false: Open isn't available for attachments in Outlook on the web for private computer sessions. Note that Office and .pdf documents can still be previewed in Outlook on the web. +- $true: Open is available for attachments in Outlook on the web for private computer sessions. This value is the default. +- $false: Open isn't available for attachments in Outlook on the web for private computer sessions. Office and .pdf documents can still be previewed in Outlook on the web. By default in Exchange 2013 or later, all Outlook on the web sessions are considered to be on private computers. @@ -759,7 +817,6 @@ By default in Exchange 2013 or later, all Outlook on the web sessions are consid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -769,10 +826,13 @@ Accept wildcard characters: False ``` ### -DirectFileAccessOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DirectFileAccessOnPrivateComputersEnabled parameter specifies the left-click options for attachments in Outlook on the web for public computer sessions. Valid values are: -- $true: Open is available for attachments in Outlook on the web for public computer sessions. This is the default value. -- $false: Open isn't available for attachments in Outlook on the web for public computer sessions. Note that Office and .pdf documents can still be previewed in Outlook on the web. +- $true: Open is available for attachments in Outlook on the web for public computer sessions. This value is the default. +- $false: Open isn't available for attachments in Outlook on the web for public computer sessions. Office and .pdf documents can still be previewed in Outlook on the web. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true). @@ -780,7 +840,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -790,16 +849,18 @@ Accept wildcard characters: False ``` ### -DisplayPhotosEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisplayPhotosEnabled parameter specifies whether users see sender photos in Outlook on the web. Valid values are: -- $true: Users see sender photos in Outlook on the web. This is the default value. +- $true: Users see sender photos in Outlook on the web. This value is the default. - $false: Users don't see sender photos in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -809,13 +870,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -825,13 +888,15 @@ Accept wildcard characters: False ``` ### -DropboxAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -841,6 +906,9 @@ Accept wildcard characters: False ``` ### -Exchange2003Url + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The Exchange2003Url parameter specifies the Outlook Web App URL for Exchange Server 2003 mailboxes. The URL must include the Outlook Web App virtual directory name, even if you're using a redirect to simplify the URL specified by the Exchange2003Url parameter. @@ -849,7 +917,6 @@ The Exchange2003Url parameter specifies the Outlook Web App URL for Exchange Ser Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -859,13 +926,15 @@ Accept wildcard characters: False ``` ### -ExchwebProxyDestination -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: ExchwebProxyDestinations Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -875,16 +944,18 @@ Accept wildcard characters: False ``` ### -ExplicitLogonEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExplicitLogonEnabled parameter specifies whether to allow a user to open someone else's mailbox in Outlook on the web (provided that user has permissions to the mailbox). Valid values are: -- $true: A user with the required permissions is able to open someone else's mailbox in Outlook on the web. This is the default value. +- $true: A user with the required permissions is able to open someone else's mailbox in Outlook on the web. This value is the default. - $false: A user with the required permissions isn't able to open someone else's mailbox in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -894,13 +965,16 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. 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"`. @@ -910,7 +984,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -920,9 +993,12 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null (blank): This is the default value. +- $null (blank): This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. 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"`. @@ -933,7 +1009,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -943,10 +1018,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -955,7 +1033,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -965,6 +1042,9 @@ Accept wildcard characters: False ``` ### -ExternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalAuthenticationMethods parameter restricts the authentication methods that can be used to connect to the virtual directory from outside the firewall. Valid values are: - Adfs @@ -994,7 +1074,6 @@ Although you can specify any of these values, whether or not the authentication Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1004,13 +1083,15 @@ Accept wildcard characters: False ``` ### -ExternalDownloadHostName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalDownloadHostName parameter specifies the download location for files in Outlook on the web for external users (for example, in-line image files). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1020,15 +1101,17 @@ Accept wildcard characters: False ``` ### -ExternalSPMySiteHostURL + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalSPMySiteHostURL specifies the My Site Host URL for external users (for example, `https://sp01.contoso.com`). -This parameter is part of rich document collaboration that allows links to documents in OneDrive for Business to appear as regular file attachments in messages. +This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1038,6 +1121,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. @@ -1046,7 +1132,6 @@ This setting is important when Secure Sockets Layer (SSL) is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1056,6 +1141,9 @@ Accept wildcard characters: False ``` ### -FailbackUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FailbackUrl parameter specifies the URL that Outlook on the web uses to connect to the server after failback in a site resilience process and requires a separate DNS entry pointing to the original server's IP address. This parameter value must be different from the ExternalUrl parameter. @@ -1064,7 +1152,6 @@ This parameter value must be different from the ExternalUrl parameter. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1074,9 +1161,12 @@ Accept wildcard characters: False ``` ### -FilterWebBeaconsAndHtmlForms + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FilterWebBeaconsAndHtmlForms parameter specifies how web beacons are handled in Outlook on the web. Valid values are: -- UserFilterChoice (This is the default value) +- UserFilterChoice (default value) - ForceFilter - DisableFilter @@ -1084,7 +1174,6 @@ The FilterWebBeaconsAndHtmlForms parameter specifies how web beacons are handled Type: WebBeaconFilterLevels Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1094,16 +1183,18 @@ Accept wildcard characters: False ``` ### -ForceSaveAttachmentFilteringEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForceSaveAttachmentFilteringEnabled parameter specifies whether files are filtered before they can be saved from Outlook on the web. Valid values are: - $true: The attachments specified by the ForceSaveFileTypes parameter are filtered before they can be saved from Outlook on the web. -- $false: The attachments aren't filtered before they're saved. This is the default value. +- $false: The attachments aren't filtered before they're saved. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1113,6 +1204,9 @@ Accept wildcard characters: False ``` ### -ForceSaveFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForceSaveFileTypes parameter specifies the attachment file types (file extensions) that can only be saved from Outlook on the web (not opened). The default values are: .ade, .adp, .app, .asp, .aspx, .asx, .bas, .bat, .cer, .chm, .cmd, .com, .cpl, .crt, .csh, .dcr, .dir, .exe, .fxp, .gadget, .hlp, .hta, .htm, .html, .inf, .ins, .isp, .its, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .msc, .msh, .mshxml, .msi, .msp, .mst, .ops, .pcd, .pif, .plg, .prf, .prg, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .pst, .reg, .scf, .scr, .sct, .shb, .shs, .spl, .swf, .tmp, .url, .vb, .vbe, .vbs, .vsmacro, .vss, .vst, .vsw, .ws, .wsc, .wsf, .wsh @@ -1130,7 +1224,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1140,6 +1233,9 @@ Accept wildcard characters: False ``` ### -ForceSaveMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForceSaveMimeTypes parameter specifies the MIME extensions in attachments that only allow the attachments to be saved locally (not opened). The default values are: - Application/futuresplash @@ -1161,7 +1257,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1171,10 +1266,13 @@ Accept wildcard characters: False ``` ### -ForceWacViewingFirstOnPrivateComputers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForceWacViewingFirstOnPrivateComputers parameter specifies whether private computers must first preview an Office file as a web page in Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server) before opening the file in the local application. Valid values are: - $true: Private computers must first preview an Office file as a web page in Office Online Server before opening the file. -- $false: Private computers aren't required to preview an Office file as a web page in Office Online Server before opening the file. This is the default value. +- $false: Private computers aren't required to preview an Office file as a web page in Office Online Server before opening the file. This value is the default. By default in Exchange 2013 or later, all Outlook on the web sessions are considered to be on private computers. @@ -1182,7 +1280,6 @@ By default in Exchange 2013 or later, all Outlook on the web sessions are consid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1192,10 +1289,13 @@ Accept wildcard characters: False ``` ### -ForceWacViewingFirstOnPublicComputers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForceWacViewingFirstOnPublicComputers parameter specifies whether public computers must first preview an Office file as a web page in Office Online Server before opening the file in the local application. Valid values are: - $true: Public computers must first preview an Office file as a web page in Office Online Server before opening the file. -- $false: Public computers aren't required to preview an Office file as a web page in Office Online Server before opening the file. This is the default value. +- $false: Public computers aren't required to preview an Office file as a web page in Office Online Server before opening the file. This value is the default. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true). @@ -1203,7 +1303,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1213,12 +1312,15 @@ Accept wildcard characters: False ``` ### -ForceWebReadyDocumentViewingFirstOnPrivateComputers + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The ForceWebReadyDocumentViewingFirstOnPrivateComputers parameter specifies whether private computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file from Outlook Web App. Valid values are: - $true: Private computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file. -- $false: Private computers aren't required to preview an Office file as a web page in WebReady Document Viewing before opening the file. This is the default value. +- $false: Private computers aren't required to preview an Office file as a web page in WebReady Document Viewing before opening the file. This value is the default. By default in Exchange 2013 or later, all Outlook on the web sessions are considered to be on private computers. @@ -1226,7 +1328,6 @@ By default in Exchange 2013 or later, all Outlook on the web sessions are consid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1236,12 +1337,15 @@ Accept wildcard characters: False ``` ### -ForceWebReadyDocumentViewingFirstOnPublicComputers + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The ForceWebReadyDocumentViewingFirstOnPublicComputers parameter specifies whether Public computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file from Outlook Web App. Valid values are: - $true: Public computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file. -- $false: Public computers aren't required to preview an Office file as a web page in WebReady Document Viewing before opening the file. This is the default value. +- $false: Public computers aren't required to preview an Office file as a web page in WebReady Document Viewing before opening the file. This value is the default. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true). @@ -1249,7 +1353,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1259,16 +1362,18 @@ Accept wildcard characters: False ``` ### -FormsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FormsAuthentication parameter enables or disables forms-based authentication on the Outlook on the web virtual directory. Valid values are: -- $true: Forms-based authentication is enabled in Outlook on the web. This is the default value. The BasicAuthentication parameter is also set to $true, and the DigestAuthentication and WindowsAuthentication parameters are set to $false. +- $true: Forms-based authentication is enabled in Outlook on the web. This value is the default. The BasicAuthentication parameter is also set to $true, and the DigestAuthentication and WindowsAuthentication parameters are set to $false. - $false: Forms-based authentication is disabled in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1278,13 +1383,15 @@ Accept wildcard characters: False ``` ### -FreCardsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1294,16 +1401,18 @@ Accept wildcard characters: False ``` ### -GlobalAddressListEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GlobalAddressListEnabled parameter specifies whether the global address list is available in Outlook on the web. Valid values are: -- $true: The global address list is visible in Outlook on the web. This is the default value. +- $true: The global address list is visible in Outlook on the web. This value is the default. - $false: The global address list isn't visible in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1313,13 +1422,15 @@ Accept wildcard characters: False ``` ### -GoogleDriveAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1329,10 +1440,13 @@ Accept wildcard characters: False ``` ### -GzipLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GzipLevel parameter sets Gzip configuration information for the Outlook on the web virtual directory. Valid values are: - Off -- Low (This is the default value) +- Low (default value) - High - Error @@ -1340,7 +1454,6 @@ The GzipLevel parameter sets Gzip configuration information for the Outlook on t Type: GzipLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1350,13 +1463,15 @@ Accept wildcard characters: False ``` ### -InstantMessagingCertificateThumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InstantMessagingCertificateThumbprint parameter specifies the trusted certificate used to communicate between the instant messaging server and the Mailbox server. Use the Get-ExchangeCertificate cmdlet to find the thumbprint of the certificate. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1366,16 +1481,18 @@ Accept wildcard characters: False ``` ### -InstantMessagingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: -- $true: Instant messaging is available in Outlook on the web. This is the default value. +- $true: Instant messaging is available in Outlook on the web. This value is the default. - $false: Instant messaging isn't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1385,13 +1502,15 @@ Accept wildcard characters: False ``` ### -InstantMessagingServerName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InstantMessagingServerName parameter specifies the fully qualified domain name (FQDN) of the instant messaging server or set of servers behind a load balancing device. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1401,16 +1520,18 @@ Accept wildcard characters: False ``` ### -InstantMessagingType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InstantMessagingType parameter specifies the type of instant messaging provider in Outlook on the web. Valid values are: -- None: This is the default value. +- None: This value is the default. - Ocs: Lync or Skype (formerly known as Office Communication Server). ```yaml Type: InstantMessagingTypeOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1420,16 +1541,18 @@ Accept wildcard characters: False ``` ### -IntegratedFeaturesEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IntegratedFeaturesEnabled parameter specifies whether to allow Outlook on the web users who are logged on using Integrated Windows authentication to access specific features. Valid values are: -- $true: Integrated features are enabled. For example, users logged on using Integrated Windows authentication can view and change meeting content. This is the default value. +- $true: Integrated features are enabled. For example, users logged on using Integrated Windows authentication can view and change meeting content. This value is the default. - $false: Integrated features are disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1439,13 +1562,15 @@ Accept wildcard characters: False ``` ### -InternalDownloadHostName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalDownloadHostName parameter specifies the download location for files in Outlook on the web for internal users (for example, in-line image files). The default value is blank ($null). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1455,15 +1580,17 @@ Accept wildcard characters: False ``` ### -InternalSPMySiteHostURL + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalSPMySiteHostURL specifies the My Site Host URL for internal users (for example, `https://sp01.contoso.com`). -This parameter is part of rich document collaboration that allows links to documents in OneDrive for Business to appear as regular file attachments in messages. +This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1473,6 +1600,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is important when SSL is used. @@ -1481,7 +1611,6 @@ This setting is important when SSL is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1491,16 +1620,18 @@ Accept wildcard characters: False ``` ### -IRMEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IRMEnabled parameter specifies whether Information Rights Management (IRM) features are available in Outlook on the web. Valid values are: -- $true: IRM is available in Outlook on the web. This is the default value. +- $true: IRM is available in Outlook on the web. This value is the default. - $false: IRM isn't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1510,16 +1641,18 @@ Accept wildcard characters: False ``` ### -IsPublic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsPublic parameter specifies whether external users use the virtual directory for Outlook on the web in multiple virtual directory environments (you've configured separate virtual directories on the same server for internal vs. external Outlook on the web connections). Valid values are: - $true: External users use the virtual directory for Outlook on the web. -- $false: External users don't use the virtual directory for Outlook on the web. This is the default value. +- $false: External users don't use the virtual directory for Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1529,16 +1662,18 @@ Accept wildcard characters: False ``` ### -JournalEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The JournalEnabled parameter specifies whether the Journal folder is available in Outlook on the web. Valid values are: -- $true: The Journal folder is visible in Outlook on the web. This is the default value. +- $true: The Journal folder is visible in Outlook on the web. This value is the default. - $false: The Journal folder isn't visible in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1548,16 +1683,18 @@ Accept wildcard characters: False ``` ### -JunkEmailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The JunkEmailEnabled parameter specifies whether the Junk Email folder and junk email management are available in Outlook on the web. Valid values are: -- $true: The Junk Email folder and junk email management are available in Outlook on the web. This is the default value. +- $true: The Junk Email folder and junk email management are available in Outlook on the web. This value is the default. - $false: The Junk Email folder and junk email management aren't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1567,18 +1704,20 @@ Accept wildcard characters: False ``` ### -LegacyRedirectType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The LegacyRedirectType parameter specifies the type of redirect that Outlook Web App uses to a legacy Client Access server or Front End server when forms-based authentication isn't used on the Exchange 2010 Outlook Web App virtual directory. Valid values are: -- Silent: A standard redirect is used. This is the default value. +- Silent: A standard redirect is used. This value is the default. - Manual: An intermediate page is displayed to show the legacy URL so that users can change their bookmarks. ```yaml Type: LegacyRedirectTypeOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1588,6 +1727,9 @@ Accept wildcard characters: False ``` ### -LogonAndErrorLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogonAndErrorLanguage parameter specifies the language that used in Outlook on the web for forms-based authentication and for error messages when a user's current language setting can't be read. A valid value is a supported Microsoft Windows Language Code Identifier (LCID). For example, 1033 is US English. @@ -1598,7 +1740,6 @@ The default value is 0, which means the logon and error language selection is un Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1608,9 +1749,12 @@ Accept wildcard characters: False ``` ### -LogonFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogonFormat parameter specifies the type of logon format that's required for forms-based authentication on the Outlook on the web sign-in page. Valid values are: -- FullDomain: Requires the format domain\\username. This is the default value. +- FullDomain: Requires the format domain\\username. This value is the default. - UserName: Requires only the username, but you also need to specify a value for the DefaultDomain parameter. - PrincipalName: Requires the user principal name (UPN) (for example, user@contoso.com). This sign-in method works only for users whose UPN name is the same as their email address. @@ -1618,7 +1762,6 @@ The LogonFormat parameter specifies the type of logon format that's required for Type: LogonFormats Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1628,9 +1771,12 @@ Accept wildcard characters: False ``` ### -LogonPageLightSelectionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogonPageLightSelectionEnabled parameter specifies whether the Outlook on the web sign-in page includes the option to sign in to the light version of Outlook on the web. Valid values are: -- $true: The option to use the light version of Outlook on the web is available on the sign-in page. This is the default value. +- $true: The option to use the light version of Outlook on the web is available on the sign-in page. This value is the default. - $false: The option to use the light version of Outlook on the web is available on the sign-in page. This parameter is meaningful only for browsers that support the full version of Outlook on the web; unsupported browsers are always required to use the light version of Outlook on the web. @@ -1639,7 +1785,6 @@ This parameter is meaningful only for browsers that support the full version of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1649,10 +1794,13 @@ Accept wildcard characters: False ``` ### -LogonPagePublicPrivateSelectionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogonPagePublicPrivateSelectionEnabled parameter specifies whether the Outlook on the web sign-in page includes the public/private computer session option at sign-in. Valid values are: - $true: The public/private computer session selection is available on the Outlook on the web sign-in page. -- $false: The public/private computer session selection isn't available on the Outlook on the web sign-in page. All sessions are considered to be on private computers. This is the default value. +- $false: The public/private computer session selection isn't available on the Outlook on the web sign-in page. All sessions are considered to be on private computers. This value is the default. By default in Exchange 2013 or later, all Outlook on the web sessions are considered to be on private computers. Users can only specify public computer sessions if you've set this parameter value to $true. @@ -1662,7 +1810,6 @@ When you change the value of this parameter, restart IIS (Stop-Service WAS -Forc Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1672,16 +1819,18 @@ Accept wildcard characters: False ``` ### -NotesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NotesEnabled parameter specifies whether the Notes folder is available in Outlook on the web. Valid values are: -- $true: The Notes folder is visible in Outlook on the web. This is the default value. +- $true: The Notes folder is visible in Outlook on the web. This value is the default. - $false: The Notes folder isn't visible in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1691,6 +1840,9 @@ Accept wildcard characters: False ``` ### -NotificationInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The NotificationInterval parameter specifies the polling frequency in seconds that the client polls the server for new item notifications, reminder updates, and session time-out information in Outlook Web App. @@ -1703,7 +1855,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1713,13 +1864,15 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1729,13 +1882,15 @@ Accept wildcard characters: False ``` ### -OneDriveAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1745,13 +1900,15 @@ Accept wildcard characters: False ``` ### -OrganizationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + When the OrganizationEnabled parameter is set to $false, the Automatic Reply option doesn't include external and internal options, the address book doesn't show the organization hierarchy, and the Resources tab in Calendar forms is disabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1761,9 +1918,12 @@ Accept wildcard characters: False ``` ### -OutboundCharset + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OutboundCharset parameter specifies the character set that's used for outgoing messages in Outlook on the web. Valid values are: -- AutoDetect: Examine the first 2 kilobytes (KB) of text in the message to determine the character set that's used in outgoing messages. This is the default value. +- AutoDetect: Examine the first 2 kilobytes (KB) of text in the message to determine the character set that's used in outgoing messages. This value is the default. - AlwaysUTF8: Always use UTF-8 encoded Unicode characters in outgoing messages, regardless of the detected text in the message, or the user's language choice in Outlook on the web. Use this value if replies to UTF-8 encoded messages aren't being encoded in UTF-8. - UserLanguageChoice: Use the user's language choice in Outlook on the web to encode outgoing messages. @@ -1771,7 +1931,6 @@ The OutboundCharset parameter specifies the character set that's used for outgoi Type: OutboundCharsetOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1781,16 +1940,18 @@ Accept wildcard characters: False ``` ### -OWALightEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. +- $true: The light version of Outlook on the web is available. This value is the default. - $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. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1800,18 +1961,20 @@ Accept wildcard characters: False ``` ### -OWAMiniEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAMiniEnabled parameter controls the availability of the mini version of Outlook Web App. Valid values are: -- $true: The mini version of Outlook Web App is available. This is the default value. +- $true: The mini version of Outlook Web App is available. This value is the default. - $false: The mini version of Outlook Web App isn't available. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1821,16 +1984,18 @@ Accept wildcard characters: False ``` ### -PremiumClientEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PremiumClientEnabled parameter controls the availability of the full version of Outlook Web App. Valid values are: -- $true: The full version of Outlook Web App is available for supported browsers. This is the default value. +- $true: The full version of Outlook Web App is available for supported browsers. This value is the default. - $false: The full version of Outlook Web App isn't available. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1840,18 +2005,20 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The PublicFoldersEnabled parameter specifies whether a user can browse or read items in public folders in Outlook Web App. Valid values are: -- $true: Public folders are available in Outlook Web App. This is the default value. +- $true: Public folders are available in Outlook Web App. This value is the default. - $false: Public folders aren't available in Outlook Web App. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1861,18 +2028,20 @@ Accept wildcard characters: False ``` ### -RecoverDeletedItemsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The RecoverDeletedItemsEnabled parameter specifies whether a user can use Outlook Web App to view, recover, or delete permanently items that have been deleted from the Deleted Items folder. Valid values are: -- $true: Users can view, recover, or permanently delete items in Outlook Web App. This is the default value. +- $true: Users can view, recover, or permanently delete items in Outlook Web App. This value is the default. - $false: Users can't view, recover, or permanently delete items in Outlook Web App. Items deleted from the Deleted Items folder in Outlook Web App are still retained. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1882,16 +2051,18 @@ Accept wildcard characters: False ``` ### -RedirectToOptimalOWAServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RedirectToOptimalOWAServer parameter specifies whether to find the optimal server for Outlook on the web. Valid values are: -- $true: Outlook on the web uses service discovery to find the best Mailbox server to use after a user authenticates. This is the default value. +- $true: Outlook on the web uses service discovery to find the best Mailbox server to use after a user authenticates. This value is the default. - $false: Outlook on the web doesn't redirect clients to the optimal Mailbox server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1901,16 +2072,18 @@ Accept wildcard characters: False ``` ### -ReferenceAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReferenceAttachmentsEnabled parameter specifies whether users can attach files from the cloud as linked attachments in Outlook on the web. Valid values are: -- $true: Users can attach files that are stored in the cloud as linked attachments. If the file hasn't been uploaded to the cloud yet, the users can attach and upload the file in the same step. This is the default value. +- $true: Users can attach files that are stored in the cloud as linked attachments. If the file hasn't been uploaded to the cloud yet, the users can attach and upload the file in the same step. This value is the default. - $false: Users can't share files in the cloud as linked attachments. They need to download a local copy of the file before attaching the file to the email message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1920,9 +2093,12 @@ Accept wildcard characters: False ``` ### -RemindersAndNotificationsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemindersAndNotificationsEnabled parameter specifies whether notifications and reminders are enabled in Outlook on the web. Valid values are: -- $true: Notifications and reminders are enabled in Outlook on the web. This is the default value. +- $true: Notifications and reminders are enabled in Outlook on the web. This value is the default. - $false: Notifications and reminders are disabled in Outlook on the web. This parameter doesn't apply to the light version of Outlook Web App. @@ -1931,7 +2107,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1941,15 +2116,17 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsActionForUnknownServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. -This parameter has been deprecated and is no longer used. +This parameter is deprecated and no longer used. ```yaml Type: RemoteDocumentsActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1959,15 +2136,17 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsAllowedServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. -This parameter has been deprecated and is no longer used. +This parameter is deprecated and no longer used. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1977,15 +2156,17 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsBlockedServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. -This parameter has been deprecated and is no longer used. +This parameter is deprecated and no longer used. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1995,15 +2176,17 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsInternalDomainSuffixList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. -This parameter has been deprecated and is no longer used. +This parameter is deprecated and no longer used. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2013,9 +2196,12 @@ Accept wildcard characters: False ``` ### -ReportJunkEmailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReportJunkEmailEnabled parameter specifies whether users can report messages as junk or not junk to Microsoft in Outlook on the web. Valid values are: -- $true: This is the default value. Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox and gives users the option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk folder** moves the message to the Junk Email folder and gives users the option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. +- $true: This value is the default. Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox and gives users the option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk folder** moves the message to the Junk Email folder and gives users the option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. - $false: Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox with no option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk** moves the message to the Junk Email folder with no option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. This parameter is meaningful only when the JunkEmailEnabled parameter is set to $true. @@ -2024,7 +2210,6 @@ This parameter is meaningful only when the JunkEmailEnabled parameter is set to Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2034,16 +2219,18 @@ Accept wildcard characters: False ``` ### -RulesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RulesEnabled parameter specifies whether a user can view, create, or modify server-side rules in Outlook on the web. Valid values are: -- $true: Users can view, create, or modify server-side rules in Outlook on the web. This is the default value. +- $true: Users can view, create, or modify server-side rules in Outlook on the web. This value is the default. - $false: Users can't view, create, or modify server-side rules in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2053,16 +2240,18 @@ Accept wildcard characters: False ``` ### -SaveAttachmentsToCloudEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SaveAttachmentsToCloudEnabled parameter specifies whether users can save regular email attachments to the cloud. Valid values are: -- $true: Users can save regular email attachments to the cloud. This is the default value. +- $true: Users can save regular email attachments to the cloud. This value is the default. - $false: Users can only save regular email attachments locally. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2072,18 +2261,20 @@ Accept wildcard characters: False ``` ### -SearchFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The SearchFoldersEnabled parameter specifies whether Search Folders are available in Outlook on the web. Valid values are: -- $true: Search Folders are visible in Outlook on the Web. This is the default value. +- $true: Search Folders are visible in Outlook on the Web. This value is the default. - $false: Search Folders aren't visible in Outlook on the Web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2093,16 +2284,18 @@ Accept wildcard characters: False ``` ### -SetPhotoEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SetPhotoEnabled parameter specifies whether users can add, change, and remove their sender photo in Outlook on the web. Valid values are: -- $true: Users can manage their photos in Outlook on the web. This is the default value. +- $true: Users can manage their photos in Outlook on the web. This value is the default. - $false: Users can't manage their user photo in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2112,13 +2305,15 @@ Accept wildcard characters: False ``` ### -SetPhotoURL + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SetPhotoURL parameter specifies the location (URL) of user photos. The default value of this parameter is blank ($null). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2128,16 +2323,18 @@ Accept wildcard characters: False ``` ### -SignaturesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SignaturesEnabled parameter specifies whether to enable or disable the use of signatures in Outlook on the web. Valid values are: -- $true: Signatures are available in Outlook on the web. This is the default value. +- $true: Signatures are available in Outlook on the web. This value is the default. - $false: Signatures aren't available in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2147,18 +2344,20 @@ Accept wildcard characters: False ``` ### -SilverlightEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The SilverlightEnabled parameter specifies whether a user can use Microsoft Silverlight features in Outlook Web App. Valid values are: -- $true: Silverlight features are available in Outlook Web App. This is the default value. +- $true: Silverlight features are available in Outlook Web App. This value is the default. - $false: Silverlight features aren't available in Outlook Web App. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2168,11 +2367,14 @@ Accept wildcard characters: False ``` ### -SMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The SMimeEnabled parameter specifies whether users can download the S/MIME control for Outlook Web App and use it to read and compose signed and encrypted messages. Valid values are: -- $true: Users can read and compose S/MIME signed and encrypted messages in Outlook Web App. This is the default value. +- $true: Users can read and compose S/MIME signed and encrypted messages in Outlook Web App. This value is the default. - $false: Users can't read or compose messages in Outlook Web App that are opaque-signed or encrypted by using S/MIME. Messages that are clear-signed can be read but not composed, and their signatures aren't validated. **Note**: In Exchange 2013 or later, use the Get-SmimeConfig and Set-SmimeConfig cmdlets to configure the S/MIME settings in Outlook on the web. For more information, see [S/MIME for message signing and encryption](https://learn.microsoft.com/Exchange/policy-and-compliance/smime). @@ -2181,7 +2383,6 @@ The SMimeEnabled parameter specifies whether users can download the S/MIME contr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2191,11 +2392,14 @@ Accept wildcard characters: False ``` ### -SpellCheckerEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The SpellCheckerEnabled parameter specifies whether to enable or disable the built-in Outlook Web App spell checker in the full version of Outlook Web App. Valid values are: -- $true: Spell checking is available in Outlook Web App. This is the default value. +- $true: Spell checking is available in Outlook Web App. This value is the default. - $false: Spell checking isn't available in Outlook Web App. This parameter doesn't apply to the light version of Outlook Web App. @@ -2204,7 +2408,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2214,9 +2417,12 @@ Accept wildcard characters: False ``` ### -TasksEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TasksEnabled parameter specifies whether Tasks folder is available in Outlook on the web. Valid values are: -- $true: The Tasks folder is available in Outlook on the web. This is the default value. +- $true: The Tasks folder is available in Outlook on the web. This value is the default. - $false: The Tasks folder isn't available in Outlook on the web. This parameter doesn't apply to the light version of Outlook on the web. @@ -2225,7 +2431,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2235,9 +2440,12 @@ Accept wildcard characters: False ``` ### -TextMessagingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TextMessagingEnabled parameter specifies whether users can send and receive text messages in Outlook on the web. Valid values are: -- $true: Text messaging is available in Outlook on the web. This is the default value. +- $true: Text messaging is available in Outlook on the web. This value is the default. - $false: Text messaging isn't available in Outlook on the web. This parameter doesn't apply to the light version of Outlook on the web. @@ -2246,7 +2454,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2256,16 +2463,18 @@ Accept wildcard characters: False ``` ### -ThemeSelectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ThemeSelectionEnabled parameter specifies whether users can change the theme in Outlook on the web. Valid values are: -- $true: Users can specify the theme in Outlook on the web. This is the default value. +- $true: Users can specify the theme in Outlook on the web. This value is the default. - $false: Users can't specify or change the theme in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2275,12 +2484,15 @@ Accept wildcard characters: False ``` ### -UMIntegrationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UMIntegrationEnabled parameter specifies whether Unified Messaging (UM) integration is enabled in Outlook on the web. Valid values are: -- $true: UM integration is enabled in Outlook on the web. This is the default value. +- $true: UM integration is enabled in Outlook on the web. This value is the default. - $false: UM integration is disabled in Outlook on the web. -This setting applies only if Unified Messaging has been enabled for a user (for example, bu using the Enable-UMMailbox cmdlet). +This setting applies only if Unified Messaging is enabled for a user (for example, bu using the Enable-UMMailbox cmdlet). This parameter doesn't apply to the light version of Outlook on the web. @@ -2288,7 +2500,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2298,13 +2509,15 @@ Accept wildcard characters: False ``` ### -UNCAccessOnPrivateComputersEnabled -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2314,13 +2527,15 @@ Accept wildcard characters: False ``` ### -UNCAccessOnPublicComputersEnabled -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2330,16 +2545,18 @@ Accept wildcard characters: False ``` ### -UseGB18030 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseGB18030 parameter specifies whether to use the GB18030 character set instead of GB2312 in Outlook on the web. Valid values are: - $true: GB18030 is used wherever GB2312 would have been used in Outlook on the web. -- $false: GB2312 isn't replaced by GB18030 in Outlook on the web. This is the default value. +- $false: GB2312 isn't replaced by GB18030 in Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2349,16 +2566,18 @@ Accept wildcard characters: False ``` ### -UseISO885915 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseISO885915 parameter specifies whether to use the character set ISO8859-15 instead of ISO8859-1 in Outlook on the web. Valid values are: - $true: ISO8859-15 is used wherever ISO8859-1 would have been used in Outlook on the web. -- $false: ISO8859-1 isn't replaced by GB18030 in Outlook on the web. This is the default value. +- $false: ISO8859-1 isn't replaced by GB18030 in Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2368,6 +2587,9 @@ Accept wildcard characters: False ``` ### -UserContextTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UserContextTimeout parameter specifies the time-out setting in minutes for a user context object. This parameter doesn't limit public and private forms-based authentication time-out settings. The default value is 60. @@ -2376,7 +2598,6 @@ The default value is 60. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2386,13 +2607,15 @@ Accept wildcard characters: False ``` ### -VirtualDirectoryType -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: VirtualDirectoryTypes Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2402,16 +2625,18 @@ Accept wildcard characters: False ``` ### -WacEditingEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WacEditingEnabled parameter specifies whether to enable or disable editing documents in Outlook on the web by using Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server). Valid values are: -- $true: Users can edit supported documents in Outlook on the web. This is the default value. +- $true: Users can edit supported documents in Outlook on the web. This value is the default. - $false: Users can't edit supported documents in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2421,9 +2646,12 @@ Accept wildcard characters: False ``` ### -WacViewingOnPrivateComputersEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WacViewingOnPrivateComputersEnabled parameter specifies whether to enable or disable web viewing of supported Office documents private computer sessions in Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server). By default, all Outlook on the web sessions are considered to be on private computers. Valid values are: -- $true: In private computer sessions, users can view supported Office documents in the web browser. This is the default value. +- $true: In private computer sessions, users can view supported Office documents in the web browser. This value is the default. - $false: In private computer sessions, users can't view supported Office documents in the web browser. Users can still open the file in a supported application or save the file locally. By default in Exchange 2013 or later, all Outlook on the web sessions are considered to be on private computers. @@ -2432,7 +2660,6 @@ By default in Exchange 2013 or later, all Outlook on the web sessions are consid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2442,9 +2669,12 @@ Accept wildcard characters: False ``` ### -WacViewingOnPublicComputersEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WacViewingOnPublicComputersEnabled parameter specifies whether to enable or disable web viewing of supported Office documents in public computer sessions in Office Online Server. Valid values are: -- $true: In public computer sessions, users can view supported Office documents in the web browser. This is the default value. +- $true: In public computer sessions, users can view supported Office documents in the web browser. This value is the default. - $false: In public computer sessions, users can't view supported Office documents in the web browser. Users can still open the file in a supported application or save the file locally. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true). @@ -2453,7 +2683,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2463,17 +2692,19 @@ Accept wildcard characters: False ``` ### -WebPartsFrameOptionsType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WebPartsFrameOptionsType parameter specifies what sources can access web parts in IFRAME or FRAME elements in Outlook on the web. Valid values are: - None: There are no restrictions on displaying Outlook on the web content in a frame. -- SameOrigin: This is the default value and the recommended value. Display Outlook on the web content only in a frame that has the same origin as the content. +- SameOrigin: This value is the default and the recommended value. Display Outlook on the web content only in a frame that has the same origin as the content. - Deny: Blocks display of Outlook on the web content in a frame, regardless of the origin of the site attempting to access it. ```yaml Type: WebPartsFrameOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2483,18 +2714,20 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingForAllSupportedTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingForAllSupportedTypes parameter specifies whether to enable WebReady Document Viewing for all supported file and MIME types. Valid values are: -- $true: All supported attachment types are available for WebReady Document Viewing. This is the default value. +- $true: All supported attachment types are available for WebReady Document Viewing. This value is the default. - $false: Only the attachment types that are specified by the WebReadyFileTypes and WebReadyMimeTypes parameters are available for WebReady Document Viewing (you can remove values from the lists). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2504,11 +2737,14 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingOnPrivateComputersEnabled parameter specifies whether WebReady Document Viewing is available in private computer sessions. Valid values are: -- $true: WebReady Document Viewing is available in private computer sessions. This is the default value. +- $true: WebReady Document Viewing is available in private computer sessions. This value is the default. - $false: WebReady Document Viewing isn't available in private computer sessions. By default in Exchange 2013, all Outlook on the web sessions are considered to be on private computers. @@ -2517,7 +2753,6 @@ By default in Exchange 2013, all Outlook on the web sessions are considered to b Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2527,11 +2762,14 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingOnPublicComputersEnabled parameter specifies whether WebReady Document Viewing is in public computer sessions. Valid values are: -- $true: WebReady Document Viewing is available for public computer sessions. This is the default value. +- $true: WebReady Document Viewing is available for public computer sessions. This value is the default. - $false: WebReady Document Viewing isn't available for public computer sessions. In Exchange 2013, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true). @@ -2540,7 +2778,6 @@ In Exchange 2013, users can only specify public computer sessions if you've enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2550,6 +2787,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingSupportedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. This is a read-only parameter that can't be modified; use the WebReadyFileTypes parameter instead. @@ -2558,7 +2798,6 @@ This is a read-only parameter that can't be modified; use the WebReadyFileTypes Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2568,6 +2807,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingSupportedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. This is a read-only parameter that can't be modified; use the WebReadyMimeTypes parameter instead. @@ -2576,7 +2818,6 @@ This is a read-only parameter that can't be modified; use the WebReadyMimeTypes Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2586,6 +2827,9 @@ Accept wildcard characters: False ``` ### -WebReadyFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyFileTypes parameter specifies the attachment file types (file extensions) that can be viewed by WebReady Document Viewing in Outlook on the web. The default value is all supported file types: @@ -2613,7 +2857,6 @@ This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parame Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2623,6 +2866,9 @@ Accept wildcard characters: False ``` ### -WebReadyMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyMimeTypes parameter specifies the MIME extensions of attachments that allow the attachments to be viewed by WebReady Document Viewing in Outlook on the web. The default value is all supported MIME types: @@ -2649,7 +2895,6 @@ This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parame Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2659,13 +2904,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2675,16 +2922,18 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsAuthentication parameter enables or disables Integrated Windows authentication on the virtual directory. Valid values are: - $true: Integrated Windows authentication is enabled on the Outlook on the web virtual directory. -- $false: Integrated Windows authentication is disabled on the Outlook on the web virtual directory. This is the default value. +- $false: Integrated Windows authentication is disabled on the Outlook on the web virtual directory. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2694,13 +2943,15 @@ Accept wildcard characters: False ``` ### -WSSAccessOnPrivateComputersEnabled -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2710,13 +2961,15 @@ Accept wildcard characters: False ``` ### -WSSAccessOnPublicComputersEnabled -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is deprecated and no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PartnerApplication.md b/exchange/exchange-ps/ExchangePowerShell/Set-PartnerApplication.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-PartnerApplication.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PartnerApplication.md index 157ce52607..85dddd2094 100644 --- a/exchange/exchange-ps/exchange/Set-PartnerApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PartnerApplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-partnerapplication -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-PartnerApplication -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-partnerapplication +schema: 2.0.0 +title: Set-PartnerApplication --- # Set-PartnerApplication @@ -79,7 +80,7 @@ Set-PartnerApplication [-Identity] ## DESCRIPTION You can configure partner applications such as SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://learn.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -93,6 +94,9 @@ This example refreshes the auth metadata for the HRApp partner application. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the partner application you want to modify. You can use any value that uniquely identifies the partner application. For example: - Name @@ -104,7 +108,6 @@ The Identity parameter specifies the partner application you want to modify. You Type: PartnerApplicationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -114,13 +117,15 @@ Accept wildcard characters: False ``` ### -AcceptSecurityIdentifierInformation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AcceptSecurityIdentifierInformation parameter specifies whether Exchange should accept security identifiers (SIDs) from another trusted Active Directory forest for the partner application. By default, new partner applications are configured to not accept SIDs from another forest. If you're in deployment with a trusted forest, set the parameter to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -130,16 +135,18 @@ Accept wildcard characters: False ``` ### -AccountType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AccountType parameter specifies the type of Microsoft account that's required for the partner application. Valid values are: -- OrganizationalAccount: This is the default value +- OrganizationalAccount: This value is the default - ConsumerAccount ```yaml Type: SupportedAccountType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -149,13 +156,15 @@ Accept wildcard characters: False ``` ### -ActAsPermissions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ActAsPermissions parameter specifies the delegate permissions that are allowed for the partner application. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -ApplicationIdentifier + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ApplicationIdentifier parameter specifies a unique application identifier for the partner application that uses an authorization server. ```yaml Type: String Parameter Sets: ACSTrustApplication Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -AppOnlyPermissions + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -189,7 +203,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -199,6 +212,9 @@ Accept wildcard characters: False ``` ### -AuthMetadataUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AuthMetadataUrl parameter specifies the URL that Exchange can retrieve the AuthMetadata document from for a partner application that doesn't use an authorization server. @@ -207,7 +223,6 @@ The AuthMetadataUrl parameter specifies the URL that Exchange can retrieve the A Type: String Parameter Sets: AuthMetadataUrl Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,6 +232,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -226,7 +244,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -244,7 +264,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,13 +273,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter specifies whether the partner application is enabled. By default, new partner applications are enabled. Set the parameter to $false to create the application configuration in a disabled state. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -270,6 +291,9 @@ Accept wildcard characters: False ``` ### -IssuerIdentifier + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -278,7 +302,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -288,13 +311,15 @@ Accept wildcard characters: False ``` ### -LinkedAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LinkedAccount parameter specifies a linked Active Directory user account for the application. Exchange evaluates Role Based Access Control (RBAC) permissions for the linked account when authorizing a token used to perform a task. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -304,13 +329,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a new name for the partner application. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -320,6 +347,9 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Realm parameter specifies a security realm for the partner application. If the token is from a domain that's not an accepted domain, Exchange checks the realm specified in the token. In such a scenario, only tokens with the same realm specified in the partner application can access Exchange resources. @@ -328,7 +358,6 @@ The Realm parameter specifies a security realm for the partner application. If t Type: String Parameter Sets: ACSTrustApplication Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -338,6 +367,9 @@ Accept wildcard characters: False ``` ### -RefreshAuthMetadata + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RefreshAuthMetadata switch refreshes the auth metadata from the authorization server. You don't need to specify a value with this switch. @@ -346,7 +378,6 @@ The RefreshAuthMetadata switch refreshes the auth metadata from the authorizatio Type: SwitchParameter Parameter Sets: RefreshAuthMetadata Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,6 +387,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. @@ -366,7 +400,6 @@ We don't recommend using this switch in a production environment. Type: SwitchParameter Parameter Sets: AuthMetadataUrl Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -376,13 +409,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Set-PendingFederatedDomain.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PendingFederatedDomain.md index a823ef0913..92a82fcef1 100644 --- a/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PendingFederatedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-pendingfederateddomain -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PendingFederatedDomain -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-pendingfederateddomain +schema: 2.0.0 +title: Set-PendingFederatedDomain --- # Set-PendingFederatedDomain @@ -35,7 +36,7 @@ Set-PendingFederatedDomain [[-Identity] ] ## DESCRIPTION This cmdlet allows the Exchange admin center to save domains selected as the FederatedOrganizationIdentifier or federated domains when proof of domain ownership hasn't been completed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example adds the pending domains contoso.com and sales.contoso.com to the e ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -74,7 +80,6 @@ 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 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -PendingAccountNamespace + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PendingAccountNamespace parameter specifies the pending domain that's used as the account namespace for the federation trust. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -PendingDomains + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PendingDomains parameter specifies the pending federated domains that are configured for the federation trust. ```yaml Type: SmtpDomain[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-PerimeterConfig.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-PerimeterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PerimeterConfig.md index d104c470f0..1611b85ea0 100644 --- a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PerimeterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-perimeterconfig applicable: Exchange Online, Exchange Online Protection -title: Set-PerimeterConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-perimeterconfig +schema: 2.0.0 +title: Set-PerimeterConfig --- # Set-PerimeterConfig @@ -43,13 +44,15 @@ This example shows how to add an IP address to cloud-based safelists where the g ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -GatewayIPAddresses + +> Applicable: Exchange Online + Use the GatewayIPAddresses parameter to create or modify a list of gateway server IP addresses to add to IP safelists. IP addresses are specified in IPv4 format, for example, 10.1.1.1. If you list more than one IP address, separate each entry with a comma. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-PhishSimOverridePolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PhishSimOverridePolicy.md index 95798fa9a6..b4bb856629 100644 --- a/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PhishSimOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-phishsimoverridepolicy applicable: Exchange Online -title: Set-PhishSimOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-phishsimoverridepolicy +schema: 2.0.0 +title: Set-PhishSimOverridePolicy --- # Set-PhishSimOverridePolicy @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS 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 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). +Use the Set-PhishSimOverridePolicy cmdlet to modify non-Microsoft phishing simulation override policies that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -32,7 +33,7 @@ Set-PhishSimOverridePolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example disables the phishing simulation override policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the phishing simulation override policy that yo Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -92,7 +100,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -118,16 +127,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -137,6 +148,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + 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. @@ -145,7 +159,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Place.md b/exchange/exchange-ps/ExchangePowerShell/Set-Place.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-Place.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Place.md index aeffd3882a..8cade9febb 100644 --- a/exchange/exchange-ps/exchange/Set-Place.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Place.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-place applicable: Exchange Online -title: Set-Place -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-place +schema: 2.0.0 +title: Set-Place --- # Set-Place @@ -52,7 +53,7 @@ Set-Place [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +74,9 @@ The example adds the specified metadata to the room mailbox named Conference Roo ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the room mailbox that you want to modify. You can use any value that uniquely identifies the room. For example: - Name @@ -86,7 +90,6 @@ The Identity parameter specifies the room mailbox that you want to modify. You c Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -AudioDeviceName + +> Applicable: Exchange Online + The AudioDeviceName parameter specifies the name of the audio device in the room. If the value contains spaces, enclose the value in quotation marks ("). The default value is blank ($null). To indicate that this room has no audio device, use the value $null for this parameter. @@ -104,7 +110,6 @@ The default value is blank ($null). To indicate that this room has no audio devi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -Building + +> Applicable: Exchange Online + The Building parameter specifies the building name or building number that the room is in. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -Capacity + +> Applicable: Exchange Online + The Capacity parameter specifies the capacity of the room. A valid value is an integer. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Exchange Online + The City parameter specifies the room's city. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -162,13 +173,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Exchange Online + The CountryOrRegion parameter specifies the room's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name). A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). @@ -188,7 +204,6 @@ The friendly name is returned in the CountryOrRegion property value by the Get-P Type: CountryInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -DisplayDeviceName + +> Applicable: Exchange Online + The DisplayDeviceName parameter specifies the name of the display device in the room. If the value contains spaces, enclose the value in quotation marks ("). The default value is blank ($null). To indicate that this room has no display device, use the value $null for this parameter. @@ -206,7 +224,6 @@ The default value is blank ($null). To indicate that this room has no display de Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,13 +233,15 @@ Accept wildcard characters: False ``` ### -Floor + +> Applicable: Exchange Online + The Floor parameter specifies the floor number that the room is on. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -232,13 +251,15 @@ Accept wildcard characters: False ``` ### -FloorLabel + +> Applicable: Exchange Online + The FloorLabel parameter specifies a descriptive label for the floor that the room is on. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,6 +269,9 @@ Accept wildcard characters: False ``` ### -GeoCoordinates + +> Applicable: Exchange Online + The GeoCoordinates parameter specifies the room's location in latitude, longitude and (optionally) altitude coordinates. A valid value for this parameter uses one of the following formats: - Latitude and longitude: For example, "47.644125;-122.122411" @@ -259,7 +283,6 @@ The GeoCoordinates parameter specifies the room's location in latitude, longitud Type: GeoCoordinates Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -269,16 +292,18 @@ Accept wildcard characters: False ``` ### -IsWheelChairAccessible + +> Applicable: Exchange Online + The IsWheelChairAccessible parameter specifies whether the room is wheelchair accessible. Valid values are: - $true: The room is wheelchair accessible. -- $false: The room is not wheelchair accessible. This is the default value. +- $false: The room is not wheelchair accessible. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -288,13 +313,15 @@ Accept wildcard characters: False ``` ### -Label + +> Applicable: Exchange Online + The Label parameter specifies a descriptive label for the room (for example, a number or name). If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -304,12 +331,15 @@ Accept wildcard characters: False ``` ### -MTREnabled + +> Applicable: Exchange Online + **Note**: Currently, this parameter is informational only and results in no additional functionality. The MTREnabled parameter identifies the room as configured with a Microsoft Teams room system. You can add Teams room systems as audio sources in Teams meetings that involve the room. Valid values are: - $true: The room is has a Teams room system. You can add the Teams room system to Microsoft Teams meetings when selecting to join a meeting with room audio. -- $false: The room is does not have a Teams room system. Users will join Teams meetings using their PC or mobile device audio instead of using room audio. This is the default value. +- $false: The room is does not have a Teams room system. Users join Teams meetings using their PC or mobile device audio instead of using room audio. This value is the default. For more information about Microsoft Teams Rooms, see [Microsoft Teams Rooms](https://learn.microsoft.com/microsoftteams/rooms/). @@ -317,7 +347,6 @@ For more information about Microsoft Teams Rooms, see [Microsoft Teams Rooms](ht Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -327,6 +356,9 @@ Accept wildcard characters: False ``` ### -ParentId + +> Applicable: Exchange Online + **Note**: This feature is experimental and is available only for organizations using Microsoft Places. The ParentId parameter specifies the ID of a Place in the parent location hierarchy in Microsoft Places. @@ -337,7 +369,6 @@ Organizations that are onboarding Rooms and Workspaces to Microsoft Places need Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -347,6 +378,9 @@ Accept wildcard characters: False ``` ### -ParentType + +> Applicable: Exchange Online + **Note**: This feature is experimental and is available only for organizations using Microsoft Places. The ParentType parameter specifies the parent type of the ParentId in Microsoft Places. Valid values are: @@ -360,7 +394,6 @@ Organizations that are onboarding Rooms and Workspaces to Microsoft Places need Type: Microsoft.Exchange.Management.RecipientTasks.SetPlaceParentType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -370,13 +403,15 @@ Accept wildcard characters: False ``` ### -Phone + +> Applicable: Exchange Online + The Phone parameter specifies the room's telephone number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -386,13 +421,15 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Exchange Online + The PostalCode parameter specifies the room's postal code. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -402,13 +439,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter specifies the room's state or province. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -418,13 +457,15 @@ Accept wildcard characters: False ``` ### -Street + +> Applicable: Exchange Online + The Street parameter specifies the room's physical address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -434,6 +475,9 @@ Accept wildcard characters: False ``` ### -Tags + +> Applicable: Exchange Online + The Tags parameter specifies additional features of the room (for example, details like the type of view or furniture type). You can specify multiple labels separated by commas. If the labels contains spaces, enclose the values in quotation marks: `"Label 1","Label 2",..."Label N"`. @@ -442,7 +486,6 @@ You can specify multiple labels separated by commas. If the labels contains spac Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -452,6 +495,9 @@ Accept wildcard characters: False ``` ### -VideoDeviceName + +> Applicable: Exchange Online + The VideoDeviceName parameter specifies the name of the video device in the room. If the value contains spaces, enclose the value in quotation marks ("). The default value is blank ($null). To indicate that this room has no video device, use the value $null for this parameter. @@ -460,7 +506,6 @@ The default value is blank ($null). To indicate that this room has no video devi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -470,13 +515,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-PolicyConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-PolicyConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-PolicyConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PolicyConfig.md index 6455c497f6..a5938c4bcd 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PolicyConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-policyconfig applicable: Security & Compliance -title: Set-PolicyConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-policyconfig +schema: 2.0.0 +title: Set-PolicyConfig --- # Set-PolicyConfig @@ -70,13 +71,15 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -86,13 +89,15 @@ Accept wildcard characters: False ``` ### -CaseHoldPolicyLimit + +> Applicable: Security & Compliance + {{ Fill CaseHoldPolicyLimit Description }} ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -ClassificationScheme + +> Applicable: Security & Compliance + {{ Fill ClassificationScheme Description }} ```yaml @@ -109,7 +117,6 @@ Type: ClassificationScheme Parameter Sets: (All) Aliases: Accepted values: Default, V0_AggregatedOnly, V1_DetailedResults -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -ComplianceUrl + +> Applicable: Security & Compliance + {{ Fill ComplianceUrl Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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. @@ -144,7 +156,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -DlpAppGroups + +> Applicable: Security & Compliance + {{ Fill DlpAppGroups Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -DlpAppGroupsPsws + +> Applicable: Security & Compliance + {{ Fill DlpAppGroupsPsws Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -DlpExtensionGroups + +> Applicable: Security & Compliance + {{ Fill DlpExtensionGroups Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -202,13 +219,15 @@ Accept wildcard characters: False ``` ### -DlpNetworkShareGroups + +> Applicable: Security & Compliance + {{ Fill DlpNetworkShareGroups Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -218,13 +237,15 @@ Accept wildcard characters: False ``` ### -DlpPrinterGroups + +> Applicable: Security & Compliance + {{ Fill DlpPrinterGroups Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -234,13 +255,15 @@ Accept wildcard characters: False ``` ### -DlpRemovableMediaGroups + +> Applicable: Security & Compliance + {{ Fill DlpRemovableMediaGroups Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -250,6 +273,9 @@ Accept wildcard characters: False ``` ### -DocumentIsUnsupportedSeverity + +> Applicable: Security & Compliance + {{ Fill DocumentIsUnsupportedSeverity Description }} ```yaml @@ -257,7 +283,6 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Required: False Position: Named @@ -267,13 +292,15 @@ Accept wildcard characters: False ``` ### -EnableAdvancedRuleBuilder + +> Applicable: Security & Compliance + {{ Fill EnableAdvancedRuleBuilder Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -283,6 +310,9 @@ Accept wildcard characters: False ``` ### -EnableLabelCoauth + +> Applicable: Security & Compliance + The EnableLabelCoauth parameter enables or disables co-authoring support in Office desktop apps for the entire organization. Valid value are: - $true: Co-authoring support in Office desktop apps is enabled. When documents are labeled and encrypted by sensitivity labels, multiple users can edit these documents at the same time. Labeling information for unencrypted files is no longer saved in custom properties. Don't enable co-authoring if you use any apps, services, scripts, or tools that read or write labeling metadata to the old location. @@ -291,7 +321,7 @@ The EnableLabelCoauth parameter enables or disables co-authoring support in Offi Disabling co-authoring support in Office desktop apps in the organization has the following consequences: - For apps and services that support the new labeling metadata, they now revert to the original metadata format and location when labels are read or saved. -- The new metadata format and location for Office documents that was used while the setting was enabled will not be copied to the original format and location. As a result, this labeling information for unencrypted Word, Excel, and PowerPoint files will be lost. +- The new metadata format and location for Office documents used while the setting was enabled isn't copied to the original format and location. As a result, this labeling information for unencrypted Word, Excel, and PowerPoint files is lost. - Co-authoring and AutoSave no longer work in your organization for labeled and encrypted documents. - Sensitivity labels remain enabled for Office files in OneDrive and SharePoint. @@ -299,7 +329,6 @@ Disabling co-authoring support in Office desktop apps in the organization has th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -309,16 +338,18 @@ Accept wildcard characters: False ``` ### -EnableSpoAipMigration + +> Applicable: Security & Compliance + The EnableSpoAipMigration parameter enables or disables built-in labeling for supported Office files in SharePoint and OneDrive. Valid values are: -- $true: Users can apply your sensitivity labels in Office for the web. Users will see the Sensitivity button on the ribbon so they can apply labels, and see any applied label name on the status bar. +- $true: Users can apply your sensitivity labels in Office for the web. Users see the Sensitivity button on the ribbon so they can apply labels, and see any applied label name on the status bar. - $false: Users can't apply your sensitivity labels in Office for the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -328,6 +359,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpGlobalSettings + +> Applicable: Security & Compliance + The EndpointDlpGlobalSettings parameter specifies the global endpoints. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. The value of `` is one of the supported values. @@ -350,7 +384,6 @@ Example values: Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -360,13 +393,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpGlobalSettingsPsws + +> Applicable: Security & Compliance + {{ Fill EndpointDlpGlobalSettingsPsws Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -376,6 +411,9 @@ Accept wildcard characters: False ``` ### -ExtendTeamsDlpPoliciesToSharePointOneDrive + +> Applicable: Security & Compliance + 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 @@ -385,7 +423,6 @@ The ExtendTeamsDlpPoliciesToSharePointOneDrive parameter enables the Teams DLP P Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -395,6 +432,9 @@ Accept wildcard characters: False ``` ### -InformationBarrierMode + +> Applicable: Security & Compliance + The InformationBarrierMode parameter specifies the mode that controls the total number of segments and how many segments a user can be part of. Valid values are: - SingleSegment: Users in the organization can have 5000 segments but can only be assigned to one segment. @@ -405,7 +445,6 @@ Type: InformationBarrierMode Parameter Sets: (All) Aliases: Accepted values: SingleSegment, MultiSegment -Applicable: Security & Compliance Required: False Position: Named @@ -415,6 +454,9 @@ Accept wildcard characters: False ``` ### -InformationBarrierPeopleSearchRestriction + +> Applicable: Security & Compliance + {{ Fill InformationBarrierPeopleSearchRestriction Description }} ```yaml @@ -422,7 +464,6 @@ Type: InformationBarrierPeopleSearchRestriction Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Security & Compliance Required: False Position: Named @@ -432,13 +473,15 @@ Accept wildcard characters: False ``` ### -IsDlpSimulationOptedIn + +> Applicable: Security & Compliance + {{ Fill IsDlpSimulationOptedIn Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -448,6 +491,9 @@ Accept wildcard characters: False ``` ### -OnPremisesWorkload + +> Applicable: Security & Compliance + {{ Fill OnPremisesWorkload Description }} ```yaml @@ -455,7 +501,6 @@ Type: Workload Parameter Sets: (All) Aliases: Accepted values: None, Exchange, SharePoint, Intune, OneDriveForBusiness, PublicFolder, SharePointOnPremises, ExchangeOnPremises, AuditAlerting, Skype, ModernGroup, DynamicScope, Teams, UnifiedAuditAzure, EndpointDevices, ThirdPartyApps, OnPremisesScanner -Applicable: Security & Compliance Required: False Position: Named @@ -465,6 +510,9 @@ Accept wildcard characters: False ``` ### -ProcessingLimitExceededSeverity + +> Applicable: Security & Compliance + {{ Fill ProcessingLimitExceededSeverity Description }} ```yaml @@ -472,7 +520,6 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Required: False Position: Named @@ -482,13 +529,15 @@ Accept wildcard characters: False ``` ### -PurviewLabelConsent + +> Applicable: Security & Compliance + {{ Fill PurviewLabelConsent Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -498,13 +547,15 @@ Accept wildcard characters: False ``` ### -ReservedForFutureUse + +> Applicable: Security & Compliance + {{ Fill ReservedForFutureUse Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -514,13 +565,15 @@ Accept wildcard characters: False ``` ### -RetentionForwardCrawl + +> Applicable: Security & Compliance + {{ Fill RetentionForwardCrawl Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -530,17 +583,19 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Security & Compliance + The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - Ignore -- RetryThenBlock (This is the default value) +- RetryThenBlock (default value) ```yaml Type: PolicyRuleErrorAction Parameter Sets: (All) Aliases: Accepted values: Ignore, RetryThenBlock -Applicable: Security & Compliance Required: False Position: Named @@ -550,9 +605,12 @@ Accept wildcard characters: False ``` ### -SenderAddressLocation + +> Applicable: Security & Compliance + The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: -- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. +- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This value is the default. - 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. @@ -561,7 +619,6 @@ Type: PolicySenderAddressLocation Parameter Sets: (All) Aliases: Accepted values: Header, Envelope, HeaderOrEnvelope -Applicable: Security & Compliance Required: False Position: Named @@ -571,13 +628,15 @@ Accept wildcard characters: False ``` ### -SiteGroups + +> Applicable: Security & Compliance + {{ Fill SiteGroups Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -587,13 +646,15 @@ Accept wildcard characters: False ``` ### -SiteGroupsPsws + +> Applicable: Security & Compliance + {{ Fill SiteGroupsPsws Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -603,13 +664,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-PolicyTipConfig.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-PolicyTipConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PolicyTipConfig.md index 16cd681d3b..8bf4dd3de8 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PolicyTipConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-policytipconfig -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-PolicyTipConfig -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-policytipconfig +schema: 2.0.0 +title: Set-PolicyTipConfig --- # Set-PolicyTipConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-PolicyTipConfig cmdlet to modify custom Policy Tips in your organization. You can't modify built-in Policy Tips. @@ -30,7 +31,7 @@ Set-PolicyTipConfig [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example replaces the text of all custom Spanish Policy Tips with the value, ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the custom Policy Tip you want to modify. You can use any value that uniquely identifies the custom Policy Tip. For example: - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. @@ -62,7 +66,6 @@ The Identity parameter specifies the custom Policy Tip you want to modify. You c Type: PolicyTipConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -Value + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Value parameter specifies the text that's displayed by the Policy Tip. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PopSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-PopSettings.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-PopSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PopSettings.md index a6e5d017f8..38da595909 100644 --- a/exchange/exchange-ps/exchange/Set-PopSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PopSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-popsettings -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PopSettings -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-popsettings +schema: 2.0.0 +title: Set-PopSettings --- # Set-PopSettings @@ -56,7 +57,7 @@ Set-PopSettings [-AuthenticatedConnectionTimeout ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -95,11 +96,14 @@ Set-PopSettings -X509CertificateName mail.contoso.com This example specifies the certificate that contains mail.contoso.com is used to encrypt POP3 client connections. -**Note**: For single subject certificates or a SAN certificates, you also need to assign the certificate to the Exchange POP service by using the Enable-ExchangeCertificate cmdlet. For wildcard certificates, you don't need to assign the certificate to the Exchange POP service (you'll receive an error if you try). +**Note**: For single subject certificates or a SAN certificates, you also need to assign the certificate to the Exchange POP service by using the Enable-ExchangeCertificate cmdlet. For wildcard certificates, you don't need to assign the certificate to the Exchange POP service (you get an error if you try). ## PARAMETERS ### -AuthenticatedConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AuthenticatedConnectionTimeout parameter specifies the time to wait before closing an idle authenticated connection. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -110,7 +114,6 @@ Valid values are 00:00:30 to 1:00:00. The default value is 00:30:00 (30 minutes) Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +123,15 @@ Accept wildcard characters: False ``` ### -Banner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Banner parameter specifies the text string that's displayed to connecting POP3 clients. The default value is: The Microsoft Exchange POP3 service is ready. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,9 +141,12 @@ Accept wildcard characters: False ``` ### -CalendarItemRetrievalOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CalendarItemRetrievalOption parameter specifies how calendar items are presented to POP3 clients. Valid values are: -- 0 or iCalendar. This is the default value. +- 0 or iCalendar. This value is the default. - 1 or IntranetUrl. - 2 or InternetUrl. - 3 or Custom. @@ -149,7 +157,6 @@ If you specify 3 or Custom, you need to specify a value for the OwaServerUrl par Type: CalendarItemRetrievalOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +166,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -168,7 +178,6 @@ 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 Required: False Position: Named @@ -178,13 +187,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,16 +205,18 @@ Accept wildcard characters: False ``` ### -EnableExactRFC822Size + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnableExactRFC822Size parameter specifies how message sizes are presented to POP3 clients. Valid values are: - $true: Calculate the exact message size. Because this setting can negatively affect performance, you should configure it only if it's required by your POP3 clients. -- $false: Use an estimated message size. This is the default value. +- $false: Use an estimated message size. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -213,16 +226,18 @@ Accept wildcard characters: False ``` ### -EnableGSSAPIAndNTLMAuth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnableGSSAPIAndNTLMAuth parameter specifies whether connections can use Integrated Windows authentication (NTLM) by using the Generic Security Services application programming interface (GSSAPI). This setting applies to connections where Transport Layer Security (TLS) is disabled. Valid values are: -- $true: NTLM for POP3 connections is enabled. This is the default value. +- $true: NTLM for POP3 connections is enabled. This value is the default. - $false: NTLM for POP3 connections is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -232,16 +247,18 @@ Accept wildcard characters: False ``` ### -EnforceCertificateErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnforceCertificateErrors parameter specifies whether to enforce Secure Sockets Layer (SSL) certificate validation failures. Valid values are: - $true: If the certificate isn't valid or doesn't match the target POP3 server's FQDN, the connection attempt fails. -- $false: The server doesn't deny POP3 connections based on certificate errors. This is the default value. +- $false: The server doesn't deny POP3 connections based on certificate errors. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,9 +268,12 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionPolicy parameter specifies how Extended Protection for Authentication is used for POP3 connections. Valid values are: -- None: Extended Protection for Authentication isn't used. This is the default value. +- None: Extended Protection for Authentication isn't used. This value is the default. - Allow: Extended Protection for Authentication is used only if it's supported by the incoming POP3 connection. If it's not, Extended Protection for Authentication isn't used. - Require: Extended Protection for Authentication is required for all POP3 connections. If the incoming POP3 connection doesn't support it, the connection is rejected. @@ -263,7 +283,6 @@ Extended Protection for Authentication enhances the protection and handling of c Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,6 +292,9 @@ Accept wildcard characters: False ``` ### -ExternalConnectionSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by external POP3 clients (POP3 connections from outside your corporate network). This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). @@ -289,7 +311,6 @@ The combination of encryption methods and ports that are specified for this para Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -299,6 +320,9 @@ Accept wildcard characters: False ``` ### -InternalConnectionSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by internal POP3 clients (POP3 connections from inside your corporate network). This setting is also used when a POP3 connection is forwarded to another Exchange server that's running the Microsoft Exchange POP3 service. This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). @@ -315,7 +339,6 @@ The combination of encryption methods and ports that are specified for this para Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,6 +348,9 @@ Accept wildcard characters: False ``` ### -LogFileLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogFileLocation parameter specifies the location for the POP3 protocol log files. The default location is%ExchangeInstallPath%Logging\\Pop3. This parameter is only meaningful when the ProtocolLogEnabled parameter value is $true. @@ -333,7 +359,6 @@ This parameter is only meaningful when the ProtocolLogEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -343,10 +368,13 @@ Accept wildcard characters: False ``` ### -LogFileRollOverSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogFileRollOverSettings parameter defines how frequently POP3 protocol logging creates a new log file. Valid values are: -- 1 or Hourly. This is the default value in Exchange 2019 and Exchange 2016. -- 2 or Daily. This is the default value in Exchange 2013 and Exchange 2010. +- 1 or Hourly. This value is the default in Exchange 2019 and Exchange 2016. +- 2 or Daily. This value is the default in Exchange 2013 and Exchange 2010. - 3 or Weekly. - 4 or Monthly. @@ -356,7 +384,6 @@ This parameter is only meaningful when the LogPerFileSizeQuota parameter value i Type: LogFileRollOver Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -366,17 +393,19 @@ Accept wildcard characters: False ``` ### -LoginType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LoginType parameter specifies the authentication method for POP3 connections. Valid values are: - 1 or PlainTextLogin. - 2 or PlainTextAuthentication. -- 3 or SecureLogin. This is the default value. +- 3 or SecureLogin. This value is the default. ```yaml Type: LoginOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -386,6 +415,9 @@ Accept wildcard characters: False ``` ### -LogPerFileSizeQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LogPerFileSizeQuota parameter specifies the maximum size of a POP3 protocol log file. When you enter a value, qualify the value with one of the following units: @@ -396,7 +428,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The default value is 0, which means a new POP3 protocol log file is created at the frequency that's specified by the LogFileRollOverSettings parameter. @@ -406,7 +438,6 @@ This parameter is only meaningful when the ProtocolLogEnabled parameter value is Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -416,13 +447,15 @@ Accept wildcard characters: False ``` ### -MaxCommandSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxCommandSize parameter specifies the maximum size in bytes of a single POP3 command. Valid values are from 40 through 1024. The default value is 512. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -432,13 +465,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionFromSingleIP + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConnectionFromSingleIP parameter specifies the maximum number of POP3 connections that are accepted by the Exchange server from a single IP address. Valid values are from 1 through 2147483647. The default value is 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -448,13 +483,15 @@ Accept wildcard characters: False ``` ### -MaxConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConnections parameter specifies the maximum number of POP3 connections that are accepted by the Exchange server. Valid values are from 1 through 2147483647. The default value is 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -464,13 +501,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionsPerUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConnectionsPerUser parameter specifies the maximum number of POP3 connections that are allowed for each user. Valid values are from 1 through 2147483647. The default value is 16. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -480,6 +519,9 @@ Accept wildcard characters: False ``` ### -MessageRetrievalMimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages. Valid values are: - 0 or TextOnly. @@ -487,14 +529,13 @@ The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages - 2 or HtmlAndTextAlternative. - 3 or TextEnrichedOnly. - 4 or TextEnrichedAndTextAlternative. -- 5 or BestBodyFormat. This is the default value. +- 5 or BestBodyFormat. This value is the default. - 6 or Tnef. ```yaml Type: MimeTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -504,16 +545,18 @@ Accept wildcard characters: False ``` ### -MessageRetrievalSortOrder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageRetrievalSortOrder parameter specifies how retrieved messages are sorted. Valid values are: -- 0 or Ascending. This is the default value. +- 0 or Ascending. This value is the default. - 1 or Descending. ```yaml Type: SortOrder Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -523,13 +566,15 @@ Accept wildcard characters: False ``` ### -OwaServerUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaServerUrl parameter specifies the URL that's used to retrieve calendar information for instances of custom Outlook on the web calendar items. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -539,6 +584,9 @@ Accept wildcard characters: False ``` ### -PreAuthenticatedConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PreAuthenticatedConnectionTimeout parameter specifies the time to wait before closing an idle POP3 connection that isn't authenticated. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -549,7 +597,6 @@ Valid values are from00:00:30 to 1:00:00. The default value is 00:01:00 (one min Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -559,16 +606,18 @@ Accept wildcard characters: False ``` ### -ProtocolLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProtocolLogEnabled parameter specifies whether to enable protocol logging for POP3. Valid values are: - $true: POP3 protocol logging is enabled. -- $false: POP3 protocol logging is disabled. This is the default value. +- $false: POP3 protocol logging is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -578,13 +627,15 @@ Accept wildcard characters: False ``` ### -ProxyTargetPort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProxyTargetPort parameter specifies the port on the Microsoft Exchange POP3 Backend service that listens for client connections that are proxied from the Microsoft Exchange POP3 service. The default value is 1995. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -594,6 +645,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -607,7 +661,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -617,6 +670,9 @@ Accept wildcard characters: False ``` ### -SSLBindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SSLBindings parameter specifies the IP address and TCP port that's used for an POP3 connection that's always encrypted by SSL/TLS. This parameter uses the syntax `IPv4OrIPv6Address:Port`. The default value is `[::]:995,0.0.0.0:995`. @@ -629,7 +685,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -639,16 +694,18 @@ Accept wildcard characters: False ``` ### -SuppressReadReceipt + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuppressReadReceipt parameter specifies whether to stop duplicate read receipts from being sent to POP3 clients that have the Send read receipts for messages I send setting configured in their POP3 email program. Valid values are: - $true: The sender receives a read receipt only when the recipient opens the message. -- $false: The sender receives a read receipt when the recipient downloads the message, and when the recipient opens the message. This is the default value. +- $false: The sender receives a read receipt when the recipient downloads the message, and when the recipient opens the message. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -658,6 +715,9 @@ Accept wildcard characters: False ``` ### -UnencryptedOrTLSBindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UnencryptedOrTLSBindings parameter specifies the IP address and TCP port that's used for unencrypted POP3 connections, or POP3 connections that are encrypted by using opportunistic TLS (STARTTLS) after the initial unencrypted protocol handshake. This parameter uses the syntax `IPv4OrIPv6Address:Port`. The default value is `[::]:110, 0.0.0.0:110`. @@ -670,7 +730,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -680,13 +739,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -696,6 +757,9 @@ Accept wildcard characters: False ``` ### -X509CertificateName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The X509CertificateName parameter specifies the certificate that's used for encrypting POP3 client connections. A valid value for this parameter is the FQDN from the ExternalConnectionSettings or InternalConnectionSettings parameters (for example, mail.contoso.com or mailbox01.contoso.com). @@ -708,7 +772,6 @@ If you use a wildcard certificate, you don't need to assign the certificate to t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-PowerShellVirtualDirectory.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PowerShellVirtualDirectory.md index 16c3da7808..bf18ace465 100644 --- a/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PowerShellVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-powershellvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PowerShellVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-powershellvirtualdirectory +schema: 2.0.0 +title: Set-PowerShellVirtualDirectory --- # Set-PowerShellVirtualDirectory @@ -40,7 +41,7 @@ Set-PowerShellVirtualDirectory [-Identity] ## DESCRIPTION Although it's possible to modify a Windows PowerShell virtual directory, we recommend that you only do so at the request of Microsoft Customer Service and Support. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,9 @@ This example modifies the external URL of the Contoso Windows PowerShell virtual ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the PowerShell virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -66,7 +70,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -76,16 +79,18 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: -- $true: Basic authentication is enabled. This is the default value. +- $true: Basic authentication is enabled. This value is the default. - $false: Basic authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -CertificateAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CertificateAuthentication parameter specifies whether certificate authentication is enabled on the Windows PowerShell virtual directory. The valid values are $true and $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -120,7 +130,6 @@ 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 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,19 +157,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,16 +181,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,10 +202,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -199,7 +217,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +244,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,13 +262,15 @@ Accept wildcard characters: False ``` ### -RequireSSL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireSSL parameter specifies whether the Windows PowerShell virtual directory should require that the client connection be made using Secure Sockets Layer (SSL). The valid values are $true and $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,13 +280,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,16 +298,18 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: -- $true: Integrated Windows authentication is enabled. This is the default value. +- $true: Integrated Windows authentication is enabled. This value is the default. - $false: Integrated Windows authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md b/exchange/exchange-ps/ExchangePowerShell/Set-ProtectionAlert.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-ProtectionAlert.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ProtectionAlert.md index c1875d6ea6..7df4ae0f1e 100644 --- a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ProtectionAlert.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-protectionalert applicable: Security & Compliance -title: Set-ProtectionAlert -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-protectionalert +schema: 2.0.0 +title: Set-ProtectionAlert --- # Set-ProtectionAlert @@ -74,6 +75,9 @@ This example modifies an alert so that even though it's configured for aggregate ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the alert policy that you want to modify. You can use any value that uniquely identifies the alert policy. For example: - Name @@ -84,7 +88,6 @@ The Identity parameter specifies the alert policy that you want to modify. You c Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -94,17 +97,19 @@ Accept wildcard characters: False ``` ### -AggregationType + +> Applicable: Security & Compliance + The AggregationType parameter specifies the how the alert policy triggers alerts for multiple occurrences of monitored activity. Valid values are: - None: Alerts are triggered for every occurrence of the activity. -- SimpleAggregation: Alerts are triggered based on the volume of activity in a given time window (the values of the Threshold and TimeWindow parameters). This is the default value. -- AnomalousAggregation: Alerts are triggered when the volume of activity reaches unusual levels (greatly exceeds the normal baseline that's established for the activity). Note that it can take up to 7 days for Microsoft 365 to establish the baseline. During the baseline calculation period, no alerts are generated for the activity. +- SimpleAggregation: Alerts are triggered based on the volume of activity in a given time window (the values of the Threshold and TimeWindow parameters). This value is the default. +- AnomalousAggregation: Alerts are triggered when the volume of activity reaches unusual levels (greatly exceeds the normal baseline that's established for the activity). It can take up to 7 days for Microsoft 365 to establish the baseline. During the baseline calculation period, no alerts are generated for the activity. ```yaml Type: AlertAggregationType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -AlertBy + +> Applicable: Security & Compliance + The AlertBy parameter specifies the scope for aggregated alert policies. Valid values are determined by the ThreatType parameter value: - Activity: Valid values are User or $null (blank, which is the default value). If you don't use the value User, the scope of the alert policy is the entire organization. @@ -121,11 +129,12 @@ The AlertBy parameter specifies the scope for aggregated alert policies. Valid v You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). +**Note**: This parameter is required to show entities in alerts. Without it, alerts trigger without showing entities. We strongly recommend specifying a value for this parameter. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -AlertFor + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: Security & Compliance + The Category parameter specifies a category for the alert policy. Valid values are: - AccessGovernance @@ -168,7 +182,6 @@ When an activity occurs that matches the conditions of the alert policy, the ale Type: AlertRuleCategory Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -194,6 +209,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -203,7 +221,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -213,13 +230,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies descriptive text for the alert policy. 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 @@ -229,16 +248,18 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter enables or disables the alert policy. Valid values are: - $true: The alert policy is disabled. -- $false: The alert policy is enabled. This is the default value. +- $false: The alert policy is enabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -248,6 +269,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Security & Compliance + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -308,7 +332,6 @@ You can specify multiple criteria by using the -and comparison operator. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -318,6 +341,9 @@ Accept wildcard characters: False ``` ### -NotificationCulture + +> Applicable: Security & Compliance + The NotificationCulture parameter specifies the language or locale that's used for notifications. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -326,7 +352,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -336,13 +361,15 @@ Accept wildcard characters: False ``` ### -NotificationEnabled + +> Applicable: Security & Compliance + {{ Fill NotificationEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -352,13 +379,15 @@ Accept wildcard characters: False ``` ### -NotifyUser + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -368,10 +397,13 @@ Accept wildcard characters: False ``` ### -NotifyUserOnFilterMatch + +> Applicable: Security & Compliance + The NotifyUserOnFilterMatch parameter specifies whether to trigger an alert for a single event when the alert policy is configured for aggregated activity. Valid values are: - $true: Even though the alert is configured for aggregated activity, a notification is triggered during a match for the activity (basically, an early warning). -- $false: Alerts are triggered according to the specified aggregation type. This is the default value. +- $false: Alerts are triggered according to the specified aggregation type. This value is the default. You can't use this parameter when the AggregationType parameter value is None (alerts are triggered for every occurrence of the activity). @@ -379,7 +411,6 @@ You can't use this parameter when the AggregationType parameter value is None (a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -389,6 +420,9 @@ Accept wildcard characters: False ``` ### -NotifyUserSuppressionExpiryDate + +> Applicable: Security & Compliance + 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". @@ -397,7 +431,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -407,16 +440,18 @@ Accept wildcard characters: False ``` ### -NotifyUserThrottleThreshold -The NotifyUserThrottleThreshold parameter specifies the maximum number of notifications for the alert policy within the time period specified by the NotifyUserThrottleWindow parameter. Once the maximum number of notifications has been reached in the time period, no more notifications are sent for the alert. Valid values are: + +> Applicable: Security & Compliance + +The NotifyUserThrottleThreshold parameter specifies the maximum number of notifications for the alert policy within the time period specified by the NotifyUserThrottleWindow parameter. Once the maximum number of notifications is reached in the time period, no more notifications are sent for the alert. Valid values are: - An integer. -- The value $null. This is the default value (no maximum number of notifications for an alert). +- The value $null. This value is the default (no maximum number of notifications for an alert). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -426,16 +461,18 @@ Accept wildcard characters: False ``` ### -NotifyUserThrottleWindow + +> Applicable: Security & Compliance + The NotifyUserThrottleWindow parameter specifies the time interval in minutes that's used by the NotifyUserThrottleThreshold parameter. Valid values are: - An integer. -- The value $null. This is the default value (no interval for notification throttling). +- The value $null. This value is the default (no interval for notification throttling). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -445,6 +482,9 @@ Accept wildcard characters: False ``` ### -Operation + +> Applicable: Security & Compliance + The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. @@ -455,7 +495,6 @@ You can only use this parameter when the ThreatType parameter has the value Acti Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -465,13 +504,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypes + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -481,13 +522,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypesForCounting + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypesForCounting Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -497,13 +540,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypesThreshold + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypesThreshold Description }} ```yaml Type: System.UInt64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -513,9 +558,12 @@ Accept wildcard characters: False ``` ### -Severity + +> Applicable: Security & Compliance + The Severity parameter specifies the severity of the detection. Valid values are: -- Low (This is the default value) +- Low (default value) - Medium - High @@ -523,7 +571,6 @@ The Severity parameter specifies the severity of the detection. Valid values are Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -533,6 +580,9 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: Security & Compliance + The Threshold parameter specifies the number of detections that trigger the alert policy (within the time period specified by the TimeWindow parameter). A valid value is an integer that's greater than or equal to 3. You can only use this parameter when the AggregationType parameter value is SimpleAggregation. @@ -541,7 +591,6 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -551,6 +600,9 @@ Accept wildcard characters: False ``` ### -TimeWindow + +> Applicable: Security & Compliance + The TimeWindow parameter specifies the time interval in minutes for number of detections specified by the Threshold parameter. A valid value is an integer that's greater than 60 (one hour). You can only use this parameter when the AggregationType parameter value is SimpleAggregation. @@ -559,7 +611,6 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -569,13 +620,15 @@ Accept wildcard characters: False ``` ### -VolumeThreshold + +> Applicable: Security & Compliance + {{ Fill VolumeThreshold Description }} ```yaml Type: System.UInt64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -585,13 +638,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-PublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolder.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-PublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PublicFolder.md index d2f0376645..637254fa24 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolder.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-PublicFolder -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-publicfolder +schema: 2.0.0 +title: Set-PublicFolder --- # Set-PublicFolder ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-PublicFolder cmdlet to set the attributes of public folders. @@ -51,7 +52,7 @@ Set-PublicFolder [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,13 +80,15 @@ In Exchange 2010, this example sets the folder to replicate only on weekends. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name and path of the public folder you want to modify. A valid value uses the format: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. ```yaml Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -95,7 +98,10 @@ Accept wildcard characters: False ``` ### -AgeLimit -The AgeLimit parameter specifies the overall age limit on the folder. Replicas of this public folder are automatically deleted when the age limit is exceeded. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AgeLimit parameter specifies the overall age limit on the folder. Items that reach the age limit are deleted from the public folder. Replicas of this public folder are automatically deleted when the age limit is exceeded. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -103,7 +109,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -122,7 +130,6 @@ 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 Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -140,7 +150,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -EformsLocaleId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -174,7 +188,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -184,6 +197,9 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The HiddenFromAddressListsEnabled parameter specifies whether to hide the public folder from address lists. @@ -192,7 +208,6 @@ The HiddenFromAddressListsEnabled parameter specifies whether to hide the public Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IssueWarningQuota parameter specifies the public folder size that triggers a warning to public folder owners stating that the folder is almost full. The default value is unlimited, which is 2 terabytes. @@ -214,7 +232,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 1 through 2TB. @@ -222,7 +240,6 @@ The valid input range for this parameter is from 1 through 2TB. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -232,6 +249,9 @@ Accept wildcard characters: False ``` ### -LocalReplicaAgeLimit + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The LocalReplicaAgeLimit parameter specifies the age limit of the replica on the connected server, if there is a replica on it. @@ -240,7 +260,6 @@ The LocalReplicaAgeLimit parameter specifies the age limit of the replica on the Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -250,6 +269,9 @@ Accept wildcard characters: False ``` ### -MailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailEnabled parameter specifies that the public folder is mail-enabled. To do this, you use the value $true. You use this parameter to correct a mail-enabled public folder that lost its mail-enabled status. If you attempt to use this parameter to mail-enable a public folder that was never mail-enabled, the command will fail. @@ -258,7 +280,6 @@ You use this parameter to correct a mail-enabled public folder that lost its mai Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -268,6 +289,9 @@ Accept wildcard characters: False ``` ### -MailRecipientGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MailRecipientGuid parameter specifies the MailRecipientGuid value of the public folder. You use this parameter to correct a mail-enabled public folder that lost its MailRecipientGuid value. The value that you specify for this parameter must match the MailRecipientGuid value of an existing mail-enabled public folder. Otherwise, the command will fail. @@ -276,7 +300,6 @@ The value that you specify for this parameter must match the MailRecipientGuid v Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -286,6 +309,9 @@ Accept wildcard characters: False ``` ### -MaxItemSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxItemSize parameter specifies the maximum size for posted items. Items larger than the value of the MaxItemSize parameter are rejected. The default value is unlimited, which is 2 gigabytes. When you enter a value, qualify the value with one of the following units: When you enter a value, qualify the value with one of the following units: @@ -296,7 +322,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 1 through 2GB. @@ -304,7 +330,6 @@ The valid input range for this parameter is from 1 through 2GB. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -314,13 +339,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name for the public folder. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -330,6 +357,9 @@ Accept wildcard characters: False ``` ### -OverrideContentMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The OverrideContentMailbox parameter specifies the target public folder mailbox whereyou want to move this public folder's content to. You can use any value that uniquely identifies the mailbox. For example: @@ -349,7 +379,6 @@ The OverrideContentMailbox parameter specifies the target public folder mailbox Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -359,13 +388,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Path parameter specifies the path of the public folder, for example, \\TopLevelPublicFolder\\PublicFolder. ```yaml Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -375,13 +406,15 @@ Accept wildcard characters: False ``` ### -PerUserReadStateEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PerUserReadStateEnabled parameter specifies whether to maintain read and unread data on a per-user basis. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -391,6 +424,9 @@ Accept wildcard characters: False ``` ### -ProhibitPostQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ProhibitPostQuota parameter specifies the size of a public folder at which users are notified that the public folder is full. Users can't post to a folder whose size is larger than the ProhibitPostQuota parameter value. The default value is unlimited, which is 2 terabytes. When you enter a value, qualify the value with one of the following units: @@ -401,7 +437,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 1 through 2TB. @@ -409,7 +445,6 @@ The valid input range for this parameter is from 1 through 2TB. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -419,6 +454,9 @@ Accept wildcard characters: False ``` ### -Replicas + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The Replicas parameter specifies a list of public folder databases with which to replicate this public folder. You can use any value that uniquely identifies the database. For example: @@ -433,7 +471,6 @@ You can specify multiple values separated by commas. If the values contain space Type: DatabaseIdParameter[] Parameter Sets: Set2 Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -443,6 +480,9 @@ Accept wildcard characters: False ``` ### -ReplicationSchedule + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The ReplicationSchedule parameter specifies the replication schedule for the folder. @@ -471,7 +511,6 @@ Here are some examples: Type: Schedule Parameter Sets: Set2 Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -481,6 +520,9 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsFor + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetainDeletedItemsFor parameter specifies the retention time for deleted items. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -489,7 +531,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -499,6 +540,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -514,7 +558,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -524,6 +567,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseAgeDefaults + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The UseDatabaseAgeDefaults parameter specifies whether to use the database age limit. @@ -532,7 +578,6 @@ The UseDatabaseAgeDefaults parameter specifies whether to use the database age l Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -542,6 +587,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseQuotaDefaults + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The UseDatabaseQuotaDefaults parameter specifies whether to use the public store quota limits. @@ -550,7 +598,6 @@ The UseDatabaseQuotaDefaults parameter specifies whether to use the public store Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -560,6 +607,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseReplicationSchedule + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The UseDatabaseReplicationSchedule parameter specifies whether to use the public folder replication schedule. @@ -568,7 +618,6 @@ The UseDatabaseReplicationSchedule parameter specifies whether to use the public Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -578,6 +627,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseRetentionDefaults + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The UseDatabaseRetentionDefaults parameter specifies whether to use the database retention defaults. @@ -586,7 +638,6 @@ The UseDatabaseRetentionDefaults parameter specifies whether to use the database Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -596,13 +647,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderDatabase.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderDatabase.md index 85ad17feda..a1407b777f 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfolderdatabase applicable: Exchange Server 2010 -title: Set-PublicFolderDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-publicfolderdatabase +schema: 2.0.0 +title: Set-PublicFolderDatabase --- # Set-PublicFolderDatabase @@ -48,7 +49,7 @@ Set-PublicFolderDatabase [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,11 +72,14 @@ This example sets the database maintenance schedule on PFDB01 to run daily from Set-PublicFolderDatabase -RetainDeletedItemsUntilBackup $true -Identity 'PFDB01' ``` -This example prevents the deleted items in the public folder database PFDB01 from being permanently deleted until after the database has been backed up. +This example prevents the deleted items in the public folder database PFDB01 from being permanently deleted until after the database is backed up. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the public folder database that you want to modify. You can use any value that uniquely identifies the database. For example: - Name @@ -86,7 +90,6 @@ The Identity parameter specifies the public folder database that you want to mod Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -AllowFileRestore + +> Applicable: Exchange Server 2010 + The AllowFileRestore parameter specifies that the public folder database can be overwritten if the public folder database is restored. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -112,13 +117,15 @@ Accept wildcard characters: False ``` ### -BackgroundDatabaseMaintenance + +> Applicable: Exchange Server 2010 + The BackgroundDatabaseMaintenance parameter specifies whether the Extensible Storage Engine (ESE) performs database maintenance. The two possible values are $true or $false. If you specify $true, the public folder database reads the object during database mount and initializes the database to perform the background database maintenance. If you specify $false, the public folder database reads the object during database mount and initializes the database without the option to perform the background database maintenance. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -CircularLoggingEnabled + +> Applicable: Exchange Server 2010 + The CircularLoggingEnabled parameter specifies whether to enable circular logging. If you specify a value of $true, circular logging is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -153,7 +165,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -CustomReferralServerList + +> Applicable: Exchange Server 2010 + The CustomReferralServerList parameter specifies public folder referral costs to individual servers manually. Costs can be any positive number. Servers not included on the list aren't included for referrals. If this parameter is set with no servers in the list, there are no public folder referrals. The CustomReferralServerList parameter accepts an array in the following format: "serverID:cost". Use a comma to separate multiple servers, for example, "MBXSERVER01:1","MBXSERVER02:5". @@ -171,7 +185,6 @@ The CustomReferralServerList parameter accepts an array in the following format: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -DeletedItemRetention + +> Applicable: Exchange Server 2010 + The DeletedItemRetention parameter specifies the time that deleted items are kept in the dumpster before being permanently deleted during store maintenance. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -197,13 +212,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -213,13 +230,15 @@ Accept wildcard characters: False ``` ### -EventHistoryRetentionPeriod + +> Applicable: Exchange Server 2010 + The EventHistoryRetentionPeriod parameter specifies the length of time that events are retained in the event history table. Events can be retained for up to one week. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -229,13 +248,15 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2010 + The IssueWarningQuota parameter specifies the public folder size at which a warning is issued to public folder owners stating that the folder is almost full. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -245,13 +266,15 @@ Accept wildcard characters: False ``` ### -ItemRetentionPeriod + +> Applicable: Exchange Server 2010 + The ItemRetentionPeriod parameter specifies the length of time that items are retained in a folder before they're deleted during store maintenance. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -261,6 +284,9 @@ Accept wildcard characters: False ``` ### -MaintenanceSchedule + +> Applicable: Exchange Server 2010 + The MaintenanceSchedule parameter specifies the store maintenance schedule. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. @@ -286,7 +312,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -296,13 +321,15 @@ Accept wildcard characters: False ``` ### -MaxItemSize + +> Applicable: Exchange Server 2010 + The MaxItemSize parameter specifies the maximum size of an item that can be posted to or received by a public folder. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -312,13 +339,15 @@ Accept wildcard characters: False ``` ### -MountAtStartup + +> Applicable: Exchange Server 2010 + The MountAtStartup parameter specifies whether the database should be mounted when the store starts. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -328,13 +357,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the name of the public folder database. Use this parameter to change the name of the public folder database. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -344,13 +375,15 @@ Accept wildcard characters: False ``` ### -ProhibitPostQuota + +> Applicable: Exchange Server 2010 + The ProhibitPostQuota parameter specifies the size of a public folder at which users are notified that the public folder is full. Users can't post to a folder larger than the ProhibitPostQuota parameter value. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -360,6 +393,9 @@ Accept wildcard characters: False ``` ### -QuotaNotificationSchedule + +> Applicable: Exchange Server 2010 + The QuotaNotificationSchedule parameter specifies the interval at which warning messages are sent when public folders exceed their specified size limit. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. @@ -385,7 +421,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -395,7 +430,10 @@ Accept wildcard characters: False ``` ### -ReplicationMessageSize -The ReplicationMessageSize parameter specifies the size of replication messages. Small items may be aggregated into a single replication message that can be as large as this setting, but items larger than this setting are replicated with messages larger than this size. + +> Applicable: Exchange Server 2010 + +The ReplicationMessageSize parameter specifies the size of replication messages. Small items might be aggregated into a single replication message that can be as large as this setting, but items larger than this setting are replicated with messages larger than this size. A valid value is a number up to 2 gigabytes (2147482624 bytes). The default value is 300 kilobytes (307200 bytes). @@ -406,13 +444,12 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -422,13 +459,15 @@ Accept wildcard characters: False ``` ### -ReplicationPeriod -The ReplicationPeriod parameter specifies the interval at which replication of public folders or content updates may occur. + +> Applicable: Exchange Server 2010 + +The ReplicationPeriod parameter specifies the interval at which replication of public folders or content updates might occur. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -438,7 +477,10 @@ Accept wildcard characters: False ``` ### -ReplicationSchedule -The ReplicationSchedule parameter specifies the time intervals during which replication of public folders or contents may occur. + +> Applicable: Exchange Server 2010 + +The ReplicationSchedule parameter specifies the time intervals during which replication of public folders or contents might occur. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. @@ -464,7 +506,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -474,13 +515,15 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsUntilBackup + +> Applicable: Exchange Server 2010 + The RetainDeletedItemsUntilBackup parameter specifies that deleted items aren't removed until a backup of the public folder database is performed. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -490,6 +533,9 @@ Accept wildcard characters: False ``` ### -UseCustomReferralServerList + +> Applicable: Exchange Server 2010 + The UseCustomReferralServerList parameter specifies whether to use the server costs specified by the PublicFolderReferralServerList parameter. If set to $true, the server uses the PublicFolderReferralServerList parameter costs to make public folder referrals. If set to $false, the server uses Active Directory inter-site costs to make public folder referrals. Setting this parameter to $false also clears the PublicFolderReferralServerList parameter. @@ -498,7 +544,6 @@ Setting this parameter to $false also clears the PublicFolderReferralServerList Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -508,13 +553,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMigrationRequest.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMigrationRequest.md index 7c4de5b3bf..e02fbe8c83 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfoldermigrationrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PublicFolderMigrationRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-publicfoldermigrationrequest +schema: 2.0.0 +title: Set-PublicFolderMigrationRequest --- # Set-PublicFolderMigrationRequest @@ -55,7 +56,7 @@ Set-PublicFolderMigrationRequest [-Identity] Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the migration request that you want to modify. You can use the following values: - Name @@ -78,7 +82,6 @@ The Identity parameter specifies the migration request that you want to modify. Type: PublicFolderMigrationRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -RehomeRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RehomeRequest switch tells the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the public folder that's being migrated. You don't need to specify a value with this switch. This switch is used primarily for debugging purposes. @@ -96,7 +102,6 @@ This switch is used primarily for debugging purposes. Type: SwitchParameter Parameter Sets: Rehome Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -114,7 +122,6 @@ You need to use this switch if you set the LargeItemLimit parameter to a value o Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -132,7 +142,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BatchName parameter specifies a descriptive name for the public folder batch migration. You can use the BatchName parameter as a search string when you use the Get-PublicFolderMigrationRequest cmdlet. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -158,13 +169,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -183,7 +199,6 @@ 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 Required: False Position: Named @@ -193,13 +208,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All)) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +244,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -240,7 +262,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -250,16 +271,18 @@ Accept wildcard characters: False ``` ### -PreventCompletion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PreventCompletion parameter specifies whether to run the migration request, but not allow it to complete. Valid values are: - $true: The migration request is run, but is not allowed to complete. To complete the migration request, set this parameter to $false before you run the Resume-PublicFolderMigrationRequest cmdlet. -- $false: The migration request is run and allowed to complete. This is the default value. +- $false: The migration request is run and allowed to complete. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -269,12 +292,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: - Lowest - Lower - Low -- Normal: This is the default value. +- Normal: This value is the default. - High - Higher - Highest @@ -284,7 +310,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -294,6 +319,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -307,7 +335,6 @@ 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 Required: False Position: Named @@ -317,13 +344,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SkipMerging parameter specifies whether certain stages of a migration are to be skipped for debugging purposes. Don't use this parameter unless directed to do so by Microsoft Customer Service and Support or specific documentation. ```yaml Type: SkippableMergeComponent[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -333,13 +362,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMoveRequest.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMoveRequest.md index f63c7353d0..a38c57d131 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfoldermoverequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PublicFolderMoveRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-publicfoldermoverequest +schema: 2.0.0 +title: Set-PublicFolderMoveRequest --- # Set-PublicFolderMoveRequest @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-PublicFolderMoveRequest cmdlet to change a public folder move request after the move request has been created. You can use the Set-PublicFolderMoveRequest cmdlet to recover from a failed move request. +Use the Set-PublicFolderMoveRequest cmdlet to change a public folder move request after the move request is created. You can use the Set-PublicFolderMoveRequest cmdlet to recover from a failed move request. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -39,7 +40,7 @@ Set-PublicFolderMoveRequest [-Identity] ## DESCRIPTION You can pipeline the Set-PublicFolderMoveRequest cmdlet from the Get-PublicFolderMoveRequestStatistics or Get-PublicFolderMoveRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example changes the public folder move request \\PublicFolderMove to accept ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the public folder move request. The default identity of a public folder move request is \\PublicFolderMove. ```yaml Type: PublicFolderMoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -77,7 +83,6 @@ 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 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -95,7 +103,6 @@ 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 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -130,7 +142,6 @@ 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 Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +169,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +187,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the 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. For more information about maximum message size values, see the following topics: @@ -187,7 +205,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,12 +214,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: - Lowest - Lower - Low -- Normal: This is the default value. +- Normal: This value is the default. - High - Higher - Highest @@ -212,7 +232,6 @@ 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 Required: False Position: Named @@ -222,6 +241,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -235,7 +257,6 @@ 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 Required: False Position: Named @@ -245,13 +266,15 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuspendWhenReadyToComplete parameter specifies whether to suspend the request before it reaches the status of CompletionInProgress. After the move is suspended, it has a status of AutoSuspended. You can then manually complete the move by using the Resume-PublicFolderMoveRequest command. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,13 +284,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md b/exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePermissions.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-QuarantinePermissions.md rename to exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePermissions.md index 124bd14378..bc66a72143 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePermissions.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-quarantinepermissions applicable: Exchange Online, Exchange Online Protection -title: Set-QuarantinePermissions -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-quarantinepermissions +schema: 2.0.0 +title: Set-QuarantinePermissions --- # Set-QuarantinePermissions @@ -38,7 +39,7 @@ Set-QuarantinePermissions -QuarantinePermissionsObject ## DESCRIPTION To see the current value of the permissions object that you want to modify, run the variable name as a command. For example, run the command `$Perms` to see the quarantine policy permissions stored in the `$Perms` variable. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,13 +55,15 @@ In the same PowerShell session, you can use `$Perms` for the _EndUserQuarantineP ## PARAMETERS ### -QuarantinePermissionsObject + +> Applicable: Exchange Online, Exchange Online Protection + The QuarantinePermissionsObject parameter specifies the existing variable that contains quarantine permissions that you want to modify. For example if you previously ran the command `$Perms = New-QuarantinePermissions `, use the value `$Perms` for this parameter. ```yaml Type: QuarantinePermissions Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 9 @@ -70,16 +73,18 @@ Accept wildcard characters: False ``` ### -PermissionToAllowSender + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- $false: Allow sender isn't available for affected messages in quarantine. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -89,16 +94,18 @@ Accept wildcard characters: False ``` ### -PermissionToBlockSender + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are: - $true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine. -- $false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This is the default value. +- $false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 2 @@ -108,16 +115,18 @@ Accept wildcard characters: False ``` ### -PermissionToDelete + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are: - $true: Delete messages and Delete from quarantine are available for affected messages in quarantine. -- $false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This is the default value. +- $false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 3 @@ -127,10 +136,13 @@ Accept wildcard characters: False ``` ### -PermissionToDownload + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToDownload parameter specifies whether users are allowed to download messages from quarantine. Valid values are: - $true: The permission is enabled. -- $false: The permission is disabled. This is the default value. +- $false: The permission is disabled. This value is the default. 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. @@ -138,7 +150,6 @@ Currently, this value has no effect on the available actions in quarantine notif Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 4 @@ -148,16 +159,18 @@ Accept wildcard characters: False ``` ### -PermissionToPreview + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are: - $true: Preview message is available for affected messages in quarantine. -- $false: Preview message isn't available for affected messages in quarantine. This is the default value. +- $false: Preview message isn't available for affected messages in quarantine. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 5 @@ -167,6 +180,9 @@ Accept wildcard characters: False ``` ### -PermissionToRelease + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are: - $true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine. @@ -178,7 +194,6 @@ Don't set this parameter and the _PermissionToRequestRelease_ parameter to $true Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 6 @@ -188,6 +203,9 @@ Accept wildcard characters: False ``` ### -PermissionToRequestRelease + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are: - $true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine. @@ -199,7 +217,6 @@ Don't set this parameter and the _PermissionRelease_ parameter to $true. Set one Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 7 @@ -209,10 +226,13 @@ Accept wildcard characters: False ``` ### -PermissionToViewHeader + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToViewHeader parameter specifies whether users are allowed to view the message headers of quarantined messages. Valid values are: - $true: The permission is enabled. -- $false: The permission is disabled. This is the default value. +- $false: The permission is disabled. This value is the default. 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. @@ -220,7 +240,6 @@ Currently, this value has no effect on available actions in quarantine notificat Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 8 diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-QuarantinePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePolicy.md index 581ac6b1c0..a80cbc375e 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-quarantinepolicy applicable: Exchange Online, Exchange Online Protection -title: Set-QuarantinePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-quarantinepolicy +schema: 2.0.0 +title: Set-QuarantinePolicy --- # Set-QuarantinePolicy @@ -49,9 +50,9 @@ Set-QuarantinePolicy [-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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,6 +78,9 @@ This example modifies the global settings for quarantine notifications (formerly ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the quarantine policy you want to modify. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -87,7 +91,6 @@ The Identity parameter specifies the quarantine policy you want to modify. You c Type: QuarantineTagIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -AdminNotificationFrequencyInDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,13 +118,15 @@ Accept wildcard characters: False ``` ### -AdminNotificationLanguage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: EsnLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese Required: False @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -AdminNotificationsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -AdminQuarantinePermissionsList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -171,7 +185,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -CustomDisclaimer + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -197,13 +212,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -213,6 +230,9 @@ Accept wildcard characters: False ``` ### -EndUserQuarantinePermissions + +> Applicable: Exchange Online, Exchange Online Protection + **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. @@ -223,7 +243,6 @@ For example, run the following command to store the required permissions in a va Type: QuarantinePermissions Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +252,9 @@ Accept wildcard characters: False ``` ### -EndUserQuarantinePermissionsValue + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy. This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1): @@ -260,7 +282,6 @@ For custom permissions, get the binary value that corresponds to the permissions Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -270,13 +291,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. To set this parameter back to the default email address quarantine@messaging.microsoft.com, use the value $null. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -286,6 +309,9 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserSpamNotificationFrequency parameter species how often quarantine notifications are sent to users. Valid values are: - 04:00:00 (4 hours) @@ -296,7 +322,6 @@ The EndUserSpamNotificationFrequency parameter species how often quarantine noti Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -306,13 +331,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequencyInDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -322,13 +349,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLanguage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: EsnLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese Required: False @@ -339,6 +368,9 @@ Accept wildcard characters: False ``` ### -EsnCustomSubject + +> Applicable: Exchange Online, Exchange Online Protection + The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications. You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. @@ -351,7 +383,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: MultiValuedProperty Parameter Sets: (All) Aliases: MultiValuedProperty -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -361,10 +392,13 @@ Accept wildcard characters: False ``` ### -ESNEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: - $true: Quarantine notifications are enabled. -- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value. +- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This value is the default. **Note**: If the value of this parameter is $true and the value of the EndUserQuarantinePermissionsValue parameter is 0 (No access where all permissions are turned off), users can view their messages in quarantine, but the only available action for the messages is **View message header**. @@ -372,7 +406,6 @@ The ESNEnabled parameter specifies whether to enable quarantine notifications (f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -382,13 +415,15 @@ Accept wildcard characters: False ``` ### -IgnoreDehydratedFlag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -398,16 +433,18 @@ Accept wildcard characters: False ``` ### -IncludeMessagesFromBlockedSenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + 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. +- $false: Recipients don't get quarantine notifications for affected messages from blocked senders. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -417,6 +454,9 @@ Accept wildcard characters: False ``` ### -MultiLanguageCustomDisclaimer + +> Applicable: Exchange Online, Exchange Online Protection + The MultiLanguageCustomDisclaimer parameter specifies the custom disclaimer text to use near the bottom of quarantine notifications. The localized text, **A disclaimer from your organization:** is always included first, followed by the text you specify for this parameter. You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique custom disclaimer text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. @@ -429,7 +469,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -439,6 +478,9 @@ Accept wildcard characters: False ``` ### -MultiLanguageSenderName + +> Applicable: Exchange Online, Exchange Online Protection + The MultiLanguageSenderName parameter specifies the email sender's display name to use in quarantine notifications. You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you can specify a unique sender name. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, and MultiLanguageSenderName parameter values in the same order. @@ -451,7 +493,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -461,6 +502,9 @@ Accept wildcard characters: False ``` ### -MultiLanguageSetting + +> Applicable: Exchange Online, Exchange Online Protection + The MultiLanguageSetting parameter specifies the language of quarantine notifications. Valid values are: Default, Amharic, Arabic, Basque, BengaliIndia, Bulgarian, Catalan, ChineseSimplified, ChineseTraditional, Croatian, Cyrillic, Czech, Danish, Dutch, English, Estonian, Filipino, Finnish, French, Galician, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Malay, Malayalam, Marathi, Norwegian, NorwegianNynorsk, Odia, Persian, Polish, Portuguese, PortuguesePortugal, Romanian, Russian, Serbian, SerbianCyrillic, Slovak, Slovenian, Spanish, Swahili, Swedish, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, and Vietnamese. @@ -477,7 +521,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -487,10 +530,13 @@ Accept wildcard characters: False ``` ### -OrganizationBrandingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The OrganizationBrandingEnabled parameter enables or disables organization branding in the end-user quarantine notification messages. Valid values are: - $true: Organization branding is enabled. The default Microsoft logo that's used in quarantine notifications is replaced by your custom logo. Before you do this, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your custom logo. -- $false: Organization branding is disabled. The default Microsoft logo is used in quarantine notifications. This is the default value. +- $false: Organization branding is disabled. The default Microsoft logo is used in quarantine notifications. This value is the default. This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. @@ -498,7 +544,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,13 +553,15 @@ Accept wildcard characters: False ``` ### -QuarantineRetentionDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -524,13 +571,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RMSTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Set-RMSTemplate.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-RMSTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RMSTemplate.md index 807ec202d5..27c19d4d2b 100644 --- a/exchange/exchange-ps/exchange/Set-RMSTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RMSTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-rmstemplate applicable: Exchange Online, Exchange Online Protection -title: Set-RMSTemplate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-rmstemplate +schema: 2.0.0 +title: Set-RMSTemplate --- # Set-RMSTemplate @@ -15,7 +16,7 @@ ms.reviewer: This cmdlet is available only in the cloud-based service. > [!NOTE] -> This cmdlet has been deprecated. If you use AD RMS with Exchange Online, you need to migrate to Azure Information Protection before you can use message encryption. For more information, see [Verify that Azure Rights Management is active](https://learn.microsoft.com/purview/set-up-new-message-encryption-capabilities#verify-that-azure-rights-management-is-active). +> This cmdlet is deprecated. If you use AD RMS with Exchange Online, you need to migrate to Azure Information Protection before you can use message encryption. For more information, see [Verify that Azure Rights Management is active](https://learn.microsoft.com/purview/set-up-new-message-encryption-capabilities#verify-that-azure-rights-management-is-active). Use the Set-RMSTemplate cmdlet to modify the properties of an existing Active Directory Rights Management Services (AD RMS) template in your organization. @@ -45,6 +46,9 @@ This example changes the RMS template Contoso Confidential from Distributed to A ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the RMS template. You can use any value that uniquely identifies the RMS template, for example: - Name @@ -56,7 +60,6 @@ You can use the Get-RMSTemplate cmdlet to view the RMS templates in your organiz Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Online, Exchange Online Protection + The Type parameter specifies the type of RMS template. You can specify one of the following values: - Archived @@ -78,7 +84,6 @@ The default type for imported RMS templates is Archived. Type: RmsTemplateType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ReceiveConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-ReceiveConnector.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-ReceiveConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ReceiveConnector.md index 0243479192..9ac0a5b89e 100644 --- a/exchange/exchange-ps/exchange/Set-ReceiveConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ReceiveConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-receiveconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ReceiveConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-receiveconnector +schema: 2.0.0 +title: Set-ReceiveConnector --- # Set-ReceiveConnector @@ -82,7 +83,7 @@ Set-ReceiveConnector [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -100,6 +101,9 @@ Configures the Receive connector to time out connections after 15 minutes. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Receive connector that you want to modify. You can use any value that uniquely identifies the Receive connector. For example: - Name @@ -111,7 +115,6 @@ The Identity parameter specifies the Receive connector that you want to modify. Type: ReceiveConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -121,16 +124,18 @@ Accept wildcard characters: False ``` ### -AdvertiseClientSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AdvertiseClientSettings parameter specifies whether the SMTP server name, port number, and authentication settings for the Receive connector are displayed to users in the options of Outlook on the web. Valid values are: - $true: The SMTP values are displayed in Outlook on the web. Typically, you would only use this setting for a Receive connector with the usage type Client (authenticated SMTP connections on TCP port 587 for POP3 and IMAP4 clients). -- $false: The SMTP values are displayed in Outlook on the web. This is the default value. +- $false: The SMTP values are displayed in Outlook on the web. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,6 +145,9 @@ Accept wildcard characters: False ``` ### -AuthMechanism + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AuthMechanism parameter specifies the advertised and accepted authentication mechanisms for the Receive connector. Valid values are: - None @@ -162,7 +170,6 @@ You can specify multiple values separated by commas, but some values have depend Type: AuthMechanisms Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,7 +179,10 @@ Accept wildcard characters: False ``` ### -AuthTarpitInterval -The AuthTarpitInterval parameter specifies the period of time to delay responses to failed authentication attempts from remote servers that may be abusing the connection. The default value is 5 seconds. + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The AuthTarpitInterval parameter specifies the period of time to delay responses to failed authentication attempts from remote servers that might be abusing the connection. The default value is 5 seconds. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -184,7 +194,6 @@ You can configure the delay for other SMTP failure responses by using the Tarpit Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +203,9 @@ Accept wildcard characters: False ``` ### -Banner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Banner parameter specifies a custom SMTP 220 banner that's displayed to remote messaging servers that connect to the Receive connector. When you specify a value, enclose the value in quotation marks, and start the value with 220 (the default "Service ready" SMTP response code). The default value of this parameter is blank ($null), which uses the following SMTP banner: @@ -204,7 +216,6 @@ The default value of this parameter is blank ($null), which uses the following S Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -214,10 +225,13 @@ Accept wildcard characters: False ``` ### -BareLinefeedRejectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BareLinefeedRejectionEnabled parameter specifies whether this Receive connector rejects messages that contain line feed (LF) characters without immediately preceding carriage return characters (CR) in the SMTP DATA stream. This condition is known as bare line feeds. Valid values are: - $true: Messages that contain bare line feeds are rejected. -- $false: Messages that contain bare line feeds aren't rejected. This is the default value. +- $false: Messages that contain bare line feeds aren't rejected. This value is the default. Although message that contain bare line feeds might be delivered successfully, these messages don't follow SMTP protocol standards and might cause problems on messaging servers. @@ -225,7 +239,6 @@ Although message that contain bare line feeds might be delivered successfully, t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -235,9 +248,12 @@ Accept wildcard characters: False ``` ### -BinaryMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BinaryMimeEnabled parameter specifies whether the BINARYMIME Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: BINARYMIME is enabled and is advertised in the EHLO response. This setting requires that the ChunkingEnabled parameter is also set to the value $true. This is the default value. +- $true: BINARYMIME is enabled and is advertised in the EHLO response. This setting requires that the ChunkingEnabled parameter is also set to the value $true. This value is the default. - $false: BINARYMIME is disabled and isn't advertised in the EHLO response. The binary MIME extension is defined in RFC 3030. @@ -246,7 +262,6 @@ The binary MIME extension is defined in RFC 3030. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -256,6 +271,9 @@ Accept wildcard characters: False ``` ### -Bindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax `"IPv4Address:TCPPort","IPv6Address:TCPPort"`. You can specify an IPv4 address and port, an IPv6 address and port, or both. The IP address values 0.0.0.0 or `[::]` indicate that the Receive connector uses all available local IPv4 or all IPv6 addresses. You need to specify a valid local IP address from the network adapters of the Exchange server. If you specify an invalid local IP address, the Microsoft Exchange Transport service might fail to start when the service is restarted. @@ -269,7 +287,6 @@ The values for this parameter must satisfy one of the following uniqueness requi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -279,9 +296,12 @@ Accept wildcard characters: False ``` ### -ChunkingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ChunkingEnabled parameter specifies whether the CHUNKING Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: CHUNKING is enabled and is advertised in the EHLO response. This is the default value. +- $true: CHUNKING is enabled and is advertised in the EHLO response. This value is the default. - $false: CHUNKING is disabled and isn't advertised in the EHLO response. Chunking is defined in RFC 3030. @@ -290,7 +310,6 @@ Chunking is defined in RFC 3030. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,13 +319,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,6 +337,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -325,7 +349,6 @@ 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 Required: False Position: Named @@ -335,6 +358,9 @@ Accept wildcard characters: False ``` ### -ConnectionInactivityTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectionInactivityTimeout parameter specifies the maximum amount of idle time before a connection to the Receive connector is closed. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -349,7 +375,6 @@ The value of this parameter must be less than the value of the ConnectionTimeout Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -359,6 +384,9 @@ Accept wildcard characters: False ``` ### -ConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectionTimeout parameter specifies the maximum time that the connection to the Receive connector can remain open, even if the connection is actively transmitting data. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -373,7 +401,6 @@ The value of this parameter must be greater than the value of the ConnectionInac Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -383,6 +410,9 @@ Accept wildcard characters: False ``` ### -DefaultDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DefaultDomain parameter specifies the default accepted domain to use for the Exchange organization. You can use any value that uniquely identifies the accepted domain. For example: - Name @@ -399,7 +429,6 @@ Although you can configure any accepted domain as the default domain, you typica Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -409,9 +438,12 @@ Accept wildcard characters: False ``` ### -DeliveryStatusNotificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeliveryStatusNotificationEnabled parameter specifies whether the DSN (delivery status notification) Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: DSN is enabled and is advertised in the EHLO response. This is the default value. +- $true: DSN is enabled and is advertised in the EHLO response. This value is the default. - $false: DSN is disabled and isn't advertised in the EHLO response. Delivery status notifications are defined in RFC 3461. @@ -420,7 +452,6 @@ Delivery status notifications are defined in RFC 3461. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -430,6 +461,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -438,7 +472,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -448,12 +481,15 @@ Accept wildcard characters: False ``` ### -DomainSecureEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainSecureEnabled parameter specifies whether to enable or disable mutual Transport Layer Security (TLS) authentication (also known as Domain Secure) for the domains that are serviced by the Receive connector. Valid values are: - $true: Mutual TLS authentication is enabled. - $false: Mutual TLS authentication is disabled. -Note that setting this parameter to the value $true is only part of the requirements for enabling mutual TLS authentication: +Setting this parameter to the value $true is only part of the requirements for enabling mutual TLS authentication: - The AuthMechanism parameter must contain the value Tls, and can't contain the value ExternalAuthoritative. - The domain that's used for mutual TLS authentication must be configured in the following locations: @@ -465,7 +501,6 @@ Note that setting this parameter to the value $true is only part of the requirem Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -475,9 +510,12 @@ Accept wildcard characters: False ``` ### -EightBitMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EightBitMimeEnabled parameter specifies whether the 8BITMIME Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: 8BITMIME is enabled and is advertised in the EHLO response. This is the default value. +- $true: 8BITMIME is enabled and is advertised in the EHLO response. This value is the default. - $false: 8BITMIME is disabled and isn't advertised in the EHLO response. 8-bit data transmission is defined in RFC 6152. @@ -486,7 +524,6 @@ The EightBitMimeEnabled parameter specifies whether the 8BITMIME Extended SMTP e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -496,6 +533,9 @@ Accept wildcard characters: False ``` ### -EnableAuthGSSAPI + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnableAuthGSSAPI parameter enables or disables Kerberos when Integrated Windows authentication is available on the Receive connector (the AuthMechanism parameter contains the value Integrated). Valid values are: - $true: Kerberos is enabled. The Extended SMTP keyword AUTH GSSAPI NTLM is advertised in the EHLO response. Clients can use Kerberos or NTLM for Integrated Windows authentication. @@ -507,7 +547,6 @@ The Generic Security Services application programming interface (GSSAPI) is an I Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -517,16 +556,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether to enable or disable the Receive connector. Valid values are: -- $true: The Receive connector is enabled. This is the default value. +- $true: The Receive connector is enabled. This value is the default. - $false: The Receive connector is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -536,9 +577,12 @@ Accept wildcard characters: False ``` ### -EnhancedStatusCodesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnhancedStatusCodesEnabled parameter specifies whether the ENHANCEDSTATUSCODES Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: ENHANCEDSTATUSCODES is enabled and is advertised in the EHLO response. This is the default value. +- $true: ENHANCEDSTATUSCODES is enabled and is advertised in the EHLO response. This value is the default. - $false: ENHANCEDSTATUSCODES is disabled and isn't advertised in the EHLO response. Enhanced status codes are defined in RFC 2034. @@ -547,7 +591,6 @@ Enhanced status codes are defined in RFC 2034. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -557,11 +600,14 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionPolicy parameter specifies how you want to use Extended Protection for Authentication on the Receive connector.Valid values are: -- None: Extended Protection for Authentication won't be used. This is the default value. -- Allow: Extended Protection for Authentication will be used only if the connecting host supports it. Otherwise, the connections will be established without Extended Protection for Authentication. -- Require: Extended Protection for Authentication will be required for all incoming connections to this Receive connector. If the connecting host doesn't support Extended Protection for Authentication, the connection will be rejected. +- None: Extended Protection for Authentication aren't used. This value is the default. +- Allow: Extended Protection for Authentication are used only if the connecting host supports it. Otherwise, the connections are established without Extended Protection for Authentication. +- Require: Extended Protection for Authentication is required for all incoming connections to this Receive connector. If the connecting host doesn't support Extended Protection for Authentication, the connection is rejected. Extended Protection for Authentication enhances the protection and handling of credentials when authenticating network connections using Integrated Windows authentication. Integrated Windows authentication is also known as NTLM. We strongly recommend that you use Extended Protection for Authentication if you are using Integrated Windows authentication. @@ -569,7 +615,6 @@ Extended Protection for Authentication enhances the protection and handling of c Type: ExtendedProtectionPolicySetting Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -579,6 +624,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Fqdn parameter specifies the destination FQDN that's shown to connected messaging servers. This value is used in the following locations: - In the default SMTP banner of the Receive connector @@ -594,7 +642,6 @@ Don't modify this value on the default Receive connector named `Default Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LongAddressesEnabled parameter specifies whether the Receive connector accepts long X.400 email addresses. The X.400 email addresses are encapsulated in SMTP email addresses by using the Internet Mail Connector Encapsulated Address (IMCEA) encapsulation method. Valid values are: - $true: X.400 email addresses can be up to 1,860 characters long after IMCEA encapsulation. -- $false: The maximum length of a complete SMTP email address is 571 characters. This is the default value. +- $false: The maximum length of a complete SMTP email address is 571 characters. This value is the default. When you set this parameter to the value $true the following changes are made to the Receive connector: @@ -621,7 +671,6 @@ You can only configure this parameter on Receive connectors in the Transport ser Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -631,9 +680,12 @@ Accept wildcard characters: False ``` ### -MaxAcknowledgementDelay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. -The MaxAcknowledgementDelay parameter specifies the period the transport server delays acknowledgement when receiving messages from a host that doesn't support shadow redundancy. When receiving messages from a host that doesn't support shadow redundancy, a Microsoft Exchange Server 2010 transport server delays issuing an acknowledgement until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server times out and issues an acknowledgement anyway. The default value is 30 seconds. +The MaxAcknowledgementDelay parameter specifies the period the transport server delays acknowledgement when receiving messages from a host that doesn't support shadow redundancy. When receiving messages from a host that doesn't support shadow redundancy, a Microsoft Exchange Server 2010 transport server delays issuing an acknowledgement until it verifies that the message is successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server times out and issues an acknowledgement anyway. The default value is 30 seconds. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -641,7 +693,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -651,6 +702,9 @@ Accept wildcard characters: False ``` ### -MaxHeaderSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxHeaderSize parameter specifies the maximum size of the SMTP message header before the Receive connector closes the connection. The default value is 256 kilobytes (262144 bytes). When you enter a value, qualify the value with one of the following units: @@ -660,7 +714,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is from 1 to 2147483647 bytes. @@ -668,7 +722,6 @@ A valid value is from 1 to 2147483647 bytes. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -678,6 +731,9 @@ Accept wildcard characters: False ``` ### -MaxHopCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxHopCount parameter specifies the maximum number of hops that a message can take before the message is rejected by the Receive connector. The maximum number of hops is determined by the number of Received header fields that exist in a submitted message. A valid value is from 1 to 500. The default value is 30. @@ -686,7 +742,6 @@ A valid value is from 1 to 500. The default value is 30. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -696,6 +751,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxInboundConnection parameter specifies the maximum number of inbound connections that this Receive connector serves at the same time. A valid value is from 1 to 2147483647, or the value unlimited. The default value is 5000. @@ -706,7 +764,6 @@ To disable the inbound connection limit on a Receive connector, enter a value of Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -716,6 +773,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnectionPercentagePerSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxInboundConnectionPercentagePerSource parameter specifies the maximum number of connections that a Receive connector serves at the same time from a single IP address, expressed as the percentage of available remaining connections on a Receive connector. A valid value is from 1 to 100 without the percent sign (%). The default value is 2 percent. @@ -724,7 +784,6 @@ A valid value is from 1 to 100 without the percent sign (%). The default value i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -734,6 +793,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnectionPerSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxInboundConnectionPerSource parameter specifies the maximum number of connections that this Receive connector serves at the same time from a single IP address. A valid value is from 1 to 10000, or the value unlimited. The default value is 20. @@ -744,7 +806,6 @@ To disable the inbound connection per source limit on a Receive connector, enter Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -754,6 +815,9 @@ Accept wildcard characters: False ``` ### -MaxLocalHopCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxLocalHopCount parameter specifies the maximum number of local hops that a message can take before the message is rejected by the Receive connector. The maximum number of local hops is determined by the number of Received headers with local server addresses in a submitted message. A valid value is from 0 to 50. The default value is 8. @@ -764,7 +828,6 @@ When you specify the value 0, the message is never rejected based on the number Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -774,6 +837,9 @@ Accept wildcard characters: False ``` ### -MaxLogonFailures + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxLogonFailures parameter specifies the number of logon failures that the Receive connector retries before it closes the connection. A valid value is from 0 to 10. The default value is 3. @@ -784,7 +850,6 @@ When you specify the value 0, the connection is never closed because of logon fa Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -794,6 +859,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxMessageSize parameter specifies the maximum size of a message that's allowed through the Receive connector. The default value is 36 MB, which results in a realistic maximum message size of 25 MB. When you enter a value, qualify the value with one of the following units: @@ -804,7 +872,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value for this parameter is from 65536 to 2147483647 bytes. @@ -814,7 +882,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -824,6 +891,9 @@ Accept wildcard characters: False ``` ### -MaxProtocolErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxProtocolErrors parameter specifies the maximum number of SMTP protocol errors that the Receive connector accepts before closing the connection. A valid value is from 0 to 2147483647, or the value unlimited. The default value is 5. @@ -834,7 +904,6 @@ When you specify the value unlimited, a connection is never closed because of pr Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -844,6 +913,9 @@ Accept wildcard characters: False ``` ### -MaxRecipientsPerMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxRecipientsPerMessage parameter specifies the maximum number of recipients per message that the Receive connector accepts before closing the connection. A valid value is from 1 to 512000. The default value is 200. @@ -852,7 +924,6 @@ A valid value is from 1 to 512000. The default value is 200. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -862,6 +933,9 @@ Accept wildcard characters: False ``` ### -MessageRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageRateLimit parameter specifies the maximum number of messages that can be sent by a single client IP address per minute. A valid value is from 1 to 2147483647, or the value unlimited. @@ -874,7 +948,6 @@ The default value for Receive connectors on Mailbox servers is unlimited. The de Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -884,6 +957,9 @@ Accept wildcard characters: False ``` ### -MessageRateSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageRateSource parameter specifies how the message submission rate is calculated. Valid values are: - None: No message submission rate is calculated. @@ -895,7 +971,6 @@ The MessageRateSource parameter specifies how the message submission rate is cal Type: MessageRateSourceFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -905,13 +980,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name for the Receive connector. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -921,10 +998,13 @@ Accept wildcard characters: False ``` ### -OrarEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OrarEnabled parameter enables or disables Originator Requested Alternate Recipient (ORAR) on the Receive connector. Valid values are: - $true: ORAR is enabled and is advertised in the XORAR keyword in the EHLO response. The actual ORAR information is transmitted in the RCPT TO SMTP command. -- $false: ORAR is disabled and is isn't advertised in the EHLO response. This is the default value. +- $false: ORAR is disabled and is isn't advertised in the EHLO response. This value is the default. If the email address specified in the ORAR information is a long X.400 email address, you need to set the LongAddressesEnabled parameter to the value $true. @@ -932,7 +1012,6 @@ If the email address specified in the ORAR information is a long X.400 email add Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -942,6 +1021,9 @@ Accept wildcard characters: False ``` ### -PermissionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PermissionGroups parameter specifies the well-known security principals who are authorized to use the Receive connector and the permissions that are assigned to them. Valid values are: - None @@ -962,7 +1044,6 @@ For more information about the default permissions and security principals for p Type: PermissionGroups Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -972,9 +1053,12 @@ Accept wildcard characters: False ``` ### -PipeliningEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PipeliningEnabled parameter specifies whether the PIPELINING Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: -- $true: PIPELINING is enabled and is advertised in the EHLO response. This is the default value. +- $true: PIPELINING is enabled and is advertised in the EHLO response. This value is the default. - $false: PIPELINING is disabled and isn't advertised in the EHLO response. Pipelining is defined in RFC 2920. @@ -983,7 +1067,6 @@ Pipelining is defined in RFC 2920. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -993,9 +1076,12 @@ Accept wildcard characters: False ``` ### -ProtocolLoggingLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProtocolLoggingLevel parameter specifies whether to enable or disable protocol logging for the Receive connector. Valid values are: -- None: Protocol logging is disabled on the Receive connector. This is the default value. +- None: Protocol logging is disabled on the Receive connector. This value is the default. - Verbose: Protocol logging is enabled on the Receive connector. For more information about protocol logging, see [Protocol logging](https://learn.microsoft.com/Exchange/mail-flow/connectors/protocol-logging). @@ -1004,7 +1090,6 @@ For more information about protocol logging, see [Protocol logging](https://lear Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1014,16 +1099,18 @@ Accept wildcard characters: False ``` ### -RejectReservedSecondLevelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectReservedSecondLevelRecipientDomains parameter specifies whether to reject connections that contain recipients in reserved second-level domains as specified in RFC 2606 (example.com, example.net, or example.org). Valid value are: - $true: RCPT TO commands that contain reserved second-level domains are rejected. -- $false: RCPT TO commands that contain reserved second-level domains aren't rejected. This is the default value. +- $false: RCPT TO commands that contain reserved second-level domains aren't rejected. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1033,16 +1120,18 @@ Accept wildcard characters: False ``` ### -RejectReservedTopLevelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectReservedTopLevelRecipientDomains parameter specifies whether to reject connections that contain recipients in reserved top-level domains (TLDs) as specified in RFC 2606 (.test, .example, .invalid, or .localhost). Valid value are: - $true: RCPT TO commands that contain reserved TLDs are rejected. -- $false: RCPT TO commands that contain reserved TLDs aren't rejected. This is the default value. +- $false: RCPT TO commands that contain reserved TLDs aren't rejected. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1052,16 +1141,18 @@ Accept wildcard characters: False ``` ### -RejectSingleLabelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectSingleLabelRecipientDomains parameter specifies whether to reject connections that contain recipients in single-label domains (for example, chris@contoso instead of chris@contoso.com). Valid values are: - $true: RCPT TO commands that contain single-label domains are rejected. -- $false: RCPT TO commands that contain single-label domains aren't rejected. This is the default value. +- $false: RCPT TO commands that contain single-label domains aren't rejected. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1071,6 +1162,9 @@ Accept wildcard characters: False ``` ### -RemoteIPRanges + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoteIPRanges parameter specifies the remote IP addresses that the Receive connector accepts messages from. Valid values are: - Single IP address: For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11. @@ -1091,7 +1185,6 @@ When remote IP address ranges overlap, the Receive connector with the most speci Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1101,16 +1194,18 @@ Accept wildcard characters: False ``` ### -RequireEHLODomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireEHLODomain parameter specifies whether the client must provide a domain name in the EHLO handshake after the SMTP connection is established. Valid values are: - $true: The client must provide a domain name in the EHLO handshake. If it doesn't, the SMTP connection is closed. -- $false: The client isn't required to provide a domain name in the EHLO handshake. This is the default value. +- $false: The client isn't required to provide a domain name in the EHLO handshake. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1120,16 +1215,18 @@ Accept wildcard characters: False ``` ### -RequireTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireTLS parameter specifies whether to require TLS transmission for inbound messages on the Receive connector. Valid values are: - $true: Inbound messages on the Receive connector require TLS transmission. -- $false: Inbound messages on the Receive connector don't require TLS transmission. This is the default value. +- $false: Inbound messages on the Receive connector don't require TLS transmission. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1139,13 +1236,15 @@ Accept wildcard characters: False ``` ### -ServiceDiscoveryFqdn + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ServiceDiscoveryFqdn parameter specifies the service discovery fully-qualified domain name (FQDN). for the Receive connector. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1155,9 +1254,12 @@ Accept wildcard characters: False ``` ### -SizeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SizeEnabled parameter specifies how the SIZE Extended SMTP extension is used on the Receive connector. Valid values are: -- Enabled: SIZE is enabled and is advertised in the EHLO response along with the value of the MaxMessageSize parameter. If the size of the inbound message exceeds the specified value, the Receive connector closes the connection with an error code. This is the default value. +- Enabled: SIZE is enabled and is advertised in the EHLO response along with the value of the MaxMessageSize parameter. If the size of the inbound message exceeds the specified value, the Receive connector closes the connection with an error code. This value is the default. - Disabled: SIZE is disabled and isn't advertised in the EHLO response. - EnabledwithoutValue: SIZE is enabled and is advertised in the EHLO response, but the value of the MaxMessageSize parameter isn't disclosed in the EHLO response. This setting allows messages to bypass message size checks for authenticated connections between Mailbox servers. @@ -1167,7 +1269,6 @@ SIZE is defined in RFC 1870. Type: SizeMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1177,13 +1278,15 @@ Accept wildcard characters: False ``` ### -SmtpUtf8Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1193,10 +1296,13 @@ Accept wildcard characters: False ``` ### -SuppressXAnonymousTls + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuppressXAnonymousTls parameter specifies whether the X-ANONYMOUSTLS Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: X-ANONYMOUSTLS is disabled and isn't advertised in the EHLO response. This setting also requires that you set the UseDownGradedExchangeServerAuth parameter to the value $true on the Set-TransportService cmdlet on the server. -- $false: X-ANONYMOUSTLS is enabled and is advertised in the EHLO response. This is the default value. +- $false: X-ANONYMOUSTLS is enabled and is advertised in the EHLO response. This value is the default. The X-ANONYMOUSTLS extension is important when the AuthMechanism parameter contains the value ExchangeServer. @@ -1204,7 +1310,6 @@ The X-ANONYMOUSTLS extension is important when the AuthMechanism parameter conta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1214,7 +1319,10 @@ Accept wildcard characters: False ``` ### -TarpitInterval -The TarpitInterval parameter specifies the period of time to delay an SMTP response to a remote server that may be abusing the connection. The default value is 00:00:05 (5 seconds). + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The TarpitInterval parameter specifies the period of time to delay an SMTP response to a remote server that might be abusing the connection. The default value is 00:00:05 (5 seconds). To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1226,7 +1334,6 @@ You can configure the delay for authentication failure responses by using the Au Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1236,13 +1343,15 @@ Accept wildcard characters: False ``` ### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"` and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1252,6 +1361,9 @@ Accept wildcard characters: False ``` ### -TlsDomainCapabilities + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TlsDomainCapabilities parameter specifies the capabilities that the Receive connector makes available to specific hosts outside of the organization. Remote hosts are authenticated with TLS with certificate validation before these capabilities are offered. This parameter uses the following syntax: @@ -1273,7 +1385,6 @@ For example, `"contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptCloudServices Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1283,6 +1394,9 @@ Accept wildcard characters: False ``` ### -TransportRole + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportRole parameter specifies the transport service on the Mailbox server where the Receive connector is created. Valid values are: - FrontendTransport: The Front End Transport service where client or external SMTP connections occur. @@ -1294,7 +1408,6 @@ You can't use this parameter on Edge Transport servers. Type: ServerRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1304,13 +1417,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-RecipientFilterConfig.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RecipientFilterConfig.md index d1543894e3..04a2802d81 100644 --- a/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RecipientFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-recipientfilterconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-RecipientFilterConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-recipientfilterconfig +schema: 2.0.0 +title: Set-RecipientFilterConfig --- # Set-RecipientFilterConfig @@ -34,7 +35,7 @@ Set-RecipientFilterConfig [-BlockedRecipients ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,13 +59,15 @@ This example makes the following changes to the Recipient Filter agent configura ## PARAMETERS ### -BlockedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BlockedRecipients parameter specifies one or more SMTP addresses. To enter multiple SMTP addresses, separate the addresses by using a comma. The maximum number of individual SMTP addresses that you can input is 800. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -BlockListEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BlockListEnabled parameter specifies whether the Recipient Filter agent blocks messages sent to recipients listed in the BlockedRecipients parameter. Valid input for the BlockListEnabled parameter is $true or $false. The default setting is $false. When the BlockListEnabled parameter is set to $true, the Recipient Filter agent blocks messages sent to recipients listed in the BlockedRecipients parameter. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -99,7 +107,6 @@ 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 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -117,7 +127,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the Recipient Filter agent is enabled 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. When the Enabled parameter is set to $true, the Recipient Filter agent is enabled on the computer on which you're running the command. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalMailEnabled parameter specifies whether all messages received from unauthenticated connections by servers external to your organization are passed through the Recipient 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 received from unauthenticated connections by servers external to your organization are passed through the Recipient Filter agent for processing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,13 +172,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalMailEnabled parameter specifies whether all messages from authenticated sender domains that belong to authoritative domains in the enterprise are passed through the Recipient 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 sender domains that belong to authoritative domains in the enterprise are passed through the Recipient Filter agent for processing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,13 +190,15 @@ Accept wildcard characters: False ``` ### -RecipientValidationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecipientValidationEnabled parameter specifies whether the Recipient Filter agent blocks messages addressed to recipients that don't exist in the organization. Valid input for the RecipientValidationEnabled parameter is $true or $false. The default setting is $false. When the RecipientValidationEnabled parameter is set to $true, the Recipient Filter agent blocks messages addressed to recipients that don't exist in the organization. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +208,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-RecordReviewNotificationTemplateConfig.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RecordReviewNotificationTemplateConfig.md index b3552f8231..fedde7df9c 100644 --- a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RecordReviewNotificationTemplateConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-recordreviewnotificationtemplateconfig applicable: Security & Compliance -title: Set-RecordReviewNotificationTemplateConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-recordreviewnotificationtemplateconfig +schema: 2.0.0 +title: Set-RecordReviewNotificationTemplateConfig --- # Set-RecordReviewNotificationTemplateConfig @@ -42,16 +43,18 @@ This example configures customized review notification text and review reminder ## PARAMETERS ### -IsCustomizedNotificationTemplate + +> Applicable: Security & Compliance + The IsCustomizedNotificationTemplate switch specifies whether to use a customized review notification instead of the system default notification. Valid values are: - $true: Use a customized review notification. You specify the notification text using the CustomizedNotificationDataString parameter. -- $false: Use the default system notification. This is the default value. +- $false: Use the default system notification. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -61,16 +64,18 @@ Accept wildcard characters: False ``` ### -IsCustomizedReminderTemplate + +> Applicable: Security & Compliance + The IsCustomizedReminderTemplate switch specifies whether to use a customized review reminder instead of the system default reminder: - $true: Use a customized review reminder. You specify the reminder text using the CustomizedReminderDataString parameter. -- $false: Use the default system reminder. This is the default value. +- $false: Use the default system reminder. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -CustomizedNotificationDataString + +> Applicable: Security & Compliance + The CustomizedNotificationDataString parameter specifies the customized review notification text to use. If the value contains spaces, enclose the value in quotation marks ("). The value of this parameter is meaningful only when the value of the IsCustomizedNotificationTemplate parameter is $true. @@ -88,7 +96,6 @@ The value of this parameter is meaningful only when the value of the IsCustomize Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -CustomizedReminderDataString + +> Applicable: Security & Compliance + The CustomizedReminderDataString parameter specifies the customized review reminder text to use. If the value contains spaces, enclose the value in quotation marks ("). The value of this parameter is meaningful only when the value of the IsCustomizedReminderTemplate parameter is $true. @@ -106,7 +116,6 @@ The value of this parameter is meaningful only when the value of the IsCustomize Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RegulatoryComplianceUI.md b/exchange/exchange-ps/ExchangePowerShell/Set-RegulatoryComplianceUI.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-RegulatoryComplianceUI.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RegulatoryComplianceUI.md index 8f4caf3d77..1450683bf3 100644 --- a/exchange/exchange-ps/exchange/Set-RegulatoryComplianceUI.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RegulatoryComplianceUI.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-regulatorycomplianceui applicable: Security & Compliance -title: Set-RegulatoryComplianceUI +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-regulatorycomplianceui schema: 2.0.0 +title: Set-RegulatoryComplianceUI --- # Set-RegulatoryComplianceUI @@ -38,17 +40,19 @@ This example displays the UI option in retention label settings to mark content ## PARAMETERS ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether to show or hide the UI option in retention label settings to mark content as a regulatory record. Valid values are: $true: The option to mark content as a regulatory record is visible in the UI for retention label settings. -$false: The option to mark content as a regulatory record is not visible in the UI for retention label settings. This is the default value. +$false: The option to mark content as a regulatory record is not visible in the UI for retention label settings. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RemoteDomain.md b/exchange/exchange-ps/ExchangePowerShell/Set-RemoteDomain.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-RemoteDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RemoteDomain.md index 8f7c3965a5..2dff3a4d90 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RemoteDomain.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-remotedomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-RemoteDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-remotedomain +schema: 2.0.0 +title: Set-RemoteDomain --- # Set-RemoteDomain ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-RemoteDomain cmdlet to configure a managed connection for a remote domain. @@ -56,7 +57,7 @@ Set-RemoteDomain [-Identity] ## DESCRIPTION When you set a remote domain, you can control mail flow with more precision, specify message formatting and policy and specify acceptable character sets for messages sent to or received from the remote domain. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,6 +82,9 @@ This example queries Active Directory for all remote domains for which auto repl ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the remote domain that you want to modify. You can use any value that uniquely identifies the remote domain. For example: - Name @@ -91,7 +95,6 @@ The Identity parameter specifies the remote domain that you want to modify. You Type: RemoteDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -101,9 +104,12 @@ Accept wildcard characters: False ``` ### -AllowedOOFType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AllowedOOFType parameter specifies the type of automatic replies or out-of-office (also known as OOF) notifications than can be sent to recipients in the remote domain. Valid values are: -- External: Only automatic replies that are designated as external are sent to recipients in the remote domain. This is the default value. +- External: Only automatic replies that are designated as external are sent to recipients in the remote domain. This value is the default. - ExternalLegacy: Only external automatic replies or automatic replies that aren't designated as internal or external are sent to recipients in the remote domain. - InternalLegacy: Only internal automatic replies or automatic replies that aren't designated as internal or external are sent to recipients in the remote domain. - None: No automatic replies are sent to recipients in the remote domain. @@ -117,7 +123,6 @@ The value of this parameter is affected by the value of the IsInternal parameter Type: AllowedOOFType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,16 +132,18 @@ Accept wildcard characters: False ``` ### -AutoForwardEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AutoForwardEnabled parameter specifies whether to allow messages that are auto-forwarded by client email programs in your organization. Valid values are: -- $true: Auto-forwarded messages are delivered to recipients in the remote domain. This is the default value for new remote domains that you create and the built-in remote domain named Default in Exchange Online. -- $false: Auto-forwarded messages aren't delivered to recipients in the remote domain. This is the default value for the built-in remote domain named Default in on-premises Exchange. +- $true: Auto-forwarded messages are delivered to recipients in the remote domain. This value is the default for new remote domains that you create and the built-in remote domain named Default in Exchange Online. +- $false: Auto-forwarded messages aren't delivered to recipients in the remote domain. This value is the default for the built-in remote domain named Default in on-premises Exchange. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,16 +153,18 @@ Accept wildcard characters: False ``` ### -AutoReplyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AutoReplyEnabled parameter specifies whether to allow messages that are automatic replies from client email programs in your organization (for example, automatic reply messages that are generated by rules in Outlook). Valid values are: -- $true: Automatic replies are delivered to recipients in the remote domain. This is the default value for new remote domains that you create and the built-in remote domain named Default in Exchange Online. -- $false: Automatic replies aren't delivered to recipients in the remote domain. This is the default value for the built-in remote domain named Default in on-premises Exchange. +- $true: Automatic replies are delivered to recipients in the remote domain. This value is the default for new remote domains that you create and the built-in remote domain named Default in Exchange Online. +- $false: Automatic replies aren't delivered to recipients in the remote domain. This value is the default for the built-in remote domain named Default in on-premises Exchange. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,6 +174,9 @@ Accept wildcard characters: False ``` ### -ByteEncoderTypeFor7BitCharsets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ByteEncoderTypeFor7BitCharsets parameter specifies the 7-bit transfer encoding method for MIME format for messages sent to this remote domain. Valid values are: - Use7Bit: Always use default 7-bit transfer encoding for HTML and plain text. @@ -174,13 +186,12 @@ The ByteEncoderTypeFor7BitCharsets parameter specifies the 7-bit transfer encodi - UseBase64HtmlDetectTextPlain: Use Base64 encoding for HTML and for plain text, unless line wrapping is enabled in plain text. If line wrapping is enabled in plain text, use Base64 encoding for HTML, and use 7-bit encoding for plain text. - UseQPHtml7BitTextPlain: Always use QP encoding for HTML. Always use 7-bit encoding for plain text. - UseBase64Html7BitTextPlain: Always use Base64 encoding for HTML. Always use 7-bit encoding for plain text. -- Undefined: Always use QP encoding for HTML and plain text. This is the default value. +- Undefined: Always use QP encoding for HTML and plain text. This value is the default. ```yaml Type: ByteEncoderTypeFor7BitCharsetsEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -190,6 +201,9 @@ Accept wildcard characters: False ``` ### -CharacterSet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CharacterSet parameter specifies a character set for MIME messages without defined character sets that are sent from your organization to recipients in the remote domain. Valid values are: big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874, or the value $null. @@ -202,7 +216,6 @@ This setting doesn't overwrite character sets that are already specified in outb Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -221,7 +237,6 @@ 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 Required: False Position: Named @@ -231,9 +246,12 @@ Accept wildcard characters: False ``` ### -ContentType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ContentType parameter specifies the outbound message content type and formatting. Valid values are: -- MimeHtmlText: Converts messages to MIME messages that use HTML formatting, unless the original message is a text message. If the original message is a text message, the outbound message is a MIME message that uses text formatting. This is the default value. +- MimeHtmlText: Converts messages to MIME messages that use HTML formatting, unless the original message is a text message. If the original message is a text message, the outbound message is a MIME message that uses text formatting. This value is the default. - MimeText: Converts all messages to MIME messages that use text formatting. - MimeHtml: Converts all messages to MIME messages that use HTML formatting. @@ -241,7 +259,6 @@ The ContentType parameter specifies the outbound message content type and format Type: ContentType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -251,16 +268,18 @@ Accept wildcard characters: False ``` ### -DeliveryReportEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DeliveryReportEnabled parameter specifies whether to allow delivery reports from client software in your organization to recipients in the remote domain. Valid values are: -- $true: Delivery reports are delivered to recipients in the remote domain. This is the default value. +- $true: Delivery reports are delivered to recipients in the remote domain. This value is the default. - $false: Delivery reports aren't delivered to recipients in the remote domain. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -270,18 +289,20 @@ Accept wildcard characters: False ``` ### -DisplaySenderName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: You should only modify this parameter under the direction of Microsoft Customer Service and Support. The DisplaySenderName parameter specifies whether to show the sender's Display Name in the From email address for messages sent to recipients in the remote domain. Valid values are: -- $true: Sender names are displayed in messages sent to recipients in the remote domain. This is the default value. +- $true: Sender names are displayed in messages sent to recipients in the remote domain. This value is the default. - $false. Sender names aren't displayed in messages sent to recipients in the remote domain. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -291,6 +312,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -301,7 +325,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -311,18 +334,20 @@ Accept wildcard characters: False ``` ### -IsCoexistenceDomain + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IsCoexistenceDomain parameter specifies whether this remote domain is used to represent your Exchange Online organization. Valid values are: - $true: The remote domain represents your Exchange Online organization. -- $false: The remote domain doesn't represent your Exchange Online organization. This is the default value. +- $false: The remote domain doesn't represent your Exchange Online organization. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -332,10 +357,13 @@ Accept wildcard characters: False ``` ### -IsInternal + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsInternal parameter specifies whether the recipients in the remote domain are considered to be internal recipients. Valid values are: - $true: All transport components (for example, transport rules) treat recipients in the remote domain as internal recipients. Typically, you use this value in cross-forest deployments. -- $false: Recipients in the remote domain are treated as external recipients. This is the default value. +- $false: Recipients in the remote domain are treated as external recipients. This value is the default. The value of this parameter is affected by the value of the AllowedOOFType parameter, and vice-versa: @@ -346,7 +374,6 @@ The value of this parameter is affected by the value of the AllowedOOFType param Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -356,13 +383,15 @@ Accept wildcard characters: False ``` ### -LineWrapSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LineWrapSize parameter specifies the line-wrap size for messages to recipients in the remote domain. Valid values are an integer from 0 through 132 or the value to unlimited. The default value is unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -372,16 +401,18 @@ Accept wildcard characters: False ``` ### -MeetingForwardNotificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MeetingForwardNotificationEnabled parameter specifies whether to enable meeting forward notifications for recipients in the remote domain. Valid values are: -- $true: Meeting requests forwarded to recipients in the remote domain generate a meeting forward notification to the meeting organizer. This is the default value. +- $true: Meeting requests forwarded to recipients in the remote domain generate a meeting forward notification to the meeting organizer. This value is the default. - $false: Meeting requests forwarded to recipients in the remote domain don't generate a meeting forward notification to the meeting organizer. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -391,6 +422,9 @@ Accept wildcard characters: False ``` ### -MessageCountThreshold + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MessageCountThreshold parameter specifies the acceptable message count for the remote domain. If the message count exceeds this value, an event is generated that's visible using the Get-ServerHealth and Get-HealthReport cmdlets. @@ -401,7 +435,6 @@ Valid input for this parameter is an integer. The default value is Int32 (214748 Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -411,13 +444,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a unique name for the remote domain object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -427,11 +462,14 @@ Accept wildcard characters: False ``` ### -NDRDiagnosticInfoEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The NDRDiagnosticInfoEnabled parameter specifies whether diagnostic information is included in non-delivery reports (also known NDRs or bounce messages) that are sent to recipients the remote domain. Valid values are: -- $true: The diagnostic information of an NDR includes details that help administrators troubleshoot delivery problems. This detailed information includes internal server names. This is the default value. +- $true: The diagnostic information of an NDR includes details that help administrators troubleshoot delivery problems. This detailed information includes internal server names. This value is the default. - $false: The diagnostic information section in the NDR body as well as internal server headers from the attached original message headers are removed from the NDR. This parameter is meaningful only when the value of the NDREnabled parameter is $true. @@ -440,7 +478,6 @@ This parameter is meaningful only when the value of the NDREnabled parameter is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -450,16 +487,18 @@ Accept wildcard characters: False ``` ### -NDREnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NDREnabled parameter specifies whether to allow non-delivery reports (also known NDRs or bounce messages) from your organization to recipients in the remote domain. Valid values are: -- $true: NDRs from your organization are sent to recipients in the remote domain. This is the default value. +- $true: NDRs from your organization are sent to recipients in the remote domain. This value is the default. - $false: NDRs from your organization aren't sent to recipients in the remote domain. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -469,6 +508,9 @@ Accept wildcard characters: False ``` ### -NonMimeCharacterSet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NonMimeCharacterSet parameter specifies a character set for plain text messages without defined character sets that are sent from your organization to recipients in the remote domain. Valid values are: big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874, or the value $null. @@ -481,7 +523,6 @@ This setting doesn't overwrite character sets that are already specified in outb Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -491,18 +532,20 @@ Accept wildcard characters: False ``` ### -PreferredInternetCodePageForShiftJis + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PreferredInternetCodePageForShiftJis parameter specifies the specific code page to use for Shift JIS character encoding in messages that are sent to recipients in the remote domain. Valid values are: - 50220: Use ISO-2022-JP codepage. - 50221: Use ESC-2022-JP codepage. - 50222: Use SIO-2022-JP codepage. -- Undefined: No codepage is defined. This is the default value. +- Undefined: No codepage is defined. This value is the default. ```yaml Type: PreferredInternetCodePageForShiftJisEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -512,9 +555,12 @@ Accept wildcard characters: False ``` ### -RequiredCharsetCoverage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RequiredCharsetCoverage parameter specifies a percentage threshold for characters in a message that must match to apply your organization's preferred character set before switching to automatic character set detection. -For example, if you set this parameter to 60, the preferred character sets will still be used during content conversion for messages that contain characters from non-preferred character sets as long as the percentage of those characters is 40 percent or less. If the percentage of characters in a message doesn't belong to preferred character sets, Exchange analyzes the Unicode characters and automatically determines the best matching character set to use. +For example, if you set this parameter to 60, the preferred character sets are still used during content conversion for messages that contain characters from non-preferred character sets as long as the percentage of those characters is 40 percent or less. If the percentage of characters in a message doesn't belong to preferred character sets, Exchange analyzes the Unicode characters and automatically determines the best matching character set to use. If recipients in the remote domain use characters that span character sets, you might want to specify a lower percentage to ensure that your organization's preferred character set is used during content conversion. @@ -522,7 +568,6 @@ If recipients in the remote domain use characters that span character sets, you Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -532,6 +577,9 @@ Accept wildcard characters: False ``` ### -SmtpDaneMandatoryModeEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -540,7 +588,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -550,16 +597,18 @@ Accept wildcard characters: False ``` ### -TargetDeliveryDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetDeliveryDomain parameter specifies whether the remote domain is used in cross-forest deployments to generate target email addresses for new mail users that represent users in the other organization (for example, all mailboxes hosted on Exchange Online are represented as mail users in your on-premises organization). Valid values are: - $true: The remote domain is used for the target email address of mail users that represent the users in the other forest. -- $false: The remote domain isn't used for the target email address of mail users that represent the users in the other forest. This is the default value. +- $false: The remote domain isn't used for the target email address of mail users that represent the users in the other forest. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -569,17 +618,19 @@ Accept wildcard characters: False ``` ### -TNEFEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TNEFEnabled parameter specifies whether Transport Neutral Encapsulation Format (TNEF) message encoding is used on messages sent to the remote domain. Valid values are: - $true: TNEF encoding is used on all messages sent to the remote domain. - $false: TNEF encoding isn't used on any messages sent to the remote domain. -- $null (blank): TNEF encoding isn't specified for the remote domain. This is the default value. TNEF encoding for recipients in the remote domain is controlled by the value of the UseMapiRichTextFormat parameter for any mail user or mail contact objects, the sender's per-recipient settings in Outlook, or the sender's default internet message settings in Outlook +- $null (blank): TNEF encoding isn't specified for the remote domain. This value is the default. TNEF encoding for recipients in the remote domain is controlled by the value of the UseMapiRichTextFormat parameter for any mail user or mail contact objects, the sender's per-recipient settings in Outlook, or the sender's default internet message settings in Outlook ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -589,16 +640,18 @@ Accept wildcard characters: False ``` ### -TrustedMailInboundEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TrustedMailInboundEnabled parameter specifies whether messages from senders in the remote domain are treated as trusted messages. Valid values are: -- $true: Inbound messages from senders in the remote domain are considered safe and will bypass content filtering and recipient filtering. -- $false: Inbound messages from senders in the remote domain won't bypass content filtering and recipient filtering. This is the default value. +- $true: Inbound messages from senders in the remote domain are considered safe and skip content filtering and recipient filtering. +- $false: Inbound messages from senders in the remote domain don't bypass content filtering and recipient filtering. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -608,16 +661,18 @@ Accept wildcard characters: False ``` ### -TrustedMailOutboundEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TrustedMailOutboundEnabled parameter specifies whether messages sent to recipients in the remote domain are treated as trusted messages. Valid values are: -- $true: Outbound messages to recipients in the remote domain are considered safe and will bypass content filtering and recipient filtering. We recommend that you use this value in cross-forest deployments. -- $false: Outbound messages to recipients in the remote domain won't bypass content filtering and recipient filtering. This is the default value. +- $true: Outbound messages to recipients in the remote domain are considered safe and skip content filtering and recipient filtering. We recommend that you use this value in cross-forest deployments. +- $false: Outbound messages to recipients in the remote domain don't bypass content filtering and recipient filtering. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -627,16 +682,18 @@ Accept wildcard characters: False ``` ### -UseSimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The UseSimpleDisplayName parameter specifies whether the sender's simple display name is used for the From email address in messages sent to recipients in the remote domain. Valid values are: - $true: Simple display names are used in messages sent to recipients in the remote domain. If the sender doesn't have a simple display name configured, the From email address is `EmailAddress `. -- $false: Simple display names aren't used in messages sent to recipients in the remote domain. This is the default value. +- $false: Simple display names aren't used in messages sent to recipients in the remote domain. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -646,13 +703,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-RemoteMailbox.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RemoteMailbox.md index 6850e91830..8d10964e6e 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-remotemailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-RemoteMailbox -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-remotemailbox +schema: 2.0.0 +title: Set-RemoteMailbox --- # Set-RemoteMailbox @@ -92,7 +93,7 @@ Some attributes on mailboxes in the service can only be configured by connecting Directory synchronization must be configured correctly for changes made to an on-premises mail user to be applied to a mailbox in the service. Changing the configuration of the mailbox in the service isn't immediate and depends on the directory synchronization schedule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -101,18 +102,21 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-RemoteMailbox -Identity davids -Type Room ``` -This example configures the mailbox in the service that's associated with the specified mail user as a room resource mailbox. This example assumes that directory synchronization has been configured. +This example configures the mailbox in the service that's associated with the specified mail user as a room resource mailbox. This example assumes that directory synchronization is configured. ### Example 2 ```powershell Set-RemoteMailbox -Identity kima -AcceptMessagesOnlyFrom davids,"Executive Team",bill@contoso.com ``` -This example configures delivery restrictions for the mailbox in the service that's associated with the specified mail user. This example assumes that directory synchronization has been configured. +This example configures delivery restrictions for the mailbox in the service that's associated with the specified mail user. This example assumes that directory synchronization is configured. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the remote mailbox (mail user) that you want to modify. You can use any value that uniquely identifies the mail user. For example: - ADObjectID @@ -128,7 +132,6 @@ The Identity parameter specifies the remote mailbox (mail user) that you want to Type: RemoteMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -138,6 +141,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -161,7 +167,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +176,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -194,7 +202,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,6 +211,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -229,7 +239,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,6 +248,9 @@ Accept wildcard characters: False ``` ### -ACLableSyncedObjectEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. - To enable this feature, use this switch without a value. @@ -248,7 +260,6 @@ The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -258,6 +269,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -282,7 +296,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -292,13 +305,15 @@ Accept wildcard characters: False ``` ### -ArchiveGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -308,6 +323,9 @@ Accept wildcard characters: False ``` ### -ArchiveName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). The following default values are used based on the version of Exchange: @@ -322,7 +340,6 @@ In Outlook, the value of this parameter is ignored. The name of the archive mail Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,6 +349,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -353,7 +373,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -363,6 +382,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -372,7 +394,6 @@ 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 Required: False Position: Named @@ -382,13 +403,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -398,13 +421,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -414,13 +439,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -430,13 +457,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -446,13 +475,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -462,13 +493,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -478,13 +511,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -494,13 +529,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -510,13 +547,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -526,13 +565,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -542,13 +583,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -558,13 +601,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -574,13 +619,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -590,13 +637,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -606,13 +655,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -622,13 +673,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisplayName parameter specifies the display name for the mail user. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -638,13 +691,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -654,6 +709,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -681,7 +739,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -691,16 +748,18 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: -- $true: Email address policies are applied to this recipient. This is the default value. +- $true: Email address policies are applied to this recipient. This value is the default. - $false: Email address policies aren't applied to this recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -710,6 +769,9 @@ Accept wildcard characters: False ``` ### -ExchangeGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExchangeGuid parameter specifies the ExchangeGuid property value of the mail user, which should match the ExchangeGuid value of the corresponding cloud mailbox. The ExchangeGuid property is a unique Exchange mailbox identifier, and corresponds to the msExchMailboxGuid attribute in Active Directory. An example value is d5a0bd9b-4e95-49b5-9736-14fde1eec1e3. Although the syntax is the same, this value is different than the GUID property value, which corresponds to the objectGUID attribute in Active Directory. @@ -718,7 +780,6 @@ The ExchangeGuid property is a unique Exchange mailbox identifier, and correspon Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -728,19 +789,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -750,19 +813,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -772,19 +837,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -794,19 +861,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -816,19 +885,21 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. +Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` returns a match if the property _contains_ the specified value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -838,13 +909,15 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013 + The GrantSendOnBehalfTo parameter specifies the DN of recipients that can send messages on behalf of this mail-enabled user. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -854,16 +927,18 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. -- $false: The recipient is visible in address lists. This is the default value. +- $false: The recipient is visible in address lists. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -873,6 +948,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -884,7 +962,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -894,6 +971,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -902,7 +982,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -912,6 +991,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -923,7 +1005,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -933,6 +1014,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -947,7 +1031,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -957,6 +1040,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -976,7 +1062,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -986,10 +1071,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -997,7 +1085,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1007,13 +1094,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name of the mail user. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1023,6 +1112,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the mail user are no longer automatically updated by email address policies. @@ -1033,7 +1125,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1043,6 +1134,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder of the mailbox. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 30 gigabytes (32212254720 bytes). @@ -1055,7 +1149,7 @@ When you enter a number, you can qualify it with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value. @@ -1063,7 +1157,6 @@ The RecoverableItemsQuota value must be greater than or equal to the Recoverable Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1073,6 +1166,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for the mailbox. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 20 gigabytes (21474836480 bytes). @@ -1085,7 +1181,7 @@ When you enter a number, you can qualify it with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value. @@ -1093,7 +1189,6 @@ The RecoverableItemsWarningQuota value must be less than or equal to the Recover Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1103,6 +1198,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1126,7 +1224,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1136,6 +1233,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1159,7 +1259,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1169,6 +1268,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1194,7 +1296,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1204,6 +1305,9 @@ Accept wildcard characters: False ``` ### -RemoteRoutingAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoteRoutingAddress parameter specifies the SMTP address of the mailbox in the service that's associated with this mail user. You shouldn't have to change the remote routing address if the address was automatically configured by Exchange when the mail user and its associated mailbox in the service were created. @@ -1212,7 +1316,6 @@ You shouldn't have to change the remote routing address if the address was autom Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1222,6 +1325,9 @@ Accept wildcard characters: False ``` ### -RemovePicture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemovePicture switch removes the picture from the mail user. You don't need to specify a value with this switch. You can add a picture to a mail user by using the Import-RecipientDataProperty cmdlet. @@ -1230,7 +1336,6 @@ You can add a picture to a mail user by using the Import-RecipientDataProperty c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1240,6 +1345,9 @@ Accept wildcard characters: False ``` ### -RemoveSpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoveSpokenName switch removes the spoken name from the mail user. You don't need to specify a value with this switch. You can add a picture to a mail user by using the Import-RecipientDataProperty cmdlet. @@ -1248,7 +1356,6 @@ You can add a picture to a mail user by using the Import-RecipientDataProperty c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1258,6 +1365,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1269,7 +1379,6 @@ The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1279,16 +1388,18 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResetPasswordOnNextLogon parameter specifies whether the user must change their password the next time they log on. Valid values are: - $true: The user is required to change their password the next time they log on. -- $false: The user isn't required to change their password the next time they log on. This is the default value. +- $false: The user isn't required to change their password the next time they log on. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1298,13 +1409,15 @@ Accept wildcard characters: False ``` ### -SamAccountName -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1314,9 +1427,12 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: -- Always: Notify all senders when their messages aren't approved. This is the default value. +- Always: Notify all senders when their messages aren't approved. This value is the default. - Internal: Notify senders in the organization when their messages aren't approved. - Never: Don't notify anyone when a message isn't approved. @@ -1328,7 +1444,6 @@ The default value is Never. Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1338,6 +1453,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Type parameter specifies the type for the mailbox in the service. Valid values are: - Regular @@ -1355,7 +1473,6 @@ Notes on the value Shared: Type: ConvertibleRemoteMailboxSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1365,13 +1482,15 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1381,13 +1500,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1397,6 +1518,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -1408,7 +1532,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionPolicy.md index ed3adf565b..355d745fa1 100644 --- a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-reportsubmissionpolicy applicable: Exchange Online -title: Set-ReportSubmissionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-reportsubmissionpolicy +schema: 2.0.0 +title: Set-ReportSubmissionPolicy --- # Set-ReportSubmissionPolicy @@ -82,11 +83,11 @@ The report submission rule (the SentTo parameter \*-ReportSubmissionRule cmdlets When you set the email address of the reporting mailbox in the Microsoft Defender portal, the same email address is also set in the following parameters in the \*-ReportSubmissionPolicy cmdlets: - Microsoft integrated reporting using Microsoft reporting tools in Outlook: The ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses parameters. -- Microsoft integrated reporting using third-party tools in Outlook: The ThirdPartyReportAddresses parameter. +- Microsoft integrated reporting using non-Microsoft tools in Outlook: The ThirdPartyReportAddresses parameter. Although it's not absolutely required, it makes sense to keep the email address consistent in the related parameters in the \*-ReportSubmissionPolicy and \*-ReportSubmissionRule cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -145,7 +146,7 @@ Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReport New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub ``` -This example turns on reporting in Outlook, but uses third-party reporting tools in Outlook to send reported messages to the specified reporting mailbox in Exchange Online. +This example turns on reporting in Outlook, but uses non-Microsoft reporting tools in Outlook to send reported messages to the specified reporting mailbox in Exchange Online. The required third command is different based on whether you already have a report submission rule: @@ -159,20 +160,22 @@ Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReport Get-ReportSubmissionRule | Remove-ReportSubmissionRule ``` -This example turns off the Microsoft integrated reporting. Microsoft reporting tools in Outlook are not available to users and messages reported by third-party tools in Outlook are not available on the Submissions page in the Microsoft Defender portal. +This example turns off the Microsoft integrated reporting. Microsoft reporting tools in Outlook are not available to users and messages reported by non-Microsoft tools in Outlook are not available on the Submissions page in the Microsoft Defender portal. If the report submission rule doesn't already exist (the Get-ReportSubmissionRule command returns no output), you don't need to run the second command to remove it. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission policy that you want to modify. The only available policy is named DefaultReportSubmissionPolicy. ```yaml Type: ReportSubmissionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -182,6 +185,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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. @@ -191,7 +197,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -201,10 +206,13 @@ Accept wildcard characters: False ``` ### -DisableQuarantineReportingOption + +> Applicable: Exchange Online + The DisableQuarantineReportingOption parameter allows or prevents users from reporting messages in quarantine. Valid values are: - $true: Users can't report quarantined messages from quarantine. -- $false: Users can report quarantined messages from quarantine. This is the default value. +- $false: Users can report quarantined messages from quarantine. This value is the default. This parameter is meaningful only reporting in Outlook is enabled as described in the EnableReportToMicrosoft parameter. @@ -212,7 +220,6 @@ This parameter is meaningful only reporting in Outlook is enabled as described i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -222,13 +229,15 @@ Accept wildcard characters: False ``` ### -DisableUserSubmissionOptions + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -238,13 +247,15 @@ Accept wildcard characters: False ``` ### -EnableCustomizedMsg + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -254,10 +265,13 @@ Accept wildcard characters: False ``` ### -EnableCustomNotificationSender + +> Applicable: Exchange Online + The EnableCustomNotificationSender parameter specifies whether a custom sender email address is used for result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Use a custom Microsoft 365 sender email address. -- $false: Use the default sender email address. This is the default value. +- $false: Use the default sender email address. This value is the default. You specify the sender email address using the NotificationSenderAddress parameter. @@ -265,7 +279,6 @@ You specify the sender email address using the NotificationSenderAddress paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -275,6 +288,9 @@ Accept wildcard characters: False ``` ### -EnableOrganizationBranding + +> Applicable: Exchange Online + The EnableOrganizationBranding parameter specifies whether to show the company logo in the footer of result messages that users receive after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Use the company logo in the footer text instead of the Microsoft logo. @@ -286,7 +302,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -296,23 +311,26 @@ Accept wildcard characters: False ``` ### -EnableReportToMicrosoft + +> Applicable: Exchange Online + The EnableReportToMicrosoft parameter specifies whether Microsoft integrated reporting experience is enabled or disabled. Valid values are $true or $false. The value $true for this parameter enables reporting in Outlook. The following configurations are possible: -- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft only (the reporting mailbox isn't used)**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. This is the default result. -- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft and reported messages are sent to the specified reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. +- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft only (the reporting mailbox isn't used)**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. +- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft and reporting mailbox (reported messages are sent to the specified mailbox)**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. This is the default configuration. +- **Using a third party add-in in Outlook for users to report to Microsoft and reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. The EnableThirdPartyAddress parameter value is $true. To create the policy, use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. The value $false for this parameter disables reporting in Outlook. The following configurations are possible: - **Microsoft reporting tools are available in Outlook, but reported messages are sent only to the reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. -- **Reporting in Outlook is disabled. Microsoft reporting tools are not available in Outlook. Any messages reported by users in Outlook with third-party reporting tools aren't visible on the Submissions page in the Microsoft Defender portal**: The EnableThirdPartyAddress, ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. +- **Reporting in Outlook is disabled. Microsoft reporting tools are not available in Outlook. Any messages reported by users in Outlook with non-Microsoft reporting tools aren't visible on the Submissions page in the Microsoft Defender portal**: The EnableThirdPartyAddress, ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -322,16 +340,22 @@ Accept wildcard characters: False ``` ### -EnableThirdPartyAddress -The EnableThirdPartyAddress parameter specifies whether you're using third-party reporting tools in Outlook instead of Microsoft tools to send messages to the reporting mailbox in Exchange Online. Valid values are: -- $true: Reporting in Outlook is enabled, but third-party tools in Outlook send reported messages to the reporting mailbox in Exchange Online. You also need to set the EnableReportToMicrosoft parameter value to $false. To create the policy, use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. -- $false: Third-party reporting tools in Outlook aren't used. +> Applicable: Exchange Online + +The EnableThirdPartyAddress parameter specifies whether you're using non-Microsoft reporting tools in Outlook instead of Microsoft tools to send messages to the reporting mailbox in Exchange Online. Valid values are $true or $false. + +The value $true enables Microsoft to capture information about email sent to the non-Microsoft 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 non-Microsoft 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 non-Microsoft 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 non-Microsoft reporting tools in Outlook aren't used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -341,6 +365,9 @@ Accept wildcard characters: False ``` ### -EnableUserEmailNotification + +> Applicable: Exchange Online + The EnableUserEmailNotification parameter species whether users receive result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Customized admin review result messages are sent. This value is required when user reported messages go only to the reporting mailbox (the value of the EnableReportToMicrosoft parameter is $false). @@ -356,7 +383,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -366,6 +392,9 @@ Accept wildcard characters: False ``` ### -JunkReviewResultMessage + +> Applicable: Exchange Online + The JunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as junk. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -378,7 +407,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -388,6 +416,9 @@ Accept wildcard characters: False ``` ### -NotJunkReviewResultMessage + +> Applicable: Exchange Online + The NotJunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as not junk. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -400,7 +431,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -410,6 +440,9 @@ Accept wildcard characters: False ``` ### -NotificationFooterMessage + +> Applicable: Exchange Online + The NotificationFooterMessage parameter specifies the custom footer text to use in email notifications after an admin reviews and marks the reported messages as junk, not junk, or phishing. If the value contains spaces, enclose the value in quotation marks. You can use the EnableOrganizationBranding parameter to include your company logo in the message footer. @@ -420,7 +453,6 @@ This parameter is meaningful only when the value of the EnableUserEmailNotificat Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -430,6 +462,9 @@ Accept wildcard characters: False ``` ### -NotificationSenderAddress + +> Applicable: Exchange Online + The NotificationSenderAddress parameter specifies the sender email address to use in result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. The email address must be in Exchange Online. This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -438,7 +473,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -448,13 +482,15 @@ Accept wildcard characters: False ``` ### -NotificationsForCleanSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -464,13 +500,15 @@ Accept wildcard characters: False ``` ### -NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -480,13 +518,15 @@ Accept wildcard characters: False ``` ### -NotificationsForSpamSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -496,13 +536,15 @@ Accept wildcard characters: False ``` ### -NotificationsForSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -512,13 +554,15 @@ Accept wildcard characters: False ``` ### -OnlyShowPhishingDisclaimer + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -528,6 +572,9 @@ Accept wildcard characters: False ``` ### -PhishingReviewResultMessage + +> Applicable: Exchange Online + The PhishingReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as phishing. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -540,7 +587,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -550,6 +596,9 @@ Accept wildcard characters: False ``` ### -PostSubmitMessage + +> Applicable: Exchange Online + The PostSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message title using the PostSubmitMessageTitle parameter. @@ -560,7 +609,6 @@ This parameter is meaningful only when the value of the PostSubmitMessageEnabled Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -570,16 +618,18 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageEnabled + +> Applicable: Exchange Online + The PostSubmitMessageEnabled parameter enables or disables the pop-up Outlook notifications that users see after they report messages using Microsoft reporting tools. Valid values are: -- $true: Users receive pop-up notifications in Outlook after they report messages. This is the default value. +- $true: Users receive pop-up notifications in Outlook after they report messages. This value is the default. - $false: Users don't receive pop-up notifications in Outlook after they report messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -589,13 +639,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -605,13 +657,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -621,13 +675,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -637,6 +693,9 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitle + +> Applicable: Exchange Online + The PostSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message text using the PostSubmitMessage parameter. @@ -647,7 +706,6 @@ This parameter is meaningful only when the value of the PostSubmitMessageEnabled Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -657,13 +715,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -673,13 +733,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -689,13 +751,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -705,6 +769,9 @@ Accept wildcard characters: False ``` ### -PreSubmitMessage + +> Applicable: Exchange Online + The PreSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message title using the PreSubmitMessageTitle parameter. @@ -715,7 +782,6 @@ This parameter is meaningful only when the value of the PreSubmitMessageEnabled Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -725,16 +791,18 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageEnabled + +> Applicable: Exchange Online + The PreSubmitMessageEnabled parameter enables or disables the pop-up Outlook notifications that users see before they report messages using Microsoft reporting tools. Valid values are: -- $true: Users receive pop-up notifications in Outlook before they report messages. This is the default value. +- $true: Users receive pop-up notifications in Outlook before they report messages. This value is the default. - $false: Users don't receive pop-up notifications in Outlook before they report messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -744,13 +812,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -760,13 +830,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -776,13 +848,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -792,6 +866,9 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitle + +> Applicable: Exchange Online + The PreSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the pop-up message text using the PreSubmitMessage parameter. @@ -802,7 +879,6 @@ This parameter is meaningful only when the value of the PreSubmitMessageEnabled Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -812,13 +888,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -828,13 +906,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -844,13 +924,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -860,13 +942,15 @@ Accept wildcard characters: False ``` ### -ReportChatMessageEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -876,13 +960,15 @@ Accept wildcard characters: False ``` ### -ReportChatMessageToCustomizedAddressEnabled + +> Applicable: Exchange Online + {{ Fill ReportChatMessageToCustomizedAddressEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -892,9 +978,12 @@ Accept wildcard characters: False ``` ### -ReportJunkAddresses + +> Applicable: Exchange Online + **Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. -The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. +The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. If you change the ReportJunkToCustomizedAddress parameter value to $false, you should set the value $null (blank) for this parameter. @@ -904,7 +993,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -914,7 +1002,10 @@ Accept wildcard characters: False ``` ### -ReportJunkToCustomizedAddress -The ReportJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +> Applicable: Exchange Online + +The ReportJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. - $false: User reported messages are not sent to the reporting mailbox. @@ -925,7 +1016,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -935,9 +1025,12 @@ Accept wildcard characters: False ``` ### -ReportNotJunkAddresses + +> Applicable: Exchange Online + **Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. -The ReportNotJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. +The ReportNotJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. If you change the ReportNotJunkToCustomizedAddress parameter value to $false, you should set the value $null (blank) for this parameter. @@ -947,7 +1040,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -957,7 +1049,10 @@ Accept wildcard characters: False ``` ### -ReportNotJunkToCustomizedAddress -The ReportNotJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +> Applicable: Exchange Online + +The ReportNotJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. - $false: User reported messages are not sent to the reporting mailbox. @@ -968,7 +1063,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -978,9 +1072,12 @@ Accept wildcard characters: False ``` ### -ReportPhishAddresses + +> Applicable: Exchange Online + **Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. -The ReportPhishAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. +The ReportPhishAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. If you change the ReportPhishToCustomizedAddress parameter value to $false, you should set the value $null (blank) for this parameter. @@ -990,7 +1087,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1000,7 +1096,10 @@ Accept wildcard characters: False ``` ### -ReportPhishToCustomizedAddress -The ReportPhishToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +> Applicable: Exchange Online + +The ReportPhishToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. - $false: User reported messages are not sent to the reporting mailbox. @@ -1011,7 +1110,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1021,19 +1119,21 @@ Accept wildcard characters: False ``` ### -ThirdPartyReportAddresses + +> Applicable: Exchange Online + **Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. -Use the ThirdPartyReportAddresses parameter to specify the email address of the reporting mailbox when you're using a third-party product for user submissions instead of reporting in Outlook. +Use the ThirdPartyReportAddresses parameter to specify the email address of the reporting mailbox when you're using a non-Microsoft product for user submissions instead of reporting in Outlook. If you change the EnableThirdPartyAddress parameter value to $false, you should set the value $null (blank) for this parameter. -For more information about using third-party reporting tools with or without reporting in Outlook in favor of a third-party product, see the EnableThirdPartyAddress parameter. +For more information about using non-Microsoft reporting tools with or without reporting in Outlook in favor of a non-Microsoft product, see the EnableThirdPartyAddress parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1043,13 +1143,15 @@ Accept wildcard characters: False ``` ### -UserSubmissionOptions + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1059,13 +1161,15 @@ Accept wildcard characters: False ``` ### -UserSubmissionOptionsMessage + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1075,13 +1179,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionRule.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionRule.md index 88878ff4a1..16493b60d8 100644 --- a/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-reportsubmissionrule applicable: Exchange Online -title: Set-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-reportsubmissionrule +schema: 2.0.0 +title: Set-ReportSubmissionRule --- # Set-ReportSubmissionRule @@ -37,11 +38,11 @@ The SentTo parameter identifies the email address of the reporting mailbox. If you set the email address of the reporting mailbox in the Microsoft Defender portal at , the same email address is also set in the *\-ReportSubmissionPolicy cmdlets: - Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). -- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. +- Microsoft integrated reporting using non-Microsoft reporting tools in Outlook: ThirdPartyReportAddresses. When you use this cmdlet to set the email address of the reporting mailbox, the corresponding parameters in the *\-ReportSubmissionPolicy cmdlets are not updated. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example changes the reporting mailbox to userreportedmessages@contoso.onmic ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission rule that you want to modify. The default rule is named DefaultReportSubmissionRule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -96,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the name of the report submission rule. When the rule is automatically created, the name of the rule is DefaultReportSubmissionRule. We recommend using this value to avoid confusion. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -ReportSubmissionPolicy + +> Applicable: Exchange Online + The ReportSubmissionPolicy parameter specifies the report submission policy that's associated with this rule. The only available policy is named DefaultReportSubmissionPolicy. ```yaml Type: ReportSubmissionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,17 +149,20 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies the email address of the reporting mailbox in Exchange Online where user reported messages are sent. The value of this parameter is meaningful only if reporting in Outlook is enabled, and user reported messages are sent to a reporting mailbox as configured in the \*-ReportSubmissionPolicy cmdlets (either of the following scenarios): - Microsoft integrated reporting is enabled using Microsoft reporting tools in Outlook: `-EnableThirdPartyAddress $false -ReportJunkToCustomizedAddress $true -ReportNotJunkToCustomizedAddress $true -ReportPhishToCustomizedAddress $true`. -- Microsoft integrated reporting is enabled using third-party reporting tools in Outlook: `-EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ReportJunkToCustomizedAddress $false -ReportNotJunkToCustomizedAddress $false -ReportPhishToCustomizedAddress $false`. +- Microsoft integrated reporting is enabled using non-Microsoft reporting tools in Outlook: `-EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ReportJunkToCustomizedAddress $false -ReportNotJunkToCustomizedAddress $false -ReportPhishToCustomizedAddress $false`. If you set the email address of the reporting mailbox in the Microsoft Defender portal, the following parameters in the *\-ReportSubmissionPolicy cmdlets are set to the same value: - Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). -- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. +- Microsoft integrated reporting using non-Microsoft reporting tools in Outlook: ThirdPartyReportAddresses. When you use this cmdlet to set the email address of the reporting mailbox, the related parameter values in the *\-ReportSubmissionPolicy cmdlets are not updated, which doesn't affect the functionality of the reporting mailbox. You should update the related values in the \*-ReportSubmissionPolicy cmdlets for consistency and to avoid confusion. @@ -156,7 +170,6 @@ When you use this cmdlet to set the email address of the reporting mailbox, the Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-ResourceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-ResourceConfig.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-ResourceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ResourceConfig.md index 19453e4a45..b47989e46f 100644 --- a/exchange/exchange-ps/exchange/Set-ResourceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ResourceConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-resourceconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ResourceConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-resourceconfig +schema: 2.0.0 +title: Set-ResourceConfig --- # Set-ResourceConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-ResourceConfig cmdlet to create custom resource properties that you can add to room and equipment mailboxes. @@ -31,7 +32,7 @@ Set-ResourceConfig [-Confirm] ## DESCRIPTION After you use this cmdlet to create custom resource properties, you use the ResourceCustom parameter on the Set-Mailbox cmdlet to add one or more of those properties to a room or equipment mailbox. For more information, see the ResourceCustom parameter description in Set-Mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example adds the custom resource property Room/TV and removes Equipment/Lap ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -61,7 +65,6 @@ 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 Required: False Position: Named @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -79,7 +85,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -ResourcePropertySchema + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ResourcePropertySchema parameter specifies the custom resource property that you want to make available to room or equipment mailboxes. This parameter uses the syntax `Room/` or `Equipment/` where the `` value doesn't contain spaces. For example, `Room/Whiteboard` or `Equipment/Van`. You can specify multiple values separated by commas. 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"`. @@ -99,7 +107,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ResubmitRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-ResubmitRequest.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-ResubmitRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ResubmitRequest.md index 222f007a7c..6f968b3786 100644 --- a/exchange/exchange-ps/exchange/Set-ResubmitRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ResubmitRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-resubmitrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ResubmitRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-resubmitrequest +schema: 2.0.0 +title: Set-ResubmitRequest --- # Set-ResubmitRequest @@ -29,7 +30,7 @@ Set-ResubmitRequest [-Identity] -Enabled Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the resubmit request you want to modify. Each resubmit request is identified by an incremented integer value. ```yaml Type: ResubmitRequestIdentityParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter enables or disables an active resubmit request. Valid input for this parameter is $true or $false. Setting the value to $false disables the resubmit request. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -75,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -84,7 +92,6 @@ 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 Required: False Position: Named @@ -94,6 +101,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -107,7 +117,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionCompliancePolicy.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RetentionCompliancePolicy.md index b97520fc0b..5e04592e5a 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-retentioncompliancepolicy applicable: Security & Compliance -title: Set-RetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-retentioncompliancepolicy +schema: 2.0.0 +title: Set-RetentionCompliancePolicy --- # Set-RetentionCompliancePolicy @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Set-RetentionCompliancePolicy cmdlet to modify existing retention policies in the Microsoft Purview compliance portal. -**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. For information about the distribution status, see [Get-RetentionCompliancePolicy](https://learn.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy). +**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. For information about the distribution status, see [Get-RetentionCompliancePolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentioncompliancepolicy). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -130,7 +131,7 @@ Set-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchange This example makes the following changes to the existing retention policy named "Regulation 123 Compliance": - Adds the mailbox for the user named Kitty Petersen. -- Adds the SharePoint Online site `https://contoso.sharepoint.com/sites/teams/finance`. +- Adds the SharePoint site `https://contoso.sharepoint.com/sites/teams/finance`. - Removes public folders. - Updates the comment. @@ -148,6 +149,8 @@ Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocatio 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 = @" @@ -162,6 +165,8 @@ Set-RetentionCompliancePolicy -Identity "Tenant Level Policy" -AddModernGroupLoc 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 = @" @@ -180,9 +185,49 @@ Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocatio 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 + +> Applicable: Security & Compliance + The Identity parameter specifies the retention policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -193,7 +238,6 @@ The Identity parameter specifies the retention policy that you want to modify. Y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -203,7 +247,10 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. + +> Applicable: Security & Compliance + +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -211,7 +258,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -221,6 +267,9 @@ Accept wildcard characters: False ``` ### -AddAdaptiveScopeLocation + +> Applicable: Security & Compliance + The AddAdaptiveScopeLocation parameter specifies the adaptive scope location to add to the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -233,7 +282,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -243,6 +291,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -261,7 +312,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -271,6 +321,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocationException + +> Applicable: Security & Compliance + This parameter specifies the mailboxes to add to the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -289,7 +342,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -299,6 +351,9 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocation + +> Applicable: Security & Compliance + The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups when you aren't using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -314,7 +369,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -324,6 +378,9 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocationException + +> Applicable: Security & Compliance + The AddModernGroupLocationException parameter specifies the Microsoft 365 Groups to add to the list of excluded Microsoft 365 Groups when you're using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -339,7 +396,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -349,7 +405,10 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation -The AddOneDriveLocation parameter specifies the OneDrive for Business sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +The AddOneDriveLocation parameter specifies the OneDrive sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -357,7 +416,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -367,7 +425,10 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocationException -This parameter specifies the OneDrive for Business sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +This parameter specifies the OneDrive sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -375,7 +436,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -385,13 +445,15 @@ Accept wildcard characters: False ``` ### -AddPublicFolderLocation + +> Applicable: Security & Compliance + The AddPublicFolderLocation parameter specifies that you want to add all public folders to the retention policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -401,17 +463,19 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation -The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -SharePoint Online sites can't be added to the policy until they have been indexed. +SharePoint sites can't be added to the policy until they have been indexed. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -421,7 +485,10 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationException -This parameter specifies the SharePoint Online sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +This parameter specifies the SharePoint sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -429,7 +496,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -439,6 +505,9 @@ Accept wildcard characters: False ``` ### -AddSkypeLocation + +> Applicable: Security & Compliance + The AddSkypeLocation parameter specifies the Skype for Business Online users to add from the list of included Skype for Business Online users. You can use any value that uniquely identifies the user. For example: @@ -454,7 +523,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -464,13 +532,15 @@ Accept wildcard characters: False ``` ### -AddSkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -480,6 +550,9 @@ Accept wildcard characters: False ``` ### -AddTeamsChannelLocation + +> Applicable: Security & Compliance + The AddTeamsChannelLocation parameter specifies the Teams to add to the policy. You can use any value that uniquely identifies the team. For example: @@ -494,7 +567,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -504,6 +576,9 @@ Accept wildcard characters: False ``` ### -AddTeamsChannelLocationException + +> Applicable: Security & Compliance + The AddTeamsChannelLocationException parameter specifies the Teams to add to the exclusion list when you use the value All for the TeamsChannelLocation parameter. You can use any value that uniquely identifies the team. For example: - Name @@ -516,7 +591,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -526,6 +600,9 @@ Accept wildcard characters: False ``` ### -AddTeamsChatLocation + +> Applicable: Security & Compliance + The AddTeamsChatLocation parameter specifies the Teams users to add to the policy. You can use any value that uniquely identifies the user. For example: @@ -541,7 +618,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -551,6 +627,9 @@ Accept wildcard characters: False ``` ### -AddTeamsChatLocationException + +> Applicable: Security & Compliance + The AddTeamsChatLocationException parameter specifies the Teams users to add to the exclusion list when you use the value All for the TeamsChatLocation parameter. You can use any value that uniquely identifies the user. For example: - Name @@ -563,7 +642,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -573,18 +651,20 @@ Accept wildcard characters: False ``` ### -Applications + +> Applicable: Security & Compliance + The Applications parameter specifies the target when Microsoft 365 Groups are included in the policy (the ModernGroups parameter is set). Valid values are: - `Group:Exchange` for the mailbox that's connected to the Microsoft 365 Group. - `Group:SharePoint` for the SharePoint site that's connected to the Microsoft 365 Group. - `"Group:Exchange,SharePoint"` for both the mailbox and the SharePoint site that are connected to the Microsoft 365 Group. -- blank (`$null`): This is the default value, and is functionally equivalent to the value `"Group:Exchange,SharePoint"`. To return to the default value of both the mailbox and SharePoint site for the selected Microsoft 365 groups, specify `"Group:Exchange,SharePoint"`. +- blank (`$null`): This value is the default, and is functionally equivalent to the value `"Group:Exchange,SharePoint"`. To return to the default value of both the mailbox and SharePoint site for the selected Microsoft 365 groups, specify `"Group:Exchange,SharePoint"`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -594,13 +674,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -610,6 +692,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -619,7 +704,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -629,17 +713,25 @@ Accept wildcard characters: False ``` ### -DeletedResources -The DeletedResources parameter specifies the Sharepoint sites to be removed from the list of included sites or excluded from a tenant level policy when the associated group has been deleted. You use this parameter with the AddModernGroupLocationException and RemoveModernGroupLocation parameters. -A valid value is a JSON String. See the Examples section for syntax and examples using this parameter. +> Applicable: Security & Compliance + +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. -For more information about this 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). +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 @@ -649,16 +741,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -668,10 +762,13 @@ Accept wildcard characters: False ``` ### -EnforceSimulationPolicy + +> Applicable: Security & Compliance + The EnforceSimulationPolicy parameter specifies whether to enforce a simulation policy as an active policy. Valid values are: - $true: Enforce the simulation policy as an active policy. -- $false: Don't enforce the simulation policy as an active policy. This is the default value. +- $false: Don't enforce the simulation policy as an active policy. This value is the default. For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). @@ -679,7 +776,6 @@ For more information about simulation mode, see [Learn about simulation mode](ht Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -689,6 +785,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -697,7 +796,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -707,6 +805,11 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + +**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. @@ -715,7 +818,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -725,13 +827,15 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -741,13 +845,17 @@ Accept wildcard characters: False ``` ### -PriorityCleanup -{{ Fill PriorityCleanup Description }} + +> Applicable: Security & Compliance + +The PriorityCleanup switch specifies whether to update a Priority cleanup policy. You don't need to specify a value with this switch. + +Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -757,6 +865,9 @@ Accept wildcard characters: False ``` ### -RemoveAdaptiveScopeLocation + +> Applicable: Security & Compliance + The RemoveAdaptiveScopeLocation parameter specifies the adaptive scope location to remove from the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -769,7 +880,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -779,6 +889,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. You can use any value that uniquely identifies the mailbox. For example: @@ -794,7 +907,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -804,6 +916,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocationException + +> Applicable: Security & Compliance + The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. You can use any value that uniquely identifies the mailbox. For example: @@ -819,7 +934,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -829,6 +943,9 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocation + +> Applicable: Security & Compliance + The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups when you aren't using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -844,7 +961,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -854,6 +970,9 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocationException + +> Applicable: Security & Compliance + The RemoveModernGroupLocationException parameter specifies the Microsoft 365 Groups to remove from the list of excluded groups when you're using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -869,7 +988,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -879,7 +997,10 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation -The RemoveOneDriveLocation parameter specifies the OneDrive for Business sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +The RemoveOneDriveLocation parameter specifies the OneDrive sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -887,7 +1008,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -897,7 +1017,10 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocationException -This parameter specifies the OneDrive for Business sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +This parameter specifies the OneDrive sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -905,7 +1028,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -915,13 +1037,15 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation + +> Applicable: Security & Compliance + The RemovePublicFolderLocation parameter specifies that you want to remove all public folders from the retention policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -931,7 +1055,10 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation -The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -939,7 +1066,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -949,7 +1075,10 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationException -This parameter specifies the SharePoint Online sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. + +> Applicable: Security & Compliance + +This parameter specifies the SharePoint sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -957,7 +1086,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -967,6 +1095,9 @@ Accept wildcard characters: False ``` ### -RemoveSkypeLocation + +> Applicable: Security & Compliance + The RemoveSkypeLocation parameter specifies the Skype for Business Online users to remove from the list of included Skype for Business Online users. You can use any value that uniquely identifies the user. For example: @@ -982,7 +1113,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -992,13 +1122,15 @@ Accept wildcard characters: False ``` ### -RemoveSkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1008,12 +1140,15 @@ Accept wildcard characters: False ``` ### -RestrictiveRetention + +> Applicable: Security & Compliance + The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for a retention policy or retention label policy. Valid values are: - $true: Preservation Lock is enabled for the policy. No one (including an administrator) can turn off the policy or make it less restrictive. -- $false: Preservation Lock isn't enabled for the policy. This is the default value. +- $false: Preservation Lock isn't enabled for the policy. This value is the default. -After a policy has been locked, no one can turn off or disable it, or remove content from the policy. And it's not possible to modify or delete content that's subject to the policy during the retention period. The only way that you can modify the retention policy are by adding content to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. +After a policy is locked, no one can turn off or disable it, or remove content from the policy. And it's not possible to modify or delete content that's subject to the policy during the retention period. The only way that you can modify the retention policy are by adding content to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. Therefore, before you lock a policy for retention, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need. @@ -1021,7 +1156,6 @@ Therefore, before you lock a policy for retention, it's critical that you unders Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1031,6 +1165,9 @@ Accept wildcard characters: False ``` ### -RemoveTeamsChannelLocation + +> Applicable: Security & Compliance + The RemoveTeamsChannelLocation parameter specifies the Teams to remove from the policy. You can use any value that uniquely identifies the team. For example: @@ -1045,7 +1182,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1055,6 +1191,9 @@ Accept wildcard characters: False ``` ### -RemoveTeamsChannelLocationException + +> Applicable: Security & Compliance + The RemoveTeamsChannelLocationException parameter specifies the Teams to remove from the exclusion list when you use the value All for the TeamsChannelLocation parameter. You can use any value that uniquely identifies the team. For example: - Name @@ -1067,7 +1206,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1077,6 +1215,9 @@ Accept wildcard characters: False ``` ### -RemoveTeamsChatLocation + +> Applicable: Security & Compliance + The RemoveTeamsChatLocation parameter specifies the Teams users to remove from the policy. You can use any value that uniquely identifies the user. For example: @@ -1092,7 +1233,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1102,6 +1242,9 @@ Accept wildcard characters: False ``` ### -RemoveTeamsChatLocationException + +> Applicable: Security & Compliance + The RemoveTeamsChatLocationException parameter specifies the Teams users to remove from the exclusion list when you use the value All for the TeamsChatLocation parameter. You can use any value that uniquely identifies the user. For example: - Name @@ -1114,7 +1257,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1124,10 +1266,13 @@ Accept wildcard characters: False ``` ### -StartSimulation + +> Applicable: Security & Compliance + The StartSimulation parameter specifies whether to start the simulation for a policy that was created in simulation mode. Valid values are: - $true: Start the simulation. -- $false: Don't start the simulation. This is the default value. +- $false: Don't start the simulation. This value is the default. For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). @@ -1135,7 +1280,6 @@ For more information about simulation mode, see [Learn about simulation mode](ht Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1145,13 +1289,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionComplianceRule.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RetentionComplianceRule.md index 3a544e128a..ff567dd1a3 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-retentioncompliancerule applicable: Security & Compliance -title: Set-RetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-retentioncompliancerule +schema: 2.0.0 +title: Set-RetentionComplianceRule --- # Set-RetentionComplianceRule @@ -55,6 +56,9 @@ This example changes the hold duration for the existing retention rule named "In ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the retention rule that you want to modify. You Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -ApplyComplianceTag + +> Applicable: Security & Compliance + The ApplyComplianceTag parameter specifies the label that's applied to email messages or documents by the rule (which affects how long the content is retained). A valid value for this parameter is the name of an existing label. If the value contains spaces, enclose the value in quotation marks. You view and create labels by using the Get-ComplianceTag and New-ComplianceTag cmdlets. @@ -87,7 +93,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -122,7 +132,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -144,7 +156,6 @@ You can't use this parameter for Teams retention rules. Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -ContentDateFrom + +> Applicable: Security & Compliance + 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". @@ -162,7 +176,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,6 +185,9 @@ Accept wildcard characters: False ``` ### -ContentDateTo + +> Applicable: Security & Compliance + 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". @@ -180,7 +196,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -200,7 +218,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -210,7 +227,10 @@ Accept wildcard characters: False ``` ### -ExcludedItemClasses -The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: + +> Applicable: Security & Compliance + +The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. This parameter doesn't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: - IPM.Note.Microsoft.Conversation - IPM.Note.Microsoft.Conversation.Voice @@ -221,7 +241,7 @@ The ExcludedItemClasses parameter specifies the types of messages to exclude fro - IPM.Note.Microsoft.Voicemail.UM - IPM.Note.Microsoft.Voicemail.UM.CA -Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or non-Microsoft message classes. The values you specify aren't validated, so the parameter accepts any text value. You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. @@ -231,7 +251,6 @@ You can't use this parameter for Teams retention rules. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -241,6 +260,9 @@ Accept wildcard characters: False ``` ### -ExpirationDateOption + +> Applicable: Security & Compliance + The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: - CreationAgeInDays @@ -252,7 +274,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -262,13 +283,15 @@ Accept wildcard characters: False ``` ### -IRMRiskyUserProfiles + +> Applicable: Security & Compliance + {{ Fill IRMRiskyUserProfiles Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -278,13 +301,17 @@ Accept wildcard characters: False ``` ### -PriorityCleanup -{{ Fill PriorityCleanup Description }} + +> Applicable: Security & Compliance + +The PriorityCleanup switch specifies whether to update the rule associated with a Priority cleanup policy. You don't need to specify a value with this switch. + +Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -294,6 +321,9 @@ Accept wildcard characters: False ``` ### -RetentionComplianceAction + +> Applicable: Security & Compliance + The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - Delete @@ -304,7 +334,6 @@ The RetentionComplianceAction parameter specifies the retention action for the r Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -314,6 +343,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - An integer: The hold duration in days. @@ -323,7 +355,6 @@ The RetentionDuration parameter specifies the hold duration for the retention ru Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -333,13 +364,16 @@ Accept wildcard characters: False ``` ### -RetentionDurationDisplayHint + +> Applicable: Security & Compliance + The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. - Days - Months - Years -For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal displays 1 year as the content hold duration. You can't use this parameter for Teams retention rules. @@ -347,7 +381,6 @@ You can't use this parameter for Teams retention rules. Type: HoldDurationHint Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -357,13 +390,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicy.md similarity index 75% rename from exchange/exchange-ps/exchange/Set-RetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicy.md index 14102c1ff4..28d1b59219 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-retentionpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-RetentionPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-retentionpolicy +schema: 2.0.0 +title: Set-RetentionPolicy --- # Set-RetentionPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-RetentionPolicy cmdlet to change the properties of an existing retention policy. @@ -35,7 +36,7 @@ Set-RetentionPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,18 +47,20 @@ Set-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag" This example modifies the policy MyPolicy to link the retention policy tag MyRetentionPolicyTag with it. -The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). +The Identity parameter is positional, which means you can use it without the -Identity label in the supported location in the command (in this case, first). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name, distinguished name (DN), or GUID of the retention policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -76,7 +82,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you use the RetentionId parameter. @@ -112,7 +122,6 @@ Use this switch to hide the confirmation prompt when you use the RetentionId par Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -122,18 +131,21 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IsDefault switch specifies that this retention policy is the default retention policy. You don't need to specify a value with this switch. -When you use this switch, you'll get a warning that this retention policy will replace the current default retention policy (the policy where the IsDefault property value is currently True) as the default. By default, the default retention policy is named Default MRM Policy. +When you use this switch, you get a warning that this retention policy replaces the current default retention policy (the policy where the IsDefault property value is currently True) as the default. By default, the default retention policy is named Default MRM Policy. **Note**: Changing which retention policy is the default might or might not affect new and existing mailboxes based on the value of the RetentionPolicy parameter on all mailbox plans: - $null (blank): Changes to which retention policy is the default are continually reflected in new and existing mailboxes. - A retention policy is specified: The value of the RetentionPolicy parameter for all mailbox plans should be $null (blank) or match the Exchange retention policy that's configured as the default policy for the organization. Otherwise, the experience might be inconsistent when creating new mailboxes, enabling disabled mailboxes, and changing licenses. For more information see [Mailbox plans in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/mailbox-plans). -If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox will be overwritten when changing licenses and will need to be manually reset to the original value. +If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox is overwritten when changing licenses. You need to manually reset the RetentionPolicy to the original value. Changes to the default retention policy that affect existing mailboxes can potentially saturate the network if there are hundreds or thousands of mailboxes that require updates. @@ -141,7 +153,6 @@ Changes to the default retention policy that affect existing mailboxes can poten Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -IsDefaultArbitrationMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. You don't need to specify a value with this switch. @@ -161,7 +175,6 @@ This parameter isn't available in on-premises deployments. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies a unique name for the retention policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -RetentionId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionId parameter specifies the identity of the retention policy to make sure mailboxes moved between two Exchange organizations continue to have the same retention policy applied to them. For example, in a cross-forest deployment or in a cross-premises deployment, when a mailbox is moved from an on-premises Exchange server to the cloud, or a cloud-based mailbox is moved to an on-premises Exchange server, this parameter is used to make sure the same retention policy is applied to the mailbox. It's not normally required to specify or modify the RetentionId parameter for a retention tag. The parameter is populated automatically when importing retention tags using the Import-RetentionTags.ps1 script. @@ -195,7 +213,6 @@ It's not normally required to specify or modify the RetentionId parameter for a Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -205,13 +222,15 @@ Accept wildcard characters: False ``` ### -RetentionPolicyTagLinks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionPolicyTagLinks parameter specifies the identity of retention policy tags to associate with the retention policy. Mailboxes that get a retention policy applied have retention tags linked with that retention policy. ```yaml Type: RetentionPolicyTagIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -221,13 +240,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicyTag.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicyTag.md index f4d7334536..b741d5fba9 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicyTag.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-retentionpolicytag -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-RetentionPolicyTag -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-retentionpolicytag +schema: 2.0.0 +title: Set-RetentionPolicyTag --- # Set-RetentionPolicyTag ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-RetentionPolicyTag cmdlet to modify the properties of a retention tag. @@ -70,13 +71,13 @@ Set-RetentionPolicyTag -Mailbox ## DESCRIPTION Retention tags are used to apply message retention settings to folders and items in a mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder will be automatically deleted in 120 days" +Set-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder are automatically deleted in 120 days" ``` This example changes the comment for the AllUsers-DeletedItems retention policy tag. @@ -91,13 +92,15 @@ This example makes optional retention tags available to user Terry Adams using t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name, distinguished name (DN), or GUID of the retention policy tag to be modified. ```yaml Type: RetentionPolicyTagIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies a mailbox for assigning opt-in tags. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -126,7 +132,6 @@ You must use this parameter with the OptionalInMailbox parameter. Type: MailboxIdParameter Parameter Sets: MailboxTask Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -AddressForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -144,7 +152,6 @@ This parameter is reserved for internal Microsoft use. Type: RecipientIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -154,13 +161,15 @@ Accept wildcard characters: False ``` ### -AgeLimitForRetention + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml Type: EnhancedTimeSpan Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,13 +179,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Comment parameter specifies a comment for the retention policy tag. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -195,7 +209,6 @@ 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 Required: False Position: Named @@ -205,6 +218,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -213,7 +229,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -223,6 +238,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you use the RetentionId parameter. @@ -231,7 +249,6 @@ Use this switch to hide the confirmation prompt when you use the RetentionId par Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -241,6 +258,9 @@ Accept wildcard characters: False ``` ### -JournalingEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -249,7 +269,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -259,6 +278,9 @@ Accept wildcard characters: False ``` ### -LabelForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -267,7 +289,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -277,13 +298,15 @@ Accept wildcard characters: False ``` ### -LegacyManagedFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LegacyManagedFolder parameter specifies the name of a managed folder. The retention tag is created by using retention settings from the managed folder and its managed content settings. You can use this parameter to create retention tags based on existing managed folders to migrate users from managed folder mailbox policies to retention policies. ```yaml Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -293,13 +316,15 @@ Accept wildcard characters: False ``` ### -LocalizedComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LocalizedComment parameter specifies the localized comment and language for the retention policy tag. This comment is displayed in Microsoft Outlook based on the user's locale. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -309,13 +334,15 @@ Accept wildcard characters: False ``` ### -LocalizedRetentionPolicyTagName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The LocalizedRetentionPolicyTagName parameter specifies a localized name for the retention policy tag. This name is displayed in Outlook based on the user's locale. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -325,6 +352,9 @@ Accept wildcard characters: False ``` ### -MessageClass + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MessageClass parameter specifies the message type to which the tag applies. If not specified, the default value is set to \*. With the exception of a default policy tag (DPT) for voicemail, Exchange doesn't support retention tags for different message types. Only tags with a MessageClass of \* are supported and they apply to all message types. @@ -337,7 +367,6 @@ A DPT for voice mail messages applies only to Microsoft Exchange Unified Messagi Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -347,6 +376,9 @@ Accept wildcard characters: False ``` ### -MessageFormatForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -355,7 +387,6 @@ This parameter is reserved for internal Microsoft use. Type: JournalingFormat Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -365,13 +396,15 @@ Accept wildcard characters: False ``` ### -MustDisplayCommentEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -381,13 +414,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the retention policy tag. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -397,13 +432,15 @@ Accept wildcard characters: False ``` ### -OptionalInMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OptionalInMailbox parameter is used with the Mailbox parameter to assign personal tags to the mailbox. You can use this parameter to make available to a user a personal tag that isn't assigned to the retention policy applied to the specified mailbox. You can specify multiple personal tags separated by commas. ```yaml Type: RetentionPolicyTagIdParameter[] Parameter Sets: MailboxTask Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -413,12 +450,15 @@ Accept wildcard characters: False ``` ### -RetentionAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionAction parameter specifies the action for the retention policy. Valid values are: - DeleteAndAllowRecovery: Deletes a message and allows recovery from the Recoverable Items folder. - MarkAsPastRetentionLimit: Messages are marked as past the retention limit. - MoveToArchive: Moves a message to the user's archive mailbox. You can use this action for retention tags of type All, Personal, and RecoverableItems. -- PermanentlyDelete: Permanently deletes a message. A message that has been permanently deleted can't be recovered using the Recoverable Items folder. Permanently deleted messages aren't returned in a Discovery search, unless litigation hold is enabled for the mailbox. +- PermanentlyDelete: Permanently deletes a message. A message that is permanently deleted can't be recovered using the Recoverable Items folder. Permanently deleted messages aren't returned in a Discovery search, unless litigation hold is enabled for the mailbox. The MoveToDeletedItems and MoveToFolder actions are available, but don't work. These actions are available for upgrades from messaging records management (MRM) 1.0 (managed folders) to MRM 2.0 (retention policies). MRM 2.0 was introduced in Exchange 2010 Service Pack 1 (SP1). @@ -428,7 +468,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionAction Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -438,17 +477,19 @@ Accept wildcard characters: False ``` ### -RetentionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionEnabled parameter specifies whether the tag is enabled. When set to $false, the tag is disabled and no retention action is taken on messages that have the tag applied. Messages with a disabled tag are still considered tagged, so any default policy tags in the user's retention policy aren't applied to such messages. -When you set the RetentionEnabled parameter to $false, the retention period for the tag is shown as Never. Users may apply this tag to items that they want to indicate should never be deleted or should never be moved to the archive. Enabling the tag later may result in unintentional deletion or archiving of items. To avoid this situation, if a retention policy is disabled temporarily, it may be advisable to change the name of that tag so that users are discouraged from using it, such as `DISABLED_`. +When you set the RetentionEnabled parameter to $false, the retention period for the tag is shown as Never. Users might apply this tag to items that they want to indicate should never be deleted or should never be moved to the archive. Enabling the tag later might result in unintentional deletion or archiving of items. To avoid this situation, if a retention policy is disabled temporarily, it might be advisable to change the name of that tag so that users are discouraged from using it, such as `DISABLED_`. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -458,6 +499,9 @@ Accept wildcard characters: False ``` ### -RetentionId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RetentionId parameter specifies an alternate tag ID to ensure the retention tag found on mailbox items tagged in one Exchange organization matches the tag when the mailbox is moved to another Exchange organization (for example, in a cross-forest deployment or in a cross-premises deployment, when a mailbox is moved from an on-premises Exchange server to the cloud, or a cloud-based mailbox is moved to an on-premises Exchange server). Typically, you don't need to specify or modify the RetentionId parameter for a retention tag. This parameter is populated automatically when importing retention tags in a cross-forest or cross-premises deployment. @@ -466,7 +510,6 @@ Typically, you don't need to specify or modify the RetentionId parameter for a r Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -476,13 +519,15 @@ Accept wildcard characters: False ``` ### -SystemTag + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SystemTag parameter specifies whether the retention policy tag is created for internal Exchange functionality. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -492,13 +537,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-RoleAssignmentPolicy.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RoleAssignmentPolicy.md index eca66e5008..dd117830db 100644 --- a/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RoleAssignmentPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-roleassignmentpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-RoleAssignmentPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-roleassignmentpolicy +schema: 2.0.0 +title: Set-RoleAssignmentPolicy --- # Set-RoleAssignmentPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-RoleAssignmentPolicy cmdlet to modify existing management role assignment policies in your organization. @@ -36,7 +37,7 @@ You can use the Set-RoleAssignmentPolicy cmdlet to change the name of an assignm For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example changes the default assignment policy. New mailboxes or mailboxes m ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the assignment policy to modify. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -75,7 +81,6 @@ 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 Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Description parameter specifies the description that's displayed when the role assignment policy is viewed using the Get-RoleAssignmentPolicy cmdlet. Enclose the description in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -111,7 +121,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IsDefault switch makes the assignment policy the default assignment policy. You don't need to specify a value with this switch. New mailboxes or mailboxes moved from previous versions of Exchange are assigned the default assignment policy when an explicit assignment policy isn't provided. @@ -129,7 +141,6 @@ New mailboxes or mailboxes moved from previous versions of Exchange are assigned Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -139,13 +150,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the new name of the assignment policy. If the assignment policy name contains spaces, enclose the name in quotation marks ("). The maximum length of the name is 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RoleGroup.md b/exchange/exchange-ps/ExchangePowerShell/Set-RoleGroup.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-RoleGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RoleGroup.md index b0c9fd04a3..e67458b4f8 100644 --- a/exchange/exchange-ps/exchange/Set-RoleGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RoleGroup.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-rolegroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Set-RoleGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-rolegroup +schema: 2.0.0 +title: Set-RoleGroup --- # Set-RoleGroup ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-RoleGroup cmdlet to modify who can add or remove members to or from management role groups or change the name of the role group. @@ -57,7 +58,7 @@ If the ManagedBy property is populated with role group managers, the user config For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -89,13 +90,15 @@ The first command retrieves the credentials using the Get-Credential cmdlet and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the name of the role group to modify. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the fully qualified domain name (FQDN) or IP address of the domain controller in the forest where the foreign USG resides. The domain controller you specify is used to get security information for the foreign USG specified by the LinkedForeignGroup parameter. @@ -115,7 +121,6 @@ You can only use the LinkedDomainController parameter with a linked role group. Type: String Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -125,6 +130,9 @@ Accept wildcard characters: False ``` ### -LinkedForeignGroup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedForeignGroup parameter specifies the name of the foreign USG you want to link this role group to. If the foreign USG name contains spaces, enclose the name in quotation marks ("). @@ -137,7 +145,6 @@ If you use the LinkedForeignGroup parameter, you must specify a domain controlle Type: UniversalSecurityGroupIdParameter Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -158,7 +168,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,6 +177,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -177,7 +189,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -187,13 +198,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Description parameter specifies the description displayed when the role group is viewed using the Get-RoleGroup cmdlet. Enclose the description in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -203,13 +216,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter has a maximum length of 256 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -227,7 +245,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,6 +254,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -247,7 +267,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -257,6 +276,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. @@ -269,7 +291,6 @@ You can only use the LinkedCredential parameter with a linked role group. Type: PSCredential Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Position: Named Default value: None Accept pipeline input: False @@ -277,6 +298,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies the users or USG who can modify the configuration of a role group or add or remove members to or from a role group. The list you specify with this parameter overwrites the existing ManagedBy list. To add or remove individual role group managers, and for more information about modifying multivalued properties, see [Modifying multivalued properties](https://learn.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). You can use the name, distinguished name (DN), or primary SMTP address of the user or USG you want to add. If the name of the user or USG contains spaces, enclose the name in quotation marks ("). @@ -287,7 +311,6 @@ If you want to add more than one user or USG, separate them using commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -297,13 +320,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Name parameter specifies the name of the role group. The name can contain up to 64 characters. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -313,6 +338,9 @@ Accept wildcard characters: False ``` ### -WellKnownObject + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill WellKnownObject Description }} @@ -321,7 +349,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -331,6 +358,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -339,7 +369,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-RoutingGroupConnector.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RoutingGroupConnector.md index d17b041270..da642097c4 100644 --- a/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RoutingGroupConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-routinggroupconnector applicable: Exchange Server 2010 -title: Set-RoutingGroupConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-routinggroupconnector +schema: 2.0.0 +title: Set-RoutingGroupConnector --- # Set-RoutingGroupConnector @@ -39,7 +40,7 @@ The Set-RoutingGroupConnector cmdlet modifies the properties of an existing rout The Exchange 2003 source servers specified in this cmdlet are automatically added to the ExchangeLegacyInterop universal security group. By default, the Exchange 2010 system grants Send to and Receive from permissions on the Hub Transport servers to members of this group. The source and target servers must be computers that have the Exchange 2010 Hub Transport server role installed, or Exchange 2003 bridgehead servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +58,15 @@ This example makes the following configuration changes to the routing group conn ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name or GUID of the routing group connector. The name is expressed as [[Administrative Group Name\\]Routing Group Name]\\Routing Group Connector Name. ```yaml Type: RoutingGroupConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Cost + +> Applicable: Exchange Server 2010 + The Cost parameter specifies a cost to the connector. Transport servers use the connector cost to determine the least cost routing path from a source server to the destination server for message delivery. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010 + The MaxMessageSize parameter specifies the maximum size of a message that can pass through a routing group connector. The default value is unlimited. When you enter a value, qualify the value with one of the following units: - B (bytes) @@ -137,7 +149,6 @@ Unqualified values are treated as bytes. The valid input range for this paramete Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the name of the routing group connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -PublicFolderReferralsEnabled + +> Applicable: Exchange Server 2010 + The PublicFolderReferralsEnabled parameter specifies whether users can use this routing group connector to access a public folder replica located in the routing group of the target servers when an instance of that public folder isn't available in the same routing group as the user's mailbox. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010 + The SourceTransportServers parameter specifies the host name or FQDN of the transport servers that are used to send messages to the target transport servers. You can specify more than one server by separating each entry with a comma. For more information about how to add or remove values from multivalued properties, see [Modifying Multivalued Properties](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb684908(v=exchg.141)). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -195,13 +212,15 @@ Accept wildcard characters: False ``` ### -TargetTransportServers + +> Applicable: Exchange Server 2010 + The TargetTransportServers parameter specifies the host name or FQDN of the transport servers that receive messages from the source transport servers. You can specify more than one server by separating each entry with a comma. For more information about how to add or remove values from multivalued properties, see [Modifying Multivalued Properties](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb684908(v=exchg.141)). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -211,13 +230,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RpcClientAccess.md b/exchange/exchange-ps/ExchangePowerShell/Set-RpcClientAccess.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-RpcClientAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RpcClientAccess.md index 970b171e11..f89351c27e 100644 --- a/exchange/exchange-ps/exchange/Set-RpcClientAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RpcClientAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-rpcclientaccess -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-RpcClientAccess -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-rpcclientaccess +schema: 2.0.0 +title: Set-RpcClientAccess --- # Set-RpcClientAccess @@ -37,7 +38,7 @@ Outlook 2007 isn't supported in Exchange 2016 or later, so you shouldn't see Out To block Outlook versions for specific mailboxes, use the Set-CASMailbox cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,6 +61,9 @@ This example prevents Outlook Anywhere connections by Outlook 2013 clients that ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Client Access server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -71,7 +75,6 @@ The Server parameter specifies the Client Access server where you want to run th Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -BlockedClientVersions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BlockedClientVersions parameter specifies the RPC client versions that aren't allowed to connect to the specified Exchange server. For example, the Microsoft Exchange RPC Client Access service rejects an Outlook Anywhere connection if the version of Outlook is the specified value, or is in the specified range. Valid version values are in the format X.Y.Z. RPC client versions are typically reported in format X.0.Y.Z format, but for this parameter, you need to specify the value as X.Y.Z. @@ -93,13 +99,12 @@ You can specify ranges. For example, -13.32767.65535, 14.0.0-14.32767.65535, or You can specify multiple individual values or range values separated by semicolons (;). -Be careful when you restrict client access, because Exchange server components might also use RPC to log on. Some components may report their client version as a text string, while others may report the Exchange build number. Monitor the RPC Client Access log to see the client versions that are connecting to your Exchange server before you block any client versions. +Be careful when you restrict client access, because Exchange server components might also use RPC to log on. Some components might report their client version as a text string, while others might report the Exchange build number. Monitor the RPC Client Access log to see the client versions that are connecting to your Exchange server before you block any client versions. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -118,7 +126,6 @@ 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 Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,16 +153,18 @@ Accept wildcard characters: False ``` ### -EncryptionRequired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EncryptionRequired parameter specifies whether encryption is required for RPC client connections. Valid values are: -- $true: Unencrypted RPC client connections are rejected. This is the default value. +- $true: Unencrypted RPC client connections are rejected. This value is the default. - $false: Unencrypted RPC client connections are allowed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -MaximumConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaximumConnections parameter specifies the maximum number of concurrent client connections that are allowed by the Microsoft Exchange RPC Client Access service. The default value is 65536. **Note**: Although you can configure a non-default value for this parameter, changes to this setting aren't enforced. @@ -171,7 +185,6 @@ The MaximumConnections parameter specifies the maximum number of concurrent clie Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of the configuration object in Active Directory. By default, this parameter is set to RpcClientAccess. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentPolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentPolicy.md index fbaa17c621..a68c77dc14 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-safeattachmentpolicy applicable: Exchange Online -title: Set-SafeAttachmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-safeattachmentpolicy +schema: 2.0.0 +title: Set-SafeAttachmentPolicy --- # Set-SafeAttachmentPolicy @@ -38,7 +39,7 @@ Safe Attachments is a feature in Microsoft Defender for Office 365 that opens em A safe attachment policy can be assigned to only one safe attachment rule by using the SafeAttachmentPolicy parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example modifies the existing safe attachment policy named Engineering Bloc ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment policy that you want to modify. You can use any value that uniquely identifies the policy. For example: @@ -64,7 +68,6 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -74,10 +77,13 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online + 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 Microsoft Defender portal. -- Block: Block the email message that contains the malware attachment. This is the default value. +- Block: Block the email message that contains the malware attachment. This value is the default. - 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). @@ -90,7 +96,6 @@ The results of all actions are available in message trace. Type: SafeAttachmentAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -125,7 +135,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -135,10 +144,13 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: Exchange Online + The Enable parameter works with the Action parameter to specify the action for the safe attachment policy. Valid values are: - $true: The Action parameter specifies the action for the safe attachment policy. -- $false: This is the default value. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. $false corresponds to the value **Off** for the **Safe Attachments unknown malware response** setting of the complete Safe Attachments policy in the Microsoft Defender portal (the combination of the rule and the corresponding associated policy in PowerShell). +- $false: This value is the default. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. $false corresponds to the value **Off** for the **Safe Attachments unknown malware response** setting of the complete Safe Attachments policy in the Microsoft Defender portal (the combination of the rule and the corresponding associated policy in PowerShell). To enable or disable an existing Safe Attachments policy, use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. @@ -146,7 +158,6 @@ To enable or disable an existing Safe Attachments policy, use the Enable-SafeAtt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -QuarantineTag + +> Applicable: Exchange Online + The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware by Safe Attachments. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -172,7 +186,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -182,16 +195,18 @@ Accept wildcard characters: False ``` ### -Redirect + +> Applicable: Exchange Online + The Redirect parameter specifies whether to deliver messages to an alternate email address if malware is detected in an attachment. Valid values are: - $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is 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. +- $false: Messages that contain malware attachments aren't delivered to another email address. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -201,6 +216,9 @@ Accept wildcard characters: False ``` ### -RedirectAddress + +> Applicable: Exchange Online + The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. The value of this parameter is meaningful only when value of the Redirect parameter is $true and the value of the Action parameter is Allow. @@ -209,7 +227,6 @@ The value of this parameter is meaningful only when value of the Redirect parame Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -219,13 +236,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentRule.md index 985e31a012..593ee7140c 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-safeattachmentrule applicable: Exchange Online -title: Set-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-safeattachmentrule +schema: 2.0.0 +title: Set-SafeAttachmentRule --- # Set-SafeAttachmentRule @@ -45,7 +46,7 @@ A safe attachment policy can be assigned only to one safe attachment rule. > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Safe Attachments policy settings](https://learn.microsoft.com/defender-office-365/safe-attachments-about#safe-attachments-policy-settings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example modifies the existing safe attachment rule named Engineering Depart ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment rule that you want to modify. You can use any value that uniquely identifies the rule. For example: @@ -71,7 +75,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -106,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -147,7 +159,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -174,7 +188,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -184,13 +197,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the safe attachment rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -214,7 +232,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -224,13 +241,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -240,6 +259,9 @@ Accept wildcard characters: False ``` ### -SafeAttachmentPolicy + +> Applicable: Exchange Online + The SafeAttachmentPolicy parameter specifies the safe attachment policy that's associated with this safe attachment rule. The rule defines the conditions, and the policy defines the actions. You can use any value that uniquely identifies the policy. For example: @@ -254,7 +276,6 @@ You can't specify a safe attachment policy that's already associated with anothe Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -264,6 +285,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -279,7 +303,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -289,6 +312,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -306,7 +332,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -316,13 +341,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksPolicy.md index 4587cee20b..828b4ef04b 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-safelinkspolicy applicable: Exchange Online -title: Set-SafeLinksPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-safelinkspolicy +schema: 2.0.0 +title: Set-SafeLinksPolicy --- # Set-SafeLinksPolicy @@ -44,7 +45,7 @@ Set-SafeLinksPolicy [-Identity] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links to see if they lead to malicious web sites. When a user clicks a link, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example modifies the existing Safe Links policy named Engineering Block URL ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the Safe Links policy that you want to modify. Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -AllowClickThrough + +> Applicable: Exchange Online + The AllowClickThrough parameter specifies whether to allow users to click through to the original URL on warning pages. Valid values are: $true: The user is allowed to click through to the original URL. @@ -105,7 +113,6 @@ In PowerShell, the default value is $false. In new Safe Links policies created i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -124,7 +134,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -CustomNotificationText + +> Applicable: Exchange Online + The custom notification text specifies the customized notification text to show to users. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -150,16 +161,18 @@ Accept wildcard characters: False ``` ### -DeliverMessageAfterScan + +> Applicable: Exchange Online + The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: -- $true: Wait until Safe Links scanning is complete before delivering the message. This is the default value. Messages that contain malicious links are not delivered. +- $true: Wait until Safe Links scanning is complete before delivering the message. This value is the default. Messages that contain malicious links are not delivered. - $false: If Safe Links scanning can't complete, deliver the message anyway. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -DisableUrlRewrite + +> Applicable: Exchange Online + The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: - $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). @@ -180,7 +196,6 @@ In PowerShell, the default value is $false. In new Safe Links policies created i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -DoNotRewriteUrls + +> Applicable: Exchange Online + The DoNotRewriteUrls parameter specifies the URLs that are not rewritten by Safe Links scanning. The list of entries allows users who are included in the policy to access the specified URLs that would otherwise be blocked by Safe Links. 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"`. @@ -200,7 +218,6 @@ For details about the entry syntax, see [Entry syntax for the "Do not rewrite th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -210,16 +227,18 @@ Accept wildcard characters: False ``` ### -EnableForInternalSenders + +> Applicable: Exchange Online + The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: -- $true: The policy is applied to internal and external senders. This is the default value. +- $true: The policy is applied to internal and external senders. This value is the default. - $false: The policy is applied only to external senders. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -229,16 +248,18 @@ Accept wildcard characters: False ``` ### -EnableOrganizationBranding + +> Applicable: Exchange Online + The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: - $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. -- $false: Organization branding is not displayed on Safe Links warning and notification pages. This is the default value. +- $false: Organization branding is not displayed on Safe Links warning and notification pages. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,16 +269,18 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForEmail + +> Applicable: Exchange Online + The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: -- $true: Safe Links is enabled for email. This is the default value. When a user clicks a link in an email, the link will be checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $true: Safe Links is enabled for email. This value is the default. When a user clicks a link in an email, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - $false: Safe Links isn't enabled for email. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -267,18 +290,20 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForOffice + +> Applicable: Exchange Online + The EnableSafeLinksForOffice parameter specifies whether to enable Safe Links protection for supported Office desktop, mobile, or web apps. Valid values are: -- $true: Safe Links scanning is enabled in Office apps. This is the default value. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $true: Safe Links scanning is enabled in Office apps. This value is the default. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - $false: Safe Links isn't enabled for Office apps. -Note that this protection applies to links in Office documents, not links in email messages. +This protection applies to links in Office documents, not links in email messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -288,16 +313,18 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForTeams + +> Applicable: Exchange Online + The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: -- $true: Safe Links is enabled for Teams. This is the default value. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $true: Safe Links is enabled for Teams. This value is the default. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - $false: Safe Links isn't enabled for Teams. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -307,16 +334,18 @@ Accept wildcard characters: False ``` ### -ScanUrls + +> Applicable: Exchange Online + The ScanUrls parameter specifies whether to enable or disable real-time scanning of clicked links in email messages. Valid values are: -- $true: Real-time scanning of clicked links, including links that point to files, is enabled. This is the default value. +- $true: Real-time scanning of clicked links, including links that point to files, is enabled. This value is the default. - $false: Real-time scanning of clicked links, including links that point to files, is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -326,16 +355,18 @@ Accept wildcard characters: False ``` ### -TrackClicks + +> Applicable: Exchange Online + The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links. Valid values are: -- $true: User clicks are tracked. This is the default value. +- $true: User clicks are tracked. This value is the default. - $false: User clicks aren't tracked. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -345,16 +376,18 @@ Accept wildcard characters: False ``` ### -UseTranslatedNotificationText + +> Applicable: Exchange Online + The UseTranslatedNotificationText specifies whether to use Microsoft Translator to automatically localize the custom notification text that you specified with the CustomNotificationText parameter. Valid values are: - $true: Translate custom notification text to the user's language. -- $false: Don't translate custom notification text to the user's language. This is the default value. +- $false: Don't translate custom notification text to the user's language. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -364,13 +397,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksRule.md index 6db4b01eeb..99b959c1d1 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-safelinksrule applicable: Exchange Online -title: Set-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-safelinksrule +schema: 2.0.0 +title: Set-SafeLinksRule --- # Set-SafeLinksRule @@ -43,7 +44,7 @@ Safe Links is a feature in Microsoft Defender for Office 365 that checks links i > [!IMPORTANT] > Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Recipient filters in Safe Links policies](https://learn.microsoft.com/defender-office-365/safe-links-about#recipient-filters-in-safe-links-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,6 +76,9 @@ This example is similar to Example 2, but in this example, the Safe Links rule i ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links rule that you want to modify. You can use any value that uniquely identifies the rule. For example: @@ -87,7 +91,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -122,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -163,7 +175,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -190,7 +204,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -200,13 +213,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the Safe Links rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,6 +231,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -230,7 +248,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -240,13 +257,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -256,6 +275,9 @@ Accept wildcard characters: False ``` ### -SafeLinksPolicy + +> Applicable: Exchange Online + The SafeLinksPolicy parameter specifies the Safe Links policy that's associated with this Safe Links rule. The rule defines the conditions and the policy defines the actions. You can use any value that uniquely identifies the policy. For example: @@ -270,7 +292,6 @@ You can't specify a Safe Attachments policy that's already associated with anoth Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -295,7 +319,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -305,6 +328,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -322,7 +348,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -332,13 +357,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md b/exchange/exchange-ps/ExchangePowerShell/Set-SearchDocumentFormat.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SearchDocumentFormat.md index 4288a07794..fe00863c4d 100644 --- a/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SearchDocumentFormat.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-searchdocumentformat -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SearchDocumentFormat -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-searchdocumentformat +schema: 2.0.0 +title: Set-SearchDocumentFormat --- # Set-SearchDocumentFormat @@ -33,7 +34,7 @@ Set-SearchDocumentFormat [-Identity] -Enabled ## DESCRIPTION Exchange Search includes built-in support for indexing many file formats. If you disable indexing for a supported file format, items containing an attachment of that file type aren't considered unsearchable. When you perform an [In-Place eDiscovery search in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and you select the option to include unsearchable items, only items that are actually unsearchable are returned. Items that weren't searched because the associated file format is set as unsearchable aren't returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This command disables the Zip file format for indexing by Exchange Search. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the file format. ```yaml Type: SearchDocumentFormatId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the file format is enabled. Set the parameter to $false to disable the format for content indexing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -88,7 +96,6 @@ 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 Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -111,7 +121,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-SecOpsOverridePolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SecOpsOverridePolicy.md index 0c6e563991..35300359af 100644 --- a/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SecOpsOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-secopsoverridepolicy applicable: Exchange Online -title: Set-SecOpsOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-secopsoverridepolicy +schema: 2.0.0 +title: Set-SecOpsOverridePolicy --- # Set-SecOpsOverridePolicy @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS 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 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). +Use the Set-SecOpsOverridePolicy cmdlet to modify SecOps mailbox override policies that bypass filtering. For more information, see [Configure the advanced delivery policy for non-Microsoft 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). @@ -34,7 +35,7 @@ Set-SecOpsOverridePolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example modifies the SecOPs mailbox override policy with the specified sett ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the SecOps override policy that you want to mod Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AddSentTo + +> Applicable: Exchange Online + 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. @@ -77,7 +83,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -112,7 +122,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,16 +149,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + 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. This value is the default. - $false: The policy is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +170,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + 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. @@ -165,7 +181,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -175,6 +190,9 @@ Accept wildcard characters: False ``` ### -RemoveSentTo + +> Applicable: Exchange Online + 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. @@ -183,7 +201,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -193,6 +210,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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. @@ -201,7 +221,6 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SendConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-SendConnector.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-SendConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SendConnector.md index a8e6726d37..1fa5337f50 100644 --- a/exchange/exchange-ps/exchange/Set-SendConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SendConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-sendconnector -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SendConnector -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-sendconnector +schema: 2.0.0 +title: Set-SendConnector --- # Set-SendConnector @@ -62,7 +63,7 @@ Set-SendConnector [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,13 +80,15 @@ This example makes the following configuration changes to the Send connector nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GUID or connector name that represents the Send connector you want to modify. ```yaml Type: SendConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -95,9 +98,12 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. -- AddressSpaceType: On an Edge server, the address space type must be SMTP. In the Transport service on a Mailbox server, the address space type may be SMTP, X400, or any other text string. If you omit the address space type, SMTP is assumed. +- AddressSpaceType: On an Edge server, the address space type must be SMTP. In the Transport service on a Mailbox server, the address space type might be SMTP, X400, or any other text string. If you omit the address space type, SMTP is assumed. - AddressSpace: For SMTP address space types, the address space that you enter must be RFC 1035-compliant. For example, \*, \*.com, and \*.contoso.com are permitted, but \*contoso.com is not. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such as o=MySite;p=MyOrg;a=adatum;c=us. For all other values of address space type, you can enter any text for the address space. - AddressSpaceCost: The valid input range for the cost is from 1 through 100. A lower cost indicates a better route. This parameter is optional. If you omit the address space cost, a cost of 1 is assumed. If you enter a non-SMTP address space that contains the semicolon character (;), you must specify the address space cost. @@ -108,20 +114,19 @@ If you specify the address space type or the address space cost, you must enclos - "SMTP:contoso.com" - contoso.com -You may specify multiple address spaces by separating the address spaces with commas, for example: contoso.com,fabrikam.com. If you specify the address space type or the address space cost, enclose the address space in quotation marks ("), for example: "contoso.com;2","fabrikam.com;3". +You might specify multiple address spaces by separating the address spaces with commas, for example: contoso.com,fabrikam.com. If you specify the address space type or the address space cost, enclose the address space in quotation marks ("), for example: "contoso.com;2","fabrikam.com;3". If you specify a non-SMTP address space type on a Send connector configured in the Transport service on a Mailbox server, you must configure the following parameters: - The SmartHosts parameter must be set to a value that specifies a smart host. - The DNSRoutingEnabled parameter must be set to $false. -Although you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as third-party fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see [Foreign connectors](https://learn.microsoft.com/exchange/foreign-connectors-exchange-2013-help). +Although you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as non-Microsoft fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see [Foreign connectors](https://learn.microsoft.com/exchange/foreign-connectors-exchange-2013-help). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +136,9 @@ Accept wildcard characters: False ``` ### -AuthenticationCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AuthenticationCredential parameter specifies the username and password that's required to use the connector. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -139,7 +147,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,20 +156,22 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. Valid values are: -- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This is the default value for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. +- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This value is the default for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages. - $false: The connector isn't used for mail flow in hybrid organizations, so any cross-premises headers are removed from messages that flow through the connector. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +181,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + TheComment parameter specifies an optional comment. You must enclose the Comment parameter in quotation marks ("), for example: "this is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +199,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -197,7 +211,6 @@ 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 Required: False Position: Named @@ -207,16 +220,18 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectorType parameter specifies whether the connector is used in hybrid deployments to send messages to Microsoft 365. Valid values are: -- Default: The connector isn't used to send messages to Microsoft 365. This is the default value. +- Default: The connector isn't used to send messages to Microsoft 365. This value is the default. - XPremises: The connector is used to send messages to Microsoft 365. ```yaml Type: TenantConnectorType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -226,6 +241,9 @@ Accept wildcard characters: False ``` ### -ConnectionInactivityTimeOut + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectionInactivityTimeOut parameter specifies the maximum time an idle connection can remain open. The default value is ten 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. @@ -236,7 +254,6 @@ For example, to specify fifteen minutes, set it to 00:15:00. The valid input ran Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,13 +263,15 @@ Accept wildcard characters: False ``` ### -DNSRoutingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DNSRoutingEnabled parameter specifies whether the Send connector uses Domain Name System (DNS) to route mail. Valid values for this parameter are $true or $false. The default value is $true. If you specify a SmartHosts parameter, the DNSRoutingEnabled parameter must be $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,6 +281,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -270,7 +292,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -DomainSecureEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainSecureEnabled parameter is part of the process to enable mutual Transport Layer Security (TLS) authentication for the domains serviced by this Send connector. Mutual TLS authentication functions correctly only when the following conditions are met: - The value of the DomainSecureEnabled parameter must be $true. @@ -299,7 +323,6 @@ The default value for the DomainSecureEnabled parameter is $true for default Sen Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,13 +332,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether to enable the Send connector to process email messages. Valid values are $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,6 +350,9 @@ Accept wildcard characters: False ``` ### -ErrorPolicies + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ErrorPolicies parameter specifies how communication errors are treated. Possible values are the following: - Default: A non-delivery report (NDR) is generated for communication errors. @@ -340,7 +368,6 @@ Specify a value other than Default for this parameter only if this Send connecto Type: ErrorPolicies Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -350,6 +377,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -358,7 +388,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -368,13 +397,15 @@ Accept wildcard characters: False ``` ### -ForceHELO + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForceHELO parameter specifies whether HELO is sent instead of the default EHLO. Valid values are $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -384,6 +415,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Fqdn parameter specifies the FQDN used as the source server for connected messaging servers that use the Send connector to receive outgoing messages. The value of this parameter is displayed to connected messaging servers whenever a source server name is required, as in the following examples: - In the EHLO/HELO command when the Send connector communicates with the next hop messaging server @@ -396,7 +430,6 @@ The default value of the Fqdn parameter is $null. This means the default FQDN va Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,13 +439,15 @@ Accept wildcard characters: False ``` ### -FrontendProxyEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FrontendProxyEnabled parameter routes outbound messages through the CAS server, where destination specific routing, such as DNS or IP address, is set, when the parameter is set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -422,13 +457,15 @@ Accept wildcard characters: False ``` ### -IgnoreSTARTTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreSTARTTLS parameter specifies whether to ignore the StartTLS option offered by a remote sending server. This parameter is used with remote domains. This parameter must be set to $false if the RequireTLS parameter is set to $true. Valid values for this parameter are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -438,6 +475,9 @@ Accept wildcard characters: False ``` ### -IsCoexistenceConnector + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IsCoexistenceConnector parameter specifies whether this Send connector is used for secure mail flow between your on-premises deployment and your Microsoft 365 organization. The default value is $false. @@ -446,7 +486,6 @@ The IsCoexistenceConnector parameter specifies whether this Send connector is us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -456,13 +495,15 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers with the Transport service. When the value of this parameter is $false, the connector can be used by all Mailbox servers in the Exchange organization. When the value of this parameter is $true, the connector can only be used by Transport service on Mailbox servers in the same Active Directory site. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -472,6 +513,9 @@ Accept wildcard characters: False ``` ### -LinkedReceiveConnector + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The LinkedReceiveConnector parameter forces all messages received by the specified Receive connector out through this Send connector. The value of the LinkedReceiveConnector parameter can use any of the following identifiers to specify the Receive connector: @@ -492,7 +536,6 @@ When you use the LinkedReceiveConnector parameter with this command, you must al Type: ReceiveConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -502,6 +545,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxMessageSize parameter specifies the maximum size of a message that can pass through a connector. The default value is 25 MB. When you enter a value, qualify the value with one of the following units: @@ -512,7 +558,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is 0 to 2147483647 bytes. To remove the message size limit on a Send connector, enter a value of unlimited. @@ -520,7 +566,6 @@ The valid input range for this parameter is 0 to 2147483647 bytes. To remove the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -530,13 +575,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the administrator-supplied name of the connector. You must enclose the Name parameter in quotation marks (") if the name contains spaces. For example, "New Send Connector". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -546,13 +593,15 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Port parameter specifies the port number for smart host forwarding, if you specify a value in the SmartHosts parameter. The valid input range is an integer from 0 through 65535. The default value is 25. In most organizations, the port number is set to 25. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -562,13 +611,15 @@ Accept wildcard characters: False ``` ### -ProtocolLoggingLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProtocolLoggingLevel parameter specifies whether to enable protocol logging. Verbose enables protocol logging. None disables protocol logging. The location of the Send connector protocol logs for all Send connectors configured in the Transport service on a Mailbox server or on an Edge server is specified with the SendProtocolLogPath parameter of the Set-TransportService cmdlet. ```yaml Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -578,13 +629,15 @@ Accept wildcard characters: False ``` ### -RequireOorg + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -594,13 +647,15 @@ Accept wildcard characters: False ``` ### -RequireTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequireTLS parameter specifies whether all messages sent through this connector must be transmitted using TLS. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -610,13 +665,15 @@ Accept wildcard characters: False ``` ### -SmartHostAuthMechanism + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SmartHostAuthMechanism parameter specifies the smart host authentication mechanism to use for authentication with a remote server. Use this parameter only when a smart host is configured and the DNSRoutingEnabled parameter is set to $false. Valid values are None, BasicAuth, BasicAuthRequireTLS, ExchangeServer, and ExternalAuthoritative. All values are mutually exclusive. If you select BasicAuth or BasicAuthRequireTLS, you must use the AuthenticationCredential parameter to specify the authentication credential. ```yaml Type: AuthMechanisms Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -626,6 +683,9 @@ Accept wildcard characters: False ``` ### -SmartHosts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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"`. @@ -636,7 +696,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -646,13 +705,15 @@ Accept wildcard characters: False ``` ### -SmtpMaxMessagesPerConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SmtpMaxMessagesPerConnection parameter specifies the maximum number of messages the server can send per connection. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -662,13 +723,15 @@ Accept wildcard characters: False ``` ### -SourceIPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceIPAddress parameter specifies the local IP address to use as the endpoint for an SMTP connection to a remote messaging server. The default IP address is 0.0.0.0. This value means that the server can use any available local IP address. This parameter is valid only for Send connectors configured on an Edge server. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -678,6 +741,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceTransportServers parameter specifies the names of the Mailbox servers that can use this Send connector. This parameter isn't valid for Send connectors configured on an Edge 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"`. @@ -688,7 +754,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -698,6 +763,9 @@ Accept wildcard characters: False ``` ### -TlsAuthLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TlsAuthLevel parameter specifies the TLS authentication level that is used for outbound TLS connections established by this Send connector. Valid values are: - EncryptionOnly: TLS is used only to encrypt the communication channel. No certificate authentication is performed. @@ -710,7 +778,6 @@ You can't specify a value for this parameter if the IgnoreSTARTTLS parameter is Type: TlsAuthLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -720,13 +787,15 @@ Accept wildcard characters: False ``` ### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -736,6 +805,9 @@ Accept wildcard characters: False ``` ### -TlsDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TlsDomain parameter specifies the domain name that the Send connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is used only if the TlsAuthLevel parameter is set to DomainValidation. @@ -749,7 +821,6 @@ A value for this parameter is required if: Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -759,13 +830,15 @@ Accept wildcard characters: False ``` ### -UseExternalDNSServersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseExternalDNSServersEnabled parameter specifies whether this Send connector uses the external DNS list specified by the ExternalDNSServers parameter of the Set-TransportService cmdlet. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -775,13 +848,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-SenderFilterConfig.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-SenderFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SenderFilterConfig.md index 1b634750be..e5828cb5d1 100644 --- a/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SenderFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-senderfilterconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SenderFilterConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-senderfilterconfig +schema: 2.0.0 +title: Set-SenderFilterConfig --- # Set-SenderFilterConfig @@ -37,7 +38,7 @@ Set-SenderFilterConfig [-Action ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +58,15 @@ It adds user1@contoso.com and user2@contoso.com to the blocked senders list with ## PARAMETERS ### -Action + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Action parameter specifies the action that the Sender Filter agent takes on messages from blocked senders or domains. Valid input for this parameter is StampStatus or Reject. The default value is Reject. ```yaml Type: BlockedSenderAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -BlankSenderBlockingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BlankSenderBlockingEnabled parameter blocks or allows messages that don't contain a sender value in the SMTP command MAIL FROM. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -BlockedDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BlockedDomains parameter specifies the domain names to block. When the Sender Filter agent encounters a message from a domain on this list, the Sender Filter agent takes the action specified by the Action parameter. Valid input for this parameter is one or more domains or subdomains. Wildcard characters aren't permitted. For example, if you specify the values contoso.com and marketing.contoso.com, only messages from those domains are blocked by the Sender Filter agent. Messages from sales.contoso.com aren't blocked by the Sender Filter agent. @@ -103,7 +111,6 @@ The maximum number of entries for this parameter is 800. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -BlockedDomainsAndSubdomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BlockedDomainsAndSubdomains parameter specifies the domain names to block. When the Sender Filter agent encounters a message from a domain on this list, or from any of the domain's subdomains, the Sender Filter agent takes the action specified by the Action parameter. Valid input for this parameter is one or more domains. Wildcard characters aren't permitted. For example, if you specify the value contoso.com, messages from contoso.com, sales.contoso.com, and all other subdomains of contoso.com are blocked by the Sender Filter agent. @@ -127,7 +137,6 @@ The maximum number of entries for this parameter is 800. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -BlockedSenders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BlockedSenders parameter specifies one or more SMTP email addresses to block. When the Sender Filter agent encounters a message from a sender on this list, the Sender Filter agent takes the action specified by the Action parameter. 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"`. @@ -149,7 +161,6 @@ The maximum number of entries for this parameter is 800. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +170,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -168,7 +182,6 @@ 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 Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -186,7 +202,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,13 +211,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter enables or disables sender filtering on your Exchange server. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,13 +229,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalMailEnabled parameter enables or disables sender filtering on unauthenticated connections from external messaging servers. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,13 +247,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalMailEnabled parameter enables or disables sender filtering on authenticated connections from authoritative domains in your organization. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -244,6 +265,9 @@ Accept wildcard characters: False ``` ### -RecipientBlockedSenderAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecipientBlockedSenderAction parameter specifies the action that the Sender Filter agent takes on messages received from blocked senders that are defined by SafeList aggregation. SafeList aggregation adds blocked senders that are defined by your users in Microsoft Outlook or Outlook on the web to the Blocked Senders list that's used by the Sender Filter agent. Valid input for this parameter is Delete or Reject. The default value is Reject. @@ -252,7 +276,6 @@ Valid input for this parameter is Delete or Reject. The default value is Reject. Type: RecipientBlockedSenderAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,13 +285,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SenderIdConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-SenderIdConfig.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-SenderIdConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SenderIdConfig.md index eaeddca576..0e2577dcff 100644 --- a/exchange/exchange-ps/exchange/Set-SenderIdConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SenderIdConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-senderidconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SenderIdConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-senderidconfig +schema: 2.0.0 +title: Set-SenderIdConfig --- # Set-SenderIdConfig @@ -36,7 +37,7 @@ Set-SenderIdConfig ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example makes the following modifications to the Sender ID configuration: ## PARAMETERS ### -BypassedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BypassedRecipients parameter specifies one or more SMTP email addresses. Messages bound for the email addresses listed in this parameter are excluded from processing by the Sender ID agent. You can specify multiple values separated by commas. You can enter a maximum of 100 email addresses. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -BypassedSenderDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BypassedSenderDomains parameter specifies one or more domain names. Messages that originate from the domains listed in this parameter are excluded from processing by the Sender ID agent. You can specify multiple values separated by commas. You can enter a maximum of 100 domain names. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -94,7 +102,6 @@ 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 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -112,7 +122,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter specifies whether the Sender ID agent is enabled 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. When the Enabled parameter is set to $true, the Sender ID agent is enabled on the computer on which you're running the command. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalMailEnabled parameter specifies whether all messages from unauthenticated connections external to your organization are passed through the Sender ID 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 external to your organization are passed through the Sender ID agent for processing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalMailEnabled parameter specifies whether all messages from authenticated sender domains that belong to authoritative domains in your enterprise are passed through the Sender ID 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 sender domains that belong to authoritative domains in your enterprise are passed through the Sender ID agent for processing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,13 +185,15 @@ Accept wildcard characters: False ``` ### -SpoofedDomainAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SpoofedDomainAction parameter specifies the action that the Sender ID agent takes on the message when the sender domain shows evidence of being spoofed. The SpoofedDomainAction parameter takes the following values: StampStatus, Reject or Delete. The default value is StampStatus. ```yaml Type: SenderIdAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +203,15 @@ Accept wildcard characters: False ``` ### -TempErrorAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TempErrorAction parameter specifies the action that the Sender ID agent takes on the message when a Sender ID status of TempError is returned. The TempErrorAction parameter takes the following values: StampStatus, Reject or Delete. The default value is StampStatus. ```yaml Type: SenderIdAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,13 +221,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-SenderReputationConfig.md similarity index 79% rename from exchange/exchange-ps/exchange/Set-SenderReputationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SenderReputationConfig.md index 610a9441ff..d31d0a7da9 100644 --- a/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SenderReputationConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-senderreputationconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SenderReputationConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-senderreputationconfig +schema: 2.0.0 +title: Set-SenderReputationConfig --- # Set-SenderReputationConfig @@ -38,7 +39,7 @@ Set-SenderReputationConfig [-Confirm] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,6 +57,9 @@ It sets the number of hours that senders are put on the blocked senders list to ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -65,7 +69,6 @@ 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 Required: False Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -83,7 +89,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,16 +98,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Enabled parameter enables or disables sender reputation on the Exchange server. Valid values are: -- $true: Sender reputation is enabled. This is the default value. +- $true: Sender reputation is enabled. This value is the default. - $false: Sender reputation is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,16 +119,18 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalMailEnabled parameter allows or prevents sender reputation from processing messages from unauthenticated connections that are external to your Exchange organization. Valid values are: -- $true: Sender reputation is enabled on mail from external sources. This is the default value. +- $true: Sender reputation is enabled on mail from external sources. This value is the default. - $false: Sender reputation is disabled on mail from external sources. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,16 +140,18 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalMailEnabled parameter allows or prevents sender reputation from processing messages from authenticated sender domains that are authoritative domains in your Exchange organization. Valid values are: - $true: Sender reputation is enabled on mail from internal sources. -- $false: Sender reputation is disabled on mail from internal sources. This is the default value. +- $false: Sender reputation is disabled on mail from internal sources. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,22 +161,24 @@ Accept wildcard characters: False ``` ### -OpenProxyDetectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OpenProxyDetectionEnabled parameter allows or prevents sender reputation from attempting to connect to the message's source IP address to send a test message back to the Exchange server. This test determines if the sender is an open proxy server. Valid values are: -- $true: Open proxy server detection is enabled. This is the default value. +- $true: Open proxy server detection is enabled. This value is the default. - $false: Open proxy server detection is disabled. Open proxy server detection requires the following open outbound TCP ports in your firewall: 23, 80, 1080, 1081, 3128, and 6588. If your organization uses a proxy server for outbound Internet access, you also need to define the properties of the proxy server by using the ProxyServerName, ProxyServerPort, and ProxyServerType parameters. -The values of the OpenProxyDetectionEnabled and SenderBlockingEnabled parameters can both be set to $true, but they both can't be set to $false. If one value is $true and the other is $false, and you change the $true value to $false, the parameter that was previously $false will automatically change to $true. +The values of the OpenProxyDetectionEnabled and SenderBlockingEnabled parameters can both be set to $true, but they both can't be set to $false. If one value is $true and the other is $false, and you change the $true value to $false, the parameter that was previously $false is automatically changed to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,6 +188,9 @@ Accept wildcard characters: False ``` ### -ProxyServerName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProxyServerName parameter specifies the name or IP address of your organization's proxy server. Sender reputation uses this value to connect to the Internet for open proxy server detection. The default value is blank ($null). To clear this value, use the value $null. @@ -183,7 +199,6 @@ The default value is blank ($null). To clear this value, use the value $null. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +208,9 @@ Accept wildcard characters: False ``` ### -ProxyServerPort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProxyServerPort parameter specifies the port number that's used by your organization's proxy server. Sender reputation uses this value to connect to the Internet for open proxy server detection. The default value is 0. @@ -201,7 +219,6 @@ The default value is 0. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,9 +228,12 @@ Accept wildcard characters: False ``` ### -ProxyServerType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProxyServerType parameter specifies the type of your organization's proxy server. Sender reputation uses this value to connect to the Internet for open proxy server detection. Valid values are: -- None: This is the default value. +- None: This value is the default. - Cisco - HttpConnect - HttpPost @@ -226,7 +246,6 @@ The ProxyServerType parameter specifies the type of your organization's proxy se Type: ProxyType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,20 +255,22 @@ Accept wildcard characters: False ``` ### -SenderBlockingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SenderBlockingEnabled parameter allows or prevents sender reputation from blocking senders when their sender reputation level (SRL) meets or exceeds the value of the SrlBlockThreshold parameter. Valid values are: -- $true: Sender blocking is enabled. This is the default value. +- $true: Sender blocking is enabled. This value is the default. - $false: Sender blocking is disabled. You can temporarily block senders for up to 48 hours when you use the SenderBlockingPeriod parameter. -The values of the OpenProxyDetectionEnabled and SenderBlockingEnabled parameters can both be set to $true, but they both can't be set to $false. If one value is $true and the other is $false, and you change the $true value to $false, the parameter that was previously $false will automatically change to $true. +The values of the OpenProxyDetectionEnabled and SenderBlockingEnabled parameters can both be set to $true, but they both can't be set to $false. If one value is $true and the other is $false, and you change the $true value to $false, the parameter that was previously $false is automatically changed to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,13 +280,15 @@ Accept wildcard characters: False ``` ### -SenderBlockingPeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SenderBlockingPeriod parameter specifies the number of hours that a sender remains on the blocked senders list when their SRL meets or exceeds the value of the SrlBlockThreshold parameter. Valid input for this parameter is an integer from 0 through 48. The default value is 24. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,6 +298,9 @@ Accept wildcard characters: False ``` ### -SrlBlockThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SrlBlockThreshold specifies the SRL rating that must be met or exceeded for sender reputation to block a sender. Valid input for this parameter is an integer from 0 through 9. The default value is 7. Messages are blocked only when the SenderBlockingEnabled parameter is set to $true. @@ -283,7 +309,6 @@ Messages are blocked only when the SenderBlockingEnabled parameter is set to $tr Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +318,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ServerComponentState.md b/exchange/exchange-ps/ExchangePowerShell/Set-ServerComponentState.md similarity index 72% rename from exchange/exchange-ps/exchange/Set-ServerComponentState.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ServerComponentState.md index 94f4d5e415..a128777da6 100644 --- a/exchange/exchange-ps/exchange/Set-ServerComponentState.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ServerComponentState.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-servercomponentstate -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ServerComponentState -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-servercomponentstate +schema: 2.0.0 +title: Set-ServerComponentState --- # Set-ServerComponentState @@ -32,20 +33,38 @@ Set-ServerComponentState [-Identity] -Component -Re ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-ServerComponentState -Component UMCallRouter -Identity MailboxServer01 -Requester Maintenance -State Active +Set-ServerComponentState -Identity MailboxServer01 -Component UMCallRouter -Requester Maintenance -State Active ``` This example sets the Unified Messaging (UM) component state to Active, as requested by maintenance mode. +### Example 2 +```powershell +Set-ServerComponentState -Identity Exch5 -Component ServerWideOffline -State Inactive -Requester Maintenance + +Set-ServerComponentState -Identity Exch5 -Component ServerWideOffline -State Active -Requester Maintenance +``` + +This example prepares the server for maintenance, such as installing a Security Update or Cumulative Update. + +The first command changes the state of all server components to Inactive. + +The second command changes the state to Active after the maintenance is over (required). + +**Note**: By design, the Microsoft Exchange IMAP4 and Microsoft Exchange POP3 services stop if the related `ImapProxy` and `PopProxy` components are in the Inactive state. You might need to manually restart the services after the related `ImapProxy` and `PopProxy` components are changed to the Active state. + ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -57,7 +76,6 @@ The Identity parameter specifies the Exchange server where you want to run this Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,13 +85,15 @@ Accept wildcard characters: False ``` ### -Component + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Component parameter specifies the component or endpoint for which you want to set the state. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -83,6 +103,9 @@ Accept wildcard characters: False ``` ### -Requester + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Requester parameter specifies the system requesting this state change. Valid values are: - HealthAPI @@ -95,7 +118,6 @@ The Requester parameter specifies the system requesting this state change. Valid Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -105,6 +127,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The State parameter specifies the state that you want for the component. Valid values are: - Active @@ -115,7 +140,6 @@ The State parameter specifies the state that you want for the component. Valid v Type: ServiceState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -125,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -134,7 +161,6 @@ 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 Required: False Position: Named @@ -144,6 +170,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -152,7 +181,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,13 +190,15 @@ Accept wildcard characters: False ``` ### -LocalOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LocalOnly switch specifies that the changes are written to the registry of the Exchange server only and not to Active Directory. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,13 +208,15 @@ Accept wildcard characters: False ``` ### -RemoteOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RemoteOnly switch specifies that the changes are written to Active Directory only and not to the registry of the Exchange server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,13 +226,15 @@ Accept wildcard characters: False ``` ### -TimeoutInSeconds + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,13 +244,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ServerMonitor.md b/exchange/exchange-ps/ExchangePowerShell/Set-ServerMonitor.md similarity index 80% rename from exchange/exchange-ps/exchange/Set-ServerMonitor.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ServerMonitor.md index 42b0c4a810..a04cf496f3 100644 --- a/exchange/exchange-ps/exchange/Set-ServerMonitor.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ServerMonitor.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-servermonitor -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ServerMonitor -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-servermonitor +schema: 2.0.0 +title: Set-ServerMonitor --- # Set-ServerMonitor @@ -29,7 +30,7 @@ Set-ServerMonitor [-Server] -Name -Repairing Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -54,7 +58,6 @@ The Server parameter specifies the Exchange server where you want to run this co Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the monitor identity. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Repairing + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Repairing parameter specifies whether to set or clear the repairing property on a monitor. The default value is $true. @@ -88,7 +96,6 @@ The default value is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -107,7 +117,6 @@ 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 Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -TargetResource + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetResource parameter specifies the target resource that you want to set the monitor on. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ServicePrincipal.md b/exchange/exchange-ps/ExchangePowerShell/Set-ServicePrincipal.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-ServicePrincipal.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ServicePrincipal.md index 78b5a30bc0..7b86a39d4c 100644 --- a/exchange/exchange-ps/exchange/Set-ServicePrincipal.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ServicePrincipal.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-serviceprincipal applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Set-ServicePrincipal -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda ms.reviewer: bili1 +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-serviceprincipal +schema: 2.0.0 +title: Set-ServicePrincipal --- # Set-ServicePrincipal @@ -31,7 +33,7 @@ Set-ServicePrincipal [-Identity] ## DESCRIPTION You can use this cmdlet to change the DisplayName only. If AppId/ObjectId is wrong, delete the service principal and create a new one. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +47,9 @@ This example sets the service principal in Exchange Online with the specified di ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the service principal that you want to modify. You can use any value that uniquely identifies the service principal. For example: - Name @@ -57,7 +62,6 @@ The Identity parameter specifies the service principal that you want to modify. Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -67,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -76,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -86,13 +92,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The DisplayName parameter specifies the friendly name of the service principal. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -102,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SettingOverride.md b/exchange/exchange-ps/ExchangePowerShell/Set-SettingOverride.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-SettingOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SettingOverride.md index f038384c37..440f1e77e8 100644 --- a/exchange/exchange-ps/exchange/Set-SettingOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SettingOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-settingoverride -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SettingOverride -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-settingoverride +schema: 2.0.0 +title: Set-SettingOverride --- # Set-SettingOverride @@ -39,7 +40,7 @@ Set-SettingOverride [-Identity] ## DESCRIPTION Setting overrides configure and store Exchange server customizations in Active Directory. The settings can be organization-wide or server-specific, and they persist in Active Directory across Exchange Cumulative Updates (CUs). Exchange customizations in web.config or exe.config XML application configuration files are server-specific, and they're lost when you install the next Exchange CU. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example modifies the setting override named Change OAB Generation on the se ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the setting override that you want to modify. You can use any value that uniquely identifies the override. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the setting override that you want to modify. Y Type: SettingOverrideIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -82,7 +88,6 @@ 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 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -116,7 +126,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -MaxVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxVersion parameter specifies the latest version of Exchange 2016 that this override applies to (up to and including the specified value). Valid input for this parameter is an Exchange 2016 version value in the format 15.1.xxx.xx. You can use values with leading zeros, but the leading zeros are removed from the results. For example, 15.01.0225.042 is stored as 15.1.225.42. @@ -136,7 +148,6 @@ To remove a configured version value so the override applies to all versions of Type: Version Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -MinVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MinVersion parameter specifies the earliest version of Exchange 2016 that this override applies to (up to and including the specified value). Valid input for this parameter is an Exchange 2016 version value in the format 15.1.xxx.xx. You can use values with leading zeros, but the leading zeros are removed from the results. For example, 15.01.0225.042 is stored as 15.1.225.42. @@ -156,7 +170,6 @@ To remove a configured version value so the override applies to all versions of Type: Version Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Parameters parameter specifies one or more parameters for the override that are available for the combination of the Component and Section parameter values. This parameter uses the syntax: `@("Parameter1=Value1","Parameter2=Value2"...)`. For example: - `@("Enabled=true")` @@ -175,7 +191,6 @@ The Parameters parameter specifies one or more parameters for the override that Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,13 +200,15 @@ Accept wildcard characters: False ``` ### -Reason + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Reason parameter is used to provide a description of why the override was created. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,6 +218,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the name of the Exchange 2016 server where you want the override applied. You can specify a single Exchange 2016 server name, or an array of Exchange 2016 server name wildcards. For example, if you have three Exchange 2016 servers named Exchange01, Exchange02 and Exchange03, specify the value Exchange\* to apply the override to all of them. To remove the specified server so the override applies to all Exchange 2016 servers in the Active Directory forest, use the value $null. @@ -209,7 +229,6 @@ To remove the specified server so the override applies to all Exchange 2016 serv Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,13 +238,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SharingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-SharingPolicy.md similarity index 76% rename from exchange/exchange-ps/exchange/Set-SharingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SharingPolicy.md index 5f5182f760..6801283c4d 100644 --- a/exchange/exchange-ps/exchange/Set-SharingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SharingPolicy.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-sharingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-SharingPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-sharingpolicy +schema: 2.0.0 +title: Set-SharingPolicy --- # Set-SharingPolicy ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-SharingPolicy cmdlet to modify existing sharing policies that control how users inside your organization can share free/busy and contact information with users outside your organization. @@ -33,9 +34,9 @@ Set-SharingPolicy [-Identity] ``` ## DESCRIPTION -Users can only share free/busy and contact information after federation has been configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing options for the mailbox. +Users can only share free/busy and contact information after federation is configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing options for the mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,6 +64,9 @@ This example disables the sharing policy SharingPolicy01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the sharing policy that you want to modify. You can use one of the following values: - ADObjectID @@ -74,7 +78,6 @@ The Identity parameter specifies the identity of the sharing policy that you wan Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -93,7 +99,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -103,15 +108,17 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Default switch specifies that the sharing policy is the default sharing policy for all mailboxes. You don't need to specify a value with this switch. -If no sharing policy has been applied to a mailbox, the default policy is automatically applied. If you want to disable sharing across your organization, you disable the default policy. +If no sharing policy is applied to a mailbox, the default policy is automatically applied. If you want to disable sharing across your organization, you disable the default policy. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -129,7 +139,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -Domains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Domains parameter specifies the domains and the associated sharing options for those domains in the sharing policy. Values for this parameter use the basic syntax: `'Domain: SharingPolicyAction'`. You can use the following values for `Domain`: @@ -160,7 +172,6 @@ You can specify multiple `'Domain: SharingPolicyAction'` values separated by com Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Enabled parameter specifies whether to enable the sharing policy. Valid values for this parameter are $true or $false. The default is $true. When the sharing policy is disabled, users who are provisioned to use this policy continue to share information until the sharing policy assistant runs. @@ -178,7 +192,6 @@ When the sharing policy is disabled, users who are provisioned to use this polic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,13 +201,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the unique name of the sharing policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -204,13 +219,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SiteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-SiteMailbox.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-SiteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SiteMailbox.md index c9c67e224a..19c2ab872a 100644 --- a/exchange/exchange-ps/exchange/Set-SiteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SiteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-sitemailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SiteMailbox -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-sitemailbox +schema: 2.0.0 +title: Set-SiteMailbox --- # Set-SiteMailbox @@ -40,7 +41,7 @@ Set-SiteMailbox [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,6 +62,9 @@ This example disables the duplication of email messages in the site mailbox SMO\ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the site mailbox. You can use any value that uniquely identifies the site mailbox. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the identity of the site mailbox. You can use a Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -Active + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Active parameter specifies whether to change the site mailbox's lifecycle status. This parameter accepts $true or $false. This parameter is intended for use only by the user interface. We recommend that you don't use this parameter in the Exchange Management Shell. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -109,7 +117,6 @@ 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 Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DisplayName parameter specifies the display name of the site mailbox. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -159,7 +173,6 @@ 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 Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is intended for use only by the user interface. We recommend that you don't use this parameter. The Members parameter specifies the members of the site mailbox. You can add or remove members using this parameter. @@ -188,7 +204,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -Owners + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is intended for use only by the user interface. We recommend that you don't use this parameter. The Owners parameter specifies the owners of the site mailbox. You can add or remove owners using this parameter. @@ -217,7 +235,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,13 +244,15 @@ Accept wildcard characters: False ``` ### -RemoveDuplicateMessages -The RemoveDuplicateMessages parameter specifies that when users post messages to a site mailbox, duplicate messages will be deleted. This parameter accepts the values of $true or $false. The default value is $false. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The RemoveDuplicateMessages parameter specifies that when users post messages to a site mailbox, duplicate messages are deleted. This parameter accepts the values of $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,13 +262,15 @@ Accept wildcard characters: False ``` ### -SharePointUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SharePointUrl parameter specifies the URL of the SharePoint site, for example, "https://myserver/teams/edu". ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,15 +280,17 @@ Accept wildcard characters: False ``` ### -ShowInMyClient + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is intended for use only by the user interface. We recommend that you don't use this parameter. -The ShowInMyClient parameter specifies that the site mailbox folder will show in your email client. +The ShowInMyClient parameter specifies that the site mailbox folder appears in your email client. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,6 +300,9 @@ Accept wildcard characters: False ``` ### -SyncEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SyncEnabled parameter specifies whether to enable or disable synchronization for the site mailbox. Valid values are: - $true: Synchronization is enabled. @@ -286,7 +312,6 @@ The SyncEnabled parameter specifies whether to enable or disable synchronization Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,13 +321,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-SiteMailboxProvisioningPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SiteMailboxProvisioningPolicy.md index 460a831c41..868f1e990d 100644 --- a/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SiteMailboxProvisioningPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-sitemailboxprovisioningpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SiteMailboxProvisioningPolicy -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-sitemailboxprovisioningpolicy +schema: 2.0.0 +title: Set-SiteMailboxProvisioningPolicy --- # Set-SiteMailboxProvisioningPolicy @@ -40,7 +41,7 @@ Set-SiteMailboxProvisioningPolicy [-Identity] ## DESCRIPTION Site mailbox provisioning policies apply settings to new site mailboxes that you create. You can create multiple site mailbox provisioning policies, but only the default policy is followed when users create site mailboxes. The default site mailbox provisioning policy is named Default. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,6 +69,9 @@ This example changes the default provisioning policy named SM\_DefaultPolicy and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the site mailbox provisioning policy that you want to edit. You can use any value that uniquely identifies the policy. For example: - Name @@ -78,7 +82,6 @@ The Identity parameter specifies the identity of the site mailbox provisioning p Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,16 +91,18 @@ Accept wildcard characters: False ``` ### -AliasPrefix + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AliasPrefix parameter specifies the custom text prefix to add to the aliases of new site mailboxes. Valid values are: - A text string that's 8 characters or less. When you specify a text value, the value of the DefaultAliasPrefixEnabled parameter ignored and aliases get the text prefix you specified. -- The value $null. This is the default value. The results of this value depend on the DefaultAliasPrefixEnabled parameter value. When it's $true, aliases get the default prefix text. When it's $false, aliases don't get any prefix text. +- The value $null. This value is the default. The results of this value depend on the DefaultAliasPrefixEnabled parameter value. When it's $true, aliases get the default prefix text. When it's $false, aliases don't get any prefix text. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -116,7 +124,6 @@ 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 Required: False Position: Named @@ -126,9 +133,12 @@ Accept wildcard characters: False ``` ### -DefaultAliasPrefixEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DefaultAliasPrefixEnabled parameter specifies whether new site mailboxes have the default prefix text added to the alias. Valid values are: -- $true: Aliases get the default prefix text. This is the default value. In Microsoft 365, the default prefix text is `SMO-` (for example, the alias value `BugBash_2016` becomes `SMO-BugBash_2016`). In on-premises Exchange, the default prefix text is `SM-` (for example, the alias value `BugBash_2016` becomes `SM-BugBash_2016`). +- $true: Aliases get the default prefix text. This value is the default. In Microsoft 365, the default prefix text is `SMO-` (for example, the alias value `BugBash_2016` becomes `SMO-BugBash_2016`). In on-premises Exchange, the default prefix text is `SM-` (for example, the alias value `BugBash_2016` becomes `SM-BugBash_2016`). - $false: Aliases don't get the default prefix text. The value of this parameter is related to the value of the AliasPrefix parameter. If you specify a text string for AliasPrefix, the DefaultAliasPrefixEnabled value is ignored. Specifying a text value for AliasPrefix automatically sets the value to $false, but even if you set it to $true, the default alias prefix text isn't used. @@ -137,7 +147,6 @@ The value of this parameter is related to the value of the AliasPrefix parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsDefault switch specifies that the site mailbox provisioning policy is the default policy. You don't need to specify a value with this switch. You can have multiple policies, but only the default policy is followed when users create site mailboxes. @@ -171,7 +185,6 @@ You can have multiple policies, but only the default policy is followed when use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +194,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -191,7 +207,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The IssueWarningQuota value must be less than or equal to the ProhibitSendReceiveQuota value. @@ -201,7 +217,6 @@ The default value is 49 GB. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,6 +226,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the site mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -220,7 +238,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the value unlimited. The default value is 36 MB. @@ -228,7 +246,6 @@ A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the val Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,13 +255,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name of the site mailbox provisioning policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,6 +273,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -264,7 +286,7 @@ A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or t - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value must be greater than or equal to the ProhibitSendQuota or IssueWarningQuota values. @@ -274,7 +296,6 @@ The default value is 50 GB. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,13 +305,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SmimeConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-SmimeConfig.md similarity index 77% rename from exchange/exchange-ps/exchange/Set-SmimeConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SmimeConfig.md index 9c7b0865ae..b8158b73ae 100644 --- a/exchange/exchange-ps/exchange/Set-SmimeConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SmimeConfig.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-smimeconfig -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-SmimeConfig -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-smimeconfig +schema: 2.0.0 +title: Set-SmimeConfig --- # Set-SmimeConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. -Use the Set-SmimeConfig cmdlet to modify the S/MIME configuration for Outlook on the web (formerly known as Outlook Web App). +Use the Set-SmimeConfig cmdlet to modify the S/MIME configuration for Outlook on the web (formerly known as Outlook Web App or OWA) and new Outlook for Windows. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -47,6 +48,7 @@ Set-SmimeConfig [[-Identity] ] [-OWATripleWrapSignedEncryptedMail ] [-OWAUseKeyIdentifier ] [-OWAUseSecondaryProxiesWhenFindingCertificates ] + [-NoSignOnReply ] [-SMIMECertificateIssuingCA ] [-WhatIf] [] @@ -55,7 +57,7 @@ Set-SmimeConfig [[-Identity] ] ## DESCRIPTION The Set-SmimeConfig cmdlet can change several important parameters than can reduce the overall level of message security. Review your organization's security policy before you make any changes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,13 +71,15 @@ This example sets the S/MIME configuration to allow users the choice of signing ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -85,13 +89,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -101,6 +107,9 @@ Accept wildcard characters: False ``` ### -OWAAllowUserChoiceOfSigningCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAAllowUserChoiceOfSigningCertificate parameter specifies whether to allow users to select the certificate to use when they digitally sign email messages in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -109,7 +118,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -119,6 +127,9 @@ Accept wildcard characters: False ``` ### -OWAAlwaysEncrypt + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAAlwaysEncrypt parameter specifies whether all outgoing messages are automatically encrypted in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -127,7 +138,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -137,6 +147,9 @@ Accept wildcard characters: False ``` ### -OWAAlwaysSign + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAAlwaysSign parameter specifies whether all outgoing messages are automatically signed in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -145,7 +158,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -155,9 +167,12 @@ Accept wildcard characters: False ``` ### -OWABCCEncryptedEmailForking + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWABCCEncryptedEmailForking parameter specifies how Bcc messages are encrypted in Outlook on the web. Valid values are: -- 0: One encrypted message per Bcc recipient. This is the default value. +- 0: One encrypted message per Bcc recipient. This value is the default. - 1: One single encrypted message for all Bcc recipients. - 2: One encrypted message without Bcc forking. @@ -167,7 +182,6 @@ This setting affects the security and privacy of Outlook on the web. Consult you Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -177,16 +191,18 @@ Accept wildcard characters: False ``` ### -OWACheckCRLOnSend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWACheckCRLOnSend parameter specifies how the certificate revocation list (CRL) check is enforced when an email message is sent in Outlook on the web. Valid values are: - $true: When the CRL distribution point is inaccessible, Outlook on the web displays a warning dialog box and prevents signed or encrypted messages from being sent. -- $false: When the CRL distribution point is inaccessible, Outlook on the web allows signed or encrypted messages to be sent. This is the default value. +- $false: When the CRL distribution point is inaccessible, Outlook on the web allows signed or encrypted messages to be sent. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -196,9 +212,12 @@ Accept wildcard characters: False ``` ### -OWAClearSign + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAClearSign parameter specifies how email messages are signed in Outlook on the web. Valid values are: -- $true: Digitally signed messages are clear-signed. This is the default value. +- $true: Digitally signed messages are clear-signed. This value is the default. - $false: digitally signed messages are opaque-signed. Clear-signed messages are larger than opaque-signed messages, but clear-signed messages can be read in most email clients, including clients that don't support S/MIME. @@ -207,7 +226,6 @@ Clear-signed messages are larger than opaque-signed messages, but clear-signed m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -217,13 +235,15 @@ Accept wildcard characters: False ``` ### -OWACopyRecipientHeaders + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -233,6 +253,9 @@ Accept wildcard characters: False ``` ### -OWACRLConnectionTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWACRLConnectionTimeout parameter specifies the time in milliseconds that Outlook on the web waits while connecting to retrieve a single CRL as part of a certificate validation operation. A valid value is an integer between 0 and 4294967295 (UInt32). The default value is 60000 (60 seconds). @@ -243,7 +266,6 @@ When multiple CRLs in a certificate chain must be retrieved, the time limit that Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -253,6 +275,9 @@ Accept wildcard characters: False ``` ### -OWACRLRetrievalTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWACRLRetrievalTimeout parameter specifies the time in milliseconds that Outlook on the web waits to retrieve all CRLs when validating a certificate. VA valid value is an integer between 0 and 4294967295 (UInt32). The default value is 10000 (10 seconds). @@ -263,7 +288,6 @@ If all the required CRLs are not retrieved before the time limit expires, the op Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -273,10 +297,13 @@ Accept wildcard characters: False ``` ### -OWADisableCRLCheck + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWADisableCRLCheck parameter enables or disables CRL checking in Outlook on the web. Valid values are: - $true: CRL checks are disabled when validating certificates. -- $false: CRL checks are enabled when validating certificates.This is the default value. +- $false: CRL checks are enabled when validating certificates.This value is the default. Disabling CRL checking can decrease the time that's required to validate the signatures of signed email messages, but it also validates email messages that are signed with revoked certificates. @@ -284,7 +311,6 @@ Disabling CRL checking can decrease the time that's required to validate the sig Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -294,6 +320,9 @@ Accept wildcard characters: False ``` ### -OWADLExpansionTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWADLExpansionTimeout parameter specifies the time in milliseconds that Outlook on the web waits when sending encrypted messages to members of a distribution group that requires expansion. A valid value is an integer between 0 and 4294967295 (UInt32). The default value is 60000 (60 seconds). If the operation doesn't complete in the time specified by this parameter, the operation fails and the message is not sent. @@ -306,7 +335,6 @@ The timeout value that's specified by this parameter is applied to the expansion Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -316,6 +344,9 @@ Accept wildcard characters: False ``` ### -OWAEncryptionAlgorithms + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAEncryptionAlgorithms parameter specifies a list of symmetric encryption algorithms that are used by Outlook on the web to encrypt messages. Valid values are: - 6601: DES (56-bit) @@ -323,9 +354,9 @@ The OWAEncryptionAlgorithms parameter specifies a list of symmetric encryption a - 6603: 3DES (168-bit) - 660E: AES128 - 660F: AES192 -- 6610: AES256 (This is the default value) +- 6610: AES256 (default value) -If you use a third-party cryptographic service provider (CSP), you need to specify the object identifier (OID) together with an algorithm ID (Outlook on the web needs an algorithm ID to infer how the algorithm should be used). For example, to provide a custom replacement for the 3DES algorithm, use the value `6603,`. +If you use a non-Microsoft cryptographic service provider (CSP), you need to specify the object identifier (OID) together with an algorithm ID (Outlook on the web needs an algorithm ID to infer how the algorithm should be used). For example, to provide a custom replacement for the 3DES algorithm, use the value `6603,`. This parameter uses the syntax `` or `RC2:` or `,`. You can specify multiple values separated by semicolons (;). For example, to set the encryption algorithms to 3DES, RC2-128, RC2-64, DES, and RC2-56, use the following value: `6603;6602:128;6602:64;6601;6602:56`. @@ -335,7 +366,6 @@ If the parameter is not specified or is not formatted correctly, Outlook on the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -345,9 +375,12 @@ Accept wildcard characters: False ``` ### -OWAEncryptTemporaryBuffers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAEncryptTemporaryBuffers parameter specifies whether the Outlook on the web client-side temporary message storage buffers are encrypted. Valid values are: -- $true: All client-side temporary buffers that store message data are encrypted using an ephemeral key and the 3DES algorithm. This is the default value. +- $true: All client-side temporary buffers that store message data are encrypted using an ephemeral key and the 3DES algorithm. This value is the default. - $false: Temporary buffer encryption is disabled. Disabling encryption of the buffers can increase performance of the Outlook on the web client but also leaves information unencrypted in the client's buffer. Consult your organization's security policy before you disable this feature. @@ -356,7 +389,6 @@ Disabling encryption of the buffers can increase performance of the Outlook on t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -366,16 +398,18 @@ Accept wildcard characters: False ``` ### -OWAForceSMIMEClientUpgrade + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAForceSMIMEClientUpgrade parameter specifies whether or not users are forced to upgrade an S/MIME control that's older than their current version in Outlook on the web. -- $true: Users need to download and install the new control before they can use S/MIME. This is the default value. +- $true: Users need to download and install the new control before they can use S/MIME. This value is the default. - $false: Users receive a warning if the S/MIME control on their computer is not current, but they can still use S/MIME without updating the control. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -385,6 +419,9 @@ Accept wildcard characters: False ``` ### -OWAIncludeCertificateChainAndRootCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAIncludeCertificateChainAndRootCertificate parameter specifies whether the certificate chains and root certificates of the signing or encryption certificates are included in the message in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -393,7 +430,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -403,16 +439,18 @@ Accept wildcard characters: False ``` ### -OWAIncludeCertificateChainWithoutRootCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAIncludeCertificateChainWithoutRootCertificate parameter specifies whether the certificate chains of the signing or encryption certificates are included in messages in Outlook on the web. Valid values are: - $true: Signed or encrypted messages include the full certificate chain, but not the root certificate. -- $false: Signed or encrypted messages include only the signing and encrypting certificates, not their corresponding certificate chains. This is the default value. +- $false: Signed or encrypted messages include only the signing and encrypting certificates, not their corresponding certificate chains. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -422,17 +460,19 @@ Accept wildcard characters: False ``` ### -OWAIncludeSMIMECapabilitiesInMessage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAIncludeSMIMECapabilitiesInMessage parameter specifies whether signed and encrypted messages in Outlook on the web include attributes that describe the supported encryption and signing algorithms. Valid input for this parameter is $true or $false. The default is $false. -Enabling this option increases the size of messages, but may make it easier for some email clients to interact with encrypted messages in Outlook on the web. +Enabling this option increases the size of messages, but might make it easier for some email clients to interact with encrypted messages in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -442,17 +482,19 @@ Accept wildcard characters: False ``` ### -OWAOnlyUseSmartCard + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAOnlyUseSmartCard parameter specifies whether smartcard-based certificates are required for Outlook on the web message signing and decryption. Valid values are: $true: Smartcard-based certificates for signing and decryption are required when you use Outlook on the web and the S/MIME control. -$false: Smartcard-based certificates for signing and decryption aren't required when you use Outlook on the web and the S/MIME control. This is the default value. +$false: Smartcard-based certificates for signing and decryption aren't required when you use Outlook on the web and the S/MIME control. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -462,6 +504,9 @@ Accept wildcard characters: False ``` ### -OWASenderCertificateAttributesToDisplay + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWASenderCertificateAttributesToDisplay parameter controls which certificate attributes are displayed when signature verification proceeds despite a mismatch between the sender's email address and the email address in sender's certificate. The parameter accepts a comma-separated list of object identifiers (OIDs). This setting is blank ($null) by default. @@ -470,7 +515,6 @@ The parameter accepts a comma-separated list of object identifiers (OIDs). This Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -480,9 +524,12 @@ Accept wildcard characters: False ``` ### -OWASignedEmailCertificateInclusion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWASignedEmailCertificateInclusion parameter specifies whether the sender's encryption certificate is excluded from a signed email message in Outlook on the web. Valid values are: -- $true: Outlook on the web and the S/MIME control include both signing and encrypting certificates with signed email messages. This is the default value. +- $true: Outlook on the web and the S/MIME control include both signing and encrypting certificates with signed email messages. This value is the default. - $false: Outlook on the web and the S/MIME control do not include signing and encrypting certificates with signed email messages. When you don't include the certificates with signed email messages, the size of encrypted messages is reduced. However, recipients don't have access to the sender's encryption certificate in the message. Recipients need to retrieve the certificate from a directory, or from the sender. @@ -491,7 +538,6 @@ When you don't include the certificates with signed email messages, the size of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -501,15 +547,18 @@ Accept wildcard characters: False ``` ### -OWASigningAlgorithms + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWASigningAlgorithms parameter specifies the list of symmetric encryption signing algorithms that are used by Outlook on the web to sign messages with the S/MIME control. Valid values are: - 8003: CALG\_MD5 or 128-bit MD5 - 800E: CALG\_SHA\_512 or 512-bit Secure Hash Algorithm (SHA) - 800D: CALG\_SHA\_384 or 384-bit SHA - 800C: CALG\_SHA\_256 or 256-bit SHA -- 8004: SHA1 or 160-bit SHA-1 (This is the default value) +- 8004: SHA1 or 160-bit SHA-1 (default value) -If you use a third-party cryptographic service provider (CSP), you need to specify the object identifier (OID) together with an algorithm ID (Outlook on the web needs an algorithm ID to infer how the algorithm should be used). For example, to provide a custom replacement for the SHA1 algorithm, use the value `8804,`. +If you use a non-Microsoft cryptographic service provider (CSP), you need to specify the object identifier (OID) together with an algorithm ID (Outlook on the web needs an algorithm ID to infer how the algorithm should be used). For example, to provide a custom replacement for the SHA1 algorithm, use the value `8804,`. This parameter uses the syntax `` or `:` or `,`. You can specify multiple values separated by semicolons (;). @@ -521,7 +570,6 @@ If this parameter is not specified or is not formatted correctly, Outlook on the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -531,10 +579,13 @@ Accept wildcard characters: False ``` ### -OWATripleWrapSignedEncryptedMail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWATripleWrapSignedEncryptedMail parameter specifies whether signed and encrypted email messages in Outlook on the web are triple-wrapped. Valid values are: - $true: A signed message is encrypted, and then the encrypted message is signed (signed-encrypted-signed). -- $false: A signed message is encrypted only (there is no additional signing of the encrypted message). This is the default value. +- $false: A signed message is encrypted only (there is no additional signing of the encrypted message). This value is the default. Triple-wrapped messages offer the highest level of security for messages under the S/MIME standard, but are larger in size. @@ -542,7 +593,6 @@ Triple-wrapped messages offer the highest level of security for messages under t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -552,6 +602,9 @@ Accept wildcard characters: False ``` ### -OWAUseKeyIdentifier + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAUseKeyIdentifier parameter specifies whether a certificate's key identifier is used to encode the asymmetrically encrypted token in Outlook on the web. Valid input for this parameter is $true or $false. The default is $false. @@ -564,7 +617,6 @@ This parameter causes the use of a certificate's key identifier when encoding th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -574,17 +626,19 @@ Accept wildcard characters: False ``` ### -OWAUseSecondaryProxiesWhenFindingCertificates + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OWAUseSecondaryProxiesWhenFindingCertificates parameter specifies whether alternative proxies are used during the certificate search in Outlook on the web. Valid input for this parameter is $true or $false. The default is $true. -Outlook on the web attempts to find the correct certificate for a recipient when sending encrypted messages. The certificate subject or subject alternative name values can each contain an email address. Because a recipient can have multiple proxy addresses, the certificate's subject or subject alternative name values may not match the recipient's primary SMTP address. When this parameter is set to $true, and the certificate subject or subject alternative name values do not match the recipient's primary SMTP address, Outlook on the web tries to match the certificate's subject to one of the recipient's proxy addresses. +Outlook on the web attempts to find the correct certificate for a recipient when sending encrypted messages. The certificate subject or subject alternative name values can each contain an email address. Because a recipient can have multiple proxy addresses, the certificate's subject or subject alternative name values might not match the recipient's primary SMTP address. When this parameter is set to $true, and the certificate subject or subject alternative name values do not match the recipient's primary SMTP address, Outlook on the web tries to match the certificate's subject to one of the recipient's proxy addresses. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -593,7 +647,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NoSignOnReply + +> Applicable: Exchange Online + +This parameter is available only in the cloud-based service. + +This parameter applies only to new Outlook for Windows. It doesn't apply to Outlook on the web. + +The NoSignOnReply parameter specifies whether S/MIME signatures are inherited in Reply and Reply all messages. Valid values are: + +- $true: Reply and Reply all messages don't inherit S/MIME signatures. If incoming email has S/MIME encryption and signature attached, only encryption is inherited. Signature isn't inherited. +- $false: Reply and Reply all messages inherit S/MIME signatures. Users need to go to S/MIME settings and remove S/MIME signature to remove the inherited signature. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SMIMECertificateIssuingCA + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SMIMECertificateIssuingCA parameter specifies the serialized certificate store (SST) that contains the Certificate Authority (CA) signing and intermediate certificate information. 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`). @@ -604,7 +686,6 @@ Each certificate is checked, and if any certificates are expired, the operation Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -614,13 +695,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewPolicyV2.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewPolicyV2.md index 6604ef88d6..36033766e8 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewPolicyV2.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-supervisoryreviewpolicyv2 applicable: Security & Compliance -title: Set-SupervisoryReviewPolicyV2 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-supervisoryreviewpolicyv2 +schema: 2.0.0 +title: Set-SupervisoryReviewPolicyV2 --- # Set-SupervisoryReviewPolicyV2 @@ -29,6 +30,7 @@ Set-SupervisoryReviewPolicyV2 [-Identity] [-Force] [-PolicyRBACScopes ] [-PolicyTemplate ] + [-PreservationPeriodInDays ] [-RemoveReviewers ] [-RetentionPeriodInDays ] [-Reviewers ] @@ -52,6 +54,9 @@ This example adds reviewers and updates the comment for the supervisory review p ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the supervisory review policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -62,7 +67,6 @@ The Identity parameter specifies the supervisory review policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -AddReviewers + +> Applicable: Security & Compliance + The AddReviewers parameter specifies the SMTP addresses of reviewers to add to the supervisory review policy. You can specify multiple email addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -88,13 +94,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + 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 @@ -104,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -113,7 +124,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -123,13 +133,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + {{ Fill Enabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -139,6 +151,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + 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. @@ -147,7 +162,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -157,13 +171,15 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + {{ Fill PolicyRBACScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All)) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -173,13 +189,33 @@ Accept wildcard characters: False ``` ### -PolicyTemplate + +> Applicable: Security & Compliance + {{ 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 + +> Applicable: Security & Compliance + +{{ Fill PreservationPeriodInDays Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -189,13 +225,15 @@ Accept wildcard characters: False ``` ### -RemoveReviewers + +> Applicable: Security & Compliance + 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. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -205,13 +243,15 @@ Accept wildcard characters: False ``` ### -RetentionPeriodInDays -The RetentionPeriodInDays parameter specifies the number of days that the messages will be retained for review. + +> Applicable: Security & Compliance + +The RetentionPeriodInDays parameter specifies the number of days that the messages are retained for review. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -221,6 +261,9 @@ Accept wildcard characters: False ``` ### -Reviewers + +> Applicable: Security & Compliance + The Reviewers parameter specifies the SMTP addresses of the reviewers for the supervisory review policy. You can specify multiple email addresses separated by commas. The reviewers that you specify with this parameter replace the existing reviewers. To selectively add or remove reviewers, use the AddReviewers and RemoveReviewers parameters. @@ -229,7 +272,6 @@ The reviewers that you specify with this parameter replace the existing reviewer Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -239,13 +281,15 @@ Accept wildcard characters: False ``` ### -UserReportingWorkloads + +> Applicable: Security & Compliance + {{ Fill UserReportingWorkloads Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -255,13 +299,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewRule.md index e3f1d28903..205cc6424b 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-supervisoryreviewrule applicable: Security & Compliance -title: Set-SupervisoryReviewRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-supervisoryreviewrule +schema: 2.0.0 +title: Set-SupervisoryReviewRule --- # Set-SupervisoryReviewRule @@ -20,30 +21,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 +41,7 @@ Set-SupervisoryReviewRule [-IncludeAdaptiveScopes ] [-InPurviewFilter ] [-Ocr ] + [-PolicyRBACScopes ] [-SamplingRate ] [-SentTo ] [-WhatIf] @@ -85,6 +66,9 @@ This example modifies the existing rule named EU Brokers Rule with the following ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the supervisory review rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -93,9 +77,8 @@ 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 Required: True Position: 1 @@ -104,14 +87,34 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AdvancedRule + +> Applicable: Security & Compliance + +{{ Fill AdvancedRule Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CcsiDataModelOperator + +> Applicable: Security & Compliance + {{ Fill CcsiDataModelOperator Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -121,6 +124,9 @@ Accept wildcard characters: False ``` ### -Condition + +> Applicable: Security & Compliance + The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: - User or group communications to supervise: `"((Reviewee:) -OR (Reviewee:)...)"`. Exceptions use the syntax `"(NOT((Reviewee:) -OR (Reviewee:)...))"`. @@ -137,7 +143,6 @@ The Condition parameter specifies the conditions and exceptions for the rule. Th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -147,6 +152,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -156,7 +164,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -166,13 +173,15 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + {{ Fill ContentContainsSensitiveInformation Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -182,13 +191,15 @@ Accept wildcard characters: False ``` ### -ContentMatchesDataModel + +> Applicable: Security & Compliance + {{ Fill ContentMatchesDataModel Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -198,13 +209,15 @@ Accept wildcard characters: False ``` ### -ContentSources + +> Applicable: Security & Compliance + {{ Fill ContentSources Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -214,13 +227,15 @@ Accept wildcard characters: False ``` ### -DayXInsights + +> Applicable: Security & Compliance + {{ Fill DayXInsights Description }} ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -230,13 +245,15 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + {{ Fill ExceptIfFrom Description }} ```yaml Type: MultiValuedProperty -Parameter Sets: Default +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -246,13 +263,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfRecipientDomainIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -262,13 +281,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRevieweeIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfRevieweeIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -278,13 +299,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfSenderDomainIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -294,13 +317,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + {{ Fill ExceptIfSentTo Description }} ```yaml Type: MultiValuedProperty -Parameter Sets: Default +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -310,13 +335,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Security & Compliance + {{ Fill ExceptIfSubjectOrBodyContainsWords Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -326,13 +353,15 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + {{ Fill From Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -342,13 +371,15 @@ Accept wildcard characters: False ``` ### -IncludeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill IncludeAdaptiveScopes Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -358,13 +389,15 @@ Accept wildcard characters: False ``` ### -InPurviewFilter + +> Applicable: Security & Compliance + {{ Fill InPurviewFilter Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -374,13 +407,33 @@ Accept wildcard characters: False ``` ### -Ocr + +> Applicable: Security & Compliance + {{ Fill Ocr Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes + +> Applicable: Security & Compliance + +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -390,13 +443,15 @@ Accept wildcard characters: False ``` ### -SamplingRate + +> Applicable: Security & Compliance + The SamplingRate parameter specifies the percentage of communications for review. If you want reviewers to review all detected items, use the value 100. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -406,13 +461,15 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + {{ Fill SentTo Description }} ```yaml Type: MultiValuedProperty -Parameter Sets: Default +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -422,13 +479,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-SweepRule.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SweepRule.md index 184a02c1af..e28e857498 100644 --- a/exchange/exchange-ps/exchange/Set-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SweepRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-sweeprule -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-SweepRule -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-sweeprule +schema: 2.0.0 +title: Set-SweepRule --- # Set-SweepRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-SweepRule cmdlet to modify Sweep rules in mailboxes. @@ -41,7 +42,7 @@ Set-SweepRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ This example modifies the existing rule that has the rule ID value x2hlsdpGmUifj ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the Sweep rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). @@ -67,7 +71,6 @@ You can get these identity values by using the Get-SweepRule cmdlet. Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -86,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -DestinationFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -117,7 +125,6 @@ Example values for this parameter are `john@contoso.com:\Unimportant` or `John:\ Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -135,7 +145,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,13 +154,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFlagged + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: @@ -186,7 +200,6 @@ The typical message flag values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -ExceptIfPinned + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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: @@ -207,7 +223,6 @@ 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 Required: False Position: Named @@ -217,6 +232,9 @@ Accept wildcard characters: False ``` ### -KeepForDays + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The KeepForDays parameter specifies an action for the Sweep rule that specifies the number of days to keep messages that match the conditions of the rule. After the number of days have passed, the messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). You can't use this parameter with the KeepLatest parameter, and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. @@ -225,7 +243,6 @@ You can't use this parameter with the KeepLatest parameter, and the Sweep rule m Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -235,6 +252,9 @@ Accept wildcard characters: False ``` ### -KeepLatest + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The KeepLatest parameter specifies an action for the Sweep rule that specifies the number of messages to keep that match the conditions of the rule. After the number of messages is exceeded, the oldest messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). You can't use this parameter with the KeepForDays parameter, and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. @@ -243,7 +263,6 @@ You can't use this parameter with the KeepForDays parameter, and the Sweep rule Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -253,6 +272,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox that contains the rule you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -270,7 +292,6 @@ The Mailbox parameter specifies the mailbox that contains the rule you want to m Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -280,13 +301,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Name parameter specifies the name of the Sweep rule. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -296,6 +319,9 @@ Accept wildcard characters: False ``` ### -Provider + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Provider parameter specifies the provider for the Sweep rule. If the value contains spaces, enclose the value in quotation marks. For Sweep rules that you create in Outlook on the web, the default value is Exchange16. @@ -304,7 +330,6 @@ For Sweep rules that you create in Outlook on the web, the default value is Exch Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -314,6 +339,9 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Sender parameter specifies a condition for the Sweep rule that looks for the specified sender in messages. For internal senders, you can use any value that uniquely identifies the sender. For example: - Name @@ -329,7 +357,6 @@ For external senders, use their email address. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -339,6 +366,9 @@ Accept wildcard characters: False ``` ### -SourceFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -360,7 +390,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -370,6 +399,9 @@ Accept wildcard characters: False ``` ### -SystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SystemCategory parameter specifies a condition for the sweep rule that looks for messages with the specified system category. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -401,7 +433,6 @@ The SystemCategory parameter specifies a condition for the sweep rule that looks Type: SystemCategoryType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,13 +442,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SystemMessage.md b/exchange/exchange-ps/ExchangePowerShell/Set-SystemMessage.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-SystemMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SystemMessage.md index 0cb1bfebec..7b2c217f03 100644 --- a/exchange/exchange-ps/exchange/Set-SystemMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SystemMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-systemmessage -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SystemMessage -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-systemmessage +schema: 2.0.0 +title: Set-SystemMessage --- # Set-SystemMessage @@ -32,7 +33,7 @@ Set-SystemMessage [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +54,9 @@ This example modifies the text of the custom English WarningMailbox quota messag ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the custom system message that you want to modify. You can use any value that uniquely identifies the system message. For example: - Identity @@ -108,7 +112,6 @@ Maximum number of levels (depth) in a mailbox folder: Type: SystemMessageIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -127,7 +133,6 @@ 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 Required: False Position: Named @@ -137,6 +142,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -145,7 +153,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +162,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies a descriptive name for the system message. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +180,9 @@ Accept wildcard characters: False ``` ### -Original + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Original switch specifies whether to stop using the custom system message and start using the default system message. You don't need to specify a value with this switch. This switch is useful when you want to preserve the custom system message without using it. @@ -181,7 +193,6 @@ This switch only works on custom system messages for default (not new) enhanced Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -Text + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Text parameter specifies the text in the custom system message. The text should explain why the system message was sent and any actions that the user should take. This parameter can contain text and HTML tags. The maximum length is 512 characters (which includes all text and HTML tags). @@ -201,7 +215,7 @@ The following HTML tags are available: - `` and `` (italic) - `
` (line break) - `

` and `

` (paragraph) -- `` and `` (hyperlink). **Note**: You need to use single quotation marks (not double quotation marks) around the complete text string if you use this tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). +- `` and `` (hyperlink). **Note**: You need to use single quotation marks (not double quotation marks) around the complete text string if you use this tag. Otherwise, you get an error (because of the double quotation marks in the tag). Use the following escape codes for these special characters: @@ -218,7 +232,6 @@ Here's an example value for this parameter that uses HTML tags and special chara Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,13 +241,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicy.md index 65370a81b9..ce6a7a824e 100644 --- a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-teamsprotectionpolicy applicable: Exchange Online -title: Set-TeamsProtectionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-teamsprotectionpolicy +schema: 2.0.0 +title: Set-TeamsProtectionPolicy --- # Set-TeamsProtectionPolicy @@ -32,7 +33,7 @@ Set-TeamsProtectionPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,13 +47,15 @@ This example changes the quarantine policy that's used for high confidence phish ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Teams protection policy that you want to modify. There's only one Teams protection policy in an organization named Teams Protection Policy. ```yaml Type: TeamsProtectionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -87,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -97,6 +104,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishQuarantineTag + +> Applicable: Exchange Online + The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as high confidence phishing by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -111,7 +121,6 @@ If you don't use this parameter, the default quarantine policy that's used is na Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -MalwareQuarantineTag + +> Applicable: Exchange Online + The MalwareQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as malware by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -135,7 +147,6 @@ If you don't use this parameter, the default quarantine policy that's used is na Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -145,14 +156,18 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online -Applicable: Exchange Online Required: False Position: Named @@ -162,16 +177,18 @@ Accept wildcard characters: False ``` ### -ZapEnabled + +> Applicable: Exchange Online + The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware and high confidence phishing messages in Teams messages. Valid values are: -- $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This is the default value. +- $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This value is the default. - $false: ZAP for malware and high confidence phishing messages in Teams is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicyRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicyRule.md index 859d7e7ee7..42a45386d8 100644 --- a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-teamsprotectionpolicyrule applicable: Exchange Online -title: Set-TeamsProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-teamsprotectionpolicyrule +schema: 2.0.0 +title: Set-TeamsProtectionPolicyRule --- # Set-TeamsProtectionPolicyRule @@ -35,7 +36,7 @@ Set-TeamsProtectionPolicyRule [-Identity] > [!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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,13 +50,15 @@ This example modifies the existing Teams protection policy rule by excluding rec ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Teams protection policy rule that you want to modify. There's only one Teams protection policy rule in an organization named Teams Protection Policy Rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -90,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages with email addresses in the specified domains. To replace all existing domains with the values you specify, use the following syntax: `Domain1,Domain2,...DomainN`. @@ -136,7 +146,6 @@ To empty the list, use the value $null for this parameter. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -189,7 +201,6 @@ To empty the list, use the value $null for this parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -199,6 +210,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception to ZAP for Teams protection that looks for Teams messages sent to members of distribution groups or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -242,7 +256,6 @@ To empty the list, use the value $null for this parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -252,13 +265,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md b/exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListItems.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListItems.md index 843a7d4d31..0c4b286a6b 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-tenantallowblocklistitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Set-TenantAllowBlockListItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-tenantallowblocklistitems +schema: 2.0.0 +title: Set-TenantAllowBlockListItems --- # Set-TenantAllowBlockListItems @@ -49,9 +50,9 @@ Set-TenantAllowBlockListItems -Entries -ListType ``` ## DESCRIPTION -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). +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 non-Microsoft 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). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,11 +68,14 @@ This example changes the expiration date of the specified entry. Set-TenantAllowBlockListItems -ListType Url -ListSubType AdvancedDelivery -Entries *.fabrikam.com -ExpirationDate 9/11/2021 ``` -This example changes the expiration date of the URL allow entry for the specified third-party phishing simulation URL. +This example changes the expiration date of the URL allow entry for the specified non-Microsoft phishing simulation URL. ## PARAMETERS ### -Entries + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Entries parameter specifies the entries that you want to modify based on the ListType parameter value. Valid values are: - FileHash: The exact SHA256 file hash value. @@ -88,7 +92,6 @@ You can't use this parameter with the Ids parameter. ```yaml Type: String[] Parameter Sets: Entries -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Ids + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Ids parameter specifies the entries that you want to modify. This value is shown in the Identity property in the output of the Get-TenantAllowBlockListItems cmdlet. An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. @@ -108,7 +114,6 @@ You can't use this parameter with the Entries parameter. Type: String[] Parameter Sets: Ids Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -ListType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListType parameter specifies the type of entry that you want to modify. Valid values are: - FileHash @@ -131,7 +139,6 @@ Use the Entries or Ids parameter with this parameter to identify the entry itsel Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -NoExpiration + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. This switch is available to use with the following types of entries: @@ -155,7 +165,6 @@ You can't use this switch with the ExpirationDate parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -Allow + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Allow switch specifies that you're modifying an allow entry. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -181,13 +192,15 @@ Accept wildcard characters: False ``` ### -Block + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Block switch specifies that you're modifying a block entry. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -197,6 +210,9 @@ Accept wildcard characters: False ``` ### -ExpirationDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ExpirationDate parameter filters the results by expiration date in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -210,7 +226,6 @@ You can't use this parameter with the NoExpiration or RemoveAfter parameters. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -220,16 +235,18 @@ Accept wildcard characters: False ``` ### -ListSubType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListSubType parameter further specifies the entry that you want to modify. Valid values are: -- AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). -- Tenant: This is the default value. +- AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the advanced delivery policy for non-Microsoft phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +- Tenant: This value is the default. ```yaml Type: ListSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -239,13 +256,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -255,6 +274,9 @@ Accept wildcard characters: False ``` ### -OutputJson + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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. You use this switch to prevent the command from halting on the first entry that contains a syntax error. @@ -263,7 +285,6 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -273,6 +294,9 @@ Accept wildcard characters: False ``` ### -RemoveAfter + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -285,7 +309,6 @@ To change the allow entry to a static expiration date/time value that doesn't de Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListSpoofItems.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListSpoofItems.md index e410aa39ca..def6278fd4 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListSpoofItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-tenantallowblocklistspoofitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Set-TenantAllowBlockListSpoofItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-tenantallowblocklistspoofitems +schema: 2.0.0 +title: Set-TenantAllowBlockListSpoofItems --- # Set-TenantAllowBlockListSpoofItems @@ -30,7 +31,7 @@ Set-TenantAllowBlockListSpoofItems [-Identity] Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter uses the value Default. ```yaml Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Action parameter specifies whether this entry is an allow or block spoofed sender entry. Valid values are: - Allow @@ -78,7 +84,6 @@ The Action parameter specifies whether this entry is an allow or block spoofed s Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -Ids + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Ids parameter specifies the spoof pair that you want to modify. A valid value is the Identity property value from the output of the Get-TenantAllowBlockListSpoofItems cmdlet. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -113,7 +123,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md b/exchange/exchange-ps/ExchangePowerShell/Set-TextMessagingAccount.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-TextMessagingAccount.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TextMessagingAccount.md index 57563a2af1..550a18a31f 100644 --- a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TextMessagingAccount.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-textmessagingaccount -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-TextMessagingAccount -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-textmessagingaccount +schema: 2.0.0 +title: Set-TextMessagingAccount --- # Set-TextMessagingAccount ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. The Set-TextMessagingAccount cmdlet allows a user to configure the text messaging settings on their own mailbox. An administrator can't use this cmdlet to configure the text messaging settings on another user's mailbox. @@ -37,7 +38,7 @@ When text messaging notifications are enabled on a mailbox, you can configure ca To clear the text messaging settings from your own mailbox, use the Clear-TextMessagingAccount parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example sets the region, mobile operator and notification phone number for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the target mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -75,7 +79,6 @@ The Identity parameter specifies the target mailbox. You can use any value that Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -94,7 +100,6 @@ 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 Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -CountryRegionId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CountryRegionId parameter specifies the country/region that your mobile phone is registered in. Although this parameter accepts any valid ISO 3166-1 two-letter country code value (for example, AU for Australia), the following values correspond to the country/region selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): - US @@ -116,7 +124,6 @@ A reference for two-letter country codes is available at [Country Codes List](ht Type: RegionInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -134,7 +144,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -155,7 +167,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,6 +176,9 @@ Accept wildcard characters: False ``` ### -MobileOperatorId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MobileOperatorId parameter specifies the mobile operator (carrier) for your phone. Although this parameter accepts any random number, the following values correspond to the country/region and mobile operator selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): United States: @@ -187,7 +201,6 @@ Romania: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,13 +210,15 @@ Accept wildcard characters: False ``` ### -NotificationPhoneNumber + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The NotificationPhoneNumber parameter specifies the telephone number to use for your text messaging notifications. This parameter uses the E.164 format: `+` (for example, `+15551234567`). ```yaml Type: E164Number Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -213,13 +228,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicy.md index 51e733463a..14a41dfeb7 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-throttlingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ThrottlingPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-throttlingpolicy +schema: 2.0.0 +title: Set-ThrottlingPolicy --- # Set-ThrottlingPolicy @@ -173,11 +174,11 @@ Set-ThrottlingPolicy [-Identity] ## DESCRIPTION Throttling policy settings are stored in Active Directory. -By default, there is one default user throttling policy named GlobalThrottlingPolicy with a throttling scope of Global. Exchange Setup creates this policy as part of the Client Access server role. You shouldn't replace, re-create, or remove the existing default throttling policy. However, you can edit any additional throttling policies with the scope of Organization or Regular if you want to change your user throttling settings. You can create polices with the scope of Organization or Regular using the New-ThrottlingPolicy cmdlet. +By default, there is one default user throttling policy named GlobalThrottlingPolicy with a throttling scope of Global. Exchange Setup creates this policy as part of the Client Access server role. You shouldn't replace, re-create, or remove the existing default throttling policy. However, you can edit any additional throttling policies with the scope of Organization or Regular if you want to change your user throttling settings. You can create policies with the scope of Organization or Regular using the New-ThrottlingPolicy cmdlet. For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -207,13 +208,19 @@ This example modifies a throttling policy so that it restricts a user to be able ## PARAMETERS ### -Identity -The Identity parameter uniquely identifies the throttling policy that you want to modify values for. The name you use is the name of the throttling policy object in Active Directory. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Identity parameter specifies the throttling policy that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -223,13 +230,15 @@ Accept wildcard characters: False ``` ### -AnonymousCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnonymousCutoffBalance parameter specifies the resource consumption limits for an anonymous user before the user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,13 +248,15 @@ Accept wildcard characters: False ``` ### -AnonymousMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnonymousMaxBurst parameter specifies the amount of time that an anonymous user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,13 +266,15 @@ Accept wildcard characters: False ``` ### -AnonymousMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnonymousMaxConcurrency parameter specifies how many anonymous connections can be made to a user's calendar data at the same time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If anonymous users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The AnonymousMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 1. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -271,6 +284,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInAD parameter specifies the percentage of a minute that anonymous users can spend executing LDAP requests (PercentTimeInAD) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -279,7 +295,6 @@ The AnonymousPercentTimeInAD parameter specifies the percentage of a minute that Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -289,6 +304,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInCAS parameter specifies the percentage of a minute that anonymous users can spend executing CAS code (PercentTimeInCAS) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -297,7 +315,6 @@ The AnonymousPercentTimeInCAS parameter specifies the percentage of a minute tha Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -307,6 +324,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInMailboxRPC parameter specifies the percentage of a minute that anonymous users can spend executing mailbox RPC requests (PercentTimeInMailboxRPC) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -315,7 +335,6 @@ The AnonymousPercentTimeInMailboxRPC parameter specifies the percentage of a min Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -325,13 +344,15 @@ Accept wildcard characters: False ``` ### -AnonymousRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AnonymousRechargeRate parameter specifies the rate at which an anonymous user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -341,13 +362,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,13 +380,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -373,13 +398,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -389,13 +416,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -405,13 +434,15 @@ Accept wildcard characters: False ``` ### -ComplianceMaxExpansionDGRecipients + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ComplianceMaxExpansionDGRecipients parameter specifies the maximum number of recipients to expand in distribution groups when a discovery search is looking for a specified recipient. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -421,13 +452,15 @@ Accept wildcard characters: False ``` ### -ComplianceMaxExpansionNestedDGs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ComplianceMaxExpansionNestedDGs parameter specifies the maximum number of nested distribution groups to expand when a discovery search is looking for a specified recipient. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -437,6 +470,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -446,7 +482,6 @@ 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 Required: False Position: Named @@ -456,13 +491,15 @@ Accept wildcard characters: False ``` ### -ConsensusCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -472,13 +509,15 @@ Accept wildcard characters: False ``` ### -ConsensusMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -488,13 +527,15 @@ Accept wildcard characters: False ``` ### -ConsensusMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -504,13 +545,15 @@ Accept wildcard characters: False ``` ### -ConsensusRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -520,13 +563,15 @@ Accept wildcard characters: False ``` ### -CpaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CpaCutoffBalance parameter specifies the resource consumption limits for a cross-premises user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -536,13 +581,15 @@ Accept wildcard characters: False ``` ### -CpaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CpaMaxBurst parameter specifies the amount of time that a cross-premises user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -552,13 +599,15 @@ Accept wildcard characters: False ``` ### -CPAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CpaMaxConcurrency parameter specifies how many concurrent connections a cross-premises user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The CpaMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -568,13 +617,15 @@ Accept wildcard characters: False ``` ### -CPAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + The CPAPercentTimeInCAS parameter specifies the percentage of a minute that a cross-premises user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -584,6 +635,9 @@ Accept wildcard characters: False ``` ### -CPAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CPAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that a cross-premises user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -592,7 +646,6 @@ The CPAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -602,13 +655,15 @@ Accept wildcard characters: False ``` ### -CpaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CpaRechargeRate parameter specifies the rate at which a cross premises user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -618,6 +673,9 @@ Accept wildcard characters: False ``` ### -CPUStartPercent + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CPUStartPercent parameter specifies the per-process CPU percentage at which users governed by this policy begin to be backed off. Valid values are from 0 through 100. Use $null to turn off CPU percentage-based throttling for this policy. @@ -626,7 +684,6 @@ The CPUStartPercent parameter specifies the per-process CPU percentage at which Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -636,13 +693,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxConcurrency parameter specifies the number of concurrent discovery search executions that a user can have at the same time. To modify the discovery throttling parameters, create a new policy and name it "DiscoveryThrottlingPolicy". ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -652,13 +711,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxKeywords -The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchange/search-mailbox). + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchangepowershell/search-mailbox). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -668,13 +729,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxKeywordsPerPage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxKeywordsPerPage parameter specifies the number of keywords for which to show statistics on a single page in the EAC. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -684,13 +747,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxMailboxes parameter specifies the maximum number of source mailboxes that a user can include in a discovery search. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -700,13 +765,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxPreviewSearchMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxPreviewSearchMailboxes parameter specifies the maximum number of mailboxes that a user can include in eDiscovery Search Preview. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -716,13 +783,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxRefinerResults -This parameter isn't used and will be removed. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -732,13 +801,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxSearchQueueDepth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxSearchQueueDepth parameter specifies the maximum number of concurrent discovery search threads that can be active at the same time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -748,13 +819,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxStatsSearchMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryMaxStatsSearchMailboxes parameter specifies the maximum number of mailboxes that a user can search in an In-Place eDiscovery search without being able to view the statistics. When the number of mailboxes configured with the DiscoveryMaxStatsSearchMailboxes parameter is exceeded, the user must copy the search results to a discovery mailbox to view the statistics for the discovery search. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -764,13 +837,15 @@ Accept wildcard characters: False ``` ### -DiscoveryPreviewSearchResultsPageSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DiscoveryPreviewSearchResultsPageSize parameter specifies the number of messages displayed on a single page in eDiscovery Search Preview. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -780,13 +855,15 @@ Accept wildcard characters: False ``` ### -DiscoverySearchTimeoutPeriod -The DiscoverySearchTimeoutPeriod parameter specifies the number of minutes that a discovery search will run before it times out. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The DiscoverySearchTimeoutPeriod parameter specifies the number of minutes that a discovery search runs before it times out. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -796,6 +873,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -804,7 +884,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -814,13 +893,15 @@ Accept wildcard characters: False ``` ### -EasCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasCutoffBalance parameter specifies the resource consumption limits for an Exchange ActiveSync user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -830,13 +911,15 @@ Accept wildcard characters: False ``` ### -EasMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasMaxBurst parameter specifies the amount of time that an Exchange ActiveSync user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -846,13 +929,15 @@ Accept wildcard characters: False ``` ### -EASMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasMaxConcurrency parameter specifies how many concurrent connections an Exchange ActiveSync user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The EasMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 10. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -862,13 +947,15 @@ Accept wildcard characters: False ``` ### -EASMaxDeviceDeletesPerMonth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasMaxDeviceDeletesPerMonth parameter specifies a limit to the number of Exchange ActiveSync partnerships that a user can delete per month. By default, each user can delete a maximum of 20 partnerships per calendar month. When the limit is reached, the partnership deletion attempt fails and an error message is displayed to the user. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -878,13 +965,15 @@ Accept wildcard characters: False ``` ### -EASMaxDevices + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasMaxDevices parameter specifies a limit to the number of Exchange ActiveSync partnerships that a user can have at one time. By default, each user can create 100 Exchange ActiveSync partnerships with their Exchange account. After users exceed the limit, they must delete one of their existing partnerships before they can create any more new partnerships. An email error message describing the limitation is sent to the user when the limit is exceeded. Additionally, an event is logged in the Application log when a user exceeds the limit. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -894,13 +983,15 @@ Accept wildcard characters: False ``` ### -EasMaxInactivityForDeviceCleanup -The EasMaxInactivityForDeviceCleanup parameter specifies the length of time that a user's device partnerships will remain active. By default, there is no limit to the number of days that a user's device partnerships will remain active. Use this value if you want to minimize the amount of inactive device partnerships in your organization. To use this setting, specify a value in days since the user's last sync time to cause the device partnership to be removed. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The EasMaxInactivityForDeviceCleanup parameter specifies the length of time that a user's device partnerships remain active. By default, there is no limit to the number of days that a user's device partnerships remain active. Use this value if you want to minimize the amount of inactive device partnerships in your organization. To use this setting, specify a value in days since the user's last sync time to cause the device partnership to be removed. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -910,6 +1001,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInAD parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -918,7 +1012,6 @@ The EASPercentTimeInAD parameter specifies the percentage of a minute that an Ex Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -928,6 +1021,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInCAS parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -936,7 +1032,6 @@ The EASPercentTimeInCAS parameter specifies the percentage of a minute that an E Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -946,6 +1041,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -954,7 +1052,6 @@ The EASPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -964,13 +1061,15 @@ Accept wildcard characters: False ``` ### -EasRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EasRechargeRate parameter specifies the rate at which an Exchange ActiveSync user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -980,13 +1079,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -996,13 +1097,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1012,13 +1115,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1028,13 +1133,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1044,13 +1151,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1060,13 +1169,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1076,13 +1187,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1092,13 +1205,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1108,13 +1223,15 @@ Accept wildcard characters: False ``` ### -EwsCostThreshold + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsCostThreshold parameter specifies the cost threshold for Exchange Web Services users. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1124,13 +1241,15 @@ Accept wildcard characters: False ``` ### -EwsCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsCutoffBalance parameter specifies the resource consumption limits for an Exchange Web Services user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1140,13 +1259,15 @@ Accept wildcard characters: False ``` ### -EwsMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsMaxBurst parameter specifies the amount of time that an Exchange Web Services user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1156,6 +1277,9 @@ Accept wildcard characters: False ``` ### -EWSFastSearchTimeoutInSeconds + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSFastSearchTimeoutInSeconds parameter specifies the amount of time that searches made using Exchange Web Services continue before they time out. If the search takes more than the time indicated by the policy value, the search stops and an error is returned. The default value of this setting is 60 seconds. @@ -1164,7 +1288,6 @@ The EWSFastSearchTimeoutInSeconds parameter specifies the amount of time that se Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1174,6 +1297,9 @@ Accept wildcard characters: False ``` ### -EWSFindCountLimit + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSFindCountLimit parameter specifies the maximum result size of FindItem or FindFolder calls that can exist in memory on the Client Access server at the same time for this user in this current process. If an attempt is made to find more items or folders than your policy limit allows, an error is returned. However, the limit isn't strictly enforced if the call is made within the context of an indexed page view. Specifically, in this scenario, the search results are truncated to include the number of items and folders that fit within the policy limit. You can then continue paging into your results set via further FindItem or FindFolder calls. @@ -1182,7 +1308,6 @@ The EWSFindCountLimit parameter specifies the maximum result size of FindItem or Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1192,13 +1317,15 @@ Accept wildcard characters: False ``` ### -EWSMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsMaxConcurrency parameter specifies how many concurrent connections an Exchange Web Services user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The EwsMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 10. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1208,13 +1335,15 @@ Accept wildcard characters: False ``` ### -EWSMaxSubscriptions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsMaxSubscriptions parameter specifies the maximum number of active push and pull subscriptions that an Exchange Web Services user can have on a specified Exchange server at the same time. If a user tries to create more subscriptions than the configured maximum, the subscription fails, and an event is logged in Event Viewer. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1224,6 +1353,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInAD parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1232,7 +1364,6 @@ The EWSPercentTimeInAD parameter specifies the percentage of a minute that an Ex Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1242,6 +1373,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInCAS parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1250,7 +1384,6 @@ The EWSPercentTimeInCAS parameter specifies the percentage of a minute that an E Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1260,6 +1393,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1268,7 +1404,6 @@ The EWSPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1278,13 +1413,15 @@ Accept wildcard characters: False ``` ### -EwsRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EwsRechargeRate parameter specifies the rate at which an Exchange Web Services user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1294,6 +1431,9 @@ Accept wildcard characters: False ``` ### -ExchangeMaxCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExchangeMaxCmdlets parameter specifies the number of cmdlets that can be executed within a specific time period before their execution is slowed down. The value specified by this parameter should be less than the value specified by the PowerShellMaxCmdlets parameter. The time period used for this limit is specified by the PowerShellMaxCmdletsTimePeriod parameter. We recommend that you set values for both parameters at the same time. @@ -1302,7 +1442,6 @@ The time period used for this limit is specified by the PowerShellMaxCmdletsTime Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1312,6 +1451,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -1320,7 +1462,6 @@ 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 Required: False Position: Named @@ -1330,13 +1471,15 @@ Accept wildcard characters: False ``` ### -ForwardeeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForwardeeLimit parameter specifies the limits for the number of recipients that can be configured in Inbox Rules when using the forward or redirect action. This parameter doesn't limit the number of messages that can be forwarded or redirected to the recipients that are configured. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1346,13 +1489,15 @@ Accept wildcard characters: False ``` ### -ImapCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ImapCutoffBalance parameter specifies the resource consumption limits for an IMAP user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1362,13 +1507,15 @@ Accept wildcard characters: False ``` ### -ImapMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ImapMaxBurst parameter specifies the amount of time that an IMAP user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1378,13 +1525,15 @@ Accept wildcard characters: False ``` ### -IMAPMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ImapMaxConcurrency parameter specifies how many concurrent connections an IMAP user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The ImapMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1394,6 +1543,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInAD parameter specifies the percentage of a minute that an IMAP user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1402,7 +1554,6 @@ The IMAPPercentTimeInAD parameter specifies the percentage of a minute that an I Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1412,6 +1563,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInCAS parameter specifies the percentage of a minute that an IMAP user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1420,7 +1574,6 @@ The IMAPPercentTimeInCAS parameter specifies the percentage of a minute that an Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1430,6 +1583,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an IMAP user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1438,7 +1594,6 @@ The IMAPPercentTimeInMailboxRPC parameter specifies the percentage of a minute t Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1448,13 +1603,15 @@ Accept wildcard characters: False ``` ### -ImapRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ImapRechargeRate parameter specifies the rate at which the IMAP user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1464,6 +1621,9 @@ Accept wildcard characters: False ``` ### -IsServiceAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IsServiceAccount switch specifies that the user accounts associated with this policy are moderated by per-user thresholds and the health of system resources (for example, overall CPU usage). You don't need to specify a value with this switch. You might want to use this switch if you intend to associate this policy with user accounts that require higher throttling limits (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). @@ -1474,7 +1634,6 @@ By using this switch, work done by these accounts is moderated by the higher use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1484,13 +1643,15 @@ Accept wildcard characters: False ``` ### -MessageRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageRateLimit parameter specifies the number of messages per minute that can be submitted to transport by POP3 or IMAP4 clients that use SMTP. Clients receive a transient error if they submit messages at a rate that exceeds the value of this parameter. Exchange attempts to connect and send the messages at a later time. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1500,13 +1661,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the name of the object in Active Directory. The default policy is named `DefaultThrottlingPolicy`. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1516,13 +1679,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1532,13 +1697,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1548,13 +1715,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1564,13 +1733,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSocketConnectionsPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1580,13 +1751,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSocketConnectionsPerUser + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1596,13 +1769,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSubscriptions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1612,13 +1787,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1628,13 +1805,15 @@ Accept wildcard characters: False ``` ### -OwaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaCutoffBalance parameter specifies the resource consumption limits for an Outlook on the web user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1644,13 +1823,15 @@ Accept wildcard characters: False ``` ### -OwaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaMaxBurst parameter specifies the amount of time that an Outlook on the web user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1660,6 +1841,9 @@ Accept wildcard characters: False ``` ### -OWAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaMaxConcurrency parameter specifies how many concurrent connections an Outlook on the web user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. A valid value for this parameter is an integer from 0 through 2147483647 inclusive. The default value is 5. To indicate that the number of concurrent connections should be unthrottled (no limit), use the value $null. @@ -1670,7 +1854,6 @@ A valid value for this parameter is an integer from 0 through 2147483647 inclusi Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1680,6 +1863,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInAD parameter specifies the percentage of a minute that an Outlook Web App user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1688,7 +1874,6 @@ The OWAPercentTimeInAD parameter specifies the percentage of a minute that an Ou Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1698,6 +1883,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInCAS parameter specifies the percentage of a minute that an Outlook Web App user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1706,7 +1894,6 @@ The OWAPercentTimeInCAS parameter specifies the percentage of a minute that an O Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1716,6 +1903,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Outlook Web App user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1724,7 +1914,6 @@ The OWAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1734,13 +1923,15 @@ Accept wildcard characters: False ``` ### -OwaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaRechargeRate parameter specifies the rate at which an Outlook on the web user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1750,13 +1941,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaVoiceCutoffBalance parameter specifies the resource consumption limits for an Outlook on the web voice user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1766,13 +1959,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaVoiceMaxBurst parameter specifies the amount of time that an Outlook on the web voice user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1782,13 +1977,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaVoiceMaxConcurrency parameter specifies how many concurrent connections an Outlook on the web voice user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The OwaVoiceMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 5. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1798,13 +1995,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OwaVoiceRechargeRate parameter specifies the rate at which an Outlook on the web voice user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1814,13 +2013,15 @@ Accept wildcard characters: False ``` ### -PopCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PopCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1830,13 +2031,15 @@ Accept wildcard characters: False ``` ### -PopMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PopMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1846,13 +2049,15 @@ Accept wildcard characters: False ``` ### -POPMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PopMaxConcurrency parameter specifies how many concurrent connections a POP user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The PopMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 20. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1862,6 +2067,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInAD parameter specifies the percentage of a minute a POP user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1870,7 +2078,6 @@ The POPPercentTimeInAD parameter specifies the percentage of a minute a POP user Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1880,6 +2087,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInCAS parameter specifies the percentage of a minute a POP user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1888,7 +2098,6 @@ The POPPercentTimeInCAS parameter specifies the percentage of a minute a POP use Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1898,6 +2107,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInMailboxRPC parameter specifies the percentage of a minute a POP user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1906,7 +2118,6 @@ The POPPercentTimeInMailboxRPC parameter specifies the percentage of a minute a Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1916,13 +2127,15 @@ Accept wildcard characters: False ``` ### -PopRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PopRechargeRate parameter specifies the rate at which the user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1932,13 +2145,15 @@ Accept wildcard characters: False ``` ### -PowerShellCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1948,13 +2163,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1964,13 +2181,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdletQueueDepth -The PowerShellMaxCmdletQueueDepth parameter specifies the number of operations allowed to be executed by the user. This value directly affects the behavior of the PowerShellMaxCmdlets and PowerShellMaxConcurrency parameters. For example, the PowerShellMaxConcurrency parameter consumes at least two operations defined by the PowerShellMaxCmdletQueueDepth parameter but additional operations are also consumed per cmdlet execution. The number of operations depends on the cmdlets executed. We recommend that the value for the PowerShellMaxCmdletQueueDepth parameter be at least three times larger than the value of the PowerShellMaxConcurrency parameter. This parameter won't affect Exchange admin center operations or Exchange Web Services operations. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PowerShellMaxCmdletQueueDepth parameter specifies the number of operations allowed to be executed by the user. This value directly affects the behavior of the PowerShellMaxCmdlets and PowerShellMaxConcurrency parameters. For example, the PowerShellMaxConcurrency parameter consumes at least two operations defined by the PowerShellMaxCmdletQueueDepth parameter but additional operations are also consumed per cmdlet execution. The number of operations depends on the cmdlets executed. We recommend that the value for the PowerShellMaxCmdletQueueDepth parameter be at least three times larger than the value of the PowerShellMaxConcurrency parameter. This parameter doesn't affect Exchange admin center operations or Exchange Web Services operations. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1980,13 +2199,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxCmdlets parameter specifies the number of cmdlets that can be executed within a specific time period before their execution is stopped. The value specified by this parameter should be more than the value specified by the ExchangeMaxCmdlets parameter. The time period used for this limit is specified by the PowerShellMaxCmdletsTimePeriod parameter. Both values should be set at the same time. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1996,13 +2217,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdletsTimePeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxCmdletsTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine whether the number of cmdlets being executed exceeds the limits specified by the PowerShellMaxCmdlets and ExchangeMaxCmdlets parameters. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2012,6 +2235,9 @@ Accept wildcard characters: False ``` ### -PowerShellMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxConcurrency parameter specifies different information depending on context: - In the context of remote PowerShell, the PowerShellMaxConcurrency parameter specifies the maximum number of remote PowerShell sessions that a remote PowerShell user can have open at the same time. @@ -2023,7 +2249,6 @@ This parameter value doesn't necessarily correlate to the number of browsers ope Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2033,7 +2258,10 @@ Accept wildcard characters: False ``` ### -PowerShellMaxDestructiveCmdlets -The PowerShellMaxDestructiveCmdlets parameter specifies the number of destructive cmdlets that can be executed within a specific time period before their execution is stopped. Destructive cmdlets are cmdlets that can make significant changes to user data and configuration settings in your Exchange organization. Throttling these cmdlets may help prevent accidental data loss. The following cmdlets are designated as destructive: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PowerShellMaxDestructiveCmdlets parameter specifies the number of destructive cmdlets that can be executed within a specific time period before their execution is stopped. Destructive cmdlets are cmdlets that can make significant changes to user data and configuration settings in your Exchange organization. Throttling these cmdlets might help prevent accidental data loss. The following cmdlets are designated as destructive: - Disable-Mailbox - Move-ActiveMailboxDatabase @@ -2051,7 +2279,6 @@ The time period used for this limit is specified by the PowerShellMaxDestructive Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2061,13 +2288,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxDestructiveCmdletsTimePeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxDestructiveCmdletsTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine how many destructive cmdlets can be run. You set a value for this parameter when you set the PowerShellMaxDestructiveCmdlets parameter. Both values should be set at the same time. For more information, see the description for the PowerShellMaxDestructiveCmdlets parameter. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2077,13 +2306,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxOperations -The PowerShellMaxOperations parameter specifies the protocol-level operations that are used to send and receive data. If the execution of a cmdlet results in a significant number of operations (for example, if there is a lot of input/output occurring), throttling may occur. The default setting is Unlimited. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PowerShellMaxOperations parameter specifies the protocol-level operations that are used to send and receive data. If the execution of a cmdlet results in a significant number of operations (for example, if there is a lot of input/output occurring), throttling might occur. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2093,13 +2324,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxRunspaces + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxRunspaces parameter specifies the number of concurrent Windows PowerShell sessions that a user is allowed to have. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2109,13 +2342,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxRunspacesTimePeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxRunspacesTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine how many Windows PowerShell sessions can be run. You set this value when you set the PowerShellMaxRunspaces parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2125,6 +2360,9 @@ Accept wildcard characters: False ``` ### -PowerShellMaxTenantConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxTenantConcurrency parameter limits the number of concurrent Windows PowerShell connections per tenant organization. By default, the limit for concurrent Windows PowerShell connections per tenant organization is set to 9. If users in a tenant organization try to make more concurrent requests than the limit set by the PowerShellMaxTenantConcurrency parameter, the new connection attempt fails. However, the existing connections remain valid. This limit is enforced even if a single user hasn't exceeded the per-user limit set by the PowerShellMaxConcurrency parameter. The PowerShellMaxTenantConcurrency parameter has a valid range from 0 through 100 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. This property can only be set for the default throttling policy. @@ -2133,7 +2371,6 @@ This property can only be set for the default throttling policy. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2143,13 +2380,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxTenantRunspaces + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellMaxTenantRunspaces parameter specifies the number of concurrent Windows PowerShell sessions that a tenant is allowed to have. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2159,13 +2398,15 @@ Accept wildcard characters: False ``` ### -PowerShellRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PowerShellRechargeRate parameter specifies the rate at which the user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2175,6 +2416,9 @@ Accept wildcard characters: False ``` ### -PswsMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PswsMaxConcurrency parameter specifies how many concurrent connections a Windows PowerShell Web Services user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The PswsMaxConcurrency parameter has a default value of 18. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. @@ -2183,7 +2427,6 @@ The PswsMaxConcurrency parameter has a default value of 18. To indicate that the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2193,13 +2436,15 @@ Accept wildcard characters: False ``` ### -PswsMaxRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PswsMaxRequest parameter specifies how many requests a Windows PowerShell Web Services user can have against an Exchange server at one time. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2209,13 +2454,15 @@ Accept wildcard characters: False ``` ### -PswsMaxRequestTimePeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PswsMaxRequestTimePeriod parameter specifies the period of time, in seconds, that the throttling policy uses to determine how many requests can be run. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2225,13 +2472,15 @@ Accept wildcard characters: False ``` ### -PushNotificationCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2241,13 +2490,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2257,13 +2508,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxBurstPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2273,13 +2526,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2289,13 +2544,15 @@ Accept wildcard characters: False ``` ### -PushNotificationRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2305,13 +2562,15 @@ Accept wildcard characters: False ``` ### -PushNotificationRechargeRatePerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2321,13 +2580,15 @@ Accept wildcard characters: False ``` ### -PushNotificationSamplingPeriodPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2337,13 +2598,15 @@ Accept wildcard characters: False ``` ### -RcaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2353,13 +2616,15 @@ Accept wildcard characters: False ``` ### -RcaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2369,6 +2634,9 @@ Accept wildcard characters: False ``` ### -RCAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaMaxConcurrency parameter specifies how many concurrent connections an RPC Client Access user can have against an Exchange server at one time. A connection is held from the moment a request is received until the connection is closed or the connection is otherwise disconnected (for example, if the user goes offline). If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. A valid value is an integer from 0 through 4294967295, or the value unlimited. The default value is 40. @@ -2379,7 +2647,6 @@ To indicate that the number of concurrent connections should be unthrottled (no Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2389,6 +2656,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInAD parameter specifies the percentage of a minute that an Outlook user can spend executing directory requests. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2397,7 +2667,6 @@ The RCAPercentTimeInAD parameter specifies the percentage of a minute that an Ou Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2407,6 +2676,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInCAS parameter specifies the percentage of a minute that an Outlook user can spend executing CAS mailbox requests. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2415,7 +2687,6 @@ The RCAPercentTimeInCAS parameter specifies the percentage of a minute that an O Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2425,6 +2696,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an RPC Client Access user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2433,7 +2707,6 @@ The RCAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2443,13 +2716,15 @@ Accept wildcard characters: False ``` ### -RcaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaRechargeRate parameter specifies the rate at which the budget for the user is charged (how much the budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2459,13 +2734,15 @@ Accept wildcard characters: False ``` ### -RcaSharedCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaSharedCutoffBalance parameter specifies the resource consumption limits for all users before they're completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2475,13 +2752,15 @@ Accept wildcard characters: False ``` ### -RcaSharedMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaShardMaxBurst parameter specifies the amount of time that all users can consume elevated amounts of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2491,6 +2770,9 @@ Accept wildcard characters: False ``` ### -RcaSharedMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaSharedMaxConcurrency parameter specifies how many concurrent connections all RPC Client Access users can have against an Exchange server at one time. A connection is held from the moment a request is received until the connection is closed or the connection is otherwise disconnected (for example, if users go offline). If there are more concurrent requests than the policy allows, new connection attempts fail. However, the existing connections remain valid. The default value is unlimited, which means the limit is controlled individually for each user by the RcaMaxConcurrency parameter. @@ -2499,7 +2781,6 @@ The default value is unlimited, which means the limit is controlled individually Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2509,13 +2790,15 @@ Accept wildcard characters: False ``` ### -RcaSharedRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RcaSharedRechargeRate parameter specifies the rate at which the budget for all users is charged (how much the budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2525,13 +2808,15 @@ Accept wildcard characters: False ``` ### -RecipientRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecipientRateLimit parameter specifies the limits on the number of recipients that a user can address in a 24-hour period. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2541,13 +2826,15 @@ Accept wildcard characters: False ``` ### -SchedulesCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2557,13 +2844,15 @@ Accept wildcard characters: False ``` ### -SchedulesMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2573,13 +2862,15 @@ Accept wildcard characters: False ``` ### -SchedulesMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2589,13 +2880,15 @@ Accept wildcard characters: False ``` ### -SchedulesRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2605,6 +2898,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicyScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ThrottlingPolicyScope parameter specifies the scope of the throttling policy. You can use the following values: - Regular: This scope specifies a custom policy that applies to specific users. @@ -2617,7 +2913,6 @@ For more information about throttling policy scopes, see [User workload manageme Type: ThrottlingPolicyScopeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2627,13 +2922,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicyAssociation.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicyAssociation.md index 7179fe0d72..07e8f891fd 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicyAssociation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-throttlingpolicyassociation -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ThrottlingPolicyAssociation -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-throttlingpolicyassociation +schema: 2.0.0 +title: Set-ThrottlingPolicyAssociation --- # Set-ThrottlingPolicyAssociation @@ -38,7 +39,7 @@ In data center deployments, the object referred to by the Identity and Throttlin For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). -You need to be assigned permissions before you can run the Set-ThrottlingPolicyAssociation cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run the Set-ThrottlingPolicyAssociation cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,13 +62,15 @@ You don't need to use the Set-ThrottlingPolicyAssociation cmdlet to associate a ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the object to which you want to associate a throttling policy. The object can be a user with a mailbox, a user without a mailbox, a contact, or a computer account. ```yaml Type: ThrottlingPolicyAssociationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -86,7 +92,6 @@ 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 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -104,7 +112,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ThrottlingPolicy parameter specifies the throttling policy that you want the object specified by the Identity parameter to be associated with. ```yaml Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Set-TransportAgent.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TransportAgent.md index 65fa73a458..da20218a86 100644 --- a/exchange/exchange-ps/exchange/Set-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-transportagent -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-TransportAgent -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-transportagent +schema: 2.0.0 +title: Set-TransportAgent --- # Set-TransportAgent @@ -31,7 +32,7 @@ Set-TransportAgent [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,13 +46,15 @@ This example modifies the priority of a fictitious agent named Test App in the F ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name (Identity property value) of the transport agent that you want to modify. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: TransportAgentObjectId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -70,7 +76,6 @@ 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 Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -88,7 +96,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Priority parameter specifies the priority of the transport agent. The priority of the transport agent controls the order in which the transport agents process email messages. The priority must be a value between 0 and the maximum number of transport agents. The default behavior is to append a new transport agent to the end of the priority list. Transport agents with a priority closest to 0 process email messages first. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,6 +123,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -126,7 +138,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TransportConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-TransportConfig.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-TransportConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TransportConfig.md index 57473281ff..a084e229ad 100644 --- a/exchange/exchange-ps/exchange/Set-TransportConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TransportConfig.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-transportconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-TransportConfig -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-transportconfig +schema: 2.0.0 +title: Set-TransportConfig --- # Set-TransportConfig ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-TransportConfig cmdlet to modify the transport configuration settings for the whole Exchange organization. @@ -91,7 +92,7 @@ Set-TransportConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -114,6 +115,9 @@ To avoid journaling issues, we recommend that you set JournalingReportNdrTo to a ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -122,7 +126,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -132,15 +135,17 @@ Accept wildcard characters: False ``` ### -AddressBookPolicyRoutingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The AddressBookPolicyRoutingEnabled parameter controls how recipients are resolved in an organization that uses address book policies to create separate virtual organizations within the same Exchange organization. Specifically, the global address list (GAL) that's specified in the user's address book policy controls how recipients are resolved. When the value of this parameter is $true, users that are assigned different GALs appear as external recipients. When the value of this parameter is $false, users that are assigned different GALs appear as internal recipients. -The default value is $false. Note that this parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter may take up to 30 minutes to take effect. For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). +The default value is $false. This parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter might take up to 30 minutes to take effect. For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -150,6 +155,9 @@ Accept wildcard characters: False ``` ### -AgentGeneratedMessageLoopDetectionInSubmissionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AgentGeneratedMessageLoopDetectionInSubmissionEnabled parameter controls the behavior of messages loop detection in for loops caused by transport agents in the Mailbox Transport Submission service. An agent-generated loop occurs when an agent creates a new copy of a message or adds recipients to a message, and the agent continues to process these resulting messages by creating copies or adding recipients. @@ -162,7 +170,6 @@ When Exchange detects an agent-generated message loop, the loop is stopped. When Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +179,9 @@ Accept wildcard characters: False ``` ### -AgentGeneratedMessageLoopDetectionInSmtpEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AgentGeneratedMessageLoopDetectionInSmtpEnabled parameter controls the behavior of messages loop detection in for loops caused by transport agents in the Transport service. An agent-generated loop occurs when an agent creates a new copy of a message or adds recipients to a message, and the agent continues to process these resulting messages by creating copies or adding recipients. @@ -184,7 +194,6 @@ When Exchange detects an agent-generated message loop, the loop is stopped. When Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +203,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyTLSClients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AllowLegacyTLSClients Description }} @@ -202,7 +214,6 @@ This parameter is available only in the cloud-based service. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -212,13 +223,15 @@ Accept wildcard characters: False ``` ### -ClearCategories + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ClearCategories parameter keeps or removes Microsoft Outlook message categories during content conversion. Valid input for this parameter is $true or $false. The default value is $true. This means that by default, Outlook message categories are removed during content conversion. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -228,6 +241,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -237,7 +253,6 @@ 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 Required: False Position: Named @@ -247,7 +262,10 @@ Accept wildcard characters: False ``` ### -ConvertDisclaimerWrapperToEml -The ConvertDisclaimerWrapperToEml parameter specifies whether the original message will be added as a TNEF attachment or a regular EML attachment to a disclaimer when all of the following are true: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The ConvertDisclaimerWrapperToEml parameter specifies whether the original message is added as a TNEF attachment or a regular EML attachment to a disclaimer when all of the following are true: - Message is sent to an external user. - The sender has signed the message. @@ -261,7 +279,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -271,6 +288,9 @@ Accept wildcard characters: False ``` ### -DiagnosticsAggregationServicePort + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The DiagnosticsAggregationServicePort parameter specifies the TCP port that's used to collect message queue diagnostic information. The default value is 9710. @@ -279,7 +299,6 @@ The DiagnosticsAggregationServicePort parameter specifies the TCP port that's us Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,6 +308,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -299,7 +321,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,6 +330,9 @@ Accept wildcard characters: False ``` ### -DSNConversionMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The DSNConversionMode parameter controls how Exchange handles delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) that are generated by earlier versions of Exchange or other email systems. Valid values are: - DoNotConvert: DSNs aren't modified. The DSN is delivered as a standard message. @@ -321,7 +345,6 @@ The default value in Exchange 2010 and Exchange 2013 is UseExchangeDSNs. Otherwi Type: DSNConversionOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -331,13 +354,15 @@ Accept wildcard characters: False ``` ### -ExternalDelayDsnEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalDelayDsnEnabled parameter specifies whether a delay delivery status notification (DSN) message should be created for external messages that couldn't be immediately delivered. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -347,13 +372,15 @@ Accept wildcard characters: False ``` ### -ExternalDsnDefaultLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create external DSN messages. The default value is the default Windows server language. ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -363,13 +390,15 @@ Accept wildcard characters: False ``` ### -ExternalDsnLanguageDetectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalDsnLanguageDetectionEnabled parameter specifies whether the server should try to send an external DSN message in the same language as the original message that generated the notification. Valid input for this parameter is $true or $false.The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -379,6 +408,9 @@ Accept wildcard characters: False ``` ### -ExternalDsnMaxMessageAttachSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ExternalDsnMaxMessageAttachSize parameter specifies the maximum size of the original message attached to an external DSN message. If the original message exceeds this size, only the headers of the original message are included in the DSN message. The default value is 10 megabytes (MB). @@ -391,7 +423,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 0 through 2147483647 bytes. If you specify a value of 0, only the original message headers are included in the external DSN message. @@ -399,7 +431,6 @@ The valid input range for this parameter is from 0 through 2147483647 bytes. If Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -409,13 +440,15 @@ Accept wildcard characters: False ``` ### -ExternalDsnReportingAuthority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalDsnReportingAuthority parameter specifies the domain in the machine-readable part of external DSN messages. The default value is blank ($null), which means the value is the authoritative domain that you specified during the creation of the organization. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -425,16 +458,18 @@ Accept wildcard characters: False ``` ### -ExternalDsnSendHtml + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalDsnSendHtml parameter specifies whether external DSN messages should be HTML or plain text. Valid values are: -- $true: External DSNs are HTML. This is the default value. +- $true: External DSNs are HTML. This value is the default. - $false: External DSNs are plain text. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -444,6 +479,9 @@ Accept wildcard characters: False ``` ### -ExternalPostmasterAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExternalPostmasterAddress parameter specifies the email address in the From header field of an external DSN message. The default value is blank ($null). The default value means the external postmaster address is `postmaster@` in the following locations: @@ -460,7 +498,6 @@ To override the default behavior, you can specify an email address for the Exter Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -470,6 +507,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -478,7 +518,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -488,6 +527,9 @@ Accept wildcard characters: False ``` ### -GenerateCopyOfDSNFor + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The GenerateCopyOfDSNFor parameter controls the non-delivery reports (NDRs) that are copied to a mailbox by specifying the DSN codes that you want to monitor. You must configure the list of monitored DSNs on one Mailbox server and locally on each Edge Transport server in your Exchange organization. @@ -515,7 +557,6 @@ To assign a mailbox to the Exchange recipient, use the Set-OrganizationConfig cm Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -525,17 +566,19 @@ Accept wildcard characters: False ``` ### -HeaderPromotionModeSetting + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The HeaderPromotionModeSetting parameter specifies whether named properties are created for custom X-headers on messages received. Valid values are: - MustCreate: Exchange creates a named property for each new custom X-header. - MayCreate: Exchange creates a named property for each new custom X-header on messages received from authenticated senders. No named properties are created for custom X-headers on messages received from unauthenticated senders. -- NoCreate: Exchange won't create any named properties based on custom X-headers on incoming messages. This is the default value. +- NoCreate: Exchange doesn't create any named properties based on custom X-headers on incoming messages. This value is the default. ```yaml Type: HeaderPromotionMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -545,13 +588,15 @@ Accept wildcard characters: False ``` ### -InternalDelayDsnEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InternalDelayDsnEnabled parameter specifies whether a delay DSN message should be created for messages sent to or from recipients or senders in the same Exchange organization that couldn't be immediately delivered. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -561,13 +606,15 @@ Accept wildcard characters: False ``` ### -InternalDsnDefaultLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create internal DSN messages. The default value is the default Windows server language. ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -577,13 +624,15 @@ Accept wildcard characters: False ``` ### -InternalDsnLanguageDetectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InternalDsnLanguageDetectionEnabled parameter specifies whether the server should try to send an internal DSN message in the same language as the original message that generated the notification. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -593,6 +642,9 @@ Accept wildcard characters: False ``` ### -InternalDsnMaxMessageAttachSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The InternalDsnMaxMessageAttachSize parameter specifies the maximum size of the original message that generated an internal DSN message. If the original message exceeds this size, only the headers of the original message are included in the DSN message. The default value is 10 MB. @@ -604,7 +656,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 0 through 2147483647 bytes. If you specify a value of 0, only the original message headers are included in the internal DSN message. @@ -612,7 +664,6 @@ The valid input range for this parameter is from 0 through 2147483647 bytes. If Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -622,13 +673,15 @@ Accept wildcard characters: False ``` ### -InternalDsnReportingAuthority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InternalDsnReportingAuthority parameter specifies the domain in the machine-readable part of internal DSN messages. The default value is blank ($null), which means the value is the authoritative domain that you specified during the creation of the organization. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -638,16 +691,18 @@ Accept wildcard characters: False ``` ### -InternalDsnSendHtml + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InternalDsnSendHtml parameter specifies whether internal DSN messages should be HTML or plain text. Valid values are: -- $true: Internal DSNs are HTML. This is the default value. +- $true: Internal DSNs are HTML. This value is the default. - $false: Internal DSNs are plain text. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -657,6 +712,9 @@ Accept wildcard characters: False ``` ### -InternalSMTPServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The InternalSMTPServers parameter specifies a list of internal SMTP server IP addresses or IP address ranges that should be ignored by Sender ID and connection filtering. @@ -669,7 +727,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -679,6 +736,9 @@ Accept wildcard characters: False ``` ### -JournalMessageExpirationDays + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The JournalMessageExpirationDays parameter extends the number of days that undeliverable journal reports are queued before they expire. A valid value is an integer from 0 to 7. The default value is 0, which means undeliverable journal reports are treated like regular undeliverable messages. @@ -687,7 +747,6 @@ The JournalMessageExpirationDays parameter extends the number of days that undel Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -697,13 +756,15 @@ Accept wildcard characters: False ``` ### -JournalingReportNdrTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The JournalingReportNdrTo parameter specifies the email address to which journal reports are sent if the journaling mailbox is unavailable. By default, if this parameter is left empty, Exchange continues to try to deliver the journal report to the journaling mailbox. We recommended that you use a dedicated (non-user) mailbox as the value for this parameter. Like the journaling mailbox, the alternate journaling mailbox can't be an Exchange Online mailbox. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -713,9 +774,12 @@ Accept wildcard characters: False ``` ### -LegacyJournalingMigrationEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. -The LegacyJournalingMigrationEnabled parameter specifies whether journal messages generated in Microsoft Exchange Server 2003 will be reformatted by Exchange 2010. +The LegacyJournalingMigrationEnabled parameter specifies whether journal messages generated in Microsoft Exchange Server 2003 is reformatted by Exchange 2010. The default value is $false. @@ -723,7 +787,6 @@ The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -733,6 +796,9 @@ Accept wildcard characters: False ``` ### -MaxAllowedAgentGeneratedMessageDepth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxAllowedAgentGeneratedMessageDepth parameter specifies how many times all agents can process any resulting copies of the same message. The default value is 3. Valid input for this parameter is an integer. @@ -741,7 +807,6 @@ The MaxAllowedAgentGeneratedMessageDepth parameter specifies how many times all Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -751,6 +816,9 @@ Accept wildcard characters: False ``` ### -MaxAllowedAgentGeneratedMessageDepthPerAgent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxAllowedAgentGeneratedMessageDepthPerAgent parameter specifies how many times a single agent can process any resulting copies of the same message. The default value is 2. @@ -761,7 +829,6 @@ The value of the MaxAllowedAgentGeneratedMessageDepth parameter should be larger Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -771,6 +838,9 @@ Accept wildcard characters: False ``` ### -MaxDumpsterSizePerDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. @@ -785,7 +855,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. To enable the transport dumpster, the value of the MaxDumpsterSizePerDatabase parameter must be greater than 0, and the value of the MaxDumpsterTime parameter must be greater than 00:00:00. @@ -795,7 +865,6 @@ There's no replacement for this parameter in later versions of Exchange. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -805,6 +874,9 @@ Accept wildcard characters: False ``` ### -MaxDumpsterTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. @@ -823,7 +895,6 @@ This parameter is replaced by the SafetyNetHoldTime parameter. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -833,6 +904,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxReceiveSize parameter specifies the maximum message size that can be received by recipients in the organization. The default value is 10 MB. @@ -844,7 +918,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the value unlimited. @@ -856,7 +930,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -866,6 +939,9 @@ Accept wildcard characters: False ``` ### -MaxRecipientEnvelopeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The MaxRecipientEnvelopeLimit parameter specifies the maximum number of recipients in a message. Exchange treats an unexpanded distribution group as one recipient. In on-premises Exchange, the default value is 500. The valid input range for this parameter is from 0 through 2147483647. If you enter a value of Unlimited, no limit is imposed on the number of recipients in a message. @@ -876,7 +952,6 @@ In Exchange Online, the default value is Unlimited, which means the organization Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -886,6 +961,9 @@ Accept wildcard characters: False ``` ### -MaxRetriesForLocalSiteShadow + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxRetriesForLocalSiteShadow parameter specifies the maximum number of attempts to make a shadow copy of the message in the local Active Directory site. Valid input for this parameter is an integer between 0 and 255. The default value is 2. The total number of attempts to create a shadow copy of the message is controlled by the ShadowMessagePreferenceSetting parameter: @@ -900,7 +978,6 @@ If a shadow copy of the message isn't created after the specified number of atte Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -910,6 +987,9 @@ Accept wildcard characters: False ``` ### -MaxRetriesForRemoteSiteShadow + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxRetriesForRemoteSiteShadow parameter specifies the maximum number of attempts to make a shadow copy of the message in a different Active Directory site. Valid input for this parameter is an integer between 0 and 255. The default value is 4. The total number of attempts to create a shadow copy of the message is controlled by the ShadowMessagePreferenceSetting parameter: @@ -924,7 +1004,6 @@ If a shadow copy of the message isn't created after the specified number of atte Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -934,6 +1013,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MaxSendSize parameter specifies the maximum message size that can be sent by senders in the organization. The default value is 10 MB. @@ -945,7 +1027,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the value unlimited. @@ -957,7 +1039,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -967,6 +1048,9 @@ Accept wildcard characters: False ``` ### -MessageExpiration + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MessageExpiration parameter specifies the message expiration timeout interval for the organization. @@ -977,13 +1061,12 @@ The default value is 1.00:00:00 or 1 day. A valid value is from 12 hours (0.12:00:00) to 24 hours (1.00:00:00). -Queued messages typically expire after 24 hours, resulting in an NDR for failed delivery. If you change this value, the NDR will be sent at the new applicable time. +Queued messages typically expire after 24 hours, resulting in an NDR for failed delivery. If you change this value, the NDR is sent at the new applicable time. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -993,18 +1076,20 @@ Accept wildcard characters: False ``` ### -PreventDuplicateJournalingEnabled + +> Applicable: Exchange Online + 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. +- $false: Journaling messages might be duplicated in hybrid environments. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1014,6 +1099,9 @@ Accept wildcard characters: False ``` ### -QueueDiagnosticsAggregationInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The QueueDiagnosticsAggregationInterval parameter specifies the polling interval that's used to retrieve message queue diagnostic information. The default value is 00:01:00 or one minute. @@ -1024,7 +1112,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1034,12 +1121,15 @@ Accept wildcard characters: False ``` ### -RejectMessageOnShadowFailure + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The RejectMessageOnShadowFailure parameter specifies whether to accept or reject messages when shadow copies of the messages can't be created. Valid values are: - $true: Messages are rejected with the SMTP code 450 4.5.1. Use this value only if you have multiple Mailbox servers in a database availability group (DAG) or in an Active Directory site where shadow copies of the messages can be created. -- $false: Messages are accepted without making shadow copies. This is the default value. +- $false: Messages are accepted without making shadow copies. This value is the default. The number of attempts to make a shadow copy of the message and where to make the shadow copy are controlled by the MaxRetriesForLocalSiteShadow, MaxRetriesForRemoteSiteShadow, and ShadowMessagePreferenceSetting parameter settings. @@ -1047,7 +1137,6 @@ The number of attempts to make a shadow copy of the message and where to make th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1057,6 +1146,9 @@ Accept wildcard characters: False ``` ### -ReplyAllStormBlockDurationHours + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ReplyAllStormBlockDurationHours Description }} @@ -1065,7 +1157,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1075,6 +1166,9 @@ Accept wildcard characters: False ``` ### -ReplyAllStormDetectionMinimumRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ReplyAllStormDetectionMinimumRecipients Description }} @@ -1083,7 +1177,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1093,6 +1186,9 @@ Accept wildcard characters: False ``` ### -ReplyAllStormDetectionMinimumReplies + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ReplyAllStormDetectionMinimumReplies Description }} @@ -1101,7 +1197,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1111,6 +1206,9 @@ Accept wildcard characters: False ``` ### -ReplyAllStormProtectionEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ReplyAllStormProtectionEnabled Description }} @@ -1119,7 +1217,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1129,13 +1226,15 @@ Accept wildcard characters: False ``` ### -Rfc2231EncodingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Rfc2231EncodingEnabled parameter specifies whether the RFC 2231 encoding of MIME parameters for outbound messages is enabled in your organization. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1145,6 +1244,9 @@ Accept wildcard characters: False ``` ### -SafetyNetHoldTime + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SafetyNetHoldTime parameter specifies how long a copy of a successfully processed message is retained in Safety Net. Unacknowledged shadow copies of messages auto-expire from Safety Net based on adding the values of the SafetyNetHoldTime parameter and the MessageExpirationTimeout parameter on the Set-TransportService cmdlet. @@ -1157,7 +1259,6 @@ The default value is 2.00:00:00 or 2 days. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1167,6 +1268,9 @@ Accept wildcard characters: False ``` ### -ShadowHeartbeatFrequency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ShadowHeartbeatFrequency parameter specifies the amount of time a server waits before establishing a connection to a primary server to query the discard status of shadow messages. @@ -1179,7 +1283,6 @@ Valid input for this parameter is 00:00:01 to 1.00:00:00. The default value is 0 Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1189,6 +1292,9 @@ Accept wildcard characters: False ``` ### -ShadowHeartbeatRetryCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. @@ -1201,7 +1307,6 @@ This parameter is replaced by the ShadowResubmitTimeSpan parameter. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1211,6 +1316,9 @@ Accept wildcard characters: False ``` ### -ShadowHeartbeatTimeoutInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. @@ -1227,7 +1335,6 @@ This parameter is replaced by the ShadowHeartbeatFrequency parameter. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1237,6 +1344,9 @@ Accept wildcard characters: False ``` ### -ShadowMessageAutoDiscardInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ShadowMessageAutoDiscardInterval parameter specifies how long a server retains discard events for shadow messages. A primary server queues discard events until queried by the shadow server. However, if the shadow server doesn't query the primary server for the duration specified in this parameter, the primary server deletes the queued discard events. @@ -1249,7 +1359,6 @@ Valid input for this parameter is 00:00:05 to 90.00:00:00. The default value is Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1259,6 +1368,9 @@ Accept wildcard characters: False ``` ### -ShadowMessagePreferenceSetting + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ShadowMessagePreferenceSetting parameter specifies the preferred location for making a shadow copy of a message. Valid values are: @@ -1273,7 +1385,6 @@ The default value is PreferRemote. Type: ShadowMessagePreference Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1283,6 +1394,9 @@ Accept wildcard characters: False ``` ### -ShadowRedundancyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ShadowRedundancyEnabled parameter specifies whether shadow redundancy is enabled in the organization. Valid input for this parameter is $true or $false. The default value is $true. @@ -1291,7 +1405,6 @@ The ShadowRedundancyEnabled parameter specifies whether shadow redundancy is ena Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1301,6 +1414,9 @@ Accept wildcard characters: False ``` ### -ShadowResubmitTimeSpan + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ShadowResubmitTimeSpan parameter specifies amount of time a server waits before deciding that a primary server has failed and assumes ownership of shadow messages in the shadow queue for the primary server that's unreachable. @@ -1315,7 +1431,6 @@ This parameter replaces the ShadowHeartbeatRetryCount parameter. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1325,6 +1440,9 @@ Accept wildcard characters: False ``` ### -SmtpClientAuthenticationDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SmtpClientAuthenticationDisabled parameter specifies whether to disable authenticated SMTP (SMTP AUTH) for the whole organization. Examples of clients and services that require authenticated SMTP to send email messages include: @@ -1336,7 +1454,7 @@ The SmtpClientAuthenticationDisabled parameter specifies whether to disable auth Valid values for this parameter are: -- $true: Authenticated SMTP is disabled. This is the default value for organizations created after January 2020. +- $true: Authenticated SMTP is disabled. This value is the default for organizations created after January 2020. - $false: Authenticated SMTP is enabled. The corresponding parameter that controls authenticated SMTP on individual mailboxes is the SmtpClientAuthenticationDisabled parameter on the Set-CASMailbox cmdlet. The default mailbox value is blank ($null), which means the mailbox setting is controlled by this organizational setting. @@ -1347,7 +1465,6 @@ To selectively enable authenticated SMTP for specific mailboxes only: disable au Type: Boolean Parameter Sets: Exchange Online Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1357,6 +1474,9 @@ Accept wildcard characters: False ``` ### -SupervisionTags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The SupervisionTags parameter specifies the various tags that are used for transport supervision in the organization. @@ -1367,7 +1487,6 @@ When you install Exchange, two tags, Allow and Reject, are created by default. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1377,6 +1496,9 @@ Accept wildcard characters: False ``` ### -TLSReceiveDomainSecureList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The TLSReceiveDomainSecureList parameter specifies the domains from which you want to receive domain secured email by using mutual Transport Layer Security (TLS) authentication. To fully support mutual TLS authentication, you must also perform the following steps: @@ -1395,7 +1517,6 @@ The wildcard character (\*) isn't supported in the domains listed in the TLSRece Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1405,6 +1526,9 @@ Accept wildcard characters: False ``` ### -TLSSendDomainSecureList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The TLSSendDomainSecureList parameter specifies the domains from which you want to send domain secured email by using mutual TLS authentication. To fully support mutual TLS authentication, you must also perform the following steps: @@ -1417,13 +1541,12 @@ 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"...}`. -Multiple domains may be separated by commas. The wildcard character (\*) isn't supported in the domains listed in the TLSSendDomainSecureList parameter or in the TLSReceiveSecureList parameter. The default values for both parameters are an empty list ({}). +Multiple domains might be separated by commas. The wildcard character (\*) isn't supported in the domains listed in the TLSSendDomainSecureList parameter or in the TLSReceiveSecureList parameter. The default values for both parameters are an empty list ({}). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1433,6 +1556,9 @@ Accept wildcard characters: False ``` ### -TransportRuleAttachmentTextScanLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The TransportRuleAttachmentTextScanLimit parameter specifies the maximum size of text to extract from attachments for scanning by attachment scanning predicates in transport rules and data loss prevention (DLP) policies. @@ -1444,7 +1570,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. In Exchange Online, Exchange 2019, and Exchange 2016, the default value is 1 MB (1,048,576 bytes). In Exchange 2013, the default value is 150 KB (153,600 bytes). @@ -1454,7 +1580,6 @@ If the amount of text in the attachment is larger than the value of this paramet Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1464,6 +1589,9 @@ Accept wildcard characters: False ``` ### -VerifySecureSubmitEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The VerifySecureSubmitEnabled parameter verifies that email clients submitting messages from mailboxes on Mailbox servers are using encrypted MAPI submission. The valid values for this parameter are $true or $false. The default value is $false @@ -1476,7 +1604,6 @@ If the VerifySecureSubmitEnabled parameter is set to $false, all MAPI message su Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1486,6 +1613,9 @@ Accept wildcard characters: False ``` ### -VoicemailJournalingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in on-premises Exchange. The VoicemailJournalingEnabled parameter specifies whether Unified Messaging voice mail messages are journaled by the Journaling agent. Valid input for this parameter is $true or $false. The default value is $true. @@ -1494,7 +1624,6 @@ The VoicemailJournalingEnabled parameter specifies whether Unified Messaging voi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1504,13 +1633,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1520,6 +1651,9 @@ Accept wildcard characters: False ``` ### -Xexch50Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Xexch50Enabled parameter specifies whether Xexch50 authentication should be enabled for backward compatibility with computers running Exchange 2003. Valid input for this parameter is $true or $false. The default value is $true. @@ -1528,7 +1662,6 @@ The Xexch50Enabled parameter specifies whether Xexch50 authentication should be Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-TransportRule.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TransportRule.md index d5e0d7dd39..876e36276c 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TransportRule.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-transportrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-TransportRule -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-transportrule +schema: 2.0.0 +title: Set-TransportRule --- # Set-TransportRule ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-TransportRule cmdlet to modify existing transport rules (mail flow rules) in your organization. @@ -209,9 +210,9 @@ Set-TransportRule [-Identity] ## DESCRIPTION In on-premises Exchange organizations, rules created on Mailbox servers are stored in Active Directory. All Mailbox servers in the organization have access to the same set of rules. On Edge Transport servers, rules are saved in the local copy of Active Directory Lightweight Directory Services (AD LDS). Rules aren't shared or replicated between Edge Transport servers or between Mailbox servers and Edge Transport servers. Also, some conditions and actions are exclusive to each server role. -The search for words or text patterns in the subject or other header fields in the message occurs after the message has been decoded from the MIME content transfer encoding method that was used to transmit the binary message between SMTP servers in ASCII text. You can't use conditions or exceptions to search for the raw (typically, Base64) encoded values of the subject or other header fields in messages. +The search for words or text patterns in the subject or other header fields in the message occurs after the message is decoded from the MIME content transfer encoding method that was used to transmit the binary message between SMTP servers in ASCII text. You can't use conditions or exceptions to search for the raw (typically, Base64) encoded values of the subject or other header fields in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -225,6 +226,9 @@ This example modifies the existing rule named Sales Team Disclaimer transport ru ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -235,7 +239,6 @@ The Identity parameter specifies the rule that you want to modify. You can use a Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -245,7 +248,10 @@ 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. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + +The ActivationDate parameter specifies when the rule starts processing messages. The rule doesn'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". @@ -253,7 +259,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -263,6 +268,9 @@ Accept wildcard characters: False ``` ### -ADComparisonAttribute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -305,7 +313,6 @@ If you don't use the ADComparisonOperator parameter, the default comparison oper Type: ADAttribute Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -315,20 +322,22 @@ Accept wildcard characters: False ``` ### -ADComparisonOperator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. The ADComparisonOperator parameter specifies the comparison operator for the ADComparisonAttribute parameter. Valid values are: -- Equal (This is the default value) +- Equal (default value) - NotEqual ```yaml Type: Evaluation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -338,6 +347,9 @@ Accept wildcard characters: False ``` ### -AddManagerAsRecipientType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -355,7 +367,6 @@ This action only works if the sender's Manager attribute is defined. Type: AddedRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -365,6 +376,9 @@ Accept wildcard characters: False ``` ### -AddToRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -384,7 +398,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -394,6 +407,9 @@ Accept wildcard characters: False ``` ### -AnyOfCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -417,7 +433,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -427,6 +442,9 @@ Accept wildcard characters: False ``` ### -AnyOfCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -450,7 +468,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -460,6 +477,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -474,7 +494,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -484,6 +503,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -498,7 +520,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,6 +529,9 @@ Accept wildcard characters: False ``` ### -AnyOfToCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -531,7 +555,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -541,6 +564,9 @@ Accept wildcard characters: False ``` ### -AnyOfToCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -564,7 +590,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -574,6 +599,9 @@ Accept wildcard characters: False ``` ### -AnyOfToHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -597,7 +625,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -607,6 +634,9 @@ Accept wildcard characters: False ``` ### -AnyOfToHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -630,7 +660,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -640,6 +669,9 @@ Accept wildcard characters: False ``` ### -ApplyClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -652,7 +684,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -662,13 +693,16 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerFallbackAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be applied to a message (for example, encrypted or signed messages where the contents can't be altered). Valid values are: -- Wrap: This is the default value. A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. +- Wrap: This value is the default. A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. If you want other rules to examine and act on the original message (which is now an attachment in the new message), make sure those rules are applied _before_ the disclaimer rule by using a lower priority for the disclaimer rule and higher priority for other rules. @@ -685,7 +719,6 @@ If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the Type: DisclaimerFallbackAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -695,13 +728,16 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 ApplyHtmlDisclaimerLocation parameter specifies where to insert the HTML disclaimer text in the body of messages. Valid values are: -- Append: The disclaimer is added to the end of the message body. This is the default value. +- Append: The disclaimer is added to the end of the message body. This value is the default. - Prepend: The disclaimer is inserted at the beginning of the message body. If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Append is used. @@ -710,7 +746,6 @@ If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the Type: DisclaimerLocation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -720,6 +755,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -760,7 +798,6 @@ You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the Type: DisclaimerText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -770,6 +807,9 @@ Accept wildcard characters: False ``` ### -ApplyOME + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -783,7 +823,6 @@ The ApplyOME parameter specifies an action that encrypts messages and their atta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -793,6 +832,9 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionCustomizationTemplate + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -803,7 +845,6 @@ The ApplyRightsProtectionCustomizationTemplate parameter specifies an action tha Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -813,6 +854,9 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -829,7 +873,6 @@ For more information, see [Transport protection rules](https://learn.microsoft.c Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -839,6 +882,9 @@ Accept wildcard characters: False ``` ### -AttachmentContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -851,7 +897,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -861,6 +906,9 @@ Accept wildcard characters: False ``` ### -AttachmentExtensionMatchesWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -873,7 +921,6 @@ The AttachmentExtensionMatchesWords parameter specifies a condition that looks f Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -883,6 +930,9 @@ Accept wildcard characters: False ``` ### -AttachmentHasExecutableContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -898,7 +948,6 @@ The system inspects the file properties rather than relying on the file extensio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -908,6 +957,9 @@ Accept wildcard characters: False ``` ### -AttachmentIsPasswordProtected + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -921,7 +973,6 @@ The AttachmentIsPasswordProtected parameter specifies a condition that looks for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -931,6 +982,9 @@ Accept wildcard characters: False ``` ### -AttachmentIsUnsupported + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -950,7 +1004,6 @@ In Exchange 2010, to extend the list of supported file types, see [Register Filt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -960,6 +1013,9 @@ Accept wildcard characters: False ``` ### -AttachmentMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -974,7 +1030,6 @@ Only the first 150 kilobytes (KB) of the attachment is scanned when trying to ma Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -984,6 +1039,9 @@ Accept wildcard characters: False ``` ### -AttachmentNameMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -994,7 +1052,6 @@ The AttachmentNameMatchesPatterns parameter specifies a condition that looks for Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1004,6 +1061,9 @@ Accept wildcard characters: False ``` ### -AttachmentProcessingLimitExceeded + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1019,7 +1079,6 @@ You use this condition to create rules that work together with other attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1029,11 +1088,14 @@ Accept wildcard characters: False ``` ### -AttachmentPropertyContainsWords + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. -The AttachmentPropertyContainsWords parameter specifies a condition that looks for words in the properties of attached Office documents. This condition helps integrate mail flow rules (transport rules) with the File Classification Infrastructure (FCI) in Windows Server 2012 R2 or later, SharePoint, or a third-party classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: +The AttachmentPropertyContainsWords parameter specifies a condition that looks for words in the properties of attached Office documents. This condition helps integrate mail flow rules (transport rules) with the File Classification Infrastructure (FCI) in Windows Server 2012 R2 or later, SharePoint, or a non-Microsoft classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: - Business Impact - Compliancy @@ -1058,7 +1120,6 @@ When you specify multiple properties, or multiple values for the same property, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1068,6 +1129,9 @@ Accept wildcard characters: False ``` ### -AttachmentSizeOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -1082,15 +1146,14 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. -The embedded images are treated as attachments (for example, messages with a picture in the signature); for this reason, we do not recommend using a very small value since unexpected messages will be blocked. +The embedded images are treated as attachments (for example, messages with a picture in the signature). For this reason, we don't recommend using a very small value, since unexpected messages are blocked. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1100,6 +1163,9 @@ Accept wildcard characters: False ``` ### -BetweenMemberOf1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1119,7 +1185,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1129,6 +1194,9 @@ Accept wildcard characters: False ``` ### -BetweenMemberOf2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1148,7 +1216,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1158,6 +1225,9 @@ Accept wildcard characters: False ``` ### -BlindCopyTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1177,7 +1247,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1187,13 +1256,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Comments parameter specifies optional descriptive text for the rule (for example, what the rule is used for, or how it has changed over time). The length of the comment can't exceed 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1203,6 +1274,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -1212,7 +1286,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -1222,6 +1295,9 @@ Accept wildcard characters: False ``` ### -ContentCharacterSetContainsWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1234,7 +1310,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1244,6 +1319,9 @@ Accept wildcard characters: False ``` ### -CopyTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1263,7 +1341,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1273,6 +1350,9 @@ Accept wildcard characters: False ``` ### -DeleteMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1286,7 +1366,6 @@ The DeleteMessage parameter specifies an action that silently drops messages wit Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1296,6 +1375,9 @@ Accept wildcard characters: False ``` ### -Disconnect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -1309,7 +1391,6 @@ The Disconnect parameter specifies an action that ends the SMTP connection betwe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1319,6 +1400,9 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note**: This parameter is functional only in on-premises Exchange. The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see [Data loss prevention in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). @@ -1327,7 +1411,6 @@ The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's a Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1337,6 +1420,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -1347,7 +1433,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1357,6 +1442,9 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonAttribute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1399,7 +1487,6 @@ If you don't use the ExceptIfADComparisonOperator parameter, the default compari Type: ADAttribute Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1409,20 +1496,22 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonOperator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfADComparisonOperator parameter specifies the comparison operator for the ExceptIfADComparisonAttribute parameter. Valid values are: -- Equal (This is the default value) +- Equal (default value) - NotEqual ```yaml Type: Evaluation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1432,6 +1521,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1455,7 +1547,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1465,6 +1556,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1488,7 +1582,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1498,6 +1591,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1512,7 +1608,6 @@ A match for this exception prevents the rule action from being applied to all re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1522,6 +1617,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1536,7 +1634,6 @@ A match for this exception prevents the rule action from being applied to all re Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1546,6 +1643,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1569,7 +1669,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1579,6 +1678,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1602,7 +1704,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1612,6 +1713,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1635,7 +1739,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1645,6 +1748,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1668,7 +1774,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1678,6 +1783,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1690,7 +1798,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1700,6 +1807,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentExtensionMatchesWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1712,7 +1822,6 @@ The ExceptIfAttachmentExtensionMatchesWords parameter specifies an exception tha Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1722,6 +1831,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentHasExecutableContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1737,7 +1849,6 @@ The system inspects the file properties rather than relying on the file extensio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1747,6 +1858,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsPasswordProtected + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1760,7 +1874,6 @@ The ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1770,6 +1883,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsUnsupported + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1789,7 +1905,6 @@ In Exchange 2010, to extend the list of supported file types, see [Register Filt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1799,6 +1914,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1813,7 +1931,6 @@ Only the first 150 KB of the attachment is scanned when trying to match a text p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1823,6 +1940,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentNameMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1833,7 +1953,6 @@ The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1843,6 +1962,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentProcessingLimitExceeded + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1858,7 +1980,6 @@ You use this exception to create rules that work together with other attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1868,11 +1989,14 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentPropertyContainsWords + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. -The ExceptIfAttachmentPropertyContainsWords parameter specifies an exception that looks for words in the properties of attached Office documents. This condition helps integrate rules with the File Classification Infrastructure (FCI) in Windows Server 2018 R2 or later, SharePoint, or a third-party classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: +The ExceptIfAttachmentPropertyContainsWords parameter specifies an exception that looks for words in the properties of attached Office documents. This condition helps integrate rules with the File Classification Infrastructure (FCI) in Windows Server 2018 R2 or later, SharePoint, or a non-Microsoft classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: - Business Impact - Compliancy @@ -1897,7 +2021,6 @@ When you specify multiple properties, or multiple values for the same property, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1907,6 +2030,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentSizeOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1921,13 +2047,12 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1937,6 +2062,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1956,7 +2084,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1966,6 +2093,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1985,7 +2115,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1995,6 +2124,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2007,7 +2139,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2017,6 +2148,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2038,7 +2172,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2048,6 +2181,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2060,7 +2196,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2070,6 +2205,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2084,7 +2222,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2094,6 +2231,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2115,7 +2255,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2125,6 +2264,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2138,7 +2280,6 @@ The ExceptIfFromScope parameter specifies an exception that looks for the locati Type: FromUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2148,6 +2289,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2164,7 +2308,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2174,6 +2317,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasNoClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2187,7 +2333,6 @@ The ExceptIfHasNoClassification parameter specifies an exception that looks for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2197,6 +2342,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. @@ -2212,7 +2360,6 @@ The ExceptIfHasSenderOverride parameter specifies an exception that looks for me Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2222,6 +2369,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2232,7 +2382,6 @@ The ExceptIfHeaderContainsMessageHeader parameter specifies the name of header f Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2242,6 +2391,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2256,7 +2408,6 @@ You specify the header field to search by using the ExceptIfHeaderContainsMessag Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2266,6 +2417,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2276,7 +2430,6 @@ The ExceptIfHeaderMatchesMessageHeader parameter specifies the name of header fi Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2286,6 +2439,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2298,7 +2454,6 @@ You specify the header field to search by using the ExceptIfHeaderMatchesMessage Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2308,6 +2463,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2329,7 +2487,6 @@ You specify if you want to look for these users as managers of senders or recipi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2339,6 +2496,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerForEvaluatedUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2354,7 +2514,6 @@ You specify the users to look for by using the ExceptIfManagerAddresses paramete Type: EvaluatedUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2364,6 +2523,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageContainsDataClassifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. @@ -2380,7 +2542,6 @@ For a list of sensitive information types available, see [Sensitive information Type: Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2390,6 +2551,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2404,13 +2568,12 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2420,6 +2583,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2427,7 +2593,7 @@ In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this exception **will not** match during mail flow rule evaluation. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message is forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this exception **does not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -2440,7 +2606,6 @@ The ExceptIfMessageTypeMatches parameter specifies an exception that looks for m Type: MessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2450,6 +2615,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2496,7 +2664,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2506,6 +2673,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2550,7 +2720,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2560,6 +2729,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2570,7 +2742,6 @@ The ExceptIfRecipientAddressContainsWords parameter specifies an exception that Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2580,6 +2751,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2592,7 +2766,6 @@ This parameter works when the recipient is an individual user. This parameter do Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2602,6 +2775,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2614,7 +2790,6 @@ This exception matches domains and subdomains. For example, "contoso.com" matche Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2624,6 +2799,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientInSenderList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2632,7 +2810,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2642,6 +2819,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2657,7 +2837,6 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2667,6 +2846,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2713,7 +2895,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2723,6 +2904,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2767,7 +2951,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2777,6 +2960,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2791,7 +2977,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2801,6 +2986,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderInRecipientList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2809,7 +2997,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2819,6 +3006,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIpRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2831,13 +3021,12 @@ The ExceptIfSenderIpRanges parameter specifies an exception that looks for sende You can specify multiple values separated by commas. -In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. +In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if non-Microsoft software is used during message transport. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2847,6 +3036,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderManagementRelationship + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2860,7 +3052,6 @@ The ExceptIfSenderManagementRelationship parameter specifies an exception that l Type: ManagementRelationship Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2870,6 +3061,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2889,7 +3083,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2899,6 +3092,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: @@ -2916,7 +3112,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2926,6 +3121,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2941,7 +3139,6 @@ The ExceptIfSentToScope parameter specifies an exception that looks for the loca Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2951,6 +3148,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2965,7 +3165,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2975,6 +3174,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2985,7 +3187,6 @@ The ExceptIfSubjectMatchesPatterns parameter specifies an exception that looks f Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2995,6 +3196,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3009,7 +3213,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3019,6 +3222,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3029,7 +3235,6 @@ The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception that l Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3039,6 +3244,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -3053,7 +3261,6 @@ The ExceptIfWithImportance parameter specifies an exception that looks for messa Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3063,9 +3270,12 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. +The ExpiryDate parameter specifies when this rule stops processing messages. The rule doesn'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". @@ -3073,7 +3283,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3083,6 +3292,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3104,7 +3316,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3114,6 +3325,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3126,7 +3340,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3136,6 +3349,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3150,7 +3366,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3160,6 +3375,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3181,7 +3399,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3191,6 +3408,9 @@ Accept wildcard characters: False ``` ### -FromScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3204,7 +3424,6 @@ The FromScope parameter specifies a condition that looks for the location of mes Type: FromUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3214,6 +3433,9 @@ Accept wildcard characters: False ``` ### -GenerateIncidentReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -3233,7 +3455,6 @@ The GenerateIncidentReport parameter specifies where to send the incident report Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3243,6 +3464,9 @@ Accept wildcard characters: False ``` ### -GenerateNotification + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -3264,7 +3488,6 @@ The maximum number of characters is 5120. Type: DisclaimerText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3274,6 +3497,9 @@ Accept wildcard characters: False ``` ### -HasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3290,7 +3516,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3300,6 +3525,9 @@ Accept wildcard characters: False ``` ### -HasNoClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3313,7 +3541,6 @@ The HasNoClassification parameter specifies a condition that looks for messages Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3323,6 +3550,9 @@ Accept wildcard characters: False ``` ### -HasSenderOverride + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. @@ -3338,7 +3568,6 @@ The HasSenderOverride parameter specifies a condition that looks for messages wh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3348,6 +3577,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3358,7 +3590,6 @@ The HeaderContainsMessageHeader parameter specifies the name of header field in Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3368,6 +3599,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3382,7 +3616,6 @@ You specify the header field to search by using the HeaderContainsMessageHeader Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3392,6 +3625,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3402,7 +3638,6 @@ The HeaderMatchesMessageHeader parameter specifies the name of header field in t Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3412,6 +3647,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3424,7 +3662,6 @@ You specify the header field to search by using the HeaderMatchesMessageHeader p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3434,6 +3671,9 @@ Accept wildcard characters: False ``` ### -IncidentReportContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -3441,10 +3681,10 @@ In on-premises Exchange, this action is available only on Mailbox servers. The IncidentReportContent parameter specifies the message properties that are included in the incident report. Valid values are: - Sender: The sender of the message. -- Recipients: The recipients in the To field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. +- Recipients: The recipients in the To field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients is displayed. - Subject: The Subject field of the message. -- CC: The recipients in the Cc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. -- BCC: The recipients in the Bcc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. +- CC: The recipients in the Cc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients is displayed. +- BCC: The recipients in the Bcc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients is displayed. - Severity: The audit severity of the rule that was triggered. If the message was processed by more than one rule, the highest severity is displayed. - RuleDetections: The list of rules that the message triggered. - FalsePositive: The false positive if the sender marked the message as a false positive for a PolicyTip. @@ -3461,7 +3701,6 @@ You use this parameter with the GenerateIncidentReport parameter. Type: IncidentReportContent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3471,15 +3710,18 @@ Accept wildcard characters: False ``` ### -IncidentReportOriginalMail + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. -This parameter has been deprecated and is no longer used. Use the IncidentReportContent parameter instead. The value AttachOriginalMail on the IncidentReportContent parameter is equivalent to setting this parameter to the value IncludeOriginalMail. +This parameter is deprecated and no longer used. Use the IncidentReportContent parameter instead. The value AttachOriginalMail on the IncidentReportContent parameter is equivalent to setting this parameter to the value IncludeOriginalMail. 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 IncidentReportOriginalMail parameter specifies whether to include the original message with the incident report. This parameter is used together with the GenerateIncidentReport parameter. Valid values are: +The IncidentReportOriginalMail parameter specifies whether to include the original message with the incident report. Use this parameter with the GenerateIncidentReport parameter. Valid values are: - IncludeOriginalMail - DoNotIncludeOriginalMail (this is the default value) @@ -3488,7 +3730,6 @@ The IncidentReportOriginalMail parameter specifies whether to include the origin Type: IncidentReportOriginalMail Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -3498,6 +3739,9 @@ Accept wildcard characters: False ``` ### -LogEventText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -3516,7 +3760,6 @@ The entry contains the following information: Type: EventLogText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3526,6 +3769,9 @@ Accept wildcard characters: False ``` ### -ManagerAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3547,7 +3793,6 @@ You specify if you want to look for these users as managers of senders or recipi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3557,6 +3802,9 @@ Accept wildcard characters: False ``` ### -ManagerForEvaluatedUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3572,7 +3820,6 @@ You specify the users to look for by using the ManagerAddresses parameter. Type: EvaluatedUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3582,6 +3829,9 @@ Accept wildcard characters: False ``` ### -MessageContainsDataClassifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. @@ -3600,7 +3850,6 @@ You can specify the notification options by using the NotifySender parameter. Type: Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3610,6 +3859,9 @@ Accept wildcard characters: False ``` ### -MessageSizeOver + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3624,13 +3876,12 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3640,6 +3891,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3647,7 +3901,7 @@ In on-premises Exchange, this condition is available only on Mailbox servers. The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this condition **will not** match during mail flow rule evaluation. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message is forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this condition **does not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -3660,7 +3914,6 @@ The MessageTypeMatches parameter specifies a condition that looks for messages o Type: MessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3670,17 +3923,19 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Mode parameter specifies how the rule operates. Valid values are: -- Audit: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport action occurs. -- AuditAndNotify: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport and GenerateNotification actions occur. -- Enforce: All actions specified in the rule are taken. This is the default value. +- Audit: The actions that the rule would have taken are written to the message tracking log, but no action that affects message delivery is taken on the message. The GenerateIncidentReport action occurs. +- AuditAndNotify: The actions that the rule would have taken are written to the message tracking log, but no action that affects message delivery is taken on the message. The GenerateIncidentReport and GenerateNotification actions occur. +- Enforce: All actions specified in the rule are taken. This value is the default. ```yaml Type: RuleMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3690,6 +3945,9 @@ Accept wildcard characters: False ``` ### -ModerateMessageByManager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -3705,7 +3963,6 @@ This action only works if the sender's Manager attribute is defined. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3715,6 +3972,9 @@ Accept wildcard characters: False ``` ### -ModerateMessageByUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -3736,7 +3996,6 @@ You can't use a distribution group as a moderator. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3746,13 +4005,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the display name of the transport rule to be created. The length of the name canThe Name parameter specifies the unique name of the rule. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3762,6 +4023,9 @@ Accept wildcard characters: False ``` ### -NotifySender + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -3780,13 +4044,12 @@ For all values except NotifyOnly, you can specify an enhanced status code and a If you use this parameter, you also need to specify a condition that looks for sensitive information types in messages by using the MessageContainsDataClassifications parameter. -This action is applicable to messages sent by internal users only. External senders will not receive notifications. +This action applies to messages sent by internal users only. External senders don't receive notifications. ```yaml Type: NotifySenderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3796,6 +4059,9 @@ Accept wildcard characters: False ``` ### -PrependSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -3808,7 +4074,6 @@ Consider ending the value for this parameter with a colon (:) and a space, or at Type: SubjectPrefix Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3818,6 +4083,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -3832,7 +4100,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3842,6 +4109,9 @@ Accept wildcard characters: False ``` ### -Quarantine + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Edge Transport servers. @@ -3857,7 +4127,6 @@ If this action is in a rule that's not the last rule in the list, rule evaluatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3867,6 +4136,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3913,7 +4185,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3923,6 +4194,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3967,7 +4241,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3977,6 +4250,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3987,7 +4263,6 @@ The RecipientAddressContainsWords parameter specifies a condition that looks for Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3997,6 +4272,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4009,7 +4287,6 @@ This parameter works when the recipient is an individual user. This parameter do Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4019,18 +4296,20 @@ Accept wildcard characters: False ``` ### -RecipientAddressType + +> Applicable: Exchange Online, Exchange Online Protection + 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 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. +- Resolved: The rule checks the recipient's primary SMTP email address without checking any proxy addresses. This value is the default. ```yaml Type: RecipientAddressType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4040,6 +4319,9 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4052,7 +4334,6 @@ This condition matches domains and subdomains. For example, "contoso.com" matche Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4062,6 +4343,9 @@ Accept wildcard characters: False ``` ### -RecipientInSenderList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -4070,7 +4354,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4080,6 +4363,9 @@ Accept wildcard characters: False ``` ### -RedirectMessageTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4099,7 +4385,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4109,6 +4394,9 @@ Accept wildcard characters: False ``` ### -RejectMessageEnhancedStatusCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -4125,7 +4413,6 @@ To further customize the NDR (for example, multiple languages), you need to crea Type: RejectEnhancedStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4135,6 +4422,9 @@ Accept wildcard characters: False ``` ### -RejectMessageReasonText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -4155,7 +4445,6 @@ To further customize the NDR (for example, multiple languages), you need to crea Type: RejectText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4165,6 +4454,9 @@ Accept wildcard characters: False ``` ### -RemoveHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4175,7 +4467,6 @@ The RemoveHeader parameter specifies an action that removes a header field from Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4185,6 +4476,9 @@ Accept wildcard characters: False ``` ### -RemoveOME + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4198,7 +4492,6 @@ The RemoveOME parameter specifies an action that removes the previous version of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4208,6 +4501,9 @@ Accept wildcard characters: False ``` ### -RemoveOMEv2 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4221,7 +4517,6 @@ The RemoveOMEv2 parameter specifies an action that removes Office 365 Message En Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4231,6 +4526,9 @@ Accept wildcard characters: False ``` ### -RemoveRMSAttachmentEncryption + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4246,7 +4544,6 @@ The RemoveRMSAttachmentEncryption parameter specifies an action that removes Mic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4256,6 +4553,9 @@ Accept wildcard characters: False ``` ### -RouteMessageOutboundConnector + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4270,7 +4570,6 @@ The RouteMessageOutboundConnector parameter specifies an action that routes mess Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4280,6 +4579,9 @@ Accept wildcard characters: False ``` ### -RouteMessageOutboundRequireTls + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -4293,7 +4595,6 @@ The RouteMessageOutboundRequireTls parameter specifies an action that uses Trans Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4303,16 +4604,18 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RuleErrorAction parameter specifies what to do if rule processing can't be completed on messages. Valid values are: -- Ignore: The message is sent anyway. This is the default value. +- Ignore: The message is sent anyway. This value is the default. - Defer: The message is deferred so the rules engine can attempt to process the message again. ```yaml Type: RuleErrorAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4322,16 +4625,18 @@ Accept wildcard characters: False ``` ### -RuleSubType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RuleSubType parameter specifies the rule type. Valid values are: - Dlp: The rule is associated with a DLP policy. This value is meaningful only in on-premises Exchange. -- None: The rule is a regular transport rule. This is the default value. +- None: The rule is a regular transport rule. This value is the default. ```yaml Type: RuleSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4341,6 +4646,9 @@ Accept wildcard characters: False ``` ### -SCLOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4356,7 +4664,6 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4366,6 +4673,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4412,7 +4722,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4422,6 +4731,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4466,7 +4778,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4476,9 +4787,12 @@ Accept wildcard characters: False ``` ### -SenderAddressLocation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 the From, Sender, or Reply-To fields. In Exchange Online, the From field only. This value is the default, 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. @@ -4494,7 +4808,6 @@ Message envelope searching is available only for the following conditions and ex Type: SenderAddressLocation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4504,6 +4817,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4518,7 +4834,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4528,6 +4843,9 @@ Accept wildcard characters: False ``` ### -SenderInRecipientList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -4536,7 +4854,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4546,6 +4863,9 @@ Accept wildcard characters: False ``` ### -SenderIpRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4558,13 +4878,12 @@ The SenderIpRanges parameter specifies a condition that looks for senders whose You can specify multiple values separated by commas. -In Exchange Online, the IP address that's used during evaluation of this condition is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. +In Exchange Online, the IP address that's used during evaluation of this condition is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if non-Microsoft software is used during message transport. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4574,6 +4893,9 @@ Accept wildcard characters: False ``` ### -SenderManagementRelationship + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4587,7 +4909,6 @@ The SenderManagementRelationship parameter specifies a condition that looks for Type: ManagementRelationship Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4597,6 +4918,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4616,7 +4940,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4626,6 +4949,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4647,7 +4973,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4657,6 +4982,9 @@ Accept wildcard characters: False ``` ### -SentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4672,7 +5000,6 @@ The SentToScope parameter specifies a condition that looks for the location of r Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4682,6 +5009,9 @@ Accept wildcard characters: False ``` ### -SetAuditSeverity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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. @@ -4697,7 +5027,6 @@ The SetAuditSeverity parameter specifies an action that sets the severity level Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4707,6 +5036,9 @@ Accept wildcard characters: False ``` ### -SetHeaderName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4717,7 +5049,6 @@ The SetHeaderName parameter specifies an action that adds or modifies a header f Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4727,6 +5058,9 @@ Accept wildcard characters: False ``` ### -SetHeaderValue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4737,7 +5071,6 @@ The SetHeaderValue parameter specifies an action that adds or modifies a header Type: HeaderValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4747,6 +5080,9 @@ Accept wildcard characters: False ``` ### -SetSCL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4760,7 +5096,6 @@ The SetSCL parameter specifies an action that adds or modifies the SCL value of Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4770,6 +5105,9 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectStatusCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4782,7 +5120,6 @@ You can use this parameter with the SmtpRejectMessageRejectText parameter. If yo Type: RejectStatusCode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4792,6 +5129,9 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4804,7 +5144,6 @@ You can use this parameter with the SmtpRejectMessageRejectStatusCode parameter. Type: RejectText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4814,6 +5153,9 @@ Accept wildcard characters: False ``` ### -StopRuleProcessing + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4827,7 +5169,6 @@ The StopRuleProcessing parameter specifies an action that stops processing more Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4837,6 +5178,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4851,7 +5195,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4861,6 +5204,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4871,7 +5217,6 @@ The SubjectMatchesPatterns parameter specifies a condition that looks for text p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4881,6 +5226,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4895,7 +5243,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4905,6 +5252,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4915,7 +5265,6 @@ The SubjectOrBodyMatchesPatterns parameter specifies a condition that looks for Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4925,13 +5274,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4941,6 +5292,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4955,7 +5309,6 @@ The WithImportance parameter specifies a condition that looks for messages with Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TransportServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-TransportServer.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-TransportServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TransportServer.md index 00b90e63b6..5fc2ac7ac3 100644 --- a/exchange/exchange-ps/exchange/Set-TransportServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TransportServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-transportserver -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-TransportServer -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-transportserver +schema: 2.0.0 +title: Set-TransportServer --- # Set-TransportServer @@ -122,7 +123,7 @@ Set-TransportServer [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -150,6 +151,9 @@ This example sets the ReceiveProtocolLogPath parameter to C:\\SMTP Protocol Logs ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Transport server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -161,7 +165,6 @@ The Identity parameter specifies the Transport server that you want to modify. Y Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -171,6 +174,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveUserStatisticsLogMaxAge parameter specifies the maximum duration that the per user activity statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -181,7 +187,6 @@ For example, to specify 10 days for this parameter, use 10.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,6 +196,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveUserStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the per user activity statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 megabyte (MB). The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -201,7 +209,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than or equal to the value of the ActiveUserStatisticsLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the server statistics log directory. @@ -209,7 +217,6 @@ The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,6 +226,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveUserStatisticsLogMaxFileSize parameter specifies the maximum file size for the per user activity statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -229,7 +239,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than or equal to the value of the ActiveUserStatisticsLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the server statistics log files. @@ -237,7 +247,6 @@ The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -247,6 +256,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveUserStatisticsLogPath parameter specifies the location of per user activity statistics log storage. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\ActiveUsersStats. @@ -258,7 +270,6 @@ Setting the value of this parameter to $null disables server statistics logging. Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -268,13 +279,15 @@ Accept wildcard characters: False ``` ### -AgentLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,6 +297,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogMaxAge parameter specifies the maximum age for the agent log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -294,7 +310,6 @@ Setting the value of the AgentLogMaxAge parameter to 00:00:00 prevents the autom Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,6 +319,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogMaxDirectorySize parameter specifies the maximum size of all agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -314,7 +332,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the AgentLogMaxFileSize parameter must be less than or equal to the value of the AgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log directory. @@ -322,7 +340,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,6 +349,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogMaxFileSize parameter specifies the maximum size of each agent log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -342,7 +362,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the AgentLogMaxFileSize parameter must be less than or equal to the value of the AgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log files. @@ -350,7 +370,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -360,13 +379,15 @@ Accept wildcard characters: False ``` ### -AgentLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogPath parameter specifies the default agent log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\AgentLog. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the AgentLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -376,6 +397,9 @@ Accept wildcard characters: False ``` ### -AntispamAgentsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AntispamAgentsEnabled parameter specifies whether anti-spam agents are installed on the server specified with the Identity parameter. The default value is $false for the Transport service on Mailbox servers and $true on Edge servers. You set this parameter by using a script. You shouldn't modify this parameter manually. @@ -384,7 +408,6 @@ You set this parameter by using a script. You shouldn't modify this parameter ma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -394,6 +417,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -403,7 +429,6 @@ 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 Required: False Position: Named @@ -413,13 +438,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -429,6 +456,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxAge parameter specifies the maximum age for the connectivity log file. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -439,7 +469,6 @@ For example, to specify 25 days for this parameter, use 25.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -449,6 +478,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all connectivity logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 1000 MB. When you enter a value, qualify the value with one of the following units: @@ -459,7 +491,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ConnectivityLogMaxFileSize parameter must be less than or equal to the value of the ConnectivityLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the connectivity log directory. @@ -467,7 +499,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -477,6 +508,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxFileSize parameter specifies the maximum size of each connectivity log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -487,7 +521,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ConnectivityLogMaxFileSize parameter must be less than or equal to the value of the ConnectivityLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the connectivity log files. @@ -495,7 +529,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -505,6 +538,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Connectivity @@ -516,7 +552,6 @@ Setting the value of this parameter to $null disables connectivity logging. Howe Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -526,6 +561,9 @@ Accept wildcard characters: False ``` ### -ContentConversionTracingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service on a Mailbox server or on the Edge server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: - Administrators: Full Control @@ -536,7 +574,6 @@ The ContentConversionTracingEnabled parameter specifies whether content conversi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -546,6 +583,9 @@ Accept wildcard characters: False ``` ### -DelayNotificationTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DelayNotificationTimeout parameter specifies how long the server waits before it generates a delayed delivery status notification (DSN) message. The default value is 4 hours. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -556,7 +596,6 @@ For example, to specify 3.5 hours for this parameter, use 03:30:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -566,13 +605,15 @@ Accept wildcard characters: False ``` ### -DnsLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -582,6 +623,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogMaxAge parameter specifies the maximum age for the DNS log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -592,7 +636,6 @@ Setting the value of the DnsLogMaxAge parameter to 00:00:00 prevents the automat Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -602,6 +645,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogMaxDirectorySize parameter specifies the maximum size of all DNS logs in the DNS log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 100 MB. When you enter a value, qualify the value with one of the following units: @@ -612,7 +658,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the DnsLogMaxFileSize parameter must be less than or equal to the value of the DnsLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the DNS log directory. @@ -620,7 +666,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -630,6 +675,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogMaxFileSize parameter specifies the maximum size of each DNS log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -640,7 +688,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the DnsLogMaxFileSize parameter must be less than or equal to the value of the DnsLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the DNS log files. @@ -648,7 +696,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -658,13 +705,15 @@ Accept wildcard characters: False ``` ### -DnsLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogPath parameter specifies the DNS log directory location. The default value is blank ($null), which indicates no location is configured. If you enable DNS logging, you need to specify a local file path for the DNS log files by using this parameter. If the path contains spaces, enclose the entire path value in quotation marks ("). ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -674,6 +723,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -682,7 +734,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -692,13 +743,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalDNSAdapterEnabled parameter specifies one or more Domain Name System (DNS) servers that Exchange uses for external DNS lookups. When the ExternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations outside the Exchange organization are performed by using the DNS settings of the external network adapter specified by the value of the ExternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for external Exchange DNS lookups only, you must specify the DNS servers by using the ExternalDNSServers parameter, and you must also set the value of the ExternalDNSAdapterEnabled parameter to $false. The default value of the ExternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -708,7 +761,10 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterGuid -The ExternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of destinations that exist outside the Exchange organization. The concept of an external network adapter and an internal network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and external DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for external DNS lookups. The default value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ExternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of destinations that exist outside the Exchange organization. The concept of an external network adapter and an internal network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and external DNS lookups are performed by using the DNS settings of any available network adapter. You might enter the GUID of a specific network adapter to use for external DNS lookups. The default value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the value of the ExternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the ExternalDNSServers parameter is used. @@ -716,7 +772,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -726,13 +781,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSProtocolOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalDNSProtocolOption parameter specifies which protocol to use when querying external DNS servers. The valid options for this parameter are Any, UseTcpOnly, and UseUdpOnly. The default value is Any. ```yaml Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -742,6 +799,9 @@ Accept wildcard characters: False ``` ### -ExternalDNSServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. DNS servers are specified by IP address. The default value is an empty list ({}). 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"`. @@ -754,7 +814,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the Ext Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -764,13 +823,15 @@ Accept wildcard characters: False ``` ### -ExternalIPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalIPAddress parameter specifies the IP address used in the Received message header field for every message that travels through the Edge server or the Transport service on a Mailbox server. The IP address in the Received header field is used for hop count and routing loop detection. The IP address specified by the ExternalIPAddress parameter overrides the external network adapter's actual IP address. Typically, you would want to set the value of the ExternalIPAddress parameter to match the value of your domain's public MX record. The default value of the ExternalIPAddress parameter is blank. This means the actual IP address of the external network adapter is used in the Received header field. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -780,13 +841,15 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalDNSAdapterEnabled parameter specifies one or more DNS servers that Exchange uses for internal DNS lookups. When the InternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations inside the Exchange organization are performed by using the DNS settings of the internal network adapter specified by the value of the InternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for internal Exchange DNS lookups only, you must specify the DNS servers by using the InternalDNSServers parameter, and you must also set the value of the InternalDNSAdapterEnabled parameter to $false. The default value of the InternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -796,7 +859,10 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterGuid -The InternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of servers that exist inside the Exchange organization. The concept of an internal network adapter and an external network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and internal DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for internal DNS lookups. The default value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The InternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of servers that exist inside the Exchange organization. The concept of an internal network adapter and an external network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and internal DNS lookups are performed by using the DNS settings of any available network adapter. You might enter the GUID of a specific network adapter to use for internal DNS lookups. The default value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the InternalDNSAdapterEnabled parameter is set to $false, the value of the InternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the InternalDNSServers parameter is used. @@ -804,7 +870,6 @@ If the value of the InternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -814,6 +879,9 @@ Accept wildcard characters: False ``` ### -InternalDNSProtocolOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalDNSProtocolOption parameter specifies which protocol to use when you query internal DNS servers. Valid options for this parameter are Any, UseTcpOnly, or UseUdpOnly. The default value is Any. @@ -822,7 +890,6 @@ The default value is Any. Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -832,6 +899,9 @@ Accept wildcard characters: False ``` ### -InternalDNSServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalDNSServers parameter specifies the list of DNS servers that should be used when resolving a domain name. DNS servers are specified by IP address. The default value is any empty list ({}). 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"`. @@ -844,7 +914,6 @@ If the InternalDNSAdapterGuid parameter is set, and the value of the InternalDNS Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -854,6 +923,9 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorProtocolLoggingLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging on the implicit and invisible intra-organization Send connectors that are used to transmit messages between Exchange servers in the Exchange organization. Valid values for this parameter are None or Verbose. The value Verbose enables protocol logging for the connector. The value None disables protocol logging for the connector. The default value is None. When the IntraOrgConnectorProtocolLoggingLevel parameter is set to Verbose, the information is written to the Send connector protocol log specified by the SendProtocolLog parameters. @@ -862,7 +934,6 @@ Valid values for this parameter are None or Verbose. The value Verbose enables p Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -872,13 +943,15 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorSmtpMaxMessagesPerConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IntraOrgConnectorSmtpMaxMessagesPerConnection parameter specifies the maximum number of messages per connection limit on the implicit and invisible intra-organization Send connectors that are used to transmit messages between Exchange servers in the Exchange organization. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -888,6 +961,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IrmLogEnabled parameter enables logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: - $true: Enable IRM logging @@ -897,7 +973,6 @@ The IrmLogEnabled parameter enables logging of Information Rights Management (IR Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -907,6 +982,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -917,7 +995,6 @@ The valid input range for this parameter is 00:00:00 to 24855.03:14:07. Setting Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -927,6 +1004,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -937,7 +1017,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the IRM log directory. @@ -945,7 +1025,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -955,6 +1034,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -965,7 +1047,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the IRM log files. @@ -973,7 +1055,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -983,13 +1064,17 @@ Accept wildcard characters: False ``` ### -IrmLogPath -The IrmLogPath parameter specifies the default IRM log directory location. The default location is %ExchangeInstallPath%Logging\\IRMLogs. If you set the value of the IrmLogPath parameter to $null, you effectively disable IRM logging. However, if you set the value of the IrmLogPath parameter to $null when the value of the IrmLogEnabled attribute is $true, Exchange will log errors in the Application event log. The preferred way for disabling IRM logging is to set the IrmLogEnabled to $false. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The IrmLogPath parameter specifies the default IRM log directory location. The default location is %ExchangeInstallPath%Logging\\IRMLogs. + +If you set the value of this parameter to $null, you effectively disable IRM logging. However, if the value of the IrmLogEnabled parameter is $true, Exchange adds errors to the Application event log. The preferred way to disable IRM logging is to set the IrmLogEnabled parameter to $false. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -999,13 +1084,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxDeliveries + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConcurrentMailboxDeliveries parameter specifies the maximum number of delivery threads that the transport service can have open at the same time to deliver messages to mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. We recommend that you don't modify the default value unless Microsoft Customer Service and Support advises you to do this. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1015,13 +1102,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxSubmissions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConcurrentMailboxSubmissions parameter specifies the maximum number of submission threads that the transport service can have open at the same time to send messages from mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1031,13 +1120,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionRatePerMinute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConnectionRatePerMinute parameter specifies the maximum rate that connections are allowed to be opened with the transport service. If many connections are attempted with the transport service at the same time, the MaxConnectionRatePerMinute parameter limits the rate that the connections are opened so that the server's resources aren't overwhelmed. The default value is 1200 connections per minute. The valid input range for this parameter is from 1 through 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1047,13 +1138,15 @@ Accept wildcard characters: False ``` ### -MaxOutboundConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxOutboundConnections parameter specifies the maximum number of outbound connections that can be open at a time. The default value is 1000. 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. The value of the MaxOutboundConnections parameter must be greater than or equal to the value of the MaxPerDomainOutboundConnections parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1063,13 +1156,15 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1079,6 +1174,9 @@ Accept wildcard characters: False ``` ### -MessageExpirationTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageExpirationTimeout parameter specifies the maximum time that a particular message can remain in a queue. If a message remains in the queue for longer than this period of time, the message is returned to the sender as a permanent failure. The default value is 2 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1089,7 +1187,6 @@ For example, to specify 3 days for this parameter, use 3.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1099,7 +1196,10 @@ 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. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +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. @@ -1109,7 +1209,6 @@ For example, to specify 20 minutes for this parameter, use 00:20:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1119,13 +1218,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogEnabled parameter specifies whether message tracking is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1135,6 +1236,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogMaxAge parameter specifies the message tracking log maximum file age. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1145,7 +1249,6 @@ For example, to specify 20 days for this parameter, use 20.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1155,6 +1258,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogMaxDirectorySize parameter specifies the maximum size of the message tracking log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The maximum size of the message tracking log directory is calculated as the total size of all log files that have the same name prefix. Other files that don't follow the name prefix convention aren't counted in the total directory size calculation. Renaming old log files or copying other files into the message tracking log directory could cause the directory to exceed its specified maximum size. @@ -1171,7 +1277,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the MessageTrackingLogMaxFileSize parameter must be less than or equal to the value of the MessageTrackingLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the message tracking log directory. @@ -1179,7 +1285,6 @@ The value of the MessageTrackingLogMaxFileSize parameter must be less than or eq Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1189,6 +1294,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogMaxFileSize parameter specifies the maximum size of the message tracking log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1198,7 +1306,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the MessageTrackingLogMaxFileSize parameter must be less than or equal to the value of the MessageTrackingLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 4294967296 bytes (4 GB). If you enter a value of unlimited, no size limit is imposed on the message tracking log files. @@ -1206,7 +1314,6 @@ The value of the MessageTrackingLogMaxFileSize parameter must be less than or eq Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1216,13 +1323,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogPath parameter specifies the location of the message tracking logs. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\MessageTracking. Setting the value of this parameter to $null disables message tracking. However, setting this parameter to $null when the value of the MessageTrackingLogEnabled attribute is $true generates event log errors. The preferred method to disable message tracking is to use the MessageTrackingLogEnabled parameter. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1232,13 +1341,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogSubjectLoggingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogSubjectLoggingEnabled parameter specifies whether the message subject should be included in the message tracking log. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1248,6 +1359,9 @@ Accept wildcard characters: False ``` ### -OutboundConnectionFailureRetryInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OutboundConnectionFailureRetryInterval parameter specifies the retry interval for subsequent connection attempts to a remote server where previous connection attempts have failed. The previously failed connection attempts are controlled by the TransientFailureRetryCount and TransientFailureRetryInterval parameters. For the Transport service on a Mailbox server, the default value of the OutboundConnectionFailureRetryInterval parameter is 10 minutes. On an Edge server, the default value is 30 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. @@ -1258,7 +1372,6 @@ For example, to specify 15 minutes for this parameter, use 00:15:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1268,6 +1381,9 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxHeaderSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PickupDirectoryMaxHeaderSize parameter specifies the maximum message header size that can be submitted to the Pickup directory. The default value is 64 KB. When you enter a value, qualify the value with one of the following units: @@ -1277,7 +1393,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 32768 through 2147483647 bytes. @@ -1285,7 +1401,6 @@ The valid input range for this parameter is from 32768 through 2147483647 bytes. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1295,13 +1410,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxMessagesPerMinute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PickupDirectoryMaxMessagesPerMinute parameter specifies the maximum number of messages processed per minute by the Pickup directory and by the Replay directory. Each directory can independently process message files at the rate specified by the PickupDirectoryMaxMessagesPerMinute parameter. The default value is 100. The valid input range for this parameter is from 1 through 20000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1311,13 +1428,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxRecipientsPerMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PickupDirectoryMaxRecipientsPerMessage parameter specifies the maximum number of recipients that can be included on an message. The default value is 100. The valid input range for this parameter is from 1 through 10000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1327,13 +1446,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryPath -The PickupDirectoryPath parameter specifies the location of the Pickup directory. The Pickup directory is used by administrators and third-party applications to create and submit messages. The default location is %ExchangeInstallPath%TransportRoles\\Pickup. If the value of the PickupDirectoryPath parameter is set to $null, the Pickup directory is disabled. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PickupDirectoryPath parameter specifies the location of the Pickup directory. The Pickup directory is used by administrators and non-Microsoft applications to create and submit messages. The default location is %ExchangeInstallPath%TransportRoles\\Pickup. If the value of the PickupDirectoryPath parameter is set to $null, the Pickup directory is disabled. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1343,13 +1464,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PipelineTracingEnabled parameter specifies whether to enable pipeline tracing. Pipeline tracing captures message snapshot files that record the changes made to the message by each transport agent configured in the transport service on the server. Pipeline tracing creates verbose log files that accumulate quickly. Pipeline tracing should only be enabled for a short time to provide in-depth diagnostic information that enables you to troubleshoot problems. In addition to troubleshooting, you can use pipeline tracing to validate changes that you make to the configuration of the transport service where you enable pipeline tracing. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1359,6 +1482,9 @@ Accept wildcard characters: False ``` ### -PipelineTracingPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PipelineTracingPath parameter specifies the location of the pipeline tracing logs. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\PipelineTracing. @@ -1378,7 +1504,6 @@ Pipeline tracing captures the complete contents of messages to the path specifie Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1388,13 +1513,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingSenderAddress -The PipelineTracingSenderAddress parameter specifies the sender address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PipelineTracingSenderAddress parameter specifies the sender address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you might have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1404,13 +1531,15 @@ Accept wildcard characters: False ``` ### -PoisonMessageDetectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PoisonMessageDetectionEnabled parameter specifies whether poison messages should be detected. The default value is $true. Poison messages are messages determined to be potentially harmful to the Exchange system after a server failure. Poison messages are put in the poison message queue. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1420,13 +1549,15 @@ Accept wildcard characters: False ``` ### -PoisonThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PoisonThreshold parameter specifies the number of times a message can be rejected before it's classified as a poison message. The default value is 2. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this. The valid input range for this parameter is from 1 through 10. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1436,6 +1567,9 @@ Accept wildcard characters: False ``` ### -QueueMaxIdleTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QueueMaxIdleTime parameter specifies the period of time an empty delivery queue can exist before the queue is removed. The default value is 3 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. @@ -1446,7 +1580,6 @@ For example, to specify 5 minutes for this parameter, use 00:05:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1456,6 +1589,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QueueLogMaxAge parameter specifies the maximum age of the queue log files. Log files that are older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -1466,7 +1602,6 @@ For example, to specify 10 days for this parameter, use 10.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1476,6 +1611,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QueueLogMaxDirectorySize parameter specifies the maximum size of the queue log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 200 MB. When you enter a value, qualify the value with one of the following units: @@ -1486,7 +1624,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the QueueLogMaxFileSize parameter must be less than or equal to the value of the QueueLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the queue log directory. @@ -1494,7 +1632,6 @@ The value of the QueueLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1504,6 +1641,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QueueLogMaxFileSize parameter specifies the maximum size of the queue log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1514,7 +1654,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the QueueLogMaxFileSize parameter must be less than or equal to the value of the QueueLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the queue log files. @@ -1522,7 +1662,6 @@ The value of the QueueLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1532,13 +1671,15 @@ Accept wildcard characters: False ``` ### -QueueLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QueueLogPath parameter specifies the path of the queue log directory. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\QueueViewer. Setting the value of this parameter to $null disables queue logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1548,6 +1689,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxAge parameter specifies the maximum age of the Receive connector protocol log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1558,7 +1702,6 @@ For example, to specify 20 days for this parameter, use 20.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1568,6 +1711,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the Receive connector protocol log directory shared by all the Receive connectors that exist on the server. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -1578,7 +1724,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ReceiveProtocolLogMaxFileSize parameter must be less than or equal to the value of the ReceiveProtocolLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the Receive connector protocol log directory. @@ -1586,7 +1732,6 @@ The value of the ReceiveProtocolLogMaxFileSize parameter must be less than or eq Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1596,6 +1741,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of the Receive connector protocol log files shared by all the Receive connectors that exist on the server. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1606,7 +1754,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ReceiveProtocolLogMaxFileSize parameter must be less than or equal to the value of the ReceiveProtocolLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the Receive connector protocol log files. @@ -1614,7 +1762,6 @@ The value of the ReceiveProtocolLogMaxFileSize parameter must be less than or eq Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1624,6 +1771,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogPath parameter specifies the path of the protocol log directory for all the Receive connectors that exist on the server. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\ProtocolLog\\SmtpReceive. @@ -1635,7 +1785,6 @@ Setting the value of this parameter to $null disables protocol logging for all R Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1645,13 +1794,15 @@ Accept wildcard characters: False ``` ### -RecipientValidationCacheEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecipientValidationCacheEnabled parameter specifies whether the recipient addresses used by transport agents, such as the Recipient Filtering agent, are cached. The default value is $true on Edge servers and $false for the Transport service on Mailbox servers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1661,13 +1812,15 @@ Accept wildcard characters: False ``` ### -ReplayDirectoryPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplayDirectoryPath parameter specifies the path of the Replay directory. The Replay directory is used to resubmit exported messages and to receive messages from foreign gateway servers. The default location is %ExchangeInstallPath%TransportRoles\\Replay. If the value of the ReplayDirectoryPath parameter is set to $null, the Replay directory is disabled. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1677,13 +1830,15 @@ Accept wildcard characters: False ``` ### -RootDropDirectoryPath -The RootDropDirectoryPath parameter specifies the top-level location of the Drop directory used by all Foreign connectors defined in the Transport service on a Mailbox server. The value of the RootDropDirectoryPath parameter may be a local path, or a Universal Naming Convention (UNC) path to a remote server. By default, the RootDropDirectoryPath parameter is blank. This indicates the value of RootDropDirectoryPath is the Exchange installation folder. The RootDropDirectoryPath parameter is used with the DropDirectory parameter in the Set-ForeignConnector cmdlet to specify the location for outgoing messages going to the address spaces defined on the Foreign connector. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The RootDropDirectoryPath parameter specifies the top-level location of the Drop directory used by all Foreign connectors defined in the Transport service on a Mailbox server. The value of the RootDropDirectoryPath parameter might be a local path, or a Universal Naming Convention (UNC) path to a remote server. By default, the RootDropDirectoryPath parameter is blank. This indicates the value of RootDropDirectoryPath is the Exchange installation folder. The RootDropDirectoryPath parameter is used with the DropDirectory parameter in the Set-ForeignConnector cmdlet to specify the location for outgoing messages going to the address spaces defined on the Foreign connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1693,6 +1848,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogMaxAge parameter specifies the maximum routing table log age. Log files older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1703,7 +1861,6 @@ For example, to specify 5 days for this parameter, use 5.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1713,6 +1870,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the routing table log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 50 MB. When you enter a value, qualify the value with one of the following units: @@ -1723,7 +1883,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the routing table log directory. @@ -1731,7 +1891,6 @@ The valid input range for this parameter is from 1 through 9223372036854775807 b Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1741,6 +1900,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Routing. @@ -1752,7 +1914,6 @@ Setting the value of the RoutingTableLogPath parameter to $null disables routing Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1762,6 +1923,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxAge parameter specifies the Send connector protocol log file maximum age. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1772,7 +1936,6 @@ For example, to specify 25 days for this parameter, use 25.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1782,6 +1945,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the Send connector protocol log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 MB. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -1792,7 +1958,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the SendProtocolLogMaxFileSize parameter must be less than or equal to the value of the SendProtocolLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the Send connector protocol log directory. @@ -1800,7 +1966,6 @@ The value of the SendProtocolLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1810,6 +1975,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxFileSize parameter specifies the maximum size of the Send connector protocol log files shared by all the Send connectors that exist on a server. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1820,7 +1988,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the SendProtocolLogMaxFileSize parameter must be less than or equal to the value of the SendProtocolLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the Send connector protocol log files. @@ -1828,7 +1996,6 @@ The value of the SendProtocolLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1838,6 +2005,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogPath parameter specifies the location of protocol log storage for the Send connectors. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\ProtocolLog\\SmtpSend. @@ -1849,7 +2019,6 @@ Setting the value of this parameter to $null disables protocol logging for all S Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1859,6 +2028,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogMaxAge parameter specifies the maximum duration that the server statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days. @@ -1871,7 +2043,6 @@ For example, to specify 60 days for this parameter, use 60.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1881,6 +2052,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the server statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 MB. The default value is 250 MB. When you enter a value, qualify the value with one of the following: @@ -1899,7 +2073,6 @@ The value of the ServerStatisticsLogMaxFileSize parameter must be less than or e Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1909,6 +2082,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogMaxFileSize parameter specifies the maximum file size for the server statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following: @@ -1927,7 +2103,6 @@ The value of the ServerStatisticsLogMaxFileSize parameter must be less than or e Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1937,6 +2112,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogPath parameter specifies the location of the server statistics log. The default location depends on your version of Exchange: @@ -1950,7 +2128,6 @@ Setting the value of this parameter to $null disables server statistics logging. Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1960,13 +2137,15 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransientFailureRetryCount parameter specifies the maximum number of immediate connection retries attempted when the server encounters a connection failure with a remote server. The default value is 6. The valid input range for this parameter is from 0 through 15. When the value of this parameter is set to 0, the server doesn't immediately attempt to retry an unsuccessful connection, and the next connection attempt is controlled by the OutboundConnectionFailureRetryInterval parameter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1976,6 +2155,9 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransientFailureRetryInterval parameter controls the connection interval between each connection attempt specified by the TransientFailureRetryCount parameter. For the Transport service on a Mailbox server, the default value of the TransientFailureRetryInterval parameter is 5 minutes. On an Edge server, the default value is 10 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. @@ -1986,7 +2168,6 @@ For example, to specify 8 minutes for this parameter, use 00:08:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1996,9 +2177,12 @@ Accept wildcard characters: False ``` ### -UseDowngradedExchangeServerAuth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseDowngradedExchangeServerAuth parameter specifies whether the Generic Security Services application programming interface (GSSAPI) authentication method is used on connections where Transport Layer Security (TLS) is disabled. -Normally, TLS is required for connections between the Transport services on Mailbox servers in your organization. On TLS secured connections, Kerberos authentication is used by default. However, there may be scenarios where you need to disable TLS between specific Transport services in your organization. When you do that, you need to set this parameter to $true to provide an alternative authentication method. The default value is $false. You shouldn't set this value to $true unless it's absolutely required. +Normally, TLS is required for connections between the Transport services on Mailbox servers in your organization. On TLS secured connections, Kerberos authentication is used by default. However, there might be scenarios where you need to disable TLS between specific Transport services in your organization. When you do that, you need to set this parameter to $true to provide an alternative authentication method. The default value is $false. You shouldn't set this value to $true unless it's absolutely required. If you set this parameter to $true, you also need to create a specific Receive connector to service the non-TLS connections. This Receive connector must have remote IP address ranges specified to ensure that it's only used for non-TLS connections. You also must set the SuppressXAnonymousTls attribute of the Receive connector to $true. @@ -2006,7 +2190,6 @@ If you set this parameter to $true, you also need to create a specific Receive c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2016,13 +2199,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2032,13 +2217,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2048,13 +2235,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2064,13 +2253,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2080,13 +2271,15 @@ Accept wildcard characters: False ``` ### -WlmLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TransportService.md b/exchange/exchange-ps/ExchangePowerShell/Set-TransportService.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-TransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TransportService.md index c6c5a3fe45..1c8982c109 100644 --- a/exchange/exchange-ps/exchange/Set-TransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-transportservice -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-TransportService -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-transportservice +schema: 2.0.0 +title: Set-TransportService --- # Set-TransportService @@ -164,7 +165,7 @@ Set-TransportService [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -192,6 +193,9 @@ This example sets the ReceiveProtocolLogPath parameter to C:\\SMTP Protocol Logs ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Mailbox server that hosts the Transport service configuration you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -205,7 +209,6 @@ You can't use this parameter on an Edge Transport server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -215,6 +218,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveUserStatisticsLogMaxAge parameter specifies the maximum duration that the per user activity statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -225,7 +231,6 @@ For example, to specify 10 days for this parameter, use 10.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -235,6 +240,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveUserStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the per user activity statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 megabyte (MB). The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -245,7 +253,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than or equal to the value of the ActiveUserStatisticsLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the server statistics log directory. @@ -253,7 +261,6 @@ The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,6 +270,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveUserStatisticsLogMaxFileSize parameter specifies the maximum file size for the per user activity statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -273,7 +283,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than or equal to the value of the ActiveUserStatisticsLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the server statistics log files. @@ -281,7 +291,6 @@ The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -291,13 +300,15 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveUserStatisticsLogPath parameter specifies the location of per user activity statistics log storage. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ActiveUsersStats. Setting the value of this parameter to $null disables server statistics logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -307,13 +318,15 @@ Accept wildcard characters: False ``` ### -AgentLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -323,6 +336,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogMaxAge parameter specifies the maximum age for the agent log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -333,7 +349,6 @@ Setting the value of the AgentLogMaxAge parameter to 00:00:00 prevents the autom Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -343,6 +358,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogMaxDirectorySize parameter specifies the maximum size of all agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -353,7 +371,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the AgentLogMaxFileSize parameter must be less than or equal to the value of the AgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log directory. @@ -361,7 +379,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -371,6 +388,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogMaxFileSize parameter specifies the maximum size of each agent log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -381,7 +401,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the AgentLogMaxFileSize parameter must be less than or equal to the value of the AgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log files. @@ -389,7 +409,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -399,13 +418,15 @@ Accept wildcard characters: False ``` ### -AgentLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AgentLogPath parameter specifies the default agent log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\AgentLog. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the AgentLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -415,6 +436,9 @@ Accept wildcard characters: False ``` ### -AntispamAgentsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AntispamAgentsEnabled parameter specifies whether anti-spam agents are installed on the server specified with the Identity parameter. The default value is $false for the Transport service on Mailbox servers and $true on Edge Transport servers. You set this parameter by using a script. You shouldn't modify this parameter manually. @@ -423,7 +447,6 @@ You set this parameter by using a script. You shouldn't modify this parameter ma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +456,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -442,7 +468,6 @@ 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 Required: False Position: Named @@ -452,13 +477,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,6 +495,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxAge parameter specifies the maximum age for the connectivity log file. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -478,7 +508,6 @@ For example, to specify 25 days for this parameter, use 25.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -488,6 +517,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all connectivity logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 1000 MB. When you enter a value, qualify the value with one of the following units: @@ -498,7 +530,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ConnectivityLogMaxFileSize parameter must be less than or equal to the value of the ConnectivityLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the connectivity log directory. @@ -506,7 +538,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -516,6 +547,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogMaxFileSize parameter specifies the maximum size of each connectivity log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -526,7 +560,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the ConnectivityLogMaxFileSize parameter must be less than or equal to the value of the ConnectivityLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the connectivity log files. @@ -534,7 +568,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -544,13 +577,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\Connectivity. Setting the value of this parameter to $null disables connectivity logging. However, setting this parameter to $null when the value of the ConnectivityLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -560,6 +595,9 @@ Accept wildcard characters: False ``` ### -ContentConversionTracingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service on a Mailbox server or on the Edge Transport server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of email messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: - Administrators: Full Control @@ -570,7 +608,6 @@ The ContentConversionTracingEnabled parameter specifies whether content conversi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -580,6 +617,9 @@ Accept wildcard characters: False ``` ### -DelayNotificationTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DelayNotificationTimeout parameter specifies how long the server waits before it generates a delayed delivery status notification (DSN) message. The default value is 4 hours. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -590,7 +630,6 @@ For example, to specify 3.5 hours for this parameter, use 03:30:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -600,13 +639,15 @@ Accept wildcard characters: False ``` ### -DnsLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -616,6 +657,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogMaxAge parameter specifies the maximum age for the DNS log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -626,7 +670,6 @@ Setting the value of the DnsLogMaxAge parameter to 00:00:00 prevents the automat Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -636,6 +679,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogMaxDirectorySize parameter specifies the maximum size of all DNS logs in the DNS log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 100 MB. When you enter a value, qualify the value with one of the following units: @@ -646,7 +692,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the DnsLogMaxFileSize parameter must be less than or equal to the value of the DnsLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the DNS log directory. @@ -654,7 +700,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -664,6 +709,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogMaxFileSize parameter specifies the maximum size of each DNS log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -674,7 +722,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the DnsLogMaxFileSize parameter must be less than or equal to the value of the DnsLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the DNS log files. @@ -682,7 +730,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -692,13 +739,15 @@ Accept wildcard characters: False ``` ### -DnsLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DnsLogPath parameter specifies the DNS log directory location. The default value is blank ($null), which indicates no location is configured. If you enable DNS logging, you need to specify a local file path for the DNS log files by using this parameter. If the path contains spaces, enclose the entire path value in quotation marks ("). ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -708,6 +757,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -716,7 +768,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -726,13 +777,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalDNSAdapterEnabled parameter specifies one or more Domain Name System (DNS) servers that Exchange uses for external DNS lookups. When the ExternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations outside the Exchange organization are performed by using the DNS settings of the external network adapter specified by the value of the ExternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for external Exchange DNS lookups only, you must specify the DNS servers by using the ExternalDNSServers parameter, and you must also set the value of the ExternalDNSAdapterEnabled parameter to $false. The default value of the ExternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -742,7 +795,10 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterGuid -The ExternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of destinations that exist outside the Exchange organization. The concept of an external network adapter and an internal network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and external DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for external DNS lookups. The default value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The ExternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of destinations that exist outside the Exchange organization. The concept of an external network adapter and an internal network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and external DNS lookups are performed by using the DNS settings of any available network adapter. You might enter the GUID of a specific network adapter to use for external DNS lookups. The default value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the value of the ExternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the ExternalDNSServers parameter is used. @@ -750,7 +806,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -760,13 +815,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSProtocolOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalDNSProtocolOption parameter specifies which protocol to use when querying external DNS servers. The valid options for this parameter are Any, UseTcpOnly, and UseUdpOnly. The default value is Any. ```yaml Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -776,6 +833,9 @@ Accept wildcard characters: False ``` ### -ExternalDNSServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. DNS servers are specified by IP address. The default value is an empty list ({}). 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"`. @@ -788,7 +848,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the Ext Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -798,13 +857,15 @@ Accept wildcard characters: False ``` ### -ExternalIPAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalIPAddress parameter specifies the IP address used in the Received message header field for every message that travels through the Edge Transport server or the Transport service on a Mailbox server. The IP address in the Received header field is used for hop count and routing loop detection. The IP address specified by the ExternalIPAddress parameter overrides the external network adapter's actual IP address. Typically, you would want to set the value of the ExternalIPAddress parameter to match the value of your domain's public MX record. The default value of the ExternalIPAddress parameter is blank. This means the actual IP address of the external network adapter is used in the Received header field. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -814,13 +875,15 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalDNSAdapterEnabled parameter specifies one or more DNS servers that Exchange uses for internal DNS lookups. When the InternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations inside the Exchange organization are performed by using the DNS settings of the internal network adapter specified by the value of the InternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for internal Exchange DNS lookups only, you must specify the DNS servers by using the InternalDNSServers parameter, and you must also set the value of the InternalDNSAdapterEnabled parameter to $false. The default value of the InternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -830,7 +893,10 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterGuid -The InternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of servers that exist inside the Exchange organization. The concept of an internal network adapter and an external network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and internal DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for internal DNS lookups. The default value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The InternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of servers that exist inside the Exchange organization. The concept of an internal network adapter and an external network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and internal DNS lookups are performed by using the DNS settings of any available network adapter. You might enter the GUID of a specific network adapter to use for internal DNS lookups. The default value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the InternalDNSAdapterEnabled parameter is set to $false, the value of the InternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the InternalDNSServers parameter is used. @@ -838,7 +904,6 @@ If the value of the InternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -848,13 +913,15 @@ Accept wildcard characters: False ``` ### -InternalDNSProtocolOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalDNSProtocolOption parameter specifies which protocol to use when you query internal DNS servers. Valid options for this parameter are Any, UseTcpOnly, or UseUdpOnly.The default value is Any. ```yaml Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -864,6 +931,9 @@ Accept wildcard characters: False ``` ### -InternalDNSServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalDNSServers parameter specifies the list of DNS servers that should be used when resolving a domain name. DNS servers are specified by IP address. The default value is any empty list ({}). 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"`. @@ -876,7 +946,6 @@ If the InternalDNSAdapterGuid parameter is set, and the value of the InternalDNS Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -886,6 +955,9 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorProtocolLoggingLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging for the implicit and invisible intra-organization Send connector in the following transport services on the server: - The Transport service. @@ -893,14 +965,13 @@ The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP pro Valid values are: -- None: Protocol logging is disabled for the intra-organization Send connector in the Transport service and in the Mailbox Transport Submission service. This is the default value. +- None: Protocol logging is disabled for the intra-organization Send connector in the Transport service and in the Mailbox Transport Submission service. This value is the default. - Verbose: Protocol logging is enabled for the intra-organization Send connector in the Transport service and in the Mailbox Transport Submission service. The location of the log files is controlled by the SendProtocolLogPath parameter. ```yaml Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -910,6 +981,9 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorSmtpMaxMessagesPerConnection + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IntraOrgConnectorSmtpMaxMessagesPerConnection parameter specifies the maximum number of messages per connection that are allowed on the implicit and invisible intra-organization Send connector in the Transport service on the server. A valid value is an integer from 0 to 2147483647. The default value is 20. @@ -918,7 +992,6 @@ A valid value is an integer from 0 to 2147483647. The default value is 20. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -928,6 +1001,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IrmLogEnabled parameter enables logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: - $true: Enable IRM logging @@ -937,7 +1013,6 @@ The IrmLogEnabled parameter enables logging of Information Rights Management (IR Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -947,6 +1022,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -957,7 +1035,6 @@ The valid input range for this parameter is 00:00:00 to 24855.03:14:07. Setting Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -967,6 +1044,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -977,7 +1057,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the IRM log directory. @@ -985,7 +1065,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -995,6 +1074,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1005,7 +1087,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the IRM log files. @@ -1013,7 +1095,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1023,13 +1104,17 @@ Accept wildcard characters: False ``` ### -IrmLogPath -The IrmLogPath parameter specifies the default IRM log directory location. The default location is %ExchangeInstallPath%Logging\\IRMLogs. If you set the value of the IrmLogPath parameter to $null, you effectively disable IRM logging. However, if you set the value of the IrmLogPath parameter to $null when the value of the IrmLogEnabled attribute is $true, Exchange will log errors in the Application event log. The preferred way for disabling IRM logging is to set the IrmLogEnabled to $false. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The IrmLogPath parameter specifies the default IRM log directory location. The default value is %ExchangeInstallPath%IRMLogs. + +If you set the value of this parameter to $null, you effectively disable IRM logging. However, if the value of the IrmLogEnabled parameter is $true, Exchange adds errors to the Application event log. The preferred way to disable IRM logging is to set the IrmLogEnabled parameter to $false. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1039,13 +1124,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxDeliveries + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConcurrentMailboxDeliveries parameter specifies the maximum number of delivery threads that the transport service can have open at the same time to deliver messages to mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. We recommend that you don't modify the default value unless Microsoft Customer Service and Support advises you to do this. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1055,13 +1142,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxSubmissions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConcurrentMailboxSubmissions parameter specifies the maximum number of submission threads that the transport service can have open at the same time to send messages from mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1071,13 +1160,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionRatePerMinute + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxConnectionRatePerMinute parameter specifies the maximum rate that connections are allowed to be opened with the transport service. If many connections are attempted with the transport service at the same time, the MaxConnectionRatePerMinute parameter limits the rate that the connections are opened so that the server's resources aren't overwhelmed. The default value is 1200 connections per minute. The valid input range for this parameter is from 1 through 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1087,13 +1178,15 @@ Accept wildcard characters: False ``` ### -MaxOutboundConnections + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxOutboundConnections parameter specifies the maximum number of outbound connections that can be open at a time. The default value is 1000. 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. The value of the MaxOutboundConnections parameter must be greater than or equal to the value of the MaxPerDomainOutboundConnections parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1103,13 +1196,15 @@ Accept wildcard characters: False ``` ### -MaxPerDomainOutboundConnections + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1119,6 +1214,9 @@ Accept wildcard characters: False ``` ### -MessageExpirationTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageExpirationTimeout parameter specifies the maximum time that a particular message can remain in a queue. If a message remains in the queue for longer than this period of time, the message is returned to the sender as a permanent failure. The default value is 2 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1129,7 +1227,6 @@ For example, to specify 3 days for this parameter, use 3.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1139,6 +1236,9 @@ Accept wildcard characters: False ``` ### -MessageRetryInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -1149,7 +1249,6 @@ For example, to specify 20 minutes for this parameter, use 00:20:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1159,13 +1258,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogEnabled parameter specifies whether message tracking is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1175,6 +1276,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogMaxAge parameter specifies the message tracking log maximum file age. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1185,7 +1289,6 @@ For example, to specify 20 days for this parameter, use 20.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1195,6 +1298,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogMaxDirectorySize parameter specifies the maximum size of the message tracking log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The maximum size of the message tracking log directory is calculated as the total size of all log files that have the same name prefix. Other files that don't follow the name prefix convention aren't counted in the total directory size calculation. Renaming old log files or copying other files into the message tracking log directory could cause the directory to exceed its specified maximum size. @@ -1211,7 +1317,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the MessageTrackingLogMaxFileSize parameter must be less than or equal to the value of the MessageTrackingLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the message tracking log directory. @@ -1219,7 +1325,6 @@ The value of the MessageTrackingLogMaxFileSize parameter must be less than or eq Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1229,6 +1334,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogMaxFileSize parameter specifies the maximum size of the message tracking log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1238,7 +1346,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the MessageTrackingLogMaxFileSize parameter must be less than or equal to the value of the MessageTrackingLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 4294967296 bytes (4 GB). If you enter a value of unlimited, no size limit is imposed on the message tracking log files. @@ -1246,7 +1354,6 @@ The value of the MessageTrackingLogMaxFileSize parameter must be less than or eq Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1256,13 +1363,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogPath parameter specifies the location of the message tracking logs. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\MessageTracking. Setting the value of this parameter to $null disables message tracking. However, setting this parameter to $null when the value of the MessageTrackingLogEnabled attribute is $true generates event log errors. The preferred method to disable message tracking is to use the MessageTrackingLogEnabled parameter. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1272,13 +1381,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogSubjectLoggingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MessageTrackingLogSubjectLoggingEnabled parameter specifies whether the message subject should be included in the message tracking log. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1288,6 +1399,9 @@ Accept wildcard characters: False ``` ### -OutboundConnectionFailureRetryInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OutboundConnectionFailureRetryInterval parameter specifies the retry interval for subsequent connection attempts to a remote server where previous connection attempts have failed. The previously failed connection attempts are controlled by the TransientFailureRetryCount and TransientFailureRetryInterval parameters. For the Transport service on a Mailbox server, the default value of the OutboundConnectionFailureRetryInterval parameter is 10 minutes. On an Edge Transport server, the default value is 30 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. @@ -1298,7 +1412,6 @@ For example, to specify 15 minutes for this parameter, use 00:15:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1308,6 +1421,9 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxHeaderSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PickupDirectoryMaxHeaderSize parameter specifies the maximum message header size that can be submitted to the Pickup directory. The default value is 64 KB. When you enter a value, qualify the value with one of the following units: @@ -1317,7 +1433,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 32768 through 2147483647 bytes. @@ -1325,7 +1441,6 @@ The valid input range for this parameter is from 32768 through 2147483647 bytes. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1335,13 +1450,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxMessagesPerMinute + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PickupDirectoryMaxMessagesPerMinute parameter specifies the maximum number of messages processed per minute by the Pickup directory and by the Replay directory. Each directory can independently process message files at the rate specified by the PickupDirectoryMaxMessagesPerMinute parameter. The default value is 100. The valid input range for this parameter is from 1 through 20000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1351,13 +1468,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxRecipientsPerMessage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PickupDirectoryMaxRecipientsPerMessage parameter specifies the maximum number of recipients that can be included on an email message. The default value is 100. The valid input range for this parameter is from 1 through 10000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1367,13 +1486,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryPath -The PickupDirectoryPath parameter specifies the location of the Pickup directory. The Pickup directory is used by administrators and third-party applications to create and submit messages. The default location is %ExchangeInstallPath%TransportRoles\\Pickup. If the value of the PickupDirectoryPath parameter is set to $null, the Pickup directory is disabled. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PickupDirectoryPath parameter specifies the location of the Pickup directory. The Pickup directory is used by administrators and non-Microsoft applications to create and submit messages. The default location is %ExchangeInstallPath%TransportRoles\\Pickup. If the value of the PickupDirectoryPath parameter is set to $null, the Pickup directory is disabled. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1383,13 +1504,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PipelineTracingEnabled parameter specifies whether to enable pipeline tracing. Pipeline tracing captures message snapshot files that record the changes made to the message by each transport agent configured in the transport service on the server. Pipeline tracing creates verbose log files that accumulate quickly. Pipeline tracing should only be enabled for a short time to provide in-depth diagnostic information that enables you to troubleshoot problems. In addition to troubleshooting, you can use pipeline tracing to validate changes that you make to the configuration of the transport service where you enable pipeline tracing. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1399,6 +1522,9 @@ Accept wildcard characters: False ``` ### -PipelineTracingPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PipelineTracingPath parameter specifies the location of the pipeline tracing logs. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\PipelineTracing. The path must be local to the Exchange server. Setting the value of this parameter to $null disables pipeline tracing. However, setting this parameter to $null when the value of the PipelineTracingEnabled attribute is $true generates event log errors. The preferred method to disable pipeline tracing is to use the PipelineTracingEnabled parameter. @@ -1413,7 +1539,6 @@ Pipeline tracing captures the complete contents of email messages to the path sp Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1423,13 +1548,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingSenderAddress -The PipelineTracingSenderAddress parameter specifies the sender email address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PipelineTracingSenderAddress parameter specifies the sender email address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you might have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1439,13 +1566,15 @@ Accept wildcard characters: False ``` ### -PoisonMessageDetectionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PoisonMessageDetectionEnabled parameter specifies whether poison messages should be detected. The default value is $true. Poison messages are messages determined to be potentially harmful to the Exchange system after a server failure. Poison messages are put in the poison message queue. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1455,13 +1584,15 @@ Accept wildcard characters: False ``` ### -PoisonThreshold + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PoisonThreshold parameter specifies the number of times a message can be rejected before it's classified as a poison message. The default value is 2. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this. The valid input range for this parameter is from 1 through 10. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1471,6 +1602,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QueueLogMaxAge parameter specifies the maximum age of the queue log files. Log files that are older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1481,7 +1615,6 @@ For example, to specify 10 days for this parameter, use 10.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1491,6 +1624,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QueueLogMaxDirectorySize parameter specifies the maximum size of the queue log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 200 MB. When you enter a value, qualify the value with one of the following units: @@ -1501,7 +1637,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the QueueLogMaxFileSize parameter must be less than or equal to the value of the QueueLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the queue log directory. @@ -1509,7 +1645,6 @@ The value of the QueueLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1519,6 +1654,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QueueLogMaxFileSize parameter specifies the maximum size of the queue log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1529,7 +1667,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the QueueLogMaxFileSize parameter must be less than or equal to the value of the QueueLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the queue log files. @@ -1537,7 +1675,6 @@ The value of the QueueLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1547,13 +1684,15 @@ Accept wildcard characters: False ``` ### -QueueLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QueueLogPath parameter specifies the path of the queue log directory. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\QueueViewer. Setting the value of this parameter to $null disables queue logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1563,6 +1702,9 @@ Accept wildcard characters: False ``` ### -QueueMaxIdleTime + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The QueueMaxIdleTime parameter specifies the period of time an empty delivery queue can exist before the queue is removed. The default value is 3 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. @@ -1573,7 +1715,6 @@ For example, to specify 5 minutes for this parameter, use 00:05:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1583,6 +1724,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Receive connectors in the Transport service on the server. Log files that are older than the specified value are automatically deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1595,7 +1739,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1605,6 +1748,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Receive connectors in the Transport service on the server. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -1617,7 +1763,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be greater than or equal to the value of the ReceiveProtocolLogMaxFileSize parameter. @@ -1627,7 +1773,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1637,6 +1782,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all Receive connectors in the Transport on the server. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -1649,7 +1797,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be less than or equal to the value of the ReceiveProtocolLogMaxDirectorySize parameter. @@ -1659,7 +1807,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1669,6 +1816,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReceiveProtocolLogPath parameter specifies the location of the protocol log directory for all Receive connectors in the Transport service on the server. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ProtocolLog\\SmtpReceive. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for any Receive connector in the Transport service. To disable protocol logging for these Receive connectors, use the value None for the ProtocolLoggingLevel parameter on the Set-ReceiveConnector cmdlet for each Receive connector in the Transport service. @@ -1677,7 +1827,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1687,13 +1836,15 @@ Accept wildcard characters: False ``` ### -RecipientValidationCacheEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RecipientValidationCacheEnabled parameter specifies whether the recipient addresses used by transport agents, such as the Recipient Filtering agent, are cached. The default value is $true on Edge Transport servers and $false for the Transport service on Mailbox servers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1703,13 +1854,15 @@ Accept wildcard characters: False ``` ### -ReplayDirectoryPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ReplayDirectoryPath parameter specifies the path of the Replay directory. The Replay directory is used to resubmit exported messages and to receive messages from foreign gateway servers. The default location is %ExchangeInstallPath%TransportRoles\\Replay. If the value of the ReplayDirectoryPath parameter is set to $null, the Replay directory is disabled. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1719,13 +1872,15 @@ Accept wildcard characters: False ``` ### -RequestBrokerLogEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1735,13 +1890,15 @@ Accept wildcard characters: False ``` ### -RequestBrokerLogMaxAge + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1751,13 +1908,15 @@ Accept wildcard characters: False ``` ### -RequestBrokerLogMaxDirectorySize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1767,13 +1926,15 @@ Accept wildcard characters: False ``` ### -RequestBrokerLogMaxFileSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1783,13 +1944,15 @@ Accept wildcard characters: False ``` ### -RequestBrokerLogPath + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1799,13 +1962,15 @@ Accept wildcard characters: False ``` ### -ResourceLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1815,13 +1980,15 @@ Accept wildcard characters: False ``` ### -ResourceLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1831,13 +1998,15 @@ Accept wildcard characters: False ``` ### -ResourceLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1847,13 +2016,15 @@ Accept wildcard characters: False ``` ### -ResourceLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1863,13 +2034,15 @@ Accept wildcard characters: False ``` ### -ResourceLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1879,13 +2052,15 @@ Accept wildcard characters: False ``` ### -RootDropDirectoryPath -The RootDropDirectoryPath parameter specifies the top-level location of the Drop directory used by all Foreign connectors defined in the Transport service on a Mailbox server. The value of the RootDropDirectoryPath parameter may be a local path, or a Universal Naming Convention (UNC) path to a remote server. By default, the RootDropDirectoryPath parameter is blank. This indicates the value of RootDropDirectoryPath is the Exchange installation folder. The RootDropDirectoryPath parameter is used with the DropDirectory parameter in the Set-ForeignConnector cmdlet to specify the location for outgoing messages going to the address spaces defined on the Foreign connector. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The RootDropDirectoryPath parameter specifies the top-level location of the Drop directory used by all Foreign connectors defined in the Transport service on a Mailbox server. The value of the RootDropDirectoryPath parameter might be a local path, or a Universal Naming Convention (UNC) path to a remote server. By default, the RootDropDirectoryPath parameter is blank. This indicates the value of RootDropDirectoryPath is the Exchange installation folder. The RootDropDirectoryPath parameter is used with the DropDirectory parameter in the Set-ForeignConnector cmdlet to specify the location for outgoing messages going to the address spaces defined on the Foreign connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1895,6 +2070,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogMaxAge parameter specifies the maximum routing table log age. Log files older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1905,7 +2083,6 @@ For example, to specify 5 days for this parameter, use 5.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1915,6 +2092,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the routing table log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 50 MB. When you enter a value, qualify the value with one of the following units: @@ -1925,7 +2105,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The valid input range for this parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the routing table log directory. @@ -1933,7 +2113,6 @@ The valid input range for this parameter is from 1 through 9223372036854775807 b Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1943,13 +2122,15 @@ Accept wildcard characters: False ``` ### -RoutingTableLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\Routing. Setting the value of the RoutingTableLogPath parameter to $null disables routing table logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1959,6 +2140,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Send connectors in the Transport service that have this server configured as a source server. Log files that are older than the specified value are automatically deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1971,7 +2155,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1981,6 +2164,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Send connectors in the Transport service that have this server configured as a source server. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -1993,7 +2179,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be greater than or equal to the value of the SendProtocolLogMaxFileSize parameter. @@ -2003,7 +2189,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2013,6 +2198,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all Send connectors in the Transport service that have this server configured as a source server. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -2025,7 +2213,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of this parameter must be less than or equal to the value of the SendProtocolLogMaxDirectorySize parameter. @@ -2035,7 +2223,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2045,6 +2232,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SendProtocolLogPath parameter specifies the location of the protocol log directory for all Send connectors in the Transport service on the server. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ProtocolLog\\SmtpSend. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for any Send connector in the Transport service that has this server configured as a source server. To disable protocol logging for these Send connectors, use the value None for the following parameters: @@ -2056,7 +2246,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2066,6 +2255,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogMaxAge parameter specifies the maximum duration that the server statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days. @@ -2078,7 +2270,6 @@ For example, to specify 60 days for this parameter, use 60.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2088,6 +2279,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the server statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 MB. The default value is 250 MB. @@ -2108,7 +2302,6 @@ The value of the ServerStatisticsLogMaxFileSize parameter must be less than or e Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2118,6 +2311,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogMaxFileSize parameter specifies the maximum file size for the server statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. @@ -2138,7 +2334,6 @@ The value of the ServerStatisticsLogMaxFileSize parameter must be less than or e Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2148,6 +2343,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogPath parameter specifies the location of server statistics log storage. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ServerStats. Setting the value of this parameter to $null disables server statistics logging. @@ -2156,7 +2354,6 @@ The ServerStatisticsLogPath parameter specifies the location of server statistic Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2166,13 +2363,15 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryCount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransientFailureRetryCount parameter specifies the maximum number of immediate connection retries attempted when the server encounters a connection failure with a remote server. The default value is 6. The valid input range for this parameter is from 0 through 15. When the value of this parameter is set to 0, the server doesn't immediately attempt to retry an unsuccessful connection, and the next connection attempt is controlled by the OutboundConnectionFailureRetryInterval parameter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2182,6 +2381,9 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransientFailureRetryInterval parameter controls the connection interval between each connection attempt specified by the TransientFailureRetryCount parameter. For the Transport service on a Mailbox server, the default value of the TransientFailureRetryInterval parameter is 5 minutes. On an Edge Transport server, the default value is 10 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. @@ -2192,7 +2394,6 @@ For example, to specify 8 minutes for this parameter, use 00:08:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2202,13 +2403,15 @@ Accept wildcard characters: False ``` ### -TransportHttpLogEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2218,13 +2421,15 @@ Accept wildcard characters: False ``` ### -TransportHttpLogMaxAge + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2234,13 +2439,15 @@ Accept wildcard characters: False ``` ### -TransportHttpLogMaxDirectorySize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2250,13 +2457,15 @@ Accept wildcard characters: False ``` ### -TransportHttpLogMaxFileSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2266,13 +2475,15 @@ Accept wildcard characters: False ``` ### -TransportHttpLogPath + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2282,13 +2493,15 @@ Accept wildcard characters: False ``` ### -TransportMaintenanceLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2298,13 +2511,15 @@ Accept wildcard characters: False ``` ### -TransportMaintenanceLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2314,13 +2529,15 @@ Accept wildcard characters: False ``` ### -TransportMaintenanceLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2330,13 +2547,15 @@ Accept wildcard characters: False ``` ### -TransportMaintenanceLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2346,13 +2565,15 @@ Accept wildcard characters: False ``` ### -TransportMaintenanceLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2362,13 +2583,15 @@ Accept wildcard characters: False ``` ### -TransportSyncAccountsPoisonAccountThreshold + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2378,13 +2601,15 @@ Accept wildcard characters: False ``` ### -TransportSyncAccountsPoisonDetectionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2394,13 +2619,15 @@ Accept wildcard characters: False ``` ### -TransportSyncAccountsPoisonItemThreshold + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2410,13 +2637,15 @@ Accept wildcard characters: False ``` ### -TransportSyncAccountsSuccessivePoisonItemThreshold + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2426,13 +2655,15 @@ Accept wildcard characters: False ``` ### -TransportSyncEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2442,13 +2673,15 @@ Accept wildcard characters: False ``` ### -TransportSyncExchangeEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2458,13 +2691,15 @@ Accept wildcard characters: False ``` ### -TransportSyncHubHealthLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2474,13 +2709,15 @@ Accept wildcard characters: False ``` ### -TransportSyncHubHealthLogFilePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2490,13 +2727,15 @@ Accept wildcard characters: False ``` ### -TransportSyncHubHealthLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2506,13 +2745,15 @@ Accept wildcard characters: False ``` ### -TransportSyncHubHealthLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2522,13 +2763,15 @@ Accept wildcard characters: False ``` ### -TransportSyncHubHealthLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2538,13 +2781,15 @@ Accept wildcard characters: False ``` ### -TransportSyncImapEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2554,13 +2799,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2570,13 +2817,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogFilePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2586,13 +2835,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogLoggingLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SyncLogLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2602,13 +2853,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2618,13 +2871,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2634,13 +2889,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2650,13 +2907,15 @@ Accept wildcard characters: False ``` ### -TransportSyncMaxDownloadItemsPerConnection + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2666,13 +2925,15 @@ Accept wildcard characters: False ``` ### -TransportSyncMaxDownloadSizePerConnection + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2682,13 +2943,15 @@ Accept wildcard characters: False ``` ### -TransportSyncMaxDownloadSizePerItem + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2698,13 +2961,15 @@ Accept wildcard characters: False ``` ### -TransportSyncPopEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2714,13 +2979,15 @@ Accept wildcard characters: False ``` ### -TransportSyncRemoteConnectionTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2730,9 +2997,12 @@ Accept wildcard characters: False ``` ### -UseDowngradedExchangeServerAuth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseDowngradedExchangeServerAuth parameter specifies whether the Generic Security Services application programming interface (GSSAPI) authentication method is used on connections where Transport Layer Security (TLS) is disabled. -Normally, TLS is required for connections between the Transport services on Mailbox servers in your organization. On TLS secured connections, Kerberos authentication is used by default. However, there may be scenarios where you need to disable TLS between specific Transport services in your organization. When you do that, you need to set this parameter to $true to provide an alternative authentication method. The default value is $false. You shouldn't set this value to $true unless it's absolutely required. +Normally, TLS is required for connections between the Transport services on Mailbox servers in your organization. On TLS secured connections, Kerberos authentication is used by default. However, there might be scenarios where you need to disable TLS between specific Transport services in your organization. When you do that, you need to set this parameter to $true to provide an alternative authentication method. The default value is $false. You shouldn't set this value to $true unless it's absolutely required. If you set this parameter to $true, you also need to create a specific Receive connector to service the non-TLS connections. This Receive connector must have remote IP address ranges specified to ensure that it's only used for non-TLS connections. You also must set the SuppressXAnonymousTls attribute of the Receive connector to $true. @@ -2740,7 +3010,6 @@ If you set this parameter to $true, you also need to create a specific Receive c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2750,13 +3019,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2766,13 +3037,15 @@ Accept wildcard characters: False ``` ### -WindowsLiveHotmailTransportSyncEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2782,13 +3055,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2798,13 +3073,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2814,13 +3091,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2830,13 +3109,15 @@ Accept wildcard characters: False ``` ### -WlmLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMAutoAttendant.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMAutoAttendant.md index c224bb9dc4..8136c757d5 100644 --- a/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umautoattendant +schema: 2.0.0 +title: Set-UMAutoAttendant --- # Set-UMAutoAttendant @@ -74,7 +75,7 @@ The Set-UMAutoAttendant cmdlet changes or modifies the settings of an existing U After this task is completed, the parameters and values specified are configured on the UM auto attendant. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,13 +103,15 @@ This example configures the UM auto attendant MyAutoAttendant and enables busine ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM auto attendant being viewed. This parameter is the directory object ID for the UM auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -AfterHoursKeyMapping + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursKeyMapping parameter specifies the key mappings to be used for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. The following is an example for a custom table that has two entries: @@ -130,7 +136,6 @@ The default value is disabled. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -140,6 +145,9 @@ Accept wildcard characters: False ``` ### -AfterHoursKeyMappingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursKeyMappingEnabled parameter specifies whether to enable or disable key mappings for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. The following is an example for a custom table that has two entries: @@ -150,7 +158,6 @@ The following is an example for a custom table that has two entries: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -160,13 +167,15 @@ Accept wildcard characters: False ``` ### -AfterHoursMainMenuCustomPromptEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursMainMenuCustomPromptEnabled parameter specifies whether the after business hours custom main menu is enabled. The default value is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -176,13 +185,15 @@ Accept wildcard characters: False ``` ### -AfterHoursMainMenuCustomPromptFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursMainMenuCustomPromptFilename parameter specifies the .wav file to be used for the after business hours custom main menu prompt. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -192,13 +203,15 @@ Accept wildcard characters: False ``` ### -AfterHoursTransferToOperatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursTransferToOperatorEnabled parameter specifies whether to allow calls to be transferred to the operator's extension number after business hours. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -208,13 +221,15 @@ Accept wildcard characters: False ``` ### -AfterHoursWelcomeGreetingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursWelcomeGreetingEnabled parameter specifies whether the after hours greeting is enabled. The system default audio is used if this parameter is set to disabled. The default value is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -224,13 +239,15 @@ Accept wildcard characters: False ``` ### -AfterHoursWelcomeGreetingFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursWelcomeGreetingFilename parameter specifies the .wav file to be used for the after hours greeting message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -240,13 +257,15 @@ Accept wildcard characters: False ``` ### -AllowDialPlanSubscribers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowDialPlanSubscribers parameter specifies whether to allow the dial plan subscribers to dial numbers that are resolved to a subscriber in the same dial plan. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -256,13 +275,15 @@ Accept wildcard characters: False ``` ### -AllowedInCountryOrRegionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/region dial group names allowed. The names must match group names defined in the dial plan. The string must have fewer than 128 characters. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -272,13 +293,15 @@ Accept wildcard characters: False ``` ### -AllowedInternationalGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInternationalGroups parameter specifies the list of international dial group names allowed. The names must match group names defined in the dial plan. The string must have fewer than 128 characters. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -288,13 +311,15 @@ Accept wildcard characters: False ``` ### -AllowExtensions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowExtensions parameter specifies whether callers can make calls to extensions that have the same number of digits as the number specified on the dial plan object. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -304,6 +329,9 @@ Accept wildcard characters: False ``` ### -BusinessHoursKeyMapping + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursKeyMapping parameter specifies the key mappings for business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. The following is an example for a custom table that has two entries: @@ -316,7 +344,6 @@ The default is disabled. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -326,13 +353,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursKeyMappingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursKeyMappingEnabled parameter specifies whether the custom menus for business hours are enabled or disabled. The default value is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -342,13 +371,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursMainMenuCustomPromptEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursMainMenuCustomPromptEnabled parameter specifies whether the business hours custom main menu prompt is enabled. The default value is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -358,13 +389,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursMainMenuCustomPromptFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursMainMenuCustomPromptFilename parameter specifies the .wav file to be used for the business hours custom main menu prompt. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -374,6 +407,9 @@ Accept wildcard characters: False ``` ### -BusinessHoursSchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursSchedule parameter specifies the hours the business is open. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. @@ -401,7 +437,6 @@ Here are some examples: Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -411,13 +446,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursTransferToOperatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursTransferToOperatorEnabled parameter specifies whether to allow call transfers to the operator's extension number during business hours. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -427,13 +464,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursWelcomeGreetingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursWelcomeGreetingEnabled parameter specifies whether the custom business hours greeting is enabled. The system default audio is used if this parameter is set to disabled. The default value is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -443,13 +482,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursWelcomeGreetingFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursWelcomeGreetingFilename parameter specifies the .wav file to be used for the welcome message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -459,13 +500,15 @@ Accept wildcard characters: False ``` ### -BusinessLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessLocation parameter specifies what the Mailbox server should read to the caller who selected the business location option on a UM auto attendant menu. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -475,13 +518,15 @@ Accept wildcard characters: False ``` ### -BusinessName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessName parameter specifies the name of the company or organization being used to generate the UM auto attendant welcome greeting for callers. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -491,13 +536,15 @@ Accept wildcard characters: False ``` ### -CallSomeoneEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -507,6 +554,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -516,7 +566,6 @@ 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 Required: False Position: Named @@ -526,13 +575,15 @@ Accept wildcard characters: False ``` ### -ContactAddressList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactAddressList parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, this parameter defines the scope for directory searches. ```yaml Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -542,13 +593,15 @@ Accept wildcard characters: False ``` ### -ContactRecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches. ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -558,13 +611,15 @@ Accept wildcard characters: False ``` ### -ContactScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactScope parameter specifies the scope of the directory search given to callers when they access the UM auto attendant and specify a user's name. ```yaml Type: DialScopeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -574,13 +629,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -590,13 +647,15 @@ Accept wildcard characters: False ``` ### -DTMFFallbackAutoAttendant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DTMFFallbackAutoAttendant parameter specifies the dual tone multi-frequency (DTMF) auto attendant used if the speech-enabled auto attendant is unavailable. If the SpeechEnabled parameter is set to $true, this auto attendant must have an associated DTMF auto attendant to use as the fallback auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -606,13 +665,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -622,6 +683,9 @@ Accept wildcard characters: False ``` ### -HolidaySchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The HolidaySchedule parameter specifies the holiday schedule for the organization. The schedule is formatted as an array of strings. Each string contains three parts: - Name, which is limited to 64 characters @@ -636,7 +700,6 @@ The following is an example: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -646,13 +709,15 @@ Accept wildcard characters: False ``` ### -InfoAnnouncementEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InfoAnnouncementEnabled parameter specifies whether to enable the informational greeting. The default setting is $true. ```yaml Type: InfoAnnouncementEnabledEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -662,13 +727,15 @@ Accept wildcard characters: False ``` ### -InfoAnnouncementFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InfoAnnouncementFilename parameter specifies the .wav file to be used for the informational announcement. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -678,13 +745,15 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Language parameter specifies the language used by the UM auto attendant. This language is selected from the list of available dial plan languages. ```yaml Type: UMLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -694,6 +763,9 @@ Accept wildcard characters: False ``` ### -MatchedNameSelectionMethod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MatchedNameSelectionMethod parameter specifies the selection to use to differentiate between users who have names that match the touchtone or speech input. This setting can be set to the following: - Department @@ -707,7 +779,6 @@ The MatchedNameSelectionMethod parameter specifies the selection to use to diffe Type: AutoAttendantDisambiguationFieldEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -717,13 +788,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name to be used for the UM auto attendant. This name is limited to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -733,13 +806,15 @@ Accept wildcard characters: False ``` ### -NameLookupEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NameLookupEnabled parameter specifies whether to allow callers to perform directory lookups by dialing the name or by speaking the name. This parameter can prevent callers from connecting to unknown extensions. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -749,13 +824,15 @@ Accept wildcard characters: False ``` ### -OperatorExtension + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the dial plan operator is used. If the dial plan operator isn't specified, the feature isn't enabled. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -765,13 +842,15 @@ Accept wildcard characters: False ``` ### -PilotIdentifierList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PilotIdentifierList parameter specifies a list of one or more pilot numbers. Pilot numbers are used to route incoming calls to Mailbox servers. The calls are then answered by the UM auto attendant. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -781,13 +860,15 @@ Accept wildcard characters: False ``` ### -SendVoiceMsgEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SendVoiceMsgEnabled parameter specifies whether to allow the Send Message feature. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -797,13 +878,15 @@ Accept wildcard characters: False ``` ### -SpeechEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SpeechEnabled parameter specifies whether the auto attendant is speech-enabled. The default setting on the UM auto attendant is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -813,13 +896,15 @@ Accept wildcard characters: False ``` ### -Timezone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Timezone parameter specifies the time zone used with the auto attendant. The default time zone is the time zone setting on the server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -829,13 +914,15 @@ Accept wildcard characters: False ``` ### -Timezone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Timezone parameter specifies the time zone used with the auto attendant. The default time zone is the time zone setting on the server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -845,13 +932,15 @@ Accept wildcard characters: False ``` ### -TimeZoneName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TimeZoneName parameter specifies all or part of a MicrosoftWindows time zone display name. The string is compared to the display names in the local system registry to determine a simple contains match. An error is returned if the time zone name isn't correct. ```yaml Type: UMTimeZone Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -861,13 +950,15 @@ Accept wildcard characters: False ``` ### -WeekStartDay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WeekStartDay parameter specifies the starting day of the week. The valid values for this parameter are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. ```yaml Type: DayOfWeek Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -877,13 +968,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMCallAnsweringRule.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMCallAnsweringRule.md index f5a3f24afa..9c17c4a91e 100644 --- a/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: Set-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umcallansweringrule +schema: 2.0.0 +title: Set-UMCallAnsweringRule --- # Set-UMCallAnsweringRule @@ -54,7 +55,7 @@ You can also specify the following actions: After this task is completed, the cmdlet sets the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -93,10 +94,10 @@ This example performs the following actions on the call answering rule MyCallAns - Sets the priority of the call answering rule to 2. - Creates key mappings for the call answering rule. -If the caller reaches the voice mail for the user and the status of the user is set to Busy, the caller can: +If the caller reaches the voice mail for the user and the status of the user is set to Busy, the caller can take one of the following actions: - Press the 1 key and be transferred to a receptionist at extension 45678. -- Press the 2 key and the Find Me feature will be used for urgent issues and ring extension 23456 first and then 45671. +- Press the 2 key and the Find Me feature is used for urgent issues and ring extension 23456 first and then 45671. ### Example 5 ```powershell @@ -121,13 +122,15 @@ This example sets a custom period for the time of day on the call answering rule ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for a call answering rule being changed. ```yaml Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -137,13 +140,15 @@ Accept wildcard characters: False ``` ### -CallerIds + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CallerIds parameter specifies an entry for the "If the Caller is" condition. Each entry for this parameter can contain a phone number, an Active Directory contact, a personal contact, or the personal Contacts folder. The parameter can contain 50 phone numbers or contact entries and no more than one entry for specifying the default Contacts folder. If the CallerIds parameter doesn't contain a condition, the condition isn't set and is ignored. The default value is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -153,13 +158,15 @@ Accept wildcard characters: False ``` ### -CallersCanInterruptGreeting + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CallersCanInterruptGreeting parameter specifies whether a caller can interrupt the voice mail greeting while it's being played. The default is $null. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -169,13 +176,15 @@ Accept wildcard characters: False ``` ### -CheckAutomaticReplies + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CheckAutomaticReplies parameter specifies an entry for the "If My Automatic Replies are Enabled" condition. The default is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -185,6 +194,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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`. @@ -194,7 +206,6 @@ 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 Required: False Position: Named @@ -204,13 +215,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named @@ -220,13 +233,15 @@ Accept wildcard characters: False ``` ### -ExtensionsDialed + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The ExtensionsDialed parameter specifies an entry for the "If the Caller Dials" condition. Each entry must be unique per call answering rule. Each extension must correspond to existing extension numbers assigned to UM-enabled users. The default is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -236,13 +251,15 @@ Accept wildcard characters: False ``` ### -KeyMappings + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The KeyMappings parameter specifies a key mapping entry for a call answering rule. The key mappings are those menu options offered to callers if the call answering rule is set to $true. You can configure a maximum of 10 entries. None of the defined key mappings can overlap. The default is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -252,7 +269,10 @@ Accept wildcard characters: False ``` ### -Mailbox -The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule will be changed. You can use any value that uniquely identifies the mailbox. For example: + +> Applicable: Exchange Server 2013, Exchange Server 2016 + +The Mailbox parameter specifies the UM-enabled mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name - Alias @@ -271,7 +291,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -281,13 +300,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the name of the UM call answering rule or Call Answering Rule ID being modified. The call answering ID or name must be unique per the user's UM-enabled mailbox. The name or ID for the call answering rule can contain up to 255 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -297,13 +318,17 @@ Accept wildcard characters: False ``` ### -Priority -The Priority parameter specified the order that the call answering rule will be evaluated against other existing call answering rules. Call answering rules are processed in order of increasing priority values. The priority must be unique between all call answering rules in the UM-enabled mailbox. The priority on the call answering rule must be between 1 (highest) and 9 (lowest). The default is 9. + +> Applicable: Exchange Server 2013, Exchange Server 2016 + +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, and rules can't have the same priority value. + +A valid value is an integer from 1 (highest priority) to 9 (lowest priority). The default value is 9. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -313,6 +338,9 @@ Accept wildcard characters: False ``` ### -ScheduleStatus + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The ScheduleStatus parameter specifies an entry for the "If my Schedule show that I am" condition. Users can specify their free/busy status to be checked. This parameter can be set from 0 through 15 and is interpreted as a 4-bit mask that represents the calendar status including Free, Tentative, Busy and Out of Office. The following settings can be used to set the schedule status: - None = 0x0 @@ -327,7 +355,6 @@ The default setting is $null. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -337,13 +364,15 @@ Accept wildcard characters: False ``` ### -TimeOfDay + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The TimeOfDay parameter specifies an entry for the "If the Call Arrives During" condition for the call answering rule. You can specify working hours, non-working hours or custom hours. The default is $null. ```yaml Type: TimeOfDay Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -353,13 +382,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMCallRouterSettings.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMCallRouterSettings.md index e2d42d19d4..70f693b2b4 100644 --- a/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMCallRouterSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umcallroutersettings applicable: Exchange Server 2013, Exchange Server 2016 -title: Set-UMCallRouterSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umcallroutersettings +schema: 2.0.0 +title: Set-UMCallRouterSettings --- # Set-UMCallRouterSettings @@ -36,7 +37,7 @@ Set-UMCallRouterSettings [[-Server] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example removes the Exchange server named UMCallRouter001 from all UM SIP d ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -75,7 +79,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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`. @@ -94,7 +100,6 @@ 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 Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -DialPlans + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DialPlans parameter specifies the dial plan used by the Microsoft Exchange Unified Messaging Call Router service. The Exchange server only needs to be associated with a UM dial plan if Lync Server 2010, Lync Server 2013, or Skype for Business Server 2015 is used in your organization. To remove an Exchange server from a dial plan, use $null. The default is no dial plans assigned. 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"`. @@ -114,7 +122,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named @@ -140,13 +149,19 @@ Accept wildcard characters: False ``` ### -IPAddressFamily -The IPAddressFamily parameter specifies whether the UM IP gateway will use Internet Protocol version 4 (IPv4), IPv6, or both to communicate. If set to IPv4Only, the UM IP gateway only uses IPv4 to communicate. If set to IPv6Only, the UM IP gateway only uses IPv6. If set to Any, IPv6 is used first, and then if necessary, it falls back to IPv4. The default is Any. + +> Applicable: Exchange Server 2013, Exchange Server 2016 + +The IPAddressFamily parameter specifies the Internet Protocol (IP) version to use. Valid values are: + +- IPv4Only: The UM IP gateway uses only IPv4 to communicate. +- IPv6Only: The UM IP gateway uses only IPv6. +- Any: IPv6 is used first. If IPv6 isn't available, IPV4 is used. This value is the default. ```yaml Type: IPAddressFamily Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -156,13 +171,15 @@ Accept wildcard characters: False ``` ### -IPAddressFamilyConfigurable + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IPAddressFamilyConfigurable parameter specifies whether you're able to set the IPAddressFamily parameter to IPv6Only or Any. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -172,13 +189,15 @@ Accept wildcard characters: False ``` ### -MaxCallsAllowed -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2013, Exchange Server 2016 + +This parameter is deprecated and no longer used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -188,13 +207,15 @@ Accept wildcard characters: False ``` ### -SipTcpListeningPort + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The SipTcpListeningPort parameter specifies the TCP port that's used by the Microsoft Exchange Unified Messaging Call Router service to receive incoming calls. This TCP port is used when a UM dial plan isn't configured to use SIP Secured or Secured mode. The default is port 5060. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -204,13 +225,15 @@ Accept wildcard characters: False ``` ### -SipTlsListeningPort + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The SipTlsListeningPort parameter specifies the Transport Layer Security (TLS) port that's used by the Microsoft Exchange Unified Messaging Call Router service to receive incoming calls. This TLS port is used when a UM dial plan is configured to use SIP Secured or Secured mode. The default is port 5061. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -220,13 +243,15 @@ Accept wildcard characters: False ``` ### -UMStartupMode + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The UMStartupMode parameter specifies whether the Microsoft Exchange Unified Messaging Call Router service starts up in TCP, TLS, or Dual mode. If the Exchange server isn't associated with any UM dial plans or is being added to UM dial plans that have different security settings, you should choose Dual mode. In Dual mode, the Microsoft server can listen on ports 5060 and 5061 at the same time. If the startup mode is changed, the Microsoft Exchange Unified Messaging Call Router service must be restarted. ```yaml Type: UMStartupMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -236,13 +261,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMDialPlan.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMDialPlan.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-UMDialPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMDialPlan.md index 0255771570..7443667f03 100644 --- a/exchange/exchange-ps/exchange/Set-UMDialPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMDialPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMDialPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umdialplan +schema: 2.0.0 +title: Set-UMDialPlan --- # Set-UMDialPlan @@ -82,7 +83,7 @@ UM dial plans are important to the operation of Unified Messaging. Modifications After this task is completed, the parameters and values specified are configured on the UM dial plan. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -114,13 +115,15 @@ This example configures the UM dial plan MyDialPlan with dialing rules. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the UM dial plan ID. This parameter is the directory object identifier for the UM dial plan. This parameter is used to link mailboxes and Mailbox and Client Access servers to dial plans. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -130,13 +133,15 @@ Accept wildcard characters: False ``` ### -AccessTelephoneNumbers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AccessTelephoneNumbers parameter specifies a single valid voice mail pilot number or a list of valid voice mail pilot numbers. This list is presented to you when a user is being enabled for Unified Messaging. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -146,13 +151,15 @@ Accept wildcard characters: False ``` ### -AllowDialPlanSubscribers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowDialPlanSubscribers parameter specifies whether to allow subscribers dial numbers that resolve to a subscriber within the same dial plan. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -162,13 +169,15 @@ Accept wildcard characters: False ``` ### -AllowedInCountryOrRegionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/region names from the same dial group that can be dialed. The name of the allowed in-country/region group must match the group name specified in the UM dial plan. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -178,13 +187,15 @@ Accept wildcard characters: False ``` ### -AllowedInternationalGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInternationalGroups parameter specifies the list of international dial group names allowed. The international dial group name must match the group name specified in the dial plan. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -194,13 +205,15 @@ Accept wildcard characters: False ``` ### -AllowExtensions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowExtensions parameter specifies whether to allow calls to dial plan extensions. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -210,13 +223,15 @@ Accept wildcard characters: False ``` ### -AllowHeuristicADCallingLineIdResolution -The AllowHeuristicADCallingLineIdResolution parameter specifies whether to allow calling line ID resolution using telephone number fields that may be configured in Active Directory. When this parameter is set to $true, the telephone numbers such as those defined in the Mobile or Home telephone number fields in Active Directory are used. Setting this parameter to $true allows for resolution of calling IDs for both UM-enabled and non-UM-enabled users. The default is $true. You may want to set this parameter to $false if the telephone numbers for users aren't in a standard format. If the telephone numbers aren't in a standard format, the Mailbox server may not be able to correctly resolve the caller ID to a name of a user in a consistent manner. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The AllowHeuristicADCallingLineIdResolution parameter specifies whether to allow calling line ID resolution using telephone number fields that might be configured in Active Directory. When this parameter is set to $true, the telephone numbers such as those defined in the Mobile or Home telephone number fields in Active Directory are used. Setting this parameter to $true allows for resolution of calling IDs for both UM-enabled and non-UM-enabled users. The default is $true. You might want to set this parameter to $false if the telephone numbers for users aren't in a standard format. If the telephone numbers aren't in a standard format, the Mailbox server might not be able to correctly resolve the caller ID to a name of a user in a consistent manner. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -226,13 +241,15 @@ Accept wildcard characters: False ``` ### -AudioCodec + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AudioCodec parameter specifies the audio codec used for recording. Mp3 is the default setting. ```yaml Type: AudioCodecEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -242,13 +259,15 @@ Accept wildcard characters: False ``` ### -AutomaticSpeechRecognitionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AutomaticSpeechRecognitionEnabled parameter specifies whether Automatic Speech Recognition (ASR) is enabled for users who are members of the dial plan. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -258,13 +277,15 @@ Accept wildcard characters: False ``` ### -CallAnsweringRulesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CallAnsweringRulesEnabled parameter specifies whether Call Answering Rules are enabled for UM-enabled users associated with the UM dial plan. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -274,13 +295,15 @@ Accept wildcard characters: False ``` ### -CallSomeoneEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -290,6 +313,9 @@ Accept wildcard characters: False ``` ### -ConfiguredInCountryOrRegionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ConfiguredInCountryOrRegionGroups parameter specifies the in-country groups that can be used. Each string consists of four parts: - Group name (up to 32 characters) @@ -301,7 +327,6 @@ The ConfiguredInCountryOrRegionGroups parameter specifies the in-country groups Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -311,6 +336,9 @@ Accept wildcard characters: False ``` ### -ConfiguredInternationalGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ConfiguredInternationalGroups parameter specifies the international groups that can be used. Each string consists of four parts: - Group name (up to 32 characters) @@ -322,7 +350,6 @@ The ConfiguredInternationalGroups parameter specifies the international groups t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -332,6 +359,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -341,7 +371,6 @@ 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 Required: False Position: Named @@ -351,13 +380,15 @@ Accept wildcard characters: False ``` ### -ContactAddressList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactAddressList parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, this parameter defines the scope for directory searches. ```yaml Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -367,13 +398,15 @@ Accept wildcard characters: False ``` ### -ContactRecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches. ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -383,13 +416,15 @@ Accept wildcard characters: False ``` ### -ContactScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactScope parameter specifies the scope of the directory search provided to callers when they access the UM dial plan and specify a user's name. ```yaml Type: CallSomeoneScopeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -399,13 +434,15 @@ Accept wildcard characters: False ``` ### -CountryOrRegionCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is located. For example, 1 is the code used for North America, and 44 is the code used for the United Kingdom. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -415,13 +452,15 @@ Accept wildcard characters: False ``` ### -DefaultLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DefaultLanguage parameter specifies the default language of the system. This default language is selected from the list of available languages. The default value is U.S. English. ```yaml Type: UMLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -431,13 +470,15 @@ Accept wildcard characters: False ``` ### -DialByNamePrimary + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DialByNamePrimary parameter specifies that the Dial by Name lookup key is to be created from the specified source. The default value is LastFirst. ```yaml Type: DialByNamePrimaryEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -447,13 +488,15 @@ Accept wildcard characters: False ``` ### -DialByNameSecondary + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DialByNameSecondary parameter specifies that the secondary Dial by Name lookup key is to be created from the specified source. The default value is SMTPAddress. ```yaml Type: DialByNameSecondaryEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -463,13 +506,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -479,13 +524,15 @@ Accept wildcard characters: False ``` ### -EquivalentDialPlanPhoneContexts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The EquivalentDialPlanPhoneContexts parameter specifies the name of an equivalency dial plan. This parameter can be used when two UM dial plans exist but are in different forests or when a Private Branch eXchange (PBX) numbering plan spans two UM dial plans. Adding the name of the equivalency dial plan allows name lookups using a caller ID to search in the user's dial plan but then also search for a name for the calling line ID in any equivalent dial plans that are configured. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -495,13 +542,15 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Extension parameter specifies the extension number used by the Call Someone feature when a call is transferred. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -511,13 +560,15 @@ Accept wildcard characters: False ``` ### -FaxEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The FaxEnabled parameter specifies whether the Mailbox servers associated with the UM dial plan answers and processes incoming fax calls. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -527,13 +578,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -543,13 +596,15 @@ Accept wildcard characters: False ``` ### -InCountryOrRegionNumberFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InCountryOrRegionNumberFormat parameter specifies the prefix string to use and the number of digits to take from the directory. This number is used when dialing into this dial plan from inside the same country or region code. ```yaml Type: NumberFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -559,13 +614,15 @@ Accept wildcard characters: False ``` ### -InfoAnnouncementEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InfoAnnouncementEnabled parameter specifies whether an informational announcement is enabled. This parameter can be set to True, False, or Uninterruptible. The default value is False. ```yaml Type: InfoAnnouncementEnabledEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -575,13 +632,15 @@ Accept wildcard characters: False ``` ### -InfoAnnouncementFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InfoAnnouncementFilename parameter specifies the audio file name for an informational announcement. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -591,13 +650,15 @@ Accept wildcard characters: False ``` ### -InputFailuresBeforeDisconnect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InputFailuresBeforeDisconnect parameter specifies the number of sequential user input errors allowed before the call is disconnected. The default value is 3. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -607,13 +668,15 @@ Accept wildcard characters: False ``` ### -InternationalAccessCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InternationalAccessCode parameter specifies the code that precedes a telephone number to dial international calls. For example, 011 is the code used to call the United States. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -623,13 +686,15 @@ Accept wildcard characters: False ``` ### -InternationalNumberFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InternationalNumberFormat parameter specifies the prefix string to use and the number of digits to take from the directory, when dialing into this dial plan from a different country code. ```yaml Type: NumberFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -639,13 +704,15 @@ Accept wildcard characters: False ``` ### -LegacyPromptPublishingPoint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The LegacyPromptPublishingPoint parameter was used to specify the location of the prompt publishing point for Exchange Server 2007 Unified Messaging servers. This parameter was used in coexistence scenarios when Exchange 2007 Unified Messaging servers were also included in the UM dial plan. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -655,13 +722,15 @@ Accept wildcard characters: False ``` ### -LogonFailuresBeforeDisconnect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The LogonFailuresBeforeDisconnect parameter specifies the number of sequential unsuccessful logon attempts that can be made before the call is disconnected. The default value is 3. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -671,6 +740,9 @@ Accept wildcard characters: False ``` ### -MatchedNameSelectionMethod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MatchedNameSelectionMethod parameter specifies the selection to use to differentiate between users who have names that match the touchtone or speech input. This setting can be set to the following: - Title @@ -683,7 +755,6 @@ The MatchedNameSelectionMethod parameter specifies the selection to use to diffe Type: DisambiguationFieldEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -693,13 +764,15 @@ Accept wildcard characters: False ``` ### -MaxCallDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MaxCallDuration parameter specifies the maximum length of time that a call can last before it's interrupted and the call is dropped. The default value is 30 minutes. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -709,13 +782,15 @@ Accept wildcard characters: False ``` ### -MaxRecordingDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MaxRecordingDuration parameter specifies the maximum length of time that messages can be recorded. This includes all kinds of calls. The default is 20 minutes. The value of this setting can be from 1 through 100. Setting this value too low can cause long voice messages to be disconnected before they are completed. Setting this value too high lets users save lengthy voice messages in their Inboxes. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -725,13 +800,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name to use for the UM dial plan. This name is limited to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -741,13 +818,15 @@ Accept wildcard characters: False ``` ### -NationalNumberPrefix + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NationalNumberPrefix parameter specifies the dialing code that precedes a telephone number when placing calls from one local area to another within a specific country or region. For example, 1 is the code used within North America, and 0 is the code used within the United Kingdom. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -757,13 +836,15 @@ Accept wildcard characters: False ``` ### -NumberingPlanFormats + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NumberingPlanFormats parameter specifies one or more phone number masks that can be used for resolving caller ID to names of users in Active Directory. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -773,13 +854,15 @@ Accept wildcard characters: False ``` ### -OperatorExtension + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the Do Not Allow Transfer to the Operator feature is unavailable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -789,13 +872,15 @@ Accept wildcard characters: False ``` ### -OutsideLineAccessCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OutsideLineAccessCode parameter specifies the code that precedes a telephone number to dial an external in-country telephone number. This code is also referred to as a trunk access code. The default value is 9. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -805,13 +890,15 @@ Accept wildcard characters: False ``` ### -PilotIdentifierList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PilotIdentifierList parameter specifies the pilot numbers configured on the dial plan. A single dial plan can have multiple pilot numbers. The pilot numbers must be in the E.164 format. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -821,13 +908,15 @@ Accept wildcard characters: False ``` ### -RecordingIdleTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The RecordingIdleTimeout parameter specifies the length of time that a caller can be silent when recording a voice message before the recording is ended. The default value is 5 seconds. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -837,13 +926,15 @@ Accept wildcard characters: False ``` ### -SendVoiceMsgEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SendVoiceMsgEnabled parameter specifies whether the Send Message feature is enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -853,13 +944,15 @@ Accept wildcard characters: False ``` ### -TUIPromptEditingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TUIPromptEditingEnabled parameter specifies whether authorized users are permitted to record UM dial plan or automated attendant prompts by using the Telephone User Interface (TUI). The default setting is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -869,13 +962,15 @@ Accept wildcard characters: False ``` ### -UMAutoAttendant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMAutoAttendant parameter specifies the auto attendant run when the caller presses the star (\*) key. If this parameter is specified, it overrides the Call Someone feature. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -885,13 +980,15 @@ Accept wildcard characters: False ``` ### -VoIPSecurity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoIPSecurity parameter specifies whether the Voice over IP (VoIP) traffic is encrypted or that the signaling channel or the signaling and the media channels are encrypted by using mutual Transport Layer Security (TLS). The default setting is Unsecured. ```yaml Type: UMVoIPSecurityType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -901,13 +998,15 @@ Accept wildcard characters: False ``` ### -WelcomeGreetingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WelcomeGreetingEnabled parameter specifies whether a custom welcome greeting is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -917,13 +1016,15 @@ Accept wildcard characters: False ``` ### -WelcomeGreetingFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WelcomeGreetingFilename parameter specifies the audio file name for the welcome greeting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -933,13 +1034,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMIPGateway.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMIPGateway.md index af9d1ffda1..d0fc8eafb1 100644 --- a/exchange/exchange-ps/exchange/Set-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umipgateway +schema: 2.0.0 +title: Set-UMIPGateway --- # Set-UMIPGateway @@ -41,11 +42,11 @@ Set-UMIPGateway [-Identity] ## DESCRIPTION The Set-UMIPGateway cmdlet modifies configuration settings for a specific UM IP gateway, for example, the IP address to the IP gateway. These modifications include allowing outgoing calls and controlling communications with a Session Initiation Protocol (SIP)-enabled IP Private Branch eXchange (PBX) or IP gateway. -It's possible that modifications to the UM IP gateway settings may disrupt communication between Mailbox servers and the SIP-enabled IP PBX or IP gateway. Modifications to a UM IP gateway should be performed only by an administrator who fully understands the implications of making configuration changes to the UM IP gateway. +It's possible that modifications to the UM IP gateway settings might disrupt communication between Mailbox servers and the SIP-enabled IP PBX or IP gateway. Modifications to a UM IP gateway should be performed only by an administrator who fully understands the implications of making configuration changes to the UM IP gateway. After this task is completed, the parameters and values specified are configured on the UM IP gateway. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,13 +81,15 @@ This example enables the UM IP gateway to function as an IP gateway simulator an ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM IP gateway being modified. This parameter is the directory object ID for the UM IP gateway. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -Address -The Address parameter specifies the IP address or the fully qualified domain name (FQDN) configured on the UM IP gateway or SIP-enabled IP PBX. An FQDN is required if the UM dial plan associated with the UM IP gateway is operating in SIP Secured or Secured mode. If an FQDN is used, verify that the Domain Name System (DNS) has been configured correctly. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The Address parameter specifies the IP address or the fully qualified domain name (FQDN) configured on the UM IP gateway or SIP-enabled IP PBX. An FQDN is required if the UM dial plan associated with the UM IP gateway is operating in SIP Secured or Secured mode. If an FQDN is used, verify that the Domain Name System (DNS) is configured correctly. ```yaml Type: UMSmartHost Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -121,7 +129,6 @@ 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 Required: False Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -DelayedSourcePartyInfoEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DelayedSourcePartyInfoEnabled parameter specifies whether Unified Messaging should delay the process of accepting an inbound call from the Voice over IP (VoIP) gateway if the corresponding SIP INVITE of the call contains no calling party and diversion information. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -163,13 +174,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -179,17 +192,19 @@ Accept wildcard characters: False ``` ### -IPAddressFamily -The IPAddressFamily parameter specifies whether the UM IP gateway will use Internet Protocol version 4 (IPv4), IPv6, or both to communicate. Valid values are: -- IPv4Only: The UM IP gateway will only use IPv4 to communicate. This is the default value. -- IPv6Only: The UM IP gateway will only use IPv6. -- Any: IPv6 will be used first, and then if necessary, it will fall back to IPv4. +> Applicable: Exchange Server 2013, Exchange Server 2016 + +The IPAddressFamily parameter specifies the Internet Protocol (IP) version to use. Valid values are: + +- IPv4Only: The UM IP gateway uses only IPv4 to communicate. This value is the default. +- IPv6Only: The UM IP gateway uses only IPv6. +- Any: IPv6 is used first. If IPv6 isn't available, IPV4 is used. ```yaml Type: IPAddressFamily Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -MessageWaitingIndicatorAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MessageWaitingIndicatorAllowed parameter specifies whether to enable the UM IP gateway to allow SIP NOTIFY messages to be sent to users associated with a UM dial plan and the UM IP gateway. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -215,13 +232,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the UM IP gateway. This display name is limited to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -231,13 +250,15 @@ Accept wildcard characters: False ``` ### -OutcallsAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OutcallsAllowed parameter specifies whether to allow this UM IP gateway to be used for outgoing calls. This doesn't govern call transfers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -247,13 +268,15 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Port parameter specifies the IP port on which the IP gateway or IP PBX is listening. By default, it's port 5060. The range for this parameter is from 0 through 65535. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -263,13 +286,15 @@ Accept wildcard characters: False ``` ### -Simulator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Simulator parameter specifies the simulator used for the UM IP gateway being viewed. A simulator allows a client to connect to the Mailbox server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -279,6 +304,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Status parameter specifies whether to enable or disable the UM IP gateway. Valid values are: - Enabled @@ -289,7 +317,6 @@ The Status parameter specifies whether to enable or disable the UM IP gateway. V Type: GatewayStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -299,13 +326,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailbox.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-UMMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMMailbox.md index 7e179f4bc5..e6f7eb7a8c 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ummailbox +schema: 2.0.0 +title: Set-UMMailbox --- # Set-UMMailbox @@ -48,11 +49,11 @@ Set-UMMailbox [-Identity] ``` ## DESCRIPTION -The Set-UMMailbox cmdlet sets UM properties associated with a user who has been UM-enabled. Many of the UM properties for the user are stored on the user's mailbox, and other UM properties for the user are stored in Active Directory. +The Set-UMMailbox cmdlet sets UM properties associated with a user who is UM-enabled. Many of the UM properties for the user are stored on the user's mailbox, and other UM properties for the user are stored in Active Directory. After this task is completed, the parameters and values specified are configured on the UM mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,6 +82,9 @@ This example prevents the user tony@contoso.com from accessing his calendar and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -98,7 +102,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -108,13 +111,15 @@ Accept wildcard characters: False ``` ### -AllowUMCallsFromNonUsers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowUMCallsFromNonUsers parameter specifies whether to exclude the mailbox from Unified Messaging directory searches. ```yaml Type: AllowUMCallsFromNonUsersFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -124,13 +129,15 @@ Accept wildcard characters: False ``` ### -AnonymousCallersCanLeaveMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AnonymousCallersCanLeaveMessages parameter specifies whether diverted calls without a caller ID are allowed to leave a message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -140,13 +147,15 @@ Accept wildcard characters: False ``` ### -AutomaticSpeechRecognitionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AutomaticSpeechRecognitionEnabled parameter specifies whether users can use Automatic Speech Recognition (ASR) when they log on to their mailbox. This parameter can only be set to $true if there is ASR support for the language selected by the user in Microsoft Outlook on the web Options. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -CallAnsweringAudioCodec + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CallAnsweringAudioCodec parameter specifies the audio codec used to encode voice mail messages left for the user. The audio codec used is the audio codec set on the UM dial plan. The default value is Mp3. ```yaml Type: AudioCodecEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -CallAnsweringRulesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CallAnsweringRulesEnabled parameter specifies whether users can configure or set up Call Answering Rules for their accounts. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -197,7 +213,6 @@ 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 Required: False Position: Named @@ -207,13 +222,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -223,13 +240,15 @@ Accept wildcard characters: False ``` ### -FaxEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The FaxEnabled parameter specifies whether a user is allowed to receive incoming faxes. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -239,6 +258,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -250,7 +272,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -260,22 +281,24 @@ Accept wildcard characters: False ``` ### -ImListMigrationCompleted + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The ImListMigrationCompleted parameter specifies whether the UM-enabled user's Lync or Skype for Business contact list is stored in their mailbox. Valid values are: - $true: The user's Lync or Skype for Business contact list is stored in their Exchange 2016 mailbox. This prevents you from migrating the mailbox back to an Exchange 2010 server. -- $false: The user's Lync or Skype for Business contact list is stored on a Lync or Skype for Business server. This doesn't prevent you from migrating the mailbox back to an Exchange 2010 server. This is the default value. +- $false: The user's Lync or Skype for Business contact list is stored on a Lync or Skype for Business server. This doesn't prevent you from migrating the mailbox back to an Exchange 2010 server. This value is the default. Lync Server 2013 and Skype for Business Server 2015 support storing the user's contact list in their Exchange 2016 mailbox. This feature is known as the unified contact store (UCS), and it allows applications to show a consistent, up-to-date contact list. However, Exchange 2010 doesn't support the unified contact store. Therefore, before you migrate a user's Exchange 2016 mailbox back to Exchange 2010, you need to move the user's Lync or Skype for Business contact list from the unified contact store back to a Lync 2013 or Skype for Business server. For more information, see [Configuring Microsoft Lync Server 2013 to use the unified contact store](https://learn.microsoft.com/lyncserver/lync-server-2013-configuring-lync-server-to-use-the-unified-contact-store). -If you migrate an Exchange 2013 mailbox back to Exchange 2010 while the user's Lync or Skype for Business contact list is stored in the unified contact store, the user could permanently lose access to those contacts. After you verify the user's Lync or Skype for Business contact list has been moved back to a Lync 2013 or Skype for Business server, you should be able to complete the mailbox migration. If you need to migrate the mailbox despite the potential for data loss, you can manually set the ImListMigrationCompleted parameter to $false. +If you migrate an Exchange 2013 mailbox back to Exchange 2010 while the user's Lync or Skype for Business contact list is stored in the unified contact store, the user could permanently lose access to those contacts. After you verify the user's Lync or Skype for Business contact list is moved back to a Lync 2013 or Skype for Business server, you should be able to complete the mailbox migration. If you need to migrate the mailbox despite the potential for data loss, you can manually set the ImListMigrationCompleted parameter to $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -285,6 +308,9 @@ Accept wildcard characters: False ``` ### -MissedCallNotificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MissedCallNotificationEnabled parameter specifies whether to send missed call notifications. When you're integrating Unified Messaging and Lync Server or Skype for Business Server, missed call notifications aren't available to users who have mailboxes located on Exchange 2010 Mailbox servers. A missed call notification is generated when a user disconnects before the call is sent to a Mailbox server. @@ -293,7 +319,6 @@ When you're integrating Unified Messaging and Lync Server or Skype for Business Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -303,13 +328,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the user. The display name is limited to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -319,13 +346,15 @@ Accept wildcard characters: False ``` ### -OperatorNumber + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OperatorNumber parameter specifies the string of digits for the personal operator. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -335,13 +364,15 @@ Accept wildcard characters: False ``` ### -PinlessAccessToVoiceMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PinlessAccessToVoiceMailEnabled parameter specifies whether UM-enabled users are required to use a PIN to access their voice mail. A PIN is still required to access email and the calendar. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -351,13 +382,15 @@ Accept wildcard characters: False ``` ### -PlayOnPhoneEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PlayOnPhoneEnabled parameter specifies whether a user can use the Play on Phone feature to listen to voice messages. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -367,13 +400,15 @@ Accept wildcard characters: False ``` ### -SubscriberAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SubscriberAccessEnabled parameter specifies whether the users are allowed subscriber access to their individual mailboxes. If it's set to $true, after users are authenticated, they're able to retrieve voice mail over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -383,13 +418,15 @@ Accept wildcard characters: False ``` ### -TUIAccessToCalendarEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TUIAccessToCalendarEnabled parameter specifies whether UM-enabled users can access and manage their individual calendar using the Microsoft Outlook Voice Access telephone user interface (TUI) or touchtone interface. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -399,13 +436,15 @@ Accept wildcard characters: False ``` ### -TUIAccessToEmailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TUIAccessToEmailEnabled parameter specifies whether users can access their individual email messages over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -415,13 +454,15 @@ Accept wildcard characters: False ``` ### -UMMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMMailboxPolicy parameter specifies the UM mailbox policy associated with the UM-enabled user's mailbox. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -431,13 +472,15 @@ Accept wildcard characters: False ``` ### -UMSMSNotificationOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMSMSNotificationOption parameter specifies whether a UM-enabled user gets SMS or text messaging notifications for voice mail only, voice mail and missed calls, or no notifications. The values for this parameter are: VoiceMail, VoiceMailAndMissedCalls, and None. The default value is None. ```yaml Type: UMSMSNotificationOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -447,13 +490,15 @@ Accept wildcard characters: False ``` ### -VoiceMailAnalysisEnabled -The VoiceMailAnalysisEnabled parameter specifies whether a copy of each voice mail left for a UM-enabled user will be forwarded to Microsoft for analysis and improvement of speech recognition features. + +> Applicable: Exchange Server 2013, Exchange Server 2016 + +The VoiceMailAnalysisEnabled parameter specifies whether a copy of each voice mail left for a UM-enabled user is forwarded to Microsoft for analysis and improvement of speech recognition features. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -463,13 +508,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPIN.md similarity index 75% rename from exchange/exchange-ps/exchange/Set-UMMailboxPIN.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPIN.md index bec81a4cf6..51d113a847 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPIN.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ummailboxpin applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMMailboxPIN -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ummailboxpin +schema: 2.0.0 +title: Set-UMMailboxPIN --- # Set-UMMailboxPIN @@ -35,11 +36,11 @@ Set-UMMailboxPIN [-Identity] ``` ## DESCRIPTION -The Set-UMMailboxPIN cmdlet is used when a UM-enabled user has been locked out of a mailbox because either the user tried to log on by using an incorrect PIN multiple times or because the user has forgotten the PIN. You can use this cmdlet to set the user's PIN. The new PIN must comply with the PIN policy rules specified in the user's mailbox policy. The new PIN is sent to the user in an email message, or sent to an alternative email address. You can control whether the user must reset the PIN at logon and if the mailbox will continue to be locked. +The Set-UMMailboxPIN cmdlet is used when a UM-enabled user is locked out of a mailbox because either the user tried to log on by using an incorrect PIN multiple times or because the user has forgotten the PIN. You can use this cmdlet to set the user's PIN. The new PIN must comply with the PIN policy rules specified in the user's mailbox policy. The new PIN is sent to the user in an email message, or sent to an alternative email address. You can control whether the user must reset the PIN at logon and if the mailbox remains locked. After this task is completed, the PIN on a UM-enabled mailbox is set. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,32 +49,35 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-UMMailboxPIN -Identity tonysmith@contoso.com ``` -This example resets the PIN on the UM-enabled mailbox for tonysmith@contoso.com. +This example resets the PIN on the UM-enabled mailbox for `tonysmith@contoso.com`. ### Example 2 ```powershell Set-UMMailboxPIN -Identity tonysmith@contoso.com -PIN 1985848 -PinExpired $true ``` -This example resets the initial PIN to 1985848 on the UM-enabled mailbox for tonysmith@contoso.com, and then sets the PIN as expired so that the user will be asked to change the PIN the next time the user logs on. +This example resets the initial PIN to 1985848 on the UM-enabled mailbox for `tonysmith@contoso.com`, and then sets the PIN as expired so that the user is asked to change the PIN the next time they sign in. ### Example 3 ```powershell Set-UMMailboxPIN -Identity tonysmith@contoso.com -LockedOut $true ``` -This example locks the UM-enabled mailbox for tonysmith@contoso.com to prevent the user from accessing the mailbox. +This example locks the UM-enabled mailbox for `tonysmith@contoso.com` to prevent the user from accessing the mailbox. ### Example 4 ```powershell Set-UMMailboxPIN -Identity tonysmith@contoso.com -LockedOut $false ``` -This example unlocks the UM-enabled mailbox for tonysmith@contoso.com and allows the user access to the mailbox. +This example unlocks the UM-enabled mailbox for `tonysmith@contoso.com` and allows the user access to the mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -91,7 +95,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -110,7 +116,6 @@ 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 Required: False Position: Named @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -147,7 +157,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -157,13 +166,18 @@ Accept wildcard characters: False ``` ### -LockedOut -The LockedOut parameter specifies whether the mailbox will continue to be locked. If set to $true, the mailbox is marked as locked out. By default, if this parameter is omitted or set to $false, the command clears the locked-out status on the mailbox. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The LockedOut parameter specifies whether the mailbox is locked out of UM. Valid values are: + +- $true: The mailbox is locked out of UM. +- $false: The locked-out status on the UM mailbox is cleared. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -173,13 +187,15 @@ Accept wildcard characters: False ``` ### -NotifyEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NotifyEmail parameter specifies the email address to which the server sends the email message that contains the PIN reset information. By default, the message is sent to the SMTP address of the enabled user. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -189,13 +205,15 @@ Accept wildcard characters: False ``` ### -Pin + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Pin parameter specifies a new PIN for use with the mailbox. The PIN is checked against the PIN rules defined in the Unified Messaging mailbox policy. If the PIN isn't supplied, the command generates a new PIN for the mailbox and includes it in an email message sent to the user. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -205,13 +223,15 @@ Accept wildcard characters: False ``` ### -PINExpired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PINExpired parameter specifies whether the PIN is treated as expired. If this parameter is supplied and is set to $false, the user isn't required to reset the PIN the next time that the user logs on. If the PIN isn't supplied, the PIN is treated as expired and the user is prompted to reset the PIN the next time that the user logs on. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -221,13 +241,15 @@ Accept wildcard characters: False ``` ### -SendEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SendEmail parameter specifies whether to send a PIN to the user in an email message. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -237,13 +259,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -253,13 +277,15 @@ Accept wildcard characters: False ``` ### -PINExpired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PINExpired parameter specifies whether the PIN is treated as expired. If this parameter is supplied and is set to $false, the user isn't required to reset the PIN the next time that the user logs on. If the PIN isn't supplied, the PIN is treated as expired and the user is prompted to reset the PIN the next time that the user logs on. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPolicy.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPolicy.md index 789aabc713..15310627c3 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ummailboxpolicy +schema: 2.0.0 +title: Set-UMMailboxPolicy --- # Set-UMMailboxPolicy @@ -78,13 +79,13 @@ When the Set-UMMailboxPolicy cmdlet is used to modify UM mailbox policy objects, After this task is completed, the parameters and values specified are configured on the UM mailbox policy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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-UMMailboxPolicy -Identity MyUMMailboxPolicy -LogonFailuresBeforePINReset 8 -MaxLogonAttempts 12 -MinPINLength 8 -PINHistoryCount 10 -PINLifetime 60 -ResetPINText "The PIN used to allow you access to your mailbox using Outlook Voice Access has been reset." +Set-UMMailboxPolicy -Identity MyUMMailboxPolicy -LogonFailuresBeforePINReset 8 -MaxLogonAttempts 12 -MinPINLength 8 -PINHistoryCount 10 -PINLifetime 60 -ResetPINText "The PIN used to allow you access to your mailbox using Outlook Voice Access is reset." ``` This example sets the PIN settings for users associated with the UM mailbox policy MyUMMailboxPolicy. @@ -106,13 +107,15 @@ This example configures the text of voice mail messages sent to UM-enabled users ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM mailbox policy being modified. This is the directory object ID for the UM mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -122,13 +125,15 @@ Accept wildcard characters: False ``` ### -AllowAutomaticSpeechRecognition + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowAutomaticSpeechRecognition parameter specifies whether users associated with the UM mailbox policy can use Automatic Speech Recognition (ASR). The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -138,13 +143,15 @@ Accept wildcard characters: False ``` ### -AllowCallAnsweringRules + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowCallAnsweringRules parameter specifies whether users associated with the UM mailbox policy are allowed to configure or set up Call Answering Rules for their accounts. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -154,13 +161,15 @@ Accept wildcard characters: False ``` ### -AllowCommonPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowCommonPatterns parameter specifies whether to allow obvious PINs. Examples of obvious PINs include subsets of the telephone number, sequential numbers, or repeated numbers. If set to $false, sequential and repeated numbers and the suffix of the mailbox extension are rejected. If set to $true, only the suffix of the mailbox extension is rejected. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -170,13 +179,15 @@ Accept wildcard characters: False ``` ### -AllowDialPlanSubscribers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowDialPlanSubscribers parameter specifies whether to let subscribers in a dial plan dial a number that resolves to another subscriber within the same dial plan. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -186,13 +197,15 @@ Accept wildcard characters: False ``` ### -AllowedInCountryOrRegionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInCountryOrRegionGroups parameter specifies whether to let subscribers dial the list of in-country/region dial group names. The names that subscribers are allowed to dial must match the group names defined in the UM dial plan. The string is limited to 128 characters. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -202,13 +215,15 @@ Accept wildcard characters: False ``` ### -AllowedInternationalGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInternationalGroups parameter specifies whether to let subscribers dial the list of international dial group names. The names that subscribers dial must match the group names defined in the dial plan. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -218,13 +233,15 @@ Accept wildcard characters: False ``` ### -AllowExtensions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowExtensions parameter specifies whether to let subscribers dial calls to the number of digits specified on the UM dial plan. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -234,13 +251,15 @@ Accept wildcard characters: False ``` ### -AllowFax + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowFax parameter specifies whether users associated with the UM mailbox policy are allowed to receive incoming faxes. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -250,13 +269,15 @@ Accept wildcard characters: False ``` ### -AllowMessageWaitingIndicator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowMessageWaitingIndicator parameter specifies whether users associated with the UM mailbox policy can receive notifications that they've received a new voice mail message. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -266,6 +287,9 @@ Accept wildcard characters: False ``` ### -AllowMissedCallNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowMissedCallNotifications parameter specifies whether missed call notifications are enabled for users associated with the UM mailbox policy. The default value is $true. When you're integrating Unified Messaging and Lync Server or Skype for Business Server, missed call notifications aren't available to users who have mailboxes located on Exchange 2010 Mailbox servers. A missed call notification is generated when a user disconnects before the call is sent to a Mailbox server. @@ -274,7 +298,6 @@ When you're integrating Unified Messaging and Lync Server or Skype for Business Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -284,13 +307,15 @@ Accept wildcard characters: False ``` ### -AllowPinlessVoiceMailAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowPinlessVoiceMailAccess parameter specifies whether users associated with the UM mailbox policy are required to use a PIN to access their voice mail. A PIN is still required to access their email and calendar. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -300,13 +325,15 @@ Accept wildcard characters: False ``` ### -AllowPlayOnPhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowPlayOnPhone parameter specifies whether users associated with the UM mailbox policy can use the Play on Phone feature to listen to voice mail messages. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -316,13 +343,15 @@ Accept wildcard characters: False ``` ### -AllowSMSNotification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowSMSNotification parameter specifies whether UM-enabled users associated with the UM mailbox policy are allowed to get SMS or text messages sent to their mobile phones. If this parameter is set to $true, you also want to set the Set-UMMailbox cmdlet UMSMSNotificationOption parameter for the UM-enabled user to either VoiceMail or VoiceMailAndMissedCalls. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -332,13 +361,15 @@ Accept wildcard characters: False ``` ### -AllowSubscriberAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowSubscriberAccess parameter specifies whether users associated with the UM mailbox policy are allowed subscriber access to their individual mailboxes. If this parameter is set to $true, after users are authenticated, they're able to retrieve voice mail over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -348,13 +379,15 @@ Accept wildcard characters: False ``` ### -AllowTUIAccessToCalendar + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowTUIAccessToCalendar parameter specifies whether users associated with the UM mailbox policy can access their individual calendars over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -364,13 +397,15 @@ Accept wildcard characters: False ``` ### -AllowTUIAccessToDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowTUIAccessToDirectory parameter specifies whether users associated with the UM mailbox policy can access the directory over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -380,13 +415,15 @@ Accept wildcard characters: False ``` ### -AllowTUIAccessToEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowTUIAccessToEmail parameter specifies whether users associated with the UM mailbox policy can access their individual email messages over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -396,13 +433,15 @@ Accept wildcard characters: False ``` ### -AllowTUIAccessToPersonalContacts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowTUIAccessToPersonalContacts parameter specifies whether users associated with the UM mailbox policy can access their personal contacts over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -412,13 +451,15 @@ Accept wildcard characters: False ``` ### -AllowVoiceMailAnalysis -The AllowVoiceMailAnalysis parameter specifies whether a copy of each voice mail left for the users associated with the UM mailbox policy will be forwarded to Microsoft for analysis and improvement of our speech recognition features. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The AllowVoiceMailAnalysis parameter specifies whether a copy of each voice mail is forwarded to Microsoft for analysis and improvement of our speech recognition features. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -428,13 +469,15 @@ Accept wildcard characters: False ``` ### -AllowVoiceMailPreview + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowVoiceMailPreview parameter specifies whether users associated with the UM mailbox policy are able to receive Voice Mail Previews for call-answered messages, or have Voice Mail Previews provided for voice mail messages that they send to other users in their mailbox. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -444,13 +487,15 @@ Accept wildcard characters: False ``` ### -AllowVoiceResponseToOtherMessageTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowVoiceResponseToOtherMessageTypes parameter specifies whether UM-enabled users associated with the UM mailbox policy can record and attach a voice mail message when replying to email messages and calendar items. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -460,6 +505,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -469,7 +517,6 @@ 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 Required: False Position: Named @@ -479,13 +526,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -495,13 +544,15 @@ Accept wildcard characters: False ``` ### -FaxMessageText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The FaxMessageText parameter specifies the text included in the body part of fax messages. This text is limited to 512 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -511,13 +562,15 @@ Accept wildcard characters: False ``` ### -FaxServerURI -The FaxServerURI parameter specifies the Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) for the fax solution that serves the UM-enabled users associated with the UM mailbox policy. This fax product or fax service accepts incoming fax calls that were redirected from Exchange Unified Messaging servers and creates inbound fax messages for the UM-enabled users associated with the UM mailbox policy. Although you can enter more than one fax server URI, only one URI will be used by the Unified Messaging server. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The FaxServerURI parameter specifies the Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) for the fax solution that serves the UM-enabled users associated with the UM mailbox policy. This fax product or fax service accepts incoming fax calls that were redirected from Exchange Unified Messaging servers and creates inbound fax messages for the UM-enabled users associated with the UM mailbox policy. Although you can enter more than one fax server URI, only one URI is used by the Unified Messaging server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -527,13 +580,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -543,13 +598,15 @@ Accept wildcard characters: False ``` ### -InformCallerOfVoiceMailAnalysis -The InformCallerOfVoiceMailAnalysis parameter specifies whether the callers leaving the voice mails will be informed about the possibility of their voice mails being forwarded to Microsoft for analysis. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The InformCallerOfVoiceMailAnalysis parameter specifies whether callers leaving voice mails are informed about the possibility of their voice mails being forwarded to Microsoft for analysis. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -559,13 +616,15 @@ Accept wildcard characters: False ``` ### -LogonFailuresBeforePINReset + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The LogonFailuresBeforePINReset parameter specifies the number of sequential unsuccessful logon attempts before the mailbox PIN is automatically reset. To disable this feature, set this parameter to Unlimited. If this parameter isn't set to Unlimited, it must be set to less than the value of the MaxLogonAttempts parameter. The range is from 0 through 999. The default setting is 5. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -575,13 +634,15 @@ Accept wildcard characters: False ``` ### -MaxGreetingDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MaxGreetingDuration parameter specifies the maximum greeting length. The range is from 1 through 10 minutes. The default value is 5 minutes. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -591,13 +652,15 @@ Accept wildcard characters: False ``` ### -MaxLogonAttempts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MaxLogonAttempts parameter specifies the number of times users can try unsuccessfully to log on, in sequence, before the UM mailboxes are locked. The range is from 1 through 999. The default value is 15. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -607,13 +670,15 @@ Accept wildcard characters: False ``` ### -MinPINLength + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MinPINLength parameter specifies the minimum number of digits required in a PIN for UM-enabled users. The range is from 4 through 24. The default value is 6. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -623,13 +688,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the UM mailbox policy. This setting is limited to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -639,13 +706,15 @@ Accept wildcard characters: False ``` ### -PINHistoryCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PINHistoryCount parameter specifies the number of previous PINs that are remembered and aren't allowed during a PIN reset. This number includes the first time that the PIN was set. The range is from 1 through 20. The default value is 5. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -655,13 +724,15 @@ Accept wildcard characters: False ``` ### -PINLifetime -The PINLifetime parameter specifies the number of days until a new password is required. The range is from 1 through 999. The default value is 60. If you specify Unlimited, the users' PINs won't expire. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +The PINLifetime parameter specifies the number of days until a new password is required. The range is from 1 through 999. The default value is 60. If you specify Unlimited, the PINs don't expire. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -671,13 +742,15 @@ Accept wildcard characters: False ``` ### -ProtectAuthenticatedVoiceMail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ProtectAuthenticatedVoiceMail parameter specifies whether Mailbox servers that answer Outlook Voice Access calls for UM-enabled users associated with the UM mailbox policy create protected voice mail messages. The default setting is None. This means that no protection is applied to voice mail messages. If the value is set to Private, only messages marked as private are protected. If the value is set to All, every voice mail message is protected. ```yaml Type: DRMProtectionOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -687,13 +760,15 @@ Accept wildcard characters: False ``` ### -ProtectedVoiceMailText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ProtectedVoiceMailText parameter specifies the text included in the body part of the protected voice mail messages for UM-enabled users associated with the UM mailbox policy. This text can contain up to 512 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -703,13 +778,15 @@ Accept wildcard characters: False ``` ### -ProtectUnauthenticatedVoiceMail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ProtectUnauthenticatedVoiceMail parameter specifies whether the Mailbox servers that answer calls for UM-enabled users associated with the UM mailbox policy create protected voice mail messages. This also applies when a message is sent from a UM auto attendant to a UM-enabled user associated with the UM mailbox policy. The default setting is None. This means that no protection is applied to voice mail messages. If the value is set to Private, only messages marked as private are protected. If the value is set to All, every voice mail message is protected. ```yaml Type: DRMProtectionOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -719,13 +796,15 @@ Accept wildcard characters: False ``` ### -RequireProtectedPlayOnPhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The RequireProtectedPlayOnPhone parameter specifies whether users associated with the UM mailbox policy can only use Play on Phone for protected voice mail messages or whether users can use multimedia software to play the protected message. The default value is $false. When set to $false, users are able to use both methods to listen to protected voice mail messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -735,13 +814,15 @@ Accept wildcard characters: False ``` ### -ResetPINText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ResetPINText parameter specifies the text to be included in the PIN reset email message. This text is limited to 512 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -751,13 +832,15 @@ Accept wildcard characters: False ``` ### -SourceForestPolicyNames + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SourceForestPolicyNames parameter specifies the name or names of the corresponding UM mailbox policy objects located in the source forest during a cross-forest migration. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -767,13 +850,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan associated with the UM mailbox policy. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -783,13 +868,15 @@ Accept wildcard characters: False ``` ### -UMEnabledText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMEnabledText parameter specifies the text to be included when a user is enabled for Unified Messaging. This text is limited to 512 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -799,13 +886,15 @@ Accept wildcard characters: False ``` ### -VoiceMailPreviewPartnerAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoiceMailPreviewPartnerAddress parameter specifies the SMTP address of a Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is $null. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -815,13 +904,15 @@ Accept wildcard characters: False ``` ### -VoiceMailPreviewPartnerAssignedID + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoiceMailPreviewPartnerAssignedID parameter specifies the identification string, if any, provided to the organization by the Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is $null. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -831,13 +922,15 @@ Accept wildcard characters: False ``` ### -VoiceMailPreviewPartnerMaxDeliveryDelay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoiceMailPreviewPartnerMaxDeliveryDelay parameter specifies the number of seconds that a Mailbox server waits for a Voice Mail Preview partner system to return a message with a Voice Mail Preview. If this time is exceeded, the Mailbox server delivers the voice mail message without a preview. The default value is 1200. The minimum value for this parameter is 300. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -847,13 +940,15 @@ Accept wildcard characters: False ``` ### -VoiceMailPreviewPartnerMaxMessageDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoiceMailPreviewPartnerMaxMessageDuration parameter specifies the maximum duration, in seconds, of voice mail messages sent to the Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is 180. The minimum number for this parameter is 60. This setting should be set equal to the maximum value allowed by the Voice Mail Preview partner. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -863,13 +958,15 @@ Accept wildcard characters: False ``` ### -VoiceMailText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoiceMailText parameter specifies the text to be included in the body part of voice mail messages. The parameter applies to call answering messages in addition to messages originated by an authenticated subscriber. This text is limited to 512 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -879,13 +976,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UmServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMServer.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-UmServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMServer.md index 6fa2f340bf..8a8cb9ca5f 100644 --- a/exchange/exchange-ps/exchange/Set-UmServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umserver applicable: Exchange Server 2010 -title: Set-UmServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umserver +schema: 2.0.0 +title: Set-UMServer --- # Set-UMServer @@ -47,7 +48,7 @@ The Set-UMServer cmdlet sets specific properties on a Unified Messaging server. After this task is completed, the cmdlet sets the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,6 +83,9 @@ This example changes the grammar generation schedule to 02:30-03:00 every day on ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Unified Messaging server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -93,7 +97,6 @@ The Identity parameter specifies the Unified Messaging server that you want to m Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -112,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -122,13 +127,17 @@ Accept wildcard characters: False ``` ### -DialPlans -The DialPlans parameter specifies all the dial plans for which this server will handle UM calls. If no dial plans are defined, the Unified Messaging server won't handle UM calls. + +> Applicable: Exchange Server 2010 + +The DialPlans parameter specifies the dial plans that the server handles UM calls for. You can specify multiple values separated by commas. + +If no dial plans are specified, the Unified Messaging server doesn't handle UM calls. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -ExternalServiceFqdn + +> Applicable: Exchange Server 2010 + The ExternalServiceFqdn parameter is the FQDN or host name of a load balancer servicing Unified Messaging servers. This parameter is useful when you're migrating Unified Messaging servers from within your organization to a Microsoft Exchange Server 2010 hosted environment. The external service host FQDN can contain up to 2,048 characters. ```yaml Type: UMSmartHost Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -170,6 +183,9 @@ Accept wildcard characters: False ``` ### -GrammarGenerationSchedule + +> Applicable: Exchange Server 2010 + The GrammarGenerationSchedule parameter specifies the scheduled times to start speech grammar generation. This parameter allows only one start time per day. The default scheduled time for grammar generation is 02:00-02:30 local time each day. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. @@ -197,7 +213,6 @@ Here are some examples: Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -207,6 +222,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2010 + The IrmLogEnabled parameter specifies whether to enable logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: - $true Enable IRM logging @@ -216,7 +234,6 @@ The IrmLogEnabled parameter specifies whether to enable logging of Information R Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -226,13 +243,15 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2010 + The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter the value as a time span: dd.hh:mm:ss, where d = days, h = hours, m = minutes, and s = seconds. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of the IrmLogMaxAge parameter to 00:00:00 prevents the automatic removal of IRM log files because of their age. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -242,6 +261,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2010 + The IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 megabytes (MB). When you enter a value, qualify the value with one of the following units: - B (bytes) @@ -256,7 +278,6 @@ Unqualified values are treated as bytes. The value of the IrmLogMaxFileSize para Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -266,6 +287,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2010 + The IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: - B (bytes) @@ -280,7 +304,6 @@ Unqualified values are treated as bytes. The value of the IrmLogMaxFileSize para Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -290,13 +313,17 @@ Accept wildcard characters: False ``` ### -IrmLogPath -The IrmLogPath parameter specifies the default IRM log directory location. The default value is C:\\Program Files\\Microsoft\\Exchange Server\\V14. If you set the value of the IrmLogPath parameter to $null, you effectively disable IRM logging. However, if you set the value of the IrmLogPath parameter to $null when the value of the IrmLogEnabled attribute is $true, Exchange will log errors in the Application event log. The preferred way for disabling IRM logging is to set the IrmLogEnabled parameter to $false. + +> Applicable: Exchange Server 2010 + +The IrmLogPath parameter specifies the default IRM log directory location. The default value is %ExchangeInstallPath%IRMLogs. + +If you set the value of this parameter to $null, you effectively disable IRM logging. However, if the value of the IrmLogEnabled parameter is $true, Exchange adds errors to the Application event log. The preferred way to disable IRM logging is to set the IrmLogEnabled parameter to $false. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -306,13 +333,15 @@ Accept wildcard characters: False ``` ### -MaxCallsAllowed + +> Applicable: Exchange Server 2010 + The MaxCallsAllowed parameter specifies the maximum number of concurrent voice calls that the Unified Messaging server allows. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -322,6 +351,9 @@ Accept wildcard characters: False ``` ### -SIPAccessService + +> Applicable: Exchange Server 2010 + The SIPAccessService parameter specifies the FQDN and TCP port of the nearest Lync Server Edge pool or Skype for Business Server Edge pool location for inbound and outbound calls from remote Lync or Skype for Business users located outside of the network. We recommend that you always use this parameter in Lync Server or Skype for Business Server deployments that span multiple geographic regions; otherwise, the Unified Messaging server might select a pool for Real-Time Transport Protocol (RTP) media traffic that isn't the closest geographically to the remote user. @@ -332,7 +364,6 @@ You configure this parameter for each Unified Messaging server so the value iden Type: ProtocolConnectionSettings Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -342,13 +373,15 @@ Accept wildcard characters: False ``` ### -SipTcpListeningPort + +> Applicable: Exchange Server 2010 + The SipTcpListeningPort parameter specifies the TCP port used by the Unified Messaging server to receive incoming calls. This TCP port is used by Unified Messaging servers added to a UM dial plan that isn't configured to use SIP Secured or Secured mode. The default is port 5060. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -358,13 +391,15 @@ Accept wildcard characters: False ``` ### -SipTlsListeningPort + +> Applicable: Exchange Server 2010 + The SipTlsListeningPort parameter specifies the Transport Layer Security (TLS) port used by the Unified Messaging server to receive incoming calls. This TLS port is used by Unified Messaging servers that are added to a UM dial plan configured to use SIP Secured or Secured mode. The default is port 5061. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -374,13 +409,15 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010 + The Status parameter specifies the Unified Messaging server status. The available options are Enabled, Disabled, and NoNewCalls. ```yaml Type: ServerStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -390,13 +427,21 @@ Accept wildcard characters: False ``` ### -UMStartupMode -The UMStartupMode parameter specifies whether the Microsoft Exchange Unified Messaging service on a Unified Messaging server will start up in TCP, TLS, or Dual mode. If the Unified Messaging server is being added to UM dial plans that have different security settings, you should choose Dual mode. In Dual mode, the Unified Messaging server can listen on ports 5060 and 5061 at the same time. If the startup mode is changed, the Microsoft Exchange Unified Messaging service must be restarted. + +> Applicable: Exchange Server 2010 + +The UMStartupMode parameter specifies the startup mode for the Microsoft Exchange Unified Messaging service on an Exchange server. Valid values are: + +- TCP +- TLS +- Dual: Use this value to add the Unified Messaging server to UM dial plans with different security settings. The Unified Messaging server can listen on ports 5060 and 5061 at the same time. + +If you change the startup mode, you need to restart the Microsoft Exchange Unified Messaging service. ```yaml Type: UMStartupMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -406,13 +451,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMService.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMService.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-UMService.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMService.md index 51772cc547..6ae35474ca 100644 --- a/exchange/exchange-ps/exchange/Set-UMService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umservice applicable: Exchange Server 2013, Exchange Server 2016 -title: Set-UMService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umservice +schema: 2.0.0 +title: Set-UMService --- # Set-UMService @@ -42,7 +43,7 @@ Set-UMService [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,6 +79,9 @@ This example performs the following actions: ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the Mailbox server that hosts the Unified Messaging service configuration you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -89,7 +93,6 @@ The Identity parameter specifies the Mailbox server that hosts the Unified Messa Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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`. @@ -108,7 +114,6 @@ 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 Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -DialPlans + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DialPlans parameter specifies all dial plans that the Unified Messaging service handles incoming calls for. Exchange 2016 and Exchange 2013 servers can't be associated with a TelExt or E.164 UM dial plan, but can be associated or added to SIP dial plans. If you're integrating Unified Messaging with Lync Server 2010, Lync Server 2013, or Skype for Business Server 2015, you need to associate or add all Exchange 2016 and Exchange 2013 servers to SIP dial plans. @@ -132,7 +140,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -142,13 +149,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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 Required: False Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -GrammarGenerationSchedule + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The GrammarGenerationSchedule parameter specifies the scheduled times to start speech grammar generation. This parameter allows only one start time per day. The default scheduled time for grammar generation is 02:00-02:30 local time each day. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. @@ -185,7 +197,6 @@ Here are some examples: Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -195,17 +206,19 @@ Accept wildcard characters: False ``` ### -IPAddressFamily -The IPAddressFamily parameter specifies whether the UM IP gateway will use IPv4, IPv6, or both to communicate. Valid values are: -- IPv4 -- IPv6 -- Any: IPv6 is used first and if necessary, the UM IP gateway falls back to IPv4. This is the default value. +> Applicable: Exchange Server 2013, Exchange Server 2016 + +The IPAddressFamily parameter specifies the Internet Protocol (IP) version to use. Valid values are: + +- IPv4Only: The UM IP gateway uses only IPv4 to communicate. +- IPv6Only: The UM IP gateway uses only IPv6. +- Any: IPv6 is used first. If IPv6 isn't available, IPV4 is used. This value is the default. ```yaml Type: IPAddressFamily Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -215,13 +228,15 @@ Accept wildcard characters: False ``` ### -IPAddressFamilyConfigurable + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IPAddressFamilyConfigurable parameter specifies whether you're able to set the IPAddressFamily parameter to IPv6Only or Any. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IrmLogEnabled parameter specifies whether to enable logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Valid values are: - $true: Enable IRM logging @@ -240,7 +258,6 @@ The IrmLogEnabled parameter specifies whether to enable logging of Information R Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -250,6 +267,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -260,7 +280,6 @@ The valid input range for this parameter is from 00:00:00 through 24855.03:14:07 Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -270,6 +289,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 megabytes (MB). When you enter a value, qualify the value with one of the following units: @@ -280,7 +302,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the connectivity log directory. @@ -288,7 +310,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -298,6 +319,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -308,7 +332,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. The value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the IRM log files. @@ -316,7 +340,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -326,15 +349,17 @@ Accept wildcard characters: False ``` ### -IrmLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IrmLogPath parameter specifies the default IRM log directory location. The default location is %ExchangeInstallPath%IRMLogs. -If you set the value of this parameter to $null, you effectively disable IRM logging. However, setting this parameter to $null when the value of the IrmLogEnabled parameter is $true, generates errors in the Application event log. The preferred way to disable IRM logging is to set the IrmLogEnabled parameter to $false. +If you set the value of this parameter to $null, you effectively disable IRM logging. However, if the value of the IrmLogEnabled parameter is $true, Exchange adds errors to the Application event log. The preferred way to disable IRM logging is to set the IrmLogEnabled parameter to $false. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -344,13 +369,15 @@ Accept wildcard characters: False ``` ### -MaxCallsAllowed + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The MaxCallsAllowed parameter specifies the maximum number of concurrent voice calls that the Unified Messaging service allows. The default value is 100. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -360,6 +387,9 @@ Accept wildcard characters: False ``` ### -SIPAccessService + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The SIPAccessService parameter specifies the FQDN and TCP port of the nearest Lync Server Front End pool or Skype for Business Server Front End pool location for inbound and outbound calls from remote Lync or Skype for Business users located outside of the network. We recommend that you always use this parameter in Lync Server or Skype for Business Server deployments that span multiple geographic regions; otherwise, the Microsoft Exchange Unified Messaging service might select a pool for Real-Time Transport Protocol (RTP) media traffic that isn't the closest geographically to the remote user. @@ -370,7 +400,6 @@ You configure this parameter for each instance of the Unified Messaging service Type: ProtocolConnectionSettings Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -380,13 +409,15 @@ Accept wildcard characters: False ``` ### -Status -This parameter has been deprecated and is no longer used. + +> Applicable: Exchange Server 2013, Exchange Server 2016 + +This parameter is deprecated and no longer used. ```yaml Type: ServerStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -396,9 +427,12 @@ Accept wildcard characters: False ``` ### -UMStartupMode + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The UMStartupMode parameter specifies the startup mode for the Unified Messaging service. Valid values are: -- TCP (This is the default value) +- TCP (default value) - TLS - Dual: The service can listen on ports 5060 and 5061 at the same time. If you add the Exchange server to UM dial plans that have different security settings, you should use this value. @@ -408,7 +442,6 @@ If you change the value of this parameter, you need to restart the Unified Messa Type: UMStartupMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -418,13 +451,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-UnifiedAuditLogRetentionPolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UnifiedAuditLogRetentionPolicy.md index b54bb64a99..1c7e08d02d 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UnifiedAuditLogRetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-unifiedauditlogretentionpolicy applicable: Security & Compliance -title: Set-UnifiedAuditLogRetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-unifiedauditlogretentionpolicy +schema: 2.0.0 +title: Set-UnifiedAuditLogRetentionPolicy --- # Set-UnifiedAuditLogRetentionPolicy @@ -50,11 +51,14 @@ This example adds the AeD (for eDiscovery Premium events) record type to the pol Set-UnifiedAuditLogRetentionPolicy -Name "SearchQueryPerformed by app@sharepoint" -Operations SearchQueryPerformed,FileAccessed -UserIds $null -RetentionDuration SixMonths -Priority 10000 ``` -This example modifies an audit log retention policy and changes to retention duration to six months, adds an additional activity to the Operations parameter, and removes all values from the UserId property so that the policy will apply to all users. +This example modifies an audit log retention policy and changes to retention duration to six months, adds an additional activity to the Operations parameter, and removes all values from the UserId property so the policy applies to all users. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the unified audit log retention policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the unified audit log retention policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A higher integer value indicates a lower priority. The value 1 is the highest priority, and the value 10000 is the lowest priority. No two policies can have the same priority value. This parameter is required when you modify an audit log retention policy, and you must use a unique priority value. @@ -83,7 +89,6 @@ This parameter is required when you modify an audit log retention policy, and yo Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies how long audit log records are kept. Valid values are: - ThreeMonths @@ -108,7 +116,6 @@ Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears -Applicable: Security & Compliance Required: True Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -127,7 +137,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -137,13 +146,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the audit log retention policy. The maximum length is 256 characters. 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 @@ -153,7 +164,10 @@ Accept wildcard characters: False ``` ### -Operations -The Operations parameter specifies the audit log operations that are retained by the policy. The values you specify will overwrite any existing entries. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). + +> Applicable: Security & Compliance + +The Operations parameter specifies the audit log operations that are retained by the policy. The values you specify overwrite any existing entries. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -161,7 +175,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -171,15 +184,17 @@ Accept wildcard characters: False ``` ### -RecordTypes + +> Applicable: Security & Compliance + The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). -You can specify multiple values separated by commas. The values you specify will overwrite any existing entries. +You can specify multiple values separated by commas. The values you specify overwrite any existing entries. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -189,7 +204,10 @@ Accept wildcard characters: False ``` ### -UserIds -The UserIds parameter specifies the audit logs that are retained by the policy based on the ID of the user who performed the action. The values you specify will overwrite any existing entries. + +> Applicable: Security & Compliance + +The UserIds parameter specifies the audit logs that are retained by the policy based on the ID of the user who performed the action. The values you specify overwrite any existing entries. 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"`. @@ -197,7 +215,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -207,13 +224,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md b/exchange/exchange-ps/ExchangePowerShell/Set-UnifiedGroup.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-UnifiedGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UnifiedGroup.md index df94654699..561eb31f90 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UnifiedGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-unifiedgroup applicable: Exchange Online, Exchange Online Protection -title: Set-UnifiedGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-unifiedgroup +schema: 2.0.0 +title: Set-UnifiedGroup --- # Set-UnifiedGroup @@ -88,7 +89,7 @@ Microsoft 365 Groups are group objects that are available across Microsoft 365 s > [!NOTE] > You can't change the HiddenGroupMembershipEnabled setting on an existing Microsoft 365 Group. The setting is available only during new group creation. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -112,6 +113,9 @@ This example changes the Microsoft 365 Group named Legal Department from a publi ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to modify. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -125,7 +129,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to modify Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -135,6 +138,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -156,7 +162,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -166,6 +171,9 @@ Accept wildcard characters: False ``` ### -AccessType + +> Applicable: Exchange Online, Exchange Online Protection + The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Valid values are: - Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. @@ -177,7 +185,6 @@ The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Type: ModernGroupTypeInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,6 +194,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Microsoft 365 Group. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -200,7 +210,6 @@ The Alias value can contain letters, numbers and the following characters: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,10 +219,13 @@ Accept wildcard characters: False ``` ### -AlwaysSubscribeMembersToCalendarEvents + +> Applicable: Exchange Online, Exchange Online Protection + The AlwaysSubscribeMembersToCalendarEvents switch controls the default subscription settings of new members that are added to the Microsoft 365 Group. Changing this setting doesn't affect existing group members. -- If you use this switch without a value, all future members that are added to the group will have their subscriptions set to ReplyAndEvents. Previous events are not automatically added to their calendars. -- If you use this exact syntax: `-AlwaysSubscribeMembersToCalendarEvents:$false,` all future members that are added to the group will have their subscriptions set to ReplyOnly. +- If you use this switch without a value, all future members added to the group have their subscriptions set to ReplyAndEvents. Previous events are not automatically added to their calendars. +- If you use this exact syntax: `-AlwaysSubscribeMembersToCalendarEvents:$false,` all future members added to the group have their subscriptions set to ReplyOnly. Group members can change their own subscription settings, which can override your intended use of this switch. @@ -225,7 +237,6 @@ The AutoSubscribeNewMembers switch overrides this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -235,6 +246,9 @@ Accept wildcard characters: False ``` ### -AuditLogAgeLimit + +> Applicable: Exchange Online, Exchange Online Protection + The AuditLogAgeLimit parameter specifies the maximum age of audit log entries for the Microsoft 365 Group. Log entries older than the specified value are removed. The default value is 90 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -245,7 +259,6 @@ For example, to specify 60 days for this parameter, use 60.00:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,6 +268,9 @@ Accept wildcard characters: False ``` ### -AutoSubscribeNewMembers + +> Applicable: Exchange Online, Exchange Online Protection + The AutoSubscribeNewMembers switch specifies whether to automatically subscribe new members that are added to the Microsoft 365 Group to conversations and calendar events. Only users that are added to the group after you enable this setting are automatically subscribed to the group. - To subscribe new members to conversations and calendar events, use the AutoSubscribeNewMembers switch without a value. @@ -266,7 +282,6 @@ The AutoSubscribeNewMembers switch specifies whether to automatically subscribe Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -276,6 +291,9 @@ Accept wildcard characters: False ``` ### -CalendarMemberReadOnly + +> Applicable: Exchange Online, Exchange Online Protection + The CalendarMemberReadOnly switch specifies whether to set read-only Calendar permissions to the Microsoft 365 Group for members of the group. - To set read-only Calendar permissions, use the CalendarMemberReadOnly switch without a value. @@ -287,7 +305,6 @@ To view the current value of the CalendarMemberReadOnly property on a Microsoft Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -297,13 +314,15 @@ Accept wildcard characters: False ``` ### -Classification + +> Applicable: Exchange Online, Exchange Online Protection + The Classification parameter specifies the classification for the Microsoft 365 Group. You need to configure the list of available classifications in Microsoft Entra ID before you can specify a value for this parameter. For more information, see [Microsoft Entra cmdlets for configuring group settings](https://learn.microsoft.com/azure/active-directory/users-groups-roles/groups-settings-cmdlets). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,6 +332,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -322,7 +344,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -332,6 +353,9 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorsEnabled specifies whether to enable the ability to use connectors for the Microsoft 365 Group. - To enable connectors, use the ConnectorsEnabled switch without a value. @@ -345,7 +369,6 @@ For more information about connectors for Microsoft 365 Groups, see [Connect app Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -355,13 +378,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -371,13 +396,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -387,13 +414,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -403,13 +432,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -419,13 +450,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -435,13 +468,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -451,13 +486,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -467,13 +504,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -483,13 +522,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -499,13 +540,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -515,13 +558,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -531,13 +576,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -547,13 +594,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -563,13 +612,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -579,13 +630,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -595,6 +648,9 @@ Accept wildcard characters: False ``` ### -DataEncryptionPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The DataEncryptionPolicy parameter specifies the data encryption policy that's applied to the Microsoft 365 Group. You can use any value that uniquely identifies the policy. For example: - Name @@ -607,7 +663,6 @@ To remove an existing policy, use the value $null. Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -617,13 +672,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the name of the Microsoft 365 Group. The display name is visible in the Exchange admin center, address lists, and Outlook. 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: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -633,13 +690,16 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the Microsoft 365 Group, including the primary SMTP address. In cloud-based organizations, the primary SMTP address and other proxy addresses for Microsoft 365 Groups are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the Microsoft 365 Group. Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. -- SPO: SharePoint Online email address. +- SPO: SharePoint email address. If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. @@ -657,7 +717,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -667,6 +726,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. @@ -677,7 +739,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -687,6 +748,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. @@ -697,7 +761,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -707,6 +770,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. @@ -717,7 +783,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -727,6 +792,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. @@ -737,7 +805,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -747,6 +814,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that 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: `"Value","Value2",..."ValueN"`. @@ -757,7 +827,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -767,13 +836,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -783,6 +854,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Online, Exchange Online Protection + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this Microsoft 365 Group. Although messages that are sent on behalf of the group clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the group, not the sender. The sender you specify for this parameter must 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 sender. For example: @@ -808,7 +882,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -818,16 +891,18 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The HiddenFromAddressListsEnabled parameter specifies whether the Microsoft 365 Group appears in the global address list (GAL) and other address lists in your organization. Valid values are: -- $true: The Microsoft 365 Group is hidden from the GAL and other address lists. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users also can't find the group by using the Discover option in Outlook on the web. For users that are members of the Microsoft 365 Group, the group will still appear in the navigation pane in Outlook and Outlook on the web if HiddenFromExchangeClientsEnabled property is **NOT** enabled. +- $true: The Microsoft 365 Group is hidden from the GAL and other address lists. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users also can't find the group by using the Discover option in Outlook on the web. For users that are members of the Microsoft 365 Group, the group still appears in the navigation pane in Outlook and Outlook on the web if HiddenFromExchangeClientsEnabled property is **NOT** enabled. - $false: The Microsoft 365 Group is visible in the GAL and other address lists. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -837,17 +912,19 @@ Accept wildcard characters: False ``` ### -HiddenFromExchangeClientsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The HiddenFromExchangeClientsEnabled switch specifies whether the Microsoft 365 Group is hidden from Outlook clients connected to Microsoft 365. - To enable this setting, you don't need to specify a value with this switch. The Microsoft 365 Group is hidden from Outlook experiences. The group isn't visible in the Outlook left-hand navigation and isn't visible in the global address list (GAL). The group name doesn't resolve during the creation of a new message in Outlook. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users can't find the group by using the Discover option in Outlook on the web. The HiddenFromAddressListsEnabled property is set to the value True to prevent the group from showing in the GAL and in the Offline Address Book (OAB). -- To disable this setting, use this exact syntax: `-HiddenFromExchangeClientsEnabled:$false`. The Microsoft 365 Group isn't hidden from Outlook experiences. The group will be visible in the GAL and other address lists. This is the default value. +- To disable this setting, use this exact syntax: `-HiddenFromExchangeClientsEnabled:$false`. The Microsoft 365 Group isn't hidden from Outlook experiences. The group is visible in the GAL and other address lists. This value is the default. - If Microsoft 365 Groups are hidden from Exchange clients, users don't see the option to subscribe or unsubscribe to a Microsoft 365 Group. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -857,6 +934,9 @@ Accept wildcard characters: False ``` ### -InformationBarrierMode + +> Applicable: Exchange Online, Exchange Online Protection + The InformationBarrierMode parameter specifies the information barrier mode for the Microsoft 365 Group. Valid values are: - Explicit @@ -868,7 +948,6 @@ The InformationBarrierMode parameter specifies the information barrier mode for Type: GroupInformationBarrierMode Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -878,13 +957,15 @@ Accept wildcard characters: False ``` ### -IsMemberAllowedToEditContent + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill IsMemberAllowedToEditContent Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -894,6 +975,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Online, Exchange Online Protection + The Language parameter specifies language preference for the Microsoft 365 Group. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -902,7 +986,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -912,13 +995,15 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online, Exchange Online Protection + The MailboxRegion parameter specifies the preferred data location (PDL) for the Microsoft 365 Group in multi-geo environments. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -928,6 +1013,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Online, Exchange Online Protection + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -939,7 +1027,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -949,6 +1036,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Online, Exchange Online Protection + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -963,7 +1053,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -973,6 +1062,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Online, Exchange Online Protection + The MaxReceiveSize parameter specifies the maximum size of an email message that can be sent to this group. Messages that exceed the maximum size are rejected by the group. When you enter a value, qualify the value with one of the following units: @@ -982,7 +1074,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -992,7 +1084,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1002,6 +1093,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Online, Exchange Online Protection + The MaxSendSize parameter specifies the maximum size of an email message that can be sent by this group. When you enter a value, qualify the value with one of the following units: @@ -1011,7 +1105,7 @@ When you enter a value, qualify the value with one of the following units: - MB (megabytes) - GB (gigabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values might be rounded up to the nearest kilobyte. A valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited, which indicates the maximum size is imposed elsewhere (for example, organization, server, or connector limits). @@ -1021,7 +1115,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1031,6 +1124,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1048,7 +1144,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1058,10 +1153,13 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. -- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value. +- $false: Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This value is the default. You use the ModeratedBy parameter to specify the moderators. @@ -1069,7 +1167,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1079,13 +1176,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Online, Exchange Online Protection + The Notes parameter specifies the description of the Microsoft 365 Group. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1095,13 +1194,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1111,6 +1212,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Online, Exchange Online Protection + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1136,7 +1240,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1146,6 +1249,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1155,7 +1261,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1165,6 +1270,9 @@ Accept wildcard characters: False ``` ### -SensitivityLabelId + +> Applicable: Exchange Online, Exchange Online Protection + The SensitivityLabelId parameter specifies the GUID value of the sensitivity label that's assigned to the Microsoft 365 Group. **Note**: In the output of the Get-UnifiedGroup cmdlet, this property is named SensitivityLabel, not SensitivityLabelId. @@ -1173,7 +1281,6 @@ The SensitivityLabelId parameter specifies the GUID value of the sensitivity lab Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1183,12 +1290,15 @@ Accept wildcard characters: False ``` ### -SubscriptionEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SubscriptionEnabled switch specifies whether the group owners can enable subscription to conversations and calendar events on the groups they own. This option can be set only in Exchange Online PowerShell. - To change the value to $true, use this switch without a value. - To change the value to $false, use this exact syntax: `-SubscriptionEnabled:$false`. The value of the AutoSubscribeNewMembers parameter must also be $false before you can use the value $false for this switch. -**Note**: You should use the value $false for this switch only if you intend to disable group owner ability to change subscription options on the group. Group owners will not be able to enable subscription options on the group settings using Outlook on the web or Outlook desktop. Group owners might see the error, "The group update is in progress" error when they try to enable Subscription option. Admins trying to enable Subscription from Microsoft admin center might also see error, "Can't save 'Send copies of group conversations and events to group member's inboxes' Either your assigned product license doesn't include Exchange Online or you have recently created this group and it's still not ready for management". +**Note**: Use the value $false for this switch only to prevent group owners from changing subscription options on the group. When the value is $false, group owners can't enable subscription options on the group settings using Outlook on the web or Outlook desktop. Group owners might see the error, "The group update is in progress" error when they try to enable Subscription option. Admins trying to enable Subscription from Microsoft admin center might also see error, "Can't save 'Send copies of group conversations and events to group member's inboxes' Either your assigned product license doesn't include Exchange Online or you have recently created this group and it's still not ready for management". **Note**: This property is evaluated only when you add internal members from your organization. Guest user accounts are always subscribed when added as a member. You can manually remove subscriptions for guest users by using the Remove-UnifiedGroupLinks cmdlet. @@ -1196,7 +1306,6 @@ The SubscriptionEnabled switch specifies whether the group owners can enable sub Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1206,6 +1315,9 @@ Accept wildcard characters: False ``` ### -UnifiedGroupWelcomeMessageEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The UnifiedGroupWelcomeMessageEnabled switch specifies whether to enable or disable sending system-generated welcome messages to users who are added as members to the Microsoft 365 Group. - To enable this setting, you don't need to specify a value with this switch. @@ -1219,7 +1331,6 @@ This setting is enabled by default. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1229,13 +1340,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-User.md b/exchange/exchange-ps/ExchangePowerShell/Set-User.md similarity index 77% rename from exchange/exchange-ps/exchange/Set-User.md rename to exchange/exchange-ps/ExchangePowerShell/Set-User.md index 09606906d6..262220b5ea 100644 --- a/exchange/exchange-ps/exchange/Set-User.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-User.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-user -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-User -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-user +schema: 2.0.0 +title: Set-User --- # Set-User ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Set-User cmdlet to modify user attributes. You can use this cmdlet to modify all objects that have user accounts (for example, user mailboxes, mail users, and user accounts). @@ -95,7 +96,7 @@ Set-User [-Identity] ## DESCRIPTION The Set-User cmdlet contains no mail-related properties for mailboxes or mail users. To modify the mail-related properties for a user, you need to use the corresponding cmdlet based on the object type (for example, Set-Mailbox or Set-MailUser). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,6 +119,9 @@ Performing this procedure on a linked mailbox removes all permissions on the mai ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the user that you want to modify. You can use any value that uniquely identifies the user. For example: - Name @@ -131,7 +135,6 @@ The Identity parameter specifies the user that you want to modify. You can use a Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -141,6 +144,9 @@ Accept wildcard characters: False ``` ### -AllowUMCallsFromNonUsers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user from Unified Messaging directory searches. @@ -149,7 +155,6 @@ The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user fro Type: AllowUMCallsFromNonUsersFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +164,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Arbitration switch is required to modify arbitration mailboxes. You don't need to specify a value with this switch. @@ -169,7 +177,6 @@ Arbitration mailboxes are system mailboxes that are used for storing different t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -179,13 +186,15 @@ Accept wildcard characters: False ``` ### -AssistantName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AssistantName parameter specifies the name of the user's assistant. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -195,6 +204,9 @@ Accept wildcard characters: False ``` ### -AuthenticationPolicy + +> Applicable: Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AuthenticationPolicy parameter specifies the authentication policy to apply to the user. You can use any value that uniquely identifies the policy. For example: - Name @@ -209,7 +221,6 @@ You create authentication policies with the New-AuthenticationPolicy cmdlet to b Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,6 +230,9 @@ Accept wildcard characters: False ``` ### -BlockCloudCache + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill BlockCloudCache Description }} @@ -227,7 +241,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -237,6 +250,9 @@ Accept wildcard characters: False ``` ### -CanHaveCloudCache + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill CanHaveCloudCache Description }} @@ -245,7 +261,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,6 +270,9 @@ Accept wildcard characters: False ``` ### -CertificateSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CertificateSubject parameter specifies the value of the subject field of the user's digital certificate. @@ -263,7 +281,6 @@ The CertificateSubject parameter specifies the value of the subject field of the Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,13 +290,15 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The City parameter specifies the user's city. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -289,6 +308,9 @@ Accept wildcard characters: False ``` ### -ClearDataEncryptionPolicy + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill ClearDataEncryptionPolicy Description }} @@ -297,7 +319,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,13 +328,15 @@ Accept wildcard characters: False ``` ### -Company + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Company parameter specifies the user's company. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,6 +346,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -332,7 +358,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -342,6 +367,9 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The CountryOrRegion parameter specifies the user's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name). A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). @@ -352,7 +380,6 @@ The friendly name is returned in the CountryOrRegion property value by the Get-U Type: CountryInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -362,18 +389,20 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: -- $true: A DTMF map is created for the recipient. This is the default value. +- $true: A DTMF map is created for the recipient. This value is the default. - $false: A DTMF map isn't created for the recipient. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -383,13 +412,15 @@ Accept wildcard characters: False ``` ### -Department + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Department parameter specifies the user's department. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -399,6 +430,9 @@ Accept wildcard characters: False ``` ### -DesiredWorkloads + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill DesiredWorkloads Description }} @@ -407,7 +441,6 @@ This parameter is available only in the cloud-based service. Type: Microsoft.Exchange.Data.MailboxWorkloadFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -417,13 +450,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the user. The display name is visible in the Exchange admin center and in Active Directory. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -433,6 +468,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -441,7 +479,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -451,6 +488,9 @@ Accept wildcard characters: False ``` ### -EXOModuleEnabled + +> Applicable: Exchange Online, Exchange Online Protection + 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: @@ -466,7 +506,6 @@ The default value depends on the management roles that are assigned to the user. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -476,13 +515,15 @@ Accept wildcard characters: False ``` ### -Fax + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Fax parameter specifies the user's fax number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -492,13 +533,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,6 +551,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -518,7 +564,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -528,6 +573,9 @@ Accept wildcard characters: False ``` ### -GeoCoordinates + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The GeoCoordinates parameter specifies the user's location in latitude, longitude and (optionally) altitude coordinates. A valid value for this parameter uses one of the following formats: - Latitude and longitude: For example, "47.644125;-122.122411" @@ -539,7 +587,6 @@ The GeoCoordinates parameter specifies the user's location in latitude, longitud Type: GeoCoordinates Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -549,13 +596,15 @@ Accept wildcard characters: False ``` ### -HomePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The HomePhone parameter specifies the user's home telephone number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -565,6 +614,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -578,7 +630,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -588,13 +639,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -604,6 +657,9 @@ Accept wildcard characters: False ``` ### -IsShadowMailbox + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill IsShadowMailbox Description }} @@ -612,7 +668,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -622,13 +677,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -638,6 +695,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. @@ -650,7 +710,6 @@ You can only use the LinkedCredential parameter with a linked user. Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -660,6 +719,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if this user is a linked user. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter. @@ -670,7 +732,6 @@ This parameter is required only if you're connecting a linked user. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -680,6 +741,9 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if this user is a linked user. The master account is the account to which the user links. The master account grants access to the user. You can use one of the following values: @@ -693,7 +757,7 @@ The LinkedMasterAccount parameter specifies the master account in the forest whe - Alias - $null -If you set this parameter's value to $null, you will unlink the account and convert the linked mailbox into a non-linked user mailbox. The mailbox won't retain the permissions previously set on it such as Send As, full access, folder, and calendar delegation. +If you set this parameter's value to $null, you unlink the account and convert the linked mailbox into a non-linked user mailbox. The mailbox doesn't retain the permissions previously set on it (for example, Send As, Full Access, folder permissions, and calendar delegation). This parameter is required only if you're connecting a linked user. @@ -701,7 +765,6 @@ This parameter is required only if you're connecting a linked user. Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -711,6 +774,9 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MailboxRegion Description }} @@ -719,7 +785,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -729,6 +794,9 @@ Accept wildcard characters: False ``` ### -MailboxRegionSuffix + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MailboxRegionSuffix Description }} @@ -737,7 +805,6 @@ This parameter is available only in the cloud-based service. Type: MailboxRegionSuffixValue Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -747,6 +814,9 @@ Accept wildcard characters: False ``` ### -ManagedOnboardingType + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill ManagedOnboardingType Description }} @@ -755,7 +825,6 @@ This parameter is available only in the cloud-based service. Type: ManagedOnboardingType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -765,13 +834,15 @@ Accept wildcard characters: False ``` ### -Manager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Manager parameter specifies the user's manager. ```yaml Type: UserContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -781,6 +852,9 @@ Accept wildcard characters: False ``` ### -MobilePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The MobilePhone parameter specifies the user's primary mobile phone number. **Note**: In Exchange Online, you can't use this parameter. Instead, use the MobilePhone parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. @@ -789,7 +863,6 @@ The MobilePhone parameter specifies the user's primary mobile phone number. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -799,13 +872,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the user. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -815,13 +890,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -831,13 +908,15 @@ Accept wildcard characters: False ``` ### -Office + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Office parameter specifies the user's physical office name or number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -847,13 +926,15 @@ Accept wildcard characters: False ``` ### -OtherFax + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OtherFax parameter specifies the user's alternative fax number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -863,13 +944,15 @@ Accept wildcard characters: False ``` ### -OtherHomePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OtherHomePhone parameter specifies the user's alternative home telephone number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -879,13 +962,15 @@ Accept wildcard characters: False ``` ### -OtherTelephone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OtherTelephone parameter specifies the user's alternative telephone number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -895,13 +980,15 @@ Accept wildcard characters: False ``` ### -Pager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Pager parameter specifies the user's pager number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -911,6 +998,9 @@ Accept wildcard characters: False ``` ### -PermanentlyClearPreviousMailboxInfo + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is functional only in the cloud-based service. The PermanentlyClearPreviousMailboxInfo switch specifies whether to clear the Exchange Online mailbox attributes on a user. You don't need to specify a value with this switch. @@ -923,7 +1013,6 @@ Clearing these attributes might be required in mailbox move and re-licensing sce Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -933,6 +1022,9 @@ Accept wildcard characters: False ``` ### -Phone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Phone parameter specifies the user's office telephone number. **Note**: In Exchange Online, you can't use this parameter. Instead, use the BusinessPhones parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. @@ -941,7 +1033,6 @@ The Phone parameter specifies the user's office telephone number. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -951,13 +1042,15 @@ Accept wildcard characters: False ``` ### -PhoneticDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -967,13 +1060,15 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PostalCode parameter specifies the user's zip code or postal code. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -983,13 +1078,15 @@ Accept wildcard characters: False ``` ### -PostOfficeBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PostOfficeBox parameter specifies the user's post office box number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -999,6 +1096,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The PublicFolder switch is required to modify public folder mailboxes. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -1007,7 +1107,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1017,6 +1116,9 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + **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: @@ -1034,7 +1136,6 @@ A user's experience in any of these management interfaces is still controlled by Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1044,6 +1145,9 @@ Accept wildcard characters: False ``` ### -RemoveMailboxProvisioningConstraint + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1052,7 +1156,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1062,16 +1165,18 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The ResetPasswordOnNextLogon parameter specifies whether the user must change their password the next time they log on. Valid values are: - $true: The user is required to change their password the next time they log on. -- $false: The user isn't required to change their password the next time they log on. This is the default value. +- $false: The user isn't required to change their password the next time they log on. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1081,15 +1186,17 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters might generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1099,13 +1206,15 @@ Accept wildcard characters: False ``` ### -SeniorityIndex -The SeniorityIndex parameter specifies the order in which this user will display in a hierarchical address book. A user with a value of 2 will display higher in an address book than a user with a value of 1. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + +The SeniorityIndex parameter specifies the order in which this user is displayed in a hierarchical address book. A user with a value of 2 is displayed higher in an address book than a user with a value of 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1115,6 +1224,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -1127,7 +1239,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1137,6 +1248,9 @@ Accept wildcard characters: False ``` ### -SkipDualWrite + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1145,7 +1259,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1155,13 +1268,15 @@ Accept wildcard characters: False ``` ### -StateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The StateOrProvince parameter specifies the user's state or province. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1171,13 +1286,15 @@ Accept wildcard characters: False ``` ### -StreetAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The StreetAddress parameter specifies the user's physical address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1187,6 +1304,9 @@ Accept wildcard characters: False ``` ### -StsRefreshTokensValidFrom + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -1197,7 +1317,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1207,6 +1326,9 @@ Accept wildcard characters: False ``` ### -TelephoneAssistant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The TelephoneAssistant parameter specifies the telephone number of the user's assistant. @@ -1215,7 +1337,6 @@ The TelephoneAssistant parameter specifies the telephone number of the user's as Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1225,13 +1346,15 @@ Accept wildcard characters: False ``` ### -Title + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Title parameter specifies the user's title. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1241,15 +1364,17 @@ Accept wildcard characters: False ``` ### -UMCallingLineIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The UMCallingLineIds parameter specifies telephone numbers or extensions that can be mapped to a Unified Messaging (UM)-enabled user. You can specify more than one telephone number for each user, separated by a comma. This parameter accepts digits less than 128 characters in length and may include an optional plus sign (+) preceding the numbers. Each UM-enabled user must have a unique UMCallingLineIds parameter value. +The UMCallingLineIds parameter specifies telephone numbers or extensions that can be mapped to a Unified Messaging (UM)-enabled user. You can specify more than one telephone number for each user, separated by a comma. This parameter accepts digits less than 128 characters in length and might include an optional plus sign (+) preceding the numbers. Each UM-enabled user must have a unique UMCallingLineIds parameter value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1259,6 +1384,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -1279,7 +1407,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1289,6 +1416,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. @@ -1297,7 +1427,6 @@ The UserPrincipalName parameter specifies the logon name for the user account. T Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1307,6 +1436,9 @@ Accept wildcard characters: False ``` ### -VIP + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The VIP parameter specifies whether the user is a priority account. Valid values are: @@ -1320,7 +1452,6 @@ For more information about priority accounts, see [Manage and monitor priority a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1330,13 +1461,15 @@ Accept wildcard characters: False ``` ### -WebPage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WebPage parameter specifies the user's Web page. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1346,13 +1479,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1362,6 +1497,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -1373,7 +1511,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-UserBriefingConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-UserBriefingConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UserBriefingConfig.md index d036882c11..d27da2058d 100644 --- a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UserBriefingConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-userbriefingconfig applicable: Exchange Online -title: Set-UserBriefingConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-userbriefingconfig +schema: 2.0.0 +title: Set-UserBriefingConfig --- # Set-UserBriefingConfig @@ -53,13 +54,15 @@ This example enables the Briefing email for lila@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user that you want to modify (for example, lila@contoso.onmicrosoft.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -69,16 +72,18 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether to enable or disable the Briefing email for a specified user's mailbox. Valid values are: - $true: The daily briefing message is enabled. -- $false: The daily briefing message is disabled. This is the default value. +- $false: The daily briefing message is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UserPhoto.md b/exchange/exchange-ps/ExchangePowerShell/Set-UserPhoto.md similarity index 77% rename from exchange/exchange-ps/exchange/Set-UserPhoto.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UserPhoto.md index d2c06bedea..b9c4c20062 100644 --- a/exchange/exchange-ps/exchange/Set-UserPhoto.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UserPhoto.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-userphoto -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-UserPhoto -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-userphoto +schema: 2.0.0 +title: Set-UserPhoto --- # Set-UserPhoto @@ -95,11 +96,11 @@ Set-UserPhoto [-Identity] ## DESCRIPTION The user photos feature allows users to associate a picture with their account. User photos are stored in the user's Active Directory account and in the root directory of the user's Exchange mailbox. Administrators use the Set-UserPhoto cmdlet to configure user photos. Users can upload, preview, and save a user photo to their account in the Options page in Outlook on the web. When a user uploads a photo, a preview of the photo is displayed on the Options page in Outlook on the web. This is the preview state, and creates the same result as running the Set-UserPhoto cmdlet using the Preview parameter. If the user clicks Save, the preview photo is saved as the user's photo. This is the same result as running the `Set-UserPhoto -Save` command or running both the `Set-UserPhoto -Preview` and `Set-UserPhoto -Save` commands. If the user cancels the preview photo on the Options page in Outlook on the web, then the `Set-UserPhoto -Cancel` command is called. -A user photo must be set for a user before you can run the Get-UserPhoto cmdlet to view information about the user's photo. Otherwise, you'll get an error message saying the user photo doesn't exist for the specified user. Alternatively, you can run the `Get-UserPhoto -Preview` command to view information about a preview photo. +A user photo must be set for a user before you can run the Get-UserPhoto cmdlet to view information about the user's photo. Otherwise, you get an error message saying the user photo doesn't exist for the specified user. Alternatively, you can run the `Get-UserPhoto -Preview` command to view information about a preview photo. -**Notes**: Changes to the user photo won't appear in SharePoint until the affected user visits their profile page (My Site) or any SharePoint page that shows their large thumbnail image. +**Notes**: Changes to the user photo don't appear in SharePoint until the affected user visits their profile page (My Site) or any SharePoint page that shows their large thumbnail image. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -129,6 +130,9 @@ This example deletes the preview photo that was uploaded in the previous example ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the user. You can use any value that uniquely identifies the user. For example: - Name @@ -146,7 +150,6 @@ The Identity parameter specifies the identity of the user. You can use any value Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -156,7 +159,10 @@ Accept wildcard characters: False ``` ### -Cancel -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. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Cancel switch deletes the current 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. @@ -164,7 +170,6 @@ To delete the photo that's currently associated with a user's account, use the R Type: SwitchParameter Parameter Sets: CancelPhoto Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -174,15 +179,17 @@ Accept wildcard characters: False ``` ### -PictureData -The PictureData parameter specifies the photo file that will be uploaded to the user's account. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The PictureData parameter specifies the photo file to upload to the user's account. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] -Parameter Sets: UploadPhotoData +Parameter Sets: UploadPhotoData, UploadPreview Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -191,27 +198,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Byte[] -Parameter Sets: UploadPreview -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -PictureStream -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -PictureStream -The PictureStream parameter specifies the photo that will be uploaded to the user's account. This parameter is used by client applications such as Outlook on the web when users add a photo. To upload a photo using PowerShell, use the PictureData parameter to specify the photo file. +The PictureStream parameter specifies the photo to upload to the user's account. This parameter is used by client applications such as Outlook on the web when users add a photo. To upload a photo using PowerShell, use the PictureData parameter to specify the photo file. ```yaml Type: Stream -Parameter Sets: UploadPhotoStream +Parameter Sets: UploadPhotoStream, UploadPreview Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -220,29 +216,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Stream -Parameter Sets: UploadPreview -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Preview -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE -### -Preview The Preview switch uploads a preview photo for the user account. You don't need to specify a value with this switch. -A preview photo is the photo object that is uploaded to the user's account, but isn't saved. For example, if a user uploads a photo in Outlook on the web Options to preview before saving it. If you use the Preview switch to upload a preview photo, you need to run the command `Set-UserPhoto -Save` to save it as the user's photo. +A preview photo is uploaded to the user's account, but isn't saved. For example, if a user uploads a photo in Outlook on the web Options to preview before saving it. If you use the Preview switch to upload a preview photo, you need to run the command `Set-UserPhoto -Save` to save it as the user's photo. ```yaml Type: SwitchParameter Parameter Sets: UploadPreview Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -252,13 +237,15 @@ Accept wildcard characters: False ``` ### -Save -The Save switch specifies that the photo that's uploaded to the user's account will be saved as the user's photo. You don't need to specify a value with this switch. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Save switch specifies the uploaded photo is saved as the user's photo. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: SavePhoto Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -268,6 +255,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -279,7 +269,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,13 +278,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -305,13 +296,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -321,6 +314,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -332,7 +328,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -342,13 +337,15 @@ Accept wildcard characters: False ``` ### -PhotoType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -358,13 +355,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-VivaInsightsSettings.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-VivaInsightsSettings.md index d794753e4e..e15f50ba9d 100644 --- a/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-VivaInsightsSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-vivainsightssettings applicable: Exchange Online -title: Set-VivaInsightsSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-vivainsightssettings +schema: 2.0.0 +title: Set-VivaInsightsSettings --- # Set-VivaInsightsSettings @@ -54,13 +55,15 @@ This example disables access to all the Headspace features in Microsoft Viva Ins ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user that you want to modify. You identify the user by their User Principal Name (UPN) (for example, roy@contoso.onmicrosoft.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter enables or disables access to specific features of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are: - $true: The specified features in Microsoft Viva Insights in Microsoft Teams are enabled for the user. @@ -79,7 +85,6 @@ The Enabled parameter enables or disables access to specific features of Microso Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Feature + +> Applicable: Exchange Online + The Feature parameter specifies the feature of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are: - Headspace: Represents all features of Headspace. @@ -99,7 +107,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: headspace -Applicable: Exchange Online Required: True Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-WebServicesVirtualDirectory.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-WebServicesVirtualDirectory.md index 09636df6f4..af15a221bb 100644 --- a/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-WebServicesVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-webservicesvirtualdirectory -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-WebServicesVirtualDirectory -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-webservicesvirtualdirectory +schema: 2.0.0 +title: Set-WebServicesVirtualDirectory --- # Set-WebServicesVirtualDirectory @@ -45,7 +46,7 @@ Set-WebServicesVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +74,9 @@ This example enables MRSProxy on the EWS default website. MRSProxy is the servic ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the EWS virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -85,7 +89,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -95,16 +98,18 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: -- $true: Basic authentication is enabled. This is the default value. +- $true: Basic authentication is enabled. This value is the default. - $false: Basic authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -CertificateAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CertificateAuthentication parameter specifies whether certificate authentication is enabled. This parameter affects the `/ews/management/` virtual directory. It doesn't affect the `/ews/` virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -139,7 +149,6 @@ 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 Required: False Position: Named @@ -149,16 +158,18 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. -- $false: Digest authentication is disabled. This is the default value. +- $false: Digest authentication is disabled. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,13 +179,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,19 +197,21 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. - AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. - NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. -- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. +- ProxyCoHosting: HTTP and HTTPS traffic might be accessing the virtual directory and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,16 +221,18 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: -- $null: This is the default value. +- $null: This value is the default. - Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,10 +242,13 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: -- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. -- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- None: Extended Protection for Authentication isn't be used on the virtual directory. This value is the default. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication work, but might not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. **Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. @@ -237,7 +257,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -247,6 +266,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. @@ -255,7 +277,6 @@ This setting is important when Secure Sockets Layer (SSL) is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -273,7 +297,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -283,10 +306,13 @@ Accept wildcard characters: False ``` ### -GzipLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The GzipLevel parameter sets the Gzip configuration for the Exchange Web Services virtual directory. Valid values are: - Off: No compression. -- Low: Static compression only. This is the default value. This value has the same result as the Off value, because Exchange Web Services content is dynamic. +- Low: Static compression only. This value is the default. This value has the same result as the Off value, because Exchange Web Services content is dynamic. - High: Static and dynamic compression. Content from Exchange Web Services is compressed if clients indicate support for Gzip compression in their requests. - Error: Identifies errors in the Gzip compression configuration. @@ -294,7 +320,6 @@ The GzipLevel parameter sets the Gzip configuration for the Exchange Web Service Type: GzipLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,6 +329,9 @@ Accept wildcard characters: False ``` ### -InternalNLBBypassUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + **Note:** This parameter applies only to Exchange 2010. By default, Exchange 2013 or later already has the InternalNLBBypassUrl value configured on the backend Exchange Web Services (EWS) virtual directory on Mailbox servers. The InternalNLBBypassUrl parameter specifies the URL of the Exchange server that has the Client Access server role installed, regardless of whether it's behind a Network Load Balancing (NLB) array or not. @@ -314,7 +342,6 @@ When you set the InternalUrl parameter to the URL of the NLB array, you should s Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,6 +351,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is important when SSL is used. @@ -332,7 +362,6 @@ This setting is important when SSL is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -342,13 +371,15 @@ Accept wildcard characters: False ``` ### -MRSProxyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MRSProxyEnabled parameter specifies whether to enable MRSProxy for the Exchange Web Services virtual directory on Exchange servers that have the Client Access server role installed. MRSProxy helps to proxy mailbox moves between Active Directory forests. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -358,15 +389,17 @@ Accept wildcard characters: False ``` ### -MRSProxyMaxConnections + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. -The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy will accept. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). +The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy accepts. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -376,16 +409,18 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OAuthAuthentication parameter specifies whether OAuth authentication is enabled on the virtual directory. Valid values are: -- $true: OAuth authentication is enabled. This is the default value. +- $true: OAuth authentication is enabled. This value is the default. - $false: OAuth authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -395,13 +430,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -411,16 +448,18 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: -- $true: Integrated Windows authentication is enabled. This is the default value. +- $true: Integrated Windows authentication is enabled. This value is the default. - $false: Integrated Windows authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -430,16 +469,18 @@ Accept wildcard characters: False ``` ### -WSSecurityAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are: -- $true: WS-Security authentication is enabled. This is the default value. +- $true: WS-Security authentication is enabled. This value is the default. - $false: WS-Security authentication is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md b/exchange/exchange-ps/ExchangePowerShell/Set-X400AuthoritativeDomain.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Set-X400AuthoritativeDomain.md index 30872ecd30..3091a8391f 100644 --- a/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-X400AuthoritativeDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-x400authoritativedomain -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-X400AuthoritativeDomain -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-x400authoritativedomain +schema: 2.0.0 +title: Set-X400AuthoritativeDomain --- # Set-X400AuthoritativeDomain @@ -66,7 +67,7 @@ organizational unit name - Abbreviation: OU1 to OU4 - Maximum character length: 32 -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,6 +84,9 @@ This example makes the following changes to an existing X.400 authoritative doma ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 @@ -93,7 +97,6 @@ The Identity parameter specifies the X.400 authoritative domain that you want to Type: X400AuthoritativeDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -112,7 +118,6 @@ 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 Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -130,7 +138,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,13 +147,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Name parameter specifies the unique name for the X.400 authoritative domain. 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: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +183,9 @@ Accept wildcard characters: False ``` ### -X400DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The X400DomainName parameter specifies the X.400 namespace that can only include the X.400 organizational components. Specifically, only the following attribute types are supported: - C (Country) @@ -189,7 +203,6 @@ Separate the address attributes with semicolons and enclose the entire address i Type: X400Domain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,13 +212,15 @@ Accept wildcard characters: False ``` ### -X400ExternalRelay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The X400ExternalRelay parameter specifies whether this authoritative domain is an external relay domain. If you set the X400ExternalRelay parameter to $true, Exchange routes to the external address and doesn't treat resolution failures to this subdomain as errors. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/Start-ComplianceSearch.md similarity index 79% rename from exchange/exchange-ps/exchange/Start-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Start-ComplianceSearch.md index ddcb34db75..69a49182af 100644 --- a/exchange/exchange-ps/exchange/Start-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-ComplianceSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Start-ComplianceSearch -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-compliancesearch +schema: 2.0.0 +title: Start-ComplianceSearch --- # Start-ComplianceSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Start-ComplianceSearch cmdlet to start stopped, completed or not started compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. @@ -30,7 +31,7 @@ Start-ComplianceSearch [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. @@ -48,6 +49,9 @@ This example starts the compliance search named Case 1234 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Identity parameter specifies the compliance search that you want to start. You can use any value that uniquely identifies the compliance search. For example: @@ -61,7 +65,6 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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. @@ -98,7 +106,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -RetryOnError + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The RetryOnError switch specifies whether to retry the search on any items that failed without re-running the entire search all over again. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The WhatIf parameter doesn't work in the Microsoft Purview compliance portal. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -132,7 +144,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Start-DatabaseAvailabilityGroup.md similarity index 81% rename from exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Start-DatabaseAvailabilityGroup.md index 771a794112..fedd062276 100644 --- a/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-databaseavailabilitygroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Start-DatabaseAvailabilityGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-databaseavailabilitygroup +schema: 2.0.0 +title: Start-DatabaseAvailabilityGroup --- # Start-DatabaseAvailabilityGroup @@ -43,7 +44,7 @@ Start-DatabaseAvailabilityGroup [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the DAG being started. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectorySite + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveDirectorySite parameter specifies whether to start all DAG members in the specified site. ```yaml Type: AdSiteIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxServer parameter specifies whether to start a single DAG member. ```yaml Type: MailboxServerIdParameter Parameter Sets: MailboxSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigurationOnly switch specifies whether to update the Active Directory properties with the start action, but doesn't perform a start of the DAG or any members. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -137,7 +149,6 @@ 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 Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-EdgeSynchronization.md b/exchange/exchange-ps/ExchangePowerShell/Start-EdgeSynchronization.md similarity index 79% rename from exchange/exchange-ps/exchange/Start-EdgeSynchronization.md rename to exchange/exchange-ps/ExchangePowerShell/Start-EdgeSynchronization.md index a61cfb7896..942cf46484 100644 --- a/exchange/exchange-ps/exchange/Start-EdgeSynchronization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-EdgeSynchronization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-edgesynchronization -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Start-EdgeSynchronization -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-edgesynchronization +schema: 2.0.0 +title: Start-EdgeSynchronization --- # Start-EdgeSynchronization @@ -33,7 +34,7 @@ Start-EdgeSynchronization [-Confirm] ## DESCRIPTION The Microsoft Exchange EdgeSync service that runs on Mailbox servers replicates data stored in Active Directory to the local Active Directory Lightweight Directory Services (AD LDS) store on the Edge Transport server. After the initial replication, one-way synchronization of changed data in Active Directory to AD LDS keeps this data up to date. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example starts edge synchronization on the Mailbox server named Mailbox01. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -56,7 +60,6 @@ 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 Required: False Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -ForceFullSync + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForceFullSync switch specifies whether to initiate a full edge synchronization. You don't need to specify a value with this switch. If you don't use this switch, only changes since the last replication are synchronized. If you use this switch, the entire configuration information and recipient data are synchronized. @@ -74,7 +80,6 @@ If you don't use this switch, only changes since the last replication are synchr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -ForceUpdateCookie + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ForceUpdateCookie switch specifies whether to force the Microsoft Exchange EdgeSync service to update the replication cookie even if it encounters an error. You don't need to specify a value with this switch. The cookie maintains the changes in Active Directory since the previous EdgeSync replication. Normally, the Microsoft Exchange EdgeSync service doesn't update the cookie if it encounters any errors during replication. @@ -92,7 +100,6 @@ The cookie maintains the changes in Active Directory since the previous EdgeSync Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -115,7 +125,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,15 +134,17 @@ Accept wildcard characters: False ``` ### -TargetServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetServer parameter specifies an Edge Transport server to initiate edge synchronization with. If omitted, all Edge Transport servers are synchronized. -You may want to use this parameter to specify a single Edge Transport server for synchronization if a new Edge Transport server has been installed or if that Edge Transport server has been unavailable for some time. +You might want to use this parameter to specify a single Edge Transport server for synchronization if a new Edge Transport server is installed or if that Edge Transport server is unavailable for some time. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md b/exchange/exchange-ps/ExchangePowerShell/Start-HistoricalSearch.md similarity index 85% rename from exchange/exchange-ps/exchange/Start-HistoricalSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Start-HistoricalSearch.md index 598f93159b..30a29a3eb4 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-HistoricalSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-historicalsearch applicable: Exchange Online, Exchange Online Protection -title: Start-HistoricalSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-historicalsearch +schema: 2.0.0 +title: Start-HistoricalSearch --- # Start-HistoricalSearch @@ -45,11 +46,11 @@ Start-HistoricalSearch -EndDate -ReportTitle -ReportType Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -80,7 +84,6 @@ You also need to use at least one of the following parameters in the command: Me Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -ReportTitle + +> Applicable: Exchange Online, Exchange Online Protection + The ReportTitle parameter specifies a descriptive name for the historical search. If the value contains spaces, enclose the value in quotation marks ("). You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. @@ -98,7 +104,6 @@ You also need to use at least one of the following parameters in the command: Me Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -108,6 +113,9 @@ Accept wildcard characters: False ``` ### -ReportType + +> Applicable: Exchange Online, Exchange Online Protection + 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 @@ -128,7 +136,6 @@ You also need to use at least one of the following parameters in the command: Me Type: HistoricalSearchReportType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -146,7 +156,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -BlockStatus + +> Applicable: Exchange Online, Exchange Online Protection + The BlockStatus parameter filters the results in OutboundSecurityReport reports by the status of messages sent externally, messages blocked due to security checks, or messages sent successfully. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -CompressFile + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill CompressFile Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorType parameter filters the results in ConnectorReport reports by the connector type. Valid values are: - OnPremises @@ -198,7 +214,6 @@ The ConnectorType parameter filters the results in ConnectorReport reports by th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,6 +223,9 @@ Accept wildcard characters: False ``` ### -DeliveryStatus + +> Applicable: Exchange Online, Exchange Online Protection + The DeliveryStatus parameter filters the results by the delivery status of the message. You can use one of the following values: - Delivered @@ -218,7 +236,6 @@ The DeliveryStatus parameter filters the results by the delivery status of the m Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by the direction of the message. Valid values are: - All: Incoming and outgoing messages. @@ -238,7 +258,6 @@ The Direction parameter filters the results by the direction of the message. Val Type: MessageDirection Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,13 +267,15 @@ Accept wildcard characters: False ``` ### -DLPPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The DLPPolicy parameter filters the results by the name of the DLP policy that acted on the message. You can specify multiple DLP policies separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -264,13 +285,15 @@ Accept wildcard characters: False ``` ### -EncryptionTemplate + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill EncryptionTemplate Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,13 +303,15 @@ Accept wildcard characters: False ``` ### -EncryptionType + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill EncryptionType Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -296,6 +321,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Online, Exchange Online Protection + The Locale parameter filters the results by the locale of the message. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -304,7 +332,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -314,13 +341,15 @@ 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, ""). + +> Applicable: Exchange Online, Exchange Online Protection + +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 might include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -330,13 +359,15 @@ Accept wildcard characters: False ``` ### -NetworkMessageID -The NetworkMessageId parameter filters the message tracking log entries by the value of the NetworkMessageId field. This field contains a unique message ID value that persists across copies of the message that may be created due to bifurcation or distribution group expansion. An example value is 1341ac7b13fb42ab4d4408cf7f55890f. + +> Applicable: Exchange Online, Exchange Online Protection + +The NetworkMessageId parameter filters the message tracking log entries by the value of the NetworkMessageId field. This field contains a unique message ID value that persists across copies of the message that might be created due to bifurcation or distribution group expansion. An example value is 1341ac7b13fb42ab4d4408cf7f55890f. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -346,6 +377,9 @@ Accept wildcard characters: False ``` ### -NotifyAddress + +> Applicable: Exchange Online, Exchange Online Protection + The NotifyAddress parameter specifies the email addresses of internal recipients to notify when the historical search is complete. The email address must be in an accepted domain that's configured for your organization. You can enter multiple email addresses separated by commas. To view the results of the historical search, you need to specify at least one email address for the NotifyAddress parameter. Otherwise, you need to click on the completed message trace in the Exchange admin center at **Mail flow** \> **Message trace**. @@ -354,7 +388,6 @@ To view the results of the historical search, you need to specify at least one e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -364,13 +397,15 @@ Accept wildcard characters: False ``` ### -OriginalClientIP + +> Applicable: Exchange Online, Exchange Online Protection + The OriginalClientIP parameter filters the results by the original IP address of the message. For incoming messages, the OriginalClientIP value is the sender's IP address. For outgoing messages, the OriginalClientIP value is the IP address of the external SMTP server that received the message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -380,13 +415,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. The maximum number of addresses is 100. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -396,13 +433,15 @@ Accept wildcard characters: True ``` ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. The maximum number of addresses is 100. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -412,13 +451,15 @@ Accept wildcard characters: False ``` ### -SmtpSecurityError + +> Applicable: Exchange Online, Exchange Online Protection + The SmtpSecurityError parameter filters the results in OutboundSecurityReport reports by the error type of blocked messages when sent externally. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -428,6 +469,9 @@ Accept wildcard characters: False ``` ### -TLSUsed + +> Applicable: Exchange Online, Exchange Online Protection + The TLSUsed parameter filters the results in ConnectorReport reports by the TLS version. Valid values are: - No Tls @@ -438,7 +482,6 @@ The TLSUsed parameter filters the results in ConnectorReport reports by the TLS Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -448,13 +491,15 @@ Accept wildcard characters: False ``` ### -TransportRule + +> Applicable: Exchange Online, Exchange Online Protection + The TransportRule parameter filters the results by the name of the Exchange mail flow rule (also known as a transport rule) that acted on the message. You can specify multiple transport rules separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -464,13 +509,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill Url Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md b/exchange/exchange-ps/ExchangePowerShell/Start-InformationBarrierPoliciesApplication.md similarity index 92% rename from exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md rename to exchange/exchange-ps/ExchangePowerShell/Start-InformationBarrierPoliciesApplication.md index 2afb3f3ca7..24ad708c99 100644 --- a/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-InformationBarrierPoliciesApplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication applicable: Security & Compliance -title: Start-InformationBarrierPoliciesApplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-informationbarrierpoliciesapplication +schema: 2.0.0 +title: Start-InformationBarrierPoliciesApplication --- # Start-InformationBarrierPoliciesApplication @@ -43,13 +44,15 @@ This applies all active information barrier policies. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -CleanupGroupSegmentLink + +> Applicable: Security & Compliance + The CleanupGroupSegmentLink switch specifies whether to remove group segment links. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -75,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -84,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 @@ -122,4 +131,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Start-MailboxAssistant.md b/exchange/exchange-ps/ExchangePowerShell/Start-MailboxAssistant.md similarity index 84% rename from exchange/exchange-ps/exchange/Start-MailboxAssistant.md rename to exchange/exchange-ps/ExchangePowerShell/Start-MailboxAssistant.md index 52a05e9bcb..1af287cc35 100644 --- a/exchange/exchange-ps/exchange/Start-MailboxAssistant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-MailboxAssistant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-mailboxassistant -applicable: Exchange Server 2019 -title: Start-MailboxAssistant -schema: 2.0.0 +applicable: Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-mailboxassistant +schema: 2.0.0 +title: Start-MailboxAssistant --- # Start-MailboxAssistant @@ -30,7 +31,7 @@ Start-MailboxAssistant [-Identity] -AssistantName ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +47,9 @@ This example starts the `BigFunnelRetryFeederTimeBasedAssistant` assistant and l ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the user whose mailbox should be processed by the Mailbox Assistant. Valid values are: - Distinguished name (DN) @@ -56,7 +60,6 @@ The Identity parameter specifies the user whose mailbox should be processed by t Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: True Position: 0 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssistantName + +> Applicable: Exchange Server 2019, Exchange Server SE + The AssistantName parameter specifies the assistant that should process the mailbox. Valid values are: - BigFunnelRetryFeederTimeBasedAssistant @@ -76,7 +82,6 @@ Values are case sensitive. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: True Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019, Exchange Server SE + 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`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -137,6 +148,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Server 2019, Exchange Server SE + 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. @@ -145,7 +159,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019, Exchange Server SE + 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 diff --git a/exchange/exchange-ps/exchange/Start-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/Start-MailboxSearch.md similarity index 80% rename from exchange/exchange-ps/exchange/Start-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Start-MailboxSearch.md index a84f5ccd78..4da8c127b8 100644 --- a/exchange/exchange-ps/exchange/Start-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-MailboxSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-MailboxSearch -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-mailboxsearch +schema: 2.0.0 +title: Start-MailboxSearch --- # Start-MailboxSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Start-MailboxSearch cmdlet to restart or resume a mailbox search that's been stopped. @@ -42,7 +43,7 @@ In Exchange 2013 or later, mailbox searches are also used for In-Place Hold. How For more details, see [In-Place Hold and Litigation Hold in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/holds/holds) and [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,13 +57,15 @@ This example starts the mailbox search ProjectContoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the search. The name is referenced when starting, stopping, or removing the search. ```yaml Type: SearchObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -81,7 +87,6 @@ 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 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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. @@ -117,7 +127,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,6 +136,9 @@ Accept wildcard characters: False ``` ### -Resume + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Resume switch resumes a stopped, failed, or partially succeeded search from the point it stopped. You don't need to specify a value with this switch. If you use this switch to resume a search, previous search results aren't removed from the target mailbox. @@ -135,7 +147,6 @@ If you use this switch to resume a search, previous search results aren't remove Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -145,13 +156,15 @@ Accept wildcard characters: False ``` ### -StatisticsStartIndex + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The StatisticsStartIndex parameter is used by the EAC to retrieve keyword statistics in a paged operation. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -161,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md b/exchange/exchange-ps/ExchangePowerShell/Start-ManagedFolderAssistant.md similarity index 80% rename from exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md rename to exchange/exchange-ps/ExchangePowerShell/Start-ManagedFolderAssistant.md index edd46319b2..c3b0d8267e 100644 --- a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-ManagedFolderAssistant.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-managedfolderassistant -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-ManagedFolderAssistant -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-managedfolderassistant +schema: 2.0.0 +title: Start-ManagedFolderAssistant --- # Start-ManagedFolderAssistant ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Start-ManagedFolderAssistant cmdlet to immediately start messaging records management (MRM) processing of mailboxes that you specify. @@ -110,13 +111,13 @@ Start-ManagedFolderAssistant [-Identity] [-StopHo ## DESCRIPTION The Managed Folder Assistant uses the retention policy settings of users' mailboxes to process retention of items. This mailbox processing occurs automatically. You can use the Start-ManagedFolderAssistant cmdlet to immediately start processing the specified mailbox. -In Exchange Server 2010 release to manufacturing (RTM), the Identity parameter specifies the Mailbox server to start the assistant and process all mailboxes on that server, and the Mailbox parameter specifies the mailbox to process. In Exchange 2010 Service Pack 1 (SP1) and later, the Mailbox parameter has been removed, and the Identity parameter accepts the mailbox or mail user to process. +In Exchange Server 2010 release to manufacturing (RTM), the Identity parameter specifies the Mailbox server to start the assistant and process all mailboxes on that server, and the Mailbox parameter specifies the mailbox to process. In Exchange 2010 Service Pack 1 (SP1) and later, the Mailbox parameter is removed, and the Identity parameter accepts the mailbox or mail user to process. If you use these parameters in scheduled commands or scripts, we recommend that you review them and make any necessary changes. For more information, see [KB4032361](https://support.microsoft.com/help/4032361). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -137,6 +138,9 @@ This example uses the Get-Mailbox command to retrieve all the mailboxes that res ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the mailbox to be processed. In cross-premises deployments, you can also specify a mail user who has a mailbox in the cloud. You can use any value that uniquely identifies the mailbox or mail user. For example: - Name @@ -156,7 +160,6 @@ The Identity parameter specifies the mailbox to be processed. In cross-premises Type: MailboxOrMailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -166,6 +169,9 @@ Accept wildcard characters: False ``` ### -AdaptiveScope + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AdaptiveScope Description }} @@ -174,7 +180,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ComplianceBoundaryAssistantParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -184,13 +189,17 @@ 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. + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AggMailboxCleanup switch specifies aggregate mailbox cleanup. You don't need to specify a value with this switch. + +This switch cleans up aggregate mailboxes, audits, and calendar logging. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -200,6 +209,9 @@ Accept wildcard characters: False ``` ### -B2DumpsterArchiver + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill B2DumpsterArchiver Description }} @@ -208,7 +220,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ElcB2DumpsterArchiverAssistantParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -218,6 +229,9 @@ Accept wildcard characters: False ``` ### -B2IPMArchiver + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill B2IPMArchiver Description }} @@ -226,7 +240,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ElcB2IPMArchiverAssistantParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -236,6 +249,9 @@ Accept wildcard characters: False ``` ### -ComplianceJob + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -244,7 +260,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: ComplianceJobAssistantParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -254,6 +269,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -263,7 +281,6 @@ 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 Required: False Position: Named @@ -273,6 +290,9 @@ Accept wildcard characters: False ``` ### -DataGovernance + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -281,7 +301,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: DataGovernanceAssistantParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -291,6 +310,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -299,7 +321,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,6 +330,9 @@ Accept wildcard characters: False ``` ### -FullCrawl + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FullCrawl switch recalculates the application of tags across the whole mailbox. You don't need to specify a value with this switch. @@ -317,7 +341,6 @@ The FullCrawl switch recalculates the application of tags across the whole mailb Type: SwitchParameter Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -327,15 +350,17 @@ 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). +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The HoldCleanup switch instructs the Managed Folder Assistant to clean up duplicate versions of items in the Recoverable Items folder that might 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 might 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 @@ -345,6 +370,9 @@ Accept wildcard characters: False ``` ### -InactiveMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The InactiveMailbox switch runs the command only on inactive mailboxes. You don't need to specify a value with this switch. @@ -357,7 +385,6 @@ When you use this switch, items aren't moved from the inactive mailbox to the ar Type: SwitchParameter Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -367,17 +394,19 @@ Accept wildcard characters: False ``` ### -StopHoldCleanup + +> Applicable: Exchange Online + 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. +A hold clean-up command runs 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 Required: False Position: Named @@ -387,13 +416,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -419,4 +450,4 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[Export-MailboxDiagnosticLogs](https://learn.microsoft.com/powershell/module/exchange/Export-MailboxDiagnosticLogs) +[Export-MailboxDiagnosticLogs](https://learn.microsoft.com/powershell/module/exchangepowershell/Export-MailboxDiagnosticLogs) diff --git a/exchange/exchange-ps/exchange/Start-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Start-MigrationBatch.md similarity index 77% rename from exchange/exchange-ps/exchange/Start-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Start-MigrationBatch.md index cf1d3e9731..50807eac36 100644 --- a/exchange/exchange-ps/exchange/Start-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-MigrationBatch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-migrationbatch -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-MigrationBatch -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-migrationbatch +schema: 2.0.0 +title: Start-MigrationBatch --- # Start-MigrationBatch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Start-MigrationBatch cmdlet to start a move request or migration batch that was created with the New-MigrationBatch cmdlet. @@ -33,11 +34,11 @@ Start-MigrationBatch [[-Identity] ] ## DESCRIPTION The Start-MigrationBatch cmdlet starts a pending migration batch that was created, but not started, with the New-MigrationBatch cmdlet. -The Start-MigrationBatch cmdlet also will resume a Stopped migration batch or retry failures within a Failed or Synced with Errors migration batch. In the cloud-based service, the Start-MigrationBatch cmdlet can also retry failures within a Completed with Errors migration batch. +The Start-MigrationBatch cmdlet also resumes a Stopped migration batch or retry failures within a Failed or Synced with Errors migration batch. In the cloud-based service, the Start-MigrationBatch cmdlet can also retry failures within a Completed with Errors migration batch. In the cloud-based service, the Start-MigrationBatch cmdlet can be run at any time to retry failed users within the batch. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,13 +52,15 @@ This example starts the migration batch SEM1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter identifies the migration batch that you want to start. Use the migration batch Name parameter as the value for this parameter. Use the Get-MigrationBatch cmdlet to identify the name of the migration batch. ```yaml Type: MigrationBatchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -112,7 +122,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Validate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Validate switch starts the migration batch in the validation stage of the migration process. You don't need to specify a value with this switch. @@ -132,7 +144,6 @@ If you use this switch, the migration performs a validation check of the mailbox Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-MigrationUser.md b/exchange/exchange-ps/ExchangePowerShell/Start-MigrationUser.md similarity index 81% rename from exchange/exchange-ps/exchange/Start-MigrationUser.md rename to exchange/exchange-ps/ExchangePowerShell/Start-MigrationUser.md index be88fe1878..59b9123568 100644 --- a/exchange/exchange-ps/exchange/Start-MigrationUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-MigrationUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-migrationuser -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-MigrationUser -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-migrationuser +schema: 2.0.0 +title: Start-MigrationUser --- # Start-MigrationUser @@ -30,7 +31,7 @@ Start-MigrationUser [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example starts the migration of the user named laura@contoso.com ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the email address of the user that's being migrated. You can also identify the user by the GUID value in the MigrationUser property from the output of the Get-MigrationUser cmdlet. This identification method is useful if you accidentally submitted the same user in multiple batches. @@ -52,7 +56,6 @@ You can also identify the user by the GUID value in the MigrationUser property f Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -89,7 +97,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -107,7 +117,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md b/exchange/exchange-ps/ExchangePowerShell/Start-RetentionAutoTagLearning.md similarity index 89% rename from exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md rename to exchange/exchange-ps/ExchangePowerShell/Start-RetentionAutoTagLearning.md index 3ad1a2652d..00f627f80b 100644 --- a/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-RetentionAutoTagLearning.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-retentionautotaglearning applicable: Exchange Server 2010 -title: Start-RetentionAutoTagLearning -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-retentionautotaglearning +schema: 2.0.0 +title: Start-RetentionAutoTagLearning --- # Start-RetentionAutoTagLearning @@ -45,7 +46,7 @@ Start-RetentionAutoTagLearning [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +74,9 @@ This example sets user Joe Healy's mailbox to clear all retention policy tags as ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter identifies the mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -90,7 +94,6 @@ The Identity parameter identifies the mailbox. You can use any value that unique Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -100,13 +103,15 @@ Accept wildcard characters: False ``` ### -CrossValidate + +> Applicable: Exchange Server 2010 + The CrossValidate switch specifies whether items in the specified mailbox are being auto-tagged. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: CrossValidate Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -116,13 +121,15 @@ Accept wildcard characters: False ``` ### -Clear + +> Applicable: Exchange Server 2010 + The Clear switch specifies whether to clear auto-tags from the specified mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Train Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -141,7 +151,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -NumberOfSegments + +> Applicable: Exchange Server 2010 + The NumberOfSegments parameter specifies the number of segments. Auto-tagging divides a mailbox into the number of segments specified and learns tagging behavior from n-1 segments. Tags are then predicted for items in the remaining segment based on this behavior. This is done for each segment. The default value is 10. @@ -179,7 +193,6 @@ You csn only use this parameter with the CrossValidate parameter. Type: Int32 Parameter Sets: CrossValidate Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -189,6 +202,9 @@ Accept wildcard characters: False ``` ### -Train + +> Applicable: Exchange Server 2010 + The Train switch specifies whether to start the training algorithm for auto-tagging on the specified mailbox. You don't need to specify a value with this switch. This switch is especially useful for retraining. @@ -197,7 +213,6 @@ This switch is especially useful for retraining. Type: SwitchParameter Parameter Sets: Train Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -207,13 +222,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/Stop-ComplianceSearch.md similarity index 78% rename from exchange/exchange-ps/exchange/Stop-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-ComplianceSearch.md index a0b52107ee..50dc351ba7 100644 --- a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-ComplianceSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Stop-ComplianceSearch -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-compliancesearch +schema: 2.0.0 +title: Stop-ComplianceSearch --- # Stop-ComplianceSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Stop-ComplianceSearch cmdlet to stop running compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. @@ -28,7 +29,7 @@ Stop-ComplianceSearch [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. @@ -46,6 +47,9 @@ This example stops the active compliance search named Case 1234 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The Identity parameter specifies the compliance search that you want to stop. You can use any value that uniquely identifies the compliance search. For example: @@ -59,7 +63,6 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -96,7 +104,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Stop-DatabaseAvailabilityGroup.md similarity index 82% rename from exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-DatabaseAvailabilityGroup.md index c9f3ae6135..fd68e66f9e 100644 --- a/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-databaseavailabilitygroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Stop-DatabaseAvailabilityGroup -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-databaseavailabilitygroup +schema: 2.0.0 +title: Stop-DatabaseAvailabilityGroup --- # Stop-DatabaseAvailabilityGroup @@ -43,7 +44,7 @@ Stop-DatabaseAvailabilityGroup [-Identity] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the DAG being stopped. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectorySite + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveDirectorySite parameter specifies the Active Directory site containing the DAG members to stop (for example, stop all DAG members in a particular Active Directory site). ```yaml Type: AdSiteIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxServer parameter specifies a single DAG member to stop. If Datacenter Activation Coordination mode is enabled for the DAG and all DAG members are in the same Active Directory site, use the MailboxServer parameter to stop individual DAG members instead of the ActiveDirectorySite parameter when stopping failed DAG members. ```yaml Type: MailboxServerIdParameter Parameter Sets: MailboxSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConfigurationOnly switch updates the Active Directory properties with the stop action, but doesn't perform a stop of the DAG or any members. You don't need to specify a value with this switch. You eed to use this switch when the DAG member servers are offline, but Active Directory is up and accessible in the primary datacenter. @@ -127,7 +137,6 @@ You eed to use this switch when the DAG member servers are offline, but Active D Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -146,7 +158,6 @@ 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 Required: False Position: Named @@ -156,13 +167,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-HistoricalSearch.md b/exchange/exchange-ps/ExchangePowerShell/Stop-HistoricalSearch.md similarity index 83% rename from exchange/exchange-ps/exchange/Stop-HistoricalSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-HistoricalSearch.md index 314339dd93..52153100c5 100644 --- a/exchange/exchange-ps/exchange/Stop-HistoricalSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-HistoricalSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-historicalsearch applicable: Exchange Online, Exchange Online Protection -title: Stop-HistoricalSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-historicalsearch +schema: 2.0.0 +title: Stop-HistoricalSearch --- # Stop-HistoricalSearch @@ -30,7 +31,7 @@ A historical search provides message trace and report details in a comma-separat After you start a historical search by using the Start-HistoricalSearch cmdlet, the search is queued, but not actually running. While the search is queued and has the status value of NotStarted, you can use the Stop-HistoricalSearch cmdlet to stop it. After the search is actively running, and has a status value of InProgress, you can't stop it. When you stop a historical search, it's given a status value of Cancelled. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example stops the historical search that has the JobId value f9c66f83-b5c8- ## PARAMETERS ### -JobId + +> Applicable: Exchange Online, Exchange Online Protection + The JobId parameter specifies the identity GUID value of the historical search that you want to stop. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md b/exchange/exchange-ps/ExchangePowerShell/Stop-InformationBarrierPoliciesApplication.md similarity index 94% rename from exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-InformationBarrierPoliciesApplication.md index 00b91d2c2c..1bdb947ae3 100644 --- a/exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-InformationBarrierPoliciesApplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication applicable: Security & Compliance -title: Stop-InformationBarrierPoliciesApplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-informationbarrierpoliciesapplication +schema: 2.0.0 +title: Stop-InformationBarrierPoliciesApplication --- # Stop-InformationBarrierPoliciesApplication @@ -42,13 +43,15 @@ This example stops the application of information barrier policies per the polic ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the active application of information barrier policies that you want to stop. This value is a GUID that's assigned when you run the Start-InformationBarrierPoliciesApplication cmdlet (for example, 46237888-12ca-42e3-a541-3fcb7b5231d1). You can also find the Identity value of the most recent policy application running the command Get-InformationBarrierPoliciesApplicationStatus. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Stop-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/Stop-MailboxSearch.md similarity index 79% rename from exchange/exchange-ps/exchange/Stop-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-MailboxSearch.md index b78b8cb8b3..3033128657 100644 --- a/exchange/exchange-ps/exchange/Stop-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-MailboxSearch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Stop-MailboxSearch -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-mailboxsearch +schema: 2.0.0 +title: Stop-MailboxSearch --- # Stop-MailboxSearch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Stop-MailboxSearch cmdlet to stop a mailbox search that's in progress. @@ -33,7 +34,7 @@ Stop-MailboxSearch [-Identity] ## DESCRIPTION In Microsoft Exchange, mailbox searches are used for In-Place eDiscovery and In-Place Hold. You can start and stop a mailbox search. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example stops the mailbox search Project Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the name of the mailbox search. ```yaml Type: SearchObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -90,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md b/exchange/exchange-ps/ExchangePowerShell/Stop-ManagedFolderAssistant.md similarity index 82% rename from exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-ManagedFolderAssistant.md index 0b03abf051..24ece5e1b7 100644 --- a/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-ManagedFolderAssistant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-managedfolderassistant -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Stop-ManagedFolderAssistant -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-managedfolderassistant +schema: 2.0.0 +title: Stop-ManagedFolderAssistant --- # Stop-ManagedFolderAssistant @@ -31,7 +32,7 @@ Stop-ManagedFolderAssistant [[-Identity] ] ## DESCRIPTION The Managed Folder Assistant uses the managed folder mailbox policy settings of users to process mailbox items for retention and journaling as needed. Use the Stop-ManagedFolderAssistant cmdlet to stop the Managed Folder Assistant as soon as processing of the current mailbox is completed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example stops the Managed Folder Assistant on the servers ExchSrvr1 and Exc ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -65,7 +69,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -84,7 +90,6 @@ 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 Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Stop-MigrationBatch.md similarity index 78% rename from exchange/exchange-ps/exchange/Stop-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-MigrationBatch.md index 2c68616341..f4acf68ecd 100644 --- a/exchange/exchange-ps/exchange/Stop-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-MigrationBatch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-migrationbatch -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Stop-MigrationBatch -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-migrationbatch +schema: 2.0.0 +title: Stop-MigrationBatch --- # Stop-MigrationBatch ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Stop-MigrationBatch cmdlet to stop the processing of a migration batch that's in progress. @@ -30,9 +31,9 @@ Stop-MigrationBatch [[-Identity] ] ``` ## DESCRIPTION -The Stop-MigrationBatch cmdlet stops the migration batch that's being processed in your on-premises Exchange organization or by the cloud-based migration service running in Microsoft 365. You can only stop migration batches that have mailboxes that are still in the process of being migrated or are waiting to be migrated. Stopping a migration won't affect mailboxes that have been migrated already. The migration of mailboxes that are being actively migrated is stopped immediately. If all migration requests in a migration batch are completed or failed, this cmdlet won't run. +The Stop-MigrationBatch cmdlet stops the migration batch that's being processed in your on-premises Exchange organization or by the cloud-based migration service running in Microsoft 365. You can only stop migration batches that have mailboxes that are still in the process of being migrated or are waiting to be migrated. Stopping a migration doesn't affect mailboxes that have been migrated already. The migration of mailboxes that are being actively migrated is stopped immediately. If all migration requests in a migration batch are completed or failed, this cmdlet doesn't run. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example stops the migration batch MigrationBatch1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter identifies the name of the current migration batch. The value for this parameter is specified by the Name parameter of the New-MigrationBatch cmdlet. ```yaml Type: MigrationBatchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -96,7 +104,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -114,7 +124,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -124,13 +133,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-MigrationUser.md b/exchange/exchange-ps/ExchangePowerShell/Stop-MigrationUser.md similarity index 81% rename from exchange/exchange-ps/exchange/Stop-MigrationUser.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-MigrationUser.md index ccaca8fe4d..dcc2733a46 100644 --- a/exchange/exchange-ps/exchange/Stop-MigrationUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-MigrationUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-migrationuser -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Stop-MigrationUser -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-migrationuser +schema: 2.0.0 +title: Stop-MigrationUser --- # Stop-MigrationUser @@ -30,7 +31,7 @@ Stop-MigrationUser [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example stops the migration of the user laura@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the email address of the user that's being migrated. You can also identify the user by the GUID value in the MigrationUser property from the output of the Get-MigrationUser cmdlet. This identification method is useful if you accidentally submitted the same user in multiple batches. @@ -52,7 +56,6 @@ You can also identify the user by the GUID value in the MigrationUser property f Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -89,7 +97,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -107,7 +117,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxDatabaseCopy.md similarity index 80% rename from exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxDatabaseCopy.md index bbd7d1ecfa..358bee1cd6 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboxdatabasecopy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-MailboxDatabaseCopy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-mailboxdatabasecopy +schema: 2.0.0 +title: Suspend-MailboxDatabaseCopy --- # Suspend-MailboxDatabaseCopy @@ -42,7 +43,7 @@ Suspend-MailboxDatabaseCopy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,13 +64,15 @@ This example only suspends activation for the copy of the database DB3 hosted on ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name of the database copy being suspended. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -ActivationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActivationOnly switch specifies whether to suspend only activation for the mailbox database copy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -104,7 +112,6 @@ 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 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -EnableReplayLag + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: EnableReplayLag Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -146,13 +157,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuspendComment parameter specifies the reason that the database copy is being suspended. This parameter is limited to 512 characters. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,13 +175,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxExportRequest.md similarity index 82% rename from exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxExportRequest.md index 5f063c4f44..b8e9238531 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboxexportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-MailboxExportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-mailboxexportrequest +schema: 2.0.0 +title: Suspend-MailboxExportRequest --- # Suspend-MailboxExportRequest @@ -32,7 +33,7 @@ Suspend-MailboxExportRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This example suspends all export requests that are in progress by using the Get- ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). Use the following syntax: `Alias\Name`. ```yaml Type: MailboxExportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -78,7 +84,6 @@ 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 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxImportRequest.md similarity index 81% rename from exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxImportRequest.md index 41e44b0123..23e614915e 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxImportRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboximportrequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Suspend-MailboxImportRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-mailboximportrequest +schema: 2.0.0 +title: Suspend-MailboxImportRequest --- # Suspend-MailboxImportRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Suspend-MailboxImportRequest cmdlet to suspend an import request any time after the request was created, but before the request reaches the status of Completed. You can resume the move request by using the Resume-MailboxImportRequest cmdlet. @@ -34,7 +35,7 @@ Suspend-MailboxImportRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +56,15 @@ This example suspends all import requests that are in progress by using the Get- ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you created the request by using the Name parameter, use the following syntax: `Alias\Name`. ```yaml Type: MailboxImportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -80,7 +86,6 @@ 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 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -124,13 +133,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxRestoreRequest.md similarity index 80% rename from exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxRestoreRequest.md index ca7cdcbde0..bee0d5a78f 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxRestoreRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboxrestorerequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Suspend-MailboxRestoreRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-mailboxrestorerequest +schema: 2.0.0 +title: Suspend-MailboxRestoreRequest --- # Suspend-MailboxRestoreRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Suspend-MailboxRestoreRequest cmdlet to suspend a restore request any time after the request was created, but before the request reaches the status of Completed. You can resume the restore request by using the Resume-MailboxRestoreRequest cmdlet. @@ -30,7 +31,7 @@ Suspend-MailboxRestoreRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +52,9 @@ This example suspends all restore requests that are in progress by using the Get ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -59,7 +63,6 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: MailboxRestoreRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -78,7 +84,6 @@ 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 Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -96,7 +104,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-Message.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-Message.md similarity index 81% rename from exchange/exchange-ps/exchange/Suspend-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-Message.md index e978e8d3de..6f8990c619 100644 --- a/exchange/exchange-ps/exchange/Suspend-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-message -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-Message -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-message +schema: 2.0.0 +title: Suspend-Message --- # Suspend-Message @@ -38,13 +39,13 @@ Suspend-Message [-Identity] ``` ## DESCRIPTION -A message already in delivery won't be suspended. Delivery will continue and the message status will be PendingSuspend. If the delivery fails, the message will re-enter the queue and it will then be suspended. You can't suspend a message that's in the poison message queue. +A message already in delivery isn't suspended. Delivery continues and the message status is PendingSuspend. If the delivery fails, the message re-enters the queue and then it's suspended. You can't suspend a message in the poison message queue. A message being sent to multiple recipients might be located in multiple queues. If you specify an Identity parameter, the message is suspended in a single queue if that identity matches only a single message. If the identity matches more than one message, you receive an error. To suspend a message in more than one queue in a single operation, you must use the Filter parameter. -For instructions on how to resume a suspended message, see [Resume-Message](https://learn.microsoft.com/powershell/module/exchange/resume-message). +For instructions on how to resume a suspended message, see [Resume-Message](https://learn.microsoft.com/powershell/module/exchangepowershell/resume-message). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,13 +62,15 @@ This example prevents delivery of all messages for which the following condition ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -85,7 +91,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -104,7 +112,6 @@ 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 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -129,7 +139,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,13 +148,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-MoveRequest.md similarity index 80% rename from exchange/exchange-ps/exchange/Suspend-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-MoveRequest.md index 852bd02d0b..a710a4defc 100644 --- a/exchange/exchange-ps/exchange/Suspend-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-MoveRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-moverequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Suspend-MoveRequest -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-moverequest +schema: 2.0.0 +title: Suspend-MoveRequest --- # Suspend-MoveRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Suspend-MoveRequest cmdlet to suspend a move request any time after the move request was created, but before it reaches the status of CompletionInProgress. You can resume the move request by using the Resume-MoveRequest cmdlet. @@ -31,7 +32,7 @@ Suspend-MoveRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +53,9 @@ This example suspends all move requests that are in progress by using the Get-Mo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use one of the following values: - GUID @@ -66,7 +70,6 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c Type: MoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -85,7 +91,6 @@ 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 Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -103,7 +111,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter specifies the move destination by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -132,7 +142,6 @@ The ProxyToMailbox parameter specifies the move destination by the location of t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendComment parameter specifies a description as to why the request was suspended. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -158,13 +169,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMailboxMigrationRequest.md similarity index 79% rename from exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMailboxMigrationRequest.md index 6e8a63fbb7..3fed8dba41 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMailboxMigrationRequest.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-publicfoldermailboxmigrationrequest -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Suspend-PublicFolderMailboxMigrationRequest -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-publicfoldermailboxmigrationrequest +schema: 2.0.0 +title: Suspend-PublicFolderMailboxMigrationRequest --- # Suspend-PublicFolderMailboxMigrationRequest ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Suspend-PublicFolderMailboxMigrationRequest cmdlet to suspend individual jobs in public folder migration batches that were created by using the New-MigrationBatch cmdlet. @@ -30,7 +31,7 @@ Suspend-PublicFolderMailboxMigrationRequest [-Identity] Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the public folder mailbox migration request that you want to suspend. This value uses the syntax `\PublicFolderMailboxMigration` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). ```yaml Type: PublicFolderMailboxMigrationRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -87,7 +95,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,13 +104,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The SuspendComment parameter specifies a descriptive reason for why you suspended the public folder mailbox migration. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -113,13 +122,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMigrationRequest.md similarity index 83% rename from exchange/exchange-ps/exchange/Suspend-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMigrationRequest.md index 824fe531ac..e0b3bf7472 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-publicfoldermigrationrequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-PublicFolderMigrationRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-publicfoldermigrationrequest +schema: 2.0.0 +title: Suspend-PublicFolderMigrationRequest --- # Suspend-PublicFolderMigrationRequest @@ -32,7 +33,7 @@ Suspend-PublicFolderMigrationRequest [-Identity] Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the migration request that you want to suspend. You can use the following values: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the migration request that you want to suspend. Type: PublicFolderMigrationRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -81,7 +87,6 @@ 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 Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuspendComment parameter specifies a description as to why the request was suspended. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMoveRequest.md similarity index 81% rename from exchange/exchange-ps/exchange/Suspend-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMoveRequest.md index fc298d21c8..8e0c073d7e 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-publicfoldermoverequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-PublicFolderMoveRequest -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-publicfoldermoverequest +schema: 2.0.0 +title: Suspend-PublicFolderMoveRequest --- # Suspend-PublicFolderMoveRequest @@ -30,7 +31,7 @@ Suspend-PublicFolderMoveRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,13 +45,15 @@ This example suspends the public folder move request \\PublicFolderMove. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the identity of the public folder move request. The default identity is \\PublicFolderMove. ```yaml Type: PublicFolderMoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -69,7 +75,6 @@ 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 Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,13 +102,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,13 +120,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderReplication.md similarity index 85% rename from exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderReplication.md index 8819989303..3a6df6e1ba 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderReplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-publicfolderreplication applicable: Exchange Server 2010 -title: Suspend-PublicFolderReplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-publicfolderreplication +schema: 2.0.0 +title: Suspend-PublicFolderReplication --- # Suspend-PublicFolderReplication @@ -28,7 +29,7 @@ Suspend-PublicFolderReplication [-Confirm] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example stops public folder replication for the organization. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -51,7 +55,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-Queue.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-Queue.md similarity index 83% rename from exchange/exchange-ps/exchange/Suspend-Queue.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-Queue.md index 14102cc59b..b5f271cc28 100644 --- a/exchange/exchange-ps/exchange/Suspend-Queue.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-Queue.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-queue -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-Queue -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-queue +schema: 2.0.0 +title: Suspend-Queue --- # Suspend-Queue @@ -40,9 +41,9 @@ Suspend-Queue [-Identity] ## DESCRIPTION The Suspend-Queue cmdlet stops processing on a queue that has a status of Active or Retry. Messages being processed are delivered, but no additional messages leave the queue. When you use the Identity parameter, the queue is suspended only if the identity matches a single queue. If the identity matches more than one queue, you receive an error. To suspend more than one queue in a single operation, you must use the Filter parameter. -For instructions on how to resume suspended queues, see [Resume-Queue](https://learn.microsoft.com/powershell/module/exchange/resume-queue). +For instructions on how to resume suspended queues, see [Resume-Queue](https://learn.microsoft.com/powershell/module/exchangepowershell/resume-queue). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,13 +64,15 @@ This example suspends processing on all queues on the server Server1.contoso.com ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -87,7 +93,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -106,7 +114,6 @@ 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 Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -131,7 +141,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,13 +150,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-ActiveSyncConnectivity.md similarity index 80% rename from exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ActiveSyncConnectivity.md index 48f24eefda..4f1a49368e 100644 --- a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ActiveSyncConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-activesyncconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ActiveSyncConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-activesyncconnectivity +schema: 2.0.0 +title: Test-ActiveSyncConnectivity --- # Test-ActiveSyncConnectivity @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-ActiveSyncConnectivity cmdlet to test connectivity to Microsoft Exchange ActiveSync virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet is replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -58,7 +59,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-ActiveSyncConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EAS Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,6 +80,9 @@ This example tests the Exchange ActiveSync connectivity for the mailbox PaulS us ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -94,7 +98,6 @@ You can't use this parameter with the Url parameter. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -URL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The URL parameter specifies the URL that's used to connect to the Exchange ActiveSync virtual directory. You can't use this parameter with the ClientAccessServer parameter. @@ -112,7 +118,6 @@ You can't use this parameter with the ClientAccessServer parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -AllowUnsecureAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AllowUnsecureAccess switch allows the test to continue over an unsecured channel that doesn't require Secure Sockets Layer (SSL). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -147,7 +157,6 @@ 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 Required: False Position: Named @@ -157,13 +166,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LightMode switch tells the command to perform only a subset of the tests. You don't need to specify a value with this switch. When you use this switch, only the Options test is run. @@ -183,7 +197,6 @@ If you don't use this switch, the First Sync, GetItemEstimate, Sync Data, Ping a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -201,7 +217,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,6 +226,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -226,7 +244,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -244,7 +264,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,13 +273,15 @@ Accept wildcard characters: False ``` ### -MonitoringInstance -The MonitoringInstance parameter specifies an identifier for this task when the test is run from Microsoft System Center Operations Manager (SCOM). This parameter is important because SCOM may run multiple instances of the test from the same server at the same time. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The MonitoringInstance parameter specifies an identifier for this task when the test is run from Microsoft System Center Operations Manager (SCOM). This parameter is important because SCOM might run multiple instances of the test from the same server at the same time. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,6 +291,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -278,7 +302,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -288,13 +311,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Timeout parameter specifies the amount of time (in seconds) to wait for a response from the command. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,6 +329,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -312,7 +340,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,13 +349,15 @@ Accept wildcard characters: False ``` ### -UseAutodiscoverForClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseAutodiscoverForClientAccessServer switch specifies whether the test should use the Autodiscover service to locate the Exchange ActiveSync virtual directory. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -338,13 +367,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Test-ApplicationAccessPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ApplicationAccessPolicy.md index 24d8280b0b..ec8f3c76ba 100644 --- a/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ApplicationAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection -title: Test-ApplicationAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-applicationaccesspolicy +schema: 2.0.0 +title: Test-ApplicationAccessPolicy --- # Test-ApplicationAccessPolicy @@ -28,7 +29,7 @@ Test-ApplicationAccessPolicy [-Identity] -AppId ## DESCRIPTION This feature applies only to apps connecting to the Microsoft Graph API for Outlook resources. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example tests access to the user RandomUser9911@AppPolicyTest2.com for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the recipient to test. You can use any value that uniquely identifies the recipient. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the recipient to test. You can use any value th Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -AppId + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID of the app that you want to test. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. You can specify multiple app GUID values separated by commas. @@ -79,7 +85,6 @@ You can specify multiple app GUID values separated by commas. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-ArchiveConnectivity.md similarity index 81% rename from exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ArchiveConnectivity.md index 219f178aa0..07d2cfe24b 100644 --- a/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ArchiveConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-archiveconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ArchiveConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-archiveconnectivity +schema: 2.0.0 +title: Test-ArchiveConnectivity --- # Test-ArchiveConnectivity @@ -32,7 +33,7 @@ Test-ArchiveConnectivity [-UserSmtp] ## DESCRIPTION Running the Test-ArchiveConnectivity cmdlet validates connectivity to a user's archive mailbox. End-to-end verification includes testing whether an on-premises or cloud-based archive is provisioned for the on-premises mailbox user and whether it's enabled and logging on to the archive mailbox on behalf of the user. Successful completion of the command indicates that processes such as the Managed Folder Assistant and Outlook on the web are able to successfully access the archive mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +54,15 @@ This command retrieves mailboxes that have a cloud-based archive provisioned and ## PARAMETERS ### -UserSmtp + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UserSmtp parameter specifies the SMTP address of the mailbox. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -78,7 +84,6 @@ 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 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -IncludeArchiveMRMConfiguration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeArchiveMRMConfiguration switch retrieves retention tags that are provisioned in the user's archive mailbox and the last time the archive was processed by the Managed Folder Assistant. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-AssistantHealth.md b/exchange/exchange-ps/ExchangePowerShell/Test-AssistantHealth.md similarity index 79% rename from exchange/exchange-ps/exchange/Test-AssistantHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Test-AssistantHealth.md index 95868838da..9ef180021a 100644 --- a/exchange/exchange-ps/exchange/Test-AssistantHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-AssistantHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-assistanthealth -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-AssistantHealth -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-assistanthealth +schema: 2.0.0 +title: Test-AssistantHealth --- # Test-AssistantHealth @@ -37,7 +38,7 @@ The Mailbox Assistants service runs on all servers that have the Mailbox server By default, when you run this cmdlet, it returns the RunspaceId, events, and performance counters in a table format. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example detects the mailbox assistant's health on the local Mailbox server. ## PARAMETERS ### -ServerName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ServerName parameter specifies the Mailbox server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -71,7 +75,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -90,7 +96,6 @@ 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 Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -IncludeCrashDump + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeCrashDump switch specifies that the command should take an error report prior to taking any recovery actions. You don't need to specify a value with this switch. You should only use this switch on the local computer. If you use this switch while connected remotely, the command will fail. @@ -108,7 +116,6 @@ You should only use this switch on the local computer. If you use this switch wh Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -MaxProcessingTimeInMinutes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxProcessingTimeInMinutes parameter specifies the maximum amount of time the MSExchangeMailboxAssistants service is allowed to process an event without responding. You can specify a value from 1 through 3600 minutes. The default value is 15 minutes. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -142,7 +154,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -ResolveProblems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This ResolveProblems switch specifies that if the command detects an issue, it attempts to fix it. You don't need to specify a value with this switch. This command attempts to fix the following issues: @@ -163,7 +177,6 @@ This command attempts to fix the following issues: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,7 +186,10 @@ Accept wildcard characters: False ``` ### -WatermarkBehindWarningThreholdInMinutes -The WatermarkBehindWarningThreholdInMinutes parameter specifies the threshold for watermark age. Event watermarks indicate the last time that events were successfully processed by an assistant. An event watermark that hasn't been updated in a while may indicate a problem. For each Mailbox Assistant, the Test-AssistantHealth cmdlet compares the current time with the time stamp of the last event watermark to determine the watermark age. If that age exceeds the value set by the WatermarkBehindWarningThreholdInMinutes parameter, a warning is generated. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The WatermarkBehindWarningThreholdInMinutes parameter specifies the threshold for watermark age. Event watermarks indicate the last time that events were successfully processed by an assistant. An event watermark that hasn't been updated in a while might indicate a problem. For each Mailbox Assistant, the Test-AssistantHealth cmdlet compares the current time with the time stamp of the last event watermark to determine the watermark age. If that age exceeds the value set by the WatermarkBehindWarningThreholdInMinutes parameter, a warning is generated. You can specify a value from 1 through 10080 minutes. The default value is 60 minutes. @@ -181,7 +197,6 @@ You can specify a value from 1 through 10080 minutes. The default value is 60 mi Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +206,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-CalendarConnectivity.md similarity index 81% rename from exchange/exchange-ps/exchange/Test-CalendarConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-CalendarConnectivity.md index c2836a32a6..f7db94b064 100644 --- a/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-CalendarConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-calendarconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-CalendarConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-calendarconnectivity +schema: 2.0.0 +title: Test-CalendarConnectivity --- # Test-CalendarConnectivity @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-CalendarConnectivity cmdlet to verify that anonymous calendar sharing is enabled and working properly. The Calendar virtual directory is a subdirectory of the Microsoft Outlook on the web virtual directories. When you run this command without any parameters, the command tests calendar connectivity against all Outlook on the web virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet is replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -58,7 +59,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-CalendarConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\Calendar Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,6 +73,9 @@ This example tests the anonymous calendar sharing for the server named MBX01. ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -85,7 +89,6 @@ You can use any value that uniquely identifies the server. For example: Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -104,7 +110,6 @@ 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 Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of this command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -161,7 +173,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +182,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -179,7 +193,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,6 +202,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -197,7 +213,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,13 +222,15 @@ Accept wildcard characters: False ``` ### -TestType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TestType parameter specifies whether the command tests internal or external URLs. Values are Internal and External. The default value is Internal. ```yaml Type: OwaConnectivityTestType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -223,13 +240,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of this command. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,13 +258,15 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of this command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +276,9 @@ Accept wildcard characters: False ``` ### -VirtualDirectoryName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The VirtualDirectoryName parameter specifies the name of the Outlook on the web virtual directory that you want to test. Enclose values that contain spaces in quotation marks ("). If you don't use this parameter, all available Outlook on the web virtual directories are tested. @@ -263,7 +287,6 @@ If you don't use this parameter, all available Outlook on the web virtual direct Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,13 +296,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Test-ClientAccessRule.md similarity index 80% rename from exchange/exchange-ps/exchange/Test-ClientAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ClientAccessRule.md index 3389d80031..c6cb852390 100644 --- a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ClientAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-clientaccessrule -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Test-ClientAccessRule -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-clientaccessrule +schema: 2.0.0 +title: Test-ClientAccessRule --- # Test-ClientAccessRule @@ -15,7 +16,7 @@ ms.reviewer: > [!NOTE] > Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). -This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Test-ClientAccessRule cmdlet to test how client access rules affect access to your organization. If any of the client properties you specify for this cmdlet match any client access rules, the rules are returned in the results. @@ -41,7 +42,7 @@ Client access rules are like mail flow rules (also known as transport rules) for - RemotePowerShell:BasicAuthentication and NonBasicAuthentication. - ExchangeActiveSync:BasicAuthentication, OAuthAuthentication, and CertificateBasedAuthentication. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,6 +62,9 @@ This example tests client access by using the following client properties: ## PARAMETERS ### -AuthenticationType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The AuthenticationType parameter specifies the client authentication type to test. Valid values for this parameter are: @@ -77,7 +81,6 @@ In client access rules, authentication types are defined by the AnyOfAuthenticat Type: ClientAccessAuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Protocol + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Protocol parameter specifies the client protocol to test. Valid values for this parameter are: @@ -109,7 +115,6 @@ In client access rules, protocol types are defined by the AnyOfProtocols and Exc Type: ClientAccessProtocol Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -RemoteAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RemoteAddress parameter specifies the client IP address to test. Valid input for this parameter is an IP address. For example, 192.168.1.50. In client access rules, IP addresses are defined by the AnyOfClientIPAddressesOrRanges and ExceptAnyOfClientIPAddressesOrRanges parameters. @@ -127,7 +135,6 @@ In client access rules, IP addresses are defined by the AnyOfClientIPAddressesOr Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -137,13 +144,15 @@ Accept wildcard characters: False ``` ### -RemotePort + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The RemotePort parameter specifies the client TCP port to test. Valid input for this parameter is an integer from 1 to 65535. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The User parameter specifies the user account to test. For the best results, we recommend using the following values: @@ -179,7 +191,6 @@ In client access rules, users are defined by the UsernameMatchesAnyOfPatterns, U Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -189,6 +200,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -198,7 +212,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,13 +221,15 @@ Accept wildcard characters: False ``` ### -OAuthClaims + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The OAuthClaims parameter specifies the OAuth claims token of a middle-tier app. ```yaml Type: Hashtable Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -224,13 +239,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-DataClassification.md b/exchange/exchange-ps/ExchangePowerShell/Test-DataClassification.md similarity index 77% rename from exchange/exchange-ps/exchange/Test-DataClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Test-DataClassification.md index 7d9109fd68..5126151cb5 100644 --- a/exchange/exchange-ps/exchange/Test-DataClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-DataClassification.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-dataclassification -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance -title: Test-DataClassification -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-dataclassification +schema: 2.0.0 +title: Test-DataClassification --- # Test-DataClassification ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Test-DataClassification cmdlet to find the confidence and count of a sensitive information type that's found in a specified text string. @@ -33,7 +34,7 @@ Test-DataClassification ## DESCRIPTION This cmdlet lets you know the classification results that are returned by the Microsoft classification engine in specific text. The classification results include the sensitive type, its count, and confidence. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example lists all sensitive info types, their count, and confidence in the ## PARAMETERS ### -ClassificationNames + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + The ClassificationNames parameter specifies the sensitive information type that you want to find in the text specified by the TextToClassify parameter. Valid values are: - Name @@ -60,7 +64,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Security & Compliance + 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. @@ -78,7 +84,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -FileExtension + +> Applicable: Exchange Online, Security & Compliance + This parameter is available only in the cloud-based service. {{ Fill FileExtension Description }} @@ -96,7 +104,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -TestTextExtractionResults + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + The TestTextExtractionResults parameter specifies the extracted text from the Test-TextExtraction cmdlet as the input text stream. ```yaml Type: TestTextExtractionResult[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -TextToClassify + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + The TextToClassify parameter specifies the text string for which classification results need to be shown. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-EcpConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-EcpConnectivity.md similarity index 80% rename from exchange/exchange-ps/exchange/Test-EcpConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-EcpConnectivity.md index 81cf892ecd..e9a4a9e8e6 100644 --- a/exchange/exchange-ps/exchange/Test-EcpConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-EcpConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-ecpconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-EcpConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-ecpconnectivity +schema: 2.0.0 +title: Test-EcpConnectivity --- # Test-EcpConnectivity @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-EcpConnectivity cmdlet to test connectivity to Exchange Control Panel (ECP) virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet is replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -57,7 +58,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-EcpConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EAC Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,6 +72,9 @@ This example tests user connectivity to the Exchange admin center on Server01. ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -84,7 +88,6 @@ You can use any value that uniquely identifies the server. For example: Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -103,7 +109,6 @@ 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 Required: False Position: Named @@ -113,13 +118,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +136,15 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of this command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -160,7 +172,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -178,7 +192,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -196,7 +212,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -RSTEndpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,13 +239,15 @@ Accept wildcard characters: False ``` ### -TestType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TestType parameter specifies whether the command tests internal or external URLs. Values are Internal and External. The default value is Internal. ```yaml Type: OwaConnectivityTestType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,13 +257,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. The default value for the Timeout parameter is 30 seconds. You must specify a time-out value greater than 0 seconds and less than 1 hour (3,600 seconds). We recommend that you always configure this parameter with a value of 5 seconds or more. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,6 +275,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -262,7 +286,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -272,6 +295,9 @@ Accept wildcard characters: False ``` ### -VirtualDirectoryName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The VirtualDirectoryName parameter specifies the name of the EAC virtual directory that you want to test. Enclose values that contain spaces in quotation marks ("). If you don't use this parameter, all available EAC virtual directories are tested. @@ -280,7 +306,6 @@ If you don't use this parameter, all available EAC virtual directories are teste Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -290,13 +315,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md b/exchange/exchange-ps/ExchangePowerShell/Test-EdgeSynchronization.md similarity index 78% rename from exchange/exchange-ps/exchange/Test-EdgeSynchronization.md rename to exchange/exchange-ps/ExchangePowerShell/Test-EdgeSynchronization.md index 8f9a1e1fb9..2565e0d1c4 100644 --- a/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-EdgeSynchronization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-edgesynchronization -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-EdgeSynchronization -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-edgesynchronization +schema: 2.0.0 +title: Test-EdgeSynchronization --- # Test-EdgeSynchronization @@ -43,11 +44,11 @@ Test-EdgeSynchronization [-ExcludeRecipientTest] ``` ## DESCRIPTION -The Test-EdgeSynchronization cmdlet is a diagnostic cmdlet that provides a report of the synchronization status of subscribed Edge Transport servers. You can use the VerifyRecipient parameter with this cmdlet to verify that a single recipient has been synchronized to the Active Directory Lightweight Directory Services (AD LDS) instance. The Edge Subscription process establishes one-way replication of recipient and configuration information from Active Directory to AD LDS. +The Test-EdgeSynchronization cmdlet is a diagnostic cmdlet that provides a report of the synchronization status of subscribed Edge Transport servers. You can use the VerifyRecipient parameter with this cmdlet to verify that a single recipient is synchronized to the Active Directory Lightweight Directory Services (AD LDS) instance. The Edge Subscription process establishes one-way replication of recipient and configuration information from Active Directory to AD LDS. This cmdlet compares the data stored in Active Directory and the data stored in AD LDS. Any inconsistencies in data are reported in the results output by this cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,13 +69,15 @@ This example verifies the synchronization status of the single recipient kate@co ## PARAMETERS ### -VerifyRecipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The VerifyRecipient parameter specifies a single recipient with which to verify the synchronization status. You identify the recipient by specifying a proxy address assigned to the recipient. The proxy address is the recipient's email address. The recipient verification test is mutually exclusive of the test that verifies synchronization of configuration data. ```yaml Type: ProxyAddress Parameter Sets: SingleValidation Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -93,7 +99,6 @@ 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 Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -ExcludeRecipientTest + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExcludeRecipientTest switch specifies whether to exclude validation of recipient data synchronization. You don't need to specify a value with this switch. If you use this switch, only the synchronization of configuration objects is validated. Validating that recipient data is synchronized takes longer than validating only configuration data. @@ -127,7 +137,6 @@ If you use this switch, only the synchronization of configuration objects is val Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -FullCompareMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FullCompareMode switch specifies whether a full comparison of the configuration data between Active Directory and AD LDS instance on the target Edge Transport server is performed. You don't need to specify a value with this switch. If you don't use this switch, a full comparison of replicated configuration data is skipped and the command only tests the Edge synchronization by verifying the replication cookie. @@ -145,7 +157,6 @@ If you don't use this switch, a full comparison of replicated configuration data Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -MaxReportSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxReportSize parameter specifies the total number of objects and properties listed in the results. The results output by this command include a list of all out-of-sync objects and properties in both AD LDS and Active Directory. If the directory services aren't synchronized, a large amount of data can result. If you don't specify a value for this parameter, the default value of 1,000 is used. The minimum value for this parameter is 1. The maximum value for this parameter is unlimited. ```yaml Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,16 +184,18 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). -- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. +- $false: Monitoring events and performance counters aren't included in the command results. This value is the default. ```yaml Type: Boolean Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,15 +205,17 @@ Accept wildcard characters: False ``` ### -TargetServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetServer parameter specifies an Edge Transport server to initiate edge synchronization with. If omitted, all Edge Transport servers are synchronized. -You may want to use this parameter to specify a single Edge Transport server for synchronization if a new Edge Transport server has been installed or if that Edge Transport server has been unavailable for some time. +You might want to use this parameter to specify a single Edge Transport server for synchronization if a new Edge Transport server is installed or if that Edge Transport server is unavailable for some time. ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,13 +225,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ExchangeSearch.md b/exchange/exchange-ps/ExchangePowerShell/Test-ExchangeSearch.md similarity index 83% rename from exchange/exchange-ps/exchange/Test-ExchangeSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ExchangeSearch.md index de07b2a9a7..ea1a930da9 100644 --- a/exchange/exchange-ps/exchange/Test-ExchangeSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ExchangeSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-exchangesearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ExchangeSearch -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-exchangesearch +schema: 2.0.0 +title: Test-ExchangeSearch --- # Test-ExchangeSearch @@ -59,7 +60,7 @@ The Test-ExchangeSearch cmdlet creates a hidden message and an attachment in the You can use the Verbose switch to get detailed information about each step performed by the cmdlet as part of the test. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,6 +81,9 @@ This example tests Exchange Search results for the mailbox database on which the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox that you want to test Exchange Search against. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -99,7 +103,6 @@ You can't use this parameter with the MailboxDatabase or Server parameters. Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -109,13 +112,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Archive switch specifies that the test is run against the archive mailbox for the mailbox user specified by the Identity parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -134,7 +142,6 @@ 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 Required: False Position: Named @@ -144,13 +151,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,13 +169,15 @@ Accept wildcard characters: False ``` ### -IndexingTimeoutInSeconds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IndexingTimeoutInSeconds parameter specifies, in seconds, the maximum amount of time to wait between adding the new email message to the test mailbox and waiting for it to be returned in a search result. The default value is 120 seconds. If this parameter isn't specified, the default interval is used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -MailboxDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010 and 2013. The MailboxDatabase parameter specifies the mailbox database to test Exchange Search against. You can use any value that uniquely identifies the database. For example: @@ -190,7 +204,6 @@ You can't use this parameter with the Identity or Server parameters. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,6 +213,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -208,7 +224,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -218,6 +233,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server for the recipient that you want to test Exchange Search against. You can use any value that uniquely identifies the server. For example: - Name @@ -231,7 +249,6 @@ You can't use this parameter with the MailboxDatabase or Identity parameters. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,13 +258,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-FederationTrust.md b/exchange/exchange-ps/ExchangePowerShell/Test-FederationTrust.md similarity index 82% rename from exchange/exchange-ps/exchange/Test-FederationTrust.md rename to exchange/exchange-ps/ExchangePowerShell/Test-FederationTrust.md index d8910cf09d..eaf1f69594 100644 --- a/exchange/exchange-ps/exchange/Test-FederationTrust.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-FederationTrust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-federationtrust -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-FederationTrust -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-federationtrust +schema: 2.0.0 +title: Test-FederationTrust --- # Test-FederationTrust @@ -42,7 +43,7 @@ The Test-FederationTrust cmdlet runs the following series of tests to ensure tha - Certificates are checked to ensure they're valid and can be used with the Microsoft Federation Gateway. - A security token is requested from the Microsoft Federation Gateway. This test ensures that a token can be properly retrieved and used. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,6 +57,9 @@ This example validates the federation trust deployed in the Exchange organizatio ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -65,7 +69,6 @@ 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 Required: False Position: Named @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,16 +96,18 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). -- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. +- $false: Monitoring events and performance counters aren't included in the command results. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -UserIdentity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UserIdentity parameter specifies a mailbox user to request a token for. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +135,6 @@ If you don't specify a mailbox, the command uses the default test mailbox. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Test-FederationTrustCertificate.md similarity index 80% rename from exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Test-FederationTrustCertificate.md index d26350dd00..781666803b 100644 --- a/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-FederationTrustCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-federationtrustcertificate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-FederationTrustCertificate -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-federationtrustcertificate +schema: 2.0.0 +title: Test-FederationTrustCertificate --- # Test-FederationTrustCertificate @@ -30,7 +31,7 @@ Test-FederationTrustCertificate [-Confirm] ## DESCRIPTION The certificate used to establish a federation trust is propagated to all Exchange servers in the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example reports the status of federation certificates. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -53,7 +57,6 @@ 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 Required: False Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Test-IPAllowListProvider.md similarity index 86% rename from exchange/exchange-ps/exchange/Test-IPAllowListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Test-IPAllowListProvider.md index 4b2de63622..6c5899366a 100644 --- a/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-IPAllowListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-ipallowlistprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-IPAllowListProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-ipallowlistprovider +schema: 2.0.0 +title: Test-IPAllowListProvider --- # Test-IPAllowListProvider @@ -46,6 +47,9 @@ This example tests the existing IP Allow list provider named Contoso,com by send ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the IP Allow list provider that you want to test. You can use any value that uniquely identifies the IP Allow list provider. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the IP Allow list provider that you want to tes Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddress parameter specifies an IP address to be used in testing the IP Allow list provider. You need to use a known allowed IP address. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -91,7 +99,6 @@ 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 Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -109,7 +119,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -134,7 +146,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Test-IPBlockListProvider.md similarity index 86% rename from exchange/exchange-ps/exchange/Test-IPBlockListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Test-IPBlockListProvider.md index 7ab51aad23..dbfb72bf09 100644 --- a/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-IPBlockListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-ipblocklistprovider -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-IPBlockListProvider -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-ipblocklistprovider +schema: 2.0.0 +title: Test-IPBlockListProvider --- # Test-IPBlockListProvider @@ -46,6 +47,9 @@ This example tests the existing IP Block list provider named Contoso.com by send ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the IP Block list provider that you want to test. You can use any value that uniquely identifies the IP Block list provider. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the IP Block list provider that you want to tes Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddress parameter specifies an IP address to be used in testing the IP Block list provider. You need to use a known blocked IP address. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -91,7 +99,6 @@ 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 Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -109,7 +119,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -134,7 +146,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-IRMConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Test-IRMConfiguration.md similarity index 78% rename from exchange/exchange-ps/exchange/Test-IRMConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Test-IRMConfiguration.md index c3b0a5ae4e..9d4926513f 100644 --- a/exchange/exchange-ps/exchange/Test-IRMConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-IRMConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-irmconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Test-IRMConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-irmconfiguration +schema: 2.0.0 +title: Test-IRMConfiguration --- # Test-IRMConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Test-IRMConfiguration cmdlet to test Information Rights Management (IRM) configuration and functionality. @@ -33,7 +34,7 @@ Test-IRMConfiguration [[-Identity] ] -Sender Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -62,7 +66,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Sender parameter specifies the email address of the sender to test. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -97,7 +105,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -115,7 +125,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -Recipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Recipient parameter specifies the email address of the recipient to test. You can specify multiple email addresses separated by commas. This parameter is required in the cloud-based service. @@ -135,7 +147,6 @@ In on-premises Exchange, if you don't use this parameter, the sender address tha Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -145,6 +156,9 @@ Accept wildcard characters: False ``` ### -RMSOnline + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RMSOnline switch specifies whether to test connectivity from Exchange Online to RMS Online, obtain your Exchange Online organization's TPD, and test its validity. You don't need to specify a value with this switch. @@ -153,7 +167,6 @@ The RMSOnline switch specifies whether to test connectivity from Exchange Online Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ImapConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-ImapConnectivity.md similarity index 83% rename from exchange/exchange-ps/exchange/Test-ImapConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ImapConnectivity.md index 44bf2c9053..47fd7ae231 100644 --- a/exchange/exchange-ps/exchange/Test-ImapConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ImapConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-imapconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ImapConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-imapconnectivity +schema: 2.0.0 +title: Test-ImapConnectivity --- # Test-ImapConnectivity @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-ImapConnectivity cmdlet to verify that connectivity to the Microsoft Exchange IMAP4 service is working as expected. -**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet is replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -58,7 +59,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-IMAPConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\IMAP Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). **Note**: In Exchange 2013 or later, when you run this command to test a single mailbox on an Exchange server that isn't hosting the active mailbox database copy for the mailbox, you might see the following error message: @@ -85,6 +86,9 @@ This example tests the client IMAP4 connectivity of the server named Contoso12 a ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -98,7 +102,6 @@ You can use any value that uniquely identifies the server. For example: Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -117,7 +123,6 @@ 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 Required: False Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -ConnectionType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectionType parameter specifies the type of connection that's used to connect to the IMAP4 service. Valid values are: - Plaintext @@ -137,7 +145,6 @@ The ConnectionType parameter specifies the type of connection that's used to con Type: ProtocolConnectionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +154,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LightMode switch tells the command to perform only a test logon to the server by using the IMAP4 protocol. You don't need to specify a value with this switch. If you don't use this switch, the command also tests sending and receiving a message using the IMAP4 protocol. @@ -171,7 +183,6 @@ If you don't use this switch, the command also tests sending and receiving a mes Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -189,7 +203,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,6 +212,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -214,7 +230,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,6 +239,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -232,7 +250,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -242,6 +259,9 @@ Accept wildcard characters: False ``` ### -PerConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PerConnectionTimeout parameter specifies the amount of time, in seconds, to wait per connection for the test operation to finish. Valid values are between 0 and 120 seconds. The default value is 120 seconds. We recommend that you configure this parameter with a value of 5 seconds or more. @@ -250,7 +270,6 @@ We recommend that you configure this parameter with a value of 5 seconds or more Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,13 +279,15 @@ Accept wildcard characters: False ``` ### -PortClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PortClientAccessServer parameter specifies the port to use to connect to the Client Access server. The default port is 143 for IMAP4. The valid range is from 0 through 65,535. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,6 +297,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -284,7 +308,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -294,6 +317,9 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. Valid values are between 0 and 3600 seconds (1 hour). The default value is 180 seconds (3 minutes). We recommend that you configure this parameter with a value of 5 seconds or more. @@ -302,7 +328,6 @@ We recommend that you configure this parameter with a value of 5 seconds or more Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -312,6 +337,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -320,7 +348,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -330,13 +357,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Test-M365DataAtRestEncryptionPolicy.md similarity index 83% rename from exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Test-M365DataAtRestEncryptionPolicy.md index f166b0c365..f6dcd67b34 100644 --- a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-M365DataAtRestEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-m365dataatrestencryptionpolicy applicable: Exchange Online, Exchange Online Protection -title: Test-M365DataAtRestEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-m365dataatrestencryptionpolicy +schema: 2.0.0 +title: Test-M365DataAtRestEncryptionPolicy --- # Test-M365DataAtRestEncryptionPolicy @@ -29,7 +30,7 @@ Test-M365DataAtRestEncryptionPolicy [[-Identity] Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 data-at-rest encryption policy that you want to test. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ You can find the existing data-at-rest encryption policies by using the Get-M365 Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-MAPIConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-MAPIConnectivity.md similarity index 82% rename from exchange/exchange-ps/exchange/Test-MAPIConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-MAPIConnectivity.md index 0b615b567c..cfd7f7fb0e 100644 --- a/exchange/exchange-ps/exchange/Test-MAPIConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-MAPIConnectivity.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-mapiconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-MAPIConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-mapiconnectivity +schema: 2.0.0 +title: Test-MAPIConnectivity --- # Test-MAPIConnectivity ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Test-MapiConnectivity cmdlet to verify server functionality by logging on to the mailbox that you specify. If you don't specify a mailbox, the cmdlet logs on to the SystemMailbox on the database that you specify. @@ -74,7 +75,7 @@ There are three distinct parameters that you can use with the command: Database, - The Identity parameter takes a mailbox identity and tests the ability to log on to a specific mailbox. - The Server parameter takes a server identity and tests the ability to log on to each system mailbox on the specified server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -95,6 +96,9 @@ This example tests connectivity to a mailbox, specified as a domain name and use ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies a mailbox to test. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -118,7 +122,6 @@ You can't use the Identity, Database, or Server parameters in the same command. Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -128,6 +131,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The Database parameter specifies the database on which to test the connectivity to the system mailbox. You can use any value that uniquely identifies the database. For example: @@ -144,7 +150,6 @@ You can't use the Identity, Database, or Server parameters in the same command. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -154,6 +159,9 @@ Accept wildcard characters: False ``` ### -ActiveDirectoryTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The ActiveDirectoryTimeout parameter specifies the amount of time, in seconds, allowed for each Active Directory operation to complete before the operation times out. The default value is 15 seconds. @@ -162,7 +170,6 @@ The ActiveDirectoryTimeout parameter specifies the amount of time, in seconds, a Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +179,9 @@ Accept wildcard characters: False ``` ### -AllConnectionsTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The AllConnectionsTimeout parameter specifies the amount of time, in seconds, allowed for all connections to complete before the cmdlet times out. The time-out countdown doesn't begin until all information necessary to perform the connections is gathered from Active Directory.The default value is 90 seconds. @@ -180,7 +190,6 @@ The AllConnectionsTimeout parameter specifies the amount of time, in seconds, al Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,6 +199,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Archive switch specifies whether to test the MAPI connectivity of the personal archive that's associated with the specified mailbox. You don't need to specify a value with this switch. If you don't use this switch, only the primary mailbox is tested. @@ -198,7 +210,6 @@ If you don't use this switch, only the primary mailbox is tested. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,6 +219,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -217,7 +231,6 @@ 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 Required: False Position: Named @@ -227,6 +240,9 @@ Accept wildcard characters: False ``` ### -CopyOnServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The CopyOnServer parameter specifies the Mailbox server that holds the specific database copy to test. You can use any value that uniquely identifies the server. For example: @@ -242,7 +258,6 @@ You can only use this parameter with the Server parameter, not the Identify or D Type: ServerIdParameter Parameter Sets: Database, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,6 +267,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -260,7 +278,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,6 +287,9 @@ Accept wildcard characters: False ``` ### -IncludePassive + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The IncludePassive switch tests MAPI connectivity from all active and passive database copies. You don't need to specify a value with this switch. @@ -280,7 +300,6 @@ If you don't use this switch, the command tests MAPI connectivity from active da Type: SwitchParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -290,18 +309,20 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). -- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. +- $false: Monitoring events and performance counters aren't included in the command results. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -311,6 +332,9 @@ Accept wildcard characters: False ``` ### -PerConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. The PerConnectionTimeout parameter specifies the amount of time, in seconds, allowed for each connection to complete before the connection times out. The default value is 10 seconds. @@ -319,7 +343,6 @@ The PerConnectionTimeout parameter specifies the amount of time, in seconds, all Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -329,9 +352,12 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. -The Server parameter specifies the server on which you will test the MAPI connectivity. The command tests the MAPI connectivity to each system mailbox hosted on active databases on the specified server. You can use any value that uniquely identifies the server. For example: +The Server parameter specifies the server to test MAPI connectivity on. The command tests the MAPI connectivity to each system mailbox hosted on active databases on the specified server. You can use any value that uniquely identifies the server. For example: - Name - FQDN @@ -346,7 +372,6 @@ You can't use the Identity, Database, or Server parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +381,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-MRSHealth.md b/exchange/exchange-ps/ExchangePowerShell/Test-MRSHealth.md similarity index 83% rename from exchange/exchange-ps/exchange/Test-MRSHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Test-MRSHealth.md index c4208ccf1f..d5513b2862 100644 --- a/exchange/exchange-ps/exchange/Test-MRSHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-MRSHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-mrshealth -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-MRSHealth -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-mrshealth +schema: 2.0.0 +title: Test-MRSHealth --- # Test-MRSHealth @@ -35,7 +36,7 @@ Test-MRSHealth [[-Identity] ] ## DESCRIPTION The Microsoft Exchange Mailbox Replication service runs on Mailbox servers. This command ensures that the Mailbox Replication service is running and that it responds to a remote procedure call (RPC) ping check. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,6 +57,9 @@ This example tests the health of the Mailbox Replication service on the Mailbox ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the server on which to perform the health test. You can use any value that uniquely identifies the server. For example: - Name @@ -69,7 +73,6 @@ If you don't specify the server, the command runs on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -88,7 +94,6 @@ 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 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -MaxQueueScanAgeSeconds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaxQueueScanAgeSeconds parameter specifies the threshold for the last queue scan property. If the time stamp on the last queue scan property is older than the value specified by this parameter, an error event is created that shows the Mailbox Replication service isn't scanning mailbox database queues. The default value is 1800 seconds (30 minutes). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,16 +139,18 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). -- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. +- $false: Monitoring events and performance counters aren't included in the command results. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -MRSProxyCredentials + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MRSProxyCredentials parameter specifies the credentials that are required for the MRSProxyPingCheck test on the server that's specified by the MRSProxyServer parameter. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -157,7 +171,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,6 +180,9 @@ Accept wildcard characters: False ``` ### -MRSProxyServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MRSProxyServer parameter specifies the fully qualified domain name (FQDN) of the target server for the MRSProxyPingCheck test. The Microsoft Replication proxy service is part of the Mailbox Replication service, and is used for remote mailbox moves. However, the Mailbox Replication proxy service communicates only with the Mailbox Replication service on another server. You can test the Mailbox Replication proxy service in the following ways: @@ -179,7 +195,6 @@ The Microsoft Replication proxy service is part of the Mailbox Replication servi Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,13 +204,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-Mailflow.md b/exchange/exchange-ps/ExchangePowerShell/Test-Mailflow.md similarity index 84% rename from exchange/exchange-ps/exchange/Test-Mailflow.md rename to exchange/exchange-ps/ExchangePowerShell/Test-Mailflow.md index 628848623e..02e216dd65 100644 --- a/exchange/exchange-ps/exchange/Test-Mailflow.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-Mailflow.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-mailflow -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-Mailflow -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-mailflow +schema: 2.0.0 +title: Test-Mailflow --- # Test-Mailflow @@ -114,7 +115,7 @@ The Test-Mailflow results are displayed on-screen. The interesting values in the You can write the Test-Mailflow results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding ` > ` to the command. For example: `Test-Mailflow -AutoDiscoverTargetMailboxServer | ConvertTo-Csv > "C:\My Documents\test-mailflow 2020-05-01.csv"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -123,7 +124,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Test-Mailflow Mailbox1 -TargetMailboxServer Mailbox2 ``` -This example tests message flow from the server name Mailbox1 to the server named Mailbox2. Note that you need to run this command while connected to Mailbox1. +This example tests message flow from the server name Mailbox1 to the server named Mailbox2. You need to run this command while connected to Mailbox1. ### Example 2 ```powershell @@ -135,6 +136,9 @@ This example tests message flow from the local Mailbox server where you're runni ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the source Mailbox server name from which a test message is sent. You can use any value that uniquely identifies the server. For example: - Name @@ -148,7 +152,6 @@ If you don't use this parameter, the local Mailbox server is used. Type: ServerIdParameter Parameter Sets: AutoDiscoverTargetMailboxServer, TargetDatabase, TargetEmailAddress, TargetMailboxServer, SourceServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -158,6 +161,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverTargetMailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDiscoverTargetMailboxServer switch specifies whether to automatically populate a list of target Mailbox servers to which to send a test message. You don't need to specify a value with this switch. The task queries Active Directory to discover all Mailbox servers and then sends each server a test message. @@ -168,7 +174,6 @@ When you use this switch, you can't use the CrossPremises, TargetDatabase, Targe Type: SwitchParameter Parameter Sets: AutoDiscoverTargetMailboxServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -178,7 +183,10 @@ Accept wildcard characters: False ``` ### -CrossPremises -The CrossPremises parameter specifies whether the mail flow test will be conducted in cross-premises mode. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The CrossPremises parameter specifies whether the mail flow test is conducted in cross-premises mode. Set this parameter to $true if your organization is using a cross-premises deployment and you want to verify cross-premises mail flow. @@ -188,7 +196,6 @@ When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, Type: Boolean Parameter Sets: CrossPremises Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -198,6 +205,9 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetDatabase parameter specifies the mailbox database to which test messages are sent. You can use any value that uniquely identifies the database. For example: - Name @@ -210,7 +220,6 @@ You can't use this parameter with the AutoDiscoverTargetMailboxServer, CrossPrem Type: DatabaseIdParameter Parameter Sets: TargetDatabase Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -220,6 +229,9 @@ Accept wildcard characters: False ``` ### -TargetEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetEmailAddress parameter specifies the SMTP address of the mailbox to which test messages are sent. Use this parameter to send test messages to a Mailbox server in a remote forest. If this parameter is used, the test is always a remote test. When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, CrossPremises, TargetDatabase or TargetMailboxServer parameters. @@ -228,7 +240,6 @@ When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, Type: String Parameter Sets: TargetEmailAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -238,6 +249,9 @@ Accept wildcard characters: False ``` ### -TargetMailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetMailboxServer parameter specifies one or more Mailbox servers in the local Exchange organization to send test messages to. You can use any value that uniquely identifies the server. For example: - Name @@ -251,7 +265,6 @@ When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, Type: ServerIdParameter Parameter Sets: TargetMailboxServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -261,13 +274,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectoryTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveDirectoryTimeout parameter specifies the number of seconds that elapse before the task provides an informational message about the delay. The default value is 15 seconds. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,6 +292,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -286,7 +304,6 @@ 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 Required: False Position: Named @@ -296,13 +313,15 @@ Accept wildcard characters: False ``` ### -CrossPremisesExpirationTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CrossPremisesExpirationTimeout parameter is used when this cmdlet is run by Microsoft System Center Operations Manager 2007 agents for asynchronous monitoring. We don't recommend using this parameter when running this cmdlet manually. ```yaml Type: EnhancedTimeSpan Parameter Sets: CrossPremises Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -312,13 +331,15 @@ Accept wildcard characters: False ``` ### -CrossPremisesPendingErrorCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CrossPremisesPendingErrorCount parameter is used when this cmdlet is run by System Center Operations Manager 2007 agents for asynchronous monitoring. We don't recommend using this parameter when running this cmdlet manually. ```yaml Type: Int32 Parameter Sets: CrossPremises Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -328,13 +349,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -344,13 +367,15 @@ Accept wildcard characters: False ``` ### -ErrorLatency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ErrorLatency parameter specifies how long to wait for a test message to be delivered before an error event is logged in Microsoft System Center Operations Manager 2007. The default value when a test message is sent to the local Mailbox server is 15 seconds and 180 seconds when a test message is sent to a remote Mailbox server. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -360,13 +385,15 @@ Accept wildcard characters: False ``` ### -ExecutionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ExecutionTimeout parameter specifies the maximum time that this task can run before the test is determined to be a failure. If no test message or delivery report arrives before this time expires, the task ends and an error is reported. When the task is run in the Exchange Management Shell, the default setting is 240 seconds. When the MonitoringContext parameter is used, the default setting is 15 seconds. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -376,16 +403,18 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). -- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. +- $false: Monitoring events and performance counters aren't included in the command results. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -395,6 +424,9 @@ Accept wildcard characters: False ``` ### -TargetEmailAddressDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TargetEmailAddressDisplayName parameter specifies a custom display name that's used on events and reports in Microsoft System Center Operations Manager 2007 when the TargetEmailAddress parameter is used. If you don't use the TargetEmailAddressDisplayName parameter, the events and reports use the email address value specified by the TargetEmailAddress parameter. This parameter is available only with the TargetEmailAddress parameter and has no effect on the output of the cmdlet outside of Microsoft System Center Operations Manager. @@ -403,7 +435,6 @@ This parameter is available only with the TargetEmailAddress parameter and has n Type: String Parameter Sets: TargetEmailAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -413,13 +444,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/ExchangePowerShell/Test-Message.md similarity index 82% rename from exchange/exchange-ps/exchange/Test-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Test-Message.md index c4b62c4ac7..3ec53636f8 100644 --- a/exchange/exchange-ps/exchange/Test-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-message applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection -title: Test-Message -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-message +schema: 2.0.0 +title: Test-Message --- # Test-Message @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in the cloud-based service. -Use the Test-Message cmdlet to simulate and report on the effects of mail flow rules (transport rules) and unified DLP rules on test email messages. Because this cmdlet introduces email into the DLP evaluation pipeline, actions such as Block, Moderate, etc. can take place on the test message. Related notifications will also be sent to any configured recipients. +Use the Test-Message cmdlet to simulate and report on the effects of mail flow rules (transport rules) and unified DLP rules on test email messages. Because this cmdlet introduces email into the DLP evaluation pipeline, actions such as Block, Moderate, etc. can take place on the test message. Related notifications are also sent to any configured recipients. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -44,7 +45,7 @@ Test-Message -Recipients -SendReportTo Applicable: Exchange Online, Exchange Online Protection + The Recipients parameter specifies the recipient email address to use for the test message. You can specify multiple email addresses separated by commas. @@ -68,7 +72,6 @@ You can specify multiple email addresses separated by commas. Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -SendReportTo + +> Applicable: Exchange Online, Exchange Online Protection + The SendReportTo parameter specifies the target email address for the command results. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -TransportRules + +> Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection + The TransportRules switch specifies that you want to test mail flow rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: TransportRules Aliases: -Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -UnifiedDlpRules + +> Applicable: Exchange Online, Exchange Online Protection + The UnifiedDlpRules switch specifies that you want to unified DLP rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter -Parameter Sets: UnifiedDLPRules +Parameter Sets: UnifiedDLPRules, TransportRules Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -125,20 +134,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: TransportRules -Aliases: -Applicable: Exchange Online +### -Confirm -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection -### -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`. @@ -148,7 +147,6 @@ 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 Online, Exchange Online Protection Required: False Position: Named @@ -158,13 +156,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -174,6 +174,9 @@ Accept wildcard characters: False ``` ### -MessageFileData + +> Applicable: Exchange Online, Exchange Online Protection + The MessageFileData parameter specifies the .eml message file to test. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -182,7 +185,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -192,13 +194,15 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Online, Exchange Online Protection + The Sender parameter specifies the sender email address to use for the test message. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md b/exchange/exchange-ps/ExchangePowerShell/Test-MigrationServerAvailability.md similarity index 85% rename from exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md rename to exchange/exchange-ps/ExchangePowerShell/Test-MigrationServerAvailability.md index ae4250e599..06819bf80a 100644 --- a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-MigrationServerAvailability.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-migrationserveravailability -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-MigrationServerAvailability -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-migrationserveravailability +schema: 2.0.0 +title: Test-MigrationServerAvailability --- # Test-MigrationServerAvailability ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Test-MigrationServerAvailability cmdlet to test the availability of the target server in preparation to perform cross-forest mailbox moves, migration of on-premises mailboxes to Exchange Online, or to migrate on-premises mailbox data from an IMAP server to Exchange Online mailboxes. For all migration types, the cmdlet attempts to verify the connection settings used to connect to the target server. @@ -178,7 +179,7 @@ If the verification is successful, you can use the same settings to create a mig - New-MigrationEndpoint - New-MigrationBatch -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -226,13 +227,15 @@ This example tests multiple existing endpoints. ## PARAMETERS ### -Autodiscover + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Autodiscover switch specifies that the command should use the Autodiscover service to obtain the connection settings for the target server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -242,13 +245,15 @@ Accept wildcard characters: False ``` ### -Compliance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Compliance switch specifies that the endpoint type is compliance. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Compliance Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -258,15 +263,17 @@ 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. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +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). ```yaml Type: PSCredential -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, PSTImport, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup, MrsProxyPublicFolder +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, PSTImport, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, ExchangeRemoteMove Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -275,27 +282,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: PSCredential -Parameter Sets: ExchangeRemoteMove -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -EmailAddress -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -EmailAddress The EmailAddress parameter specifies the email address of an administrator account that can access the remote server. This parameter is required when you use the Autodiscover parameter. ```yaml Type: SmtpAddress -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -304,27 +300,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SmtpAddress -Parameter Sets: ExchangeOutlookAnywhere, Gmail -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Endpoint -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -Endpoint The Endpoint parameter specifies the name of the migration endpoint to connect to. A migration endpoint contains the connection settings and other migration configuration settings. If you include this parameter, the Test-MigrationServerAvailability cmdlet attempts to verify the ability to connect to the remote server using the settings in the migration endpoint. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: TestEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -334,6 +319,9 @@ Accept wildcard characters: False ``` ### -ExchangeOutlookAnywhere + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeOutlookAnywhere switch specifies a migration type for migrating on-premises mailboxes to Exchange Online. You don't need to specify a value with this switch. @@ -344,7 +332,6 @@ Use this switch if you plan to migrate mailboxes to Exchange Online using a stag Type: SwitchParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -354,6 +341,9 @@ Accept wildcard characters: False ``` ### -ExchangeRemoteMove + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ExchangeRemoteMove switch specifies a migration type where mailboxes are moved with full fidelity between two on-premises forests or between an on-premises forest and Exchange Online. You don't need to specify a value with this switch. Use this switch if you plan to perform a cross-forest move or migrate mailboxes between an on-premises Exchange organization and Exchange Online in a hybrid deployment. @@ -362,7 +352,6 @@ Use this switch if you plan to perform a cross-forest move or migrate mailboxes Type: SwitchParameter Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeRemoteMove Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -372,6 +361,9 @@ Accept wildcard characters: False ``` ### -ExchangeServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeServer parameter specifies the FQDN of the on-premises Exchange server. Use this parameter when you plan to perform a staged Exchange migration or a cutover Exchange migration. This parameter is required if you don't use the Autodiscover parameter. @@ -380,7 +372,6 @@ The ExchangeServer parameter specifies the FQDN of the on-premises Exchange serv Type: String Parameter Sets: ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -390,6 +381,9 @@ Accept wildcard characters: False ``` ### -Imap + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Imap parameter specifies an IMAP migration type. You don't need to specify a value with this switch. @@ -400,7 +394,6 @@ This switch is required when you want to migrate data from an IMAP mail server t Type: SwitchParameter Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -410,6 +403,9 @@ Accept wildcard characters: False ``` ### -Gmail + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Gmail parameter specifies Gmail as the migration type. You don't need to specify a value with this switch. @@ -420,7 +416,6 @@ This switch is required when you want to migrate data from a Google Workspace (f Type: SwitchParameter Parameter Sets: Gmail Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -430,6 +425,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Port parameter specifies the TCP port number used by the IMAP migration process to connect to the target server. This parameter is required only for IMAP migrations. @@ -440,7 +438,6 @@ The standard is to use port 143 for unencrypted connections, port 143 for Transp Type: Int32 Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -450,6 +447,9 @@ Accept wildcard characters: False ``` ### -PSTImport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -458,7 +458,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: PSTImport Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -468,6 +467,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -476,7 +478,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: PublicFolder, MrsProxyPublicFolder Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -486,6 +487,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabaseServerLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -494,7 +498,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -504,13 +507,15 @@ Accept wildcard characters: False ``` ### -PublicFolderToUnifiedGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The PublicFolderToUnifiedGroup switch specifies that the endpoint type is public folders to Microsoft 365 Groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -520,6 +525,9 @@ Accept wildcard characters: False ``` ### -RemoteServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The RemoteServer parameter specifies the FQDN of the on-premises mail server. This parameter is required when you want to perform one of the following migration types: - Cross-forest move @@ -528,9 +536,8 @@ The RemoteServer parameter specifies the FQDN of the on-premises mail server. Th ```yaml Type: Fqdn -Parameter Sets: PSTImport, ExchangeRemoteMove, IMAP, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder +Parameter Sets: PSTImport, ExchangeRemoteMove, IMAP, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, Compliance Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -539,20 +546,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Fqdn -Parameter Sets: Compliance -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -RPCProxyServer -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -RPCProxyServer This parameter is available only in the cloud-based service. The RPCProxyServer parameter specifies the FQDN of the RPC proxy server for the on-premises Exchange server. This parameter is required when you don't use the Autodiscover parameter. Use this parameter if you plan to perform a staged Exchange migration or a cutover Exchange migration to migrate mailboxes to Exchange Online. @@ -561,7 +558,6 @@ The RPCProxyServer parameter specifies the FQDN of the RPC proxy server for the Type: Fqdn Parameter Sets: ExchangeOutlookAnywhere, PublicFolder, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -571,9 +567,12 @@ Accept wildcard characters: False ``` ### -ServiceAccountKeyFileData + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. +The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that is granted access to your remote tenant is created. 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`). @@ -581,7 +580,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: Gmail Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -591,15 +589,17 @@ Accept wildcard characters: False ``` ### -SourceMailboxLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The SourceMailboxLegacyDN parameter specifies a mailbox on the target server. Use the LegacyExchangeDN for the on-premises test mailbox as the value for this parameter. The cmdlet will attempt to access this mailbox using the credentials for the administrator account on the target server. +The SourceMailboxLegacyDN parameter specifies a mailbox on the target server. Use the LegacyExchangeDN for the on-premises test mailbox as the value for this parameter. The cmdlet attempts to access this mailbox using the credentials for the administrator account on the target server. ```yaml Type: String -Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup +Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -608,20 +608,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online +### -AcceptUntrustedCertificates -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -AcceptUntrustedCertificates This parameter is available only in the cloud-based service. {{ Fill AcceptUntrustedCertificates Description }} @@ -630,7 +620,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, IMAP Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -640,6 +629,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Authentication parameter specifies the authentication method used by the on-premises mail server. Use Basic or NTLM. If you don't include this parameter, Basic authentication is used. @@ -650,7 +642,6 @@ The parameter is only used for cutover Exchange migrations and staged Exchange m Type: AuthenticationMethod Parameter Sets: ExchangeOutlookAnywhere, PublicFolder, IMAP, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -660,6 +651,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -669,7 +663,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -679,13 +672,15 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FilePath parameter specifies the path containing the PST files when testing a PST Import migration endpoint. ```yaml Type: String Parameter Sets: PSTImport Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -695,14 +690,17 @@ Accept wildcard characters: False ``` ### -MailboxPermission + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxPermission parameter specifies what permissions are assigned to the migration administrator account defined by the Credentials parameter. You make the permissions assignment to test the connectivity to a user mailbox on the source mail server when you're testing the connection settings in preparation for a staged or cutover Exchange migration or for creating an Exchange Outlook Anywhere migration endpoint. Specify one of the following values for the account defined by the Credentials parameter: -- FullAccess: The account has been assigned the Full-Access permission to the mailboxes that will be migrated. -- Admin: The account is a member of the Domain Admins group in the organization that hosts the mailboxes that will be migrated. +- FullAccess: The account is assigned the Full-Access permission to the mailboxes to be migrated. +- Admin: The account is a member of the Domain Admins group in the organization that hosts the mailboxes to be migrated. This parameter isn't used for testing the connection to the remote server for a remote move migration or an IMAP migration. @@ -710,7 +708,6 @@ This parameter isn't used for testing the connection to the remote server for a Type: MigrationMailboxPermission Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -720,6 +717,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -728,7 +728,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -738,6 +737,9 @@ Accept wildcard characters: False ``` ### -Security + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl. @@ -746,7 +748,6 @@ For an IMAP migration, the Security parameter specifies the encryption method us Type: IMAPSecurityMechanism Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -756,15 +757,17 @@ Accept wildcard characters: False ``` ### -TestMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. -The TestMailbox parameter specifies a mailbox on the target server. Use the primary SMTP address as the value for this parameter. The cmdlet will attempt to access this mailbox using the credentials for the administrator account on the target server. +The TestMailbox parameter specifies a mailbox on the target server. Use the primary SMTP address as the value for this parameter. The cmdlet attempts to access this mailbox using the credentials for the administrator account on the target server. ```yaml Type: MailboxIdParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail, PublicFolder, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -774,13 +777,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-OAuthConnectivity.md similarity index 75% rename from exchange/exchange-ps/exchange/Test-OAuthConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-OAuthConnectivity.md index 69c08e2c8a..3f06edf39c 100644 --- a/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-OAuthConnectivity.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-oauthconnectivity -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-OAuthConnectivity -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-oauthconnectivity +schema: 2.0.0 +title: Test-OAuthConnectivity --- # Test-OAuthConnectivity ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Test-OAuthConnectivity cmdlet to test OAuth authentication to partner applications for a user. @@ -34,7 +35,7 @@ Test-OAuthConnectivity -Service -TargetUri ## DESCRIPTION SharePoint, Lync and Skype for Business partner applications are automatically created in on-premises Exchange deployments. For the Test-OAuthConnectivity cmdlet to succeed for other partner applications in on-premises deployments, you first need to create the partner application by using the Configure-EnterprisePartnerApplication.ps1 script that's available in the %ExchangeInstallPath%Scripts folder ($env:ExchangeInstallPath\Scripts in PowerShell). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example tests OAuth connectivity with Exchange for Gurinder Singh. ## PARAMETERS ### -Service + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Service parameter specifies the partner application. Valid values for this parameter are: - EWS @@ -58,7 +62,6 @@ The Service parameter specifies the partner application. Valid values for this p Type: ModServiceType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -TargetUri + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The TargetUri parameter specifies the URL for the service you want to test OAuth connectivity with. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -AppOnly -The AppOnly switch specifies the cmdlet will authenticate to the specified service as Exchange without any user context. You don't need to specify a value with this switch. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The AppOnly switch specifies the cmdlet authenticates to the specified service as Exchange without any user context. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -109,7 +119,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Mailbox parameter specifies the mailbox for which you want to test OAuth connectivity to the specified partner application. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -136,7 +148,6 @@ The Mailbox parameter specifies the mailbox for which you want to test OAuth con Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -ReloadConfig + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ReloadConfig switch reloads all the configuration settings from the Exchange configuration objects. You don't need to specify a value with this switch. If you don't use this switch, the cached configuration settings are used. @@ -154,7 +168,6 @@ If you don't use this switch, the cached configuration settings are used. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,13 +177,15 @@ Accept wildcard characters: False ``` ### -UseCachedToken -The UseCachedToken switch specifies that OAuth will try to use an existing, cached authorization token. You don't need to specify a value with this switch. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The UseCachedToken switch specifies that OAuth tries to use an existing, cached authorization token. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md b/exchange/exchange-ps/ExchangePowerShell/Test-OrganizationRelationship.md similarity index 77% rename from exchange/exchange-ps/exchange/Test-OrganizationRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/Test-OrganizationRelationship.md index 79352a03a2..7067d1c473 100644 --- a/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-OrganizationRelationship.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Test-OrganizationRelationship -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-organizationrelationship +schema: 2.0.0 +title: Test-OrganizationRelationship --- # Test-OrganizationRelationship ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Test-OrganizationRelationship cmdlet to verify that the organization relationship is properly configured and functioning as expected. @@ -29,11 +30,11 @@ Test-OrganizationRelationship [[-Identity] ``` ## DESCRIPTION -The Test-OrganizationRelationship cmdlet doesn't include any functional tests of federated sharing features, such as accessing user free/busy information or moving mailboxes between organizations. It only verifies that the configuration will allow these features to work correctly. +The Test-OrganizationRelationship cmdlet doesn't include any functional tests of federated sharing features, such as accessing user free/busy information or moving mailboxes between organizations. The cmdlet only verifies that the configuration allows these features to work correctly. Before you can test an organization relationship, you must first create an organization relationship. For more information, see [Create an organization relationship](https://learn.microsoft.com/exchange/create-an-organization-relationship-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example validates the organization relationship deployed in the fabrikam.co ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the organization relationship to be tested. You can use the following values: - Canonical name @@ -57,7 +61,6 @@ The Identity parameter specifies the organization relationship to be tested. You Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -UserIdentity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The UserIdentity parameter specifies the mailbox for which a delegation token is requested to access the external organization's configuration information. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -80,7 +86,6 @@ The UserIdentity parameter specifies the mailbox for which a delegation token is Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -99,7 +107,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -117,7 +127,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-OutlookConnectivity.md similarity index 85% rename from exchange/exchange-ps/exchange/Test-OutlookConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-OutlookConnectivity.md index 2443888dbc..31fbe709a4 100644 --- a/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-OutlookConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-outlookconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-OutlookConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-outlookconnectivity +schema: 2.0.0 +title: Test-OutlookConnectivity --- # Test-OutlookConnectivity @@ -94,7 +95,7 @@ Test-OutlookConnectivity [[-Identity] ] -WSTestType Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Identity parameter specifies a target user mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -171,7 +175,6 @@ If you don't use this parameter, the command looks for a test user in Active Dir Type: MailboxIdParameter Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -181,25 +184,27 @@ Accept wildcard characters: False ``` ### -ProbeIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ProbeIdentity parameter specifies the probe to use. Valid values are: Outlook Anywhere (RPC over HTTP) probes: - `Outlook.Protocol\OutlookRpcSelfTestProbe`: Validates that the RPC/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. -- `Outlook.Protocol\OutlookRpcDeepTestProbe`: Validates that the RPC/HTTP endpoint is working on the Mailbox server. It will attempt to connect to and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. -- `Outlook.Protocol\OutlookRpcDeepTestProbe\`: Validates that the RPC/HTTP endpoint is working on the Mailbox Server. It will attempt to connect to and log in to the mailbox in the specified mailbox database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). +- `Outlook.Protocol\OutlookRpcDeepTestProbe`: Validates that the RPC/HTTP endpoint is working on the Mailbox server. It attempts to connect to and log in to the mailbox. Since no database is specified, it attempts to connect to the first database returned by the Get-MailboxDatabase cmdlet. +- `Outlook.Protocol\OutlookRpcDeepTestProbe\`: Validates that the RPC/HTTP endpoint is working on the Mailbox Server. It attempts to connect to and log in to the mailbox in the specified mailbox database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). MAPI over HTTP probes: - `OutlookMapiHttp.Protocol\OutlookMapiHttpSelfTestProbe`: Validates that the MAPI/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. -- `OutlookMapiHttp.Protocol\OutlookMapiHttpDeepTestProbe`: Validates that the MAPI/HTTP endpoint is working on the Mailbox server. It will attempt to connect and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. -- `OutlookMapiHttp.Protocol\OutlookRpcDeepTestProbe\`: Validates that the MAPI/HTTP endpoint is working on the Mailbox Server. It will attempt to connect and log in to the mailbox in the specified database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). +- `OutlookMapiHttp.Protocol\OutlookMapiHttpDeepTestProbe`: Validates that the MAPI/HTTP endpoint is working on the Mailbox server. It attempts to connect and log in to the mailbox. Since no database is specified, it attempts to connect to the first database returned by the Get-MailboxDatabase cmdlet. +- `OutlookMapiHttp.Protocol\OutlookRpcDeepTestProbe\`: Validates that the MAPI/HTTP endpoint is working on the Mailbox Server. It attempts to connect and log in to the mailbox in the specified database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). ```yaml Type: String Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -209,6 +214,9 @@ Accept wildcard characters: False ``` ### -GetDefaultsFromAutodiscover + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The GetDefaultsFromAutodiscover parameter specifies whether to get default values for all of the other parameters for the command from the Autodiscover service settings. If you run the command specifying values for other parameters, those values override the default values from the Autodiscover service. The default value for this parameter is $true. @@ -217,7 +225,6 @@ The GetDefaultsFromAutodiscover parameter specifies whether to get default value Type: Boolean Parameter Sets: RpcProxyServer Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -227,6 +234,9 @@ Accept wildcard characters: False ``` ### -Protocol + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Protocol parameter specifies whether to test for Outlook Anywhere connectivity or directly test for RPC or TCP/IP connectivity. The value is either HTTP or TCP. @@ -235,7 +245,6 @@ The Protocol parameter specifies whether to test for Outlook Anywhere connectivi Type: Protocol Parameter Sets: Protocol Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -245,6 +254,9 @@ Accept wildcard characters: False ``` ### -RpcTestType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcTestType parameter specifies which type of RPC endpoint the command should test. Valid values are: @@ -256,7 +268,6 @@ The RpcTestType parameter specifies which type of RPC endpoint the command shoul Type: RpcTestType Parameter Sets: RpcTestType Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -266,11 +277,14 @@ Accept wildcard characters: False ``` ### -WSTestType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The WSTestType parameter specifies type of servers that you want to include in your Outlook connectivity test. You can use the following values: -- Unknown (This is the default value.) +- Unknown (This value is the default.) - Internal - External @@ -278,7 +292,6 @@ The WSTestType parameter specifies type of servers that you want to include in y Type: VirtualDirectoryUriScope Parameter Sets: WSTestType Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -288,19 +301,21 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Archive parameter specifies whether tests should be performed to connect to the user's on-premises archive mailbox. Valid values are: $true: Connect to the user's on-premises archive mailbox. -$false: Don't connect to the user's on-premises mailbox. This is the default value. +$false: Don't connect to the user's on-premises mailbox. This value is the default. ```yaml Type: Boolean Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -310,6 +325,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. 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. @@ -321,7 +339,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -331,6 +348,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Credential parameter specifies the credential used by the probe. The system's test credentials are used by default A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -339,7 +359,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -349,13 +368,15 @@ Accept wildcard characters: False ``` ### -Hostname + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + TheHostname parameter specifies the protocol endpoint target of the probe. You can use a specific Mailbox server or route through Distributed Name Service server. ```yaml Type: String Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -365,6 +386,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MailboxCredential parameter specifies certain credentials to allow logon access to a user's mailbox. Use the parameter along with the Identity parameter to access a user's mailbox when you don't have access permissions. @@ -375,7 +399,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -385,6 +408,9 @@ Accept wildcard characters: False ``` ### -MailboxId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxID parameter specifies the target mailbox. In Exchange 2013 or later, the Identity parameter specifies a target user mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -406,7 +432,6 @@ If you don't use this parameter, the command uses the test account. Type: MailboxIdParameter Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -416,6 +441,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. @@ -426,7 +454,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -436,6 +463,9 @@ Accept wildcard characters: False ``` ### -RpcAuthenticationType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcAuthenticationType parameter specifies the authentication setting to test for the RPC layer. Using this parameter is helpful if a different authentication type is set at the RPC proxy virtual directory. You can use the following values: @@ -450,7 +480,6 @@ The default value is Negotiate. Type: RpcAuthenticationType Parameter Sets: RpcProxyServer, RpcTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -460,6 +489,9 @@ Accept wildcard characters: False ``` ### -RpcClientAccessServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcClientAccessServer parameter specifies the target server with the Client Access server role installed that you want to test. This can be a server fully qualified domain name (FQDN) or a GUID. @@ -468,7 +500,6 @@ The RpcClientAccessServer parameter specifies the target server with the Client Type: ClientAccessServerIdParameter Parameter Sets: RpcProxyServer, RpcTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -478,6 +509,9 @@ Accept wildcard characters: False ``` ### -RpcProxyAuthenticationType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcProxyAuthenticationType parameter specifies the authentication setting for the RPC Proxy endpoint. The value can be specified as Basic, NTLM, or Negotiate. There is no default value unless used with the GetDefaultsFromAutodiscover parameter. @@ -486,7 +520,6 @@ The RpcProxyAuthenticationType parameter specifies the authentication setting fo Type: RPCProxyAuthenticationType Parameter Sets: RpcProxyServer, RpcTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -496,6 +529,9 @@ Accept wildcard characters: False ``` ### -RpcProxyServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcProxyServer parameter specifies whether to set the target RpcProxy server for testing. This parameter can be used when the RpcProxy server is different from the Client Access server. @@ -504,7 +540,6 @@ The RpcProxyServer parameter specifies whether to set the target RpcProxy server Type: ServerIdParameter Parameter Sets: RpcProxyServer Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -514,6 +549,9 @@ Accept wildcard characters: False ``` ### -RpcProxyTestType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcProxyTestType parameter specifies which HTTP endpoint the command should connect to. Valid values are: @@ -525,7 +563,6 @@ The RpcProxyTestType parameter specifies which HTTP endpoint the command should Type: RpcProxyTestType Parameter Sets: RpcTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -535,13 +572,15 @@ Accept wildcard characters: False ``` ### -RunFromServerId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RunFromServerID parameter specifies the server on which the probe should be run. ```yaml Type: ServerIdParameter Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -551,13 +590,17 @@ Accept wildcard characters: False ``` ### -TimeOutSeconds -The TimeOutSeconds parameter specifies the timeout period in seconds before the probe is ended. The default value is 30 seconds. The digits can be entered with or with the use of quotation marks. Either 10 or "10" will work. Any input error will default back to 30 seconds. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The TimeOutSeconds parameter specifies the timeout period in seconds before the probe is ended. A valid value is an integer. The default value is 30 seconds. + +The default value is used if you specify invalid values for this parameter. ```yaml Type: String Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -567,6 +610,9 @@ Accept wildcard characters: False ``` ### -TotalTimeoutInMinutes + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The TotalTimeoutInMinutes parameter specifies the time limit, in minutes, for the command to wait for test results before ending the request. The default value is two minutes. @@ -575,7 +621,6 @@ The TotalTimeoutInMinutes parameter specifies the time limit, in minutes, for th Type: Int32 Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -585,6 +630,9 @@ Accept wildcard characters: False ``` ### -TrustAnySslCert + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. @@ -595,7 +643,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -605,6 +652,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. 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. @@ -613,7 +663,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OutlookWebServices.md b/exchange/exchange-ps/ExchangePowerShell/Test-OutlookWebServices.md similarity index 86% rename from exchange/exchange-ps/exchange/Test-OutlookWebServices.md rename to exchange/exchange-ps/ExchangePowerShell/Test-OutlookWebServices.md index a9eae33fd1..5e75a7054c 100644 --- a/exchange/exchange-ps/exchange/Test-OutlookWebServices.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-OutlookWebServices.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-outlookwebservices -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-OutlookWebServices -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-outlookwebservices +schema: 2.0.0 +title: Test-OutlookWebServices --- # Test-OutlookWebServices @@ -65,7 +66,7 @@ Test-OutlookWebServices [[-Identity] ] [-MonitoringContext] ## DESCRIPTION The Test-OutlookWebServices cmdlet uses a specified address to verify that the Outlook provider is configured correctly. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,13 +87,15 @@ The example tests for a connection to each service. The example also submits a r ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies any valid address in the forest. If you specify this parameter, incorrectly formed addresses and addresses that are outside the forest are rejected. This address is used to test the Outlook provider. This property accepts the domain and username in the domain\\username format or an Active Directory GUID and resolves them to the SMTP address that's needed to authenticate. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDiscoverServer parameter specifies the server with the Client Access server role installed that's used for Autodiscover. You can use any value that uniquely identifies the server. For example: @@ -117,7 +123,6 @@ You can't use this parameter with the ClientAccessServer parameter. Type: ClientAccessServerIdParameter Parameter Sets: AutoDiscoverServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is functional only in Exchange Server 2010. The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. @@ -144,7 +152,6 @@ You can't use this parameter with the AutoDiscoverServer parameter. Type: ClientAccessServerIdParameter Parameter Sets: Default, ClientAccessServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,6 +161,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -163,7 +173,6 @@ 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 Required: False Position: Named @@ -173,13 +182,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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: Default Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -189,6 +200,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -197,7 +211,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: AutoDiscoverServer, ClientAccessServer, MonitoringContext Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,16 +220,18 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). -- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. +- $false: Monitoring events and performance counters aren't included in the command results. This value is the default. ```yaml Type: Boolean Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -226,13 +241,15 @@ Accept wildcard characters: False ``` ### -TargetAddress + +> Applicable: Exchange Server 2010 + The TargetAddress parameter specifies the recipient that's used to test whether Availability service data can be retrieved. ```yaml Type: RecipientIdParameter[] Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -242,6 +259,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -250,7 +270,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: AutoDiscoverServer, ClientAccessServer, MonitoringContext Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,13 +279,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OwaConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-OwaConnectivity.md similarity index 91% rename from exchange/exchange-ps/exchange/Test-OwaConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-OwaConnectivity.md index 3f6dbf78e8..4144d034bc 100644 --- a/exchange/exchange-ps/exchange/Test-OwaConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-OwaConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-owaconnectivity applicable: Exchange Server 2010 -title: Test-OwaConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-owaconnectivity +schema: 2.0.0 +title: Test-OwaConnectivity --- # Test-OwaConnectivity @@ -62,13 +63,13 @@ If the server hosting the test mailbox isn't available, the Test-OwaConnectivity If you run the Test-OwaConnectivity cmdlet on a Client Access server without using either the ClientAccessServer parameter or the URL parameter, the cmdlet tests the server on which you run the cmdlet. To test a specific Client Access server, use the ClientAccessServer parameter. -To test a single URL, run the Test-OwaConnectivity cmdlet with the URL parameter and credentials for an existing Exchange mailbox. If the URL is behind a load balancer, you can't predict which Client Access server the command will test. Because credentials are required as part of the parameters when you use the URL parameter, you can use any account to run the Test-OwaConnectivity cmdlet when you use the URL parameter. +To test a single URL, run the Test-OwaConnectivity cmdlet with the URL parameter and credentials for an existing Exchange mailbox. If the URL is behind a load balancer, you can't predict which Client Access server the command tests. Because credentials are required as part of the parameters when you use the URL parameter, you can use any account to run the Test-OwaConnectivity cmdlet when you use the URL parameter. If the command encounters a virtual directory that doesn't require Secure Sockets Layer (SSL), the command skips that directory unless the AllowUnsecureAccess parameter is used. If the AllowUnsecureAccess parameter is used, communications between servers are sent in clear text for purposes of the test. The Test-OwaConnectivity cmdlet can be run as a one-time interactive task or as a scheduled task under Microsoft System Center Operations Manager 2007 control. To run the Test-OwaConnectivity cmdlet as a System Center Operations Manager 2007 task, the Client Access test mailbox must be available on the Mailbox servers that the cmdlet tests against. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -89,6 +90,9 @@ This example tests the connectivity of a specific Client Access server Contoso12 ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The ClientAccessServer parameter specifies the name of the Client Access server to test. If this parameter is included, all Exchange Outlook Web App virtual directories on the Client Access server are tested against all Exchange Mailbox servers in the local Active Directory site. @@ -99,7 +103,6 @@ Don't use this parameter with the URL parameter. Type: ServerIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -URL + +> Applicable: Exchange Server 2010 + The URL parameter specifies the URL to test. This parameter is required only when you want to test a single Outlook Web App URL. If this parameter is used, the MailboxCredential parameter is also required. @@ -119,7 +125,6 @@ You can't use the URL parameter with the TestType or ClientAccessServer paramete Type: String Parameter Sets: URL Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -129,6 +134,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010 + The MailboxCredential parameter specifies the mailbox credential for a single URL test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -139,7 +147,6 @@ The MailboxCredential parameter is required only when using the URL parameter. Type: PSCredential Parameter Sets: URL Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -149,6 +156,9 @@ Accept wildcard characters: False ``` ### -AllowUnsecureAccess + +> Applicable: Exchange Server 2010 + The AllowUnsecureAccess switch specifies whether virtual directories that don't require SSL are tested. You don't need to specify a value with this switch. If you don't use this switch, the command skips virtual directories that don't require SSL, and an error is generated. @@ -157,7 +167,6 @@ If you don't use this switch, the command skips virtual directories that don't r Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -167,6 +176,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -176,7 +188,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -186,13 +197,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -202,6 +215,9 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010 + The LightMode parameter isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of the command. This parameter is implemented for other Exchange diagnostic commands where it's used to run a less intensive version of a command. @@ -210,7 +226,6 @@ This parameter is implemented for other Exchange diagnostic commands where it's Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -220,13 +235,15 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010 + The MailboxServer parameter specifies the name of the Mailbox server to test. If not specified, all Mailbox servers in the local Active Directory site are tested. ```yaml Type: ServerIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -244,7 +264,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -254,6 +273,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010 + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -262,7 +284,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -272,13 +293,15 @@ Accept wildcard characters: False ``` ### -RSTEndpoint + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -288,13 +311,15 @@ Accept wildcard characters: False ``` ### -TestType + +> Applicable: Exchange Server 2010 + The TestType parameter specifies whether the command tests internal or external URLs. Values are Internal and External. You can't use this parameter with the URL parameter. When neither the TestType parameter nor the URL parameter is specified, the default is TestType:Internal. ```yaml Type: OwaConnectivityTestType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -304,13 +329,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010 + The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. The default value for the Timeout parameter is 30 seconds. You must specify a time-out value greater than 0 seconds and less than 1 hour (3,600 seconds). We recommend that you always configure this parameter with a value of 5 seconds or more. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -320,6 +347,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -328,7 +358,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -338,13 +367,15 @@ Accept wildcard characters: False ``` ### -VirtualDirectoryName + +> Applicable: Exchange Server 2010 + The VirtualDirectoryName parameter specifies the name of the virtual directory to test on a particular Client Access server. If this parameter isn't included, all Exchange Outlook Web App virtual directories that support Exchange mailboxes are tested. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -354,13 +385,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-PopConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-PopConnectivity.md similarity index 82% rename from exchange/exchange-ps/exchange/Test-PopConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-PopConnectivity.md index fedc41347a..93b78565f1 100644 --- a/exchange/exchange-ps/exchange/Test-PopConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-PopConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-popconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-PopConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-popconnectivity +schema: 2.0.0 +title: Test-PopConnectivity --- # Test-PopConnectivity @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-PopConnectivity cmdlet to verify that the Microsoft Exchange POP3 service is working as expected. -**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet is replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -58,7 +59,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-PopConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\POP Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,6 +80,9 @@ This example tests the client POP3 connectivity of the specific server named Con ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -92,7 +96,6 @@ You can use any value that uniquely identifies the server. For example: Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -111,7 +117,6 @@ 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 Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -ConnectionType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectionType parameter specifies the type of connection that's used to connect to the POP3 service. Valid values are: - Plaintext @@ -131,7 +139,6 @@ The ConnectionType parameter specifies the type of connection that's used to con Type: ProtocolConnectionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,13 +148,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LightMode switch tells the command to perform only a test logon to the server by using the POP3 protocol. You don't need to specify a value with this switch. If you don't use this switch, the command also tests receiving a message using the POP3 protocol. @@ -165,7 +177,6 @@ If you don't use this switch, the command also tests receiving a message using t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -183,7 +197,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -208,7 +224,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -218,6 +233,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -226,7 +244,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -PerConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PerConnectionTimeout parameter specifies the amount of time, in seconds, to wait per connection for the test operation to finish. Valid values are between 0 and 120 seconds. The default value is 120 seconds. We recommend that you configure this parameter with a value of 5 seconds or more. @@ -244,7 +264,6 @@ We recommend that you configure this parameter with a value of 5 seconds or more Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,13 +273,15 @@ Accept wildcard characters: False ``` ### -PortClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PortClientAccessServer parameter specifies the port to use to connect to the Client Access server. The default port is 110 for POP3. The valid range is from 0 through 65,535. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,6 +291,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -278,7 +302,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -288,6 +311,9 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. Valid values are between 0 and 3600 seconds (1 hour). The default value is 180 seconds (3 minutes). We recommend that you configure this parameter with a value of 5 seconds or more. @@ -296,7 +322,6 @@ We recommend that you configure this parameter with a value of 5 seconds or more Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -306,6 +331,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -314,7 +342,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,13 +351,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-PowerShellConnectivity.md similarity index 83% rename from exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-PowerShellConnectivity.md index b418302280..c0853084d2 100644 --- a/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-PowerShellConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-powershellconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-PowerShellConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-powershellconnectivity +schema: 2.0.0 +title: Test-PowerShellConnectivity --- # Test-PowerShellConnectivity @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-PowerShellConnectivity cmdlet to test client connectivity to Exchange remote PowerShell virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet is replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -70,7 +71,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-PowerShellConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\PowerShell Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -95,6 +96,9 @@ The credentials that are used to connect to the virtual directory are stored in ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -110,7 +114,6 @@ You can't use this parameter with the ConnectionUri parameter. Type: ServerIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -ConnectionUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ConnectionUri parameter specifies the URL of the remote PowerShell virtual directory to test, for example, `https://contoso.com/powershell`. You can't use this parameter with the ClientAccessServer parameter. @@ -128,7 +134,6 @@ You can't use this parameter with the ClientAccessServer parameter. Type: Uri Parameter Sets: URL Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -TestCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TestCredential parameter specifies the credentials to use for the test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -148,7 +156,6 @@ You can only use this parameter with the ConnectionUri parameter. Type: PSCredential Parameter Sets: URL Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -158,6 +165,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Authentication parameter specifies the type of authentication that's used to connect. Valid values are: - Default @@ -171,7 +181,6 @@ The Authentication parameter specifies the type of authentication that's used to Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -190,7 +202,6 @@ 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 Required: False Position: Named @@ -200,13 +211,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -216,6 +229,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -231,7 +247,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +256,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -249,7 +267,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,6 +276,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -267,7 +287,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,6 +296,9 @@ Accept wildcard characters: False ``` ### -TestType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TestType parameter specifies whether the command tests internal or external URLs. Values are Internal and External. The default value is Internal. You can only use this parameter with the ClientAccessServer parameter. @@ -285,7 +307,6 @@ You can only use this parameter with the ClientAccessServer parameter. Type: OwaConnectivityTestType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -295,6 +316,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -303,7 +327,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,6 +336,9 @@ Accept wildcard characters: False ``` ### -VirtualDirectoryName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The VirtualDirectoryName parameter specifies the name of the remote PowerShell virtual directory that you want to test. Enclose values that contain spaces in quotation marks ("). You can only use this parameter with the ClientAccessServer parameter. If you don't use this parameter, all available remote PowerShell virtual directories on the server are tested. @@ -321,7 +347,6 @@ You can only use this parameter with the ClientAccessServer parameter. If you do Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -331,13 +356,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ReplicationHealth.md b/exchange/exchange-ps/ExchangePowerShell/Test-ReplicationHealth.md similarity index 81% rename from exchange/exchange-ps/exchange/Test-ReplicationHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ReplicationHealth.md index 384af71e00..f57ca85a11 100644 --- a/exchange/exchange-ps/exchange/Test-ReplicationHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ReplicationHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-replicationhealth -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ReplicationHealth -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-replicationhealth +schema: 2.0.0 +title: Test-ReplicationHealth --- # Test-ReplicationHealth @@ -36,7 +37,7 @@ Test-ReplicationHealth [[-Identity] ] ## DESCRIPTION The Test-ReplicationHealth cmdlet is designed for the proactive monitoring of continuous replication and the continuous replication pipeline, the availability of Active Manager and the health and status of the underlying cluster service, quorum and network components. The Test-ReplicationHealth cmdlet can be run locally or remotely against any Mailbox server in a DAG. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +51,9 @@ This example tests the health of replication for the Mailbox server MBX1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the Mailbox server that you want to test. You can use any value that uniquely identifies the server. For example: - Name @@ -63,7 +67,6 @@ You can't use this parameter with the DatabaseAvailabilityGroup parameter. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectoryTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveDirectoryTimeout parameter specifies the time interval in seconds that's allowed for each directory service operation before the operation times out. The default value is 15 seconds. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -98,7 +106,6 @@ 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 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DatabaseAvailabilityGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DatabaseAvailabilityGroup parameter specifies whether to test all servers in the specified DAG. You can use any value that uniquely identifies the DAG. For example: - Name @@ -120,7 +130,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,16 +157,18 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). -- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. +- $false: Monitoring events and performance counters aren't included in the command results. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -OutputObjects + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The OutputObjects switch specifies whether to output an array of information regarding failures. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +196,15 @@ Accept wildcard characters: False ``` ### -TransientEventSuppressionWindow + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransientEventSuppressionWindow parameter specifies the number of minutes that the queue lengths can be exceeded before the queue length tests are considered to have failed. This parameter is used to reduce the number of failures due to transient load generation. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,13 +214,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-SenderId.md b/exchange/exchange-ps/ExchangePowerShell/Test-SenderId.md similarity index 79% rename from exchange/exchange-ps/exchange/Test-SenderId.md rename to exchange/exchange-ps/ExchangePowerShell/Test-SenderId.md index 53db8aa93a..7ea8aad67f 100644 --- a/exchange/exchange-ps/exchange/Test-SenderId.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-SenderId.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-senderid -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-SenderId -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-senderid +schema: 2.0.0 +title: Test-SenderId --- # Test-SenderId @@ -33,7 +34,7 @@ Test-SenderId -IPAddress -PurportedResponsibleDomain ## DESCRIPTION The Test-SenderId cmdlet provides the results of a Sender ID check for the IP address and the corresponding domain name that you specify. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,13 +48,15 @@ This example checks whether the IP address 192.168.0.1 is the legitimate sender ## PARAMETERS ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IPAddress parameter specifies the originating IP address of the sending server. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -PurportedResponsibleDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The PurportedResponsibleDomain parameter specifies the domain name that you want to verify with Sender ID. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -88,7 +96,6 @@ 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 Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -106,7 +116,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -HelloDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The HelloDomain parameter specifies the domain address displayed in the HELO or EHLO SMTP commands from this sender. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +143,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -145,7 +159,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ServiceHealth.md b/exchange/exchange-ps/ExchangePowerShell/Test-ServiceHealth.md similarity index 80% rename from exchange/exchange-ps/exchange/Test-ServiceHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ServiceHealth.md index 1016e36a2c..e9aa727121 100644 --- a/exchange/exchange-ps/exchange/Test-ServiceHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ServiceHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-servicehealth -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ServiceHealth -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-servicehealth +schema: 2.0.0 +title: Test-ServiceHealth --- # Test-ServiceHealth @@ -31,9 +32,9 @@ Test-ServiceHealth [[-Server] ] ``` ## DESCRIPTION -This cmdlet isn't supported on Exchange 2013 Client Access servers (the cmdlet will return unexpected output). +This cmdlet isn't supported on Exchange 2013 Client Access servers (the cmdlet returns unexpected output). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example uses the Test-ServiceHealth command without parameters to test the ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -60,7 +64,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectoryTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ActiveDirectoryTimeout parameter specifies the amount of time, in seconds, allowed for each Active Directory operation to complete before the operation times out. The default value is 15 seconds. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -95,7 +103,6 @@ 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 Required: False Position: Named @@ -105,6 +112,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -113,7 +123,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,16 +132,18 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). -- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. +- $false: Monitoring events and performance counters aren't included in the command results. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/ExchangePowerShell/Test-ServicePrincipalAuthorization.md similarity index 86% rename from exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ServicePrincipalAuthorization.md index 896490cd63..b40a761d80 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ServicePrincipalAuthorization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-serviceprincipalauthorization applicable: Exchange Online, Exchange Online Protection -title: Test-ServicePrincipalAuthorization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-serviceprincipalauthorization +schema: 2.0.0 +title: Test-ServicePrincipalAuthorization --- # Test-ServicePrincipalAuthorization @@ -29,7 +30,7 @@ Test-ServicePrincipalAuthorization [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example tests the entitlement of the app named "DemoB", including which per ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the service principal that you want to test. You can use any value that uniquely identifies the service principal. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the service principal that you want to test. Yo Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Resource + +> Applicable: Exchange Online, Exchange Online Protection + The Resource parameter specifies the target mailbox where the scoped permissions apply. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -111,7 +119,6 @@ The Resource parameter specifies the target mailbox where the scoped permissions Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-SiteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Test-SiteMailbox.md similarity index 85% rename from exchange/exchange-ps/exchange/Test-SiteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Test-SiteMailbox.md index 249202e6e8..20760ca321 100644 --- a/exchange/exchange-ps/exchange/Test-SiteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-SiteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-sitemailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-SiteMailbox -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-sitemailbox +schema: 2.0.0 +title: Test-SiteMailbox --- # Test-SiteMailbox @@ -36,7 +37,7 @@ Test-SiteMailbox [[-Identity] ] ## DESCRIPTION If you don't specify the RequestorIdentity parameter, the command uses the identification of the user running this command. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +65,9 @@ This example tests a specific user's ability to access a SharePoint site by usin ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the site mailbox that you want to test. You can use any value that uniquely identifies the site mailbox. For example: - Name @@ -79,7 +83,6 @@ You can't use this parameter with the SharePointUrl parameter. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -BypassOwnerCheck + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. @@ -97,7 +103,6 @@ If you don't use this switch, and you aren't a member or owner of the site mailb Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -116,7 +124,6 @@ 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 Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -RequestorIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The RequestorIdentity parameter specifies the user to test for correct permissions to the SharePoint site mailbox. You can use any value that uniquely identifies the user. For example: - Name @@ -143,7 +153,6 @@ If you don't specify this parameter, the command uses the identification of the Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -SharePointUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SharePointUrl parameter specifies the SharePoint URL where the site mailbox is hosted, for example, "https://myserver/teams/edu". You can't use this parameter with the Identity parameter. @@ -161,7 +173,6 @@ You can't use this parameter with the Identity parameter. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +182,9 @@ Accept wildcard characters: False ``` ### -UseAppTokenOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UseAppTokenOnly switch specifies that you want to test the site mailbox by using the identity of the Exchange server. You don't need to specify a value with this switch. You can't use this switch with the RequestorIdentity parameter. @@ -179,7 +193,6 @@ You can't use this switch with the RequestorIdentity parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,13 +202,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-SmtpConnectivity.md similarity index 85% rename from exchange/exchange-ps/exchange/Test-SmtpConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-SmtpConnectivity.md index 68097adcaf..29e06a7f1e 100644 --- a/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-SmtpConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-smtpconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-SmtpConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-smtpconnectivity +schema: 2.0.0 +title: Test-SmtpConnectivity --- # Test-SmtpConnectivity @@ -41,7 +42,7 @@ When you run the Test-SmtpConnectivity cmdlet against a Mailbox server, the cmdl You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding ` > ` to the command. For example: `Test-SmtpConnectivity Mailbox01 | ConvertTo-Csv > "C:\My Documents\SMTP Test.csv"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example verifies SMTP connectivity for all Receive connectors on all Mailbo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the transport server for which the cmdlet verifies SMTP connectivity . The Identity parameter specifies the transport server where you want to verify SMTP connectivity (test all Receive connectors on the specified server). You can use any value that uniquely identifies the server. For example: @@ -77,7 +81,6 @@ The Identity parameter specifies the transport server where you want to verify S Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -96,7 +102,6 @@ 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 Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -114,7 +122,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,16 +131,18 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). -- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. +- $false: Monitoring events and performance counters aren't included in the command results. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,13 +152,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-SystemHealth.md b/exchange/exchange-ps/ExchangePowerShell/Test-SystemHealth.md similarity index 89% rename from exchange/exchange-ps/exchange/Test-SystemHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Test-SystemHealth.md index 8248f8de34..b12b185cce 100644 --- a/exchange/exchange-ps/exchange/Test-SystemHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-SystemHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-systemhealth applicable: Exchange Server 2010 -title: Test-SystemHealth -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-systemhealth +schema: 2.0.0 +title: Test-SystemHealth --- # Test-SystemHealth @@ -47,7 +48,7 @@ Test-SystemHealth [-ADCredentials ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,6 +71,9 @@ This example saves the output data as a byte stream to the variable named $SysHe ## PARAMETERS ### -ADCredentials + +> Applicable: Exchange Server 2010 + The ADCredentials parameter specifies the username and password that's used to access Active Directory. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -78,7 +82,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -Analyze + +> Applicable: Exchange Server 2010 + The Analyze switch enables analysis on the data gathered. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -Collect + +> Applicable: Exchange Server 2010 + The Collect switch enables data collection. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -ConfigurationData + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -ConfigurationFileLocation + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: LongPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -161,7 +175,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010 + The Description parameter specifies a descriptive label for the scan. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -187,13 +202,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -203,13 +220,15 @@ Accept wildcard characters: False ``` ### -DownloadConfigurationUpdates + +> Applicable: Exchange Server 2010 + The DownloadConfigurationUpdates switch checks for and downloads newer versions of the configuration file. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -ExchangeCredentials + +> Applicable: Exchange Server 2010 + The ExchangeCredentials parameter specifies the username and password that's used to access Exchange servers. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -227,7 +249,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -237,13 +258,15 @@ Accept wildcard characters: False ``` ### -Export + +> Applicable: Exchange Server 2010 + The Export switch causes sensitive data to be removed from the output file specified. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -253,13 +276,15 @@ Accept wildcard characters: False ``` ### -GenerateEvents + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -269,13 +294,15 @@ Accept wildcard characters: False ``` ### -GenerateSQMData + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -285,13 +312,15 @@ Accept wildcard characters: False ``` ### -MaxThreads + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -301,13 +330,15 @@ Accept wildcard characters: False ``` ### -MergeFileLocation + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: LongPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -317,6 +348,9 @@ Accept wildcard characters: False ``` ### -OutData + +> Applicable: Exchange Server 2010 + The OutData switch specifies whether the output data is sent as a byte stream. You don't need to specify a value with this switch. For example, if you run the command: `$temp = Test-SystemHealth -OutData`, `$temp` contains the byte stream of the output data, and you can covert it back to xml by using the Set-Content command. For a code sample, see "Example 2" in this topic. @@ -325,7 +359,6 @@ For example, if you run the command: `$temp = Test-SystemHealth -OutData`, `$tem Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -335,13 +368,15 @@ Accept wildcard characters: False ``` ### -OutFileLocation + +> Applicable: Exchange Server 2010 + The OutFileLocation parameter identifies the name and path to the data file to generate. ```yaml Type: LongPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -351,13 +386,15 @@ Accept wildcard characters: False ``` ### -Roles + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -367,13 +404,15 @@ Accept wildcard characters: False ``` ### -ScanType + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -383,13 +422,15 @@ Accept wildcard characters: False ``` ### -ServerList + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -399,13 +440,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010 + The Timeout parameter specifies the number of seconds before the operation times out. The default value is 300 seconds (5 minutes). ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -415,13 +458,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-TextExtraction.md b/exchange/exchange-ps/ExchangePowerShell/Test-TextExtraction.md similarity index 68% rename from exchange/exchange-ps/exchange/Test-TextExtraction.md rename to exchange/exchange-ps/ExchangePowerShell/Test-TextExtraction.md index b334ac76e8..3327ccacd5 100644 --- a/exchange/exchange-ps/exchange/Test-TextExtraction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-TextExtraction.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-textextraction -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance -title: Test-TextExtraction -schema: 2.0.0 +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-textextraction +schema: 2.0.0 +title: Test-TextExtraction --- # Test-TextExtraction ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might 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,9 +30,11 @@ Test-TextExtraction [-FileData] ``` ## DESCRIPTION -This cmdlet returns the text that is found in a file in Exchange. The Microsoft classification engine uses this text to classify content and determine which sensitive information types are found in this file/message. +This cmdlet doesn't work on encrypted email message files. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +The Microsoft classification engine uses the results to classify content and determine the sensitive information types in the message file. + +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,7 +45,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,11 +54,14 @@ $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 ### -FileData + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + The FileData parameter specifies the name and path of the file from which text should be extracted. A valid value for this parameter requires you to read the file to a byte-encoded object using the 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`). @@ -64,7 +70,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: True Position: 0 @@ -74,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + 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`. @@ -83,7 +91,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -93,6 +100,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + 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. @@ -101,7 +111,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -111,13 +120,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance + 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 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-UMConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-UMConnectivity.md similarity index 84% rename from exchange/exchange-ps/exchange/Test-UMConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-UMConnectivity.md index 7a6b3e9a41..d85acfead8 100644 --- a/exchange/exchange-ps/exchange/Test-UMConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-UMConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-umconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Test-UMConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-umconnectivity +schema: 2.0.0 +title: Test-UMConnectivity --- # Test-UMConnectivity @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-UMConnectivity cmdlet to test the operation of Unified Messaging (UM) servers. -**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet is replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -108,9 +109,9 @@ The Test-UMConnectivity cmdlet can be used to test the operation of a Mailbox se When you run this cmdlet in an on-premises Unified Messaging deployment, you need to create a UM IP gateway object for the computer or server that the cmdlet is testing. When you create the UM IP gateway object, you must configure it with a fully qualified domain name (FQDN) and that FQDN must match the name of the computer running this cmdlet. -After this task is complete, the cmdlet will have tested the operation of the Mailbox server and related telephony components. +After this task is complete, the cmdlet tested the operation of the Mailbox server and related telephony components. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -138,13 +139,15 @@ This example tests a SIP dial plan by using a SIP URI. This example can be used ## PARAMETERS ### -Phone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Phone parameter specifies the telephone number or Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) used when the test call is redirected. The extension number should be configured in the PBX to forward calls to the UM hunt group. ```yaml Type: String Parameter Sets: TuiLogonSpecific, EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -154,13 +157,15 @@ Accept wildcard characters: False ``` ### -PIN + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PIN parameter specifies the PIN associated with the UM-enabled mailbox. ```yaml Type: String Parameter Sets: TuiLogonSpecific Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -170,13 +175,15 @@ Accept wildcard characters: False ``` ### -ResetPIN + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ResetPIN parameter specifies whether to generate or regenerate a new PIN for all the test mailboxes in the current site. ```yaml Type: Boolean Parameter Sets: PinReset Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -186,13 +193,15 @@ Accept wildcard characters: False ``` ### -TUILogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TUILogon parameter specifies whether the cmdlet tries to log on to one or more UM-enabled mailboxes. The mailboxes must be UM-enabled and associated with the UM dial plan to which the Mailbox server running the Microsoft Exchange Unified Messaging service belongs. The default setting is $false. ```yaml Type: Boolean Parameter Sets: TuiLogonSpecific Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -202,13 +211,15 @@ Accept wildcard characters: False ``` ### -TUILogonAll + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TUILogonAll parameter specifies whether to try to connect to all test mailboxes in the current Active Directory site. The default setting is $false. The accounts that are tested must be generated by calling the New-TestCasConnectivityUser.ps1 script, and the corresponding mailboxes must be UM-enabled. Otherwise, no action is taken. ```yaml Type: Boolean Parameter Sets: TuiLogonGeneral Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -218,13 +229,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan to be tested. This parameter must be used with the TUILogon parameter. ```yaml Type: UMDialPlanIdParameter Parameter Sets: TuiLogonSpecific Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -234,13 +247,15 @@ Accept wildcard characters: False ``` ### -UMIPGateway + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMIPGateway parameter specifies the name of the UM IP gateway or IP PBX to use for the outgoing test call. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -250,13 +265,15 @@ Accept wildcard characters: False ``` ### -CallRouter + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CallRouter switch specifies whether to test the Microsoft Exchange Unified Messaging Call Router service (front-end). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: LocalLoop Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -266,13 +283,15 @@ Accept wildcard characters: False ``` ### -CertificateThumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CertificateThumbprint parameter specifies the certificate thumbprint used for SIP Secured and Secured mode. ```yaml Type: String Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -282,6 +301,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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`. @@ -291,7 +313,6 @@ 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 Required: False Position: Named @@ -301,13 +322,15 @@ Accept wildcard characters: False ``` ### -DiagDtmfDurationInMilisecs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DiagDtmfDurationInMilisecs parameter specifies the duration of each digit sent. ```yaml Type: Int32 Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -317,13 +340,15 @@ Accept wildcard characters: False ``` ### -DiagDtmfSequence + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DiagDtmfSequence parameter specifies the sequence of digits sent. ```yaml Type: String Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -333,13 +358,15 @@ Accept wildcard characters: False ``` ### -DiagInitialSilenceInMilisecs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DiagInitialSilenceInMilisecs parameter specifies the time period in milliseconds that the cmdlet pauses before the digit sequence is sent. ```yaml Type: Int32 Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -349,13 +376,15 @@ Accept wildcard characters: False ``` ### -DiagInterDtmfDiffGapInMilisecs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DiagInterDtmfDiffGapInMilisecs parameter specifies whether to customize the time between the digits in the diagnostic sequence. This is a comma-delimited list that can accept null entries. This should include multiple values. ```yaml Type: String Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -365,13 +394,15 @@ Accept wildcard characters: False ``` ### -DiagInterDtmfGapInMilisecs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DiagInterDtmfGapInMilisecs parameter specifies the time in milliseconds between each digit sent in the digit sequence. This is a single value. ```yaml Type: Int32 Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -381,13 +412,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -397,13 +430,15 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The From parameter specifies the SIP URI or SIP address that the call originated from. It's used only when you use the Phone parameter. The default setting is the SIP URI specified when you use the Phone parameter. ```yaml Type: String Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -413,13 +448,15 @@ Accept wildcard characters: False ``` ### -ListenPort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ListenPort parameter specifies the IP port number on which to listen. If not specified, IP port 9000 is used. ```yaml Type: Int32 Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -429,13 +466,15 @@ Accept wildcard characters: False ``` ### -MediaSecured + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MediaSecured parameter specifies whether to use Secure RTP or RTP (unsecured) mode. ```yaml Type: Boolean Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -445,16 +484,18 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). -- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. +- $false: Monitoring events and performance counters aren't included in the command results. This value is the default. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -464,13 +505,15 @@ Accept wildcard characters: False ``` ### -RemotePort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The RemotePort parameter specifies the port used for the call. If not specified, the default is port 5060 for Transmission Control Protocol (TCP) and 5061 for mutual Transport Layer Security (TLS). ```yaml Type: Int32 Parameter Sets: TuiLogonSpecific, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -480,13 +523,15 @@ Accept wildcard characters: False ``` ### -Secured + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Secured parameter specifies whether the test is run in SIP Secured mode. ```yaml Type: Boolean Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -496,13 +541,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Timeout parameter specifies the length of time in seconds to wait for the test operation to finish. The default is 600 seconds. You can't set this parameter with a value of less than 60 seconds. However, we recommend that you always configure this parameter with a value of 60 seconds or more. The maximum value for this parameter is 1800 seconds. ```yaml Type: Int32 Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -512,13 +559,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + 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 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-WebServicesConnectivity.md similarity index 86% rename from exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-WebServicesConnectivity.md index fba4a45320..6e29d4210f 100644 --- a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-WebServicesConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-webservicesconnectivity -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-WebServicesConnectivity -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-webservicesconnectivity +schema: 2.0.0 +title: Test-WebServicesConnectivity --- # Test-WebServicesConnectivity @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-WebServicesConnectivity cmdlet to test client connectivity to Exchange Web Services virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet is replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -89,7 +90,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-WebServicesConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EWS Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,6 +110,9 @@ This example tests the client connection to Exchange Web Services on the server ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox to use for the test. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -128,7 +132,6 @@ When you use this parameter, you also need to use the MailboxCredential paramete Type: MailboxIdParameter Parameter Sets: AutoDiscoverServer, MonitoringContext, ClientAccessServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -138,6 +141,9 @@ Accept wildcard characters: False ``` ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -153,7 +159,6 @@ You can't use this parameter with the AutoDiscoverServer parameter. Type: ServerIdParameter Parameter Sets: Default, ClientAccessServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -163,6 +168,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The AutoDiscoverServer parameter specifies the server with the Client Access server role installed that's used for Autodiscover. You can use any value that uniquely identifies the server. For example: @@ -176,9 +184,8 @@ You can't use this parameter with the ClientAccessServer parameter. ```yaml Type: ClientAccessServerIdParameter -Parameter Sets: AutoDiscoverServer +Parameter Sets: AutoDiscoverServer, ClientAccessServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -187,20 +194,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: ServerIdParameter -Parameter Sets: ClientAccessServer -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -AllowUnsecureAccess -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -AllowUnsecureAccess This parameter is available only in Exchange Server 2010. The AllowUnsecureAccess switch specifies whether to enable the command to continue to run over an unsecured channel that doesn't require Secure Sockets Layer (SSL). You don't need to specify a value with this switch. @@ -209,7 +206,6 @@ The AllowUnsecureAccess switch specifies whether to enable the command to contin Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -219,6 +215,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -228,7 +227,6 @@ 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 Required: False Position: Named @@ -238,6 +236,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -246,7 +247,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -256,6 +256,9 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The LightMode switch tells the command to perform only a subset of the tests. You don't need to specify a value with this switch. When you use this switch, the EWS: ConvertId test is run instead of the EWS: GetFolder test. @@ -264,7 +267,6 @@ When you use this switch, the EWS: ConvertId test is run instead of the EWS: Get Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -274,6 +276,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -284,7 +289,6 @@ This parameter is required when you use the Identity parameter. Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -294,13 +298,15 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010 + The MailboxServer parameter specifies the identity of the Exchange Mailbox server on which the test is run. ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -310,6 +316,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -318,7 +327,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: MonitoringContext Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -328,6 +336,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010 + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -336,7 +347,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -346,13 +356,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010 + The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. The default value for the Timeout parameter is 300 seconds. You must specify a time-out value greater than 0 seconds. We recommend that you always configure this parameter with a value of 5 seconds or more. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -362,6 +374,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -370,7 +385,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -380,6 +394,9 @@ Accept wildcard characters: False ``` ### -UseAutodiscoverForClientAccessServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The UseAutodiscoverForClientAccessServer switch specifies whether the test should use the Autodiscover service to locate the Client Access server. You don't need to specify a value with this switch. @@ -388,7 +405,6 @@ The UseAutodiscoverForClientAccessServer switch specifies whether the test shoul Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -398,13 +414,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedMailbox.md similarity index 84% rename from exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedMailbox.md index 50c11224ce..e78381ee09 100644 --- a/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/undo-softdeletedmailbox applicable: Exchange Online -title: Undo-SoftDeletedMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/undo-softdeletedmailbox +schema: 2.0.0 +title: Undo-SoftDeletedMailbox --- # Undo-SoftDeletedMailbox @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Undo-SoftDeletedMailbox cmdlet to recover a mailbox that has been deleted. Mailboxes can be recovered within 30 days of being deleted. +Use the Undo-SoftDeletedMailbox cmdlet to recover a mailbox that is deleted. Mailboxes can be recovered within 30 days of being deleted. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -44,11 +45,11 @@ Undo-SoftDeletedMailbox [-SoftDeletedObject] ``` ## DESCRIPTION -Use the Undo-SoftDeletedMailbox cmdlet to recover a mailbox that has been deleted. When a mailbox is deleted with the Remove-Mailbox or Disable-Mailbox cmdlet, it's not actually deleted. It's hidden in Exchange and moved in Active Directory to the organizational unit (OU) Soft Deleted Objects. This enables administrators to recover deleted mailboxes for up to 30 days after deletion. +Use the Undo-SoftDeletedMailbox cmdlet to recover a mailbox that is deleted. When a mailbox is deleted with the Remove-Mailbox or Disable-Mailbox cmdlet, it's not actually deleted. It's hidden in Exchange and moved in Active Directory to the organizational unit (OU) Soft Deleted Objects. This enables administrators to recover deleted mailboxes for up to 30 days after deletion. If the Microsoft account (formerly known as a Windows Live ID) wasn't deleted when the mailbox was deleted, you have to specify a new Microsoft account and password when you use the Undo-SoftDeletedMailbox cmdlet to recover a mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,18 +65,20 @@ This example recovers the deleted mailbox for the user Florence Flipo. When this Undo-SoftDeletedMailbox bjohnson@contoso.edu -WindowsLiveID brianj@contoso.edu -Password (Get-Credential).password ``` -This example recovers the deleted mailbox for the user Brian Johnson. When this mailbox was deleted, the associated Microsoft account wasn't deleted. Note that a new Microsoft account and password have to be created to recover this mailbox. In the scenario, the old Microsoft account is retained as a proxy address for the mailbox. +This example recovers the deleted mailbox for the user Brian Johnson. When this mailbox was deleted, the associated Microsoft account wasn't deleted. A new Microsoft account and password have to be created to recover this mailbox. In the scenario, the old Microsoft account is retained as a proxy address for the mailbox. ## PARAMETERS ### -SoftDeletedObject + +> Applicable: Exchange Online + The SoftDeletedObject parameter specifies the deleted mailbox to recover. You can use the alias or the email address of the deleted mailbox for the value of this parameter. Use the Get-Mailbox -SoftDeletedMailbox command to get information for deleted mailboxes. ```yaml Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Online + The PublicFolder switch is required to recover public folder mailboxes. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -93,7 +99,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -112,7 +120,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Online + The DisplayName parameter specifies the new display name for the recovered mailbox. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a new value for the Name property of the recovered mailbox. Otherwise, the original value is retained when the mailbox is recovered. The new name value is also used in the DistinguishedName property. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Online + The Password parameter specifies a new password for the mailbox. You can use the following methods as a value for this parameter: @@ -168,7 +182,6 @@ You have to include the Password parameter to recover a deleted mailbox with an Type: SecureString Parameter Sets: SoftDeletedMailbox Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 @@ -194,6 +209,9 @@ Accept wildcard characters: False ``` ### -WindowsLiveID + +> Applicable: Exchange Online + The WindowsLiveID parameter specifies a new Microsoft account (formerly known as a Windows Live ID) and primary SMTP address for the mailbox. The previous Microsoft account is retained as a proxy address for the mailbox. You have to include the WindowsLiveID parameter to recover a deleted mailbox with an existing Microsoft account that wasn't deleted with the mailbox. @@ -202,7 +220,6 @@ You have to include the WindowsLiveID parameter to recover a deleted mailbox wit Type: WindowsLiveId Parameter Sets: SoftDeletedMailbox Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md b/exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedUnifiedGroup.md similarity index 88% rename from exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedUnifiedGroup.md index 7402d91bdb..f8fa5fc6a6 100644 --- a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedUnifiedGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/undo-softdeletedunifiedgroup applicable: Exchange Online -title: Undo-SoftDeletedUnifiedGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/undo-softdeletedunifiedgroup +schema: 2.0.0 +title: Undo-SoftDeletedUnifiedGroup --- # Undo-SoftDeletedUnifiedGroup @@ -34,7 +35,7 @@ Soft-deleted Microsoft 365 Groups are groups that have been deleted, but can be To display all soft-deleted Microsoft 365 Groups in your organization, use the [Get-MgDirectoryDeletedItemAsGroup](https://learn.microsoft.com/powershell/module/microsoft.graph.identity.directorymanagement/get-mgdirectorydeleteditemasgroup) cmdlet in Microsoft Graph PowerShell. To permanently remove (purge) a soft-deleted Microsoft 365 Group, use the [Remove-MgDirectoryDeletedItem](https://learn.microsoft.com/powershell/module/microsoft.graph.identity.directorymanagement/remove-mgdirectorydeleteditem) cmdlet in Microsoft Graph PowerShell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +49,9 @@ This example restores the soft-deleted Microsoft 365 Group named Marketing Depar ## PARAMETERS ### -SoftDeletedObject + +> Applicable: Exchange Online + The SoftDeletedObject parameter specifies the soft-deleted Microsoft 365 Group that you want to restore. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -67,7 +71,6 @@ The SoftDeletedObject parameter specifies the soft-deleted Microsoft 365 Group t Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -86,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Uninstall-TransportAgent.md similarity index 82% rename from exchange/exchange-ps/exchange/Uninstall-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Uninstall-TransportAgent.md index 5618a653c7..16b4f889f2 100644 --- a/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Uninstall-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/uninstall-transportagent -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Uninstall-TransportAgent -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/uninstall-transportagent +schema: 2.0.0 +title: Uninstall-TransportAgent --- # Uninstall-TransportAgent @@ -36,7 +37,7 @@ You can install and uninstall transport agents in the following locations: - The Front End Transport service on Mailbox servers. - Edge Transport servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +51,15 @@ This example uninstalls a fictitious application named Test App from the Transpo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the display name of the transport agent that you want to uninstall. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: TransportAgentObjectId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -75,7 +81,6 @@ 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 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data 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. @@ -93,7 +101,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -115,7 +125,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/Update-AddressList.md similarity index 80% rename from exchange/exchange-ps/exchange/Update-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Update-AddressList.md index 8c44e68434..82e016cadf 100644 --- a/exchange/exchange-ps/exchange/Update-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-AddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-addresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-AddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-addresslist +schema: 2.0.0 +title: Update-AddressList --- # Update-AddressList @@ -29,7 +30,7 @@ Update-AddressList [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example updates the recipients of the address list named building4 that's u ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the address list that you want to update. You can use any value that uniquely identifies the address list. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the address list that you want to update. You c Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -73,7 +79,6 @@ 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 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md b/exchange/exchange-ps/ExchangePowerShell/Update-ComplianceCaseMember.md similarity index 91% rename from exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md rename to exchange/exchange-ps/ExchangePowerShell/Update-ComplianceCaseMember.md index dfbaff31dc..95df48bd89 100644 --- a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-ComplianceCaseMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-compliancecasemember applicable: Security & Compliance -title: Update-ComplianceCaseMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-compliancecasemember +schema: 2.0.0 +title: Update-ComplianceCaseMember --- # Update-ComplianceCaseMember @@ -50,6 +51,9 @@ This example replaces the existing members of the eDiscovery case named Case 515 ## PARAMETERS ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the name of the eDiscovery case that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. @@ -58,7 +62,6 @@ To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -68,7 +71,10 @@ Accept wildcard characters: False ``` ### -Members -The Members parameter specifies the users that will replace the current eDiscovery case members. You can use any value that uniquely identifies the user. For example: + +> Applicable: Security & Compliance + +The Members parameter specifies the users that replace the current eDiscovery case members. You can use any value that uniquely identifies the user. For example: - Name - Distinguished name (DN) @@ -81,7 +87,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -100,7 +108,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Update-DatabaseSchema.md b/exchange/exchange-ps/ExchangePowerShell/Update-DatabaseSchema.md similarity index 72% rename from exchange/exchange-ps/exchange/Update-DatabaseSchema.md rename to exchange/exchange-ps/ExchangePowerShell/Update-DatabaseSchema.md index 1ca485d6cb..57d4333d3b 100644 --- a/exchange/exchange-ps/exchange/Update-DatabaseSchema.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-DatabaseSchema.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-databaseschema -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-DatabaseSchema -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-databaseschema +schema: 2.0.0 +title: Update-DatabaseSchema --- # Update-DatabaseSchema @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Update-DatabaseSchema cmdlet to upgrade the database schema for one or more databases after an Exchange software update that includes database schema updates has been installed on Mailbox servers in a database availability group (DAG). Some software updates for Exchange may include database schema updates. After such an update has been installed on all members of a DAG, the administrator must run the Update-DatabaseSchema cmdlet for each database in the DAG and dismount/mount or failover the database to trigger the database schema update. The in-place database schema upgrade engine ensures that no schema updates occur until all members of the DAG have compatible versions of the software. +Use the Update-DatabaseSchema cmdlet to upgrade the database schema for one or more databases after an Exchange software update that includes database schema updates is installed on Mailbox servers in a database availability group (DAG). Some software updates for Exchange might include database schema updates. After such an update is installed on all members of a DAG, the administrator must run the Update-DatabaseSchema cmdlet for each database in the DAG and dismount/mount or failover the database to trigger the database schema update. The in-place database schema upgrade engine ensures that no schema updates occur until all members of the DAG have compatible versions of the software. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -28,7 +29,7 @@ Update-DatabaseSchema [-Identity] -MajorVersion - ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,6 +43,9 @@ This example updates the database schema for database DB1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox database for which you want to set one or more attributes. You can use any value that uniquely identifies the database. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the mailbox database for which you want to set Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -MajorVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -MinorVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -94,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -103,7 +113,6 @@ 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 Required: False Position: Named @@ -113,13 +122,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Update-DistributionGroupMember.md similarity index 77% rename from exchange/exchange-ps/exchange/Update-DistributionGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Update-DistributionGroupMember.md index cc94a00944..14bace8d2f 100644 --- a/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-DistributionGroupMember.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-distributiongroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Update-DistributionGroupMember -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-distributiongroupmember +schema: 2.0.0 +title: Update-DistributionGroupMember --- # Update-DistributionGroupMember ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Update-DistributionGroupMember cmdlet to replace all members of distribution groups and mail-enabled security groups. To add or remove existing group members, use the Add-DistributionGroupMember and Remove-DistributionGroupMember cmdlets. @@ -31,7 +32,7 @@ Update-DistributionGroupMember [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example replaces the existing members of the distribution group name Resear ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -79,7 +85,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -98,7 +106,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,7 +135,10 @@ Accept wildcard characters: False ``` ### -Members -The Members parameter specifies the recipients (mail-enabled objects) that will replace the current group members. You can use any value that uniquely identifies the recipient. For example: + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + +The Members parameter specifies the recipients (mail-enabled objects) that replace the current group members. You can use any value that uniquely identifies the recipient. For example: - Name - Alias @@ -137,7 +149,7 @@ The Members parameter specifies the recipients (mail-enabled objects) that will 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"`. -Although it isn't required, it's a good idea to add only security principals (for example, mailboxes and mail users with user accounts or other mail-enabled security groups) to mail-enabled security groups. If you assign permissions to a mail-enabled security group, any members that aren't security principals (for example, mail contacts or distribution groups) won't have the permissions assigned. +Although it isn't required, it's a good idea to add only security principals (for example, mailboxes and mail users with user accounts or other mail-enabled security groups) to mail-enabled security groups. If you assign permissions to a mail-enabled security group, any members that aren't security principals (for example, mail contacts or distribution groups) don't have the permissions assigned. The maximum number of entries for this parameter is 10000. @@ -145,7 +157,6 @@ The maximum number of entries for this parameter is 10000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 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/Update-EmailAddressPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Update-EmailAddressPolicy.md similarity index 80% rename from exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Update-EmailAddressPolicy.md index a5ab8316da..ee26653d15 100644 --- a/exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-EmailAddressPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-emailaddresspolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-EmailAddressPolicy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-emailaddresspolicy +schema: 2.0.0 +title: Update-EmailAddressPolicy --- # Update-EmailAddressPolicy @@ -31,7 +32,7 @@ Update-EmailAddressPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example applies the email address policy named Northwest Executives to all ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the email address policy that you want to apply to recipients. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the email address policy that you want to apply Type: EmailAddressPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -74,7 +80,6 @@ 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 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -FixMissingAlias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The FixMissingAlias switch repairs recipients that don't have an alias. The alias is generated based on the Name property of the recipient. You don't need to specify a value with this switch. You need to use this switch if you receive an error message when you attempt to update the email address policy, global address list, or address list. @@ -108,7 +118,6 @@ You need to use this switch if you receive an error message when you attempt to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -UpdateSecondaryAddressesOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The UpdateSecondaryAddressesOnly switch specifies that only the proxy email addresses are updated for the recipients. You don't need to specify a value with this switch. The recipient's primary email address isn't updated. @@ -126,7 +138,6 @@ The recipient's primary email address isn't updated. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-ExchangeHelp.md b/exchange/exchange-ps/ExchangePowerShell/Update-ExchangeHelp.md similarity index 79% rename from exchange/exchange-ps/exchange/Update-ExchangeHelp.md rename to exchange/exchange-ps/ExchangePowerShell/Update-ExchangeHelp.md index 01778dcf54..2b5969d380 100644 --- a/exchange/exchange-ps/exchange/Update-ExchangeHelp.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-ExchangeHelp.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-exchangehelp -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-ExchangeHelp -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-exchangehelp +schema: 2.0.0 +title: Update-ExchangeHelp --- # Update-ExchangeHelp @@ -30,7 +31,7 @@ The Update-ExchangeHelp cmdlet is available in Exchange Server 2013 or later. You need to run the Update-ExchangeHelp cmdlet on each Exchange server. By default, the cmdlet requires an Internet connection, but you can configure an offline mode. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,15 +45,17 @@ This example checks for the latest available version of Help for the Exchange Ma ## PARAMETERS ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -By default, the Update-ExchangeHelp cmdlet has a throttling period of 24 hours. If you run this cmdlet within 24 hours of the last time you ran it, it won't check for updates. You can use this switch to force the cmdlet to check for updates more frequently and to display status or error messages. +By default, the Update-ExchangeHelp cmdlet has a throttling period of 24 hours. If you run this cmdlet within 24 hours of the last time you ran it, the cmdlet doesn't check for updates. You can use this switch to force the cmdlet to check for updates more frequently and to display status or error messages. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-FileDistributionService.md b/exchange/exchange-ps/ExchangePowerShell/Update-FileDistributionService.md similarity index 89% rename from exchange/exchange-ps/exchange/Update-FileDistributionService.md rename to exchange/exchange-ps/ExchangePowerShell/Update-FileDistributionService.md index 869bf696a3..c7ef1e4eaf 100644 --- a/exchange/exchange-ps/exchange/Update-FileDistributionService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-FileDistributionService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-filedistributionservice applicable: Exchange Server 2010 -title: Update-FileDistributionService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-filedistributionservice +schema: 2.0.0 +title: Update-FileDistributionService --- # Update-FileDistributionService @@ -34,7 +35,7 @@ The Update-FileDistributionService cmdlet forces the Microsoft Exchange File Dis If you don't use the Type parameter when running this command, OAB, Unified Messaging, and Group Metrics data are reloaded. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,6 +63,9 @@ This example polls Server1 for changes to Group Metrics files associated with Se ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the Exchange server where you want to run this Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -92,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010 + The Type parameter specifies whether to reload OAB, Unified Messaging, or Group Metrics data. If you don't use the Type parameter when running this command, OAB, Unified Messaging, and Group Metrics data are reloaded. The Type parameter takes the following values: @@ -130,7 +140,6 @@ The Type parameter takes the following values: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-GlobalAddressList.md b/exchange/exchange-ps/ExchangePowerShell/Update-GlobalAddressList.md similarity index 79% rename from exchange/exchange-ps/exchange/Update-GlobalAddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Update-GlobalAddressList.md index 8fe39ea94d..a5ac3dd34c 100644 --- a/exchange/exchange-ps/exchange/Update-GlobalAddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-GlobalAddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-globaladdresslist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-GlobalAddressList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-globaladdresslist +schema: 2.0.0 +title: Update-GlobalAddressList --- # Update-GlobalAddressList @@ -29,7 +30,7 @@ Update-GlobalAddressList [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example updates the recipients in the default GAL. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the global address list that you want to update. You can use any value that uniquely identifies the GAL. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the global address list that you want to update Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -72,7 +78,6 @@ 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 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Update-HybridConfiguration.md similarity index 82% rename from exchange/exchange-ps/exchange/Update-HybridConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Update-HybridConfiguration.md index bb0e1ea9e9..f5c22913e3 100644 --- a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-HybridConfiguration.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-hybridconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Update-HybridConfiguration -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-hybridconfiguration +schema: 2.0.0 +title: Update-HybridConfiguration --- # Update-HybridConfiguration ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Update-HybridConfiguration cmdlet to define the credentials that are used to update the hybrid configuration object. @@ -31,7 +32,7 @@ Update-HybridConfiguration -OnPremisesCredentials -TenantCredenti ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +56,9 @@ Use the last command to define the credentials that are used to update the hybri ## PARAMETERS ### -OnPremisesCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The OnPremisesCredentials parameter specifies the on-premises Active Directory account and password that's used to configure the hybrid configuration object. This account must be a member of the Organization Management role group. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -63,7 +67,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -TenantCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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] @@ -84,7 +90,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -103,7 +111,6 @@ 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 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -121,7 +131,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. This confirmation prompt is displayed only when the existing HybridConfiguration Active Directory object version is Exchange 2010. @@ -139,7 +151,6 @@ This confirmation prompt is displayed only when the existing HybridConfiguration Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -SuppressOAuthWarning + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Update-MailboxDatabaseCopy.md similarity index 82% rename from exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Update-MailboxDatabaseCopy.md index b7f5614479..0e94dc981e 100644 --- a/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-mailboxdatabasecopy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-MailboxDatabaseCopy -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-mailboxdatabasecopy +schema: 2.0.0 +title: Update-MailboxDatabaseCopy --- # Update-MailboxDatabaseCopy @@ -79,7 +80,7 @@ The Update-MailboxDatabaseCopy cmdlet can also be used to seed a content index c You must suspend a database copy before you can update it using the Update-MailboxDatabaseCopy cmdlet. For detailed steps about how to suspend a database copy, see [Suspend or resume a mailbox database copy](https://learn.microsoft.com/Exchange/high-availability/manage-ha/suspend-resume-db-copies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -121,13 +122,15 @@ This example performs a full server reseed of all of the databases on the Mailbo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the name or GUID of the mailbox database whose copy is being seeded. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: CancelSeed, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -137,13 +140,15 @@ Accept wildcard characters: False ``` ### -CancelSeed + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CancelSeed switch specifies whether to cancel an in-progress seeding operation. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: CancelSeed Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -153,13 +158,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter is used as part of a full server reseed operation. It can be used with the MaximumSeedsInParallel parameter to start reseeds of database copies in parallel across the specified server in batches of up to the value of the MaximumSeedsInParallel parameter copies at a time. ```yaml Type: MailboxServerIdParameter Parameter Sets: ExplicitServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -169,6 +176,9 @@ Accept wildcard characters: False ``` ### -BeginSeed + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BeginSeed switch asynchronously starts the seeding operation and then exits the cmdlet. You don't need to specify a value with this switch. This switch is useful for scripting reseeds. @@ -177,7 +187,6 @@ This switch is useful for scripting reseeds. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,13 +196,15 @@ Accept wildcard characters: False ``` ### -CatalogOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The CatalogOnly switch specifies that only the content index catalog for the database copy should be seeded. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,6 +214,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -212,7 +226,6 @@ 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 Required: False Position: Named @@ -222,13 +235,15 @@ Accept wildcard characters: False ``` ### -DatabaseOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DatabaseOnly switch specifies that only the database copy should be seeded. The content index catalog isn't seeded. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,6 +253,9 @@ Accept wildcard characters: False ``` ### -DeleteExistingFiles + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DeleteExistingFiles switch specifies whether to remove the existing log files at the target location. You don't need to specify a value with this switch. This switch removes only the files that it checks for and fails if other files are present. No action is taken on other files at the target location. Therefore, if database-related files are present, you must manually remove them. @@ -246,7 +264,6 @@ This switch removes only the files that it checks for and fails if other files a Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -256,13 +273,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -272,6 +291,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -280,7 +302,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -290,6 +311,9 @@ Accept wildcard characters: False ``` ### -ManualResume + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The ManualResume switch specifies whether to automatically resume replication on the database copy. You don't need to specify a value with this switch. With this switch, you can manually resume replication to the database copy. @@ -298,7 +322,6 @@ With this switch, you can manually resume replication to the database copy. Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -308,13 +331,15 @@ Accept wildcard characters: False ``` ### -MaximumSeedsInParallel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The MaximumSeedsInParallel parameter is used with the Server parameter to specify the maximum number of parallel seeding operations that should occur across the specified server during a full server reseed operation. The default value is 10. ```yaml Type: Int32 Parameter Sets: ExplicitServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,13 +349,15 @@ Accept wildcard characters: False ``` ### -Network -The Network parameter specifies which DAG network should be used for seeding. Note that content index catalog seeding always occurs over the MAPI network, even if you use this parameter to specify the DAG network. + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The Network parameter specifies which DAG network should be used for seeding. Content index catalog seeding always occurs over the MAPI network, even if you use this parameter to specify the DAG network. ```yaml Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,13 +367,15 @@ Accept wildcard characters: False ``` ### -NetworkCompressionOverride + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NetworkCompressionOverride parameter specifies whether to override the current DAG network compression settings. ```yaml Type: UseDagDefaultOnOff Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +385,15 @@ Accept wildcard characters: False ``` ### -NetworkEncryptionOverride + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NetworkEncryptionOverride parameter specifies whether to override the current DAG encryption settings. ```yaml Type: UseDagDefaultOnOff Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -372,13 +403,15 @@ Accept wildcard characters: False ``` ### -NoThrottle + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The NoThrottle switch prevents the seeding operation from being throttled. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -388,13 +421,15 @@ Accept wildcard characters: False ``` ### -PrimaryDatabasePartitionOnly + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -404,6 +439,9 @@ Accept wildcard characters: False ``` ### -SafeDeleteExistingFiles + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SafeDeleteExistingFiles switch specifies a seeding operation with a single copy redundancy pre-check prior to the seed. You don't need to specify a value with this switch. Because this switch includes the redundancy safety check, it requires a lower level of permissions than the DeleteExistingFiles parameter. Limited permission administrators can perform the seeding operation by using this switch. @@ -412,7 +450,6 @@ Because this switch includes the redundancy safety check, it requires a lower le Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -422,13 +459,15 @@ Accept wildcard characters: False ``` ### -SecondaryDatabasePartitionOnly + +> Applicable: Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -438,6 +477,9 @@ Accept wildcard characters: False ``` ### -SourceServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The SourceServer parameter specifies the Mailbox server with a passive copy of the mailbox database to be used as the source for the seed operation. You can use any value that uniquely identifies the server. For example: @@ -451,7 +493,6 @@ The SourceServer parameter specifies the Mailbox server with a passive copy of t Type: ServerIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -461,13 +502,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/Update-OfflineAddressBook.md similarity index 80% rename from exchange/exchange-ps/exchange/Update-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/Update-OfflineAddressBook.md index c9dd29eb20..7b0a285910 100644 --- a/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-OfflineAddressBook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-offlineaddressbook -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-OfflineAddressBook -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-offlineaddressbook +schema: 2.0.0 +title: Update-OfflineAddressBook --- # Update-OfflineAddressBook @@ -30,7 +31,7 @@ Update-OfflineAddressBook [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +45,9 @@ This example updates the OAB MyOAB. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the GUID, distinguished name (DN), or OAB name that represents a specific OAB. You can also include the path by using the format Server\\OfflineAddressBookName. You can omit the parameter label Identity so that only the OAB name or GUID is supplied. @@ -52,7 +56,6 @@ You can omit the parameter label Identity so that only the OAB name or GUID is s Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -71,7 +77,6 @@ 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 Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,6 +104,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -105,7 +115,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-PublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolder.md similarity index 88% rename from exchange/exchange-ps/exchange/Update-PublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Update-PublicFolder.md index 52de562a91..3c4332d4c8 100644 --- a/exchange/exchange-ps/exchange/Update-PublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-publicfolder applicable: Exchange Server 2010 -title: Update-PublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-publicfolder +schema: 2.0.0 +title: Update-PublicFolder --- # Update-PublicFolder @@ -29,7 +30,7 @@ Update-PublicFolder [-Identity] -Server Applicable: Exchange Server 2010 + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path by using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -58,7 +62,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Mailbox server that holds the source public folder database for replication. You can use any value that uniquely identifies the server. For example: - Name @@ -79,7 +85,6 @@ The Server parameter specifies the Mailbox server that holds the source public f Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -124,13 +133,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-PublicFolderHierarchy.md b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderHierarchy.md similarity index 86% rename from exchange/exchange-ps/exchange/Update-PublicFolderHierarchy.md rename to exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderHierarchy.md index c8bcc1dc98..a245e2ba23 100644 --- a/exchange/exchange-ps/exchange/Update-PublicFolderHierarchy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderHierarchy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-publicfolderhierarchy applicable: Exchange Server 2010 -title: Update-PublicFolderHierarchy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-publicfolderhierarchy +schema: 2.0.0 +title: Update-PublicFolderHierarchy --- # Update-PublicFolderHierarchy @@ -29,7 +30,7 @@ Update-PublicFolderHierarchy -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +44,9 @@ This example pipes the output of the Get-MailboxServer command to the Update-Pub ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Mailbox server that holds the source public folder database for replication. You can use any value that uniquely identifies the server. For example: - Name @@ -54,7 +58,6 @@ The Server parameter specifies the Mailbox server that holds the source public f Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + 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`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + 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 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderMailbox.md similarity index 76% rename from exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderMailbox.md index cfef60bbfd..41d8f95ea9 100644 --- a/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderMailbox.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-publicfoldermailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Update-PublicFolderMailbox -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-publicfoldermailbox +schema: 2.0.0 +title: Update-PublicFolderMailbox --- # Update-PublicFolderMailbox ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Update-PublicFolderMailbox cmdlet to update the hierarchy for public folders. @@ -47,7 +48,7 @@ Update-PublicFolderMailbox [-Identity] -FolderId Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the public folder mailbox that you want to update. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -85,7 +89,6 @@ The Identity parameter specifies the public folder mailbox that you want to upda Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -95,13 +98,15 @@ Accept wildcard characters: False ``` ### -FolderId + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FolderId parameter specifies the GUID or name of the public folder that you want to synchronize. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. ```yaml Type: PublicFolderIdParameter Parameter Sets: InvokeSingleFolderSynchronizer Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -111,15 +116,17 @@ Accept wildcard characters: False ``` ### -InvokeSynchronizer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The InvokeSynchronizer switch can only be used on secondary hierarchy public folder mailboxes and triggers hierarchy synchronization from the primary public folder mailbox to the specified secondary public folder mailbox. You don't need to specify a value with this switch. This switch should only be used for troubleshooting purposes. ```yaml Type: SwitchParameter -Parameter Sets: InvokeSingleFolderSynchronizer +Parameter Sets: InvokeSingleFolderSynchronizer, InvokeSynchronizer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -128,20 +135,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: InvokeSynchronizer -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online -### -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`. @@ -151,7 +148,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -161,13 +157,15 @@ Accept wildcard characters: False ``` ### -CreateAssociatedDumpster + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The CreateAssociatedDumpster switch specifies whether to create the associated dumpster before synchronizing the folder. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: InvokeSingleFolderSynchronizer Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -177,6 +175,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -185,7 +186,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -195,13 +195,15 @@ Accept wildcard characters: False ``` ### -ForceOnlineSync + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The ForceOnlineSync switch specifies whether to force the secondary public folder mailbox to synchronize with the primary public folder mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: InvokeSynchronizer Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -211,13 +213,15 @@ Accept wildcard characters: False ``` ### -FullSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The FullSync switch specifies that you want to perform a full synchronization of the public folder mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: InvokeSynchronizer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -227,11 +231,14 @@ Accept wildcard characters: False ``` ### -ReconcileFolders -The ReconcileFolders switch specifies whether to look closely for differences in the folder hierarchy between the primary public folder mailbox and the secondary public folder mailbox. Folders that exist in the primary public folder mailbox and not in the secondary will be recreated. You don't need to specify a value with this switch. -In on-premises Exchange, folders that exist in the secondary public folder mailbox and not in the primary will be deleted. +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The ReconcileFolders switch specifies whether to look closely for differences in the folder hierarchy between the primary public folder mailbox and the secondary public folder mailbox. Folders that exist in the primary public folder mailbox and not in the secondary are recreated. You don't need to specify a value with this switch. + +In on-premises Exchange, folders that exist in the secondary public folder mailbox and not in the primary are deleted. -In Exchange Online, folders that exist in the secondary public folder mailbox and not in the primary will be moved to \NON_IPM_SUBTREE\LOST_AND_FOUND. See [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/introducing-public-folder-8220-lost-and-found-8221-functionality/ba-p/604043) for more details about LOST_AND_FOUND functionality. +In Exchange Online, folders that exist in the secondary public folder mailbox and not in the primary are moved to \NON_IPM_SUBTREE\LOST_AND_FOUND. See [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/introducing-public-folder-8220-lost-and-found-8221-functionality/ba-p/604043) for more details about LOST_AND_FOUND functionality. In both the scenarios, public folders that were deleted or moved to LOST_AND_FOUND can be restored using Set-PublicFolder command. @@ -243,13 +250,12 @@ This example restores the public folder named "Documents" from LOST_AND_FOUND to `Set-PublicFolder -Identity \NON_IPM_SUBTREE\DUMPSTER_ROOT\DUMPSTER_EXTEND\RESERVED_1\RESERVED_1\9f32c468-4bc2-42aa-b979-16a057394b2f\Documents -Path \Engineering` -**Note**: You should use the ReconcileFolders switch only for repair or troubleshooting purposes to look for differences in the public folder hierarchy that aren't detected by a regular synchronization. These undetected differences may occur in database failover or disaster recovery scenarios. You must use this switch with the InvokeSynchronizer switch. +**Note**: You should use the ReconcileFolders switch only for repair or troubleshooting purposes to look for differences in the public folder hierarchy that aren't detected by a regular synchronization. These undetected differences might occur in database failover or disaster recovery scenarios. You must use this switch with the InvokeSynchronizer switch. ```yaml Type: SwitchParameter Parameter Sets: InvokeSynchronizer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -259,17 +265,19 @@ Accept wildcard characters: False ``` ### -SuppressStatus -The SuppressStatus switch specifies that the output of this cmdlet is suppressed and that the command will run asynchronously in the background from the Exchange Management Shell. You don't need to specify a value with this switch. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + +The SuppressStatus switch specifies that the output of this cmdlet is suppressed and that the command runs asynchronously in the background from the Exchange Management Shell. You don't need to specify a value with this switch. You can only use this switch with the InvokeSynchronizer switch. -If you don't use this switch, the output will display status messages every 3 seconds for up to one minute. Until the minute passes, you can't use the PowerShell Window for other commands. +If you don't use this switch, the output displays status messages every 3 seconds for up to one minute. Until the minute passes, you can't use the PowerShell Window for other commands. ```yaml Type: SwitchParameter Parameter Sets: InvokeSynchronizer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -279,13 +287,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-Recipient.md b/exchange/exchange-ps/ExchangePowerShell/Update-Recipient.md similarity index 80% rename from exchange/exchange-ps/exchange/Update-Recipient.md rename to exchange/exchange-ps/ExchangePowerShell/Update-Recipient.md index c4b96b4b18..1da8470535 100644 --- a/exchange/exchange-ps/exchange/Update-Recipient.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-Recipient.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-recipient -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Update-Recipient -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-recipient +schema: 2.0.0 +title: Update-Recipient --- # Update-Recipient ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Update-Recipient cmdlet to add Exchange attributes to recipient objects. @@ -36,7 +37,7 @@ In on-premises Exchange, before you can run the Update-Recipient cmdlet to conve - mailNickname - msExchHomeServerName -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,6 +58,9 @@ In on-premises Exchange, this example updates all contacts in a specific organiz ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Identity parameter specifies the recipient that you want to update. You can use any value that uniquely identifies the recipient. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the recipient that you want to update. You can Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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`. @@ -89,7 +95,6 @@ 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 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + The Credential parameter specifies the username and password to use to access Active Directory. 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). @@ -107,7 +115,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The 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. @@ -125,7 +135,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-RoleGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Update-RoleGroupMember.md similarity index 80% rename from exchange/exchange-ps/exchange/Update-RoleGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Update-RoleGroupMember.md index 8c47b09f10..d1c9b5f696 100644 --- a/exchange/exchange-ps/exchange/Update-RoleGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-RoleGroupMember.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-rolegroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Update-RoleGroupMember -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-rolegroupmember +schema: 2.0.0 +title: Update-RoleGroupMember --- # Update-RoleGroupMember ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Update-RoleGroupMember cmdlet to modify the members of a management role group. @@ -35,13 +36,13 @@ The Update-RoleGroupMember cmdlet enables you to replace the entire membership l The Add-RoleGroupMember and Remove-RoleGroupMember cmdlets can be used to add or remove role group members. You can combine these cmdlets with other cmdlets, such as Get-Mailbox, to add or remove multiple members without overwriting the entire membership list at once. -If the ManagedBy property has been populated with role group managers, the user updating role group membership must be a role group manager. Alternately, if the user is a member of the Organization Management role group or is directly or indirectly assigned the Role Management role, the BypassSecurityGroupManagerCheck switch can be used to override the security group management check. +If the ManagedBy property is populated with role group managers, the user updating role group membership must be a role group manager. Alternately, if the user is a member of the Organization Management role group or is directly or indirectly assigned the Role Management role, the BypassSecurityGroupManagerCheck switch can be used to override the security group management check. If the role group is a linked role group, you can't use the Update-RoleGroupMember cmdlet to modify members on the role group. Instead, you need to modify members on the foreign universal security group (USG) that's linked to the linked role group. To find the foreign USG that's linked to a role group, use the Get-RoleGroup cmdlet. For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,13 +76,15 @@ Mail-enabled security group: If you want to add or remove a mail-enabled securit ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group whose membership you want to modify. If the name of the role group contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -102,7 +108,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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`. @@ -121,7 +129,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -139,7 +149,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + The Members parameter specifies the mailboxes or mail-enabled USGs to add as a member of the role group. You can identify the user or group by the name, DN, or primary SMTP address value. You can specify multiple members separated by commas (`Value1,Value2,...ValueN`). If the value contains spaces, enclose the value in quotation marks (`"Value 1","Value 2",..."Value N"`). By default, the values that you specify overwrite the existing membership list of the role group. To add or remove multiple members without replacing the entire membership list, see the Examples section. @@ -157,7 +169,6 @@ By default, the values that you specify overwrite the existing membership list o Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -175,7 +189,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-SafeList.md b/exchange/exchange-ps/ExchangePowerShell/Update-SafeList.md similarity index 78% rename from exchange/exchange-ps/exchange/Update-SafeList.md rename to exchange/exchange-ps/ExchangePowerShell/Update-SafeList.md index 9b052ebd8b..da2acef985 100644 --- a/exchange/exchange-ps/exchange/Update-SafeList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-SafeList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-safelist -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-SafeList -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-safelist +schema: 2.0.0 +title: Update-SafeList --- # Update-SafeList @@ -34,9 +35,9 @@ Update-SafeList [-Identity] ## DESCRIPTION The Update-SafeList cmdlet reads the safelist aggregation data stored on a Microsoft Outlook user mailbox and then hashes and writes the data to the corresponding user object in Active Directory. The command compares the binary attribute created to any value stored on the attribute. If the two values are identical, the command doesn't update the user attribute value with the safelist aggregation data. Safelist aggregation data contains the Outlook user's Safe Senders List and Safe Recipients List. -Be mindful of the network and replication traffic that may be generated when you run the Update-SafeList cmdlet. Running the command on multiple mailboxes where safelists are heavily used may generate a significant amount of traffic. We recommend that if you run the command on multiple mailboxes, you should run the command during off-peak, non-business hours. +Be mindful of the network and replication traffic that might be generated when you run the Update-SafeList cmdlet. Running the command on multiple mailboxes where safelists are heavily used might generate a significant amount of traffic. We recommend that if you run the command on multiple mailboxes, you should run the command during off-peak, non-business hours. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +60,9 @@ This example updates safelist data for all user mailboxes in your Exchange organ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox from which you want to collect safelist aggregation data. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -76,7 +80,6 @@ The Identity parameter specifies the mailbox from which you want to collect safe Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -95,7 +101,6 @@ 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 Required: False Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -EnsureJunkEmailRule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The EnsureJunkEmailRule switch forces the junk email rule to be turned on for the mailbox if the rule isn't turned on already. You don't need to specify a value with this switch. The junk email rule can only be created after the user logs on to the mailbox. If the user has never logged on to the mailbox, this parameter can't turn on the junk email rule. @@ -129,7 +139,6 @@ The junk email rule can only be created after the user logs on to the mailbox. I Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,17 +148,19 @@ Accept wildcard characters: False ``` ### -IncludeDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The IncludeDomains switch specifies whether to include the sender domains specified by users in Outlook in the safelist aggregation data. You don't need to specify a value with this switch. By default, domains specified by the senders aren't included. -In most cases, we don't recommend that you include domains because users may include the domains of large Internet service providers (ISPs), which could unintentionally provide addresses that may be used or spoofed by spammers. +In most cases, we don't recommend that you include domains because users might include the domains of large Internet service providers (ISPs), which could unintentionally provide addresses that might be used or spoofed by spammers. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +170,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Type parameter specifies which user-generated list is updated to the user object. Valid values for this parameter are SafeSenders, SafeRecipients, and Both. The default value is SafeSenders. The safelist aggregation feature doesn't act on Safe Recipients List data. We don't recommend running the Type parameter with the SafeRecipients or Both values. @@ -167,7 +181,6 @@ The safelist aggregation feature doesn't act on Safe Recipients List data. We do Type: UpdateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-SiteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Update-SiteMailbox.md similarity index 79% rename from exchange/exchange-ps/exchange/Update-SiteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Update-SiteMailbox.md index e56a3a732f..66e33b2771 100644 --- a/exchange/exchange-ps/exchange/Update-SiteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-SiteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-sitemailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-SiteMailbox -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-sitemailbox +schema: 2.0.0 +title: Update-SiteMailbox --- # Update-SiteMailbox @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Update-SiteMailbox cmdlet to trigger a Microsoft SharePoint synchronization. This command synchronizes document content membership and permissions into Microsoft Exchange. You may need to perform this action when troubleshooting document or membership synchronization issues. +Use the Update-SiteMailbox cmdlet to trigger a Microsoft SharePoint synchronization. This command synchronizes document content membership and permissions into Microsoft Exchange. You might need to perform this action when troubleshooting document or membership synchronization issues. Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). @@ -37,7 +38,7 @@ Update-SiteMailbox [-Identity] ## DESCRIPTION If you are running this command against a site mailbox in which you aren't the owner, you need to use the BypassOwnerCheck parameter to run this cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +59,9 @@ This example updates the site mailbox WinterHoliday@tailspintoys.com and perform ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the site mailbox that you want to update. You can use any value that uniquely identifies the site mailbox. For example: - Name @@ -71,7 +75,6 @@ The Identity parameter specifies the site mailbox that you want to update. You c Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -BypassOwnerCheck + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. @@ -89,7 +95,6 @@ If you don't use this switch, and you aren't a member or owner of the site mailb Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -108,7 +116,6 @@ 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 Required: False Position: Named @@ -118,13 +125,17 @@ Accept wildcard characters: False ``` ### -FullSync -The FullSync switch specifies full sync is expensive and will have a performance impact on the Exchange system. You don't need to specify a value with this switch. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + +The FullSync switch specifies a full synchronization. You don't need to specify a value with this switch. + +Full synchronizations are expensive and affect the performance of the Exchange system. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +145,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +163,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Server parameter specifies the fully qualified domain name (FQDN) or the Microsoft SharePoint server on which the site mailbox is located. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +181,9 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Target parameter specifies whether to update the SharePoint documents, the site mailbox's membership list or both. This parameter accepts the following values: - All @@ -178,7 +196,6 @@ If you don't specify this parameter when you run the cmdlet, this parameter valu Type: TargetType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-StoreMailboxState.md b/exchange/exchange-ps/ExchangePowerShell/Update-StoreMailboxState.md similarity index 80% rename from exchange/exchange-ps/exchange/Update-StoreMailboxState.md rename to exchange/exchange-ps/ExchangePowerShell/Update-StoreMailboxState.md index d586e3c49e..58865bb16f 100644 --- a/exchange/exchange-ps/exchange/Update-StoreMailboxState.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-StoreMailboxState.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-storemailboxstate -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-StoreMailboxState -schema: 2.0.0 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-storemailboxstate +schema: 2.0.0 +title: Update-StoreMailboxState --- # Update-StoreMailboxState @@ -28,9 +29,9 @@ Update-StoreMailboxState -Database -Identity Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Database parameter specifies the mailbox database that contains the mailbox. You can use any value that uniquely identifies the database. For example: - Name @@ -68,7 +72,6 @@ The Database parameter specifies the mailbox database that contains the mailbox. Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The Identity parameter specifies the mailbox that you want to update. Use the mailbox GUID as the value for this parameter. Run the following command to obtain the mailbox GUID and other information for all mailboxes in your organization: Get-MailboxDatabase | Get-MailboxStatistics | Format-List DisplayName,MailboxGuid,Database,DisconnectReason,DisconnectDate. @@ -86,7 +92,6 @@ Run the following command to obtain the mailbox GUID and other information for a Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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`. @@ -105,7 +113,6 @@ 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 Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +155,6 @@ To see the return types, which are also known as output types, that this cmdlet ## NOTES If a mailbox is moved to another database, the mailbox is immediately disabled. There's a 24-hour delay to allow for replication. -In this scenario, Update-StoreMailboxState might not immediately update the DisconnectState and DisconnectReason properties in the output of Get-MailboxStatistics. The values will update approximately 24 hours after the move. +In this scenario, Update-StoreMailboxState might not immediately update the DisconnectState and DisconnectReason properties in the output of Get-MailboxStatistics. The values update approximately 24 hours after the move. ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Update-VivaModuleFeaturePolicy.md similarity index 74% rename from exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Update-VivaModuleFeaturePolicy.md index 9d677d3db1..aebd5b6c89 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-VivaModuleFeaturePolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/update-vivamodulefeaturepolicy applicable: Exchange Online -title: Update-VivaModuleFeaturePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-vivamodulefeaturepolicy +schema: 2.0.0 +title: Update-VivaModuleFeaturePolicy --- # Update-VivaModuleFeaturePolicy @@ -15,42 +15,24 @@ 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**: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available. - -Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module or a category in Viva. +Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module in Viva. - You can't update a policy for a particular user or group to include the entire tenant if a policy for the entire tenant already exists for the feature. Only one tenant-wide policy is supported. -- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature/category is enabled. If a user has multiple policies assigned for a feature/category (directly as a user or member of a group), the most restrictive policy applies. -- You can only update user controls at the feature policy level, not the category policy level. -- 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. +- 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/exchangepowershell/get-vivamodulefeature) cmdlet. Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX - -### FeaturePolicy ``` Update-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId [-Confirm] [-Everyone ] [-IsFeatureEnabled ] [-IsUserControlEnabled ] - [-GroupIds ] - [-Name ] - [-ResultSize ] - [-UserIds ] - [-WhatIf] - [] -``` - -### CategoryPolicy -``` -Update-VivaModuleFeaturePolicy> -CategoryId -PolicyId - [-Confirm] - [-Everyone ] + [-IsUserOptedInByDefault ] [-GroupIds ] [-Name ] [-ResultSize ] @@ -60,18 +42,16 @@ Update-VivaModuleFeaturePolicy> -CategoryId -PolicyId ``` ## DESCRIPTION -Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module or a category in Viva. - -Support for categories is available in version 3.5.0-Preview2 or later of the 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) or the category (IsCategoryEnabled parameter). +- Whether or not the policy enables the feature (IsFeatureEnabled parameter). - Whether or not the policy enables user controls (IsUserControlEnabled parameter, only applicable to a feature policy). - Who the policy applies to (the UserIds and GroupIds parameters or the Everyone parameter). -You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureEnabled/IsCategoryEnabled parameter, the name of the policy is updated but whether or not the policy enables the feature/category remains unchanged. +You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureEnabled parameter, the name of the policy is updated but whether or not the policy enables the feature remains unchanged. **Important**: Values that you specify for the UserIds and/or GroupIds parameters or the Everyone parameter **overwrite** any existing users or groups. To preserve the existing users and groups, you need to specify those existing users or groups **and** any additional users or groups that you want to add. Not including existing users or groups in the command effectively removes those specific users or groups from the policy. For more information, see the examples. @@ -120,66 +100,25 @@ This example updates the name of the specified policy, makes it so the policy en ### Example 5 ```powershell -Update-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsCategoryEnabled $false +Update-VivaModuleFeaturePolicy -ModuleId PeopleSkills -FeatureId ShowAISkills -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -IsFeatureEnabled $true -IsUserControlEnabled $true -IsUserOptedInByDefault $false ``` -This example updates the name of the specified policy and makes it so the policy does not enable the category (effectively all features under the category). - -### Example 6 -```powershell -Update-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 -``` - -This example updates who the specified policy applies to. The policy now applies **only** to the specified groups, overwriting the users and groups the policy used to apply to. - -### Example 7 -```powershell -Update-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -UserIds user1@contoso.com,user2@contoso.com -``` - -This example updates who the specified policy applies to. The policy now applies **only** to the specified users, overwriting the users and groups the policy used to apply to. - -### Example 8 -```powershell -Update-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsCategoryEnabled $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 category (effectively all features under the category), 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. +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 -### -CategoryId -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. - -The CategoryId parameter specifies the category of the policy that you want to update. - -To view details about the categories that support feature access controls, use the Get-FeatureCategory cmdlet. The CategoryId value is returned in the output of the cmdlet. - -```yaml -Type: String -Parameter Sets: CategoryPolicy -Aliases: -Applicable: Exchange Online +### -FeatureId -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -FeatureId The FeatureId parameter specifies the feature in the Viva module of the policy that you want to update. To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -189,13 +128,15 @@ Accept wildcard characters: False ``` ### -ModuleId + +> Applicable: Exchange Online + The ModuleId parameter specifies the Viva module of the policy that you want to update. ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -205,6 +146,9 @@ Accept wildcard characters: False ``` ### -PolicyId + +> Applicable: Exchange Online + The PolicyId parameter specifies the policy for the feature in the Viva module that you want to update. To view details about the policies for a feature in a Viva module, use the Get-VivaModuleFeaturePolicy cmdlet. The PolicyId value is returned in the output of the cmdlet. @@ -213,7 +157,6 @@ To view details about the policies for a feature in a Viva module, use the Get-V Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -223,6 +166,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + 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`. @@ -232,7 +178,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -242,6 +187,9 @@ Accept wildcard characters: False ``` ### -Everyone + +> Applicable: Exchange Online + The Everyone parameter specifies that the updated policy applies to all users in the organization. Valid values are: - $true: The policy applies to all users. This is the only useful value for this parameter. @@ -255,7 +203,6 @@ Don't use this parameter with the GroupIds or UserIds parameters. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -265,6 +212,9 @@ Accept wildcard characters: False ``` ### -GroupIds + +> Applicable: Exchange Online + 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. @@ -281,7 +231,6 @@ To have the updated policy apply to all users in the organization, use the Every Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -289,24 +238,21 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -IsFeatureEnabled -### -IsCategoryEnabled -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. +> Applicable: Exchange Online -The IsCategoryEnabled parameter specifies whether the category is enabled by the updated policy. Valid values are: +The IsFeatureEnabled parameter specifies whether the feature is enabled by the updated policy. Valid values are: -- $true: The category (effectively all features under the category) is enabled by the policy. -- $false: The category (effectively all features under the category) is not enabled by the policy. +- $true: The feature is enabled by the policy. +- $false: The feature is not enabled by the policy. -If you don't want to update whether the category is enabled by the policy, don't use this parameter. +If you don't want to update whether the feature is enabled by the policy, don't use this parameter. ```yaml Type: Boolean -Parameter Sets: CategoryPolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -315,19 +261,25 @@ 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: +### -IsUserControlEnabled -- $true: The feature is enabled by the policy. -- $false: The feature is not enabled by the policy. +> Applicable: Exchange Online -If you don't want to update whether the feature is enabled by the policy, don't use this parameter. +**Note**: This parameter is available in version 3.3.0 or later of the module. If the feature supports user controls for opting out, make sure you set the *IsUserControlEnabled* parameter when you create the policy. Otherwise, user controls for the policy use the default state for the feature. + +The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: + +- $true: User control is enabled by the policy. Users can opt out of the feature. +- $false: User control isn't enabled by the policy. Users can't opt of the feature. + +Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information. + +If you don't want to update whether the user control is enabled by the policy, don't use this parameter. ```yaml Type: Boolean -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -336,23 +288,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsUserControlEnabled -**Note**: This parameter is available in version 3.3.0 or later of the module. If the feature supports user controls for opting out, make sure you set the *IsUserControlEnabled* parameter when you create the policy. Otherwise, user controls for the policy use the default state for the feature. +### -IsUserOptedInByDefault -The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: +> Applicable: Exchange Online -- $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. +This parameter is available in version 3.8.0-Preview2 or later of the module. -Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information. +The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are: -If you don't want to update whether the user control is enabled by the policy, don't use this parameter. +- $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: FeaturePolicy +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -362,6 +316,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the updated name for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). Valid characters are English letters, numbers, commas, periods, and spaces. @@ -372,7 +329,6 @@ If you don't want to update the name of the policy, don't use this parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -382,13 +338,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -398,6 +356,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Exchange Online + The UserIds parameter specifies the user principal names (UPNs) of users that the updated policy applies to. You can enter multiple values separated by commas. If you don't want to update who the policy applies to, don't use this parameter. @@ -412,7 +373,6 @@ To have the updated policy apply to all users in the organization, use the Every Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -422,13 +382,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + 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 diff --git a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/ExchangePowerShell/Update-eDiscoveryCaseAdmin.md similarity index 79% rename from exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md rename to exchange/exchange-ps/ExchangePowerShell/Update-eDiscoveryCaseAdmin.md index c72830007e..72ff44c8c3 100644 --- a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-eDiscoveryCaseAdmin.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-ediscoverycaseadmin applicable: Security & Compliance -title: Update-eDiscoveryCaseAdmin -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-ediscoverycaseadmin +schema: 2.0.0 +title: Update-eDiscoveryCaseAdmin --- # Update-eDiscoveryCaseAdmin @@ -28,7 +29,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. To make a user an eDiscovery Administrator, add the user to the eDiscovery Manager role group. For instructions, see [Add users or groups to a Microsoft Purview built-in role group](https://learn.microsoft.com/purview/purview-compliance-portal-permissions#add-users-or-groups-to-a-microsoft-purview-built-in-role-group). You can then use this cmdlet to manage the list of eDiscover Administrators. +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 ""`. + +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). @@ -44,7 +47,10 @@ This example replaces the existing eDiscovery Administrators with new users. ## PARAMETERS ### -Users -The Users parameter specifies the users that will replace the current eDiscovery Administrators. You can use any value that uniquely identifies the user. For example: + +> Applicable: Security & Compliance + +The Users parameter specifies the users that replaces the current eDiscovery Administrators. You can use any value that uniquely identifies the user. For example: - Name - Distinguished name (DN) @@ -57,7 +63,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -67,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + 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`. @@ -76,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +93,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + 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 diff --git a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Upgrade-DistributionGroup.md similarity index 81% rename from exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Upgrade-DistributionGroup.md index d0092da6bc..3a013933e6 100644 --- a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Upgrade-DistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/upgrade-distributiongroup applicable: Exchange Online, Exchange Online Protection -title: Upgrade-DistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/upgrade-distributiongroup +schema: 2.0.0 +title: Upgrade-DistributionGroup --- # Upgrade-DistributionGroup @@ -31,7 +32,7 @@ Upgrade-DistributionGroup [-DlIdentities] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,6 +46,9 @@ This example upgrades the specified distribution groups to Microsoft 365 Groups. ## PARAMETERS ### -DlIdentities + +> Applicable: Exchange Online + The DlIdentities parameter specifies the email address of the distribution group that you want to upgrade to a Microsoft 365 Group. You can specify multiple values separated by commas. @@ -53,7 +57,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -ActionType + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -ExecutingUser + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -95,13 +102,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Validate-OutboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Validate-OutboundConnector.md similarity index 85% rename from exchange/exchange-ps/exchange/Validate-OutboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Validate-OutboundConnector.md index e096f825c2..1a4f895aa1 100644 --- a/exchange/exchange-ps/exchange/Validate-OutboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Validate-OutboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/validate-outboundconnector applicable: Exchange Online, Exchange Online Protection -title: Validate-OutboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/validate-outboundconnector +schema: 2.0.0 +title: Validate-OutboundConnector --- # Validate-OutboundConnector @@ -35,7 +36,7 @@ The Validate-OutboundConnector cmdlet performs two tests on the specified connec - SMTP connectivity to each smart host that's defined on the connector. - Send test email messages to one or more recipients in the domain that's configured on the connector. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +50,9 @@ This example tests the Outbound connector named Contoso.com Outbound Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Outbound connector that you want to test. You can use any value that uniquely identifies the connector. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the Outbound connector that you want to test. Y Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Online, Exchange Online Protection + The Recipients parameter specifies one or more email addresses to send a test message to. The email addresses need to be in the domain that's configured on the connector. 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"`. @@ -77,7 +83,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + 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`. @@ -96,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md b/exchange/exchange-ps/ExchangePowerShell/Validate-RetentionRuleQuery.md similarity index 94% rename from exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md rename to exchange/exchange-ps/ExchangePowerShell/Validate-RetentionRuleQuery.md index c4a8ee7175..51538b1dbf 100644 --- a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md +++ b/exchange/exchange-ps/ExchangePowerShell/Validate-RetentionRuleQuery.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/validate-retentionrulequery applicable: Exchange Online, Security & Compliance -title: Validate-RetentionRuleQuery -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/validate-retentionrulequery +schema: 2.0.0 +title: Validate-RetentionRuleQuery --- # Validate-RetentionRuleQuery @@ -40,6 +41,9 @@ This example validates the specified KQL content search filter. ## PARAMETERS ### -KqlQueryString + +> Applicable: Exchange Online, Security & Compliance + The KqlQueryString parameter specifies the KQL text search string that you want to validate. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -48,7 +52,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Write-AdminAuditLog.md b/exchange/exchange-ps/ExchangePowerShell/Write-AdminAuditLog.md similarity index 76% rename from exchange/exchange-ps/exchange/Write-AdminAuditLog.md rename to exchange/exchange-ps/ExchangePowerShell/Write-AdminAuditLog.md index 3545297054..1d92073322 100644 --- a/exchange/exchange-ps/exchange/Write-AdminAuditLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Write-AdminAuditLog.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/write-adminauditlog -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Write-AdminAuditLog -schema: 2.0.0 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/write-adminauditlog +schema: 2.0.0 +title: Write-AdminAuditLog --- # Write-AdminAuditLog ## 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 in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Write-AdminAuditLog cmdlet to write a comment to the administrator audit log. @@ -33,7 +34,7 @@ When the Write-AdminAuditLog cmdlet runs, the value provided in the Comment para For the Write-AdminAuditLog cmdlet to write to the audit log, it must be included in the list of cmdlets being logged by administrator audit logging. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +48,9 @@ This example adds a comment to the administrator audit log. ## PARAMETERS ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + The Comment parameter specifies the comment to add to the administrator audit log. The maximum length is 500 characters. If the comment you specify contains spaces, enclose the comment in quotation marks ("). @@ -55,7 +59,6 @@ If the comment you specify contains spaces, enclose the comment in quotation mar Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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`. @@ -74,7 +80,6 @@ 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, Exchange Online Protection Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE + 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. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection + 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 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/Get-ActivityAlert.md b/exchange/exchange-ps/exchange/Get-ActivityAlert.md deleted file mode 100644 index 4d61e352ef..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/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 -```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-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-VivaFeatureCategory.md b/exchange/exchange-ps/exchange/Get-VivaFeatureCategory.md deleted file mode 100644 index b5f8a509e6..0000000000 --- a/exchange/exchange-ps/exchange/Get-VivaFeatureCategory.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivafeaturecategory -applicable: Exchange Online -title: Get-VivaFeatureCategory -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-VivaFeatureCategory - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module v3.5.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). - -**Note**: While we are adding support for category policies in the Exchange Online PowerShell module v3.5.0-Preview1 or later, we have not yet released any categories in Viva. We will update when there are categories available. - -Use the Get-VivaFeatureCategory cmdlet to view all categories in Viva that support feature access controls. This cmdlet provides details about the categories, including the category identifiers, descriptions, and Viva module features that belong to the category. A category contains a group of features in the same or different Viva module. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-VivaFeatureCategory - [-ResultSize ] - [] -``` - -## DESCRIPTION -Use the Get-VivaFeatureCategory cmdlet to view the categories in Viva that support feature access controls. - -You need to use the Connect-ExchangeOnline cmdlet to authenticate. - -This cmdlet requires the .NET Framework 4.7.2 or later. - -## EXAMPLES - -### Example 1 -```powershell -Get-VivaFeatureCategory -``` - -This example returns all categories in Viva that support feature access controls. - -## PARAMETERS - -### -ResultSize -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Unlimited -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS -[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) - -[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) - -[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/New-ActivityAlert.md b/exchange/exchange-ps/exchange/New-ActivityAlert.md deleted file mode 100644 index 5d49c0e66c..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/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 -```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-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-HybridConfiguration.md b/exchange/exchange-ps/exchange/New-HybridConfiguration.md deleted file mode 100644 index 7d9e42ecac..0000000000 --- a/exchange/exchange-ps/exchange/New-HybridConfiguration.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-hybridconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-HybridConfiguration -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# New-HybridConfiguration - -## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the New-HybridConfiguration cmdlet to create the HybridConfiguration object and set up a hybrid deployment between your on-premises Exchange organization and a Microsoft 365 for enterprises organization. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -New-HybridConfiguration - [-ClientAccessServers ] - [-Confirm] - [-DomainController ] - [-Domains ] - [-EdgeTransportServers ] - [-ExternalIPAddresses ] - [-Features ] - [-OnPremisesSmartHost ] - [-ReceivingTransportServers ] - [-SecureMailCertificateThumbprint ] - [-SendingTransportServers ] - [-ServiceInstance ] - [-TlsCertificateName ] - [-TransportServers ] - [-WhatIf] - [] -``` - -## DESCRIPTION -A hybrid deployment offers organizations the ability to extend the feature-rich experience and administrative control they have with their existing on-premises Microsoft Exchange organization to the cloud. The New-HybridConfiguration cmdlet is used with the Hybrid Configuration wizard and is typically configured when the hybrid deployment is initially created by the wizard. We strongly recommend that you use the Hybrid Configuration wizard to create the HybridConfiguration object and configure your hybrid deployment with the Exchange Online organization. - -For more information, see [Exchange Server hybrid deployments](https://learn.microsoft.com/exchange/exchange-hybrid). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -New-HybridConfiguration -``` - -This example creates the hybrid configuration named Hybrid Configuration with the default hybrid configuration settings. - -## PARAMETERS - -### -ClientAccessServers -This parameter is available only in Exchange Server 2010. - -The ClientAccessServers parameter specifies the Exchange Server 2010 SP2 servers with the Client Access server role installed that will be configured to support the hybrid deployment features. At least one Client Access server must be defined and be externally accessible from the Internet on ports 80 and 443. The servers will be configured to enable the following: - -- Mailbox Replication Service (MRS) Proxy The MRS Proxy service configuration on the Client Access servers will be enabled. -- Virtual Directories The Client Access servers will host the default Web sites for the Exchange Web Services (EWS), offline address books, and ActiveSync services. -- Outlook Anywhere The Client Access servers will have Outlook Anywhere enabled. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 - -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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domains -The Domains parameter specifies the domain namespaces that are used in the hybrid deployment. These domains must be configured as accepted domains in either the on-premises Exchange organization or the Exchange Online service. The domains are used in configuring the organization relationships and Send and Receive connectors used by the hybrid configuration. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EdgeTransportServers -The EdgeTransportServers parameter specifies the Edge Transport servers that are configured to support the hybrid deployment features. The Edge Transport server must be externally accessible from the Internet on port 25. The accepted values for the EdgeTransportServers parameter are either the full or short computer name of an Edge Transport server, for example, either edge.corp.contoso.com or EDGE. Separate server names with a comma if defining more than one Edge Transport server. - -When configuring the EdgeTransportServers parameter, you must configure the ReceivingTransportServers and SendingTransportServers parameter values to $null. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ExternalIPAddresses -The ExternalIPAddresses parameter is a legacy parameter that specifies the publicly accessible inbound IP address of Microsoft Exchange Server 2010 Hub Transport servers. The only configuration change that should be made with this parameter is to change or clear the legacy Exchange 2010 Hub Transport server IP address value. The IP address must be Internet Protocol version 4 (IPv4) based only. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Features -The Features parameter specifies the features that are enabled for the hybrid configuration. One or more of the following values separated by commas can be entered. When using the Hybrid Configuration wizard, all features are enabled by default. - -- OnlineArchive: Enables the Exchange Online archive for on-premises Exchange and Exchange Online organization users. -- FreeBusy: Enables free/busy calendar information to be shared between on-premises Exchange and Exchange Online organization users. -- MailTips: Enables MailTips information to be shared between on-premises Exchange and Exchange Online organization users. -- MessageTracking: Enables message tracking information to be shared between on-premises Exchange and Exchange Online organization users. -- OWARedirection: Enables automatic Microsoft Outlook on the web redirection to either the on-premises Exchange or Exchange Online organizations depending on where the user mailbox is located. -- SecureMail: Enables secure message transport via Transport Layer Security (TLS) between the on-premises Exchange and Exchange Online organizations. -- Centralized: Enables the on-premises servers to handle all message transport between the on-premises Exchange and Exchange Online organizations, including message delivering to the Internet for both organizations. If this value is $false, the on-premises server and Exchange Online organization are each responsible for their own Internet message delivery. -- Photos: Enables the sharing of user photo data between the on-premises Exchange and Exchange Online organizations. This feature works in tandem with the PhotosEnabled parameter in the OrganizationRelationship cmdlets in a hybrid deployment. If the Photos parameter is $true, the PhotosEnabled parameter is automatically set to $true. If the Photos parameter is $false, the PhotosEnabled parameter is automatically set to $false. When running the Hybrid Configuration wizard for the first time, the default value is $true. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -OnPremisesSmartHost -The OnPremisesSmartHost parameter specifies the FQDN of the on-premises Mailbox server used for secure mail transport for messages sent between the on-premises Exchange and Exchange Online organizations. - -```yaml -Type: SmtpDomain -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ReceivingTransportServers -The ReceivingTransportServers parameter specifies the Mailbox servers that are defined in the outbound connector configuration of the Microsoft Exchange Online Protection (EOP) service included as part of the Microsoft 365 organization. The servers defined in the ReceivingTransportServers parameter are designated as the receiving servers for secure mail messages sent from the Exchange Online organization to the on-premises Exchange organization in a hybrid deployment. At least one Mailbox server must be defined and be externally accessible from the Internet for secure mail to be enabled between the on-premises Exchange and Exchange Online organizations. The accepted values for the ReceivingTransportServers parameter are either the full or short computer name of a Mailbox server, for example, either mbx.corp.contoso.com or MBX. Separate server names with a comma if defining more than one Mailbox server. - -If configuring the EdgeTransportServers parameter in the hybrid deployment, the ReceivingTransportServers parameter value must be $null. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SecureMailCertificateThumbprint -This parameter is available only in Exchange Server 2010. - -The SecureMailCertificateThumbprint parameter specifies the thumbprint of the X.509 certificate to be used as the certificate for hybrid deployment secure message transport. This certificate cannot be self-signed, must be obtained from a trusted certificate authority (CA) and must be installed on all Hub Transport servers defined in the TransportServers parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SendingTransportServers -The SendingTransportServers parameter specifies the Exchange Mailbox servers that are defined in the inbound connector configuration of the EOP service included as part of the Microsoft 365 organization. The servers defined in the SendingTransportServers parameter are designated as the receiving servers for secure mail messages sent from the on-premises Exchange organization to the Exchange Online organization in a hybrid deployment. At least one Mailbox server must be defined and be externally accessible from the Internet for secure mail to be enabled between the on-premises Exchange and Exchange Online organizations. The accepted values for the SendingTransportServers parameter are either the full or short computer name of a Mailbox server, for example, either mbx.corp.contoso.com or MBX. Separate server names with a comma if defining more than one Mailbox server. - -If configuring the EdgeTransportServers parameter in the hybrid deployment, the SendingTransportServers parameter value must be $null. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ServiceInstance -The ServiceInstance parameter should only be used by organizations manually configuring hybrid deployments with Office 365 operated by 21Vianet in China. All other organizations should use the Hybrid Configuration wizard to configure a hybrid deployment with Microsoft 365. The valid values for this parameter are 0 (null) or 1. The default value is 0 (null).For organizations connecting with Office 365 operated by 21Vianet in China, set this value to 1 when manually configuring your hybrid deployment. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TlsCertificateName -The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. - -```yaml -Type: SmtpX509Identifier -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -TransportServers -This parameter is available only in Exchange Server 2010. - -The TransportServers parameter specifies the Exchange Server 2010 SP2 servers with the Hub Transport server role installed that are configured to support the hybrid deployment features. At least one Hub Transport server must be defined and be externally accessible from the Internet for secure mail to be enabled between the on-premises and cloud-based organizations. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 - -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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS 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-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/Set-ActivityAlert.md b/exchange/exchange-ps/exchange/Set-ActivityAlert.md deleted file mode 100644 index 899cf0f8be..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/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 -```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-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/Set-AuditConfigurationRule.md deleted file mode 100644 index a265423f12..0000000000 --- a/exchange/exchange-ps/exchange/Set-AuditConfigurationRule.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -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 -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-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 Set-AuditConfigurationRule cmdlet to modify 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 - -``` -Set-AuditConfigurationRule [-Identity] -AuditOperation - [-Confirm] - [-DomainController ] - [-WhatIf] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-AuditConfigurationRule 989a3a6c-dc40-4fa4-8307-beb3ece992e9 -AuditOperation @{Add="CheckOut"} -``` - -This example modifies an existing SharePoint auditing rule. The check-out operation is added to the rule without affecting the existing operations that are already being audited. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the audit configuration rule that you want to modify. The name of the rule is a GUID value. For example, 989a3a6c-dc40-4fa4-8307-beb3ece992e9. You can find the name value by running the following command: Get-AuditConfigurationRule | Format-List Name,Workload,AuditOperation,Policy. - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AuditOperation -The AuditOperation parameter specifies the operations that are audited by the rule. Valid values are: - -- Administrate -- CheckIn -- CheckOut -- Count -- CreateUpdate -- Delete -- Forward -- MoveCopy -- PermissionChange -- ProfileChange -- SchemaChange -- Search -- SendAsOthers -- View -- Workflow - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index ab94e97812..663de1cf39 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -798,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", @@ -812,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", @@ -828,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", @@ -841,6 +847,7 @@ "Test-ServicePrincipalAuthorization": "organization", "Test-SystemHealth": "organization", "Update-ExchangeHelp": "organization", + "Check-PurviewConfig": "policy-and-compliance", "Disable-JournalArchiving": "policy-and-compliance", "Disable-JournalRule": "policy-and-compliance", "Disable-OutlookProtectionRule": "policy-and-compliance", @@ -851,7 +858,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", @@ -879,7 +885,6 @@ "Import-TransportRuleCollection": "policy-and-compliance", "Install-UnifiedCompliancePrerequisite": "policy-and-compliance", "Invoke-ComplianceSecurityFilterAction": "policy-and-compliance", - "New-ActivityAlert": "policy-and-compliance", "New-AutoSensitivityLabelPolicy": "policy-and-compliance", "New-AutoSensitivityLabelRule": "policy-and-compliance", "New-InformationBarrierPolicy": "policy-and-compliance", @@ -893,7 +898,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", @@ -904,10 +908,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", @@ -926,25 +928,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", 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/officewebapps/docs-conceptual/intro.md b/officewebapps/docs-conceptual/intro.md index 8ac54086df..14a2034181 100644 --- a/officewebapps/docs-conceptual/intro.md +++ b/officewebapps/docs-conceptual/intro.md @@ -1,4 +1,5 @@ --- +description: The Office Online Server cmdlets provide the command line interface for administration and management. title: Office Online Server cmdlet reference --- diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md index 5f8470dadc..e03059b3f9 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md @@ -12,7 +12,9 @@ ms.reviewer: # Get-OfficeWebAppsExcelBIServer ## SYNOPSIS -Returns the server ID of the instance of Analysis Services that has been configured as a data model server in Office Online Server. + +Returns the server ID of the instance of Analysis Services that has been configured as a data model +server in Office Online Server. ## SYNTAX @@ -21,12 +23,15 @@ Get-OfficeWebAppsExcelBIServer ``` ## DESCRIPTION -Returns the server ID of the instance of Analysis Services that has been configured as a data model server in Office Online Server. + +Returns the server ID of the instance of Analysis Services that has been configured as a data model +server in Office Online Server. ## EXAMPLES ### Example 1 -``` + +```powershell Get-OfficeWebAppsExcelBIServer ``` diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md index 1af1fd7bb1..dee6470e64 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Returns a list of currently configured UDF definitions. ## SYNTAX @@ -21,24 +22,27 @@ Get-OfficeWebAppsExcelUserDefinedFunction [[-Identity] ] ``` ## DESCRIPTION + Returns a list of currently configured UDF definitions. ## EXAMPLES ### This example returns a list of currently configured UDF definitions from c:\myudf.dll. -``` + +```powershell Get-OfficeWebAppsExcelUserDefinedFunction -Identity c:\myudf.dll ``` ## PARAMETERS ### -Identity + The path and filename of the UDF. ```yaml Type: UserDefinedFunction Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md index 6aceca683e..168bf69836 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsFarm ## SYNOPSIS + Returns details about the OfficeWebAppsFarm object that the current server is a member of. ## SYNTAX @@ -21,21 +22,25 @@ Get-OfficeWebAppsFarm ``` ## DESCRIPTION -The Get-OfficeWebAppsFarm cmdlet returns details about the OfficeWebAppsFarm object that the current server is a member of. -This object represents a group of servers that work as a unit to provide web-based editing and viewing of Office documents. -No parameters are used with the Get-OfficeWebAppsFarm cmdlet. + +The `Get-OfficeWebAppsFarm` cmdlet returns details about the OfficeWebAppsFarm object that the +current server is a member of. This object represents a group of servers that work as a unit to +provide web-based editing and viewing of Office documents. No parameters are used with the +`Get-OfficeWebAppsFarm` cmdlet. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell Get-OfficeWebAppsFarm ``` This example returns details about the OfficeWebAppsFarm object. -### ------------------EXAMPLE 2--------------------- -``` +### EXAMPLE 2 + +```powershell (Get-OfficeWebAppsFarm).Machines ``` diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md index 453f1006dc..d034e6df00 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsHost ## SYNOPSIS + Returns the list of host domains that are on the Allow List for an Office Online Server farm. ## SYNTAX @@ -21,34 +22,41 @@ Get-OfficeWebAppsHost ``` ## DESCRIPTION -The Get-OfficeWebAppsHost cmdlet returns 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 an Office Online Server farm and using it for file operations without your knowledge. -The wildcard * is assumed for any domain that appears on the Allow List so that requests to all subdomains are also allowed. -For example, if the domain contoso.com is on the Allow List, then Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. +The Get-OfficeWebAppsHost cmdlet returns 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 +an Office Online Server farm and using it for file operations without your knowledge. + +The wildcard * is assumed for any domain that appears on the Allow List so that requests to all +subdomains are also allowed. For example, if the domain contoso.com is on the Allow List, then +Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. Requests to other domains (such as fabrikam.com) are not allowed. -If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any domain. -Do not leave this list blank if your Office Online Server farm is accessible from the Internet. -Otherwise anyone can use your Office Online Server farm to view and edit content. +If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any +domain. Do not leave this list blank if your Office Online Server farm is accessible from the +Internet. Otherwise anyone can use your Office Online Server farm to view and edit content. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell Get-OfficeWebAppsHost ``` This example returns the host domains that are on the Allow List. -### ------------------EXAMPLE 2--------------------- +### EXAMPLE 2 + If there are multiple domains in the Allow List, please run the following: -``` +```powershell Get-OfficeWebAppsHost | Select allowList -ExpandProperty allowList ``` -This example returns the host domains that are on the Allow List without ellipsis truncation in the case of multiple domains. +This example returns the host domains that are on the Allow List without ellipsis truncation in the +case of multiple domains. ## PARAMETERS diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md index 45ec6f32f5..f0588a4a6f 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsMachine ## SYNOPSIS + Returns details about the current server that is in an Office Online Server farm. ## SYNTAX @@ -21,20 +22,24 @@ Get-OfficeWebAppsMachine ``` ## DESCRIPTION -The Get-OfficeWebAppsMachine cmdlet returns details about the current server that is in an Office Online Server farm. -These details include the roles and health status of the current server and the name of the master server for the farm. + +The Get-OfficeWebAppsMachine cmdlet returns details about the current server that is in an Office +Online Server farm. These details include the roles and health status of the current server and the +name of the master server for the farm. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell Get-OfficeWebAppsMachine ``` This example returns details about the current server that is in an Office Online Server farm. -### ------------------EXAMPLE 2--------------------- -``` +### EXAMPLE 2 + +```powershell (Get-OfficeWebAppsFarm).Machines ``` diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md index 0640085f2b..ff4020acb3 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsExcelBIServer ## SYNOPSIS + Configures Analysis Services servers to work with Excel Online. ## SYNTAX @@ -21,24 +22,29 @@ New-OfficeWebAppsExcelBIServer -ServerId ``` ## DESCRIPTION + Configures Analysis Services servers to work with Excel Online. ## EXAMPLES -### This example configures the Analysis Services server named SSAS01 to work with Excel Online. -``` +### Example 1 + +This example configures the Analysis Services server named SSAS01 to work with Excel Online. + +```powershell New-OfficeWebAppsExcelBIServer -ServerID "SSAS01" ``` ## PARAMETERS ### -ServerId + The name of the Analysis Services server. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md index c631ff437e..74ec676b53 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Creates a definition for a UDF binary. ## SYNTAX @@ -22,29 +23,39 @@ New-OfficeWebAppsExcelUserDefinedFunction -Assembly [-AssemblyLocation ``` ## DESCRIPTION + Creates a definition for a UDF binary. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell New-OfficeWebAppsExcelUserDefinedFunction -Assembly c:\myudf.dll -AssemblyLocation LocalFile -Enable:$true -Description "My Server UDFs" ``` -### ------------------EXAMPLE 2--------------------- -``` -New-OfficeWebAppsExcelUserDefinedFunction -Assembly "CompanyName.Hierarchical.MyUdfNamespace.MyUdfClassName.dll, Version=1.1.0.0, Culture=en, PublicKeyToken=e8123117d7ba9ae38" -AssemblyLocation GAC -Enable:$true -Description "My GAC Server UDFs" +### EXAMPLE 2 + +```powershell +$newOfficeWebAppsExcelUserDefinedFunctionSplat = @{ + Assembly = 'CompanyName.Hierarchical.MyUdfNamespace.MyUdfClassName.dll, Version=1.1.0.0, Culture=en, PublicKeyToken=e8123117d7ba9ae38' + AssemblyLocation = 'GAC' + Enable = $true + Description = "My GAC Server UDFs" +} +New-OfficeWebAppsExcelUserDefinedFunction @newOfficeWebAppsExcelUserDefinedFunctionSplat ``` ## PARAMETERS ### -Assembly + The name of the assembly. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -54,13 +65,18 @@ Accept wildcard characters: False ``` ### -AssemblyLocation + The location of the assembly. -Values: LocalFile - a local directory; GAC - the Global Assembly Cache. + +Values: + +- LocalFile - a local directory +- GAC - the Global Assembly Cache ```yaml Type: AssemblyLocation Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -70,8 +86,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -86,12 +102,13 @@ Accept wildcard characters: False ``` ### -Description + Description of the UDF. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -101,12 +118,13 @@ Accept wildcard characters: False ``` ### -Enable + Enables the UDF. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -116,8 +134,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md index d2afbe0bcb..df9e2f8c8d 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md @@ -12,52 +12,63 @@ ms.reviewer: # New-OfficeWebAppsFarm ## SYNOPSIS + Creates a new Office Online Server farm on the local computer. ## SYNTAX ``` -New-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] [-AllowHttp] - [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] [-S2SCertificateName ] - [-EditingEnabled] [-Proxy ] [-LogLocation ] [-LogRetentionInDays ] - [-LogVerbosity ] [-CacheLocation ] [-MaxMemoryCacheSizeInMB ] - [-DocumentInfoCacheSize ] [-CacheSizeInGB ] [-ClipartEnabled] [-TranslationEnabled] - [-MaxTranslationCharacterCount ] [-TranslationServiceAppId ] - [-TranslationServiceAddress ] [-RenderingLocalCacheLocation ] - [-RecycleActiveProcessCount ] [-AllowCEIP] [-ExcelRequestDurationMax ] - [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] [-ExcelPrivateBytesMax ] - [-ExcelConnectionLifetime ] [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] - [-ExcelUseEffectiveUserName] [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] - [-ExcelMemoryCacheThreshold ] [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] - [-ExcelAbortOnRefreshOnOpenFail] [-ExcelAutomaticVolatileFunctionCacheLifeTime ] - [-ExcelConcurrentDataRequestsPerSessionMax ] [-ExcelDefaultWorkbookCalcMode ] - [-ExcelRestExternalDataEnabled] [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] - [-OpenFromUncEnabled] [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] - [-RemovePersonalInformationFromLogs] [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] +New-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] + [-AllowHttp] [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] + [-S2SCertificateName ] [-EditingEnabled] [-Proxy ] [-LogLocation ] + [-LogRetentionInDays ] [-LogVerbosity ] [-CacheLocation ] + [-MaxMemoryCacheSizeInMB ] [-DocumentInfoCacheSize ] [-CacheSizeInGB ] + [-ClipartEnabled] [-TranslationEnabled] [-MaxTranslationCharacterCount ] + [-TranslationServiceAppId ] [-TranslationServiceAddress ] + [-RenderingLocalCacheLocation ] [-RecycleActiveProcessCount ] [-AllowCEIP] + [-ExcelRequestDurationMax ] [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] + [-ExcelPrivateBytesMax ] [-ExcelConnectionLifetime ] + [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] [-ExcelUseEffectiveUserName] + [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] [-ExcelMemoryCacheThreshold ] + [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] [-ExcelAbortOnRefreshOnOpenFail] + [-ExcelAutomaticVolatileFunctionCacheLifeTime ] + [-ExcelConcurrentDataRequestsPerSessionMax ] + [-ExcelDefaultWorkbookCalcMode ] [-ExcelRestExternalDataEnabled] + [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] [-OpenFromUncEnabled] + [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] [-RemovePersonalInformationFromLogs] + [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The New-OfficeWebAppsFarm cmdlet creates a new Office Online Server farm on the local computer. -You run this cmdlet on the first server in the Office Online Server farm and then add more servers to the farm by using the New-OfficeWebAppsMachine cmdlet. + +The New-OfficeWebAppsFarm cmdlet creates a new Office Online Server farm on the local computer. You +run this cmdlet on the first server in the Office Online Server farm and then add more servers to +the farm by using the New-OfficeWebAppsMachine cmdlet. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- +### EXAMPLE 1 + ``` New-OfficeWebAppsFarm -ExternalUrl "https://office.contoso.com" -CertificateName "Office Server Cert" -EditingEnabled:$true ``` -This example creates an Office Online Server farm on the local server that has editing enabled for Office in a browser. With this example, only a single URL is used for both internal and external users. The Certificate Name value is the Friendly Name of the certificate as it appears in the Computer's certificate store. +This example creates an Office Online Server farm on the local server that has editing enabled for +Office in a browser. With this example, only a single URL is used for both internal and external +users. The Certificate Name value is the Friendly Name of the certificate as it appears in the +Computer's certificate store. ## PARAMETERS ### -AllowCEIP -Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online Server farm. + +Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online +Server farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -67,15 +78,17 @@ Accept wildcard characters: False ``` ### -AllowHttp -Indicates that IIS sites should be provisioned on port 80 for HTTP access. -Use AllowHTTP only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. + +Indicates that IIS sites should be provisioned on port 80 for HTTP access. Use AllowHTTP only in +environments where all computers require IPSEC (full encryption) or in test environments that do not +contain sensitive files. Enabled automatically when you enable SSLOffloaded. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -85,15 +98,17 @@ Accept wildcard characters: False ``` ### -AllowHttpSecureStoreConnections + Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). The default is False. -Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. +Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full +encryption) or in test environments that do not contain sensitive files. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -103,12 +118,13 @@ Accept wildcard characters: False ``` ### -AllowOutboundHttp + Allows outbound HTTP connections from Office Online Server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -118,13 +134,14 @@ Accept wildcard characters: False ``` ### -CacheLocation -Specifies the location of the global disk cache that is used to store rendered image files. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\d\. + +Specifies the location of the global disk cache that is used to store rendered image files. The +default location is `%programdata%\Microsoft\OfficeWebApps\Working\d\`. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -134,15 +151,16 @@ Accept wildcard characters: False ``` ### -CacheSizeInGB + Specifies the maximum size of the global disk cache in gigabytes. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 15 GB. +The type must be an integer value in the range of 0 to any positive integer. The default size is 15 +GB. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -152,19 +170,23 @@ Accept wildcard characters: False ``` ### -CertificateName -Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS bindings. -If the specified certificate is not found or has expired, or if the specified value is associated with more than one certificate, an error is logged and the farm is not created. +Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS +bindings. -This value is used on every server that joins the Office Online Server farm. -Therefore, every server in the farm must have a certificate that has this friendly name. +If the specified certificate is not found or has expired, or if the specified value is associated +with more than one certificate, an error is logged and the farm is not created. -You don't have to specify the CertificateName parameter if you are using either the AllowHttp or SSLOffloaded parameter. +This value is used on every server that joins the Office Online Server farm. Therefore, every server +in the farm must have a certificate that has this friendly name. + +You don't have to specify the CertificateName parameter if you are using either the AllowHttp or +SSLOffloaded parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -174,16 +196,17 @@ Accept wildcard characters: False ``` ### -ClipartEnabled -Enables support for inserting Bing images into Office documents. -This feature requires server-to-web communication, configured either directly or by using a proxy that you specify by using the Proxy parameter. -The OpenFromUrlEnabled parameter must be set to True for Bing Images to work.. -The default is False. +Enables support for inserting Bing images into Office documents. This feature requires server-to-web +communication, configured either directly or by using a proxy that you specify by using the Proxy +parameter. + +The OpenFromUrlEnabled parameter must be set to True for Bing Images to work.. The default is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -193,8 +216,9 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters + +Prompts you for confirmation before executing the command. For more information, type the following +command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -209,6 +233,7 @@ Accept wildcard characters: False ``` ### -DocumentInfoCacheSize + Specifies the maximum number of document conversion records that are stored in a memory cache. The default value is 5000 records. @@ -216,7 +241,7 @@ The default value is 5000 records. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -226,14 +251,14 @@ Accept wildcard characters: False ``` ### -EditingEnabled -Enables support for editing in the browser. -The default is False. -Only set to True if you have the appropriate licensing to use the editing functionality. + +Enables support for editing in the browser. The default is False. Only set to True if you have the +appropriate licensing to use the editing functionality. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -243,13 +268,14 @@ Accept wildcard characters: False ``` ### -ExcelAbortOnRefreshOnOpenFail -Prevents a workbook from loading if data refresh fails. -This helps prevent users from seeing out-of-date information or possibly information that they should not have access to. + +Prevents a workbook from loading if data refresh fails. This helps prevent users from seeing +out-of-date information or possibly information that they should not have access to. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -259,13 +285,14 @@ Accept wildcard characters: False ``` ### -ExcelAllowExternalData -Enables the refresh of supported external data in Excel workbooks in a browser where workbooks contain connections to external data. -The default is True. + +Enables the refresh of supported external data in Excel workbooks in a browser where workbooks +contain connections to external data. The default is True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -275,15 +302,18 @@ Accept wildcard characters: False ``` ### -ExcelAutomaticVolatileFunctionCacheLifeTime -Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. --1: Calculates once when the workbook loads. -0: Always calculates. -1 to 2073600: Caches 1 second to 24 days. + +Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for +automatic recalculations. + +- -1: Calculates once when the workbook loads. +- 0: Always calculates. +- 1 to 2073600: Caches 1 second to 24 days. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -293,12 +323,13 @@ Accept wildcard characters: False ``` ### -ExcelCachingUnusedFiles + Enable caching of files that are no longer in use by Web Excel sessions. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -308,13 +339,14 @@ Accept wildcard characters: False ``` ### -ExcelChartAndImageSizeMax -Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a browser. -The value must be an integer greater than 0. + +Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a +browser. The value must be an integer greater than 0. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -324,13 +356,14 @@ Accept wildcard characters: False ``` ### -ExcelConcurrentDataRequestsPerSessionMax -Specifies the maximum number of concurrent external data requests allowed in each session. -If a session must issue more than this number of requests, additional requests are queued. + +Specifies the maximum number of concurrent external data requests allowed in each session. If a +session must issue more than this number of requests, additional requests are queued. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -340,13 +373,14 @@ Accept wildcard characters: False ``` ### -ExcelConnectionLifetime -Specifies the duration, in seconds, of external data connections for Excel in a browser. -The default is 1800 seconds. + +Specifies the duration, in seconds, of external data connections for Excel in a browser. The default +is 1800 seconds. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -356,12 +390,13 @@ Accept wildcard characters: False ``` ### -ExcelDefaultWorkbookCalcMode + PARAMVALUE: File | Manual | Auto | AutoDataTables ```yaml Type: DefaultWorkbookCalcMode Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -371,13 +406,14 @@ Accept wildcard characters: False ``` ### -ExcelExternalDataCacheLifetime -Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. -The default is 300 seconds. + +Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. The +default is 300 seconds. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -387,14 +423,15 @@ Accept wildcard characters: False ``` ### -ExcelMemoryCacheThreshold -The percentage of the Maximum Private Bytes that can be allocated to inactive objects. -When the memory cache threshold is exceeded, cached objects that are not currently in use are released. -Valid values: 0 (disables caching of inactive objects); from 1 through 95. + +The percentage of the Maximum Private Bytes that can be allocated to inactive objects. When the +memory cache threshold is exceeded, cached objects that are not currently in use are released. Valid +values: 0 (disables caching of inactive objects); from 1 through 95. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -404,16 +441,16 @@ Accept wildcard characters: False ``` ### -ExcelPrivateBytesMax -Specifies the maximum private bytes, in megabytes, used by Excel in a browser. -When set to -1, the maximum private bytes use 50 percent of physical memory on the computer. -The type must be -1 or any positive integer. -The default value is -1. +Specifies the maximum private bytes, in megabytes, used by Excel in a browser. When set to -1, the +maximum private bytes use 50 percent of physical memory on the computer. + +The type must be -1 or any positive integer. The default value is -1. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -423,16 +460,16 @@ Accept wildcard characters: False ``` ### -ExcelRequestDurationMax -Specifies the maximum duration, in seconds, for a single request in a session. -After this time elapses, the request times out. -The type must be -1 (no limit) or an integer in the range of 1 to 2073600. -The default value is 300. +Specifies the maximum duration, in seconds, for a single request in a session. After this time +elapses, the request times out. + +The type must be -1 (no limit) or an integer in the range of 1 to 2073600. The default value is 300. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -442,15 +479,14 @@ Accept wildcard characters: False ``` ### -ExcelRestExternalDataEnabled -Allow requests from the REST API to refresh external data connections. -This setting has no effect if Allow External Data is set to None. -Check box Bool. -Default is False. + +Allow requests from the REST API to refresh external data connections. This setting has no effect if +Allow External Data is set to None. Check box Bool. Default is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -460,20 +496,20 @@ Accept wildcard characters: False ``` ### -ExcelSessionTimeout -Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no user activity. -Valid values include the following: --1 Session never expires. +Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no +user activity. Valid values include the following: -0 Session expires at the end of a single request. +- -1 Session never expires. +- 0 Session expires at the end of a single request. +- 1 to 2073600Session remains active for 1 second to 24 days. -1 to 2073600Session remains active for 1 second to 24 days. The default value is 450. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -483,13 +519,13 @@ Accept wildcard characters: False ``` ### -ExcelUdfsAllowed -Enables User Defined Functions for Excel in a browser. -The default is False. + +Enables User Defined Functions for Excel in a browser. The default is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -499,15 +535,21 @@ Accept wildcard characters: False ``` ### -ExcelUnusedObjectAgeMax -The maximum time (in minutes) that inactive objects remain in the memory cache. -Inactive objects are objects that are not used in a session. -Valid values: -1 (no maximum); from 1 through 34560 (24 days). + +The maximum time (in minutes) that inactive objects remain in the memory cache. Inactive objects are +objects that are not used in a session. + +Valid values: + +- -1 (no maximum) +- 1 through 34560 (24 days). + Default is -1. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -517,13 +559,14 @@ Accept wildcard characters: False ``` ### -ExcelUseEffectiveUserName -Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. -The default is False. + +Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. The +default is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -533,12 +576,13 @@ Accept wildcard characters: False ``` ### -ExcelWarnOnDataRefresh + Turns off or on the warning dialog displayed when data refreshes in Excel in a browser. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -548,15 +592,15 @@ Accept wildcard characters: False ``` ### -ExcelWorkbookSizeMax + Specifies the maximum size, in megabytes, of a workbook that can be loaded. -The type must be an integer value in the range of 1 to 2000. -The default value is 10. +The type must be an integer value in the range of 1 to 2000. The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -566,8 +610,10 @@ Accept wildcard characters: False ``` ### -ExternalURL + Specifies the URL root that clients use to access the Office Online Server farm from the Internet. -In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to the IP address of the external-facing load balancer. +In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to +the IP address of the external-facing load balancer. An Office Online Server farm requires at least one URL, set using either ExternalURL or InternalURL. You can also set both internal and external URLs. @@ -575,7 +621,7 @@ You can also set both internal and external URLs. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -585,13 +631,15 @@ Accept wildcard characters: False ``` ### -FarmOU -Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of to join the Office Online Server farm. -Use this parameter to prevent unauthorized servers (that is, servers that are not in the OU) from joining an Office Online Server farm. + +Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of +to join the Office Online Server farm. Use this parameter to prevent unauthorized servers (that is, +servers that are not in the OU) from joining an Office Online Server farm. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -601,12 +649,13 @@ Accept wildcard characters: False ``` ### -Force + Suppresses any user prompts by answering Yes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -616,6 +665,7 @@ Accept wildcard characters: False ``` ### -InternalURL + Specifies the URL root that clients use to access the Office Online Server farm from the intranet. An Office Online Server farm requires at least one URL, set using either ExternalURL or InternalURL. @@ -624,7 +674,7 @@ You can also set both internal and external URLs. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -634,17 +684,18 @@ Accept wildcard characters: False ``` ### -LogLocation + Specifies the location on the local computer where activity logs are stored. The location applies for every server in the farm and cannot be customized on a per-server basis. -The default location is %programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\`. Be sure to allow sufficient disk space on the drive on which logs are stored. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -654,16 +705,15 @@ Accept wildcard characters: False ``` ### -LogRetentionInDays -Specifies the number of days that log entries are stored. -Log entries older than the configured date are trimmed. -The type must be an integer value in the range of 0 to 365. -The default value is 7 days. +Specifies the number of days that log entries are stored. Log entries older than the configured date +are trimmed. The type must be an integer value in the range of 0 to 365. The default value is 7 +days. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -673,30 +723,27 @@ Accept wildcard characters: False ``` ### -LogVerbosity -Specifies how much information is stored in the trace log files. -The values are as follows: - -VerboseEX writes low-level detail to the trace log file. -Useful for traces that are likely to be high volume. - -Verbose writes low-level detail to the trace log file. - -Medium writes medium-level detail to the trace log file. - -High writes high-level detail to the trace log file. -Monitorable writes traces that represent an unusual code path and actions that should be monitored. +Specifies how much information is stored in the trace log files. The values are as follows: -Unexpected writes traces that represent an unexpected code path and actions that should be monitored. +- VerboseEX writes low-level detail to the trace log file. Useful for traces that are likely to be + high volume. +- Verbose writes low-level detail to the trace log file. +- Medium writes medium-level detail to the trace log file. +- High writes high-level detail to the trace log file. +- Monitorable writes traces that represent an unusual code path and actions that should be + monitored. +- Unexpected writes traces that represent an unexpected code path and actions that should be + monitored. +- None writes no trace information to the trace log file. -None writes no trace information to the trace log file. - -Leaving the LogVerbosity at a low level for an extended period of time will negatively impact performance. +Leaving the LogVerbosity at a low level for an extended period of time will negatively impact +performance. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -706,15 +753,14 @@ Accept wildcard characters: False ``` ### -MaxMemoryCacheSizeInMB -Specifies, in megabytes, the maximum amount of memory that the rendering cache can use. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 75 MB. +Specifies, in megabytes, the maximum amount of memory that the rendering cache can use. The type +must be an integer value in the range of 0 to any positive integer. The default size is 75 MB. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -724,16 +770,15 @@ Accept wildcard characters: False ``` ### -MaxTranslationCharacterCount -Specifies the maximum amount of characters a document can have in order to be translated. -The type must be an integer value. -The value can be set to 0 to indicate no limit or a value from 2000 to 2,000,000. -The default value is 125,000. +Specifies the maximum amount of characters a document can have in order to be translated. The type +must be an integer value. The value can be set to 0 to indicate no limit or a value from 2000 to +2,000,000. The default value is 125,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -743,14 +788,14 @@ Accept wildcard characters: False ``` ### -OpenFromUncEnabled -Turns on or off the ability to use Online Viewers to view Office files from a UNC path. -You must first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths. +Turns on or off the ability to use Online Viewers to view Office files from a UNC path. You must +first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -760,15 +805,14 @@ Accept wildcard characters: False ``` ### -OpenFromUrlEnabled -Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path. -The default is False. -You must set this parameter to True when you use ClipartEnabled. +Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path. The +default is False. You must set this parameter to True when you use ClipartEnabled. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -778,13 +822,15 @@ Accept wildcard characters: False ``` ### -OpenFromUrlThrottlingEnabled -Throttles the number of Open From URL requests from any given server in a time period. -The default throttling values, which are not configurable, make sure that an Office Online Server farm will not overwhelm a single server with requests for content to be viewed in the Online Viewers. + +Throttles the number of Open From URL requests from any given server in a time period. The default +throttling values, which are not configurable, make sure that an Office Online Server farm will not +overwhelm a single server with requests for content to be viewed in the Online Viewers. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -794,14 +840,15 @@ Accept wildcard characters: False ``` ### -PicturePasteDisabled -Turns off the ability for users to paste images from a web page into Office in a browser. -The default is False. -If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to False, users can paste images into Office in a browser. + +Turns off the ability for users to paste images from a web page into Office in a browser. The +default is False. If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to +False, users can paste images into Office in a browser. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -811,13 +858,14 @@ Accept wildcard characters: False ``` ### -Proxy + Specifies the URL of the proxy server that is configured to allow HTTP requests to external sites. Typically configured in conjunction with the ClipartEnabled and TranslationEnabled parameters. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -827,15 +875,14 @@ Accept wildcard characters: False ``` ### -RecycleActiveProcessCount -Specifies the number of files that a single Word or PowerPoint process can render before the process is recycled. -The type must be an integer value in the range of 1 to 1000. -The default value is 5. +Specifies the number of files that a single Word or PowerPoint process can render before the process +is recycled. The type must be an integer value in the range of 1 to 1000. The default value is 5. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -845,24 +892,22 @@ Accept wildcard characters: False ``` ### -RemovePersonalInformationFromLogs -Provides a best effort scrub of personal information from Office Online Server logs and replaces values with a SHA256 hash. -Potentially scrubbed information can be: - -Document names and URLs - -IP addresses -Email addresses +Provides a best effort scrub of personal information from Office Online Server logs and replaces +values with a SHA256 hash. Potentially scrubbed information can be: -User names +- Document names and URLs +- IP addresses +- Email addresses +- User names -The default is False. -Note that enabling this parameter doesn't guarantee that personal information won't be logged to the Office Online Server logs. +The default is False. Note that enabling this parameter doesn't guarantee that personal information +won't be logged to the Office Online Server logs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -872,14 +917,15 @@ Accept wildcard characters: False ``` ### -RenderingLocalCacheLocation + Specifies the location of the temporary cache for use by the Word and PowerPoint Viewing Services. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\waccache\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Working\waccache\`. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -889,12 +935,14 @@ Accept wildcard characters: False ``` ### -S2SCertificateName -The friendly name of the certificate to use for server-to-server authentication with SharePoint Server. + +The friendly name of the certificate to use for server-to-server authentication with SharePoint +Server. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -904,14 +952,16 @@ Accept wildcard characters: False ``` ### -SSLOffloaded -Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load balancer. -When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local server. -However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for those references. + +Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load +balancer. When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local +server. However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for +those references. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -921,16 +971,18 @@ Accept wildcard characters: False ``` ### -TranslationEnabled -Enables support for automatic document translation using Microsoft Translator, an online service that translates text between languages. -The translated file is shown in Word. -Because Microsoft Translator is an online service, you must enable server-to-web communication directly or by using a proxy that you specify by using the Proxy parameter. + +Enables support for automatic document translation using Microsoft Translator, an online service +that translates text between languages. The translated file is shown in Word. Because Microsoft +Translator is an online service, you must enable server-to-web communication directly or by using a +proxy that you specify by using the Proxy parameter. Microsoft Translator may collect data to improve the quality of translations. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -940,14 +992,15 @@ Accept wildcard characters: False ``` ### -TranslationServiceAddress -Specifies the URL of the translation server that translation requests are sent to. -The default is the Microsoft Translator online service. -Typically you will not use this parameter unless you must change translation services. + +Specifies the URL of the translation server that translation requests are sent to. The default is +the Microsoft Translator online service. Typically you will not use this parameter unless you must +change translation services. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -957,14 +1010,16 @@ Accept wildcard characters: False ``` ### -TranslationServiceAppId -Specifies the application ID for the translation service. -The default is the public application ID for Office in a browser. -Typically you will not use this parameter unless you have negotiated with Microsoft Translator for additional services and they have provided you with a private application ID. + +Specifies the application ID for the translation service. The default is the public application ID +for Office in a browser. Typically you will not use this parameter unless you have negotiated with +Microsoft Translator for additional services and they have provided you with a private application +ID. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -974,8 +1029,9 @@ Accept wildcard characters: False ``` ### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters + +Displays a message that describes the effect of the command instead of executing the command. For +more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md index b8b8d28dcf..a0f6c9701d 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsHost ## SYNOPSIS + Adds a host domain to the Allow List for an Office Online Server farm. ## SYNTAX @@ -21,42 +22,48 @@ 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 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. +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 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. -The wildcard * is assumed for any domain that is added to the Allow List so that requests to all subdomains are also allowed. -For example, if you add the domain contoso.com to the Allow List, Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. +The wildcard * is assumed for any domain that is added to the Allow List so that requests to all +subdomains are also allowed. For example, if you add the domain contoso.com to the Allow List, +Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. Requests to other domains (such as fabrikam.com) are not allowed. -If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any domain. -Do not leave this list blank if your Office Online Server farm is accessible from the Internet. -Otherwise anyone can use your Office Online Server farm to view and edit content. +If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any +domain. Do not leave this list blank if your Office Online Server farm is accessible from the +Internet. Otherwise anyone can use your Office Online Server farm to view and edit content. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell New-OfficeWebAppsHost -domain "contoso.com" ``` This example adds the domain contoso.com to the Allow List. -You cannot add multiple host domains to the Allow List all at the same time. -You must run the New-OfficeWebAppsHost cmdlet for each host domain that you want to add to the Allow List. +You cannot add multiple host domains to the Allow List all at the same time. You must run the +New-OfficeWebAppsHost cmdlet for each host domain that you want to add to the Allow List. ## PARAMETERS ### -Domain + Specifies the domain to add to the Allow List. Do not specify an asterisk or start it with a period. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md index e14ee933a9..a3fe411c10 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsMachine ## SYNOPSIS + Adds the current server to an existing Office Online Server farm. ## SYNTAX @@ -21,26 +22,31 @@ New-OfficeWebAppsMachine [-Force] [-MachineToJoin] [-Roles ] ``` ## DESCRIPTION -The New-OfficeWebAppsMachine cmdlet adds the current server to an existing Office Online Server farm and optionally sets one or more roles on the new server. + +The New-OfficeWebAppsMachine cmdlet adds the current server to an existing Office Online Server farm +and optionally sets one or more roles on the new server. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell New-OfficeWebAppsMachine -MachineToJoin server1.contoso.com ``` -This example adds the current server to the Office Online Server farm that is running on the server named server1.contoso.com. +This example adds the current server to the Office Online Server farm that is running on the server +named server1.contoso.com. ## PARAMETERS ### -MachineToJoin + Specifies the name of any server that is already a member of the Office Online Server farm. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -50,8 +56,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -66,12 +72,13 @@ Accept wildcard characters: False ``` ### -Force + Assumes the answer to any user prompt is Yes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -81,18 +88,16 @@ Accept wildcard characters: False ``` ### -Roles -Specifies one or more server roles, separated by commas, to assign to the new server. -If no roles are specified, then the server is assigned all roles. - -The role types are as follows: -FrontEnd +Specifies one or more server roles, separated by commas, to assign to the new server. If no roles +are specified, then the server is assigned all roles. -WordBackEnd - -ExcelBackEnd +The role types are as follows: -PowerPointBackEnd +- FrontEnd +- WordBackEnd +- ExcelBackEnd +- PowerPointBackEnd As a best practice, we recommend that all servers in an Office Online Server farm run all roles. Assigning roles is not useful until the Office Online Server farm contains approximately 50 servers. @@ -100,7 +105,7 @@ Assigning roles is not useful until the Office Online Server farm contains appro ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -110,8 +115,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md index a77ac79a21..3c771412ea 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md @@ -12,7 +12,9 @@ ms.reviewer: # Remove-OfficeWebAppsExcelBIServer ## SYNOPSIS -Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel Online. + +Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel +Online. ## SYNTAX @@ -21,24 +23,30 @@ Remove-OfficeWebAppsExcelBIServer -ServerId ``` ## DESCRIPTION -Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel Online. + +Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel +Online. ## EXAMPLES -### This example removes the server named SSAS01 from the Allow List. -``` +### Example 1 + +This example removes the server named SSAS01 from the Allow List. + +```powershell Remove-OfficeWebAppsExcelBIServer -ServerID "SSAS01" ``` ## PARAMETERS ### -ServerId + The name of the Analysis Services server. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md index 6fb132b9ed..2548862222 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # Remove-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Removes an existing UDF definition. ## SYNTAX @@ -21,24 +22,29 @@ Remove-OfficeWebAppsExcelUserDefinedFunction [-Identity] [ ``` ## DESCRIPTION + Removes an existing UDF definition. ## EXAMPLES -### This example removes the UDF c:\myudf.dll. -``` +### Example 1 + +This example removes the UDF c:\myudf.dll. + +```powershell Remove-OfficeWebAppsExcelUserDefinedFunction -Identity c:\myudf.dll ``` ## PARAMETERS ### -Identity + The path and filename of the UDF. ```yaml Type: UserDefinedFunction Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -48,8 +54,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -64,8 +70,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md index 24e918437f..bf5d6e8f6c 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md @@ -12,6 +12,7 @@ ms.reviewer: # Remove-OfficeWebAppsHost ## SYNOPSIS + Removes a host domain from the Allow List for an Office Online Server farm. ## SYNTAX @@ -21,17 +22,19 @@ Remove-OfficeWebAppsHost -Domain ``` ## DESCRIPTION -The Remove-OfficeWebAppsHost cmdlet removes the specified host domain from the Allow List. -The Allow List contains the host domains to which Office Online Server allows file operations requests. -If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any domain. -Do not leave this list blank if your Office Online Server farm is accessible from the Internet. -Otherwise anyone can use your Office Online Server farm to view and edit content. +The Remove-OfficeWebAppsHost cmdlet removes the specified host domain from the Allow List. The Allow +List contains the host domains to which Office Online Server allows file operations requests. + +If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any +domain. Do not leave this list blank if your Office Online Server farm is accessible from the +Internet. Otherwise anyone can use your Office Online Server farm to view and edit content. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell Remove-OfficeWebAppsHost -domain "contoso.com" ``` @@ -40,12 +43,13 @@ This example removes the domain contoso.com from the Allow List. ## PARAMETERS ### -Domain + Specifies the host domain to remove from the Allow List. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md index eb7f54047f..1b256e19b4 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # Remove-OfficeWebAppsMachine ## SYNOPSIS + Removes the current server from the Office Online Server farm. ## SYNTAX @@ -21,16 +22,22 @@ Remove-OfficeWebAppsMachine [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The Remove-OfficeWebAppsMachine cmdlet removes the current server from the Office Online Server farm. -As part of this process, the cmdlet removes the web applications and shuts down the services that are related to Office Online Server. -If you cannot run the Remove-OfficeWebAppsMachine cmdlet from the server that you want to remove, use the Repair-OfficeWebAppsFarm cmdlet from any other server in the Office Online farm. -If the local server is designated as the master server in the Office Online Server farm, you cannot remove it from the farm until you assign a different server as master by using the Set-OfficeWebAppsMachine cmdlet, or until you remove all other servers from the farm. +The Remove-OfficeWebAppsMachine cmdlet removes the current server from the Office Online Server +farm. As part of this process, the cmdlet removes the web applications and shuts down the services +that are related to Office Online Server. If you cannot run the Remove-OfficeWebAppsMachine cmdlet +from the server that you want to remove, use the Repair-OfficeWebAppsFarm cmdlet from any other +server in the Office Online farm. + +If the local server is designated as the master server in the Office Online Server farm, you cannot +remove it from the farm until you assign a different server as master by using the +Set-OfficeWebAppsMachine cmdlet, or until you remove all other servers from the farm. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell Remove-OfficeWebAppsMachine ``` @@ -39,8 +46,8 @@ This example removes the current server from the Office Online Server farm. ## PARAMETERS ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -55,8 +62,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md index fa7c33ca21..b30252119d 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md @@ -12,6 +12,7 @@ ms.reviewer: # Repair-OfficeWebAppsFarm ## SYNOPSIS + Removes all servers flagged as unhealthy from an Office Online Server farm. ## SYNTAX @@ -21,25 +22,30 @@ Repair-OfficeWebAppsFarm [-Force] [-WhatIf] [-Confirm] ``` ## DESCRIPTION -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. -If there are multiple unhealthy servers, you are prompted before each server is removed. -If there are no unhealthy servers, this cmdlet does nothing. +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. + +If there are multiple unhealthy servers, you are prompted before each server is removed. If there +are no unhealthy servers, this cmdlet does nothing. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell (Get-OfficeWebAppsFarm).Machines ``` This example displays the health status of all servers in the Office Online Server farm. -### ------------------EXAMPLE 2--------------------- -``` +### EXAMPLE 2 + +```powershell Repair-OfficeWebAppsFarm ``` @@ -48,8 +54,8 @@ This example removes all unhealthy servers from the Office Online Server farm. ## PARAMETERS ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -64,12 +70,13 @@ Accept wildcard characters: False ``` ### -Force + Assumes the answer to any user prompt is Yes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -79,8 +86,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md index 3f8b966834..cdbf52285b 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # Set-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Sets properties on existing UDF definitions. ## SYNTAX @@ -22,24 +23,29 @@ Set-OfficeWebAppsExcelUserDefinedFunction [-Identity] [-As ``` ## DESCRIPTION + Sets properties on existing UDF definitions. ## EXAMPLES -### This example disables the UDF at c:\myudf.dll. -``` +### Example 1 + +This example disables the UDF at c:\myudf.dll. + +```powershell Set-OfficeWebAppsExcelUserDefinedFunction -Identity c:\myudf.dll -Enable:$false ``` ## PARAMETERS ### -Identity + The path and filename of the UDF. ```yaml Type: UserDefinedFunction Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -49,12 +55,13 @@ Accept wildcard characters: False ``` ### -Assembly + The name of the assembly. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -64,13 +71,18 @@ Accept wildcard characters: False ``` ### -AssemblyLocation + The location of the assembly. -Values: LocalFile - a local directory; GAC - the Global Assembly Cache. + +Values: + +- LocalFile - a local directory +- GAC - the Global Assembly Cache ```yaml Type: AssemblyLocation Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -80,8 +92,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -96,12 +108,13 @@ Accept wildcard characters: False ``` ### -Description + A description of the assembly. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -111,12 +124,13 @@ Accept wildcard characters: False ``` ### -Enable + Enables the UDF. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -126,8 +140,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md index 800ce67d72..68a1b316c3 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md @@ -12,51 +12,58 @@ ms.reviewer: # Set-OfficeWebAppsFarm ## SYNOPSIS + Configures the settings of an existing Office Online Server farm. ## SYNTAX ``` -Set-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] [-AllowHttp] - [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] [-S2SCertificateName ] - [-EditingEnabled] [-Proxy ] [-LogLocation ] [-LogRetentionInDays ] - [-LogVerbosity ] [-CacheLocation ] [-MaxMemoryCacheSizeInMB ] - [-DocumentInfoCacheSize ] [-CacheSizeInGB ] [-ClipartEnabled] [-TranslationEnabled] - [-MaxTranslationCharacterCount ] [-TranslationServiceAppId ] - [-TranslationServiceAddress ] [-RenderingLocalCacheLocation ] - [-RecycleActiveProcessCount ] [-AllowCEIP] [-ExcelRequestDurationMax ] - [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] [-ExcelPrivateBytesMax ] - [-ExcelConnectionLifetime ] [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] - [-ExcelUseEffectiveUserName] [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] - [-ExcelMemoryCacheThreshold ] [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] - [-ExcelAbortOnRefreshOnOpenFail] [-ExcelAutomaticVolatileFunctionCacheLifeTime ] - [-ExcelConcurrentDataRequestsPerSessionMax ] [-ExcelDefaultWorkbookCalcMode ] - [-ExcelRestExternalDataEnabled] [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] - [-OpenFromUncEnabled] [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] - [-RemovePersonalInformationFromLogs] [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] +Set-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] + [-AllowHttp] [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] + [-S2SCertificateName ] [-EditingEnabled] [-Proxy ] [-LogLocation ] + [-LogRetentionInDays ] [-LogVerbosity ] [-CacheLocation ] + [-MaxMemoryCacheSizeInMB ] [-DocumentInfoCacheSize ] [-CacheSizeInGB ] + [-ClipartEnabled] [-TranslationEnabled] [-MaxTranslationCharacterCount ] + [-TranslationServiceAppId ] [-TranslationServiceAddress ] + [-RenderingLocalCacheLocation ] [-RecycleActiveProcessCount ] [-AllowCEIP] + [-ExcelRequestDurationMax ] [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] + [-ExcelPrivateBytesMax ] [-ExcelConnectionLifetime ] + [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] [-ExcelUseEffectiveUserName] + [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] [-ExcelMemoryCacheThreshold ] + [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] [-ExcelAbortOnRefreshOnOpenFail] + [-ExcelAutomaticVolatileFunctionCacheLifeTime ] + [-ExcelConcurrentDataRequestsPerSessionMax ] + [-ExcelDefaultWorkbookCalcMode ] [-ExcelRestExternalDataEnabled] + [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] [-OpenFromUncEnabled] + [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] [-RemovePersonalInformationFromLogs] + [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] ``` ## DESCRIPTION + The Set-OfficeWebAppsFarm cmdlet configures the settings of an existing Office Online Server farm. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell Set-OfficeWebAppsFarm -ClipartEnabled:$true ``` This example enables insertion of clip art from Office.com. -### ------------------EXAMPLE 2--------------------- -``` +### EXAMPLE 2 + +```powershell Set-OfficeWebAppsFarm -EditingEnabled:$true ``` This example enables edit functionality for Office in a browser. -### ------------------EXAMPLE 3--------------------- -``` +### EXAMPLE 3 + +```powershell Set-OfficeWebAppsFarm -OpenFromUncEnabled:$false ``` @@ -65,14 +72,16 @@ This example turns off the ability to view any Office file from a UNC path. ## PARAMETERS ### -AllowCEIP -Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online Server farm. + +Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online +Server farm. You must restart every server in the Office Online Server farm for this change to take effect. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -82,8 +91,10 @@ Accept wildcard characters: False ``` ### -AllowHttp -Indicates that IIS sites should be provisioned on port 80 for HTTP access. -Use AllowHTTP only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. + +Indicates that IIS sites should be provisioned on port 80 for HTTP access. Use AllowHTTP only in +environments where all computers require IPSEC (full encryption) or in test environments that do not +contain sensitive files. Enabled automatically when you enable SSLOffloaded. @@ -92,7 +103,7 @@ You must restart every server in the farm for this change to take effect. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -102,15 +113,17 @@ Accept wildcard characters: False ``` ### -AllowHttpSecureStoreConnections -Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). -The default is False. -Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. +Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). The +default is False. + +Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full +encryption) or in test environments that do not contain sensitive files. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -120,12 +133,13 @@ Accept wildcard characters: False ``` ### -AllowOutboundHttp + Allows outbound HTTP connections from Office Online Server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -135,13 +149,14 @@ Accept wildcard characters: False ``` ### -CacheLocation + Specifies the location of the global disk cache that is used to store rendered image files. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\d\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Working\d\`. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -151,15 +166,14 @@ Accept wildcard characters: False ``` ### -CacheSizeInGB -Specifies the maximum size of the global disk cache in gigabytes. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 15 GB. +Specifies the maximum size of the global disk cache in gigabytes. The type must be an integer value +in the range of 0 to any positive integer. The default size is 15 GB. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -169,21 +183,25 @@ Accept wildcard characters: False ``` ### -CertificateName -Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS bindings. -If the specified certificate is not found or has expired, or if the specified value is associated with more than one certificate, an error is logged and the farm is not created. +Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS +bindings. -This value is used on every server that joins the Office Online Server farm. -Therefore, every server in the farm must have a certificate that has this friendly name. +If the specified certificate is not found or has expired, or if the specified value is associated +with more than one certificate, an error is logged and the farm is not created. -You don't have to specify the CertificateName parameter if you are using either the AllowHttp or SSLOffloaded parameter. +This value is used on every server that joins the Office Online Server farm. Therefore, every server +in the farm must have a certificate that has this friendly name. + +You don't have to specify the CertificateName parameter if you are using either the AllowHttp or +SSLOffloaded parameter. You must restart every server in the farm for this change to take effect. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -193,13 +211,15 @@ Accept wildcard characters: False ``` ### -ClipartEnabled -Enables support for inserting clip art from Office.com into Office documents. -This feature requires server-to-web communication, configured either directly or by using a proxy that you specify by using the Proxy parameter. + +Enables support for inserting clip art from Office.com into Office documents. This feature requires +server-to-web communication, configured either directly or by using a proxy that you specify by +using the Proxy parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -209,8 +229,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters. ```yaml Type: SwitchParameter @@ -225,6 +245,7 @@ Accept wildcard characters: False ``` ### -DocumentInfoCacheSize + Specifies the maximum number of document conversion records that are stored in a memory cache. The default value is 5000 records. @@ -232,7 +253,7 @@ The default value is 5000 records. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -242,14 +263,14 @@ Accept wildcard characters: False ``` ### -EditingEnabled -Enables support for editing in the browser. -The default is False. -Only set to True if you have the appropriate licensing to use the edit functionality. + +Enables support for editing in the browser. The default is False. Only set to True if you have the +appropriate licensing to use the edit functionality. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -259,13 +280,14 @@ Accept wildcard characters: False ``` ### -ExcelAbortOnRefreshOnOpenFail -Prevents a workbook from loading if data refresh fails. -This helps prevent users from seeing out-of-date information or possibly information that they should not have access to. + +Prevents a workbook from loading if data refresh fails. This helps prevent users from seeing +out-of-date information or possibly information that they should not have access to. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -275,13 +297,14 @@ Accept wildcard characters: False ``` ### -ExcelAllowExternalData -Enables the refresh of supported external data in Excel workbooks in a browser where workbooks contain connections to external data. -The default is True. + +Enables the refresh of supported external data in Excel workbooks in a browser where workbooks +contain connections to external data. The default is True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -291,15 +314,18 @@ Accept wildcard characters: False ``` ### -ExcelAutomaticVolatileFunctionCacheLifeTime -Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. --1: Calculates once when the workbook loads. -0: Always calculates. -1 to 2073600: Caches 1 second to 24 days. + +Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for +automatic recalculations. + +- -1: Calculates once when the workbook loads. +- 0: Always calculates. +- 1 to 2073600: Caches 1 second to 24 days. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -309,12 +335,13 @@ Accept wildcard characters: False ``` ### -ExcelCachingUnusedFiles + Enable caching of files that are no longer in use by Web Excel sessions. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -324,13 +351,14 @@ Accept wildcard characters: False ``` ### -ExcelChartAndImageSizeMax -Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a browser. -The value must be an integer greater than 0. + +Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a +browser. The value must be an integer greater than 0. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -340,13 +368,14 @@ Accept wildcard characters: False ``` ### -ExcelConcurrentDataRequestsPerSessionMax -Specifies the maximum number of concurrent external data requests allowed in each session. -If a session must issue more than this number of requests, additional requests are queued. + +Specifies the maximum number of concurrent external data requests allowed in each session. If a +session must issue more than this number of requests, additional requests are queued. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -356,13 +385,14 @@ Accept wildcard characters: False ``` ### -ExcelConnectionLifetime -Specifies the duration, in seconds, of external data connections for Excel in a browser. -The default is 1800 seconds. + +Specifies the duration, in seconds, of external data connections for Excel in a browser. The default +is 1800 seconds. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -372,12 +402,13 @@ Accept wildcard characters: False ``` ### -ExcelDefaultWorkbookCalcMode + PARAMVALUE: File | Manual | Auto | AutoDataTables ```yaml Type: DefaultWorkbookCalcMode Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -387,13 +418,14 @@ Accept wildcard characters: False ``` ### -ExcelExternalDataCacheLifetime -Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. -The default is 300 seconds. + +Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. The +default is 300 seconds. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -403,14 +435,15 @@ Accept wildcard characters: False ``` ### -ExcelMemoryCacheThreshold -The percentage of the Maximum Private Bytes that can be allocated to inactive objects. -When the memory cache threshold is exceeded, cached objects that are not currently in use are released. -Valid values: 0 (disables caching of inactive objects); from 1 through 95. + +The percentage of the Maximum Private Bytes that can be allocated to inactive objects. When the +memory cache threshold is exceeded, cached objects that are not currently in use are released. Valid +values: 0 (disables caching of inactive objects); from 1 through 95. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -420,18 +453,18 @@ Accept wildcard characters: False ``` ### -ExcelPrivateBytesMax -Specifies the maximum private bytes, in megabytes, used by Excel in a browser. -When set to -1, the maximum private bytes use 50 percent of physical memory on the computer. -The type must be -1 or any positive integer. -The default value is -1. +Specifies the maximum private bytes, in megabytes, used by Excel in a browser. When set to -1, the +maximum private bytes use 50 percent of physical memory on the computer. + +The type must be -1 or any positive integer. The default value is -1. You must restart every server in the farm for this change to take effect. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -441,16 +474,16 @@ Accept wildcard characters: False ``` ### -ExcelRequestDurationMax -Specifies the maximum duration, in seconds, for a single request in a session. -After this time elapses, the request times out. -The type must be -1 (no limit) or an integer in the range of 1 to 2073600. -The default value is 300. +Specifies the maximum duration, in seconds, for a single request in a session. After this time +elapses, the request times out. + +The type must be -1 (no limit) or an integer in the range of 1 to 2073600. The default value is 300. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -460,15 +493,14 @@ Accept wildcard characters: False ``` ### -ExcelRestExternalDataEnabled -Allow requests from the REST API to refresh external data connections. -This setting has no effect if Allow External Data is set to None. -Check box Bool. -Default is False. + +Allow requests from the REST API to refresh external data connections. This setting has no effect if +Allow External Data is set to None. Check box Bool. Default is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -478,20 +510,20 @@ Accept wildcard characters: False ``` ### -ExcelSessionTimeout -Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no user activity. -Valid values include the following: --1 Session never expires. +Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no +user activity. Valid values include the following: -0 Session expires at the end of a single request. +- -1 Session never expires. +- 0 Session expires at the end of a single request. +- 1 to 2073600 Session remains active for 1 second to 24 days. -1 to 2073600 Session remains active for 1 second to 24 days. The default value is 450. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -501,13 +533,13 @@ Accept wildcard characters: False ``` ### -ExcelUdfsAllowed -Enables User Defined Functions for Excel in a browser. -The default is False. + +Enables User Defined Functions for Excel in a browser. The default is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -517,15 +549,21 @@ Accept wildcard characters: False ``` ### -ExcelUnusedObjectAgeMax -The maximum time (in minutes) that inactive objects remain in the memory cache. -Inactive objects are objects that are not used in a session. -Valid values: -1 (no maximum); from 1 through 34560 (24 days). + +The maximum time (in minutes) that inactive objects remain in the memory cache. Inactive objects are +objects that are not used in a session. + +Valid values: + +- -1 (no maximum) +- 1 through 34560 (24 days). + Default is -1. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -535,13 +573,14 @@ Accept wildcard characters: False ``` ### -ExcelUseEffectiveUserName -Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. -The default is False. + +Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. The +default is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -551,12 +590,13 @@ Accept wildcard characters: False ``` ### -ExcelWarnOnDataRefresh + Turns off or on the warning dialog box that is displayed when data refreshes in Excel in a browser. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -566,15 +606,15 @@ Accept wildcard characters: False ``` ### -ExcelWorkbookSizeMax + Specifies the maximum size, in megabytes, of a workbook that can be loaded. -The type must be an integer value in the range of 1 to 2000. -The default value is 10. +The type must be an integer value in the range of 1 to 2000. The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -584,16 +624,18 @@ Accept wildcard characters: False ``` ### -ExternalURL + Specifies the URL root that clients use to access the Office Online Server farm from the Internet. -In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to the IP address of the external-facing load balancer. +In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to +the IP address of the external-facing load balancer. -An Office Online Server farm requires at least one URL,that isset by using either ExternalURL or InternalURL. -You can also set both internal and external URLs. +An Office Online Server farm requires at least one URL,that isset by using either ExternalURL or +InternalURL. You can also set both internal and external URLs. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -603,13 +645,15 @@ Accept wildcard characters: False ``` ### -FarmOU -Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of to join the Office Online Server farm. -Use this parameter to prevent unauthorized servers (that is, servers that are not in the OU) from joining an Office Online Server farm. + +Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of +to join the Office Online Server farm. Use this parameter to prevent unauthorized servers (that is, +servers that are not in the OU) from joining an Office Online Server farm. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -619,12 +663,13 @@ Accept wildcard characters: False ``` ### -Force + Suppresses any user prompts by answering "Yes." ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -634,16 +679,17 @@ Accept wildcard characters: False ``` ### -InternalURL -Specifies the URL root that clients must use to access the Office Online Server farm from the intranet. -An Office Online Server farm requires at least one URL. -It is set using either ExternalURL or InternalURL. -You can also set both internal and external URLs. +Specifies the URL root that clients must use to access the Office Online Server farm from the +intranet. + +An Office Online Server farm requires at least one URL. It is set using either ExternalURL or +InternalURL. You can also set both internal and external URLs. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -653,10 +699,11 @@ Accept wildcard characters: False ``` ### -LogLocation + Specifies the location on the local computer where activity logs are stored. The location applies for every server in the farm and cannot be customized on a per-server basis. -The default location is %programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\`. Be sure to allow sufficient disk space on the drive where logs are stored. @@ -665,7 +712,7 @@ You must restart every server in the farm for this change to take effect. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -675,18 +722,18 @@ Accept wildcard characters: False ``` ### -LogRetentionInDays -Specifies the number of days that log entries are stored. -Log entries older than the configured date are trimmed. -The type must be an integer value in the range of 0 to 365. -The default value is 7 days. +Specifies the number of days that log entries are stored. Log entries older than the configured date +are trimmed. + +The type must be an integer value in the range of 0 to 365. The default value is 7 days. You must restart every server in the farm for this change to take effect. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -696,23 +743,19 @@ Accept wildcard characters: False ``` ### -LogVerbosity -Specifies how much information is stored in the trace log files. -The values are as follows: - -VerboseEX writes low-level detail to the trace log file. -Useful for traces that are likely to be high volume. - -Verbose writes low-level detail to the trace log file. - -Medium writes medium-level detail to the trace log file. - -High writes high-level detail to the trace log file. - -Monitorable writes traces that represent an unusual code path and actions that should be monitored. -Unexpected writes traces that represent an unexpected code path and actions that should be monitored. +Specifies how much information is stored in the trace log files. The values are as follows: -None writes no trace information to the trace log file. +- VerboseEX writes low-level detail to the trace log file. Useful for traces that are likely to be + high volume. +- Verbose writes low-level detail to the trace log file. +- Medium writes medium-level detail to the trace log file. +- High writes high-level detail to the trace log file. +- Monitorable writes traces that represent an unusual code path and actions that should be + monitored. +- Unexpected writes traces that represent an unexpected code path and actions that should be + monitored. +- None writes no trace information to the trace log file. Leaving the LogVerbosity at a low level for a long time will adversely affect performance. @@ -721,7 +764,7 @@ You must restart every server in the farm for this change to take effect. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -731,15 +774,16 @@ Accept wildcard characters: False ``` ### -MaxMemoryCacheSizeInMB + Specifies, in megabytes, the maximum amount of memory that the rendering cache can use. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 1024 MB. +The type must be an integer value in the range of 0 to any positive integer. The default size is +1024 MB. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -749,16 +793,16 @@ Accept wildcard characters: False ``` ### -MaxTranslationCharacterCount + Specifies the maximum number of characters a document can have in order to be translated. -The type must be an integer value. -The value can be set to 0 to indicate no limit or a value from 2000 to 2,000,000. -The default value is 125,000. +The type must be an integer value. The value can be set to 0 to indicate no limit or a value from +2000 to 2,000,000. The default value is 125,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -768,6 +812,7 @@ Accept wildcard characters: False ``` ### -OpenFromUncEnabled + Turns on or off the ability to use Online Viewers to view Office files from a UNC path. You must first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths. @@ -775,7 +820,7 @@ You must first set OpenFromUrlEnabled to True to allow Online Viewers to display ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -785,12 +830,13 @@ Accept wildcard characters: False ``` ### -OpenFromUrlEnabled + Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -800,13 +846,15 @@ Accept wildcard characters: False ``` ### -OpenFromUrlThrottlingEnabled -Throttles the number of Open From URL requests from any given server in a time period. -The default throttling values, which are not configurable, make sure that an Office Online Server farm will not overwhelm a single server with requests for content to be viewed in the Online Viewers. + +Throttles the number of Open From URL requests from any given server in a time period. The default +throttling values, which are not configurable, make sure that an Office Online Server farm will not +overwhelm a single server with requests for content to be viewed in the Online Viewers. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -816,14 +864,15 @@ Accept wildcard characters: False ``` ### -PicturePasteDisabled -Turns off the ability for users to paste images from a web page into Office in a browser. -The default is False. -If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to False, users can paste images into Office in a browser. + +Turns off the ability for users to paste images from a web page into Office in a browser. The +default is False. If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to +False, users can paste images into Office in a browser. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -833,13 +882,14 @@ Accept wildcard characters: False ``` ### -Proxy + Specifies the URL of the proxy server that is configured to allow HTTP requests to external sites. Typically configured together with the ClipartEnabled and TranslationEnabled parameters. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -849,17 +899,16 @@ Accept wildcard characters: False ``` ### -RecycleActiveProcessCount -Specifies the number of files that a single Word or PowerPoint process can render before the process is recycled. -The type must be an integer value in the range of 1 to 1000. -The default value is 5. +Specifies the number of files that a single Word or PowerPoint process can render before the process +is recycled. The type must be an integer value in the range of 1 to 1000. The default value is 5. You must restart every server in the farm for this change to take effect. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -869,24 +918,22 @@ Accept wildcard characters: False ``` ### -RemovePersonalInformationFromLogs -Provides a best effort scrub of personal information from Office Online Server logs and replaces values with a SHA256 hash. -Potentially scrubbed information can be: - -Document names and URLs -IP addresses +Provides a best effort scrub of personal information from Office Online Server logs and replaces +values with a SHA256 hash. Potentially scrubbed information can be: -Email addresses +- Document names and URLs +- IP addresses +- Email addresses +- User names -User names - -The default is False. -Note that enabling this parameter doesn't guarantee that personal information won't be logged to the Office Online Server logs. +The default is False. Note that enabling this parameter doesn't guarantee that personal information +won't be logged to the Office Online Server logs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -896,14 +943,15 @@ Accept wildcard characters: False ``` ### -RenderingLocalCacheLocation + Specifies the location of the temporary cache for use by the Word and PowerPoint Viewing Services. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\waccache\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Working\waccache\`. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -913,12 +961,14 @@ Accept wildcard characters: False ``` ### -S2SCertificateName -The friendly name of the certificate to use for server-to-server authentication with SharePoint Server. + +The friendly name of the certificate to use for server-to-server authentication with SharePoint +Server. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -928,16 +978,18 @@ Accept wildcard characters: False ``` ### -SSLOffloaded -Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load balancer. -When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local server. -However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for those references. + +Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load +balancer. When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local +server. However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for +those references. You must restart every server in the farm for this change to take effect. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -947,16 +999,18 @@ Accept wildcard characters: False ``` ### -TranslationEnabled -Enables support for automatic document translation using Microsoft Translator, an online service that translates text between languages. -The translated file is shown in Word. -Because Microsoft Translator is an online service, you must enable server-to-web communication directly or by using a proxy that you specify by using the Proxy parameter. + +Enables support for automatic document translation using Microsoft Translator, an online service +that translates text between languages. The translated file is shown in Word. Because Microsoft +Translator is an online service, you must enable server-to-web communication directly or by using a +proxy that you specify by using the Proxy parameter. Microsoft Translator may collect data to improve the quality of translations. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -966,16 +1020,17 @@ Accept wildcard characters: False ``` ### -TranslationServiceAddress -Specifies the URL of the translation server that translation requests are sent to. -The default is the Microsoft Translator online service. -Typically you will not use this parameter unless you must change translation services. + +Specifies the URL of the translation server that translation requests are sent to. The default is +the Microsoft Translator online service. Typically you will not use this parameter unless you must +change translation services. You must restart every server in the Office Online Server farm for this change to take effect. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -985,14 +1040,16 @@ Accept wildcard characters: False ``` ### -TranslationServiceAppId -Specifies the application ID for the translation service. -The default is the public application ID for Office in a browser. -Typically you will not use this parameter unless you have negotiated with Microsoft Translator for additional services and they have provided you with a private application ID. + +Specifies the application ID for the translation service. The default is the public application ID +for Office in a browser. Typically you will not use this parameter unless you have negotiated with +Microsoft Translator for additional services and they have provided you with a private application +ID. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1002,8 +1059,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md index eced821b85..8ecdea8977 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # Set-OfficeWebAppsMachine ## SYNOPSIS + Changes the settings of the current server that is in an Office Online Server farm. ## SYNTAX @@ -21,27 +22,32 @@ Set-OfficeWebAppsMachine [-Master ] [-Roles ] [-WhatIf] [-Conf ``` ## DESCRIPTION -The Set-OfficeWebAppsMachine cmdlet changes the settings of the current server that is in an Office Online Server farm. -The settings include the roles held by the current server and the designated master server for the farm. + +The Set-OfficeWebAppsMachine cmdlet changes the settings of the current server that is in an Office +Online Server farm. The settings include the roles held by the current server and the designated +master server for the farm. ## EXAMPLES -### ------------------EXAMPLE 1--------------------- -``` +### EXAMPLE 1 + +```powershell (Get-OfficeWebAppsFarm).Machines ``` This example shows the roles held by each server in the Office Online Server farm. -### ------------------EXAMPLE 2--------------------- -``` +### EXAMPLE 2 + +```powershell Set-OfficeWebAppsMachine -Roles FrontEnd ``` This example configures the current server as a Front End server. -### ------------------EXAMPLE 3--------------------- -``` +### EXAMPLE 3 + +```powershell Set-OfficeWebAppsMachine -Roles All ``` @@ -50,8 +56,8 @@ This example configures the current server to host all roles. ## PARAMETERS ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -66,14 +72,15 @@ Accept wildcard characters: False ``` ### -Master -Specifies the server that stores the master farm configuration files. -If you set the local server as the master, you must run Set-OfficeWebAppsMachine -Master on all of the remaining servers in the Office Online Server farm to point them to the new master. +Specifies the server that stores the master farm configuration files. If you set the local server as +the master, you must run Set-OfficeWebAppsMachine -Master on all of the remaining servers in the +Office Online Server farm to point them to the new master. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -83,19 +90,15 @@ Accept wildcard characters: False ``` ### -Roles -Specifies the list of server roles to assign to the local server, separated by commas. - -The role types are as follows: - -All -FrontEnd +Specifies the list of server roles to assign to the local server, separated by commas. The role +types are as follows: -WordBackEnd - -ExcelBackEnd - -PowerPointBackEnd +- All +- FrontEnd +- WordBackEnd +- ExcelBackEnd +- PowerPointBackEnd As a best practice, we recommend that all servers in an Office Online Server farm run all roles. Assigning roles is not useful until the Office Online Server farm contains approximately 50 servers. @@ -103,7 +106,7 @@ Assigning roles is not useful until the Office Online Server farm contains appro ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -113,8 +116,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/officewebapps.md b/officewebapps/officewebapps-ps/officewebapps/officewebapps.md index 7bda9b6c5d..6456880abe 100644 --- a/officewebapps/officewebapps-ps/officewebapps/officewebapps.md +++ b/officewebapps/officewebapps-ps/officewebapps/officewebapps.md @@ -1,65 +1,84 @@ --- -Module Name: Office Online Server PowerShell +Module Name: officewebapps Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX title: officewebapps --- +# officewebapps Module -# Office Online Server PowerShell ## Description + The following cmdlet references are for Office Online Server. ## officewebapps Cmdlets + ### [Get-OfficeWebAppsExcelBIServer](Get-OfficeWebAppsExcelBIServer.md) -{{Manually Enter Get-OfficeWebAppsExcelBIServer Description Here}} + +Returns the server ID of the instance of Analysis Services that has been configured as a data model server in Office Online Server. ### [Get-OfficeWebAppsExcelUserDefinedFunction](Get-OfficeWebAppsExcelUserDefinedFunction.md) -{{Manually Enter Get-OfficeWebAppsExcelUserDefinedFunction Description Here}} + +Returns a list of currently configured UDF definitions. ### [Get-OfficeWebAppsFarm](Get-OfficeWebAppsFarm.md) -{{Manually Enter Get-OfficeWebAppsFarm Description Here}} + +Returns details about the OfficeWebAppsFarm object that the current server is a member of. ### [Get-OfficeWebAppsHost](Get-OfficeWebAppsHost.md) -{{Manually Enter Get-OfficeWebAppsHost Description Here}} + +Returns the list of host domains that are on the Allow List for an Office Online Server farm. ### [Get-OfficeWebAppsMachine](Get-OfficeWebAppsMachine.md) -{{Manually Enter Get-OfficeWebAppsMachine Description Here}} + +Returns details about the current server that is in an Office Online Server farm. ### [New-OfficeWebAppsExcelBIServer](New-OfficeWebAppsExcelBIServer.md) -{{Manually Enter New-OfficeWebAppsExcelBIServer Description Here}} + +Configures Analysis Services servers to work with Excel Online. ### [New-OfficeWebAppsExcelUserDefinedFunction](New-OfficeWebAppsExcelUserDefinedFunction.md) -{{Manually Enter New-OfficeWebAppsExcelUserDefinedFunction Description Here}} + +Creates a definition for a UDF binary. ### [New-OfficeWebAppsFarm](New-OfficeWebAppsFarm.md) -{{Manually Enter New-OfficeWebAppsFarm Description Here}} + +Creates a new Office Online Server farm on the local computer. ### [New-OfficeWebAppsHost](New-OfficeWebAppsHost.md) -{{Manually Enter New-OfficeWebAppsHost Description Here}} + +Adds a host domain to the Allow List for an Office Online Server farm. ### [New-OfficeWebAppsMachine](New-OfficeWebAppsMachine.md) -{{Manually Enter New-OfficeWebAppsMachine Description Here}} + +Adds the current server to an existing Office Online Server farm. ### [Remove-OfficeWebAppsExcelBIServer](Remove-OfficeWebAppsExcelBIServer.md) -{{Manually Enter Remove-OfficeWebAppsExcelBIServer Description Here}} + +Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel Online. ### [Remove-OfficeWebAppsExcelUserDefinedFunction](Remove-OfficeWebAppsExcelUserDefinedFunction.md) -{{Manually Enter Remove-OfficeWebAppsExcelUserDefinedFunction Description Here}} + +Removes an existing UDF definition. ### [Remove-OfficeWebAppsHost](Remove-OfficeWebAppsHost.md) -{{Manually Enter Remove-OfficeWebAppsHost Description Here}} + +Removes a host domain from the Allow List for an Office Online Server farm. ### [Remove-OfficeWebAppsMachine](Remove-OfficeWebAppsMachine.md) -{{Manually Enter Remove-OfficeWebAppsMachine Description Here}} + +Removes the current server from the Office Online Server farm. ### [Repair-OfficeWebAppsFarm](Repair-OfficeWebAppsFarm.md) -{{Manually Enter Repair-OfficeWebAppsFarm Description Here}} + +Removes all servers flagged as unhealthy from an Office Online Server farm. ### [Set-OfficeWebAppsExcelUserDefinedFunction](Set-OfficeWebAppsExcelUserDefinedFunction.md) -{{Manually Enter Set-OfficeWebAppsExcelUserDefinedFunction Description Here}} + +Sets properties on existing UDF definitions. ### [Set-OfficeWebAppsFarm](Set-OfficeWebAppsFarm.md) -{{Manually Enter Set-OfficeWebAppsFarm Description Here}} + +Configures the settings of an existing Office Online Server farm. ### [Set-OfficeWebAppsMachine](Set-OfficeWebAppsMachine.md) -{{Manually Enter Set-OfficeWebAppsMachine Description Here}} +Changes the settings of the current server that is in an Office Online Server farm. diff --git a/skype/skype-ps/skype/Add-CsSlaDelegates.md b/skype/skype-ps/SkypeForBusiness/Add-CsSlaDelegates.md similarity index 88% rename from skype/skype-ps/skype/Add-CsSlaDelegates.md rename to skype/skype-ps/SkypeForBusiness/Add-CsSlaDelegates.md index 3700e12bc1..be0cefe134 100644 --- a/skype/skype-ps/skype/Add-CsSlaDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Add-CsSlaDelegates.md @@ -1,13 +1,14 @@ --- -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Add-CsSlaDelegates -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/add-cssladelegates +schema: 2.0.0 +title: Add-CsSlaDelegates --- # Add-CsSlaDelegates @@ -25,17 +26,17 @@ Add-CsSlaDelegates [-Identity] -Delegate [-Confirm] [-Pa ## DESCRIPTION SLA is a feature in Skype for Business (SfB) for handling multiple calls on a specific number called a shared number. SLA can configure any enterprise voice enabled SfB user as a shared number with multiple lines to respond to multiple calls. The calls are not actually received on the shared number, instead they are forwarded to users that act as delegates for the shared number. Any one of the delegates can pick up the call while the rest of the delegates get a notification on their phone about who picked up the call and which line has become busy as a result. Both the number of lines and the delegates are configurable for a shared number in SLA. In addition, advanced options such as BusyOption (what happens in a situation when all lines are busy) and MissedCallOption (the case in which none of the delegates pick up a call) can also be configured for a shared number. -The `Add-CsSlaDelegates` cmdlet provides a way to retrieve a shared number configuration. +The `Add-CsSlaDelegates` cmdlet provides a way to retrieve a shared number configuration. NOTE: Logging in with the account created for the SLA number is not supported. Using the SLA number account with any device or Desktop Client can result in unpredictable behavior. It is not necessary to use that account for the Shared Line Appearance feature to function. -By default, members of the RTCUniversalServerAdmins group are authorized to run the `Add-CsSlaDelegates`. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt: +By default, members of the RTCUniversalServerAdmins group are authorized to run the `Add-CsSlaDelegates`. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt: Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Add-CsSlaDelegates"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Add-CsSlaDelegates -Identity emergency -Delegate sip:delegate_1@contosohealth.com ``` @@ -45,13 +46,15 @@ This example adds a delegate "delegate_1@contosohealth.com" to an SLA configurat ## PARAMETERS ### -Delegate + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies a user that will respond to a call on the shared number specified by the Identity parameter. This parameter requires a valid sip address. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -61,7 +64,10 @@ Accept wildcard characters: False ``` ### -Identity -Indicates the identity of the shared number to which the delegate will be added. + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the identity of the shared number to which the delegate will be added. User identities can be specified using one of five formats: - SIP address: Example. sip:kenmyer@litwareinc.com. @@ -73,8 +79,7 @@ User identities can be specified using one of five formats: ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -83,14 +88,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,14 +106,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Approve-CsDeviceUpdateRule.md similarity index 89% rename from skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md rename to skype/skype-ps/SkypeForBusiness/Approve-CsDeviceUpdateRule.md index e35882d1bb..b85028736b 100644 --- a/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Approve-CsDeviceUpdateRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/approve-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Approve-CsDeviceUpdateRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/approve-csdeviceupdaterule +schema: 2.0.0 +title: Approve-CsDeviceUpdateRule --- # Approve-CsDeviceUpdateRule @@ -52,7 +53,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Approve-CsDeviceUpdateRule"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Approve-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 ``` @@ -60,7 +61,7 @@ Approve-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com The command shown in Example 1 approves the device update rule d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 found on the service WebServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* | Approve-CsDeviceUpdateRule ``` @@ -70,7 +71,7 @@ To do this, the command first calls the `Get-CsDeviceUpdateRule` cmdlet along wi (By definition, these are all the device update rules that have been assigned to the service WebServer:atl-cs-001.litwareinc.com.) This filtered collection is then piped to the `Approve-CsDeviceUpdateRule` cmdlet, which approves each rule in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} | Approve-CsDeviceUpdateRule ``` @@ -83,7 +84,28 @@ The filtered collection is then piped to the `Approve-CsDeviceUpdateRule` cmdlet ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the device update rule being approved. The Identity for a device update rule consists of two parts: the service where the device update rule has been assigned (for example, service:WebServer:atl-cs-001.litwareinc.com) and a globally unique identifier (GUID). Consequently, a device update rule configured for the Redmond site will have an Identity similar to this: service:WebServer:atl-cs-001.litwareinc.com /d5ce3c10-2588-420a-82ac-dc2d9b1222ff9. @@ -91,8 +113,7 @@ Consequently, a device update rule configured for the Redmond site will have an ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -102,13 +123,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,14 +140,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -134,29 +159,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -170,14 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. The `Approve-CsDeviceUpdateRule` cmdlet accepts pipelined instances of the device update rule object. ## OUTPUTS -### -None. +### None Instead, the `Approve-CsDeviceUpdateRule` cmdlet approves instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/Backup-CsPool.md b/skype/skype-ps/SkypeForBusiness/Backup-CsPool.md similarity index 82% rename from skype/skype-ps/skype/Backup-CsPool.md rename to skype/skype-ps/SkypeForBusiness/Backup-CsPool.md index ebbf326a13..fc2172aa7a 100644 --- a/skype/skype-ps/skype/Backup-CsPool.md +++ b/skype/skype-ps/SkypeForBusiness/Backup-CsPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/backup-cspool applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Backup-CsPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/backup-cspool +schema: 2.0.0 +title: Backup-CsPool --- # Backup-CsPool @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the Backup ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Backup-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -47,7 +48,7 @@ Backup-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" The command shown in Example 1 backs up the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Backup-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" -SteadyState ``` @@ -57,26 +58,10 @@ In Example 2, a "steady state" backup is done for the pool atl-cs-001.litwareinc ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool being backed up. -For example: - -`-SourcePoolFqdn "atl-cs-001.litwareinc.com"` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Category -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Category Enables you to select the Skype for Business Server modules that will be backed up; if this parameter is not present then all the modules will be backed up. Allowed values are: @@ -87,8 +72,7 @@ Allowed values are: ```yaml Type: BackupCategory Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,31 +81,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -FailedOverPoolOnly -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` - -### -FailedOverPoolOnly When specified, backup will take place only if the pool is in a failed over state. If you use this parameter then you must also use the FullBackup parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,13 +101,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,14 +119,16 @@ Accept wildcard characters: False ``` ### -FullBackup + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, backup will not begin until the backup service has reached its final state. You cannot use both the FullBackup parameter and the SteadyState parameter in the same command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,13 +138,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the topology information from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,7 +155,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being backed up. +For example: + +`-SourcePoolFqdn "atl-cs-001.litwareinc.com"` + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + File path for the log file created when the cmdlet runs. For example: @@ -192,8 +192,7 @@ By default, reports are written to the AppData\Local\Temp folder in your user pr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,13 +202,15 @@ Accept wildcard characters: False ``` ### -RetryCount + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of times Backup-CsPool will try to call the backup service before failing. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,14 +220,16 @@ Accept wildcard characters: False ``` ### -SteadyState + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, backup will not begin until the backup service has reached a steady state. A "steady state" occurs when the pool switches to read-only or failover/failback mode and no longer produces any new data that needs to be backed up. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,13 +239,33 @@ Accept wildcard characters: False ``` ### -WaitTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Amount of time (in seconds) that the cmdlet will wait before checking to see if the backup service is in either the full state or the steady state. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -252,13 +275,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -272,14 +297,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Backup-CsPool` cmdlet does not accept pipelined data. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateFile.md similarity index 87% rename from skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md rename to skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateFile.md index 4565de64c5..c5123b079c 100644 --- a/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md +++ b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/clear-csdeviceupdatefile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Clear-CsDeviceUpdateFile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/clear-csdeviceupdatefile +schema: 2.0.0 +title: Clear-CsDeviceUpdateFile --- # Clear-CsDeviceUpdateFile @@ -41,7 +42,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Clear-CsDeviceUpdateFile"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Clear-CsDeviceUpdateFile -Identity "service:WebServer:atl-cs-001.litwareinc.com" ``` @@ -51,47 +52,53 @@ The command shown in Example 1 deletes all the device update files from the serv ## PARAMETERS -### -Identity -Unique identifier of the service hosting the device update files. -For example, this syntax clears device update files from the Web Services service for the pool atl-cs-001.litwareinc.com: -Identity "service:WebServer:atl-cs-001.litwareinc.com". +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +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 occur when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the service hosting the device update files. +For example, this syntax clears device update files from the Web Services service for the pool atl-cs-001.litwareinc.com: -Identity "service:WebServer:atl-cs-001.litwareinc.com". ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -100,14 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -121,14 +130,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Clear-CsDeviceUpdateFile` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None + The `Clear-CsDeviceUpdateFile` cmdlet does not return any values. ## NOTES diff --git a/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateLog.md similarity index 86% rename from skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md rename to skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateLog.md index 37114a8907..9fadfc9d99 100644 --- a/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md +++ b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateLog.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/clear-csdeviceupdatelog applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Clear-CsDeviceUpdateLog -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/clear-csdeviceupdatelog +schema: 2.0.0 +title: Clear-CsDeviceUpdateLog --- # Clear-CsDeviceUpdateLog @@ -37,7 +38,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Clear-CsDeviceUpdateLog"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Clear-CsDeviceUpdateLog -Identity "service:WebServer:atl-cs-001.litwareinc.com" -DaysBack 10 ``` @@ -47,24 +48,10 @@ The command shown in Example 1 connects to the Device Update Web service with th ## PARAMETERS -### -Identity -Unique identifier of the service hosting the Device Update Web service log files. -For example, this syntax clears Device Update Web service log files from the Web Services for the pool atl-cs-001.litwareinc.com: -Identity "service:WebServer:atl-cs-001.litwareinc.com". - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DaysBack -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DaysBack Maximum age (in days) of the log files to be maintained. All log files older than the value specified using the DaysBack parameter will be deleted. For example, if you set DaysBack to 7 then any log files more than seven days old will be removed. @@ -74,8 +61,7 @@ This parameter can be set to any integer value between 1 and 30, inclusive. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 3 @@ -85,13 +71,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,30 +88,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the service hosting the Device Update Web service log files. +For example, this syntax clears Device Update Web service log files from the Web Services for the pool atl-cs-001.litwareinc.com: -Identity "service:WebServer:atl-cs-001.litwareinc.com". ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -137,14 +148,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Clear-CsDeviceUpdateLog` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None The `Clear-CsDeviceUpdateLog` cmdlet does not return any values. ## NOTES diff --git a/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Clear-CsPersistentChatRoom.md similarity index 90% rename from skype/skype-ps/skype/Clear-CsPersistentChatRoom.md rename to skype/skype-ps/SkypeForBusiness/Clear-CsPersistentChatRoom.md index e6cc17f0f3..177d0d4e67 100644 --- a/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Clear-CsPersistentChatRoom.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Clear-CsPersistentChatRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/clear-cspersistentchatroom +schema: 2.0.0 +title: Clear-CsPersistentChatRoom --- # Clear-CsPersistentChatRoom @@ -51,7 +52,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Clear ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Clear-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom" -EndDate "3/1/2018" ``` @@ -59,7 +60,7 @@ Clear-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom" -End The command shown in Example removes all the content from the Persistent Chat chat room ITChatRoom that was added to the room on or before March 1, 2018. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatRoom | Clear-CsPersistentChatRoom -EndDate "3/1/2018" -Confirm:$False ``` @@ -73,6 +74,9 @@ Note that, in order to suppress the confirmation prompt which would otherwise ap ## PARAMETERS ### -EndDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates the last date for which content should be removed. For example, if you specify an EndDate of 3/1/2018 (March 1, 2018 in US English) then all the Persistent Chat content added to the room on or before 3/1/2018 will be deleted. @@ -82,8 +86,7 @@ You must specify an EndDate when running the `Clear-CsPersistentChatRoom` cmdlet ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Identity of the chat room whose content is to be removed. For example: @@ -101,8 +107,7 @@ For example: ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -112,13 +117,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: ChatRoom Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -128,6 +135,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. If you set the value of this parameter to False then you will not get a confirmation prompt when you run the cmdlet: @@ -137,7 +147,6 @@ If you set the value of this parameter to False then you will not get a confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -167,13 +178,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.GroupChat.Cmdlets.ChatRoomObject The `Clear-CsPersistentChatRoom` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.GroupChat.Cmdlets.ChatRoomObject object. ## OUTPUTS -### -None. Instead, `Clear-CsPersistentChatRoom` modifies existing instances of the Microsoft.Rtc.Management.GroupChat.Cmdlets.ChatRoomObject object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Convert-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Convert-CsUserData.md similarity index 86% rename from skype/skype-ps/skype/Convert-CsUserData.md rename to skype/skype-ps/SkypeForBusiness/Convert-CsUserData.md index 36e5bfd5b6..64b6cc5e73 100644 --- a/skype/skype-ps/skype/Convert-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Convert-CsUserData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/convert-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Convert-CsUserData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/convert-csuserdata +schema: 2.0.0 +title: Convert-CsUserData --- # Convert-CsUserData @@ -37,7 +38,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Conve ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Convert-CsUserData -InputFile "C:\Logs\Lync2013Data.Zip" -OutputFile "C:\Logs\Lync2010Data.xml" -TargetVersion Lync2010 ``` @@ -46,7 +47,7 @@ The command shown in Example 1 converts the user data stored in the file C:\Logs The converted data is stored in the XML file C:\Logs\Lync2010Data.xml. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Convert-CsUserData -InputFile "C:\Logs\Lync2013Data.Zip" -OutputFile "C:\Logs\Lync2010data.xml" -TargetVersion Lync2010 -UserFilter "kenmyer@litwareinc.com" ``` @@ -57,61 +58,62 @@ This is done by including the UserFilter parameter followed by the user's SIP ad ## PARAMETERS -### -InputFile -Full path to the .ZIP file or .XML file containing the user data to be converted. -For example: +### -ConfDirectoryFilter --InputFile "C:\Data\Lync2010.zip" +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to convert conference directory data. +To do this, include the ConfDirectoryFilter parameter and specify the Identity of the conference directory: + +-ConfDirectoryFilter 13 + +You can retrieve conference directory Identities by using this command: + +Get-CsConferenceDirectory | Select-Object Identity, ServiceId ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutputFile -Full path to the file that will store the converted data. -If you are outputting the data using the Microsoft Lync Server 2010 format then the output file must use a .XML file extension; for example: +### -Force --OutputFile "C:\Data\ConvertedLync2010Data.xml" - -If you are using the Microsoft Lync Server 2013 Preview format, the output file must use a .ZIP file extension: - --OutputFile "C:\Data\ConvertedLyncData.zip" +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetVersion -Indicates the format for the converted data. -Allowed values are: +### -InputFile -- Lync2010 -- Current +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the .ZIP file or .XML file containing the user data to be converted. +For example: + +-InputFile "C:\Data\Lync2010.zip" ```yaml -Type: ConvertTarget +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -120,39 +122,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfDirectoryFilter -Enables you to convert conference directory data. -To do this, include the ConfDirectoryFilter parameter and specify the Identity of the conference directory: +### -OutputFile --ConfDirectoryFilter 13 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can retrieve conference directory Identities by using this command: +Full path to the file that will store the converted data. +If you are outputting the data using the Microsoft Lync Server 2010 format then the output file must use a .XML file extension; for example: + +-OutputFile "C:\Data\ConvertedLync2010Data.xml" + +If you are using the Microsoft Lync Server 2013 Preview format, the output file must use a .ZIP file extension: + +-OutputFile "C:\Data\ConvertedLyncData.zip" -Get-CsConferenceDirectory | Select-Object Identity, ServiceId ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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 occur when running the command. +### -TargetVersion + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the format for the converted data. +Allowed values are: + +- Lync2010 +- Current ```yaml -Type: SwitchParameter +Type: ConvertTarget Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -UserFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to convert data for a single user. That user specified by using his or her SIP address, minus the sip: prefix. For example: @@ -169,8 +183,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,13 +197,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Convert-CsUserData` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Convert-CsUserData` cmdlet creates either XML or ZIP files, depending on whether the converted data is to be used with Lync Server or with Skype for Business Server. ## NOTES diff --git a/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md b/skype/skype-ps/SkypeForBusiness/ConvertTo-JsonForPSWS.md similarity index 92% rename from skype/skype-ps/skype/ConvertTo-JsonForPSWS.md rename to skype/skype-ps/SkypeForBusiness/ConvertTo-JsonForPSWS.md index a337781345..d79e55099a 100644 --- a/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md +++ b/skype/skype-ps/SkypeForBusiness/ConvertTo-JsonForPSWS.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/convertto-jsonforpsws applicable: Skype for Business Online -title: ConvertTo-JsonForPSWS -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/convertto-jsonforpsws +schema: 2.0.0 +title: ConvertTo-JsonForPSWS --- # ConvertTo-JsonForPSWS @@ -28,7 +30,7 @@ You can then use the `ConvertTo-JsonForPSWS` cmdlet to convert a JSON-formatted ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> (Get-UICulture).Calendar | ConvertTo-JsonForPSWS { @@ -46,7 +48,7 @@ PS C:\> (Get-UICulture).Calendar | ConvertTo-JsonForPSWS This command uses the `ConvertTo-JsonForPSWS` cmdlet to convert a GregorianCalendar object to a JSON-formatted string for PowerShell Web Services. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> @{Account="User01";Domain="Domain01";Admin="True"} | ConvertTo-JsonForPSWS -Compress {"Admin":"True","Account":"User01","Domain":"Domain01"} @@ -54,7 +56,7 @@ PS C:\> @{Account="User01";Domain="Domain01";Admin="True"} | ConvertTo-JsonForPS This command shows the effect of using the Compress parameter of `ConvertTo-JsonForPSWS`. The compression affects only the appearance of the string, not its validity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-Date | Select-Object -Property * | ConvertTo-JsonForPSWS { @@ -101,7 +103,7 @@ This command shows how to use the `ConvertTo-JsonForPSWS` cmdlet to convert an o It uses the `ConvertTo-JsonForPSWS` cmdlet to convert a System.DateTime object from the Get-Date cmdlet to a JSON-formatted string for PowerShell Web Services. The command uses the Select-Object cmdlet to get all () of the properties of the **DateTime* object. The output shows the JSON string that `ConvertTo-JsonForPSWS` returned. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> $JsonSecurityHelp = Get-Content $Pshome\Modules\Microsoft.PowerShell.Security\en-US\Microsoft.PowerShell.Security.dll-Help.xml | ConvertTo-JsonForPSWS ``` @@ -111,13 +113,15 @@ This command uses the `ConvertTo-JsonForPSWS` cmdlet to convert a Windows PowerS ## PARAMETERS ### -Compress + +> Applicable: Skype for Business Online + Omits white space and indented formatting in the output string. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -127,13 +131,15 @@ Accept wildcard characters: False ``` ### -Depth + +> Applicable: Skype for Business Online + Specifies how many levels of contained objects are included in the JSON representation. The default value is 2. ```yaml Type: Int Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -143,6 +149,9 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: Skype for Business Online + Specifies the objects to convert to JSON format. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe an object to `ConvertTo-JsonForPSWS`. The InputObject parameter is required, but its value can be null ($Null) or an empty string. When the input object is $Null, `ConvertTo-JsonForPSWS` does not generate any output. When the input object is an empty string, `ConvertTo-JsonForPSWS` returns an empty string. @@ -150,8 +159,7 @@ The InputObject parameter is required, but its value can be null ($Null) or an e ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 0 diff --git a/skype/skype-ps/skype/Copy-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Copy-CsVoicePolicy.md similarity index 80% rename from skype/skype-ps/skype/Copy-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Copy-CsVoicePolicy.md index 2b2f8404d0..5fc590f362 100644 --- a/skype/skype-ps/skype/Copy-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Copy-CsVoicePolicy.md @@ -1,13 +1,15 @@ --- -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 -title: Copy-CsVoicePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/copy-csvoicepolicy +schema: 2.0.0 +title: Copy-CsVoicePolicy --- # Copy-CsVoicePolicy @@ -26,7 +28,7 @@ This cmdlet has been deprecated for use with Lync Server 2013 and Lync Online. A ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> {{ Add example code here }} ``` @@ -36,30 +38,16 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -PolicyName - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -BypassDualWrite -### -Tenant +> Applicable: Skype for Business Online ```yaml -Type: Guid +Type: Object Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -68,11 +56,12 @@ Accept wildcard characters: False ### -Force +> Applicable: Lync Server 2013, Skype for Business Online + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online +Aliases: Required: False Position: Named @@ -83,11 +72,12 @@ Accept wildcard characters: False ### -Identity +> Applicable: Lync Server 2013, Skype for Business Online + ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online +Aliases: Required: False Position: 2 @@ -98,11 +88,12 @@ Accept wildcard characters: False ### -LocalStore +> Applicable: Lync Server 2013, Skype for Business Online + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online +Aliases: Required: False Position: Named @@ -111,15 +102,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassDualWrite +### -PolicyName + +> Applicable: Lync Server 2013, Skype for Business Online ```yaml -Type: Object +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: -Required: False +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Online + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/skype/skype-ps/skype/Debug-CsAddressBookReplication.md b/skype/skype-ps/SkypeForBusiness/Debug-CsAddressBookReplication.md similarity index 87% rename from skype/skype-ps/skype/Debug-CsAddressBookReplication.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsAddressBookReplication.md index 1afa8db7a1..74b1b4802d 100644 --- a/skype/skype-ps/skype/Debug-CsAddressBookReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsAddressBookReplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csaddressbookreplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsAddressBookReplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csaddressbookreplication +schema: 2.0.0 +title: Debug-CsAddressBookReplication --- # Debug-CsAddressBookReplication @@ -39,7 +40,7 @@ The functions carried out by the Debug-CsAddressBookReplication cmdlet are not a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsAddressBookReplication ``` @@ -47,7 +48,7 @@ Debug-CsAddressBookReplication The command shown in Example 1 verifies Address book replication for the current pool. To verify replication for a specified pool, include the PoolFqdn parameter followed by the fully qualified domain name of the pool to be verified. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Debug-CsAddressBookReplication -User "sip:kenmyer@litwareinc.com" ``` @@ -55,14 +56,14 @@ Debug-CsAddressBookReplication -User "sip:kenmyer@litwareinc.com" In Example 2, the User parameter is included when verifying Address book replication for the current pool. When the User parameter is included, additional related information is returned for the specified user. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Debug-CsAddressBookReplication -User "sip:kenmyer@litwareinc.com" -VerifyReplication ``` Example 3 uses the VerifyReplication parameter to make a change to the specified user account and then verify that this change can be successfully replicated to the Address Book. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Debug-CsAddressBookReplication -VerifyNormalization ``` @@ -72,7 +73,31 @@ The command shown in Example 4 uses the VerifyNormalization parameter to return ## PARAMETERS +### -AnalyzeFailures + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When included in a command, Debug-CsAddessBookReplication will return information about any SQL Server stored procedure errors (SprocExecuteErrors) associated with the Address Book. +The returned data includes information about which stored procedure failed; when the procedure failed; and how many times the procedure has failed. +Debug-CsAddressBookReplication will also return the SQL error code and provide the failed SQL statement. +Among other things, that enables you to rerun the statement from within the SQL debugger. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a domain controller to connect to when verifying Address book replication. If this parameter is not included then the cmdlet will use the first available domain controller. @@ -80,7 +105,6 @@ If this parameter is not included then the cmdlet will use the first available d Type: String Parameter Sets: (All) Aliases: DC -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -90,13 +114,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,6 +132,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -127,7 +156,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -137,6 +165,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax @@ -148,7 +179,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -158,14 +188,16 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool being checked. If this parameter is not included then the Debug-CsAddressBookReplication cmdlet will verify the current pool. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,32 +206,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -User -When included, returns detailed replication information for the specified user accounts. -The user account to be verified can be specified by using the user's SIP address, email address, or SamAccountName. +### -StartDate -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Indicates the earliest activity date for the errors returned by the AnalyzeFailures parameter. +For example, if you set the start date to 3/1/2018 (Match 1, 2018, in U.S. +English) any errors prior to that date (for example, errors recorded on February 21, 2018) will be excluded from the returned data. -### -VerifyNormalization -If specified, detailed information will be returned for any user accounts where Address book normalization failed. -Normalization rules are used to convert phone numbers to the E.164 format used by Skype for Business Server. +Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate parameter. ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,15 +228,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VerifyReplication -When specified, the Debug-CsAddressBookReplication cmdlet will modify the specified user account in Active Directory and then verify that the changes are replicated to the Address book. -Note that the user account modification is for testing purposes only, and will not actually change the property values of that account. +### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for which address book replication is being verified. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,17 +253,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AnalyzeFailures -When included in a command, Debug-CsAddessBookReplication will return information about any SQL Server stored procedure errors (SprocExecuteErrors) associated with the Address Book. -The returned data includes information about which stored procedure failed; when the procedure failed; and how many times the procedure has failed. -Debug-CsAddressBookReplication will also return the SQL error code and provide the failed SQL statement. -Among other things, that enables you to rerun the statement from within the SQL debugger. +### -User + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When included, returns detailed replication information for the specified user accounts. +The user account to be verified can be specified by using the user's SIP address, email address, or SamAccountName. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,18 +272,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartDate -Indicates the earliest activity date for the errors returned by the AnalyzeFailures parameter. -For example, if you set the start date to 3/1/2018 (Match 1, 2018, in U.S. -English) any errors prior to that date (for example, errors recorded on February 21, 2018) will be excluded from the returned data. +### -VerifyNormalization -Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate parameter. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If specified, detailed information will be returned for any user accounts where Address book normalization failed. +Normalization rules are used to convert phone numbers to the E.164 format used by Skype for Business Server. ```yaml -Type: DateTime +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,21 +291,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for which address book replication is being verified. -For example: +### -VerifyReplication -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can return the tenant ID for each of your tenants by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` +When specified, the Debug-CsAddressBookReplication cmdlet will modify the specified user account in Active Directory and then verify that the changes are replicated to the Address book. +Note that the user account modification is for testing purposes only, and will not actually change the property values of that account. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,7 +320,7 @@ The Debug-CsAddressBookReplication cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.Activities.Database.AddressBookReplicationTaskOutput The Debug-CsAddressBookReplication cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.Activities.Database.AddressBookReplicationTaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Debug-CsDataConference.md b/skype/skype-ps/SkypeForBusiness/Debug-CsDataConference.md similarity index 87% rename from skype/skype-ps/skype/Debug-CsDataConference.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsDataConference.md index 6db0f9115d..abf65669b9 100644 --- a/skype/skype-ps/skype/Debug-CsDataConference.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsDataConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csdataconference applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsDataConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csdataconference +schema: 2.0.0 +title: Debug-CsDataConference --- # Debug-CsDataConference @@ -26,21 +27,21 @@ The functions carried out by the Debug-CsDataConference cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsDataConference ``` The command shown in Example 1 returns diagnostic information for the Conferencing Server installed on the local computer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Debug-CsDataConference -TargetFqdn "atl-cs-001.litwareinc.com" ``` In Example 2, diagnostic information is returned for the Conferencing Server installed on the remote computer atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Debug-CsDataConference | Select-Object -ExpandProperty Details | Format-List ``` @@ -55,13 +56,15 @@ The Select-Object cmdlet uses the ExpandProperty parameter to return complete in ## PARAMETERS ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any nonfatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -71,16 +74,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\DataConference.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -TargetFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the computer where the Skype for Business Server 2015 Conferencing Server is installed. If this parameter is not included, the Debug-CsDataConference cmdlet will run against the local computer. If Conferencing Server is not installed on the local computer, an error will occur. @@ -97,8 +105,7 @@ If Conferencing Server is not installed on the local computer, an error will occ ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Debug-CsInterPoolReplication.md b/skype/skype-ps/SkypeForBusiness/Debug-CsInterPoolReplication.md similarity index 85% rename from skype/skype-ps/skype/Debug-CsInterPoolReplication.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsInterPoolReplication.md index ebc215436e..9ca4675a41 100644 --- a/skype/skype-ps/skype/Debug-CsInterPoolReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsInterPoolReplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csinterpoolreplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsInterPoolReplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csinterpoolreplication +schema: 2.0.0 +title: Debug-CsInterPoolReplication --- # Debug-CsInterPoolReplication @@ -44,14 +45,14 @@ The functions carried out by the Debug-CsInterPoolReplication cmdlet are not ava ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsInterPoolReplication -PoolFqdn "atl-cs-001.litwareinc.com" ``` The command shown in Example 1 verifies the full replication status between the pool atl-cs-001.litwareinc.com and its previously-assigned backup pool. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Debug-CsInterPoolReplication -PoolFqdn "atl-cs-001.litwareinc.com" -BackupModule DataConf ``` @@ -61,26 +62,10 @@ In Example 2, only the replication of data conferencing data is verified between ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the primary pool being tested. -For example: - -`-PoolFqdn "atl-cs-001.litwareinc.com"` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -BackupModule -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -BackupModule Enables administrators to specify the data store to be verified. Allowed values are: @@ -94,8 +79,7 @@ The default value is All. ```yaml Type: BackupModules Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,14 +88,16 @@ 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. +### -DatabaseCommandTimeoutInSeconds + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: Int32 ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,14 +106,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,16 +124,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabaseCommandTimeoutInSeconds -PARAMVALUE: Int32 +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the primary pool being tested. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: Int32 +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -153,13 +146,15 @@ Accept wildcard characters: False ``` ### -ResyncSignatureMismatchItems + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +164,33 @@ Accept wildcard characters: False ``` ### -SuppressMultiMasterDetection + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When included in the command, Debug-CsInterPoolReplication will not verify whether or not the pool is part of a multi-master replication configuration before beginning its verification checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -185,13 +200,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -210,7 +227,7 @@ Debug-CsInterPoolReplication does not accept pipelined data. ## OUTPUTS -### String +### String ## NOTES diff --git a/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md b/skype/skype-ps/SkypeForBusiness/Debug-CsIntraPoolReplication.md similarity index 87% rename from skype/skype-ps/skype/Debug-CsIntraPoolReplication.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsIntraPoolReplication.md index 5f9eb262df..d2a3c557ff 100644 --- a/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsIntraPoolReplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csintrapoolreplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsIntraPoolReplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csintrapoolreplication +schema: 2.0.0 +title: Debug-CsIntraPoolReplication --- # Debug-CsIntraPoolReplication @@ -55,14 +56,14 @@ The functions carried out by the Debug-CsIntraPoolReplication cmdlet are not ava ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsIntraPoolReplication -UserUri "sip:kenmyer@litwareinc.com" ``` The command shown in Example 1 verifies replication on a Front End server by using the user with the SIP address "sip:kenmyer@litwareinc.com". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser -OU "OU=Redmond,dc=litwareinc,dc=com" | ForEach-Object {Debug-CsIntraPoolReplication $_.Identity} ``` @@ -71,7 +72,7 @@ In Example 2, replication is verified by using all the users who have user accou To do this, the command first calls Get-CsUser along with the OU parameter; the parameter value "OU=Redmond,dc=litwareinc,dc=com" limits the returned data to user accounts found in the Redmond OU. Those accounts are then piped to the ForEach-Object cmdlet which, in turn, uses Debug-CsIntraPoolReplication cmdlet to verify the replication status of each account in the OU. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` "sip:kenmyer@litwareinc.com","sip:pilar@litwareinc.com" | ForEach-Object {Debug-CsIntraPoolReplication -UserUri $_} ``` @@ -79,14 +80,14 @@ Those accounts are then piped to the ForEach-Object cmdlet which, in turn, uses The command shown in Example 3 verifies replication status by using a pair of user SIP addresses. To perform this task, the two SIP addresses (enclosed in quotation marks and separated by using a comma) are piped to the ForEach-Object cmdlet, which then runs the Debug-CsIntraPoolReplication cmdlet against each SIP address.. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Debug-CsIntraPoolReplication -ConferenceDirectory 13 ``` In Example 4, replication is verified for the conference directory with the ID 13. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Debug-CsIntraPoolReplication UserUri {$_.Identity} ``` @@ -99,6 +100,9 @@ Those accounts are then piped to the Debug-CsIntraPoolReplication cmdlet, which ## PARAMETERS ### -ConferenceDirectory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to verify the replication of a conference directory. Conference directories should be specified using the directory Identity; conference directory Identities can be retrieved by using this command: @@ -109,8 +113,7 @@ You cannot use the ConferenceDirectory parameter and the UserUri parameter in th ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: ConferenceDirectory -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -119,35 +122,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -UserUri -SIP address of the user account employed in testing intra-pool replication. -For example: - -`-UserUri sip:kenmyer@litwareinc.com` - -You cannot use the ConferenceDirectory parameter and the UserUri parameter in the same command. +### -Force -```yaml -Type: UserIdParameter -Parameter Sets: User -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, 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 -``` - -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +141,9 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool to be checked. For example: @@ -165,8 +152,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -176,13 +162,15 @@ Accept wildcard characters: False ``` ### -Service + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a particular service to be verified. ```yaml Type: String Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -192,13 +180,15 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When included in the command, shows information about all the services involved in replication. ```yaml Type: SwitchParameter Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,6 +198,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify the type of replication to be verified. Allowed values are: @@ -217,8 +210,7 @@ Allowed values are: ```yaml Type: ServiceEnumerationType Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -227,20 +219,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the user account employed in testing intra-pool replication. +For example: + +`-UserUri sip:kenmyer@litwareinc.com` + +You cannot use the ConferenceDirectory parameter and the UserUri parameter in the same command. + +```yaml +Type: UserIdParameter +Parameter Sets: User +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. + Debug-CsIntraPoolReplication accepts a pipelined string value representing the SIP address or Active Directory display name of a user account that has been enabled for Lync Server. The cmdlet also accepts pipelined instances of the Active Directory user object for a Lync Server-enabled user. ## OUTPUTS -### -Debug-CsIntraPoolReplication returns instances of the Microsoft.Rtc.Management.UserPinservice.Data.syncReplicationDetails object. +### Microsoft.Rtc.Management.UserPinService.Data.SyncReplicationDetails + +Debug-CsIntraPoolReplication returns instances of the Microsoft.Rtc.Management.UserPinService.Data.SyncReplicationDetails object. ## NOTES diff --git a/skype/skype-ps/skype/Debug-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Debug-CsLisConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Debug-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsLisConfiguration.md index 11d2b846e0..f473e54e7e 100644 --- a/skype/skype-ps/skype/Debug-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-cslisconfiguration +schema: 2.0.0 +title: Debug-CsLisConfiguration --- # Debug-CsLisConfiguration @@ -40,7 +41,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsLisConfiguration | Format-Table -Wrap ``` @@ -53,13 +54,15 @@ Therefore, in this example we pipe the output to the Format-Table cmdlet, specif ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +Aliases: Required: False Position: Named @@ -69,14 +72,16 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to specify a domain controller. If no domain controller is specified, the first available will be used. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md b/skype/skype-ps/SkypeForBusiness/Debug-CsStorageServiceFailures.md similarity index 88% rename from skype/skype-ps/skype/Debug-CsStorageServiceFailures.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsStorageServiceFailures.md index 417dd26a22..7779f3ee67 100644 --- a/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsStorageServiceFailures.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csstorageservicefailures applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsStorageServiceFailures -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csstorageservicefailures +schema: 2.0.0 +title: Debug-CsStorageServiceFailures --- # Debug-CsStorageServiceFailures @@ -75,7 +76,7 @@ Other : ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsStorageServiceFailures -SipURI kmyer@contoso.com ``` @@ -84,7 +85,7 @@ This example returns debugging information about storage service failures relati -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Debug-CsStorageServiceFailures -Component ConversationHistory ``` @@ -95,13 +96,15 @@ This example returns debugging information about storage service failures relati ## PARAMETERS ### -AdapterId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the GUID of the data adapter on which to gather the debugging information. ```yaml Type: Guid Parameter Sets: (All) Aliases: g -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -Binding + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the Windows Communication Foundation (WCF) binding. A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. Valid values are: @@ -122,7 +128,6 @@ Valid values are: Type: String Parameter Sets: (All) Aliases: b -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -132,6 +137,9 @@ Accept wildcard characters: False ``` ### -Component + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the storage service component for which debug information will be returned. Acceptable values for the Component parameter are: @@ -148,7 +156,6 @@ Acceptable values for the Component parameter are: Type: Component Parameter Sets: (All) Aliases: c -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -158,6 +165,9 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The EndDate parameter specifies the end date of the date range. Use the short date format defined in the Regional Options settings for the computer on which the command is run. @@ -168,8 +178,7 @@ If you enter the date and time of day, you must enclose the argument in quotatio ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,13 +188,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,6 +206,9 @@ Accept wildcard characters: False ``` ### -HostNameStorageService + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the server where the Skype for Business Storage Service is running. This parameter is required if the Binding parameter is set to NetTCP. @@ -202,7 +216,6 @@ This parameter is required if the Binding parameter is set to NetTCP. Type: String Parameter Sets: (All) Aliases: h -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -212,14 +225,16 @@ Accept wildcard characters: False ``` ### -OutFileName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the full path of where to write a text file containing the debug results. Otherwise, they are written to the console. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,6 +244,9 @@ Accept wildcard characters: False ``` ### -SipUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) of the user on which to collect debug data. This is the SIPAddress property of the user as returned by the Get-CsUser cmdlet. @@ -236,7 +254,6 @@ This is the SIPAddress property of the user as returned by the Get-CsUser cmdlet Type: String Parameter Sets: (All) Aliases: s -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -246,6 +263,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The StartDate parameter specifies the start date of the date range. Use the short date format defined in the Regional Options settings for the computer on which the command is run. @@ -256,8 +276,7 @@ If you enter the date and time of day, you must enclose the argument in quotatio ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md b/skype/skype-ps/SkypeForBusiness/Debug-CsUnifiedContactStore.md similarity index 90% rename from skype/skype-ps/skype/Debug-CsUnifiedContactStore.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsUnifiedContactStore.md index df94000299..a9acc3120d 100644 --- a/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsUnifiedContactStore.md @@ -1,13 +1,14 @@ --- -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsUnifiedContactStore -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csunifiedcontactstore +schema: 2.0.0 +title: Debug-CsUnifiedContactStore --- # Debug-CsUnifiedContactStore @@ -44,14 +45,14 @@ The functions carried out by the Debug-CsUnifiedContactStore cmdlet are not avai ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsUnifiedContactStore -PoolFqdn "atl-cs-001.litwareinc.com" ``` The command shown in Example 1 verifies the unified contact store status for all the users who have accounts homed on the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Debug-CsUnifiedContactStore -Identity "kenmyer@litwareinc.com" ``` @@ -61,85 +62,93 @@ In Example 2, the unified contact store status is verified for a single user: th ## PARAMETERS -### -Identity -SIP address of an individual user whose unified contact store status is being verified. -(You can specify only one user per command.) For example: +### -ContactDataExportFileName -`-Identity "kenmyer@litwareinc.com"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -When specifying the SIP address, the sip: prefix is optional. -This syntax will also work: +File path for the XML file that will contain the contacts for the specified user when those contacts exported from the unified contact store. +For example: -`-Identity "sip:kenmyer@litwareinc.com"` +`-ContactDataExportFileName "C:\Exports\KenMyer.xml"` + +Note that you must include the Identity parameter and the SIP address for the user whose contacts you want to export. +If that user has not been enabled for the unified contact store, the command will terminate and no contacts will be exported. ```yaml -Type: UserIdParameter +Type: String Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolFqdn -Fully qualified domain name of the Registrar pool whose unified contact store status is being verified. -All user accounts homed on the specified pool will be checked. -For example: +### -Force -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any nonfatal error message that might occur when running the command. ```yaml -Type: Fqdn -Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -ContactDataExportFileName -File path for the XML file that will contain the contacts for the specified user when those contacts exported from the unified contact store. -For example: +### -Identity -`-ContactDataExportFileName "C:\Exports\KenMyer.xml"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Note that you must include the Identity parameter and the SIP address for the user whose contacts you want to export. -If that user has not been enabled for the unified contact store, the command will terminate and no contacts will be exported. +SIP address of an individual user whose unified contact store status is being verified. +(You can specify only one user per command.) For example: + +`-Identity "kenmyer@litwareinc.com"` + +When specifying the SIP address, the sip: prefix is optional. +This syntax will also work: + +`-Identity "sip:kenmyer@litwareinc.com"` ```yaml -Type: String +Type: UserIdParameter Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any nonfatal error message that might occur when running the command. +### -PoolFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the Registrar pool whose unified contact store status is being verified. +All user accounts homed on the specified pool will be checked. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: PoolFqdn +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` diff --git a/skype/skype-ps/skype/Disable-CsAdDomain.md b/skype/skype-ps/SkypeForBusiness/Disable-CsAdDomain.md similarity index 83% rename from skype/skype-ps/skype/Disable-CsAdDomain.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsAdDomain.md index 38a11de6d4..5a931440a2 100644 --- a/skype/skype-ps/skype/Disable-CsAdDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsAdDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-csaddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsAdDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-csaddomain +schema: 2.0.0 +title: Disable-CsAdDomain --- # Disable-CsAdDomain @@ -37,7 +38,7 @@ Historical Note: The tasks carried out by Disable-CsAdDomain are similar to the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsAdDomain ``` @@ -45,14 +46,14 @@ Disable-CsAdDomain The command shown in Example 1 rolls back the domain preparation process in the local domain. Because the Force parameter is not included, the command will fail if the Disable-CsAdDomain cmdlet determines that at least one Front End Server, A/V Conferencing Server, or Web Services server is still active in the domain. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Disable-CsAdDomain -Domain asia.litwareinc.com ``` Example 2 rolls back the domain preparation process for the domain asia.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Disable-CsAdDomain -Force ``` @@ -64,14 +65,16 @@ This means that rollback will occur even if the Disable-CsAdDomain cmdlet determ ## PARAMETERS ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the domain where domain preparation should be rolled back (for example, -Domain asia.litwareinc.com). If this parameter is not included, rollback will take place on the local domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -81,14 +84,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to specify the FQDN of the domain controller to be used when running Disable-CsAdDomain. If not specified, 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 +Aliases: Required: False Position: Named @@ -97,15 +102,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -FQDN of a global catalog server in your domain. -This parameter is not required if you are running the Disable-CsAdDomain cmdlet on a computer with an account in your domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present rollback will occur even if the Disable-CsAdDomain cmdlet determines that at least one Front End, conferencing, or Web Services server is still active in the domain. +If not present then the command will fail if a Front End, Conferencing, or Web Services server is still active in the domain. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,16 +121,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a global catalog server in your domain. +This parameter is not required if you are running the Disable-CsAdDomain cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,15 +140,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If present rollback will occur even if the Disable-CsAdDomain cmdlet determines that at least one Front End, conferencing, or Web Services server is still active in the domain. -If not present then the command will fail if a Front End, Conferencing, or Web Services server is still active in the domain. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,16 +161,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\DisableDomain.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -168,14 +181,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -184,14 +199,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Disable-CsAdForest.md b/skype/skype-ps/SkypeForBusiness/Disable-CsAdForest.md similarity index 83% rename from skype/skype-ps/skype/Disable-CsAdForest.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsAdForest.md index c417b7c00c..c8d4d7cb4b 100644 --- a/skype/skype-ps/skype/Disable-CsAdForest.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsAdForest.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-csadforest applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsAdForest -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-csadforest +schema: 2.0.0 +title: Disable-CsAdForest --- # Disable-CsAdForest @@ -40,7 +41,7 @@ Historical Note: The tasks carried out by Disable-CsAdForest are similar to the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsAdForest ``` @@ -49,7 +50,7 @@ The command shown in Example 1 rolls back the forest preparation tasks carried o Because the Force parameter is not included, the command will fail if the Disable-CsAdForest cmdlet detects that at least one of the domains in the forest is still prepared for Skype for Business Server. In that case, you will need to rolls back the domain preparation by running the Disable-CsAdDomain cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Disable-CsAdForest -Force ``` @@ -60,15 +61,17 @@ Rollback is forced by including the Force parameter. ## PARAMETERS -### -GroupDomain -Fully qualified domain name (FQDN) of the domain where the Skype for Business Server universal groups were created (for example, -GroupDomain asia.litwareinc.com). -If this parameter is not included, the Disable-CsAdForest cmdlet will look for the universal groups in the local domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, forces the rollback of the forest preparation steps even if the Disable-CsAdForest cmdlet detects that at least one of the domains in the forest is still prepared for Skype for Business Server. +If not present, the command will fail if the Disable-CsAdForest cmdlet detects that at least one of the domains in the forest is still prepared for. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -77,14 +80,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GroupDomainController -FQDN of a domain controller where universal group information is stored. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a global catalog server in your domain. +This parameter is not required if you are running the Disable-CsComputer cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -93,15 +99,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -FQDN of a global catalog server in your domain. -This parameter is not required if you are running the Disable-CsComputer cmdlet on a computer with an account in your domain. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,16 +119,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -GroupDomain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the domain where the Skype for Business Server universal groups were created (for example, -GroupDomain asia.litwareinc.com). +If this parameter is not included, the Disable-CsAdForest cmdlet will look for the universal groups in the local domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,14 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RootDomainController -FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. +### -GroupDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where universal group information is stored. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,16 +157,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\DisableForest.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,15 +177,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If present, forces the rollback of the forest preparation steps even if the Disable-CsAdForest cmdlet detects that at least one of the domains in the forest is still prepared for Skype for Business Server. -If not present, the command will fail if the Disable-CsAdForest cmdlet detects that at least one of the domains in the forest is still prepared for. +### -RootDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,14 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -196,14 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Disable-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Disable-CsComputer.md similarity index 82% rename from skype/skype-ps/skype/Disable-CsComputer.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsComputer.md index d6b985bdfd..277d5a7707 100644 --- a/skype/skype-ps/skype/Disable-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-cscomputer +schema: 2.0.0 +title: Disable-CsComputer --- # Disable-CsComputer @@ -36,14 +37,14 @@ You must be a local administrator and a member of the domain in order to run the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsComputer ``` The command shown in Example 1 disables the local computer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Disable-CsComputer -Report C:\Logs\Disable.html ``` @@ -55,14 +56,16 @@ This log file is generated by adding the Report parameter followed by the path t ## PARAMETERS -### -Scorch -Uninstalls all Skype for Business Server services and server roles for the local computer. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -72,14 +75,16 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Disable-CsComputer cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,17 +93,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -GlobalSettingsDomainController -`-Report "C:\Logs\DisableComputer.html"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,14 +113,19 @@ 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. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\DisableComputer.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,14 +134,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Scorch + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Uninstalls all Skype for Business Server services and server roles for the local computer. ```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 +Aliases: Required: False Position: Named @@ -140,13 +153,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -155,16 +170,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -182,7 +197,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### None +### None Instead, Disable-CsComputer disables instances of the Microsoft.Rtc.Management.Deploy.Internal.Machine object. diff --git a/skype/skype-ps/skype/Disable-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Disable-CsHostingProvider.md similarity index 89% rename from skype/skype-ps/skype/Disable-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsHostingProvider.md index ed00fbdde6..ebf471ca69 100644 --- a/skype/skype-ps/skype/Disable-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsHostingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsHostingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-cshostingprovider +schema: 2.0.0 +title: Disable-CsHostingProvider --- # Disable-CsHostingProvider @@ -62,7 +63,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsHostingProvider -Identity "Fabrikam.com" ``` @@ -70,7 +71,7 @@ Disable-CsHostingProvider -Identity "Fabrikam.com" The command shown in Example 1 disables the hosting provider Fabrikam.com. Note that this command will return an error message if Fabrikam.com is already disabled. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHostingProvider | Where-Object {$_.Enabled -eq $True} | Disable-CsHostingProvider ``` @@ -80,7 +81,7 @@ To do this, the command first calls the Get-CsHostingProvider cmdlet to return a That collection is then piped to the Where-Object cmdlet, which picks out only those providers where the Enabled property is equal to True. The filtered collection is then piped to the Disable-CsHostingProvider cmdlet, which disables each provider in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHostingProvider | Where-Object {$_.VerificationLevel -ne "AlwaysVerifiable" -and $_.Enabled -eq $True} | Disable-CsHostingProvider ``` @@ -93,15 +94,35 @@ The filtered collection is then piped to the Disable-CsHostingProvider cmdlet, w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the hosting provider to be disabled. The Identity might be the fully qualified domain (FQDN) name of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -111,13 +132,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,14 +149,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -143,29 +168,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -179,7 +190,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider The Disable-CsHostingProvider cmdlet accepts pipelined instances of the hosting provider object. ## OUTPUTS diff --git a/skype/skype-ps/skype/Disable-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Disable-CsMeetingRoom.md similarity index 88% rename from skype/skype-ps/skype/Disable-CsMeetingRoom.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsMeetingRoom.md index 15cd889743..d201290f22 100644 --- a/skype/skype-ps/skype/Disable-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsMeetingRoom.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Disable-CsMeetingRoom -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-csmeetingroom +schema: 2.0.0 +title: Disable-CsMeetingRoom --- # Disable-CsMeetingRoom @@ -52,14 +54,14 @@ The functions carried out by the Disable-CsMeetingRoom cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsMeetingRoom -Identity "sip:RedmondMeetingRoom@litwareinc.com" ``` The command shown in Example 1 disables the meeting room sip:RedmondMeetingRoom@litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingRoom | Disable-CsMeetingRoom ``` @@ -71,7 +73,29 @@ That collection is then piped to the Disable-CsMeetingRoom cmdlet, which disable ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to disable a meeting room. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be configured as a meeting room. Identities are typically 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). @@ -83,8 +107,7 @@ For example, the Identity "* Smith" returns all the user who have a display name ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -93,14 +116,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a meeting room object through the pipeline that represents the meeting room being disabled. +By default, the Disable-CsMeetingRoom cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,32 +135,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to disable a meeting room. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -PassThru -Enables you to pass a meeting room object through the pipeline that represents the meeting room being disabled. -By default, the Disable-CsMeetingRoom cmdlet does not pass objects through the pipeline. +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -144,13 +154,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -164,7 +176,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom ### Microsoft.Rtc.Management.AD.UserIdParameter diff --git a/skype/skype-ps/skype/Disable-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Disable-CsPublicProvider.md similarity index 90% rename from skype/skype-ps/skype/Disable-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsPublicProvider.md index 7fe6d0507f..1156385343 100644 --- a/skype/skype-ps/skype/Disable-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-cspublicprovider +schema: 2.0.0 +title: Disable-CsPublicProvider --- # Disable-CsPublicProvider @@ -55,7 +56,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsPublicProvider -Identity "Skype" ``` @@ -63,7 +64,7 @@ Disable-CsPublicProvider -Identity "Skype" Example 1 disables the public provider with the Identity Skype. This command will return an error if Skype is already disabled. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPublicProvider | Where-Object {$_.Enabled -eq $True} | Disable-CsPublicProvider ``` @@ -73,7 +74,7 @@ To do this, the command first uses the Get-CsPublicProvider cmdlet to return a c This collection is piped to the Where-Object cmdlet, which picks out only those providers where the Enabled property is equal to True. In turn, this filtered collection is piped to the Disable-CsPublicProvider cmdlet, which disables each provider in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPublicProvider | Where-Object {$_.VerificationLevel -ne "AlwaysVerifiable" -and $_.Enabled -eq $True} | Disable-CsPublicProvider ``` @@ -86,15 +87,35 @@ This collection is then piped to the Where-Object cmdlet, which selects the prov ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the public provider to be disabled. The Identity is typically the name of the website providing the services. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -104,13 +125,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,14 +142,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -136,29 +161,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Disable-CsUser.md b/skype/skype-ps/SkypeForBusiness/Disable-CsUser.md similarity index 89% rename from skype/skype-ps/skype/Disable-CsUser.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsUser.md index df9affeaa4..df508074fa 100644 --- a/skype/skype-ps/skype/Disable-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-csuser +schema: 2.0.0 +title: Disable-CsUser --- # Disable-CsUser @@ -48,7 +49,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsUser -Identity "Ken Myer" ``` @@ -56,7 +57,7 @@ Disable-CsUser -Identity "Ken Myer" Example 1 disables the Skype for Business Server account for the user Ken Myer. In this example, the user's display name is used to indicate his Identity. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser -LdapFilter "Department=Finance" | Disable-CsUser ``` @@ -65,7 +66,7 @@ In Example 2, all the users in the Finance department have their Skype for Busin To carry out this task, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who belong to the Finance department. That collection is then piped to the Disable-CsUser cmdlet, which disables each account in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -UnassignedUser | Disable-CsUser ``` @@ -78,7 +79,29 @@ That collection is then piped to the Disable-CsUser cmdlet, which disables each ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to disable a user account. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be disabled. 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). You can also reference a user account by using the Active Directory distinguished name. @@ -89,8 +112,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -99,32 +121,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to disable a user account. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). +### -PassThru -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -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 disabled. By default, the Disable-CsUser cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 diff --git a/skype/skype-ps/skype/Enable-CsAdDomain.md b/skype/skype-ps/SkypeForBusiness/Enable-CsAdDomain.md similarity index 82% rename from skype/skype-ps/skype/Enable-CsAdDomain.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsAdDomain.md index c23a8ddc5c..c9f91d501f 100644 --- a/skype/skype-ps/skype/Enable-CsAdDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsAdDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-csaddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsAdDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-csaddomain +schema: 2.0.0 +title: Enable-CsAdDomain --- # Enable-CsAdDomain @@ -42,14 +43,14 @@ Historical Note: This cmdlet carries out tasks similar to those carried out by t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsAdDomain ``` The command shown in Example 1 prepares the local domain for the installation of Skype for Business Server. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Enable-CsAdDomain -Domain asia.litwareinc.com ``` @@ -59,15 +60,17 @@ Example 2 prepares the domain asia.litwareinc.com for the installation of Skype ## PARAMETERS -### -Domain -Fully qualified domain name (FQDN) of the domain where domain preparation is to take place (for example, -Domain asia.litwareinc.com). -If this parameter is not included, domain preparation will take place on the local domain. +### -CrossForest + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, indicates that domain preparation is taking place in a domain in a different forest. +This parameter is not required if the domain being enabled is in the same forest as the computer where the command is being run. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -76,15 +79,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables administrators to specify the FQDN of the domain controller to be used when running the Enable-CsAdDomain cmdlet. -If not specified, the cmdlet will use the first available domain controller. +### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the domain where domain preparation is to take place (for example, -Domain asia.litwareinc.com). +If this parameter is not included, domain preparation will take place on the local domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -93,14 +98,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipPrepareCheck -If set to True ($True), then the Enable-CsAdDomain cmdlet will skip its initial preparation check. +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to specify the FQDN of the domain controller to be used when running the Enable-CsAdDomain cmdlet. +If not specified, the cmdlet will use the first available domain controller. ```yaml -Type: Boolean +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,15 +117,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CrossForest -If present, indicates that domain preparation is taking place in a domain in a different forest. -This parameter is not required if the domain being enabled is in the same forest as the computer where the command is being run. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,14 +136,16 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a global catalog server in your domain. This parameter is not required if you are running the Enable-CsAdDomain cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +155,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container then any domain controller can be used and this parameter can be omitted. @@ -151,8 +165,7 @@ If global settings are stored in the Configuration container then any domain con ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,14 +174,19 @@ 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. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\DomainPrep.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,17 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -SkipPrepareCheck -`-Report "C:\Logs\DomainPrep.html"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True ($True), then the Enable-CsAdDomain cmdlet will skip its initial preparation check. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,14 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -212,14 +231,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsAdForest.md b/skype/skype-ps/SkypeForBusiness/Enable-CsAdForest.md similarity index 82% rename from skype/skype-ps/skype/Enable-CsAdForest.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsAdForest.md index 0ef2979fe9..fd7f390b90 100644 --- a/skype/skype-ps/skype/Enable-CsAdForest.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsAdForest.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-csadforest applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsAdForest -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-csadforest +schema: 2.0.0 +title: Enable-CsAdForest --- # Enable-CsAdForest @@ -43,7 +44,7 @@ Historical Note: This cmdlet carries out tasks similar to those carried out by t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsAdForest ``` @@ -51,7 +52,7 @@ Enable-CsAdForest This command prepares the Active Directory forest for the installation of Skype for Business Server. Because the GroupDomain parameter is not used, the universal security groups generated when you run the Enable-CsAdForest cmdlet will be created in the local domain. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Enable-CsAdForest -GroupDomain northamerica.litwareinc.com ``` @@ -62,31 +63,16 @@ The GroupDomain parameter is used to ensure that the universal security groups c ## PARAMETERS -### -GroupDomain -Fully qualified domain name (FQDN) of the domain where the new universal security groups should be created. -If this parameter is not included, then the groups will be created in the local domain. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -GroupDomainController -FQDN of a domain controller where universal group information is stored. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +82,16 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a global catalog server in your domain. This parameter is not required if you are running the Enable-CsAdForest cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +101,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -120,8 +111,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,14 +120,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RootDomainController -FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. +### -GroupDomain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the domain where the new universal security groups should be created. +If this parameter is not included, then the groups will be created in the local domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,14 +139,16 @@ 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. +### -GroupDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where universal group information is stored. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,16 +158,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\ForestPrep.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,14 +178,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -RootDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipPrepareCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), causes Enable-CsAdForest to run without first doing its initial preparation checks. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -198,13 +215,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -213,14 +232,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipPrepareCheck -When set to True ($True), causes Enable-CsAdForest to run without first doing its initial preparation checks. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Enable-CsComputer.md similarity index 83% rename from skype/skype-ps/skype/Enable-CsComputer.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsComputer.md index 7d94d1d9aa..b55aa2ea20 100644 --- a/skype/skype-ps/skype/Enable-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-cscomputer +schema: 2.0.0 +title: Enable-CsComputer --- # Enable-CsComputer @@ -33,14 +34,14 @@ You must be a local administrator and a member of the domain in order to run the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsComputer ``` The command shown in Example 1 activates any new Skype for Business Server services or server roles that have been installed on the local computer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Enable-CsComputer -Verbose ``` @@ -51,15 +52,16 @@ In this case, however, the addition of the Verbose parameter ensures that a step ## PARAMETERS -### -GlobalCatalog -Fully qualified domain name (FQDN) of a global catalog server in your domain. -This parameter is not required if you are running the Enable-CsComputer cmdlet on a computer with an account in your domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -68,17 +70,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -GlobalCatalog -`-Report "C:\Logs\EnableComputer.html"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of a global catalog server in your domain. +This parameter is not required if you are running the Enable-CsComputer cmdlet on a computer with an account in your domain. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -87,14 +89,18 @@ 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. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,14 +109,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\EnableComputer.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,13 +131,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -135,16 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Enable-CsHostingProvider.md similarity index 90% rename from skype/skype-ps/skype/Enable-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsHostingProvider.md index 13691b8524..d58604c9b6 100644 --- a/skype/skype-ps/skype/Enable-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsHostingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsHostingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-cshostingprovider +schema: 2.0.0 +title: Enable-CsHostingProvider --- # Enable-CsHostingProvider @@ -60,7 +61,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsHostingProvider -Identity Fabrikam.com ``` @@ -68,7 +69,7 @@ Enable-CsHostingProvider -Identity Fabrikam.com In Example 1, the hosting provider with the Identity Fabrikam.com is enabled for use. Note that this command will return an error if Fabrikam.com has already been enabled for use. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHostingProvider | Where-Object {$_.Enabled -eq $False} | Enable-CsHostingProvider ``` @@ -78,7 +79,7 @@ To do this, the command first calls the Get-CsHostingProvider cmdlet without any This collection is then piped to the Where-Object cmdlet, which selects any provider where the Enabled property is equal to False; by definition, that is any provider that is currently disabled. This filtered collection is then piped to the Enable-CsHostingProvider cmdlet, which enables each of the providers in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHostingProvider | Where-Object {$_.EnabledSharedAddressSpace -eq $True -and $_.Enabled -eq $False} | Enable-CsHostingProvider ``` @@ -91,15 +92,35 @@ After that, the filtered collection is piped to the Enable-CsHostingProvider cmd ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the hosting provider to be enabled. The Identity is might be the fully qualified domain name (FQDN) of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -109,13 +130,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,14 +147,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -141,29 +166,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Enable-CsMeetingRoom.md similarity index 87% rename from skype/skype-ps/skype/Enable-CsMeetingRoom.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsMeetingRoom.md index c823fe60ad..d3b3d2bc3c 100644 --- a/skype/skype-ps/skype/Enable-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsMeetingRoom.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Enable-CsMeetingRoom -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-csmeetingroom +schema: 2.0.0 +title: Enable-CsMeetingRoom --- # Enable-CsMeetingRoom @@ -58,7 +60,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsMeetingRoom -Identity "Redmond Meeting room" -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddress "sip:RedmondMeetingRoom@litwareinc.com" ``` @@ -66,7 +68,7 @@ Enable-CsMeetingRoom -Identity "Redmond Meeting room" -RegistrarPool "atl-cs-001 The command shown in Example 1 enables the meeting room that has the Identity (in this case, the Active Directory display name) Redmond Meeting room. The new meeting room is homed on the Registrar pool arl-cs-001.litwareinc.com and given the SIP address sip:RedmondMeetingRoom@litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdUser -OU "OU=MeetingRooms,dc=litwareinc,dc=com" | Enable-CsMeetingRoom -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddressType "SamAccountName" -SipDomain "litwareinc.com" ``` @@ -79,36 +81,17 @@ Each new meeting rooms will be home on the Registrar pool atl-cs-001.litwareinc. ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be configured as a meeting room. -Identities are typically 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\room14); and, 4) the user's Active Directory display name (for example, Room 14). - -You can also reference a user account 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 user who have a display name that ends with the string value " Smith". +### -DomainController -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -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 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 -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. +Enables you to connect to the specified domain controller in order to enable a meeting room. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,15 +100,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to enable a meeting room. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). +### -HostingProviderProxyFqdn + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the hosting provider proxy server. +This parameter is used only with Skype for Business Online. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: HostingProvider Required: False Position: Named @@ -134,24 +119,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostingProviderProxyFqdn -Fully qualified domain name of the hosting provider proxy server. -This parameter is used only with Skype for Business Online. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be configured as a meeting room. +Identities are typically 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\room14); and, 4) the user's Active Directory display name (for example, Room 14). + +You can also reference a user account 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 user who have a display name that ends with the string value " Smith". ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: HostingProvider -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -OriginatorSid + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Value of the msRTCSIP-OriginatorSID attribute. This Active Directory attribute is used to enable single sign-on. This parameter is used only with Skype for Business Online. @@ -159,8 +154,7 @@ This parameter is used only with Skype for Business Online. ```yaml Type: SecurityIdentifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +164,16 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a meeting room object through the pipeline that represents the meeting room being enabled for Skype for Business Server. By default, the Enable-CsMeetingRoom cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,14 +183,16 @@ Accept wildcard characters: False ``` ### -ProxyPool + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Proxy pool name. This parameter is used only with Skype for Business Online. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,13 +202,15 @@ Accept wildcard characters: False ``` ### -RegistrarPool + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Registrar pool where the meeting room's Skype for Business Server 2015 account will be homed. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,6 +220,9 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to assign the meeting room a specific SIP address. When specifying the SIP address, preface the address with "sip:". That means the value supplied to the SipAddress parameter should look something like this: @@ -234,8 +237,7 @@ Instead, you must auto-generate SIP address for those rooms by using the SipAddr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,6 +247,9 @@ Accept wildcard characters: False ``` ### -SipAddressType + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Instructs Skype for Business Server to auto-generate a SIP address for the new meeting room. In order to have Skype for Business Server auto-generate the SIP address, you must include the SipAddressType parameter and use one of the following parameter values: @@ -252,7 +257,7 @@ In order to have Skype for Business Server auto-generate the SIP address, you mu For example, the user Room 14 would have a SIP address similar to this: Room.14@litwareinc.com. If you use this address type then you must also include the SipDomain parameter. -- EmailAddress: The user's email address (as defined in Active Directory) is used as the SIP address.UserPrincipalName. +- EmailAddress: The user's email address (as defined in Active Directory) is used as the SIP address.UserPrincipalName. The user's UPN is used as the SIP address. - SamAccountName: The SIP address is the user's SamAccountName (logon name) followed by the SIP domain. @@ -264,8 +269,7 @@ The SipAddressType parameter is not required if you use the SIPAddress parameter ```yaml Type: AddressType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +279,9 @@ Accept wildcard characters: False ``` ### -SipDomain + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The SIP domain for the meeting room being enabled. This parameter is required if you use the SIPAddressType parameter to have Skype for Business Server auto-generate a SIP address for the user and you based SIP addresses on the SamAccountName or the user's first name and last name. This parameter is not required if you base SIP addresses on the user's email address or UPN; that's because the domain name is already included in those attribute values. @@ -282,8 +289,25 @@ This parameter is not required if you base SIP addresses on the user's email add ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -293,13 +317,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Enable-CsPublicProvider.md similarity index 88% rename from skype/skype-ps/skype/Enable-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsPublicProvider.md index e94296ea51..2c7d284b10 100644 --- a/skype/skype-ps/skype/Enable-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-cspublicprovider +schema: 2.0.0 +title: Enable-CsPublicProvider --- # Enable-CsPublicProvider @@ -50,7 +51,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsPublicProvider -Identity "Skype" ``` @@ -58,7 +59,7 @@ Enable-CsPublicProvider -Identity "Skype" The command shown in Example 1 enables the public provider with the Identity Skype. This command will return an error if Skype is already enabled. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPublicProvider | Where-Object {$_.Enabled -eq $False} | Enable-CsPublicProvider ``` @@ -68,7 +69,7 @@ In order to carry out this task, the command first uses the Get-CsPublicProvider That collection is piped to the Where-Object cmdlet, which selects only those providers where the Enabled property is equal to False. The filtered collection is then piped to the Enable-CsPublicProvider cmdlet, which enables each provider in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPublicProvider | Where-Object {$_.VerificationLevel -eq "AlwaysVerifiable" -and $_.Enabled -eq $False} | Enable-CsPublicProvider ``` @@ -81,15 +82,35 @@ This collection is piped to the Where-Object cmdlet, which picks out those provi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the public provider to be enabled. The Identity is typically the name of the website providing the services (for example, Yahoo!; AOL; and MSN). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -99,13 +120,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,14 +137,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -131,29 +156,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -168,7 +179,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider The Enable-CsPublicProvider cmdlet accepts pipelined instances of the public provider object. diff --git a/skype/skype-ps/skype/Enable-CsReplica.md b/skype/skype-ps/SkypeForBusiness/Enable-CsReplica.md similarity index 82% rename from skype/skype-ps/skype/Enable-CsReplica.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsReplica.md index 9b9ffe4c9e..821da9b2b4 100644 --- a/skype/skype-ps/skype/Enable-CsReplica.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsReplica.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-csreplica applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsReplica -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-csreplica +schema: 2.0.0 +title: Enable-CsReplica --- # Enable-CsReplica @@ -33,7 +34,7 @@ Instead, this will automatically take place when you install Skype for Business ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 1 (Skype for Business Server 2015) ``` Enable-CsReplica ``` @@ -43,15 +44,16 @@ The command shown in Example 1 adds the local computer to the Skype for Business ## PARAMETERS -### -GlobalCatalog -Fully qualified domain name (FQDN) of a global catalog server in your domain. -This parameter is not required if you are running the Enable-CsReplica cmdlet on a computer with an account in your domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -60,17 +62,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -GlobalCatalog -`-Report "C:\Logs\EnableReplica.html"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of a global catalog server in your domain. +This parameter is not required if you are running the Enable-CsReplica cmdlet on a computer with an account in your domain. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,14 +81,18 @@ 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. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -95,14 +101,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\EnableReplica.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,13 +123,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -127,16 +140,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Enable-CsTopology.md similarity index 88% rename from skype/skype-ps/skype/Enable-CsTopology.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsTopology.md index 6ea479e1df..058dc996bb 100644 --- a/skype/skype-ps/skype/Enable-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsTopology.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsTopology -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-cstopology +schema: 2.0.0 +title: Enable-CsTopology --- # Enable-CsTopology @@ -59,7 +60,7 @@ To verify that setup permissions have been delegated, run the Test-CsSetupPermis ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsTopology ``` @@ -69,15 +70,16 @@ The command shown in Example 1 enables the most recently published topology. ## PARAMETERS -### -GlobalCatalog -Fully qualified domain name (FQDN) of a global catalog server in your domain. -This parameter is not required if you are running the Enable-CsTopology cmdlet on a computer with an account in your domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,16 +88,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of a global catalog server in your domain. +This parameter is not required if you are running the Enable-CsTopology cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,14 +107,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipPrepareCheck -If set to True ($True) the Enable-CsTopology cmdlet will skip its initial preparation check. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: Boolean +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,16 +128,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\Enable_Topology.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +148,16 @@ 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. +### -SkipPrepareCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True ($True) the Enable-CsTopology cmdlet will skip its initial preparation check. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,14 +166,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -171,14 +184,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsUser.md b/skype/skype-ps/SkypeForBusiness/Enable-CsUser.md similarity index 88% rename from skype/skype-ps/skype/Enable-CsUser.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsUser.md index edbb4b7306..ae74f423eb 100644 --- a/skype/skype-ps/skype/Enable-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-csuser +schema: 2.0.0 +title: Enable-CsUser --- # Enable-CsUser @@ -40,7 +41,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsUser -Identity "Pilar Ackerman" -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddressType SamAccountName -SipDomain litwareinc.com ``` @@ -48,7 +49,7 @@ Enable-CsUser -Identity "Pilar Ackerman" -RegistrarPool "atl-cs-001.litwareinc.c In Example 1, the Enable-CsUser cmdlet enables the user account with the display name Pilar Ackerman. In this example, the user is assigned to the Registrar pool atl-cs-001.litwareinc.com, and Skype for Business Server auto-generates the SIP address by using the user's SamAccountName (pilar) followed by the SIP domain litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Enable-CsUser -Identity "Pilar Ackerman" -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddress "sip:pilar@litwareinc.com" ``` @@ -57,7 +58,7 @@ In Example 2, the Active Directory user account belonging to Pilar Ackerman is e In order to configure the account for Skype for Business Server the following parameters are used along with the Enable-CsUser cmdlet: Identity, which identifies the account to be enabled; RegistrarPool, which indicates the Standard Edition server or Enterprise Edition Front End pool on which the user is to be homed; and SipAddress, which specifies the SIP address for the new user. In this case, the SIP address is explicitly assigned instead of using Skype for Business Server to auto-generate the address. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdUser -LdapFilter "department=Finance" | Enable-CsUser -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddressType SamAccountName -SipDomain litwareinc.com ``` @@ -73,7 +74,7 @@ Instead, two parameters, SipAddressType and SipDomain, are added to the command. That means that a new SIP address consisting of the user's SamAccountName and the SIP domain name will automatically be generated for each account. For example, a user with the SamAccountName kenmyer will be given the SIP address sip:kenmyer@litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAdUser -Filter {Enabled -ne $True} | Enable-CsUser -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddressType SamAccountName -SipDomain litwareinc.com ``` @@ -83,7 +84,7 @@ To do this, the Get-CsAdUser cmdlet is invoked, along with the Filter parameter. The filter {Enabled -ne $True} returns a collection of all the users who have not been enabled for Skype for Business Server. That collection is then piped to the Enable-CsUser cmdlet, which enables each account, assigning the user to the Registrar pool atl-cs-001.litwareinc.com and auto-generating a SIP address for each user. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Enable-CsUser -Identity user@litwareinc.com -HostingProvider sipfed.online.lync.com -SipAddressType UserPrincipalName ``` @@ -93,7 +94,48 @@ Example 5 populates an existing Active Directory user in on-premises Skype for B ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to enable a user account. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostingProviderProxyFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is used only for Skype for Business Online. +It should not be used with an on-premises implementation of Skype for Business Server. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: HostingProvider + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be enabled for Skype for Business Server. 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). You can also reference a user account by using the user's Active Directory distinguished name. @@ -104,8 +146,7 @@ For example, the Identity "* Smith" returns all the user who have a display name ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -114,14 +155,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -RegistrarPool -Indicates the Registrar pool where the user's Skype for Business Server 2015 account will be homed. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being enabled for Skype for Business Server. +By default, the Enable-CsUser cmdlet does not pass objects through the pipeline. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,26 +174,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddressType -Instructs Skype for Business Server 2015 to auto-generate a SIP address for the new user. -In order to have Skype for Business Server 2015 auto-generate the SIP address, you must include the SipAddressType parameter and use one of the following parameter values: +### -ProxyPool -- FirstLastName: The SIP address is the user's first name and a period followed by the user's last name and the SIP domain. -For example, the user Ken Myer would have a SIP address similar to this: Ken.Myer@litwareinc.com. -If you use this address type then you must also include the SipDomain parameter. -- EmailAddress: The user's email address (as defined in Active Directory) is used as the SIP address. -- UserPrincipalName: The user's UPN is used as the SIP address. -- SamAccountName: The SIP address is the user's SamAccountName (logon name) followed by the SIP domain. -For example, the user with the SamAccountName kmyer will have a SIP address similar to this: kmyer@litwareinc.com. -If you use this address type then you must also include the SipDomain parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The SipAddressType parameter is not required if you use the SipAddress parameter and explicitly assign the user a SIP address. +This parameter is used only for Skype for Business Online. +It should not be used with an on-premises implementation of Skype for Business Online. ```yaml -Type: AddressType +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,16 +193,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipDomain -The SIP domain for the user account being enabled. -This parameter is required if you use the SipAddressType parameter to have Skype for Business Server auto-generate a SIP address for the user and you based SIP addresses on the SamAccountName or the user's first name and last name. -This parameter is not required if you base SIP addresses on the user's email address or UPN; that's because the domain name is already included in those attribute values. +### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Registrar pool where the user's Skype for Business Server 2015 account will be homed. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,6 +212,9 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to assign the user a specific SIP address. When specifying the SIP address, preface the address with "sip:". That means the value supplied to the SipAddress parameter should look something like this: @@ -191,8 +229,7 @@ Instead, you must auto-generate SIP address for those users by using the SipAddr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,32 +238,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostingProviderProxyFqdn -This parameter is used only for Skype for Business Online. -It should not be used with an on-premises implementation of Skype for Business Server. +### -SipAddressType -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: HostingProvider -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Instructs Skype for Business Server 2015 to auto-generate a SIP address for the new user. +In order to have Skype for Business Server 2015 auto-generate the SIP address, you must include the SipAddressType parameter and use one of the following parameter values: -### -ProxyPool -This parameter is used only for Skype for Business Online. -It should not be used with an on-premises implementation of Skype for Business Online. +- FirstLastName: The SIP address is the user's first name and a period followed by the user's last name and the SIP domain. +For example, the user Ken Myer would have a SIP address similar to this: Ken.Myer@litwareinc.com. +If you use this address type then you must also include the SipDomain parameter. +- EmailAddress: The user's email address (as defined in Active Directory) is used as the SIP address. +- UserPrincipalName: The user's UPN is used as the SIP address. +- SamAccountName: The SIP address is the user's SamAccountName (logon name) followed by the SIP domain. +For example, the user with the SamAccountName kmyer will have a SIP address similar to this: kmyer@litwareinc.com. +If you use this address type then you must also include the SipDomain parameter. + +The SipAddressType parameter is not required if you use the SipAddress parameter and explicitly assign the user a SIP address. ```yaml -Type: Fqdn +Type: AddressType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -235,15 +268,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to enable a user account. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). +### -SipDomain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP domain for the user account being enabled. +This parameter is required if you use the SipAddressType parameter to have Skype for Business Server auto-generate a SIP address for the user and you based SIP addresses on the SamAccountName or the user's first name and last name. +This parameter is not required if you base SIP addresses on the user's email address or UPN; that's because the domain name is already included in those attribute values. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -252,15 +288,16 @@ 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 enabled for Skype for Business Server. -By default, the Enable-CsUser cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -270,29 +307,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Export-CsArchivingData.md b/skype/skype-ps/SkypeForBusiness/Export-CsArchivingData.md similarity index 86% rename from skype/skype-ps/skype/Export-CsArchivingData.md rename to skype/skype-ps/SkypeForBusiness/Export-CsArchivingData.md index cd7d61b79f..c4da017c34 100644 --- a/skype/skype-ps/skype/Export-CsArchivingData.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsArchivingData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-csarchivingdata applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsArchivingData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-csarchivingdata +schema: 2.0.0 +title: Export-CsArchivingData --- # Export-CsArchivingData @@ -66,7 +67,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsArchivingData -Identity "ArchivingDatabase:atl-sql-001.litwareinc.com" -StartDate 6/1/2018 -OutputFolder "C:\ArchivingExports" ``` @@ -74,7 +75,7 @@ Export-CsArchivingData -Identity "ArchivingDatabase:atl-sql-001.litwareinc.com" The command shown in Example 1 extracts records from the Archiving database located on the server atl-sql-001.litwareinc.com, and then saves the resulting EML file to the folder C:\ArchivingExports. The specified start date of June 1, 2018 (-StartDate 6/1/2018) ensures that only items recorded in the database after 5/31/2018 will be exported. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Export-CsArchivingData -Identity "ArchivingDatabase:atl-sql-001.litwareinc.com" -StartDate 6/1/2018 -OutputFolder "C:\ArchivingExports" -UserUri "kenmyer@litwareinc.com" ``` @@ -82,7 +83,7 @@ Export-CsArchivingData -Identity "ArchivingDatabase:atl-sql-001.litwareinc.com" Example 2 is a variation of the command shown in Example 1; in this case, however, only the records pertaining to the user Ken Myer are exported. To limit your export to records pertaining to a single user, include the UserUri parameter followed by appropriate SIP address. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Export-CsArchivingData -Identity "ArchivingDatabase:atl-sql-001.litwareinc.com" -StartDate 6/1/2018 -EndDate 6/30/2018 -OutputFolder "C:\ArchivingExports" ``` @@ -96,17 +97,19 @@ With a start date of June 1, 2018 and an end date of June 30, 2018, exporting is ## PARAMETERS ### -DBInstance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is intended for use only with Microsoft Lync Server 2010. If you are using the Export-CsArchivingData cmdlet on Skype for Business Server you should use the Identity parameter instead. Path to the SQL Server database instance where archiving data is recorded. -For example: +For example: `"atl-sql-001\Archinst"` ```yaml Type: String Parameter Sets: ExcludeWebConfArchiveSet, PurgeSet, ByDbInstance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -115,58 +118,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutputFolder -Full path to the folder where the exported data should be stored (for example, C:\ArchivingExports). -If this folder does not exist, then the Export-CsArchivingData cmdlet will create it. +### -EndDate + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the latest activity date for records to be exported. +For example, if you set the end date to 6/1/2018 (June 1, 2018, in U.S. +English) any items recorded in the database after that date (for example, items recorded on June 2, 2018) will be excluded from the export. +Although you will not receive an error message, your export will fail if the end date occurs before the start date (for example, an end date of 1/1/2018 and a start date of 6/1/2018). + +Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate and EndDate properties. + +If an end date is not specified then the current date will be used. ```yaml -Type: String +Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StartDate -Indicates the earliest activity date for the records to be exported. -For example, if you set the start date to 6/1/2018 (June 1, 2018, in U.S. -English) any items recorded in the database prior to that date (for example, items recorded on May 31, 2018) will be excluded from the export. +### -ExcludeWebConfArchive -Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate and EndDate properties. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Instructs the Export-CsArchivingData cmdlet to only export instant messaging records. +By default, the cmdlet exports both IM and conferencing records. ```yaml -Type: DateTime +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EndDate -Indicates the latest activity date for records to be exported. -For example, if you set the end date to 6/1/2018 (June 1, 2018, in U.S. -English) any items recorded in the database after that date (for example, items recorded on June 2, 2018) will be excluded from the export. -Although you will not receive an error message, your export will fail if the end date occurs before the start date (for example, an end date of 1/1/2018 and a start date of 6/1/2018). +### -Force -Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate and EndDate properties. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If an end date is not specified then the current date will be used. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: DateTime +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,32 +180,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserUri -Enables you to export archiving data for a single user; this is done by using the UserUri parameter and specifying the SIP address of the user. -The UserUri parameter will accept only one URI at a time. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service identity of the archiving database to be exported. +For example: + +`-Identity "ArchivingDatabase:atl-sql-001.litwareinc.com"` + +You can also specify the database by using just the pool name: + +`-Identity "atl-sql-001.litwareinc.com"` + +You can retrieve the service identities for your archiving databases by using this command: + +`Get-CsService -ArchivingDatabase | Select-Object Identity` ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: ExcludeWebConfArchiveSet, PurgeSet, ByIdentity +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -ExcludeWebConfArchive -Instructs the Export-CsArchivingData cmdlet to only export instant messaging records. -By default, the cmdlet exports both IM and conferencing records. +### -IncludeTrustedApplication + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Include data logged by trusted applications (CAA/CAS) when exporting records. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,31 +227,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Purge -When included, the Purge parameter causes any record that has been successfully exported to be deleted from the Archiving database. -If you do not include this parameter, exported records will be retained in the database. +### -OutputFolder + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the folder where the exported data should be stored (for example, C:\ArchivingExports). +If this folder does not exist, then the Export-CsArchivingData cmdlet will create it. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -Purge + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When included, the Purge parameter causes any record that has been successfully exported to be deleted from the Archiving database. +If you do not include this parameter, exported records will be retained in the database. ```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 +Aliases: Required: False Position: Named @@ -242,30 +265,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -StartDate + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the earliest activity date for the records to be exported. +For example, if you set the start date to 6/1/2018 (June 1, 2018, in U.S. +English) any items recorded in the database prior to that date (for example, items recorded on May 31, 2018) will be excluded from the export. + +Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate and EndDate properties. ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeTrustedApplication -Include data logged by trusted applications (CAA/CAS) when exporting records. +### -UserUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to export archiving data for a single user; this is done by using the UserUri parameter and specifying the SIP address of the user. +The UserUri parameter will accept only one URI at a time. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -274,41 +306,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Service identity of the archiving database to be exported. -For example: - -`-Identity "ArchivingDatabase:atl-sql-001.litwareinc.com"` - -You can also specify the database by using just the pool name: - -`-Identity "atl-sql-001.litwareinc.com"` +### -Confirm -You can retrieve the service identities for your archiving databases by using this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsService -ArchivingDatabase | Select-Object Identity` +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity -Parameter Sets: ExcludeWebConfArchiveSet, PurgeSet, ByIdentity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +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. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -324,16 +349,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None - ## OUTPUTS -### +### None The Export-CsArchivingData cmdlet returns Archiving database records in EML format. - ## NOTES - ## RELATED LINKS [Get-CsArchivingConfiguration](Get-CsArchivingConfiguration.md) diff --git a/skype/skype-ps/skype/Export-CsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Export-CsConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Export-CsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Export-CsConfiguration.md index 07b09a1158..583fd51e63 100644 --- a/skype/skype-ps/skype/Export-CsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-csconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-csconfiguration +schema: 2.0.0 +title: Export-CsConfiguration --- # Export-CsConfiguration @@ -51,7 +52,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsConfiguration -FileName "C:\Config.zip" ``` @@ -61,38 +62,42 @@ The command shown in Example 1 exports Skype for Business Server data from the C ## PARAMETERS -### -FileName -Path to the .ZIP file to be created when you run the Export-CsConfiguration cmdlet. -For example: +### -AsBytes -`-FileName "C:\Config.zip".` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you must include either the FileName or the AsBytes parameters, but not both, when calling the Export-CsConfiguration cmdlet. +Returns topology information as a byte array; the returned data must then be stored in a variable in order to be used by the Import-CsConfiguration cmdlet. +You cannot use both AsBytes and FileName in the same command. ```yaml -Type: String -Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: AsBytes +Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AsBytes -Returns topology information as a byte array; the returned data must then be stored in a variable in order to be used by the Import-CsConfiguration cmdlet. -You cannot use both AsBytes and FileName in the same command. +### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the .ZIP file to be created when you run the Export-CsConfiguration cmdlet. +For example: + +`-FileName "C:\Config.zip".` + +Note that you must include either the FileName or the AsBytes parameters, but not both, when calling the Export-CsConfiguration cmdlet. ```yaml -Type: SwitchParameter -Parameter Sets: AsBytes -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: FileName +Aliases: -Required: False +Required: True Position: 2 Default value: None Accept pipeline input: False @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. To set the Force parameter to True use this syntax: @@ -108,8 +116,7 @@ To set the Force parameter to True use this syntax: ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the configuration data from the local computer rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,16 +150,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None - ## OUTPUTS -### +### System.Byte[] If called along with the AsBytes parameter, the Export-CsConfiguration cmdlet returns configuration information in the form of a byte array. - ## NOTES - ## RELATED LINKS [Import-CsConfiguration](Import-CsConfiguration.md) diff --git a/skype/skype-ps/skype/Export-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Export-CsLisConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Export-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Export-CsLisConfiguration.md index 86b50a823e..ae1b34d559 100644 --- a/skype/skype-ps/skype/Export-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-cslisconfiguration +schema: 2.0.0 +title: Export-CsLisConfiguration --- # Export-CsLisConfiguration @@ -45,21 +46,21 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsLisConfiguration -FileName C:\E911Config.bak ``` This example exports the entire E9-1-1 configuration from the Location Information Server (LIS) to the backup file named E911Config.bak. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $lisconfig = Export-CsLisConfiguration -AsBytes ``` In this example, the LIS configuration is stored as an array of bytes in a variable, $lisconfig. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $lisconfig = Export-CsLisConfiguration -AsBytes @@ -80,38 +81,42 @@ The contents of the file are then piped to the Import-CsLisConfiguration cmdlet, ## PARAMETERS -### -FileName -The path and file name of the file to which you want to save the configuration. -This cannot be the name of an existing file. +### -AsBytes -If you supply a value to the AsBytes parameter, you cannot supply a value to the FileName parameter. -If you're accessing this cmdlet remotely, you must use AsBytes rather than FileName. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns the configuration as a byte array. +The output of the command should be assigned to a variable for later import. +(If you don't assign the output to a variable, the byte array representing the configuration will scroll down your Lync Server Management Shell window.) You cannot specify both the AsBytes parameter and the FileName parameter; you can use only one or the other for each call to this cmdlet. ```yaml -Type: String -Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: AsBytes +Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AsBytes -Returns the configuration as a byte array. -The output of the command should be assigned to a variable for later import. -(If you don't assign the output to a variable, the byte array representing the configuration will scroll down your Lync Server Management Shell window.) You cannot specify both the AsBytes parameter and the FileName parameter; you can use only one or the other for each call to this cmdlet. +### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The path and file name of the file to which you want to save the configuration. +This cannot be the name of an existing file. + +If you supply a value to the AsBytes parameter, you cannot supply a value to the FileName parameter. +If you're accessing this cmdlet remotely, you must use AsBytes rather than FileName. ```yaml -Type: SwitchParameter -Parameter Sets: AsBytes -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: FileName +Aliases: -Required: False +Required: True Position: 2 Default value: None Accept pipeline input: False diff --git a/skype/skype-ps/skype/Export-CsPersistentChatData.md b/skype/skype-ps/SkypeForBusiness/Export-CsPersistentChatData.md similarity index 90% rename from skype/skype-ps/skype/Export-CsPersistentChatData.md rename to skype/skype-ps/SkypeForBusiness/Export-CsPersistentChatData.md index c748866515..d2b7982107 100644 --- a/skype/skype-ps/skype/Export-CsPersistentChatData.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsPersistentChatData.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Export-CsPersistentChatData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-cspersistentchatdata +schema: 2.0.0 +title: Export-CsPersistentChatData --- # Export-CsPersistentChatData @@ -53,7 +54,7 @@ The functions carried out by the Export-CsPersistentChatData cmdlet are not avai ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsPersistentChatData -DBInstance "atl-sql-001.litwareinc.com\rtc" -FileName "C:\Logs\PersistentChatData.zip" ``` @@ -64,36 +65,40 @@ Because the Level parameter was not specified, the Export-CsPersistentChatData c ## PARAMETERS -### -DBInstance -Fully qualified domain name and name of the SQL Server instance where the Skype for Business Server 2015 Persistent Chat database is located. -For example, this syntax specifies the database found in the RTC database instance on the server atl-sql-001.litwareinc.com: +### -AsBytes -`-DBInstance "atl-sql-001.litwareinc.com\rtc"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Returns Persistent Chat information as a byte array; the returned data must then be stored in a variable in order to be used by the Import-CsPersistentChatData cmdlet. +You cannot use both AsBytes and FileName in the same command. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Type: SwitchParameter +Parameter Sets: AsBytes +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AsBytes -Returns Persistent Chat information as a byte array; the returned data must then be stored in a variable in order to be used by the Import-CsPersistentChatData cmdlet. -You cannot use both AsBytes and FileName in the same command. +### -DBInstance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name and name of the SQL Server instance where the Skype for Business Server 2015 Persistent Chat database is located. +For example, this syntax specifies the database found in the RTC database instance on the server atl-sql-001.litwareinc.com: + +`-DBInstance "atl-sql-001.litwareinc.com\rtc"` ```yaml -Type: SwitchParameter -Parameter Sets: AsBytes -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Type: String +Parameter Sets: (All) +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -DBName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SQL instance name of the Persistent Chat database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -DisableExportedNodes + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, all exported categories and chat rooms will be disabled when the export is complete. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full path to the .ZIP file that the Export-CsPersistentChatData cmdlet will create; this file will contain the exported user data. For example: @@ -141,8 +153,7 @@ For example: ```yaml Type: String Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to specify which Persistent Chat information will be exported. Allowed values are: @@ -166,8 +180,7 @@ The default value is All, which means that all the Persistent Chat information w ```yaml Type: ExportLevel Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -177,6 +190,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full path for the log file created when the cmdlet runs. For example: @@ -185,8 +201,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -196,14 +211,16 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to export data for a specified set of categories (and their corresponding chat rooms). By default all Categories are exported. ```yaml Type: System.Collections.Generic.List`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -213,6 +230,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Beginning date for the time period for which Persistent Chat chat room content should be exported. For example: @@ -223,8 +243,7 @@ This parameter is valid only when they Level is set to RoomDirectory. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -240,14 +259,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None - ## OUTPUTS -### +### None The Export-CsPersistentChatData cmdlet creates .ZIP files. - ## NOTES - ## RELATED LINKS diff --git a/skype/skype-ps/skype/Export-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Export-CsRgsConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Export-CsRgsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Export-CsRgsConfiguration.md index eb820753a3..231ce56828 100644 --- a/skype/skype-ps/skype/Export-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsRgsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-csrgsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsRgsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-csrgsconfiguration +schema: 2.0.0 +title: Export-CsRgsConfiguration --- # Export-CsRgsConfiguration @@ -42,7 +43,7 @@ The functions carried out by the Export-CsRgsConfiguration cmdlet are not availa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsRgsConfiguration -Source "ApplicationServer:atl-rgs-001.litwareinc.com" -FileName "C:\Exports\Rgs.zip" ``` @@ -53,6 +54,9 @@ The command shown in Example 1 exports the Response Group configuration settings ## PARAMETERS ### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to the .ZIP file to be created when you run the Export-CsRgsConfiguration cmdlet. For example: @@ -63,8 +67,7 @@ Note that your command will fail if this file already exists. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -73,33 +76,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Source -Identity of the Response Group instance whose configuration settings are being exported. -For example: - -`-Source "ApplicationServer:atl-rgs-001.litwareinc.com"` - -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +95,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If specified, configuration information for all the Response Group instances found on the designated pool will be exported. For example: @@ -117,8 +106,7 @@ For example: ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,13 +116,15 @@ Accept wildcard characters: False ``` ### -RemoveExportedConfiguration + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, the Response Group instance will be deleted after the configuration information has been exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +133,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Source + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Identity of the Response Group instance whose configuration settings are being exported. +For example: + +`-Source "ApplicationServer:atl-rgs-001.litwareinc.com"` + +```yaml +Type: RgsIdentity +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). @@ -153,7 +164,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### None The Export-CsRgsConfiguration cmdlet creates compressed files with the .ZIP file extension. diff --git a/skype/skype-ps/skype/Export-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Export-CsUserData.md similarity index 85% rename from skype/skype-ps/skype/Export-CsUserData.md rename to skype/skype-ps/SkypeForBusiness/Export-CsUserData.md index 0a7cb7f3d3..338ab0c4f4 100644 --- a/skype/skype-ps/skype/Export-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsUserData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsUserData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-csuserdata +schema: 2.0.0 +title: Export-CsUserData --- # Export-CsUserData @@ -54,7 +55,7 @@ NOTE: URNs that have the following characters back slash (\\) and forward slash ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsUserData -PoolFqdn "atl-cs-001.litwareinc.com" -FileName "C:\Logs\ExportedUserData.zip" ``` @@ -63,99 +64,99 @@ The command shown in Example 1 exports user data from the pool atl-cs-001.litwar ## PARAMETERS -### -FileName -Full path to the .ZIP file that the `Export-CsUserData` cmdlet will create; this file will contain the exported user data. -For example: +### -ConfDirectoryFilter --FileName "C:\Logs\ExportedData.zip" +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, allows you to export conference directory information for the specified conference directory. +For example, to export data from the conference directory with the ID 13 use this syntax: + +-ConfDirectoryFilter 13 + +You can return conference directory IDs by using this command: + +`Get-CsConferenceDirectory` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Fully qualified domain name of the pool where the User database containing the user data to be exported is installed. -For example: - --Identity "atl-sql-001.litwareinc.com" +### -DbName -Note that you can retrieve fully qualified domain names for your User database pools by running this command: +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Get-CsService -UserDatabase +Name of the SQL Server database containing the user data to be exported. ```yaml Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: SqlInstance +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolFqdn -Fully qualified domain name of the Registrar pool containing the user data to be exported. -For example: +### -DomainController --PoolFqdn "atl-cs-001.litwareinc.com" +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to specify the FQDN of the domain controller to be used when running the `Export-CsUserData` cmdlet. +If not specified, the cmdlet will use the first available domain controller. ```yaml Type: Fqdn -Parameter Sets: PoolFqdn -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfDirectoryFilter -When specified, allows you to export conference directory information for the specified conference directory. -For example, to export data from the conference directory with the ID 13 use this syntax: +### -FileName --ConfDirectoryFilter 13 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can return conference directory IDs by using this command: +Full path to the .ZIP file that the `Export-CsUserData` cmdlet will create; this file will contain the exported user data. +For example: -`Get-CsConferenceDirectory` +-FileName "C:\Logs\ExportedData.zip" ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables administrators to specify the FQDN of the domain controller to be used when running the `Export-CsUserData` cmdlet. -If not specified, the cmdlet will use the first available domain controller. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,30 +165,41 @@ 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. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool where the User database containing the user data to be exported is installed. +For example: + +-Identity "atl-sql-001.litwareinc.com" + +Note that you can retrieve fully qualified domain names for your User database pools by running this command: + +Get-CsService -UserDatabase ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Identity +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -LegacyFormat + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, data is saved in the format used by Microsoft Lync Server 2010. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,20 +208,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserFilter -Enables you to export data for a single user. -That user is in dictated by specifying his or her SIP address, minus the sip: prefix. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the Registrar pool containing the user data to be exported. For example: --UserFilter "kenmyer@litwareinc.com" +-PoolFqdn "atl-cs-001.litwareinc.com" ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: PoolFqdn +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -217,6 +230,9 @@ Accept wildcard characters: False ``` ### -SqlInstanceName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Name of the SQL Server instance containing the user data to be exported. For example: @@ -225,8 +241,7 @@ For example: ```yaml Type: String Parameter Sets: SqlInstance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -235,14 +250,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DbName -Name of the SQL Server database containing the user data to be exported. +### -UserFileFilter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to a text file containing a list of user URIs for whom data should be exported. ```yaml Type: String -Parameter Sets: SqlInstance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -251,14 +268,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserFileFilter -Full path to a text file containing a list of user URIs for whom data should be exported. +### -UserFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to export data for a single user. +That user is in dictated by specifying his or her SIP address, minus the sip: prefix. +For example: + +-UserFilter "kenmyer@litwareinc.com" ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -278,7 +301,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### None The `Export-CsUserData` cmdlet creates new .ZIP files. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAVEdgeConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAVEdgeConfiguration.md index 25ec18533d..2cee24268d 100644 --- a/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAVEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAVEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csavedgeconfiguration +schema: 2.0.0 +title: Get-CsAVEdgeConfiguration --- # Get-CsAVEdgeConfiguration @@ -41,7 +42,7 @@ The Get-CsAVEdgeConfiguration cmdlet provides a way for you to retrieve informat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAVEdgeConfiguration ``` @@ -49,14 +50,14 @@ Get-CsAVEdgeConfiguration The command shown in Example 1 returns a collection of all the A/V Edge configuration settings configured for use in the organization. Calling the Get-CsAVEdgeConfiguration cmdlet without any additional parameters always returns a complete collection of A/V Edge configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAVEdgeConfiguration -Identity site:Redmond ``` In Example 2 a single collection of A/V Edge configuration settings is returned: the collection that has the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAVEdgeConfiguration -Filter "site:*" ``` @@ -65,7 +66,7 @@ Example 3 returns a collection of all the A/V Edge configuration settings that h To do this, the Get-CsAVEdgeConfiguration cmdlet is called along with the Filter parameter; the filter value "site:*" limits the returned data to settings that have an Identity that begins with the characters "site:". By definition, that limits the returned data to settings configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAVEdgeConfiguration | Where-Object {$_.MaxBandwidthPerUserKB -gt 10000} ``` @@ -74,14 +75,14 @@ In Example 4, the only A/V Edge configuration settings that are returned are tho To perform this task, the command first calls the Get-CsAVEdgeConfiguration cmdlet without any parameters; that returns a collection of all the A/V Edge configuration settings currently in use. That collection is then piped to the Where-Object cmdlet, which picks out only the settings where the MaxBandwidthPerUserKB is greater than 10000 kilobits per second. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAVEdgeConfiguration | Where-Object {$_.MaxBandwidthPerUserKB -eq 10000} ``` Example 5 is similar to the command shown in Example 4; in Example 5, however, the only A/V Edge settings returned are those where the MaxBandwidthPerUserKB property is exactly equal to 10000 kilobits per second. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsAVEdgeConfiguration | Where-Object {$_.MaxTokenLifetime -lt "08:00:00"} ``` @@ -93,11 +94,34 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when indicating the A/V Edge configuration settings to be returned. +For example, to return all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings configured at the service, use this syntax: -Filter "service:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of A/V Edge configuration settings to be retrieved. To retrieve the global collection, use the following syntax: -Identity global. To retrieve a site collection use syntax similar to this: -Identity site:Redmond. -Settings configured at the service scope should be referred to using syntax similar to this: +Settings configured at the service scope should be referred to using syntax similar to this: `-Identity service:EdgeServer:atl-cs-001.litwareinc.com` @@ -108,8 +132,7 @@ If this parameter is not included, the Get-CsAVEdgeConfiguration cmdlet returns ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -118,32 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the A/V Edge configuration settings to be returned. -For example, to return all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings configured at the service, use this syntax: -Filter "service:*". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the A/V Edge configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAccessEdgeConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAccessEdgeConfiguration.md index 11284940f2..8def73a465 100644 --- a/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAccessEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaccessedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAccessEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaccessedgeconfiguration +schema: 2.0.0 +title: Get-CsAccessEdgeConfiguration --- # Get-CsAccessEdgeConfiguration @@ -48,7 +49,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAccessEdgeConfiguration ``` @@ -56,7 +57,7 @@ Get-CsAccessEdgeConfiguration Example 1 demonstrates the basic use of the Get-CsAccessEdgeConfiguration cmdlet: calling the cmdlet without any additional parameters returns all the property values for your Access Edge server implementation. Note that there is no need to include the Identity or Filter parameters; that's because there is only one set of Access Edge server configuration data. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAccessEdgeConfiguration | Select-Object Allow* ``` @@ -66,7 +67,7 @@ To do this, the command first uses the Get-CsAccessEdgeConfiguration cmdlet to r This information is then piped to the Select-Object cmdlet, which picks out only those properties that start with the string value "Allow". In turn, those are the only property values displayed on the screen. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` (Get-CsAccessEdgeConfiguration).EnablePartnerDiscovery ``` @@ -79,50 +80,56 @@ After all the property values have been returned, standard "dot notation" (the o ## PARAMETERS -### -Identity -Unique identifier of the Access Edge configuration settings to be returned. -Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsAccessEdgeConfiguration cmdlet. -However, you can use the following syntax to retrieve the global settings: -Identity global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the Access Edge 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: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Access Edge 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*". +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the Access Edge configuration settings to be returned. +Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsAccessEdgeConfiguration cmdlet. +However, you can use the following syntax to retrieve the global settings: -Identity global. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Access Edge configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdContact.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdContact.md similarity index 88% rename from skype/skype-ps/skype/Get-CsAdContact.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdContact.md index 34b07fefb1..3c3a0f433f 100644 --- a/skype/skype-ps/skype/Get-CsAdContact.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadcontact +schema: 2.0.0 +title: Get-CsAdContact --- # Get-CsAdContact @@ -41,7 +42,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdContact ``` @@ -49,7 +50,7 @@ Get-CsAdContact The command shown in Example 1 returns a collection of all the multi-forest contacts found in Active Directory Domain Services. Calling the Get-CsAdContact cmdlet without any additional parameters returns all the property values for all the Active Directory contacts. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdContact | Select-Object DisplayName, SipAddress ``` @@ -57,14 +58,14 @@ Get-CsAdContact | Select-Object DisplayName, SipAddress Example 2 also returns a collection of all the Active Directory contacts. In this case, however, that collection is piped to the Select-Object cmdlet, which specifies the only two attributes that will be displayed on the screen: DisplayName and SipAddress. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdContact -Identity "Ken Myer" ``` Example 3 returns information for a single Active Directory contact: the contact with the Identity "Ken Myer". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAdContact -LdapFilter "Organization=Fabrikam" ``` @@ -73,7 +74,7 @@ In Example 4, the command returns all the Active Directory contacts who work for To do this, the Get-CsAdContact cmdlet is called, along with the LdapFilter parameter. In this example, the limits the returned data to contacts that have their Organization attribute set to "Fabrikam". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` $x = Get-Credential -Credential "litwareinc\administrator" @@ -91,27 +92,10 @@ The parameter value $x indicates that the Get-CsAdContact cmdlet should be run u ## PARAMETERS -### -Identity -Indicates the Identity of the contact to be returned. -Contact Identities can be specified by using one of three formats: 1) the contact's SIP address; 2) the contact's Active Directory distinguished name; and, 3) the contact's Active Directory display name (for example, Ken Myer). - -You can use the asterisk (*) wildcard character when using the Display Name as the contact Identity. -For example, the Identity "* Smith" returns all the contacts with a display name that ends in the string value "Smith". - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsAdContact cmdlet under alternate credentials; this might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. @@ -120,8 +104,7 @@ For details, see the Help topic for Get-Credential. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,14 +114,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +133,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. The Filter parameter uses the same Windows PowerShell filtering syntax used by the Where-Object cmdlet. @@ -156,8 +144,51 @@ For example, a filter that returns only contacts who have a SIP address that end ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the contact to be returned. +Contact Identities can be specified by using one of three formats: 1) the contact's SIP address; 2) the contact's Active Directory distinguished name; and, 3) the contact's Active Directory display name (for example, Ken Myer). + +You can use the asterisk (*) wildcard character when using the Display Name as the contact Identity. +For example, the Identity "* Smith" returns all the contacts with a display name that ends in the string value "Smith". + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LDAPFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering on generic Active Directory attributes. +For example, you can limit returned data to contacts who work in a specific department, or contacts that have a specified manager or job title. + +The LdapFilter parameter uses the LDAP query language when creating filters. +For example, a filter that returns the contact that has the telephone number 1-425-555-1298 would look like this: "telephoneNumber=1-425-555-1298", with "telephoneNumber" representing the Active Directory attribute; "=" representing the comparison operator (equal to); and "1-425-555-1298" representing the filter value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -167,6 +198,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the retrieved information from a specific Active Directory organizational unit (OU) or container. This parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs: AccountsPayable and AccountsReceivable. @@ -177,8 +211,7 @@ When specifying an OU, use the distinguished name of that container; for example ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,6 +221,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven contacts (regardless of the number of contacts 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 7 users will be returned. @@ -199,28 +235,7 @@ If you set the ResultSize to 7 but you have only three contacts in your forest, ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] 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 -``` - -### -LDAPFilter -Enables you to limit the returned data by filtering on generic Active Directory attributes. -For example, you can limit returned data to contacts who work in a specific department, or contacts that have a specified manager or job title. - -The LdapFilter parameter uses the LDAP query language when creating filters. -For example, a filter that returns the contact that has the telephone number 1-425-555-1298 would look like this: "telephoneNumber=1-425-555-1298", with "telephoneNumber" representing the Active Directory attribute; "=" representing the comparison operator (equal to); and "1-425-555-1298" representing the filter value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdDomain.md similarity index 87% rename from skype/skype-ps/skype/Get-CsAdDomain.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdDomain.md index 5bccf6a4ec..d8b73df760 100644 --- a/skype/skype-ps/skype/Get-CsAdDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaddomain +schema: 2.0.0 +title: Get-CsAdDomain --- # Get-CsAdDomain @@ -46,7 +47,7 @@ Historical Note: Get-CsAdDomain performs the same function as the following Micr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdDomain ``` @@ -54,7 +55,7 @@ Get-CsAdDomain Example 1 returns information regarding the current status of your local Active Directory domain. If your domain settings are up-to-date, and the domain is ready to host Skype for Business Server, the value LC_DOMAIN_SETTINGS_STATE_READY will be returned. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdDomain -Domain "fabrikam.com" ``` @@ -62,7 +63,7 @@ Get-CsAdDomain -Domain "fabrikam.com" The command shown in Example 2 returns the current status of a specific domain: fabrikam.com. In a multi-domain environment, you can return information for a given domain by including the Domain parameter. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdDomain -Report "C:\Logs\DomainReport.html" ``` @@ -75,14 +76,16 @@ Those steps include tasks such as verifying the existence of Active Directory gr ## PARAMETERS ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the domain to be checked; for example: -Domain "litwareinc.com". If this parameter is not specified, then the local domain will be checked. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -92,14 +95,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to specify the FQDN of the domain controller to be used when running the Get-CsAdDomain cmdlet. If not specified, 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 +Aliases: Required: False Position: Named @@ -109,14 +114,16 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a global catalog server in your domain. This parameter is not required if you are running the Get-CsAdDomain cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -133,8 +143,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,16 +153,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\DomainPrep.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdForest.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdForest.md similarity index 87% rename from skype/skype-ps/skype/Get-CsAdForest.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdForest.md index 7c4a94daab..4c65ba0df4 100644 --- a/skype/skype-ps/skype/Get-CsAdForest.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdForest.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadforest applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdForest -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadforest +schema: 2.0.0 +title: Get-CsAdForest --- # Get-CsAdForest @@ -46,14 +47,14 @@ Typically all domain members have this permission. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsAdForest ``` Example 1 returns information indicating whether your Active Directory forest has been correctly configured to allow for the installation of Skype for Business Server. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsAdForest -Report C:\Logs\ForestState.html ``` @@ -66,14 +67,16 @@ This file includes a detailed list of all the Active Directory groups and Active ## PARAMETERS ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Get-CsAdForest cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in AD DS, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -90,8 +96,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,14 +105,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RootDomainController -FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\ForestPrep.html"` ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,17 +126,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -RootDomainController -`-Report "C:\Logs\ForestPrep.html"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -SkipPrepareCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True), causes Get-CsAdForest to run without first doing its initial preparation checks. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdPrincipal.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdPrincipal.md similarity index 90% rename from skype/skype-ps/skype/Get-CsAdPrincipal.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdPrincipal.md index 408fcea9c1..aa7db5f198 100644 --- a/skype/skype-ps/skype/Get-CsAdPrincipal.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdPrincipal.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadprincipal applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdPrincipal -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadprincipal +schema: 2.0.0 +title: Get-CsAdPrincipal --- # Get-CsAdPrincipal @@ -52,14 +53,14 @@ The functions carried out by the Get-CsAdPrincipal cmdlet are not available in t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdPrincipal ``` The command shown in Example 1 returns all the Active Directory principals in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdPrincipal -Filter {SipAddress -eq "sip:RedmondMeetingRoom@litwareinc.com"} ``` @@ -67,7 +68,7 @@ Get-CsAdPrincipal -Filter {SipAddress -eq "sip:RedmondMeetingRoom@litwareinc.com In Example 2, information is returned for a single Active Directory principal: the principal with the SIP address "sip:RedmondMeetingRoom@litwareinc.com". This is done by including the Filter parameter and a filter value that looks for principals where the SipAddress property is equal to (-eq) "sip:RedmondMeetingRoom@litwareinc.com". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdPrincipal | Where-Object {$_.ObjectClass -contains "contact"} ``` @@ -80,6 +81,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Credential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to run the Get-CsAdPrincipal cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. @@ -89,8 +93,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,14 +103,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve Active Directory principal information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. The Filter parameter uses much of the same Windows PowerShell filtering syntax used by the Where-Object cmdlet. @@ -124,13 +132,12 @@ For example, a filter that returns only principals whose sip address equals "Red `-Filter {SipAddress -eq "sip:RedmondMeetingRoom@litwareinc.com"}` -In that example, SipAddress represents the Skype for Business attribute, -eq represents the comparison operator (equal to "sip:RedmondMeetingRoom@litwareinc.com") +In that example, SipAddress represents the Skype for Business attribute, -eq represents the comparison operator (equal to "sip:RedmondMeetingRoom@litwareinc.com") ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the principal account to be retrieved. Identities are typically specified by using one of four formats: 1) the account SIP address; 2) the user's user principal name (UPN); 3) the account domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the account Active Directory display name (for example, Ken Myer). @@ -151,8 +161,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -LDAPFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). For example, you can limit returned data to principals who belong to a specific department or who have a specific manager or job title. @@ -175,8 +187,7 @@ In that example, the "l" (a lowercase L) represents the Active Directory attribu ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return information about principals in a specific organizational unit (OU) or container. The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable - principals will be returned from each of these three OUs. @@ -201,8 +215,7 @@ To return principals from the Users container, use this syntax: ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven principals (regardless of the number of principals 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 principals will be returned. @@ -223,8 +239,7 @@ If you set the ResultSize to 7 but you have only three principals in your forest ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdServerSchema.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdServerSchema.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAdServerSchema.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdServerSchema.md index 68b5c4a03e..a683ce6d08 100644 --- a/skype/skype-ps/skype/Get-CsAdServerSchema.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdServerSchema.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadserverschema applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdServerSchema -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadserverschema +schema: 2.0.0 +title: Get-CsAdServerSchema --- # Get-CsAdServerSchema @@ -36,7 +37,7 @@ However, you can also run the Get-CsAdServerSchema cmdlet independently of the S ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdServerSchema ``` @@ -44,7 +45,7 @@ Get-CsAdServerSchema The command shown in Example 1 returns the current state of the Active Directory server schema. If the schema is up to date, the command returns the following value: SCHEMA_VERSION_STATE_CURRENT. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdServerSchema -Report C:\Logs\Server_Schema.html ``` @@ -57,15 +58,17 @@ This information includes details such as the schema major version and minor ver ## PARAMETERS ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\SchemaPrep.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdUser.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdUser.md similarity index 90% rename from skype/skype-ps/skype/Get-CsAdUser.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdUser.md index 64a6b36104..f793dda3e0 100644 --- a/skype/skype-ps/skype/Get-CsAdUser.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaduser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaduser +schema: 2.0.0 +title: Get-CsAdUser --- # Get-CsAdUser @@ -51,14 +52,14 @@ The LdapFilter parameter enables you to limit the returned data for users who fi One important thing to note about the Get-CsAdUser cmdlet is this: although the Enabled attribute, which determines whether or not a user has been enabled for Skype for Business Server, is a Boolean value, this property actually has three valid values: -True: +True: The user has been enabled for Skype for Business Server. -False: +False: The user has temporarily had their Skype for Business Server account disabled. This is typically carried out by using the Set-CsUser cmdlet and setting the Enabled parameter to $False. -Null: +Null: The user has not been enabled for Skype for Business Server. What that means is that, if you want to return a list of users who are not enabled for Skype for Business Server then you must use a command that returns all the users where the Enabled attribute is null: @@ -74,14 +75,14 @@ Users who have not been enabled for Skype for Business Server will not be return ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdUser ``` The command shown in Example 1 returns a collection of all the user accounts in your Active Directory domain. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdUser -Identity "Pilar Ackerman" ``` @@ -89,7 +90,7 @@ Get-CsAdUser -Identity "Pilar Ackerman" In Example 2, the Get-CsAdUser cmdlet returns user account information for Pilar Ackerman. In this example, the user's display name is used to specify her Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdUser -OU "ou=Finance,dc=litwareinc,dc=com" ``` @@ -97,7 +98,7 @@ Get-CsAdUser -OU "ou=Finance,dc=litwareinc,dc=com" Example 3 returns user account information for all the users in the Finance organizational unit. To do this, the DN of the OU must be passed to the OU parameter. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAdUser -Filter {Enabled -ne $True} | Select-Object DisplayName ``` @@ -107,7 +108,7 @@ To do this, the Filter parameter is used with the Get-CsAdUser cmdlet to restric This filter tells the Get-CsAdUser cmdlet to return only those user accounts that have not been enabled for use with Skype for Business Server. After the data has been retrieved, the information is piped to the Select-Object cmdlet, which then identifies the only property (in this case, DisplayName) that will actually be displayed on the screen. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAdUser -LdapFilter "Department=Finance" ``` @@ -118,28 +119,10 @@ This is done by using the LDAP filter value "Department=Finance". ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be retrieved. -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). -You can also reference a user account 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". +### -Credential -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Credential Enables you to run the Get-CsAdUser cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. @@ -149,8 +132,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,14 +142,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,6 +161,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. The Filter parameter uses the same Windows PowerShell filtering syntax used by the Where-Object cmdlet. @@ -185,8 +172,52 @@ For example, a filter that returns only users who are not enabled for Skype for ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be retrieved. +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). +You can also reference a user account 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: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LDAPFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). +For example, you can limit returned data to users who work in a specific department or users who have a specific manager or job title. + +The LdapFilter parameter uses the LDAP query language when creating filters. +For example, a filter that returns only users who work in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -196,6 +227,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return users from a specific Active Directory organizational unit (OU) or container. This parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable -- users will be returned from each of these three OUs. @@ -206,8 +240,7 @@ To return users from the Users container, use this syntax: cn=Users,dc=litwarein ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -217,6 +250,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven users (regardless of the number of users 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. @@ -228,28 +264,7 @@ If you set the ResultSize to 7 but you have only three users in your forest, the ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] 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 -``` - -### -LDAPFilter -Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). -For example, you can limit returned data to users who work in a specific department or users who have a specific manager or job title. - -The LdapFilter parameter uses the LDAP query language when creating filters. -For example, a filter that returns only users who work in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdditionalInternalDomain.md similarity index 86% rename from skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdditionalInternalDomain.md index 0e359015b0..cd3f6eacd7 100644 --- a/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdditionalInternalDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdditionalInternalDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadditionalinternaldomain +schema: 2.0.0 +title: Get-CsAdditionalInternalDomain --- # Get-CsAdditionalInternalDomain @@ -42,13 +43,15 @@ Gets additional SIP domain names from LocalStore ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data. ```yaml Type: String Parameter Sets: Filter Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -58,13 +61,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the additional SIP domain to be returned. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 1 @@ -74,13 +79,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsAddressBookConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAddressBookConfiguration.md index 7515253dc6..25ade65d2b 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAddressBookConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaddressbookconfiguration +schema: 2.0.0 +title: Get-CsAddressBookConfiguration --- # Get-CsAddressBookConfiguration @@ -52,7 +53,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAddressBookConfiguration ``` @@ -60,14 +61,14 @@ Get-CsAddressBookConfiguration Example 1 returns information about all the Address Book configuration settings in use in your organization. This is the default behavior if you call the Get-CsAddressBookConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookConfiguration -Identity site:Redmond ``` Example 2 returns information for the Address Book configuration settings with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookConfiguration -Filter site:* ``` @@ -75,7 +76,7 @@ Get-CsAddressBookConfiguration -Filter site:* In this example, the Filter parameter and the filter value "site:*" are used to return information about all the Address Book configuration settings that have been applied at the site scope. The supplied filter value returns information for all the Address Book settings that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAddressBookConfiguration | Where-Object {$_.UseNormalizationRules -eq $True} ``` @@ -87,7 +88,30 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection (or multiple collections) of Address Book settings. +For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity, use this syntax: -Filter *EMEA*. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Address Book settings to be returned. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -100,8 +124,7 @@ If this parameter is not specified, then the Get-CsAddressBookConfiguration cmdl ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -110,32 +133,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection (or multiple collections) of Address Book settings. -For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity, use this syntax: -Filter *EMEA*. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the Address Book configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationConfiguration.md index 17e9105af0..975fde866f 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAddressBookNormalizationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaddressbooknormalizationconfiguration +schema: 2.0.0 +title: Get-CsAddressBookNormalizationConfiguration --- # Get-CsAddressBookNormalizationConfiguration @@ -39,7 +40,7 @@ That means that, in some cases, you might need to create identical rules: one fo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAddressBookNormalizationConfiguration ``` @@ -47,7 +48,7 @@ Get-CsAddressBookNormalizationConfiguration The command shown in Example 1 returns a collection of all the Address Book normalization configuration settings currently in use in the organization. This is done by calling the Get-CsAddressBookNormalizationConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookNormalizationConfiguration -Identity "site:Redmond" ``` @@ -56,7 +57,7 @@ In Example 2, information is returned for a single collection of normalization r -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookNormalizationConfiguration -Filter "site:*" ``` @@ -69,14 +70,16 @@ That syntax limits the returned data to all the collections that have an Identit ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a collection (or multiple collections) of Address Book normalization configuration settings. For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter "site:*" ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Address Book normalization configuration settings to be returned. To refer to the global settings, use this syntax: -Identity global @@ -99,8 +105,7 @@ If this parameter is not specified, then the Get-CsAddressBookNormalizationConfi ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Address Book normalization configuration 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationRule.md similarity index 90% rename from skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationRule.md index d12fa7f30e..046ca6401f 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAddressBookNormalizationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaddressbooknormalizationrule +schema: 2.0.0 +title: Get-CsAddressBookNormalizationRule --- # Get-CsAddressBookNormalizationRule @@ -37,21 +38,21 @@ That means, in some cases, you might need to create identical rules: one for ass ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAddressBookNormalizationRule ``` The command shown in Example 1 returns information about all the Address Book normalization rules configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookNormalizationRule -Identity "Global/Generic_All" ``` In Example 2, information is returned for a single Address Book normalization rule: the rule Generic_All found in the global collection of Address Book normalization rules. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookNormalizationRule -Identity "Global" ``` @@ -60,7 +61,7 @@ Example 3 returns all the normalization rules found in the global collection of To return all the rules in a collection simply specify the collection scope. For example, to find all the rules in the collection assigned to the Redmond site use this syntax: -Identity "site:Redmond". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAddressBookNormalizationRule | Where-Object {$_.Priority -eq 1} ``` @@ -73,6 +74,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters to return a collection of normalization rules based on the rule Identity. Note, however, that Filter works only on the scope portion of the Identity and not on the rule name. For example, the filter value *lob* will return all rules at the global scope (scopes that contain the letters "lob"). @@ -85,8 +89,7 @@ To return all the rules in a given collection (such as the Redmond site) you can ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the rule. If a value is specified for this parameter, it must be in the format scope/name; for example, site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. If neither the Identity nor the Filter parameters are included in a command, the Get-CsAddressBookNormalizationRule cmdlet will return all the Address book normalization rules configured for use in the organization. @@ -103,8 +109,7 @@ If neither the Identity nor the Filter parameters are included in a command, the ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Address book normalization rules from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRole.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAdminRole.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdminRole.md index 45ac191dd0..42c55397f9 100644 --- a/skype/skype-ps/skype/Get-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRole.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdminRole -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadminrole +schema: 2.0.0 +title: Get-CsAdminRole --- # Get-CsAdminRole @@ -88,7 +89,7 @@ To return a list of all the RBAC roles this cmdlet has been assigned to (includi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdminRole ``` @@ -96,14 +97,14 @@ Get-CsAdminRole The command shown in Example 1 returns information about all the RBAC roles configured for use in your organization. This is done by calling the Get-CsAdminRole cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdminRole -Identity "CsHelpDesk" ``` In Example 2, a single RBAC role is returned: the role that has the Identity CsHelpDesk. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdminRole -Filter "*Voice*" ``` @@ -111,7 +112,7 @@ Get-CsAdminRole -Filter "*Voice*" Example 3 returns all the RBAC roles that have the string value "Voice" somewhere in their Identity (for example, CsVoiceAdministrator; RedmondVoiceAdministrators). To do this, Get-CsAdminRole is called along with the Filter parameter; the filter value "*Voice*" limits the returned data to RBAC roles that have the string value "Voice" somewhere in their Identity. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAdminRole | Where-Object {$_.IsStandardRole -eq $False} ``` @@ -121,7 +122,7 @@ To carry out this task, the command first uses the Get-CsAdminRole cmdlet to ret This collection is then piped to the Where-Object cmdlet, which selects only those roles where the IsStandardRole property is equal to False. By definition, any role that meets that criterion is a custom RBAC role. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Set-CsUser\b"} ``` @@ -131,7 +132,7 @@ To do this, the command first calls the Get-CsAdminRole cmdlet without any param This collection is then piped to the Where-Object cmdlet, which picks out any role where the Cmdlets property includes the string value "Set-CsUser\b". (The \b is a word boundary marker that indicates that "Set-CsUser" represents the entire string value.) -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsAdminRole | Where-Object {$_.UserScopes -match "OU: ou=Redmond,dc=litwareinc,dc=com"} ``` @@ -140,7 +141,7 @@ Example 6 returns information about all the RBAC roles that include the specifie To perform this task, the command first calls the Get-CsAdminRole cmdlet in order to return a collection of all the RBAC roles currently configured for use. This collection is then piped to the Where-Object cmdlet, which selects all of the roles that include the string value "OU:ou=Redmond,dc=litwareinc,dc=com" in the UserScopes property. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsAdminRole -Identity "CsVoiceAdministrator" | Select-Object -ExpandProperty Cmdlets ``` @@ -152,7 +153,29 @@ This information is then piped to the Select-Object cmdlet, which uses the Expan ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards in order to specify the RBAC role (or roles) to be returned. +For example, to return all the roles that include the string value "Redmond" in their Identity, you can use this syntax: -Filter "*Redmond*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the RBAC role to be returned. The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. @@ -160,8 +183,7 @@ For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -170,15 +192,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards in order to specify the RBAC role (or roles) to be returned. -For example, to return all the roles that include the string value "Redmond" in their Identity, you can use this syntax: -Filter "*Redmond*". +### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves the RBAC data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -188,6 +211,9 @@ Accept wildcard characters: False ``` ### -Sid + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use a security identifier (SID) to specify the RBAC role to be retrieved. SIDs are assigned by Skype for Business Server at the time that the RBAC role is created, and look similar to this: S-1-5-21-1573807623-1597889489-1765977225-1145. @@ -196,8 +222,7 @@ This same SID can also be found on the corresponding Active Directory security g ```yaml Type: String Parameter Sets: SID -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -206,22 +231,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the RBAC 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: -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). diff --git a/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRoleAssignment.md similarity index 88% rename from skype/skype-ps/skype/Get-CsAdminRoleAssignment.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdminRoleAssignment.md index 553b2ad153..6c0eedc3c8 100644 --- a/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRoleAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadminroleassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdminRoleAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadminroleassignment +schema: 2.0.0 +title: Get-CsAdminRoleAssignment --- # Get-CsAdminRoleAssignment @@ -33,14 +34,14 @@ The Get-CsAdminRoleAssignment cmdlet provides a way for you to retrieve a list o ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdminRoleAssignment -Identity "kenmyer" ``` The command shown in Example 1 returns all of the RBAC roles assigned to the user kenmyer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser | ForEach-Object {$_.DisplayName; Get-CsAdminRoleAssignment -Identity $_.SamAccountName} ``` @@ -53,7 +54,28 @@ The user account information must be piped to the ForEach-Object cmdlet because ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SamAccountName of the user whose RBAC roles are to be returned, You can retrieve the SamAccountName for a user by using a command similar to this: `Get-CsUser "Ken Myer" | Select-Object SamAccountName` @@ -64,8 +86,7 @@ Other common values used when specifying identities, such as the Active Director ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,30 +95,16 @@ Accept pipeline input: True (ByValue) 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 Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the RBAC role assignment 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,7 +119,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### String +### String The Get-CsAdminRoleAssignment cmdlet accepts a pipelined string value representing the SamAccountName of a user. diff --git a/skype/skype-ps/skype/Get-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsAllowedDomain.md similarity index 90% rename from skype/skype-ps/skype/Get-CsAllowedDomain.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAllowedDomain.md index d929aab5aa..255892d051 100644 --- a/skype/skype-ps/skype/Get-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAllowedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAllowedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csalloweddomain +schema: 2.0.0 +title: Get-CsAllowedDomain --- # Get-CsAllowedDomain @@ -48,7 +49,7 @@ The Get-CsAllowedDomain cmdlet provides a way for you to return information abou ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAllowedDomain ``` @@ -56,7 +57,7 @@ Get-CsAllowedDomain The command shown in Example 1 returns a collection of all the domains included in the list of domains approved for federation. Calling the Get-CsAllowedDomain cmdlet without any additional parameters always returns the complete collection of approved domains. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAllowedDomain -Identity fabrikam.com ``` @@ -64,7 +65,7 @@ Get-CsAllowedDomain -Identity fabrikam.com Example 2 returns information about the allowed domain with the Identity "fabrikam.com". Because identities must be unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAllowedDomain -Filter *fabrikam* ``` @@ -74,7 +75,7 @@ To do this, the command uses the Filter parameter and the filter value "\*fabrik This filter value tells the Get-CsAllowedDomain cmdlet to return only those domains where the Identity (the only property you can filter on) includes the string value "fabrikam". Domains such as fabrikam.com, fabrikam.net, and africa.fabrikam.org will all be returned by this command. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAllowedDomain | Where-Object {$_.ProxyFqdn -eq $Null} ``` @@ -84,7 +85,7 @@ To carry out this task, the Get-CsAllowedDomain cmdlet is first called without a This collection is then piped to the Where-Object cmdlet, which selects only those allowed domains where the ProxyFqdn property is equal to a null value; a null value means that no value has been entered for ProxyFqdn. To find all the domains that have a value of some kind configured for the ProxyFqdn property, use this syntax instead: `Where-Object {$_.ProxyFqdn -ne $Null}`. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAllowedDomain | Where-Object {$_.MarkForMonitoring -eq $True} ``` @@ -95,57 +96,63 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS -### -Identity -Name of the domain to be returned. -Domains are listed on the allowed list by their fully qualified domain name (FQDN); that means that the Identity for a given domain will be similar to fabrikam.com or contoso.net. -Note that you cannot use wildcards when specifying a domain Identity. -To use wildcards to return a given domain (or set of domains), use the Filter parameter instead. +### -Filter -If this parameter is not specified, then all of the domains on the allowed domain list will be returned. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return one or more domains from the list of allowed domains. + +To return all of the domains that have an Identity that begins with the letter "r", use this syntax: `-Filter r*` + +To return all of the domains that have an Identity that ends with ".net", use this syntax: `-Filter "*.net"` + +To return all of the domains that have an Identity that begins with the letter "r" or with the letter "g", use this syntax: `-Filter [rg]*` ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return one or more domains from the list of allowed domains. +### -Identity -To return all of the domains that have an Identity that begins with the letter "r", use this syntax: `-Filter r*` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To return all of the domains that have an Identity that ends with ".net", use this syntax: `-Filter "*.net"` +Name of the domain to be returned. +Domains are listed on the allowed list by their fully qualified domain name (FQDN); that means that the Identity for a given domain will be similar to fabrikam.com or contoso.net. +Note that you cannot use wildcards when specifying a domain Identity. +To use wildcards to return a given domain (or set of domains), use the Filter parameter instead. -To return all of the domains that have an Identity that begins with the letter "r" or with the letter "g", use this syntax: `-Filter [rg]*` +If this parameter is not specified, then all of the domains on the allowed domain list will be returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the allowed domains from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Get-CsAnalogDevice.md similarity index 88% rename from skype/skype-ps/skype/Get-CsAnalogDevice.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAnalogDevice.md index 395151838c..fb2abe18a0 100644 --- a/skype/skype-ps/skype/Get-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAnalogDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAnalogDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csanalogdevice +schema: 2.0.0 +title: Get-CsAnalogDevice --- # Get-CsAnalogDevice @@ -45,7 +46,7 @@ Optional parameters provide different ways for you to filter information; for ex ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAnalogDevice ``` @@ -53,7 +54,7 @@ Get-CsAnalogDevice The command shown in Example 1 returns a collection of all the analog devices currently configured for use in the organization. This is done by calling the Get-CsAnalogDevice cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAnalogDevice | Select-Object DisplayName, LineUri ``` @@ -62,7 +63,7 @@ In Example 2, only two property values -- DisplayName and LineUri -- are returne To carry out this task, the command first calls the Get-CsAnalogDevice cmdlet without any parameters; this returns all the property values for all the analog devices in the organization. This collection is then piped to the Select-Object cmdlet, which selects and displays only the values for the DisplayName and the LineUri properties. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAnalogDevice -Filter {DisplayName -eq "Building 14 Receptionist"} ``` @@ -70,7 +71,7 @@ Get-CsAnalogDevice -Filter {DisplayName -eq "Building 14 Receptionist"} Example 3 returns information about the analog device that has the Active Directory display name "Building 14 Receptionist". To do this, the command calls Get-CsAnalogDevice and the Filter parameter; the filter value {DisplayName -eq "Building 14 Receptionist"} limits the returned items to analog devices where the DisplayName property is equal to "Building 14 Receptionist". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAnalogDevice -Filter {Gateway -eq "192.168.0.240"} ``` @@ -78,7 +79,7 @@ Get-CsAnalogDevice -Filter {Gateway -eq "192.168.0.240"} Example 4 returns all of the analog devices configured for the gateway 192.168.0.240. This is done by calling the Get-CsAnalogDevice cmdlet and including the Filter parameter; the filter value "192.168.0.240" ensures that the only objects returned are analog devices where the Gateway property is equal to 192.168.0.240. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAnalogDevice -Filter {AnalogFax -eq $True} ``` @@ -87,14 +88,14 @@ The command shown in Example 5 returns information about all the analog fax mach To perform this task, the command calls the Get-CsAnalogDevice cmdlet along with the Filter parameter. The filter value {AnalogFax -eq $True} limits the returned objects to fax machines: analog devices where the AnalogFax property is equal to True. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsAnalogDevice -Filter {LineUri -eq "tel:+14255556001"} ``` In Example 6, a single analog device is returned: the device that has a LineUri (phone number) equal to tel:+14255556001. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsAnalogDevice -Filter {LineUri -like "tel:+1425555*"} ``` @@ -103,7 +104,7 @@ Example 7 returns all of the analog devices that have an area code of 425 and th To carry out this task, the Get-CsAnalogDevice cmdlet is used along with the Filter parameter; the filter value {LineUri -like "tel:+1425555*"} limits the returned data to devices where the LineUri property begins with the characters "tel:+1425555". That's equivalent to a phone number that begins with these characters: 1425555 (for example, the 1-425-555-1298). -### -------------------------- Example 8 -------------------------- +### Example 8 ``` Get-CsAnalogDevice -OU "ou=Telecommunications,dc=litwareinc,dc=com" ``` @@ -111,7 +112,7 @@ Get-CsAnalogDevice -OU "ou=Telecommunications,dc=litwareinc,dc=com" Example 8 returns a collection of all the analog devices that have a contact object in the Telecommunications OU in Active Directory Domain Services. To do this, the Get-CsAnalogDevice cmdlet is called along with the OU parameter; the parameter value limits the returned objects to analog devices that have contacts objects in the OU with the distinguished name ou=Telecommunications,dc=litwareinc,dc=com. -### -------------------------- Example 9 -------------------------- +### Example 9 ``` Get-CsAnalogDevice | Grant-CsVoicePolicy -PolicyName "AnalogVoicePolicy" ``` @@ -123,25 +124,10 @@ This collection is then piped to the Grant-CsVoicePolicy cmdlet, which assigns t ## PARAMETERS -### -Identity -Unique identifier for the analog device. -Analog devices are identified by using the Active Directory distinguished name of the associated contact object. -By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsAnalogDevice cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with contact objects. @@ -151,8 +137,7 @@ For details, see the Get-Credential cmdlet Help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,14 +147,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) of the computer; for example, atl-cs-001.litwareinc.com. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +166,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. For example, you can limit returned data to analog device contact objects that have been assigned a specific voice policy, or contacts that have not been assigned a specific voice policy. @@ -190,8 +180,7 @@ For example, a filter that returns only fax machines would look like this, with ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,7 +189,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the analog device. +Analog devices are identified by using the Active Directory distinguished name of the associated contact object. +By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -LdapFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). For example, you can limit returned data to contact objects that have been assigned to a specific department or are located in a specific building. @@ -214,8 +226,7 @@ In the preceding filter, "l" represents the Active Directory attribute (locality ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,19 +236,21 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return contact objects from a specific Active Directory organizational unit (OU). This returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable -- analog device information will be returned from each of these OUs. -When specifying an OU, use the distinguished name of that container; for example: +When specifying an OU, use the distinguished name of that container; for example: `-OU "OU=Finance,dc=litwareinc,dc=com"` ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,6 +260,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return seven analog devices (regardless of how many analog devices 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 phones will be returned. @@ -258,8 +274,7 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/Get-CsAnnouncement.md similarity index 89% rename from skype/skype-ps/skype/Get-CsAnnouncement.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAnnouncement.md index a6d35b457e..e49c1c84a0 100644 --- a/skype/skype-ps/skype/Get-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAnnouncement.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAnnouncement -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csannouncement +schema: 2.0.0 +title: Get-CsAnnouncement --- # Get-CsAnnouncement @@ -40,7 +41,7 @@ This cmdlet retrieves one or more of these announcement settings. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAnnouncement ``` @@ -48,7 +49,7 @@ Get-CsAnnouncement Example 1 returns all of the announcements configured for use in the organization. This is done by calling the Get-CsAnnouncement cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAnnouncement -Identity "ApplicationServer:redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90" ``` @@ -56,14 +57,14 @@ Get-CsAnnouncement -Identity "ApplicationServer:redmond.litwareinc.com/1951f734- The command shown in Example 2 returns a single announcement: the announcement with the Identity ApplicationServer:redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90. For an alternate (and arguably easier) way to retrieve a specific announcement, see Example 5. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAnnouncement -Identity "ApplicationServer:redmond.litwareinc.com" ``` The command shown in Example 3 returns information about all of the announcements that have been configured for use on the service ApplicationServer:redmond.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAnnouncement -Filter "*ApplicationServer:Redmond*" ``` @@ -72,7 +73,7 @@ In Example 4, information is returned for all of the announcements configured fo This is done by including the Filter parameter and the filter value "*ApplicationServer:Redmond*", which limits the returned data to announcements that have an Identity that contains the string value "ApplicationServer:Redmond". By definition, those are announcements configured for use in the Redmond site. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAnnouncement | Where-Object {$_.Name -eq "Welcome Announcement"} ``` @@ -81,7 +82,7 @@ Example 5 shows an alternate way to return a specific announcement or set of ann To do this, the Get-CsAnnouncement cmdlet is first called, without any parameters, in order to return a collection of all the announcements in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out those announcements that have a Name equal to (-eq) "Welcome Announcement". -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsAnnouncement -Identity "ApplicationServer:redmond.litwareinc.com" | Where-Object {$_.Name -eq "Welcome Announcement"} ``` @@ -92,7 +93,7 @@ This will return a collection of all announcements associated with that service. As in Example 5, this collection is then piped to the Where-Object cmdlet, which picks out those announcements that have a Name equal to (-eq) "Welcome Announcement". Because announcement names must be unique within an Application service, this command will never return more than a single item. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsAnnouncement | Where-Object {$_.Name -like "Welcome*"} ``` @@ -101,7 +102,7 @@ This example is similar to Example 5 in that we retrieve all the announcements, However, in Example 5 we used the -eq operator in the where clause to find an identical match for the name. In this example we've used the -like operator and a wildcard value to find all announcements that, in this case, begin with the string Welcome. -### -------------------------- Example 8 -------------------------- +### Example 8 ``` Get-CsAnnouncement | Where-Object {($_.TextToSpeechPrompt -ne $Null) -and ($_.Language -ne "en-US")} ``` @@ -114,7 +115,29 @@ This collection is then piped to the Where-Object cmdlet, which selects all the ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter allows you to perform a wildcard search on the Identity of all announcements configured for the organization. +Use the wildcard character (*) to filter on any part of 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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An identifier for the Announcement you want to retrieve. If you omit this parameter and the Filter parameter, all instances of announcements configured for the organization will be displayed. The value for the Identity parameter can be supplied in one of two ways: @@ -125,8 +148,7 @@ The value for the Identity parameter can be supplied in one of two ways: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -135,31 +157,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter allows you to perform a wildcard search on the Identity of all announcements configured for the organization. -Use the wildcard character (*) to filter on any part of the Identity. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the announcement information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsApplicationEndpoint.md similarity index 83% rename from skype/skype-ps/skype/Get-CsApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Get-CsApplicationEndpoint.md index abcb4005cc..62ca279973 100644 --- a/skype/skype-ps/skype/Get-CsApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csapplicationendpoint +schema: 2.0.0 +title: Get-CsApplicationEndpoint --- # Get-CsApplicationEndpoint @@ -33,14 +34,14 @@ These objects are stored in Active Directory in the Application Contacts contain ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsApplicationEndpoint ``` This example retrieves information about all application endpoints defined within the Skype for Business Server 2015 deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsApplicationEndpoint -Filter {DisplayName -like "*endpoint*"} ``` @@ -49,7 +50,7 @@ Example 2 retrieves all application endpoints that have the string "endpoint" an To do this, the command uses the Filter parameter. The value of the parameter filters to find endpoint objects that have a display name (DisplayName) that contains (-like) the string endpoint (*endpoint* - the wildcard characters indicate that any characters can come before or after the string endpoint, meaning endpoint can be anywhere within the display name). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsApplicationEndpoint -ApplicationId tapp2 | Select-Object Identity, SipAddress, DisplayName, OwnerUrn ``` @@ -62,40 +63,22 @@ The next part of this command pipes the returned object or objects to the Select ## PARAMETERS -### -Identity -The Identity, SIP address, or display name of the application endpoint to retrieve. -The Identity consists of the distinguished name of the endpoint. -This will typically contain a globally unique identifier (GUID) as part of the CN, for example: - -`CN={8811fefe-e0bb-4fab-ae39-7aaeddd423dc},CN=Application Contacts,CN=RTC Service,CN=Services,CN=Configuration,DC=Vdomain,DC=com.` - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ApplicationId -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ApplicationId The application ID of the application endpoint you want to retrieve. The application ID is the value of the endpoint's OwnerUrn property. For example, if the OwnerUrn property has a value of urn:application:Caa, the application ID is urn:application:Caa. However, you can enter only the suffix, in this case Caa, to retrieve the endpoint. -For example: +For example: `-ApplicationId Caa` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,14 +88,16 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Alternate credentials under which the Get operation will proceed. You can retrieve a PSCredential object by calling the Windows PowerShell cmdlet Get-Credential. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +107,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to specify a domain controller. If no domain controller is specified, the first available will be used. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +126,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on specific attributes for Skype for Business Server. For example, you can limit returned data to contacts whose display names or SIP addresses match a certain wildcard pattern. @@ -148,8 +138,7 @@ For example, a filter that returns only contacts that have been enabled for Ente ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +147,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity, SIP address, or display name of the application endpoint to retrieve. +The Identity consists of the distinguished name of the endpoint. +This will typically contain a globally unique identifier (GUID) as part of the CN, for example: + +`CN={8811fefe-e0bb-4fab-ae39-7aaeddd423dc},CN=Application Contacts,CN=RTC Service,CN=Services,CN=Configuration,DC=Vdomain,DC=com.` + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The organizational unit (OU) in which the endpoint resides. ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +188,15 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Fully Qualified Domain Name (FQDN) of the pool on which the application endpoint resides. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,13 +206,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of endpoint records to retrieve. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsArchivingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsArchivingConfiguration.md index 55d5040275..25286cbfa6 100644 --- a/skype/skype-ps/skype/Get-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsArchivingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csarchivingconfiguration +schema: 2.0.0 +title: Get-CsArchivingConfiguration --- # Get-CsArchivingConfiguration @@ -52,21 +53,21 @@ With the Get-CsArchivingConfiguration cmdlet, you can determine how IM session a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsArchivingConfiguration ``` The command shown in Example 1 returns a collection of all the archiving configuration settings in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingConfiguration -Identity site:Redmond ``` In Example 2, the Identity parameter is used to limit the returned collection of archiving configuration settings to those settings that have the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsArchivingConfiguration -Filter site:* ``` @@ -74,7 +75,7 @@ Get-CsArchivingConfiguration -Filter site:* In Example 3, the Filter parameter is used to limit the returned collection of archiving configuration settings to settings that have been configured at the site scope. The parameter value "site:*" limits the returned items to those that have an Identity that starts with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -ne "None"} ``` @@ -88,7 +89,30 @@ If this property is set to any other value (either "IMOnly" or "ImAndWebConf") t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection (or collections) of archiving configuration settings. +To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings that have the string value "Canada" somewhere in their Identity (the only property you can filter on) use this syntax: -Filter "*Canada*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of archiving settings you want to return. To refer to the global settings use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -106,8 +130,7 @@ If this parameter is not specified, then the Get-CsArchivingConfiguration cmdlet ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -116,32 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection (or collections) of archiving configuration settings. -To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings that have the string value "Canada" somewhere in their Identity (the only property you can filter on) use this syntax: -Filter "*Canada*". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the archiving configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsArchivingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsArchivingPolicy.md index f7195895dc..000217e372 100644 --- a/skype/skype-ps/skype/Get-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsArchivingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csarchivingpolicy +schema: 2.0.0 +title: Get-CsArchivingPolicy --- # Get-CsArchivingPolicy @@ -55,7 +56,7 @@ To determine whether or not IM session archiving has been enabled, use the Get-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsArchivingPolicy ``` @@ -63,7 +64,7 @@ Get-CsArchivingPolicy Example 1 calls the Get-CsArchivingPolicy cmdlet without any parameters. This returns a collection of all the archiving policies currently in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingPolicy -Identity site:Redmond ``` @@ -71,7 +72,7 @@ Get-CsArchivingPolicy -Identity site:Redmond In Example 2, the Get-CsArchivingPolicy cmdlet is used to return the archiving policy with the Identity site:Redmond. Because identities must be unique, this command will always return, at most, a single policy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsArchivingPolicy -Filter tag:* ``` @@ -80,7 +81,7 @@ Example 3 returns a collection of all the archiving policies that have been conf This is done by including the Filter parameter and the filter value "tag:*". That filter value instructs the Get-CsArchivingPolicy cmdlet to return only those policies that have an identity beginning with the string value "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsArchivingPolicy | Where-Object {$_.ArchiveInternal -eq $False} ``` @@ -90,7 +91,7 @@ To do this, the Get-CsArchivingPolicy cmdlet is first used to return a collectio That collection is then piped to the Where-Object cmdlet. In turn, the Where-Object cmdlet applies a filter that restricts the returned data to those policies where the ArchiveInternal property is equal to False. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsArchivingPolicy | Where-Object {$_.ArchiveInternal -eq $False -and $_.ArchiveExternal -eq $False} ``` @@ -104,7 +105,31 @@ To select policies that meet just one (or both) of the specified criteria use th ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +For example, to return all of the policies configured at the site scope, use this syntax: -Filter "site:*". +This returns any policy where the Identity (the only property you can filter on) begins with the string value "site:". +To return a collection of all the per-user policies that have an Identity that begins with "Sales", use this syntax: -Filter "Sales*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the archiving policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a site policy, use syntax similar to this: -Identity site:Redmond. @@ -114,8 +139,7 @@ If this parameter is omitted, then all of the archiving policies configured for ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -124,33 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. -For example, to return all of the policies configured at the site scope, use this syntax: -Filter "site:*". -This returns any policy where the Identity (the only property you can filter on) begins with the string value "site:". -To return a collection of all the per-user policies that have an Identity that begins with "Sales", use this syntax: -Filter "Sales*". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the archiving 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,6 +167,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose archiving policies are being returned. For example: @@ -172,8 +182,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsAudioConferencingProvider.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAudioConferencingProvider.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAudioConferencingProvider.md index b3dc99ff07..0a446e5e6d 100644 --- a/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAudioConferencingProvider.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaudioconferencingprovider applicable: Skype for Business Online -title: Get-CsAudioConferencingProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaudioconferencingprovider +schema: 2.0.0 +title: Get-CsAudioConferencingProvider --- # Get-CsAudioConferencingProvider @@ -38,21 +40,21 @@ Administrators can retrieve information about the audio conferencing providers a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAudioConferencingProvider ``` The command shown in Example 1 returns information about all the audio conferencing providers available for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAudioConferencingProvider -Identity "Fabrikam Telecom" ``` In Example 2, information is returned for a single audio conferencing provider: the provider with the Identity Fabrikam Telecom. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAudioConferencingProvider -Filter "*Fabrikam*" ``` @@ -64,6 +66,9 @@ In this example, the filter value "*Fabrikam*" returns all audio conferencing pr ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + Enables you to use wildcard characters when indicating the audio conferencing provider (or providers) to be returned. For example, this syntax returns information about all the audio conferencing providers that have the string value "fabrikam" somewhere in their Identity: @@ -74,8 +79,7 @@ Note that you cannot use the Filter parameter and the Identity parameters in the ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique identifier for the audio conferencing provider to be returned. For example: @@ -95,8 +102,7 @@ If neither the Identity parameter nor the Filter parameter are included in a com ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -106,13 +112,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + This parameter is not used with Skype for Business Online. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsAudioTestServiceApplication.md similarity index 88% rename from skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAudioTestServiceApplication.md index 4829ab115f..aba13f0ecd 100644 --- a/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAudioTestServiceApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaudiotestserviceapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAudioTestServiceApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaudiotestserviceapplication +schema: 2.0.0 +title: Get-CsAudioTestServiceApplication --- # Get-CsAudioTestServiceApplication @@ -41,21 +42,21 @@ Administrators can also use the Set-CsAudioTestServiceApplication to modify the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAudioTestServiceApplication ``` In Example 1, the Get-CsAudioTestServiceApplication cmdlet is called without any additional parameters in order to return a collection of all the Audio Test service contacts currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAudioTestServiceApplication -Identity "sip:RedmondAudioTest@litwareinc.com" ``` In Example 2, a single Audio Test service contact is returned: the contact that has the Identity sip:RedmondAudioTest@litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAudioTestServiceApplication -Filter {DisplayName -like "*Redmond*"} ``` @@ -67,34 +68,39 @@ This command returns contacts with display names such as "Redmond Audio Test Ser ## PARAMETERS -### -Identity -SIP address of the audio test service contact. +### -Credential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to run the cmdlet under alternate credentials. +This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. + +To use the Credential parameter, you must first create a PSCredential object by using the Get-Credential cmdlet. +For details, see the Get-Credential cmdlet help topic. ```yaml -Type: UserIdParameter +Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential -Enables you to run the cmdlet under alternate credentials. -This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. +### -DomainController -To use the Credential parameter, you must first create a PSCredential object by using the Get-Credential cmdlet. -For details, see the Get-Credential cmdlet help topic. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to retrieve contact information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). ```yaml -Type: PSCredential +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering for attributes specific to Skype for Business Server. For example, you can limit returned data to audio test contact objects that have a specific display name or use a particular language. @@ -117,8 +126,7 @@ You cannot use both the Filter and the Identity parameters in the same command. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,7 +135,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the audio test service contact. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return contacts from a specific Active Directory organizational unit (OU). The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs, such as AccountsPayable and AccountsReceivable, users will be returned from each of these three OUs. @@ -137,8 +166,7 @@ When specifying an OU, use the distinguished name (DN) of that container; for ex ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +176,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return seven users (regardless of how many users 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. @@ -159,25 +190,7 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] 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 -``` - -### -DomainController -Enables you to connect to the specified domain controller in order to retrieve contact information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAuthConfig.md b/skype/skype-ps/SkypeForBusiness/Get-CsAuthConfig.md similarity index 92% rename from skype/skype-ps/skype/Get-CsAuthConfig.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAuthConfig.md index 56541b3cdc..6830ed2e0c 100644 --- a/skype/skype-ps/skype/Get-CsAuthConfig.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAuthConfig.md @@ -1,13 +1,14 @@ --- -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 2015, Skype for Business Server 2019 -title: Get-CsAuthConfig -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csauthconfig +schema: 2.0.0 +title: Get-CsAuthConfig --- # Get-CsAuthConfig @@ -45,37 +46,44 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Pool + +> Applicable: Skype for Business Server 2019 + +{{Fill Pool Description}} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Pool -{{Fill Pool Description}} +### -Confirm + +> Applicable: Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: cf Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -83,7 +91,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAutodiscoverConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAutodiscoverConfiguration.md index 9b8fbb11b7..ab67cc43f7 100644 --- a/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAutodiscoverConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csautodiscoverconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAutodiscoverConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csautodiscoverconfiguration +schema: 2.0.0 +title: Get-CsAutodiscoverConfiguration --- # Get-CsAutodiscoverConfiguration @@ -53,21 +54,21 @@ The Get-CsAutoDiscoverConfiguration cmdlet provides a way to return information ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoDiscoverConfiguration ``` The command shown in Example 1 returns all the Autodiscover configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoDiscoverConfiguration -Identity "global" ``` In Example 2, only one collection of Autodiscover configuration settings are returned: the global collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAutoDiscoverConfiguration -Filter "site:*" ``` @@ -76,7 +77,7 @@ The command shown in Example 3 returns all the Autodiscover configuration settin To do this, the Filter parameter is included, along with the filter value "site:*"; that filter value ensures that the only settings returned are those that have an Identity that begins with the string value "site:". By definition, any settings with an Identity beginning with "site:" are settings configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAutoDiscoverConfiguration | Where-Object {$_.WebLinks -like "*fabrikam.com"} ``` @@ -90,6 +91,9 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when specifying the Identity of the Autodiscover configuration settings to be returned. For example, this syntax returns all the settings configured at the site scope: @@ -100,8 +104,7 @@ Note that you cannot use both the Identity and the Filter parameters in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Autodiscover configuration settings to be retrieved. To retrieve the global settings, use this syntax: @@ -125,8 +131,7 @@ If this parameter is not included, then the Get-CsAutoDiscoverConfiguration cmdl ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -136,13 +141,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Autodiscover configuration 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceConfiguration.md index 0807cde4a1..c0a962595a 100644 --- a/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbackupserviceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsBackupServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbackupserviceconfiguration +schema: 2.0.0 +title: Get-CsBackupServiceConfiguration --- # Get-CsBackupServiceConfiguration @@ -42,7 +43,7 @@ The functions carried out by the Get-CsBackupServiceConfiguration cmdlet are not ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBackupServiceConfiguration ``` @@ -54,6 +55,9 @@ Because there is only a single, global set of backup service configuration setti ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard values when referencing a collection of backup service configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings: @@ -65,8 +69,7 @@ The preceding syntax returns all the conference backup service configuration set ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the backup service configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsBackupServiceConfiguration cmdlet. You can, however, use the following syntax to reference the global settings: @@ -85,8 +91,7 @@ You can, however, use the following syntax to reference the global settings: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the backup service configuration 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBackupServiceStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceStatus.md similarity index 87% rename from skype/skype-ps/skype/Get-CsBackupServiceStatus.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceStatus.md index 6b305b2b3c..4c6847c6b9 100644 --- a/skype/skype-ps/skype/Get-CsBackupServiceStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceStatus.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbackupservicestatus applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsBackupServiceStatus -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbackupservicestatus +schema: 2.0.0 +title: Get-CsBackupServiceStatus --- # Get-CsBackupServiceStatus @@ -33,7 +34,7 @@ The functions carried out by the Get-CsBackupServiceStatus cmdlet are not availa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBackupServiceStatus -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -43,26 +44,10 @@ The preceding command returns the backup service status for the pool atl-cs-001. ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool whose backup service status is being checked. -For example: - -`-PoolFqdn "atl-cs-001.litwareinc.com"` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Category -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Category Type of backup whose status is being checked. Allowed values are: @@ -75,8 +60,7 @@ If this parameter is not specified then all three backup types will be checked. ```yaml Type: BackupCategory Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,13 +70,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +87,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool whose backup service status is being checked. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + +```yaml +Type: Fqdn +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). @@ -112,7 +119,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### System.Object Returns information about the backup service. diff --git a/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsBandwidthPolicyServiceConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBandwidthPolicyServiceConfiguration.md index 7b0c12b2c5..327a4e8ba7 100644 --- a/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBandwidthPolicyServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsBandwidthPolicyServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbandwidthpolicyserviceconfiguration +schema: 2.0.0 +title: Get-CsBandwidthPolicyServiceConfiguration --- # Get-CsBandwidthPolicyServiceConfiguration @@ -38,21 +39,21 @@ The Get-CsBandwidthPolicyServiceConfiguration cmdlet retrieves settings for one ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBandwidthPolicyServiceConfiguration ``` Example 1 retrieves all bandwidth policy service configurations defined within the Skype for Business Server implementation. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond ``` This example retrieves the bandwidth policy service configuration defined for the Redmond site (-Identity site:Redmond). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsBandwidthPolicyServiceConfiguration -Filter site:* ``` @@ -62,7 +63,7 @@ We do this by passing the value site:* to the Filter parameter. This will search the Identity property of all bandwidth policy service configurations for values that begin with site: and are followed by any other characters. Because all site-level configurations have Identity values beginning with site: and followed by the name of the site, this filter will find all configurations for all sites. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsBandwidthPolicyServiceConfiguration | Where-Object {$_.MaxLogFileSizeMb -gt 4} ``` @@ -79,48 +80,54 @@ If the value of MaxLogFileSizeMb is not greater than 4, the item is ignored and ## PARAMETERS -### -Identity -The unique identifier of the configuration you want to retrieve. -This identifier will consist of the scope (for the global configuration) or the scope and name (for a site-level configuration, such as site:Redmond). +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing one or more wildcard characters that will be used to search the Identity property of all bandwidth policy service configurations to find every configuration with an Identity that matches the wildcard pattern. +For example, the Filter value site:* will retrieve all configurations with Identity values that begin with the string site: and end with any set of characters. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string containing one or more wildcard characters that will be used to search the Identity property of all bandwidth policy service configurations to find every configuration with an Identity that matches the wildcard pattern. -For example, the Filter value site:* will retrieve all configurations with Identity values that begin with the string site: and end with any set of characters. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the configuration you want to retrieve. +This identifier will consist of the scope (for the global configuration) or the scope and name (for a site-level configuration, such as site:Redmond). ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the bandwidth policy service configuration from the local replica of the Central Management store, rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsBlockedDomain.md similarity index 90% rename from skype/skype-ps/skype/Get-CsBlockedDomain.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBlockedDomain.md index 4db4188c4b..c876209b6a 100644 --- a/skype/skype-ps/skype/Get-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBlockedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsBlockedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csblockeddomain +schema: 2.0.0 +title: Get-CsBlockedDomain --- # Get-CsBlockedDomain @@ -48,7 +49,7 @@ The Get-CsBlockedDomain cmdlet enables you to return information about the domai ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBlockedDomain ``` @@ -56,7 +57,7 @@ Get-CsBlockedDomain The command shown in Example 1 returns a collection of all the domains included on the blocked domain list. This is done by calling the Get-CsBlockedDomain cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` ``` @@ -64,7 +65,7 @@ This is done by calling the Get-CsBlockedDomain cmdlet without any additional pa In Example 2, the only blocked domain returned is the one with the Identity "fabrikam.com". Because domains on the blocked list must have unique identities, this command will return, at most, a single item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsBlockedDomain -Filter *.net ``` @@ -72,7 +73,7 @@ Get-CsBlockedDomain -Filter *.net Example 3 uses the Filter parameter to return a collection of all the blocked domains that have an identity that ends in the string value ".net". This sample command returns such domains as northwindtraders.net, contoso.net, and fabrikam.net. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsBlockedDomain | Where-Object {$_.Comment -eq $Null} ``` @@ -81,7 +82,7 @@ Example 4 returns a collection of all the domains where the Comment property has To do this, the command first uses the Get-CsBlockedDomain cmdlet to return a collection of all the domains on the blocked list. This collection is then piped to the Where-Object cmdlet, which selects only those domains where the Comment property is equal to a null value. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsBlockedDomain | Where-Object {$_.Comment -match "Ken Myer"} ``` @@ -93,7 +94,31 @@ This collection is then piped to the Where-Object cmdlet, which picks out those ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return one or more domains from the list of blocked domains. +To return all the domains that have an Identity that begins with the letter "r" use this syntax: -Filter r*. +To return all the domains that have an Identity that ends with ".net" use this syntax: -Filter "*.net". +To return all the domains that have an Identity that begins with the letter "f" or with the letter "g" use this syntax: -Filter \[fg\]*. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the domain to be returned. Domains are listed on the blocked list by their fully qualified domain name (FQDN); thus the Identity for a given domain will be similar to fabrikam.com or contoso.net. Note that you cannot use wildcards when specifying a domain Identity. @@ -104,8 +129,7 @@ If this parameter is not specified, then all the domains on the blocked domain l ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -114,33 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return one or more domains from the list of blocked domains. -To return all the domains that have an Identity that begins with the letter "r" use this syntax: -Filter r*. -To return all the domains that have an Identity that ends with ".net" use this syntax: -Filter "*.net". -To return all the domains that have an Identity that begins with the letter "f" or with the letter "g" use this syntax: -Filter \[fg\]*. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the blocked domain 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingConfiguration.md index 82470cd5a7..3e7868801d 100644 --- a/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbroadcastmeetingconfiguration applicable: Skype for Business Online -title: Get-CsBroadcastMeetingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbroadcastmeetingconfiguration +schema: 2.0.0 +title: Get-CsBroadcastMeetingConfiguration --- # Get-CsBroadcastMeetingConfiguration @@ -38,7 +40,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBroadcastMeetingConfiguration ``` @@ -49,13 +51,15 @@ This example returns the tenant's global broadcast meeting configuration. ## PARAMETERS ### -ExposeSDNConfigurationJsonBlob + +> Applicable: Skype for Business Online + When set to true, the cmdlet will only return broadcast meeting configuration settings that relate to the Software Defined Network configuration. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -65,13 +69,15 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -81,13 +87,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -97,13 +105,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -113,13 +123,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingPolicy.md similarity index 94% rename from skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingPolicy.md index acdf4bbf3d..ec0428e9ee 100644 --- a/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbroadcastmeetingpolicy applicable: Skype for Business Online -title: Get-CsBroadcastMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbroadcastmeetingpolicy +schema: 2.0.0 +title: Get-CsBroadcastMeetingPolicy --- # Get-CsBroadcastMeetingPolicy @@ -165,7 +167,7 @@ BroadcastMeetingRecordingEnforced : False ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBroadcastMeetingPolicy ``` @@ -177,13 +179,15 @@ See detailed description for more information. ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -193,13 +197,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -209,13 +215,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -225,13 +233,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBusyOptions.md b/skype/skype-ps/SkypeForBusiness/Get-CsBusyOptions.md similarity index 84% rename from skype/skype-ps/skype/Get-CsBusyOptions.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBusyOptions.md index 717261c488..b60869040c 100644 --- a/skype/skype-ps/skype/Get-CsBusyOptions.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBusyOptions.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsBusyOptions -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbusyoptions +schema: 2.0.0 +title: Get-CsBusyOptions --- # Get-CsBusyOptions @@ -31,7 +32,7 @@ This cmdlet retrieves configuration information about Busy Options for a specifi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBusyOptions -Identity sip:KenMyer@Contoso.com ``` @@ -42,6 +43,9 @@ This example returns the Busy Options setting for "KenMyer@Contoso.com". ## PARAMETERS ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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". @@ -49,8 +53,7 @@ You can use the asterisk (*) wildcard character when using the display name as t ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 0 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -81,21 +86,18 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.AD.UserIdParameter object. - +### Microsoft.Rtc.Management.AD.UserIdParameter ## OUTPUTS -### -Microsoft.Rtc.Management.Bob.Cmdlets.ActionType object. -Microsoft.Rtc.Management.AD.UserIdParameter object. +### Microsoft.Rtc.Management.Bob.Cmdlets.ActionType +### Microsoft.Rtc.Management.AD.UserIdParameter ## NOTES - ## RELATED LINKS -[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) -[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) +[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csbusyoptions?view=skype-ps) + +[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/Get-CsCallParkOrbit.md similarity index 88% rename from skype/skype-ps/skype/Get-CsCallParkOrbit.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCallParkOrbit.md index d13afad9f1..b9aa584c25 100644 --- a/skype/skype-ps/skype/Get-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCallParkOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCallParkOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscallparkorbit +schema: 2.0.0 +title: Get-CsCallParkOrbit --- # Get-CsCallParkOrbit @@ -38,7 +39,7 @@ Call park orbits are composed of settings that specify a range of numbers at whi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCallParkOrbit ``` @@ -46,14 +47,14 @@ Get-CsCallParkOrbit In this example, the Get-CsCallParkOrbit cmdlet is called without specifying any additional parameters. When called like this, the Get-CsCallParkOrbit cmdlet returns a collection of all the call park orbit ranges configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCallParkOrbit -Identity "Redmond CPO 1" ``` In Example 2, the Get-CsCallParkOrbit cmdlet is used to return information about the call park orbit range with the name "Redmond CPO 1". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCallParkOrbit -Filter *Redmond* ``` @@ -63,7 +64,7 @@ For example, this command will return call park orbits with identities such as " The command uses the Filter parameter with the wildcard character (*) to designate what to search for. (This search is not case sensitive.) -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsCallParkOrbit | Where-Object {$_.CallParkServiceId.toString() -eq "ApplicationServer:pool0.litwareinc.com"} ``` @@ -75,7 +76,7 @@ Notice that we add the toString method to the end of the CallParkServiceId param The CallParkServiceId is of type WritableServiceId. In order to compare that value to the supplied string, we must first turn it into a string by calling the toString method. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsCallParkOrbit | Where-Object {$_.NumberRangeStart.StartsWith("*")} ``` @@ -85,7 +86,7 @@ After the Get-CsCallParkOrbit cmdlet retrieves a collection of all the call park The Where-Object cmdlet narrows the collection to only those call park orbit ranges that have a call park location starting with a *. It does this by checking the StartsWith property of the NumberRangeStart object for the string "*". -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsCallParkOrbit | Where-Object {[Char]::IsDigit($_.NumberRangeStart[0])} ``` @@ -101,48 +102,54 @@ If it is, the call park orbit information for the corresponding collection item ## PARAMETERS -### -Identity -The unique name of the call park orbit range. -This name was assigned by the administrator when the call park orbit range was defined. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter accepts a wildcard string and returns all call park orbit ranges with identities matching that string. +For example, a Filter value of Redmond* will return all call park orbit ranges with names beginning with the string Redmond, such as Redmond 1, Redmond 2, RedmondCPO, etc. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter accepts a wildcard string and returns all call park orbit ranges with identities matching that string. -For example, a Filter value of Redmond* will return all call park orbit ranges with names beginning with the string Redmond, such as Redmond 1, Redmond 2, RedmondCPO, etc. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique name of the call park orbit range. +This name was assigned by the administrator when the call park orbit range was defined. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the call park orbit information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +159,16 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the type of call park orbit to be retrieved. Skype for Business Server 2015 allows for two different types of call park orbits: -- CallPark: +- CallPark: This is the standard call park orbit, in which a user places a call on hold and then can retrieve that call from any phone by dialing the specified call park number. -- GroupPickup: +- GroupPickup: With group pickup, users can answer any incoming call that is made to any member of their call pickup group. Call pickup groups are configured by administrators. @@ -173,8 +183,7 @@ This parameter was introduced in Lync Server 2013. ```yaml Type: OrbitType Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsCallViaWorkPolicy.md similarity index 87% rename from skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCallViaWorkPolicy.md index 5bf6b230bd..aa5c397b59 100644 --- a/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCallViaWorkPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCallViaWorkPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscallviaworkpolicy +schema: 2.0.0 +title: Get-CsCallViaWorkPolicy --- # Get-CsCallViaWorkPolicy @@ -35,7 +36,7 @@ Use the Get-CsCallViaWorkPolicy cmdlet to return call via work policies. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCallViaWorkPolicy -Identity Site:Redmond ``` @@ -47,6 +48,9 @@ This example returns the properties of the policy currently assigned to the Redm ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return all the policies configured at the site scope use this syntax: -Filter "site:\*". To return a collection of all the per-user policies, use this syntax: -Filter "tag:\*" @@ -54,8 +58,7 @@ To return a collection of all the per-user policies, use this syntax: -Filter "t ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the identity of the policy to be returned. Call via work policies can be returned at the global, site, or per-user scope. @@ -77,8 +83,7 @@ Per-user syntax: -Identity CallviaWorkStandard ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the call via work 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsCdrConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsCdrConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCdrConfiguration.md index 2b953208c4..37fb8c3e2a 100644 --- a/skype/skype-ps/skype/Get-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCdrConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCdrConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscdrconfiguration +schema: 2.0.0 +title: Get-CsCdrConfiguration --- # Get-CsCdrConfiguration @@ -46,21 +47,21 @@ The Get-CsCdrConfiguration cmdlet provides a way for you return detailed informa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCdrConfiguration ``` This example uses the Get-CsCdrConfiguration cmdlet to return a collection of all the CDR settings configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCdrConfiguration -Identity site:Redmond ``` Example 2 uses the Identity parameter to return a single collection of CDR settings: the settings with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCdrConfiguration -Filter site:* ``` @@ -69,7 +70,7 @@ In Example 3, the Filter parameter is employed to return all the CDR settings th The filter value "site:*" returns all the CDR settings that have an Identity that begins with the string value "site:". By definition, those are settings that have been configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsCdrConfiguration | Where-Object {$_.KeepCallDetailForDays -lt 30} ``` @@ -81,7 +82,30 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection of CDR configuration settings. +For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings that have the string value "Western" somewhere in their Identity, use this syntax: -Filter *Western*. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of CDR configuration settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -93,8 +117,7 @@ If this parameter is not specified then the Get-CsCdrConfiguration cmdlet return ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -103,32 +126,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection of CDR configuration settings. -For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings that have the string value "Western" somewhere in their Identity, use this syntax: -Filter *Western*. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the CDR configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Get-CsCertificate.md similarity index 89% rename from skype/skype-ps/skype/Get-CsCertificate.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCertificate.md index 99a8ec2704..324f27dd20 100644 --- a/skype/skype-ps/skype/Get-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscertificate +schema: 2.0.0 +title: Get-CsCertificate --- # Get-CsCertificate @@ -35,7 +36,7 @@ If a certificate has not been configured for use with Skype for Business Server ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCertificate ``` @@ -43,7 +44,7 @@ Get-CsCertificate The command shown in Example 1 returns information about the certificates currently assigned to Skype for Business Server components. This is done by calling the Get-CsCertificate cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCertificate -Type WebServicesInternal ``` @@ -51,7 +52,7 @@ Get-CsCertificate -Type WebServicesInternal Example 2 retrieves all the Skype for Business Server certificates used for internal Web services. To do this, the Type parameter is included, along with the parameter value WebServicesInternal. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCertificate | Where-Object {$_.NotAfter -lt "9/1/2018"} ``` @@ -63,7 +64,7 @@ The date specified in this example (9/1/2018) uses the U.S. English format for date-time values. Dates should be specified using a format compatible with your Regional and Language Options. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsCertificate | Where-Object {$_.Issuer -eq "Cn=MyCa"} ``` @@ -72,7 +73,7 @@ Example 4 returns information about all the Skype for Business Server certificat To do this, the command first calls the Get-CsCertificate cmdlet without any parameters in order to return a collection of all the certificates currently in use. This collection is then piped to the Where-Object cmdlet, which picks out all the certificates where the Issuer property is equal to (-eq) "Cn=MyCa". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsCertificate | Where-Object {$_.Subject -eq "CN=atl-cs-001.litwareinc.com"} ``` @@ -84,55 +85,38 @@ In turn, the Where-Object cmdlet selects only those certificates where the Subje ## PARAMETERS -### -Type -Type of certificate being requested. -Certificate types include, but are not limited to, the following: - -- AccessEdgeExternal -- AudioVideoAuthentication -- DataEdgeExternal -- Default -- External -- Internal -- iPhoneAPNService -- iPadAPNService -- MPNService -- PICWebService (Skype for Business Online only) -- ProvisionService (Skype for Business Online only) -- WebServicesExternal -- WebServicesInternal -- WsFedTokenTransfer - -For example, this syntax returns information about the Default certificate: +### -Identity -`-Type Default` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can specify multiple types in a single command by separating the certificate types with commas: +Enables you to retrieve certificates configured at the global scope (global certificates are copied and distributed to the appropriate computers). +Use this syntax to return information about the global certificates: -`-Type Internal,External,Default` +`Get-CsCertificate -Identity "global"` ```yaml -Type: CertType[] +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -NetportId + +> Applicable: Lync Server 2010 + Reserved for future use. This parameter is for certificates dedicated to a specific port, a scenario not yet supported by Lync Server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -142,6 +126,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to record detailed information about the procedures carried out by the Get-CsCertificate cmdlet. The parameter value should be the full path to the HTML file that will be generated; for example: -Report C:\Logs\Certificates.html. If the specified file already exists, it will automatically be overwritten with the new information. @@ -149,8 +136,7 @@ If the specified file already exists, it will automatically be overwritten with ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,20 +145,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Enables you to retrieve certificates configured at the global scope (global certificates are copied and distributed to the appropriate computers). -Use this syntax to return information about the global certificates: +### -Type -`Get-CsCertificate -Identity "global"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of certificate being requested. +Certificate types include, but are not limited to, the following: + +- AccessEdgeExternal +- AudioVideoAuthentication +- DataEdgeExternal +- Default +- External +- Internal +- iPhoneAPNService +- iPadAPNService +- MPNService +- PICWebService (Skype for Business Online only) +- ProvisionService (Skype for Business Online only) +- WebServicesExternal +- WebServicesInternal +- WsFedTokenTransfer + +For example, this syntax returns information about the Default certificate: + +`-Type Default` + +You can specify multiple types in a single command by separating the certificate types with commas: + +`-Type Internal,External,Default` ```yaml -Type: XdsIdentity +Type: CertType[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/Get-CsClientAccessLicense.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientAccessLicense.md similarity index 89% rename from skype/skype-ps/skype/Get-CsClientAccessLicense.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientAccessLicense.md index ca9a1a2205..82bb8832c5 100644 --- a/skype/skype-ps/skype/Get-CsClientAccessLicense.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientAccessLicense.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientaccesslicense applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientAccessLicense -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientaccesslicense +schema: 2.0.0 +title: Get-CsClientAccessLicense --- # Get-CsClientAccessLicense @@ -55,7 +56,7 @@ The functions carried out by the Get-CsClientAccessLicense cmdlet are not availa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientAccessLicense -MonitoringDatabase "atl-sql-001\Archinst" -LicenseName "Standard" -LicenseBasedType "UserBased" -StartDate "6/1/2018" ``` @@ -66,7 +67,53 @@ License usage information will be returned for the time period beginning on June ## PARAMETERS +### -DailyUsage + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If specified, license usage is broken down on a day-by-day basis for the specified time period. +If not specified, then license usage is summarized for the specified time period. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Ending date for the time period for which client license usage should be checked. +For example: + +`-EndDate "2/1/2018"` + +The EndDate must be later than the StartDate. +Note that the end date does not appear in the output when you call the Get-CsClientAccessLicense cmdlet. + +```yaml +Type: DateTime +Parameter Sets: DefaultSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -License + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns the available license names. This parameter cannot be used with any other parameters; this is the only valid syntax: @@ -75,8 +122,7 @@ This parameter cannot be used with any other parameters; this is the only valid ```yaml Type: SwitchParameter Parameter Sets: LicenseSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -86,6 +132,9 @@ Accept wildcard characters: False ``` ### -LicenseBasedType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the license is UserBased or DeviceBased. With UserBased licenses, each user who accesses Skype for Business Server is required to have a client access license, regardless of the number of devices he or she uses to access Skype for Business Server. With DeviceBased licenses, each device used to access Skype for Business Server requires a separate license. @@ -96,8 +145,7 @@ Device-based licensing is aimed at on-site users who typically access Skype for ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -107,6 +155,9 @@ Accept wildcard characters: False ``` ### -LicenseName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the kind of license being retrieved. Valid values are: @@ -117,8 +168,7 @@ Valid values are: ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -128,6 +178,9 @@ Accept wildcard characters: False ``` ### -MonitoringDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SQL Server instance for the monitoring database. This is typically specified by using the fully qualified domain name of the SQL Server computer and SQL Server instance of the monitoring database. For example: @@ -141,8 +194,7 @@ If the monitoring database is in the default SQL Server instance then you only n ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -152,6 +204,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Beginning date for the time period for which client license usage should be checked. For example, using the US English format the StartDate parameter might look like this: @@ -162,8 +217,7 @@ The StartDate must be earlier than the EndDate. ```yaml Type: DateTime Parameter Sets: DefaultSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -172,45 +226,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DailyUsage -If specified, license usage is broken down on a day-by-day basis for the specified time period. -If not specified, then license usage is summarized for the specified time period. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultSet -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 -``` - -### -EndDate -Ending date for the time period for which client license usage should be checked. -For example: - -`-EndDate "2/1/2018"` - -The EndDate must be later than the StartDate. -Note that the end date does not appear in the output when you call the Get-CsClientAccessLicense cmdlet. - -```yaml -Type: DateTime -Parameter Sets: DefaultSet -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 -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). @@ -222,7 +237,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### System.Object The Get-CsClientAccessLicense cmdlet returns licensing information. diff --git a/skype/skype-ps/skype/Get-CsClientCertificate.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientCertificate.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClientCertificate.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientCertificate.md index 396563d963..d01dbc9556 100644 --- a/skype/skype-ps/skype/Get-CsClientCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientcertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientcertificate +schema: 2.0.0 +title: Get-CsClientCertificate --- # Get-CsClientCertificate @@ -38,14 +39,14 @@ That means that you will not be able to run the Get-CsClientCertificate cmdlet f ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientCertificate -Identity "Ken Myer" ``` The command shown in Example 1 returns all the client certificates issued to Ken Myer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientCertificate -Identity "Ken Myer" | Where-Object {$_.ExpirationTime -lt "9/5/2018"} ``` @@ -57,7 +58,7 @@ The date specified in this example (9/5/2018) uses the U.S. English format for date-time values. Dates should be specified using a format compatible with your Regional and Language Options. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientCertificate -Identity "Ken Myer" | Where-Object {$_.PublicationTime -gt "1/1/2018"} ``` @@ -66,7 +67,7 @@ Example 3 returns all the client certificates that have been issued to Ken Myer To accomplish this task, the command first calls the Get-CsClientCertificate cmdlet to return a collection of all the client certificates issued to Ken Myer. This collection is then piped to the Where-Object cmdlet, which selects only those certificates where the PublicationTime property is greater than January 1, 2018 (1/1/2018). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUser | Where-Object {$_.RegistrarPool -ne $Null} | Get-CsClientCertificate ``` @@ -81,6 +82,9 @@ This filtered collection is then piped to the Get-CsClientCertificate cmdlet, wh ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account with the certificate information you want to retrieve. User Identities can be specified by using one of four formats: 1) the user's Session Initiation Protocol (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. @@ -90,8 +94,7 @@ Wildcards cannot be used when specifying the user Identity. ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -100,14 +103,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -116,14 +121,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClientPinInfo.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientPinInfo.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClientPinInfo.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientPinInfo.md index 58a1c53bdf..7b518d1899 100644 --- a/skype/skype-ps/skype/Get-CsClientPinInfo.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientPinInfo.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientpininfo applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientPinInfo -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientpininfo +schema: 2.0.0 +title: Get-CsClientPinInfo --- # Get-CsClientPinInfo @@ -40,7 +41,7 @@ That means that you will not be able to run the Get-CsClientPinInfo cmdlet from ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUser | Get-CsClientPinInfo ``` @@ -49,14 +50,14 @@ Example 1 returns PIN information for all the users who have been enabled for Sk To do this, the command first calls the Get-CsUser cmdlet to return all users who have been enabled for Skype for Business Server. That collection is piped to the Get-CsClientPinInfo cmdlet, which displays PIN information for each user in the collection. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientPinInfo -Identity "litwareinc\kenmyer" ``` In Example 2, the Get-CsClientPinInfo cmdlet is used to display PIN information for a single user: the user with the Identity litwareinc\kenmyer. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -OU "OU=Finance,DC=litwareinc,DC=com" | Get-CsClientPinInfo ``` @@ -65,7 +66,7 @@ Example 3 returns PIN information for all the users with accounts in the Finance To do this, the Get-CsUser cmdlet and the OU parameter are used to return a collection of all the users in the Finance OU. That collection is then piped to the Get-CsClientPinInfo cmdlet, which displays PIN information for each user in the collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUser -LdapFilter "Title=Manager" | Get-CsClientPinInfo ``` @@ -78,6 +79,9 @@ The Get-CsClientPinInfo cmdlet is then used to display PIN information for each ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account for which the PIN should be locked. 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). You can also reference a user account by using the user's Active Directory distinguished name. @@ -88,8 +92,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -98,14 +101,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -114,14 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientPolicy.md similarity index 87% rename from skype/skype-ps/skype/Get-CsClientPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientPolicy.md index 43174d771f..e4f11b0f42 100644 --- a/skype/skype-ps/skype/Get-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsClientPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientpolicy +schema: 2.0.0 +title: Get-CsClientPolicy --- # Get-CsClientPolicy @@ -41,7 +43,7 @@ The Get-CsClientPolicy cmdlet enables you to return information about all the cl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientPolicy ``` @@ -49,7 +51,7 @@ Get-CsClientPolicy In Example 1, Get-CsClientPolicy is called without any additional parameters; this returns a collection of all the client policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientPolicy -Identity SalesPolicy ``` @@ -57,7 +59,7 @@ Get-CsClientPolicy -Identity SalesPolicy In Example 2, Get-CsClientPolicy is used to return the per-user client policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientPolicy -Filter "tag:*" ``` @@ -65,7 +67,7 @@ Get-CsClientPolicy -Filter "tag:*" Example 3 uses the Filter parameter to return all the client policies that have been configured at the per-user scope. The filter value "tag:*" tells Get-CsClientPolicy to return only those policies that have an Identity that begins with the string value "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClientPolicy | Where-Object {$_.DisableSavingIM -eq $True} ``` @@ -74,7 +76,7 @@ The preceding command returns a collection of all the client policies where the To do this, Get-CsClientPolicy is first called without any parameters in order to return a collection of all the client policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the DisableSavingIM property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsClientPolicy | Where-Object {$_.DisableSavingIM -eq $True -and $_.EnableIMAutoArchiving -eq $False} ``` @@ -84,7 +86,7 @@ To do this, the command first calls Get-CsClientPolicy in order to return a coll That collection is then piped to Where-Object, which picks out only those policies that meet both of the following criteria: DisableSavingIM must be equal to True and EnableIMAutoArchiving must be equal to False. The -and operator tells Where-Object that only objects that meet all the specified criteria should be selected. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsClientPolicy | Where-Object {$_.DisableSavingIM -eq $True -or $_.EnableIMAutoArchiving -eq $False} ``` @@ -98,7 +100,30 @@ The -or operator tells Where-Object that any object that meets at least one of t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +For example, to return all the policies configured at the site scope use this syntax: -Filter "site:\*". +To return a collection of all the per-user policies, use this syntax: -Filter "tag:\*". + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the client policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a site policy, use syntax similar to this: -Identity site:Redmond. @@ -109,8 +134,7 @@ If this parameter is omitted, then all the client policies configured for use in ```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 +Aliases: Required: False Position: 1 @@ -119,32 +143,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. -For example, to return all the policies configured at the site scope use this syntax: -Filter "site:\*". -To return a collection of all the per-user policies, use this syntax: -Filter "tag:\*". - -```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the client 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,20 +162,22 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose client policies are being returned. -For example: +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: +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: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsClientVersionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientVersionConfiguration.md index 62a9a4f591..a79a7093b6 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientVersionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientversionconfiguration +schema: 2.0.0 +title: Get-CsClientVersionConfiguration --- # Get-CsClientVersionConfiguration @@ -55,7 +56,7 @@ The technology relies on self-reporting from client applications, and does not a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientVersionConfiguration ``` @@ -63,7 +64,7 @@ Get-CsClientVersionConfiguration In the first example, the Get-CsClientVersionConfiguration cmdlet is called without specifying any additional parameters. This causes the Get-CsClientVersionConfiguration cmdlet to return a collection of all the client version configuration settings currently in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientVersionConfiguration -Identity site:Redmond ``` @@ -71,7 +72,7 @@ Get-CsClientVersionConfiguration -Identity site:Redmond In this example, the Get-CsClientVersionConfiguration cmdlet returns all the client version configuration settings that have the Identity site:Redmond. Because Identities must be unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientVersionConfiguration -Filter "site:*" ``` @@ -80,7 +81,7 @@ Example 3 returns all the client version configuration settings that have been a This is done by including the Filter parameter and the filter value "site:*". That filter value instructs the Get-CsClientVersionConfiguration cmdlet to return only the settings that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClientVersionConfiguration | Where-Object {$_.Enabled -eq $False} ``` @@ -93,7 +94,30 @@ This collection is then piped to the Where-Object cmdlet, which applies a filter ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection (or collections) of client version configuration settings. +To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for) use this syntax: -Filter *EMEA*. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of client version configuration settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -105,8 +129,7 @@ If this parameter is not specified then the Get-CsClientVersionConfiguration cmd ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,32 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection (or collections) of client version configuration settings. -To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for) use this syntax: -Filter *EMEA*. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the client version configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsClientVersionPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicy.md index 79e4188c89..358edac7aa 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientVersionPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientversionpolicy +schema: 2.0.0 +title: Get-CsClientVersionPolicy --- # Get-CsClientVersionPolicy @@ -51,7 +52,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientVersionPolicy ``` @@ -59,7 +60,7 @@ Get-CsClientVersionPolicy In the first example, the Get-CsClientVersionPolicy cmdlet is called without specifying any additional parameters. This causes the Get-CsClientVersionPolicy cmdlet to return a collection of all the client version policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientVersionPolicy -Identity site:Redmond ``` @@ -67,7 +68,7 @@ Get-CsClientVersionPolicy -Identity site:Redmond In Example 2, the Get-CsClientVersionPolicy cmdlet returns all the client version policies that have the Identity site:Redmond. Because Identities must be unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientVersionPolicy -Filter site:* ``` @@ -75,7 +76,7 @@ Get-CsClientVersionPolicy -Filter site:* Example 3 returns all the client version policies that have been configured at the site scope. This is done by including the Filter parameter and the filter value "site:*"; that value instructs the Get-CsClientVersionPolicy cmdlet to return only those policies that have an Identity beginning with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClientVersionPolicy | Select-Object -ExpandProperty Rules ``` @@ -88,7 +89,32 @@ When this property is expanded, detailed information about each rule (including ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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". @@ -103,8 +129,7 @@ If this parameter is not included then all of the client version policies config ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -113,34 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the client version 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +157,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose client version policies are being returned. For example: @@ -162,8 +172,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicyRule.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicyRule.md index 88381a0d58..96555755c1 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicyRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientVersionPolicyRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientversionpolicyrule +schema: 2.0.0 +title: Get-CsClientVersionPolicyRule --- # Get-CsClientVersionPolicyRule @@ -38,21 +39,21 @@ Before the user can log on to Skype for Business Server, the system will check t If a rule exists, Skype for Business Server will then take the action specified by the rule. That action must be one of the following: -- Allow: +- Allow: The user will be allowed to log on. -- AllowAndUpgrade: +- AllowAndUpgrade: The user will be allowed to log on, and his or her copy of Communicator 2007 R2 will automatically be upgraded to the latest version of Skype for Business. Upgrades are carried out using either Microsoft Update or Windows Server Update Services, depending on how you have configured your system. -- AllowWithUrl: +- AllowWithUrl: The user will be allowed to log on, and a message will be displayed pointing the user to a URL where the latest version of Skype for Business can be downloaded and installed. The URL must point to a website that you have created yourself; no such site is created for you when you install Skype for Business Server. -- Block: +- Block: The user will not be allowed to log on. -- BlockAndUpgrade: +- BlockAndUpgrade: The user will not be allowed to log on, but his or her copy of Communicator 2007 R2 will automatically be upgraded to the latest version of Skype for Business. The user can then try to log on by using the new client application. Upgrades are carried out using either Microsoft Update or Windows Server Update Services, depending on how you have configured your system. -- BlockWithUrl: +- BlockWithUrl: The user will not be allowed to log on, but a message will be displayed pointing him or her to a URL where the latest version of Skype for Business can be downloaded and installed. The URL must point to a website that you have created yourself; no such site is created for you when you install Skype for Business Server. @@ -69,21 +70,21 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientVersionPolicyRule ``` Example 1 returns information about all of the client version policy rules currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientVersionPolicyRule -Identity "Global/2336c611-a243-4c5d-994b-eea8a524d0e4" ``` In Example 2, information about a single client version policy rule is returned: the rule with the Identity Global/2336c611-a243-4c5d-994b-eea8a524d0e4. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientVersionPolicyRule -Filter "Global/*" ``` @@ -92,7 +93,7 @@ Example 3 returns all the client version policy rules that have been configured To do this, the command uses the Filter parameter and the filter value "Global/*". That filter value returns only those rules that have an Identity that begins with the string value "Global/". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClientVersionPolicyRule | Where-Object {$_.Enabled -eq $False} ``` @@ -101,7 +102,7 @@ The command shown in Example 4 returns all the client version policy rules that To do this, the command first calls the Get-CsClientVersionPolicy cmdlet in order to return a collection of all the available client policy rules. This collection is then piped to the Where-Object cmdlet, which picks out the rules where the Enabled property is equal to False. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsClientVersionPolicyRule | Where-Object {$_.Action -eq "Block"} ``` @@ -114,56 +115,62 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS -### -Identity -Unique identifier for the client version policy rule to be retrieved. -The Identity of a client version rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). -That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. -Because GUIDs are difficult to remember and to work with, the Examples section in this Help topic lists alternate ways that you can identify the rules to be returned. +### -Filter -If this parameter is not specified all of the client version policy rules configured for use will be returned. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the client version policy rules to be returned. +For example, to return all the rules configured for the Redmond site, use this syntax: + +`-Filter "site:Redmond/*"` + +You cannot use both the Filter and the Identity parameters in the same command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the client version policy rules to be returned. -For example, to return all the rules configured for the Redmond site, use this syntax: +### -Identity -`-Filter "site:Redmond/*"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You cannot use both the Filter and the Identity parameters in the same command. +Unique identifier for the client version policy rule to be retrieved. +The Identity of a client version rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). +That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. +Because GUIDs are difficult to remember and to work with, the Examples section in this Help topic lists alternate ways that you can identify the rules to be returned. + +If this parameter is not specified all of the client version policy rules configured for use will be returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the client version policy rule 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,6 +180,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose client version policy rules are being returned. For example: @@ -185,8 +195,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnector.md similarity index 93% rename from skype/skype-ps/skype/Get-CsCloudCallDataConnector.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnector.md index 9908ff7acb..393205b598 100644 --- a/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnector.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudcalldataconnector applicable: Skype for Business Server 2019 -title: Get-CsCloudCallDataConnector -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscloudcalldataconnector +schema: 2.0.0 +title: Get-CsCloudCallDataConnector --- # Get-CsCloudCallDataConnector @@ -38,13 +39,15 @@ This example returns the CloudCallDataConnector settings stored on-premises. Not ## PARAMETERS ### -LocalStore + +> Applicable: Skype for Business Server 2019 + Retrieves the Call Data Connector 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: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnectorConfiguration.md similarity index 95% rename from skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnectorConfiguration.md index 2e03619361..de302491b6 100644 --- a/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnectorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudcalldataconnectorconfiguration applicable: Skype for Business Server 2019 -title: Get-CsCloudCallDataConnectorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscloudcalldataconnectorconfiguration +schema: 2.0.0 +title: Get-CsCloudCallDataConnectorConfiguration --- # Get-CsCloudCallDataConnectorConfiguration @@ -69,6 +70,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2019 + Enables you to use wildcard characters to return a collection of CloudCallDataConnector configuration settings. For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. To return a collection of all the settings that have the string value "Western" somewhere in their Identity, use this syntax: -Filter Western . @@ -77,7 +81,6 @@ To return a collection of all the settings that have the string value "Western" Type: String Parameter Sets: Filter Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2019 + Indicates the unique identifier for the collection of CloudCallDataConnector configuration settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -98,7 +104,6 @@ If this parameter is not specified, the Get-CsCloudCallDataConnectorConfiguratio Type: XdsIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: 1 Default value: None @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2019 + Retrieves the CloudCallDataConnector configuration 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: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsCloudMeetingPolicy.md similarity index 88% rename from skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCloudMeetingPolicy.md index 0cec065b8a..9a294345b0 100644 --- a/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCloudMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudmeetingpolicy applicable: Skype for Business Online -title: Get-CsCloudMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscloudmeetingpolicy +schema: 2.0.0 +title: Get-CsCloudMeetingPolicy --- # Get-CsCloudMeetingPolicy @@ -31,14 +33,14 @@ Get-CsCloudMeetingPolicy [-Tenant ] [-Filter ] [-LocalStore] [ Applicable: Skype for Business Online + @{Text=} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -67,16 +71,18 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: +For example: `-Identity "SeattlePSTN"` ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -86,13 +92,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -102,12 +110,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + 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` @@ -118,8 +129,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsAgentStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsAgentStatus.md similarity index 85% rename from skype/skype-ps/skype/Get-CsClsAgentStatus.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsAgentStatus.md index cf595df96b..9e6324a1cd 100644 --- a/skype/skype-ps/skype/Get-CsClsAgentStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsAgentStatus.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsagentstatus applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsAgentStatus -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclsagentstatus +schema: 2.0.0 +title: Get-CsClsAgentStatus --- # Get-CsClsAgentStatus @@ -26,7 +27,7 @@ The Get-CsClsAgentStatus cmdlet returns information about the ClsAgent, includin ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsAgentStatus ``` @@ -35,7 +36,7 @@ Returns information about the ClsAgent service on the local machine. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsAgentStatus -DefaultXml ``` @@ -47,14 +48,16 @@ Returns the default.xml file as an XmlDocument object. ## PARAMETERS ### -CacheFileLocalFolders + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the path to search for log files stored on disk. By default the CacheFileLocalFolders path from the Get-CsClsConfiguration cmdlet is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -DefaultXml + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If specified, the cmdlet will return the default.xml file as an XmlDocument object for debugging purposes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsClsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsConfiguration.md index d64818736f..d8d00c976f 100644 --- a/skype/skype-ps/skype/Get-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclsconfiguration +schema: 2.0.0 +title: Get-CsClsConfiguration --- # Get-CsClsConfiguration @@ -50,21 +51,21 @@ The functions carried out by the Get-CsClsConfiguration cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsConfiguration ``` The command shown in Example 1 returns information about all the centralized logging configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsConfiguration -Identity "site:Redmond" ``` In Example 2, information is returned for a single collection of centralized logging configuration settings: the collection applied to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsConfiguration -Identity "site:Redmond" | Select-Object -ExpandProperty Scenarios ``` @@ -74,7 +75,7 @@ In order to do this, the command first retrieves all the centralized logging pro Those property values are then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to "expand" the values found in the Scenarios property. When you expand a property you simply display all the information stored in that property in an easy-to-read fashion. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClsConfiguration | Where-Object {$_.EtlFileRolloverMinutes -gt 60} ``` @@ -83,7 +84,7 @@ In Example 4, information is returned for all the centralizing logging configura To carry out this task, the command first calls the Get-CsClsConfiguration cmdlet without any parameters; this returns a collection of all the centralized logging configuration settings in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the EtlFileRolloverMinutes property is greater than (-gt) 60 minutes. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsClsConfiguration | Where-Object {$_.Scenarios.Name -match "HybridVoice"} ``` @@ -96,6 +97,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a collection (or collections) of centralized logging configuration settings. For example, to return a collection of all the settings configured at the site scope, use this syntax: @@ -104,8 +108,7 @@ For example, to return a collection of all the settings configured at the site s ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +118,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of centralized logging configuration settings you want to return. To refer to the global settings use this syntax: @@ -132,8 +138,7 @@ If this parameter is not specified, then the Get-CsClsConfiguration cmdlet retur ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -143,13 +148,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the centralized logging configuration 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsRegion.md similarity index 89% rename from skype/skype-ps/skype/Get-CsClsRegion.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsRegion.md index 2fbc717fd3..b11594aa62 100644 --- a/skype/skype-ps/skype/Get-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclsregion +schema: 2.0.0 +title: Get-CsClsRegion --- # Get-CsClsRegion @@ -45,21 +46,21 @@ The functions carried out by the Get-CsClsRegion cmdlet are not available in the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsRegion ``` The command shown in Example 1 returns information for all the centralized logging regions configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsRegion -Identity "global/US" ``` In Example 2, information is returned only for the centralized logging region that has the Identity global/US. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsRegion -Filter "global/*" ``` @@ -67,7 +68,7 @@ Get-CsClsRegion -Filter "global/*" Example 3 returns information about all the centralized logging regions configured at the global scope. This is done by calling the Get-CsClsRegion cmdlet along with the Filter parameter; the filter value "global/*" limits the returned data to regions configured at the global scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClsRegion | Where-Object {$_.OtherRegionAccess -match "Europe"} ``` @@ -80,6 +81,9 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a centralized logging region (or regions). For example, to return a collection of all the settings configured at the global scope, use this syntax: @@ -88,8 +92,7 @@ For example, to return a collection of all the settings configured at the global ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the centralized logging region to be returned. A region identity consists of the scope where the region was created followed by the region name. For example, to return a region named US created at the global scope, use the following syntax: @@ -110,8 +116,7 @@ If this parameter is not specified then the Get-CsClsRegion cmdlet returns infor ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -121,13 +126,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the centralized logging configuration data from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsScenario.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClsScenario.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsScenario.md index b6d5b31459..9c137c2734 100644 --- a/skype/skype-ps/skype/Get-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsScenario.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsScenario -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclsscenario +schema: 2.0.0 +title: Get-CsClsScenario --- # Get-CsClsScenario @@ -46,21 +47,21 @@ The functions carried out by the Get-CsClsScenario cmdlet are not available in t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsScenario ``` The command shown in Example 1 returns information about all the centralized logging scenarios currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsScenario -Identity "global/VoiceMail" ``` Example 2 returns information about a single centralized logging scenario: the VoiceMail scenario included in the global settings collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsScenario | Where-Object {$_.Provider.Name -match "AsMcu"} ``` @@ -69,7 +70,7 @@ Example 3 returns information about all the default scenarios currently in use. To do this, the command first calls the Get-CsClsScenario cmdlet without any parameters; that returns a collection of all the available scenarios. That collection is then piped to the Where-Object cmdlet, which picks out only those scenarios that contain (-match) a Provider named "AsMcu". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClsScenario -Identity "global/VoiceMail" | Select-Object -ExpandProperty Provider ``` @@ -83,6 +84,9 @@ In turn, that causes all the data stored in the Provider property to be displaye ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards in order to return one or scenarios. For example, to return all the HybridVoice scenarios, regardless of the scope where these scenarios have been configured, use this syntax: @@ -93,8 +97,7 @@ You cannot use both the Identity parameter and the Filter parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the scenario to be returned. A scenario consists of two parts: the scope where the scenario is configured (that is, the collection of centralized logging configuration settings where the scenario can be found) and the scenario name. For example: @@ -121,8 +127,7 @@ If this parameter is not specified then the Get-CsClsScenario cmdlet will return ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -132,13 +137,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the scenario 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsSearchTerm.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsSearchTerm.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClsSearchTerm.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsSearchTerm.md index df614416c4..f3583b541c 100644 --- a/skype/skype-ps/skype/Get-CsClsSearchTerm.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsSearchTerm.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclssearchterm applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsSearchTerm -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclssearchterm +schema: 2.0.0 +title: Get-CsClsSearchTerm --- # Get-CsClsSearchTerm @@ -48,21 +49,21 @@ The functions carried out by the Get-CsClsSearchTerm cmdlet are not available in ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsSearchTerm ``` The command shown in Example 1 returns information about all the search terms currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsSearchTerm -Identity "global/Phone" ``` In Example 2, information is returned for a single search term: the Phone search term found in the global collection of centralized logging configuration settings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsSearchTerm | Where-Object {$_.Type -eq "URI"} ``` @@ -71,7 +72,7 @@ The command shown in Example 3 returns information for all the URI search terms. To do this, the command first calls the Get-CsClsSearchTerm cmdlet without any parameters; this returns a collection of all the available search terms. That collection is then piped to the Where-Object cmdlet, which picks out only those terms where the Type property is equal to (-eq) URI. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClsSearchTerm | Where-Object {$_.Inserts -match "ItemE164"} ``` @@ -84,6 +85,9 @@ That collection is then piped to the Where-Object cmdlet, which selects any term ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards in order to return one or search terms. For example, to return all the CallID search terms, regardless of the scope where these terms have been configured, use this syntax: @@ -94,8 +98,7 @@ You cannot use both the Identity parameter and the Filter parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the search term to be returned. A search term consists of two parts: the scope where the term is configured (that is, the collection of centralized logging configuration settings where the term can be found) and the term name. For example: @@ -122,8 +128,7 @@ If this parameter is not specified then the Get-CsClsSearchTerm cmdlet will retu ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -133,13 +138,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the search term 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsSecurityGroup.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClsSecurityGroup.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsSecurityGroup.md index 7c79d2ab0a..49ac35cf81 100644 --- a/skype/skype-ps/skype/Get-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsSecurityGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsSecurityGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclssecuritygroup +schema: 2.0.0 +title: Get-CsClsSecurityGroup --- # Get-CsClsSecurityGroup @@ -45,21 +46,21 @@ The functions carried out by the Get-CsClsSecurityGroup cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsSecurityGroup ``` The command shown in Example 1 returns information about all the centralized logging security groups configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsSecurityGroup -Identity "global/HelpDesk" ``` In Example 2, information is returned for a single centralized logging security group: the group with the Identity global/helpdesk. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsSecurityGroup -Filter "global/*" ``` @@ -67,7 +68,7 @@ Get-CsClsSecurityGroup -Filter "global/*" Example 3 returns information for all the centralized logging security groups configured at the global scope. To do this, the Filter parameter is included along with the filter value "global/*"; that filter value limits the returned data to groups configured at the global scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClsSecurityGroup | Where-Object {$_.AccessLevel -eq "RedmondSupport"} ``` @@ -80,6 +81,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a centralized logging security group (or groups). For example, to return a collection of all the groups configured at the global scope, use this syntax: @@ -88,8 +92,7 @@ For example, to return a collection of all the groups configured at the global s ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the centralized logging security group to be returned. A security group identity consists of the scope where the group was created followed by the group name. For example, to return a group named HelpDesk created at the global scope, use the following syntax: @@ -110,8 +116,7 @@ If this parameter is not specified then the Get-CsClsSecurityGroup cmdlet return ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -121,13 +126,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the centralized logging configuration data from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Get-CsCommonAreaPhone.md similarity index 89% rename from skype/skype-ps/skype/Get-CsCommonAreaPhone.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCommonAreaPhone.md index 97dc27f37a..8e8d01d122 100644 --- a/skype/skype-ps/skype/Get-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCommonAreaPhone.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCommonAreaPhone -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscommonareaphone +schema: 2.0.0 +title: Get-CsCommonAreaPhone --- # Get-CsCommonAreaPhone @@ -47,7 +48,7 @@ Optional parameters provide different ways for you to filter information; for ex ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCommonAreaPhone ``` @@ -55,7 +56,7 @@ Get-CsCommonAreaPhone The command shown in Example 1 returns information about all the common area phones configured for use in the organization. This is done by calling the Get-CsCommonAreaPhone cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCommonAreaPhone -Filter {DisplayName -eq "Building 14 Lobby"} ``` @@ -63,7 +64,7 @@ Get-CsCommonAreaPhone -Filter {DisplayName -eq "Building 14 Lobby"} In Example 2, the common area phone with the Active Directory display name "Building 14 Lobby" is returned. This task is carried out by including the Filter parameter and the filter value {DisplayName -eq "Building 14 Lobby"}; that filter value limits returned objects to common area phones where the DisplayName property is equal to "Building 14 Lobby". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCommonAreaPhone -Filter {DisplayName -like "Building 14*"} ``` @@ -72,7 +73,7 @@ Example 3 returns all the common area phones that have an Active Directory displ To do this, the Get-CsCommonAreaPhone cmdlet is called, along with the Filter parameter and the filter value {DisplayName -like "Building 14*"}. The filter value uses the -like operator and the wildcard string "Building 14*" to limit returned data to phones where the DisplayName property begins with "Building 14" (for example, "Building 14 Lobby", "Building 14 Cafeteria", etc.). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsCommonAreaPhone -Filter {LineUri -eq "tel:+14255551234"} ``` @@ -80,7 +81,7 @@ Get-CsCommonAreaPhone -Filter {LineUri -eq "tel:+14255551234"} In Example 4, a single common area phone is returned: the phone that has a LineUri property equal to "tel:+14255551234". Because LineUris must be unique, this command will never return more than a single item. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsCommonAreaPhone -Filter {DialPlan -eq $Null} ``` @@ -89,7 +90,7 @@ The command shown in Example 5 returns information about all the common area pho This is done by using the Filter parameter and the filter value {DialPlan -eq $Null}; that limits returned data to phones where the DialPlan property is equal to a null value. If a common area phone has not explicitly been assigned a dial plan, then it automatically uses the global dial plan or, if one exists, the dial plan assigned to the site. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsCommonAreaPhone -OU "ou=Telecommunications,dc=litwareinc,dc=com" ``` @@ -100,25 +101,10 @@ To do this, the Get-CsCommonAreaPhone cmdlet is called along with the OU paramet ## PARAMETERS -### -Identity -Unique identifier for the common area phone. -Common area phones are identified using the Active Directory distinguished name (DN) of the associated contact object. -By default, common area phones use a globally unique identifier (GUID) as their common name, which means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsCommonAreaPhone cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. @@ -128,8 +114,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +124,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the Fully Qualified Domain Name (FQDN) of that computer (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +143,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. For example, you can limit returned data to common area phone contact objects that have been assigned a specific voice policy, or contacts that have not been assigned a specific voice policy. @@ -164,8 +154,7 @@ The Filter parameter uses the same Windows PowerShell filtering syntax that is u ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,7 +163,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the common area phone. +Common area phones are identified using the Active Directory distinguished name (DN) of the associated contact object. +By default, common area phones use a globally unique identifier (GUID) as their common name, which means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -LdapFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). For example, you can limit returned data to contact objects that have been assigned to a specific department or are located in a specific building. @@ -188,8 +200,7 @@ In the preceding filter, "l" (a lowercase L) represents the Active Directory att ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,19 +210,21 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return contact objects from a specific Active Directory organizational unit (OU). The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable -- common area phone information will be returned from each of these OUs. -When specifying an OU, use the distinguished name of that container; for example: +When specifying an OU, use the distinguished name of that container; for example: `-OU "OU=Finance,dc=litwareinc,dc=com"` ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,6 +234,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return seven common area phones (regardless of how many common area phones 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 phones will be returned. @@ -232,8 +248,7 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Get-CsComputer.md similarity index 84% rename from skype/skype-ps/skype/Get-CsComputer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsComputer.md index 295846eabe..bb007895da 100644 --- a/skype/skype-ps/skype/Get-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscomputer +schema: 2.0.0 +title: Get-CsComputer --- # Get-CsComputer @@ -37,14 +38,14 @@ Alternatively, you can use optional parameters such as Identity, Filter, or Pool ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsComputer ``` In Example 1 the Get-CsComputer cmdlet is used to return information about all the computers that perform service roles within your Skype for Business Server 2015 infrastructure. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsComputer -Filter "*.litwareinc.com" ``` @@ -52,14 +53,14 @@ Get-CsComputer -Filter "*.litwareinc.com" The command shown in Example 2 uses the Filter parameter to return only those service role computers that are part of the litwareinc.com domain. The wildcard string *.litwareinc.com restricts the returned information to computers that have an FQDN that ends with the string value ".litwareinc.com". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsComputer -Identity "atl-cs-001.litwareinc.com" ``` In Example 3, the Identity parameter is used to limit the returned data to the one computer that has the FQDN atl-cs-001.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsComputer -Pool "atl-cs-001.litwareinc.com" ``` @@ -69,9 +70,31 @@ In Example 4, the Pool parameter is used to return information about all the com ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the Identity of the computer (or computers) to be returned. +For example, this command returns information about all the computers that have an Identity that begins with the string value "atl-": -Filter "atl-*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of the computer to be returned. -For example: +For example: `-Identity "atl-cs-001.litwareinc.com".` @@ -80,8 +103,7 @@ If this parameter is not specified, all of the computers running Skype for Busin ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -90,15 +112,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the Identity of the computer (or computers) to be returned. -For example, this command returns information about all the computers that have an Identity that begins with the string value "atl-": -Filter "atl-*". +### -Local + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, returns information only for the local computer. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -108,30 +131,16 @@ Accept wildcard characters: False ``` ### -Pool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a Skype for Business Server pool. When you use this parameter, information about all the computers in the specified pool will be returned. ```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 -``` - -### -Local -When present, returns information only for the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDirectory.md similarity index 88% rename from skype/skype-ps/skype/Get-CsConferenceDirectory.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConferenceDirectory.md index aaeb78a46a..0adf558721 100644 --- a/skype/skype-ps/skype/Get-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDirectory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConferenceDirectory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconferencedirectory +schema: 2.0.0 +title: Get-CsConferenceDirectory --- # Get-CsConferenceDirectory @@ -42,14 +43,14 @@ The Get-CsConferenceDirectory cmdlet enables you to return information about all ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsConferenceDirectory ``` The command shown in Example 1 returns information about all the conference directories configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferenceDirectory -Identity 2 ``` @@ -57,7 +58,7 @@ Get-CsConferenceDirectory -Identity 2 Example 2 returns information about the conference directory with the Identity 2. Because identities must be unique this command will never return more than a single conference directory. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferenceDirectory | Where-Object {$_.ServiceID -match "UserServer:atl-cs-001.litwareinc.com"} ``` @@ -69,49 +70,55 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS -### -Identity -Numeric identifier (for example, 7) of the conference directory to be returned. -If this parameter is omitted, then the Get-CsConferenceDirectory cmdlet returns information about all the conference directories in use in your organization. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards to specify the Identity of the conference directory (or directories) to be retrieved. +Because directory Identities are numeric, this parameter might be of minimal value. +However, this syntax will return all the conference directories that have an Identity that begins with the number 3: -Filter "3*". ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards to specify the Identity of the conference directory (or directories) to be retrieved. -Because directory Identities are numeric, this parameter might be of minimal value. -However, this syntax will return all the conference directories that have an Identity that begins with the number 3: -Filter "3*". +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Numeric identifier (for example, 7) of the conference directory to be returned. +If this parameter is omitted, then the Get-CsConferenceDirectory cmdlet returns information about all the conference directories in use in your organization. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the conference directory 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDisclaimer.md similarity index 89% rename from skype/skype-ps/skype/Get-CsConferenceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConferenceDisclaimer.md index 6ce2b822e0..50c1e86fdc 100644 --- a/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConferenceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconferencedisclaimer +schema: 2.0.0 +title: Get-CsConferenceDisclaimer --- # Get-CsConferenceDisclaimer @@ -40,7 +41,7 @@ The Get-CsConferenceDisclaimer cmdlet enables you to view the body and header of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CSConferenceDisclaimer ``` @@ -51,25 +52,10 @@ Because you are limited to a single disclaimer (configured at the global scope), ## PARAMETERS -### -Identity -Unique Identity of the conference disclaimer. -Because you can only have a single, global instance of the conference disclaimer, you do not need to specify an Identity when calling the Get-CsConferenceDisclaimer cmdlet. -You can, however, use the following syntax to reference the global disclaimer: -Identity global. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Filter -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Filter Enables you to use wildcard values when referencing a conference disclaimer. Because you can only have a single, global instance of the conference disclaimer, there is really no reason to ever use the Filter parameter. However, you can use the following syntax to reference the global disclaimer: -Filter "g*". @@ -78,8 +64,7 @@ That syntax brings back all the conference disclaimers that have an Identity tha ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,14 +73,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique Identity of the conference disclaimer. +Because you can only have a single, global instance of the conference disclaimer, you do not need to specify an Identity when calling the Get-CsConferenceDisclaimer cmdlet. +You can, however, use the following syntax to reference the global disclaimer: -Identity global. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the conference disclaimer 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConferencingConfiguration.md index 381a5744ae..48b1e89149 100644 --- a/skype/skype-ps/skype/Get-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconferencingconfiguration +schema: 2.0.0 +title: Get-CsConferencingConfiguration --- # Get-CsConferencingConfiguration @@ -48,7 +49,7 @@ The Get-CsConferencingConfiguration cmdlet provides a way for administrators to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsConferencingConfiguration ``` @@ -56,7 +57,7 @@ Get-CsConferencingConfiguration Example 1 returns information about all the conferencing configuration settings currently in use in the organization. This is done by calling the Get-CsConferencingConfiguration cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingConfiguration -Identity site:Redmond ``` @@ -64,7 +65,7 @@ Get-CsConferencingConfiguration -Identity site:Redmond In Example 2, conferencing configuration information is returned for the Redmond site (-Identity site:Redmond). Because Identities must be unique, this command will always return, at most, a single collection of conferencing configuration settings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingConfiguration -Filter "site:*" ``` @@ -72,7 +73,7 @@ Get-CsConferencingConfiguration -Filter "site:*" The command shown in Example 3 returns information about all the conferencing configuration settings that have been applied at the site scope. To do this, the Get-CsConferencingConfiguration cmdlet is called along with the Filter parameter; the filter value "site:*" ensures that only settings that have an Identity that begins with the string value 'site:" are returned. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsConferencingConfiguration | Where-Object {$_.Organization -ne "Litwareinc"} ``` @@ -81,7 +82,7 @@ Example 4 returns information about all the conferencing configuration settings To carry out this task, the command first calls the Get-CsConferencingConfiguration cmdlet without any parameters; this returns a collection of all the conferencing configuration settings used in the organization. The resulting collection is then piped to the Where-Object cmdlet, which selects only those settings where the Organization property is not equal to Litwareinc. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsConferencingConfiguration | Where-Object {$_.MaxContentStorageMB -gt 100} ``` @@ -94,55 +95,61 @@ This collection is then piped to the Where-Object cmdlet, which picks out those ## PARAMETERS -### -Identity -Unique identifier for the collection of conferencing configuration settings to be retrieved. -To retrieve the global settings, use this syntax: -Identity global. -To retrieve settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". -To retrieve settings configured at the service scope, use syntax similar to this: -Identity "service:ConferencingServer:atl-cs-001.litwareinc.com". +### -Filter -If this parameter is not included, then the Get-CsConferencingConfiguration cmdlet will return all the conferencing configuration settings currently in use in your organization. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the Identity of the conferencing configuration settings to be returned. +For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". +This syntax returns all the settings configured at the service scope: -Filter "service:*". + +Note that you cannot use both the Identity and the Filter parameters in the same command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Identity of the conferencing configuration settings to be returned. -For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". -This syntax returns all the settings configured at the service scope: -Filter "service:*". +### -Identity -Note that you cannot use both the Identity and the Filter parameters in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the collection of conferencing configuration settings to be retrieved. +To retrieve the global settings, use this syntax: -Identity global. +To retrieve settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". +To retrieve settings configured at the service scope, use syntax similar to this: -Identity "service:ConferencingServer:atl-cs-001.litwareinc.com". + +If this parameter is not included, then the Get-CsConferencingConfiguration cmdlet will return all the conferencing configuration settings currently in use in your organization. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the conferencing configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsConferencingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConferencingPolicy.md index 570ad8b1b5..8561063bda 100644 --- a/skype/skype-ps/skype/Get-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconferencingpolicy +schema: 2.0.0 +title: Get-CsConferencingPolicy --- # Get-CsConferencingPolicy @@ -53,7 +55,7 @@ The Get-CsConferencingPolicy cmdlet provides a way for you to return information ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsConferencingPolicy ``` @@ -61,7 +63,7 @@ Get-CsConferencingPolicy The first example returns a collection of all the conferencing policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingPolicy -Identity "Global" ``` @@ -69,7 +71,7 @@ Get-CsConferencingPolicy -Identity "Global" In Example 2, the Identity parameter is used to limit the retrieved information to conferencing policies that have an identity equal to Global. Because policy Identities must be unique, this command returns a single policy: the Global conferencing policy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingPolicy -Filter "tag:*" ``` @@ -77,7 +79,7 @@ Get-CsConferencingPolicy -Filter "tag:*" Example 3 uses the Filter parameter to return a collection of all the conferencing policies that have been configured at the per-user scope. The wildcard value "tag:*" tells Windows PowerShell to limit the returned data to conferencing policies that have an identity beginning with the string value "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsConferencingPolicy | Where-Object {$_.MaxMeetingSize -gt 100} ``` @@ -88,7 +90,7 @@ That collection is then piped to the Where-Object cmdlet, which applies a filter -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsConferencingPolicy | Where-Object {$_.AllowExternalUsersToSaveContent -eq $True -and $_.AllowExternalUserControl -eq $True} ``` @@ -98,7 +100,7 @@ To do this, the command calls the Get-CsConferencingPolicy cmdlet without any ad That collection is then piped to the Where-Object cmdlet, which picks out only those policies where both AllowExternalUsersToSaveContent and AllowExternalUserControl are True. The -and operator tells the Where-Object cmdlet that an object must meet all the specified criteria in order to be returned. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsConferencingPolicy | Where-Object {$_.AllowExternalUsersToSaveContent -eq $True -or $_.AllowExternalUserControl -eq $True} ``` @@ -109,7 +111,7 @@ To do this, the command calls the Get-CsConferencingPolicy cmdlet without any ad That collection is then piped to the Where-Object cmdlet, which picks out only those policies where either AllowExternalUsersToSaveContent and/or AllowExternalUserControl are equal to True. The -or operator tells the Where-Object cmdlet that an object must meet just one of the specified criteria in order to be returned. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsConferencingPolicy -ApplicableTo "kenmyer@litwareinc.com" ``` @@ -121,31 +123,35 @@ Note that this command requires the Office 365 UsageLocation property to be conf ## PARAMETERS -### -Identity -Unique identifier for the conferencing policy to be retrieved. -Conferencing policies can be configured at the global scope or at the per-user scope. -To retrieve the global policy, use this syntax: -Identity global. -To retrieve a per-user policy use syntax similar to this: -Identity SalesConferencingPolicy. +### -ApplicableTo -If this parameter is not included, the Get-CsConferencingPolicy cmdlet will return a collection of all the conferencing policies configured for use in your organization. +> Applicable: Skype for Business Online -Note that wildcards are not allowed when specifying an Identity. -Use the Filter parameter if you need to use wildcards when specifying a conferencing policy. +Returns a list of the conferencing 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-CsConferencingPolicy -ApplicableTo "kenmyer@litwareinc.com"` + +The ApplicableTo parameter is useful because it's possible that only some of the available per-user conferencing 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-CsConferencingPolicy 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. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UserIdParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters when specifying the conferencing policy (or policies) to be returned. For example, this syntax returns all the policies configured at the per-user scope @@ -154,8 +160,7 @@ For example, this syntax returns all the policies configured at the per-user sco ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,40 +169,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the conferencing policy data from the local replica of the Central Management store rather than from the Central Management store itself. +### -Identity -This parameter is not used with Skype for Business Online. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the conferencing policy to be retrieved. +Conferencing policies can be configured at the global scope or at the per-user scope. +To retrieve the global policy, use this syntax: -Identity global. +To retrieve a per-user policy use syntax similar to this: -Identity SalesConferencingPolicy. + +If this parameter is not included, the Get-CsConferencingPolicy cmdlet will return a collection of all the conferencing policies configured for use in your organization. + +Note that wildcards are not allowed when specifying an Identity. +Use the Filter parameter if you need to use wildcards when specifying a conferencing policy. ```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 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicableTo -Returns a list of the conferencing 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: +### -Include -`Get-CsConferencingPolicy -ApplicableTo "kenmyer@litwareinc.com"` +> Applicable: Skype for Business Online -The ApplicableTo parameter is useful because it's possible that only some of the available per-user conferencing 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-CsConferencingPolicy 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. +PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly ```yaml -Type: UserIdParameter +Type: PolicyFilter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -205,14 +212,19 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Include -PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly + +### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves the conferencing policy data from the local replica of the Central Management store rather than from the Central Management store itself. + +This parameter is not used with Skype for Business Online. ```yaml -Type: PolicyFilter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -222,13 +234,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md b/skype/skype-ps/SkypeForBusiness/Get-CsConfigurationStoreLocation.md similarity index 88% rename from skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConfigurationStoreLocation.md index fdc95a47a5..a458ace3cb 100644 --- a/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConfigurationStoreLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconfigurationstorelocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConfigurationStoreLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconfigurationstorelocation +schema: 2.0.0 +title: Get-CsConfigurationStoreLocation --- # Get-CsConfigurationStoreLocation @@ -34,14 +35,14 @@ The Get-CsConfigurationStoreLocation cmdlet is used to report back the SQL Serve ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsConfigurationStoreLocation ``` The command shown in Example 1 returns the SQL Server path to the computer (or pool) hosting the Central Management store. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConfigurationStoreLocation -Report "C:\Logs\ConfigurationStore.html" ``` @@ -52,6 +53,9 @@ Example 2 is a variation of the command shown in Example 1; in this case, howeve ## PARAMETERS ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a domain controller where global settings are stored. If global settings are stored in the Active Directory System container, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -59,8 +63,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -70,16 +73,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\ConfigurationStore.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsConversationHistoryConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConversationHistoryConfiguration.md index 8c4b36089d..9b0b492d8a 100644 --- a/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConversationHistoryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconversationhistoryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConversationHistoryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconversationhistoryconfiguration +schema: 2.0.0 +title: Get-CsConversationHistoryConfiguration --- # Get-CsConversationHistoryConfiguration @@ -38,7 +39,7 @@ There is no option for creating additional conversation history settings at the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsConversationHistoryConfiguration ``` @@ -50,6 +51,9 @@ Note that you will always get back just one collection of settings; that's becau ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard values when referencing a collection of conversation history configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings: @@ -61,8 +65,7 @@ That syntax brings back all the conversation history configuration settings that ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the conversation history configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsConversationHistoryConfiguration cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -81,8 +87,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the conversation history configuration 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsCpsConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Get-CsCpsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCpsConfiguration.md index 2859c7b997..623d57c397 100644 --- a/skype/skype-ps/skype/Get-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCpsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCpsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscpsconfiguration +schema: 2.0.0 +title: Get-CsCpsConfiguration --- # Get-CsCpsConfiguration @@ -42,21 +43,21 @@ In addition, Call Park service can be configured to play music on hold to the ca ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCpsConfiguration ``` Example 1 retrieves a collection of all the Call Park service configurations that have been defined for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCpsConfiguration -Identity site:Redmond1 ``` Example 2 retrieves only the Call Park service configurations with the Identity site:Redmond1. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCpsConfiguration -Filter site:* ``` @@ -64,7 +65,7 @@ Get-CsCpsConfiguration -Filter site:* In Example 3, the Filter parameter is used to return all the Call Park service configurations that have been configured at the site scope. The wildcard string site:* tells the Get-CsCpsConfiguration cmdlet to return only those settings where the Identity begins with the string value site:. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsCpsConfiguration -Filter *:re* ``` @@ -72,7 +73,7 @@ Get-CsCpsConfiguration -Filter *:re* As in Example 3, in this example we use the Filter parameter to retrieve a subset of all the defined Call Park service configurations. In this case, we filter on the string *:re*, which will return Call Park configurations for all sites with names beginning with the letters re, such as Redmond1, Redmond2, and RemoteComputer. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsCpsConfiguration | Where-Object {$_.EnableMusicOnHold -eq $False} ``` @@ -84,47 +85,53 @@ That collection is then piped to the Where-Object cmdlet, which, in turn, applie ## PARAMETERS -### -Identity -The unique identifier of the Call Park service configuration you want to retrieve. -This identifier will be either Global or site:\, where \ is the name of the site to which the configuration applies. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to do a wildcard search to retrieve only those configurations with Identity values matching the wildcard string. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Allows you to do a wildcard search to retrieve only those configurations with Identity values matching the wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the Call Park service configuration you want to retrieve. +This identifier will be either Global or site:\, where \ is the name of the site to which the configuration applies. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Call Park service information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md b/skype/skype-ps/SkypeForBusiness/Get-CsDatabaseMirrorState.md similarity index 91% rename from skype/skype-ps/skype/Get-CsDatabaseMirrorState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDatabaseMirrorState.md index ab7cc8b8ab..9ff2c9d852 100644 --- a/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDatabaseMirrorState.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsDatabaseMirrorState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdatabasemirrorstate +schema: 2.0.0 +title: Get-CsDatabaseMirrorState --- # Get-CsDatabaseMirrorState @@ -47,7 +48,7 @@ The functions carried out by the Get-CsDatabaseMirrorState cmdlet are not availa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDatabaseMirrorState -PoolFqdn "atl-cs-001.litwareinc.com" -DatabaseType Monitoring ``` @@ -57,26 +58,10 @@ The command shown in Example 1 returns the state of the database mirror assigned ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool whose database mirroring state is being checked. -For example: - -`-PoolFqdn "atl-cs-001.litwareinc.com"` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -DatabaseType -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -DatabaseType Type of database whose mirror state is being checked. Allowed values for Lync Server 2013 are: @@ -106,8 +91,7 @@ Allowed values for Skype for Business Server 2015 are: ```yaml Type: DatabaseNameType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -117,13 +101,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the backup mirror state from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -132,7 +118,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name of the pool whose database mirroring state is being checked. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -141,8 +151,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateConfiguration.md index dcc4810931..9167cbbc26 100644 --- a/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDeviceUpdateConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdeviceupdateconfiguration +schema: 2.0.0 +title: Get-CsDeviceUpdateConfiguration --- # Get-CsDeviceUpdateConfiguration @@ -43,7 +44,7 @@ You can use the Get-CsDeviceUpdateConfiguration cmdlet to return information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDeviceUpdateConfiguration ``` @@ -51,14 +52,14 @@ Get-CsDeviceUpdateConfiguration The command shown in Example 1 returns a collection of all the device update configuration settings currently in use in the organization. Calling the Get-CsDeviceUpdateConfiguration cmdlet without any additional parameters returns all the device update settings currently in use. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDeviceUpdateConfiguration -Identity Global ``` In Example 2, information is returned for the global device update configuration settings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDeviceUpdateConfiguration -Filter site:* ``` @@ -66,7 +67,7 @@ Get-CsDeviceUpdateConfiguration -Filter site:* Example 3 demonstrates the use of the Filter parameter. The filter value "site:*" returns a collection of all the device update configuration settings applied at the site scope; that's because these settings all have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDeviceUpdateConfiguration | Where-Object {$_.MaxLogFileSize -gt 2048000} ``` @@ -75,7 +76,7 @@ Example 4 returns all the device update configuration settings where the MaxLogF To do this, the Get-CsDeviceUpdateConfiguration cmdlet is used to return a collection of all the device update configuration settings currently in use. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the MaxLogFileSize property is greater than 2048000. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDeviceUpdateConfiguration | Where-Object {$_.ValidLogFileTypes -like "*Watson*"} ``` @@ -87,7 +88,31 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way for you to use wildcard characters when specifying device update configuration settings. +For example, to return a collection of all the configuration settings that have been applied at the site scope, use this syntax: -Filter "site:*". +To return all the settings that have the term "EMEA" in their Identity, use this syntax: -Filter "*EMEA*". +Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other device update configuration properties. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the device update configuration settings to be retrieved. To refer to the global settings, use this syntax: -Identity global. To refer to site settings, use syntax similar to this: -Identity site:Redmond. @@ -97,8 +122,7 @@ If you need to use wildcards, use the Filter parameter instead. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -107,33 +131,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Provides a way for you to use wildcard characters when specifying device update configuration settings. -For example, to return a collection of all the configuration settings that have been applied at the site scope, use this syntax: -Filter "site:*". -To return all the settings that have the term "EMEA" in their Identity, use this syntax: -Filter "*EMEA*". -Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other device update configuration properties. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the device update configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateRule.md similarity index 88% rename from skype/skype-ps/skype/Get-CsDeviceUpdateRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateRule.md index 0e5442fdfb..2f6c51ed61 100644 --- a/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDeviceUpdateRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdeviceupdaterule +schema: 2.0.0 +title: Get-CsDeviceUpdateRule --- # Get-CsDeviceUpdateRule @@ -42,7 +43,7 @@ The Get-CsDeviceUpdateRule cmdlet enables you to return information about the de ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDeviceUpdateRule ``` @@ -50,14 +51,14 @@ Get-CsDeviceUpdateRule The command in Example 1 returns information about all the device update rules that have been applied in your organization. Calling the Get-CsDeviceUpdateRule cmdlet without any additional parameters always returns the complete collection of device update rules. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 ``` The command shown in Example 2 returns information about the device update rule with the Identity "WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* ``` @@ -66,7 +67,7 @@ Example 3 returns information about all the device update rules configured for t To accomplish this task, the Filter parameter is used along with the filter value "WebServer:atl-cs-001.litwareinc.com*". That filter limits the returned data to device update rules that have an Identity that begins with the string value "service:WebServer:atl-cs-001.litwareinc.com." -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} ``` @@ -75,7 +76,7 @@ Example 4 returns all the device update rules where the Brand property is equal To do this, the Get-CsDeviceUpdateRule cmdlet is called in order to return a collection of all the device update rules in the organization. That collection is then piped to the Where-Object cmdlet, which selects only those rules where the Brand is equal to "LG-Nortel". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDeviceUpdateRule | Where-Object {$_.ApprovedVersion -eq $Null} ``` @@ -85,7 +86,7 @@ This is done by using the Get-CsDeviceUpdateRules cmdlet to return a collection In turn, the Where-Object cmdlet selects only those rules where the Approved property is equal to a null value. If the Approved property is null, it means that these rules are not approved. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsDeviceUpdateRule | Where-Object {$_.ApprovedVersion -ne $Null -and $_.Brand -eq "LG-Nortel"} ``` @@ -97,56 +98,62 @@ That collection is then piped to the Where-Object cmdlet, which filters the coll ## PARAMETERS -### -Identity -Unique identifier for the device update rule. -The Identity of a device update rule is composed of two parts: the service scope where the rule has been applied (for example, service:WebServer:atl-cs-001.litwareinc.com) and the globally unique identifier (GUID) that was pre-assigned to the rule (for example, d5ce3c10-2588-420a-82ac-dc2d9b1222ff9). -Based on this, the Identity for a given device update rule will look something like this: +### -Filter -`"service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 "` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Wildcards are not allowed when specifying an Identity. -Use the Filter parameter if you want to use wildcards when specifying a rule. +Enables you to use wildcards when specifying the Identity of a device update rule or set of rules. +For example, to return all the device update rules for WebServer:atl-cs-001.litwareinc.com use this filter value: + +`"service:WebServer:atl-cs-001.litwareinc.com*"` ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Identity of a device update rule or set of rules. -For example, to return all the device update rules for WebServer:atl-cs-001.litwareinc.com use this filter value: +### -Identity -`"service:WebServer:atl-cs-001.litwareinc.com*"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the device update rule. +The Identity of a device update rule is composed of two parts: the service scope where the rule has been applied (for example, service:WebServer:atl-cs-001.litwareinc.com) and the globally unique identifier (GUID) that was pre-assigned to the rule (for example, d5ce3c10-2588-420a-82ac-dc2d9b1222ff9). +Based on this, the Identity for a given device update rule will look something like this: + +`"service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 "` + +Wildcards are not allowed when specifying an Identity. +Use the Filter parameter if you want to use wildcards when specifying a rule. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the device update rule 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticConfiguration.md index e828788cb7..8cbbe00cba 100644 --- a/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDiagnosticConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdiagnosticconfiguration +schema: 2.0.0 +title: Get-CsDiagnosticConfiguration --- # Get-CsDiagnosticConfiguration @@ -46,7 +47,7 @@ The Get-CsDiagnosticConfiguration cmdlet enables you to return information about ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDiagnosticConfiguration ``` @@ -54,14 +55,14 @@ Get-CsDiagnosticConfiguration In Example 1, information is returned for all of the diagnostic configuration settings currently in use in the organization. This is done by calling the Get-CsDiagnosticConfiguration cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDiagnosticConfiguration -Identity site:Redmond ``` Example 2 returns information for the diagnostic configuration settings applied to the Redmond site (-Identity site:Redmond). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDiagnosticConfiguration -Identity site:Redmond | Select-Object -ExpandProperty Filter ``` @@ -71,7 +72,7 @@ To do this, the command first uses the Get-CsDiagnosticConfiguration cmdlet to r This information is then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to "expand" the value of the Filter property. Expanding the Filter property enables you to access the properties and property values for the individual filters maintained in the diagnostic configuration settings. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDiagnosticConfiguration -Identity global | Select-Object -ExpandProperty Filter | Where-Object {$_.Uri -contains "sip:diagnostics@litwareinc.com"} ``` @@ -81,7 +82,7 @@ To do this, the command first uses the Get-CsDiagnosticConfiguration cmdlet to r This information is then piped to the Select-Object cmdlet, which expands the Filter property. The individual filter objects are then piped to the Select-Object cmdlet, which extracts only those filters where the Uri property includes the SIP address sip:diagnostics@litwareinc.com. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDiagnosticConfiguration -Identity global | Select-Object -ExpandProperty Filter | Where-Object {$_.Uri -notcontains "sip:diagnostics@litwareinc.com"} ``` @@ -94,53 +95,59 @@ Those filter objects are then piped to the Select-Object cmdlet, which selects o ## PARAMETERS -### -Identity -Unique identifier for the diagnostic configuration settings to be returned. -To return settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". -To return the global settings, use this syntax: -Identity global. +### -Filter -If this parameter is not specified, then all of the diagnostics configuration settings currently in use will be returned. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the settings collection (or collections) to be returned. +For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". + +Note that you cannot use both the Filter and the Identity parameters in the same command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the settings collection (or collections) to be returned. -For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". +### -Identity -Note that you cannot use both the Filter and the Identity parameters in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the diagnostic configuration settings to be returned. +To return settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". +To return the global settings, use this syntax: -Identity global. + +If this parameter is not specified, then all of the diagnostics configuration settings currently in use will be returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the diagnostic configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticHeaderConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticHeaderConfiguration.md index 70f111e8de..3626c1153c 100644 --- a/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticHeaderConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDiagnosticHeaderConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdiagnosticheaderconfiguration +schema: 2.0.0 +title: Get-CsDiagnosticHeaderConfiguration --- # Get-CsDiagnosticHeaderConfiguration @@ -51,7 +52,7 @@ The Get-CsDiagnosticHeaderConfiguration cmdlet provides a way for you to retriev ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDiagnosticHeaderConfiguration ``` @@ -59,14 +60,14 @@ Get-CsDiagnosticHeaderConfiguration The preceding command returns information about all the diagnostic header configuration settings currently in use in the organization. This is done by calling the Get-CsDiagnosticHeaderConfiguration cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDiagnosticHeaderConfiguration -Identity site:Redmond ``` In Example 2, a single collection of diagnostic header configuration settings is returned: the collection that has the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDiagnosticHeaderConfiguration -Filter "service:*" ``` @@ -74,7 +75,7 @@ Get-CsDiagnosticHeaderConfiguration -Filter "service:*" The command shown in Example 3 returns all the diagnostic header settings that have been configured at the service scope. This is done by calling the Get-CsDiagnosticHeaderConfiguration cmdlet and the Filter parameter; the filter value "service:*" ensures that the only settings that are returned are those that have an Identity that begins with the characters "service:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True} ``` @@ -83,7 +84,7 @@ Example 4 returns all the diagnostic header configuration settings that allow se To perform this task, the command first calls the Get-CsDiagnosticHeaderConfiguration cmdlet without any parameters; this returns a collection of all the diagnostic header settings currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the SendToExternalNetworks property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True -or $_.SendToOutsideUnauthenticatedUsers -eq $True} ``` @@ -100,55 +101,61 @@ To require that settings meet both of the specified criteria, use the -and opera ## PARAMETERS -### -Identity -Unique identifier for the diagnostic header configuration settings to be returned. -To return settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". -To return settings configured at the service scope, use syntax like this: -Identity "service:EdgeServer:atl-edge-001.litwareinc.com". -To return the global settings, use this syntax: -Identity global. +### -Filter -If this parameter is not specified, then all the diagnostic header configuration settings currently in use will be returned. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the settings collection (or collections) to be returned. +For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". +This syntax returns all the settings configured at the service scope: -Filter "service:*". + +Note that you cannot use both the Filter and the Identity parameters in the same command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the settings collection (or collections) to be returned. -For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". -This syntax returns all the settings configured at the service scope: -Filter "service:*". +### -Identity -Note that you cannot use both the Filter and the Identity parameters in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the diagnostic header configuration settings to be returned. +To return settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". +To return settings configured at the service scope, use syntax like this: -Identity "service:EdgeServer:atl-edge-001.litwareinc.com". +To return the global settings, use this syntax: -Identity global. + +If this parameter is not specified, then all the diagnostic header configuration settings currently in use will be returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the diagnostic header configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingAccessNumber.md similarity index 89% rename from skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingAccessNumber.md index fe50bf5290..2c48363823 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingAccessNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDialInConferencingAccessNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdialinconferencingaccessnumber +schema: 2.0.0 +title: Get-CsDialInConferencingAccessNumber --- # Get-CsDialInConferencingAccessNumber @@ -59,7 +60,7 @@ This is simply the way the cmdlet handles imported dial-in conferencing access n ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDialInConferencingAccessNumber ``` @@ -67,7 +68,7 @@ Get-CsDialInConferencingAccessNumber The command shown in Example 1 returns a collection of all the dial-in conferencing access numbers configured for use in the organization. Calling the Get-CsDialInConferencingAccessNumber cmdlet without any additional parameters always returns a collection of all the available dial-in access numbers. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialInConferencingAccessNumber -Identity sip:RedmondDialIn@litwareinc.com ``` @@ -75,7 +76,7 @@ Get-CsDialInConferencingAccessNumber -Identity sip:RedmondDialIn@litwareinc.com In Example 2, the dial-in conferencing access number with the Identity sip:RedmondDialIn@litwareinc.com is returned. Because identities must be unique, this command will never return more than one access number. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDialInConferencingAccessNumber -Region "Redmond" ``` @@ -85,21 +86,21 @@ To do this, the Get-CsDialInConferencingAccessNumber cmdlet is called along with Specifying "Redmond" as the parameter value causes the Get-CsDialInConferencingAccessNumber cmdlet to return all the numbers where "Redmond" appears in the list of associated regions. For example, an access number that only listed Redmond as a region would be returned, as would an access number that listed both Redmond and Portland. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDialInConferencingAccessNumber -Region $Null ``` Example 4 returns all the dial-in conferencing access numbers that are not associated with a region (that is, where the Regions property is empty). -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDialInConferencingAccessNumber -Region site:USA/Redmond ``` The command shown in Example 5 returns all the dial-in conferencing access numbers for the Redmond region that have been scoped to the USA site (that is, the site with the SiteId site:USA). -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsDialInConferencingAccessNumber -Filter {DisplayName -like "*Seattle*"} ``` @@ -107,7 +108,7 @@ Get-CsDialInConferencingAccessNumber -Filter {DisplayName -like "*Seattle*"} In Example 6, the Filter parameter is used in order to return a collection of all the dial-in conferencing access numbers that include the string value "Seattle" somewhere in their DisplayName. The filter value {DisplayName -like "*Seattle*"} limits the returned data to access numbers where the DisplayName includes the word "Seattle" (for example, Seattle Access Number; Dial-In Number for Seattle; Tacoma/Seattle Access Number; etc.). -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsDialInConferencingAccessNumber -Filter {LineUri -like "tel:+1425*"} ``` @@ -119,7 +120,7 @@ To return all the phone numbers for area code 425 or for the area code 206, use `{LineUri -like "tel:+1425*" -or LineUri -like "tel:+1206*"}` -### -------------------------- Example 8 -------------------------- +### Example 8 ``` Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -eq "it-IT"} ``` @@ -128,7 +129,7 @@ Example 8 returns a collection of all the dial-in conferencing access numbers wh To carry out this task, the Get-CsDialInConferencingAccessNumber cmdlet is first called in order to return a collection of all the access numbers configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those numbers where the PrimaryLanguage property is equal to Italian ("it-It"). -### -------------------------- Example 9 -------------------------- +### Example 9 ``` Get-CsDialInConferencingAccessNumber | Where-Object {$_.SecondaryLanguages -contains "fr-FR"} ``` @@ -140,26 +141,10 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS -### -Identity -SIP address of the dial-in conferencing access number (that is, the contact object that represents the number) to be retrieved. -You must include the "sip:" prefix when specifying the Identity; for example: -Identity sip:RedmondDialIn@litwareinc.com. - -If this parameter is not specified, then the Get-CsDialInConferencingAccessNumber cmdlet will return all the dial-in conferencing access numbers configured for use in your organization. - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsDialInConferencingAccessNumber cmdlet under alternate credentials; this might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. To use the Credential parameter you must first create a PSCredential object by using the Get-Credential cmdlet. @@ -168,8 +153,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +163,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (for example, atl-mcs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +182,9 @@ Accept wildcard characters: False ``` ### -EmptyRegion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the dial plans that are associated with a region that is not associated with at least one dial-in conferencing access number. For example, suppose the Bellevue dial plan is associated with the Bellevue region, but no access numbers have been configured for the Bellevue region. The Bellevue region would thus be considered an empty region. @@ -205,8 +194,7 @@ This parameter cannot be used in conjunction with any other parameter. ```yaml Type: SwitchParameter Parameter Sets: EmptyRegion -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -216,6 +204,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on specific attributes for Skype for Business Server. For example, you can limit returned data to dial-in conferencing numbers that have the string value "Redmond" in their display name, or toll-free dial-in conferencing numbers that use the 1-800 prefix. @@ -225,8 +216,7 @@ For example, a filter that returns only access numbers that have the 1-800 prefi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -235,7 +225,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the dial-in conferencing access number (that is, the contact object that represents the number) to be retrieved. +You must include the "sip:" prefix when specifying the Identity; for example: -Identity sip:RedmondDialIn@litwareinc.com. + +If this parameter is not specified, then the Get-CsDialInConferencingAccessNumber cmdlet will return all the dial-in conferencing access numbers configured for use in your organization. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return access numbers from a specific Active Directory organizational unit (OU). This includes data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs, AccountsPayable and AccountsReceivable, access number information will be returned from each of these three OUs. @@ -245,8 +259,7 @@ When specifying an OU, use the distinguished name of that container; for example ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -256,6 +269,9 @@ Accept wildcard characters: False ``` ### -Region + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns all the dial-in conferencing access numbers associated with the specified dial plan region. For example, to return all the dial-in numbers for the Northwest region, use this syntax: -Region Northwest. @@ -273,8 +289,7 @@ For details, see the Set-CsDialInConferencingAccessNumber cmdlet help topic. ```yaml Type: String Parameter Sets: Region -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,6 +299,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return just seven access numbers (regardless of how many access numbers are in your forest), simply include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven items will be returned. @@ -295,8 +313,7 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingConfiguration.md index 1a86bff077..c630811964 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDialInConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdialinconferencingconfiguration +schema: 2.0.0 +title: Get-CsDialInConferencingConfiguration --- # Get-CsDialInConferencingConfiguration @@ -40,7 +41,7 @@ These conference "join behaviors" are managed using dial-in conferencing configu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDialInConferencingConfiguration ``` @@ -48,14 +49,14 @@ Get-CsDialInConferencingConfiguration Example 1 returns a collection of all the dial-in conferencing configuration settings currently in use in the organization. Calling the Get-CsDialInConferencingConfiguration cmdlet without any additional parameters always returns the complete collection of dial-in conferencing settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialInConferencingConfiguration -Identity site:Redmond ``` Example 2 returns the dial-in conferencing configuration settings with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDialInConferencingConfiguration -Filter "site:*" ``` @@ -64,7 +65,7 @@ In Example 3, the Filter parameter is used to return all the dial-in conferencin The filter value "site:*" instructs the Get-CsDialInConferencingConfiguration cmdlet to return only those settings where the Identity begins with the string value "site:". By design, any dial-conferencing settings that have an Identity beginning with "site:" represent settings configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDialInConferencingConfiguration | Where-Object {$_.EnableNameRecording -eq $False} ``` @@ -76,7 +77,31 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way for you to use wildcard characters when specifying dial-in conferencing configuration settings. +For example, to return a collection of all the configuration settings that have been applied at the site scope use this syntax: -Filter "site:*". +To return all the settings that have the term "EMEA" in their Identity use this syntax: -Filter "*EMEA*". +Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other dial-in conferencing configuration properties. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the dial-in conferencing configuration settings to be retrieved. To refer to the global settings, use this syntax: -Identity global. To refer to site settings, use syntax similar to this: -Identity site:Redmond. @@ -88,8 +113,7 @@ If called without any parameters the Get-CsDialInConferencingConfiguration cmdle ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -98,33 +122,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Provides a way for you to use wildcard characters when specifying dial-in conferencing configuration settings. -For example, to return a collection of all the configuration settings that have been applied at the site scope use this syntax: -Filter "site:*". -To return all the settings that have the term "EMEA" in their Identity use this syntax: -Filter "*EMEA*". -Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other dial-in conferencing configuration properties. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the dial-in conferencing 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingDtmfConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingDtmfConfiguration.md index 7656e7a355..fab4581867 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingDtmfConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDialInConferencingDtmfConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdialinconferencingdtmfconfiguration +schema: 2.0.0 +title: Get-CsDialInConferencingDtmfConfiguration --- # Get-CsDialInConferencingDtmfConfiguration @@ -44,14 +45,14 @@ The Get-CsDialInConferencingDtmfConfiguration cmdlet enables you to retrieve a l ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDialInConferencingDtmfConfiguration -Identity site:Redmond ``` The command show in Example 1 returns the DTMF settings for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialInConferencingDtmfConfiguration | Select-Object Identity, HelpCommand ``` @@ -60,7 +61,7 @@ Example 2 returns a collection of all the DTMF settings, and then, for each item To do this, the Get-CsDialInConferencingDtmfConfiguration cmdlet is called in order to return a collection of all the property values for all the DTMF settings currently in use in the organization. That collection is then piped to the Select-Object cmdlet, which picks two properties (Identity and HelpCommand) to be displayed on the screen. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDialInConferencingDtmfConfiguration -Filter "site:*" ``` @@ -70,7 +71,7 @@ This is done by including the Filter parameter and the filter value "site:*". That filter value limits the returned data to settings that have an Identity that begins with the characters "site:". By definition, those are settings configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDialInConferencingDtmfConfiguration | Where-Object {$_.AdmitAll -ne 8} ``` @@ -82,7 +83,30 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection (or collections) of DTMF configuration settings. +To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for), use this syntax: -Filter *EMEA*. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of DTMF settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -94,8 +118,7 @@ If this parameter is not specified, then the Get-CsDialInConferencingDtmfConfigu ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -104,32 +127,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection (or collections) of DTMF configuration settings. -To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for), use this syntax: -Filter *EMEA*. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the DTMF configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingLanguageList.md similarity index 91% rename from skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingLanguageList.md index 1f82e950cc..18e8140ed5 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingLanguageList.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencinglanguagelist applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDialInConferencingLanguageList -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdialinconferencinglanguagelist +schema: 2.0.0 +title: Get-CsDialInConferencingLanguageList --- # Get-CsDialInConferencingLanguageList @@ -47,7 +48,7 @@ Note, too that the list of available languages is configured at the global scope ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` (Get-CsDialInConferencingLanguageList).Languages -contains "en-US" ``` @@ -57,7 +58,7 @@ In this example, the Get-CsDialInConferencingLanguageList cmdlet is called in or If it is, the Get-CsDialInConferencingLanguageList cmdlet will report back the value "True". If "en-US" cannot be found in the list of supported languages, then the cmdlet will report back the value "False". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` (Get-CsDialInConferencingLanguageList).Languages ``` @@ -71,49 +72,55 @@ After the information has been returned, standard "dot notation" (the object nam ## PARAMETERS -### -Identity -Indicates the dial-in conferencing language list to be returned. -At this point in time there is only one such object: global. -Because of this, you do not need to include this parameter when calling the Get-CsDialInConferencingLanguageList cmdlet. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying a dial-conferencing language list. +Because there is only one such object (global), you can return the language list without using either the Filter or the Identity parameter. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying a dial-conferencing language list. -Because there is only one such object (global), you can return the language list without using either the Filter or the Identity parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the dial-in conferencing language list to be returned. +At this point in time there is only one such object: global. +Because of this, you do not need to include this parameter when calling the Get-CsDialInConferencingLanguageList cmdlet. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the languages list from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialPlan.md similarity index 86% rename from skype/skype-ps/skype/Get-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDialPlan.md index bd10f2446f..cd3f145794 100644 --- a/skype/skype-ps/skype/Get-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialPlan.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDialPlan -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdialplan +schema: 2.0.0 +title: Get-CsDialPlan --- # Get-CsDialPlan @@ -40,14 +42,14 @@ Note: You can use the Get-CsDialPlan cmdlet to retrieve specific information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### 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 -------------------------- +### Example 2 ``` Get-CsDialPlan -Identity RedmondDialPlan ``` @@ -55,7 +57,7 @@ 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 -------------------------- +### Example 3 ``` Get-CsDialPlan -Identity site:Redmond ``` @@ -63,7 +65,7 @@ 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 -------------------------- +### Example 4 ``` Get-CsDialPlan -Filter tag:* ``` @@ -71,7 +73,7 @@ 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 -------------------------- +### Example 5 ``` Get-CsDialPlan | Select-Object -ExpandProperty NormalizationRules ``` @@ -82,7 +84,7 @@ To see all of these rules, this sample command first uses the Get-CsDialPlan cmd 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 -------------------------- +### Example 6 ``` Get-CsDialPlan | Where-Object {$_.Description -match "Redmond"} ``` @@ -94,46 +96,52 @@ That collection is then piped to the Where-Object cmdlet, which applies a filter ## PARAMETERS -### -Identity -The unique identifier designating the scope, and for per-user scope a name, to identify the dial plan you want to retrieve. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 1 +Position: Named 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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier designating the scope, and for per-user scope a name, to identify the dial plan you want to retrieve. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: (All) +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,13 +151,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -169,7 +179,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile ## NOTES diff --git a/skype/skype-ps/skype/Get-CsEffectivePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsEffectivePolicy.md similarity index 92% rename from skype/skype-ps/skype/Get-CsEffectivePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsEffectivePolicy.md index 117520586f..eb5470453e 100644 --- a/skype/skype-ps/skype/Get-CsEffectivePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsEffectivePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cseffectivepolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsEffectivePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cseffectivepolicy +schema: 2.0.0 +title: Get-CsEffectivePolicy --- # Get-CsEffectivePolicy @@ -63,14 +64,14 @@ The functions carried out by the Get-CsEffectivePolicy cmdlet are not directly a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsEffectivePolicy - Identity "Ken Myer" ``` The command shown in Example 1 returns the effective policies for the user with the Active Directory display name Ken Myer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` "Ken Myer","Pilar Ackerman" | Get-CsEffectivePolicy ``` @@ -78,7 +79,7 @@ The command shown in Example 1 returns the effective policies for the user with In the preceding command, effective policy information is returned for users with the display names Ken Myer and Pilar Ackerman. Policy information for multiple users can be returned by piping multiple user Identities to the Get-CsEffectivePolicy cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -Filter {ConferencingPolicy -eq "RedmondConferencingPolicy"} | Get-CsEffectivePolicy ``` @@ -87,7 +88,7 @@ In Example 3, effective policy information is returned for all the users who hav To do this, the command first uses the Get-CsUser cmdlet to return a collection of users who have been assigned RedmondConferencingPolicy; the Filter parameter and the filter value {ConferencingPolicy -eq "RedmondConferencingPolicy"} limits the returned data to users who have been assigned the RedmondConferencingPolicy per-user conferencing policy. That collection of user accounts is then piped to the Get-CsEffectivePolicy cmdlet, which displays effective policy information for each user in the collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUser -Filter {ConferencingPolicy -eq "RedmondConferencingPolicy"} | Get-CsEffectivePolicy | Select-Object Identity, MobilityPolicy ``` @@ -96,7 +97,7 @@ Example 4 is a variation of the command shown in Example 3. In this example, effective policy information is again returned for all the users who have been assigned the conferencing policy RedmondConferencingPolicy; in this case, however, the returned information is limited to the user Identity and mobility policy. This is done by returning all the effective policy information and then piping that data to the Select-Object cmdlet, which, in turn, is used to limit the displayed data to the Identity and MobilityPolicy properties. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsUser -LdapFilter "Department=Finance" | Get-CsEffectivePolicy ``` @@ -108,28 +109,10 @@ That collection is then piped to the Get-CsEffectivePolicy cmdlet, which display ## PARAMETERS -### -Identity -Indicates the Identity of the user account whose effective policy settings are being calculated. -User Identities are typically specified by using one of the following 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. - -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsEffectivePolicy cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. @@ -139,8 +122,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +132,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN). For example: @@ -159,8 +144,7 @@ For example: ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,7 +153,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account whose effective policy settings are being calculated. +User Identities are typically specified by using one of the following 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. + +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: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -181,8 +191,7 @@ If you set the ResultSize to 7 but you have only three users in your forest, the ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Get-CsEnhancedEmergencyServiceDisclaimer.md similarity index 87% rename from skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsEnhancedEmergencyServiceDisclaimer.md index 36aa47f5ad..9532259e03 100644 --- a/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csenhancedemergencyservicedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Get-CsEnhancedEmergencyServiceDisclaimer --- # Get-CsEnhancedEmergencyServiceDisclaimer @@ -39,7 +40,7 @@ This message will be displayed only if the LocationRequired property of the user ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsEnhancedEmergencyServiceDisclaimer ``` @@ -49,47 +50,53 @@ This command retrieves the text of the enhanced emergency service disclaimer. ## PARAMETERS -### -Identity -This will always be Global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter allows for wildcard searches of the Identity. +However, since the only valid value for Identity is Global, this parameter is not useful for this cmdlet. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter allows for wildcard searches of the Identity. -However, since the only valid value for Identity is Global, this parameter is not useful for this cmdlet. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This will always be Global. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the disclaimer information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Get-CsExUmContact.md similarity index 86% rename from skype/skype-ps/skype/Get-CsExUmContact.md rename to skype/skype-ps/SkypeForBusiness/Get-CsExUmContact.md index e674e05256..37be55352d 100644 --- a/skype/skype-ps/skype/Get-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsExUmContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsExUmContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csexumcontact +schema: 2.0.0 +title: Get-CsExUmContact --- # Get-CsExUmContact @@ -33,21 +34,21 @@ This cmdlet retrieves one or more of these contacts. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsExUmContact ``` This example retrieves all Exchange UM contacts defined within a Skype for Business Server 2015 deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsExUmContact -Identity sip:exum1@fabrikam.com ``` This example retrieves the Exchange UM contact with the SIP address sip:exum1@fabrikam.com -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsExUmContact -Filter {Enabled -eq $False} ``` @@ -56,7 +57,7 @@ In this example, we use the Filter parameter to retrieve all Exchange UM contact We do this by filtering on the Enabled property to see if the value of this property is equal to (-eq) False ($False). Contacts returned by this command will not function. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsExUmContact -Filter {LineURI -like "tel:555*"} ``` @@ -64,7 +65,7 @@ Get-CsExUmContact -Filter {LineURI -like "tel:555*"} This command filters on the LineURI property to retrieve all Exchange UM contacts with a LineURI beginning with tel:555. In other words, it retrieves all contacts with a phone number that begins with 555. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsExUmContact -OU "OU=ExUmContacts,DC=Vdomain,DC=com" ``` @@ -74,37 +75,39 @@ The command in this example uses the OU parameter to retrieve all Exchange UM co ## PARAMETERS -### -Identity -The unique identifier of the contact object you want to retrieve. -Contact identities can be specified using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant). +### -Credential -Full data type: Microsoft.Rtc.Management.AD.UserIdParameter +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to run the cmdlet under alternate credentials; this might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. + +To use the Credential parameter, you must first create a PSCredential object by calling the Get-Credential cmdlet. ```yaml -Type: UserIdParameter +Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to limit the returned data by filtering on Skype for Business Server-specific attributes. -For example, you can limit returned data to contacts that have line URIs beginning with "tel:555". +### -DomainController -The Filter parameter uses a subset of the Windows PowerShell filtering syntax used by the Where-Object cmdlet. -For example, a filter that returns only contacts who have been enabled for Enterprise Voice would look like this: {EnterpriseVoiceEnabled -eq $True}, with EnterpriseVoiceEnabled representing the Active Directory attribute; -eq representing the comparison operator (equal to); and $True (a built-in Windows PowerShell variable) representing the filter value. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to retrieve contact information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (for example, atl-mcs-001.litwareinc.com). + +Full data type: Microsoft.Rtc.Management.Deploy.Fqdn ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,16 +116,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LdapFilter -Enables you to limit the returned data by filtering "generic" Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). +### -Filter -The LdapFilter parameter uses LDAP query language when creating filters. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering on Skype for Business Server-specific attributes. +For example, you can limit returned data to contacts that have line URIs beginning with "tel:555". + +The Filter parameter uses a subset of the Windows PowerShell filtering syntax used by the Where-Object cmdlet. +For example, a filter that returns only contacts who have been enabled for Enterprise Voice would look like this: {EnterpriseVoiceEnabled -eq $True}, with EnterpriseVoiceEnabled representing the Active Directory attribute; -eq representing the comparison operator (equal to); and $True (a built-in Windows PowerShell variable) representing the filter value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,35 +138,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential -Enables you to run the cmdlet under alternate credentials; this might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. +### -Identity -To use the Credential parameter, you must first create a PSCredential object by calling the Get-Credential cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the contact object you want to retrieve. +Contact identities can be specified using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant). + +Full data type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml -Type: PSCredential +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to retrieve contact information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (for example, atl-mcs-001.litwareinc.com). +### -LdapFilter -Full data type: Microsoft.Rtc.Management.Deploy.Fqdn +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering "generic" Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). + +The LdapFilter parameter uses LDAP query language when creating filters. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,6 +180,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the retrieved information to a specific Active Directory organizational unit (OU). Note that this returns data from the specified OU and any child OUs. @@ -177,8 +191,7 @@ When specifying an OU, use the distinguished name of that container; for example ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return just seven contacts (regardless of how many contacts are in your forest) simply include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven contacts will be returned. @@ -201,8 +217,7 @@ Full data type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsExternalAccessPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsExternalAccessPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsExternalAccessPolicy.md index 5fa4d707b7..00ff93f3ba 100644 --- a/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsExternalAccessPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csexternalaccesspolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsExternalAccessPolicy -schema: 2.0.0 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csexternalaccesspolicy +schema: 2.0.0 +title: Get-CsExternalAccessPolicy --- # Get-CsExternalAccessPolicy @@ -55,7 +57,7 @@ The Get-CsExternalAccessPolicy cmdlet provides a way for you to return informati ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-CsExternalAccessPolicy ``` @@ -63,7 +65,7 @@ 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) +### EXAMPLE 2 (Skype for Business Online) ``` Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" ``` @@ -71,7 +73,7 @@ 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) +### EXAMPLE 2 (Skype for Business Server 2015) ``` Get-CsExternalAccessPolicy -Identity site:Redmond ``` @@ -79,7 +81,7 @@ 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 -------------------------- +### Example 3 ``` Get-CsExternalAccessPolicy -Filter tag:* ``` @@ -87,7 +89,7 @@ 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 -------------------------- +### Example 4 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} ``` @@ -96,7 +98,7 @@ In Example 4, the Get-CsExternalAccessPolicy cmdlet and the Where-Object cmdlet 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 -------------------------- +### Example 5 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True} ``` @@ -106,7 +108,7 @@ In order to perform this task, the command first uses the Get-CsExternalAccessPo 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 -------------------------- +### EXAMPLE 6 ``` Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com" ``` @@ -119,32 +121,39 @@ NOTE: This command requires the Office 365 UsageLocation property to be configur ## 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. +### -ApplicableTo -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. +> Applicable: Skype for Business Online -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. +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: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UserIdParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + **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. @@ -174,8 +183,7 @@ Note that the Filter parameter can only be applied to the policy Identity. ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,43 +192,43 @@ 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. +### -Identity -NOTE: This parameter is not used with Skype for Business Online. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: 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 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 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"` +### -Include -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. +> Applicable: Skype for Business Online -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. +PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly ```yaml -Type: UserIdParameter +Type: PolicyFilter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -229,14 +237,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Include -PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly +### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: PolicyFilter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -246,13 +258,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsExternalUserCommunicationPolicy.md similarity index 82% rename from skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsExternalUserCommunicationPolicy.md index f3dc30cd98..4497bfb2be 100644 --- a/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsExternalUserCommunicationPolicy.md @@ -1,20 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy applicable: Skype for Business Online -title: Get-CsExternalUserCommunicationPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csexternalusercommunicationpolicy +schema: 2.0.0 +title: Get-CsExternalUserCommunicationPolicy --- # Get-CsExternalUserCommunicationPolicy ## SYNOPSIS -Returns information about one or more external user communication policies configured for your organization. +Returns information about one or more external user communication policies configured for your organization. ## SYNTAX @@ -27,28 +29,28 @@ This cmdlet retrieves external user communication policy information. External u ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` PS C:\> Get-CsExternalUserCommunicationPolicy ``` This example displays all the external user communication policies that have been defined for an organization along with the settings for each. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` PS C:\> Get-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer ``` This example uses the Identity parameter to retrieve the external user communication policy settings for the policy named BlockExternalP2PFileTransfer. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` PS C:\> Get-CsExternalUserCommunicationPolicy -Filter tag* ``` This example uses the Filter parameter to retrieve all the external user communication policies along with the settings for each. All per-user external user communication policies have an Identity in the format `tag:`. - -### -------------------------- Example 4 ------------------------ + +### Example 4 ``` PS C:\> Get-CsExternalUserCommunicationPolicy -Filter Block* ``` @@ -58,13 +60,15 @@ This example uses the Filter parameter to retrieve all the external user communi ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + This parameter accepts a wildcard string and returns all external user communication policies with identities matching that string. For example, a Filter value of tag:* will return all external user communication policies excluding Global policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique identifier for the external user communication policy to be created. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -89,13 +95,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -105,6 +113,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" @@ -118,8 +129,7 @@ If you are using a remote session of Windows PowerShell and are connected only t ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -142,10 +152,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy?view=skype-ps) +[New-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csexternalusercommunicationpolicy?view=skype-ps) -[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) +[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csexternalusercommunicationpolicy?view=skype-ps) -[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) +[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csexternalusercommunicationpolicy?view=skype-ps) -[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) +[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csexternalusercommunicationpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsFIPSConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsFIPSConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsFIPSConfiguration.md index 4a4f0b69d7..e28597d116 100644 --- a/skype/skype-ps/skype/Get-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsFIPSConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsFIPSConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csfipsconfiguration +schema: 2.0.0 +title: Get-CsFIPSConfiguration --- # Get-CsFIPSConfiguration @@ -46,7 +47,7 @@ The functions carried out by the Get-CsFIPSConfiguration cmdlet are not availabl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsFIPSConfiguration ``` @@ -58,6 +59,9 @@ Note that there is only a single, global instance of FIPS configuration settings ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard values when referencing a collection of FIPS configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings: @@ -69,8 +73,7 @@ That syntax brings back all the FIPS configuration settings that have an Identit ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the FIPS configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsFIPSConfiguration cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -89,8 +95,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the FIPS configuration 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose FIPS configuration settings are to be retrieved. For example: @@ -129,8 +139,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsFileTransferFilterConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsFileTransferFilterConfiguration.md index 388bc6c94d..bb683fd7f7 100644 --- a/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsFileTransferFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsFileTransferFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csfiletransferfilterconfiguration +schema: 2.0.0 +title: Get-CsFileTransferFilterConfiguration --- # Get-CsFileTransferFilterConfiguration @@ -40,7 +41,7 @@ File transfer filter configurations include the list of file extensions that are ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsFileTransferFilterConfiguration ``` @@ -48,7 +49,7 @@ Get-CsFileTransferFilterConfiguration The command shown in Example 1 returns a collection of all the file transfer filter configurations in use in your organization. This is the default behavior any time you call the Get-CsFileTransferFilterConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsFileTransferFilterConfiguration -Identity site:Redmond ``` @@ -56,7 +57,7 @@ Get-CsFileTransferFilterConfiguration -Identity site:Redmond Example 2 returns a single file transfer filter configuration: the configuration that has the Identity site:Redmond. Because identities must be unique, this command can never return more than one configuration. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsFileTransferFilterConfiguration -Filter site:* @@ -65,7 +66,7 @@ Get-CsFileTransferFilterConfiguration -Filter site:* Example 3 uses the Filter parameter to return a collection of all the file transfer filter configurations at the site level. The Filter value "site:*" instructs the Get-CsFileTransferFilterConfiguration cmdlet to return only those configurations that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsFileTransferFilterConfiguration | Where-Object {$_.Extensions -contains ".xls"} ``` @@ -74,7 +75,7 @@ The command shown in Example 4 returns only those file transfer filter configura To do this, the Get-CsFileTransferFilterConfiguration cmdlet is first used to return a collection of all the configurations in use in your organization. That collection is then piped to the Where-Object cmdlet, which applies a filter that restricts the returned data to those configurations where the Extensions property includes (-contains) the string value ".xls". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsFileTransferFilterConfiguration | Where-Object {$_.Enabled -eq $False} ``` @@ -83,7 +84,7 @@ Example 5 returns all the file transfer filter configurations that are currently To accomplish this task, the Get-CsFileTransferFilterConfiguration cmdlet is used to return a collection of all the configurations in use in your organization. This collection is then piped to the Where-Object cmdlet, which, in turn, selects only those configuration where the Enabled property is equal to (-eq) False ($False). -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsFileTransferFilterConfiguration -Identity Global | Select-Object -ExpandProperty Extensions ``` @@ -96,7 +97,30 @@ That results in the complete list of file extensions being displayed on the scre ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the file transfer filter configurations to be returned. +For example, to return all the file transfer filter configurations at the site scope, use this syntax: -Filter "site:*". +By design, file transfer filter configurations that have an Identity (the only property you can filter for) that begins with the string value "site:" were configured at the site scope. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the file transfer filter configuration you want to retrieve. To refer to the global settings, use this syntax: -Identity global. To refer to settings configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -106,8 +130,7 @@ If you want to use wildcards, use the Filter parameter instead. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -116,32 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the file transfer filter configurations to be returned. -For example, to return all the file transfer filter configurations at the site scope, use this syntax: -Filter "site:*". -By design, file transfer filter configurations that have an Identity (the only property you can filter for) that begins with the string value "site:" were configured at the site scope. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the file transfer filter configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsGraphPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsGraphPolicy.md similarity index 90% rename from skype/skype-ps/skype/Get-CsGraphPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsGraphPolicy.md index 69cd22f5e8..5c2cd76bad 100644 --- a/skype/skype-ps/skype/Get-CsGraphPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsGraphPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csgraphpolicy applicable: Skype for Business Online -title: Get-CsGraphPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csgraphpolicy +schema: 2.0.0 +title: Get-CsGraphPolicy --- # Get-CsGraphPolicy @@ -17,7 +19,7 @@ Use the `Get-CsGraphPolicy` cmdlet to return information about one or more graph ## SYNTAX ``` -Get-CsGraphPolicy [[-Identity] ] [-Filter ] [-LocalStore] [-Tenant ] +Get-CsGraphPolicy [[-Identity] ] [-Filter ] [-LocalStore] [-Tenant ] [] ``` @@ -30,7 +32,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "Get-CsGraphPolicy"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsGraphPolicy ``` @@ -41,13 +43,15 @@ This example returns all predefined graph policies in your organization. ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + This parameter accepts a wildcard string and returns all graph policies with identities matching that string. For example, a Filter value of "\*Enabled\*" will return all policies which contain the string "Enabled". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -57,13 +61,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the predefined graph policy to return. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -73,13 +79,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -89,6 +97,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" @@ -102,8 +113,7 @@ If you are using a remote session of Windows PowerShell and are connected only t ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -122,4 +132,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Grant-CsGraphPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csgraphpolicy?view=skype-ps) +[Grant-CsGraphPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csgraphpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/Get-CsGroupPickupUserOrbit.md similarity index 87% rename from skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md rename to skype/skype-ps/SkypeForBusiness/Get-CsGroupPickupUserOrbit.md index 199078925f..934d36657f 100644 --- a/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsGroupPickupUserOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsGroupPickupUserOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csgrouppickupuserorbit +schema: 2.0.0 +title: Get-CsGroupPickupUserOrbit --- # Get-CsGroupPickupUserOrbit @@ -25,14 +26,14 @@ Get-CsGroupPickupUserOrbit [-User] [-Force] [] ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsGroupPickupUserOrbit -User sip:ken.myer@contoso.com ``` The following example gets the group pickup orbit number of a user specified by SIP address. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsGroupPickupUserOrbit "Ken Myer" ``` @@ -41,7 +42,7 @@ The following example gets the group pickup orbit number by using the display na User is a positional parameter. The first parameter after the cmdlet is assumed to be the User parameter value. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser "Ken Myer" | Get-CsGroupPickupUserOrbit ``` @@ -51,7 +52,28 @@ The following example gets the group pickup orbit numbers by piping the output o ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -User + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the user whose group pickup orbit number will be retrieved. Because User is a positional parameter, the -User syntax is not required. The first parameter after the cmdlet is assumed to be the User parameter value. @@ -63,7 +85,6 @@ You can also reference a user account by using the user's Active Directory disti Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -72,22 +93,6 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```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 -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsHealthMonitoringConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHealthMonitoringConfiguration.md index ce017ff110..602413f717 100644 --- a/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHealthMonitoringConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsHealthMonitoringConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshealthmonitoringconfiguration +schema: 2.0.0 +title: Get-CsHealthMonitoringConfiguration --- # Get-CsHealthMonitoringConfiguration @@ -50,21 +51,21 @@ The Get-CsHealthMonitoringConfiguration cmdlet provides a way for you to retriev ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsHealthMonitoringConfiguration ``` Example 1 returns all the health monitoring configuration settings currently in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHealthMonitoringConfiguration -Identity atl-cs-001.litwareinc.com ``` The command shown in Example 2 returns a single collection of health monitoring configuration settings: the settings that have the Identity atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHealthMonitoringConfiguration -Filter *.litwareinc.com ``` @@ -72,7 +73,7 @@ Get-CsHealthMonitoringConfiguration -Filter *.litwareinc.com Example 3 returns all the health monitoring configuration settings that have been created for the domain litwareinc.com. To do this, the Get-CsHealthMonitoringConfiguration cmdlet is called along with the Filter parameter; the filter value "*.litwareinc.com" ensures that only those settings that have an Identity that ends with the string value ".litwareinc.com" will be returned. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsHealthMonitoringConfiguration | Where-Object {$_.FirstTestUserSipUri -eq "sip:kenmyer@litwareinc.com" -or $_.SecondTestUserSipUri -eq " sip:kenmyer@litwareinc.com"} ``` @@ -85,50 +86,56 @@ As a result, any collection of settings where Ken Myer's SIP address is used for ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the pool where the health monitoring configuration settings have been assigned. -For example: -Identity atl-cs-001.litwareinc.com. +### -Filter -If this parameter is not included, then the Get-CsHealthMonitoringConfiguration cmdlet will return information about all the health monitoring configuration settings currently in use. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the health monitoring configuration settings to be retrieved. +For example, this syntax returns all the settings configured for the litwareinc.com domain: -Filter "*.litwareinc.com". ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the health monitoring configuration settings to be retrieved. -For example, this syntax returns all the settings configured for the litwareinc.com domain: -Filter "*.litwareinc.com". +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool where the health monitoring configuration settings have been assigned. +For example: -Identity atl-cs-001.litwareinc.com. + +If this parameter is not included, then the Get-CsHealthMonitoringConfiguration cmdlet will return information about all the health monitoring configuration settings currently in use. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the health monitoring configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsHostedVoicemailPolicy.md similarity index 85% rename from skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHostedVoicemailPolicy.md index 7910736a0e..1daa76f755 100644 --- a/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHostedVoicemailPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsHostedVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshostedvoicemailpolicy +schema: 2.0.0 +title: Get-CsHostedVoicemailPolicy --- # Get-CsHostedVoicemailPolicy @@ -39,21 +41,21 @@ You can call the Get-CsUser cmdlet and check the HostedVoiceMail property to det ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsHostedVoicemailPolicy ``` This command returns all defined hosted voice mail policies for the Skype for Business Server 2015 implementation. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHostedVoicemailPolicy -Identity ExRedmond ``` This command returns the policy settings for the per-user hosted voice mail policy ExRedmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHostedVoicemailPolicy -Filter tag:* ``` @@ -62,48 +64,54 @@ This command returns the policy settings for all per-user hosted voice mail poli ## PARAMETERS -### -Identity -The unique identifier for the hosted voice mail policy you want to retrieve. -The Identity includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter allows you to do a wildcard search on the Identity of the hosted voice mail policy. +This will retrieve all instances of a hosted voice mail policy where the Identity matches the wildcard pattern specified in the Filter value. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter allows you to do a wildcard search on the Identity of the hosted voice mail policy. -This will retrieve all instances of a hosted voice mail policy where the Identity matches the wildcard pattern specified in the Filter value. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier for the hosted voice mail policy you want to retrieve. +The Identity includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the hosted voice mail policy from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsHostingProvider.md similarity index 90% rename from skype/skype-ps/skype/Get-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHostingProvider.md index 3e5f2a3e66..49b18f3616 100644 --- a/skype/skype-ps/skype/Get-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHostingProvider.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsHostingProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshostingprovider +schema: 2.0.0 +title: Get-CsHostingProvider --- # Get-CsHostingProvider @@ -53,7 +55,7 @@ Note that you cannot federate with a hosting provider if your Edge Servers are c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsHostingProvider ``` @@ -61,7 +63,7 @@ Get-CsHostingProvider Example 1 returns a collection of all the hosting providers configured for use in the organization. Calling the Get-CsHostingProvider cmdlet without any additional parameters returns the complete collection of hosting providers. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHostingProvider -Identity Fabrikam.com ``` @@ -69,14 +71,14 @@ Get-CsHostingProvider -Identity Fabrikam.com Example 2 returns the hosting provider that has the Identity Fabrikam.com. Because Identities must be unique among hosting providers, this command will never return more than a single item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHostingProvider -Filter *.org ``` The command shown in Example 3 returns a collection of all the hosting providers that have an Identity that ends with the string value ".org" (for example, fabrikam.org and contoso.org). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsHostingProvider | Where-Object {$_.Enabled -eq $True} ``` @@ -85,7 +87,7 @@ In Example 4, all the hosting providers that are currently enabled for use are r To do this, the Get-CsHostingProvider cmdlet is first called in order to return a collection of all the hosting providers currently configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those providers where the Enabled property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsHostingProvider | Where-Object {$_.Enabled -eq $True -and $_.EnabledSharedAddressSpace -eq $True} ``` @@ -94,7 +96,7 @@ Example 5 returns all the hosting providers that have a shared address space and (Split domain simply means that some of your Skype for Business Server 2015 accounts are maintained on-premises while other accounts are maintained by a hosting provider.) To carry out this task, the command first uses the Get-CsHostingProvider cmdlet to return a collection of all the currently configured hosting providers. This collection is then piped to the Where-Object cmdlet, which selects only those providers that meet two criteria: 1) the Enabled property is equal to True; and, 2) the EnabledSharedAddressSpace property is equal to True. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsHostingProvider | Select-Object * ``` @@ -106,51 +108,57 @@ To see the values for these properties, the information returned by the Get-CsHo ## PARAMETERS -### -Identity -Unique identifier for the hosting provider to be returned. -The Identity might be the fully qualified domain name (FQDN) of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). +### -Filter -If this parameter is not specified, the Get-CsHostingProvider cmdlet will return a collection of all the hosting providers configured for use in your organization. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard values to return one or more hosting providers. +For example, to return all the hosting providers that have an identity that ends with the string value ".com" use this syntax: -Filter "*.com". +To return all the hosting providers that have an Identity that begins with the string "Fabri" use this syntax: -Filter "Fabri*". ```yaml -Type: XdsGlobalRelativeIdentity -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 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard values to return one or more hosting providers. -For example, to return all the hosting providers that have an identity that ends with the string value ".com" use this syntax: -Filter "*.com". -To return all the hosting providers that have an Identity that begins with the string "Fabri" use this syntax: -Filter "Fabri*". +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the hosting provider to be returned. +The Identity might be the fully qualified domain name (FQDN) of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). + +If this parameter is not specified, the Get-CsHostingProvider cmdlet will return a collection of all the hosting providers configured for use in your organization. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the hosting provider 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridApplicationEndpoint.md similarity index 87% rename from skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHybridApplicationEndpoint.md index 4fe4251dd1..42d35dd115 100644 --- a/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsHybridApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint +schema: 2.0.0 +title: Get-CsHybridApplicationEndpoint --- # Get-CsHybridApplicationEndpoint @@ -29,21 +30,21 @@ The `Get-CsHybridApplicationEndpoint` cmdlet provides numerous ways for you to f ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` -PS C:\> Get-CsHybridApplicationEndpoint +PS C:\> Get-CsHybridApplicationEndpoint ``` This example displays all the hybrid application endpoints that have been defined for an organization along with the settings for each. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsHybridApplicationEndpoint -Identity "CN={4f6c99fe-7999-4088-ac4d-e88e0b3d3820},OU=Redmond,DC=litwareinc,DC=com" ``` This example uses the Identity parameter to retrieve the hybrid application endpoint settings for a specific endpoint. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsHybridApplicationEndpoint -Filter {DisplayName -like "*bot*"} ``` @@ -53,6 +54,9 @@ This example uses the Filter parameter to retrieve all the hybrid application en ## PARAMETERS ### -Credential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to run the Get-CsHybridApplicationEndpoint cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with user objects. To use the Credential parameter you must first create a PSCredential object by using the [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6) cmdlet. For details, see the Get-Credential cmdlet help topic. @@ -61,7 +65,6 @@ To use the Credential parameter you must first create a PSCredential object by u Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on Skype for Business Server 2015-specific attributes. For example, you can limit returned data to endpoints with specific word in their DisplayName attribute. The Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. For example, a filter that returns only endpoints with a value in their LineURI attribute would look like this, with LineURI representing the Active Directory attribute, -ne representing the comparison operator (not equal to), and $null (a built-in Windows PowerShell variable) representing the filter value: @@ -97,7 +105,6 @@ The Filter parameter uses the same Windows PowerShell filtering syntax that is u Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique application Id for the endpoint you want to get. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 0 @@ -123,6 +132,9 @@ Accept wildcard characters: False ``` ### -LdapFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). For example, you can limit returned data to endpoints which work in a specific department, or endpoints which have a specified manager or job title. The LdapFilter parameter uses the LDAP query language when creating filters. For example, a filter that returns only endpoints which belongs in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. @@ -131,7 +143,6 @@ The LdapFilter parameter uses the LDAP query language when creating filters. For Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -141,6 +152,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return information about endpoints in a specific organizational unit (OU) or container. The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs--AccountsPayable and AccountsReceivable--endpoints will be returned from each of these three OUs. When specifying an OU, use the distinguished name (DN) of that container; for example: -OU "OU=Finance,dc=litwareinc,dc=com". To return endpoints accounts from the Users container, use this syntax: @@ -151,7 +165,6 @@ When specifying an OU, use the distinguished name (DN) of that container; for ex Type: OUIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -161,6 +174,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven endpoints (regardless of the number of endpoints 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 endpoints will be returned. The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0 the command will run, but no data will be returned. If you set the ResultSize to 7 but you have only three endpoints in your forest, the command will return those three endpoints, and then complete without error. @@ -169,7 +185,6 @@ The result size can be set to any whole number between 0 and 2147483647, inclusi Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -194,8 +209,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsHybridMediationServer.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridMediationServer.md similarity index 91% rename from skype/skype-ps/skype/Get-CsHybridMediationServer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHybridMediationServer.md index 22a1a60c23..915e1bc8b6 100644 --- a/skype/skype-ps/skype/Get-CsHybridMediationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridMediationServer.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridmediationserver applicable: Skype for Business Online -title: Get-CsHybridMediationServer -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridmediationserver +schema: 2.0.0 +title: Get-CsHybridMediationServer --- # Get-CsHybridMediationServer @@ -33,7 +35,7 @@ If the user has licenses assigned, the warning message will be shown as guidance ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Online) +### Example 1 (Skype for Business Online) ``` Get-CsHybridMediationServer -Fqdn MediationServer.Contoso.com ``` @@ -44,14 +46,16 @@ This example gets the FQDN of a mediation server access proxy. ## PARAMETERS ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the hybrid public switched telephone network (PSTN) site. For example: -Identity "SeattlePSTN". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -60,14 +64,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Tenant + +> Applicable: Skype for Business Online + +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 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. +The tenant ID will be determined by your connection and credentials. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -76,18 +86,16 @@ 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 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. -The tenant ID will be determined by your connection and credentials. -The Tenant parameter is primarily for use in a hybrid deployment. +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -97,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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. @@ -104,7 +115,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 Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNAppliance.md similarity index 86% rename from skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNAppliance.md index 35c6ae3de8..a7b0e1e9df 100644 --- a/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNAppliance.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridpstnappliance applicable: Skype for Business Online -title: Get-CsHybridPSTNAppliance -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridpstnappliance +schema: 2.0.0 +title: Get-CsHybridPSTNAppliance --- # Get-CsHybridPSTNAppliance @@ -20,7 +22,7 @@ Use the `Get-CsHybridPSTNAppliance` cmdlet to retrieve information about your Sk ## SYNTAX ``` -Get-CsHybridPSTNAppliance [-Name ] [-LocalStore] [[-Identity] ] +Get-CsHybridPSTNAppliance [-Name ] [-LocalStore] [[-Identity] ] [-Tenant ] [-Filter ] [-SiteName ] [] ``` @@ -36,28 +38,28 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsHybridPSTNAppliance ``` The command shown in Example 1 returns information for all the Skype for Business Cloud Connector Edition appliances. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHybridPSTNAppliance -SiteName "SeattlePSTN" ``` The command shown in Example 2 returns information for all the Skype for Business Cloud Connector Edition appliances in the given site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHybridPSTNAppliance -Name "CCE1" ``` The command shown in Example 3 returns information for the Skype for Business Cloud Connector Edition appliance with the given name. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsHybridPSTNAppliance -SiteName "SeattlePSTN" -Name "CCE1" ``` @@ -68,13 +70,15 @@ The command shown in Example 4 returns information for the Skype for Business Cl ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + This parameter accepts a wildcard string and returns all hybrid PSTN appliances with identities matching that string. For example, a Filter value of "CCE*" will return all appliances which start with the string "CCE". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -84,13 +88,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the Skype for Business Cloud Connector Edition appliance. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -100,13 +106,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -116,13 +124,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Skype for Business Online + Name of Skype for Business Cloud Connector Edition appliance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -132,13 +142,15 @@ Accept wildcard characters: False ``` ### -SiteName + +> Applicable: Skype for Business Online + Name of Skype for Business Cloud Connector Edition site that the appliance belongs to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -148,6 +160,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" @@ -161,8 +176,7 @@ If you are using a remote session of Windows PowerShell and are connected only t ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -181,8 +195,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/set-cshybridpstnappliance?view=skype-ps) +[Set-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridpstnappliance?view=skype-ps) -[Register-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/register-cshybridpstnappliance?view=skype-ps) +[Register-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skypeforbusiness/register-cshybridpstnappliance?view=skype-ps) -[Unregister-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance?view=skype-ps) +[Unregister-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skypeforbusiness/unregister-cshybridpstnappliance?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNSite.md similarity index 91% rename from skype/skype-ps/skype/Get-CsHybridPSTNSite.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNSite.md index 3bfc36476a..0c17909c6f 100644 --- a/skype/skype-ps/skype/Get-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNSite.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridpstnsite applicable: Skype for Business Online -title: Get-CsHybridPSTNSite -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridpstnsite +schema: 2.0.0 +title: Get-CsHybridPSTNSite --- # Get-CsHybridPSTNSite @@ -40,14 +42,14 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsHybridPSTNSite ``` The command shown in Example 1 returns information for all the PSTN sites. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHybridPSTNSite -Identity "SeattlePSTN" ``` @@ -58,14 +60,16 @@ The command shown in Example 2 returns information for the PSTN site with the gi ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + Enables you to limit the returned data by filtering on (PSTN) site specific attributes. The Filter parameter uses the same filtering syntax that is used by the Where-Object cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -75,14 +79,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the hybrid public switched telephone network (PSTN) site. For example: -Identity "SeattlePSTN". ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -92,13 +98,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -108,6 +116,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". @@ -120,8 +131,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsIPPhonePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsIPPhonePolicy.md similarity index 82% rename from skype/skype-ps/skype/Get-CsIPPhonePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsIPPhonePolicy.md index 7ae4ac2e57..90adfbbc0b 100644 --- a/skype/skype-ps/skype/Get-CsIPPhonePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsIPPhonePolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2019 -title: Get-CsIPPhonePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csipphonepolicy +schema: 2.0.0 +title: Get-CsIPPhonePolicy --- # Get-CsIPPhonePolicy @@ -26,7 +28,7 @@ IP phone policies are applied each time a user accesses the system via an IP pho ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` PS C:\> Get-CsIPPhonePolicy ``` @@ -36,13 +38,15 @@ This example returns the global IP phone policy along with all their settings. ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -52,13 +56,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -68,13 +74,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -84,13 +92,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +126,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skype/grant-csipphonepolicy?view=skype-ps) +[Grant-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csipphonepolicy?view=skype-ps) -[Set-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skype/set-csipphonepolicy?view=skype-ps) +[Set-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csipphonepolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsImConfiguration.md similarity index 81% rename from skype/skype-ps/skype/Get-CsImConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsImConfiguration.md index b174055e0f..343fb5dc55 100644 --- a/skype/skype-ps/skype/Get-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsImConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsImConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimconfiguration +schema: 2.0.0 +title: Get-CsImConfiguration --- # Get-CsImConfiguration @@ -32,7 +33,7 @@ Use the Get-CsImConfiguration cmdlet to retrieve information about Instant Messa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsImConfiguration ``` @@ -42,13 +43,15 @@ This example returns information for all Instant Messaging (IM) configurations i ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a collection of items. For instance the following usage specifies all the site scoped IM configurations: -Filter "site:*" . Filter and Identity are mutually exclusive. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -58,14 +61,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier specifying the scope and, in some cases the name, of the IM configuration. If this parameter is omitted, all IM configurations for the organization are returned. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -75,13 +80,15 @@ Accept wildcard characters: False ``` ### -LocalStore -Presence of this switch causes the cmdlet to retrieve information from the local replica of the Central Management store, rather than from Central Management store itself. + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Presence of this switch causes the cmdlet to retrieve information from the local replica of the Central Management store, rather than from Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +98,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,8 +131,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsImFilterConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Get-CsImFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsImFilterConfiguration.md index fec8ca39e9..f615e9e92d 100644 --- a/skype/skype-ps/skype/Get-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsImFilterConfiguration.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsImFilterConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimfilterconfiguration +schema: 2.0.0 +title: Get-CsImFilterConfiguration --- # Get-CsImFilterConfiguration @@ -43,7 +45,7 @@ You can also specify an Identity to show the settings for a specific site (or th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsImFilterConfiguration ``` @@ -51,7 +53,7 @@ Get-CsImFilterConfiguration The command shown in Example 1 returns a collection of all the IM hyperlink filters configured for use in your organization. This is the behavior any time you call the Get-CsImFilterConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsImFilterConfiguration -Identity site:Redmond ``` @@ -59,7 +61,7 @@ Get-CsImFilterConfiguration -Identity site:Redmond Example 2 returns settings for one IM filter: the settings that have the Identity site:Redmond. Because identities must be unique, this command can never return more than one configuration. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsImFilterConfiguration -Filter site:* ``` @@ -67,7 +69,7 @@ Get-CsImFilterConfiguration -Filter site:* Example 3 uses the Filter parameter to return a collection of all the IM filters that have been configured at the site level. The wildcard string site:* instructs the Get-CsImFilterConfiguration cmdlet to return only those IM filter configurations that have an Identity that begins with the string value site:. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` (Get-CsImFilterConfiguration -Identity Global).Prefixes ``` @@ -80,30 +82,41 @@ That tells Windows PowerShell to first carry out the command enclosed in parenth ## PARAMETERS -### -Identity -The unique identifier of the settings you want to retrieve. -This will be either global or site:\, where \ is the name of the site to which these settings apply, such as site:Redmond. +### -Filter -Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Performs a wildcard search for configurations matching a given Identity pattern. +For example, returns all settings with identities beginning with site* (all site-specific settings). ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> 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 Online, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the settings you want to retrieve. +This will be either global or site:\, where \ is the name of the site to which these settings apply, such as site:Redmond. + +Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity + ```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 +Aliases: Required: False Position: 1 @@ -112,31 +125,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Performs a wildcard search for configurations matching a given Identity pattern. -For example, returns all settings with identities beginning with site* (all site-specific settings). - -```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the IM filter configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```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 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsImTranslationConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Get-CsImTranslationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsImTranslationConfiguration.md index 4c07855098..989d51a5ed 100644 --- a/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsImTranslationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsImTranslationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimtranslationconfiguration +schema: 2.0.0 +title: Get-CsImTranslationConfiguration --- # Get-CsImTranslationConfiguration @@ -32,7 +33,7 @@ This cmdlet is reserved for internal Microsoft use. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` This cmdlet is reserved for internal Microsoft use. ``` @@ -43,13 +44,15 @@ This cmdlet is reserved for internal Microsoft use. ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -75,13 +80,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Get-CsKerberosAccountAssignment.md similarity index 89% rename from skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md rename to skype/skype-ps/SkypeForBusiness/Get-CsKerberosAccountAssignment.md index 769b89632e..12c60eedb4 100644 --- a/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsKerberosAccountAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsKerberosAccountAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cskerberosaccountassignment +schema: 2.0.0 +title: Get-CsKerberosAccountAssignment --- # Get-CsKerberosAccountAssignment @@ -46,21 +47,21 @@ The Get-CsKerberosAccountAssignment cmdlet provides a way for you to return info ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsKerberosAccountAssignment ``` The command shown in Example 1 returns information about all the Kerberos account assignments currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsKerberosAccountAssignment -Identity "site:Redmond" ``` Example 2 returns information about a single Kerberos account assignment: the account assignment for the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsKerberosAccountAssignment -Filter "*Redmond*" ``` @@ -68,7 +69,7 @@ Get-CsKerberosAccountAssignment -Filter "*Redmond*" In Example 3, information is returned for all the Kerberos accounts that have been assigned to sites that have the string value "Redmond" somewhere in their site Identity. To do this, the Filter parameter is included along with the filter value "*Redmond". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsKerberosAccountAssignment | Where-Object {$_.UserAccount -match "litwareinc"} ``` @@ -81,53 +82,59 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS -### -Identity -Unique identifier of the site where the Kerberos account was assigned; for example: -Identity "site:Redmond". -(Note that this is the Identity of the site, not of the computer account.) You cannot use wildcards when specifying the site identity. -To employ wildcards, use the Filter parameter instead. +### -Filter -If neither the Identity nor the Filter parameter is included, then the Get-CsKerberosAccountAssignment cmdlet returns all the Kerberos account assignments configured for use in the organization. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the Kerberos account assignment (or assignments) to be returned. +For example, this syntax returns all the account assignments that include the string value "Europe": -Filter "*Europe*". + +You cannot use both the Identity and the Filter parameters in the same command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the Kerberos account assignment (or assignments) to be returned. -For example, this syntax returns all the account assignments that include the string value "Europe": -Filter "*Europe*". +### -Identity -You cannot use both the Identity and the Filter parameters in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the site where the Kerberos account was assigned; for example: -Identity "site:Redmond". +(Note that this is the Identity of the site, not of the computer account.) You cannot use wildcards when specifying the site identity. +To employ wildcards, use the Filter parameter instead. + +If neither the Identity nor the Filter parameter is included, then the Get-CsKerberosAccountAssignment cmdlet returns all the Kerberos account assignments configured for use in the organization. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Kerberos assignment 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsLisCivicAddress.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisCivicAddress.md similarity index 92% rename from skype/skype-ps/skype/Get-CsLisCivicAddress.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisCivicAddress.md index c1fd4ffdb0..aa5e7e491b 100644 --- a/skype/skype-ps/skype/Get-CsLisCivicAddress.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisCivicAddress.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csliscivicaddress applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisCivicAddress -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csliscivicaddress +schema: 2.0.0 +title: Get-CsLisCivicAddress --- # Get-CsLisCivicAddress @@ -36,7 +37,7 @@ This flag can be automatically updated by running the Test-CsLisCivicAddress cmd ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisCivicAddress ``` @@ -46,7 +47,7 @@ The Get-CsLisCivicAddress cmdlet does not accept any parameters (other than the Therefore any call to the Get-CsLisCivicAddress cmdlet will always return all civic addresses. See Example 2 for a command that will allow you to retrieve more specific results. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisCivicAddress | Where-Object {$_.City -eq "Redmond"} ``` @@ -55,7 +56,7 @@ In this example, all the civic addresses in the city of Redmond are retrieved. The example begins with a call to the Get-CsLisCivicAddress cmdlet, which retrieves a collection of all civic addresses in the location database. This collection is then piped to the Where-Object cmdlet, which will return only those items in the collection with a City property value equal to (-eq) Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsLisCivicAddress | Where-Object {$_.MSAGValid -eq $true} ``` diff --git a/skype/skype-ps/skype/Get-CsLisLocation.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisLocation.md similarity index 91% rename from skype/skype-ps/skype/Get-CsLisLocation.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisLocation.md index 7b91277e0f..0a47e181b7 100644 --- a/skype/skype-ps/skype/Get-CsLisLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslislocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslislocation +schema: 2.0.0 +title: Get-CsLisLocation --- # Get-CsLisLocation @@ -34,14 +35,14 @@ The Get-CsLisCivicAddress cmdlet retrieves only address information. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisLocation ``` Calling the Get-CsLisLocation cmdlet with no parameters retrieves all locations defined within the location configuration database. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisLocation -Unreferenced ``` @@ -49,7 +50,7 @@ Get-CsLisLocation -Unreferenced The Unreferenced parameter doesn't accept a value. It's simply a switch that tells the Get-CsLisLocation cmdlet to return only those locations that are not associated with a port, switch, subnet, or wireless access point. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsLisLocation | Where-Object {$_.Location -ceq "NorthCampus"} ``` @@ -64,14 +65,16 @@ That means that in this case only locations with Location values of NorthCampus ## PARAMETERS ### -Unreferenced + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Including this parameter will retrieve only the locations that were not associated with a port, subnet, switch, or wireless access point. In other words, including this parameter retrieves all locations that either were created by calling the Set-CsLisLocation cmdlet or that were assigned to a Location Information Server (LIS) port, subnet, switch, or wireless access point that no longer exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsLisPort.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisPort.md similarity index 94% rename from skype/skype-ps/skype/Get-CsLisPort.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisPort.md index 3eec392209..d4506c2443 100644 --- a/skype/skype-ps/skype/Get-CsLisPort.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisPort.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslisport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisPort -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslisport +schema: 2.0.0 +title: Get-CsLisPort --- # Get-CsLisPort @@ -38,14 +39,14 @@ To narrow down the information retrieved, you must pipe the output from this cmd ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisPort ``` Example 1 retrieves all Location Information Server (LIS) ports and any associated locations that have been defined in the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisPort | Where-Object {$_.City -eq "Redmond"} ``` diff --git a/skype/skype-ps/skype/Get-CsLisServiceProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisServiceProvider.md similarity index 95% rename from skype/skype-ps/skype/Get-CsLisServiceProvider.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisServiceProvider.md index 2efdc5c58d..8908eda271 100644 --- a/skype/skype-ps/skype/Get-CsLisServiceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisServiceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslisserviceprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisServiceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslisserviceprovider +schema: 2.0.0 +title: Get-CsLisServiceProvider --- # Get-CsLisServiceProvider @@ -31,7 +32,7 @@ This cmdlet retrieves information about a provider, including the name of the pr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisServiceProvider ``` diff --git a/skype/skype-ps/skype/Get-CsLisSubnet.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisSubnet.md similarity index 94% rename from skype/skype-ps/skype/Get-CsLisSubnet.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisSubnet.md index 070908d63a..bc6be383e8 100644 --- a/skype/skype-ps/skype/Get-CsLisSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslissubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslissubnet +schema: 2.0.0 +title: Get-CsLisSubnet --- # Get-CsLisSubnet @@ -38,14 +39,14 @@ To narrow down the information retrieved, you must pipe the output from this cmd ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisSubnet ``` Example 1 retrieves all Location Information Server (LIS) subnets that have been defined in the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisSubnet | Where-Object {$_.Subnet -eq "192.0.10.0"} ``` diff --git a/skype/skype-ps/skype/Get-CsLisSwitch.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisSwitch.md similarity index 93% rename from skype/skype-ps/skype/Get-CsLisSwitch.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisSwitch.md index b4fbab5b8d..367b13af80 100644 --- a/skype/skype-ps/skype/Get-CsLisSwitch.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisSwitch.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslisswitch applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisSwitch -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslisswitch +schema: 2.0.0 +title: Get-CsLisSwitch --- # Get-CsLisSwitch @@ -38,14 +39,14 @@ To narrow down the information retrieved you must pipe the output from this cmdl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisSwitch ``` Example 1 retrieves all Location Information Server (LIS) switches that have been defined in the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisSwitch | Where-Object {$_.ChassisID -eq "99-99-99-99-99-99"} ``` @@ -56,7 +57,7 @@ The command begins by calling the Get-CsLisSwitch cmdlet to retrieve all switch This collection of switch locations is piped to the Where-Object cmdlet. The Where-Object cmdlet checks the ChassisID property of each item in the collection and returns the item with the ChassisID value 99-99-99-99-99-99. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsLisSwitch | Where-Object {$_.City -eq "Redmond"} ``` diff --git a/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisWirelessAccessPoint.md similarity index 93% rename from skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisWirelessAccessPoint.md index 469f7a2244..587398d70e 100644 --- a/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisWirelessAccessPoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csliswirelessaccesspoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisWirelessAccessPoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csliswirelessaccesspoint +schema: 2.0.0 +title: Get-CsLisWirelessAccessPoint --- # Get-CsLisWirelessAccessPoint @@ -38,14 +39,14 @@ To narrow down the information retrieved, you must pipe the output from this cmd ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisWirelessAccessPoint ``` Example 1 retrieves all Location Information Server (LIS) WAPs that have been defined in the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisWirelessAccessPoint | Where-Object {$_.BSSID -eq "99-99-99-99-99-99"} ``` @@ -56,7 +57,7 @@ The command begins by calling the Get-CsLisWirelessAccessPoint cmdlet to retriev This collection of WAP locations is piped to the Where-Object cmdlet. The Where-Object cmdlet checks the BSSID property of each item in the collection and returns the item with the BSSID value 99-99-99-99-99-99. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsLisWirelessAccessPoint | Where-Object {$_.City -eq "Redmond"} ``` diff --git a/skype/skype-ps/skype/Get-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsLocationPolicy.md similarity index 88% rename from skype/skype-ps/skype/Get-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLocationPolicy.md index 06e3d908b0..b3d22d64f4 100644 --- a/skype/skype-ps/skype/Get-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslocationpolicy +schema: 2.0.0 +title: Get-CsLocationPolicy --- # Get-CsLocationPolicy @@ -39,7 +40,7 @@ This cmdlet retrieves one or more location policies. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLocationPolicy ``` @@ -47,7 +48,7 @@ Get-CsLocationPolicy Example 1 returns a collection of all the location policies currently in use in your organization. This is done simply by calling the Get-CsLocationPolicy cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLocationPolicy -Identity Reno ``` @@ -55,7 +56,7 @@ Get-CsLocationPolicy -Identity Reno The command shown in Example 2 returns only those location policies that have an Identity equal to Reno. Because identities must be unique, this command will only return, at most, one location policy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsLocationPolicy -Filter tag:* ``` @@ -64,7 +65,7 @@ Example 3 uses the Filter parameter to return all the location policies that hav (Policies configured at the per-user scope can be directly assigned to users and network sites.) The wildcard string tag:* tells the Get-CsLocationPolicy cmdlet that the returned data should be limited to those location policies that have an Identity that begins with the string value tag:. Even though you don't need to specify the tag: prefix when retrieving an individual policy, you can use that prefix to filter on all per-user policies. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsLocationPolicy | Where-Object {$_.EnhancedEmergencyServicesEnabled -eq $False} ``` @@ -76,49 +77,55 @@ That collection is then piped to the Where-Object cmdlet; in turn, the Where-Obj ## PARAMETERS -### -Identity -The unique identifier of the location policy you want to retrieve. -To retrieve the global location policy, use a value of Global. -For a policy created at the site scope, this value will be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment (for example, site:Redmond). -For a policy created at the per-user scope, this value will simply be the name of the policy, such as Reno. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing wildcard characters that will retrieve location policies based on matching the Identity value of the policy to the wildcard string. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string containing wildcard characters that will retrieve location policies based on matching the Identity value of the policy to the wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the location policy you want to retrieve. +To retrieve the global location policy, use a value of Global. +For a policy created at the site scope, this value will be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment (for example, site:Redmond). +For a policy created at the per-user scope, this value will simply be the name of the policy, such as Reno. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the location policy information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +135,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose location policies are being returned. For example: @@ -140,8 +150,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsManagementConnection.md b/skype/skype-ps/SkypeForBusiness/Get-CsManagementConnection.md similarity index 86% rename from skype/skype-ps/skype/Get-CsManagementConnection.md rename to skype/skype-ps/SkypeForBusiness/Get-CsManagementConnection.md index be0b6e4a2d..4687a41c9d 100644 --- a/skype/skype-ps/skype/Get-CsManagementConnection.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsManagementConnection.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmanagementconnection applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsManagementConnection -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmanagementconnection +schema: 2.0.0 +title: Get-CsManagementConnection --- # Get-CsManagementConnection @@ -35,32 +36,15 @@ By comparison, the Get-CsConfigurationStoreLocation cmdlet always returns inform ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsManagementConnection ``` The command in Example 1 returns information about the management connection to the Central Management store. - ## PARAMETERS -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsManagementStoreReplicationStatus.md similarity index 90% rename from skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md rename to skype/skype-ps/SkypeForBusiness/Get-CsManagementStoreReplicationStatus.md index a9c3ebe4b8..920430ffbc 100644 --- a/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsManagementStoreReplicationStatus.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmanagementstorereplicationstatus applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsManagementStoreReplicationStatus -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmanagementstorereplicationstatus +schema: 2.0.0 +title: Get-CsManagementStoreReplicationStatus --- # Get-CsManagementStoreReplicationStatus @@ -36,14 +37,14 @@ The Get-CsManagementStoreReplicationStatus cmdlet enables you to verify the repl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsManagementStoreReplicationStatus ``` In Example 1, the Get-CsManagementStoreReplicationStatus cmdlet is called without any parameters; that returns the replication status (up to date or not up to date) for all Skype for Business Server computers. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsManagementStoreReplicationStatus | Where-Object {$_.UpToDate -eq $False} ``` @@ -52,14 +53,14 @@ Example 2 returns a collection of all the computers where replication is not up This is done by first using the Get-CsManagementStoreReplicationStatus cmdlet to retrieve a collection containing the replication status for all the servers. This collection is then piped to the Where-Object cmdlet, which applies a filter that limits the returned data to computers where the UpToDate property is equal to False. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsManagementStoreReplicationStatus -ReplicaFqdn atl-cs-001.litwareinc.com ``` In Example 3, returned data is limited to a single computer: atl-cs-001.litwareinc.com/ -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsManagementStoreReplicationStatus | Where-Object {$_.LastUpdateCreation -lt "8/11/2018 8:00 PM"} ``` @@ -78,7 +79,7 @@ The dates specified in this example use the U.S. English format for date-time values. Dates should be specified using a format compatible with your Regional and Language Options. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsManagementStoreReplicationStatus -CentralManagementStoreStatus ``` @@ -89,36 +90,40 @@ This includes the fully qualified domains names of the Active Master and the Fil ## PARAMETERS -### -ReplicaFqdn -Fully qualified domain name (FQDN) of the computer for which the replication status is to be checked. -For example: -ReplicaFqdn "atl-cs-001.litwareinc.com". +### -CentralManagementStoreStatus -If this parameter is not included, then replication status information for all your Skype for Business Server computers will be returned. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns additional information about the current status of the Central Management store, including a list of active replicas and deleted replicas, as well as the location of the Active Master and the File Transfer Agent services. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -CentralManagementStoreStatus -Returns additional information about the current status of the Central Management store, including a list of active replicas and deleted replicas, as well as the location of the Active Master and the File Transfer Agent services. +### -ReplicaFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the computer for which the replication status is to be checked. +For example: -ReplicaFqdn "atl-cs-001.litwareinc.com". + +If this parameter is not included, then replication status information for all your Skype for Business Server computers will be returned. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/skype/skype-ps/skype/Get-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsMcxConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsMcxConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsMcxConfiguration.md index 8a44cb988e..12fffd2b5e 100644 --- a/skype/skype-ps/skype/Get-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMcxConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmcxconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsMcxConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmcxconfiguration +schema: 2.0.0 +title: Get-CsMcxConfiguration --- # Get-CsMcxConfiguration @@ -44,21 +45,21 @@ The Get-CsMcxConfiguration cmdlet provides a way for administrators to retrieve ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMcxConfiguration ``` The command shown in Example 1 returns information about all the Mobility Service configuration settings currently in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMcxConfiguration -Identity "global" ``` In Example 2, information is returned only for the global collection of Mobility Service configuration settings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMcxConfiguration -Filter "service:*" ``` @@ -67,7 +68,7 @@ Example 3 returns information about all the Mobility Service configuration setti To do this, the Filter parameter is included along with the string value "service:*". That filter value returns all the Mobility Service configuration settings that have an Identity that begins with the string value "service:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMcxConfiguration | Where-Object {$_.ExposedWebURL -eq "External"} ``` @@ -76,7 +77,7 @@ In Example 4, the only Mobility Service configuration settings returned are thos To do this, the command first calls the Get-CsMcxConfiguration cmdlet without any parameters in order to return a collection of all the Mobility Service configuration settings currently in use in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the ExposedWebURL property is equal to (-eq) External. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsMcxConfiguration | Where-Object {$_.SessionExpirationInterval -lt 259200} ``` @@ -89,6 +90,9 @@ That collection is then piped to the Where-Object cmdlet, which, in turn, select ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a collection of Mobility Service configuration settings. For example, to return a collection of all the settings configured at the site scope, use this syntax: @@ -101,8 +105,7 @@ To return a collection of all the settings configured at the service scope, use ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +115,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of Mobility Service configuration settings you want to return. To refer to the global settings, use this syntax: @@ -133,8 +139,7 @@ If this parameter is not specified, then the Get-CsMcxConfiguration cmdlet retur ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -144,13 +149,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Mobility Service configuration 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsMediaConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Get-CsMediaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsMediaConfiguration.md index 226f87551c..89dcc63754 100644 --- a/skype/skype-ps/skype/Get-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMediaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsMediaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmediaconfiguration +schema: 2.0.0 +title: Get-CsMediaConfiguration --- # Get-CsMediaConfiguration @@ -35,14 +36,14 @@ This cmdlet retrieves one or more collections of settings that define media inte ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMediaConfiguration ``` Example 1 returns all the media configurations in use in your organization; this is done simply by invoking the Get-CsMediaConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMediaConfiguration -Identity site:Redmond1 ``` @@ -50,7 +51,7 @@ Get-CsMediaConfiguration -Identity site:Redmond1 Example 2 returns only the media configuration that has the Identity site:Redmond1. Because identities must be unique, specifying an Identity ensures that you will never retrieve more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMediaConfiguration -Filter site:* ``` @@ -58,7 +59,7 @@ Get-CsMediaConfiguration -Filter site:* In Example 3, the Filter parameter is used to return all the media configurations at the site scope. The wildcard string site:* ensures that Windows PowerShell will return only those media configurations that have identities beginning with the string value site:. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMediaConfiguration | Where-Object {$_.EncryptionLevel -eq "SupportEncryption"} ``` @@ -67,7 +68,7 @@ In this example, the Get-CsMediaConfiguration cmdlet and the Where-Object cmdlet To do this, the command first uses the Get-CsMediaConfiguration cmdlet to retrieve all the media configurations in use in your organization. This information is then piped to the Where-Object cmdlet, which applies a filter that restricts the returned data to those configurations where the EncryptionLevel property is equal to (-eq) SupportEncryption. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsMediaConfiguration -Filter *:*med* ``` @@ -78,47 +79,53 @@ For example, this command will retrieve media configuration settings defined for ## PARAMETERS -### -Identity -The unique identifier of the media configuration you want to retrieve. -This identifier specifies the scope at which this configuration is applied (global, site, or service). +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the media configuration you want to retrieve. +This identifier specifies the scope at which this configuration is applied (global, site, or service). ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the media configuration information from the local replica of the Central Management store, rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsMeetingConfiguration.md index 431f2547ca..51a5a0357d 100644 --- a/skype/skype-ps/skype/Get-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingConfiguration.md @@ -1,16 +1,18 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsMeetingConfiguration -schema: 2.0.0 +audience: ITPro author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau +ms.localizationpriority: medium ms.reviewer: rogupta -manager: bulenteg -audience: ITPro -ms.topic: reference -ms.localizationpriority: medium +ms.topic: reference +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmeetingconfiguration +schema: 2.0.0 +title: Get-CsMeetingConfiguration --- # Get-CsMeetingConfiguration @@ -46,21 +48,21 @@ When used in on-premises environments, the Get-CsMeetingConfiguration cmdlet ena ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMeetingConfiguration ``` The command shown in Example 1 returns a collection of all the meeting configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingConfiguration -Identity site:Redmond ``` In Example 2, only one collection of meeting configuration settings is returned: the settings that have the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMeetingConfiguration -Filter "service:*" ``` @@ -68,7 +70,7 @@ Get-CsMeetingConfiguration -Filter "service:*" Example 3 returns all the meeting configuration settings that have been configured at the service scope. This is done by including the Filter parameter and the filter value "service:*", which limits returned data to settings where the Identity property begins with the characters "service:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMeetingConfiguration | Where-Object {$_.AdmitAnonymousUsersByDefault -eq $True} ``` @@ -80,7 +82,39 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection of meeting configuration settings. +Because each tenant is limited to a single, global collection of meeting configuration settings there is no need to use the Filter parameter. +However, this is valid syntax for the Get-CsMeetingConfiguration cmdlet: + +`Get-CsMeetingConfiguration " -Filter "g*"` + +This parameter can be used as follows when using Skype for Business Server (on-premises). + +To return a collection of all the settings configured at the site scope, use this syntax: +`-Filter site:*` +To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter on) use this syntax: +`-Filter *EMEA*` + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the collection of meeting configuration settings to be returned. Because each tenant is limited to a single, global collection of meeting configuration settings there is no need include this parameter when calling the Get-CsMeetingConfiguration cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter for Online environments. @@ -88,7 +122,7 @@ For example: `Get-CsMeetingConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` -This parameter can be used as follows when using Skype for Business Server (on-premises). To refer to the global settings, use this syntax: +This parameter can be used as follows when using Skype for Business Server (on-premises). To refer to the global settings, use this syntax: `-Identity global` To refer to a collection configured at the site scope, use syntax similar to this: @@ -105,8 +139,7 @@ If you need to use wildcards, then include the Filter parameter instead. ```yaml Type: XdsIdentity Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,25 +148,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection of meeting configuration settings. -Because each tenant is limited to a single, global collection of meeting configuration settings there is no need to use the Filter parameter. -However, this is valid syntax for the Get-CsMeetingConfiguration cmdlet: +### -LocalStore -`Get-CsMeetingConfiguration " -Filter "g*"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter can be used as follows when using Skype for Business Server (on-premises). +Retrieves the meeting configuration data from the local replica of the Central Management store rather than from the Central Management store itself. -To return a collection of all the settings configured at the site scope, use this syntax: -`-Filter site:*` -To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter on) use this syntax: -`-Filter *EMEA*` +This parameter is not used with Skype for Business Online. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -143,6 +169,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose meeting configuration settings are to be retrieved. For example: @@ -160,26 +189,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid 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 -``` - -### -LocalStore -Retrieves the meeting configuration data from the local replica of the Central Management store rather than from the Central Management store itself. - -This parameter is not used with Skype for Business Online. - -```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 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingRoom.md similarity index 89% rename from skype/skype-ps/skype/Get-CsMeetingRoom.md rename to skype/skype-ps/SkypeForBusiness/Get-CsMeetingRoom.md index 4401dd0254..4da389d1cb 100644 --- a/skype/skype-ps/skype/Get-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingRoom.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsMeetingRoom -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmeetingroom +schema: 2.0.0 +title: Get-CsMeetingRoom --- # Get-CsMeetingRoom @@ -49,21 +51,21 @@ The functions carried out by the Get-CsMeetingRoom cmdlet are not available in t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMeetingRoom ``` The command shown in Example 1 returns information about all the meeting rooms configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingRoom -Identity "sip:RedmondMeetingRoom@litwareinc.com" ``` Example 2 returns information for a single meeting room: the system with the SIP address sip:RedmondMeetingRoom@litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMeetingRoom -Filter {VoicePolicy -eq "RedmondVoicePolicy"} ``` @@ -76,6 +78,9 @@ That filter value limits the returned data to meeting rooms where the VoicePolic ## PARAMETERS ### -Credential + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to run the Get-CsMeetingRoom cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. @@ -85,8 +90,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +100,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve meeting room information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +119,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on Skype for Business-specific attributes. For example, you can limit returned data to meeting rooms that have been assigned a specific voice policy, or rooms that have not been assigned a specific voice policy. @@ -124,8 +133,7 @@ For example, a filter that returns only rooms that have been assigned the voice ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +143,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the meeting room to be retrieved. Meeting room Identities are typically specified using one of four formats: 1) the room's SIP address; 2) the room's user principal name (UPN); 3) the room's domain name and logon name, in the form domain\logon (for example, litwareinc\room14); and, 4) the room's Active Directory display name (for example, Room 14). @@ -146,8 +157,7 @@ For example, the Identity "*Redmond*" returns all the rooms that have a display ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -157,6 +167,9 @@ Accept wildcard characters: False ``` ### -LdapFilter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business). For example, you can limit returned data to meeting rooms belonging to a specific department.The LdapFilter parameter uses the LDAP query language when creating filters. For example, a filter that returns only meeting rooms found in the city of Redmond would look like this: @@ -168,8 +181,7 @@ In that syntax, "l" (a lowercase L) represents the Active Directory attribute (l ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +191,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return information about meeting rooms in a specific organizational unit (OU) or container. The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable -- meeting rooms will be returned from each of these three OUs. @@ -190,8 +205,7 @@ When specifying an OU, use the distinguished name (DN) of that container; for ex ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +215,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2013, Skype for Business Server 2015 Enables you to limit the number of records returned by the cmdlet. @@ -214,8 +231,7 @@ If you set the ResultSize to 7 but you have only three meeting rooms in your for ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsMobilityPolicy.md similarity index 88% rename from skype/skype-ps/skype/Get-CsMobilityPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsMobilityPolicy.md index c59665485e..cfa30d7966 100644 --- a/skype/skype-ps/skype/Get-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMobilityPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmobilitypolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsMobilityPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmobilitypolicy +schema: 2.0.0 +title: Get-CsMobilityPolicy --- # Get-CsMobilityPolicy @@ -52,21 +54,21 @@ Mobility policies can be configured at the global, site, or the per-user scope, ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMobilityPolicy ``` The command shown in Example 1 returns information about all the mobility policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMobilityPolicy -Identity "site:Redmond" ``` Example 2 returns information about a single mobility policy: the policy with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMobilityPolicy -Filter "tag:*" ``` @@ -75,7 +77,7 @@ In Example 3, information is returned for all of your per-user mobility policies To do this, the Filter parameter is included along with the filter value "tag:*"; this returns any policy that has an Identity that begins with the string value "tag:". By definition, any policy that has an identity beginning with that string value is a per-user policy. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMobilityPolicy | Where-Object {$_.EnableOutsideVoice -eq $False} ``` @@ -87,7 +89,28 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -ApplicableTo + +> Applicable: Skype for Business Online + +{{Fill ApplicableTo Description}} + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return all the policies configured at the site scope use this syntax: @@ -100,8 +123,7 @@ To return a collection of all the per-user policies, use this syntax: ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +133,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the mobility policy to be returned. To refer to the global policy, use this syntax: @@ -129,8 +154,7 @@ If this parameter is not specified, then the Get-CsMobilityPolicy cmdlet returns ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -139,30 +163,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the mobility 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: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -Include -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -ApplicableTo -{{Fill ApplicableTo Description}} +{{Fill Include Description}} ```yaml -Type: UserIdParameter +Type: PolicyFilter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +Accepted values: Automatic, All, SubscriptionDefaults, TenantDefinedOnly Required: False Position: Named @@ -171,15 +182,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Include -{{Fill Include Description}} +### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves the mobility policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml -Type: PolicyFilter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Accepted values: Automatic, All, SubscriptionDefaults, TenantDefinedOnly -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -189,13 +201,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkBandwidthPolicyProfile.md similarity index 86% rename from skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkBandwidthPolicyProfile.md index de1572dc01..aa829b2055 100644 --- a/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkBandwidthPolicyProfile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkBandwidthPolicyProfile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkbandwidthpolicyprofile +schema: 2.0.0 +title: Get-CsNetworkBandwidthPolicyProfile --- # Get-CsNetworkBandwidthPolicyProfile @@ -37,14 +38,14 @@ As part of call admission control (CAC), a bandwidth policy is used to define ba ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkBandwidthPolicyProfile ``` Calling the Get-CsNetworkBandwidthPolicyProfile cmdlet without any parameters will retrieve all bandwidth policy profiles defined within the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile ``` @@ -52,7 +53,7 @@ Get-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile This example retrieves the bandwidth policy profile with the Identity LowBWProfile. Because identities must be unique this will return, at most, one profile. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkBandwidthPolicyProfile -Filter *50MB* ``` @@ -64,47 +65,53 @@ For example, this would retrieve profiles with identities such as "BW profile fo ## PARAMETERS -### -Identity -A string value that uniquely identifies the bandwidth policy profile you want to retrieve. -Specifying an Identity will retrieve, at most, one profile. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing wildcards that is used to retrieve bandwidth policy profiles that have Identity values that match the wildcard pattern. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string containing wildcards that is used to retrieve bandwidth policy profiles that have Identity values that match the wildcard pattern. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string value that uniquely identifies the bandwidth policy profile you want to retrieve. +Specifying an Identity will retrieve, at most, one profile. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network bandwidth policy profile from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Get-CsNetworkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkConfiguration.md index 5914281385..0be2037370 100644 --- a/skype/skype-ps/skype/Get-CsNetworkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkConfiguration.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkconfiguration +schema: 2.0.0 +title: Get-CsNetworkConfiguration --- # Get-CsNetworkConfiguration @@ -38,7 +40,7 @@ For example, to retrieve the network regions, it will usually be easier to call ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkConfiguration ``` @@ -46,7 +48,7 @@ Get-CsNetworkConfiguration This example retrieves the network configuration settings. These settings are defined only at the global scope, so only one item will be returned. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` (Get-CsNetworkConfiguration).MediaBypassSettings ``` @@ -58,46 +60,52 @@ This command first retrieves that configuration by calling the Get-CsNetworkConf ## PARAMETERS -### -Identity -This will always be Global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Because there will only ever be one network configuration, you do not need this parameter for this cmdlet. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Because there will only ever be one network configuration, you do not need this parameter for this cmdlet. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +This will always be Global. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```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 +Aliases: Required: False Position: Named @@ -107,13 +115,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterRegionRoute.md similarity index 87% rename from skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterRegionRoute.md index c65e85e16f..02beecac2f 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterRegionRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkInterRegionRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkinterregionroute +schema: 2.0.0 +title: Get-CsNetworkInterRegionRoute --- # Get-CsNetworkInterRegionRoute @@ -37,21 +38,21 @@ This cmdlet retrieves information about these route associations. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkInterRegionRoute -Identity NA_APAC_Route ``` Example 1 retrieves the route with the Identity NA_APAC_Route. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkInterRegionRoute -Filter *APAC* ``` In Example 2, we use the Filter parameter to retrieve all routes that contain the string APAC anywhere within the Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkInterRegionRoute | Where-Object {$_.NetworkRegionLinks -eq "NA_EMEA"} ``` @@ -62,7 +63,7 @@ Calling this cmdlet with no parameters retrieves all routes defined with the CAC This collection of routes is then piped to the Where-Object cmdlet. The Where-Object cmdlet takes the collection and retrieves all items in the collection that have the value NA_EMEA within their NetworkRegionLinks list. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkInterRegionRoute | Where-Object {$_.NetworkRegionID1 -eq "NorthAmerica" -or $_.NetworkRegionID2 -eq "NorthAmerica"} ``` @@ -77,48 +78,54 @@ It does this by checking to see if the route has a NetworkRegionID1 value equal ## PARAMETERS -### -Identity -The unique identifier for the network region route you want to retrieve. -Network region routes are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies a particular route. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string that allows you to retrieve routes based on matching the Identity values to the wildcard string passed as a value to this parameter. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string that allows you to retrieve routes based on matching the Identity values to the wildcard string passed as a value to this parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier for the network region route you want to retrieve. +Network region routes are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies a particular route. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network interregion route information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterSitePolicy.md similarity index 86% rename from skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterSitePolicy.md index 447ed6ca95..21f59828ff 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterSitePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkInterSitePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkintersitepolicy +schema: 2.0.0 +title: Get-CsNetworkInterSitePolicy --- # Get-CsNetworkInterSitePolicy @@ -36,7 +37,7 @@ This cmdlet retrieves one or more network site policies that associate bandwidth ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkInterSitePolicy ``` @@ -45,7 +46,7 @@ Calling the Get-CsNetworkInterSitePolicy cmdlet with no parameters retrieves all -### -------------------------- Example 2 -------------------------- (Lync Server 2010) +### Example 2 (Lync Server 2010) ``` Get-CsNetworkInterSitePolicy -Identity Reno_Portland ``` @@ -54,7 +55,7 @@ This example retrieves the network site policy with the Identity Reno_Portland. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkInterSitePolicy -Filter *Reno* ``` @@ -64,7 +65,7 @@ The wildcard characters (*) within the value passed to the Filter parameter sign -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkInterSitePolicy | Where-Object {$_.BWPolicyProfileID -eq $null} ``` @@ -79,48 +80,54 @@ It does this by comparing to see if the BWPolicyProfileID property of each site ## PARAMETERS -### -Identity -The unique identifier of the network site policy you want to retrieve. -Network site policies are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies that policy. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing wildcard characters that will search for policies with Identity values matching the wildcard string. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string containing wildcard characters that will search for policies with Identity values matching the wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network site policy you want to retrieve. +Network site policies are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies that policy. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network inter-site policy information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkInterface.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterface.md similarity index 88% rename from skype/skype-ps/skype/Get-CsNetworkInterface.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterface.md index cce4863773..962ae9f4c7 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterface.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterface.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkinterface applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkInterface -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkinterface +schema: 2.0.0 +title: Get-CsNetworkInterface --- # Get-CsNetworkInterface @@ -38,21 +39,21 @@ The Get-CsNetworkInterface cmdlet provides a way for administrators to return in ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkInterface ``` Example 1 returns information for all the network interfaces configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkInterface -Identity atl-cs-001.litwareinc.com/Primary/1 ``` The command shown in Example 2 returns information about a single network interface: the interface that has the Identity atl-cs-001.litwareinc.com.com/Primary/1. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkInterface -Filter "*.litwareinc.com*" ``` @@ -61,7 +62,7 @@ In Example 3, information is returned for all the network interfaces in the doma To do this, the Filter parameter is included, along with the filter value "*.litwareinc.com*". This filter value limits the returned data to interfaces that have an Identity that includes the string value "litwareinc.com". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkInterface | Where-Object {$_.IPAddress -eq "192.168.0.240"} ``` @@ -70,7 +71,7 @@ Example 4 returns information about all the network interfaces configured for th To do this, the command first calls the Get-CsNetworkInterface cmdlet without any parameters; this returns a collection of all the network interfaces configured for use in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those interfaces where the IPAddress property is equal to 192.168.0.240. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsNetworkInterface | Where-Object {$_.IPAddress -like "192.168.0.*"} ``` @@ -78,7 +79,7 @@ Get-CsNetworkInterface | Where-Object {$_.IPAddress -like "192.168.0.*"} The command shown in Example 5 is a variation of the command shown in Example 4; in this case, however, information is returned for all the network interfaces configured for the subnet "192.168.0.*". This is done by retrieving a collection of all the network interfaces, piping that collection to the Where-Object cmdlet, and then picking out only those interfaces where IPAddress starts with the string value "192.168.0.". -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsNetworkInterface | Where-Object {$_.Interface -eq "External"} ``` @@ -90,40 +91,31 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS -### -Identity -Unique identifier for the network interface to be returned. -A network interface Identity consists of three parts: - -- The fully qualified domain name (FQDN) of the computer itself (for example, atl-cs-001.litwareinc.com). -- The network interface "side" (Primary; Internal; External; public switched telephone network). -- The side indicates the type of traffic the port is used for. - -The network interface number for that particular side. - -For example: +### -ComputerFqdn -`-Identity "atl-cs-001.litwareinc.com/Primary/1"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The Identity, ComputerFqdn, and Filter parameters must be used separately; for example, you cannot run a command that uses both ComputerFqdn and Identity. -In addition, you cannot use wildcard characters when specifying the Identity. -To employ wildcards, use the Filter parameter. +FQDN of the computer for which network interface information is to be returned. +For example, to return network interface information for the computer atl-cs-001.litwareinc.com (and only for that computer) use this syntax: -If neither the Identity, ComputerFqdn, nor Filter parameters are used, then the Get-CsNetworkInterface cmdlet returns information about all the network interfaces currently in use on your computers running a Skype for Business Server service or server role. +`-ComputerFqdn atl-cs-001.litwareinc.com` ```yaml -Type: NetworkInterfaceIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when specifying the network interface (or interfaces) to be returned. For example, this syntax returns information about the Primary network interface used on all of your computers running a Skype for Business Server service or server role: @@ -132,8 +124,7 @@ For example, this syntax returns information about the Primary network interface ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,20 +133,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerFqdn -FQDN of the computer for which network interface information is to be returned. -For example, to return network interface information for the computer atl-cs-001.litwareinc.com (and only for that computer) use this syntax: +### -Identity -`-ComputerFqdn atl-cs-001.litwareinc.com` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the network interface to be returned. +A network interface Identity consists of three parts: + +- The fully qualified domain name (FQDN) of the computer itself (for example, atl-cs-001.litwareinc.com). +- The network interface "side" (Primary; Internal; External; public switched telephone network). +- The side indicates the type of traffic the port is used for. + +The network interface number for that particular side. + +For example: + +`-Identity "atl-cs-001.litwareinc.com/Primary/1"` + +The Identity, ComputerFqdn, and Filter parameters must be used separately; for example, you cannot run a command that uses both ComputerFqdn and Identity. +In addition, you cannot use wildcard characters when specifying the Identity. +To employ wildcards, use the Filter parameter. + +If neither the Identity, ComputerFqdn, nor Filter parameters are used, then the Get-CsNetworkInterface cmdlet returns information about all the network interfaces currently in use on your computers running a Skype for Business Server service or server role. ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: NetworkInterfaceIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/Get-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegion.md similarity index 86% rename from skype/skype-ps/skype/Get-CsNetworkRegion.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegion.md index bac9faa045..4ed8aaee59 100644 --- a/skype/skype-ps/skype/Get-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkregion +schema: 2.0.0 +title: Get-CsNetworkRegion --- # Get-CsNetworkRegion @@ -38,14 +39,14 @@ Use this cmdlet to retrieve information about one or more network regions, inclu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkRegion ``` Example 1 retrieves all network regions defined for the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkRegion -Identity NorthAmerica ``` @@ -53,14 +54,14 @@ Get-CsNetworkRegion -Identity NorthAmerica Example 2 retrieves the network regions with the Identity NorthAmerica. Because identities are unique, this command retrieves at most one network region. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkRegion | Where-Object {$_.CentralSite -eq "site:Redmond"} ``` This example retrieves all network regions with identities that end with the string "America." This would retrieve regions with identities such as NorthAmerica, SouthAmerica, and CentralAmerica. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkRegion | Where-Object {$_.CentralSite -eq "site:Redmond"} ``` @@ -73,49 +74,55 @@ The Where-Object cmdlet filters this collection to return only those items (netw ## PARAMETERS -### -Identity -The unique identifier of the network region you want to retrieve. -The Identity will be in the form of a string that uniquely identifies that region. -(Note that the Identity is the same as the NetworkRegionID.) +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter allows you to perform a wildcard search on the Identity of all network regions configured for the organization. +Use the wildcard character to filter on any part of the Identity. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter allows you to perform a wildcard search on the Identity of all network regions configured for the organization. -Use the wildcard character to filter on any part of the Identity. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network region you want to retrieve. +The Identity will be in the form of a string that uniquely identifies that region. +(Note that the Identity is the same as the NetworkRegionID.) ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network region information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegionLink.md similarity index 86% rename from skype/skype-ps/skype/Get-CsNetworkRegionLink.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegionLink.md index 9c7f1775f6..0f03c02672 100644 --- a/skype/skype-ps/skype/Get-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegionLink.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkRegionLink -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkregionlink +schema: 2.0.0 +title: Get-CsNetworkRegionLink --- # Get-CsNetworkRegionLink @@ -36,21 +37,21 @@ This cmdlet retrieves one or more region links that are defined within the netwo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkRegionLink ``` Example 1 retrieves all network region links defined within a Skype for Business Server 2015 deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkRegionLink -Identity NA_EMEA ``` Example 2 retrieves information about (at most) one network region link, the link with the Identity NA_EMEA. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkRegionLink -Filter *EMEA* ``` @@ -60,7 +61,7 @@ Notice the * characters, one before the string EMEA and one after. This means any character or characters can precede or follow the string; the string EMEA simply must be included in the Identity somewhere. This will retrieve links with names such as NA_EMEA, EMEA_APAC, and EMEA2_SA. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkRegionLink | Where-Object {$_.NetworkRegionID1 -eq "EMEA" -or $_.NetworkRegionID2 -eq "EMEA"} ``` @@ -74,49 +75,55 @@ If either of these properties is equal to EMEA--in other words if either Network ## PARAMETERS -### -Identity -The unique identifier of the network region link you want to retrieve. -Network region links are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies that link. -(Note that this value is the same as the NetworkRegionLinkID.) +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Accepts a wildcard string that is used to retrieve network links based on matching the value of the Identity to the wildcard string. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Accepts a wildcard string that is used to retrieve network links based on matching the value of the Identity to the wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network region link you want to retrieve. +Network region links are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies that link. +(Note that this value is the same as the NetworkRegionLinkID.) ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network region link information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSite.md similarity index 85% rename from skype/skype-ps/skype/Get-CsNetworkSite.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkSite.md index 63eaeaaf8c..109d52d820 100644 --- a/skype/skype-ps/skype/Get-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworksite +schema: 2.0.0 +title: Get-CsNetworkSite --- # Get-CsNetworkSite @@ -36,7 +37,7 @@ This cmdlet retrieves the settings for one or more existing sites. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkSite ``` @@ -45,14 +46,14 @@ Calling the Get-CsNetworkSite cmdlet with no parameters will return all network -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSite -Identity Redmond ``` This command retrieves the site with the Identity (and, by definition, the NetworkSiteID) Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkSite -Filter NA* ``` @@ -61,7 +62,7 @@ The command in Example 3 calls the Get-CsNetworkSite cmdlet with the Filter para The value of the Filter parameter is NA*, meaning that this command will retrieve all sites with an Identity beginning with the string NA and followed by any number of characters. This will return sites such as NARedmond, NAVancouver, and NAChicago. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkSite | Where-Object {$_.NetworkRegionID -eq "NorthAmerica"} ``` @@ -73,49 +74,55 @@ This collection of sites is then piped to the Where-Object cmdlet, which filters ## PARAMETERS -### -Identity -The unique identifier of the network site you want to retrieve. -Sites are created only at the global scope, so you do not need to specify a scope. -Instead, you need to specify only the site ID. -(Note that this is the same value as the NetworkSiteID for the network site.) +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A wildcard string that allows you to retrieve multiple sites based on matching the site Identity to the Filter value. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A wildcard string that allows you to retrieve multiple sites based on matching the site Identity to the Filter value. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network site you want to retrieve. +Sites are created only at the global scope, so you do not need to specify a scope. +Instead, you need to specify only the site ID. +(Note that this is the same value as the NetworkSiteID for the network site.) ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network site information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSubnet.md similarity index 84% rename from skype/skype-ps/skype/Get-CsNetworkSubnet.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkSubnet.md index aca38d63a4..290f7be6ff 100644 --- a/skype/skype-ps/skype/Get-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworksubnet +schema: 2.0.0 +title: Get-CsNetworkSubnet --- # Get-CsNetworkSubnet @@ -36,28 +37,28 @@ Use this cmdlet to retrieve information about the subnet, including the Identity ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkSubnet ``` This example retrieves all subnets within the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSubnet -Identity 172.11.15.0 ``` This example retrieves all information about the subnet with the Identity (the Subnet ID) 172.11.15.0. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkSubnet -Filter 172.11.* ``` This example retrieves all subnets with identities that begin with 172.11. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkSubnet | Where-Object {$_.NetworkSiteID -eq "Vancouver"} ``` @@ -70,49 +71,55 @@ The Where-Object cmdlet takes that collection and narrows it down to only those ## PARAMETERS -### -Identity -The unique subnet ID of the subnet you want to retrieve. -This value will be an IP address (such as 174.11.12.0). +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Use this parameter to perform a wildcard search of all subnets based on Identity. +For example, the Filter value 172.11.* will retrieve all subnets with an Identity beginning with 172.11. +(such as 172.11.10.0, 172.11.25.0, etc.). ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Use this parameter to perform a wildcard search of all subnets based on Identity. -For example, the Filter value 172.11.* will retrieve all subnets with an Identity beginning with 172.11. -(such as 172.11.10.0, 172.11.25.0, etc.). +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique subnet ID of the subnet you want to retrieve. +This value will be an IP address (such as 174.11.12.0). ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network subnet information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsOAuthConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsOAuthConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsOAuthConfiguration.md index b2c5cfbfdd..c5826254af 100644 --- a/skype/skype-ps/skype/Get-CsOAuthConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthConfiguration.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsOAuthConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csoauthconfiguration +schema: 2.0.0 +title: Get-CsOAuthConfiguration --- # Get-CsOAuthConfiguration @@ -45,7 +47,7 @@ The functions carried out by the Get-CsOAuthConfiguration cmdlet are not availab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOAuthConfiguration ``` @@ -56,6 +58,9 @@ The command shown in Example 1 returns information for the OAuth configuration s ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard values when referencing a collection of OAuth configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings: @@ -67,8 +72,7 @@ That syntax brings back all the OAuth configuration settings that have an Identi ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the OAuth configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsOAuthConfiguration cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -87,8 +94,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -98,13 +104,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the OAuth configuration 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose OAuth configuration settings are to be retrieved. For example: @@ -127,8 +138,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthServer.md similarity index 88% rename from skype/skype-ps/skype/Get-CsOAuthServer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsOAuthServer.md index d8186132f4..6b6eebe275 100644 --- a/skype/skype-ps/skype/Get-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsOAuthServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csoauthserver +schema: 2.0.0 +title: Get-CsOAuthServer --- # Get-CsOAuthServer @@ -44,14 +45,14 @@ The functions carried out by the Get-CsOAuthServer cmdlet are not available in t ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) +### Example 1 (Skype for Business Server 2015) ``` Get-CsOAuthServer ``` Example 1 returns information about all the OAuth servers configured for use in the organization. -### -------------------------- Example 2 -------------------------- (Skype for Business Server 2015) +### Example 2 (Skype for Business Server 2015) ``` Get-CsOAuthServer -Identity "Office 365" ``` @@ -62,6 +63,9 @@ In Example 2, information is returned for the OAuth server that has the Identity ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more OAuth servers. For example, to return all of the OAuth servers that have an Identity that includes the string value "Microsoft" use this syntax: @@ -70,8 +74,7 @@ For example, to return all of the OAuth servers that have an Identity that inclu ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the OAuth server to be returned. For example: @@ -91,8 +97,7 @@ If neither the Identity parameter nor the Filter parameter is included in the co ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the OAuth service 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose OAuth server settings are to be retrieved. For example: @@ -131,8 +141,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundCallingNumberTranslationRule.md similarity index 90% rename from skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsOutboundCallingNumberTranslationRule.md index 5583f31ca1..d83fea3bef 100644 --- a/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundCallingNumberTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsOutboundCallingNumberTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csoutboundcallingnumbertranslationrule +schema: 2.0.0 +title: Get-CsOutboundCallingNumberTranslationRule --- # Get-CsOutboundCallingNumberTranslationRule @@ -46,21 +47,21 @@ Double-click appropriate entry in the Name column and then, in the Edit Trunk Co ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOutboundCallingNumberTranslationRule ``` The command shown in Example 1 returns information about all the outbound calling number translation rules currently configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond/SevenDigit" ``` In Example 2, information is returned only for the outbound calling number translation rule that has the Identity "site:Redmond/SevenDigit." -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond" ``` @@ -68,7 +69,7 @@ Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond" Example 3 returns information for all the outbound calling number translation rules configured for the Redmond site. This is done by setting the value of the Identity parameter to the Identity of the Redmond site (site:Redmond). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond" | Where-Object {$_.Priority -eq 0} ``` @@ -81,6 +82,9 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Performs a wildcard search that allows you to return only those outbound translation rules that have Identities that match the wildcard string. For example, this syntax returns all the translation rules that include the string value "Redmond": @@ -93,8 +97,7 @@ To return all the translation rules configured at the site scope use this syntax ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the outbound calling number translation rule you want to retrieve. The Identity consists of the scope followed by a unique name within each scope; for example: @@ -118,8 +124,7 @@ If neither the Identity parameter nor the Filter parameter is specified the Get- ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -129,13 +134,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the outbound calling number translation rule 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundTranslationRule.md similarity index 87% rename from skype/skype-ps/skype/Get-CsOutboundTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsOutboundTranslationRule.md index 8b9c66c91c..96b1ba29a5 100644 --- a/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsOutboundTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csoutboundtranslationrule +schema: 2.0.0 +title: Get-CsOutboundTranslationRule --- # Get-CsOutboundTranslationRule @@ -44,21 +45,21 @@ The rule is automatically associated with the trunk configuration with the same ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOutboundTranslationRule ``` This example retrieves all outbound translation rules for the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond" ``` This example retrieves a single outbound translation rule: the rule with Identity site:Redmond/Prefix Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOutboundTranslationRule -Filter site:* ``` @@ -69,48 +70,54 @@ The command calls the Get-CsOutboundTranslationRule cmdlet with a Filter of site ## PARAMETERS -### -Identity -The unique identifier for the outbound translation rule you want to retrieve. -The Identity consists of the scope followed by a unique name within each scope (for example, site:Redmond/OutboundRule1). -Specifying a value for Identity will return at most one outbound translation rule. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Performs a wildcard search on Identity that allows you to narrow down your results to only those outbound translation rules whose identities match the given wildcard string. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Performs a wildcard search on Identity that allows you to narrow down your results to only those outbound translation rules whose identities match the given wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier for the outbound translation rule you want to retrieve. +The Identity consists of the scope followed by a unique name within each scope (for example, site:Redmond/OutboundRule1). +Specifying a value for Identity will return at most one outbound translation rule. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the outbound translation rule from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsPartnerApplication.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPartnerApplication.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPartnerApplication.md index d88eef5d7f..0742207f0c 100644 --- a/skype/skype-ps/skype/Get-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPartnerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPartnerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspartnerapplication +schema: 2.0.0 +title: Get-CsPartnerApplication --- # Get-CsPartnerApplication @@ -46,21 +47,21 @@ Skype for Business Server Control Panel: The functions carried out by the Get-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPartnerApplication ``` The command shown in Example 1 returns information about all the partner applications configured for use in the organization -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPartnerApplication -Identity "MicrosoftExchange" ``` Example 2 returns information for the partner application that has the Identity MicrosoftExchange. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPartnerApplication | Where-Object {$_.ApplicationIdentifier -eq "microsoft.exchange"} ``` @@ -68,7 +69,7 @@ Get-CsPartnerApplication | Where-Object {$_.ApplicationIdentifier -eq "microsoft In Example 3, information is returned for all the partner applications that have an application identifier equal to "microsoft.exchange." In order to do this, the command first calls the Get-CsPartnerApplication cmdlet without any parameters; that returns a collection of all the configured partner applications. That collection is then piped to the Where-Object cmdlet, which picks out only those partner applications where the ApplicationIdentifier property is equal to "microsoft.exchange." -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPartnerApplication | Where-Object {$_.Enabled -eq $False} ``` @@ -81,6 +82,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard values to return one or more partner applications. For example, to return all the partner applications that have an Identity that includes the string value "Microsoft" use this syntax: @@ -91,8 +95,7 @@ You cannot use both the Filter parameter and the Identity parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the partner application. For example: @@ -112,8 +118,7 @@ If neither the identity parameter nor the Filter parameter are included in the c ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -123,13 +128,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the partner application 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account where whose partner application settings are to be retrieved. For example: @@ -152,8 +162,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatAddin.md similarity index 92% rename from skype/skype-ps/skype/Get-CsPersistentChatAddin.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatAddin.md index 72d85cb632..a7a9afa8ab 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatAddin.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsPersistentChatAddin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchataddin +schema: 2.0.0 +title: Get-CsPersistentChatAddin --- # Get-CsPersistentChatAddin @@ -46,21 +47,21 @@ To view Persistent Chat add-in information in Skype for Business Server Control ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatAddin ``` Example 1 returns information about all the Persistent Chat add-ins configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITPersistentChatAddin" ``` In Example 2, information is returned for a specific Persistent Chat add-in: the add-in with the Identity atl-cs-001.litwareinc.com\ITPersistentChatAddin. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatAddin -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -71,6 +72,9 @@ Example 3 returns information for all the Persistent Chat add-ins configured for ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat add-in to be returned. The Identity is composed of the fully qualified domain name of the Persistent Chat pool where the add-in is located, a "\" character, and the add-in name. For example: @@ -82,8 +86,7 @@ If this parameter is not specified then the Get-CsPersistentChatAddin cmdlet ret ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name for the Persistent Chat pool. If this parameter is used then only Persistent Chat add-ins found on the specified pool will be returned. If this parameter is not used then the Get-CsPersistentChatAddin cmdlet will return add-ins from all your Persistent Chat pools. @@ -103,8 +109,7 @@ For example: ```yaml Type: String Parameter Sets: Pool -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatCategory.md similarity index 91% rename from skype/skype-ps/skype/Get-CsPersistentChatCategory.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatCategory.md index e00444b74c..e27b9541eb 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatCategory.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsPersistentChatCategory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatcategory +schema: 2.0.0 +title: Get-CsPersistentChatCategory --- # Get-CsPersistentChatCategory @@ -49,21 +50,21 @@ To view Persistent Chat categories in Skype for Business Server Control Panel, c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatCategory ``` The command shown in Example 1 returns information for all the Persistent Chat categories configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatCategory -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" ``` In Example 2, information is returned for all the Persistent Chat categories configured for use on the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatCategory | Where-Object {$_.Invites -eq $False} ``` @@ -72,7 +73,7 @@ Example 3 returns information for all the Persistent Chat categories where the I To do this, the command first uses the Get-CsPersistentChatCategory cmdlet to return a collection of all the Persistent Chat categories. This collection is then piped to the Where-Object cmdlet, which picks out only those categories where the Invites property is set to False ($False). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatCategory | Where-Object {$_.Creators -contains "Ken Myer"} ``` @@ -84,7 +85,29 @@ This collection is then piped to the Where-Object cmdlet, which picks out any ca ## PARAMETERS +### -AsObject + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +When specified, Active Directory display names are used when showing users who are on the AllowedMembers, DeniedMembers, or Creators lists. +When not specified, SIP addresses are used when showing these users. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the chat room category. The Identity consists of the Persistent Chat pool were the category is located followed by the category Name; for example: @@ -93,8 +116,7 @@ The Identity consists of the Persistent Chat pool were the category is located f ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -103,24 +125,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsObject -When specified, Active Directory display names are used when showing users who are on the AllowedMembers, DeniedMembers, or Creators lists. -When not specified, SIP addresses are used when showing these users. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -PersistentChatPoolFqdn -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -PersistentChatPoolFqdn Fully qualified domain name of the Persistent Chat pool that hosts Persistent Chat categories. If you use the PoolFqdn parameter without including the Name parameter, information will be returned for all the Persistent Chat categories on the specified pool. If you leave off both the Name and PoolFqdn parameters, then information will be returned for all your Persistent Chat categories. @@ -128,8 +136,7 @@ If you leave off both the Name and PoolFqdn parameters, then information will be ```yaml Type: String Parameter Sets: Pool -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatComplianceConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatComplianceConfiguration.md index cf19471a4f..27b163aafd 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatComplianceConfiguration.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsPersistentChatComplianceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatcomplianceconfiguration +schema: 2.0.0 +title: Get-CsPersistentChatComplianceConfiguration --- # Get-CsPersistentChatComplianceConfiguration @@ -45,21 +46,21 @@ The functions carried out by the Get-CsPersistentChatComplianceConfiguration cmd ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatComplianceConfiguration ``` The command shown in Example 1 returns information about all the Persistent Chat compliance configuration settings currently in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatComplianceConfiguration -Identity "site:Redmond" ``` In Example 2, information is returned for the Persistent Chat compliance configuration settings applied to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatComplianceConfiguration -Filter "service:*" ``` @@ -67,7 +68,7 @@ Get-CsPersistentChatComplianceConfiguration -Filter "service:*" Example 3 returns information about all the Persistent Chat compliance configuration settings applied to the service scope. This is done by including the Filter parameter and the filter value "service:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatComplianceConfiguration | Where-Object {$_.OneChatRoomPerOutputFile -eq $True} ``` @@ -76,7 +77,7 @@ In Example 4, information is returned for all the Persistent Chat compliance con To do this, the command first uses the Get-CsPersistentChatComplianceConfiguration to return a collection consisting of all the Persistent Chat compliance configuration settings. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the OneChatRoomPerOutputFile property is equal to True ($True). -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPersistentChatComplianceConfiguration | Where-Object {$_.CustomConfiguration -ne $Null} ``` @@ -89,6 +90,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to use wildcards when specifying the collection (or collections) of Persistent Chat compliance settings to be returned. For example, this syntax returns all the settings policies configured at the service scope: @@ -99,8 +103,7 @@ The Filter and Identity parameters cannot be used in the same command. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat compliance settings to be returned. To return the global collection, use this syntax: @@ -130,8 +136,7 @@ If neither the Identity parameter nor the Filter parameter are included in a com ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -141,13 +146,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the Persistent Chat compliance 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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatConfiguration.md index 7fd56a3f4c..7b93fd6c02 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatConfiguration.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsPersistentChatConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatconfiguration +schema: 2.0.0 +title: Get-CsPersistentChatConfiguration --- # Get-CsPersistentChatConfiguration @@ -44,21 +45,21 @@ To view Persistent Chat configuration information in the Skype for Business Serv ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatConfiguration ``` The command shown in Example 1 returns information for all the Persistent Chat configuration settings in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatConfiguration -Identity "site:Redmond" ``` In Example 2, information is returned for a specified set of Persistent Chat configuration settings: the settings applied to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatConfiguration -Filter "service:*" ``` @@ -66,7 +67,7 @@ Get-CsPersistentChatConfiguration -Filter "service:*" Example 3 returns information for all the Persistent Chat configuration settings applied to the site scope. This is done by including the Filter parameter and the filter value "service:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatConfiguration | Where-Object {$_.DefaultChatHistory -gt 30} ``` @@ -75,7 +76,7 @@ In Example 4, information is returned for all the Persistent Chat configuration To carry out this task the command first uses the Get-CsPersistentChatConfiguration cmdlet to return a collection of all the Persistent Chat configuration settings. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the DefaultChatHistory property is greater than (-gt) 30. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPersistentChatConfiguration | Where-Object {$_.RoomManagementUrl -eq $Null} ``` @@ -88,6 +89,9 @@ In turn, this collection is piped to the Where-Object cmdlet, which selects any ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to use wildcards when specifying the collection (or collections) of Persistent Chat configuration settings to be returned. For example, this syntax returns all the settings configured at the service scope: @@ -98,8 +102,7 @@ The Filter and Identity parameters cannot be used in the same command. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat configuration settings to be returned. To return the global collection, use this syntax: @@ -129,8 +135,7 @@ If neither the Identity parameter nor the Filter parameter are included in a com ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -140,13 +145,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the Persistent Chat configuration 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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEligiblePrincipal.md similarity index 91% rename from skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEligiblePrincipal.md index f4405e37b0..cabdf2a2fb 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEligiblePrincipal.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsPersistentChatEligiblePrincipal -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchateligibleprincipal +schema: 2.0.0 +title: Get-CsPersistentChatEligiblePrincipal --- # Get-CsPersistentChatEligiblePrincipal @@ -50,21 +51,21 @@ The functions carried out by the Get-CsPersistentChatEligiblePrincipal cmdlet ar ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatEligiblePrincipal -PersistentChatPoolFqdn "atl-persistentchat-001.litwareinc.com" -Category "ITChat" ``` The command shown in Example 1 returns information about the eligible principals for the Persistent Chat category ITChat. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatEligiblePrincipal -PersistentChatPoolFqdn "atl-persistentchat-001.litwareinc.com" -Room "HelpDeskChatRoom" -Presenters ``` In Example 2, information is returned for all the eligible presenters for the chat room HelpDeskChatRoom. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatEligiblePrincipal -PersistentChatPoolFqdn "atl-persistentchat-001.litwareinc.com" -Room "HelpDeskChatRoom" -Presenters | Where-Object {$_.PersistentChatPrincipalType -ne "user"} ``` @@ -77,14 +78,16 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Category + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Name of the Group Chat category for which eligible principals are to be returned. You must use either the Category or the Room parameter when calling the Get-CsPersistentChatEligiblePrincipal cmdlet; however, you cannot use both of those parameters in the same command. ```yaml Type: String Parameter Sets: Category -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -93,24 +96,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Room -Name of the Group Chat room for which eligible principals are to be returned. -You must use either the Category or the Room parameter when calling the Get-CsPersistentChatEligiblePrincipal cmdlet; however, you cannot use both of those parameters in the same command. - -```yaml -Type: String -Parameter Sets: Room -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Filter -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Filter Provides a way to filter for eligible principals by using a wildcard search. For example: @@ -121,8 +110,7 @@ Note that the Filter parameter can only filter on user SIP addresses. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -132,6 +120,9 @@ Accept wildcard characters: False ``` ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name of the persistent Chat pool. For example: @@ -140,8 +131,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -151,6 +141,9 @@ Accept wildcard characters: False ``` ### -Presenters + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When included in the command, returns the eligible presenters for a Persistent Chat chat room. When not included in the command, the Get-CsPersistentChatEligiblePrincipal cmdlet returns eligible members and managers instead. @@ -159,8 +152,7 @@ This parameter can only be used along with the Room parameter, and can only retu ```yaml Type: SwitchParameter Parameter Sets: Room -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -170,6 +162,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven Persistent Chat principals (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 principals will be returned. @@ -181,8 +176,7 @@ If you set the ResultSize to 7 but you have only three principals in your forest ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -191,6 +185,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Room + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Name of the Group Chat room for which eligible principals are to be returned. +You must use either the Category or the Room parameter when calling the Get-CsPersistentChatEligiblePrincipal cmdlet; however, you cannot use both of those parameters in the same command. + +```yaml +Type: String +Parameter Sets: Room +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). diff --git a/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEndpoint.md similarity index 91% rename from skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEndpoint.md index 04e98b3f03..920b5aded6 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEndpoint.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsPersistentChatEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatendpoint +schema: 2.0.0 +title: Get-CsPersistentChatEndpoint --- # Get-CsPersistentChatEndpoint @@ -44,14 +45,14 @@ The functions carried out by the Get-CsPersistentChatEndpoint cmdlet are not ava ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatEndpoint ``` The command shown in Example 1 returns information about all the Persistent Chat endpoints configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatEndpoint -Identity "sip:pce@litwareinc.com" ``` @@ -59,7 +60,7 @@ Get-CsPersistentChatEndpoint -Identity "sip:pce@litwareinc.com" Example 2 uses the Filter parameter to return information for the Persistent Chat endpoint that has the Identity "sip:pce@litwareinc.com". In this case, the SIP address is used as the Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatEndpoint -PersistentChatPoolFqdn atl-pcpool-001.litwareinc.com ``` @@ -71,6 +72,9 @@ This is done by including the PoolFqdn parameter followed by the fully qualified ## PARAMETERS ### -Credential + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to run the Get-CsPersistentChatEndpoint cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. @@ -79,8 +83,7 @@ To use the Credential parameter you must first create a PSCredential object by u ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN). For example: @@ -99,8 +105,7 @@ For example: ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to limit the returned data by filtering on Skype for Business Server-specific attributes. For example, you can limit returned data to Persistent Chat endpoints that have been assigned a specific voice policy, or endpoints have not been assigned a specific voice policy. @@ -121,8 +129,7 @@ For example, a filter that returns only endpoints that have been assigned a per- ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat endpoint to be returned. Endpoint Identities are typically specified using the endpoint's SIP address or display name; for example: @@ -144,8 +154,7 @@ However, you can also use the full Identity of the endpoint; for example: ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 1 @@ -155,14 +164,16 @@ Accept wildcard characters: False ``` ### -LdapFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). Because Persistent Chat endpoints have very few non-Skype for Business Server attributes this parameter is of minimal value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -172,14 +183,16 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to return information about user accounts in a specific organizational unit (OU) or container. Because new Persistent Chat endpoints are all created in the same Active Directory container (ApplicationContacts/RTC Service/Services/Configuration) this parameter is of minimal value. ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -189,13 +202,15 @@ Accept wildcard characters: False ``` ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name of the Persistent Chat pool associated with the Persistent Chat endpoint. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -205,6 +220,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven contacts (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. @@ -216,8 +234,7 @@ If you set the ResultSize to 7 but you have only three contacts in your forest, ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsPersistentChatPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatPolicy.md index 7c0e9ecc89..925da87467 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatPolicy.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsPersistentChatPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatpolicy +schema: 2.0.0 +title: Get-CsPersistentChatPolicy --- # Get-CsPersistentChatPolicy @@ -45,21 +46,21 @@ To view Persistent Chat policy information in the Skype for Business Server Cont ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatPolicy ``` The command shown in Example 1 returns information about all the Persistent Chat policies configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatPolicy -Identity "RedmondPersistentChatPolicy" ``` In Example 2, information is returned only for the per-user Persistent Chat policy with the Identity RedmondPersistentChatPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatPolicy -Filter "site:*" ``` @@ -67,7 +68,7 @@ Get-CsPersistentChatPolicy -Filter "site:*" In Example 3, information is returned for all the Persistent Chat policies configured at the site scope. This is done by including the Filter parameter and the parameter value "site:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatPolicy | Where-Object {$_.EnablePersistentChat -eq $True} ``` @@ -80,6 +81,9 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to do a wildcard search for Persistent Chat policies. For example, to find all the policies configured at the site scope, use this syntax: @@ -90,8 +94,7 @@ You cannot use both the Filter parameter and the Identity parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identity assigned to the policy when it was created. Persistent Chat policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -123,8 +129,7 @@ If neither the Identity nor the Filter parameter is specified the Get-CsPersiste ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -134,13 +139,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the Persistent Chat 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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -150,6 +157,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose Persistent Chat policies are being returned. For example: @@ -162,8 +172,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatRoom.md similarity index 88% rename from skype/skype-ps/skype/Get-CsPersistentChatRoom.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatRoom.md index b2f79623d0..8d0e58466d 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatRoom.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsPersistentChatRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatroom +schema: 2.0.0 +title: Get-CsPersistentChatRoom --- # Get-CsPersistentChatRoom @@ -46,21 +47,21 @@ The Get-CsPersistentChatRoom cmdlet provides a way to return information about a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatRoom ``` The command shown in Example 1 returns information about the Persistent Chat chat rooms configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom" ``` Example 2 returns information for a single Persistent Chat chat room: the room with the Identity atl-cs-001.litwareinc.com\ITChatRoom. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatRoom -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -71,6 +72,9 @@ In Example 3, information is returned for all the Persistent Chat chat rooms con ## PARAMETERS ### -Addin + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms associated with the specified chat room add-in. Note that you can only specify one add-in per command. @@ -78,8 +82,7 @@ Note that you can only specify one add-in per command. ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -89,14 +92,16 @@ Accept wildcard characters: False ``` ### -AsObject + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When specified, Active Directory display names are used when showing users who are on the Managers or Presenters lists. When not specified, SIP addresses are used when showing these users. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns information for all the Persistent Chat chat rooms in the specified category. For example: @@ -117,8 +125,7 @@ In addition, you cannot use the PersistentChatPoolFqdn, Filter, or Identity para ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -ChatContentExceedsMB + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms whose cumulative chat content exceeds the specified value (in megabytes). ```yaml Type: Int32 Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to search for active chat rooms (by using the parameter value $False) or disabled chat rooms (by using the parameter value $True). ```yaml Type: Boolean Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to return information for Persistent Chat chat rooms based on the Name and/or the Description of the room. To return information for a chat room with a specific name, use syntax similar to this: @@ -170,8 +184,7 @@ That syntax returns information only for chat rooms that have the name ITChat. ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -181,6 +194,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique Identifier for the Persistent Chat chat room being returned. The Identity for a chat room consists of the Persistent Chat pool where the room has been configured plus the name of the room; for example: @@ -192,8 +208,7 @@ If you call the Get-CsPersistentChatRoom cmdlet without any parameters the cmdle ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 1 @@ -203,13 +218,15 @@ Accept wildcard characters: False ``` ### -Invitations + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms that use invitations (by using the parameter value Inherit) or chat rooms that do not use invitations (by using the parameter value False). ```yaml Type: ChatRoomInvitations Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -219,6 +236,9 @@ Accept wildcard characters: False ``` ### -Manager + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms managed by the specified user. For example: @@ -229,8 +249,7 @@ Note that you can only specify a single manager per command. ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -240,6 +259,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms that the specified user is a member of. For example: @@ -250,8 +272,7 @@ Note that you can only specify a single member per command. ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -261,6 +282,9 @@ Accept wildcard characters: False ``` ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns information about all the Persistent Chat chat rooms configured on the specified Persistent Chat pool. For example: @@ -271,8 +295,7 @@ You cannot use the Category, Filter, or Identity parameters in any command that ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -282,6 +305,9 @@ Accept wildcard characters: False ``` ### -Privacy + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to return chat rooms that meet the specified privacy setting. Allowed values are: @@ -292,8 +318,7 @@ Allowed values are: ```yaml Type: ChatRoomPrivacy Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -303,6 +328,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven chat rooms (regardless of the number of rooms in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven rooms will be returned. @@ -314,8 +342,7 @@ If you set the ResultSize to 7 but you have only three rooms in your forest, the ```yaml Type: Int32 Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -325,6 +352,9 @@ Accept wildcard characters: False ``` ### -SearchDescription + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to search for the specified text value in either the chat room Name or the chat room Description. To search both the Name and the Description, include the SearchDescription parameter along with the Filter parameter. For example: @@ -334,8 +364,7 @@ For example: ```yaml Type: SwitchParameter Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -345,6 +374,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms by room type. Allowed values are: @@ -354,8 +386,7 @@ Allowed values are: ```yaml Type: ChatRoomType Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatState.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPersistentChatState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatState.md index 232ca51c32..7901d8d630 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatState.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsPersistentChatState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatstate +schema: 2.0.0 +title: Get-CsPersistentChatState --- # Get-CsPersistentChatState @@ -40,21 +41,21 @@ The functions carried out by the Get-CsPersistentChatState cmdlet are not availa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatState ``` The command shown in Example 1 returns the state of all the Persistent Chat servers configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatState -Identity "PersistentChatServer:atl-gc-001.litwareinc.com" ``` {Enter description for Example 2} -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatState -Filter "*.litwareinc.com" ``` @@ -63,7 +64,7 @@ Example 3 returns state information for all Persistent Chat servers in the domai To do this, the Filter parameter is included along with the filter value "*.litwareinc.com". That filter value causes the Get-CsPersistentChatState cmdlet to return information for all the Persistent Chat servers that have an Identity that ends with the string value ".litwareinc.com". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatState | Where-Object {$_.PoolState -eq "FailedOver"} ``` @@ -76,6 +77,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to use wildcards when retrieving one or more Persistent Chat states. For example, to return all the Persistent Chat states for the domain litwareinc.com, use this syntax: @@ -86,8 +90,7 @@ You cannot use both the Filter parameter and the Identity parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat pool. For example: @@ -107,8 +113,7 @@ If this parameter is omitted then the Get-CsPersistentChatState cmdlet returns i ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -118,13 +123,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the Persistent Chat state 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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsPinPolicy.md similarity index 88% rename from skype/skype-ps/skype/Get-CsPinPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPinPolicy.md index a72edbf43e..c52b31b0ec 100644 --- a/skype/skype-ps/skype/Get-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPinPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPinPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspinpolicy +schema: 2.0.0 +title: Get-CsPinPolicy --- # Get-CsPinPolicy @@ -41,7 +42,7 @@ You can use the Get-CsPinPolicy cmdlet to retrieve information about the PIN pol ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPinPolicy ``` @@ -49,14 +50,14 @@ Get-CsPinPolicy The command shown in Example 1 returns a collection of all the PIN policies configured for use in the organization. Calling the Get-CsPinPolicy cmdlet without any parameters always returns the complete set of PIN policies. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPinPolicy -Identity "site:Redmond" ``` Example 2 returns a single PIN policy: the policy with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPinPolicy -Filter "tag:*" ``` @@ -64,7 +65,7 @@ Get-CsPinPolicy -Filter "tag:*" The command shown in Example 3 uses the Filter parameter to return all the policies that have been configured at the per-user scope. This is done by using the filter value "tag:*"; this value instructs the Get-CsPinPolicy cmdlet to return only those policies that have an Identity that begins with the characters "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPinPolicy | Where-Object {$_.AllowCommonPatterns -eq $True} ``` @@ -73,7 +74,7 @@ Example 4 returns all the PIN policies where the AllowCommonPatterns property is In this example, the Get-CsPinPolicy cmdlet is first called without any additional parameters; that returns a collection of all the PIN policies configured for use in the organization. That collection is then passed to the Where-Object cmdlet, which picks out only those policies where the AllowCommonPatterns property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPinPolicy | Where-Object {$_.PinLifetime -gt 30} ``` @@ -85,7 +86,31 @@ That means only policies that have PIN expiration times of more than 30 days wil ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to do a wildcard search for PIN policies. +For example, to find all the policies configured at the site scope, use this Filter: site:*. +To find the site policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: site:S*. +Note that this parameter can only filter on the Identity property. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the policy when it was created. PIN policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -108,8 +133,7 @@ If neither the Identity nor the Filter parameter is specified the Get-CsPinPolic ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -118,33 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to do a wildcard search for PIN policies. -For example, to find all the policies configured at the site scope, use this Filter: site:*. -To find the site policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: site:S*. -Note that this parameter can only filter on the Identity property. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the PIN 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +161,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose PIN policies are being returned. For example: @@ -166,8 +176,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/Get-CsPlatformServiceSettings.md similarity index 84% rename from skype/skype-ps/skype/Get-CsPlatformServiceSettings.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPlatformServiceSettings.md index 556e9c6bbe..60673b9b8d 100644 --- a/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPlatformServiceSettings.md @@ -1,13 +1,14 @@ --- -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPlatformServiceSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csplatformservicesettings +schema: 2.0.0 +title: Get-CsPlatformServiceSettings --- # Get-CsPlatformServiceSettings @@ -34,7 +35,7 @@ The `Get-CsPlatformServiceSettings` cmdlet shows you which of these features are ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> Get-CsPlatformServiceSettings ``` @@ -44,6 +45,9 @@ This example shows you which of the Skype for Business on Mac features are enabl ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more Platform Service Settings configurations. For example, to return all of the Platform Service Settings configurations with the word Test in their names use this syntax: @@ -53,7 +57,6 @@ For example, to return all of the Platform Service Settings configurations with Type: String Parameter Sets: Filter Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the Platform Service Settings to be returned. ```yaml Type: XdsIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 1 @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Platform Service Settings configuration 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -110,8 +117,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csplatformservicesettings?view=skype-ps) -[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsPool.md b/skype/skype-ps/SkypeForBusiness/Get-CsPool.md similarity index 87% rename from skype/skype-ps/skype/Get-CsPool.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPool.md index 8c56497961..26ea317632 100644 --- a/skype/skype-ps/skype/Get-CsPool.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspool +schema: 2.0.0 +title: Get-CsPool --- # Get-CsPool @@ -41,14 +42,14 @@ The Get-CsPool cmdlet enables you to retrieve information about each pool in use ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPool ``` Example 1 returns all the pools found in your deployment of Skype for Business Server. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPool | Select-Object -ExpandProperty Computers ``` @@ -59,14 +60,14 @@ The ExpandProperty parameter is then used to "expand" the value of the Computers The Computers property is an array of objects representing each computer in the pool. When you expand the Computers property you get back detailed information about each of these computers. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPool -Identity atl-cs-001.litwareinc.com ``` In Example 3, the Identity parameter is used to restrict the returned data to the pool that has the Identity atl-cs-001.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPool -Site "Redmond" ``` @@ -74,7 +75,7 @@ Get-CsPool -Site "Redmond" Example 4 returns all the pools found in the Redmond site. To do this, the command uses the Site parameter; the parameter value "Redmond" limits the returned data to pools where the Site property is equal to Redmond. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPool | Where-Object {$_.Services.Count -eq 0} ``` @@ -87,49 +88,56 @@ If the Count equals 0, that means that there are no Skype for Business Server se ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the pool to be returned. -For example: +### -Filter -`-Identity atl-cs-001.litwareinc.com` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If this parameter is not present, then all the pools in your organization will be returned. +Enables you to use wildcards when specifying the Identity of the pool (or pools) to be returned. +For example, this syntax returns all the pools that have an Identity that ends with the string value ".fabrikam.com": + +`-Filter "*.fabrikam.com"` + +Note that you cannot use both the Filter and the Identity parameters in the same command. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Identity of the pool (or pools) to be returned. -For example, this syntax returns all the pools that have an Identity that ends with the string value ".fabrikam.com": +### -Identity -`-Filter "*.fabrikam.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use both the Filter and the Identity parameters in the same command. +Fully qualified domain name (FQDN) of the pool to be returned. +For example: + +`-Identity atl-cs-001.litwareinc.com` + +If this parameter is not present, then all the pools in your organization will be returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Site + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns all the pools found on the specified site. The site in question should be referenced using the site's DisplayName (for example, Redmond) rather than the site Identity (for example, site:Redmond). For example: @@ -143,8 +151,7 @@ You can retrieve the display names for your sites by running this command: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md b/skype/skype-ps/SkypeForBusiness/Get-CsPoolBackupRelationship.md similarity index 87% rename from skype/skype-ps/skype/Get-CsPoolBackupRelationship.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPoolBackupRelationship.md index d29e9701e9..b7eef6416c 100644 --- a/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPoolBackupRelationship.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolbackuprelationship applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPoolBackupRelationship -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspoolbackuprelationship +schema: 2.0.0 +title: Get-CsPoolBackupRelationship --- # Get-CsPoolBackupRelationship @@ -33,7 +34,7 @@ The functions carried out by the Get-CsPoolBackupRelationship cmdlet are not ava ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPoolBackupRelationship -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -43,33 +44,34 @@ The command shown in Example returns information about the backup relationship a ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool whose backup relationship is being checked. -For example: +### -Force -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +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 occur when running the command. +### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves the backup relationship 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -78,16 +80,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the backup relationship data from the local replica of the Central Management store rather than from the Central Management store itself. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool whose backup relationship is being checked. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/skype/skype-ps/skype/Get-CsPoolFabricState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPoolFabricState.md similarity index 60% rename from skype/skype-ps/skype/Get-CsPoolFabricState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPoolFabricState.md index 2e915d6108..55b4b14c1b 100644 --- a/skype/skype-ps/skype/Get-CsPoolFabricState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPoolFabricState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolfabricstate applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPoolFabricState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspoolfabricstate +schema: 2.0.0 +title: Get-CsPoolFabricState --- # Get-CsPoolFabricState @@ -20,31 +21,27 @@ This cmdlet was introduced in Lync Server 2013. ## SYNTAX -### (Default) -``` -Get-CsPoolFabricState -PoolFqdn [-Confirm] [-Force] [-Type ] [-WhatIf] - [] -``` - -### PoolFqdn -``` -Get-CsPoolFabricState [-PoolFqdn] [-Confirm] [-Force] [-HealthState ] - [-OutputCsvFile ] [-ServiceName ] [-ShowAll] [-WhatIf] [-Type ] [] -``` - ### RoutingGroup ``` -Get-CsPoolFabricState [-RoutingGroup] [-Confirm] [-Force] [-WhatIf] [] +Get-CsPoolFabricState [-RoutingGroup] [-ReplicaBuildProgress] [-Force] [-MinutesToPoll ] + [-PollInterval ] [-ReplicaBuildProgressTimeout ] [-WhatIf] [-Confirm] [] ``` ### Tenant ``` -Get-CsPoolFabricState [-Tenant] [-Confirm] [-Force] [-WhatIf] [] +Get-CsPoolFabricState [-Tenant] [-Force] [-WhatIf] [-Confirm] [] ``` ### User ``` -Get-CsPoolFabricState [-UserUri] [-Confirm] [-Force] [-WhatIf] [] +Get-CsPoolFabricState [-UserUri] [-Force] [-WhatIf] [-Confirm] [] +``` + +### PoolFqdn +``` +Get-CsPoolFabricState -PoolFqdn [-HealthState ] [-ShowAll] [-OutputCsvFile ] + [-ServiceName ] [-Force] [-Type ] [-QueryTimeout ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -53,10 +50,9 @@ This includes information about Windows Fabric replica instances for any (or all The functions carried out by the Get-CsPoolFabricState cmdlet are not available in Skype for Business Server Control Panel. - ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPoolFabricState -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -64,7 +60,7 @@ Get-CsPoolFabricState -PoolFqdn "atl-cs-001.litwareinc.com" The command shown in Example 1 returns the fabric state for the pool atl-cs-001.litwareinc.com. Because the Type parameter was not included, state information for all the services on the pool will be returned. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPoolFabricState -PoolFqdn "atl-cs-001.litwareinc.com" -Type MCU ``` @@ -75,46 +71,82 @@ This is done by including the Type parameter and the parameter value "MCU". ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool being checked. -You must supply the FQDN of a pool when calling this cmdlet; for example: +### -Force -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthState + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String + +```yaml +Type: System.String +Parameter Sets: PoolFqdn +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinutesToPoll +Max number of minutes for which the cmdlet will poll cluster manager for replica build progress + +```yaml +Type: System.Int32 +Parameter Sets: RoutingGroup +Aliases: + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -OutputCsvFile + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String + ```yaml Type: String Parameter Sets: PoolFqdn -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PollInterval +Interval in seconds between cluster manager polls for replica build progress ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Int32 +Parameter Sets: RoutingGroup +Aliases: Required: False Position: Named @@ -123,39 +155,49 @@ 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. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being checked. +You must supply the FQDN of a pool when calling this cmdlet; for example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.String +Parameter Sets: PoolFqdn +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Specifies the service type to be returned. -Allowed values are: +### -QueryTimeout +Query timeout period in minutes to retrieve the state of fabric services. -* All (returns information for all services) -* MCUFactory (returns information for the MCU factory service) -* ConferenceDirectory (returns information for the Conference Directory service) +```yaml +Type: System.Int32 +Parameter Sets: PoolFqdn +Aliases: -LYSS (returns information for the Lync Server Storage service) +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -You can only specify a single type per command. +### -ReplicaBuildProgress +If a replica is being built for the given RG, polls for the status of the build ```yaml -Type: FabricEnumerationType -Parameter Sets: (All), PoolFqdn -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RoutingGroup +Aliases: Required: False Position: Named @@ -164,14 +206,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ReplicaBuildProgressTimeout +The number of seconds for which no replica build progress has been made before considering progress to be stuck ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Int32 +Parameter Sets: RoutingGroup +Aliases: Required: False Position: Named @@ -181,14 +222,16 @@ Accept wildcard characters: False ``` ### -RoutingGroup + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Windows Fabric routing group to be returned. Routing groups are used to specify the servers that users log onto. ```yaml -Type: String +Type: System.String Parameter Sets: RoutingGroup -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -197,7 +240,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ServiceName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String + +```yaml +Type: System.String +Parameter Sets: PoolFqdn +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowAll + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: SwitchParameter + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PoolFqdn +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose Windows Fabric pool state is being returned. For example: @@ -208,10 +290,9 @@ You can return the tenant ID for each of your Skype for Business Online tenants `Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: Guid +Type: System.Guid Parameter Sets: Tenant -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -220,35 +301,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserUri -Enables you to check the Windows fabric state for the pool used by a specific user. -For example, to check the Windows fabric state for the user Ken Myer use this syntax: +### -Type -`-UserUri "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you can only specify one user URI per command. +Specifies the service type to be returned. +Allowed values are: -```yaml -Type: UserIdParameter -Parameter Sets: User -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +* All (returns information for all services) +* MCUFactory (returns information for the MCU factory service) +* ConferenceDirectory (returns information for the Conference Directory service) -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +LYSS (returns information for the Lync Server Storage service) -### -HealthState -PARAMVALUE: String +You can only specify a single type per command. ```yaml -Type: String +Type: System.String Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,70 +328,77 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutputCsvFile -PARAMVALUE: String +### -UserUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to check the Windows fabric state for the pool used by a specific user. +For example, to check the Windows fabric state for the user Ken Myer use this syntax: + +`-UserUri "sip:kenmyer@litwareinc.com"` + +Note that you can only specify one user URI per command. ```yaml -Type: String -Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: Microsoft.Rtc.Management.AD.UserIdParameter +Parameter Sets: User +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceName -PARAMVALUE: String +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowAll -PARAMVALUE: SwitchParameter +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter -Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS -### String +### String String value representing the fabric state. - ## NOTES - ## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPoolUpgradeReadinessState.md similarity index 90% rename from skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPoolUpgradeReadinessState.md index db2ff87bbf..7bf4f2987b 100644 --- a/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPoolUpgradeReadinessState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolupgradereadinessstate applicable: Lync Server 2013, Skype for Business Server 2015 -title: Get-CsPoolUpgradeReadinessState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspoolupgradereadinessstate +schema: 2.0.0 +title: Get-CsPoolUpgradeReadinessState --- # Get-CsPoolUpgradeReadinessState @@ -38,7 +39,7 @@ In Skype for Business Server 2019, Get-CsPoolUpgradeReadinessState cmdlet was re ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPoolUpgradeReadinessState ``` @@ -49,14 +50,16 @@ Note that this command must be executed on a Front End server located within the ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -65,14 +68,17 @@ 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. +### -SkipIdleSecondaryVerification + +> Applicable: Skype for Business Server 2015 + +When included in the command, Get-CsPoolUpgradeReadinessState returns even if replicas are still being built. +By default, Get-CsPoolUpgradeReadinessState waits until the replicas have been built before completing. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -81,14 +87,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -97,15 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipIdleSecondaryVerification -When included in the command, Get-CsPoolUpgradeReadinessState returns even if replicas are still being built. -By default, Get-CsPoolUpgradeReadinessState waits until the replicas have been built before completing. +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPresenceManagementState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceManagementState.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPresenceManagementState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPresenceManagementState.md index 73930cdaf6..5bd1c76402 100644 --- a/skype/skype-ps/skype/Get-CsPresenceManagementState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceManagementState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspresencemanagementstate applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPresenceManagementState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspresencemanagementstate +schema: 2.0.0 +title: Get-CsPresenceManagementState --- # Get-CsPresenceManagementState @@ -29,7 +30,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPresenceManagementState -Fqdn "atl-mcs-001.litwareinc.com" ``` @@ -40,13 +41,15 @@ This example returns the management state of a pool specified by its fully quali ## PARAMETERS ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Force parameter is not implemented for this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -56,6 +59,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the computer or pool to report. The computer or pool should be referenced by using its fully qualified domain name (FQDN). For example, -ComputerName "atl-mcs-001.litwareinc.com". @@ -65,8 +71,7 @@ If FQDN is not specified, the settings for the local machine will be modified. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 diff --git a/skype/skype-ps/skype/Get-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsPresencePolicy.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPresencePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPresencePolicy.md index f4d0e7294a..98e95ef9a9 100644 --- a/skype/skype-ps/skype/Get-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPresencePolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsPresencePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspresencepolicy +schema: 2.0.0 +title: Get-CsPresencePolicy --- # Get-CsPresencePolicy @@ -52,7 +54,7 @@ The Get-CsPresencePolicy cmdlet provides a way for you to return information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPresencePolicy ``` @@ -60,14 +62,14 @@ Get-CsPresencePolicy The command shown in Example 1 returns information about all the presence policies configured for use in the organization. This is done by calling the Get-CsPresencePolicy cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPresencePolicy -Identity "RedmondPresencePolicy" ``` Example 2 returns a single per-user presence policy: the policy with the Identity RedmondPresencePolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPresencePolicy -Filter "site:*" ``` @@ -75,7 +77,7 @@ Get-CsPresencePolicy -Filter "site:*" Example 3 returns information about all the presence policies that have been configured at the site scope. To do this, the command uses the Filter parameter and the filter value "site:*"; that filter value limits returned data to all the presence policies that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPresencePolicy | Where-Object {$_.MaxPromptedSubscriber -le 100} ``` @@ -87,7 +89,33 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the policy (or policies) to be returned. +For example, this syntax returns all the presence policies configured at the site scope: + +`-Filter "site:*"` + +The Filter and Identity parameters cannot be used in the same command. + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the presence policy to be retrieved. To return the global policy, use this syntax: @@ -108,8 +136,7 @@ If neither the Identity nor the Filter parameters are specified, then the Get-Cs ```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 +Aliases: Required: False Position: 1 @@ -118,35 +145,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the policy (or policies) to be returned. -For example, this syntax returns all the presence policies configured at the site scope: - -`-Filter "site:*"` - -The Filter and Identity parameters cannot be used in the same command. - -```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the presence 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +164,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose presence policies are being returned. For example: @@ -168,8 +179,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: Identity, Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceProvider.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPresenceProvider.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPresenceProvider.md index 8051cd503e..ca019ef1f6 100644 --- a/skype/skype-ps/skype/Get-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPresenceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspresenceprovider +schema: 2.0.0 +title: Get-CsPresenceProvider --- # Get-CsPresenceProvider @@ -41,21 +42,21 @@ The functions carried out by the Get-CsPresenceProvider cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPresenceProvider ``` The command shown in Example 1 returns information about all the presence providers configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPresenceProvider -Identity "global/fabrikam.com" ``` Example 2 returns information about a single presence provider: the provider with the Identity global/fabrikam.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPresenceProvider -Filter "site:*" ``` @@ -64,7 +65,7 @@ In Example 3, information is returned for all the presence providers configured To do this, the Filter parameter is used along with the filter value "site:*". That filter value limits returned data to presence providers that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPresenceProvider | Where-Object {$_.Fqdn -match "fabrikam.com"} ``` @@ -77,6 +78,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when specifying the Identity of the presence provider (or providers) to be returned. For example, to return all the presence providers configured at the service scope use this filter value: @@ -87,8 +91,7 @@ You cannot use both the Filter parameter and the Identity parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the presence provider. The Identity of a presence provider is composed of two parts: the scope (Parent) where the provider has been applied (for example, service:UserServer:atl-cs-001.litwareinc.com) and the provider's fully qualified domain name. For example, to retrieve a single presence provider use syntax similar to this: @@ -114,8 +120,7 @@ If neither the Identity nor the Filter parameters are included, then the Get-CsP ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -125,13 +130,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the allowed domains from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPrivacyConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPrivacyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPrivacyConfiguration.md index f008d70f24..c7ae94a499 100644 --- a/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPrivacyConfiguration.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsPrivacyConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csprivacyconfiguration +schema: 2.0.0 +title: Get-CsPrivacyConfiguration --- # Get-CsPrivacyConfiguration @@ -49,21 +51,21 @@ The Get-CsPrivacyConfiguration cmdlet enables you to retrieve information about ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPrivacyConfiguration ``` The command shown in Example 1 returns all the privacy configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPrivacyConfiguration -Identity site:Redmond ``` Example 2 returns a single collection of privacy configuration settings: the settings that have the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPrivacyConfiguration -Filter "site:*" ``` @@ -72,7 +74,7 @@ In Example 3, information is returned for all the privacy configuration settings To do this, the Filter parameter is included, along with the filter value "site:*". That filter value ensures that only settings where the Identity (the only property you can filter on) begins with the characters "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPrivacyConfiguration | Where-Object {$_.EnablePrivacyMode -eq $True} ``` @@ -84,7 +86,35 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards to return one or more collections of privacy configuration settings. +For example, to return all the settings configured at the site scope, you can use this syntax: + +`-Filter "site:*"` + +To return all the settings configured at the service scope, use this syntax: + +`-Filter "service:*"` + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the privacy configuration settings to be retrieved. To return the global settings, use this syntax: @@ -103,8 +133,7 @@ If this parameter is not specified then the Get-CsPrivacyConfiguration cmdlet re ```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 +Aliases: Required: False Position: 1 @@ -113,21 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards to return one or more collections of privacy configuration settings. -For example, to return all the settings configured at the site scope, you can use this syntax: - -`-Filter "site:*"` +### -LocalStore -To return all the settings configured at the service scope, use this syntax: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`-Filter "service:*"` +Retrieves the privacy configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -137,6 +161,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose privacy configuration settings are to be retrieved. For example: @@ -154,24 +181,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid 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 -``` - -### -LocalStore -Retrieves the privacy configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsProxyConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsProxyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsProxyConfiguration.md index 8ab2e40fe6..a1a81b9d9c 100644 --- a/skype/skype-ps/skype/Get-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsProxyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsProxyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csproxyconfiguration +schema: 2.0.0 +title: Get-CsProxyConfiguration --- # Get-CsProxyConfiguration @@ -40,7 +41,7 @@ The Get-CsProxyConfiguration cmdlet enables you to return information about any ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsProxyConfiguration ``` @@ -48,7 +49,7 @@ Get-CsProxyConfiguration The command shown in Example 1 returns a collection of all the proxy configuration settings currently in use in the organization. This is done by calling the Get-CsProxyConfiguration cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsProxyConfiguration -Identity "service:EdgeServer:atl-cs-001.litwareinc.com" ``` @@ -56,7 +57,7 @@ Get-CsProxyConfiguration -Identity "service:EdgeServer:atl-cs-001.litwareinc.com In Example 2, information about the proxy configuration settings that have the Identity service:EdgeServer:atl-cs-001.litwareinc.com is returned. Because Identities must be unique, this command will never return more than one collection of settings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsProxyConfiguration -Filter "service:*" ``` @@ -64,7 +65,7 @@ Get-CsProxyConfiguration -Filter "service:*" Example 3 returns information about all of the proxy settings that have been configured at the service scope. To do this, the command calls the Get-CsProxyConfiguration cmdlet along with the Filter parameter; the filter value "service:*" ensures that only those settings that have an Identity that begins with the string value "service:" will be returned. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsProxyConfiguration | Where-Object {$_.UseCertificateForClientToProxyAuth -eq $False} ``` @@ -73,7 +74,7 @@ Example 4 returns information about the proxy configuration settings that do not To carry out this task, the command first uses the Get-CsProxyConfiguration cmdlet to return a collection of all the proxy configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the UseCertificateForClientToProxyAuth property is equal to False. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsProxyConfiguration | Where-Object {$_.MaxClientMessageBodySizeKb -lt 5000} ``` @@ -85,7 +86,33 @@ This collection is then piped to the Where-Object cmdlet, which picks out those ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the proxy configuration settings to be returned. +For example, this syntax returns all the settings configured at the service scope: + +`-Filter "service:*"` + +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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the proxy server configuration settings to be returned. To return the global settings, use this syntax: @@ -103,8 +130,7 @@ If this parameter is not included, the Get-CsProxyConfiguration cmdlet returns a ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -113,35 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the proxy configuration settings to be returned. -For example, this syntax returns all the settings configured at the service scope: - -`-Filter "service:*"` - -You cannot use both the Filter and the Identity parameters in the same command. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the proxy configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPstnUsage.md b/skype/skype-ps/SkypeForBusiness/Get-CsPstnUsage.md similarity index 88% rename from skype/skype-ps/skype/Get-CsPstnUsage.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPstnUsage.md index 3905df1116..ecd927a965 100644 --- a/skype/skype-ps/skype/Get-CsPstnUsage.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPstnUsage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspstnusage applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPstnUsage -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspstnusage +schema: 2.0.0 +title: Get-CsPstnUsage --- # Get-CsPstnUsage @@ -42,14 +43,14 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Get-CsPstnUsage"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPstnUsage ``` This command returns the list of global PSTN usages available within the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` (Get-CsPstnUsage).Usage ``` @@ -73,7 +74,7 @@ International Restricted -### -------------------------- Example 3 -------------------------- +### Example 3 ``` (Get-CsPstnUsage).Usage | ForEach-Object {if ($_ -like "*tern*") {$_}} ``` @@ -89,48 +90,54 @@ The If statement compares the current usage string to the string "*tern*" (the * ## PARAMETERS -### -Identity -The level at which these settings are applied. -The only identity that can be applied to PSTN usages is Global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Filter parameter allows you to retrieve only those PSTN usages with an Identity matching a particular wildcard string. +However, the only Identity available to PSTN usages is Global, so this parameter is not useful for this cmdlet. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to retrieve only those PSTN usages with an Identity matching a particular wildcard string. -However, the only Identity available to PSTN usages is Global, so this parameter is not useful for this cmdlet. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The level at which these settings are applied. +The only identity that can be applied to PSTN usages is Global. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the PSTN usage information from the local data store rather than the main Central Management store. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsPublicProvider.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPublicProvider.md index e896dc4205..dab30f22b4 100644 --- a/skype/skype-ps/skype/Get-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspublicprovider +schema: 2.0.0 +title: Get-CsPublicProvider --- # Get-CsPublicProvider @@ -45,7 +46,7 @@ In order to federate with a public provider you need to create and enable a new ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPublicProvider ``` @@ -53,7 +54,7 @@ Get-CsPublicProvider The command shown in Example 1 returns a collection of all the public providers that are configured for use in the organization. Calling the Get-CsPublicProvider cmdlet without any additional parameters always returns the complete collection of public providers. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPublicProvider -Identity "Skype" ``` @@ -61,7 +62,7 @@ Get-CsPublicProvider -Identity "Skype" In Example 2, all the public providers that have the Identity Skype are returned. Because Identities must be unique among public providers (and among hosting providers), this command will always return, at most, a single item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPublicProvider -Filter W* ``` @@ -69,7 +70,7 @@ Get-CsPublicProvider -Filter W* Example 3 returns all the public providers that have an Identity that begins with the letter W. This is done by including the Filter parameter and the filter value "W*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPublicProvider | Where-Object {$_.Enabled -eq $False} ``` @@ -78,7 +79,7 @@ The command shown in Example 4 returns a collection of all the public providers To do this, the command first calls the Get-CsPublicProvider cmdlet to return a collection of all the public providers configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those providers where the Enabled property is equal to False. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPublicProvider | Where-Object {$_.VerificationLevel -ne "AlwaysVerifiable"} ``` @@ -91,27 +92,10 @@ The net effect: only providers where the VerificationLevel property is set to ei ## PARAMETERS -### -Identity -Unique identifier for the public provider to be returned. -The Identity is typically the name of the web site providing the services. - -You cannot use wildcards when specifying the Identity. -To use wildcards to return one or more public providers, use the Filter parameter instead. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Filter -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Filter Enables you to use wildcard values in order to return one or more public providers. For example, to return a collection of all the public providers that have an Identity that begins with the letter Y, use this syntax: @@ -124,8 +108,7 @@ To return a collection of all the public providers that include the string value ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,14 +117,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the public provider to be returned. +The Identity is typically the name of the web site providing the services. + +You cannot use wildcards when specifying the Identity. +To use wildcards to return one or more public providers, use the Filter parameter instead. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the public provider 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPushNotificationConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPushNotificationConfiguration.md index c691ad8fc7..e13e143fbc 100644 --- a/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPushNotificationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPushNotificationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspushnotificationconfiguration +schema: 2.0.0 +title: Get-CsPushNotificationConfiguration --- # Get-CsPushNotificationConfiguration @@ -51,21 +53,21 @@ The `Get-CsPushNotificationConfiguration` cmdlet provides a way for you to retur ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPushNotificationConfiguration ``` Skype for Business Server example 1 returns information about all the push notification settings configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPushNotificationConfiguration -Identity "site:Redmond" ``` Skype for Business Server example 2 returns information about a single collection of push notification settings: the settings configured for the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPushNotificationConfiguration -Filter "site:*" ``` @@ -73,7 +75,7 @@ Get-CsPushNotificationConfiguration -Filter "site:*" In Skype for Business Server example 3, the command returns all the push notification settings assigned to the site scope. To do this, the command uses the Filter parameter and the filter value "site:*"; that filter value returns only those settings that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService -eq $False} ``` @@ -82,7 +84,7 @@ In Skype for Business Server example 4 returns all the push notification setting To do this, the command first uses the Get-CsPushNotificationConfiguration cmdlet to return a collection of all the push notification settings currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the EnableApplePushNotificationService property is equal to (-eq) False. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService -eq $False -and $_.EnableMicrosoftPushNotificationService -eq $False} ``` @@ -100,6 +102,9 @@ To restrict the returned data to settings where both services have been disabled ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a collection (or collections) of push notification configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: @@ -112,8 +117,7 @@ To return a collection of all the settings that have the string value "Canada" s ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +127,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of push notification settings you want to return. To refer to the global settings use this syntax: @@ -140,8 +147,7 @@ If this parameter is not specified, then the Get-CsPushNotificationConfiguration ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -151,13 +157,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the push notification configuration 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: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +175,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose push notification configuration settings are to be modified. For example: @@ -183,8 +194,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -211,8 +221,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration?view=skype-ps) -[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) +[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspushnotificationconfiguration?view=skype-ps) -[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) +[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsQoEConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Get-CsQoEConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsQoEConfiguration.md index df091a86aa..4f79f5c84b 100644 --- a/skype/skype-ps/skype/Get-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsQoEConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsQoEConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csqoeconfiguration +schema: 2.0.0 +title: Get-CsQoEConfiguration --- # Get-CsQoEConfiguration @@ -39,21 +40,21 @@ QoE is part of the Monitoring Server role; therefore Monitoring Server must be d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsQoEConfiguration ``` This example uses the Get-CsQoEConfiguration cmdlet to return a collection of all the QoE settings configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsQoEConfiguration -Identity site:Redmond ``` Example 2 uses the Identity parameter to ensure that the Get-CsQoEConfiguration cmdlet returns only the QoE settings with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsQoEConfiguration -Filter site:* ``` @@ -62,7 +63,7 @@ In Example 3 the Filter parameter is used to return all the QoE settings that ha The wildcard "site:*" returns all the QoE settings that have an Identity beginning with the string value site:. Settings that meet those criteria are settings that have been configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsQoEConfiguration | Where-Object {$_.KeepQoEDataForDays -lt 30} ``` @@ -74,24 +75,10 @@ That collection is then piped to the Where-Object cmdlet, which applies a filter ## PARAMETERS -### -Identity -The unique identifier of the settings you want to retrieve. -Possible values are global and site:\, where \ is the name of the site in your Skype for Business Server deployment to which you want to apply the changes. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Filter -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Filter Enables you to use wildcard characters in order to return a collection (or multiple collections) of QoE configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: @@ -104,8 +91,7 @@ To return a collection of all the settings that have the string value "Western" ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,14 +100,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the settings you want to retrieve. +Possible values are global and site:\, where \ is the name of the site in your Skype for Business Server deployment to which you want to apply the changes. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the settings from the local replica of the Central Management store. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsRegistrarConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsRegistrarConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRegistrarConfiguration.md index e5b7e3c765..8d0992a2da 100644 --- a/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRegistrarConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRegistrarConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csregistrarconfiguration +schema: 2.0.0 +title: Get-CsRegistrarConfiguration --- # Get-CsRegistrarConfiguration @@ -43,21 +44,21 @@ Registrar configuration settings are used to help manage endpoints and endpoint ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRegistrarConfiguration ``` The command shown in Example 1 returns a collection of all the Registrar configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRegistrarConfiguration -Identity site:Redmond ``` Example 2 returns a single collection of Registrar configuration settings: the settings configured for the Redmond site (-Identity site:Redmond). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRegistrarConfiguration -Filter "service:*" ``` @@ -65,7 +66,7 @@ Get-CsRegistrarConfiguration -Filter "service:*" In Example 3, information is returned for all the Registrar configuration settings assigned at the service scope. To do this, the command uses the Filter parameter and the filter value "service:*"; that filter value ensures that only settings that have an Identity that begins with the string value "service:" will be returned. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRegistrarConfiguration | Where-Object {$_.EnableDHCPServer -eq $True} ``` @@ -74,7 +75,7 @@ Example 4 returns information about the Registrar configuration settings that en To carry out this task, the command first calls the Get-CsRegistrarConfiguration cmdlet without any parameters; that returns a collection of all the Registrar configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the EnableDHCPServer property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRegistrarConfiguration | Where-Object {$_.MaxEndpointsPerUser -gt 8} ``` @@ -86,7 +87,35 @@ This collection is then piped to the Where-Object cmdlet, which picks out those ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards in order to return one or more collections of Registrar configuration settings. +For example, to return all the settings configured at the site scope, use this syntax: + +`-Filter "site:*"` + +To return all the settings configured at the service scope, use this syntax: + +`-Filter "service:*"` + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the Registrar configuration settings to be returned. To return the global settings, use this syntax: @@ -105,8 +134,7 @@ If this parameter is omitted then the Get-CsRegistrarConfiguration cmdlet return ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,37 +143,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards in order to return one or more collections of Registrar configuration settings. -For example, to return all the settings configured at the site scope, use this syntax: - -`-Filter "site:*"` - -To return all the settings configured at the service scope, use this syntax: - -`-Filter "service:*"` +### -LocalStore -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore Retrieves the Registrar configuration settings 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsReportingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsReportingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsReportingConfiguration.md index 6a67e67c54..f506d40a04 100644 --- a/skype/skype-ps/skype/Get-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsReportingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsReportingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csreportingconfiguration +schema: 2.0.0 +title: Get-CsReportingConfiguration --- # Get-CsReportingConfiguration @@ -38,21 +39,21 @@ The functions carried out by the Get-CsReportingConfiguration cmdlet are not ava ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsReportingConfiguration ``` The command shown in Example 1 returns information for all the reporting configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsReportingConfiguration -Identity "Service:MonitoringDatabase:atl-sql-001.litwareinc.com" ``` In Example 2, information is returned for a single collection of reporting configuration settings: the settings with the Identity "Service:MonitoringDatabase:atl-sql-001.litwareinc.com". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsReportingConfiguration -Filter "*.litwareinc.com" ``` @@ -60,7 +61,7 @@ Get-CsReportingConfiguration -Filter "*.litwareinc.com" In Example 3, information is returned for all the reporting configuration settings that have an Identity that ends in ".litwareinc.com". To do this, the command uses the Filter parameter and the filter value "*.litwareinc.com". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsReportingConfiguration | Where-Object {$_.ReportingUrl -like "*_ARCHINST*"} ``` @@ -73,6 +74,9 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters when specifying the reporting configuration settings to be returned. For example, this syntax returns all the settings configured at the service scope: @@ -83,8 +87,7 @@ Note that you cannot use both the Filter and the Identity parameters in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database associated with the reporting configuration settings. For example: @@ -104,8 +110,7 @@ If you do not include either the Identity parameter or the Filter parameter in y ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the reporting configuration 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsAgentGroup.md similarity index 89% rename from skype/skype-ps/skype/Get-CsRgsAgentGroup.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsAgentGroup.md index c55cfb40ac..5f130ac2d1 100644 --- a/skype/skype-ps/skype/Get-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsAgentGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsAgentGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgsagentgroup +schema: 2.0.0 +title: Get-CsRgsAgentGroup --- # Get-CsRgsAgentGroup @@ -38,7 +39,7 @@ The Get-CsRgsAgentGroup cmdlet provides a way for you to return information abou ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsAgentGroup ``` @@ -46,21 +47,21 @@ Get-CsRgsAgentGroup Example 1 returns all the Response Group agent groups configured for use in the organization. This is done by calling Get-CsRgsAgentGroup without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com ``` The command shown in Example 2 returns all the Response Group agent groups configured for use on the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" ``` The command shown in Example 3 returns a single Response Group agent group: the group named Help Desk found on the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.RoutingMethod -eq "RoundRobin"} ``` @@ -69,7 +70,7 @@ In Example 4, information is returned for all the Response Group agent groups on To do this, the command first uses Get-CsRgsAgentGroup to return a collection of all the agent groups on ApplicationServer:atl-cs-001.litwareinc.com. This collection is then piped to the Where-Object cmdlet, which selects only those groups where the RoutingMethod property is equal to "RoundRobin". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRgsAgentGroup -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.RoutingMethod -ne "RoundRobin"} ``` @@ -82,6 +83,9 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents either the Identity of the service where the Response Group agent group is hosted or the full Identity of the agent group itself. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com) then all the agent groups hosted on that service will be returned. If you specify the Identity of the group, then only the specified agent group will be returned. @@ -95,8 +99,7 @@ If called without any parameters, Get-CsRgsAgentGroup returns a collection of al ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name given to the agent group at the time the group was created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that "owns" the agent group. The Owner pool ID and the Pool ID of an agent group are typically the same. However, if a group needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. @@ -130,8 +138,7 @@ However, the Owner ID will continue to point to the original pool. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,14 +148,16 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, shows all the Response Group agent groups, including those groups where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsAgentGroup only returns information about agent groups where the Owner pool ID and the Pool ID are identical. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsConfiguration.md similarity index 93% rename from skype/skype-ps/skype/Get-CsRgsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsConfiguration.md index efecbe98eb..c7e990e0dc 100644 --- a/skype/skype-ps/skype/Get-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgsconfiguration +schema: 2.0.0 +title: Get-CsRgsConfiguration --- # Get-CsRgsConfiguration @@ -37,7 +38,7 @@ However, the Examples section in this topic shows a way to work around this issu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" ``` @@ -45,7 +46,7 @@ Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwarein Example 1 returns the Response Group configuration settings for the service ApplicationServer:atl-cs-001.litwareinc.com. Because there can only be one collection of settings per service, this command will never return more than a single item. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` (Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com").DisableCallContext ``` @@ -60,7 +61,7 @@ For example, to display the value of the AgentRingbackGracePeriod property (and `(Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com").AgentRingbackGracePeriod` -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsService -ApplicationServer | Where-Object {$_.Applications -contains "urn:application:RGS"} | ForEach-Object {Get-CsRgsConfiguration -Identity $_.Identity} ``` @@ -76,14 +77,16 @@ ForEach-Object then takes each server in the collection and uses Get-CsRgsConfig ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the service hosting the Response Group configuration settings; for example: -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com". If you do not include this parameter, Get-CsRgsConfiguration will prompt you to supply an Identity. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 diff --git a/skype/skype-ps/skype/Get-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHolidaySet.md similarity index 90% rename from skype/skype-ps/skype/Get-CsRgsHolidaySet.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsHolidaySet.md index 2b7b8d3bf5..d6bbb7114d 100644 --- a/skype/skype-ps/skype/Get-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHolidaySet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsHolidaySet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgsholidayset +schema: 2.0.0 +title: Get-CsRgsHolidaySet --- # Get-CsRgsHolidaySet @@ -49,21 +50,21 @@ The Get-CsRgsHolidaySet provides a way for you to return information about the R ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsHolidaySet ``` Example 1 returns information about all the holiday sets configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" ``` The command shown in Example 2 returns information about all the holiday sets configured for the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "2018 Holidays" ``` @@ -71,7 +72,7 @@ Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.c In Example 3, a single holiday set from the service ApplicationServer:atl-cs-001.litwareinc.com is returned: the set with the Name "2018 Holidays". Because Names must be unique for each service, this command will never return more than one item. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "2018 Holidays"| Select-Object -ExpandProperty HolidayList ``` @@ -80,7 +81,7 @@ Example 4 displays detailed information for the holidays found in the holiday se To do this, the command first uses Get-CsRgsHolidaySet to retrieve the specified holiday set. This set is then passed to the Select-Object cmdlet, which uses the ExpandProperty parameter to show detailed information for each holiday in the set. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Select-Object Identity -ExpandProperty HolidayList | Where-Object {$_.Name -eq "Christmas Day"} | ForEach-Object {Get-CsRgsHolidaySet -Identity $_.Identity} ``` @@ -98,6 +99,9 @@ The net result is a list of all the holiday sets that include a Christmas Day ho ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents either the Identity of the service where the holiday set is hosted or the full Identity of the holiday set. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com), then all the holiday sets hosted on that service will be returned. If you specify the Identity of the holiday set, then only the specified set will be returned. @@ -111,8 +115,7 @@ If called without any parameters, Get-CsRgsHolidaySet returns a collection of al ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -122,13 +125,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name given to the holiday set at the time the set was created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that "owns" the holiday set. The Owner pool ID and the Pool ID of a holiday set are typically the same. However, if a holiday set needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. @@ -146,8 +154,7 @@ However, the Owner ID will continue to point to the original pool. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,14 +164,16 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, shows all the Response Group holiday sets, including those sets where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsHolidaySet only returns information about agent sets where the Owner pool ID and the Pool ID are identical. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHoursOfBusiness.md similarity index 89% rename from skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsHoursOfBusiness.md index 8f06475469..b620ba4c19 100644 --- a/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHoursOfBusiness.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsHoursOfBusiness -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgshoursofbusiness +schema: 2.0.0 +title: Get-CsRgsHoursOfBusiness --- # Get-CsRgsHoursOfBusiness @@ -41,7 +42,7 @@ The Get-CsRgsHoursOfBusiness cmdlet provides a way for you to retrieve informati ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsHoursOfBusiness ``` @@ -49,21 +50,21 @@ Get-CsRgsHoursOfBusiness Example 1 returns information about all the business hour collections configured for use in your organization. This is done by calling Get-CsRgsHoursOfBusiness without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" ``` The command shown in Example 2 returns all the business hour collections configured for use on atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "Help Desk Business Hours" ``` Example 3 returns a single collection of business hours from atl-cs-001.litwareinc.com: the collection with the Name "Help Desk Business Hours". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.SundayTimeRange1 -ne $Null -or $_.SundayTimeRange2 -ne $Null} ``` @@ -73,7 +74,7 @@ To do this, the command first calls Get-CsRgsHoursOfBusiness to return all the b This data is then piped to the Where-Object cmdlet, which selects only those items where one of the following two criteria is true: the SundayTimeRange1 property is not equal to a null value and/or the SundayTimeRange2 property is not equal to a null value. If a time range property is not null, then that means business hours have been configured for that time period. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.MondayTimeRange1.OpenTime -le "08:00:00"} ``` @@ -83,7 +84,7 @@ In order to do this, the command first uses Get-CsRgsHoursOfBusiness to return a This data is then piped to the Where-Object cmdlet, which selects only those collections where the value of the MondayTimeRange1.OpenTime property is less than or equal to 8:00 A.M. (08:00:00). -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.Custom -eq $False} ``` @@ -96,6 +97,9 @@ This data is then piped to the Where-Object cmdlet, which picks out only those c ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents either the Identity of the service where the business hours collection is hosted or the full Identity of the collection itself. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com), then all the business hours collections hosted on that service will be returned. If you specify the Identity of the collection, then only the specified business hours collection will be returned. @@ -109,8 +113,7 @@ If called without any parameters, Get-CsRgsHoursOfBusiness returns all the busin ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -120,13 +123,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name given to the business hours collection at the time the collection was created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that "owns" the business hours. The Owner pool ID and the Pool ID of a collection of business hours are typically the same. However, if a collection needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. @@ -144,8 +152,7 @@ However, the Owner ID will continue to point to the original pool. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,14 +162,16 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, shows all the Response Group business hour collections, including those collections where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsHoursOfBusiness only returns information about business hour collections where the Owner pool ID and the Pool ID are identical. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsQueue.md similarity index 89% rename from skype/skype-ps/skype/Get-CsRgsQueue.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsQueue.md index 80bee92147..0842e2f4d8 100644 --- a/skype/skype-ps/skype/Get-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsQueue.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsQueue -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgsqueue +schema: 2.0.0 +title: Get-CsRgsQueue --- # Get-CsRgsQueue @@ -36,7 +37,7 @@ The Get-CsRgsQueue cmdlet provides a way for you to return information about the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsQueue ``` @@ -44,21 +45,21 @@ Get-CsRgsQueue The command shown in Example 1 returns information about all the Response Group queues configured for use in the organization. This is done by calling Get-CsRgsQueue without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com ``` The command shown in Example 2 returns information about all the Response Group queues located on the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" ``` In Example 3, information is returned for a single Response Group queue: the queue named "Help Desk" located on the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty TimeoutAction ``` @@ -68,7 +69,7 @@ To carry out this task, Get-CsRgsQueue is first used to return information about This information is then passed to the Select-Object cmdlet, which "expands" the value stored in the TimeoutAction property. When you expand the TimeoutAction property, you see the individual properties of the embedded object that make up the property value: Prompt; TargetQuestion; Target; TargetQueueID; and TargetUri. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.OverflowCandidate -eq "NewestCall"} ``` @@ -82,6 +83,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents either the Identity of the service where the Response Group queue is hosted or the full Identity of the queue itself. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com), then all the Response Group queues hosted on that service will be returned. If you specify the Identity of the queue, then only the specified Response Group queue will be returned. @@ -95,8 +99,7 @@ If called without any parameters, Get-CsRgsQueue returns all the Response Group ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name given to the Response Group queue at the time the queue was created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that "owns" the queue. The Owner pool ID and the Pool ID of a queue are typically the same. However, if a queue needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. @@ -130,8 +138,7 @@ However, the Owner ID will continue to point to the original pool. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,14 +148,16 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, shows all the Response Group queues, including those queues where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsQueue only returns information about queues where the Owner pool ID and the Pool ID are identical. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsWorkflow.md similarity index 89% rename from skype/skype-ps/skype/Get-CsRgsWorkflow.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsWorkflow.md index 2e3ca094e9..7b4a16108e 100644 --- a/skype/skype-ps/skype/Get-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsWorkflow.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsWorkflow -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgsworkflow +schema: 2.0.0 +title: Get-CsRgsWorkflow --- # Get-CsRgsWorkflow @@ -38,7 +39,7 @@ The Get-CsRgsWorkflow cmdlet provides a way for you to return information about ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsWorkflow ``` @@ -46,14 +47,14 @@ Get-CsRgsWorkflow Example 1 returns information about all the workflows configured for use in your organization. This is done by calling Get-CsRgsWorkflow without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com ``` Example 2 returns information about all the Response Group application workflows found on the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty DefaultAction ``` @@ -63,14 +64,14 @@ To carry out this task, Get-CsRgsWorkflow is first used to return information ab This information is then piped to the Select-Object cmdlet, which "expands" the value stored in the DefaultAction property. When you expand the value of DefaultAction, you see the individual properties of the embedded object stored in the DefaultAction property. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "European Sales Support" ``` Example 4 returns information about a single Response Group workflow: the European Sales Supports workflow found on ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.Language -eq "en-Us"} ``` @@ -81,7 +82,7 @@ To do this, the command first calls Get-CsRgsWorkflow to return a collection of That collection is then piped to the Where-Object cmdlet, which selects only those workflows where the Language property is equal to U.S. English (en-US). -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.CustomMusicOnHoldFile -eq $Null} ``` @@ -94,6 +95,9 @@ The returned data is then piped to Where-Object, which picks out only those item ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents either the Identity of the service where the Response Group workflow is hosted or the full Identity of the workflow itself. If you specify the service Identity (for example, service: ApplicationServer:atl-cs-001.litwareinc.com), then all the Response Group workflows hosted on that service will be returned. If you specify the Identity of the workflow, then only that one Response Group workflow will be returned. @@ -107,8 +111,7 @@ If called without any parameters, Get-CsRgsWorkflow returns a collection of all ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -118,13 +121,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name given to the Response Group workflow at the time the workflow was created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +139,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that "owns" the workflow. The Owner pool ID and the Pool ID of a workflow are typically the same. However, if a workflow needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. @@ -142,8 +150,7 @@ However, the Owner ID will continue to point to the original pool. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,14 +160,16 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, shows all the Response Group workflows, including those workflows where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsWorkflow only returns information about workflows where the Owner and Parent Pools are identical. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsRoutingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Get-CsRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRoutingConfiguration.md index a17cb208b0..430986aab9 100644 --- a/skype/skype-ps/skype/Get-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csroutingconfiguration +schema: 2.0.0 +title: Get-CsRoutingConfiguration --- # Get-CsRoutingConfiguration @@ -37,7 +38,7 @@ To retrieve individual voice routes or to retrieve them as individual objects ra ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRoutingConfiguration ``` @@ -48,47 +49,53 @@ To retrieve individual voice routes, use the Get-CsVoiceRoute cmdlet. ## PARAMETERS -### -Identity -The scope of the routing configuration to retrieve. -The only possible value is Global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +There can be only one instance of this object, so this parameter does nothing. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -There can be only one instance of this object, so this parameter does nothing. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The scope of the routing configuration to retrieve. +The only possible value is Global. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the routing configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsServerApplication.md similarity index 88% rename from skype/skype-ps/skype/Get-CsServerApplication.md rename to skype/skype-ps/SkypeForBusiness/Get-CsServerApplication.md index 79fa934203..ed93f964b4 100644 --- a/skype/skype-ps/skype/Get-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsServerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsServerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csserverapplication +schema: 2.0.0 +title: Get-CsServerApplication --- # Get-CsServerApplication @@ -37,7 +38,7 @@ The Get-CsServerApplication cmdlet provides a way for administrators to return i ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsServerApplication ``` @@ -45,21 +46,21 @@ Get-CsServerApplication The command shown in Example 1 returns information about all the server applications currently in use in the organization. This is done by calling the Get-CsServerApplication cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsServerApplication -Identity "service:EdgeServer:atl-edge-001.litwareinc.com" ``` In Example 2, information is returned for all the server applications running on the service EdgeServer:atl-edge-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsServerApplication -Identity "service:Registrar:atl-cs-001.litwareinc.com/ExumRouting" ``` Example 3 returns information for a single server application: the application that has the Identity Registrar:atl-cs-001.litwareinc.com/ExumRouting". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsServerApplication -Filter "service:*:atl-cs-001.litwareinc.com*" ``` @@ -68,7 +69,7 @@ Example 4 returns all the server applications configured for use in the pool atl This is done by using the Filter parameter and the filter value "service:*:atl-cs-001.litwareinc.com*". The filter value limits the returned data to applications that have an Identity that begins with the characters "service:" and includes the characters ":atl-cs-001.litwareinc.com". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsServerApplication | Where-Object {$_.Enabled -eq $False} ``` @@ -77,7 +78,7 @@ In Example 5, information is returned for all the server applications that are c To carry out this task, the command first calls the Get-CsServerApplication cmdlet to return a collection of all the server applications configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those applications where the Enabled property is equal to False. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsServerApplication | Where-Object {$_.Critical -eq $True -and $_.Enabled -eq $False} ``` @@ -88,7 +89,7 @@ To do this, the command first calls the Get-CsServerApplication cmdlet without a This collection is then piped to the Where-Object cmdlet, which picks out only those applications that meet two criteria: the Critical property must be equal to True; and, the Enabled property must be equal to False. The -and operator ensures that only objects that meet both criteria will be returned. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsServerApplication | Where-Object {$_.Uri -like "*routing*"} ``` @@ -97,7 +98,7 @@ In Example 7, information is returned for any server application that has the st This task is accomplished by first using the Get-CsServerApplication cmdlet to retrieve all the server applications currently in use. The resulting collection is then piped to the Where-Object cmdlet, which selects only those applications in which the Uri property includes the string value "routing". -### -------------------------- Example 8 -------------------------- +### Example 8 ``` Get-CsServerApplication | Where-Object {$_.ScriptName -ne $Null} ``` @@ -110,7 +111,31 @@ If the ScriptName property is not equal to a null value that means that a script ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when returning a server application or set of server applications. +For example, to return all the server applications that have the string value "IIMFilter" somewhere in their Identity use this syntax: + +`-Filter "*IIMFilter*"` + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the server application to be retrieved. Server application Identities are composed of the service where the application is hosted plus the application name. For example, the server application named QoEAgent might have an Identity similar to this: service: Registrar:atl-cs-001.litwareinc.com/QoEAgent. @@ -124,8 +149,7 @@ If this parameter is omitted, then all the server applications will be returned ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -134,33 +158,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when returning a server application or set of server applications. -For example, to return all the server applications that have the string value "IIMFilter" somewhere in their Identity use this syntax: - -`-Filter "*IIMFilter*"` - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the server application 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsServerPatchVersion.md b/skype/skype-ps/SkypeForBusiness/Get-CsServerPatchVersion.md similarity index 87% rename from skype/skype-ps/skype/Get-CsServerPatchVersion.md rename to skype/skype-ps/SkypeForBusiness/Get-CsServerPatchVersion.md index 707697cc6e..05178f93e2 100644 --- a/skype/skype-ps/skype/Get-CsServerPatchVersion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsServerPatchVersion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csserverpatchversion applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsServerPatchVersion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csserverpatchversion +schema: 2.0.0 +title: Get-CsServerPatchVersion --- # Get-CsServerPatchVersion @@ -22,12 +23,12 @@ Get-CsServerPatchVersion [-Report ] [] ``` ## DESCRIPTION -This cmdlet returns the Skype for Business Server version for each component installed on the server. It replaces the previous methods (Windows Registry and WMI Classes). +This cmdlet returns the Skype for Business Server version for each component installed on the server. It replaces the previous methods (Windows Registry and WMI Classes). You should have installed November 2015 Cumulative Update (6.0.9319.102) for Skype for Business Server 2015 or later. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsServerPatchVersion ``` @@ -38,13 +39,15 @@ This example returns the version for each component installed on the Skype for B ## PARAMETERS ### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Generates a log file with the result of the operation. You should specify the file name in html format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsServerVersion.md b/skype/skype-ps/SkypeForBusiness/Get-CsServerVersion.md similarity index 96% rename from skype/skype-ps/skype/Get-CsServerVersion.md rename to skype/skype-ps/SkypeForBusiness/Get-CsServerVersion.md index 8335546002..8e61e94ed9 100644 --- a/skype/skype-ps/skype/Get-CsServerVersion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsServerVersion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csserverversion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsServerVersion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csserverversion +schema: 2.0.0 +title: Get-CsServerVersion --- # Get-CsServerVersion @@ -46,7 +47,7 @@ If you need a very specific version number then you should use the Windows Contr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsServerVersion ``` diff --git a/skype/skype-ps/skype/Get-CsService.md b/skype/skype-ps/SkypeForBusiness/Get-CsService.md similarity index 82% rename from skype/skype-ps/skype/Get-CsService.md rename to skype/skype-ps/SkypeForBusiness/Get-CsService.md index c0a5253689..4ec3a7f8f5 100644 --- a/skype/skype-ps/skype/Get-CsService.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsService.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsService -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csservice +schema: 2.0.0 +title: Get-CsService --- # Get-CsService @@ -209,14 +210,14 @@ If you need to return information for multiple server roles, you can use the Get ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsService ``` The command shown in Example 1 returns information about all the Skype for Business Server services and server roles currently running in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsService -ApplicationServer ``` @@ -225,7 +226,7 @@ Example 2 returns information only about the Application service. You can return information for other services/server roles simply by using the appropriate parameter. For example, this command returns information about the file store: -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsService -PoolFqdn "atl-cs-001.litwareinc.com" | Select-Object Identity ``` @@ -234,7 +235,7 @@ Example 3 reports back the Identity for each service located on the pool atl-cs- To carry out this task, the command first calls the Get-CsService cmdlet and the PoolFqdn parameter to return only those services and server roles found on the pool atl-cs-001.litwareinc.com. This collection is then piped to the Select-Object cmdlet, which reports back the Identity of each item in the collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsService | Where-Object {$_.SiteID -eq "site:Redmond"} ``` @@ -243,7 +244,7 @@ In Example 4, information is returned for all the services/server roles found on This is done by first calling the Get-CsService cmdlet without any parameters in order to return a collection of all the services and server roles currently in use in the organization. This data is then piped to the Where-Object cmdlet, which picks out only those items where the SiteID property is equal to site:Redmond. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsService | Where-Object {$_.DependentServiceList -like "*Registrar*"} ``` @@ -257,51 +258,17 @@ The Where-Object cmdlet criteria is specified by using the -like operator and th ## PARAMETERS -### -Identity -Unique identifier of the specific service or server role to be returned. -For example: - -`-Identity "Registrar:atl-cs-001.litwareinc.com"` - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Filter -Enables you to use wildcards to specify the service (or services) to be returned. -You cannot use both the Identity and the Filter parameters in the same command. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ApplicationDatabase -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ApplicationDatabase Returns information about the Application databases used in your organization. Application databases are used by the Application service. ```yaml Type: SwitchParameter Parameter Sets: ApplicationDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -311,14 +278,16 @@ Accept wildcard characters: False ``` ### -ApplicationServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Application service. The Application service provides a way to run applications created by using the Microsoft Unified Communications Managed API (UCMA). ```yaml Type: SwitchParameter Parameter Sets: ApplicationServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -328,14 +297,16 @@ Accept wildcard characters: False ``` ### -ArchivingDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Archiving databases used in your organization. Archiving databases store transcripts of instant messaging sessions. ```yaml Type: SwitchParameter Parameter Sets: ArchivingDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -345,14 +316,34 @@ Accept wildcard characters: False ``` ### -ArchivingServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Archiving Servers used in your organization. Archiving Servers enable you to save the transcripts of instant messaging sessions. ```yaml Type: SwitchParameter Parameter Sets: ArchivingServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupServer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the backup servers used in your organization. + +```yaml +Type: SwitchParameter +Parameter Sets: BackupServer +Aliases: Required: False Position: Named @@ -362,14 +353,16 @@ Accept wildcard characters: False ``` ### -CentralManagement + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Central Management service used in your organization. The Central Management service is used to send configuration data to computers running Skype for Business Server services. ```yaml Type: SwitchParameter Parameter Sets: CentralManagement -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -379,14 +372,16 @@ Accept wildcard characters: False ``` ### -CentralManagementDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Central Management store used in your organization. The Central Management store maintains configuration information for Skype for Business Server. ```yaml Type: SwitchParameter Parameter Sets: CentralManagementDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -396,6 +391,9 @@ Accept wildcard characters: False ``` ### -ConferencingServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the A/V Conferencing service used in your organization. The A/V Conferencing service is used to conduct meetings and conferences. @@ -403,7 +401,6 @@ The A/V Conferencing service is used to conduct meetings and conferences. Type: SwitchParameter Parameter Sets: ConferenceServer Aliases: ConferenceServer -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -413,6 +410,9 @@ Accept wildcard characters: False ``` ### -Director + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Directors used in your organization. Directors are empowered to handle user requests and user authentication, but do not house user accounts. Directors are typically used to handle requests from external users. @@ -420,8 +420,7 @@ Directors are typically used to handle requests from external users. ```yaml Type: SwitchParameter Parameter Sets: Director -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -431,14 +430,16 @@ Accept wildcard characters: False ``` ### -EdgeServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Edge Servers used in your organization. Edge Servers provide connectivity between your internal network and the Internet. ```yaml Type: SwitchParameter Parameter Sets: EdgeServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -448,14 +449,16 @@ Accept wildcard characters: False ``` ### -FileStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the File Stores used in your organization. The File Store is used to maintain Skype for Business Server files, such as audio files used by the Announcement service. ```yaml Type: SwitchParameter Parameter Sets: FileStore -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -464,15 +467,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ManagementServer -Returns information about the Central Management Server used in your organization. -The Central Management Server is commonly collocated with the Front End Servers and is responsible for accessing information in the Central Management store. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards to specify the service (or services) to be returned. +You cannot use both the Identity and the Filter parameters in the same command. ```yaml -Type: SwitchParameter -Parameter Sets: ManagementServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False Position: Named @@ -481,15 +486,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MediationServer -Returns information about the Mediation Servers used in your organization. -Mediation Servers help provide a bridge between your Enterprise Voice network and the public switched telephone network (PSTN). +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the specific service or server role to be returned. +For example: + +`-Identity "Registrar:atl-cs-001.litwareinc.com"` + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LegalInterceptServer + +> Applicable: Lync Server 2013 + +Returns information about the legal intercept servers used in your organization. +Legal intercept servers provide real-time interception of instant messaging communications on Office 365. ```yaml Type: SwitchParameter -Parameter Sets: MediationServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LegalInterceptServer +Aliases: Required: False Position: Named @@ -498,15 +526,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringServer -Returns information about the Monitoring Servers used in your organization. -Monitoring Servers are used to track Enterprise Voice phone usage and call quality. +### -ManagementServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Central Management Server used in your organization. +The Central Management Server is commonly collocated with the Front End Servers and is responsible for accessing information in the Central Management store. ```yaml Type: SwitchParameter -Parameter Sets: MonitoringServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ManagementServer +Aliases: Required: False Position: Named @@ -515,15 +545,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringDatabase -Returns information about the monitoring databases used in your organization. -Monitoring databases store Enterprise Voice phone usage and call quality information. +### -MediationServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Mediation Servers used in your organization. +Mediation Servers help provide a bridge between your Enterprise Voice network and the public switched telephone network (PSTN). ```yaml Type: SwitchParameter -Parameter Sets: MonitoringDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: MediationServer +Aliases: Required: False Position: Named @@ -532,15 +564,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolFqdn -Fully qualified domain name (FQDN) of the pool hosting the service or server role. -If you use the PoolFqdn parameter without specifying a service-specific parameter, then all the services and server roles found on that pool will be returned. +### -MonitoringDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the monitoring databases used in your organization. +Monitoring databases store Enterprise Voice phone usage and call quality information. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: MonitoringDatabase +Aliases: Required: False Position: Named @@ -549,15 +583,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProvisionServer -Returns information about the Provision Server service used in your organization. -The Provision Server service is used to manage Lync Server certificates. +### -MonitoringServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Monitoring Servers used in your organization. +Monitoring Servers are used to track Enterprise Voice phone usage and call quality. ```yaml Type: SwitchParameter -Parameter Sets: ProvisionServer -Aliases: -Applicable: Lync Server 2010 +Parameter Sets: MonitoringServer +Aliases: Required: False Position: Named @@ -566,15 +602,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProvisionDatabase -Returns information about the provision databases used in your organization. -Provision databases maintain information about Lync Server certificates. +### -PersistentChatComplianceDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the databases used for maintaining Persistent Chat compliance information. ```yaml Type: SwitchParameter -Parameter Sets: ProvisionDatabase -Aliases: -Applicable: Lync Server 2010 +Parameter Sets: PersistentChatComplianceDatabase +Aliases: Required: False Position: Named @@ -583,15 +620,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnGateway -Returns information about the public switched telephone network (PSTN) gateways used in your organization. -PSTN gateways translate signals from Enterprise Voice devices to signals that can be understood by PSTN devices, and vice-versa. +### -PersistentChatDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the databases used for maintaining Persistent Chat information. ```yaml Type: SwitchParameter -Parameter Sets: PstnGateway -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: PersistentChatDatabase +Aliases: Required: False Position: Named @@ -600,15 +638,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Registrar -Returns information about the Registrars used in your organization. -Registrars are used to authenticate users and to keep track of a user's current status. +### -PersistentChatServer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Persistent Chat servers used in your organization. ```yaml Type: SwitchParameter -Parameter Sets: Registrar -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: PersistentChatServer +Aliases: Required: False Position: Named @@ -617,15 +656,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TrustedApplicationPool -Returns information about the trusted application pools used in your organization. -Trusted applications pools host computers that run trusted applications. +### -PoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool hosting the service or server role. +If you use the PoolFqdn parameter without specifying a service-specific parameter, then all the services and server roles found on that pool will be returned. ```yaml -Type: SwitchParameter -Parameter Sets: TrustedApplicationPool -Aliases: ExternalServer -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -634,15 +675,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserDatabase -Returns information about the User database used in your organization. -User databases store data needed by the User Server service. +### -ProvisionDatabase + +> Applicable: Lync Server 2010 + +Returns information about the provision databases used in your organization. +Provision databases maintain information about Lync Server certificates. ```yaml Type: SwitchParameter -Parameter Sets: UserDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ProvisionDatabase +Aliases: Required: False Position: Named @@ -651,15 +694,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserServer -Returns information about the User Services service used in your organization. -The User Services service provides such things as user replication, in-band provisioning, presence publication and notification, and contact card exchange. +### -ProvisionServer + +> Applicable: Lync Server 2010 + +Returns information about the Provision Server service used in your organization. +The Provision Server service is used to manage Lync Server certificates. ```yaml Type: SwitchParameter -Parameter Sets: UserServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ProvisionServer +Aliases: Required: False Position: Named @@ -668,15 +713,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebServer -Returns information about the Web Services service used in your organization. -The Web Services service host web-based applications such as the Address Book service. +### -PstnGateway + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the public switched telephone network (PSTN) gateways used in your organization. +PSTN gateways translate signals from Enterprise Voice devices to signals that can be understood by PSTN devices, and vice-versa. ```yaml Type: SwitchParameter -Parameter Sets: WebServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: PstnGateway +Aliases: Required: False Position: Named @@ -685,14 +732,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupServer -Returns information about the backup servers used in your organization. +### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Registrars used in your organization. +Registrars are used to authenticate users and to keep track of a user's current status. ```yaml Type: SwitchParameter -Parameter Sets: BackupServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: Registrar +Aliases: Required: False Position: Named @@ -701,15 +751,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegalInterceptServer -Returns information about the legal intercept servers used in your organization. -Legal intercept servers provide real-time interception of instant messaging communications on Office 365. +### -TrustedApplicationPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the trusted application pools used in your organization. +Trusted applications pools host computers that run trusted applications. ```yaml Type: SwitchParameter -Parameter Sets: LegalInterceptServer -Aliases: -Applicable: Lync Server 2013 +Parameter Sets: TrustedApplicationPool +Aliases: ExternalServer Required: False Position: Named @@ -718,14 +770,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PersistentChatComplianceDatabase -Returns information about the databases used for maintaining Persistent Chat compliance information. +### -UserDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the User database used in your organization. +User databases store data needed by the User Server service. ```yaml Type: SwitchParameter -Parameter Sets: PersistentChatComplianceDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: UserDatabase +Aliases: Required: False Position: Named @@ -734,14 +789,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PersistentChatDatabase -Returns information about the databases used for maintaining Persistent Chat information. +### -UserServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the User Services service used in your organization. +The User Services service provides such things as user replication, in-band provisioning, presence publication and notification, and contact card exchange. ```yaml Type: SwitchParameter -Parameter Sets: PersistentChatDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: UserServer +Aliases: Required: False Position: Named @@ -750,14 +808,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PersistentChatServer -Returns information about the Persistent Chat servers used in your organization. +### -VideoGateway + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the video gateway service. +Video gateways provide a way to connect Skype for Business users to video teleconferencing devices. ```yaml Type: SwitchParameter -Parameter Sets: PersistentChatServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: VideoGateway +Aliases: Required: False Position: Named @@ -766,15 +827,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WacServer -Returns information about the Office Web Apps servers used with Microsoft Lync Server. -Office Web Apps server was previously known as "WacServer". +### -VideoInteropServer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the video interoperability service. +The video interoperability service provides a way to seamless connect Skype for Business users to third-party video teleconferencing providers. ```yaml Type: SwitchParameter -Parameter Sets: WacServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: VideoInteropServer +Aliases: Required: False Position: Named @@ -783,15 +846,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoGateway -Returns information about the video gateway service. -Video gateways provide a way to connect Skype for Business users to video teleconferencing devices. +### -WacServer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Office Web Apps servers used with Microsoft Lync Server. +Office Web Apps server was previously known as "WacServer". ```yaml Type: SwitchParameter -Parameter Sets: VideoGateway -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: WacServer +Aliases: Required: False Position: Named @@ -800,15 +865,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoInteropServer -Returns information about the video interoperability service. -The video interoperability service provides a way to seamless connect Skype for Business users to third-party video teleconferencing providers. +### -WebServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Web Services service used in your organization. +The Web Services service host web-based applications such as the Address Book service. ```yaml Type: SwitchParameter -Parameter Sets: VideoInteropServer -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: WebServer +Aliases: Required: False Position: Named @@ -818,7 +885,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 @@ -828,11 +898,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -The Get-CsService cmdlet returns different objects based on the parameters used when calling the cmdlet. -For example, if you include the MonitoringDatabase parameter, the Get-CsService cmdlet returns instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase object. -To determine the objects returned using other parameters, call the Get-CsService cmdlet using one of those parameters, and then pipe the returned object to the Get-Member cmdlet. -For example: +### Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase + +The Get-CsService cmdlet returns different objects based on the parameters used when calling the +cmdlet. For example, if you include the MonitoringDatabase parameter, the Get-CsService cmdlet +returns instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase object. To determine +the objects returned using other parameters, call the Get-CsService cmdlet using one of those +parameters, and then pipe the returned object to the Get-Member cmdlet. For example: `Get-CsService -Registrar | Get-Member` diff --git a/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsSimpleUrlConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsSimpleUrlConfiguration.md index aa3aa23c6e..0fa6b6d36f 100644 --- a/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSimpleUrlConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsSimpleUrlConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cssimpleurlconfiguration +schema: 2.0.0 +title: Get-CsSimpleUrlConfiguration --- # Get-CsSimpleUrlConfiguration @@ -62,7 +63,7 @@ The Get-CsSimpleUrlConfiguration cmdlet provides a way for you to retrieve infor ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsSimpleUrlConfiguration ``` @@ -70,14 +71,14 @@ Get-CsSimpleUrlConfiguration Example 1 returns information about all the simple URL configuration collections currently in use in the organization. This is achieved by calling the Get-CsSimpleUrlConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsSimpleUrlConfiguration -Identity "site:Redmond" ``` In Example 2, information is returned for a single simple URL configuration collection: the configuration with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsSimpleUrlConfiguration -Filter "site:*" ``` @@ -85,7 +86,7 @@ Get-CsSimpleUrlConfiguration -Filter "site:*" Example 3 returns information for all the simple URL configuration collections that have been assigned to the site scope. To do this, the Get-CsSimpleUrlConfiguration cmdlet is called along with the Filter parameter; the filter value "site:*" limits the returned data to those collections that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsSimpleUrlConfiguration | Select-Object -ExpandProperty SimpleUrl ``` @@ -95,7 +96,7 @@ To carry out this task, the command first calls the Get-CsSimpleUrlConfiguration This data is then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to "expand" the value of the SimpleUrl property. Expanding a property value displays all the data stored in that property in an easy-to-read format. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsSimpleUrlConfiguration | Select-Object -ExpandProperty SimpleUrl | Where-Object {$_.Component -eq "Meet"} ``` @@ -109,7 +110,33 @@ The filtered collection is then piped to the Where-Object cmdlet, which picks ou ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters to specify the simple URL collection (or collections) to be returned. +For example, this syntax returns all the simple URL collections that have been configured at the site scope: + +`-Filter "site:*"` + +Note that you cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of simple URLs to be returned. To return the global collection, use this syntax: @@ -127,8 +154,7 @@ Calling the Get-CsSimpleUrlConfiguration cmdlet without any parameters returns a ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -137,19 +163,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters to specify the simple URL collection (or collections) to be returned. -For example, this syntax returns all the simple URL collections that have been configured at the site scope: +### -LocalStore -`-Filter "site:*"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use both the Filter and the Identity parameters in the same command. +Retrieves the simple URL configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -159,6 +182,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account where whose Simple URL configuration settings are to be retrieved. For example: @@ -171,24 +197,7 @@ You can return the tenant ID for each of your tenants by running this command: ```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 -``` - -### -LocalStore -Retrieves the simple URL configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsSipDomain.md similarity index 89% rename from skype/skype-ps/skype/Get-CsSipDomain.md rename to skype/skype-ps/SkypeForBusiness/Get-CsSipDomain.md index 0b57d1b663..70e53dafb9 100644 --- a/skype/skype-ps/skype/Get-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSipDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsSipDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cssipdomain +schema: 2.0.0 +title: Get-CsSipDomain --- # Get-CsSipDomain @@ -43,14 +44,14 @@ The Get-CsSipDomain cmdlet also identifies the default SIP domain for your organ ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsSipDomain ``` In Example 1, the Get-CsSipDomain cmdlet is called without any parameters; this returns information about all the SIP domains configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsSipDomain -Identity fabrikam.com ``` @@ -58,7 +59,7 @@ Get-CsSipDomain -Identity fabrikam.com The command shown in Example 2 returns information for any SIP domain that has the Identity fabrikam.com. Because SIP domain Identities must be unique, this command will never return more than a single item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsSipDomain -Filter "f*" ``` @@ -66,7 +67,7 @@ Get-CsSipDomain -Filter "f*" Example 3 uses the Get-CsSipDomain cmdlet and the Filter parameter to return information about all the SIP domains that have an Identity that begins with the letter "f". For example: fabrikam.com; fabrikam.org; fabrikam-users.com; and so on. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsSipDomain | Where-Object {$_.IsDefault -eq $True} ``` @@ -78,35 +79,39 @@ This collection is then piped to the Where-Object cmdlet, which selects the one ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the SIP domain to be returned (for example, fabrikam.com). -If neither this parameter nor the Filter parameter is specified, then all the SIP domains authorized for use in your organization are returned. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the Identities of the SIP domain (or domains) to be returned. +For example the filter value "*.org" returns a collection of all the authorized SIP domains that have an Identity that ends with the string value ".org". ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Identities of the SIP domain (or domains) to be returned. -For example the filter value "*.org" returns a collection of all the authorized SIP domains that have an Identity that ends with the string value ".org". +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the SIP domain to be returned (for example, fabrikam.com). +If neither this parameter nor the Filter parameter is specified, then all the SIP domains authorized for use in your organization are returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsSipResponseCodeTranslationRule.md similarity index 91% rename from skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsSipResponseCodeTranslationRule.md index ffac7c3b58..bef4da9658 100644 --- a/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSipResponseCodeTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsSipResponseCodeTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cssipresponsecodetranslationrule +schema: 2.0.0 +title: Get-CsSipResponseCodeTranslationRule --- # Get-CsSipResponseCodeTranslationRule @@ -53,7 +54,7 @@ The Get-CsSipResponseCodeTranslationRule cmdlet enables you to retrieve informat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsSipResponseCodeTranslationRule ``` @@ -61,14 +62,14 @@ Get-CsSipResponseCodeTranslationRule The command shown in Example 1 returns a collection of all the response code translation rules configured for use in your organization. This is done by calling the Get-CsSipResponseCodeTranslationRule cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" ``` Example 2 returns a single response code translation rule: the rule with the Identity PstnGateway:192.168.0.240/Rule404. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsSipResponseCodeTranslationRule -Filter "site:*" ``` @@ -76,7 +77,7 @@ Get-CsSipResponseCodeTranslationRule -Filter "site:*" In Example 3, the Filter parameter is used to limit the returned data to all the response code translation rules configured at the site scope. The filter value "site:*" limits the returned data to rules that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsSipResponseCodeTranslationRule | Where-Object {$_.ReceivedISUPCauseValue -eq -1} ``` @@ -89,7 +90,31 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the translation rule (or rules) to be returned. +For example, this syntax returns all the translation rules that have the string value "404" in their Identity: + +-Filter "*404*" + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the translation rule. The identity for a translation rule consists of two parts: the scope where the rule was configured, and the name given to the rule when it was created. For example, a translation rule named Rule404 that was created at the global scope would have an Identity that looked like this: global/Rule404. @@ -106,8 +131,7 @@ If this parameter is omitted, the Get-CsSipResponseCodeTranslationRule cmdlet re ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -116,33 +140,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the translation rule (or rules) to be returned. -For example, this syntax returns all the translation rules that have the string value "404" in their Identity: - --Filter "*404*" - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the SIP response code translation rule 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsSite.md b/skype/skype-ps/SkypeForBusiness/Get-CsSite.md similarity index 89% rename from skype/skype-ps/skype/Get-CsSite.md rename to skype/skype-ps/SkypeForBusiness/Get-CsSite.md index fca553017d..13b45d02a7 100644 --- a/skype/skype-ps/skype/Get-CsSite.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cssite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cssite +schema: 2.0.0 +title: Get-CsSite --- # Get-CsSite @@ -43,21 +44,21 @@ The Get-CsSite cmdlet enables you to return information about all the sites in y ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsSite ``` Example 1 retrieves information for all your Skype for Business Server sites. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsSite -Identity "Redmond" ``` In Example 2, information is returned for a single site: the site with the Identity Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsSite | Where-Object {$_.SiteType -eq "CentralSite"} ``` @@ -66,7 +67,7 @@ The command shown in Example 3 returns information for your central site. To carry out this task, the command first calls the Get-CsSite cmdlet in order to return a collection of all the sites configured for use in your organization. This collection is then piped to the Where-Object cmdlet, which picks out the one site where the SiteType property is equal to "CentralSite". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsSite -Identity "Redmond" | Select-Object -ExpandProperty Pools ``` @@ -79,43 +80,47 @@ Expanding a property value means that all the values stored in that property wil ## PARAMETERS -### -Identity -Name of the site to be returned. -Note that you should specify just the site name; for example: +### -Filter -`-Identity "Redmond"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not use the format "site:Redmond" when specifying the Identity. +Enables you to use wildcards when specifying the Identity of the site (or sites) to be returned. +For example, this syntax returns all the pools that have an Identity that include the string value "Dublin": + +`-Filter "*Dublin*"` + +Note that you cannot use both Filter and Identity in the same command. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Identity of the site (or sites) to be returned. -For example, this syntax returns all the pools that have an Identity that include the string value "Dublin": +### -Identity -`-Filter "*Dublin*"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use both Filter and Identity in the same command. +Name of the site to be returned. +Note that you should specify just the site name; for example: + +`-Identity "Redmond"` + +Do not use the format "site:Redmond" when specifying the Identity. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/Get-CsSlaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsSlaConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsSlaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsSlaConfiguration.md index 6e91991f77..6cbadeb256 100644 --- a/skype/skype-ps/skype/Get-CsSlaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSlaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsSlaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csslaconfiguration +schema: 2.0.0 +title: Get-CsSlaConfiguration --- # Get-CsSlaConfiguration @@ -24,8 +25,8 @@ Get-CsSlaConfiguration [-Identity] [-PassThru] [ Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: UserIdParameter -Indicates the identity of the Enterprise Voice user whose shared number information will be retrieved. +Indicates the identity of the Enterprise Voice user whose shared number information will be retrieved. User identities can be specified using one of five formats: SIP address @@ -87,8 +91,7 @@ Example: CN=KenMyer,CN=Users,DC=Atlanta,DC=Corp,DC=litware,DC=com ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -98,15 +101,17 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: SwitchParameter -The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. +The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsStaticRoutingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsStaticRoutingConfiguration.md index 58237d6f2b..af24fc6008 100644 --- a/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsStaticRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsStaticRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csstaticroutingconfiguration +schema: 2.0.0 +title: Get-CsStaticRoutingConfiguration --- # Get-CsStaticRoutingConfiguration @@ -46,21 +47,21 @@ This includes the ability to return detailed information about each route assign ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsStaticRoutingConfiguration ``` The command shown in Example 1 returns information about all the static routing configuration collections in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" ``` In Example 2, information about a single static routing configuration collection is returned: the collection with the Identity service:Registrar:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsStaticRoutingConfiguration -Filter "service:*" ``` @@ -68,7 +69,7 @@ Get-CsStaticRoutingConfiguration -Filter "service:*" Example 3 uses the Filter parameter to return information about the static routing configuration collections assigned to the service scope. The filter value "service:*" limits the returned data to collections that have an identity that begins with the string value "service:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsStaticRoutingConfiguration | Select-Object -ExpandProperty Route ``` @@ -78,7 +79,7 @@ To do this, the command first calls the Get-CsStaticRoutingConfiguration cmdlet This information is then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to "expand" the value of the Route property. When you expand a property, all the objects and values contained within that property are displayed on the screen in easy-to-read fashion. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsStaticRoutingConfiguration | Select-Object -ExpandProperty Route | Where-Object {$_.MatchOnlyPhoneUri -eq $True} ``` @@ -91,7 +92,33 @@ These route objects are then piped to the Where-Object cmdlet, which picks out o ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the static routing configuration collection (or collections) to be returned. +For example, this syntax returns all the static routing collections configured at the service scope: + +`-Filter "service:*"` + +Note that you cannot use both the Identity and the Filter 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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the static routing configuration collection. To return information about the global collection, use this syntax: @@ -109,8 +136,7 @@ If you do not include either the Identity or the Filter parameters then the Get- ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -119,35 +145,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the static routing configuration collection (or collections) to be returned. -For example, this syntax returns all the static routing collections configured at the service scope: - -`-Filter "service:*"` - -Note that you cannot use both the Identity and the Filter parameters in the same command. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the static routing configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsStorageServiceConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsStorageServiceConfiguration.md index c6356193a8..6d209364e1 100644 --- a/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsStorageServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsStorageServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csstorageserviceconfiguration +schema: 2.0.0 +title: Get-CsStorageServiceConfiguration --- # Get-CsStorageServiceConfiguration @@ -42,21 +43,21 @@ Skype for Business Server Control Panel: The functions carried out by the Get-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsStorageServiceConfiguration ``` The command shown in Example 1 returns information about all the storage service configuration settings in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsStorageServiceConfiguration -Identity "site:Redmond" ``` In Example 2, information is returned for a single collection of storage service configuration settings: the collection of settings applied to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsStorageServiceConfiguration -Filter "service:*" ``` @@ -69,6 +70,9 @@ That filter value limits returned data to collections that have an Identity that ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when retrieving one or more collections of storage service configuration settings. For example, to return all the settings configured at the site scope, use this syntax: @@ -83,8 +87,7 @@ Note that you cannot use both the Filter parameter and the Identity parameter in ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the storage service configuration settings to be returned. Storage service configuration settings can be applied to the global, site, or service scope (for the Registrar service only). To return a complete collection of storage service configuration settings, omit the Identity parameter altogether: @@ -116,8 +122,7 @@ To return settings at the service level, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -127,13 +132,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the storage service configuration 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradeConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradeConfiguration.md index 4c98490cbe..523d97838a 100644 --- a/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradeConfiguration.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsTeamsUpgradeConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csteamsupgradeconfiguration +schema: 2.0.0 +title: Get-CsTeamsUpgradeConfiguration --- # Get-CsTeamsUpgradeConfiguration @@ -31,14 +33,14 @@ 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. +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 +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. + 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. @@ -56,13 +58,15 @@ The above cmdlet lists the properties of TeamsUpgradeConfiguration. ### -Identity + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + {{Fill Identity Description}} ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Do not use ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,13 +94,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradePolicy.md similarity index 92% rename from skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradePolicy.md index 69d65757c9..33b3eaced3 100644 --- a/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 -title: Get-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csteamsupgradepolicy +schema: 2.0.0 +title: Get-CsTeamsUpgradePolicy --- # Get-CsTeamsUpgradePolicy @@ -32,10 +34,10 @@ Get-CsTeamsUpgradePolicy [-Tenant ] [-Filter ] [-LocalStore] [ Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +{{Fill Filter Description}} ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -{{Fill Filter Description}} + + +### -Identity + +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +If identity parameter is passed, this will return a specific instance. If no identity parameter is specified, the cmdlet returns all instances. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 -### -Tenant {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsTelemetryConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsTelemetryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTelemetryConfiguration.md index 53ce0dee66..e8a4820018 100644 --- a/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTelemetryConfiguration.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTelemetryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstelemetryconfiguration +schema: 2.0.0 +title: Get-CsTelemetryConfiguration --- # Get-CsTelemetryConfiguration ## SYNOPSIS -Use the Get-CsTelemetryConfiguration cmdlet to return the settings on existing telemetry configurations. +Use the Get-CsTelemetryConfiguration cmdlet to return the settings on existing telemetry configurations. Telemetry returns a small set of Skype for Business operational data to Microsoft for quality tracking and product improvement. The data includes sign-in information, meeting joins, and other activity data. ## SYNTAX @@ -33,7 +34,7 @@ For privacy information, see the Skype for Business Privacy Statement (https://g ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTelemetryConfiguration -Identity Site:Redmond ``` @@ -44,6 +45,9 @@ This example returns the settings for the configuration scoped to the Redmond si ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more collections of telemetry configuration settings. For example, to return all the settings that have been configured at the site scope use the following syntax: -Filter "site:*". The Filter and the Identity parameters are mutually exclusive. @@ -51,8 +55,7 @@ The Filter and the Identity parameters are mutually exclusive. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier that includes the scope of the telemetry configuration. Telemetry configurations can be scoped at the Global, Site, or Service level. For example, "site:Redmond" (for site). @@ -79,8 +85,7 @@ You can combine the two commands to zero in on a single role in a single pool. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsTenantHybridConfiguration.md similarity index 94% rename from skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTenantHybridConfiguration.md index af7842ce10..1ad843ec24 100644 --- a/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTenantHybridConfiguration.md @@ -1,13 +1,15 @@ --- -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 Server 2019 -title: Get-CsTenantHybridConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstenanthybridconfiguration +schema: 2.0.0 +title: Get-CsTenantHybridConfiguration --- # Get-CsTenantHybridConfiguration @@ -57,14 +59,14 @@ However, you can't create or modify hybrid PSTN sites through the CsTenantHybrid ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantHybridConfiguration -Identity "Global" ``` The command shown in Example 1 returns the property values for the global collection of tenant hybrid configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTenantHybridConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" ``` @@ -75,6 +77,9 @@ In Example 2, property values are returned for the custom tenant hybrid configur ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + Enables you to use wildcard characters in order to return a collection of tenant hybrid configuration settings. Because you are limited to a single, global collection of hybrid configuration settings there is no need to use the Filter parameter. However, this is valid syntax for the Get-CsTenantHybridConfiguration cmdlet: @@ -84,8 +89,7 @@ However, this is valid syntax for the Get-CsTenantHybridConfiguration cmdlet: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -95,6 +99,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique Identity of the tenant hybrid configuration settings to be returned. Because you are limited to a single, global collection of hybrid configuration settings, the only collection that can be returned by using the Identity parameter is the global collection: @@ -105,8 +112,7 @@ To modify the settings for an individual tenant, use the Tenant parameter instea ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -116,13 +122,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + This parameter is not used with Skype for Business Online. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -132,6 +140,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". @@ -144,8 +155,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/Get-CsTenantUpdateTimeWindow.md similarity index 89% rename from skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTenantUpdateTimeWindow.md index 375176efc1..3c33070967 100644 --- a/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTenantUpdateTimeWindow.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstenantupdatetimewindow applicable: Skype for Business Online -title: Get-CsTenantUpdateTimeWindow -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstenantupdatetimewindow +schema: 2.0.0 +title: Get-CsTenantUpdateTimeWindow --- # Get-CsTenantUpdateTimeWindow @@ -40,14 +42,14 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantUpdateTimeWindow ``` The command shown in Example 1 returns information for all the tenant update time windows. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTenantUpdateTimeWindow -Identity "AlwaysOn" ``` @@ -58,13 +60,15 @@ The command shown in Example 2 returns information for the tenant update time wi ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the tenant update time window. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -90,13 +96,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -106,13 +114,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/Get-CsTestDevice.md similarity index 88% rename from skype/skype-ps/skype/Get-CsTestDevice.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTestDevice.md index 079667d0d1..845c924c2a 100644 --- a/skype/skype-ps/skype/Get-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTestDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTestDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstestdevice +schema: 2.0.0 +title: Get-CsTestDevice --- # Get-CsTestDevice @@ -44,7 +45,7 @@ You can use the Get-CsTestDevice cmdlet to retrieve information about the test d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTestDevice ``` @@ -52,21 +53,21 @@ Get-CsTestDevice Example 1 returns all the test devices in the organization. Calling the Get-CsTestDevice cmdlet without any additional parameters will return all the test devices currently in use. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTestDevice -Identity site:Redmond/UCPhone ``` This example returns the test device named UCPhone that was assigned to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTestDevice -Identity site:Redmond ``` In Example 3, the command returns all the test devices configured for the Redmond site. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsTestDevice -Filter site:* ``` @@ -77,7 +78,37 @@ To do this, the command uses the Filter parameter; the filter value "site:*" lim ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way for you to use wildcard characters when specifying the test device (or devices) to be returned. +For example, to return all the test device collections that have been configured at the site scope, use this syntax: + +`-Filter "site:*"` + +To return all the devices that have the term "EMEA" in their Identity, use this syntax: + +`-Filter "*EMEA*"` + +Note that Filter acts only on the Identity of the test device collection; you cannot filter on other collection properties. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the test device to be returned. To refer to an individual device named UCPhone (stored in the global collection), use this syntax: @@ -97,8 +128,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -107,39 +137,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Provides a way for you to use wildcard characters when specifying the test device (or devices) to be returned. -For example, to return all the test device collections that have been configured at the site scope, use this syntax: - -`-Filter "site:*"` - -To return all the devices that have the term "EMEA" in their Identity, use this syntax: - -`-Filter "*EMEA*"` - -Note that Filter acts only on the Identity of the test device collection; you cannot filter on other collection properties. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the test device 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTestUserCredential.md b/skype/skype-ps/SkypeForBusiness/Get-CsTestUserCredential.md similarity index 95% rename from skype/skype-ps/skype/Get-CsTestUserCredential.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTestUserCredential.md index 328d03a5ff..139e1d1a8b 100644 --- a/skype/skype-ps/skype/Get-CsTestUserCredential.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTestUserCredential.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstestusercredential applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTestUserCredential -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstestusercredential +schema: 2.0.0 +title: Get-CsTestUserCredential --- # Get-CsTestUserCredential @@ -42,7 +43,7 @@ The functions carried out by the Get-CsTestUserCredential cmdlet are not availab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTestUserCredential -SipAddress "sip:kenmyer@litewareinc.com" ``` @@ -50,7 +51,7 @@ Get-CsTestUserCredential -SipAddress "sip:kenmyer@litewareinc.com" The command shown in Example 1 returns information for the user sip:kenmyer@litwareinc.com provided that the user has been configured as a watcher node test user. If the user has not been configured as a test user then the Get-CsTestUserCredential cmdlet will return an error. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $ErrorActionPreference = "SilentlyContinue" @@ -74,6 +75,9 @@ The final command in the example resets the value of $ErrorActionPreference to " ## PARAMETERS ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the account being checked for test user credentials. For example: @@ -85,8 +89,7 @@ If you do not, you will be prompted to enter that address. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 diff --git a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystem.md similarity index 89% rename from skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md rename to skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystem.md index eec5a7e4a6..9b4b0450e2 100644 --- a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystem.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsThirdPartyVideoSystem -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csthirdpartyvideosystem +schema: 2.0.0 +title: Get-CsThirdPartyVideoSystem --- # Get-CsThirdPartyVideoSystem @@ -34,21 +35,21 @@ Information about these contact objects can be returned by using the Get-CsThird ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsThirdPartyVideoSystem ``` The command shown in Example 1 returns a collection of all the third-party video systems configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video System"} ``` In Example 2, information is returned for a single third-party video system: the system with the Active Directory display name Redmond Video System. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsThirdPartyVideoSystem -OU "ou=Telecommunications,dc=litwareinc,dc=com" ``` @@ -59,23 +60,10 @@ Note that this command also returns information for any third-party video system ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsThirdPartyVideoSystem cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with contact objects. @@ -85,8 +73,7 @@ For details, see the Get-Credential cmdlet Help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +83,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) of the computer; for example, atl-cs-001.litwareinc.com. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +102,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server 2015. For example, you can limit returned data to third-party video system contact objects that have been assigned a specific voice policy, or contacts that have not been assigned a specific voice policy. @@ -124,8 +116,7 @@ For example, a filter that returns only video systems in the IT department would ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +126,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the third-party video system. Video systems are identified by using the Active Directory distinguished name of the associated contact object. By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. @@ -142,8 +136,7 @@ By default, video systems use a GUID (globally unique identifier) as their commo ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -153,6 +146,9 @@ Accept wildcard characters: False ``` ### -LdapFilter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). For example, you can limit returned data to contact objects that have been assigned to a specific department or are located in a specific building. @@ -166,8 +162,7 @@ In the preceding filter, "l" represents the Active Directory attribute (locality ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,6 +172,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return contact objects from a specific Active Directory organizational unit (OU). The cmdlet will then return data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable - third-party video system information will be returned from each of these OUs. @@ -186,8 +184,7 @@ When specifying an OU, use the distinguished name of that container; for example ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,6 +194,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return 3 video systems (regardless of how many video systems are in your forest), include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which 7 systems will be returned. @@ -208,8 +208,25 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -219,13 +236,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystemPolicy.md similarity index 90% rename from skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystemPolicy.md index 372623ffd8..efa1cc84e9 100644 --- a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystemPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsThirdPartyVideoSystemPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csthirdpartyvideosystempolicy +schema: 2.0.0 +title: Get-CsThirdPartyVideoSystemPolicy --- # Get-CsThirdPartyVideoSystemPolicy @@ -42,7 +43,7 @@ The Get-CsThirdPartyVideoSystem cmdlet provides a way for administrators to retu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsThirdPartyVideoSystemPolicy @@ -50,14 +51,14 @@ Get-CsThirdPartyVideoSystemPolicy The command shown in Example 1 returns information about all the third-party video system policies currently configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystemPolicy -Identity "RedmondVideoSystemPolicy" ``` In Example 2, information for a single third-party video system policy is returned: the per-user policy with the Identity RedmondVideoSystemPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsThirdPartyVideoSystemPolicy -Filter "site:*" ``` @@ -65,7 +66,7 @@ Get-CsThirdPartyVideoSystemPolicy -Filter "site:*" Example 3 returns information about all the third-party video system policies that have been configured at the site scope. To do this, the Filter parameter is included, along with the filter value "site:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsThirdPartVideoSystemPolicy | Where-Object {$_.SupportsSendingLowResolution -eq $True} ``` @@ -78,6 +79,9 @@ That collection is then pipe to the Where-Object cmdlet, which picks out only th ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to do a wildcard search for third-party video system policies. For example, to find all the policies configured at the site scope, use this syntax: @@ -92,8 +96,7 @@ Note that you can only filter on the Identity property. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the policy when it was created. Third-party video system policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -124,8 +130,7 @@ If neither the Identity nor the Filter parameter is specified the Get-CsThirdPar ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -135,13 +140,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the third-party video system 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +158,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the third-party video system policies are being returned. For example: @@ -163,8 +173,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Get-CsTopology.md similarity index 89% rename from skype/skype-ps/skype/Get-CsTopology.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTopology.md index 4f487076f5..3c991d687b 100644 --- a/skype/skype-ps/skype/Get-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTopology.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTopology -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstopology +schema: 2.0.0 +title: Get-CsTopology --- # Get-CsTopology @@ -36,7 +37,7 @@ You can also use the AsXml parameter to return detailed information about your e ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTopology ``` @@ -44,7 +45,7 @@ Get-CsTopology Example 1 returns complete details for your Skype for Business Server topology. This is done by calling the Get-CsTopology cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTopology | Select-Object -ExpandProperty Machines ``` @@ -53,7 +54,7 @@ Example 2 returns information about the computers found in your Skype for Busine To do this, the command first calls the Get-CsTopology cmdlet to return the complete Skype for Business Server topology. This information is then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to extract and display detailed information for all the computers included in that topology. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTopology -AsXML | Out-File C:\Logs\Topology.xml ``` @@ -66,14 +67,16 @@ That formatted data is then piped to the Out-File cmdlet, which saves the inform ## PARAMETERS ### -AsXml + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns topology information in XML format. By combining the Get-CsTopology cmdlet, the AsXml parameter, and the Out-File cmdlet, you can export your topology to an XML file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,13 +86,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the topology 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrunk.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrunk.md similarity index 88% rename from skype/skype-ps/skype/Get-CsTrunk.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrunk.md index 96dffbef9c..26ade9db35 100644 --- a/skype/skype-ps/skype/Get-CsTrunk.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrunk.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrunk applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrunk -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstrunk +schema: 2.0.0 +title: Get-CsTrunk --- # Get-CsTrunk @@ -49,28 +50,28 @@ The functions carried out by the Get-CsTrunk cmdlet are not available in the Sky ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTrunk ``` The command shown in Example 1 returns information for all the SIP trunks configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTrunk -Identity "PstnGateway:192.168.0.240" ``` In Example 2, information is returned for a single SIP trunk: the trunk with the Identity PstnGateway:192.168.0.240. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTrunk -PoolFqdn "atl-cs-001.litwareinc.com" ``` The command shown in Example 3 returns information for all the SIP trunks found on the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsTrunk | Where-Object {$_.Routable -eq $True} ``` @@ -83,6 +84,9 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a SIP trunk (or collection of SIP trunks). For example, to return a collection of all the SIP trunks configured as part of the PSTN gateway service use this syntax: @@ -91,8 +95,7 @@ For example, to return a collection of all the SIP trunks configured as part of ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the SIP trunk to be returned. For example: @@ -115,8 +121,7 @@ If this parameter is not specified, then Get-CsTrunk returns a collection of all ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name for the trunk or PSTN gateway as defined in the topology. For example: @@ -134,8 +142,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrunkConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Get-CsTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrunkConfiguration.md index c3be85f003..c38c6419c0 100644 --- a/skype/skype-ps/skype/Get-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstrunkconfiguration +schema: 2.0.0 +title: Get-CsTrunkConfiguration --- # Get-CsTrunkConfiguration @@ -37,14 +38,14 @@ These settings configure such things as whether media bypass is enabled on this ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTrunkConfiguration ``` This example retrieves all trunk configurations for the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTrunkConfiguration -Identity site:Redmond ``` @@ -52,7 +53,7 @@ Get-CsTrunkConfiguration -Identity site:Redmond This example retrieves the trunk configuration with the Identity site:Redmond. Because identities are unique, this command will return at most one object. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTrunkConfiguration -Filter site:* ``` @@ -63,49 +64,55 @@ The Get-CsTrunkConfiguration cmdlet uses the Filter parameter to retrieve all tr ## PARAMETERS -### -Identity -The unique identifier of the trunk configuration you want to retrieve. -Trunk configurations can be defined at the Global scope, the Site scope, or at the Service scope for a PSTN Gateway service. -For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter accepts a wildcard string and returns all trunk configurations with identities matching that string. +For example, a Filter value of site:* will return all trunk configurations defined at the site level. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter accepts a wildcard string and returns all trunk configurations with identities matching that string. -For example, a Filter value of site:* will return all trunk configurations defined at the site level. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the trunk configuration you want to retrieve. +Trunk configurations can be defined at the Global scope, the Site scope, or at the Service scope for a PSTN Gateway service. +For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplication.md similarity index 89% rename from skype/skype-ps/skype/Get-CsTrustedApplication.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplication.md index b4d37f606f..8b963820b9 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrustedApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstrustedapplication +schema: 2.0.0 +title: Get-CsTrustedApplication --- # Get-CsTrustedApplication @@ -48,14 +49,14 @@ While this prefix is part of the Identity, it's not required when you specify th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTrustedApplication ``` This example retrieves information about all trusted applications defined within the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 ``` @@ -64,7 +65,7 @@ Example 2 retrieves the trusted application with the Identity TrustPool.litwarei Notice that we were able to omit the urn:application: prefix. The Get-CsTrustedApplication cmdlet adds the prefix automatically and retrieves the correct application. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTrustedApplication -Filter *trust* ``` @@ -74,7 +75,7 @@ In this case, with a Filter value of *trust*, the command will retrieve all trus This string can be contained within any part of the Identity, the pool FQDN, or the application ID. So this command will retrieve trusted applications with identities such as TrustedPool.litwareinc.com/urn:application:application1, Pool1.litwareinc.com/urn:application:trustedapp, and Pool1.litwareinc.com/urn:application:trust. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsTrustedApplication -ApplicationId tapp2 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com ``` @@ -83,7 +84,7 @@ Example 4 will return the same results as Example 2 (where the Identity was spec The only difference between the two examples is that Example 2 retrieves the trusted application based on the Identity, which consists of the trusted pool FQDN followed by the application ID. In this example, the application ID and trusted pool FQDN are entered as values to two separate parameters: ApplicationId and TrustedApplicationPoolFqdn. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsTrustedApplication | Where-Object {$_.TrustedApplicationPoolFqdn -eq "TrustPool.litwareinc.com"} ``` @@ -96,25 +97,31 @@ This collection is then piped to the Where-Object cmdlet, which looks through th ## PARAMETERS -### -Identity -The unique identifier of the trusted application you want to retrieve. -Identity values must be entered in the format \/\, where pool FQDN is the FQDN of the pool on which the application resides, and application ID is the name of the application. -Note that if you specify an Identity, you cannot specify an ApplicationID or a TrustedApplicationPoolFqdn. +### -ApplicationId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name of the application. +This can include the application ID prefix, but doesn't need to. +For example, ApplicationId values of urn:application:tapp1 and tapp1 will both return the same application. +If you supply a value for ApplicationId, you cannot supply a value for the Identity, but you must supply a value for the TrustedApplicationPoolFqdn parameter. ```yaml -Type: ExternalApplicationIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string that includes wildcards that enables you to retrieve trusted applications based on Identity values that match the given wildcard string. Identities consist of a trusted application pool FQDN followed by a slash (/) followed by the trusted application ID. The Filter value will match any part of the Identity, both the FQDN and the application ID. @@ -122,8 +129,7 @@ The Filter value will match any part of the Identity, both the FQDN and the appl ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,34 +138,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -The name of the application. -This can include the application ID prefix, but doesn't need to. -For example, ApplicationId values of urn:application:tapp1 and tapp1 will both return the same application. -If you supply a value for ApplicationId, you cannot supply a value for the Identity, but you must supply a value for the TrustedApplicationPoolFqdn parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the trusted application you want to retrieve. +Identity values must be entered in the format \/\, where pool FQDN is the FQDN of the pool on which the application resides, and application ID is the name of the application. +Note that if you specify an Identity, you cannot specify an ApplicationID or a TrustedApplicationPoolFqdn. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: ExternalApplicationIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -TrustedApplicationPoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The FQDN of the trusted application pool on which the application will reside. If you supply a value for TrustedApplicationPoolFqdn, you cannot supply a value for the Identity, but you must supply a value for the ApplicationID parameter. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationComputer.md similarity index 85% rename from skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationComputer.md index 17ccc65a5d..c9654448db 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationcomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrustedApplicationComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstrustedapplicationcomputer +schema: 2.0.0 +title: Get-CsTrustedApplicationComputer --- # Get-CsTrustedApplicationComputer @@ -40,21 +41,21 @@ You can use this cmdlet to retrieve computers based on the computer FQDN or to r ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTrustedApplicationComputer ``` Example 1 retrieves all computers that have been assigned to any trusted application pool within the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- (Skype for Business Server 2015) +### Example 2 (Skype for Business Server 2015) ``` Get-CsTrustedApplicationComputer -Identity Trust1.litwareinc.com ``` Example 2 retrieves information about the computer with the FQDN Trust1.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTrustedApplicationComputer -Filter Trust* ``` @@ -63,14 +64,14 @@ This example uses the Filter parameter to do a wildcard search for all computers The Filter parameter searches the Identity property of all trusted application computers. The wildcard character (*) at the end of the string means that the Filter should look for identities that begin with the string Trust followed by any other characters. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsTrustedApplicationComputer -Pool TrustPool.litwareinc.com ``` Example 4 retrieves a list of all computers that have been assigned to the trusted application pool TrustPool.litwareinc.com. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsTrustedApplicationComputer | Where-Object {$_.Pool -like "*.litwareinc.com"} ``` @@ -87,46 +88,52 @@ A value will match that string if it begins with any set of characters and ends ## PARAMETERS -### -Identity -The fully qualified domain name (FQDN) of the computer you want to retrieve. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string that includes wildcards that enables you to retrieve trusted computers based on Identity values that match the given wildcard string. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string that includes wildcards that enables you to retrieve trusted computers based on Identity values that match the given wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the computer you want to retrieve. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Pool -The FQDN of the trusted application pool for which you want to retrieve computer information. +### -Local + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, returns information only for the local computer. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,14 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Local -When present, returns information only for the local computer. +### -Pool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The FQDN of the trusted application pool for which you want to retrieve computer information. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationEndpoint.md similarity index 83% rename from skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationEndpoint.md index d41c6cd9e1..876a0f591d 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrustedApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstrustedapplicationendpoint +schema: 2.0.0 +title: Get-CsTrustedApplicationEndpoint --- # Get-CsTrustedApplicationEndpoint @@ -33,14 +34,14 @@ This cmdlet retrieves one or more existing endpoint contact objects in Active Di ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTrustedApplicationEndpoint ``` This example retrieves information about all trusted application endpoints defined within the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTrustedApplicationEndpoint -Identity "sip:endpoint1@litwareinc.com" ``` @@ -48,7 +49,7 @@ Get-CsTrustedApplicationEndpoint -Identity "sip:endpoint1@litwareinc.com" Example 2 retrieves information about the application endpoint contact with the SIP address endpoint1@litwareinc.com. Note that the sip: prefix is required when using a SIP address as the Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTrustedApplicationEndpoint -Filter {DisplayName -like "*endpoint*"} ``` @@ -57,7 +58,7 @@ Example 3 retrieves all trusted application endpoints that have the string "endp To do this, the command uses the Filter parameter. The value of the parameter filters to find endpoint objects that have a display name (DisplayName) that contains (-like) the string endpoint (*endpoint* - the wildcard characters indicate that any characters can come before or after the string endpoint, meaning endpoint can be anywhere within the display name). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsTrustedApplicationEndpoint -ApplicationId tapp2 | Select-Object SipAddress, DisplayName, OwnerUrn ``` @@ -70,34 +71,35 @@ The next part of this command pipes the returned object or objects to the Select ## PARAMETERS -### -Identity -The Identity (distinguished name), SIP address, or display name of the application endpoint to be retrieved. +### -ApplicationId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The application ID of the trusted application for the endpoint you want to retrieve. ```yaml -Type: UserIdParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to limit the returned data by filtering on specific attributes for Skype for Business Server. -For example, you can limit returned data to contacts whose display names or SIP addresses match a certain wildcard pattern. +### -Credential -The Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. -For example, a filter that returns only contacts that have been enabled for Enterprise Voice would look like this: {EnterpriseVoiceEnabled -eq $True}, with EnterpriseVoiceEnabled representing the Active Directory attribute, -eq representing the comparison operator (equal to), and $True (a built-in Windows PowerShell variable) representing the filter value. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Alternate credentials to be used to retrieve the endpoint. +You can retrieve a PSCredential object by calling the Get-Credential cmdlet. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,14 +108,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -The application ID of the trusted application for the endpoint you want to retrieve. +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,15 +127,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential -Alternate credentials to be used to retrieve the endpoint. -You can retrieve a PSCredential object by calling the Get-Credential cmdlet. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering on specific attributes for Skype for Business Server. +For example, you can limit returned data to contacts whose display names or SIP addresses match a certain wildcard pattern. + +The Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. +For example, a filter that returns only contacts that have been enabled for Enterprise Voice would look like this: {EnterpriseVoiceEnabled -eq $True}, with EnterpriseVoiceEnabled representing the Active Directory attribute, -eq representing the comparison operator (equal to), and $True (a built-in Windows PowerShell variable) representing the filter value. ```yaml -Type: PSCredential +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,31 +149,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity (distinguished name), SIP address, or display name of the application endpoint to be retrieved. ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The OU in which the endpoint resides. ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,13 +186,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of endpoint records to retrieve. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,13 +204,15 @@ Accept wildcard characters: False ``` ### -TrustedApplicationPoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The fully qualified domain name (FQDN) of the trusted application pool associated with the application for the endpoint you want to retrieve. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationPool.md similarity index 87% rename from skype/skype-ps/skype/Get-CsTrustedApplicationPool.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationPool.md index c790d1b493..b2858d9334 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrustedApplicationPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cstrustedapplicationpool +schema: 2.0.0 +title: Get-CsTrustedApplicationPool --- # Get-CsTrustedApplicationPool @@ -70,14 +71,14 @@ This cmdlet retrieves one or more pools that have been defined as trusted applic ## EXAMPLES -### -------------------------- Example 1 ------------------------ (Lync Server 2010) +### Example 1 (Lync Server 2010) ``` Get-CsTrustedApplicationPool ``` Example 1 retrieves all pools within the Lync Server 2010 deployment that have been defined as trusted application pools. -### -------------------------- EXAMPLE 1 -------------------------- (Lync Server 2013) +### EXAMPLE 1 (Lync Server 2013) ``` ``` @@ -86,7 +87,7 @@ Example 1 retrieves all pools within the Lync Server deployment that have been d Get-CsTrustedApplicationPool -### -------------------------- EXAMPLE 1 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 1 (Skype for Business Server 2015) ``` ``` @@ -95,14 +96,14 @@ Example 1 retrieves all pools within the Skype for Business Server 2015 deployme Get-CsTrustedApplicationPool -### -------------------------- Example 2 ------------------------ (Lync Server 2010) +### Example 2 (Lync Server 2010) ``` Get-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com ``` In this example, we've used the Identity parameter to ensure we retrieve only one trusted application pool, in this case the pool with the FQDN TrustPool.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- (Lync Server 2013) +### EXAMPLE 2 (Lync Server 2013) ``` ``` @@ -111,7 +112,7 @@ In this example, we've used the Identity parameter to ensure we retrieve only on Get-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 2 (Skype for Business Server 2015) ``` ``` @@ -120,7 +121,7 @@ In this example, we've used the Identity parameter to ensure we retrieve only on Get-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -### -------------------------- Example 3 ------------------------ (Lync Server 2010) +### Example 3 (Lync Server 2010) ``` Get-CsTrustedApplicationPool -Filter *:TrustPool.* ``` @@ -130,7 +131,7 @@ The Filter parameter is used with a value of *:TrustPool.*. This filter string will search the Identity values of all trusted application pools for those that contain the string ":TrustPool.". For example, this command will retrieve the pool with the Identity value TrustedApplicationPool:TrustPool.litwareinc.com. -### -------------------------- EXAMPLE 3 -------------------------- (Lync Server 2013) +### EXAMPLE 3 (Lync Server 2013) ``` ``` @@ -142,7 +143,7 @@ For example, this command will retrieve the pool with the Identity value Trusted Get-CsTrustedApplicationPool -Filter *:TrustPool.* -### -------------------------- EXAMPLE 3 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 3 (Skype for Business Server 2015) ``` ``` @@ -154,7 +155,7 @@ For example, this command will retrieve the pool with the Identity value Trusted Get-CsTrustedApplicationPool -Filter *:TrustPool.* -### -------------------------- Example 4 ------------------------ (Lync Server 2010) +### Example 4 (Lync Server 2010) ``` Get-CsTrustedApplicationPool | Where-Object {$_.ServiceId -like "Redmond1*"} ``` @@ -166,7 +167,7 @@ The example begins by calling Get-CsTrustedApplicationPool with no parameters, w This collection is then piped to the Where-Object cmdlet, which narrows down the collection to only those pools where the service ID ($_.ServiceId) matches the wildcard string (-like) Redmond1*. The result will be a collection of all trusted application pools with FQDNs beginning with the string Redmond1, such as Redmond1-ExternalServer-1, Redmond1-ExternalServer-2, and Redmond1-ExternalServer-3. -### -------------------------- EXAMPLE 4 -------------------------- (Lync Server 2013) +### EXAMPLE 4 (Lync Server 2013) ``` ``` @@ -180,7 +181,7 @@ The result will be a collection of all trusted application pools with FQDNs begi Get-CsTrustedApplicationPool | Where-Object {$_.ServiceId -like "Redmond1*"} -### -------------------------- EXAMPLE 4 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 4 (Skype for Business Server 2015) ``` ``` @@ -196,48 +197,54 @@ Get-CsTrustedApplicationPool | Where-Object {$_.ServiceId -like "Redmond1*"} ## PARAMETERS -### -Identity -The fully qualified domain name (FQDN) or service ID of the pool for which you want to retrieve settings. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing one or more wildcard characters that is used to search for a pool with an Identity that matches the wildcard string. +For example, specifying the string *Redmond* would retrieve all trusted application pools with identities containing the string Redmond, such as TrustedApplicationPool:Redmond.litwareinc.com. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string containing one or more wildcard characters that is used to search for a pool with an Identity that matches the wildcard string. -For example, specifying the string *Redmond* would retrieve all trusted application pools with identities containing the string Redmond, such as TrustedApplicationPool:Redmond.litwareinc.com. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) or service ID of the pool for which you want to retrieve settings. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The FQDN of the pool you want to retrieve. This behaves the same as the Identity parameter, except that Identity also accepts a service ID. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,12 +258,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayExternalServer Retrieves one or more objects of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsUCPhoneConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUCPhoneConfiguration.md index 7441f11f69..93ffd0b941 100644 --- a/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUCPhoneConfiguration.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsUCPhoneConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csucphoneconfiguration +schema: 2.0.0 +title: Get-CsUCPhoneConfiguration --- # Get-CsUCPhoneConfiguration @@ -63,7 +65,7 @@ Phone configuration settings can be applied at either the global scope or at the ## EXAMPLES -### -------------------------- Example -------------------------- +### Example 1 ``` Get-CsUCPhoneConfiguration ``` @@ -71,7 +73,7 @@ Get-CsUCPhoneConfiguration The command shown in Example 1 returns all of the UC phone configuration settings currently in use in the organization. Calling the Get-CsUCPhoneConfiguration cmdlet without any parameters always returns a complete collection of phone configuration settings. -### -------------------------- Example -------------------------- +### Example 2 ``` Get-CsUCPhoneConfiguration -Identity site:Redmond ``` @@ -79,7 +81,7 @@ Get-CsUCPhoneConfiguration -Identity site:Redmond In Example 2, only the UC phone configuration settings that have the Identity site:Redmond are returned. Because Identities must be unique, this command will never return more than one collection of phone configuration settings. -### -------------------------- Example -------------------------- +### Example 3 ``` Get-CsUCPhoneConfiguration -Filter site:* ``` @@ -88,7 +90,7 @@ In Example 3, all the UC phone settings that have been configured at the site sc To do this, the Get-CsUCPhoneConfiguration cmdlet is called, along with the Filter parameter; the filter value "site:*" limits the returned data to settings where the Identity property (the only property you can filter on) begins with the string value "site:". By definition, any settings that have an Identity that begins with the string value "site:" are settings that have been configured at the site scope. -### -------------------------- Example -------------------------- +### Example 4 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.SIPSecurityMode -eq "Medium"} ``` @@ -97,7 +99,7 @@ Example 4 returns the UC phone configuration settings where the SIP security mod (SIP security can be set to Low, Medium, or High.) To carry out this task, the command first uses the Get-CsUCPhoneConfiguration cmdlet without any additional parameters in order to return a collection of all the UC phone settings configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the SIPSecurityMode property is equal to Medium. -### -------------------------- Example -------------------------- +### Example 5 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.EnforcePhoneLock -eq $False -or $_.MinPhonePinLength -lt 6} ``` @@ -113,7 +115,35 @@ Where-Object {$_.EnforcePhoneLock -eq $False -and $_.MinPhonePinLength -lt 6} ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection (or collections) of UC phone configuration settings. +To return a collection of all the settings configured at the site scope, use this syntax: + +-Filter site:* + +To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for), use this syntax: + +-Filter *EMEA* + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of unified communications (UC) phone configuration settings you want to return. To refer to the global settings use this syntax: @@ -131,8 +161,7 @@ If this parameter is not specified then the Get-CsUCPhoneConfiguration cmdlet re ```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 +Aliases: Required: False Position: 1 @@ -141,37 +170,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection (or collections) of UC phone configuration settings. -To return a collection of all the settings configured at the site scope, use this syntax: - --Filter site:* - -To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for), use this syntax: - --Filter *EMEA* - -```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the UC phone configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,13 +189,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -201,15 +211,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsUCPhoneConfiguration cmdlet does not accept pipelined input. ## OUTPUTS ### System.Object -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings The Get-CsUCPhoneConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUICulture.md b/skype/skype-ps/SkypeForBusiness/Get-CsUICulture.md similarity index 86% rename from skype/skype-ps/skype/Get-CsUICulture.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUICulture.md index 071c8309d1..b18a666020 100644 --- a/skype/skype-ps/skype/Get-CsUICulture.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUICulture.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuiculture applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUICulture -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuiculture +schema: 2.0.0 +title: Get-CsUICulture --- # Get-CsUICulture @@ -40,7 +41,7 @@ The Get-CsUICulture cmdlet provides a way for you to determine the culture curre ## EXAMPLES -### -------------------------- Example ------------------------ +### Example ``` Get-CsUICulture ``` @@ -49,34 +50,17 @@ The command shown in Example 1 returns basic information about the culture curre ## PARAMETERS -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None. +### None The Get-CsUICulture cmdlet does not accept pipelined input. ## OUTPUTS -### +### System.Globalization.CultureInfo The Get-CsUICulture cmdlet returns instances of the System.Globalization.CultureInfo class. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/Get-CsUnassignedNumber.md similarity index 85% rename from skype/skype-ps/skype/Get-CsUnassignedNumber.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUnassignedNumber.md index 903f8ebaea..c934f4544f 100644 --- a/skype/skype-ps/skype/Get-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUnassignedNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUnassignedNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csunassignednumber +schema: 2.0.0 +title: Get-CsUnassignedNumber --- # Get-CsUnassignedNumber @@ -39,14 +40,14 @@ This cmdlet retrieves one or more unassigned number ranges that define that rout ## EXAMPLES -### -------------------------- Example -------------------------- +### Example 1 ``` Get-CsUnassignedNumber ``` Example 1 returns a collection of all the unassigned numbers configured for use in your organization. -### -------------------------- Example -------------------------- +### Example 2 ``` Get-CsUnassignedNumber -Identity UNSet1 ``` @@ -54,7 +55,7 @@ Get-CsUnassignedNumber -Identity UNSet1 In Example 2, the Identity parameter is used to limit the retrieved data to unassigned numbers that have the Identity UNSet1. Because identities must be unique, this command will return only the specified unassigned number range. -### -------------------------- Example -------------------------- +### Example 3 ``` Get-CsUnassignedNumber -Filter *Redmond* ``` @@ -62,7 +63,7 @@ Get-CsUnassignedNumber -Filter *Redmond* This example uses the Filter parameter to return a collection of all the unassigned number settings with Identity values that include the string Redmond. For example, this command would return unassigned number setting with identities such as Redmond Numbers, Unassigned Redmond Numbers, UNRedmond, etc. -### -------------------------- Example -------------------------- +### Example 4 ``` Get-CsUnassignedNumber | Where-Object {$_.AnnouncementName -match "Welcome"} ``` @@ -73,46 +74,52 @@ That collection is then piped to the Where-Object cmdlet, which applies a filter ## PARAMETERS -### -Identity -The unique name of the unassigned number range to retrieve. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Performs a wildcard search that allows you to narrow down your results to only those unassigned number settings whose identities match the given wildcard string. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named 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 those unassigned number settings whose identities match the given wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique name of the unassigned number range to retrieve. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the unassigned number information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,12 +133,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange Returns an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md b/skype/skype-ps/SkypeForBusiness/Get-CsUpgradeDomainInfo.md similarity index 91% rename from skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUpgradeDomainInfo.md index e8d813bd7c..5c090fc42f 100644 --- a/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUpgradeDomainInfo.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csupgradedomaininfo applicable: Skype for Business Server 2019 -title: Get-CsUpgradeDomainInfo -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csupgradedomaininfo +schema: 2.0.0 +title: Get-CsUpgradeDomainInfo --- # Get-CsUpgradeDomainInfo @@ -32,7 +33,7 @@ The functions carried out by the Get-CsUpgradeDomainInfo cmdlet are not availabl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUpgradeDomainInfo ``` @@ -42,14 +43,16 @@ Note that this command must be executed on a Front End server located within the ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -58,14 +61,16 @@ 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. +### -QueryTimeout + +> Applicable: Skype for Business Server 2019 + +Query timeout period in minutes to retrieve the state of fabric services. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -74,14 +79,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -90,14 +97,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -QueryTimeout -Query timeout period in minutes to retrieve the state of fabric services. +### -WhatIf + +> Applicable: Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsUser.md b/skype/skype-ps/SkypeForBusiness/Get-CsUser.md similarity index 88% rename from skype/skype-ps/skype/Get-CsUser.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUser.md index c59d7c3028..dbea2a89c6 100644 --- a/skype/skype-ps/skype/Get-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuser +schema: 2.0.0 +title: Get-CsUser --- # Get-CsUser @@ -49,18 +50,18 @@ For example, if you don't want to return all your Skype for Business Server user (These parameters are mutually exclusive: if you use Filter in a command you cannot use LdapFilter in that same command, and vice-versa.) The Filter parameter enables you to limit the returned data to users who meet the specified Skype for Business Server criteria; for example, you might decide to return only users with accounts on the specified Registrar pool, or only users who have been enabled for Enterprise Voice. The LdapFilter parameter enables you to limit the returned data to users who fit other Active Directory-based criteria; for example, users who work in a specified state or province, users who do or do not have a pager, or users with a designated job title. -**Note: the equivalent command for Skype for Business Online is [Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/skype/get-csonlineuser?view=skype-ps)**. +**Note: the equivalent command for Skype for Business Online is [Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csonlineuser?view=skype-ps)**. ## EXAMPLES -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 1 ``` Get-CsUser ``` In the preceding example, the Get-CsUser cmdlet is called without any parameters in order to return a collection of all the domain users who have been enabled for Skype for Business Server 2015. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 2 ``` Get-CsUser | Format-Table -Property DisplayName, SipAddress, EnterpriseVoiceEnabled -AutoSize ``` @@ -70,14 +71,14 @@ By default, the Get-CsUser cmdlet returns a very large number of properties and Therefore, in this example the retrieved data is piped to the Format-Table cmdlet. The Format-Table cmdlet then uses the Property parameter to select the properties DisplayName, SipAddress, and EnterpriseVoiceEnabled, and display those properties and their values in a table. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 3 ``` Get-CsUser -Identity "Pilar Ackerman" ``` In Example 3, the Identity parameter is used to limit the returned data to the user account with the Identity (in this case, the display name) Pilar Ackerman. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Identity "Pilar*" ``` @@ -85,7 +86,7 @@ Get-CsUser -Identity "Pilar*" In Example 4, the wildcard character (*) is used when specifying the user's Identity. That causes the Get-CsUser cmdlet to return all the users who have an Identity that begins with the string value "Pilar". -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 5 ``` Get-CsUser -Filter {VoicePolicy -ne $Null} ``` @@ -100,7 +101,7 @@ To return a collection of users who do have a voice policy assigned to them, use Get-CsUser -Filter {VoicePolicy -eq $Null} -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 6 ``` Get-CsUser -LdapFilter "Department=Finance" ``` @@ -108,7 +109,7 @@ Get-CsUser -LdapFilter "Department=Finance" Example 6 uses the LdapFilter parameter to limit the returned data to users who work in the Finance department. This is done by using the LDAP filter value "Department=Finance". -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 7 ``` Get-CsUser -LdapFilter "&(Department=Finance)(Title=Manager)" ``` @@ -117,7 +118,7 @@ Example 7 demonstrates the use of an AND query in conjunction with the LdapFilte This query (which uses the ampersand character "&" to indicate an AND query) specifies two conditions: "Department=Finance" and "Title=Manager". For a user account to be returned by this query, both conditions must be true: a user must work in the Finance department, and he or she must be a Manager. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 8 ``` Get-CsUser -LdapFilter "|(Title=Supervisor)(Title=Manager)" ``` @@ -127,14 +128,14 @@ In the AND query shown in Example 7, both conditions had to be true in order for With an OR query, only one condition must be true for the account to be returned. In this case, a user account will be returned if the user is a Supervisor or if the user is a Manager. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 9 ``` Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com" ``` Example 9 returns user account information for all the users with accounts in the Finance OU. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 10 ``` Get-CsUser -UnassignedUser ``` @@ -143,28 +144,10 @@ Example 10 returns a collection of all the users who have been enabled for Skype ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be retrieved. -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). -You can also reference a user account 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 Server 2015, Skype for Business Server 2019 +### -Credential -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsUser cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with user objects. @@ -176,8 +159,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,14 +169,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +188,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on Skype for Business Server 2015-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. @@ -217,8 +204,7 @@ For example, a filter that returns only users who have been enabled for Enterpri ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -227,17 +213,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnOfficeCommunicationServer -Returns a collection of users homed on Office Communications Server 2007. -Users with accounts on the current version of the software will not be returned when you use this parameter. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates the Identity of the user account to be retrieved. +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). +You can also reference a user account 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: SwitchParameter +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LdapFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). +For example, you can limit returned data to users who work in a specific department, or users who have a specified manager or job title. + +The LdapFilter parameter uses the LDAP query language when creating filters. +For example, a filter that returns only users who work in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. + + + +```yaml +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,6 +261,9 @@ Accept wildcard characters: False ``` ### -OnLyncServer + +> Applicable: Lync Server 2010, Lync Server 2013 + Returns a collection of users homed on Lync Server. Users with accounts on previous versions of the software will not be returned when you use this parameter. @@ -255,8 +272,7 @@ Users with accounts on previous versions of the software will not be returned wh ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013 +Aliases: Required: False Position: Named @@ -265,23 +281,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OU -Enables you to return information about user accounts in a specific organizational unit (OU) or container. -The OU parameter returns data from both the specified OU and any of its child OUs. -For example, if the Finance OU has two child OUs--AccountsPayable and AccountsReceivable--users will be returned from each of these three OUs. - -When specifying an OU, use the distinguished name (DN) of that container; for example: -OU "OU=Finance,dc=litwareinc,dc=com". -To return user accounts from the Users container, use this syntax: - --OU "cn=Users,dc=litwareinc,dc=com" +### -OnModernServer +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: SwitchParameter ```yaml -Type: OUIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: OnLyncServer Required: False Position: Named @@ -290,20 +299,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResultSize -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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns a collection of users homed on Office Communications Server 2007. +Users with accounts on the current version of the software will not be returned when you use this parameter. + -The result size can be set to any whole number between 0 and 2147483647, inclusive. -If set to 0 the command will run, but no data will be returned. -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: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -312,20 +320,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LdapFilter -Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). -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. +### -OU -The LdapFilter parameter uses the LDAP query language when creating filters. -For example, a filter that returns only users who work in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to return information about user accounts in a specific organizational unit (OU) or container. +The OU parameter returns data from both the specified OU and any of its child OUs. +For example, if the Finance OU has two child OUs--AccountsPayable and AccountsReceivable--users will be returned from each of these three OUs. + +When specifying an OU, use the distinguished name (DN) of that container; for example: -OU "OU=Finance,dc=litwareinc,dc=com". +To return user accounts from the Users container, use this syntax: + +-OU "cn=Users,dc=litwareinc,dc=com" ```yaml -Type: String +Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -334,17 +347,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UnAssignedUser -Enables you to return a collection of all the users who have been enabled for Skype for Business Server 2015 but are not currently assigned to a Registrar pool. -Users are not allowed to log on to Skype for Business Server 2015 unless they are assigned to a Registrar pool. +### -ResultSize +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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. +If set to 0 the command will run, but no data will be returned. +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: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -354,6 +372,9 @@ Accept wildcard characters: False ``` ### -UnAssignedUser + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return a collection of all the users who have been enabled for Skype for Business Server 2015 but are not currently assigned to a Registrar pool. Users are not allowed to log on to Skype for Business Server 2015 unless they are assigned to a Registrar pool. @@ -362,8 +383,7 @@ Users are not allowed to log on to Skype for Business Server 2015 unless they ar ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -372,14 +392,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnModernServer -PARAMVALUE: SwitchParameter +### -UnAssignedUser + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to return a collection of all the users who have been enabled for Skype for Business Server 2015 but are not currently assigned to a Registrar pool. +Users are not allowed to log on to Skype for Business Server 2015 unless they are assigned to a Registrar pool. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: OnLyncServer -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -393,13 +418,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String. +### System.String The Get-CsUser cmdlet accepts a pipelined string value representing the Identity of a user account that has been enabled for Skype for Business Server. ## OUTPUTS -### +###Microsoft.Rtc.Management.ADConnect.Schema.ADUser The Get-CsUser cmdlet returns instances of the Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserAcp.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserAcp.md similarity index 90% rename from skype/skype-ps/skype/Get-CsUserAcp.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserAcp.md index 430f4b037c..a7260fad55 100644 --- a/skype/skype-ps/skype/Get-CsUserAcp.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserAcp.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsUserAcp -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuseracp +schema: 2.0.0 +title: Get-CsUserAcp --- # Get-CsUserAcp @@ -60,14 +62,14 @@ Note that the Get-CsUserAcp cmdlet returns audio conferencing provider informati ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-CsUserAcp ``` The command shown in Example 1 returns audio conferencing provider information for all the users in your organization. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUserAcp -Identity "Ken Myer" ``` @@ -75,7 +77,7 @@ Get-CsUserAcp -Identity "Ken Myer" Example 2 returns audio conferencing provider information for a single user: the user with the Identity Ken Myer. In this case, the identity is specified by using the user's Active Directory display name. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUserAcp -Filter {AcpInfo -ne $Null} ``` @@ -86,7 +88,7 @@ To return information about users who have not been assigned an audio conferenci {AcpInfo -eq $Null} -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUserAcp | Where-Object {$_.AcpInfo -match "Fabrikam ACP"} ``` @@ -95,7 +97,7 @@ Example 4 returns audio conferencing provider information for any user who has b To carry out this task the command first uses the Get-CsUserAcp cmdlet without any parameters in order to return audio conferencing provider information for all the users in your organization. This information is then piped to the Where-Object cmdlet, which picks out any user whose AcpInfo property includes (-match) the string value "Fabrikam ACP". -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` Get-CsUserAcp -Identity "Ken Myer" | Select-Object -ExpandProperty AcpInfo ``` @@ -107,30 +109,10 @@ When a property value is expanded, that means that all the information stored in ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be retrieved. -You can specify a user's identity 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 Domain Services display name (for example, Ken Myer). -You can also references a user account 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 with a display name that ends with the string value " Smith". - - +### -Credential -```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 +> 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: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Credential Enables you to run the Get-CsUserAcp cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. @@ -142,8 +124,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential 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 +Aliases: Required: False Position: Named @@ -153,6 +134,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server 2015. 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. @@ -166,8 +150,7 @@ For example, a filter that returns only users who have been enabled for Enterpri ```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 +Aliases: Required: False Position: Named @@ -176,7 +159,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be retrieved. +You can specify a user's identity 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 Domain Services display name (for example, Ken Myer). +You can also references a user account 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 with a display name that ends with the string value " Smith". + + + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -LdapFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). 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. @@ -188,8 +199,7 @@ For example, a filter that returns only users who work in the city of Redmond wo ```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 +Aliases: Required: False Position: Named @@ -199,6 +209,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return seven users (regardless of how many users are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which 7 users will be returned. @@ -212,8 +225,7 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] 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 +Aliases: Required: False Position: Named @@ -229,15 +241,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Rtc.Management.AD.UserIdParameter -### -String. +### String The Get-CsUserAcp cmdlet accepts a pipelined string value representing the Identity of a user account that has been enabled for Skype for Business Server 2015. ## OUTPUTS -### System.Object - -### +### Microsoft.Rtc.Management.ADConnect.Schema.ADUserAcp The Get-CsUserAcp cmdlet returns instances of the Microsoft.Rtc.Management.ADConnect.Schema.ADUserAcp object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserCallForwardingSettings.md similarity index 94% rename from skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserCallForwardingSettings.md index 3fa9eb9579..e746d84297 100644 --- a/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserCallForwardingSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csusercallforwardingsettings applicable: Skype for Business Server 2019 -title: Get-CsUserCallForwardingSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csusercallforwardingsettings +schema: 2.0.0 +title: Get-CsUserCallForwardingSettings --- # Get-CsUserCallForwardingSettings @@ -44,6 +45,9 @@ This example returns the call forwarding settings for the specified user and dis ## PARAMETERS ### -User + +> Applicable: Skype for Business Server 2019CU1 + Specifies the identity of the target user. Acceptable values include: Example: jphillips@contoso.com @@ -53,7 +57,6 @@ Example: sip:jphillips@contoso.com Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2019CU1 Required: True Position: 0 diff --git a/skype/skype-ps/skype/Get-CsUserDatabaseState.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserDatabaseState.md similarity index 89% rename from skype/skype-ps/skype/Get-CsUserDatabaseState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserDatabaseState.md index e213d9e530..cb461e1fad 100644 --- a/skype/skype-ps/skype/Get-CsUserDatabaseState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserDatabaseState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserdatabasestate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserDatabaseState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuserdatabasestate +schema: 2.0.0 +title: Get-CsUserDatabaseState --- # Get-CsUserDatabaseState @@ -43,27 +44,27 @@ However, to run the Get-CsUserDatabaseState cmdlet remotely you will need to man ## EXAMPLES -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 1 ``` Get-CsUserDatabaseState ``` The command shown in Example 1 returns the online status of each user database configured for use in your organization. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 2 ``` Get-CsUserDatabaseState -Identity "UserDatabase:atl-sql-001.litwareinc.com" ``` The command shown in Example 2 returns the online status of a single user database: the database with the Identity UserDatabase:atl-sql-001.litwareinc.com. -### -------------------------- EXAMPLE -------------------------- +### -------------------------- EXAMPLE 3. -------------------------- ``` Get-CsUserDatabaseState -RegistrarPool "atl-cs-001.litwareinc.com"\ ``` In Example 3, status information is returned for all the user databases located in the Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 4 ``` Get-CsUserDatabaseState | Where-Object {$_.Online -eq $True} ``` @@ -76,6 +77,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the user database whose online status is to be returned. For example: @@ -89,8 +93,7 @@ If both parameters are omitted the Get-CsUserDatabaseState cmdlet returns inform ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the Registrar pool hosting the user databases whose online status is to be returned. For example: @@ -113,8 +119,7 @@ If both parameters are omitted the Get-CsUserDatabaseState cmdlet returns inform ```yaml Type: Fqdn Parameter Sets: RegistrarPool -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,13 +133,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsUserDatabaseState cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.UserStoreState The Get-CsUserDatabaseState cmdlet returns instances of the Microsoft.Rtc.Management.Xds.UserStoreState object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserDelegates.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserDelegates.md similarity index 95% rename from skype/skype-ps/skype/Get-CsUserDelegates.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserDelegates.md index 414d0cf5f2..265f94c44d 100644 --- a/skype/skype-ps/skype/Get-CsUserDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserDelegates.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserdelegates applicable: Skype for Business Server 2019 -title: Get-CsUserDelegates -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuserdelegates +schema: 2.0.0 +title: Get-CsUserDelegates --- # Get-CsUserDelegates @@ -44,6 +45,9 @@ This example returns the list of delegates for the specified user ## PARAMETERS ### -User + +> Applicable: Skype for Business Server 2019CU1 + Specifies the identity of the target user. Acceptable values include: Example: jphillips@contoso.com @@ -53,7 +57,6 @@ Example: sip:jphillips@contoso.com Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2019CU1 Required: True Position: 0 diff --git a/skype/skype-ps/skype/Get-CsUserLocationStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserLocationStatus.md similarity index 92% rename from skype/skype-ps/skype/Get-CsUserLocationStatus.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserLocationStatus.md index 88057a3b23..f6fb20cc5a 100644 --- a/skype/skype-ps/skype/Get-CsUserLocationStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserLocationStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserlocationstatus applicable: Skype for Business Online -title: Get-CsUserLocationStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuserlocationstatus +schema: 2.0.0 +title: Get-CsUserLocationStatus --- # Get-CsUserLocationStatus @@ -29,7 +31,7 @@ The `Get-CsUserLocationStatus` tracks the progress of the cross region move and ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> Get-CsUserLocationStatus -Identity PilarA@contoso.com ``` @@ -38,23 +40,10 @@ This example tracks the progress of the cross region move for PilarA@contoso.com ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +### -Identity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Identity Indicates the Identity of the user account to be verified. User Identities can be specified using one of four formats: 1) the user's SIP address; @@ -66,8 +55,7 @@ You can use the asterisk (\*) wildcard character when using the display name as ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -77,13 +65,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 0 @@ -92,7 +82,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before running the 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 + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -100,7 +111,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsUserPoolInfo.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserPoolInfo.md similarity index 90% rename from skype/skype-ps/skype/Get-CsUserPoolInfo.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserPoolInfo.md index dc820faa56..962aa61c85 100644 --- a/skype/skype-ps/skype/Get-CsUserPoolInfo.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserPoolInfo.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserpoolinfo applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserPoolInfo -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuserpoolinfo +schema: 2.0.0 +title: Get-CsUserPoolInfo --- # Get-CsUserPoolInfo @@ -48,13 +49,13 @@ Note that replica information will be shown only if the user's primary pool has ## EXAMPLES -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 1 ``` Get-CsUserPoolInfo "sip:kenmyer@litwareinc.com" ``` This command returns user pool information for a single user: the user with the SIP address sip:kenmyer@litwareinc.com. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 2 ``` Get-CsUser | Get-CsUserPoolInfo ``` @@ -63,7 +64,7 @@ In Example 2, user pool information is returned for all the users who have been To carry out this task, the command first calls the Get-CsUser cmdlet without any parameters in order to return a collection of all the users enabled for Skype for Business Server. This collection is then piped to the Get-CsUserPoolInfo cmdlet, which displays pool information for each user in the collection. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 3 ``` Get-CsUser | Where-Object {$_.RegistrarPool -ne $Null} | Get-CsUserPoolInfo ``` @@ -77,7 +78,7 @@ To suppress the error message, Example 3 again uses the Get-CsUser cmdlet to ret This time, however, the collection is piped to the Where-Object cmdlet, which picks out only users where the RegistrarPool property is not equal to a null value. (In other words, users who have been assigned a Registrar pool.) That filtered collection is then piped to the Get-CsUserPoolInfo cmdlet, which displays pool information for each user in the filtered collection. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {RegistrarPool -eq "redmond-cs-001.litwareinc.com"} | Get-CsUserPoolInfo ``` @@ -87,7 +88,7 @@ To do this, the Get-CsUser cmdlet is called along with the Filter parameter; the That collection is then piped to the Get-CsUserPoolInfo cmdlet, which retrieves pool information for each user in the collection. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 5 ``` Get-CsUser | Get-CsUserPoolInfo | Where-Object {$_.BackupPoolFqdn -eq $Null} ``` @@ -97,7 +98,7 @@ To carry out this task, the command first calls the Get-CsUser cmdlet to return That information is then piped to the Get-CsUserPoolInfo cmdlet, which retrieves pool information for each user in the collection. Finally, that pool information is piped to the Where-Object cmdlet, which displays data only for those users where the BackupPoolFqdn property is equal to a null value. -### -------------------------- Example ------------------------ +### Example 6 ``` Get-CsUserPoolInfo "Ken Myer" | Select-Object -Expand PrimaryPoolMachinesInPreferredOrder ``` @@ -111,6 +112,9 @@ Expanding a property means that all of the values stored in that property are di ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user whose user pool information is to be retrieved. 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 Domain Services display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. @@ -123,8 +127,7 @@ For example, the Identity "\* Smith" returns information for users who have a la ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -134,6 +137,9 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the user pool information from the local replica of the Central Management store rather than from the Central Management store itself. @@ -141,8 +147,7 @@ Retrieves the user pool information from the local replica of the Central Manage ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,14 +161,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. -The Get-CsUserPoolInfo cmdlet accepts a pipelined string value representing the SamAccountName of a user account that has been enabled for Skype for Business Server. +### System.String +The Get-CsUserPoolInfo cmdlet accepts a pipelined string value representing the SamAccountName of a +user account that has been enabled for Skype for Business Server. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined instances of the Active Directory user object. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.GetOCsUserPoolInfoCmdlet+UserInformation The Get-CsUserPoolInfo cmdlet returns instances of the Microsoft.Rtc.Management.Xds.GetOCsUserPoolInfoCmdlet+UserInformation object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserPstnSettings.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserPstnSettings.md similarity index 92% rename from skype/skype-ps/skype/Get-CsUserPstnSettings.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserPstnSettings.md index 0db2a2b553..719f9936de 100644 --- a/skype/skype-ps/skype/Get-CsUserPstnSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserPstnSettings.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserpstnsettings applicable: Skype for Business Online -title: Get-CsUserPstnSettings -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuserpstnsettings +schema: 2.0.0 +title: Get-CsUserPstnSettings --- # Get-CsUserPstnSettings @@ -34,7 +36,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\"} ## EXAMPLES -### -------------------------- Example -------------------------- +### Example ``` Get-CsUserPstnSettings -Identity jphillips@contoso.com -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" ``` @@ -45,6 +47,9 @@ This example returns the PSTN settings for the specified user and tenant. ## PARAMETERS ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the target user. Acceptable values include: @@ -57,8 +62,7 @@ Example: 98403f08-577c-46dd-851a-f0460a13b03d ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -67,14 +71,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Tenant + +> Applicable: Skype for Business Online + +Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. +For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". + +You can find the tenant ID for your Skype for Business Online tenants 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 be determined by your connection and credentials. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -83,21 +96,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. -For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". +### -Confirm -You can find the tenant ID for your Skype for Business Online tenants by running this command: Get-CsTenant | Select-Object DisplayName, TenantID +> Applicable: Skype for Business Online -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 be determined by your connection and credentials. -The Tenant parameter is primarily for use in a hybrid deployment. +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -107,6 +115,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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. @@ -114,7 +125,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 Required: False Position: Named @@ -128,12 +138,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### UserPstnSettings The Get-CsUserPstnSettings cmdlet returns instances of the UserPstnSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserReplicatorConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserReplicatorConfiguration.md index 479833bdf5..63880c4826 100644 --- a/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserReplicatorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserReplicatorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuserreplicatorconfiguration +schema: 2.0.0 +title: Get-CsUserReplicatorConfiguration --- # Get-CsUserReplicatorConfiguration @@ -59,7 +60,7 @@ The Get-CsUserReplicatorConfiguration cmdlet enables administrators to return in ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUserReplicatorConfiguration ``` @@ -70,8 +71,33 @@ The command shown in Example 1 returns information about all the User Replicator ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the collection (or collections) of User Replicator configuration settings to be returned. +For example, this command returns all the settings configured at the service scope: + +-Filter "service:*" + + + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the User Replicator configuration settings to be returned. To return settings at the service scope, use syntax similar to this: @@ -89,8 +115,7 @@ If this parameter is not specified then all the User Replicator configurations s ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -99,35 +124,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the collection (or collections) of User Replicator configuration settings to be returned. -For example, this command returns all the settings configured at the service scope: - --Filter "service:*" - - - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the User Replicator configuration 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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsUserReplicatorConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration The Get-CsUserReplicatorConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserServicesConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsUserServicesConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserServicesConfiguration.md index 110e94585e..1a672d064f 100644 --- a/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserServicesConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserServicesConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuserservicesconfiguration +schema: 2.0.0 +title: Get-CsUserServicesConfiguration --- # Get-CsUserServicesConfiguration @@ -43,7 +44,7 @@ The Get-CsUserServicesConfiguration cmdlet provides a way for administrators to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUserServicesConfiguration ``` @@ -52,7 +53,7 @@ The command shown in Example 1 returns a collection of all the User Services con This is achieved by calling the Get-CsUserServicesConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUserServicesConfiguration -Identity site:Redmond ``` @@ -60,7 +61,7 @@ Get-CsUserServicesConfiguration -Identity site:Redmond In Example 2, only one collection of User Services configuration settings is returned: the collection with the Identity site:Redmond. Because identities must be unique, this command can never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUserServicesConfiguration -Filter "service:*" ``` @@ -70,7 +71,7 @@ This is done by calling the Get-CsUserServicesConfiguration cmdlet along with th By definition, those are settings configured at the service scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUserServicesConfiguration | Where-Object {$_.MaxContacts -gt 250} ``` @@ -80,7 +81,7 @@ To do this, the command first calls the Get-CsUserServicesConfiguration cmdlet w That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the MaxContacts property is greater than 250. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsUserServicesConfiguration | Where-Object {$_.AnonymousUserGracePeriod -gt "00:10:00"} ``` @@ -92,59 +93,61 @@ The returned collection is then piped to the Where-Object cmdlet, which selects ## PARAMETERS -### -Identity - -Unique identifier for the User Services configuration settings to be returned. -To return the global settings, use this syntax:. +### -Filter -`-Identity global` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To return settings configured at the site scope, use syntax similar to this: - -`-Identity site:Redmond` +Enables you to use wildcards when retrieving one or more collections of User Services configuration settings. +For example, to return all the settings configured at the site scope, use this syntax: -To return settings at the service level, use syntax like this: +`-Filter "site:*"` -`-Identity service:UserServer:atl-cs-001.litwareinc.com` +To return all the settings configured at the service scope, use this syntax: -If this parameter is omitted then the Get-CsUserServicesConfiguration cmdlet returns all the User Services configuration settings currently in use in your organization. +`-Filter "service:*"` ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter +### -Identity -Enables you to use wildcards when retrieving one or more collections of User Services configuration settings. -For example, to return all the settings configured at the site scope, use this syntax: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Filter "site:*"` +Unique identifier for the User Services configuration settings to be returned. +To return the global settings, use this syntax:. -To return all the settings configured at the service scope, use this syntax: +`-Identity global` -`-Filter "service:*"` +To return settings configured at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To return settings at the service level, use syntax like this: + +`-Identity service:UserServer:atl-cs-001.litwareinc.com` + +If this parameter is omitted then the Get-CsUserServicesConfiguration cmdlet returns all the User Services configuration settings currently in use in your organization. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -152,6 +155,8 @@ Accept wildcard characters: False ### -LocalStore +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the User Services configuration data from the local replica of the Central Management store rather than from the Central Management store itself. @@ -159,8 +164,7 @@ Retrieves the User Services configuration data from the local replica of the Cen ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +179,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsUserServicesConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings The Get-CsUserServicesConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserServicesPolicy.md similarity index 88% rename from skype/skype-ps/skype/Get-CsUserServicesPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserServicesPolicy.md index 2feb41556d..e7e1df690d 100644 --- a/skype/skype-ps/skype/Get-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserServicesPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsUserServicesPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuserservicespolicy +schema: 2.0.0 +title: Get-CsUserServicesPolicy --- # Get-CsUserServicesPolicy @@ -52,14 +54,14 @@ Skype for Business Server Control Panel: The functions carried out by the Get-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUserServicesPolicy ``` The command shown in Example 1 returns information about all the User Services policies currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUserServicesPolicy -Identity "site:Redmond" @@ -68,7 +70,7 @@ Get-CsUserServicesPolicy -Identity "site:Redmond" In Example 2, information is returned for a single User Services policy: the policy configured for the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUserServicesPolicy -Filter "site:*" ``` @@ -77,7 +79,7 @@ Example 3 returns information for all the User Services policies configured at t This is done by including the Filter parameter and the filter value "site:*". -### -------------------------- Example 4 -------------------------- (Skype for Business Server 2015) +### Example 4 (Skype for Business Server 2015) ``` Get-CsUserServicesPolicy | Where-Object {$_.UcsAllowed -eq $False} ``` @@ -89,6 +91,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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: @@ -103,8 +108,7 @@ You cannot use both the Filter and the Identity parameters in the same command. ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +118,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be returned. To return the global policy, use this syntax: @@ -139,8 +146,7 @@ If this parameter is not included then all of the user services policies configu ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -150,13 +156,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the user services 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: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,6 +174,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When used, retrieves the user services policy for the specified Skype for Business Online tenant. For example: @@ -176,8 +187,7 @@ You should not use the Tenant parameter and the Identity parameter in the same c ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,15 +203,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None -### -None. +### None The Get-CsUserServicesPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### System.Object - -### +### Microsoft.Rtc.Management.WritableConfig.Policy.UsersServices.UserServicesPolicy The Get-CsUserServicesPolicy cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UsersServices.UserServicesPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserSession.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserSession.md similarity index 90% rename from skype/skype-ps/skype/Get-CsUserSession.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserSession.md index 8871e70049..f7d3f5eb42 100644 --- a/skype/skype-ps/skype/Get-CsUserSession.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserSession.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csusersession applicable: Skype for Business Online -title: Get-CsUserSession -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csusersession +schema: 2.0.0 +title: Get-CsUserSession --- # Get-CsUserSession @@ -30,7 +32,7 @@ You have to be assigned Skype For Business admin role to run this cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUserSession -User "Ken.Myer@Contoso.com" -StartTime "02/22/2016 07:30:15 PM" ``` @@ -39,32 +41,34 @@ This example returns user session information for Ken Myer from "02/22/2016 07:3 ## PARAMETERS -### -StartTime -Specifies the start date, time and offset of the date range. +### -EndTime + +> Applicable: Skype for Business Online + +Specifies the end date, time and offset of the date range. ```yaml Type: DateTimeOffset Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -User -Specifies the user whose session data will be retrieved. -The input format is any form of user URI defined in Skype for Business Online. -For instance: `-User "Ken.Myer@Contoso.com"`. +### -StartTime + +> Applicable: Skype for Business Online + +Specifies the start date, time and offset of the date range. ```yaml -Type: String +Type: DateTimeOffset Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: True Position: Named @@ -73,16 +77,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EndTime -Specifies the end date, time and offset of the date range. +### -User + +> Applicable: Skype for Business Online + +Specifies the user whose session data will be retrieved. +The input format is any form of user URI defined in Skype for Business Online. +For instance: `-User "Ken.Myer@Contoso.com"`. ```yaml -Type: DateTimeOffset +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -94,12 +102,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Hosted.Data.UserSession The Get-CsUserSession cmdlet returns an instance of the Microsoft.Rtc.Management.Hosted.Data.UserSession object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserSettingsPageConfiguration.md similarity index 96% rename from skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserSettingsPageConfiguration.md index f92d47dd5f..59605a3a6a 100644 --- a/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserSettingsPageConfiguration.md @@ -1,13 +1,15 @@ --- -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 2015, Skype for Business Server 2019 -title: Get-CsUserSettingsPageConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csusersettingspageconfiguration +schema: 2.0.0 +title: Get-CsUserSettingsPageConfiguration --- # Get-CsUserSettingsPageConfiguration diff --git a/skype/skype-ps/skype/Get-CsUserTeamMembers.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserTeamMembers.md similarity index 95% rename from skype/skype-ps/skype/Get-CsUserTeamMembers.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserTeamMembers.md index a5584e71ca..4b0d3b233d 100644 --- a/skype/skype-ps/skype/Get-CsUserTeamMembers.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserTeamMembers.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserteammembers applicable: Skype for Business Server 2019 -title: Get-CsUserTeamMembers -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csuserteammembers +schema: 2.0.0 +title: Get-CsUserTeamMembers --- # Get-CsUserTeamMembers @@ -45,6 +46,9 @@ This example returns the list of team members for the specified user and display ## PARAMETERS ### -User + +> Applicable: Skype for Business Server 2019CU1 + Specifies the identity of the target user. Acceptable values include: Example: jphillips@contoso.com @@ -54,7 +58,6 @@ Example: sip:jphillips@contoso.com Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2019CU1 Required: True Position: 0 diff --git a/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerConfiguration.md index 66425ce2e9..e3bfe60677 100644 --- a/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVideoInteropServerConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvideointeropserverconfiguration +schema: 2.0.0 +title: Get-CsVideoInteropServerConfiguration --- # Get-CsVideoInteropServerConfiguration @@ -51,14 +52,14 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVideoInteropServerConfiguration ``` This example returns information about all the VIS configuration settings in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoInteropServerConfiguration -Identity "site:Redmond" ``` @@ -66,7 +67,7 @@ Get-CsVideoInteropServerConfiguration -Identity "site:Redmond" This example returns information for the collection of VIS configurations that are scoped to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVideoInteropServerConfiguration -Filter "site:*" ``` @@ -74,7 +75,7 @@ Get-CsVideoInteropServerConfiguration -Filter "site:*" This example returns all the VIS collections configured at the site scope by including the Filter value "site:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVideoInteropServerConfiguration | Where-Object {$_.EnableEnhancedVideoExperience -eq $True} ``` @@ -87,6 +88,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more collections of VIS configuration settings. For example, to return all the settings that have been configured at the site scope use the following syntax: @@ -97,8 +101,7 @@ The Filter and the Identity parameters are mutually exclusive. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the VIS configuration when it was created. VIS settings can be configured at the global, site, or service scope (for the VideoInteropServer service only). To refer to the global instance, use this syntax: @@ -126,8 +132,7 @@ If neither the Identity nor the Filter parameter is specified, then the Get-CsVi ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -137,13 +142,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the VIS configuration from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,13 +164,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsVideoInteropServerConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration The Get-CsVideoInteropServerConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md index 007084aa59..01ada78195 100644 --- a/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVideoInteropServerSyntheticTransactionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvideointeropserversynthetictransactionconfiguration +schema: 2.0.0 +title: Get-CsVideoInteropServerSyntheticTransactionConfiguration --- # Get-CsVideoInteropServerSyntheticTransactionConfiguration @@ -35,7 +36,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVideoInteropServerSyntheticTransactionConfiguration -Identity "site:Redmond" ``` @@ -45,6 +46,9 @@ This example returns the Video Interop Server synthetic transaction configuratio ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more collections of VIS configuration settings. For example, to return all the settings that have been configured at the site scope use the following syntax: @@ -55,8 +59,7 @@ The Filter and the Identity parameters are mutually exclusive. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Video Interop Server (VIS) synthetic transaction configuration to be retrieved. Wildcard characters such as the asterisk (*) cannot be used with the Identity parameter. @@ -76,8 +82,7 @@ If neither the Identity nor the Filter parameter is specified, then the Get-CsVi ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the VIS configuration 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,12 +114,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None +### None ## OUTPUTS -### +### VideoInteropServerSyntheticTransactionConfiguration Returns an object array, or single instance (if used with the Identity parameter) of the VideoInteropServerSyntheticTransactionConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVideoTrunk.md b/skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunk.md similarity index 88% rename from skype/skype-ps/skype/Get-CsVideoTrunk.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunk.md index b6024c0dac..63f7d19dec 100644 --- a/skype/skype-ps/skype/Get-CsVideoTrunk.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunk.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvideotrunk applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVideoTrunk -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvideotrunk +schema: 2.0.0 +title: Get-CsVideoTrunk --- # Get-CsVideoTrunk @@ -41,21 +42,21 @@ To return a list of all the role-based access control (RBAC) roles that can run ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVideoTrunk ``` This example returns information about all the video trunks configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoTrunk -Identity "VideoTrunk:192.168.0.240" ``` This example returns information for a single video trunk with the identity "VideoTrunk:192.168.0.240". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVideoTrunk -Filter "VideoTrunk:192.168*" ``` @@ -67,13 +68,15 @@ The filter value "VideoTrunk:192.168*" limits the returned data to video trunks ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a video trunk (or a collection of video trunks). ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the video trunk to be returned. For example: @@ -96,8 +102,7 @@ If this parameter is not specified, then all the video trunks in the organizatio ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the trunk as defined in the topology. For example: @@ -115,8 +123,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,13 +137,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsVideoTrunk cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayVideoGateway#Decorated The Get-CsVideoTrunk cmdlet returns instances of the Microsoft.Rtc.Management.Xds.DisplayVideoGateway#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunkConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunkConfiguration.md index fc9b683da3..47e38d6f4a 100644 --- a/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVideoTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvideotrunkconfiguration +schema: 2.0.0 +title: Get-CsVideoTrunkConfiguration --- # Get-CsVideoTrunkConfiguration @@ -54,7 +55,7 @@ However, administrators can use the New-CsVideoTrunkConfiguration cmdlet to crea ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVideoTrunkConfiguration ``` @@ -62,7 +63,7 @@ Get-CsVideoTrunkConfiguration This example returns information about all the Video Trunk configurations in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoTrunkConfiguration -Identity "site:Seattle" ``` @@ -70,7 +71,7 @@ Get-CsVideoTrunkConfiguration -Identity "site:Seattle" This example returns information for a collection of Video Trunk configuration settings scoped to the Seattle site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVideoTrunkConfiguration -Filter "site:*" ``` @@ -78,7 +79,7 @@ Get-CsVideoTrunkConfiguration -Filter "site:*" This example returns all the Video Trunk configurations configured at the site scope. This is done by including the Filter parameter and the filter value "site:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVideoTrunkConfiguration | Where-Object {$_.EnableSessionTimer -eq $True} ``` @@ -91,14 +92,16 @@ That collection is then piped to the Where-Object cmdlet, which filters the outp ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Filter parameter enables you to use wildcard characters in order to return one or more collections of Video Interop Server configuration settings. For example, to return all the settings that have been configured at the site scope use the following syntax: -Filter "site:*" ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Identity parameter specifies the Video Trunk configuration to retrieve. Video Trunk configuration settings can be configured at the global, site, or service scope (for the VideoGateway service only). To refer to the global instance, use this syntax: -Identity "global" @@ -122,8 +128,7 @@ If neither the Identity nor the Filter parameter is specified then the Get-CsVid ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -133,13 +138,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Video Trunk configuration data from the local copy of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,13 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsVideoTrunkConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration The Get-CsVideoTrunkConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Get-CsVoiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoiceConfiguration.md index 862ecb0444..72ea396dbe 100644 --- a/skype/skype-ps/skype/Get-CsVoiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvoiceconfiguration +schema: 2.0.0 +title: Get-CsVoiceConfiguration --- # Get-CsVoiceConfiguration @@ -39,7 +40,7 @@ To retrieve individual voice test configurations or to retrieve them as individu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceConfiguration ``` @@ -49,47 +50,53 @@ To retrieve the voice test configurations, use the Get-CsVoiceTestConfiguration ## PARAMETERS -### -Identity -The scope of the voice configuration to retrieve. -The only possible value is Global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +There can only be one instance of this object, so this parameter does nothing. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -There can only be one instance of this object, so this parameter does nothing. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The scope of the voice configuration to retrieve. +The only possible value is Global. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,12 +110,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration This cmdlet returns an instance of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceNormalizationRule.md similarity index 86% rename from skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoiceNormalizationRule.md index 9747b6b836..3e9ffb33b8 100644 --- a/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceNormalizationRule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicenormalizationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvoicenormalizationrule +schema: 2.0.0 +title: Get-CsVoiceNormalizationRule --- # Get-CsVoiceNormalizationRule @@ -41,7 +43,7 @@ The same rules accessed by this cmdlet can also be accessed through the Normaliz ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceNormalizationRule ``` @@ -49,14 +51,14 @@ Get-CsVoiceNormalizationRule This example retrieves all voice normalization rules defined for the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceNormalizationRule -Filter site* ``` Example 2 retrieves all voice normalization rules specified for all sites. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceNormalizationRule -Filter *s* ``` @@ -65,7 +67,7 @@ Example 3 retrieves all voice normalization rules with the letter s anywhere in For example, this will return all site- and service-level rules, as well as per-user rules with an s in the scope name, such as RedmondEastUsers. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVoiceNormalizationRule | Where-Object {$_.Name -match "seattle"} ``` @@ -77,49 +79,55 @@ We then pipe this collection to the Where-Object cmdlet to find all the items in ## PARAMETERS -### -Identity -A unique identifier for the rule. -If a value is specified for this parameter, it must be in the format scope/name; for example, site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Uses wildcard strings to return a collection of normalization rules based on Identity. +Note that Filter works only on the scope portion of the Identity, not on the name. +For example, the filter value *lob* will return all rules at the global scope (scopes that contain the letters lob), but not a rule with the identity site:Redmond/lobby, where lob is only in the name portion of the identity, not the scope. ```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Uses wildcard strings to return a collection of normalization rules based on Identity. -Note that Filter works only on the scope portion of the Identity, not on the name. -For example, the filter value *lob* will return all rules at the global scope (scopes that contain the letters lob), but not a rule with the identity site:Redmond/lobby, where lob is only in the name portion of the identity, not the scope. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the rule. +If a value is specified for this parameter, it must be in the format scope/name; for example, site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: (All) +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice normalization rule from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,13 +137,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +Aliases: Required: False Position: Named @@ -149,14 +159,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### System.Object - -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule The Get-CsVoiceNormalizationRule cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoicePolicy.md similarity index 85% rename from skype/skype-ps/skype/Get-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoicePolicy.md index ee4a8eb0cb..6d73aa63b6 100644 --- a/skype/skype-ps/skype/Get-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoicePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoicePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvoicepolicy +schema: 2.0.0 +title: Get-CsVoicePolicy --- # Get-CsVoicePolicy @@ -40,7 +42,7 @@ Use this cmdlet to retrieve the settings that enable and disable many of these f ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoicePolicy ``` @@ -49,7 +51,7 @@ This example displays all the voice policies that have been defined for an organ -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoicePolicy -Identity UserPolicy1 ``` @@ -57,7 +59,7 @@ Get-CsVoicePolicy -Identity UserPolicy1 This example uses the Identity parameter to retrieve the voice policy settings for the per-user policy named UserPolicy1. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoicePolicy -Filter tag* ``` @@ -69,41 +71,43 @@ All per-user voice policies have an Identity in the format tag:\ Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter accepts a wildcard string and returns all voice policies with identities matching that string. +For example, a Filter value of tag:* will return all voice policies defined at the per-user level. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter +### -Identity -This parameter accepts a wildcard string and returns all voice policies with identities matching that string. -For example, a Filter value of tag:* will return all voice policies defined at the per-user level. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier specifying the scope and, in some cases the name, of the policy. +If this parameter is omitted, all voice policies for the organization are returned. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -111,14 +115,15 @@ Accept wildcard characters: False ### -LocalStore +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice policy from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,6 +134,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Office 365 tenant account whose voice policy is to be retrieved. For example: @@ -142,8 +149,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,12 +163,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy This cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoute.md similarity index 85% rename from skype/skype-ps/skype/Get-CsVoiceRoute.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoute.md index f66706f65e..2e723da73f 100644 --- a/skype/skype-ps/skype/Get-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoiceRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvoiceroute +schema: 2.0.0 +title: Get-CsVoiceRoute --- # Get-CsVoiceRoute @@ -41,7 +42,7 @@ The PSTN usage associates the voice route to a voice policy. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceRoute ``` @@ -49,7 +50,7 @@ Get-CsVoiceRoute Retrieves the properties for all voice routes defined within the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceRoute -Identity Route1 ``` @@ -57,7 +58,7 @@ Get-CsVoiceRoute -Identity Route1 Retrieves the properties for the Route1 voice route. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoute -Filter *test* ``` @@ -66,7 +67,7 @@ This command displays voice route settings where the Identity contains the strin To find the string test only at the end of the Identity, use the value \*test. Similarly, to find the string test only if it occurs at the beginning of the Identity, specify the value test\*. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVoiceRoute | Where-Object {$_.PstnGatewayList.Count -eq 0} ``` @@ -81,47 +82,53 @@ If the count of PSTN gateways is 0, the list is empty and no gateways have been ## PARAMETERS -### -Identity -A string that uniquely identifies the voice route. -If no identity is provided, all voice routes for the organization are returned. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string that uniquely identifies the voice route. +If no identity is provided, all voice routes for the organization are returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice route from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,12 +142,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route This cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoutingPolicy.md similarity index 88% rename from skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoutingPolicy.md index 05f3448032..4b36a89e9d 100644 --- a/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoutingPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Get-CsVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvoiceroutingpolicy +schema: 2.0.0 +title: Get-CsVoiceRoutingPolicy --- # Get-CsVoiceRoutingPolicy @@ -41,21 +43,21 @@ The functions carried out by the Get-CsVoiceRoutingPolicy cmdlet are not availab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceRoutingPolicy ``` The command shown in Example 1 returns information for all the voice routing policies configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" ``` In Example 2, information is returned for a single voice routing policy: the policy with the Identity RedmondVoiceRoutingPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoutingPolicy -Filter "tag:*" ``` @@ -63,7 +65,7 @@ Get-CsVoiceRoutingPolicy -Filter "tag:*" The command shown in Example 3 returns information about all the voice routing 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:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVoiceRoutingPolicy | Where-Object {$_.PstnUsages -contains "Long Distance"} ``` @@ -72,7 +74,7 @@ In Example 4, information is returned only for those voice routing policies that To carry out this task, the command first calls Get-CsVoiceRoutingPolicy without any parameters; that returns a collection of all the voice routing 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 PstnUsages property includes (-contains) the usage "Long Distance". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsVoiceRoutingPolicy | Where-Object {$_.PstnUsages -notcontains "Long Distance"} ``` @@ -83,6 +85,9 @@ In order to do that, the Where-Object cmdlet uses the -notcontains operator, whi ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when retrieving one or more voice routing policies. For example, to return all the policies configured at the per-user scope, use this syntax: @@ -91,8 +96,7 @@ For example, to return all the policies configured at the per-user scope, use th ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +106,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the voice routing policy to be retrieved. To return the global policy, use this syntax: @@ -118,8 +125,7 @@ If neither the Identity nor the Filter parameters are specified, then Get-CsVoic ```yaml Type: XdsIdentity Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -129,13 +135,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice 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: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,13 +157,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsVoiceRoutingPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy The Get-CsVoiceRoutingPolicy cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceTestConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoiceTestConfiguration.md index 3ebb3b103b..b764ba53d4 100644 --- a/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceTestConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoiceTestConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvoicetestconfiguration +schema: 2.0.0 +title: Get-CsVoiceTestConfiguration --- # Get-CsVoiceTestConfiguration @@ -39,7 +40,7 @@ You can do this testing by retrieving a test configuration with this cmdlet, and ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceTestConfiguration ``` @@ -47,7 +48,7 @@ Get-CsVoiceTestConfiguration Retrieves all the voice test configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceTestConfiguration | Select-Object Identity, DialedNumber, ExpectedTranslatedNumber ``` @@ -56,7 +57,7 @@ This example retrieves all the voice test configuration settings, displaying onl The settings returned by the Get-CsVoiceTestConfiguration cmdlet are piped to the Select-Object cmdlet, where the output is narrowed down to the Identity, DialedNumber, and ExpectedTranslatedNumber properties. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceTestConfiguration -Filter *test* ``` @@ -69,47 +70,53 @@ For example, this command would return voice test configurations with names such ## PARAMETERS -### -Identity -A string uniquely identifying the test configuration you want to retrieve. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter provides a way to do a wildcard search of the defined voice test configurations. +(For details, see the examples in this topic.) ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter provides a way to do a wildcard search of the defined voice test configurations. -(For details, see the examples in this topic.) +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string uniquely identifying the test configuration you want to retrieve. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice test configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,12 +130,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration Returns one of more objects of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoicemailReroutingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoicemailReroutingConfiguration.md index 18b12a31a4..42b0021016 100644 --- a/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoicemailReroutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoicemailReroutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csvoicemailreroutingconfiguration +schema: 2.0.0 +title: Get-CsVoicemailReroutingConfiguration --- # Get-CsVoicemailReroutingConfiguration @@ -44,7 +45,7 @@ Calling this cmdlet with no parameters will return all voice mail rerouting conf ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoicemailReroutingConfiguration ``` @@ -52,7 +53,7 @@ Get-CsVoicemailReroutingConfiguration This example retrieves all of the voice mail rerouting configuration settings defined in this deployment of Skype for Business Server 2015. For example, if there are three branch offices where a Survivable Branch Appliance is deployed, this command will return three voice mail rerouting configuration sets. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoicemailReroutingConfiguration -Identity site:BranchOffice_Portland ``` @@ -60,7 +61,7 @@ Get-CsVoicemailReroutingConfiguration -Identity site:BranchOffice_Portland This example retrieves the voice mail rerouting configuration settings for the site BranchOffice_Portland. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoicemailReroutingConfiguration -Filter *:BranchOffice* ``` @@ -68,7 +69,7 @@ Get-CsVoicemailReroutingConfiguration -Filter *:BranchOffice* This example retrieves all the voice mail rerouting settings for all sites with site names beginning with the string BranchOffice (for example, BranchOffice_Portland, BranchOffice_Sacramento). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVoicemailReroutingConfiguration | Where-Object {$_.Enabled -eq $False} ``` @@ -81,47 +82,53 @@ The Where-Object cmdlet narrows that collection down to include only the configu ## PARAMETERS -### -Identity -The unique identifier of the configuration you want to retrieve. -For this cmdlet the Identity will be either Global or Site:\, where \ is the name of the site to which the settings are applied. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Filter parameter allows you to retrieve configuration settings for a particular set of sites based on wildcard matching. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to retrieve configuration settings for a particular set of sites based on wildcard matching. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the configuration you want to retrieve. +For this cmdlet the Identity will be either Global or Site:\, where \ is the name of the site to which the settings are applied. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice mail rerouting configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,12 +142,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration Retrieves one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsWatcherNodeConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsWatcherNodeConfiguration.md index f8c31c4d96..9b6c9207f1 100644 --- a/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsWatcherNodeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsWatcherNodeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cswatchernodeconfiguration +schema: 2.0.0 +title: Get-CsWatcherNodeConfiguration --- # Get-CsWatcherNodeConfiguration @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: The functions carried out by the Get-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsWatcherNodeConfiguration ``` @@ -56,7 +57,7 @@ Get-CsWatcherNodeConfiguration The command shown in Example 1 returns information about all the watcher nodes currently configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" ``` @@ -64,7 +65,7 @@ Get-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" In Example 2, information is returned for the watcher node associated with the pool. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsWatcherNodeConfiguration | Where-Object {$_.TestUsers -contains "sip:kenmyer@litwareinc.com"} ``` @@ -74,7 +75,7 @@ To do this, the command first uses the Get-CsWatcherNodeConfiguration cmdlet to That collection is then piped to the Where-Object cmdlet, which picks out only those nodes where the TestUsers property contains the SIP address sip:kenmyer@litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsWatcherNodeConfiguration | Where-Object {$_.ExtendedTests -match "TestType=PSTN"} ``` @@ -88,6 +89,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more watcher nodes. For example, to return all of the watcher nodes for the domain litwareinc.com use this syntax: @@ -96,8 +100,7 @@ For example, to return all of the watcher nodes for the domain litwareinc.com us ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +111,8 @@ Accept wildcard characters: False ### -Identity +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that the watcher node has been assigned to. For example: @@ -120,8 +125,7 @@ If this parameter is not specified then the Get-CsWatcherNodeConfiguration cmdle ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -131,13 +135,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the watcher node configuration 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +157,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsWatcherNodeConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated The Get-CsWatcherNodeConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsWebServiceConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsWebServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsWebServiceConfiguration.md index 0955ecea76..219d0dcb0c 100644 --- a/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsWebServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsWebServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cswebserviceconfiguration +schema: 2.0.0 +title: Get-CsWebServiceConfiguration --- # Get-CsWebServiceConfiguration @@ -43,7 +44,7 @@ The Get-CsWebServiceConfiguration cmdlet enables you to return detailed informat ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsWebServiceConfiguration ``` @@ -51,7 +52,7 @@ Get-CsWebServiceConfiguration Example 1 returns information about all the Web Services configuration settings currently in use in the organization. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsWebServiceConfiguration -Identity site:Redmond ``` @@ -59,7 +60,7 @@ Get-CsWebServiceConfiguration -Identity site:Redmond The command shown in Example 2 returns information about the Web Services configuration settings that have the Identity site:Redmond. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsWebServiceConfiguration -Filter "site:*" ``` @@ -68,7 +69,7 @@ Example 3 returns all the Web Services configuration settings that have been ass To do this, the Filter parameter is included when calling the Get-CsWebServiceConfiguration cmdlet; the filter value "site:*" ensures that only those settings that have an Identity that begins with the string value "site:" are returned. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsWebServiceConfiguration | Where-Object {$_.UsePinAuth -eq $False} ``` @@ -78,7 +79,7 @@ This is done by first calling the Get-CsWebServiceConfiguration cmdlet to return This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the UsePinAuth property is equal to False. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Get-CsWebServiceConfiguration | Where-Object {$_.MaxGroupSizeToExpand -gt 100} ``` @@ -91,58 +92,60 @@ This information is then piped to the Where-Object cmdlet, which selects only th ## PARAMETERS -### -Identity - -Unique identifier for the Web Services configuration settings to be returned. -To return the global settings, use this syntax: - --Identity global - -To return settings configured at the site scope, use syntax similar to this: +### -Filter --Identity "site:Redmond" +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Service-scope settings can be returned using syntax like this: +Enables you to use wildcards when specifying the Web Services configuration settings collection (or collections) to be returned. +For example, this syntax returns all the settings configured at the site scope: --Identity "service:WebServer:atl-cs-001.litwareinc.com" +-Filter "site:*" You cannot use both the Filter and the Identity parameters in the same command. -If you do not specify either parameter, the Get-CsWebServiceConfiguration cmdlet will return all the Web Services settings collections currently in use in your organization. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter +### -Identity -Enables you to use wildcards when specifying the Web Services configuration settings collection (or collections) to be returned. -For example, this syntax returns all the settings configured at the site scope: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 --Filter "site:*" +Unique identifier for the Web Services configuration settings to be returned. +To return the global settings, use this syntax: + +-Identity global + +To return settings configured at the site scope, use syntax similar to this: + +-Identity "site:Redmond" + +Service-scope settings can be returned using syntax like this: + +-Identity "service:WebServer:atl-cs-001.litwareinc.com" You cannot use both the Filter and the Identity parameters in the same command. +If you do not specify either parameter, the Get-CsWebServiceConfiguration cmdlet will return all the Web Services settings collections currently in use in your organization. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -150,6 +153,8 @@ Accept wildcard characters: False ### -LocalStore +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Web Services configuration data from the local replica of the Central Management store rather than from the Central Management store itself. @@ -157,8 +162,7 @@ Retrieves the Web Services configuration data from the local replica of the Cent ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,13 +176,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsWebServiceConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Web.WebServiceSettings The Get-CsWebServiceConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Web.WebServiceSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsWindowsService.md b/skype/skype-ps/SkypeForBusiness/Get-CsWindowsService.md similarity index 88% rename from skype/skype-ps/skype/Get-CsWindowsService.md rename to skype/skype-ps/SkypeForBusiness/Get-CsWindowsService.md index 1141e80426..45c8af401c 100644 --- a/skype/skype-ps/skype/Get-CsWindowsService.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsWindowsService.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cswindowsservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsWindowsService -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cswindowsservice +schema: 2.0.0 +title: Get-CsWindowsService --- # Get-CsWindowsService @@ -41,7 +42,7 @@ However, by including the ComputerName parameter you can return information abou ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsWindowsService ``` @@ -51,7 +52,7 @@ This is done by calling the Get-CsWindowsService cmdlet without any parameters. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsWindowsService | Format-List ``` @@ -62,7 +63,7 @@ In the default, tabular view, only a subset of property values is displayed.) To -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsWindowsService -Name "RTCSrv" ``` @@ -71,7 +72,7 @@ Example 3 returns information for a single Skype for Business Server service: th -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsWindowsService -Name "RTCSrv" | Select-Object -ExpandProperty RoleName @@ -83,7 +84,7 @@ This information is then piped to the Select-Object cmdlet, which uses the Expan Note that this command will return an error message if a service does not have a role name. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Get-CsWindowsService -Computer atl-cs-001.litwareinc.com ``` @@ -93,7 +94,7 @@ This is done by including the ComputerName parameter followed by the FQDN of the -### -------------------------- Example 6 ------------------------ +### Example 6 ``` Get-CsWindowsService -Report C:\Logs\Services.html ``` @@ -104,7 +105,7 @@ If the Get-CsWindowsService cmdlet encounters any problems in retrieving service -### -------------------------- Example 7 ------------------------ +### Example 7 ``` Get-CsWindowsService | Where-Object {$_.Status -eq "Running"} ``` @@ -115,7 +116,7 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t -### -------------------------- Example 8 ------------------------ +### Example 8 ``` Get-CsWindowsService | Where-Object {$_.DisplayName -like "*Application Sharing*"} ``` @@ -126,7 +127,7 @@ This collection is then piped to the Where-Object cmdlet, which selects the one The end result: information is displayed for the Skype for Business Server Application Sharing Conferencing service. -### -------------------------- Example 9 ------------------------ +### Example 9 ``` Get-CsWindowsService | Where-Object {$_.RoleName -contains "ApplicationServer"} ``` @@ -138,44 +139,39 @@ This collection is then piped to the Where-Object cmdlet, which selects those se ## PARAMETERS -### -Name - -Name of the service you want to return information for. -Note that you must use the service name (for example, RTCCAA) and not the service display name. -You can only pass a single service name to the Name parameter; in addition you cannot use wildcards in the service name. +### -ComputerName -Note, too that the Get-CsWindowsService cmdlet can only return information for Skype for Business Server services; you cannot use this cmdlet to return information for other Windows services. -For those services, you might be able to use the Windows PowerShell Get-Service cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If you do not include this parameter, the Get-CsWindowsService cmdlet will return information about all your Skype for Business Server services. +Name of the remote computer from which service information is to be retrieved; if this parameter is not included, the Get-CsWindowsService cmdlet will return information about the Skype for Business Server services running on the local computer. +The remote computer should be referenced by using its fully qualified domain name (FQDN); for example, atl-mcs-001.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 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName +### -ExcludeActivityLevel -Name of the remote computer from which service information is to be retrieved; if this parameter is not included, the Get-CsWindowsService cmdlet will return information about the Skype for Business Server services running on the local computer. -The remote computer should be referenced by using its fully qualified domain name (FQDN); for example, atl-mcs-001.litwareinc.com. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If included, this parameter causes the Get-CsWindowsService cmdlet to return only the service status and not the service activity level. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,34 +180,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeActivityLevel +### -Name -If included, this parameter causes the Get-CsWindowsService cmdlet to return only the service status and not the service activity level. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the service you want to return information for. +Note that you must use the service name (for example, RTCCAA) and not the service display name. +You can only pass a single service name to the Name parameter; in addition you cannot use wildcards in the service name. + +Note, too that the Get-CsWindowsService cmdlet can only return information for Skype for Business Server services; you cannot use this cmdlet to return information for other Windows services. +For those services, you might be able to use the Windows PowerShell Get-Service cmdlet. + +If you do not include this parameter, the Get-CsWindowsService cmdlet will return information about all your Skype for Business Server services. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to an HTML file where error information can be stored. If this parameter is included, any errors that occur during the running of this cmdlet will be logged to the specified file (for example, C:\Logs\Service_report.html). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,13 +231,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsWindowsService cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.Deployment.Core.NTService The Get-CsWindowsService cmdlet returns instances of the Microsoft.Rtc.Management.Deployment.Core.NTService object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/Get-CsXmppAllowedPartner.md similarity index 90% rename from skype/skype-ps/skype/Get-CsXmppAllowedPartner.md rename to skype/skype-ps/SkypeForBusiness/Get-CsXmppAllowedPartner.md index d842572c39..f5cd1ab27b 100644 --- a/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsXmppAllowedPartner.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsXmppAllowedPartner -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csxmppallowedpartner +schema: 2.0.0 +title: Get-CsXmppAllowedPartner --- # Get-CsXmppAllowedPartner @@ -46,7 +47,7 @@ To view information about your XMPP allowed partners in the Skype for Business S ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsXmppAllowedPartner ``` @@ -55,7 +56,7 @@ The command shown in Example 1 returns information about all the XMPP allowed pa -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsXmppAllowedPartner -Identity "xmpp.contoso.com" ``` @@ -64,7 +65,7 @@ In Example 2, information is returned for a single XMPP allowed partner: the par -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsXmppAllowedPartner - Filter "*.org" ``` @@ -73,7 +74,7 @@ Example 3 returns information for all the XMPP allowed partners that have an Ide -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsXmppAllowedPartner | Where-Object {$_.SaslNegotiation -eq "Required"} ``` @@ -86,14 +87,16 @@ The returned partners are then piped to the Where-Object cmdlet, which selects o ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to use wildcards when specifying the Identities of the XMPP allowed partner (or partners) to be returned. For example the filter value "*.org" returns a collection of all the XMPP allowed partners that have an Identity that ends with the string value ".org". ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -103,14 +106,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name (FQDN) of the XMPP allowed partner to be returned (for example, fabrikam.com). If neither this parameter nor the Filter parameter is specified, then all the XMPP partners configured for use in your organization are returned. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the XMPP allowed partner 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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -140,13 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsXmppAllowedPartner cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated The Get-CsXmppAllowedPartner cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsXmppGatewayConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsXmppGatewayConfiguration.md index 42d1978491..310783616d 100644 --- a/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsXmppGatewayConfiguration.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Get-CsXmppGatewayConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csxmppgatewayconfiguration +schema: 2.0.0 +title: Get-CsXmppGatewayConfiguration --- # Get-CsXmppGatewayConfiguration @@ -56,7 +57,7 @@ Skype for Business Server Control Panel: The functions carried out by the Get-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsXmppGatewayConfiguration ``` @@ -69,6 +70,9 @@ Because Skype for Business Server 2015 only allows for a single, global collecti ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to use wildcard values when referencing a collection of XMPP gateway configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings: @@ -80,8 +84,7 @@ That syntax brings back all the XMPP gateway configuration settings that have an ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -92,6 +95,8 @@ Accept wildcard characters: False ### -Identity +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the XMPP gateway configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsXmppGatewayConfiguration cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -103,8 +108,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -114,13 +118,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the XMPP gateway 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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -134,13 +140,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsXmppGatewayConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings The Get-CsXmppGatewayConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings object. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsArchivingPolicy.md similarity index 89% rename from skype/skype-ps/skype/Grant-CsArchivingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsArchivingPolicy.md index 195e225d06..80094620f3 100644 --- a/skype/skype-ps/skype/Grant-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsArchivingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsArchivingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csarchivingpolicy +schema: 2.0.0 +title: Grant-CsArchivingPolicy --- # Grant-CsArchivingPolicy @@ -53,7 +54,7 @@ The Grant-CsArchivingPolicy cmdlet is used to assign per-user archiving policies ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsArchivingPolicy -Identity "Ken Myer" -PolicyName RedmondArchivingPolicy @@ -64,7 +65,7 @@ Note that, with the Grant-CsArchivingPolicy cmdlet, the Identity property refers Instead, the policy to be assigned is specified by using the PolicyName parameter; the parameter value is the policy Identity (minus the "tag:" prefix). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -OU "OU=Redmond,dc=litwareinc,dc=com" | Grant-CsArchivingPolicy -PolicyName RedmondArchivingPolicy @@ -75,7 +76,7 @@ To do this, the Get-CsUser cmdlet and the OU parameter are used to return a coll This collection is then piped to the Grant-CsArchivingPolicy cmdlet, which assigns the policy RedmondArchivingPolicy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsArchivingPolicy -PolicyName RedmondArchivingPolicy @@ -86,7 +87,7 @@ To carry out this task, the Get-CsUser cmdlet is called along with the LdapFilte (In the LDAP query language, l, a lowercase L, is short for "locality", or city.) This collection is then piped to the Grant-CsArchivingPolicy cmdlet, which assigns the RedmondArchivingPolicy policy to each user in the collection. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Grant-CsArchivingPolicy -PolicyName RedmondArchivingPolicy @@ -97,7 +98,7 @@ To do this, the Get-CsUser cmdlet is first used to return all the users who have This collection is then piped to the Where-Object cmdlet, which selects only those users who have a RegistrarPool that is equal to atl-cs-001-litwareinc.com. This filtered collection is then piped to the Grant-CsArchivingPolicy cmdlet, which assigns the policy RedmondArchivingPolicy to each user in the collection. -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` Get-CsUser -Filter {ArchivingPolicy -eq "RedmondArchivingPolicy"} | Grant-CsArchivingPolicy -PolicyName "NorthAmericaArchivingPolicy" @@ -108,7 +109,7 @@ To perform this task, the Get-CsUser cmdlet is used to return a collection of al The filtered collection is then piped to the Grant-CsArchivingPolicy cmdlet, which assigns the policy NorthAmericaArchivingPolicy to each user in the collection. -### -------------------------- EXAMPLE 6 -------------------------- +### EXAMPLE 6 ``` Get-CsUser -Filter {ArchivingPolicy -eq "RedmondArchivingPolicy"} | Grant-CsArchivingPolicy -PolicyName $Null @@ -120,7 +121,29 @@ This time, however, the policy RedmondArchivingPolicy is unassigned from all the ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a domain controller to connect to when assigning the policy. +If this parameter is not included then the cmdlet will use the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the 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 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. @@ -131,8 +154,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -141,37 +163,19 @@ 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 scope designator "tag:". -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondArchivingPolicy has a PolicyName equal to RedmondArchivingPolicy. +### -PassThru -To remove a per-user policy that has been assigned to a user, set PolicyName to a null value: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-PolicyName $Null` +If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. +By default, the Grant-CsArchivingPolicy cmdlet does not pass objects through the pipeline. -```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: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Enables you to specify a domain controller to connect to when assigning the policy. -If this parameter is not included then the cmdlet will use the first available domain controller. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,34 +184,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -PolicyName -If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. -By default, the Grant-CsArchivingPolicy cmdlet does not pass objects through the pipeline. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the scope designator "tag:". +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondArchivingPolicy has a PolicyName equal to RedmondArchivingPolicy. +To remove a per-user policy that has been assigned to a user, set PolicyName to a null value: +`-PolicyName $Null` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -216,14 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -237,16 +249,19 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### String The Grant-CsArchivingPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.IM.ImArchivingPolicy The Grant-CsArchivingPolicy cmdlet does not return a value or object. Instead, the cmdlet assigns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.IM.ImArchivingPolicy object to users or groups of users. + +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsCallViaWorkPolicy.md similarity index 87% rename from skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsCallViaWorkPolicy.md index 5b5a65c2cf..e177f38495 100644 --- a/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsCallViaWorkPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsCallViaWorkPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cscallviaworkpolicy +schema: 2.0.0 +title: Grant-CsCallViaWorkPolicy --- # Grant-CsCallViaWorkPolicy @@ -29,7 +30,7 @@ This cmdlet assigns an existing per-user call via work policy to a user. Call vi ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) +### Example 1 (Skype for Business Server 2015) ``` Grant-CsCallViaWorkPolicy -Identity "Ken Myer" -PolicyName StandardUserCvW @@ -40,7 +41,29 @@ This example assigns the policy named "StandardUserCvW" to "Ken Myer". ## PARAMETERS +### -DomainController + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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-CsCallViaWorkPolicy cmdlet will contact the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies a unique identifier of the user account the policy should be assigned to. User identities can be specified by using one of four formats. @@ -58,8 +81,7 @@ For example, the Identity "\* Smith" grants the policy all users who have a disp ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -68,35 +90,17 @@ 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:"). -A policy that has an identity of "Tag:Redmond" has a PolicyName of "Redmond". -A policy with the identity "Tag:RedmondCalloutPolicy" has a PolicyName of "RedmondCalloutPolicy". -If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. -For example: `Grant-CsCallViaWorkPolicy -Identity "Ken Myer" -PolicyName $Null` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -PassThru -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsCallViaWorkPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,32 +109,39 @@ 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-CsCallViaWorkPolicy cmdlet will contact the first available domain controller. +### -PolicyName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the name of the policy to be assigned. +The PolicyName is the policy identity minus the policy scope ("tag:"). +A policy that has an identity of "Tag:Redmond" has a PolicyName of "Redmond". +A policy with the identity "Tag:RedmondCalloutPolicy" has a PolicyName of "RedmondCalloutPolicy". +If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. +For example: `Grant-CsCallViaWorkPolicy -Identity "Ken Myer" -PolicyName $Null` ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 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-CsCallViaWorkPolicy cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -160,13 +173,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsClientPolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsClientPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsClientPolicy.md index 5b614c56ca..6a417b1d7e 100644 --- a/skype/skype-ps/skype/Grant-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsClientPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csclientpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsClientPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csclientpolicy +schema: 2.0.0 +title: Grant-CsClientPolicy --- # Grant-CsClientPolicy @@ -45,14 +47,14 @@ In order to assign per-user policies to users, you must use the Grant-CsClientPo ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsClientPolicy -Identity "Ken Myer" -PolicyName SalesPolicy ``` In Example 1, the client policy SalesPolicy is assigned to the user with the Identity Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -LDAPFilter "Department=Sales" | Grant-CsClientPolicy -PolicyName SalesPolicy ``` @@ -61,7 +63,7 @@ In Example 2, all the users who belong to the Sales department are assigned the The command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who are members of the Sales department. This collection of users is then piped to the Grant-CsClientPolicy cmdlet, which assigns the policy SalesPolicy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LDAPFilter "(&(Title=Accountant)(l=Redmond))" | Grant-CsClientPolicy -PolicyName RedmondAccountingPolicy ``` @@ -73,7 +75,7 @@ The filter value "(&(Title=Accountant)(l=Redmond))" limits the returned data to The resulting collection is then piped to the Grant-CsClientPolicy cmdlet, which assigns the policy RedmondAccountingPolicy to each user in the collection. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -LdapFilter "(|(Title=Accountant)(Title=Senior Accountant))" | Grant-CsClientPolicy -PolicyName AccountingPolicy ``` @@ -83,7 +85,7 @@ To carry out this task, the Get-CsUser cmdlet and the LdapFilter parameter are u The filter value "(|(Title=Accountant)(Title=Senior Accountant))" limits the returned data to users with the job title Accountant (Title=Accountant) or (|) users with the job title Senior Accountant (Title=Senior Accountant). This filtered collection is then piped to the Grant-CsClientPolicy cmdlet, which assigns the client policy AccountingPolicy to each user in the collection. -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Grant-CsClientPolicy -PolicyName AtlantaBranchPolicy ``` @@ -94,7 +96,29 @@ This collection is then piped to the Grant-CsClientPolicy cmdlet, which assigns ## PARAMETERS +### -DomainController + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a domain controller to connect to when assigning the policy. +If this parameter is not included then the cmdlet will use the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the 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. @@ -105,8 +129,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter 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 +Aliases: Required: True Position: 1 @@ -115,71 +138,68 @@ 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 ("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. +### -PassThru -If you set PolicyName to a null value, then the command will unassign any per-user policy assigned to the user. -For example: +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`Grant-CsClientPolicy -Identity "Ken Myer" -PolicyName $Null` +If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. +By default, the Grant-CsClientPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: String +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 +Aliases: Required: False -Position: 2 +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 assigning the policy. -If this parameter is not included then the cmdlet will use the first available domain controller. +### -PolicyName -```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 +> 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 -``` +"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. -### -PassThru -If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. -By default, the Grant-CsClientPolicy cmdlet does not pass objects through the pipeline. +If you set PolicyName to a null value, then the command will unassign any per-user policy assigned to the user. +For example: + +`Grant-CsClientPolicy -Identity "Ken Myer" -PolicyName $Null` ```yaml -Type: SwitchParameter +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 +Aliases: Required: False -Position: Named +Position: 2 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. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose hybrid configuration 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` + +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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,13 +209,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -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 @@ -204,24 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose hybrid configuration settings are being returned. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return your tenant ID by running this command: +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`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. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -235,14 +249,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Grant-CsClientPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsClientPolicy cmdlet returns no objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. diff --git a/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsClientVersionPolicy.md similarity index 89% rename from skype/skype-ps/skype/Grant-CsClientVersionPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsClientVersionPolicy.md index f3c7b5346a..5ffeabb5c2 100644 --- a/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsClientVersionPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsClientVersionPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csclientversionpolicy +schema: 2.0.0 +title: Grant-CsClientVersionPolicy --- # Grant-CsClientVersionPolicy @@ -53,7 +54,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsClientVersionPolicy -Identity "Ken Myer" -PolicyName "RedmondClientVersionPolicy" @@ -62,7 +63,7 @@ Grant-CsClientVersionPolicy -Identity "Ken Myer" -PolicyName "RedmondClientVersi In Example 1, the client version policy RedmondClientVersionPolicy is assigned to user Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsClientVersionPolicy -PolicyName "RedmondClientVersionPolicy" @@ -73,7 +74,7 @@ To do this, the command first uses the Get-CsUser cmdlet and the LdapFilter para This collection is then piped to the Grant-CsClientVersionPolicy cmdlet, which assigns the specified policy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -OU "ou=Redmond,ou=North America,dc=litwareinc,dc=com" | Grant-CsClientVersionPolicy -PolicyName "RedmondClientVersionPolicy" @@ -84,7 +85,7 @@ To accomplish this task, the command first calls the Get-CsUser cmdlet and the O After the user accounts have been retrieved, the collection is piped to the Grant-CsClientVersionPolicy cmdlet, which assigns RedmondClientVersionPolicy to each of those users. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {VoicePolicy -eq "RedmondVoicePolicy"} | Grant-CsClientVersionPolicy -PolicyName "RedmondClientVersionPolicy" @@ -95,7 +96,7 @@ To do this, the command first calls the Get-CsUser cmdlet along with the Filter The resulting user accounts are then piped to the Grant-CsClientVersionPolicy cmdlet and assigned the client version policy RedmondClientVersionPolicy. -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` Get-CsUser | Grant-CsClientVersionPolicy -PolicyName $Null @@ -109,7 +110,31 @@ This is done by setting the parameter value of PolicyName to $null. ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a domain controller to connect to when assigning the policy. +If this parameter is not included, then the cmdlet will use the first available domain controller. + + + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the 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. @@ -120,8 +145,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -130,27 +154,10 @@ 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 ("tag:"). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondClientVersionPolicy has a PolicyName equal to RedmondClientVersionPolicy. -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - ### -PassThru +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. By default, the Grant-CsClientVersionPolicy cmdlet does not pass objects through the pipeline. @@ -159,8 +166,7 @@ By default, the Grant-CsClientVersionPolicy cmdlet does not pass objects through ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,30 +175,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PolicyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope ("tag:"). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondClientVersionPolicy has a PolicyName equal to RedmondClientVersionPolicy. +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -201,18 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController - -Enables you to specify a domain controller to connect to when assigning the policy. -If this parameter is not included, then the cmdlet will use the first available domain controller. +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -226,14 +237,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Grant-CsClientVersionPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsClientVersionPolicy cmdlet does not return objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. diff --git a/skype/skype-ps/skype/Grant-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsConferencingPolicy.md similarity index 83% rename from skype/skype-ps/skype/Grant-CsConferencingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsConferencingPolicy.md index 079b1f8b84..a66f45c8c0 100644 --- a/skype/skype-ps/skype/Grant-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsConferencingPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Grant-CsConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csconferencingpolicy +schema: 2.0.0 +title: Grant-CsConferencingPolicy --- # Grant-CsConferencingPolicy @@ -51,7 +53,7 @@ Instead, you must use the Grant-CsConferencingPolicy cmdlet to explicitly assign ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsConferencingPolicy -identity "Ken Myer" -PolicyName SalesConferencingPolicy ``` @@ -59,7 +61,7 @@ Grant-CsConferencingPolicy -identity "Ken Myer" -PolicyName SalesConferencingPol In Example 1, the Grant-CsConferencingPolicy cmdlet is used to assign the policy SalesConferencingPolicy to the user with the Identity "Ken Myer". -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -OU "ou=Finance,dc=litwareinc,dc=com" | Grant-CsConferencingPolicy -PolicyName FinanceConferencingPolicy ``` @@ -69,7 +71,7 @@ To assign the same policy to all the users in a given organizational unit (OU), After the user accounts have been retrieved, that information is then piped to the Grant-CsConferencingPolicy cmdlet, which assigns the FinanceConferencingPolicy policy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -OU "ou=Finance,dc=litwareinc,dc=com" | Grant-CsConferencingPolicy -PolicyName $Null ``` @@ -78,7 +80,7 @@ Example 3 represents a variation of Example 2: in this case, however, any per-us To do this, the command calls the Grant-CsConferencingPolicy cmdlet and specifies a null value ($Null) as the parameter value for the parameter PolicyName. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -LdapFilter "Department=Human Resources" | Grant-CsConferencingPolicy -PolicyName HRConferencingPolicy ``` @@ -90,7 +92,29 @@ After the user accounts have been retrieved, that collection is piped to the Gra ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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-CsConferencingPolicy cmdlet will contact the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -101,8 +125,7 @@ For example, the Identity "* Smith" returns all the users with a display name th ```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 +Aliases: Required: True Position: 1 @@ -111,68 +134,57 @@ 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:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. +### -PassThru -To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsConferencingPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: String +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 +Aliases: Required: False -Position: 2 +Position: Named 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-CsConferencingPolicy cmdlet will contact the first available domain controller. +### -PolicyName -```yaml -Type: Fqdn -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 +> 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 -``` +"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:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. -By default, the Grant-CsConferencingPolicy cmdlet does not pass objects through the pipeline. +To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. ```yaml -Type: SwitchParameter +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 +Aliases: Required: False -Position: Named +Position: 2 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. +### -Tenant + +> Applicable: Skype for Business Online + +{{Fill Tenant Description}} ```yaml -Type: SwitchParameter +Type: Guid 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 +Aliases: Required: False Position: Named @@ -182,13 +194,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -197,14 +211,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -{{Fill Tenant Description}} +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -218,30 +234,20 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String Grant-CsConferencingPolicy accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ### Microsoft.Rtc.Management.AD.UserIdParameter -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. -The Grant-CsConferencingPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. -The cmdlet also accepts pipelined input of user objects. - ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, Grant-CsConferencingPolicy returns no objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. -### System.Object - -### -By default, the Grant-CsConferencingPolicy cmdlet returns no objects or values. -However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. - ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Grant-CsDialPlan.md similarity index 85% rename from skype/skype-ps/skype/Grant-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsDialPlan.md index 17aa244dd3..2b5a420865 100644 --- a/skype/skype-ps/skype/Grant-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsDialPlan -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csdialplan +schema: 2.0.0 +title: Grant-CsDialPlan --- # Grant-CsDialPlan @@ -43,7 +44,7 @@ For example: ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsDialPlan -Identity "Ken Myer" -PolicyName RedmondDialPlan @@ -52,7 +53,7 @@ Grant-CsDialPlan -Identity "Ken Myer" -PolicyName RedmondDialPlan In the example, the Grant-CsDialPlan cmdlet is used to assign the dial plan RedmondDialPlan to the user with the Identity (in this case the display name) Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -LDAPFilter "l=Redmond" | Grant-CsDialPlan -PolicyName RedmondDialPlan @@ -65,7 +66,29 @@ To do this, the Get-CsUser cmdlet is invoked in order to retrieve a collection o ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (unique identifier) of the user to whom the dial plan is being assigned. 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). @@ -78,8 +101,7 @@ Full data type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -88,53 +110,55 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName +### -PassThru -The Identity value of the dial plan to be assigned to the user. -(Note that this includes only the name portion of the Identity. -Per-user dial plan identities include a prefix of tag: that should not be included with the PolicyName.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns the results of the command. +By default, this cmdlet does not generate any output. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -PolicyName -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity value of the dial plan to be assigned to the user. +(Note that this includes only the name portion of the Identity. +Per-user dial plan identities include a prefix of tag: that should not be included with the PolicyName.) ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Confirm -Returns the results of the command. -By default, this cmdlet does not generate any output. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -145,30 +169,14 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -182,15 +190,14 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of a user account to which the dial plan is being granted. ### Microsoft.Rtc.Management.AD.UserIdParameter ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact. ### System.Object diff --git a/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsExternalAccessPolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsExternalAccessPolicy.md index cee8b30442..4c23f36cd9 100644 --- a/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsExternalAccessPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Grant-CsExternalAccessPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csexternalaccesspolicy +schema: 2.0.0 +title: Grant-CsExternalAccessPolicy --- # Grant-CsExternalAccessPolicy @@ -77,14 +79,14 @@ That's because the settings in the per-user policy take precedence. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` 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 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsExternalAccessPolicy -PolicyName RedmondAccessPolicy ``` @@ -93,7 +95,7 @@ The command shown in Example 2 assigns the external access policy RedmondAccessP To do this, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who work in Redmond; the filter value "l=Redmond" limits returned data to those users who work in the city of Redmond (the l in the filter, a lowercase L, represents the locality). That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy RedmondAccessPolicy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LdapFilter "Title=Sales Representative" | Grant-CsExternalAccessPolicy -PolicyName SalesAccessPolicy ``` @@ -102,7 +104,7 @@ In Example 3, all the users who have the job title "Sales Representative" are as To perform this task, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the Sales Representatives; the filter value "Title=Sales Representative" restricts the returned collection to users who have the job title "Sales Representative". This filtered collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy SalesAccessPolicy to each user in the collection. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {ExternalAccessPolicy -eq $Null} | Grant-CsExternalAccessPolicy -PolicyName BasicAccessPolicy ``` @@ -111,7 +113,7 @@ The command shown in Example 4 assigns the external access policy BasicAccessPol (That is, users currently being governed by a site policy or by the global policy.) To do this, the Get-CsUser cmdlet and the Filter parameter are used to return the appropriate set of users; the filter value {ExternalAccessPolicy -eq $Null} limits the returned data to user accounts where the ExternalAccessPolicy property is equal to (-eq) a null value ($Null). By definition, ExternalAccessPolicy will be null only if users have not been assigned a per-user policy. -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` Get-CsUser -OU "ou=US,dc=litwareinc,dc=com" | Grant-CsExternalAccessPolicy -PolicyName USAccessPolicy ``` @@ -120,7 +122,7 @@ Example 5 assigns the external access policy USAccessPolicy to all the users who The command starts off by calling the Get-CsUser cmdlet and the OU parameter; the parameter value "ou=US,dc=litwareinc,dc=com" limits the returned data to user accounts found in the US OU. The returned collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy USAccessPolicy to each user in the collection. -### -------------------------- EXAMPLE 6 -------------------------- +### EXAMPLE 6 ``` Get-CsUser | Grant-CsExternalAccessPolicy -PolicyName $Null ``` @@ -131,73 +133,89 @@ That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which ## 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. +### -DomainController -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." +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: 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 +Type: Fqdn +Parameter Sets: (All) +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondAccessPolicy has a PolicyName equal to RedmondAccessPolicy. +### -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". -To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. +```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: (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 +Parameter Sets: GrantToGroup +Aliases: -Required: False -Position: 2 +Required: True +Position: 0 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. +### -Identity + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: 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 +Type: UserIdParameter +Parameter Sets: GrantToUser +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +Aliases: Required: False Position: Named @@ -206,32 +224,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PolicyName + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +"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: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -239,13 +262,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -254,46 +279,37 @@ 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. +### -Confirm + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True +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. +### -WhatIf -```yaml -Type: String -Parameter Sets: GrantToGroup -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: 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". +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: +Parameter Sets: (All) +Aliases: wi -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -304,30 +320,21 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String Grant-CsExternalAccessPolicy accepts pipelined input of string values representing the Identity of a user account. -The cmdlet also accepts pipelined input of user objects. ### Microsoft.Rtc.Management.AD.UserIdParameter +The cmdlet also accepts pipelined input of user objects. -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. -The Grant-CsExternalAccessPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact 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. -### System.Object - -### -By default, the Grant-CsExternalAccessPolicy cmdlet 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 diff --git a/skype/skype-ps/skype/Grant-CsGraphPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsGraphPolicy.md similarity index 91% rename from skype/skype-ps/skype/Grant-CsGraphPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsGraphPolicy.md index d1c384d7e3..5f4eff9801 100644 --- a/skype/skype-ps/skype/Grant-CsGraphPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsGraphPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csgraphpolicy applicable: Lync Server 2010 -title: Grant-CsGraphPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csgraphpolicy +schema: 2.0.0 +title: Grant-CsGraphPolicy --- # Grant-CsGraphPolicy @@ -41,7 +43,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Grant-CsGraphPolicy -PolicyName "GraphDisabled" -Identity Ken.Myer ``` @@ -51,54 +53,53 @@ This example grants the "GraphDisabled" policy to Ken Myer. ## PARAMETERS -### -PolicyName -Specifies the name of the graph policy to grant to the tenant or user. -The two options are: +### -DomainController -Graph Enabled: Granting this policy will enable the pre-loading content or files that are attached to an Outlook meeting invitation into a Microsoft Teams or Skype for Business Online meeting. -For example, `Grant-CsGraphPolicy -PolicyName "Graph Enabled"`. +> Applicable: Microsoft Teams -Graph Disabled: Granting this policy will disable the pre-loading of content, files or attachments attached to an Outlook meeting invitation into a Microsoft Teams or Skype for Business Online meeting. -For example, `Grant-CsGraphPolicy -PolicyName "Graph Disabled"`. +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: String +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: Required: False -Position: 2 +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. +### -Identity + +> Applicable: Microsoft Teams + +Specifies the identity of the user who will be granted the graph policy. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 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. +### -PassThru + +> Applicable: Microsoft Teams + +Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -107,30 +108,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the identity of the user who will be granted the graph policy. +### -PolicyName + +> Applicable: Microsoft Teams + +Specifies the name of the graph policy to grant to the tenant or user. +The two options are: + +Graph Enabled: Granting this policy will enable the pre-loading content or files that are attached to an Outlook meeting invitation into a Microsoft Teams or Skype for Business Online meeting. +For example, `Grant-CsGraphPolicy -PolicyName "Graph Enabled"`. + +Graph Disabled: Granting this policy will disable the pre-loading of content, files or attachments attached to an Outlook meeting invitation into a Microsoft Teams or Skype for Business Online meeting. +For example, `Grant-CsGraphPolicy -PolicyName "Graph Disabled"`. ```yaml -Type: UserIdParameter +Type: String Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: Required: False -Position: 1 +Position: 2 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. +### -Tenant + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -139,14 +151,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -156,6 +170,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -163,7 +180,6 @@ 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 Required: False Position: Named @@ -177,12 +193,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### System.String The Grant-CsGraphPolicy cmdlet accepts a pipelined string value representing the Identity of a user account to which the graph policy is being granted. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact The Grant-CsGraphPolicy cmdlet returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact when used with the PassThru parameter. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsHostedVoicemailPolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsHostedVoicemailPolicy.md index 9fe8d50ae6..82cb8b3da0 100644 --- a/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsHostedVoicemailPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsHostedVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cshostedvoicemailpolicy +schema: 2.0.0 +title: Grant-CsHostedVoicemailPolicy --- # Grant-CsHostedVoicemailPolicy @@ -40,7 +42,7 @@ If you assign to a user a hosted voice mail policy that does not include a desti ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsHostedVoicemailPolicy -Identity "Ken Myer" -PolicyName ExRedmond ``` @@ -48,7 +50,7 @@ Grant-CsHostedVoicemailPolicy -Identity "Ken Myer" -PolicyName ExRedmond This example assigns the hosted voice mail policy with the Identity ExRedmond to the user with the display name Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com" | Grant-CsHostedVoicemailPolicy -PolicyName ExRedmond ``` @@ -60,7 +62,29 @@ This collection of users is then piped to the Grant-CsHostedVoicemailPolicy cmdl ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (unique identifier) of the user to whom the hosted voice mail policy is being assigned. 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). @@ -73,8 +97,7 @@ Full data type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -83,33 +106,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName -The name (Identity) of the hosted voice mail policy to be assigned to the user. -(Note that this includes only the name portion of the Identity. -Per-user hosted voice mail policy identities include a prefix of tag: that should not be included with the PolicyName.) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PassThru -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +Returns the results of the command. +By default, this cmdlet does not generate any output. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,31 +125,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns the results of the command. -By default, this cmdlet does not generate any output. +### -PolicyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name (Identity) of the hosted voice mail policy to be assigned to the user. +(Note that this includes only the name portion of the Identity. +Per-user hosted voice mail policy identities include a prefix of tag: that should not be included with the PolicyName.) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -151,14 +163,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -172,15 +186,14 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of a user account to which the hosted voice mail policy is being granted. ### Microsoft.Rtc.Management.AD.UserIdParameter ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact. ### System.Object diff --git a/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsIPPhonePolicy.md similarity index 88% rename from skype/skype-ps/skype/Grant-CsIPPhonePolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsIPPhonePolicy.md index 0bc1ea6d26..443226329b 100644 --- a/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsIPPhonePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csipphonepolicy applicable: Skype for Business Server 2019 -title: Grant-CsIPPhonePolicy, Skype for Business Server 2019 -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csipphonepolicy +schema: 2.0.0 +title: Grant-CsIPPhonePolicy, Skype for Business Server 2019 --- # Grant-CsIPPhonePolicy @@ -37,7 +39,7 @@ IP phone policies are applied each time a user accesses the system, regardless o ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName SkypePolicy ``` @@ -45,7 +47,7 @@ Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName SkypePolicy This example assigns the IP phone policy "SkypePolicy" to the user with the identity "Ken Myer". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser -LDAPFilter "Department=Sales" | Grant-CsIPPhonePolicy -PolicyName SalesPolicy ``` @@ -57,50 +59,16 @@ This collection of users is piped to the Grant-CsIPPhonePolicy cmdlet, which ass ## PARAMETERS -### -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 the identity "tag:Redmond" has a PolicyName equal to "Redmond". -If you set PolicyName to a null value, then the command will unassign any per-user policy assigned to the user. -For example: `Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName $Null` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams, Skype for Business Server 2019 - -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. +### -DomainController -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams, Skype for Business Server 2019 +> Applicable: Microsoft Teams, Skype for Business Server 2019 -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 Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +78,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + Specifies the identity of the target user. Acceptable values include: @@ -122,8 +93,7 @@ Example: 98403f08-577c-46dd-851a-f0460a13b03d ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -133,14 +103,16 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + Including this switch enables you to pass a user object through the pipeline that represents the user account being assigned the voice routing policy. By default, the Grant-CsIPPhonePolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,14 +121,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyName + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + +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 the identity "tag:Redmond" has a PolicyName equal to "Redmond". +If you set PolicyName to a null value, then the command will unassign any per-user policy assigned to the user. +For example: `Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName $Null` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -166,6 +180,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + 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. @@ -173,7 +190,6 @@ 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 Server 2019 Required: False Position: Named @@ -187,12 +203,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The Grant-CsIPPhonePolicy cmdlet accepts pipelined input of Microsoft.Rtc.Management.ADConnect.Schema.ADUser objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsIPPhonePolicy cmdlet returns no objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. diff --git a/skype/skype-ps/skype/Grant-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsLocationPolicy.md similarity index 88% rename from skype/skype-ps/skype/Grant-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsLocationPolicy.md index 6ea4f48cc5..408f04ad56 100644 --- a/skype/skype-ps/skype/Grant-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cslocationpolicy +schema: 2.0.0 +title: Grant-CsLocationPolicy --- # Grant-CsLocationPolicy @@ -47,7 +48,7 @@ If the user calls from a location that is unknown or unmapped in the organizatio ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsLocationPolicy -Identity "Ken Myer" -PolicyName Reno @@ -56,7 +57,7 @@ Grant-CsLocationPolicy -Identity "Ken Myer" -PolicyName Reno In Example 1, the Grant-CsLocationPolicy cmdlet is used to assign the Reno location policy to user Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -LDAPFilter "Department=Accounting" | Grant-CsLocationPolicy -PolicyName AccountingArea @@ -68,7 +69,7 @@ The query value passed to LDAPFilter--"Department=Accounting"--returns all the u This collection is then passed to the Grant-CsLocationPolicy cmdlet, which proceeds to assign the AccountingArea policy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Grant-CsLocationPolicy -Identity "Ken Myer" -PolicyName Reno -PassThru | Select-Object DisplayName, LocationPolicy @@ -84,7 +85,29 @@ One thing to notice with this example is that the newly granted location policy ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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'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). Note that the SAMAccountName cannot be used as an identity. @@ -95,8 +118,7 @@ For example, the Identity "* Smith" would grant the policy to all the users with ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -105,32 +127,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PassThru -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,13 +147,15 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity of the location policy to apply to the user. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -155,14 +164,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -171,14 +182,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -192,13 +205,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of a user account to which the location policy is being granted. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsMobilityPolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsMobilityPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsMobilityPolicy.md index a6b4002ac5..b6fb757e37 100644 --- a/skype/skype-ps/skype/Grant-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsMobilityPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csmobilitypolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsMobilityPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csmobilitypolicy +schema: 2.0.0 +title: Grant-CsMobilityPolicy --- # Grant-CsMobilityPolicy @@ -36,7 +38,7 @@ Users who have been enabled for Call via Work can achieve this either by dialing With dial-out conferencing, a user effectively asks the Mobility Service server to make a call for them. The server will set up the call, and then call the user back on their mobile phone. After the user has answered, the server will then dial the party being called. -Both of these capabilities can be managed by using mobility policies. +Both of these capabilities can be managed by using mobility policies. With Microsoft Teams or Skype for Business Server, mobile devices can make or receive phone calls by using either the standard cellular phone network. or by using Wi-Fi connections. @@ -67,7 +69,7 @@ Who can run this cmdlet: By default, members of the following groups are authori ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsMobilityPolicy -Identity "Ken Myer" -PolicyName "RedmondMobilityPolicy" ``` @@ -75,7 +77,7 @@ Grant-CsMobilityPolicy -Identity "Ken Myer" -PolicyName "RedmondMobilityPolicy" The command shown in Example 1 assigns the per-user mobility policy RedmondMobilityPolicy to a single user: Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -Filter {MobilityPolicy -eq "NorthAmericaMobilityPolicy"} | Grant-CsMobilityPolicy -PolicyName "RedmondMobilityPolicy" ``` @@ -85,7 +87,7 @@ To do this, the command first uses the Get-CsUser cmdlet and the Filter paramete After retrieving the collection of user accounts, those accounts are then piped to the Grant-CsMobilityPolicy cmdlet, which assigns each user the policy RedmondMobilityPolicy. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsMobilityPolicy -PolicyName "RedmondMobilityPolicy" ``` @@ -95,7 +97,7 @@ To perform this task, the command first calls the Get-CsUser cmdlet along with t (The "l" represents the Active Directory attribute "locality".) After the user accounts have been retrieved, those accounts are piped to the Grant-CsMobilityPolicy cmdlet; in turn, the Grant-CsMobilityPolicy cmdlet assigns each user the policy RedmondMobilityPolicy. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Grant-CsMobilityPolicy -PolicyName "RedmondMobilityPolicy" ``` @@ -107,35 +109,17 @@ After retrieving the collection of user accounts, those accounts are then piped ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user mobility policy. -User Identities are typically 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 specified by using the user's Active Directory distinguished name. - -In addition, you can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" will assign the policy to all the users who have a display name that ends with the string value " Smith". - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -DomainController -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +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-CsMobilityPolicy cmdlet will contact the first available domain controller. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,32 +128,40 @@ 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-CsMobilityPolicy cmdlet will contact the first available domain controller. +### -Identity + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be assigned the per-user mobility policy. +User Identities are typically 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 specified by using the user's Active Directory distinguished name. + +In addition, you can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" will assign the policy to all the users who have a display name that ends with the string value " Smith". ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsMobilityPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +171,9 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + "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:RedmondUsersMobilityPolicy has a PolicyName equal to RedmondUsersMobilityPolicy. @@ -193,8 +188,7 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -203,14 +197,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -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 +``` + +### -Confirm + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -219,13 +230,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -{{Fill Tenant Description}} +### -WhatIf + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -239,28 +253,19 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### System.String Grant-CsMobilityPolicy accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ### Microsoft.Rtc.Management.AD.UserIdParameter - -### -The Grant-CsMobilityPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, Grant-CsMobilityPolicy does not return any objects or values. However, if you include the PassThru parameter, the cmdlet will be able to pipeline instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. -### System.Object - -### -By default, the Grant-CsMobilityPolicy cmdlet does not return any objects or values. -However, if you include the PassThru parameter, the cmdlet will be able to pipeline instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. - ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsOUPermission.md b/skype/skype-ps/SkypeForBusiness/Grant-CsOUPermission.md similarity index 84% rename from skype/skype-ps/skype/Grant-CsOUPermission.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsOUPermission.md index 222046671f..7dc547d5e1 100644 --- a/skype/skype-ps/skype/Grant-CsOUPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsOUPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csoupermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsOUPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csoupermission +schema: 2.0.0 +title: Grant-CsOUPermission --- # Grant-CsOUPermission @@ -42,7 +43,7 @@ In that case, you will need to be an enterprise administrator or a domain admini ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user" @@ -51,7 +52,7 @@ Grant-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user" The command shown in Example 1 grants user management rights (-ObjectType "user") to the Redmond OU in the domain litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Grant-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user","contact","inetOrgPerson" @@ -60,7 +61,7 @@ Grant-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user","c In Example 2, management rights are granted for three different objects (user, contact, inetOrgPerson) for the Redmond OU in the domain litwareinc.com. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = "ou=Redmond,dc=litwareinc,dc=com", "ou=Dublin,dc=litwareinc,dc=com", "ou=Tokyo,dc=litwareinc,dc=com" @@ -76,77 +77,58 @@ In turn, that command grants user management rights for each OU in the array. ## PARAMETERS -### -ObjectType - -Type of object covered by these rights. -Valid values are: - -User - -Computer - -Contact - -AppContact +### -Domain -InetOrgPerson +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Device (required for creating common area phones) - -To assign multiple object types in the same command, separate the object types by using commas: `-ObjectType "user","computer","contact".` -Note, however, that you can only specify a maximum of three object types per command. +Name of the domain where the OU is located. +If this parameter is not included, then the Grant-CsOUPermission cmdlet will look for the OU on the current domain. ```yaml -Type: ObjectType +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OU - -Distinguished name of the OU where rights are to be granted. -For example: +### -DomainController -`-OU "ou=Redmond,dc=litwareinc,dc=com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you can only grant rights to a single OU per command. +Enables administrators to specify the fully qualified domain name (FQDN) of the domain controller to be used when running the Grant-CsOUPermission cmdlet. +If not specified, the cmdlet will use the first available domain controller. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Domain - -Name of the domain where the OU is located. -If this parameter is not included, then the Grant-CsOUPermission cmdlet will look for the OU on the current domain. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,18 +137,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -GlobalCatalog -Enables administrators to specify the fully qualified domain name (FQDN) of the domain controller to be used when running the Grant-CsOUPermission cmdlet. -If not specified, the cmdlet will use the first available domain controller. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a global catalog server in your domain. +This parameter is not required if you are running the Grant-CsOUPermission cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,36 +158,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog +### -ObjectType -FQDN of a global catalog server in your domain. -This parameter is not required if you are running the Grant-CsOUPermission cmdlet on a computer with an account in your domain. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of object covered by these rights. +Valid values are: + +User + +Computer + +Contact + +AppContact + +InetOrgPerson + +Device (required for creating common area phones) + +To assign multiple object types in the same command, separate the object types by using commas: `-ObjectType "user","computer","contact".` +Note, however, that you can only specify a maximum of three object types per command. ```yaml -Type: Fqdn +Type: ObjectType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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 occur when running the command. +### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Distinguished name of the OU where rights are to be granted. +For example: + +`-OU "ou=Redmond,dc=litwareinc,dc=com"` + +Note that you can only grant rights to a single OU per command. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -213,6 +221,8 @@ Accept wildcard characters: False ### -Report +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -223,8 +233,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -233,14 +242,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -249,14 +260,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -270,13 +283,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Grant-CsOUPermission cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Grant-CsOUPermission cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsPersistentChatPolicy.md similarity index 91% rename from skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsPersistentChatPolicy.md index 2802ff6d76..c01595ad38 100644 --- a/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsPersistentChatPolicy.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Grant-CsPersistentChatPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cspersistentchatpolicy +schema: 2.0.0 +title: Grant-CsPersistentChatPolicy --- # Grant-CsPersistentChatPolicy @@ -45,7 +46,7 @@ In the Edit Lync Server User dialog box, select a policy from the Persistent Cha ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Grant-CsPersistentChatPolicy -Identity "Ken Myer" -PolicyName "RedmondUsersPersistentChatPolicy" @@ -54,7 +55,7 @@ Grant-CsPersistentChatPolicy -Identity "Ken Myer" -PolicyName "RedmondUsersPersi The command shown in Example 1 assigns the per-user policy RedmondUsersPersistentChatPolicy to the user with the Active Directory display name "Ken Myer". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser -LdapFilter "Department=IT" | Grant-CsPersistentChatPolicy -PolicyName "RedmondUsersPersistentChatPolicy" @@ -65,7 +66,7 @@ To do this, the command first calls the Get-CsUser cmdlet along with the LdapFil That collection of users is then piped to the Grant-CsPersistentChatPolicy cmdlet, which assigns the policy RedmondUsersPersistentChatPolicy to each user in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -Filter {PersistentChatPolicy -eq $Null} | Grant-CsPersistentChatPolicy -PolicyName "RedmondUsersPersistentChatPolicy" @@ -76,7 +77,7 @@ To carry out this task, the command first employs the Get-CsUser cmdlet and the That collection of users is then piped to the Grant-CsPersistentChatPolicy cmdlet, which assigns each user in the collection the policy RedmondUsersPersistentChatPolicy. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUser -Filter {PersistentChatPolicy -eq "RedmondUsersPersistentChatPolicy"} | Grant-CsPersistentChatPolicy -PolicyName $Null @@ -91,35 +92,19 @@ After the per-user policy has been unassigned, users will have their Persistent ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user Persistent Chat policy. -User Identities are typically 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 (four example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -User Identities can also be specified by using the user's Active Directory distinguished name. +### -DomainController -In addition, 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". +> Applicable: Lync Server 2013, Skype for Business Server 2015 -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Enables you to specify the fully qualified domain name of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified then the Grant-CsPersistentChatPolicy cmdlet will contact the first available domain controller. -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` -### -Confirm -Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -128,35 +113,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -Identity -Enables you to specify the fully qualified domain name of a domain controller to be contacted when assigning the new policy. -If this parameter is not specified then the Grant-CsPersistentChatPolicy cmdlet will contact the first available domain controller. +> Applicable: Lync Server 2013, Skype for Business Server 2015 +Indicates the Identity of the user account to be assigned the per-user Persistent Chat policy. +User Identities are typically 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 (four example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be specified by using the user's Active Directory distinguished name. +In addition, 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: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsPersistentChatPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -166,6 +156,9 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + "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:RedmondUsersPersistentChatPolicy has a PolicyName equal to RedmondUsersPersistentChatPolicy. @@ -174,8 +167,7 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -184,14 +176,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +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 +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -205,14 +217,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. +### System.String The Grant-CsPersistentChatPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsPersistentChatPolicy cmdlet does not return an objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact. diff --git a/skype/skype-ps/skype/Grant-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsPinPolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsPinPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsPinPolicy.md index 7abc34da1c..1023e41e3c 100644 --- a/skype/skype-ps/skype/Grant-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsPinPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsPinPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cspinpolicy +schema: 2.0.0 +title: Grant-CsPinPolicy --- # Grant-CsPinPolicy @@ -41,7 +42,7 @@ In order to assign a per-user policy you must use the Grant-CsPinPolicy cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsPinPolicy -Identity "kenmyer@litwareinc.com" -PolicyName RedmondUsersPinPolicy @@ -50,7 +51,7 @@ Grant-CsPinPolicy -Identity "kenmyer@litwareinc.com" -PolicyName RedmondUsersPin The command shown in Example 1 assigns the policy RedmondUsersPinPolicy to the user kenmyer@litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Grant-CsPinPolicy -Identity kenmyer@litwareinc.com -PolicyName $Null @@ -60,7 +61,7 @@ Example 2 unassigns any per-user PIN policy previously assigned to the user kenm Calling the Grant-CsPinPolicy cmdlet and setting the policy name to a null value ($Null) removes any per-user policy assigned to the user. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsPinPolicy -PolicyName RedmondUsersPinPolicy @@ -71,7 +72,7 @@ In Example 3, the policy RedmondUsersPinPolicy is assigned to all the users who To do this, the Get-CsUser cmdlet first retrieves a collection of all the users who work in Redmond; this is done by including the LdapFilter parameter and using the filter value "l=Redmond". (With LDAP filters, l, a lowercase L, represents the user's locality.) That collection of users is then piped to the Grant-CsPinPolicy cmdlet, which assigns each user the policy RedmondUsersPinPolicy. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {PinPolicy -eq $Null} | Grant-CsPinPolicy -PolicyName RedmondUsersPinPolicy @@ -84,7 +85,31 @@ That collection of users is then piped to the Grant-CsPinPolicy cmdlet, which as ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the fully qualified domain name of a domain (FQDN) controller to be contacted when assigning the new policy. +If this parameter is not specified then the Grant-CsPinPolicy cmdlet will contact the first available domain controller. + + + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be assigned the per-user PIN policy. 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 (four example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be specified by using the user's Active Directory distinguished name. @@ -95,8 +120,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -105,57 +129,58 @@ 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:RedmondUsersPinPolicy has a PolicyName equal to RedmondUsersPinPolicy. -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +### -PassThru +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsPinPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -PolicyName -Enables you to specify the fully qualified domain name of a domain (FQDN) controller to be contacted when assigning the new policy. -If this parameter is not specified then the Grant-CsPinPolicy cmdlet will contact the first available domain controller. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +"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:RedmondUsersPinPolicy has a PolicyName equal to RedmondUsersPinPolicy. +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 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-CsPinPolicy cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -165,29 +190,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -201,15 +212,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.UserPinService.PinInfoDetails object. +### System.String The Grant-CsPinPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.UserPinService.PinInfoDetails The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### -By default, the Grant-CsPinPolicy cmdlet does not return a value or object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsPresencePolicy.md similarity index 88% rename from skype/skype-ps/skype/Grant-CsPresencePolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsPresencePolicy.md index 0b4f666350..de73bc50c6 100644 --- a/skype/skype-ps/skype/Grant-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsPresencePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsPresencePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cspresencepolicy +schema: 2.0.0 +title: Grant-CsPresencePolicy --- # Grant-CsPresencePolicy @@ -52,7 +53,7 @@ Instead, per-user presence policies must be explicitly assigned to users (or gro ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsPresencePolicy -Identity "Ken Myer" -PolicyName "RedmondPresencePolicy" @@ -61,7 +62,7 @@ Grant-CsPresencePolicy -Identity "Ken Myer" -PolicyName "RedmondPresencePolicy" The command shown in Example 1 assigns the per-user presence policy RedmondPresencePolicy to a single user: the user with the Identity Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -OU "OU=Redmond,dc=litwareinc,dc=com" | Grant-CsPresencePolicy -PolicyName "RedmondPresencePolicy" @@ -72,7 +73,7 @@ To do this, the command first uses the Get-CsUser cmdlet and the OU parameter to This collection is then piped to the Grant-CsPresencePolicy cmdlet, which assigns the policy RedmondPresencePolicy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsPresencePolicy -PolicyName "RedmondPresencePolicy" @@ -83,7 +84,7 @@ To carry out this task, the command first uses the Get-CsUser cmdlet and the Lda (In the LDAP query language, l, the lowercase L, is short for "locality.") The retrieved collection is then piped to the Grant-CsPresencePolicy cmdlet, which assigns the policy RedmondPresencePolicy to each user in the collection. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsPresencePolicy -PolicyName $Null @@ -95,7 +96,35 @@ Calling the Grant-CsPresencePolicy cmdlet while setting the PolicyName parameter ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified name of the domain (FQDN) controller to be contacted when assigning the policy. +For example: + +`-DomainController atl-dc-001.litwareinc.com` + +If not specified, the Grant-CsPresencePolicy cmdlet will contact the nearest available domain controller when assigning the policy. + + + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be assigned the presence policy. 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 specified by using the user's Active Directory distinguished name. @@ -106,8 +135,7 @@ For example, the Identity "* Smith" returns all the users with display name that ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -116,63 +144,60 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName - -Identity of the per-user policy to be assigned; for example: - -`-PolicyName "RedmondPresencePolicy"` - -The PolicyName is the Identity of the policy minus the "tag:" prefix. -For example, a policy with the Identity "tag:NorthAmericaPresencePolicy" has a PolicyName equal to "NorthAmericaPresencePolicy". +### -PassThru +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsPresencePolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -PolicyName -Fully qualified name of the domain (FQDN) controller to be contacted when assigning the policy. -For example: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-DomainController atl-dc-001.litwareinc.com` +Identity of the per-user policy to be assigned; for example: -If not specified, the Grant-CsPresencePolicy cmdlet will contact the nearest available domain controller when assigning the policy. +`-PolicyName "RedmondPresencePolicy"` + +The PolicyName is the Identity of the policy minus the "tag:" prefix. +For example, a policy with the Identity "tag:NorthAmericaPresencePolicy" has a PolicyName equal to "NorthAmericaPresencePolicy". ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 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-CsPresencePolicy cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -182,29 +207,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -218,14 +229,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.WritebleConfig.Policy.Presence.PresencePolicy object. +### System.String The Grant-CsPresencePolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.WritebleConfig.Policy.Presence.PresencePolicy The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsPresencePolicy cmdlet does not return an objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact. diff --git a/skype/skype-ps/skype/Grant-CsSetupPermission.md b/skype/skype-ps/SkypeForBusiness/Grant-CsSetupPermission.md similarity index 83% rename from skype/skype-ps/skype/Grant-CsSetupPermission.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsSetupPermission.md index 7884f28095..2462c8078c 100644 --- a/skype/skype-ps/skype/Grant-CsSetupPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsSetupPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cssetuppermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsSetupPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cssetuppermission +schema: 2.0.0 +title: Grant-CsSetupPermission --- # Grant-CsSetupPermission @@ -39,7 +40,7 @@ Keep in mind that this cmdlet only grants permissions to the RTCUniversalServerA ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsSetupPermission -ComputerOU "ou=CsServers,dc=litwareinc,dc=com" @@ -52,6 +53,8 @@ The command shown in Example 1 grants setup permissions for the CsServers OU in ### -ComputerOU +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name of the OU containing the accounts for the computers where Skype for Business Server will be (or has been) installed. For example: "ou=CsServers,dc=litwareinc,dc=com". @@ -65,8 +68,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +79,8 @@ Accept wildcard characters: False ### -Domain +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the domain where the OU is located. If this parameter is not included, then the Grant-CsSetupPermission cmdlet will look for the OU in the current domain. @@ -85,8 +89,7 @@ If this parameter is not included, then the Grant-CsSetupPermission cmdlet will ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +100,8 @@ Accept wildcard characters: False ### -DomainController +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified name of the domain controller to be contacted when assigning the policy. For example: @@ -109,8 +114,7 @@ If not specified, the Grant-CsSetupPermission cmdlet will contact the nearest av ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,22 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog - -Fully qualified name of the global catalog server to be contacted when assigning the policy. -For example: - -`-GlobalCatalog atl-dc-001.litwareinc.com` - -If not specified, the Grant-CsSetupPermission cmdlet will contact the nearest available global catalog server when assigning the policy. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,14 +141,23 @@ 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. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified name of the global catalog server to be contacted when assigning the policy. +For example: + +`-GlobalCatalog atl-dc-001.litwareinc.com` + +If not specified, the Grant-CsSetupPermission cmdlet will contact the nearest available global catalog server when assigning the policy. + + ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +168,8 @@ Accept wildcard characters: False ### -Report +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -171,8 +180,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,14 +189,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -197,14 +207,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -218,15 +230,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Grant-CsSetupPermission cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None The Grant-CsSetupPermission cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsTeamsUpgradePolicy.md similarity index 94% rename from skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsTeamsUpgradePolicy.md index 49be661490..6372ed2925 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsTeamsUpgradePolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2019, Skype for Business Server 2015 -title: Grant-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csteamsupgradepolicy +schema: 2.0.0 +title: Grant-CsTeamsUpgradePolicy --- # Grant-CsTeamsUpgradePolicy @@ -39,11 +41,11 @@ Grant-CsTeamsUpgradePolicy [-MigrateMeetingsToTeams ] [-PassThru] [[-Po ## 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. +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. +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](/powershell/module/skype/start-csexmeetingmigration). +**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in later versions of the module. Tenants must run Start-CsExMeetingMigration. See [Start-CsExMeetingMigrationService](/powershell/module/skypeforbusiness/start-csexmeetingmigration). Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are as follows: @@ -66,20 +68,20 @@ Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built- > [!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. -> +> - 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. -> +> +> - 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). @@ -102,7 +104,7 @@ The `Grant-CsTeamsUpgradePolicy` cmdlet checks the configuration of the correspo 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. +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 @@ -110,9 +112,9 @@ The above cmdlet assigns the "UpgradeToTeams" policy to user Mike@contoso.com. 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. +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 +### Example 3: Grant Policy to the entire tenant ```powershell PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName SfBOnly -Global @@ -165,32 +167,33 @@ After running these lines will create an HTML file on the Desktop of the curre ## PARAMETERS -### -Identity - -The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. +### -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: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName +### -Global -The name of the policy instance. +> Applicable: Skype for Business Online + +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +Aliases: Required: False Position: 1 @@ -199,49 +202,46 @@ 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. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Type: String +Parameter Sets: GrantToGroup +Aliases: -Required: False -Position: 1 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Identity -Prompts you for confirmation before running the cmdlet. +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +Type: UserIdParameter +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Tenant - -Do not use. +### -MigrateMeetingsToTeams +Not supported anymore, see the Description section. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -250,14 +250,14 @@ 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. +### -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: GrantToTenant +Parameter Sets: (All) Aliases: Required: False @@ -267,27 +267,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName + +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +The name of the policy instance. ```yaml -Type: String -Parameter Sets: GrantToGroup +Type: Object +Parameter Sets: (All) Aliases: -Required: True -Position: Named +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateMeetingsToTeams -Not supported anymore, see the Description section. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -297,13 +300,14 @@ 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. +### -Tenant -By default, the cmdlet does not pass objects through the pipeline. +> Applicable: Skype for Business Online + +Do not use. ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) Aliases: @@ -314,13 +318,16 @@ 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. +### -Confirm + +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named diff --git a/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsThirdPartyVideoSystemPolicy.md similarity index 90% rename from skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsThirdPartyVideoSystemPolicy.md index c5066205d9..e17c24a9c7 100644 --- a/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsThirdPartyVideoSystemPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsThirdPartyVideoSystemPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csthirdpartyvideosystempolicy +schema: 2.0.0 +title: Grant-CsThirdPartyVideoSystemPolicy --- # Grant-CsThirdPartyVideoSystemPolicy @@ -39,7 +40,7 @@ If you want a VTC device to be managed by the global policy or (if available) th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video Device"} | Grant-CsThirdPartyVideoSystemPolicy -PolicyName "RedmondVideoSystemPolicy" @@ -50,7 +51,7 @@ To do this, the command first uses the Get-CsThirdPartyVideoSystem cmdlet and th This device is then piped to the Grant-CsThirdPartyVideoSystemPolicy cmdlet, which assigns the device the policy RedmondVideoSystemPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video Device"} | Grant-CsThirdPartyVideoSystemPolicy -PolicyName $Null @@ -61,7 +62,7 @@ The command shown in Example 2 is effectively the inverse of the command shown i If no site policy exists then Redmond Video Device will be managed by using the global policy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsThirdPartyVideoSystem -Filter {ThirdPartyVideoSystemPolicy -eq $Null} | Grant-CsThirdPartyVideoSystemPolicy -PolicyName "RedmondVideoSystemPolicy" @@ -74,7 +75,29 @@ To do this, the command first uses the Get-CsUser cmdlet and the Filter paramete ## PARAMETERS +### -DomainController + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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-CsThirdPartyVideoSystemPolicy cmdlet will contact the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the video system being assigned the per-user policy. Video systems are identified by using the Active Directory distinguished name (DN) of the associated contact object. By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. @@ -83,8 +106,7 @@ This means you might find it easier to modify third-party video systems by using ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -93,33 +115,17 @@ 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:RedmondUsersVideoPolicy has a PolicyName equal to RedmondUsersVideoPolicy. -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +### -PassThru -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Enables you to pass a contact object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsThirdPartyVideoSystemPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,32 +134,37 @@ 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-CsThirdPartyVideoSystemPolicy cmdlet will contact the first available domain controller. +### -PolicyName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +"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:RedmondUsersVideoPolicy has a PolicyName equal to RedmondUsersVideoPolicy. +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a contact object through the pipeline that represents the user being assigned the policy. -By default, the Grant-CsThirdPartyVideoSystemPolicy cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -163,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -183,14 +196,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Grant-CsThirdPartyVideoSystemPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy By default, the Grant-CsThirdPartyVideoSystemPolicy cmdlet does not return a value or object. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object. diff --git a/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsUserServicesPolicy.md similarity index 89% rename from skype/skype-ps/skype/Grant-CsUserServicesPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsUserServicesPolicy.md index cbb4c917da..b373c680f0 100644 --- a/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsUserServicesPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsUserServicesPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csuserservicespolicy +schema: 2.0.0 +title: Grant-CsUserServicesPolicy --- # Grant-CsUserServicesPolicy @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the Grant- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Grant-CsUserServicesPolicy -Identity "Ken Myer" -PolicyName "RedmondUserServicesPolicy" @@ -58,7 +59,7 @@ Grant-CsUserServicesPolicy -Identity "Ken Myer" -PolicyName "RedmondUserServices The command shown in Example 1 assigns the per-user User Services policy RedmondUserServicesPolicy to the user with the Identity (in this example, the Active Directory display name) Ken Myer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Grant-CsUserServicesPolicy -Identity "Ken Myer" -PolicyName $Null @@ -68,7 +69,7 @@ Example 2 unassigns any per-user Users Services policy previously assigned to Ke Per-user policies are unassigned by setting the PolicyName parameter to a Null value ($Null). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Grant-CsUserServicesPolicy -PolicyName "RedmondUserServicesPolicy" @@ -81,7 +82,29 @@ This collection of users is then piped to the Grant-CsUserServicesPolicy cmdlet, ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to retrieve user information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be assigned the per-user user experience policy. User Identities are typically 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 (four example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). @@ -93,8 +116,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -103,14 +125,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. +By default, the Grant-CsUserServicesPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,68 +144,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to retrieve user information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). +### -PolicyName -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondUserExperiencePolicy has a PolicyName equal to RedmondUserExperiencePolicy. -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. -By default, the Grant-CsUserServicesPolicy cmdlet does not pass objects through the pipeline. +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondUserExperiencePolicy has a PolicyName equal to RedmondUserExperiencePolicy. +### -Confirm -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -194,14 +207,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Grant-CsUserServicesPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsUserServicesPolicy cmdlet 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. diff --git a/skype/skype-ps/skype/Grant-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsVoicePolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsVoicePolicy.md index f553602f84..cb81b4ba9c 100644 --- a/skype/skype-ps/skype/Grant-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsVoicePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsVoicePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csvoicepolicy +schema: 2.0.0 +title: Grant-CsVoicePolicy --- # Grant-CsVoicePolicy @@ -50,7 +51,7 @@ For example: ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsVoicePolicy -Identity "Ken Myer" -PolicyName VoicePolicyRedmond ``` @@ -58,7 +59,7 @@ Grant-CsVoicePolicy -Identity "Ken Myer" -PolicyName VoicePolicyRedmond This example assigns the voice policy with the Identity VoicePolicyRedmond to the user with the display name Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com" | Grant-CsVoicePolicy -PolicyName VoicePolicyRedmond ``` @@ -70,7 +71,29 @@ This collection of users is then piped to the Grant-CsVoicePolicy cmdlet, which ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (unique identifier) of the user to whom the policy is being assigned. User identities can be specified by 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). @@ -83,8 +106,7 @@ Full Data Type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -93,33 +115,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName -The name (Identity) of the voice policy to be assigned to the user. -(Note that this includes only the name portion of the Identity. -Per-user policy identities include a prefix of tag: that should not be included with the PolicyName.) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PassThru -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +Returns the results of the command. +By default, this cmdlet does not generate any output. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,31 +134,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns the results of the command. -By default, this cmdlet does not generate any output. +### -PolicyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name (Identity) of the voice policy to be assigned to the user. +(Note that this includes only the name portion of the Identity. +Per-user policy identities include a prefix of tag: that should not be included with the PolicyName.) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 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. +### -Tenant + +> Applicable: Skype for Business Online + +Globally unique identifier (GUID) of the tenant account whose federation 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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,13 +180,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -177,21 +197,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose federation settings are being returned. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return your tenant ID by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -205,13 +220,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of a user account to which the voice policy is being granted. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsVoiceRoutingPolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsVoiceRoutingPolicy.md index 741af07a2c..c7832e9d92 100644 --- a/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsVoiceRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csvoiceroutingpolicy +schema: 2.0.0 +title: Grant-CsVoiceRoutingPolicy --- # Grant-CsVoiceRoutingPolicy @@ -41,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the Grant- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Grant-CsVoiceRoutingPolicy -Identity "Ken Myer" -PolicyName "RedmondVoiceRoutingPolicy" ``` @@ -49,7 +51,7 @@ Grant-CsVoiceRoutingPolicy -Identity "Ken Myer" -PolicyName "RedmondVoiceRouting The command shown in Example 1 assigns the per-user voice routing policy RedmondVoiceRoutingPolicy to the user with the Active Directory display name "Ken Myer". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Grant-CsVoiceRoutingPolicy -Identity "Ken Myer" -PolicyName $Null ``` @@ -58,7 +60,7 @@ In Example 2, any per-user voice routing policy previously assigned to the user To unassign a per-user policy, set the PolicyName to a null value ($Null). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -OU "OU=Redmond,dc=litwareinc,dc=com" | Grant-CsVoiceRoutingPolicy -PolicyName "RedmondVoiceRoutingPolicy" ``` @@ -70,7 +72,29 @@ Those user accounts are then piped to the Grant-CsVoiceRoutingPolicy cmdlet, whi ## PARAMETERS +### -DomainController + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to retrieve user information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be assigned the per-user voice routing policy. User Identities are typically 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). @@ -82,8 +106,7 @@ For example, the Identity "\* Smith" returns all the users who have a display na ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -92,14 +115,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being assigned the voice routing policy. +By default, the Grant-CsVoiceRoutingPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,32 +134,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to retrieve user information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). +### -PolicyName + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondVoiceRoutingPolicy has a PolicyName equal to RedmondVoiceRoutingPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 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 voice routing policy. -By default, the Grant-CsVoiceRoutingPolicy cmdlet does not pass objects through the pipeline. +### -Tenant +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,49 +171,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondVoiceRoutingPolicy has a PolicyName equal to RedmondVoiceRoutingPolicy. +### -Confirm -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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, 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: Required: False Position: Named @@ -198,14 +212,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Grant-CsVoiceRoutingPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsVoiceRoutingPolicy cmdlet 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. diff --git a/skype/skype-ps/skype/Import-CSAnnouncementFile.md b/skype/skype-ps/SkypeForBusiness/Import-CSAnnouncementFile.md similarity index 83% rename from skype/skype-ps/skype/Import-CSAnnouncementFile.md rename to skype/skype-ps/SkypeForBusiness/Import-CSAnnouncementFile.md index 37882297f1..36aee95683 100644 --- a/skype/skype-ps/skype/Import-CSAnnouncementFile.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CSAnnouncementFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csannouncementfile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CSAnnouncementFile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csannouncementfile +schema: 2.0.0 +title: Import-CSAnnouncementFile --- # Import-CSAnnouncementFile @@ -37,7 +38,7 @@ Imported files must be WAV or WMA files. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $a = [System.IO.File]::ReadAllBytes('.\GreetingFile.wav') @@ -53,7 +54,7 @@ We pass the service Identity ApplicationServer:redmond.litwareinc.com to the Par This can be any valid Windows operating system file name, but it should end with a .wav or .wma extension. Finally, we pass the variable $a as the value to the Content parameter to read in our byte array. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" -Content ([System.IO.File]::ReadAllBytes('.\GreetingFile.wav')) @@ -61,7 +62,7 @@ Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -File Example 2 is identical to Example 1 except that we included the command inside parentheses as a value to the Content parameter rather than calling that command on its own and assigning it to a variable. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` [System.IO.File]::ReadAllBytes('.\GreetingFile.wav') | Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" @@ -73,31 +74,37 @@ This is the most reliable way of importing an announcement file from a remote se ## PARAMETERS -### -Parent -The service ID of the Application Server on which the associated Announcement service is running. +### -Content + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The contents of the audio file as a byte array. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml -Type: String +Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True -Position: 2 +Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name that you want the file to have in the File Store. You will use this name in the AudioFilePrompt parameter in the call to the New-CsAnnouncement or Set-CsAnnouncement cmdlet to assign the file to an announcement. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -106,48 +113,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Content -The contents of the audio file as a byte array. +### -Force -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`). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Byte[] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The service ID of the Application Server on which the associated Announcement service is running. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -156,14 +167,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -177,15 +190,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -Byte\[\]. -Accepts a byte array from an audio file. -Byte array must be piped as a single record. -See Example 3. +### System.Byte[] +Accepts a byte array from an audio file. Byte array must be piped as a single record. See Example 3. ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Import-CsCertificate.md similarity index 66% rename from skype/skype-ps/skype/Import-CsCertificate.md rename to skype/skype-ps/SkypeForBusiness/Import-CsCertificate.md index ba39973617..f083e4ec22 100644 --- a/skype/skype-ps/skype/Import-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cscertificate +schema: 2.0.0 +title: Import-CsCertificate --- # Import-CsCertificate @@ -22,23 +23,16 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### Local (Default) ``` -Import-CsCertificate -Path [-Password ] [-PrivateKeyExportable ] [-Force] - [-Report ] [-WhatIf] [-Confirm] [] +Import-CsCertificate -Path [-Password ] [-PrivateKeyExportable ] + [-EffectiveDate ] [-Roll] [-Force] [-Report ] [-WhatIf] [-Confirm] [] ``` ### CMS ``` -Import-CsCertificate [-Identity] -Path -Type [-Confirm] - [-EffectiveDate ] [-Force] [-Password ] [-Report ] [-Roll] [-WhatIf] - [] -``` - -### Local -``` -Import-CsCertificate -Path [-Confirm] [-EffectiveDate ] [-Force] [-Password ] - [-PrivateKeyExportable ] [-Report ] [-Roll] [-WhatIf] [] +Import-CsCertificate [-Identity] -Path [-Password ] -Type + [-EffectiveDate ] [-Roll] [-Force] [-Report ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -56,7 +50,7 @@ At that point, you can use the Import-CsCertificate cmdlet to import the certifi ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Import-CsCertificate -Path "C:\Certificates\WebServer.pfx" -PrivateKeyExportable $True @@ -68,63 +62,74 @@ After the command completes, the certificate will be available to be assigned to ## PARAMETERS -### -Path -Full path to the certificate file to be imported. -For example: `-Path "C:\Certificates\WebServer.cer".` +### -EffectiveDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Date and time when the certificate can first be used. +For example, to configure a certificate for first use at 8:00 AM on July 31, 2012 use this syntax on a server running under the US English Region and Language settings: + +`-EffectiveTime "7/31/2012 8:00 AM"` ```yaml -Type: String +Type: System.DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: EffectiveTime -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Password -Password associated with the certificate file. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PrivateKeyExportable -When set to True, ensures that the private key portion of the certificate can be read by the Network Service account. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to Global, enables the certificate to function at the global scope. +Global certificates will automatically be copied and distributed to the appropriate computers. ```yaml -Type: Boolean -Parameter Sets: (All), Local -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Microsoft.Rtc.Management.Xds.XdsIdentity +Parameter Sets: CMS +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None 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. +### -Password + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Password associated with the certificate file. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,31 +138,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\Certificates.html"` +### -Path + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the certificate file to be imported. +For example: `-Path "C:\Certificates\WebServer.cer".` ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -PrivateKeyExportable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, ensures that the private key portion of the certificate can be read by the Network Service account. ```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 +Type: System.Boolean +Parameter Sets: Local +Aliases: Required: False Position: Named @@ -166,14 +175,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\Certificates.html"` ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,75 +194,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -When set to Global, enables the certificate to function at the global scope. -Global certificates will automatically be copied and distributed to the appropriate computers. +### -Roll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to update the specified certificate at the date and time specified by the EffectiveDate parameter; this enables you to specify a date and time when the new certificate will become the primary certificate. +Note that your command will fail if you specify the Roll parameter without including the EffectiveDate parameter. ```yaml -Type: XdsIdentity -Parameter Sets: CMS -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -Type +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of certificate being requested. Certificate types include, but are not limited to, the following: -AccessEdgeExternal - -AudioVideoAuthentication - -DataEdgeExternal - -Default - -External - -Internal - -iPadAPNService - -iPhoneAPNService - -LogRetentionService - -MPNService - -OAuthTokenIssuer - -PICWebService - -ProvisionService - -SMPDNSWebService - -TenantAdmin - -UpgradeEngineService - -WebServicesExternal - -WebServicesInternal - -WsFedTokenTransfer - -XMPPServer - - +- AccessEdgeExternal +- AudioVideoAuthentication +- DataEdgeExternal +- Default +- External +- Internal +- iPadAPNService +- iPhoneAPNService +- LogRetentionService +- MPNService +- OAuthTokenIssuer +- PICWebService +- ProvisionService +- SMPDNSWebService +- TenantAdmin +- UpgradeEngineService +- WebServicesExternal +- WebServicesInternal +- WsFedTokenTransfer +- XMPPServer ```yaml -Type: CertType[] +Type: Microsoft.Rtc.Management.Deployment.CertType[] Parameter Sets: CMS -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -259,59 +253,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EffectiveDate -Date and time when the certificate can first be used. -For example, to configure a certificate for first use at 8:00 AM on July 31, 2012 use this syntax on a server running under the US English Region and Language settings: +### -Confirm -`-EffectiveTime "7/31/2012 8:00 AM"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: DateTime -Parameter Sets: CMS, Local -Aliases: EffectiveTime -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Roll -Enables you to update the specified certificate at the date and time specified by the EffectiveDate parameter; this enables you to specify a date and time when the new certificate will become the primary certificate. -Note that your command will fail if you specify the Roll parameter without including the EffectiveDate parameter. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter -Parameter Sets: CMS, Local -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None. +### None Import-CsCertificate does not accept pipelined input. -### -None. +### None The Import-CsCertificate cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md b/skype/skype-ps/SkypeForBusiness/Import-CsCompanyPhoneNormalizationRules.md similarity index 89% rename from skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md rename to skype/skype-ps/SkypeForBusiness/Import-CsCompanyPhoneNormalizationRules.md index 68beb13982..9d98d022c7 100644 --- a/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsCompanyPhoneNormalizationRules.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cscompanyphonenormalizationrules applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsCompanyPhoneNormalizationRules -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cscompanyphonenormalizationrules +schema: 2.0.0 +title: Import-CsCompanyPhoneNormalizationRules --- # Import-CsCompanyPhoneNormalizationRules @@ -42,7 +43,7 @@ Alternatively, the New-CsAddressBookNormalizationConfiguration and Set-CsAddress ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Import-CsCompanyPhoneNormalizationRules -Filename "C:\Data\Company_Phone_Number_Normalization_Rules.txt" -Identity Global @@ -54,6 +55,9 @@ This example reads the phone normalization rules at the specified path and appli ## PARAMETERS ### -FileName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the full path to the input Company_Phone_Number_Normalization_Rules.txt file. For example: @@ -62,8 +66,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -72,30 +75,16 @@ 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 Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +94,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the address book normalization configuration settings to be updated. To modify the global settings, use this syntax: @@ -124,8 +116,7 @@ An error will occur if you try to apply these settings to any other service. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -135,13 +126,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,14 +143,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -171,13 +184,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None +### None ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Import-CsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Import-CsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Import-CsConfiguration.md index 6f8f568b9c..d1c19492f1 100644 --- a/skype/skype-ps/skype/Import-CsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csconfiguration +schema: 2.0.0 +title: Import-CsConfiguration --- # Import-CsConfiguration @@ -49,7 +50,7 @@ You only need to do this once; after that, replication will take place automatic ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` @@ -59,7 +60,7 @@ Import-CsConfiguration -FileName "C:\Config.zip" The command shown in Example 1 imports the current topology, configuration settings, and policies from a file named C:\Config.zip to the Central Management store. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Import-CsConfiguration -FileName "C:\Config.zip" -LocalStore @@ -70,7 +71,7 @@ In this example, configuration data has been exported to a file named Config.zip Import-CsConfiguration is then used to import that data, with the LocalStore parameter causing that data to be imported to the local computer instead of the Central Management store. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = Export-CsConfiguration -AsBytes @@ -89,6 +90,8 @@ The net effect is that data is copied from the Central Management store to the l ### -ByteInput +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Reads topology information from a byte array stored in a variable. This byte array is created by using the ByteInput parameter when calling the Export-CsConfiguration cmdlet. @@ -99,8 +102,7 @@ You cannot use both the ByteInput parameter and the FileName parameter in the sa ```yaml Type: Byte[] Parameter Sets: ByteInput -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -111,6 +113,8 @@ Accept wildcard characters: False ### -FileName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to the .ZIP file created by Export-CsConfiguration. For example: `-FileName "C:\Config.zip".` Note that you must include either the FileName or the ByteInput parameter, but not both, when calling the Import-CsConfiguration cmdlet. @@ -120,8 +124,7 @@ Note that you must include either the FileName or the ByteInput parameter, but n ```yaml Type: String Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -131,6 +134,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Bypasses any prompts that would otherwise appear should a non-fatal error occur when running the command. To set the Force parameter to True, use this syntax: @@ -139,8 +145,7 @@ To set the Force parameter to True, use this syntax: ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,13 +155,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Copies the configuration data to the local computer rather than the Central Management store. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +177,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Import-CsConfiguration cmdlet does not return any values or objects. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsDeviceUpdate.md b/skype/skype-ps/SkypeForBusiness/Import-CsDeviceUpdate.md similarity index 88% rename from skype/skype-ps/skype/Import-CsDeviceUpdate.md rename to skype/skype-ps/SkypeForBusiness/Import-CsDeviceUpdate.md index a5c01e0bfd..7cb14051a4 100644 --- a/skype/skype-ps/skype/Import-CsDeviceUpdate.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsDeviceUpdate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csdeviceupdate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsDeviceUpdate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csdeviceupdate +schema: 2.0.0 +title: Import-CsDeviceUpdate --- # Import-CsDeviceUpdate @@ -53,7 +54,7 @@ Alternatively, you can use a command like the one shown in Example 3; this one c ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Import-CsDeviceUpdate -Identity "service:WebServer:atl-cs-001.litwareinc.com" -FileName C:\Updates\UCUpdates.cab @@ -61,7 +62,7 @@ Import-CsDeviceUpdate -Identity "service:WebServer:atl-cs-001.litwareinc.com" -F The command shown in Example 1 imports device update rules from the file C:\Updates\UCUpdates.cab. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Import-CsDeviceUpdate -Identity "service:WebServer:atl-cs-001.litwareinc.com" -FileName \\\\atl-fs-001\Updates\UCUpdates.cab @@ -70,7 +71,7 @@ Import-CsDeviceUpdate -Identity "service:WebServer:atl-cs-001.litwareinc.com" -F The command shown in Example 2 imports device update rules from the UNC path \\\\atl-fs-001\Updates\UCUpdates.cab. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsService -WebServer | ForEach-Object {Import-CsDeviceUpdate -Identity $_.Identity -FileName C:\Updates\UCUpdates.cab} @@ -84,68 +85,75 @@ Note that this command will work only if you have copied UCUpdates.cab to the sa ## PARAMETERS -### -Identity - -Indicates the service instance where the new update rules will be applied. -For example: `-Identity "service:WebServer:atl-cs-001.litwareinc.com".` - -The Identity should be the fully qualified domain name of the Front End pool where the Web server is installed. +### -FileName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Path to the update file (for example, C:\Updates\UCUpdates.cab). ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -FileName -Path to the update file (for example, C:\Updates\UCUpdates.cab). +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +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 occur when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the service instance where the new update rules will be applied. +For example: `-Identity "service:WebServer:atl-cs-001.litwareinc.com".` + +The Identity should be the fully qualified domain name of the Front End pool where the Web server is installed. + + ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -154,14 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -175,13 +185,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsDeviceUpdate cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.Rule The Import-CsDeviceUpdate cmdlet imports instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.Rule class. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConferenceDirectory.md similarity index 88% rename from skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md rename to skype/skype-ps/SkypeForBusiness/Import-CsLegacyConferenceDirectory.md index aa6269159b..27392e0c86 100644 --- a/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConferenceDirectory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cslegacyconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsLegacyConferenceDirectory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cslegacyconferencedirectory +schema: 2.0.0 +title: Import-CsLegacyConferenceDirectory --- # Import-CsLegacyConferenceDirectory @@ -44,7 +45,7 @@ The Import-CsLegacyConferenceDirectory cmdlet should also be run anytime the Mer ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Import-CsLegacyConferenceDirectory @@ -55,15 +56,16 @@ The command shown in Example 1 imports conferencing directories from Communicati ## PARAMETERS -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\ImportDirectories.html"` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -72,14 +74,17 @@ 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. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\ImportDirectories.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,14 +93,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -104,14 +111,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -125,13 +134,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsLegacyConferenceDirectory cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Import-CsLegacyConferenceDirectory cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsLegacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Import-CsLegacyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Import-CsLegacyConfiguration.md index 51ac1f67d2..44ca95194f 100644 --- a/skype/skype-ps/skype/Import-CsLegacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cslegacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsLegacyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cslegacyconfiguration +schema: 2.0.0 +title: Import-CsLegacyConfiguration --- # Import-CsLegacyConfiguration @@ -56,7 +57,7 @@ If that happens you must re-run the Import-CsLegacyConfiguration cmdlet before y ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Import-CsLegacyConfiguration @@ -65,7 +66,7 @@ Import-CsLegacyConfiguration The command shown in Example 1 merges voice policies and other settings from Communications Server 2007 or Communications Server 2007 R2 with an installation of Skype for Business Server. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Import-CsLegacyConfiguration -ReplaceExisting @@ -80,17 +81,16 @@ Because you included the ReplaceExisting parameter, the Skype for Business Serve ## PARAMETERS -### -ReplaceExisting - -If present, this parameter instructs the Import-CsLegacyConfiguration cmdlet to overwrite any previously imported policies or settings that have changed since the last time the cmdlet was run. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,14 +99,18 @@ 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. +### -ReplaceExisting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, this parameter instructs the Import-CsLegacyConfiguration cmdlet to overwrite any previously imported policies or settings that have changed since the last time the cmdlet was run. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,14 +120,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\ImportConfiguration.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -148,14 +156,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -169,13 +179,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsLegacyConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Import-CsLegacyConfiguration cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsLisConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Import-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Import-CsLisConfiguration.md index 20298f3573..ab7e2c6734 100644 --- a/skype/skype-ps/skype/Import-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cslisconfiguration +schema: 2.0.0 +title: Import-CsLisConfiguration --- # Import-CsLisConfiguration @@ -48,7 +49,7 @@ If you then call the Import-CsLisConfiguration cmdlet to restore the backed-up c ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Import-CsLisConfiguration -FileName C:\E911Config.bak @@ -56,7 +57,7 @@ Import-CsLisConfiguration -FileName C:\E911Config.bak This example imports the E9-1-1 configuration from the backup file named E911Config.back to the location configuration database. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $lisconfig = Export-CsLisConfiguration -AsBytes @@ -72,7 +73,7 @@ In line 2 the Import-CsLisConfiguration cmdlet is called. The ByteInput parameter receives a value of $lisconfig, which is the variable containing the byte array we exported. This will import that byte array back into the location configuration database. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $lisconfig = Export-CsLisConfiguration -AsBytes @@ -95,13 +96,15 @@ The contents of the file are then piped to the Import-CsLisConfiguration cmdlet, ## PARAMETERS ### -ByteInput + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value passed to this parameter is a variable containing a byte array of the LIS configuration that was created by the Export-CsLisConfiguration cmdlet with the AsBytes parameter. ```yaml Type: Byte[] Parameter Sets: ByteInput -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the backup file from which to import the configuration. You cannot specify a FileName and a ByteInput. Only one of these two parameters can be used with each call to this cmdlet. @@ -118,8 +124,7 @@ Only one of these two parameters can be used with each call to this cmdlet. ```yaml Type: String Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -133,15 +138,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -Byte\[\]. -Accepts a byte array from an exported LIS configuration. -The byte array must be piped as a single record. -See Example 3. +### Sysetm.Byte[] +Accepts a byte array from an exported LIS configuration. The byte array must be piped as a single +record. See Example 3. ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsPersistentChatData.md b/skype/skype-ps/SkypeForBusiness/Import-CsPersistentChatData.md similarity index 91% rename from skype/skype-ps/skype/Import-CsPersistentChatData.md rename to skype/skype-ps/SkypeForBusiness/Import-CsPersistentChatData.md index a6407326d2..5baf53598f 100644 --- a/skype/skype-ps/skype/Import-CsPersistentChatData.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsPersistentChatData.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Import-CsPersistentChatData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cspersistentchatdata +schema: 2.0.0 +title: Import-CsPersistentChatData --- # Import-CsPersistentChatData @@ -51,7 +52,7 @@ Skype for Business Server Control Panel: The functions carried out by the Import ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Import-CsPersistentChatData -DBInstance "atl-sql-001.litwareinc.com\rtc" -FileName "C:\Logs\PersistentChatExport.zip" @@ -63,13 +64,15 @@ The command shown on Example 1 reads exported Persistent Chat data from the file ## PARAMETERS ### -ByteInput + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When specified, data is imported as a byte array rather than an XML file. ```yaml Type: Byte[] Parameter Sets: ByteInput -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -80,6 +83,8 @@ Accept wildcard characters: False ### -DBInstance +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name and name of the SQL Server instance where the Skype for Business Server Persistent Chat database is located. For example, this syntax specifies the database found in the RTC database instance on the server atl-sql-001.litwareinc.com: @@ -90,8 +95,7 @@ For example, this syntax specifies the database found in the RTC database instan ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full path to the XML file being imported. For example: @@ -109,8 +116,7 @@ For example: ```yaml Type: String Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -119,14 +125,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\PersistentChatExport.html"` + +If this file already exists, it will be overwritten when you run the cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -135,19 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -Confirm -`-Report "C:\Logs\PersistentChatExport.html"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -If this file already exists, it will be overwritten when you run the cmdlet. +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -157,13 +167,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -177,14 +189,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsPersistentChatData cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Import-CsRgsAudioFile.md b/skype/skype-ps/SkypeForBusiness/Import-CsRgsAudioFile.md similarity index 87% rename from skype/skype-ps/skype/Import-CsRgsAudioFile.md rename to skype/skype-ps/SkypeForBusiness/Import-CsRgsAudioFile.md index 2e14bd423a..9e75832851 100644 --- a/skype/skype-ps/skype/Import-CsRgsAudioFile.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsRgsAudioFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csrgsaudiofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsRgsAudioFile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csrgsaudiofile +schema: 2.0.0 +title: Import-CsRgsAudioFile --- # Import-CsRgsAudioFile @@ -37,7 +38,7 @@ Even though the audio file is already used by the Response Group application you ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content ([System.IO.File]::ReadAllBytes('C:\Media\WhileYouWait.wav')) @@ -64,24 +65,10 @@ If you do not call Set-CsRgsWorkflow, your modifications will exist only in memo ## PARAMETERS -### -Identity -Identity of the service where the audio file is to be imported. -(This must be the same service that hosts the Response Group application.) For example: `-Identity "service:ApplicationServer:atl-cs-001.litwareinc.com".` - -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Content -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Content Actual content of the audio file being imported. 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`). @@ -89,8 +76,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -100,14 +86,16 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + File name for the audio file being imported. For example, the file name for the file C:\Media\Welcome.wav is this: Welcome.wav. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -117,13 +105,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,30 +122,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Identity of the service where the audio file is to be imported. +(This must be the same service that hosts the Response Group application.) For example: `-Identity "service:ApplicationServer:atl-cs-001.litwareinc.com".` ```yaml -Type: SwitchParameter +Type: RgsIdentity Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -169,13 +182,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None Import-CsRgsAudioFile does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.AudioFile Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.AudioFile object. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsRgsConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Import-CsRgsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Import-CsRgsConfiguration.md index a18372286a..812b6ad4e6 100644 --- a/skype/skype-ps/skype/Import-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsRgsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csrgsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsRgsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csrgsconfiguration +schema: 2.0.0 +title: Import-CsRgsConfiguration --- # Import-CsRgsConfiguration @@ -41,7 +42,7 @@ Skype for Business Server Control Panel: The functions carried out by the Import ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Import-CsRgsConfiguration -FileName "C:\Export\RgsExport.zip" -Destination "ApplicationServer:atl-cs-001.litwareinc.com" @@ -54,6 +55,8 @@ The command shown in Example 1 imports a previously exported collection of Respo ### -Destination +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the Response Group instance where the configuration settings are being imported. For example: @@ -64,8 +67,7 @@ For example: ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -76,6 +78,8 @@ Accept wildcard characters: False ### -FileName +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to the .ZIP file created by the Export-CsRgsConfiguration cmdlet. For example: @@ -86,8 +90,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,13 +118,15 @@ Accept wildcard characters: False ``` ### -OverwriteOwner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present the current owner of the Response Group objects will be overwritten with the service identity of the new Response Group pool. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,14 +136,16 @@ Accept wildcard characters: False ``` ### -ReplaceExistingRgsSettings + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, all the existing service settings for the destination pool are replaced with the imported settings. If not specified, then service settings will remain as-is and only Response Group object (such as workflows and agent groups) will be imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,14 +155,16 @@ Accept wildcard characters: False ``` ### -ResolveNameConflicts + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, duplicate names will be resolved by appending a unique identifying number. For example, if there are two workflows named Help Desk Workflow one of the two will be renamed Help Desk Workflow (2). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,14 +178,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsRgsConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Import-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Import-CsUserData.md similarity index 84% rename from skype/skype-ps/skype/Import-CsUserData.md rename to skype/skype-ps/SkypeForBusiness/Import-CsUserData.md index d282e09e95..18ad46d95b 100644 --- a/skype/skype-ps/skype/Import-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsUserData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsUserData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csuserdata +schema: 2.0.0 +title: Import-CsUserData --- # Import-CsUserData @@ -40,7 +41,7 @@ Import-CsUserData -FileName -PoolFqdn [-ConfDirectoryFilter Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, allows you to import conference directory information for the specified conference directory. +For example, to import data from the conference directory with the ID 13 use this syntax: + +`-ConfDirectoryFilter 13` + +You can return conference directory IDs by using this command: + +`Get-CsConferenceDirectory` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Service Identity of the user database where the data should be imported. -For example: +### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to specify the FQDN of the domain controller to be used when running the Import-CsUserData cmdlet. +If not specified, the cmdlet will use the first available domain controller. -`-Identity "UserDatabase:atl-sql-001.litwareinc.com"` -You cannot use both the Identity and the PoolFqdn parameters in the same command. ```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolFqdn -Fully qualified domain name of the Registrar pool for the user data being imported. +### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the input file containing the exported user data. For example: -`-PoolFqdn "atl-cs-001.litwareinc.com"` +`-InputFile "C:\Data\ExportedUsers.xml"` ```yaml -Type: Fqdn -Parameter Sets: PoolFqdn -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -118,21 +127,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfDirectoryFilter -When specified, allows you to import conference directory information for the specified conference directory. -For example, to import data from the conference directory with the ID 13 use this syntax: - -`-ConfDirectoryFilter 13` +### -Force -You can return conference directory IDs by using this command: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsConferenceDirectory` +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,34 +145,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -Identity -Enables administrators to specify the FQDN of the domain controller to be used when running the Import-CsUserData cmdlet. -If not specified, the cmdlet will use the first available domain controller. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service Identity of the user database where the data should be imported. +For example: +`-Identity "UserDatabase:atl-sql-001.litwareinc.com"` + +You cannot use both the Identity and the PoolFqdn parameters in the same command. ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Identity +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -LegacyFormat + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates that the data to be imported was exported from a previous version of Lync Server or Office Communications Server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,16 +186,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegacyFormat -Indicates that the data to be imported was exported from a previous version of Lync Server or Office Communications Server. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the Registrar pool for the user data being imported. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: PoolFqdn +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -195,6 +209,8 @@ Accept wildcard characters: False ### -RoutingGroupFilter +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the imported data to users who belong to the same routing group. Routing groups are used by Skype for Business Server to determine the Front End server that users register with. @@ -203,8 +219,7 @@ Routing groups are used by Skype for Business Server to determine the Front End ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -214,6 +229,9 @@ Accept wildcard characters: False ``` ### -UserFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to import user data for a single user. To convert data for a specified user (and only for that user), set the UserFilter parameter to the SIP address of that user, being sure to omit the sip: prefix. For example: @@ -225,8 +243,7 @@ This parameter allows you to import data one user at a time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,14 +257,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsUserData cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Install-CsAdServerSchema.md b/skype/skype-ps/SkypeForBusiness/Install-CsAdServerSchema.md similarity index 85% rename from skype/skype-ps/skype/Install-CsAdServerSchema.md rename to skype/skype-ps/SkypeForBusiness/Install-CsAdServerSchema.md index 9a20d7aaef..2af92daaec 100644 --- a/skype/skype-ps/skype/Install-CsAdServerSchema.md +++ b/skype/skype-ps/SkypeForBusiness/Install-CsAdServerSchema.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/install-csadserverschema applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Install-CsAdServerSchema -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/install-csadserverschema +schema: 2.0.0 +title: Install-CsAdServerSchema --- # Install-CsAdServerSchema @@ -44,7 +45,7 @@ If it does not, then you must run the Install-CsAdServerSchema cmdlet on the sch ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Install-CsAdServerSchema @@ -52,7 +53,7 @@ Install-CsAdServerSchema The command shown in Example 1 determines the location of the .LDF file by reading information from the registry, then uses that file to update the Active Directory schema. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Install-CsAdServerSchema -Ldf "C:\Schemas" @@ -64,8 +65,28 @@ This folder location is specified by using the Ldf parameter. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -GlobalCatalog +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain. @@ -74,8 +95,7 @@ This parameter is not required if you are running the Install-CsAdServerSchema c ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +106,8 @@ Accept wildcard characters: False ### -GlobalSettingsDomainController +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller in your domain. This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain. @@ -94,8 +116,7 @@ This parameter is not required if you are running the Install-CsAdServerSchema c ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,6 +127,8 @@ Accept wildcard characters: False ### -Ldf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to the folder containing the .LDF file to be imported; the .LDF (LDAP Data Interchange Format) file contains the required updates for the Active Directory schema. If this parameter is not included, the Install-CsAdServerSchema cmdlet will look for the file in the Skype for Business Server installation path recorded in the registry. The installation path will typically be C:\Program Files\Skype for Business Server\Deployment\Setup. @@ -115,8 +138,7 @@ The installation path will typically be C:\Program Files\Skype for Business Serv ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,31 +147,17 @@ 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 Server 2015, Skype for Business Server 2019 +### -Report -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Report Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\ServerSchema.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +166,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SchemaMaster + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Active Directory schema master for your domain. +This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +186,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -190,15 +203,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SchemaMaster -Fully qualified domain name (FQDN) of the Active Directory schema master for your domain. -This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -212,13 +226,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Install-CsAdServerSchema cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Install-CsAdServerSchema cmdlet does not return any values or objects. ## NOTES diff --git a/skype/skype-ps/skype/Install-CsDatabase.md b/skype/skype-ps/SkypeForBusiness/Install-CsDatabase.md similarity index 85% rename from skype/skype-ps/skype/Install-CsDatabase.md rename to skype/skype-ps/SkypeForBusiness/Install-CsDatabase.md index cfa2fa1de6..9ee4fa1d42 100644 --- a/skype/skype-ps/skype/Install-CsDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Install-CsDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/install-csdatabase applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Install-CsDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/install-csdatabase +schema: 2.0.0 +title: Install-CsDatabase --- # Install-CsDatabase @@ -124,7 +125,7 @@ If that group is listed as the owner the group could possibly be deleted when yo ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn atl-sql-001.litwareinc.com -DatabasePaths "E:\CSLog","F:\CSLog","G:\CSDB" @@ -133,7 +134,7 @@ Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn atl-sql-001.litwareinc.co In Example 1, the Install-CsDatabase cmdlet reads in the Skype for Business Server topology, and then installs any required databases on the pool atl-sql-001.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Install-CsDatabase -CentralManagementDatabase -SqlServerFqdn atl-sql-001.litwareinc.com -SqlInstanceName rtc -DatabasePaths "G:\CSDB" @@ -145,8 +146,28 @@ The database will be installed in the rtc instance, and make use of the folder G ## PARAMETERS +### -Backup + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When used, backs up the existing Central Management server database to the specified SQL Server instance. + +```yaml +Type: SwitchParameter +Parameter Sets: ByCMS +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CentralManagementDatabase +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If this parameter is included, the Install-CsDatabase cmdlet will use the SqlServerFqdn parameter to install the Central Management store on the specified computer. This parameter is typically used only by Topology Builder, and is generally called just once, during initial setup. @@ -155,8 +176,7 @@ This parameter is typically used only by Topology Builder, and is generally call ```yaml Type: SwitchParameter Parameter Sets: ByCMS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -167,6 +187,8 @@ Accept wildcard characters: False ### -Clean +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If this parameter is included, the Install-CsDatabase cmdlet will delete and reinstall databases as needed. If this parameter is not included, the Install-CsDatabase cmdlet will not overwrite any existing databases. You cannot use both Clean and Update in the same command. @@ -176,8 +198,7 @@ You cannot use both Clean and Update in the same command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,13 +208,15 @@ Accept wildcard characters: False ``` ### -Collocated + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If present, additional database roles will be collocated with the Central Management store. ```yaml Type: SwitchParameter Parameter Sets: ByCMS, ByDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +227,8 @@ Accept wildcard characters: False ### -ConfiguredDatabases +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Reads information from the Skype for Business Server topology, and installs the required databases on the specified SQL Server computer or SQL Server cluster. Administrators who need to call the Install-CsDatabase cmdlet will almost always use this parameter when specifying the databases to be installed. @@ -212,8 +237,7 @@ Administrators who need to call the Install-CsDatabase cmdlet will almost always ```yaml Type: SwitchParameter Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -222,14 +246,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabasePathMap + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify custom folder paths for data files and log files; multiple paths should be separated by using a semicolon (;). +For example: + +`-DatabasePathMap @{"Archiving:DbPath"="\\\\atl-sql-001.litwareinc.com\db";"Archiving:LogPath"="\\\\atl-sql-002.litwareinc.com\logs"}` + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DatabasePaths + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the drives and folders where data and log files can be stored; for example: -DatabasePaths "D:\Logs","E:\Data". ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,6 +287,8 @@ Accept wildcard characters: False ### -DatabaseType +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to install a specific database on a specific SQL Server computer or SQL Server cluster. As a general rule, administrators should not run the Install-CsDatabase cmdlet with the DatabaseType parameter unless instructed otherwise by Microsoft support personnel. Instead, administrators should typically use the ConfiguredDatabases parameter. @@ -278,8 +327,7 @@ User ```yaml Type: DatabaseNameType Parameter Sets: ByDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -289,13 +337,33 @@ Accept wildcard characters: False ``` ### -ExcludeCollocatedStores + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, suppresses a warning message telling you that any collocated database stores must be installed on the local computer. ```yaml Type: SwitchParameter Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, forces the installation of the new database even if an existing database of that type is currently in use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -306,6 +374,8 @@ Accept wildcard characters: False ### -ForDefaultInstance +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, instructs the Install-CsDatabase cmdlet to only act against the default SQL Server instance. You cannot use both ForDefaultInstance and ForInstance in the same command. @@ -314,8 +384,7 @@ You cannot use both ForDefaultInstance and ForInstance in the same command. ```yaml Type: SwitchParameter Parameter Sets: ByConfigured, ByLocal -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -326,6 +395,8 @@ Accept wildcard characters: False ### -ForInstance +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, instructs the Install-CsDatabase cmdlet to only act against the specified SQL Server instance. You cannot use both ForInstance and ForDefaultInstance in the same command. @@ -334,8 +405,7 @@ You cannot use both ForInstance and ForDefaultInstance in the same command. ```yaml Type: String Parameter Sets: ByConfigured, ByLocal -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -346,6 +416,8 @@ Accept wildcard characters: False ### -GlobalCatalog +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Install-CsDatabase cmdlet on a computer with an account in your domain. @@ -354,8 +426,7 @@ This parameter is not required if you are running the Install-CsDatabase cmdlet ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -366,6 +437,8 @@ Accept wildcard characters: False ### -GlobalSettingsDomainController +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -375,8 +448,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -387,6 +459,8 @@ Accept wildcard characters: False ### -LocalDatabases +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If this parameter is included, the Install-CsDatabase cmdlet will read in the Skype for Business Server topology and install databases and stores as needed on the local computer. @@ -394,8 +468,7 @@ If this parameter is included, the Install-CsDatabase cmdlet will read in the Sk ```yaml Type: SwitchParameter Parameter Sets: ByLocal -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -404,8 +477,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NoReindex + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prevents the index files from being rebuilt when a database is being updated. +This parameter can only be used along with the Update parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\InstallDatabases.html"` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SkipPrepareCheck +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, causes the Install-CsDatabase cmdlet to forego its initial preparation checks. @@ -413,8 +526,7 @@ When present, causes the Install-CsDatabase cmdlet to forego its initial prepara ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -425,6 +537,8 @@ Accept wildcard characters: False ### -SqlInstanceName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the database instance where the database is to be installed. A database instance is simply a set of running processes that provides access to database files. If this parameter is omitted, the Install-CsDatabase cmdlet will use the default SQL Server instance. @@ -434,8 +548,7 @@ If this parameter is omitted, the Install-CsDatabase cmdlet will use the default ```yaml Type: String Parameter Sets: ByCMS, ByDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -445,14 +558,16 @@ Accept wildcard characters: False ``` ### -SqlServerFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the computer where the database is to be installed. For example: `-SqlServerFqdn atl-sql-001.litwareinc.com.` ```yaml Type: Fqdn Parameter Sets: ByCMS, ByDatabase, ByConfigured -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -463,6 +578,8 @@ Accept wildcard characters: False ### -Update +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, updates the existing database. You cannot use Update and Clean in the same command. @@ -475,8 +592,7 @@ At that point you can then run Install-CsDatabase and the Update parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -486,46 +602,15 @@ Accept wildcard characters: False ``` ### -UseDefaultSqlPaths -When specified, instructs SQL Server to select the drive where data and log files will be stored. -```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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -When present, forces the installation of the new database even if an existing database of that type is currently in use. +When specified, instructs SQL Server to select the drive where data and log files will be stored. ```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 -``` - -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\InstallDatabases.html"` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -534,46 +619,16 @@ 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 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 -``` - -### -Backup -When used, backs up the existing Central Management server database to the specified SQL Server instance. - -```yaml -Type: SwitchParameter -Parameter Sets: ByCMS -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -582,34 +637,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabasePathMap -Enables you to specify custom folder paths for data files and log files; multiple paths should be separated by using a semicolon (;). -For example: - -`-DatabasePathMap @{"Archiving:DbPath"="\\\\atl-sql-001.litwareinc.com\db";"Archiving:LogPath"="\\\\atl-sql-002.litwareinc.com\logs"}` - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -NoReindex -Prevents the index files from being rebuilt when a database is being updated. -This parameter can only be used along with the Update parameter. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -623,13 +660,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Install-CsDatabase cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Install-CsDatabase cmdlet does not return any values or objects. ## NOTES diff --git a/skype/skype-ps/skype/Install-CsMirrorDatabase.md b/skype/skype-ps/SkypeForBusiness/Install-CsMirrorDatabase.md similarity index 85% rename from skype/skype-ps/skype/Install-CsMirrorDatabase.md rename to skype/skype-ps/SkypeForBusiness/Install-CsMirrorDatabase.md index feb4acc5d3..45d5af9ec1 100644 --- a/skype/skype-ps/skype/Install-CsMirrorDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Install-CsMirrorDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/install-csmirrordatabase applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Install-CsMirrorDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/install-csmirrordatabase +schema: 2.0.0 +title: Install-CsMirrorDatabase --- # Install-CsMirrorDatabase @@ -52,7 +53,7 @@ Skype for Business Server Control Panel: The functions carried out by the Instal ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Install-CsMirrorDatabase -ConfiguredDatabases -FileShare "\\atl-fs-001.litware.com\DbBackup" -SqlServerFqdn "atl-primary-001.litwareinc.com" -DropExisitingDatabasesOnMirror @@ -66,6 +67,8 @@ The ConfiguredDatabases parameter causes the Install-CsMirrorDatabase cmdlet to ### -ConfiguredDatabases +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Reads information from the Skype for Business Server topology, and installs the required mirror databases on the specified SQL Server computer or SQL Server cluster. @@ -73,8 +76,7 @@ Reads information from the Skype for Business Server topology, and installs the ```yaml Type: SwitchParameter Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -83,8 +85,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabasePathMap + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify custom folder paths for data files and log files; multiple paths should be separated by using a semicolon (;). +For example: + +`-DatabasePathMap @{"Archiving:DbPath"="\\\\atl-sql-001.litwareinc.com\db";"Archiving:LogPath"="\\\\atl-sql-002.litwareinc.com\logs"}` + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DatabaseType +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of mirror database to be installed. Allowed values are: @@ -119,31 +144,7 @@ User ```yaml Type: DatabaseNameType Parameter Sets: ByDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileShare - -UNC path to the database shared folder. -The file share is used to export of databases from the primary SQL Server and import those databases onto the mirror. - -The shared folder and its contents can be deleted after mirroring is established. -The folder should also be deleted if you decide to disable mirroring. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -152,33 +153,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name (FQDN) of the primary SQL Server computer. -For example: - -`-SqlServerFqdn atl-sql-001.litwareinc.com` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DropExistingDatabasesOnMirror -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +When present, deletes any existing copies of the mirrored databases from the server acting as the mirror before new data is copied to that server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,17 +171,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabasePathMap -Enables you to specify custom folder paths for data files and log files; multiple paths should be separated by using a semicolon (;). +### -ExcludeDatabaseList + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +List of databases that should not be included in the mirror database; multiple databases can be specified by separating those databases using commas. For example: -`-DatabasePathMap @{"Archiving:DbPath"="\\\\atl-sql-001.litwareinc.com\db";"Archiving:LogPath"="\\\\atl-sql-002.litwareinc.com\logs"}` +`-ExcludeDatabaseList "RTCCAB","RTCPROV"` ```yaml -Type: Hashtable +Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,35 +192,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DropExistingDatabasesOnMirror -When present, deletes any existing copies of the mirrored databases from the server acting as the mirror before new data is copied to that server. +### -FileShare -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +UNC path to the database shared folder. +The file share is used to export of databases from the primary SQL Server and import those databases onto the mirror. + +The shared folder and its contents can be deleted after mirroring is established. +The folder should also be deleted if you decide to disable mirroring. -### -ExcludeDatabaseList -List of databases that should not be included in the mirror database; multiple databases can be specified by separating those databases using commas. -For example: -`-ExcludeDatabaseList "RTCCAB","RTCPROV"` ```yaml -Type: String[] +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -243,6 +218,8 @@ Accept wildcard characters: False ### -ForDefaultInstance +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, instructs the Install-CsMirrorDatabase cmdlet to only act against the default SQL Server instance. You cannot use both ForDefaultInstance and ForInstance in the same command. @@ -251,8 +228,7 @@ You cannot use both ForDefaultInstance and ForInstance in the same command. ```yaml Type: SwitchParameter Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -263,6 +239,8 @@ Accept wildcard characters: False ### -ForInstance +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, instructs the Install-CsMirrorDatabase cmdlet to only act against the specified SQL Server instance. You cannot use both ForInstance and ForDefaultInstance in the same command. @@ -271,8 +249,7 @@ You cannot use both ForInstance and ForDefaultInstance in the same command. ```yaml Type: String Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -283,6 +260,8 @@ Accept wildcard characters: False ### -Report +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -293,8 +272,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -305,6 +283,8 @@ Accept wildcard characters: False ### -SqlInstanceName +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the database instance where the database is to be installed. A database instance is simply a set of running processes that provides access to database files. If this parameter is omitted, the Install-CsMirrorDatabase cmdlet will use the default SQL Server instance. @@ -314,8 +294,46 @@ If this parameter is omitted, the Install-CsMirrorDatabase cmdlet will use the d ```yaml Type: String Parameter Sets: ByDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlServerFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the primary SQL Server computer. +For example: + +`-SqlServerFqdn atl-sql-001.litwareinc.com` + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -325,13 +343,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -345,14 +365,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Install-CsMirrorDatabase cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsArchivingDatabasePurge.md similarity index 88% rename from skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsArchivingDatabasePurge.md index dbb310849d..f36b95f89d 100644 --- a/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsArchivingDatabasePurge.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csarchivingdatabasepurge applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsArchivingDatabasePurge -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csarchivingdatabasepurge +schema: 2.0.0 +title: Invoke-CsArchivingDatabasePurge --- # Invoke-CsArchivingDatabasePurge @@ -59,7 +60,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsArchivingDatabasePurge -Identity "service:ArchivingDatabase:atl-sql-001.litwareinc.com" -PurgeArchivingDataOlderThanHours 24 -PurgeExportedArchivesOnly $False @@ -70,7 +71,7 @@ To ensure that all the records are deleted, including records that have not been -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsArchivingDatabasePurge -Identity "service:ArchivingDatabase:atl-sql-001.litwareinc.com" -PurgeArchivingDataOlderThanHours 24 -PurgeExportedArchivesOnly $False -Confirm:$False @@ -83,7 +84,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1; That syntax suppresses the confirmation prompts that would otherwise appear when purging archiving records. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsService -ArchivingDatabase | ForEach-Object {Invoke-CsArchivingDatabasePurge -Identity $_.Identity -PurgeArchivingDataOlderThanHours 24 -PurgeExportedArchivesOnly $False -Confirm:$False} @@ -97,7 +98,28 @@ In turn, the ForEach-Object cmdlet takes each database in the collection and the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the archiving database to be purged. You can retrieve the Identities for your archiving databases by running this command: @@ -108,8 +130,7 @@ Note that you cannot use the Identity parameter and the SqlServerFqdn parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -118,15 +139,37 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -MaxArchivingRecordsToDelete + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the maximum number of archiving records to be purged from the database; if you set this value to 99 and you have 100 records in the database that meet the PurgeArchivingDataOlderThanHours criterion, only the 99 oldest records will be deleted. + +MaxArchivingRecordsToDelete can be set to any integer value between 1 and 2147483647, inclusive. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PurgeArchivingDataOlderThanHours + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the age (in hours) of the archiving records to be purged from the database; any records older than this value will be deleted. PurgeArchivingDataOlderThanHours can be set to any integer value between 1 and 2147483647, inclusive. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -136,14 +179,16 @@ Accept wildcard characters: False ``` ### -PurgeExportedArchivesOnly + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, records will be removed for the archiving database only if those records have been exported (and, as a result, have been marked for deletion). Records that have not been exported will remain in the database, even if those records are older than the value specified by the PurgeArchivingDataOlderThanHours property. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 3 @@ -152,35 +197,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name of the computer where the archiving database is located. -For example: +### -SqlInstanceName -`-SqlServerFqdn "atl-sql-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. +SQL Server instance name for the archiving database. +For example: + +`-SqlInstanceName "archinst"` ```yaml Type: String Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,51 +218,39 @@ 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. +### -SqlServerFqdn -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Fully qualified domain name of the computer where the archiving database is located. +For example: -### -MaxArchivingRecordsToDelete -Specifies the maximum number of archiving records to be purged from the database; if you set this value to 99 and you have 100 records in the database that meet the PurgeArchivingDataOlderThanHours criterion, only the 99 oldest records will be deleted. +`-SqlServerFqdn "atl-sql-001.litwareinc.com"` -MaxArchivingRecordsToDelete can be set to any integer value between 1 and 2147483647, inclusive. +Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. ```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: SqlServer +Aliases: -Required: False -Position: 4 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -SQL Server instance name for the archiving database. -For example: +### -Confirm -`-SqlInstanceName "archinst"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -243,13 +260,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -263,12 +282,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayArchivingDatabase#Decorated The Invoke-CsArchivingDatabasePurge cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayArchivingDatabase#Decorated class. ## OUTPUTS -### +### Microsoft.Rtc.Management.Purge.ArchDataPurgeStatistics The Invoke-CsArchivingDatabasePurge cmdlet returns instances of the Microsoft.Rtc.Management.Purge.ArchDataPurgeStatistics class. ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsBackupServiceSync.md similarity index 85% rename from skype/skype-ps/skype/Invoke-CsBackupServiceSync.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsBackupServiceSync.md index 4c9944e54e..e68a427b48 100644 --- a/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsBackupServiceSync.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csbackupservicesync applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsBackupServiceSync -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csbackupservicesync +schema: 2.0.0 +title: Invoke-CsBackupServiceSync --- # Invoke-CsBackupServiceSync @@ -37,7 +38,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsBackupServiceSync -PoolFqdn "atl-cs-001.litwareinc.com" @@ -48,27 +49,10 @@ The command shown in Example 1 synchronizes the backup services for the pool atl ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool where backup service synchronization is being invoked. -For example: - -`-PoolFqdn "atl-cs-001.litwareinc.com"` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -BackupModule +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the type of data to be synchronized. Valid values are: @@ -80,13 +64,12 @@ CentralMgmt.CMSMaster ApplicationServer.RGSDataStore -ApplicationServer.RGSFileStore +ApplicationServer.RGSFileStore ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,13 +79,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -111,19 +96,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool where backup service synchronization is being invoked. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + +```yaml +Type: Fqdn +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 (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS -### -String value. +### System.Stringvalue. The Invoke-CsBackupServiceSync cmdlet can accept a pipelined string value representing the fully qualified domain name of a Skype for Business Server pool. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsCdrDatabasePurge.md similarity index 88% rename from skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsCdrDatabasePurge.md index 1aff964a92..184d913498 100644 --- a/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsCdrDatabasePurge.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscdrdatabasepurge applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsCdrDatabasePurge -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-cscdrdatabasepurge +schema: 2.0.0 +title: Invoke-CsCdrDatabasePurge --- # Invoke-CsCdrDatabasePurge @@ -59,7 +60,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsCdrDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -PurgeCallDetailDataOlderThanDays 10 -PurgeDiagnosticDataOlderThanDays 10 @@ -67,7 +68,7 @@ Invoke-CsCdrDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litw The command shown in Example 1 deletes all the records (both call detail and diagnostic records) from the monitoring database atl-sql-001.litwareinc.com that are more than 10 days old. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsCdrDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -PurgeCallDetailDataOlderThanDays 10 -PurgeDiagnosticDataOlderThanDays 10 -Confirm:$False @@ -80,7 +81,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1; That syntax suppresses the confirmation prompts that would otherwise appear when purging CDR records. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsService -MonitoringDatabase | ForEach-Object {Invoke-CsCdrDatabasePurge -Identity $_.Identity -PurgeCallDetailDataOlderThanDays 10 -PurgeDiagnosticDataOlderThanDays 10 -Confirm:$False} @@ -94,7 +95,28 @@ In turn, the ForEach-Object cmdlet takes each database in the collection and the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database to be purged. You can retrieve the Identities for your monitoring databases by running this command: @@ -105,8 +127,7 @@ Note that you cannot use the Identity parameter and the SqlServerFqdn parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -117,6 +138,8 @@ Accept wildcard characters: False ### -PurgeCallDetailDataOlderThanDays +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the age (in days) of the call detail records to be purged from the database; any records older than this value will be deleted. Call detail records represent user/session reports. They differ from diagnostic data reports, which are diagnostic logs uploaded by client applications such as Skype for Business. @@ -128,8 +151,7 @@ PurgeCallDetailDataOlderThanDays can be set to any integer value between 1 and 2 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -140,6 +162,8 @@ Accept wildcard characters: False ### -PurgeDiagnosticDataOlderThanDays +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the age (in days) of the diagnostic data records to be purged from the database; any records older than this value will be deleted. Diagnostic data reports are diagnostic logs uploaded by client applications such as Skype for Business. @@ -150,8 +174,7 @@ PurgeDiagnosticDataOlderThanHours can be set to any integer value between 1 and ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 3 @@ -160,70 +183,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name of the computer where the CDR database is located. -For example: +### -SqlInstanceName -`-SqlServerFqdn "atl-sql-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. +SQL Server instance name for the CDR database. +For example: + +`-SqlInstanceName "archinst"` ```yaml Type: String Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SqlServerFqdn -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Fully qualified domain name of the computer where the CDR database is located. +For example: -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +`-SqlServerFqdn "atl-sql-001.litwareinc.com"` + +Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: SqlServer +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -SQL Server instance name for the CDR database. -For example: +### -Confirm -`-SqlInstanceName "archinst"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -233,13 +246,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -253,13 +268,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase#Decorated The Invoke-CsCdrDatabasePurge cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase#Decorated class. ## OUTPUTS - -### +### Microsoft.Rtc.Management.Purge.CdrDataPurgeStatistics The Invoke-CsCdrDatabasePurge cmdlet returns instances of the Microsoft.Rtc.Management.Purge.CdrDataPurgeStatistics class. ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsComputerFailBack.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailBack.md similarity index 86% rename from skype/skype-ps/skype/Invoke-CsComputerFailBack.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailBack.md index 2700d5b25c..26594423a2 100644 --- a/skype/skype-ps/skype/Invoke-CsComputerFailBack.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailBack.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscomputerfailback applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsComputerFailBack -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-cscomputerfailback +schema: 2.0.0 +title: Invoke-CsComputerFailBack --- # Invoke-CsComputerFailBack @@ -32,7 +33,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) +### Example 1 (Skype for Business Server 2015) ``` Invoke-CsComputerFailBack -ComputerName "atl-mcs-001.litwareinc.com" -NoStart @@ -44,6 +45,9 @@ This example marks the computer "atl-mcs-001.litwareinc.com" as available to the ## PARAMETERS ### -ComputerName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the computer name to fail back. The computer should be referenced by using its fully qualified domain name (FQDN). For example, `-ComputerName "atl-mcs-001.litwareinc.com".` @@ -52,8 +56,7 @@ The computer name used during failback must be the same name used during failove ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -62,23 +65,10 @@ 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 Server 2015, Skype for Business Server 2019 +### -NoStart -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -NoStart If the NoStart parameter is specified, the Skype for Business server is added back into the pool and marked as available, but all the Skype for Business services are not started. Only the Skype for Business service (rtcsrv) is verified by the cmdlet. This allows for follow-up scripting to start the remaining services and configure the server for your environment before users and data are assigned. @@ -86,8 +76,7 @@ This allows for follow-up scripting to start the remaining services and configur ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +86,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\Server1FailbackLog.html".` If this file already exists, it will be overwritten. @@ -105,8 +97,25 @@ By default, reports are written to the AppData\Local\Temp folder in your user pr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipFabricHealthCheck + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill SkipFabricHealthCheck Description}} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -116,6 +125,9 @@ Accept wildcard characters: False ``` ### -WaitTime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time in TimeSpan format that the cmdlet will wait for a confirmation of failback success. If the time is exceeded, the cmdlet will fail and Skype for Business services will not be started or enabled. The default is one hour. @@ -123,8 +135,7 @@ The default is one hour. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,14 +144,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -149,14 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipFabricHealthCheck -{{Fill SkipFabricHealthCheck Description}} +### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -170,14 +185,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsComputerFailBack cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsComputerFailOver.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailOver.md similarity index 85% rename from skype/skype-ps/skype/Invoke-CsComputerFailOver.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailOver.md index 723b08653b..9b6c2a4d82 100644 --- a/skype/skype-ps/skype/Invoke-CsComputerFailOver.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailOver.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscomputerfailover applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsComputerFailOver -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-cscomputerfailover +schema: 2.0.0 +title: Invoke-CsComputerFailOver --- # Invoke-CsComputerFailOver @@ -34,7 +35,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) +### Example 1 (Skype for Business Server 2015) ``` Invoke-CsComputerFailOver -ComputerName "atl-mcs-001.litwareinc.com" -Report "C:\Logs\S1_FailOverLog.html" -WaitTime 1:30:00 ``` @@ -42,7 +43,7 @@ Invoke-CsComputerFailOver -ComputerName "atl-mcs-001.litwareinc.com" -Report "C: This example directs that the users assigned to server "atl-mcs-001.litwareinc.com" will be moved to other servers in the pool. The log output path is specified and the cmdlet will wait 1 hour 30 minutes before timing out. -### -------------------------- Example 2 -------------------------- (Skype for Business Server 2015) +### Example 2 (Skype for Business Server 2015) ``` $TimeSpan = New-TimeSpan -Minutes 30 Invoke-CsComputerFailOver -ComputerName "atl-mcs-001.litwareinc.com" -DrainingTimeout $TimeSpan @@ -53,6 +54,9 @@ This example force to drain all conferences and sessions after 30 minutes. If us ## PARAMETERS ### -ComputerName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the computer name to fail over. The computer should be referenced by using its fully qualified domain name (FQDN). For example, `-ComputerName "atl-mcs-001.litwareinc.com".` @@ -60,8 +64,7 @@ For example, `-ComputerName "atl-mcs-001.litwareinc.com".` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -70,14 +73,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -DrainingTimeout + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Draining timeout in TimeSpan format to gracefully drain MCUs. ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If the Force parameter is specified, the server is failed over without verifying the pool's capacity to absorb the failed over server's workload. **Note:** If you run this parameter together with -WhatIf parameter, it will be ignored and a server failover will be started. @@ -94,8 +102,7 @@ If the Force parameter is specified, the server is failed over without verifying ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,14 +112,16 @@ Accept wildcard characters: False ``` ### -NoStop + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If specified, Skype for Business Server services will not be stopped as part of the failover. This maintains the failed over server's state for additional scripting or troubleshooting. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\S1_FailOverLog.html".` If this file already exists, it will be overwritten. @@ -130,8 +142,7 @@ By default, reports are written to the "AppData\Local\Temp" folder in your user ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,16 +151,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WaitTime -Specifies the amount of time in TimeSpan format that the cmdlet will wait for confirmation that users and data have been migrated, and all conferences and sessions have been drained. -If the wait time is exceeded, the cmdlet fails and no action is taken on the specified server. -The default is one hour. +### -SkipFabricHealthCheck + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is reserved for internal Microsoft use. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +169,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -WaitTime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time in TimeSpan format that the cmdlet will wait for confirmation that users and data have been migrated, and all conferences and sessions have been drained. +If the wait time is exceeded, the cmdlet fails and no action is taken on the specified server. +The default is one hour. ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,14 +189,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DrainingTimeout -Draining timeout in TimeSpan format to gracefully drain MCUs. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -190,14 +207,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipFabricHealthCheck -This parameter is reserved for internal Microsoft use. +### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -211,14 +230,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsComputerFailOver cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsDatabaseFailover.md similarity index 84% rename from skype/skype-ps/skype/Invoke-CsDatabaseFailover.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsDatabaseFailover.md index 95e2fcf516..6bf0a475fd 100644 --- a/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsDatabaseFailover.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csdatabasefailover applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsDatabaseFailover -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csdatabasefailover +schema: 2.0.0 +title: Invoke-CsDatabaseFailover --- # Invoke-CsDatabaseFailover @@ -43,7 +44,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsDatabaseFailover -PoolFqdn atl-cs-001.litwareinc.com -DatabaseType "User" -NewPrincipal "Mirror" @@ -52,7 +53,7 @@ Invoke-CsDatabaseFailover -PoolFqdn atl-cs-001.litwareinc.com -DatabaseType "Use The command shown in Example 1 invokes failover for the User database found on the pool atl-cs-001.litwareinc.com. The command causes the User database to failover to a previously-assigned mirror database. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsDatabaseFailover -PoolFqdn atl-cs-001.litwareinc.com -ExcludeDatabase -NewPrincipal "Mirror" -ExcludeDatabaseList "LcsCDR", "LcsLog" @@ -66,6 +67,8 @@ These databases are exempted from failover by using the ExcludeDatabaseList para ### -DatabaseType +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of database being failed over. Valid values are: @@ -100,8 +103,7 @@ User ```yaml Type: DatabaseNameType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -110,54 +112,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NewPrincipal +### -ExcludeDatabaseList -Specifies whether failover will be to the primary database or to the mirror database. -Valid values are: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Mirror +List of databases that should not be failed over. +For example: -Primary +`-ExcludeDatabaseList "LcsCDR"` +To prevent multiple databases from being failed over, separate the database names using commas: +`-ExcludeDatabaseList "LcsCDR", "LcsLog"` ```yaml -Type: MirrorRole +Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolFqdn -Fully qualified domain name of the pool containing the database to be failed over. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. +The Force parameter is also used if the current database is not accessible. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves topology information from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,54 +174,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeDatabaseList -List of databases that should not be failed over. -For example: +### -NewPrincipal -`-ExcludeDatabaseList "LcsCDR"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether failover will be to the primary database or to the mirror database. +Valid values are: + +Mirror + +Primary -To prevent multiple databases from being failed over, separate the database names using commas: -`-ExcludeDatabaseList "LcsCDR", "LcsLog"` ```yaml -Type: String[] +Type: MirrorRole Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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 occur when running the command. -The Force parameter is also used if the current database is not accessible. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool containing the database to be failed over. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves topology information from the local replica of the Central Management store rather than from the Central Management store itself. +### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\DatabaseFailover.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,15 +236,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\DatabaseFailover.html"` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -240,13 +255,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -260,14 +277,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsDatabaseFailover cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementServerFailover.md similarity index 85% rename from skype/skype-ps/skype/Invoke-CsManagementServerFailover.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsManagementServerFailover.md index 342f852532..74d8ffdb34 100644 --- a/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementServerFailover.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csmanagementserverfailover applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsManagementServerFailover -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csmanagementserverfailover +schema: 2.0.0 +title: Invoke-CsManagementServerFailover --- # Invoke-CsManagementServerFailover @@ -53,7 +54,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsManagementServerFailover @@ -63,7 +64,7 @@ Invoke-CsManagementServerFailover The command shown in Example 1 fails over the Central Management store for Skype for Business Server. In this case, the existing management store will be replaced by the preassigned database specified in the topology. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsManagementServerFailover -BackupSqlServerFqdn "redmond-cs-001.litwareinc.com" - BackupSqlInstanceName "RTC" -Force @@ -75,57 +76,52 @@ In this case, the existing management store will be replaced by the RTC database ## PARAMETERS -### -BackupSqlServerFqdn - -Fully qualified domain name of the computer hosting the SQL Server backup database. -This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode. +### -BackupMirrorSqlInstanceName +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +SQL Server instance for the mirror database. ```yaml -Type: Fqdn +Type: String Parameter Sets: DisasterRecovery -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +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 occur when running the command. -This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode. - -You should not use the Force parameter if you are running the cmdlet for purposes other than disaster recovery, as it will not account for replication during the failover. -When the parameter is not used, the cmdlet will first make sure all replications are done, then set the source DB to read-only mode. +### -BackupMirrorSqlServerFqdn +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name of the computer hosting the SQL Server mirror database. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: DisasterRecovery -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupMirrorSqlInstanceName -SQL Server instance for the mirror database. +### -BackupSqlInstanceName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SQL Server instance for the backup database. ```yaml Type: String Parameter Sets: DisasterRecovery -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,48 +130,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupMirrorSqlServerFqdn -Fully qualified domain name of the computer hosting the SQL Server mirror database. +### -BackupSqlServerFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the computer hosting the SQL Server backup database. +This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode. + + ```yaml Type: Fqdn Parameter Sets: DisasterRecovery -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupSqlInstanceName -SQL Server instance for the backup database. +### -Force -```yaml -Type: String -Parameter Sets: DisasterRecovery -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. +This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode. + +You should not use the Force parameter if you are running the cmdlet for purposes other than disaster recovery, as it will not account for replication during the failover. +When the parameter is not used, the cmdlet will first make sure all replications are done, then set the source DB to read-only mode. -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: DisasterRecovery +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -183,14 +176,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\CMSFailover.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,13 +195,33 @@ Accept wildcard characters: False ``` ### -Restore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, restores the existing Central Management Server database. ```yaml Type: SwitchParameter Parameter Sets: Normal -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -216,13 +231,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -236,14 +253,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsManagementServerFailover cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementStoreReplication.md similarity index 91% rename from skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsManagementStoreReplication.md index c002ae71c5..5e9761f390 100644 --- a/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementStoreReplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csmanagementstorereplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsManagementStoreReplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csmanagementstorereplication +schema: 2.0.0 +title: Invoke-CsManagementStoreReplication --- # Invoke-CsManagementStoreReplication @@ -47,7 +48,7 @@ Instead, there could be a two to three minute delay as changes are processed by ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Invoke-CsManagementStoreReplication @@ -56,7 +57,7 @@ Invoke-CsManagementStoreReplication In Example 1, the Invoke-CsManagementStoreReplication cmdlet is called without any parameters. This forces replication to take place on all Skype for Business Server computers. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Invoke-CsManagementStoreReplication -ReplicaFqdn atl-cs-001.litwareinc.com @@ -68,41 +69,44 @@ That causes replication to take place only on the computer atl-cs-001.litwareinc ## PARAMETERS -### -ReplicaFqdn - -Fully qualified domain name (FQDN) of the computer where replication should be initiated. -For example: `-ReplicaFqdn "atl-cs-001.litwareinc.com".` - -If this parameter is not included, then replication will be initiated on all your Skype for Business Server computers. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +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. +### -ReplicaFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the computer where replication should be initiated. +For example: `-ReplicaFqdn "atl-cs-001.litwareinc.com".` + +If this parameter is not included, then replication will be initiated on all your Skype for Business Server computers. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -111,13 +115,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsManagementStoreReplication cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Invoke-CsManagementStoreReplication cmdlet does not return any objects. ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsPoolFailBack.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailBack.md similarity index 86% rename from skype/skype-ps/skype/Invoke-CsPoolFailBack.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailBack.md index 99b453decd..aa80db5c7d 100644 --- a/skype/skype-ps/skype/Invoke-CsPoolFailBack.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailBack.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cspoolfailback applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsPoolFailBack -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-cspoolfailback +schema: 2.0.0 +title: Invoke-CsPoolFailBack --- # Invoke-CsPoolFailBack @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsPoolFailback -PoolFqdn "atl-cs-001.litwareinc.com" @@ -58,38 +59,55 @@ In Example 1, failback is invoked for the pool atl-cs-001.litwareinc.com. ## PARAMETERS -### -PoolFqdn +### -DatabaseCommandTimeoutInSeconds -Fully qualified domain name of the pool being failed back. -For example: +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -`-PoolFqdn "atl-cs-001.litwareinc.com"` +The amount of time, in seconds, to wait for database commands to time out. -The pool FQDN used during failback must be the same FQDN used during failover. +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisasterMode + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to invoke pool failback even if the backup pool is currently unavailable. +When you use this parameter, data generated by the failed-over users on the backup pool will be lost. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,34 +116,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisasterMode +### -PoolFqdn -Enables administrators to invoke pool failback even if the backup pool is currently unavailable. -When you use this parameter, data generated by the failed-over users on the backup pool will be lost. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being failed back. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + +The pool FQDN used during failback must be the same FQDN used during failover. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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. +### -SkipDataVerification + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When included in a command, Invoke-CsPoolFailover will proceed with the failover operation without first verifying data integrity. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +160,9 @@ Accept wildcard characters: False ``` ### -WaitTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the maximum amount of time the cmdlet should wait before synching data. Time values must be express using the format hours:minutes:seconds; for example, the following syntax sets the wait time to 1 minute and 30 seconds (00 hours:01:minutes:30 seconds): @@ -145,8 +173,7 @@ The default value is 15 seconds. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,14 +182,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -171,30 +200,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabaseCommandTimeoutInSeconds -The amount of time, in seconds, to wait for database commands to time out. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -SkipDataVerification -When included in a command, Invoke-CsPoolFailover will proceed with the failover operation without first verifying data integrity. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -208,14 +223,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsPoolFailBack cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsPoolFailOver.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailOver.md similarity index 85% rename from skype/skype-ps/skype/Invoke-CsPoolFailOver.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailOver.md index 45d8e8e11f..644dffd905 100644 --- a/skype/skype-ps/skype/Invoke-CsPoolFailOver.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailOver.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cspoolfailover applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsPoolFailOver -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-cspoolfailover +schema: 2.0.0 +title: Invoke-CsPoolFailOver --- # Invoke-CsPoolFailOver @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsPoolFailOver -PoolFqdn "atl-cs-001.litwareinc.com" @@ -57,7 +58,7 @@ Invoke-CsPoolFailOver -PoolFqdn "atl-cs-001.litwareinc.com" The command shown in Example 1 invokes pool failover for the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsPoolFailOver -PoolFqdn "atl-cs-001.litwareinc.com" -DisasterMode @@ -68,36 +69,16 @@ Example 2 invokes disaster mode failover for the pool atl-cs-001.litwareinc.com. ## PARAMETERS -### -PoolFqdn - -Fully qualified domain name of the pool being failed over from. -For example: - -`-PoolFqdn "atl-cs-001.litwareinc.com"` - - +### -DatabaseCommandTimeoutInSeconds -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +The amount of time to wait, in seconds, for database commands to time out. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +89,8 @@ Accept wildcard characters: False ### -DisasterMode +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, indicates that failover is being performed in "disaster mode." If a pool is no longer accessible the only way to restore full functionality to users in that pool is to fail over the pool by using the DisasterMode parameter. 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. @@ -119,8 +102,7 @@ Note: The parameters required for an Enterprise pool if the backend SQL services ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +113,8 @@ Accept wildcard characters: False ### -FlushStorageService +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, the Invoke-CsPoolFailOver cmdlet will both fail over all the users in the pool, and call the Invoke-CsStorageServiceFlush cmdlet to flush the storage service database on each Front End server in the pool. Flushing a database involves writing all the queued data to disk, and then clearing the database cache. @@ -139,8 +123,7 @@ Flushing a database involves writing all the queued data to disk, and then clear ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,13 +133,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,14 +150,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WaitTime -Specifies the amount of time (in seconds) that the cmdlet will wait before assuming that the data has been synced from the failed-over pool to the backup pool. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being failed over from. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + + ```yaml -Type: TimeSpan +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicesStopDelayMins + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies a number of minutes to wait for the services to stop. + +```yaml +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,14 +191,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SkipDataVerification + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When included in a command, Invoke-CsPoolFailback will proceed with the failback operation without first verifying data integrity. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,14 +209,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabaseCommandTimeoutInSeconds -The amount of time to wait, in seconds, for database commands to time out. +### -WaitTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in seconds) that the cmdlet will wait before assuming that the data has been synced from the failed-over pool to the backup pool. ```yaml -Type: Int32 +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,14 +227,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServicesStopDelayMins -Specifies a number of minutes to wait for the services to stop. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -229,14 +245,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipDataVerification -When included in a command, Invoke-CsPoolFailback will proceed with the failback operation without first verifying data integrity. +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -250,14 +268,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsPoolFailOver cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsQoEDatabasePurge.md similarity index 88% rename from skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsQoEDatabasePurge.md index 573235dd3b..f09e0b15e7 100644 --- a/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsQoEDatabasePurge.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csqoedatabasepurge applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsQoEDatabasePurge -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csqoedatabasepurge +schema: 2.0.0 +title: Invoke-CsQoEDatabasePurge --- # Invoke-CsQoEDatabasePurge @@ -55,7 +56,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsQoEDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -PurgeQoEDataOlderThanDays 10 @@ -64,7 +65,7 @@ Invoke-CsQoEDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litw The command shown in Example 1 purges all the QoE records more than 10 days old from the monitoring database on atl-sql-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsQoEDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -PurgeQoEDataOlderThanDays 10 -Confirm:$False @@ -77,7 +78,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1; That syntax suppresses the confirmation prompts that would otherwise appear when purging QoE records. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsService -MonitoringDatabase | Invoke-CsQoEDatabasePurge -PurgeQoEDataOlderThanDays 10 -Confirm:$False ``` @@ -90,7 +91,28 @@ In turn, the ForEach-Object cmdlet takes each database in the collection and the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database to be purged. You can retrieve the Identities for your monitoring databases by running this command: @@ -101,8 +123,7 @@ Note that you cannot use the Identity parameter and the SqlServerFqdn parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -112,6 +133,9 @@ Accept wildcard characters: False ``` ### -PurgeQoEDataOlderThanDays + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the age (in days) of the QoE records to be purged from the database; any records older than this value will be deleted. PurgeQoEDataOlderThanHours can be set to any integer value between 1 and 2147483647, inclusive. @@ -119,8 +143,7 @@ PurgeQoEDataOlderThanHours can be set to any integer value between 1 and 2147483 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -129,70 +152,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name of the computer where the QoE database is located. -For example: +### -SqlInstanceName -`-SqlServerFqdn "atl-sql-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. +SQL Server instance name for the QoE database. +For example: + +`-SqlInstanceName "archinst"` ```yaml Type: String Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SqlServerFqdn -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Fully qualified domain name of the computer where the QoE database is located. +For example: -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +`-SqlServerFqdn "atl-sql-001.litwareinc.com"` + +Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: SqlServer +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -SQL Server instance name for the QoE database. -For example: +### -Confirm -`-SqlInstanceName "archinst"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -202,13 +215,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -222,12 +237,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase#Decorated The Invoke-CsQoEDatabasePurge cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase#Decorated class. ## OUTPUTS -### +### Microsoft.Rtc.Management.Purge.QoEDataPurgeStatistics The Invoke-CsQoEDatabasePurge cmdlet returns instances of the Microsoft.Rtc.Management.Purge.QoEDataPurgeStatistics class. ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsRgsStoreReplicateData.md similarity index 79% rename from skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsRgsStoreReplicateData.md index a62fee6b1d..edcfdd3f7a 100644 --- a/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsRgsStoreReplicateData.md @@ -1,16 +1,17 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csrgsstorereplicatedata applicable: Skype for Business Server 2019 -title: Invoke-CsRGSStoreReplicateData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csrgsstorereplicatedata +schema: 2.0.0 +title: Invoke-CsRgsStoreReplicateData --- -# Invoke-CsRGSStoreReplicateData +# Invoke-CsRgsStoreReplicateData ## SYNOPSIS Replicate existing RGS data present on the specified pool to the backup tables so that data can be picked up by RGSBackupService. @@ -18,11 +19,11 @@ Replicate existing RGS data present on the specified pool to the backup tables s ## SYNTAX ``` -Invoke-CsRGSStoreReplicateData -PoolFqdn [-Force] [] +Invoke-CsRgsStoreReplicateData -PoolFqdn [-Force] [] ``` ## DESCRIPTION -The Invoke-CsRGSStoreReplicateData cmdlet enables administrators to replicate existing RGS data(RGS entities created before CU1 installation) present on the specified pool to the backup tables so that data can be picked by backupservice. Backup service will sync RGS data to the paired pool if RGSBackupSerice in enabled. +The Invoke-CsRgsStoreReplicateData cmdlet enables administrators to replicate existing RGS data(RGS entities created before CU1 installation) present on the specified pool to the backup tables so that data can be picked by backupservice. Backup service will sync RGS data to the paired pool if RGSBackupSerice in enabled. Skype for Business Server Control Panel: The functions carried out by the Invoke- CsRGSStoreReplicateData cmdlet are not available in the Skype for Business Server Control Panel. @@ -30,7 +31,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ### Example 1 ``` -Invoke-CsRGSStoreReplicateData -PoolFqdn "atl-cs-001.litwareinc.com" +Invoke-CsRgsStoreReplicateData -PoolFqdn "atl-cs-001.litwareinc.com" ``` The command shown in Example 1 replicates the RGS data for the pool atl-cs-001.litwareinc.com to the back up table. @@ -38,13 +39,15 @@ The command shown in Example 1 replicates the RGS data for the pool atl-cs-001.l ## PARAMETERS ### -Force + +> Applicable: Skype for Business Server 2019CU1 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -54,6 +57,9 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Skype for Business Server 2019CU1 + Fully qualified domain name of the pool whose data will be replicated. For example: `-PoolFqdn "atl-cs-001.litwareinc.com"` @@ -62,7 +68,6 @@ For example: Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019CU1 Required: True Position: Named @@ -75,7 +80,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None. The Invoke-CsRGSStoreReplicateData cmdlet does not accept pipelined data. +### None. The Invoke-CsRgsStoreReplicateData cmdlet does not accept pipelined data. ## OUTPUTS diff --git a/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsStorageServiceFlush.md similarity index 88% rename from skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsStorageServiceFlush.md index 90e2298abf..e99d0c107b 100644 --- a/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsStorageServiceFlush.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csstorageserviceflush applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsStorageServiceFlush -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csstorageserviceflush +schema: 2.0.0 +title: Invoke-CsStorageServiceFlush --- # Invoke-CsStorageServiceFlush @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsStorageServiceFlush -PoolFqdn "atl-cs-001.litwareinc.com" -FlushType "SteadyState" @@ -60,67 +61,53 @@ In a steady state flush, the only data removed from the queue (and written to di ## PARAMETERS -### -FlushType - -Specifies the type of storage flush to be performed. -Allowed values are: - -SteadyState - The only data that will be flushed is data that can be removed from the queue without affecting normal operations of the storage service. -This is typically done to remove older data from the queue. +### -Binding -FullFlush - Flushes all the data from the queue. -This is typically used when a pool is being failed over, and when there is no expectation that the queue will be receiving any new data. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Windows Communication Foundation (WCF) binding. +A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. +valid values are: +NetNamedPipe -```yaml -Type: FlushType -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +NetTCP -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -PoolFqdn -Fully qualified domain name of the pool containing the storage service to be flushed. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: b -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Binding +### -FlushType -Windows Communication Foundation (WCF) binding. -A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. -valid values are: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -NetNamedPipe +Specifies the type of storage flush to be performed. +Allowed values are: -NetTCP +SteadyState - The only data that will be flushed is data that can be removed from the queue without affecting normal operations of the storage service. +This is typically done to remove older data from the queue. + +FullFlush - Flushes all the data from the queue. +This is typically used when a pool is being failed over, and when there is no expectation that the queue will be receiving any new data. ```yaml -Type: String +Type: FlushType Parameter Sets: (All) -Aliases: b -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -128,13 +115,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +134,8 @@ Accept wildcard characters: False ### -HostNameStorageService +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the server where the Skype for Business Server Storage Service is running. This parameter is required if the Binding is set to NetTCP. @@ -154,7 +145,6 @@ This parameter is required if the Binding is set to NetTCP. Type: String Parameter Sets: (All) Aliases: h -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -163,14 +153,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool containing the storage service to be flushed. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WaitTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the maximum amount of time the cmdlet will wait before assuming that flushing has begun and moving on to the next step in the flushing process. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,14 +194,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsStorageServiceFlush cmdlet does not accept pipelined data. ## OUTPUTS -### -String value. +### System.Stringvalue. ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsUcsRollback.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsUcsRollback.md similarity index 87% rename from skype/skype-ps/skype/Invoke-CsUcsRollback.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsUcsRollback.md index b0d139bbd3..03518eb58d 100644 --- a/skype/skype-ps/skype/Invoke-CsUcsRollback.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsUcsRollback.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Invoke-CsUcsRollback -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csucsrollback +schema: 2.0.0 +title: Invoke-CsUcsRollback --- # Invoke-CsUcsRollback @@ -51,7 +53,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsUcsRollback -Identity "Ken Myer" @@ -60,7 +62,7 @@ Invoke-CsUcsRollback -Identity "Ken Myer" The command shown in Example 1 removes the user Ken Myer from the unified contact store. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Invoke-CsUcsRollback -Confirm:$False @@ -74,38 +76,32 @@ In order to suppress the confirmation prompt that would otherwise occur each tim ## PARAMETERS -### -Identity - -Indicates the Identity of the user account to be rolled back. -User Identities are typically 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). - -You can also reference a user account by using the user's Active Directory distinguished name. +### -DomainController -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". +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to connect to the specified domain controller in order to retrieve user information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml -Type: UserIdParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Force -Prompts you for confirmation before executing the command. -To prevent a confirmation prompt from appearing each time you roll back a user account use this syntax: +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`-Confirm:$False` +Suppresses the display of any non-fatal error message that might arise when running the command. @@ -113,8 +109,7 @@ To prevent a confirmation prompt from appearing each time you roll back a user a ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,29 +118,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be rolled back. +User Identities are typically 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). + +You can also reference a user account 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". -Enables you to connect to the specified domain controller in order to retrieve user information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force +### -PassThru -Suppresses the display of any non-fatal error message that might arise when running the command. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being removed from the Unified Contact Store. +By default, the Invoke-CsUcsRollback cmdlet does not pass objects through the pipeline. @@ -153,8 +158,7 @@ Suppresses the display of any non-fatal error message that might arise when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,10 +167,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Confirm -Enables you to pass a user object through the pipeline that represents the user account being removed from the Unified Contact Store. -By default, the Invoke-CsUcsRollback cmdlet does not pass objects through the pipeline. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. +To prevent a confirmation prompt from appearing each time you roll back a user account use this syntax: + +`-Confirm:$False` @@ -174,8 +182,7 @@ By default, the Invoke-CsUcsRollback cmdlet does not pass objects through the pi ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -186,6 +193,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -194,7 +203,6 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -208,22 +216,21 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser Invoke-CsUcsRollback accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ### Microsoft.Rtc.Management.AD.UserIdParameter -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The Invoke-CsUcsRollback cmdlet accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### -None. +### None ### System.Object diff --git a/skype/skype-ps/skype/Lock-CsClientPin.md b/skype/skype-ps/SkypeForBusiness/Lock-CsClientPin.md similarity index 90% rename from skype/skype-ps/skype/Lock-CsClientPin.md rename to skype/skype-ps/SkypeForBusiness/Lock-CsClientPin.md index 4e7c015374..26255993b9 100644 --- a/skype/skype-ps/skype/Lock-CsClientPin.md +++ b/skype/skype-ps/SkypeForBusiness/Lock-CsClientPin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/lock-csclientpin applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Lock-CsClientPin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/lock-csclientpin +schema: 2.0.0 +title: Lock-CsClientPin --- # Lock-CsClientPin @@ -48,7 +49,7 @@ That means that you will not be able to run the Lock-CsClientPin cmdlet from a r ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Lock-CsClientPin -Identity "kenmyer@litwareinc.com" @@ -57,7 +58,7 @@ Lock-CsClientPin -Identity "kenmyer@litwareinc.com" In Example 1, the Lock-CsClientPin cmdlet is used to lock the PIN belonging to the user kenmyer@litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser | Get-CsClientPinInfo | Where-Object {$_.IsPinSet -eq $True} | Lock-CsClientPin @@ -69,7 +70,7 @@ That collection is piped to the Get-CsClientPinInfo cmdlet, which is used, in co That filtered collection is then piped to the Lock-CsClientPin cmdlet, which locks the PIN for each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser | Get-CsClientPinInfo | Where-Object {$_.PinExpirationTime -lt (Get-Date)} | Lock-CsClientPin @@ -85,7 +86,28 @@ After that, the Lock-CsClientPin cmdlet is used to lock each of the expired PINs ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the user account for which the PIN should be locked. 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). You can also reference user Identities by using the user's Active Directory distinguished name. @@ -96,8 +118,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -106,14 +127,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -123,29 +146,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -159,14 +168,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Lock-CsClientPin cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.UserPinService.PinInfoDetails The Lock-CsClientPin cmdlet does not return a value or object. Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Management.UserPinService.PinInfoDetails object. diff --git a/skype/skype-ps/skype/Merge-CsLegacyTopology.md b/skype/skype-ps/SkypeForBusiness/Merge-CsLegacyTopology.md similarity index 90% rename from skype/skype-ps/skype/Merge-CsLegacyTopology.md rename to skype/skype-ps/SkypeForBusiness/Merge-CsLegacyTopology.md index c472df4e40..d6c67daeb3 100644 --- a/skype/skype-ps/skype/Merge-CsLegacyTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Merge-CsLegacyTopology.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/merge-cslegacytopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Merge-CsLegacyTopology -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/merge-cslegacytopology +schema: 2.0.0 +title: Merge-CsLegacyTopology --- # Merge-CsLegacyTopology @@ -63,7 +64,7 @@ If you do not do this no Edge Servers will be included in your merged topology. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Merge-CsLegacyTopology -TopologyXmlFileName C:\New_Topology.xml @@ -73,7 +74,7 @@ The command shown in Example 1 merges topology information and trusted service e The required parameter TopologyXmlFileName is used to indicate the path to the output file generated when you run the Merge-CsLegacyTopology cmdlet. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Merge-CsLegacyTopology -TopologyXmlFileName C:\New_Topology.xml -UserInputFileName C:\EdgeServers.xml @@ -86,109 +87,121 @@ The parameter value C:\EdgeServers.xml points to a custom XML file containing Ed ## PARAMETERS -### -TopologyXmlFileName - -Path to the output file to be created when the Merge-CsLegacyTopology cmdlet is run. -Note that this file differs from the file specified using the Report parameter; the latter file is used for recording error information while the Topology XML file contains your newly created Skype for Business Server topology. -This file will later be used to publish the new topology. - -If the specified file already exists, it will be overwritten when you run the Merge-CsLegacyTopology cmdlet. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: Topology -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserInputFileName - -Path to the XML file used to import Edge Server data from an earlier version of Skype for Business Server. -This XML file (which you must create following the guidelines detailed in the Skype for Business Server Deployment Guide) is required because Edge Server settings are not stored in Active Directory Domain Services. -If you do not need to import Edge Server information, then this parameter can be omitted. - -If this parameter is not used, remote and external access features (including federation) might not function as expected in an environment running both Communications Server 2007 R2 or Communications Server 2007 R2 and . +### -Report +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\MergeTopology.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +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 occur when running the command. +### -Reserved + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to merge the topology using a topology object instead of a topology XML file. + + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: PartialTopology +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\MergeTopology.html"` +### -TopologyXmlFileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the output file to be created when the Merge-CsLegacyTopology cmdlet is run. +Note that this file differs from the file specified using the Report parameter; the latter file is used for recording error information while the Topology XML file contains your newly created Skype for Business Server topology. +This file will later be used to publish the new topology. + +If the specified file already exists, it will be overwritten when you run the Merge-CsLegacyTopology cmdlet. + + ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: Topology +Aliases: -Required: False -Position: Named +Required: True +Position: 1 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. +### -UserInputFileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the XML file used to import Edge Server data from an earlier version of Skype for Business Server. +This XML file (which you must create following the guidelines detailed in the Skype for Business Server Deployment Guide) is required because Edge Server settings are not stored in Active Directory Domain Services. +If you do not need to import Edge Server information, then this parameter can be omitted. + +If this parameter is not used, remote and external access features (including federation) might not function as expected in an environment running both Communications Server 2007 R2 or Communications Server 2007 R2 and . + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -197,19 +210,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Reserved - -Enables you to merge the topology using a topology object instead of a topology XML file. +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: PSObject -Parameter Sets: PartialTopology -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -221,13 +233,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Merge-CsLegacyTopology cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Merge-CsLegacyTopology cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Move-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Move-CsAnalogDevice.md similarity index 72% rename from skype/skype-ps/skype/Move-CsAnalogDevice.md rename to skype/skype-ps/SkypeForBusiness/Move-CsAnalogDevice.md index 70102968cd..b18f28a8ea 100644 --- a/skype/skype-ps/skype/Move-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsAnalogDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsAnalogDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csanalogdevice +schema: 2.0.0 +title: Move-CsAnalogDevice --- # Move-CsAnalogDevice @@ -22,25 +23,18 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### Identity (Default) ``` -Move-CsAnalogDevice [-Identity] [-Target] [-DomainController ] - [-ProxyPool ] [-Force] [-PassThru] [-WhatIf] [-Confirm] [-IgnoreBackendStoreException] - [] -``` - -### Identity -``` -Move-CsAnalogDevice [-Identity] [-Target] [-Confirm] [-DomainController ] - [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] [-Report ] [-WhatIf] - [] +Move-CsAnalogDevice [-Target] [-Report ] [-Force] [-UseLegacyMode] + [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-Identity] + [-PassThru] [-WhatIf] [-Confirm] [] ``` ### Users ``` -Move-CsAnalogDevice [-Target] -UserList [-ConcurrentMovesPerFE ] [-Confirm] - [-DomainController ] [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] - [-Report ] [-WhatIf] [] +Move-CsAnalogDevice [-Target] -UserList [-Report ] [-Force] [-UseLegacyMode] + [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -56,10 +50,9 @@ After a device has been associated with a contact object, you can then manage th The Move-CsAnalogDevice cmdlet provides a way for you to move an existing analog device to a new Registrar pool. - ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsAnalogDevice -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com" -Target atl-cs-001.litwareinc.com @@ -68,7 +61,7 @@ Move-CsAnalogDevice -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redm The command shown in Example 1 moves the analog device with the Identity CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com to the Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsAnalogDevice | Where-Object {$_.DisplayName -eq "Building 14, Room 142"} | Move-CsAnalogDevice -Target atl-cs-001.litwareinc.com @@ -80,7 +73,7 @@ This collection is then piped to the Where-Object cmdlet, which picks out all th That filtered collection is then piped to the Move-CsAnalogDevice cmdlet, which moves all of the devices in the collection to the Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsAnalogDevice | Where-Object {$_.DisplayName -like "Building 14*"} | Move-CsAnalogDevice -Target atl-cs-001.litwareinc.com @@ -94,120 +87,114 @@ The filtered collection is then piped to the Move-CsAnalogDevice cmdlet, which m ## PARAMETERS -### -Identity -Unique identifier for the analog device. -Analog devices are identified by using the Active Directory distinguished name of the associated contact object. -By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. - -```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DomainController -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Target -The fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the analog device should be moved. -In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. +Enables you to connect to the specified domain controller in order to move the analog device. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to move the analog device. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (for example, atl-cs-001.litwareinc.com). +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, moves the analog device but deletes any associated data (such as policies that were assigned to the device). +If not present, the device is moved along with any associated data. ```yaml -Type: Fqdn +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyPool - -This parameter is used only for Skype for Business Online. -It should not be used with an on-premises implementation of Skype for Business Server. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier for the analog device. +Analog devices are identified by using the Active Directory distinguished name of the associated contact object. +By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Microsoft.Rtc.Management.AD.UserIdParameter +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -If present, moves the analog device but deletes any associated data (such as policies that were assigned to the device). -If not present, the device is moved along with any associated data. +### -IgnoreBackendStoreException + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the common area phone despite those errors. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user account being moved. By default, the Move-CsAnalogDevice cmdlet does not pass objects through the pipeline. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ProxyPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is used only for Skype for Business Online. +It should not be used with an on-premises implementation of Skype for Business Server. + + ```yaml -Type: SwitchParameter +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -216,14 +203,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -232,14 +221,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the common area phone despite those errors. +### -Target + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the analog device should be moved. +In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. + +```yaml +Type: Microsoft.Rtc.Management.Deploy.Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseLegacyMode +{{ Fill UseLegacyMode Description }} ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -249,13 +256,15 @@ Accept wildcard characters: False ``` ### -UserList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: String ```yaml -Type: String +Type: System.String Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -264,50 +273,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentMovesPerFE -PARAMVALUE: Int32 +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 -Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -PARAMVALUE: String +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String -Parameter Sets: Identity, Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -String. +### System.String The Move-CsAnalogDevice cmdlet accepts a pipelined string value that represents the Identity of the analog device. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact By default, the Move-CsAnalogDevice cmdlet does not return any objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. diff --git a/skype/skype-ps/skype/Move-CsApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Move-CsApplicationEndpoint.md similarity index 83% rename from skype/skype-ps/skype/Move-CsApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Move-CsApplicationEndpoint.md index 1947fce031..8a2190362f 100644 --- a/skype/skype-ps/skype/Move-CsApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csapplicationendpoint +schema: 2.0.0 +title: Move-CsApplicationEndpoint --- # Move-CsApplicationEndpoint @@ -41,7 +42,7 @@ Also, if an application originally designed to work against Skype for Business S ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsApplicationEndpoint -Identity sip:endpoint1@litwareinc.com -TargetApplicationPool TrustPoolA.litwareinc.com @@ -51,7 +52,7 @@ This example moves the application endpoint contact object with the SIP address Use this command to upgrade a UCMA 2.0 application to a Skype for Business Server application after coexistence. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Move-CsApplicationEndpoint -Identity sip:endpoint2@litwareinc.com -TargetApplicationPool TrustPoolA.litwareinc.com -Force @@ -65,68 +66,74 @@ This will update an existing object in Active Directory with the necessary attri ## PARAMETERS -### -Identity -The SIP address or distinguished name (DN) of the endpoint contact you want to move. +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. ```yaml -Type: UserIdParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetApplicationPool -The fully qualified domain name (FQDN) of the pool to which the endpoint is moving. -The target pool must have a Registrar service dependency. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This flag is required if you are moving a Microsoft Unified Communications Managed API (UCMA) 2.0 contact object to the same pool but on a Skype for Business Server deployment. +This will force routing to occur through the Skype for Business Server Registrar. + + ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: Target -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP address or distinguished name (DN) of the endpoint contact you want to move. ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force - -This flag is required if you are moving a Microsoft Unified Communications Managed API (UCMA) 2.0 contact object to the same pool but on a Skype for Business Server deployment. -This will force routing to occur through the Skype for Business Server Registrar. +### -IgnoreBackendStoreException +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the application endpoint despite those errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,13 +143,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifying this parameter will return the application endpoint object after the object has been moved. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,30 +160,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -TargetApplicationPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the pool to which the endpoint is moving. +The target pool must have a Registrar service dependency. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Target -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -183,14 +197,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the application endpoint despite those errors. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -204,13 +220,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of an application endpoint. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact. ## NOTES diff --git a/skype/skype-ps/skype/Move-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Move-CsCommonAreaPhone.md similarity index 77% rename from skype/skype-ps/skype/Move-CsCommonAreaPhone.md rename to skype/skype-ps/SkypeForBusiness/Move-CsCommonAreaPhone.md index 55cd8f84f2..7c5968f18f 100644 --- a/skype/skype-ps/skype/Move-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsCommonAreaPhone.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsCommonAreaPhone -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-cscommonareaphone +schema: 2.0.0 +title: Move-CsCommonAreaPhone --- # Move-CsCommonAreaPhone @@ -21,25 +22,18 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### Identity (Default) ``` -Move-CsCommonAreaPhone [-Identity] [-Target] [-DomainController ] - [-ProxyPool ] [-Force] [-PassThru] [-WhatIf] [-Confirm] [-IgnoreBackendStoreException] - [] -``` - -### Identity -``` -Move-CsCommonAreaPhone [-Identity] [-Target] [-Confirm] [-DomainController ] - [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] [-Report ] [-WhatIf] - [] +Move-CsCommonAreaPhone [-Target] [-Report ] [-Force] [-UseLegacyMode] + [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-Identity] + [-PassThru] [-WhatIf] [-Confirm] [] ``` ### Users ``` -Move-CsCommonAreaPhone [-Target] -UserList [-ConcurrentMovesPerFE ] [-Confirm] - [-DomainController ] [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] - [-Report ] [-WhatIf] [] +Move-CsCommonAreaPhone [-Target] -UserList [-Report ] [-Force] [-UseLegacyMode] + [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -58,10 +52,9 @@ For example, if you do not want people to have the ability to transfer or park c The Move-CsCommonAreaPhone cmdlet enables you to move an existing common area phone to a new Registrar pool. - ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsCommonAreaPhone -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com" -Target atl-cs-001.litwareinc.com @@ -69,7 +62,7 @@ Move-CsCommonAreaPhone -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=R The command shown in Example 1 moves the common area phone with the Identity CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com to the Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsCommonAreaPhone | Where-Object {$_.DisplayName -eq "Building 31 Cafeteria"} | Move-CsCommonAreaPhone -Target atl-cs-001.litwareinc.com @@ -80,7 +73,7 @@ To do this, the Get-CsCommonAreaPhone cmdlet is first called without any paramet This collection is then piped to the Where-Object cmdlet, which picks out only those phones where the DisplayName attribute is equal to "Building 31 Cafeteria." That filtered collection is then piped to the Move-CsCommonAreaPhone cmdlet, which moves each phone in the collection to atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsCommonAreaPhone | Where-Object {$_.RegistrarPool -match "dublin-cs-001.litwareinc.com"} | Move-CsCommonAreaPhone -Target atl-cs-001.litwareinc.com @@ -91,7 +84,7 @@ To carry out this task, the command first calls the Get-CsCommonAreaPhone cmdlet This collection is then piped to the Where-Object cmdlet, which picks out all the common area phones where the RegistrarPool is equal to dublin-cs-001.litwareinc.com. This collection is then piped to the Move-CsCommonAreaPhone cmdlet, which moves each phone in the collection to the new Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsCommonAreaPhone | Where-Object {$_.RegistrarPool -match "dublin-cs-001.litwareinc.com"} | Move-CsCommonAreaPhone -Target atl-cs-001.litwareinc.com -PassThru | Grant-CsVoicePolicy -PolicyName AtlantaVoicePolicy @@ -104,120 +97,114 @@ To do this, the PassThru parameter is included when calling the Move-CsCommonAre ## PARAMETERS -### -Identity -Unique identifier for the common area phone. -Common area phones are identified using the Active Directory distinguished name of the associated contact object. -By default, common area phones use a globally unique identifier (GUID) as their common name, which means that phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. - -```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DomainController -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Target -The fully qualified domain name (FQDN) of the Registrar pool where the common area phone should be moved; for example: atl-cs-001.litwareinc.com. -In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. +Enables you to connect to the specified domain controller in order to move the common area phone. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (for example, atl-cs-001.litwareinc.com). ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to move the common area phone. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (for example, atl-cs-001.litwareinc.com). +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, moves the common area phone but deletes any associated data (such as policies that were assigned to the device). +If not present, the phone is moved along with any associated data. ```yaml -Type: Fqdn +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyPool - -This parameter is used only for Skype for Business Online. -It should not be used with an on-premises implementation of Skype for Business Server. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier for the common area phone. +Common area phones are identified using the Active Directory distinguished name of the associated contact object. +By default, common area phones use a globally unique identifier (GUID) as their common name, which means that phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Microsoft.Rtc.Management.AD.UserIdParameter +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -If present, moves the common area phone but deletes any associated data (such as policies that were assigned to the device). -If not present, the phone is moved along with any associated data. +### -IgnoreBackendStoreException + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the common area phone despite those errors. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user account being moved. By default, the Move-CsCommonAreaPhone cmdlet does not pass objects through the pipeline. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ProxyPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is used only for Skype for Business Online. +It should not be used with an on-premises implementation of Skype for Business Server. + + ```yaml -Type: SwitchParameter +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -226,14 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -242,14 +231,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the common area phone despite those errors. +### -Target + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the Registrar pool where the common area phone should be moved; for example: atl-cs-001.litwareinc.com. +In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. + +```yaml +Type: Microsoft.Rtc.Management.Deploy.Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseLegacyMode +{{ Fill UseLegacyMode Description }} ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -259,13 +266,15 @@ Accept wildcard characters: False ``` ### -UserList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: String ```yaml -Type: String +Type: System.String Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -274,34 +283,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentMovesPerFE -PARAMVALUE: Int32 +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 -Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -PARAMVALUE: String +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String -Parameter Sets: Identity, Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -311,13 +324,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String The Move-CsCommonAreaPhone cmdlet accepts a pipelined string value that represents the Identity of the common area phone. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact By default, the Move-CsCommonAreaPhone cmdlet does not return any objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. diff --git a/skype/skype-ps/skype/Move-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Move-CsConferenceDirectory.md similarity index 87% rename from skype/skype-ps/skype/Move-CsConferenceDirectory.md rename to skype/skype-ps/SkypeForBusiness/Move-CsConferenceDirectory.md index 239a0646db..fd92131772 100644 --- a/skype/skype-ps/skype/Move-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsConferenceDirectory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsConferenceDirectory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csconferencedirectory +schema: 2.0.0 +title: Move-CsConferenceDirectory --- # Move-CsConferenceDirectory @@ -48,7 +49,7 @@ For example, this command backs up conference directory 3 to the file C:\Logs\Co ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsConferenceDirectory -Identity 3 -TargetPool atl-cs-002.litwareinc.com @@ -57,7 +58,7 @@ Move-CsConferenceDirectory -Identity 3 -TargetPool atl-cs-002.litwareinc.com The command shown in Example 1 moves the conference directory with the Identity 3 to the pool atl-cs-002.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Move-CsConferenceDirectory -Identity 3 -TargetPool atl-cs-002.litwareinc.com -Force @@ -67,7 +68,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1. In this case, however, the Force parameter is included to ensure that the move takes place even if the target pool is currently unavailable. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsConferenceDirectory | Move-CsConferenceDirectory -TargetPool atl-cs-002.litwareinc.com @@ -80,14 +81,40 @@ This collection is then piped to the Move-CsConferenceDirectory cmdlet, which mo ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, moves the conference directory even if the target pool is currently unavailable. +By default, the Move-CsConferenceDirectory cmdlet will not move directories if the target pool cannot be contacted. + +Before running the Move-CsConferenceDirectory cmdlet, note that if you use the -Force parameter, the dial-in code for existing meetings will be lost. +Users will still be able to join meetings using a Lync client, but unable to dial-in to meetings by phone dial in. + + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Numeric identity of the conference directory to be moved. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -97,14 +124,16 @@ Accept wildcard characters: False ``` ### -TargetPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the pool where the conference directory is to be moved. For example: `-Identity atl-cs-002.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 +Aliases: Required: True Position: Named @@ -113,21 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force - -When present, moves the conference directory even if the target pool is currently unavailable. -By default, the Move-CsConferenceDirectory cmdlet will not move directories if the target pool cannot be contacted. - -Before running the Move-CsConferenceDirectory cmdlet, note that if you use the -Force parameter, the dial-in code for existing meetings will be lost. -Users will still be able to join meetings using a Lync client, but unable to dial-in to meetings by phone dial in. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -137,29 +161,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -173,14 +183,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Move-CsConferenceDirectory cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Move-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Move-CsExUmContact.md similarity index 67% rename from skype/skype-ps/skype/Move-CsExUmContact.md rename to skype/skype-ps/SkypeForBusiness/Move-CsExUmContact.md index fd94b648a5..951916a929 100644 --- a/skype/skype-ps/skype/Move-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsExUmContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsExUmContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csexumcontact +schema: 2.0.0 +title: Move-CsExUmContact --- # Move-CsExUmContact @@ -21,24 +22,18 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) -``` -Move-CsExUmContact [-Identity] [-Target] [-Confirm] [-DomainController ] - [-Force] [-PassThru] [-ProxyPool ] [-WhatIf] [-IgnoreBackendStoreException] [] -``` - -### Identity +### Identity (Default) ``` -Move-CsExUmContact [-Identity] [-Target] [-Confirm] [-DomainController ] - [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] [-Report ] [-WhatIf] +Move-CsExUmContact [-Target] [-Report ] [-Force] [-UseLegacyMode] [-IgnoreBackendStoreException] + [-ProxyPool ] [-DomainController ] [-Identity] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### Users ``` -Move-CsExUmContact [-Target] -UserList [-ConcurrentMovesPerFE ] [-Confirm] - [-DomainController ] [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] - [-Report ] [-WhatIf] [] +Move-CsExUmContact [-Target] -UserList [-Report ] [-Force] [-UseLegacyMode] + [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -52,7 +47,7 @@ When an Exchange UM contact object is moved, the AutoAttendant and IsSubscriberA ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsExUmContact -Identity "sip:exum1@fabrikam.com" -Target atl-cs-001.litwareinc.com @@ -63,7 +58,7 @@ Note that a confirmation prompt will be displayed when you run this command, eve This prompt will appear even if you include the Force parameter. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsExUmContact | Where-Object {$_.AutoAttendant -eq $True} | Move-CsExUmContact -Target atl-cs-001.litwareinc.com @@ -80,47 +75,35 @@ As in Example 1, you will be prompted for confirmation when running this command ## PARAMETERS -### -Identity -The unique identifier of the contact object you want to move. -Contact identities can be specified by using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant). +### -DomainController -```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Target -The fully qualified domain name (FQDN) of the Registrar pool to which the contact is being moved. +Enables you to connect to the specified domain controller. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its FQDN (for example, atl-mcs-001.litwareinc.com). ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,68 +112,75 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its FQDN (for example, atl-mcs-001.litwareinc.com). +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the contact object you want to move. +Contact identities can be specified by using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant). ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Microsoft.Rtc.Management.AD.UserIdParameter +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -IgnoreBackendStoreException + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the contact despite those errors. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a contact object through the pipeline that represents the contact account being moved. By default, the Move-CsExUmContact cmdlet does not pass objects through the pipeline. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -ProxyPool +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is used only for hosted instances of Skype for Business Server. It should not be used with an on-premises implementation of Skype for Business Server. ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,14 +189,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,14 +207,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the contact despite those errors. +### -Target + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the Registrar pool to which the contact is being moved. + +```yaml +Type: Microsoft.Rtc.Management.Deploy.Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseLegacyMode +{{ Fill UseLegacyMode Description }} ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -232,13 +241,15 @@ Accept wildcard characters: False ``` ### -UserList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: String ```yaml -Type: String +Type: System.String Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -247,50 +258,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentMovesPerFE -PARAMVALUE: Int32 +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 -Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -PARAMVALUE: String +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String -Parameter Sets: Identity, Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of an Exchange UM object to be moved. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact When called with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact. ## NOTES diff --git a/skype/skype-ps/skype/Move-CsLegacyUser.md b/skype/skype-ps/SkypeForBusiness/Move-CsLegacyUser.md similarity index 84% rename from skype/skype-ps/skype/Move-CsLegacyUser.md rename to skype/skype-ps/SkypeForBusiness/Move-CsLegacyUser.md index 9bc5c5ed52..b7235c61b5 100644 --- a/skype/skype-ps/skype/Move-CsLegacyUser.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsLegacyUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-cslegacyuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsLegacyUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-cslegacyuser +schema: 2.0.0 +title: Move-CsLegacyUser --- # Move-CsLegacyUser @@ -53,7 +54,7 @@ Before you can run the Merge-CsLegacyTopology, cmdlet you must first install the ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsLegacyUser -Identity "Pilar Ackerman" -Target "atl-cs-001.litwareinc.com" @@ -64,7 +65,7 @@ Because no additional parameters are included, any policies or settings previous That means that, if a legacy policy (such as a dial plan) was assigned to Pilar Ackerman, she will be assigned the Skype for Business Server equivalent when her account is moved. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Move-CsLegacyUser -Identity "Pilar Ackerman" -Target "atl-cs-001.litwareinc.com" -ExcludeDialPlan @@ -74,7 +75,7 @@ The command shown in Example 2 migrates Pilar Ackerman's user account, but does After the account is migrated, Pilar will not have an assigned dial plan. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -OU "ou=Finance,dc=litwareinc,dc=com" | Move-CsLegacyUser -Target "atl-cs-001.litwareinc.com" @@ -86,7 +87,7 @@ After the accounts have been retrieved, the collection is piped to the Move-CsLe This command assumes that all the users in the Finance OU are legacy users. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -UnassignedUser | Move-CsLegacyUser -Target "atl-cs-001.litwareinc.com" @@ -100,53 +101,39 @@ This example assumes that all of the unassigned users are legacy users. ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be migrated. -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 Domain Services display name (for example, Ken Myer). -User Identities can also be reference 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 with a display name that ends with the string value " Smith". +### -Credential -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, 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 -``` +Enables you to run the Move-CsLegacyUser cmdlet under alternate credentials. +This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. -### -Target -FQDN of the Registrar pool where the user account should be homed. -For example: `-Target atl-cs-001.litwareinc.com.` +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. ```yaml -Type: Fqdn +Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to move a user account. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,13 +143,15 @@ Accept wildcard characters: False ``` ### -ExcludeArchivingPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any archiving policies assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,13 +161,15 @@ Accept wildcard characters: False ``` ### -ExcludeConferencingPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any conferencing policies assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,13 +179,15 @@ Accept wildcard characters: False ``` ### -ExcludeDialPlan + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any dial plans assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,13 +197,15 @@ Accept wildcard characters: False ``` ### -ExcludeExternalAccessPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any external access policies assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,13 +215,15 @@ Accept wildcard characters: False ``` ### -ExcludePresencePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any presence policies assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,13 +233,15 @@ Accept wildcard characters: False ``` ### -ExcludeVoicePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any voice policies assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,18 +250,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyPool - -This parameter is used only with Communications Server 2007 R2. -It should not be used with an on-premises implementation of Skype for Business Server. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -271,14 +268,18 @@ 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. +### -HostedMigrationOverrideUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the hosted migration service used when moving a user to the Office 365 version of Skype for Business Server. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -287,31 +288,39 @@ 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 moved. -By default, the Move-CsLegacyUser cmdlet does not pass objects through the pipeline. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be migrated. +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 Domain Services display name (for example, Ken Myer). +User Identities can also be reference 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 with a display name that ends with the string value " Smith". ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -IgnoreBackendStoreException + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the user despite those errors. ```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 +Aliases: Required: False Position: Named @@ -320,14 +329,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being moved. +By default, the Move-CsLegacyUser cmdlet does not pass objects through the pipeline. ```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 +Aliases: Required: False Position: Named @@ -336,18 +348,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential -Enables you to run the Move-CsLegacyUser cmdlet under alternate credentials. -This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. +### -ProxyPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is used only with Communications Server 2007 R2. +It should not be used with an on-premises implementation of Skype for Business Server. + -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. ```yaml -Type: PSCredential +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -356,17 +369,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostedMigrationOverrideUrl +### -Target -URL for the hosted migration service used when moving a user to the Office 365 version of Skype for Business Server. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +FQDN of the Registrar pool where the user account should be homed. +For example: `-Target atl-cs-001.litwareinc.com.` +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -375,14 +406,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the user despite those errors. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -396,13 +429,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Move-CsLegacyUser cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The Move-CsLegacyUser cmdlet does not return any values or objects. Instead, the cmdlet moves instances of the Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. diff --git a/skype/skype-ps/skype/Move-CsManagementServer.md b/skype/skype-ps/SkypeForBusiness/Move-CsManagementServer.md similarity index 82% rename from skype/skype-ps/skype/Move-CsManagementServer.md rename to skype/skype-ps/SkypeForBusiness/Move-CsManagementServer.md index 5e869c100f..929a8b740e 100644 --- a/skype/skype-ps/skype/Move-CsManagementServer.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsManagementServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csmanagementserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsManagementServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csmanagementserver +schema: 2.0.0 +title: Move-CsManagementServer --- # Move-CsManagementServer @@ -21,16 +22,34 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### FromBackup (Default) +``` +Move-CsManagementServer [-ConfigurationFileName ] [-LisConfigurationFileName ] + [-TargetFqdn ] [-Force] [-Report ] [-WhatIf] [-Confirm] [] +``` + +### UseSqlBackup +``` +Move-CsManagementServer [-TargetFqdn ] [-Force] [-Report ] [-WhatIf] [-Confirm] + [] +``` + +### DisasterMode ``` -Move-CsManagementServer [-ConfigurationFileName ] [-LisConfigurationFileName ] [-Force] - [-Report ] [-WhatIf] [-Confirm] [] +Move-CsManagementServer [-TargetFqdn ] [-Force] [-Report ] [-WhatIf] [-Confirm] + [] ``` -### FromBackup +### NonUserPool ``` -Move-CsManagementServer [-ConfigurationFileName ] [-Confirm] [-Force] - [-LisConfigurationFileName ] [-Report ] [-TargetFqdn ] [-WhatIf] [] +Move-CsManagementServer [-TargetFqdn ] [-Force] [-Report ] [-WhatIf] [-Confirm] + [] +``` + +### NonUserPoolDisasterMode +``` +Move-CsManagementServer [-TargetFqdn ] [-Force] [-Report ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -88,7 +107,7 @@ Note that the Move-CsManagementServer cmdlet must be run locally; it cannot be c ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsManagementServer @@ -97,7 +116,7 @@ Move-CsManagementServer The command shown in Example 1 moves the Central Management Server from its existing pool to a new pool. To perform this live migration (that is, to move a Central Management Server that is online and accessible), you must run the command from a computer located in the pool where the server is to be moved. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Move-CsManagementServer -ConfigurationFileName "C:\CsConfiguration.zip" -LisConfigurationFileName "C:\CsLisConfiguration.zip" -Force @@ -112,16 +131,17 @@ In addition, you must include the ConfigurationFileName parameter to import your ### -ConfigurationFileName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Full path to the Skype for Business Server configuration backup file created by running the Export-CsConfiguration cmdlet. This parameter should only be used in a disaster recovery scenario. ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: FromBackup Aliases: CsConfiguration -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -130,37 +150,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LisConfigurationFileName -Full path to the E9-1-1 backup file created by running the Export-CsLisConfiguration cmdlet. -This parameter should only be used in a disaster recovery scenario. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Forces the Central Management Server move even if the existing store is offline; this parameter is required in a disaster recovery scenario. +Note that there is the potential for some data loss any time you force the movement of the Central Management Server. + +The Force parameter can also be used if your previous attempts at calling the Move-CsManagementServer cmdlet have failed. + + ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: CsLisConfiguration -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force - -Forces the Central Management Server move even if the existing store is offline; this parameter is required in a disaster recovery scenario. -Note that there is the potential for some data loss any time you force the movement of the Central Management Server. - -The Force parameter can also be used if your previous attempts at calling the Move-CsManagementServer cmdlet have failed. +### -LisConfigurationFileName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Full path to the E9-1-1 backup file created by running the Export-CsLisConfiguration cmdlet. +This parameter should only be used in a disaster recovery scenario. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.String +Parameter Sets: FromBackup +Aliases: CsLisConfiguration Required: False Position: Named @@ -170,14 +193,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\MoveManagementServer.html"` ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -186,14 +211,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool where the Management Server should be moved to. ```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 +Type: Fqdn +Parameter Sets: FromBackup +Aliases: Required: False Position: Named @@ -203,33 +230,37 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.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 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name of the pool where the Management Server should be moved to. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn -Parameter Sets: FromBackup -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -239,14 +270,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Move-CsManagementServer cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None The Move-CsManagementServer cmdlet does not return any objects. ## NOTES diff --git a/skype/skype-ps/skype/Move-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Move-CsMeetingRoom.md similarity index 87% rename from skype/skype-ps/skype/Move-CsMeetingRoom.md rename to skype/skype-ps/SkypeForBusiness/Move-CsMeetingRoom.md index 25aefd9c8e..87720f64b5 100644 --- a/skype/skype-ps/skype/Move-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsMeetingRoom.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csmeetingroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsMeetingRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csmeetingroom +schema: 2.0.0 +title: Move-CsMeetingRoom --- # Move-CsMeetingRoom @@ -53,14 +54,14 @@ Skype for Business Server Control Panel: The functions carried out by the Move-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Move-CsMeetingRoom -Target "atl-cs-001.litwareinc.com" -Identity "Room 14" ``` The command shown in Example 1 moves the meeting room with the display name "Room 14" to the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingRoom | Move-CsMeetingRoom -Target "atl-cs-001.litwareinc.com" ``` @@ -69,7 +70,7 @@ Example 2 moves all the meeting rooms in the organization to the pool atl-cs-001 To do this, the command first calls the Get-CsMeetingRoom cmdlet without any parameters; that returns a collection of all the meeting rooms configured for use in the organization. That collection is then piped to the Move-CsMeetingRoom cmdlet, which moves each meeting room in the collection to the new pool. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Move-CsMeetingRoom -Identity "Room 15" -HostedMigrationOverrideUrl "https://admin2a.online.lync.com/HostedMigration/hostedmigrationservice.svc" -Target "sipfed.online.lync.com" -Credential $credential ``` @@ -78,48 +79,17 @@ The command shown in Example 3 moves the meeting room with the display name "Roo ## PARAMETERS -### -Identity -Indicates the Identity of the meeting room to be moved. -Meeting rooms can be specified using one of four formats: 1) the room's SIP address; 2) the room's user principal name (UPN); 3) the room's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the room's Active Directory display name (for example, Main Conference Room). -User Identities can also be referenced by using the room's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity -Aliases: -Applicable: Lync Server 2013, 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 -``` - -### -Target -The FQDN (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the meeting room should be moved. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Credential +Enables you to run the Move-CsMeetingRoom cmdlet under alternate credentials. +This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. -### -Confirm -Prompts you for confirmation before executing the command. +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. ```yaml -Type: SwitchParameter +Type: PSCredential Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,14 +99,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to move a meeting room. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,15 +117,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential -Enables you to run the Move-CsMeetingRoom cmdlet under alternate credentials. -This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. +### -Force -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. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the Move-CsMeetingRoom cmdlet to ignore all errors that might occur when carrying out the move operation. +As a general rule, you should avoid using the Force parameter unless absolutely necessary. ```yaml -Type: PSCredential +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -164,15 +136,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -When present, instructs the Move-CsMeetingRoom cmdlet to ignore all errors that might occur when carrying out the move operation. -As a general rule, you should avoid using the Force parameter unless absolutely necessary. +### -HostedMigrationOverrideUrl +URL for the hosted migration service used when moving a user to Lync Online. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,29 +151,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostedMigrationOverrideUrl -URL for the hosted migration service used when moving a user to Lync Online. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the meeting room to be moved. +Meeting rooms can be specified using one of four formats: 1) the room's SIP address; 2) the room's user principal name (UPN); 3) the room's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the room's Active Directory display name (for example, Main Conference Room). +User Identities can also be referenced by using the room's Active Directory distinguished name. ```yaml -Type: String -Parameter Sets: (All) +Type: UserIdParameter +Parameter Sets: (All), Identity Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -IgnoreBackendStoreException + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to the move meeting room despite those errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,14 +190,16 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a meeting room object through the pipeline that represents the meeting room being moved. By default, the Move-CsMeetingRoom cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,13 +209,15 @@ Accept wildcard characters: False ``` ### -ProxyPool + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is not used with the on-premises version of Skype for Business Online. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,14 +226,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the file path for the log file created when the cmdlet runs. +For example: -Report "C:\Logs\S1_FailOverLog.html". +If this file already exists, it will be overwritten. +By default, reports are written to the "AppData\Local\Temp" folder in your user profile. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Identity, Users +Aliases: Required: False Position: Named @@ -261,14 +247,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Target + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The FQDN (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the meeting room should be moved. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UserList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: String ```yaml Type: String Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -277,17 +283,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Specifies the file path for the log file created when the cmdlet runs. -For example: -Report "C:\Logs\S1_FailOverLog.html". -If this file already exists, it will be overwritten. -By default, reports are written to the "AppData\Local\Temp" folder in your user profile. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: Identity, Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -301,13 +324,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom The Moves-CsMeetingRoom cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom object. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Move-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Move-CsRgsConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Move-CsRgsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Move-CsRgsConfiguration.md index c0b6514042..8415a632bf 100644 --- a/skype/skype-ps/skype/Move-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsRgsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csrgsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsRgsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csrgsconfiguration +schema: 2.0.0 +title: Move-CsRgsConfiguration --- # Move-CsRgsConfiguration @@ -47,7 +48,7 @@ That type of migration can only be done by using the new Import-CsRgsConfigurati ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsRgsConfiguration -Source atl-ocsrgs-001.litwareinc.com -Destination redmond-lyncrgs-001.litwareinc.com ``` @@ -58,13 +59,15 @@ The command shown in Example 1 migrates the Response Group application from atl- ## PARAMETERS ### -Destination + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of the computer where the newer server Response Group application is to be hosted (the "copy to" location). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 3 @@ -73,30 +76,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Source -FQDN of the pool where the legacy Response Group application is currently hosted (the "copy from" location). +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +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 occur when running the command. +### -ResolveNameConflicts + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When present, duplicate names will be resolved by appending a unique identifying number. For example, if there are two workflows named Help Desk Workflow one of the two will be renamed Help Desk Workflow (2). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,17 +112,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResolveNameConflicts -When present, duplicate names will be resolved by appending a unique identifying number. For example, if there are two workflows named Help Desk Workflow one of the two will be renamed Help Desk Workflow (2). +### -Source + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the pool where the legacy Response Group application is currently hosted (the "copy from" location). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -126,13 +135,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None Move-CsRgsConfiguration does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableSettings.ServiceSettings Move-CsRgsConfiguration moves instances of the Microsoft.Rtc.Management.WritableSettings.ServiceSettings from one service to another. ## NOTES diff --git a/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Move-CsThirdPartyVideoSystem.md similarity index 86% rename from skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md rename to skype/skype-ps/SkypeForBusiness/Move-CsThirdPartyVideoSystem.md index 6ab001cf5a..89d073182a 100644 --- a/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsThirdPartyVideoSystem.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsThirdPartyVideoSystem -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csthirdpartyvideosystem +schema: 2.0.0 +title: Move-CsThirdPartyVideoSystem --- # Move-CsThirdPartyVideoSystem @@ -42,7 +43,7 @@ If you later decide to move a contact object to a different pool, you can do so ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Move-CsThirdPartyVideoSystem -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com" -Target "atl-cs-001.litwareinc.com" @@ -51,7 +52,7 @@ Move-CsThirdPartyVideoSystem -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f The command shown in Example 1 moves the third-party video system with the Identity CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com to the Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystem | Move-CsThirdPartyVideoSystem -Target "atl-cs-001.litwareinc.com" @@ -64,83 +65,94 @@ That collection is then piped to the Move-CsThirdPartyVideoSystem cmdlet, which ## PARAMETERS -### -Identity -Unique identifier for the third-party video system to be moved. -Video systems are identified by using the Active Directory distinguished name of the associated contact object. -By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: +### -ConcurrentMovesPerFE -CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: Int32 ```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: Int32 +Parameter Sets: Users +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Target -The fully qualified domain name (FQDN) of the Registrar pool where the video system should be moved (for example, atl-cs-001.litwareinc.com). -In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. +### -DomainController + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to move the video system. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (e.g., atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserList -PARAMVALUE: String +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +If present, moves the video system but deletes any associated data (such as policies that were assigned to the system). +If not present, the video system is moved along with any associated data. ```yaml -Type: String -Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentMovesPerFE -PARAMVALUE: Int32 +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the third-party video system to be moved. +Video systems are identified by using the Active Directory distinguished name of the associated contact object. +By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: + +CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com ```yaml -Type: Int32 -Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: UserIdParameter +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -IgnoreBackendStoreException + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the video system despite those errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,15 +161,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to move the video system. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (e.g., atl-cs-001.litwareinc.com). +### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a video system contact object through the pipeline that represents the video system being moved. +By default, the Move-CsThirdPartyVideoSystem cmdlet does not pass objects through the pipeline. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,15 +180,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If present, moves the video system but deletes any associated data (such as policies that were assigned to the system). -If not present, the video system is moved along with any associated data. +### -ProxyPool + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is used only for Skype for Business Online. +It should not be used with an on-premises implementation of Skype for Business Server. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,14 +199,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the video system despite those errors. +### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,48 +217,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a video system contact object through the pipeline that represents the video system being moved. -By default, the Move-CsThirdPartyVideoSystem cmdlet does not pass objects through the pipeline. +### -Target + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the Registrar pool where the video system should be moved (for example, atl-cs-001.litwareinc.com). +In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyPool -This parameter is used only for Skype for Business Online. -It should not be used with an on-premises implementation of Skype for Business Server. +### -UserList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Users +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -PARAMVALUE: String +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -250,13 +273,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -270,12 +295,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact The Move-CsThirdPartyVideoSystem cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact By default the Move-CsThirdPartyVideoSystem cmdlet does not return any data or objects. However, if you include the PassThru parameter you can instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object through the pipeline. diff --git a/skype/skype-ps/skype/Move-CsUser.md b/skype/skype-ps/SkypeForBusiness/Move-CsUser.md similarity index 68% rename from skype/skype-ps/skype/Move-CsUser.md rename to skype/skype-ps/SkypeForBusiness/Move-CsUser.md index 29973fc914..af6e71552d 100644 --- a/skype/skype-ps/skype/Move-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsUser.md @@ -1,46 +1,53 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csuser +schema: 2.0.0 +title: Move-CsUser --- # Move-CsUser ## SYNOPSIS -Moves one or more user accounts enabled for Skype for Business Server to TeamsOnly (or the reverse). This cmdlet also can be used to move on-premises users from one pool to another. - -**PRE-REQUISITES steps for running Move-CsUser** -- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later - -**PRE-REQUISITES steps for** [Office 365 operated by 21Vianet](/microsoft-365/admin/services-in-china/services-in-china?view=o365-21vianet) -- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later -- Run Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina - -For more information, see [Set-TeamsEnvironmentConfig](/powershell/module/teams/set-teamsenvironmentconfig). +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. ## SYNTAX -### (Default) - +### Identity (Default) ``` -Move-CsUser [-Identity] [-Target] [-Credential ] [-UseOAuth] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-ProxyPool ] [-MoveConferenceData] [-Report ] [-DomainController ] [-Confirm] [-Force] [-PassThru] [-WhatIf] [] +Move-CsUser [-Identity] [-Credential ] [-Target] [-MoveToTeams] + [-HostedMigrationOverrideUrl ] [-TenantAdminUserName ] [-BypassAudioConferencingCheck] + [-BypassEnterpriseVoiceCheck] [-AccessTokens ] [-MoveConferenceData] [-Report ] [-Force] + [-UseLegacyMode] [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-PassThru] + [-WhatIf] [-Confirm] [] ``` -### UserList - +### Users ``` -Move-CsUser -UserList [-Target] [-Credential ] [-UseOAuth] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-ProxyPool ] [-MoveConferenceData] [-Report ] [-DomainController ] [-Confirm] [-Force] [-PassThru] [-WhatIf] [] +Move-CsUser [-Credential ] [-Target] [-MoveToTeams] [-HostedMigrationOverrideUrl ] + [-TenantAdminUserName ] [-BypassAudioConferencingCheck] [-BypassEnterpriseVoiceCheck] + [-AccessTokens ] [-MoveConferenceData] -UserList [-Report ] [-Force] + [-UseLegacyMode] [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-PassThru] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION +**PRE-REQUISITES steps for running Move-CsUser** +- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later + +**PRE-REQUISITES steps for** [Office 365 operated by 21Vianet](/microsoft-365/admin/services-in-china/services-in-china?view=o365-21vianet) +- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later +- Run Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina + +For more information, see [Set-TeamsEnvironmentConfig](/powershell/module/teams/set-teamsenvironmentconfig). + The Move-CsUser cmdlet enables you to move a user account enabled for Skype for Business in the following scenarios: - from an on-premises Skype for Business deployment to Teams-only in Microsoft 365 (or the reverse) @@ -58,11 +65,11 @@ When moving a user to the Microsoft 365 cloud to become TeamsOnly (or the revers > [!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. +> - 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 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. +> As of November 10, 2023, moving users from Teams to On-Premises will no longer migrate their contacts. This is mainly due to our continuous efforts to tighten security and protect customers' data. After carefully analyzing the usage patterns and performing risk assessments with the legacy infrastructure, we decided to deprecate this feature. **MINIMUM REQUIRED SERVER VERSIONS**: @@ -90,73 +97,86 @@ $cred=get-credential Move-CsUser -Identity "PilarA@contoso.com" -Target "sipfed.online.lync.com" -Credential $cred ``` -In Example 1, the Move-CsUser cmdlet is used to move the user account with sip address PilarA@contoso.com to Teams. This user will now be a Teams only user. If -Credential parameter is not specified, the admin will be prompted for credentials. It no longer matters whether the `-MoveToTeams` switch is specified. +In Example 1, the Move-CsUser cmdlet is used to move the user account with sip address PilarA@contoso.com to Teams. +This user will now be a Teams only user. +If -Credential parameter is not specified, the admin will be prompted for credentials. +It no longer matters whether the `-MoveToTeams` switch is specified. +NOTE: The MoveToTeams switch is only available on Skype for Business Server 2019. +Organizations using other versions of Skype for Business Server must first move the user to Skype for Business Online, and then apply TeamsUpgradePolicy. -### EXAMPLE 2: Move a user to another on-premises pool +### EXAMPLE 2: Move a user to Skype for Business Online +``` +$cred=get-credential +Move-CsUser -Identity PilarA@contoso.com -Target "sipfed.online.lync.com" -Credential $cred +``` -```powershell +In Example 2, the Move-CsUser cmdlet is used to move the user account with sip address PilarA@contoso.com to Skype for Business Online. +This is the same cmdlet usage as example 1, except the MoveToTeams switch is not specified. + +### EXAMPLE 3: Move a user to another on-premises pool +``` Move-CsUser -Identity "Pilar Ackerman" -Target "atl-cs-001.litwareinc.com" ``` In Example 3, the Move-CsUser cmdlet is used to move the user account with the Identity Pilar Ackerman to the Registrar pool atl-cs-001.litwareinc.com. -### EXAMPLE 3: Move multiple users - -```powershell +### EXAMPLE 4: Move multiple users +``` Get-CsUser -OU "ou=Finance,dc=litwareinc,dc=com" | Move-CsUser -Target "atl-cs-001.litwareinc.com" ``` -In Example 4, all the user accounts in the Finance organizational unit (OU) are moved to the Registrar pool atl-cs-001.litwareinc.com in on-premises. -To carry out this task, the command first uses the Get-CsUser cmdlet and the OU parameter to retrieve a collection of all the user accounts in the Finance OU. After the data has been retrieved, the information is piped to the Move-CsUser cmdlet, which moves each account in the collection to the Registrar pool atl-cs-001.litwareinc.com. +In Example 4, all the user accounts in the Finance organizational unit (OU) are moved to the Registrar pool atl-cs-001.litwareinc.com. +To carry out this task, the command first uses the Get-CsUser cmdlet and the OU parameter to retrieve a collection of all the user accounts in the Finance OU. +After the data has been retrieved, the information is piped to the Move-CsUser cmdlet, which moves each account in the collection to the Registrar pool atl-cs-001.litwareinc.com. -### EXAMPLE 4: Move multiple users listed in a file +## PARAMETERS -```powershell -Move-CsUser -UserList C:\Folder1\Folder2\file1.txt -Target "atl-cs-001.litwareinc.com" -Report C:\Folder1\Folder2\out.csv -``` +### -AccessTokens +{{ Fill AccessTokens Description }} -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. +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: -## PARAMETERS +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -### -Identity +### -BypassAudioConferencingCheck -Indicates the Identity of the user account to be moved. -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. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -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 with who have a display name that ends with the string value " Smith". +This parameter has been deprecated and should not be used. ```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Required: False +Position: Named +Default value: False +Accept pipeline input: False Accept wildcard characters: False ``` -### -Target +### -BypassEnterpriseVoiceCheck -If moving to an on-premises pool (either from another pool or from Microsoft 365), this is the FQDN (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the user account should be moved. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -If moving to Microsoft 365, this must be set to the ProxyFqdn value of the hosting provider. In most cases this is sipfed.online.lync.com. The value of the ProxyFqdn can be obtained using Get-CsHostingProvider +By default, if the on-premise user is configured for Enteprise Voice, moving the user to Office 365 will provision the user for Microsoft Phone System, for an additional license is required. +If you want to move such a user to Office 365 but do not want to configure them for Phone System, specify this switch to by-pass the license check. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -164,13 +184,16 @@ 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. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -179,15 +202,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseOAuth +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -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. +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: SwitchParameter +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015 + Required: False Position: Named Default value: None @@ -195,31 +220,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassAudioConferencingCheck +### -Force -This parameter has been deprecated and should not be used. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, moves the user account without moving contacts or meetings. Contacts and meetings are not recoverable. +If not present, both the account and the associated data are moved. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassEnterpriseVoiceCheck - -This parameter has been deprecated and should not be used. +### -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. +However, a specific URL can be specified if required. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Required: False Position: Named Default value: None @@ -227,30 +256,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantAdminUserName +### -Identity -This is an optional parameter that if, specified, pre-populates the username of the tenant admin when moving users to or from Office 365. This can be useful for scenarios involving smart card authentication or 2 factor auth. This parameter is only available with Skype for Business Server 2019 and CU8 for Skype for Business Server 2015. When specifying this parameter on Skype for Business Server 2015 with CU8, you must also specify the UseOAuth parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be moved. +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 with who have a display name that ends with the string value " Smith". ```yaml -Type: UserIdParameter +Type: Microsoft.Rtc.Management.AD.UserIdParameter +Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named + +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -ProxyPool - -This is an optional parameter that can be used to specify the front-end pool for user migration. +### -IgnoreBackendStoreException +{{ Fill IgnoreBackendStoreException Description }} ```yaml -Type: Fqdn +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,15 +296,16 @@ Accept wildcard characters: False ### -MoveConferenceData +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, moves meeting and conference data for users being transferred to a different Registrar pool. Note that you should only use the MoveConferenceData parameter if you are moving users between on-premises pools and you should not use the MoveConferenceData parameter if you are moving users as part of a disaster recovery procedure. Instead, you should rely on the backup service for moving conference data as part of a disaster recovery procedure. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter 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 @@ -277,40 +313,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force - -If present, moves the user account without moving contacts or meetings. Contacts and meetings are not recoverable. -If not present, both the account and the associated data are moved. +### -MoveToTeams +If specified, the user will be moved to Office 365 as a Teams-only user. +This will ensure incoming chats and calls land in the user's Teams client. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.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 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -PassThru -Enables you to bypass the confirmation prompt that would otherwise appear when you attempt to move a user. -To bypass the confirmation prompt, include the Confirm parameter using this syntax: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Confirm:$False` +Enables you to pass a user object through the pipeline that represents the user account being moved. +By default, the Move-CsUser cmdlet does not pass objects through the pipeline. -If you would prefer to have the confirmation prompt then use this syntax: +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: -`-Confirm` +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This is an optional parameter that can be used to specify the front-end pool for user migration. ```yaml -Type: SwitchParameter +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -321,13 +368,14 @@ Accept wildcard characters: False ### -Report +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A CSV file to be created with detailed information about the move. You can supply the file name if you want to create the file in the current folder, or an absolute path. ```yaml -Type: String -Parameter Sets: Identity, Users +Type: System.String +Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -336,31 +384,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserList +### -Target -A text file with a list of users to be moved, in the following format example: "sip:user1@contoso.com,sip:user2@contoso.com,sip:user3@contoso.com". You can supply the file name if it's located in the current folder, or the absolute path to the file. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If moving to an on-premises pool (either from another pool or from Microsoft 365), this is the FQDN (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the user account should be moved. + +If moving to Microsoft 365, this must be set to the ProxyFqdn value of the hosting provider. In most cases this is sipfed.online.lync.com. The value of the ProxyFqdn can be obtained using Get-CsHostingProvider ```yaml -Type: String -Parameter Sets: Users +Type: Microsoft.Rtc.Management.Deploy.Fqdn +Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantAdminUserName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This is an optional parameter that if, specified, pre-populates the username of the tenant admin when moving users to or from Office 365. This can be useful for scenarios involving smart card authentication or 2 factor auth. This parameter is only available with Skype for Business Server 2019 and CU8 for Skype for Business Server 2015. When specifying this parameter on Skype for Business Server 2015 with CU8, you must also specify the UseOAuth parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -UseLegacyMode +{{ Fill UseLegacyMode Description }} ```yaml -Type: Fqdn +Type: System.Management.Automation.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 @@ -369,44 +436,70 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -UserList -Enables you to pass a user object through the pipeline that represents the user account being moved. -By default, the Move-CsUser cmdlet does not pass objects through the pipeline. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +A text file with a list of users to be moved, in the following format example: "sip:user1@contoso.com,sip:user2@contoso.com,sip:user3@contoso.com". You can supply the file name if it's located in the current folder, or the absolute path to the file. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: System.String +Parameter Sets: Users Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to bypass the confirmation prompt that would otherwise appear when you attempt to move a user. +To bypass the confirmation prompt, include the Confirm parameter using this syntax: + +`-Confirm:$False` + +If you would prefer to have the confirmation prompt then use this syntax: + +`-Confirm` + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.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 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAVEdgeConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsAVEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsAVEdgeConfiguration.md index 89161bbc99..9ef6f986cf 100644 --- a/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAVEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAVEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csavedgeconfiguration +schema: 2.0.0 +title: New-CsAVEdgeConfiguration --- # New-CsAVEdgeConfiguration @@ -48,7 +49,7 @@ Because of that, you will probably not need to create a new collection of settin ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAVEdgeConfiguration -Identity site:Redmond -MaxTokenLifetime "04:00:00" @@ -58,7 +59,7 @@ The command shown in Example 1 creates a new collection of A/V Edge configuratio In this example, the MaxTokenLifetime property is set to 4 hours (04 hours : 00 minutes : 00 seconds). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsAVEdgeConfiguration -Identity site:Redmond -InMemory @@ -78,7 +79,28 @@ The third command then uses the Set-CsAVEdgeConfiguration cmdlet to apply the se ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of A/V Edge configuration settings to be created. To create a collection of settings to be applied at the site scope, use syntax similar to this: `-Identity site:Redmond.` (Note that this command will fail if a collection of A/V Edge configuration settings have already been applied to the Redmond site.) Settings configured at the service scope should use syntax similar to this: `-Identity service:EdgeServer:atl-cs-001.litwareinc.com.` @@ -86,8 +108,7 @@ To create a collection of settings to be applied at the site scope, use syntax s ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -96,24 +117,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxTokenLifetime -The maximum amount of time that an authentication token can be used before it expires and must be renewed. -Token lifetimes are expressed using the following format: Days.Hours:Minutes:Seconds. -For example, 13 days must be expressed like this, with a period (.) following the number of days, and colons (:) used to separate the hours, minutes, and seconds: +### -InMemory -13.00:00:00 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The default value of 8 hours must be expressed like this: +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-\. -08:00:00 -The minimum allowed token lifetime is 1 minute (00:01:00); the maximum allowed lifetime is 180 days (180.00:00:00). ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +138,17 @@ 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. +### -MaxBandwidthPerPortKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to a single port. +The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 3000. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,18 +157,17 @@ 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-\. +### -MaxBandwidthPerUserKb +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to any one user. +The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 10000. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +176,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxTokenLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum amount of time that an authentication token can be used before it expires and must be renewed. +Token lifetimes are expressed using the following format: Days.Hours:Minutes:Seconds. +For example, 13 days must be expressed like this, with a period (.) following the number of days, and colons (:) used to separate the hours, minutes, and seconds: + +13.00:00:00 + +The default value of 8 hours must be expressed like this: + +08:00:00 + +The minimum allowed token lifetime is 1 minute (00:01:00); the maximum allowed lifetime is 180 days (180.00:00:00). ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +205,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -190,32 +222,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxBandwidthPerPortKb -Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to a single port. -The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 3000. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -MaxBandwidthPerUserKb -Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to any one user. -The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 10000. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -229,13 +245,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAVEdgeConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsAdditionalInternalDomain.md similarity index 82% rename from skype/skype-ps/skype/New-CsAdditionalInternalDomain.md rename to skype/skype-ps/SkypeForBusiness/New-CsAdditionalInternalDomain.md index 02cf488052..2d50d1658e 100644 --- a/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAdditionalInternalDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAdditionalInternalDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csadditionalinternaldomain +schema: 2.0.0 +title: New-CsAdditionalInternalDomain --- # New-CsAdditionalInternalDomain @@ -37,7 +38,7 @@ domains. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` PS C:\> New-CsAdditionalInternalDomain -Identity fabrikam.com ``` @@ -46,30 +47,16 @@ The cmdlet shown in Example 1 creates a new additional internal domain, one that ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Domain -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Domain Fully qualified domain name (FQDN) for the new additional internal domain. ```yaml Type: String Parameter Sets: ParentAndRelativeKey Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -79,13 +66,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -95,13 +84,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) for the new additional internal domain. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -111,13 +102,33 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```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 +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -127,13 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -158,6 +171,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Remove-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain?view=skype-ps) +[Remove-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csadditionalinternaldomain?view=skype-ps) -[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) +[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadditionalinternaldomain?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsAddressBookConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsAddressBookConfiguration.md index 2e6b1c092e..ac1f1add23 100644 --- a/skype/skype-ps/skype/New-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAddressBookConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csaddressbookconfiguration +schema: 2.0.0 +title: New-CsAddressBookConfiguration --- # New-CsAddressBookConfiguration @@ -51,7 +52,7 @@ Your command will also fail if the site in question already contains a collectio ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAddressBookConfiguration -Identity site:Redmond -KeepDuration 15 -SynchronizePollingInterval 00:10:00 @@ -61,7 +62,7 @@ Example 1 creates a new collection of Address Book configuration settings with t To create the new collection you must call the New-CsAddressBookConfiguration cmdlet along with the Identity parameter and any other optional parameters (for example, the KeepDuration and SynchronizePollingInterval parameters). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = Get-CsAddressBookConfiguration -Identity site:Redmond @@ -77,7 +78,7 @@ This command includes two optional parameters -- KeepDuration and SynchronizePol For example, KeepDuration uses the parameter value $x.KeepDuration; that parameter value represents the KeepDuration information copied from the Redmond site. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CsAddressBookConfiguration -Identity site:Redmond -InMemory @@ -99,33 +100,36 @@ The fourth and final command then uses the Set-CsAddressBookConfiguration cmdlet ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new collection of Address Book settings. -Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". +### -EnableFileGeneration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the Address Book server generates Address Book index files that can be downloaded by clients. +When set to False, these index files are not generated. +That means that client applications will have to use the Address Book Web Query service when searching for contacts. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFileGeneration -When set to True (the default value) the Address Book server generates Address Book index files that can be downloaded by clients. -When set to False, these index files are not generated. -That means that client applications will have to use the Address Book Web Query service when searching for contacts. +### -EnablePhotoSearch + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, user photos will be displayed in search results. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,20 +138,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreGenericRules +### -EnableSearchByDialPad -Indicates whether or not the Address Book server ignores the generic normalization rules used when parsing phone numbers. -Generic rules are the rules that are built into Skype for Business Server. -These rules cannot be changed; however, by setting the value of this property to True you can instruct your Address Book servers to ignore these rules and instead use custom rules that you create yourself. -The default value is False. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, users will be able to search for contacts by using their mobile device keypad. +This can be a convenience for mobile users, but has the potential to greatly increase the size of your Address Book database. +The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,20 +159,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepDuration - -Specifies the amount of time (in days) that Address Book servers will keep change files. -Change files older than the value of the KeepDuration property will be deleted. -The KeepDuration can be set to any integer value between 1 and 90, inclusive. -The default value is 30 days. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,41 +177,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxDeltaFileSizePercentage - -When changes are made to Active Directory (such as a new user being enabled for Skype for Business Server) the Address Book server typically records these changes in a "delta file," a file consisting only of the updated information; Skype for Business can then download the delta files rather than a complete Address Book file. -The MaxDeltaFileSizePercentage property determines how large the delta files can get before they are incorporated into the complete Address Book file. -By default, delta files can be as large as 20 percent of the complete Address Book file before a new Address Book file is generated. -At that point, Lync clients will download the complete file rather than a delta file. - -MaxDeltaFileSizePercentage must be entered as a percentage value, from 1 to 100, inclusive. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier to be assigned to the new collection of Address Book settings. +Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". ```yaml -Type: UInt32 +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RunTimeOfDay -Indicates the time of day when the servers generate new Address Book files. -The RunTimeOfDay property is based on a 24-hour clock (hours:minutes:seconds), with 00:00:00 representing midnight and 23:59:00 representing 11:59 P.M.. +### -IgnoreGenericRules + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the Address Book server ignores the generic normalization rules used when parsing phone numbers. +Generic rules are the rules that are built into Skype for Business Server. +These rules cannot be changed; however, by setting the value of this property to True you can instruct your Address Book servers to ignore these rules and instead use custom rules that you create yourself. +The default value is False. + -The default value is 01:30:00 (1:30 A.M.). ```yaml -Type: DateTime +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,16 +219,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SynchronizePollingInterval -Indicates how often Address Book servers synchronize their information with the information stored in the User database. -The SynchronizePollingInterval can be set to any value between 5 seconds (00:00:05) and 3 hours (03:00:00). -The default value is 5 minutes (00:05:00). +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -239,17 +240,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNormalizationRules -Indicates whether Address Book servers should use phone normalization rules when retrieving phone numbers. -If set to False, phone numbers will be retrieved as-is, and it will be up to the client application to apply normalization rules when displaying these numbers. +### -KeepDuration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in days) that Address Book servers will keep change files. +Change files older than the value of the KeepDuration property will be deleted. +The KeepDuration can be set to any integer value between 1 and 90, inclusive. +The default value is 30 days. + -The default value is True. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,14 +263,23 @@ 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. +### -MaxDeltaFileSizePercentage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When changes are made to Active Directory (such as a new user being enabled for Skype for Business Server) the Address Book server typically records these changes in a "delta file," a file consisting only of the updated information; Skype for Business can then download the delta files rather than a complete Address Book file. +The MaxDeltaFileSizePercentage property determines how large the delta files can get before they are incorporated into the complete Address Book file. +By default, delta files can be as large as 20 percent of the complete Address Book file before a new Address Book file is generated. +At that point, Lync clients will download the complete file rather than a delta file. + +MaxDeltaFileSizePercentage must be entered as a percentage value, from 1 to 100, inclusive. + + ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -274,18 +288,17 @@ 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-\. +### -MaxFileShareThreadCount +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the maximum number of system resources that can be used by the Address Book server if there are problems accessing the service file share. +The default value is 300. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -294,14 +307,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PhotoCacheRefreshInterval + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: TimeSpan ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -310,14 +325,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -RunTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the time of day when the servers generate new Address Book files. +The RunTimeOfDay property is based on a 24-hour clock (hours:minutes:seconds), with 00:00:00 representing midnight and 23:59:00 representing 11:59 P.M.. + +The default value is 01:30:00 (1:30 A.M.). ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -326,14 +346,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePhotoSearch -When set to True, user photos will be displayed in search results. +### -SynchronizePollingInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates how often Address Book servers synchronize their information with the information stored in the User database. +The SynchronizePollingInterval can be set to any value between 5 seconds (00:00:05) and 3 hours (03:00:00). +The default value is 5 minutes (00:05:00). ```yaml -Type: Boolean +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -342,17 +366,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSearchByDialPad -When set to True, users will be able to search for contacts by using their mobile device keypad. -This can be a convenience for mobile users, but has the potential to greatly increase the size of your Address Book database. +### -UseNormalizationRules -The default value is True ($True). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether Address Book servers should use phone normalization rules when retrieving phone numbers. +If set to False, phone numbers will be retrieved as-is, and it will be up to the client application to apply normalization rules when displaying these numbers. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -361,15 +387,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxFileShareThreadCount -Specifies the maximum number of system resources that can be used by the Address Book server if there are problems accessing the service file share. -The default value is 300. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -378,14 +405,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PhotoCacheRefreshInterval -PARAMVALUE: TimeSpan +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -399,13 +428,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAddressBookConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationConfiguration.md index 3291177ad9..81bd405570 100644 --- a/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAddressBookNormalizationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csaddressbooknormalizationconfiguration +schema: 2.0.0 +title: New-CsAddressBookNormalizationConfiguration --- # New-CsAddressBookNormalizationConfiguration @@ -37,7 +38,7 @@ That means that, in some cases, you might need to create identical rules: one fo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsAddressBookNormalizationConfiguration -Identity "site:Redmond" @@ -50,24 +51,10 @@ Those rules are most-easily created using the New-CsAddressBookNormalizationRule ## PARAMETERS -### -Identity -Unique identifier for the new collection of Address Book normalization rules. -Because new rule collections can only be created at the site scope, the Identity will always be similar to this: `-Identity "site:Redmond"` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -AddressBookNormalizationRules -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -AddressBookNormalizationRules One or more normalization rules to be assigned to the collection. Although these rules can be created directly using the New-CsAddressBookNormalizationConfiguration cmdlet, it is recommended that you create the normalization rules using the New-CsAddressBookNormalizationRule cmdlet instead. That cmdlet creates the rule and assigns it to the specified collection using a single command, and using much simpler syntax. @@ -75,8 +62,7 @@ That cmdlet creates the rule and assigns it to the specified collection using a ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -85,14 +71,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -101,31 +89,54 @@ 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. +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new collection of Address Book normalization rules. +Because new rule collections can only be created at the site scope, the Identity will always be similar to this: `-Identity "site:Redmond"` ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -155,13 +168,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAddressBookNormalizationConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings The New-CsAddressBookNormalizationConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings object cmdlet. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationRule.md similarity index 88% rename from skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationRule.md index 9aa677a96c..5afc3c08e9 100644 --- a/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAddressBookNormalizationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csaddressbooknormalizationrule +schema: 2.0.0 +title: New-CsAddressBookNormalizationRule --- # New-CsAddressBookNormalizationRule @@ -39,7 +40,7 @@ That means that, in some cases, you might need to create identical rules: one fo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsAddressBookNormalizationRule -Parent "site:Redmond" -Name RedmondFourDigit -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1425555$1' @@ -56,77 +57,76 @@ Single quotes are required for these values; double quotes (or no quotes) will c ## PARAMETERS -### -Identity -Unique identifier for the rule. -The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +### -Description -Note that the Identity is composed of the Parent (scope) and the Name. -If you use the Identity parameter then you cannot use the Name or the Parent parameters. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide explanatory text that accompanies a normalization rule. +For example, the Description might explain how the rule converts phone numbers. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The name to be given to the new 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, the Name defaults to the name used 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. +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False 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. -Address book normalization rules can be created at the global scope, the site scope, or the service scope (for the Address Book service only). -Note that a collection of Address Book normalization configuration settings must already be assigned to the specified scope before you can add a rule to that scope. -For example, you cannot add a rule to the Redmond site unless you have already created Address Book normalization configuration settings for that site. +### -Identity -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. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the rule. +The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. + +Note that the Identity is composed of the Parent (scope) and the Name. +If you use the Identity parameter then you cannot use the Name or the Parent parameters. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,50 +135,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text that accompanies a normalization rule. -For example, the Description might explain how the rule converts phone numbers. +### -Name + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The name to be given to the new 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, the Name defaults to the name used 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: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Parent -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +The scope at which the new normalization rule will be created. +Address book normalization rules can be created at the global scope, the site scope, or the service scope (for the Address Book service only). +Note that a collection of Address Book normalization configuration settings must already be assigned to the specified scope before you can add a rule to that scope. +For example, you cannot add a rule to the Redmond site unless you have already created Address Book normalization configuration settings for that site. -### -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-\. +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: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -186,6 +183,9 @@ Accept wildcard characters: False ``` ### -Pattern + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that the phone number must match in order for this rule to be applied. The default value is ^(\d{11})$. @@ -194,8 +194,7 @@ This expression represents any set of numbers up to 11 digits. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +204,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The order in which rules are applied; this is required because a given phone number might match more than one rule. The Priority parameter sets the order in which the rules are tested against the number. If a phone number matches multiple rules, the rule with the highest priority will be selected to do the conversion. @@ -214,8 +216,7 @@ Note that, when you set a priority, any existing rules will renumber themselves ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +226,9 @@ Accept wildcard characters: False ``` ### -Translation + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The regular expression pattern that will be applied to the number to convert it to E.164 format. The default value is +$. @@ -233,8 +237,25 @@ This prefixes the number with a plus sign (+). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -244,13 +265,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -264,13 +287,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAddressBookNormalizationRule cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule The New-CsAddressBookNormalizationRule cmdlet creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/New-CsAdminRole.md similarity index 90% rename from skype/skype-ps/skype/New-CsAdminRole.md rename to skype/skype-ps/SkypeForBusiness/New-CsAdminRole.md index afa8e62603..769c1f6c1d 100644 --- a/skype/skype-ps/skype/New-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAdminRole.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAdminRole -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csadminrole +schema: 2.0.0 +title: New-CsAdminRole --- # New-CsAdminRole @@ -105,7 +106,7 @@ However, you can use the Set-CsAdminRole cmdlet to change the administrative sco ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAdminRole -Identity "RedmondVoiceAdministrator" -Template "CsVoiceAdministrator" @@ -115,7 +116,7 @@ The command in Example 1 duplicates the RBAC role CsVoiceAdministrator. Because no additional parameters are used, the new role -- RedmondVoiceAdministrators -- will be an exact duplicate of CsVoiceAdministrator, which includes both the UserScopes and ConfigScopes properties being set to "global". -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsAdminRole -Identity "RedmondVoiceAdministrator" -Template "CsVoiceAdministrator" -UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com" @@ -125,7 +126,7 @@ Example 2 creates a new RBAC role (RedmondVoiceAdministrator) and then configure To do this, the UserScopes parameter is included along with the following parameter value: "OU:ou=Redmond,dc=litwareinc,dc=com". This parameter value replaces the current value of the UserScopes property with one item: the OU with the distinguished name (DN) "ou=Redmond,dc=litwareinc,dc=com". -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsAdminRole -Identity "RedmondVoiceAdministrator" -Template "CsVoiceAdministrator" -UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com","OU:ou=Portland,dc=litwareinc,dc=com" @@ -135,7 +136,7 @@ The command shown in Example 3 is a variation of the command shown in Example 2; This is done by assigning a comma-separated list to the Replace method: the two items in the list represent the identifiers for the two OUs (Redmond and Portland) to be assigned to the new RBAC role. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` New-CsAdminRole -Identity "RedmondVoiceAdministrator" -Template "CsVoiceAdministrator" -ConfigScopes "site:Redmond" @@ -147,36 +148,27 @@ Note that the syntax for the ConfigScopes property requires the use of the "site ## PARAMETERS -### -Identity -Unique identifier for the RBAC role to be created. -The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. -For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. +### -Cmdlets -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the cmdlets that will be available to users who hold the new RBAC role. +For example, to create a new role that provides access only to one cmdlet (the Export-CsArchivingData cmdlet) use syntax like this: + +`-Cmdlets "Export-CsArchivingData"` + +To allow access to multiple cmdlets, separate the cmdlet names using commas: + +`-Cmdlets "Export-CsArchivingData","Invoke-CsArchivingDatabasePurge"` -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Template -Name of the built-in RBAC role that will serve as a template for the custom RBAC role being created. -All new RBAC roles must be based on an existing role; it is not possible to create a blank RBAC role (that is, a role with no cmdlets assigned to it or without values assigned to either the ConfigScopes or UserScopes properties). -However, after the custom role has been created, you can then use the Set-CsAdminRole cmdlet to modify the properties of the new role. ```yaml -Type: String +Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.WritableConfig.Settings.Roles.CmdletType] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -185,6 +177,8 @@ Accept wildcard characters: False ### -ConfigScopes +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Used to limit the scope of the cmdlet to configuration settings within the specified site. To limit the cmdlet scope to a single site, use syntax similar to this: `-ConfigScopes site:Redmond.` Multiple sites can be specified by using a comma-separated list: `-ConfigScopes "site:Redmond, "site:Dublin".` @@ -202,8 +196,7 @@ You must specify a value for either (or both) the ConfigScopes and UserScopes pr ```yaml Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.ConfigScope] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,20 +205,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserScopes -Used to limit the scope of the cmdlet to user management activities within the specified organizational unit. -To limit the cmdlet scope to a single organizational unit, use syntax similar to this: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com".` -Multiple OUs can be specified by using a comma-separated list: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com", "OU:ou=Dublin,dc=litwareinc,dc=com".` -To add new scopes (or remove existing scopes) from a role, use the Windows PowerShell list modifiers syntax. -For details, see the Examples section of this Help topic. +### -Force -You must specify a value for either (or both) the ConfigScopes and UserScopes properties. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.UserScope] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,17 +223,21 @@ 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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the RBAC role to be created. +The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. +For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -252,6 +245,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -260,8 +255,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -270,14 +264,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ScriptModules + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a function within a Windows PowerShell script that will then be available to users who hold the new RBAC role. +For example, this syntax provides access to a function named Reset in a script named UpdateDatabase.ps1 : + +`-ScriptModules "UpdateDatabase.ps1:Reset"` + + ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -286,40 +287,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Template + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the built-in RBAC role that will serve as a template for the custom RBAC role being created. +All new RBAC roles must be based on an existing role; it is not possible to create a blank RBAC role (that is, a role with no cmdlets assigned to it or without values assigned to either the ConfigScopes or UserScopes properties). +However, after the custom role has been created, you can then use the Set-CsAdminRole cmdlet to modify the properties of the new role. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Cmdlets +### -UserScopes -Enables you to specify the cmdlets that will be available to users who hold the new RBAC role. -For example, to create a new role that provides access only to one cmdlet (the Export-CsArchivingData cmdlet) use syntax like this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Cmdlets "Export-CsArchivingData"` +Used to limit the scope of the cmdlet to user management activities within the specified organizational unit. +To limit the cmdlet scope to a single organizational unit, use syntax similar to this: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com".` +Multiple OUs can be specified by using a comma-separated list: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com", "OU:ou=Dublin,dc=litwareinc,dc=com".` +To add new scopes (or remove existing scopes) from a role, use the Windows PowerShell list modifiers syntax. +For details, see the Examples section of this Help topic. -To allow access to multiple cmdlets, separate the cmdlet names using commas: +You must specify a value for either (or both) the ConfigScopes and UserScopes properties. -`-Cmdlets "Export-CsArchivingData","Invoke-CsArchivingDatabasePurge"` +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.UserScope] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.WritableConfig.Settings.Roles.CmdletType] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -328,20 +349,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScriptModules - -Enables you to specify a function within a Windows PowerShell script that will then be available to users who hold the new RBAC role. -For example, this syntax provides access to a function named Reset in a script named UpdateDatabase.ps1 : - -`-ScriptModules "UpdateDatabase.ps1:Reset"` +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[System.String] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -355,12 +372,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Roles.Role The New-CsAdminRole cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Roles.Role object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsAllowedDomain.md similarity index 89% rename from skype/skype-ps/skype/New-CsAllowedDomain.md rename to skype/skype-ps/SkypeForBusiness/New-CsAllowedDomain.md index 4bd2464f78..0a78fdc77b 100644 --- a/skype/skype-ps/skype/New-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAllowedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAllowedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csalloweddomain +schema: 2.0.0 +title: New-CsAllowedDomain --- # New-CsAllowedDomain @@ -55,7 +56,7 @@ If you want to create a new federation relationship, you can use the New-CsAllow ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAllowedDomain -Identity "fabrikam.com" @@ -66,7 +67,7 @@ In Example 1, the domain fabrikam.com is added to the list of allowed domains. To do this, the New-CsAllowedDomain cmdlet is called, along with the Identity parameter; this parameter is assigned the name of the domain to be added to the allowed list. Note that this command will fail if fabrikam.com is already on the allowed list or on the blocked list. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsAllowedDomain -Identity "fabrikam.com" -ProxyFqdn "proxyserver.fabrikam.com" -MarkForMonitoring $True -Comment "Contact: Ken Myer (kenmyer@fabrikam.com)" @@ -76,7 +77,7 @@ New-CsAllowedDomain -Identity "fabrikam.com" -ProxyFqdn "proxyserver.fabrikam.co Example 2 is a variation of the command shown in Example 1. In this case, however, two additional parameters are included along with Identity: ProxyFqdn is used to specify the FQDN of the proxy server for fabrikam.com, and MarkForMonitoring is used to add this federation connection to the list of items monitored by Monitoring Server. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CsAllowedDomain -Identity "fabrikam.com" -InMemory @@ -104,36 +105,17 @@ Fabrikam.com will not show up on the allowed list until after you have called th ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the domain to be added to the allowed list; for example, fabrikam.com. -You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. -If you use Identity, the Domain property will be set to the same value assigned to Identity. -If you use Domain, the Identity property will be set to the same value assigned to Domain. - -Note that Identities must be unique: if the specified domain already exists on either the blocked or the allowed list, your command will fail. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Comment -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Comment Optional string value that provides additional information about the domain being added to the allowed list. For example, you might add a Comment that provides contact information for the federated domain. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +125,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN (for example, fabrikam.com) of the domain to be added to the allowed list. You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. If you use Identity, the Domain property will be set to the same value assigned to Identity. @@ -153,8 +138,7 @@ Note that Domains must be unique: if the specified domain already exists on eith ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -163,17 +147,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MarkForMonitoring -Indicates whether or not the federation connection between your domain and the remote domain will be monitored by Monitoring Server. -By default, MarkForMonitoring is set to False, meaning that the connection will not be monitored. +### -Force -This property will be ignored if you have not deployed Monitoring Server. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,34 +165,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyFqdn -FQDN (for example, proxy-server.fabrikam.com) of the SIP proxy server deployed in the domain being added to the allowed list. -This property is optional: if it is not specified then DNS SRV discovery procedures will be used to determine the location of the SIP proxy server. +### -Identity -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Fully qualified domain name (FQDN) of the domain to be added to the allowed list; for example, fabrikam.com. +You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. +If you use Identity, the Domain property will be set to the same value assigned to Identity. +If you use Domain, the Identity property will be set to the same value assigned to Domain. -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +Note that Identities must be unique: if the specified domain already exists on either the blocked or the allowed list, your command will fail. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -217,6 +190,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -225,8 +200,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -235,14 +209,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MarkForMonitoring + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the federation connection between your domain and the remote domain will be monitored by Monitoring Server. +By default, MarkForMonitoring is set to False, meaning that the connection will not be monitored. + +This property will be ignored if you have not deployed Monitoring Server. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,14 +230,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -ProxyFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN (for example, proxy-server.fabrikam.com) of the SIP proxy server deployed in the domain being added to the allowed list. +This property is optional: if it is not specified then DNS SRV discovery procedures will be used to determine the location of the SIP proxy server. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,6 +250,9 @@ Accept wildcard characters: False ``` ### -VerificationLevel + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how (or if) messages sent from a domain are verified to ensure that they were sent from that domain. The VerificationLevel must be set to one of the following values: @@ -290,8 +275,43 @@ This is the default value. ```yaml Type: VerificationLevelType Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -305,13 +325,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAllowedDomain cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/New-CsAnalogDevice.md similarity index 83% rename from skype/skype-ps/skype/New-CsAnalogDevice.md rename to skype/skype-ps/SkypeForBusiness/New-CsAnalogDevice.md index 78fd82666f..0ec191412f 100644 --- a/skype/skype-ps/skype/New-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAnalogDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAnalogDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csanalogdevice +schema: 2.0.0 +title: New-CsAnalogDevice --- # New-CsAnalogDevice @@ -54,7 +55,7 @@ For details, see the OU and the DN parameter descriptions in this topic. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAnalogDevice -LineUri tel:+14255556001 -DisplayName "Building 14 Receptionist" -RegistrarPool redmond-Cs-001.litwareinc.com -AnalogFax $False -Gateway 192.168.0.240 -OU "ou=Telecommunications,dc=litwareinc,dc=com" @@ -66,17 +67,17 @@ The command shown in Example 1 creates a new analog device with the phone number ## PARAMETERS -### -LineUri -Phone number for the analog device. -The line Uniform Resource Identifier (URI) should be specified by using the E.164 format, and be prefixed by 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". +### -AnalogFax + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Set to True ($True) if the analog device is a fax machine. +Set to False ($False) if the device is not a fax machine. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -85,19 +86,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress - -Unique identifier (similar to an e-mail address) that allows the analog device to communicate with SIP devices such as Skype for Business. -The SIP address must be prefaced by the prefix "sip:". -For example: sip:bldg14lobby@litwareinc.com. +### -DisplayName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Configures the Active Directory display name of the analog device. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,31 +104,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPool -Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. -For example: -RegistrarPool "atl-cs-001.litwareinc.com". +### -DisplayNumber -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number as displayed in Skype for Business. +The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; etc. -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -DisplayName -Configures the Active Directory display name of the analog device. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,35 +125,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber +### -DN -Phone number as displayed in Skype for Business. -The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; etc. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to associate an existing Active Directory contact object with the analog device. +If you have a contact object you want to associate with an analog device, use the DN parameter followed by the distinguished name of that contact. +For example: `-DN "cn=Building 14 Lobby,dc=litwareinc,dc=com".` +Note that the command will fail if the specified contact does not exist. +You cannot use the OU and the DN parameters in the same command. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: ADObjectId +Parameter Sets: DN +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AnalogFax -Set to True ($True) if the analog device is a fax machine. -Set to False ($False) if the device is not a fax machine. +### -Gateway + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +IP address of the PSTN gateway to be used by the analog device. ```yaml -Type: Boolean +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -176,14 +166,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Gateway -IP address of the PSTN gateway to be used by the analog device. +### -LineUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the analog device. +The line Uniform Resource Identifier (URI) should be specified by using the E.164 format, and be prefixed by 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". ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -193,6 +188,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name of the Active Directory organizational unit (OU) where the contact object should be located. For example: `-OU "ou=Redmond,dc=litwareinc,dc=com".` @@ -202,8 +200,7 @@ As a result, the contact object will have a name similar to this: {ce84964a-c4da ```yaml Type: OUIdParameter Parameter Sets: OU -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -212,51 +209,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DN -Enables you to associate an existing Active Directory contact object with the analog device. -If you have a contact object you want to associate with an analog device, use the DN parameter followed by the distinguished name of that contact. -For example: `-DN "cn=Building 14 Lobby,dc=litwareinc,dc=com".` -Note that the command will fail if the specified contact does not exist. +### -PassThru -You cannot use the OU and the DN parameters in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns an object representing the common area phone. ```yaml -Type: ADObjectId -Parameter Sets: DN -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns an object representing the common area phone. +### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. +For example: -RegistrarPool "atl-cs-001.litwareinc.com". ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier (similar to an e-mail address) that allows the analog device to communicate with SIP devices such as Skype for Business. +The SIP address must be prefaced by the prefix "sip:". +For example: sip:bldg14lobby@litwareinc.com. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -266,13 +269,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -286,13 +309,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAnalogDevice cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact The New-CsAnalogDevice cmdlet creates new instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/New-CsAnnouncement.md similarity index 87% rename from skype/skype-ps/skype/New-CsAnnouncement.md rename to skype/skype-ps/SkypeForBusiness/New-CsAnnouncement.md index 5d2ff20332..fdd9081a57 100644 --- a/skype/skype-ps/skype/New-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAnnouncement.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAnnouncement -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csannouncement +schema: 2.0.0 +title: New-CsAnnouncement --- # New-CsAnnouncement @@ -50,7 +51,7 @@ You can assign announcements to unassigned numbers by calling the New-CsUnassign ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Help Desk Announcement" -TextToSpeechPrompt "Welcome to the Help Desk." -Language "en-US" @@ -70,7 +71,7 @@ You will see the full Identity after you create the new announcement; the GUID i That Identity will be similar to this: service:ApplicationServer:redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Welcome Announcement" -AudioFilePrompt "WelcomeMessage.wav" @@ -83,7 +84,7 @@ This file must be in the File Store in order for this announcement to play. You can add audio files to the File Store by calling the Import-CsAnnouncementFile cmdlet. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Forward Announcement" -AudioFilePrompt "WelcomeMessage.wav" -TargetUri sip:kmyer@litwareinc.com @@ -95,7 +96,7 @@ However, in this example in addition to the Identity, Name, and AudioFilePrompt We pass this parameter the SIP URI of the user or phone to which the caller will be forwarded after the announcement has been played. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Forward Announcement" -AudioFilePrompt "WelcomeMessage.wav" -TargetUri "sip:+14255551212@litwareinc.com;user=phone" @@ -104,7 +105,7 @@ New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "For Example 4 is identical to Example 3 except that instead of forwarding the call based on a user's SIP address, the call is forwarded to a phone number. -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Busy" @@ -116,7 +117,50 @@ That means the caller will hear a busy signal when a call to an unassigned numbe ## PARAMETERS +### -AudioFilePrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name of the audio file to be played for the announcement. +Audio files are stored in the File Store. +To save an audio file to the File Store, use the Import-CsAnnouncementFile cmdlet. + +Valid file types: WAV and WMA + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the Announcement. For this value you must enter the Identity of the Application Server running the Response Group application. For example, ApplicationServer:redmond.litwareinc.com. @@ -135,8 +179,7 @@ You can create a new announcement with a matching Identity (including the GUID) ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -145,81 +188,86 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -This parameter is identical to Identity, except that Identity will accept the service Identity and the GUID, whereas Parent will accept only the service Identity; the GUID will be automatically generated. -You cannot specify an Identity and a Parent. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -Language -A descriptive name for the Announcement. -This name must be unique within the service. -This name will be used in the call to the New-CsUnassignedNumber cmdlet or to the Set-CsUnassignedNumber cmdlet to specify the Announcement associated with an unassigned number range. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The language in which the text-to-speech (TTS) prompt will be played. +If a value is entered for TextToSpeechPrompt, this parameter is required. + +Values are entered as a string representing the language and locale to be used. +The following is a list of valid values, followed by the language and locale in parentheses: ca-ES (Catalan, Spain); da-DK (Danish, Denmark); de-DE (German, Germany); en-AU (English, Australia); en-CA (English, Canada); en-GB (English, United Kingdom); en-IN (English, India); en-US (English, United States); es-ES (Spanish, Spain); es-MX (Spanish, Mexico); fi-FI (Finnish, Finland); fr-CA (French, Canada); fr-FR (French, France); it-IT (Italian, Italy); ja-JP (Japanese, Japan); ko-KR (Korean, Korea); nb-NO (Norwegian, Bokmal, Norway); nl-NL (Dutch, Netherlands); pl-PL (Polish, Poland); pt-BR (Portuguese, Brazil); pt-PT (Portuguese, Portugal); ru-RU (Russian, Russia); sv-SE (Swedish, Sweden); zh-CN (Chinese, People's Republic of China); zh-HK (Chinese, Hong Kong SAR); zh-TW (Chinese, Taiwan) ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFilePrompt -The name of the audio file to be played for the announcement. -Audio files are stored in the File Store. -To save an audio file to the File Store, use the Import-CsAnnouncementFile cmdlet. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A descriptive name for the Announcement. +This name must be unique within the service. +This name will be used in the call to the New-CsUnassignedNumber cmdlet or to the Set-CsUnassignedNumber cmdlet to specify the Announcement associated with an unassigned number range. + -Valid file types: WAV and WMA ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Language - -The language in which the text-to-speech (TTS) prompt will be played. -If a value is entered for TextToSpeechPrompt, this parameter is required. - -Values are entered as a string representing the language and locale to be used. -The following is a list of valid values, followed by the language and locale in parentheses: ca-ES (Catalan, Spain); da-DK (Danish, Denmark); de-DE (German, Germany); en-AU (English, Australia); en-CA (English, Canada); en-GB (English, United Kingdom); en-IN (English, India); en-US (English, United States); es-ES (Spanish, Spain); es-MX (Spanish, Mexico); fi-FI (Finnish, Finland); fr-CA (French, Canada); fr-FR (French, France); it-IT (Italian, Italy); ja-JP (Japanese, Japan); ko-KR (Korean, Korea); nb-NO (Norwegian, Bokmal, Norway); nl-NL (Dutch, Netherlands); pl-PL (Polish, Poland); pt-BR (Portuguese, Brazil); pt-PT (Portuguese, Portugal); ru-RU (Russian, Russia); sv-SE (Swedish, Sweden); zh-CN (Chinese, People's Republic of China); zh-HK (Chinese, Hong Kong SAR); zh-TW (Chinese, Taiwan) +### -Parent +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +This parameter is identical to Identity, except that Identity will accept the service Identity and the GUID, whereas Parent will accept only the service Identity; the GUID will be automatically generated. +You cannot specify an Identity and a Parent. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -227,6 +275,9 @@ Accept wildcard characters: False ``` ### -TargetUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Uniform Resource Identifier (URI) to which the caller will be transferred after the announcement has been played. This value must be a SIP address entered in the format sip: followed by the SIP address. For example, sip:kmyer@litwareinc.com. @@ -235,8 +286,7 @@ Note that the SIP address can also be a telephone number or voice mail, for exam ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +296,9 @@ Accept wildcard characters: False ``` ### -TextToSpeechPrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A text-to-speech (TTS) prompt. This is a string that will be converted to audio and played as the announcement. @@ -254,24 +307,7 @@ If both AudioFilePrompt and TextToSpeechPrompt are specified for a single announ ```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 -``` - -### -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 +Aliases: Required: False Position: Named @@ -280,18 +316,16 @@ 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-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -301,29 +335,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -337,12 +357,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement. ## NOTES diff --git a/skype/skype-ps/skype/New-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsArchivingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsArchivingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsArchivingConfiguration.md index 16ef9e0722..a5d58262d1 100644 --- a/skype/skype-ps/skype/New-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsArchivingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsArchivingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csarchivingconfiguration +schema: 2.0.0 +title: New-CsArchivingConfiguration --- # New-CsArchivingConfiguration @@ -46,7 +47,7 @@ Alternatively, you can use the New-CsArchivingConfiguration cmdlet to create cus ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsArchivingConfiguration -Identity site:Redmond -EnableArchiving "ImOnly" @@ -56,7 +57,7 @@ The command shown in Example 1 creates a new collection of archiving configurati By adding the EnableArchiving parameter and setting the parameter value to "ImOnly", the command also enables IM session archiving (but not web conference archiving) for the Redmond site. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsArchivingConfiguration -Identity site:Redmond -InMemory @@ -77,34 +78,10 @@ If you do not call the Set-CsArchivingConfiguration cmdlet, these settings will ## PARAMETERS -### -Identity - -Unique identifier to be assigned to the new collection of archiving configuration settings. -In Skype for Business Server you can create new collections at the site scope or at the service scope. -To create new settings at the site scope, use syntax similar to this: - -`-Identity "site:Redmond"` - -To create settings at the service scope (for the Registrar service only) use syntax like this: - -`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` - - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ArchiveDuplicateMessages -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ArchiveDuplicateMessages Specifies how cross-pool instant messages should be archived. For example, Ken Myer (with an account in Pool 1) sends an instant message to Pilar Ackerman (who has an account in Pool 2). Pilar, in turn, sends a reply to Ken's instant message. @@ -114,8 +91,7 @@ If ArchiveDuplicateMessages is set to True (the default value), the transcript w ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,14 +101,16 @@ Accept wildcard characters: False ``` ### -BlockOnArchiveFailure + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, then the IM service will be suspended any time your instant message sessions cannot be archived. If set to False (the default value), instant messaging will continue even if sessions cannot be archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +121,8 @@ Accept wildcard characters: False ### -CachePurgingInterval +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often (in hours) the system is purged of transcripts where none of the participants have been enabled for archiving. By design, all group IM sessions and conferencing sessions are recorded when they take place. At the specified interval, the system will determine whether any of the participants in these sessions have been enabled for archiving. @@ -156,8 +136,7 @@ The default value is 24. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +146,9 @@ Accept wildcard characters: False ``` ### -EnableArchiving + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates which items (if any) are saved to the archiving database. Valid values are: @@ -183,8 +165,30 @@ Both IM and web conferencing sessions are archived to the database. ```yaml Type: EnableArchiving Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExchangeArchiving + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, Skype for Business Server instant message and conferencing transcripts are stored in Exchange rather than a separate SQL Server database. +Note that if you enable Exchange archiving then users will be managed by the Exchange archiving policies instead of Skype for Business Server archiving policies. + +The default value is False. + + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -194,6 +198,9 @@ Accept wildcard characters: False ``` ### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, archived instant messages will periodically be removed from the database, provided that these instant messages: 1) are older than the value specified in the KeepArchivingDataForDays property; or, 2) have been exported and marked for deletion. If False, instant messages will not be automatically deleted from the database. @@ -201,8 +208,7 @@ If False, instant messages will not be automatically deleted from the database. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -211,17 +217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepArchivingDataForDays -Number of days (between 1 and 2562) that archived instant messages are kept in the database before being automatically deleted. -The default value is 14. +### -Force -This property takes effect only if EnablePurging has been set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,37 +235,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PurgeExportedArchivesOnly -If True, then the system will only purge instant messages that have been exported (and, as a result, have been marked for deletion). -Instant messages that have not been exported will remain in the database, even if those messages are older than the value specified by the KeepArchivingDataForDays property. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier to be assigned to the new collection of archiving configuration settings. +In Skype for Business Server you can create new collections at the site scope or at the service scope. +To create new settings at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +To create settings at the service scope (for the Registrar service only) use syntax like this: + +`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` + + ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PurgeHourOfDay -Indicates the time of day when expired records are deleted from the archiving database. -The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 AM) and 23 representing 11:00 PM. -Note that you can only specify the hour of the day. -This means that you can schedule purging to take place at 4:00 AM, but you cannot schedule it to take place at, for instance, 4:30 AM or 4:15 AM. -The default value is 2 (2:00 AM). +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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-\. + -Database purging takes place only if the EnablePurging property is set to True. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -269,14 +284,19 @@ 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. +### -KeepArchivingDataForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Number of days (between 1 and 2562) that archived instant messages are kept in the database before being automatically deleted. +The default value is 14. + +This property takes effect only if EnablePurging has been set to True. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -285,18 +305,17 @@ 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-\. +### -PurgeExportedArchivesOnly +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +If True, then the system will only purge instant messages that have been exported (and, as a result, have been marked for deletion). +Instant messages that have not been exported will remain in the database, even if those messages are older than the value specified by the KeepArchivingDataForDays property. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -305,14 +324,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the time of day when expired records are deleted from the archiving database. +The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 AM) and 23 representing 11:00 PM. +Note that you can only specify the hour of the day. +This means that you can schedule purging to take place at 4:00 AM, but you cannot schedule it to take place at, for instance, 4:30 AM or 4:15 AM. +The default value is 2 (2:00 AM). + +Database purging takes place only if the EnablePurging property is set to True. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -322,13 +349,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -337,20 +366,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableExchangeArchiving - -When set to True, Skype for Business Server instant message and conferencing transcripts are stored in Exchange rather than a separate SQL Server database. -Note that if you enable Exchange archiving then users will be managed by the Exchange archiving policies instead of Skype for Business Server archiving policies. - -The default value is False. +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -364,13 +389,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsArchivingConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings The New-CsArchivingConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsArchivingPolicy.md similarity index 88% rename from skype/skype-ps/skype/New-CsArchivingPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsArchivingPolicy.md index 1abff2dd90..b10bea8433 100644 --- a/skype/skype-ps/skype/New-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsArchivingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsArchivingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csarchivingpolicy +schema: 2.0.0 +title: New-CsArchivingPolicy --- # New-CsArchivingPolicy @@ -54,7 +55,7 @@ You cannot create a new policy at the global scope. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsArchivingPolicy -Identity site:Redmond -ArchiveInternal $True @@ -64,7 +65,7 @@ In Example 1, the New-CsArchivingPolicy cmdlet is used to create a new archiving In addition, the ArchiveInternal parameter is set to True; that means that this new policy will enable archiving for internal IM sessions and conferences. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsArchivingPolicy -Identity site:Redmond -InMemory @@ -86,31 +87,10 @@ Finally, the last command in the example uses the Set-CsArchivingPolicy cmdlet t ## PARAMETERS -### -Identity -Indicates the unique Identity to be assigned to the policy. -New archiving policies can be created at the site scope or the per-user scope. -To create a new site policy, use the prefix "site:" followed by the name of the site. -For example, this syntax creates a new policy for the Redmond site: `-Identity site:Redmond.` -To create a new per-user policy, use an Identity similar to this: `-Identity SalesArchivingPolicy.` - -Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsArchivingPolicy cmdlet instead. -Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ArchiveExternal +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether external IM sessions are archived. (An external IM session is one in which at least one of the participants is an unauthenticated user who does not have an Active Directory account within your organization.) The default value is False, which means that IM sessions that include external users are not archived. @@ -119,8 +99,7 @@ Indicates whether external IM sessions are archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,14 +109,16 @@ Accept wildcard characters: False ``` ### -ArchiveInternal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether internal IM sessions are archived. (An internal IM session is one in which all the participants are authenticated users who have Active Directory accounts within your organization.) The default value is False, which means that internal IM sessions are not archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,14 +128,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide a brief description of the archiving policy. For example, the Description might be used to detail which users the policy should be applied to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,13 +147,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,8 +164,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the unique Identity to be assigned to the policy. +New archiving policies can be created at the site scope or the per-user scope. +To create a new site policy, use the prefix "site:" followed by the name of the site. +For example, this syntax creates a new policy for the Redmond site: `-Identity site:Redmond.` +To create a new per-user policy, use an Identity similar to this: `-Identity SalesArchivingPolicy.` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsArchivingPolicy cmdlet instead. +Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -189,8 +201,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,14 +210,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new archiving 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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -216,13 +236,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -231,21 +253,16 @@ 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 archiving policy is being created. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -259,13 +276,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsArchivingPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy The New-CsArchivingPolicy cmdlet creates instances of the Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAutodiscoverConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsAutodiscoverConfiguration.md index 0e9d77cb0a..ae3c47995c 100644 --- a/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAutodiscoverConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csautodiscoverconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAutodiscoverConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csautodiscoverconfiguration +schema: 2.0.0 +title: New-CsAutodiscoverConfiguration --- # New-CsAutodiscoverConfiguration @@ -54,7 +55,7 @@ When you install Skype for Business Server a global collection of settings will ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAutoDiscoverConfiguration -Identity "site:Redmond" @@ -64,7 +65,7 @@ The command shown in Example 1 creates a new collection of Autodiscover configur Because the WebLinks parameter was not included, these settings will not contain any Autodiscover URLs. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscover.fabrikam.com" @@ -83,33 +84,16 @@ That syntax causes the values stored in the variables $Link1 and $Link2 to be ad ## PARAMETERS -### -Identity -Unique identifier for the collection of Autodiscover configuration settings to be modified. -To create a collection configured at the site scope, use syntax similar to this: - -`-Identity "site:Redmond"` +### -EnableCertificateProvisioningServiceUrl -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +When set to True (the default value), the Certificate Provisioning Service URL is included in Autodiscover Service responses. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,13 +103,15 @@ Accept wildcard characters: False ``` ### -ExternalSipClientAccessFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the server used for external client access. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,13 +121,15 @@ Accept wildcard characters: False ``` ### -ExternalSipClientAccessPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for eternal client access. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +139,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,15 +156,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the collection of Autodiscover configuration settings to be modified. +To create a collection configured at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of a command 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 the Set-CsAutoDiscoverConfiguration cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,14 +197,16 @@ Accept wildcard characters: False ``` ### -WebLinks + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of Autodiscover URLs. These URLs must be created by using the New-CsWebLink cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,14 +215,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -216,14 +233,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableCertificateProvisioningServiceUrl -When set to True (the default value), the Certificate Provisioning Service URL is included in Autodiscover Service responses. +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -237,15 +256,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### None New-CsAutoDiscoverConfiguration does not accept pipelined input. -### -The New-CsAutoDiscoverConfiguration cmdlet does not accept pipelined input. - ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsBandwidthPolicyServiceConfiguration.md similarity index 83% rename from skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsBandwidthPolicyServiceConfiguration.md index 3a2dc9990e..99c9d65747 100644 --- a/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsBandwidthPolicyServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsBandwidthPolicyServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csbandwidthpolicyserviceconfiguration +schema: 2.0.0 +title: New-CsBandwidthPolicyServiceConfiguration --- # New-CsBandwidthPolicyServiceConfiguration @@ -38,7 +39,7 @@ This cmdlet configures a new bandwidth policy service at the site level. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond @@ -48,7 +49,7 @@ This example creates a new bandwidth policy service configuration at the site Re No other parameters are specified, so the defaults are used for all configuration values. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsBandwidthPolicyServiceConfiguration -Identity site:Dublin -EnableLogging $True -LogCleanupInterval 30.00:00:00 @@ -62,15 +63,55 @@ The LogCleanupInterval value is a TimeSpan object, which is in the format dd.hh: ## PARAMETERS +### -EnableLogging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Set this parameter to True to generate CAC failure and link status logs related to the bandwidth policy service. + +Default: False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier that contains the scope and name of the configuration. This configuration can be created only at the site scope, so the Identity will be in the following format: site:\, where \ is the name of the site to which the configuration applies. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -79,16 +120,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLogging -Set this parameter to True to generate CAC failure and link status logs related to the bandwidth policy service. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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-\. + -Default: False ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +142,9 @@ Accept wildcard characters: False ``` ### -LogCleanUpInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The period of time after which CAC failure and link status logs will be removed. This value must be within the range 1 day through 60 days. @@ -108,8 +155,7 @@ Default: 10 days (10.00:00:00) ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +165,9 @@ Accept wildcard characters: False ``` ### -MaxLogFileSizeMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum size the log file is allowed to reach. The value for this parameter must be a positive number; it specifies the file size in megabytes. @@ -127,8 +176,7 @@ Default: 3 (MB) ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +186,9 @@ Accept wildcard characters: False ``` ### -MaxTokenLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of time the token issued by the Bandwidth Policy Authentication service will exist. This value must be in the range 1 hour through 24 hours. @@ -148,24 +199,7 @@ Default: 8 hours (08:00:00) ```yaml Type: TimeSpan 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 -``` - -### -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 +Aliases: Required: False Position: Named @@ -174,18 +208,16 @@ 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-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -195,29 +227,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -231,12 +249,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/New-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsBlockedDomain.md similarity index 89% rename from skype/skype-ps/skype/New-CsBlockedDomain.md rename to skype/skype-ps/SkypeForBusiness/New-CsBlockedDomain.md index 4b9231b7d5..1ec03640d5 100644 --- a/skype/skype-ps/skype/New-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsBlockedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsBlockedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csblockeddomain +schema: 2.0.0 +title: New-CsBlockedDomain --- # New-CsBlockedDomain @@ -54,7 +55,7 @@ The New-CsBlockedDomain cmdlet enables you to add a domain to the list of blocke ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsBlockedDomain -Identity "fabrikam.com" -Comment "Blocked per Ken Myer." @@ -66,7 +67,7 @@ In addition, the Comment parameter is included in order to add a comment to the Note that this command will fail if fabrikam.com is already on the blocked list or on the allowed list. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsBlockedDomain -Identity "fabrikam.com" -InMemory @@ -90,36 +91,17 @@ Instead, the virtual domain will disappear as soon as you end your Windows Power ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the domain to be added to the blocked list; for example, "fabrikam.com". -You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. -If you use Identity, the Domain property will be set to the same value assigned to Identity. -If you use Domain, the Identity property will be set to the same value that is assigned to Domain. - -Note that Identities must be unique: if the specified domain already exists on either the blocked or the allowed list, the command will fail. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Comment -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Comment Optional string value that provides additional information about the blocked domain. For example, you might add a Comment that explains why the domain has been blocked. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,6 +111,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN (for example, fabrikam.com) of the domain to be added to the blocked list. You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. If you use Identity, the Domain property will be set to the same value that is assigned to Identity. @@ -139,8 +124,7 @@ Note that Domains must be unique: if the specified domain already exists on eith ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -150,13 +134,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,8 +151,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the domain to be added to the blocked list; for example, "fabrikam.com". +You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. +If you use Identity, the Domain property will be set to the same value assigned to Identity. +If you use Domain, the Identity property will be set to the same value that is assigned to Domain. + +Note that Identities must be unique: if the specified domain already exists on either the blocked or the allowed list, the command will fail. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -175,8 +186,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,14 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -201,14 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -222,13 +236,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsBlockedDomain cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/New-CsCallParkOrbit.md similarity index 87% rename from skype/skype-ps/skype/New-CsCallParkOrbit.md rename to skype/skype-ps/SkypeForBusiness/New-CsCallParkOrbit.md index fb35a67100..da290a9e16 100644 --- a/skype/skype-ps/skype/New-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCallParkOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsCallParkOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscallparkorbit +schema: 2.0.0 +title: New-CsCallParkOrbit --- # New-CsCallParkOrbit @@ -39,7 +40,7 @@ You can create multiple call park orbits; each must have a globally unique name ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsCallParkOrbit -Identity "Redmond CPO 1" -NumberRangeStart 100 -NumberRangeEnd 199 -CallParkService ApplicationServer:pool0.litwareinc.com @@ -49,7 +50,7 @@ This example creates a new call park orbit named "Redmond CPO 1" on the Applicat The available number range for this call park orbit is 100 through 199. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsCallParkOrbit -Identity "Redmond CPO 2" -NumberRangeStart "*1000" -NumberRangeEnd "*1999" -CallParkService pool0.litwareinc.com @@ -59,7 +60,7 @@ This example creates a new call park orbit named "Redmond CPO 2" on the Call Par The available range for this call park orbit is *1000 through *1999. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsCallParkOrbit -Identity "Redmond CPO 3" -NumberRangeStart "#1000" -NumberRangeEnd "#1999" -CallParkService ApplicationServer:redmond.litwareinc.com @@ -71,8 +72,47 @@ The available range for this call park orbit is #1000 through #1999. ## PARAMETERS +### -CallParkService + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) or service ID of the Application service that hosts the Call Park application. +All calls parked to numbers within the range specified by the NumberRangeStart and NumberRangeEnd parameters will be routed to this server or pool. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: CallParkServerFqdn + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the call park orbit range. This name must be unique within the Skype for Business Server deployment. This string can be any value, but should be something that allows for easy identification of the particular call park orbit range. @@ -83,8 +123,7 @@ All call park orbit ranges are created with a global scope. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -93,44 +132,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallParkService -The fully qualified domain name (FQDN) or service ID of the Application service that hosts the Call Park application. -All calls parked to numbers within the range specified by the NumberRangeStart and NumberRangeEnd parameters will be routed to this server or pool. +### -InMemory -```yaml -Type: String -Parameter Sets: (All) -Aliases: CallParkServerFqdn -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +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-\. -### -NumberRangeStart -The first number in the range for this call park orbit. -The value must be less than or equal to the NumberRangeEnd. -The value must also be the same length as the value of the NumberRangeEnd. -Valid values: Must match the regular expression string (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). -This means that the value must be a string beginning with either the character * or # or a number 1 through 9 (the first character cannot be a zero). -If the first character is * or # the following character must be a number 1 through 9 (it cannot be a zero). -Subsequent characters can be any number 0 through 9 up to seven additional characters. -(For example, #6000, *92000, and *95551212.) The number following the * or # must be greater than 100. -If the first character is not * or #, the first character must be a number 1 through 9 (it cannot be zero), followed by up to eight characters, each a number 0 through 9. -(For example, 915551212;41212;300) ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 3 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -138,6 +155,8 @@ Accept wildcard characters: False ### -NumberRangeEnd +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The last number in the range for this call park orbit. The value must be greater than or equal to the NumberRangeStart. The value must also be the same length as the value of the NumberRangeStart. @@ -156,8 +175,7 @@ Subsequent characters can be any number 0 through 9 up to seven additional chara ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 4 @@ -166,50 +184,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -NumberRangeStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The first number in the range for this call park orbit. +The value must be less than or equal to the NumberRangeEnd. +The value must also be the same length as the value of the NumberRangeEnd. + +Valid values: Must match the regular expression string (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). +This means that the value must be a string beginning with either the character * or # or a number 1 through 9 (the first character cannot be a zero). +If the first character is * or # the following character must be a number 1 through 9 (it cannot be a zero). +Subsequent characters can be any number 0 through 9 up to seven additional characters. +(For example, #6000, *92000, and *95551212.) The number following the * or # must be greater than 100. +If the first character is not * or #, the first character must be a number 1 through 9 (it cannot be zero), followed by up to eight characters, each a number 0 through 9. +(For example, 915551212;41212;300) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Type -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-\. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the type of call park orbit being created. +Skype for Business Server allows for two different types of call park orbits: +CallPark. +This is the standard call park orbit, in which a user places a call on hold and then can retrieve that call from any phone by dialing the specified call park number. +CallPark is the default orbit type and will be used if the Type parameter is not specified. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +GroupPickup. +With group pickup, users can answer any incoming call that is made to any member of their call pickup group. +Call pickup groups are configured by administrators. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +To specify a call park orbit type, use syntax similar to this: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Type GroupPickup` + +This parameter was introduced in the February 2013 release of Lync Server 2013. ```yaml -Type: SwitchParameter +Type: OrbitType Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,13 +246,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -234,29 +263,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Specifies the type of call park orbit being created. -Skype for Business Server allows for two different types of call park orbits: - -CallPark. -This is the standard call park orbit, in which a user places a call on hold and then can retrieve that call from any phone by dialing the specified call park number. -CallPark is the default orbit type and will be used if the Type parameter is not specified. - -GroupPickup. -With group pickup, users can answer any incoming call that is made to any member of their call pickup group. -Call pickup groups are configured by administrators. +### -WhatIf -To specify a call park orbit type, use syntax similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Type GroupPickup` - -This parameter was introduced in the February 2013 release of Lync Server 2013. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: OrbitType +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -270,12 +286,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit This cmdlet creates an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit. ## NOTES diff --git a/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsCallViaWorkPolicy.md similarity index 85% rename from skype/skype-ps/skype/New-CsCallViaWorkPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsCallViaWorkPolicy.md index cc14b7f786..0f98d2be99 100644 --- a/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCallViaWorkPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsCallViaWorkPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscallviaworkpolicy +schema: 2.0.0 +title: New-CsCallViaWorkPolicy --- # New-CsCallViaWorkPolicy @@ -28,7 +29,7 @@ This cmdlet creates a new call via work policy. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsCallViaWorkPolicy -Identity Site:Redmond -Enabled $true -AdminCallbackNumber +14258881234 -UseAdminCallbackNumber $true @@ -40,32 +41,10 @@ The policy is enabled, the administrative callback number is specified and enfor ## PARAMETERS -### -Identity -Unique identity to be assigned to the policy. -New 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 the Identity. -For example, to create a new policy for the Redmond site you would use this syntax: `-Identity site:Redmond`. -To create a new per-user policy, this syntax: `-Identity SalesDepartmentPolicy`. - -You cannot create a new global policy. -If you want to make changes to the global policy, use the Set-CsCallViaWorkPolicy 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-CsCallViaWorkPolicy cmdlet. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -AdminCallbackNumber -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -AdminCallbackNumber Specifies the number that will be called during the call back to the Skype for Business user before placing the external call. Typically this is the user's desk phone. If you want the user be able to change the callback number, use the UseAdminCallbackNumber switch. @@ -75,8 +54,7 @@ For instance, "12068881234" or "+12068881234". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -85,14 +63,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Enabled + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether the policy is enabled at creation. +The default is false ($False). ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -101,15 +82,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Specifies whether the policy is enabled at creation. -The default is false ($False). +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,31 +100,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identity to be assigned to the policy. +New 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 the Identity. +For example, to create a new policy for the Redmond site you would use this syntax: `-Identity site:Redmond`. +To create a new per-user policy, this syntax: `-Identity SalesDepartmentPolicy`. + +You cannot create a new global policy. +If you want to make changes to the global policy, use the Set-CsCallViaWorkPolicy 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-CsCallViaWorkPolicy cmdlet. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +147,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -168,6 +165,9 @@ Accept wildcard characters: False ``` ### -UseAdminCallbackNumber + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If true ($True), the number specified in the AdminCallbackNumber is the only number that will be used for the callback to the user, or first leg, of the outbound call. If false ($False), the user has the opportunity to change the callback number through the client. The user might choose to change the call back number to a personal phone number like a mobile, home, or hotel phone number. @@ -175,8 +175,25 @@ The user might choose to change the call back number to a personal phone number ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -186,13 +203,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -206,12 +225,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.CallViaWork.CallViaWorkPolicy The New-CsCallViaWorkPolicy returns Microsoft.Rtc.Management.WritableConfig.Policy.CallViaWork.CallViaWorkPolicy instances. ## NOTES diff --git a/skype/skype-ps/skype/New-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsCdrConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsCdrConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsCdrConfiguration.md index 68b89ad829..c2c4d6877f 100644 --- a/skype/skype-ps/skype/New-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCdrConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsCdrConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscdrconfiguration +schema: 2.0.0 +title: New-CsCdrConfiguration --- # New-CsCdrConfiguration @@ -49,7 +50,7 @@ If you try this, the command will fail. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsCdrConfiguration -Identity site:Redmond -EnableCDR $False @@ -60,7 +61,7 @@ In addition to the Identity site:Redmond, the new settings also have the EnableC Because site settings take precedence over global settings, this means that CDR will not be used in the Redmond site, regardless of whether or not CDR has been enabled at the global scope. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsCdrConfiguration -Identity site:Redmond -InMemory @@ -81,32 +82,17 @@ If the Set-CsCdrConfiguration cmdlet was not called, the virtual collection woul ## PARAMETERS -### -Identity -Represents the unique identifier to be assigned to the new collection of CDR configuration settings. -Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableCDR -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableCDR Indicates whether or not CDR is enabled. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +102,9 @@ Accept wildcard characters: False ``` ### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not CDR records will periodically be deleted from the CDR database. If True (the default value), records will be deleted after the time period specified by the properties KeepCallDetailForDays (CDR records) and the KeepErrorReportForDays (CDR errors). If False, CDR records will be maintained indefinitely. @@ -123,8 +112,65 @@ If False, CDR records will be maintained indefinitely. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the unique identifier to be assigned to the new collection of CDR configuration settings. +Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -134,6 +180,9 @@ Accept wildcard characters: False ``` ### -KeepCallDetailForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of days that CDR records will be kept in the CDR database; any records older than the specified number of days will automatically be deleted. (Note that purging will take place only if the EnablePurging property has been set to True.) @@ -143,8 +192,7 @@ The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,6 +203,8 @@ Accept wildcard characters: False ### -KeepErrorReportForDays +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of days that CDR error reports are kept; any reports older than the specified number of days will automatically be deleted. CDR error reports are diagnostic reports uploaded by client applications such as Skype for Business. @@ -166,8 +216,7 @@ The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,6 +226,9 @@ Accept wildcard characters: False ``` ### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the local time of day when expired records are deleted from the CDR database. The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 A.M.) and 23 representing 11:00 P.M. Note that you can only specify the hour of the day; that means that you can schedule purging to take place at 4:00 A.M. @@ -190,24 +242,7 @@ Database purging takes place only if the EnablePurging property is set to True. ```yaml Type: UInt32 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 -``` - -### -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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -216,18 +251,16 @@ 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-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -237,29 +270,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -273,13 +292,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsCdrConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicy.md similarity index 81% rename from skype/skype-ps/skype/New-CsClientPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsClientPolicy.md index 38bddfb4fe..f883a84825 100644 --- a/skype/skype-ps/skype/New-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: New-CsClientPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclientpolicy +schema: 2.0.0 +title: New-CsClientPolicy --- # New-CsClientPolicy @@ -84,7 +86,7 @@ The following parameters are not applicable to Skype for Business Online: Addres ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- (Skype for Business Server) +### EXAMPLE 1 (Skype for Business Server) ``` New-CsClientPolicy -Identity RedmondClientPolicy -DisableCalendarPresence $True -DisablePhonePresence $True -DisplayPhoto "PhotosFromADOnly" ``` @@ -92,7 +94,7 @@ New-CsClientPolicy -Identity RedmondClientPolicy -DisableCalendarPresence $True The command shown in Example 1 creates a new client policy with the Identity RedmondClientPolicy. In addition to specifying the Identity, this command also includes three optional parameters and their parameter values: DisableCalendarPresence, DisablePhonePresence, and DisplayPhoto. -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server) +### EXAMPLE 2 (Skype for Business Server) ``` $x = New-CsClientPolicy -Identity RedmondClientPolicy -InMemory @@ -117,28 +119,10 @@ If you do not call the Set-CsClientPolicy cmdlet the policy RedmondClientPolicy ## PARAMETERS -### -Identity - -Unique Identity to be assigned to the new policy. -New client 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 SalesClientPolicy.` - -```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 +### -AddressBookAvailability -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -AddressBookAvailability Indicates how users are allowed to access information by using the Address Book Web Query service and/or by downloading a copy of the Address Book to their local computer). AddressBookAvailability must be set to one of the following values: @@ -151,8 +135,7 @@ FileDownloadOnly ```yaml Type: AddressBookAvailability 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 +Aliases: Required: False Position: Named @@ -162,14 +145,16 @@ Accept wildcard characters: False ``` ### -AttendantSafeTransfer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Attendant operates in "safe transfer" mode; this means that transferred calls that do not reach the intended recipient will reappear in the incoming area along with a "Failed Transfer" notice. When set to False, transferred calls that fail to reach the intended recipient will not reappear in the incoming area. ```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 +Aliases: Required: False Position: Named @@ -179,6 +164,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoveryRetryInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + After a failed connection attempt, specifies the amount of time Skype for Business waits before trying again to connect to Skype for Business Server. The AutoDiscoveryRetryInterval can be set to value between 1 second and 60 minutes (1 hour), inclusive. @@ -188,8 +176,7 @@ For example, to set the interval to 25 minutes use this syntax: `- AutoDiscovery ```yaml Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -199,6 +186,9 @@ Accept wildcard characters: False ``` ### -BlockConversationFromFederatedContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, contacts from outside your organization will not be allowed to initiate instant messaging conversations with any user that this policy applies to. However, outside users will be able to participate in conversations as long as the internal user initiates that conversation. When set to False, outside contacts are allowed to send unsolicited instant messages to users in your organization. @@ -206,8 +196,7 @@ When set to False, outside contacts are allowed to send unsolicited instant mess ```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 +Aliases: Required: False Position: Named @@ -217,6 +206,9 @@ Accept wildcard characters: False ``` ### -CalendarStatePublicationInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time, in seconds, that Skype for Business waits before retrieving calendar information from Microsoft Outlook and adding this data to your presence information. For example, to set the CalendarStatePublicationInterval to 10 minutes (600 seconds) use this syntax: @@ -226,8 +218,7 @@ For example, to set the CalendarStatePublicationInterval to 10 minutes (600 seco ```yaml Type: UInt32 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 +Aliases: Required: False Position: Named @@ -237,6 +228,9 @@ Accept wildcard characters: False ``` ### -ConferenceIMIdleTimeout + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of minutes that a user can remain in an instant messaging session without either sending or receiving an instant message. The ConferenceIMIdleTimeout must be less than or equal to 1 hour, and must be specified using the format hours:minutes:seconds. @@ -247,8 +241,7 @@ For example, this syntax sets the timeout value to 45 minutes: ```yaml Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -258,6 +251,9 @@ Accept wildcard characters: False ``` ### -CustomizedHelpUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + URL for custom help set up by an organization. This help, rather than the default product help, will be displayed any time a user clicks the Help menu in Skype for Business. @@ -268,8 +264,7 @@ This parameter has been deprecated for use with Skype for Business Server. ```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 +Aliases: Required: False Position: Named @@ -279,6 +274,9 @@ Accept wildcard characters: False ``` ### -CustomLinkInErrorMessages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the website that can be added to error messages that appear in Skype for Business. If a URL is specified, that URL will appear at the bottom of any error message that occurs in Skype for Business. Users can then click that link and be taken to a custom website that contains additional information, such as troubleshooting tips. @@ -286,8 +284,7 @@ Users can then click that link and be taken to a custom website that contains ad ```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 +Aliases: Required: False Position: Named @@ -297,14 +294,16 @@ Accept wildcard characters: False ``` ### -CustomStateUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the location of the XML file used to add custom presence states to Skype for Business. (Skype for Business allows up to four custom presence states in addition to the built-in states such as Available, Busy, and Do Not Disturb.) The location of the XML file should be specified using the HTTPS protocol. ```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 +Aliases: Required: False Position: Named @@ -314,14 +313,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Allows administrators to provide additional information about a policy. For example, the Description might indicate which 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 +Aliases: Required: False Position: Named @@ -331,6 +332,9 @@ Accept wildcard characters: False ``` ### -DGRefreshInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the amount of time Skype for Business waits before automatically refreshing the membership list of any distribution group that has been "expanded" in the Contacts list. (Expanding a distribution group means displaying all the members in that group.) DGRefreshInterval can be set to any integer value between 30 seconds and 28,800 seconds (8 hours), inclusive. The default value is 28,800 seconds. @@ -338,8 +342,7 @@ The default value is 28,800 seconds. ```yaml Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -349,6 +352,9 @@ Accept wildcard characters: False ``` ### -DisableCalendarPresence + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, calendar data taken from Microsoft Outlook will not be included in your presence information. When set to False, calendar data will be included in your presence information. For example, free/busy information will be reported in your contact card. @@ -357,8 +363,7 @@ Likewise, your status will automatically be set to Busy any time Outlook shows t ```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 +Aliases: Required: False Position: Named @@ -368,14 +373,16 @@ Accept wildcard characters: False ``` ### -DisableContactCardOrganizationTab + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the contact card Organization tab is not visible within the Skype for Business user interface. When set to False, the contact card Organization tab is available in Skype for Business. ```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 +Aliases: Required: False Position: Named @@ -385,6 +392,9 @@ Accept wildcard characters: False ``` ### -DisableEmailComparisonCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not attempt to verify that any currently running instance of Microsoft Outlook belongs to the same user running Skype for Business; for example, the software will not verify that both Outlook and Skype for Business are running under Ken Myer's user account. Instead, it will be assumed that the two applications are running under the same account and, in turn, will include contact and calendar data in Outlook with Skype for Business. @@ -394,8 +404,7 @@ If the SMTP addresses do not match, then contact and calendar data in Outlook wi ```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 +Aliases: Required: False Position: Named @@ -405,6 +414,9 @@ Accept wildcard characters: False ``` ### -DisableEmoticons + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be able to send or receive emoticons in their instant messages; instead they will be see the text equivalent of those emoticons. For example, instead of seeing a graphical "smiley face," users will see the text equivalent: @@ -415,8 +427,7 @@ When set to False, users will be able to include emoticons in their instant mess ```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 +Aliases: Required: False Position: Named @@ -426,14 +437,16 @@ Accept wildcard characters: False ``` ### -DisableFederatedPromptDisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any notification dialog box generated when you are added to a federated user's Contacts list will use the federated user's SIP address (for example, sip:kenmyer@fabrikam.com). When set to False, the notification dialog box will use the federated user's display name (for example, Ken Myer) 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 +Aliases: Required: False Position: Named @@ -443,14 +456,16 @@ Accept wildcard characters: False ``` ### -DisableFeedsTab + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the activity feeds tab will not be displayed in Skype for Business. When set to False, the feeds tab will be available within Skype for Business. ```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 +Aliases: Required: False Position: Named @@ -460,6 +475,9 @@ Accept wildcard characters: False ``` ### -DisableFreeBusyInfo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, free/busy information retrieved from Microsoft Outlook will not be displayed in your contact card. When set to False, free/busy information is displayed in your contact card. For example, your contact card might include a note similar to this: @@ -469,8 +487,7 @@ Calendar: Free until 2:00 PM ```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 +Aliases: Required: False Position: Named @@ -480,6 +497,9 @@ Accept wildcard characters: False ``` ### -DisableHandsetOnLockedMachine + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be able to use their Polycom handset if the computer that the handset is connected to is locked. To use the handset, users will first have to unlock the computer. @@ -488,8 +508,7 @@ When set to False, users will be allowed to use their Polycom handset even if th ```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 +Aliases: Required: False Position: Named @@ -499,6 +518,9 @@ Accept wildcard characters: False ``` ### -DisableHtmlIm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any HTML text copied from a webpage will be converted to plain text when pasted into an instant message. When set to False, HTML formatting (such as font size and color, drop-down lists, and buttons) will be retained when pasted into an instant message. @@ -508,8 +530,7 @@ You can copy and paste buttons and other controls into a message, but any script ```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 +Aliases: Required: False Position: Named @@ -519,6 +540,9 @@ Accept wildcard characters: False ``` ### -DisableICE + +> Applicable: Lync Server 2010 + When set to True, Lync 2010 will not use the Interactive Connectivity Establishment (ICE) protocol to traverse firewalls and network address translation (NAT) devices; this effectively prevents users from making Lync 2010 calls across the Internet. When set to False, Lync 2010 will use the ICE protocol to enable Lync 2010 calls to traverse firewalls and NAT devices. @@ -527,8 +551,7 @@ This setting is equivalent to the Communications Server 2007 R2 Group Policy set ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -538,14 +561,38 @@ Accept wildcard characters: False ``` ### -DisableInkIM + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be allowed to receive instant messages containing Tablet PC ink. (Ink is a technology that enables you to insert handwritten notes into a document.) When set to False, users will be allowed to receive messages that contain Tablet PC ink. ```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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableMeetingSubjectAndLocation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, detailed information about a meeting -- namely, the meeting subject and the location where the meeting is being held -- will be displayed as a tooltip when you view free/busy information in a contact card. +When set to True, this detailed information will not be displayed. +To completely prevent the display of meeting-related information you should also set DisableCalendarPresence to True. + + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -555,6 +602,9 @@ Accept wildcard characters: False ``` ### -DisableOneNote12Integration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the ability to start Microsoft OneNote from within Skype for Business (and the ability to automatically link instant messaging sessions and OneNote notes) is disabled. When set to False, the option Take Notes Using OneNote is enabled in Skype for Business. In addition, if you locate an instant message transcript in Microsoft Outlook's Conversation History, you can retrieve any OneNote notes associated with that conversation just by clicking the Edit conversation notes button. @@ -562,8 +612,7 @@ In addition, if you locate an instant message transcript in Microsoft Outlook's ```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 +Aliases: Required: False Position: Named @@ -573,6 +622,9 @@ Accept wildcard characters: False ``` ### -DisableOnlineContextualSearch + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, disables the Find Previous Conversations menu option that appears when you right-click a user in your Contacts list. (This option enables you to search the Microsoft Outlook Conversation History folder for previous instant messaging sessions involving the user in question.) When set to False, the Find Previous Conversations option will be available when you right-click a user in your Contacts list. @@ -584,8 +636,7 @@ Cached searches are not affected by this setting. ```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 +Aliases: Required: False Position: Named @@ -595,6 +646,9 @@ Accept wildcard characters: False ``` ### -DisablePhonePresence + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business does not take phone calls into consideration when determining your current status. When set to False, phone calls are taken into consideration when determining your status. For example, any time you are on the phone your status will automatically be set to Busy. @@ -602,8 +656,7 @@ For example, any time you are on the phone your status will automatically be set ```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 +Aliases: Required: False Position: Named @@ -613,14 +666,16 @@ Accept wildcard characters: False ``` ### -DisablePICPromptDisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any notification dialog box generated when you are added to the Contacts list of a user with an account on a public instant messaging service such as MSN will display that person's SIP address (for example, sip:kenmyer@litwareinc.com). When set to False, the notification dialog box will use the person's display name (for example, Ken Myer) 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 +Aliases: Required: False Position: Named @@ -631,6 +686,8 @@ Accept wildcard characters: False ### -DisablePoorDeviceWarnings +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not issue warnings (for example, upon startup, in the Tuning Wizard, and in the Conversation window) if an audio or video device is not working correctly. When set to False, these warnings will be issued. @@ -639,8 +696,7 @@ When set to False, these warnings will be issued. ```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 +Aliases: Required: False Position: Named @@ -651,6 +707,8 @@ Accept wildcard characters: False ### -DisablePoorNetworkWarnings +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not display warnings about poor network quality. @@ -658,8 +716,7 @@ When set to True, Skype for Business will not display warnings about poor networ ```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 +Aliases: Required: False Position: Named @@ -670,6 +727,8 @@ Accept wildcard characters: False ### -DisablePresenceNote +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any Out of Office message you configure in Microsoft Outlook will not be displayed as part of your presence information. When set to False, your Out of Office message will be displayed any time a user holds the mouse over your name in their Contacts list. @@ -678,8 +737,7 @@ When set to False, your Out of Office message will be displayed any time a user ```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 +Aliases: Required: False Position: Named @@ -690,6 +748,8 @@ Accept wildcard characters: False ### -DisableRTFIM +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When both this setting and the DisableHtmlIm setting are set to True, prevents rich text formatting (for example, different fonts, font sizes, and font colors) from being used in instant messages; instead, all messages sent and received will be converted to plain text format. When set to False, rich text formatting will be allowed in instant messages. @@ -698,8 +758,7 @@ When set to False, rich text formatting will be allowed in instant messages. ```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 +Aliases: Required: False Position: Named @@ -710,6 +769,8 @@ Accept wildcard characters: False ### -DisableSavingIM +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the options for saving an instant messaging session are removed from the menu bar in the Skype for Business Conversation window. When set to False, these options are available in the Conversation window. @@ -721,8 +782,7 @@ However, it does not prevent users from copying all the text in a transcript to ```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 +Aliases: Required: False Position: Named @@ -733,6 +793,8 @@ Accept wildcard characters: False ### -DisplayPhoto +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether or not photos (of both the user and his or her contacts) will be displayed in Skype for Business. Valid settings are: @@ -749,8 +811,7 @@ The default value is AllPhotos. ```yaml Type: DisplayPhoto 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 +Aliases: Required: False Position: Named @@ -761,6 +822,8 @@ Accept wildcard characters: False ### -EnableAppearOffline +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True an additional presence state, Appear Offline, is available in Skype for Business. This state makes it appear as though the user is offline; however, he or she will actually be online and available to answer phone calls and respond to instant messages. When set to False, the Appear Offline presence state will not be available in Skype for Business. @@ -770,8 +833,7 @@ When set to False, the Appear Offline presence state will not be available in Sk ```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 +Aliases: Required: False Position: Named @@ -782,6 +844,8 @@ Accept wildcard characters: False ### -EnableCallLogAutoArchiving +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, information about your incoming and outgoing phone calls is automatically saved to the Conversation History folder in Microsoft Outlook. (The actual call itself is not recorded. What is recorded is information such as who took part in the call; the length of the call; and whether this was an incoming or an outgoing call.) When set to False, this information is not saved to Outlook. @@ -791,8 +855,25 @@ What is recorded is information such as who took part in the call; the length of ```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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableClientAutoPopulateWithTeam + +> Applicable: Skype for Business Online + +When set to true, allows a user's Skype client to be autopopulated with members of his or her immediate team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -803,6 +884,8 @@ Accept wildcard characters: False ### -EnableClientMusicOnHold +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, music will be played any time a caller is placed on hold. When set to False, music will not be played any time a caller is placed on hold. The default value is False. @@ -813,8 +896,7 @@ 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 +Aliases: Required: False Position: Named @@ -825,6 +907,8 @@ Accept wildcard characters: False ### -EnableConversationWindowTabs +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, supplemental information related to an instant messaging session will be displayed in a separate browser window. This type of information is available only for custom applications that use the Microsoft Unified Communications APIs. For example, customer service or support team personnel can automatically access related information while chatting with someone. @@ -839,8 +923,7 @@ This parameter has been deprecated for use with Skype for Business Server. ```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 +Aliases: Required: False Position: Named @@ -851,6 +934,8 @@ Accept wildcard characters: False ### -EnableEnterpriseCustomizedHelp +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users who click the Help menu in Skype for Business will be given custom help set up by the organization. This parameter has been deprecated for use with Skype for Business Server. @@ -860,8 +945,7 @@ This parameter has been deprecated for use with Skype for Business Server. ```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 +Aliases: Required: False Position: Named @@ -872,6 +956,8 @@ Accept wildcard characters: False ### -EnableEventLogging +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, detailed information about Skype for Business will be recorded in the Application event log. When set to False, only major events (such as the failure to connect to Skype for Business Server) are recorded in the event log. @@ -880,8 +966,25 @@ When set to False, only major events (such as the failure to connect to Skype fo ```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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExchangeContactsFolder + +> Applicable: Skype for Business Online + +When set to false, this allows admins to hide Skype for Business contacts from showing up in users' Outlook and Outlook on the Web clients. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -892,6 +995,8 @@ Accept wildcard characters: False ### -EnableExchangeContactSync +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True (the default value) Skype for Business creates a corresponding personal contact in Microsoft Outlook for each person on a user's Skype for Business Contacts list. @@ -899,8 +1004,7 @@ When set to True (the default value) Skype for Business creates a corresponding ```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 +Aliases: Required: False Position: Named @@ -911,6 +1015,8 @@ Accept wildcard characters: False ### -EnableExchangeDelegateSync +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, delegates that a user has configured in Microsoft Exchange will be allowed to schedule meetings for that user. @@ -919,8 +1025,7 @@ When set to True, delegates that a user has configured in Microsoft Exchange wil ```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 +Aliases: Required: False Position: Named @@ -931,6 +1036,8 @@ Accept wildcard characters: False ### -EnableFullScreenVideo +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, this parameter does two things: 1) enables full-screen video (with the correct aspect ratio) for Skype for Business calls; and, 2) disables video preview for Skype for Business calls. When set to False, full-screen video is not available in Skype for Business, but video preview is available. @@ -939,8 +1046,45 @@ When set to False, full-screen video is not available in Skype for Business, but ```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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableHighPerformanceConferencingAppSharing + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, enables better performance in applications (such as CAD/CAM applications) that have a high screen refresh rate. +However, this improved performance will reduce the system resources and network bandwidth available to other applications. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableHighPerformanceP2PAppSharing + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, allows a peer-to-peer application sharing session to exceed the maximum frame rate of 2.5 frames per second. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -951,6 +1095,8 @@ Accept wildcard characters: False ### -EnableHotdesking +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, enables users to log on to a phone running Skype for Business Phone Edition in a shared workspace by using their Skype for Business Server account. (Among other things, this provides the user access to his or her contacts.) When set to False, users are not allowed to log on to a phone by using their own credentials. @@ -963,8 +1109,7 @@ When set to False, no users will be allowed to log on to a common area phone whe ```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 +Aliases: Required: False Position: Named @@ -975,6 +1120,8 @@ Accept wildcard characters: False ### -EnableIMAutoArchiving +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, a transcript of every instant messaging session that a user takes part in will be saved to the Conversation History folder in Microsoft Outlook. When set to False, these transcripts will not be saved automatically. (However, users will have the option to manually save instant messaging transcripts.) @@ -984,8 +1131,7 @@ When set to False, these transcripts will not be saved automatically. ```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 +Aliases: Required: False Position: Named @@ -994,24 +1140,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSQMData - -Note: This setting has been deprecated for Skype for Business Server. - -When EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Program. -However, Skype for Business will provide the user with the option to join the program. - -When set to False, the user will not be enrolled in the Customer Experience Improvement Program. -In addition, Skype for Business will not give users the option of joining the program. -The only way for a user to participate in the CEIP program is for EnableSQMData to be set to True and the user to then manually opt-in to the program. +### -EnableMediaRedirection +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True) allows audio and video streams to be separated from other network traffic; in turn, this allows client devices to do encoding and decoding of audio and video locally. +Media redirection typically results in lower bandwidth usage, higher server scalability, and a more-optimal user experience compared to similar techniques such as device remoting or codec compression. ```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 +Aliases: Required: False Position: Named @@ -1020,19 +1159,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTracing - -When set to True, software tracing will be enabled in Skype for Business; when set to False, software tracing will be disabled. -Software tracing involves keeping a detailed record of everything that a program does (including tracking API calls). -Tracing is mostly useful to developers and to application support personnel. +### -EnableMeetingEngagement +> Applicable: Skype for Business Online +{{Fill EnableMeetingEngagement Description}} ```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 +Aliases: Required: False Position: Named @@ -1041,18 +1177,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableUnencryptedFileTransfer +### -EnableNotificationForNewSubscribers -When set to True, users will be allowed to exchange files with external users whose instant messaging software does not support encrypted file transfers. -When set to False, users will only be able to exchange files with external users who have software that supports encrypted file transfers. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, any time you are added to someone's Contacts list you will receive notification that you have been added to the list. +In addition, the notification dialog box will provide options for you to add this person to your Contacts list, or to block them from viewing your presence information. +When set to False, you will not be notified if you are added to someone's Contacts list. ```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 +Aliases: Required: False Position: Named @@ -1061,21 +1199,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVOIPCallDefault - -When set to True, a Skype for Business call will be placed any time a user employs the click-to-call feature. - -This policy setting only affects the initial state of the click-to-call feature. -If the user modifies the value of the click-to-call setting then the user-selected value will override this policy setting. -After a user has modified the click-to-call setting that setting will remain in use and will not be affected by the EnableVOIPCallDefault policy. +### -EnableOnlineFeedback +> Applicable: Skype for Business Online +When set to true, allows users to provide feedback through the "help->report a problem" menu options in the client. ```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 +Aliases: Required: False Position: Named @@ -1084,19 +1217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludedContactFolders +### -EnableOnlineFeedbackScreenshots -Indicates which Microsoft Outlook contact folders (if any) should not be searched any time Skype for Business searches for new contacts. -Multiple folders can be specified by separating the folder names using semicolons; for example, `-ExcludedContactFolders "SenderPhotoContacts;OtherContacts".` +> Applicable: Skype for Business Online -NOTE: When using a Skype for Business client, with either Office 2013 or Office 2016, this policy won't work in the same way. -In that combination, the Skype for Business client uses the search capabilities of Office (mso.dll), which finds contacts from Exchange mailbox contact folders. There isn't an option to suppress the search of those contact folders for the Office search component. +When set to true, allows users to provide screenshots of their clients when reporting problems. ```yaml -Type: String +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 +Aliases: Required: False Position: Named @@ -1105,25 +1235,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HotdeskingTimeout - -Timeout interval for a user logged on to a hot-desked phone. -(A hot-desked phone is a phone running Skype for Business Phone Edition that is located in a shared workspace, and that users can log on to by using their Skype for Business Server account.) The hot-desk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hot-desked phone. -When specifying a hot desking timeout you must use the format hours:minutes:seconds. -For example, this syntax sets the hot desking timeout interval to 45 minutes: - -`-HotdeskingTimeout 00:45:00` +### -EnableServerConversationHistory -Note that this policy setting applies only to common area phones and not to users. -The default value is 5 minutes (00:05:00), and the minimum value is 30 seconds (00:00:30). +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True), allows conversation histories, missed call notifications, and missed IM notifications to be stored on the server instead of in client mailboxes. +This makes it easier for users to retrieve that information from a mobile device. +The default value is False ($False). ```yaml -Type: TimeSpan +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 +Aliases: Required: False Position: Named @@ -1132,23 +1256,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMWarning - -When configured, the specified message appears in the Conversation window each time a user takes part in an instant messaging session. -For example, if IMWarning is set to "All information is the property of Litwareinc" then that message will appear in the Conversation window each time a user takes part in an instant messaging session. - -If set to a null value ($Null), then no message appears in the Conversation window. - -Your warning message should be limited to 256 characters, and can only contain plain text. -You cannot use any formatting (such as boldface or italics) and you cannot clickable URLs within the text. +### -EnableSkypeUI +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True), this parameter allows administrators to enable the Skype for Business user interface instead of the Lync interface for the Skype for Business client. ```yaml -Type: String +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 +Aliases: Required: False Position: Named @@ -1157,25 +1274,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MAPIPollInterval +### -EnableSQMData -> [!IMPORTANT] -> This parameter has been deprecated for use with Skype for Business Server. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -For users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Skype for Business retrieves calendar data from the Exchange public folders. -MAPIPollInterval can be set to any value between 1 second and 1 hour; inclusive. -To configure the MAPI poll interval, use the format hours:minutes:seconds. -For example, this command sets the MAPI poll interval to 45 minutes: +Note: This setting has been deprecated for Skype for Business Server. -`-MapiPollInterval 00:45:00` +When EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Program. +However, Skype for Business will provide the user with the option to join the program. + +When set to False, the user will not be enrolled in the Customer Experience Improvement Program. +In addition, Skype for Business will not give users the option of joining the program. +The only way for a user to participate in the CEIP program is for EnableSQMData to be set to True and the user to then manually opt-in to the program. ```yaml -Type: TimeSpan +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 +Aliases: Required: False Position: Named @@ -1184,21 +1301,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaximumDGsAllowedInContactList - -Indicates the maximum number of distribution groups that a user can configure as a contact. -MaximumDGsAllowedInContactList can be set to any integer value between 0 and 64, inclusive. -The default value is 10. +### -EnableTracing +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, software tracing will be enabled in Skype for Business; when set to False, software tracing will be disabled. +Software tracing involves keeping a detailed record of everything that a program does (including tracking API calls). +Tracing is mostly useful to developers and to application support personnel. ```yaml -Type: UInt32 +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 +Aliases: Required: False Position: Named @@ -1207,19 +1323,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaximumNumberOfContacts +### -EnableUnencryptedFileTransfer -Indicates the maximum number of contacts a user is allowed to have. -The maximum contacts can be set to any integer value between 0 and 1000, inclusive. -When set to 0, that prevents the user from having any contacts. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users will be allowed to exchange files with external users whose instant messaging software does not support encrypted file transfers. +When set to False, users will only be able to exchange files with external users who have software that supports encrypted file transfers. ```yaml -Type: UInt16 +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 +Aliases: Required: False Position: Named @@ -1228,20 +1344,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MusicOnHoldAudioFile +### -EnableURL -Path to the audio file to be played when a caller is placed on hold. -If a value is configured for this property, then music on hold will be enabled and users will not be allowed to disable the feature. -If no value is configured for this property, then users can specify their own music-on-hold file, provided that EnableClientMusicOnHold is set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, hyperlinks embedded in an instant message will be "clickable;" that is, users can click that link and their web browser will open to the specified location. +When set to False, hyperlinks will appear in instant messages as plain text. +To navigate to the location, users will need to copy the link text and paste it into their web browser. ```yaml -Type: String +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 +Aliases: Required: False Position: Named @@ -1250,30 +1366,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -P2PAppSharingEncryption - -Indicates whether or not desktop and application sharing data exchanged during a peer-to-peer conversation is encrypted. -Allowed values are: - -Supported. -Desktop and application sharing data will be encrypted, if possible. - -Enforced. -Desktop and application sharing data must be encrypted. -If the data cannot be encrypted, then desktop and application sharing will not be enabled for the conversation. - -NotSupported. -Desktop and application sharing data will not be encrypted. - - +### -EnableViewBasedSubscriptionMode +> Applicable: Skype for Business Online +{{Fill EnableViewBasedSubscriptionMode Description}} ```yaml -Type: P2PAppSharingEncryption +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 +Aliases: Required: False Position: Named @@ -1282,18 +1384,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PlayAbbreviatedDialTone +### -EnableVOIPCallDefault -When set to True, a 3-second dial tone will be played any time a Skype for Business-compatible handset is taken off the hook. -(A Skype for Business handset looks like a standard telephone, but plugs into a USB port on a computer and is used to make Skype for Business calls rather than "regular" phone calls.) When set to False, a 30-second dial tone is played any time a Skype for Business-compatible handset is taken off the hook. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, a Skype for Business call will be placed any time a user employs the click-to-call feature. + +This policy setting only affects the initial state of the click-to-call feature. +If the user modifies the value of the click-to-call setting then the user-selected value will override this policy setting. +After a user has modified the click-to-call setting that setting will remain in use and will not be affected by the EnableVOIPCallDefault policy. ```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 +Aliases: Required: False Position: Named @@ -1302,23 +1408,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyEntry - -Provides a way to add settings not covered by the default parameters. -For example, when testing pre-release versions of Lync 2010 it was possible to add a Send Feedback option to the user interface. -That was done by using code similar to this: - -`$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback"Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}` +### -ExcludedContactFolders -For more details and examples, see the New-CsClientPolicyEntry cmdlet help topic. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates which Microsoft Outlook contact folders (if any) should not be searched any time Skype for Business searches for new contacts. +Multiple folders can be specified by separating the folder names using semicolons; for example, `-ExcludedContactFolders "SenderPhotoContacts;OtherContacts".` +NOTE: When using a Skype for Business client, with either Office 2013 or Office 2016, this policy won't work in the same way. +In that combination, the Skype for Business client uses the search capabilities of Office (mso.dll), which finds contacts from Exchange mailbox contact folders. There isn't an option to suppress the search of those contact folders for the Office search component. ```yaml -Type: PSListModifier +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 +Aliases: Required: False Position: Named @@ -1327,41 +1430,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchPrefixFlags - -Represents the Address Book attributes that should be used any time a user searches for a new contact. -The search prefix flags are constructed as a binary number like 11101111, in which a 1 indicates that the attribute should be searched and a 0 indicates that the attribute should not be searched. -The attributes in the binary value are (from right to left): - -Primary email address +### -Force -Email alias +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -All email addresses +Suppresses the display of any non-fatal error message that might occur when running the command. -Company -Display name -First name -Last name +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -The binary value 1110111 means that all attributes should be searched except attribute 4: Company. -To search only last name, first name, and display name you would construct this value: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -1110000 +### -HelpEnvironment -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 a Windows PowerShell command similar to this: +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`[Convert]::ToInt32("1110111", 2)` +When set to Office 365, the Skype for Business Online client help documentation for Skype for Business will be shown to users rather than the on-premises help shown by default. +You can either set HelpEnvironment to Office 365 or to a null value ($Null). +If set to a null value (the default value) then the on-premises help will be shown to users. ```yaml -Type: UInt16 +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 +Aliases: Required: False Position: Named @@ -1370,23 +1471,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowManagePrivacyRelationships +### -HotdeskingTimeout -When set to True, shows the Relationships option in the Skype for Business Contacts list window. -When set to False, hides the Relationships option. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this setting applies only to Lync 2010. -Skype for Business will not show these relationships even if ShowManagePrivacyRelationships has been set to True. +Timeout interval for a user logged on to a hot-desked phone. +(A hot-desked phone is a phone running Skype for Business Phone Edition that is located in a shared workspace, and that users can log on to by using their Skype for Business Server account.) The hot-desk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hot-desked phone. +When specifying a hot desking timeout you must use the format hours:minutes:seconds. +For example, this syntax sets the hot desking timeout interval to 45 minutes: -The default value is False. +`-HotdeskingTimeout 00:45:00` + +Note that this policy setting applies only to common area phones and not to users. +The default value is 5 minutes (00:05:00), and the minimum value is 30 seconds (00:00:30). ```yaml -Type: Boolean +Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -1395,37 +1499,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowRecentContacts - -This parameter currently has no effect on the client. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Unique Identity to be assigned to the new policy. +New client 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 SalesClientPolicy.` ```yaml -Type: Boolean +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 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowSharepointPhotoEditLink - -If set to True, Skype for Business will include a link that enables users to edit the personal photo stored on their SharePoint My Site. -The default value is False, which means that Skype for Business will not include a link to the SharePoint My Site. +### -IMLatencyErrorThreshold +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +If IM latency is greater than the threshold value (in milliseconds), the client will submit a CER. ```yaml -Type: Boolean +Type: UInt32 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 +Aliases: Required: False Position: Named @@ -1434,23 +1539,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchCenterExternalURL - -External URL for the SharePoint site used for keyword searches (also known as expert searches). -This URL will appear at the bottom of any keyword search results that appear in Skype for Business. -If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using the search capabilities of SharePoint. -(SharePoint offers more search options than does Skype for Business.) - -SPSearchCenterExternalURL represents the URL for external users; that is, for users logging on from outside the organization's firewall. -The parameter SPSearchCenterInternalURL is for users who log on from inside the firewall. +### -IMLatencySpinnerDelay +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Amount of time, in milliseconds, to wait before showing the spinner in the client when IM message delivery is delayed. ```yaml -Type: String +Type: UInt32 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 +Aliases: Required: False Position: Named @@ -1459,23 +1557,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchCenterInternalURL +### -IMWarning -Internal URL for the SharePoint site used for keyword searches (also known as expert searches). -This URL will appear at the bottom of any keyword search results that appear in Skype for Business. -If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using the search capabilities of SharePoint. -(SharePoint offers more search options than Skype for Business does.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -SPSearchCenterInternalURL represents the URL for internal users; that is, for users logging on from inside the organization's firewall. -The parameter SPSearchCenterExternalURL is for users who log on from outside the firewall. +When configured, the specified message appears in the Conversation window each time a user takes part in an instant messaging session. +For example, if IMWarning is set to "All information is the property of Litwareinc" then that message will appear in the Conversation window each time a user takes part in an instant messaging session. + +If set to a null value ($Null), then no message appears in the Conversation window. + +Your warning message should be limited to 256 characters, and can only contain plain text. +You cannot use any formatting (such as boldface or italics) and you cannot clickable URLs within the text. ```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 +Aliases: Required: False Position: Named @@ -1484,18 +1583,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchExternalURL +### -InMemory -External URL for the SharePoint site used for keyword searches (also known as expert searches). -Skype for Business will use the SharePoint site located at this URL any time an external user (that is, a user who has accessed the system from outside the organization's firewall) conducts a keyword search. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1504,18 +1604,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchInternalURL +### -MAPIPollInterval -Internal URL for the SharePoint site used for keyword searches (also known as expert searches). -Skype for Business will use the SharePoint site located at this URL any time an internal user (that is, a user who has logged on from inside the organization's firewall) conducts a keyword search. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +> [!IMPORTANT] +> This parameter has been deprecated for use with Skype for Business Server. + +For users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Skype for Business retrieves calendar data from the Exchange public folders. +MAPIPollInterval can be set to any value between 1 second and 1 hour; inclusive. +To configure the MAPI poll interval, use the format hours:minutes:seconds. +For example, this command sets the MAPI poll interval to 45 minutes: + +`-MapiPollInterval 00:45:00` ```yaml -Type: String +Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -1524,18 +1632,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TabURL +### -MaximumDGsAllowedInContactList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of distribution groups that a user can configure as a contact. +MaximumDGsAllowedInContactList can be set to any integer value between 0 and 64, inclusive. +The default value is 10. + -Specifies the location of the XML file used to create custom tabs located at the bottom of the Skype for Business Contacts list window. -This parameter has been deprecated for use with Skype for Business Server. ```yaml -Type: String +Type: UInt32 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 +Aliases: Required: False Position: Named @@ -1544,25 +1656,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebServicePollInterval - -For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Skype for Business retrieves calendar data from Microsoft Exchange Server Web Services. -WebServicePollInterval can be set to any value between 1 second and 1 hour; inclusive. -To configure the Web Service poll interval, use the format hours:minutes:seconds. -For example, this command sets the Web Service poll interval to 45 minutes: +### -MaximumNumberOfContacts -`-WebServicePollInterval 00:45:00` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this setting does not apply to users whose email account is on Exchange 2003. -For those users, calendar retrieval is managed using MAPIPollInterval. +Indicates the maximum number of contacts a user is allowed to have. +The maximum contacts can be set to any integer value between 0 and 1000, inclusive. +When set to 0, that prevents the user from having any contacts. ```yaml -Type: TimeSpan +Type: UInt16 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 +Aliases: Required: False Position: Named @@ -1571,18 +1678,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -MaxPhotoSizeKB -Suppresses the display of any non-fatal error message that might occur when running the command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum size (in kilobytes) for photos displayed in Skype for Business. +The default value is 30 kilobytes. ```yaml -Type: SwitchParameter +Type: UInt32 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 +Aliases: Required: False Position: Named @@ -1591,18 +1700,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -MusicOnHoldAudioFile + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the audio file to be played when a caller is placed on hold. +If a value is configured for this property, then music on hold will be enabled and users will not be allowed to disable the feature. +If no value is configured for this property, then users can specify their own music-on-hold file, provided that EnableClientMusicOnHold is set to True. -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 +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 +Aliases: Required: False Position: Named @@ -1611,38 +1723,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf - -Describes what would happen if you executed the command without actually executing the command. - +### -P2PAppSharingEncryption +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether or not desktop and application sharing data exchanged during a peer-to-peer conversation is encrypted. +Allowed values are: -```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 +Supported. +Desktop and application sharing data will be encrypted, if possible. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Enforced. +Desktop and application sharing data must be encrypted. +If the data cannot be encrypted, then desktop and application sharing will not be enabled for the conversation. -### -Confirm +NotSupported. +Desktop and application sharing data will not be encrypted. -Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: P2PAppSharingEncryption 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 +Aliases: Required: False Position: Named @@ -1651,19 +1756,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableMeetingSubjectAndLocation +### -PlayAbbreviatedDialTone -When set to False, detailed information about a meeting -- namely, the meeting subject and the location where the meeting is being held -- will be displayed as a tooltip when you view free/busy information in a contact card. -When set to True, this detailed information will not be displayed. -To completely prevent the display of meeting-related information you should also set DisableCalendarPresence to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, a 3-second dial tone will be played any time a Skype for Business-compatible handset is taken off the hook. +(A Skype for Business handset looks like a standard telephone, but plugs into a USB port on a computer and is used to make Skype for Business calls rather than "regular" phone calls.) When set to False, a 30-second dial tone is played any time a Skype for Business-compatible handset is taken off the hook. ```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 +Aliases: Required: False Position: Named @@ -1672,19 +1777,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNotificationForNewSubscribers +### -PolicyEntry -When set to True, any time you are added to someone's Contacts list you will receive notification that you have been added to the list. -In addition, the notification dialog box will provide options for you to add this person to your Contacts list, or to block them from viewing your presence information. -When set to False, you will not be notified if you are added to someone's Contacts list. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way to add settings not covered by the default parameters. +For example, when testing pre-release versions of Lync 2010 it was possible to add a Send Feedback option to the user interface. +That was done by using code similar to this: + +`$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback"Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}` + +For more details and examples, see the New-CsClientPolicyEntry cmdlet help topic. ```yaml -Type: Boolean +Type: PSListModifier 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 +Aliases: Required: False Position: Named @@ -1693,19 +1803,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableURL - -When set to True, hyperlinks embedded in an instant message will be "clickable;" that is, users can click that link and their web browser will open to the specified location. -When set to False, hyperlinks will appear in instant messages as plain text. -To navigate to the location, users will need to copy the link text and paste it into their web browser. +### -PublicationBatchDelay +> Applicable: Skype for Business Online +{{Fill PublicationBatchDelay Description}} ```yaml -Type: Boolean +Type: UInt32 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 +Aliases: Required: False Position: Named @@ -1714,19 +1821,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxPhotoSizeKB - -Indicates the maximum size (in kilobytes) for photos displayed in Skype for Business. - -The default value is 30 kilobytes. +### -RateMyCallAllowCustomUserFeedback +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, a free-text input field will be displayed in the Rate My Call window for users to submit custom feedback. ```yaml -Type: UInt32 +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 +Aliases: Required: False Position: Named @@ -1735,15 +1839,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMediaRedirection -When set to True ($True) allows audio and video streams to be separated from other network traffic; in turn, this allows client devices to do encoding and decoding of audio and video locally. -Media redirection typically results in lower bandwidth usage, higher server scalability, and a more-optimal user experience compared to similar techniques such as device remoting or codec compression. +### -RateMyCallDisplayPercentage + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter controls how often the form is shown. ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1752,16 +1857,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpEnvironment -When set to Office 365, the Skype for Business Online client help documentation for Skype for Business will be shown to users rather than the on-premises help shown by default. -You can either set HelpEnvironment to Office 365 or to a null value ($Null). -If set to a null value (the default value) then the on-premises help will be shown to users. +### -RequireContentPin + +> Applicable: Skype for Business Online + +{{Fill RequireContentPin Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1770,56 +1875,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TracingLevel -Enables Administrators to manage event tracing and logging in Skype for Business. -Allowed values are: +### -SearchPrefixFlags -Off - Tracing is disabled and the user cannot change this setting. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Light - Minimal tracing is performed, and the user cannot change this setting. +Represents the Address Book attributes that should be used any time a user searches for a new contact. +The search prefix flags are constructed as a binary number like 11101111, in which a 1 indicates that the attribute should be searched and a 0 indicates that the attribute should not be searched. +The attributes in the binary value are (from right to left): -Full - Verbose tracing is performed, and the user cannot change this setting. +Primary email address -By default TracingLevel is set to Light. +Email alias +All email addresses -```yaml -Type: TracingLevel -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Company -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Display name -### -EnableClientAutoPopulateWithTeam -When set to true, allows a user's Skype client to be autopopulated with members of his or her immediate team. +First name -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Last name -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +The binary value 1110111 means that all attributes should be searched except attribute 4: Company. +To search only last name, first name, and display name you would construct this value: -### -EnableExchangeContactsFolder -When set to false, this allows admins to hide Skype for Business contacts from showing up in users' Outlook and Outlook on the Web clients. +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 a Windows PowerShell command similar to this: + +`[Convert]::ToInt32("1110111", 2)` ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1828,32 +1919,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableHighPerformanceConferencingAppSharing -When set to True, enables better performance in applications (such as CAD/CAM applications) that have a high screen refresh rate. -However, this improved performance will reduce the system resources and network bandwidth available to other applications. +### -ShowManagePrivacyRelationships -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +When set to True, shows the Relationships option in the Skype for Business Contacts list window. +When set to False, hides the Relationships option. + +Note that this setting applies only to Lync 2010. +Skype for Business will not show these relationships even if ShowManagePrivacyRelationships has been set to True. -### -EnableHighPerformanceP2PAppSharing -When set to True, allows a peer-to-peer application sharing session to exceed the maximum frame rate of 2.5 frames per second. The default value is False. + + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1862,30 +1945,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingEngagement -{{Fill EnableMeetingEngagement Description}} +### -ShowRecentContacts -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter currently has no effect on the client. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -EnableOnlineFeedback -When set to true, allows users to provide feedback through the "help->report a problem" menu options in the client. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1894,14 +1965,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineFeedbackScreenshots -When set to true, allows users to provide screenshots of their clients when reporting problems. +### -ShowSharepointPhotoEditLink + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, Skype for Business will include a link that enables users to edit the personal photo stored on their SharePoint My Site. +The default value is False, which means that Skype for Business will not include a link to the SharePoint My Site. + + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1910,17 +1986,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableServerConversationHistory -When set to True ($True), allows conversation histories, missed call notifications, and missed IM notifications to be stored on the server instead of in client mailboxes. -This makes it easier for users to retrieve that information from a mobile device. +### -SPSearchCenterExternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +External URL for the SharePoint site used for keyword searches (also known as expert searches). +This URL will appear at the bottom of any keyword search results that appear in Skype for Business. +If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using the search capabilities of SharePoint. +(SharePoint offers more search options than does Skype for Business.) + +SPSearchCenterExternalURL represents the URL for external users; that is, for users logging on from outside the organization's firewall. +The parameter SPSearchCenterInternalURL is for users who log on from inside the firewall. + -The default value is False ($False). ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1929,14 +2012,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSkypeUI -When set to True ($True), this parameter allows administrators to enable the Skype for Business user interface instead of the Lync interface for the Skype for Business client. +### -SPSearchCenterInternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Internal URL for the SharePoint site used for keyword searches (also known as expert searches). +This URL will appear at the bottom of any keyword search results that appear in Skype for Business. +If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using the search capabilities of SharePoint. +(SharePoint offers more search options than Skype for Business does.) + +SPSearchCenterInternalURL represents the URL for internal users; that is, for users logging on from inside the organization's firewall. +The parameter SPSearchCenterExternalURL is for users who log on from outside the firewall. + + ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1945,14 +2038,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableViewBasedSubscriptionMode -{{Fill EnableViewBasedSubscriptionMode Description}} +### -SPSearchExternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +External URL for the SharePoint site used for keyword searches (also known as expert searches). +Skype for Business will use the SharePoint site located at this URL any time an external user (that is, a user who has accessed the system from outside the organization's firewall) conducts a keyword search. + + ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1961,14 +2059,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMLatencyErrorThreshold -If IM latency is greater than the threshold value (in milliseconds), the client will submit a CER. +### -SPSearchInternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Internal URL for the SharePoint site used for keyword searches (also known as expert searches). +Skype for Business will use the SharePoint site located at this URL any time an internal user (that is, a user who has logged on from inside the organization's firewall) conducts a keyword search. + + ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1977,14 +2080,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMLatencySpinnerDelay -Amount of time, in milliseconds, to wait before showing the spinner in the client when IM message delivery is delayed. +### -SupportModernFilePicker + +> Applicable: Skype for Business Online + +{{Fill SupportModernFilePicker Description}} ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1993,14 +2098,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PublicationBatchDelay -{{Fill PublicationBatchDelay Description}} +### -TabURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the location of the XML file used to create custom tabs located at the bottom of the Skype for Business Contacts list window. +This parameter has been deprecated for use with Skype for Business Server. + + ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -2009,14 +2119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RateMyCallAllowCustomUserFeedback -When set to True, a free-text input field will be displayed in the Rate My Call window for users to submit custom feedback. +### -TelemetryTier + +> Applicable: Skype for Business Online + +{{Fill TelemetryTier Description}} ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -2025,14 +2137,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RateMyCallDisplayPercentage -This parameter controls how often the form is shown. +### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client 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: UInt16 +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -2041,14 +2162,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireContentPin -{{Fill RequireContentPin Description}} +### -TracingLevel + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables Administrators to manage event tracing and logging in Skype for Business. +Allowed values are: + +Off - Tracing is disabled and the user cannot change this setting. + +Light - Minimal tracing is performed, and the user cannot change this setting. + +Full - Verbose tracing is performed, and the user cannot change this setting. + +By default TracingLevel is set to Light. + ```yaml -Type: String +Type: TracingLevel Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -2057,14 +2190,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SupportModernFilePicker -{{Fill SupportModernFilePicker Description}} +### -WebServicePollInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Skype for Business retrieves calendar data from Microsoft Exchange Server Web Services. +WebServicePollInterval can be set to any value between 1 second and 1 hour; inclusive. +To configure the Web Service poll interval, use the format hours:minutes:seconds. +For example, this command sets the Web Service poll interval to 45 minutes: + +`-WebServicePollInterval 00:45:00` + +Note that this setting does not apply to users whose email account is on Exchange 2003. +For those users, calendar retrieval is managed using MAPIPollInterval. + + ```yaml -Type: Boolean +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -2073,14 +2218,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TelemetryTier -{{Fill TelemetryTier Description}} +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -2089,21 +2239,19 @@ 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 client policy is being created. -For example: +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. -`-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 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -2119,15 +2267,14 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ### None -### -None. +### None The New-CsClientPolicy cmdlet does not accept pipelined input. ## OUTPUTS ### System.Object -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy The New-CsClientPolicy cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClientPolicyEntry.md b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicyEntry.md similarity index 92% rename from skype/skype-ps/skype/New-CsClientPolicyEntry.md rename to skype/skype-ps/SkypeForBusiness/New-CsClientPolicyEntry.md index 4fb43fb573..55da53e8e9 100644 --- a/skype/skype-ps/skype/New-CsClientPolicyEntry.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicyEntry.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientpolicyentry applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClientPolicyEntry -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclientpolicyentry +schema: 2.0.0 +title: New-CsClientPolicyEntry --- # New-CsClientPolicyEntry @@ -43,7 +44,7 @@ Instead, you will need to wait for notification from Microsoft regarding names a ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback" @@ -71,7 +72,7 @@ Finally, the last command in the example uses the Set-CsClientPolicy cmdlet to w If you do not call the Set-CsClientPolicy cmdlet, your changes will exist only in memory, and will disappear as soon as you end your Windows PowerShell session or delete the variable $x. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback" @@ -87,7 +88,7 @@ After the command finishes running the only item in the PolicyEntry property wil Any items contained in that property before the Set-CsClientPolicy cmdlet was called will have replaced by the new entry. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $y = Get-CsClientPolicy -Identity global @@ -107,7 +108,7 @@ The syntax RemoveAt(0) means that the first policy entry will be removed. As soon as the policy entry has been removed from the in-memory instance of the global policy, the Set-CsClientPolicy cmdlet is then called in order to write these changes to the actual instance of the global client policy. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Set-CsClientPolicy -Identity global -PolicyEntry $Null @@ -120,14 +121,16 @@ This is done by using the PolicyEntry parameter and setting the parameter value ## PARAMETERS ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the new policy entry. For example: `-Name "OnlineFeedbackURL".` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -137,14 +140,16 @@ Accept wildcard characters: False ``` ### -Value + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Value to be assigned to the new policy entry. For example: `-Value https://www.litwareinc.com/feedback.` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -158,13 +163,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsClientPolicyEntry cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Client.PolicyEntryType The New-CsClientPolicyEntry cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Client.PolicyEntryType object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsClientVersionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsClientVersionConfiguration.md index a361347d9f..0b90809a27 100644 --- a/skype/skype-ps/skype/New-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClientVersionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclientversionconfiguration +schema: 2.0.0 +title: New-CsClientVersionConfiguration --- # New-CsClientVersionConfiguration @@ -56,7 +57,7 @@ The technology relies on self-reporting from client applications, and does not a ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsClientVersionConfiguration -Identity site:Redmond -Enabled $False @@ -66,7 +67,7 @@ The command shown in Example 1 creates a new collection of client version config In this command, the Enabled parameter is set to False, which means that client filtering is disabled for the Redmond site. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsClientVersionConfiguration -Identity site:Redmond -InMemory @@ -86,25 +87,10 @@ In command 3, the Set-CsClientVersionConfiguration cmdlet is used to transform t ## PARAMETERS -### -Identity -Represents the unique identifier to be assigned to the new collection of client version configuration settings. -Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". -Note that the preceding command will fail if a collection of settings with the Identity site:Redmond already exists. +### -DefaultAction -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultAction Indicates the action to be taken if a user tries to log on from a client application with a version number that cannot be found in the appropriate client version policy. DefaultAction must be set to one of the following values: @@ -130,8 +116,26 @@ When the Enabled property is set to False, then no client version filtering of a ```yaml Type: DefaultAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the URL of the webpage where users can download an approved client application. +If specified, and if the DefaultAction is set to BlockWithUrl, this URL will appear in the "Access denied" message box displayed any time a user tries to log on from an unsupported client application. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -141,6 +145,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether client version filtering is enabled or disabled. If the Enabled property is True, the server will check the version number of each client application that attempts to log on; the server will then allow or deny access based on the appropriate client version policy. If the Enabled property is False, then any client application capable of logging on will be allowed to log on. @@ -150,8 +157,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,13 +167,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,34 +184,39 @@ 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-\. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Represents the unique identifier to be assigned to the new collection of client version configuration settings. +Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". +Note that the preceding command will fail if a collection of settings with the Identity site:Redmond already exists. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 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. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,13 +226,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -228,15 +243,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultURL -Specifies the URL of the webpage where users can download an approved client application. -If specified, and if the DefaultAction is set to BlockWithUrl, this URL will appear in the "Access denied" message box displayed any time a user tries to log on from an unsupported client application. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -250,13 +266,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsClientVersionConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicy.md similarity index 88% rename from skype/skype-ps/skype/New-CsClientVersionPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicy.md index d8e270a440..d4502b3f65 100644 --- a/skype/skype-ps/skype/New-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClientVersionPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclientversionpolicy +schema: 2.0.0 +title: New-CsClientVersionPolicy --- # New-CsClientVersionPolicy @@ -56,7 +57,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsClientVersionPolicy -Identity site:Redmond @@ -66,7 +67,7 @@ In Example 1, a new client version policy is created for the Redmond site. Because no parameters are specified (other than the mandatory Identity parameter), the new policy will contain all of the default values for a client version policy. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsSite | Select-Object Identity | ForEach-Object {New-CsClientVersionPolicy -Identity ("site:" + $_.Identity)} @@ -80,8 +81,47 @@ Those Identities are then piped to the ForEach-Object cmdlet, which takes each s ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to provide explanatory text about the policy. +For example, you might include information about the users that 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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be created. To create a policy at the site scope, use syntax similar to this: `-Identity "site:Redmond".` To create a policy at the service scope, use syntax similar to this: `-Identity "Registrar:atl-cs-001.litwareinc.com".` @@ -95,8 +135,7 @@ To create a per-user policy, use syntax similar to this: `-Identity "SalesDepart ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -105,15 +144,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables you to provide explanatory text about the policy. -For example, you might include information about the users that the policy should be assigned to. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +167,8 @@ Accept wildcard characters: False ### -Rules +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of client version policy rules. You can add and remove rules from a policy by using the New-CsClientVersionPolicyRule cmdlet and the Remove-CsClientVersionPolicyRule cmdlet. To add a rule at the time you create the new policy, create the rule and store the value in a variable (for example, $x). @@ -136,8 +181,7 @@ You can then use syntax similar to this when creating the new policy: ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,34 +190,23 @@ 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 Server 2015, Skype for Business Server 2019 +### -Tenant -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -InMemory +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client version policy is being created. +For example: -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-\. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,30 +215,16 @@ 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 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 @@ -214,21 +233,16 @@ 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 client version policy is being created. -For example: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -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` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -242,13 +256,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Get-CsClientVersionPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy The New-CsClientVersionPolicy cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicyRule.md similarity index 87% rename from skype/skype-ps/skype/New-CsClientVersionPolicyRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicyRule.md index 2cb0dc194e..3c954a243b 100644 --- a/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicyRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClientVersionPolicyRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclientversionpolicyrule +schema: 2.0.0 +title: New-CsClientVersionPolicyRule --- # New-CsClientVersionPolicyRule @@ -87,7 +88,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = [guid]::NewGuid() @@ -105,7 +106,7 @@ This command uses four parameters: Parent, with a parameter value representing t In this case, the UserAgent parameter represents an in-house client application. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = [guid]::NewGuid() @@ -130,84 +131,10 @@ When those tasks are complete, the final command in the example and the Set-CsCl ## PARAMETERS -### -Identity - -Unique identifier for the client version policy rule to be created. -The Identity of a client version policy rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). -That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. - -Instead of using the Identity parameter you can use the Parent and RuleId parameters to have the New-CsClientVerisonPolicyRule cmdlet create the Identity for you. - - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MajorVersion -Major version of the software. -For example, if your copy of Communicator is version 2.0.6362.111, then the MajorVersion is 2. -Major versions equate to primary releases of the software. -You must assign a value to the MajorVersion property any time you create a new rule. - -```yaml -Type: UInt16 -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 -``` - -### -MinorVersion -Minor version of the software. -For example, if your copy of Communicator is version 2.0.6362.111, then the MinorVersion is 0. -Minor versions equate to interim releases of the software. - -```yaml -Type: UInt16 -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 -``` - -### -UserAgent -Designator used to identify the software client. -For example, OC is the user agent designation for Communicator. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Action -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Action Action to be taken any time the rule is triggered (that is, any time someone attempts to log on by using the specified software). Valid values are: @@ -233,8 +160,7 @@ The user can then try to log on by using the new client application. ```yaml Type: Action Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,14 +170,16 @@ Accept wildcard characters: False ``` ### -ActionUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where users can download the latest version of Lync. This property is required if the Action is set to BlockWithUrl or AllowWithUrl. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,6 +189,9 @@ Accept wildcard characters: False ``` ### -BuildNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Build number of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the BuildNumber is 6362. Build numbers represent internal versions of the software during the development process, and help to ensure that you are using the final release version as opposed to a pre-release version. @@ -268,8 +199,7 @@ Build numbers represent internal versions of the software during the development ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,6 +209,9 @@ Accept wildcard characters: False ``` ### -CompareOp + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comparison operator used to determine if the client software attempting to log on was released before, after, or at the same time as the version specified in the rule. Valid values are: @@ -297,8 +230,7 @@ LEQ (less than or equal to) ```yaml Type: CompareOp Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,14 +240,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional information about the client version rule. For example, the Description might include information about who to contact if you believe the rule should 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 +Aliases: Required: False Position: Named @@ -325,6 +259,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the client version rule is to be used. If the Enabled property is set to False ($False), then the rule will be ignored any time a user attempts to log on with the specified software. The default value is True. @@ -332,8 +269,111 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the client version policy rule to be created. +The Identity of a client version policy rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). +That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. + +Instead of using the Identity parameter you can use the Parent and RuleId parameters to have the New-CsClientVerisonPolicyRule cmdlet create the Identity for you. + + + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -MajorVersion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Major version of the software. +For example, if your copy of Communicator is version 2.0.6362.111, then the MajorVersion is 2. +Major versions equate to primary releases of the software. +You must assign a value to the MajorVersion property any time you create a new rule. + +```yaml +Type: UInt16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinorVersion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Minor version of the software. +For example, if your copy of Communicator is version 2.0.6362.111, then the MinorVersion is 0. +Minor versions equate to interim releases of the software. + +```yaml +Type: UInt16 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -344,6 +384,8 @@ Accept wildcard characters: False ### -Parent +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope information for the new rule. To use the Parent parameter and create a new rule for the global policy, use this syntax: `-Parent global.` To create a new rule for a site policy, use syntax similar to this: `-Parent "site:Redmond".` @@ -357,8 +399,7 @@ You must use either the Identity parameter or both the Parent and RuleId paramet ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -368,6 +409,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Relative priority of the rule. Rules are processed in priority order, with the rule that has priority 0 being processed first, the rule that has priority 1 being processed second, and so on. If you assign a priority that is already in use, the new rule will use that priority and other rules will be renumbered accordingly. @@ -375,8 +419,7 @@ If you assign a priority that is already in use, the new rule will use that prio ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -386,6 +429,9 @@ Accept wildcard characters: False ``` ### -QfeNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Quick fix engineering number of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the QfeNumber is 111. QFE numbers represent planned updates to an application that are made available after the software's official release. @@ -393,8 +439,7 @@ QFE numbers represent planned updates to an application that are made available ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -404,6 +449,9 @@ Accept wildcard characters: False ``` ### -RuleId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) for the rule. In Windows PowerShell, you can create a GUID by using the following command: @@ -412,8 +460,7 @@ In Windows PowerShell, you can create a GUID by using the following command: ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -422,34 +469,23 @@ 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 Server 2015, Skype for Business Server 2019 +### -Tenant -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -InMemory +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client version policy rule is being created. +For example: -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-\. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -458,14 +494,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UserAgent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Designator used to identify the software client. +For example, OC is the user agent designation for Communicator. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -474,14 +513,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -UserAgentFullName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide a friendly name for the user agent. +For example, instead of relying on the user agent UCCP to identify the agent administrators might spell the name out in full: Microsoft Unified Communications Client. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -490,18 +534,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAgentFullName - -Enables administrators to provide a friendly name for the user agent. -For example, instead of relying on the user agent UCCP to identify the agent administrators might spell the name out in full: Microsoft Unified Communications Client. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -510,21 +552,16 @@ 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 client version policy rule is being created. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -538,13 +575,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsClientVersionPolicyRule cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule The New-CsClientVersionPolicyRule cmdlet creates new instances of Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsCloudCallDataConnectorConfiguration.md similarity index 93% rename from skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsCloudCallDataConnectorConfiguration.md index 9508f13493..145a1ae495 100644 --- a/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCloudCallDataConnectorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscloudcalldataconnectorconfiguration applicable: Skype for Business Server 2019 -title: New-CsCloudCallDataConnectorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscloudcalldataconnectorconfiguration +schema: 2.0.0 +title: New-CsCloudCallDataConnectorConfiguration --- # New-CsCloudCallDataConnectorConfiguration @@ -55,29 +56,16 @@ If the Set-CsCloudCallDataConnectorConfiguration cmdlet was not called, the virt ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -EnableCallDataConnector -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2019 -### -EnableCallDataConnector Enables upload of call data (CDR and QoE). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -86,13 +74,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -101,13 +91,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2019 + Represents the unique identifier to be assigned to the new collection of CloudCallDataConnector configuration settings. Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example, "site:Redmond". ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: True Position: 1 Default value: None @@ -116,13 +108,32 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2019 + 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: -Applicable: Skype for Business Server 2019 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named Default value: None @@ -131,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -138,7 +152,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/New-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsClsConfiguration.md similarity index 83% rename from skype/skype-ps/skype/New-CsClsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsClsConfiguration.md index 123753063b..734c8bc7b6 100644 --- a/skype/skype-ps/skype/New-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclsconfiguration +schema: 2.0.0 +title: New-CsClsConfiguration --- # New-CsClsConfiguration @@ -55,7 +56,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsClsConfiguration -Identity "site:Redmond" -EtlFileRolloverSizeMB 40 -EtlFileRolloverMinutes 120 @@ -67,26 +68,10 @@ In this new collection, the ETL file rollover size is set to 40 megabytes, and t ## PARAMETERS -### -Identity -Unique identifier for the centralized logging configuration settings to be created. -Because these settings can only be created at the site scope, use syntax similar to this, with the prefix "site:" followed by the name of the site: - -`-Identity "site:Redmond"` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CacheFileLocalFolders -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CacheFileLocalFolders One or more full paths to the local folders where the cache files will be stored. The default value is %TEMP%\Tracing. If more than one path is specified, then separate them with semi-colons. @@ -94,8 +79,7 @@ If more than one path is specified, then separate them with semi-colons. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,14 +89,16 @@ Accept wildcard characters: False ``` ### -CacheFileLocalMaxDiskUsage + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum amount of disk space (percentage) that can be used for the cache files. The default value is 80. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +108,16 @@ Accept wildcard characters: False ``` ### -CacheFileLocalRetentionPeriod + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of days that cache files are retained locally. The default value is 14. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +127,16 @@ Accept wildcard characters: False ``` ### -CacheFileNetworkFolder + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Full UNC path to the network cache folder. There is no default value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,14 +146,16 @@ Accept wildcard characters: False ``` ### -ComponentThrottleLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum rate at which a component is allowed to generate trace records before its tracing is throttled. The default value is 5000 trace calls per second. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,14 +165,16 @@ Accept wildcard characters: False ``` ### -ComponentThrottleSample + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of times the ComponentThrottleLimit can be exceeded within a one minute interval. The default value is 3. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,23 +183,10 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EtlFileFolder -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EtlFileFolder Full path to the folder where the event log trace files will be stored. The default value is %TEMP%\Tracing. Note that %TEMP% is evaluated in the contents of the CLS Service so it actual expands to %WINDIR%\ServiceProfiles\NetworkService\AppData\Local @@ -213,8 +194,7 @@ Note that %TEMP% is evaluated in the contents of the CLS Service so it actual ex ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,14 +204,16 @@ Accept wildcard characters: False ``` ### -EtlFileRolloverMinutes + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum amount of time (in minutes) that can elapse before a new event log trace file is created. (This new file will be created even if the existing trace file has not reached the specified rollover size.) The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,14 +223,16 @@ Accept wildcard characters: False ``` ### -EtlFileRolloverSizeMB + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum size (in megabytes) that at event trace log file can reach before a new file is created. The default value is 20. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,13 +242,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -273,15 +259,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the centralized logging configuration settings to be created. +Because these settings can only be created at the site scope, use syntax similar to this, with the prefix "site:" followed by the name of the site: + +`-Identity "site:Redmond"` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,6 +301,8 @@ Accept wildcard characters: False ### -MinimumClsAgentServiceVersion +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the minimum version of the centralized logging service agent to be used when logging data; any computers with an agent version lower than the minimum value will be excluded from the logging operations. The default value is 6, representing Skype for Business Server. This parameter is intended for use with Skype for Business Online. @@ -301,8 +312,45 @@ This parameter is intended for use with Skype for Business Online. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkUsagePacketSize + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Packet size (in kilobytes) for transmitting agent search results and copying cache files over the network. +The default value is 64 KB. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkUsageThreshold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Bandwidth usage threshold (in MB per second) for transmitting agent search results and copying cache files over the network. +The default value is 10. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -313,6 +361,8 @@ Accept wildcard characters: False ### -Regions +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of regions defined for the centralized logging configuration settings. Regions are defined using the New-CsClsRegion cmdlet. @@ -323,8 +373,7 @@ This parameter is intended for use with Skype for Business Online. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -334,14 +383,16 @@ Accept wildcard characters: False ``` ### -Scenarios + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of components/situations that can be traced using centralized logging. Scenarios are managed using the CsClsScenario cmdlets. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -351,14 +402,16 @@ Accept wildcard characters: False ``` ### -SearchTerms + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of terms that help determine the personally identifiable information available to technical support personnel who search the centralized logging files. Search terms are managed using the CsClsSearchTerm cmdlets. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -369,6 +422,8 @@ Accept wildcard characters: False ### -SecurityGroups +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Security groups who are allowed to access the log files. This parameter is intended for use with Skype for Business Online. @@ -378,8 +433,7 @@ This parameter is intended for use with Skype for Business Online. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -389,14 +443,16 @@ Accept wildcard characters: False ``` ### -TmfFileSearchPath + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Search path for TMF (trace message format) files. TMF files convert binary trace messages to a human-readable format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -405,31 +461,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Version -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -NetworkUsagePacketSize -Packet size (in kilobytes) for transmitting agent search results and copying cache files over the network. -The default value is 64 KB. +This parameter is reserved for internal Microsoft use. ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -438,15 +479,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkUsageThreshold -Bandwidth usage threshold (in MB per second) for transmitting agent search results and copying cache files over the network. -The default value is 10. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -455,14 +497,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Version -This parameter is reserved for internal Microsoft use. +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -476,13 +520,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsClsConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration The New-CsClsConfiguration cmdlet creates new instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClsProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsClsProvider.md similarity index 88% rename from skype/skype-ps/skype/New-CsClsProvider.md rename to skype/skype-ps/SkypeForBusiness/New-CsClsProvider.md index 33da9f6a09..ffdedae2bb 100644 --- a/skype/skype-ps/skype/New-CsClsProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclsprovider +schema: 2.0.0 --- # New-CsClsProvider @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $provider = New-CsClsProvider -Name "WebInfrastructure" -Type "WPP" -Level "Warning" -Flags "All" @@ -61,7 +62,7 @@ To do this, the first command in the example uses the New-CsClsProvider cmdlet t The second command in the example then adds this new provider to the scenario site:Redmond/WAC. Because the command uses the syntax @{Add=$provider} the new provider will be added to the WAC scenario in addition to any other providers already configured for that -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $provider = New-CsClsProvider -Name "WebInfrastructure" -Type "WPP" -Level "Warning" -Flags "All" @@ -77,6 +78,9 @@ This is done by using the syntax @{Replace=$provider}. ## PARAMETERS ### -Flags + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies individual protocols and subcomponents involved in the trace. For example, the SipStack provider includes the following flags: TF_COMPONENT, TF_RTCHTTP, TF_CONNECTION, TF_DIAG. @@ -85,8 +89,7 @@ Most providers are configured to use all available flags. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -95,8 +98,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Guid + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier assigned to the provider. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Level +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Tracing level for events recorded by the provider: Allowed values are: * Fatal @@ -111,8 +134,7 @@ Tracing level for events recorded by the provider: Allowed values are: ```yaml Type: ProviderLevel Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -122,13 +144,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name for the new provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -137,62 +161,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type - -Type of tracing used by the provider. -Allowed values are: +### -Role -WPP (Windows software trace preprocessor) +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -EventLog - -IISLog +Skype for Business Server server role for the provider. +For example, FE for Front End server or Edge for Edge Server. ```yaml -Type: ProviderType +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Guid -Globally unique identifier assigned to the provider. +### -Type -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Type of tracing used by the provider. +Allowed values are: -### -Role +WPP (Windows software trace preprocessor) -Skype for Business Server server role for the provider. -For example, FE for Front End server or Edge for Edge Server. +EventLog + +IISLog ```yaml -Type: String +Type: ProviderType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -204,13 +214,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsClsProvider cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Provider The New-CsClsProvider cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Provider object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/New-CsClsRegion.md similarity index 85% rename from skype/skype-ps/skype/New-CsClsRegion.md rename to skype/skype-ps/SkypeForBusiness/New-CsClsRegion.md index e25b134904..0b9437b4a9 100644 --- a/skype/skype-ps/skype/New-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsRegion.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclsregion +schema: 2.0.0 --- # New-CsClsRegion @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsClsRegion -Identity "global/Europe" -SecurityGroupSuffix "EMEA" -OtherRegionAccess "global/US" @@ -61,7 +62,28 @@ The new region uses the security group suffix EMEA and also allows access by the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new region. Region Identities consist of the centralized logging configuration scope where the region will be created plus a unique region name. For example, to create a global region named Redmond use this syntax: @@ -73,8 +95,7 @@ If you use the Identity parameter then you cannot use either the name parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -83,7 +104,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name for the new region. For example: @@ -95,8 +138,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -106,13 +148,15 @@ Accept wildcard characters: False ``` ### -OtherRegionAccess + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of an additional region that can be accessed by authorized users for this region. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -122,6 +166,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope of the centralized logging configuration settings where the new region will be located. For example, to add the new region to the global settings, use this syntax: @@ -137,8 +184,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -148,13 +194,15 @@ Accept wildcard characters: False ``` ### -SecurityGroupSuffix + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suffix to be added to the end of the name of any security group that will be authorized for this region. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -163,47 +211,19 @@ 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 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 -``` +### -Sites -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Sites contained within this region. +These correspond to the SiteId attribute values in the topology document. -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 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,18 +232,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Sites - -Sites contained within this region. -These correspond to the SiteId attribute values in the topology document. +### -Confirm +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -233,13 +251,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -253,13 +273,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsClsRegion cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region The New-CsClsRegion cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/New-CsClsScenario.md similarity index 88% rename from skype/skype-ps/skype/New-CsClsScenario.md rename to skype/skype-ps/SkypeForBusiness/New-CsClsScenario.md index c8ab273146..a4f0bc7a01 100644 --- a/skype/skype-ps/skype/New-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsScenario.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclsscenario +schema: 2.0.0 --- # New-CsClsScenario @@ -51,7 +52,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Lync Server 2013) +### Example 1 (Lync Server 2013) ``` $provider = New-CsClsProvider -Name "RedmondHybridVoice" -Type "WPP" -Level "Info" -Flags "All" @@ -65,7 +66,7 @@ After the description and the provider have been created, the final command in t -### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) +### Example 1 (Skype for Business Server 2015) ``` $provider = New-CsClsProvider -Name "RedmondHybridVoice" -Type "WPP" -Level "Info" -Flags "All" @@ -81,7 +82,28 @@ After the description and the provider have been created, the final command in t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new scenario. A scenario consists of two parts: the scope where the scenario is configured (that is, the collection of centralized logging configuration settings where the scenario can be found) and the scenario name. For example: @@ -93,8 +115,7 @@ If you use the Identity parameter then you cannot use either the name parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,7 +124,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name for the new scenario. For example: @@ -115,8 +160,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -126,6 +170,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope of the centralized logging configuration settings where the new scenario will be located. For example, to add the new scenario to the global settings, use this syntax: @@ -141,8 +188,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -151,30 +197,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Provider -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Logging provider for the scenario. +New providers must be created using the New-CsClsProvider cmdlet. +For example: -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +`$provider = New-CsClsProvider -Name "UserServices" -Type "WPP" -Level "Info" -Flags "All"` ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,18 +219,16 @@ 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-\. +### -Confirm +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -203,34 +237,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Provider -Logging provider for the scenario. -New providers must be created using the New-CsClsProvider cmdlet. -For example: - -`$provider = New-CsClsProvider -Name "UserServices" -Type "WPP" -Level "Info" -Flags "All"` - -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -244,13 +260,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsClsScenario cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated The New-CsClsScenario cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/New-CsClsSecurityGroup.md similarity index 87% rename from skype/skype-ps/skype/New-CsClsSecurityGroup.md rename to skype/skype-ps/SkypeForBusiness/New-CsClsSecurityGroup.md index 6e4d1cada3..69a7df709d 100644 --- a/skype/skype-ps/skype/New-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsSecurityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclssecuritygroup +schema: 2.0.0 --- # New-CsClsSecurityGroup @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsClsSecurityGroup -Identity "global/HelpDesk" -AccessLevel "Tier3" @@ -61,6 +62,9 @@ In this example, the AccessLevel property is set to Tier3. ## PARAMETERS ### -AccessLevel + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + String value specifying the access level assigned to the group. Access levels are arbitrary string values assigned by administrators and used to categorize security groups. For example: @@ -73,8 +77,7 @@ Currently the only values that have meaning are "Tier3", "Tier2", "Product", "Op ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -83,7 +86,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new security group. Security group Identities consist of the centralized logging configuration scope where the group will be created plus a unique security group name. For example, to create a global security group named HelpDesk use this syntax: @@ -95,8 +119,7 @@ If you use the Identity parameter then you cannot use either the name parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -105,7 +128,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name for the new security group. For example: @@ -117,8 +162,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -128,6 +172,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope of the centralized logging configuration settings where the new security group will be located. For example, to add the new security group to the global settings, use this syntax: @@ -143,8 +190,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -154,29 +200,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -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 -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -185,31 +217,16 @@ 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -223,13 +240,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsClsSecurityGroup cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated The New-CsClsSecurityGroup cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/New-CsCommonAreaPhone.md similarity index 87% rename from skype/skype-ps/skype/New-CsCommonAreaPhone.md rename to skype/skype-ps/SkypeForBusiness/New-CsCommonAreaPhone.md index 948f235f55..e15952adf6 100644 --- a/skype/skype-ps/skype/New-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCommonAreaPhone.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscommonareaphone +schema: 2.0.0 --- # New-CsCommonAreaPhone @@ -58,7 +59,7 @@ For more details, see the OU and the DN parameter descriptions in this topic. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsCommonAreaPhone -LineUri tel:+14255556710 -RegistrarPool redmond-cs-001.litwareinc.com -DisplayName "Building 14 Lobby" -OU "ou=Telecommunications,dc=litwareinc,dc=com" @@ -68,7 +69,7 @@ The command shown in Example 1 creates a new common area phone for the phone num (Note that the LineUri must be specified using the E.164 format.) In addition to specifying the phone number, the command also specifies the Registrar pool (RegistrarPool); the Active Directory display name (DisplayName); and the distinguished name of the OU where the corresponding contact object should be created (OU). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsCommonAreaPhone -LineUri tel:+14255556710 -RegistrarPool redmond-cs-001.litwareinc.com -DN "cn=Building 14 Lobby,ou=Telecommunications,dc=litwareinc,dc=com" @@ -82,51 +83,17 @@ In this command the DisplayName is also left out, which means that the new commo ## PARAMETERS -### -LineUri -Phone number for the common area phone. -The line Uniform Resource Identifier (URI) should be specified using the E.164 format, and be prefixed by 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. - -```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: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistrarPool -Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. -For example: `-RegistrarPool "atl-cs-001.litwareinc.com".` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description Enables you to set the Active Directory Description attribute for the common area phone. In turn, this provides a way for you to supply additional information about the phone; for example, you might want to provide details about who to contact in case of problems with the phone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,13 +103,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to set the Active Directory display name of the common area phone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,6 +122,8 @@ Accept wildcard characters: False ### -DisplayNumber +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number as displayed in Skype for Business. The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; and so on. When choosing a display number, keep in mind that this number will be shown on the display screen of the common area phone only if the number can be normalized. @@ -163,8 +134,7 @@ When choosing a display number, keep in mind that this number will be shown on t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,6 +145,8 @@ Accept wildcard characters: False ### -DN +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to associate an existing Active Directory contact object with the new common area phone. If you have a contact object you want to associate with a common area phone, use the DN parameter followed by the distinguished name of that contact. For example: -DN "cn=Building 14 Lobby,dc=litwareinc,dc=com". @@ -193,8 +165,28 @@ You cannot use the OU and the DN parameters in the same command. ```yaml Type: ADObjectId Parameter Sets: DN -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the common area phone. +The line Uniform Resource Identifier (URI) should be specified using the E.164 format, and be prefixed by 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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -204,6 +196,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name of the Active Directory organizational unit (OU) where the contact object should be located. For example: `-OU "ou=Redmond,dc=litwareinc,dc=com".` @@ -213,8 +208,7 @@ As a result, the contact object will have a name similar to this: {ce84964a-c4da ```yaml Type: OUIdParameter Parameter Sets: OU -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -223,19 +217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress - -Unique identifier that allows the common area phone to communicate with SIP devices such as Skype for Business. -The SIP address must be prefaced by the prefix "sip:" and must include a valid SIP domain. -For example: sip:bldg14lobby@litwareinc.com. +### -PassThru +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Returns an object representing the common area phone. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,30 +235,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns an object representing the common area phone. +### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. +For example: `-RegistrarPool "atl-cs-001.litwareinc.com".` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier that allows the common area phone to communicate with SIP devices such as Skype for Business. +The SIP address must be prefaced by the prefix "sip:" and must include a valid SIP domain. +For example: sip:bldg14lobby@litwareinc.com. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,13 +277,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -297,13 +317,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsCommonAreaPhone cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact The New-CsCommonAreaPhone cmdlet creates new instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/New-CsConferenceDirectory.md similarity index 85% rename from skype/skype-ps/skype/New-CsConferenceDirectory.md rename to skype/skype-ps/SkypeForBusiness/New-CsConferenceDirectory.md index 4a9c8747e0..01805b0390 100644 --- a/skype/skype-ps/skype/New-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsConferenceDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csconferencedirectory +schema: 2.0.0 --- # New-CsConferenceDirectory @@ -40,7 +41,7 @@ New conference directories can be created by calling the New-CsConferenceDirecto ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsConferenceDirectory -Identity 42 -HomePool "atl-cs-001.litwareinc.com" @@ -51,34 +52,35 @@ This directory will be hosted on the pool atl-cs-001.litwareinc.com. ## PARAMETERS -### -Identity -Unique numeric identifier for the new conference directory. -Identities can be any integer value between 0 and 9999 inclusive; however, Identities must be unique. -(For example, you cannot have two directories with the Identity 575.) You do not need to follow a numeric order when creating new directories. -For example, you can create a directory with the Identity 999 followed by a directory with the Identity 2 followed by a directory with the Identity 438, and so on. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsGlobalRelativeIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -HomePool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the Registrar pool where the new conference directory will be hosted. For example: `-Identity atl-cs-001.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 +Aliases: Required: True Position: Named @@ -87,30 +89,37 @@ 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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique numeric identifier for the new conference directory. +Identities can be any integer value between 0 and 9999 inclusive; however, Identities must be unique. +(For example, you cannot have two directories with the Identity 575.) You do not need to follow a numeric order when creating new directories. +For example, you can create a directory with the Identity 999 followed by a directory with the Identity 2 followed by a directory with the Identity 438, and so on. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -119,14 +128,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -140,13 +151,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsConferenceDirectory cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsConferencingConfiguration.md similarity index 83% rename from skype/skype-ps/skype/New-CsConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsConferencingConfiguration.md index dd911eb816..42a528785b 100644 --- a/skype/skype-ps/skype/New-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsConferencingConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csconferencingconfiguration +schema: 2.0.0 --- # New-CsConferencingConfiguration @@ -58,7 +59,7 @@ If you try to create new settings for the Redmond site and the Redmond site alre ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsConferencingConfiguration -Identity site:Redmond -Organization Litwareinc @@ -69,7 +70,7 @@ In this example, one additional parameter is included (Organization) which is us Note that this command will fail if the Redmond site already has a collection of conferencing configuration settings. That's because you can have only one such collection per site. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsConferencingConfiguration -Identity site:Redmond -InMemory @@ -90,26 +91,10 @@ Instead, they will disappear as soon as you end your Windows PowerShell session ## PARAMETERS -### -Identity -Unique identifier for the collection of conferencing configuration settings to be modified. -To refer to a collection configured at the site scope, use syntax similar to this: `-Identity "site:Redmond".` -To refer to a collection at the service scope, use syntax like the following: `-Identity "service:ConferencingServer:atl-cs-001.litwareinc.com".` -Note the Web Conferencing service is the only service that can host these configuration settings. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ClientAppSharingPort -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ClientAppSharingPort Represents the starting port number used for application sharing. The ClientAppSharingPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -117,8 +102,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +112,9 @@ Accept wildcard characters: False ``` ### -ClientAppSharingPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for application sharing. (The default value is 40.) To determine the actual ports used for application sharing, use this value and the ClientAppSharingPort value. For example, if ClientAppSharingPort is set to 5350 and ClientAppSharingPortRange is set to 3, then the following 3 ports are available for application sharing: 5350; 5351; 5352. @@ -135,8 +122,7 @@ For example, if ClientAppSharingPort is set to 5350 and ClientAppSharingPortRang ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +132,9 @@ Accept wildcard characters: False ``` ### -ClientAudioPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client audio. The ClientAudioPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -153,8 +142,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,6 +152,9 @@ Accept wildcard characters: False ``` ### -ClientAudioPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client audio. (The default value is 40.) To determine the actual ports used for client audio, use this value and the ClientAudioPort value. For example, if ClientAudioPort is set to 5350 and ClientAudioPortRange is set to 3, then the following 3 ports are available for client audio: 5350; 5351; 5352. @@ -171,8 +162,7 @@ For example, if ClientAudioPort is set to 5350 and ClientAudioPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +172,9 @@ Accept wildcard characters: False ``` ### -ClientFileTransferPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for file transfers. The ClientFileTransferPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -189,8 +182,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +192,9 @@ Accept wildcard characters: False ``` ### -ClientFileTransferPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for file transfers. (The default value is 40.) To determine the actual ports used for file transfers, use this value and the ClientFileTransferPort value. For example, if ClientFileTransferPort is set to 5350 and ClientFileTransferPortRange is set to 3, then the following three ports are available for file transfers: 5350; 5351; 5352. @@ -207,8 +202,7 @@ For example, if ClientFileTransferPort is set to 5350 and ClientFileTransferPort ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +213,8 @@ Accept wildcard characters: False ### -ClientMediaPort +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client media. Use this parameter for Microsoft Office Communicator 2007 R2 clients. The ClientMediaPort must be a value port number between 1024 and 65535, inclusive. @@ -229,8 +225,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,6 +236,8 @@ Accept wildcard characters: False ### -ClientMediaPortRange +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client media. (The default value is 40.) Use this parameter for Office Communicator 2007 R2 clients. To determine the actual ports used for client media, use this value and the ClientMediaPort value. @@ -251,8 +248,7 @@ For example, if ClientMediaPort is set to 5350 and ClientMediaPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -262,14 +258,16 @@ Accept wildcard characters: False ``` ### -ClientMediaPortRangeEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, clients will use the specified port range for media traffic. When set to False (the default value) any available port (from port 1024 through port 65535) will be used to accommodate media traffic. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,6 +277,9 @@ Accept wildcard characters: False ``` ### -ClientSipDynamicPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for SIP traffic. The ClientSipDynamicPort must be a value port number between 1024 and 65535, inclusive. The default value is 7100. @@ -286,8 +287,7 @@ The default value is 7100. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,6 +297,9 @@ Accept wildcard characters: False ``` ### -ClientSipDynamicPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for SIP traffic. (The default value is 3.) To determine the actual ports used for SIP traffic, use this value and the ClientSipDynamicPort value. For example, if ClientSipDynamicPort is set to 7100 and ClientSipDynamicPortRange is set to 3, then the following three ports are available for client media: 7100; 7101; 7102. @@ -304,8 +307,7 @@ For example, if ClientSipDynamicPort is set to 7100 and ClientSipDynamicPortRang ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -315,6 +317,9 @@ Accept wildcard characters: False ``` ### -ClientVideoPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client video. The ClientVideoPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -322,8 +327,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,6 +337,9 @@ Accept wildcard characters: False ``` ### -ClientVideoPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client video. (The default value is 40.) To determine the actual ports used for client video, use this value and the ClientVideoPort value. For example, if ClientVideoPort is set to 5350 and ClientVideoPortRange is set to 3, then the following three ports are available for client video: 5350; 5351; 5352. @@ -340,8 +347,43 @@ For example, if ClientVideoPort is set to 5350 and ClientVideoPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudPollServicePrimaryUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used with Skype for Business Server. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudPollServiceSecondaryUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used with Skype for Business Server. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -352,6 +394,8 @@ Accept wildcard characters: False ### -ConsoleDownloadExternalUrl +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where external users can download a supported client such as Skype for Business. Note that this setting applies only to legacy clients (such as Microsoft Office Communicator 2007 R2) that are logging on to a Skype for Business Server 2015 pool. @@ -360,8 +404,7 @@ Note that this setting applies only to legacy clients (such as Microsoft Office ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -372,6 +415,8 @@ Accept wildcard characters: False ### -ConsoleDownloadInternalUrl +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where internal users can download a supported client such as Skype for Business. Note that this setting applies only to legacy clients (such as Microsoft Office Communicator 2007 R2) that are logging on to a Skype for Business Server pool. @@ -380,8 +425,7 @@ Note that this setting applies only to legacy clients (such as Microsoft Office ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -392,6 +436,8 @@ Accept wildcard characters: False ### -ContentGracePeriod +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how long conference content will remain on the server following the end of a meeting. The ContentGracePeriod must be specified using the format Days.Hours:Minutes:Seconds. For example, to set the content grace period to 30 days use this syntax: `-ContentGracePeriod 30.00:00:00.` @@ -404,8 +450,7 @@ The default value is 15 days (15.00:00:00). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -414,30 +459,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpdeskExternalUrl -URL where external users who click Help during a conference will be directed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HelpdeskInternalUrl -URL where internal users who click Help during a conference will be directed. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -446,16 +477,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxBandwidthPerAppSharingServiceMb -Indicates the maximum amount of bandwidth (in megabytes) set aside for the Application Sharing Conferencing service. -MaxBandwidthPerAppSharingServiceMb can be set to any integer value between 50 and 100000, inclusive. -The default value is 375 megabytes. +### -HelpdeskExternalUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL where external users who click Help during a conference will be directed. ```yaml -Type: UInt64 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -464,19 +495,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxContentStorageMb - -Maximum amount of file space (in megabytes) allowed for the storage of conference content. -MaxContentStorageMb can be set to any integer value between 50 and 1024 (1 gigabyte), inclusive. -The default value is 500. +### -HelpdeskInternalUrl +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +URL where internal users who click Help during a conference will be directed. ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -485,17 +513,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Organization -Name of the organization hosting the conference. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the collection of conferencing configuration settings to be modified. +To refer to a collection configured at the site scope, use syntax similar to this: `-Identity "site:Redmond".` +To refer to a collection at the service scope, use syntax like the following: `-Identity "service:ConferencingServer:atl-cs-001.litwareinc.com".` +Note the Web Conferencing service is the only service that can host these configuration settings. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -503,6 +536,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -511,8 +546,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -521,14 +555,18 @@ 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. +### -MaxBandwidthPerAppSharingServiceMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum amount of bandwidth (in megabytes) set aside for the Application Sharing Conferencing service. +MaxBandwidthPerAppSharingServiceMb can be set to any integer value between 50 and 100000, inclusive. +The default value is 375 megabytes. ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -537,14 +575,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxContentStorageMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum amount of file space (in megabytes) allowed for the storage of conference content. +MaxContentStorageMb can be set to any integer value between 50 and 1024 (1 gigabyte), inclusive. +The default value is 500. + + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -553,14 +597,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxUploadFileSizeMb + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum total size of the files (including handouts and PowerPoint slides) that can be used in a given conference. +This setting is typically used when conference content is being archived in Microsoft Exchange Server: by setting a maximum upload file size you can ensure that the content used in the conference (and thus the content which must be archived) does not exceed the maximum file size configured for Microsoft Exchange. +The default value is 500 megabytes. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -569,16 +617,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxUploadFileSizeMb -Maximum total size of the files (including handouts and PowerPoint slides) that can be used in a given conference. -This setting is typically used when conference content is being archived in Microsoft Exchange Server: by setting a maximum upload file size you can ensure that the content used in the conference (and thus the content which must be archived) does not exceed the maximum file size configured for Microsoft Exchange. -The default value is 500 megabytes. +### -Organization + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the organization hosting the conference. ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -587,14 +635,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudPollServicePrimaryUrl -This parameter is not currently used with Skype for Business Server. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -603,14 +653,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudPollServiceSecondaryUrl -This parameter is not currently used with Skype for Business Server. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -624,13 +676,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsConferencingConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings The New-CsConferencingConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsConferencingPolicy.md similarity index 82% rename from skype/skype-ps/skype/New-CsConferencingPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsConferencingPolicy.md index 08fab2b313..2b5c568eb7 100644 --- a/skype/skype-ps/skype/New-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsConferencingPolicy.md @@ -1,12 +1,14 @@ --- +applicable: Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, +author: tomkau external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingpolicy -applicable: Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, -schema: 2.0.0 +Locale: en-US manager: bulenteg -author: tomkau +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csconferencingpolicy +schema: 2.0.0 --- # New-CsConferencingPolicy @@ -81,26 +83,10 @@ All other policy properties will use the default values. ## PARAMETERS -### -Identity -Unique identifier for the conferencing policy to be created. -In Skype for Business Server, Conferencing policies can be created at the site or per-user scopes. In Skype for Business Online, Conferencing policies can created on a per-user scope only. -To create a site policy, use syntax similar to this: `-Identity site:Redmond.` -To create a per-user policy, use syntax similar to this: `-Identity SalesConferencingPolicy.` - -```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 +### -AllowAnnotations -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -AllowAnnotations Indicates whether or not participants are allowed to make on-screen annotations on any content shared during the meeting; in addition, this setting determines whether or not whiteboarding is allowed in the conference. The default value is True. @@ -116,8 +102,7 @@ However, the user can participate in other conferences where annotations are all ```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 +Aliases: Required: False Position: Named @@ -128,6 +113,8 @@ Accept wildcard characters: False ### -AllowAnonymousParticipantsInMeetings +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether anonymous users are allowed to participate in the meeting. If set to False then only authenticated users (that is, users logged on to your Active Directory Domain Services or the Active Directory of a federated partner) are allowed to attend the meeting. The default value is True. @@ -140,8 +127,7 @@ However, the user can take part in other conferences where anonymous participant ```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 +Aliases: Required: False Position: Named @@ -152,6 +138,8 @@ Accept wildcard characters: False ### -AllowAnonymousUsersToDialOut +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not anonymous users (unauthenticated users) are allowed to join a conference using dial-out phoning. With dial-out phoning, the conferencing server telephones the user; when the user answers the phone, he or she will be joined to the conference. @@ -169,8 +157,7 @@ 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 +Aliases: Required: False Position: Named @@ -181,6 +168,8 @@ Accept wildcard characters: False ### -AllowConferenceRecording +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether users are allowed to record the meeting. The default value is False. @@ -191,8 +180,7 @@ This setting applies to all users taking part in the conference. ```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 +Aliases: Required: False Position: Named @@ -203,6 +191,8 @@ Accept wildcard characters: False ### -AllowExternalUserControl +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether external users (either anonymous users or federated users) are allowed to take control of shared applications or desktops. The default value is False. @@ -213,8 +203,33 @@ That means that some users in a session might be allowed to give up control of a ```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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExternalUsersToRecordMeeting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether external users (either anonymous users or federated users) are allowed to record the meeting. +The default value is False. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to record conferences. +However, the user can take part in other conferences where external users are allowed to record meetings. + +Note that this setting takes effect only if the AllowConferenceRecording property is set to True. + + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -225,6 +240,8 @@ Accept wildcard characters: False ### -AllowExternalUsersToSaveContent +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether external users (that is, users not currently logged-on to your network) are allowed to save handouts, slides, and other meeting content. The default value is True. @@ -237,8 +254,25 @@ However, the user can take part in other conferences where external users are al ```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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFederatedParticipantJoinAsSameEnterprise + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), allows federated meeting participants to join the meeting as though they were internal users rather than external users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -249,6 +283,8 @@ Accept wildcard characters: False ### -AllowIPAudio +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not computer audio is allowed in the meeting. The default value is True. @@ -259,8 +295,7 @@ However, the user can take part in other conferences where IP audio is allowed. ```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 +Aliases: Required: False Position: Named @@ -271,6 +306,8 @@ Accept wildcard characters: False ### -AllowIPVideo +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not computer video is allowed in the meeting. The default value is True. @@ -282,8 +319,7 @@ However, the user can take part in other conferences where IP video is allowed. ```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 +Aliases: Required: False Position: Named @@ -292,21 +328,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowParticipantControl +### -AllowLargeMeetings -Indicates whether or not meeting participants are allowed to take control of applications or desktops shared during the meeting. -The default value is True. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow participant control. -However, the user can take part in other conferences where participant control is allowed. +When set to True, all online meetings are treated as "large meeting." With a large meeting, restrictions are placed on the number of notifications that are sent to participants as well as the size of the meeting roster that is transmitted by default. +The default value is False ($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 +Aliases: Required: False Position: Named @@ -315,21 +349,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPolls - -Indicates whether or not users are allowed to conduct online polls during a meeting. -The default value is True. +### -AllowMultiView -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow polls. -However, the user can take part in other conferences where polls are allowed. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True (the default value) enables users to schedule conferences that allow multiview; that is, clients can receive multiple video streams during a given conference. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy can include multiview. +However, the user can participate in other conferences where multiview is allowed. ```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 +Aliases: Required: False Position: Named @@ -338,21 +370,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserToScheduleMeetingsWithAppSharing +### -AllowNonEnterpriseVoiceUsersToDialOut -Indicates whether or not users are allowed to organize meetings that include application sharing. -The default value is True. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow application sharing. -However, the user can take part in other conferences where application sharing is allowed. +Indicates whether or users who have not been enabled for Enterprise Voice are allowed to join a conference using dial-out phoning. +With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference. + +Note that dial-in conferencing is allowed even when this setting is False. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow users who have not been enabled for Enterprise Voice to join the conference via dial-out phoning. +However, the user can take part in other conferences where users who have not been enabled for Enterprise Voice can join via dial out. +The default value is False ($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 +Aliases: Required: False Position: Named @@ -361,18 +396,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description - -Enables administrators to provider explanatory text about the conferencing policy. -For example, the Description might indicate the users the policy should be assigned to. +### -AllowOfficeContent +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to False, prevents users from using Office content in their conferences. ```yaml -Type: String +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 +Aliases: Required: False Position: Named @@ -381,31 +414,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAppDesktopSharing - -Indicates whether participants are allowed to share applications (or their desktop) during the course of a meeting. -Allowed values are: - -Desktop. -Users are allowed to share their entire desktop. +### -AllowParticipantControl -SingleApplication. -Users are allowed to share a single application. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -None. -Users are not allowed to share applications or their desktop. +Indicates whether or not meeting participants are allowed to take control of applications or desktops shared during the meeting. +The default value is True. -This setting is enforced at the per-user level. -That means that some users in a conference might be allowed to share their desktop or applications while other users in the same conference might not be allowed to do so. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow participant control. +However, the user can take part in other conferences where participant control is allowed. -The default value is Desktop. ```yaml -Type: EnableAppDesktopSharing +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 +Aliases: Required: False Position: Named @@ -414,20 +438,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDataCollaboration +### -AllowPolls -Indicates whether users can organize meetings that include data collaboration activities such as whiteboarding and annotations. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow data collaboration. -However, the user can take part in other conferences where data collaboration is allowed. +Indicates whether or not users are allowed to conduct online polls during a meeting. +The default value is True. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow polls. +However, the user can take part in other conferences where polls are allowed. ```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 +Aliases: Required: False Position: Named @@ -436,20 +462,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDialInConferencing +### -AllowQandA -Indicates whether users are able to join the meeting by dialing in with a public switched telephone network (PSTN) telephone. -The default value is True. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow dial-in conferencing. -However, the user can take part in other conferences where dial-in conferencing is allowed. +When set to True (the default value) the user will be able to include the Questions and Answers Manager in any online conference that he or she organizes. +When set to False, the user will be prohibited from including Questions and Answers Manager in any of his or her conferences. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow the use of the Questions and Answers Manager. +However, the user can make use of the Questions and Answers Manager in other conferences where polls are allowed. ```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 +Aliases: Required: False Position: Named @@ -458,21 +484,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFileTransfer +### -AllowSharedNotes -Indicates whether file transfers to all the meeting participants are allowed during the meeting. -The default value is True. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) any open OneNote notebooks linked to the conference will automatically be updated with information such as conference participants and details about content shared during the conference. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow file transfers. -However, the user can take part in other conferences where file transfers are allowed. ```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 +Aliases: Required: False Position: Named @@ -481,21 +505,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PFileTransfer +### -AllowUserToScheduleMeetingsWithAppSharing -Indicates whether peer-to-peer file transfers (that is, file transfers that do not involve all participants) are allowed during the meeting. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not users are allowed to organize meetings that include application sharing. The default value is True. -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to transfer files while the other user is not. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow application sharing. +However, the user can take part in other conferences where application sharing is allowed. ```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 +Aliases: Required: False Position: Named @@ -504,19 +529,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PRecording +### -ApplicationSharingMode -If True, users will be able to record peer-to-peer conferencing sessions. -The default value is False. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to record the session while the other user is not. +Determines the protocol used for screen sharing - VbSS vs RDP. This parameter is used only in SfB Server. To disable VbSS for a user, use the value "RDP". ```yaml -Type: Boolean +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 +Aliases: Required: False Position: Named @@ -525,21 +547,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PVideo - -If True, users will be able to take part in peer-to-peer video conferencing sessions. -The default value is False. +### -AppSharingBitRateKb -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to use video the session while the other user is not. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Bit rate (in kilobits) used for application sharing. +The default value is 50000. ```yaml -Type: Boolean +Type: Int64 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 +Aliases: Required: False Position: Named @@ -548,24 +567,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxMeetingSize +### -AudioBitRateKb -Indicates the maximum number of people who are allowed to attend a meeting. -After the maximum number of participants has been reached, anyone else who tries to join the meeting will be turned away with the notice that the meeting is full. -The number of participants specified in this value can be any 32-bit whole number (any value between 1 and 4,294,967,295), but the recommended size is between 2 and 250, inclusive; the default value is 250. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -250 is the maximum for shared pool deployments, based on Microsoft testing. -For information about supporting meeting with more than 250 participants, see "Microsoft Lync Server 2010 Support for Large Meetings" at https://go.microsoft.com/fwlink/p/?linkId=242073 (https://go.microsoft.com/fwlink/p/?linkId=242073). +Bit rate (in kilobits) used for audio transmissions. +The audio bit rate can be any whole number between 20 and 200, inclusive; the default value is 200. + +This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. -This setting applies to the user who organizes the conference: no conference created by a user affected by this policy will allow more than the specified number of participants. -However, the user can take part in other conferences where additional participants are allowed. ```yaml Type: UInt32 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 +Aliases: Required: False Position: Named @@ -574,27 +590,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxVideoConferenceResolution - -Indicates the maximum resolution for meeting video. -Allowed values are: - -CIF. -Common Intermediate Format (CIF) has a resolution of 352 pixels by 288 pixels. - -VGA. -VGA has a resolution of 640 pixels by 480 pixels. - -The default value is VGA. - +### -CloudRecordingServiceSupport +> Applicable: Skype for Business Online +This parameter is reserved for internal Microsoft use. ```yaml -Type: MaxVideoConferenceResolution +Type: CloudRecordingServiceSupport 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 +Aliases: +Accepted values: NotSupported, Supported, Required Required: False Position: Named @@ -603,16 +609,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provider explanatory text about the conferencing policy. +For example, the Description might indicate the users the policy should be assigned to. -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +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 +Aliases: Required: False Position: Named @@ -621,18 +630,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -DisablePowerPointAnnotations -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-\. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True) users will not be able to add annotations to PowerPoint slides used in a conference. +However (depending on the value of the AllowAnnotations property), users will still have access to other whiteboarding features. +The default value is False, meaning that PowerPoint annotations are allowed. ```yaml -Type: SwitchParameter +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 +Aliases: Required: False Position: Named @@ -641,17 +651,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -EnableAppDesktopSharing -Describes what would happen if you executed the command without actually executing the command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether participants are allowed to share applications (or their desktop) during the course of a meeting. +Allowed values are: + +Desktop. +Users are allowed to share their entire desktop. + +SingleApplication. +Users are allowed to share a single application. + +None. +Users are not allowed to share applications or their desktop. + +This setting is enforced at the per-user level. +That means that some users in a conference might be allowed to share their desktop or applications while other users in the same conference might not be allowed to do so. + +The default value is Desktop. ```yaml -Type: SwitchParameter +Type: EnableAppDesktopSharing 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 +Aliases: Required: False Position: Named @@ -660,17 +685,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -EnableDataCollaboration -Prompts you for confirmation before executing the command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether users can organize meetings that include data collaboration activities such as whiteboarding and annotations. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow data collaboration. +However, the user can take part in other conferences where data collaboration is allowed. ```yaml -Type: SwitchParameter +Type: Boolean 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 +Aliases: Required: False Position: Named @@ -679,23 +708,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalUsersToRecordMeeting - -Indicates whether external users (either anonymous users or federated users) are allowed to record the meeting. -The default value is False. +### -EnableDialInConferencing -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to record conferences. -However, the user can take part in other conferences where external users are allowed to record meetings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this setting takes effect only if the AllowConferenceRecording property is set to True. +Indicates whether users are able to join the meeting by dialing in with a public switched telephone network (PSTN) telephone. +The default value is True. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow dial-in conferencing. +However, the user can take part in other conferences where dial-in conferencing is allowed. ```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 +Aliases: Required: False Position: Named @@ -704,17 +731,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppSharingBitRateKb +### -EnableFileTransfer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether file transfers to all the meeting participants are allowed during the meeting. +The default value is True. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow file transfers. +However, the user can take part in other conferences where file transfers are allowed. -Bit rate (in kilobits) used for application sharing. -The default value is 50000. ```yaml -Type: Int64 +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 +Aliases: Required: False Position: Named @@ -723,20 +755,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioBitRateKb +### -EnableMultiViewJoin -Bit rate (in kilobits) used for audio transmissions. -The audio bit rate can be any whole number between 20 and 200, inclusive; the default value is 200. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True (the default value) clients will attempt to join a conference using multiview (which allows the client to receive multiple video streams during the conference). +This parameter will be ignored if multiview is not allowed in the conference being joined. This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. +That means that some users in a session might be allowed to have multiple video streams while other users in the same conference might not. ```yaml -Type: UInt32 +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 +Aliases: Required: False Position: Named @@ -745,18 +778,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileTransferBitRateKb - -Bit rate (in kilobits) used for file transfers. -The default value is 50000. +### -EnableOnlineMeetingPromptForLyncResources +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, users will be prompted any time they schedule a meeting in Outlook that includes invitees (such as a meeting room) that would benefit from having the meeting held online. +The default value is False. ```yaml -Type: Int64 +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 +Aliases: Required: False Position: Named @@ -765,22 +797,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoBitRateKb +### -EnableP2PFileTransfer -Bit rate (in kilobits) used for video transmissions. -The default value is 400. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. In Skype for Business Online, this setting is also enforced for producers of Skype for Business Online Broadcast meetings. +Indicates whether peer-to-peer file transfers (that is, file transfers that do not involve all participants) are allowed during the meeting. +The default value is True. -**Note:** As a result of unprecedented demand for video conferencing during the COVID-19 situation, when creating policies in Skype for Business Online, this setting cannot be changed from its default value. If you are using broadcast meeting functionality and require a a higher video bit rate, please contact your Technical Account Manager or Support to request this change. +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to transfer files while the other user is not. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, +Aliases: Required: False Position: Named @@ -789,18 +821,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowLargeMeetings +### -EnableP2PRecording -When set to True, all online meetings are treated as "large meeting." With a large meeting, restrictions are placed on the number of notifications that are sent to participants as well as the size of the meeting roster that is transmitted by default. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is False ($False). +If True, users will be able to record peer-to-peer conferencing sessions. +The default value is False. +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to record the session while the other user is not. ```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 +Aliases: Required: False Position: Named @@ -809,18 +843,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMultiView +### -EnableP2PVideo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, users will be able to take part in peer-to-peer video conferencing sessions. +The default value is False. + +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to use video the session while the other user is not. -When set to True (the default value) enables users to schedule conferences that allow multiview; that is, clients can receive multiple video streams during a given conference. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy can include multiview. -However, the user can participate in other conferences where multiview is allowed. ```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 +Aliases: Required: False Position: Named @@ -829,23 +867,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNonEnterpriseVoiceUsersToDialOut - -Indicates whether or users who have not been enabled for Enterprise Voice are allowed to join a conference using dial-out phoning. -With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference. - -Note that dial-in conferencing is allowed even when this setting is False. +### -EnableReliableConferenceDeletion -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow users who have not been enabled for Enterprise Voice to join the conference via dial-out phoning. -However, the user can take part in other conferences where users who have not been enabled for Enterprise Voice can join via dial out. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -The default value is False ($False). +PARAMVALUE: $true | $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 +Aliases: Required: False Position: Named @@ -854,18 +885,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedNotes +### -FileTransferBitRateKb -When set to True (the default value) any open OneNote notebooks linked to the conference will automatically be updated with information such as conference participants and details about content shared during the conference. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Bit rate (in kilobits) used for file transfers. +The default value is 50000. ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -874,18 +906,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisablePowerPointAnnotations +### -Force -When set to True ($True) users will not be able to add annotations to PowerPoint slides used in a conference. -However (depending on the value of the AllowAnnotations property), users will still have access to other whiteboarding features. -The default value is False, meaning that PowerPoint annotations are allowed. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -894,40 +925,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMultiViewJoin - -When set to True (the default value) clients will attempt to join a conference using multiview (which allows the client to receive multiple video streams during the conference). -This parameter will be ignored if multiview is not allowed in the conference being joined. -This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. -That means that some users in a session might be allowed to have multiple video streams while other users in the same conference might not. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier for the conferencing policy to be created. +In Skype for Business Server, Conferencing policies can be created at the site or per-user scopes. In Skype for Business Online, Conferencing policies can created on a per-user scope only. +To create a site policy, use syntax similar to this: `-Identity site:Redmond.` +To create a per-user policy, use syntax similar to this: `-Identity SalesConferencingPolicy.` ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TotalReceiveVideoBitRateKb +### -InMemory -Indicates the maximum allowed bitrate (in kilobytes per second) for all the video used in a conference; that is, the combined total for all the video streams. -The default value is 50000 kilobytes per second. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: Int64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -936,30 +967,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowFederatedParticipantJoinAsSameEnterprise -When set to True ($True), allows federated meeting participants to join the meeting as though they were internal users rather than external users. +### -MaxMeetingSize -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Indicates the maximum number of people who are allowed to attend a meeting. +After the maximum number of participants has been reached, anyone else who tries to join the meeting will be turned away with the notice that the meeting is full. +The number of participants specified in this value can be any 32-bit whole number (any value between 1 and 4,294,967,295), but the recommended size is between 2 and 250, inclusive; the default value is 250. + +250 is the maximum for shared pool deployments, based on Microsoft testing. +For information about supporting meeting with more than 250 participants, see "Microsoft Lync Server 2010 Support for Large Meetings" at https://go.microsoft.com/fwlink/p/?linkId=242073 (https://go.microsoft.com/fwlink/p/?linkId=242073). + +This setting applies to the user who organizes the conference: no conference created by a user affected by this policy will allow more than the specified number of participants. +However, the user can take part in other conferences where additional participants are allowed. -### -AllowOfficeContent -When set to False, prevents users from using Office content in their conferences. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -968,18 +994,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowQandA -When set to True (the default value) the user will be able to include the Questions and Answers Manager in any online conference that he or she organizes. -When set to False, the user will be prohibited from including Questions and Answers Manager in any of his or her conferences. +### -MaxVideoConferenceResolution + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum resolution for meeting video. +Allowed values are: + +CIF. +Common Intermediate Format (CIF) has a resolution of 352 pixels by 288 pixels. + +VGA. +VGA has a resolution of 640 pixels by 480 pixels. + +The default value is VGA. + + -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow the use of the Questions and Answers Manager. -However, the user can make use of the Questions and Answers Manager in other conferences where polls are allowed. ```yaml -Type: Boolean +Type: MaxVideoConferenceResolution Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -988,14 +1024,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationSharingMode -Determines the protocol used for screen sharing - VbSS vs RDP. This parameter is used only in SfB Server. To disable VbSS for a user, use the value "RDP". +### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new conferencing 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: String +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1004,15 +1049,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudRecordingServiceSupport -This parameter is reserved for internal Microsoft use. +### -TotalReceiveVideoBitRateKb + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum allowed bitrate (in kilobytes per second) for all the video used in a conference; that is, the combined total for all the video streams. +The default value is 50000 kilobytes per second. + + ```yaml -Type: CloudRecordingServiceSupport +Type: Int64 Parameter Sets: (All) -Aliases: -Accepted values: NotSupported, Supported, Required -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1021,15 +1070,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineMeetingPromptForLyncResources -When set to True, users will be prompted any time they schedule a meeting in Outlook that includes invitees (such as a meeting room) that would benefit from having the meeting held online. -The default value is False. +### -VideoBitRateKb + +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, + +Bit rate (in kilobits) used for video transmissions. +The default value is 400. + +This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. In Skype for Business Online, this setting is also enforced for producers of Skype for Business Online Broadcast meetings. + +**Note:** As a result of unprecedented demand for video conferencing during the COVID-19 situation, when creating policies in Skype for Business Online, this setting cannot be changed from its default value. If you are using broadcast meeting functionality and require a a higher video bit rate, please contact your Technical Account Manager or Support to request this change. + + ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1038,14 +1095,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReliableConferenceDeletion -PARAMVALUE: $true | $false +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -1054,21 +1115,18 @@ 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 conferencing policy is being created. -For example: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. -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 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -1083,17 +1141,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### None - -### -None. The New-CsConferencingPolicy cmdlet does not accept pipelined input. ## OUTPUTS ### System.Object -### -The New-CsConferencingPolicy cmdlet creates a new instance of the Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy ## NOTES diff --git a/skype/skype-ps/skype/New-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsCpsConfiguration.md similarity index 85% rename from skype/skype-ps/skype/New-CsCpsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsCpsConfiguration.md index dfaf405eee..ec1eba0cc1 100644 --- a/skype/skype-ps/skype/New-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCpsConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscpsconfiguration +schema: 2.0.0 --- # New-CsCpsConfiguration @@ -44,7 +45,7 @@ In addition, Call Park service can be configured to play music on hold to the ca ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsCpsConfiguration -Identity site:Redmond -EnableMusicOnHold $False ``` @@ -54,7 +55,7 @@ This configuration will be created with default values with the exception of Ena This command sets this property to False, meaning the caller whose call has been parked will not hear anything while on hold. (EnableMusicOnHold is set to True by default, assuming Call Park service has been deployed.) -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsCpsConfiguration -Identity site:Redmond -OnTimeoutURI sip:kenmyer@litwareinc.com @@ -66,7 +67,7 @@ In this case the OnTimeoutURI is set to sip:kenmyer@litwareinc.com. The value passed to this parameter must begin with the string "sip:" and should point to a user or Response Group that will receive parked calls that aren't picked up after a specified number of ringback attempts. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsCpsConfiguration -Identity site:Redmond -MaxCallPickupAttempts 2 @@ -79,25 +80,10 @@ That means the call rings back up to two times. ## PARAMETERS -### -Identity -The site to which the settings are applied. -This must be entered in the format site:\, such as site:Redmond. -A configuration will always exist at the global scope and can't be removed, so a global configuration can't be re-created with this cmdlet. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CallPickupTimeoutThreshold -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CallPickupTimeoutThreshold The amount of time that will elapse after a call has been parked before it will ring back to the phone on which the call was answered. This must be entered in the format hh:mm:ss (hh = hours, mm = minutes, ss = seconds) @@ -107,8 +93,7 @@ Default: 00:01:30 (90 seconds); Minimum Value: 10 seconds (00:00:10); Maximum Va ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +104,8 @@ Accept wildcard characters: False ### -EnableMusicOnHold +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether music plays for the caller while a call is parked. Skype for Business Server ships with a default Music on Hold file. @@ -131,8 +118,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,17 +127,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxCallPickupAttempts -The number of times a parked call will ring back to the answering phone before giving up and forwarding the call to the fallback Uniform Resource Identifier (URI). -The fallback URI is set with the OnTimeoutURI parameter. +### -Force -Default: 1; Minimum Value: 1; Maximum Value: 10 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,35 +145,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnTimeoutURI -The SIP address of the user or Response Group to which unanswered parked calls will be routed. -The parked call will be routed after the number of ringbacks defined with the MaxCallPickupAttempts parameter. -If that parameter is set to Null, the OnTimeoutURI will be ignored and the parked call will be disconnected after unsuccessful ringback attempts. +### -Identity -Values must be SIP URIs, beginning with the string sip:. -For example, sip:rgs1@litwareinc.com. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The site to which the settings are applied. +This must be entered in the format site:\, such as site:Redmond. +A configuration will always exist at the global scope and can't be removed, so a global configuration can't be re-created with this cmdlet. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,18 +186,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -MaxCallPickupAttempts -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The number of times a parked call will ring back to the answering phone before giving up and forwarding the call to the fallback Uniform Resource Identifier (URI). +The fallback URI is set with the OnTimeoutURI parameter. +Default: 1; Minimum Value: 1; Maximum Value: 10 ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -217,14 +207,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -OnTimeoutURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP address of the user or Response Group to which unanswered parked calls will be routed. +The parked call will be routed after the number of ringbacks defined with the MaxCallPickupAttempts parameter. +If that parameter is set to Null, the OnTimeoutURI will be ignored and the parked call will be disconnected after unsuccessful ringback attempts. + +Values must be SIP URIs, beginning with the string sip:. +For example, sip:rgs1@litwareinc.com. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,13 +231,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -254,12 +271,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDeviceUpdateConfiguration.md similarity index 90% rename from skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsDeviceUpdateConfiguration.md index e0f256355d..d2ff1f42c4 100644 --- a/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDeviceUpdateConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDeviceUpdateConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdeviceupdateconfiguration +schema: 2.0.0 +title: New-CsDeviceUpdateConfiguration --- # New-CsDeviceUpdateConfiguration @@ -98,7 +99,7 @@ That's because you can only have one collection of device update configuration s ## EXAMPLES -### -------------------------- Example 1 ------------------------ (Lync Server 2010) +### Example 1 (Lync Server 2010) ``` New-CsDeviceUpdateConfiguration -Identity site:Redmond ``` @@ -106,7 +107,7 @@ New-CsDeviceUpdateConfiguration -Identity site:Redmond The command shown in Example 1 creates a new set of device update configuration settings with the Identity site:Redmond. Because no other parameters are included in the command, this new collection of configuration settings will use the default values for each property. -### -------------------------- EXAMPLE 1 -------------------------- (Lync Server 2013) +### EXAMPLE 1 (Lync Server 2013) ``` ``` @@ -116,7 +117,7 @@ Because no other parameters are included in the command, this new collection of New-CsDeviceUpdateConfiguration -Identity site:Redmond -### -------------------------- EXAMPLE 1 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 1 (Skype for Business Server 2015) ``` ``` @@ -126,7 +127,7 @@ Because no other parameters are included in the command, this new collection of New-CsDeviceUpdateConfiguration -Identity site:Redmond -### -------------------------- Example 2 ------------------------ (Lync Server 2010) +### Example 2 (Lync Server 2010) ``` New-CsDeviceUpdateConfiguration -Identity site:Redmond -MaxLogFileSize 204800 -LogCleanUpInterval 7.00:00:00 ``` @@ -135,7 +136,7 @@ The preceding command also creates a new set of device update configuration sett In this case, two additional parameters are used in order to customize the new settings: MaxLogFileSize is used to set the maximum log file size to 2048000 bytes, while LogCleanUpInterval is used to set the log cleanup interval time to 7 days (7 days . 00 hours : 00 minutes : 00 seconds). -### -------------------------- EXAMPLE 2 -------------------------- (Lync Server 2013) +### EXAMPLE 2 (Lync Server 2013) ``` ``` @@ -146,7 +147,7 @@ In this case, two additional parameters are used in order to customize the new s New-CsDeviceUpdateConfiguration -Identity site:Redmond -MaxLogFileSize 204800 -LogCleanUpInterval 7.00:00:00 -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 2 (Skype for Business Server 2015) ``` ``` @@ -159,15 +160,35 @@ New-CsDeviceUpdateConfiguration -Identity site:Redmond -MaxLogFileSize 204800 -L ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the new device update configuration settings. Because new settings can only be created at the site scope, the Identity will look something like this: -Identity "site:Redmond". ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -176,7 +197,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +**Below Content Applies To:** Lync Server 2010, Lync Server 2013 + +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. + + + +**Below Content Applies To:** Skype for Business Server 2015 + +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 +``` + ### -LogCleanUpInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time a device update log file is kept before it is deleted by the system. The value must be entered in the format dd.hh:mm:ss where dd is days, hh is hours, mm is minutes, and ss is seconds. @@ -191,8 +245,7 @@ Default: 10.00:00:00 (10 Days) ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +255,9 @@ Accept wildcard characters: False ``` ### -LogCleanUpTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the time of day when the system checks to see if there are any expired log files that should be deleted. (Expired log files are any files older than the value specified in by the LogCleanupInterval property.) @@ -214,8 +270,7 @@ The default value is null. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +280,9 @@ Accept wildcard characters: False ``` ### -LogFlushInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often information stored in the log file cache is written to the actual log file. By default, device update information is not immediately written to the log file; instead, that information is cached in memory until: 1) the log flush time interval has expired; or, 2) the cache has reached its maximum size. If this value is set to 10 minutes (00:10:00), then information in the cache will be written to the log file every 10 minutes. @@ -241,8 +299,7 @@ Default: 00:05:00 ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -252,6 +309,9 @@ Accept wildcard characters: False ``` ### -MaxLogCacheLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum amount of information (in bytes) that can be held in the log file cache before that cache must be cleared and the data written to a log file. By default, log files are "flushed" every X number of minutes. (For details, see the description of the parameter LogFlushInterval.) However, if the cache reaches its maximum size, the information in it will automatically be written to a log file (and the cache cleared) even if the log flush interval has not yet expired. @@ -261,8 +321,7 @@ Default: 512000 ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -272,6 +331,9 @@ Accept wildcard characters: False ``` ### -MaxLogFileSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum size, in bytes, for an individual log file. When a file reaches the maximum size, the next batch of data is automatically written to a new log file. The old log file will be retained until the log cleanup interval has expired. @@ -281,8 +343,7 @@ Default: 1024000 ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,6 +353,9 @@ Accept wildcard characters: False ``` ### -ValidLogFileExtensions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010 Indicates the valid log file extensions that can be used with the Device Update Web service. @@ -322,8 +386,7 @@ Default: .dmp, .clg, .clg2, .bak, .kdmp, .dat, .bin, .cat, .xml, .txt, .hex ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,6 +396,9 @@ Accept wildcard characters: False ``` ### -ValidLogFileTypes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010 Indicates the log file types retained by the device update system. @@ -341,7 +407,7 @@ The default file types include the following: Watson. Log files automatically generated by a device in the event of a system crash. -Config. +Config. Microsoft RoundTable conferencing device profiles that are created any time you configure a RoundTable device. DiagLog. @@ -393,8 +459,7 @@ For example, if you do not want to store CELog files then you can remove the CEL ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -403,42 +468,16 @@ 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 Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -**Below Content Applies To:** Lync Server 2010, Lync Server 2013 - -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. - - - -**Below Content Applies To:** Skype for Business Server 2015 - -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-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -448,29 +487,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -484,17 +509,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None New-CsDeviceUpdateConfiguration does not accept pipelined input. -### -None. -The New-CsDeviceUpdateConfiguration cmdlet does not accept pipelined input. - ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration The New-CsDeviceUpdateConfiguration cmdlet creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsDiagnosticConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsDiagnosticConfiguration.md index db23830811..a11ad277a6 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDiagnosticConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdiagnosticconfiguration +schema: 2.0.0 +title: New-CsDiagnosticConfiguration --- # New-CsDiagnosticConfiguration @@ -102,14 +103,14 @@ For example, your command will fail if you try to create a new collection for th ## EXAMPLES -### -------------------------- Example 1 ------------------------ (Lync Server 2010) +### Example 1 (Lync Server 2010) ``` New-CsDiagnosticConfiguration -Identity site:Redmond ``` The preceding command creates a new collection of diagnostic configuration settings for the Redmond site. -### -------------------------- EXAMPLE 1 -------------------------- (Lync Server 2013) +### EXAMPLE 1 (Lync Server 2013) ``` ``` @@ -118,7 +119,7 @@ Example 1 creates a new collection of diagnostic configuration settings for the New-CsDiagnosticConfiguration -Identity site:Redmond -### -------------------------- EXAMPLE 1 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 1 (Skype for Business Server 2015) ``` ``` @@ -127,9 +128,9 @@ Example 1 creates a new collection of diagnostic configuration settings for the New-CsDiagnosticConfiguration -Identity site:Redmond -### -------------------------- Example 2 ------------------------ (Lync Server 2010) +### Example 2 (Lync Server 2010) ``` -$x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri "sip:user@fabrikam.com" -Enabled $False +$x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri "sip:user@fabrikam.com" -Enabled $False New-CsDiagnosticConfiguration -Identity site:Redmond -Filter $x ``` @@ -142,7 +143,7 @@ The resulting virtual filter is then stored in the variable $x. In command 2, New-CsDiagnosticConfiguration is used to create a new diagnostic configuration settings collection for the Redmond site. These new settings will use the diagnostic filter stored in the variable $x. -### -------------------------- EXAMPLE 2 -------------------------- (Lync Server 2013) +### EXAMPLE 2 (Lync Server 2013) ``` ``` @@ -159,7 +160,7 @@ $x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri "sip:user@fabrikam.com" -En New-CsDiagnosticConfiguration -Identity site:Redmond -Filter $x -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 2 (Skype for Business Server 2015) ``` ``` @@ -176,7 +177,7 @@ $x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri "sip:user@fabrikam.com" -En New-CsDiagnosticConfiguration -Identity site:Redmond -Filter $x -### -------------------------- Example 3 ------------------------ (Lync Server 2010) +### Example 3 (Lync Server 2010) ``` $x = New-CsDiagnosticConfiguration -Identity site:Redmond -InMemory $x.LoggingShare = "\\atl-fs-001\logs" @@ -192,7 +193,7 @@ The final command is then used to transform the virtual diagnostic configuration Note that this final command is mandatory. If you do not call Set-CsDiagnosticConfiguration, no settings will be applied to the Redmond site, and the virtual settings will disappear as soon as you end your Windows PowerShell session or delete the variable $x. -### -------------------------- EXAMPLE 3 -------------------------- (Lync Server 2013) +### EXAMPLE 3 (Lync Server 2013) ``` ``` @@ -212,7 +213,7 @@ $x.LoggingShare = "\\\\atl-fs-001\logs" Set-CsDiagnosticConfiguration -Instance $x -### -------------------------- EXAMPLE 3 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 3 (Skype for Business Server 2015) ``` ``` @@ -234,24 +235,10 @@ Set-CsDiagnosticConfiguration -Instance $x ## PARAMETERS -### -Identity -Unique identifier for the diagnostics configuration settings to be created. -Because new settings can only be created at the site scope you must use syntax similar to this: -Identity "site:Redmond". - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Filter -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Filter Collection of domains and URIs whose traffic will be logged if diagnostic filtering is enabled. The Filter property consists of three separate items: @@ -269,8 +256,7 @@ Enabled - Indicates whether or not the filter should be activated. ```yaml Type: Filter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,14 +265,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoggingShare -Shared folder where the diagnostic logs can be uploaded. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -295,23 +283,29 @@ 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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the diagnostics configuration settings to be created. +Because new settings can only be created at the site scope you must use syntax similar to this: -Identity "site:Redmond". ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010, Lync Server 2013 Creates an object reference without actually committing the object as a permanent change. @@ -329,8 +323,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -339,14 +332,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LogAllSipHeaders + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, only the core SIP headers are recorded in the logs. +Setting this value to False can help reduce the size of the log files. +When set to True, all SIP headers are logged. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoggingShare + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Shared folder where the diagnostic logs can be uploaded. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -356,13 +371,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -371,16 +388,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LogAllSipHeaders -When set to False, only the core SIP headers are recorded in the logs. -Setting this value to False can help reduce the size of the log files. -When set to True, all SIP headers are logged. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -394,22 +411,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None New-CsDiagnosticConfiguration does not accept pipelined input. -### -None. -The New-CsDiagnosticConfiguration cmdlet does not accept pipelined input. - ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings New-CsDiagnosticConfiguration creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings. -### -The New-CsDiagnosticConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings. - ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticHeaderConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsDiagnosticHeaderConfiguration.md index 7906c3c207..76c24848bf 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticHeaderConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDiagnosticHeaderConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdiagnosticheaderconfiguration +schema: 2.0.0 +title: New-CsDiagnosticHeaderConfiguration --- # New-CsDiagnosticHeaderConfiguration @@ -56,7 +57,7 @@ Likewise, your command will fail if you try to create a new collection at the gl ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsDiagnosticHeaderConfiguration -Identity site:Redmond -SendToOutsideUnauthenticatedUsers $True ``` @@ -66,7 +67,7 @@ In addition to specifying the Identity, the command also uses the SendToOutsideA -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsDiagnosticHeaderConfiguration -Identity site:Redmond -InMemory @@ -90,7 +91,28 @@ If you do not call the Set-CsDiagnosticHeaderConfiguration cmdlet, no settings w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the diagnostic header configuration settings to be created. To create a new settings collection at the site scope, use syntax similar to this: `-Identity "site:Redmond".` To create a new settings collection at the service scope, use syntax like this: `-Identity "service:EdgeServer:atl-cs-001.litwareinc.com".` @@ -101,8 +123,7 @@ In addition, you cannot create new settings at the site or service scope if the ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -111,17 +132,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SendToExternalNetworks +### -InMemory -When set to True, diagnostic headers will be attached to messages sent to external users. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,33 +153,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SendToOutsideUnauthenticatedUsers -When set to True, diagnostic headers will be attached to messages sent to outside users. -Outside users are users who have connected from outside the internal network (for example, through a proxy server) and have not yet been authenticated. +### -SendToExternalNetworks -The default value is False. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, diagnostic headers will be attached to messages sent to external users. -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 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,18 +173,17 @@ 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-\. +### -SendToExternalNetworksOnServiceEdge +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, diagnostic headers will be attached to messages sent to networks on the service edge. +The default value is False. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,14 +192,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SendToOutsideUnauthenticatedUsers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, diagnostic headers will be attached to messages sent to outside users. +Outside users are users who have connected from outside the internal network (for example, through a proxy server) and have not yet been authenticated. + +The default value is False. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,13 +214,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -217,15 +231,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SendToExternalNetworksOnServiceEdge -When set to True, diagnostic headers will be attached to messages sent to networks on the service edge. -The default value is False. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -240,14 +255,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsDiagnosticHeaderConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings The New-CsDiagnosticHeaderConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDiagnosticsFilter.md b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticsFilter.md similarity index 88% rename from skype/skype-ps/skype/New-CsDiagnosticsFilter.md rename to skype/skype-ps/SkypeForBusiness/New-CsDiagnosticsFilter.md index d2f329786f..e5f3100d81 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticsFilter.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticsFilter.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticsfilter applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDiagnosticsFilter -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdiagnosticsfilter +schema: 2.0.0 +title: New-CsDiagnosticsFilter --- # New-CsDiagnosticsFilter @@ -87,14 +88,16 @@ To do this, both names (separated by a comma) are used as parameter values for t ## PARAMETERS ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the filter should be employed. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,14 +107,16 @@ Accept wildcard characters: False ``` ### -ExcludeConferenceMessages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, information about conference messages (that is, any message with a conference URI in its To or From header) will not be recorded in the log files. The default value is 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 +Aliases: Required: False Position: Named @@ -120,15 +125,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludePresenceNotifications -If set to True, information about presence notifications (that is, any message that uses the NOTIFY or BENOTIFY method) will not be recorded in the log files. -The default value is False. +### -ExcludeMidDialogRequests +If set to True, information about mid-dialog SIP requests will not be recorded in the log files. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,15 +140,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeRegisterMessages -If set to True, information about client registrations (that is, any message that uses the REGISTER method) will not be recorded in the log files. +### -ExcludePresenceNotifications + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, information about presence notifications (that is, any message that uses the NOTIFY or BENOTIFY method) will not be recorded in the log files. The default value is 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 +Aliases: Required: False Position: Named @@ -154,17 +159,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Fqdn -Collection of domains to be included in the filter. -(More technically, these domains represent the host portion of a SIP address.) For the FQDN property you can use a fully qualified domain name (FQDN) like this: fabrikam.com. -Alternatively, you can use wildcards to represent multiple domains: *.fabrikam.com. -You can have more than one domain in a single filter. +### -ExcludeRegisterMessages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, information about client registrations (that is, any message that uses the REGISTER method) will not be recorded in the log files. +The default value is False. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,23 +178,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Uri -Collection of URIs to be included in the filter. -(The URI is the user@host portion of a SIP address.) A URI can consist of any of the following patterns: +### -ExcludeSubscribeMessages -user@fabrikam.com +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -user@* +If set to True, information about client subscriptions (that is, any message that uses the SUBSCRIBE method) will not be recorded in the log files. +The default value is False. -*@fabrikam.com -You can include multiple URIs in a single filter. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,18 +199,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeSubscribeMessages - -If set to True, information about client subscriptions (that is, any message that uses the SUBSCRIBE method) will not be recorded in the log files. -The default value is False. +### -ExcludeSuccessfulRequests +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +If set to True. +Information about successful SIP requests will not be recorded in the log files. +Instead, only information about unsuccessful requests will be saved. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -218,16 +219,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeSuccessfulRequests -If set to True. -Information about successful SIP requests will not be recorded in the log files. -Instead, only information about unsuccessful requests will be saved. +### -ExcludeTypingNotifications +If set to True, information about typing notifications SIP messages will not be recorded in the log files. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,11 +234,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeMidDialogRequests -If set to True, information about mid-dialog SIP requests will not be recorded in the log files. +### -Fqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of domains to be included in the filter. +(More technically, these domains represent the host portion of a SIP address.) For the FQDN property you can use a fully qualified domain name (FQDN) like this: fabrikam.com. +Alternatively, you can use wildcards to represent multiple domains: *.fabrikam.com. +You can have more than one domain in a single filter. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -251,11 +255,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeTypingNotifications -If set to True, information about typing notifications SIP messages will not be recorded in the log files. +### -Uri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of URIs to be included in the filter. +(The URI is the user@host portion of a SIP address.) A URI can consist of any of the following patterns: + +user@fabrikam.com + +user@* + +*@fabrikam.com + +You can include multiple URIs in a single filter. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -271,15 +287,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsDiagnosticsFilter cmdlet does not accept pipelined input. ## OUTPUTS - -### -The New-CsDiagnosticsFilter cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.Filter object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.Filter ## NOTES diff --git a/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingAccessNumber.md similarity index 74% rename from skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md rename to skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingAccessNumber.md index 96f6b14689..51f7e7e4d5 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingAccessNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDialInConferencingAccessNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdialinconferencingaccessnumber +schema: 2.0.0 +title: New-CsDialInConferencingAccessNumber --- # New-CsDialInConferencingAccessNumber @@ -22,31 +23,22 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### Onprem (Default) ``` -New-CsDialInConferencingAccessNumber -PrimaryUri [-DisplayName ] -DisplayNumber - -LineURI -Regions - -Pool -PrimaryLanguage +New-CsDialInConferencingAccessNumber -PrimaryUri -DisplayNumber -LineURI + -PrimaryLanguage [-SecondaryLanguages ] - [-ScopeToSite] [-PassThru] [-WhatIf] [-Confirm] [-Tenant ] [] + -Pool -Regions + [-ScopeToSite] [-Tenant ] [-DisplayName ] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### Hosting ``` -New-CsDialInConferencingAccessNumber -DisplayNumber -HostingProviderProxyFqdn -LineURI - -PrimaryLanguage -PrimaryUri [-Confirm] [-DisplayName ] [-PassThru] [-ScopeToSite] +New-CsDialInConferencingAccessNumber -PrimaryUri -DisplayNumber -LineURI + -PrimaryLanguage [-SecondaryLanguages ] - [-Tenant ] [-WhatIf] [] -``` - -### Onprem -``` -New-CsDialInConferencingAccessNumber -DisplayNumber -LineURI -Pool - -PrimaryLanguage -PrimaryUri - -Regions [-Confirm] - [-DisplayName ] [-PassThru] [-ScopeToSite] - [-SecondaryLanguages ] - [-Tenant ] [-WhatIf] [] + [-ScopeToSite] -HostingProviderProxyFqdn [-Tenant ] [-DisplayName ] [-PassThru] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -73,7 +65,7 @@ That simply means you must first create a dial plan, and specify a region for th ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" -LineUri "tel:+18005551234" -Pool atl-cs-001.litwareinc.com -PrimaryLanguage "en-US" -Regions "Redmond" ``` @@ -82,7 +74,7 @@ Example 1 creates a new dial-in conferencing access number with the primary URI In addition to the PrimaryUri parameter, the command also includes parameters that configure the telephone number as displayed in Skype for Business (DisplayNumber); the telephone number in the E.164 format (LineUri); the Registrar pool the new number is assigned to `(-Pool): the primary language for the number (PrimaryLanguage)`; and the region the new number is assigned to (Regions). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" -LineUri "tel:+18005551234" -Pool atl-cs-001.litwareinc.com -PrimaryLanguage "en-US" -Regions "Redmond" -SecondaryLanguages "fr-CA", "fr-FR" @@ -92,7 +84,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1; To assign these secondary languages, the SecondaryLanguages parameter is included, along with a comma-separated list of the languages to be assigned (fr-CA and fr-FR). -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" -LineUri "tel:+18005551234" -Pool atl-cs-001.litwareinc.com -PrimaryLanguage "en-US" -Regions "Redmond" -ScopeToSite ``` @@ -104,58 +96,56 @@ To do this, the command includes the parameter ScopeToSite. ## PARAMETERS -### -PrimaryUri +### -DisplayName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Unique SIP address to be assigned to the new contact object. -When specifying the PrimaryUri you must include the "sip:" prefix. -For example: `-PrimaryUri "sip:RedmondDialIn@litwareinc.com".` -Note that the sip: prefix must be entered in all lowercase letters. +Active Directory display name for the new contact object. +This is the name that will also be displayed in Skype for Business. ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName - -Active Directory display name for the new contact object. -This is the name that will also be displayed in Skype for Business. +### -DisplayNumber +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Phone number as displayed in meeting invitations and on the dial-in conferencing webpage. +The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234. ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber -Phone number as displayed in meeting invitations and on the dial-in conferencing webpage. -The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234. +### -HostingProviderProxyFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the hosting provider that hosts your dial-in conferencing service. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Microsoft.Rtc.Management.Deploy.Fqdn +Parameter Sets: Hosting +Aliases: HostingProvider Required: True Position: Named @@ -165,6 +155,9 @@ Accept wildcard characters: False ``` ### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The actual dial-in conferencing phone number. The LineURI must be specified using the following syntax: the tel: prefix followed by a plus sign (+) followed by the country/region calling code, area code, and phone number. For example: tel:+18005551234. @@ -173,10 +166,9 @@ Note that spaces, hyphens, parentheses and other characters are not allowed. LineURIs must be unique throughout Active Directory. ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -185,32 +177,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Regions -Dial plan regions associated with the dial-in number. -If a region is not included in at least one dial plan, then it cannot be associated with a dial-in conferencing access number. -To specify multiple regions, use a comma-separated list: `-Regions "Northwest", "Southwest"` +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a contact object through the pipeline that represents the new dial-in conferencing access number. +By default, the New-CsDialInConferencingAccessNumber cmdlet does not pass objects through the pipeline. ```yaml -Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] -Parameter Sets: (All), Onprem -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -Pool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Home pool for the new contact object. ```yaml -Type: Fqdn -Parameter Sets: (All), Onprem -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Microsoft.Rtc.Management.Deploy.Fqdn +Parameter Sets: Onprem +Aliases: Required: True Position: Named @@ -220,6 +215,9 @@ Accept wildcard characters: False ``` ### -PrimaryLanguage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Primary language used for making dial-in conferencing announcements. The language must be configured using one of the available dial-in conferencing language codes; for example, en-US for U.S. English; fr-FR for French; etc. @@ -228,10 +226,9 @@ To return a list of the available language codes, type the following command at `Get-CsDialInConferencingLanguageList | Select-Object -ExpandProperty Languages.` ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -240,83 +237,82 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryLanguages -Optional collection of languages that can also be used for making dial-in conferencing announcements. -Secondary languages must be configured as a comma-separated list of language codes; for example, the following syntax sets French Canadian and French as secondary languages; `-SecondaryLanguages "fr-CA", "fr-FR".` +### -PrimaryUri -A single access number can have as many as four secondary languages. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.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 -``` +Unique SIP address to be assigned to the new contact object. +When specifying the PrimaryUri you must include the "sip:" prefix. +For example: `-PrimaryUri "sip:RedmondDialIn@litwareinc.com".` +Note that the sip: prefix must be entered in all lowercase letters. + -### -ScopeToSite -If present, the new number will be scoped to the same site as the contact object's home pool. -If the ScopeToSite parameter is not included, the new number will be assigned to the global scope. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a contact object through the pipeline that represents the new dial-in conferencing access number. -By default, the New-CsDialInConferencingAccessNumber cmdlet does not pass objects through the pipeline. +### -Regions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Dial plan regions associated with the dial-in number. +If a region is not included in at least one dial plan, then it cannot be associated with a dial-in conferencing access number. +To specify multiple regions, use a comma-separated list: `-Regions "Northwest", "Southwest"` ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] +Parameter Sets: Onprem +Aliases: -Required: False +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. +### -ScopeToSite + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, the new number will be scoped to the same site as the contact object's home pool. +If the ScopeToSite parameter is not included, the new number will be assigned to the global scope. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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 executing the command. +### -SecondaryLanguages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Optional collection of languages that can also be used for making dial-in conferencing announcements. +Secondary languages must be configured as a comma-separated list of language codes; for example, the following syntax sets French Canadian and French as secondary languages; `-SecondaryLanguages "fr-CA", "fr-FR".` + +A single access number can have as many as four secondary languages. ```yaml -Type: SwitchParameter +Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -327,6 +323,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new dial-in conferencing access number is being created. For example: @@ -339,10 +337,9 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml -Type: Guid +Type: System.Nullable`1[System.Guid] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -351,35 +348,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostingProviderProxyFqdn -Fully qualified domain name of the hosting provider that hosts your dial-in conferencing service. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Fqdn -Parameter Sets: Hosting -Aliases: HostingProvider -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True +Required: False Position: Named -Default value: None +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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. +### None The New-CsDialInConferencingAccessNumber cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.AccessNumber The New-CsDialInConferencingAccessNumber cmdlet creates new instances of the Microsoft.Rtc.Management.Xds.AccessNumber object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingConfiguration.md index d05fb34422..f591124b88 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDialInConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdialinconferencingconfiguration +schema: 2.0.0 +title: New-CsDialInConferencingConfiguration --- # New-CsDialInConferencingConfiguration @@ -43,7 +44,7 @@ These conference "join behaviors" are managed using dial-in conferencing configu ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CSDialInConferencingConfiguration -Identity site:Redmond -EnableNameRecording $False ``` @@ -52,7 +53,7 @@ The command shown in Example 1 creates a new collection of dial-in conferencing In addition, the optional parameter EnableNameRecording is included in order to set the EnableNameRecording property to False. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CSDialInConferencingConfiguration -Identity site:Redmond -InMemory @@ -68,27 +69,31 @@ Finally, line 3 in the example calls the Set-CSDialInConferencingConfiguration c ## PARAMETERS -### -Identity -Indicates the Identity of the dial-in conferencing configuration settings to be created. -Because these settings can only be created at the site scope, use syntax similar to this, with the prefix "site:" followed by the name of the site: `-Identity site:Redmond.` +### -AllowAnonymousPstnActivation -Note that there can only be one set of dial-in conferencing configuration settings per site. -The sample command will fail if a collection of settings with the Identity site:Redmond already exists. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether unauthenticated callers can start a meeting if they are the first person to join. +An unauthenticated caller is defined as a participant who joins a meeting over the phone and doesn't provide a PIN when joining the meeting. +$True to allow anonymous activation, otherwise $False. +The default is $False. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -EnableNameRecording + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether or not users are asked to record their name before entering the conference. Set to True ($True) to require name recording; set to False ($False) to bypass name recording. The default value is True. @@ -96,8 +101,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,14 +111,16 @@ Accept wildcard characters: False ``` ### -EntryExitAnnouncementsEnabledByDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True announcements will be played each time a participant enters or exits a conference. If set to False (the default value), entry and exit announcements will not be played. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +130,9 @@ Accept wildcard characters: False ``` ### -EntryExitAnnouncementsType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the action taken by the system any time a participant enters or leaves a conference. Valid values are: @@ -139,8 +148,7 @@ Note that announcements are played only if the EntryExitAnnouncementsEnabledByDe ```yaml Type: EntryExitAnnouncementsType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,13 +158,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,34 +175,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Identity -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates the Identity of the dial-in conferencing configuration settings to be created. +Because these settings can only be created at the site scope, use syntax similar to this, with the prefix "site:" followed by the name of the site: `-Identity site:Redmond.` +Note that there can only be one set of dial-in conferencing configuration settings per site. +The sample command will fail if a collection of settings with the Identity site:Redmond already exists. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 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. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,14 +218,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PinAuthType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies which users are allowed to use PIN authentication. +Allowed values are: + +Everyone + +OrganizerOnly ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -217,17 +241,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousPstnActivation -Specifies whether unauthenticated callers can start a meeting if they are the first person to join. -An unauthenticated caller is defined as a participant who joins a meeting over the phone and doesn't provide a PIN when joining the meeting. -$True to allow anonymous activation, otherwise $False. -The default is $False. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -236,19 +259,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinAuthType -Specifies which users are allowed to use PIN authentication. -Allowed values are: +### -WhatIf -Everyone +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -OrganizerOnly +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -262,13 +282,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsDialInConferencingConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingDtmfConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingDtmfConfiguration.md index 80d7835196..9ea7630918 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingDtmfConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDialInConferencingDtmfConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdialinconferencingdtmfconfiguration +schema: 2.0.0 +title: New-CsDialInConferencingDtmfConfiguration --- # New-CsDialInConferencingDtmfConfiguration @@ -67,7 +68,7 @@ To disable a command, set its value to Null ($Null). ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CSDialInConferencingDtmfConfiguration -Identity site:Redmond -MuteUnmuteCommand 4 -AudienceMuteCommand 6 ``` @@ -77,7 +78,7 @@ In this example, the MuteUnmuteCommand property is set to 4 and the AudienceMute -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CSDialInConferencingDtmfConfiguration -Identity site:Redmond -AdmitAll $Null ``` @@ -86,7 +87,7 @@ Example 2 creates a new set of DTMF configuration settings for the Redmond site. In this example, the AdmitAll property is disabled; that's done by using the AdmitAll parameter and setting the parameter value to null. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CSDialInConferencingDtmfConfiguration -Identity site:Redmond -InMemory @@ -110,32 +111,17 @@ The final command then uses the Set-CSDialInConferencingDtmfConfiguration cmdlet ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new collection of DTMF configuration settings. -Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". +### -AdmitAll -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdmitAll Indicates the key to be pressed in order to allow all the users in the lobby to immediately join the conference. The default value is 8. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,14 +131,16 @@ Accept wildcard characters: False ``` ### -AudienceMuteCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key a presenter can press to mute or unmute everyone else in the conference (that is, everyone other than the presenter will be muted or unmuted). The default key is 4. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +150,9 @@ Accept wildcard characters: False ``` ### -CommandCharacter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed at the beginning of a command. The default key is the asterisk (*). The only other allowed value is #. @@ -169,8 +160,7 @@ The only other allowed value is #. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,14 +170,34 @@ Accept wildcard characters: False ``` ### -EnableDisableAnnouncementsCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed to enable or disable announcements each time someone joins or leaves the conference. The default key is 9. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -197,14 +207,16 @@ Accept wildcard characters: False ``` ### -HelpCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed in order to privately play a description of all the DTMF commands. The default key is 1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,36 +225,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LockUnlockConferenceCommand -Indicates the key to be pressed to lock or unlock a conference. -If a conference is locked, then no new participants will be allowed to join that conference, at least not until the conference has been unlocked. -The default key is 7. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier to be assigned to the new collection of DTMF configuration settings. +Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MuteUnmuteCommand +### -InMemory -Indicates the key to be pressed to mute or unmute yourself; the same key is used to toggle back and forth between muting and unmuting. -The default key is 6. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,15 +265,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrivateRollCallCommand -Indicates the key to be pressed to privately play the name of each conference participant. -The default key is 3. +### -LockUnlockConferenceCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the key to be pressed to lock or unlock a conference. +If a conference is locked, then no new participants will be allowed to join that conference, at least not until the conference has been unlocked. +The default key is 7. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,14 +285,19 @@ 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. +### -MuteUnmuteCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the key to be pressed to mute or unmute yourself; the same key is used to toggle back and forth between muting and unmuting. +The default key is 6. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,18 +306,17 @@ 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-\. +### -OperatorLineUri +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Phone number that the dial-in conferencing auto-attendant will connect a PSTN user to any time that user presses *0 on their telephone keypad. +Pressing *0 is designed to connect dial-in conferencing users to operator assistance. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -304,14 +325,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PrivateRollCallCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the key to be pressed to privately play the name of each conference participant. +The default key is 3. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -321,13 +345,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -336,15 +362,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OperatorLineUri -Phone number that the dial-in conferencing auto-attendant will connect a PSTN user to any time that user presses *0 on their telephone keypad. -Pressing *0 is designed to connect dial-in conferencing users to operator assistance. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -358,13 +385,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsDialInConferencingDtmfConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/New-CsDialPlan.md similarity index 86% rename from skype/skype-ps/skype/New-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/New-CsDialPlan.md index aff1a6f077..594511a004 100644 --- a/skype/skype-ps/skype/New-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDialPlan -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdialplan +schema: 2.0.0 +title: New-CsDialPlan --- # New-CsDialPlan @@ -44,7 +45,7 @@ New normalization rules can be added to a dial plan by calling the New-CsVoiceNo ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsDialPlan -Identity RedmondDialPlan ``` @@ -54,7 +55,7 @@ The command shown in Example 1 creates a new dial plan with the Identity Redmond Dial plans created at the per-user scope can be directly assigned to users and groups.) All other properties of the dial plan will be assigned default values. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsDialPlan -Identity site:Redmond -SimpleName RedmondSiteDialPlan @@ -72,7 +73,7 @@ Multiple normalization rules can be applied to one dial plan, so each normalizat -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsDialPlan -Identity RedmondDialPlan -Description "Dial plan for Redmond users" ``` @@ -84,26 +85,46 @@ The command shown in Example 3 creates a new dial plan with the Identity Redmond ## PARAMETERS -### -Identity -A unique identifier designating the scope and name (site), the service role and FQDN, or the name (per user) to identify the dial plan. -For example, a site Identity would be entered in the format site:\, where sitename is the name of the site. -A dial plan at the service scope must be a Registrar or PSTN gateway service, where the Identity value is formatted like this: Registrar:Redmond.litwareinc.com. -A per-user Identity would be entered simply as a unique string value. +### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of this dial plan--what it's for, what type of user it applies to, or any other information that will be helpful in identifying the purpose of the dial plan. Maximum characters: 512 @@ -111,8 +132,7 @@ Maximum characters: 512 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +142,9 @@ Accept wildcard characters: False ``` ### -DialinConferencingRegion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the region associated with this dial plan. Specify a value for this parameter if the dial plan will be used for dial-in conferencing. This allows the correct access number to be assigned when the conference organizer sets up the conference. @@ -132,8 +155,7 @@ Maximum characters: 512 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +165,9 @@ Accept wildcard characters: False ``` ### -ExternalAccessPrefix + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number (or set of numbers) that designates the call as external to the organization. (For example, to dial an outside line, first press 9.) This prefix will be ignored by the normalization rules, although these rules will be applied to the rest of the number. @@ -156,8 +181,67 @@ Default: 9 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier designating the scope and name (site), the service role and FQDN, or the name (per user) to identify the dial plan. +For example, a site Identity would be entered in the format site:\, where sitename is the name of the site. +A dial plan at the service scope must be a Registrar or PSTN gateway service, where the Identity value is formatted like this: Registrar:Redmond.litwareinc.com. +A per-user Identity would be entered simply as a unique string value. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -168,6 +252,8 @@ Accept wildcard characters: False ### -NormalizationRules +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of normalization rules that are applied to this dial plan. While this list and these rules can be created directly with this cmdlet, we recommend that you create the normalization rules with the New-CsVoiceNormalizationRule cmdlet, which creates the rule and assigns it to the specified dial plan. @@ -185,8 +271,7 @@ You can create a new normalization rule by calling the New-CsVoiceNormalizationR ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +281,9 @@ Accept wildcard characters: False ``` ### -OptimizeDeviceDialing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Setting this parameter to True will apply the prefix in the ExternalAccessPrefix parameter to calls made outside the organization. This value can be set to True only if a value has been specified for the ExternalAccessPrefix parameter. @@ -204,8 +292,7 @@ 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 +Aliases: Required: False Position: Named @@ -216,6 +303,8 @@ Accept wildcard characters: False ### -SimpleName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A display name for the dial plan. This name must be unique among all dial plans within the Skype for Business Server deployment. @@ -235,8 +324,7 @@ The default for a per-user dial plan is the Identity of the dial plan. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,29 +334,15 @@ Accept wildcard characters: False ``` ### -State -This parameter is not used with this cmdlet. -```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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -City This parameter is not used with this cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,30 +351,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CountryCode -This parameter is not used with this cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses any confirmation prompts before making changes. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -309,50 +369,16 @@ 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-\. - - +### -WhatIf -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -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 @@ -366,12 +392,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile. ## NOTES diff --git a/skype/skype-ps/skype/New-CsEmergencyNumber.md b/skype/skype-ps/SkypeForBusiness/New-CsEmergencyNumber.md similarity index 86% rename from skype/skype-ps/skype/New-CsEmergencyNumber.md rename to skype/skype-ps/SkypeForBusiness/New-CsEmergencyNumber.md index f871386781..5d9149fd86 100644 --- a/skype/skype-ps/skype/New-CsEmergencyNumber.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsEmergencyNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csemergencynumber applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsEmergencyNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csemergencynumber +schema: 2.0.0 +title: New-CsEmergencyNumber --- # New-CsEmergencyNumber @@ -29,21 +30,21 @@ With the November 2016 Cumulative Update, the number of support emergency number ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> New-CsEmergencyNumber -DialString 911 ``` This example creates a new emergency number with dial string 911. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` PS C:\> New-CsEmergencyNumber -DialString 911 -DialMask 112 ``` This example creates a new emergency number with dial string 911 and single dial mask 112. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` PS C:\> New-CsEmergencyNumber -DialString 911 -DialMask 112;999 ``` @@ -53,13 +54,15 @@ This example creates an emergency number with multiple dial masks. ## PARAMETERS ### -DialMask + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + For each emergency number, you can specify zero or more emergency dial masks. A dial mask is a number that you want to translate into the value of the emergency dial number value when it is dialed. For example, assume you enter a value of 212 in this field and the emergency dial number field has a value of 911. When a user dials 212, the number will be translated to 911. This allows for alternate emergency numbers to be dialed and still have the call reach emergency services (for example, if someone from a country or region with a different emergency number attempts to dial that country or region's number rather than the number for the country or region they are currently in). You can define multiple emergency dial masks by separating the values with semicolons. For example, 212;414. The string limit for a dial mask is 100 characters. Each character must be a digit 0 through 9. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -DialString + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the phone number to call out with this emergency number. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -98,6 +103,6 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[New-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skype/new-cslocationpolicy?view=skype-ps) +[New-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cslocationpolicy?view=skype-ps) -[Set-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skype/set-cslocationpolicy?view=skype-ps) +[Set-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslocationpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/New-CsExUmContact.md similarity index 85% rename from skype/skype-ps/skype/New-CsExUmContact.md rename to skype/skype-ps/SkypeForBusiness/New-CsExUmContact.md index a9107cd958..2bc51dc65b 100644 --- a/skype/skype-ps/skype/New-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExUmContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsExUmContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csexumcontact +schema: 2.0.0 +title: New-CsExUmContact --- # New-CsExUmContact @@ -40,7 +41,7 @@ From the policies retrieved you can determine whether an appropriate global or s ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsExUmContact -SipAddress sip:exumsa1@fabrikam.com -RegistrarPool RedmondPool.litwareinc.com -OU "OU=ExUmContacts,DC=litwareinc,DC=com" -DisplayNumber 2065554567 ``` @@ -53,7 +54,7 @@ Because we didn't specifically set the AutoAttendant parameter, the default of F -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsExUmContact -SipAddress sip:exumaa1@fabrikam.com -RegistrarPool RedmondPool.litwareinc.com -OU "OU=ExUmContacts,DC=litwareinc,DC=com" -DisplayNumber 2065559876 -AutoAttendant $True ``` @@ -67,45 +68,42 @@ The difference in this example is that we set the optional parameter AutoAttenda ## PARAMETERS -### -SipAddress +### -AutoAttendant -The SIP address of the contact. -This must be a new address that does not already exist as a user or contact in Active Directory Domain Services. -This value must begin with the string sip: followed by the SIP address. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether this contact object is an Auto Attendant. +(Auto Attendant provides a set of voice prompts that allow callers to navigate the phone system and reach the intended party.) + +Default: False ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPool - - -The fully qualified domain name (FQDN) of the pool on which the Registrar service is running. - -Note that an Exchange UM contact in Skype for Business Server cannot be moved to pools that are part of Microsoft Office Communications Server 2007 or Microsoft Office Communications Server 2007 R2 deployments. - -Full data type: Microsoft.Rtc.Management.Deploy.Fqdn +### -Description +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A description of this contact. +The description is for use by administrators to identify the type of contact (Auto Attendant or Subscriber Access), the location, provider, or any other information that will identify the purpose of each Exchange UM contact. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -113,6 +111,9 @@ Accept wildcard characters: False ``` ### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The telephone number of the contact. Display numbers for each contact must be unique (for instance, no two Exchange UM contacts can have the same display number). @@ -122,8 +123,7 @@ The first digit cannot be zero. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -133,6 +133,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The organizational unit (OU) where this contact will be located in Active Directory. Full data type: Microsoft.Rtc.Management.AD.OUIdParameter @@ -140,8 +143,7 @@ Full data type: Microsoft.Rtc.Management.AD.OUIdParameter ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -150,20 +152,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoAttendant - -Specifies whether this contact object is an Auto Attendant. -(Auto Attendant provides a set of voice prompts that allow callers to navigate the phone system and reach the intended party.) - -Default: False +### -PassThru +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Returns the results of this command. +Running this cmdlet will display the newly created object; including this parameter will simply repeat that output, making the use of this parameter redundant. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,48 +171,63 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description of this contact. -The description is for use by administrators to identify the type of contact (Auto Attendant or Subscriber Access), the location, provider, or any other information that will identify the purpose of each Exchange UM contact. +### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + + +The fully qualified domain name (FQDN) of the pool on which the Registrar service is running. + +Note that an Exchange UM contact in Skype for Business Server cannot be moved to pools that are part of Microsoft Office Communications Server 2007 or Microsoft Office Communications Server 2007 R2 deployments. + +Full data type: Microsoft.Rtc.Management.Deploy.Fqdn + + ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns the results of this command. -Running this cmdlet will display the newly created object; including this parameter will simply repeat that output, making the use of this parameter redundant. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP address of the contact. +This must be a new address that does not already exist as a user or contact in Active Directory Domain Services. +This value must begin with the string sip: followed by the SIP address. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -222,14 +236,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -243,12 +259,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact Creates an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact. ## NOTES diff --git a/skype/skype-ps/skype/New-CsExtendedTest.md b/skype/skype-ps/SkypeForBusiness/New-CsExtendedTest.md similarity index 91% rename from skype/skype-ps/skype/New-CsExtendedTest.md rename to skype/skype-ps/SkypeForBusiness/New-CsExtendedTest.md index 0b33391159..00c3e2135d 100644 --- a/skype/skype-ps/skype/New-CsExtendedTest.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExtendedTest.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csextendedtest applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsExtendedTest -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csextendedtest +schema: 2.0.0 +title: New-CsExtendedTest --- # New-CsExtendedTest @@ -42,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsExtendedTest -TestUsers "sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com" -Name "PSTN Test" -TestType "PSTN" @@ -61,13 +62,15 @@ This is done by using the ExtendedTests parameter and the syntax @{Add=$x}. ## PARAMETERS ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Friendly name to be given to the extended test. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -TestType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of testing to be carried out by the extended test. Allowed values are: @@ -88,8 +94,7 @@ You can only specify a single TestType per extended test. ```yaml Type: TestType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -TestUsers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the user account(s) that will serve as test users. Multiple accounts can be specified by separating those accounts using commas; for example: @@ -109,8 +117,7 @@ You must specify at least two test users when using the PSTN TestType. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,13 +131,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsExtendedTest cmdlet does not accept pipelined input ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.ExtendedTest The New-CsExtendedTest cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.ExtendedTest object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsExternalAccessPolicy.md similarity index 82% rename from skype/skype-ps/skype/New-CsExternalAccessPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsExternalAccessPolicy.md index cee7711844..725ef00909 100644 --- a/skype/skype-ps/skype/New-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExternalAccessPolicy.md @@ -1,17 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csexternalaccesspolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsExternalAccessPolicy -schema: 2.0.0 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csexternalaccesspolicy +schema: 2.0.0 +title: New-CsExternalAccessPolicy --- # 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 +29,7 @@ For information about external access in Microsoft Teams, see [Manage external a ```powershell New-CsExternalAccessPolicy [-Tenant ] [-Description ] [-EnableFederationAccess ] [-EnableAcsFederationAccess ] - [-EnableXmppAccess ] [-EnablePublicCloudAccess ] - [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] [-EnableOutsideAccess ] [-Identity] + [-EnableXmppAccess ] [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] [-EnableOutsideAccess ] [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -51,7 +54,7 @@ This enables your users to use Skype for Business and log on to Skype for Busine 4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. -5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skype/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skypeforbusiness/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. @@ -67,7 +70,7 @@ The following parameters are not applicable to Skype for Business Online/Microso ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True -EnableOutsideAccess $True ``` @@ -75,7 +78,7 @@ New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $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 ------------------------ +### Example 2 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false @@ -83,7 +86,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederatio In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $True -EnableTeamsConsumerInbound $False ``` @@ -91,14 +94,12 @@ New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $Tr 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 -------------------------- +### EXAMPLE 4 ``` $x = New-CsExternalAccessPolicy -Identity RedmondAccessPolicy -InMemory $x.EnableFederationAccess = $True -$x.EnablePublicCloudAccess = $True - $x.EnableOutsideAccess = $True Set-CsExternalAccessPolicy -Instance $x @@ -108,55 +109,57 @@ 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. ## 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.` +### -Description -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. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: XdsIdentity +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: True -Position: 2 +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. +### -EnableAcsFederationAccess + +> Applicable: Microsoft Teams + +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: String +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 +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### -EnableFederationAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. @@ -165,7 +168,6 @@ The default value is True. 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 @@ -174,58 +176,59 @@ 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. +### -EnableOutsideAccess -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. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. -The default value is True. +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: True +Default value: None 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. +### -EnablePublicCloudAudioVideoAccess -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. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. -The default value is True. +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: -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 +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. +### -EnableTeamsConsumerAccess -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. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +(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](/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: Microsoft Teams Required: False Position: Named Default value: True @@ -233,33 +236,39 @@ 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. +### -EnableTeamsConsumerInbound + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who are using Teams with an account that's not managed by an organization can start the communication with the user. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - Required: False Position: Named -Default value: None +Default value: True 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. +### -EnableXmppAccess + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -268,15 +277,16 @@ 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. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +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 @@ -285,23 +295,36 @@ 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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: SwitchParameter +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: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -309,7 +332,6 @@ If you assign the output of this cmdlet called with this parameter to a variable 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 @@ -318,14 +340,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: SwitchParameter +Type: Guid 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 +Aliases: Required: False Position: Named @@ -335,13 +366,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -350,38 +383,16 @@ 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 -``` - -### -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: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -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` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -395,13 +406,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsExternalAccessPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. ### System.Object diff --git a/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsExternalUserCommunicationPolicy.md similarity index 88% rename from skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsExternalUserCommunicationPolicy.md index 728455d346..d8d8249f5d 100644 --- a/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExternalUserCommunicationPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy applicable: Skype for Business Online -title: New-CsExternalUserCommunicationPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csexternalusercommunicationpolicy +schema: 2.0.0 +title: New-CsExternalUserCommunicationPolicy --- # New-CsExternalUserCommunicationPolicy @@ -30,7 +32,7 @@ This cmdlet allows you to block P2P file transfer with Federated partners only. ## EXAMPLES -### Example 1 +### Example 1 ``` PS C:\> New-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer -EnableP2PFileTransfer $False ``` @@ -39,14 +41,13 @@ This example creates a new policy to block external file transfer. Then you can ## PARAMETERS -### -EnableP2PFileTransfer -Indicates whether file transfers to Federated partners are allowed. The default value is True. +### -AllowPresenceVisibility +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -55,7 +56,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFileTransfer +### -AllowTitleVisibility This parameter is reserved for internal Microsoft use. ```yaml @@ -70,7 +71,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPresenceVisibility +### -EnableFileTransfer This parameter is reserved for internal Microsoft use. ```yaml @@ -85,8 +86,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTitleVisibility -This parameter is reserved for internal Microsoft use. +### -EnableP2PFileTransfer + +> Applicable: Skype for Business Online + +Indicates whether file transfers to Federated partners are allowed. The default value is True. ```yaml Type: Boolean @@ -100,13 +104,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the 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: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -116,31 +120,18 @@ Accept wildcard characters: False ``` ### -Identity -Unique identifier for the external user communication policy to be created. -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +> Applicable: Skype for Business Online -Required: False -Position: 1 -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. +Unique identifier for the external user communication policy to be created. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -162,6 +153,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` @@ -175,8 +169,22 @@ If you are using a remote session of Windows PowerShell and are connected only t ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +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 @@ -186,13 +194,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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 @@ -215,10 +225,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) +[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csexternalusercommunicationpolicy?view=skype-ps) -[Get-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy?view=skype-ps) +[Get-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csexternalusercommunicationpolicy?view=skype-ps) -[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) +[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csexternalusercommunicationpolicy?view=skype-ps) -[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) +[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csexternalusercommunicationpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsFIPSConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsFIPSConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsFIPSConfiguration.md index 64a8204ef3..22fa7439d0 100644 --- a/skype/skype-ps/skype/New-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsFIPSConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsFIPSConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csfipsconfiguration +schema: 2.0.0 +title: New-CsFIPSConfiguration --- # New-CsFIPSConfiguration @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsFIPSConfiguration -Identity "global" -RequireFIPSCompliantMedia $False -InMemory @@ -65,35 +66,16 @@ Although this example works, it is easier to modify FIPS configuration settings ## PARAMETERS -### -Identity - -Unique identifier for the new collection of FIPS configuration settings. -Because Skype for Business Server only supports a single, global collection of FIPS settings, the only way you can use this parameter is to create a "new" global collection that exists only in memory. -You will also need to use the InMemory parameter in order to do that. - - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,31 +84,39 @@ 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. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new collection of FIPS configuration settings. +Because Skype for Business Server only supports a single, global collection of FIPS settings, the only way you can use this parameter is to create a "new" global collection that exists only in memory. +You will also need to use the InMemory parameter in order to do that. + + ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +127,8 @@ Accept wildcard characters: False ### -RequireFIPSCompliantMedia +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business Server will only allow media sessions with entities that use FIPS compliant algorithms for authentication and authorization. Note that, if you require FIPS compliance, then your users will no longer be able to connect to your system by using a Microsoft Lync Server 2010 A/V Edge server. @@ -149,8 +141,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +152,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new FIPS configuration settings are being created. For example: @@ -175,8 +168,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -186,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -206,13 +218,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsFIPSConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration The New-CsFIPSConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsFileTransferFilterConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsFileTransferFilterConfiguration.md index 166f9d2ba7..cd582f0fa2 100644 --- a/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsFileTransferFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsFileTransferFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csfiletransferfilterconfiguration +schema: 2.0.0 +title: New-CsFileTransferFilterConfiguration --- # New-CsFileTransferFilterConfiguration @@ -47,7 +48,7 @@ Likewise, you cannot create a new configuration for a site that already has one ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsFileTransferFilterConfiguration -Identity site:Redmond ``` @@ -57,7 +58,7 @@ Because no additional parameters were specified, the configuration will be creat -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions @{Add=".ps1"} ``` @@ -69,7 +70,7 @@ This new extension is added by using the Extensions parameter and the list modif -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions @{Replace=".vbs",".ps1"} @@ -81,7 +82,7 @@ This means that the complete set of file extensions will be replaced by the two In this case the only files blocked at the Redmond site will be .vbs and .ps1. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` New-CsFileTransferFilterConfiguration -Identity site:Redmond -Action "BlockAll" @@ -105,25 +106,10 @@ Note that this same task can be accomplished in one step with the following comm ## PARAMETERS -### -Identity -Unique identifier to be given to the file transfer filter configuration. -The Identity for the new configuration is simply the prefix "site:" followed by the site name. -For example, to create a new configuration for the Redmond site, you would use this syntax: `-Identity site:Redmond.` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Action -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Action Determines the action to be taken if file transfer filtering is enabled. If set to BlockAll then all file transfers will be prohibited, regardless of file extension. If set to Block (the default value) file transfers will be allowed unless the file extension appears as one of the prohibited file types listed in the Extensions property. @@ -133,8 +119,7 @@ To allow unrestricted file transfers (that is, to allow users to exchange any ty ```yaml Type: FileFilterAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +129,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables or disables file transfer filtering. If this parameter is set to True, files with the specified extensions (or all files, depending on the value of the Action property) cannot be transferred by a Skype for Business Server client. If this parameter is set to False, any file can be transferred. @@ -155,8 +143,7 @@ Default: True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +154,8 @@ Accept wildcard characters: False ### -Extensions +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + List of file extensions that will be blocked. If you attempt to use a Skype for Business Server client to transfer a file that has a file extension matching one of the extensions in this list, that transfer will be blocked and the file will not be transferred. This list is ignored if Action is set to BlockAll (all file transfers are blocked) or if Enabled is set to False (no file transfers are blocked). @@ -180,8 +169,7 @@ By default, the following file extensions are included in the Extensions propert ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,13 +179,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +Aliases: Required: False Position: Named @@ -206,8 +196,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier to be given to the file transfer filter configuration. +The Identity for the new configuration is simply the prefix "site:" followed by the site name. +For example, to create a new configuration for the Redmond site, you would use this syntax: `-Identity site:Redmond.` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -216,8 +228,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -226,14 +237,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -242,14 +255,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -263,12 +278,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration The New-CsFileTransferFilterConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/New-CsGroupPickupUserOrbit.md similarity index 86% rename from skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md rename to skype/skype-ps/SkypeForBusiness/New-CsGroupPickupUserOrbit.md index 2b89c659fb..490ee280df 100644 --- a/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsGroupPickupUserOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsGroupPickupUserOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csgrouppickupuserorbit +schema: 2.0.0 +title: New-CsGroupPickupUserOrbit --- # New-CsGroupPickupUserOrbit @@ -27,7 +28,7 @@ This cmdlet will throw an exception if the user is already assigned a group pick ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsGroupPickupUserOrbit -User sip:KenMyers@Contoso.com -Orbit "*100" ``` @@ -36,7 +37,7 @@ This example adds a user specified by the SIP address to the *100 orbit. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsGroupPickupUserOrbit "Ken Myers" -Orbit 2103 ``` @@ -49,18 +50,38 @@ The first parameter after the cmdlet is assumed to be the User parameter value. ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Orbit + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. -For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). +For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skypeforbusiness/New-CsCallParkOrbit). Values for the Orbit parameter must match the regular expression (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -70,6 +91,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the user whose group pickup orbit number will be assigned. Because User is a positional parameter, the -User syntax is not required. The first parameter after the cmdlet is assumed to be the User parameter value. @@ -81,7 +105,6 @@ You can also reference a user account by using the user's Active Directory disti Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -91,13 +114,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,30 +131,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,12 +154,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### System.String This cmdlet supports pipelined input from the Get-CsUser cmdlet. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit This cmdlet returns an instance of the Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsHealthMonitoringConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsHealthMonitoringConfiguration.md index 836ccad607..52bf89df98 100644 --- a/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHealthMonitoringConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsHealthMonitoringConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshealthmonitoringconfiguration +schema: 2.0.0 +title: New-CsHealthMonitoringConfiguration --- # New-CsHealthMonitoringConfiguration @@ -65,7 +66,7 @@ However, test users cannot be assigned to Office Communications Server pools. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsHealthMonitoringConfiguration -Identity atl-cs-001.litwareinc.com -FirstTestUserSipUri "sip:kenmyer@litwareinc.com" -SecondTestUserSipUri "sip:pilar@litwareinc.com" ``` @@ -75,7 +76,7 @@ These new settings will use sip:kenmyer@litwareinc.com and sip:pilar@litwareinc. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = Get-CsService -Registrar | Select-Object PoolFqdn @@ -98,46 +99,39 @@ Each collection is also assigned the same two test accounts: sip:kenmyer@litware ## PARAMETERS -### -Identity - -FQDN of the pool where the health monitoring configuration settings are to be assigned (for example: `-Identity atl-cs-001.litwareinc.com`). -Your command will fail if the specified pool already hosts a collection of health monitoring configuration settings. +### -FirstTestSamAccountName -The Identity is equivalent to the TargetFqdn parameter. -When creating a new collection of settings, you can use either parameter. -If you leave out both parameters, the New-CsHealthMonitoringConfiguration cmdlet will prompt you to enter the Identity. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +SamAccountName of the first test user. +The FirstTestSamAccountName must be entered by using the format domain\username; for example: +`-FirstTestSamAccountName litwareinc\kenmyer` ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn - -FQDN of the pool where the health monitoring configuration settings are to be assigned (for example: `-TargetFqdn atl-cs-001.litwareinc.com`). -Your command will fail if the specified pool already hosts a collection of health monitoring configuration settings. - -The TargetFqdn is equivalent to the Identity parameter. -When creating a new collection of settings, you can use either parameter. -If you leave out both parameters, the New-CsHealthMonitoringConfiguration cmdlet will prompt you to enter the Identity. +### -FirstTestUserSipUri +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +SIP address of the first test user to be configured for use by this collection of health monitoring settings. +Note that the SIP address must include the sip: prefix. +For example: `-FirstTestUserSipUri "sip:kenmyer@litwareinc.com".` ```yaml Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -146,17 +140,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FirstTestSamAccountName -SamAccountName of the first test user. -The FirstTestSamAccountName must be entered by using the format domain\username; for example: +### -Force -`-FirstTestSamAccountName litwareinc\kenmyer` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,18 +158,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FirstTestUserSipUri -SIP address of the first test user to be configured for use by this collection of health monitoring settings. -Note that the SIP address must include the sip: prefix. -For example: `-FirstTestUserSipUri "sip:kenmyer@litwareinc.com".` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the pool where the health monitoring configuration settings are to be assigned (for example: `-Identity atl-cs-001.litwareinc.com`). +Your command will fail if the specified pool already hosts a collection of health monitoring configuration settings. + +The Identity is equivalent to the TargetFqdn parameter. +When creating a new collection of settings, you can use either parameter. +If you leave out both parameters, the New-CsHealthMonitoringConfiguration cmdlet will prompt you to enter the Identity. + + ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -184,6 +205,9 @@ Accept wildcard characters: False ``` ### -SecondTestSamAccountName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SamAccountName of the second test user. The SecondTestSamAccountName must be entered by using the format domain\username; for example: @@ -192,8 +216,7 @@ The SecondTestSamAccountName must be entered by using the format domain\username ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,6 +226,9 @@ Accept wildcard characters: False ``` ### -SecondTestUserSipUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the second test user to be configured for use by this collection of health monitoring settings. Note that the SIP address must include the sip: prefix. For example: `-SecondTestUserSipUri "sip:pilar@litwareinc.com".` @@ -210,8 +236,7 @@ For example: `-SecondTestUserSipUri "sip:pilar@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 +Aliases: Required: True Position: Named @@ -220,50 +245,41 @@ 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. +### -TargetFqdn -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory +FQDN of the pool where the health monitoring configuration settings are to be assigned (for example: `-TargetFqdn atl-cs-001.litwareinc.com`). +Your command will fail if the specified pool already hosts a collection of health monitoring configuration settings. -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-\. +The TargetFqdn is equivalent to the Identity parameter. +When creating a new collection of settings, you can use either parameter. +If you leave out both parameters, the New-CsHealthMonitoringConfiguration cmdlet will prompt you to enter the Identity. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -272,14 +288,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -293,13 +311,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsHealthMonitoringConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings The New-CsHealthMonitoringConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsHostedVoicemailPolicy.md similarity index 86% rename from skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsHostedVoicemailPolicy.md index 31d525c270..903062e995 100644 --- a/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHostedVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsHostedVoicemailPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshostedvoicemailpolicy +schema: 2.0.0 +title: New-CsHostedVoicemailPolicy --- # New-CsHostedVoicemailPolicy @@ -44,7 +45,7 @@ Policies created at the per-user scope must be assigned to users or contact obje ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsHostedVoicemailPolicy -Identity ExRedmond -Destination ExUM.fabrikam.com -Description "Hosted voicemail policy for Redmond users." -Organization "corp1.litwareinc.com, corp2.litwareinc.com" ``` @@ -56,7 +57,7 @@ This policy is described as (has a Description parameter value of) "Hosted voice -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = New-CsHostedVoiceMailPolicy -Identity global -Tenant "73d355dd-ce5d-4ab9-bf49-7b822c18dd98" -Destination ExUM.fabrikam.com -Description "Hosted voicemail policy for Redmond users." -Organization "corp1.litwareinc.com, corp2.litwareinc.com" @@ -74,31 +75,16 @@ To create the new policy, the second command then calls the Set-CsHostedVoiceMai ## PARAMETERS -### -Identity -A unique identifier for the policy, which includes the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as RenoHostedVoicemail). -A global policy will always exist and can't be removed, so you cannot create a global policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A friendly description of the policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +95,8 @@ Accept wildcard characters: False ### -Destination +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value assigned to this parameter is the fully qualified domain name (FQDN) of the hosted Exchange UM service. Note that the chosen destination must be trusted for routing. @@ -121,8 +109,7 @@ This value must be 255 characters or less and in the form of an FQDN, such as se ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,18 +118,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Organization - -This parameter contains a comma-separated list of the Exchange tenants that contain Skype for Business Server users. -Each tenant must be specified as an FQDN of the tenant on the hosted Exchange Service. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,17 +136,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the policy, which includes the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as RenoHostedVoicemail). +A global policy will always exist and can't be removed, so you cannot create a global policy. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -169,6 +157,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -177,8 +167,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,14 +176,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Organization + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter contains a comma-separated list of the Exchange tenants that contain Skype for Business Server users. +Each tenant must be specified as an FQDN of the tenant on the hosted Exchange Service. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,14 +197,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new hosted voicemail policy is being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + + ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,24 +224,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Confirm -Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new hosted voicemail policy is being created. -For example: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +Prompts you for confirmation before executing the command. -You can return the tenant ID for each of your tenants by running this command: +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -`Get-CsTenant | Select-Object DisplayName, TenantID` +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: wi Required: False Position: Named @@ -250,12 +265,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy ## NOTES diff --git a/skype/skype-ps/skype/New-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsHostingProvider.md similarity index 87% rename from skype/skype-ps/skype/New-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/New-CsHostingProvider.md index ef1f878ccf..5b00236148 100644 --- a/skype/skype-ps/skype/New-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHostingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsHostingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshostingprovider +schema: 2.0.0 +title: New-CsHostingProvider --- # New-CsHostingProvider @@ -69,7 +70,7 @@ Note, too that you cannot federate with a hosting provider if your Edge Servers ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsHostingProvider -Identity Fabrikam.com -ProxyFqdn "proxyserver.fabrikam.com" -Enabled $True ``` @@ -79,7 +80,7 @@ In addition to specifying the Identity, the command also includes the other two If you leave out any of the required parameters, the New-CsHostingProvider cmdlet will prompt you to enter those values before continuing. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsHostingProvider -Identity Fabrikam.com -ProxyFqdn "proxyserver.fabrikam.com" -Enabled $True -HostsOCSUsers $True -EnabledSharedAddressSpace $True @@ -93,27 +94,31 @@ To create a split domain provider that hosts non-Skype for Business Server servi ## PARAMETERS -### -Identity -Unique identifier for the hosting provider to be created. -The Identity is a string value; the Identity might be the FQDN of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). +### -AutodiscoverUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the autodiscover service used by a hosting provider that hosts Skype for Business Server accounts. +The autodiscover service enables client applications to determine how to access resources such as a user's home pool. + -Hosting provider Identities must be unique. -Your command will fail if you try to create a new hosting provider with the same Identity as an existing provider. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the network connection between your domain and the hosting provider is enabled. Messages cannot be exchanged between the two organizations until this value is set to True. The default value is False. @@ -121,8 +126,7 @@ The default value is 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 +Aliases: Required: True Position: Named @@ -131,16 +135,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyFqdn -The FQDN for the proxy server used by the hosting provider. -Note that this value cannot be modified. -If the hosting provider later changes its proxy server or if you make a mistake when you first specify the proxy FQDN you will need to delete and then recreate the entry for that provider. +### -EnabledSharedAddressSpace + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, indicates that the hosting provider is being used in a split domain scenario. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -149,17 +154,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledSharedAddressSpace -If True, indicates that the hosting provider is being used in a split domain scenario. -The default value is False. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -168,6 +174,8 @@ Accept wildcard characters: False ### -HostsOCSUsers +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, indicates that the hosting provider is used to host Skype for Business Server accounts. If False, that indicates that the provider hosts other account types, such as Microsoft Exchange accounts. The default value is False. @@ -177,8 +185,7 @@ The default value is 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 +Aliases: Required: True Position: Named @@ -187,49 +194,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsLocal +### -Identity -If True, indicates that the proxy server used by the hosting provider is contained within your Skype for Business Server topology. -The default value is False. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier for the hosting provider to be created. +The Identity is a string value; the Identity might be the FQDN of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). +Hosting provider Identities must be unique. +Your command will fail if you try to create a new hosting provider with the same Identity as an existing provider. ```yaml -Type: Boolean +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VerificationLevel -Indicates the allowed verification level for messages sent to and from the hosted provider. -The VerificationLevel must be set to one of the following values: +### -InMemory -AlwaysVerifiable. -Indicates that all messages sent from the hosting provider are considered verifiable. -That means that no messages from the hosting provider will be rejected. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -AlwaysUnverifiable. -Indicates that all messages sent from the hosting provider are considered unverifiable. -As a result, messages are passed only if the user on the hosting provider is also in your Contacts list. +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-\. -UseSourceVerification. -Relies on the verification level included in messages sent from the hosting provider. -If this level is not specified, then the message will be rejected as being unverifiable. -The default value is AlwayVerifiable. ```yaml -Type: VerificationLevelType +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -238,14 +237,19 @@ 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. +### -IsLocal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, indicates that the proxy server used by the hosting provider is contained within your Skype for Business Server topology. +The default value is False. + + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -254,34 +258,40 @@ 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-\. +### -ProxyFqdn +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The FQDN for the proxy server used by the hosting provider. +Note that this value cannot be modified. +If the hosting provider later changes its proxy server or if you make a mistake when you first specify the proxy FQDN you will need to delete and then recreate the entry for that provider. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -SipClientPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used by the provider for communicating with SIP clients; the default value is 443. +Note that, by default, the SipClientPort is not displayed when you run the Get-CsHostingProvider cmdlet. +To see the SipClientPort, use a command similar to this: + +`Get-CsHostingProvider | Select-Object *` ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -290,14 +300,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -VerificationLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the allowed verification level for messages sent to and from the hosted provider. +The VerificationLevel must be set to one of the following values: + +AlwaysVerifiable. +Indicates that all messages sent from the hosting provider are considered verifiable. +That means that no messages from the hosting provider will be rejected. + +AlwaysUnverifiable. +Indicates that all messages sent from the hosting provider are considered unverifiable. +As a result, messages are passed only if the user on the hosting provider is also in your Contacts list. + +UseSourceVerification. +Relies on the verification level included in messages sent from the hosting provider. +If this level is not specified, then the message will be rejected as being unverifiable. + +The default value is AlwayVerifiable. ```yaml -Type: SwitchParameter +Type: VerificationLevelType Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -306,18 +333,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutodiscoverUrl - -URL for the autodiscover service used by a hosting provider that hosts Skype for Business Server accounts. -The autodiscover service enables client applications to determine how to access resources such as a user's home pool. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -326,18 +351,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipClientPort -Port used by the provider for communicating with SIP clients; the default value is 443. -Note that, by default, the SipClientPort is not displayed when you run the Get-CsHostingProvider cmdlet. -To see the SipClientPort, use a command similar to this: +### -WhatIf -`Get-CsHostingProvider | Select-Object *` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -351,13 +374,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsHostingProvider cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/New-CsHybridApplicationEndpoint.md similarity index 82% rename from skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/New-CsHybridApplicationEndpoint.md index 55b09cfd15..7128a5bd6e 100644 --- a/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHybridApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsHybridApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint +schema: 2.0.0 +title: New-CsHybridApplicationEndpoint --- # New-CsHybridApplicationEndpoint @@ -33,7 +34,7 @@ Hybrid connectivity between Skype for Business Server and Skype for Business Onl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> New-CsHybridApplicationEndpoint -ApplicationId 41ec7d50-ba91-1208-73ee-136b88859725 -DisplayName NewBot1 -SipAddress sip:newbot1@litwareinc.com -OU "ou=Redmond,dc=litwareinc,dc=com" ``` @@ -43,6 +44,9 @@ This example creates a hybrid application endpoint named NewBot1 in Skype for Bu ## PARAMETERS ### -ApplicationId + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The ApplicationId or Client Id for which the endpoint is being created. There are predefined values if you are creating an on-premises resource account for Skype for Business hybrid deployments: @@ -53,7 +57,6 @@ There are predefined values if you are creating an on-premises resource account Type: Guid Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -62,30 +65,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DisplayName -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DisplayName Friendly name for the application endpoint is being created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -95,13 +84,15 @@ Accept wildcard characters: False ``` ### -LineUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Valid phone number for the application endpoint is being created. (Not currently supported through BOT framework) ```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 @@ -111,13 +102,15 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Active Directory Organizational Unit (OU) for the disabled user to be created. Wait for the newly created user object to be directory synced to the Microsoft Entra ID or start a new directory sync cycle by running the [Start-ADSyncSyncCycle](https://learn.microsoft.com/azure/active-directory/connect/active-directory-aadconnectsync-feature-scheduler#start-the-scheduler) on the domain controller machine. ```yaml Type: OUIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -127,13 +120,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,13 +138,15 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The SipUri for the Endpoint. SIP Uri must be lowercase. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -158,14 +155,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -190,8 +207,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/New-CsHybridPSTNSite.md similarity index 90% rename from skype/skype-ps/skype/New-CsHybridPSTNSite.md rename to skype/skype-ps/SkypeForBusiness/New-CsHybridPSTNSite.md index 7bd818bd11..638495cc18 100644 --- a/skype/skype-ps/skype/New-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHybridPSTNSite.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cshybridpstnsite applicable: Skype for Business Online -title: New-CsHybridPSTNSite -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshybridpstnsite +schema: 2.0.0 +title: New-CsHybridPSTNSite --- # New-CsHybridPSTNSite @@ -35,7 +37,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsHybridPSTNSite -Identity "SeattlePSTN" -EdgeFQDN "Contoso.Denver.Edge.com" -BitsUpdateTimeWindow @{add="FirstWeekend","Night"} -OsUpdateTimeWindow @{add="Weekday"} ``` @@ -46,49 +48,16 @@ This example creates a new hybrid public switched telephone network (PSTN) site ## PARAMETERS -### -EdgeFQDN -Specifies the fully qualified domain name of the edge server. -For example: `-EdgeFQDN Contoso.Denver.Edge.com` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: `-Identity "SeattlePSTN".` -If the identity provided is not unique within the tenant, the cmdlet will fail. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +### -BitsUpdateTimeWindow -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -BitsUpdateTimeWindow Time window for updating Skype for Business Cloud Connector Edition bits on the appliance. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -97,14 +66,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -EdgeFQDN + +> Applicable: Skype for Business Online + +Specifies the fully qualified domain name of the edge server. +For example: `-EdgeFQDN Contoso.Denver.Edge.com` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -114,6 +86,9 @@ Accept wildcard characters: False ``` ### -EnableAutoUpdate + +> Applicable: Skype for Business Online + If set to $true, automatic updates will be turned on for the Skype for Business Cloud Connector Edition appliance. If set to $false, automatic updates will be turned off for the Skype for Business Cloud Connector Edition appliance. The default is $true. @@ -121,8 +96,7 @@ The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -132,6 +106,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + 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. @@ -139,8 +116,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 +Aliases: Required: False Position: Named @@ -149,14 +125,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the hybrid public switched telephone network (PSTN) site. +For example: `-Identity "SeattlePSTN".` +If the identity provided is not unique within the tenant, the cmdlet will fail. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -166,13 +164,15 @@ Accept wildcard characters: False ``` ### -OsUpdateTimeWindow + +> Applicable: Skype for Business Online + Time window for updating the operating system on the appliance. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -182,6 +182,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308".` @@ -194,8 +197,25 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -205,6 +225,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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. @@ -212,7 +235,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 Required: False Position: Named @@ -226,12 +248,11 @@ This cmdlet supports the common parameters:` -Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### HybridPstnSite The New-CsHybridPSTNSite cmdlet returns instances of the HybridPstnSite object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsImConfiguration.md similarity index 80% rename from skype/skype-ps/skype/New-CsImConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsImConfiguration.md index bff157c1c2..22bf9e2b05 100644 --- a/skype/skype-ps/skype/New-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsImConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsImConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimconfiguration +schema: 2.0.0 +title: New-CsImConfiguration --- # New-CsImConfiguration @@ -28,7 +29,7 @@ Use the New-CsImConfiguration cmdlet to create a new Instant Messaging (IM) conf ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsImConfiguration -Identity "Site:Redmond" -EnableOfflineIm $true ``` @@ -37,30 +38,16 @@ This example creates a new Instant Messaging (IM) configuration for the Redmond ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableOfflineIm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableOfflineIm Enables or disables Offline Instant Messaging. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -70,13 +57,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,13 +75,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier specifying the scope and, in some cases the name, of the IM configuration. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -102,13 +93,15 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,13 +111,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -134,13 +147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -163,8 +178,8 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsImFilterConfiguration.md similarity index 85% rename from skype/skype-ps/skype/New-CsImFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsImFilterConfiguration.md index 07c90a6de3..e0aecce531 100644 --- a/skype/skype-ps/skype/New-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsImFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csimfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsImFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimfilterconfiguration +schema: 2.0.0 +title: New-CsImFilterConfiguration --- # New-CsImFilterConfiguration @@ -40,7 +41,7 @@ Calling the New-CsImFilterConfiguration cmdlet with only an Identity specified w ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsImFilterConfiguration -Identity site:Redmond @@ -51,7 +52,7 @@ In Example 1, the New-CsImFilterConfiguration cmdlet is used to create a new IM -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsImFilterConfiguration -Identity site:Redmond -Prefixes @{add="rtsp:","urn:"} ``` @@ -61,7 +62,7 @@ Because the Prefixes parameter has been specified, the new configuration will co We add these prefixes by using the add list modifier to add these prefixes to the default list. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsImFilterConfiguration -Identity site:Redmond -Prefixes @{replace="rtsp:","urn:"} ``` @@ -75,27 +76,10 @@ Therefore, only URIs with prefixes of rtsp: or urn: will be filtered within inst ## PARAMETERS -### -Identity -A unique identifier specifying the scope of the IM filter configuration. -Global settings exist by default and cannot be re-created with the New-CsImFilterConfiguration cmdlet, but you can create site-level settings by specifying an Identity of site:\, where \ is the name of the site to which the settings will be applied (for example, site:Redmond). - -Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Action +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value of this parameter determines the action that will be taken when a hyperlink is included in an instant message: Allow - Hyperlinks are prefixed with an underscore so that the links are no longer active. @@ -116,8 +100,7 @@ Full Data Type: Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.UrlFil ```yaml Type: UrlFilterAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,14 +110,16 @@ Accept wildcard characters: False ``` ### -AllowMessage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If a value is specified for this parameter, that string is inserted at the beginning of each message containing hyperlinks when the value of the Action property is set to Allow. You can use this message to notify users of things such as the potential dangers of clicking unknown links, or your organization's relevant policies and requirements. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +129,9 @@ Accept wildcard characters: False ``` ### -BlockFileExtension + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If this parameter is set to True, a hyperlink that contains a file path with an extension specified by the Extensions property defined in the applicable file transfer filter configuration (retrieved by calling the Get-CsFileTransferFilterConfiguration cmdlet) is blocked and an error message is returned to the sender. If this parameter is set to False, no special check is made for file extensions. @@ -152,8 +140,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,6 +150,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables or disables this feature. If this parameter is set to True, instant messages will be scanned for hyperlinks and the rules in this configuration will be applied. If this parameter is set to False, messages will not be checked for hyperlinks. @@ -172,8 +162,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,17 +171,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreLocal -The value of this parameter controls whether filtering is performed on local Intranet URIs passed in instant messages.If this parameter is set to True, any URI that is defined in the Intranet zone of the local computer is ignored. -(The local computer is the Front End Server running the IM Filter application.) If this parameter is set to False, the specified filtering is applied to all hyperlinks. +### -Force -Default: True +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,34 +189,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Prefixes -The list of URI prefixes that will be filtered. -Any hyperlink included in an instant message with a prefix matching one of the prefixes in this list will be filtered according to the specified settings. +### -Identity -Default: callto:, file:, ftp., ftp:, gopher:, href, http:, https:, ldap:, mailto:, news:, nntp:, sip:, sips:, tel:, telnet:, www*. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier specifying the scope of the IM filter configuration. +Global settings exist by default and cannot be re-created with the New-CsImFilterConfiguration cmdlet, but you can create site-level settings by specifying an Identity of site:\, where \ is the name of the site to which the settings will be applied (for example, site:Redmond). + +Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity ```yaml -Type: PSListModifier +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WarnMessage -This parameter contains the warning message that is inserted at the beginning of each instant message that contains hyperlinks when the value of the Action property is set to Warn. -Typically this message would be used for such things as stating the potential dangers of clicking unknown links, or referring to your organization's relevant policies and requirements. +### -IgnoreLocal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The value of this parameter controls whether filtering is performed on local Intranet URIs passed in instant messages.If this parameter is set to True, any URI that is defined in the Intranet zone of the local computer is ignored. +(The local computer is the Front End Server running the IM Filter application.) If this parameter is set to False, the specified filtering is applied to all hyperlinks. + +Default: True ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +231,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -253,18 +252,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Prefixes -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The list of URI prefixes that will be filtered. +Any hyperlink included in an instant message with a prefix matching one of the prefixes in this list will be filtered according to the specified settings. +Default: callto:, file:, ftp., ftp:, gopher:, href, http:, https:, ldap:, mailto:, news:, nntp:, sip:, sips:, tel:, telnet:, www*. ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -273,14 +273,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -WarnMessage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter contains the warning message that is inserted at the beginning of each instant message that contains hyperlinks when the value of the Action property is set to Warn. +Typically this message would be used for such things as stating the potential dangers of clicking unknown links, or referring to your organization's relevant policies and requirements. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -290,13 +293,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -310,12 +333,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/New-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsImTranslationConfiguration.md similarity index 78% rename from skype/skype-ps/skype/New-CsImTranslationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsImTranslationConfiguration.md index 02129499f3..4f613cea18 100644 --- a/skype/skype-ps/skype/New-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsImTranslationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsImTranslationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimtranslationconfiguration +schema: 2.0.0 +title: New-CsImTranslationConfiguration --- # New-CsImTranslationConfiguration @@ -28,7 +29,7 @@ This cmdlet is reserved for internal Microsoft use. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` This cmdlet is reserved for internal Microsoft use. @@ -39,30 +40,16 @@ This cmdlet is reserved for internal Microsoft use. ## PARAMETERS -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -AccessTokenUri -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -AccessTokenUri This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -72,13 +59,15 @@ Accept wildcard characters: False ``` ### -ApplicationId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,13 +77,15 @@ Accept wildcard characters: False ``` ### -ClientId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,13 +95,15 @@ Accept wildcard characters: False ``` ### -ClientSecret + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,14 +112,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,30 +130,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -168,13 +167,15 @@ Accept wildcard characters: False ``` ### -ServiceUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,13 +185,33 @@ Accept wildcard characters: False ``` ### -TranslationType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -200,13 +221,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsIssuedCertId.md b/skype/skype-ps/SkypeForBusiness/New-CsIssuedCertId.md similarity index 92% rename from skype/skype-ps/skype/New-CsIssuedCertId.md rename to skype/skype-ps/SkypeForBusiness/New-CsIssuedCertId.md index 0303d409ac..8de607e56e 100644 --- a/skype/skype-ps/skype/New-CsIssuedCertId.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsIssuedCertId.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csissuedcertid applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsIssuedCertId -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csissuedcertid +schema: 2.0.0 +title: New-CsIssuedCertId --- # New-CsIssuedCertId @@ -61,7 +62,7 @@ You do not need to use the New-CsIssuedCertId cmdlet if you create a static rout ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $cert = New-CsIssuedCertId -Issuer "Fabrikam" -SerialNumber 0x10,0x14,0x3A,0x1A @@ -81,13 +82,15 @@ To ensure that this object uses the Fabrikam-issued certificate for authenticati ## PARAMETERS ### -Issuer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the certification authority (CA) that issued the certificate to be used in the static route. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -SerialNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Serial number of the certificate to be used in the static route. Serial numbers must be passed as a byte array. This means you must pass the serial number as an array of two-character values, with each of these two-character values prefaced by 0x. @@ -105,8 +111,7 @@ For example: `-SerialNumber 0x01, 0x23, 0x45, 0x67, 0x89.` ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -120,13 +125,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsIssuedCertId does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.BaseTypes.IssuedCertId New-CsIssuedCertId creates instances of the Microsoft.Rtc.Management.WritableConfig.BaseTypes.IssuedCertId object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsKerberosAccount.md b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccount.md similarity index 86% rename from skype/skype-ps/skype/New-CsKerberosAccount.md rename to skype/skype-ps/SkypeForBusiness/New-CsKerberosAccount.md index 85ed0abd14..bc296cbff5 100644 --- a/skype/skype-ps/skype/New-CsKerberosAccount.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccount.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cskerberosaccount applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsKerberosAccount -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cskerberosaccount +schema: 2.0.0 +title: New-CsKerberosAccount --- # New-CsKerberosAccount @@ -43,7 +44,7 @@ SPNs provide a way for client applications to locate a particular service. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsKerberosAccount -UserAccount "litwareinc\kerberostest" -ContainerDN "cn=Computers,dc=litwareinc,dc=com" @@ -65,6 +66,8 @@ After you make the new account assignment, the final command calls the Enable-Cs ### -ContainerDN +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name of the Active Directory container where the new account is to be created. For example: `-ContainerDN "ou=Finance,dc=litwareinc,dc=com".` If this parameter is not specified, then the New-CsKerberosAccount cmdlet will create the new account in the Computers container in Active Directory. @@ -74,8 +77,7 @@ If this parameter is not specified, then the New-CsKerberosAccount cmdlet will c ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -84,37 +86,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAccount - -Account name for the new account, using the format domain_name\user_name. -For example: `-UserAccount "litwareinc\kerberostest".` -Note that your command will fail if the specified account already exists. - -Note, too that, despite the name UserAccount, the account created by running the New-CsKerberosAccount cmdlet is actually a computer account, not a user account. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +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 occur when running the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\KerberosAccount.html".` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,31 +123,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\KerberosAccount.html".` +### -UserAccount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Account name for the new account, using the format domain_name\user_name. +For example: `-UserAccount "litwareinc\kerberostest".` +Note that your command will fail if the specified account already exists. + +Note, too that, despite the name UserAccount, the account created by running the New-CsKerberosAccount cmdlet is actually a computer account, not a user account. + + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -156,14 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -177,13 +188,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsKerberosAccount cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccount The New-CsKerberosAccount cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccount object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccountAssignment.md similarity index 86% rename from skype/skype-ps/skype/New-CsKerberosAccountAssignment.md rename to skype/skype-ps/SkypeForBusiness/New-CsKerberosAccountAssignment.md index d02844a752..5cbc13c650 100644 --- a/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccountAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsKerberosAccountAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cskerberosaccountassignment +schema: 2.0.0 +title: New-CsKerberosAccountAssignment --- # New-CsKerberosAccountAssignment @@ -45,7 +46,7 @@ To change a site that is already associated with a Kerberos account, use the Set ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsKerberosAccountAssignment -UserAccount "litwareinc\kerberostest" -Identity "site:Redmond" @@ -60,54 +61,56 @@ The second command then calls the Enable-CsTopology cmdlet in order to create th ## PARAMETERS -### -Identity -Unique identifier of the site where the Kerberos account is to be assigned. -(This is the Identity of the site, not of the computer account.) For example: `-Identity "site:Redmond".` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAccount - -Account name for the account to be assigned, using the format domain_name\user_name. -For example: `-UserAccount "litwareinc\kerberostest".` -The user name portion of the account (kerberostest) is a NETBIOS name and can contain a maximum of 15 characters. - -Note that, despite the name UserAccount, the account is actually a computer account, not a user account. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier of the site where the Kerberos account is to be assigned. +(This is the Identity of the site, not of the computer account.) For example: `-Identity "site:Redmond".` ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None 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. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,18 +119,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -UserAccount -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Account name for the account to be assigned, using the format domain_name\user_name. +For example: `-UserAccount "litwareinc\kerberostest".` +The user name portion of the account (kerberostest) is a NETBIOS name and can contain a maximum of 15 characters. + +Note that, despite the name UserAccount, the account is actually a computer account, not a user account. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,14 +143,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -152,14 +161,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -173,13 +184,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsKerberosAccountAssignment cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment The New-CsKerberosAccountAssignment cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsLocationPolicy.md similarity index 87% rename from skype/skype-ps/skype/New-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsLocationPolicy.md index bea3233f4e..e35f93eed7 100644 --- a/skype/skype-ps/skype/New-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cslocationpolicy +schema: 2.0.0 +title: New-CsLocationPolicy --- # New-CsLocationPolicy @@ -52,7 +53,7 @@ If the user calls from a location that is unknown or unmapped in the organizatio ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsLocationPolicy -Identity site:Redmond -EnhancedEmergencyServicesEnabled $True ``` @@ -60,7 +61,7 @@ New-CsLocationPolicy -Identity site:Redmond -EnhancedEmergencyServicesEnabled $T Example 1 uses the New-CsLocationPolicy cmdlet to create a new location policy for the Redmond site that enables all users on that site for E9-1-1. To create this policy, the New-CsLocationPolicy cmdlet is called along with two parameters: one to set the Identity, which in this case is the string site: followed by the name of the site to which this policy will apply; the other to set the value of the EnhancedEmergencyServicesEnabled property to True. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsLocationPolicy -Identity Reno -Description "All users located at the Reno site" -EnhancedEmergencyServicesEnabled $True -PstnUsage Emergency -EmergencyDialString 911 ``` @@ -78,31 +79,10 @@ This value must match a value in the list of PSTN usages. ## PARAMETERS -### -Identity - -A unique identifier for the location policy. -This cmdlet can be used to create policies at the site or per-user scope. -(A global policy exists by default and cannot be removed.) For a policy created at the site scope, this value must be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment. -For example, site:Redmond. -A policy created at the per-user scope can be assigned any string value, such as Reno. - - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ConferenceMode +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If a value is specified for the ConferenceUri parameter, the ConferenceMode parameter determines whether a third party can participate in the call or can only listen in. Available values are: @@ -115,8 +95,7 @@ Twoway: Third party can listen in and participate in the call between the caller ```yaml Type: ConferenceModeEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +105,9 @@ Accept wildcard characters: False ``` ### -ConferenceUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The SIP Uniform Resource Identifier (URI), in this case the telephone number, of a third party that will be conferenced in to any emergency calls that are made. For example, the company security office could receive a call when an emergency call is made and listen in or participate in that call (depending on the value of the ConferenceMode property). @@ -134,8 +116,7 @@ The string must be from 1 to 256 characters in length and must begin with the pr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,14 +126,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A detailed description of this location. For example, "Reno corporate users". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +145,9 @@ Accept wildcard characters: False ``` ### -EmergencyDialMask + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number that is dialed that will be translated into the value of the EmergencyDialString property. For example, if EmergencyDialMask has a value of "212" and EmergencyDialString has a value of "911", if a user dials 212 the call will be made to 911. This allows for alternate emergency numbers to be dialed and still have the call reach emergency services (for example, if someone from a country/region with a different emergency number attempts to dial that country/region's number rather than the number for the country/region they're currently in). @@ -179,8 +165,7 @@ Each character must be a digit 0 through 9. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +175,9 @@ Accept wildcard characters: False ``` ### -EmergencyDialString + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number that is dialed to reach emergency services. In the United States this value is 911. @@ -198,8 +186,7 @@ The string must be made of the digits 0 through 9 and can be from 1 to 10 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 +Aliases: Required: False Position: Named @@ -208,20 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnhancedEmergencyServicesEnabled - -Specifies whether the users associated with this policy are enabled for E9-1-1. -Set the value to True to enable E9-1-1 so Skype for Business Server clients will retrieve location information on registration and include that information when an emergency call is made. - -Default Value: False +### -EmergencyNumbers +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +{{Fill EmergencyNumbers Description}} ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,25 +213,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationRequired +### -EnhancedEmergencyServiceDisclaimer -If the client was unable to retrieve a location from the location configuration database, the user can be prompted to manually enter a location. -This parameter accepts the following values: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -- no: The user will not be prompted for a location. When a call is made with no location information, the Emergency Service Provider will answer the call and ask for a location. -- yes: The user will be prompted to input location information when the client registers at a new location. The user can dismiss the prompt without entering any information. If information is entered, a call made to 911 will first be answered by the Emergency Service Provider to verify the location before being routed to the PSAP operator (the 911 operator). -- disclaimer: This option is the same as yes except that if the user dismisses the prompt disclaimer text will be displayed that can alert the user to the consequences of declining to enter location information. (The disclaimer text must be set by calling the Set-CsEnhancedEmergencyServiceDisclaimer cmdlet.) +Text value containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. +To remove a service disclaimer from a location policy set this property to a null value: -This value is ignored if EnhancedEmergencyServicesEnabled is set to False (the default). -Users will not be prompted for location information. +`-EnhancedEmergencyServiceDisclaimer $Null` + +Location policies, and the EnhancedEmergencyServiceDisclaimer property, should be used in Skype for Business Server to set disclaimers for the E9-1-1 service. +By using location policies to set these disclaimers, you can create different disclaimers for different locales or different sets of users. ```yaml -Type: LocationRequiredEnum +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,25 +239,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationUri +### -EnhancedEmergencyServicesEnabled -One or more SIP URIs to be notified when an emergency call is made. -For example, the company security office could be notified through an instant message whenever an emergency call is made. -If the caller's location is available that location will be included in the notification. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Multiple SIP URIs can be included as a comma-separated list. -For example, `-NotificationUri sip:security@litwareinc.com,sip:kmyer@litwareinc.com.` -Note that distribution lists can be configured as a notification URI. +Specifies whether the users associated with this policy are enabled for E9-1-1. +Set the value to True to enable E9-1-1 so Skype for Business Server clients will retrieve location information on registration and include that information when an emergency call is made. -The string must be from 1 to 256 characters in length and must begin with the prefix sip:. +Default Value: False ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,19 +262,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsage -The public switched telephone network (PSTN) usage that will be used to determine which voice route will be used to route emergency calls from clients using this profile. -The route associated with this usage should point to a SIP trunk dedicated to emergency calls. +### -Force -The usage must already exist in the global list of PSTN usages. -Call the Get-CsPstnUsage cmdlet to retrieve a list of usages. -To create a new usage, call the Set-CsPstnUsage cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -305,37 +280,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseLocationForE911Only - -Location information can be used by the Skype for Business Server client for various reasons (such as notifying teammates of current location). -Set this value to True to ensure location information is available only for use with an emergency call. - +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A unique identifier for the location policy. +This cmdlet can be used to create policies at the site or per-user scope. +(A global policy exists by default and cannot be removed.) For a policy created at the site scope, this value must be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment. +For example, site:Redmond. +A policy created at the per-user scope can be assigned any string value, such as Reno. -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 +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -343,6 +306,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -351,8 +316,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -361,14 +325,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LocationRefreshInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in hours) between client requests for Location Information service location update. +The LocationRefreshInterval can be set to any value between 1 and 12; the default value is 4. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -377,14 +344,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -LocationRequired + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If the client was unable to retrieve a location from the location configuration database, the user can be prompted to manually enter a location. +This parameter accepts the following values: + +- no: The user will not be prompted for a location. When a call is made with no location information, the Emergency Service Provider will answer the call and ask for a location. +- yes: The user will be prompted to input location information when the client registers at a new location. The user can dismiss the prompt without entering any information. If information is entered, a call made to 911 will first be answered by the Emergency Service Provider to verify the location before being routed to the PSAP operator (the 911 operator). +- disclaimer: This option is the same as yes except that if the user dismisses the prompt disclaimer text will be displayed that can alert the user to the consequences of declining to enter location information. (The disclaimer text must be set by calling the Set-CsEnhancedEmergencyServiceDisclaimer cmdlet.) + +This value is ignored if EnhancedEmergencyServicesEnabled is set to False (the default). +Users will not be prompted for location information. + + ```yaml -Type: SwitchParameter +Type: LocationRequiredEnum Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -393,23 +372,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnhancedEmergencyServiceDisclaimer +### -NotificationUri -Text value containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. -To remove a service disclaimer from a location policy set this property to a null value: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-EnhancedEmergencyServiceDisclaimer $Null` +One or more SIP URIs to be notified when an emergency call is made. +For example, the company security office could be notified through an instant message whenever an emergency call is made. +If the caller's location is available that location will be included in the notification. -Location policies, and the EnhancedEmergencyServiceDisclaimer property, should be used in Skype for Business Server to set disclaimers for the E9-1-1 service. -By using location policies to set these disclaimers, you can create different disclaimers for different locales or different sets of users. +Multiple SIP URIs can be included as a comma-separated list. +For example, `-NotificationUri sip:security@litwareinc.com,sip:kmyer@litwareinc.com.` +Note that distribution lists can be configured as a notification URI. + +The string must be from 1 to 256 characters in length and must begin with the prefix sip:. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -418,15 +400,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationRefreshInterval -Specifies the amount of time (in hours) between client requests for Location Information service location update. -The LocationRefreshInterval can be set to any value between 1 and 12; the default value is 4. +### -PstnUsage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The public switched telephone network (PSTN) usage that will be used to determine which voice route will be used to route emergency calls from clients using this profile. +The route associated with this usage should point to a SIP trunk dedicated to emergency calls. + +The usage must already exist in the global list of PSTN usages. +Call the Get-CsPstnUsage cmdlet to retrieve a list of usages. +To create a new usage, call the Set-CsPstnUsage cmdlet. ```yaml -Type: Int64 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -436,6 +424,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new location policy is being created. For example: @@ -448,8 +439,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -458,14 +448,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmergencyNumbers -{{Fill EmergencyNumbers Description}} +### -UseLocationForE911Only + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Location information can be used by the Skype for Business Server client for various reasons (such as notifying teammates of current location). +Set this value to True to ensure location information is available only for use with an emergency call. + + ```yaml -Type: PSListModifier +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -479,12 +510,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy Creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy. ## NOTES diff --git a/skype/skype-ps/skype/New-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsMcxConfiguration.md similarity index 90% rename from skype/skype-ps/skype/New-CsMcxConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsMcxConfiguration.md index 58a5312e5f..1afda57100 100644 --- a/skype/skype-ps/skype/New-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMcxConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csmcxconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsMcxConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csmcxconfiguration +schema: 2.0.0 +title: New-CsMcxConfiguration --- # New-CsMcxConfiguration @@ -45,7 +46,7 @@ When you install Skype for Business Server, a single collection of Mobility Serv ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsMcxConfiguration -Identity "site:Redmond" -ExposedWebURL Internal -SessionShortExpirationInterval 7200 @@ -55,7 +56,7 @@ In Example 1, a new collection of Mobility Service configuration settings is cre In this example, two changes are made to the default Mobility Service configuration settings: the ExposedWebURL property is to Internal, and the SessionShortExpirationInterval property is set to 7200 seconds. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsService -WebServer | ForEach-Object {New-CsMcxConfiguration -Identity $_.Identity -ExposedWebURL Internal -SessionShortExpirationInterval 7200} @@ -67,7 +68,7 @@ In turn, the ForEach-Object cmdlet takes each server in the collection and runs -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CsMcxConfiguration -Identity "site:Redmond" -InMemory @@ -90,38 +91,37 @@ Note that if you do not call the Set-CsMcxConfiguration cmdlet, no settings will ## PARAMETERS -### -Identity -Unique identifier of the collection of Mobility Service configuration settings to be created. -To create settings at the site scope, use the prefix "site:" followed by the site name. -For example: +### -ExposedWebURL -`-Identity "site:Redmond"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To create settings configured at the service scope, use syntax like this: +Indicates whether the URL used by the Autodiscovery Service is accessible to users both inside and outside the organization firewall (External) or only accessible to users inside the firewall (Internal). -`-Identity service:WebServer:atl-cs-001.litwareinc.com` +Allowed values are: Internal or External. +The default value is External. ```yaml -Type: XdsIdentity +Type: ExposedWebURL Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,50 +130,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExposedWebURL -Indicates whether the URL used by the Autodiscovery Service is accessible to users both inside and outside the organization firewall (External) or only accessible to users inside the firewall (Internal). +### -Identity -Allowed values are: Internal or External. -The default value is External. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: ExposedWebURL -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier of the collection of Mobility Service configuration settings to be created. +To create settings at the site scope, use the prefix "site:" followed by the site name. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Identity "site:Redmond"` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +To create settings configured at the service scope, use syntax like this: + +`-Identity service:WebServer:atl-cs-001.litwareinc.com` ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of a command 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +176,9 @@ Accept wildcard characters: False ``` ### -PushNotificationProxyUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URI of a service provider that can forward push notification requests to the Apple Push Notification Service and the Microsoft Push Notification Service. The PushNotificationProxyUri must be in the form of a SIP address; for example: @@ -191,8 +187,7 @@ The PushNotificationProxyUri must be in the form of a SIP address; for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,6 +198,8 @@ Accept wildcard characters: False ### -SessionExpirationInterval +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Length of time, in seconds, of a mobile session for iPhone or Windows Phone users. If Skype for Business is running in the background on these phones, users will receive push notifications as long as the session expiration interval has not expired. @@ -218,8 +215,7 @@ Note that the value of the SessionExpirationInterval property must be greater th ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,6 +226,8 @@ Accept wildcard characters: False ### -SessionShortExpirationInterval +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Length of time, in seconds, of a mobile session for Android or Nokia phone users. The mobile device must send a notice to the server indicating that the device is still active before the session timeout is reached. @@ -244,8 +242,25 @@ Note that the value of the SessionExpirationInterval property must be greater th ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -255,13 +270,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -275,13 +292,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsMcxConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsMediaConfiguration.md similarity index 84% rename from skype/skype-ps/skype/New-CsMediaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsMediaConfiguration.md index b90eef34a2..0ac8357ad0 100644 --- a/skype/skype-ps/skype/New-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMediaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsMediaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csmediaconfiguration +schema: 2.0.0 +title: New-CsMediaConfiguration --- # New-CsMediaConfiguration @@ -38,7 +39,7 @@ This cmdlet creates a new collection of settings that define the behavior of spe ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsMediaConfiguration -Identity site:Redmond1 -EncryptionLevel RequireEncryption ``` @@ -49,7 +50,7 @@ That requirement is put in place by adding the EncryptionLevel parameter and set -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsMediaConfiguration -Identity MediationServer:pool0.litwareinc.com -EnableSiren $True ``` @@ -61,60 +62,55 @@ This new configuration will have an EnableSiren value of True, which means that ## PARAMETERS -### -Identity - -A unique identifier specifying the scope at which this configuration is applied (site or service). -A configuration at the site scope would be entered as site:\, such as site:Redmond. -A service would be entered as \:\, such as MediationServer:pool0.litwareinc.com. -A media configuration at the global scope will always exist and cannot be removed, so a new global configuration cannot be created. - -Media configurations created at the service scope can be created for only the A/V Conferencing service, Mediation Server, and Application Server. +### -EnableAdaptiveBandWidthEstimation +> Applicable: Lync Server 2013 +When set to True (the default value) Microsoft Lync Server will select the bandwidth rate at which to play a video stream. +This selection will be based on such factors as the network congestion and the client's quality of the client's current network connection. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableQoS -QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings. +### -EnableG722StereoCodec + +> Applicable: Lync Server 2013 + +When set to True (the default value) allows the use of the G.722 wideband speech codec. +G.722 is a standard voice codec commonly used with Voice over IP applications; with a sampling rate of 16 KHz G.722 provides higher voice quality and clarity than many other commonly-used speech codecs. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSiren - -By default, the Mediation Server does not negotiate Siren as a possible codec for calls between itself and clients. -If this setting is True, Siren will be included as a possible codec for use between the Mediation Server and other clients. - -Default: False +### -EnableH264Codec +> Applicable: Lync Server 2013 +When set to True (the default value) allows the use of the H.264/MPEG-4 AVC video codec. +H.264 is a standard codec commonly used for recording, compressing, and distributing high-definition video. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,26 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptionLevel -The level of encryption between unified communications devices. - -Valid values: - -SupportEncryption - secure real-time transport protocol (SRTP) will be used if it can be negotiated. - -RequireEncryption - SRTP must be negotiated. - -DoNotSupportEncryption - SRTP must not be used. - -Default: RequireEncryption +### -EnableInCallQoS +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages. ```yaml -Type: EncryptionLevel +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,42 +137,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxVideoRateAllowed -The maximum rate at which video signals will be transferred at the client endpoints. - -Valid values: Hd720p15M, VGA600K, CIF250K - -Hd720p15M - High definition, with a resolution of 1280 x 720 and aspect ratio 16:9. - -VGA600K - VGA, with a resolution of 640 x 480, 25 fps with the aspect ratio 4:3. - -CIF250K - Common Intermediate Format (CIF) video format, 15 fps with a resolution of 352 x 288. +### -EnableQoS -Note that these values are not case sensitive; values will be converted to appropriate casing when the configuration is created. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: VGA600K +QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings. ```yaml -Type: MaxVideoRateAllowed +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -EnableRtpRtcpMultiplexing + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables or disables the use of RTP/RTCP Multiplexing, if enabled, when negotiating, only one candidate will be used for both RTP and RTCP. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,17 +173,21 @@ 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-\. +### -EnableSiren + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +By default, the Mediation Server does not negotiate Siren as a possible codec for calls between itself and clients. +If this setting is True, Siren will be included as a possible codec for use between the Mediation Server and other clients. + +Default: False ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -214,14 +196,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -EnableVideoBasedSharing + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,14 +214,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EncryptionLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The level of encryption between unified communications devices. + +Valid values: + +SupportEncryption - secure real-time transport protocol (SRTP) will be used if it can be negotiated. + +RequireEncryption - SRTP must be negotiated. + +DoNotSupportEncryption - SRTP must not be used. + +Default: RequireEncryption + + ```yaml -Type: SwitchParameter +Type: EncryptionLevel Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,15 +244,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAdaptiveBandWidthEstimation -When set to True (the default value) Microsoft Lync Server will select the bandwidth rate at which to play a video stream. -This selection will be based on such factors as the network congestion and the client's quality of the client's current network connection. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -263,32 +262,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableG722StereoCodec -When set to True (the default value) allows the use of the G.722 wideband speech codec. -G.722 is a standard voice codec commonly used with Voice over IP applications; with a sampling rate of 16 KHz G.722 provides higher voice quality and clarity than many other commonly-used speech codecs. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier specifying the scope at which this configuration is applied (site or service). +A configuration at the site scope would be entered as site:\, such as site:Redmond. +A service would be entered as \:\, such as MediationServer:pool0.litwareinc.com. +A media configuration at the global scope will always exist and cannot be removed, so a new global configuration cannot be created. + +Media configurations created at the service scope can be created for only the A/V Conferencing service, Mediation Server, and Application Server. + + ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableH264Codec -When set to True (the default value) allows the use of the H.264/MPEG-4 AVC video codec. -H.264 is a standard codec commonly used for recording, compressing, and distributing high-definition video. +### -InCallQoSIntervalSeconds + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the interval between call QoS actions. ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -297,14 +305,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableInCallQoS -Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -313,14 +326,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRtpRtcpMultiplexing -Enables or disables the use of RTP/RTCP Multiplexing, if enabled, when negotiating, only one candidate will be used for both RTP and RTCP. +### -MaxVideoRateAllowed + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum rate at which video signals will be transferred at the client endpoints. + +Valid values: Hd720p15M, VGA600K, CIF250K + +Hd720p15M - High definition, with a resolution of 1280 x 720 and aspect ratio 16:9. + +VGA600K - VGA, with a resolution of 640 x 480, 25 fps with the aspect ratio 4:3. + +CIF250K - Common Intermediate Format (CIF) video format, 15 fps with a resolution of 352 x 288. + +Note that these values are not case sensitive; values will be converted to appropriate casing when the configuration is created. + +Default: VGA600K ```yaml -Type: Boolean +Type: MaxVideoRateAllowed Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -329,14 +356,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InCallQoSIntervalSeconds -Specifies the interval between call QoS actions. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -345,14 +374,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVideoBasedSharing -Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -366,12 +397,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings. ## NOTES diff --git a/skype/skype-ps/skype/New-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsMeetingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsMeetingConfiguration.md index 77faa8bbc2..dd15560ce8 100644 --- a/skype/skype-ps/skype/New-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMeetingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csmeetingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsMeetingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csmeetingconfiguration +schema: 2.0.0 +title: New-CsMeetingConfiguration --- # New-CsMeetingConfiguration @@ -53,7 +54,7 @@ If you try to create new settings for the Redmond site, and the Redmond site alr ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsMeetingConfiguration -Identity site:Redmond -EnableAssignedConferenceType $False -AssignedConferenceTypeByDefault $False -AdmitAnonymousUsersByDefault $False ``` @@ -68,7 +69,7 @@ That's because only one collection of meeting configuration settings can be appl -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsMeetingConfiguration -Identity site:Redmond -InMemory @@ -96,41 +97,39 @@ Instead, your virtual settings will disappear as soon as you end your Windows Po ## PARAMETERS -### -Identity - -Unique identifier for the new collection of meeting configuration settings. -Meeting configuration settings can only be created at the site or service scope. -To create new settings at the site scope, use syntax similar to this: `-Identity "site:Redmond".` -To create new settings at the service scope, use syntax like this: `-Identity "service:UserServer:atl-cs-001.litwareinc.com".` - -Note that the call to the New-CsMeetingConfiguration cmdlet will fail if the specified site or service already has a collection of meeting configuration settings. +### -AdmitAnonymousUsersByDefault +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Determines whether meetings will, by default, allow attendance by anonymous users (that is, unauthenticated users). +Set this value to True if you would like new meetings to allow for attendance by anonymous users by default. +Set this value to False if you would prefer that, by default, new meetings do not allow for attendance by anonymous users. +The default value is True. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AdmitAnonymousUsersByDefault -Determines whether meetings will, by default, allow attendance by anonymous users (that is, unauthenticated users). -Set this value to True if you would like new meetings to allow for attendance by anonymous users by default. -Set this value to False if you would prefer that, by default, new meetings do not allow for attendance by anonymous users. +### -AssignedConferenceTypeByDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether new meetings will be configured, by default, as public meetings. +Set this value to True to use public meetings by default; set this value to False to use private meetings by default. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,16 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AssignedConferenceTypeByDefault -Determines whether new meetings will be configured, by default, as public meetings. -Set this value to True to use public meetings by default; set this value to False to use private meetings by default. -The default value is True. +### -CustomFooterText + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Text to be used on custom meeting invitations. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +157,9 @@ Accept wildcard characters: False ``` ### -DesignateAsPresenter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates which users (besides the meeting organizer) are automatically designated as presenters when they join a meeting. Valid choices are: None; Company; and Everyone. By default, DesignateAsPresenter is set to Company, meaning everyone in your organization has presenter rights the moment they join a meeting. @@ -165,8 +167,7 @@ By default, DesignateAsPresenter is set to Company, meaning everyone in your org ```yaml Type: DesignateAsPresenter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,6 +177,9 @@ Accept wildcard characters: False ``` ### -EnableAssignedConferenceType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether users are allowed to schedule public meetings. With a public meeting, the conference ID and the meeting link remain consistent each time the meeting is held. With a private meeting, the conference ID and meeting link change from meeting to meeting. @@ -183,8 +187,7 @@ With a private meeting, the conference ID and meeting link change from meeting t ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,18 +196,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnCallersBypassLobby -Indicates whether users dialing in over a public switched telephone network (PSTN) phone line should automatically be admitted to a meeting. -If set to True PSTN callers will automatically be admitted to the meeting. -If set to False PSTN callers will initially be routed to the conference lobby. -At that point, they will be put on hold until a conference presenter grants them access to the meeting. -The default value is True. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,14 +214,16 @@ 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. +### -HelpURL + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL to a website where users can obtain assistance on joining the meeting. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,44 +232,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Identity -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new collection of meeting configuration settings. +Meeting configuration settings can only be created at the site or service scope. +To create new settings at the site scope, use syntax similar to this: `-Identity "site:Redmond".` +To create new settings at the service scope, use syntax like this: `-Identity "service:UserServer:atl-cs-001.litwareinc.com".` + +Note that the call to the New-CsMeetingConfiguration cmdlet will fail if the specified site or service already has a collection of meeting configuration settings. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 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 which the new meeting configuration settings are being created. -For example: +### -InMemory -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can return the tenant ID for each of your tenants by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` +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: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -275,14 +278,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LegalURL + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL to a website containing legal information and meeting disclaimers. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -291,14 +296,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -LogoURL + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the image to be used on custom meeting invitations. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -307,14 +314,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomFooterText -Text to be used on custom meeting invitations. +### -PstnCallersBypassLobby + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether users dialing in over a public switched telephone network (PSTN) phone line should automatically be admitted to a meeting. +If set to True PSTN callers will automatically be admitted to the meeting. +If set to False PSTN callers will initially be routed to the conference lobby. +At that point, they will be put on hold until a conference presenter grants them access to the meeting. +The default value is True. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -323,14 +336,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpURL -URL to a website where users can obtain assistance on joining the meeting. +### -RequireRoomSystemsAuthorization + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True) all users must be authenticated before they can join a meeting using the Skype for Business Room System. +The default value is False ($False). + + ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -339,14 +357,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegalURL -URL to a website containing legal information and meeting disclaimers. +### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new meeting configuration settings are being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + + ```yaml -Type: String +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -355,14 +384,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LogoURL -URL for the image to be used on custom meeting invitations. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -371,18 +402,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireRoomSystemsAuthorization - -When set to True ($True) all users must be authenticated before they can join a meeting using the Skype for Business Room System. -The default value is False ($False). +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -396,13 +425,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsMeetingConfiguration cmdlet does not accept pipelined data. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration The New-CsMeetingConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsMobilityPolicy.md similarity index 87% rename from skype/skype-ps/skype/New-CsMobilityPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsMobilityPolicy.md index 5e9016c50f..3729806fa0 100644 --- a/skype/skype-ps/skype/New-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMobilityPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csmobilitypolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsMobilityPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csmobilitypolicy +schema: 2.0.0 +title: New-CsMobilityPolicy --- # New-CsMobilityPolicy @@ -62,7 +64,7 @@ To use Call via Work, users must be managed by a voice policy that allows simult ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ```powershell New-CsMobilityPolicy -Identity site:Redmond -EnableOutsideVoice $False @@ -71,7 +73,7 @@ New-CsMobilityPolicy -Identity site:Redmond -EnableOutsideVoice $False The command shown in Example 1 creates a new mobility policy for the Redmond site, and disables the use of Call via Work for any users affected by the policy. This is done by setting the EnableOutsideVoice parameter to False. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ```powershell $x = New-CsMobilityPolicy -Identity site:Redmond -InMemory @@ -91,45 +93,34 @@ If you do not call the Set-CsMobilityPolicy cmdlet, the policy will not be creat ## PARAMETERS -### -Identity - -Unique Identity to be assigned to the policy. -New mobility 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` +### -AllowAutomaticPstnFallback -To create a new per-user policy, use an Identity similar to this: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Identity SalesDepartmentPolicy` - -Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsMobilityPolicy 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-CsMobilityPolicy cmdlet. +This parameter is reserved for internal Microsoft use. ```yaml -Type: XdsIdentity +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: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -AllowCustomerExperienceImprovementProgram -Prompts you for confirmation before executing the command. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) mobile users will be allowed to participate in the Microsoft Customer Experience Improvement Program. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,16 +129,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -AllowDeviceContactsSync -Enables administrators to provide explanatory text to accompany the policy. -For example, the Description might include information about the users that the policy should be assigned to. +> Applicable: Skype for Business Online + +When set to True (the default value) users will be allowed to sync device contacts on the mobile apps. + +More information: [How to disable CallKit integration for Skype for Business iOS](https://learn.microsoft.com/SkypeForBusiness/troubleshoot/server-phone-system/disable-callkit-integration). ```yaml -Type: String +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 @@ -156,18 +149,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableIPAudioVideo +### -AllowExchangeConnectivity -When set to False, prohibits the user from making voice over IP (VoIP) calls using the mobile device. -The default value is True, meaning that VoIP calls are allowed. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter was introduced in Lync Server 2013. +When set to True (the default value) users will be allowed to connect to Exchange by using their mobile device. ```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 @@ -176,15 +167,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMobility +### -AllowSaveCallLogs -When set to True, users are allowed to use Skype for Business Mobile. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) users will be allowed to save a call log of calls made from or received by their mobile device. + +Note that this setting does not apply to Android devices. ```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 @@ -193,18 +187,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOutsideVoice +### -AllowSaveCredentials -When set to True, enables users to take advantage of Call via Work. -When set to False, users cannot use Call via Work. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is True. +When set to True (the default value) users will be allowed to save credentials information (such as passwords) on their mobile device. +This information can then be applied to auto-logon scenarios. ```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 @@ -213,15 +206,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -AllowSaveIMHistory -Suppresses the display of any non-fatal error message that might occur when running the command. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) users will be allowed to save transcripts of IM and conferencing sessions on their mobile devices. ```yaml -Type: SwitchParameter +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 @@ -230,16 +224,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Description -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of a command 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. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide explanatory text to accompany the policy. +For example, the Description might include information about the users that the policy should be assigned to. ```yaml -Type: SwitchParameter +Type: String 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 @@ -248,11 +243,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireWIFIForIPVideo +### -EnableIPAudioVideo -When set to True, the user can use IP video only in calls made when mobile device is connected to a Wi-Fi network. -If mobile device goes outside of Wi-Fi range, then video calls will be received as audio calls only. -If this property is set to False (the default value) then the user can make or receive IP video calls in using either a Wi-Fi or a cellular data connection. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, prohibits the user from making voice over IP (VoIP) calls using the mobile device. +The default value is True, meaning that VoIP calls are allowed. This parameter was introduced in Lync Server 2013. @@ -260,7 +256,6 @@ This parameter was introduced in Lync Server 2013. 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 @@ -269,32 +264,16 @@ 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 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 -``` +### -EnableMobility -### -AllowAutomaticPstnFallback +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter is reserved for internal Microsoft use. +When set to True, users are allowed to use Skype for Business Mobile. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -303,15 +282,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCustomerExperienceImprovementProgram +### -EnableOutsideVoice -When set to True (the default value) mobile users will be allowed to participate in the Microsoft Customer Experience Improvement Program. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, enables users to take advantage of Call via Work. +When set to False, users cannot use Call via Work. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -320,17 +303,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDeviceContactsSync +### -EnablePushNotifications -When set to True (the default value) users will be allowed to sync device contacts on the mobile apps. +> Applicable: Skype for Business Online -More information: [How to disable CallKit integration for Skype for Business iOS](https://learn.microsoft.com/SkypeForBusiness/troubleshoot/server-phone-system/disable-callkit-integration). +When set to True (the default value) users will be allowed to receive push notifications on their mobile devices. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -339,15 +321,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExchangeConnectivity +### -EncryptAppData -When set to True (the default value) users will be allowed to connect to Exchange by using their mobile device. +> Applicable: Skype for Business Online + +When set to True (the default value) users will be allowed to encrypt data on their mobile apps. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -356,17 +339,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSaveCallLogs +### -Force -When set to True (the default value) users will be allowed to save a call log of calls made from or received by their mobile device. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this setting does not apply to Android devices. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -375,50 +357,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSaveCredentials +### -Identity -When set to True (the default value) users will be allowed to save credentials information (such as passwords) on their mobile device. -This information can then be applied to auto-logon scenarios. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Unique Identity to be assigned to the policy. +New mobility 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: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Identity site:Redmond` -### -AllowSaveIMHistory +To create a new per-user policy, use an Identity similar to this: -When set to True (the default value) users will be allowed to save transcripts of IM and conferencing sessions on their mobile devices. +`-Identity SalesDepartmentPolicy` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsMobilityPolicy 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-CsMobilityPolicy cmdlet. ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePushNotifications +### -InMemory -When set to True (the default value) users will be allowed to receive push notifications on their mobile devices. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of a command 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: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -427,15 +407,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptAppData +### -RequireIntune -When set to True (the default value) users will be allowed to encrypt data on their mobile apps. +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -444,15 +425,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireIntune +### -RequireWIFIForIPVideo -This parameter is reserved for internal Microsoft use. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the user can use IP video only in calls made when mobile device is connected to a Wi-Fi network. +If mobile device goes outside of Wi-Fi range, then video calls will be received as audio calls only. +If this property is set to False (the default value) then the user can make or receive IP video calls in using either a Wi-Fi or a cellular data connection. + +This parameter was introduced in Lync Server 2013. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -463,6 +449,8 @@ Accept wildcard characters: False ### -RequireWiFiForSharing +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, mobile users must use a WiFi connection in order to participate in an application sharing session. When set to False (the default value) mobile users can participate in application sharing by using either a WiFi connection or a cellular (3G/4G) connection. @@ -473,7 +461,6 @@ If this value is set to False users can use the Options page to modify their sha Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -484,6 +471,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new mobility policy is being created. For example: @@ -497,7 +486,6 @@ You can return the tenant ID for each of your Skype for Business Online tenants Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -508,6 +496,8 @@ Accept wildcard characters: False ### -VoiceSettings +> Applicable: Skype for Business Online + Controls how audio is connected by a mobile device joining a meeting or a peer-to-peer call. When the Skype for Business client is first run, and the user is enabled for Phone System with a Calling Plan, they are prompted to configure a call back phone number. This number is stored in settings under the **Calls and Meetings** section and will be used based on the value chosen for this parameter. Acceptable values are: **VoIPAlways:** WiFi will be used when available, otherwise a call back will be performed. @@ -520,7 +510,42 @@ Controls how audio is connected by a mobile device joining a meeting or a peer-t Type: String 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 + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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 diff --git a/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWAlternatePath.md similarity index 91% rename from skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkBWAlternatePath.md index cb3e77828a..75a9e44419 100644 --- a/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWAlternatePath.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbwalternatepath applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkBWAlternatePath -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkbwalternatepath +schema: 2.0.0 +title: New-CsNetworkBWAlternatePath --- # New-CsNetworkBWAlternatePath @@ -42,7 +43,7 @@ Note that you can apply these settings directly by using the AudioAlternatePath ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $a = New-CsNetworkBWAlternatePath -BWPolicyModality "audio" -AlternatePath $true @@ -63,13 +64,15 @@ We assign a value for the required parameter CentralSite (in this example the na ## PARAMETERS ### -AlternatePath + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Set the parameter to True to allow calls made in the media of the modality specified in the BWPolicyModality parameter (either audio or video) to be routed through an alternate path if adequate bandwidth does not exist in the primary path. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -BWPolicyModality + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The modality to which the alternate path setting applies. Valid values: audio, video @@ -88,8 +94,7 @@ Full data type: Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfigur ```yaml Type: BWPolicyModality Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -103,12 +108,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWAlternatePathType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWAlternatePathType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkBWPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWPolicy.md similarity index 88% rename from skype/skype-ps/skype/New-CsNetworkBWPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkBWPolicy.md index f6cd2973a3..d027e2020c 100644 --- a/skype/skype-ps/skype/New-CsNetworkBWPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbwpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkBWPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkbwpolicy +schema: 2.0.0 +title: New-CsNetworkBWPolicy --- # New-CsNetworkBWPolicy @@ -40,7 +41,7 @@ Note that the recommended method of assigning audio and video policies is to ass ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $bwp = New-CsNetworkBWPolicy -BWLimit 200 -BWSessionLimit 3000 -BWPolicyModality video ``` @@ -50,7 +51,7 @@ All parameters for the New-CsNetworkBWPolicy cmdlet are required. In this example we specified a total bandwidth limit (BWLimit) of 2000 kbps and a bandwidth session limit (BWSessionLimit) of 300 kbps, and we applied these limits to video sessions (-BWPolicyModality video). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $bwp = New-CsNetworkBWPolicy -BWLimit 200 -BWSessionLimit 3000 -BWPolicyModality video @@ -68,13 +69,15 @@ Then we use the BWPolicy parameter, giving it the value $bwp, which is the varia ## PARAMETERS ### -BWLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum total bandwidth, in kbps, for all concurrent sessions of the type specified in the BWPolicyModality parameter. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -BWPolicyModality + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines which type of bandwidth is limited. Valid values: Audio, Video @@ -91,8 +97,7 @@ Valid values: Audio, Video ```yaml Type: BWPolicyModality Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -BWSessionLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum bandwidth, in kbps, allowed for a single session of the type specified in the BWPolicyModality parameter. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -122,12 +129,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBandwidthPolicyProfile.md similarity index 84% rename from skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkBandwidthPolicyProfile.md index 0c27af1dff..4955cc7fc9 100644 --- a/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBandwidthPolicyProfile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkBandwidthPolicyProfile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkbandwidthpolicyprofile +schema: 2.0.0 +title: New-CsNetworkBandwidthPolicyProfile --- # New-CsNetworkBandwidthPolicyProfile @@ -41,7 +42,7 @@ Bandwidth policy profiles are applied to network sites by calling the New-CsNetw ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkBandwidthPolicyProfile -Identity LowBWLimits -AudioBWLimit 2000 -AudioBWSessionLimit 200 -VideoBWLimit 1400 -VideoBWSessionLimit 500 @@ -55,26 +56,10 @@ The same is done to create video session limits, but using the VideoBWLimit and ## PARAMETERS -### -Identity -A string value that uniquely identifies the policy. -All bandwidth policy profiles are created at the global scope. -Therefore the scope is implied and only a unique name needs to be specified when creating a new bandwidth policy profile. -Note that this value also populates the BWPolicyProfileID property of the profile. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AudioBWLimit -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AudioBWLimit The maximum amount of bandwidth to allocate for all audio connections. If a single audio session will cause the audio bandwidth limit to be exceeded, that session will not be allowed to start. @@ -88,8 +73,7 @@ Default: If you supply a value to the AudioBWSessionLimit parameter but not to A ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +83,9 @@ Accept wildcard characters: False ``` ### -AudioBWSessionLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of bandwidth to allocate per audio session. Expressed in kbps. Value must be 40 or higher. @@ -110,8 +97,7 @@ Default: If you supply a value to the AudioBWLimit parameter but not to AudioBWS ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +107,9 @@ Accept wildcard characters: False ``` ### -BWPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of objects containing bandwidth policy profiles. Each object in the list consists of a bandwidth modality (audio or video), a bandwidth limitation, and a bandwidth session limitation. @@ -131,8 +120,7 @@ Objects in the list can be created by calling the New-CsNetworkBWPolicy cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,14 +130,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of the bandwidth policy profile. For example, you can use this parameter to clarify the expected use of the profile. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,22 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoBWLimit -The maximum amount of bandwidth to allocate for all video connections. -If a single video session will cause the video bandwidth limit to be exceeded, that session will not be allowed to start. +### -Force -Expressed in kbps. -For example, a value of 1000 would signify 1000 kbps. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter. - -Default: If you supply a value to the VideoBWSessionLimit parameter but not to VideoBWLimit, VideoBWLimit will default to 0. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,36 +166,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoBWSessionLimit -The maximum amount of bandwidth to allocate per video session. -Expressed in kbps. -Value must be 100 or higher. +### -Identity -If you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: If you supply a value to the VideoBWLimit parameter but not to VideoBWSessionLimit, VideoBWSessionLimit will default to 700. +A string value that uniquely identifies the policy. +All bandwidth policy profiles are created at the global scope. +Therefore the scope is implied and only a unique name needs to be specified when creating a new bandwidth policy profile. +Note that this value also populates the BWPolicyProfileID property of the profile. ```yaml -Type: String +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,18 +208,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -VideoBWLimit -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The maximum amount of bandwidth to allocate for all video connections. +If a single video session will cause the video bandwidth limit to be exceeded, that session will not be allowed to start. + +Expressed in kbps. +For example, a value of 1000 would signify 1000 kbps. +If you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter. + +Default: If you supply a value to the VideoBWSessionLimit parameter but not to VideoBWLimit, VideoBWLimit will default to 0. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,14 +234,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -VideoBWSessionLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum amount of bandwidth to allocate per video session. +Expressed in kbps. +Value must be 100 or higher. + +If you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter. + +Default: If you supply a value to the VideoBWLimit parameter but not to VideoBWSessionLimit, VideoBWSessionLimit will default to 700. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,13 +259,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -277,12 +299,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterRegionRoute.md similarity index 84% rename from skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkInterRegionRoute.md index 5a44fa962c..cc4f4719c4 100644 --- a/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterRegionRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkInterRegionRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkinterregionroute +schema: 2.0.0 +title: New-CsNetworkInterRegionRoute --- # New-CsNetworkInterRegionRoute @@ -45,7 +46,7 @@ This cmdlet creates that route association. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkInterRegionRoute -Identity NA_APAC_Route -NetworkRegionID1 NorthAmerica -NetworkRegionID2 APAC -NetworkRegionLinkIDs "NA_EMEA,EMEA_APAC" @@ -62,7 +63,28 @@ This will route connections from NorthAmerica to APAC through EMEA and apply any ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the newly created network region route. Network region routes are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that route. @@ -70,8 +92,7 @@ Instead, it contains a string that is a unique name that identifies that route. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -80,15 +101,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -InterNetworkRegionRouteID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This value is the same as the Identity. You cannot specify both an Identity and an InterNetworkRegionRouteID; a value entered for one will be automatically used for both. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -98,6 +142,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionID1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkRegionID) of one of the two regions connected through this route. The value passed to this parameter must be a different region from the value of the NetworkRegionID2 parameter. (In other words, you can't route a region to itself.) In addition, the combination of NetworkRegionID1 and NetworkRegionID2 must be unique (for example, you can't have two routes defined that connect NorthAmerica and EMEA). @@ -105,8 +152,7 @@ The value passed to this parameter must be a different region from the value of ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -116,6 +162,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionID2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkRegionID) of one of the two regions connected through this route. The value passed to this parameter must be a different region from the value of the NetworkRegionID1 parameter. (In other words, you can't route a region to itself.) In addition, the combination of NetworkRegionID1 and NetworkRegionID2 must be unique (for example, you can't have two routes defined that connect NorthAmerica and EMEA). @@ -123,8 +172,7 @@ The value passed to this parameter must be a different region from the value of ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -134,6 +182,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionLinkIDs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to specify all the links for this route as a string of comma-separated values. The values are the identities (NetworkRegionLinkIDs) of the region links. If you enter values for both NetworkRegionLinkIDs and NetworkRegionLinks, NetworkRegionLinkIDs will be ignored. @@ -142,8 +193,7 @@ This parameter provides a convenient way to specify the list of links without ha ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,6 +203,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionLinks + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list object containing the identities (NetworkRegionLinkIDs) of the region links that apply to this route. For this cmdlet, this parameter differs from the NetworkRegionLinkIDs parameter only in the format if you enter more than one link. The NetworkRegionLinkIDs parameter is the recommended method for defining the initial list with this cmdlet. @@ -160,8 +213,7 @@ The NetworkRegionLinkIDs parameter is the recommended method for defining the in ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,34 +222,16 @@ 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 - -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-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -207,29 +241,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -243,12 +263,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterSitePolicy.md similarity index 82% rename from skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkInterSitePolicy.md index 445ced2da8..8cc5fc86b0 100644 --- a/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterSitePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkInterSitePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkintersitepolicy +schema: 2.0.0 +title: New-CsNetworkInterSitePolicy --- # New-CsNetworkInterSitePolicy @@ -44,7 +45,7 @@ This cmdlet creates a network site policy that associates a bandwidth limitation ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkInterSitePolicy -Identity Reno_Portland -NetworkSiteID1 Reno -NetworkSiteID2 Portland -BWPolicyProfileID LowBWLimits @@ -57,136 +58,151 @@ The bandwidth limitations for audio and video connections between these sites ar ## PARAMETERS -### -Identity -A unique identifier for the newly created network inter-site policy. -Network inter-site policies are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies that site policy. +### -BWPolicyProfileID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the bandwidth policy profile that will define the limitations for this site policy. +You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InterNetworkSitePolicyID -This value is the same as the Identity. -You cannot specify both an Identity and an InterNetworkSitePolicyID; a value entered for one will be automatically used for both. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID1 -The Identity (NetworkSiteID) of one of the two sites associated with this policy. -The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the newly created network inter-site policy. +Network inter-site policies are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies that site policy. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID2 -The Identity (NetworkSiteID) of one of the two sites associated with this policy. -The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BWPolicyProfileID -The Identity of the bandwidth policy profile that will define the limitations for this site policy. -You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. +### -InterNetworkSitePolicyID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This value is the same as the Identity. +You cannot specify both an Identity and an InterNetworkSitePolicyID; a value entered for one will be automatically used for both. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -NetworkSiteID1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity (NetworkSiteID) of one of the two sites associated with this policy. +The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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-\. +### -NetworkSiteID2 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The Identity (NetworkSiteID) of one of the two sites associated with this policy. +The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -195,14 +211,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -216,12 +234,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkMediaBypassConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkMediaBypassConfiguration.md index 37c19d474c..846d8be409 100644 --- a/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkMediaBypassConfiguration.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: New-CsNetworkMediaBypassConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkmediabypassconfiguration +schema: 2.0.0 +title: New-CsNetworkMediaBypassConfiguration --- # New-CsNetworkMediaBypassConfiguration @@ -39,7 +41,7 @@ To retrieve these settings, run this command: (Get-CsNetworkConfiguration).Media ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $a = New-CsNetworkMediaBypassConfiguration -AlwaysBypass $true -Enabled $true @@ -59,7 +61,7 @@ Therefore, in line 2 of the example, we save the media bypass configuration chan The following parameters are not applicable to Skype for Business Online: BypassID, EnableDefaultBypassID, EnabledForAudioVideoConferences, ExternalBypassMode, InternalBypassMode, PipelineVariable, and Tenant -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $a = (Get-CsNetworkConfiguration).MediaBypassSettings @@ -85,6 +87,8 @@ Finally, in line 3 we call the Set-CsNetworkConfiguration cmdlet, passing the Me ### -AlwaysBypass +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Setting this parameter to True will attempt media bypass on all calls. Set this parameter value to True only if call admission control (CAC) is disabled. @@ -105,8 +109,7 @@ Default: 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 +Aliases: Required: False Position: Named @@ -117,6 +120,8 @@ Accept wildcard characters: False ### -BypassID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The media bypass ID. If the AlwaysBypass parameter is set to True and a value is supplied for this parameter, this BypassID will be associated with all subnets. If AlwaysBypass is False, the BypassID value is associated with all subnets that are not found in network configuration sites and regions. @@ -128,8 +133,7 @@ This value is automatically generated when Enabled is set to True and either: 1) ```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 +Aliases: Required: False Position: Named @@ -140,6 +144,8 @@ Accept wildcard characters: False ### -Enabled +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Set this parameter to True to enable media bypass. At that point bypass decisions will be based on the value of the AlwaysBypass setting as follows: @@ -151,8 +157,7 @@ Default: 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 +Aliases: Required: False Position: Named @@ -163,6 +168,8 @@ Accept wildcard characters: False ### -EnableDefaultBypassID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + This value applies only when AlwaysBypass is set to False. Setting this value to True will automatically generate a default bypass ID. @@ -177,8 +184,7 @@ Default: 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 +Aliases: Required: False Position: Named @@ -187,18 +193,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalBypassMode +### -EnabledForAudioVideoConferences -Reserved for future use. -External media bypass is not supported in Skype for Business Server. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Default: Off +Indicates whether media bypass should be used for audio/video conferences. +The default value is False ($False). ```yaml -Type: BypassModeEnumType +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 +Aliases: Required: False Position: Named @@ -207,19 +212,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InternalBypassMode +### -ExternalBypassMode -The value of this parameter controls when clients connecting from inside the organization's network can try to perform media bypass. -If Enabled is set to True, this value will automatically be changed to Any. -Other values for this parameter are reserved for future use. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Reserved for future use. +External media bypass is not supported in Skype for Business Server. Default: Off ```yaml Type: BypassModeEnumType 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 +Aliases: Required: False Position: Named @@ -228,16 +233,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledForAudioVideoConferences +### -InternalBypassMode -Indicates whether media bypass should be used for audio/video conferences. -The default value is False ($False). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +The value of this parameter controls when clients connecting from inside the organization's network can try to perform media bypass. +If Enabled is set to True, this value will automatically be changed to Any. +Other values for this parameter are reserved for future use. + +Default: Off ```yaml -Type: Boolean +Type: BypassModeEnumType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,13 +256,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -267,12 +278,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.MediaBypassSettingsType Creates an object reference of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.MediaBypassSettingsType. ### System.Object diff --git a/skype/skype-ps/skype/New-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegion.md similarity index 86% rename from skype/skype-ps/skype/New-CsNetworkRegion.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkRegion.md index eee2fe72cc..54aa830319 100644 --- a/skype/skype-ps/skype/New-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkregion +schema: 2.0.0 +title: New-CsNetworkRegion --- # New-CsNetworkRegion @@ -49,7 +50,7 @@ The parameters of this cmdlet allow you to provide settings that determine wheth ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkRegion -Identity NorthAmerica -Description "All North American Locations" -CentralSite Redmond-NA-MLS @@ -60,7 +61,7 @@ The region name is specified as the value for the Identity parameter. A value is also specified for the optional Description parameter, describing this region as being composed of "All North American Locations." Finally, the CentralSite parameter receives a value of the name of the central site for this region, Redmond-NA-MLS. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsNetworkRegion -Identity EMEA -CentralSite Dublin-EU-Site -AudioAlternatePath $False @@ -71,7 +72,7 @@ To do this we call the New-CsNetworkRegion cmdlet, passing an Identity of EMEA. We assign a value for the required parameter CentralSite (in this example the name of the central site for this region is Dublin-EU-Site), and then we specify the AudioAlternatePath parameter, passing it the value $False. Setting AudioAlternatePath to False indicates that if adequate bandwidth is not available, the audio calls will not be routed to an alternate path; instead, they will simply not be completed. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $a = New-CsNetworkBWAlternatePath -BWPolicyModality "audio" -AlternatePath $False @@ -92,61 +93,10 @@ We assign a value for the required parameter CentralSite (in this example the na ## PARAMETERS -### -Identity -A unique identifier for the newly created network region. -Regions are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies that region. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CentralSite -The central site running the bandwidth policy service. -This service must be enabled in order to use CAC. -This service runs on the Front End Server or the Standard Edition server. - -```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: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkRegionID -This value is the same as the Identity. -You cannot specify both an Identity and a NetworkRegionID; a value entered for one will be automatically used for both. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AudioAlternatePath +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter determines whether audio calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path. This parameter populates the BWAlternatePaths property. @@ -163,8 +113,7 @@ If any of your calls will be Internet calls, this value must be True, regardless ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,6 +123,9 @@ Accept wildcard characters: False ``` ### -BWAlternatePaths + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of objects that contain information about whether alternate Internet connection paths are allowed if a media request is unable to complete along the preferred path (for example, if limits on that path have been exceeded). Alternate path objects must be created by calling the New-CsNetworkBWAlternatePath cmdlet. @@ -184,8 +136,7 @@ Alternate paths for audio and video are enabled (AlternatePath = True) by defaul ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +147,8 @@ Accept wildcard characters: False ### -BypassID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A globally unique identifier (GUID). This GUID is used to map network regions to media bypass settings within a CAC or Enhanced 9-1-1 (E9-1-1) network configuration. (Use this BypassID value in the call to the New-CsNetworkMediaBypassConfiguration cmdlet.) @@ -210,8 +163,7 @@ If you supply a value for this parameter, you'll receive a confirmation prompt a ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,43 +172,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A string that describes the region. -This parameter can be used to provide a more descriptive explanation of what the region is for than can be expressed by the Identity alone. +### -CentralSite + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The central site running the bandwidth policy service. +This service must be enabled in order to use CAC. +This service runs on the Front End Server or the Standard Edition server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoAlternatePath - -This parameter determines whether video calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path. - -This parameter populates the BWAlternatePaths property. -The value supplied to this parameter is stored in the AlternatePath property for the alternate path element with a BWPolicyModality value of Video. - -If you supply a value for this parameter you cannot specify a value for the BWAlternatePaths parameter. - -Default: True. -Set this parameter to False only if you need to turn off the offload to the Internet. -If any of your calls will be Internet calls, this value must be True, regardless of bandwidth settings. +### -Description +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A string that describes the region. +This parameter can be used to provide a more descriptive explanation of what the region is for than can be expressed by the Identity alone. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -266,14 +212,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. For example, if you supply a value to the BypassID parameter, you will not be prompted for confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -282,8 +230,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the newly created network region. +Regions are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies that region. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -292,8 +262,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -302,14 +271,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -NetworkRegionID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This value is the same as the Identity. +You cannot specify both an Identity and a NetworkRegionID; a value entered for one will be automatically used for both. ```yaml -Type: SwitchParameter +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VideoAlternatePath + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter determines whether video calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path. + +This parameter populates the BWAlternatePaths property. +The value supplied to this parameter is stored in the AlternatePath property for the alternate path element with a BWPolicyModality value of Video. + +If you supply a value for this parameter you cannot specify a value for the BWAlternatePaths parameter. + +Default: True. +Set this parameter to False only if you need to turn off the offload to the Internet. +If any of your calls will be Internet calls, this value must be True, regardless of bandwidth settings. + + + +```yaml +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -319,13 +320,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -339,12 +360,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegionLink.md similarity index 82% rename from skype/skype-ps/skype/New-CsNetworkRegionLink.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkRegionLink.md index 20c21b9c30..3d622da848 100644 --- a/skype/skype-ps/skype/New-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegionLink.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkRegionLink -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkregionlink +schema: 2.0.0 +title: New-CsNetworkRegionLink --- # New-CsNetworkRegionLink @@ -44,7 +45,7 @@ This cmdlet defines a link between two regions and sets the bandwidth limitation ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkRegionLink -Identity NA_EMEA -NetworkRegionID1 NorthAmerica -NetworkRegionID2 EMEA -BWPolicyProfileID LowBWLimits @@ -62,134 +63,149 @@ For details, see the New-CsNetworkSite cmdlet help topic.) ## PARAMETERS -### -Identity -A unique identifier for the newly created network region link. -Network region links are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies that link. +### -BWPolicyProfileID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the bandwidth policy profile that will define the bandwidth limitations for this link. +You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID1 -The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID2 parameter. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID2 -The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID1 parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the newly created network region link. +Network region links are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies that link. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionLinkID -This value is the same as the Identity. -You cannot specify both an Identity and a NetworkRegionLinkID; a value entered for one will be automatically used for both. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BWPolicyProfileID -The Identity of the bandwidth policy profile that will define the bandwidth limitations for this link. -You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. +### -NetworkRegionID1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID2 parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -NetworkRegionID2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID1 parameter. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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-\. +### -NetworkRegionLinkID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +This value is the same as the Identity. +You cannot specify both an Identity and a NetworkRegionLinkID; a value entered for one will be automatically used for both. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -198,14 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -219,12 +237,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSite.md similarity index 85% rename from skype/skype-ps/skype/New-CsNetworkSite.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkSite.md index 160f838625..7d083d20e8 100644 --- a/skype/skype-ps/skype/New-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworksite +schema: 2.0.0 +title: New-CsNetworkSite --- # New-CsNetworkSite @@ -47,7 +48,7 @@ A CAC network site must be created for every site within an organization, even i ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkSite -Identity Vancouver -NetworkRegionID NorthAmerica ``` @@ -63,7 +64,7 @@ Unless (or until) a value is added to this site later using the Set-CsNetworkSit -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsNetworkSite -Identity Paris -NetworkRegionID EMEA -BWPolicyProfileID LowBWLimits ``` @@ -79,45 +80,10 @@ The policies associated with that profile will be used for this site. ## PARAMETERS -### -Identity - -A unique identifier for the newly created network site. -Sites are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is unique among all network sites within the Skype for Business Server 2015 deployment. - - - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSiteID -This value is the same as the Identity. -You cannot specify both an Identity and a NetworkSiteID; a value entered for one will be automatically used for both. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -BWPolicyProfileID -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -BWPolicyProfileID The Identity of the bandwidth policy profile that will define the bandwidth limitations for this site. You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. @@ -126,8 +92,7 @@ If you specify a value for this parameter, you must also specify a value for the ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +103,8 @@ Accept wildcard characters: False ### -BypassID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A globally unique identifier (GUID). This GUID is used to map network sites to media bypass settings within a CAC or E9-1-1 network configuration. (Use this BypassID value in the call to the New-CsNetworkMediaBypassConfiguration cmdlet.) @@ -155,8 +122,7 @@ If you manually enter a value, you will receive a confirmation prompt to verify ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,14 +132,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string that describes the site. This parameter can be used to provide a more descriptive explanation of what the site is for or where it is than can be expressed by the Identity alone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,16 +150,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationPolicy -The name of the location policy associated with this site. -The location policy assigns specific E9-1-1 settings to the site. -You can retrieve a list of location policies by calling the Get-CsLocationPolicy cmdlet. +### -EnableLocationBasedRouting + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,35 +169,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -The Identity of the network region that this site is associated with. -This parameter must contain a value if you want to provide a BypassID (either through auto-generation or manually), or if the EnableBandwidthPolicyCheck property of the network configuration is True. -You can retrieve the network configuration settings by calling the Get-CsNetworkConfiguration cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the newly created network site. +Sites are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is unique among all network sites within the Skype for Business Server 2015 deployment. + + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -236,6 +211,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -244,8 +221,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -254,14 +230,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LocationPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name of the location policy associated with this site. +The location policy assigns specific E9-1-1 settings to the site. +You can retrieve a list of location policies by calling the Get-CsLocationPolicy cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -270,33 +250,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -NetworkRegionID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the network region that this site is associated with. +This parameter must contain a value if you want to provide a BypassID (either through auto-generation or manually), or if the EnableBandwidthPolicyCheck property of the network configuration is True. +You can retrieve the network configuration settings by calling the Get-CsNetworkConfiguration cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationBasedRouting -When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. -The default value is False. +### -NetworkSiteID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This value is the same as the Identity. +You cannot specify both an Identity and a NetworkSiteID; a value entered for one will be automatically used for both. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -304,6 +290,9 @@ Accept wildcard characters: False ``` ### -VoiceRoutingPolicy + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Per-user voice routing policy to be assigned to the site. For example: @@ -316,8 +305,43 @@ This parameter was introduced in the February, 2013 release of Lync Server 2013. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -331,12 +355,11 @@ This cmdlet supports the common parameters:` -Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType Create an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSubnet.md similarity index 85% rename from skype/skype-ps/skype/New-CsNetworkSubnet.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkSubnet.md index 38d0bfaf72..2d6ea0f494 100644 --- a/skype/skype-ps/skype/New-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworksubnet +schema: 2.0.0 +title: New-CsNetworkSubnet --- # New-CsNetworkSubnet @@ -47,7 +48,7 @@ For more details, see the Examples section for this cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkSubnet -Identity 172.11.15.0 -MaskBits 24 -NetworkSiteID Vancouver ``` @@ -60,7 +61,7 @@ That is done by supplying a value--in this case 24--to the MaskBits parameter. Finally, the site ID Vancouver is passed to the NetworkSiteID parameter to associate this subnet with that site. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Import-CSV C:\subnet.csv | foreach {New-CsNetworkSubnet -Identity $_.Identity -MaskBits $_.Mask -NetworkSiteID $_.SiteID} @@ -97,67 +98,74 @@ This process continues until all lines in the file have been read, and their val ## PARAMETERS -### -Identity -The unique subnet ID of the subnet being created. -This must be an IP address (such as 174.11.12.0), and it must be the first address in the IP address range defined by the subnet. +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A description of the subnet being created. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MaskBits -The bitmask to be applied to the subnet being created. +### -Force -Valid values: 1 through 32 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SubnetID -This is the same value as the Identity. -You must specify either an Identity or a SubnetID, but you cannot specify both. -Whatever value you supply to one will automatically be applied to the other. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique subnet ID of the subnet being created. +This must be an IP address (such as 174.11.12.0), and it must be the first address in the IP address range defined by the subnet. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description of the subnet being created. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,31 +174,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID -The site ID of the site to which this subnet belongs. -You can retrieve site IDs for your deployment by calling the Get-CsNetworkSite cmdlet. +### -MaskBits + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The bitmask to be applied to the subnet being created. + +Valid values: 1 through 32 ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -NetworkSiteID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The site ID of the site to which this subnet belongs. +You can retrieve site IDs for your deployment by calling the Get-CsNetworkSite cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,34 +213,36 @@ 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-\. +### -SubnetID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +This is the same value as the Identity. +You must specify either an Identity or a SubnetID, but you cannot specify both. +Whatever value you supply to one will automatically be applied to the other. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -235,14 +251,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -256,12 +274,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/New-CsOAuthServer.md similarity index 84% rename from skype/skype-ps/skype/New-CsOAuthServer.md rename to skype/skype-ps/SkypeForBusiness/New-CsOAuthServer.md index 683832a330..5fd412151e 100644 --- a/skype/skype-ps/skype/New-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsOAuthServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsOAuthServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csoauthserver +schema: 2.0.0 +title: New-CsOAuthServer --- # New-CsOAuthServer @@ -44,7 +45,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsOAuthServer -Identity "Office 365" -MetadataUrl "https://sts.office365.microsoft.com/metadata/json/1" @@ -56,32 +57,36 @@ The new server uses the metadata URL `https://sts.office365.microsoft.com/metada ## PARAMETERS -### -MetadataUrl -URL where the WS-FederationMetadata for the server is published. -Servers use the metadata to agree on the types of tokens that will be exchanged as well the keys that will be used to sign these tokens. -Note that the specified URL must be available when you run the New-CsOAuthServer cmdlet or else the command will fail. +### -AcceptSecurityIdentifierInformation + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -AuthorizationUriOverride + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +URI used for OAuth authorization override. +The override prevents authenticated users from being reprompted for their credentials after they have logged on. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Friendly (and unique) name used to identify the OAuth server. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -123,14 +132,16 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,8 +150,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MetadataUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL where the WS-FederationMetadata for the server is published. +Servers use the metadata to agree on the types of tokens that will be exchanged as well the keys that will be used to sign these tokens. +Note that the specified URL must be available when you run the New-CsOAuthServer cmdlet or else the command will fail. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Realm +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Server-to-server security container. By default, Skype for Business Server uses your default SIP domain as its OAuth realm. @@ -149,8 +182,7 @@ By default, Skype for Business Server uses your default SIP domain as its OAuth ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +193,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new OAuth server is being created. For example: @@ -175,8 +209,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,31 +218,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Type -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Type of authentication used by the server. +For example, this syntax configures the server to use Active Directory Federation Services authentication: -### -AcceptSecurityIdentifierInformation -When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. -The default value is False. +-Type "ADFS" ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -218,15 +239,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthorizationUriOverride -URI used for OAuth authorization override. -The override prevents authenticated users from being reprompted for their credentials after they have logged on. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -235,17 +257,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Type of authentication used by the server. -For example, this syntax configures the server to use Active Directory Federation Services authentication: +### -WhatIf --Type "ADFS" +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -259,13 +280,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsOAuthServer cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated The New-CsOAuthServer cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsOutboundCallingNumberTranslationRule.md similarity index 86% rename from skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsOutboundCallingNumberTranslationRule.md index db567dff75..7479ea4838 100644 --- a/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsOutboundCallingNumberTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsOutboundCallingNumberTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csoutboundcallingnumbertranslationrule +schema: 2.0.0 +title: New-CsOutboundCallingNumberTranslationRule --- # New-CsOutboundCallingNumberTranslationRule @@ -53,7 +54,7 @@ In the Edit Trunk Configuration dialog box scroll down to the section labeled Ca ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsOutboundCallingNumberTranslationRule -Parent "site:Redmond" -Name SevenDigit -Description "Converts a dialed number to seven digits" -Pattern '^\+1206(\d{7})$' -Translation '$1' @@ -64,7 +65,47 @@ The command shown in Example 1 creates a new outbound calling number translation ## PARAMETERS +### -Description + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text to accompany a translation rule. +This description can be used to help administrators clearly identify the purpose of the rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new translation rule. Names are composed of the scope (parent), a "/" character, and a unique name within that scope. For example, a rule named RedmondDialing created for the Redmond site would have an Identity that looked like this: @@ -76,8 +117,7 @@ If you use the Identity parameter then your command cannot contain either the Pa ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -86,7 +126,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name for the new translation rule; names must be unique for the given scope. For example: @@ -98,8 +160,7 @@ The Name parameter cannot be used in the same command as the Identity parameter. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -109,6 +170,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope at which the new translation rule will be configured. To configure a rule at the global scope, use this syntax: @@ -128,8 +192,7 @@ The Parent parameter cannot be used in the same command as the Identity paramete ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -138,31 +201,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Pattern -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description -Enables administrators to provide additional text to accompany a translation rule. -This description can be used to help administrators clearly identify the purpose of the rule. +A regular expression representing the number pattern to which the Translation will be applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,31 +219,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Priority -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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. +Priority assigned to the rule. +If a number matches the Pattern of more than one outbound translation rule, rules are applied in priority order. +Rules are processed in order of their assigned priority; the first rule to be processed has a priority of 0; the second rule to be processed has a priority of 1; and so on. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,14 +239,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Pattern -A regular expression representing the number pattern to which the Translation will be applied. +### -Translation + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A regular expression that will be applied to the number matching the Pattern to prepare that number for outbound calling. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,32 +257,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -Priority assigned to the rule. -If a number matches the Pattern of more than one outbound translation rule, rules are applied in priority order. -Rules are processed in order of their assigned priority; the first rule to be processed has a priority of 0; the second rule to be processed has a priority of 1; and so on. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Translation -A regular expression that will be applied to the number matching the Pattern to prepare that number for outbound calling. +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -255,13 +276,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -275,14 +298,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsOutboundCallingNumberTranslationRule cmdlet does not accept pipelined data. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated The New-CsOutboundCallingNumberTranslationRule cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsOutboundTranslationRule.md similarity index 84% rename from skype/skype-ps/skype/New-CsOutboundTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsOutboundTranslationRule.md index 73e18b5b4f..f67d9fdc10 100644 --- a/skype/skype-ps/skype/New-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsOutboundTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsOutboundTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csoutboundtranslationrule +schema: 2.0.0 +title: New-CsOutboundTranslationRule --- # New-CsOutboundTranslationRule @@ -51,7 +52,7 @@ If you call the New-CsOutboundTranslationRule cmdlet and specify a scope at whic ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond" @@ -62,7 +63,7 @@ Because no other parameters are specified, the rule is created with the default 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. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsOutboundTranslationRule -Parent global -Name SeattleSevenDigit -Description "Convert to seven digits" -Pattern '^\+1425(\d{7})$' -Translation '$1' @@ -77,8 +78,47 @@ For example, the number +14255551212 would be translated to the number 5551212. ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A description of the outbound translation rule. +This description will help identify the purpose of the rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the outbound translation rule. The Identity includes the scope at which the rule is applied and the name of the rule, and must be at the global, site, or service (PSTNGateway only) scope. For example, site:Redmond/OutboundRule1 and PstnGateway:Redmond.litwareinc.com/OutboundRule2. @@ -90,8 +130,7 @@ If the Identity parameter is specified, you cannot specify values for the Name o ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -100,19 +139,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -The scope of the outbound translation rule. -If a value is specified for this parameter, a value must also be specified for the Name parameter. -However, the Identity parameter cannot be specified. -If the Parent and Name parameters aren't specified, the Identity must be. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -120,6 +161,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the outbound translation rule. If no Name is supplied, an Identity consisting of a scope and name must be specified. If a Name is supplied, the Parent parameter is also required, but an Identity cannot be specified. @@ -127,8 +171,7 @@ If a Name is supplied, the Parent parameter is also required, but an Identity ca ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -137,17 +180,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description of the outbound translation rule. -This description will help identify the purpose of the rule. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The scope of the outbound translation rule. +If a value is specified for this parameter, a value must also be specified for the Name parameter. +However, the Identity parameter cannot be specified. +If the Parent and Name parameters aren't specified, the Identity must be. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -155,6 +202,9 @@ Accept wildcard characters: False ``` ### -Pattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression representing the number pattern to which the Translation will be applied. Default: ^\+(\d*)$ @@ -162,8 +212,7 @@ Default: ^\+(\d*)$ ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,14 +222,16 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If a number matches the Pattern of more than one outbound translation rule, rules are applied in priority order. Use this parameter to assign a priority to the rule. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +241,9 @@ Accept wildcard characters: False ``` ### -Translation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that will be applied to the number matching the Pattern to prepare that number for outbound routing. Default: $1 @@ -197,24 +251,7 @@ Default: $1 ```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 -``` - -### -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 +Aliases: Required: False Position: Named @@ -223,18 +260,16 @@ 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-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -244,29 +279,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -280,12 +301,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/New-CsPartnerApplication.md similarity index 84% rename from skype/skype-ps/skype/New-CsPartnerApplication.md rename to skype/skype-ps/SkypeForBusiness/New-CsPartnerApplication.md index 60a75d1f84..43772db63f 100644 --- a/skype/skype-ps/skype/New-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPartnerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPartnerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspartnerapplication +schema: 2.0.0 +title: New-CsPartnerApplication --- # New-CsPartnerApplication @@ -70,7 +71,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPartnerApplication -Identity "MicrosoftExchange" -ApplicationTrustLevel "Full" -MetadataUrl "https://autodiscover.litwareinc.com/metadata/json/1" @@ -80,7 +81,7 @@ The command shown in Example 1 creates a new partner application with the Identi In this example, the new partner application uses the metadata URL `https://autodiscover.litwareinc.com/metadata/json/1`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsPartnerApplication -Identity "MicrosoftExchange" -ApplicationIdentifier "microsoft.exchange" -ApplicationTrustLevel "Full" -UseOAuthServer @@ -93,8 +94,29 @@ To do this, the command uses the UseOAuthServer parameter instead of the Metadat ## PARAMETERS +### -AcceptSecurityIdentifierInformation + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. +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 +``` + ### -ApplicationIdentifier +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the partner application. The ApplicationIdentifier is provided by the server application. You cannot use the ApplicationIdentifier parameter and the MetadataUrl parameter in the same command. @@ -104,8 +126,7 @@ You cannot use the ApplicationIdentifier parameter and the MetadataUrl parameter ```yaml Type: String Parameter Sets: UseOAuthServer, CertificateFileData, CertificateRawData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -116,6 +137,8 @@ Accept wildcard characters: False ### -ApplicationTrustLevel +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the level of trust between Skype for Business Server and the partner application. Allowed values are: @@ -130,8 +153,7 @@ The default value is Full. ```yaml Type: ApplicationTrustLevel Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -141,6 +163,9 @@ Accept wildcard characters: False ``` ### -CertificateFileData + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to a certificate file that can be assigned to the partner application. For example: @@ -149,8 +174,7 @@ For example: ```yaml Type: String Parameter Sets: CertificateFileData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -160,6 +184,9 @@ Accept wildcard characters: False ``` ### -CertificateRawData + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Certificate (in Base64 encoded format) that can be assigned to the partner application. To read raw data from a certificate and then convert that data to the required format, use commands similar to these: @@ -174,41 +201,7 @@ You can then use this syntax to assign the certificate data stored in the variab ```yaml Type: String Parameter Sets: CertificateRawData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataUrl -URL where the WS-FederationMetadata for the partner application is published. -Partner applications use the metadata to agree on the types of tokens that will be exchanged as well the keys that will be used to sign these tokens. - -```yaml -Type: String -Parameter Sets: MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseOAuthServer -When present, indicates that the partner application will use one of the pre-authorized OAuth servers instead of a security token server built into the application itself. - -```yaml -Type: SwitchParameter -Parameter Sets: UseOAuthServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -217,48 +210,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptSecurityIdentifierInformation -When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. -The default value is False. - -```yaml -Type: Boolean -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 -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Enabled -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Enabled When set to True the partner application will be enabled and available for immediate use. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,13 +230,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,13 +248,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new partner application. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -300,14 +266,16 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -316,33 +284,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Realm - -Server-to-server security container. -By default, Skype for Business Server uses your default SIP domain as its OAuth realm. +### -MetadataUrl +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +URL where the WS-FederationMetadata for the partner application is published. +Partner applications use the metadata to agree on the types of tokens that will be exchanged as well the keys that will be used to sign these tokens. ```yaml Type: String -Parameter Sets: UseOAuthServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: MetadataUrl +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Realm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Server-to-server security container. +By default, Skype for Business Server uses your default SIP domain as its OAuth realm. + ```yaml Type: String -Parameter Sets: CertificateFileData, CertificateRawData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: UseOAuthServer, CertificateFileData, CertificateRawData +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -351,6 +324,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new partner application is being created. For example: @@ -360,13 +335,46 @@ You can return the tenant ID for each of your 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 +``` + +### -UseOAuthServer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, indicates that the partner application will use one of the pre-authorized OAuth servers instead of a security token server built into the application itself. ```yaml -Type: Guid +Type: SwitchParameter +Parameter Sets: UseOAuthServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -376,13 +384,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -396,13 +406,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPartnerApplication cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated The New-CsPartnerApplication cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatAddin.md similarity index 91% rename from skype/skype-ps/skype/New-CsPersistentChatAddin.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatAddin.md index 6b554367cb..221af9acbe 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatAddin.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: New-CsPersistentChatAddin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchataddin +schema: 2.0.0 +title: New-CsPersistentChatAddin --- # New-CsPersistentChatAddin @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: To create a new Persistent Chat add-in ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatAddin -Name "ITPersistentChatAddin" -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" -Url "https://atl-cs-001.litwareinc.com/itchat" @@ -54,14 +55,15 @@ The URL parameter and the parameter value `https://atl-cs-001.litwareinc.com/itc ### -Name +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -70,34 +72,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Url +### -PersistentChatPoolFqdn -URL of the webpage to be displayed by the Persistent Chat add-in. +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name of the Persistent Chat Server pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PersistentChatPoolFqdn +### -Url -Fully qualified domain name of the Persistent Chat Server pool. +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +URL of the webpage to be displayed by the Persistent Chat add-in. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -109,14 +113,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatAddin cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject The New-CsPersistentChatAddin cmdlet creates new instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatCategory.md similarity index 90% rename from skype/skype-ps/skype/New-CsPersistentChatCategory.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatCategory.md index 807ee1f92c..fa822cfd9e 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatCategory.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: New-CsPersistentChatCategory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatcategory +schema: 2.0.0 +title: New-CsPersistentChatCategory --- # New-CsPersistentChatCategory @@ -46,7 +47,7 @@ Skype for Business Server Control Panel: To create a new Persistent Chat categor ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatCategory -Name "HelpDesk" -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" -EnableFileUpload @@ -58,32 +59,17 @@ In this example, file upload is enabled (by including the parameter EnableFileUp ## PARAMETERS -### -Name -Name given to the Persistent Chat category. -Names must be unique per Persistent Chat pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Description Additional text accompanying the Persistent Chat category. For example, the Description might explain the purpose of the category and what type of rooms you can expect to find within the category. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -93,13 +79,15 @@ Accept wildcard characters: False ``` ### -EnableFileUpload + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, allows file uploads to the chat rooms in the category. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -109,14 +97,16 @@ Accept wildcard characters: False ``` ### -EnableInvitations + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When this parameter is included, Invitations will be enabled for the category. Among other things, this means that users on the AllowedMembers list will automatically receive an invitation to join a new chat room at the time that new room is created. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -125,14 +115,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Name given to the Persistent Chat category. +Names must be unique per Persistent Chat pool. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name of the Persistent Chat pool where the category should be created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -142,14 +153,16 @@ Accept wildcard characters: False ``` ### -RemoveChatHistory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When this parameter is included, the chat history feature will be disabled for the new category. Typically, chat history is only disabled for chat rooms that are used for announcements that are posted once and then never need to be referred to again. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -163,13 +176,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatCategory cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject The New-CsPersistentChatCategory cmdlet creates new instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatComplianceConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatComplianceConfiguration.md index 98ea85b68d..ebf55e5526 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatComplianceConfiguration.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: New-CsPersistentChatComplianceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatcomplianceconfiguration +schema: 2.0.0 +title: New-CsPersistentChatComplianceConfiguration --- # New-CsPersistentChatComplianceConfiguration @@ -43,7 +44,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatComplianceConfiguration -Identity "site:Redmond" -AddUserDetails $True -AddChatRoomDetails $True @@ -53,7 +54,7 @@ The command shown in Example 1 creates a new collection of Persistent Chat compl In this example, both the AddUserDetails and the AddChatRoomDetails properties are set to True ($True). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsPersistentChatComplianceConfiguration -Identity "site:Redmond" -RunInterval "00:30:00" @@ -65,39 +66,17 @@ In this example, the RunInterval property is set to 30 minutes; that is, 00 hour ## PARAMETERS -### -Identity -Unique identifier for the new Persistent Chat compliance settings being created. -New compliance settings can be created at either the site or the service scope (for the Persistent Chat Server service, only). -To create new settings at the site scope, use syntax similar to this: - -`-Identity "site:Redmond"` - -To create new settings at the service scope, use syntax like this: - -`-Identity "service:PersistentChatServer:atl-gc-001.litwareinc.com"` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -AdapterName -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -AdapterName Name of the Persistent Chat adapters used by the compliance settings. Adapters are third-party products that convert the data in the compliance database to a specific format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -107,14 +86,16 @@ Accept wildcard characters: False ``` ### -AdapterOutputDirectory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full path to the folder where adapter data is stored. You must have a separate folder for each adapter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -125,6 +106,8 @@ Accept wildcard characters: False ### -AdapterType +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies the fully qualified name of a .Net managed type that implements the Microsoft.Rtc.Internal.Chat.Server.Compliance.IComplianceAdapter interface. This adapter is supplied by a third-party or can be set to the internal XML adapter, "Microsoft.Rtc.Internal.Chat.Server.Compliance.XmlAdapter,compliance". @@ -133,8 +116,7 @@ If you do not specify an adapter type Persistent Chat will not save compliance d ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -145,6 +127,8 @@ Accept wildcard characters: False ### -AddChatRoomDetails +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, additional details about each chat room are provided to the adapter. This has the potential to greatly increase the size of the compliance data. @@ -153,8 +137,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -165,6 +148,8 @@ Accept wildcard characters: False ### -AddUserDetails +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, additional details about each chat room user are provided to the adapter. This has the potential to greatly increase the size of the compliance data. @@ -173,24 +158,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -201,14 +169,15 @@ Accept wildcard characters: False ### -CreateFileAttachmentsManifest +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -219,13 +188,14 @@ Accept wildcard characters: False ### -CustomConfiguration +> Applicable: Lync Server 2013, Skype for Business Server 2015 + XSLT transform script that enables Persistent Chat to save compliance data in a custom format of your design. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -235,13 +205,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -250,15 +222,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique identifier for the new Persistent Chat compliance settings being created. +New compliance settings can be created at either the site or the service scope (for the Persistent Chat Server service, only). +To create new settings at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +To create new settings at the service scope, use syntax like this: + +`-Identity "service:PersistentChatServer:atl-gc-001.litwareinc.com"` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -268,14 +268,16 @@ Accept wildcard characters: False ``` ### -OneChatRoomPerOutputFile + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, separate reports are created for each chat room. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -285,6 +287,9 @@ Accept wildcard characters: False ``` ### -RunInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Amount of time that the server waits before generating the next output file. The RunInterval must be specified using the format days.hours:minutes:seconds. For example, to specify a RunInterval of 30 minutes (the default value) use this syntax: @@ -297,8 +302,25 @@ The default value is 15 minutes (00:15:00). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -308,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -328,13 +352,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatComplianceConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration The New-CsPersistentChatComplianceConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsPersistentChatConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatConfiguration.md index ede3df5de1..e647faf83c 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatConfiguration.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: New-CsPersistentChatConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatconfiguration +schema: 2.0.0 +title: New-CsPersistentChatConfiguration --- # New-CsPersistentChatConfiguration @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: To create a new collection of Persisten ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatConfiguration -Identity "site:Redmond" -ParticipantUpdateLimit 100 @@ -51,38 +52,38 @@ In this example, the ParticipantUpdateLimit property is set to 100. ## PARAMETERS -### -Identity -Unique identifier for the new Persistent Chat configuration settings being created. -New configuration settings can be created at either the site or the service scope (for the Persistent Chat Server service, only). -To create new settings at the site scope, use syntax similar to this: +### -DefaultChatHistory -`-Identity "site:Redmond"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -To create new settings at the service scope, use syntax like this: +Default number of chat messages instantly available in a chat room. +Note that this value represents only the number of messages immediately available; it does not place a limit on the total amount of messages that can be retrieved. -`-Identity "service:PersistentChatServer:atl-gc-001.litwarein.com"` +DefaultChatHistory can be set to any value between 1 and 500, inclusive. +The default value is 30. ```yaml -Type: XdsIdentity +Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -91,51 +92,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultChatHistory -Default number of chat messages instantly available in a chat room. -Note that this value represents only the number of messages immediately available; it does not place a limit on the total amount of messages that can be retrieved. +### -Identity -DefaultChatHistory can be set to any value between 1 and 500, inclusive. -The default value is 30. +> Applicable: Lync Server 2013, Skype for Business Server 2015 -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Unique identifier for the new Persistent Chat configuration settings being created. +New configuration settings can be created at either the site or the service scope (for the Persistent Chat Server service, only). +To create new settings at the site scope, use syntax similar to this: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Identity "site:Redmond"` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +To create new settings at the service scope, use syntax like this: + +`-Identity "service:PersistentChatServer:atl-gc-001.litwarein.com"` ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -145,14 +138,16 @@ Accept wildcard characters: False ``` ### -MaxFileSizeKB + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum size of a file (in kilobytes) that can be uploaded or downloaded by the web service. The default value is 20000 KB. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -162,14 +157,16 @@ Accept wildcard characters: False ``` ### -ParticipantUpdateLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum number of users who can participate in a chat room before the active participant list updates are disabled. The default value is 75. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -179,13 +176,33 @@ Accept wildcard characters: False ``` ### -RoomManagementUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + URL for the Web page that administrators can use to manage individual chat rooms. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -195,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -215,13 +234,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration The New-CsPersistentChatConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatEndpoint.md similarity index 89% rename from skype/skype-ps/skype/New-CsPersistentChatEndpoint.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatEndpoint.md index ea7227eca8..588b1393a2 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatEndpoint.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: New-CsPersistentChatEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatendpoint +schema: 2.0.0 +title: New-CsPersistentChatEndpoint --- # New-CsPersistentChatEndpoint @@ -42,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatEndpoint -SipAddress "sip:pce@litwareinc.com" -PersistentChatPoolFqdn "atl-pcpool-001.litwareinc.com" -DisplayName "Persistent Chat Endpoint 1" ``` @@ -54,88 +55,97 @@ This new endpoint has the SIP address "sip:pce@litwareinc.com" and the display n ## PARAMETERS -### -PersistentChatPoolFqdn -Fully qualified domain name of the Persistent Chat pool that the new endpoint will be associated with. -For example: +### -DisplayName -`-PersistentChatPoolFqdn "atl-pc-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Active Directory display name for the new contact object. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress - -Unique identifier that allows the endpoint to communicate with 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:pcEndpoint1@litwareinc.com"` +### -PassThru +> Applicable: Lync Server 2013, Skype for Business Server 2015 +Enables you to pass a contact object through the pipeline that represents the new Persistent Chat endpoint. +By default, the New-CsPersistentChatEndpoint cmdlet does not pass objects through the pipeline. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name of the Persistent Chat pool that the new endpoint will be associated with. +For example: + +`-PersistentChatPoolFqdn "atl-pc-001.litwareinc.com"` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Active Directory display name for the new contact object. +### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique identifier that allows the endpoint to communicate with 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:pcEndpoint1@litwareinc.com"` + + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a contact object through the pipeline that represents the new Persistent Chat endpoint. -By default, the New-CsPersistentChatEndpoint cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -145,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -165,13 +177,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatEndpoint cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSPersistentChatContact The New-CsPersistentChatEndpoint cmdlet creates new instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSPersistentChatContact class. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatPolicy.md similarity index 90% rename from skype/skype-ps/skype/New-CsPersistentChatPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatPolicy.md index 24a866881d..f4e345e4e0 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatPolicy.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: New-CsPersistentChatPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatpolicy +schema: 2.0.0 +title: New-CsPersistentChatPolicy --- # New-CsPersistentChatPolicy @@ -44,7 +45,7 @@ Skype for Business Server Control Panel: To create a new Persistent Chat policy ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatPolicy -Identity "RedmondPersistentChatPolicy" -EnablePersistentChat $True @@ -54,7 +55,7 @@ The command shown in Example 1 creates a new per-user Persistent Chat policy wit In this example, Persistent Chat is enabled by using the parameter EnablePersistentChat and the parameter value $True. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsPersistentChatPolicy -Identity "site:Redmond" -EnablePersistentChat $True @@ -66,46 +67,36 @@ That's done by setting the Identity to the string value "site:" followed by the ## PARAMETERS -### -Identity - -Unique identifier to be assigned to the policy. -New Persistent Chat policies can be created at the site scope or the 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 SalesPersistentChatPolicy` - -Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsPersistentChatPolicy 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-CsPersistentChatPolicy cmdlet. +### -Description +> Applicable: Lync Server 2013, Skype for Business Server 2015 +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: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EnablePersistentChat + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +When set to True, users affected by the policy will be allowed to use Persistent Chat. +When set to False (the default value) users affected by the policy will not be allowed to use Persistent Chat. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -114,15 +105,16 @@ 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. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -131,31 +123,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePersistentChat -When set to True, users affected by the policy will be allowed to use Persistent Chat. -When set to False (the default value) users affected by the policy will not be allowed to use Persistent Chat. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique identifier to be assigned to the policy. +New Persistent Chat policies can be created at the site scope or the 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 SalesPersistentChatPolicy` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsPersistentChatPolicy 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-CsPersistentChatPolicy cmdlet. + + ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None 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. +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -164,15 +175,23 @@ 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. +### -Tenant + +> Applicable: Skype for Business Server 2015 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new Persistent Chat 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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -181,14 +200,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -197,21 +218,16 @@ 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 Persistent Chat policy is being created. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2013, Skype for Business Server 2015 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015 +Aliases: wi Required: False Position: Named @@ -225,13 +241,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy The New-CsPersistentChatPolicy cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatRoom.md similarity index 89% rename from skype/skype-ps/skype/New-CsPersistentChatRoom.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatRoom.md index b387851687..17cf3e47de 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatRoom.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: New-CsPersistentChatRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatroom +schema: 2.0.0 +title: New-CsPersistentChatRoom --- # New-CsPersistentChatRoom @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: To create a new Persistent Chat chat ro ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatRoom -Name "ITChatRoom" -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" -Category "IT" @@ -59,56 +60,43 @@ In this example, the chat room is added to the IT category. ## PARAMETERS -### -Category -Category under which the room is to be created; for example: +### -Addin -`-Category "IT"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -Note that the specified category must already exist or the command will fail. -Categories, which are collections of Persistent Chat chat rooms, can be created by using the New-CsPersistentChatCategory cmdlet. +Name of the Persistent Chat add-in, if any, associated with the chat room. +A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. +Add-ins can be created by using the New-CsPersistentChatAddin cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Name of the new Persistent Chat chat room. -Names must be unique per Persistent Chat pool. +### -Category -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +> Applicable: Lync Server 2013, Skype for Business Server 2015 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Category under which the room is to be created; for example: -### -Addin -Name of the Persistent Chat add-in, if any, associated with the chat room. -A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. -Add-ins can be created by using the New-CsPersistentChatAddin cmdlet. +`-Category "IT"` + +Note that the specified category must already exist or the command will fail. +Categories, which are collections of Persistent Chat chat rooms, can be created by using the New-CsPersistentChatCategory cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -116,13 +104,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables administrators to provide additional information about the new chat room ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -132,14 +122,16 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, the new chat room will be disabled and unavailable for use when it is first created. If this parameter is not used then the new chat room will be enabled and available for immediate use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -149,14 +141,16 @@ Accept wildcard characters: False ``` ### -Invitations + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies whether or not Invitations for the new chat room will be inherited from the category. Among other things, this means that users on the AllowedMembers list will automatically receive an invitation to join a new chat room at the time that new room is created. ```yaml Type: ChatRoomInvitations Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -165,7 +159,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Name of the new Persistent Chat chat room. +Names must be unique per Persistent Chat pool. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name of the Persistent Chat pool where the new chat room will be located. For example: @@ -174,8 +190,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -Privacy + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Privacy settings for the new chat room. Allowed values are: @@ -195,8 +213,7 @@ Allowed values are: ```yaml Type: ChatRoomPrivacy Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies whether the new chat room should be configured as a Normal chat room (where all members can post messages) or an Auditorium (where only presenters can post messages). For example: @@ -216,8 +236,7 @@ The default value is Normal. ```yaml Type: ChatRoomType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -231,13 +250,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatRoom cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject The New-CsPersistentChatRoom cmdlet creates new instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsPinPolicy.md similarity index 88% rename from skype/skype-ps/skype/New-CsPinPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsPinPolicy.md index 36afdd1b3c..3f5da09609 100644 --- a/skype/skype-ps/skype/New-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPinPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPinPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspinpolicy +schema: 2.0.0 +title: New-CsPinPolicy --- # New-CsPinPolicy @@ -43,7 +44,7 @@ However, you cannot create a second global PIN policy; all you can do is modify ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsPinPolicy -Identity "site:Redmond" -MinPasswordLength 10 @@ -54,7 +55,7 @@ This command includes just one optional parameter, MinPasswordLength, which is u All the remaining policy properties will be configured using the default values. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsPinPolicy -Identity "site:Redmond" -MinPasswordLength 10 -PINHistoryCount 10 -PINLifetime 30 @@ -64,7 +65,7 @@ The command shown in Example 2 creates a new policy with the Identity site:Redmo This command uses the parameters MinPasswordLength, PINHistoryCount, and PINLifetime to explicitly configure three different property values for the new policy. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CsPinPolicy -Identity "site:Redmond" -InMemory @@ -87,7 +88,7 @@ After all the properties have been configured, the Set-CsPinPolicy cmdlet is use After the Set-CsPinPolicy cmdlet has been called, you will be able to view the policy and its property values by using the Get-CsPinPolicy cmdlet. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` $x = Get-CsPinPolicy -Identity "site:Redmond" @@ -106,8 +107,70 @@ The net result is that the value of the MinPasswordLength property will be copie ## PARAMETERS +### -AllowCommonPatterns + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not "common patterns" are allowed in PINs. +Common patterns include repeating digits (222222); four or more consecutive digits (123456); and PINs that match a user's phone number or extension number. +If set to True common patterns (such as the PIN 456789, which includes consecutive digits) are allowed; if set to False common patterns are not allowed. +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 +``` + +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide explanatory text to accompany a PIN policy. +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique Identity to be assigned to the policy. PIN policies can be created at the site or per-user scope. To create a policy at the site scope, use syntax similar to this: @@ -123,8 +186,7 @@ To create a policy at the per-user scope, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -133,15 +195,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany a PIN policy. -For example, the Description might include information about the users the policy should be assigned to. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +218,8 @@ Accept wildcard characters: False ### -MaximumLogonAttempts +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of sequential logon failures that are allowed before a user's PIN is automatically locked. Logon failures are counted in two different ways: local logon failures and global logon failures. When a user first tries to logon, a new 30 minute observation window starts; each failed logon during that 30 minute window is recorded as both a local logon failure and a global logon failure. @@ -180,8 +248,7 @@ This typically provides the most security. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,6 +258,9 @@ Accept wildcard characters: False ``` ### -MinPasswordLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The minimum allowed length (that is, the minimum number of digits) in a PIN. For example, if MinPasswordLength is set to 8 then a PIN of 1259 will be rejected because that PIN only has 4 digits. PIN lengths must have at least 4 digits but no more than 24 digits; the default value is 5. @@ -198,8 +268,7 @@ PIN lengths must have at least 4 digits but no more than 24 digits; the default ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,6 +278,9 @@ Accept wildcard characters: False ``` ### -PINHistoryCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often users are allowed to reuse the same PIN. For example, if the PINHistoryCount is set to 3, then the first three times a user resets his or her PIN they must use a new PIN; on the fourth reset, they can reuse their first PIN. (And, on the fifth reset, they can reuse their second PIN, and so on.) The PIN history count can be any whole number between 0 and 20, inclusive; 0 means that users can use the same PIN number over and over again. @@ -220,8 +292,7 @@ For example, you cannot set PINLifetime to 30 and leave PINHistoryCount at 0. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,6 +302,9 @@ Accept wildcard characters: False ``` ### -PINLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the length of time (in days) that a PIN remains valid; after the PIN lifetime expires users must select a new PIN number before they will be allowed to use PIN authentication to gain access to the system. PINLifetime can be set to any whole number between 0 and 999, inclusive; 0 indicates that PIN numbers never expire. By default, the PIN lifetime is set to 0 days. @@ -240,8 +314,7 @@ If you set the PINLifetime to a value greater than 0 then you must also set the ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -250,34 +323,23 @@ 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 Server 2015, Skype for Business Server 2019 +### -Tenant -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -InMemory +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new PIN policy is being created. +For example: -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-\. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -286,52 +348,16 @@ 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 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 -``` - -### -AllowCommonPatterns - -Indicates whether or not "common patterns" are allowed in PINs. -Common patterns include repeating digits (222222); four or more consecutive digits (123456); and PINs that match a user's phone number or extension number. -If set to True common patterns (such as the PIN 456789, which includes consecutive digits) are allowed; if set to False common patterns are not allowed. -The default value is 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 Required: False Position: Named @@ -340,21 +366,16 @@ 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 PIN policy is being created. -For example: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -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 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -368,13 +389,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPinPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy Creates a new instance of the Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/New-CsPlatformServiceSettings.md similarity index 81% rename from skype/skype-ps/skype/New-CsPlatformServiceSettings.md rename to skype/skype-ps/SkypeForBusiness/New-CsPlatformServiceSettings.md index a469445901..223b84ddae 100644 --- a/skype/skype-ps/skype/New-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPlatformServiceSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPlatformServiceSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csplatformservicesettings +schema: 2.0.0 +title: New-CsPlatformServiceSettings --- # New-CsPlatformServiceSettings @@ -32,7 +33,7 @@ The `New-CsPlatformServiceSettings` cmdlet gives you the ability to create a new ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> New-CsPlatformServiceSettings -Identity NewPSS -EnableDelegateManagement $True -EnableExternalAccessCheck $True ``` @@ -41,30 +42,16 @@ This example creates a new Platform Service Settings configuration and enables d ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableCORS -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableCORS This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -74,13 +61,15 @@ Accept wildcard characters: False ``` ### -EnableDelegateManagement + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables the ability to manage delegates from the Skype for Business on Mac client. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -90,13 +79,15 @@ Accept wildcard characters: False ``` ### -EnableE911 + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows Skype for Business on Mac users to call 911. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,13 +97,15 @@ Accept wildcard characters: False ``` ### -EnableExternalAccessCheck + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to use external access policies to block external access to Skype for Business on Mac users. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -122,13 +115,15 @@ Accept wildcard characters: False ``` ### -EnableFileTransfer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables Skype for Business on Mac users send files in peer-to-peer chats. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -138,13 +133,15 @@ Accept wildcard characters: False ``` ### -EnablePushNotifications + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables Skype for Business on Mac clients to use push notifications. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -154,13 +151,15 @@ Accept wildcard characters: False ``` ### -EnableUcwaScopeCheck + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -170,13 +169,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before testing. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -186,6 +187,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the Platform Service Settings to be created. To create a new collection of settings at the site scope, use syntax similar to this: @@ -196,7 +200,7 @@ To create new settings at the service scope, use syntax like this: `-Identity service:WebServer:atl-cs-001.litwareinc.com` -Privacy settings can only be created for the WebServer service. +Privacy settings can only be created for the WebServer service. An error will occur if you try to apply these settings to any other service. Note that your command will fail if Platform Service Settings already exist for the specified site or service. @@ -206,7 +210,6 @@ Likewise, your command will fail if you attempt to create a new collection of gl Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -216,6 +219,9 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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-CsPlatformServiceSettings. @@ -223,7 +229,6 @@ If you assign the output of this cmdlet called with this parameter to a variable Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -233,13 +238,15 @@ Accept wildcard characters: False ``` ### -MaxRegistrationsPerPublicApplication + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -249,13 +256,33 @@ Accept wildcard characters: False ``` ### -UseLegacyPushNotifications + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean 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 +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -265,6 +292,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -272,7 +302,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -297,8 +326,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsPresencePolicy.md similarity index 88% rename from skype/skype-ps/skype/New-CsPresencePolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsPresencePolicy.md index 3fbe18e8f8..18c6a6033b 100644 --- a/skype/skype-ps/skype/New-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPresencePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPresencePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspresencepolicy +schema: 2.0.0 +title: New-CsPresencePolicy --- # New-CsPresencePolicy @@ -55,7 +56,7 @@ Note that you cannot create a new presence policy at the global scope, nor can y ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsPresencePolicy -Identity "RedmondPresencePolicy" -MaxPromptedSubscriber 400 -MaxCategorySubscription 500 @@ -65,7 +66,7 @@ The command shown in Example 1 creates a new per-user presence policy with the I In this example, the value of the MaxPromptedSubscriber property is set to 400 and the value of the MaxCategorySubscription property is set to 500. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsPresencePolicy -Identity "RedmondPresencePolicy" -InMemory @@ -88,46 +89,37 @@ This final step is crucial: if you do not call the Set-CsPresencePolicy cmdlet t ## PARAMETERS -### -Identity - -Unique identifier for the new presence policy. -To create a new per-user policy, use syntax similar to this: - -`-Identity "RedmondPresencePolicy"` - -To create a new policy at the site scope, use syntax similar to this: +### -Description -`-Identity "site:Redmond"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot create a new presence policy at the global scope. -In addition, your command will fail if the site in question already hosts a presence policy, or if you try to use the Identity of a per-user policy that already exists. +Enables administrators to provide additional text to accompany a presence policy. +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxCategorySubscription -The maximum number of category subscriptions allowed at any one time. -A category subscription represents a request for a specific category of information; for example, an application that requests calendar data. +### -Force -MaxCategorySubscription can be set to any integer value between 0 and 3000; the default value is 1000. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,35 +128,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxPromptedSubscriber -The maximum number of promoted subscribers a user can have at any one time. -By default, any time you are added to another user's Contacts list a notification dialog appears on screen informing you of this fact, and giving you the chance to do such things as add the person to your own Contacts list or block the person from viewing your presence. -Until you take action and dismiss the dialog box, each notification counts as a prompted subscriber. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new presence policy. +To create a new per-user policy, use syntax similar to this: + +`-Identity "RedmondPresencePolicy"` + +To create a new policy at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +Note that you cannot create a new presence policy at the global scope. +In addition, your command will fail if the site in question already hosts a presence policy, or if you try to use the Identity of a per-user policy that already exists. + -MaxPromptedSubscriber can be set to any integer value between 0 and 600, inclusive; the default value is 200. -If you set this value to 0, users will not receive any notifications when they are added to another user's Contacts list. ```yaml -Type: UInt16 +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None 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. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,18 +179,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -MaxCategorySubscription -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The maximum number of category subscriptions allowed at any one time. +A category subscription represents a request for a specific category of information; for example, an application that requests calendar data. +MaxCategorySubscription can be set to any integer value between 0 and 3000; the default value is 1000. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,14 +200,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxPromptedSubscriber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum number of promoted subscribers a user can have at any one time. +By default, any time you are added to another user's Contacts list a notification dialog appears on screen informing you of this fact, and giving you the chance to do such things as add the person to your own Contacts list or block the person from viewing your presence. +Until you take action and dismiss the dialog box, each notification counts as a prompted subscriber. + +MaxPromptedSubscriber can be set to any integer value between 0 and 600, inclusive; the default value is 200. +If you set this value to 0, users will not receive any notifications when they are added to another user's Contacts list. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,14 +223,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new presence 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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,18 +248,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description - -Enables administrators to provide additional text to accompany a presence policy. -For example, the Description might include information about the users the policy should be assigned to. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -245,21 +266,16 @@ 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 presence policy is being created. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -273,13 +289,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPresencePolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy The New-CsPresencePolicy cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsPresenceProvider.md similarity index 88% rename from skype/skype-ps/skype/New-CsPresenceProvider.md rename to skype/skype-ps/SkypeForBusiness/New-CsPresenceProvider.md index a7723a9ad6..a1348d9178 100644 --- a/skype/skype-ps/skype/New-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPresenceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPresenceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspresenceprovider +schema: 2.0.0 +title: New-CsPresenceProvider --- # New-CsPresenceProvider @@ -46,7 +47,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPresenceProvider -Parent "global" -Fqdn "fabrikam.com" @@ -55,7 +56,7 @@ New-CsPresenceProvider -Parent "global" -Fqdn "fabrikam.com" The command shown in Example 1 creates a new presence provider (with the fully qualified domain name "fabrikam.com") that will be added to the global collection of user services configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUserServicesConfiguration | ForEach-Object {New-CsPresenceProvider -Parent $_.Identity -Fqdn "fabrikam.com"} @@ -68,7 +69,28 @@ Those settings are then piped to the ForEach-Object, which takes each item in th ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Fqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name for the presence provider. For example: @@ -82,8 +104,7 @@ Note that FQDNs must be unique at a given scope. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -93,6 +114,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new presence provider. The Identity of a presence provider is composed of two parts: the scope (Parent) where the rule has been applied (for example, service:UserServer:atl-cs-001.litwareinc.com) and the provider's fully qualified domain name. To create a new provider at the global scope use syntax similar to this: @@ -112,8 +136,7 @@ You cannot use the Identity parameter in the same command as the Fqdn or the Par ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -122,7 +145,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Parent + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope where the new presence provider will be created. To create a new presence provider at the global scope, use syntax similar to this: @@ -142,8 +187,7 @@ However, the Parent parameter cannot be used in conjunction with the Identity pa ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -153,29 +197,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -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 -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -184,31 +214,16 @@ 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -222,13 +237,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPresenceProvider cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated The New-CsPresenceProvider cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPrivacyConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsPrivacyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsPrivacyConfiguration.md index 73c2badb7b..cc569bfb5f 100644 --- a/skype/skype-ps/skype/New-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPrivacyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csprivacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPrivacyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csprivacyconfiguration +schema: 2.0.0 +title: New-CsPrivacyConfiguration --- # New-CsPrivacyConfiguration @@ -50,7 +51,7 @@ The New-CsPrivacyConfiguration cmdlet enables you to create new privacy configur ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsPrivacyConfiguration -Identity site:Redmond -EnablePrivacyMode $True @@ -61,7 +62,7 @@ The new settings enable privacy mode; this is done by adding the EnablePrivacyMo Note that this command will fail if the Redmond site already has a collection of privacy settings. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsPrivacyConfiguration -Identity site:Redmond -InMemory @@ -82,40 +83,10 @@ Calling the Set-CsPrivacyConfiguration cmdlet is critical: if you fail to call t ## PARAMETERS -### -Identity - -Unique identifier for the privacy configuration settings to be created. -To create a new collection of settings at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To create new settings at the service scope, use syntax like this: - -`-Identity service:UserServer:atl-cs-001.litwareinc.com` - -Privacy settings can only be created for the User Server service. -An error will occur if you try to apply these settings to any other service. - -Note that your command will fail if privacy configuration settings already exist for the specified site or service. -Likewise, your command will fail if you attempt to create a new collection of global settings. - - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AutoInitiateContacts +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, Skype for Business will automatically add your manager and your direct reports to your Contacts list. The default value is True. @@ -124,8 +95,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +106,8 @@ Accept wildcard characters: False ### -DisplayPublishedPhotoDefault +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, the user's photo will automatically be published in Skype for Business. If False, the user's photo will not be available unless he or she explicitly selects the option Let others see my photo. The default value is True. @@ -145,8 +117,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +127,9 @@ Accept wildcard characters: False ``` ### -EnablePrivacyMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, gives users the opportunity to enable the advanced privacy mode. In advanced privacy mode, only people on your Contacts list will be allowed to view your presence information. If False, your presence information will be available to anyone in your organization. @@ -164,8 +138,7 @@ The default value is 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 +Aliases: Required: False Position: Named @@ -174,19 +147,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PublishLocationDataDefault - -If True, location data will automatically be published in Skype for Business. -If False, location data will not be available unless the user explicitly selects the option Show Contacts My Location. -The default value is True. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,17 +165,34 @@ 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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the privacy configuration settings to be created. +To create a new collection of settings at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To create new settings at the service scope, use syntax like this: + +`-Identity service:UserServer:atl-cs-001.litwareinc.com` + +Privacy settings can only be created for the User Server service. +An error will occur if you try to apply these settings to any other service. + +Note that your command will fail if privacy configuration settings already exist for the specified site or service. +Likewise, your command will fail if you attempt to create a new collection of global settings. + + ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -213,6 +200,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -221,8 +210,29 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishLocationDataDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, location data will automatically be published in Skype for Business. +If False, location data will not be available unless the user explicitly selects the option Show Contacts My Location. +The default value is True. + + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -233,6 +243,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new privacy configuration settings are being created. For example: @@ -247,8 +259,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,14 +268,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -273,14 +286,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -294,13 +309,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPrivacyConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration The New-CsPrivacyConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsProxyConfiguration.md similarity index 81% rename from skype/skype-ps/skype/New-CsProxyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsProxyConfiguration.md index 2d9e20f244..b6f4e42f3c 100644 --- a/skype/skype-ps/skype/New-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsProxyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsProxyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csproxyconfiguration +schema: 2.0.0 +title: New-CsProxyConfiguration --- # New-CsProxyConfiguration @@ -48,7 +49,7 @@ These new collections are created by using the New-CsProxyConfiguration cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsProxyConfiguration -Identity "service:EdgeServer:atl-edge-001.litwareinc.com" -RequestServerCompression $True -MaxClientMessageBodySizeKb 256 @@ -59,7 +60,7 @@ These new settings use all the default proxy server property values except for t Note that this command will fail if proxy server settings have already been configured for the service EdgeServer:atl-edge-001.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsProxyConfiguration -Identity "service:EdgeServer:atl-edge-001.litwareinc.com" -InMemory @@ -83,38 +84,34 @@ If you do not call the Set-CsProxyConfiguration cmdlet, no settings will be appl ## PARAMETERS -### -Identity - -Unique identifier for the proxy server configuration settings to be created. -Proxy server configuration settings can only be created at the service scope, and only for the Edge Server and Registrar services. -You cannot create settings at the global scope; likewise, you cannot create settings at the service scope if the service in question already hosts a collection of proxy server settings. -For example, if the service Registrar:atl-cs-001.litwareinc.com already hosts proxy server settings, then any command that attempts to create new settings for that service will fail. +### -AcceptClientCompression -To specify the Identity for your new proxy server settings, use syntax similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` +When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptClientCompression -When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints. +### -AcceptServerCompression + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), the proxy server will accept all incoming compression requests from other servers. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,14 +120,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptServerCompression -When set to True (the default value), the proxy server will accept all incoming compression requests from other servers. +### -AllowPartnerPollingSubscribes + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set the True, partner applications are allowed to periodically poll the service for state changes. +The default value is False ($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 +Aliases: Required: False Position: Named @@ -139,14 +139,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableWhiteSpaceKeepAlive -When set to True (the default value), the proxy server expects clients to periodically send a "whitespace message" (an empty message with no content) to indicate that the connection is still active. +### -DisableNtlmFor2010AndLaterClients + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users logging on from Skype for Business must use the Kerberos protocol for authentication. +The default value is 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 +Aliases: Required: False Position: Named @@ -155,16 +160,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxClientCompressionCount -Indicates the maximum number of client-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. -The compression count can be set to any integer value between 0 and 65535, inclusive. -The default value is 15000. +### -DnsCacheRecordCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of records that can be maintained in the DNS record cache. +The default value is 3000. + + ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,16 +181,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxServerCompressionCount -Indicates the maximum number of server-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. -The server compression count can be set to any integer value between 0 and 65535, inclusive. -The default value is 1024. +### -EnableLoggingAllMessageBodies + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, Microsoft Lync Server will log the actual content of all instant messages. +For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files. + +The default value is False. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,15 +202,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Realm -Indicates whether or not security credentials are processed by the default proxy server realm (SIP Communications Service) or by a custom realm. -Custom realms must be specified (and created) by using the New-CsSipProxyCustom cmdlet. +### -EnableWhiteSpaceKeepAlive + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), the proxy server expects clients to periodically send a "whitespace message" (an empty message with no content) to indicate that the connection is still active. ```yaml -Type: IRealmChoice +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,14 +220,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestServerCompression -When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,31 +238,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TreatAllClientsAsRemote -When set to True, the proxy server functions as if all client connections are external connections that pass through the Edge Server running the Access Edge service. -The default value is False. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the proxy server configuration settings to be created. +Proxy server configuration settings can only be created at the service scope, and only for the Edge Server and Registrar services. +You cannot create settings at the global scope; likewise, you cannot create settings at the service scope if the service in question already hosts a collection of proxy server settings. +For example, if the service Registrar:atl-cs-001.litwareinc.com already hosts proxy server settings, then any command that attempts to create new settings for that service will fail. + +To specify the Identity for your new proxy server settings, use syntax similar to this: + +`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UseCertificateForClientToProxyAuth -When set to True (the default value), client endpoints will be allowed to use certificates for authentication. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,18 +284,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseKerberosForClientToProxyAuth - -When set to True (the default value), client endpoints will be allowed to use the Kerberos protocol for authentication. -Although Kerberos is a more secure protocol than NTLM, it cannot be used if the client belongs to a different realm than the server. +### -LoadBalanceEdgeServers +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When True, software load balancing is employed for requests to Edge Servers. +The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,16 +303,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNtlmForClientToProxyAuth -When set to True (the default value), client endpoints will be allowed to use the NTLM protocol for authentication. -Although NTLM is a less secure protocol than Kerberos, NTLM can be used if the client belongs to a different domain than the server. -That is not true for Kerberos authentication. +### -LoadBalanceInternalServers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When True, software load balancing is employed for requests to Registrars and other internal servers. +The default value is true ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -295,14 +322,18 @@ 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. +### -MaxClientCompressionCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of client-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. +The compression count can be set to any integer value between 0 and 65535, inclusive. +The default value is 15000. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -311,18 +342,18 @@ 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-\. +### -MaxClientMessageBodySizeKb +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. +The default value is 128, meaning that messages with a body size larger than 128 KB will be rejected. +The client message body size can be set to any integer value between 64 and 256, inclusive. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -331,14 +362,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxKeepAliveInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in minutes) that can elapse before the server verifies that the connection with the client is still valid. +The default value is 20 minutes. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -347,14 +381,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxServerCompressionCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of server-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. +The server compression count can be set to any integer value between 0 and 65535, inclusive. +The default value is 1024. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -363,18 +401,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableNtlmFor2010AndLaterClients - -When set to True, users logging on from Skype for Business must use the Kerberos protocol for authentication. -The default value is False. +### -MaxServerMessageBodySizeKb +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The maximum-allowed size (in kilobytes) for the body of a message sent from another server. +The default value is 5000, meaning that messages with a body size larger than 5000 KB will be rejected. +The server message body size can be set to any integer value between 1000 and 20000, inclusive. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -383,18 +421,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DnsCacheRecordCount - -Maximum number of records that can be maintained in the DNS record cache. -The default value is 3000. +### -OutgoingTlsCount +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each internal server. +The minimum number of TLS connections is 1, and the maximum number is 4. +By default, OutgoingTlsCount is set to 4. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -403,16 +441,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxClientMessageBodySizeKb -The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. -The default value is 128, meaning that messages with a body size larger than 128 KB will be rejected. -The client message body size can be set to any integer value between 64 and 256, inclusive. +### -Realm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not security credentials are processed by the default proxy server realm (SIP Communications Service) or by a custom realm. +Custom realms must be specified (and created) by using the New-CsSipProxyCustom cmdlet. ```yaml -Type: UInt32 +Type: IRealmChoice Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -421,16 +460,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxServerMessageBodySizeKb -The maximum-allowed size (in kilobytes) for the body of a message sent from another server. -The default value is 5000, meaning that messages with a body size larger than 5000 KB will be rejected. -The server message body size can be set to any integer value between 1000 and 20000, inclusive. +### -RequestServerCompression + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -439,16 +478,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutgoingTlsCount -Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each internal server. -The minimum number of TLS connections is 1, and the maximum number is 4. -By default, OutgoingTlsCount is set to 4. +### -SpecialConfigurationList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -457,15 +496,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPartnerPollingSubscribes -When set the True, partner applications are allowed to periodically poll the service for state changes. -The default value is False ($False). +### -TestFeatureList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used by Skype for Business Server. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -474,17 +514,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLoggingAllMessageBodies -When set to True, Microsoft Lync Server will log the actual content of all instant messages. -For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files. +### -TestParameterList -The default value is False. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used by Skype for Business Server. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -493,15 +532,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoadBalanceEdgeServers -When True, software load balancing is employed for requests to Edge Servers. -The default value is True ($True). +### -TreatAllClientsAsRemote + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the proxy server functions as if all client connections are external connections that pass through the Edge Server running the Access Edge service. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -510,15 +551,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoadBalanceInternalServers -When True, software load balancing is employed for requests to Registrars and other internal servers. -The default value is true ($True). +### -UseCertificateForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use certificates for authentication. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -527,15 +569,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxKeepAliveInterval -Specifies the amount of time (in minutes) that can elapse before the server verifies that the connection with the client is still valid. -The default value is 20 minutes. +### -UseKerberosForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use the Kerberos protocol for authentication. +Although Kerberos is a more secure protocol than NTLM, it cannot be used if the client belongs to a different realm than the server. + + ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -544,14 +590,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpecialConfigurationList -PARAMVALUE: String +### -UseNtlmForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use the NTLM protocol for authentication. +Although NTLM is a less secure protocol than Kerberos, NTLM can be used if the client belongs to a different domain than the server. +That is not true for Kerberos authentication. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -560,14 +610,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TestFeatureList -This parameter is not currently used by Skype for Business Server. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -576,14 +628,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TestParameterList -This parameter is not currently used by Skype for Business Server. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -597,13 +651,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsProxyConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings The New-CsProxyConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsPublicProvider.md similarity index 86% rename from skype/skype-ps/skype/New-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/New-CsPublicProvider.md index 3350062fcf..6b3ff1c9ff 100644 --- a/skype/skype-ps/skype/New-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspublicprovider +schema: 2.0.0 +title: New-CsPublicProvider --- # New-CsPublicProvider @@ -48,7 +49,7 @@ Note that you cannot federate with a public provider if your Edge servers are co ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsPublicProvider -Identity "Fabrikam" -ProxyFqdn "proxyserver.fabrikam.com" -Enabled $True @@ -58,7 +59,7 @@ The command shown in Example 1 creates a new federation relationship with a publ In addition to specifying the Identity, two other property values (and their corresponding parameters) must be set: ProxyFqdn (set to proxyserver.fabrikam.com) and Enabled (which, in this case, is set to True). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsPublicProvider -Identity "Fabrikam" -ProxyFqdn "proxyserver.fabrikam.com" -Enabled $True -InMemory @@ -80,101 +81,75 @@ In turn, the virtual provider will disappear the moment you end your Windows Pow ## PARAMETERS -### -Identity +### -Enabled -Unique identifier for the public provider to be created. -The Identity typically the name of the website providing the services. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Identities must be unique not only among public providers, but also among hosting providers. -Suppose you try to create a new public provider with the Identity Fabrikam. -Your command will fail if a public provider or a hosting provider with that Identity already exists. +Indicates whether or not the federation relationship between your organization and the public provider is active. +If set to True, users in your organization will be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. +If set to False, users in your organization will not be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. +You can enable and disable federation relationships at any time by using the Enable-CsPublicProvider cmdlet and the Disable-CsPublicProvider cmdlet, respectively. ```yaml -Type: XdsGlobalRelativeIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyFqdn -Specifies the fully qualified domain name (FQDN) (for example, proxyserver.fabrikam.com) of the proxy server used by the public provider. +### -EnableSkypeDirectorySearch -Proxy FQDNs must be unique not only among public providers, but also among hosting providers. -For example, suppose you try to create a new public provider with the proxy FQDN proxyserver.fabrikam.com. -This command will fail if a public provider or a hosting provider with that proxy FQDN already exists. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled - -Indicates whether or not the federation relationship between your organization and the public provider is active. -If set to True, users in your organization will be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. -If set to False, users in your organization will not be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. -You can enable and disable federation relationships at any time by using the Enable-CsPublicProvider cmdlet and the Disable-CsPublicProvider cmdlet, respectively. +### -EnableSkypeIdRouting +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: $true | $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 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VerificationLevel - -Indicates how (or if) messages sent from a public provider are verified to ensure that they were sent from that provider. -The VerificationLevel must be set to one of the following values: - -AlwaysVerifiable. -All messages purportedly sent from this provider will be accepted. -If a verification header is not found in the message it will be added by Skype for Business Server. -This is the default value. - -AlwaysUnverifiable. -All messages purportedly sent from a public provider are considered unverified. -They will be delivered only if they were sent from a person who is on the recipient's Contacts list. -For example, if Ken Myer is on your Contacts list you will be able to receive messages from him. -If Pilar Ackerman is not on your Contacts list then you will not be able to receive messages from her. -Note that Skype for Business users can manually override this setting, thereby allowing themselves to receive messages people not on their Contacts list. - -UseSourceVerification. -Uses the verification header added to the message by the public provider. -If the verification information is missing the message will be rejected. -This value has been deprecated for use in Skype for Business Server. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: VerificationLevelType +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,14 +158,16 @@ 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. +### -IconUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the icon used to indicate a Microsoft Skype contact. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,34 +176,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Identity -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the public provider to be created. +The Identity typically the name of the website providing the services. + +Identities must be unique not only among public providers, but also among hosting providers. +Suppose you try to create a new public provider with the Identity Fabrikam. +Your command will fail if a public provider or a hosting provider with that Identity already exists. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 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. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -235,14 +222,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -NameDecorationDomain + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,14 +242,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IconUrl -URL for the icon used to indicate a Microsoft Skype contact. +### -NameDecorationExcludedDomainList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -267,17 +260,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NameDecorationDomain - -PARAMVALUE: String +### -NameDecorationRoutingDomain +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -286,30 +278,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSkypeDirectorySearch -PARAMVALUE: $true | $false +### -ProxyFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the fully qualified domain name (FQDN) (for example, proxyserver.fabrikam.com) of the proxy server used by the public provider. + +Proxy FQDNs must be unique not only among public providers, but also among hosting providers. +For example, suppose you try to create a new public provider with the proxy FQDN proxyserver.fabrikam.com. +This command will fail if a public provider or a hosting provider with that proxy FQDN already exists. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSkypeIdRouting -PARAMVALUE: $true | $false +### -VerificationLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates how (or if) messages sent from a public provider are verified to ensure that they were sent from that provider. +The VerificationLevel must be set to one of the following values: + +AlwaysVerifiable. +All messages purportedly sent from this provider will be accepted. +If a verification header is not found in the message it will be added by Skype for Business Server. +This is the default value. + +AlwaysUnverifiable. +All messages purportedly sent from a public provider are considered unverified. +They will be delivered only if they were sent from a person who is on the recipient's Contacts list. +For example, if Ken Myer is on your Contacts list you will be able to receive messages from him. +If Pilar Ackerman is not on your Contacts list then you will not be able to receive messages from her. +Note that Skype for Business users can manually override this setting, thereby allowing themselves to receive messages people not on their Contacts list. + +UseSourceVerification. +Uses the verification header added to the message by the public provider. +If the verification information is missing the message will be rejected. +This value has been deprecated for use in Skype for Business Server. + + ```yaml -Type: Boolean +Type: VerificationLevelType Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -318,14 +338,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NameDecorationExcludedDomainList -PARAMVALUE: String +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -334,14 +356,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NameDecorationRoutingDomain -PARAMVALUE: String +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -355,13 +379,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPublicProvider cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPushNotificationConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsPushNotificationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsPushNotificationConfiguration.md index 614ff79df4..f77adc63bc 100644 --- a/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPushNotificationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPushNotificationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspushnotificationconfiguration +schema: 2.0.0 +title: New-CsPushNotificationConfiguration --- # New-CsPushNotificationConfiguration @@ -48,7 +49,7 @@ That gives Administrators the ability to provide push notifications to users in ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsPushNotificationConfiguration -Identity "site:Redmond" -EnableApplePushNotificationService $True -EnableMicrosoftPushNotificationService -$True @@ -58,7 +59,7 @@ The command shown in Example 1 creates a new collection of push notification set The latter is done by setting both the EnableApplePushNotificationService and the EnableMicrosoftPushNotificationService properties to True. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsSite | ForEach-Object {New-CsPushNotificationConfiguration -Identity $_.Identity} @@ -70,7 +71,7 @@ That collection is then piped to the ForEach-Object cmdlet, which takes each sit Note that this command will fail for any site that already hosts a collection of push notification configuration settings. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CsPushNotificationConfiguration -Identity "site:Redmond" -InMemory @@ -93,44 +94,10 @@ If you do not call the Set-CsPushNotificationConfiguration cmdlet, these setting ## PARAMETERS -### -Identity -Push notification settings can only be created at the site scope. -To specify a new collection of settings for a site, use syntax similar to this: - -`-Identity "site:Redmond"` - -Note that this command will fail if the Redmond site already hosts a collection of push notification settings. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableApplePushNotificationService -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableApplePushNotificationService When set to True, iPhone users will receive push notifications from the Apple Push Notification Service. When set to False, iPhone users will not receive these notifications. @@ -139,8 +106,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +116,9 @@ Accept wildcard characters: False ``` ### -EnableMicrosoftPushNotificationService + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Windows Phone users will receive push notifications from the Microsoft Push Notification Service. When set to False, Windows Phone users will not receive these notifications. @@ -158,8 +127,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +137,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,15 +154,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Push notification settings can only be created at the site scope. +To specify a new collection of settings for a site, use syntax similar to this: + +`-Identity "site:Redmond"` + +Note that this command will fail if the Redmond site already hosts a collection of push notification settings. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of a command 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,6 +198,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new push notification configuration settings are being created. For example: @@ -217,8 +214,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -228,13 +242,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -248,20 +264,19 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPushNotificationConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration The New-CsPushNotificationConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration object. ## NOTES ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration?view=skype-ps) -[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) +[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspushnotificationconfiguration?view=skype-ps) -[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) +[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsQoEConfiguration.md similarity index 81% rename from skype/skype-ps/skype/New-CsQoEConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsQoEConfiguration.md index 936e584b5d..9ced62415a 100644 --- a/skype/skype-ps/skype/New-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsQoEConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsQoEConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csqoeconfiguration +schema: 2.0.0 +title: New-CsQoEConfiguration --- # New-CsQoEConfiguration @@ -41,7 +42,7 @@ QoE is part of the Monitoring Server role; therefore Monitoring Server must be d ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsQoEConfiguration -Identity site:Redmond -EnableQoE $False @@ -52,7 +53,7 @@ In addition to the Identity site:Redmond, the new settings also have the EnableQ Because site settings take precedence over global settings, this means that QoE will be disabled for the Redmond site, regardless of whether or not QoE has been enabled at the global scope. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsQoEConfiguration -Identity site:Dublin -KeepQoEDataForDays 30 -PurgeHourOfDay 4 @@ -67,27 +68,10 @@ Note: If you have enabled QoE and call detail recording (CDR), for performance r ## PARAMETERS -### -Identity - -The site to which the new settings apply. -This must be entered in the format site:\, where \ is the name of the site in your Skype for Business Server deployment. - - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableExternalConsumer -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableExternalConsumer Specifies whether an external consumer is able to receive QoE reports. Default: False @@ -95,8 +79,7 @@ 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 +Aliases: Required: False Position: Named @@ -106,6 +89,9 @@ Accept wildcard characters: False ``` ### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether records will be purged after the duration defined in the KeepQoEDataForDays property has elapsed. Default: True @@ -113,8 +99,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +109,9 @@ Accept wildcard characters: False ``` ### -EnableQoE + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether QoE records will be collected and saved to the monitoring database. Note that even if EnableQoE is set to True, QoE data will not be collected unless a Monitoring Server has been deployed and associated with a Registrar pool. @@ -133,8 +121,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,13 +131,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerIssuedCertId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The certificate ID of the certificate that allows access to the external consumer web service. ```yaml Type: IssuedCertId Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,13 +149,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The friendly name of the external consumer of the QoE report. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,13 +167,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The URL of the external consumer to which the QoE reports will be posted. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,19 +184,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepQoEDataForDays -The number of days QoE data will be stored before being purged from the database. -This value is ignored if EnablePurging is set to False. +### -Force -Must be a value from 1 through 2562. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: 60 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,34 +202,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PurgeHourOfDay -The hour of day that QoE records that have exceeded the number of days specified in the KeepQoEDataForDays property will be purged. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The site to which the new settings apply. +This must be entered in the format site:\, where \ is the name of the site in your Skype for Business Server deployment. + -Must be a value 0 through 23, representing the hour of the day. -For example, 0 would be midnight, 13 would be 1:00 PM. -Default: 1 ```yaml -Type: UInt32 +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,18 +244,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -KeepQoEDataForDays -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The number of days QoE data will be stored before being purged from the database. +This value is ignored if EnablePurging is set to False. + +Must be a value from 1 through 2562. +Default: 60 ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,14 +267,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The hour of day that QoE records that have exceeded the number of days specified in the KeepQoEDataForDays property will be purged. + +Must be a value 0 through 23, representing the hour of the day. +For example, 0 would be midnight, 13 would be 1:00 PM. +Default: 1 ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -285,13 +290,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -305,12 +330,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsRegistrarConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsRegistrarConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsRegistrarConfiguration.md index cb6eea8e9f..a78ff2f052 100644 --- a/skype/skype-ps/skype/New-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRegistrarConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRegistrarConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csregistrarconfiguration +schema: 2.0.0 +title: New-CsRegistrarConfiguration --- # New-CsRegistrarConfiguration @@ -50,7 +51,7 @@ Your command will also fail if you try to create new settings at the global scop ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsRegistrarConfiguration -Identity site:Redmond -MaxEndpointsPerUser 4 -EnableDHCPServer $True @@ -61,7 +62,7 @@ In addition to specifying the Identity for the new settings, the command also se Note that this command will fail if the Redmond site has already been assigned a collection of Registrar configuration settings. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsRegistrarConfiguration -Identity site:Redmond -InMemory @@ -86,39 +87,29 @@ If you do not call the Set-CsRegistrarConfiguration cmdlet, no new settings will ## PARAMETERS -### -Identity - -Unique identifier for the Registrar configuration settings to be created. -To create settings configured at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To create settings at the service level, use syntax like this: - -`-Identity service:Registrar:atl-cs-001.litwareinc.com` - -Note that a given site or service can only have, at most, a single collection of Registrar settings. -If you try to create a new collection with the Identity site:Redmond and the Redmond site already hosts a collection of Registrar settings, then your command will fail. - -In addition, you cannot create new Registrar settings at the global scope. -If you want to change values at the global scope, use the Set-CsRegistrarConfiguration cmdlet. +### -BackupStoreUnavailableThreshold +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the amount of time the system will wait before determining that the backup store is unavailable; at that point, users will be placed in survivability mode. +The default value is 30 minutes (00:30:00). ```yaml -Type: XdsIdentity +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DefaultEndpointExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. The DefaultEndpointExpiration property represents the expiration timeout interval for clients that do not request a specific timeout value. @@ -128,8 +119,7 @@ The default value is 600 (10 minutes). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +129,16 @@ Accept wildcard characters: False ``` ### -EnableDHCPServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether endpoints can use DHCP servers to locate a Registrar. If True, clients will send a DHCP Inform message when they first start; the DHCP server will respond by sending the fully qualified domain name (FQDN) of a Registrar that can be used to log on the user. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,19 +147,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEndpointExpiration -When endpoints log on, they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. -The MaxEndpointExpiration property represents the maximum amount of time that clients can be granted. -For example, if the maximum time is set to 600 seconds and a client requests a timeout interval of 800 seconds, the client will be given the maximum allowed expiration period: 600 seconds. +### -EnableWinFabLogUpload -The MaxEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). -The default value is 900. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,19 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinEndpointExpiration -When endpoints log on, they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. -The MinEndpointExpiration property represents the minimum amount of time that clients can be granted. -For example, if the minimum time is set to 600 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 600 seconds. +### -Force -The MinEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). -The default value is 300. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,45 +183,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEndpointsPerUser +### -Identity -Indicates the maximum number of endpoints a user can simultaneously have connected to the system. -(For example, a user who is logged on to Skype for Business Server with both a computer and a mobile phone would be using two endpoints.) MaxEndpointsPerUser must be set to a value between 1 and 64, inclusive. -The default value is 8. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Although it is possible to allow a user as many as 64 endpoints, it is recommended that the maximum number of endpoints not exceed 8. -Values of 9 or more are used for backwards compatibility and, in rare cases, when suggested by Microsoft support personnel. -For new deployments, the maximum number of endpoints should be no more than 8. +Unique identifier for the Registrar configuration settings to be created. +To create settings configured at the site scope, use syntax similar to this: -Note, too, that the maximum number of endpoints is intended to give individual users multiple points of presence. -As such, this setting is designed for individual users and not for groups of users (such as an entire department.) +`-Identity site:Redmond` +To create settings at the service level, use syntax like this: +`-Identity service:Registrar:atl-cs-001.litwareinc.com` -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Note that a given site or service can only have, at most, a single collection of Registrar settings. +If you try to create a new collection with the Identity site:Redmond and the Redmond site already hosts a collection of Registrar settings, then your command will fail. + +In addition, you cannot create new Registrar settings at the global scope. +If you want to change values at the global scope, use the Set-CsRegistrarConfiguration cmdlet. -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 occur when running the command. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -243,6 +218,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -251,8 +228,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,14 +237,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxEndpointExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When endpoints log on, they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. +The MaxEndpointExpiration property represents the maximum amount of time that clients can be granted. +For example, if the maximum time is set to 600 seconds and a client requests a timeout interval of 800 seconds, the client will be given the maximum allowed expiration period: 600 seconds. + +The MaxEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). +The default value is 900. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,14 +260,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxEndpointsPerUser + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of endpoints a user can simultaneously have connected to the system. +(For example, a user who is logged on to Skype for Business Server with both a computer and a mobile phone would be using two endpoints.) MaxEndpointsPerUser must be set to a value between 1 and 64, inclusive. +The default value is 8. + +Although it is possible to allow a user as many as 64 endpoints, it is recommended that the maximum number of endpoints not exceed 8. +Values of 9 or more are used for backwards compatibility and, in rare cases, when suggested by Microsoft support personnel. +For new deployments, the maximum number of endpoints should be no more than 8. + +Note, too, that the maximum number of endpoints is intended to give individual users multiple points of presence. +As such, this setting is designed for individual users and not for groups of users (such as an entire department.) + + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -293,15 +289,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupStoreUnavailableThreshold -Specifies the amount of time the system will wait before determining that the backup store is unavailable; at that point, users will be placed in survivability mode. -The default value is 30 minutes (00:30:00). +### -MaxUserCount + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of users that can simultaneously be logged on to a Registrar. +MaxUserCount can be set to any integer value between 2000 and 100000, inclusive. +The default value is 12000. + + ```yaml -Type: TimeSpan +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -310,19 +311,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxUserCount +### -MinEndpointExpiration -Indicates the maximum number of users that can simultaneously be logged on to a Registrar. -MaxUserCount can be set to any integer value between 2000 and 100000, inclusive. -The default value is 12000. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When endpoints log on, they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. +The MinEndpointExpiration property represents the minimum amount of time that clients can be granted. +For example, if the minimum time is set to 600 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 600 seconds. +The MinEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). +The default value is 300. ```yaml -Type: UInt64 +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,6 +336,8 @@ Accept wildcard characters: False ### -PoolState +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Current state for the Registrar pool. Allowed values are: @@ -351,8 +356,7 @@ The default value is Active. ```yaml Type: PoolState Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -361,14 +365,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableWinFabLogUpload -PARAMVALUE: $true | $false +### -UserCertificateReplicationThreshold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Minimum interval in minutes for user certificate to be replicated. ```yaml -Type: Boolean +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -377,14 +383,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCertificateReplicationThreshold -Minimum interval in minutes for user certificate to be replicated. +### -WinFabMaxLogsSizeMb + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Limits the maximum disk space used by Fabric traces. Only applies to deployments using Windows Fabric 3.0 or newer ```yaml -Type: UInt64 +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -393,14 +401,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WinFabMaxLogsSizeMb -Limits the maximum disk space used by Fabric traces. Only applies to deployments using Windows Fabric 3.0 or newer +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -414,13 +442,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsRegistrarConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings The New-CsRegistrarConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsReportingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsReportingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsReportingConfiguration.md index 5b76d057c5..d0eff10eb1 100644 --- a/skype/skype-ps/skype/New-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsReportingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsReportingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csreportingconfiguration +schema: 2.0.0 +title: New-CsReportingConfiguration --- # New-CsReportingConfiguration @@ -50,7 +51,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -ReportingUrl "https://atl-sql-001.litwareinc.com/lync_reports" @@ -62,7 +63,28 @@ In this example, the value of the ReportingUrl property is set to `https://atl-s ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database to be associated with the new reporting configuration settings. For example: @@ -71,8 +93,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -81,14 +102,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,31 +121,18 @@ 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. +### -ReportingUrl -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the Skype for Business Server Monitoring Reports. -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 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,17 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReportingUrl - -URL for the Skype for Business Server Monitoring Reports. +### -Confirm +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -150,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -170,14 +182,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsReportingConfiguration cmdlet does not accept pipelined data. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration The New-CsReportingConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsAgentGroup.md similarity index 86% rename from skype/skype-ps/skype/New-CsRgsAgentGroup.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsAgentGroup.md index ce81c7775c..d2f9ed1228 100644 --- a/skype/skype-ps/skype/New-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsAgentGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsAgentGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsagentgroup +schema: 2.0.0 +title: New-CsRgsAgentGroup --- # New-CsRgsAgentGroup @@ -47,7 +48,7 @@ New agent groups are created by using the New-CsRgsAgentGroup cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsRgsAgentGroup -Parent service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Group" @@ -59,7 +60,7 @@ In this example, no other group parameters are specified, meaning the group will Because no agents have been assigned to this group any calls routed to the new agent group will automatically be disconnected. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsRgsAgentGroup -Parent service: ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Group" -AgentsByUri "sip:kenmyer@litwareinc.com","sip:pilarackerman@litwareinc.com" @@ -73,42 +74,10 @@ This value is a comma-separated list of the SIP addresses to be added to the age ## PARAMETERS -### -Name -Unique name to be assigned to the agent group. -The combination of the Parent property and the Name property enables you to uniquely identify agent groups without having to refer to the group's globally unique identifier (GUID). - -```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: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parent -Service where the new agent group will be hosted. -For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` - -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AgentAlertTime +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the amount of time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 10 and 600 seconds (10 minutes), inclusive. The default value is 20 seconds. @@ -121,8 +90,7 @@ To avoid this, set the Alert Time value to less than 180 seconds. ```yaml Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +100,9 @@ Accept wildcard characters: False ``` ### -AgentsByUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010 Enables you to individually add agents to an agent group. @@ -151,8 +122,7 @@ Note that you can only select users who have been enabled for Enterprise Voice. ```yaml Type: System.Collections.ObjectModel.Collection`1[System.Uri] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,14 +132,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional, explanatory information about the agent group. For example, the Description might contain information about who to contact if the group does not receive the expected phone calls. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,13 +151,15 @@ Accept wildcard characters: False ``` ### -DistributionGroupAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to add all the members of a distribution group to an agent group. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -194,16 +168,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ParticipationPolicy -Indicates whether or not agents are required to formally sign on to the system in order to receive phone calls intended for the group. -If ParticipationPolicy is set to Informal (the default value) sign-in is not required. -If ParticipationPolicy is set to Formal then sign-in is required. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: ParticipationPolicy +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,47 +186,77 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RoutingMethod +### -InMemory -Specifies the method used to route new calls to agents. -The RoutingMethod must be set to one of the following values: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -LongestIdle - Calls are routed to the agent who has been idle (that is, not involved in a Skype for Business activity) for the longest period of time. +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-\. -RoundRobin - Calls are routed to the next agent on the list. -Serial - Calls are always routed to the first agent on the list, and are only routed to other agents if this person is not available or does not answer within the allotted time. -Parallel - Calls are routed to all agents at the same time, except for agents whose presence status indicates that they are in a call or otherwise unavailable. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Attendant - Calls are routed to all agents at the same time, even if the agent's presence status indicates that he or she is in a call or otherwise unavailable. -The only exception occurs when an agent has set his or her presence to Do Not Disturb. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The default routing method is Parallel. +### -Name +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique name to be assigned to the agent group. +The combination of the Parent property and the Name property enables you to uniquely identify agent groups without having to refer to the group's globally unique identifier (GUID). ```yaml -Type: RoutingMethod +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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 occur when running the command. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service where the new agent group will be hosted. +For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` ```yaml -Type: SwitchParameter +Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParticipationPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not agents are required to formally sign on to the system in order to receive phone calls intended for the group. +If ParticipationPolicy is set to Informal (the default value) sign-in is not required. +If ParticipationPolicy is set to Formal then sign-in is required. + +```yaml +Type: ParticipationPolicy +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -261,18 +265,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -RoutingMethod -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the method used to route new calls to agents. +The RoutingMethod must be set to one of the following values: + +LongestIdle - Calls are routed to the agent who has been idle (that is, not involved in a Skype for Business activity) for the longest period of time. + +RoundRobin - Calls are routed to the next agent on the list. + +Serial - Calls are always routed to the first agent on the list, and are only routed to other agents if this person is not available or does not answer within the allotted time. + +Parallel - Calls are routed to all agents at the same time, except for agents whose presence status indicates that they are in a call or otherwise unavailable. + +Attendant - Calls are routed to all agents at the same time, even if the agent's presence status indicates that he or she is in a call or otherwise unavailable. +The only exception occurs when an agent has set his or her presence to Do Not Disturb. + +The default routing method is Parallel. ```yaml -Type: SwitchParameter +Type: RoutingMethod Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -283,6 +301,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -291,7 +311,6 @@ Prompts you for confirmation before executing the command. 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 @@ -302,6 +321,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -310,7 +331,6 @@ Describes what would happen if you executed the command without actually executi 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 @@ -324,13 +344,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsAgentGroup does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup New-CsRgsAgentGroup creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsAnswer.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsAnswer.md similarity index 91% rename from skype/skype-ps/skype/New-CsRgsAnswer.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsAnswer.md index 446e74549c..fc7ce4688c 100644 --- a/skype/skype-ps/skype/New-CsRgsAnswer.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsAnswer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsanswer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsAnswer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsanswer +schema: 2.0.0 +title: New-CsRgsAnswer --- # New-CsRgsAnswer @@ -51,7 +52,7 @@ In that case, you will need to create a new instance of the Response Group answe ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $w = New-CsRgsPrompt -TextToSpeechPrompt "Please hold while we transfer your call." @@ -79,6 +80,9 @@ For details, see the New-CsRgsQuestion help topic. ## PARAMETERS ### -Action + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the action to be taken any time a caller provides this answer. The Action parameter must be specified using an object reference created by using the New-CsRgsCallAction cmdlet. For details, see the Examples section in this topic. @@ -86,8 +90,7 @@ For details, see the Examples section in this topic. ```yaml Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -DtmfResponse + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key on the telephone keypad to be pressed in order to match the answer. For example, if callers are told to press 1 for hardware, then DtmfResponse would be configured like this: `-DtmfResponse 1.` @@ -106,8 +112,7 @@ Each answer must have at least one of these two response types. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,14 +122,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name given to the Response Group answer. Names do not have to be unique. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -VoiceResponseList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Array of keywords callers can say that will match the answer. For example, if one option available to callers is "Hardware" then the VoiceResponseList property might be set to this: `-VoiceResponseList "Hardware".` Multiple keywords can be specified by using comma-separated values. @@ -143,8 +153,7 @@ Voice responses should not contain double quote marks, because that character is ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,13 +167,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsAnswer does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.Answer Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Answer object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsCallAction.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsCallAction.md similarity index 91% rename from skype/skype-ps/skype/New-CsRgsCallAction.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsCallAction.md index 5e38c17538..e5f69b3565 100644 --- a/skype/skype-ps/skype/New-CsRgsCallAction.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsCallAction.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgscallaction applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsCallAction -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgscallaction +schema: 2.0.0 +title: New-CsRgsCallAction --- # New-CsRgsCallAction @@ -52,7 +53,7 @@ In addition, all the call actions except for TransferToQuestion can be used for ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Overflow" @@ -83,7 +84,7 @@ If the Help Desk queue "overflows" (that is, if it reaches the maximum number of Finally, the last command in the example calls Set-CsRgsQueue to write the changes to the actual instance of Help Desk Overflow queue on ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $w = New-CsRgsPrompt -TextToSpeechPrompt "Please hold while we transfer your call." @@ -105,6 +106,9 @@ To do this, the new call action's Action property is set to TransferToPSTN and t ## PARAMETERS ### -Action + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the call action to be taken. The Action must be set to one of the following values: @@ -125,8 +129,7 @@ The Action must be specified each time you create a new call action; there is no ```yaml Type: Action Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -136,14 +139,16 @@ Accept wildcard characters: False ``` ### -Prompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompt to be played before the call action takes place. (For example, "Please hold while your call is transferred.") Prompts must be created by using the New-CsRgsPrompt cmdlet. ```yaml Type: Prompt Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,6 +158,9 @@ Accept wildcard characters: False ``` ### -Question + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Question to be asked if the Action has been set to TransferToQuestion. The question must be created by using the New-CsRgsQuestion cmdlet. @@ -161,8 +169,7 @@ This parameter is required if the Action has been set to TransferToQuestion. ```yaml Type: Question Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,6 +179,9 @@ Accept wildcard characters: False ``` ### -QueueID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the Response Group queue the call should be transferred to (assuming that the Action has been set to TransferToQueue). The QueueID is best specified by using Get-CsRgsQueue to retrieve the Identity of the relevant queue. @@ -180,8 +190,7 @@ This parameter is required if the Action is set to TransferToQueue. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,6 +200,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address, voice mail URI, or PSTN telephone number that the call should be transferred to. This parameter is required if the Action has been set to TransferToUri; TransferToVoiceMailUri; or TransferToPSTN. @@ -198,8 +210,7 @@ This parameter is required if the Action has been set to TransferToUri; Transfer ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,13 +224,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsCallAction does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.CallAction New-CsRgsCallAction creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.CallAction object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsHoliday.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoliday.md similarity index 91% rename from skype/skype-ps/skype/New-CsRgsHoliday.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsHoliday.md index 18b0630657..587fb8058b 100644 --- a/skype/skype-ps/skype/New-CsRgsHoliday.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoliday.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsholiday applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsHoliday -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsholiday +schema: 2.0.0 +title: New-CsRgsHoliday --- # New-CsRgsHoliday @@ -56,7 +57,7 @@ Although a holiday set can (and typically does) hold multiple holidays, these ho ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $christmasDay = New-CsRgsHoliday -StartDate "12/25/2013 12:00 AM" -EndDate "12/26/2013 12:00 AM" -Name "Christmas Day" @@ -81,39 +82,42 @@ The final command then calls Set-CsRgsHolidaySet to write the changes (that is, ## PARAMETERS -### -Name -Unique name used to differentiate the holiday from other holidays. +### -EndDate + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Ending date for the holiday. +The format for the ending date depends on your Regional and Language Options. +For example, in the U.S. +an ending date of July 4, 2013 would be formatted like this: `-EndDate "7/5/2013 12:00 AM"`, meaning that the holiday ends at 12:00 A.M. +on July 5, 2013. + + ```yaml -Type: String +Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EndDate - -Ending date for the holiday. -The format for the ending date depends on your Regional and Language Options. -For example, in the U.S. -an ending date of July 4, 2013 would be formatted like this: `-EndDate "7/5/2013 12:00 AM"`, meaning that the holiday ends at 12:00 A.M. -on July 5, 2013. +### -Name +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique name used to differentiate the holiday from other holidays. ```yaml -Type: DateTime +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -122,6 +126,8 @@ Accept wildcard characters: False ### -StartDate +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Starting date for the holiday. The format for the starting date depends on your Regional and Language Options. For example, in the U.S. @@ -133,8 +139,7 @@ on July 4, 2013. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -148,13 +153,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsHoliday does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.Holiday New-CsRgsHoliday creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Holiday object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsHolidaySet.md similarity index 89% rename from skype/skype-ps/skype/New-CsRgsHolidaySet.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsHolidaySet.md index d86a40c358..7f3736a22a 100644 --- a/skype/skype-ps/skype/New-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsHolidaySet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsHolidaySet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsholidayset +schema: 2.0.0 +title: New-CsRgsHolidaySet --- # New-CsRgsHolidaySet @@ -56,7 +57,7 @@ Note that, when you create a new holiday set, you must include at least one holi ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` -HolidayList($x, $y, $z) @@ -79,8 +80,28 @@ You can then include all those variable names as the parameter value passed to H ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -HolidayList +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + One or more holidays to be added to the holiday set. Holidays must be created by using the New-CsRgsHoliday cmdlet and then stored in an object reference. These object references are then passed to the Holidays parameter in order to add the holidays to the holiday set. @@ -97,8 +118,7 @@ English. ```yaml Type: System.Collections.ObjectModel.Collection`1[Microsoft.Rtc.Rgs.Management.WritableSettings.Holiday] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -107,77 +127,69 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Unique name to be assigned to the holiday set. -The combination of the Parent property and the Name property enables you to uniquely identify holiday sets without having to refer to the set's globally unique identifier (GUID). +### -InMemory -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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-\. -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Parent -Service where the new holiday set will be hosted. -For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` ```yaml -Type: RgsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +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-\. +### -Name +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique name to be assigned to the holiday set. +The combination of the Parent property and the Name property enables you to uniquely identify holiday sets without having to refer to the set's globally unique identifier (GUID). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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 occur when running the command. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service where the new holiday set will be hosted. +For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` ```yaml -Type: SwitchParameter +Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010 Prompts you for confirmation before running the cmdlet. @@ -194,7 +206,6 @@ Prompts you for confirmation before executing the command. 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 @@ -205,6 +216,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -213,7 +226,6 @@ Describes what would happen if you executed the command without actually executi 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 @@ -227,13 +239,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsHolidaySet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet New-CsRgsHolidaySet creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoursOfBusiness.md similarity index 85% rename from skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsHoursOfBusiness.md index 137037c180..712416ba06 100644 --- a/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoursOfBusiness.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsHoursOfBusiness -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgshoursofbusiness +schema: 2.0.0 +title: New-CsRgsHoursOfBusiness --- # New-CsRgsHoursOfBusiness @@ -59,7 +60,7 @@ to Hours2. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsRgsHoursOfBusiness -Parent "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "Help Desk Business Hours" @@ -69,7 +70,7 @@ The command shown in Example 1 creates a new business hours set named Help Desk In this example, no business hours are configured for the set. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $weekday = New-CsRgsTimeRange -Name "Weekday Hours" -OpenTime "8:00" -CloseTime "18:00" @@ -90,49 +91,35 @@ to 6:00 P.M., and by using the time range variable $weekday. ## PARAMETERS -### -Name -Unique name to be assigned to the business hours set. -The combination of the Parent property and the Name property enables you to uniquely identify business hour sets without having to refer to the collection's globally unique identifier (GUID). +### -Custom + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, the business hours can only be used by the specified workflow. +If set to False (the default value) the business hours can be shared among multiple workflows. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -Service where the new business hours set will be hosted. -For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` - -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Custom -If set to True, the business hours can only be used by the specified workflow. -If set to False (the default value) the business hours can be shared among multiple workflows. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,22 +128,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MondayHours1 -First set of opening and closing times for Monday. +### -FridayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Friday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Monday then you will only need to configure a single time range. +every Friday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Monday. +to 5:00 P.M., you will need to create two time ranges for Friday. -If your organization is closed on Mondays, then do not configure a value for either MondayHours1 or MondayHours2. +If your organization is closed on Fridays, then do not configure a value for either FridayHours1 or FridayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,21 +154,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MondayHours2 -Second set of opening and closing times for Monday. +### -FridayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Friday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Monday then you will only need to configure a single time range. +every Friday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M. -you will need to create two time ranges for Monday. +to 5:00 P.M., you will need to create two time ranges for Friday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,22 +178,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TuesdayHours1 -First set of opening and closing times for Tuesday. -If your organization is open from, say, 9:00 A.M. -to 5:00 P.M. -every Tuesday then you will only need to configure a single time range. -However, if your organization is open from 8:00 A.M. -to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Tuesday. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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-\. + -If your organization is closed on Tuesdays, then do not configure a value for either TuesdayHours1 or TuesdayHours2. ```yaml -Type: TimeRange +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,20 +199,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TuesdayHours2 -Second set of opening and closing times for Tuesday. +### -MondayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Monday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Tuesday then you will only need to configure a single time range. +every Monday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Tuesday. +to 5:00 P.M., you will need to create two time ranges for Monday. + +If your organization is closed on Mondays, then do not configure a value for either MondayHours1 or MondayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,22 +225,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WednesdayHours1 -First set of opening and closing times for Wednesday. +### -MondayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Monday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Wednesday then you will only need to configure a single time range. +every Monday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Wednesday. - -If your organization is closed on Wednesday, then do not configure a value for either WednesdayHours1 or WednesdayHours2. +to 5:00 P.M. +you will need to create two time ranges for Monday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,44 +250,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WednesdayHours2 -Second set of opening and closing times for Wednesday. -If your organization is open from, say, 9:00 A.M. -to 5:00 P.M. -every Wednesday then you will only need to configure a single time range. -However, if your organization is open from 8:00 A.M. -to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Wednesday. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique name to be assigned to the business hours set. +The combination of the Parent property and the Name property enables you to uniquely identify business hour sets without having to refer to the collection's globally unique identifier (GUID). ```yaml -Type: TimeRange +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ThursdayHours1 -First set of opening and closing times for Thursday. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service where the new business hours set will be hosted. +For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` + +```yaml +Type: RgsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SaturdayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Saturday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Thursday then you will only need to configure a single time range. +every Saturday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Thursday. +to 5:00 P.M., you will need to create two time ranges for Saturday. -If your organization is closed on Thursdays, then do not configure a value for either ThursdayHours1 or ThursdayHours2. +If your organization is closed on Saturdays, then do not configure a value for either SaturdayHours1 or SaturdayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -304,20 +314,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ThursdayHours2 -Second set of opening and closing times for Thursday. +### -SaturdayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Saturday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Thursday then you will only need to configure a single time range. +every Saturday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Thursday. +to 5:00 P.M., you will need to create two time ranges for Saturday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -326,22 +338,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FridayHours1 -First set of opening and closing times for Friday. +### -SundayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Sunday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Friday then you will only need to configure a single time range. -However, if your organization is open from 8:00 A.M. -to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Friday. +every Sunday then you will only need to configure a single time range. +However, if your organization is open from 8:00 AM to noon, closes for an hour lunch, then is open again from 1:00 P.M. +to 5:00 P.M., you will need to create two time ranges for Sunday. -If your organization is closed on Fridays, then do not configure a value for either FridayHours1 or FridayHours2. +If your organization is closed on Sundays, then do not configure a value for either SundayHours1 or SundayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -350,20 +363,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FridayHours2 -Second set of opening and closing times for Friday. +### -SundayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Sunday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Friday then you will only need to configure a single time range. +every Sunday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Friday. +to 5:00 P.M. +you will need to create two time ranges for Sunday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -372,22 +388,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SaturdayHours1 -First set of opening and closing times for Saturday. +### -ThursdayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Thursday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Saturday then you will only need to configure a single time range. +every Thursday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Saturday. +to 5:00 P.M., you will need to create two time ranges for Thursday. -If your organization is closed on Saturdays, then do not configure a value for either SaturdayHours1 or SaturdayHours2. +If your organization is closed on Thursdays, then do not configure a value for either ThursdayHours1 or ThursdayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -396,20 +414,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SaturdayHours2 -Second set of opening and closing times for Saturday. +### -ThursdayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Thursday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Saturday then you will only need to configure a single time range. +every Thursday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Saturday. +to 5:00 P.M., you will need to create two time ranges for Thursday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -418,21 +438,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SundayHours1 -First set of opening and closing times for Sunday. +### -TuesdayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Tuesday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Sunday then you will only need to configure a single time range. -However, if your organization is open from 8:00 AM to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Sunday. +every Tuesday then you will only need to configure a single time range. +However, if your organization is open from 8:00 A.M. +to noon, closes for an hour lunch, then is open again from 1:00 P.M. +to 5:00 P.M., you will need to create two time ranges for Tuesday. -If your organization is closed on Sundays, then do not configure a value for either SundayHours1 or SundayHours2. +If your organization is closed on Tuesdays, then do not configure a value for either TuesdayHours1 or TuesdayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -441,21 +464,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SundayHours2 -Second set of opening and closing times for Sunday. +### -TuesdayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Tuesday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Sunday then you will only need to configure a single time range. +every Tuesday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M. -you will need to create two time ranges for Sunday. +to 5:00 P.M., you will need to create two time ranges for Tuesday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -464,18 +488,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -WednesdayHours1 -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +First set of opening and closing times for Wednesday. +If your organization is open from, say, 9:00 A.M. +to 5:00 P.M. +every Wednesday then you will only need to configure a single time range. +However, if your organization is open from 8:00 A.M. +to noon, closes for an hour lunch, then is open again from 1:00 P.M. +to 5:00 P.M., you will need to create two time ranges for Wednesday. +If your organization is closed on Wednesday, then do not configure a value for either WednesdayHours1 or WednesdayHours2. ```yaml -Type: SwitchParameter +Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -484,14 +514,22 @@ 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. +### -WednesdayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Wednesday. +If your organization is open from, say, 9:00 A.M. +to 5:00 P.M. +every Wednesday then you will only need to configure a single time range. +However, if your organization is open from 8:00 A.M. +to noon, closes for an hour lunch, then is open again from 1:00 P.M. +to 5:00 P.M., you will need to create two time ranges for Wednesday. ```yaml -Type: SwitchParameter +Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -502,6 +540,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -510,7 +550,6 @@ Prompts you for confirmation before executing the command. 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 @@ -521,6 +560,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -529,7 +570,6 @@ Describes what would happen if you executed the command without actually executi 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 @@ -543,13 +583,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsHoursOfBusiness does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsPrompt.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsPrompt.md similarity index 93% rename from skype/skype-ps/skype/New-CsRgsPrompt.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsPrompt.md index 663c604f09..5f04c8674c 100644 --- a/skype/skype-ps/skype/New-CsRgsPrompt.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsPrompt.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsprompt applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsPrompt -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsprompt +schema: 2.0.0 +title: New-CsRgsPrompt --- # New-CsRgsPrompt @@ -49,7 +50,7 @@ After new prompts are created in memory, the corresponding object reference is t ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $queue = Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -69,7 +70,7 @@ The final command in the example uses New-CsRgsCallAction to create a new Respon When creating the call action, the object reference $prompt (which contains the newly-created workflow prompt) is used as the value for the Prompt parameter; the object reference $queue is likewise used in conjunction with the QueueID parameter. After running this command, the new call action and its new workflow prompt are ready to be added to a Response Group workflow. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $queue = Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Queue" @@ -92,15 +93,17 @@ Please hold." ## PARAMETERS -### -TextToSpeechPrompt -Text-to-speech (TTS) prompt to be read when the workflow is activated. -The TTS prompt, which is used only if an audio file is not specified, can contain a maximum of 4096 characters. +### -AudioFilePrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Audio file to be played when the workflow is activated. +The audio file must be imported by using the Import-CsRgsAudioFile cmdlet. ```yaml -Type: String +Type: AudioFile Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,15 +112,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFilePrompt -Audio file to be played when the workflow is activated. -The audio file must be imported by using the Import-CsRgsAudioFile cmdlet. +### -TextToSpeechPrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Text-to-speech (TTS) prompt to be read when the workflow is activated. +The TTS prompt, which is used only if an audio file is not specified, can contain a maximum of 4096 characters. ```yaml -Type: AudioFile +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,13 +136,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsPrompt does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableSettings.Prompt New-CsRgsPrompt creates instances of the Microsoft.Rtc.Management.WritableSettings.Prompt object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsQuestion.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsQuestion.md similarity index 90% rename from skype/skype-ps/skype/New-CsRgsQuestion.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsQuestion.md index 9a30312ad9..87c1e1b85b 100644 --- a/skype/skype-ps/skype/New-CsRgsQuestion.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsQuestion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsquestion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsQuestion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsquestion +schema: 2.0.0 +title: New-CsRgsQuestion --- # New-CsRgsQuestion @@ -46,7 +47,7 @@ For example, if the caller in the original scenario presses 3, the prompt might ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $new = Get-CsRgsQueue -Identity service:ApplicationServer:pool0.litwareinc.com -Name "New Service Request" @@ -87,24 +88,10 @@ In addition to the Prompt parameter, the AnswerList parameter is used to indicat ## PARAMETERS -### -Prompt -Question to be asked of the caller. -Prompts must be created by using the New-CsRgsPrompt cmdlet. - -```yaml -Type: Prompt -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AnswerList -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AnswerList Array of valid answers to the question. For example, a help desk question might have answers such as Hardware Support, Software Installation, and Network Connections. Answers must be created by using the New-CsRgsAnswer cmdlet. @@ -112,8 +99,7 @@ Answers must be created by using the New-CsRgsAnswer cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +109,9 @@ Accept wildcard characters: False ``` ### -InvalidAnswerPrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Response to be issued in case the caller selects an invalid answer. The InvalidAnswerPrompt must be created by using the New-CsRgsPrompt cmdlet. Note that after the playing the InvalidAnswerPrompt the application will then repeat the original prompt. @@ -130,8 +119,7 @@ Note that after the playing the InvalidAnswerPrompt the application will then re ```yaml Type: Prompt Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,14 +129,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identifier for the question. Question names, which do not have to be unique, are limited to a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +148,16 @@ Accept wildcard characters: False ``` ### -NoAnswerPrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Response to be issued in case the caller does not respond to the initial prompt. The NoAnswerPrompt must be created by using the New-CsRgsPrompt cmdlet. ```yaml Type: Prompt Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,18 +166,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Prompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Question to be asked of the caller. +Prompts must be created by using the New-CsRgsPrompt cmdlet. + +```yaml +Type: Prompt +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS -### -None. +### None New-CsRgsQuestion does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableSettings.Question New-CsRgsQuestion creates instances of the Microsoft.Rtc.Management.WriteableSettings.Question object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsQueue.md similarity index 83% rename from skype/skype-ps/skype/New-CsRgsQueue.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsQueue.md index 119cd58947..81c364e828 100644 --- a/skype/skype-ps/skype/New-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsQueue.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsQueue -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsqueue +schema: 2.0.0 +title: New-CsRgsQueue --- # New-CsRgsQueue @@ -43,7 +44,7 @@ The New-CsRgsQueue cmdlet provides an easy way for administrators to create new ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsRgsCallAction -Action TransferToVoicemailUri -Uri "sip:+14255551298@litwareinc.com" @@ -61,34 +62,22 @@ In addition to specifying the OverflowAction, this command also configures value ## PARAMETERS -### -Parent -Service where the new queue will be hosted. -For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` +### -AgentGroupIDList -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Identity of the Response Group agent groups to be added to the queue. +The agent group Identities can be retrieved using the Get-CsRgsAgentGroup cmdlet. +For details, see the Examples section in this topic. -### -Name -Unique name to be assigned to the queue. -The combination of the Parent property and the Name property enables you to uniquely identify Response Group queues without having to refer to the queue's globally unique identifier (GUID). +If a call is routed to a queue that has no agent groups assigned to it (or has only been assigned agent groups that do not have any agents) then that call will automatically be disconnected. ```yaml -Type: String +Type: System.Collections.ObjectModel.Collection`1[Microsoft.Rtc.Rgs.Management.RgsIdentity] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -96,13 +85,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional information about the Response Group queue. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -111,15 +102,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowAction -Action to be taken if the overflow threshold is reached. -The OverflowAction must be created using the New-CsRgsCallAction cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: CallAction +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,21 +120,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowCandidate -Indicates which call will be acted upon should the overflow threshold be reached. -The OverflowCandidate property must be set to one of the following two values: +### -InMemory -NewestCall +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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-\. -OldestCall -The default value is NewestCall. ```yaml -Type: OverflowCandidate +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,33 +141,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowThreshold -Number of simultaneous 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 1000, inclusive. -The default value is Null, meaning that an unlimited number of calls can be in the queue at any given time. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique name to be assigned to the queue. +The combination of the Parent property and the Name property enables you to uniquely identify Response Group queues without having to refer to the queue's globally unique identifier (GUID). ```yaml -Type: Int16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutAction -Action to be taken if the timeout threshold is reached. -The TimeoutAction must be created using the New-CsRgsCallAction cmdlet. +### -OverflowAction + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Action to be taken if the overflow threshold is reached. +The OverflowAction must be created using the New-CsRgsCallAction cmdlet. ```yaml Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -186,17 +179,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutThreshold -Amount of 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. +### -OverflowCandidate -The timeout threshold can be any integer value between 10 and 65535 seconds (approximately 18 hours), inclusive; the default value is null, meaning that the queue never times out. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates which call will be acted upon should the overflow threshold be reached. +The OverflowCandidate property must be set to one of the following two values: + +NewestCall + +OldestCall + +The default value is NewestCall. ```yaml -Type: Int32 +Type: OverflowCandidate Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,14 +204,18 @@ 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. +### -OverflowThreshold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Number of simultaneous 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 1000, inclusive. +The default value is Null, meaning that an unlimited number of calls can be in the queue at any given time. ```yaml -Type: SwitchParameter +Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,18 +224,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Parent -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service where the new queue will be hosted. +For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` + +```yaml +Type: RgsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -TimeoutAction + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Action to be taken if the timeout threshold is reached. +The TimeoutAction must be created using the New-CsRgsCallAction cmdlet. ```yaml -Type: SwitchParameter +Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,18 +262,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AgentGroupIDList -Identity of the Response Group agent groups to be added to the queue. -The agent group Identities can be retrieved using the Get-CsRgsAgentGroup cmdlet. -For details, see the Examples section in this topic. +### -TimeoutThreshold -If a call is routed to a queue that has no agent groups assigned to it (or has only been assigned agent groups that do not have any agents) then that call will automatically be disconnected. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Amount of 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 timeout threshold can be any integer value between 10 and 65535 seconds (approximately 18 hours), inclusive; the default value is null, meaning that the queue never times out. ```yaml -Type: System.Collections.ObjectModel.Collection`1[Microsoft.Rtc.Rgs.Management.RgsIdentity] +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -263,6 +285,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -271,7 +295,6 @@ Prompts you for confirmation before executing the command. 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 @@ -282,6 +305,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -290,7 +315,6 @@ Describes what would happen if you executed the command without actually executi 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 @@ -304,13 +328,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsQueue does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.Queue New-CsRgsQueue creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsTimeRange.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsTimeRange.md similarity index 92% rename from skype/skype-ps/skype/New-CsRgsTimeRange.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsTimeRange.md index 7d567a2ff5..32bf1da90f 100644 --- a/skype/skype-ps/skype/New-CsRgsTimeRange.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsTimeRange.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgstimerange applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsTimeRange -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgstimerange +schema: 2.0.0 +title: New-CsRgsTimeRange --- # New-CsRgsTimeRange @@ -53,7 +54,7 @@ You must also use New-CsRgsTimeRange to specify opening and closing hours any ti ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $sundayHours = New-CsRgsTimeRange -Name "Sunday hours" -OpenTime "08:30" -CloseTime "13:30" @@ -80,7 +81,7 @@ Note that if you fail to call Set-CsRgsHoursOfBusiness, the newly created time r If that happens, then the Help Desk Hours business hours collection will not be updated. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $sundayHours = New-CsRgsTimeRange -Name "Sunday hours" -OpenTime "08:30" -CloseTime "13:30" @@ -102,6 +103,9 @@ In this command, the variable $sundayHours specifies the time range for the prop ## PARAMETERS ### -CloseTime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Time of day when business hours end. CloseTime should be formatted using a 24-hour clock; for example, to indicate that business hours end at 9:00 P.M. use this format: `-CloseTime "21:00".` @@ -109,8 +113,7 @@ use this format: `-CloseTime "21:00".` ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -119,35 +122,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OpenTime -Time of day when business hours begin. -OpenTime should be formatted using a 24-hour clock; for example, to indicate that business hours begin at 1:30 P.M. -use this format: `-OpenTime "13:30".` +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the time range being created. +The Name is limited to a maximum of 128 characters. ```yaml -Type: TimeSpan +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Unique identifier for the time range being created. -The Name is limited to a maximum of 128 characters. +### -OpenTime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Time of day when business hours begin. +OpenTime should be formatted using a 24-hour clock; for example, to indicate that business hours begin at 1:30 P.M. +use this format: `-OpenTime "13:30".` ```yaml -Type: String +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -159,13 +166,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsTimeRange does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.TimeRange New-CsRgsTimeRange creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.TimeRange object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsWorkflow.md similarity index 84% rename from skype/skype-ps/skype/New-CsRgsWorkflow.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsWorkflow.md index dd48bcbd80..132b05b862 100644 --- a/skype/skype-ps/skype/New-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsWorkflow.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsWorkflow -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsworkflow +schema: 2.0.0 +title: New-CsRgsWorkflow --- # New-CsRgsWorkflow @@ -47,7 +48,7 @@ New workflows are created by using the New-CsRgsWorkflow cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsRgsWorkflow -Parent service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" -PrimaryUri "sip:helpdesk@litwareinc.com" @@ -57,7 +58,7 @@ Example 1 creates a new workflow on the service ApplicationServer:atl-cs-001.lit This workflow is given the Name Help Desk and is assigned a primary URI of sip:helpdesk@litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $prompt = New-CsRgsPrompt -TextToSpeechPrompt "Welcome to the help desk." @@ -81,59 +82,10 @@ This command sets the PrimaryUri to sip:helpdesk@litwareinc.com and sets the val ## PARAMETERS -### -Name -Unique name to be assigned to the workflow. -The combination of the Parent property and the Name property enables you to uniquely identify workflows without having to refer to the workflow's globally unique identifier (GUID). - -```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: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parent -Service where the new workflow will be hosted. -For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` - -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryUri -SIP address for the workflow. -For example: `-PrimaryUri "sip:helpdesk@litwareinc.com".` -The PrimaryUri must begin with the "sip:" prefix. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Active -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Active If set to True, this means that the workflow is active and available to take phone calls. If set to False (the default value), the workflow is not available to take phone calls. @@ -144,8 +96,7 @@ If Active is set to False (or not configured) then no validation will take place ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,14 +106,16 @@ Accept wildcard characters: False ``` ### -Anonymous + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, the identities of individual Response Group agents will be masked any time these agents answer a call. If set to False (the default value), agent identities will be available to callers. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,14 +125,16 @@ Accept wildcard characters: False ``` ### -BusinessHoursID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Days of the week and times of the day that workflow agents are available to answer calls. The business hour Identities can be retrieved by using the Get-CsRgsHoursOfBusiness cmdlet. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,14 +144,16 @@ Accept wildcard characters: False ``` ### -CustomMusicOnHoldFile + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents custom music to be played when callers are placed on hold. (If not defined, callers will hear the default music when placed on hold.) Custom music must be imported by using the Import-CsRgsAudioFile cmdlet. ```yaml Type: AudioFile Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +163,9 @@ Accept wildcard characters: False ``` ### -DefaultAction + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the action to be taken when a workflow is opened during business hours. DefaultAction must be defined by using the New-CsRgsCallAction cmdlet, and must either direct the call to a queue or to a question. The DefaultAction parameter is mandatory if the workflow is active, but can be omitted if the workflow is inactive. @@ -213,8 +173,7 @@ The DefaultAction parameter is mandatory if the workflow is active, but can be o ```yaml Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +184,8 @@ Accept wildcard characters: False ### -Description +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to add additional information about a Response Group workflow. For example, the Description might include contact information for the owner of the workflow. This description appears in the Skype for Business contact card for the workflow. @@ -234,8 +195,7 @@ This description appears in the Skype for Business contact card for the workflow ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +206,8 @@ Accept wildcard characters: False ### -DisplayNumber +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number for the workflow as displayed in Skype for Business. The DisplayNumber can be formatted any way you want; for example: @@ -260,8 +222,7 @@ The DisplayNumber can be formatted any way you want; for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -271,14 +232,34 @@ Accept wildcard characters: False ``` ### -EnabledForFederation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the workflow is available to users from a federated domain. If set to False, only users within your organization will have access to the workflow. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -288,14 +269,56 @@ Accept wildcard characters: False ``` ### -HolidayAction + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Action to be taken if a call is received on a holiday. The HolidayAction must be defined by using the New-CsRgsCallAction cmdlet. ```yaml Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HolidaySetIDList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents days when workflow agents are not available to answer calls. +The holiday set Identities can be retrieved by using the Get-CsRgsHolidaySet cmdlet. + +```yaml +Type: System.Collections.ObjectModel.Collection`1[Microsoft.Rtc.Rgs.Management.RgsIdentity] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -306,6 +329,8 @@ Accept wildcard characters: False ### -Language +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Language that is used to read workflow text-to-speech prompts. The language parameter is optional as long as the operating system is using one of the supported languages shown in the list below. (Note that supported speech languages represent a subset of the languages that can be used on the operating system.) @@ -381,8 +406,7 @@ For example: `-Language "nl-NL".` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -392,6 +416,9 @@ Accept wildcard characters: False ``` ### -LineUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number for the workflow. The line Uniform Resource Identifier (URI) must be specified by using the following format: the TEL: prefix followed by a plus sign, followed by the country/region calling code, area code, and phone number (using only digits: no blank spaces, periods, or hyphens). For example: `-LineUri "TEL:+14255551219"` @@ -399,8 +426,7 @@ For example: `-LineUri "TEL:+14255551219"` ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -409,15 +435,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NonBusinessHoursAction -Action to be taken if a call is received outside the workflow's business hours. -The NonBusinessHoursAction must be defined by using the New-CsRgsCallAction cmdlet. +### -Managed + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True indicates that the workflow will be managed by one or more users. +Those users can be specified by using the ManagedByUri parameter. ```yaml -Type: CallAction +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -426,15 +454,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeZone -Time zone information used when determining holidays and business hours. -For example: `-TimeZone "Pacific Standard Time"` +### -ManagersByUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP addresses of the user (or users) who will manage the workflow. +For example: + +`-ManagedByUri "sip:kenmyer@litwareinc.com"` + +To specify multiple managers separate the manager SIP addresses by using commas: + +`-ManagedByUri "sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com"` ```yaml -Type: String +Type: System.Collections.ObjectModel.Collection`1[System.Uri] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -443,34 +479,36 @@ 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. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique name to be assigned to the workflow. +The combination of the Parent property and the Name property enables you to uniquely identify workflows without having to refer to the workflow's globally unique identifier (GUID). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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-\. +### -NonBusinessHoursAction +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Action to be taken if a call is received outside the workflow's business hours. +The NonBusinessHoursAction must be defined by using the New-CsRgsCallAction cmdlet. ```yaml -Type: SwitchParameter +Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -479,53 +517,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before executing the command. +### -Parent +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service where the new workflow will be hosted. +For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` ```yaml -Type: SwitchParameter +Type: RgsIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HolidaySetIDList -Represents days when workflow agents are not available to answer calls. -The holiday set Identities can be retrieved by using the Get-CsRgsHolidaySet cmdlet. +### -PrimaryUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the workflow. +For example: `-PrimaryUri "sip:helpdesk@litwareinc.com".` +The PrimaryUri must begin with the "sip:" prefix. ```yaml -Type: System.Collections.ObjectModel.Collection`1[Microsoft.Rtc.Rgs.Management.RgsIdentity] +Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -TimeZone +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Time zone information used when determining holidays and business hours. +For example: `-TimeZone "Pacific Standard Time"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -534,15 +575,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Managed -When set to True indicates that the workflow will be managed by one or more users. -Those users can be specified by using the ManagedByUri parameter. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -551,21 +595,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ManagersByUri -SIP addresses of the user (or users) who will manage the workflow. -For example: +### -WhatIf -`-ManagedByUri "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. -To specify multiple managers separate the manager SIP addresses by using commas: -`-ManagedByUri "sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com"` ```yaml -Type: System.Collections.ObjectModel.Collection`1[System.Uri] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -579,13 +620,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsRgsWorkflow cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow The New-CsRgsWorkflow cmdlet creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsRoutingConfiguration.md similarity index 84% rename from skype/skype-ps/skype/New-CsRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsRoutingConfiguration.md index b71bf8d54b..cc61d28dfd 100644 --- a/skype/skype-ps/skype/New-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csroutingconfiguration +schema: 2.0.0 +title: New-CsRoutingConfiguration --- # New-CsRoutingConfiguration @@ -45,7 +46,7 @@ This command will create an object only in memory that contains a default list o ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsRoutingConfiguration -Identity global -InMemory @@ -57,37 +58,38 @@ Any other use of this cmdlet will return an error. ## PARAMETERS -### -Identity -The scope of the routing configuration. -This value must be Global. +### -CallViaWorkCallerId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The number the system will display for the callback portion of an external call. +External calls first connect the user making the call by calling a specified number (typically the user's desk phone), once connected to the user, the system dials the outside number. +The CallViaWorkCallerId parameter specifies the number that will be displayed during the first leg, or callback segment, of the call via work external call. +For more information, see New-CsCallViaWorkPolicy. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Route - -A list of all voice routes (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route objects) defined for the Skype for Business Server deployment. - -You can create voice route objects by using the New-CsVoiceRoute cmdlet. -That is the recommended way of adding voice routes to this list. +### -EnableLocationBasedRouting +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. +The default value is False. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,13 +99,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +Aliases: Required: False Position: Named @@ -112,8 +116,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The scope of the routing configuration. +This value must be Global. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -122,8 +147,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +156,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Route + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A list of all voice routes (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route objects) defined for the Skype for Business Server deployment. + +You can create voice route objects by using the New-CsVoiceRoute cmdlet. +That is the recommended way of adding voice routes to this list. + + ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,13 +180,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -164,34 +197,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallViaWorkCallerId -The number the system will display for the callback portion of an external call. -External calls first connect the user making the call by calling a specified number (typically the user's desk phone), once connected to the user, the system dials the outside number. -The CallViaWorkCallerId parameter specifies the number that will be displayed during the first leg, or callback segment, of the call via work external call. -For more information, see New-CsCallViaWorkPolicy. +### -WhatIf -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableLocationBasedRouting -When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. -The default value is False. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -205,12 +220,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnRoutingSettings Can create an in-memory object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnRoutingSettings. ## NOTES diff --git a/skype/skype-ps/skype/New-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/New-CsServerApplication.md similarity index 85% rename from skype/skype-ps/skype/New-CsServerApplication.md rename to skype/skype-ps/SkypeForBusiness/New-CsServerApplication.md index 00a0588174..a7eab23cf2 100644 --- a/skype/skype-ps/skype/New-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsServerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsServerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csserverapplication +schema: 2.0.0 +title: New-CsServerApplication --- # New-CsServerApplication @@ -45,7 +46,7 @@ The New-CsServerApplication cmdlet provides a way for administrators to configur ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsServerApplication -Identity "EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor" -Uri http://www.litwareinc.com/edgemonitor -Critical $False @@ -54,7 +55,7 @@ New-CsServerApplication -Identity "EdgeServer:atl-edge-001.litwareinc.com/EdgeMo Example 1 creates a new server application with the Identity EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor. In addition to specifying the Identity, the parameters Uri and Critical are included; these parameters are used to specify the application URI and to indicate the application is not considered critical. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsServerApplication -Identity "EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor" -InMemory @@ -78,94 +79,99 @@ If you do not call the Set-CsServerApplication cmdlet, no application will be co ## PARAMETERS -### -Identity -Unique identifier for the server application to be created. -Server application Identities are composed of the service where the application is hosted plus the application name. -For example, the server application named QoEAgent might have an Identity similar to this: service:Registrar:atl-cs-001.litwareinc.com/QoEAgent. +### -Critical + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, then Skype for Business Server will not start unless the application in question can be started. +If False, then Skype for Business Server will start regardless of whether or not the application can be started. +If this parameter is not specified the Critical property will be set to True. + + ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent - -Specifies the service that will host the new server application. -If you use the Identity parameter, then you do not need to use either the Parent or the Name parameters; that's because the application Identity combines the values of the Parent and Name properties. -However, you can omit the Identity parameter by using the Parent and Name parameters instead. -In that case, the Parent parameter would need to look something like this: - -`-Parent "Registrar:atl-cs-001.litwareinc.com"` +### -Enabled +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Set this value to True to enable the application. +Set the value to False to disable the application. +If this parameter is not specified the Enabled property will be set to False and the new application will be disabled. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Friendly name for the service. -If you use the Identity parameter you do not need to include the Name parameter when creating a new service; instead, the Name property will be populated using the name portion of the application Identity. -For example, if you create a new application with the Identity service:Registrar:atl-cs-001.litwareinc.com/TestService the application will automatically be named TestService. -The Name parameter is required only if you use the Parent parameter. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False 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`. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the server application to be created. +Server application Identities are composed of the service where the application is hosted plus the application name. +For example, the server application named QoEAgent might have an Identity similar to this: service:Registrar:atl-cs-001.litwareinc.com/QoEAgent. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Set this value to True to enable the application. -Set the value to False to disable the application. -If this parameter is not specified the Enabled property will be set to False and the new application will be disabled. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,38 +180,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Critical - -If set to True, then Skype for Business Server will not start unless the application in question can be started. -If False, then Skype for Business Server will start regardless of whether or not the application can be started. -If this parameter is not specified the Critical property will be set to True. +### -Name +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Friendly name for the service. +If you use the Identity parameter you do not need to include the Name parameter when creating a new service; instead, the Name property will be populated using the name portion of the application Identity. +For example, if you create a new application with the Identity service:Registrar:atl-cs-001.litwareinc.com/TestService the application will automatically be named TestService. +The Name parameter is required only if you use the Parent parameter. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ScriptName -Path to the Microsoft SIP Processing Language (MSPL) script used by the application (if applicable). -MSPL is a scripting language used for filtering and routing SIP messages. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the service that will host the new server application. +If you use the Identity parameter, then you do not need to use either the Parent or the Name parameters; that's because the application Identity combines the values of the Parent and Name properties. +However, you can omit the Identity parameter by using the Parent and Name parameters instead. +In that case, the Parent parameter would need to look something like this: + +`-Parent "Registrar:atl-cs-001.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 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -213,6 +227,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the order of execution for server applications. The application with priority 0 is started first; the application with priority 1 is started second; and so on. Note that each service that hosts a server application has its own unique set of priorities. @@ -226,8 +243,7 @@ For example, if you delete an application that has a priority of 0 then the appl ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,18 +252,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Script -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-\. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to associate the server application with a script. +To add a script to a server application, use syntax similar to this: + +`-Script "Update.ps1"` + +To remove a script, simply set the Script property to a null value: +`-Script $Null` +Each server application can only be associated with one script. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -256,14 +279,17 @@ 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. +### -ScriptName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the Microsoft SIP Processing Language (MSPL) script used by the application (if applicable). +MSPL is a scripting language used for filtering and routing SIP messages. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -272,16 +298,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Uri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique Uniform Resource Identifier (URI) for the application. +For example, the QoEAgent application has the URI `http://www.microsoft.com/LCS/QoEAgent`. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -289,13 +318,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -304,23 +335,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Script -Enables you to associate the server application with a script. -To add a script to a server application, use syntax similar to this: - -`-Script "Update.ps1"` - -To remove a script, simply set the Script property to a null value: +### -WhatIf -`-Script $Null` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Each server application can only be associated with one script. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -334,13 +358,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsServerApplication cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application The New-CsServerApplication cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSimpleUrl.md b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrl.md similarity index 92% rename from skype/skype-ps/skype/New-CsSimpleUrl.md rename to skype/skype-ps/SkypeForBusiness/New-CsSimpleUrl.md index 93d388cd74..5a685c1c1b 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrl.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrl.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurl applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSimpleUrl -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssimpleurl +schema: 2.0.0 +title: New-CsSimpleUrl --- # New-CsSimpleUrl @@ -65,7 +66,7 @@ After updating a simple URL collection, you must then run the Enable-CsComputer ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com" @@ -86,7 +87,37 @@ This syntax causes the URL stored in the object reference $simpleUrl to be added ## PARAMETERS +### -ActiveUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the URL that is actually to be accessed by users. +The SimpleUrlEntry property can contain multiple URLs, but only one of those URLs can be active at a given time. +An error will occur if you try to set the ActiveUrl to a value not found in the SimpleUrlEntry property. + +To assign an active URL, simply use the URL itself as the parameter value. +For example: + +`-ActiveUrl "https://meet.litwareinc.com"` + + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Component + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the type of simple URL being created. Valid values are: @@ -105,8 +136,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -117,6 +147,8 @@ Accept wildcard characters: False ### -Domain +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP domain for the simple URL. For example: @@ -127,8 +159,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -138,6 +169,9 @@ Accept wildcard characters: False ``` ### -SimpleUrlEntry + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of URLs for the specified component. For example, both `https://meet.litwareinc.com` and `https://litwareinc.com/meet` might be configured as URL entries for the Meet component. However, only one of those URLs can be (and must be) configured as the active URL. @@ -147,34 +181,7 @@ Simple URL entries must be created by using the New-CsSimpleUrlEntry cmdlet. ```yaml Type: PSListModifier 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 -``` - -### -ActiveUrl - -Indicates the URL that is actually to be accessed by users. -The SimpleUrlEntry property can contain multiple URLs, but only one of those URLs can be active at a given time. -An error will occur if you try to set the ActiveUrl to a value not found in the SimpleUrlEntry property. - -To assign an active URL, simply use the URL itself as the parameter value. -For example: - -`-ActiveUrl "https://meet.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 +Aliases: Required: False Position: Named @@ -188,13 +195,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSimpleUrl cmdlet does not accept pipelined data. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.SimpleUtl.SimpleUrl The New-CsSimpleUrl cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.SimpleUtl.SimpleUrl object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlConfiguration.md index 4bcbbf4b6a..703170baa3 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSimpleUrlConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssimpleurlconfiguration +schema: 2.0.0 +title: New-CsSimpleUrlConfiguration --- # New-CsSimpleUrlConfiguration @@ -63,7 +64,7 @@ After updating a simple URL collection you must then run the Enable-CsComputer c ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsSimpleUrlConfiguration -Identity "site:Redmond" @@ -74,7 +75,7 @@ Because no parameters other than Identity are included with this command, the ne This command will fail if the Redmond site already hosts a simple URL collection. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://dialin.fabrikam.com" @@ -103,45 +104,44 @@ That syntax causes the URLs stored in the object references $simpleUrl and $simp ## PARAMETERS -### -Identity - -Unique identifier for the new simple URL configuration collection. -If there isn't a simple URL Configuration at Global level at the time the cmdlet is run, and if this parameter isn't specified, it will default to Global level, thus making this parameter optional in that case. -Because new collections after Global level can only be created at the site scope, the Identity must be the prefix "site:" followed by the name of the site, thus making this parameter mandatory. -For example, this syntax creates a new collection for the Redmond site: - -`-Identity "site:Redmond"` +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SimpleUrl +### -Identity -Simple URLs that have been configured for this collection. -These URLs must be created by using the New-SimpleUrl cmdlet and the New-SimpleUrlEntry cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new simple URL configuration collection. +If there isn't a simple URL Configuration at Global level at the time the cmdlet is run, and if this parameter isn't specified, it will default to Global level, thus making this parameter optional in that case. +Because new collections after Global level can only be created at the site scope, the Identity must be the prefix "site:" followed by the name of the site, thus making this parameter mandatory. +For example, this syntax creates a new collection for the Redmond site: + +`-Identity "site:Redmond"` ```yaml -Type: PSListModifier +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -149,6 +149,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -157,8 +159,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,14 +168,19 @@ 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. +### -SimpleUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Simple URLs that have been configured for this collection. +These URLs must be created by using the New-SimpleUrl cmdlet and the New-SimpleUrlEntry cmdlet. + + ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,6 +191,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new Simple URL configuration settings are being created. For example: @@ -199,8 +207,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,14 +216,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -225,14 +234,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -246,12 +257,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration The New-CsSimpleUrlConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSimpleUrlEntry.md b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlEntry.md similarity index 95% rename from skype/skype-ps/skype/New-CsSimpleUrlEntry.md rename to skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlEntry.md index f748308d5a..2f9e850afb 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrlEntry.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlEntry.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurlentry applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSimpleUrlEntry -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssimpleurlentry +schema: 2.0.0 +title: New-CsSimpleUrlEntry --- # New-CsSimpleUrlEntry @@ -69,7 +70,7 @@ After updating a simple URL collection, you must then run the Enable-CsComputer ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com" @@ -90,7 +91,7 @@ This is done by using the Set-CsSimpleUrlConfiguration cmdlet, the SimpleUrl par This syntax causes the URL stored in the object reference $simpleUrl to be added to the SimpleUrl property. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com" @@ -121,6 +122,8 @@ This syntax causes the URLs stored in the object references $simpleUrl and $simp ### -Url +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL to be added to the SimpleUrlEntry property of a simple URL. For example: @@ -133,8 +136,7 @@ URLs must start with the "https:" prefix. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -148,13 +150,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### -The New-CsSimpleUrlEntry cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.SimpleUtl.SimpleUrlEntry object. +### Microsoft.Rtc.Management.WritableConfig.SimpleUrl.SimpleUrlEntry +The New-CsSimpleUrlEntry cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.SimpleUrl.SimpleUrlEntry object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsSipDomain.md similarity index 85% rename from skype/skype-ps/skype/New-CsSipDomain.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipDomain.md index e3f6128773..70ad4b3151 100644 --- a/skype/skype-ps/skype/New-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipdomain +schema: 2.0.0 +title: New-CsSipDomain --- # New-CsSipDomain @@ -39,7 +40,7 @@ That is something you can do by running the New-CsSipDomain cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsSipDomain -Identity fabrikam.com @@ -48,7 +49,7 @@ New-CsSipDomain -Identity fabrikam.com The command shown in Example 1 creates a new SIP domain, one that has the Identity fabrikam.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsSipDomain -Identity fabrikam.com -IsDefault $True @@ -61,8 +62,28 @@ That's because you can have only one default SIP domain. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) for the new SIP domain. For example: @@ -73,8 +94,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -85,6 +105,8 @@ Accept wildcard characters: False ### -IsDefault +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the domain is the default SIP domain, the domain used by Skype for Business Server any time a domain name is not explicitly stated. If set to True, the new domain will also become the new default domain @@ -98,8 +120,7 @@ If you change the default SIP domain you will need to restart the RTCCAA and RTC ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,14 +129,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -125,29 +148,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -161,14 +170,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSipDomain cmdlet does not accept pipelined data. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.SipDomain The New-CsSipDomain cmdlet creates new instances of the Microsoft.Rtc.Management.Xds.SipDomain object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyCustom.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyCustom.md similarity index 89% rename from skype/skype-ps/skype/New-CsSipProxyCustom.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyCustom.md index 1e9b87ddfd..a050f4e734 100644 --- a/skype/skype-ps/skype/New-CsSipProxyCustom.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyCustom.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxycustom applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyCustom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxycustom +schema: 2.0.0 +title: New-CsSipProxyCustom --- # New-CsSipProxyCustom @@ -37,7 +38,7 @@ You can create a custom realm by using the New-CsSipProxyCustom cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsSipProxyCustom -CustomValue "Litwareinc Communications Service" @@ -49,13 +50,15 @@ The command shown in Example 1 assigns a custom realm (Litwareinc Communications ## PARAMETERS ### -CustomValue + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the realm to be used for authentication purposes. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -69,13 +72,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSipProxyCustom cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Custom The New-CsSipProxyCustom cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Custom object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyRealm.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyRealm.md similarity index 92% rename from skype/skype-ps/skype/New-CsSipProxyRealm.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyRealm.md index 28a9713563..d337191b26 100644 --- a/skype/skype-ps/skype/New-CsSipProxyRealm.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyRealm.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyrealm applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyRealm -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxyrealm +schema: 2.0.0 +title: New-CsSipProxyRealm --- # New-CsSipProxyRealm @@ -39,7 +40,7 @@ However, because this cmdlet requires an additional step you might want to use t ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsSipProxyUseDefault @@ -53,7 +54,7 @@ To do this, the first command calls the New-CsSipProxyUseDefault cmdlet in order In the second command, $x is used as the parameter value for the New-CsSipProxyRealm cmdlet and the RealmChoice parameter. In turn, this creates a new proxy realm object that is stored in a variable named $y. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsSipProxyCustom -CustomValue "Litwareinc Communications Service" @@ -70,14 +71,16 @@ In the second command, $x is used, along with the New-CsSipProxyRealm cmdlet and ## PARAMETERS ### -RealmChoice + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object representing the realm to be used by a proxy server. The RealmChoice must be created by using either the New-CsSipProxyUseDefault or the New-CsSipProxyCustom cmdlet. ```yaml Type: IRealmChoice Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -91,13 +94,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSipProxyRealm cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Realm The New-CsSipProxyRealm cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Realm object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyTCP.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTCP.md similarity index 93% rename from skype/skype-ps/skype/New-CsSipProxyTCP.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyTCP.md index 60a6fa4a29..3e40591f16 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTCP.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTCP.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytcp applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyTCP -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxytcp +schema: 2.0.0 +title: New-CsSipProxyTCP --- # New-CsSipProxyTCP @@ -49,7 +50,7 @@ You do not need to use the New-CsSipProxyTCP cmdlet if you use the New-CsStaticR ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` After the SipProxy.TCP object has been created, the New-CsSipProxyTransport cmdlet creates a TCP transport object. @@ -66,14 +67,16 @@ To do this, the first command in the example uses the New-CsSipProxyTCP cmdlet t ## PARAMETERS ### -IPAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + IP address of the next hop router. For example: -IPAddress 192.168.0.240. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -87,13 +90,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSipProxyTCP cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.TCP The New-CsSipProxyTCP cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.TCP object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyTLS.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTLS.md similarity index 92% rename from skype/skype-ps/skype/New-CsSipProxyTLS.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyTLS.md index 8083398419..73f8147ce9 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTLS.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTLS.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytls applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyTLS -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxytls +schema: 2.0.0 +title: New-CsSipProxyTLS --- # New-CsSipProxyTLS @@ -51,7 +52,7 @@ The New-CsSipProxyTLS cmdlet is not required if you use the New-CsStaticRoute cm ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $cert = New-CsSipProxyUseDefaultCert @@ -72,13 +73,15 @@ As soon as the TLS object exists, that object (and the TLS protocol) can be adde ## PARAMETERS ### -Certificate + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Certificate to be used for TLS authentication. ```yaml Type: ITLSTLSChoice Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -89,6 +92,8 @@ Accept wildcard characters: False ### -Fqdn +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the next hop server. For example: @@ -99,8 +104,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -114,13 +118,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSipProxyTLS cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.TLS The New-CsSipProxyTLS cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.TLS object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyTransport.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTransport.md similarity index 92% rename from skype/skype-ps/skype/New-CsSipProxyTransport.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyTransport.md index 3986103a26..29fc29778b 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTransport.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTransport.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytransport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyTransport -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxytransport +schema: 2.0.0 +title: New-CsSipProxyTransport --- # New-CsSipProxyTransport @@ -48,7 +49,7 @@ You do not need to use the `New-CsSipProxyTransport` cmdlet if you are using the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $cert = New-CsSipProxyUseDefaultCert @@ -63,7 +64,7 @@ This object, stored in a variable named $cert, instructs Skype for Business Serv After the UseDefaultCert object has been created, the `New-CsSipProxyTLS` cmdlet can be called to create a new SipProxy.TLS object, one that uses the default certificate and points to atl-proxy-001.litwareinc.com as the fully qualified domain name (FQDN) of the next hop server. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $tcp = New-CsSipProxyTCP -IPAddress 192.168.1.100 @@ -79,14 +80,16 @@ After the SipProxy.TCP object has been created, the `New-CsSipProxyTransport` cm ## PARAMETERS ### -Port + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number used for SIP routing. For example: `-Port 7742`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -TransportChoice + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the transmission protocol (TCP or TLS) to be used on the static route. To use the TCP protocol, create a transport object by using the `New-CsSipProxyTCP` cmdlet. To use the TLS protocol, create a transport object by using the `New-CsSipProxyTLS` cmdlet. @@ -103,8 +109,7 @@ To use the TLS protocol, create a transport object by using the `New-CsSipProxyT ```yaml Type: ITransportChoice Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -118,13 +123,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsSipProxyTransport` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Transport The `New-CsSipProxyTransport` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Transport object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyUseDefault.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefault.md similarity index 84% rename from skype/skype-ps/skype/New-CsSipProxyUseDefault.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefault.md index c4b0c49aba..ac656386a6 100644 --- a/skype/skype-ps/skype/New-CsSipProxyUseDefault.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefault.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyusedefault applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyUseDefault -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxyusedefault +schema: 2.0.0 +title: New-CsSipProxyUseDefault --- # New-CsSipProxyUseDefault @@ -33,7 +34,7 @@ If you change the realm and then want to revert back to using the default realm, ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = New-CsSipProxyUseDefault ``` @@ -43,34 +44,17 @@ The command shown in Example 1 assigns the default realm (SIP Communications Ser ## PARAMETERS -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None. +### None The `New-CsSipProxyUseDefault` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.UseDefault The `New-CsSipProxyUseDefault` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.UseDefault object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefaultCert.md similarity index 91% rename from skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefaultCert.md index c3e2de765f..27130ad504 100644 --- a/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefaultCert.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyusedefaultcert applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyUseDefaultCert -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxyusedefaultcert +schema: 2.0.0 +title: New-CsSipProxyUseDefaultCert --- # New-CsSipProxyUseDefaultCert @@ -43,7 +44,7 @@ Note that the New-CsSipProxyUseDefaultCert cmdlet is not required if you use the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $cert = New-CsSipProxyUseDefaultCert @@ -62,34 +63,17 @@ As soon as the TLS object exists, that object (and the TLS protocol) can be adde ## PARAMETERS -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None. +### None The `New-CsSipProxyUseDefaultCert` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.UseDefaultCert The `New-CsSipProxyUseDefaultCert` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.UseDefaultCert object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsSipResponseCodeTranslationRule.md similarity index 86% rename from skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipResponseCodeTranslationRule.md index 79e5457a51..5279411e43 100644 --- a/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipResponseCodeTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipResponseCodeTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipresponsecodetranslationrule +schema: 2.0.0 +title: New-CsSipResponseCodeTranslationRule --- # New-CsSipResponseCodeTranslationRule @@ -57,7 +58,7 @@ Translation rules can be assigned to the global scope, the site scope, or to the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" -ReceivedResponseCode 434 -TranslatedResponseCode 404 ``` @@ -66,7 +67,7 @@ The command shown in Example 1 creates a new SIP response code translation rule This rule translates a received response code of 434 to the standard SIP response code 404 (Not Found). -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsSipResponseCodeTranslationRule -Parent "PstnGateway:192.168.0.240" -Name "Rule404" -ReceivedResponseCode 434 -TranslatedResponseCode 404 ``` @@ -78,7 +79,28 @@ This simply shows an alternate way of creating a new SIP response code translati ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the translation rule to be created. The identity for a translation rule consists of two parts: the scope where the rule is to be assigned and the name to be given to the rule. For example, a translation rule named Rule404 to be created at the global scope would have an Identity that looks like this: global/Rule404. @@ -88,8 +110,7 @@ Instead of using the Identity parameter, you can use the Parent and Name paramet ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -98,18 +119,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TranslatedResponseCode -Value of the Skype for Business Server SIP response code that the ReceivedResponseCode and/or the ReceivedISUPCauseCode should be translated to. -Translated response codes can be any integer value between 400 and 699, inclusive. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -117,6 +140,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name used to differentiate one translation rule from another. Names must be unique within a given scope; for example, the Redmond site can only have one translation rule named Rule404. However, you can have a translation rule named Rule404 at the Redmond site and another rule named Rule404 at the Dublin site. @@ -126,8 +152,7 @@ The Name parameter must always be used in conjunction with the Parent parameter. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -137,6 +162,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope where the new translation rule is to be assigned. To assign a rule to the global scope, use this syntax: @@ -156,8 +184,7 @@ The Parent parameter must always be used in conjunction with the Name parameter. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -167,6 +194,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Relative priority of the translation rule. Rules are processed in order of their assigned priority; the first rule to be processed has a priority of 0; the second rule to be processed has a priority of 1 and so on. If not specified the new rule will be given the lowest priority in its scope. @@ -174,8 +204,7 @@ If not specified the new rule will be given the lowest priority in its scope. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,18 +213,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceivedResponseCode -Value of the SIP response code used by a gateway when responding to an INVITE message. -A response code can be any integer value between 400 and 699, inclusive. -Although the cmdlet will accept integer values less than 400, these are not recognized as final responses. -As a result, the translation rule will never be used. -A value of 0 means that only the ISUP cause code will be used when executing the translation rule; the SIP response code will be ignored. +### -ReceivedISUPCauseValue + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Value of the ISDN User Part (ISUP) code that must be present in the SIP response message used by a gateway when responding to an INVITE message. +A value of -1 indicates that only the SIP response code will be used when executing the translation rule; the ISUP cause code will be ignored. + ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,16 +233,20 @@ 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-\. +### -ReceivedResponseCode +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Value of the SIP response code used by a gateway when responding to an INVITE message. +A response code can be any integer value between 400 and 699, inclusive. +Although the cmdlet will accept integer values less than 400, these are not recognized as final responses. +As a result, the translation rule will never be used. +A value of 0 means that only the ISUP cause code will be used when executing the translation rule; the SIP response code will be ignored. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,32 +255,20 @@ 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. +### -TranslatedResponseCode -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Value of the Skype for Business Server SIP response code that the ReceivedResponseCode and/or the ReceivedISUPCauseCode should be translated to. +Translated response codes can be any integer value between 400 and 699, inclusive. -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -255,13 +276,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -270,16 +293,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceivedISUPCauseValue -Value of the ISDN User Part (ISUP) code that must be present in the SIP response message used by a gateway when responding to an INVITE message. -A value of -1 indicates that only the SIP response code will be used when executing the translation rule; the ISUP cause code will be ignored. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -293,14 +316,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsSipResponseCodeTranslationRule` cmdlet does not accept pipelined input. ## OUTPUTS -### -The `New-CsSipResponseCodeTranslationRule` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTRanslationRule#Decorated object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule +The `New-CsSipResponseCodeTranslationRule` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTTranslationRule object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsStaticRoute.md b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoute.md similarity index 87% rename from skype/skype-ps/skype/New-CsStaticRoute.md rename to skype/skype-ps/SkypeForBusiness/New-CsStaticRoute.md index f7208b4025..14f6ec2ce5 100644 --- a/skype/skype-ps/skype/New-CsStaticRoute.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csstaticroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsStaticRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csstaticroute +schema: 2.0.0 +title: New-CsStaticRoute --- # New-CsStaticRoute @@ -47,7 +48,7 @@ After a route has been created by using the `New-CsStaticRoute` cmdlet, you must ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = New-CsStaticRoute -TCPRoute -Destination "192.168.0.100" -Port 8025 -MatchUri "litwareinc.com" @@ -64,7 +65,7 @@ This is done by calling the `Set-CsStaticRoutingConfiguration` cmdlet along with The parameter value @{Add=$x} adds the route object stored in $x to the existing set of routes already in the global collection. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = New-CsStaticRoute -TLSRoute -Destination "atl-proxy-001.litwareinc.com" -Port 8025 -MatchUri "*.litwareinc.com" -UseDefaultCertificate $True @@ -79,7 +80,7 @@ In addition, the new route object, which is stored in a variable named $x, uses After the route object has been created, the second command in the example then adds the new route to the global static routing configuration collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $x = New-CsStaticRoute -TLSRoute -Destination "atl-proxy.litwareinc.com" -Port 5061 -MatchUri "litwareinc.com" -UseDefaultCertificate $False -TLSCertIssuer "CN=CertificateAuthority, DC=litwareinc, DC=com" -TLSCertSerialNumber 0x8f,0x33,0x70,0x93,0x70,0x05,0x33,0x00,0x02,0x33 @@ -94,6 +95,9 @@ After the route object has been created, the second command in the example then ## PARAMETERS ### -Destination + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If the route uses Transport Layer Security (TLS) as the transport protocol, then the Destination is the fully qualified domain name (FQDN) of the next hop server. For example: `-Destination "atl-proxy-001.litwareinc.com"` @@ -104,8 +108,7 @@ For example: `-Destination "192.168.0.240"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -114,39 +117,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MatchUri -FQDN or domain suffix used to determine if the message is being sent to a user handled by this route. -For example, you might use the FQDN "litwareinc.com". -This pattern matches any user who has a SIP address that ends with the domain name "litwareinc.com". +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, then the route is enabled and any messages matching the MatchURI pattern will be routed to the next hop server. +If set to False, the route is disabled and will not be used in routing messages. +The default value is True. -To match child domains of a domain, you can use a wildcard value like "*.litwareinc.com". -That value matches any domain that ends with the suffix "litwareinc.com". -For example: northamerica.litwareinc.com; asia.litwareinc.com and europe.litwareinc.com. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -If set to True, then the route is enabled and any messages matching the MatchURI pattern will be routed to the next hop server. -If set to False, the route is disabled and will not be used in routing messages. -The default value is True. +### -MatchOnlyPhoneUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +If set to True, only messages addressed to phone Uniform Resource identifiers (URIs) (for example, sip:kenmmyer@litwareinc.com;user=phone) will be matched and potentially, routed. +If set to False (the default value) then all messages will be matched. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,17 +157,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MatchOnlyPhoneUri -If set to True, only messages addressed to phone Uniform Resource identifiers (URIs) (for example, sip:kenmmyer@litwareinc.com;user=phone) will be matched and potentially, routed. -If set to False (the default value) then all messages will be matched. +### -MatchUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN or domain suffix used to determine if the message is being sent to a user handled by this route. +For example, you might use the FQDN "litwareinc.com". +This pattern matches any user who has a SIP address that ends with the domain name "litwareinc.com". + +To match child domains of a domain, you can use a wildcard value like "*.litwareinc.com". +That value matches any domain that ends with the suffix "litwareinc.com". +For example: northamerica.litwareinc.com; asia.litwareinc.com and europe.litwareinc.com. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -173,6 +182,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number used for SIP routing. For example: `-Port 7742` @@ -180,8 +192,7 @@ For example: `-Port 7742` ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -ReplaceHostInRequestUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True ($True) then the host portion of a Request-URI will be replaced by the address of the next hop server. If set the False then the Request-URI will be used as-is. The Request-URI represents the URI of the user or service that the request (message) is addressed to. @@ -199,8 +213,7 @@ The default value is 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 +Aliases: Required: False Position: Named @@ -210,13 +223,15 @@ Accept wildcard characters: False ``` ### -TCPRoute + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Configures TCP as the transport protocol for the new route. ```yaml Type: SwitchParameter Parameter Sets: TCP -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -226,6 +241,9 @@ Accept wildcard characters: False ``` ### -TLSCertIssuer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the certification authority (CA) that issued the certificate to be used in the static route. This parameter is not used if you have configured TCP as the transport protocol. @@ -234,8 +252,7 @@ If you include the TLSCertIssuer parameter then you must also use the TLSCertSer ```yaml Type: String Parameter Sets: TLS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,6 +262,9 @@ Accept wildcard characters: False ``` ### -TLSCertSerialNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Serial number of the TLS certificate to be used in the static route. Serial numbers must be passed as a byte array; this means you must pass the serial number as an array of two-character values. For example: `-TLSCertSerialNumber 0x01, 0xA4, 0xD5, 0x67, 0x89` @@ -257,8 +277,7 @@ If you include the TLSCertSerialNumber parameter then you must also use the TLSC ```yaml Type: Byte[] Parameter Sets: TLS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,13 +287,15 @@ Accept wildcard characters: False ``` ### -TLSRoute + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Configures TLS as the transport protocol for the new route. ```yaml Type: SwitchParameter Parameter Sets: TLS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -284,6 +305,9 @@ Accept wildcard characters: False ``` ### -UseDefaultCertificate + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Configures the route to use your default Skype for Business Server certificate as its authentication certificate. If you do not want to use the default certificate then you must specify a different certificate by using the TLSCertIssuer and TLSCertSerialNumber parameters. @@ -295,8 +319,7 @@ To view the default certificate, use the following command: ```yaml Type: Boolean Parameter Sets: TLS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -310,13 +333,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsStaticRoute` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Route The `New-CsStaticRoute` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Route object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoutingConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsStaticRoutingConfiguration.md index f59880c6ef..8420d95040 100644 --- a/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsStaticRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csstaticroutingconfiguration +schema: 2.0.0 +title: New-CsStaticRoutingConfiguration --- # New-CsStaticRoutingConfiguration @@ -39,7 +40,7 @@ In addition to that, you can use the `New-CsStaticRoutingConfiguration` cmdlet t ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" ``` @@ -48,7 +49,7 @@ Example 1 creates a new static routing configuration collection with the Identit Because the Route parameter is not included in the command, the new collection will not have any static routes assigned to it. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = New-CsStaticRoute -TCPRoute -Destination "192.168.0.100" -Port 8025 -MatchUri "*.litwareinc.com" @@ -64,7 +65,28 @@ After that, the `New-CsStaticRoutingConfiguration` cmdlet is called to create a ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new static routing collection to be created. New collections can only be created at the service scope and can only be assigned to the Registrar service. Because of that, the Identity for a new collection must look similar to this: @@ -75,8 +97,7 @@ Because of that, the Identity for a new collection must look similar to this: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -85,32 +106,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Route -Individual static routes maintained within the collection. -Routes to be added to a collection must either by copied from another collection or created using the `New-CsStaticRoute` cmdlet. -For details, see the Examples section in this topic. +### -InMemory -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +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-\. -### -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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,16 +126,18 @@ 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-\. +### -Route +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Individual static routes maintained within the collection. +Routes to be added to a collection must either by copied from another collection or created using the `New-CsStaticRoute` cmdlet. +For details, see the Examples section in this topic. ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,14 +146,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -153,14 +164,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -174,13 +187,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsStaticRoutingConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings The `New-CsStaticRoutingConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsStorageServiceConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsStorageServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsStorageServiceConfiguration.md index b9fb8758da..9ece5b6e06 100644 --- a/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsStorageServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsStorageServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csstorageserviceconfiguration +schema: 2.0.0 +title: New-CsStorageServiceConfiguration --- # New-CsStorageServiceConfiguration @@ -38,7 +39,7 @@ Skype for Business Server Control Panel: The functions carried out by the `New-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsStorageServiceConfiguration -Identity "site:Redmond" ``` @@ -48,40 +49,34 @@ The command shown in Example 1 creates a new collection of storage service confi ## PARAMETERS -### -Identity -Unique identifier for the new collection of storage service configuration settings to be created. -Storage service settings can be created at the site scope or the service scope (but only for the Registrar service). -To create a new collections of settings at the site scope, use syntax similar to this: - -`-Identity "site:Redmond"` - -To create settings at the service scope, use syntax similar to this: +### -EnableAsyncAdaptorTaskAbort -`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Note that your command will fail if the specified site or service already hosts a collection of storage service configuration settings. +PARAMVALUE: $true | $false ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableAutoImportFlushedData + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,14 +85,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAsyncAdaptorTaskAbort +### -EnableFabricReplicationSetReduction + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,14 +103,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAutoImportFlushedData -PARAMVALUE: $true | $false +### -FabricInvalidStateTimeoutDuration + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: UInt64 ```yaml -Type: Boolean +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +121,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFabricReplicationSetReduction -PARAMVALUE: $true | $false +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any nonfatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,30 +139,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FabricInvalidStateTimeoutDuration -PARAMVALUE: UInt64 +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new collection of storage service configuration settings to be created. +Storage service settings can be created at the site scope or the service scope (but only for the Registrar service). +To create a new collections of settings at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +To create settings at the service scope, use syntax similar to this: + +`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` + +Note that your command will fail if the specified site or service already hosts a collection of storage service configuration settings. ```yaml -Type: UInt64 +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any nonfatal error message that might occur when running the command. +### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,15 +186,16 @@ 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-\. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -188,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -208,13 +227,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsStorageServiceConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings The `New-CsStorageServiceConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsTeamsUpgradePolicy.md similarity index 96% rename from skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsTeamsUpgradePolicy.md index e0076883f9..6d121fd2ea 100644 --- a/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTeamsUpgradePolicy.md @@ -1,14 +1,14 @@ --- -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 2015, Skype for Business Server 2019 -title: New-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csteamsupgradepolicy +schema: 2.0.0 +title: New-CsTeamsUpgradePolicy --- # New-CsTeamsUpgradePolicy @@ -53,15 +53,16 @@ This creates a policy for users that can be granted as desired to individual use ## PARAMETERS -### -NotifySfbUsers +### -Description -Determines whether users who are assigned this policy will see a notification in their Skype for Business client about a pending upgrade to Teams. In addition, if NotifySfBUsers=true and TeamsUpgradeConfiguration has DownloadTeams=true, Win32 versions of Skype for Business will silently download the Teams client. +> Applicable: Skype for Business Server 2019 + +Free form text that can be used as needed by administrators. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -69,33 +70,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Free form text that can be used as needed by administrators. +> Applicable: Skype for Business Server 2019 + +The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\" where \ is the name of the site. To specify a policy that can be assigned as needed to any users, simply specify a name of your choosing. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity +### -NotifySfbUsers -The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\" where \ is the name of the site. To specify a policy that can be assigned as needed to any users, simply specify a name of your choosing. +> Applicable: Skype for Business Server 2019 + +Determines whether users who are assigned this policy will see a notification in their Skype for Business client about a pending upgrade to Teams. In addition, if NotifySfBUsers=true and TeamsUpgradeConfiguration has DownloadTeams=true, Win32 versions of Skype for Business will silently download the Teams client. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/New-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsTelemetryConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsTelemetryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsTelemetryConfiguration.md index 8cff3d883a..dcbf5fdff4 100644 --- a/skype/skype-ps/skype/New-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTelemetryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTelemetryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstelemetryconfiguration +schema: 2.0.0 +title: New-CsTelemetryConfiguration --- # New-CsTelemetryConfiguration @@ -28,7 +29,7 @@ For privacy information, see the Skype for Business Privacy Statement (https://g ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsTelemetryConfiguration -Identity Site:Redmond -EnableClientTelemetry $True ``` @@ -38,42 +39,35 @@ This example creates a new telemetry configuration with telemetry enabled and sc ## PARAMETERS -### -Identity -A unique identifier that includes the scope of the telemetry configuration. -Telemetry configurations can be scoped at the Global, Site, or Service level. -For example, "site:Redmond" (for site). -The format of the service scope is "Service:\", where identity is derived from the topology. -You can use the following commands to identify the relevant services. - -`Get-CsService -WebServer | fl Identity` +### -EnableClientTelemetry -`Get-CsService -PoolFqdn \ | fl Identity` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -The first command will give you all of the WebServices in the topology, regardless of the pool. -The second will give you all of the services on the pool, regardless of their role. -You can combine the two commands to zero in on a single role in a single pool. +When set to true, client telemetry will be enabled. +The default is false. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -82,31 +76,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableClientTelemetry -When set to true, client telemetry will be enabled. -The default is false. +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier that includes the scope of the telemetry configuration. +Telemetry configurations can be scoped at the Global, Site, or Service level. +For example, "site:Redmond" (for site). +The format of the service scope is "Service:\", where identity is derived from the topology. +You can use the following commands to identify the relevant services. + +`Get-CsService -WebServer | fl Identity` + +`Get-CsService -PoolFqdn \ | fl Identity` + +The first command will give you all of the WebServices in the topology, regardless of the pool. +The second will give you all of the services on the pool, regardless of their role. +You can combine the two commands to zero in on a single role in a single pool. ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,15 +125,16 @@ 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-\. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -133,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -153,13 +166,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/New-CsTenantUpdateTimeWindow.md similarity index 88% rename from skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md rename to skype/skype-ps/SkypeForBusiness/New-CsTenantUpdateTimeWindow.md index 11a5b21e8e..7fe75be3ec 100644 --- a/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTenantUpdateTimeWindow.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstenantupdatetimewindow applicable: Skype for Business Online -title: New-CsTenantUpdateTimeWindow -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstenantupdatetimewindow +schema: 2.0.0 +title: New-CsTenantUpdateTimeWindow --- # New-CsTenantUpdateTimeWindow @@ -62,7 +64,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsTenantUpdateTimeWindow -Identity FirstAndLastWeekend -Monthly -WeeksOfMonth First,Last -DaysOfWeek Sunday,Saturday -StartTime 1:00 -Duration 5:00 ``` @@ -70,7 +72,7 @@ New-CsTenantUpdateTimeWindow -Identity FirstAndLastWeekend -Monthly -WeeksOfMont This example creates a new tenant update time window in the tenant in Monthly type. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsTenantUpdateTimeWindow -Identity MidDay -Monthly -DayOfMonth 15 -StartTime 5:00 -Duration 6:00 ``` @@ -78,7 +80,7 @@ New-CsTenantUpdateTimeWindow -Identity MidDay -Monthly -DayOfMonth 15 -StartTime This example creates a new tenant update time window in the tenant in Monthly type. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` New-CsTenantUpdateTimeWindow -Identity Weekday -Weekly -DaysOfWeek Monday,Tuesday,Wednesday,Thursday,Friday -StartTime 3:00 -Duration 10:00 ``` @@ -86,7 +88,7 @@ New-CsTenantUpdateTimeWindow -Identity Weekday -Weekly -DaysOfWeek Monday,Tuesda This example creates a new tenant update time window in the tenant in Weekly type. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` New-CsTenantUpdateTimeWindow -Identity Night -Daily ``` @@ -97,13 +99,15 @@ This example creates a new tenant update time window in the tenant in Daily type ## PARAMETERS ### -Daily + +> Applicable: Skype for Business Online + Type of Time window is daily. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -113,14 +117,16 @@ Accept wildcard characters: False ``` ### -DayOfMonth + +> Applicable: Skype for Business Online + Day of month. It must be defined when Type is Monthly. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -130,6 +136,9 @@ Accept wildcard characters: False ``` ### -DaysOfWeek + +> Applicable: Skype for Business Online + Days of week. It can be multiple days separated by a comma. It must be defined when Type is Weekly or Monthly. @@ -137,8 +146,7 @@ It must be defined when Type is Weekly or Monthly. ```yaml Type: TenantUpdateTimeWindowDayOfWeek Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -147,30 +155,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the identity of the tenant update time window. +### -Duration + +> Applicable: Skype for Business Online + +Duration of the update time window. ```yaml -Type: XdsGlobalRelativeIdentity +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Monthly -Type of Time window is monthly. +### -Force + +> Applicable: Skype for Business Online + +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 +Aliases: Required: False Position: Named @@ -179,32 +193,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Weekly -Type of Time window is weekly. +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the tenant update time window. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WeeksOfMonth -Weeks of month. -It can be multiple weeks separated by a comma. -It must be defined when Type is Monthly. +### -InMemory + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: TenantUpdateTimeWindowWeekOfMonth +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -213,14 +229,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Monthly + +> Applicable: Skype for Business Online + +Type of Time window is monthly. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -229,14 +247,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Duration -Duration of the update time window. +### -StartTime + +> Applicable: Skype for Business Online + +Time of day when the update time window starts. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -245,16 +265,16 @@ 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. +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -263,14 +283,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -PARAMVALUE: SwitchParameter +### -Weekly + +> Applicable: Skype for Business Online + +Type of Time window is weekly. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -279,14 +301,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartTime -Time of day when the update time window starts. +### -WeeksOfMonth + +> Applicable: Skype for Business Online + +Weeks of month. +It can be multiple weeks separated by a comma. +It must be defined when Type is Monthly. ```yaml -Type: TimeSpan +Type: TenantUpdateTimeWindowWeekOfMonth Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -295,14 +321,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -312,13 +340,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/New-CsTestDevice.md similarity index 86% rename from skype/skype-ps/skype/New-CsTestDevice.md rename to skype/skype-ps/SkypeForBusiness/New-CsTestDevice.md index 74d4439948..d42996a9c5 100644 --- a/skype/skype-ps/skype/New-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTestDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTestDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstestdevice +schema: 2.0.0 +title: New-CsTestDevice --- # New-CsTestDevice @@ -46,7 +47,7 @@ These devices can be configured at either the global scope or the site scope. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTestDevice -Identity site:Redmond/UCPhone -IdentifierType SerialNumber -Identifier "07823-A345" ``` @@ -56,7 +57,7 @@ Note the syntax used to specify the device Identity: the device scope (site:Redm This device uses the serial number as the IdentifierType and has a serial number of 07823-A345. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsTestDevice -Parent "site:Redmond" -Name UCPhone -IdentifierType SerialNumber -Identifier "07823-A345" ``` @@ -69,28 +70,28 @@ The `New-CsTestDevice` cmdlet will take those two parameter values and construct ## PARAMETERS -### -Identity -Indicates the Identity for the new test device. -An Identity consists of both the scope where the test device is to be assigned (for example, site:Redmond) and the name for the new device (for example, UCPhone). -To assign a test device named UCPhone to the Redmond site, your Identity parameter must look like this: +### -Force -`-Identity "site:Redmond/UCPhone"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Identifier + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Based on the IdentifierType, indicates the Media Access Control (MAC) address or serial number of the new test device. Serial numbers can be specified using numbers, letters, hyphens and underscores; for example: @@ -110,8 +111,7 @@ A MAC address such as 01-02-03-04-05 will not be accepted because it does not ha ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -121,6 +121,9 @@ Accept wildcard characters: False ``` ### -IdentifierType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the test device will be uniquely identified by its MAC address or by its serial number. To identify a device by its MAC address, set the IdentifierType to MACAddress. To identify a device by its serial number, set the IdentifierType to SerialNumber. @@ -129,8 +132,7 @@ MACAddress and SerialNumber are the only allowed values. ```yaml Type: IdentifierType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -139,87 +141,102 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Name for the new test device (names must be unique within a given scope). -The Name parameter should be used only when using the Parent parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity for the new test device. +An Identity consists of both the scope where the test device is to be assigned (for example, site:Redmond) and the name for the new device (for example, UCPhone). +To assign a test device named UCPhone to the Redmond site, your Identity parameter must look like this: + +`-Identity "site:Redmond/UCPhone"` + ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -Name of the scope (for example, site:Redmond) where the new test device is to be assigned. -If you use the Parent parameter then you must also use the Name parameter; for example: +### -InMemory -`-Parent site:Redmond -Name UCPhone` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If you use the Parent parameter then you should not use the Identity parameter and vice-versa. +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 -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +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 occur when running the command. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name for the new test device (names must be unique within a given scope). +The Name parameter should be used only when using the Parent parameter. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True 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-\. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the scope (for example, site:Redmond) where the new test device is to be assigned. +If you use the Parent parameter then you must also use the Name parameter; for example: + +`-Parent site:Redmond -Name UCPhone` + +If you use the Parent parameter then you should not use the Identity parameter and vice-versa. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -228,14 +245,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -249,13 +268,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsTestDevice` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystem.md similarity index 88% rename from skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md rename to skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystem.md index b99a3a2d81..1d7ee7ac6a 100644 --- a/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystem.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsThirdPartyVideoSystem -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csthirdpartyvideosystem +schema: 2.0.0 +title: New-CsThirdPartyVideoSystem --- # New-CsThirdPartyVideoSystem @@ -38,7 +39,7 @@ VTC contact objects can be created by using the `New-CsThirdPartyVideoSystem` cm ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsThirdPartyVideoSystem -RegistrarPool "redmond-cs-001.litwareinc.com" -OU "ou=Telecommunications,dc=litwareinc,dc=com" -DisplayName "Redmond Video System" -SipAddress "sip:redmondvideo@litwareinc.com" ``` @@ -47,7 +48,7 @@ In Example 1, a new third-party video system contact object is created in the Te This new contact object will be homed on the Registrar pool Redmond-cs-001.litwareinc.com; will have the display name Redmond Video System and will use the SIP address sip:redmondvideo@litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsThirdPartyVideoSystem -RegistrarPool "redmond-cs-001.litwareinc.com" -DN "cn=RedmondVideoSystem,ou=Telecommunications,dc=litwareinc,dc=com" -SipAddress "sip:redmondvideo@litwareinc.com" ``` @@ -58,43 +59,41 @@ To carry out that task you need to include three parameters: RegistrarPool, whic ## PARAMETERS -### -DN -Enables you to associate an existing Active Directory contact object with a third-party video system. -If you have a contact object you want to associate with video system, use the DN parameter followed by the distinguished name of that contact. -For example: +### -DisplayName -`-DN "cn=Building 14 Lobby,dc=litwareinc,dc=com"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Note that the command will fail if the specified contact does not exist. -Note, too that you cannot use the OU and the DN parameters in the same command. +Configures the Active Directory display name of the video system. ```yaml -Type: ADObjectId -Parameter Sets: DN -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OU -Distinguished name of the Active Directory organizational unit (OU) where the contact object should be located. +### -DN + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to associate an existing Active Directory contact object with a third-party video system. +If you have a contact object you want to associate with video system, use the DN parameter followed by the distinguished name of that contact. For example: -`-OU "ou=Redmond,dc=litwareinc,dc=com"` +`-DN "cn=Building 14 Lobby,dc=litwareinc,dc=com"` -If you include the OU parameter, a new contact will be created in the specified OU and the contact will automatically be assigned a GUID (globally unique identifier) as its common name. -As a result, the contact object will have a name similar to this: {ce84964a-c4da-4622-ad34-c54ff3ed361f}. +Note that the command will fail if the specified contact does not exist. +Note, too that you cannot use the OU and the DN parameters in the same command. ```yaml -Type: OUIdParameter -Parameter Sets: OU -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: ADObjectId +Parameter Sets: DN +Aliases: Required: True Position: Named @@ -103,37 +102,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPool -Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. +### -LineUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the VTC device. +The line URI should be specified by using the E.164 format and be prefixed by the "TEL:" prefix. For example: -`-RegistrarPool "atl-cs-001.litwareinc.com"` +`-LineURI "TEL:+14255551297"` + +Any extension number should be added to the end of the line URI; for example: + +`-LineURI "TEL:+14255551297;ext=51297"` ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -Unique identifier that allows the video system to communicate with SIP devices such as Skype for Business. -The SIP address must be prefaced by the prefix "sip:". +### -OU + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Distinguished name of the Active Directory organizational unit (OU) where the contact object should be located. For example: -`sip:contoso_video@litwareinc.com` +`-OU "ou=Redmond,dc=litwareinc,dc=com"` + +If you include the OU parameter, a new contact will be created in the specified OU and the contact will automatically be assigned a GUID (globally unique identifier) as its common name. +As a result, the contact object will have a name similar to this: {ce84964a-c4da-4622-ad34-c54ff3ed361f}. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: OUIdParameter +Parameter Sets: OU +Aliases: Required: True Position: Named @@ -142,14 +152,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a contact object through the pipeline that represents the third-party video system being modified. +By default, the `New-CsThirdPartyVideoSystem` cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,55 +171,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Configures the Active Directory display name of the video system. +### -RegistrarPool + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. +For example: + +`-RegistrarPool "atl-cs-001.litwareinc.com"` ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LineUri -Phone number for the VTC device. -The line URI should be specified by using the E.164 format and be prefixed by the "TEL:" prefix. -For example: +### -SipAddress -`-LineURI "TEL:+14255551297"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Any extension number should be added to the end of the line URI; for example: +Unique identifier that allows the video system to communicate with SIP devices such as Skype for Business. +The SIP address must be prefaced by the prefix "sip:". +For example: -`-LineURI "TEL:+14255551297;ext=51297"` +`sip:contoso_video@litwareinc.com` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a contact object through the pipeline that represents the third-party video system being modified. -By default, the `New-CsThirdPartyVideoSystem` cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -216,13 +233,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -236,13 +255,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsThirdPartyVideoSystem` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact The `New-CsThirdPartyVideoSystem` cmdlet creates new instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystemPolicy.md similarity index 87% rename from skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystemPolicy.md index 4043433c11..bd4445810b 100644 --- a/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystemPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsThirdPartyVideoSystemPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csthirdpartyvideosystempolicy +schema: 2.0.0 +title: New-CsThirdPartyVideoSystemPolicy --- # New-CsThirdPartyVideoSystemPolicy @@ -36,7 +37,7 @@ The `New-CsThirdPartyVideoSystem` cmdlet provides a way for administrators to cr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsThirdPartyVideoSystemPolicy -Identity "site:Redmond" -SupportsSendingLowResolution $False ``` @@ -47,33 +48,16 @@ With this policy, VTCs will not be allowed to send low resolution video; that's ## PARAMETERS -### -Identity -Indicates the unique Identity to be assigned to the policy. -Third party video system policies can be created at the site or per-user scope. -To create a policy at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. -To create a policy at the per-user scope, use syntax similar to this: `-Identity "RedmondVideoSystemPolicy"`. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -82,31 +66,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the unique Identity to be assigned to the policy. +Third party video system policies can be created at the site or per-user scope. +To create a policy at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. +To create a policy at the per-user scope, use syntax similar to this: `-Identity "RedmondVideoSystemPolicy"`. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,14 +107,16 @@ Accept wildcard characters: False ``` ### -SupportsSendingLowResolution + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not low-resolution video can be sent by a VTC device. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +126,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for the third-party video system policy being created. For example: @@ -145,8 +141,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -156,13 +169,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -176,13 +191,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsThirdPartyVideoSystemPolicy` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy The `New-CsThirdPartyVideoSystemPolicy` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsTrunkConfiguration.md similarity index 85% rename from skype/skype-ps/skype/New-CsTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsTrunkConfiguration.md index f7e31d7df2..4a85482b3c 100644 --- a/skype/skype-ps/skype/New-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstrunkconfiguration +schema: 2.0.0 +title: New-CsTrunkConfiguration --- # New-CsTrunkConfiguration @@ -27,7 +28,7 @@ New-CsTrunkConfiguration [-Identity] [-ConcentratedTopology ] [-RTCPCallsOnHold ] [-SipResponseCodeTranslationRulesList ] [-SRTPMode ] [-Force] [-InMemory] [-WhatIf] [-Confirm] [-Enable3pccRefer ] [-EnableFastFailoverTimer ] [-EnableOnlineVoice ] - [-EnableRTPLatching ] [-ForwardCallHistory ] [-ForwardPAI ] [-ForwardAnonymousCallGatewayPAI ] + [-EnableRTPLatching ] [-ForwardCallHistory ] [-ForwardPAI ] [-ForwardAnonymousCallGatewayPAI ] [-OutboundCallingNumberTranslationRulesList ] [-PstnUsages ] [-EnableLocationRestriction ] [-NetworkSiteID ] [] ``` @@ -40,7 +41,7 @@ These settings configure such things as whether media bypass is enabled on this ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTrunkConfiguration -Identity site:Redmond ``` @@ -49,7 +50,7 @@ This example creates a new trunk configuration with the Identity site:Redmond. The remaining properties for this new configuration will be populated with default values. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsTrunkConfiguration -Identity site:Redmond -EnableBypass $True ``` @@ -59,7 +60,7 @@ Media bypass is enabled by assigning the value $True to the EnableBypass paramet The remaining properties for this new configuration will be populated with default values. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` New-CsTrunkConfiguration -Identity site:Redmond @@ -78,25 +79,10 @@ After that we pass values to the Pattern and Translation parameters to define th ## PARAMETERS -### -Identity -A unique identifier that includes the scope of the trunk configuration. -Trunk configurations can be created at the Site scope, or at the Service scope for a PSTN Gateway service. -(A global configuration exists by default and cannot be removed or re-created.) For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ConcentratedTopology -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ConcentratedTopology The value of this parameter determines whether there is a well-known media termination point. (An example of a well-known media termination point would be a PSTN gateway where the media termination has the same IP as the signaling termination.) Set this value to False if the trunk does not have a well-known media termination point. @@ -105,8 +91,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +101,36 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string describing the purpose of the trunk configuration. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable3pccRefer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the 3pcc protocol can be used to allow transferred calls to bypass the hosted site. +3pcc is also known as "third party control," and occurs when a third-party is used to connect a pair of callers (for example, an operator placing a call from person A to person B). +The REFER method is a standard SIP method which indicates that the recipient should contact a third-party by using information supplied by the sender. +The default value is False ($False). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -132,6 +140,9 @@ Accept wildcard characters: False ``` ### -EnableBypass + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value of this parameter determines whether media bypass is enabled for this trunk. Set this value to True to enable bypass. Note that in order for the media bypass to work successfully, certain capabilities must be supported by PSTN gateways, SBCs and PBXs, including: @@ -156,8 +167,7 @@ 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 +Aliases: Required: False Position: Named @@ -166,16 +176,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMobileTrunkSupport -Defines whether the service provider is a mobile carrier. +### -EnableFastFailoverTimer -Default: False +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, outbound calls that are not answered by the gateway within 10 seconds will be routed to the next available trunk; if there are no additional trunks then the call will automatically be dropped. +In an organization with slow networks and gateway responses, that could potentially result in calls being dropped unnecessarily. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,18 +197,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePIDFLOSupport -Defines whether to route emergency calls with Presence Information Data Format Location Object (PIDF-LO) through the defined gateway. -Set this parameter to True if emergency calls are to be routed to a certified emergency services provider. -(The location will be transmitted with the call.) +### -EnableLocationRestriction -Default: False +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, location-based voice routing will be enabled for calls passing through the SIP trunks managed by the specified collection of SIP trunk configuration settings. +With location-based voice routing, the locations of both the user making the call and the user receiving the call are taken into account when calls are routed. +If this property is set to True (the default value is False) then you should also set the NetworkSiteId property. + +This parameter was introduced in the February, 2013 version of Lync Server 2013. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,23 +219,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReferSupport -Defines whether this trunk supports receiving Refer requests from the Mediation Server. - -Media bypass can be enabled only under the following circumstances: +### -EnableMobileTrunkSupport -- The ConcentratedTopology parameter is set to True -- The EnableReferSupport parameter is set to False and RTCPActiveCalls and RTCPCallsOnHold are set to False, or EnableReferSupport is set to True +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that if EnableBypass is True and EnableReferSupport is False, bypass calls that are subsequently transferred will become non-bypass. +Defines whether the service provider is a mobile carrier. -Default: True +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 +Aliases: Required: False Position: Named @@ -229,20 +239,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSessionTimer -Specifies whether the session timer is enabled. -Session timers are used to determine whether a particular session is still active. +### -EnableOnlineVoice -Note that even if this parameter is set to False, session timers can be applicable if the remote connection has session timer enabled. -In such a case, the Mediation Server will reply to session timer probes from the remote entity. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: False +Indicates whether the SIP trunks support online voice. +With online voice, users have an on-premises Lync Server account but have their voicemail hosted by Office 365. +The default value is False ($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 +Aliases: Required: False Position: Named @@ -251,18 +259,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSignalBoost -When this parameter is set to True the PSTN gateway, IP-PBX, or SBC at the service provider will boost the audio volume in voice streams that are sent to the Mediation Server or Skype for Business Server clients. -If this value is set to False, audio will be boosted either at the Mediation Server (for non-bypass calls) or in Skype for Business Server clients (for bypass calls). +### -EnablePIDFLOSupport -Default: False +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Defines whether to route emergency calls with Presence Information Data Format Location Object (PIDF-LO) through the defined gateway. +Set this parameter to True if emergency calls are to be routed to a certified emergency services provider. +(The location will be transmitted with the call.) + +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 +Aliases: Required: False Position: Named @@ -271,16 +281,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEarlyDialogs -The maximum number of forked responses a PSTN gateway, IP-PBX, or SBC at the service provider can receive to an Invite that it sent to the Mediation Server. +### -EnableReferSupport -Default: 20 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Defines whether this trunk supports receiving Refer requests from the Mediation Server. + +Media bypass can be enabled only under the following circumstances: + +- The ConcentratedTopology parameter is set to True +- The EnableReferSupport parameter is set to False and RTCPActiveCalls and RTCPCallsOnHold are set to False, or EnableReferSupport is set to True + +Note that if EnableBypass is True and EnableReferSupport is False, bypass calls that are subsequently transferred will become non-bypass. + +Default: True ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -289,16 +308,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundTranslationRulesList -A collection of phone number translation rules that apply to calls handled by Outbound Routing (calls routed to PBX or PSTN destinations). +### -EnableRTPLatching -While this list and these rules can be created directly with this cmdlet, it is recommended that you create the outbound translation rules with the `New-CsOutboundTranslationRule` cmdlet, which will create the rule and assign it to the trunk configuration with the matching scope. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the SIP trunks support RTP latching. +RTP latching is a technology that enables RTP/RTCP connectivity through a NAT (network address translator) device or firewall. +The default value is False ($False). ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -307,16 +328,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemovePlusFromUri -Setting this parameter to True will cause the Mediation Server to remove leading plus signs (+) from Uniform Resource Identifiers (URIs) before sending them on to the service provider. +### -EnableSessionTimer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether the session timer is enabled. +Session timers are used to determine whether a particular session is still active. + +Note that even if this parameter is set to False, session timers can be applicable if the remote connection has session timer enabled. +In such a case, the Mediation Server will reply to session timer probes from the remote entity. 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 +Aliases: Required: False Position: Named @@ -325,21 +352,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RTCPActiveCalls -This parameter determines whether RTCP packets are sent from the PSTN gateway, IP-PBX, or SBC at the service provider for active calls. -An active call in this context is a call where media is allowed to flow in at least one direction. -If RTCPActiveCalls is set to True, the Mediation Server or Skype for Business Server client can terminate a call if it does not receive RTCP packets for a period exceeding 30 seconds. +### -EnableSignalBoost -Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: True +When this parameter is set to True the PSTN gateway, IP-PBX, or SBC at the service provider will boost the audio volume in voice streams that are sent to the Mediation Server or Skype for Business Server clients. +If this value is set to False, audio will be boosted either at the Mediation Server (for non-bypass calls) or in Skype for Business Server clients (for bypass calls). + +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 +Aliases: Required: False Position: Named @@ -348,21 +374,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RTCPCallsOnHold -This parameter determines whether RTCP packets continue to be sent across the trunk for calls that have been placed on hold and no media packets are expected to flow in either direction. -If Music on Hold is enabled at either the Skype for Business Server client or the trunk, the call will be considered to be active and this property will be ignored. -In these circumstances use the RTCPActiveCalls parameter. - -Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. +### -Force -Default: True +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -371,20 +392,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipResponseCodeTranslationRulesList -A list of SIP response code translation rules that apply to response codes received from a PSTN gateway, IP-PBX, or SBC at the service provider. -These rules allow the administrator to map SIP response codes with values between 400 and 699 received over a trunk to new values more consistent with Skype for Business Server. +### -ForwardAnonymousCallGatewayPAI -You can create this list and corresponding rules directly with this cmdlet. -However, it is recommended that you create the SIP response code translation rules by calling the `New-CsSipResponseCodeTranslationRule` cmdlet. -That cmdlet will create the rule and assign it to the trunk configuration with the matching scope. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +If an anonymous call is forwarded to an outgoing PSTN call, this parameter indicates whether the incoming P-Asserted-Identity (PAI) header at the Gateway call will be preserved in the PSTN call. The default value is **False** ($False). +**Notes:** +- `EnablePAIPAssthrough` is deprecated in favor of `ForwardAnonymousCallGatewayPAI`. This change is made by installing KB5016483. +- When `ForwardAnonymousCallGatewayPAI` is used, `ForwardPAI` must be set to **True**. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -393,28 +414,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SRTPMode -The value of this parameter determines the level of support for SRTP to protect media traffic between the Mediation Server and the PSTN Gateway, IP-PBX, or SBC at the service provider. -For media bypass cases, this value must be compatible with the EncryptionLevel setting in the media configuration. -Media configuration is set by using the `New-CsMediaConfiguration` cmdlet and the `Set-CsMediaConfiguration` cmdlet. - -Valid values: - -- Required: SRTP encryption must be used. -- Optional: SRTP will be used if the gateway supports it. -- NotSupported: SRTP encryption is not supported and therefore will not be used. - -Note: SRTPMode is used only if the gateway is configured to use Transport Layer Security (TLS). -If the gateway is configured with Transmission Control Protocol (TCP) as the transport, SRTPMode is internally set to NotSupported. +### -ForwardCallHistory -Default: Required +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether call history information will be forwarded through the trunk. +The default value is False ($False). ```yaml -Type: SRTPMode +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -423,14 +433,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -ForwardPAI + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. +The PAI header provides a way to verify the identity of the caller. +The default value is False ($False). ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -439,32 +453,38 @@ 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-\. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier that includes the scope of the trunk configuration. +Trunk configurations can be created at the Site scope, or at the Service scope for a PSTN Gateway service. +(A global configuration exists by default and cannot be removed or re-created.) For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 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. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -473,14 +493,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxEarlyDialogs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum number of forked responses a PSTN gateway, IP-PBX, or SBC at the service provider can receive to an Invite that it sent to the Mediation Server. + +Default: 20 ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -489,17 +513,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enable3pccRefer -Indicates whether the 3pcc protocol can be used to allow transferred calls to bypass the hosted site. -3pcc is also known as "third party control," and occurs when a third-party is used to connect a pair of callers (for example, an operator placing a call from person A to person B). -The REFER method is a standard SIP method which indicates that the recipient should contact a third-party by using information supplied by the sender. -The default value is False ($False). +### -NetworkSiteID + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Site ID of the network site associated with the new collection of trunk configuration settings. +If the EnableLocationRestriction property is set to True then location-based voice routing through this trunk will be managed by using the settings configured for the specified site. +Network site IDs can be retrieved by using this command: + +`Get-CsNetworkSite | Select NetworkSiteID` + +This parameter was introduced in the February, 2013 release of Lync Server 2013. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -508,17 +537,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFastFailoverTimer -When set to True, outbound calls that are not answered by the gateway within 10 seconds will be routed to the next available trunk; if there are no additional trunks then the call will automatically be dropped. -In an organization with slow networks and gateway responses, that could potentially result in calls being dropped unnecessarily. +### -OutboundCallingNumberTranslationRulesList -The default value is True. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of outbound calling number translation rules assigned to the trunk. +You can retrieve information about the available rules by running this command: + +`Get-CsOutboundCallingNumberTranslationRule` ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -527,16 +558,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineVoice -Indicates whether the SIP trunks support online voice. -With online voice, users have an on-premises Lync Server account but have their voicemail hosted by Office 365. -The default value is False ($False). +### -OutboundTranslationRulesList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A collection of phone number translation rules that apply to calls handled by Outbound Routing (calls routed to PBX or PSTN destinations). + +While this list and these rules can be created directly with this cmdlet, it is recommended that you create the outbound translation rules with the `New-CsOutboundTranslationRule` cmdlet, which will create the rule and assign it to the trunk configuration with the matching scope. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -545,16 +578,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRTPLatching -Indicates whether or not the SIP trunks support RTP latching. -RTP latching is a technology that enables RTP/RTCP connectivity through a NAT (network address translator) device or firewall. -The default value is False ($False). +### -PstnUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of PSTN usages assigned to the trunk. +You can retrieve information about the available usages by running this command: + +`Get-CsPstnUsage` ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -563,15 +599,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardCallHistory -Indicates whether call history information will be forwarded through the trunk. -The default value is False ($False). +### -RemovePlusFromUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Setting this parameter to True will cause the Mediation Server to remove leading plus signs (+) from Uniform Resource Identifiers (URIs) before sending them on to the service provider. + +Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -580,16 +619,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardPAI -Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. -The PAI header provides a way to verify the identity of the caller. -The default value is False ($False). +### -RTCPActiveCalls + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter determines whether RTCP packets are sent from the PSTN gateway, IP-PBX, or SBC at the service provider for active calls. +An active call in this context is a call where media is allowed to flow in at least one direction. +If RTCPActiveCalls is set to True, the Mediation Server or Skype for Business Server client can terminate a call if it does not receive RTCP packets for a period exceeding 30 seconds. + +Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. + +Default: True + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -598,18 +644,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardAnonymousCallGatewayPAI -If an anonymous call is forwarded to an outgoing PSTN call, this parameter indicates whether the incoming P-Asserted-Identity (PAI) header at the Gateway call will be preserved in the PSTN call. The default value is **False** ($False). +### -RTCPCallsOnHold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter determines whether RTCP packets continue to be sent across the trunk for calls that have been placed on hold and no media packets are expected to flow in either direction. +If Music on Hold is enabled at either the Skype for Business Server client or the trunk, the call will be considered to be active and this property will be ignored. +In these circumstances use the RTCPActiveCalls parameter. + +Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. + +Default: True -**Notes:** -- `EnablePAIPAssthrough` is deprecated in favor of `ForwardAnonymousCallGatewayPAI`. This change is made by installing KB5016483. -- When `ForwardAnonymousCallGatewayPAI` is used, `ForwardPAI` must be set to **True**. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -618,17 +669,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundCallingNumberTranslationRulesList -Collection of outbound calling number translation rules assigned to the trunk. -You can retrieve information about the available rules by running this command: +### -SipResponseCodeTranslationRulesList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A list of SIP response code translation rules that apply to response codes received from a PSTN gateway, IP-PBX, or SBC at the service provider. +These rules allow the administrator to map SIP response codes with values between 400 and 699 received over a trunk to new values more consistent with Skype for Business Server. + +You can create this list and corresponding rules directly with this cmdlet. +However, it is recommended that you create the SIP response code translation rules by calling the `New-CsSipResponseCodeTranslationRule` cmdlet. +That cmdlet will create the rule and assign it to the trunk configuration with the matching scope. -`Get-CsOutboundCallingNumberTranslationRule` ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -637,17 +693,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsages -Collection of PSTN usages assigned to the trunk. -You can retrieve information about the available usages by running this command: +### -SRTPMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The value of this parameter determines the level of support for SRTP to protect media traffic between the Mediation Server and the PSTN Gateway, IP-PBX, or SBC at the service provider. +For media bypass cases, this value must be compatible with the EncryptionLevel setting in the media configuration. +Media configuration is set by using the `New-CsMediaConfiguration` cmdlet and the `Set-CsMediaConfiguration` cmdlet. + +Valid values: + +- Required: SRTP encryption must be used. +- Optional: SRTP will be used if the gateway supports it. +- NotSupported: SRTP encryption is not supported and therefore will not be used. + +Note: SRTPMode is used only if the gateway is configured to use Transport Layer Security (TLS). +If the gateway is configured with Transmission Control Protocol (TCP) as the transport, SRTPMode is internally set to NotSupported. + +Default: Required -`Get-CsPstnUsage` ```yaml -Type: PSListModifier +Type: SRTPMode Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -656,18 +725,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationRestriction -When set to True, location-based voice routing will be enabled for calls passing through the SIP trunks managed by the specified collection of SIP trunk configuration settings. -With location-based voice routing, the locations of both the user making the call and the user receiving the call are taken into account when calls are routed. -If this property is set to True (the default value is False) then you should also set the NetworkSiteId property. +### -Confirm -This parameter was introduced in the February, 2013 version of Lync Server 2013. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -676,20 +743,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID -Site ID of the network site associated with the new collection of trunk configuration settings. -If the EnableLocationRestriction property is set to True then location-based voice routing through this trunk will be managed by using the settings configured for the specified site. -Network site IDs can be retrieved by using this command: +### -WhatIf -`Get-CsNetworkSite | Select NetworkSiteID` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter was introduced in the February, 2013 release of Lync Server 2013. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -703,12 +766,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplication.md similarity index 87% rename from skype/skype-ps/skype/New-CsTrustedApplication.md rename to skype/skype-ps/SkypeForBusiness/New-CsTrustedApplication.md index a46ee864c0..b290679449 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTrustedApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstrustedapplication +schema: 2.0.0 +title: New-CsTrustedApplication --- # New-CsTrustedApplication @@ -53,7 +54,7 @@ You must open the port in the Windows firewall and any corporate firewalls in or ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTrustedApplication -ApplicationId tapp1 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com -Port 6000 ``` @@ -64,7 +65,7 @@ We also must specify a port for the application; in this example we used port 60 Note that running this cmdlet by specifying an ApplicationId and a TrustedApplicationPoolFqdn will automatically generate an Identity that can later be used to retrieve, modify, or remove this application. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 -Port 6100 ``` @@ -76,27 +77,10 @@ This value must be in the format \/\. ## PARAMETERS -### -Identity -A unique identifier for the trusted application on the pool. -Identity values must be entered in the format \/\, where pool FQDN is the fully qualified domain name (FQDN) of the pool on which the application resides and application ID is the name of the application. -The application ID must be unique for a given pool. - -If you enter an Identity, you cannot specify values for the ApplicationId or TrustedApplicationPoolFqdn parameters. - -```yaml -Type: ExternalApplicationIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ApplicationId -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ApplicationId The name of the application. This must be a string that is unique within the pool that is specified in the TrustedApplicationPoolFqdn parameter. The string cannot contain spaces. @@ -107,8 +91,7 @@ You cannot specify an ApplicationId and an Identity. ```yaml Type: String Parameter Sets: AppIdAndPoolFqdn -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -117,61 +100,71 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Port -The port number on which the application will run. -The port must be unique within a given pool. -In other words, no other applications that use this same port can be defined on the specified pool. +### -EnableTcp + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies that the trusted application will use Transmission Control Protocol (TCP). +Use this parameter only if the trusted application is not a Microsoft Unified Communications Managed API (UCMA) application. +This is because UCMA applications support only the mutual Transport Layer Security (MTLS) protocol. +If you do not specify the Force parameter with the EnableTcp parameter, you'll receive a confirmation prompt before the new trusted application will be created. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TrustedApplicationPoolFqdn -The FQDN of the trusted application pool on which the application will reside. -If you supply a value for TrustedApplicationPoolFqdn you must also supply a value for ApplicationId, but you cannot supply a value for the Identity parameter. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String -Parameter Sets: AppIdAndPoolFqdn -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTcp -Specifies that the trusted application will use Transmission Control Protocol (TCP). -Use this parameter only if the trusted application is not a Microsoft Unified Communications Managed API (UCMA) application. -This is because UCMA applications support only the mutual Transport Layer Security (MTLS) protocol. -If you do not specify the Force parameter with the EnableTcp parameter, you'll receive a confirmation prompt before the new trusted application will be created. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the trusted application on the pool. +Identity values must be entered in the format \/\, where pool FQDN is the fully qualified domain name (FQDN) of the pool on which the application resides and application ID is the name of the application. +The application ID must be unique for a given pool. + +If you enter an Identity, you cannot specify values for the ApplicationId or TrustedApplicationPoolFqdn parameters. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: ExternalApplicationIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LegacyApplicationName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Use this parameter only if the application is being migrated from a Microsoft Office Communications Server 2007 R2 deployment. This value must be the same as the GRUU type of the Office Communications Server 2007 R2 version of the application in order for the two to work together. @@ -183,8 +176,7 @@ If you don't specify a value for this parameter, the value of the Application ID ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,32 +185,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Port + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The port number on which the application will run. +The port must be unique within a given pool. +In other words, no other applications that use this same port can be defined on the specified pool. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -TrustedApplicationPoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The FQDN of the trusted application pool on which the application will reside. +If you supply a value for TrustedApplicationPoolFqdn you must also supply a value for ApplicationId, but you cannot supply a value for the Identity parameter. ```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 +Type: String +Parameter Sets: AppIdAndPoolFqdn +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -226,13 +225,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -246,12 +265,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayTrustedApplication Creates an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplication. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationComputer.md similarity index 85% rename from skype/skype-ps/skype/New-CsTrustedApplicationComputer.md rename to skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationComputer.md index 1f2dd613a9..9b39db4d3f 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationcomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTrustedApplicationComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstrustedapplicationcomputer +schema: 2.0.0 +title: New-CsTrustedApplicationComputer --- # New-CsTrustedApplicationComputer @@ -38,7 +39,7 @@ In addition, if you did not specify a computer FQDN for the default computer whe ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTrustedApplicationComputer -Identity Trust1.litwareinc.com -Pool TrustPool.litwareinc.com ``` @@ -51,14 +52,34 @@ The pool must exist and must be a trusted application pool. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The FQDN of the computer that hosts the trusted application. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -68,14 +89,16 @@ Accept wildcard characters: False ``` ### -Pool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The FQDN of the pool hosting the trusted application computer. You can find available pools by running the `Get-CsTrustedApplicationPool` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -84,14 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -101,29 +126,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -137,12 +148,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayComputer Creates an object of type Microsoft.Rtc.Management.Xds.DisplayComputer. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationEndpoint.md similarity index 82% rename from skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationEndpoint.md index 9013c9e9a4..1d988dd154 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTrustedApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstrustedapplicationendpoint +schema: 2.0.0 +title: New-CsTrustedApplicationEndpoint --- # New-CsTrustedApplicationEndpoint @@ -34,7 +35,7 @@ This cmdlet creates a new endpoint contact object in Active Directory Domain Ser ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTrustedApplicationEndpoint -ApplicationId tapp1 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com ``` @@ -46,7 +47,7 @@ In order to ensure the SIP address is unique, the auto-generated address will in If you'd like a more readable SIP address, see Example 2. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsTrustedApplicationEndpoint -ApplicationId tapp1 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com -SipAddress sip:endpoint1@litwareinc.com ``` @@ -59,6 +60,9 @@ Rather than allowing the system to generate a SIP address, we've specified an ad ## PARAMETERS ### -ApplicationId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The application ID of the trusted application for which the endpoint contact is being created. An application with this ID must already exist. Note that you may include only the name part of the application ID, you don't need to (but you can) include the prefix information. @@ -67,8 +71,7 @@ For example, if the application ID is urn:application:TrustedApp1 you only need ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -77,33 +80,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TrustedApplicationPoolFqdn -The fully qualified domain name (FQDN) of the trusted application pool associated with the application. -The application must already be associated with this pool for the endpoint to be created. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DisplayName -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -SipAddress -A SIP address for the new contact object. -If you do not include a value for this parameter a SIP address will be auto-generated in the format sip:RtcApplication-\.\, for example sip:RtcApplication-fbf9e2d1-c6aa-45a3-a045-b92d4ef961b2@litwareinc.com. -The domain will be the default SIP domain. +The display name of the endpoint contact object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,14 +98,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -The display name of the endpoint contact object. +### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The telephone number of the contact as it will appear in the Address Book. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,14 +116,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber -The telephone number of the contact as it will appear in the Address Book. +### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The phone number of the contact. +Must be in the format TEL:\, for example TEL:+14255551212. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,15 +135,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -The phone number of the contact. -Must be in the format TEL:\, for example TEL:+14255551212. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns the results of this command. +Running this cmdlet will display the newly created object; including this parameter will simply repeat that output, making the use of this parameter redundant. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +155,9 @@ Accept wildcard characters: False ``` ### -PrimaryLanguage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The primary language used for the trusted application. The language must be configured using a valid language code, such as en-US (U.S. English), fr-FR (French), etc. @@ -169,8 +165,7 @@ English), fr-FR (French), etc. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +175,9 @@ Accept wildcard characters: False ``` ### -SecondaryLanguages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of languages that can also be used for trusted applications. Values must be configured as a comma-separated values list of language codes. For example, the following syntax sets French Canadian and French as secondary languages: `-SecondaryLanguages "fr-CA","fr-FR"`. @@ -187,8 +185,27 @@ For example, the following syntax sets French Canadian and French as secondary l ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A SIP address for the new contact object. +If you do not include a value for this parameter a SIP address will be auto-generated in the format sip:RtcApplication-\.\, for example sip:RtcApplication-fbf9e2d1-c6aa-45a3-a045-b92d4ef961b2@litwareinc.com. +The domain will be the default SIP domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -198,6 +215,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new trusted application pool endpoint is being created. For example: @@ -211,8 +231,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,31 +240,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns the results of this command. -Running this cmdlet will display the newly created object; including this parameter will simply repeat that output, making the use of this parameter redundant. +### -TrustedApplicationPoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the trusted application pool associated with the application. +The application must already be associated with this pool for the endpoint to be created. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -254,14 +277,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -275,12 +300,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact Creates an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationPool.md similarity index 84% rename from skype/skype-ps/skype/New-CsTrustedApplicationPool.md rename to skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationPool.md index cd945137d5..77d1433fd8 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTrustedApplicationPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstrustedapplicationpool +schema: 2.0.0 +title: New-CsTrustedApplicationPool --- # New-CsTrustedApplicationPool @@ -43,7 +44,7 @@ To add more computers to the pool, call the `New-CsTrustedApplicationComputer` c ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -Registrar pool0.litwareinc.com -Site Redmond ``` @@ -61,7 +62,7 @@ However, if you want to later find all trusted application pools for the NA site `Get-CsTrustedApplicationPool | Where-Object {$_.SiteId -eq "site:Redmond1"}` -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -Registrar Registrar:redmond.litwareinc.com -Site Redmond -ComputerFqdn AppServer.litwareinc.com ``` @@ -75,25 +76,10 @@ We've specified a different FQDN, AppServer.litwareinc.com, for the computer tha ## PARAMETERS -### -Identity -The FQDN of the new pool. -Note that while the Identity value for creating a pool is the pool FQDN, the value that will be stored as the Identity with the new pool is actually an automatically generated service ID of the pool. -The Identity entered here will be saved as the PoolFqdn. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AppSharingPortCount -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AppSharingPortCount The number of ports available in the port range for application sharing connections. Default: 0 @@ -101,8 +87,7 @@ Default: 0 ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,13 +97,15 @@ Accept wildcard characters: False ``` ### -AppSharingPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for application sharing connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +115,9 @@ Accept wildcard characters: False ``` ### -AudioPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of ports available in the port range for audio connections. Default: 0 @@ -135,8 +125,7 @@ Default: 0 ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,13 +135,15 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for audio connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +153,9 @@ Accept wildcard characters: False ``` ### -ComputerFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creating a trusted application pool will automatically create a trusted application computer that is part of that pool. By default the computer will receive the same FQDN as the pool. Enter a value in this parameter to specify an FQDN for the computer that is different from the pool FQDN. @@ -170,8 +164,25 @@ If you plan to add more computers to the pool, you must enter a value for this p ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -180,7 +191,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The FQDN of the new pool. +Note that while the Identity value for creating a pool is the pool FQDN, the value that will be stored as the Identity with the new pool is actually an automatically generated service ID of the pool. +The Identity entered here will be saved as the PoolFqdn. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OutboundOnly + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether a trusted application can initiate a connection to a server within the pool. Set this value to True if you want all connections to be initiated by the server rather than the application. @@ -189,8 +223,7 @@ 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 +Aliases: Required: False Position: Named @@ -200,6 +233,9 @@ Accept wildcard characters: False ``` ### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The service ID or FQDN of the Registrar service for the pool. Note that even though this parameter is optional, if you attempt to create a new trusted application endpoint (by using the `New-CsTrustedApplicationEndpoint` cmdlet) and assign the endpoint to a pool that does not have a Registrar dependency, you'll receive an error and the endpoint will not be created. @@ -208,8 +244,7 @@ In addition, you cannot remove a trusted application pool that is not associated ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +254,9 @@ Accept wildcard characters: False ``` ### -RequiresReplication + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether replication is required for this pool. Set this value to False if replication is not required. You would usually set this parameter to False for Microsoft Outlook Web Access and manually-provisioned applications. @@ -229,8 +267,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,6 +277,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Site ID of the site on which this pool is homed. Call the `Get-CsSite` cmdlet to retrieve the SiteId property of a site. Keep in mind that you must use the SiteId property rather than the Identity of the site. @@ -254,8 +294,7 @@ If the pool doesn't exist, this parameter is required. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -265,6 +304,9 @@ Accept wildcard characters: False ``` ### -ThrottleAsServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Set this parameter to false to throttle connections between the servers within the pool and trusted applications as clients. This places greater restrictions on the connections than the default True, which throttles connections as servers. Throttling a connection places restrictions on the number of transactions that can occur at once. @@ -274,8 +316,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -285,6 +326,9 @@ Accept wildcard characters: False ``` ### -TreatAsAuthenticated + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether authentication is required for trusted applications connecting to servers within the pool. Set this parameter to False if you want to require trusted applications to be authenticated. The default value of True allows the trusted applications to connect under the assumption they've already been authenticated. @@ -294,8 +338,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -305,6 +348,9 @@ Accept wildcard characters: False ``` ### -VideoPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of ports available in the port range for video connections. Default: 0 @@ -312,8 +358,7 @@ Default: 0 ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -323,13 +368,15 @@ Accept wildcard characters: False ``` ### -VideoPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for video connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -338,14 +385,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -355,29 +404,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -391,12 +426,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayExternalServer Creates an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. ## NOTES diff --git a/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsUCPhoneConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsUCPhoneConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsUCPhoneConfiguration.md index 30a0ec713e..dd777d583b 100644 --- a/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUCPhoneConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csucphoneconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsUCPhoneConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csucphoneconfiguration +schema: 2.0.0 +title: New-CsUCPhoneConfiguration --- # New-CsUCPhoneConfiguration @@ -51,7 +52,7 @@ The only thing you can do at the global scope is use the `Set-CsUCPhoneConfigura ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsUCPhoneConfiguration -Identity site:Redmond -CalendarPollInterval "00:10:00" -LoggingLevel "Medium" ``` @@ -62,7 +63,7 @@ As soon as this command completes, the new settings will be applied to the Redmo Note that this command will fail if the Redmond site already has a collection of UC phone settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = New-CsUCPhoneConfiguration -Identity site:Redmond -InMemory @@ -83,24 +84,10 @@ If you do not call this cmdlet, your virtual settings will disappear when you en ## PARAMETERS -### -Identity -Represents the unique identifier to be assigned to the new collection of UC phone configuration settings. -Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". +### -CalendarPollInterval -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CalendarPollInterval Indicates how often the UC device retrieves information from your Outlook calendar. The value must be specified using the format hours:minutes:seconds; for example, to set the time interval to 1 hour (the maximum allowed interval) use this syntax: @@ -112,8 +99,7 @@ The default value is 3 minutes (00:03:00). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,14 +109,73 @@ Accept wildcard characters: False ``` ### -EnforcePhoneLock + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether or not UC phones are automatically locked after the number of minutes specified by PhoneLockTimeout. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the unique identifier to be assigned to the new collection of UC phone configuration settings. +Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -140,6 +185,9 @@ Accept wildcard characters: False ``` ### -LoggingLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables logging on the UC device. Valid values are Off; Low; Medium; and High. The default value is Off. @@ -147,8 +195,7 @@ The default value is Off. ```yaml Type: LoggingLevel Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +205,9 @@ Accept wildcard characters: False ``` ### -MinPhonePinLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the minimum number of digits required for personal identification numbers (PINs). Minimum value: 4 @@ -169,8 +219,7 @@ Default: 6 ```yaml Type: Byte Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +229,9 @@ Accept wildcard characters: False ``` ### -PhoneLockTimeout + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the length of time, in minutes, that a UC phone will remain idle before automatically locking. This value must be less than 01:00:00 (1 hour). @@ -188,8 +240,7 @@ The default value is 00:10:00 (10 minutes). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,6 +250,9 @@ Accept wildcard characters: False ``` ### -SIPSecurityMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the level of security that the server applies to SIP sessions initiated by a UC phone. Valid values are: @@ -214,8 +268,7 @@ The default value is High. ```yaml Type: SIPSecurityMode Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +278,9 @@ Accept wildcard characters: False ``` ### -Voice8021p + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the user priority value (the 802.1p value) for voice traffic within the Skype for Business Server deployment. This setting is effective only for networks in which switches and bridges are 802.1p-capable. @@ -235,8 +291,7 @@ The default value is 0. ```yaml Type: Byte Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +301,9 @@ Accept wildcard characters: False ``` ### -VoiceDiffServTag + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the decimal representation of the 6-bit DiffServ Code Point (DSCP) priority marking. This marking defines the Per Hop Behavior (PHB) for IP packets passed by the UC phones that are managed by this server. @@ -255,8 +313,7 @@ The default value is 40. ```yaml Type: Byte Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -265,32 +322,16 @@ 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 Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Confirm -### -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -300,29 +341,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -336,13 +363,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsUCPhoneConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings Creates instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/New-CsUnassignedNumber.md similarity index 86% rename from skype/skype-ps/skype/New-CsUnassignedNumber.md rename to skype/skype-ps/SkypeForBusiness/New-CsUnassignedNumber.md index 963f52646a..42e4c0e189 100644 --- a/skype/skype-ps/skype/New-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUnassignedNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsUnassignedNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csunassignednumber +schema: 2.0.0 +title: New-CsUnassignedNumber --- # New-CsUnassignedNumber @@ -47,7 +48,7 @@ To check on Exchange Auto Attendant settings, run the `Get-CsExUmContact` cmdlet ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsUnassignedNumber -Identity UNSet1 -NumberRangeStart "+14255551000" -NumberRangeEnd "+14255551100" -AnnouncementService ApplicationServer:redmond.litwareinc.com -AnnouncementName "Welcome Announcement" ``` @@ -58,7 +59,7 @@ Finally, we specify the Announcement by first supplying the AnnouncementService Keep in mind that an Announcement with that name must already exist in the system. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsUnassignedNumber -Identity UNSet2 -NumberRangeStart "+14255552100" -NumberRangeEnd "+14255552200" -ExUmAutoAttendantPhoneNumber "+12065551234" ``` @@ -71,7 +72,7 @@ Note that Exchange must be set up and this number must be an existing contact ob The contact must be an Auto Attendant contact (the AutoAttendant property for the contact must be True). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` New-CsUnassignedNumber -Identity UNSet2 -NumberRangeStart "+14255552100" -NumberRangeEnd "+14255552200" -ExUmAutoAttendantPhoneNumber "+12065551234" -Priority 2 ``` @@ -83,32 +84,16 @@ This means that if an unassigned number range has been defined that overlaps thi ## PARAMETERS -### -Identity -A unique name for the range of unassigned numbers being created. -All unassigned number ranges have a global scope, so the name specified here must be unique throughout the Skype for Business Server deployment. - +### -AnnouncementName -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnnouncementName The name of the Announcement that will be used to handle calls to this range of numbers. ```yaml Type: String Parameter Sets: AnnouncementService -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 6 @@ -118,6 +103,9 @@ Accept wildcard characters: False ``` ### -AnnouncementService + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The fully qualified domain name (FQDN) or service ID of the Announcement service. This parameter is required only if you have not specified a value for the ExUmAutoAttendantPhoneNumber parameter. @@ -125,7 +113,6 @@ This parameter is required only if you have not specified a value for the ExUmAu Type: String Parameter Sets: AnnouncementService Aliases: AnnouncementServerFqdn -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 5 @@ -135,6 +122,9 @@ Accept wildcard characters: False ``` ### -ExUmAutoAttendantPhoneNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number of the Exchange Auto Attendant to route calls in this range to. This field is required only if you are not using an Announcement Service (in which case you do not supply values for the AnnouncementService or AnnouncementName parameters). The Exchange Auto Attendant contact must already be set up in order to assign a value to this parameter. @@ -143,8 +133,7 @@ The Exchange Auto Attendant contact must already be set up in order to assign a ```yaml Type: String Parameter Sets: AutoAttendant -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 5 @@ -153,28 +142,68 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberRangeStart -The first number in the range of unassigned numbers. -Must be less than or equal to the value supplied for NumberRangeEnd. +### -Force -The number must match the regular expression (tel:)?(\+)?\[1-9\]\d{0,17}(;ext=\[1-9\]\d{0,9})?. -This means the number may begin with the string tel: (if you don't specify that string it will be automatically added for you), a plus sign (+) and a digit 1 through 9. -The phone number can be up to 17 digits and may be followed by an extension in the format ;ext= followed by the extension number. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique name for the range of unassigned numbers being created. +All unassigned number ranges have a global scope, so the name specified here must be unique throughout the Skype for Business Server deployment. + + +```yaml +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True -Position: 3 +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 ``` ### -NumberRangeEnd + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The last number in the range of unassigned numbers. Must be greater than or equal to the number supplied for NumberRangeStart. To specify a range of one number, use the same number for the NumberRangeStart and NumberRangeEnd. @@ -186,8 +215,7 @@ The phone number can be up to 17 digits and may be followed by an extension in t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 4 @@ -196,32 +224,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -It is possible for unassigned number ranges to overlap. -If a number falls within more than one range, the range with the highest priority will take effect. +### -NumberRangeStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The first number in the range of unassigned numbers. +Must be less than or equal to the value supplied for NumberRangeEnd. +The number must match the regular expression (tel:)?(\+)?\[1-9\]\d{0,17}(;ext=\[1-9\]\d{0,9})?. +This means the number may begin with the string tel: (if you don't specify that string it will be automatically added for you), a plus sign (+) and a digit 1 through 9. +The phone number can be up to 17 digits and may be followed by an extension in the format ;ext= followed by the extension number. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +It is possible for unassigned number ranges to overlap. +If a number falls within more than one range, the range with the highest priority will take effect. + ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,16 +267,16 @@ 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-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -249,29 +286,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -285,12 +308,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange Creates an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange. ## NOTES diff --git a/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsUserReplicatorConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsUserReplicatorConfiguration.md index 285f45e328..d39dfcced5 100644 --- a/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUserReplicatorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsUserReplicatorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csuserreplicatorconfiguration +schema: 2.0.0 +title: New-CsUserReplicatorConfiguration --- # New-CsUserReplicatorConfiguration @@ -49,7 +50,7 @@ You cannot create new User Replicator settings for the on-premises version of Sk ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsUserReplicatorConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" ``` @@ -58,7 +59,7 @@ The command shown in Example 1 creates a new collection of User Replicator confi Because no additional parameters are specified, the new collection will use the default user replicator values. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsUserReplicatorConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" -ADDomainNamingContextList @{Add="dc=fabrikam,dc=com","dc=contoso.com"} ``` @@ -70,30 +71,10 @@ This new collection of user replicator configuration settings will only configur ## PARAMETERS -### -Identity -Unique identifier of the User Replicator configuration settings to be created. -Settings can only be created at the service scope and only for the Registrar service. -That means that new settings must have an Identity similar to this: - -`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` - -Note that this applies only to Skype for Business Online. - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ADDomainNamingContextList -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ADDomainNamingContextList Distinguished names of the Active Directory domains that the User Replicator must synchronize with. For example, to add a domain to the list use syntax similar to this: @@ -111,8 +92,7 @@ If this property is not null then the replicator will only synchronize with the ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,20 +101,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReplicationCycleInterval -Represents the amount of time that the User Replicator waits before checking for user account updates in Active Directory. -The replication cycle interval can be any time value between 1 second and 23 hours, 59 minutes and 59 seconds; the default value is 1 minute. -The interval must be expressed using the format hours:minutes:seconds. -For example, this syntax sets to time interval to one hour and 15 minutes: +### -Force -`-ReplicationCycleInterval 01:15:00` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,23 +119,35 @@ 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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the User Replicator configuration settings to be created. +Settings can only be created at the service scope and only for the Registrar service. +That means that new settings must have an Identity similar to this: + +`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` + +Note that this applies only to Skype for Business Online. + ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -167,8 +155,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,14 +164,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ReplicationCycleInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the amount of time that the User Replicator waits before checking for user account updates in Active Directory. +The replication cycle interval can be any time value between 1 second and 23 hours, 59 minutes and 59 seconds; the default value is 1 minute. +The interval must be expressed using the format hours:minutes:seconds. +For example, this syntax sets to time interval to one hour and 15 minutes: + +`-ReplicationCycleInterval 01:15:00` + ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipFirstSyncAllowedDowntime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates how long Skype for Business Server should wait for user data to synchronize before marking the service as started. +The default value is 2 hours (02:00:00), meaning that, after 2 hours, the status of the replication service will changed from Pending to Started. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -194,13 +208,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -209,15 +225,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipFirstSyncAllowedDowntime -Indicates how long Skype for Business Server should wait for user data to synchronize before marking the service as started. -The default value is 2 hours (02:00:00), meaning that, after 2 hours, the status of the replication service will changed from Pending to Started. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -231,13 +248,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsUserReplicatorConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration The `New-CsUserReplicatorConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsUserServicesConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsUserServicesConfiguration.md index 6a6f17e252..7398a80b2b 100644 --- a/skype/skype-ps/skype/New-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsUserServicesConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csuserservicesconfiguration +schema: 2.0.0 +title: New-CsUserServicesConfiguration --- # New-CsUserServicesConfiguration @@ -42,7 +43,7 @@ Your command will fail if you try to create settings for, say, the Redmond site ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsUserServicesConfiguration -Identity site:Redmond -MaxContacts 500 -MaintenanceTimeOfDay "11:00 PM" ``` @@ -53,7 +54,7 @@ Note that this command will fail if User Services settings have already been con That is because you are limited to one collection of settings per site. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = New-CsUserServicesConfiguration -Identity site:Redmond -InMemory @@ -77,31 +78,28 @@ This final step is crucial: if you do not call the `Set-CsUserServicesConfigurat ## PARAMETERS -### -Identity -Unique identifier for the User Services configuration settings to be created. -To create settings at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To create settings at the service level, use syntax like this: +### -AllowNonRoomSystemNotification -`-Identity service:UserServer:atl-cs-001.litwareinc.com` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: $true | $false ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -AnonymousUserGracePeriod + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the amount of time an anonymous (unauthenticated) user can remain in a meeting without an authenticated user being present in that same meeting. For example, if this value is set to 15 minutes an anonymous user can stay in the meeting for, at most, 15 minutes before an authenticated user must join. If an authenticated user does not join before the grace period expires then the anonymous user will be removed from the meeting. @@ -114,8 +112,7 @@ The grace period can be set to any value between 0 second and 1 day; the default ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +122,9 @@ Accept wildcard characters: False ``` ### -DeactivationGracePeriod + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of time that a meeting can remain active. This value must be specified using the following format: days.hours:minutes:seconds. For example, to enable a meeting to last for 60 hours you would use this format: 2.12:00:00 (2 days. @@ -136,8 +136,7 @@ The default value is 1 day (1.00:00:00). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +146,9 @@ Accept wildcard characters: False ``` ### -DefaultSubscriptionExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. If no such request is issued, then the subscription is set to the value specified by the DefaultSubscriptionExpiration property. @@ -157,8 +159,71 @@ The default value is 28800 seconds (8 hours). ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the User Services configuration settings to be created. +To create settings at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To create settings at the service level, use syntax like this: + +`-Identity service:UserServer:atl-cs-001.litwareinc.com` + + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -168,6 +233,9 @@ Accept wildcard characters: False ``` ### -MaintenanceTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the time of day when regularly-scheduled database maintenance (such as the purging of outdated records) takes place. This value must be specified as a date-time value. You can use either the 24-hour format (for example, "14:00") or the 12-hour format (for example, "2:00 PM"). @@ -177,8 +245,7 @@ The default value for MaintenanceTimeOfDay is 1:00 AM (01:00:00). ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,6 +255,9 @@ Accept wildcard characters: False ``` ### -MaxContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of contacts a user can have; the default value is 250. The MaxContacts property represents the absolute maximum number of contacts a user can have. However, you can use the CsClientPolicy cmdlets to limit certain users to a maximum number of contacts lower than the value of MaxContacts. @@ -195,8 +265,7 @@ However, you can use the CsClientPolicy cmdlets to limit certain users to a maxi ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +275,9 @@ Accept wildcard characters: False ``` ### -MaxPersonalNotes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum number of personal notes that are stored in the user's note history. By default, the last 3 personal notes are maintained in the note history. The maximum number of notes that can be maintained in the history is 10. @@ -213,8 +285,7 @@ The maximum number of notes that can be maintained in the history is 10. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +295,9 @@ Accept wildcard characters: False ``` ### -MaxScheduledMeetingsPerOrganizer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of meetings that a single user can serve as organizer for at a given time. The default value is 1000. This means that, if a user is already the organizer for 1000 meetings, his or her attempt to schedule a new meeting (meeting number 1001) will fail. @@ -231,8 +305,7 @@ This means that, if a user is already the organizer for 1000 meetings, his or he ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -242,6 +315,9 @@ Accept wildcard characters: False ``` ### -MaxSubscriptionExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. The MaxSubscriptionExpiration property represents the maximum amount of time that clients can be granted. @@ -253,8 +329,7 @@ The default value is 43200 seconds (12 hours). ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,6 +339,9 @@ Accept wildcard characters: False ``` ### -MaxSubscriptions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of SIP subscribe dialogs that a user can have open at any one time. A subscribe dialog represents a request for SIP resources. The default value is 200. @@ -272,8 +350,7 @@ The default value is 200. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -282,32 +359,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscribeToCollapsedDG -If set to True (the default value), client applications will be allowed to subscribe to distribution groups that are not currently expanded in the Contacts list. -This enables the client to maintain up-to-minute presence information for each member of the group. -If set to False, client applications will not be allowed to subscribe to "collapsed" groups. +### -MinSubscriptionExpiration -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Subscriptions are created any time a user makes a request for data such as presence information. +When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. +The MinSubscriptionExpiration property represents the minimum amount of time that clients can be granted. +For example, if the minimum time is set to 1200 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 1200 seconds. + +The minimum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. +The default value is 1200 seconds (20 minutes). -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -316,16 +384,17 @@ 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-\. +### -PresenceProviders +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of presence providers for the new User Service configuration settings. +Presence providers are best added to a collection of User Service configuration settings by using the `New-CsPresenceProvider` cmdlet. ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -334,30 +403,18 @@ 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 +### -SubscribeToCollapsedDG -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +If set to True (the default value), client applications will be allowed to subscribe to distribution groups that are not currently expanded in the Contacts list. +This enables the client to maintain up-to-minute presence information for each member of the group. +If set to False, client applications will not be allowed to subscribe to "collapsed" groups. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -366,21 +423,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinSubscriptionExpiration -Subscriptions are created any time a user makes a request for data such as presence information. -When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. -The MinSubscriptionExpiration property represents the minimum amount of time that clients can be granted. -For example, if the minimum time is set to 1200 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 1200 seconds. +### -Confirm -The minimum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. -The default value is 1200 seconds (20 minutes). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -389,31 +441,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PresenceProviders -Collection of presence providers for the new User Service configuration settings. -Presence providers are best added to a collection of User Service configuration settings by using the `New-CsPresenceProvider` cmdlet. +### -WhatIf -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowNonRoomSystemNotification -PARAMVALUE: $true | $false +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -427,13 +464,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsUserServicesConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings The `New-CsUserServicesConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesPolicy.md similarity index 87% rename from skype/skype-ps/skype/New-CsUserServicesPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsUserServicesPolicy.md index d9608afa86..71aee732ed 100644 --- a/skype/skype-ps/skype/New-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsUserServicesPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csuserservicespolicy +schema: 2.0.0 +title: New-CsUserServicesPolicy --- # New-CsUserServicesPolicy @@ -46,7 +47,7 @@ Skype for Business Server Control Panel: The functions carried out by the `New-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsUserServicesPolicy -Identity "site:Redmond" -UcsAllowed $False ``` @@ -57,7 +58,46 @@ Users managed by this policy will not have their contacts moved to the Unified C ## PARAMETERS +### -EnableAwaySinceIndication + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be created. To create a policy at the site scope, use syntax similar to this: @@ -78,8 +118,7 @@ To create a per-user policy, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -88,30 +127,17 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -InMemory -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,15 +146,18 @@ 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. +### -MigrationDelayInDays + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the number of days the system will wait before beginning a migration to or from the unified contact store. +MigrationDelayInDays can be set to any value between 0 and 180, inclusive. +The default value is 0. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +167,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new user services policy is being created. For example: @@ -151,8 +183,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +193,9 @@ Accept wildcard characters: False ``` ### -UcsAllowed + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True (the default value) users affected by the policy will automatically be migrated to the unified contact store (assuming that they have an account on Exchange and that they log on using Skype for Business). When set to False, users can be removed from the unified contact store, but only if they are "manually" removed by the `Invoke-CsUcsRollback` cmdlet. @@ -169,8 +203,7 @@ When set to False, users can be removed from the unified contact store, but only ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +212,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -195,32 +230,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAwaySinceIndication -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -MigrationDelayInDays -Specifies the number of days the system will wait before beginning a migration to or from the unified contact store. -MigrationDelayInDays can be set to any value between 0 and 180, inclusive. -The default value is 0. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -234,13 +253,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsUserServicesPolicy` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy The `New-CsUserServicesPolicy` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerConfiguration.md index 3c55431495..6d37cf7e9b 100644 --- a/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVideoInteropServerConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvideointeropserverconfiguration +schema: 2.0.0 +title: New-CsVideoInteropServerConfiguration --- # New-CsVideoInteropServerConfiguration @@ -45,7 +46,7 @@ However, administrators can use the `New-CsVideoInteropServerConfiguration` cmdl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVideoInteropServerConfiguration -Identity "site:Redmond" -EnableEnhancedVideoExperience $False ``` @@ -56,38 +57,35 @@ The enhanced video experience is disabled by setting the EnableEnhancedVideoExpe ## PARAMETERS -### -Identity -Unique identifier for the new collection of VIS configuration settings. -New collections can be created at either the site scope or the service scope (for the video interop service only). -For example, this syntax creates a new collection of settings assigned to the Redmond site: - -`-Identity "site:Redmond"` +### -EnableEnhancedVideoExperience -And this syntax creates a new collection assigned to the VIS for the pool atl-cs-001.litwareinc.com: +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -`-Identity "service:VideoInteropServer:atl-edge-001.litwareinc.com"` +When set to True ($True) the single video stream coming from a third party video teleconferencing system (VTC) will be converted to multiple streams in order to meet the needs of devices using different video resolutions or frame rates. +The default value is True ($True). ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,31 +94,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableEnhancedVideoExperience -When set to True ($True) the single video stream coming from a third party video teleconferencing system (VTC) will be converted to multiple streams in order to meet the needs of devices using different video resolutions or frame rates. -The default value is True ($True). +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new collection of VIS configuration settings. +New collections can be created at either the site scope or the service scope (for the video interop service only). +For example, this syntax creates a new collection of settings assigned to the Redmond site: + +`-Identity "site:Redmond"` + +And this syntax creates a new collection assigned to the VIS for the pool atl-cs-001.litwareinc.com: + +`-Identity "service:VideoInteropServer:atl-edge-001.litwareinc.com"` ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,15 +139,16 @@ 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-\. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -167,13 +180,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsVideoInteropServerConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration The `New-CsVideoInteropServerConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerSyntheticTransactionConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerSyntheticTransactionConfiguration.md index 090e344050..febf093c0e 100644 --- a/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVideoInteropServerSyntheticTransactionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvideointeropserversynthetictransactionconfiguration +schema: 2.0.0 +title: New-CsVideoInteropServerSyntheticTransactionConfiguration --- # New-CsVideoInteropServerSyntheticTransactionConfiguration @@ -30,7 +31,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVideoInteropServerSyntheticTransactionConfiguration -Identity "site:Redmond" -WatcherNodeFqdns "atl-cs-001.contoso.com", "atl-cs-002.contoso.com" ``` @@ -40,7 +41,28 @@ This example creates a new Video Interop Server synthetic transaction configurat ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Identity parameter specifies the Video Interop Server synthetic transaction configuration to create. Video Interop Server synthetic transaction configuration settings can be configured at the global, site, or service scope. To refer to the global instance, use this syntax: @@ -56,8 +78,7 @@ Wildcard characters such as the asterisk (*) cannot be used with the Identity pa ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -66,14 +87,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -82,31 +106,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +### -WatcherNodeFqdns -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Specifies the FQDN of the watcher node relevant to the synthetic transaction. +For example: `-WatcherNodeFqdns "atl-cs-001.contoso.com"`. +Watcher nodes are computers that periodically use System Center Operations Manager and Skype for Business Server synthetic transactions to verify that Skype for Business Server components are working as expected. +For more information, see `New-CsWatcherNodeConfiguration`. -### -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. +To enter multiple values and overwrite any existing entries, use the following syntax: `\,\....` +If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: `"\","\"....` + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="\","\"...; Remove="\","\"...}`. ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,22 +132,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WatcherNodeFqdns -Specifies the FQDN of the watcher node relevant to the synthetic transaction. -For example: `-WatcherNodeFqdns "atl-cs-001.contoso.com"`. -Watcher nodes are computers that periodically use System Center Operations Manager and Skype for Business Server synthetic transactions to verify that Skype for Business Server components are working as expected. -For more information, see `New-CsWatcherNodeConfiguration`. +### -Confirm -To enter multiple values and overwrite any existing entries, use the following syntax: `\,\....` -If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: `"\","\"....` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="\","\"...; Remove="\","\"...}`. +Prompts you for confirmation before executing the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -160,12 +173,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None +### None ## OUTPUTS -### +### VideoInteropServerSyntheticTransactionConfiguration Returns a VideoInteropServerSyntheticTransactionConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVideoTrunkConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsVideoTrunkConfiguration.md index 554d14112c..13c80df66f 100644 --- a/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVideoTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVideoTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvideotrunkconfiguration +schema: 2.0.0 +title: New-CsVideoTrunkConfiguration --- # New-CsVideoTrunkConfiguration @@ -52,7 +53,7 @@ However, administrators can use the `New-CsVideoTrunkConfiguration` cmdlet to cr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVideoTrunkConfiguration -Identity "site:Redmond" -EnableSessionTimer $True ``` @@ -63,51 +64,17 @@ Session timers are enabled on the new configuration by setting the EnableSession ## PARAMETERS -### -Identity -The Identity parameter specifies the unique identifier for the new collection of video trunk configuration settings. -New collections can be created at either the site scope or the service scope (for the Video Gateway service only). - -For example, this syntax creates a new collection of settings assigned to the Redmond site: `-Identity "site:Redmond"`. -And this syntax creates a new collection assigned to the Video Gateway "video-pbx-001.litwareinc.com": `-Identity "service:VideoGateway:video-pbx-001.litwareinc.com"` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableMediaEncryptionForSipOverTls -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` - -### -EnableMediaEncryptionForSipOverTls When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) uses TLS to protect SIP signaling and uses SRTP to protect the media traffic. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +84,9 @@ Accept wildcard characters: False ``` ### -EnableSessionTimer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether the session timer is enabled. Session timers are used to determine whether a particular session is still active. The default is false ($False). @@ -127,8 +97,7 @@ In such a case, the Video Interop Server will reply to session timer probes from ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,13 +107,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +125,9 @@ Accept wildcard characters: False ``` ### -ForwardErrorCorrectionType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the type of Forward Error Correction (FEC) to be used between the Video Interop Server (VIS) and a Video Gateway. The valid settings are: @@ -164,8 +138,7 @@ Cisco: Enables FEC compatible with Cisco Video Gateways, such as Cisco Unified C ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,14 +148,16 @@ Accept wildcard characters: False ``` ### -GatewaySendsRtcpForActiveCalls + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) sends RTCP for calls that are enabled for media sending from the Video Gateway or VTC. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -192,14 +167,16 @@ Accept wildcard characters: False ``` ### -GatewaySendsRtcpForCallsOnHold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) sends RTCP for calls that are disabled for media sending from the Video Gateway or VTC. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,15 +185,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity parameter specifies the unique identifier for the new collection of video trunk configuration settings. +New collections can be created at either the site scope or the service scope (for the Video Gateway service only). + +For example, this syntax creates a new collection of settings assigned to the Redmond site: `-Identity "site:Redmond"`. +And this syntax creates a new collection assigned to the Video Gateway "video-pbx-001.litwareinc.com": `-Identity "service:VideoGateway:video-pbx-001.litwareinc.com"` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 passing that object reference to the `Set-CsVideoTrunkConfiguration` cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -226,13 +245,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -246,13 +267,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsVideoTrunkConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration The `New-CsVideoTrunkConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceNormalizationRule.md similarity index 83% rename from skype/skype-ps/skype/New-CsVoiceNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoiceNormalizationRule.md index 9404a4f7ca..4f8361741f 100644 --- a/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceNormalizationRule.md @@ -1,12 +1,14 @@ --- -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 -title: New-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: jenstrier +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoicenormalizationrule +schema: 2.0.0 +title: New-CsVoiceNormalizationRule --- # New-CsVoiceNormalizationRule @@ -42,18 +44,18 @@ 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 +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 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 +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 -------------------------- +### Example 1 ``` New-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" ``` @@ -67,7 +69,7 @@ Keep in mind that a dial plan for the Redmond site must exist for this command t You can create a new dial plan by calling the `New-CsDialPlan` cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoiceNormalizationRule -Parent SeattleUser -Name SeattleFourDigit -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' ``` @@ -84,7 +86,7 @@ Single quotes are required for these values; double quotes (or no quotes) will n 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 -------------------------- +### 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} @@ -94,88 +96,88 @@ This example creates a new in-memory voice normalization rule and then adds it t ## 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. +### -Description -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.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -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. +A friendly description of the normalization rule. +Maximum string length: 512 characters. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named 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. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False 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. +### -Identity -The Parent parameter is required unless the Identity parameter is specified. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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. -If you include the Parent parameter, the Name parameter is also required. + ```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 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A friendly description of the normalization rule. +### -InMemory -Maximum string length: 512 characters. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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: String +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 +Aliases: Required: False Position: Named @@ -185,6 +187,9 @@ Accept wildcard characters: False ``` ### -IsInternalExtension + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + 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. @@ -194,8 +199,7 @@ 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 +Aliases: Required: False Position: Named @@ -204,34 +208,45 @@ 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. +### -Name -Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True 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. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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: Int32 +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 +Aliases: Required: False Position: Named @@ -240,16 +255,18 @@ 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. +### -Pattern -Default: +$1 (The default prefixes the number with a plus sign \[+\].) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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 +Aliases: Required: False Position: Named @@ -258,14 +275,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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: SwitchParameter +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 +Aliases: Required: False Position: Named @@ -274,17 +295,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. +### -Tenant -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +For internal Microsoft usage. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -293,27 +313,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Translation -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -323,13 +334,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + 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 @@ -338,14 +351,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal Microsoft usage. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -359,12 +374,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsVoicePolicy.md similarity index 83% rename from skype/skype-ps/skype/New-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoicePolicy.md index 1f0e3f4982..256ec3d70c 100644 --- a/skype/skype-ps/skype/New-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoicePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoicePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoicepolicy +schema: 2.0.0 +title: New-CsVoicePolicy --- # New-CsVoicePolicy @@ -39,7 +40,7 @@ The policy created by this cmdlet determines whether many of these features are ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoicePolicy -Identity UserVoicePolicy1 ``` @@ -47,7 +48,7 @@ New-CsVoicePolicy -Identity UserVoicePolicy1 This example creates a new per-user voice policy (with default settings) that has an Identity of UserVoicePolicy1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoicePolicy UserVoicePolicy2 -AllowSimulRing $false -PstnUsages @{add = "Local"} ``` @@ -58,7 +59,7 @@ This command also adds "Local" to the list of PSTN usages, which associates this The Identity parameter is a positional parameter and therefore if you put the identity value first in the list of parameters you don't need to explicitly state that it's the Identity.) -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $a = Get-CsPstnUsage @@ -75,26 +76,10 @@ This refers to the Usage property of the PSTN usage settings, which contains the ## PARAMETERS -### -Identity -A unique identifier specifying the scope or the name of the policy. -Valid values for this cmdlet are site:\ (where \ is the name of the Skype for Business Server site to which this policy applies, such as site:Redmond) and a string designating a per-user policy, such as RedmondVoicePolicy. -A global policy exists by default. - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AllowCallForwarding -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AllowCallForwarding If this parameter is set to True, calls can be forwarded. If this parameter is set to False, calls cannot be forwarded. @@ -103,8 +88,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +98,9 @@ Accept wildcard characters: False ``` ### -AllowPSTNReRouting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When this parameter is set to True, calls made to internal numbers homed on another pool will be routed through the public switched telephone network (PSTN) when the pool or WAN is unavailable. Default: True @@ -121,8 +108,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +118,9 @@ Accept wildcard characters: False ``` ### -AllowSimulRing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Simultaneous ring is a feature that allows multiple phones to ring when a single number is dialed. Setting this parameter to True enables this feature. If this parameter is set to False, simultaneous ring cannot be configured for any user to which this policy is assigned. @@ -141,8 +130,63 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallForwardingSimulRingUsageType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way for administrators to manage call forwarding and simultaneous ringing. +Allowed values are: + +VoicePolicyUsage - The default voice policy usage is used to manage call forwarding and simultaneous ringing on all calls. +This is the default value. + +InternalOnly - Call forwarding and simultaneous ringing are limited to calls made from one Lync user to another. + +CustomUsage. +A custom PSTN usage will be used to manage call forwarding and simultaneous ringing. +This usage must be specified using the CustomCallForwardingSimulRingUsages parameter. + + +```yaml +Type: CallForwardingSimulRingUsageType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomCallForwardingSimulRingUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Custom PSTN usage used to manage call forwarding and simultaneous ringing. +To add a custom usage to voice policy use syntax similar to this: + +`-CustomCallForwardingSimulRingUsages @{Add="RedmondPstnUsage"}` + +To remove a custom usage, use this syntax: + +`-CustomCallForwardingSimulRingUsages @{Remove="RedmondPstnUsage"}` + +Note that the usage must exist before it can be used with the CustomCallForwardingSimulRingUsages parameter. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -152,6 +196,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of the voice policy. Maximum length: 1040 characters. @@ -159,8 +206,25 @@ Maximum length: 1040 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBusyOptions + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill EnableBusyOptions Description}} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -170,6 +234,9 @@ Accept wildcard characters: False ``` ### -EnableBWPolicyOverride + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Policies can be set to manage network configuration, including limiting bandwidth. Setting this parameter to True will allow override of these policies. In other words, if this parameter is set to True, no bandwidth checks will be made and calls will go through regardless of the call admission control (CAC) settings. @@ -179,8 +246,7 @@ 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 +Aliases: Required: False Position: Named @@ -190,6 +256,9 @@ Accept wildcard characters: False ``` ### -EnableCallPark + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Call Park application allows a call to be held, or parked, at a certain number within a range of numbers for later retrieval. Setting this parameter to True enables the application. If this parameter is set to False, users assigned to this policy cannot park calls that have been dialed to their phone number. @@ -199,8 +268,7 @@ 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 +Aliases: Required: False Position: Named @@ -210,6 +278,9 @@ Accept wildcard characters: False ``` ### -EnableCallTransfer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether calls can be transferred to another number. If this parameter is set to True, calls can be transferred; if the parameter is set to False, calls cannot be transferred. @@ -218,8 +289,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,6 +299,9 @@ Accept wildcard characters: False ``` ### -EnableDelegation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Call delegation allows a user to answer calls for another user or make calls on the other user's behalf. For example, a manager can set up call delegation so that all incoming calls ring both the manager's phone and the phone of an administrator. Setting this parameter to True allows users with this policy to set up call delegation. @@ -239,8 +312,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -250,6 +322,9 @@ Accept wildcard characters: False ``` ### -EnableMaliciousCallTracing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Malicious call tracing is a standard that is in place to trace calls that a user designates as malicious. These calls can be traced even if caller ID is blocked. The trace is available only to the proper authorities, not the user. @@ -260,8 +335,7 @@ 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 +Aliases: Required: False Position: Named @@ -271,6 +345,9 @@ Accept wildcard characters: False ``` ### -EnableTeamCall + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Team Call allows a user to designate a group of other users whose phones will ring when that user's number is called. This feature is useful in teams where, for example, anyone from a team can answer incoming calls from customers. Setting this parameter to True enables this feature. @@ -280,8 +357,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -290,18 +366,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -A displayable name describing this policy. +### -EnableVoicemailEscapeTimer -Default: DefaultPolicy +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, calls to an unanswered mobile device will be routed to the organization voicemail instead of the mobile device provider's voicemail. +If a call is answered "too soon" (that is, before the value configured for the PSTNVoicemailEscapeTimer property has elapsed) it will be assumed that the mobile device is not available and the call will be routed to the organization voicemail. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -310,19 +387,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PreventPSTNTollBypass -PSTN tolls are more commonly known as long-distance charges. -Organizations can sometimes bypass these tolls by implementing a Voice over Internet Protocol (VoIP) solution that enables branch offices to connect by using network calls. -Setting this parameter to True will send calls through the PSTN and incur charges rather than going through the network and bypassing the tolls. +### -Force -Default: False +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -331,46 +405,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsages -A list of PSTN usages available to this policy. -The PSTN usage ties a voice policy to a phone route. - -Any string value can be placed into this list, as long as the value exists in the current global list of PSTN usages. -(Duplicate strings are not allowed; all strings must be unique.) The list of PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet. +### -Identity -By default this list is empty. -If you don't supply a value for this parameter, you'll receive a warning message stating that users granted this policy will not be able to make outbound PSTN calls. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: PSListModifier -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 -``` +A unique identifier specifying the scope or the name of the policy. +Valid values for this cmdlet are site:\ (where \ is the name of the Skype for Business Server site to which this policy applies, such as site:Redmond) and a string designating a per-user policy, such as RedmondVoicePolicy. +A global policy exists by default. -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -378,8 +437,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,30 +446,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Name -```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 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A displayable name describing this policy. + +Default: DefaultPolicy -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 +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -420,25 +468,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallForwardingSimulRingUsageType -Provides a way for administrators to manage call forwarding and simultaneous ringing. -Allowed values are: +### -PreventPSTNTollBypass -VoicePolicyUsage - The default voice policy usage is used to manage call forwarding and simultaneous ringing on all calls. -This is the default value. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -InternalOnly - Call forwarding and simultaneous ringing are limited to calls made from one Lync user to another. +PSTN tolls are more commonly known as long-distance charges. +Organizations can sometimes bypass these tolls by implementing a Voice over Internet Protocol (VoIP) solution that enables branch offices to connect by using network calls. +Setting this parameter to True will send calls through the PSTN and incur charges rather than going through the network and bypassing the tolls. -CustomUsage. -A custom PSTN usage will be used to manage call forwarding and simultaneous ringing. -This usage must be specified using the CustomCallForwardingSimulRingUsages parameter. +Default: False ```yaml -Type: CallForwardingSimulRingUsageType +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -447,23 +491,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomCallForwardingSimulRingUsages -Custom PSTN usage used to manage call forwarding and simultaneous ringing. -To add a custom usage to voice policy use syntax similar to this: +### -PstnUsages -`-CustomCallForwardingSimulRingUsages @{Add="RedmondPstnUsage"}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To remove a custom usage, use this syntax: +A list of PSTN usages available to this policy. +The PSTN usage ties a voice policy to a phone route. -`-CustomCallForwardingSimulRingUsages @{Remove="RedmondPstnUsage"}` +Any string value can be placed into this list, as long as the value exists in the current global list of PSTN usages. +(Duplicate strings are not allowed; all strings must be unique.) The list of PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet. -Note that the usage must exist before it can be used with the CustomCallForwardingSimulRingUsages parameter. +By default this list is empty. +If you don't supply a value for this parameter, you'll receive a warning message stating that users granted this policy will not be able to make outbound PSTN calls. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -472,26 +516,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVoicemailEscapeTimer -When set to True, calls to an unanswered mobile device will be routed to the organization voicemail instead of the mobile device provider's voicemail. -If a call is answered "too soon" (that is, before the value configured for the PSTNVoicemailEscapeTimer property has elapsed) it will be assumed that the mobile device is not available and the call will be routed to the organization voicemail. - -The default value is False. +### -PSTNVoicemailEscapeTimer -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` - -### -PSTNVoicemailEscapeTimer Amount of time (in milliseconds) used to determine whether or not a call has been answered "too soon". If a response is received within this time interval Skype for Business Server will assume that the mobile device is not available and automatically switch the call to the organization's voicemail. If no response is received before the time interval is reached then the call will be allowed to proceed. The default value is 1500 milliseconds. @@ -500,8 +528,7 @@ The default value is 1500 milliseconds. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -511,6 +538,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new voice policy is being created. For example: @@ -524,8 +554,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -535,6 +564,9 @@ Accept wildcard characters: False ``` ### -VoiceDeploymentMode + +> Applicable: Lync Server 2013 + Allowed values are: * OnPrem @@ -547,8 +579,7 @@ The default value is OnPrem. ```yaml Type: VoiceDeploymentMode Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -557,14 +588,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableBusyOptions -{{Fill EnableBusyOptions Description}} +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -578,12 +629,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Voice.VoicePolicy This cmdlet creates an instance of the Microsoft.Rtc.Management.WritableConfig.Voice.VoicePolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoiceRegex.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRegex.md similarity index 88% rename from skype/skype-ps/skype/New-CsVoiceRegex.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoiceRegex.md index dfa493a3db..883418e4be 100644 --- a/skype/skype-ps/skype/New-CsVoiceRegex.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRegex.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: New-CsVoiceRegex -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoiceregex +schema: 2.0.0 +title: New-CsVoiceRegex --- # New-CsVoiceRegex @@ -42,7 +44,7 @@ Use this cmdlet to help you generate regular expressions to be used as Pattern a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $regex = New-CsVoiceRegex -ExactLength 7 -DigitsToStrip 3 ``` @@ -53,7 +55,7 @@ The Pattern created by this regular expression will be ^\d{3}(\d{4})$ while the For example, the number 5551212 would match this pattern and the resulting translation would be 1212: the 7-digit number with the first 3 digits stripped. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $regex = New-CsVoiceRegex -AtLeastLength 7 -StartsWith "1" @@ -77,6 +79,9 @@ This adds up to a number of at least 7 digits (1 plus 5 plus 1 or more) that sta ## PARAMETERS ### -AtLeastLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The minimum length required for the string (phone number) to match the expression. For example, if you're defining a normalization rule that affects only numbers that must be at least 7 digits (or characters) in length, specify a value of 7 for this parameter. @@ -86,8 +91,7 @@ You cannot enter values for both. ```yaml Type: Int32 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 +Aliases: Required: False Position: Named @@ -96,18 +100,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExactLength -The length the string (phone number) must be to match the regular expression. -For example, if you want a normalization rule to affect only 10-digit numbers, specify a value of 10 for this parameter. +### -DigitsToPrepend -You must enter a value for this parameter or for the AtLeastLength parameter. -You cannot enter values for both. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +A string specifying the characters or numbers to add to the beginning of the phone number. +The value entered for this parameter will impact the Translation value, prepending characters to the number matching the regular expression Pattern. +For example, if the number matching the pattern is 5551212 and the DigitsToPrepend value is 425, the translated number will be 4255551212 (assuming no other translations have been applied). ```yaml -Type: Int32 +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 +Aliases: Required: False Position: Named @@ -116,16 +120,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DigitsToPrepend -A string specifying the characters or numbers to add to the beginning of the phone number. -The value entered for this parameter will impact the Translation value, prepending characters to the number matching the regular expression Pattern. -For example, if the number matching the pattern is 5551212 and the DigitsToPrepend value is 425, the translated number will be 4255551212 (assuming no other translations have been applied). +### -DigitsToStrip + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +The number of characters to strip from the beginning of the string (phone number). +For example, if the number 2065551212 is entered and the DigitsToStrip is 3, the number will be translated to 5551212 ```yaml -Type: String +Type: Int32 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 +Aliases: Required: False Position: Named @@ -134,15 +139,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DigitsToStrip -The number of characters to strip from the beginning of the string (phone number). -For example, if the number 2065551212 is entered and the DigitsToStrip is 3, the number will be translated to 5551212 +### -ExactLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +The length the string (phone number) must be to match the regular expression. +For example, if you want a normalization rule to affect only 10-digit numbers, specify a value of 10 for this parameter. + +You must enter a value for this parameter or for the AtLeastLength parameter. +You cannot enter values for both. ```yaml Type: Int32 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 +Aliases: Required: False Position: Named @@ -152,6 +162,9 @@ Accept wildcard characters: False ``` ### -StartsWith + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The first character of the string (phone number). The string will not match the regular expression unless it begins with the string specified in the StartsWith parameter. For example, if a value of "+1" is specified for StartsWith, only numbers that begin with +1 will match this pattern and be translated. @@ -161,8 +174,7 @@ For example, if you've specified an ExactLength of 10 and a StartsWith string of ```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 +Aliases: Required: False Position: Named @@ -176,12 +188,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.OcsVoiceRegex Creates on object of type Microsoft.Rtc.Management.Voice.OcsVoiceRegex. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoute.md similarity index 85% rename from skype/skype-ps/skype/New-CsVoiceRoute.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoiceRoute.md index f6633618bd..b3e460d9b9 100644 --- a/skype/skype-ps/skype/New-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoiceRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoiceroute +schema: 2.0.0 +title: New-CsVoiceRoute --- # New-CsVoiceRoute @@ -48,7 +49,7 @@ A voice route includes a regular expression that identifies which phone numbers ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoiceRoute -Identity Route1 ``` @@ -57,7 +58,7 @@ The command in this example creates a new voice route with an Identity of Route1 All other properties will be set to the default values. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoiceRoute -Identity Route1 -PstnUsages @{add="Long Distance"} -PstnGatewayList @{add="PstnGateway:redmondpool.litwareinc.com"} ``` @@ -66,7 +67,7 @@ The command in this example creates a new voice route with an Identity of Route1 It also adds the PSTN usage Long Distance to the list of usages and the service ID PstnGateway:redmondpool.litwareinc.com to the list of PSTN gateways. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $x = (Get-CsPstnUsage).Usage @@ -86,61 +87,59 @@ This value says to add the contents of $x, which contain the phone usages list r ## PARAMETERS -### -Identity -A name that uniquely identifies the voice route. -Voice routes can be defined only at the global scope, so the identity is simply the name you want to give the route. -(You can have spaces in the route name, for instance Test Route, but you must enclose the full string in double quotes in the call to the `New-CsVoiceRoute` cmdlet.) +### -AlternateCallerId -If Identity is specified, the Name must be left blank. -The value of the Identity will be assigned to the Name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If the SuppressCallerId parameter is set to True, the value of the AlternateCallerId parameter will be displayed to receiving parties rather than the caller's actual number. +This number should be a valid number and could be used to represent a division within an organization, such as Support or Human Resources. + +If the SuppressCallerId parameter is set to False, the AlternateCallerId parameter is ignored. +This value must match the regular expression (\+)?\[1-9\]\d*(;ext=\[1-9\]\d*)?. +In other words, the value can begin with a plus sign (+) but doesn't need to; must consist of any number of digits and may be followed by an extension that begins with ;ext= followed by any number of digits. +(Note that if you include an extension the string must be placed within double quotes.) ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The unique name of the voice route. -If this parameter is set, the value will be automatically applied to the voice route Identity. -You cannot specify both an Identity and a Name. +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A description of what this voice route is for. ```yaml Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AlternateCallerId -If the SuppressCallerId parameter is set to True, the value of the AlternateCallerId parameter will be displayed to receiving parties rather than the caller's actual number. -This number should be a valid number and could be used to represent a division within an organization, such as Support or Human Resources. +### -Force -If the SuppressCallerId parameter is set to False, the AlternateCallerId parameter is ignored. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This value must match the regular expression (\+)?\[1-9\]\d*(;ext=\[1-9\]\d*)?. -In other words, the value can begin with a plus sign (+) but doesn't need to; must consist of any number of digits and may be followed by an extension that begins with ;ext= followed by any number of digits. -(Note that if you include an extension the string must be placed within double quotes.) +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,14 +148,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description of what this voice route is for. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A name that uniquely identifies the voice route. +Voice routes can be defined only at the global scope, so the identity is simply the name you want to give the route. +(You can have spaces in the route name, for instance Test Route, but you must enclose the full string in double quotes in the call to the `New-CsVoiceRoute` cmdlet.) + +If Identity is specified, the Name must be left blank. +The value of the Identity will be assigned to the Name. + ```yaml -Type: String +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,7 +192,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique name of the voice route. +If this parameter is set, the value will be automatically applied to the voice route Identity. +You cannot specify both an Identity and a Name. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NumberPattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that specifies the phone numbers to which this route applies. Numbers matching this pattern will be routed according to the rest of the routing settings. @@ -174,8 +224,7 @@ Default: \[0-9\]{10} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,14 +234,16 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number could resolve to multiple voice routes. The priority determines the order in which the routes will be applied if more than one route is possible. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +253,9 @@ Accept wildcard characters: False ``` ### -PstnGatewayList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + In Skype for Business Server a Mediation Server can be associated with multiple gateways. This parameter contains a list of gateways associated with this voice route. Each member of this list must be the service Identity of the PSTN gateway or Mediation Server. @@ -218,8 +272,7 @@ However, if you leave this parameter blank when creating a new voice route, you' ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,6 +282,9 @@ Accept wildcard characters: False ``` ### -PstnUsages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of PSTN usages (such as Local, Long Distance, etc.) that can be applied to this voice route. The PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet.) @@ -239,8 +295,7 @@ However, if you leave this parameter blank when creating a new voice route, you' ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -250,6 +305,9 @@ Accept wildcard characters: False ``` ### -SuppressCallerId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether a caller's ID will be revealed on outbound calls. If this parameter is set to True, caller ID will be suppressed. In place of the actual ID, the value of the AlternateCallerId will be displayed. @@ -258,8 +316,7 @@ When SuppressCallerId is set to True, a value for AlternateCallerId must be supp ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,32 +325,16 @@ 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 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Confirm -### -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -303,29 +344,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -339,12 +366,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route Creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoutingPolicy.md similarity index 85% rename from skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoiceRoutingPolicy.md index f6a0bd7f8b..167abe7182 100644 --- a/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoiceRoutingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoiceroutingpolicy +schema: 2.0.0 +title: New-CsVoiceRoutingPolicy --- # New-CsVoiceRoutingPolicy @@ -38,7 +39,7 @@ Skype for Business Server Control Panel: The functions carried out by the `New-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -Name "RedmondVoiceRoutingPolicy" -PstnUsages "Long Distance" ``` @@ -47,7 +48,7 @@ The command shown in Example 1 creates a new per-user voice routing policy with This policy is assigned a single PSTN usage: Long Distance. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -Name "RedmondVoiceRoutingPolicy" -PstnUsages "Long Distance", "Local", "Internal" ``` @@ -58,34 +59,35 @@ Multiple usages can be assigned simply by separating each usage using a comma. ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new voice routing policy. -Because you can only create new policies at the per-user scope, the Identity will always be the "name" being assigned to the policy. -For example: +### -Description -`-Identity "RedmondVoiceRoutingPolicy"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide explanatory text to accompany a voice routing policy. +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,48 +96,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany a voice routing policy. -For example, the Description might include information about the users the policy should be assigned to. +### -Identity -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Unique identifier to be assigned to the new voice routing policy. +Because you can only create new policies at the per-user scope, the Identity will always be the "name" being assigned to the policy. +For example: -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +`-Identity "RedmondVoiceRoutingPolicy"` ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,13 +138,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A friendly name describing this policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +156,9 @@ Accept wildcard characters: False ``` ### -PstnUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of PSTN usages (such as Local or Long Distance) that can be applied to this voice routing policy. The PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet.) @@ -168,8 +166,25 @@ The PSTN usage must be an existing usage. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -199,13 +216,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsVoiceRoutingPolicy` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy The `New-CsVoiceRoutingPolicy` cmdlet creates new instances of Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceTestConfiguration.md similarity index 83% rename from skype/skype-ps/skype/New-CsVoiceTestConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoiceTestConfiguration.md index bff35169f4..8f05db245e 100644 --- a/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceTestConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoiceTestConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoicetestconfiguration +schema: 2.0.0 +title: New-CsVoiceTestConfiguration --- # New-CsVoiceTestConfiguration @@ -46,7 +47,7 @@ The configurations created with this cmdlet are tested using the `Test-CsVoiceTe ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoiceTestConfiguration -Identity TestConfig1 ``` @@ -54,7 +55,7 @@ New-CsVoiceTestConfiguration -Identity TestConfig1 This example creates a new voice test configuration with default values that has the Identity TestConfig1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoiceTestConfiguration TestConfig1 -TargetDialplan site:Redmond1 ``` @@ -66,7 +67,7 @@ In this example we declared TestConfig1 without specifying the Identity paramete Identity is a positional parameter, so the first value in the command following the cmdlet name is recognized by the cmdlet as the Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` New-CsVoiceTestConfiguration -Identity TestConfig1 -DialedNumber 5551212 -ExpectedTranslatedNumber +5551212 ``` @@ -79,46 +80,10 @@ That test must be run using the `Test-CsVoiceTestConfiguration` cmdlet. ## PARAMETERS -### -Identity -A string uniquely identifying this test scenario. - -This string can be up to 32 characters in length and may contain any alphanumeric characters plus the backslash (\\), period (.) or underscore (_). - -The value of this parameter does not include scope because this object can be created only at the global scope. -Therefore only a unique name is required. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -This parameter contains the same value as the Identity. -If the Identity parameter is specified, you cannot include the Name parameter in your command. -Likewise, if the Name parameter is specified, you cannot specify an Identity. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DialedNumber -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DialedNumber The phone number you want to use to test the policies, usages, etc. Must be 512 characters or fewer. @@ -128,8 +93,7 @@ Default: 1234 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +103,9 @@ Accept wildcard characters: False ``` ### -ExpectedRoute + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the voice route expected to be used during the configuration test. If a different route is used, based on the target dial plan and voice policy, the test will fail. You can retrieve available voice routes by calling the `Get-CsVoiceRoute` cmdlet. @@ -148,8 +115,7 @@ Must be 256 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +125,9 @@ Accept wildcard characters: False ``` ### -ExpectedTranslatedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number in the format you expect to see it after translation. This is the value of the DialedNumber parameter after normalization. If you run the `Test-CsVoiceTestConfiguration` cmdlet and the DialedNumber does not result in the value in ExpectedTranslatedNumber, the test will report as Fail. @@ -171,8 +140,7 @@ Default: +1234 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +150,9 @@ Accept wildcard characters: False ``` ### -ExpectedUsage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the PSTN usage expected to be used during the configuration test. If a different PSTN usage is used, based on the target dial plan and voice policy, the test will fail. You can retrieve available usages by calling the `Get-CsPstnUsage` cmdlet. @@ -192,8 +163,7 @@ Must be 256 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,20 +172,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetVoicePolicy -The Identity of the voice policy against which to run this test. -Voice policies can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. - -Must be 40 characters or fewer. +### -Force -Default: Global +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,23 +190,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string uniquely identifying this test scenario. + +This string can be up to 32 characters in length and may contain any alphanumeric characters plus the backslash (\\), period (.) or underscore (_). + +The value of this parameter does not include scope because this object can be created only at the global scope. +Therefore only a unique name is required. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -248,8 +224,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,14 +233,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter contains the same value as the Identity. +If the Identity parameter is specified, you cannot include the Name parameter in your command. +Likewise, if the Name parameter is specified, you cannot specify an Identity. ```yaml -Type: SwitchParameter +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDialplan + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the dial plan to be used for this test. +Dial plans can be retrieved by called the `Get-CsDialPlan` cmdlet. + +Must be 40 characters or fewer. + +Default: Global + + +```yaml +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVoicePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the voice policy against which to run this test. +Voice policies can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. + +Must be 40 characters or fewer. + +Default: Global + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -275,13 +302,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -290,20 +319,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetDialplan -The Identity of the dial plan to be used for this test. -Dial plans can be retrieved by called the `Get-CsDialPlan` cmdlet. - -Must be 40 characters or fewer. +### -WhatIf -Default: Global +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -317,12 +342,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVoicemailReroutingConfiguration.md similarity index 85% rename from skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoicemailReroutingConfiguration.md index 58bcb680ea..b0daf21b70 100644 --- a/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoicemailReroutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoicemailReroutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoicemailreroutingconfiguration +schema: 2.0.0 +title: New-CsVoicemailReroutingConfiguration --- # New-CsVoicemailReroutingConfiguration @@ -38,7 +39,7 @@ Note that these settings are not available unless the Enabled property has been ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoicemailReroutingConfiguration -Identity site:Redmond1 -Enabled $True -AutoAttendantNumber "+14255551212" ``` @@ -47,7 +48,7 @@ This example creates new voice mail rerouting settings that apply to the site Re The Enabled parameter is set to True to turn on this configuration and a phone number (+14255551212) is supplied to specify the Auto-Attendant to which calls will be rerouted. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoicemailReroutingConfiguration -Identity site:Redmond1 -SubscriberAccessNumber "+14255551213" ``` @@ -60,25 +61,10 @@ Enabled is set to False by default, so Subscriber Access calls will not be rerou ## PARAMETERS -### -Identity -This parameter contains a unique identifier specifying the scope at which this configuration is applied. -New voice mail rerouting configurations can be created only at the site level, so the Identity would be in the format Site:\, where \ is the name of the site to which the settings are applied. -A global voice mail rerouting configuration exists by default and cannot be re-created by calling the `New-CsVoicemailReroutingConfiguration` cmdlet. +### -AutoAttendantNumber -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoAttendantNumber Phone number of the Auto-Attendant to which the voice mail deposit attempts should be re-routed. The number supplied to this parameter must be a LineUri of an existing contact object. @@ -88,8 +74,7 @@ Value must be a number beginning with a digit 1 through 9, optionally preceded b ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +84,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether attempts to access voice mail should be re-routed through PSTN when IP connectivity is down. Default: False @@ -106,8 +94,7 @@ 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 +Aliases: Required: False Position: Named @@ -116,18 +103,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscriberAccessNumber -Subscriber Access number to which the voice mail retrieval attempts should be re-routed. +### -Force -The number supplied to this parameter must be a LineUri of an existing contact object. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,23 +121,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter contains a unique identifier specifying the scope at which this configuration is applied. +New voice mail rerouting configurations can be created only at the site level, so the Identity would be in the format Site:\, where \ is the name of the site to which the settings are applied. +A global voice mail rerouting configuration exists by default and cannot be re-created by calling the `New-CsVoicemailReroutingConfiguration` cmdlet. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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-\. @@ -160,8 +152,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +161,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SubscriberAccessNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Subscriber Access number to which the voice mail retrieval attempts should be re-routed. + +The number supplied to this parameter must be a LineUri of an existing contact object. + +Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,13 +184,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -207,12 +224,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsWatcherNodeConfiguration.md similarity index 85% rename from skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsWatcherNodeConfiguration.md index 7127cbf0ec..c00bfab531 100644 --- a/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWatcherNodeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsWatcherNodeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cswatchernodeconfiguration +schema: 2.0.0 +title: New-CsWatcherNodeConfiguration --- # New-CsWatcherNodeConfiguration @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the `New-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTestUserCredential -SipAddress "sip:kenmyer@litwareinc.com" -UserName "litwareinc\kenmyer" -Password "07Apples" @@ -69,64 +70,57 @@ These new settings use port 5061; the two new test users and the extended test s ## PARAMETERS -### -Identity -Fully qualified domain name of the pool being associated with the watcher node configuration settings. -You can use either the Identity parameter or the TargetFqdn parameter to specify the pool; however, you cannot use both these parameters in the same command. +### -Enabled -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PortNumber -SIP port used by the Registrar service. +Enables or disables the watcher node. +The default value is True ($True). ```yaml -Type: UInt16 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name of the pool being associated with the watcher node configuration settings. -You can use either the TargetFqdn parameter or the Identity parameter to specify the pool; however, you cannot use both these parameters in the same command. +### -ExtendedTests + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +PSTN or Audio Conferencing Provider tests that can be assigned to a watcher node configuration. +These tests must be created using the `New-CsExtendedTest` cmdlet and stored in a variable (for example, $x). +The test can then be assigned to a watcher node by using syntax similar to this: + +`-ExtendedTests @{Add=$x}` ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSListModifier +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,35 +129,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Enables or disables the watcher node. -The default value is True ($True). +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being associated with the watcher node configuration settings. +You can use either the Identity parameter or the TargetFqdn parameter to specify the pool; however, you cannot use both these parameters in the same command. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExtendedTests -PSTN or Audio Conferencing Provider tests that can be assigned to a watcher node configuration. -These tests must be created using the `New-CsExtendedTest` cmdlet and stored in a variable (for example, $x). -The test can then be assigned to a watcher node by using syntax similar to this: +### -InMemory -`-ExtendedTests @{Add=$x}` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,33 +167,37 @@ 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. +### -PortNumber + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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. +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being associated with the watcher node configuration settings. +You can use either the TargetFqdn parameter or the Identity parameter to specify the pool; however, you cannot use both these parameters in the same command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -206,6 +205,9 @@ Accept wildcard characters: False ``` ### -Tests + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Synthetic transactions to be run by the watcher node. Allowed values are: @@ -249,8 +251,7 @@ To configure tests at the time you create a new watcher node, use the following ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -260,6 +261,9 @@ Accept wildcard characters: False ``` ### -TestUsers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP addresses of the test users to be assigned to the watcher node; these user accounts must have previously been configured by using the `Set-CsTestUserCredential` cmdlet. To add test users, use syntax similar to this, separating user addresses by using commas: @@ -268,8 +272,7 @@ To add test users, use syntax similar to this, separating user addresses by usin ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -278,15 +281,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseInternalWebUrls -When set to True ($True), instructs the watcher node to use the internal Web URLs rather than the external Web URLs. -This provides a way to way to verify URL validity for users located behind the organization's firewall. +### -UseAutoDiscovery + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), Skype for Business Online watcher nodes will use the Autodiscover service to locate the target pool. +When set to False (the default value) watcher nodes will use SRV records to locate the pool. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -295,14 +300,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UseInternalWebUrls + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), instructs the watcher node to use the internal Web URLs rather than the external Web URLs. +This provides a way to way to verify URL validity for users located behind the organization's firewall. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -312,13 +320,15 @@ Accept wildcard characters: False ``` ### -XmppTestReceiverMailAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + XMPP email address to be used when testing the XMPP gateway. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -327,15 +337,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseAutoDiscovery -When set to True ($True), Skype for Business Online watcher nodes will use the Autodiscover service to locate the target pool. -When set to False (the default value) watcher nodes will use SRV records to locate the pool. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -349,13 +378,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsWatcherNodeConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated The `New-CsWatcherNodeConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsWebLink.md b/skype/skype-ps/SkypeForBusiness/New-CsWebLink.md similarity index 94% rename from skype/skype-ps/skype/New-CsWebLink.md rename to skype/skype-ps/SkypeForBusiness/New-CsWebLink.md index 56cf68d55b..f76582aeba 100644 --- a/skype/skype-ps/skype/New-CsWebLink.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebLink.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csweblink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsWebLink -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csweblink +schema: 2.0.0 +title: New-CsWebLink --- # New-CsWebLink @@ -52,7 +53,7 @@ Autodiscover URLs are based on the SIP domains used in your organization; admini ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscover.fabrikam.com" @@ -65,7 +66,7 @@ After that, the `Set-CsAutoDiscoverConfiguration` cmdlet is used to add the new This is done by using the WebLinks parameter and the parameter value @{Add=$Link1}. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscover.fabrikam.com" @@ -84,6 +85,9 @@ That syntax causes the values stored in the variables $Link1 and $Link2 to be ad ## PARAMETERS ### -Href + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the Autodiscover service, For example: `-Href "https://LyncDiscover.fabrikam.com"` @@ -91,8 +95,7 @@ URL for the Autodiscover service, For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Token + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name to be given to the URL. For example: @@ -110,8 +116,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -125,13 +130,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsWebLink` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Settings.WebLink.WebLink Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.WebLink.WebLink object ## NOTES diff --git a/skype/skype-ps/skype/New-CsWebOrigin.md b/skype/skype-ps/SkypeForBusiness/New-CsWebOrigin.md similarity index 94% rename from skype/skype-ps/skype/New-CsWebOrigin.md rename to skype/skype-ps/SkypeForBusiness/New-CsWebOrigin.md index f4c97376ec..06ac4c6969 100644 --- a/skype/skype-ps/skype/New-CsWebOrigin.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebOrigin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csweborigin applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsWebOrigin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csweborigin +schema: 2.0.0 +title: New-CsWebOrigin --- # New-CsWebOrigin @@ -33,7 +34,7 @@ Skype for Business Server Control Panel: The functions carried out by the `New-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsWebOrigin -Url "http://fabrikam.com" @@ -48,7 +49,7 @@ The second command in the example uses the `New-CsWebServiceConfiguration` cmdle The syntax "`- CrossDomainAuthorizationList $x`" adds http://fabrikam.com to the collection of domains authorized for cross-domain scripting. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = New-CsWebOrigin -Url "http://fabrikam.com" @@ -67,6 +68,9 @@ To replace the existing collection with just http://fabrikam.com use the syntax ## PARAMETERS ### -Url + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + URL of the domain authorized to send cross-domain scripting requests. URLs must be prefaced using either the http: or the https: prefix. For example: @@ -76,8 +80,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -91,13 +94,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsWebOrigin` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Web.Origin The `New-CsWebOrigin` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.Origin object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsWebServiceConfiguration.md similarity index 83% rename from skype/skype-ps/skype/New-CsWebServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsWebServiceConfiguration.md index 8b4f16252e..c0f2c96b00 100644 --- a/skype/skype-ps/skype/New-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsWebServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cswebserviceconfiguration +schema: 2.0.0 +title: New-CsWebServiceConfiguration --- # New-CsWebServiceConfiguration @@ -124,41 +125,58 @@ For example: ## PARAMETERS -### -Identity -Unique identifier for the Web Services configuration settings to be created. -To create settings configured at the site scope, use syntax similar to this: +### -AllowAnonymousAccessToLWAConference -`-Identity "site:Redmond"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To create settings configured at the service scope, use syntax similar to this: +When set to True (the default value), anonymous users will be allowed to attend Skype for Business web App conferences. -`-Identity "service:WebServer:atl-cs-001.litwareinc.com"` -Note that any settings created at the service scope must be assigned to the Web Server service. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExternalAuthentication +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), OAuth authentication can be used to authenticate external users. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousAccessToLWAConference -When set to True (the default value), anonymous users will be allowed to attend Skype for Business web App conferences. +### -AutoLaunchLyncWebAccess + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +When set to True, Skype for Business Web App will automatically be used as the default web popup for joining an online conference, provided that the prerequisites for using Skype for Business Web App (for example, Silverlight have been installed and Internet Explorer is not blocking pop-up windows) have been met. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -168,14 +186,40 @@ Accept wildcard characters: False ``` ### -CASigningKeyLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Sets the size of the certification authority (CA) signing key, the private key used by a CA to sign digital certificates. The signing key length can be set to any integer value between 2048 and 16384 bytes; the default value is 2048. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CrossDomainAuthorizationList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of domains allowed to host web applications that send cross-domain scripting requests to the Skype for Business Server deployment. + +Domains to be added to the list must be created using the `New-CsWebOrigin` cmdlet and then added to the new collection of Web service configuration settings. +Domain names must be prefaced using the http: or the https: prefix. +See Example 3 of this help topic for more information. + +This parameter was introduced in the February, 2013 release of Lync Server 2013. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -185,6 +229,9 @@ Accept wildcard characters: False ``` ### -DefaultValidityPeriodHours + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. DefaultValidityPeriodHours represents the amount of time a certificate will remain valid if the client does not request a custom validity period. @@ -194,8 +241,7 @@ The default value is 4320 (180 days). ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +251,9 @@ Accept wildcard characters: False ``` ### -EnableCertChainDownload + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, servers presented with an authentication certificate will download the certificate chain for that certificate. The certificate chain traces an individual certificate back to the issuing CA. Certificates will not be accepted for authentication unless the certificate's CA is trusted. @@ -212,8 +261,7 @@ Certificates will not be accepted for authentication unless the certificate's CA ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -223,6 +271,9 @@ Accept wildcard characters: False ``` ### -EnableGroupExpansion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, group expansion will be enabled in Skype for Business. With group expansion, users can configure a distribution group as a contact and then "expand" that group. When a group has been expanded, users can see all the individual members of a group and their current presence information. @@ -231,8 +282,7 @@ When a group has been expanded, users can see all the individual members of a gr ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,15 +291,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InferCertChainFromSSL -If set to True, servers will use the certificate information included in the Secure Sockets Layer (SSL) protocol to determine the issuing CA. -Certificates will not be accepted for authentication unless the certificate's CA is trusted. +### -EnableMediaBasicAuth + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $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 +Aliases: Required: False Position: Named @@ -258,17 +309,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MACResolverUrl -URL for a Web service capable of performing Media Access Control (MAC) resolution. -MAC resolution involves taking the MAC address of a connected client and returning the chassis and port IDs of the network switch that client is connected to. -MAC resolution is used by the Enhanced 9-1-1 service. +### -EnableStatisticsInResponse +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True) the X-MS-WebInfraStats header is included in all HTTP responses. +The default value is False ($False). ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,16 +328,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxCSRKeySize -Sets the maximum size of the certificate signing request (CSR) key. -(A CSR is a message sent from an applicant to a CA in order to apply for a digital certificate.) The maximum size can be set to any integer value between 1024 and 16384 bytes. -The default value is 16384. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: UInt64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -295,18 +346,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxGroupSizeToExpand -Represents the maximum number of people that will be displayed when a group is expanded. -For example, if MaxGroupSizeToExpand is set to 75, only the first 75 members of the group will be displayed any time the group is expanded. +### -HstsMaxAgeInSeconds -MaxGroupSizeToExpand can be set to any integer value between 1 and 1000, inclusive. -The default value is 100. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the time in seconds of the max-age setting in the Strict-Transport-Security (STS) header of an HTTPS response. +A negative value will suppress the STS header in the HTTPS response. +The default is 315,360,000 (one year.) ```yaml -Type: UInt32 +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -315,36 +366,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxValidityPeriodHours -When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. -MaxValidityPeriodHours represents the maximum amount of time a client can request. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the Web Services configuration settings to be created. +To create settings configured at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +To create settings configured at the service scope, use syntax similar to this: + +`-Identity "service:WebServer:atl-cs-001.litwareinc.com"` + +Note that any settings created at the service scope must be assigned to the Web Server service. -MaxValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). -The default value is 8760. ```yaml -Type: UInt64 +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MinCSRKeySize -Sets the minimum size of the CSR key. -The minimum size can be set to any integer value between 1024 and 16384 bytes. -The default value is 16384. +### -InferCertChainFromSSL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, servers will use the certificate information included in the Secure Sockets Layer (SSL) protocol to determine the issuing CA. +Certificates will not be accepted for authentication unless the certificate's CA is trusted. ```yaml -Type: UInt64 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -353,18 +413,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinValidityPeriodHours -When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. -MinValidityPeriodHours represents the minimum amount of time a client can request. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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-\. -MinValidityPeriodHours can be any integer value between 8 hours and 4320 hours (180 days). -The default value is 8. ```yaml -Type: UInt64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -373,15 +433,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryLocationSourceUrl -URL for a Web service that can process a location request. -This service is typically used only when location requests cannot be resolved locally. +### -MACResolverUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for a Web service capable of performing Media Access Control (MAC) resolution. +MAC resolution involves taking the MAC address of a connected client and returning the chassis and port IDs of the network switch that client is connected to. +MAC resolution is used by the Enhanced 9-1-1 service. + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -390,17 +454,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TrustedCACerts -Collection of certificates representing certificate chains trusted by the Web server. -New certificates added to the collection must be created using the `New-CsWebTrustedCACertificate` cmdlet. +### -MaxCSRKeySize -This collection is not used if the InferCertChainFromSSL property is set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Sets the maximum size of the certificate signing request (CSR) key. +(A CSR is a message sent from an applicant to a CA in order to apply for a digital certificate.) The maximum size can be set to any integer value between 1024 and 16384 bytes. +The default value is 16384. ```yaml -Type: PSListModifier +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -409,32 +474,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseCertificateAuth -When set to True (the default value), clients can be authenticated using certificates. -Set this value to False ($False) to disable certificate authentication. +### -MaxGroupSizeToExpand -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Represents the maximum number of people that will be displayed when a group is expanded. +For example, if MaxGroupSizeToExpand is set to 75, only the first 75 members of the group will be displayed any time the group is expanded. -### -UsePinAuth -When set to True (the default value), clients can be authenticated using personal identification numbers (PINs). -Set this value to False ($False) to disable PIN authentication. +MaxGroupSizeToExpand can be set to any integer value between 1 and 1000, inclusive. +The default value is 100. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -443,21 +496,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWindowsAuth -Determines how (and if) users will be authenticated using Windows authentication; that is, using the same credentials they used when they logged on to Windows. -Valid values are: +### -MaxValidityPeriodHours -Negotiate - The client and server will work together to determine the proper authentication protocol (either Kerberos or NTLM). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -NTLM - Windows authentication will be allowed, but only using the NTLM protocol. +When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. +MaxValidityPeriodHours represents the maximum amount of time a client can request. -None - Windows authentication will not be allowed. +MaxValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). +The default value is 8760. ```yaml -Type: UseWindowsAuth +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -466,14 +518,18 @@ 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. +### -MinCSRKeySize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Sets the minimum size of the CSR key. +The minimum size can be set to any integer value between 1024 and 16384 bytes. +The default value is 16384. ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -482,16 +538,20 @@ 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-\. +### -MinValidityPeriodHours +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. +MinValidityPeriodHours represents the minimum amount of time a client can request. + +MinValidityPeriodHours can be any integer value between 8 hours and 4320 hours (180 days). +The default value is 8. ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -500,30 +560,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MobilePreferredAuthType -```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 +> 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 -``` +Specifies the preferred authentication type to be used by mobile applications. +If an unsupported method is specified, the web ticket service will not start and an event will be logged by the Skype for Business Server. +Accepted values for the MobilePreferredAuthType parameter are: -### -Confirm -Prompts you for confirmation before executing the command. +None + +OAuth + +WebTicketServiceAnon + +WebTicketServiceWinNegotiate + +WebTicketServiceWinNtlm + +WebTicketServiceCert + +WebTicketServicePin + +WsFedPassive + +WsFedBearer + +WebTicketServiceAuth ```yaml -Type: SwitchParameter +Type: MobilePreferredAuthType Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -532,17 +600,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowDownloadCommunicatorAttendeeLink -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +### -PendingGetWaitSupportingApps -If set to True (the default value), users joining a meeting by using a client application other than Skype for Business will see a link that points them toward a download for Skype for Business Web App. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. +Supported applications are Android, iPhone, iPad, Macintosh, Windows. +To support all applications you can give All as input. +For example: +- To support Android and Macintosh - Android;Macintosh; +- To support all devices - All; +The default value is None. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -551,18 +624,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowJoinUsingLegacyClientLink -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +### -PendingGetWaitTimeOutInMinutes -If set to True, users joining a meeting by using a client application other than Skype for Business will be given the opportunity to join the meeting by using their current client application. -The default value is False. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. +The value can be specified in between 5 to 15 minutes (both inclusive). +The default value is 15 minutes. ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -571,14 +644,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalAuthentication -When set to True (the default value), OAuth authentication can be used to authenticate external users. +### -SecondaryLocationSourceUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for a Web service that can process a location request. +This service is typically used only when location requests cannot be resolved locally. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -587,19 +663,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoLaunchLyncWebAccess -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +### -ShowAlternateJoinOptionsExpanded -When set to True, Skype for Business Web App will automatically be used as the default web popup for joining an online conference, provided that the prerequisites for using Skype for Business Web App (for example, Silverlight have been installed and Internet Explorer is not blocking pop-up windows) have been met. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is True. +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +When set to True then alternate options for joining an online conference will automatically be expanded and shown to users. +When set to False (the default value) these options will be available, but the user will have to display the list of options for themselves. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -608,18 +685,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowAlternateJoinOptionsExpanded +### -ShowDownloadCommunicatorAttendeeLink + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter has been deprecated for use with the on-premises version of Skype for Business Server. -When set to True then alternate options for joining an online conference will automatically be expanded and shown to users. -When set to False (the default value) these options will be available, but the user will have to display the list of options for themselves. +If set to True (the default value), users joining a meeting by using a client application other than Skype for Business will see a link that points them toward a download for Skype for Business Web App. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -628,15 +706,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWsFedPassiveAuth -When set to True, allows for passive authentication: authentication of users by using URL redirection or smart linking. -The default value is False ($False). +### -ShowJoinUsingLegacyClientLink + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +If set to True, users joining a meeting by using a client application other than Skype for Business will be given the opportunity to join the meeting by using their current client application. +The default value is False. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -645,14 +728,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WsFedPassiveMetadataUri -URI used by the WS-federation Web requestor protocol. +### -TrustedCACerts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of certificates representing certificate chains trusted by the Web server. +New certificates added to the collection must be created using the `New-CsWebTrustedCACertificate` cmdlet. + +This collection is not used if the InferCertChainFromSSL property is set to True. ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -661,20 +749,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CrossDomainAuthorizationList -Collection of domains allowed to host web applications that send cross-domain scripting requests to the Skype for Business Server deployment. +### -UseCertificateAuth -Domains to be added to the list must be created using the `New-CsWebOrigin` cmdlet and then added to the new collection of Web service configuration settings. -Domain names must be prefaced using the http: or the https: prefix. -See Example 3 of this help topic for more information. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter was introduced in the February, 2013 release of Lync Server 2013. +When set to True (the default value), clients can be authenticated using certificates. +Set this value to False ($False) to disable certificate authentication. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -683,14 +768,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMediaBasicAuth -PARAMVALUE: $true | $false +### -UseDomainAuthInLWA + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, domain authentication can be employed as a way to authenticate Skype for Business Web App users. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -699,15 +786,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableStatisticsInResponse -When set to True ($True) the X-MS-WebInfraStats header is included in all HTTP responses. -The default value is False ($False). +### -UsePinAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), clients can be authenticated using personal identification numbers (PINs). +Set this value to False ($False) to disable PIN authentication. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -716,16 +805,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HstsMaxAgeInSeconds -Specifies the time in seconds of the max-age setting in the Strict-Transport-Security (STS) header of an HTTPS response. -A negative value will suppress the STS header in the HTTPS response. -The default is 315,360,000 (one year.) +### -UseWebClientLegacyUI + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +If true ($True), then the legacy web interface is presented to the client. +If false ($False), the standard web interface is used. +The default is false. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -734,16 +825,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PendingGetWaitTimeOutInMinutes -Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. -The value can be specified in between 5 to 15 minutes (both inclusive). -The default value is 15 minutes. +### -UseWindowsAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines how (and if) users will be authenticated using Windows authentication; that is, using the same credentials they used when they logged on to Windows. +Valid values are: + +Negotiate - The client and server will work together to determine the proper authentication protocol (either Kerberos or NTLM). + +NTLM - Windows authentication will be allowed, but only using the NTLM protocol. + +None - Windows authentication will not be allowed. ```yaml -Type: Int64 +Type: UseWindowsAuth Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -752,20 +850,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PendingGetWaitSupportingApps -Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. -Supported applications are Android, iPhone, iPad, Macintosh, Windows. -To support all applications you can give All as input. -For example: -- To support Android and Macintosh - Android;Macintosh; -- To support all devices - All; -The default value is None. +### -UseWsFedPassiveAuth + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, allows for passive authentication: authentication of users by using URL redirection or smart linking. +The default value is False ($False). ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -774,36 +869,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MobilePreferredAuthType -Specifies the preferred authentication type to be used by mobile applications. -If an unsupported method is specified, the web ticket service will not start and an event will be logged by the Skype for Business Server. -Accepted values for the MobilePreferredAuthType parameter are: - -None - -OAuth - -WebTicketServiceAnon - -WebTicketServiceWinNegotiate - -WebTicketServiceWinNtlm - -WebTicketServiceCert - -WebTicketServicePin - -WsFedPassive +### -WsFedPassiveMetadataUri -WsFedBearer +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -WebTicketServiceAuth +URI used by the WS-federation Web requestor protocol. ```yaml -Type: MobilePreferredAuthType +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -812,14 +887,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDomainAuthInLWA -When set to True, domain authentication can be employed as a way to authenticate Skype for Business Web App users. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -828,16 +905,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWebClientLegacyUI -If true ($True), then the legacy web interface is presented to the client. -If false ($False), the standard web interface is used. -The default is false. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -851,14 +928,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsWebServiceConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### -The `New-CsWebServiceConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings ## NOTES diff --git a/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md b/skype/skype-ps/SkypeForBusiness/New-CsWebTrustedCACertificate.md similarity index 91% rename from skype/skype-ps/skype/New-CsWebTrustedCACertificate.md rename to skype/skype-ps/SkypeForBusiness/New-CsWebTrustedCACertificate.md index 1ae3b83bb3..6733384478 100644 --- a/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebTrustedCACertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cswebtrustedcacertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsWebTrustedCACertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cswebtrustedcacertificate +schema: 2.0.0 +title: New-CsWebTrustedCACertificate --- # New-CsWebTrustedCACertificate @@ -37,7 +38,7 @@ In most cases, the CA that issued the default certificate will be the only certi ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = New-CsWebTrustedCACertificate -Thumbprint "D543DFF74FEEA425162FD25F342786F1AB453BB3" -CAStore TrustedRootCA @@ -55,18 +56,23 @@ The parameter value ${Add=$x} tells the cmdlet to add the certificate stored in ## PARAMETERS -### -Thumbprint -Thumbprint of the certificate which should be trusted by Lync Phone Edition. -You can retrieve certificate issuer and thumbprint values by running this command: +### -CAStore -`Get-CsCertificate | Select-Object Issuer, Thumbprint` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the name of the certificate store (on the local computer) where the certificate is stored. +Valid values are: + +TrustedRootCA +IntermediateCA + +ThirdPartyRootCA ```yaml -Type: String +Type: CAStore Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -75,21 +81,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CAStore -Indicates the name of the certificate store (on the local computer) where the certificate is stored. -Valid values are: +### -Thumbprint -TrustedRootCA +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -IntermediateCA +Thumbprint of the certificate which should be trusted by Lync Phone Edition. +You can retrieve certificate issuer and thumbprint values by running this command: + +`Get-CsCertificate | Select-Object Issuer, Thumbprint` -ThirdPartyRootCA ```yaml -Type: CAStore +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -103,13 +108,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsWebTrustedCACertificate` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Web.CACertID The `New-CsWebTrustedCACertificate` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.CACertID object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/New-CsXmppAllowedPartner.md similarity index 88% rename from skype/skype-ps/skype/New-CsXmppAllowedPartner.md rename to skype/skype-ps/SkypeForBusiness/New-CsXmppAllowedPartner.md index 3143cc1192..2932966534 100644 --- a/skype/skype-ps/skype/New-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsXmppAllowedPartner.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: New-CsXmppAllowedPartner -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csxmppallowedpartner +schema: 2.0.0 +title: New-CsXmppAllowedPartner --- # New-CsXmppAllowedPartner @@ -50,7 +51,7 @@ Skype for Business Server Control Panel: To create a new XMPP allowed partner us ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsXmppAllowedPartner -Identity "contoso.com" -PartnerType "PublicVerified" ``` @@ -59,7 +60,7 @@ The command shown in Example 1 creates a new XMPP allowed partner: contoso.com. In this example, the PartnerType property is set to "PublicVerified". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsXmppAllowedPartner -Identity "fabrikam.com" -AdditionalDomains "research.fabrikam2.com" ``` @@ -70,53 +71,10 @@ In addition to the root domain (fabrikam.com), the AdditionalDomains property is ## PARAMETERS -### -Domain -Primary domain of the XMPP allowed partner; for example: - -`-Domain "fabrikam.com"` - -You can specify the primary domain by using either the Domain parameter or the Identity parameter. -However, you cannot use both parameters in the same command. - -Additional domains can be specified by using the AdditionalDomains parameter. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Primary domain of the XMPP allowed partner; for example: - -``-Identity "fabrikam.com"` - -You can specify the primary domain by using either the Identity parameter or the Domain parameter. -However, you cannot use both parameters in the same command. - -Additional domains can be specified by using the AdditionalDomains parameter. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -AdditionalDomains -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -AdditionalDomains Additional XMPP domains belonging to the allowed partner. Multiple domains can be specified by separated domain names by using commas; for example: @@ -125,8 +83,7 @@ Multiple domains can be specified by separated domain names by using commas; for ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -135,14 +92,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -ConnectionLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Specifies the maximum number of simultaneous connections allowed to a specific partner. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -151,14 +110,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionLimit -Specifies the maximum number of simultaneous connections allowed to a specific partner. +### -Description + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Enables administrators to provide additional text regarding the XMPP allowed partner. +For example, the Description might include contact information for the partner. ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -167,17 +129,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide additional text regarding the XMPP allowed partner. -For example, the Description might include contact information for the partner. +### -Domain + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Primary domain of the XMPP allowed partner; for example: + +`-Domain "fabrikam.com"` + +You can specify the primary domain by using either the Domain parameter or the Identity parameter. +However, you cannot use both parameters in the same command. + +Additional domains can be specified by using the AdditionalDomains parameter. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -185,6 +155,9 @@ Accept wildcard characters: False ``` ### -EnableKeepAlive + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates whether or not the XMPP partner should periodically transmit "keep alive" packets in order to verify that the connection is still active. The default value is True. @@ -192,8 +165,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -203,13 +175,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -218,15 +192,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Primary domain of the XMPP allowed partner; for example: + +``-Identity "fabrikam.com"` + +You can specify the primary domain by using either the Identity parameter or the Domain parameter. +However, you cannot use both parameters in the same command. + +Additional domains can be specified by using the AdditionalDomains parameter. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -236,6 +237,9 @@ Accept wildcard characters: False ``` ### -PartnerType + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies the relationship between Skype for Business Server and the XMPP partner. Allowed values are: @@ -251,8 +255,7 @@ The default value is PublicUnverified. ```yaml Type: PartnerType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -262,13 +265,15 @@ Accept wildcard characters: False ``` ### -ProxyFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full qualified domain name of the proxy server used by the XMPP partner. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -278,6 +283,9 @@ Accept wildcard characters: False ``` ### -SaslNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates support for the Simple Authentication and Security Layer protocol, a protocol used for server authentication. Allowed values are: @@ -294,8 +302,7 @@ The default value is Required. ```yaml Type: SaslNegotiation Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -305,6 +312,9 @@ Accept wildcard characters: False ``` ### -SupportDialbackNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates whether dialback negotiation will be supported. With dialback negotiation, when Server A contacts Server B communication is not immediately established. Instead, Server B first attempts to verify the identity of Server A by contacting the authoritative DNS server for the domain that Server A claims to be from. @@ -318,8 +328,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -329,6 +338,9 @@ Accept wildcard characters: False ``` ### -TlsNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates support for the Transport Layer Security protocol, a protocol used to encrypt server-to-server data streams. Allowed values are: @@ -343,8 +355,25 @@ NotSupported (TLS negotiation will not be support The default value is Required. ```yaml Type: TlsNegotiation Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -354,13 +383,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -374,13 +405,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsXmppAllowedPartner` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner The `New-CsXmppAllowedPartner` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Publish-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Publish-CsLisConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Publish-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Publish-CsLisConfiguration.md index a3a95573fd..0a76f4c99a 100644 --- a/skype/skype-ps/skype/Publish-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Publish-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/publish-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Publish-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/publish-cslisconfiguration +schema: 2.0.0 +title: Publish-CsLisConfiguration --- # Publish-CsLisConfiguration @@ -33,7 +34,7 @@ The configuration can be removed from the Central Management store by calling th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Publish-CsLisConfiguration ``` @@ -44,13 +45,15 @@ This command commits the LIS configuration to the Central Management store. ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +Aliases: Required: False Position: Named @@ -59,14 +62,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -75,14 +80,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -96,12 +103,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Publish-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Publish-CsTopology.md similarity index 86% rename from skype/skype-ps/skype/Publish-CsTopology.md rename to skype/skype-ps/SkypeForBusiness/Publish-CsTopology.md index a947773c93..e708f35eeb 100644 --- a/skype/skype-ps/skype/Publish-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Publish-CsTopology.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/publish-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Publish-CsTopology -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/publish-cstopology +schema: 2.0.0 +title: Publish-CsTopology --- # Publish-CsTopology @@ -55,7 +56,7 @@ After publishing the topology in this manner, you will then need to reconfigure ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` (Get-CsTopology -AsXml).ToString() \> C:\Topologies\Topology.xml @@ -69,23 +70,10 @@ To carry out these tasks, the first command in the example uses the `Get-CsTopol ## PARAMETERS -### -FileName -Full path to the XML file containing the new topology information. - -```yaml -Type: String -Parameter Sets: Filename -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -BackupFileName -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -BackupFileName Full path to the backup file automatically created when you run the `Publish-CsTopology` cmdlet. If this parameter is not specified, then the `Publish-CsTopology` cmdlet will create a backup file in your Temp folder (%temp%) similar to this: Publish-CsTopology-Backup-\[2010_10_01\]\[08_30_00\]. In that file name, 2010_10_01 represents the date that publication took place: year (2010), month (10) and day (01). @@ -95,8 +83,7 @@ In addition, 08_30_00 represents the time of day when publication took place: ho ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,14 +93,16 @@ Accept wildcard characters: False ``` ### -Document + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to publish an XML element rather than an XML file. This XML element must be configured as a System.XML.Linq.XElement object. ```yaml Type: XElement Parameter Sets: Document -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -122,37 +111,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -Fully qualified domain name (FQDN) of a global catalog server in your domain. -This parameter is not required if you are running the `Publish-CsTopology` cmdlet on a computer with an account in your domain. +### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Full path to the XML file containing the new topology information. ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filename +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -FinalizeUninstall + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Used only when uninstalling Skype for Business Server. After the Central Management Server has been removed, use `Publish-CsTopology` and the FinalizeUninstall parameter to publish an empty topology. +Among other things, this removes all the Active Directory entries for the Central Management Server. ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: Finalize +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -160,13 +150,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,15 +167,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\Publish_Topology.html"` +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of a global catalog server in your domain. +This parameter is not required if you are running the `Publish-CsTopology` cmdlet on a computer with an account in your domain. + ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -192,14 +187,38 @@ 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. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. + ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\Publish_Topology.html"` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -209,13 +228,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -224,18 +245,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FinalizeUninstall -Used only when uninstalling Skype for Business Server. After the Central Management Server has been removed, use `Publish-CsTopology` and the FinalizeUninstall parameter to publish an empty topology. -Among other things, this removes all the Active Directory entries for the Central Management Server. +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: Finalize -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -247,14 +268,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Publish-CsTopology` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Publish-CsTopology` cmdlet publishes instances of the Microsoft.Rtc.Management.Deploy.Internal.DefaultTopology object. ## NOTES diff --git a/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Register-CsHybridPSTNAppliance.md similarity index 89% rename from skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md rename to skype/skype-ps/SkypeForBusiness/Register-CsHybridPSTNAppliance.md index 9dcace377f..8dea417205 100644 --- a/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Register-CsHybridPSTNAppliance.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/register-cshybridpstnappliance applicable: Skype for Business Online -title: Register-CsHybridPSTNAppliance -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/register-cshybridpstnappliance +schema: 2.0.0 +title: Register-CsHybridPSTNAppliance --- # Register-CsHybridPSTNAppliance @@ -37,7 +39,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Insert example commands for example 1. ``` @@ -47,14 +49,18 @@ Insert descriptive text for example 1. ## PARAMETERS -### -MediationServerFqdn -Mediation Server FQDN of this Skype for Business Cloud Connector Edition appliance. +### -Force + +> Applicable: Skype for Business Online + +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: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -63,14 +69,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MediationServerIPAddress -Mediation Server IP address of this Skype for Business Cloud Connector Edition appliance. +### -InMemory + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -79,14 +87,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Name of Skype for Business Cloud Connector Edition appliance. +### -MediationServerFqdn + +> Applicable: Skype for Business Online + +Mediation Server FQDN of this Skype for Business Cloud Connector Edition appliance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -95,14 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteName -Name of Skype for Business Cloud Connector Edition site that the appliance belongs to. +### -MediationServerIPAddress + +> Applicable: Skype for Business Online + +Mediation Server IP address of this Skype for Business Cloud Connector Edition appliance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -111,14 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Name + +> Applicable: Skype for Business Online + +Name of Skype for Business Cloud Connector Edition appliance. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -127,16 +141,16 @@ 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. +### -SiteName + +> Applicable: Skype for Business Online + +Name of Skype for Business Cloud Connector Edition site that the appliance belongs to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -145,14 +159,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -PARAMVALUE: SwitchParameter +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -161,14 +177,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -178,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAVEdgeConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAVEdgeConfiguration.md index 37d8b834d3..1ab68fc50c 100644 --- a/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAVEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAVEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csavedgeconfiguration +schema: 2.0.0 +title: Remove-CsAVEdgeConfiguration --- # Remove-CsAVEdgeConfiguration @@ -37,7 +38,7 @@ Instead, the properties contained within the global collection will all be reset ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsAVEdgeConfiguration -Identity site:Redmond ``` @@ -46,7 +47,7 @@ The command shown in Example 1 removes the A/V Edge configuration settings that After the settings are removed, A/V Edge servers in the Redmond site will be governed by the global configuration settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAVEdgeConfiguration -Filter "service:*" | Remove-CsAVEdgeConfiguration ``` @@ -56,7 +57,7 @@ To do this, the command first calls the `Get-CsAVEdgeConfiguration` cmdlet along This filtered collection is then piped to the `Remove-CsAVEdgeConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAVEdgeConfiguration | Where-Object {$_.MaxBandwidthPerUserKB -lt 5000} | Remove-CsAVEdgeConfiguration ``` @@ -69,7 +70,28 @@ The filtered collection is then piped to the `Remove-CsAVEdgeConfiguration` cmdl ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of A/V Edge configuration settings to be removed. To "remove" the global collection, use the following syntax: `-Identity global`. (As noted previously, the global settings cannot be removed; the properties can only be reset to their default values.) To remove a site collection, use syntax similar to this: `-Identity site:Redmond`. @@ -82,8 +104,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -92,14 +113,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -109,29 +132,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -145,14 +154,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings + The `Remove-CsAVEdgeConfiguration` cmdlet accepts pipelined input of media relay settings objects. These objects retrieved by running the Get-CsAVEdgeConfiguration cmdlet. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings The `Remove-CsAVEdgeConfiguration` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. diff --git a/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAdditionalInternalDomain.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAdditionalInternalDomain.md index 9840f5844b..3459b55f9f 100644 --- a/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAdditionalInternalDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAdditionalInternalDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csadditionalinternaldomain +schema: 2.0.0 +title: Remove-CsAdditionalInternalDomain --- # Remove-CsAdditionalInternalDomain @@ -31,7 +32,7 @@ domains. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ```powershell Remove-CsAdditionalInternalDomain -Identity fabrikam.com ``` @@ -40,30 +41,16 @@ Example 1 removes the additional internal domain with the Identity fabrikam.com. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -73,13 +60,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) for the new additional internal domain. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -88,14 +77,34 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the 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 + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -120,6 +129,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain?view=skype-ps) +[New-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csadditionalinternaldomain?view=skype-ps) -[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) +[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadditionalinternaldomain?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookConfiguration.md index 6462ca6564..882fcda3cc 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAddressBookConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csaddressbookconfiguration +schema: 2.0.0 +title: Remove-CsAddressBookConfiguration --- # Remove-CsAddressBookConfiguration @@ -44,7 +45,7 @@ Instead, running the `Remove-CsAddressBookConfiguration` cmdlet against the glob ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsAddressBookConfiguration -Identity site:Redmond ``` @@ -53,7 +54,7 @@ In this example, the `Remove-CsAddressBookConfiguration` cmdlet is used to delet Using the Identity parameter ensures that only the specified Address Book settings will be removed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookConfiguration -Filter site:* | Remove-CsAddressBookConfiguration ``` @@ -63,7 +64,7 @@ To do this, the `Get-CsAddressBookConfiguration` cmdlet is used to retrieve a co The retrieved collection is then piped to the `Remove-CsAddressBookConfiguration` cmdlet, which removes all the items in that collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookConfiguration | Where-Object {$_.KeepDuration -lt 30.} | Remove-CsAddressBookConfiguration ``` @@ -76,7 +77,28 @@ This collection is then piped to the `Where-Object` cmdlet, which selects only t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Address Book configuration settings to be removed. To remove the global collection, use the following syntax: `-Identity global`. (When you "remove" the global settings you simply reset all the properties to their default values.) To remove a site collection, use syntax similar to this: `-Identity site:Redmond`. @@ -85,8 +107,7 @@ Note that you cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -95,14 +116,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -112,29 +135,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -148,13 +157,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings The `Remove-CsAddressBookConfiguration` cmdlet accepts pipelined input of Address Book configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings The `Remove-CsAddressBookConfiguration` cmdlet does not return a value or object. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. diff --git a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationConfiguration.md index 5aa40f5cda..5c84425888 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAddressBookNormalizationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csaddressbooknormalizationconfiguration +schema: 2.0.0 +title: Remove-CsAddressBookNormalizationConfiguration --- # Remove-CsAddressBookNormalizationConfiguration @@ -38,7 +39,7 @@ That means, in some cases, you might need to create identical rules: one for ass ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsAddressBookNormalizationConfiguration -Identity "site:Redmond" ``` @@ -47,7 +48,7 @@ The command shown in Example 1 deletes the Address Book normalization configurat After this collection has been deleted, Address Book servers in the Redmond site will use the global configuration settings to handle phone number normalization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookNormalizationConfiguration -Filter "site:*" | Remove-CsAddressBookNormalizationConfiguration ``` @@ -60,7 +61,28 @@ When this command completes, the deployment will be limited to the global collec ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Address Book configuration settings to be removed. For example: `-Identity "site:Redmond"` @@ -69,8 +91,7 @@ Note that you cannot use wildcards when specifying the collection to be removed. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -80,13 +101,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -95,30 +118,16 @@ 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: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -132,13 +141,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings The `Remove-CsAddressBookNormalizationConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsAddressBookNormalizationConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationRule.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationRule.md index b1f7133ca9..b48ff0a503 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAddressBookNormalizationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csaddressbooknormalizationrule +schema: 2.0.0 +title: Remove-CsAddressBookNormalizationRule --- # Remove-CsAddressBookNormalizationRule @@ -32,7 +33,7 @@ That means, in some cases, you might need to create identical rules: one for ass ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsAddressBookNormalizationRule -Identity "Global/Generic_All" ``` @@ -40,7 +41,7 @@ Remove-CsAddressBookNormalizationRule -Identity "Global/Generic_All" The command shown in Example 1 removes the Generic_All normalization rule from the global collection of Address Book normalization rules. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookNormalizationRule -Identity "site:Redmond" | Remove-CsAddressBookNormalizationRule ``` @@ -51,7 +52,7 @@ Those rules are then piped to and deleted by, the `Remove-CsAddressBookNormaliza When the command finishes running the normalization rules collection for the Redmond site will still exist, but the collection will no longer contain any rules. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookNormalizationRule | Where-Object {$_.Pattern -eq "E164"} | Remove-CsAddressBookNormalizationRule ``` @@ -64,15 +65,35 @@ Any rules that meet that criterion are then piped to the `Remove-CsAddressBookNo ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the rule being removed. The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -82,13 +103,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -97,30 +120,16 @@ 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: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -134,13 +143,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated The `Remove-CsAddressBookNormalizationRule` cmdlet accepts pipelined input of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated Instead, the `Remove-CsAddressBookNormalizationRule` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAdminRole.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsAdminRole.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAdminRole.md index 0902573360..b427334395 100644 --- a/skype/skype-ps/skype/Remove-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAdminRole.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAdminRole -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csadminrole +schema: 2.0.0 +title: Remove-CsAdminRole --- # Remove-CsAdminRole @@ -103,7 +104,7 @@ To avoid these confirmation prompts, use the Confirm parameter and set the param ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsAdminRole -Identity "RedmondHelpDesk" ``` @@ -111,7 +112,7 @@ Remove-CsAdminRole -Identity "RedmondHelpDesk" The command shown in Example 1 deletes the RBAC role with the Identity RedmondHelpDesk. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Remove-CsAdminRole -Filter "*Redmond*" ``` @@ -119,7 +120,7 @@ Remove-CsAdminRole -Filter "*Redmond*" Example 2 deletes all of the RBAC roles that have the string value "Redmond" somewhere in their Identity. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAdminRole | Where-Object {$_.IsStandardRole -eq $False} | Remove-CsAdminRole ``` @@ -133,33 +134,35 @@ In turn, those custom roles are piped to and deleted by, the `Remove-CsAdminRole ## PARAMETERS -### -Identity -Unique identifier for the RBAC role to be deleted. -The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. -For example, the Help Desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards in order to specify the custom RBAC roles to be removed. +For example, to remove all the custom roles that include the string value "Redmond" in their Identity, you can use this syntax: `-Filter "*Redmond*"`. ```yaml Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: Filter +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards in order to specify the custom RBAC roles to be removed. -For example, to remove all the custom roles that include the string value "Redmond" in their Identity, you can use this syntax: `-Filter "*Redmond*"`. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -168,7 +171,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the RBAC role to be deleted. +The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. +For example, the Help Desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Sid + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use a Security Identifier (SID) to specify the RBAC role to be deleted. SIDs are assigned by Skype for Business Server at the time that the RBAC role is created and look similar to this: S-1-5-21-1573807623-1597889489-1765977225-1145. The SID for a given RBAC role can be retrieved by using the `Get-CsAdminRole` cmdlet. @@ -177,8 +203,7 @@ The SID for a given RBAC role can be retrieved by using the `Get-CsAdminRole` cm ```yaml Type: String Parameter Sets: SID -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -187,30 +212,19 @@ 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. +### -Confirm -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Enables you to bypass the confirmation prompt that appears when you try to delete an RBAC role. +To bypass the prompt, include the Confirm parameter and set the parameter value to $False: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`Remove-CsAdminRole RedmondAdministrators -Confirm:$False` ```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 +Aliases: cf Required: False Position: Named @@ -219,17 +233,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Enables you to bypass the confirmation prompt that appears when you try to delete an RBAC role. -To bypass the prompt, include the Confirm parameter and set the parameter value to $False: +### -WhatIf -`Remove-CsAdminRole RedmondAdministrators -Confirm:$False` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -243,13 +256,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The `Remove-CsAdminRole` cmdlet accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Roles.Role The `Remove-CsAdminRole` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Roles.Role object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAllowedDomain.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsAllowedDomain.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAllowedDomain.md index 369b896c1d..49d8195faa 100644 --- a/skype/skype-ps/skype/Remove-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAllowedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAllowedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csalloweddomain +schema: 2.0.0 +title: Remove-CsAllowedDomain --- # Remove-CsAllowedDomain @@ -44,7 +45,7 @@ Note that a domain cannot simultaneously appear on both the allowed and the bloc ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsAllowedDomain -Identity fabrikam.com ``` @@ -52,7 +53,7 @@ Remove-CsAllowedDomain -Identity fabrikam.com The command shown in Example 1 removes the domain fabrikam.com from the list of allowed domains. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAllowedDomain -Filter *fabrikam* | Remove-CsAllowedDomain ``` @@ -62,7 +63,7 @@ To do this, the command first uses the `Get-CsAllowedDomain` cmdlet and the Filt That filtered collection is then piped to the `Remove-CsAllowedDomain` cmdlet, which, in turn, removes all of the items in the filtered collection from the list of allowed domains. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAllowedDomain | Where-Object {$_.ProxyFqdn -eq $Null} | Remove-CsAllowedDomain ``` @@ -73,7 +74,7 @@ That collection is piped to the `Where-Object` cmdlet, which picks out only thos The filtered collection is then piped to the `Remove-CsAllowedDomain` cmdlet, which removes each domain in the collection from the allowed list. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsAllowedDomain | Where-Object {$_.Comment -match "Ken Myer"} | Remove-CsAllowedDomain ``` @@ -86,15 +87,35 @@ This filtered collection is then piped to the `Remove-CsAllowedDomain` cmdlet, w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the domain to be removed from the allowed list; for example, fabrikam.com. You cannot use wildcards when specifying a domain Identity. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,14 +124,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -120,29 +143,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -156,13 +165,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain The `Remove-CsAllowedDomain` cmdlet accepts pipelined instances of the allowed domain object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain Deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAnalogDevice.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsAnalogDevice.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAnalogDevice.md index 2934cae81d..18c7691e40 100644 --- a/skype/skype-ps/skype/Remove-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAnalogDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAnalogDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csanalogdevice +schema: 2.0.0 +title: Remove-CsAnalogDevice --- # Remove-CsAnalogDevice @@ -42,7 +43,7 @@ Additionally, the contact object associated with that device will be deleted fro ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsAnalogDevice -Identity "CN={e5e7daba-394e-46ec-95a1-1f2a9947aad2},CN=Users,DC=litwareinc,DC=com" ``` @@ -50,7 +51,7 @@ Remove-CsAnalogDevice -Identity "CN={e5e7daba-394e-46ec-95a1-1f2a9947aad2},CN=Us Example 1 deletes the analog device that has the Identity CN={e5e7daba-394e-46ec-95a1-1f2a9947aad2},CN=Users,DC=litwareinc,DC=com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAnalogDevice -Filter {DisplayName -eq "Building 14 Receptionist"} | Remove-CsAnalogDevice ``` @@ -60,7 +61,7 @@ To carry out this task, the command first calls the `Get-CsAnalogDevice` cmdlet The returned items are then piped to and removed by, the `Remove-CsAnalogDevice` cmdlet. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAnalogDevice -Filter {VoicePolicy -eq "RedmondVoicePolicy"} | Remove-CsAnalogDevice ``` @@ -70,7 +71,7 @@ To do this, the `Get-CsAnalogDevice` cmdlet and the Filter parameter are used to The filtered collection is then piped to the `Remove-CsAnalogDevice` cmdlet, which deletes each item in that collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsAnalogDevice -Filter {AnalogFax -eq $True} | Remove-CsAnalogDevice ``` @@ -83,6 +84,9 @@ In turn, this filtered collection is piped to the `Remove-CsAnalogDevice` cmdlet ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the analog device to be removed. Analog devices are identified by using the Active Directory distinguished name (DN) of the associated contact object. By default, these devices, use a globally unique identifier (GUID) as their common name; that means analog devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. @@ -92,8 +96,7 @@ Because of that you might find it easier to retrieve analog devices by using the ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -102,14 +105,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -118,14 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -139,13 +146,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact + The `Remove-CsAnalogDevice` cmdlet accepts pipelined instances of the analog device object. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact The `Remove-CsAnalogDevice` cmdlet deletes existing instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAnnouncement.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsAnnouncement.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAnnouncement.md index b51ed922b3..bcc1e36145 100644 --- a/skype/skype-ps/skype/Remove-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAnnouncement.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAnnouncement -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csannouncement +schema: 2.0.0 +title: Remove-CsAnnouncement --- # Remove-CsAnnouncement @@ -38,7 +39,7 @@ However, the AnnouncementId property value (the GUID of the Announcement that wa ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsAnnouncement -Identity "ApplicationServer:Redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90" ``` @@ -47,7 +48,7 @@ Example 1 removes the announcement that has the Identity "ApplicationServer:Redm Because Identities must be unique, this command will remove, at most, a single announcement. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Remove-CsAnnouncement -Identity "ApplicationServer:Redmond.litwareinc.com" ``` @@ -59,7 +60,28 @@ Specifying the parameter value "ApplicationServer:Redmond.litwareinc.com" (witho ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the Announcement you want to remove. The value for the Identity parameter can be supplied in one of two ways: @@ -69,8 +91,7 @@ The value for the Identity parameter can be supplied in one of two ways: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -79,14 +100,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -96,29 +119,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -132,12 +141,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement Deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsArchivingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsArchivingConfiguration.md index cd4dcbd64d..4af1375389 100644 --- a/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsArchivingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csarchivingconfiguration +schema: 2.0.0 +title: Remove-CsArchivingConfiguration --- # Remove-CsArchivingConfiguration @@ -50,7 +51,7 @@ In turn, that will disable archiving at the global scope. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsArchivingConfiguration -Identity site:Redmond ``` @@ -58,7 +59,7 @@ Remove-CsArchivingConfiguration -Identity site:Redmond Example 1 uses the `Remove-CsArchivingConfiguration` cmdlet to delete the archiving configuration settings with the identity site:Redmond. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingConfiguration -Filter "site:*" | Remove-CsArchivingConfiguration ``` @@ -69,7 +70,7 @@ This is done by using the filter value "site:*", which limits the returned data The filtered collection is then piped to the `Remove-CsArchivingConfiguration` cmdlet, which deletes each item in that collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -eq "None"} | Remove-CsArchivingConfiguration ``` @@ -82,7 +83,28 @@ The filtered collection is then piped to the `Remove-CsArchivingConfiguration` c ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of archiving configuration settings to be removed. To remove the global collection, use the following syntax: `-Identity global`. (Note that you cannot actually remove the global settings; instead, you can only reset the properties to their default values.) To remove a site collection, use syntax similar to this: `-Identity site:Redmond`. @@ -98,8 +120,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -108,14 +129,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -125,29 +148,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -161,13 +170,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings + The `Remove-CsArchivingConfiguration` cmdlet accepts pipelined input of archiving configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings The `Remove-CsArchivingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object. diff --git a/skype/skype-ps/skype/Remove-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingPolicy.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsArchivingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsArchivingPolicy.md index aad1e6bdd9..806ac5cc4e 100644 --- a/skype/skype-ps/skype/Remove-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsArchivingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csarchivingpolicy +schema: 2.0.0 +title: Remove-CsArchivingPolicy --- # Remove-CsArchivingPolicy @@ -55,7 +56,7 @@ That's because the default value for both these properties (ArchiveInternal and ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsArchivingPolicy -Identity site:Redmond ``` @@ -64,7 +65,7 @@ In Example 1, the `Remove-CsArchivingPolicy` cmdlet is used to delete the policy Note that, when a policy configured at the site scope is deleted, users previously managed by the site policy will automatically be governed by the global archiving policy instead. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingPolicy -Filter site:* | Remove-CsArchivingPolicy ``` @@ -75,7 +76,7 @@ This is done by using the filter value "site:*", which instructs the `Get-CsArch After the collection has been returned, the data is piped to the `Remove-CsArchivingPolicy` cmdlet, which deletes all the policies in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsArchivingPolicy | Where-Object {$_.ArchiveExternal -eq $False} | Remove-CsArchivingPolicy ``` @@ -88,7 +89,32 @@ The filtered collection is then passed to the `Remove-CsArchivingPolicy` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one use. +If this parameter is not present, then the `Remove-CsArchivingPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. +Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. +You must answer yes (by pressing the Y key) before the command will continue and the policy will be removed. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the archiving policy to be removed. Archiving policies can be configured at the global, site, or per-user scopes. To remove the global policy, use this syntax: `-Identity global`. @@ -103,8 +129,7 @@ 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -113,34 +138,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one use. -If this parameter is not present, then the `Remove-CsArchivingPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. -Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. -You must answer yes (by pressing the Y key) before the command will continue and the policy will be removed. +### -Tenant +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the archiving policy is being removed. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,13 +164,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -165,21 +181,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the archiving policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -193,13 +204,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy + The `Remove-CsArchivingPolicy` cmdlet accepts pipelined input of archiving policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy The `Remove-CsArchivingPolicy` cmdlet does not return a value or object. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy object. diff --git a/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAutodiscoverConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAutodiscoverConfiguration.md index 28d818613b..b651dcb0fb 100644 --- a/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAutodiscoverConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csautodiscoverconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAutodiscoverConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csautodiscoverconfiguration +schema: 2.0.0 +title: Remove-CsAutodiscoverConfiguration --- # Remove-CsAutodiscoverConfiguration @@ -49,7 +50,7 @@ In that case, however, the global settings will not be removed; however, any Aut ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsAutoDiscoverConfiguration -Identity "site:Redmond" ``` @@ -57,7 +58,7 @@ Remove-CsAutoDiscoverConfiguration -Identity "site:Redmond" The command shown in Example 1 deletes the Autodiscover configuration settings for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoDiscoverConfiguration -Filter "site:*" | Remove-CsAutoDiscoverConfiguration ``` @@ -69,7 +70,28 @@ That filtered collection is then piped to the `Remove-CsAutoDiscoverConfiguratio ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the Autodiscover settings to be removed. Autodiscover settings can be configured at the global or the site scope. To "remove" the global policy, use this syntax: `-Identity global`. @@ -85,8 +107,7 @@ Note that wildcards are not allowed when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -96,13 +117,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -111,30 +134,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -148,14 +157,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration. +### Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration The `Remove-CsAutoDiscoverConfiguration` cmdlet accepts pipelined input of AutoDiscoverConfiguration objects ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBackupServiceConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsBackupServiceConfiguration.md index c6a0bc6cfc..f280ceb02e 100644 --- a/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBackupServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csbackupserviceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsBackupServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csbackupserviceconfiguration +schema: 2.0.0 +title: Remove-CsBackupServiceConfiguration --- # Remove-CsBackupServiceConfiguration @@ -35,7 +36,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsBackupServiceConfiguration -Identity "global" ``` @@ -46,7 +47,28 @@ Note that even though Skype for Business Server only uses a single, global colle ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the backup service configuration settings. Although you can only have a single, global instance of these settings, you still need to specify an Identity when calling the `Remove-CsBackupServiceConfiguration` cmdlet: @@ -56,8 +78,7 @@ Although you can only have a single, global instance of these settings, you stil ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -67,13 +88,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -82,30 +105,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -119,13 +128,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration The `Remove-CsBackupServiceConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsBackupServiceConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBandwidthPolicyServiceConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsBandwidthPolicyServiceConfiguration.md index 41f3e9cac6..24e63a04d8 100644 --- a/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBandwidthPolicyServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsBandwidthPolicyServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csbandwidthpolicyserviceconfiguration +schema: 2.0.0 +title: Remove-CsBandwidthPolicyServiceConfiguration --- # Remove-CsBandwidthPolicyServiceConfiguration @@ -34,7 +35,7 @@ You can also use the cmdlet to "remove" the global bandwidth policy service; how ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond ``` @@ -42,7 +43,7 @@ Remove-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond This example removes the bandwidth policy service configuration defined for the Redmond site (-Identity site:Redmond). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsBandwidthPolicyServiceConfiguration | Where-Object {$_.EnableLogging -eq $False} | Remove-CsBandwidthPolicyServiceConfiguration ``` @@ -57,15 +58,35 @@ This collection is then piped to the `Remove-CsBandwidthPolicyServiceConfigurati ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the configuration you want to remove. This identifier will consist of the scope (for the global configuration) or the scope and name (for a site-level configuration, such as site:Redmond). ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,14 +95,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -91,29 +114,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -127,13 +136,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration + Accepts pipelined input of bandwidth policy service configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration. diff --git a/skype/skype-ps/skype/Remove-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBlockedDomain.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsBlockedDomain.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsBlockedDomain.md index 29b6a48035..3fa9d1468b 100644 --- a/skype/skype-ps/skype/Remove-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBlockedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsBlockedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csblockeddomain +schema: 2.0.0 +title: Remove-CsBlockedDomain --- # Remove-CsBlockedDomain @@ -45,7 +46,7 @@ A domain cannot simultaneously appear on both the allowed and the blocked lists. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsBlockedDomain -Identity fabrikam.com ``` @@ -54,7 +55,7 @@ The command shown in Example 1 removes the domain fabrikam.com from the list of This is done by calling the `Remove-CsBlockedDomain` cmdlet and specifying the domain with the Identity "fabrikam.com". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsBlockedDomain -Filter *fabrikam* | Remove-CsBlockedDomain ``` @@ -64,7 +65,7 @@ To do this, the `Get-CsBlockedDomain` cmdlet and the Filter parameter are first That collection is then piped to the `Remove-CsBlockedDomain` cmdlet, which deletes each item in the collection from the list of blocked domains. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsBlockedDomain | Remove-CsBlockedDomain ``` @@ -77,15 +78,35 @@ The net result: no domains will be left on the blocked domain list. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the domain to be removed from the blocked list; for example, fabrikam.com. Note that you cannot use wildcards when specifying a domain Identity. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -94,14 +115,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -111,29 +134,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -147,13 +156,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain + The `Remove-CsBlockedDomain` cmdlet accepts pipelined instances of the blocked domain object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain Deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsBusyOptions.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBusyOptions.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsBusyOptions.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsBusyOptions.md index 3a462337d7..129298a72f 100644 --- a/skype/skype-ps/skype/Remove-CsBusyOptions.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBusyOptions.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsBusyOptions -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csbusyoptions +schema: 2.0.0 +title: Remove-CsBusyOptions --- # Remove-CsBusyOptions @@ -26,7 +27,7 @@ This cmdlet removes configuration information about Busy Options for a specific ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsBusyOptions -Identity "Ken Myer" ``` @@ -35,23 +36,10 @@ This example removes Busy Options for "Ken Myer". ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Identity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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". @@ -59,8 +47,7 @@ You can use the asterisk (*) wildcard character when using the display name as t ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 0 @@ -70,13 +57,33 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -86,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -93,7 +103,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -107,17 +116,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.AD.UserIdParameter object. +### Microsoft.Rtc.Management.AD.UserIdParameter + ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.BusyOptions.BusyOptions This cmdlet does not return any objects. ## NOTES ## RELATED LINKS -[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions?view=skype-ps) +[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbusyoptions?view=skype-ps) -[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) +[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCallParkOrbit.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsCallParkOrbit.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCallParkOrbit.md index c2fc47f998..8ac726c896 100644 --- a/skype/skype-ps/skype/Remove-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCallParkOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCallParkOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscallparkorbit +schema: 2.0.0 +title: Remove-CsCallParkOrbit --- # Remove-CsCallParkOrbit @@ -33,7 +34,7 @@ The freed numbers can then be used in a newly defined call park orbit. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCallParkOrbit -Identity "Redmond CPO 1" ``` @@ -41,7 +42,7 @@ Remove-CsCallParkOrbit -Identity "Redmond CPO 1" In this example, the `Remove-CsCallParkOrbit` cmdlet is used to delete the call park orbit range with the name Redmond CPO 1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCallParkOrbit | Remove-CsCallParkOrbit ``` @@ -51,7 +52,7 @@ The command first calls the `Get-CsCallParkOrbit` cmdlet with no parameters to r It then pipes that collection of call park orbit ranges to the `Remove-CsCallParkOrbit` cmdlet, which removes each call park orbit. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCallParkOrbit -Filter *Redmond* | Remove-CsCallParkOrbit ``` @@ -63,15 +64,35 @@ This collection is piped to the `Remove-CsCallParkOrbit` cmdlet, which removes e ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the call park orbit range. This name was assigned by the administrator when the call park orbit range was defined. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -80,14 +101,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -97,29 +120,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -133,13 +142,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit object. +### Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit + Accepts pipelined input of call park orbit objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit. diff --git a/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCallViaWorkPolicy.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCallViaWorkPolicy.md index 80f2007953..164657d59c 100644 --- a/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCallViaWorkPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCallViaWorkPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscallviaworkpolicy +schema: 2.0.0 +title: Remove-CsCallViaWorkPolicy --- # Remove-CsCallViaWorkPolicy @@ -28,7 +29,7 @@ Use this cmdlet to delete an existing call via work policy. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCallViaWorkPolicy -Identity CvWStandardPolicy ``` @@ -38,7 +39,28 @@ This example removes a per-user scoped policy named "CvWStandardPolicy". ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the identity of the policy to be removed. Call via work policies can be specified at the global, site, or per-user scope. @@ -51,8 +73,7 @@ Per-user syntax: `-Identity CallviaWorkStandard` ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -61,30 +82,16 @@ Accept pipeline input: True (ByPropertyName) 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 Server 2015, Skype for Business Server 2019 +### -Tenant -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -93,14 +100,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -110,13 +119,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -130,13 +141,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCdrConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsCdrConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCdrConfiguration.md index fd052dd951..a983e5d9ca 100644 --- a/skype/skype-ps/skype/Remove-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCdrConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCdrConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscdrconfiguration +schema: 2.0.0 +title: Remove-CsCdrConfiguration --- # Remove-CsCdrConfiguration @@ -47,7 +48,7 @@ If you run the `Remove-CsCdrConfiguration` cmdlet against the global settings, t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCdrConfiguration -Identity site:Redmond ``` @@ -56,7 +57,7 @@ Example 1 uses the `Remove-CsCdrConfiguration` cmdlet to remove the CDR settings Using the Identity parameter ensures that only the settings assigned to the specified site will be removed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCdrConfiguration -Filter site:* | Remove-CsCdrConfiguration ``` @@ -66,7 +67,7 @@ To do this, the command first uses the `Get-CsCdrConfiguration` cmdlet and the F The filtered collection is then piped to the `Remove-CsCdrConfiguration` cmdlet, which deletes all the items in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCdrConfiguration | Where-Object {$_.KeepCallDetailForDays -lt 30} | Remove-CsCdrConfiguration ``` @@ -79,7 +80,28 @@ The filtered collection is then piped to the `Remove-CsCdrConfiguration` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the CDR configuration settings to be removed. To "remove" the global settings, use this syntax: `-Identity global`. (Note, again, that you cannot actually remove the global settings; all you can do is reset the properties to their default values.) To remove settings from the site scope, use syntax similar to this: `-Identity site:Redmond`. @@ -88,8 +110,7 @@ You cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -98,14 +119,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -115,29 +138,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -151,14 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings. +### Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings The `Remove-CsCdrConfiguration` cmdlet accepts pipelined input of CDR configuration objects. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCertificate.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsCertificate.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCertificate.md index f66a9b06f6..e3513ed5d5 100644 --- a/skype/skype-ps/skype/Remove-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscertificate +schema: 2.0.0 +title: Remove-CsCertificate --- # Remove-CsCertificate @@ -40,7 +41,7 @@ Remove-CsCertificate -Type WebServicesExternal -Force ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsCertificate -Type WebServicesExternal ``` @@ -53,60 +54,54 @@ Remove-CsCertificate -Type WebServicesExternal -Force ## PARAMETERS -### -Type -Type of certificate to be deleted. -Certificate types include (but are not limited to): - -- AccessEdgeExternal - -- AudioVideoAuthentication - -- DataEdgeExternal - -- Default - -- External - -- Internal - -- PICWebService (Skype for Business Online only) +### -Force -- ProvisionService (Skype for Business Online only) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -- WebServicesExternal +Bypasses the confirmation prompt that typically occurs if you attempt to delete a certificate that is currently in use. -- WebServicesInternal +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -- WsFedTokenTransfer +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -For example, this syntax deletes the Default certificate: -Type Default. +### -Identity -You can delete multiple types in a single command by separating the certificate types with commas: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 --Type Internal,External,Default +When set to Global, removes the certificate from the global scope. +When not specified, certificates are removed from the local computer. ```yaml -Type: CertType[] +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -NetportId + +> Applicable: Lync Server 2010 + Reserved for future use. This parameter is for certificates dedicated to a specific port, a scenario not yet supported by Lync Server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -115,14 +110,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Bypasses the confirmation prompt that typically occurs if you attempt to delete a certificate that is currently in use. +### -Previous + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, removes the previously-assigned certificate instead of the currently-assigned certificate. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,16 +129,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to record detailed information about the procedures carried out by the `Remove-CsCertificate` cmdlet. -The parameter value should be the full path to the HTML file to be generated; for example: +The parameter value should be the full path to the HTML file to be generated; for example: -Report C:\Logs\Certificates.html. If the specified file already exists it will automatically be overwritten with the new information. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,14 +149,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Type + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of certificate to be deleted. +Certificate types include (but are not limited to): + +- AccessEdgeExternal + +- AudioVideoAuthentication + +- DataEdgeExternal + +- Default + +- External + +- Internal + +- PICWebService (Skype for Business Online only) + +- ProvisionService (Skype for Business Online only) + +- WebServicesExternal + +- WebServicesInternal + +- WsFedTokenTransfer + +For example, this syntax deletes the Default certificate: -Type Default. + +You can delete multiple types in a single command by separating the certificate types with commas: + +-Type Internal,External,Default ```yaml -Type: SwitchParameter +Type: CertType[] Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +197,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -182,31 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -When set to Global, removes the certificate from the global scope. -When not specified, certificates are removed from the local computer. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Previous -When specified, removes the previously-assigned certificate instead of the currently-assigned certificate. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -220,14 +237,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsCertificate` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsCertificate` cmdlet deletes instances of the Microsoft.Rtc.Management.Deployment.CertificateReference object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientPolicy.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsClientPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClientPolicy.md index dad1f49490..f90e1569d1 100644 --- a/skype/skype-ps/skype/Remove-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Remove-CsClientPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclientpolicy +schema: 2.0.0 +title: Remove-CsClientPolicy --- # Remove-CsClientPolicy @@ -39,7 +41,7 @@ However, all the properties in the global policy will be reset to their default ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClientPolicy -Identity SalesPolicy ``` @@ -47,7 +49,7 @@ Remove-CsClientPolicy -Identity SalesPolicy In Example 1, the `Remove-CsClientPolicy` cmdlet is used to delete the client policy that has the Identity SalesPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientPolicy -Filter "tag:*" | Remove-CsClientPolicy ``` @@ -57,7 +59,7 @@ The command uses the `Get-CsClientPolicy` cmdlet and the Filter parameter to ret The filtered collection is then piped to the `Remove-CsClientPolicy` cmdlet, which removes each policy in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientPolicy | Where-Object {$_.EnableAppearOffline -eq $True} | Remove-CsClientPolicy ``` @@ -70,7 +72,32 @@ In turn, this filtered collection is piped to the `Remove-CsClientPolicy` cmdlet ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one user. +If this parameter is not present, then the `Remove-CsClientPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. +Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. +You must answer yes (by pressing the Y key) before the command will continue and the policy will be removed. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -82,8 +109,7 @@ You cannot use wildcards when specifying a policy 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 +Aliases: Required: True Position: 2 @@ -92,34 +118,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one user. -If this parameter is not present, then the `Remove-CsClientPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. -Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. -You must answer yes (by pressing the Y key) before the command will continue and the policy will be removed. +### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```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 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client policy is being removed. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-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` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: Guid 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 +Aliases: Required: False Position: Named @@ -129,13 +145,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -144,22 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client 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: +### -WhatIf -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -173,13 +185,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy + The `Remove-CsClientPolicy` cmdlet accepts pipelined instances of the client policy object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy The `Remove-CsClientPolicy` cmdlet does not return a value. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. diff --git a/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionConfiguration.md index fee4af8bf2..5470a8ad36 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClientVersionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclientversionconfiguration +schema: 2.0.0 +title: Remove-CsClientVersionConfiguration --- # Remove-CsClientVersionConfiguration @@ -45,7 +46,7 @@ In that case, the global settings will not be removed; instead, the global prope ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsClientVersionConfiguration -Identity site:Redmond ``` @@ -53,7 +54,7 @@ Remove-CsClientVersionConfiguration -Identity site:Redmond The command shown in Example 1 deletes the client version configuration settings that have the Identity "site:Redmond". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsClientVersionConfiguration -Filter site:* | Remove-CsClientVersionConfiguration ``` @@ -63,7 +64,7 @@ To accomplish this task the command first calls the `Get-CsClientVersionConfigur This filtered collection is then piped to the `Remove-CsClientVersionConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsClientVersionConfiguration | Where-Object {$_.Enabled -eq $False} | Remove-CsClientVersionConfiguration ``` @@ -76,7 +77,28 @@ From there, the filtered collection is piped to the `Remove-CsClientVersionConfi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of client version configuration settings to be removed. To remove the global collection, use the following syntax: `-Identity global`. (Keep in mind that the global settings will not actually be removed; instead, the global properties will all be reset to their default values.) To remove a site collection, use syntax similar to this: `-Identity site:Redmond`. @@ -85,8 +107,7 @@ Note that you cannot use wildcards when specifying the Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -95,14 +116,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -112,29 +135,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -148,14 +157,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration + The `Remove-CsClientVersionConfiguration` cmdlet accepts pipelined instances of the client version configuration object. ## OUTPUTS -### -None. +### None Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicy.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsClientVersionPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicy.md index 73274296e7..17273cf9fe 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClientVersionPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclientversionpolicy +schema: 2.0.0 +title: Remove-CsClientVersionPolicy --- # Remove-CsClientVersionPolicy @@ -57,7 +58,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClientVersionPolicy -Identity site:Redmond ``` @@ -65,7 +66,7 @@ Remove-CsClientVersionPolicy -Identity site:Redmond The command shown in Example 1 deletes the client version policy for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientVersionPolicy -Filter tag:* | Remove-CsClientVersionPolicy ``` @@ -77,7 +78,28 @@ This filtered collection is then piped to the `Remove-CsClientVersionPolicy` cmd ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be deleted. To remove a policy configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. To remove a policy configured at the service scope, use syntax similar to this: `-Identity "Registrar:atl-cs-001.litwareinc.com"`. @@ -90,8 +112,7 @@ To remove per-user policies, use syntax similar to this: `-Identity "SalesDepart ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -100,30 +121,23 @@ 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. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy is being removed. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,13 +147,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -148,21 +164,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -176,13 +187,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy + The `Remove-CsClientVersionPolicy` cmdlet accepts pipelined instances of the client version policy object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy The `Remove-CsClientVersionPolicy` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicyRule.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicyRule.md index 9ab5db8977..a004c6d66a 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicyRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClientVersionPolicyRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclientversionpolicyrule +schema: 2.0.0 +title: Remove-CsClientVersionPolicyRule --- # Remove-CsClientVersionPolicyRule @@ -69,7 +70,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsClientVersionPolicyRule -Identity site:Redmond/74ba9211-8610-42f9-91ba-846cdee98820 ``` @@ -78,7 +79,7 @@ The command shown in Example 1 deletes the client version policy rule that has t Because Identities must be unique, this command will only delete, at most, a single rule. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsClientVersionPolicyRule -Filter "site:Redmond/*" | Remove-CsClientVersionPolicyRule ``` @@ -88,7 +89,7 @@ To do this, the command first calls the `Get-CsClientVersionPolicyRule` cmdlet a This filtered collection is then piped to the `Remove-CsClientVersionPolicyRule` cmdlet, which deletes each item in that collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsClientVersionPolicyRule | Where-Object {$_.Enabled -eq $False} | Remove-CsClientVersionPolicyRule ``` @@ -101,7 +102,28 @@ The filtered collection is then piped to the `Remove-CsClientVersionPolicyRule` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the client version policy rule to be removed. The Identity of a client version rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. @@ -109,8 +131,7 @@ That means that a rule will have an Identity similar to this: site:Redmond/1987d ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -119,30 +140,23 @@ 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. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy rule is being removed. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +166,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -167,21 +183,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy rule is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -195,14 +206,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule + The `Remove-CsClientVersionPolicyRule` cmdlet accepts pipelined instances of the client version rule object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsClientVersionPolicyRule` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsClsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClsConfiguration.md index 2e6f11933a..aea857c78e 100644 --- a/skype/skype-ps/skype/Remove-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclsconfiguration +schema: 2.0.0 +title: Remove-CsClsConfiguration --- # Remove-CsClsConfiguration @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClsConfiguration -Identity "site:Redmond" ``` @@ -55,7 +56,7 @@ Remove-CsClsConfiguration -Identity "site:Redmond" The command shown in Example 1 removes the centralized logging configuration settings applied to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsConfiguration -Filter "site:*" | Remove-CsClsConfiguration ``` @@ -65,7 +66,7 @@ To do this, the command first calls the `Get-CsClsConfiguration` cmdlet along th Those settings are then piped to, and removed by, the `Remove-CsClsConfiguration` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsConfiguration | Where-Object {$_.EtlFileRolloverSizeMB -gt 20} | Remove-CsClsConfiguration ``` @@ -78,7 +79,28 @@ Settings that meet that criterion are then piped to and delete by, the `Remove-C ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of centralized logging configuration settings you want to remove. To remove the global settings use this syntax: @@ -96,8 +118,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -107,13 +128,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -122,30 +145,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -159,13 +168,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -The `Remove-CsClsConfiguration` cmdlet accepts pipelined instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration +The `Remove-CsClsConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration Instead, the `Remove-CsClsConfiguration` cmdlet deletes existing instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsRegion.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsClsRegion.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClsRegion.md index d453a56054..295987e11d 100644 --- a/skype/skype-ps/skype/Remove-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClsRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclsregion +schema: 2.0.0 +title: Remove-CsClsRegion --- # Remove-CsClsRegion @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClsRegion -Identity "global/US" ``` @@ -47,7 +48,7 @@ Remove-CsClsRegion -Identity "global/US" The command shown in Example 1 removes the centralized logging region that has the Identity global/US. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsRegion -Filter "global/*" | Remove-CsClsRegion ``` @@ -57,7 +58,7 @@ To do this, the command first calls the `Get-CsClsRegion` cmdlet along with the These regions are then piped to, and deleted by, the `Remove-CsClsRegion` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsRegion | Where-Object {$_.SecurityGroupSuffix -eq "EMEA" | Remove-CsClsRegion ``` @@ -70,7 +71,28 @@ That subcollection of regions is then piped to the `Remove-CsClsRegion` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the centralized logging region to be removed. A region identity consists of the scope where the region was created followed by the region name. For example, to delete a region named US created at the global scope, use the following syntax: @@ -80,8 +102,7 @@ For example, to delete a region named US created at the global scope, use the fo ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -91,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,30 +129,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,13 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated The `Remove-CsClsRegion` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated Instead, the `Remove-CsClsRegion` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsScenario.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsClsScenario.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClsScenario.md index c1cf3ade17..203a7097e2 100644 --- a/skype/skype-ps/skype/Remove-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsScenario.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClsScenario -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclsscenario +schema: 2.0.0 +title: Remove-CsClsScenario --- # Remove-CsClsScenario @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClsScenario -Identity "site:Redmond/WAC" ``` @@ -48,7 +49,7 @@ Remove-CsClsScenario -Identity "site:Redmond/WAC" The command shown in Example 1 removes the WAC scenario from the global collection of centralized logging configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsScenario | Where-Object {$_.Name -eq "HybridVoice" | Remove-CsClsScenario ``` @@ -61,7 +62,28 @@ The HybridVoice scenarios are then piped to and deleted by, the `Remove-CsClsSce ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the scenario to be removed. A scenario consists of two parts: the scope where the scenario is configured (that is, the collection of centralized logging configuration settings where the scenario can be found) and the scenario name. For example: @@ -77,8 +99,7 @@ If you do that, however, the entire collection of centralized logging configurat ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -88,13 +109,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -103,30 +126,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -140,13 +149,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated The `Remove-CsClsScenario` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated Instead, the `Remove-CsClsScenario` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsSecurityGroup.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsClsSecurityGroup.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClsSecurityGroup.md index 823296de5b..26bcbdee04 100644 --- a/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsSecurityGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClsSecurityGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclssecuritygroup +schema: 2.0.0 +title: Remove-CsClsSecurityGroup --- # Remove-CsClsSecurityGroup @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClsSecurityGroup -Identity "global/HelpDesk" ``` @@ -47,7 +48,7 @@ Remove-CsClsSecurityGroup -Identity "global/HelpDesk" The command shown in Example 1 deletes the centralized logging security group with the Identity Global/HelpDesk. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsSecurityGroup | Remove-CsClsSecurityGroup ``` @@ -57,7 +58,7 @@ To do this, the command first calls the `Get-CsClsSecurityGroup` cmdlet without That collection is then piped to the `Remove-CsClsSecurityGroup` cmdlet, which deletes each group in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsSecurityGroup | Where-Object {$_.AccessLevel -eq "Tier3"} | Remove-CsClsSecurityGroup ``` @@ -70,7 +71,28 @@ In turn, those groups are piped to and removed by, the `Remove-CsClsSecurityGrou ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the centralized logging security group to be removed. A security group identity consists of the scope where the group was created followed by the group name. For example, to remove a group named HelpDesk created at the global scope, use the following syntax: @@ -80,8 +102,7 @@ For example, to remove a group named HelpDesk created at the global scope, use t ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -91,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,30 +129,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,13 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated The `Remove-CsClsSecurityGroup` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated Instead, the `Remove-CsClsSecurityGroup` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCommonAreaPhone.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsCommonAreaPhone.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCommonAreaPhone.md index 2a890219dc..1a910a9919 100644 --- a/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCommonAreaPhone.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCommonAreaPhone -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscommonareaphone +schema: 2.0.0 +title: Remove-CsCommonAreaPhone --- # Remove-CsCommonAreaPhone @@ -47,7 +48,7 @@ In addition, the contact object associated with that phone will be deleted from ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsCommonAreaPhone -Filter {DisplayName -eq "Building 14 Lobby"} | Remove-CsCommonAreaPhone ``` @@ -57,7 +58,7 @@ To do this, the command first calls the `Get-CsCommonAreaPhone` cmdlet along wit The returned object is then piped to, and deleted by, the `Remove-CsCommonAreaPhone` cmdlet. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsCommonAreaPhone -Filter {DialPlan -eq $Null} | Remove-CsCommonAreaPhone ``` @@ -67,7 +68,7 @@ This task is carried out by first using the `Get-CsCommonAreaPhone` cmdlet and t This filtered collection is then piped to the `Remove-CsCommonAreaPhone` cmdlet, which deletes each phone in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsCommonAreaPhone -OU "ou=Redmond,dc=litwareinc,dc=com" | Remove-CsCommonAreaPhone ``` @@ -80,6 +81,9 @@ The returned collection is then piped to the `Remove-CsCommonAreaPhone` cmdlet, ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the common area phone. Common area phones are identified using the Active Directory distinguished name of the associated contact object. By default, common area phones use a globally unique identifier (GUID) as their common name, which means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. @@ -89,8 +93,7 @@ Because of that, you might find it easier to retrieve common area phones by usin ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -99,14 +102,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -115,14 +120,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -136,13 +143,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact + The `Remove-CsCommonAreaPhone` cmdlet accepts pipelined instances of the common area phone object. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact The `Remove-CsCommonAreaPhone` cmdlet deletes existing instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDirectory.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsConferenceDirectory.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDirectory.md index 407a22cf8c..52b0682a68 100644 --- a/skype/skype-ps/skype/Remove-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDirectory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConferenceDirectory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconferencedirectory +schema: 2.0.0 +title: Remove-CsConferenceDirectory --- # Remove-CsConferenceDirectory @@ -40,7 +41,7 @@ Note that if you need to move a directory from one pool to another, you can do s ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsConferenceDirectory -Identity 2 ``` @@ -48,7 +49,7 @@ Remove-CsConferenceDirectory -Identity 2 The command shown in Example 1 deletes the conference directory with the Identity 2. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsConferenceDirectory | Where-Object {$_.ServiceID -match "UserServer:atl-cs-001.litwareinc.com"} | Remove-CsConferenceDirectory ``` @@ -61,14 +62,36 @@ In turn, that filtered collection is piped to and deleted by, the `Remove-CsConf ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, removes the conference directory even if the pool that hosts the directory is currently unavailable. +By default, the `Remove-CsConferenceDirectory` cmdlet will not remove directories if the corresponding pool cannot be contacted. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Numeric identity of the conference directory to be removed. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -77,16 +100,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -When present, removes the conference directory even if the pool that hosts the directory is currently unavailable. -By default, the `Remove-CsConferenceDirectory` cmdlet will not remove directories if the corresponding pool cannot be contacted. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -96,29 +119,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -132,14 +141,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories object. +### Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories + The `Remove-CsConferenceDirectory` cmdlet accepts pipelined input of conference directory objects. ## OUTPUTS -### -None. +### None Instead, the `Removes-CsConferenceDirectory` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDisclaimer.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDisclaimer.md index efd4048142..a04afdc406 100644 --- a/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConferenceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconferencedisclaimer +schema: 2.0.0 +title: Remove-CsConferenceDisclaimer --- # Remove-CsConferenceDisclaimer @@ -36,7 +37,7 @@ The `Remove-CsConferenceDisclaimer` cmdlet enables you to reset your conference ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsConferenceDisclaimer -Identity global ``` @@ -47,7 +48,28 @@ That means that both the disclaimer Header and Body will be set to null values, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the conference disclaimer to be removed. Although you can only have a single, global instance of the conference disclaimer, you must still use the Identity parameter when calling the `Remove-CsConferenceDisclaimer` cmdlet. @@ -55,8 +77,7 @@ Although you can only have a single, global instance of the conference disclaime ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -65,14 +86,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -82,29 +105,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -118,14 +127,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer object. +### Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer + The `Remove-CsConferenceDisclaimer` cmdlet accepts pipelined input of conference disclaimer objects. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsConferenceDisclaimer` cmdlet resets existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer object to their default property values. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConferencingConfiguration.md index 4164a16021..2dc1d69b3d 100644 --- a/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconferencingconfiguration +schema: 2.0.0 +title: Remove-CsConferencingConfiguration --- # Remove-CsConferencingConfiguration @@ -51,7 +52,7 @@ For example, if you previously changed the maximum content storage value to 200 ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsConferencingConfiguration -Identity site:Redmond ``` @@ -60,7 +61,7 @@ Example 1 deletes the conferencing configuration settings applied to the Redmond When site settings such as these are deleted, users in the site will automatically inherit the settings found in the global conferencing configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingConfiguration -Filter site:* | Remove-CsConferencingConfiguration ``` @@ -70,7 +71,7 @@ To do this, the command first calls the `Get-CsConferencingConfiguration` cmdlet This filtered collection is then piped to the `Remove-CsConferencingConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingConfiguration | Where-Object {$_.Organization -ne "Litwareinc"} | Remove-CsConferencingConfiguration ``` @@ -83,7 +84,28 @@ Finally, the filtered collection is piped to the `Remove-CsConferencingConfigura ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the collection of conferencing configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. To remove settings configured at the service scope, use syntax similar to this: `-Identity "service:ConferencingServer:atl-cs-001.litwareinc.com"`. @@ -95,8 +117,7 @@ In that case, however, those settings will not be removed; instead, all the prop ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -105,14 +126,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -122,29 +145,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -158,14 +167,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings + The `Remove-CsConferencingConfiguration` cmdlet accepts pipelined instances of the conferencing configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsConferencingConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingPolicy.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsConferencingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConferencingPolicy.md index cbc2051711..cb4af72de7 100644 --- a/skype/skype-ps/skype/Remove-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Remove-CsConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconferencingpolicy +schema: 2.0.0 +title: Remove-CsConferencingPolicy --- # Remove-CsConferencingPolicy @@ -48,7 +50,7 @@ In that case, however the policy will not be removed; instead, all the global po ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsConferencingPolicy -Identity SalesConferencingPolicy ``` @@ -56,7 +58,7 @@ Remove-CsConferencingPolicy -Identity SalesConferencingPolicy In Example 1, the `Remove-CsConferencingPolicy` cmdlet is used to delete the conferencing policy with the Identity SalesConferencingPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingPolicy -Filter "site:*" | Remove-CsConferencingPolicy ``` @@ -66,7 +68,7 @@ To accomplish this task, the command first uses the `Get-CsConferencingPolicy` c That filtered collection is then piped to the `Remove-CsConferencingPolicy` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingPolicy | Where-Object {$_.MaxMeetingSize -gt 100} | Remove-CsConferencingPolicy ``` @@ -79,7 +81,30 @@ Finally, that filtered collection is passed to the `Remove-CsConferencingPolicy` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, causes the `Remove-CsConferencingPolicy` cmdlet to delete the per-user policy even if the policy in question is currently assigned to at least one user. +If not present, you will be asked to confirm the deletion request before the policy will be removed. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the conferencing policy to be removed. Conferencing policies can be configured at the global, site, or per-user scopes. To remove the global policy, use this syntax: `-Identity global`. @@ -93,8 +118,7 @@ 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 +Aliases: Required: True Position: 2 @@ -103,33 +127,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -If present, causes the `Remove-CsConferencingPolicy` cmdlet to delete the per-user policy even if the policy in question is currently assigned to at least one user. -If not present, you will be asked to confirm the deletion request before the policy will be removed. +### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```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 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the conferencing policy is being removed. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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: SwitchParameter +Type: Guid 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 +Aliases: Required: False Position: Named @@ -139,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -146,7 +164,6 @@ Prompts you for confirmation before executing the command. 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 @@ -155,22 +172,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the conferencing policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -184,13 +196,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy + The `Remove-CsConferencingPolicy` cmdlet accepts pipelined instances of the meeting policy object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy The `Remove-CsConferencingPolicy` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. diff --git a/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConfigurationStoreLocation.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConfigurationStoreLocation.md index 654ff393a0..048b5b0daa 100644 --- a/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConfigurationStoreLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconfigurationstorelocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConfigurationStoreLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconfigurationstorelocation +schema: 2.0.0 +title: Remove-CsConfigurationStoreLocation --- # Remove-CsConfigurationStoreLocation @@ -38,7 +39,7 @@ After the SCP has been deleted, you can recreate it (or create a new service con ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsConfigurationStoreLocation ``` @@ -47,7 +48,7 @@ The command shown in Example 1 removes the Active Directory service control poin To restore this SCP (or to create a new SCP), you must run the `Set-CsConfigurationStoreLocation` cmdlet. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Remove-CsConfigurationStoreLocation -Report C:\Logs\Store_Location.html ``` @@ -61,16 +62,16 @@ If the file does not exist, it will be created when the command runs. ## PARAMETERS -### -GlobalSettingsDomainController -Fully qualified domain name (FQDN) of a domain controller where global settings are stored. -If global settings are stored in the Active Directory System container, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,14 +80,18 @@ 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. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of a domain controller where global settings are stored. +If global settings are stored in the Active Directory System container, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +101,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\ConfigurationStore.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,14 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -128,14 +137,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -149,13 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsConfigurationStoreLocation` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Remove-CsConfigurationStoreLocation` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConversationHistoryConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConversationHistoryConfiguration.md index 1d6e47fc07..e43ea4d7b1 100644 --- a/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConversationHistoryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconversationhistoryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConversationHistoryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconversationhistoryconfiguration +schema: 2.0.0 +title: Remove-CsConversationHistoryConfiguration --- # Remove-CsConversationHistoryConfiguration @@ -39,7 +40,7 @@ If you run the `Remove-CsConversationHistoryConfiguration` cmdlet then CachedUse ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsConversationHistoryConfiguration -Identity "global" ``` @@ -49,7 +50,28 @@ The command shown in Example 1 resets all the properties in the global collectio ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the conversation history configuration settings to be deleted. Because there is only a single, global collection of settings per deployment, the only allowed syntax is the following: @@ -58,8 +80,7 @@ Because there is only a single, global collection of settings per deployment, th ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -69,13 +90,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -84,30 +107,16 @@ 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: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -121,13 +130,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings `Remove-CsConversationHistoryConfiguration` accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings Instead, `Remove-CsConversationHistoryConfiguration` resets instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCpsConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsCpsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCpsConfiguration.md index 31f01a2608..10086060d2 100644 --- a/skype/skype-ps/skype/Remove-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCpsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCpsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscpsconfiguration +schema: 2.0.0 +title: Remove-CsCpsConfiguration --- # Remove-CsCpsConfiguration @@ -39,7 +40,7 @@ In the case of the Global configuration, however, the configuration will not act ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCpsConfiguration -Identity site:Redmond1 ``` @@ -48,7 +49,7 @@ Example 1 uses the `Remove-CsCpsConfiguration` cmdlet to delete the Call Park se Because identities are unique, this command will result in only one configuration being deleted. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCpsConfiguration -Filter site:* | Remove-CsCpsConfiguration ``` @@ -61,15 +62,35 @@ Note that any time you remove Call Park service settings from a site, the site w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the Call Park service configuration you want to remove. This identifier will be either Global or site:\, where \ is the name of the site to which the configuration applies. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -78,14 +99,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -95,29 +118,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -131,13 +140,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings + Accepts pipelined input of Call Park service configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateConfiguration.md index 3ba03e403a..074ffecb83 100644 --- a/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDeviceUpdateConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdeviceupdateconfiguration +schema: 2.0.0 +title: Remove-CsDeviceUpdateConfiguration --- # Remove-CsDeviceUpdateConfiguration @@ -46,7 +47,7 @@ That means that MaxLogCacheLimit will be reset to 512,000 bytes. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsDeviceUpdateConfiguration -Identity global ``` @@ -55,7 +56,7 @@ In Example 1, the `Remove-CsDeviceUpdateConfiguration` cmdlet is used to "remove Because the global settings cannot actually be removed, the command will not delete anything; however, all the properties in the global device update configuration settings will be reset to their default values. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Remove-CsDeviceUpdateConfiguration -Identity site:Redmond ``` @@ -64,7 +65,7 @@ The command shown in Example 2 removes the device update configuration settings Because these settings were configured at the site scope, they will be deleted and the Redmond site will no longer have its own set of device update configuration settings. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDeviceUpdateConfiguration -Filter "site:*" | Remove-CsDeviceUpdateConfiguration ``` @@ -74,7 +75,7 @@ To do this, the `Get-CsDeviceUpdateConfiguration` cmdlet and the Filter paramete That collection is then piped to the `Remove-CsDeviceUpdateConfiguration` cmdlet, which removes each of the items in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsDeviceUpdateConfiguration | Where-Object {$_.MaxLogFileSize -lt 1024000} | Remove-CsDeviceUpdateConfiguration ``` @@ -87,7 +88,28 @@ That filtered collection is then piped to the `Remove-CsDeviceUpdateConfiguratio ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the device update configuration settings to be removed. To refer to the global settings, use this syntax: `-Identity global`. To refer to site settings, use syntax similar to this: `-Identity site:Redmond`. @@ -96,8 +118,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -106,14 +127,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -123,29 +146,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -159,14 +168,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration + The `Remove-CsDeviceUpdateConfiguration` cmdlet accepts pipelined instances of the device update configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsDeviceUpdateConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateRule.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateRule.md index f13625d1e3..c37e2cecd6 100644 --- a/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDeviceUpdateRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdeviceupdaterule +schema: 2.0.0 +title: Remove-CsDeviceUpdateRule --- # Remove-CsDeviceUpdateRule @@ -38,7 +39,7 @@ To help lessen this confusion, the `Remove-CsDeviceUpdateRule` cmdlet can be use ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 ``` @@ -47,7 +48,7 @@ Example 1 deletes the device update rule with the Identity service:WebServer:atl After the rule has been deleted, the corresponding firmware update will no longer be available for use. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDeviceUpdateRule | Remove-CsDeviceUpdateRule ``` @@ -57,7 +58,7 @@ This is done by calling the `Get-CsDeviceUpdateRule` cmdlet (without any paramet That collection is then piped to the `Remove-CsDeviceUpdateRule` cmdlet, which, in turn, deletes each rule in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* | Remove-CsDeviceUpdateRule ``` @@ -67,7 +68,7 @@ To do this, the command first uses the `Get-CsDeviceUpdateRule` cmdlet and the F This collection is then piped to the `Remove-CsDeviceUpdateRule` cmdlet, which deletes each rule in that collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} | Remove-CsDeviceUpdateRule ``` @@ -80,7 +81,28 @@ The filtered collection is then piped to the `Remove-CsDeviceUpdateRule` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the device update rule. The Identity of a device update rule is composed of two parts: The service scope where the rule has been applied (for example, service:WebServer:atl-cs-001.litwareinc.com) and the globally unique identifier (GUID) that was pre-assigned to the rule (for example, d5ce3c10-2588-420a-82ac-dc2d9b1222ff9). Based on this, the Identity for a given device update rule will look something like this: "service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9". @@ -90,8 +112,7 @@ 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -100,14 +121,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -117,29 +140,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -153,13 +162,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule + The `Remove-CsDeviceUpdateRule` cmdlet accepts pipelined instances of the device update rule object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.Rule The `Remove-CsDeviceUpdateRule` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.Rule object. diff --git a/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticConfiguration.md index 863e71f71f..dbff4aefcb 100644 --- a/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDiagnosticConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdiagnosticconfiguration +schema: 2.0.0 +title: Remove-CsDiagnosticConfiguration --- # Remove-CsDiagnosticConfiguration @@ -44,7 +45,7 @@ That means that all the filters added to that collection will be removed. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsDiagnosticConfiguration -Identity site:Redmond ``` @@ -52,7 +53,7 @@ Remove-CsDiagnosticConfiguration -Identity site:Redmond Example 1 deletes the diagnostic configuration settings that have the Identity site:Redmond. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDiagnosticConfiguration -Filter site:* | Remove-CsDiagnosticConfiguration ``` @@ -62,7 +63,7 @@ To do this, the command calls the `Get-CsDiagnosticConfiguration` cmdlet along w The filtered collection is then piped to the `Remove-CsDiagnosticConfiguration` cmdlet, which removes each item in that collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDiagnosticConfiguration | Remove-CsDiagnosticConfiguration ``` @@ -74,7 +75,28 @@ These items are then piped to the `Remove-CsDiagnosticConfiguration` cmdlet, whi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the diagnostic configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. @@ -85,8 +107,7 @@ However, the global settings will not actually be removed; instead, the properti ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -95,14 +116,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -112,29 +135,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -148,14 +157,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings + The `Remove-CsDiagnosticConfiguration` cmdlet accepts pipelined instances of the diagnostic filter settings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsDiagnosticConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticHeaderConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticHeaderConfiguration.md index 5b42883a96..d43515515d 100644 --- a/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticHeaderConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDiagnosticHeaderConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdiagnosticheaderconfiguration +schema: 2.0.0 +title: Remove-CsDiagnosticHeaderConfiguration --- # Remove-CsDiagnosticHeaderConfiguration @@ -46,7 +47,7 @@ Instead, the two properties contained in the global collection -- SendToExternal ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsDiagnosticHeaderConfiguration -Identity site:Redmond ``` @@ -54,7 +55,7 @@ Remove-CsDiagnosticHeaderConfiguration -Identity site:Redmond In Example 1, the diagnostic header configuration settings that have the Identity site:Redmond are removed. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDiagnosticHeaderConfiguration -Filter service:* | Remove-CsDiagnosticHeaderConfiguration ``` @@ -65,7 +66,7 @@ The filter value "service:*" limits the returned data to those settings where th This filtered collection is then piped to the `Remove-CsDiagnosticHeaderConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True} | Remove-CsDiagnosticHeaderConfiguration ``` @@ -78,7 +79,28 @@ These settings are then piped to the `Remove-CsDiagnosticHeaderConfiguration` cm ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the diagnostic header configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. To remove settings configured at the service scope, use syntax similar to this: `-Identity "service:EdgeServer:atl-edge-001.litwareinc.com"`. @@ -90,8 +112,7 @@ Note, however, that the global settings will not actually be removed; instead, t ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -100,14 +121,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -117,29 +140,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -153,14 +162,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings + The `Remove-CsDiagnosticHeaderConfiguration` cmdlet accepts pipelined instances of the diagnostic header settings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsDiagnosticHeaderConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingAccessNumber.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingAccessNumber.md index 7f4137e2f9..271343f38c 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingAccessNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDialInConferencingAccessNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdialinconferencingaccessnumber +schema: 2.0.0 +title: Remove-CsDialInConferencingAccessNumber --- # Remove-CsDialInConferencingAccessNumber @@ -39,7 +40,7 @@ When you run the `Remove-CsDialInConferencingAccessNumber` cmdlet, the cmdlet no ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsDialInConferencingAccessNumber -Identity sip:RedmondDialIn@litwareinc.com ``` @@ -47,7 +48,7 @@ Remove-CsDialInConferencingAccessNumber -Identity sip:RedmondDialIn@litwareinc.c The command shown in Example 1 deletes the dial-in conferencing access number that has the Identity sip:RedmondDialIn@litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDialInConferencingAccessNumber -Filter {LineUri -like "tel:+1800*"} | Remove-CsDialInConferencingAccessNumber ``` @@ -57,7 +58,7 @@ To do this, the command uses the `Get-CsDialInConferencingAccessNumber` cmdlet a This filtered collection is then piped to the `Remove-CsDialInConferencingAccessNumber` cmdlet, which deletes each number in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDialInConferencingAccessNumber -Region "Redmond" | Remove-CsDialInConferencingAccessNumber ``` @@ -67,7 +68,7 @@ To carry out this task, the `Get-CsDialInConferencingAccessNumber` cmdlet and th (That is, any access number that includes Redmond in its list of regions.) This collection is then piped to the `Remove-CsDialInConferencingAccessNumber` cmdlet, which deletes all the access numbers in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsDialInConferencingAccessNumber -Region $Null | Remove-CsDialInConferencingAccessNumber ``` @@ -77,7 +78,7 @@ To do this, the `Get-CsDialInConferencingAccessNumber` cmdlet is called along wi That collection is then piped to the `Remove-CsDialInConferencingAccessNumber` cmdlet, which deletes all the numbers in the collection. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -ne "it-IT"} | Remove-CsDialInConferencingAccessNumber ``` @@ -88,7 +89,7 @@ That collection is then piped to the `Where-Object` cmdlet, which picks out any Finally, the filtered collection is piped to the `Remove-CsDialInConferencingAccessNumber` cmdlet, which deletes all the access numbers in the collection. -### -------------------------- Example 6 ------------------------ +### Example 6 ``` Get-CsDialInConferencingAccessNumber -Filter {DisplayName -eq "Default Dial-In Access Number"} | Remove-CsDialInConferencingAccessNumber ``` @@ -101,14 +102,16 @@ The returned object is then piped to the `Remove-CsDialInConferencingAccessNumbe ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the dial-in conferencing access number (that is, the contact object that represents that number) to be removed. You must include the sip: prefix when specifying the Identity; for example: `-Identity "sip:RedmondDialIn@litwareinc.com"`. ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -117,14 +120,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -133,14 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -154,13 +161,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.AccessNumber object. +### Microsoft.Rtc.Management.Xds.AccessNumber + The `Remove-CsDialInConferencingAccessNumber` cmdlet accepts pipelined input of the access number object. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.AccessNumber The `Remove-CsDialInConferencingAccessNumber` cmdlet deletes instances of the Microsoft.Rtc.Management.Xds.AccessNumber object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingConfiguration.md index e0c94267aa..da3d98b21e 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDialInConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdialinconferencingconfiguration +schema: 2.0.0 +title: Remove-CsDialInConferencingConfiguration --- # Remove-CsDialInConferencingConfiguration @@ -44,7 +45,7 @@ Instead, all the properties within that collection of settings will be reset to ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CSDialInConferencingConfiguration -Identity "site:Redmond" ``` @@ -52,7 +53,7 @@ Remove-CSDialInConferencingConfiguration -Identity "site:Redmond" In Example 1, the dial-in conferencing configuration settings for the Redmond site are deleted. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CSDialInConferencingConfiguration -Filter "site:*" | Remove-CSDialInConferencingConfiguration ``` @@ -62,7 +63,7 @@ To do this, the command first uses the `Get-CSDialInConferencingConfiguration` c (The filter value "site:*" ensures that only settings that have an Identity that begins with the string value "site:" are returned.) This filtered collection is then piped to the `Remove-CSDialInConferencingConfiguration` cmdlet, which removes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CSDialInConferencingConfiguration | Where-Object {$_.EnableNameRecording -eq $False} | Remove-CSDialInConferencingConfiguration ``` @@ -75,7 +76,28 @@ In turn, this filtered collection is piped to the `Remove-CSDialInConferencingCo ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the dial-in conferencing configuration settings to be removed. To refer to the global settings, use this syntax: `-Identity global`. To refer to site settings, use syntax similar to this: `-Identity site:Redmond`. @@ -84,8 +106,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -94,14 +115,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -111,29 +134,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -147,14 +156,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration + The `Remove-CSDialInConferencingConfiguration` cmdlet accepts pipelined instances of the dial-in conferencing configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CSDialInConferencingConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingDtmfConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingDtmfConfiguration.md index 8eaaf5a8d7..30dc774091 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingDtmfConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDialInConferencingDtmfConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdialinconferencingdtmfconfiguration +schema: 2.0.0 +title: Remove-CsDialInConferencingDtmfConfiguration --- # Remove-CsDialInConferencingDtmfConfiguration @@ -49,7 +50,7 @@ If you now run the `Remove-CSDialInConferencingDtmfConfiguration` cmdlet against ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CSDialInConferencingDtmfConfiguration -Identity site:Redmond ``` @@ -57,7 +58,7 @@ Remove-CSDialInConferencingDtmfConfiguration -Identity site:Redmond Example 1 deletes the collection of DTMF configuration settings that has the Identity site:Redmond. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CSDialInConferencingDtmfConfiguration -Filter "site:*" | Remove-CSDialInConferencingDtmfConfiguration ``` @@ -67,7 +68,7 @@ To perform this task, the command first uses the `Get-CSDialInConferencingDtmfCo This filtered collection is then piped to the `Remove-CSDialInConferencingConfiguration` cmdlet, which removes each item in that collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CSDialInConferencingDtmfConfiguration | Where-Object {$_.PrivateRollCallCommand -eq $Null} | Remove-CSDialInConferencingDtmfConfiguration ``` @@ -80,7 +81,28 @@ The filtered collection is then piped to the `Remove-CSDialInConferencingDtmfCon ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of DTMF settings to be removed. To "remove" the global settings, use this syntax: `-Identity global`. (As noted earlier, you cannot actually remove the global setting; all you can do is reset the properties to their default values.) To remove a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. @@ -89,8 +111,7 @@ You cannot use wildcards when specifying an Identity ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -99,14 +120,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -116,29 +139,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -152,14 +161,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration + The `Remove-CsDialInConferencingDtmfConfiguration` cmdlet accepts pipelined instances of the dial-in conference DTMF configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CSDialInConferencingDtmfConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialPlan.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDialPlan.md index e42285747c..140ea40e80 100644 --- a/skype/skype-ps/skype/Remove-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDialPlan -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdialplan +schema: 2.0.0 +title: Remove-CsDialPlan --- # Remove-CsDialPlan @@ -37,7 +38,7 @@ If the global dial plan is removed, any associated normalization rules will also ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsDialPlan -Identity RedmondDialPlan ``` @@ -47,7 +48,7 @@ Note that when you delete a dial plan, you do not necessarily have to assign a n Instead, those users will use the dial plan assigned to their service or site, or the global plan. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialPlan | Where-Object {$_.Description -match "Redmond"} | Remove-CsDialPlan ``` @@ -60,14 +61,34 @@ After that's done, the filtered collection is passed to the `Remove-CsDialPlan` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the dial plan you want to remove. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -76,14 +97,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -93,29 +116,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -129,13 +138,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile + The `Remove-CsDialPlan` cmdlet accepts pipelined input of dial plan objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile This cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsEnhancedEmergencyServiceDisclaimer.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsEnhancedEmergencyServiceDisclaimer.md index 12953178d6..a96e0584fd 100644 --- a/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csenhancedemergencyservicedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Remove-CsEnhancedEmergencyServiceDisclaimer --- # Remove-CsEnhancedEmergencyServiceDisclaimer @@ -34,7 +35,7 @@ This message will be displayed only if the LocationRequired property of the user ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsEnhancedEmergencyServiceDisclaimer -Identity global ``` @@ -46,14 +47,34 @@ It simply sets the Body property to an empty string. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This value is required and must be set to Global. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -62,14 +83,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -79,29 +102,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -115,13 +124,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer + Accepts pipelined input of an enhanced emergency service disclaimer object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer This cmdlet does not return a value or an object. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer. diff --git a/skype/skype-ps/skype/Remove-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Remove-CsExUmContact.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsExUmContact.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsExUmContact.md index 264bd46774..9547ed50f7 100644 --- a/skype/skype-ps/skype/Remove-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsExUmContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsExUmContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csexumcontact +schema: 2.0.0 +title: Remove-CsExUmContact --- # Remove-CsExUmContact @@ -31,7 +32,7 @@ Any of the objects that are created can be removed with the `Remove-CsExUmContac ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsExUmContact -Identity sip:exumsa1@fabrikam.com ``` @@ -39,7 +40,7 @@ Remove-CsExUmContact -Identity sip:exumsa1@fabrikam.com This example removes the Exchange UM contact with the SIP address exumsa1@fabrikam.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsExUmContact -Filter {LineURI -like "tel:425*"} | Remove-CsExUmContact ``` @@ -54,6 +55,9 @@ Once we have that collection of objects, we pipe the collection to the `Remove-C ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the contact object you want to remove. Contact identities can be specified using one of four formats: 1) The contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1) and 4) the contact's Active Directory display name (for example, Team Auto Attendant). @@ -63,8 +67,7 @@ Full data type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -73,14 +76,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -89,14 +94,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -110,13 +117,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact + Accepts pipelined input of Exchange UM contact objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact This cmdlet does not return an object. It removes an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact. diff --git a/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalAccessPolicy.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsExternalAccessPolicy.md index d10506b89c..8c9e86fd3c 100644 --- a/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalAccessPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Remove-CsExternalAccessPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csexternalaccesspolicy +schema: 2.0.0 +title: Remove-CsExternalAccessPolicy --- # Remove-CsExternalAccessPolicy @@ -53,7 +55,7 @@ Instead, the properties of the global policy will simply be reset to their defau ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsExternalAccessPolicy -Identity site:Redmond ``` @@ -61,7 +63,7 @@ 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 ------------------------ +### Example 2 ``` Get-CsExternalAccessPolicy -Filter site:* | Remove-CsExternalAccessPolicy ``` @@ -70,7 +72,7 @@ Example 2 deletes all the external access policies that have been configured at To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of policies configured at the site scope; the filter value "site:*" limits the returned data to external access policies that have an Identity that begins with the string value "site:". The filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} | Remove-CsExternalAccessPolicy ``` @@ -80,7 +82,7 @@ To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet to r This collection is then piped to the `Where-Object` cmdlet, which picks out only those policies where the EnableFederationAccess property is equal to True. This filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -or $_.EnablePublicCloudAccess -eq $True} | Remove-CsExternalAccessPolicy ``` @@ -96,7 +98,28 @@ To delete all the policies where both EnableFederationAccess and EnablePublicClo ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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`. @@ -110,7 +133,6 @@ Note that wildcards are not allowed when specifying an Identity. 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 @@ -119,30 +141,23 @@ 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. +### -Tenant -```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 +> Applicable: 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the external access policy is being removed. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-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: SwitchParameter +Type: Guid 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 +Aliases: Required: False Position: Named @@ -152,13 +167,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -167,21 +184,16 @@ 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: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -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` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -195,14 +207,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy + The `Remove-CsExternalAccessPolicy` cmdlet accepts pipelined input of the external access policy object. ## OUTPUTS -### -None. +### 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. diff --git a/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalUserCommunicationPolicy.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsExternalUserCommunicationPolicy.md index a7a6576fd6..237ba287e9 100644 --- a/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalUserCommunicationPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy applicable: Skype for Business Online -title: Remove-CsExternalUserCommunicationPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csexternalusercommunicationpolicy +schema: 2.0.0 +title: Remove-CsExternalUserCommunicationPolicy --- # Remove-CsExternalUserCommunicationPolicy @@ -27,7 +29,7 @@ Remove-CsExternalUserCommunicationPolicy [-Tenant ] [-Identity] {{ Add example code here }} ``` @@ -36,30 +38,16 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Force {{Fill Force Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -69,13 +57,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + {{Fill Identity Description}} ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -85,13 +75,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -101,6 +111,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -108,7 +121,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsFIPSConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsFIPSConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsFIPSConfiguration.md index 21351e05ab..e5f29655d2 100644 --- a/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsFIPSConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsFIPSConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csfipsconfiguration +schema: 2.0.0 +title: Remove-CsFIPSConfiguration --- # Remove-CsFIPSConfiguration @@ -41,7 +42,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsFIPSConfiguration -Identity "Global" ``` @@ -51,7 +52,28 @@ Example 1 resets the properties in the global collection of FIPS configuration s ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the FIPS configuration settings to be removed. Because Skype for Business Server only supports a single, global collection of FIPS settings, the only collection that can be deleted is the global collection: @@ -64,8 +86,7 @@ Instead, the lone property in that collection - RequireFIPSCompliantMedia - will ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,30 +95,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Server tenant account for the FIPS configuration settings being deleted. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,22 +121,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Server tenant account for the FIPS configuration settings being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -Confirm -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -151,13 +162,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration The `Remove-CsFIPSConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration object ## OUTPUTS -### -None. +### None Instead, the `Remove-CsFIPSConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsFileTransferFilterConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsFileTransferFilterConfiguration.md index bcffa2634d..cd81be59cd 100644 --- a/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsFileTransferFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsFileTransferFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csfiletransferfilterconfiguration +schema: 2.0.0 +title: Remove-CsFileTransferFilterConfiguration --- # Remove-CsFileTransferFilterConfiguration @@ -37,7 +38,7 @@ In that case, however, the global configuration will not be removed; instead, al ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsFileTransferFilterConfiguration -Identity site:Redmond ``` @@ -45,7 +46,7 @@ Remove-CsFileTransferFilterConfiguration -Identity site:Redmond In Example 1, the `Remove-CsFileTransferFilterConfiguration` cmdlet is used to remove the file transfer filter configuration that has the Identity site:Redmond. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsFileTransferFilterConfiguration -Filter site:* | Remove-CsFileTransferFilterConfiguration ``` @@ -56,7 +57,7 @@ The filter value "site:*" tells the `Get-CsFileTransferFilterConfiguration` cmdl The filtered collection of configurations is then piped to the `Remove-CsFileTransferFilterConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsFileTransferFilterConfiguration | Where-Object {$_.Enabled -eq $False} | Remove-CsFileTransferFilterConfiguration ``` @@ -69,7 +70,28 @@ That filtered collection is then piped to the `Remove-CsFileTransferFilterConfig ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the file transfer configuration to be removed. To refer to the global configuration, use this syntax: `-Identity global`. To refer to a configuration at the site scope, use syntax similar to this: `-Identity site:Redmond`. @@ -78,8 +100,7 @@ Note that you cannot use wildcard values when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -88,14 +109,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -105,29 +128,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -141,13 +150,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration + Accepts pipelined input of file transfer filter configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration This cmdlet does not return a value or object. Instead, it removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. diff --git a/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/Remove-CsGroupPickupUserOrbit.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsGroupPickupUserOrbit.md index f6a9d6484e..f9c1ddbe5a 100644 --- a/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsGroupPickupUserOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsGroupPickupUserOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csgrouppickupuserorbit +schema: 2.0.0 +title: Remove-CsGroupPickupUserOrbit --- # Remove-CsGroupPickupUserOrbit @@ -27,7 +28,7 @@ This cmdlet will throw an exception if the user does not have an assigned group ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsGroupPickupUserOrbit sip:ken.myer@contoso.com ``` @@ -39,7 +40,28 @@ The first parameter after the cmdlet is assumed to be the User parameter value. ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -User + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the user whose group pickup orbit number will be removed. Because User is a positional parameter, the -User syntax is not required. The first parameter after the cmdlet is assumed to be the User parameter value. @@ -51,7 +73,6 @@ You can also reference a user account by using the user's Active Directory disti Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -61,13 +82,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -76,30 +99,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -113,13 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String This cmdlet supports pipelined input from the Get-CsUser cmdlet. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHealthMonitoringConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsHealthMonitoringConfiguration.md index d7ea78fe80..409c07d416 100644 --- a/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHealthMonitoringConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsHealthMonitoringConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshealthmonitoringconfiguration +schema: 2.0.0 +title: Remove-CsHealthMonitoringConfiguration --- # Remove-CsHealthMonitoringConfiguration @@ -44,7 +45,7 @@ The `Remove-CsHealthMonitoringConfiguration` cmdlet provides a way for you to re ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsHealthMonitoringConfiguration -Identity atl-cs-001.litwareinc.com ``` @@ -53,7 +54,7 @@ The command shown in Example 1 deletes the collection of health monitoring confi Because identities must be unique, this command will delete, at most, a single collection of settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsHealthMonitoringConfiguration | Remove-CsHealthMonitoringConfiguration ``` @@ -63,7 +64,7 @@ To do this, the command first calls the `Get-CsHealthMonitoringConfiguration` cm This collection is then piped to the `Remove-CsHealthMonitoringConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsHealthMonitoringConfiguration -Filter *.litwareinc.com | Remove-CsHealthMonitoringConfiguration ``` @@ -73,7 +74,7 @@ To do this, the `Get-CsHealthMonitoringConfiguration` cmdlet is called along wit The filtered collection is then piped to the `Remove-CsHealthMonitoringConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` (Get-CsHealthMonitoringConfiguration | Where-Object {$_.FirstTestUserSipUri -eq "sip:kenmyer@litwareinc.com" -or $_.SecondTestUserSipUri -eq " sip:kenmyer@litwareinc.com"}) | Remove-CsHealthMonitoringConfiguration ``` @@ -86,15 +87,35 @@ In turn, those settings are piped to and removed by, the `Remove-CsHealthMonitor ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the pool hosting the health monitoring configuration settings that are to be deleted. For example: -Identity atl-cs-001.litwareinc.com. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,14 +124,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -120,29 +143,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -156,14 +165,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings + The `Remove-CsHealthMonitoringConfiguration` cmdlet accepts pipelined instances of the health monitoring configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsHealthMonitoringConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHostedVoicemailPolicy.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsHostedVoicemailPolicy.md index ce701e607c..1e1bf3bb71 100644 --- a/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHostedVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsHostedVoicemailPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshostedvoicemailpolicy +schema: 2.0.0 +title: Remove-CsHostedVoicemailPolicy --- # Remove-CsHostedVoicemailPolicy @@ -30,7 +31,7 @@ This cmdlet removes a policy that specifies how to route unanswered calls to the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsHostedVoicemailPolicy -Identity ExRedmond ``` @@ -38,7 +39,7 @@ Remove-CsHostedVoicemailPolicy -Identity ExRedmond This command removes the hosted voice mail policy for the ExRedmond per-user policy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHostedVoicemailPolicy -Filter tag* | Remove-CsHostedVoicemailPolicy ``` @@ -50,15 +51,35 @@ That set of policies is then piped to the `Remove-CsHostedVoicemailPolicy` cmdle ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the hosted voice mail policy that you want to remove. This identifier includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -67,30 +88,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the hosted voicemail policy being deleted. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,13 +115,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -115,22 +132,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the hosted voicemail policy being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -WhatIf -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -144,13 +155,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy + Accepts pipelined input of hosted voice mail policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy This cmdlet does not return an object. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy. diff --git a/skype/skype-ps/skype/Remove-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHostingProvider.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsHostingProvider.md index 8dd1e03560..2d74e150fc 100644 --- a/skype/skype-ps/skype/Remove-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHostingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsHostingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshostingprovider +schema: 2.0.0 +title: Remove-CsHostingProvider --- # Remove-CsHostingProvider @@ -51,7 +52,7 @@ To re-establish the relationship, you can use the `Enable-CsHostingProvider` cmd ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsHostingProvider -Identity "Fabrikam.com" ``` @@ -60,7 +61,7 @@ The command show in Example 1 deletes the hosting provider with the Identity Fab After the hosting provider has been deleted, federation with Fabrikam.com (and any domains associated with Fabrikam.com) will be terminated. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsHostingProvider | Remove-CsHostingProvider ``` @@ -71,7 +72,7 @@ That collection is then piped to the `Remove-CsHostingProvider` cmdlet, which de When this command completes there will no longer be any hosting providers configured for use. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsHostingProvider -Filter "*Fabrikam*" | Remove-CsHostingProvider ``` @@ -82,7 +83,7 @@ For example, this command returns such providers as Fabrikam.com, Fabrikam.net a The filtered collection is then piped to the `Remove-CsHostingProvider` cmdlet, which deletes each item in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsHostingProvider | Where-Object {$_.VerificationLevel -ne "AlwaysVerifiable"} | Remove-CsHostingProvider ``` @@ -93,7 +94,7 @@ The resulting collection is then piped to the `Where-Object` cmdlet, which picks The filtered collection is then piped to the `Remove-CsHostingProvider` cmdlet, which removes each provider in that collection. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Get-CsHostingProvider | Where-Object {$_.Enabled -eq $False} | Remove-CsHostingProvider ``` @@ -106,15 +107,35 @@ The filtered collection is then piped to the `Remove-CsHostingProvider` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the hosting provider to be removed. The Identity is a string value; the Identity might be the fully qualified domain name (FQDN) of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -123,14 +144,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -140,29 +163,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -176,14 +185,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider + The `Remove-CsHostingProvider` cmdlet accepts pipelined instances of the hosting provider object. ## OUTPUTS -### -None. +### None Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridApplicationEndpoint.md similarity index 80% rename from skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsHybridApplicationEndpoint.md index 947839dc20..899fedc75a 100644 --- a/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsHybridApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint +schema: 2.0.0 +title: Remove-CsHybridApplicationEndpoint --- # Remove-CsHybridApplicationEndpoint @@ -28,7 +29,7 @@ This cmdlet removes an existing hybrid application endpoint user object in Activ ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsHybridApplicationEndpoint -Identity "CN={4f6c99fe-7999-4088-ac4d-e88e0b3d3820},OU=Redmond,DC=litwareinc,DC=com" ``` @@ -37,30 +38,16 @@ This example removes the specified hybrid application endpoint including the Act ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Identity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Identity The ApplicationId for the endpoint that is being deleted. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 0 @@ -69,14 +56,34 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -101,8 +108,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint?view=skype-ps) -[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridPSTNSite.md similarity index 92% rename from skype/skype-ps/skype/Remove-CsHybridPSTNSite.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsHybridPSTNSite.md index 57891ebc8e..661ccd0d64 100644 --- a/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridPSTNSite.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshybridpstnsite applicable: Skype for Business Online -title: Remove-CsHybridPSTNSite -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshybridpstnsite +schema: 2.0.0 +title: Remove-CsHybridPSTNSite --- # Remove-CsHybridPSTNSite @@ -39,7 +41,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsHybridPSTNSite -Identity "SeattlePSTN" ``` @@ -49,31 +51,18 @@ This example removes the "SeattlePSTN" hybrid public switched telephone network ## PARAMETERS -### -Identity -Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: `-Identity "SeattlePSTN"`. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +### -Force -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +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: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -82,25 +71,29 @@ 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. +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the hybrid public switched telephone network (PSTN) site. +For example: `-Identity "SeattlePSTN"`. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. @@ -113,8 +106,25 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -124,6 +134,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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. @@ -131,7 +144,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 Required: False Position: Named @@ -145,13 +157,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsImConfiguration.md similarity index 80% rename from skype/skype-ps/skype/Remove-CsImConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsImConfiguration.md index 9b6ba26e08..648737338a 100644 --- a/skype/skype-ps/skype/Remove-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsImConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsImConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimconfiguration +schema: 2.0.0 +title: Remove-CsImConfiguration --- # Remove-CsImConfiguration @@ -27,7 +28,7 @@ Use the Remove-CsImConfiguration cmdlet to remove a new Instant Messaging (IM) c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsImConfiguration -Identity "Site:Redmond" ``` @@ -36,30 +37,16 @@ This example removes the existing Redmond site IM configuration. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -69,13 +56,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier specifying the scope and, in some cases the name, of the IM configuration. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -85,13 +74,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -101,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -130,8 +141,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimconfiguration?view=skype-ps) -[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsImFilterConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsImFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsImFilterConfiguration.md index 25c342bb06..2fc626cfb1 100644 --- a/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsImFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csimfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsImFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimfilterconfiguration +schema: 2.0.0 +title: Remove-CsImFilterConfiguration --- # Remove-CsImFilterConfiguration @@ -34,7 +35,7 @@ Running this cmdlet against the Global identity will simply reset the global con ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsImFilterConfiguration -Identity site:Redmond ``` @@ -43,7 +44,7 @@ In Example 1, the `Remove-CsImFilterConfiguration` cmdlet is used to remove the When an IM filter configuration is removed from a site, that site will automatically begin using the global settings in its place. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsImFilterConfiguration -Filter site:* | Remove-CsImFilterConfiguration ``` @@ -55,7 +56,28 @@ The filtered collection of configurations is then piped to the `Remove-CsImFilte ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identity of the configuration to be removed. This will be either Global or Site:\ (where \ represents the name of the site to which the settings apply). @@ -64,8 +86,7 @@ Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,14 +95,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -91,29 +114,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -127,13 +136,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration + Accepts pipelined input of IM filter configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsImTranslationConfiguration.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsImTranslationConfiguration.md index f3d59ef6ed..c1adf0646b 100644 --- a/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsImTranslationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsImTranslationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimtranslationconfiguration +schema: 2.0.0 +title: Remove-CsImTranslationConfiguration --- # Remove-CsImTranslationConfiguration @@ -27,7 +28,7 @@ This cmdlet is reserved for internal Microsoft use. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` This cmdlet is reserved for internal Microsoft use. ``` @@ -37,46 +38,52 @@ This cmdlet is reserved for internal Microsoft use. ## PARAMETERS -### -Identity +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -86,13 +93,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Remove-CsKerberosAccountAssignment.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsKerberosAccountAssignment.md index acd10f5224..f539bfc8ad 100644 --- a/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsKerberosAccountAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsKerberosAccountAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cskerberosaccountassignment +schema: 2.0.0 +title: Remove-CsKerberosAccountAssignment --- # Remove-CsKerberosAccountAssignment @@ -44,7 +45,7 @@ This removes the account's service principal name from Active Directory and comp ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsKerberosAccountAssignment -Identity "site:Redmond" @@ -54,7 +55,7 @@ Enable-CsTopology The commands shown in Example 1 remove the Kerberos account assignment from the Redmond site, then call the `Enable-CsTopology` cmdlet to finish disabling Kerberos web authentication. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsKerberosAccountAssignment | Remove-CsKerberosAccountAssignment @@ -69,15 +70,35 @@ When that's done, the second command in the example calls the `Enable-CsTopology ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, suppresses all error messages except for 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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the site where the Kerberos account assignment is to be removed. (This is the Identity of the site, not of the Kerberos account.) For example: `-Identity "site:Redmond"`. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -86,14 +107,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -When present, suppresses all error messages except for fatal errors. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -103,29 +126,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -139,14 +148,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment object. +### Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment + The `Remove-CsKerberosAccountAssignment` cmdlet accepts pipelined instances of the Kerberos account assignment object. ## OUTPUTS -### -None. +### None The `Remove-CsKerberosAccountAssignment` cmdlet does not return any objects or values. Instead, the cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment object. diff --git a/skype/skype-ps/skype/Remove-CsLisLocation.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisLocation.md similarity index 56% rename from skype/skype-ps/skype/Remove-CsLisLocation.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisLocation.md index ccca42e1b3..d9372beda3 100644 --- a/skype/skype-ps/skype/Remove-CsLisLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslislocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslislocation +schema: 2.0.0 +title: Remove-CsLisLocation --- # Remove-CsLisLocation @@ -51,7 +52,7 @@ You can use the `Remove-CsLisPort` cmdlet, the `Remove-CsLisSubnet` cmdlet, the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisLocation -Location Bldg30NEWing -HouseNumber 1000 -StreetName Main -City Redmond -State WA -Country US ``` @@ -63,7 +64,7 @@ If you don't supply parameter values for all non-null properties, the location w You will be prompted for any parameter that you haven't specified in the command, but if they contain null values you can simply press Enter at each prompt. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisLocation -Unreferenced | Remove-CsLisLocation ``` @@ -77,13 +78,15 @@ This collection is then piped to the `Remove-CsLisLocation` cmdlet, which remove ## PARAMETERS ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The location city. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -92,27 +95,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CompanyName -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CompanyName The name of the company at this location. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -121,28 +113,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this location is in. This value will contain two characters or less. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -151,28 +132,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumber -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumber The house number of the location. For a company this is the number on the street where the company is located. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -181,28 +151,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -211,27 +170,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Location -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Location The name for this location. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -240,27 +188,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostalCode -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostalCode The postal code associated with this location. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -269,28 +206,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -299,28 +225,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -329,28 +244,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. This value will be two characters or less. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -359,27 +263,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -388,27 +281,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -417,27 +299,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -446,14 +317,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -467,14 +340,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS location objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. -It removes an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLisPort.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisPort.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsLisPort.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisPort.md index 6a06ce9cb4..482e98b123 100644 --- a/skype/skype-ps/skype/Remove-CsLisPort.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisPort.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisPort -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslisport +schema: 2.0.0 +title: Remove-CsLisPort --- # Remove-CsLisPort @@ -40,7 +41,7 @@ If you attempt to remove a port that does not exist, no action will be taken and ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisPort -ChassisID 99-99-99-99-99-99 -PortID 4200 -PortIDSubType 1 ``` @@ -52,7 +53,7 @@ This parameter and value could also have been entered like this: `-PortIDSubType If this port was associated with a location, that location will not be removed, only the port will be removed from the location mapping. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisPort | Where-Object {$_.HouseNumber -eq ""} | Remove-CsLisPort ``` @@ -70,14 +71,16 @@ You can remove locations by calling the `Remove-CsLisLocation` cmdlet. ## PARAMETERS ### -ChassisID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -PortID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The ID of the port you want to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -PortIDSubType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The subtype of the port you want to remove. This value can be entered as a numeric value or a string, but it must be a valid subtype. Valid subtypes are: @@ -116,8 +124,7 @@ Valid subtypes are: ```yaml Type: PortIDSubType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -126,14 +133,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -142,14 +151,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -163,14 +174,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS port objects. ## OUTPUTS -### +### None This cmdlet does not return a value. -It removes an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLisServiceProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisServiceProvider.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsLisServiceProvider.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisServiceProvider.md index e7c73e5c72..2bae110582 100644 --- a/skype/skype-ps/skype/Remove-CsLisServiceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisServiceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisserviceprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisServiceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslisserviceprovider +schema: 2.0.0 +title: Remove-CsLisServiceProvider --- # Remove-CsLisServiceProvider @@ -31,7 +32,7 @@ This cmdlet removes an entry for a provider; after running this cmdlet there wil ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisServiceProvider ``` @@ -42,14 +43,16 @@ There will only be, at most, one service provider defined, which will be removed ## PARAMETERS -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -58,14 +61,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -79,14 +84,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of a Location Information Server (LIS) service provider object. ## OUTPUTS -### +### None This cmdlet does not return an object or a value. -It removes an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLisSubnet.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSubnet.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsLisSubnet.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisSubnet.md index 3ce56e33d1..f045080bee 100644 --- a/skype/skype-ps/skype/Remove-CsLisSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslissubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslissubnet +schema: 2.0.0 +title: Remove-CsLisSubnet --- # Remove-CsLisSubnet @@ -36,7 +37,7 @@ If you attempt to remove a subnet that does not exist, no action will be taken a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisSubnet -Subnet 192.10.10.0 ``` @@ -48,7 +49,7 @@ The value of the Subnet in this example is an IPv4 address, 192.10.10.0. If this subnet is associated with a location, that location will not be removed, only the subnet will be removed from the location mapping. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisSubnet | Where-Object {$_.Location -eq "Bldg30/Room1000"} | Remove-CsLisSubnet ``` @@ -65,6 +66,9 @@ You can remove locations by calling the `Remove-CsLisLocation` cmdlet. ## PARAMETERS ### -Subnet + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The IP address of the subnet you want to remove. This value will be an IPv4 address (digits separated by periods, such as 192.0.2.0). @@ -72,8 +76,7 @@ This value will be an IPv4 address (digits separated by periods, such as 192.0.2 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -82,14 +85,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -98,14 +103,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -119,13 +126,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of Location Information Server (LIS) subnet objects. ## OUTPUTS -### -This cmdlet removes an object of type System.Management.Automation.PSCustomObject. +### None +This cmdlet does not return an object or a value. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLisSwitch.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSwitch.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsLisSwitch.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisSwitch.md index 5ef8122f1d..1a0542f488 100644 --- a/skype/skype-ps/skype/Remove-CsLisSwitch.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSwitch.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisswitch applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisSwitch -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslisswitch +schema: 2.0.0 +title: Remove-CsLisSwitch --- # Remove-CsLisSwitch @@ -39,7 +40,7 @@ If you attempt to remove a switch that does not exist, no action will be taken a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisSwitch -ChassisID 99-99-99-99-99-99 ``` @@ -50,7 +51,7 @@ This command will not succeed if the ChassisID is referenced by a port. Also, if this switch was associated with a location, that location will not be removed, only the switch will be removed from the location mapping. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisSwitch | Where-Object {$_.City -eq ""} | Remove-CsLisSwitch ``` @@ -68,14 +69,16 @@ You can remove locations by calling the `Remove-CsLisLocation` cmdlet. ## PARAMETERS ### -ChassisID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Media Access Control (MAC) address of the network switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -84,14 +87,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -100,14 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -121,14 +128,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS switch objects. ## OUTPUTS -### +### None This cmdlet does not return a value. -It removes an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisWirelessAccessPoint.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisWirelessAccessPoint.md index 044104f835..baa16b074d 100644 --- a/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisWirelessAccessPoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csliswirelessaccesspoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisWirelessAccessPoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csliswirelessaccesspoint +schema: 2.0.0 +title: Remove-CsLisWirelessAccessPoint --- # Remove-CsLisWirelessAccessPoint @@ -36,7 +37,7 @@ If you attempt to remove a WAP that does not exist, no action will be taken and ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisWirelessAccessPoint -BSSID 99-99-99-99-99-99 ``` @@ -46,7 +47,7 @@ Example 1 removes the LIS WAP location with the BSSID 99-99-99-99-99-99. If this WAP was associated with a location, that location will not be removed, only the WAP will be removed from the location mapping. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisWirelessAccessPoint | Where-Object {$_.Location -like "*Bldg30*"} | Remove-CsLisWirelessAccessPoint ``` @@ -62,14 +63,16 @@ Note that, as in Example 1, no locations are removed from the location configura ## PARAMETERS ### -BSSID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Basic Service Set Identifier (BSSID) of the wireless access point you want to remove. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -78,14 +81,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -94,14 +99,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -115,13 +122,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS wireless access point objects. ## OUTPUTS -### -This cmdlet removes an object of type System.Management.Automation.PSCustomObject. +### None +This cmdlet does not return an object or a value. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLocationPolicy.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLocationPolicy.md index b6aa1cf457..8f7612a3d6 100644 --- a/skype/skype-ps/skype/Remove-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslocationpolicy +schema: 2.0.0 +title: Remove-CsLocationPolicy --- # Remove-CsLocationPolicy @@ -38,7 +39,7 @@ If this cmdlet is run against a per-user location policy that is assigned to use ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLocationPolicy -Identity Reno ``` @@ -48,7 +49,7 @@ When a per-user policy is removed, users or groups who were assigned that policy If no policy has been configured for their site, then these users and groups will use the global location policy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLocationPolicy | Where-Object {$_.EnhancedEmergencyServicesEnabled -eq $false} | Remove-CsLocationPolicy ``` @@ -61,7 +62,29 @@ Finally, this filtered collection is passed to the `Remove-CsLocationPolicy` cmd ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifying this parameter will bypass any confirmation prompts and the deletion will occur without any warning notice. +For example, if a per-user location policy is assigned to one or more users, a confirmation prompt will be displayed before deletion if this parameter is not included in 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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the location policy you want to remove. To remove the global location policy (which simply resets that policy to its default values), use a value of Global. For a policy created at the site scope, this value will be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment (for example, site:Redmond). @@ -71,8 +94,7 @@ For a policy created at the per-user scope, this value will simply be the name o ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -81,31 +103,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Specifying this parameter will bypass any confirmation prompts and the deletion will occur without any warning notice. -For example, if a per-user location policy is assigned to one or more users, a confirmation prompt will be displayed before deletion if this parameter is not included in the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the location policy is being removed. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,13 +129,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -130,21 +146,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the location policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -158,13 +169,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy + Accepts pipelined input of location policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy This cmdlet does not return a value or object. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy object. diff --git a/skype/skype-ps/skype/Remove-CsManagementConnection.md b/skype/skype-ps/SkypeForBusiness/Remove-CsManagementConnection.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsManagementConnection.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsManagementConnection.md index 6df3c26265..f3fb47548f 100644 --- a/skype/skype-ps/skype/Remove-CsManagementConnection.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsManagementConnection.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmanagementconnection applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsManagementConnection -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csmanagementconnection +schema: 2.0.0 +title: Remove-CsManagementConnection --- # Remove-CsManagementConnection @@ -41,7 +42,7 @@ Note, too that this cmdlet only affects the management connection information fo ## EXAMPLES -### ------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsManagementConnection ``` @@ -51,14 +52,16 @@ The command shown in Example 1 removes the existing management connection inform ## PARAMETERS -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -67,14 +70,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -88,14 +93,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsManagementConnection` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsManagementConnection` cmdlet deletes instances of the Microsoft.Rtc.Management.Xds.ManagementConnection object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMcxConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsMcxConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsMcxConfiguration.md index 87060d1bca..1e9e9a1a17 100644 --- a/skype/skype-ps/skype/Remove-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMcxConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmcxconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsMcxConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csmcxconfiguration +schema: 2.0.0 +title: Remove-CsMcxConfiguration --- # Remove-CsMcxConfiguration @@ -46,7 +47,7 @@ Instead, the properties in the global collection will simply be reset to their d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsMcxConfiguration -Identity "site:Redmond" ``` @@ -54,7 +55,7 @@ Remove-CsMcxConfiguration -Identity "site:Redmond" The command shown in Example 1 deletes the collection of Mobility Service configuration settings assigned to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMcxConfiguration -Filter "service:*" | Remove-CsMcxConfiguration ``` @@ -64,7 +65,7 @@ To do this, the `Get-CsMcxConfiguration` cmdlet is used along with the Filter pa That filtered collection is then piped to and deleted by, the `Remove-CsMcxConfiguration` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMcxConfiguration | Where-Object {$_.ExposedWebURL -eq "Internal"} | Remove-CsMcxConfiguration ``` @@ -75,7 +76,7 @@ This collection is then piped to the `Where-Object` cmdlet, which picks out only In turn, that filtered collection is piped to the `Remove-CsMcxConfiguration` cmdlet, which deletes each item in that filtered collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMcxConfiguration | Where-Object {$_.PushNotificationProxyUri -eq $Null} | Remove-CsMcxConfiguration ``` @@ -88,7 +89,28 @@ Any settings that meet that criterion are then piped to and deleted by, the `Rem ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the Mobility Service configuration settings to be removed. To "remove" the global settings, use this syntax: @@ -109,8 +131,7 @@ You cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -120,13 +141,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -135,30 +158,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -172,14 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration. +### Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration The `Remove-CsMcxConfiguration` cmdlet accepts pipelined input of McxConfiguration objects. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.McxConfiguration.McxConfiguration Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMediaConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsMediaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsMediaConfiguration.md index afa18b9584..b4f59d6cb7 100644 --- a/skype/skype-ps/skype/Remove-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMediaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsMediaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csmediaconfiguration +schema: 2.0.0 +title: Remove-CsMediaConfiguration --- # Remove-CsMediaConfiguration @@ -33,7 +34,7 @@ In that case, however, the settings will not actually be removed; instead, they ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsMediaConfiguration -Identity site:Redmond1 ``` @@ -42,7 +43,7 @@ In Example 1, the `Remove-CsMediaConfiguration` cmdlet is used to delete the med When media settings are removed from the site scope, that site will automatically begin to use the global media settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMediaConfiguration | Where-Object {$_.EncryptionLevel -eq "RequireEncryption"} | Remove-CsMediaConfiguration ``` @@ -53,7 +54,7 @@ That information is then piped to the `Where-Object` cmdlet, which applies a fil Finally, that filtered set of data is passed to the `Remove-CsMediaConfiguration` cmdlet, which deletes each item in the set. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMediaConfiguration -Filter service:* | Remove-CsMediaConfiguration ``` @@ -66,15 +67,35 @@ That set of collections is then piped the `Remove-CsMediaConfiguration` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the media configuration settings you want to remove. This identifier specifies the scope at which this configuration is applied (global, site, or service). ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -83,14 +104,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -100,29 +123,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -136,13 +145,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings + Accepts pipelined input of media configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMeetingConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsMeetingConfiguration.md index 29096e1294..fd6a2d0e14 100644 --- a/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMeetingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmeetingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsMeetingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csmeetingconfiguration +schema: 2.0.0 +title: Remove-CsMeetingConfiguration --- # Remove-CsMeetingConfiguration @@ -41,7 +42,7 @@ Instead, all the properties in the global collection will be reset to their defa ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsMeetingConfiguration -Identity site:Redmond ``` @@ -50,7 +51,7 @@ In Example 1, the meeting configuration settings that have the Identity site:Red When these settings are removed from the Redmond site users in that site will automatically inherit the global meeting configuration settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsMeetingConfiguration -Filter "site:*" | Remove-CsMeetingConfiguration ``` @@ -60,7 +61,7 @@ To do this, the command first calls the `Get-CsMeetingConfiguration` cmdlet alon This filtered collection is then piped to the `Remove-CsMeetingConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsMeetingConfiguration | Where-Object {$_.AdmitAnonymousUsersByDefault -eq $True} | Remove-CsMeetingConfiguration ``` @@ -73,7 +74,28 @@ The filtered collection is then piped to the `Remove-CsMeetingConfiguration` cmd ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the meeting configuration settings to be removed. To "remove" the global settings, use this syntax: `-Identity global`. (As noted previously, you cannot actually remove the global settings; all you can do is reset the properties to their default values.) To remove settings from the site scope, use syntax similar to this: `-Identity site:Redmond.` @@ -84,8 +106,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -94,23 +115,10 @@ 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 Server 2015, Skype for Business Server 2019 +### -Tenant -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Tenant Globally unique identifier (GUID) of the Skype for Business Online tenant account for the meeting configuration settings being deleted. For example: @@ -124,8 +132,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,14 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -150,14 +159,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -171,14 +182,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration + The `Remove-CsMeetingConfiguration` cmdlet accepts pipelined instances of the meeting configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsMeetingConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMobilityPolicy.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsMobilityPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsMobilityPolicy.md index bf1e210f0e..0c669d59d2 100644 --- a/skype/skype-ps/skype/Remove-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMobilityPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmobilitypolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsMobilityPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csmobilitypolicy +schema: 2.0.0 +title: Remove-CsMobilityPolicy --- # Remove-CsMobilityPolicy @@ -53,7 +55,7 @@ In this case, that means enabling Call via Work. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsMobilityPolicy -Identity "site:Redmond" ``` @@ -62,7 +64,7 @@ The command shown in Example 1 removes the mobility policy configured for the Re When the policy is removed, users previously managed by the Redmond site policy will now be managed by the global policy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMobilityPolicy -Filter "tag:*" | Remove-CsMobilityPolicy ``` @@ -72,7 +74,7 @@ To do this, the command first uses the `Get-CsMobilityPolicy` cmdlet and the Fil That collection of per-user policies is then piped to the `Remove-CsMobilityPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMobilityPolicy | Where-Object {$_.EnableOutsideVoice -eq $False} | Remove-CsMobilityPolicy ``` @@ -85,7 +87,34 @@ Any policies where EnableOutsideVoice is False are then piped to and removed by, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is present, the policy will be removed even if it is currently assigned to at least one user. +If this parameter is not present, then the `Remove-CsMobilityPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. +Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. +You must answer yes (by pressing the Y key) before the command will continue and the policy is removed. + +This parameter applies only to per-user policies. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the client policy to be removed. To "remove" the global policy, use the following syntax: @@ -108,8 +137,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -118,37 +146,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the mobility policy is being removed. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -Force -If this parameter is present, the policy will be removed even if it is currently assigned to at least one user. -If this parameter is not present, then the `Remove-CsMobilityPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. -Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. -You must answer yes (by pressing the Y key) before the command will continue and the policy is removed. +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: -This parameter applies only to per-user policies. +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,15 +172,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -174,22 +191,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the mobility policy is being removed. -For example: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -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` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -203,14 +215,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility. +### Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility The `Remove-CsMobilityPolicy` cmdlet accepts pipelined instances of the Mobility object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility Instead, the `Remove-CsMobilityPolicy` cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkBandwidthPolicyProfile.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkBandwidthPolicyProfile.md index 134bd4667f..0b7eca21ae 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkBandwidthPolicyProfile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkBandwidthPolicyProfile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkbandwidthpolicyprofile +schema: 2.0.0 +title: Remove-CsNetworkBandwidthPolicyProfile --- # Remove-CsNetworkBandwidthPolicyProfile @@ -35,7 +36,7 @@ You must first remove the profile from all sites, inter-site policies and networ ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile ``` @@ -44,7 +45,7 @@ This example removes the bandwidth policy profile with the Identity LowBWProfile Because identities must be unique this will remove, at most, one profile. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSite | Where-Object {$_.BWPolicyProfileID -eq "LowBWProfile"} | Set-CsNetworkSite -BWPolicyProfileID $null @@ -64,15 +65,35 @@ To ensure that the profile is not in use anywhere in the network configuration, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string value that uniquely identifies the bandwidth policy profile you want to remove. Specifying an Identity will remove, at most, one profile. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -81,14 +102,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -98,29 +121,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -134,13 +143,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType + Accepts pipelined input of network bandwidth policy profile objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkConfiguration.md similarity index 81% rename from skype/skype-ps/skype/Remove-CsNetworkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkConfiguration.md index ae7068d77e..8a01796d96 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkconfiguration +schema: 2.0.0 +title: Remove-CsNetworkConfiguration --- # Remove-CsNetworkConfiguration @@ -30,7 +31,7 @@ WARNING: Running this cmdlet will delete an entire network configuration, includ ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkConfiguration -Identity Global -Confirm ``` @@ -41,14 +42,34 @@ The Confirm parameter is used so you'll be prompted to verify you really want to ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This will always be Global. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -57,14 +78,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. +It is recommended that you always use this parameter with this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -74,30 +98,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. -It is recommended that you always use this parameter with this cmdlet. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -111,13 +120,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings + Accepts pipelined input of a network configuration object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings This cmdlet does not return an object. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object. diff --git a/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterRegionRoute.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterRegionRoute.md index 3df20e1a1b..fbbedcfe58 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterRegionRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkInterRegionRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkinterregionroute +schema: 2.0.0 +title: Remove-CsNetworkInterRegionRoute --- # Remove-CsNetworkInterRegionRoute @@ -32,7 +33,7 @@ This cmdlet removes one of these route associations. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkInterRegionRoute -Identity NA_APAC_Route ``` @@ -40,7 +41,7 @@ Remove-CsNetworkInterRegionRoute -Identity NA_APAC_Route Example 1 removes the route with the Identity NA_APAC_Route. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkInterRegionRoute | Where-Object {$_.NetworkRegionID1 -eq "NorthAmerica" -or $_.NetworkRegionID2 -eq "NorthAmerica"} | Remove-CsNetworkInterRegionRoute ``` @@ -56,7 +57,28 @@ Once the collection contains only the routes that include the NorthAmerica regio ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier for the network region route you want to remove. Network region routes are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that route. @@ -64,8 +86,7 @@ Instead, it contains a string that is a unique name that identifies that route. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,14 +95,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -91,29 +114,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -127,13 +136,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType + Accepts pipelined input of network inter-region route objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterSitePolicy.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterSitePolicy.md index 8dc5aaec89..2d812a3bbe 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterSitePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkInterSitePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkintersitepolicy +schema: 2.0.0 +title: Remove-CsNetworkInterSitePolicy --- # Remove-CsNetworkInterSitePolicy @@ -31,7 +32,7 @@ This cmdlet removes a network site policy that associates a bandwidth limitation ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkInterSitePolicy -Identity Reno_Portland ``` @@ -39,7 +40,7 @@ Remove-CsNetworkInterSitePolicy -Identity Reno_Portland This example removes the network site policy with the Identity Reno_Portland. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkInterSitePolicy | Remove-CsNetworkInterSitePolicy ``` @@ -51,7 +52,28 @@ That collection is then piped to the `Remove-CsNetworkInterSitePolicy` cmdlet, w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the network site policy you want to remove. Network site policies are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that site policy. @@ -59,8 +81,7 @@ Instead, it contains a string that is a unique name that identifies that site po ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -69,14 +90,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -86,29 +109,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -122,13 +131,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType + Accepts pipelined input of network inter-site policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegion.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsNetworkRegion.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegion.md index 3f35e18280..9d0c8b4c1c 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkregion +schema: 2.0.0 +title: Remove-CsNetworkRegion --- # Remove-CsNetworkRegion @@ -37,7 +38,7 @@ If you attempt to remove a region associated with a site you'll receive an error ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkRegion -Identity NorthAmerica ``` @@ -46,7 +47,7 @@ Example 1 removes the network region with the Identity NorthAmerica. Because identities are unique this command removes only one network region. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkRegion | Where-Object {$_.CentralSite -eq "site:Redmond"} | Remove-CsNetworkRegion ``` @@ -58,7 +59,7 @@ The `Where-Object` cmdlet filters this collection to return only those items (ne After narrowing the collection down to those items, this new collection is piped to the `Remove-CsNetworkRegion` cmdlet, which removes every item in that collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkSite | Where-Object {$_.NetworkRegionID -eq "NorthAmerica"} | Set-CsNetworkSite -NetworkRegionID $null -BypassID $null @@ -84,15 +85,35 @@ At this point we can call line 2, which removes the network region. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the network region you want to remove. The Identity will be in the form of a string that uniquely identifies that region. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -101,14 +122,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -118,29 +141,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -154,13 +163,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType + Accepts pipelined input of network region objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegionLink.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsNetworkRegionLink.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegionLink.md index 57fec11fcc..4dad446e0e 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegionLink.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkRegionLink -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkregionlink +schema: 2.0.0 +title: Remove-CsNetworkRegionLink --- # Remove-CsNetworkRegionLink @@ -31,7 +32,7 @@ This cmdlet does not impact any physical connections, but it does remove the lin ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkRegionLink -Identity NA_EMEA ``` @@ -39,7 +40,7 @@ Remove-CsNetworkRegionLink -Identity NA_EMEA This first example removes the network region link with the Identity NA_EMEA. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkRegionLink | Where-Object {$_.BWPolicyProfileID -eq "HighBWLimits"} | Remove-CsNetworkRegionLink ``` @@ -53,7 +54,28 @@ If this property is equal to (-eq) HighBWLimits, we pipe that member to the `Rem ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the network region link you want to remove. Network region links are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that link. @@ -61,8 +83,7 @@ Instead, it contains a string that is a unique name that identifies that link. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -71,14 +92,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -88,29 +111,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -124,13 +133,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType + Accepts pipelined input of network region link objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSite.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsNetworkSite.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSite.md index 385a4f9411..ef8101ac63 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworksite +schema: 2.0.0 +title: Remove-CsNetworkSite --- # Remove-CsNetworkSite @@ -30,7 +31,7 @@ This cmdlet removes a site from the CAC or E9-1-1 configuration. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkSite -Identity Vancouver ``` @@ -38,7 +39,7 @@ Remove-CsNetworkSite -Identity Vancouver This example removes the site with the Identity Vancouver from the CAC or E9-1-1 configuration. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSite | Where-Object {$_.BWPolicyProfileID -eq "LowBWProfile"} | Remove-CsNetworkSite ``` @@ -51,7 +52,28 @@ This new collection is then piped to the `Remove-CsNetworkSite` cmdlet to remove ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the network site you want to remove. Sites are created only at the global scope, so you do not need to specify a scope. Instead, you need to specify only the site ID. @@ -59,8 +81,7 @@ Instead, you need to specify only the site ID. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -69,14 +90,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -86,29 +109,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -122,13 +131,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType + Accepts pipelined input of network site objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSubnet.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsNetworkSubnet.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSubnet.md index 60a89146b9..9efea2b384 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworksubnet +schema: 2.0.0 +title: Remove-CsNetworkSubnet --- # Remove-CsNetworkSubnet @@ -31,7 +32,7 @@ Use this cmdlet to remove a network subnet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkSubnet -Identity 172.11.15.0 ``` @@ -39,7 +40,7 @@ Remove-CsNetworkSubnet -Identity 172.11.15.0 This example removes the subnet with the Identity (the Subnet ID) 172.11.15.0. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSubnet | Where-Object {$_.NetworkSiteID -eq "Vancouver"} | Remove-CsNetworkSubnet ``` @@ -54,15 +55,35 @@ Now that the collection consists only of subnets associated with the Vancouver s ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique subnet ID of the subnet you want to remove. This value will be an IP address (such as 174.11.12.0). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -71,14 +92,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -88,29 +111,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -124,13 +133,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType + Accepts pipelined input of network subnet objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType. diff --git a/skype/skype-ps/skype/Remove-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsOAuthServer.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsOAuthServer.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsOAuthServer.md index 8841ad2fa5..ea253a6da1 100644 --- a/skype/skype-ps/skype/Remove-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsOAuthServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsOAuthServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csoauthserver +schema: 2.0.0 +title: Remove-CsOAuthServer --- # Remove-CsOAuthServer @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOAuthServer -Identity "Office365" ``` @@ -47,7 +48,7 @@ Remove-CsOAuthServer -Identity "Office365" The command shown in Example 1 deletes a single OAuth server: the server with the identity "Office 365". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOAuthServer | Remove-CsOAuthServer ``` @@ -59,33 +60,16 @@ These servers are then piped to, and removed by, the `Remove-CsOAuthServer` cmdl ## PARAMETERS -### -Identity -Unique identifier for the OAuth server to be deleted. -For example: - -`-Identity "Office 365"` - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,23 +78,31 @@ 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. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the OAuth server to be deleted. +For example: + +`-Identity "Office 365"` ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for the OAuth server being deleted. For example: @@ -125,8 +117,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -156,14 +167,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated The `Remove-CsOAuthServer` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object. ## OUTPUTS -### -None. -Instead, the `Remove-CsOAuthServer` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundCallingNumberTranslationRule.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsOutboundCallingNumberTranslationRule.md index 340683cf93..1753105e4b 100644 --- a/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundCallingNumberTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsOutboundCallingNumberTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csoutboundcallingnumbertranslationrule +schema: 2.0.0 +title: Remove-CsOutboundCallingNumberTranslationRule --- # Remove-CsOutboundCallingNumberTranslationRule @@ -41,7 +42,7 @@ Select the rule to be deleted and then click Remove. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond/SevenDigit" ``` @@ -49,7 +50,7 @@ Remove-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond/SevenDigit The command shown in Example 1 removes the outbound calling number translation rule that has the Identity site:Redmond/SevenDigit. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Remove-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond" ``` @@ -58,7 +59,7 @@ In Example 2, all the outbound calling number translation rules configured for t To do this, the command calls the `Remove-CsOutboundCallingNumberTranslationRule` cmdlet along with the Identity parameter; the parameter value "site:Redmond" ensures that all the translation rules configured for the Redmond site will be removed. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOutboundCallingNumberTranslationRule | Where-Object {$_.Pattern -eq '^\+1425(\d{7})$'} | Remove-CsOutboundCallingNumberTranslationRule ``` @@ -71,7 +72,28 @@ That filtered collection is then piped to the `Remove-CsOutboundCallingNumberTra ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the outbound translation rule you want to remove. The Identity consists of the scope followed by a unique name within each scope. For example: @@ -81,8 +103,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -92,13 +113,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -107,30 +130,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -144,14 +153,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated The `Remove-CsOutboundCallingNumberTranslationRule` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated object. ## OUTPUTS -### -None. -Instead, the `Remove-CsOutboundCallingNumberTranslationRule` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundTranslationRule.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsOutboundTranslationRule.md index 4ead086ae1..b1ba48b5fe 100644 --- a/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsOutboundTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csoutboundtranslationrule +schema: 2.0.0 +title: Remove-CsOutboundTranslationRule --- # Remove-CsOutboundTranslationRule @@ -36,7 +37,7 @@ That means that using this cmdlet to remove a rule will remove it from the trunk ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond" ``` @@ -45,7 +46,7 @@ This example removes an existing outbound translation rule for site Redmond name Identities are unique, so this command will delete a single rule. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOutboundTranslationRule -Filter site:* | Remove-CsOutboundTranslationRule ``` @@ -57,7 +58,28 @@ This collection is then piped to the `Remove-CsOutboundTranslationRule` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the outbound translation rule you want to remove. The Identity consists of the scope followed by a unique name within each scope. For example, `site:Redmond/OutboundRule1`. @@ -65,8 +87,7 @@ For example, `site:Redmond/OutboundRule1`. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -75,14 +96,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -92,29 +115,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -128,13 +137,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule + Accepts pipelined input of outbound translation rule objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule. diff --git a/skype/skype-ps/skype/Remove-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPartnerApplication.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsPartnerApplication.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPartnerApplication.md index 1095f08f13..f7851f9f5f 100644 --- a/skype/skype-ps/skype/Remove-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPartnerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPartnerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspartnerapplication +schema: 2.0.0 +title: Remove-CsPartnerApplication --- # Remove-CsPartnerApplication @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPartnerApplication -Identity "MicrosoftExchange" ``` @@ -47,7 +48,7 @@ Remove-CsPartnerApplication -Identity "MicrosoftExchange" The command shown in Example 1 deletes the partner application with the Identity "MicrosoftExchange". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPartnerApplication | Remove-CsPartnerApplication ``` @@ -57,7 +58,7 @@ To do this, the command first uses the `Get-CsPartnerApplication` cmdlet in orde This collection is then piped to the `Remove-CsPartnerApplication` cmdlet, which deletes each application in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPartnerApplication | Where-Object {$_.ApplicationTrustLevel -ne "Full"} | Remove-CsPartnerApplication ``` @@ -70,7 +71,28 @@ The applications that meet that criterion are then piped to and removed by, the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the partner application to be removed. For example: @@ -81,8 +103,7 @@ Note that you cannot use wildcard characters when specifying an Identity. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -91,30 +112,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the partner application being deleted. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,22 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the partner application being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -Confirm -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -148,13 +157,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -168,14 +179,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated The `Remove-CsPartnerApplication` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPartnerApplication` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatAddin.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsPersistentChatAddin.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatAddin.md index 40d9000d06..b6107e3f34 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatAddin.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Remove-CsPersistentChatAddin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchataddin +schema: 2.0.0 +title: Remove-CsPersistentChatAddin --- # Remove-CsPersistentChatAddin @@ -47,7 +48,7 @@ Select the add-in to be removed, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITChatAddin" ``` @@ -55,7 +56,7 @@ Remove-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITChatAddin" Example 1 removes the Persistent Chat add-in ITChatAddin found on the pool `atl-cs-001.litwareinc.com`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatAddin | Remove-CsPersistentChatAddin ``` @@ -67,7 +68,28 @@ This collection is piped to the `Remove-CsPersistentChatAddin` cmdlet, which the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command; for example, attempting to remove an add-in that is currently associated with one or more chat rooms. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat add-in to be removed. The Identity is composed of the fully qualified domain name of the Persistent Chat pool where the add-in is located, a "\" character and the add-in name. For example: @@ -77,8 +99,7 @@ For example: ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -88,13 +109,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet. ```yaml Type: Addin Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -104,13 +127,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -119,30 +144,16 @@ 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; for example, attempting to remove an add-in that is currently associated with one or more chat rooms. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -156,15 +167,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject The `Remove-CsPersistentChatAddin` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object. The cmdlet will also accept a string value representing the Identity of an existing add-in. ## OUTPUTS -### -None. -Instead, the `Remove-CsPersistentChatAddin` cmdlet deletes existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatCategory.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsPersistentChatCategory.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatCategory.md index 658c5fe6a8..4719f0f8b4 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatCategory.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Remove-CsPersistentChatCategory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatcategory +schema: 2.0.0 +title: Remove-CsPersistentChatCategory --- # Remove-CsPersistentChatCategory @@ -53,7 +54,7 @@ Select the category to be removed, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatCategory -Identity "atl-cs-001.litwareinc.com\helpdesk" ``` @@ -61,7 +62,7 @@ Remove-CsPersistentChatCategory -Identity "atl-cs-001.litwareinc.com\helpdesk" The command shown in Example 1 removes the Persistent Chat category that has the Identity `"atl-cs-001.litwareinc.com\helpdesk"`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatCategory | Remove-CsPersistentChatCategory ``` @@ -74,6 +75,9 @@ This collection is piped to the `Remove-CsPersistentChatCategory` cmdlet, which ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat category to be removed. An Identity consists of the PoolFqdn plus the category Name; for example: @@ -82,8 +86,7 @@ An Identity consists of the PoolFqdn plus the category Name; for example: ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -93,13 +96,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet. ```yaml Type: Category Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -145,15 +154,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject The `Remove-CsPersistentChatCategory` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object. The cmdlet will also accept string values representing the Identity of an existing Persistent Chat category. ## OUTPUTS -### -None. -Instead, the `Remove-CsPersistentChatCategory` cmdlet deletes existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatComplianceConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatComplianceConfiguration.md index cfca03a5d7..838d7744e2 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatComplianceConfiguration.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2015 -title: Remove-CsPersistentChatComplianceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatcomplianceconfiguration +schema: 2.0.0 +title: Remove-CsPersistentChatComplianceConfiguration --- # Remove-CsPersistentChatComplianceConfiguration @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatComplianceConfiguration -Identity "site:Redmond" ``` @@ -48,7 +49,7 @@ Remove-CsPersistentChatComplianceConfiguration -Identity "site:Redmond" Example 1 removes the Persistent Chat compliance configuration settings applied to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatComplianceConfiguration -Filter "site:*" | Remove-CsPersistentChatComplianceConfiguration ``` @@ -58,7 +59,7 @@ To do that, the command first uses the `Get-CsPersistentChatComplianceConfigurat After the site-scoped settings have been retrieved, they are then piped to and removed by, the `Remove-CsPersistentChatComplianceConfiguration` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatComplianceConfiguration | Where-Object {$_.AddUserDetals -eq $True -and $_.AddChatRoomDetails -eq $True} | Remove-CsPersistentChatComplianceConfiguration ``` @@ -71,7 +72,28 @@ This filtered collection is then piped to the `Remove-CsPersistentChatCompliance ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat compliance settings to be removed. To remove a collection of settings configured at the site scope, use syntax similar to this: @@ -91,8 +113,7 @@ Instead, all the properties within that collection will be reset to their defaul ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 2 @@ -102,13 +123,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -117,30 +140,16 @@ 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 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -154,14 +163,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration The `Remove-CsPersistentChatComplianceConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPersistentChatComplianceConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatConfiguration.md index 9ad34a8583..2325cfabd1 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatConfiguration.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Remove-CsPersistentChatConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatconfiguration +schema: 2.0.0 +title: Remove-CsPersistentChatConfiguration --- # Remove-CsPersistentChatConfiguration @@ -40,7 +41,7 @@ Select the collection to be removed, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatConfiguration -Identity "site:Redmond" ``` @@ -48,7 +49,7 @@ Remove-CsPersistentChatConfiguration -Identity "site:Redmond" The command shown in Example 1 deletes the Persistent Chat configuration settings for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatConfiguration -Filter "site:*" | Remove-CsPersistentChatConfiguration ``` @@ -58,7 +59,7 @@ To do this, the command first employs the `Get-CsPersistentChatConfiguration` cm These settings are then piped to the `Remove-CsPersistentChatConfiguration` cmdlet, which deletes all the settings applied to the site scope. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatConfiguration | Where-Object {$_.DefaultChatHistory -gt 30} | Remove-CsPersistentChatConfiguration ``` @@ -71,7 +72,28 @@ The filtered collection is then piped to the `Remove-CsPersistentChatConfigurati ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat configuration settings to be removed. To remove a collection of settings configured at the site scope, use syntax similar to this: @@ -91,8 +113,7 @@ Instead, all the properties within that collection will be reset to their defaul ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 2 @@ -102,13 +123,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -117,30 +140,16 @@ 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 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -154,14 +163,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration The `Remove-CsPersistentChatConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPersistentChatConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatEndpoint.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatEndpoint.md index 7443eaddef..11ae584baa 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatendpoint applicable: Lync Server 2013, Skype for Business Server 2015 -title: Remove-CsPersistentChatEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatendpoint +schema: 2.0.0 +title: Remove-CsPersistentChatEndpoint --- # Remove-CsPersistentChatEndpoint @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatEndpoint -Identity "sip:pce@litwareinc.com" ``` @@ -48,7 +49,7 @@ The command shown in Example 1 deletes the Persistent Chat endpoint that has the In this example, the SIP address is used for the Identity -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatEndpoint -PersistentChatPoolFqdn "atl-pcpool-001.litwareinc.com" | Remove-CsPersistentChatEndpoint ``` @@ -58,7 +59,7 @@ To carry out this task, the command first uses the `Get-CsPersistentChatEndpoint The endpoints in that collection are then piped to and removed by, the `Remove-CsPersistentChatEndpoint` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatEndpoint | Remove-CsPersistentChatEndpoint ``` @@ -70,7 +71,28 @@ This collection is then piped to the `Remove-CsPersistentChatEndpoint` cmdlet, w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat endpoint to be removed. Endpoint Identities are typically specified using the endpoint's SIP address or display name; for example: @@ -83,8 +105,7 @@ However, you can also use the full Identity of the endpoint; for example: ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -94,13 +115,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -109,30 +132,16 @@ 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 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -146,13 +155,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSPersistentChatContact The `Remove-CsPersistentChatEndpoint` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSPersistentChatContact class. ## OUTPUTS -### -None. +### None The `Remove-CsPersistentChatEndpoint` cmdlet does not return objects or data. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatMessage.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsPersistentChatMessage.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatMessage.md index dd1b9a62b1..6f188703de 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatMessage.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Remove-CsPersistentChatMessage -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatmessage +schema: 2.0.0 +title: Remove-CsPersistentChatMessage --- # Remove-CsPersistentChatMessage @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatMessage -Identity "atl-persistentchat-001.litwareinc.com\ITChatRoom" -EndDate "4/1/2012" ``` @@ -57,7 +58,7 @@ Remove-CsPersistentChatMessage -Identity "atl-persistentchat-001.litwareinc.com\ The command shown in Example 1 removes all the Persistent Chat messages posted on or before April 1, 2012 from the ITChatRoom chat room on the server atl-persistentchat-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Remove-CsPersistentChatMessage -Identity "atl-persistentchat-001.litwareinc.com\ITChatRoom" -UserUri "sip:kenmyer@litwareinc.com" ``` @@ -67,69 +68,17 @@ In Example 2, all Persistent Chat messages posted by the user kenmyer@litwareinc ## PARAMETERS -### -Identity -Unique identifier for the chat room containing the message to be deleted. -For example: - -`-Identity "atl-persistentchat-001.litwareinc.com\ITChatRoom"` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -When present, removes the Persistent Chat message without leaving a replacement message. - -You cannot use both the Remove parameter and the ReplaceMessage parameter in the same command. - -```yaml -Type: SwitchParameter -Parameter Sets: Remove -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplaceMessage -Enables administrators to specify the text of the replacement message. -By default, the replacement message reads "This message was replaced by the Persistent Chat administrator." - -```yaml -Type: String -Parameter Sets: Replace -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -CaseSensitive -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -CaseSensitive When present, indicates that case sensitivity should be used when searching for messages to be removed. (In other words, an uppercase "A" will be treated as a different character than a lowercase "a".) By default, searches are not case sensitive. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -138,30 +87,16 @@ 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 2013, Skype for Business Server 2015 +### -EndDate -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -EndDate Enables you to filter for messages that were posted on or before the specified date. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -171,6 +106,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Keywords that can be used to help identify the messages to be deleted. For example, to search for all messages that include the keyword "Fabrikam" use this syntax: @@ -187,8 +125,7 @@ To look for messages using any one of the provided keywords, use the MatchClause ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -197,7 +134,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique identifier for the chat room containing the message to be deleted. +For example: + +`-Identity "atl-persistentchat-001.litwareinc.com\ITChatRoom"` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MatchClause + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies how the `Remove-CsPersistentChatMessage` cmdlet handles multiple keywords. Allowed values are: @@ -213,8 +174,7 @@ For example, this syntax searches for messages that have the exact phrase "For i ```yaml Type: AndOr Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -223,14 +183,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Remove + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +When present, removes the Persistent Chat message without leaving a replacement message. + +You cannot use both the Remove parameter and the ReplaceMessage parameter in the same command. + +```yaml +Type: SwitchParameter +Parameter Sets: Remove +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplaceMessage + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Enables administrators to specify the text of the replacement message. +By default, the replacement message reads "This message was replaced by the Persistent Chat administrator." + +```yaml +Type: String +Parameter Sets: Replace +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StartDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to filter for messages that were posted on or after the specified date. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -240,13 +241,33 @@ Accept wildcard characters: False ``` ### -UserUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SIP address of the user who posted the message (or messages) that should be removed. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -256,13 +277,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -276,14 +299,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsPersistentChatMessage` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatPolicy.md similarity index 92% rename from skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatPolicy.md index 75517edccd..458bc8fd84 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatpolicy applicable: Lync Server 2013, Skype for Business Server 2015 -title: Remove-CsPersistentChatPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatpolicy +schema: 2.0.0 +title: Remove-CsPersistentChatPolicy --- # Remove-CsPersistentChatPolicy @@ -41,7 +42,7 @@ Select the policy to be removed, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatPolicy -Identity "RedmondPersistentChatPolicy" ``` @@ -49,7 +50,7 @@ Remove-CsPersistentChatPolicy -Identity "RedmondPersistentChatPolicy" The command shown in Example 1 removes the per-user Persistent Chat policy with the Identity RedmondPersistentChatPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatPolicy -Filter "site:*" | Remove-CsPersistentChatPolicy ``` @@ -59,7 +60,7 @@ To do this, the command first uses the `Get-CsPersistentChatPolicy` cmdlet and t (This is done by using the filter value "site:*".) These policies are then piped to and deleted by, the `Remove-CsPersistentChatPolicy` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatPolicy | Where-Object {$_.EnablePersistentChat -eq $True} | Remove-CsPersistentChatPolicy ``` @@ -72,7 +73,30 @@ That collection is then piped to the `Remove-CsPersistentChatPolicy` cmdlet, whi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +If present, causes the `Remove-CsPersistentChatPolicy` cmdlet to delete the per-user policy even if the policy is currently assigned to at least one user. +If not present, you will be asked to confirm the deletion request before a policy still in use will be removed. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identity of the Persistent Chat policy to be deleted. To remove a site-scoped policy, use syntax similar to this: @@ -90,8 +114,7 @@ Instead, all the properties in the global policy will be reset to their default ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 2 @@ -100,32 +123,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +> Applicable: Skype for Business Server 2015 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the Persistent Chat policy is being removed. +For example: -### -Force -If present, causes the `Remove-CsPersistentChatPolicy` cmdlet to delete the per-user policy even if the policy is currently assigned to at least one user. -If not present, you will be asked to confirm the deletion request before a policy still in use will be removed. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -134,14 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -150,21 +166,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the Persistent Chat policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2013, Skype for Business Server 2015 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015 +Aliases: wi Required: False Position: Named @@ -178,13 +189,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy The `Remove-CsPersistentChatPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsPersistentChatPolicy` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatRoom.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsPersistentChatRoom.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatRoom.md index d789e263f1..0d1b1c19d0 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatRoom.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Remove-CsPersistentChatRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatroom +schema: 2.0.0 +title: Remove-CsPersistentChatRoom --- # Remove-CsPersistentChatRoom @@ -46,7 +47,7 @@ To delete the room, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatRoom -Identity "atl-gc-001.litwareinc.com\RedmondChatRoom" ``` @@ -54,7 +55,7 @@ Remove-CsPersistentChatRoom -Identity "atl-gc-001.litwareinc.com\RedmondChatRoom The command shown in Example 1 removes the Persistent Chat chat room RedmondChatRoom. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatRoom | Remove-CsPersistentChatRoom ``` @@ -64,7 +65,7 @@ To do this, the command first calls the `Get-CsPersistentChatRoom` cmdlet withou This collection is then piped to the `Remove-CsPersistentChatRoom` cmdlet, which deletes each room in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatRoom -Privacy "Closed" | Remove-CsPersistentChatRoom ``` @@ -76,7 +77,28 @@ This collection is then piped to the `Remove-CsPersistentChatConfiguration` cmdl ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique Identifier for the Persistent Chat chat room being removed. The Identity for a chat room consists of the Persistent Chat pool where the room has been configured plus the name of the room; for example: @@ -85,8 +107,7 @@ The Identity for a chat room consists of the Persistent Chat pool where the room ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -96,13 +117,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: ChatRoom Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -112,13 +135,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -127,30 +152,16 @@ 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 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -164,14 +175,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject The `Remove-CsPersistentChatRooms` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPersistentChatRoom` cmdlet deletes existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPinPolicy.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsPinPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPinPolicy.md index b50a7851b2..aa4b700edc 100644 --- a/skype/skype-ps/skype/Remove-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPinPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPinPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspinpolicy +schema: 2.0.0 +title: Remove-CsPinPolicy --- # Remove-CsPinPolicy @@ -47,7 +48,7 @@ If you remove the global policy, the minimum PIN length will be reset to the def ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsPinPolicy -Identity RedmondUsersPinPolicy ``` @@ -55,7 +56,7 @@ Remove-CsPinPolicy -Identity RedmondUsersPinPolicy Example 1 removes the per-user PIN policy with the Identity RedmondUsersPinPolicy. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPinPolicy -Filter "site:*" | Remove-CsPinPolicy ``` @@ -65,7 +66,7 @@ To do this, the `Get-CsPinPolicy` cmdlet is used, along with the Filter paramete This collection is then piped to the `Remove-CsPinPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPinPolicy | Where-Object {$_.AllowCommonPatterns -eq $True} | Remove-CsPinPolicy ``` @@ -76,7 +77,7 @@ This collection is then piped to the `Where-Object` cmdlet, which selects only t Finally, that filtered collection is piped to the `Remove-CsPinPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsPinPolicy | Remove-CsPinPolicy ``` @@ -89,7 +90,28 @@ Instead, all the properties in the global policy will be reset to their default ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier assigned to the policy when it was created. PIN policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -108,8 +130,7 @@ To refer to a policy at the per-user scope, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -118,30 +139,23 @@ 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. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the PIN policy is being removed. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +165,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -166,21 +182,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the PIN policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -194,15 +205,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy + The `Remove-CsPinPolicy` cmdlet accepts pipelined input of the PIN policy object. ## OUTPUTS -### +### None The `Remove-CsPinPolicy` cmdlet does not return a value or object. -Instead, the cmdlet removes one or more instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPlatformServiceSettings.md similarity index 81% rename from skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPlatformServiceSettings.md index a4f1d6ea41..ff0303a4f5 100644 --- a/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPlatformServiceSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPlatformServiceSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csplatformservicesettings +schema: 2.0.0 +title: Remove-CsPlatformServiceSettings --- # Remove-CsPlatformServiceSettings @@ -28,7 +29,7 @@ The `Remove-CsPlatformServiceSettings` cmdlet reset the global configuration in ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> Remove-CsPlatformServiceSettings -Identity Global ``` @@ -37,30 +38,16 @@ This example reset the global configuration to default value. Global configurati ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses any confirmation prompts that would otherwise be displayed before testing. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -70,13 +57,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the Platform Service Settings to be removed. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -85,7 +74,28 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the 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 + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -93,7 +103,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -118,8 +127,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csplatformservicesettings?view=skype-ps) -[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPresencePolicy.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsPresencePolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPresencePolicy.md index 7257c10c6d..1eacbf0ff8 100644 --- a/skype/skype-ps/skype/Remove-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPresencePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPresencePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspresencepolicy +schema: 2.0.0 +title: Remove-CsPresencePolicy --- # Remove-CsPresencePolicy @@ -49,7 +50,7 @@ This cmdlet can also be run against the global policy; however, if you do this t ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsPresencePolicy -Identity "RedmondPresencePolicy" ``` @@ -57,7 +58,7 @@ Remove-CsPresencePolicy -Identity "RedmondPresencePolicy" Example 1 deletes the per-user presence policy with the Identity RedmondPresencePolicy. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPresencePolicy -Filter "tag:*" | Remove-CsPresencePolicy ``` @@ -67,7 +68,7 @@ The command shown in Example 2 removes all the presence policies that have been The filtered collection is then piped to the `Remove-CsPresencePolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPresencePolicy | Where-Object {$_.MaxPromptedSubscriber -gt 500} | Remove-CsPresencePolicy ``` @@ -80,7 +81,30 @@ In turn, that filtered collection is then piped to the `Remove-CsPresencePolicy` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, causes the `Remove-CsPresencePolicy` cmdlet to delete the per-user policy even if the policy is currently assigned to at least one user. +If not present, you will be asked to confirm the deletion request before a policy still in use will be removed. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the presence policy to be removed. To remove a policy configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. To remove a policy configured at the per-user scope, use syntax similar to this: @@ -95,8 +119,7 @@ Instead, the properties within that policy will be reset to their default values ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -105,32 +128,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -If present, causes the `Remove-CsPresencePolicy` cmdlet to delete the per-user policy even if the policy is currently assigned to at least one user. -If not present, you will be asked to confirm the deletion request before a policy still in use will be removed. +### -Tenant +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the presence policy is being removed. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,13 +154,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -155,21 +171,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the presence policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -183,14 +194,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy + The `Remove-CsPresencePolicy` cmdlet accepts pipelined input of the presence policy object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsPresencePolicy` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPresenceProvider.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsPresenceProvider.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPresenceProvider.md index 66ad10e6b7..7e5c87ec71 100644 --- a/skype/skype-ps/skype/Remove-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPresenceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPresenceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspresenceprovider +schema: 2.0.0 +title: Remove-CsPresenceProvider --- # Remove-CsPresenceProvider @@ -36,7 +37,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPresenceProvider -Identity "global/fabrikam.com" ``` @@ -44,7 +45,7 @@ Remove-CsPresenceProvider -Identity "global/fabrikam.com" The command shown in Example 1 removes the presence provider with the Identity "global/fabrikam.com". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPresenceProvider | Remove-CsPresenceProvider ``` @@ -54,7 +55,7 @@ To do this, the command first calls the `Get-CsPresenceProvider` cmdlet without That collection is then piped to the `Remove-CsPresenceProvider` cmdlet, which deletes each item (that is, each provider) in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPresenceProvider | Where-Object {$_.Fqdn -match "fabrikam.com"} | Remove-CsPresenceProvider ``` @@ -67,7 +68,28 @@ In turn, that filtered collection is then piped to the `Remove-CsPresenceProvide ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the presence provider to be removed. To remove a single provider, use the actual Identity of the provider, which includes both the scope and the provider Fqdn: @@ -81,8 +103,7 @@ This syntax removes all the providers configured at the global scope: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -92,13 +113,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -107,30 +130,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -144,14 +153,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated The `Remove-CsPresenceProvider` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPresenceProvider` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object. +### None +The `Remove-CsPresenceProvider` cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPrivacyConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPrivacyConfiguration.md index f0a1d07838..fdf16ce88f 100644 --- a/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPrivacyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csprivacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPrivacyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csprivacyconfiguration +schema: 2.0.0 +title: Remove-CsPrivacyConfiguration --- # Remove-CsPrivacyConfiguration @@ -48,7 +49,7 @@ If you now "delete" the global collection EnablePrivacyMode will revert to its d ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsPrivacyConfiguration -Identity site:Redmond ``` @@ -57,7 +58,7 @@ Example 1 returns the privacy configuration settings assigned to the Redmond sit When these settings are deleted, users in the Redmond site will automatically inherit the global privacy configuration settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPrivacyConfiguration -Filter "site:*" | Remove-CsPrivacyConfiguration ``` @@ -66,7 +67,7 @@ In Example 2, all the privacy configuration settings assigned at the site scope The filtered collection is then piped to the `Remove-CsPrivacyConfiguration` cmdlet, which removes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPrivacyConfiguration | Where-Object {$_.EnablePrivacyMode -eq $False} | Remove-CsPrivacyConfiguration ``` @@ -79,7 +80,28 @@ This filtered collection is piped to the `Remove-CsPrivacyConfiguration` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the privacy configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: @@ -97,8 +119,7 @@ Instead, all the properties in that collection will be reset to their default va ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -108,6 +129,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which privacy configuration settings being deleted. For example: @@ -121,8 +145,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,14 +154,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -148,29 +173,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -184,14 +195,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration + The `Remove-CsPrivacyConfiguration` cmdlet accepts pipelined input of the privacy configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsPrivacyConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsProxyConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsProxyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsProxyConfiguration.md index fdf06b7833..a9e921c426 100644 --- a/skype/skype-ps/skype/Remove-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsProxyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsProxyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csproxyconfiguration +schema: 2.0.0 +title: Remove-CsProxyConfiguration --- # Remove-CsProxyConfiguration @@ -73,7 +74,28 @@ This subset of proxy configuration settings is then piped to the `Remove-CsProxy ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the proxy server configuration settings to be removed; for example: `-Identity "service:Registrar:atl-cs-001.litwareinc.com"` @@ -86,8 +108,7 @@ Instead, the properties within that global collection will all be reset to their ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -96,14 +117,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -113,29 +136,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -149,15 +158,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings The `Remove-CsProxyConfiguration` cmdlet accepts pipelined instances of the proxy settings object. ## OUTPUTS -### -None. -Instead, the `Remove-CsProxyConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPublicProvider.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPublicProvider.md index 85a18e6544..46fc715d6d 100644 --- a/skype/skype-ps/skype/Remove-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspublicprovider +schema: 2.0.0 +title: Remove-CsPublicProvider --- # Remove-CsPublicProvider @@ -44,7 +45,7 @@ To re-establish the relationship you can use the `Enable-CsPublicProvider` cmdle ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsPublicProvider -Identity "Skype" ``` @@ -53,7 +54,7 @@ Example 1 deletes the public provider with the Identity Skype. After this command has completed, Skype will no longer appear in the list of configured public providers; at that point, the only way to re-establish federation with Skype is to re-create the provider. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPublicProvider | Remove-CsPublicProvider ``` @@ -63,7 +64,7 @@ To do this, the command first uses the `Get-CsPublicProvider` cmdlet to return a This collection is then piped to the `Remove-CsPublicProvider` cmdlet, which, in turn, deletes each provider in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPublicProvider | Where-Object {$_.Enabled -eq $False} | Remove-CsPublicProvider ``` @@ -76,7 +77,28 @@ That filtered collection is then piped to the `Remove-CsPublicProvider` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the public provider to be removed. The Identity typically the name of the website providing the services. @@ -84,8 +106,7 @@ The Identity typically the name of the website providing the services. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -94,14 +115,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -111,29 +134,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -147,14 +156,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider + The `Remove-CsPublicProvider` cmdlet accepts pipelined instances of the public provider object. ## OUTPUTS -### -None. +### None Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPushNotificationConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPushNotificationConfiguration.md index 75b54cd946..44a3aec3bd 100644 --- a/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPushNotificationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPushNotificationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspushnotificationconfiguration +schema: 2.0.0 +title: Remove-CsPushNotificationConfiguration --- # Remove-CsPushNotificationConfiguration @@ -49,7 +50,7 @@ In this case, that means that push notifications will be disabled from both the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPushNotificationConfiguration -Identity "site:Redmond" ``` @@ -57,7 +58,7 @@ Remove-CsPushNotificationConfiguration -Identity "site:Redmond" The command shown in Example 1 deletes the collection of push notification settings assigned to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPushNotificationConfiguration -Filter "site:*" | Remove-CsPushNotificationConfiguration ``` @@ -67,7 +68,7 @@ To perform this task, the cmdlet first uses the `Get-CsPushNotificationConfigura The site-scoped settings are then piped to and deleted by, the `Remove-CsPushNotificationConfiguration` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPushNotificationConfiguration | Where-Object {$_.EnableMicrosoftPushNotificationService -eq $False} | Remove-CsPushNotificationConfiguration ``` @@ -80,7 +81,28 @@ This filtered collection is then piped to the `Remove-CsPushNotificationConfigur ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of push notification configuration settings to be removed. To remove the global collection, use the following syntax: @@ -97,8 +119,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -107,30 +128,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the push notification configuration settings being deleted. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,22 +154,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the push notification configuration settings being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -Confirm -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -164,13 +173,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -184,21 +195,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration. +### Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration The `Remove-CsPushNotificationConfiguration` cmdlet accepts pipelined instances of the PushNotificationConfiguration object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPushNotificationConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration object. +### None +This cmdlet does not return a value or object. ## NOTES ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration?view=skype-ps) -[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) +[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspushnotificationconfiguration?view=skype-ps) -[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) +[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsQoEConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsQoEConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsQoEConfiguration.md index 02136f6354..6e578300a3 100644 --- a/skype/skype-ps/skype/Remove-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsQoEConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsQoEConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csqoeconfiguration +schema: 2.0.0 +title: Remove-CsQoEConfiguration --- # Remove-CsQoEConfiguration @@ -32,7 +33,7 @@ Calling this cmdlet on the global QoE configuration will reset all properties to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsQoEConfiguration -Identity site:Redmond ``` @@ -41,7 +42,7 @@ Example 1 uses the `Remove-CsQoEConfiguration` cmdlet to remove the QoE settings Using the Identity parameter ensures that only the settings assigned to the specified site will be removed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsQoEConfiguration -Filter site:* | Remove-CsQoEConfiguration ``` @@ -51,7 +52,7 @@ To do this, the command first uses the `Get-CsQoEConfiguration` cmdlet and the F The filtered collection is then passed to the `Remove-CsQoEConfiguration` cmdlet, which deletes all the items in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsQoEConfiguration | Where-Object {$_.KeepQoEDataForDays -lt 30} | Remove-CsQoEConfiguration ``` @@ -64,7 +65,28 @@ In turn, the filtered collection is piped to the `Remove-CsQoEConfiguration` cmd ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the settings you want to remove. Possible values are global and site:\, where \ is the name of the site in your Skype for Business Server deployment with the settings to be removed. @@ -72,8 +94,7 @@ Possible values are global and site:\, where \ is the na ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -82,14 +103,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -99,29 +122,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -135,15 +144,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings + Accepts pipelined input of QoE configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. -Instead, it removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRegistrarConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRegistrarConfiguration.md index 698ba81e59..bf14ccb559 100644 --- a/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRegistrarConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRegistrarConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csregistrarconfiguration +schema: 2.0.0 +title: Remove-CsRegistrarConfiguration --- # Remove-CsRegistrarConfiguration @@ -46,7 +47,7 @@ For example, if you have changed the value of the MinEndpointExpiration property ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsRegistrarConfiguration -Identity site:Redmond ``` @@ -55,7 +56,7 @@ The command shown in Example 1 deletes the Registrar configuration settings assi When these settings are deleted, Registrars in the Redmond site will automatically use the global Registrar settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRegistrarConfiguration -Filter "service:*" | Remove-CsRegistrarConfiguration ``` @@ -65,7 +66,7 @@ To do this, the command first calls the `Get-CsRegistrarConfiguration` cmdlet al The filtered collection is then piped to the `Remove-CsRegistrarConfiguration` cmdlet, which deletes each item in that collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRegistrarConfiguration | Where-Object {$_.EnableDHCPServer -eq $True} | Remove-CsRegistrarConfiguration ``` @@ -78,7 +79,28 @@ In turn, the filtered collection is piped to the `Remove-CsRegistrarConfiguratio ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the Registrar configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. To remove settings at the service level, use syntax like this: @@ -93,8 +115,7 @@ Instead, all the properties in the global collection will be reset to their defa ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,14 +124,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -120,29 +143,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -156,14 +165,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings + The `Remove-CsRegistrarConfiguration` cmdlet accepts pipelined instances of the Registrar settings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsRegistrarConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsReportingConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsReportingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsReportingConfiguration.md index f39a678c24..13c161eaff 100644 --- a/skype/skype-ps/skype/Remove-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsReportingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsReportingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csreportingconfiguration +schema: 2.0.0 +title: Remove-CsReportingConfiguration --- # Remove-CsReportingConfiguration @@ -32,7 +33,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-002.litwareinc.com" ``` @@ -40,7 +41,7 @@ Remove-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-00 In Example 1, the reporting configuration settings with the Identity service:MonitoringDatabase:atl-sql-002.litwareinc.com are removed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsReportingConfiguration | Remove-CsReportingConfiguration ``` @@ -50,7 +51,7 @@ To do this, the command first uses the `Get-CsReportingConfiguration` cmdlet to This collection is then piped to the `Remove-CsReportingConfiguration` cmdlet, which removes each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsReportingConfiguration | Where-Object {$_.ReportingUrl -eq "https://atl-sql-002.litwareinc.com/lync_reports" | Remove-CsReportingConfiguration ``` @@ -66,7 +67,28 @@ That filtered collection is then piped to the `Remove-CsReportingConfiguration` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database whose reporting configuration settings are to be removed. For example: @@ -75,8 +97,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -86,13 +107,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -101,30 +124,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -138,14 +147,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration The `Remove-CsReportingConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object. ## OUTPUTS -### -None. -Instead, the `Remove-CsReportingConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsAgentGroup.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsRgsAgentGroup.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRgsAgentGroup.md index 7062f37fd4..0c4399dbe5 100644 --- a/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsAgentGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRgsAgentGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csrgsagentgroup +schema: 2.0.0 +title: Remove-CsRgsAgentGroup --- # Remove-CsRgsAgentGroup @@ -40,7 +41,7 @@ If you only want to remove a single agent from a group, use the `Set-CsRgsAgentG ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Remove-CsRgsAgentGroup ``` @@ -50,7 +51,7 @@ To do this, the command first uses `Get-CsRgsAgentGroup` to return all the agent Those groups are then piped to and removed by, the `Remove-CsRgsAgentGroup` cmdlet. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" | Remove-CsRgsAgentGroup ``` @@ -60,7 +61,7 @@ To do this, `Get-CsRgsAgentGroup` is first used to return the Help Desk agent gr This group is then piped to `Remove-CsRgsAgentGroup`, which removes the group from the service. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.RoutingMethod -ne "RoundRobin"} | Remove-CsRgsAgentGroup ``` @@ -74,6 +75,9 @@ The filtered collection is then piped to `Remove-CsRgsAgentGroup`, which deletes ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Forces removal of the agent group. If this parameter is present, the agent group will be deleted without warning, even if it is used by an active workflow. If this parameter is not present, then you will be asked to confirm the deletion of any agent group currently being used by an active workflow. @@ -81,8 +85,7 @@ If this parameter is not present, then you will be asked to confirm the deletion ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,30 +94,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference pointing to the agent group to be removed. +When piping workflow objects to `Remove-CsRgsAgentGroup` you can leave off the Instance parameter. + +To use the Instance parameter use commands similar to this: + +`$x = Get-CsRgsAgentGroup -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` + +`Remove-CsRgsAgentGroup -Instance $x` + +Note that you can only remove a single agent group at a time when using the Instance parameter. +That means that your object reference ($x) cannot contain multiple agent group objects. + ```yaml -Type: SwitchParameter +Type: AgentGroup Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -123,30 +141,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Object reference pointing to the agent group to be removed. -When piping workflow objects to `Remove-CsRgsAgentGroup` you can leave off the Instance parameter. - -To use the Instance parameter use commands similar to this: - -`$x = Get-CsRgsAgentGroup -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` - -`Remove-CsRgsAgentGroup -Instance $x` +### -WhatIf -Note that you can only remove a single agent group at a time when using the Instance parameter. -That means that your object reference ($x) cannot contain multiple agent group objects. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: AgentGroup +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -155,14 +164,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup + `Remove-CsRgsAgentGroup` accepts pipelined instances of the Response Group agent group object. ## OUTPUTS -### -`Remove-CsRgsAgentGroup` deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHolidaySet.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsRgsHolidaySet.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRgsHolidaySet.md index 65b20debef..d8f890b2d5 100644 --- a/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHolidaySet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRgsHolidaySet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csrgsholidayset +schema: 2.0.0 +title: Remove-CsRgsHolidaySet --- # Remove-CsRgsHolidaySet @@ -57,7 +58,7 @@ If all you want to do is remove a single holiday from a holiday set (for example ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "2010 Holidays" | Remove-CsRgsHolidaySet ``` @@ -67,7 +68,7 @@ To do this, the command first calls `Get-CsRgsHolidaySet` along with two paramet The returned object is then piped to `Remove-CsRgsHolidaySet`, which deletes the holiday set 2010 Holidays. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Select-Object Identity -ExpandProperty HolidayList | Where-Object {$_.Name -eq "New Year's Day"} | Remove-CsRgsHolidaySet ``` @@ -81,7 +82,7 @@ The selected information (holiday set Identity and holiday property values) is t The filtered collection of holiday sets is then piped to `Remove-CsRgsHolidaySet`, which deletes each holiday set that includes the holiday New Year's Day. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.HolidayList.Count -lt 5} | Remove-CsRgsHolidaySet ``` @@ -95,6 +96,9 @@ These holiday sets are then piped to and deleted by, the `Remove-CsRgsHolidaySet ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Forces removal of the holiday set. If this parameter is present, the holiday set will be deleted without warning, even if it is used by an active workflow. If this parameter is not present then you will be asked to confirm the deletion of any holiday set currently assigned to an active workflow. @@ -102,8 +106,7 @@ If this parameter is not present then you will be asked to confirm the deletion ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,30 +115,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference pointing to the holiday set to be removed. +When piping workflow objects to `Remove-CsRgsHolidaySet` you can leave off the Instance parameter. + +To use the Instance parameter use commands similar to this: + +`$x = Get-CsRgsHolidaySet -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` + +`Remove-CsRgsHolidaySet -Instance $x` + +Note that you can only remove a single holiday set at a time when using the Instance parameter. +That means that your object reference ($x) cannot contain multiple holiday set objects. + ```yaml -Type: SwitchParameter +Type: HolidaySet Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is for testing purposes only. ```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 @@ -144,30 +162,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Object reference pointing to the holiday set to be removed. -When piping workflow objects to `Remove-CsRgsHolidaySet` you can leave off the Instance parameter. - -To use the Instance parameter use commands similar to this: - -`$x = Get-CsRgsHolidaySet -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` - -`Remove-CsRgsHolidaySet -Instance $x` +### -WhatIf -Note that you can only remove a single holiday set at a time when using the Instance parameter. -That means that your object reference ($x) cannot contain multiple holiday set objects. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: HolidaySet +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -176,14 +185,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet + `Remove-CsRgsHolidaySet` accepts pipelined instances of the Response Group holiday set object. ## OUTPUTS -### -`Remove-CsRgsHolidaySet` deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHoursOfBusiness.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRgsHoursOfBusiness.md index d9620b6ae4..ca120fa95b 100644 --- a/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHoursOfBusiness.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRgsHoursOfBusiness -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csrgshoursofbusiness +schema: 2.0.0 +title: Remove-CsRgsHoursOfBusiness --- # Remove-CsRgsHoursOfBusiness @@ -49,7 +50,7 @@ For example: ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Remove-CsRgsHoursOfBusiness ``` @@ -59,7 +60,7 @@ To do this, the command first calls `Get-CsRgsHoursOfBusiness` to return all the These sets are then piped to the `Remove-CsRgsHoursOfBusiness` cmdlet, which deletes each business hours set that is passed to it. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "Help Desk Business Hours" | Remove-CsRgsHoursOfBusiness ``` @@ -67,7 +68,7 @@ Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litware In Example 2, a single set of business hours is removed from ApplicationServer:atl-cs-001.litwareinc.com: the collection named Help Desk Business Hours. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.SundayTimeRange1 -ne $Null -or $_.SundayTimeRange2 -ne $Null} | Remove-CsRgsHoursOfBusiness ``` @@ -78,7 +79,7 @@ These sets are then piped to the `Where-Object` cmdlet, which selects only those (If a time range property is not null, then that means business hours have been configured for that time interval.) Any set that meets at least one of those criteria is then piped to the `Remove-CsRgsHoursOfBusiness` cmdlet, which removes that set of business hours. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.Custom -eq $True} | Remove-CsRgsHoursOfBusiness -Force ``` @@ -92,6 +93,9 @@ These sets are then piped to and deleted by, `Remove-CsRgsHoursOfBusiness`. ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Forces the deletion of a business hours set. If this parameter is present, the set will be deleted without warning, even if the set is currently assigned to an active workflow. If this parameter is not present then you will be asked to confirm the deletion of any business hours set currently assigned to an active workflow. @@ -99,8 +103,7 @@ If this parameter is not present then you will be asked to confirm the deletion ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,30 +112,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference pointing to the business hours set to be removed. +When piping workflow objects to `Remove-CsRgsHoursOfBusiness` you can leave off the Instance parameter. + +To use the Instance parameter use commands similar to this: + +`$x = Get-CsRgsHoursOfBusiness -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` + +`Remove-CsRgsHoursOfBusiness -Instance $x` + +Note that you can only remove a single business hours set at a time when using the Instance parameter. +That means that your object reference ($x) cannot contain multiple business hour objects. + ```yaml -Type: SwitchParameter +Type: BusinessHours Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -141,30 +159,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Object reference pointing to the business hours set to be removed. -When piping workflow objects to `Remove-CsRgsHoursOfBusiness` you can leave off the Instance parameter. - -To use the Instance parameter use commands similar to this: - -`$x = Get-CsRgsHoursOfBusiness -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` - -`Remove-CsRgsHoursOfBusiness -Instance $x` +### -WhatIf -Note that you can only remove a single business hours set at a time when using the Instance parameter. -That means that your object reference ($x) cannot contain multiple business hour objects. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: BusinessHours +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -173,14 +182,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours + `Remove-CsRgsHoursOfBusiness` accepts pipelined instances of the Response Group business hours object. ## OUTPUTS -### -Deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsQueue.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsRgsQueue.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRgsQueue.md index a930605625..a702888b7e 100644 --- a/skype/skype-ps/skype/Remove-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsQueue.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRgsQueue -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csrgsqueue +schema: 2.0.0 +title: Remove-CsRgsQueue --- # Remove-CsRgsQueue @@ -45,7 +46,7 @@ Because of that, you might want to use the `Get-CsRgsQueue` cmdlet to check the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Remove-CsRgsQueue ``` @@ -55,7 +56,7 @@ To do this, the command first uses `Get-CsRgsQueue` to return a collection of al This collection is then piped to `Remove-CsRgsQueue`, which deletes each queue in the collection. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Queue" | Remove-CsRgsQueue ``` @@ -64,7 +65,7 @@ In Example 2, a single Response Group queue is deleted: the queue named "Help De To delete this queue, `Get-CsRgsQueue` is called along with the Identity and Name parameters; the single queue returned by this call is then piped to and deleted by, `Remove-CsRgsQueue`. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.OverflowCandidate -eq "NewestCall"} | Remove-CsRgsQueue ``` @@ -78,6 +79,9 @@ The filtered collection is then piped to `Remove-CsRgsQueue`, which deletes each ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Forces the deletion of a Response Group queue. If this parameter is present, the queue will be deleted without warning, even if the queue is assigned to an active workflow. If this parameter is not present then you will be asked to confirm the deletion of any queue currently in use by an active workflow. @@ -85,8 +89,7 @@ If this parameter is not present then you will be asked to confirm the deletion ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -95,30 +98,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference pointing to the queue to be removed. +When piping workflow objects to `Remove-CsRgsQueue` you can leave off the Instance parameter. + +To use the Instance parameter use commands similar to this: + +`$x = Get-CsRgsQueue -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` + +`Remove-CsRgsQueue -Instance $x` + +Note that you can only remove a single queue at a time when using the Instance parameter. +That means that your object reference ($x) cannot contain multiple queue objects. + ```yaml -Type: SwitchParameter +Type: Queue Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -127,30 +145,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Object reference pointing to the queue to be removed. -When piping workflow objects to `Remove-CsRgsQueue` you can leave off the Instance parameter. - -To use the Instance parameter use commands similar to this: - -`$x = Get-CsRgsQueue -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` - -`Remove-CsRgsQueue -Instance $x` +### -WhatIf -Note that you can only remove a single queue at a time when using the Instance parameter. -That means that your object reference ($x) cannot contain multiple queue objects. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Queue +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -159,14 +168,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.Queue + `Remove-CsRgsQueue` accepts pipelined instances of the Response Group queue object. ## OUTPUTS -### -`Remove-CsRgsQueue` deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsWorkflow.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsRgsWorkflow.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRgsWorkflow.md index e12c40c092..4b043dae8d 100644 --- a/skype/skype-ps/skype/Remove-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsWorkflow.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRgsWorkflow -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csrgsworkflow +schema: 2.0.0 +title: Remove-CsRgsWorkflow --- # Remove-CsRgsWorkflow @@ -45,7 +46,7 @@ For example: ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsRgsWorkflow -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com | Remove-CsRgsWorkflow ``` @@ -55,7 +56,7 @@ To do this, the command first calls `Get-CsRgsWorkflow` to return a collection o That collection is then piped to `Remove-CsRgsWorkflow`, which deletes each workflow in the collection. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Workflow" | Remove-CsRgsWorkflow ``` @@ -65,7 +66,7 @@ To do this, `Get-CsRgsWorkflow` is first used to return the workflow named Help That workflow is then piped to and deleted by, `Remove-CsRgsWorkflow`. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.Language -eq "en-us"} | Remove-CsRgsWorkflow ``` @@ -77,7 +78,7 @@ English (en-us). This filtered collection is then piped to the `Remove-CsRgsWorkflow` cmdlet, which deletes each item in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.CustomMusicOnHoldFile -ne $Null} | Remove-CsRgsWorkflow ``` @@ -90,7 +91,30 @@ That collection is then piped to the `Where-Object` cmdlet, which selects only t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Forces removal of the workflow. +If this parameter is present, the workflow will be deleted without warning, even if it is currently active. +If this parameter is not present then you will be asked to confirm the deletion of any active workflow. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference pointing to the workflow to be removed. When piping workflow objects to `Remove-CsRgsWorkflow` you can leave off the Instance parameter. @@ -106,8 +130,7 @@ That means that your object reference ($x) cannot contain multiple workflow obje ```yaml Type: Workflow Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -116,16 +139,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Forces removal of the workflow. -If this parameter is present, the workflow will be deleted without warning, even if it is currently active. -If this parameter is not present then you will be asked to confirm the deletion of any active workflow. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -135,29 +158,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -171,14 +180,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow + `Remove-CsRgsWorkflow` accepts pipelined instances of the Response Group workflow object. ## OUTPUTS -### -`Remove-CsRgsWorkflow` deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRoutingConfiguration.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRoutingConfiguration.md index ad76c4dab3..e29a2dd72e 100644 --- a/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csroutingconfiguration +schema: 2.0.0 +title: Remove-CsRoutingConfiguration --- # Remove-CsRoutingConfiguration @@ -34,7 +35,7 @@ WARNING: Removing the routing configuration (in other words, setting the list of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsRoutingConfiguration -Identity Global -Confirm ``` @@ -45,15 +46,35 @@ This action deletes all defined voice routes, so we added the Confirm parameter ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The scope of the routing configuration to remove. This value must be Global. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -62,14 +83,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -79,29 +102,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -115,14 +124,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Policy.Voice.PSTNRoutingSettings object. +### Microsoft.Rtc.Management.Policy.Voice.PSTNRoutingSettings + Accepts pipelined input of a routing configuration object. ## OUTPUTS -### -This cmdlet removes (resets) an object of type Microsoft.Rtc.Management.Policy.Voice.PSTNRoutingSettings. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/Remove-CsServerApplication.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsServerApplication.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsServerApplication.md index a83b20565e..65e966bc99 100644 --- a/skype/skype-ps/skype/Remove-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsServerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsServerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csserverapplication +schema: 2.0.0 +title: Remove-CsServerApplication --- # Remove-CsServerApplication @@ -34,7 +35,7 @@ However, the software itself is not uninstalled and the application can be re-en ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsServerApplication -Identity "service:EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor" ``` @@ -43,7 +44,7 @@ In Example 1, the server application that has the Identity service: EdgeServer:a Because Identities must be unique, this command will never delete more than a single application. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsServerApplication | Where-Object {$_.Critical -eq $False} | Remove-CsServerApplication ``` @@ -54,7 +55,7 @@ This collection is then piped to the `Where-Object` cmdlet, which picks all the This filtered collection is then piped to the `Remove-CsServerApplication` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsServerApplication -Filter "service:EdgeServer:atl-cs-001.litwareinc.com/*" | Remove-CsServerApplication ``` @@ -66,7 +67,28 @@ In turn, that collection is piped to the `Remove-CsServerApplication` cmdlet, wh ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the server application to be removed. Server application Identities are composed of the service where the application is hosted plus the application name. For example, the server application named QoEAgent might have an Identity similar to this: service:Registrar:atl-cs-001.litwareinc.com/QoEAgent. @@ -74,8 +96,7 @@ For example, the server application named QoEAgent might have an Identity simila ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -84,14 +105,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -101,29 +124,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -137,14 +146,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application + The `Remove-CsServerApplication` cmdlet accepts pipelined instances of the server application object. ## OUTPUTS -### -The `Remove-CsServerApplication` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSimpleUrlConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsSimpleUrlConfiguration.md index 4d7b1655df..36a838cf79 100644 --- a/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSimpleUrlConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsSimpleUrlConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cssimpleurlconfiguration +schema: 2.0.0 +title: Remove-CsSimpleUrlConfiguration --- # Remove-CsSimpleUrlConfiguration @@ -58,7 +59,7 @@ If you later decide to delete one or more of the site-scoped collections, you ca ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsSimpleUrlConfiguration -Identity "site:Redmond" ``` @@ -67,7 +68,7 @@ The command shown in Example 1 deletes the simple URL configuration collection a This command deletes all the simple URLs assigned to the specified site. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsSimpleUrlConfiguration -Filter "site:*" | Remove-CsSimpleUrlConfiguration ``` @@ -79,7 +80,28 @@ The filtered collection is then piped to the `Remove-CsSimpleUrlConfiguration` c ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of simple URLs to be removed. To remove a collection from the site scope, use syntax similar to this: @@ -98,8 +120,7 @@ Instead, all the Simple URLs within that collection will be deleted. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -108,30 +129,24 @@ 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. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the Simple URL configuration settings being deleted. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +156,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -156,22 +173,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the Simple URL configuration settings being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -WhatIf -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -185,14 +196,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration + The `Remove-CsSimpleUrlConfiguration` cmdlet accepts pipelined instances of the simple URL configuration object. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSipDomain.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsSipDomain.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsSipDomain.md index d59dc449bb..4cb03e46dd 100644 --- a/skype/skype-ps/skype/Remove-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSipDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsSipDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cssipdomain +schema: 2.0.0 +title: Remove-CsSipDomain --- # Remove-CsSipDomain @@ -43,7 +44,7 @@ To remove a SIP domain currently in use, you must first assign new SIP addresses ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsSipDomain -Identity fabrikam.com ``` @@ -53,7 +54,7 @@ Note that this command will fail if fabrikam.com is the only SIP domain currentl That's because your topology must include at least one SIP domain. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsSipDomain | Where-Object {$_.IsDefault -ne $True} | Remove-CsSipDomain ``` @@ -66,7 +67,28 @@ The net effect: the default domain is filtered out and the remaining domains are ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the SIP domain to be removed: For example: `-Identity fabrikam.com` @@ -75,8 +97,7 @@ Fully qualified domain name (FQDN) of the SIP domain to be removed: For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -85,14 +106,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -102,29 +125,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -138,14 +147,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.SipDomain object. +### Microsoft.Rtc.Management.Xds.SipDomain + The `Remove-CsSipDomain` cmdlet accepts pipelined instances of the SIP domain object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsSipDomain` cmdlet deletes existing instance of the Microsoft.Rtc.Management.Xds.SipDomain object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSipResponseCodeTranslationRule.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsSipResponseCodeTranslationRule.md index 6dcccff10c..df3fdc1c10 100644 --- a/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSipResponseCodeTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsSipResponseCodeTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cssipresponsecodetranslationrule +schema: 2.0.0 +title: Remove-CsSipResponseCodeTranslationRule --- # Remove-CsSipResponseCodeTranslationRule @@ -48,7 +49,7 @@ The `Remove-CsSipResponseCodeTranslationRule` cmdlet provides a way for you to d ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" ``` @@ -56,7 +57,7 @@ Remove-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rul The command shown in Example 1 deletes a single response code translation rule: the rule that has the Identity PstnGateway:192.168.0.240/Rule404. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsSipResponseCodeTranslationRule -Filter "service:PstnGateway:192.168.0.240/*" | Remove-CsSipResponseTranslationCode ``` @@ -66,7 +67,7 @@ To do this, the command first calls the `Get-CsSipResponseCodeTranslationRule` c This filtered collection is then piped to the `Remove-CsSipResponseTranslationCode` cmdlet, which deletes each rule in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsSipResponseCodeTranslationRule | Where-Object {$_.ReceivedISUPCauseValue -eq -1} | Remove-CsSipResponseTranslationCode ``` @@ -80,7 +81,28 @@ From there, the filtered collection is piped to the `Remove-CsSipResponseTransla ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the translation rule to be removed. The identity for a translation rule consists of two parts: the scope where the rule was configured and the name given to the rule when it was created. For example, a translation rule named Rule404 that was created at the global scope would have an Identity that looked like this: global/Rule404. @@ -88,8 +110,7 @@ For example, a translation rule named Rule404 that was created at the global sco ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -98,14 +119,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -115,29 +138,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -151,15 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated The `Remove-CsSipResponseCodeTranslationRule` cmdlet accepts pipelined instances of the SIP response code translation rule object. ## OUTPUTS -### -The `Remove-CsSipResponseCodeTranslationRule` cmdlet does not return any objects or values. -Instead, the cmdlet deletes modifies instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsSlaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsSlaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsSlaConfiguration.md index 9cf8fa98a8..26e29ddb26 100644 --- a/skype/skype-ps/skype/Remove-CsSlaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsSlaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csslaconfiguration +schema: 2.0.0 +title: Remove-CsSlaConfiguration --- # Remove-CsSlaConfiguration @@ -22,9 +23,9 @@ Remove-CsSlaConfiguration [-Identity] [-Confirm] [-PassThru] [ ``` ## DESCRIPTION -Shared Line Appearance (SLA) is a feature in Skype for Business (SfB) for handling multiple calls on a specific number called a shared number. SLA can configure any enterprise voice enabled SfB user as a shared number with multiple lines to respond to multiple calls. The calls are not actually received on the shared number, instead they are forwarded to users that act as delegates for the shared number. Any one of the delegates can pick up the call while the rest of the delegates get a notification on their phone about who picked up the call and which line has become busy as a result. Both the number of lines and the delegates are configurable for a shared number in SLA. In addition, advanced options such as BusyOption (what happens in a situation when all lines are busy) and MissedCallOption (the case in which none of the delegates pick up a call) etc. can also be configured for a shared number. +Shared Line Appearance (SLA) is a feature in Skype for Business (SfB) for handling multiple calls on a specific number called a shared number. SLA can configure any enterprise voice enabled SfB user as a shared number with multiple lines to respond to multiple calls. The calls are not actually received on the shared number, instead they are forwarded to users that act as delegates for the shared number. Any one of the delegates can pick up the call while the rest of the delegates get a notification on their phone about who picked up the call and which line has become busy as a result. Both the number of lines and the delegates are configurable for a shared number in SLA. In addition, advanced options such as BusyOption (what happens in a situation when all lines are busy) and MissedCallOption (the case in which none of the delegates pick up a call) etc. can also be configured for a shared number. -The Remove-CsSlaConfiguration cmdlet removes an SLA configuration. +The Remove-CsSlaConfiguration cmdlet removes an SLA configuration. Note: Logging in with the account created for the SLA number is not supported. Using the SLA number account with any device or Desktop Client can result in unpredictable behavior. It is not necessary to use that account for the Shared Line Appearance feature to function. By default, members of the RTCUniversalServerAdmins group are authorized to run the Remove-CsSlaConfiguration cmdlet. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt: @@ -32,9 +33,9 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Remove-CsSlaConfiguration"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` -PS C:\> Remove-CsSlaConfiguration -Identity SLAGroup1 +PS C:\> Remove-CsSlaConfiguration -Identity SLAGroup1 ``` This example removes the Shared Line Appearance configuration named "SLAGroup1". @@ -43,6 +44,9 @@ This example removes the Shared Line Appearance configuration named "SLAGroup1". ## PARAMETERS ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the SLA group to be removed. 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). You can also reference a user account by using the 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". @@ -50,8 +54,7 @@ You can use the asterisk (\*) wildcard character when using the Display Name as ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -60,14 +63,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the SLA group being removed. By default, the Remove-CsSlaConfiguration cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -76,14 +81,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the SLA group being removed. By default, the Remove-CsSlaConfiguration cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -93,13 +100,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -118,6 +127,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration?view=skype-ps) +[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csslaconfiguration?view=skype-ps) -[Set-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration?view=skype-ps) +[Set-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csslaconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsSlaDelegates.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaDelegates.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsSlaDelegates.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsSlaDelegates.md index 66462078dc..2ff567a456 100644 --- a/skype/skype-ps/skype/Remove-CsSlaDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaDelegates.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssladelegates applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsSlaDelegates -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cssladelegates +schema: 2.0.0 +title: Remove-CsSlaDelegates --- # Remove-CsSlaDelegates @@ -35,7 +36,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Remove-CsSlaDelegates"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsSlaDelegates -Identity SLAGroup1 -Delegate sip:SLA_Delegate3@contoso.com ``` @@ -46,13 +47,15 @@ This example removes SLA_Delegate3@contoso.com as delegate in SLA group named SL ## PARAMETERS ### -Delegate + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the delegate to be removed from the SLA group. This parameter requires a valid sip address. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the identity of the shared number to which the delegate will be removed. User identities can be specified using one of five formats: - SIP address. Example: sip:kenmyer@litwareinc.com. @@ -73,8 +79,7 @@ Indicates the identity of the shared number to which the delegate will be remove ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -83,14 +88,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,14 +106,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -141,4 +152,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Add-CsSlaDelegates](https://learn.microsoft.com/powershell/module/skype/add-cssladelegates?view=skype-ps) +[Add-CsSlaDelegates](https://learn.microsoft.com/powershell/module/skypeforbusiness/add-cssladelegates?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsStaticRoutingConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsStaticRoutingConfiguration.md index 7c0a317d02..a1730f2fac 100644 --- a/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsStaticRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsStaticRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csstaticroutingconfiguration +schema: 2.0.0 +title: Remove-CsStaticRoutingConfiguration --- # Remove-CsStaticRoutingConfiguration @@ -45,7 +46,7 @@ That means that all the routes assigned to the global collection will be deleted ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" ``` @@ -53,7 +54,7 @@ Remove-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litw The command shown in Example 1 removes the static routing configuration collection that has the Identity service:Registrar:atl-cs-001.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsStaticRoutingConfiguration -Filter "service:*" | Remove-CsStaticRoutingConfiguration ``` @@ -63,7 +64,7 @@ To do this, the command starts off by using the `Get-CsStaticRoutingConfiguratio This filtered collection is then piped to the `Remove-CsStaticRoutingConfiguration` cmdlet, which deletes each item in that collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsStaticRoutingConfiguration | Where-Object {$_.Route.Count -eq 0} | Remove-CsStaticRoutingConfiguration ``` @@ -76,7 +77,28 @@ The filtered information is then piped to the `Remove-CsStaticRoutingConfigurati ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the static routing configuration collection to be removed. To remove a collection configured at the service scope, use syntax similar to this: @@ -94,8 +116,7 @@ That means that all the items in the Route property will be deleted. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -104,14 +125,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -121,29 +144,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -157,13 +166,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings + The `Remove-CsStaticRoutingConfiguration` cmdlet accepts pipelined instances of the static routing settings object. ## OUTPUTS -### +### None The `Remove-CsStaticRoutingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings object. diff --git a/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsStorageServiceConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsStorageServiceConfiguration.md index 47b61a9369..2fe7374ec7 100644 --- a/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsStorageServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsStorageServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csstorageserviceconfiguration +schema: 2.0.0 +title: Remove-CsStorageServiceConfiguration --- # Remove-CsStorageServiceConfiguration @@ -41,7 +42,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsStorageServiceConfiguration -Identity "site:Redmond" ``` @@ -49,7 +50,7 @@ Remove-CsStorageServiceConfiguration -Identity "site:Redmond" The command shown in Example 1 deletes the storage service configuration settings applied to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsStorageServiceConfiguration -Filter "site:*" | Remove-CsStorageServiceConfiguration ``` @@ -61,7 +62,28 @@ That collection is then piped to the `Remove-CsStorageServiceConfiguration` cmdl ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of storage service configuration settings to be removed. To remove a collection applied to the site scope, use syntax similar to this: @@ -78,8 +100,7 @@ Instead, the properties within that collection will all be reset to their defaul ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -89,13 +110,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -104,30 +127,16 @@ 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: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -141,13 +150,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings The `Remove-CsStorageServiceConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings object. ## OUTPUTS -### -None. +### None The `Remove-CsStorageServiceConfiguration` cmdlet does not return any objects or data. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTeamsUpgradePolicy.md similarity index 96% rename from skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTeamsUpgradePolicy.md index f8d9052ec0..ac40a90455 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTeamsUpgradePolicy.md @@ -1,14 +1,14 @@ --- -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 2015, Skype for Business Server 2019 -title: Remove-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csteamsupgradepolicy +schema: 2.0.0 +title: Remove-CsTeamsUpgradePolicy --- # Remove-CsTeamsUpgradePolicy @@ -43,13 +43,14 @@ This removes the TeamsUpgradePolicy for site named Redmond1. ### -Identity +> Applicable: Skype for Business Server 2019 + The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\" where "\" is the name of the site. To specify a policy that can be assigned as needed to any users, simply specify a name of your choosing. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: True Position: 1 Default value: None diff --git a/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTelemetryConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTelemetryConfiguration.md index ce9b3db03d..434dd6ec9e 100644 --- a/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTelemetryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTelemetryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstelemetryconfiguration +schema: 2.0.0 +title: Remove-CsTelemetryConfiguration --- # Remove-CsTelemetryConfiguration @@ -27,7 +28,7 @@ For privacy information, see the Skype for Business Privacy Statement (https://g ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsTelemetryConfiguration -Identity Site:Redmond ``` @@ -35,7 +36,7 @@ Remove-CsTelemetryConfiguration -Identity Site:Redmond This example removes the telemetry configuration for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTelemetryConfiguration -Filter "Site:*" | Remove-CsTelemetryConfiguration ``` @@ -46,7 +47,28 @@ The result is that all "Site" scoped telemetry configurations are removed. ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier that includes the scope of the telemetry configuration. Telemetry configurations can be scoped at the Global, Site, or Service level. For example, "site:Redmond" (for site). @@ -67,8 +89,7 @@ Specifying the Global configuration will return it to the default Global setting ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -78,13 +99,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -93,30 +116,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -130,13 +139,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### XdsIdentity This cmdlet takes pipeline input of the `Get-CsTelemetryConfiguration` cmdlet as shown in Example 2. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTenantUpdateTimeWindow.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTenantUpdateTimeWindow.md index 0927a0240a..39e97e60d3 100644 --- a/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTenantUpdateTimeWindow.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstenantupdatetimewindow applicable: Skype for Business Online -title: Remove-CsTenantUpdateTimeWindow -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstenantupdatetimewindow +schema: 2.0.0 +title: Remove-CsTenantUpdateTimeWindow --- # Remove-CsTenantUpdateTimeWindow @@ -34,7 +36,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsTenantUpdateTimeWindow -Identity "AlwaysOn" ``` @@ -44,48 +46,54 @@ This example removes the tenant update time window. ## PARAMETERS -### -Identity -Specifies the identity of the tenant update time window. +### -Force + +> Applicable: Skype for Business Online + +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: XdsGlobalRelativeIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the tenant update time window. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: 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. +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -94,14 +102,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -111,13 +121,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTestDevice.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsTestDevice.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTestDevice.md index 0cf245979f..91ef947c3a 100644 --- a/skype/skype-ps/skype/Remove-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTestDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTestDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstestdevice +schema: 2.0.0 +title: Remove-CsTestDevice --- # Remove-CsTestDevice @@ -45,7 +46,7 @@ You can also use the cmdlet to remove all the test devices configured for a give ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTestDevice -Identity site:Redmond ``` @@ -54,7 +55,7 @@ Example 1 removes all the test devices from the Redmond site. This will remove the device collection as well as the individual test devices. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTestDevice | Remove-CsTestDevice ``` @@ -63,7 +64,7 @@ The command shown in Example 2 removes all the test devices configured for use i Note that the global test device collection cannot be removed; however, this command will delete all the individual test devices configured at the global level. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsTestDevice -Filter "site:" | Remove-CsTestDevice ``` @@ -73,7 +74,7 @@ To carry out this task, the `Get-CsTestDevice` cmdlet and the Filter parameter a This filtered collection is then piped to the `Remove-CsTestDevice` cmdlet, which deletes all the items in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsTestDevice | Where-Object {$_.Name -match "LG-Nortel Phone"} | Remove-CsTestDevice ``` @@ -86,7 +87,28 @@ Any test device meeting that criterion is then deleted by using the `Remove-CsTe ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the test device to be removed. To remove a specific device, include both the scope (for example, site:Redmond) and the device name; for example: @@ -105,8 +127,7 @@ The global test device collection itself cannot be removed; however, the followi ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -115,14 +136,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -132,29 +155,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -168,13 +177,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice + The `Remove-CsTestDevice` cmdlet accepts pipelined input of the test device object. ## OUTPUTS -### +### None The `Remove-CsTestDevice` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. diff --git a/skype/skype-ps/skype/Remove-CsTestUserCredential.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTestUserCredential.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsTestUserCredential.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTestUserCredential.md index 2d8afa8192..638a865ec2 100644 --- a/skype/skype-ps/skype/Remove-CsTestUserCredential.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTestUserCredential.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstestusercredential applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTestUserCredential -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstestusercredential +schema: 2.0.0 +title: Remove-CsTestUserCredential --- # Remove-CsTestUserCredential @@ -42,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsTestUserCredential "sip:kenmyer@litwareinc.com" ``` @@ -50,7 +51,7 @@ Remove-CsTestUserCredential "sip:kenmyer@litwareinc.com" The command shown in Example 1 removes the user with the SIP address sip:kenmyer@litwareinc.com from the collection of users configured as watcher node test users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $ErrorActionPreference = "SilentlyContinue" @@ -71,7 +72,28 @@ The final command in the example resets the value of $ErrorActionPreference to " ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the account whose test user credentials are being removed. For example: @@ -80,8 +102,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -91,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,30 +129,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,14 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsTestUserCredential` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsTestUserCredential` cmdlet deletes existing instances of the System.Management.Automation.PSCredential object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystem.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystem.md index a55a5ee89b..8e0355cb33 100644 --- a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystem.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsThirdPartyVideoSystem -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csthirdpartyvideosystem +schema: 2.0.0 +title: Remove-CsThirdPartyVideoSystem --- # Remove-CsThirdPartyVideoSystem @@ -31,7 +32,7 @@ These contact objects can later be deleted by using the `Remove-CsThirdPartyVide ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsThirdPartyVideoSystem -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com" ``` @@ -40,7 +41,7 @@ The command shown in Example 1 removes the third-party video system that has the Video system identities can be returned by using the `Get-CsThirdPartyVideoSystem` cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video System"} | Remove-CsThirdPartyVideoSystem ``` @@ -49,7 +50,7 @@ In Example 2, the `Remove-CsThirdPartyVideoSystem` cmdlet is used to delete the To do this, the command first uses `Get-CsThirdPartyVideoSystem` and the Filter parameter to retrieve the Redmond Video System contact object (and does this without having to specify an Identity like CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com.) That contact object is then piped to and deleted by, the `Remove-CsThirdPartyVideoSystem` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsThirdPartyVideoSystem | Remove-CsThirdPartyVideoSystem ``` @@ -62,6 +63,9 @@ Those video systems are then piped to and removed by, the `Remove-CsThirdPartyVi ## PARAMETERS ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the third party video system to be removed. Video systems are identified by using the Active Directory distinguished name (DN) of the associated contact object. By default, these contacts use a globally unique identifier (GUID) as their common name; that means video systems will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. @@ -70,8 +74,7 @@ Because of that you might find it easier to retrieve video systems by using the ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -117,13 +124,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact The `Remove-CsThirdPartyVideoSystem` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object. ## OUTPUTS -### -None. +### None The `Remove-CsThirdPartyVideoSystem` cmdlet does not return any objects or data. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystemPolicy.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystemPolicy.md index e2e7dcdc56..4e88a07134 100644 --- a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystemPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsThirdPartyVideoSystemPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csthirdpartyvideosystempolicy +schema: 2.0.0 +title: Remove-CsThirdPartyVideoSystemPolicy --- # Remove-CsThirdPartyVideoSystemPolicy @@ -44,7 +45,7 @@ In this case, that means that the SupportsSendingLowResolution property will be ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsThirdPartyVideoSystemPolicy -Identity "RedmondVideoSystemPolicy ``` @@ -52,7 +53,7 @@ Remove-CsThirdPartyVideoSystemPolicy -Identity "RedmondVideoSystemPolicy The command shown in Example 1 removes the per-user third-party video system policy with the Identity RedmondVideoSystemPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystemPolicy | Remove-CsThirdPartyVideoSystemPolicy ``` @@ -63,7 +64,7 @@ Note that the global policy will not actually be deleted; Skype for Business Ser However, all the properties within the global policy will be reset to their default values. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsThirdPartyVideoSystemPolicy -Filter "site:*" | Remove-CsThirdPartyVideoSystemPolicy ``` @@ -75,7 +76,28 @@ Those policies are then piped to the `Remove-CsThirdPartyVideoSystemPolicy` cmdl ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the policy when it was created. Third party video system policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -99,8 +121,7 @@ Wildcard characters such as the asterisk (*) cannot be used with the Identity pa ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -109,30 +130,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Describes what would happen if you executed the command without actually executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the third party video system policy being removed. +For example: -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,21 +155,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the third party video system policy being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -Confirm -You can return the tenant ID for each of your tenants by running this command: +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,13 +196,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy The `Remove-CsThirdPartyVideoSystemPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object ## OUTPUTS -### -None. +### None Instead, the `Remove-CsThirdPartyVideoSystemPolicy` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrunkConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTrunkConfiguration.md index 4c863ae2fc..0add714c25 100644 --- a/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstrunkconfiguration +schema: 2.0.0 +title: Remove-CsTrunkConfiguration --- # Remove-CsTrunkConfiguration @@ -34,7 +35,7 @@ Instead the configuration will be "reset" and all custom settings will be replac ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTrunkConfiguration -Identity site:Redmond ``` @@ -42,7 +43,7 @@ Remove-CsTrunkConfiguration -Identity site:Redmond This example removes the trunk configuration with the Identity site:Redmond. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrunkConfiguration -Filter site:* | Remove-CsTrunkConfiguration ``` @@ -54,14 +55,34 @@ This collection of configurations is then piped to the `Remove-CsTrunkConfigurat ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the trunk configuration you want to remove. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -70,14 +91,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -87,29 +110,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -123,13 +132,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration + Accepts pipelined input of trunk configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration. diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplication.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsTrustedApplication.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplication.md index f740667361..81a03bd29e 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTrustedApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstrustedapplication +schema: 2.0.0 +title: Remove-CsTrustedApplication --- # Remove-CsTrustedApplication @@ -39,7 +40,7 @@ While this prefix is part of the Identity, it's not required when you specify th ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 ``` @@ -47,7 +48,7 @@ Remove-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 This example removes the trusted application with the Identity TrustPool.litwareinc.com/tapp2 from the associated trusted service. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrustedApplication -Filter *trust* | Remove-CsTrustedApplication ``` @@ -61,15 +62,35 @@ The collection of trusted applications that is retrieved is then piped to the `R ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the trusted application to be removed from the trusted application pool. Identity values must be entered in the format \/\, where pool FQDN is the FQDN of the pool on which the application resides and application ID is the name of the application. ```yaml Type: ExternalApplicationIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -78,14 +99,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -95,29 +118,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -131,13 +140,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.DisplayTrustedApplication object. +### Microsoft.Rtc.Management.Xds.DisplayTrustedApplication + Accepts pipelined input of trusted application objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplication. diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationComputer.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationComputer.md index b98867daaa..66d87b18e7 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationcomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTrustedApplicationComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstrustedapplicationcomputer +schema: 2.0.0 +title: Remove-CsTrustedApplicationComputer --- # Remove-CsTrustedApplicationComputer @@ -37,7 +38,7 @@ If you want to remove the only computer on a pool you must remove the entire poo ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTrustedApplicationComputer -Identity Trust1.litwareinc.com ``` @@ -45,7 +46,7 @@ Remove-CsTrustedApplicationComputer -Identity Trust1.litwareinc.com This example removes the computer with the FQDN Trust1.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrustedApplicationComputer -Filter Trust* | Remove-CsTrustedApplicationComputer ``` @@ -59,14 +60,34 @@ Keep in mind that this won't remove the computers from a pool if removing those ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The fully qualified domain name (FQDN) of the computer to remove. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -75,14 +96,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -92,29 +115,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -128,13 +137,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.DisplayComputer object. +### Microsoft.Rtc.Management.Xds.DisplayComputer + Accepts pipelined input of trusted application computer objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Xds.DisplayComputer. diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationEndpoint.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationEndpoint.md index e90e6d3555..f82793a266 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTrustedApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstrustedapplicationendpoint +schema: 2.0.0 +title: Remove-CsTrustedApplicationEndpoint --- # Remove-CsTrustedApplicationEndpoint @@ -30,7 +31,7 @@ This cmdlet removes an existing endpoint contact object from Active Directory Do ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTrustedApplicationEndpoint -Identity "Endpoint 1" ``` @@ -39,7 +40,7 @@ This example removes the endpoint contact with the Identity (in this case the di Because identities must be unique, this command will remove, at most, one endpoint. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrustedApplicationEndpoint -ApplicationId tapp2 | Remove-CsTrustedApplicationEndpoint ``` @@ -54,13 +55,15 @@ Keep in mind that this call to the `Get-CsTrustedApplicationEndpoint` cmdlet cou ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (the distinguished name of the contact), SIP address, or display name of the application endpoint to be removed. ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -69,14 +72,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -85,14 +90,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -106,13 +113,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact + Accepts pipelined input of trusted application endpoint objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact. diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationPool.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationPool.md index 1d488c17fc..5ebc018e4a 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTrustedApplicationPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstrustedapplicationpool +schema: 2.0.0 +title: Remove-CsTrustedApplicationPool --- # Remove-CsTrustedApplicationPool @@ -36,7 +37,7 @@ Keep in mind that removing the pool also removes all computers, applications and ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com ``` @@ -46,7 +47,7 @@ We use the Identity parameter to specify the FQDN of the pool we want to remove. Because identities are unique, this command will remove, at most, one pool. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrustedApplicationPool | Where-Object {$_.PoolFqdn -match "trust*"} | Remove-CsTrustedApplicationPool ``` @@ -61,14 +62,34 @@ Finally, this collection is piped to the `Remove-CsTrustedApplicationPool` cmdle ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The fully qualified domain name (FQDN) or service ID of the pool you want to remove. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -77,14 +98,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -94,29 +117,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -130,13 +139,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.DisplayExternalServer object. +### Microsoft.Rtc.Management.Xds.DisplayExternalServer + Accepts pipelined input of trusted application pool objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. diff --git a/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUCPhoneConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUCPhoneConfiguration.md index f45cd01e67..c840780b08 100644 --- a/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUCPhoneConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csucphoneconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUCPhoneConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csucphoneconfiguration +schema: 2.0.0 +title: Remove-CsUCPhoneConfiguration --- # Remove-CsUCPhoneConfiguration @@ -47,7 +48,7 @@ For example, if you have changed the phone lock time interval to 30 minutes, "re ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsUCPhoneConfiguration -Identity site:Redmond ``` @@ -56,7 +57,7 @@ The command shown in Example 1 removes the UC phone configuration settings for t When settings are removed from a site scope, users in that site will have their UC phones governed by the global phone configuration settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsUCPhoneConfiguration -Filter site:* | Remove-CsUCPhoneConfiguration ``` @@ -66,7 +67,7 @@ To do this, the command first uses the `Get-CsUCPhoneConfiguration` cmdlet and t This filtered collection is then piped to the `Remove-CsUCPhoneConfiguration` cmdlet, which removes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.EnforcePhoneLock -eq $False} | Remove-CsUCPhoneConfiguration ``` @@ -77,7 +78,7 @@ This collection is piped to the `Where-Object` cmdlet, which picks out only thos In turn, that filtered collection is piped to the `Remove-CsUCPhoneConfiguration` cmdlet, which removes each item in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.SIPSecurityMode -ne "High"} | Remove-CsUCPhoneConfiguration ``` @@ -90,7 +91,28 @@ This collection is then piped to the `Where-Object` cmdlet, which selects only t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of UC phone configuration settings to be removed. To remove a site collection use syntax similar to this: @@ -106,8 +128,7 @@ Note that you cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -116,14 +137,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -133,29 +156,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -169,14 +178,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings + The `Remove-CsUCPhoneConfiguration` cmdlet accepts pipelined instances of the UC phone settings object. ## OUTPUTS -### -None. +### None Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUnassignedNumber.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsUnassignedNumber.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUnassignedNumber.md index 76c0291f9f..2c4fae7d52 100644 --- a/skype/skype-ps/skype/Remove-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUnassignedNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUnassignedNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csunassignednumber +schema: 2.0.0 +title: Remove-CsUnassignedNumber --- # Remove-CsUnassignedNumber @@ -32,7 +33,7 @@ This cmdlet removes the settings that define that routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsUnassignedNumber -Identity UNSet1 ``` @@ -40,7 +41,7 @@ Remove-CsUnassignedNumber -Identity UNSet1 In this example, the unassigned number settings with the Identity UNSet1 are removed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUnassignedNumber | Where-Object {$_.AnnouncementName -match "Welcome"} | Remove-CsUnassignedNumber ``` @@ -53,14 +54,34 @@ Finally, the narrowed-down collection is passed to the `Remove-CsUnassignedNumbe ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique name for the range of unassigned numbers you want to remove. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -69,14 +90,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -86,29 +109,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -122,13 +131,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange object. +### Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange + Accepts pipelined input of unassigned number objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange. diff --git a/skype/skype-ps/skype/Remove-CsUserAcp.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserAcp.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsUserAcp.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUserAcp.md index dc022a2e7e..e6dd5fdc91 100644 --- a/skype/skype-ps/skype/Remove-CsUserAcp.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserAcp.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Remove-CsUserAcp -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csuseracp +schema: 2.0.0 +title: Remove-CsUserAcp --- # Remove-CsUserAcp @@ -50,7 +52,7 @@ For example this command removes any audio conferencing providers that have the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsUserAcp -Identity "Ken Myer" ``` @@ -58,7 +60,7 @@ Remove-CsUserAcp -Identity "Ken Myer" The command shown in Example 1 removes all the audio conferencing providers that have been assigned to the user Ken Myer. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsUser | Remove-CsUserAcp ``` @@ -68,7 +70,7 @@ To do this, the command first uses the `Get-CsUser` cmdlet to retrieve a collect That collection is then piped to the `Remove-CsUserAcp` cmdlet, which removes all the audio conferencing providers that have been assigned to each user in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Remove-CsUserAcp -Identity "Ken Myer" -Name "Fabrikam ACP" ``` @@ -76,7 +78,7 @@ Remove-CsUserAcp -Identity "Ken Myer" -Name "Fabrikam ACP" In Example 3, all the audio conferencing providers that have the Name "Fabrikam ACP" are removed from Ken Myer's user account. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsUserAcp | Where-Object {$_.AcpInfo -match "14255551298"} | Remove-CsUserAcp ``` @@ -90,6 +92,9 @@ This filtered collection is then piped to the `Remove-CsUserAcp` cmdlet, which r ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account from which the audio conferencing provider is to be removed. You can specify a user's identity 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 Domain Services display name (for example, Ken Myer). User Identities can also be reference by using the user's Active Directory distinguished name. @@ -101,8 +106,7 @@ For example, the Identity "* Smith" returns all the users with a display name th ```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 +Aliases: Required: True Position: 1 @@ -112,6 +116,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the audio conferencing provider. For example: @@ -121,8 +128,7 @@ For example: ```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 +Aliases: Required: False Position: Named @@ -131,18 +137,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TollNumber -Non-toll-free phone number used for audio conferences. +### -ParticipantPasscode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Passcode required when connecting to a conference by using the audio conferencing provider. For example: -`-TollNumber "14255551298"` +`-PassCode "0712"` ```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 +Aliases: Required: False Position: Named @@ -152,6 +160,9 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user who is having the audio conferencing provider removed. By default, the `Remove-CsUserAcp` cmdlet does not pass objects through the pipeline. @@ -159,8 +170,7 @@ By default, the `Remove-CsUserAcp` cmdlet does not pass objects through the pipe ```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 +Aliases: Required: False Position: Named @@ -169,15 +179,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -TollNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Non-toll-free phone number used for audio conferences. +For example: + +`-TollNumber "14255551298"` ```yaml -Type: SwitchParameter +Type: String 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 +Aliases: Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -194,7 +212,6 @@ Prompts you for confirmation before executing the command. 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 @@ -203,18 +220,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ParticipantPasscode -Passcode required when connecting to a conference by using the audio conferencing provider. -For example: +### -WhatIf -`-PassCode "0712"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +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 +Aliases: wi Required: False Position: Named @@ -228,15 +244,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.Stringor Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. The `Remove-CsUserAcp` 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 -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserReplicatorConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUserReplicatorConfiguration.md index 1c2fa5fc3f..7ceb608ee8 100644 --- a/skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserReplicatorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUserReplicatorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csuserreplicatorconfiguration +schema: 2.0.0 +title: Remove-CsUserReplicatorConfiguration --- # Remove-CsUserReplicatorConfiguration @@ -53,7 +54,7 @@ In the case of the User Replicator, that means erasing the list of domains that ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsUserReplicatorConfiguration -Identity global ``` @@ -63,7 +64,28 @@ Example 1 resets the global User Replicator configuration settings. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the User Replicator configuration settings to be removed. To remove settings at the service scope, use syntax similar to this: @@ -80,8 +102,7 @@ You cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -90,14 +111,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -107,29 +130,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -143,14 +152,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration + The `Remove-CsUserReplicatorConfiguration` cmdlet accepts pipelined input of the User Replicator configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsUserReplicatorConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesConfiguration.md index 373e6cace5..91edca6e2a 100644 --- a/skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUserServicesConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csuserservicesconfiguration +schema: 2.0.0 +title: Remove-CsUserServicesConfiguration --- # Remove-CsUserServicesConfiguration @@ -38,7 +39,7 @@ For example, if you have changed the MaxContacts value in the global settings to ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsUserServicesConfiguration -Identity site:Redmond ``` @@ -46,7 +47,7 @@ Remove-CsUserServicesConfiguration -Identity site:Redmond The command shown in Example 1 removes the User Services configuration settings from the Redmond site (`-Identity site:Redmond`). -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsUserServicesConfiguration -Filter "service:*:" | Remove-CsUserServicesConfiguration ``` @@ -57,7 +58,7 @@ The filter value "service:*" limits returned data to settings configured at the This filtered collection is then piped to the `Remove-CsUserServicesConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsUserServicesConfiguration | Where-Object {$_.MaxContacts -gt 250} | Remove-CsUserServicesConfiguration ``` @@ -70,7 +71,28 @@ Those settings are then piped to and removed by, the `Remove-CsUserServicesConfi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the User Services configuration settings to be removed. To delete settings configured at the site scope, use syntax similar to this: @@ -88,8 +110,7 @@ Instead, all the properties in that collection will be reset to their default va ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -98,14 +119,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -115,29 +138,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -151,14 +160,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings + The `Remove-CsUserServicesConfiguration` cmdlet accepts pipelined instances of the User Services settings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsUserServicesConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesPolicy.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsUserServicesPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesPolicy.md index b5402b89cb..0eb4d25373 100644 --- a/skype/skype-ps/skype/Remove-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUserServicesPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csuserservicespolicy +schema: 2.0.0 +title: Remove-CsUserServicesPolicy --- # Remove-CsUserServicesPolicy @@ -45,7 +46,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsUserServicesPolicy -Identity "RedmondUserServicesPolicy" ``` @@ -53,7 +54,7 @@ Remove-CsUserServicesPolicy -Identity "RedmondUserServicesPolicy" The command shown in Example 1 deletes the per-user User Services policy RedmondUserServicesPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUserServicesPolicy -Filter "site:*" | Remove-CsUserServicesPolicy ``` @@ -63,7 +64,7 @@ To do this, the command first uses the `Get-CsUserServicesPolicy` cmdlet and the The resulting collection is then piped to the `Remove-CsUserServicesPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUserServicesPolicy | Where-Object {$_.UcsAllowed -eq $True} | Remove-CsUserServicesPolicy ``` @@ -76,7 +77,28 @@ Those policies are then piped to and removed by, the `Remove-CsUserServicesPolic ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be deleted. To remove a policy configured at the site scope, use syntax similar to this: @@ -96,8 +118,7 @@ To remove per-user policies, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -106,30 +127,20 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Removes the user services policy assigned to the specified Skype for Business Online tenant. +When removing a policy assigned to a tenant, you must also include the Identity parameter along with the parameter value "global": + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -Identity "global"` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,18 +149,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Removes the user services policy assigned to the specified Skype for Business Online tenant. -When removing a policy assigned to a tenant, you must also include the Identity parameter along with the parameter value "global": +### -Confirm -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -Identity "global"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -159,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -179,13 +190,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy The `Remove-CsUserServicesPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsUserServicesPolicy` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsUserStoreBackupData.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserStoreBackupData.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsUserStoreBackupData.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUserStoreBackupData.md index a03b9546bf..aa096ba5ce 100644 --- a/skype/skype-ps/skype/Remove-CsUserStoreBackupData.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserStoreBackupData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserstorebackupdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUserStoreBackupData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csuserstorebackupdata +schema: 2.0.0 +title: Remove-CsUserStoreBackupData --- # Remove-CsUserStoreBackupData @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsUserStoreBackupData -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -49,49 +50,55 @@ The command shown in Example 1 removes outdated user store information stored by ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool where "outdated" user information should be removed. -For example: +### -Force -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool where "outdated" user information should be removed. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -121,14 +130,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsUserStoreBackupData` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerConfiguration.md index 3aebb35e96..420ad4a58a 100644 --- a/skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVideoInteropServerConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvideointeropserverconfiguration +schema: 2.0.0 +title: Remove-CsVideoInteropServerConfiguration --- # Remove-CsVideoInteropServerConfiguration @@ -43,7 +44,7 @@ Skype for Business Server does not allow you to delete the global settings. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVideoInteropServerConfiguration -Identity "site:Redmond" ``` @@ -51,7 +52,7 @@ Remove-CsVideoInteropServerConfiguration -Identity "site:Redmond" This example deletes the VIS configuration settings assigned to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoInteropServerConfiguration -Filter "site:*" | Remove-CsVideoInteropServerConfiguration ``` @@ -61,7 +62,7 @@ The command calls the `Get-CsVideoInteropServerConfiguration` and filters the co Those configuration objects are then piped to and deleted by, the `Remove-CsVideoInteropServerConfiguration` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVideoInteropServerConfiguration | Where-Object {$_.EnableEnhancedVideoExperience -eq $True} | Remove-CsVideoInteropServerConfiguration ``` @@ -74,7 +75,28 @@ Those configuration objects are then piped to and deleted by the `Remove-CsVideo ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the video interop service configuration settings when they were created. Video interop settings can be assigned at the global, site, or service scope (for the VideoInteropServer service only). For example, to remove settings configured at the site scope use the following syntax: @@ -89,8 +111,7 @@ Instead, all the properties within the collection will be reset to their default ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -100,13 +121,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -115,30 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -152,13 +161,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration The `Remove-CsVideoInteropServerConfiguration` cmdlet accepts pipelined input of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. ## OUTPUTS -### -None. +### None The `Remove-CsVideoInteropServerConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md index c5fe430c83..3185e93285 100644 --- a/skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVideoInteropServerSyntheticTransactionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvideointeropserversynthetictransactionconfiguration +schema: 2.0.0 +title: Remove-CsVideoInteropServerSyntheticTransactionConfiguration --- # Remove-CsVideoInteropServerSyntheticTransactionConfiguration @@ -29,7 +30,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVideoInteropServerSyntheticTransactionConfiguration -Identity "site:Redmond" ``` @@ -39,7 +40,28 @@ This example removes the Video Interop Server synthetic transaction configuratio ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the VIS configuration to be removed. VIS settings can be configured at the global, site, or service scope (for the VideoInteropServer service only). To refer to the global instance, use this syntax: @@ -53,8 +75,7 @@ Use this syntax to refer to a collection at the site scope: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -64,13 +85,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -79,30 +102,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -116,13 +125,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerSyntheticTransactionConfiguration Accepts pipelined instances of the VideoInteropServerSyntheticTransactionConfiguration object. ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoTrunkConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVideoTrunkConfiguration.md index 820a5f657f..63191a39a2 100644 --- a/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVideoTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvideotrunkconfiguration +schema: 2.0.0 +title: Remove-CsVideoTrunkConfiguration --- # Remove-CsVideoTrunkConfiguration @@ -47,7 +48,7 @@ However, administrators can use the `New-CsVideoTrunkConfiguration` cmdlet to cr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVideoTrunkConfiguration -Identity "site:Seattle" ``` @@ -55,7 +56,7 @@ Remove-CsVideoTrunkConfiguration -Identity "site:Seattle" This example removes the Video Trunk configuration settings scoped to the Seattle site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoTrunkConfiguration -Filter "site:*" | Remove-CsVideoTrunkConfiguration ``` @@ -67,7 +68,28 @@ Those configuration objects are then piped to, and removed by, the `Remove-CsVid ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Identity parameter specifies the Video Trunk configuration to remove. Video Trunk configuration settings can be configured at the global, site, or service scope (for the VideoGateway service only). To refer to the global instance, use this syntax: `-Identity "global"` To refer to a collection at the site scope: `-Identity "site:Redmond"` @@ -81,8 +103,7 @@ Instead, all the properties within the collection will be reset to their default ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -92,13 +113,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -107,30 +130,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -144,13 +153,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration The` Remove-CsVideoTrunkConfiguration` cmdlet accepts pipelined input of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration object. ## OUTPUTS -### -None. +### None The `Remove-CsVideoTrunkConfiguration` cmdlet removes specified Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration objects. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsVoiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoiceConfiguration.md index ce31f612a4..feaa482065 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoiceconfiguration +schema: 2.0.0 +title: Remove-CsVoiceConfiguration --- # Remove-CsVoiceConfiguration @@ -35,7 +36,7 @@ After calling this cmdlet, a call to the `Get-CsVoiceTestConfiguration` cmdlet w ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoiceConfiguration -Identity Global -Confirm ``` @@ -46,15 +47,35 @@ This action deletes all defined voice test configurations, so we added the Confi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The scope of the voice configuration to remove. This value must be Global. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -63,14 +84,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -80,29 +103,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -116,13 +125,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration + Accepts pipelined input of a voice configuration object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration This cmdlet removes (resets) an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceNormalizationRule.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoiceNormalizationRule.md index 4513a469fb..c5c76e6026 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceNormalizationRule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicenormalizationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoicenormalizationrule +schema: 2.0.0 +title: Remove-CsVoiceNormalizationRule --- # Remove-CsVoiceNormalizationRule @@ -37,7 +39,7 @@ This means that calling the `Remove-CsVoiceNormalizationRule` cmdlet could leave ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoiceNormalizationRule -Identity site:Redmond/SeattleRule1 ``` @@ -45,7 +47,7 @@ Remove-CsVoiceNormalizationRule -Identity site:Redmond/SeattleRule1 This example removes the voice normalization rule with the Identity site:Redmond/SeattleRule1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Remove-CsVoiceNormalizationRule -Identity site:Redmond ``` @@ -55,51 +57,56 @@ This example removes all voice normalization rules from site Redmond. ## PARAMETERS -### -Identity -The unique identity of the rule to be removed. -If the Identity specified includes 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 one rule with that unique Identity will be removed. -If the value passed to the Identity contains only the scope (site:Redmond), all normalization rules at that scope will be removed. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identity of the rule to be removed. +If the Identity specified includes 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 one rule with that unique Identity will be removed. +If the value passed to the Identity contains only the scope (site:Redmond), all normalization rules at that scope will be removed. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +For internal Microsoft usage. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -116,7 +126,6 @@ Prompts you for confirmation before executing the command. 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 @@ -125,14 +134,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal Microsoft usage. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -146,13 +158,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule + Accepts pipelined input of voice normalization rule objects. ## OUTPUTS -### +### None This cmdlet deletes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicePolicy.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoicePolicy.md index 137f719863..1b3fbebbb7 100644 --- a/skype/skype-ps/skype/Remove-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoicePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoicepolicy +schema: 2.0.0 +title: Remove-CsVoicePolicy --- # Remove-CsVoicePolicy @@ -33,7 +34,7 @@ In that case, however, the policy will not actually be removed; instead, the pol ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoicePolicy -Identity UserVoicePolicy1 ``` @@ -41,7 +42,7 @@ Remove-CsVoicePolicy -Identity UserVoicePolicy1 This example removes the UserVoicePolicy1 per-user voice policy settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoicePolicy -Filter tag* | Remove-CsVoicePolicy ``` @@ -53,15 +54,35 @@ That collection of policies is then piped to the `Remove-CsVoicePolicy` cmdlet t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier specifying the scope and in some cases the name, of the policy to be removed. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -70,30 +91,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the voice policy being deleted. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,13 +117,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -118,21 +134,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the voice policy being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -146,13 +157,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy + Accepts pipelined input of voice policy objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an instance of a Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. diff --git a/skype/skype-ps/skype/Remove-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoute.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsVoiceRoute.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoute.md index 97f01579c4..f352b5f7fe 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoiceRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoiceroute +schema: 2.0.0 +title: Remove-CsVoiceRoute --- # Remove-CsVoiceRoute @@ -31,7 +32,7 @@ Voice routes are associated with voice policies through PSTN usages, so removing ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoiceRoute -Identity Route1 ``` @@ -39,7 +40,7 @@ Remove-CsVoiceRoute -Identity Route1 Removes the settings for the voice route with the identity Route1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceRoute | Remove-CsVoiceRoute ``` @@ -49,7 +50,7 @@ First all voice routes are retrieved by the `Get-CsVoiceRoute` cmdlet. These voice routes are then piped to the `Remove-CsVoiceRoute` cmdlet, which removes each one. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoute -Filter *Redmond* | Remove-CsVoiceRoute ``` @@ -61,15 +62,35 @@ After all of the voice routes with identities that include the string Redmond ar ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string that uniquely identifies the voice route you want to delete. (If the route name contains a space, such as Test Route, you must enclose the full string in double quotes.) ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -78,14 +99,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -95,29 +118,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -131,13 +140,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route + Accepts pipelined input of voice route objects. ## OUTPUTS -### +### None Removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoutingPolicy.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoutingPolicy.md index 2d439ee40e..835f61b2e2 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoiceRoutingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoiceroutingpolicy +schema: 2.0.0 +title: Remove-CsVoiceRoutingPolicy --- # Remove-CsVoiceRoutingPolicy @@ -37,7 +38,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" ``` @@ -45,7 +46,7 @@ Remove-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" The command shown in Example 1 deletes the voice routing policy RedmondVoiceRoutingPolicy -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceRoutingPolicy -Filter "tag:*" | Remove-CsVoiceRoutingPolicy ``` @@ -55,7 +56,7 @@ To do this, the command first calls the `Get-CsVoiceRoutingPolicy` cmdlet along Those per-user policies are then piped to and removed by, the `Remove-CsVoiceRoutingPolicy` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoutingPolicy | Where-Object {$_.PstnUsages -contains "Long Distance"} | Remove-CsVoiceRoutingPolicy ``` @@ -67,7 +68,33 @@ That collection is then piped to the `Where-Object` cmdlet, which picks out only ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one user. + +If this parameter is not present, then the `Remove-CsVoiceRoutingPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. +Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. +You must answer yes (by pressing the Y key) before the command will continue and the policy will be removed. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the voice routing policy to be removed. To "remove" the global policy, use the following syntax: @@ -85,8 +112,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -96,13 +122,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -111,35 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one user. - -If this parameter is not present, then the `Remove-CsVoiceRoutingPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. -Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. -You must answer yes (by pressing the Y key) before the command will continue and the policy will be removed. - +### -WhatIf -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` - -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -153,13 +162,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy The `Remove-CsVoiceRoutingPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsVoiceRoutingPolicy` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceTestConfiguration.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoiceTestConfiguration.md index 0a7f3baca9..af6648cb7e 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceTestConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoiceTestConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoicetestconfiguration +schema: 2.0.0 +title: Remove-CsVoiceTestConfiguration --- # Remove-CsVoiceTestConfiguration @@ -31,7 +32,7 @@ When you're done with those tests and won't need them again, use this cmdlet to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoiceTestConfiguration -Identity TestConfig1 ``` @@ -39,7 +40,7 @@ Remove-CsVoiceTestConfiguration -Identity TestConfig1 This example removes the voice test configuration settings with the Identity TestConfig1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceTestConfiguration -Filter *test* | Remove-CsVoiceTestConfiguration ``` @@ -51,14 +52,34 @@ The resulting set of configurations is then piped to the `Remove-CsVoiceTestConf ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string uniquely identifying the test configuration you want to remove. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -67,14 +88,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -84,29 +107,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -120,13 +129,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration + Accepts pipelined input of voice test configuration objects. ## OUTPUTS -### +### None Removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicemailReroutingConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoicemailReroutingConfiguration.md index 9a5d3a1dfd..1a53386901 100644 --- a/skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicemailReroutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoicemailReroutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoicemailreroutingconfiguration +schema: 2.0.0 +title: Remove-CsVoicemailReroutingConfiguration --- # Remove-CsVoicemailReroutingConfiguration @@ -37,7 +38,7 @@ Note that if you call this cmdlet to remove the Global settings, those settings ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoicemailReroutingConfiguration -Identity site:Redmond1 ``` @@ -45,7 +46,7 @@ Remove-CsVoicemailReroutingConfiguration -Identity site:Redmond1 This example removes the voice mail rerouting configuration settings for the site Redmond1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoicemailReroutingConfiguration | Remove-CsVoicemailReroutingConfiguration ``` @@ -57,15 +58,35 @@ The settings retrieved by this call are then passed to the `Remove-CsVoicemailRe ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the configuration you want to remove. For this cmdlet the Identity will be either Global or Site:\, where \ is the name of the site to which the settings are applied. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,14 +95,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -91,29 +114,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -127,13 +136,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration + Accepts pipelined input of voice mail rerouting configuration objects. ## OUTPUTS -### +### None Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsWatcherNodeConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsWatcherNodeConfiguration.md index e6ad98fce0..d9fb9a2d0d 100644 --- a/skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsWatcherNodeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsWatcherNodeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cswatchernodeconfiguration +schema: 2.0.0 +title: Remove-CsWatcherNodeConfiguration --- # Remove-CsWatcherNodeConfiguration @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" ``` @@ -47,7 +48,7 @@ Remove-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" The command shown in Example 1 removes the watcher node configuration settings applied to the pool `atl-cs-001.litwareinc.com`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsWatcherNodeConfiguration | Remove-CsWatcherNodeConfiguration ``` @@ -58,7 +59,7 @@ This collection is then piped to the `Remove-CsWatcherNodeConfiguration` cmdlet, That effectively removes each watcher node in the organization. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsWatcherNodeConfiguration | Where-Object {$_.TestUsers -contains "sip:kenmyer@litwareinc.com"} | Remove-CsWatcherNodeConfiguration ``` @@ -71,7 +72,28 @@ That filtered collection is then piped to the `Remove-CsWatcherNodeConfiguration ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that has been assigned the watcher node being deleted. For example: @@ -80,8 +102,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -91,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,30 +129,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,13 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated The `Remove-CsWatcherNodeConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsWatcherNodeConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsWebServiceConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsWebServiceConfiguration.md index 11ae5b1038..58c9599b15 100644 --- a/skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsWebServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsWebServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cswebserviceconfiguration +schema: 2.0.0 +title: Remove-CsWebServiceConfiguration --- # Remove-CsWebServiceConfiguration @@ -42,7 +43,7 @@ Because the default value for this property is 100, "removing" the global collec ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsWebServiceConfiguration -Identity site:Redmond ``` @@ -50,7 +51,7 @@ Remove-CsWebServiceConfiguration -Identity site:Redmond Example 1 removes the Web Services configuration settings for the Redmond site. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsWebServiceConfiguration -Filter "site:*" | Remove-CsWebServiceConfiguration ``` @@ -60,7 +61,7 @@ To carry out this task, the command first calls the `Get-CsWebServiceConfigurati This filtered collection is then piped to the `Remove-CsWebServiceConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsWebServiceConfiguration | Where-Object {$_.EnableGroupExpansion -eq $False} | Remove-CsWebServiceConfiguration ``` @@ -73,7 +74,28 @@ The filtered collection is then piped to the `Remove-CsWebServiceConfiguration` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the Web Services configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: @@ -93,8 +115,7 @@ To reset the global collection, use this syntax: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,14 +124,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -120,29 +143,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -156,14 +165,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings + The `Remove-CsWebServiceConfiguration` cmdlet accepts pipelined input of the Web Services settings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsWebServiceConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/Remove-CsXmppAllowedPartner.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsXmppAllowedPartner.md index fabbb2d393..42c62f478b 100644 --- a/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsXmppAllowedPartner.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Remove-CsXmppAllowedPartner -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csxmppallowedpartner +schema: 2.0.0 +title: Remove-CsXmppAllowedPartner --- # Remove-CsXmppAllowedPartner @@ -40,7 +41,7 @@ Select the partner to be removed, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsXmppAllowedPartner -Identity "contoso.com" ``` @@ -48,7 +49,7 @@ Remove-CsXmppAllowedPartner -Identity "contoso.com" Example 1 deletes the XMPP allowed partner with the Identity "contoso.com". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsXmppAllowedPartner | Remove-CsXmppAllowedPartner ``` @@ -58,7 +59,7 @@ To carry out this task the command first calls the `Get-CsXmppAllowedPartner` cm This collection is then piped to the `Remove-CsXmppAllowedPartner` cmdlet, which removes each partner in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsXmppAllowedPartner | Where-Object {$_.PartnerType -eq "PublicUnverified"} | Remove-CsXmppAllowedPartner ``` @@ -71,7 +72,28 @@ The partners that meet that criterion are then piped to and deleted by, the `Rem ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name (FQDN) of the XMPP allowed partner to be deleted. For example: @@ -80,8 +102,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 2 @@ -91,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -106,30 +129,16 @@ 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 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -143,13 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated The `Remove-CsXmppAllowedPartner` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsXmppAllowedPartner` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Request-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Request-CsCertificate.md similarity index 81% rename from skype/skype-ps/skype/Request-CsCertificate.md rename to skype/skype-ps/SkypeForBusiness/Request-CsCertificate.md index 56a2d03fd8..6bf5aee446 100644 --- a/skype/skype-ps/skype/Request-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Request-CsCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/request-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Request-CsCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/request-cscertificate +schema: 2.0.0 +title: Request-CsCertificate --- # Request-CsCertificate @@ -72,7 +73,7 @@ After that you should be able to retrieve certificate requests. ## EXAMPLES -### -------------------------- Example 1 ----------------------- +### Example 1 ``` Request-CsCertificate -New -Type WebServicesExternal -CA "atl-ca-001.litwareinc.com\myca" ``` @@ -80,7 +81,7 @@ Request-CsCertificate -New -Type WebServicesExternal -CA "atl-ca-001.litwareinc. The command shown in Example 1 creates a new certificate request: it contacts the CA atl-ca-001.litwareinc.com\myca and requests a new WebServicesExternal certificate. -### -------------------------- Example 2 ----------------------- +### Example 2 ``` Request-CsCertificate -List ``` @@ -88,7 +89,7 @@ Request-CsCertificate -List Example 2 lists all the pending certificate requests made by using the `Request-CsCertificate` cmdlet. -### -------------------------- Example 3 ----------------------- +### Example 3 ``` Request-CsCertificate -New -Type WebServicesExternal -Output C:\Certificates\WebServicesExternal.cer ``` @@ -96,7 +97,7 @@ Request-CsCertificate -New -Type WebServicesExternal -Output C:\Certificates\Web Example 3 uses the Output parameter to create an offline certificate request. -### -------------------------- Example 4 ----------------------- +### 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 Certificate" -Template jcila -PrivateKeyExportable $True -DomainName "atl-cs-001.litwareinc.com,atl-ext.litwareinc.com" ``` @@ -105,7 +106,7 @@ Example 4 is a more detailed (and more realistic) example of how to use the `Req This example requests a certificate for use with the Standard Edition of Skype for Business Server. -### -------------------------- Example 5 ----------------------- +### Example 5 ``` Request-CsCertificate -New -Type Default,WebServicesInternal,WebServicesExternal -ComputerFqdn "atl-cs-001.litwareinc.com" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "Enterprise Edition Pool Certificate" -Template jcila -PrivateKeyExportable $True -DomainName "pool1.litwareinc.com,pool1int.litwareinc.com,pool1ext.litwareinc.com" ``` @@ -113,7 +114,7 @@ Request-CsCertificate -New -Type Default,WebServicesInternal,WebServicesExternal In Example 5, a pool certificate is requested for use with the Enterprise Edition of Skype for Business Server. -### -------------------------- Example 6 ----------------------- +### Example 6 ``` Request-CsCertificate -New -Type Internal -ComputerFqdn "atl-edge-001" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "Internal Edge Certificate" -Template jcila -PrivateKeyExportable $True -DomainName "atl-edge-001.litwareinc.com, ap.litwareinc.com" ``` @@ -121,7 +122,7 @@ Request-CsCertificate -New -Type Internal -ComputerFqdn "atl-edge-001" -CA "atl- Example 6 shows how you can request a certificate for the internal Edge Server. -### -------------------------- Example 7 ----------------------- +### Example 7 ``` Request-CsCertificate -New -Type AccessEdgeExternal,DataEdgeExternal,AudioVideoAuthentication -ComputerFqdn "atl-edge-001" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "External Edge Certificate" -Template jcila -PrivateKeyExportable $True -DomainName "atl-edge-001.litwareinc.com,ap.litwareinc.com,dp.litwareinc.com,atl-edge-001" ``` @@ -131,52 +132,20 @@ Example 7 is a variation of the command shown in Example 6, In this case, howeve ## PARAMETERS -### -Type -Type of certificate being requested. -Certificate types include (but are not limited to): - -AccessEdgeExternal - -AudioVideoAuthentication - -DataEdgeExternal - -Default - -External - -Internal - -iPhoneAPNService - -iPadAPNService - -MPNService - -PICWebService (Skype for Business Online only) - -ProvisionService (Skype for Business Online only) - -WebServicesExternal - -WebServicesInternal - -WsFedTokenTransfer - -For example, this syntax requests a new Default certificate: `-Type Default`. - -You can specify multiple types in a single command by separating the certificate types with commas: +### -AllSipDomain -`-Type Internal,External,Default` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When present, all your SIP domains are automatically added to the certificates Subject Alternative Name field. +If not present, only the primary SIP domain is added by default. +However, additional domains can be specified by using the DomainName parameter. ```yaml -Type: CertType[] +Type: SwitchParameter Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -184,6 +153,9 @@ Accept wildcard characters: False ``` ### -CA + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) that points to the CA. For example: `-CA "atl-ca-001.litwareinc.com\myca"`. To obtain a list of known CAs, type the following at the Windows PowerShell prompt, and then press ENTER: @@ -195,8 +167,7 @@ The Config property returned by Certutil indicates the location of a CA. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +177,9 @@ Accept wildcard characters: False ``` ### -CaAccount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Account name of the user requesting the new certificate, using the format domain_name\user_name. For example: `-CaAccount "litwareinc\kenmyer"`. If not specified, the `Request-CsCertificate` cmdlet will use the credentials of the logged-on user when requesting the new certificate. @@ -214,8 +188,7 @@ If not specified, the `Request-CsCertificate` cmdlet will use the credentials of ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,13 +198,15 @@ Accept wildcard characters: False ``` ### -CaPassword + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Password for the user requesting the new certificate (as specified using the CaAccount parameter). ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,13 +216,15 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + City where the certificate will be deployed. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,14 +234,16 @@ Accept wildcard characters: False ``` ### -Clear + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, deletes any pending certificate requests made by using the `Request-CsCertificate` cmdlet. ```yaml Type: SwitchParameter Parameter Sets: ByClear -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -274,6 +253,9 @@ Accept wildcard characters: False ``` ### -ClientEKU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Set this parameter to True if the certificate is to be used for client authentication. This type of authentication is required if you want your users to be able to exchange instant messages with people who have accounts with AOL. The EKU portion of the parameter name is short for extended key usage; the extended key usage field lists the valid uses for the certificate. @@ -281,8 +263,7 @@ The EKU portion of the parameter name is short for extended key usage; the exten ```yaml Type: Boolean Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,6 +273,9 @@ Accept wildcard characters: False ``` ### -ComputerFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of the computer for which the certificate is being requested. When present, this parameter forces the `Request-CsCertificate` cmdlet to connect to the Central Management store in order to locate the specified computer. You should always use the computer name when requesting a certificate, even when requesting a pool certificate. @@ -301,8 +285,7 @@ The `Request-CsCertificate` cmdlet will automatically add the pool name to the S ```yaml Type: Fqdn Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -312,13 +295,15 @@ Accept wildcard characters: False ``` ### -Country + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Country/region where the certificate will be deployed. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -328,6 +313,9 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comma-separated list of fully-qualified domain names that should be added to the certificate's Subject Alternative Name field. For example: @@ -337,8 +325,25 @@ For example: ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -348,13 +353,15 @@ Accept wildcard characters: False ``` ### -FriendlyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User-assigned name that makes it easier to identify the certificate. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -364,6 +371,9 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a global catalog server in your domain. This parameter is not required if you are running the `Request-CsCertificate` cmdlet on a computer with an account in your domain. @@ -371,8 +381,7 @@ This parameter is not required if you are running the `Request-CsCertificate` cm ```yaml Type: Fqdn Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -382,6 +391,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services then this parameter must point to the root domain controller. If global settings are stored in the Configuration container then any domain controller can be used and this parameter can be omitted. @@ -390,8 +402,7 @@ If global settings are stored in the Configuration container then any domain con ```yaml Type: Fqdn Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -401,6 +412,9 @@ Accept wildcard characters: False ``` ### -KeyAlg + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the type of cryptographic algorithm to be used in generating the public and private keys for the new certificate. Valid key algorithms include: @@ -415,8 +429,7 @@ ECDH_P521 ```yaml Type: KeyAlgorithmIdentifier Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -426,6 +439,9 @@ Accept wildcard characters: False ``` ### -KeySize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the size (in bits) of the private key used by the certificate. Larger key sizes are more secure, but require more processing overhead in order to be decrypted. @@ -435,8 +451,7 @@ For example: `-KeySize 2048`. ```yaml Type: Int32 Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -446,14 +461,16 @@ Accept wildcard characters: False ``` ### -List + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, lists any pending certificate requests made by using the `Request-CsCertificate` cmdlet. ```yaml Type: SwitchParameter Parameter Sets: ByList -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -463,13 +480,15 @@ Accept wildcard characters: False ``` ### -New + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, indicates that you want to request a new certificate. ```yaml Type: SwitchParameter Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -479,14 +498,16 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the organization requesting the new certificate. For example: `-Organization "Litwareinc"`. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -496,13 +517,15 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Active Directory organizational unit for the computer that will be assigned the new certificate. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -512,6 +535,9 @@ Accept wildcard characters: False ``` ### -Output + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to the certificate file. If you want to create an offline certificate request use the Output parameter and specify a file path for the certificate request; for example: `-Output C:\Certificates\NewCertificate.pfx`. That will create a certificate request file that can then be emailed to a certification authority for processing. @@ -519,8 +545,7 @@ That will create a certificate request file that can then be emailed to a certif ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -530,14 +555,54 @@ Accept wildcard characters: False ``` ### -PrivateKeyExportable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Set this parameter to True if you want to make the certificate's private key exportable. When a private key is exportable, the certificate can be copied and used on multiple computers. ```yaml Type: Boolean Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\Certificates.html"` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Identification number associated with a certificate request. +The RequestID parameter provides a way for you to list, retrieve, or clear an individual certificate. + +```yaml +Type: Int32 +Parameter Sets: ByClear, ByList, ByRetrieve +Aliases: Required: False Position: Named @@ -547,14 +612,16 @@ Accept wildcard characters: False ``` ### -Retrieve + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, retrieves any pending certificate requests made by using the `Request-CsCertificate` cmdlet and attempts to complete the operation and import the requested certificate. ```yaml Type: SwitchParameter Parameter Sets: ByRetrieve -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -564,6 +631,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + U.S. state where the certificate will be deployed. For example: `-State WA`. @@ -571,8 +641,7 @@ For example: `-State WA`. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -582,6 +651,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the certificate template to be used when generating the new certificate; for example: `-Template "WebServer"`. The requested template must be installed on the CA. Note that the value entered must be the template name, not the template display name. @@ -589,8 +661,7 @@ Note that the value entered must be the template name, not the template display ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -599,49 +670,54 @@ 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. +### -Type -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of certificate being requested. +Certificate types include (but are not limited to): -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\Certificates.html"` +AccessEdgeExternal -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +AudioVideoAuthentication -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +DataEdgeExternal + +Default + +External + +Internal + +iPhoneAPNService + +iPadAPNService + +MPNService + +PICWebService (Skype for Business Online only) + +ProvisionService (Skype for Business Online only) + +WebServicesExternal + +WebServicesInternal + +WsFedTokenTransfer + +For example, this syntax requests a new Default certificate: `-Type Default`. + +You can specify multiple types in a single command by separating the certificate types with commas: + +`-Type Internal,External,Default` -### -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 +Type: CertType[] +Parameter Sets: ByNew +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -649,13 +725,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -664,33 +742,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestId -Identification number associated with a certificate request. -The RequestID parameter provides a way for you to list, retrieve, or clear an individual certificate. +### -WhatIf -```yaml -Type: Int32 -Parameter Sets: ByClear, ByList, ByRetrieve -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllSipDomain -When present, all your SIP domains are automatically added to the certificates Subject Alternative Name field. -If not present, only the primary SIP domain is added by default. -However, additional domains can be specified by using the DomainName parameter. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter -Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -704,14 +765,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Request-CsCertificate` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Request-CsCertificate` cmdlet helps manage instances of the Microsoft.Rtc.Management.Deployment.CertificateReference object. ## NOTES diff --git a/skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Reset-CsDeviceUpdateRule.md similarity index 88% rename from skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md rename to skype/skype-ps/SkypeForBusiness/Reset-CsDeviceUpdateRule.md index 70da9753fa..24f93a5b06 100644 --- a/skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsDeviceUpdateRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/reset-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Reset-CsDeviceUpdateRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/reset-csdeviceupdaterule +schema: 2.0.0 +title: Reset-CsDeviceUpdateRule --- # Reset-CsDeviceUpdateRule @@ -53,7 +54,7 @@ If a rule has already been approved, you will need to use the `Restore-CsDeviceU ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Reset-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 ``` @@ -61,7 +62,7 @@ Reset-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d The command shown in Example 1 resets the device update rule d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 found on the service WebServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* | Reset-CsDeviceUpdateRule ``` @@ -71,7 +72,7 @@ This is done by first calling the `Get-CsDeviceUpdateRule` cmdlet along with the (By definition, these are all the device update rules that have been assigned to the service WebServer:atl-cs-001.litwareinc.com.) The filtered collection is then piped to the `Reset-CsDeviceUpdateRule` cmdlet, which resets each rule in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} | Reset-CsDeviceUpdateRule ``` @@ -84,7 +85,29 @@ After that the filtered collection is piped to the `Reset-CsDeviceUpdateRule` cm ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the device update rule being reset. The Identity for a device update rule consists of a two parts: the service where the device update rule has been assigned (for example, service:WebServer:atl-cs-001.litwareinc.com) and a globally unique identifier (GUID). Consequently, a device update rule configured for the Redmond site will have an Identity similar to this: "service:WebServer:atl-cs-oo1.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9". @@ -92,8 +115,7 @@ Consequently, a device update rule configured for the Redmond site will have an ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -103,13 +125,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,30 +142,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm -```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 +> 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 @@ -150,15 +160,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -172,14 +183,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule + The `Reset-CsDeviceUpdateRule` cmdlet accepts pipelined instances of the device update rule object. ## OUTPUTS -### -None. +### None Instead, the `Reset-CsDeviceUpdateRule` cmdlet resets instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/Reset-CsNotificationQueues.md b/skype/skype-ps/SkypeForBusiness/Reset-CsNotificationQueues.md similarity index 85% rename from skype/skype-ps/skype/Reset-CsNotificationQueues.md rename to skype/skype-ps/SkypeForBusiness/Reset-CsNotificationQueues.md index dff712feba..44ad3d7eef 100644 --- a/skype/skype-ps/skype/Reset-CsNotificationQueues.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsNotificationQueues.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/reset-csnotificationqueues applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Reset-CsNotificationQueues -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/reset-csnotificationqueues +schema: 2.0.0 +title: Reset-CsNotificationQueues --- # Reset-CsNotificationQueues @@ -25,7 +26,7 @@ The `Reset-CsNotificationQueues` cmdlet resets all presence notification queues. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Reset-CsNotificationQueues -Fqdn FE01.contoso.com ``` @@ -34,14 +35,16 @@ This example resets the notification queues on server FE01.contoso.com. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -50,39 +53,46 @@ 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. +### -Fqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the fqdn of the server which you want to reset notification queues. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Fqdn -Specifies the fqdn of the server which you want to reset notification queues. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -90,7 +100,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Reset-CsPoolRegistrarState.md b/skype/skype-ps/SkypeForBusiness/Reset-CsPoolRegistrarState.md similarity index 87% rename from skype/skype-ps/skype/Reset-CsPoolRegistrarState.md rename to skype/skype-ps/SkypeForBusiness/Reset-CsPoolRegistrarState.md index db9733ae64..ab08c9bbe5 100644 --- a/skype/skype-ps/skype/Reset-CsPoolRegistrarState.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsPoolRegistrarState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/reset-cspoolregistrarstate applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Reset-CsPoolRegistrarState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/reset-cspoolregistrarstate +schema: 2.0.0 +title: Reset-CsPoolRegistrarState --- # Reset-CsPoolRegistrarState @@ -36,7 +37,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Reset ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType ServiceReset ``` @@ -45,7 +46,7 @@ The command shown in Example 1 performs a service reset for the Registrar pool ` Note that, after issuing this command, you will be prompted as to whether or not you want to proceed with the service reset. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType ServiceReset -Confirm:$False ``` @@ -57,7 +58,7 @@ As a result, you will not be prompted as to whether or not you want to proceed w Instead, the command will run as soon as you press ENTER. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType QuorumLossRecovery ``` @@ -68,7 +69,7 @@ Note that only those services that are in a quorum loss will have to reload user Other services will be unaffected by this command. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType FullReset ``` @@ -82,7 +83,7 @@ Because of that, it is recommended that you first try to restart the pool using If that fails, please consult Microsoft support personnel before using the FullReset option. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType FullReset -NoReStart ``` @@ -98,33 +99,35 @@ If that fails, please consult Microsoft support personnel before using the FullR ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the Registrar pool being reset. -For example: +### -Force -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MachineFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the computer to be removed from the pool. +This parameter is only used when performing a MachineStateRemoved reset. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,14 +136,16 @@ 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. +### -NoReStart + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, services (such as RtcSrv and FabricHostSvc) that are stopped when the cmdlet runs are not restarted. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,33 +154,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MachineFqdn -Fully qualified domain name of the computer to be removed from the pool. -This parameter is only used when performing a MachineStateRemoved reset. +### -PoolFqdn -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Fully qualified domain name of the Registrar pool being reset. +For example: -### -NoReStart -When specified, services (such as RtcSrv and FabricHostSvc) that are stopped when the cmdlet runs are not restarted. +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -183,14 +176,16 @@ Accept wildcard characters: False ``` ### -ResetLocalDatabases + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, stops and restarts the local Skype for Business Server databases in addition to the local Skype for Business Server services. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +195,9 @@ Accept wildcard characters: False ``` ### -ResetType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of reset to be performed. Allowed values are:
    @@ -227,8 +225,7 @@ This type of reset should be used only when the server in question (or its datab ```yaml Type: PoolResetType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +234,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ServicesStopDelayMins + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: Int32 + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -253,14 +270,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServicesStopDelayMins -PARAMVALUE: Int32 +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -274,14 +293,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Reset-CsPoolRegistrarState` cmdlet does not accept pipelined input. ## OUTPUTS -### -String values. +### System.Stringvalues. The `Reset-CsPoolRegistrarState` cmdlet does not return objects. ## NOTES diff --git a/skype/skype-ps/skype/Reset-CsRoutingGroup.md b/skype/skype-ps/SkypeForBusiness/Reset-CsRoutingGroup.md similarity index 83% rename from skype/skype-ps/skype/Reset-CsRoutingGroup.md rename to skype/skype-ps/SkypeForBusiness/Reset-CsRoutingGroup.md index af1ce598f9..3e2e20405d 100644 --- a/skype/skype-ps/skype/Reset-CsRoutingGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsRoutingGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/reset-csroutinggroup applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Reset-CsRoutingGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/reset-csroutinggroup +schema: 2.0.0 +title: Reset-CsRoutingGroup --- # Reset-CsRoutingGroup @@ -29,7 +30,7 @@ Missing routing groups can be identified by using the `Get-CsPoolFabricState` cm ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Reset-CsRoutingGroup -RoutingGroup "bef5fa3b-3c97-4af0-abe7-611deee7616c" -ResetType "Transient" ``` @@ -39,33 +40,16 @@ The command shown in Example 1 performs a transient on the routing group with th ## PARAMETERS -### -RoutingGroup -Globally unique identifier (GUID) of the routing group that needs to be reset. -For example: - -`-RoutingGroup "bef5fa3b-3c97-4af0-abe7-611deee7616c"` +### -Binding -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Binding PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) Aliases: b -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -74,30 +58,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` - -### -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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +77,15 @@ Accept wildcard characters: False ``` ### -HostNameStorageService + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) Aliases: h -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -123,13 +95,15 @@ Accept wildcard characters: False ``` ### -Lyss + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +113,9 @@ Accept wildcard characters: False ``` ### -ResetType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Type of reset to be performed. Allowed values are: @@ -151,8 +128,7 @@ Allowed values are: ```yaml Type: RgResetType Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,14 +137,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RoutingGroup + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the routing group that needs to be reset. +For example: + +`-RoutingGroup "bef5fa3b-3c97-4af0-abe7-611deee7616c"` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool containing the routing group that needs to be reset. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -178,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -198,14 +217,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Reset-CsRoutingGroup` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None The `Reset-CsRoutingGroup` cmdlet does return objects or data. ## NOTES diff --git a/skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Restore-CsDeviceUpdateRule.md similarity index 89% rename from skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md rename to skype/skype-ps/SkypeForBusiness/Restore-CsDeviceUpdateRule.md index 2bff596090..f2d40b85ad 100644 --- a/skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Restore-CsDeviceUpdateRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/restore-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Restore-CsDeviceUpdateRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/restore-csdeviceupdaterule +schema: 2.0.0 +title: Restore-CsDeviceUpdateRule --- # Restore-CsDeviceUpdateRule @@ -57,7 +58,7 @@ If there is no such previous version then the update being rolled back will simp ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Restore-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 ``` @@ -65,7 +66,7 @@ Restore-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com The command shown in Example 1 restores the device update rule d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 found on the service WebServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* | Restore-CsDeviceUpdateRule ``` @@ -75,7 +76,7 @@ To do this, the command first calls the `Get-CsDeviceUpdateRule` cmdlet along wi (By definition, these are all the device update rules that have been assigned to the service WebServer:atl-cs-001.litwareinc.com.) This filtered collection is then piped to the `Restore-CsDeviceUpdateRule` cmdlet, which restores each rule in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} | Restore-CsDeviceUpdateRule ``` @@ -88,7 +89,28 @@ The filtered collection is then piped to the `Restore-CsDeviceUpdateRule` cmdlet ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the device update rule being restored. The Identity for a device update rule consists of two parts: the service where the device update rule has been assigned (for example, service:WebServer:atl-cs-001.litwareinc.com) and a globally unique identifier (GUID). Consequently, a device update rule configured for the Redmond site will have an Identity similar to this: service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9. @@ -96,8 +118,7 @@ Consequently, a device update rule configured for the Redmond site will have an ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -107,13 +128,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +145,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -139,29 +164,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -175,14 +186,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule + The `Restore-CsDeviceUpdateRule` cmdlet accepts pipelined instances of the device update rule object. ## OUTPUTS -### -None. +### None Instead, the `Restore-CsDeviceUpdateRule` cmdlet restores instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/Revoke-CsClientCertificate.md b/skype/skype-ps/SkypeForBusiness/Revoke-CsClientCertificate.md similarity index 88% rename from skype/skype-ps/skype/Revoke-CsClientCertificate.md rename to skype/skype-ps/SkypeForBusiness/Revoke-CsClientCertificate.md index 5b2828745f..1550129456 100644 --- a/skype/skype-ps/skype/Revoke-CsClientCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Revoke-CsClientCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/revoke-csclientcertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Revoke-CsClientCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/revoke-csclientcertificate +schema: 2.0.0 +title: Revoke-CsClientCertificate --- # Revoke-CsClientCertificate @@ -43,7 +44,7 @@ In turn, that means that you will not be able to run the `Revoke-CsClientCertifi ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Revoke-CsClientCertificate -Identity "Ken Myer" ``` @@ -51,7 +52,7 @@ Revoke-CsClientCertificate -Identity "Ken Myer" The command shown in Example 1 revokes all the client certificates currently assigned to Ken Myer; this is done by calling the `Revoke-CsClientCertificate` cmdlet followed by the Identity of the user whose certificates are to be revoked. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsUser | Revoke-CsClientCertificate ``` @@ -63,7 +64,28 @@ This collection is then piped to the `Revoke-CsClientCertificate` cmdlet, which ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account for which certificates are to be revoked. User Identities can be specified by using one of four formats: 1) the user's Session Initiation Protocol (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. @@ -71,8 +93,7 @@ User Identities can also be referenced by using the user's Active Directory dist ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -81,14 +102,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -98,29 +121,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -134,15 +143,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The `Revoke-CsClientCertificate` cmdlet accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### -None. +### None Instead, the `Revoke-CsClientCertificate` cmdlet revokes instances of the Microsoft.Rtc.Management.UserPinService.CertInfoDetails object. ## NOTES diff --git a/skype/skype-ps/skype/Revoke-CsOUPermission.md b/skype/skype-ps/SkypeForBusiness/Revoke-CsOUPermission.md similarity index 83% rename from skype/skype-ps/skype/Revoke-CsOUPermission.md rename to skype/skype-ps/SkypeForBusiness/Revoke-CsOUPermission.md index e78386a8cd..74a6ec3257 100644 --- a/skype/skype-ps/skype/Revoke-CsOUPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Revoke-CsOUPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/revoke-csoupermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Revoke-CsOUPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/revoke-csoupermission +schema: 2.0.0 +title: Revoke-CsOUPermission --- # Revoke-CsOUPermission @@ -35,7 +36,7 @@ If you run the `Revoke-CsOUPermission` cmdlet against an OU you will then need t ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Revoke-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user" ``` @@ -43,7 +44,7 @@ Revoke-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user" The command shown in Example 1 revokes user management permissions (-ObjectType "user") for the Redmond OU in the domain litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Revoke-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user","contact","inetOrgPerson" ``` @@ -53,70 +54,56 @@ In Example 2, three different management permissions (user, contact and inetOrgP ## PARAMETERS -### -ObjectType -Type of object covered by these permissions. -Valid values are: - -User - -Computer - -Contact - -AppContact - -InetOrgPerson +### -Domain -To revoke permissions to multiple object types in the same command, separate the object types by using commas: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-ObjectType "user","computer","contact"` +Name of the domain where the OU is located. +If this parameter is not included the `Revoke-CsOUPermission` cmdlet will look for the OU in the current domain. ```yaml -Type: ObjectType +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OU -Distinguished name of the OU where permissions are to be removed. -For example: +### -DomainController -`-OU "ou=Redmond,dc=litwareinc,dc=com` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can only remove permissions from a single OU per command. +Enables administrators to specify the fully qualified domain name (FQDN) of the domain controller to be used when running the `Revoke-CsOUPermission` cmdlet. +If not specified, the cmdlet will use the first available domain controller. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Domain -Name of the domain where the OU is located. -If this parameter is not included the `Revoke-CsOUPermission` cmdlet will look for the OU in the current domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,16 +112,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables administrators to specify the fully qualified domain name (FQDN) of the domain controller to be used when running the `Revoke-CsOUPermission` cmdlet. -If not specified, the cmdlet will use the first available domain controller. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of a global catalog server in your domain. +This parameter is not required if you are running the `Revoke-CsOUPermission` cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,34 +132,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -Fully qualified domain name of a global catalog server in your domain. -This parameter is not required if you are running the `Revoke-CsOUPermission` cmdlet on a computer with an account in your domain. +### -ObjectType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of object covered by these permissions. +Valid values are: + +User + +Computer + +Contact + +AppContact + +InetOrgPerson + +To revoke permissions to multiple object types in the same command, separate the object types by using commas: + +`-ObjectType "user","computer","contact"` ```yaml -Type: Fqdn +Type: ObjectType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True 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 occur when running the command. +### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Distinguished name of the OU where permissions are to be removed. +For example: + +`-OU "ou=Redmond,dc=litwareinc,dc=com` + +You can only remove permissions from a single OU per command. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -187,8 +203,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,14 +212,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -213,14 +230,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -234,13 +253,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Revoke-CsOUPermission` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Revoke-CsOUPermission` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Revoke-CsSetupPermission.md b/skype/skype-ps/SkypeForBusiness/Revoke-CsSetupPermission.md similarity index 83% rename from skype/skype-ps/skype/Revoke-CsSetupPermission.md rename to skype/skype-ps/SkypeForBusiness/Revoke-CsSetupPermission.md index 2749dcce16..bb9180ddd4 100644 --- a/skype/skype-ps/skype/Revoke-CsSetupPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Revoke-CsSetupPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/revoke-cssetuppermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Revoke-CsSetupPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/revoke-cssetuppermission +schema: 2.0.0 +title: Revoke-CsSetupPermission --- # Revoke-CsSetupPermission @@ -37,7 +38,7 @@ In that case, you will need to be an enterprise administrator or a domain admini ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Revoke-CsSetupPermission -ComputerOU "ou=CsServers,dc=litwareinc,dc=com" ``` @@ -48,6 +49,9 @@ The command shown in Example 1 revokes the setup rights applied to the CsServers ## PARAMETERS ### -ComputerOU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name (DN) of the OU that contains the accounts for the computers where Skype for Business Server will be (or has been) installed. For example: @@ -62,8 +66,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the domain where the OU is located. If this parameter is not included, then the `Revoke-CsSetupPermission` cmdlet will look for the OU in the current domain. @@ -80,8 +86,7 @@ If this parameter is not included, then the `Revoke-CsSetupPermission` cmdlet wi ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified name of the domain controller to be contacted when assigning the policy. For example: @@ -102,8 +110,7 @@ If not specified, the `Revoke-CsSetupPermission` cmdlet will contact the nearest ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,20 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -Fully qualified name of the global catalog server to be contacted when assigning the policy. -For example: - -`-GlobalCatalog atl-dc-001.litwareinc.com` +### -Force -If not specified, the `Revoke-CsSetupPermission` cmdlet will contact the nearest available global catalog server when assigning the policy. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,14 +137,22 @@ 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. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified name of the global catalog server to be contacted when assigning the policy. +For example: + +`-GlobalCatalog atl-dc-001.litwareinc.com` + +If not specified, the `Revoke-CsSetupPermission` cmdlet will contact the nearest available global catalog server when assigning the policy. + ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -160,8 +174,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +183,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -186,14 +201,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -207,14 +224,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Revoke-CsSetupPermission` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Search-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Search-CsClsLogging.md similarity index 82% rename from skype/skype-ps/skype/Search-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Search-CsClsLogging.md index 012dcf1d84..4fa5447b51 100644 --- a/skype/skype-ps/skype/Search-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Search-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/search-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Search-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/search-csclslogging +schema: 2.0.0 +title: Search-CsClsLogging --- # Search-CsClsLogging @@ -42,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Searc ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Search-CsClsLogging -Computers "atl-cs-001.litwareinc.com" -IP "192.168.0.242" ``` @@ -50,7 +51,7 @@ Search-CsClsLogging -Computers "atl-cs-001.litwareinc.com" -IP "192.168.0.242" The command shown in Example 1 searches for the IP address 192.168.0.242 in the log files found on the computer atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Search-CsClsLogging -Computers "atl-cs-001.litwareinc.com" -IP "192.168.0.242" -Uri "sip:kenmyer@litwareinc.com" -MatchAll ``` @@ -59,7 +60,7 @@ In Example 2, a search is made for entries that match both the IP address 192.16 The MatchAll parameter specifies that all the criteria must be met for an entry to be recorded as a match. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Search-CsClsLogging -Computers "atl-cs-001.litwareinc.com" -IP "192.168.0.242" -Uri "sip:kenmyer@litwareinc.com" -MatchAny ``` @@ -71,13 +72,15 @@ The MatchAny parameter specifies that just one of the criteria must be met for a ## PARAMETERS ### -AsXml + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, return code information from each computer searched is returned in XML format instead of as a string value. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -CallId + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Call identifier to be searched for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -Components + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comma-separated list of components to be searched. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comma-separated list of the computers to be searched. For example: @@ -127,8 +137,7 @@ For example: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -ConferenceId + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Conference ID to be searched for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,14 +165,16 @@ Accept wildcard characters: False ``` ### -CorrelationIds + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comma-separated list of correlation IDs to search for. A correlation is a 32 bit integer associated with each request. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Ending date and time for the log entries to be searched. Specified in local time zone. Defaults to 5 minutes after current time if no StartTime specified, otherwise defaults to 30 minutes after StartTime. @@ -182,8 +198,7 @@ For example, on computer running the US English version of Skype for Business Se ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,14 +208,16 @@ Accept wildcard characters: False ``` ### -IP + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + IP address being searched for. This must be an actual IP address; you cannot use wildcards when specifying the address. ```yaml Type: IPAddress Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -210,6 +227,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the minimum type of log entry to be returned. Allowed values are: @@ -234,8 +254,7 @@ For example, if you set the LogLevel to Warning then the cmdlet will return entr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,14 +264,16 @@ Accept wildcard characters: False ``` ### -MatchAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, all the included criteria must be matched. This is similar to an AND query in SQL Server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -262,6 +283,9 @@ Accept wildcard characters: False ``` ### -MatchAny + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, only one of the included criteria must be matched. This is similar to an OR query in SQL Server. This is the default. @@ -269,8 +293,7 @@ This is the default. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -280,14 +303,16 @@ Accept wildcard characters: False ``` ### -OutputFilePath + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, specifies the full path of where to write a text file containing the search results. Otherwise they are written to the console. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,14 +322,16 @@ Accept wildcard characters: False ``` ### -Phone + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number to be searched for. This number should be entered using the E.164 format and should not include wildcard characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -314,6 +341,9 @@ Accept wildcard characters: False ``` ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comma-separated list of the pools to be searched. For example: @@ -322,8 +352,7 @@ For example: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,13 +362,15 @@ Accept wildcard characters: False ``` ### -SipContents + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Arbitrary text to search for within the body of a SIP message. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -349,14 +380,16 @@ Accept wildcard characters: False ``` ### -SkipNetworkLogs + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, instructs the `Search-CsClsLogging` cmdlet to avoid searching network logs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -366,6 +399,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Beginning date and time for the log entries to be searched. Specified in local time zone. Defaults to 30 minutes before EndTime. @@ -377,8 +413,7 @@ For example, on computer running the US English version of Skype for Business Se ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,13 +423,15 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Uri to be searched for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -408,14 +445,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Search-CsClsLogging` cmdlet does not accept pipelined input. ## OUTPUTS -### -String values or XML. +### System.Stringvalues or XML. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAVEdgeConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAVEdgeConfiguration.md index 32085367bd..3a309d1fc1 100644 --- a/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAVEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAVEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csavedgeconfiguration +schema: 2.0.0 +title: Set-CsAVEdgeConfiguration --- # Set-CsAVEdgeConfiguration @@ -44,7 +45,7 @@ However, unless instructed by Microsoft support personnel, it is recommended tha ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAVEdgeConfiguration -Identity global -MaxTokenLifetime "04:00:00" ``` @@ -55,7 +56,28 @@ In this example, the maximum token lifetime is set to 4 hours (04 hours : 00 min ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of A/V Edge configuration settings to be modified. To modify the global collection, use the following syntax: `-Identity global`. To modify a site collection use syntax similar to this: `-Identity site:Redmond`. @@ -64,8 +86,7 @@ Settings configured at the service scope should be referred to using syntax simi ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -75,13 +96,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,24 +113,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -MaxTokenLifetime -The maximum amount of time that an authentication token can be used before it expires and must be renewed. -Token lifetimes are expressed using the following format: Days.Hours:Minutes:Seconds. -For example, 13 days must be expressed like this, with a period (.) following the number of days, and colons (:) used to separate the hours, minutes, and seconds: - -13.00:00:00 - -The default value of 8 hours must be expressed like this: +### -MaxBandwidthPerPortKb -08:00:00 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The minimum allowed token lifetime is 1 minute (00:01:00); the maximum allowed lifetime is 180 days (180.00:00:00). +Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to a single port. +The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 3000. ```yaml -Type: TimeSpan +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,14 +132,17 @@ 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. +### -MaxBandwidthPerUserKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to any one user. +The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 10000. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +151,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxTokenLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum amount of time that an authentication token can be used before it expires and must be renewed. +Token lifetimes are expressed using the following format: Days.Hours:Minutes:Seconds. +For example, 13 days must be expressed like this, with a period (.) following the number of days, and colons (:) used to separate the hours, minutes, and seconds: + +13.00:00:00 + +The default value of 8 hours must be expressed like this: + +08:00:00 + +The minimum allowed token lifetime is 1 minute (00:01:00); the maximum allowed lifetime is 180 days (180.00:00:00). ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,13 +180,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -164,32 +197,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxBandwidthPerPortKb -Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to a single port. -The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 3000. +### -WhatIf -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxBandwidthPerUserKb -Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to any one user. -The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 10000. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -203,13 +220,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings + The `Set-CsAVEdgeConfiguration` cmdlet accepts pipelined input of media relay settings objects. ## OUTPUTS -### +### None The `Set-CsAVEdgeConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. diff --git a/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAccessEdgeConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAccessEdgeConfiguration.md index a8885119cb..b2e7c57131 100644 --- a/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAccessEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csaccessedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAccessEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csaccessedgeconfiguration +schema: 2.0.0 +title: Set-CsAccessEdgeConfiguration --- # Set-CsAccessEdgeConfiguration @@ -82,7 +83,7 @@ Instead, you will see and be able to change the property values VerificationLeve ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAccessEdgeConfiguration -AllowAnonymousUsers $True -VerificationLevel "UseSourceVerification" ``` @@ -90,7 +91,7 @@ Set-CsAccessEdgeConfiguration -AllowAnonymousUsers $True -VerificationLevel "Use In Example 1, two properties of the Access Edge configuration settings are modified: the AllowAnonymousUsers property is set to True and the VerificationLevel property is set to UseSourceVerification. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsAccessEdgeConfiguration -UseDefaultRouting -DefaultRouteFqdn "atl-edge-001.litwareinc.com" ``` @@ -99,7 +100,7 @@ The command shown in Example 2 changes the routing method for the Edge server to In order to do this the command must include both the UseDefaultRouting parameter and the DefaultRouteFqdn parameter, along with a parameter value that specifies the fully qualified domain name of the Edge server. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsAccessEdgeConfiguration -UseDnsSrvRouting -EnablePartnerDiscovery $True ``` @@ -110,50 +111,58 @@ This requires the use of two parameters: UseDnsSrvRouting (with no parameter val ## PARAMETERS -### -Identity -Unique identifier of the Access Edge configuration settings to be returned. -Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the `Set-CsAccessEdgeConfiguration` cmdlet. -However, if you prefer, you can use the following syntax to modify the global settings: `-Identity global`. +### -AllowAnonymousUsers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether or not anonymous users (that is, unauthenticated users) are allowed to cross the firewall and join meetings and conferences. +The default value is False. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False -Position: 2 +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. +### -AllowFederatedUsers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether internal users are allowed to communicate with users from federated domains. +This property also determines whether internal users can communicate with users in a split domain scenario. +(In a split domain, some of your users have accounts hosted on-premises, while others have accounts hosted off-premises.) The default value is False. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsers -Indicates whether or not anonymous users (that is, unauthenticated users) are allowed to cross the firewall and join meetings and conferences. -The default value is False. +### -AllowOutsideUsers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether users can access Skype for Business Server across the Internet. +This includes both anonymous users and remote users who are trying to log on to the system. +The default value is True. + ```yaml Type: Boolean Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,16 +171,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowFederatedUsers -Indicates whether internal users are allowed to communicate with users from federated domains. -This property also determines whether internal users can communicate with users in a split domain scenario. -(In a split domain, some of your users have accounts hosted on-premises, while others have accounts hosted off-premises.) The default value is False. +### -BeClearingHouse + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether your Edge servers are directly connected to other organizations. +The default value is False. +This parameter should not be changed unless you are instructed to do so by Microsoft support personnel. ```yaml Type: Boolean -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: DnsSrvRouting +Aliases: Required: False Position: Named @@ -180,17 +191,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOutsideUsers -Indicates whether users can access Skype for Business Server across the Internet. -This includes both anonymous users and remote users who are trying to log on to the system. -The default value is True. +### -CertificatesDeletedPercentage +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The default value is 20. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +210,9 @@ Accept wildcard characters: False ``` ### -DefaultRouteFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the server used for federation requests. This parameter is required if you use default routing. @@ -209,8 +222,7 @@ Note that you must delete all your hosting providers and all your public provide ```yaml Type: String Parameter Sets: DefaultRoute -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,16 +231,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableArchivingDisclaimer -If set to True, Edge Servers send an archiving notification header to federated and clearinghouse partners. -This notification (which informs people that instant messaging (IM) conversations might be archived) can be displayed in the conversation window of a federated or clearinghouse user. -The default value is False. +### -DiscoveredPartnerReportPeriodMinutes + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The default value is 60. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,18 +249,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePartnerDiscovery -If True, Skype for Business Server will use DNS records to try and discover partner domains not listed in the AllowedDomains list. -If False, Skype for Business Server will only federate with domains found on the AllowedDomains list. -This parameter is required if you use DNS service routing. -The default value is False. +### -DiscoveredPartnerStandardRate + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The default value is 20. ```yaml -Type: Boolean -Parameter Sets: DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UInt32 +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False Position: Named @@ -257,14 +267,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsPublicProvider -Must be set to True if the default route requires a public instant messaging license. +### -DiscoveredPartnerVerificationLevel + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Sets the verification level for messages sent to and from the discovered partner. +Allowed values are: + +* AlwaysVerifiable +* AlwaysUnverifiable +* UseSourceVerification ```yaml -Type: Boolean -Parameter Sets: DefaultRoute -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: VerificationLevelType +Parameter Sets: DnsSrvRouting +Aliases: Required: False Position: Named @@ -273,15 +290,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepCrlsUpToDateForPeers -Determines whether or not Edge servers periodically check the certificate revocation lists (CRLs) for federated domain certificates. -The default value is True. +### -DnsSrvCacheRecordCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of DNS SRV records that can be maintained in the cache. +SRV records are used to specify service locations and port numbers. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -290,16 +309,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MarkSourceVerifiableOnOutgoingMessages -If True, outgoing messages are marked as verifiable; this enables federated domains to determine the verification level for each message. -If False, outgoing messages are all marked as unverifiable. -The default value is True. +### -EnableArchivingDisclaimer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, Edge Servers send an archiving notification header to federated and clearinghouse partners. +This notification (which informs people that instant messaging (IM) conversations might be archived) can be displayed in the conversation window of a federated or clearinghouse user. +The default value is False. ```yaml Type: Boolean Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,17 +329,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutgoingTlsCountForFederatedPartners -Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each federated partner. -The minimum number of TLS connections is 1, and the maximum number is 4. -By default, OutgoingTlsCountForFederatedPartners is set to 4. -This parameter should not be changed unless you are instructed to do so by Microsoft support personnel. +### -EnableDiscoveredPartnerContactsLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), enables user enumeration protection for Discovered Partner federated peers. + ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -327,15 +348,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDnsSrvRouting -Indicates that Edge servers should rely on DNS SRV records when sending and receiving federation requests. -This is the default routing method. +### -EnablePartnerDiscovery + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, Skype for Business Server will use DNS records to try and discover partner domains not listed in the AllowedDomains list. +If False, Skype for Business Server will only federate with domains found on the AllowedDomains list. +This parameter is required if you use DNS service routing. +The default value is False. + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -344,23 +370,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VerificationLevel -If you are using default routing, the VerificationLevel property is used to monitor and assess the verification level of incoming messages. -Valid values are: - -AlwaysVerifiable: All requests received on the default route are marked as verified. -If a verification header is not present it will automatically be added to the message. +### -EnableUserReplicator -AlwaysUnverifiable: Messages are passed only if the addressee (the user the message is intended for) has configured an Allow ACE (access control entry) for the person who sent the message. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -UseSourceVerification: Message verification is based on the verification level included with the message. -If no verification header is present then the message will be marked as unverified. +The default value is False ($False). ```yaml -Type: VerificationLevelType -Parameter Sets: DefaultRoute -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False Position: Named @@ -370,13 +389,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -385,48 +406,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the Access Edge configuration settings to be returned. +Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the `Set-CsAccessEdgeConfiguration` cmdlet. +However, if you prefer, you can use the following syntax to modify the global settings: `-Identity global`. + ```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 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -BeClearingHouse -Indicates whether your Edge servers are directly connected to other organizations. -The default value is False. -This parameter should not be changed unless you are instructed to do so by Microsoft support personnel. +### -IsPublicProvider + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Must be set to True if the default route requires a public instant messaging license. ```yaml Type: Boolean -Parameter Sets: DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: DefaultRoute +Aliases: Required: False Position: Named @@ -435,16 +463,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDefaultRouting -Indicates that administrators must specify the fully qualified domain name of the server used to send and receive federation requests. -If you include the UseDefaultRouting parameter then you must also include the DefaultRouteFqdn parameter. +### -KeepCrlsUpToDateForPeers +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether or not Edge servers periodically check the certificate revocation lists (CRLs) for federated domain certificates. +The default value is True. ```yaml -Type: SwitchParameter -Parameter Sets: DefaultRoute -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False Position: Named @@ -453,14 +482,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CertificatesDeletedPercentage -The default value is 20. +### -MarkSourceVerifiableOnOutgoingMessages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, outgoing messages are marked as verifiable; this enables federated domains to determine the verification level for each message. +If False, outgoing messages are all marked as unverifiable. +The default value is True. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -469,14 +502,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DiscoveredPartnerReportPeriodMinutes -The default value is 60. +### -MaxAcceptedCertificatesStored + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of allowed certificates cached by the Edge Server. +The default value is 1000. ```yaml Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -485,14 +521,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DiscoveredPartnerStandardRate -The default value is 20. +### -MaxContactsPerDiscoveredPartner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of contacts allowed per discovered partner. +The default value is 1000. ```yaml Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -501,19 +540,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DiscoveredPartnerVerificationLevel -Sets the verification level for messages sent to and from the discovered partner. -Allowed values are: +### -MaxRejectedCertificatesStored -* AlwaysVerifiable -* AlwaysUnverifiable -* UseSourceVerification +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of rejected certificates cached by the Edge Server. +The default value is 500. ```yaml -Type: VerificationLevelType -Parameter Sets: DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UInt32 +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False Position: Named @@ -522,15 +559,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDiscoveredPartnerContactsLimit -When set to True (the default value), enables user enumeration protection for Discovered Partner federated peers. +### -OutgoingTlsCountForFederatedPartners + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each federated partner. +The minimum number of TLS connections is 1, and the maximum number is 4. +By default, OutgoingTlsCountForFederatedPartners is set to 4. +This parameter should not be changed unless you are instructed to do so by Microsoft support personnel. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -539,14 +580,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableUserReplicator -The default value is False ($False). +### -SkypeSearchUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the Skype Graph Search service. +This service enables Skype for Business to search for Skype contacts. ```yaml -Type: Boolean +Type: String Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -555,15 +599,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxAcceptedCertificatesStored -Maximum number of allowed certificates cached by the Edge Server. -The default value is 1000. +### -UseDefaultRouting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates that administrators must specify the fully qualified domain name of the server used to send and receive federation requests. +If you include the UseDefaultRouting parameter then you must also include the DefaultRouteFqdn parameter. + ```yaml -Type: UInt32 -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: DefaultRoute +Aliases: Required: False Position: Named @@ -572,15 +619,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxContactsPerDiscoveredPartner -Maximum number of contacts allowed per discovered partner. -The default value is 1000. +### -UseDnsSrvRouting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates that Edge servers should rely on DNS SRV records when sending and receiving federation requests. +This is the default routing method. ```yaml -Type: UInt32 -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: DnsSrvRouting +Aliases: Required: False Position: Named @@ -589,15 +638,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxRejectedCertificatesStored -Maximum number of rejected certificates cached by the Edge Server. -The default value is 500. +### -VerificationLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If you are using default routing, the VerificationLevel property is used to monitor and assess the verification level of incoming messages. +Valid values are: + +AlwaysVerifiable: All requests received on the default route are marked as verified. +If a verification header is not present it will automatically be added to the message. + +AlwaysUnverifiable: Messages are passed only if the addressee (the user the message is intended for) has configured an Allow ACE (access control entry) for the person who sent the message. + +UseSourceVerification: Message verification is based on the verification level included with the message. +If no verification header is present then the message will be marked as unverified. ```yaml -Type: UInt32 -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: VerificationLevelType +Parameter Sets: DefaultRoute +Aliases: Required: False Position: Named @@ -606,15 +665,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DnsSrvCacheRecordCount -Maximum number of DNS SRV records that can be maintained in the cache. -SRV records are used to specify service locations and port numbers. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt32 -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -623,15 +683,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkypeSearchUrl -URL for the Skype Graph Search service. -This service enables Skype for Business to search for Skype contacts. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -645,13 +706,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsAccessEdgeConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsAccessEdgeConfiguration` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsAddressBookConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAddressBookConfiguration.md index deb444e50b..bfd68cef79 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAddressBookConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csaddressbookconfiguration +schema: 2.0.0 +title: Set-CsAddressBookConfiguration --- # Set-CsAddressBookConfiguration @@ -55,7 +56,7 @@ The `Set-CsAddressBookConfiguration` cmdlet enables you to modify any of the Add ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsAddressBookConfiguration -identity site:Redmond -RunTimeOfDay 23:00 ``` @@ -64,7 +65,7 @@ This example sets the RunTimeOfDay property (the property that determines the ti The Identity parameter is used to limit the change to the Address Book configuration settings with the identity site:Redmond. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookConfiguration -Filter site:* | Set-CsAddressBookConfiguration -RunTimeOfDay 23:00 ``` @@ -74,7 +75,7 @@ To do this, the command first uses the `Get-CsAddressBookConfiguration` cmdlet a This information is then piped to the `Set-CsAddressBookConfiguration` cmdlet, which modifies the value of the RunTimeOfDay property for each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookConfiguration | Where-Object {$_.KeepDuration -lt 30} | Set-CsAddressBookConfiguration -KeepDuration 30 ``` @@ -87,55 +88,58 @@ This filtered collection is then piped to the `Set-CsAddressBookConfiguration` c ## PARAMETERS -### -Identity -Unique identifier assigned to the collection of Address Book settings. -To refer to the global settings, use this syntax: `-Identity global`. -To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. -You cannot use wildcard characters when specifying an Identity. +### -EnableFileGeneration -If this parameter is omitted, then the `Set-CsAddressBookConfiguration` cmdlet will modify the global settings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the Address Book server generates Address Book index files that can be downloaded by clients. +When set to False, these index files are not generated. +That means that client applications will have to use the Address Book Web Query service when searching for contacts. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -EnablePhotoSearch + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, user photos will be displayed in search results. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFileGeneration -When set to True (the default value) the Address Book server generates Address Book index files that can be downloaded by clients. -When set to False, these index files are not generated. -That means that client applications will have to use the Address Book Web Query service when searching for contacts. +### -EnableSearchByDialPad + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users will be able to search for contacts by using their mobile device keypad. +This can be a convenience for mobile users, but has the potential to greatly increase the size of your Address Book database. +The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,18 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreGenericRules -Indicates whether or not the Address Book server ignores the generic normalization rules used when parsing phone numbers. -Generic rules are the rules that are built into Skype for Business Server. -These rules cannot be changed; however, by setting the value of this property to True you can instruct your Address Book servers to ignore these rules and instead use custom rules that you create yourself. -The default value is False. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,40 +166,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepDuration -Specifies the amount of time (in days) that Address Book servers will keep change files. -Change files older than the value of the KeepDuration property will be deleted. -The KeepDuration can be set to any integer value between 1 and 90, inclusive. -The default value is 30 days. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier assigned to the collection of Address Book settings. +To refer to the global settings, use this syntax: `-Identity global`. +To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. +You cannot use wildcard characters when specifying an Identity. + +If this parameter is omitted, then the `Set-CsAddressBookConfiguration` cmdlet will modify the global settings. ```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxDeltaFileSizePercentage -When changes are made to Active Directory (such as a new user being enabled for Skype for Business Server), the Address Book server typically records these changes in a "delta file," a file consisting only of the updated information; Skype for Business Server can then download the delta files rather than a complete Address Book file. -The MaxDeltaFileSizePercentage property determines how large the delta files can get before they are incorporated into the complete Address Book file. -By default, delta files can be as large as 20 percent of the complete Address Book file before a new Address Book file is generated. -At that point, clients will download the complete file rather than a delta file. +### -IgnoreGenericRules -MaxDeltaFileSizePercentage must be entered as a percentage value between 1 and 100, inclusive. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the Address Book server ignores the generic normalization rules used when parsing phone numbers. +Generic rules are the rules that are built into Skype for Business Server. +These rules cannot be changed; however, by setting the value of this property to True you can instruct your Address Book servers to ignore these rules and instead use custom rules that you create yourself. +The default value is False. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,36 +212,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RunTimeOfDay -Indicates the time of day when the servers generate new Address Book files. -The RunTimeOfDay property is based on a 24-hour clock (hours:minutes:seconds), with 00:00:00 representing midnight and 23:59:00 representing 11:59 P.M.. +### -Instance -The default value is 01:30:00 (1:30 A.M.). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SynchronizePollingInterval -Indicates how often Address Book servers synchronize their information with the information stored in the User database. -The SynchronizePollingInterval can be set to any value between 5 seconds (00:00:05) and 3 hours (03:00:00). -The default value is 5 minutes (00:05:00). +### -KeepDuration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in days) that Address Book servers will keep change files. +Change files older than the value of the KeepDuration property will be deleted. +The KeepDuration can be set to any integer value between 1 and 90, inclusive. +The default value is 30 days. + ```yaml -Type: TimeSpan +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,17 +252,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNormalizationRules -Indicates whether Address Book servers should use phone normalization rules when retrieving phone numbers. -If set to False, phone numbers will be retrieved as-is and it will be up to the client application to apply normalization rules when displaying these numbers. +### -MaxDeltaFileSizePercentage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When changes are made to Active Directory (such as a new user being enabled for Skype for Business Server), the Address Book server typically records these changes in a "delta file," a file consisting only of the updated information; Skype for Business Server can then download the delta files rather than a complete Address Book file. +The MaxDeltaFileSizePercentage property determines how large the delta files can get before they are incorporated into the complete Address Book file. +By default, delta files can be as large as 20 percent of the complete Address Book file before a new Address Book file is generated. +At that point, clients will download the complete file rather than a delta file. + +MaxDeltaFileSizePercentage must be entered as a percentage value between 1 and 100, inclusive. -The default value is True. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -263,14 +276,17 @@ 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. +### -MaxFileShareThreadCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the maximum number of system resources that can be used by the Address Book server if there are problems accessing the service file share. +The default value is 300. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,14 +295,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PhotoCacheRefreshInterval + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: TimeSpan ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -295,14 +313,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -RunTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the time of day when the servers generate new Address Book files. +The RunTimeOfDay property is based on a 24-hour clock (hours:minutes:seconds), with 00:00:00 representing midnight and 23:59:00 representing 11:59 P.M.. + +The default value is 01:30:00 (1:30 A.M.). + ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -311,14 +335,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePhotoSearch -When set to True, user photos will be displayed in search results. +### -SynchronizePollingInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates how often Address Book servers synchronize their information with the information stored in the User database. +The SynchronizePollingInterval can be set to any value between 5 seconds (00:00:05) and 3 hours (03:00:00). +The default value is 5 minutes (00:05:00). ```yaml -Type: Boolean +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -327,17 +355,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSearchByDialPad -When set to True, users will be able to search for contacts by using their mobile device keypad. -This can be a convenience for mobile users, but has the potential to greatly increase the size of your Address Book database. +### -UseNormalizationRules -The default value is True ($True). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether Address Book servers should use phone normalization rules when retrieving phone numbers. +If set to False, phone numbers will be retrieved as-is and it will be up to the client application to apply normalization rules when displaying these numbers. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -346,15 +376,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxFileShareThreadCount -Specifies the maximum number of system resources that can be used by the Address Book server if there are problems accessing the service file share. -The default value is 300. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -363,14 +394,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PhotoCacheRefreshInterval -PARAMVALUE: TimeSpan +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -384,13 +417,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings + The `Set-CsAddressBookConfiguration` cmdlet accepts pipelined input of Address Book configuration objects. ## OUTPUTS -### +### None The `Set-CsAddressBookConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. diff --git a/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationConfiguration.md index eb9e97ae29..df1a6881fa 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAddressBookNormalizationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csaddressbooknormalizationconfiguration +schema: 2.0.0 +title: Set-CsAddressBookNormalizationConfiguration --- # Set-CsAddressBookNormalizationConfiguration @@ -43,7 +44,7 @@ That means that, in some cases, you might need to create identical rules: one fo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsAddressBookNormalizationRule -Identity "global/LongDistanceRule" ``` @@ -62,7 +63,7 @@ This is done by including the AddressBookNormalizationRules parameter and the sy Alternatively, you could remove the rule by using the `Remove-CsAddressBookNormalizationRule` cmdlet -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = Get-CsAddressBookNormalizationRule -Identity "global/LongDistanceRule" @@ -78,7 +79,7 @@ This is done by first connecting to the configuration settings for the Redmond s When this command finishes running, both the global collection and the Redmond site collection will have a normalization rule named LongDistanceRule. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsAddressBookNormalizationConfiguration -Identity "site:Redmond" -AddressBookNormalizationRules $Null ``` @@ -91,6 +92,9 @@ However, no normalization rules will be assigned to that collection. ## PARAMETERS ### -AddressBookNormalizationRules + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A set of normalization rules that have been applied to this collection of Address Book normalization configuration settings. While this set of rules can be modified directly using this cmdlet, it is recommended that you create normalization rules with the `New-CsAddressBookNormalizationRule` cmdlet; this cmdlet creates the rule and assigns it to the specified collection. @@ -100,8 +104,7 @@ In general, this is easier and less error-prone than trying to modify a rules co ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,30 +113,16 @@ 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 Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses any confirmation prompts before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +132,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Address Book normalization configuration settings to be modified. To refer to the global settings, use this syntax: `-Identity "global"` @@ -153,8 +145,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -164,13 +155,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +172,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -200,13 +213,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings The `Set-CsAddressBookNormalizationConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsAddressBookNormalizationConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationRule.md similarity index 87% rename from skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationRule.md index c68c1560bb..d2656b8be7 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAddressBookNormalizationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csaddressbooknormalizationrule +schema: 2.0.0 +title: Set-CsAddressBookNormalizationRule --- # Set-CsAddressBookNormalizationRule @@ -39,7 +40,7 @@ That means, in some cases, you might need to create identical rules: one for ass ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsAddressBookNormalizationRule -Identity "Global/RedmondAddresses" -Priority 1 ``` @@ -47,7 +48,7 @@ Set-CsAddressBookNormalizationRule -Identity "Global/RedmondAddresses" -Priority The command shown in Example 1 changes the priority of the RedmondAddresses normalization rule found in the global collection of Address Book normalization rules. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookNormalizationRule | Where-Object {$_.Translation -eq '+1206556$1'} | Set-CsAddressBookNormalizationRule -Translation '+1425556$1' ``` @@ -60,31 +61,17 @@ Those rules are then piped to the `Set-CsAddressBookTranslationRule`, which chan ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Description Enables administrators to provide explanatory text that accompanies a normalization rule. For example, the Description might explain how the rule converts phone numbers. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,13 +81,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,14 +99,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the rule. The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -127,13 +118,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +136,9 @@ Accept wildcard characters: False ``` ### -Pattern + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that the phone number must match in order for this rule to be applied. The default value is ^(\d{11})$. @@ -151,8 +147,7 @@ This represents any set of numbers up to 11 digits. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +157,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The order in which rules are applied; this is required because a given phone number might match more than one rule. The Priority parameter sets the order in which the rules are tested against a number. If a phone number matches multiple rules, the rule with the highest priority will be selected to do the conversion. @@ -171,8 +169,7 @@ Note that, when you set a priority, any existing rules will renumber themselves ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +179,9 @@ Accept wildcard characters: False ``` ### -Translation + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The regular expression pattern that will be applied to the number to convert it to E.164 format. The default value is +$. @@ -190,8 +190,25 @@ This prefixes the number with a plus sign (+). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -201,13 +218,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -221,13 +240,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated The `Set-CsAddressBookNormalizationRule` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsAddressBookNormalizationRule` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Set-CsAdminRole.md similarity index 91% rename from skype/skype-ps/skype/Set-CsAdminRole.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAdminRole.md index 844768e6e6..6ce0ef6ffe 100644 --- a/skype/skype-ps/skype/Set-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAdminRole.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAdminRole -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csadminrole +schema: 2.0.0 +title: Set-CsAdminRole --- # Set-CsAdminRole @@ -92,7 +93,7 @@ After the custom role has been created, you can then use the `Set-CsAdminRole` c ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAdminRole -Identity "RedmondVoiceAdministrators" -UserScopes @{Add="OU:ou=Portland,dc=litwareinc,dc=com"} ``` @@ -102,7 +103,7 @@ To do this, the command includes the UserScopes parameter and the following para This syntax adds the OU with the distinguished name "ou=Portland,dc=litwareinc,dc=com" to the OUs already in the UserScopes property. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsAdminRole -Identity "RedmondVoiceAdministrators" -UserScopes @{Remove="OU:ou=Portland,dc=litwareinc,dc=com"} ``` @@ -112,7 +113,7 @@ To do this, the command includes the UserScopes parameter and the following para This syntax deletes the OU with the distinguished name "ou=Portland,dc=litwareinc,dc=com" from the collection of OUs already in the UserScopes property. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsAdminRole -Identity "RedmondVoiceAdministrators" -ConfigScopes @{Add="site:Redmond"} ``` @@ -122,7 +123,7 @@ To do this, the command includes the ConfigScopes parameter and the following pa This syntax adds the Redmond site to any items already in the ConfigScopes property. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Set-CsAdminRole -Identity "RedmondVoiceAdministrators" -ConfigScopes @{Remove="site:Redmond"} ``` @@ -138,25 +139,45 @@ Set-CsAdminRole -Identity "RedmondVoiceAdministrators" -ConfigScopes @{Replace=" ## PARAMETERS -### -Identity -Unique identifier for the RBAC role to be modified. -The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. -For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. +### -Cmdlets + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the cmdlets that will be available to users who hold the RBAC role. +For example, to provide access to just one cmdlet (the `Export-CsArchivingData` cmdlet) use syntax like this: + +`-Cmdlets "Export-CsArchivingData"` + +The preceding syntax replaces all the items currently stored in the Cmdlets property with the single item `Export-CsArchivingData`. +If you want to add the `Export-CsArchivingData` cmdlet to the cmdlets already stored in that property, use this syntax instead: + +`-Cmdlets @{Add="Export-CsArchivingData"}` + +Multiple cmdlets can be added by separated the cmdlet names using commas: + +`-Cmdlets @{Add="Export-CsArchivingData","Invoke-CsArchivingDatabasePurge"}` + +To remove a cmdlet from a role, use this syntax: + +`-Cmdlets @{Remove="Export-CsArchivingData"}` + ```yaml -Type: String +Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.WritableConfig.Settings.Roles.CmdletType] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -ConfigScopes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Limits the scope of the cmdlet to configuration settings within the specified site. To limit the cmdlet scope to a single site, use syntax similar to this: `-ConfigScopes site:Redmond`. Multiple sites can be specified by using a comma-separated list: `-ConfigScopes "site:Redmond, "site:Dublin"`. @@ -173,8 +194,7 @@ You must specify a value for either (or both) the ConfigScopes and UserScopes pr ```yaml Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.ConfigScope] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,20 +203,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserScopes -Limits the scope of the cmdlet to user management activities within the specified OU. -To limit the cmdlet scope to a single OU, use syntax similar to this: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com"`. -Multiple OUs can be specified by using a comma-separated list: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com", "OU:ou=Dublin,dc=litwareinc,dc=com"`. -To add new scopes (or remove existing scopes) from a role, use the Windows PowerShell list modifiers syntax. -For details, see the Examples section in this Help topic. +### -Force -You must specify a value for either (or both) the ConfigScopes and UserScopes properties. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.UserScope] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,30 +221,52 @@ 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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the RBAC role to be modified. +The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. +For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ScriptModules + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a function within a Windows PowerShell script that will then be available to users who hold the new RBAC role. +For example, this syntax provides access to a function named Reset in a script named UpdateDatabase.ps1 : + +`-ScriptCmdlets "UpdateDatabase.ps1:Reset"` + +The preceding command replaces any scripts currently stored in the ScriptCmdlets property with the Reset function and the UpdateDatabase.ps1 script. +To add this script/function to items currently stored in the ScriptCmdlets property use this syntax: + +`-ScriptCmdlets @{Add="UpdateDatabase.ps1:Reset"}` + +To remove a script/function use this syntax: + +`-ScriptCmdlets @{Add="UpdateDatabase.ps1:Reset"}` + +You can delete all the ScriptCmdlets assigned to a role by using this syntax: + +`-ScriptCmdlets $Null` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +275,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -UserScopes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Limits the scope of the cmdlet to user management activities within the specified OU. +To limit the cmdlet scope to a single OU, use syntax similar to this: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com"`. +Multiple OUs can be specified by using a comma-separated list: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com", "OU:ou=Dublin,dc=litwareinc,dc=com"`. +To add new scopes (or remove existing scopes) from a role, use the Windows PowerShell list modifiers syntax. +For details, see the Examples section in this Help topic. + +You must specify a value for either (or both) the ConfigScopes and UserScopes properties. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.UserScope] Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -253,31 +299,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Cmdlets -Enables you to specify the cmdlets that will be available to users who hold the RBAC role. -For example, to provide access to just one cmdlet (the `Export-CsArchivingData` cmdlet) use syntax like this: - -`-Cmdlets "Export-CsArchivingData"` - -The preceding syntax replaces all the items currently stored in the Cmdlets property with the single item `Export-CsArchivingData`. -If you want to add the `Export-CsArchivingData` cmdlet to the cmdlets already stored in that property, use this syntax instead: - -`-Cmdlets @{Add="Export-CsArchivingData"}` - -Multiple cmdlets can be added by separated the cmdlet names using commas: - -`-Cmdlets @{Add="Export-CsArchivingData","Invoke-CsArchivingDatabasePurge"}` - -To remove a cmdlet from a role, use this syntax: +### -Confirm -`-Cmdlets @{Remove="Export-CsArchivingData"}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.WritableConfig.Settings.Roles.CmdletType] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -286,30 +317,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScriptModules -Enables you to specify a function within a Windows PowerShell script that will then be available to users who hold the new RBAC role. -For example, this syntax provides access to a function named Reset in a script named UpdateDatabase.ps1 : - -`-ScriptCmdlets "UpdateDatabase.ps1:Reset"` - -The preceding command replaces any scripts currently stored in the ScriptCmdlets property with the Reset function and the UpdateDatabase.ps1 script. -To add this script/function to items currently stored in the ScriptCmdlets property use this syntax: - -`-ScriptCmdlets @{Add="UpdateDatabase.ps1:Reset"}` - -To remove a script/function use this syntax: +### -WhatIf -`-ScriptCmdlets @{Add="UpdateDatabase.ps1:Reset"}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can delete all the ScriptCmdlets assigned to a role by using this syntax: - -`-ScriptCmdlets $Null` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[System.String] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -323,12 +340,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### None The `Set-CsAdminRole` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Roles.Role object. diff --git a/skype/skype-ps/skype/Set-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/Set-CsAllowedDomain.md similarity index 88% rename from skype/skype-ps/skype/Set-CsAllowedDomain.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAllowedDomain.md index 09d21b4f92..fbc9c06638 100644 --- a/skype/skype-ps/skype/Set-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAllowedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAllowedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csalloweddomain +schema: 2.0.0 +title: Set-CsAllowedDomain --- # Set-CsAllowedDomain @@ -53,7 +54,7 @@ The `Set-CsAllowedDomain` cmdlet provides a way for you to modify property value ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAllowedDomain -Identity fabrikam.com -Comment "Contact: Ken Myer (kenmyer@fabrikam.com)" ``` @@ -62,7 +63,7 @@ The command shown in Example 1 modifies the Comment property for the allowed dom This is done by including the Comment parameter and the appropriate parameter value: "Contact: Ken Myer (kenmyer@fabrikam.com)". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAllowedDomain -Filter *fabrikam* | Set-CsAllowedDomain -Comment "Contact: Ken Myer (kenmyer@fabrikam.com)" ``` @@ -74,7 +75,7 @@ The filter value "*fabrikam*" instructs the `Get-CsAllowedDomain` cmdlet to retu The filtered collection is then piped to the `Set-CsAllowedDomain` cmdlet, which modifies for Comment property. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAllowedDomain | Where-Object {$_.Comment -eq $Null} | Set-CsAllowedDomain -Comment "Need contact information." ``` @@ -85,7 +86,7 @@ This collection is then piped to the `Where-Object` cmdlet, which picks out thos That filtered collection is then piped to the `Set-CsAllowedDomain` cmdlet, which modifies the Comment property for each item in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsAllowedDomain | Where-Object {$_.Comment -eq $Null} | Set-CsAllowedDomain -Comment "Need contact information." ``` @@ -98,7 +99,47 @@ That filtered collection is then piped to `Set-CsAllowedDomain`, which modifies ## PARAMETERS +### -Comment + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Optional string value that provides additional information about the domain being modified. +For example, you might add a Comment that provides contact information for the federated domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the allowed domain for which the property values are being modified. For example: @@ -107,8 +148,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -118,13 +158,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,24 +175,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Comment -Optional string value that provides additional information about the domain being modified. -For example, you might add a Comment that provides contact information for the federated domain. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -MarkForMonitoring -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -MarkForMonitoring Indicates whether the federation connection between your domain and the remote domain will be monitored by Monitoring Server. By default, MarkForMonitoring is set to False, meaning that the connection will not be monitored. @@ -160,8 +188,7 @@ This property has been deprecated and should be ignored. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,14 +198,16 @@ Accept wildcard characters: False ``` ### -ProxyFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (for example, proxy-server.fabrikam.com) of the SIP proxy server deployed in the domain being added to the allowed list. This property is optional: if it is not specified then DNS SRV discovery procedures will be used to determine the location of the SIP proxy server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,30 +216,33 @@ 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. +### -VerificationLevel -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Indicates how (or if) messages sent from a domain are verified to ensure that they were sent from that domain. +The VerificationLevel must be set to one of the following values: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +AlwaysVerifiable. +All messages purportedly sent from this domain will be accepted. +If a verification header is not found in the message it will be added by Skype for Business Server 2015. + +AlwaysUnverifiable. +All messages purportedly sent from a domain are considered unverified. +They will be delivered only if they were sent from a person who is on the recipient's Contacts list. +For example, if Ken Myer is on your Contacts list you will be able to receive messages from him. +If David Longmire is not on your Contacts list then you will not be able to receive messages from him. +Note that Skype for Business users can manually override this setting, thereby allowing themselves to receive messages people not on their Contacts list. + +UseSourceVerification. +Uses the verification header added to the message by the public provider. +If the verification information is missing the message will be rejected. +This is the default value. ```yaml -Type: SwitchParameter +Type: VerificationLevelType Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,13 +252,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -235,31 +269,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VerificationLevel -Indicates how (or if) messages sent from a domain are verified to ensure that they were sent from that domain. -The VerificationLevel must be set to one of the following values: - -AlwaysVerifiable. -All messages purportedly sent from this domain will be accepted. -If a verification header is not found in the message it will be added by Skype for Business Server 2015. +### -WhatIf -AlwaysUnverifiable. -All messages purportedly sent from a domain are considered unverified. -They will be delivered only if they were sent from a person who is on the recipient's Contacts list. -For example, if Ken Myer is on your Contacts list you will be able to receive messages from him. -If David Longmire is not on your Contacts list then you will not be able to receive messages from him. -Note that Skype for Business users can manually override this setting, thereby allowing themselves to receive messages people not on their Contacts list. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -UseSourceVerification. -Uses the verification header added to the message by the public provider. -If the verification information is missing the message will be rejected. -This is the default value. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: VerificationLevelType +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -273,13 +292,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain + The `Set-CsAllowedDomain` cmdlet accepts pipelined instances of the allowed domain object. ## OUTPUTS -### +### None The `Set-CsAllowedDomain` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object. diff --git a/skype/skype-ps/skype/Set-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Set-CsAnalogDevice.md similarity index 83% rename from skype/skype-ps/skype/Set-CsAnalogDevice.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAnalogDevice.md index 5c9cadbf2c..6db113bf1f 100644 --- a/skype/skype-ps/skype/Set-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAnalogDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAnalogDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csanalogdevice +schema: 2.0.0 +title: Set-CsAnalogDevice --- # Set-CsAnalogDevice @@ -42,7 +43,7 @@ For example, you can change the contact's Active Directory display name or the l ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAnalogDevice -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com" -LineUri "TEL:+14255551298" ``` @@ -50,7 +51,7 @@ Set-CsAnalogDevice -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmo Example 1 changes the value of the LineUri property for the analog device that has the Identity CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAnalogDevice -Filter {Gateway -eq "192.168.0.240"} | Set-CsAnalogDevice -Gateway "192.168.1.100" ``` @@ -62,34 +63,35 @@ This filtered collection is then piped to the `Set-CsAnalogDevice` cmdlet, which ## PARAMETERS -### -Identity -Unique identifier for the analog device being modified. -Analog devices are identified by using the Active Directory distinguished name (DN) of the associated contact object. -By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. -This means you might find it easier to modify analog devices by using the `Get-CsAnalogDevice` cmdlet to return the analog devices objects and then piping those objects to the `Set-CsAnalogDevice` cmdlet. +### -AnalogFax +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Set to True ($True) if the analog device is a fax machine. +Set to False ($False) if the device is not a fax machine. ```yaml -Type: UserIdParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Gateway -IP address of the PSTN gateway to be used by the analog device. +### -DisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Configures the Active Directory display name of the analog device. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,15 +100,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AnalogFax -Set to True ($True) if the analog device is a fax machine. -Set to False ($False) if the device is not a fax machine. +### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number as displayed in Skype for Business. +The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; etc. + ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,17 +120,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -Phone number for the analog device. -The line URI should be specified by using the E.164 format, and be prefixed by 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. +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to modify contact information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (FQDN) (for example, atl-mcs-001.litwareinc.com). ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,17 +139,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -Unique identifier that allows the analog device to communicate with SIP devices such as Skype for Business Server. -The SIP address must be prefaced by the prefix "sip:". -For example: sip:bldg14lobby@litwareinc.com. +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True) the analog device can be used with Skype for Business. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: CsEnabled Required: False Position: Named @@ -153,14 +158,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Configures the Active Directory display name of the analog device. +### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the contact object for the analog device has been enabled for Enterprise Voice, the VoIP solution offered by Microsoft. +With Enterprise Voice, telephone calls can be made using the Internet rather than using the standard telephone network. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,16 +177,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber -Phone number as displayed in Skype for Business. -The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; etc. +### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the contact's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving ```yaml -Type: String +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,15 +205,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to modify contact information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (FQDN) (for example, atl-mcs-001.litwareinc.com). +### -Gateway + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +IP address of the PSTN gateway to be used by the analog device. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,31 +223,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnterpriseVoiceEnabled -Indicates whether the contact object for the analog device has been enabled for Enterprise Voice, the VoIP solution offered by Microsoft. -With Enterprise Voice, telephone calls can be made using the Internet rather than using the standard telephone network. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the analog device being modified. +Analog devices are identified by using the Active Directory distinguished name (DN) of the associated contact object. +By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. +This means you might find it easier to modify analog devices by using the `Get-CsAnalogDevice` cmdlet to return the analog devices objects and then piping those objects to the `Set-CsAnalogDevice` cmdlet. + ```yaml -Type: Boolean +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PassThru -Returns an object representing the common area phone. +### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the analog device. +The line URI should be specified by using the E.164 format, and be prefixed by 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. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +266,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns an object representing the common area phone. ```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 +Aliases: Required: False Position: Named @@ -253,14 +284,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier that allows the analog device to communicate with SIP devices such as Skype for Business Server. +The SIP address must be prefaced by the prefix "sip:". +For example: sip:bldg14lobby@litwareinc.com. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -269,15 +305,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -When set to True ($True) the analog device can be used with Skype for Business. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -286,24 +323,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the contact's instant messaging sessions are archived. -Allowed values are: - -Uninitialized - -UseLyncArchivingPolicy - -ArchivingToExchange +### -WhatIf -NoArchiving +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -317,13 +346,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact + The `Set-CsAnalogDevice` cmdlet accepts pipelined instances of the analog device object. ## OUTPUTS -### +### None By default, the `Set-CsAnalogDevice` cmdlet does not return any objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. diff --git a/skype/skype-ps/skype/Set-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/Set-CsAnnouncement.md similarity index 86% rename from skype/skype-ps/skype/Set-CsAnnouncement.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAnnouncement.md index 7ed8e2878a..03dcea5b9f 100644 --- a/skype/skype-ps/skype/Set-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAnnouncement.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAnnouncement -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csannouncement +schema: 2.0.0 +title: Set-CsAnnouncement --- # Set-CsAnnouncement @@ -44,7 +45,7 @@ This cmdlet modifies these announcement settings. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsAnnouncement | Where-Object {$_.Name -eq "Help Desk Announcement"} | Set-CsAnnouncement -AudioFilePrompt "helpdesk.wav" ``` @@ -57,7 +58,7 @@ In turn, that announcement is then piped to the `Set-CsAnnouncement` cmdlet, whi Note that if this announcement already has a TextToSpeechPrompt value assigned to it, this command will generate a warning that the TextToSpeechPrompt value will be ignored. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAnnouncement | Where-Object {$_.Name -eq "Help Desk Announcement"} | Set-CsAnnouncement -TextToSpeechPrompt $Null ``` @@ -68,7 +69,7 @@ This collection is then piped to the `Where-Object` cmdlet, which selects the an This announcement is then piped to the `Set-CsAnnouncement` cmdlet, which sets the TextToSpeechPrompt property to a null value ($Null). -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAnnouncement | Where-Object {$_.Name -eq "Help Desk Announcement"} | Set-CsAnnouncement -TargetUri "sip:kmyer@litwareinc.com;opaque=app:voicemail" ``` @@ -81,92 +82,103 @@ This announcement is then piped to the `Set-CsAnnouncement` cmdlet, which sets t ## PARAMETERS -### -Identity -A unique identifier for the Announcement. -This value will always be in the format \/\, where serviceID is the Identity of the Application Server running the Announcement service and GUID is a globally unique identifier associated with these announcement settings. -For example: ApplicationServer:redmond.litwareinc.com/bef5fa3b-3c97-4af0-abe7-611deee7616c. +### -AudioFilePrompt -Because GUIDs can be difficult to enter correctly at the command line, you'll most likely retrieve announcements by using the `Get-CsAnnouncement` cmdlet and pipe them to the `Set-CsAnnouncement` cmdlet for modification. -(For details, see the Examples section.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name of the audio file to be played for the announcement. +Audio files are stored in the File Store. +To save an audio file to the File Store, use the `Import-CsAnnouncementFile` cmdlet. + +Valid file types: WAV and WMA ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -A reference to the Announcement object you want to change. -This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement, which can be retrieved by calling the `Get-CsAnnouncement` cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Enter a value for this parameter to change the name of the announcement. -Names must be unique within a service. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the Announcement. +This value will always be in the format \/\, where serviceID is the Identity of the Application Server running the Announcement service and GUID is a globally unique identifier associated with these announcement settings. +For example: ApplicationServer:redmond.litwareinc.com/bef5fa3b-3c97-4af0-abe7-611deee7616c. + +Because GUIDs can be difficult to enter correctly at the command line, you'll most likely retrieve announcements by using the `Get-CsAnnouncement` cmdlet and pipe them to the `Set-CsAnnouncement` cmdlet for modification. +(For details, see the Examples section.) ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFilePrompt -The name of the audio file to be played for the announcement. -Audio files are stored in the File Store. -To save an audio file to the File Store, use the `Import-CsAnnouncementFile` cmdlet. +### -Instance -Valid file types: WAV and WMA +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to the Announcement object you want to change. +This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement, which can be retrieved by calling the `Get-CsAnnouncement` cmdlet. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -TextToSpeechPrompt -A text-to-speech (TTS) prompt. -This is a string that will be converted to audio and played as the announcement. +### -Language + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The language in which the TTS prompt will be played. +If a value is entered for TextToSpeechPrompt this parameter is required. + +Values are entered as a string representing the language and locale to be used. +The following is a list of valid values, followed by the language and locale in parentheses: ca-ES (Catalan, Spain); da-DK (Danish, Denmark); de-DE (German, Germany); en-AU (English, Australia); en-CA (English, Canada); en-GB (English, United Kingdom); en-IN (English, India); en-US (English, United States); es-ES (Spanish, Spain); es-MX (Spanish, Mexico); fi-FI (Finnish, Finland); fr-CA (French, Canada); fr-FR (French, France); it-IT (Italian, Italy); ja-JP (Japanese, Japan); ko-KR (Korean, Korea); nb-NO (Norwegian, Bokmal, Norway); nl-NL (Dutch, Netherlands); pl-PL (Polish, Poland); pt-BR (Portuguese, Brazil); pt-PT (Portuguese, Portugal); ru-RU (Russian, Russia); sv-SE (Swedish, Sweden); zh-CN (Chinese, People's Republic of China); zh-HK (Chinese, Hong Kong SAR); zh-TW (Chinese, Taiwan) -If both AudioFilePrompt and TextToSpeechPrompt are specified for a single announcement, you will receive a warning that the audio file will take precedence and the TTS prompt will be ignored. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,19 +187,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Language -The language in which the TTS prompt will be played. -If a value is entered for TextToSpeechPrompt this parameter is required. +### -Name -Values are entered as a string representing the language and locale to be used. -The following is a list of valid values, followed by the language and locale in parentheses: ca-ES (Catalan, Spain); da-DK (Danish, Denmark); de-DE (German, Germany); en-AU (English, Australia); en-CA (English, Canada); en-GB (English, United Kingdom); en-IN (English, India); en-US (English, United States); es-ES (Spanish, Spain); es-MX (Spanish, Mexico); fi-FI (Finnish, Finland); fr-CA (French, Canada); fr-FR (French, France); it-IT (Italian, Italy); ja-JP (Japanese, Japan); ko-KR (Korean, Korea); nb-NO (Norwegian, Bokmal, Norway); nl-NL (Dutch, Netherlands); pl-PL (Polish, Poland); pt-BR (Portuguese, Brazil); pt-PT (Portuguese, Portugal); ru-RU (Russian, Russia); sv-SE (Swedish, Sweden); zh-CN (Chinese, People's Republic of China); zh-HK (Chinese, Hong Kong SAR); zh-TW (Chinese, Taiwan) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enter a value for this parameter to change the name of the announcement. +Names must be unique within a service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,6 +207,9 @@ Accept wildcard characters: False ``` ### -TargetUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The URI to which the caller will be transferred after the announcement has been played. This value must be a SIP address entered in the format sip: followed by the SIP address. For example, sip:kmyer@litwareinc.com. @@ -205,8 +218,7 @@ Note that the SIP address can also be a telephone number or voice mail, for exam ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,14 +227,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -TextToSpeechPrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A text-to-speech (TTS) prompt. +This is a string that will be converted to audio and played as the announcement. + +If both AudioFilePrompt and TextToSpeechPrompt are specified for a single announcement, you will receive a warning that the audio file will take precedence and the TTS prompt will be ignored. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,14 +248,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -247,14 +266,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -268,13 +289,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement object. +### Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement + Accepts pipelined input of announcement objects. ## OUTPUTS -### +### None The `Set-CsAnnouncement` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement object. diff --git a/skype/skype-ps/skype/Set-CsApplicationServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsApplicationServer.md similarity index 80% rename from skype/skype-ps/skype/Set-CsApplicationServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsApplicationServer.md index 0d12488539..a8cf5e8612 100644 --- a/skype/skype-ps/skype/Set-CsApplicationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsApplicationServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csapplicationserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsApplicationServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csapplicationserver +schema: 2.0.0 +title: Set-CsApplicationServer --- # Set-CsApplicationServer @@ -40,7 +41,7 @@ Note that any time you change ports you will then need to restart the correspond ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsApplicationServer -Identity "ApplicationServer:atl-cs-001.litwareinc.com" -CasSipPort 5074 ``` @@ -48,7 +49,7 @@ Set-CsApplicationServer -Identity "ApplicationServer:atl-cs-001.litwareinc.com" The command shown in Example 1 configures the SIP port for the Conferencing Announcement application on the Application Server ApplicationServer:atl-cs-001.litwareinc.com to 5074. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsApplicationServer -Identity "ApplicationServer:atl-cs-001.litwareinc.com" -AudioPortStart 49500 -AudioPortCount 5500 ``` @@ -57,7 +58,7 @@ Example 2 configures audio ports for the Application Server ApplicationServer:at In this example, the starting audio port is set to 49500 and a total of 5500 ports are set aside for audio traffic. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsService -ApplicationServer | ForEach-Object {Set-CsApplicationServer -Identity $_.Identity -CasSipPort 5074} ``` @@ -69,35 +70,17 @@ This collection is then piped to the `ForEach-Object` cmdlet, which takes each s ## PARAMETERS -### -Identity -Service location of the Application Server to be modified. -For example: `-Identity "ApplicationServer:atl-cs-001.litwareinc.com"`. - -Note that you can leave off the prefix "ApplicationServer:" when specifying an Application server. -For example: `-Identity "atl-cs-001.litwareinc.com"`. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ApplicationDatabase -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ApplicationDatabase Service location of the Application database. For example: `-ApplicationDatabase "ApplicationDatabase:atl-cs-001.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 +Aliases: Required: False Position: Named @@ -107,6 +90,9 @@ Accept wildcard characters: False ``` ### -AppSharingPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for application sharing. The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100 then ports 60000 through 60099 will be used for application sharing. @@ -114,8 +100,7 @@ For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCo ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,14 +110,16 @@ Accept wildcard characters: False ``` ### -AppSharingPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for application sharing. For example: `-AppSharingPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,13 +129,15 @@ Accept wildcard characters: False ``` ### -AtsSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for the Audio Test service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +147,9 @@ Accept wildcard characters: False ``` ### -AudioPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100, then ports 60000 through 60099 will be used for audio traffic. @@ -165,8 +157,7 @@ For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,14 +167,16 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for sending and receiving audio traffic. For example: `-AudioPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,13 +186,15 @@ Accept wildcard characters: False ``` ### -CaaSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Conferencing Attendant application, used when connecting users to a dial-in conference. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,13 +204,15 @@ Accept wildcard characters: False ``` ### -CasSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Conferencing Announcement application, used to play announcements (for example, "Ken Myer is now exiting") during a conference. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,14 +222,16 @@ Accept wildcard characters: False ``` ### -CpsSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Call Park service. The Call Park service enables you to place a call on hold from one telephone, then have that call retrieved from a different phone. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,15 +240,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PdpSipPort -SIP port used by the Policy Decision Point Server. -The Policy Decision Point Server is used for bandwidth management. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,14 +258,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PdpTurnPort -Turn traffic port used by the Policy Decision Point Server. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Application Server to be modified. +For example: `-Identity "ApplicationServer:atl-cs-001.litwareinc.com"`. + +Note that you can leave off the prefix "ApplicationServer:" when specifying an Application server. +For example: `-Identity "atl-cs-001.litwareinc.com"`. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PdpSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Policy Decision Point Server. +The Policy Decision Point Server is used for bandwidth management. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -274,15 +299,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RgsSipPort -SIP port used by the Response Group application. -The Response Group application provides a way to direct incoming phone calls to a specific group of people, such as an organization's support team. +### -PdpTurnPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Turn traffic port used by the Policy Decision Point Server. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -291,14 +317,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RgsWcfMtlsPort -Port used for Windows Communication Foundation (WCF) mutual TLS (MTLS) traffic used by the Response Group application. +### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the Registrar associated with the Policy Decision Point Server. + ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -307,16 +336,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoPortCount -Total number of ports allocated for sending and receiving video traffic. -The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. -For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100, then ports 60000 through 60099 will be used for video traffic. +### -RgsSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Response Group application. +The Response Group application provides a way to direct incoming phone calls to a specific group of people, such as an organization's support team. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -325,15 +355,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoPortStart -First port in the range of ports allocated for sending and receiving video traffic. -For example `-VideoPortStart 60000`. +### -RgsWcfMtlsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for Windows Communication Foundation (WCF) mutual TLS (MTLS) traffic used by the Response Group application. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -342,14 +373,18 @@ 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. +### -VideoPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Total number of ports allocated for sending and receiving video traffic. +The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. +For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100, then ports 60000 through 60099 will be used for video traffic. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -358,14 +393,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -VideoPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First port in the range of ports allocated for sending and receiving video traffic. +For example `-VideoPortStart 60000`. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -375,13 +413,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -390,15 +430,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Registrar -Fully qualified domain name of the Registrar associated with the Policy Decision Point Server. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -412,13 +453,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsApplicationServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsApplicationServer` cmdlet does not return any values or objects. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayApplicationServer object. diff --git a/skype/skype-ps/skype/Set-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsArchivingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsArchivingConfiguration.md index f3a3c69100..ddb0f183b7 100644 --- a/skype/skype-ps/skype/Set-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsArchivingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csarchivingconfiguration +schema: 2.0.0 +title: Set-CsArchivingConfiguration --- # Set-CsArchivingConfiguration @@ -56,7 +57,7 @@ Either way, you can use the `Set-CsArchivingConfiguration` cmdlet to modify the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsArchivingConfiguration -Identity site:Redmond -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30 ``` @@ -66,7 +67,7 @@ First, the command sets the ArchiveDuplicateMessages property to False; this pre The command also uses the KeepArchivingDataForDays parameter to instruct the server to keep instant messages for 30 days. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingConfiguration -Filter "site:*" | Set-CsArchivingConfiguration -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30 ``` @@ -76,7 +77,7 @@ To carry out this task, the command first uses the `Get-CsArchivingConfiguration The filtered collection is then piped to the `Set-CsArchivingConfiguration` cmdlet, which modifies the two property values for each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -eq "ImAndWebConf"} | Set-CsArchivingConfiguration -EnableArchiving "ImOnly" ``` @@ -89,47 +90,10 @@ The filtered collection is then piped to the `Set-CsArchivingConfiguration` cmdl ## PARAMETERS -### -Identity -Represents the unique identifier of the collection of archiving configuration settings to be modified. -To modify the global settings, either leave out this parameter or use the following syntax: `-Identity global`. -To modify settings at the site scope, use the prefix "site:" followed by the site name. -For example: `-Identity "site:Redmond"`. - -To modify settings assigned to an individual Registrar pool use syntax similar to this: - -`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -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 Server 2015, Skype for Business Server 2019 +### -ArchiveDuplicateMessages -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ArchiveDuplicateMessages Specifies how "cross-pool" instant messages should be archived. Consider a simple example: Ken Myer (with an account in Pool 1) sends an instant message to Pilar Ackerman, who has an account in Pool 2. Pilar, in turn, sends a reply to Ken's instant message. @@ -139,8 +103,7 @@ If ArchiveDuplicateMessages is set to True (the default value), the transcript w ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,14 +113,16 @@ Accept wildcard characters: False ``` ### -BlockOnArchiveFailure + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, then the IM service will be suspended any time instant messages cannot be archived. If set to False (the default value), IM will continue even if instant messages cannot be archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +132,9 @@ Accept wildcard characters: False ``` ### -CachePurgingInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often (in hours) the system is purged of transcripts where none of the participants have been enabled for archiving. By design, all group IM sessions and conferencing sessions are recorded when they take place. At the specified interval, the system determines whether any of the participants in these sessions have been enabled for archiving. @@ -179,8 +147,7 @@ The default value is 24. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +157,9 @@ Accept wildcard characters: False ``` ### -EnableArchiving + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates which items (if any) are saved to the archiving database. Valid values are: @@ -206,8 +176,29 @@ Both IM and web conferencing sessions are archived to the database. ```yaml Type: EnableArchiving Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExchangeArchiving + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, Skype for Business Server instant message and conferencing transcripts are stored in Exchange rather than a separate SQL Server database. +Note that if you enable Exchange archiving then users will be managed by the Exchange archiving policies instead of Skype for Business Server archiving policies. + +The default value is False. + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -217,6 +208,9 @@ Accept wildcard characters: False ``` ### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, then archived instant messages will periodically be removed from the database, provided that these instant messages: 1) are older than the value specified in the KeepArchivingDataForDays property; or 2) have been exported and marked for deletion. If False, instant messages will not automatically be deleted from the database. @@ -224,8 +218,7 @@ If False, instant messages will not automatically be deleted from the database. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,17 +227,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepArchivingDataForDays -Number of days (between 1 and 2562) that archived instant messages are kept in the database before being automatically deleted. -The default value is 14. +### -Force -This property takes effect only if EnablePurging has been set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -253,37 +245,63 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PurgeExportedArchivesOnly -If True, then the system will only purge instant messages that have been exported (and, as a result, have been marked for deletion). -Instant messages that have not been exported will remain in the database, even if those instant messages are older than the value specified by the KeepArchivingDataForDays property. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the unique identifier of the collection of archiving configuration settings to be modified. +To modify the global settings, either leave out this parameter or use the following syntax: `-Identity global`. +To modify settings at the site scope, use the prefix "site:" followed by the site name. +For example: `-Identity "site:Redmond"`. + +To modify settings assigned to an individual Registrar pool use syntax similar to this: + +`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` + ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PurgeHourOfDay -Indicates the time of day when expired records are deleted from the archiving database. -The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 AM) and 23 representing 11:00 PM. -Note that you can only specify the hour of the day. -This means that you can schedule purging to take place at 4:00 AM but you cannot schedule it to take place at, for instance, 4:30 AM or 4:15 AM. -The default value is 2 (2:00 AM). +### -Instance -Database purging takes place only if the EnablePurging property is set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -KeepArchivingDataForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Number of days (between 1 and 2562) that archived instant messages are kept in the database before being automatically deleted. +The default value is 14. + +This property takes effect only if EnablePurging has been set to True. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,14 +310,17 @@ 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. +### -PurgeExportedArchivesOnly + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, then the system will only purge instant messages that have been exported (and, as a result, have been marked for deletion). +Instant messages that have not been exported will remain in the database, even if those instant messages are older than the value specified by the KeepArchivingDataForDays property. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,14 +329,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the time of day when expired records are deleted from the archiving database. +The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 AM) and 23 representing 11:00 PM. +Note that you can only specify the hour of the day. +This means that you can schedule purging to take place at 4:00 AM but you cannot schedule it to take place at, for instance, 4:30 AM or 4:15 AM. +The default value is 2 (2:00 AM). + +Database purging takes place only if the EnablePurging property is set to True. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -325,13 +354,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -340,18 +371,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableExchangeArchiving -When set to True, Skype for Business Server instant message and conferencing transcripts are stored in Exchange rather than a separate SQL Server database. -Note that if you enable Exchange archiving then users will be managed by the Exchange archiving policies instead of Skype for Business Server archiving policies. +### -WhatIf -The default value is False. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -365,13 +394,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings + The `Set-CsArchivingConfiguration` cmdlet accepts pipelined input of archiving configuration objects. ## OUTPUTS -### +### None The `Set-CsArchivingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object. diff --git a/skype/skype-ps/skype/Set-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingPolicy.md similarity index 87% rename from skype/skype-ps/skype/Set-CsArchivingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsArchivingPolicy.md index f4e73c3195..9da2eb8a80 100644 --- a/skype/skype-ps/skype/Set-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsArchivingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csarchivingpolicy +schema: 2.0.0 +title: Set-CsArchivingPolicy --- # Set-CsArchivingPolicy @@ -55,7 +56,7 @@ The `Set-CsArchivingPolicy` cmdlet enables you to modify the property values for ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsArchivingPolicy -Identity global -ArchiveInternal $True ``` @@ -64,7 +65,7 @@ In this example, the `Set-CsArchivingPolicy` cmdlet is used to modify the global In this case, the ArchiveInternal property is set to True. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingPolicy | Set-CsArchivingPolicy -ArchiveInternal $True ``` @@ -77,46 +78,10 @@ That collection is then piped to the `Set-CsArchivingPolicy` cmdlet, which sets ## PARAMETERS -### -Identity -Unique identifier for the archiving policy to be modified. -Archiving 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 SalesArchivingPolicy`. -If this parameter is not specified, then the global policy will be modified. - -Wildcards are not allowed when specifying an Identity. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -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 Server 2015, Skype for Business Server 2019 +### -ArchiveExternal -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ArchiveExternal Indicates whether external IM sessions are archived. (An external IM session is one in which at least one of the participants is an unauthenticated user who does not have an Active Directory account within your organization.) The default value is False, which means that IM sessions that include external users are not archived. @@ -124,8 +89,7 @@ Indicates whether external IM sessions are archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,14 +99,16 @@ Accept wildcard characters: False ``` ### -ArchiveInternal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether internal IM sessions are archived. (An internal IM session is one in which all the participants are authenticated users who have Active Directory accounts within your organization.) The default value is False, which means that internal IM sessions are not archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,14 +118,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional text regarding the policy. For example, the Description property might be used to detail which users the policy should be applied to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +137,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,39 +154,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the archiving policy to be modified. +Archiving 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 SalesArchivingPolicy`. +If this parameter is not specified, then the global policy will be modified. + +Wildcards are not allowed when specifying an Identity. ```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 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the archiving policy is being modified. For example: @@ -229,8 +213,43 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -244,13 +263,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy + The `Remove-CsArchivingPolicy` cmdlet accepts pipelined input of archiving policy objects. ## OUTPUTS -### +### None The `Set-CsArchivingPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Policy.IM.IMArchivingPolicy object. diff --git a/skype/skype-ps/skype/Set-CsArchivingServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingServer.md similarity index 86% rename from skype/skype-ps/skype/Set-CsArchivingServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsArchivingServer.md index 8d31fba3a6..1e7eb5d4a1 100644 --- a/skype/skype-ps/skype/Set-CsArchivingServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsArchivingServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csarchivingserver +schema: 2.0.0 +title: Set-CsArchivingServer --- # Set-CsArchivingServer @@ -36,7 +37,7 @@ However, if a hardware failure or other problem should occur, you can point Arch ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsArchivingServer -Identity "ArchivingServer:atl-cs-001.litwareinc.com" -ArchivingDatabase "ArchivingDatabase:atl-sql-001.litwareinc.com" ``` @@ -47,39 +48,36 @@ In this example, the new database is located at ArchivingDatabase:atl-sql-001.li ## PARAMETERS -### -Identity -Service location of the Archiving Server instance to be modified. -For example: `-Identity ArchivingServer:atl-cs-001.litwareinc.com`. -You can retrieve the service location for all your Archiving servers by running this command: +### -ArchivingDatabase -`Get-CsService -ArchivingServer | Select-Object Identity` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you can leave off the prefix "ArchivingServer:" when specifying an Archiving server. -For example: `-Identity "atl-cs-001.litwareinc.com"`. +Service location where the new Archiving database is located. +For example: `-ArchivingDatabase ArchivingDatabase:atl-sql-001.litwareinc.com`. +Make sure you use the service location and not the SQL Server path when specifying the database location. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ArchivingDatabase -Service location where the new Archiving database is located. -For example: `-ArchivingDatabase ArchivingDatabase:atl-sql-001.litwareinc.com`. -Make sure you use the service location and not the SQL Server path when specifying the database location. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,30 +86,41 @@ 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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Archiving Server instance to be modified. +For example: `-Identity ArchivingServer:atl-cs-001.litwareinc.com`. +You can retrieve the service location for all your Archiving servers by running this command: + +`Get-CsService -ArchivingServer | Select-Object Identity` + +Note that you can leave off the prefix "ArchivingServer:" when specifying an Archiving server. +For example: `-Identity "atl-cs-001.litwareinc.com"`. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -120,14 +129,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -141,13 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsArchivingServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsArchivingServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Xds.DisplayArchivingServer object. diff --git a/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsAudioTestServiceApplication.md similarity index 82% rename from skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAudioTestServiceApplication.md index bb891a7b26..71f87688ae 100644 --- a/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAudioTestServiceApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csaudiotestserviceapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAudioTestServiceApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csaudiotestserviceapplication +schema: 2.0.0 +title: Set-CsAudioTestServiceApplication --- # Set-CsAudioTestServiceApplication @@ -43,7 +44,7 @@ Administrators can also use the `Set-CsAudioTestServiceApplication` cmdlet to mo ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAudioTestServiceApplication -Identity "sip:RedmondAudioTest@litwareinc.com" -PrimaryLanguage "en-US" ``` @@ -52,7 +53,7 @@ In Example 1, the primary language for the Audio Test service contact sip:Redmon English (en-US). -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsAudioTestServiceApplication -Identity "sip:RedmondAudioTest@litwareinc.com" -PrimaryLanguage $Null ``` @@ -61,7 +62,7 @@ Example 2 clears the value of the PrimaryLanguage property for the Audio Test se This is done by including the PrimaryLanguage parameter and setting the parameter value to $Null. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAudioTestServiceApplication | Set-CsAudioTestServiceApplication -PrimaryLanguage "en-US" ``` @@ -75,32 +76,16 @@ English (en-Us) to the PrimaryLanguage property for each contact in the collecti ## PARAMETERS -### -Identity -SIP address of the audio test service contact to be modified. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` +### -DisplayName -### -Enabled -Indicates whether or not the contact object has been enabled for Skype for Business Server. -If you set this value to False ($False), the contact will no longer be able to log on to Skype for Business Server; setting this value to True ($True) re-enables the contact's logon privileges. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Active Directory display name of the contact object. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,14 +94,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Active Directory display name of the contact object. +### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Although a valid property, DisplayNumber is not actually used with the Audio Test service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,14 +112,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber -Although a valid property, DisplayNumber is not actually used with the Audio Test service. +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the contact object has been enabled for Skype for Business Server. +If you set this value to False ($False), the contact will no longer be able to log on to Skype for Business Server; setting this value to True ($True) re-enables the contact's logon privileges. + ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: CsEnabled Required: False Position: Named @@ -142,14 +133,16 @@ Accept wildcard characters: False ``` ### -EnabledForFederation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether this contact is available to users from a federated domain. If set to False, only users within your organization will have access to the contact. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,14 +152,16 @@ Accept wildcard characters: False ``` ### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the contact object has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, users can use make telephone calls by using the Internet rather than by using the standard telephone network. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,19 +170,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrimaryLanguage -Primary language used for the audio test service. -The language must be configured using one of the allowed language codes; for example, en-US for U.S. -English; fr-FR for French; etc. -To return a list of the available language codes, type the following command at the Windows PowerShell prompt: +### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the contact's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving -`Get-CsDialInConferencingLanguageList | Select-Object -ExpandProperty Languages`. ```yaml -Type: String +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,32 +198,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryLanguages -Although a valid property, SecondaryLanguages is not actually used with the Audio Test service. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the audio test service contact to be modified. ```yaml -Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -SipAddress -This parameter is currently disabled. -You cannot change the SIP address using `Set-CsAudioTestServiceApplication`. +### -LineURI +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Although a valid property, LineUri is not actually used with the Audio Test service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,15 +234,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Indicates the type of test contact being deployed. -By default, contacts are listed as Automaton, which means they can interact with callers. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the `Set-CsAudioTestServiceApplication` cmdlet does not pass objects through the pipeline. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,15 +253,21 @@ 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 `Set-CsAudioTestServiceApplication` cmdlet does not pass objects through the pipeline. +### -PrimaryLanguage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Primary language used for the audio test service. +The language must be configured using one of the allowed language codes; for example, en-US for U.S. +English; fr-FR for French; etc. +To return a list of the available language codes, type the following command at the Windows PowerShell prompt: + +`Get-CsDialInConferencingLanguageList | Select-Object -ExpandProperty Languages`. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,14 +276,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SecondaryLanguages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Although a valid property, SecondaryLanguages is not actually used with the Audio Test service. ```yaml -Type: SwitchParameter +Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -280,14 +294,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is currently disabled. +You cannot change the SIP address using `Set-CsAudioTestServiceApplication`. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -296,14 +314,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -Although a valid property, LineUri is not actually used with the Audio Test service. +### -Type + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the type of test contact being deployed. +By default, contacts are listed as Automaton, which means they can interact with callers. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -312,24 +333,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the contact's instant messaging sessions are archived. -Allowed values are: +### -Confirm -Uninitialized +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -UseLyncArchivingPolicy +Prompts you for confirmation before executing the command. -ArchivingToExchange +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -NoArchiving +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -343,12 +374,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact The `Set-CsAudioTestServiceApplication` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object. ## OUTPUTS -### +### None The `Set-CsAudioTestServiceApplication` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsAuthConfig.md b/skype/skype-ps/SkypeForBusiness/Set-CsAuthConfig.md similarity index 91% rename from skype/skype-ps/skype/Set-CsAuthConfig.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAuthConfig.md index 3e47cfbe63..939ca2c660 100644 --- a/skype/skype-ps/skype/Set-CsAuthConfig.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAuthConfig.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csauthconfig applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAuthConfig -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csauthconfig +schema: 2.0.0 +title: Set-CsAuthConfig --- # Set-CsAuthConfig @@ -24,11 +25,11 @@ Set-CsAuthConfig [-Scenario] [[-Pool] ] [-WhatIf] [ ## DESCRIPTION Use the Set-CsAuthConfig cmdlet to modify the authentication configuration for your organization. The 5 supported scenarios are described in the following list. Scenario is a required parameter. All other parameters are optional. MA is Modern Authentication and Win is Windows Integrated Authentication in the following list. -- **Scenario 1**: External: MA + Win; Internal: MA + Win; Parameter: AllowAllExternallyAndInternally. This is the default scenario when MA is turned on for Skype for Business Server. In other words, this is the starting point when MA is configured. +- **Scenario 1**: External: MA + Win; Internal: MA + Win; Parameter: AllowAllExternallyAndInternally. This is the default scenario when MA is turned on for Skype for Business Server. In other words, this is the starting point when MA is configured. - **Scenario 2**: External: MA; Internal: MA + Win; Parameter: BlockWindowsAuthExternally. This topology blocks NTLM externally, but allows NTLM or Kerberos (for clients that don't support ADAL) to work internally. If your clients do support ADAL they will use MA internally. -- **Scenario 3**: External: MA; Internal: MA; Parameter: BlockWindowsAuthExternallyAndInternally. This topology requires MA for all users. All your ADAL-capable clients will work in this topology, and passwords will not be leveraged if, for example, you turn off the use of passwords with Certificate-based Auth. +- **Scenario 3**: External: MA; Internal: MA; Parameter: BlockWindowsAuthExternallyAndInternally. This topology requires MA for all users. All your ADAL-capable clients will work in this topology, and passwords will not be leveraged if, for example, you turn off the use of passwords with Certificate-based Auth. - **Scenario 4**: External: MA; Internal: Win; Parameter: BlockWindowsAuthExternallyAndModernAuthInternally. This topology blocks NTLM externally and MA internally. It allows all clients to use legacy authentication methods internally (even ADAL-capable clients). @@ -53,36 +54,23 @@ This example forces all external clients to use MA but allows NTLM or Kerberos ( PS C:\> Set-CsAuthConfig -Scenario BlockWindowsAuthExternalyAndModernAuthInternally ``` -This example blocks NTLM externally and MA internally. It forces all external clients to use MA, but allows all clients to use legacy authentication methods internally (even ADAL-capable clients). +This example blocks NTLM externally and MA internally. It forces all external clients to use MA, but allows all clients to use legacy authentication methods internally (even ADAL-capable clients). > [!NOTE] > Please note that in the current version of the module the parameter value BlockWindowsAuthExternalyAndModernAuthInternally is misspelled and to be able to use it, only one l for Externally should be used. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Pool -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2019 -### -Pool {{Fill Pool Description}} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: 0 Default value: None @@ -91,6 +79,9 @@ Accept wildcard characters: False ``` ### -Scenario + +> Applicable: Skype for Business Server 2019 + {{Fill Scenario Description}} ```yaml @@ -98,7 +89,6 @@ Type: AuthConfigScenario Parameter Sets: (All) Aliases: Accepted values: Custom, AllowAllExternallyAndInternally, BlockWindowsAuthExternally, BlockWindowsAuthExternallyAndInternally, BlockWindowsAuthExternalyAndModernAuthInternally, BlockModernAuthInternally -Applicable: Skype for Business Server 2019 Required: True Position: 1 Default value: None @@ -106,7 +96,27 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2019 + +Prompts you for confirmation before running the 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 + +> Applicable: Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -114,7 +124,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -138,6 +147,6 @@ For more information, see [about_CommonParameters](https://go.microsoft.com/fwli ## NOTES -After changing CsAuthConfig, you must run [Enable-CsComputer](https://learn.microsoft.com/powershell/module/skype/enable-cscomputer?view=skype-ps) on each Skype for Business Server machine before your changes take effect. +After changing CsAuthConfig, you must run [Enable-CsComputer](https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-cscomputer?view=skype-ps) on each Skype for Business Server machine before your changes take effect. ## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAutodiscoverConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAutodiscoverConfiguration.md index 19027a504c..e2b1976aaa 100644 --- a/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAutodiscoverConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csautodiscoverconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAutodiscoverConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csautodiscoverconfiguration +schema: 2.0.0 +title: Set-CsAutodiscoverConfiguration --- # Set-CsAutodiscoverConfiguration @@ -60,7 +61,7 @@ From there, you can use the `Set-CsAutoDiscoverConfiguration` cmdlet to add or r ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscover.fabrikam.com" @@ -73,7 +74,7 @@ In the second command, the `Set-CsAutoDiscoverConfiguration` cmdlet is used to a This is done by using the WebLinks parameter and the parameter value @{Add=$Link1}. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $Link1 = Get-CsAutoDiscoverConfiguration -Identity "site:Redmond" | Select-Object -ExpandProperty WebLinks | Where-Object {$_.Token -eq "Fabrikam"} @@ -91,7 +92,7 @@ After that the second command in the example uses the `Set-CsAutoDiscoverConfigu To do this, the command uses the WebLinks parameter and the parameter value @{Remove=$Link1}. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $Link2 = New-CsWebLink -Token "Contoso" -Href "https://LyncDiscover.contoso.com" @@ -104,7 +105,7 @@ The second command then uses the `Set-CsAutoDiscoverConfiguration` cmdlet and th To do this, the command uses the Replace method instead of the Add or Remove method. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks $Null ``` @@ -116,14 +117,16 @@ In turn, that deletes any URLs previously assigned to that property. ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableCertificateProvisioningServiceUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), the Certificate Provisioning Service URL is included in Autodiscover Service responses. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,14 +137,33 @@ Accept wildcard characters: False ### -EnableCORS +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, Cross-Origin Resource Sharing is enabled. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` +### -EnableCORS + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, Cross-Origin Resource Sharing is enabled. + +```yaml +Type: Boolean +Position: Named +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: False @@ -150,14 +172,16 @@ Accept wildcard characters: False ``` ### -ExternalSipClientAccessFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the server that is used for external client access. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +191,15 @@ Accept wildcard characters: False ``` ### -ExternalSipClientAccessPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for eternal client access. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,13 +209,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,6 +227,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Autodiscover configuration settings to be modified. To modify to the global collection, use this syntax: @@ -214,8 +245,7 @@ If this parameter is not specified, then the `Set-CsAutoDiscoverConfiguration` c ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -225,13 +255,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,14 +273,16 @@ Accept wildcard characters: False ``` ### -WebLinks + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of Autodiscover URLs. These URLs must be created by using the `New-CsWebLink` cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,30 +291,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableCertificateProvisioningServiceUrl -When set to True (the default value), the Certificate Provisioning Service URL is included in Autodiscover Service responses. +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -289,19 +309,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableCORS +### -WhatIf -If set to True, Cross-Origin Resource Sharing is enabled. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean -Position: Named +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -311,13 +332,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration The `Set-CsAutoDiscoverConfiguration` cmdlet accepts pipelined input of the Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration object. ## OUTPUTS -### -None. +### None The `Set-CsAutoDiscoverConfiguration` cmdlet modifies instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsBackupServiceConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsBackupServiceConfiguration.md index dec80abb43..7620a9b9eb 100644 --- a/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBackupServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csbackupserviceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsBackupServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csbackupserviceconfiguration +schema: 2.0.0 +title: Set-CsBackupServiceConfiguration --- # Set-CsBackupServiceConfiguration @@ -46,7 +47,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsBackupServiceConfiguration -Identity "global" -AuthorizedUniversalGroups "Schema Admins" ``` @@ -54,7 +55,7 @@ Set-CsBackupServiceConfiguration -Identity "global" -AuthorizedUniversalGroups " The command shown in Example 1 assigns the Active Directory security group Schema Admins to the AuthorizedUniversalGroups property for the global collection of backup service settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsBackupServiceConfiguration -Identity "global" -MaxConcurrentCalls 12 ``` @@ -62,7 +63,7 @@ Set-CsBackupServiceConfiguration -Identity "global" -MaxConcurrentCalls 12 In Example 2, the MaxConcurrentCalls property of the global collection of backup service settings is set to 12. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsBackupServiceConfiguration -Identity "global" -SyncInterval "00:10:00" ``` @@ -74,14 +75,16 @@ In this example, SyncInterval is set to 10 minutes: 00 hours : 10 minutes : 00 s ## PARAMETERS ### -AuthorizedLocalAccounts + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Names of the local users/local groups that are authorized to run the backup service. The default value is Network Service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,14 +94,16 @@ Accept wildcard characters: False ``` ### -AuthorizedUniversalGroups + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Names of the universal groups authorized to run the backup service. The default value is Schema admins. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,30 +112,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableRgsBackupService + +> Applicable: Skype for Business Server 2019 + +Indicates whether the backup service for RGS has been enabled or not. If it is set to true RGSBackupService will start syncing RGS data on paired pools ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the backup service configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the `Set-CsBackupServiceConfiguration` cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -150,8 +162,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -161,13 +172,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,14 +190,16 @@ Accept wildcard characters: False ``` ### -MaxBatchesPerCmsSync + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of batches that the CMS backup module will export during each export cycle. The default value is 500. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -194,14 +209,16 @@ Accept wildcard characters: False ``` ### -MaxBatchesPerUserStoreSync + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of batches that the User Store backup module will export during each export cycle. The default value is 500. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -211,14 +228,16 @@ Accept wildcard characters: False ``` ### -MaxConcurrentCalls + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of Windows Communication Foundation (WCF) calls that can be made to the backup service at the same time. The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -228,14 +247,16 @@ Accept wildcard characters: False ``` ### -MaxDataConfPackageSizeKB + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum size of the data package (in kilobytes) that the Data Conference module will export during each export cycle. The default value is 102400. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,17 +265,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncInterval -Specifies the amount of time that the service waits before synchronizing a pool with its backup pool. -The default value is 2 minutes (00:02:00, or 00 hours, 02 minutes, 00 seconds). -The SyncInterval can be configured to any value between 5 seconds (00:00:05) and 3 hours (03:00:00), inclusive. +### -MaxHighPriQueuePercentagePerUserStoreSync +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: Int32 ```yaml -Type: TimeSpan +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -263,14 +283,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SyncInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time that the service waits before synchronizing a pool with its backup pool. +The default value is 2 minutes (00:02:00, or 00 hours, 02 minutes, 00 seconds). +The SyncInterval can be configured to any value between 5 seconds (00:00:05) and 3 hours (03:00:00), inclusive. + ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,14 +304,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxHighPriQueuePercentagePerUserStoreSync -PARAMVALUE: Int32 +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -295,34 +322,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRgsBackupService -Indicates whether the backup service for RGS has been enabled or not. If it is set to true RGSBackupService will start syncing RGS data on paired pools +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: wi +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.WritableConfig.Settings.BackupService.BackupServiceConfiguration The `Set-CsBackupServiceConfiguration` cmdlet accepts piped instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsBackupServiceConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsBandwidthPolicyServiceConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsBandwidthPolicyServiceConfiguration.md index cc5fd68c6b..3ea0c12444 100644 --- a/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBandwidthPolicyServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsBandwidthPolicyServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csbandwidthpolicyserviceconfiguration +schema: 2.0.0 +title: Set-CsBandwidthPolicyServiceConfiguration --- # Set-CsBandwidthPolicyServiceConfiguration @@ -42,7 +43,7 @@ This cmdlet modifies an existing bandwidth policy service configuration. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond -EnableLogging $true -MaxTokenLifetime 3:00:00 -LogCleanUpInterval 5.00:00:00 ``` @@ -57,15 +58,53 @@ Finally, the LogCleanUpInterval parameter receives a value of 5.00:00:00, which ## PARAMETERS +### -EnableLogging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Set this parameter to True to generate CAC failure and link status logs related to the bandwidth policy service. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the configuration you want to change. This identifier will consist of the scope (for the global configuration) or the scope and name (for a site-level configuration, such as site:Redmond). ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -75,14 +114,16 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to a bandwidth policy service configuration object. This object must be of type BandwidthPolicyServiceConfiguration, which can be retrieved by calling the `Get-CsBandwidthPolicyServiceConfiguration` cmdlet. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,23 +132,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -EnableLogging -Set this parameter to True to generate CAC failure and link status logs related to the bandwidth policy service. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LogCleanUpInterval -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LogCleanUpInterval The period of time after which CAC failure and link status logs will be removed. This value must be within the range 1 day through 60 days. @@ -117,8 +145,7 @@ For example, 20 days would be 20.00:00:00. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +155,9 @@ Accept wildcard characters: False ``` ### -MaxLogFileSizeMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum size the log file is allowed to reach. The value for this parameter must be a positive number and specifies the file size in megabytes. For example, to allow the log file to reach a maximum size of 10 megabytes, enter the value 10. @@ -135,8 +165,7 @@ For example, to allow the log file to reach a maximum size of 10 megabytes, ente ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +175,9 @@ Accept wildcard characters: False ``` ### -MaxTokenLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of time the token issued by the Bandwidth Policy Authentication service will exist. This value must be in the range 1 hour through 24 hours. @@ -155,8 +187,7 @@ For example, the value for 12 hours would be 12:00:00. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,14 +196,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -182,29 +215,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -218,13 +237,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration + Accepts pipelined input of bandwidth policy service configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration. diff --git a/skype/skype-ps/skype/Set-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/Set-CsBlockedDomain.md similarity index 88% rename from skype/skype-ps/skype/Set-CsBlockedDomain.md rename to skype/skype-ps/SkypeForBusiness/Set-CsBlockedDomain.md index 15662712d0..e960300107 100644 --- a/skype/skype-ps/skype/Set-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBlockedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsBlockedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csblockeddomain +schema: 2.0.0 +title: Set-CsBlockedDomain --- # Set-CsBlockedDomain @@ -51,7 +52,7 @@ If you need to change the Comment property for any domain on the list of blocked ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsBlockedDomain -Identity fabrikam.com -Comment "Block this domain pending legal review." ``` @@ -60,7 +61,7 @@ The command shown in Example 1 modifies the Comment for the blocked domain with In this example, the Comment parameter is included along with the parameter value, "Block this domain pending legal review." -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsBlockedDomain | Set-CsBlockedDomain -Comment "Block this domain pending legal review." ``` @@ -70,7 +71,7 @@ To do this, the command first calls the `Get-CsBlockedDomain` cmdlet, which retu That collection is then piped to the `Set-CsBlockedDomain` cmdlet, which proceeds to modify the Comment property for each domain in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsBlockedDomain | Where-Object {$_.Comment -eq $Null} | Set-CsBlockedDomain -Comment "Block this domain pending legal review." ``` @@ -83,80 +84,90 @@ The filtered collection is then piped to the `Set-CsBlockedDomain` cmdlet, which ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the blocked domain for which the Comment property is being modified. -For example: fabrikam.com +### -Comment + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to provide additional information about the domain being modified. +For example, you might add a Comment that indicates why the domain has been placed on the blocked list. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Comment -Enables you to provide additional information about the domain being modified. -For example, you might add a Comment that indicates why the domain has been placed on the blocked list. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the blocked domain for which the Comment property is being modified. +For example: fabrikam.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 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -165,14 +176,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -186,13 +199,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain + The `Set-CsBlockedDomain` cmdlet accepts pipelined instances of the blocked domain object. ## OUTPUTS -### +### None The `Set-CsBlockedDomain` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. diff --git a/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsBroadcastMeetingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsBroadcastMeetingConfiguration.md index 62a74c0304..ebfc086c66 100644 --- a/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBroadcastMeetingConfiguration.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-csbroadcastmeetingconfiguration applicable: Skype for Business Online -title: Set-CsBroadcastMeetingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csbroadcastmeetingconfiguration +schema: 2.0.0 +title: Set-CsBroadcastMeetingConfiguration --- # Set-CsBroadcastMeetingConfiguration @@ -58,7 +60,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsBroadcastMeetingConfiguration -Identity Global -EnableAnonymousBroadcastMeeting $true -EnableBroadcastMeetingRecording $true ``` @@ -66,7 +68,7 @@ Set-CsBroadcastMeetingConfiguration -Identity Global -EnableAnonymousBroadcastMe This example sets the global configuration to enable unauthenticated attendees and recorded meetings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsBroadcastMeetingConfiguration -EnableSdnProviderForBroadcastMeeting $true -SdnProviderName "SDNCo" -SdnLicenseId 24030-38291-39042-2048-253904 -SdnApiTemplateUrl "https://api.SDNCo.com/template?auth={0}" -SdnFallbackAttendeeThresholdCountForBroadcastMeeting 1000 ``` @@ -74,7 +76,7 @@ Set-CsBroadcastMeetingConfiguration -EnableSdnProviderForBroadcastMeeting $true This example enables Software Defined Network (SDN) management of broadcast meetings and provides all the required and optional settings to enable SDN support. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsBroadcastMeetingConfiguration -SdnFallbackAttendeeThresholdCountForBroadcastMeeting 500 ``` @@ -84,50 +86,17 @@ This example adjusts the broadcast meeting configuration to set the number of me ## PARAMETERS -### -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 EnableSdnProviderForBroadcastMeeting is set to $true. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SdnProviderName -Specifies the Software Defined Network (SDN) provider's name. -This parameter is only required if EnableSdnProviderForBroadcastMeeting is set to $true. +### -BroadcastMeetingSupportUrl -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +> Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BroadcastMeetingSupportUrl Specifies a URL where broadcast meeting attendees can find support information or FAQs specific to that meeting. The URL will be displayed during the broadcast meeting. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -136,23 +105,10 @@ 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 +### -EnableAnonymousBroadcastMeeting -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -EnableAnonymousBroadcastMeeting Specifies whether non-authenticated attendees are allowed to join and view the web-based portion of the meeting. Valid input for this parameter is $true or $false. The default value is $true. @@ -160,8 +116,7 @@ The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -171,6 +126,9 @@ Accept wildcard characters: False ``` ### -EnableBroadcastMeeting + +> Applicable: Skype for Business Online + Specifies whether broadcast meetings are enabled. Valid input for this parameter is $true or $false. The default value is $false. @@ -178,8 +136,7 @@ The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -189,6 +146,9 @@ Accept wildcard characters: False ``` ### -EnableBroadcastMeetingRecording + +> Applicable: Skype for Business Online + Specifies whether broadcast meetings can be recorded at the server level. Valid input for this parameter is $true or $false. The default value is $true. @@ -196,8 +156,7 @@ The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -207,14 +166,16 @@ Accept wildcard characters: False ``` ### -EnableOpenBroadcastMeeting + +> Applicable: Skype for Business Online + Specifies if the organizer is allowed to create broadcast meetings that allows anyone in the organizer's organization to attend. The default and only setting is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -224,14 +185,16 @@ Accept wildcard characters: False ``` ### -EnableSdnProviderForBroadcastMeeting + +> Applicable: Skype for Business Online + If set to $true, broadcast meeting streams are enabled to take advantage of the network and bandwidth management capabilities of your Software Defined Network (SDN) provider. The default is $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -241,14 +204,16 @@ Accept wildcard characters: False ``` ### -EnableTechPreviewFeatures + +> Applicable: Skype for Business Online + Set to $true to enable use of features available in a technical preview program. Set to $false to disable the technical preview features. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -258,6 +223,9 @@ Accept wildcard characters: False ``` ### -EnforceBroadcastMeetingRecording + +> Applicable: Skype for Business Online + Specifies whether all meetings will be recorded. Valid input for this parameter is $true or $false. The default value is $false. @@ -265,8 +233,7 @@ The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -276,6 +243,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + 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. @@ -283,8 +253,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 +Aliases: Required: False Position: Named @@ -294,13 +263,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -310,13 +281,35 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online + 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: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SdnApiTemplateUrl + +> Applicable: Skype for Business Online + +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 EnableSdnProviderForBroadcastMeeting is set to $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -326,6 +319,9 @@ Accept wildcard characters: False ``` ### -SdnApiToken + +> Applicable: Skype for Business Online + 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 EnableSdnProviderForBroadcastMeeting is set to $true. @@ -333,8 +329,7 @@ This parameter is only required if EnableSdnProviderForBroadcastMeeting is set t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -344,6 +339,9 @@ Accept wildcard characters: False ``` ### -SdnAzureSubscriptionId + +> Applicable: Skype for Business Online + Specifies your Microsoft Azure subscription id which is required by some providers to access the Software Defined Network (SDN) provider's services. The SdnAzureSubscriptionId parameter is not currently supported. @@ -351,8 +349,7 @@ The SdnAzureSubscriptionId parameter is not currently supported. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -362,6 +359,9 @@ Accept wildcard characters: False ``` ### -SdnFallbackAttendeeThresholdCountForBroadcastMeeting + +> Applicable: Skype for Business Online + Specifies the number of broadcast meeting attendees that are allowed to fallback from a Software Defined Network (SDN) connection to the standard content delivery network. If this number is exceeded, additional meeting attendees who are not able to use the SDN service will not be allowed to join the meeting. @@ -370,8 +370,7 @@ The SdnFallbackAttendeeThresholdCountForBroadcastMeeting parameter is not curren ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -381,6 +380,9 @@ Accept wildcard characters: False ``` ### -SdnLicenseId + +> Applicable: Skype for Business Online + Specifies the Software Defined Network (SDN) license identifier. This is required and provided by some SDN providers. This parameter is only required if EnableSdnProviderForBroadcastMeeting is set to $true. @@ -388,8 +390,26 @@ This parameter is only required if EnableSdnProviderForBroadcastMeeting is set t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SdnProviderName + +> Applicable: Skype for Business Online + +Specifies the Software Defined Network (SDN) provider's name. +This parameter is only required if EnableSdnProviderForBroadcastMeeting is set to $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -399,13 +419,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -415,6 +455,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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. @@ -422,7 +465,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 Required: False Position: Named @@ -436,13 +478,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None +### None ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsBusyOptions.md b/skype/skype-ps/SkypeForBusiness/Set-CsBusyOptions.md similarity index 87% rename from skype/skype-ps/skype/Set-CsBusyOptions.md rename to skype/skype-ps/SkypeForBusiness/Set-CsBusyOptions.md index 5743b4b153..2d06ba07e6 100644 --- a/skype/skype-ps/skype/Set-CsBusyOptions.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBusyOptions.md @@ -1,12 +1,12 @@ --- +author: hirenshah1 external help file: Microsoft.Rtc.Management.dll-help.xml -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsBusyOptions -schema: 2.0.0 +Locale: en-US manager: rogupta -author: hirenshah1 +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +schema: 2.0.0 +title: Set-CsBusyOptions --- # Set-CsBusyOptions @@ -40,14 +40,14 @@ For more information about how to enable Busy Options in your organization, see ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsBusyOptions -Identity "Ken Myer" -ActionType BusyOnBusy ``` This cmdlet configures busy options for the user "Ken Myer". In this configuration, any call to "Ken Myer" will return a busy signal when he is already in a call. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsBusyOptions -Identity "Chrystal Velasquez" -ActionType VoicemailOnBusy ``` @@ -57,6 +57,9 @@ This cmdlet configures busy options for the user "Chrystal Velasquez". In this c ## PARAMETERS ### -ActionType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + There are two Action Type options: * BusyOnBusy - In which new incoming calls will be rejected with a busy signal if the user is busy. @@ -66,9 +69,8 @@ There are two Action Type options: ```yaml Type: ActionType Parameter Sets: (All) -Aliases: +Aliases: Accepted values: BusyOnBusy, VoicemailOnBusy -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -77,23 +79,10 @@ 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 -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Identity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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". @@ -101,8 +90,7 @@ You can use the asterisk (\*) wildcard character when using the display name as ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 0 @@ -112,13 +100,33 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -128,6 +136,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -135,7 +146,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -149,19 +159,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Bob.Cmdlets.ActionType object. +### Microsoft.Rtc.Management.Bob.Cmdlets.ActionType + Microsoft.Rtc.Management.AD.UserIdParameter object. ## OUTPUTS -### -Microsoft.Rtc.Management.Bob.Cmdlets.ActionType object. +### Microsoft.Rtc.Management.Bob.Cmdlets.ActionType + Microsoft.Rtc.Management.AD.UserIdParameter object. ## NOTES ## RELATED LINKS -[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions?view=skype-ps) +[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbusyoptions?view=skype-ps) -[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) +[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkOrbit.md similarity index 86% rename from skype/skype-ps/skype/Set-CsCallParkOrbit.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCallParkOrbit.md index 1962bcc635..92a8cbe0a3 100644 --- a/skype/skype-ps/skype/Set-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCallParkOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscallparkorbit +schema: 2.0.0 +title: Set-CsCallParkOrbit --- # Set-CsCallParkOrbit @@ -41,7 +42,7 @@ The new range of numbers must be unique among all call park orbits defined withi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsCallParkOrbit -Identity "Redmond CPO 1" -NumberRangeStart 500 -NumberRangeEnd 699 ``` @@ -50,7 +51,7 @@ This example changes the range of numbers for the call park orbit named "Redmond All values within this range must be unique among all call park orbit ranges within the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsCallParkOrbit -Identity "Redmond CPO 2" -NumberRangeStart "*7000" -NumberRangeEnd "*7100" ``` @@ -63,15 +64,54 @@ If these values begin with a * or # (the only non-numeric values allowed) you mu ## PARAMETERS +### -CallParkService + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) or service ID of the Application service that hosts the Call Park application. +All calls parked to numbers within the range specified by the NumberRangeStart and NumberRangeEnd parameters will be routed to this server or pool. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: CallParkServerFqdn + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the call park orbit range to be modified. If the Identity includes spaces, this value must be included within double quotes. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -81,14 +121,16 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. This object must be of type DisplayCallParkOrbit, which can be retrieved by calling the `Get-CsCallParkOrbit` cmdlet. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,24 +139,39 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -CallParkService -The fully qualified domain name (FQDN) or service ID of the Application service that hosts the Call Park application. -All calls parked to numbers within the range specified by the NumberRangeStart and NumberRangeEnd parameters will be routed to this server or pool. +### -NumberRangeEnd + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The last number in the range for this call park orbit. +The value must be greater than or equal to the NumberRangeStart. +The value must also be the same length as the value of the NumberRangeStart. +For example, if NumberRangeStart is set to 100, NumberRangeEnd cannot be set to 1001. +In addition, if the NumberRangeStart begins with a * or #, then NumberRangeEnd must begin with the same character. + +Valid values: Must match the regular expression string (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). +This means that the value must be a string beginning with either the character * or # or a number 1 through 9 (the first character cannot be a zero). +If the first character is * or # the following character must be a number 1 through 9 (it cannot be a zero). +Subsequent characters can be any number 0 through 9 up to seven additional characters. +(For example, "#6000", "*92000", and "*95551212".) If the first character is not * or #, the first character must be a number 1 through 9 (it cannot be zero), followed by up to eight characters, each a number 0 through 9. +(For example, 915551212;41212;300.) ```yaml Type: String Parameter Sets: (All) -Aliases: CallParkServerFqdn -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 5 +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -NumberRangeStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The first number in the range for this call park orbit. The value must be less than or equal to the NumberRangeEnd. The value must also be the same length as the value of the NumberRangeEnd. @@ -130,8 +187,7 @@ If the first character is not * or #, the first character must be a number 1 thr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 3 @@ -140,57 +196,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberRangeEnd -The last number in the range for this call park orbit. -The value must be greater than or equal to the NumberRangeStart. -The value must also be the same length as the value of the NumberRangeStart. -For example, if NumberRangeStart is set to 100, NumberRangeEnd cannot be set to 1001. -In addition, if the NumberRangeStart begins with a * or #, then NumberRangeEnd must begin with the same character. +### -Type -Valid values: Must match the regular expression string (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). -This means that the value must be a string beginning with either the character * or # or a number 1 through 9 (the first character cannot be a zero). -If the first character is * or # the following character must be a number 1 through 9 (it cannot be a zero). -Subsequent characters can be any number 0 through 9 up to seven additional characters. -(For example, "#6000", "*92000", and "*95551212".) If the first character is not * or #, the first character must be a number 1 through 9 (it cannot be zero), followed by up to eight characters, each a number 0 through 9. -(For example, 915551212;41212;300.) +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the type of call park orbit. +Skype for Business Server allows for two different types of call park orbits: -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +CallPark. +This is the standard call park orbit, in which a user places a call on hold and then can retrieve that call from any phone by dialing the specified call park number. +CallPark is the default orbit type and will be used if the Type parameter is not specified. -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +GroupPickup. +With group pickup, users can answer any incoming call that is made to any member of their call pickup group. +Call pickup groups are configured by administrators. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +To specify a call park orbit type, use syntax similar to this: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Type GroupPickup` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +This parameter was introduced in the February 2013 release of Lync Server 2013. ```yaml -Type: SwitchParameter +Type: OrbitType Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,13 +230,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -215,29 +247,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Specifies the type of call park orbit. -Skype for Business Server allows for two different types of call park orbits: - -CallPark. -This is the standard call park orbit, in which a user places a call on hold and then can retrieve that call from any phone by dialing the specified call park number. -CallPark is the default orbit type and will be used if the Type parameter is not specified. - -GroupPickup. -With group pickup, users can answer any incoming call that is made to any member of their call pickup group. -Call pickup groups are configured by administrators. - -To specify a call park orbit type, use syntax similar to this: +### -WhatIf -`-Type GroupPickup` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter was introduced in the February 2013 release of Lync Server 2013. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: OrbitType +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -251,13 +270,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit object. +### Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit + Accepts pipelined input of call park orbit objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit This cmdlet modifies an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkServiceMusicOnHoldFile.md similarity index 87% rename from skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCallParkServiceMusicOnHoldFile.md index 81af567605..aeee45c974 100644 --- a/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkServiceMusicOnHoldFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscallparkservicemusiconholdfile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCallParkServiceMusicOnHoldFile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscallparkservicemusiconholdfile +schema: 2.0.0 +title: Set-CsCallParkServiceMusicOnHoldFile --- # Set-CsCallParkServiceMusicOnHoldFile @@ -43,7 +44,7 @@ Audio files must be in the following format: Windows Media Audio 9, 44 kHz, 16 b ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $a = [System.IO.File]::ReadAllBytes('C:\MoHFiles\soothingmusic.wma') @@ -61,23 +62,10 @@ We then pass the audio file contents that we read into variable $a to the Conten ## PARAMETERS -### -Service -The ID of the service where the Call Park service resides; for example, ApplicationServer:pool0.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 +### -Content -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Content The contents of the audio file in byte format. 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`). @@ -85,8 +73,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -96,13 +83,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +Aliases: Required: False Position: Named @@ -111,30 +100,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Service + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The ID of the service where the Call Park service resides; for example, ApplicationServer:pool0.litwareinc.com. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -148,13 +159,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Byte\[\]. +### Sysetm.Byte[] Accepts pipelined input of a byte array containing the music on hold file. ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsCallViaWorkPolicy.md similarity index 85% rename from skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCallViaWorkPolicy.md index 5177db6710..fd232eb918 100644 --- a/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCallViaWorkPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCallViaWorkPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscallviaworkpolicy +schema: 2.0.0 +title: Set-CsCallViaWorkPolicy --- # Set-CsCallViaWorkPolicy @@ -35,7 +36,7 @@ Use this cmdlet to modify an existing call via work policy that enables and mana ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsCallViaWorkPolicy -Identity Site:Redmond -Enabled $true -AdminCallbackNumber +14258881234 -UseAdminCallbackNumber $true ``` @@ -46,6 +47,9 @@ This example enables the existing call via work policy of the Redmond site and e ## PARAMETERS ### -AdminCallbackNumber + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the number that will be called during the call back to the Skype for Business user before placing the external call. Typically this is the user's desk phone. If you want the user be able to change the callback number, use the UseAdminCallbackNumber switch. @@ -55,8 +59,7 @@ For instance, "12068881234" or "+12068881234". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -65,31 +68,17 @@ 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 Server 2015, Skype for Business Server 2019 +### -Enabled -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Enabled If true ($True) the policy is enabled. The default at policy creation is false ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,13 +88,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +106,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the unique identifier assigned to the policy when it was created. Call via work policies can be assigned at the global, site, or per-user scope. @@ -127,8 +121,7 @@ Per-user syntax: `-Identity CallviaWorkStandard` ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -138,13 +131,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,13 +149,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,6 +167,9 @@ Accept wildcard characters: False ``` ### -UseAdminCallbackNumber + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If true ($True), the number specified in the AdminCallbackNumber is the only number that will be used for the callback to the user, or first leg, of the outbound call. If false ($False), the user has the opportunity to change the callback number through the client. The user might choose to change the call back number to a conference room or home number. @@ -177,8 +177,25 @@ The user might choose to change the call back number to a conference room or hom ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -188,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -208,15 +227,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Input Types - -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceConfigurationReplicationStatus.md similarity index 87% rename from skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceConfigurationReplicationStatus.md index 4d556a212d..2fbea76b09 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceConfigurationReplicationStatus.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-cscceapplianceconfigurationreplicationstatus applicable: Skype for Business Online -title: Set-CsCceApplianceConfigurationReplicationStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscceapplianceconfigurationreplicationstatus +schema: 2.0.0 +title: Set-CsCceApplianceConfigurationReplicationStatus --- # Set-CsCceApplianceConfigurationReplicationStatus @@ -36,7 +38,7 @@ Set-CsCceApplianceConfigurationReplicationStatus [-Identity] {{ Add example code here }} ``` @@ -45,30 +47,16 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Force {{Fill Force Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -78,13 +66,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + {{Fill Identity Description}} ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -94,13 +84,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online + {{Fill Instance Description}} ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -110,13 +102,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -126,6 +138,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -133,7 +148,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceDeploymentStatus.md similarity index 86% rename from skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceDeploymentStatus.md index 1ca389b8ab..ecf067d864 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceDeploymentStatus.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-cscceappliancedeploymentstatus applicable: Skype for Business Online -title: Set-CsCceApplianceDeploymentStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscceappliancedeploymentstatus +schema: 2.0.0 +title: Set-CsCceApplianceDeploymentStatus --- # Set-CsCceApplianceDeploymentStatus @@ -40,7 +42,7 @@ Provide the detailed description here. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Insert example commands for example 1. ``` @@ -51,13 +53,15 @@ Insert descriptive text for example 1. ## PARAMETERS ### -Action + +> Applicable: Skype for Business Online + PARAMVALUE: Deploy | BitsUpdate | OsUpdate | Remove ```yaml Type: HybridPstnApplianceAction Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -66,30 +70,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -PARAMVALUE: XdsGlobalRelativeIdentity - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +### -Error -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Status -PARAMVALUE: Started | Finished | Error +PARAMVALUE: String ```yaml -Type: HybridPstnApplianceActionStatus +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -98,14 +88,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Force + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -114,30 +106,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Error -PARAMVALUE: String +### -Identity + +> Applicable: Skype for Business Online + +PARAMVALUE: XdsGlobalRelativeIdentity ```yaml -Type: String +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Instance + +> Applicable: Skype for Business Online + +PARAMVALUE: PSObject ```yaml -Type: SwitchParameter +Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -146,14 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: PSObject +### -Status + +> Applicable: Skype for Business Online + +PARAMVALUE: Started | Finished | Error ```yaml -Type: PSObject +Type: HybridPstnApplianceActionStatus Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -163,13 +161,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -179,13 +179,33 @@ Accept wildcard characters: False ``` ### -Version + +> Applicable: Skype for Business Online + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -195,13 +215,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsCceApplianceStatus.md b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceStatus.md similarity index 86% rename from skype/skype-ps/skype/Set-CsCceApplianceStatus.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceStatus.md index 634a66015e..5995fd5dc9 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceStatus.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-cscceappliancestatus applicable: Skype for Business Online -title: Set-CsCceApplianceStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscceappliancestatus +schema: 2.0.0 +title: Set-CsCceApplianceStatus --- # Set-CsCceApplianceStatus @@ -38,7 +40,7 @@ Provide the detailed description here. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Insert example commands for example 1. ``` @@ -48,30 +50,34 @@ Insert descriptive text for example 1. ## PARAMETERS -### -Identity -PARAMVALUE: XdsGlobalRelativeIdentity +### -Error + +> Applicable: Skype for Business Online + +PARAMVALUE: String ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Status -PARAMVALUE: None | Running | Maintenance | Error +### -Force + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: HybridPstnApplianceRunningStatus +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -80,30 +86,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Identity + +> Applicable: Skype for Business Online + +PARAMVALUE: XdsGlobalRelativeIdentity ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Error -PARAMVALUE: String +### -Instance + +> Applicable: Skype for Business Online + +PARAMVALUE: PSObject ```yaml -Type: String +Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -112,14 +122,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Status + +> Applicable: Skype for Business Online + +PARAMVALUE: None | Running | Maintenance | Error ```yaml -Type: SwitchParameter +Type: HybridPstnApplianceRunningStatus Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -128,14 +140,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: PSObject +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml -Type: PSObject +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -144,14 +158,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Version + +> Applicable: Skype for Business Online + +{{Fill Version Description}} ```yaml -Type: Guid +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -160,14 +176,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -Confirm + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -176,14 +194,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Version -{{Fill Version Description}} +### -WhatIf + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsCdrConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsCdrConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCdrConfiguration.md index adac626963..10f1757784 100644 --- a/skype/skype-ps/skype/Set-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCdrConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCdrConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscdrconfiguration +schema: 2.0.0 +title: Set-CsCdrConfiguration --- # Set-CsCdrConfiguration @@ -24,7 +25,7 @@ This cmdlet was introduced in Lync Server 2010. ### Identity ``` Set-CsCdrConfiguration [[-Identity] ] [-EnableCDR ] [-EnablePurging ] - [-KeepCallDetailForDays ] [-KeepErrorReportForDays ] [-PurgeHourOfDay ] + [-KeepCallDetailForDays ] [-KeepErrorReportForDays ] [-PurgeHourOfDay ] [-EnableUdcLite ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -52,7 +53,7 @@ Changes such as these can be made by using the `Set-CsCdrConfiguration` cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsCdrConfiguration -Identity site:Redmond -PurgeHourOfDay 23 ``` @@ -62,7 +63,7 @@ In this case the time is set to 23 (11:00 P.M. on a 24-hour clock). The Identity parameter is used to ensure that these changes are only made to the CDR settings that have the Identity site:Redmond. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCdrConfiguration | Set-CsCdrConfiguration -PurgeHourOfDay 23 ``` @@ -73,7 +74,7 @@ To do this, the command first calls the `Get-CsCdrConfiguration` cmdlet without This collection is then piped to the `Set-CsCdrConfiguration` cmdlet, which takes each item in the collection and changes the value of the PurgeHourOfDay property to 11:00 PM (23). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCdrConfiguration -Filter "site:*"| Set-CsCdrConfiguration -PurgeHourOfDay 23 ``` @@ -86,53 +87,52 @@ The filtered collection is then piped to the `Set-CsCdrConfiguration` cmdlet, wh ## PARAMETERS -### -Identity -Unique identifier assigned to the collection of CDR configuration settings. -To refer to the global settings, use this syntax: `-Identity global`. -To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. -Note that you cannot use wildcard characters when specifying an Identity. +### -EnableCDR -If this parameter is omitted then the `Set-CsCdrConfiguration` cmdlet will modify the global settings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether or not CDR is enabled. +The default value is True. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not CDR records will periodically be deleted from the CDR database. +If True (the default value), records will be deleted after the time period specified by the properties KeepCallDetailForDays (for CDR records) and KeepErrorReportForDays (for CDR errors). +If False, CDR records will be maintained indefinitely. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableCDR -Indicates whether or not CDR is enabled. -The default value is True. +### -EnableUdcLite +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,16 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePurging -Indicates whether or not CDR records will periodically be deleted from the CDR database. -If True (the default value), records will be deleted after the time period specified by the properties KeepCallDetailForDays (for CDR records) and KeepErrorReportForDays (for CDR errors). -If False, CDR records will be maintained indefinitely. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,7 +159,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier assigned to the collection of CDR configuration settings. +To refer to the global settings, use this syntax: `-Identity global`. +To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. +Note that you cannot use wildcard characters when specifying an Identity. + +If this parameter is omitted then the `Set-CsCdrConfiguration` cmdlet will modify the global settings. + + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -KeepCallDetailForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of days that CDR records will be kept in the CDR database; any records older than the specified number of days will automatically be deleted. (Note that purging will take only place if the EnablePurging property has been set to true.) @@ -169,8 +214,7 @@ The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +224,9 @@ Accept wildcard characters: False ``` ### -KeepErrorReportForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of days that CDR error reports are kept; any reports older than the specified number of days will automatically be deleted. CDR error reports are diagnostic reports uploaded by client applications such as Skype for Business. @@ -190,8 +237,7 @@ The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +247,9 @@ Accept wildcard characters: False ``` ### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the local time of day when expired records are deleted from the CDR database. The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 A.M.) and 23 representing 11:00 P.M. Note that you can only specify the hour of the day; that means that you can schedule purging to take place at 4:00 A.M., but you cannot schedule it to take place at 4:30 A.M. @@ -213,8 +262,7 @@ Database purging takes place only if the EnablePurging property is set to True. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -223,29 +271,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableUdcLite -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -255,29 +290,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -291,13 +312,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings. +### Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings The `Set-CsCdrConfiguration` cmdlet accepts pipelined input of call detail recording configuration objects. ## OUTPUTS -### +### None The `Set-CsCdrConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CDRSettings object. diff --git a/skype/skype-ps/skype/Set-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Set-CsCertificate.md similarity index 78% rename from skype/skype-ps/skype/Set-CsCertificate.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCertificate.md index a88a78863d..d608c0124d 100644 --- a/skype/skype-ps/skype/Set-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscertificate +schema: 2.0.0 +title: Set-CsCertificate --- # Set-CsCertificate @@ -50,7 +51,7 @@ To identify certificates available for assignment, use the `Get-CsCertificate` c ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsCertificate -Type WebServicesExternal -Thumbprint "B142918E463981A76503828BB1278391B716280987B" ``` @@ -58,7 +59,7 @@ Set-CsCertificate -Type WebServicesExternal -Thumbprint "B142918E463981A76503828 The command shown in Example 1 assigns the certificate with the Thumbprint B142918E463981A76503828BB1278391B716280987B to the WebServicesExternal role on the local computer. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsCertificate -Type Default, WebServicesInternal, WebServicesExternal -Thumbprint "B142918E463981A76503828BB1278391B716280987B" ``` @@ -68,15 +69,19 @@ Example 2 assigns the assigns the certificate with the Thumbprint B142918E463981 ## PARAMETERS -### -NetportId -Reserved for future use. -This parameter is for certificates dedicated to a specific port, a scenario not yet supported by Lync Server. +### -EffectiveDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Date and time when the certificate can first be used. +For example, to configure a certificate for first use at 8:00 AM on July 31, 2012 use this syntax on a server running under the US English Region and Language settings: + +`-EffectiveDate "7/31/2012 8:00 AM"` ```yaml -Type: String -Parameter Sets: CertificateReference, Thumbprint -Aliases: -Applicable: Lync Server 2010 +Type: DateTime +Parameter Sets: (All) +Aliases: EffectiveTime Required: False Position: Named @@ -85,87 +90,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Reference -Object reference to a certificate configured for use with Skype for Business Server. -The following command returns an object reference (the variable $x) representing a certificate with the thumbprint B142918E463981A76503828BB1278391B716280987B: +### -Force -`$x = Get-CsCertificate | Where-Object {$_.Thumbprint -eq "B142918E463981A76503828BB1278391B716280987B"`. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: CertificateReference -Parameter Sets: CertificateReference -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Thumbprint -Unique identifier for the certificate. -A certificate thumbprint looks similar to this: B142918E463981A76503828BB1278391B716280987B. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to Global, enables the certificate to function at the global scope. +Global certificates will automatically be copied and distributed to the appropriate computers. ```yaml -Type: String -Parameter Sets: Thumbprint -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: CertificateReference, Thumbprint, XdsIdentity +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Type of certificate being assigned. -Certificate types include, but are not limited to, the following: - -AccessEdgeExternal - -AudioVideoAuthentication - -DataEdgeExternal - -Default - -External - -Internal - -iPhoneAPNService - -iPadAPNService - -MPNService - -PICWebService (Skype for Business Online only) - -ProvisionService (Skype for Business Online only) +### -NetportId -WebServicesExternal +> Applicable: Lync Server 2010 -WebServicesInternal +Reserved for future use. +This parameter is for certificates dedicated to a specific port, a scenario not yet supported by Lync Server. -WsFedTokenTransfer +```yaml +Type: String +Parameter Sets: CertificateReference, Thumbprint +Aliases: -For example, this syntax assigns the Default certificate: `-Type Default`. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -You can specify multiple types in a single command by separating the certificate types with commas: +### -Password -`-Type Internal,External,Default` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Password for the certificate. ```yaml -Type: CertType[] -Parameter Sets: CertificateReference, Thumbprint -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Path +Aliases: Required: False Position: Named @@ -174,11 +164,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Path + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the .PFX certificate file. + ```yaml -Type: CertType[] +Type: String Parameter Sets: Path -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -187,23 +182,32 @@ 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. +### -Reference + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference to a certificate configured for use with Skype for Business Server. +The following command returns an object reference (the variable $x) representing a certificate with the thumbprint B142918E463981A76503828BB1278391B716280987B: + +`$x = Get-CsCertificate | Where-Object {$_.Thumbprint -eq "B142918E463981A76503828BB1278391B716280987B"`. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: CertificateReference +Parameter Sets: CertificateReference +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to record detailed information about the procedures carried out by the `Set-CsCertificate` cmdlet. The parameter value should be the full path to the HTML file to be generated; for example: `-Report C:\Logs\Certificates.html`. If the specified file already exists it will automatically be overwritten with the new information. @@ -212,8 +216,7 @@ If the specified file already exists it will automatically be overwritten with t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,30 +225,17 @@ 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 +### -Roll -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Enables you to update the specified certificate at the date and time specified by the EffectiveDate parameter; this enables you to specify a date and time when the new certificate will become the primary certificate. +Note that your command will fail if you specify the Roll parameter without including the EffectiveDate parameter. ```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 +Aliases: Required: False Position: Named @@ -254,28 +244,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -When set to Global, enables the certificate to function at the global scope. -Global certificates will automatically be copied and distributed to the appropriate computers. +### -Thumbprint -```yaml -Type: XdsIdentity -Parameter Sets: CertificateReference, Thumbprint -Aliases: -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Unique identifier for the certificate. +A certificate thumbprint looks similar to this: B142918E463981A76503828BB1278391B716280987B. ```yaml -Type: XdsIdentity -Parameter Sets: Path -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Thumbprint +Aliases: Required: True Position: Named @@ -284,33 +263,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Path -Full path to the .PFX certificate file. +### -Type -```yaml -Type: String -Parameter Sets: Path -Aliases: -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 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -EffectiveDate -Date and time when the certificate can first be used. -For example, to configure a certificate for first use at 8:00 AM on July 31, 2012 use this syntax on a server running under the US English Region and Language settings: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of certificate being assigned. +Certificate types include, but are not limited to, the following: + +AccessEdgeExternal + +AudioVideoAuthentication + +DataEdgeExternal + +Default + +External + +Internal + +iPhoneAPNService + +iPadAPNService + +MPNService + +PICWebService (Skype for Business Online only) + +ProvisionService (Skype for Business Online only) + +WebServicesExternal + +WebServicesInternal + +WsFedTokenTransfer + +For example, this syntax assigns the Default certificate: `-Type Default`. + +You can specify multiple types in a single command by separating the certificate types with commas: + +`-Type Internal,External,Default` -`-EffectiveDate "7/31/2012 8:00 AM"` ```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: EffectiveTime -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: CertType[] +Parameter Sets: CertificateReference, Thumbprint, Path +Aliases: Required: False Position: Named @@ -319,14 +320,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Password -Password for the certificate. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: Path -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -335,15 +338,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Roll -Enables you to update the specified certificate at the date and time specified by the EffectiveDate parameter; this enables you to specify a date and time when the new certificate will become the primary certificate. -Note that your command will fail if you specify the Roll parameter without including the EffectiveDate parameter. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -357,12 +361,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Deployment.CertificateReference. +### Microsoft.Rtc.Management.Deployment.CertificateReference ## OUTPUTS -### +### None The `Set-CsCertificate` cmdlet does not return any values or objects. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsClientPin.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientPin.md similarity index 89% rename from skype/skype-ps/skype/Set-CsClientPin.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClientPin.md index 186c380a81..dcff555d58 100644 --- a/skype/skype-ps/skype/Set-CsClientPin.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientPin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientpin applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClientPin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclientpin +schema: 2.0.0 +title: Set-CsClientPin --- # Set-CsClientPin @@ -52,7 +53,7 @@ That means that you will not be able to run the `Set-CsClientPin` cmdlet from a ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsClientPin -Identity "litwareinc\kenmyer" ``` @@ -62,7 +63,7 @@ To assign an auto-generated PIN, leave off the Pin parameter when calling the `S After the command completes, the new PIN assigned to Ken Myer will be displayed on the screen and that information can then be relayed to the user. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsClientPin -Identity "litwareinc\kenmyer" -Pin 18723834 ``` @@ -71,7 +72,7 @@ The command in Example 2 assigns the PIN 18723834 to the user litwareinc\kenmyer You can assign a specific PIN by using the Pin parameter followed by the number to be assigned. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsUser -OU "OU=Finance,DC=litwareinc,DC=com" | Set-CsClientPin ``` @@ -81,7 +82,7 @@ To do this, the `Get-CsUser` cmdlet is used along with the OU parameter to retur That collection is then piped to the `Set-CsClientPin` cmdlet, which generates a new PIN for each user in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsUser | Get-CsClientPinInfo | Where-Object {$_.IsPinSet -eq $False} | Set-CsClientPin ``` @@ -94,7 +95,28 @@ The resulting collection, which contains only users who do not have a PIN, is th ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the user account for which the PIN should be set. 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. @@ -105,8 +127,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -116,6 +137,9 @@ Accept wildcard characters: False ``` ### -Pin + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Optional PIN to be assigned to the user. If you do not include the PIN parameter, then Skype for Business Server will randomly generate a PIN and assign it to the user in question. Note that the PIN must adhere to the minimum length and common pattern settings found in the client PIN policy assigned to the user. @@ -124,8 +148,7 @@ Note that the PIN must adhere to the minimum length and common pattern settings ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -134,14 +157,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -151,29 +176,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -187,14 +198,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The `Set-CsClientPin` cmdlet accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### None The `Set-CsClientPin` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.UserPinService.PinInfoDetails object. diff --git a/skype/skype-ps/skype/Set-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientPolicy.md similarity index 82% rename from skype/skype-ps/skype/Set-CsClientPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClientPolicy.md index 6af1ef3225..64518f3cfa 100644 --- a/skype/skype-ps/skype/Set-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Set-CsClientPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclientpolicy +schema: 2.0.0 +title: Set-CsClientPolicy --- # Set-CsClientPolicy @@ -124,7 +126,7 @@ The following parameters are not applicable to Skype for Business Online: Addres ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClientPolicy -Identity RedmondClientPolicy -WebServicePollInterval "00:15:00" ``` @@ -133,7 +135,7 @@ The command shown in Example 1 modifies the client policy RedmondClientPolicy. In this example, the WebServicePollInterval property is set to 15 minutes (00 hours: 15 minutes: 00 seconds). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsClientPolicy -Identity RedmondClientPolicy -DisableEmoticons $True -DisableHtmlIm $True -DisableRTFIm $True ``` @@ -141,7 +143,7 @@ Set-CsClientPolicy -Identity RedmondClientPolicy -DisableEmoticons $True -Disabl In Example 2, three different property values are modified for the client policy RedmondClientPolicy: the properties DisableEmoticons, DisableHtmlIm, and DisableRTFIm are all set to True. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientPolicy -Filter "*site:*" | Set-CsClientPolicy -DisableEmoticons $True -DisableHtmlIm $True -DisableRTFIm $True ``` @@ -152,7 +154,7 @@ To do this, the command first uses the `Get-CsClientPolicy` cmdlet and the Filte This filtered collection is then piped to the `Set-CsClientPolicy` cmdlet, which takes each policy in the collection and modifies the values of DisableEmoticons, DisableHtmlIm and DisableRTFIm. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClientPolicy | Where-Object {$_.MaxPhotoSizeKb -gt 10} | Set-CsClientPolicy -MaxPhotoSizeKb 10 ``` @@ -165,43 +167,10 @@ The filtered collection is then piped to the `Set-CsClientPolicy` cmdlet, which ## PARAMETERS -### -Identity -Unique identifier assigned to the new policy. -To reference the global policy, use this syntax: `-Identity global`. -To reference a site policy, use the prefix "site:" and the name of the site as your Identity; for example: `-Identity site:Redmond`. -To reference a per-user policy, use syntax similar to this: `-Identity SalesClientPolicy`. - -```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 +### -AddressBookAvailability -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AddressBookAvailability Indicates how users are allowed to access information in the Address Book server (that is, by using the Address Book Web Query service and/or by downloading a copy of the Address Book to their local computer). AddressBookAvailability must be set to one of the following values: @@ -215,8 +184,7 @@ FileDownloadOnly ```yaml Type: AddressBookAvailability Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -226,6 +194,9 @@ Accept wildcard characters: False ``` ### -AttendantSafeTransfer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business Attendant operates in "safe transfer" mode; this means that transferred calls that do not reach the intended recipient will reappear in the incoming area along with a "Failed Transfer" notice. When set to False, transferred calls that fail to reach the intended recipient will not reappear in the incoming area. @@ -233,8 +204,7 @@ When set to False, transferred calls that fail to reach the intended recipient w ```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 +Aliases: Required: False Position: Named @@ -245,6 +215,8 @@ Accept wildcard characters: False ### -AutoDiscoveryRetryInterval +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + After a failed connection attempt, specifies the amount of time Skype for Business waits before again trying to connect to Skype for Business Server. The AutoDiscoveryRetryInterval can be set to value between 1 second and 60 minutes (1 hour), inclusive. @@ -257,8 +229,7 @@ For example, to set the interval to 25 minutes use this syntax: ```yaml Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -268,6 +239,9 @@ Accept wildcard characters: False ``` ### -BlockConversationFromFederatedContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, contacts from outside your organization will not be allowed to initiate instant message conversations with any user that this policy applies to. However, outside users will be able to participate in conversations as long the internal user initiates that conversation. When set to False, outside contacts are allowed to send unsolicited instant messages to users in your organization. @@ -276,8 +250,7 @@ When set to False, outside contacts are allowed to send unsolicited instant mess ```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 +Aliases: Required: False Position: Named @@ -287,6 +260,9 @@ Accept wildcard characters: False ``` ### -CalendarStatePublicationInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time, in seconds, that Skype for Business waits before retrieving calendar information from Outlook and adding this data to your presence information. For example, to set the CalendarStatePublicationInterval to 10 minutes (600 seconds) use this syntax: @@ -297,8 +273,7 @@ For example, to set the CalendarStatePublicationInterval to 10 minutes (600 seco ```yaml Type: UInt32 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 +Aliases: Required: False Position: Named @@ -308,6 +283,9 @@ Accept wildcard characters: False ``` ### -ConferenceIMIdleTimeout + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of minutes that a user can remain in an instant messaging session without either sending or receiving an instant message. The ConferenceIMIdleTimeout must be less than or equal to 1 hour and must be specified using the format hours:minutes:seconds. @@ -319,8 +297,7 @@ For example, this syntax sets the timeout value to 45 minutes: ```yaml Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -330,6 +307,9 @@ Accept wildcard characters: False ``` ### -CustomizedHelpUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + URL for custom Skype for Business help set up by an organization. This parameter has been deprecated for use with Skype for Business Server. @@ -339,8 +319,7 @@ Customized help will not be available unless you also set EnableEnterpriseCustom ```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 +Aliases: Required: False Position: Named @@ -350,6 +329,9 @@ Accept wildcard characters: False ``` ### -CustomLinkInErrorMessages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the website that can be added to error messages that appear in Skype for Business. If a URL is specified, that URL will appear at the bottom of any error message that occurs in Skype for Business. Users can then click that link and be taken to a custom website that contains additional information, troubleshooting tips, etc. @@ -358,8 +340,7 @@ Users can then click that link and be taken to a custom website that contains ad ```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 +Aliases: Required: False Position: Named @@ -369,6 +350,9 @@ Accept wildcard characters: False ``` ### -CustomStateUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the location of the XML file used to add custom presence states to Skype for Business. (Skype for Business allows up to four custom presence states in addition to the built-in states such as Available, Busy and Do Not Disturb.) The location of the XML file should be specified using the HTTPS protocol. @@ -376,8 +360,7 @@ Specifies the location of the XML file used to add custom presence states to Sky ```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 +Aliases: Required: False Position: Named @@ -387,6 +370,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Allows administrators to provide additional information about a policy. For example, the Description might indicate the users that the policy should be assigned to. @@ -394,8 +380,7 @@ For example, the Description might indicate the users that the policy should be ```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 +Aliases: Required: False Position: Named @@ -405,6 +390,9 @@ Accept wildcard characters: False ``` ### -DGRefreshInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the amount of time Skype for Business waits before automatically refreshing the membership list of any distribution group that has been "expanded" in the Contacts list. (Expanding a distribution group means displaying all the members in that group.) DGRefreshInterval can be set to any integer value between 30 seconds and 28,800 seconds (8 hours), inclusive. The default value is 28,800 seconds. @@ -413,8 +401,7 @@ The default value is 28,800 seconds. ```yaml Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -424,6 +411,9 @@ Accept wildcard characters: False ``` ### -DisableCalendarPresence + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, calendar data taken from Outlook will not be included in your presence information. When set to False, calendar data will be included in your presence information. For example, free/busy information will be reported in your contact card; likewise, your status will automatically be set to Busy any time Outlook shows that you are in a meeting. @@ -432,8 +422,7 @@ For example, free/busy information will be reported in your contact card; likewi ```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 +Aliases: Required: False Position: Named @@ -443,6 +432,9 @@ Accept wildcard characters: False ``` ### -DisableContactCardOrganizationTab + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the contact card organization tab is not visible within the Skype for Business user interface. When set to False, the contact card organization tab is available in Skype for Business. @@ -450,8 +442,7 @@ When set to False, the contact card organization tab is available in Skype for B ```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 +Aliases: Required: False Position: Named @@ -461,6 +452,9 @@ Accept wildcard characters: False ``` ### -DisableEmailComparisonCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not attempt to verify that any currently running instance of Outlook belongs to the same user running Skype for Business; for example, the software will not verify that both Outlook and Skype for Business are running under Ken Myer's user account. Instead, it will be assumed that the two applications are running under the same account and, in turn, will include contact and calendar data in Outlook with Skype for Business. @@ -471,8 +465,7 @@ If the SMTP addresses do not match then contact and calendar data in Outlook wil ```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 +Aliases: Required: False Position: Named @@ -482,6 +475,9 @@ Accept wildcard characters: False ``` ### -DisableEmoticons + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be able to send or receive emoticons in their instant messages; instead they will be see the text equivalent of those emoticons. For example, instead of seeing a graphical "smiley face" users will see the text equivalent: @@ -493,8 +489,7 @@ When set to False users will be able to include emoticons in their instant messa ```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 +Aliases: Required: False Position: Named @@ -504,6 +499,9 @@ Accept wildcard characters: False ``` ### -DisableFederatedPromptDisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any notification dialog generated when you are added to a federated user's Contacts list will use the federated user's SIP address (for example, sip:kenmyer@fabrikam.com). When set to False, the notification dialog will use the federated user's display name (for example, Ken Myer) instead. @@ -511,8 +509,7 @@ When set to False, the notification dialog will use the federated user's display ```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 +Aliases: Required: False Position: Named @@ -522,6 +519,9 @@ Accept wildcard characters: False ``` ### -DisableFeedsTab + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the activity feeds tab will not be displayed in Skype for Business. When set to False, the feeds tab will be available within Skype for Business. @@ -529,8 +529,7 @@ When set to False, the feeds tab will be available within Skype for Business. ```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 +Aliases: Required: False Position: Named @@ -540,6 +539,9 @@ Accept wildcard characters: False ``` ### -DisableFreeBusyInfo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, free/busy information retrieved from Microsoft Outlook will not be displayed in your contact card. When set to False, free/busy information is displayed in your contact card. For example, your contact card might include a note similar to this: @@ -550,8 +552,7 @@ Calendar: Free until 2:00 PM ```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 +Aliases: Required: False Position: Named @@ -561,6 +562,9 @@ Accept wildcard characters: False ``` ### -DisableHandsetOnLockedMachine + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be able to use their Polycom handset if the computer that the handset is connected to is locked. To use the handset, users will first have to unlock the computer. @@ -570,8 +574,7 @@ When set to False, users will be allowed to use their handset even if the comput ```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 +Aliases: Required: False Position: Named @@ -581,6 +584,9 @@ Accept wildcard characters: False ``` ### -DisableHtmlIm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any HTML text copied from a webpage will be converted to plain text when pasted into an instant message. When set to False, HTML formatting (such as font size and color, drop-down lists and buttons, etc.) will be retained when pasted into an instant message. @@ -593,8 +599,7 @@ This setting is equivalent to the Office Communications Server 2007 R2 Group Pol ```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 +Aliases: Required: False Position: Named @@ -604,6 +609,9 @@ Accept wildcard characters: False ``` ### -DisableICE + +> Applicable: Lync Server 2010 + When set to True, Lync 2010 will not use the Interactive Connectivity Establishment (ICE) protocol to traverse firewalls and network address translation (NAT) devices; this effectively prevents users from making Lync 2010 calls across the Internet. When set to False, Lync 2010 will use the ICE protocol to enable Lync 2010 calls to traverse firewalls and (NAT) devices. @@ -612,8 +620,7 @@ This setting is equivalent to the Office Communications Server 2007 R2 Group Pol ```yaml Type: Boolean Parameter Sets: Identity, Instance -Aliases: -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -623,6 +630,9 @@ Accept wildcard characters: False ``` ### -DisableInkIM + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be allowed to receive instant messages containing Tablet PC ink. (Ink is a technology that enables you to insert handwritten notes into a document.) When set to False, users will be allowed to receive messages that contain Table PC ink. @@ -630,8 +640,28 @@ When set to True, users will not be allowed to receive instant messages containi ```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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableMeetingSubjectAndLocation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, detailed information about a meeting -- namely, the meeting subject and the location where the meeting is being held -- will be displayed as a tooltip when you view free/busy information in a contact card. +When set to True, this detailed information will not be displayed. +To completely prevent the display of meeting-related information you should also set DisableCalendarPresence to True. + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -641,6 +671,9 @@ Accept wildcard characters: False ``` ### -DisableOneNote12Integration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the ability to start OneNote from within Skype for Business (and the ability to automatically link instant message sessions and OneNote notes) is disabled. When set to False, the option Take Notes Using One Note is enabled in Skype for Business. In addition, if you locate an instant message transcript in Microsoft Outlook's Conversation History you can retrieve any OneNote notes associated with that conversation just by clicking the Edit conversation notes button. @@ -649,8 +682,7 @@ In addition, if you locate an instant message transcript in Microsoft Outlook's ```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 +Aliases: Required: False Position: Named @@ -660,6 +692,9 @@ Accept wildcard characters: False ``` ### -DisableOnlineContextualSearch + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, disables the Find Previous Conversations menu option that appears when you right-click a user in your Contacts list. (This option enables you to search the Outlook Conversation History folder for previous instant messaging sessions involving the user in question.) When set to False, the Find Previous Conversations option will be available when you right-click a user in your Contacts list. @@ -672,8 +707,7 @@ Cached searches are not affected by this setting. ```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 +Aliases: Required: False Position: Named @@ -683,6 +717,9 @@ Accept wildcard characters: False ``` ### -DisablePhonePresence + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business does not take phone calls into consideration when determining your current status. When set to False, phone calls are taken into consideration when determining your status. For example, any time you are on the phone your status will automatically be set to Busy. @@ -691,8 +728,7 @@ For example, any time you are on the phone your status will automatically be set ```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 +Aliases: Required: False Position: Named @@ -702,6 +738,9 @@ Accept wildcard characters: False ``` ### -DisablePICPromptDisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any notification dialog box generated when you are added to the Contacts list of a user with an account on a public instant messaging service such as MSN will display that person's SIP address (for example, sip:kenmyer@litwareinc.com). When set to False, the notification dialog box will use the person's display name (for example, Ken Myer) instead. @@ -709,8 +748,7 @@ When set to False, the notification dialog box will use the person's display nam ```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 +Aliases: Required: False Position: Named @@ -720,6 +758,9 @@ Accept wildcard characters: False ``` ### -DisablePoorDeviceWarnings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not issue warnings (upon startup, in the Tuning Wizard, in the Conversation window, etc.) if an audio or video device is not working correctly. When set to False, these warnings will be issued. @@ -727,8 +768,7 @@ When set to False, these warnings will be issued. ```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 +Aliases: Required: False Position: Named @@ -738,14 +778,16 @@ Accept wildcard characters: False ``` ### -DisablePoorNetworkWarnings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not display warnings about poor network quality. ```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 +Aliases: Required: False Position: Named @@ -755,6 +797,9 @@ Accept wildcard characters: False ``` ### -DisablePresenceNote + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any Out of Office message you configure in Outlook will not be displayed as part of your presence information. When set to False, your Out of Office message will be displayed any time a user holds the mouse over your name in their Contacts list. @@ -762,8 +807,7 @@ When set to False, your Out of Office message will be displayed any time a user ```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 +Aliases: Required: False Position: Named @@ -773,6 +817,9 @@ Accept wildcard characters: False ``` ### -DisableRTFIM + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When both this setting and the DisableHtmlIm settings are set to True, prevents rich text formatting (for example, different fonts, font sizes and font colors) from being used in instant messages; instead, all messages sent and received will be converted to plain text format. When set to False, rich text formatting will be allowed in instant messages. @@ -780,8 +827,7 @@ When set to False, rich text formatting will be allowed in instant messages. ```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 +Aliases: Required: False Position: Named @@ -791,6 +837,9 @@ Accept wildcard characters: False ``` ### -DisableSavingIM + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the options for saving an instant message session are removed from the menu bar in the Skype for Business Conversation window. When set to False, these options are available in the Conversation window. @@ -801,8 +850,7 @@ However, it does not prevent users from copying all the text in a transcript to ```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 +Aliases: Required: False Position: Named @@ -812,6 +860,9 @@ Accept wildcard characters: False ``` ### -DisplayPhoto + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether or not photos (of both the user and his or her contacts) will be displayed in Skype for Business. Valid settings are: @@ -827,8 +878,7 @@ The default value is AllPhotos. ```yaml Type: DisplayPhoto 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 +Aliases: Required: False Position: Named @@ -838,6 +888,9 @@ Accept wildcard characters: False ``` ### -EnableAppearOffline + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True an additional presence state -- Appear Offline -- is available in Skype for Business. This state makes it appear as though the user is offline; however, he or she will actually be online and available to answer phone calls, respond to instant messages, etc. When set to False, the Appear Offline presence state will not be available in Skype for Business. @@ -846,8 +899,7 @@ When set to False, the Appear Offline presence state will not be available in Sk ```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 +Aliases: Required: False Position: Named @@ -857,6 +909,9 @@ Accept wildcard characters: False ``` ### -EnableCallLogAutoArchiving + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, information about your incoming and outgoing phone calls is automatically saved to the Conversation History folder in Outlook. (The actual call itself is not recorded. What is recorded is information such as who took part in the call; the length of the call and whether this was an incoming or an outgoing call.) When set to False, this information is not saved to Outlook. @@ -865,8 +920,25 @@ What is recorded is information such as who took part in the call; the length of ```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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableClientAutoPopulateWithTeam + +> Applicable: Skype for Business Online + +When set to true, allows a user's Skype client to be autopopulated with members of his or her immediate team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -876,6 +948,9 @@ Accept wildcard characters: False ``` ### -EnableClientMusicOnHold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, music will be played any time a caller is placed on hold. When set to False, music will not be played any time a caller is placed on hold. The default value is False. @@ -884,8 +959,7 @@ 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 +Aliases: Required: False Position: Named @@ -895,6 +969,9 @@ Accept wildcard characters: False ``` ### -EnableConversationWindowTabs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, supplemental information related to an instant messaging session will be displayed in a separate browser window. When set to False, supplemental information will not be displayed in a separate browser window. @@ -905,8 +982,7 @@ This parameter has been deprecated for use with Skype for Business Server. ```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 +Aliases: Required: False Position: Named @@ -916,6 +992,9 @@ Accept wildcard characters: False ``` ### -EnableEnterpriseCustomizedHelp + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users who click the Help menu in Skype for Business will be given custom help set up by the organization. When set to False, users who click the Help menu will be given the default product help. @@ -925,8 +1004,7 @@ This parameter has been deprecated for use with Skype for Business Server. ```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 +Aliases: Required: False Position: Named @@ -936,6 +1014,9 @@ Accept wildcard characters: False ``` ### -EnableEventLogging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, detailed information about Skype for Business will be recorded in the Application event log. When set to False, only major events (such as the failure to connect to Skype for Business Server) are recorded in the event log. @@ -943,8 +1024,25 @@ When set to False, only major events (such as the failure to connect to Skype fo ```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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExchangeContactsFolder + +> Applicable: Skype for Business Online + +When set to false, this allows admins to hide Skype for Business contacts from showing up in users' Outlook and Outlook on the Web clients. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -954,14 +1052,16 @@ Accept wildcard characters: False ``` ### -EnableExchangeContactSync + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True (the default value) Skype for Business creates a corresponding personal contact in Outlook for each person on a user's Skype for Business Contacts list. ```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 +Aliases: Required: False Position: Named @@ -971,14 +1071,16 @@ Accept wildcard characters: False ``` ### -EnableExchangeDelegateSync + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, a user that has been configured in Outlook will be allowed to schedule online Lync Calendar meetings for that user (this happens via Lync UCMAPI delegation, without the need of the Enterprise Voice feature). ```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 +Aliases: Required: False Position: Named @@ -988,6 +1090,9 @@ Accept wildcard characters: False ``` ### -EnableFullScreenVideo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, this parameter does two things: 1) enables full-screen video (with the correct aspect ratio) for Skype for Business calls and 2) disables video preview for Skype for Business calls. When set to False then full-screen video is not available in Skype for Business, but video preview is available. @@ -995,8 +1100,7 @@ When set to False then full-screen video is not available in Skype for Business, ```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 +Aliases: Required: False Position: Named @@ -1005,20 +1109,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableHotdesking -When set to True, enables users to log on to a phone running Skype for Business Phone Edition in a shared workspace by using their Skype for Business Server account. -(Among other things, this provides the user access to his or her contacts.) When set to False, users are not allowed to log on to a phone in a shared workspace by using their own credentials. +### -EnableHighPerformanceConferencingAppSharing -Note that this setting applies only to common area (shared workspace) accounts and not to user accounts. -When set to True and applied to a common area account for a phone in a shared workspace, any user will be able to log on to that phone by using his or her credentials. -When set to False, no one will be allowed to log on to that phone. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, enables better performance in applications (such as CAD/CAM applications) that have a high screen refresh rate. +However, this improved performance will reduce the system resources and network bandwidth available to other applications. ```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 +Aliases: Required: False Position: Named @@ -1027,17 +1129,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableIMAutoArchiving -When set to True, a transcript of every instant message session that a user takes part in will be saved to the Conversation History folder in Outlook. -When set to False, these transcripts will not be saved automatically. -(However, users will have the option to manually save instant message transcripts.) +### -EnableHighPerformanceP2PAppSharing + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, allows a peer-to-peer application sharing session to exceed the maximum frame rate of 2.5 frames per second. +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 +Aliases: Required: False Position: Named @@ -1046,19 +1149,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSQMData -When EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Improvement Program. -However, Skype for Business will provide the user with the option to join the program. +### -EnableHotdesking -When set to False, the user will not be enrolled in the Customer Experience Improvement Program. -In addition, Skype for Business will not give users the option of joining the program. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, enables users to log on to a phone running Skype for Business Phone Edition in a shared workspace by using their Skype for Business Server account. +(Among other things, this provides the user access to his or her contacts.) When set to False, users are not allowed to log on to a phone in a shared workspace by using their own credentials. + +Note that this setting applies only to common area (shared workspace) accounts and not to user accounts. +When set to True and applied to a common area account for a phone in a shared workspace, any user will be able to log on to that phone by using his or her credentials. +When set to False, no one will be allowed to log on to that phone. ```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 +Aliases: Required: False Position: Named @@ -1067,17 +1173,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTracing -When set to True, software tracing will be enabled in Skype for Business; when set to False software tracing will be disabled. -Software tracing involves keeping an extremely detailed record of everything that a program does (including tracking API calls). -As such tracing is mostly useful to developers and to application support personnel. +### -EnableIMAutoArchiving + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, a transcript of every instant message session that a user takes part in will be saved to the Conversation History folder in Outlook. +When set to False, these transcripts will not be saved automatically. +(However, users will have the option to manually save instant message transcripts.) ```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 +Aliases: Required: False Position: Named @@ -1086,16 +1194,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableUnencryptedFileTransfer -When set to True, users will be allowed to exchange files with external users whose instant messaging software does not support encrypted file transfers. -When set to False, users will only be able to exchange files with external users who have software that supports encrypted file transfers. +### -EnableMediaRedirection + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True) allows audio and video streams to be separated from other network traffic; in turn, this allows client devices to do encoding and decoding of audio and video locally. +Media redirection typically results in lower bandwidth usage, higher server scalability and a more-optimal user experience compared to similar techniques such as device remoting or codec compression. ```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 +Aliases: Required: False Position: Named @@ -1104,19 +1214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVOIPCallDefault -When set to True, a Skype for Business call will be placed any time a user employs the click-to-call feature. +### -EnableMeetingEngagement -This policy setting only affects the initial state of the click-to-call feature. -If the user modifies the value of the click-to-call setting then the user-selected value will override this policy setting. -After a user has modified the click-to-call setting that setting will remain in use and will not be affected by the EnableVOIPCallDefault policy. +> Applicable: Skype for Business Online +This parameter is reserved for internal Microsoft use. ```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 +Aliases: Required: False Position: Named @@ -1125,16 +1232,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludedContactFolders -Indicates which Outlook contact folders (if any) should not be searched any time Skype for Business searches for new contacts. -Multiple folders can be specified by separating the folder names using semicolons; for example: `-ExcludedContactFolders "SenderPhotoContacts;OtherContacts"`. +### -EnableNotificationForNewSubscribers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True you will receive notification any time you are added to someone else's Contacts list. +In addition, the notification dialog box will provide options for you to add that person to your Contacts list, or to block them from viewing your presence information. ```yaml -Type: String +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 +Aliases: Required: False Position: Named @@ -1143,23 +1252,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HotdeskingTimeout -Timeout interval for a user logged on to a "hot-desk" phone. -(A hot-desk phone is a phone running Skype for Business Phone Edition that is located in a shared workspace and that users can log on to using their Skype for Business Server account.) The hot-desk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hot-desk phone. -When specifying a hot desking timeout you must use the format hours:minutes:seconds. -For example, this syntax sets the hot desking timeout interval to 45 minutes: - -`-HotdeskingTimeout 00:45:00` +### -EnableOnlineFeedback -Note that this policy setting applies only to common area phones and not to users. -The default value is 5 minutes (00:05:00), and the minimum value is 30 seconds (00:00:30). +> Applicable: Skype for Business Online +When set to true, allows users to provide feedback through the "help->report a problem" menu options in the client. ```yaml -Type: TimeSpan +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 +Aliases: Required: False Position: Named @@ -1168,21 +1270,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMWarning -When configured, the specified message appears in the Conversation window each time a user takes part in an instant messaging session. -For example, if IMWarning is set to "All information is the property of Litwareinc" then that message will appear in the Conversation window each time a user takes part in an instant messaging session. +### -EnableOnlineFeedbackScreenshots -Your warning message should be limited to 256 characters, and can only contain plain text. -You cannot use any formatting (such as boldface or italics) and you cannot clickable URLs within the text. - -If set to a null value ($Null) then no message appears in the Conversation window. +> Applicable: Skype for Business Online +When set to true, allows users to provide screenshots of their clients when reporting problems. ```yaml -Type: String +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 +Aliases: Required: False Position: Named @@ -1191,24 +1288,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MAPIPollInterval +### -EnableServerConversationHistory -> [!IMPORTANT] -> This parameter has been deprecated for use with Skype for Business Server. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -For users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Skype for Business retrieves calendar data from the Exchange public folders. -MAPIPollInterval can be set to any value between 1 second and 1 hour; inclusive. -To configure the MAPI poll interval, use the format hours:minutes:seconds. -For example, this command sets the MAPI poll interval to 45 minutes: +When set to True ($True), allows conversation histories, missed call notifications, and missed IM notifications to be stored on the server instead of in client mailboxes. +This makes it easier for users to retrieve that information from a mobile device. -`-MapiPollInterval 00:45:00` +The default value is False ($False). ```yaml -Type: TimeSpan +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 +Aliases: Required: False Position: Named @@ -1217,17 +1310,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaximumDGsAllowedInContactList -Indicates the maximum number of distribution groups that a user can configure as a contact. -MaximumDGsAllowedInContactList can be set to any integer value between 0 and 64, inclusive. -The default value is 10. +### -EnableSkypeUI + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), this parameter allows administrators to enable the Skype for Business user interface instead of the Lync interface for the Skype for Business client. ```yaml -Type: UInt32 +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 +Aliases: Required: False Position: Named @@ -1236,17 +1329,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaximumNumberOfContacts -Indicates the maximum number of contacts a user is allowed to have. -The maximum contacts can be set to any integer value between 0 and 1000, inclusive. -When set to 0, that prevents the user from having any contacts. +### -EnableSQMData + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Improvement Program. +However, Skype for Business will provide the user with the option to join the program. + +When set to False, the user will not be enrolled in the Customer Experience Improvement Program. +In addition, Skype for Business will not give users the option of joining the program. ```yaml -Type: UInt16 +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 +Aliases: Required: False Position: Named @@ -1255,17 +1352,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MusicOnHoldAudioFile -Path to the audio file to be played when a caller is placed on hold. -If a value is configured for this property then music on hold will be enabled and users will not be allowed to disable the feature. -If no value is configured for this property then users can specify their own music on hold file, assuming that EnableClientMusicOnHold is set to True. +### -EnableTracing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, software tracing will be enabled in Skype for Business; when set to False software tracing will be disabled. +Software tracing involves keeping an extremely detailed record of everything that a program does (including tracking API calls). +As such tracing is mostly useful to developers and to application support personnel. ```yaml -Type: String +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 +Aliases: Required: False Position: Named @@ -1274,26 +1373,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -P2PAppSharingEncryption -Indicates whether or not desktop and application sharing data exchanged during a peer-to-peer conversation is encrypted. -Allowed values are: - -Supported. -Desktop and application sharing data will be encrypted, if possible. +### -EnableUnencryptedFileTransfer -Enforced. -Desktop and application sharing data must be encrypted. -If the data cannot be encrypted then desktop and application sharing will not be enabled for the conversation. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -NotSupported. -Desktop and application sharing data will not be encrypted. +When set to True, users will be allowed to exchange files with external users whose instant messaging software does not support encrypted file transfers. +When set to False, users will only be able to exchange files with external users who have software that supports encrypted file transfers. ```yaml -Type: P2PAppSharingEncryption +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 +Aliases: Required: False Position: Named @@ -1302,16 +1393,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PlayAbbreviatedDialTone -When set to True, a 3-second dial tone will be played any time a Skype for Business-compatible handset is taken off the hook. -(A Skype for Business-compatible handset looks like a standard telephone, but plugs into a USB port on your computer and is used to make Skype for Business calls rather than "regular" phone calls.) When set to False, a 30-second dial tone is played any time a Skype for Business-compatible handset is taken off the hook. +### -EnableURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, hyperlinks embedded in an instant message will be "clickable;" that is, users can click that link and their web browser will open to the specified location. +When set to False, hyperlinks appear in instant messages as plain text. +To navigate to the location, users will need to copy the link text and paste it into their web browser. ```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 +Aliases: Required: False Position: Named @@ -1320,23 +1414,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyEntry -Provides a way to add settings not covered by the default parameters. -For example, when testing pre-release versions Microsoft Lync Server 2010 it was possible to add a Send Feedback option to Microsoft Lync 2010. -That was done by using code similar to this: - -`$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback"` - -`Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}` +### -EnableViewBasedSubscriptionMode -For more details and examples, see the `New-CsClientPolicyEntry` cmdlet help topic. +> Applicable: Skype for Business Online +This parameter is reserved for internal Microsoft use. ```yaml -Type: PSListModifier +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 +Aliases: Required: False Position: Named @@ -1345,40 +1432,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchPrefixFlags -Represents the Address Book attributes that should be used any time a user searches for a new contact. -The search prefix flags are constructed as a binary number such as 11101111, in which a 1 indicates that the attribute should be searched and a 0 indicates that the attribute should not be searched. -The attributes in the binary value are (from right to left): - -Primary email address - -Email alias - -All email addresses - -Company - -Display name - -First name +### -EnableVOIPCallDefault -Last name +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The binary value 1110111 means that all attributes should be searched except attribute 4: Company. -To search only display name, first name, and last name you would construct this value: - -1110000 +When set to True, a Skype for Business call will be placed any time a user employs the click-to-call feature. -After the binary value has been constructed it must then be converted to a decimal value before being assigned to SearchPrefixFlags. -To convert a binary number to a decimal number you can use the following Windows PowerShell command: +This policy setting only affects the initial state of the click-to-call feature. +If the user modifies the value of the click-to-call setting then the user-selected value will override this policy setting. +After a user has modified the click-to-call setting that setting will remain in use and will not be affected by the EnableVOIPCallDefault policy. -`[Convert]::ToInt32("1110111", 2)` ```yaml -Type: UInt16 +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 +Aliases: Required: False Position: Named @@ -1387,21 +1455,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowManagePrivacyRelationships -When set to True, shows the Relationships option in the Lync Contacts list window. -When set to False, hides the Relationships option. +### -ExcludedContactFolders -Note that this setting applies only to Lync 2010. -Skype for Business will not show these relationships even if ShowManagePrivacyRelationships has been set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is False. +Indicates which Outlook contact folders (if any) should not be searched any time Skype for Business searches for new contacts. +Multiple folders can be specified by separating the folder names using semicolons; for example: `-ExcludedContactFolders "SenderPhotoContacts;OtherContacts"`. ```yaml -Type: Boolean +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 +Aliases: Required: False Position: Named @@ -1410,15 +1475,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowRecentContacts -This parameter has no effect on the client. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Boolean +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 +Aliases: Required: False Position: Named @@ -1427,16 +1494,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowSharepointPhotoEditLink -If set to True, Skype for Business will include a link that enables users to edit the personal photo stored on SharePoint. -The default value is False, which means that Skype for Business will not include a link to SharePoint. +### -HelpEnvironment + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to "Office 365", the Office 365 client help documentation for Skype for Business will be shown to users rather than the on-premises help shown by default. +You can either set HelpEnvironment to "Office 365" or to a null value ($Null). +If set to a null value (the default value) then the on-premises help will be shown to users. ```yaml -Type: Boolean +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 +Aliases: Required: False Position: Named @@ -1445,21 +1515,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchCenterExternalURL -External URL for the SharePoint site used for keyword searches (also known as expert searches). -This URL will appear at the bottom of any keyword search results that appear in Skype for Business. -If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using SharePoint's search capabilities. -(SharePoint offers more search options than Skype for Business does.) +### -HotdeskingTimeout -SPSearchCenterExternalURL represents the URL for external users; that is, for users logging on from outside the organization's firewall. -The parameter SPSearchCenterInternalURL is for users who log on from inside the firewall. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Timeout interval for a user logged on to a "hot-desk" phone. +(A hot-desk phone is a phone running Skype for Business Phone Edition that is located in a shared workspace and that users can log on to using their Skype for Business Server account.) The hot-desk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hot-desk phone. +When specifying a hot desking timeout you must use the format hours:minutes:seconds. +For example, this syntax sets the hot desking timeout interval to 45 minutes: + +`-HotdeskingTimeout 00:45:00` + +Note that this policy setting applies only to common area phones and not to users. +The default value is 5 minutes (00:05:00), and the minimum value is 30 seconds (00:00:30). ```yaml -Type: String +Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -1468,39 +1542,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchCenterInternalURL -Internal URL for the SharePoint site used for keyword searches (also known as expert searches). -This URL will appear at the bottom of any keyword search results that appear in Skype for Business. -If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using SharePoint's search capabilities. -(SharePoint offers more search options than Skype for Business does.) +### -Identity -SPSearchCenterInternalURL represents the URL for internal users; that is, for users logging on from inside the organization's firewall. -The parameter SPSearchCenterExternalURL is for users who log on from outside the firewall. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier assigned to the new policy. +To reference the global policy, use this syntax: `-Identity global`. +To reference a site policy, use the prefix "site:" and the name of the site as your Identity; for example: `-Identity site:Redmond`. +To reference a per-user policy, use syntax similar to this: `-Identity SalesClientPolicy`. ```yaml -Type: String +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 +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchExternalURL -External URL for the SharePoint site used for keyword searches (also known as expert searches). -Skype for Business will use the SharePoint site located at this URL any time an external user (that is, a user who has accessed the system from outside the organization's firewall) conducts a keyword search. +### -IMLatencyErrorThreshold + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If IM latency is greater than the threshold value (in milliseconds), the client will submit a CER. ```yaml -Type: String +Type: UInt32 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 +Aliases: Required: False Position: Named @@ -1509,16 +1582,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchInternalURL -Internal URL for the SharePoint site used for keyword searches (also known as expert searches). -Skype for Business will use the SharePoint site located at this URL any time an internal user (that is, a user who has logged on from inside the organization's firewall) conducts a keyword search. +### -IMLatencySpinnerDelay + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Amount of time, in milliseconds, to wait before showing the spinner in the client when IM message delivery is delayed. ```yaml -Type: String +Type: UInt32 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 +Aliases: Required: False Position: Named @@ -1527,16 +1601,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TabURL -Specifies the location of the XML file used to create custom tabs located at the bottom of the Skype for Business Contacts list window. -This parameter has been deprecated for use with Skype for Business Server. +### -IMWarning + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When configured, the specified message appears in the Conversation window each time a user takes part in an instant messaging session. +For example, if IMWarning is set to "All information is the property of Litwareinc" then that message will appear in the Conversation window each time a user takes part in an instant messaging session. + +Your warning message should be limited to 256 characters, and can only contain plain text. +You cannot use any formatting (such as boldface or italics) and you cannot clickable URLs within the text. + +If set to a null value ($Null) then no message appears in the Conversation window. ```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 +Aliases: Required: False Position: Named @@ -1545,40 +1626,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebServicePollInterval -For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Skype for Business retrieves calendar data from Microsoft Exchange Server Web Services. -WebServicePollInterval can be set to any value between 1 second and 1 hour; inclusive. -To configure the Web Service poll interval, use the format hours:minutes:seconds. -For example, this command sets the Web Service poll interval to 45 minutes: +### -Instance -`-WebServicePollInterval 00:45:00` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this setting does not apply to users whose email account is on Exchange 2003. -For those users, calendar retrieval is managed using MAPIPollInterval. +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: TimeSpan -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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -MAPIPollInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +> [!IMPORTANT] +> This parameter has been deprecated for use with Skype for Business Server. + +For users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Skype for Business retrieves calendar data from the Exchange public folders. +MAPIPollInterval can be set to any value between 1 second and 1 hour; inclusive. +To configure the MAPI poll interval, use the format hours:minutes:seconds. +For example, this command sets the MAPI poll interval to 45 minutes: + +`-MapiPollInterval 00:45:00` ```yaml -Type: SwitchParameter +Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -1587,15 +1672,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaximumDGsAllowedInContactList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of distribution groups that a user can configure as a contact. +MaximumDGsAllowedInContactList can be set to any integer value between 0 and 64, inclusive. +The default value is 10. ```yaml -Type: SwitchParameter +Type: UInt32 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 +Aliases: Required: False Position: Named @@ -1604,15 +1693,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaximumNumberOfContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of contacts a user is allowed to have. +The maximum contacts can be set to any integer value between 0 and 1000, inclusive. +When set to 0, that prevents the user from having any contacts. ```yaml -Type: SwitchParameter +Type: UInt16 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 +Aliases: Required: False Position: Named @@ -1621,17 +1714,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableMeetingSubjectAndLocation -When set to False, detailed information about a meeting -- namely, the meeting subject and the location where the meeting is being held -- will be displayed as a tooltip when you view free/busy information in a contact card. -When set to True, this detailed information will not be displayed. -To completely prevent the display of meeting-related information you should also set DisableCalendarPresence to True. +### -MaxPhotoSizeKB + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum size (in kilobytes) for photos displayed in Skype for Business. + +The default value is 30 kilobytes. ```yaml -Type: Boolean +Type: UInt32 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 +Aliases: Required: False Position: Named @@ -1640,16 +1735,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNotificationForNewSubscribers -When set to True you will receive notification any time you are added to someone else's Contacts list. -In addition, the notification dialog box will provide options for you to add that person to your Contacts list, or to block them from viewing your presence information. +### -MusicOnHoldAudioFile + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the audio file to be played when a caller is placed on hold. +If a value is configured for this property then music on hold will be enabled and users will not be allowed to disable the feature. +If no value is configured for this property then users can specify their own music on hold file, assuming that EnableClientMusicOnHold is set to True. ```yaml -Type: Boolean +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 +Aliases: Required: False Position: Named @@ -1658,17 +1756,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableURL -When set to True, hyperlinks embedded in an instant message will be "clickable;" that is, users can click that link and their web browser will open to the specified location. -When set to False, hyperlinks appear in instant messages as plain text. -To navigate to the location, users will need to copy the link text and paste it into their web browser. +### -P2PAppSharingEncryption + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not desktop and application sharing data exchanged during a peer-to-peer conversation is encrypted. +Allowed values are: + +Supported. +Desktop and application sharing data will be encrypted, if possible. + +Enforced. +Desktop and application sharing data must be encrypted. +If the data cannot be encrypted then desktop and application sharing will not be enabled for the conversation. + +NotSupported. +Desktop and application sharing data will not be encrypted. ```yaml -Type: Boolean +Type: P2PAppSharingEncryption 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 +Aliases: Required: False Position: Named @@ -1677,17 +1786,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxPhotoSizeKB -Indicates the maximum size (in kilobytes) for photos displayed in Skype for Business. +### -PlayAbbreviatedDialTone -The default value is 30 kilobytes. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, a 3-second dial tone will be played any time a Skype for Business-compatible handset is taken off the hook. +(A Skype for Business-compatible handset looks like a standard telephone, but plugs into a USB port on your computer and is used to make Skype for Business calls rather than "regular" phone calls.) When set to False, a 30-second dial tone is played any time a Skype for Business-compatible handset is taken off the hook. ```yaml -Type: UInt32 +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 +Aliases: Required: False Position: Named @@ -1696,16 +1806,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMediaRedirection -When set to True ($True) allows audio and video streams to be separated from other network traffic; in turn, this allows client devices to do encoding and decoding of audio and video locally. -Media redirection typically results in lower bandwidth usage, higher server scalability and a more-optimal user experience compared to similar techniques such as device remoting or codec compression. +### -PolicyEntry + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way to add settings not covered by the default parameters. +For example, when testing pre-release versions Microsoft Lync Server 2010 it was possible to add a Send Feedback option to Microsoft Lync 2010. +That was done by using code similar to this: + +`$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback"` + +`Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}` + +For more details and examples, see the `New-CsClientPolicyEntry` cmdlet help topic. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1714,17 +1833,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpEnvironment -When set to "Office 365", the Office 365 client help documentation for Skype for Business will be shown to users rather than the on-premises help shown by default. -You can either set HelpEnvironment to "Office 365" or to a null value ($Null). -If set to a null value (the default value) then the on-premises help will be shown to users. +### -PublicationBatchDelay +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml -Type: String +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1733,24 +1851,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TracingLevel -Enables Administrators to manage event tracing and logging in Skype for Business. -Allowed values are: - -Off - Tracing is disabled and the user cannot change this setting. - -Light - Minimal tracing is performed, and the user cannot change this setting. +### -RateMyCallAllowCustomUserFeedback -Full - Verbose tracing is performed, and the user cannot change this setting. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -By default TracingLevel is set to Light. +When set to True ($True), enables a text box for users to type feedback when prompted. ```yaml -Type: TracingLevel +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1759,15 +1870,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableClientAutoPopulateWithTeam +### -RateMyCallDisplayPercentage + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +The RateMyCallDisplayPercentage setting adjusts how often users are prompted for feedback, ranging from 0 to 100. +The default value is 10, meaning that users will get prompted for feedback 10% of the time after they finish a call. +Setting this to 0 means users will never get prompted. +When set to 100, users will get prompted after every call. -When set to true, allows a user's Skype client to be autopopulated with members of his or her immediate team. ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1776,15 +1892,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableExchangeContactsFolder +### -RequireContentPin -When set to false, this allows admins to hide Skype for Business contacts from showing up in users' Outlook and Outlook on the Web clients. +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1793,16 +1910,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableHighPerformanceConferencingAppSharing -When set to True, enables better performance in applications (such as CAD/CAM applications) that have a high screen refresh rate. -However, this improved performance will reduce the system resources and network bandwidth available to other applications. +### -SearchPrefixFlags + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the Address Book attributes that should be used any time a user searches for a new contact. +The search prefix flags are constructed as a binary number such as 11101111, in which a 1 indicates that the attribute should be searched and a 0 indicates that the attribute should not be searched. +The attributes in the binary value are (from right to left): + +Primary email address + +Email alias + +All email addresses + +Company + +Display name +First name + +Last name + +The binary value 1110111 means that all attributes should be searched except attribute 4: Company. +To search only display name, first name, and last name you would construct this value: + +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 following Windows PowerShell command: + +`[Convert]::ToInt32("1110111", 2)` ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1811,17 +1954,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableHighPerformanceP2PAppSharing +### -ShowManagePrivacyRelationships + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, shows the Relationships option in the Lync Contacts list window. +When set to False, hides the Relationships option. + +Note that this setting applies only to Lync 2010. +Skype for Business will not show these relationships even if ShowManagePrivacyRelationships has been set to True. -When set to True, allows a peer-to-peer application sharing session to exceed the maximum frame rate of 2.5 frames per second. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1830,14 +1979,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingEngagement -This parameter is reserved for internal Microsoft use. +### -ShowRecentContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has no effect on the client. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1846,15 +1998,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineFeedback +### -ShowSharepointPhotoEditLink + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, Skype for Business will include a link that enables users to edit the personal photo stored on SharePoint. +The default value is False, which means that Skype for Business will not include a link to SharePoint. -When set to true, allows users to provide feedback through the "help->report a problem" menu options in the client. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1863,15 +2018,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineFeedbackScreenshots +### -SPSearchCenterExternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +External URL for the SharePoint site used for keyword searches (also known as expert searches). +This URL will appear at the bottom of any keyword search results that appear in Skype for Business. +If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using SharePoint's search capabilities. +(SharePoint offers more search options than Skype for Business does.) + +SPSearchCenterExternalURL represents the URL for external users; that is, for users logging on from outside the organization's firewall. +The parameter SPSearchCenterInternalURL is for users who log on from inside the firewall. -When set to true, allows users to provide screenshots of their clients when reporting problems. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1880,18 +2043,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableServerConversationHistory -When set to True ($True), allows conversation histories, missed call notifications, and missed IM notifications to be stored on the server instead of in client mailboxes. -This makes it easier for users to retrieve that information from a mobile device. +### -SPSearchCenterInternalURL -The default value is False ($False). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Internal URL for the SharePoint site used for keyword searches (also known as expert searches). +This URL will appear at the bottom of any keyword search results that appear in Skype for Business. +If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using SharePoint's search capabilities. +(SharePoint offers more search options than Skype for Business does.) + +SPSearchCenterInternalURL represents the URL for internal users; that is, for users logging on from inside the organization's firewall. +The parameter SPSearchCenterExternalURL is for users who log on from outside the firewall. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1900,15 +2068,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSkypeUI -When set to True ($True), this parameter allows administrators to enable the Skype for Business user interface instead of the Lync interface for the Skype for Business client. +### -SPSearchExternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +External URL for the SharePoint site used for keyword searches (also known as expert searches). +Skype for Business will use the SharePoint site located at this URL any time an external user (that is, a user who has accessed the system from outside the organization's firewall) conducts a keyword search. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1917,14 +2088,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableViewBasedSubscriptionMode -This parameter is reserved for internal Microsoft use. +### -SPSearchInternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Internal URL for the SharePoint site used for keyword searches (also known as expert searches). +Skype for Business will use the SharePoint site located at this URL any time an internal user (that is, a user who has logged on from inside the organization's firewall) conducts a keyword search. + ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1933,15 +2108,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMLatencyErrorThreshold -If IM latency is greater than the threshold value (in milliseconds), the client will submit a CER. +### -SupportModernFilePicker +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1950,15 +2126,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMLatencySpinnerDelay -Amount of time, in milliseconds, to wait before showing the spinner in the client when IM message delivery is delayed. +### -TabURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the location of the XML file used to create custom tabs located at the bottom of the Skype for Business Contacts list window. +This parameter has been deprecated for use with Skype for Business Server. ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1967,14 +2146,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PublicationBatchDelay +### -TelemetryTier + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1983,35 +2164,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RateMyCallAllowCustomUserFeedback -When set to True ($True), enables a text box for users to type feedback when prompted. +### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client policy is being modified. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -RateMyCallDisplayPercentage -The RateMyCallDisplayPercentage setting adjusts how often users are prompted for feedback, ranging from 0 to 100. -The default value is 10, meaning that users will get prompted for feedback 10% of the time after they finish a call. -Setting this to 0 means users will never get prompted. -When set to 100, users will get prompted after every call. +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: UInt16 +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -2020,14 +2190,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireContentPin -This parameter is reserved for internal Microsoft use. +### -TracingLevel + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables Administrators to manage event tracing and logging in Skype for Business. +Allowed values are: + +Off - Tracing is disabled and the user cannot change this setting. + +Light - Minimal tracing is performed, and the user cannot change this setting. + +Full - Verbose tracing is performed, and the user cannot change this setting. + +By default TracingLevel is set to Light. + ```yaml -Type: String +Type: TracingLevel Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -2036,14 +2218,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SupportModernFilePicker -This parameter is reserved for internal Microsoft use. +### -WebServicePollInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Skype for Business retrieves calendar data from Microsoft Exchange Server Web Services. +WebServicePollInterval can be set to any value between 1 second and 1 hour; inclusive. +To configure the Web Service poll interval, use the format hours:minutes:seconds. +For example, this command sets the Web Service poll interval to 45 minutes: + +`-WebServicePollInterval 00:45:00` + +Note that this setting does not apply to users whose email account is on Exchange 2003. +For those users, calendar retrieval is managed using MAPIPollInterval. + ```yaml -Type: Boolean +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -2052,14 +2245,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TelemetryTier -This parameter is reserved for internal Microsoft use. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -2068,22 +2264,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client policy is being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -2097,13 +2288,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy + The `Set-CsClientPolicy` cmdlet accepts pipelined instances of the client policy object. ## OUTPUTS -### +### None The `Set-CsClientPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. diff --git a/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsClientVersionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClientVersionConfiguration.md index c7a71cdaca..7fe5245162 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClientVersionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclientversionconfiguration +schema: 2.0.0 +title: Set-CsClientVersionConfiguration --- # Set-CsClientVersionConfiguration @@ -54,7 +55,7 @@ The technology relies on self-reporting from client applications and does not at ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClientVersionConfiguration -Identity site:Redmond -Enabled $False ``` @@ -63,7 +64,7 @@ In Example 1, the `Set-CsClientVersionConfiguration` cmdlet is used to modify th In this case, the Enabled parameter is set to False in order to disable the client version configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientVersionConfiguration | Set-CsClientVersionConfiguration -DefaultURL "https://litwareinc.com/csclients" ``` @@ -73,7 +74,7 @@ To do this, the command first calls the `Get-CsClientVersionConfiguration` cmdle That information is then piped to the `Set-CsClientVersionConfiguration` cmdlet, which sets the value of the DefaultUrl for each configuration collection to https://litwareinc.com/csclients. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientVersionConfiguration | Where-Object {$_.DefaultAction -eq "Block"} | Set-CsClientVersionConfiguration -DefaultAction "BlockWithUrl" -DefaultURL "https://litwareinc.com/csclients" ``` @@ -86,44 +87,10 @@ In turn, that filtered collection is then piped to the `Set-CsClientVersionConfi ## PARAMETERS -### -Identity -Represents the unique identifier of the client version configuration settings to be modified. -To modify the global settings, use syntax like this: `-Identity global`. -To modify settings assigned to the site scope, use syntax similar to this: `"site:Redmond"`. - -If this parameter is not included, the `Set-CsClientVersionConfiguration` cmdlet will automatically configure the global settings. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -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 Server 2015, Skype for Business Server 2019 +### -DefaultAction -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DefaultAction Indicates the action to be taken if a user tries to log on from a client application with a version number that cannot be found in the appropriate client version policy. DefaultAction must be set to one of the following values: @@ -149,8 +116,26 @@ When the Enabled property is set to False, then no client version filtering of a ```yaml Type: DefaultAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the URL of the webpage where users can download an approved client application. +If specified and if the DefaultAction is set to BlockWithURL, this URL will appear in the "Access denied" message box displayed any time a user tries to log on from an unsupported client application. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -160,6 +145,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether client version filtering is enabled or disabled. If the Enabled property is True, then the server will check the version number of each client application that attempts to log on; the server will then allow or deny access based on the appropriate client version policy. If the Enabled property is False, then any client application capable of logging on will be allowed to log on. @@ -167,8 +155,7 @@ If the Enabled property is False, then any client application capable of logging ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,13 +165,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,30 +182,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the unique identifier of the client version configuration settings to be modified. +To modify the global settings, use syntax like this: `-Identity global`. +To modify settings assigned to the site scope, use syntax similar to this: `"site:Redmond"`. + +If this parameter is not included, the `Set-CsClientVersionConfiguration` cmdlet will automatically configure the global settings. + ```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 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -225,15 +241,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultURL -Specifies the URL of the webpage where users can download an approved client application. -If specified and if the DefaultAction is set to BlockWithURL, this URL will appear in the "Access denied" message box displayed any time a user tries to log on from an unsupported client application. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -247,13 +264,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration + The `Set-CsClientVersionConfiguration` cmdlet accepts pipelined instances of the client version configuration object. ## OUTPUTS -### +### None The `Set-CsClientVersionConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicy.md similarity index 89% rename from skype/skype-ps/skype/Set-CsClientVersionPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicy.md index dfff66f31a..7b8ecdb235 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClientVersionPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclientversionpolicy +schema: 2.0.0 +title: Set-CsClientVersionPolicy --- # Set-CsClientVersionPolicy @@ -60,7 +61,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClientVersionPolicy -Identity site:Redmond -Rules $Null @@ -80,7 +81,47 @@ This effectively copies all the rules from the site:Dublin policy and adds them ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to provide explanatory information about a policy. +For example, you might provide information describing the users that 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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be modified. To modify the global policy, use this syntax: `-Identity global`. To modify a policy configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. @@ -96,8 +137,7 @@ If this parameter is not included, then the `Set-CsClientVersionPolicy` cmdlet w ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -107,13 +147,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,31 +164,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Description -Enables you to provide explanatory information about a policy. -For example, you might provide information describing the users that the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Rules -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Rules Collection of individual client policy rules that have been assigned to the policy. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,30 +182,23 @@ 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. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy is being modified. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,13 +208,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -203,21 +225,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy is being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -231,13 +248,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy + The `Set-CsClientVersionPolicy` cmdlet accepts pipelined instances of the client version policy object. ## OUTPUTS -### +### None The `Set-CsClientVersionPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy object. diff --git a/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicyRule.md similarity index 86% rename from skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicyRule.md index b9933740d1..8e3d47286e 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicyRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClientVersionPolicyRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclientversionpolicyrule +schema: 2.0.0 +title: Set-CsClientVersionPolicyRule --- # Set-CsClientVersionPolicyRule @@ -81,7 +82,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsClientVersionPolicyRule -Identity site:Redmond/74ba9211-8610-42f9-91ba-846cdee98820 -Enabled $False ``` @@ -90,7 +91,7 @@ The command shown in Example 1 disables the client version policy rule that has To disable the rule, the command includes the Enabled parameter and the parameter value $False. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsClientVersionPolicyRule -Filter "site:Redmond*" | Set-CsClientVersionPolicyRule -Description "Client policy rules for Redmond" ``` @@ -100,7 +101,7 @@ To do this, the command first calls the `Get-CsClientVersionPolicyRule` cmdlet a This collection is then piped to the `Set-CsClientVersionPolicyRule` cmdlet, which assigns the Description "Client policy rules for Redmond" to each item in that collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsClientVersionPolicyRule | Where-Object {$_.UserAgent -eq "UCCP"} | Set-CsClientVersionPolicyRule -Action "Block" ``` @@ -113,41 +114,10 @@ This filtered collection is then piped to the `Set-CsClientVersionPolicyRule` cm ## PARAMETERS -### -Identity -Unique identifier for the client version policy rule to be modified. -The Identity of a client version rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). -That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -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 Server 2015, Skype for Business Server 2019 +### -Action -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Action Action to be taken any time the rule is triggered (that is, any time someone attempts to log on by using the specified software). Valid values are: @@ -173,8 +143,7 @@ The user can then try to log on by using the new client application. ```yaml Type: Action Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,14 +153,16 @@ Accept wildcard characters: False ``` ### -ActionUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where users can download the latest version of Lync. This property is required if the Action is set to BlockWithUrl or AllowWithUrl. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +172,9 @@ Accept wildcard characters: False ``` ### -BuildNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Build number of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the BuildNumber is 6362. Build numbers represent internal versions of the software during the development process, and help to ensure that you are using the final release version as opposed to a pre-release version. @@ -208,8 +182,7 @@ Build numbers represent internal versions of the software during the development ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +192,9 @@ Accept wildcard characters: False ``` ### -CompareOp + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comparison operator used to determine if the client software attempting to log on was released before, after, or at the same time as the version specified in the rule. Valid values are: @@ -237,8 +213,7 @@ LEQ (less than or equal to) ```yaml Type: CompareOp Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,14 +223,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional information about the client version rule. For example, the Description might include information about who to contact if you believe the rule should 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 +Aliases: Required: False Position: Named @@ -265,6 +242,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the client version rule is to be used. If the Enabled property is set to False the rule will be ignored any time a user attempts to log on with the specified software. The default value is True. @@ -272,8 +252,25 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -282,7 +279,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the client version policy rule to be modified. +The Identity of a client version rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). +That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -MajorVersion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Major version of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the MajorVersion is 2. Major versions equate to primary releases of the software. @@ -290,8 +328,7 @@ Major versions equate to primary releases of the software. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -301,6 +338,9 @@ Accept wildcard characters: False ``` ### -MinorVersion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Minor version of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the MinorVersion is 0. Minor versions equate to interim releases of the software. @@ -308,8 +348,7 @@ Minor versions equate to interim releases of the software. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -319,6 +358,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Relative priority of the rule. Rules are processed in priority order, with the rule with priority 0 being processed first, the rule with priority 1 being processed second, and so on. If you assign a priority already in use, the new rule will use that priority and other rules will be renumbered accordingly. @@ -326,8 +368,7 @@ If you assign a priority already in use, the new rule will use that priority and ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -337,6 +378,9 @@ Accept wildcard characters: False ``` ### -QfeNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Quick fix engineering number of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the QfeNumber is 111. QFE numbers represent planned updates to an application that are made available after the software's official release. @@ -344,8 +388,7 @@ QFE numbers represent planned updates to an application that are made available ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -354,32 +397,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAgent -Designator used to identify the software client. -For example, OC is the user agent designation for Communicator. -The `Get-CsClientVersionConfiguration` cmdlet provides corresponding friendly names for each user agent designation. +### -Tenant -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy rule is being modified. +For example: -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,14 +422,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UserAgent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Designator used to identify the software client. +For example, OC is the user agent designation for Communicator. +The `Get-CsClientVersionConfiguration` cmdlet provides corresponding friendly names for each user agent designation. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -404,14 +442,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -UserAgentFullName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide a friendly name for the user agent. +For example, instead of relying on the user agent UCCP to identify the agent administrators might spell the name out in full: Microsoft Unified Communications Client. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -420,16 +462,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAgentFullName -Enables administrators to provide a friendly name for the user agent. -For example, instead of relying on the user agent UCCP to identify the agent administrators might spell the name out in full: Microsoft Unified Communications Client. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -438,21 +480,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy rule is being modified. -For example: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -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` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -466,14 +503,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule + The `Set-CsClientVersionPolicyRule` cmdlet accepts pipelined instances of the client version rule object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClientVersionPolicyRule` cmdlet modifies instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnector.md similarity index 91% rename from skype/skype-ps/skype/Set-CsCloudCallDataConnector.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnector.md index d15bbdcaf8..4008a81250 100644 --- a/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnector.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscloudcalldataconnector applicable: Skype for Business Server 2019 -title: Set-CsCloudCallDataConnector -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscloudcalldataconnector +schema: 2.0.0 +title: Set-CsCloudCallDataConnector --- # Set-CsCloudCallDataConnector @@ -45,29 +46,16 @@ Example showing the scenario when we aren't piping the output from online cmdlet ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Force -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2019 -### -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: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -76,13 +64,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2019 + 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: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -91,13 +81,15 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Skype for Business Server 2019 + Office 365 TenantID of your tenant. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -106,13 +98,15 @@ Accept wildcard characters: False ``` ### -Token + +> Applicable: Skype for Business Server 2019 + Data ingestion token for CloudCallDataConnector telemetry endpoint. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -120,7 +114,27 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2019 + +Prompts you for confirmation before running the 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 + +> Applicable: Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -128,7 +142,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnectorConfiguration.md similarity index 94% rename from skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnectorConfiguration.md index 021a5cf3e8..f2348d4b65 100644 --- a/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnectorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscloudcalldataconnectorconfiguration applicable: Skype for Business Server 2019 -title: Set-CsCloudCallDataConnectorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscloudcalldataconnectorconfiguration +schema: 2.0.0 +title: Set-CsCloudCallDataConnectorConfiguration --- # Set-CsCloudCallDataConnectorConfiguration @@ -69,13 +70,15 @@ The filtered collection is then piped to the `Set-CsCloudCallDataConnectorConfig ## PARAMETERS ### -EnableCallDataConnector + +> Applicable: Skype for Business Server 2019 + Enables upload of call data. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2019 + Represents the unique identifier to be assigned to the new collection of CloudCallDataConnector configuration settings. Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example, "site:Redmond". ```yaml Type: XdsIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: 1 Default value: None @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2019 + 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: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -136,7 +148,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Set-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsClsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClsConfiguration.md index ac2b5e0018..f8f4c5d280 100644 --- a/skype/skype-ps/skype/Set-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclsconfiguration +schema: 2.0.0 +title: Set-CsClsConfiguration --- # Set-CsClsConfiguration @@ -64,7 +65,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClsConfiguration -Identity "global" -EtlRolloverFileSizeMB 40 ``` @@ -72,7 +73,7 @@ Set-CsClsConfiguration -Identity "global" -EtlRolloverFileSizeMB 40 In Example 1, the global collection of centralized logging configuration settings is modified to set the maximum size of an ETL file to 40 megabytes. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsConfiguration | Set-CsClsConfiguration -EtlRolloverFileSizeMB 40 ``` @@ -85,6 +86,9 @@ That collection is then piped to the `Set-CsClsConfiguration` cmdlet, which chan ## PARAMETERS ### -CacheFileLocalFolders + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + One or more full paths to the local folders where the cache files will be stored. The default value is %TEMP%\Tracing. If more than one path is specified, then separate them with semi-colons. @@ -92,8 +96,7 @@ If more than one path is specified, then separate them with semi-colons. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,14 +106,16 @@ Accept wildcard characters: False ``` ### -CacheFileLocalMaxDiskUsage + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum amount of disk space (percentage) that can be used for the cache files. The default value is 80. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,14 +125,16 @@ Accept wildcard characters: False ``` ### -CacheFileLocalRetentionPeriod + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of days that cache files are retained locally. The default value is 14. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,14 +144,16 @@ Accept wildcard characters: False ``` ### -CacheFileNetworkFolder + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Full UNC path to the network cache folder. There is no default value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -ComponentThrottleLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum rate at which a component is allowed to generate trace records before its tracing is throttled. The default value is 5000 trace calls per second. @@ -162,8 +174,7 @@ The default value is 5000. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,14 +184,16 @@ Accept wildcard characters: False ``` ### -ComponentThrottleSample + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of times the ComponentThrottleLimit can be exceeded within a one minute interval. The default value is 3. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,23 +202,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -ETLEnoughFreeSpaceInDiskInBytes + +> Applicable: Skype for Business Server 2019 + +Enough free disk space to make purge stop due low free disk space. +If disk size reaches this size, purge stops. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: 4000000000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETLEnoughQuotaInBytes + +> Applicable: Skype for Business Server 2019 + +Enough ETL usage quota to make purge stop due max quota condition reached + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 250000000000 Accept pipeline input: False Accept wildcard characters: False ``` + ### -EtlFileFolder + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Full path to the folder where the event log trace files will be stored. The default value is %TEMP%\Tracing. Note that %TEMP% is evaluated in the contents of the CLS Service so it actual expands to %WINDIR%\ServiceProfiles\NetworkService\AppData\Local @@ -213,8 +251,7 @@ Note that %TEMP% is evaluated in the contents of the CLS Service so it actual ex ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,14 +261,16 @@ Accept wildcard characters: False ``` ### -EtlFileRolloverMinutes + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum amount of time (in minutes) that can elapse before a new event log trace file is created. (This new file will be created even if the existing trace file has not reached the specified rollover size.) The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,14 +280,16 @@ Accept wildcard characters: False ``` ### -EtlFileRolloverSizeMB + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum size (in megabytes) that at event trace log file can reach before a new file is created. The default value is 20. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,14 +298,89 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ETLMaxQuotaInBytes + +> Applicable: Skype for Business Server 2019 + +Max allowed quota used by ETL files before purge starts + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 400000000000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETLMaxRetentionInDays + +> Applicable: Skype for Business Server 2019 + +Maximum retention time in days for ETL files + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 14 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETLMinFreeSpaceInDiskInBytes + +> Applicable: Skype for Business Server 2019 + +Minimum allowed free disk space to have on the ETL folder drive. +If disk reaches this size and ETL Folder size is more than ETLMinQuotaInBytes, Purge executes. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 2000000000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETLMinQuotaInBytes + +> Applicable: Skype for Business Server 2019 + +Min quota allowed for ETL files, even if disk size is less than ETLMinFreeSpaceInDiskInBytes. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3221225472 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -274,6 +390,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the centralized logging configuration settings to be modified. To refer to the global settings, use this syntax: @@ -288,8 +407,7 @@ You cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -299,13 +417,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -315,6 +435,9 @@ Accept wildcard characters: False ``` ### -MinimumClsAgentServiceVersion + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the minimum version of the centralized logging service agent to be used when logging data; any computers with an agent version lower than the minimum value will be excluded from the logging operations. The default value is 6, representing Skype for Business Server. This parameter is intended for use with Skype for Business Online. @@ -323,8 +446,7 @@ This parameter is intended for use with Skype for Business Online. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,18 +455,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Regions -Collection of regions defined for the centralized logging configuration settings. -Regions are defined using the `New-CsClsRegion` cmdlet. +### -NetworkUsagePacketSize -This parameter is intended for use with Skype for Business Online. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Packet size (in kilobytes) for transmitting agent search results and copying cache files over the network. +The default value is 64 KB. ```yaml -Type: PSListModifier +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -353,15 +474,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Scenarios -Collection of components/situations that can be traced using centralized logging. -Scenarios are managed using the CsClsScenario cmdlets. +### -NetworkUsageThreshold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Bandwidth usage threshold (in MB per second) for transmitting agent search results and copying cache files over the network. +The default value is 10. ```yaml -Type: PSListModifier +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -370,15 +493,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchTerms -Collection of terms that help determine the personally identifiable information available to technical support personnel who search the centralized logging files. -Search terms are managed using the CsClsSearchTerm cmdlets. +### -Regions + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of regions defined for the centralized logging configuration settings. +Regions are defined using the `New-CsClsRegion` cmdlet. + +This parameter is intended for use with Skype for Business Online. + ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -387,17 +515,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecurityGroups -Security groups who are allowed to access the log files. +### -Scenarios -This parameter is intended for use with Skype for Business Online. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Collection of components/situations that can be traced using centralized logging. +Scenarios are managed using the CsClsScenario cmdlets. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -406,24 +534,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TmfFileSearchPath -Search path for TMF (trace message format) files. -TMF files convert binary trace messages to a human-readable format. -This should be a UNC or DFC path, to allow it to be accessible from multiple computers. -If the path is not UNC or DFC, every machine any reference to a local folder path must contain all needed TMX files. -Local file paths will work, but must be maintained. - -There's no need to set the location C:\Program Files\Common Files\Skype for Business Server 2015\Tracing\ because every ClsAgent will automatically check this location. +### -SearchTerms -Do not set CacheFileLocalFolders to the same value as TmfFileSearchPath. -Any .tmx files found in the CacheFileLocalFolders path will be deleted. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Collection of terms that help determine the personally identifiable information available to technical support personnel who search the centralized logging files. +Search terms are managed using the CsClsSearchTerm cmdlets. ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -432,31 +553,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SecurityGroups -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Security groups who are allowed to access the log files. + +This parameter is intended for use with Skype for Business Online. -### -NetworkUsagePacketSize -Packet size (in kilobytes) for transmitting agent search results and copying cache files over the network. -The default value is 64 KB. ```yaml -Type: UInt32 +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -465,31 +574,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkUsageThreshold -Bandwidth usage threshold (in MB per second) for transmitting agent search results and copying cache files over the network. -The default value is 10. +### -TmfFileSearchPath -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Search path for TMF (trace message format) files. +TMF files convert binary trace messages to a human-readable format. +This should be a UNC or DFC path, to allow it to be accessible from multiple computers. +If the path is not UNC or DFC, every machine any reference to a local folder path must contain all needed TMX files. +Local file paths will work, but must be maintained. + +There's no need to set the location C:\Program Files\Common Files\Skype for Business Server 2015\Tracing\ because every ClsAgent will automatically check this location. + +Do not set CacheFileLocalFolders to the same value as TmfFileSearchPath. +Any .tmx files found in the CacheFileLocalFolders path will be deleted. -### -Version -This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -498,101 +602,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ETLMinFreeSpaceInDiskInBytes -Minimum allowed free disk space to have on the ETL folder drive. -If disk reaches this size and ETL Folder size is more than ETLMinQuotaInBytes, Purge executes. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +### -Version -Required: False -Position: Named -Default value: 2000000000 -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -ETLEnoughFreeSpaceInDiskInBytes -Enough free disk space to make purge stop due low free disk space. -If disk size reaches this size, purge stops. +This parameter is reserved for internal Microsoft use. ```yaml -Type: Int64 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: 4000000000 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ETLMinQuotaInBytes -Min quota allowed for ETL files, even if disk size is less than ETLMinFreeSpaceInDiskInBytes. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: 3221225472 -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ETLMaxQuotaInBytes -Max allowed quota used by ETL files before purge starts +Prompts you for confirmation before executing the command. ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: cf Required: False Position: Named -Default value: 400000000000 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ETLEnoughQuotaInBytes -Enough ETL usage quota to make purge stop due max quota condition reached - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 - -Required: False -Position: Named -Default value: 250000000000 -Accept pipeline input: False -Accept wildcard characters: False -``` +### -WhatIf +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ETLMaxRetentionInDays -Maximum retention time in days for ETL files +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: wi Required: False Position: Named -Default value: 14 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -602,13 +661,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration The `Set-CsClsConfiguration` cmdlet accepts pipelined instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClsConfiguration` cmdlet modifies existing instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsRegion.md similarity index 85% rename from skype/skype-ps/skype/Set-CsClsRegion.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClsRegion.md index 89a4dee70b..0caa65d7db 100644 --- a/skype/skype-ps/skype/Set-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClsRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclsregion +schema: 2.0.0 +title: Set-CsClsRegion --- # Set-CsClsRegion @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClsRegion -Identity "global/US" -SecurityGroupSuffix "USSupport" ``` @@ -57,30 +58,16 @@ The command shown in Example 1 changes the security group suffix for the region ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,6 +77,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the region. Region Identities consist of the centralized logging configuration scope where the region was created plus a unique region name. For example, to refer to a global region named Redmond use this syntax: @@ -99,8 +89,7 @@ For example, to refer to a global region named Redmond use this syntax: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -110,13 +99,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,13 +117,15 @@ Accept wildcard characters: False ``` ### -OtherRegionAccess + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of an additional region that can be accessed by authorized users for this region. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,13 +135,15 @@ Accept wildcard characters: False ``` ### -SecurityGroupSuffix + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suffix to be added to the end of the name of any security group that will be authorized for this region. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +153,34 @@ Accept wildcard characters: False ``` ### -Sites + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Sites contained within this region. These correspond to the SideId attribute values in the topology document. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -175,13 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -195,13 +212,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated The `Set-CsClsRegion` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClsRegion` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsScenario.md similarity index 89% rename from skype/skype-ps/skype/Set-CsClsScenario.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClsScenario.md index 156d2a64db..a2fd2f1c9f 100644 --- a/skype/skype-ps/skype/Set-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsScenario.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClsScenario -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclsscenario +schema: 2.0.0 +title: Set-CsClsScenario --- # Set-CsClsScenario @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $provider = New-CsClsProvider -Name "WebInfrastructure" -Type "WPP" -Level "Warning" -Flags "All" @@ -62,7 +63,7 @@ The second command in the example then adds this new provider to the scenario si Because the command uses the syntax `@{Add=$provider}` the new provider will be added to the WAC scenario in addition to any other providers already configured for that. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $provider = New-CsClsProvider -Name "WebInfrastructure" -Type "WPP" -Level "Warning" -Flags "All" @@ -76,30 +77,16 @@ This is done by using the syntax `@{Replace=$provider}`. ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +96,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the scenario to be modified. A scenario consists of two parts: the scope where the scenario is configured (that is, the collection of centralized logging configuration settings where the scenario can be found) and the scenario name. For example: @@ -118,8 +108,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -129,13 +118,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +136,9 @@ Accept wildcard characters: False ``` ### -Provider + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Logging provider for the scenario. New providers must be created using the `New-CsClsProvider` cmdlet. For example: @@ -154,8 +148,25 @@ For example: ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -165,13 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,13 +198,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated The `Set-CsClsScenario` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClsScenario` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsClsSearchTerm.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsSearchTerm.md similarity index 87% rename from skype/skype-ps/skype/Set-CsClsSearchTerm.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClsSearchTerm.md index f3cb33712c..9be8f9017b 100644 --- a/skype/skype-ps/skype/Set-CsClsSearchTerm.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsSearchTerm.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclssearchterm applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClsSearchTerm -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclssearchterm +schema: 2.0.0 +title: Set-CsClsSearchTerm --- # Set-CsClsSearchTerm @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClsSearchTerm -Identity "site:Redmond/IP" -Inserts "ItemURI" ``` @@ -60,30 +61,16 @@ In this example, a single Insert is configured: ItemURI. ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -93,6 +80,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the search term to be modified. A search term consists of two parts: the scope where the term is configured (that is, the collection of centralized logging configuration settings where the term can be found) and the term name. For example: @@ -104,8 +94,7 @@ You cannot use wildcards when specifying the Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,6 +104,9 @@ Accept wildcard characters: False ``` ### -Inserts + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specify how personally identifiable information is masked when viewing the log files. For example, the Insert "ItemURI" indicates that user URI information should be masked. As a result, a user URI such as sip:kenmyer@litwareinc.com will appear as a generic URI that hides the user name but preserve the domain name: @@ -126,8 +118,7 @@ Inserts mask such things as user names and computer names; phone numbers; and IP ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,13 +128,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,14 +145,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -173,13 +186,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SearchTerm#Decorated The `Set-CsClsSearchTerm` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SearchTerm#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClsSearchTerm` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SearchTerm#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsSecurityGroup.md similarity index 89% rename from skype/skype-ps/skype/Set-CsClsSecurityGroup.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClsSecurityGroup.md index a0d8f37e29..7823290fb5 100644 --- a/skype/skype-ps/skype/Set-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsSecurityGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClsSecurityGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclssecuritygroup +schema: 2.0.0 +title: Set-CsClsSecurityGroup --- # Set-CsClsSecurityGroup @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClsSecurityGroup -Identity "global/HelpDesk" -AccessLevel "Tier3" ``` @@ -56,7 +57,7 @@ The command shown in Example 1 modifies the centralized logging security group t In this example, the AccessLevel property is set to Tier3. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsSecurityGroup -Filter "global/*" | Set-CsClsSecurityGroup-AccessLevel "Tier3" ``` @@ -66,7 +67,7 @@ To do this, the command first calls the `Get-CsClsSecurityGroup` cmdlet along wi Those groups are then piped to the `Set-CsClsSecurityGroup` cmdlet, which sets the AccessLevel property of each group to Tier3. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsSecurityGroup | Where-Object {$_.AccessLevel -eq "GlobalAccess"} | Set-CsClsSecurityGroup -AccessLevel "Tier3" ``` @@ -80,6 +81,9 @@ In turn, those groups are piped to the `Set-CsClsSecurityGroup` cmdlet, which ta ## PARAMETERS ### -AccessLevel + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + String value specifying the access level assigned to the group. Access levels are assigned by administrators and used to categorize security groups. For example: @@ -93,8 +97,7 @@ Currently the only values that have meaning are "Tier3", "Tier2", "Product", "Op ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,30 +106,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +125,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the centralized logging security group to be modified. A security group identity consists of the scope where the group was created followed by the group name. For example, to modify a group named HelpDesk created at the global scope, use the following syntax: @@ -145,8 +137,7 @@ For example, to modify a group named HelpDesk created at the global scope, use t ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -156,13 +147,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,14 +164,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -192,13 +205,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated The `Set-CsClsSecurityGroup` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClsSecurityGroup` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Set-CsCommonAreaPhone.md similarity index 86% rename from skype/skype-ps/skype/Set-CsCommonAreaPhone.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCommonAreaPhone.md index 0339c1c04d..6ece411f50 100644 --- a/skype/skype-ps/skype/Set-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCommonAreaPhone.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCommonAreaPhone -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscommonareaphone +schema: 2.0.0 +title: Set-CsCommonAreaPhone --- # Set-CsCommonAreaPhone @@ -53,7 +54,7 @@ See the help topic for the `Set-CsClientPolicy` cmdlet for more information. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsCommonAreaPhone -Filter {LineUri -eq "tel:+14255556710"} | Set-CsCommonAreaPhone -DisplayName "Employee Lounge" ``` @@ -63,7 +64,7 @@ To do this, the `Get-CsCommonAreaPhone` cmdlet is first called along with the Fi The returned object is then piped to the `Set-CsCommonAreaPhone` cmdlet, which sets the value of the DisplayName property to "Employee Lounge". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsCommonAreaPhone | Set-CsCommonAreaPhone -Enabled $True ``` @@ -73,7 +74,7 @@ To carry out this task, the command calls the `Get-CsCommonAreaPhone` cmdlet wit This collection is then piped to the `Set-CsCommonAreaPhone` cmdlet, which takes each item in the collection and sets the Enabled property to True. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsCommonAreaPhone -Filter {Description -eq $Null} | Set-CsCommonAreaPhone -Description "Common area phone" ``` @@ -85,55 +86,17 @@ This filtered collection is then piped to the `Set-CsCommonAreaPhone` cmdlet, wh ## PARAMETERS -### -Identity -Unique identifier for the common area phone. -Common area phones are identified using the Active Directory distinguished name of the associated contact object. -By default, common area phones use a globally unique identifier (GUID) as their common name; that means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. -Because of that you might find it easier to retrieve common area phones by using the `Get-CsCommonAreaPhone` cmdlet, and then piping the returned objects to the `Set-CsCommonAreaPhone` cmdlet. - - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Enabled -Indicates whether or not the contact object for the common area phone has been enabled for Skype for Business Server. - -If you disable a contact by using the Enabled parameter, the information associated with that account (including assigned policies and whether or not the contact is enabled for Enterprise Voice, remote call control and/or voice mail integration) is retained. -If you later re-enable the account by using the Enabled parameter, the associated account information will be restored. +### -Description +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```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 -``` - -### -Description Enables you to modify the Active Directory description attribute for the common area phone. This provides a way to supply additional information about the phone; for example, you might provide details about who to contact in case of problems with the phone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,13 +106,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to modify the Active Directory display name of the common area phone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +124,9 @@ Accept wildcard characters: False ``` ### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number as displayed in Skype for Business. The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234 and so on. When choosing a display number, keep in mind that this number will be shown on the display screen of the common area phone only if the number can be normalized. @@ -168,8 +136,7 @@ When choosing a display number, keep in mind that this number will be shown on t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +146,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to modify contact information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (FQDN); for example: atl-mcs-001.litwareinc.com. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,15 +164,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnterpriseVoiceEnabled -Indicates whether the contact object for the common area phone has been enabled for Enterprise Voice, the Voice over Internet Protocol (VoIP) solution offered by Microsoft. -With Enterprise Voice, telephone calls can be made using the Internet rather than using the standard telephone network. +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the contact object for the common area phone has been enabled for Skype for Business Server. + +If you disable a contact by using the Enabled parameter, the information associated with that account (including assigned policies and whether or not the contact is enabled for Enterprise Voice, remote call control and/or voice mail integration) is retained. +If you later re-enable the account by using the Enabled parameter, the associated account information will be restored. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: CsEnabled Required: False Position: Named @@ -212,17 +186,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -Unique identifier that allows the common area phone to communicate with SIP devices such as Skype for Business. -The SIP address must be prefaced by the prefix sip: and include a valid SIP domain. -For example: sip:bldg14lobby@litwareinc.com. +### -EnterpriseVoiceEnabled +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the contact object for the common area phone has been enabled for Enterprise Voice, the Voice over Internet Protocol (VoIP) solution offered by Microsoft. +With Enterprise Voice, telephone calls can be made using the Internet rather than using the standard telephone network. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,14 +205,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns an object representing the common area phone. +### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the contact's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving + ```yaml -Type: SwitchParameter +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,14 +233,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the common area phone. +Common area phones are identified using the Active Directory distinguished name of the associated contact object. +By default, common area phones use a globally unique identifier (GUID) as their common name; that means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. +Because of that you might find it easier to retrieve common area phones by using the `Get-CsCommonAreaPhone` cmdlet, and then piping the returned objects to the `Set-CsCommonAreaPhone` cmdlet. + ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the common area phone. +The line Uniform Resource Identifier (URI) should be specified using the E.164 format and be prefixed by 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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -263,14 +276,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns an object representing the common area phone. ```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 +Aliases: Required: False Position: Named @@ -279,17 +294,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -Phone number for the common area phone. -The line Uniform Resource Identifier (URI) should be specified using the E.164 format and be prefixed by 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. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier that allows the common area phone to communicate with SIP devices such as Skype for Business. +The SIP address must be prefaced by the prefix sip: and include a valid SIP domain. +For example: sip:bldg14lobby@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 +Aliases: Required: False Position: Named @@ -298,24 +315,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the contact's instant messaging sessions are archived. -Allowed values are: +### -Confirm -Uninitialized +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -UseLyncArchivingPolicy +Prompts you for confirmation before executing the command. -ArchivingToExchange +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -NoArchiving +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -329,12 +356,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact + ## OUTPUTS -### +### None By default, the `Set-CsCommonAreaPhone` cmdlet does not return any objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. diff --git a/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceDisclaimer.md similarity index 83% rename from skype/skype-ps/skype/Set-CsConferenceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConferenceDisclaimer.md index 161abd1d7d..a857a327bf 100644 --- a/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConferenceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconferencedisclaimer +schema: 2.0.0 +title: Set-CsConferenceDisclaimer --- # Set-CsConferenceDisclaimer @@ -44,7 +45,7 @@ The `Set-CsConferenceDisclaimer` cmdlet enables you to modify the conference dis ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsConferenceDisclaimer -Header "Litwareinc.com Online Conference" -Body "Important note: Conferencing proceedings are recorded and archived." ``` @@ -55,49 +56,52 @@ Because you can have only one such disclaimer, you do not need to specify the Id ## PARAMETERS -### -Identity -Unique Identity of the conference disclaimer. -Because you can only have a single, global instance of the conference disclaimer, you do not need to specify an Identity when calling the `Set-CsConferenceDisclaimer` cmdlet. -However, you can use the following syntax to reference the global disclaimer: `-Identity global`. +### -Body +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Contents of the conference disclaimer. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Body -Contents of the conference disclaimer. +### -Header + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Title given the conference disclaimer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,46 +110,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Header -Title given the conference disclaimer. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique Identity of the conference disclaimer. +Because you can only have a single, global instance of the conference disclaimer, you do not need to specify an Identity when calling the `Set-CsConferenceDisclaimer` cmdlet. +However, you can use the following syntax to reference the global disclaimer: `-Identity global`. + ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -154,14 +167,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -175,13 +190,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer object. +### Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer + The `Set-CsConferenceDisclaimer` cmdlet accepts pipelined input of conference disclaimer objects. ## OUTPUTS -### +### None The `Set-CsConferenceDisclaimer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer object. diff --git a/skype/skype-ps/skype/Set-CsConferenceServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceServer.md similarity index 80% rename from skype/skype-ps/skype/Set-CsConferenceServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConferenceServer.md index b10649feaa..99debc19ec 100644 --- a/skype/skype-ps/skype/Set-CsConferenceServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferenceserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConferenceServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconferenceserver +schema: 2.0.0 +title: Set-CsConferenceServer --- # Set-CsConferenceServer @@ -36,7 +37,7 @@ You can also use the `Set-CsConferenceServer` cmdlet to associate a given server ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsConferenceServer -Identity "ConferencingServer:atl-cs-001.litwareinc.com" -ImSipPort 5075 ``` @@ -45,7 +46,7 @@ The command shown in Example 1 modifies the instant messaging SIP port for the C In this example, the port is changed to 5075. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -ConferencingServer | ForEach-Object {Set-CsConferenceServer -Identity $_.Identity -ImSipPort 5075} ``` @@ -57,36 +58,18 @@ That collection is then piped to the `ForEach-Object` cmdlet, which runs the `Se ## PARAMETERS -### -Identity -Service location of the Conference Server to be modified. -For example: `-Identity "ConferencingServer:atl-cs-001.litwareinc.com"`. - -Note that you can leave off the prefix "ConferencingServer:" when specifying a Conference Server. -For example: `-Identity "atl-cs-001.litwareinc.com"`. - - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AppSharingPortCount -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AppSharingSipPort -SIP port used to listen for requests for application sharing. -The ports actually used for application sharing are configured using AppSharingPortStart and AppSharingPortCount. +Total number of ports allocated for application sharing. +The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. +For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100, then ports 60000 through 60099 will be used for application sharing. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -95,16 +78,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppSharingPortCount -Total number of ports allocated for application sharing. -The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. -For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100, then ports 60000 through 60099 will be used for application sharing. +### -AppSharingPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First port in the range of media ports allocated for application sharing. +For example: `-AppSharingPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,15 +97,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppSharingPortStart -First port in the range of media ports allocated for application sharing. -For example: `-AppSharingPortStart 60000`. +### -AppSharingSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used to listen for requests for application sharing. +The ports actually used for application sharing are configured using AppSharingPortStart and AppSharingPortCount. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +117,9 @@ Accept wildcard characters: False ``` ### -AudioPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100, then ports 60000 through 60099 will be used for audio traffic. @@ -138,8 +127,7 @@ For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,14 +137,16 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of media ports allocated for sending and receiving audio traffic. For example: `-AudioPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,14 +156,16 @@ Accept wildcard characters: False ``` ### -AudioVideoSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used to listen for incoming requests for audio and video service. The ports actually used for audio and video traffic are configured using AudioPortCount, AudioPortStart, VideoPortCount and VideoPortStart. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,13 +175,15 @@ Accept wildcard characters: False ``` ### -DataPsomPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Data port used by the Persistent Shared Object Model (PSOM) protocol. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,14 +193,34 @@ Accept wildcard characters: False ``` ### -EdgeServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Edge Server to be associated with the Conference Server. For example: `-EdgeServer "EdgeServer:atl-edge-001.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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -215,14 +229,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Conference Server to be modified. +For example: `-Identity "ConferencingServer:atl-cs-001.litwareinc.com"`. + +Note that you can leave off the prefix "ConferencingServer:" when specifying a Conference Server. +For example: `-Identity "atl-cs-001.litwareinc.com"`. + + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ImSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for instant messaging traffic. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -232,13 +271,15 @@ Accept wildcard characters: False ``` ### -MeetingPsomPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for the Persistent Shared Object Model (PSOM) protocol, a Microsoft protocol used for conferences. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,13 +289,15 @@ Accept wildcard characters: False ``` ### -PhoneSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for telephony traffic. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,6 +307,9 @@ Accept wildcard characters: False ``` ### -VideoPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for sending and receiving video traffic. The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100, then ports 60000 through 60099 will be used for video traffic. @@ -271,8 +317,7 @@ For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -282,14 +327,16 @@ Accept wildcard characters: False ``` ### -VideoPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for sending and receiving video traffic. For example: `-VideoPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -298,14 +345,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -315,29 +364,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -351,13 +386,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsConferenceServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsConferenceServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayConferenceServer object. diff --git a/skype/skype-ps/skype/Set-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConferencingConfiguration.md index 6af69082b4..acc6e66bd0 100644 --- a/skype/skype-ps/skype/Set-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconferencingconfiguration +schema: 2.0.0 +title: Set-CsConferencingConfiguration --- # Set-CsConferencingConfiguration @@ -68,7 +69,7 @@ After these custom settings have been created, you can modify any of them (or mo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsConferencingConfiguration -Identity global -Organization Litwareinc ``` @@ -77,7 +78,7 @@ In Example 1, the `Set-CsConferencingConfiguration` cmdlet modifies the global i This is done by including the Organization parameter followed by the organization name: Litwareinc. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingConfiguration | Set-CsConferencingConfiguration -Organization Litwareinc ``` @@ -87,7 +88,7 @@ To do this the command first uses the `Get-CsConferencingConfiguration` cmdlet t This collection is then piped to the `Set-CsConferencingConfiguration` cmdlet, which takes each item in the collection and changes the value of the Organization property to Litwareinc. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingConfiguration -Filter site:* | Set-CsConferencingConfiguration -MaxContentStorageMb 50 ``` @@ -97,7 +98,7 @@ To do this, the command first calls the `Get-CsConferencingConfiguration` cmdlet The filtered collection is then piped to the `Set-CsConferencingConfiguration` cmdlet, which changes the MaxContentStorageMb property value for each item in the collection to 50. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsConferencingConfiguration | Where-Object {$_.MaxContentStorageMb -gt 100} | Set-CsConferencingConfiguration -MaxContentStorageMB 100 ``` @@ -108,7 +109,7 @@ This collection is then piped to the `Where-Object` cmdlet, which picks out thos This filtered collection is then piped to the `Set-CsConferencingConfiguration` cmdlet, which takes each item in the collection and sets the value of the MaxContentStorageMb property to 100. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Set-CsConferencingConfiguration -Identity site:Redmond -ContentGracePeriod "22:00:00" ``` @@ -116,7 +117,7 @@ Set-CsConferencingConfiguration -Identity site:Redmond -ContentGracePeriod "22:0 Example 5 retrieves the conferencing configuration settings for the Redmond site (-Identity site:Redmond) and modifies the value of the ContentGracePeriod property, setting the grace period to 22 hours (22 hours: 00 minutes: 00 seconds). -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsConferencingConfiguration | Where-Object {$_.Organization -ne "Fabrikam"} | Set-CsConferencingConfiguration -Organization Litwareinc ``` @@ -129,46 +130,10 @@ The filtered collection is then piped to the `Set-CsConferencingConfiguration` c ## PARAMETERS -### -Identity -Unique identifier for the collection of conferencing configuration settings to be modified. -To refer to the global collection, use this syntax: `-Identity global`. -To refer to a collection configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. -To refer to a collection at the service scope, use syntax like the following: `-Identity "service:ConferencingServer:atl-cs-001.litwareinc.com"`. -The Web Conferencing service is the only service that can host these configuration settings. - -If this parameter is not specified, then the `Set-CsConferencingConfiguration` cmdlet will automatically modify the global settings. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -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 Server 2015, Skype for Business Server 2019 +### -ClientAppSharingPort -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ClientAppSharingPort Represents the starting port number used for application sharing. The ClientAppSharingPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -176,8 +141,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,6 +151,9 @@ Accept wildcard characters: False ``` ### -ClientAppSharingPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for application sharing. (The default value is 40.) To determine the actual ports used for application sharing, use this value and the ClientAppSharingPort value. For example, if ClientAppSharingPort is set to 5350 and ClientAppSharingPortRange is set to 3, then the following 3 ports are available for application sharing: 5350; 5351; 5352. @@ -194,8 +161,7 @@ For example, if ClientAppSharingPort is set to 5350 and ClientAppSharingPortRang ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +171,9 @@ Accept wildcard characters: False ``` ### -ClientAudioPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client audio. The ClientAudioPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -212,8 +181,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -223,6 +191,9 @@ Accept wildcard characters: False ``` ### -ClientAudioPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client audio. (The default value is 40.) To determine the actual ports used for client audio, use this value and the ClientAudioPort value. For example, if ClientAudioPort is set to 5350 and ClientAudioPortRange is set to 3, then the following three ports are available for client audio: 5350; 5351; 5352. @@ -230,8 +201,7 @@ For example, if ClientAudioPort is set to 5350 and ClientAudioPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,6 +211,9 @@ Accept wildcard characters: False ``` ### -ClientFileTransferPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for file transfers. The ClientFileTransferPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -248,8 +221,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -259,6 +231,9 @@ Accept wildcard characters: False ``` ### -ClientFileTransferPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for file transfers. (The default value is 40.) To determine the actual ports used for file transfers, use this value and the ClientFileTransferPort value. For example, if ClientFileTransferPort is set to 5350 and ClientFileTransferPortRange is set to 3, then the following three ports are available for file transfers: 5350; 5351; 5352. @@ -266,8 +241,7 @@ For example, if ClientFileTransferPort is set to 5350 and ClientFileTransferPort ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,6 +251,9 @@ Accept wildcard characters: False ``` ### -ClientMediaPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client media. Use this parameter for Microsoft Office Communicator 2007 R2 clients. The ClientMediaPort must be a value port number between 1024 and 65535, inclusive. @@ -286,8 +263,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,6 +273,9 @@ Accept wildcard characters: False ``` ### -ClientMediaPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client media. (The default value is 40.) Use this parameter for Office Communicator 2007 R2 clients. To determine the actual ports used for client media, use this value and the ClientMediaPort value. @@ -306,8 +285,7 @@ For example, if ClientMediaPort is set to 5350 and ClientMediaPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -317,14 +295,16 @@ Accept wildcard characters: False ``` ### -ClientMediaPortRangeEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, clients will use the specified port range for media traffic. When set to False (the default value) any available port (from port 1024 through port 65535) will be used to accommodate media traffic. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -334,6 +314,9 @@ Accept wildcard characters: False ``` ### -ClientSipDynamicPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for SIP traffic. The ClientSipDynamicPort must be a value port number between 1024 and 65535, inclusive. The default value is 7100. @@ -341,8 +324,7 @@ The default value is 7100. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -352,6 +334,9 @@ Accept wildcard characters: False ``` ### -ClientSipDynamicPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for SIP traffic. (The default value is 3.) To determine the actual ports used for SIP traffic, use this value and the ClientSipDynamicPort value. For example, if ClientSipDynamicPort is set to 7100 and ClientSipDynamicPortRange is set to 3, then the following 3 ports are available for client media: 7100; 7101; 7102. @@ -359,8 +344,7 @@ For example, if ClientSipDynamicPort is set to 7100 and ClientSipDynamicPortRang ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -370,6 +354,9 @@ Accept wildcard characters: False ``` ### -ClientVideoPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client video. The ClientVideoPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -377,8 +364,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,6 +374,9 @@ Accept wildcard characters: False ``` ### -ClientVideoPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client video. (The default value is 40.) To determine the actual ports used for client video, use this value and the ClientVideoPort value. For example, if ClientVideoPort is set to 5350 and ClientVideoPortRange is set to 3, then the following three ports are available for client video: 5350; 5351; 5352. @@ -395,8 +384,43 @@ For example, if ClientVideoPort is set to 5350 and ClientVideoPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudPollServicePrimaryUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used with Skype for Business Server. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudPollServiceSecondaryUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used with Skype for Business Server. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -406,6 +430,9 @@ Accept wildcard characters: False ``` ### -ConsoleDownloadExternalUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where external users can download a supported client such as Skype for Business. Note that this setting applies only to legacy clients (such as Microsoft Office Communicator 2007 R2) that are logging on to a Skype for Business Server pool. @@ -413,8 +440,7 @@ Note that this setting applies only to legacy clients (such as Microsoft Office ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -424,6 +450,9 @@ Accept wildcard characters: False ``` ### -ConsoleDownloadInternalUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where internal users can download a supported client such as Skype for Business. Note that this setting applies only to legacy clients (such as Microsoft Office Communicator 2007 R2) that are logging on to a Skype for Business Server pool. @@ -431,8 +460,7 @@ Note that this setting applies only to legacy clients (such as Microsoft Office ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -442,6 +470,9 @@ Accept wildcard characters: False ``` ### -ContentGracePeriod + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how long conference content will remain on the server following the end of the conference. The ContentGracePeriod must be specified using the format Days.Hours:Minutes:Seconds. For example, to set the content grace period to 30 days, use this syntax: `-ContentGracePeriod 30.00:00:00`. @@ -453,8 +484,7 @@ The default value is 15 days (15.00:00:00). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -463,30 +493,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpdeskExternalUrl -URL where external users who click Help during a conference will be directed. +### -EncryptArchivedData + +> Applicable: Skype for Business Server 2019 + +Boolean flag to turn on/off encryption for a conference's archived attachments. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpdeskInternalUrl -URL where internal users who click Help during a conference will be directed. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -495,16 +529,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxBandwidthPerAppSharingServiceMb -Indicates the maximum amount of bandwidth (in megabytes) set aside for the Application Sharing Conferencing service. -MaxBandwidthPerAppSharingServiceMb can be set to any integer value between 50 and 100000, inclusive. -The default value is 375 megabytes. +### -HelpdeskExternalUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL where external users who click Help during a conference will be directed. ```yaml -Type: UInt64 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -513,16 +547,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxContentStorageMb -Maximum amount of file space (in megabytes) allowed for the storage of meeting content. -MaxContentStorageMb can be set to any integer value between 50 and 1024 (1 gigabyte), inclusive. -The default value is 500 megabytes. +### -HelpdeskInternalUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL where internal users who click Help during a conference will be directed. ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -531,46 +565,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Organization -Name of the organization hosting the conference. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the collection of conferencing configuration settings to be modified. +To refer to the global collection, use this syntax: `-Identity global`. +To refer to a collection configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. +To refer to a collection at the service scope, use syntax like the following: `-Identity "service:ConferencingServer:atl-cs-001.litwareinc.com"`. +The Web Conferencing service is the only service that can host these configuration settings. + +If this parameter is not specified, then the `Set-CsConferencingConfiguration` cmdlet will automatically modify the global settings. + ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxBandwidthPerAppSharingServiceMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum amount of bandwidth (in megabytes) set aside for the Application Sharing Conferencing service. +MaxBandwidthPerAppSharingServiceMb can be set to any integer value between 50 and 100000, inclusive. +The default value is 375 megabytes. ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -579,14 +628,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxContentStorageMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum amount of file space (in megabytes) allowed for the storage of meeting content. +MaxContentStorageMb can be set to any integer value between 50 and 1024 (1 gigabyte), inclusive. +The default value is 500 megabytes. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -596,6 +649,9 @@ Accept wildcard characters: False ``` ### -MaxUploadFileSizeMb + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum total size of the files (including handouts and PowerPoint slides) that can be used in a given conference. This setting is typically used when conference content is being archived in Microsoft Exchange Server: by setting a maximum upload file size you can ensure that the content used in the conference (and thus the content which must be archived) does not exceed the maximum file size configured for Microsoft Exchange. The default value is 500 megabytes. @@ -603,8 +659,7 @@ The default value is 500 megabytes. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -613,14 +668,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudPollServicePrimaryUrl -This parameter is not currently used with Skype for Business Server. +### -Organization + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the organization hosting the conference. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -629,14 +686,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudPollServiceSecondaryUrl -This parameter is not currently used with Skype for Business Server. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -645,18 +704,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptArchivedData -Boolean flag to turn on/off encryption for a conference's archived attachments. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: wi Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -666,13 +727,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings + The `Set-CsConferencingConfiguration` cmdlet accepts pipelined instances of the conferencing configuration object. ## OUTPUTS -### +### None The `Set-CsConferencingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object. diff --git a/skype/skype-ps/skype/Set-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingPolicy.md similarity index 84% rename from skype/skype-ps/skype/Set-CsConferencingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConferencingPolicy.md index 96b5bc05d9..aef4c610e3 100644 --- a/skype/skype-ps/skype/Set-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingPolicy.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Set-CsConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconferencingpolicy +schema: 2.0.0 +title: Set-CsConferencingPolicy --- # Set-CsConferencingPolicy @@ -87,7 +89,7 @@ The following parameters are not applicable to Skype for Business Online: Applic ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsConferencingPolicy -Identity SalesConferencingPolicy -AllowConferenceRecording $False ``` @@ -96,7 +98,7 @@ The command shown in Example 1 modifies a property value of the conferencing pol To do this, the `Set-CsConferencingPolicy` cmdlet is called along with the Identity parameter and the AllowConferenceRecording parameter. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingPolicy | Set-CsConferencingPolicy -AllowAnonymousParticipantsInMeetings $False -EnableDialInConferencing $False ``` @@ -106,7 +108,7 @@ To do this, the command first uses the `Get-CsConferencingPolicy` cmdlet to retu That collection is then piped to the `Set-CsConferencingPolicy` cmdlet, which sets the value of both the AllowAnonymousParticipantsInMeetings and EnableDialInConferencing properties to False for each policy in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingPolicy -Filter "site:*" | Set-CsConferencingPolicy -MaxVideoConferenceResolution CIF ``` @@ -116,7 +118,7 @@ To accomplish this task the command first calls the `Get-CsConferencingPolicy` c This filtered collection is then piped to the `Set-CsConferencingPolicy` cmdlet, which sets the MaxVideoConferenceResolution property for each policy in the collection to "CIF". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsConferencingPolicy | Where-Object {$_.MaxMeetingSize -gt 100} | Set-CsConferencingPolicy -MaxMeetingSize 100 ``` @@ -129,48 +131,10 @@ The filtered collection is then piped to the `Set-CsConferencingPolicy` cmdlet, ## PARAMETERS -### -Identity -Unique identifier for the conferencing policy to be modified. -Conferencing 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 SalesConferencingPolicy`. - -Note that wildcards are not allowed when specifying an Identity. -If you do not specify an Identity the `Set-CsConferencingPolicy` cmdlet will automatically modify the global conferencing policy. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity, (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: 2 -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 +### -AllowAnnotations -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -AllowAnnotations Indicates whether or not participants are allowed to make on-screen annotations on any content shared during the meeting; in addition, this setting determines whether or not whiteboarding is allowed in the conference. The default value is True. @@ -182,8 +146,7 @@ However, the user can participate in other conferences where annotations are all ```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 +Aliases: Required: False Position: Named @@ -193,6 +156,9 @@ Accept wildcard characters: False ``` ### -AllowAnonymousParticipantsInMeetings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether anonymous users are allowed to participate in the meeting. If set to False then only authenticated users (that is, users logged on to your Active Directory Domain Services or the Active Directory of a federated partner) are allowed to attend the meeting. The default value is True. @@ -204,8 +170,7 @@ However, the user can take part in other conferences where anonymous participant ```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 +Aliases: Required: False Position: Named @@ -215,6 +180,9 @@ Accept wildcard characters: False ``` ### -AllowAnonymousUsersToDialOut + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not anonymous users (for example, unauthenticated users) are allowed to join a conference using dial-out phoning. With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference. @@ -228,8 +196,7 @@ The default value is False ($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 +Aliases: Required: False Position: Named @@ -239,6 +206,9 @@ Accept wildcard characters: False ``` ### -AllowConferenceRecording + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether users are allowed to record the meeting. The default value is False. @@ -247,8 +217,7 @@ This setting applies to all users taking part in the conference. ```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 +Aliases: Required: False Position: Named @@ -258,6 +227,9 @@ Accept wildcard characters: False ``` ### -AllowExternalUserControl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether external users (either anonymous users or federated) are allowed to take control of shared applications or desktops. The default value is False. @@ -268,8 +240,7 @@ That means that some users in a session might be allowed to give up control of a ```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 +Aliases: Required: False Position: Named @@ -278,18 +249,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalUsersToSaveContent -Indicates whether external users (that is, users not currently logged-on to your network) are allowed to save handouts, slides and other meeting content. -The default value is True. +### -AllowExternalUsersToRecordMeeting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether external users (either anonymous users or federated users) are allowed to record the meeting. +The default value is False. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to record conferences. +However, the user can take part in other conferences where external users are allowed to record meetings. + +Note that this setting takes effect only if the AllowConferenceRecording property is set to True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to save content. -However, the user can take part in other conferences where external users are allowed to save content. ```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 +Aliases: Required: False Position: Named @@ -298,18 +274,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPAudio -Indicates whether or not computer audio is allowed in the meeting. +### -AllowExternalUsersToSaveContent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether external users (that is, users not currently logged-on to your network) are allowed to save handouts, slides and other meeting content. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP audio. -However, the user can take part in other conferences where IP audio is allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to save content. +However, the user can take part in other conferences where external users are allowed to save content. ```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 +Aliases: Required: False Position: Named @@ -318,39 +296,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPVideo -Indicates whether or not computer video is allowed in the meeting. -The default value is True. +### -AllowFederatedParticipantJoinAsSameEnterprise + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether a federated user will be directly admitted into conference bypassing the lobby. The default value is False. + +If set to False and AllowAnonymousParticipantsInMeetings parameter is also set to False, federated users will be treated as anonymous users and put into lobby. +If set to True and conference admission policy is set to "Anyone from my organization" or openAuthenticated, federated users are treated as company users and admitted into conference directly. +If set to True and conference admission policy is set to "People I Invite" or closedAuthenticated, federated users will be put into the lobby if they were not present in the pre-set invitee list. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP video. -However, the user can take part in other conferences where IP video is allowed. ```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 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowParticipantControl -Indicates whether or not meeting participants are allowed to take control of applications or desktops shared during the meeting. -The default value is True. +### -AllowIPAudio -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow participant control. -However, the user can take part in other conferences where participant control is allowed. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not computer audio is allowed in the meeting. +The default value is True. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP audio. +However, the user can take part in other conferences where IP audio is allowed. ```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 +Aliases: Required: False Position: Named @@ -359,18 +341,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPolls -Indicates whether or not users are allowed to conduct online polls during a meeting. +### -AllowIPVideo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not computer video is allowed in the meeting. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow polls. -However, the user can take part in other conferences where polls are allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP video. +However, the user can take part in other conferences where IP video is allowed. ```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 +Aliases: Required: False Position: Named @@ -379,18 +363,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserToScheduleMeetingsWithAppSharing -Indicates whether or not users are allowed to organize meetings that include application sharing. -The default value is True. +### -AllowLargeMeetings -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow application sharing. -However, the user can take part in other conferences where application sharing is allowed. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, all online meetings are treated as "large meeting." With a large meeting, restrictions are placed on the number of notifications that are sent to participants as well as the size of the meeting roster that is transmitted by default. + +The default value is False ($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 +Aliases: Required: False Position: Named @@ -399,15 +383,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide additional text about the conferencing policy. -For example, the Description might indicate the users the policy should be assigned to. +### -AllowMultiView + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) enables users to schedule conferences that allow multiview; that is, clients can receive multiple video streams during a given conference. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy can include multiview. +However, the user can participate in other conferences where multiview is allowed. ```yaml -Type: String +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 +Aliases: Required: False Position: Named @@ -416,28 +403,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAppDesktopSharing -Indicates whether participants are allowed to share applications (or their desktop) during the course of a meeting. -Allowed values include: - -Desktop. -Users are allowed to share their entire desktop. +### -AllowNonEnterpriseVoiceUsersToDialOut -SingleApplication. -Users are allowed to share a single application. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -None. -Users are not allowed to share applications or their desktop. +Indicates whether or users who have not been enabled for Enterprise Voice are allowed to join a conference using dial-out phoning. +With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference. +Note that dial-in conferencing is allowed even when this setting is False. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow users who have not been enabled for Enterprise Voice to join the conference via dial-out phoning. +However, the user can take part in other conferences where users who have not been enabled for Enterprise Voice can join via dial out. -The default value is Desktop. +The default value is False ($False). ```yaml -Type: EnableAppDesktopSharing +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 +Aliases: Required: False Position: Named @@ -446,17 +429,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDataCollaboration -Indicates whether users can organize meetings that include data collaboration activities such as whiteboarding and annotations. +### -AllowOfficeContent + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, prevents users from using Office content in their conferences. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow data collaboration. -However, the user can take part in other conferences where data collaboration is allowed. ```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 +Aliases: Required: False Position: Named @@ -465,20 +448,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDialInConferencing -This parameter is not available in Skype for Business Online. +### -AllowParticipantControl -Indicates whether users are able to join the meeting by dialing in with a public switched telephone network (PSTN) telephone. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not meeting participants are allowed to take control of applications or desktops shared during the meeting. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow dial-in conferencing. -However, the user can take part in other conferences where dial-in conferencing is allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow participant control. +However, the user can take part in other conferences where participant control is allowed. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -487,18 +471,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFileTransfer -Indicates whether file transfers to all the meeting participants are allowed during the meeting. +### -AllowPolls + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not users are allowed to conduct online polls during a meeting. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow file transfers. -However, the user can take part in other conferences where file transfers are allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow polls. +However, the user can take part in other conferences where polls are allowed. ```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 +Aliases: Required: False Position: Named @@ -507,18 +493,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PFileTransfer -Indicates whether peer-to-peer file transfers (that is, file transfers that do not involve all participants) are allowed during the meeting. -The default value is True ($True). +### -AllowQandA + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the user will be able to include the Questions and Answers Manager in any online conference that he or she organizes. +When set to False, the user will be prohibited from including Questions and Answers Manager in any of his or her conferences. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow the use of the Questions and Answers Manager. +However, the user can make use of the Questions and Answers Manager in other conferences where polls are allowed. -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to transfer files while the other user is not. ```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 +Aliases: Required: False Position: Named @@ -527,19 +516,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PRecording -If True, users will be able to record peer-to-peer communication sessions. -The default value is False. +### -AllowSharedNotes -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to record the session while the other user is not. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True (the default value) any open OneNote notebooks linked to the conference will automatically be updated with information such as conference participants and details about content shared during the conference. ```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 +Aliases: Required: False Position: Named @@ -548,19 +534,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PVideo -If True, users will be able to take part in peer-to-peer video communication sessions. -The default value is False. +### -AllowUserToScheduleMeetingsWithAppSharing -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to use video while the other user is not. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not users are allowed to organize meetings that include application sharing. +The default value is True. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow application sharing. +However, the user can take part in other conferences where application sharing is allowed. ```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 +Aliases: Required: False Position: Named @@ -569,23 +556,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxMeetingSize -Indicates the maximum number of people who are allowed to attend a meeting. -After the maximum number of participants has been reached anyone else who tries to join the meeting will be turned away with the notice that the meeting is full. -The number of participants specified in this value can be any 32-bit whole number (any value between 1 and 4,294,967,295), but the recommended size is between 2 and 250, inclusive; the default value is 250. +### -ApplicationSharingMode -250 is the maximum for shared pool deployments, based on Microsoft testing. -For information about supporting meeting with more than 250 participants, see "Microsoft Lync Server 2010 Support for Large Meetings" at https://go.microsoft.com/fwlink/p/?linkId=242073 (https://go.microsoft.com/fwlink/p/?linkId=242073). +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: no conference created by a user affected by this policy will allow more than the specified number of participants. -However, the user can take part in other conferences where additional participants are allowed. +Determines the protocol used for screen sharing - VbSS vs RDP. This parameter is used only in SfB Server. To disable VbSS, use the value "RDP". ```yaml -Type: UInt32 +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 +Aliases: Required: False Position: Named @@ -594,23 +575,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxVideoConferenceResolution -Indicates the maximum resolution for meeting video. -Allowed values are: +### -AppSharingBitRateKb -CIF. -Common Intermediate Format (CIF) has a resolution of 352 pixels by 288 pixels. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -VGA. -VGA has a resolution of 640 pixels by 480 pixels. +Bit rate (in kilobits) used for application sharing. +The default value is 50000. -The default value is VGA. ```yaml -Type: MaxVideoConferenceResolution +Type: Int64 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 +Aliases: Required: False Position: Named @@ -619,14 +595,20 @@ 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. +### -AudioBitRateKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Bit rate (in kilobits) used for audio transmissions. +The audio bit rate can be any whole number between 20 and 200, inclusive; the default value is 200. + +This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. + ```yaml -Type: SwitchParameter +Type: UInt32 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 +Aliases: Required: False Position: Named @@ -635,14 +617,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -CloudRecordingServiceSupport -```yaml -Type: SwitchParameter +> Applicable: Skype for Business Online + +PARAMVALUE: NotSupported | Supported | Required + +```yaml +Type: CloudRecordingServiceSupport 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 +Aliases: Required: False Position: Named @@ -651,14 +635,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text about the conferencing policy. +For example, the Description might indicate the users the policy should be assigned to. ```yaml -Type: SwitchParameter +Type: String 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 +Aliases: Required: False Position: Named @@ -667,21 +654,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalUsersToRecordMeeting -Indicates whether external users (either anonymous users or federated users) are allowed to record the meeting. -The default value is False. - -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to record conferences. -However, the user can take part in other conferences where external users are allowed to record meetings. +### -DisablePowerPointAnnotations -Note that this setting takes effect only if the AllowConferenceRecording property is set to True. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True) users will not be able to add annotations to PowerPoint slides used in a conference. +However (depending on the value of the AllowAnnotations property), users will still have access to other whiteboarding features. +The default value is False, meaning that PowerPoint annotations are allowed. ```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 +Aliases: Required: False Position: Named @@ -690,16 +674,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppSharingBitRateKb -Bit rate (in kilobits) used for application sharing. -The default value is 50000. +### -EnableAppDesktopSharing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether participants are allowed to share applications (or their desktop) during the course of a meeting. +Allowed values include: + +Desktop. +Users are allowed to share their entire desktop. +SingleApplication. +Users are allowed to share a single application. + +None. +Users are not allowed to share applications or their desktop. + + + +The default value is Desktop. ```yaml -Type: Int64 +Type: EnableAppDesktopSharing 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 +Aliases: Required: False Position: Named @@ -708,18 +706,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioBitRateKb -Bit rate (in kilobits) used for audio transmissions. -The audio bit rate can be any whole number between 20 and 200, inclusive; the default value is 200. +### -EnableDataCollaboration -This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether users can organize meetings that include data collaboration activities such as whiteboarding and annotations. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow data collaboration. +However, the user can take part in other conferences where data collaboration is allowed. ```yaml -Type: UInt32 +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 +Aliases: Required: False Position: Named @@ -728,18 +727,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileTransferBitRateKb -Bit rate (in kilobits) used for file transfers. -The default value is 50000. +### -EnableDialInConferencing -This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +This parameter is not available in Skype for Business Online. + +Indicates whether users are able to join the meeting by dialing in with a public switched telephone network (PSTN) telephone. +The default value is True. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow dial-in conferencing. +However, the user can take part in other conferences where dial-in conferencing is allowed. ```yaml -Type: Int64 +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 +Aliases: Required: False Position: Named @@ -748,18 +751,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoBitRateKb -Bit rate (in kilobits) used for video transmissions. -The default value is 50000. +### -EnableFileTransfer -This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether file transfers to all the meeting participants are allowed during the meeting. +The default value is True. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow file transfers. +However, the user can take part in other conferences where file transfers are allowed. ```yaml -Type: Int64 +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 +Aliases: Required: False Position: Named @@ -768,16 +773,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowLargeMeetings -When set to True, all online meetings are treated as "large meeting." With a large meeting, restrictions are placed on the number of notifications that are sent to participants as well as the size of the meeting roster that is transmitted by default. +### -EnableMultiViewJoin -The default value is False ($False). +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) clients will attempt to join a conference using multiview (which allows the client to receive multiple video streams during the conference). +This parameter will be ignored if multiview is not allowed in the conference being joined. +This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. +That means that some users in a session might be allowed to have multiple video streams while other users in the same conference might not. ```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 +Aliases: Required: False Position: Named @@ -786,16 +794,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMultiView -When set to True (the default value) enables users to schedule conferences that allow multiview; that is, clients can receive multiple video streams during a given conference. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy can include multiview. -However, the user can participate in other conferences where multiview is allowed. +### -EnableOnlineMeetingPromptForLyncResources + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users will be prompted any time they schedule a meeting in Outlook that includes invitees (such as a meeting room) that would benefit from having the meeting held online. +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 +Aliases: Required: False Position: Named @@ -804,22 +813,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNonEnterpriseVoiceUsersToDialOut -Indicates whether or users who have not been enabled for Enterprise Voice are allowed to join a conference using dial-out phoning. -With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference. +### -EnableP2PFileTransfer -Note that dial-in conferencing is allowed even when this setting is False. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow users who have not been enabled for Enterprise Voice to join the conference via dial-out phoning. -However, the user can take part in other conferences where users who have not been enabled for Enterprise Voice can join via dial out. +Indicates whether peer-to-peer file transfers (that is, file transfers that do not involve all participants) are allowed during the meeting. +The default value is True ($True). -The default value is False ($False). +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to transfer files while the other user is not. ```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 +Aliases: Required: False Position: Named @@ -828,14 +835,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedNotes -When set to True (the default value) any open OneNote notebooks linked to the conference will automatically be updated with information such as conference participants and details about content shared during the conference. +### -EnableP2PRecording + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, users will be able to record peer-to-peer communication sessions. +The default value is False. + +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to record the session while the other user is not. + ```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 +Aliases: Required: False Position: Named @@ -844,16 +858,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisablePowerPointAnnotations -When set to True ($True) users will not be able to add annotations to PowerPoint slides used in a conference. -However (depending on the value of the AllowAnnotations property), users will still have access to other whiteboarding features. -The default value is False, meaning that PowerPoint annotations are allowed. +### -EnableP2PVideo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, users will be able to take part in peer-to-peer video communication sessions. +The default value is False. + +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to use video while the other user is not. + ```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 +Aliases: Required: False Position: Named @@ -862,17 +881,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMultiViewJoin -When set to True (the default value) clients will attempt to join a conference using multiview (which allows the client to receive multiple video streams during the conference). -This parameter will be ignored if multiview is not allowed in the conference being joined. -This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. -That means that some users in a session might be allowed to have multiple video streams while other users in the same conference might not. +### -EnableReliableConferenceDeletion + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to true, the conference state is removed from all replicas when the user deletes it, to provide instantaneous consistency of distributed conference state. +If set to false, the deleted conference state is eventual and not instantaneous. ```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 +Aliases: Required: False Position: Named @@ -881,16 +900,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TotalReceiveVideoBitRateKb -Indicates the maximum allowed bitrate (in kilobytes per second) for all the video used in a conference; that is, the combined total for all the video streams. -The default value is 50000 kilobits per second. +### -FileTransferBitRateKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Bit rate (in kilobits) used for file transfers. +The default value is 50000. + +This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -899,57 +922,88 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowFederatedParticipantJoinAsSameEnterprise -Indicates whether a federated user will be directly admitted into conference bypassing the lobby. The default value is False. +### -Force -If set to False and AllowAnonymousParticipantsInMeetings parameter is also set to False, federated users will be treated as anonymous users and put into lobby. -If set to True and conference admission policy is set to "Anyone from my organization" or openAuthenticated, federated users are treated as company users and admitted into conference directly. -If set to True and conference admission policy is set to "People I Invite" or closedAuthenticated, federated users will be put into the lobby if they were not present in the pre-set invitee list. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOfficeContent -When set to False, prevents users from using Office content in their conferences. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the conferencing policy to be modified. +Conferencing 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 SalesConferencingPolicy`. + +Note that wildcards are not allowed when specifying an Identity. +If you do not specify an Identity the `Set-CsConferencingPolicy` cmdlet will automatically modify the global conferencing policy. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowQandA -When set to True (the default value) the user will be able to include the Questions and Answers Manager in any online conference that he or she organizes. -When set to False, the user will be prohibited from including Questions and Answers Manager in any of his or her conferences. +### -Instance -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow the use of the Questions and Answers Manager. -However, the user can make use of the Questions and Answers Manager in other conferences where polls are allowed. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxMeetingSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of people who are allowed to attend a meeting. +After the maximum number of participants has been reached anyone else who tries to join the meeting will be turned away with the notice that the meeting is full. +The number of participants specified in this value can be any 32-bit whole number (any value between 1 and 4,294,967,295), but the recommended size is between 2 and 250, inclusive; the default value is 250. + +250 is the maximum for shared pool deployments, based on Microsoft testing. +For information about supporting meeting with more than 250 participants, see "Microsoft Lync Server 2010 Support for Large Meetings" at https://go.microsoft.com/fwlink/p/?linkId=242073 (https://go.microsoft.com/fwlink/p/?linkId=242073). + +This setting applies to the user who organizes the conference: no conference created by a user affected by this policy will allow more than the specified number of participants. +However, the user can take part in other conferences where additional participants are allowed. + + +```yaml +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -958,15 +1012,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationSharingMode -Determines the protocol used for screen sharing - VbSS vs RDP. This parameter is used only in SfB Server. To disable VbSS, use the value "RDP". +### -MaxVideoConferenceResolution + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum resolution for meeting video. +Allowed values are: + +CIF. +Common Intermediate Format (CIF) has a resolution of 352 pixels by 288 pixels. + +VGA. +VGA has a resolution of 640 pixels by 480 pixels. +The default value is VGA. ```yaml -Type: String +Type: MaxVideoConferenceResolution Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -975,14 +1039,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudRecordingServiceSupport -PARAMVALUE: NotSupported | Supported | Required +### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the conferencing 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: CloudRecordingServiceSupport +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -991,15 +1065,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineMeetingPromptForLyncResources -When set to True, users will be prompted any time they schedule a meeting in Outlook that includes invitees (such as a meeting room) that would benefit from having the meeting held online. -The default value is False. +### -TotalReceiveVideoBitRateKb + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum allowed bitrate (in kilobytes per second) for all the video used in a conference; that is, the combined total for all the video streams. +The default value is 50000 kilobits per second. + ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1008,15 +1085,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReliableConferenceDeletion -When set to true, the conference state is removed from all replicas when the user deletes it, to provide instantaneous consistency of distributed conference state. -If set to false, the deleted conference state is eventual and not instantaneous. +### -VideoBitRateKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Bit rate (in kilobits) used for video transmissions. +The default value is 50000. + +This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. + ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1025,22 +1107,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the conferencing policy is being modified. -For example: +### -Confirm -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +Prompts you for confirmation before executing the command. -`Get-CsTenant | Select-Object DisplayName, TenantID` +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -1054,13 +1148,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy + The `Set-CsConferencingPolicy` cmdlet accepts pipelined instances of the meeting policy object. ## OUTPUTS -### +### None The `Set-CsConferencingPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. diff --git a/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md b/skype/skype-ps/SkypeForBusiness/Set-CsConfigurationStoreLocation.md similarity index 84% rename from skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConfigurationStoreLocation.md index e52a31a523..8e0c4719a6 100644 --- a/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConfigurationStoreLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconfigurationstorelocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConfigurationStoreLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconfigurationstorelocation +schema: 2.0.0 +title: Set-CsConfigurationStoreLocation --- # Set-CsConfigurationStoreLocation @@ -39,7 +40,7 @@ The cmdlet then sets the store location to the FQDN of that computer. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsConfigurationStoreLocation -SqlServerFqdn atl-sql-001.litwareinc.com -SqlInstanceName Rtc ``` @@ -48,7 +49,7 @@ The command shown in Example 1 sets the Active Directory service control point f In this example, the SCP points to the computer atl-sql-001.litwareinc.com and to the SQL Server instance Rtc. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsConfigurationStoreLocation -SqlServerFqdn atl-sql-001.litwareinc.com -SqlInstanceName Rtc -Report C:\Logs\Store_Location.html ``` @@ -61,17 +62,18 @@ This log is generated by including the Report parameter followed by the full pat ## PARAMETERS -### -SqlServerFqdn -Fully qualified domain name (FQDN) of the computer where the Central Management store has been installed. -For example: `-SqlServer atl-sql-001.litwareinc.com`. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -79,6 +81,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the Active Directory System container, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -86,8 +91,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,16 +100,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -Name of the SQL Server instance containing the Skype for Business Server tables and data. +### -MirrorSqlInstanceName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the SQL Server instance containing the Skype for Business Server mirror database tables and data. For example: `-SqlInstanceName "rtc"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,18 +120,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipLookup -If this parameter is included then the `Set-CsConfigurationStoreLocation` cmdlet will not verify that the specified computer and the specified instance of SQL Server are available. -Instead, it will simply change the service control point. +### -MirrorSqlServerFqdn -If this parameter is not included then both the specified computer and the specified instance of SQL Server must be available before the SCP will be changed. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the computer where the Central Management store mirror database has been installed. +For example: `-SqlServer atl-mirror-001.litwareinc.com`. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,14 +139,17 @@ 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. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\ConfigurationStore.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,15 +158,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\ConfigurationStore.html"` +### -SkipLookup + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is included then the `Set-CsConfigurationStoreLocation` cmdlet will not verify that the specified computer and the specified instance of SQL Server are available. +Instead, it will simply change the service control point. + +If this parameter is not included then both the specified computer and the specified instance of SQL Server must be available before the SCP will be changed. + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,14 +180,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SqlInstanceName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the SQL Server instance containing the Skype for Business Server tables and data. +For example: `-SqlInstanceName "rtc"`. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,32 +200,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SqlServerFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the computer where the Central Management store has been installed. +For example: `-SqlServer atl-sql-001.litwareinc.com`. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MirrorSqlInstanceName -Name of the SQL Server instance containing the Skype for Business Server mirror database tables and data. -For example: `-SqlInstanceName "rtc"`. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -217,15 +237,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MirrorSqlServerFqdn -Fully qualified domain name (FQDN) of the computer where the Central Management store mirror database has been installed. -For example: `-SqlServer atl-mirror-001.litwareinc.com`. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -239,13 +260,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsConfigurationStoreLocation` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsConfigurationStoreLocation` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsConversationHistoryConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConversationHistoryConfiguration.md index 4852521547..02d91e4439 100644 --- a/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConversationHistoryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconversationhistoryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConversationHistoryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconversationhistoryconfiguration +schema: 2.0.0 +title: Set-CsConversationHistoryConfiguration --- # Set-CsConversationHistoryConfiguration @@ -42,7 +43,7 @@ However, the global settings can be modified by using the `Set-CsConversationHis ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsConversationHistoryConfiguration -Identity "global" -EnableServerConversationHistory $True ``` @@ -51,7 +52,7 @@ In Example 1, the EnableServerConversationHistory property is set to True ($True In turn, conversation histories, missed call notifications, and missed IM notifications will be stored on the server rather than in client mailboxes. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsConversationHistoryConfiguration -Identity "global" -CachedUserThreshold 2000000 ``` @@ -62,14 +63,16 @@ The command shown in Example 2 modifies the global collection of conversation hi ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableDisplayNameResolution + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,14 +82,16 @@ Accept wildcard characters: False ``` ### -EnableServerConversationHistory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True), conversation histories and related information will be stored on the server. The default value is False, which means that this information is stored in user mailboxes. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the conversation history configuration settings being modified. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the `Set-CsConversationHistoryConfiguration` cmdlet. However, you can still use the following syntax to reference the global settings: @@ -121,8 +131,7 @@ However, you can still use the following syntax to reference the global settings ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +159,9 @@ Accept wildcard characters: False ``` ### -MaxContinuedConversationRetry + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the maximum number of times the Skype for Business Server will search for a previous conversation item from Exchange to create a continued conversation. If the previous conversation is not found in the specified number of attempts, a new conversation is created. Increasing this value will present more continued conversations, but at the cost of decreased performance. @@ -157,8 +171,7 @@ The default value is 3. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,14 +180,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -183,14 +198,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDisplayNameResolution -PARAMVALUE: $true | $false +### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -204,13 +221,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings `Set-CsConversationHistoryConfiguration` accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings object. ## OUTPUTS -### -None. +### None Instead, `Set-CsConversationHistoryConfiguration` modifies instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsCpsConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsCpsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCpsConfiguration.md index ae868b8cba..30a9033356 100644 --- a/skype/skype-ps/skype/Set-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCpsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCpsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscpsconfiguration +schema: 2.0.0 +title: Set-CsCpsConfiguration --- # Set-CsCpsConfiguration @@ -46,7 +47,7 @@ In addition, Call Park service can be configured to play music on hold to the ca ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsCpsConfiguration -Identity site:Redmond1 -MaxCallPickupAttempts 2 ``` @@ -55,7 +56,7 @@ The command shown in Example 1 modifies the Call Park service configuration with This is done by including the MaxCallPickupAttempts parameter and setting the parameter value to 2. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCpsConfiguration | Set-CsCpsConfiguration -MaxCallPickupAttempts 2 ``` @@ -65,7 +66,7 @@ To do this, the `Get-CsCpsConfiguration` cmdlet is used to retrieve a collection This collection is then piped to the `Set-CsCpsConfiguration` cmdlet, which takes each individual item in the collection and sets the value of the MaxCallPickupAttempts property to 2. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsCpsConfiguration -Identity site:Redmond1 -CallPickupTimeoutThreshold 00:00:45 ``` @@ -75,54 +76,60 @@ This example modifies the call park configuration for site Redmond1 by setting t ## PARAMETERS -### -Identity -A unique identifier of the configuration you want to modify. -The Identity specifies the scope at which the configuration is applied, either Global or a specific site (in the format site:\, such as site:Redmond). +### -CallPickupTimeoutThreshold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The amount of time that will elapse after a call has been parked before it will ring back to the phone on which the call was answered. + +This must be entered in the format hh:mm:ss (hh = hours, mm = minutes, ss = seconds) + +Minimum Value: 10 seconds (00:00:10); Maximum Value: 10 minutes (00:10:00) ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: TimeSpan +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -An object reference to a Call Park service configuration object, of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings. -This object can be retrieved by calling the `Get-CsCpsConfiguration` cmdlet. -The object can then be changed and the changes saved by passing the object back to the `Set-CsCpsConfiguration` cmdlet in this parameter. +### -EnableMusicOnHold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether music plays for the caller while a call is parked. + +Skype for Business Server ships with a default Music on Hold file. +You can change this file (thereby changing the music the caller hears while parked) with the `Set-CsCallParkServiceMusicOnHoldFile` cmdlet. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -CallPickupTimeoutThreshold -The amount of time that will elapse after a call has been parked before it will ring back to the phone on which the call was answered. +### -Force -This must be entered in the format hh:mm:ss (hh = hours, mm = minutes, ss = seconds) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Minimum Value: 10 seconds (00:00:10); Maximum Value: 10 minutes (00:10:00) +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,27 +138,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMusicOnHold -Determines whether music plays for the caller while a call is parked. +### -Identity -Skype for Business Server ships with a default Music on Hold file. -You can change this file (thereby changing the music the caller hears while parked) with the `Set-CsCallParkServiceMusicOnHoldFile` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A unique identifier of the configuration you want to modify. +The Identity specifies the scope at which the configuration is applied, either Global or a specific site (in the format site:\, such as site:Redmond). ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An object reference to a Call Park service configuration object, of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings. +This object can be retrieved by calling the `Get-CsCpsConfiguration` cmdlet. +The object can then be changed and the changes saved by passing the object back to the `Set-CsCpsConfiguration` cmdlet in this parameter. + + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -MaxCallPickupAttempts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of times a parked call will ring back to the answering phone before giving up and forwarding the call to the fallback Uniform Resource Identifier (URI). The fallback URI is set with the OnTimeoutURI parameter. @@ -160,8 +190,7 @@ Minimum Value: 1; Maximum Value: 10 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +200,9 @@ Accept wildcard characters: False ``` ### -OnTimeoutURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The SIP address of the user or Response Group to which unanswered parked calls will be routed. The parked call will be routed after the number of ringbacks defined with the MaxCallPickupAttempts parameter. If that parameter is set to Null, the OnTimeoutURI will be ignored and the parked call will be disconnected after unsuccessful ringback attempts. @@ -181,8 +213,7 @@ For example, sip:rgs1@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 +Aliases: Required: False Position: Named @@ -191,14 +222,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -208,29 +241,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -244,13 +263,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings + Accepts pipelined input of Call Park service configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings Modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDeviceUpdateConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDeviceUpdateConfiguration.md index 8f111fabab..f38f79b893 100644 --- a/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDeviceUpdateConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDeviceUpdateConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdeviceupdateconfiguration +schema: 2.0.0 +title: Set-CsDeviceUpdateConfiguration --- # Set-CsDeviceUpdateConfiguration @@ -50,7 +51,7 @@ For example, you can use this cmdlet to change the length of time a log file is ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsDeviceUpdateConfiguration -Identity global -MaxLogFileSize 2048000 -MaxLogCacheLimit 1024000 ``` @@ -59,7 +60,7 @@ Example 1 shows how the `Set-CsDeviceUpdateConfiguration` cmdlet can be used to In this case, two property values are modified: the MaxLogFileSize property is set to 2048000 bytes and the MaxLogCacheLimit property is set to 1024000 bytes. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsDeviceUpdateConfiguration -Identity site:Redmond -LogFlushInterval 00:02:00 ``` @@ -69,7 +70,7 @@ To do this, the Identity parameter is used to specify the settings at the Redmon In this case, the LogFlushInterval is set to 2 minutes (00 hours: 02 minutes: 00 seconds). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDeviceUpdateConfiguration | Set-CsDeviceUpdateConfiguration -LogCleanUpInterval 14.00:00:00 ``` @@ -79,7 +80,7 @@ To do this, the `Get-CsDeviceUpdateConfiguration` cmdlet is first used to retrie This collection is then piped to the `Set-CsDeviceUpdateConfiguration` cmdlet, which uses the LogCleanUpInterval parameter to set the log clean up interval time for each item in the collection to 14 days (14 days : 00 hours : 00 minutes : 00 seconds). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDeviceUpdateConfiguration -Filter "site:*" | Set-CsDeviceUpdateConfiguration -LogCleanUpInterval 20.00:00:00 ``` @@ -89,7 +90,7 @@ In order to do this, the `Get-CsDeviceUpdateConfiguration` cmdlet is used along This filtered collection is then piped to the `Set-CsDeviceUpdateConfiguration` cmdlet, which changes the value of the log cleanup interval for each item in the collection. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDeviceUpdateConfiguration | Set-CsDeviceUpdateConfiguration -ValidLogFileTypes @{Remove="CELog"} @@ -106,7 +107,28 @@ For example: ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the device update configuration settings to be modified. To refer to the global settings, use this syntax: `-Identity global`. To refer to site settings, use syntax similar to this: `-Identity "site:Redmond"`. @@ -115,8 +137,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -126,13 +147,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,6 +165,9 @@ Accept wildcard characters: False ``` ### -LogCleanUpInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time a device update log file is kept before it is deleted by the system. The value must be entered in the format dd.hh:mm:ss where dd is days, hh is hours, mm is minutes and ss is seconds. @@ -156,8 +182,7 @@ Default: 10.00:00:00 (10 Days) ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +192,9 @@ Accept wildcard characters: False ``` ### -LogCleanUpTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the time of day when the system checks to see if there are any expired log files that should be deleted. (Expired log files are any files older than the value specified in by the LogCleanupInterval property.) @@ -178,8 +206,7 @@ is represented as 23:52. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,6 +216,9 @@ Accept wildcard characters: False ``` ### -LogFlushInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often information stored in the log file cache is written to the actual log file. By default, device update information is not immediately written to the log file; instead, that information is cached in memory until: 1) the log flush time interval has expired or 2) the cache has reached its maximum size. If this value is set to 10 minutes (00:10:00), then information in the cache will be written to the log file every 10 minutes. @@ -205,8 +235,7 @@ Default: 00:05:00 ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -216,6 +245,9 @@ Accept wildcard characters: False ``` ### -MaxLogCacheLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum amount of information (in bytes) that can held in the log file cache before that cache must be cleared and the data written to a log file. By default, log files are "flushed" every 5 minutes. (For details, see the description of the parameter LogFlushInterval.) However, if the cache reaches its maximum size the information in it will automatically be written to a log file (and the cache cleared), even if the log flush interval has not yet expired. @@ -225,8 +257,7 @@ Default: 512000 ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,6 +267,9 @@ Accept wildcard characters: False ``` ### -MaxLogFileSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum size, in bytes, for an individual log file. When a file reaches the maximum size, the next batch of data is automatically written to a new log file. The old log file will be retained until the log cleanup interval has expired. @@ -245,8 +279,7 @@ Default: 1024000 ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -256,6 +289,9 @@ Accept wildcard characters: False ``` ### -ValidLogFileExtensions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the valid log file extensions that can be used with the Device Update Web service. This list can be modified; however, there is no reason to modify the list unless you have a Lync Phone Edition compatible device that creates log files that use a different file extension. @@ -265,8 +301,7 @@ Default: .dmp, .clg, .clg2, .bak, .kdmp, .dat, .bin, .cat, .xml, .txt, .hex ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -276,6 +311,9 @@ Accept wildcard characters: False ``` ### -ValidLogFileTypes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the log file types retained by the device update system. The default file types include the following: @@ -293,8 +331,7 @@ For example, if you do not want to store CELog files then you can remove the CEL ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -303,30 +340,16 @@ 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 Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 @@ -336,13 +359,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -356,13 +381,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration + The `Set-CsDeviceUpdateConfiguration` cmdlet accepts pipelined instances of the device update configuration object. ## OUTPUTS -### +### None The `Set-CsDeviceUpdateConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticConfiguration.md index 505b7d16bb..c7b40bbdef 100644 --- a/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDiagnosticConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdiagnosticconfiguration +schema: 2.0.0 +title: Set-CsDiagnosticConfiguration --- # Set-CsDiagnosticConfiguration @@ -49,7 +50,7 @@ Filters are used to indicate the domains whose traffic should be logged. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri sip:user@fabrikam.com @@ -64,7 +65,7 @@ In command 2, the `Set-CsDiagnosticConfiguration` cmdlet assigns the new filter In this case, any existing values in the Filter property will be replaced by the newly-created filter. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = (Get-CsDiagnosticConfiguration -Identity global).Filter @@ -83,7 +84,7 @@ When that's done, the final command in the example uses the `Set-CsDiagnosticCon The net result is that fabrikam.com will be added to any FQDNs already included in the Filter property. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $x = (Get-CsDiagnosticConfiguration -Identity global).Filter @@ -98,7 +99,7 @@ After that value has been retrieved, the Remove method is used to remove the FQD After the FQDN has been removed, the `Set-CsDiagnosticConfiguration` cmdlet is used write the modified filter (stored in the variable $x) to the global settings. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Set-CsDiagnosticConfiguration -Identity global -Filter $Null ``` @@ -109,96 +110,108 @@ This is done by setting the Filter property to a Null value. ## PARAMETERS -### -Identity -Unique identifier for the diagnostics configuration settings to be modified. -To modify settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. -To modify the global settings, use this syntax: `-Identity global`. +### -Filter -If this parameter is not specified, then the `Set-CsDiagnosticConfiguration` cmdlet will automatically modify the global settings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of domains and URIs whose traffic will be logged. +The Filter property consists of three separate items, and must be created using the `New-CsDiagnosticsFilter` cmdlet: + +Fqdn - Collection of domains to be included in the filter. +(More technically, the host portion of a SIP address.) For example a fully qualified domain name (FQDN) might look like this: fabrikam.com. +Alternatively, you can use wildcards to represent multiple domains: *.fabrikam.com. +You can include more than one domain in a single filter. + +Uri - Collection of Uris to be included in the filter. +(The Uri represents the user@host portion of a SIP address.) A URI can consist of any of the following patterns: user@fabrikam.com; user@*; *@fabrikam.com. +You can include multiple Uris in a single filter. + +Enabled - Indicates whether or not the filter should be activated. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Filter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Collection of domains and URIs whose traffic will be logged. -The Filter property consists of three separate items, and must be created using the `New-CsDiagnosticsFilter` cmdlet: +### -Identity -Fqdn - Collection of domains to be included in the filter. -(More technically, the host portion of a SIP address.) For example a fully qualified domain name (FQDN) might look like this: fabrikam.com. -Alternatively, you can use wildcards to represent multiple domains: *.fabrikam.com. -You can include more than one domain in a single filter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Uri - Collection of Uris to be included in the filter. -(The Uri represents the user@host portion of a SIP address.) A URI can consist of any of the following patterns: user@fabrikam.com; user@*; *@fabrikam.com. -You can include multiple Uris in a single filter. +Unique identifier for the diagnostics configuration settings to be modified. +To modify settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. +To modify the global settings, use this syntax: `-Identity global`. -Enabled - Indicates whether or not the filter should be activated. +If this parameter is not specified, then the `Set-CsDiagnosticConfiguration` cmdlet will automatically modify the global settings. ```yaml -Type: Filter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LoggingShare -Shared folder where the diagnostic logs can be uploaded. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -LogAllSipHeaders + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, only the core SIP headers are recorded in the logs. +Setting this value to False can help reduce the size of the log files. +When set to True, all SIP headers are logged. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,14 +220,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LoggingShare + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Shared folder where the diagnostic logs can be uploaded. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,13 +239,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -239,16 +256,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LogAllSipHeaders -When set to False, only the core SIP headers are recorded in the logs. -Setting this value to False can help reduce the size of the log files. -When set to True, all SIP headers are logged. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -262,13 +279,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings + The `Set-CsDiagnosticConfiguration` cmdlet accepts pipelined instances of the diagnostic configuration settings object. ## OUTPUTS -### +### None The `Set-CsDiagnosticConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object. diff --git a/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticHeaderConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticHeaderConfiguration.md index 4d2cb97630..f754ed392a 100644 --- a/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticHeaderConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDiagnosticHeaderConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdiagnosticheaderconfiguration +schema: 2.0.0 +title: Set-CsDiagnosticHeaderConfiguration --- # Set-CsDiagnosticHeaderConfiguration @@ -55,7 +56,7 @@ You can use this cmdlet to enable (or disable) the transmission of diagnostic he ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsDiagnosticHeaderConfiguration -Identity site:Redmond -SendToOutsideUnauthenticatedUsers $True ``` @@ -64,7 +65,7 @@ Example 1 modifies the diagnostic header configuration settings that have the Id In this example, the value of the SendToOutsideUnauthenticatedUsers property is set to True. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDiagnosticHeaderConfiguration | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True ``` @@ -74,7 +75,7 @@ To do this, the `Get-CsDiagnosticHeaderConfiguration` cmdlet is first called wit This collection is then piped to the `Set-CsDiagnosticHeaderConfiguration` cmdlet, which sets the SendToOutsideUnauthenticatedUsers property of each item in the collection to True. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True} | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True ``` @@ -87,7 +88,28 @@ That filtered collection is then piped to the `Set-CsDiagnosticHeaderConfigurati ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the diagnostic header configuration settings to be modified. To modify settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. To modify settings configured at the service scope, use syntax like this: `-Identity "service:EdgeServer:atl-cs-001.litwareinc.com"`. @@ -99,8 +121,7 @@ If this parameter is not specified, then the `Set-CsDiagnosticHeaderConfiguratio ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -110,13 +131,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,14 +149,16 @@ Accept wildcard characters: False ``` ### -SendToExternalNetworks + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, diagnostic headers will be attached to messages sent to users on external networks (such as users in a federated domain). The default value is 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 +Aliases: Required: False Position: Named @@ -142,17 +167,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SendToOutsideUnauthenticatedUsers -When set to True, diagnostic headers will be attached to messages sent to outside users. -Outside users are users who have connected from outside the internal network (for example, through a proxy server) and have not yet been authenticated. +### -SendToExternalNetworksOnServiceEdge + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, diagnostic headers will be attached to messages sent to networks on the service edge. The default value is 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 +Aliases: Required: False Position: Named @@ -161,30 +186,19 @@ 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. +### -SendToOutsideUnauthenticatedUsers -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When set to True, diagnostic headers will be attached to messages sent to outside users. +Outside users are users who have connected from outside the internal network (for example, through a proxy server) and have not yet been authenticated. -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +The default value is False. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -194,13 +208,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -209,15 +225,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SendToExternalNetworksOnServiceEdge -When set to True, diagnostic headers will be attached to messages sent to networks on the service edge. -The default value is False. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -231,13 +248,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings + The `Set-CsDiagnosticHeaderConfiguration` cmdlet accepts pipelined instances of the diagnostic header settings object. ## OUTPUTS -### +### None The `Set-CsDiagnosticHeaderConfiguration` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingAccessNumber.md similarity index 86% rename from skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingAccessNumber.md index 01205b59cd..f888c0b9f8 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingAccessNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDialInConferencingAccessNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdialinconferencingaccessnumber +schema: 2.0.0 +title: Set-CsDialInConferencingAccessNumber --- # Set-CsDialInConferencingAccessNumber @@ -59,7 +60,7 @@ In addition, the `Set-CsDialInConferencingAccessNumber` cmdlet enables you to mo ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsDialInConferencingAccessNumber -Identity "sip:RedmondDialIn@litwareinc.com" -DisplayName "Redmond Dial-In Access Number" ``` @@ -68,7 +69,7 @@ The command shown in Example 1 modifies the DisplayName property for the dial-in In this example, the display name is set to "Redmond Dial-In Access Number". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsDialInConferencingAccessNumber -Identity "sip:RedmondDialIn@litwareinc.com" -Regions "Redmond", "Seattle" ``` @@ -78,7 +79,7 @@ To do this, the Regions parameter is called, followed by the two regions (two st Note that this command will fail unless both the Redmond and Seattle regions have already been defined in dial plans. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -eq "fr-FR"}| Set-CsDialInConferencingAccessNumber -SecondaryLanguages "fr-CA" ``` @@ -89,7 +90,7 @@ That collection is then piped to the `Where-Object` cmdlet, which picks out the This filtered collection is then piped to the `Set-CsDialInConferencingAccessNumber` cmdlet, which sets the value of the SecondaryLanguages property to French Canadian ("fr-CA"). -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsDialInConferencingAccessNumber -Filter {DisplayName -eq "Default DialIn Access Number"} | Set-CsDialInConferencingAccessNumber -DisplayName "Litwareinc Conferencing" ``` @@ -99,7 +100,7 @@ To do this, the command first uses the `Get-CsDialInConferencingAccessNumber` cm That access number is then piped to the `Set-CsDialInConferencingAccessNumber` cmdlet, which changes the display name to Litwareinc Conferencing. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Get-CsDialInConferencingAccessNumber -Filter {LineUri -eq "TEL:+14255558715"} | Set-CsDialInConferencingAccessNumber -DisplayNumber "1-425-555-1298" -LineUri "tel:+14255551298" ``` @@ -109,7 +110,7 @@ To retrieve the number to be modified, the command first uses the `Get-CsDialInC That access number is then piped to the `Set-CsDialInConferencingAccessNumber` cmdlet, which modifies both the DisplayNumber and LineUri properties of the access number. -### -------------------------- Example 6 ------------------------ +### Example 6 ``` Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -ne "en-US"} | Set-CsDialInConferencingAccessNumber -SecondaryLanguages "fr-FR","it-IT" ``` @@ -122,7 +123,7 @@ English (en-US). The filtered collection is then piped to the `Set-CsDialInConferencingAccessNumber` cmdlet, which uses the -SecondaryLanguages parameter to assign each number in the collection the secondary languages French (fr-FR) and Italian (it-IT). -### -------------------------- Example 7 ------------------------ +### Example 7 ``` Get-CsDialInConferencingAccessNumber -Identity ""sip:RedmondDialIn@litwareinc.com"" -Priority 0 -ReorderedRegion Redmond ``` @@ -134,15 +135,56 @@ To set the priority, the Priority parameter is included along with the parameter ## PARAMETERS +### -DisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Active Directory display name for the new contact object. +This is the name that will also be displayed in Skype for Business. + + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number as displayed in meeting invitations and on the Dial-in Conferencing Settings webpage. +The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the contact object that represents the dial-in conferencing number. When specifying the Identity you must include the "sip:" prefix; for example: `-Identity " sip:RedmondDialIn@litwareinc.com"`. ```yaml Type: UserIdParameter Parameter Sets: Reorder, Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -152,13 +194,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: AccessNumber Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -167,16 +211,19 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -DisplayName -Active Directory display name for the new contact object. -This is the name that will also be displayed in Skype for Business. +### -LineUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The actual dial-in conferencing phone number. +The LineUri must be specified by using the following syntax: the tel: prefix followed by a plus sign (+) followed by the country/region calling code, area code and phone number. +For example: tel:+18005551234. +Spaces, hyphens, parentheses and other characters are not allowed. ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,34 +232,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber -Phone number as displayed in meeting invitations and on the Dial-in Conferencing Settings webpage. -The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234. +### -PassThru -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Enables you to pass a contact object through the pipeline that represents the modified dial-in conferencing access number. +By default, the `Set-CsDialInConferencingAccessNumber` cmdlet does not pass objects through the pipeline. -### -LineUri -The actual dial-in conferencing phone number. -The LineUri must be specified by using the following syntax: the tel: prefix followed by a plus sign (+) followed by the country/region calling code, area code and phone number. -For example: tel:+18005551234. -Spaces, hyphens, parentheses and other characters are not allowed. ```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -222,6 +253,9 @@ Accept wildcard characters: False ``` ### -PrimaryLanguage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Primary language used for making dial-in conferencing announcements. The language must be configured by using one of the available dial-in conferencing language codes; for example, en-US for U.S. English or fr-FR for French. @@ -233,8 +267,7 @@ To return a list of the available language codes, type the following command at ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,6 +277,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to change the order in which dial-in conferencing numbers are presented to users in meeting invitations or when they access the Dial-In Conferencing Settings webpage. Lower numbers are given a higher priority; to have a number appear at the beginning of the list set the priority to 0. Note that if you change the priority of a given number you must also use the ReorderedRegion parameter to indicate the region where the modified priority should take effect. @@ -252,8 +288,7 @@ Note that if you change the priority of a given number you must also use the Reo ```yaml Type: Int32 Parameter Sets: Reorder -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -263,6 +298,9 @@ Accept wildcard characters: False ``` ### -Regions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Dial plan regions associated with the dial-in number. If a region is not included in at least one dial plan, then it cannot be associated with a dial-in conferencing access number. To specify multiple regions, use a comma-separated list: `-Regions "Northwest", "Southwest"` @@ -270,8 +308,7 @@ To specify multiple regions, use a comma-separated list: `-Regions "Northwest", ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -281,14 +318,16 @@ Accept wildcard characters: False ``` ### -ReorderedRegion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Used with the Priority parameter when changing the priority of a dial-in conferencing number with a region. The ReorderedRegion parameter indicates the region where the priority reordering is to take place; for example: `-ReorderedRegion "Redmond"`. ```yaml Type: String Parameter Sets: Reorder -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -298,13 +337,15 @@ Accept wildcard characters: False ``` ### -ScopeToGlobal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If present, the dial-in conferencing number will be assigned to the global scope. ```yaml Type: SwitchParameter Parameter Sets: Identity, Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -314,13 +355,15 @@ Accept wildcard characters: False ``` ### -ScopeToSite + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If present, the dial-in conferencing number will be scoped to the site where the contact object's Registrar pool resides. ```yaml Type: SwitchParameter Parameter Sets: Identity, Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -330,6 +373,9 @@ Accept wildcard characters: False ``` ### -SecondaryLanguages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Optional collection of languages that can also be used for making dial-in conferencing announcements. Secondary languages must be configured as a comma-separated list of language codes; for example, the following syntax sets French Canadian and French as secondary languages; -SecondaryLanguages "fr-CA", "fr-FR". @@ -338,8 +384,7 @@ An access number can be associated with as many as four secondary languages. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -348,30 +393,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm -```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 +> 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 @@ -380,16 +411,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a contact object through the pipeline that represents the modified dial-in conferencing access number. -By default, the `Set-CsDialInConferencingAccessNumber` cmdlet does not pass objects through the pipeline. +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -403,13 +434,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.AccessNumber object. +### Microsoft.Rtc.Management.Xds.AccessNumber + The `Set-CsDialInConferencingAccessNumber` cmdlet accepts pipelined input of the access number object. ## OUTPUTS -### +### None The `Set-CsDialInConferencingAccessNumber` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Xds.AccessNumber object. diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingConfiguration.md index 05992d1033..d89baaa921 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDialInConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdialinconferencingconfiguration +schema: 2.0.0 +title: Set-CsDialInConferencingConfiguration --- # Set-CsDialInConferencingConfiguration @@ -47,7 +48,7 @@ In addition, you can modify any of these configuration settings (at either the g ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsDialInConferencingConfiguration -Identity site:Redmond -EntryExitAnnouncementsType "ToneOnly" ``` @@ -56,7 +57,7 @@ The command shown in Example 1 modifies the EntryExitAnnoucements property for t In this case, the EntryExitAnnouncementsType property is set to ToneOnly. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDialInConferencingConfiguration | Set-CsDialInConferencingConfiguration -EnableNameRecording $True ``` @@ -66,7 +67,7 @@ To do this, the command first uses the `Get-CsDialInConferencingConfiguration` c That collection is then piped to the `Set-CsDialInConferencingConfiguration` cmdlet, which sets the EnableNameRecording property for each item in the collection to True ($True). -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDialInConferencingConfiguration -Filter "site:*" | Set-CsDialInConferencingConfiguration -EnableNameRecording $True -EntryExitAnnouncementsType "UseNames" ``` @@ -79,51 +80,59 @@ When the command finishes running, all the dial-in conferencing settings configu ## PARAMETERS -### -Identity -Indicates the Identity of the dial-in conferencing configuration settings to be modified. -To refer to the global settings, use this syntax: `-Identity global`. -To refer to site settings, use syntax similar to this: `-Identity site:Redmond`. -Note that you cannot use wildcards when specifying an Identity. +### -AllowAnonymousPstnActivation + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether unauthenticated callers can start a meeting if they are the first person to join. +An unauthenticated caller is defined as a participant who joins a meeting over the phone and doesn't provide a PIN when joining the meeting. +$True to allow anonymous activation, otherwise $False. +The default is $False. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -EnableNameRecording + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether or not users are asked to record their name before entering the conference. +Set to True to enable name recording; set to False to bypass name recording. +The default value is True. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNameRecording -Determines whether or not users are asked to record their name before entering the conference. -Set to True to enable name recording; set to False to bypass name recording. -The default value is True. +### -EntryExitAnnouncementsEnabledByDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True announcements will be played each time a participant enters or exits a conference. +If set to False (the default value), entry and exit announcements will not be played. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +141,26 @@ 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. +### -EntryExitAnnouncementsType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the action taken by the system any time a participant enters or leaves a conference. +(Announcements are made only if the EntryExitAnnouncementsEnabledByDefault is set to True.) Valid values are: + +UseNames. +The person's name is announced any time her or she enters or leaves a conference (for example, "Ken Myer is exiting the conference"). + +ToneOnly. +A tone is played any time a participant enters or leaves a conference. + +The default value is UseNames. + ```yaml -Type: SwitchParameter +Type: EntryExitAnnouncementsType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,14 +169,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running 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 +Aliases: Required: False Position: Named @@ -164,58 +187,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the dial-in conferencing configuration settings to be modified. +To refer to the global settings, use this syntax: `-Identity global`. +To refer to site settings, use syntax similar to this: `-Identity site:Redmond`. +Note that you cannot use wildcards when specifying an Identity. ```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 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EntryExitAnnouncementsEnabledByDefault -If set to True announcements will be played each time a participant enters or exits a conference. -If set to False (the default value), entry and exit announcements will not be played. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -EntryExitAnnouncementsType -Indicates the action taken by the system any time a participant enters or leaves a conference. -(Announcements are made only if the EntryExitAnnouncementsEnabledByDefault is set to True.) Valid values are: +### -PinAuthType -UseNames. -The person's name is announced any time her or she enters or leaves a conference (for example, "Ken Myer is exiting the conference"). +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -ToneOnly. -A tone is played any time a participant enters or leaves a conference. +Specifies which users are allowed to use PIN authentication. +Allowed values are: -The default value is UseNames. +Everyone +OrganizerOnly ```yaml -Type: EntryExitAnnouncementsType +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,17 +249,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousPstnActivation -Specifies whether unauthenticated callers can start a meeting if they are the first person to join. -An unauthenticated caller is defined as a participant who joins a meeting over the phone and doesn't provide a PIN when joining the meeting. -$True to allow anonymous activation, otherwise $False. -The default is $False. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -243,19 +267,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinAuthType -Specifies which users are allowed to use PIN authentication. -Allowed values are: +### -WhatIf -Everyone +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -OrganizerOnly +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -269,13 +290,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration + The `Set-CSDialInConferencingConfiguration` cmdlet accepts pipelined instances of the dial-in conferencing configuration object. ## OUTPUTS -### +### None The `Set-CsDialInConferencingConfiguration` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingDtmfConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingDtmfConfiguration.md index f9a7d636a3..35381bc35a 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingDtmfConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDialInConferencingDtmfConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdialinconferencingdtmfconfiguration +schema: 2.0.0 +title: Set-CsDialInConferencingDtmfConfiguration --- # Set-CsDialInConferencingDtmfConfiguration @@ -64,7 +65,7 @@ To disable a command, set its value to Null ($Null). ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsDialInConferencingDtmfConfiguration -Identity global -EnableDisableAnnouncementsCommand 4 -AudienceMuteCommand 9 ``` @@ -74,7 +75,7 @@ To do this two different parameters are used: EnableDisableAnnoucementsCommand, Because no Identity is specified, these changes will affect the global DTMF settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsDialInConferencingDtmfConfiguration -Identity site:Redmond -EnableDisableAnnouncementsCommand 4 -AudienceMuteCommand 9 ``` @@ -83,7 +84,7 @@ The command shown in Example 2 is a variation of the command shown in the first In this case, however, the changes affect the DTMF settings that have the Identity site:Redmond. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsDialInConferencingDtmfConfiguration -Identity "site:Redmond" -PrivateRollCallCommand $Null ``` @@ -93,7 +94,7 @@ To disable this command, the PrivateRollCallCommand parameter is included, with This means that no keypad key will be associated with the command, which makes the command unavailable to users. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsDialInConferencingDtmfConfiguration -Filter "site:*" | Set-CsDialInConferencingDtmfConfiguration -PrivateRollCallCommand $Null ``` @@ -105,53 +106,17 @@ This filtered collection is then piped to the `Set-CsDialInConferencingDtmfConfi ## PARAMETERS -### -Identity -Indicates the unique identifier for the collection of DTMF settings you want to modify. -To refer to the global settings, use this syntax: `-Identity global`. -To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. -Note that you cannot use wildcards when specifying an Identity. - -If this parameter is not specified, then the `Set-CsDialInConferencingDtmfConfiguration` cmdlet will modify the global DTMF settings. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -AdmitAll -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AdmitAll Indicates the key to be pressed in order to allow all the users in the lobby to immediately join the conference. The default value is 8. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,14 +126,16 @@ Accept wildcard characters: False ``` ### -AudienceMuteCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key a presenter can press to mute everyone else in the conference (that is, everyone other than the presenter will be muted). The default key is 4. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,14 +145,16 @@ Accept wildcard characters: False ``` ### -CommandCharacter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed at the beginning of a command. The default key is the asterisk (*); the only other allowed value is the pound key (#). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,14 +164,34 @@ Accept wildcard characters: False ``` ### -EnableDisableAnnouncementsCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed to enable or disable announcements each time someone joins or leaves the conference. The default key is 9. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -212,14 +201,16 @@ Accept wildcard characters: False ``` ### -HelpCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed in order to privately play a description of all the DTMF commands. The default key is 1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -228,7 +219,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the unique identifier for the collection of DTMF settings you want to modify. +To refer to the global settings, use this syntax: `-Identity global`. +To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. +Note that you cannot use wildcards when specifying an Identity. + +If this parameter is not specified, then the `Set-CsDialInConferencingDtmfConfiguration` cmdlet will modify the global DTMF settings. + + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -LockUnlockConferenceCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed to lock or unlock a conference. If a conference is locked then no new participants will be allowed to join that conference, at least not until the conference has been unlocked. The default key is 7. @@ -236,8 +272,7 @@ The default key is 7. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,6 +282,9 @@ Accept wildcard characters: False ``` ### -MuteUnmuteCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed to mute or unmute yourself; the same key is used to toggle back and forth between muting and unmuting. The default key is 6. @@ -254,8 +292,7 @@ The default key is 6. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,15 +301,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrivateRollCallCommand -Indicates the key to be pressed to privately play the name of each conference participant. -The default key is 3. +### -OperatorLineUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number that the dial-in conferencing auto-attendant will connect a PSTN user to any time that user presses *0 on their telephone keypad. +Pressing *0 is designed to connect dial-in conferencing users to operator assistance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -281,30 +320,17 @@ 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 Server 2015, Skype for Business Server 2019 +### -PrivateRollCallCommand -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Indicates the key to be pressed to privately play the name of each conference participant. +The default key is 3. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -314,13 +340,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -329,15 +357,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OperatorLineUri -Phone number that the dial-in conferencing auto-attendant will connect a PSTN user to any time that user presses *0 on their telephone keypad. -Pressing *0 is designed to connect dial-in conferencing users to operator assistance. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -351,13 +380,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration + The `Set-CsDialInConferencingDtmfConfiguration` cmdlet accepts pipelined instances of the dial-in conference DTMF configuration object. ## OUTPUTS -### +### None The `Set-CsDialInConferencingDtmfConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialPlan.md similarity index 83% rename from skype/skype-ps/skype/Set-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDialPlan.md index f8e44ed1dd..27e4239681 100644 --- a/skype/skype-ps/skype/Set-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDialPlan -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdialplan +schema: 2.0.0 +title: Set-CsDialPlan --- # Set-CsDialPlan @@ -47,7 +48,7 @@ The changes made with those cmdlets will be reflected in the corresponding dial ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsDialPlan -Identity RedmondDialPlan -Description "This plan is for Redmond-based users only." ``` @@ -56,7 +57,7 @@ In Example 1, the `Set-CsDialPlan` cmdlet is used to modify the dial plan with t In this case, the only property being modified is the Description; this modification is performed by specifying the Description parameter followed by the text for the new description. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialPlan | Set-CsDialPlan -ExternalAccessPrefix 8 ``` @@ -68,43 +69,46 @@ That collection is then piped to the `Set-CsDialPlan` cmdlet, which assigns the ## PARAMETERS -### -Identity -The unique identifier designating the scope, or, for per-user plans, a name, to identify the dial plan you want to modify. -For example, a site Identity will be in the format site:\, where sitename is the name of the site. -A dial plan at the service scope will be a Registrar or PSTN gateway service, where the Identity value is formatted like this: Registrar:Redmond.litwareinc.com. -A per-user Identity will be a unique string value. +### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. -You can retrieve this object reference by calling the `Get-CsDialPlan` cmdlet. +### -CountryCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of this dial plan--what it's for, what type of user it applies to, or any other information that will be helpful in identifying the purpose of the dial plan. Maximum characters: 512 @@ -112,8 +116,7 @@ Maximum characters: 512 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +126,9 @@ Accept wildcard characters: False ``` ### -DialinConferencingRegion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the region associated with this dial plan. Specify a value for this parameter if the dial plan will be used for dial-in conferencing. This allows the correct access number to be assigned when the conference organizer sets up the conference. @@ -133,8 +139,7 @@ Maximum characters: 512 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -ExternalAccessPrefix + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number (or set of numbers) that designates the call as external to the organization. (For example, to dial an outside line, first press 9.) This prefix will be ignored by the normalization rules, although these rules will be applied to the rest of the number. @@ -155,8 +163,7 @@ This means it must be a value one to four digits in length, each digit being a n ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,16 +172,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NormalizationRules -A list of normalization rules that are applied to this dial plan. +### -Force -While this list and these rules can be modified directly with this cmdlet, it is recommended that you create normalization rules with the `New-CsVoiceNormalizationRule` cmdlet, which creates the rule and assigns it to the specified dial plan and modify them with the `Set-CsVoiceNormalizationRule` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts before making changes. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,52 +190,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OptimizeDeviceDialing -Setting this parameter to True will apply the prefix in the ExternalAccessPrefix parameter to calls made outside the organization. -This value can be set to True only if a value has been specified for the ExternalAccessPrefix parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier designating the scope, or, for per-user plans, a name, to identify the dial plan you want to modify. +For example, a site Identity will be in the format site:\, where sitename is the name of the site. +A dial plan at the service scope will be a Registrar or PSTN gateway service, where the Identity value is formatted like this: Registrar:Redmond.litwareinc.com. +A per-user Identity will be a unique string value. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SimpleName -A friendly name for the dial plan. -Dial plan names must be unique among all dial plans within a Skype for Business Server deployment. +### -Instance -This string can be up to 256 characters long. -Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), plus (+), underscore (_) and parentheses (()). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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-CsDialPlan` cmdlet. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -State -This parameter is not used with this cmdlet. +### -NormalizationRules + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A list of normalization rules that are applied to this dial plan. + +While this list and these rules can be modified directly with this cmdlet, it is recommended that you create normalization rules with the `New-CsVoiceNormalizationRule` cmdlet, which creates the rule and assigns it to the specified dial plan and modify them with the `Set-CsVoiceNormalizationRule` cmdlet. ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +250,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -City -This parameter is not used with this cmdlet. +### -OptimizeDeviceDialing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Setting this parameter to True will apply the prefix in the ExternalAccessPrefix parameter to calls made outside the organization. +This value can be set to True only if a value has been specified for the ExternalAccessPrefix parameter. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -253,14 +269,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CountryCode -This parameter is not used with this cmdlet. +### -SimpleName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A friendly name for the dial plan. +Dial plan names must be unique among all dial plans within a Skype for Business Server deployment. + +This string can be up to 256 characters long. +Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), plus (+), underscore (_) and parentheses (()). + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -269,14 +292,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts before making changes. +### -State + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -285,14 +310,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -301,14 +328,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -322,13 +351,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile + Accepts pipelined input of dial plan objects. ## OUTPUTS -### +### None The `Set-CsDialPlan` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. diff --git a/skype/skype-ps/skype/Set-CsDirector.md b/skype/skype-ps/SkypeForBusiness/Set-CsDirector.md similarity index 80% rename from skype/skype-ps/skype/Set-CsDirector.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDirector.md index 49d7fa107e..a5664e412a 100644 --- a/skype/skype-ps/skype/Set-CsDirector.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDirector.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdirector applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDirector -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdirector +schema: 2.0.0 +title: Set-CsDirector --- # Set-CsDirector @@ -41,7 +42,7 @@ This includes changing such things as the Archiving Server or Edge Server associ ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsDirector -Identity "Director:atl-cs-001.litwareinc.com" -ArchivingServer "ArchivingServer:dublin-cs-001.litwareinc.com" ``` @@ -50,7 +51,7 @@ The command shown in Example 1 changes the Archiving Server associated with the In this example, the Archiving Server is switched to ArchivingServer:dublin-cs-001.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -Director | ForEach-Object {Set-CsDirector -Identity $_.Identity -SipPort 5072} ``` @@ -63,35 +64,36 @@ In turn, the `ForEach-Object` cmdlet runs the `Set-CsDirector` cmdlet against ea ## PARAMETERS -### -Identity -Service location of the Director to be modified. -For example: `-Identity "Director:atl-cs-001.litwareinc.com"`. +### -ArchivingServer -Note that you can leave off the prefix "Director:" when specifying a Director. -For example: `-Identity "atl-cs-001.litwareinc.com"`. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Archiving Server to be associated with the Director. +For example: `-ArchivingServer "ArchivingServer:atl-cs-001.litwareinc.com"`. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ArchivingServer -Service location of the Archiving Server to be associated with the Director. -For example: `-ArchivingServer "ArchivingServer:atl-cs-001.litwareinc.com"`. +### -EdgeServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Edge Server to be associated with the Director. +For example: `-EdgeServer "EdgeServer:atl-edge-001.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 +Aliases: Required: False Position: Named @@ -100,15 +102,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EdgeServer -Service location of the Edge Server to be associated with the Director. -For example: `-EdgeServer "EdgeServer:atl-edge-001.litwareinc.com"` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,31 +120,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringServer -Service location of the Monitoring Server to be associated with the Director. -For example: `-MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com"`. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Director to be modified. +For example: `-Identity "Director:atl-cs-001.litwareinc.com"`. + +Note that you can leave off the prefix "Director:" when specifying a Director. +For example: `-Identity "atl-cs-001.litwareinc.com"`. ```yaml -Type: String +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SipPort -Port used for Session Initiation Protocol (SIP) traffic. +### -MirrorMonitoringDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the mirror monitoring database to be associated with the Director. ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,14 +160,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebPort -Port used for communicating with Web Services. +### -MonitoringDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the monitoring database to be associated with the Director. ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,15 +178,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebServer -Web Services location of the server to be associated with the Director. -For example: `-WebServer "WebServer:atl-cs-001.litwareinc.com"` +### -MonitoringServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Monitoring Server to be associated with the Director. +For example: `-MonitoringServer "MonitoringServer:atl-cs-001.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 +Aliases: Required: False Position: Named @@ -183,14 +197,17 @@ 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. +### -SipHealthPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for monitoring server health. + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,14 +216,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for Session Initiation Protocol (SIP) traffic. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,14 +234,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SipServerTcpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP listening port. +The default value is 5060. + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,15 +254,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipHealthPort -Port used for monitoring server health. +### -WebPort +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for communicating with Web Services. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,16 +272,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipServerTcpPort -SIP listening port. -The default value is 5060. +### -WebServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Web Services location of the server to be associated with the Director. +For example: `-WebServer "WebServer:atl-cs-001.litwareinc.com"` ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -266,14 +291,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MirrorMonitoringDatabase -Service location of the mirror monitoring database to be associated with the Director. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -282,14 +309,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringDatabase -Service location of the monitoring database to be associated with the Director. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -303,13 +332,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsDirector` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsDirector` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayDirector object. diff --git a/skype/skype-ps/skype/Set-CsEdgeServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsEdgeServer.md similarity index 80% rename from skype/skype-ps/skype/Set-CsEdgeServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsEdgeServer.md index 5f2b5044cf..17e9ab6ec4 100644 --- a/skype/skype-ps/skype/Set-CsEdgeServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsEdgeServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csedgeserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsEdgeServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csedgeserver +schema: 2.0.0 +title: Set-CsEdgeServer --- # Set-CsEdgeServer @@ -43,7 +44,7 @@ The `Set-CsEdgeServer` cmdlet enables you to modify configuration settings for y ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsEdgeServer -Identity "EdgeServer:atl-edge-001.litwareinc.com" -AccessEdgeInternalSipPort 5062 -AccessEdgeExternalSipPort 5062 ``` @@ -51,7 +52,7 @@ Set-CsEdgeServer -Identity "EdgeServer:atl-edge-001.litwareinc.com" -AccessEdgeI The command shown in Example 1 modifies the internal and external SIP ports for the Edge Server "EdgeServer:atl-edge-001.litwareinc.com". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -EdgeServer | Where-Object {$_.SiteId -eq "site:Redmond"} | ForEach-Object {Set-CsEdgeServer -Identity $_.Identity -AccessEdgeInternalSipPort 5062 -AccessEdgeExternalSipPort 5062} ``` @@ -65,27 +66,10 @@ That cmdlet runs the `Set-CsEdgeServer` cmdlet against each server in the collec ## PARAMETERS -### -Identity -Service location of the Edge Server to be modified. -For example: `-Identity "EdgeServer:atl-edge-001.litwareinc.com"`. - -Note that you can leave off the prefix "EdgeServer:" when specifying an Edge server. -For example: `-Identity "atl-cs-001.litwareinc.com"`. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AccessEdgeClientSipPort -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AccessEdgeClientSipPort Port used for SIP communications between the Edge Server and client devices. The initial value is set in Topology Builder but can be changed by specifying a new value for this parameter. @@ -93,8 +77,7 @@ The initial value is set in Topology Builder but can be changed by specifying a ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,14 +87,16 @@ Accept wildcard characters: False ``` ### -AccessEdgeExternalSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for external SIP traffic. The default value is 5061. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,14 +106,16 @@ Accept wildcard characters: False ``` ### -AccessEdgeInternalSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for internal SIP traffic. The default value is 5061. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +125,9 @@ Accept wildcard characters: False ``` ### -DataPsomClientPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for Persistent Shared Object Model (PSOM) communications between the Edge Server and client devices. The initial value is set in Topology Builder but can be changed by specifying a new value for this parameter. @@ -145,8 +135,7 @@ The initial value is set in Topology Builder but can be changed by specifying a ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,13 +145,15 @@ Accept wildcard characters: False ``` ### -DataPsomServerPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for PSOM communications between the Edge Server and other servers. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,7 +162,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Edge Server to be modified. +For example: `-Identity "EdgeServer:atl-edge-001.litwareinc.com"`. + +Note that you can leave off the prefix "EdgeServer:" when specifying an Edge server. +For example: `-Identity "atl-cs-001.litwareinc.com"`. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MediaCommunicationPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated on the external Edge for media communications. The default value is 10000. @@ -179,8 +213,7 @@ The default value is 10000. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +223,9 @@ Accept wildcard characters: False ``` ### -MediaCommunicationPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Starting port number on the external Edge for media communications. The default value is 50000. @@ -197,8 +233,7 @@ The default value is 50000. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,14 +243,16 @@ Accept wildcard characters: False ``` ### -MediaRelayAuthEdgePort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for media relay authentication. The default value is 5062. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +262,9 @@ Accept wildcard characters: False ``` ### -MediaRelayExternalTurnTcpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for external media relay traffic using the Transmission Control Protocol (TCP). The default value is 444 if your Edge server has a single IP address. If your Edge server has multiple IP addresses then the default value is 443. @@ -234,8 +274,7 @@ These values are initially set in Topology Builder but can be changed by specify ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,14 +284,16 @@ Accept wildcard characters: False ``` ### -MediaRelayExternalTurnUdpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for external media relay traffic using the User Datagram Protocol (UDP). The default value is 3478. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -262,14 +303,16 @@ Accept wildcard characters: False ``` ### -MediaRelayInternalTurnTcpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for internal media relay traffic using TCP. The default value is 443. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,14 +322,16 @@ Accept wildcard characters: False ``` ### -MediaRelayInternalTurnUdpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for internal media relay traffic using UDP. The default value is 3478. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -296,14 +341,16 @@ Accept wildcard characters: False ``` ### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Registrar to be associated with the Edge Server. For example: `-Registrar "Registrar:atl-cs-001.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 +Aliases: Required: False Position: Named @@ -312,14 +359,16 @@ 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. +### -SkypeSearchProxyPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: UInt16 ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -328,30 +377,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -XmppInternalPort -```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 +> 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 -``` +Port used for internal XMPP traffic. +The extensible Messaging and Presence Protocol (XMPP) is an open-standard communications protocol for exchanging messages using XML. +An allowed partner is an IM and presence provider whose users are allowed to exchange instant messages and presence information with your Skype for Business Server users. +The default value is 5098. -### -Confirm -Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -360,18 +399,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -XmppInternalPort -Port used for internal XMPP traffic. -The extensible Messaging and Presence Protocol (XMPP) is an open-standard communications protocol for exchanging messages using XML. -An allowed partner is an IM and presence provider whose users are allowed to exchange instant messages and presence information with your Skype for Business Server users. -The default value is 5098. +### -XmppListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Listening port for XMPP traffic. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -380,14 +417,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -XmppListeningPort -Listening port for XMPP traffic. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -396,14 +435,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkypeSearchProxyPort -PARAMVALUE: UInt16 +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -417,13 +458,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsEdgeServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsEdgeServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayEdgeServer object. diff --git a/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Set-CsEnhancedEmergencyServiceDisclaimer.md similarity index 83% rename from skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsEnhancedEmergencyServiceDisclaimer.md index 25d66021cd..dd9b7ef0a0 100644 --- a/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csenhancedemergencyservicedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Set-CsEnhancedEmergencyServiceDisclaimer --- # Set-CsEnhancedEmergencyServiceDisclaimer @@ -43,7 +44,7 @@ This message will be displayed only if the LocationRequired property of the user ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsEnhancedEmergencyServiceDisclaimer -Body "Warning: If you do not provide a location, emergency services may be delayed in reaching your location should you need to call for help." ``` @@ -54,79 +55,89 @@ This setting can be applied only at the global scope, which is the default for I ## PARAMETERS -### -Identity -This will always be Global. +### -Body + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -A reference to an enhanced emergency service disclaimer object. -Must be of type EnhancedEmergencyServiceDisclaimer. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Body -A string containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This will always be Global. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to an enhanced emergency service disclaimer object. +Must be of type EnhancedEmergencyServiceDisclaimer. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -135,14 +146,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -156,13 +169,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer + Accepts pipelined input of an enhanced emergency service disclaimer object. ## OUTPUTS -### +### None This cmdlet does not return a value or an object. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer. diff --git a/skype/skype-ps/skype/Set-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Set-CsExUmContact.md similarity index 84% rename from skype/skype-ps/skype/Set-CsExUmContact.md rename to skype/skype-ps/SkypeForBusiness/Set-CsExUmContact.md index aaee007975..244cfa2621 100644 --- a/skype/skype-ps/skype/Set-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsExUmContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsExUmContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csexumcontact +schema: 2.0.0 +title: Set-CsExUmContact --- # Set-CsExUmContact @@ -39,7 +40,7 @@ Simply pipe the output of the `Get-CsExUmContact` cmdlet command to the `Set-CsE ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsExUmContact -Identity sip:exumsa4@fabrikam.com | Set-CsExUmContact -AutoAttendant $True ``` @@ -50,7 +51,7 @@ We first call the `Get-CsExUmContact` cmdlet to retrieve the contact object. That contact is then passed to the `Set-CsExUmContact` cmdlet, where we set its AutoAttendant parameter to True. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsExUmContact -Identity "CN={1bf6208d-2847-45d0-828f-636f14da858b},OU=ExUmContacts,DC=litwareinc,DC=com" -AutoAttendant $True ``` @@ -62,34 +63,17 @@ We then set the AutoAttendant parameter of the contact to True. ## PARAMETERS -### -Identity -The unique identifier of the contact object you want to modify. -Contact identities can be specified using one of four formats: 1) The contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1) and 4) the contact's Active Directory display name (for example, Team Auto Attendant). - -Full data type: Microsoft.Rtc.Management.AD.UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AutoAttendant -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AutoAttendant Set the parameter to True if the contact object is an Auto Attendant. This parameter is False by default. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,14 +83,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of this contact. The description is for use by administrators to identify the type of contact (Auto Attendant or Subscriber Access), the location, provider, or any other information that will identify the purpose of each Exchange UM contact. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +102,9 @@ Accept wildcard characters: False ``` ### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The telephone number of the contact. Display numbers for each contact must be unique (no two Exchange UM contacts can have the same display number). Changing this value will also change the value of the LineURI property. @@ -126,8 +115,26 @@ The first digit cannot be zero. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the contact has been enabled for Skype for Business Server. Setting this parameter to False will disable the contact, and the Auto Attendant or Subscriber Access associated with this contact will no longer function. @@ -148,7 +158,6 @@ If you later re-enable the account using the Enable parameter, the associated ac 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 @@ -158,14 +167,16 @@ Accept wildcard characters: False ``` ### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the contact has been enabled for Enterprise Voice. If this value is set to False, the Auto Attendant or Subscriber Access feature associated with this contact will no longer be available. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,21 +185,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -The SIP address of the contact. -This must be a new address that does not already exist as a user or contact in Active Directory Domain Services. +### -ExchangeArchivingPolicy -Changing this value will also change the SIP address stored in the OtherIpPhone property. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The SipAddress can be used as the Identity value for the `Get-CsExUmContact` cmdlet commands to retrieve specific contacts. -When calling that cmdlet, the new SipAddress will be used; queries for the old SIP address will not return an object. +Indicates where the contact's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving ```yaml -Type: String +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,32 +213,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the contact object you want to modify. +Contact identities can be specified using one of four formats: 1) The contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1) and 4) the contact's Active Directory display name (for example, Team Auto Attendant). + +Full data type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns the results of the command. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,14 +253,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP address of the contact. +This must be a new address that does not already exist as a user or contact in Active Directory Domain Services. + +Changing this value will also change the SIP address stored in the OtherIpPhone property. + +The SipAddress can be used as the Identity value for the `Get-CsExUmContact` cmdlet commands to retrieve specific contacts. +When calling that cmdlet, the new SipAddress will be used; queries for the old SIP address will not return an object. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,13 +279,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -263,24 +296,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the contact's instant messaging sessions are archived. -Allowed values are: - -Uninitialized - -UseLyncArchivingPolicy - -ArchivingToExchange +### -WhatIf -NoArchiving +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -294,13 +319,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact + Accepts pipelined input of Exchange UM contact objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact This cmdlet modifies an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact. When the PassThru parameter is used, it also returns an object of this type. diff --git a/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsExternalAccessPolicy.md similarity index 77% rename from skype/skype-ps/skype/Set-CsExternalAccessPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsExternalAccessPolicy.md index 6c3a7aa2de..af39315f4c 100644 --- a/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsExternalAccessPolicy.md @@ -1,17 +1,22 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Set-CsExternalAccessPolicy -schema: 2.0.0 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csexternalaccesspolicy +schema: 2.0.0 +title: Set-CsExternalAccessPolicy --- # 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 +27,14 @@ This cmdlet was introduced in Lync Server 2010. ### Identity (Default) ``` Set-CsExternalAccessPolicy [-Tenant ] [-Description ] [-EnableFederationAccess ] [-EnableAcsFederationAccess ] - [-EnableXmppAccess ] [-EnablePublicCloudAccess ] - [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] [-EnableOutsideAccess ] [[-Identity] ] + [-EnableXmppAccess ] [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] [-EnableOutsideAccess ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Instance ``` Set-CsExternalAccessPolicy [-Tenant ] [-Description ] [-EnableFederationAccess ] [-EnableAcsFederationAccess ] - [-EnableXmppAccess ] [-EnablePublicCloudAccess ] + [-EnableXmppAccess ] [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] [-EnableOutsideAccess ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -56,7 +60,7 @@ This enables your users to use Skype for Business and log on to Skype for Busine The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, Instance, PipelineVariable, and Tenant -5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skype/set-cstenantfederationconfiguration) or Teams admin center under the External Access setting. +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skypeforbusiness/set-cstenantfederationconfiguration) or Teams admin center under the External Access setting. After an external access policy has been created, you can use the `Set-CsExternalAccessPolicy` cmdlet to change the property values of that policy. For example, by default the global policy does not allow users to communicate with people who have accounts with a federated organization. @@ -64,7 +68,7 @@ If you would like to grant this capability to all of your users you can call the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederationAccess $True ``` @@ -72,7 +76,7 @@ Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederati The command shown in Example 1 modifies the per-user external access policy that has the Identity RedmondExternalAccessPolicy. In this example, the command changes the value of the EnableFederationAccess property to True. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsExternalAccessPolicy | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` @@ -81,28 +85,17 @@ In Example 2, federation access is enabled for all the external access policies To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet without any parameters; this returns a collection of all the external policies currently configured for use. That collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which changes the value of the EnableFederationAccess property for each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsExternalAccessPolicy -Filter tag:* | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` Example 3 enables federation access for all the external access policies that have been configured at the per-user scope. -To carry out this task, the first thing the command does is use the `Get-CsExternalAcessPolicy` cmdlet and the Filter parameter to return a collection of all the policies that have been configured at the per-user scope. +To carry out this task, the first thing the command does is use the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of all the policies that have been configured at the per-user scope. (The filter value "tag:*" limits returned data to policies that have an Identity that begins with the string value "tag:". Any policy with an Identity that begins with "tag:" has been configured at the per-user scope.) The filtered collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which modifies the EnableFederationAccess property for each policy in the collection. -### -------------------------- Example 4 ------------------------ -``` -Get-CsExternalAccessPolicy | Where-Object {$_.EnablePublicCloudAccess -eq $True} | Set-CsExternalAccessPolicy -EnableFederationAccess $True -``` - -In Example 4, federation access is enabled for all the external access policies that allow public cloud access. -To do this, the command first uses the `Get-CsExternalAccessPolicy` cmdlet to return a collection of all the external access policies currently configured for use in the organization. -This collection is piped to the `Where-Object` cmdlet, which picks out only those policies where the EnablePublicCloudAccess property is equal to True. -The filtered collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which takes each policy and sets the EnableFederationAccess property to True. -The net result: all external access policies that allow public cloud access will also allow federation access. - -### -------------------------- Example 5 ------------------------ +### Example 4 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $false New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAccess $true @@ -110,7 +103,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAc 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 ------------------------ +### Example 5 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false @@ -120,63 +113,52 @@ In this example, the Global policy is updated to allow Teams-ACS federation for ## 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. +### -Description -Note that wildcards are not allowed when specifying an Identity. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: XdsIdentity +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: 1 +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. +### -EnableAcsFederationAccess -```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 +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +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. -### -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. +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: String +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 +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### -EnableFederationAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. @@ -185,7 +167,6 @@ The default value is True. 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 @@ -194,37 +175,17 @@ 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. +### -EnableOutsideAccess -```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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -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. +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 @@ -234,6 +195,9 @@ Accept wildcard characters: False ``` ### -EnablePublicCloudAudioVideoAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -242,7 +206,6 @@ The default value is False. 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 @@ -252,6 +215,9 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + (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. @@ -263,7 +229,6 @@ The default value is True. 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 @@ -273,6 +238,9 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerInbound + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + (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. @@ -284,7 +252,6 @@ The default value is True. 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 @@ -293,14 +260,17 @@ 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. +### -EnableXmppAccess + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: SwitchParameter +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 @@ -309,14 +279,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running 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 +Aliases: Required: False Position: Named @@ -325,48 +297,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: SwitchParameter +Type: XdsIdentity 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 +Aliases: Required: False -Position: Named +Position: 1 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) +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: False +Accept pipeline input: True (ByValue) 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. +### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: Boolean +Type: Guid 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 @@ -375,21 +365,34 @@ 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: +### -Confirm -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +Prompts you for confirmation before executing the command. -`Get-CsTenant | Select-Object DisplayName, TenantID` +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -403,13 +406,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy + The `Set-CsExternalAccessPolicy` cmdlet accepts pipelined input of the external access policy object. ## OUTPUTS -### +### None 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. diff --git a/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsExternalUserCommunicationPolicy.md similarity index 88% rename from skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsExternalUserCommunicationPolicy.md index 58dfe5fefc..b3baa7a8fd 100644 --- a/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsExternalUserCommunicationPolicy.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-csexternalusercommunicationpolicy applicable: Skype for Business Online -title: Set-CsExternalUserCommunicationPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csexternalusercommunicationpolicy +schema: 2.0.0 +title: Set-CsExternalUserCommunicationPolicy --- # Set-CsExternalUserCommunicationPolicy @@ -39,7 +41,7 @@ The following parameters are not applicable to Skype for Business Online: AllowP ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` PS C:\> Set-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer -EnableP2PFileTransfer $False ``` @@ -50,13 +52,15 @@ This example modifies an existing policy to block external file transfer. ## PARAMETERS ### -AllowPresenceVisibility + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -66,13 +70,15 @@ Accept wildcard characters: False ``` ### -AllowTitleVisibility + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -81,30 +87,16 @@ Accept 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: Skype for Business Online +### -EnableFileTransfer -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -EnableFileTransfer This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -114,13 +106,15 @@ Accept wildcard characters: False ``` ### -EnableP2PFileTransfer + +> Applicable: Skype for Business Online + Indicates whether file transfers to Federated partners are allowed. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -130,13 +124,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + 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 +Aliases: Required: False Position: Named @@ -146,13 +142,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique identifier for the external user communication policy to be modified. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -162,13 +160,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -178,14 +178,34 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -195,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -202,7 +225,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsFIPSConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsFIPSConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsFIPSConfiguration.md index 609a96b73c..3ab4a3db18 100644 --- a/skype/skype-ps/skype/Set-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsFIPSConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsFIPSConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csfipsconfiguration +schema: 2.0.0 +title: Set-CsFIPSConfiguration --- # Set-CsFIPSConfiguration @@ -50,7 +51,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsFIPSConfiguration -Identity "global" -RequireFIPSCompliantMedia $True ``` @@ -60,30 +61,16 @@ In Example 1, the RequireFIPSCompliantMedia property of the global FIPS configur ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -93,6 +80,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the FIPS configuration settings to be modified. Because Skype for Business Server only supports a single, global collection of FIPS settings, the only collection that can be modified is the global collection: @@ -104,8 +94,7 @@ If you do not include this parameter the `Set-CsFIPSConfiguration` cmdlet will m ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,13 +104,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +122,9 @@ Accept wildcard characters: False ``` ### -RequireFIPSCompliantMedia + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True will Skype for Business Server only allow media sessions with entities that use FIPS compliant algorithms for authentication and authorization. Note that, if you require FIPS compliance, then your users will no longer be able to connect to your system by using a Microsoft Lync Server 2010 A/V Edge server. @@ -142,8 +136,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,6 +146,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the FIPS configuration settings are being modified. For example: @@ -166,8 +162,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -197,13 +212,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration The `Set-CsFIPSConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsFIPSConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsFileTransferFilterConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsFileTransferFilterConfiguration.md index 711fda67d7..6a01fbdc5f 100644 --- a/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsFileTransferFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsFileTransferFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csfiletransferfilterconfiguration +schema: 2.0.0 +title: Set-CsFileTransferFilterConfiguration --- # Set-CsFileTransferFilterConfiguration @@ -44,7 +45,7 @@ You can also use this cmdlet to change whether or not file transfer filtering is ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsFileTransferFilterConfiguration -Identity site:Redmond -Enabled $False ``` @@ -53,7 +54,7 @@ The command shown in Example 1 disables file transfer filtering for the Redmond To carry out this task, the Enabled parameter is included in the command and is set to $False. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions @{Add=".ps1"} ``` @@ -65,7 +66,7 @@ To add multiple extensions by using a single command, simply separate the file e Note that you must include the period when specifying a file extension. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsFileTransferFilterConfiguration | Set-CsFileTransferFilterConfiguration -Extensions @{Add=".ps1"} ``` @@ -75,7 +76,7 @@ To do this, the `Get-CsFileTransferFilterConfiguration` cmdlet is first called, That collection is then piped to the `Set-CsFileTransferFilterConfiguration` cmdlet, which adds the .ps1 file extension to each item in the collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions @{Remove=".ps1"} ``` @@ -84,7 +85,7 @@ In Example 4, the file extension .ps1 is removed from the list of extensions blo This example is identical to Example 3 except that, instead of calling the Add list modifier to add an extension to the list, the Remove list modifier is called to remove an extension from that list. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` $a = Get-CsFileTransferFilterConfiguration -Identity site:Redmond @@ -105,44 +106,10 @@ To make the change to the database, we need to call the `Set-CsFileTransferFilte ## PARAMETERS -### -Identity -Unique identifier of the file transfer configuration you want to modify. -This value will be either global or site:\, where \ is the name of the site to which the settings apply, such as site:Redmond. - -If this parameter is not specified, then the `Set-CsFileTransferFilterConfiguration` cmdlet will, by default, update the global settings. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -This object must be of type FileTransferFilterConfiguration and can be retrieved by calling the `Get-CsFileTransferFilterConfiguration` cmdlet. +### -Action -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Action Determines the action to be taken if this file transfer filter configuration is enabled. If set to BlockAll then all file transfers will be prohibited, regardless of file extension. If set to Block (the default value) file transfers will be allowed unless the file extension appears as one of the prohibited file types listed in the Extensions property. @@ -152,8 +119,7 @@ To allow unrestricted file transfers (that is, to allow users to exchange any ty ```yaml Type: FileFilterAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,6 +129,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables or disables file transfer filtering. If this parameter is set to True, files with the specified extensions (or all files, depending on the value of the Action property) cannot be transferred from the client. If this parameter is set to False, any file can be transferred. @@ -172,8 +141,7 @@ Default: True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +151,9 @@ Accept wildcard characters: False ``` ### -Extensions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + List of file extensions that will be blocked. If you attempt to use a Skype for Business Server client to transfer a file that has a file extension matching one of the extensions in this list, that transfer will be blocked and the file will not be transferred. This list is ignored if Action is set to BlockAll (all file transfers are blocked) or if Enabled is set to False (no file transfers are blocked). @@ -195,8 +166,7 @@ By default, the following file extensions are included in the Extensions propert ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,13 +176,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +Aliases: Required: False Position: Named @@ -221,30 +193,75 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the file transfer configuration you want to modify. +This value will be either global or site:\, where \ is the name of the site to which the settings apply, such as site:Redmond. + +If this parameter is not specified, then the `Set-CsFileTransferFilterConfiguration` cmdlet will, by default, update the global settings. + ```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 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +This object must be of type FileTransferFilterConfiguration and can be retrieved by calling the `Get-CsFileTransferFilterConfiguration` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -258,13 +275,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration + Accepts pipelined input of file transfer filter configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/Set-CsGroupPickupUserOrbit.md similarity index 86% rename from skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md rename to skype/skype-ps/SkypeForBusiness/Set-CsGroupPickupUserOrbit.md index 5b56d01e9e..ab9c43a013 100644 --- a/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsGroupPickupUserOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsGroupPickupUserOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csgrouppickupuserorbit +schema: 2.0.0 +title: Set-CsGroupPickupUserOrbit --- # Set-CsGroupPickupUserOrbit @@ -27,7 +28,7 @@ This cmdlet will throw an exception if the user is not assigned a group pickup o ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsGroupPickupUserOrbit "Ken Myer" -Orbit "*101" ``` @@ -40,18 +41,38 @@ In this case, the display name "Ken Myer". ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Orbit + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the new group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. -For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). +For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skypeforbusiness/New-CsCallParkOrbit). Values for the Orbit parameter must match the regular expression (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -61,6 +82,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the user whose group pickup orbit number will be modified. Because User is a positional parameter, the -User syntax is not required. The first parameter after the cmdlet is assumed to be the User parameter value. @@ -72,7 +96,6 @@ You can also reference a user account by using the user's Active Directory disti Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -82,13 +105,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -97,30 +122,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -134,12 +145,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String This cmdlet supports pipelined input from the `Get-CsUser` cmdlet. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit This cmdlet returns an instance of the Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsHealthMonitoringConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHealthMonitoringConfiguration.md index 6ad6748d7f..65f606934b 100644 --- a/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHealthMonitoringConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsHealthMonitoringConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshealthmonitoringconfiguration +schema: 2.0.0 +title: Set-CsHealthMonitoringConfiguration --- # Set-CsHealthMonitoringConfiguration @@ -54,7 +55,7 @@ This cmdlet provides a way for you to change either (or both) of the test accoun ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsHealthMonitoringConfiguration -Identity atl-cs-001.litwareinc.com -FirstTestUserSipUri "sip:kenmyer@litwareinc.com" -FirstTestSamAccountName "litwareinc\kenmyer" ``` @@ -63,7 +64,7 @@ The command shown in Example 1 configures the first test user assigned to the he In this example, the SIP address for the new test user is set to sip:kenmyer@litwareinc.com and the SamAccountName for the test user is set to kenmyer. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsHealthMonitoringConfiguration | Set-CsHealthMonitoringConfiguration -FirstTestUserSipUri "sip:kenmyer@litwareinc.com" -FirstTestSamAccountName "litwareinc\kenmyer" ``` @@ -74,7 +75,7 @@ To carry out this task, the command first uses the `Get-CsHealthMonitoringConfig This collection is then piped to the `Set-CsHealthMonitoringConfiguration` cmdlet, which assigns the same first test user SIP address and SamAccountName to each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsHealthMonitoringConfiguration | Where-Object {$_.FirstTestUserSipUri -eq "sip:pilar@litwareinc.com"} | Set-CsHealthMonitoringConfiguration -FirstTestUserSipUri "sip:kenmyer@litwareinc.com" -FirstTestSamAccountName "litwareinc\kenmyer" ``` @@ -88,50 +89,57 @@ That filtered collection is then piped to the `Set-CsHealthMonitoringConfigurati ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the pool where the health monitoring configuration settings to be modified have been assigned. -For example: `-Identity atl-cs-001.litwareinc.com`. +### -FirstTestSamAccountName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SamAccountName of the first test user. +The FirstTestSamAccountName must be entered using the format domain\username; for example: + +`-FirstTestSamAccountName litwareinc\kenmyer` ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -FirstTestUserSipUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the first test user to be configured for use by this collection of health monitoring settings. +Note that the SIP address must include the sip: prefix. +For example: `-FirstTestUserSipUri "sip:kenmyer@litwareinc.com"`. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -FirstTestSamAccountName -SamAccountName of the first test user. -The FirstTestSamAccountName must be entered using the format domain\username; for example: +### -Force -`-FirstTestSamAccountName litwareinc\kenmyer` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,25 +148,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FirstTestUserSipUri -SIP address of the first test user to be configured for use by this collection of health monitoring settings. -Note that the SIP address must include the sip: prefix. -For example: `-FirstTestUserSipUri "sip:kenmyer@litwareinc.com"`. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool where the health monitoring configuration settings to be modified have been assigned. +For example: `-Identity atl-cs-001.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 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -SecondTestSamAccountName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SamAccountName of the second test user. The SecondTestSamAccountName must be entered using the format domain\username; for example: @@ -167,8 +197,7 @@ The SecondTestSamAccountName must be entered using the format domain\username; f ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,6 +207,9 @@ Accept wildcard characters: False ``` ### -SecondTestUserSipUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the second test user to be configured for use by this collection of health monitoring settings. Note that the SIP address must include the sip: prefix. For example: `-FirstTestUserSipUri "sip:pilar@litwareinc.com"`. @@ -185,8 +217,7 @@ For example: `-FirstTestUserSipUri "sip:pilar@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 +Aliases: Required: False Position: Named @@ -195,14 +226,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -212,29 +245,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -248,14 +267,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings + The `Set-CsHealthMonitoringConfiguration` cmdlet accepts pipelined instances of the health monitoring configuration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsHealthMonitoringConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsHostedVoicemailPolicy.md similarity index 84% rename from skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHostedVoicemailPolicy.md index 812ec3758b..645efba7ca 100644 --- a/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHostedVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsHostedVoicemailPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshostedvoicemailpolicy +schema: 2.0.0 +title: Set-CsHostedVoicemailPolicy --- # Set-CsHostedVoicemailPolicy @@ -42,7 +43,7 @@ You can call the `Get-CsUser` cmdlet and check the HostedVoiceMail property to d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsHostedVoicemailPolicy -Identity ExRedmond -Destination ExUM.contoso.com ``` @@ -51,7 +52,7 @@ This command modifies the Destination property of a hosted voice mail policy nam It sets the Exchange UM destination for this policy to be at FQDN ExUM.contoso.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = (Get-CsHostedVoicemailPolicy -Identity ExRedmond).Organization @@ -70,7 +71,7 @@ The next line uses the += operator to append the assigned string (,corp3.litware Organization is a comma-separated list, so if there's already a value in the list any additional values need to be preceded by a comma.) Finally, in the last line we call the `Set-CsHostedVoicemailPolicy` cmdlet and assign the new Organization string by passing the variable $a to the parameter Organization. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsHostedVoicemailPolicy -Tenant "73d355dd-ce5d-4ab9-bf49-7b822c18dd98" -Destination "ExUM.contoso.com" ``` @@ -80,48 +81,16 @@ The command shown in Example 3 modifies the Destination property of the hosted v ## PARAMETERS -### -Identity -A unique identifier for the hosted voice mail policy you want to modify. -This identifier includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -The object must be of type HostedVoicemailPolicy and can be retrieved by calling the `Get-CsHostedVoicemailPolicy` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A friendly description of the policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +100,9 @@ Accept wildcard characters: False ``` ### -Destination + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value assigned to this parameter is the fully qualified domain name (FQDN) of the hosted Exchange UM service. Note that the chosen destination must be trusted for routing. @@ -142,8 +114,7 @@ This just means it should be in the form of an FQDN, such as server.litwareinc.c ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,15 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Organization -This parameter contains a comma-separated list of the Exchange tenants that contain Skype for Business Server users. -Each tenant must be specified as an FQDN of the tenant on the hosted Exchange Service. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,46 +141,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the hosted voice mail policy you want to modify. +This identifier includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +The object must be of type HostedVoicemailPolicy and can be retrieved by calling the `Get-CsHostedVoicemailPolicy` cmdlet. ```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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Organization + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter contains a comma-separated list of the Exchange tenants that contain Skype for Business Server users. +Each tenant must be specified as an FQDN of the tenant on the hosted Exchange Service. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -218,6 +199,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Server 2015 tenant account for which hosted voicemail policy being modified. For example: @@ -233,8 +217,43 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -248,13 +267,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy + Accepts pipelined input of hosted voice mail policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy This cmdlet modifies an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy ## NOTES diff --git a/skype/skype-ps/skype/Set-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsHostingProvider.md similarity index 86% rename from skype/skype-ps/skype/Set-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHostingProvider.md index 0e74e387f7..e446b6def4 100644 --- a/skype/skype-ps/skype/Set-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHostingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsHostingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshostingprovider +schema: 2.0.0 +title: Set-CsHostingProvider --- # Set-CsHostingProvider @@ -60,7 +61,7 @@ Note that you cannot federate with a hosting provider if your Edge Servers are c ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsHostingProvider -Identity "Fabrikam.com" -VerificationLevel "AlwaysUnverifiable" ``` @@ -69,7 +70,7 @@ Example 1 modifies the hosting provider with the Identity Fabrikam.com. In this example, the VerificationLevel property is set to AlwaysUnverifiable. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsHostingProvider | Set-CsHostingProvider -VerificationLevel "AlwaysUnverifiable" ``` @@ -79,7 +80,7 @@ To do this, `Get-CsHostingProvider` is first used to return a collection of all This collection is then piped to `Set-CsHostingProvider`, which modifies the VerificationLevel property for each provider in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsHostingProvider | Where-Object {$_.EnabledSharedAddressSpace -eq $True -and $_.HostsOCSUsers -eq $True} | Set-CsHostingProvider -EnabledSharedAddressSpace $False -HostsOCSUsers $False ``` @@ -93,40 +94,30 @@ When this is done any hosting providers in the collection will still be enabled ## PARAMETERS -### -Identity -Unique identifier for the hosting provider to be modified. -The Identity might be the FQDN of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). +### -AutodiscoverUrl -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, 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 -``` +URL for the autodiscover service used by a hosting provider that hosts Skype for Business Server accounts. +The autodiscover service enables client applications such as Microsoft Lync Mobile to determine how to access resources such as a user's home pool. -### -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 Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the network connection between your domain and the hosting provider is enabled. Messages cannot be exchanged between the two organizations until this value is set to True. The default value is False. @@ -134,8 +125,7 @@ The default value is 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 +Aliases: Required: False Position: Named @@ -145,14 +135,16 @@ Accept wildcard characters: False ``` ### -EnabledSharedAddressSpace + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, indicates that the hosting provider is being used in a split domain scenario. The default value is 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 +Aliases: Required: False Position: Named @@ -161,17 +153,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostsOCSUsers -If True, indicates that the hosting provider is used to host Skype for Business Server accounts. -If False, that indicates that the provider hosts other account types, such as Microsoft Exchange Server accounts. -The default value is False. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,16 +171,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsLocal -If True, indicates that the proxy server used by the hosting provider is contained within your own Skype for Business Server topology. +### -HostsOCSUsers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, indicates that the hosting provider is used to host Skype for Business Server accounts. +If False, that indicates that the provider hosts other account types, such as Microsoft Exchange Server accounts. The default value is 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 +Aliases: Required: False Position: Named @@ -198,45 +192,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VerificationLevel -Indicates the allowed verification level for messages sent to and from the hosted provider. -The VerificationLevel must be set to one of the following values: +### -Identity -AlwaysVerifiable. -Indicates that all messages sent from the hosting provider are considered verifiable. -That means that no messages from the hosting provider will be rejected. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -AlwaysUnverifiable. -Indicates that all messages sent from the hosting provider are considered unverifiable. -As a result, messages are passed only if the user on the hosting provider is also in your Contacts list. +Unique identifier for the hosting provider to be modified. +The Identity might be the FQDN of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). -UseSourceVerification. -Relies on the verification level included in messages sent from the hosting provider. -If this level is not specified, then the message will be rejected as being unverifiable. +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: -The default value is AlwaysVerifiable. +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: VerificationLevelType -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -IsLocal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, indicates that the proxy server used by the hosting provider is contained within your own Skype for Business Server topology. +The default value is False. + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,14 +249,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SipClientPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used by the provider for communicating with SIP clients; the default value is 443. +Note that, by default, the SipClientPort is not displayed when you run the `Get-CsHostingProvider` cmdlet. +To see the SipClientPort, use a command similar to this: + +`Get-CsHostingProvider | Select-Object *` ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,14 +271,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -VerificationLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the allowed verification level for messages sent to and from the hosted provider. +The VerificationLevel must be set to one of the following values: + +AlwaysVerifiable. +Indicates that all messages sent from the hosting provider are considered verifiable. +That means that no messages from the hosting provider will be rejected. + +AlwaysUnverifiable. +Indicates that all messages sent from the hosting provider are considered unverifiable. +As a result, messages are passed only if the user on the hosting provider is also in your Contacts list. + +UseSourceVerification. +Relies on the verification level included in messages sent from the hosting provider. +If this level is not specified, then the message will be rejected as being unverifiable. + +The default value is AlwaysVerifiable. ```yaml -Type: SwitchParameter +Type: VerificationLevelType Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,16 +304,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutodiscoverUrl -URL for the autodiscover service used by a hosting provider that hosts Skype for Business Server accounts. -The autodiscover service enables client applications such as Microsoft Lync Mobile to determine how to access resources such as a user's home pool. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -295,18 +322,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipClientPort -Port used by the provider for communicating with SIP clients; the default value is 443. -Note that, by default, the SipClientPort is not displayed when you run the `Get-CsHostingProvider` cmdlet. -To see the SipClientPort, use a command similar to this: +### -WhatIf -`Get-CsHostingProvider | Select-Object *` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -320,13 +345,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider + `Set-CsHostingProvider` accepts pipelined instances of the hosting provider object. ## OUTPUTS -### +### None `Set-CsHostingProvider` does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object. diff --git a/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridApplicationEndpoint.md similarity index 80% rename from skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHybridApplicationEndpoint.md index 33c98d57dc..29dda7ffb0 100644 --- a/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsHybridApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint +schema: 2.0.0 +title: Set-CsHybridApplicationEndpoint --- # Set-CsHybridApplicationEndpoint @@ -27,7 +28,7 @@ The `Set-CsHybridApplicationEndpoint` cmdlet enables you to modify the Skype for ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsHybridApplicationEndpoint -Identity "CN={4f6c99fe-7999-4088-ac4d-e88e0b3d3820},OU=Redmond,DC=litwareinc,DC=com" -DisplayName HybridAppEndpoint1 -LineURI tel:+14255550100 ``` @@ -36,30 +37,16 @@ This example modify the DisplayName and LineURI attributes for the specified hyb ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DisplayName -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DisplayName Friendly name for the application endpoint that is being modified. ```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 @@ -69,13 +56,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -85,13 +74,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The ApplicationId or Client Id for which the endpoint that is being modified. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 0 @@ -101,13 +92,15 @@ Accept wildcard characters: False ``` ### -LineUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Valid phone number for the application endpoint that is being modified. (Not currently supported through BOT framework) ```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 @@ -117,13 +110,33 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter 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 +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -133,13 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -164,8 +179,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint?view=skype-ps) -[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsHybridMediationServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridMediationServer.md similarity index 91% rename from skype/skype-ps/skype/Set-CsHybridMediationServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHybridMediationServer.md index 22cc44dca7..175b59d3ae 100644 --- a/skype/skype-ps/skype/Set-CsHybridMediationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridMediationServer.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-cshybridmediationserver applicable: Skype for Business Online -title: Set-CsHybridMediationServer -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridmediationserver +schema: 2.0.0 +title: Set-CsHybridMediationServer --- # Set-CsHybridMediationServer @@ -34,7 +36,7 @@ Users must be retrieved by their identity and they cannot already have assigned ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsHybridMediationServer -Fqdn users.fabrikam.com -AccessProxyExternalFqdn mediationserver.Contoso.com ``` @@ -45,13 +47,15 @@ This command sets the FQDN of a mediation server. ## PARAMETERS ### -AccessProxyExternalFqdn + +> Applicable: Skype for Business Online + The fully qualified domain name of the Edge server's access proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -61,13 +65,15 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Skype for Business Online + Specifies the fully qualified domain name of the mediation server that includes the internal Active Directory domain, such as mediationserver.contoso.com ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -77,14 +83,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the hybrid public switched telephone network (PSTN) site. For example: `-Identity "SeattlePSTN"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -93,14 +101,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -Tenant + +> Applicable: Skype for Business Online + +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` + +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. +The tenant ID will be determined by your connection and credentials. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -109,20 +125,16 @@ 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` +### -Confirm -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. -The tenant ID will be determined by your connection and credentials. -The Tenant parameter is primarily for use in a hybrid deployment. +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -132,6 +144,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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. @@ -139,7 +154,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 Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNAppliance.md similarity index 89% rename from skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNAppliance.md index b3f6d8058f..7b98d1ac92 100644 --- a/skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNAppliance.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-cshybridpstnappliance applicable: Skype for Business Online -title: Set-CsHybridPSTNAppliance -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridpstnappliance +schema: 2.0.0 +title: Set-CsHybridPSTNAppliance --- # Set-CsHybridPSTNAppliance @@ -45,7 +47,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Insert example commands for example 1. ``` @@ -55,30 +57,16 @@ Insert descriptive text for example 1. ## PARAMETERS -### -Identity -PARAMVALUE: XdsGlobalRelativeIdentity +### -Force -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +> Applicable: Skype for Business Online -Required: False -Position: 2 -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 +Aliases: Required: False Position: Named @@ -87,30 +75,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Identity + +> Applicable: Skype for Business Online + +PARAMVALUE: XdsGlobalRelativeIdentity ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online + PARAMVALUE: PSObject ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -120,6 +112,9 @@ Accept wildcard characters: False ``` ### -MaintenanceMode + +> Applicable: Skype for Business Online + If set to $True, service resilience detection will be off and no checks for Bits and OS updates will run. This allows administrators to make manual maintenance changes on the host machine. @@ -128,8 +123,7 @@ If set to $False, service resilience detection will be on and checks for Bits an ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -139,13 +133,15 @@ Accept wildcard characters: False ``` ### -MediationServerGruu + +> Applicable: Skype for Business Online + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -155,13 +151,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -171,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNSite.md similarity index 91% rename from skype/skype-ps/skype/Set-CsHybridPSTNSite.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNSite.md index 9cc149848a..55e75550db 100644 --- a/skype/skype-ps/skype/Set-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNSite.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-cshybridpstnsite applicable: Skype for Business Online -title: Set-CsHybridPSTNSite -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridpstnsite +schema: 2.0.0 +title: Set-CsHybridPSTNSite --- # Set-CsHybridPSTNSite @@ -43,7 +45,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsHybridPSTNSite -Identity "SeattlePSTN" -EdgeFQDN "Contoso.Denver.Edge.com" -BitsUpdateTimeWindow @{add="FirstWeekend","Night"} -OsUpdateTimeWindow @{add="Weekday"} ``` @@ -53,31 +55,16 @@ This example sets the "SeattlePSTN" site's edge server to "Contoso.Denver.Edge.c ## PARAMETERS -### -Identity -Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: `-Identity "SeattlePSTN"`. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +### -BitsUpdateTimeWindow -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -BitsUpdateTimeWindow Time window for updating Skype for Business Cloud Connector Edition bits on the appliance. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -86,31 +73,17 @@ 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 +### -EdgeFQDN -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -EdgeFQDN Specifies the fully qualified domain name of the edge server. For example: `-EdgeFQDN Contoso.Denver.Edge.com` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -120,6 +93,9 @@ Accept wildcard characters: False ``` ### -EnableAutoUpdate + +> Applicable: Skype for Business Online + If set to $true, automatic updates will be turned on for the Skype for Business Cloud Connector Edition appliance. If set to $false, automatic updates will be turned off for the Skype for Business Cloud Connector Edition appliance. The default is $true. @@ -127,8 +103,7 @@ The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -138,6 +113,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + 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. @@ -145,8 +123,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 +Aliases: Required: False Position: Named @@ -155,14 +132,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the hybrid public switched telephone network (PSTN) site. +For example: `-Identity "SeattlePSTN"`. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Skype for Business Online + 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: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -172,13 +170,15 @@ Accept wildcard characters: False ``` ### -OsUpdateTimeWindow + +> Applicable: Skype for Business Online + Time window for updating the operating system on the appliance. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -188,6 +188,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. @@ -200,8 +203,25 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -211,6 +231,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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. @@ -218,7 +241,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 Required: False Position: Named @@ -232,13 +254,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsIPPhonePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsIPPhonePolicy.md similarity index 83% rename from skype/skype-ps/skype/Set-CsIPPhonePolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsIPPhonePolicy.md index 944e00aac7..212b13a085 100644 --- a/skype/skype-ps/skype/Set-CsIPPhonePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsIPPhonePolicy.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-csipphonepolicy applicable: Skype for Business Server 2019 -title: Set-CsIPPhonePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csipphonepolicy +schema: 2.0.0 +title: Set-CsIPPhonePolicy --- # Set-CsIPPhonePolicy @@ -49,14 +51,14 @@ IP phone policies are applied each time a user accesses the system via an IP pho ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsIPPhonePolicy -UserDialTimeoutMS 10000 ``` This example modifies the global IP phone policy UserDialTimeoutMS parameter to 10 seconds (10000 ms). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsIPPhonePolicy -EnablePowerSaveMode $False -EnableOneTouchVoicemail $False -EnableDeviceUpdate $False ``` @@ -66,15 +68,17 @@ This example sets the EnablePowerSaveMode, EnableOneTouchVoicemail and EnableDev ## PARAMETERS ### -BetterTogetherOverEthernetPairingMode + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Valid values are: Auto - The phone will get paired with BTOE app Automatically and no need for the user to enter the pairing code. -Manual - The user needs to enter the pairing code manually to pair with the BTOE app. +Manual - The user needs to enter the pairing code manually to pair with the BTOE app. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,30 +87,16 @@ 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, Skype for Business Server 2019 +### -DateTimeFormat -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online, Skype for Business Server 2019 -### -DateTimeFormat Specifies the time format to be used. The acceptable values are "24" for a 24 hour time format, or "12" for a 12 hour format. The default is "24". ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +106,15 @@ Accept wildcard characters: False ``` ### -EnableBetterTogetherOverEthernet + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies whether the Better Together Over Ethernet (BTOE) feature is enabled for users. If $true, and if the BTOE plugin is installed on the IP device, the user can tether the device to a PC and sign in to Skype for Business. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,13 +124,15 @@ Accept wildcard characters: False ``` ### -EnableDeviceUpdate + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies whether the IP device will be updated by the Skype for Business service. If set to $true, IP devices will get firmware updates from the service, if $false the device will not be updated. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,13 +142,15 @@ Accept wildcard characters: False ``` ### -EnableExchangeCalendaring + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies whether an IP device is enabled to connect to the Exchange Online calendaring service. If $true, users are able to connect to their Exchange calendars. If $false, users will not be able to connect to their calendars. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,13 +160,15 @@ Accept wildcard characters: False ``` ### -EnableOneTouchVoicemail + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies whether the Visual Voicemail feature in Skype for Business Online is enabled. If set to $true, the feature is enabled, otherwise $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,13 +178,15 @@ Accept wildcard characters: False ``` ### -EnablePowerSaveMode + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + If enabled, phone goes to power saving mode (display turns off) based on values of the PowerSaveDuringOfficeHoursTimeoutMS and PowerSavePostOfficeHoursTimeoutMS parameters. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,13 +196,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + 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, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,13 +214,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -228,13 +232,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + 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: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,13 +250,15 @@ Accept wildcard characters: False ``` ### -KeyboardLockMaxPinRetry + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies the maximum number of retries allowed for phone unlock. The default is 5. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -260,13 +268,15 @@ Accept wildcard characters: False ``` ### -LocalProvisioningServerAddress -Specifies the address of the provisioning server for your organization. + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + +Specifies the address of the provisioning server for your organization. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -276,13 +286,15 @@ Accept wildcard characters: False ``` ### -LocalProvisioningServerPassword -Specifies the password for the provisioning server. + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + +Specifies the password for the provisioning server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,13 +304,15 @@ Accept wildcard characters: False ``` ### -LocalProvisioningServerType + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies the server type for the phone. The default is FTP. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,13 +322,15 @@ Accept wildcard characters: False ``` ### -LocalProvisioningServerUser + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies a username for the provisioning server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -324,13 +340,15 @@ Accept wildcard characters: False ``` ### -PowerSaveDuringOfficeHoursTimeoutMS + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies the time in milliseconds to wait during office hours before turning on Power Save mode. The default is 900,000. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -340,13 +358,15 @@ Accept wildcard characters: False ``` ### -PowerSavePostOfficeHoursTimeoutMS + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies the time in milliseconds to wait after office hours before turning on Power Save mode. The default is 300,000. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -356,13 +376,15 @@ Accept wildcard characters: False ``` ### -PrioritizedCodecsList + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies the order in which to prioritize codecs. The default is: "G722_8000;PCMU;PCMA;G729" ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -372,13 +394,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,13 +412,33 @@ Accept wildcard characters: False ``` ### -UserDialTimeoutMS -Specifies the time in milliseconds to wait in On-Hook mode before dialing out automatically. If a user enters a phone number and does not click Dial, the system will dial the number after the number of milliseconds specified. The default is 5000. + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + +Specifies the time in milliseconds to wait in On-Hook mode before dialing out automatically. If a user enters a phone number and does not click Dial, the system will dial the number after the number of milliseconds specified. The default is 5000. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -404,6 +448,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + System.Management.Automation.SwitchParameter 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. @@ -412,7 +459,6 @@ 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, Skype for Business Server 2019 Required: False Position: Named @@ -426,14 +472,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -System.Management.Automation.PSObject - +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser Microsoft.Rtc.Management.ADConnect.Schema.ADUser ## OUTPUTS -### System.Object +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact The `Set-CsIPPhonePolicy` cmdlet 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 diff --git a/skype/skype-ps/skype/Set-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsImConfiguration.md similarity index 81% rename from skype/skype-ps/skype/Set-CsImConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsImConfiguration.md index d086c199eb..76da3e69d0 100644 --- a/skype/skype-ps/skype/Set-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsImConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsImConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimconfiguration +schema: 2.0.0 +title: Set-CsImConfiguration --- # Set-CsImConfiguration @@ -34,7 +35,7 @@ Use the Set-CsImConfiguration cmdlet to modify an existing Instant Messaging (IM ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsImConfiguration -Identity "Site:Redmond" -EnableOfflineIm $false ``` @@ -43,30 +44,16 @@ This example modifies the existing Redmond site IM configuration to disable the ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableOfflineIm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableOfflineIm Enables or disables Offline Instant Messaging. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -76,13 +63,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -92,13 +81,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier specifying the scope and, in some cases the name, of the IM configuration. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -108,13 +99,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. This object must be of type IMConfiguration and can be retrieved by calling the Get-CsImConfiguration cmdlet. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,13 +117,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -140,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -169,8 +184,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimconfiguration?view=skype-ps) -[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsImFilterConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsImFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsImFilterConfiguration.md index cbe1b6db70..4f75c4ba86 100644 --- a/skype/skype-ps/skype/Set-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsImFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csimfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsImFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimfilterconfiguration +schema: 2.0.0 +title: Set-CsImFilterConfiguration --- # Set-CsImFilterConfiguration @@ -45,7 +46,7 @@ With this cmdlet you can also update various messages that provide warnings to u ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsImFilterConfiguration -Identity site:Redmond -Enabled $False ``` @@ -54,7 +55,7 @@ The command shown in this example disables URI filtering for the IM filter confi To carry out this task, the Enabled parameter is specified in the call to the `Set-CsImFilterConfiguration` cmdlet with a value of $False. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = Get-CsImFilterConfiguration -Identity site:Redmond @@ -70,7 +71,7 @@ This changes the value of the object reference $x. To change the actual configuration itself, line 3 calls the `Set-CsImFilterConfiguration` cmdlet, passing $x as the sole parameter value. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsImFilterConfiguration -Identity site:Redmond -Prefixes @{add="urn:"} ``` @@ -80,7 +81,7 @@ In this command the Prefixes parameter of the `Set-CsImFilterConfiguration` cmdl The add list modifier is used to add this value to the Prefixes list. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsImFilterConfiguration -Identity site:Redmond -Prefixes @{remove="urn:"} ``` @@ -91,41 +92,10 @@ This example is identical to Example 3 except that rather than calling the add l ## PARAMETERS -### -Identity -The unique identifier of the IM filter configuration settings you want to modify. -This value will either be global or site:\, where \ is the site to which the configuration applies, such as site:Redmond. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -This cmdlet accepts an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration, which can be retrieved by calling the `Get-CsImFilterConfiguration` cmdlet. +### -Action -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Action The value of this parameter determines the action that will be taken when a hyperlink is included in an instant message: Allow - Hyperlinks are prefixed with an underscore so that the links are no longer active. @@ -141,8 +111,7 @@ If Warn is specified and no WarnMessage is entered, IM filtering is disabled, al ```yaml Type: UrlFilterAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,14 +121,16 @@ Accept wildcard characters: False ``` ### -AllowMessage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If a value is specified for this parameter, that string is inserted at the beginning of each message containing hyperlinks when the value of the Action property is set to Allow. You can use this message to notify users of things such as the potential dangers of clicking unknown links or your organization's relevant policies and requirements. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,6 +140,9 @@ Accept wildcard characters: False ``` ### -BlockFileExtension + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If this parameter is set to True, a hyperlink that contains a file path with an extension specified by the Extensions property defined in the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration class (retrieved by calling the `Get-CsFileTransferFilterConfiguration` cmdlet) is blocked and an error message is returned to the sender. If this parameter is set to False, no special check is made for file paths and extensions. @@ -177,8 +151,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,6 +161,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables or disables this feature. If this parameter is set to True, instant messages will be scanned for hyperlinks and the rules in this configuration will be applied. If this parameter is set to False, messages will not be checked for hyperlinks. @@ -197,8 +173,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,7 +182,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the IM filter configuration settings you want to modify. +This value will either be global or site:\, where \ is the site to which the configuration applies, such as site:Redmond. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IgnoreLocal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value of this parameter controls whether filtering is performed on local Intranet URIs passed in instant messages.If this parameter is set to True, any URI that is defined in the Intranet zone of the local computer is ignored. (The local computer is the Front End Server running the IM Filter application.) If this parameter is set to False, the specified filtering is applied to all hyperlinks. @@ -216,8 +231,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -226,7 +240,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +This cmdlet accepts an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration, which can be retrieved by calling the `Get-CsImFilterConfiguration` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Prefixes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The list of URI prefixes that will be filtered. Any hyperlink included in an instant message with a prefix matching one of the prefixes in this list will be filtered according to the specified settings. @@ -235,8 +271,7 @@ Default: callto:, file:, ftp., ftp:, gopher:, href, http:, https:, ldap:, mailto ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,14 +281,16 @@ Accept wildcard characters: False ``` ### -WarnMessage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter contains the warning message that is inserted at the beginning of each instant message that contains hyperlinks when the value of the Action property is set to Warn. Typically this message would be used for such things as stating the potential dangers of clicking unknown links or referring to your organization's relevant policies and requirements. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -262,14 +299,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -279,29 +318,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -315,13 +340,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration + Accepts pipelined input of IM filter configuration objects. ## OUTPUTS -### +### None The `Set-CsImFilterConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsImTranslationConfiguration.md similarity index 80% rename from skype/skype-ps/skype/Set-CsImTranslationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsImTranslationConfiguration.md index 4b9375f9fb..a9f1d1172f 100644 --- a/skype/skype-ps/skype/Set-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsImTranslationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsImTranslationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimtranslationconfiguration +schema: 2.0.0 +title: Set-CsImTranslationConfiguration --- # Set-CsImTranslationConfiguration @@ -36,7 +37,7 @@ This cmdlet is reserved for internal Microsoft use. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` This cmdlet is reserved for internal Microsoft use. ``` @@ -47,13 +48,15 @@ This cmdlet is reserved for internal Microsoft use. ## PARAMETERS ### -AccessTokenUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -ApplicationId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -ClientId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -95,29 +102,15 @@ Accept wildcard characters: False ``` ### -ClientSecret -This parameter is reserved for internal Microsoft use. -```yaml -Type: String -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 -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,13 +120,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,13 +138,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -159,13 +156,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +174,15 @@ Accept wildcard characters: False ``` ### -ServiceUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,13 +192,33 @@ Accept wildcard characters: False ``` ### -TranslationType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -207,13 +228,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountAssignment.md similarity index 87% rename from skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md rename to skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountAssignment.md index 2805bab96e..6947be3199 100644 --- a/skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsKerberosAccountAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cskerberosaccountassignment +schema: 2.0.0 +title: Set-CsKerberosAccountAssignment --- # Set-CsKerberosAccountAssignment @@ -50,7 +51,7 @@ To assign an account to a site that currently is not associated with a Kerberos ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsKerberosAccountAssignment -UserAccount "litwareinc\keberostest" -Identity "site:Redmond" @@ -63,52 +64,53 @@ To do this, the first command in the example uses the `Set-CsKerberosAccountAssi ## PARAMETERS -### -Identity -Unique identifier of the site where the Kerberos account was assigned. -(This is the Identity of the site, not of the computer account.) For example: `-Identity "site:Redmond"`. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAccount -Account name for the account to be assigned, using the format domain_name\user_name. -For example: `-UserAccount "litwareinc\kerberostest"`. -The user name portion of the account (kerberostest) is a NETBIOS name and can contain a maximum of 15 characters. +### -Identity -Note that, despite the name UserAccount, the account is actually a computer account, not a user account. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier of the site where the Kerberos account was assigned. +(This is the Identity of the site, not of the computer account.) For example: `-Identity "site:Redmond"`. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,14 +119,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -UserAccount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Account name for the account to be assigned, using the format domain_name\user_name. +For example: `-UserAccount "litwareinc\kerberostest"`. +The user name portion of the account (kerberostest) is a NETBIOS name and can contain a maximum of 15 characters. + +Note that, despite the name UserAccount, the account is actually a computer account, not a user account. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,14 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -149,14 +160,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -170,13 +183,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment object. +### Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment + The `Set-CsKerberosAccountAssignment` cmdlet accepts pipelined instances of the Kerberos account assignment object. ## OUTPUTS -### +### None The `Set-CsKerberosAccountAssignment` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment object. diff --git a/skype/skype-ps/skype/Set-CsKerberosAccountPassword.md b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountPassword.md similarity index 85% rename from skype/skype-ps/skype/Set-CsKerberosAccountPassword.md rename to skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountPassword.md index 53c7a9e3e7..4cf9bc4c4a 100644 --- a/skype/skype-ps/skype/Set-CsKerberosAccountPassword.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountPassword.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cskerberosaccountpassword applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsKerberosAccountPassword -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cskerberosaccountpassword +schema: 2.0.0 +title: Set-CsKerberosAccountPassword --- # Set-CsKerberosAccountPassword @@ -50,7 +51,7 @@ In addition, the cmdlet can also use the ToComputer and FromComputer parameters ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsKerberosAccountPassword -UserAccount "litwareinc\kerberostest" ``` @@ -58,7 +59,7 @@ Set-CsKerberosAccountPassword -UserAccount "litwareinc\kerberostest" The command shown in Example 1 sets the password for the Kerberos account litwareinc\kerberostest. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsKerberosAccountPassword -FromComputer "atl-cs-001.litwareinc.com" -ToComputer "dublin-cs-001.litwareinc.com" ``` @@ -68,15 +69,35 @@ In Example 2, the Kerberos account password is copied from the computer atl-cs-0 ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -FromComputer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the computer containing the Kerberos account's password that will be copied to another computer. This parameter cannot be used if you use the UserAccount parameter. ```yaml Type: Fqdn Parameter Sets: ByFqdn -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -85,15 +106,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\SetKerberosPassword.html"`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ToComputer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of the computer where the Kerberos account password will be copied. This parameter cannot be used if you use the UserAccount parameter. ```yaml Type: Fqdn Parameter Sets: ByFqdn -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,6 +145,9 @@ Accept wildcard characters: False ``` ### -UserAccount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Account name for the account whose password should be changed. This account name must use the format domain_name\user_name; for example: `-UserAccount "litwareinc\kerberostest"`. @@ -111,8 +156,7 @@ Note that, despite the name UserAccount, the account is actually a computer acco ```yaml Type: String Parameter Sets: ByUser -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -121,31 +165,16 @@ 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 Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\SetKerberosPassword.html"`. +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -155,29 +184,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -191,12 +206,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### None The `Set-CsKerberosAccountPassword` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccount object. diff --git a/skype/skype-ps/skype/Set-CsLisLocation.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisLocation.md similarity index 64% rename from skype/skype-ps/skype/Set-CsLisLocation.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisLocation.md index 61ea6408ff..5161c4289a 100644 --- a/skype/skype-ps/skype/Set-CsLisLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslislocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslislocation +schema: 2.0.0 +title: Set-CsLisLocation --- # Set-CsLisLocation @@ -53,7 +54,7 @@ This information can be entered by using the `Set-CsLisPort` cmdlet, the `Set-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLisLocation -Location Bldg30NEWing -HouseNumber 1000 -StreetName Main -City Redmond -State WA -Country US ``` @@ -67,7 +68,7 @@ Note that if you run a command with just the parameters shown here you will be p However, you can simply press Enter at each prompt without supplying values and your location will be created. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsLisLocation -Location "Suite 100/Office 20" -CompanyName "Litware, Inc." -HouseNumber 1234 -HouseNumberSuffix "" -PreDirectional "" -StreetName Main -StreetSuffix St -PostDirectional "" -City Redmond -State WA -PostalCode 99999 -Country US ``` @@ -77,7 +78,7 @@ However, in this example the command specifies all the parameters for the cmdlet This will avoid the prompts that will follow the command in Example 1 because this example instead simply sets any values we want to leave blank to empty strings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $a = Get-CsLisLocation | Where-Object {$_.Location -ceq "Bldg30NEWing"} @@ -102,7 +103,7 @@ If it does, this example will not work. To modify multiple locations at once, see Example 4. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $a = Get-CsLisLocation | Where-Object {$_.Location -ceq "NorthCampus"} @@ -126,35 +127,18 @@ Simply pipe the results of the `Where-Object` cmdlet command to the `Set-CsLisLo ## PARAMETERS -### -Instance -A reference to a location object. -This object must contain the properties required to create a location. -You can retrieve an object of this type by calling the `Get-CsLisLocation` cmdlet. - - -```yaml -Type: PSObject -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -City -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -City The location city. Maximum length: 64 characters. ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -163,29 +147,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -CompanyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 The name of the company at this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -194,29 +166,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this location is in. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -225,20 +186,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumber -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumber The house number of the location. For a company this is the number on the street where the company is located. @@ -246,9 +197,8 @@ Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -257,20 +207,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -281,9 +221,8 @@ Maximum length: 5 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -292,20 +231,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a location object. +This object must contain the properties required to create a location. +You can retrieve an object of this type by calling the `Get-CsLisLocation` cmdlet. + ```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: LocationEnumeratedOptionalSet +Aliases: Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Location + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name for this location. Typically this value is the name of a location more specific than the civic address, such as an office number, but it can be any string value. @@ -313,9 +262,8 @@ Maximum length: 20 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -324,29 +272,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostalCode -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostalCode The postal code associated with this location. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -355,20 +292,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -376,9 +303,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -387,20 +313,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -408,9 +324,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -419,29 +334,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -450,29 +354,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -481,29 +374,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -512,27 +394,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -541,14 +412,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -562,14 +435,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS location objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. -It creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLisPort.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisPort.md similarity index 66% rename from skype/skype-ps/skype/Set-CsLisPort.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisPort.md index 62814d4f3e..858796c5bc 100644 --- a/skype/skype-ps/skype/Set-CsLisPort.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisPort.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslisport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisPort -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslisport +schema: 2.0.0 +title: Set-CsLisPort --- # Set-CsLisPort @@ -69,7 +70,7 @@ Keep in mind that although a new switch entry will be created, that switch will ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLisPort -ChassisID 99-99-99-99-99-99 -PortID 4200 -PortIDSubType 1 ``` @@ -89,7 +90,7 @@ That means that if this port were associated with an address (a physical locatio The location will still exist in the location database, but it will not be associated with this port. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsLisPort -ChassisID 99-99-99-99-99-99 -PortID 4200 -PortIdSubType 1 -Location "30/1000" -HouseNumber 1234 -PreDirectional NE -StreetName First -StreetSuffix Avenue -City Redmond -State WA -Country US -PostalCode 99999 ``` @@ -98,7 +99,7 @@ Example 2 updates the port created in Example 1 by adding address information. If the address does not exist in the location database, this cmdlet will create that location. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $a = Get-CsLisPort | Where-Object {$_.ChassisID -eq "99-99-99-99-99-88"} @@ -117,6 +118,9 @@ This cmdlet will take each item in that collection and update it with the values ## PARAMETERS ### -ChassisID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The MAC address of the port's switch. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab, or as an IP address. If the combination of ChassisID, PortID, and PortIDSubType is unique, a new port location will be created. @@ -125,8 +129,7 @@ If this combination is not unique, the port location with that key combination w ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, PortSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -136,15 +139,17 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The location city of this port. Maximum length: 64 characters. ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -153,29 +158,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CompanyName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CompanyName The name of the company at this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -184,29 +178,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this port is in. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -215,27 +198,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A detailed description of this port location. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, PortSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,6 +217,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The house number of the location for the port. For a company this is the number on the street where the company is located. @@ -252,9 +227,8 @@ Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -263,20 +237,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -287,9 +251,8 @@ Maximum length: 5 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -298,20 +261,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Location -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Location The name for this location. Typically this value is the name of a location more specific than the civic address, such as an office number, but it can be any string value. @@ -319,9 +272,8 @@ Maximum length: 20 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -330,27 +282,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PortID -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PortID The ID of the port associated with this location. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, PortSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -360,6 +301,9 @@ Accept wildcard characters: False ``` ### -PortIDSubType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The subtype of the port. This value can be entered as a numeric value or a string, but it must be a valid subtype. Valid subtypes are: @@ -375,8 +319,7 @@ Default: 7 (LocallyAssigned) ```yaml Type: PortIDSubType Parameter Sets: LocationEnumeratedOptionalSet, PortSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -386,15 +329,17 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The postal code associated with this location. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -403,20 +348,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -424,9 +359,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -435,20 +369,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -456,9 +380,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -467,29 +390,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -498,29 +410,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -529,29 +430,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -560,27 +450,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -589,14 +468,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -610,12 +491,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS port objects. ## OUTPUTS -### +### None This cmdlet creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLisServiceProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisServiceProvider.md similarity index 87% rename from skype/skype-ps/skype/Set-CsLisServiceProvider.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisServiceProvider.md index 135b7b925b..a7613cdfdc 100644 --- a/skype/skype-ps/skype/Set-CsLisServiceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisServiceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslisserviceprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisServiceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslisserviceprovider +schema: 2.0.0 +title: Set-CsLisServiceProvider --- # Set-CsLisServiceProvider @@ -35,7 +36,7 @@ This cmdlet will not succeed unless it can resolve the URL and security informat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $p = Read-Host -AsSecureString @@ -63,14 +64,16 @@ Finally, we pass the variable $p (which contains the secure string with the web ## PARAMETERS ### -CertFileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name (and full path) of the certificate file. This file must have a PFX file extension. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -80,14 +83,16 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A secure string containing the password needed to access the certificate in the password protected file. Secure strings can be created by using the `ConvertTo-SecureString` cmdlet or the `Read-Host` cmdlet with the AsSecureString parameter. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -ServiceProviderName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the E9-1-1 Network Routing Provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -113,14 +120,16 @@ Accept wildcard characters: False ``` ### -ValidationServiceUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The URL of the web service. This must be a secure URL, beginning with the prefix https://. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -129,14 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -145,14 +156,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -166,12 +179,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of Location Information Server (LIS) service provider objects. ## OUTPUTS -### +### None This cmdlet creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLisSubnet.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisSubnet.md similarity index 61% rename from skype/skype-ps/skype/Set-CsLisSubnet.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisSubnet.md index d8f243e8d0..6a2e1d6a40 100644 --- a/skype/skype-ps/skype/Set-CsLisSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslissubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslissubnet +schema: 2.0.0 +title: Set-CsLisSubnet --- # Set-CsLisSubnet @@ -61,7 +62,7 @@ It is recommended that you be as specific as possible with the location paramete ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLisSubnet -Subnet 192.10.10.0 ``` @@ -81,33 +82,18 @@ The location will still exist in the location database, but it will not be assoc ## PARAMETERS -### -Subnet -The IP address of the subnet. -This value should be entered as an IPv4 address (digits separated by periods, such as 192.0.2.0). - -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet, SubnetSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -City -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -City The location city. Maximum length: 64 characters. ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -116,29 +102,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CompanyName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CompanyName The name of the company at this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -147,29 +122,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this location is in. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -178,27 +142,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A detailed description of this subnet location. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, SubnetSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,6 +161,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The house number of the location. For a company this is the number on the street where the company is located. @@ -215,9 +171,8 @@ Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -226,20 +181,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -250,9 +195,8 @@ Maximum length: 5 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -261,20 +205,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Location -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Location The name for this location. Typically this value is the name of a location more specific than the civic address, such as an office number, but it can be any string value. @@ -282,9 +216,8 @@ Maximum length: 20 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -293,29 +226,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostalCode -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostalCode The postal code associated with this location. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -324,20 +246,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -345,9 +257,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -356,20 +267,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -377,9 +278,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -388,29 +288,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -419,29 +308,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -450,29 +328,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -481,11 +348,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Subnet + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The IP address of the subnet. +This value should be entered as an IPv4 address (digits separated by periods, such as 192.0.2.0). + ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, SubnetSet +Aliases: Required: True Position: Named @@ -494,14 +367,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -510,14 +385,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -531,12 +408,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS subnet objects. ## OUTPUTS -### +### None This cmdlet creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLisSwitch.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisSwitch.md similarity index 64% rename from skype/skype-ps/skype/Set-CsLisSwitch.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisSwitch.md index 13f563aa57..188cbe3bbb 100644 --- a/skype/skype-ps/skype/Set-CsLisSwitch.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisSwitch.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslisswitch applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisSwitch -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslisswitch +schema: 2.0.0 +title: Set-CsLisSwitch --- # Set-CsLisSwitch @@ -67,7 +68,7 @@ The MACResolverUrl property specifies the URL for a web service that is capable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLisSwitch -ChassisID 99-99-99-99-99-99 ``` @@ -85,7 +86,7 @@ That means that if this switch were associated with an address (a physical locat The location will still exist in the location database, but it will not be associated with this switch. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsLisSwitch -ChassisID 99-99-99-99-99-99 -Location "30/1000" -HouseNumber 1234 -PreDirectional NE -StreetName First -StreetSuffix Avenue -City Redmond -State WA -Country US -PostalCode 99999 ``` @@ -97,6 +98,9 @@ Example 2 updates the switch created in Example 1 by adding address information. ## PARAMETERS ### -ChassisID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Media Access Control (MAC) address of the network switch. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab, or in the form of an IP address. If an entry with the specified ChassisID value does not exist, a new switch location will be created. @@ -105,8 +109,7 @@ If an entry with the specified ChassisID does exist, that entry will be replaced ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, SwitchSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -116,15 +119,17 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The location city. Maximum length: 64 characters. ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -133,29 +138,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CompanyName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CompanyName The name of the company at this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -164,29 +158,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this location is in. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -195,27 +178,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A detailed description of this network switch location. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, SwitchSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +197,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The house number of the location. For a company this is the number on the street where the company is located. @@ -232,9 +207,8 @@ Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -243,20 +217,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -267,9 +231,8 @@ Maximum length: 5 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -278,20 +241,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Location -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Location The name for this location. Typically this value is the name of a location more specific than the civic address, such as an office number, but it can be any string value. @@ -299,9 +252,8 @@ Maximum length: 20 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -310,29 +262,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostalCode -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostalCode The postal code associated with this location. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -341,20 +282,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -362,9 +293,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -373,20 +303,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -394,9 +314,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -405,29 +324,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -436,29 +344,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -467,29 +364,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -498,27 +384,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -527,14 +402,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -548,12 +425,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS switch objects. ## OUTPUTS -### +### None This cmdlet creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisWirelessAccessPoint.md similarity index 62% rename from skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisWirelessAccessPoint.md index 31b0d854db..072bb2c515 100644 --- a/skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisWirelessAccessPoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csliswirelessaccesspoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisWirelessAccessPoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csliswirelessaccesspoint +schema: 2.0.0 +title: Set-CsLisWirelessAccessPoint --- # Set-CsLisWirelessAccessPoint @@ -62,7 +63,7 @@ It is recommended that you be as specific as possible with the location paramete ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLisWirelessAccessPoint -BSSID 99-99-99-99-99-99 ``` @@ -80,7 +81,7 @@ That means that if this WAP were associated with an address (a physical location The location will still exist in the location database, but it will not be associated with this WAP. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsLisWirelessAccessPoint -BSSID 99-99-99-99-99-99 -Location "30/1000" -HouseNumber 1234 -PreDirectional NE -StreetName First -StreetSuffix Avenue -City Redmond -State WA -Country US -PostalCode 99999 ``` @@ -92,6 +93,9 @@ Example 2 updates the WAP created in Example 1 by adding address information. ## PARAMETERS ### -BSSID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. If an entry with the specified BSSID value does not exist, a new WAP location will be created. @@ -100,8 +104,7 @@ If an entry with the specified BSSID does exist, that entry will be replaced. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, WAPSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -111,15 +114,17 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The location city. Maximum length: 64 characters. ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -128,29 +133,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CompanyName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CompanyName The name of the company at this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -159,29 +153,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this location is in. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -190,27 +173,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A detailed description of this WAP location. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, WAPSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,6 +192,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The house number of the location. For a company this is the number on the street where the company is located. @@ -227,9 +202,8 @@ Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -238,20 +212,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -262,9 +226,8 @@ Maximum length: 5 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -273,20 +236,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Location -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Location The name for this location. Typically this value is the name of a location more specific than the civic address, such as an office number, but it can be any string value. @@ -294,9 +247,8 @@ Maximum length: 20 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -305,29 +257,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostalCode -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostalCode The postal code associated with this location. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -336,20 +277,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -357,9 +288,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -368,20 +298,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -389,9 +309,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -400,29 +319,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -431,29 +339,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -462,29 +359,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -493,27 +379,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -522,14 +397,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -543,12 +420,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS wireless access point objects. ## OUTPUTS -### +### None This cmdlet creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsLocationPolicy.md similarity index 86% rename from skype/skype-ps/skype/Set-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLocationPolicy.md index 6586f63b11..dcad945a92 100644 --- a/skype/skype-ps/skype/Set-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslocationpolicy +schema: 2.0.0 +title: Set-CsLocationPolicy --- # Set-CsLocationPolicy @@ -49,7 +50,7 @@ This cmdlet modifies an existing location policy. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLocationPolicy -Identity site:Redmond -EnhancedEmergencyServicesEnabled $True ``` @@ -58,7 +59,7 @@ This command uses the `Set-CsLocationPolicy` cmdlet to modify the location polic (In other words, it modifies the location policy applied to the Redmond site.) In this case, the command sets the value of the EnhancedEmergencyServicesEnabled property to True, which will enable E9-1-1 functionality for all users connected to (in this case) the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLocationPolicy | Where-Object {$_.ConferenceUri -ne $null} | Set-CsLocationPolicy -ConferenceMode twoway ``` @@ -72,46 +73,10 @@ This collection is then piped to the `Set-CsLocationPolicy` cmdlet, which then m ## PARAMETERS -### -Identity -The unique identifier of the location policy you want to modify. -To modify the global location policy, use a value of Global. -For a policy created at the site scope, this value will be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment (for example, site:Redmond). -For a policy created at the per-user scope, this value will simply be the name of the policy, such as Reno. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -A reference to a location policy object. -This object must be of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy, which can be retrieved by calling the `Get-CsLocationPolicy` cmdlet. -Retrieve this object, change the properties in memory and then pass the object reference as a value to this parameter to update that location policy. - +### -ConferenceMode -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConferenceMode If a value is specified for the ConferenceUri parameter, the ConferenceMode parameter determines whether a third party can participate in the call or can only listen in. Available values are: @@ -123,8 +88,7 @@ Twoway: Third party can listen in and participate in the call between the caller ```yaml Type: ConferenceModeEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +98,9 @@ Accept wildcard characters: False ``` ### -ConferenceUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The SIP Uniform Resource Identifier (URI), in this case the telephone number, of a third party that will be conferenced in to any emergency calls that are made. For example, the company security office could receive a call when an emergency call is made and listen in or participate in that call (depending on the value of the ConferenceMode property). @@ -142,8 +109,7 @@ The string must be from 1 to 256 characters in length and must begin with the pr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,14 +119,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A detailed description of this location. For example, "Building 30, 3rd Floor, Northeast corner". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,6 +138,9 @@ Accept wildcard characters: False ``` ### -EmergencyDialMask + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number that is dialed that will be translated into the value of the EmergencyDialString property. For example, if EmergencyDialMask has a value of "212" and EmergencyDialString has a value of "911", if a user dials 212 the call will be made to 911. This allows for alternate emergency numbers to be dialed and still have the call reach emergency services (for example, if someone from a country/region with a different emergency number attempts to dial that country/region's number rather than the number for the country/region they're currently in). @@ -187,8 +158,7 @@ Each character must be a digit 0 through 9. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,6 +168,9 @@ Accept wildcard characters: False ``` ### -EmergencyDialString + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number that is dialed to reach emergency services. In the United States this value is "911". @@ -206,8 +179,7 @@ The string must be made of the digits 0 through 9 and can be from 1 to 10 charac ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -216,16 +188,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnhancedEmergencyServicesEnabled -Specifies whether the users associated with this policy are enabled for E9-1-1. -Set the value to True to enable E9-1-1, so Skype for Business Server clients will retrieve location information on registration and include that information when an emergency call is made. +### -EmergencyNumbers +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill EmergencyNumbers Description}} ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,23 +206,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationRequired -If the client was unable to retrieve a location from the location configuration database, the user can be prompted to manually enter a location. -This parameter accepts the following values: +### -EnhancedEmergencyServiceDisclaimer -- no: The user will not be prompted for a location. When a call is made with no location information, the Emergency Service Provider will answer the call and ask for a location. -- yes: The user will be prompted to input location information when the client registers at a new location. The user can dismiss the prompt without entering any information. If information is entered, a call made to 911 will first be answered by the Emergency Service Provider to verify the location before being routed to the PSAP (that is, the 911 operator). -- disclaimer: This option is the same as yes except that if the user dismisses the prompt disclaimer text will be displayed that can alert the user to the consequences of declining to enter location information. (The disclaimer text must be set by calling the `Set-CsEnhancedEmergencyServiceDisclaimer` cmdlet.) +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This value is ignored if EnhancedEmergencyServicesEnabled is set to False (the default). -Users will not be prompted for location information. +Text value containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. +To remove a service disclaimer from a location policy set this property to a null value: + +`-EnhancedEmergencyServiceDisclaimer $Null` + +Location policies, and the EnhancedEmergencyServiceDisclaimer property, should be used in Skype for Business Server to set disclaimers for the E9-1-1 service. +By using location policies to set these disclaimers, you can create different disclaimers for different locales or different sets of users. ```yaml -Type: LocationRequiredEnum +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -259,23 +231,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationUri -One or more SIP Uniform Resource Identifiers (URIs) to be notified when an emergency call is made. -For example, the company security office could be notified through an instant message whenever an emergency call is made. -If the caller's location is available that location will be included in the notification. +### -EnhancedEmergencyServicesEnabled -Multiple SIP URIs can be included as a comma-separated list. -For example, `-NotificationUri sip:security@litwareinc.com,sip:kmyer@litwareinc.com`. -Note that, with the release of Skype for Business Server distribution lists can now be configured as a notification URI. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The string must be from 1 to 256 characters in length and must begin with the prefix sip:. +Specifies whether the users associated with this policy are enabled for E9-1-1. +Set the value to True to enable E9-1-1, so Skype for Business Server clients will retrieve location information on registration and include that information when an emergency call is made. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,19 +251,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsage -The public switched telephone network (PSTN) usage that will be used to determine which voice route will be used to route 911 calls from clients using this profile. -The route associated with this usage should point to a SIP trunk dedicated to emergency calls. +### -Force -The usage must already exist in the global list of PSTN usages. -Call the `Get-CsPstnUsage` cmdlet to retrieve a list of usages. -To create a new usage, call the `Set-CsPstnUsage` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -305,48 +269,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseLocationForE911Only -Location information can be used by the Skype for Business Server client for various reasons (such as notifying teammates of current location). -Set this value to True to ensure location information is available only for use with an emergency call. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the location policy you want to modify. +To modify the global location policy, use a value of Global. +For a policy created at the site scope, this value will be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment (for example, site:Redmond). +For a policy created at the per-user scope, this value will simply be the name of the policy, such as Reno. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a location policy object. +This object must be of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy, which can be retrieved by calling the `Get-CsLocationPolicy` cmdlet. +Retrieve this object, change the properties in memory and then pass the object reference as a value to this parameter to update that location policy. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LocationRefreshInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in hours) between client requests for Location Information service location update. +The LocationRefreshInterval can be set to any value between 1 and 12; the default value is 4. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -355,14 +331,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -LocationRequired + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If the client was unable to retrieve a location from the location configuration database, the user can be prompted to manually enter a location. +This parameter accepts the following values: + +- no: The user will not be prompted for a location. When a call is made with no location information, the Emergency Service Provider will answer the call and ask for a location. +- yes: The user will be prompted to input location information when the client registers at a new location. The user can dismiss the prompt without entering any information. If information is entered, a call made to 911 will first be answered by the Emergency Service Provider to verify the location before being routed to the PSAP (that is, the 911 operator). +- disclaimer: This option is the same as yes except that if the user dismisses the prompt disclaimer text will be displayed that can alert the user to the consequences of declining to enter location information. (The disclaimer text must be set by calling the `Set-CsEnhancedEmergencyServiceDisclaimer` cmdlet.) + +This value is ignored if EnhancedEmergencyServicesEnabled is set to False (the default). +Users will not be prompted for location information. + ```yaml -Type: SwitchParameter +Type: LocationRequiredEnum Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -371,21 +358,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnhancedEmergencyServiceDisclaimer -Text value containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. -To remove a service disclaimer from a location policy set this property to a null value: +### -NotificationUri -`-EnhancedEmergencyServiceDisclaimer $Null` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Location policies, and the EnhancedEmergencyServiceDisclaimer property, should be used in Skype for Business Server to set disclaimers for the E9-1-1 service. -By using location policies to set these disclaimers, you can create different disclaimers for different locales or different sets of users. +One or more SIP Uniform Resource Identifiers (URIs) to be notified when an emergency call is made. +For example, the company security office could be notified through an instant message whenever an emergency call is made. +If the caller's location is available that location will be included in the notification. + +Multiple SIP URIs can be included as a comma-separated list. +For example, `-NotificationUri sip:security@litwareinc.com,sip:kmyer@litwareinc.com`. +Note that, with the release of Skype for Business Server distribution lists can now be configured as a notification URI. + +The string must be from 1 to 256 characters in length and must begin with the prefix sip:. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -394,15 +385,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationRefreshInterval -Specifies the amount of time (in hours) between client requests for Location Information service location update. -The LocationRefreshInterval can be set to any value between 1 and 12; the default value is 4. +### -PstnUsage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The public switched telephone network (PSTN) usage that will be used to determine which voice route will be used to route 911 calls from clients using this profile. +The route associated with this usage should point to a SIP trunk dedicated to emergency calls. + +The usage must already exist in the global list of PSTN usages. +Call the `Get-CsPstnUsage` cmdlet to retrieve a list of usages. +To create a new usage, call the `Set-CsPstnUsage` cmdlet. ```yaml -Type: Int64 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -412,6 +409,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the location policy is being modified. For example: @@ -424,8 +424,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -434,14 +433,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmergencyNumbers -{{Fill EmergencyNumbers Description}} +### -UseLocationForE911Only + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Location information can be used by the Skype for Business Server client for various reasons (such as notifying teammates of current location). +Set this value to True to ensure location information is available only for use with an emergency call. + ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -455,13 +494,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy + Accepts pipelined input of location policy objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy object. diff --git a/skype/skype-ps/skype/Set-CsManagementConnection.md b/skype/skype-ps/SkypeForBusiness/Set-CsManagementConnection.md similarity index 89% rename from skype/skype-ps/skype/Set-CsManagementConnection.md rename to skype/skype-ps/SkypeForBusiness/Set-CsManagementConnection.md index 66a2a17e21..63c5b79500 100644 --- a/skype/skype-ps/skype/Set-CsManagementConnection.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsManagementConnection.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmanagementconnection applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsManagementConnection -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmanagementconnection +schema: 2.0.0 +title: Set-CsManagementConnection --- # Set-CsManagementConnection @@ -47,7 +48,7 @@ You cannot use the `Set-CsManagementConnection` cmdlet to change the management ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsManagementConnection -StoreProvider Sql -Connection "atl-sql-001.litwareinc.com\rtcbackup" ``` @@ -55,7 +56,7 @@ Set-CsManagementConnection -StoreProvider Sql -Connection "atl-sql-001.litwarein The command shown in Example 1 changes the management connection to the SQL Server instance rtcbackup found on the computer atl-sql-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsManagementConnection -StoreProvider FileSystem -Connection "C:\TestTopology" ``` @@ -66,6 +67,9 @@ In Example 2, the management connection is set to file system and, more specific ## PARAMETERS ### -Connection + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Location information for the SQL Server instance or the file system folder being used as the management connection. For example, if the new management connection is to a SQL Server instance named rtcbackup on the computer atl-sql-001.litwareinc.com then use this syntax: `-Connection "atl-sql-001.litwareinc.com\rtcbackup"`. @@ -77,8 +81,7 @@ If the folder does not exist, the `Set-CsManagementConnection` cmdlet will creat ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 3 @@ -87,7 +90,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableCaching + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), caching is enabled for the management connection. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StoreProvider + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the type of back-end store used for configuration information. For example, to store configuration data in SQL Server, set the StoreProvider like this: -StoreProvider Sql. In general, you should not modify the StoreProvider property unless instructed to do so by Microsoft support personnel. @@ -106,8 +130,7 @@ Azure ```yaml Type: StoreProvider Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -116,30 +139,16 @@ 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 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 @@ -148,14 +157,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableCaching -When set to True ($True), caching is enabled for the management connection. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -169,13 +180,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsManagementConnection` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsManagementConnection` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Store.StoreProvider object. diff --git a/skype/skype-ps/skype/Set-CsManagementServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsManagementServer.md similarity index 84% rename from skype/skype-ps/skype/Set-CsManagementServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsManagementServer.md index 0d77658545..848d3976d3 100644 --- a/skype/skype-ps/skype/Set-CsManagementServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsManagementServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmanagementserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsManagementServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmanagementserver +schema: 2.0.0 +title: Set-CsManagementServer --- # Set-CsManagementServer @@ -33,7 +34,7 @@ The `Set-CsManagementServer` cmdlet enables you to specify the port that the Cen ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsManagementServer -Identity "ManagementServer:atl-cs-001.litwareinc.com" -ReplicationServicePort 5076 ``` @@ -43,7 +44,28 @@ The command shown in Example 1 connects to the Central Management service with t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the Central Management service. For example: `-Identity "ManagementServer:atl-cs-001.litwareinc.com"`. @@ -53,8 +75,7 @@ For example: `-Identity "atl-cs-001.litwareinc.com"`. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -64,13 +85,15 @@ Accept wildcard characters: False ``` ### -ReplicationServicePort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number for the replication port used by the Central Management service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,14 +102,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -96,29 +121,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -132,13 +143,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsManagementServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsManagementServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayManagementServer object. diff --git a/skype/skype-ps/skype/Set-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsMcxConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsMcxConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMcxConfiguration.md index 664b12f04d..9c220565e4 100644 --- a/skype/skype-ps/skype/Set-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMcxConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmcxconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMcxConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmcxconfiguration +schema: 2.0.0 +title: Set-CsMcxConfiguration --- # Set-CsMcxConfiguration @@ -49,7 +50,7 @@ The `Set-CsMcxConfiguration` cmdlet provides a way for administrators to modify ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsMcxConfiguration -Identity site:Redmond -ExposedWebURL External ``` @@ -57,7 +58,7 @@ Set-CsMcxConfiguration -Identity site:Redmond -ExposedWebURL External In Example 1, the ExposedWebURL property for the Mobility Service configuration settings assigned to the Redmond site is set to External. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMcxConfiguration | Set-CsMcxConfiguration -ExposedWebURL External ``` @@ -67,7 +68,7 @@ To do this, the command first uses the `Get-CsMcxConfiguration` cmdlet without a That collection is then piped to the `Set-CsMcxConfiguration`, which sets the ExposedWebURL property for each item in the collection to External. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMcxConfiguration | Where-Object {$_.SessionShortExpirationInterval -gt 3600} | Set-CsMcxConfiguration -SessionShortExpirationInterval 3600 ``` @@ -80,23 +81,10 @@ This filtered collection is then piped to the `Set-CsMcxConfiguration` cmdlet, w ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ExposedWebURL -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ExposedWebURL Indicates whether the URL used by the Autodiscovery Service is accessible to users both inside and outside the organization firewall (External) or only accessible to users inside the firewall (Internal). Allowed values are: Internal or External. @@ -105,8 +93,7 @@ The default value is External. ```yaml Type: ExposedWebURL Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +103,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +121,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the unique identifier of the collection of Mobility Service configuration settings to be modified. To modify the global settings, use the following syntax: @@ -152,8 +144,7 @@ If this parameter is not specified, then the `Set-CsMcxConfiguration` cmdlet wil ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -163,13 +154,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +172,9 @@ Accept wildcard characters: False ``` ### -PushNotificationProxyUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URI of a service provider that can forward push notification requests to the Apple Push Notification Service and the Microsoft Push Notification Service. The PushNotificationProxyUri must be in the form of a SIP address; for example: @@ -187,8 +183,7 @@ The PushNotificationProxyUri must be in the form of a SIP address; for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,6 +193,9 @@ Accept wildcard characters: False ``` ### -SessionExpirationInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Length of time, in seconds, of a mobile session for iPhone or Windows Phone users. If Skype for Business is running in the background on these phones, users will receive push notifications as long as the session expiration interval has not expired. @@ -212,8 +210,7 @@ Note that the value of the SessionExpirationInterval property must be greater th ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -223,6 +220,9 @@ Accept wildcard characters: False ``` ### -SessionShortExpirationInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Length of time, in seconds, of a mobile session for Android or Nokia phone users. The mobile device must send a notice to the server indicating that the device is still active before the session timeout is reached. @@ -236,8 +236,25 @@ Note that the value of the SessionExpirationInterval property must be greater th ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -247,13 +264,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -267,14 +286,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object. +### Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration + The `Set-CsMcxConfiguration` cmdlet accepts pipelined instances of the McxConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsMcxConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsMediaConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsMediaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMediaConfiguration.md index 17f1f8b8b8..f6a2deb736 100644 --- a/skype/skype-ps/skype/Set-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMediaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMediaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmediaconfiguration +schema: 2.0.0 +title: Set-CsMediaConfiguration --- # Set-CsMediaConfiguration @@ -25,7 +26,7 @@ Set-CsMediaConfiguration [[-Identity] ] [-EnableQoS ] [-En [-EncryptionLevel ] [-MaxVideoRateAllowed ] [-Force] [-WhatIf] [-Confirm] [-EnableAdaptiveBandWidthEstimation ] [-EnableG722StereoCodec ] [-EnableH264Codec ] [-EnableInCallQoS ] [-EnableRtpRtcpMultiplexing ] - [-InCallQoSIntervalSeconds ] [-EnableVideoBasedSharing ] [-EnableDtls ] [-EnableSilkForAudioVideoConferences ] -[EnableServerFecForVideoInterop] [-WaitIceCompletedToAddDialOutUser] [-EnableRtx ] [-EnableAVBundling ] [-EnableReceiveAgc ] + [-InCallQoSIntervalSeconds ] [-EnableVideoBasedSharing ] [-EnableDtls ] [-EnableSilkForAudioVideoConferences ] -[EnableServerFecForVideoInterop] [-WaitIceCompletedToAddDialOutUser] [-EnableRtx ] [-EnableAVBundling ] [-EnableReceiveAgc ] [] ``` @@ -35,7 +36,7 @@ Set-CsMediaConfiguration [-Instance ] [-EnableQoS ] [-EnableS [-EncryptionLevel ] [-MaxVideoRateAllowed ] [-Force] [-WhatIf] [-Confirm] [-EnableAdaptiveBandWidthEstimation ] [-EnableG722StereoCodec ] [-EnableH264Codec ] [-EnableInCallQoS ] [-EnableRtpRtcpMultiplexing ] - [-InCallQoSIntervalSeconds ] [-EnableVideoBasedSharing ] [-EnableDtls ] [-EnableSilkForAudioVideoConferences ] -[EnableServerFecForVideoInterop] [-WaitIceCompletedToAddDialOutUser] [-EnableRtx ] [-EnableAVBundling ] [-EnableReceiveAgc ] + [-InCallQoSIntervalSeconds ] [-EnableVideoBasedSharing ] [-EnableDtls ] [-EnableSilkForAudioVideoConferences ] -[EnableServerFecForVideoInterop] [-WaitIceCompletedToAddDialOutUser] [-EnableRtx ] [-EnableAVBundling ] [-EnableReceiveAgc ] [] ``` @@ -69,50 +70,50 @@ Note that this value is not case sensitive; the value was entered as donotsuppor ## PARAMETERS -### -Identity -The unique identifier of the media configuration settings you want to change. -This identifier specifies the scope at which this configuration is applied (global, site, or service). +### -EnableAdaptiveBandWidthEstimation + +> Applicable: Lync Server 2013 + +When set to True (the default value) Microsoft Lync Server will select the bandwidth rate at which to play a video stream. +This selection will be based on such factors as the network congestion and the client's quality of the client's current network connection. This parameter was removed starting Lync Server Cumulative Update 3. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -An instance of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. -You can retrieve this object by calling the `Get-CsMediaConfiguration` cmdlet with a specific Identity. -You can then assign new values to the properties of that object and then save those changes by passing the object to the `Set-CsMediaConfiguration` cmdlet. - +### -EnableAVBundling +This parameter is reserved for internal Microsoft use. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableQoS -QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings. +### -EnableDtls + +> Applicable: Skype for Business Server 2019 + +Enables the use of Datagram Transport Layer Security (DTLS) for ICE ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,16 +122,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSiren -By default, the Mediation Server does not negotiate Siren as a possible codec for calls between itself and other clients. -If this setting is True, Siren will be included as a possible codec for use between the Mediation Server and other clients. +### -EnableG722StereoCodec +> Applicable: Lync Server 2013 + +When set to True (the default value) allows the use of the G.722 wideband speech codec. +G.722 is a standard voice codec commonly used with Voice over IP applications; with a sampling rate of 16 KHz G.722 provides higher voice quality and clarity than many other commonly-used speech codecs. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,28 +141,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptionLevel -The level of encryption between unified communications devices. - -Valid values: - -SupportEncryption - secure real-time transport protocol (SRTP) will be used if it can be negotiated. - -RequireEncryption - SRTP must be negotiated. - -DoNotSupportEncryption - SRTP must not be used. - -This value is not case sensitive. -(For details, see the Examples in this topic.) +### -EnableH264Codec -Default: RequireEncryption +> Applicable: Lync Server 2013 +When set to True (the default value) allows the use of the H.264/MPEG-4 AVC video codec. +H.264 is a standard codec commonly used for recording, compressing and distributing high-definition video. ```yaml -Type: EncryptionLevel +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,27 +160,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxVideoRateAllowed -The maximum rate at which video signals will be transferred at the client endpoints. - -Valid values: Hd720p15M, VGA600K, CIF250K - -Hd720p15M - High definition, with a resolution of 1280 x 720 and aspect ratio 16:9. - -VGA600K - VGA, with a resolution of 640 x 480, 25 fps with the aspect ratio 4:3. +### -EnableInCallQoS -CIF250K - Common Intermediate Format (CIF) video format, 15 fps with a resolution of 352 x 288. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Note that these values are not case sensitive; values will be converted to appropriate casing when the configuration is created. -(For details, see the Examples in this topic.) - -Default: VGA600K +Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages. ```yaml -Type: MaxVideoRateAllowed +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,14 +178,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -EnableQoS + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -214,14 +196,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -EnableReceiveAgc +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,31 +211,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableRtpRtcpMultiplexing + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables or disables the use of RTP/RTCP Multiplexing, if enabled, when negotiating, only one candidate will be used for both RTP and RTCP. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAdaptiveBandWidthEstimation -When set to True (the default value) Microsoft Lync Server will select the bandwidth rate at which to play a video stream. -This selection will be based on such factors as the network congestion and the client's quality of the client's current network connection. This parameter was removed starting Lync Server Cumulative Update 3. +### -EnableRtx +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -263,15 +244,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableG722StereoCodec -When set to True (the default value) allows the use of the G.722 wideband speech codec. -G.722 is a standard voice codec commonly used with Voice over IP applications; with a sampling rate of 16 KHz G.722 provides higher voice quality and clarity than many other commonly-used speech codecs. +### -EnableServerFecForVideoInterop + +> Applicable: Skype for Business Server 2019 + +Enables the use of server Forward Error Correction for video interoperability ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -280,15 +262,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableH264Codec -When set to True (the default value) allows the use of the H.264/MPEG-4 AVC video codec. -H.264 is a standard codec commonly used for recording, compressing and distributing high-definition video. +### -EnableSilkForAudioVideoConferences + +> Applicable: Skype for Business Server 2019 + +Enables the use of SILK codec for A/V conferences ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -297,14 +280,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableInCallQoS -Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages. +### -EnableSiren + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +By default, the Mediation Server does not negotiate Siren as a possible codec for calls between itself and other clients. +If this setting is True, Siren will be included as a possible codec for use between the Mediation Server and other clients. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -313,30 +300,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRtpRtcpMultiplexing -Enables or disables the use of RTP/RTCP Multiplexing, if enabled, when negotiating, only one candidate will be used for both RTP and RTCP. +### -EnableVideoBasedSharing + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InCallQoSIntervalSeconds -Specifies the interval between call QoS actions. +### -EncryptionLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The level of encryption between unified communications devices. + +Valid values: + +SupportEncryption - secure real-time transport protocol (SRTP) will be used if it can be negotiated. + +RequireEncryption - SRTP must be negotiated. + +DoNotSupportEncryption - SRTP must not be used. + +This value is not case sensitive. +(For details, see the Examples in this topic.) + +Default: RequireEncryption + ```yaml -Type: UInt16 +Type: EncryptionLevel Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -345,14 +350,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVideoBasedSharing -Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -361,30 +368,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDtls -Enables the use of Datagram Transport Layer Security (DTLS) for ICE +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the media configuration settings you want to change. +This identifier specifies the scope at which this configuration is applied (global, site, or service). ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSilkForAudioVideoConferences -Enables the use of SILK codec for A/V conferences +### -InCallQoSIntervalSeconds + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the interval between call QoS actions. ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -393,30 +405,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableServerFecForVideoInterop -Enables the use of server Forward Error Correction for video interoperability +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An instance of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. +You can retrieve this object by calling the `Get-CsMediaConfiguration` cmdlet with a specific Identity. +You can then assign new values to the properties of that object and then save those changes by passing the object to the `Set-CsMediaConfiguration` cmdlet. + ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WaitIceCompletedToAddDialOutUser -Waits until ICE negotiation is complete to dial out other people +### -MaxVideoRateAllowed + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum rate at which video signals will be transferred at the client endpoints. + +Valid values: Hd720p15M, VGA600K, CIF250K + +Hd720p15M - High definition, with a resolution of 1280 x 720 and aspect ratio 16:9. + +VGA600K - VGA, with a resolution of 640 x 480, 25 fps with the aspect ratio 4:3. + +CIF250K - Common Intermediate Format (CIF) video format, 15 fps with a resolution of 352 x 288. + +Note that these values are not case sensitive; values will be converted to appropriate casing when the configuration is created. +(For details, see the Examples in this topic.) + +Default: VGA600K ```yaml -Type: Boolean +Type: MaxVideoRateAllowed Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -425,8 +457,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRtx -This parameter is reserved for internal Microsoft use. +### -WaitIceCompletedToAddDialOutUser + +> Applicable: Skype for Business Server 2019 + +Waits until ICE negotiation is complete to dial out other people ```yaml Type: Boolean @@ -440,13 +475,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAVBundling -This parameter is reserved for internal Microsoft use. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -455,13 +493,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReceiveAgc -This parameter is reserved for internal Microsoft use. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -475,15 +516,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings Accepts pipelined input of media configuration objects. ## OUTPUTS -### -The `Set-CsMediaConfiguration` cmdlet does not return a value or object. -Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsMediationServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsMediationServer.md similarity index 84% rename from skype/skype-ps/skype/Set-CsMediationServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMediationServer.md index 35d51973bb..8f4cdd6b2a 100644 --- a/skype/skype-ps/skype/Set-CsMediationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMediationServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmediationserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMediationServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmediationserver +schema: 2.0.0 +title: Set-CsMediationServer --- # Set-CsMediationServer @@ -35,7 +36,7 @@ If necessary, the `Set-CsMediationServer` cmdlet can also be used to associate a ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsMediationServer -Identity "MediationServer:atl-cs-001.litwareinc.com" -SipClientTcpPort 5072 ``` @@ -44,7 +45,7 @@ The command shown in Example 1 sets the SIP gateway TCP listening port to 5072 f After changing the port you will need to restart the Skype for Business Server Mediation service. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsMediationServer -Identity "MediationServer:atl-cs-001.litwareinc.com" -AudioPortStart 60000 -AudioPortCount 1000 ``` @@ -55,27 +56,10 @@ In this example the starting audio port is set to 60000 and the total number of ## PARAMETERS -### -Identity -Service location of the Mediation Server to be modified. -For example: `-Identity "MediationServer:atl-cs-001.litwareinc.com"`. - -Note that you can leave off the prefix "MediationServer:" when specifying a Mediation Server. -For example: `-Identity "atl-cs-001.litwareinc.com"`. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AudioPortCount -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AudioPortCount Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100, then ports 60000 through 60099 inclusive will be used for audio traffic. @@ -95,8 +79,7 @@ Two local ports per network interface, one for RTP traffic and one for RTCP traf ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,14 +89,16 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for sending and receiving audio traffic. For example: `-AudioPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,14 +108,34 @@ Accept wildcard characters: False ``` ### -EdgeServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service identity of the Edge Server to be associated with the Mediation Server. For example: `-EdgeServer "EdgeServer:atl-edge-001.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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -139,15 +144,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Mediation Server to be modified. +For example: `-Identity "MediationServer:atl-cs-001.litwareinc.com"`. + +Note that you can leave off the prefix "MediationServer:" when specifying a Mediation Server. +For example: `-Identity "atl-cs-001.litwareinc.com"`. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service identity of the Registrar to be associated with the Mediation Server. For example: `-Registrar "Registrar:atl-cs-001.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 +Aliases: Required: False Position: Named @@ -157,6 +186,9 @@ Accept wildcard characters: False ``` ### -SipClientTcpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port used for communicating with gateway peers using TCP. By default, no TCP port is defined; however, a TCP port with the port number 5068 will automatically be created when a PSTN gateway is created. If you change the SipClientTcpPort you will need to restart the Mediation Server service before the new port will actually be used. @@ -164,8 +196,7 @@ If you change the SipClientTcpPort you will need to restart the Mediation Server ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,6 +206,9 @@ Accept wildcard characters: False ``` ### -SipClientTlsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port used for communicating with gateway peers using the Transport Layer Security (TLS) protocol. By default, SipClientTlsPort is configured to use port 5067. If you change the SipClientTlsPort you will need to restart the Mediation Server service before the new port will actually be used. @@ -183,8 +217,7 @@ If you change the SipClientTlsPort you will need to restart the Mediation Server ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -194,6 +227,9 @@ Accept wildcard characters: False ``` ### -SipServerPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port used for communicating with Front End Servers. By default, SipServerPort is configured to use port 5070. If you change the SipServerPort, you will need to restart the Mediation Server service before the new port will actually be used. @@ -202,8 +238,7 @@ If you change the SipServerPort, you will need to restart the Mediation Server s ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,14 +247,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -229,29 +266,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -265,13 +288,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsMediationServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsMediationServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayMediationServer object. diff --git a/skype/skype-ps/skype/Set-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMeetingConfiguration.md index 3e3103f124..ae6e612e1f 100644 --- a/skype/skype-ps/skype/Set-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingConfiguration.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-csmeetingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMeetingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmeetingconfiguration +schema: 2.0.0 +title: Set-CsMeetingConfiguration --- # Set-CsMeetingConfiguration @@ -57,7 +59,7 @@ The `Set-CsMeetingConfiguration` cmdlet enables you to modify any of the meeting ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsMeetingConfiguration -Identity site:Redmond -DesignateAsPresenter Everyone ``` @@ -65,7 +67,7 @@ Set-CsMeetingConfiguration -Identity site:Redmond -DesignateAsPresenter Everyone The command shown in Example 1 modifies the meeting configuration settings assigned to the Redmond site (-Identity site:Redmond). In this case, the value of the DesignateAsPresenter property is set to Everyone. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsMeetingConfiguration | Set-CsMeetingConfiguration -DesignateAsPresenter Everyone ``` @@ -75,7 +77,7 @@ In this case, however, the value of the DesignateAsPresenter property is modifie To do this, the `Get-CsMeetingConfiguration` cmdlet is called without any parameters in order to return a collection of all the meeting configuration settings currently in use. This collection is then piped to the `Set-CsMeetingConfiguration` cmdlet, which modifies the DesignateAsPresenter property for each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsMeetingConfiguration | Where-Object {$_.AdmitAnonymousUsersByDefault -eq $False} | Set-CsMeetingConfiguration -PstnCallersBypassLobby $True ``` @@ -87,51 +89,53 @@ In turn, this filtered collection is piped to the `Set-CsMeetingConfiguration` c ## PARAMETERS -### -Identity -Indicates the unique identifier for the collection of meeting configuration settings you want to modify. -To refer to the global settings, use this syntax: -Identity global. -To refer to a collection configured at the site scope, use syntax similar to this: -Identity "site:Redmond". -Settings configured at the service scope can be referenced using syntax like this: -Identity "service:UserServer:atl-cs-001.litwareinc.com". +### -AdmitAnonymousUsersByDefault -If this parameter is not specified, then the `Set-CsMeetingConfiguration` cmdlet will modify the global settings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether meetings will, by default, allow attendance by anonymous users (that is, unauthenticated users). Set this value to True if you would like new meetings to allow for attendance by anonymous users by default. Set this value to False if you would prefer that, by default, new meetings do not allow for attendance by anonymous users. The default value is True. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -AllowCloudRecordingService + +> Applicable: Skype for Business Online + +PARAMVALUE: $true | $false ```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 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AdmitAnonymousUsersByDefault -Determines whether meetings will, by default, allow attendance by anonymous users (that is, unauthenticated users). Set this value to True if you would like new meetings to allow for attendance by anonymous users by default. Set this value to False if you would prefer that, by default, new meetings do not allow for attendance by anonymous users. The default value is True. +### -AllowConferenceRecording + +> Applicable: Skype for Business Online + +Determines whether or not users are allowed to record conference proceedings. +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 +Aliases: Required: False Position: Named @@ -141,6 +145,9 @@ Accept wildcard characters: False ``` ### -AssignedConferenceTypeByDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether new meetings will be configured, by default, as public meetings. Set this value to True to use public meetings by default; set this value to False to use private meetings by default. The default value is True. @@ -148,8 +155,25 @@ 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 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomFooterText + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Text to be used on custom meeting invitations. Multiple lines are supported using the Enter key. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -159,16 +183,18 @@ Accept wildcard characters: False ``` ### -DesignateAsPresenter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates which users (besides the meeting organizer) are automatically designated as presenters when they join a meeting. Valid choices are: None; Company and Everyone. By default, DesignateAsPresenter is set to Company, meaning everyone in your organization will have presenter rights the moment they join a meeting. -Note: When DesignateAsPresenter is set to Everyone, only dynamic meetings will comply with this setting. Static meetings do not allow Everyone to join as a Presenter. +Note: When DesignateAsPresenter is set to Everyone, only dynamic meetings will comply with this setting. Static meetings do not allow Everyone to join as a Presenter. ```yaml Type: DesignateAsPresenter 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 +Aliases: Required: False Position: Named @@ -178,6 +204,9 @@ Accept wildcard characters: False ``` ### -EnableAssignedConferenceType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is not available in Skype for Business Online. Indicates whether users are allowed to schedule public meetings. @@ -188,8 +217,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,18 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnCallersBypassLobby -Indicates whether users dialing in over a public switched telephone network (PSTN) phone line should automatically be admitted to a meeting. -If set to True ($True), PSTN callers will automatically be admitted to the meeting. -If set to False ($False), then PSTN callers will initially be routed to the conference lobby. -At that point, they will have to wait, on hold, until a conference presenter grants them access to the meeting. -The default value is True. +### -EnableMeetingReport + +> Applicable: Skype for Business Online + +PARAMVALUE: $true | $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 +Aliases: Required: False Position: Named @@ -219,13 +245,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +Aliases: Required: False Position: Named @@ -234,26 +262,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Office 365 tenant account whose meeting configuration settings are being modified. - -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +### -HelpURL -You can return the tenant ID for each of your tenants by running this command: +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -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. +URL to a website where users can obtain assistance on joining the meeting. ```yaml -Type: Guid +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 +Aliases: Required: False Position: Named @@ -262,62 +280,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity -```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 +> 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 -``` +Indicates the unique identifier for the collection of meeting configuration settings you want to modify. +To refer to the global settings, use this syntax: -Identity global. +To refer to a collection configured at the site scope, use syntax similar to this: -Identity "site:Redmond". +Settings configured at the service scope can be referenced using syntax like this: -Identity "service:UserServer:atl-cs-001.litwareinc.com". -### -Confirm -Prompts you for confirmation before executing the command. +If this parameter is not specified, then the `Set-CsMeetingConfiguration` cmdlet will modify the global settings. ```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 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomFooterText -Text to be used on custom meeting invitations. Multiple lines are supported using the Enter key. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -HelpURL -URL to a website where users can obtain assistance on joining the meeting. +### -LegalURL + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +URL to a website containing legal information and meeting disclaimers. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -326,14 +339,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegalURL -URL to a website containing legal information and meeting disclaimers. +### -LogoURL + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the image to be used on custom meeting invitations. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -342,14 +357,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LogoURL -URL for the image to be used on custom meeting invitations. +### -PstnCallersBypassLobby + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether users dialing in over a public switched telephone network (PSTN) phone line should automatically be admitted to a meeting. +If set to True ($True), PSTN callers will automatically be admitted to the meeting. +If set to False ($False), then PSTN callers will initially be routed to the conference lobby. +At that point, they will have to wait, on hold, until a conference presenter grants them access to the meeting. +The default value is True. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -359,14 +380,16 @@ Accept wildcard characters: False ``` ### -RequireRoomSystemsAuthorization + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) all users must be authenticated before they can join a meeting using the Skype for Business Room System. The default value is False ($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 +Aliases: Required: False Position: Named @@ -375,14 +398,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCloudRecordingService -PARAMVALUE: $true | $false +### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Office 365 tenant account whose meeting configuration settings are being modified. + +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return the tenant ID for each of your tenants by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -391,15 +428,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowConferenceRecording -Determines whether or not users are allowed to record conference proceedings. -The default value is True. +### -UserUriFormatForStUser + +> Applicable: Skype for Business Online + +PARAMVALUE: String ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -408,14 +446,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingReport -PARAMVALUE: $true | $false +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -424,14 +464,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserUriFormatForStUser -PARAMVALUE: String +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -445,13 +487,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration + The `Set-CsMeetingConfiguration` cmdlet accepts pipelined instances of the meeting configuration object. ## OUTPUTS -### +### None The `Set-CsMeetingConfiguration` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingRoom.md similarity index 85% rename from skype/skype-ps/skype/Set-CsMeetingRoom.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMeetingRoom.md index c7bc7a6973..66aea66292 100644 --- a/skype/skype-ps/skype/Set-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingRoom.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-csmeetingroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMeetingRoom -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmeetingroom +schema: 2.0.0 +title: Set-CsMeetingRoom --- # Set-CsMeetingRoom @@ -54,7 +56,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsMeetingRoom -Identity "RedmondMeetingRoom" -LineUri "tel:+12065551219" ``` @@ -62,7 +64,7 @@ Set-CsMeetingRoom -Identity "RedmondMeetingRoom" -LineUri "tel:+12065551219" The command show in Example 1 updates the LineUri assigned to the meeting room RedmondMeetingRoom. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsMeetingRoom -Identity "RedmondMeetingRoom" -Enabled $False @@ -77,7 +79,7 @@ To re-enable the room, simply set the Enabled property to True ($True): `Set-CsMeetingRoom -Identity "RedmondMeetingRoom" -Enabled $True` -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMeetingRoom | Set-CsMeetingRoom -Enabled $False ``` @@ -87,7 +89,7 @@ To do this, the command first calls the `Get-CsMeetingRoom` cmdlet without any p That collection is then piped to the `Set-CsMeetingRoom` cmdlet, which temporarily disables each room in the collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMeetingRoom | Set-CsMeetingRoom -ExchangeArchivingPolicy "UseLyncArchivingPolicy" ``` @@ -99,26 +101,10 @@ That collection is then piped to the `Set-CsMeetingRoom` cmdlet, which uses the ## PARAMETERS -### -Identity -Indicates the Identity of the meeting room to be modified. -Meeting room Identities are typically specified using one of four formats: 1) the room's SIP address; 2) the room's user principal name (UPN); 3) the room's domain name and logon name, in the form domain\logon (for example, litwareinc\room14) and 4) the room's Active Directory display name (for example, Room 14). -You can also reference a room account by using the room's Active Directory distinguished name. - +### -AcpInfo -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -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 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 -``` - -### -AcpInfo Enables you to assign one or more third-party audio conferencing providers to a meeting room. However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. @@ -126,8 +112,7 @@ However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Aud ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[Microsoft.Rtc.Management.ADConnect.Collections.AcpInfo] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +122,9 @@ Accept wildcard characters: False ``` ### -AudioVideoDisabled + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the room is allowed to make audio/video (A/V) calls by using Skype for Business. If set to True, the room will largely be restricted to sending and receiving instant messages. @@ -146,8 +134,7 @@ You cannot disable A/V communications if a room is currently enabled for remote ```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 +Aliases: Required: False Position: Named @@ -156,24 +143,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -DomainController +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -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 -``` - -### -DomainController Enables you to connect to the specified domain controller in order to retrieve meeting room information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). @@ -181,8 +154,7 @@ To connect to a particular domain controller, include the DomainController param ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -192,6 +164,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the room has been enabled for Skype for Business Server. If you set this value to False, the room will no longer be able to log on to Skype for Business Server; setting this value to True re-enables the meeting room's logon privileges. @@ -205,7 +180,6 @@ When you run `Disable-CsMeetingRoom`, all the Skype for Business Server data ass Type: Boolean Parameter Sets: (All) Aliases: CsEnabled -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -215,6 +189,9 @@ Accept wildcard characters: False ``` ### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the room has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, rooms can make telephone calls using the Internet rather than using the standard telephone network. @@ -222,8 +199,7 @@ With Enterprise Voice, rooms can make telephone calls using the Internet rather ```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 +Aliases: Required: False Position: Named @@ -233,6 +209,9 @@ Accept wildcard characters: False ``` ### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how (and where) the room's instant messaging and conferencing sessions will be archived. Allowed values are: @@ -248,8 +227,7 @@ ArchivingToExchange ```yaml Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -259,6 +237,9 @@ Accept wildcard characters: False ``` ### -HostedVoiceMail + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, enables a room's voice mail calls to be routed to a hosted version of Exchange. In addition, setting this option to True enables rooms to directly place a call to another user's voice mail. @@ -266,8 +247,7 @@ In addition, setting this option to True enables rooms to directly place a call ```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 +Aliases: Required: False Position: Named @@ -276,7 +256,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the meeting room to be modified. +Meeting room Identities are typically specified using one of four formats: 1) the room's SIP address; 2) the room's user principal name (UPN); 3) the room's domain name and logon name, in the form domain\logon (for example, litwareinc\room14) and 4) the room's Active Directory display name (for example, Room 14). +You can also reference a room account by using the room's Active Directory distinguished name. + + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -LineServerURI + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The URI of the remote call control telephone gateway assigned to the room. The LineServerUri is the gateway URI, prefaced by "sip:". For example: @@ -287,8 +291,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -298,6 +301,9 @@ Accept wildcard characters: False ``` ### -LineURI + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number assigned to the room. The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "TEL:" prefix. For example: @@ -312,8 +318,7 @@ Any extension number should be added to the end of the line URI, for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -323,6 +328,9 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a meeting room object through the pipeline that represents the meeting room being modified. By default, the `Set-CsMeetingRoom` cmdlet does not pass objects through the pipeline. @@ -330,8 +338,7 @@ By default, the `Set-CsMeetingRoom` cmdlet does not pass objects through the pip ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -341,6 +348,9 @@ Accept wildcard characters: False ``` ### -PrivateLine + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number for the room private telephone line. A private line is a phone number that is not published in Active Directory Domain Services (AD DS) 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 room's delegates. @@ -355,8 +365,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -366,6 +375,9 @@ Accept wildcard characters: False ``` ### -RemoteCallControlTelephonyEnabled + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the room has been enabled for remote call control telephony. When enabled for remote call control, a room can employ Skype for Business Server to answer phone calls made to his or her desk phone. Phone calls can also be made using Skype for Business. @@ -379,8 +391,7 @@ To be enabled for remote call control, a room must also have both a LineUri and ```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 +Aliases: Required: False Position: Named @@ -390,6 +401,9 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier (similar to an email address) that allows the room 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: @@ -399,8 +413,26 @@ The SIP address must use the sip: prefix as well as a valid SIP domain; for exam ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -410,6 +442,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -417,7 +452,6 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -431,13 +465,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom The `Set-CsMeetingRoom` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsMeetingRoom` cmdlet modifies existing instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsMobilityPolicy.md similarity index 85% rename from skype/skype-ps/skype/Set-CsMobilityPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMobilityPolicy.md index b159325592..6015b87041 100644 --- a/skype/skype-ps/skype/Set-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMobilityPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmobilitypolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMobilityPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmobilitypolicy +schema: 2.0.0 +title: Set-CsMobilityPolicy --- # Set-CsMobilityPolicy @@ -72,7 +74,7 @@ The following parameters are not applicable to Skype for Business Online: AllowA ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsMobilityPolicy -Identity "site:Redmond" -EnableOutsideVoice $False ``` @@ -81,7 +83,7 @@ In Example 1, Call via Work is disabled in the mobility policy assigned to the R This is done by setting the EnableOutsideVoice property to False. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMobilityPolicy -Filter "tag:*" | Set-CsMobilityPolicy -EnableOutsideVoice $False ``` @@ -91,7 +93,7 @@ To carry out this task, the command first calls the `Get-CsMobilityPolicy` cmdle That filtered collection of policies is then piped to the `Set-CsMobilityPolicy` cmdlet, which takes each policy in the collection and sets the EnableOutsideVoice property to False. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMobilityPolicy | Where-Object {$_.Description -eq $Null} | Set-CsMobilityPolicy -Description "Policy owner: kenmyer@litwareinc.com" ``` @@ -104,15 +106,16 @@ That filtered collection is then piped to the `Set-CsMobilityPolicy` cmdlet, whi ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -AllowAutomaticPstnFallback +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,16 +124,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide additional text to accompany a mobility policy. -For example, the Description might include information about the users the policy should be assigned to. +### -AllowCustomerExperienceImprovementProgram + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) mobile users will be allowed to participate in the Microsoft Customer Experience Improvement Program. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,18 +143,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableIPAudioVideo -When set to False, prohibits the user from making voice over IP (VoIP) calls using the mobile device. -The default value is True, meaning that VoIP calls are allowed. +### -AllowDeviceContactsSync -This parameter was introduced in Lync Server 2013. +> Applicable: Skype for Business Online + +When set to True users will be allowed to sync device contacts on the mobile apps. +More information: [How to disable CallKit integration for Skype for Business iOS](https://learn.microsoft.com/SkypeForBusiness/troubleshoot/server-phone-system/disable-callkit-integration). ```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 +Aliases: Required: False Position: Named @@ -159,15 +163,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMobility -When set to True, users are allowed to use Skype for Business Mobile. +### -AllowExchangeConnectivity + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) users will be allowed to connect to Exchange by using their mobile device. ```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 +Aliases: Required: False Position: Named @@ -176,18 +182,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOutsideVoice -When set to True, enables users to take advantage of Call via Work. -When set to False, users cannot use Call via Work. +### -AllowSaveCallLogs -The default value is True. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) users will be allowed to save a call log of calls made from or received by their mobile device. + +Note that this setting does not apply to Android devices. ```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 +Aliases: Required: False Position: Named @@ -196,15 +203,21 @@ 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. +### -AllowSaveCredentials + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) users will be allowed to save credentials information (such as passwords) on their mobile device. +This information can then be applied to auto-logon scenarios. + +Note: If a user has AllowSaveCredentials set to False in the CsMobility policy, the Skype for Business App for iOS may sign out automatically when bringing it from the background to the foreground. This is due to the password not being saved anywhere but in the iOS process memory. Once the process is killed by the iOS system, the password will no longer be available, so the user will need to enter it again. However, there is no impact if modern authentication is implemented. + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,66 +226,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier assigned to the policy when it was created. -Mobility policies can be assigned at the global, site, or per-user scope. -To refer to the global instance, use this syntax: - -`-Identity global` +### -AllowSaveIMHistory -To refer to a policy at the site scope, use syntax similar to this: +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`-Identity site:Redmond` - -To refer to a per-user policy, use syntax similar to this: - -`-Identity RedmondMobilityPolicy` +When set to True (the default value) users will be allowed to save transcripts of IM and conferencing sessions on their mobile devices. -If you do not specify an Identity, then the `Set-CsMobilityPolicy` cmdlet will modify the global policy. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 1 +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. +### -Description + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text to accompany a mobility policy. +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireWIFIForIPAudio -When set to True, the user can use IP audio in calls made when his or her mobile device is connected to a Wi-Fi network. -That means that the user will only be allowed to make audio calls using Wi-Fi, and will not be able to use the standard cellular phone network. -The default value is False. +### -EnableIPAudioVideo + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, prohibits the user from making voice over IP (VoIP) calls using the mobile device. +The default value is True, meaning that VoIP calls are allowed. This parameter was introduced in Lync Server 2013. ```yaml Type: Boolean -Parameter Sets: Identity, Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -281,19 +287,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireWIFIForIPVideo -When set to True, the user can use IP video only in calls made when their mobile device is connected to a Wi-Fi network. -If the mobile device goes outside of Wi-Fi range, then video calls will be received as audio calls only. -If this property is set to False (the default value) then the user can make or receive IP video calls using either a Wi-Fi or a cellular data connection. +### -EnableMobility -This parameter was introduced in Lync Server 2013. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users are allowed to use Skype for Business Mobile. ```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 +Aliases: Required: False Position: Named @@ -302,31 +306,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -EnableOutsideVoice +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, enables users to take advantage of Call via Work. +When set to False, users cannot use Call via Work. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +The default value is True. -### -AllowAutomaticPstnFallback -This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -335,15 +328,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCustomerExperienceImprovementProgram -When set to True (the default value) mobile users will be allowed to participate in the Microsoft Customer Experience Improvement Program. +### -EnablePushNotifications + +> Applicable: Skype for Business Online +When set to True users will be allowed to receive push notifications on their mobile devices. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -352,16 +346,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDeviceContactsSync -When set to True users will be allowed to sync device contacts on the mobile apps. +### -EncryptAppData -More information: [How to disable CallKit integration for Skype for Business iOS](https://learn.microsoft.com/SkypeForBusiness/troubleshoot/server-phone-system/disable-callkit-integration). +> Applicable: Skype for Business Online + +When set to True users will be allowed to encrypt data on their mobile apps. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -370,15 +364,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExchangeConnectivity -When set to True (the default value) users will be allowed to connect to Exchange by using their mobile device. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -387,71 +383,67 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSaveCallLogs -When set to True (the default value) users will be allowed to save a call log of calls made from or received by their mobile device. +### -Identity -Note that this setting does not apply to Android devices. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier assigned to the policy when it was created. +Mobility policies can be assigned at the global, site, or per-user scope. +To refer to the global instance, use this syntax: -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +`-Identity global` -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +To refer to a policy at the site scope, use syntax similar to this: -### -AllowSaveCredentials -When set to True (the default value) users will be allowed to save credentials information (such as passwords) on their mobile device. -This information can then be applied to auto-logon scenarios. +`-Identity site:Redmond` -Note: If a user has AllowSaveCredentials set to False in the CsMobility policy, the Skype for Business App for iOS may sign out automatically when bringing it from the background to the foreground. This is due to the password not being saved anywhere but in the iOS process memory. Once the process is killed by the iOS system, the password will no longer be available, so the user will need to enter it again. However, there is no impact if modern authentication is implemented. +To refer to a per-user policy, use syntax similar to this: +`-Identity RedmondMobilityPolicy` +If you do not specify an Identity, then the `Set-CsMobilityPolicy` cmdlet will modify the global policy. ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSaveIMHistory -When set to True (the default value) users will be allowed to save transcripts of IM and conferencing sessions on their mobile devices. +### -Instance + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -EnablePushNotifications -When set to True users will be allowed to receive push notifications on their mobile devices. +### -RequireIntune + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -460,14 +452,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptAppData -When set to True users will be allowed to encrypt data on their mobile apps. +### -RequireWIFIForIPAudio + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the user can use IP audio in calls made when his or her mobile device is connected to a Wi-Fi network. +That means that the user will only be allowed to make audio calls using Wi-Fi, and will not be able to use the standard cellular phone network. +The default value is False. + +This parameter was introduced in Lync Server 2013. + ```yaml Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Parameter Sets: Identity, Instance +Aliases: Required: False Position: Named @@ -476,14 +475,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireIntune -This parameter is reserved for internal Microsoft use. +### -RequireWIFIForIPVideo + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the user can use IP video only in calls made when their mobile device is connected to a Wi-Fi network. +If the mobile device goes outside of Wi-Fi range, then video calls will be received as audio calls only. +If this property is set to False (the default value) then the user can make or receive IP video calls using either a Wi-Fi or a cellular data connection. + +This parameter was introduced in Lync Server 2013. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -493,6 +499,9 @@ Accept wildcard characters: False ``` ### -RequireWiFiForSharing + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, mobile users must use a Wi-Fi connection in order to participate in an application sharing session. When set to False (the default value) mobile users can participate in application sharing by using either a Wi-Fi connection or a cellular (3G/4G) connection. @@ -503,8 +512,7 @@ If this value is set to False, users can use the Options page to modify their sh ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -514,6 +522,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the mobility policy is being modified. For example: @@ -527,8 +538,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -538,7 +548,10 @@ Accept wildcard characters: False ``` ### -VoiceSettings -Controls how audio is connected by a mobile device joining a meeting or a peer-to-peer call. When the Skype for Business client is first run, and the user is enabled for Phone System with a Calling Plan, they are prompted to configure a call back phone number. This number is stored in settings under the **Calls and Meetings** section and will be used based on the value chosen for this parameter. Acceptable values are: + +> Applicable: Skype for Business Online + +Controls how audio is connected by a mobile device joining a meeting or a peer-to-peer call. When the Skype for Business client is first run, and the user is enabled for Phone System with a Calling Plan, they are prompted to configure a call back phone number. This number is stored in settings under the **Calls and Meetings** section and will be used based on the value chosen for this parameter. Acceptable values are: **VoIPAlways:** Wi-Fi will be used when available, otherwise a call back will be performed. @@ -549,8 +562,45 @@ Controls how audio is connected by a mobile device joining a meeting or a peer-t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -564,14 +614,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility. +### Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility The `Set-CsMobilityPolicy` cmdlet accepts pipelined instances of the Mobility object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsMobilityPolicy` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsMonitoringServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsMonitoringServer.md similarity index 86% rename from skype/skype-ps/skype/Set-CsMonitoringServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMonitoringServer.md index 4906331044..92d1d8cf8a 100644 --- a/skype/skype-ps/skype/Set-CsMonitoringServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMonitoringServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmonitoringserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMonitoringServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmonitoringserver +schema: 2.0.0 +title: Set-CsMonitoringServer --- # Set-CsMonitoringServer @@ -40,7 +41,7 @@ However, if you do need to change the location of one (or both) of these items, ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsMonitoringServer -Identity "MonitoringServer:atl-cs-001.litwareinc.com" -ReportingUrl "https://atl-cs-001.litwareinc.com/reports" ``` @@ -50,7 +51,28 @@ The command shown in Example 1 configures a new URL for the Monitoring Server re ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Monitoring Server to be modified. For example: `-Identity "MonitoringServer:atl-cs-001.litwareinc.com"`. You can retrieve the Identity for all of your Monitoring Servers by using this command: @@ -63,8 +85,7 @@ For example: `-Identity "atl-cs-001.litwareinc.com"`. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -74,6 +95,9 @@ Accept wildcard characters: False ``` ### -MonitoringDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location for the new Monitoring Server database. For example: `-MonitoringDatabase "MonitoringDatabase:atl-sql-001.litwareinc.com"`. Make sure you use the service location of the database store and not the SQL Server path name. @@ -81,8 +105,7 @@ Make sure you use the service location of the database store and not the SQL Ser ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -92,14 +115,16 @@ Accept wildcard characters: False ``` ### -ReportingUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the Monitoring Server reports. Note that these reports will not be available unless you install SQL Server Reporting Services and the Monitoring Server Report Pack. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,14 +133,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -125,29 +152,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -161,13 +174,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsMonitoringServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsMonitoringServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringServer object. diff --git a/skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkBandwidthPolicyProfile.md similarity index 87% rename from skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkBandwidthPolicyProfile.md index dffaff9982..c76fdd8d2c 100644 --- a/skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkBandwidthPolicyProfile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkBandwidthPolicyProfile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkbandwidthpolicyprofile +schema: 2.0.0 +title: Set-CsNetworkBandwidthPolicyProfile --- # Set-CsNetworkBandwidthPolicyProfile @@ -43,7 +44,7 @@ If the profile contained a policy to limit video and you set only the AudioBWLim ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile -Description "Policy for links of less than 10MB" ``` @@ -52,7 +53,7 @@ This example modifies the description of the bandwidth policy profile with the i It does this by calling the `Set-CsNetworkBandwidthPolicyProfile` cmdlet with two parameters: Identity, specifying the name of the profile to modify; and Description, specifying the new description of the profile. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsNetworkBandwidthPolicyProfile -Identity LowBWLimit -VideoBWLimit 2500 -VideoBWSessionLimit 300 ``` @@ -64,7 +65,7 @@ This command will add a video profile or update an existing video profile for th Any existing audio profiles will be unaffected. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $bp = New-CsNetworkBWPolicy -BWLimit 5000 -BWSessionLimit 200 -BWPolicyModality video @@ -80,7 +81,7 @@ The BWPolicy parameter is used with a value of $bp. This replaces any existing policies of this profile with the newly created policy we stored in the $bp variable. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $a = Get-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile @@ -106,7 +107,7 @@ Finally, we call the `Set-CsNetworkBandwidthPolicyProfile` cmdlet to update the We use the Instance parameter, passing a value of $a, which contains our modified profile. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` $ap = New-CsNetworkBWPolicy -BWLimit 2000 -BWSessionLimit 300 -BWPolicyModality audio @@ -129,43 +130,10 @@ Within those curly braces you specify the action you want to take on the list, i ## PARAMETERS -### -Identity -The string value that uniquely identifies the bandwidth policy profile you want to modify. -This is identical to the BWPolicyProfileID property of the profile and can be changed by changing the value of that property. -This is equivalent to a "cut and paste" operation: all properties of the profile remain the same, only the name changes. -However, this value cannot be changed if the profile is assigned to a network site. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -A reference to a bandwidth policy profile object (an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType) that contains the settings you want to use to modify the profile. -This object can be retrieved by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AudioBWLimit -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AudioBWLimit The maximum amount of bandwidth to allocate for all audio connections. If a single audio session will cause the audio bandwidth limit to be exceeded, that session will not be allowed to start. @@ -179,8 +147,7 @@ Default: If you supply a value to the AudioBWSessionLimit parameter but not to A ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +157,9 @@ Accept wildcard characters: False ``` ### -AudioBWSessionLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of bandwidth to allocate per audio session. Expressed in kbps. Value must be 40 or higher. @@ -201,8 +171,7 @@ Default: If you supply a value to the AudioBWLimit parameter but not to AudioBWS ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,6 +181,9 @@ Accept wildcard characters: False ``` ### -BWPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of objects containing bandwidth policy profiles. Each object in the list consists of a bandwidth modality (audio or video), a bandwidth limitation, and a bandwidth session limitation. @@ -223,8 +195,7 @@ Objects of this type can be created by calling the `New-CsNetworkBWPolicy` cmdle ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,14 +205,34 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of the bandwidth policy profile. For example, you can use this parameter to clarify the expected use of the profile. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -250,7 +241,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The string value that uniquely identifies the bandwidth policy profile you want to modify. +This is identical to the BWPolicyProfileID property of the profile and can be changed by changing the value of that property. +This is equivalent to a "cut and paste" operation: all properties of the profile remain the same, only the name changes. +However, this value cannot be changed if the profile is assigned to a network site. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a bandwidth policy profile object (an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType) that contains the settings you want to use to modify the profile. +This object can be retrieved by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -VideoBWLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of bandwidth to allocate for all video connections. If a single video session will cause the video bandwidth limit to be exceeded, that session will not be allowed to start. @@ -264,8 +298,7 @@ Default: If you supply a value to the VideoBWSessionLimit parameter but not to V ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +308,9 @@ Accept wildcard characters: False ``` ### -VideoBWSessionLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of bandwidth to allocate per video session. Expressed in kbps. Value must be 100 or higher. @@ -286,8 +322,7 @@ Default: If you supply a value to the VideoBWLimit parameter but not to VideoBWS ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -296,14 +331,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -313,29 +350,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -349,13 +372,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType + Accepts pipelined input of network bandwidth policy profile objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType. diff --git a/skype/skype-ps/skype/Set-CsNetworkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsNetworkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkConfiguration.md index c57f41a6da..7bda1845ce 100644 --- a/skype/skype-ps/skype/Set-CsNetworkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkconfiguration +schema: 2.0.0 +title: Set-CsNetworkConfiguration --- # Set-CsNetworkConfiguration @@ -60,7 +62,7 @@ The following parameters are not applicable to Skype for Business Online: BWPoli ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkConfiguration -EnableBandwidthPolicyCheck $True ``` @@ -71,52 +73,65 @@ If CAC is already enabled (in other words, if the EnableBandwidthPolicyCheck pro ## PARAMETERS -### -Identity -This value will always be Global. +### -BWPolicyProfiles + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +A collection of all the bandwidth policy profiles that can be assigned to sites, inter-site policies and network region links. +Each bandwidth policy profile contains bandwidth limitations (overall limitations and session limitations) for audio and/or video connections. +A full list of bandwidth policy profiles can be retrieved by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -A reference to a network configuration object. -This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings, which can be retrieved by calling the `Get-CsNetworkConfiguration` cmdlet. +### -EnableBandwidthPolicyCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Setting this parameter to True will run a validation check against the entire CAC configuration. +If all validation checks pass, or if you choose to ignore all warnings, CAC will be enabled. +If a validation check does not pass, you can choose to stop the validation and the value of EnableBandwidthPolicyCheck will not change. +You must have region routes defined between each pair of network regions before you running the validation check. + +Setting this value to False will disable CAC. + +Default: False ```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 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -BWPolicyProfiles -A collection of all the bandwidth policy profiles that can be assigned to sites, inter-site policies and network region links. -Each bandwidth policy profile contains bandwidth limitations (overall limitations and session limitations) for audio and/or video connections. -A full list of bandwidth policy profiles can be retrieved by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter does not take a value. +If you include this parameter, any changes made to the configuration, including enabling the configuration, will take place with no warnings or validation checks. ```yaml -Type: PSListModifier +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 +Aliases: Required: False Position: Named @@ -125,31 +140,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableBandwidthPolicyCheck -Setting this parameter to True will run a validation check against the entire CAC configuration. -If all validation checks pass, or if you choose to ignore all warnings, CAC will be enabled. -If a validation check does not pass, you can choose to stop the validation and the value of EnableBandwidthPolicyCheck will not change. -You must have region routes defined between each pair of network regions before you running the validation check. +### -Identity -Setting this value to False will disable CAC. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Default: False +This value will always be Global. ```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 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a network configuration object. +This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings, which can be retrieved by calling the `Get-CsNetworkConfiguration` cmdlet. + + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -InterNetworkRegionRoutes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of all the network region routes defined within the CAC configuration. You can retrieve all the members of this collection by calling the `Get-CsNetworkInterRegionRoute` cmdlet. @@ -157,8 +190,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier 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 +Aliases: Required: False Position: Named @@ -168,6 +200,9 @@ Accept wildcard characters: False ``` ### -InterNetworkSitePolicies + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of network inter-site policies defined within the CAC configuration. You can retrieve all the members of this collection by calling the `Get-CsNetworkInterSitePolicy` cmdlet. @@ -175,8 +210,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier 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 +Aliases: Required: False Position: Named @@ -186,6 +220,9 @@ Accept wildcard characters: False ``` ### -MediaBypassSettings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to an object that defines the global media bypass settings for the CAC configuration. Setting this value will overwrite all existing media bypass settings. You obtain this object reference by calling the `New-CsNetworkMediaBypassConfiguration` cmdlet and assigning the new configuration settings to a variable. @@ -195,8 +232,7 @@ Pass this variable to the MediaBypassSettings parameter to change the global med ```yaml Type: MediaBypassSettingsType 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 +Aliases: Required: False Position: Named @@ -206,6 +242,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionLinks + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of network region links defined within the CAC configuration. Each network region link defines a connection that exists between two regions and any bandwidth limitations that should be applied to connections between those regions. You can retrieve all the members of this collection by calling the `Get-CsNetworkRegionLink` cmdlet. @@ -214,8 +253,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier 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 +Aliases: Required: False Position: Named @@ -225,6 +263,9 @@ Accept wildcard characters: False ``` ### -NetworkRegions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of network regions (each of which represents a hub or backbone within the network) defined within the CAC configuration. You can retrieve all the members of this collection by calling the `Get-CsNetworkRegion` cmdlet. @@ -232,8 +273,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier 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 +Aliases: Required: False Position: Named @@ -243,6 +283,9 @@ Accept wildcard characters: False ``` ### -NetworkSites + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of network sites (each of which represents an office or location within a region) defined within the CAC configuration. You can retrieve all the members of this collection by calling the `Get-CsNetworkSite` cmdlet. @@ -250,8 +293,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier 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 +Aliases: Required: False Position: Named @@ -261,6 +303,9 @@ Accept wildcard characters: False ``` ### -Subnets + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of network subnets (each of which associates an endpoint with a site) defined within the CAC configuration. You can retrieve all the members of this collection by calling the `Get-CsNetworkSubnet` cmdlet. @@ -268,8 +313,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier 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 +Aliases: Required: False Position: Named @@ -278,33 +322,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -This parameter does not take a value. -If you include this parameter, any changes made to the configuration, including enabling the configuration, will take place with no warnings or validation checks. - - -```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 -``` +### -Tenant -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +> Applicable: Skype for Business Online +{{Fill Tenant Description}} ```yaml -Type: SwitchParameter +Type: Guid 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 +Aliases: Required: False Position: Named @@ -314,6 +341,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -321,7 +351,6 @@ Prompts you for confirmation before executing the command. 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 @@ -330,14 +359,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -{{Fill Tenant Description}} +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -351,13 +383,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings + Accepts pipelined input of a network configuration object. ## OUTPUTS -### +### None The `Set-CsNetworkConfiguration` cmdlet does not return a value or object. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object. diff --git a/skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterRegionRoute.md similarity index 84% rename from skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterRegionRoute.md index 2c6e2a913f..d916c582fe 100644 --- a/skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterRegionRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkInterRegionRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkinterregionroute +schema: 2.0.0 +title: Set-CsNetworkInterRegionRoute --- # Set-CsNetworkInterRegionRoute @@ -41,7 +42,7 @@ This cmdlet modifies that route association. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkInterRegionRoute -Identity NA_APAC_Route -NetworkRegionLinkIDs "NA_SA,SA_APAC" ``` @@ -50,7 +51,7 @@ This example modifies the route NA_APAC_Route by changing the region links that The NetworkRegionLinkIDs parameter is used with a value of "NA_SA,SA_APAC", which replaces any existing links with the two specified in that string. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsNetworkInterRegionRoute -Identity NA_APAC_Route -NetworkRegionLinks @{add="SA_EMEA"} ``` @@ -62,7 +63,7 @@ The syntax @{add=\} adds an element to the list of links. You can also use the syntax @{replace=\} to replace all existing links with those specified by \ (which essentially behaves the same as using NetworkRegionLinkIDs), or the syntax @{remove=\} to remove a link from the list. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsNetworkInterRegionRoute -Identity NA_Route5 -NetworkRegionID2 SouthAmerica -NetworkRegionLinkIDs "NA_SA,SA_APAC" ``` @@ -74,7 +75,28 @@ The NetworkRegionID2 parameter is used to specify the new region and then the Ne ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier for the network region route you want to modify. Network region routes are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that route. @@ -82,8 +104,7 @@ Instead, it contains a string that is a unique name that identifies that route. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -93,14 +114,16 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object reference to an existing region route. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType, which can be retrieved by calling the `Get-CsNetworkInterRegionRoute` cmdlet. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +133,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionID1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkRegionID) of one of the two regions connected through this route. The value passed to this parameter must be a different region from the value of the NetworkRegionID2 parameter. (In other words, you can't route a region to itself.) In addition, the combination of NetworkRegionID1 and NetworkRegionID2 must be unique (for example, you can't have two routes defined that connect NorthAmerica and EMEA). @@ -117,8 +143,7 @@ The value passed to this parameter must be a different region from the value of ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +153,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionID2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkRegionID) of one of the two regions connected through this route. The value passed to this parameter must be a different region from the value of the NetworkRegionID1 parameter. (In other words, you can't route a region to itself.) In addition, the combination of NetworkRegionID1 and NetworkRegionID2 must be unique (for example, you can't have two routes defined that connect NorthAmerica and EMEA). @@ -135,8 +163,7 @@ The value passed to this parameter must be a different region from the value of ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +173,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionLinkIDs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to specify all the links for this route as a string of comma-separated values. The values are the identities (NetworkRegionLinkIDs) of the region links. If you enter values for both NetworkRegionLinkIDs and NetworkRegionLinks, NetworkRegionLinkIDs will be ignored. @@ -154,8 +184,7 @@ Any links modified using this parameter will replace all existing links in the r ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,14 +194,16 @@ Accept wildcard characters: False ``` ### -NetworkRegionLinks + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list object containing the identities (NetworkRegionLinkIDs) of the region links that apply to this route. For this cmdlet, this parameter differs from the NetworkRegionLinkIDs in that in addition to allowing you to replace all existing links for this route, you can also add or remove individual links. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,14 +212,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -198,29 +231,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -234,13 +253,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType + Accepts pipelined input of network interregion route objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType. diff --git a/skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterSitePolicy.md similarity index 82% rename from skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterSitePolicy.md index 549ddcf054..3b3753bece 100644 --- a/skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterSitePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkInterSitePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkintersitepolicy +schema: 2.0.0 +title: Set-CsNetworkInterSitePolicy --- # Set-CsNetworkInterSitePolicy @@ -39,7 +40,7 @@ This cmdlet modifies a network inter-site policy that associates a bandwidth lim ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkInterSitePolicy -Identity Reno_Portland -BWPolicyProfileID HighBWLimits ``` @@ -50,7 +51,47 @@ We use the BWPolicyProfileID parameter to change the bandwidth policy profile as ## PARAMETERS +### -BWPolicyProfileID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the bandwidth policy profile that will define the limitations for this site policy. +You can retrieve a list of available profiles by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the network site policy you want to modify. Network site policies are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that site policy. @@ -58,8 +99,7 @@ Instead, it contains a string that is a unique name that identifies that site po ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -69,6 +109,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object reference to a site policy that has been modified in memory. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType and can be retrieved by calling the `Get-CsNetworkInterSitePolicy` cmdlet. @@ -76,8 +119,7 @@ This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.Net ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,32 +128,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -BWPolicyProfileID -The Identity of the bandwidth policy profile that will define the limitations for this site policy. -You can retrieve a list of available profiles by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -NetworkSiteID1 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -NetworkSiteID1 The Identity (NetworkSiteID) of one of the two sites associated with this policy. The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,14 +148,16 @@ Accept wildcard characters: False ``` ### -NetworkSiteID2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkSiteID) of one of the two sites associated with this policy. The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,14 +166,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -154,29 +185,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -190,13 +207,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType + Accepts pipelined input of network inter-site policy objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType. diff --git a/skype/skype-ps/skype/Set-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegion.md similarity index 85% rename from skype/skype-ps/skype/Set-CsNetworkRegion.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegion.md index 5262233618..38dcaea5e8 100644 --- a/skype/skype-ps/skype/Set-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkregion +schema: 2.0.0 +title: Set-CsNetworkRegion --- # Set-CsNetworkRegion @@ -43,7 +44,7 @@ Use this cmdlet to modify an existing network region, including settings that de ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkRegion -Identity NorthAmerica -Description "North American Region" ``` @@ -53,7 +54,7 @@ The Description parameter is given a value of "North American Region." If a Desc If no Description had been set, this command sets it. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsNetworkRegion -Identity EMEA -VideoAlternatePath $False ``` @@ -64,7 +65,7 @@ We then specify the VideoAlternatePath parameter, passing the value $False. Setting VideoAlternatePath to False indicates that if adequate bandwidth is not available, the video call will not be routed to an alternate path; instead, it will simply not be completed. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $a = Get-CsNetworkRegion -Identity NorthAmerica @@ -87,42 +88,10 @@ The @{add=} portion of the value adds that item to the collection of BWAlternate ## PARAMETERS -### -Identity -The unique identifier of the network region you want to modify. -The Identity will be in the form of a string that uniquely identifies that region. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -A reference to a network region object. -This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType and can be retrieved by calling the `Get-CsNetworkRegion` cmdlet. - +### -AudioAlternatePath -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AudioAlternatePath This parameter determines whether audio calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path. This parameter populates the BWAlternatePaths property. @@ -136,8 +105,7 @@ If any of your calls will be Internet calls, this value must be True, regardless ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +115,9 @@ Accept wildcard characters: False ``` ### -BWAlternatePaths + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of objects that contain information about whether alternate connection paths are allowed if a media request is unable to complete along the preferred path (for example, if limits on that path have been exceeded). Alternate path objects must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWAlternatePathType. You can create objects of this type by calling the `New-CsNetworkBWAlternatePath` cmdlet. @@ -154,8 +125,7 @@ You can create objects of this type by calling the `New-CsNetworkBWAlternatePath ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,6 +135,9 @@ Accept wildcard characters: False ``` ### -BypassID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A globally unique identifier (GUID). This GUID is used to map network regions to media bypass settings within a CAC or Enhanced 9-1-1 (E9-1-1) network configuration. (Use this BypassID value in the call to the `New-CsNetworkMediaBypassConfiguration` cmdlet.) @@ -178,8 +151,7 @@ You will receive a confirmation prompting you to verify that you want to manuall ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,6 +161,9 @@ Accept wildcard characters: False ``` ### -CentralSite + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The central site running the bandwidth policy service. This service must be enabled in order to use CAC. This service runs on the Front End Server or the Standard Edition server. @@ -196,8 +171,7 @@ This service runs on the Front End Server or the Standard Edition server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,14 +181,34 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string that describes the region. This parameter can be used to provide a more descriptive explanation of what the region is for than can be expressed by the Identity alone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -223,7 +217,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network region you want to modify. +The Identity will be in the form of a string that uniquely identifies that region. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a network region object. +This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType and can be retrieved by calling the `Get-CsNetworkRegion` cmdlet. + + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -VideoAlternatePath + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter determines whether video calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path. This parameter populates the BWAlternatePaths property. @@ -237,8 +273,7 @@ If any of your calls will be Internet calls, this value must be True, regardless ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,14 +282,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -264,29 +301,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -300,13 +323,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType + Accepts pipelined input of network region objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType. diff --git a/skype/skype-ps/skype/Set-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegionLink.md similarity index 82% rename from skype/skype-ps/skype/Set-CsNetworkRegionLink.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegionLink.md index c56b65a75a..7f0af8f3b4 100644 --- a/skype/skype-ps/skype/Set-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegionLink.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkRegionLink -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkregionlink +schema: 2.0.0 +title: Set-CsNetworkRegionLink --- # Set-CsNetworkRegionLink @@ -38,7 +39,7 @@ This cmdlet modifies a link between two regions, allowing you to change the regi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkRegionLink -Identity NA_EMEA -BWPolicyProfileID HighBWLimits ``` @@ -51,7 +52,47 @@ This will assign the bandwidth limitations defined in that bandwidth policy prof ## PARAMETERS +### -BWPolicyProfileID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the bandwidth policy profile that will define the limitations for this link. +You can retrieve a list of available profiles by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier for the network region link you want to modify. Network region links are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that link. @@ -59,8 +100,7 @@ Instead, it contains a string that is a unique name that identifies that link. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -70,6 +110,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object reference to a network region link. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType, which can be retrieved by calling the `Get-CsNetworkRegionLink` cmdlet. @@ -77,8 +120,7 @@ This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.Net ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -87,31 +129,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -BWPolicyProfileID -The Identity of the bandwidth policy profile that will define the limitations for this link. -You can retrieve a list of available profiles by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -NetworkRegionID1 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -NetworkRegionID1 The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID2 property. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,13 +148,15 @@ Accept wildcard characters: False ``` ### -NetworkRegionID2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID1 property. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,14 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -153,29 +184,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -189,13 +206,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType + Accepts pipelined input of network region link objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType. diff --git a/skype/skype-ps/skype/Set-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSite.md similarity index 84% rename from skype/skype-ps/skype/Set-CsNetworkSite.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkSite.md index 92a478becd..afe48b1896 100644 --- a/skype/skype-ps/skype/Set-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworksite +schema: 2.0.0 +title: Set-CsNetworkSite --- # Set-CsNetworkSite @@ -41,7 +42,7 @@ This can include such things as the region with which the site is associated, th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkSite -Identity Vancouver -NetworkRegionID Canada ``` @@ -53,7 +54,7 @@ Because a NetworkRegionID has been supplied but no value has been specified for Any previously-existing bypass ID will be overwritten. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsNetworkSite -Identity Vancouver - BWPolicyProfileID LowBWLimits ``` @@ -66,43 +67,10 @@ The policies associated with that profile will be used for this site. ## PARAMETERS -### -Identity -The unique identifier of the network site you want to modify. -Sites are created only at the global scope, so you do not need to specify a scope. -Instead, you need to specify only the network site ID. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -A reference to a network site object (an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType). -This object can be retrieved by calling the `Get-CsNetworkSite` cmdlet. - - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -BWPolicyProfileID -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -BWPolicyProfileID The Identity of the bandwidth policy profile that will define the limitations for this site. You can retrieve a list of available profiles by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. @@ -111,8 +79,7 @@ If you specify a value for this parameter, you must also specify a value for the ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +89,9 @@ Accept wildcard characters: False ``` ### -BypassID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A globally unique identifier (GUID). This GUID is used to map network sites to media bypass settings within a CAC or E9-1-1 network configuration. (Use this BypassID value in the call to the `New-CsNetworkMediaBypassConfiguration` cmdlet.) @@ -137,8 +107,7 @@ If you manually enter a value, you will receive a confirmation prompt to verify ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,14 +117,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string that describes the site. This parameter can be used to provide a more descriptive explanation of what the site is for or where it is than can be expressed by the Identity alone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,16 +135,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationPolicy -The name of the location policy associated with this site. -The location policy assigns specific E9-1-1 settings to the site. -To retrieve a list of location policies, call the `Get-CsLocationPolicy` cmdlet. +### -EnableLocationBasedRouting + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,18 +154,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -The Identity of the network region that this site is associated with. -This parameter must contain a value if you want to provide a BypassID (either through auto-generation or manually), or if the EnableBandwidthPolicyCheck property of the network configuration is True. -You can retrieve the network configuration settings by calling the `Get-CsNetworkConfiguration` cmdlet. +### -Force -If a BypassID exists on this site already and you don't specify a value for the BypassID parameter, the existing BypassID will be overwritten by an auto-generated BypassID. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,46 +172,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network site you want to modify. +Sites are created only at the global scope, so you do not need to specify a scope. +Instead, you need to specify only the network site ID. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a network site object (an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType). +This object can be retrieved by calling the `Get-CsNetworkSite` cmdlet. + ```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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -LocationPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name of the location policy associated with this site. +The location policy assigns specific E9-1-1 settings to the site. +To retrieve a list of location policies, call the `Get-CsLocationPolicy` cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -250,15 +232,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationBasedRouting -When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. -The default value is False. +### -NetworkRegionID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the network region that this site is associated with. +This parameter must contain a value if you want to provide a BypassID (either through auto-generation or manually), or if the EnableBandwidthPolicyCheck property of the network configuration is True. +You can retrieve the network configuration settings by calling the `Get-CsNetworkConfiguration` cmdlet. + +If a BypassID exists on this site already and you don't specify a value for the BypassID parameter, the existing BypassID will be overwritten by an auto-generated BypassID. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,6 +255,9 @@ Accept wildcard characters: False ``` ### -VoiceRoutingPolicy + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Per-user voice routing policy to be assigned to the site. For example: @@ -280,8 +270,43 @@ This parameter was introduced in the February, 2013 release of Lync Server 2013. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -295,13 +320,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType + Accepts pipelined input of network site objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType. diff --git a/skype/skype-ps/skype/Set-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSubnet.md similarity index 81% rename from skype/skype-ps/skype/Set-CsNetworkSubnet.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkSubnet.md index c12c29f142..35ca2806b7 100644 --- a/skype/skype-ps/skype/Set-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworksubnet +schema: 2.0.0 +title: Set-CsNetworkSubnet --- # Set-CsNetworkSubnet @@ -38,7 +39,7 @@ Use this cmdlet to modify the associated network site, change the description of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkSubnet -Identity 172.11.15.0 -MaskBits 25 -NetworkSiteID Chicago ``` @@ -47,7 +48,7 @@ This example modifies the subnet with the Identity (the Subnet ID) 172.11.15.0. The subnet is modified with a new MaskBits value (25) and a new NetworkSiteID (Chicago). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSubnet | Where-Object {$_.NetworkSiteID -eq "Vancouver"} | Set-CsNetworkSubnet -NetworkSiteID Chicago ``` @@ -64,15 +65,53 @@ By passing the parameter a value of Chicago, we're instructing the `Set-CsNetwor ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A description of the subnet being modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique subnet ID of the subnet you want to modify. This value will be either an IP address (such as 174.11.12.0) or a URL beginning with http: or https:. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -82,6 +121,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to the network subnet object that you want to modify. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType, which can be retrieved by calling the `Get-CsNetworkSubnet` cmdlet. @@ -89,8 +131,7 @@ This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.Net ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,30 +140,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Description -A description of the subnet being modified. +### -MaskBits -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaskBits The bitmask to be applied to the subnet. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +159,16 @@ Accept wildcard characters: False ``` ### -NetworkSiteID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The site ID of the network site to which this subnet is to be applied. You can retrieve site IDs for your deployment by calling the `Get-CsNetworkSite` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,14 +177,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -165,29 +196,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -201,13 +218,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType + Accepts pipelined input of network subnet objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType. diff --git a/skype/skype-ps/skype/Set-CsOAuthConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsOAuthConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsOAuthConfiguration.md index ad81bf71a0..d94278555a 100644 --- a/skype/skype-ps/skype/Set-CsOAuthConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csoauthconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsOAuthConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csoauthconfiguration +schema: 2.0.0 +title: Set-CsOAuthConfiguration --- # Set-CsOAuthConfiguration @@ -50,7 +52,7 @@ The following parameters are not applicable to Skype for Business Online: Additi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOAuthConfiguration -Identity global -Realm "contoso.com" ``` @@ -61,15 +63,80 @@ In this example, the Realm property is set to "contoso.com". ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -AdditionalAudienceUrls + +> Applicable: Skype for Business Online +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlternateAudienceUrl + +> Applicable: Skype for Business Online + +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 +``` + +### -ClientAdalAuthOverride + +> Applicable: Skype for Business Online + +Enable or disable ADAL (Modern Authentication) for Skype for Business Online in your tenant. Valid values are + +NoOverride, use global OAuth configuration + +Allowed, Enables OAuth for the tenant + +Disallowed, Disables OAuth for the tenant + +For more information, see [Hybrid Modern Authentication overview and prerequisites for using it with on-premises Skype for Business and Exchange servers](https://learn.microsoft.com/office365/enterprise/hybrid-modern-auth-overview) + +```yaml +Type: ClientAdalAuthOverride +Parameter Sets: (All) +Aliases: +Accepted values: NoOverride, Allowed, Disallowed + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAuthorizationOAuthServerIdentity + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +URI of the OAuth server used for client authentication. + + +```yaml +Type: String +Parameter Sets: Identity, (All) +Aliases: Required: False Position: Named @@ -79,6 +146,9 @@ Accept wildcard characters: False ``` ### -ExchangeAutodiscoverAllowedDomains + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of domains that autodiscover requests can be redirected to. For example: @@ -88,8 +158,7 @@ For example: ```yaml Type: String Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,14 +168,16 @@ Accept wildcard characters: False ``` ### -ExchangeAutodiscoverUrl + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the autodiscovery service used by the Office 365 version of Microsoft Exchange Server. ```yaml Type: String Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,14 +187,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +206,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the OAuth configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the `Set-CsOAuthConfiguration` cmdlet. You can, however, use the following syntax to reference the global settings: @@ -143,8 +219,7 @@ You can, however, use the following syntax to reference the global settings: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -154,13 +229,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +247,16 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Server-to-server security container. By default, Skype for Business Server uses your default SIP domain as its OAuth realm. ```yaml Type: String Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,14 +266,16 @@ Accept wildcard characters: False ``` ### -ServiceName + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) assigned to the OAuth service. ```yaml Type: String Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +285,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the OAuth configuration settings are being modified. For example: @@ -217,25 +301,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid 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 -``` - -### -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 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,30 +310,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdditionalAudienceUrls -This parameter is reserved for internal Microsoft use. +### -Confirm -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +> 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 -``` +Prompts you for confirmation before executing the command. -### -AlternateAudienceUrl -This parameter is reserved for internal Microsoft use. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -276,40 +329,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientAdalAuthOverride -Enable or disable ADAL (Modern Authentication) for Skype for Business Online in your tenant. Valid values are +### -WhatIf -NoOverride, use global OAuth configuration +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Allowed, Enables OAuth for the tenant - -Disallowed, Disables OAuth for the tenant +Describes what would happen if you executed the command without actually executing the command. -For more information, see [Hybrid Modern Authentication overview and prerequisites for using it with on-premises Skype for Business and Exchange servers](https://learn.microsoft.com/office365/enterprise/hybrid-modern-auth-overview) ```yaml -Type: ClientAdalAuthOverride +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Accepted values: NoOverride, Allowed, Disallowed -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientAuthorizationOAuthServerIdentity -URI of the OAuth server used for client authentication. - - -```yaml -Type: String -Parameter Sets: Identity, (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -323,13 +353,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthSettings The `Set-CsOAuthConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthSettings object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsOAuthConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthServer.md similarity index 84% rename from skype/skype-ps/skype/Set-CsOAuthServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsOAuthServer.md index 0749b9d100..c3e226867c 100644 --- a/skype/skype-ps/skype/Set-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsOAuthServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csoauthserver +schema: 2.0.0 +title: Set-CsOAuthServer --- # Set-CsOAuthServer @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOAuthServer -Identity "Office 365" -MetadataUrl "https://sts.office365.microsoft.com/metadata/json/1" ``` @@ -50,30 +51,36 @@ The command shown in Example 1 updates the metadata URL for the OAuth Server Off ## PARAMETERS -### -Identity -Friendly (and unique) name used to identify the OAuth server. +### -AcceptSecurityIdentifierInformation + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. +The default value is False. ```yaml -Type: XdsGlobalRelativeIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -AuthorizationUriOverride + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +URI used for OAuth authorization override. +The override prevents authenticated users from being reprompted for their credentials after they have logged on. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,13 +90,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,14 +107,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Friendly (and unique) name used to identify the OAuth server. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,14 +144,16 @@ Accept wildcard characters: False ``` ### -MetadataUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where the WS-FederationMetadata for the server is published. Servers use the metadata to agree on the types of tokens that will be exchanged as well the keys that will be used to sign these tokens. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +163,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for the OAuth server being modified. For example: @@ -145,8 +179,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,31 +188,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Type -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Type of authentication used by the server. +For example, this syntax configures the server to use Active Directory Federation Services authentication: -### -AcceptSecurityIdentifierInformation -When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. -The default value is False. +`-Type "ADFS"` ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,15 +209,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthorizationUriOverride -URI used for OAuth authorization override. -The override prevents authenticated users from being reprompted for their credentials after they have logged on. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -205,17 +227,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Type of authentication used by the server. -For example, this syntax configures the server to use Active Directory Federation Services authentication: +### -WhatIf -`-Type "ADFS"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -229,13 +250,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated The `Set-CsOAuthServer` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsOAuthServer` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundCallingNumberTranslationRule.md similarity index 85% rename from skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsOutboundCallingNumberTranslationRule.md index 02b03a405f..4c41f8a013 100644 --- a/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundCallingNumberTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsOutboundCallingNumberTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csoutboundcallingnumbertranslationrule +schema: 2.0.0 +title: Set-CsOutboundCallingNumberTranslationRule --- # Set-CsOutboundCallingNumberTranslationRule @@ -47,7 +48,7 @@ In the Edit Trunk Configuration dialog box, scroll down to the section labeled C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond/SevenDigit" -Priority 0 ``` @@ -58,31 +59,17 @@ In this example, the Priority is set to 0. ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description Enables administrators to provide additional text to accompany a translation rule. This description can be used to help administrators clearly identify the purpose of the rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -92,13 +79,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +97,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the translation rule to be modified. The Identity consists of the scope followed by a unique name within each scope. For example: @@ -117,8 +109,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -128,13 +119,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,13 +137,15 @@ Accept wildcard characters: False ``` ### -Pattern + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression representing the number pattern to which the Translation will be applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,6 +155,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Priority assigned to the rule. If a number matches the Pattern of more than one outbound translation rule, rules are applied in priority order. Rules are processed in order of their assigned priority; the first rule to be processed has a priority of 0; the second rule to be processed has a priority of 1; and so on. @@ -167,8 +165,7 @@ Rules are processed in order of their assigned priority; the first rule to be pr ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,13 +175,33 @@ Accept wildcard characters: False ``` ### -Translation + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that will be applied to the number matching the Pattern to prepare that number for outbound calling. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -194,13 +211,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -214,13 +233,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated The `Set-CsOutboundCallingNumberTranslationRule` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsOutboundCallingNumberTranslationRule` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundTranslationRule.md similarity index 85% rename from skype/skype-ps/skype/Set-CsOutboundTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsOutboundTranslationRule.md index 8840737092..7bd545f536 100644 --- a/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsOutboundTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csoutboundtranslationrule +schema: 2.0.0 +title: Set-CsOutboundTranslationRule --- # Set-CsOutboundTranslationRule @@ -48,7 +49,7 @@ Calling the `Set-CsOutboundTranslationRule` cmdlet is the recommended way of cha ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond" -Description "Convert to seven digits" -Pattern '^\+1425(\d{7})$' -Translation '$1' ``` @@ -60,7 +61,7 @@ These values translate an E.164 number (in this case 12 digits beginning with +1 For example, the number +14255551212 would be translated to the number 5551212. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsOutboundTranslationRule -Identity "site:Redmond/OBR1" @@ -82,7 +83,47 @@ That's because the rule with that Identity no longer exists, it's been replaced ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A friendly description of the outbound translation rule. +This description can be used to help administrators clearly identify the purpose of the rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the outbound translation rule you want to modify. The Identity consists of the scope followed by a unique name within each scope. For example, site:Redmond/OutboundRule1. @@ -90,8 +131,7 @@ For example, site:Redmond/OutboundRule1. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -101,6 +141,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object reference to an outbound translation rule. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule, which can be retrieved by calling the `Get-CsOutboundTranslationRule` cmdlet. @@ -108,8 +151,7 @@ This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.Tru ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,31 +160,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Description -A friendly description of the outbound translation rule. -This description can be used to help administrators clearly identify the purpose of the rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Pattern -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Pattern A regular expression representing the number pattern to which the Translation will be applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,14 +179,16 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If a number matches the Pattern of more than one outbound translation rule, rules are applied in priority order. Use this parameter to assign a priority to the rule. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +198,15 @@ Accept wildcard characters: False ``` ### -Translation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that will be applied to the number matching the Pattern to prepare that number for outbound routing. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,14 +215,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -201,29 +234,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -237,13 +256,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule + Accepts pipelined input of outbound translation rule objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule. diff --git a/skype/skype-ps/skype/Set-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsPartnerApplication.md similarity index 88% rename from skype/skype-ps/skype/Set-CsPartnerApplication.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPartnerApplication.md index b1273b0d76..1b49602450 100644 --- a/skype/skype-ps/skype/Set-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPartnerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPartnerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspartnerapplication +schema: 2.0.0 +title: Set-CsPartnerApplication --- # Set-CsPartnerApplication @@ -74,7 +75,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPartnerApplication -Identity "MicrosoftExchange" -Enabled $False ``` @@ -83,7 +84,7 @@ The command shown in Example 1 disables the partner application MicrosoftExchang This is done by setting the Enabled property to False ($False). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPartnerApplication | ForEach-Object {Set-CsPartnerApplication -Identity $_.Identity -Enabled $False} ``` @@ -95,7 +96,7 @@ In turn, the `ForEach-Object` cmdlet runs the `Set-CsPartnerApplication` cmdlet Doing so disables each of those partner applications. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPartnerApplication | Where-Object {$_.ApplicationTrustLevel -eq "User"} | ForEach-Object {Set-CsPartnerApplication -Identity $_.Identity -Enabled $False} ``` @@ -108,77 +109,91 @@ That filtered collection is then piped to the `ForEach-Object` cmdlet, which use ## PARAMETERS -### -CertificateFileData -Path to a certificate file that can be assigned to the partner application. -For example: +### -AcceptSecurityIdentifierInformation -`-CertificateFileData "C:\Certificates\PartnerApplication.cer"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. +The default value is False. ```yaml -Type: String -Parameter Sets: CertificateFileData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CertificateRawData -Certificate (in Base64 encoded format) that can be assigned to the partner application. -To read raw data from a certificate and then convert that data to the required format, use commands similar to these: +### -ApplicationTrustLevel -`$x = [System.IO.File]::ReadAllBytes('C:\Certificates\PartnerApplication.cer')` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$y = [Convert]::ToBase64String($x)` +Specifies the level of trust between Skype for Business Server and the partner application. +Allowed values are: -You can then use this syntax to assign the certificate data stored in the variable $y: +* Full -- The partner application is trusted to represent itself and to impersonate any user in the realm. This is the default value. +* Application -- The partner application is trusted to represent itself within the realm. In order to impersonate a user, it must obtain consent through from a security token server. +* User -- The partner application must obtain consent from a security token server in order to represent a user, and cannot represent itself. + +The default value is Full. -`-CertificateRawData $y` ```yaml -Type: String -Parameter Sets: CertificateRawData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: ApplicationTrustLevel +Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier of the partner application. +### -CertificateFileData + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to a certificate file that can be assigned to the partner application. For example: -`-Identity "MicrosoftExchange"` +`-CertificateFileData "C:\Certificates\PartnerApplication.cer"` ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: CertificateFileData +Aliases: Required: True -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MetadataUrl -URL of the security token servicer federation metadata that carries the signing keys, the issuer identifier and the issuer endpoint URL. +### -CertificateRawData + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Certificate (in Base64 encoded format) that can be assigned to the partner application. +To read raw data from a certificate and then convert that data to the required format, use commands similar to these: + +`$x = [System.IO.File]::ReadAllBytes('C:\Certificates\PartnerApplication.cer')` + +`$y = [Convert]::ToBase64String($x)` + +You can then use this syntax to assign the certificate data stored in the variable $y: + +`-CertificateRawData $y` ```yaml Type: String -Parameter Sets: MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: CertificateRawData +Aliases: Required: True Position: Named @@ -187,32 +202,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseOAuthServer -When present, the partner application will use the configured OAuth Server for server-to-server authentication. -When not present, the partner application will use its built-in security token service for server-to-server authentication. +### -Enabled + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the partner application is available for use with Skype for Business Server. +When set to False the partner application will continue to run, but will not be able to communicate with Skype for Business Server until the Enabled property has been set to True. + ```yaml -Type: SwitchParameter -Parameter Sets: UseOAuthServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptSecurityIdentifierInformation -When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. -The default value is False. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean -Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -221,72 +240,81 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationTrustLevel -Specifies the level of trust between Skype for Business Server and the partner application. -Allowed values are: +### -Identity -* Full -- The partner application is trusted to represent itself and to impersonate any user in the realm. This is the default value. -* Application -- The partner application is trusted to represent itself within the realm. In order to impersonate a user, it must obtain consent through from a security token server. -* User -- The partner application must obtain consent from a security token server in order to represent a user, and cannot represent itself. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is Full. +Unique identifier of the partner application. +For example: +`-Identity "MicrosoftExchange"` ```yaml -Type: ApplicationTrustLevel +Type: XdsGlobalRelativeIdentity Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Enabled -When set to True, the partner application is available for use with Skype for Business Server. -When set to False the partner application will continue to run, but will not be able to communicate with Skype for Business Server until the Enabled property has been set to True. +### -MetadataUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +URL of the security token servicer federation metadata that carries the signing keys, the issuer identifier and the issuer endpoint URL. ```yaml -Type: Boolean -Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: MetadataUrl +Aliases: -Required: False +Required: True 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 occur when running the command. +### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the partner application being modified. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Guid +Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl +Aliases: Required: False Position: Named @@ -295,38 +323,35 @@ 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. +### -UseOAuthServer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, the partner application will use the configured OAuth Server for server-to-server authentication. +When not present, the partner application will use its built-in security token service for server-to-server authentication. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: UseOAuthServer +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the partner application being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -Confirm -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Guid -Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -336,13 +361,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -356,14 +383,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsPartnerApplication` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPartnerApplication` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatActiveServer.md similarity index 89% rename from skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatActiveServer.md index 6bb38b73c1..ad3cf2dc3b 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatActiveServer.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Set-CsPersistentChatActiveServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatactiveserver +schema: 2.0.0 +title: Set-CsPersistentChatActiveServer --- # Set-CsPersistentChatActiveServer @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers @{Add="atl-gc-001.litwareinc.com"} ``` @@ -67,7 +68,7 @@ To add the server to the Then run the following cmdlet to add the server, using `Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers @{Add="atl-gc-001.litwareinc.com"}` -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers @{Remove="atl-gc-001.litwareinc.com"} ``` @@ -75,7 +76,7 @@ Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServer Example 2 removes the server atl-gc-001.litwareinc.com from the collection of active Persistent Chat servers. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers $Null ``` @@ -87,13 +88,15 @@ Removing all the active servers is typically done in a failback or failover scen ## PARAMETERS ### -ActiveServers + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Collection of fully-qualified domain names representing the active Persistent Chat servers. ```yaml Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Deploy.Fqdn] Parameter Sets: Explicit -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -102,80 +105,90 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Swap -When specified, swaps the active state for all the Persistent Chat servers in the specified pool: active servers will be marked as inactive, and inactive servers will be marked as active. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter -Parameter Sets: Swap -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique Identity for the collection of active servers. +Note that you can only have a single collection of Persistent Chat servers. + ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False -Position: Named +Position: 2 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. +### -Swap + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +When specified, swaps the active state for all the Persistent Chat servers in the specified pool: active servers will be marked as inactive, and inactive servers will be marked as active. ```yaml Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Parameter Sets: Swap +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique Identity for the collection of active servers. -Note that you can only have a single collection of Persistent Chat servers. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 +Prompts you for confirmation before executing the command. ```yaml -Type: XdsGlobalRelativeIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -189,14 +202,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsPersistentChatActiveServer` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatAddin.md similarity index 89% rename from skype/skype-ps/skype/Set-CsPersistentChatAddin.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatAddin.md index 57d307c906..edd2a224a7 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatAddin.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Set-CsPersistentChatAddin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchataddin +schema: 2.0.0 +title: Set-CsPersistentChatAddin --- # Set-CsPersistentChatAddin @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: To modify an existing Persistent Chat a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITPersistentChatAddin" -Url "https://atl-cs-001.litwareinc.com/itchat2" ``` @@ -60,6 +61,9 @@ In this case, the URL is changed to `https://atl-cs-001.litwareinc.com/itchat2`. ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat add-in. The Identity is composed of the fully qualified domain name of the Persistent Chat pool where the add-in is located, a "\" character, and the add-in name. For example: @@ -69,8 +73,7 @@ For example: ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: Addin Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -95,14 +100,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Friendly name given to the Persistent Chat add-in. +Names must be unique per Persistent Chat pool. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -111,15 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Friendly name given to the Persistent Chat add-in. -Names must be unique per Persistent Chat pool. +### -Url + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +URL of the Web page to be displayed by the Persistent Chat add-in. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -128,14 +137,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Url -URL of the Web page to be displayed by the Persistent Chat add-in. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -145,13 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -165,13 +178,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject The `Set-CsPersistentChatAddin` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatAddin` cmdlet modifies existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatCategory.md similarity index 91% rename from skype/skype-ps/skype/Set-CsPersistentChatCategory.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatCategory.md index 5398bb8787..0459112625 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatCategory.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Set-CsPersistentChatCategory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatcategory +schema: 2.0.0 +title: Set-CsPersistentChatCategory --- # Set-CsPersistentChatCategory @@ -56,7 +57,7 @@ Skype for Business Server Control Panel: To modify an existing Persistent Chat c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatCategory -Identity "atl-cs-001.litwareinc.com\helpdesk" -FileUpload $False ``` @@ -64,7 +65,7 @@ Set-CsPersistentChatCategory -Identity "atl-cs-001.litwareinc.com\helpdesk" -Fil In Example 1, file uploads are disabled for the Persistent Chat category atl-cs-001.litwareinc.com\helpdesk. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatCategory | Set-CsPersistentChatCategory -FileUpload $False ``` @@ -76,42 +77,10 @@ The categories in this collection are then piped to the `Set-CsPersistentChatCat ## PARAMETERS -### -Identity -Unique identifier for the chat room category. -The Identity consists of the Persistent Chat pool were the category is located followed by the category Name; for example: - -`-Identity "atl-gc-001.litwareinc.com\ITChat"` - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -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: Category -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -AllowedMembers -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -AllowedMembers Lists the users who are allowed to access chat rooms within the category. To add a new user to the Members list, use syntax similar to this: @@ -141,8 +110,7 @@ To add all the users in a distribution list, use the Active Directory distinguis ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -152,14 +120,16 @@ Accept wildcard characters: False ``` ### -AsObject + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When specified, Active Directory display names are used when adding users to or removing users from the AllowedMembers, DeniedMembers and Creators lists. When not specified, SIP addresses are used when managing these lists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -169,14 +139,16 @@ Accept wildcard characters: False ``` ### -ChatHistory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to False ($False), the chat history feature will be disabled for the new category. Typically, chat history is only disabled for chat rooms that are used for announcements that are posted once and then never need to be referred to again. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -185,23 +157,10 @@ 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 2013, Skype for Business Server 2015 +### -Creators -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Creators Lists the users who are allowed to create chat rooms within the category. To add a new user to the Creators list, use syntax similar to this: @@ -231,8 +190,7 @@ To add all the users in a distribution list, use the Active Directory distinguis ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -242,6 +200,9 @@ Accept wildcard characters: False ``` ### -DeniedMembers + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Lists the users who are not allowed to access chat rooms within the category. To add a new user to the DeniedMembers list, use syntax similar to this: @@ -271,8 +232,7 @@ To deny access to all the users in a distribution list, use the Active Directory ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -282,14 +242,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Additional text accompanying the Persistent Chat category. For example, the Description might explain the purpose of the category and what type of rooms you can expect to find within the category. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -299,13 +261,15 @@ Accept wildcard characters: False ``` ### -FileUpload + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True ($True), allows file uploads to the chat rooms in the category. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -314,15 +278,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique identifier for the chat room category. +The Identity consists of the Persistent Chat pool were the category is located followed by the category Name; for example: + +`-Identity "atl-gc-001.litwareinc.com\ITChat"` + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: Category +Parameter Sets: Instance +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Invitations + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to False ($False), Invitations will be enabled for the category. Among other things, this means that users on the AllowedMembers list will automatically receive an invitation to join a new chat room at the time that new room is created. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -332,14 +337,34 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Name given to the Persistent Chat category. Names must be unique per Persistent Chat pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -349,13 +374,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -369,13 +396,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject The `Set-CsPersistentChatCategory` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatCategory` cmdlet modifies existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatComplianceConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatComplianceConfiguration.md index 9dabe65046..3b9b28584a 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatComplianceConfiguration.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Set-CsPersistentChatComplianceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatcomplianceconfiguration +schema: 2.0.0 +title: Set-CsPersistentChatComplianceConfiguration --- # Set-CsPersistentChatComplianceConfiguration @@ -52,7 +53,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatComplianceConfiguration -Identity "global" -RunInterval "00:10:00" ``` @@ -60,7 +61,7 @@ Set-CsPersistentChatComplianceConfiguration -Identity "global" -RunInterval "00: Example 1 sets the RunInterval property of the global collection of Persistent Chat compliance configuration settings to 10 minutes: 00 hours : 10 minutes : 00 seconds. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatComplianceConfiguration | Set-CsPersistentChatComplianceConfiguration -RunInterval "00:10:00" ``` @@ -73,14 +74,16 @@ This collection is then piped to the `Set-CsPersistentChatComplianceConfiguratio ## PARAMETERS ### -AdapterName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Name of the Persistent Chat adapters. Adapters are third-party products that convert the data in the compliance database to a specific format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -90,14 +93,16 @@ Accept wildcard characters: False ``` ### -AdapterOutputDirectory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full path to the folder where adapter data is stored. You must have a separate folder for each adapter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -AdapterType + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies the fully qualified name of a .Net managed type that implements the Microsoft.Rtc.Internal.Chat.Server.Compliance.IComplianceAdapter interface. This adapter is supplied by a third-party or can be set to the internal XML adapter, "Microsoft.Rtc.Internal.Chat.Server.Compliance.XmlAdapter,compliance". @@ -116,8 +124,7 @@ If you do not specify an adapter type Persistent Chat will not save compliance d ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -AddChatRoomDetails + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, additional details about each chat room are provided to the adapter. This has the potential to greatly increase the size of the compliance data. @@ -136,8 +146,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -147,6 +156,9 @@ Accept wildcard characters: False ``` ### -AddUserDetails + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, additional details about each chat room user are provided to the adapter. This has the potential to greatly increase the size of the compliance data. @@ -156,8 +168,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -166,23 +177,10 @@ 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 2013, Skype for Business Server 2015 +### -CreateFileAttachmentsManifest -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -CreateFileAttachmentsManifest 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. @@ -190,8 +188,7 @@ These files will have the file extension .ATTACH and are placed in the location ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -201,14 +198,16 @@ Accept wildcard characters: False ``` ### -CustomConfiguration + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + XSLT transform script that enables Persistent Chat to save compliance data in a custom format of your design. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -218,13 +217,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -234,6 +235,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat compliance settings to be modified. To modify the global collection, use this syntax: @@ -253,8 +257,7 @@ If this parameter is not included then the `Set-CsPersistentChatComplianceConfig ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -264,13 +267,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -280,14 +285,16 @@ Accept wildcard characters: False ``` ### -OneChatRoomPerOutputFile + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, separate reports are created for each chat room. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -297,6 +304,9 @@ Accept wildcard characters: False ``` ### -RunInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Amount of time that the server waits before generating the next output file. The RunInterval must be specified using the format days.hours:minutes:seconds. For example, to specify a RunInterval of 15 minutes (the default value) use this syntax: @@ -308,8 +318,25 @@ The RunInterval can be set to any value between 1 minute (00:01.00) and 30 days ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -319,13 +346,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -339,13 +368,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration The `Set-CsPersistentChatComplianceConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatComplianceConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatConfiguration.md index f174447fa0..a513b93ebc 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatConfiguration.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2015 -title: Set-CsPersistentChatConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatconfiguration +schema: 2.0.0 +title: Set-CsPersistentChatConfiguration --- # Set-CsPersistentChatConfiguration @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: To modify an existing collection of Per ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatConfiguration -Identity "global" -DefaultChatHistory 100 ``` @@ -56,7 +57,7 @@ Set-CsPersistentChatConfiguration -Identity "global" -DefaultChatHistory 100 The command shown in Example 1 sets the DefaultChatHistory property of the global Persistent Chat configuration settings to 100. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatConfiguration | Set-CsPersistentChatConfiguration -DefaultChatHistory 100 ``` @@ -66,7 +67,7 @@ To carry out this task, the command first uses the `Get-CsPersistentChatConfigur This collection is then piped to the `Set-CsPersistentChatConfiguration` cmdlet, which modifies the DefaultChatHistory property for all the items in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatConfiguration -Filter "site:*" | Set-CsPersistentChatConfiguration -DefaultChatHistory 100 ``` @@ -76,7 +77,7 @@ To do this, the command first calls the `Get-CsPersistentChatConfiguration` cmdl These settings are then piped to the `Set-CsPersistentChatConfiguration` cmdlet, which changes the DefaultChatHistory property for each settings collection to 100. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatConfiguration | Where-Object {$_.DefaultChatHistory -gt 100} | Set-CsPersistentChatConfiguration -DefaultChatHistory 100 ``` @@ -89,23 +90,10 @@ In turn, that filtered collection is piped to the `Set-CsPersistentChatConfigura ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -DefaultChatHistory -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -DefaultChatHistory Default number of chat messages instantly available in a chat room. Note that this value represents only the number of messages immediately available; it does not place a limit on the total amount of messages that can be retrieved. @@ -115,8 +103,7 @@ The default value is 30. ```yaml Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -126,13 +113,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -142,6 +131,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat configuration settings to be modified. To modify a collection of settings configured at the site scope, use syntax similar to this: @@ -161,8 +153,7 @@ If you do not include the Identity parameter the `Set-CsPersistentChatConfigurat ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -172,13 +163,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -188,14 +181,16 @@ Accept wildcard characters: False ``` ### -MaxFileSizeKB + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum size of a file (in kilobytes) that can be uploaded or downloaded by the web service. The default value is 20000 KB. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -205,14 +200,16 @@ Accept wildcard characters: False ``` ### -ParticipantUpdateLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum number of users who can participate in a chat room before the active participant list updates are disabled. The default value is 75. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -222,13 +219,33 @@ Accept wildcard characters: False ``` ### -RoomManagementUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + URL for the Web page administrators can use to manage individual chat rooms. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -238,13 +255,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -258,13 +277,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration The `Set-CsPersistentChatConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatPolicy.md similarity index 90% rename from skype/skype-ps/skype/Set-CsPersistentChatPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatPolicy.md index 0be410776e..8e490a72b3 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatPolicy.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Set-CsPersistentChatPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatpolicy +schema: 2.0.0 +title: Set-CsPersistentChatPolicy --- # Set-CsPersistentChatPolicy @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: To modify an existing Persistent Chat p ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatPolicy | Set-CsPersistentChatPolicy -EnablePersistentChat $True ``` @@ -59,31 +60,17 @@ This collection is then piped to the `Set-CsPersistentChatPolicy` cmdlet, which ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -Description -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +> Applicable: Lync Server 2013, Skype for Business Server 2015 -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: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -93,14 +80,16 @@ Accept wildcard characters: False ``` ### -EnablePersistentChat + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True users affected by the policy will be allowed to use Persistent Chat. When set to False (the default value) users affected by the policy will not be allowed to use Persistent Chat. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -110,13 +99,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -126,6 +117,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identity of the Persistent Chat policy to be modified. To modify the global policy, use this syntax: @@ -145,8 +139,7 @@ If you do not include the Identity parameter the `Set-CsPersistentChatPolicy` cm ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -156,13 +149,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -171,14 +166,23 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant + +> Applicable: Skype for Business Server 2015 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the Persistent Chat 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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -187,21 +191,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the Persistent Chat policy is being modified. -For example: +### -Confirm -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +Prompts you for confirmation before executing the command. -`Get-CsTenant | Select-Object DisplayName, TenantID` +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015 +Aliases: wi Required: False Position: Named @@ -215,13 +232,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy The `Set-CsPersistentChatPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatPolicy` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatRoom.md similarity index 90% rename from skype/skype-ps/skype/Set-CsPersistentChatRoom.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatRoom.md index 0a6014d89c..e1f5c5c575 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatRoom.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Set-CsPersistentChatRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatroom +schema: 2.0.0 +title: Set-CsPersistentChatRoom --- # Set-CsPersistentChatRoom @@ -56,7 +57,7 @@ Skype for Business Server Control Panel: To modify an existing Persistent Chat c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom" -Disabled $True ``` @@ -64,7 +65,7 @@ Set-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom" -Disab The command shown in Example 1 disables the Persistent Chat chat room with the Identity atl-cs-001.litwareinc.com\ITChatRoom. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatRoom -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" | Set-CsPersistentChatRoom -Disabled $True ``` @@ -74,7 +75,7 @@ This task is performed by first using the `Get-CsPersistentChatRoom` cmdlet and These chat rooms are then piped to the `Set-CsPersistentChatRoom` cmdlet, which sets the Disabled property of each room to True ($True). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatRoom | Set-CsPersistentChatRoom -Disabled $True ``` @@ -86,42 +87,10 @@ This collection is then piped to the `Set-CsPersistentChatRoom` cmdlet, which di ## PARAMETERS -### -Identity -Unique Identifier for the Persistent Chat chat room being modified. -The Identity for a chat room consists of the Persistent Chat pool where the room has been configured plus the name of the room; for example: - -`-Identity "atl-gc-001.litwareinc.com\RedmondChatRoom"` - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -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. +### -Addin -```yaml -Type: ChatRoom -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +> Applicable: Lync Server 2013, Skype for Business Server 2015 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Addin Name of the Persistent Chat add-in, if any, associated with the chat room. A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. Add-ins can be created by using the `New-CsPersistentChatAddin` cmdlet. @@ -129,8 +98,7 @@ Add-ins can be created by using the `New-CsPersistentChatAddin` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -140,14 +108,16 @@ Accept wildcard characters: False ``` ### -AsObject + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When specified, Active Directory display names are used when adding users to or removing users from the Managers or Presenters lists. When not specified, SIP addresses are used when managing these lists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -157,6 +127,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Category under which the room is located; for example: `-Category "IT"` @@ -167,8 +140,7 @@ Categories, which are a collection of chat rooms, can be created by using the `N ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -177,30 +149,16 @@ 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 2013, Skype for Business Server 2015 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Description Enables administrators to provide additional information about the new chat room. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -210,14 +168,16 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True ($True), the new chat room will be disabled and unavailable for use when it is first created. If this parameter is not used then the new chat room will be enabled and available for immediate use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -227,13 +187,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -242,7 +204,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique Identifier for the Persistent Chat chat room being modified. +The Identity for a chat room consists of the Persistent Chat pool where the room has been configured plus the name of the room; for example: + +`-Identity "atl-gc-001.litwareinc.com\RedmondChatRoom"` + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: ChatRoom +Parameter Sets: Instance +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Invitations + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies whether or not invitations for the chat room will be inherited from the category. Among other things, this means that users on the Members list will automatically receive an invitation to join a new chat room at the time that new room is created. If set to False, invitations will not be used for the room. @@ -251,8 +255,7 @@ If set to Inherit, the room will use the Invitations setting specified for its C ```yaml Type: ChatRoomInvitations Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -262,6 +265,9 @@ Accept wildcard characters: False ``` ### -Managers + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + List of users allowed to define the membership of the chat room as well as configure other settings for the room. To add a new user to the Managers list, use syntax similar to this: @@ -292,8 +298,7 @@ To make all the users in a distribution list chat room managers, use the Active ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -303,6 +308,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + List of users who are allowed to access the chat room. If the Members property is null then the chat room inherits the membership list from its Persistent Chat category. @@ -334,8 +342,7 @@ To make all the users in a distribution list chat room members, use the Active D ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -345,14 +352,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Name of the Persistent Chat chat room. Names must be unique per Persistent Chat pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -362,6 +371,9 @@ Accept wildcard characters: False ``` ### -Presenters + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + List of users who are allowed to post messages in an auditorium chat room. To add a new user to the Presenters list, use syntax similar to this: @@ -392,8 +404,7 @@ To make all the users in a distribution list chat room presenters, use the Activ ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -403,6 +414,9 @@ Accept wildcard characters: False ``` ### -Privacy + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Privacy settings for the chat room. Allowed values are: @@ -413,8 +427,7 @@ Allowed values are: ```yaml Type: ChatRoomPrivacy Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -424,6 +437,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies whether the chat room is configured as a Normal chat room (where all members can post messages) or an Auditorium (where only presenters can post messages). For example: @@ -434,8 +450,25 @@ The default value is Normal. ```yaml Type: ChatRoomType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -445,13 +478,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -465,13 +500,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject The `Set-CsPersistentChatRoom` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatRoom` cmdlet modifies existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatState.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatState.md similarity index 88% rename from skype/skype-ps/skype/Set-CsPersistentChatState.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatState.md index b0d38cefb9..0232705158 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatState.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatState.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Set-CsPersistentChatState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatstate +schema: 2.0.0 +title: Set-CsPersistentChatState --- # Set-CsPersistentChatState @@ -43,7 +44,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatState -Identity "PersistentChatServer:atl-gc-001.litwareinc.com" -PoolState "FailedOver" ``` @@ -53,30 +54,16 @@ The command shown in Example 1 sets the pool state for the Persistent Chat serve ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -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: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -86,6 +73,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Service Identity of the Persistent Chat pool where the new service state will be applied. For example: @@ -94,8 +84,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -105,13 +94,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -121,6 +112,9 @@ Accept wildcard characters: False ``` ### -PoolState + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Current state of the Persistent Chat pool. Valid values are: @@ -132,8 +126,25 @@ The default value is Normal. ```yaml Type: PoolState Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -163,13 +176,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatState The `Set-CsPersistentChatState` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatstate object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatState` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatState object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsPinPolicy.md similarity index 87% rename from skype/skype-ps/skype/Set-CsPinPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPinPolicy.md index 8432fb8fd2..945aa20be8 100644 --- a/skype/skype-ps/skype/Set-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPinPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPinPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspinpolicy +schema: 2.0.0 +title: Set-CsPinPolicy --- # Set-CsPinPolicy @@ -45,7 +46,7 @@ PIN policies can be configured at the global, site, and per-user scopes; you can ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsPinPolicy -Identity site:Redmond -MinPasswordLength 10 ``` @@ -54,7 +55,7 @@ Example 1 modifies the PIN policy assigned to the Redmond site. In this case, the command changes the value of the MinPasswordLength property to 10; that means that new PINs will have to contain at least 10 digits. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsPinPolicy -Identity RedmondUsersPinPolicy -MinPasswordLength 10 -AllowCommonPatterns $True ``` @@ -62,7 +63,7 @@ Set-CsPinPolicy -Identity RedmondUsersPinPolicy -MinPasswordLength 10 -AllowComm Example 2 modifies two properties of the per-user PIN policy with the Identity RedmondUsersPinPolicy: it changes the value of the MinPasswordLength and the AllowCommonPatterns properties. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPinPolicy | Set-CsPinPolicy -MinPasswordLength 10 ``` @@ -72,7 +73,7 @@ To do this, the command first calls the `Get-CsPinPolicy` cmdlet without any par That collection is then piped to the `Set-CsPinPolicy` cmdlet, which modifies the value of the MinPasswordLength property for each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsPinPolicy | Where-Object {$_.MinPasswordLength -gt 10} | Set-CsPinPolicy -MaximumLogonAttempts 25 ``` @@ -84,7 +85,68 @@ The filtered set of policies is then passed to `Set-CsPinPolicy`, which takes ea ## PARAMETERS +### -AllowCommonPatterns + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not "common patterns" are allowed in PINs. +Common patterns include repeating digits (225577); 4 or more consecutive digits (991234); and PINs that match a user's phone number or extension number. +If set to True common patterns (such as the PIN 123456, which includes consecutive digits) are allowed; if set to False common patterns are not allowed. +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 +``` + +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text to accompany a PIN policy. +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier assigned to the policy when it was created. PIN policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -105,8 +167,7 @@ If you do not specify an Identity, then the `Set-CsPinPolicy` cmdlet will modify ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -116,13 +177,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,43 +194,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -AllowCommonPatterns -Indicates whether or not "common patterns" are allowed in PINs. -Common patterns include repeating digits (225577); 4 or more consecutive digits (991234); and PINs that match a user's phone number or extension number. -If set to True common patterns (such as the PIN 123456, which includes consecutive digits) are allowed; if set to False common patterns are not allowed. -The default value is 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 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -MaximumLogonAttempts -### -Description -Enables administrators to provide additional text to accompany a PIN policy. -For example, the Description might include information about the users the policy should be assigned to. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```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 -``` - -### -MaximumLogonAttempts Indicates the number of sequential logon failures that are allowed before a user's PIN is automatically locked. Logon failures are counted in two different ways: local logon failures and global logon failures. When a user first tries to logon, a new 30 minute observation window starts; each failed logon during that 30 minute window is recorded as both a local logon failure and a global logon failure. @@ -195,8 +225,7 @@ This typically provides the highest level of security. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +235,9 @@ Accept wildcard characters: False ``` ### -MinPasswordLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The minimum allowed length (that is, the minimum number of digits) in a PIN number. For example, if MinPasswordLength is set to 8, then a PIN of 1259 will be rejected because that PIN only has 4 digits. PIN lengths must have at least 4 digits but no more than 24 digits; the default value is 5. @@ -213,8 +245,7 @@ PIN lengths must have at least 4 digits but no more than 24 digits; the default ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +255,9 @@ Accept wildcard characters: False ``` ### -PINHistoryCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often users are allowed to reuse the same PIN. For example, if the PINHistoryCount is set to 3, then the first three times users reset their PINs they must use a new PIN; on the fourth reset, they can reuse their first PIN. (And, on the fifth reset, they can use their second PIN, and so on.) The PIN history count can be any whole number between 0 and 20, inclusive; 0 means that users can use the same PIN over and over again. @@ -235,8 +269,7 @@ For example, you cannot set PINLifetime to 30 and leave PINHistoryCount at 0. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +279,9 @@ Accept wildcard characters: False ``` ### -PINLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the length of time (in days) that a PIN remains valid; after the PIN lifetime expires, users must select a new PIN before they will be allowed to use PIN authentication to gain access to the system. PINLifetime can be set to any whole number between 0 and 999, inclusive; 0 indicates that PINs never expire. By default, the PIN lifetime is set to 0 days. @@ -255,8 +291,7 @@ If you set the PINLifetime to a value greater than 0 then you must also set the ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -265,30 +300,23 @@ 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. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the PIN policy is being modified. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -298,13 +326,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -313,21 +343,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the PIN policy is being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -341,13 +366,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy + The `Set-CsPinPolicy` cmdlet accepts pipelined input of the PIN policy object. ## OUTPUTS -### +### None The `Set-CsPinPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy object. diff --git a/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/Set-CsPlatformServiceSettings.md similarity index 81% rename from skype/skype-ps/skype/Set-CsPlatformServiceSettings.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPlatformServiceSettings.md index 9bf4ba1881..dadeaa28b2 100644 --- a/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPlatformServiceSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPlatformServiceSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csplatformservicesettings +schema: 2.0.0 +title: Set-CsPlatformServiceSettings --- # Set-CsPlatformServiceSettings @@ -42,7 +43,7 @@ The `Set-CsPlatformServiceSettings` cmdlet gives you control to enable or disabl ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> Set-CsPlatformServiceSettings -EnableDelegateManagement $False -EnableExternalAccessCheck $True -EnableE911 $False -EnableFil eTransfer $True @@ -52,30 +53,16 @@ This example modifies some parameters for global platform service settings. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableCORS -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableCORS This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -85,13 +72,15 @@ Accept wildcard characters: False ``` ### -EnableDelegateManagement + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables the ability to manage delegates from the Skype for Business on Mac client. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -101,13 +90,15 @@ Accept wildcard characters: False ``` ### -EnableE911 + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows Skype for Business on Mac users to call 911. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -117,13 +108,15 @@ Accept wildcard characters: False ``` ### -EnableExternalAccessCheck -Enables administrators to use external access policies to block external access to Skype for Business on Mac users. + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to use external access policies to block external access to Skype for Business on Mac users. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -133,13 +126,15 @@ Accept wildcard characters: False ``` ### -EnableFileTransfer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables Skype for Business on Mac users send files in peer-to-peer chats. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -149,13 +144,15 @@ Accept wildcard characters: False ``` ### -EnablePushNotifications + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables Skype for Business on Mac clients to use push notifications. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -165,13 +162,15 @@ Accept wildcard characters: False ``` ### -EnableUcwaScopeCheck + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -181,13 +180,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before testing. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -197,13 +198,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the Platform Service Settings to be modified. ```yaml Type: XdsIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 1 @@ -213,13 +216,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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-CsPlatformServiceSettings cmdlet. ```yaml Type: PSObject Parameter Sets: Instance Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -229,13 +234,15 @@ Accept wildcard characters: False ``` ### -MaxRegistrationsPerPublicApplication + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -245,13 +252,33 @@ Accept wildcard characters: False ``` ### -UseLegacyPushNotifications + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean 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 +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -261,6 +288,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -268,7 +298,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -293,8 +322,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsPresenceManagementState.md b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceManagementState.md similarity index 83% rename from skype/skype-ps/skype/Set-CsPresenceManagementState.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPresenceManagementState.md index 863e995fa9..3dc2452544 100644 --- a/skype/skype-ps/skype/Set-CsPresenceManagementState.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceManagementState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspresencemanagementstate applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPresenceManagementState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspresencemanagementstate +schema: 2.0.0 +title: Set-CsPresenceManagementState --- # Set-CsPresenceManagementState @@ -33,7 +34,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPresenceManagementState -Fqdn "atl-mcs-001.litwareinc.com" -NotificationBatchSize 50 ``` @@ -43,30 +44,16 @@ This example set the NotificationBatchSize to 50 on the pool or computer named " ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force The Force parameter is not implemented for this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -76,6 +63,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the computer or pool to modify. The computer or pool should be referenced by using its fully qualified domain name (FQDN). For example: `-Fqdn "atl-mcs-001.litwareinc.com"`. @@ -84,8 +74,7 @@ If FQDN is not specified, the settings for the local machine will be modified. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -94,14 +83,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LimitedNotificationMode + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill LimitedNotificationMode Description}} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ManualOverride + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,16 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxPublishersPerBatch -Specifies a general guideline for the number of publishers that are collected before notifications are sent. -Reducing the MaxPublishersPerBatch value reduces database pressure at the expense of longer notification wait time after publishing. -Increasing this value reduces notification wait times during periods of high volume, but increases database and network traffic. +### -MaxHttpMessageSizeKb + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill MaxHttpMessageSizeKb Description}} ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,14 +137,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxRemotePublishersPerBatch -PARAMVALUE: UInt32 +### -MaxPublishersPerBatch + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies a general guideline for the number of publishers that are collected before notifications are sent. +Reducing the MaxPublishersPerBatch value reduces database pressure at the expense of longer notification wait time after publishing. +Increasing this value reduces notification wait times during periods of high volume, but increases database and network traffic. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,16 +157,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationBatchInterval -Specifies the time in seconds between notification batches. -Reducing the NotificationBatchInterval value increases database and network traffic but improves notification wait times. -Increasing the value increases notification wait times. +### -MaxRemotePublishersPerBatch + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: UInt32 ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,15 +175,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationBatchSize -Specifies the maximum number of messages to send in one batch notification. -This parameters should only be changed if messages are exceeding a maximum message size parameter in your organization. +### -MaxRemoteQueueThreadCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill MaxRemoteQueueThreadCount Description}} ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +193,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -NotificationBatchInterval + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the time in seconds between notification batches. +Reducing the NotificationBatchInterval value increases database and network traffic but improves notification wait times. +Increasing the value increases notification wait times. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,14 +213,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LimitedNotificationMode -{{Fill LimitedNotificationMode Description}} +### -NotificationBatchSize + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the maximum number of messages to send in one batch notification. +This parameters should only be changed if messages are exceeding a maximum message size parameter in your organization. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -211,14 +232,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxHttpMessageSizeKb -{{Fill MaxHttpMessageSizeKb Description}} +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -227,14 +250,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxRemoteQueueThreadCount -{{Fill MaxRemoteQueueThreadCount Description}} +### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -248,13 +273,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsPresencePolicy.md similarity index 87% rename from skype/skype-ps/skype/Set-CsPresencePolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPresencePolicy.md index b700f28738..966b5d3ce1 100644 --- a/skype/skype-ps/skype/Set-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPresencePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPresencePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspresencepolicy +schema: 2.0.0 +title: Set-CsPresencePolicy --- # Set-CsPresencePolicy @@ -57,7 +58,7 @@ Modifying a presence policy simply means changing the value of the MaxPromptedSu ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsPresencePolicy -Identity "RedmondPresencePolicy" -MaxPromptedSubscriber 300 ``` @@ -66,7 +67,7 @@ The command shown in Example 1 modifies the per-user presence policy RedmondPres In this example, the value of the MaxPromptedSubscriber property is set to 300. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPresencePolicy | Set-CsPresencePolicy -MaxPromptedSubscriber 300 ``` @@ -76,7 +77,7 @@ To do this, the command first calls the `Get-CsPresencePolicy` cmdlet without an This collection is then piped to the `Set-CsPresencePolicy` cmdlet, which changes the value of the MaxPromptedSubscriber for each policy in the collection to 300. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPresencePolicy | Where-Object {$_.MaxPromptedSubscriber -gt 300} | Set-CsPresencePolicy -MaxPromptedSubscriber 300 ``` @@ -90,7 +91,48 @@ As a result, no policy will allow more than 300 prompted subscribers, although s ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text to accompany a presence policy. +For example, the Description might include information about the users the policy should be assigned to. + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the presence policy to be modified. To modify the global policy, use this syntax: @@ -108,8 +150,7 @@ To modify a per-user policy, use syntax like this: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -119,13 +160,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +178,9 @@ Accept wildcard characters: False ``` ### -MaxCategorySubscription + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of category subscriptions allowed at any one time. A category subscription represents a request for a specific category of information; for example, an application that requests calendar data. @@ -143,8 +189,7 @@ MaxCategorySubscription can be set to any integer value between 0 and 3000; the ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +199,9 @@ Accept wildcard characters: False ``` ### -MaxPromptedSubscriber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of prompted subscribers a user can have at any one time. By default, any time you are added to another user's Contacts list a notification dialog is displayed informing you of this fact and giving you the chance to do such things as add the person to your own Contacts list or block the person from viewing your presence. Until you take action and dismiss the dialog box, each notification counts as a prompted subscriber. @@ -165,8 +213,7 @@ If you set this value to 0, users will not receive any notifications when they a ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,30 +222,23 @@ 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. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the presence policy is being modified. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,31 +248,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 -``` - -### -Description -Enables administrators to provide additional text to accompany a presence 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -241,21 +265,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the presence policy is being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -269,13 +288,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy + The `Set-CsPresencePolicy` cmdlet accepts pipelined input of the presence policy object. ## OUTPUTS -### +### None The `Set-CsPresencePolicy` cmdlet does not return any values or objects. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy object. diff --git a/skype/skype-ps/skype/Set-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceProvider.md similarity index 87% rename from skype/skype-ps/skype/Set-CsPresenceProvider.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPresenceProvider.md index 253ee70774..9b2a666796 100644 --- a/skype/skype-ps/skype/Set-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPresenceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspresenceprovider +schema: 2.0.0 +title: Set-CsPresenceProvider --- # Set-CsPresenceProvider @@ -42,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = Get-CsPresenceProvider -Identity "global/contoso.com" @@ -61,30 +62,16 @@ After the FQDN property has been configured, the `Set-CsPresenceProvider` cmdlet ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +81,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the presence provider to be modified. The Identity of a presence provider is composed of two parts: the scope (Parent) where the rule has been applied (for example, service:UserServer:atl-cs-001.litwareinc.com) and the provider Fqdn. To modify a presence provider at the global scope use syntax similar to this: @@ -103,8 +93,7 @@ To modify a presence provider at the global scope use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -114,13 +103,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,14 +120,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -150,13 +161,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated The `Set-CsPresenceProvider` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPresenceProvider` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPrivacyConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsPrivacyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPrivacyConfiguration.md index 2cca0f6368..9859e3fded 100644 --- a/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPrivacyConfiguration.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Set-CsPrivacyConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csprivacyconfiguration +schema: 2.0.0 +title: Set-CsPrivacyConfiguration --- # Set-CsPrivacyConfiguration @@ -53,7 +55,7 @@ The `Set-CsPrivacyConfiguration` cmdlet enables you to modify any of the privacy ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsPrivacyConfiguration -Identity site:Redmond -EnablePrivacyMode $False -AutoInitiateContacts $True -PublishLocationDataDefault $True -DisplayPublishedPhotoDefault $True ``` @@ -62,7 +64,7 @@ The command shown in Example 1 modifies three property values for the privacy co The three property values modified are AutoInitiateContacts, PublishLocationDataDefault and DisplayPublishedPhotoDefault. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPrivacyConfiguration | Set-CsPrivacyConfiguration -EnablePrivacyMode $True ``` @@ -72,7 +74,7 @@ To do this, the command first calls the `Get-CsPrivacyConfiguration` cmdlet with This collection is then piped to the `Set-CsPrivacyConfiguration` cmdlet, which takes each item in the collection and sets the EnablePrivacyMode property to True. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPrivacyConfiguration | Where-Object {$_.EnablePrivacyMode -eq $False} | Set-CsPrivacyConfiguration -AutoInitiateContacts $True -PublishLocationDataDefault $True -DisplayPublishedPhotoDefault $True ``` @@ -85,66 +87,62 @@ The filtered collection is then piped to the `Set-CsPrivacyConfiguration` cmdlet ## PARAMETERS -### -Identity -Unique identifier for the privacy configuration settings to be modified. -To modify the global settings, use this syntax: - -`-Identity global` - -To modify settings configured at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To modify settings at the service level, use syntax like this: +### -AutoInitiateContacts -`-Identity service:Redmond-UserServices-1` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that privacy settings can only be applied to the User Server service. -An error will occur if you try to apply these settings to any other service. - -If this parameter is not specified then the global settings will be updated when you call the `Set-CsPrivacyConfiguration` cmdlet. +If True, Skype for Business will automatically add your manager and your direct reports to your Contacts list. +The default value is True. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -DisplayPublishedPhotoDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, the user's photo will automatically be published in Skype for Business. +If False, the user's photo will not be available unless he or she explicitly selects the option Let others see my photo. +The default value is True. ```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 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoInitiateContacts -If True, Skype for Business will automatically add your manager and your direct reports to your Contacts list. -The default value is True. +### -EnablePrivacyMode +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, gives users the opportunity to enable the advanced privacy mode. +In advanced privacy mode, only people on your Contacts list will be allowed to view your presence information. +If False, your presence information will be available to anyone in your organization. +The default value is False. + +For information about privacy mode in Microsoft Teams, see [User presence in Teams](/microsoftteams/presence-admins). ```yaml Type: Boolean 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 +Aliases: Required: False Position: Named @@ -153,17 +151,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayPublishedPhotoDefault -If True, the user's photo will automatically be published in Skype for Business. -If False, the user's photo will not be available unless he or she explicitly selects the option Let others see my photo. -The default value is True. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +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 +Aliases: Required: False Position: Named @@ -172,55 +170,73 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePrivacyMode -If True, gives users the opportunity to enable the advanced privacy mode. -In advanced privacy mode, only people on your Contacts list will be allowed to view your presence information. -If False, your presence information will be available to anyone in your organization. -The default value is False. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the privacy configuration settings to be modified. +To modify the global settings, use this syntax: + +`-Identity global` + +To modify settings configured at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To modify settings at the service level, use syntax like this: + +`-Identity service:Redmond-UserServices-1` + +Note that privacy settings can only be applied to the User Server service. +An error will occur if you try to apply these settings to any other service. + +If this parameter is not specified then the global settings will be updated when you call the `Set-CsPrivacyConfiguration` cmdlet. -For information about privacy mode in Microsoft Teams, see [User presence in Teams](/microsoftteams/presence-admins). ```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 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PublishLocationDataDefault -If True, location data will automatically be published in Skype for Business. -If False, location data will not be available unless the user explicitly selects the option Show Contacts My Location. -The default value is True. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -PublishLocationDataDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, location data will automatically be published in Skype for Business. +If False, location data will not be available unless the user explicitly selects the option Show Contacts My Location. +The default value is True. ```yaml -Type: SwitchParameter +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 +Aliases: Required: False Position: Named @@ -229,15 +245,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -246,15 +264,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -268,13 +288,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration + The `Set-CsPrivacyConfiguration` cmdlet accepts pipelined input of the privacy configuration object. ## OUTPUTS -### +### None The `Set-CsPrivacyConfiguration` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsProxyConfiguration.md similarity index 82% rename from skype/skype-ps/skype/Set-CsProxyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsProxyConfiguration.md index 9d347a53bc..edb0aec77e 100644 --- a/skype/skype-ps/skype/Set-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsProxyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsProxyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csproxyconfiguration +schema: 2.0.0 +title: Set-CsProxyConfiguration --- # Set-CsProxyConfiguration @@ -62,7 +63,7 @@ The `Set-CsProxyConfiguration` cmdlet provides a way for you to modify the prope ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsProxyConfiguration -Identity service:EdgeServer:atl-edge-001.litwareinc.com -AcceptServerCompression $True ``` @@ -71,7 +72,7 @@ In Example 1, all the proxy configuration settings that have the Identity servic This is done by calling the `Set-CsProxyConfiguration` cmdlet and the AcceptServerCompression parameter, and by setting the parameter value to True. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsProxyConfiguration | Where-Object {$_.AcceptServerCompression -eq $True} | Set-CsProxyConfiguration -AcceptClientCompression $True ``` @@ -82,7 +83,7 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t The filtered collection is then piped to the `Set-CsProxyConfiguration` cmdlet, which takes each item in the collection and sets the AcceptClientCompression property to True. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsProxyConfiguration -Filter service:* | Set-CsProxyConfiguration -UseNtlmForClientToProxyAuth $False ``` @@ -94,56 +95,53 @@ The filtered collection is then piped to the `Set-CsProxyConfiguration` cmdlet, ## PARAMETERS -### -Identity -Unique identifier for the proxy server configuration settings to be modified. -To modify the global settings, use this syntax: - -`-Identity global` - -To modify settings configured at the service scope, use syntax similar to this: - -`-Identity "service: EdgeServer:atl-edge-001.litwareinc.com"` +### -AcceptClientCompression -If this parameter is not included, the `Set-CsProxyConfiguration` cmdlet will automatically modify the global settings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -AcceptServerCompression + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), the proxy server will accept all incoming compression requests from other servers. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptClientCompression -When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints. +### -AllowPartnerPollingSubscribes + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set the True, partner applications are allowed to periodically poll the service for state changes. +The default value is False ($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 +Aliases: Required: False Position: Named @@ -152,14 +150,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptServerCompression -When set to True (the default value), the proxy server will accept all incoming compression requests from other servers. +### -DisableNtlmFor2010AndLaterClients + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users logging on from Skype for Business must use the Kerberos protocol for authentication. +The default value is 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 +Aliases: Required: False Position: Named @@ -168,14 +170,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableWhiteSpaceKeepAlive -When set to True (the default value) the proxy server expects clients to periodically send a "whitespace message" (an empty message with no content) to indicate that the connection is still active. +### -DnsCacheRecordCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of records that can be maintained in the DNS record cache. +The default value is 3000. + ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,16 +190,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxClientCompressionCount -Indicates the maximum number of client-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. -The compression count can be set to any integer value between 0 and 65535, inclusive. -The default value is 15000. +### -EnableLoggingAllMessageBodies + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, Skype for Business Server will log the actual content of all instant messages. +For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files. + +The default value is False. + ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,16 +212,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxServerCompressionCount -Indicates the maximum number of server-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. -The server compression count can be set to any integer value between 0 and 65535, inclusive. -The default value is 1024. +### -EnableWhiteSpaceKeepAlive + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the proxy server expects clients to periodically send a "whitespace message" (an empty message with no content) to indicate that the connection is still active. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,15 +230,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Realm -Indicates whether or not security credentials are processed by the default proxy server realm (SIP Communication Services) or by a custom realm. -Custom realms must be specified (and created) by using the `New-CsSipProxyCustom` cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: IRealmChoice +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,47 +248,63 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestServerCompression -When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the proxy server configuration settings to be modified. +To modify the global settings, use this syntax: + +`-Identity global` + +To modify settings configured at the service scope, use syntax similar to this: + +`-Identity "service: EdgeServer:atl-edge-001.litwareinc.com"` + +If this parameter is not included, the `Set-CsProxyConfiguration` cmdlet will automatically modify the global settings. + ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TreatAllClientsAsRemote -When set to True, the proxy server functions as if all client connections are external connections that pass through the Edge Server. -The default value is False. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -UseCertificateForClientToProxyAuth -When set to True (the default value), client endpoints will be allowed to use certificates for authentication. +### -LoadBalanceEdgeServers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When True, software load balancing is employed for requests to Edge Servers. +The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -286,16 +313,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseKerberosForClientToProxyAuth -When set to True (the default value), client endpoints will be allowed to use the Kerberos protocol for authentication. -Although Kerberos is a more secure protocol than NTLM, it cannot be used if the client belongs to a different realm than the server. +### -LoadBalanceInternalServers +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When True, software load balancing is employed for requests to Registrars and other internal servers. +The default value is true ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -304,16 +332,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNtlmForClientToProxyAuth -When set to True (the default value), client endpoints will be allowed to use the NTLM protocol for authentication. -Although NTLM is a less secure protocol than Kerberos, NTLM can be used if the client belongs to a different domain than the server. -That is not the case with Kerberos authentication. +### -MaxClientCompressionCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of client-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. +The compression count can be set to any integer value between 0 and 65535, inclusive. +The default value is 15000. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -322,14 +352,18 @@ 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. +### -MaxClientMessageBodySizeKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. +The default value is 128, meaning that messages with a body size larger than 128 KB will be rejected. +The client message body size can be set to any integer value between 64 and 256, inclusive. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -338,14 +372,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxKeepAliveInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in minutes) that can elapse before the server verifies that the connection with the client is still valid. +The default value is 20 minutes. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -354,14 +391,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxServerCompressionCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of server-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. +The server compression count can be set to any integer value between 0 and 65535, inclusive. +The default value is 1024. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -370,16 +411,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableNtlmFor2010AndLaterClients -When set to True, users logging on from Skype for Business must use the Kerberos protocol for authentication. -The default value is False. +### -MaxServerMessageBodySizeKb +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum-allowed size (in kilobytes) for the body of a message sent from another server. +The default value is 5000, meaning that messages with a body size larger than 5000 KB will be rejected. +The server message body size can be set to any integer value between 1000 and 20000, inclusive. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,16 +431,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DnsCacheRecordCount -Maximum number of records that can be maintained in the DNS record cache. -The default value is 3000. +### -OutgoingTlsCount +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each internal server. +The minimum number of TLS connections is 1, and the maximum number is 4. +By default, OutgoingTlsCount is set to 4. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -406,16 +451,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxClientMessageBodySizeKb -The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. -The default value is 128, meaning that messages with a body size larger than 128 KB will be rejected. -The client message body size can be set to any integer value between 64 and 256, inclusive. +### -Realm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not security credentials are processed by the default proxy server realm (SIP Communication Services) or by a custom realm. +Custom realms must be specified (and created) by using the `New-CsSipProxyCustom` cmdlet. ```yaml -Type: UInt32 +Type: IRealmChoice Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -424,16 +470,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxServerMessageBodySizeKb -The maximum-allowed size (in kilobytes) for the body of a message sent from another server. -The default value is 5000, meaning that messages with a body size larger than 5000 KB will be rejected. -The server message body size can be set to any integer value between 1000 and 20000, inclusive. +### -RequestServerCompression + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -442,16 +488,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutgoingTlsCount -Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each internal server. -The minimum number of TLS connections is 1, and the maximum number is 4. -By default, OutgoingTlsCount is set to 4. +### -SpecialConfigurationList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -460,15 +506,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPartnerPollingSubscribes -When set the True, partner applications are allowed to periodically poll the service for state changes. -The default value is False ($False). +### -TestFeatureList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used by Skype for Business Server. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -477,18 +524,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLoggingAllMessageBodies -When set to True, Skype for Business Server will log the actual content of all instant messages. -For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files. +### -TestParameterList -The default value is False. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +This parameter is not currently used by Skype for Business Server. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -497,15 +542,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoadBalanceEdgeServers -When True, software load balancing is employed for requests to Edge Servers. -The default value is True ($True). +### -TreatAllClientsAsRemote + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the proxy server functions as if all client connections are external connections that pass through the Edge Server. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -514,15 +561,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoadBalanceInternalServers -When True, software load balancing is employed for requests to Registrars and other internal servers. -The default value is true ($True). +### -UseCertificateForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use certificates for authentication. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -531,15 +579,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxKeepAliveInterval -Specifies the amount of time (in minutes) that can elapse before the server verifies that the connection with the client is still valid. -The default value is 20 minutes. +### -UseKerberosForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use the Kerberos protocol for authentication. +Although Kerberos is a more secure protocol than NTLM, it cannot be used if the client belongs to a different realm than the server. + ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -548,14 +599,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpecialConfigurationList -PARAMVALUE: String +### -UseNtlmForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use the NTLM protocol for authentication. +Although NTLM is a less secure protocol than Kerberos, NTLM can be used if the client belongs to a different domain than the server. +That is not the case with Kerberos authentication. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -564,14 +619,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TestFeatureList -This parameter is not currently used by Skype for Business Server. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -580,14 +637,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TestParameterList -This parameter is not currently used by Skype for Business Server. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -601,13 +660,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings + The `Set-CsProxyConfiguration` cmdlet accepts pipelined instances of the proxy settings object. ## OUTPUTS -### +### None The `Set-CsProxyConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object. diff --git a/skype/skype-ps/skype/Set-CsPstnGateway.md b/skype/skype-ps/SkypeForBusiness/Set-CsPstnGateway.md similarity index 84% rename from skype/skype-ps/skype/Set-CsPstnGateway.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPstnGateway.md index 652c120b20..c8c22b814b 100644 --- a/skype/skype-ps/skype/Set-CsPstnGateway.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPstnGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspstngateway applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPstnGateway -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspstngateway +schema: 2.0.0 +title: Set-CsPstnGateway --- # Set-CsPstnGateway @@ -39,7 +40,7 @@ After your PSTN gateways have been installed and configured, they can be managed ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsPstnGateway -Identity "PstnGateway:192.168.0.240" -Default $True ``` @@ -48,7 +49,7 @@ The command shown in Example 1 configures the gateway PstnGateway:192.168.0.240 That means that PstnGateway:192.168.0.240 can be used to handle calls originating from Office Communications Server 2007 R2. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -PstnGateway | ForEach-Object {Set-CsPstnGateway -Identity $_.Identity -Routable $True} ``` @@ -61,40 +62,61 @@ The `ForEach-Object` cmdlet runs the `Set-CsPstnGateway` cmdlet against each gat ## PARAMETERS -### -Identity -Service identity of the PSTN gateway to be modified. -For example: +### -AlternateByPassId -`-Identity "PstnGateway:192.168.0.240"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you can leave off the prefix "PstnGatewayServer:" when specifying a PSTN gateway. -For example: +Globally unique identifier (GUID) representing the alternate bypass ID. +This ID is automatically generated by Skype for Business Server and is used to help eliminate hairpin calls. +Depending on the way you have configured your system, this allows hairpin calls to automatically bypass the Mediation Server without you having to define and associate individual subnets with all your sites and regions. -`-Identity "atl-cs-001.litwareinc.com"` +To do this, you typically need to globally enable bypass to use network configuration sites and regions, then enable bypass on the trunk configuration for your PSTN gateway. + +A hairpin call occurs when an inbound call from the PSTN network is routed back to that network through call forwarding or simultaneous ringing. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Default + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, this gateway will handle calls sent from Office Communications Server 2007 R2. There can only be one default gateway in the collection of gateways managed by a single Mediation Server. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -104,14 +126,16 @@ Accept wildcard characters: False ``` ### -GatewaySipClientTcpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port used for communicating with Mediation Servers by using Transmission Control Protocol (TCP). The default value is 5066. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,14 +145,16 @@ Accept wildcard characters: False ``` ### -GatewaySipClientTlsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port used for communicating with Mediation Servers by using the Transport Layer Security (TLS) protocol. The default value is 5067. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,7 +163,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service identity of the PSTN gateway to be modified. +For example: + +`-Identity "PstnGateway:192.168.0.240"` + +Note that you can leave off the prefix "PstnGatewayServer:" when specifying a PSTN gateway. +For example: + +`-Identity "atl-cs-001.litwareinc.com"` + + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MediationServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service identity of the Mediation Server to be associated with the PSTN gateway. For example: @@ -147,8 +203,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +213,9 @@ Accept wildcard characters: False ``` ### -RepresentativeMediaIP + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + IP address of the media processor associated with the gateway, provided that the processor location is different from the signaling address. Both media bypass and call admission control (CAC) are based on the location of the gateway's media processor; by default, this is the same location as the signaling address. If the two locations differ (for example, with the media processor in a remote site and the signaling peer in the central site) then RepresentativeMediaIP must be configured with the IP address of the media processor. @@ -167,8 +225,7 @@ If you have deployed multiple media processors in the same site, each with its o ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,13 +235,15 @@ Accept wildcard characters: False ``` ### -Routable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, the gateway can be used in outbound routing routes. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,30 +252,16 @@ 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 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 @@ -225,38 +270,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AlternateByPassId -Globally unique identifier (GUID) representing the alternate bypass ID. -This ID is automatically generated by Skype for Business Server and is used to help eliminate hairpin calls. -Depending on the way you have configured your system, this allows hairpin calls to automatically bypass the Mediation Server without you having to define and associate individual subnets with all your sites and regions. - -To do this, you typically need to globally enable bypass to use network configuration sites and regions, then enable bypass on the trunk configuration for your PSTN gateway. - -A hairpin call occurs when an inbound call from the PSTN network is routed back to that network through call forwarding or simultaneous ringing. - - -```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 -``` +### -WhatIf -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -270,13 +293,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Get-CsPstnGateway` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsPstnGateway` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayPstnGateway object. diff --git a/skype/skype-ps/skype/Set-CsPstnUsage.md b/skype/skype-ps/SkypeForBusiness/Set-CsPstnUsage.md similarity index 80% rename from skype/skype-ps/skype/Set-CsPstnUsage.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPstnUsage.md index d588c47094..63684359dc 100644 --- a/skype/skype-ps/skype/Set-CsPstnUsage.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPstnUsage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspstnusage applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPstnUsage -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspstnusage +schema: 2.0.0 +title: Set-CsPstnUsage --- # Set-CsPstnUsage @@ -41,7 +42,7 @@ This list is global so it can be used by policies and routes throughout the Skyp ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPstnUsage -Identity global -Usage @{add="International"} ``` @@ -49,7 +50,7 @@ Set-CsPstnUsage -Identity global -Usage @{add="International"} This command adds the string "International" to the current list of available PSTN usages. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsPstnUsage -Identity global -Usage @{remove="Local"} ``` @@ -57,7 +58,7 @@ Set-CsPstnUsage -Identity global -Usage @{remove="Local"} This command removes the string "Local" from the list of available PSTN usages. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsPstnUsage -Usage @{remove="Local"} ``` @@ -67,7 +68,7 @@ This example shows the command without the Identity parameter specified. The only Identity available to the `Set-CsPstnUsage` cmdlet is the Global identity; omitting the Identity parameter defaults to Global. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsPstnUsage -Usage @{replace="International","Restricted"} ``` @@ -78,15 +79,35 @@ All previously existing usages are removed. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The scope at which these settings are applied. The Identity for this cmdlet is always Global. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -96,6 +117,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to a PSTN usage object. This object must be of type PstnUsages and can be retrieved by calling the `Get-CsPstnUsage` cmdlet. @@ -103,8 +127,7 @@ This object must be of type PstnUsages and can be retrieved by calling the `Get- ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,14 +137,16 @@ Accept wildcard characters: False ``` ### -Usage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Contains a list of allowable usage strings. These entries can be any string value. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,14 +155,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -147,29 +174,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -183,13 +196,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnUsages object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnUsages + Accepts pipelined input of PSTN usage objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnUsages object. diff --git a/skype/skype-ps/skype/Set-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsPublicProvider.md similarity index 88% rename from skype/skype-ps/skype/Set-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPublicProvider.md index 4895b36792..6828b262e5 100644 --- a/skype/skype-ps/skype/Set-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspublicprovider +schema: 2.0.0 +title: Set-CsPublicProvider --- # Set-CsPublicProvider @@ -48,7 +49,7 @@ After federated relationships have been established, you can then use the `Set-C ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsPublicProvider -Identity "Skype" -VerificationLevel "AlwaysVerifiable" ``` @@ -57,7 +58,7 @@ Example 1 sets the VerificationLevel for the public provider with the Identity S This is done by including the VerificationLevel parameter and the parameter value AlwaysVerifiable. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPublicProvider | Set-CsPublicProvider -VerificationLevel "AlwaysVerifiable" ``` @@ -67,7 +68,7 @@ To do this, the command first calls the `Get-CsPublicProvider` cmdlet without an This collection is then piped to the `Set-CsPublicProvider` cmdlet, which takes each provider in the collection and changes the value of the VerificationLevel property to AlwaysVerifiable. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPublicProvider | Where-Object {$_.VerificationLevel -eq "AlwaysUnverifiable"} | Set-CsPublicProvider -VerificationLevel "AlwaysVerifiable" ``` @@ -80,7 +81,49 @@ In turn, this filtered collection is piped to the `Set-CsPublicProvider` cmdlet, ## PARAMETERS +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the federation relationship between your organization and the public provider is active. +If set to True, users in your organization will be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. +If set to False, users in your organization will not be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the public provider to be modified. The Identity is typically the name of the website providing the services. @@ -88,8 +131,7 @@ The Identity is typically the name of the website providing the services. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -99,13 +141,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,25 +158,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Enabled -Indicates whether or not the federation relationship between your organization and the public provider is active. -If set to True, users in your organization will be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. -If set to False, users in your organization will not be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -VerificationLevel -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -VerificationLevel Indicates how (or if) messages sent from a public provider are verified to ensure that they were sent from that provider. The VerificationLevel must be set to one of the following values: @@ -157,8 +186,7 @@ This value has been deprecated for use in Skype for Business Server. ```yaml Type: VerificationLevelType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,30 +195,16 @@ 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 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 @@ -199,15 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -221,13 +236,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider + The `Set-CsPublicProvider` cmdlet accepts pipelined instances of the public provider object. ## OUTPUTS -### +### None The `Set-CsPublicProvider` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. diff --git a/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPushNotificationConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPushNotificationConfiguration.md index 7a86381463..3225199143 100644 --- a/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPushNotificationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPushNotificationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration +schema: 2.0.0 +title: Set-CsPushNotificationConfiguration --- # Set-CsPushNotificationConfiguration @@ -56,7 +58,7 @@ For example, you could enable push notifications to Windows Phone users (by sett ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPushNotificationConfiguration -Identity "site:Redmond" -EnableApplePushNotificationService $False ``` @@ -64,7 +66,7 @@ Set-CsPushNotificationConfiguration -Identity "site:Redmond" -EnableApplePushNot The command shown in Example 1 disables push notifications from the Apple Push Notification Service for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPushNotificationConfiguration -Filter "site:*" | Set-CsPushNotificationConfiguration -EnableApplePushNotificationService $False ``` @@ -74,7 +76,7 @@ To do this, the command first uses the `Get-CsPushNotificationConfiguration` cmd That collection of settings is then piped to the `Set-CsPushNotificationConfiguration` cmdlet, which takes each item in the collection and sets the EnableApplePushNotificationService property to False. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPushNotificationConfiguration | Where-Object {$_.EnableMicrosoftPushNotificationService -eq $False} | Set-CsPushNotificationConfiguration -EnableApplePushNotificationService $False ``` @@ -87,24 +89,10 @@ That filtered collection is then piped to the `Set-CsPushNotificationConfigurati ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableApplePushNotificationService -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableApplePushNotificationService When set to True, iPhone users will receive push notifications from the Apple Push Notification Service. When set to False, iPhone users will not receive these notifications. @@ -114,8 +102,7 @@ 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 +Aliases: Required: False Position: Named @@ -125,6 +112,9 @@ Accept wildcard characters: False ``` ### -EnableMicrosoftPushNotificationService + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Windows Phone users will receive push notifications from the Microsoft Push Notification Service. When set to False, Windows Phone users will not receive these notifications. @@ -134,8 +124,7 @@ 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 +Aliases: Required: False Position: Named @@ -145,14 +134,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +153,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the push notification configuration settings to be modified. To refer to the global settings, use this syntax: @@ -177,8 +171,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -188,13 +181,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +199,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for the push notification settings being modified. For example: @@ -221,8 +219,26 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -232,6 +248,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -239,7 +258,6 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -253,14 +271,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration. +### Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration The `Set-CsPushNotificationConfiguration` cmdlet accepts pipelined instances of the PushNotificationConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPushNotificationConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsQoEConfiguration.md similarity index 81% rename from skype/skype-ps/skype/Set-CsQoEConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsQoEConfiguration.md index 257965025e..bfc0b02681 100644 --- a/skype/skype-ps/skype/Set-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsQoEConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsQoEConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csqoeconfiguration +schema: 2.0.0 +title: Set-CsQoEConfiguration --- # Set-CsQoEConfiguration @@ -45,7 +46,7 @@ QoE is part of the Monitoring Server role; therefore Monitoring Server must be d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsQoEConfiguration -Identity site:Redmond -EnableQoE $False ``` @@ -54,7 +55,7 @@ The command in Example 1 uses the `Set-CsQoEConfiguration` cmdlet to modify the The new settings turn off QoE by setting the EnableQoE parameter to False. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsQoEConfiguration -Identity site:Dublin -KeepQoEDataForDays 45 -PurgeHourOfDay 4 ``` @@ -68,50 +69,16 @@ Note: If you have enabled QoE and call detail recording (CDR), for performance r ## PARAMETERS -### -Identity -The unique identifier of the settings you want to modify. -Possible values are global and site:\, where \ is the name of the site in your Skype for Business Server deployment to which you want to apply the changes. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -An object reference to a QoE configuration object. -This object must be of type QoESettings and can be retrieved by calling the `Get-CsQoEConfiguration` cmdlet. - - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableExternalConsumer -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableExternalConsumer Specifies whether an external consumer is able to receive QoE reports. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,13 +88,15 @@ Accept wildcard characters: False ``` ### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether records will be purged after the duration defined in the KeepQoEDataForDays property has elapsed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +106,9 @@ Accept wildcard characters: False ``` ### -EnableQoE + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether QoE records will be collected and saved to the monitoring database. Note that even if EnableQoE is set to True, QoE data will not be collected unless a Monitoring Server has been deployed and associated with a Registrar pool. @@ -144,8 +116,7 @@ Note that even if EnableQoE is set to True, QoE data will not be collected unles ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,13 +126,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerIssuedCertId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The certificate ID of the certificate that allows access to the external consumer web service. ```yaml Type: IssuedCertId Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,13 +144,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The friendly name of the external consumer of the QoE report. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,13 +162,33 @@ Accept wildcard characters: False ``` ### -ExternalConsumerURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The URL of the external consumer to which the QoE reports will be posted. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -202,7 +197,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the settings you want to modify. +Possible values are global and site:\, where \ is the name of the site in your Skype for Business Server deployment to which you want to apply the changes. + + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An object reference to a QoE configuration object. +This object must be of type QoESettings and can be retrieved by calling the `Get-CsQoEConfiguration` cmdlet. + + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -KeepQoEDataForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of days QoE data will be stored before being purged from the database. This value is ignored if EnablePurging is set to False. @@ -211,8 +249,7 @@ Must be a value from 1 through 2562. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,6 +259,9 @@ Accept wildcard characters: False ``` ### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The hour of the day that QoE records that have exceeded the number of days specified in the KeepQoEDataForDays property will be purged. Must be a value 0 through 23, representing the hour of the day. @@ -230,8 +270,7 @@ For example, 0 would be midnight, 13 would be 1:00 PM. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,14 +279,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -257,29 +298,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -293,13 +320,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings + Accepts pipelined input of QoE configuration objects. ## OUTPUTS -### +### None The `Set-CsQoEConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object. diff --git a/skype/skype-ps/skype/Set-CsRegistrar.md b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrar.md similarity index 81% rename from skype/skype-ps/skype/Set-CsRegistrar.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRegistrar.md index b304b0a075..729724b507 100644 --- a/skype/skype-ps/skype/Set-CsRegistrar.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrar.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csregistrar applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRegistrar -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csregistrar +schema: 2.0.0 +title: Set-CsRegistrar --- # Set-CsRegistrar @@ -45,7 +46,7 @@ These modifications include changing port settings as well as specifying the act ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsRegistrar -Identity "Registrar:atl-cs-001.litwareinc.com" -SipPort 5072 ``` @@ -53,7 +54,7 @@ Set-CsRegistrar -Identity "Registrar:atl-cs-001.litwareinc.com" -SipPort 5072 The command shown in Example 1 sets the SIP port for the Registrar Registrar:atl-cs-001.litwareinc.com to 5072. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsService -Registrar | ForEach-Object {Set-CsRegistrar -Identity $_.Identity -SipPort 5072} ``` @@ -63,7 +64,7 @@ To do this, the command first uses the `Get-CsService` cmdlet and the Registrar This collection is then piped to the `ForEach-Object` cmdlet, which takes each Registrar in the collection and runs the `Set-CsRegistrar` cmdlet in order to change the SIP port to 5072. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsRegistrar -Identity "Registrar:atl-cs-001.litwareinc.com" -BackupRegistrar "Registrar:dublin-cs-001.litwareinc.com" -EnableAutomaticFailover $True ``` @@ -73,32 +74,28 @@ Example 3 configures both a backup Registrar (BackupRegistrar) and automatic fai ## PARAMETERS -### -Identity -Service location of the Registrar to be modified. -For example: - -`-Identity "Registrar:atl-cs-001.litwareinc.com"` - -Note that you can leave off the prefix "Registrar:" when specifying a Registrar. -For example: +### -ArchivingDatabase -`-Identity "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service Identity of the database used by the Archiving service. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ArchivingServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Archiving Server to be associated with the Registrar. For example: @@ -108,8 +105,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +115,9 @@ Accept wildcard characters: False ``` ### -BackupRegistrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Registrar to be used if this Registrar is not available. For example: @@ -128,8 +127,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +137,9 @@ Accept wildcard characters: False ``` ### -EdgeServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Edge Server to be associated with the Registrar. For example: @@ -148,8 +149,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +159,9 @@ Accept wildcard characters: False ``` ### -EnableAutomaticFailover + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, the backup Registrar will be employed any time the primary Registrar is unavailable. If False, the backup Registrar will not be used if the primary Registrar is not available. @@ -168,8 +171,7 @@ If this parameter is set to True, then those users will be dropped from the back ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +181,9 @@ Accept wildcard characters: False ``` ### -FailbackDetectionInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time that the system will wait before checking to see if a Registrar that had become unavailable is now available. If you have set EnableAutomaticFailover to True, the system will "failover" to the backup Registrar any time a Registrar becomes unavailable. That simply means that the system will take users who are logged-on to the failed Registrar and attempt to log them on to the backup Registrar. @@ -201,8 +206,7 @@ This parameter cannot be used unless you have specified a backup Registrar. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,6 +216,9 @@ Accept wildcard characters: False ``` ### -FailureDetectionInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the time interval that the system will wait before deciding that a Registrar is unavailable. If EnableAutomaticFailover has been set to True, the system will then attempt to log users on to the backup Registrar instead. @@ -226,8 +233,7 @@ This parameter cannot be used unless you have specified a backup Registrar. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,18 +242,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringServer -Service location of the Monitoring Server to be associated with the Registrar. -For example: +### -Force -`-MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -256,50 +260,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipPort -Port used for SIP (Session Initiation Protocol) traffic. +### -Identity -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Service location of the Registrar to be modified. +For example: -### -UserServer -Service location of the User Services server to be associated with the Registrar. +`-Identity "Registrar:atl-cs-001.litwareinc.com"` + +Note that you can leave off the prefix "Registrar:" when specifying a Registrar. For example: -`-UserServer "UserServer:atl-cs-001.litwareinc.com"` +`-Identity "atl-cs-001.litwareinc.com"` ```yaml -Type: String +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WebPort -Port used for communicating with Web servers. +### -LyssWcfMtlsPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used by the Lync Storage Service (LYSS). +The default value is 5077. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,18 +306,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebServer -Service location of the Web Server to be associated with the Registrar. -For example: +### -MirrorArchivingDatabase -`-WebServer "WebServer:atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service Identity of the mirror database used by the Archiving service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -328,14 +324,16 @@ 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. +### -MirrorMonitoringDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service Identity of the mirror database used by the Monitoring service. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -344,14 +342,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MonitoringDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service Identity of the monitoring database associated with the Registrar. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -360,14 +360,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MonitoringServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Monitoring Server to be associated with the Registrar. +For example: + +`-MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com"` + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -377,14 +383,16 @@ Accept wildcard characters: False ``` ### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Registrar. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -394,14 +402,16 @@ Accept wildcard characters: False ``` ### -SipHealthPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for monitoring server health. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -410,16 +420,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipServerTcpPort -SIP listening port. -The default value is 5060. +### -SipPort +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for SIP (Session Initiation Protocol) traffic. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -428,31 +438,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ArchivingDatabase -Service Identity of the database used by the Archiving service. +### -SipServerTcpPort -```yaml -Type: String -Parameter Sets: (All) -Aliases: -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +SIP listening port. +The default value is 5060. -### -LyssWcfMtlsPort -Port used by the Lync Storage Service (LYSS). -The default value is 5077. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -461,14 +458,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MirrorArchivingDatabase -Service Identity of the mirror database used by the Archiving service. +### -UserServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the User Services server to be associated with the Registrar. +For example: + +`-UserServer "UserServer:atl-cs-001.litwareinc.com"` + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -477,14 +480,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MirrorMonitoringDatabase -Service Identity of the mirror database used by the Monitoring service. +### -WebPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for communicating with Web servers. ```yaml -Type: String +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -493,14 +498,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringDatabase -Service Identity of the monitoring database associated with the Registrar. +### -WebServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Web Server to be associated with the Registrar. +For example: + +`-WebServer "WebServer:atl-cs-001.litwareinc.com"` + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -510,14 +521,16 @@ Accept wildcard characters: False ``` ### -WinFabClientConnectionPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for client connections to Windows Fabric. The default value is 5092. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -527,6 +540,9 @@ Accept wildcard characters: False ``` ### -WinFabFederationPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for Windows Fabric federation. Federation refers to the process by which Windows fabric routes messages. The default value is 5090. @@ -534,8 +550,7 @@ The default value is 5090. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -545,6 +560,9 @@ Accept wildcard characters: False ``` ### -WinFabIPCPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used by Windows Fabric for inter-process communication (IPC). IPC is a technology that allows for multiple threads in a process to exchange data. The default value is 5093. @@ -552,8 +570,7 @@ The default value is 5093. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -563,6 +580,9 @@ Accept wildcard characters: False ``` ### -WinFabLeaseAgentPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used by the Windows Fabric lease agent. Lease agents are used to interact with the kernel level lease driver. The default value is 5091. @@ -570,8 +590,7 @@ The default value is 5091. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -581,6 +600,9 @@ Accept wildcard characters: False ``` ### -WinFabReplicationPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for Windows Fabric replication. Skype for Business Server uses Windows Fabric to replicate conference directories to all the Front End servers within a Registrar pool. The default value is 5094. @@ -589,8 +611,7 @@ The default value is 5094. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -600,6 +621,9 @@ Accept wildcard characters: False ``` ### -XmppGatewaySipPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used by the XMPP gateway associated with the Registrar. The extensible Messaging and Presence Protocol (XMPP) is an open-standard communications protocol for exchanging messages using XML. An allowed partner is an IM and presence provider whose users are allowed to exchange instant messages and presence information with your Skype for Business Server users. @@ -609,8 +633,43 @@ The default value is 5098. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -624,13 +683,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsRegistrar` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsRegistrar` cmdlet does not return any objects or values. Instead, the command modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayRegistrar object. diff --git a/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrarConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsRegistrarConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRegistrarConfiguration.md index 42491be2c9..5809c4d24c 100644 --- a/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrarConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRegistrarConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csregistrarconfiguration +schema: 2.0.0 +title: Set-CsRegistrarConfiguration --- # Set-CsRegistrarConfiguration @@ -51,7 +52,7 @@ Registrar configuration settings are used to help manage endpoints and endpoint ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsRegistrarConfiguration -Identity site:Redmond -EnableDHCPServer $True ``` @@ -60,7 +61,7 @@ Example 1 modifies the Registrar configuration settings applied to the Redmond s In this example, the value of the EnableDHCPServer property is set to True. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRegistrarConfiguration | Where-Object {$_.MaxEndpointsPerUser -gt 8} | Set-CsRegistrarConfiguration -MaxEndpointsPerUser 8 ``` @@ -71,7 +72,7 @@ This collection is then piped to the `Where-Object` cmdlet, which picks out only Finally, the filtered collection is piped to the `Set-CsRegistrarConfiguration` cmdlet, which sets the maximum number of endpoints for each item in that collection to 8. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRegistrarConfiguration -Filter "site:*"| Set-CsRegistrarConfiguration -EnableDHCPServer $False ``` @@ -83,54 +84,29 @@ This collection is then piped to the `Set-CsRegistrarConfiguration` cmdlet, whic ## PARAMETERS -### -Identity -Unique identifier for the Registrar configuration settings to be modified. -To modify the global settings, use this syntax: - -`-Identity global` - -To modify settings configured at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To modify settings at the service level, use syntax like this: - -`-Identity service:Registrar:atl-cs-001.litwareinc.com` +### -BackupStoreUnavailableThreshold -Note that Registrar settings can only be applied to the Registrar service. -An error message will occur if you try to apply these settings to any other service. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the amount of time the system will wait before determining that the backup store is unavailable; at that point, users will be placed in survivability mode. +The default value is 30 minutes (00:30:00). ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: TimeSpan +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DefaultEndpointExpiration -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DefaultEndpointExpiration When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. The DefaultEndpointExpiration property represents the expiration timeout interval for clients that do not request a specific timeout value. @@ -140,8 +116,7 @@ The default value is 600 (10 minutes). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,14 +126,16 @@ Accept wildcard characters: False ``` ### -EnableDHCPServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether endpoints can use DHCP servers to locate a Registrar. If True, clients will send a DHCP Inform message when they first start; the DHCP server will respond by sending the fully qualified domain name (FQDN) of a Registrar that can be used to log on the user. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,19 +144,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEndpointExpiration -When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. -The MaxEndpointExpiration property represents the maximum amount of time that clients can be granted. -For example, if the maximum time is set to 600 seconds and a client requests a timeout interval of 800 seconds, the client will be given the maximum allowed expiration period: 600 seconds. +### -EnableWinFabLogUpload -The MaxEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). -The default value is 900. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,25 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEndpointsPerUser -Indicates the maximum number of endpoints a user can simultaneously have connected to the system. -For example, a user who is logged on to Skype for Business Server with both a computer and a mobile phone would be using two endpoints. -MaxEndPointsPerUser must be set to a value between 1 and 64, inclusive. -The default value is 8. - -Although it is possible to allow a user as many as 64 endpoints, it is recommended that the maximum number of endpoints not exceed 8. -Values of 9 or more are used for backwards compatibility and, in rare cases, when suggested by Microsoft support personnel. -For new deployments, the maximum number of endpoints should be no more than 8. +### -Force -Note, too, that the maximum number of endpoints is intended to give individual users multiple points of presence. -As such, this setting is designed for individual users and not for groups of users (such as an entire department.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,51 +180,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinEndpointExpiration -When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. -The MinEndpointExpiration property represents the minimum amount of time that clients can be granted. -For example, if the minimum time is set to 600 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 600 seconds. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the Registrar configuration settings to be modified. +To modify the global settings, use this syntax: + +`-Identity global` + +To modify settings configured at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To modify settings at the service level, use syntax like this: + +`-Identity service:Registrar:atl-cs-001.litwareinc.com` + +Note that Registrar settings can only be applied to the Registrar service. +An error message will occur if you try to apply these settings to any other service. -The MinEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). -The default value is 300. ```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxEndpointExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. +The MaxEndpointExpiration property represents the maximum amount of time that clients can be granted. +For example, if the maximum time is set to 600 seconds and a client requests a timeout interval of 800 seconds, the client will be given the maximum allowed expiration period: 600 seconds. + +The MaxEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). +The default value is 900. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,14 +254,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxEndpointsPerUser + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of endpoints a user can simultaneously have connected to the system. +For example, a user who is logged on to Skype for Business Server with both a computer and a mobile phone would be using two endpoints. +MaxEndPointsPerUser must be set to a value between 1 and 64, inclusive. +The default value is 8. + +Although it is possible to allow a user as many as 64 endpoints, it is recommended that the maximum number of endpoints not exceed 8. +Values of 9 or more are used for backwards compatibility and, in rare cases, when suggested by Microsoft support personnel. +For new deployments, the maximum number of endpoints should be no more than 8. + +Note, too, that the maximum number of endpoints is intended to give individual users multiple points of presence. +As such, this setting is designed for individual users and not for groups of users (such as an entire department.) + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,15 +283,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupStoreUnavailableThreshold -Specifies the amount of time the system will wait before determining that the backup store is unavailable; at that point, users will be placed in survivability mode. -The default value is 30 minutes (00:30:00). +### -MaxUserCount + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of users that can simultaneously be logged on to a Registrar. +MaxUserCount can be set to any integer value between 2000 and 100000, inclusive. +The default value is 12000. + ```yaml -Type: TimeSpan +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -301,17 +304,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxUserCount -Indicates the maximum number of users that can simultaneously be logged on to a Registrar. -MaxUserCount can be set to any integer value between 2000 and 100000, inclusive. -The default value is 12000. +### -MinEndpointExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. +The MinEndpointExpiration property represents the minimum amount of time that clients can be granted. +For example, if the minimum time is set to 600 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 600 seconds. + +The MinEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). +The default value is 300. ```yaml -Type: UInt64 +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -321,6 +328,9 @@ Accept wildcard characters: False ``` ### -PoolState + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Current state for the Registrar pool. Allowed values are: @@ -334,8 +344,7 @@ The default value is Active. ```yaml Type: PoolState Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -344,14 +353,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableWinFabLogUpload -PARAMVALUE: $true | $false +### -UserCertificateReplicationThreshold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: UInt64 ```yaml -Type: Boolean +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -360,14 +371,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCertificateReplicationThreshold -PARAMVALUE: UInt64 +### -WinFabMaxLogsSizeMb + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: Int32 ```yaml -Type: UInt64 +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -376,14 +389,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WinFabMaxLogsSizeMb -PARAMVALUE: Int32 +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -397,13 +430,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings + The `Set-CsRegistrarConfiguration` cmdlet accepts pipelined instances of the Registrar settings object. ## OUTPUTS -### +### None The `Set-CsRegistrarConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. diff --git a/skype/skype-ps/skype/Set-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsReportingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsReportingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsReportingConfiguration.md index 9e96050de2..043e6a10d7 100644 --- a/skype/skype-ps/skype/Set-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsReportingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsReportingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csreportingconfiguration +schema: 2.0.0 +title: Set-CsReportingConfiguration --- # Set-CsReportingConfiguration @@ -53,7 +54,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-002.litwareinc.com" -ReportingURL "https://atl-sql-002.litwareinc.com/lync_reports" ``` @@ -64,30 +65,16 @@ In this example, the reporting URL is changed to `https://atl-sql-002.litwareinc ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +84,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database whose reporting configuration settings are being modified. For example: @@ -105,8 +95,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -116,13 +105,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +123,34 @@ Accept wildcard characters: False ``` ### -ReportingUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the Skype for Business Server Monitoring Reports. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -169,13 +182,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration The `Set-CsReportingConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsReportingConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsAgentGroup.md similarity index 91% rename from skype/skype-ps/skype/Set-CsRgsAgentGroup.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsAgentGroup.md index 287057404c..9241281bce 100644 --- a/skype/skype-ps/skype/Set-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsAgentGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsAgentGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgsagentgroup +schema: 2.0.0 +title: Set-CsRgsAgentGroup --- # Set-CsRgsAgentGroup @@ -43,7 +44,7 @@ If you do not call `Set-CsRgsAgentGroup`, your changes will exist in memory only ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -60,7 +61,7 @@ Command 2 in the example modifies the value of the RoutingMethod property. In the final command in the example, the `Set-CsRgsAgentGroup` cmdlet is used to write these changes to the actual Help Desk agent group. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -77,7 +78,7 @@ The second command in the example assigns a new value (helpdesk@litwareinc.com) After the new value has been assigned, `Set-CsRgsAgentGroup` is then used to write the changes to the Help Desk agent group on ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $x = Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -95,7 +96,7 @@ In command 3, the `Set-CsRgsAgentGroup` is used to write the changes (that is, t Note that if you do not call `Set-CsRgsAgentGroup`, the changes will be made in memory only, and will not be applied to the actual agent group. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` $x = Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -115,7 +116,28 @@ If you do not call `Set-CsRgsAgentGroup`, the changes will be made in memory onl ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to the Response Group agent group to be modified. An object reference is typically retrieved by using the `Get-CsRgsAgentGroup` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the Help Desk agent group and stores that object reference in a variable named $x: @@ -125,8 +147,7 @@ An object reference is typically retrieved by using the `Get-CsRgsAgentGroup` cm ```yaml Type: AgentGroup Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -135,14 +156,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -152,29 +175,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -188,13 +197,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup + `Set-CsRgsAgentGroup` accepts pipelined instances of the Response Group agent group object. ## OUTPUTS -### +### None `Set-CsRgsAgentGroup` does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. diff --git a/skype/skype-ps/skype/Set-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsRgsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsConfiguration.md index 6114842831..4cc736b283 100644 --- a/skype/skype-ps/skype/Set-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgsconfiguration +schema: 2.0.0 +title: Set-CsRgsConfiguration --- # Set-CsRgsConfiguration @@ -42,7 +43,7 @@ The `Set-CsRgsConfiguration` cmdlet provides a way for you to modify the propert ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -AgentRingbackGracePeriod 30 ``` @@ -51,7 +52,7 @@ The command shown in Example 1 modifies the AgentRingbackGracePeriod property fo In this example, AgentRingbackGracePeriod is set to 30 seconds. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -ApplicationServer | Where-Object {$_.Applications -contains "urn:application:RGS"} | ForEach-Object {Set-CsRgsConfiguration -Identity $_.Identity -AgentRingbackGracePeriod 30} ``` @@ -64,7 +65,7 @@ In turn, those computers are piped to the `ForEach-Object` cmdlet. `ForEach-Object` then takes each computer in the collection and uses the `Set-CsRgsConfiguration` to set the value of the AgentRingbackGracePeriod of the computer's Response Group configuration settings r to 30 seconds. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content ([System.IO.File]::ReadAllBytes('C:\Media\WhileYouWait.wav')) @@ -83,43 +84,10 @@ After the file has been imported, `Set-CsRgsConfiguration` is called in order to ## PARAMETERS -### -Identity -Name of the service hosting the Response Group configuration settings. -For example: `-Identity "service:ApplicationServer:atl-cs-001.litwareinc.com."` - -```yaml -Type: RgsIdentity -Parameter Sets: Direct -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Object reference to the Response Group configuration settings to be modified. -An object reference is typically retrieved by using the `Get-CsRgsConfiguration` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the configuration settings found on the service ApplicationServer:atl-cs-001.litwareinc.com and stores that object reference in a variable named $x: - -`$x = Get-CsRgsConfiguration -Identity service:ApplicationServer:atl-cs-001.litwareinc.com` +### -AgentRingbackGracePeriod -```yaml -Type: ServiceSettings -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AgentRingbackGracePeriod If an agent declines a call, the AgentRingbackGracePeriod represents the amount of time (in seconds) that can elapse before the call returns to the same agent. The grace period can be set to any integer value between 30 and 600 seconds (10 minutes), inclusive. The default value is 60 seconds. @@ -127,8 +95,7 @@ The default value is 60 seconds. ```yaml Type: Int16 Parameter Sets: Direct -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +105,9 @@ Accept wildcard characters: False ``` ### -DefaultMusicOnHoldFile + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the music that, by default, will be played any time a caller is placed on hold. The default music will play only if a Response Group workflow has not defined its own music on hold. @@ -149,8 +119,7 @@ If DefaultMusicOnHold is equal to a null value (the default value) and if a work ```yaml Type: AudioFile Parameter Sets: Direct -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,6 +129,9 @@ Accept wildcard characters: False ``` ### -DisableCallContext + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to False (the default value), each agent is able to see the call context (information such as caller wait time or workflow questions and answers) whenever a call received. (This information is visible from within Skype for Business) If set to True, call context information is not relayed to agents when a call is received. @@ -169,8 +141,7 @@ Note that the call context is only used with IVR queues. ```yaml Type: Boolean Parameter Sets: Direct -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,13 +151,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,14 +168,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the service hosting the Response Group configuration settings. +For example: `-Identity "service:ApplicationServer:atl-cs-001.litwareinc.com."` + +```yaml +Type: RgsIdentity +Parameter Sets: Direct +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference to the Response Group configuration settings to be modified. +An object reference is typically retrieved by using the `Get-CsRgsConfiguration` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the configuration settings found on the service ApplicationServer:atl-cs-001.litwareinc.com and stores that object reference in a variable named $x: + +`$x = Get-CsRgsConfiguration -Identity service:ApplicationServer:atl-cs-001.litwareinc.com` + +```yaml +Type: ServiceSettings +Parameter Sets: Instance +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -211,14 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -232,13 +249,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.ServiceSettings object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.ServiceSettings + `Set-CsRgsConfiguration` accepts pipelined instances of the Response Group application settings object. ## OUTPUTS -### +### None `Set-CsRgsConfiguration` does not return any objects or values. Instead, the cmdlet configures existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.ServiceSettings object. diff --git a/skype/skype-ps/skype/Set-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHolidaySet.md similarity index 92% rename from skype/skype-ps/skype/Set-CsRgsHolidaySet.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsHolidaySet.md index 479d34c95d..5fa79d175e 100644 --- a/skype/skype-ps/skype/Set-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHolidaySet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsHolidaySet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgsholidayset +schema: 2.0.0 +title: Set-CsRgsHolidaySet --- # Set-CsRgsHolidaySet @@ -53,7 +54,7 @@ If you do not call `Set-CsRgsHolidaySet`, then the changes you make will exist i ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = New-CsRgsHoliday -StartDate "12/25/2010" -EndDate "12/26/2010" -Name "Christmas Day" @@ -75,7 +76,7 @@ Command 3 uses the Add method to add the new holiday ($x) to the virtual copy of The final command then uses `Set-CsRgsHolidaySet` to write these changes (and add the new holiday) to the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsRgsHolidaySet -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "2010 Holidays" @@ -97,7 +98,7 @@ After the Christmas Day holiday has been retrieved, command 3 uses the Remove me The final command in the example then uses `Set-CsRgsHolidaySet` to write these changes (removing the Christmas Day holiday) to the actual 2010 Holidays holiday set on ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $x = Get-CsRgsHolidaySet -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "2010 Holidays" @@ -116,7 +117,28 @@ After this property has been cleared, the final command in the example uses the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to the Response Group holiday set to be modified. An object reference is typically retrieved by using the `Get-CsRgsHolidaySet` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the Help Desk holiday set and stores that object reference in a variable named $x: @@ -125,8 +147,7 @@ An object reference is typically retrieved by using the `Get-CsRgsHolidaySet` cm ```yaml Type: HolidaySet Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -135,14 +156,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -152,29 +175,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -188,13 +197,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet + `Remove-CsRgsHolidaySet` accepts pipelined instances of the Response Group holiday set object. ## OUTPUTS -### +### None `Set-CsRgsHolidaySet` does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. diff --git a/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHoursOfBusiness.md similarity index 91% rename from skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsHoursOfBusiness.md index 2357b448fd..cdbe0a8494 100644 --- a/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHoursOfBusiness.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsHoursOfBusiness -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgshoursofbusiness +schema: 2.0.0 +title: Set-CsRgsHoursOfBusiness --- # Set-CsRgsHoursOfBusiness @@ -27,7 +28,7 @@ Set-CsRgsHoursOfBusiness [-Instance] [-Force] [-WhatIf] [-Confir ## DESCRIPTION In order to provide callers with the best possible experience, the Response Group application makes it possible for you to clearly define when Response Group agents are available to answer calls and when they are not available to answer calls. With the Response Group application, you can define business hours; these hours indicate the days of the week and hours of the day that agents are available to answer calls. -For example, if your organization is typically open from 9:00 A.M. +For example, if your organization is typically open from 9:00 A.M. to 5:00 P.M. Monday through Friday, then you would configure business hours that show that agents are available from 9:00 A.M. to 5:00 P.M. @@ -64,7 +65,7 @@ When your modifications are complete, you then use `Set-CsRgsHoursOfBusiness` to ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $weekend = New-CsRgsTimeRange -Name "Weekend Hours" -OpenTime "12:00" -CloseTime "17:00" @@ -88,7 +89,7 @@ When that command is finished, commands 3 and 4 are used to set the SaturdayHour Finally, the last command in the example then uses `Set-CsRgsHoursOfBusiness` to write these changes back to the actual business hours set. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "Help Desk Business Hours" @@ -110,7 +111,28 @@ When the command finishes running, there will no longer be any Saturday business ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to the business hours set to be modified. An object reference is typically retrieved by using the `Get-CsRgsHoursOfBusiness` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the Help Desk business hours set and stores that object reference in a variable named $x: @@ -119,8 +141,7 @@ An object reference is typically retrieved by using the `Get-CsRgsHoursOfBusines ```yaml Type: BusinessHours Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -129,14 +150,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -146,29 +169,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -182,13 +191,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours + `Set-CsRgsHoursOfBusiness` accepts pipelined instances of the Response Group business hours object. ## OUTPUTS -### +### None Modifies existing instances of the Microsoft.Rtc.Rgs.Management.WriteableSettings.BusinessHours object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsQueue.md similarity index 91% rename from skype/skype-ps/skype/Set-CsRgsQueue.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsQueue.md index 4fbf3f12e4..a097f04204 100644 --- a/skype/skype-ps/skype/Set-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsQueue.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsQueue -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgsqueue +schema: 2.0.0 +title: Set-CsRgsQueue --- # Set-CsRgsQueue @@ -40,7 +41,7 @@ If you do not call `Set-CsRgsQueue`, your changes will be made in memory only, a ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = Get-CsRgsQueue -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -59,7 +60,7 @@ Note that, up to this point, the changes have taken place only in memory. Until you call `Set-CsRgsQueue` the actual Response Group queue on ApplicationServer:atl-cs-001.litwareinc.com will remain unchanged. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Overflow Queue" @@ -93,7 +94,28 @@ After the call action has been assigned, the final command in the example calls ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to the Response Group queue to be modified. An object reference is typically retrieved by using the `Get-CsRgsQueue` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the Help Desk queue and stores that object reference in a variable named $x: @@ -102,8 +124,7 @@ An object reference is typically retrieved by using the `Get-CsRgsQueue` cmdlet ```yaml Type: Queue Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -112,14 +133,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -129,29 +152,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -165,13 +174,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.Queue + `Set-CsRgsQueue` accepts pipelined instances of the Response Group queue object. ## OUTPUTS -### +### None `Set-CsRgsQueue` does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. diff --git a/skype/skype-ps/skype/Set-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsWorkflow.md similarity index 92% rename from skype/skype-ps/skype/Set-CsRgsWorkflow.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsWorkflow.md index 2a4c7f6b0e..ffd43fd417 100644 --- a/skype/skype-ps/skype/Set-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsWorkflow.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsWorkflow -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgsworkflow +schema: 2.0.0 +title: Set-CsRgsWorkflow --- # Set-CsRgsWorkflow @@ -41,7 +42,7 @@ If you do not call `Set-CsRgsWorkflow` then your changes will exist only in memo ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $businessHours = Get-CsRgsHoursOfBusiness service:ApplicationServer:atl-cs-001.litwareinc.com -Name "US Business Hours" @@ -66,7 +67,7 @@ This last step is important because, until this point, all the changes have take To actually save these changes to the Help Desk workflow, you must call `Set-CsRgsWorkflow`, passing the cmdlet the object reference ($y) containing the virtual copy of the workflow. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -81,7 +82,7 @@ In command 2, a new description ("Workflow for the Redmond Help Desk") is added After the description has been changed, command 3 uses the `Set-CsRgsWorkflow` to write these changes back to the actual Help Desk workflow located on ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $musicFile = [System.IO.File]::ReadAllBytes('C:\MediaFiles\Hold.wav') | Import-CsRgsAudioFile -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com -FileName "HelpDeskHoldMusic.wav" @@ -108,7 +109,28 @@ After $musicFile has been assigned to CustomMusicOnHoldFile, the final command u ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to the Response Group application workflow to be modified. An object reference is typically retrieved by using the `Get-CsRgsWorkflow` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the Help Desk workflow and stores that object reference in a variable named $x: @@ -124,8 +146,7 @@ That means that the following two commands are functionally identical: ```yaml Type: Workflow Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -134,14 +155,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -151,29 +174,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -187,13 +196,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow + `Set-CsRgsWorkflow` accepts pipelined instances of the Response Group workflow object. ## OUTPUTS -### +### None `Set-CsRgsWorkflow` does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. diff --git a/skype/skype-ps/skype/Set-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsRoutingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRoutingConfiguration.md index 5a2141d994..a98cacf45d 100644 --- a/skype/skype-ps/skype/Set-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csroutingconfiguration +schema: 2.0.0 +title: Set-CsRoutingConfiguration --- # Set-CsRoutingConfiguration @@ -41,7 +42,7 @@ To modify routing configurations, modify the individual voice routes by calling ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $a = Get-CsRoutingConfiguration @@ -75,53 +76,56 @@ That one line will accomplish the same task shown in Example 1. ## PARAMETERS -### -Identity -The scope of the routing configuration. -This must be Global. +### -CallViaWorkCallerId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The number the system will display for the callback portion of an external call. +External calls first connect the user making the call by calling a specified number (typically the user's desk phone), once connected to the user, the system dials the outside number. +The CallViaWorkCallerId parameter specifies the number that will be displayed during the first leg, or callback segment, of the call via work external call. +For more information, see `New-CsCallViaWorkPolicy`. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -A routing configuration (Microsoft.Rtc.Management.WritablConfig.Policy.Voice.PstnRoutingSettings) object. -An object of this type can be retrieved by calling the `Get-CsRoutingConfiguration` cmdlet. +### -EnableLocationBasedRouting +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. +The default value is False. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Route -A list of all voice routes (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route objects) defined for the Skype for Business Server deployment. +### -Force -You should modify individual voice route objects by using the `Set-CsVoiceRoute` cmdlet. -That is the recommended way of modifying routes in this list. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,46 +134,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The scope of the routing configuration. +This must be Global. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A routing configuration (Microsoft.Rtc.Management.WritablConfig.Policy.Voice.PstnRoutingSettings) object. +An object of this type can be retrieved by calling the `Get-CsRoutingConfiguration` cmdlet. + ```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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Route + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A list of all voice routes (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route objects) defined for the Skype for Business Server deployment. + +You should modify individual voice route objects by using the `Set-CsVoiceRoute` cmdlet. +That is the recommended way of modifying routes in this list. + ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,17 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallViaWorkCallerId -The number the system will display for the callback portion of an external call. -External calls first connect the user making the call by calling a specified number (typically the user's desk phone), once connected to the user, the system dials the outside number. -The CallViaWorkCallerId parameter specifies the number that will be displayed during the first leg, or callback segment, of the call via work external call. -For more information, see `New-CsCallViaWorkPolicy`. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -197,15 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationBasedRouting -When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. -The default value is False. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -219,13 +236,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.WritableConfig.Management.Policy.Voice.PSTNRoutingSettings object. +### Microsoft.Rtc.WritableConfig.Management.Policy.Voice.PSTNRoutingSettings + Accepts pipelined input of a routing configuration object. ## OUTPUTS -### +### None The `Set-CsRoutingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnRoutingSettings object. diff --git a/skype/skype-ps/skype/Set-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsServerApplication.md similarity index 83% rename from skype/skype-ps/skype/Set-CsServerApplication.md rename to skype/skype-ps/SkypeForBusiness/Set-CsServerApplication.md index 96b56c6e53..352309191e 100644 --- a/skype/skype-ps/skype/Set-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsServerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsServerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csserverapplication +schema: 2.0.0 +title: Set-CsServerApplication --- # Set-CsServerApplication @@ -40,7 +41,7 @@ The `Set-CsServerApplication` cmdlet provides a way for administrators to modify ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsServerApplication -Identity "Registrar:atl-cs-001.litwareinc.com/ExumRouting" -Enabled $True ``` @@ -49,7 +50,7 @@ The command shown in Example 1 enables the server application that has the Ident Because Identities must be unique, this command will only enable a single server application. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsServerApplication | Where-Object {$_.Enabled -eq $False} | Set-CsServerApplication -Enabled $True ``` @@ -62,50 +63,55 @@ In turn, the filtered collection is piped to the `Set-CsServerApplication` cmdle ## PARAMETERS -### -Identity -Unique identifier for the server application to be modified. -Server application Identities are composed of the service where the application is hosted plus the application name. -For example, the server application named QoEAgent might have an Identity similar to this: Registrar:atl-cs-001.litwareinc.com/QoEAgent. +### -Critical + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True (the default value), then Skype for Business Server will not start unless the application in question can be started. +If False, then Skype for Business Server will start regardless of whether or not the application can be started. + ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Set this value to True to enable the application. +Set the value to False to disable the application. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Critical -If set to True (the default value), then Skype for Business Server will not start unless the application in question can be started. -If False, then Skype for Business Server will start regardless of whether or not the application can be started. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,24 +120,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Set this value to True to enable the application. -Set the value to False to disable the application. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the server application to be modified. +Server application Identities are composed of the service where the application is hosted plus the application name. +For example, the server application named QoEAgent might have an Identity similar to this: Registrar:atl-cs-001.litwareinc.com/QoEAgent. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the order of execution for server applications. The application with priority 0 is started first; the application with priority 1 is started second and so on. Note that each service that hosts a server application has its own unique set of priorities. @@ -145,8 +175,7 @@ For example, if you delete an application that has a priority of 0, then the app ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,15 +184,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScriptName -Path to the Microsoft SIP Processing Language (MSPL) script used by the application. -MSPL is a scripting language used for filtering and routing SIP messages. +### -Script + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to associate the server application with a script. +To add a script to a server application, use syntax similar to this: + +`-Script "Update.ps1"` + +To remove a script, simply set the Script property to a null value: + +`-Script $Null` + +Each server application can only be associated with one script. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,15 +211,17 @@ Accept pipeline input: False 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`. +### -ScriptName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the Microsoft SIP Processing Language (MSPL) script used by the application. +MSPL is a scripting language used for filtering and routing SIP messages. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,14 +230,17 @@ 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. +### -Uri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique Uniform Resource Identifier (URI) for the application. +For example, the QoEAgent application has the URI `http://www.microsoft.com/LCS/QoEAgent`. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,13 +250,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -222,38 +268,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 -``` - -### -Script -Enables you to associate the server application with a script. -To add a script to a server application, use syntax similar to this: - -`-Script "Update.ps1"` - -To remove a script, simply set the Script property to a null value: - -`-Script $Null` - -Each server application can only be associated with one script. - -```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 @@ -267,13 +290,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application + The `Set-CsServerApplication` cmdlet accepts pipelined instances of the server application object. ## OUTPUTS -### +### None The `Set-CsServerApplication` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.application object. diff --git a/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsSimpleUrlConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsSimpleUrlConfiguration.md index c34fbf16bf..e4a7bdaca1 100644 --- a/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSimpleUrlConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsSimpleUrlConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cssimpleurlconfiguration +schema: 2.0.0 +title: Set-CsSimpleUrlConfiguration --- # Set-CsSimpleUrlConfiguration @@ -74,7 +75,7 @@ After updating a simple URL collection, you must then run the `Enable-CsComputer ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl $Null ``` @@ -84,7 +85,7 @@ The command shown in Example 1 removes all the simple URLs from the Redmond site This removes all the simple URLs from the collection. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com" @@ -104,7 +105,7 @@ This is done by using the `Set-CsSimpleUrlConfiguration` cmdlet, the SimpleUrl p This syntax causes the URL stored in the object reference $simpleUrl to be added to the SimpleUrl property. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://fabrikam.vdomain.com" @@ -128,7 +129,28 @@ This syntax simply causes the URL stored in the object reference $simpleUrl to b ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of simple URLs to be modified. To modify the global collection, use this syntax: @@ -144,8 +166,7 @@ If this parameter is not specified then the global collection will be modified. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -155,13 +176,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +194,9 @@ Accept wildcard characters: False ``` ### -SimpleUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Simple URLs configured for this collection. These URLs must be created by using the `New-SimpleUrl` cmdlet and the `New-SimpleUrlEntry` cmdlet. @@ -178,8 +204,7 @@ These URLs must be created by using the `New-SimpleUrl` cmdlet and the `New-Simp ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,23 +213,10 @@ 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. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -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 Simple URL configuration settings are to be modified. For example: @@ -218,8 +230,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -228,14 +239,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -244,14 +257,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -265,14 +280,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration + The `Set-CsSimpleUrlConfiguration` cmdlet accepts pipelined instances of the simple URL configuration object. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/Set-CsSipDomain.md similarity index 86% rename from skype/skype-ps/skype/Set-CsSipDomain.md rename to skype/skype-ps/SkypeForBusiness/Set-CsSipDomain.md index dc43ae35bf..b6211559de 100644 --- a/skype/skype-ps/skype/Set-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSipDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsSipDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cssipdomain +schema: 2.0.0 +title: Set-CsSipDomain --- # Set-CsSipDomain @@ -38,7 +39,7 @@ The `Set-CsSipDomain` cmdlet provides a way for you to change your default SIP d ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsSipDomain -Identity fabrikam.com -IsDefault $True ``` @@ -49,7 +50,28 @@ When this command is run, Fabrikam.com will become the default domain and the do ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the SIP domain to be configured as the default domain. For example: @@ -59,8 +81,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -70,6 +91,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the domain is the default SIP domain, the domain used by Skype for Business Server any time a domain name is not explicitly stated. If set to True, the new domain will become the new default domain. You cannot set this value to False because that would leave you without a default SIP domain. @@ -80,8 +104,7 @@ If you change the default SIP domain you will need to restart the RTCCAA and RTC ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,14 +113,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -107,29 +132,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -143,13 +154,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsSipDomain` cmdlet does not accept pipelined data. ## OUTPUTS -### +### None The `Set-CsSipDomain` cmdlet does not return any objects or values. Instead, the cmdlet is used to modify existing instances of the Microsoft.Rtc.Management.Xds.SipDomain object. diff --git a/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsSipResponseCodeTranslationRule.md similarity index 86% rename from skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsSipResponseCodeTranslationRule.md index 8709e8d4e9..dde043f572 100644 --- a/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSipResponseCodeTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsSipResponseCodeTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cssipresponsecodetranslationrule +schema: 2.0.0 +title: Set-CsSipResponseCodeTranslationRule --- # Set-CsSipResponseCodeTranslationRule @@ -57,7 +58,7 @@ The `Set-CsSipResponseCodeTranslationRule` cmdlet provides a way for you to modi ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" -ReceivedISUPCauseValue 477 ``` @@ -65,7 +66,7 @@ Set-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule40 The command shown in Example 1 modifies the ReceivedISUPCauseValue property for the translation rule with the Identity PstnGateway:192.168.0.240/Rule404. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" -Priority 0 ``` @@ -74,7 +75,7 @@ In Example 2, the translation rule with the Identity PstnGateway:192.168.0.240/R This is done by setting the Priority to 0. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsSipResponseCodeTranslationRule | Set-CsSipResponseCodeTranslationRule -ReceivedISUPCauseValue -1 ``` @@ -86,7 +87,28 @@ That collection is then piped to the `Set-CsSipResponseCodeTranslationRule` cmdl ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the translation rule to be modified. The Identity for a translation rule consists of two parts: the scope where the rule was configured, and the name given to the rule when it was created. For example, a translation rule named Rule404 that was created at the global scope would have an Identity that looked like this: global/Rule404. @@ -94,8 +116,7 @@ For example, a translation rule named Rule404 that was created at the global sco ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -104,32 +125,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TranslatedResponseCode -Value of SIP response code that the ReceivedResponseCode and/or the ReceivedISUPCauseCode should be translated to. -Translated response codes can be any integer value between 400 and 699, inclusive. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + ```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Relative priority of the translation rule. Rules are processed in order of their assigned priority; the first rule to be processed has a priority of 0; the second rule to be processed has a priority of 1 and so on. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,18 +163,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceivedResponseCode -Value of the SIP response code used by a gateway when responding to an INVITE message. -A response code can be any integer value between 400 and 699, inclusive. -Although the cmdlet will accept integer values less than 400, these are not recognized as final responses. -As a result, the translation rule will never be used. -A value of 0 means that only the ISUP cause code will be used when executing the translation rule; the SIP response code will be ignored. +### -ReceivedISUPCauseValue + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Value of the ISDN User Part (ISUP) code that must be present in the SIP response message used by a gateway when responding to an INVITE message. +A value of -1 indicates that only the SIP response code will be used when executing the translation rule; the ISUP cause code will be ignored. + ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +183,20 @@ 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. +### -ReceivedResponseCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Value of the SIP response code used by a gateway when responding to an INVITE message. +A response code can be any integer value between 400 and 699, inclusive. +Although the cmdlet will accept integer values less than 400, these are not recognized as final responses. +As a result, the translation rule will never be used. +A value of 0 means that only the ISUP cause code will be used when executing the translation rule; the SIP response code will be ignored. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,14 +205,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -TranslatedResponseCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Value of SIP response code that the ReceivedResponseCode and/or the ReceivedISUPCauseCode should be translated to. +Translated response codes can be any integer value between 400 and 699, inclusive. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,13 +225,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -206,33 +242,16 @@ 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 Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +### -WhatIf -### -ReceivedISUPCauseValue -Value of the ISDN User Part (ISUP) code that must be present in the SIP response message used by a gateway when responding to an INVITE message. -A value of -1 indicates that only the SIP response code will be used when executing the translation rule; the ISUP cause code will be ignored. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -246,13 +265,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated + The `Set-CsSipResponseCodeTranslationRule` cmdlet accepts pipelined instances of the SIP response code translation rule object. ## OUTPUTS -### +### None The `Set-CsSipResponseCodeTranslationRule` cmdlet does not return any objects or values. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated object. diff --git a/skype/skype-ps/skype/Set-CsSite.md b/skype/skype-ps/SkypeForBusiness/Set-CsSite.md similarity index 84% rename from skype/skype-ps/skype/Set-CsSite.md rename to skype/skype-ps/SkypeForBusiness/Set-CsSite.md index b5779296c3..262b73ad0e 100644 --- a/skype/skype-ps/skype/Set-CsSite.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cssite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cssite +schema: 2.0.0 +title: Set-CsSite --- # Set-CsSite @@ -40,7 +41,7 @@ However, you can use the `Set-CsSite` cmdlet to change the display name, the des ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsSite -Identity Redmond -Description "Full-time employees in Redmond, WA." ``` @@ -48,7 +49,7 @@ Set-CsSite -Identity Redmond -Description "Full-time employees in Redmond, WA." The command shown in Example 1 modifies the Description property for the Redmond site (-Identity Redmond). -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsSite -Identity Redmond -DisplayName "US Headquarters" ``` @@ -56,7 +57,7 @@ Set-CsSite -Identity Redmond -DisplayName "US Headquarters" Example 2 changes the display name for the Redmond site to "US Headquarters". -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsSite | Where-Object {$_.Description -eq $Null} | ForEach-Object {Set-CsSite $_.Identity -Description "Litwareinc.com"} ``` @@ -69,36 +70,35 @@ This cmdlet takes each item in the collection and uses the `Set-CsSite` cmdlet t ## PARAMETERS -### -Identity -Name of the site to be modified; for example: - -`-Identity "Redmond"` +### -DefaultPersistentChatPool -Do not use the format "site:Redmond" when specifying the identity. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name of the default Persistent Chat pool for the site. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to add additional information to a site object. For example, the Description might include contact information for the site. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +108,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Friendly name for the site. For example: @@ -117,8 +120,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +130,9 @@ Accept wildcard characters: False ``` ### -FederationRoute + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Edge Server used to provide a bridge between your internal network and the Internet. For example: @@ -137,8 +142,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,14 +151,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + ```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 +Aliases: Required: False Position: Named @@ -163,31 +170,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the site to be modified; for example: + +`-Identity "Redmond"` + +Do not use the format "site:Redmond" when specifying the identity. + ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -XmppFederationRoute + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service Identity of the Edge Server used for XMPP (Extensible Messaging and Presence Protocol) federation. +For example: +`-XmppFederationRoute EdgeServer:atl-xmpp-001.litwareinc.com` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,14 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultPersistentChatPool -Fully qualified domain name of the default Persistent Chat pool for the site. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -212,17 +232,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -XmppFederationRoute -Service Identity of the Edge Server used for XMPP (Extensible Messaging and Presence Protocol) federation. -For example: +### -WhatIf -`-XmppFederationRoute EdgeServer:atl-xmpp-001.litwareinc.com` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -236,13 +255,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsSite` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsSite` cmdlet does not return any objects or values. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Deploy.Internal.Site+CentralSite object. diff --git a/skype/skype-ps/skype/Set-CsSlaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsSlaConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsSlaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsSlaConfiguration.md index 17fb0a02a8..37a46f130e 100644 --- a/skype/skype-ps/skype/Set-CsSlaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSlaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsSlaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csslaconfiguration +schema: 2.0.0 +title: Set-CsSlaConfiguration --- # Set-CsSlaConfiguration @@ -24,7 +25,7 @@ Set-CsSlaConfiguration [-BusyOption ] [-Target ] ``` ## DESCRIPTION -Shared Line Appearance (SLA) is a feature in Skype for Business (SfB) for handling multiple calls on a specific number called a shared number. SLA can configure any enterprise voice enabled SfB user as a shared number with multiple lines to respond to multiple calls. The calls are not actually received on the shared number, instead they are forwarded to users that act as delegates for the shared number. Any one of the delegates can pick up the call while the rest of the delegates get a notification on their phone about who picked up the call and which line has become busy as a result. Both the number of lines and the delegates are configurable for a shared number in SLA. In addition, advanced options such as BusyOption (what happens in a situation when all lines are busy) and MissedCallOption (the case in which none of the delegates pick up a call) etc. can also be configured for a shared number. +Shared Line Appearance (SLA) is a feature in Skype for Business (SfB) for handling multiple calls on a specific number called a shared number. SLA can configure any enterprise voice enabled SfB user as a shared number with multiple lines to respond to multiple calls. The calls are not actually received on the shared number, instead they are forwarded to users that act as delegates for the shared number. Any one of the delegates can pick up the call while the rest of the delegates get a notification on their phone about who picked up the call and which line has become busy as a result. Both the number of lines and the delegates are configurable for a shared number in SLA. In addition, advanced options such as BusyOption (what happens in a situation when all lines are busy) and MissedCallOption (the case in which none of the delegates pick up a call) etc. can also be configured for a shared number. The Set-CsSlaConfiguration cmdlet modifies the properties of an SLA configuration. @@ -34,21 +35,21 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Set-CsSlaConfiguration"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsSlaConfiguration -Identity SLAGroup1 -MaxNumberOfCalls 3 -BusyOption BusyOnBusy ``` This example creates an SLA group for an existing Enterprise Voice user, SLAGroup1, and uses the number assigned for SLAGroup1 as the SLA mainline number. Also It sets the maximum number of concurrent calls for the new SLA group to 3, and for calls in excess of that to hear a busy signal. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsSlaConfiguration -Identity SLAGroup1 -BusyOption Forward -Target tel:+2025551234 ``` This example sets calls that exceed the maximum number of concurrent calls to be forwarded to the telephone number 202-555-1234. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Set-CsSlaConfiguration -Identity SLAGroup1 -MissedCallOption Forward -MissedCallForwardTarget sip:sla_forward_number@contoso.com -BusyOption Forward -MaxNumberOfCalls 2 -Target sip:sla_forward_number@contoso.com ``` @@ -57,25 +58,10 @@ This example specifies that missed calls to be forwarded to the user named sla_f ## PARAMETERS -### -Identity -Indicates the Identity of the SLA group to be created or modified. 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). You can also reference a user account by using the 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". +### -BusyOption -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: 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 -``` - -### -BusyOption Specifies the action to take when the SLA group exceeds the maximum number of simultaneous calls. Possible values are: * Forward * BusyOnBusy @@ -84,8 +70,7 @@ Specifies the action to take when the SLA group exceeds the maximum number of si ```yaml Type: SlaBusyOption Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,30 +79,36 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the SLA group to be created or modified. 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). You can also reference a user account by using the 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: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -MaxNumberOfCalls + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Sets the maximum number of concurrent calls to be allowed in the SLA group. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,6 +118,9 @@ Accept wildcard characters: False ``` ### -MissedCallForwardTarget + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the sip address of a user account or a telephone number to forward the call when you select `Forward` in the `MissedCallOption` parameter. The target could be a user in your organization or a phone number following next syntax: * tel:\ * sip:\ @@ -134,8 +128,7 @@ Specifies the sip address of a user account or a telephone number to forward the ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +138,9 @@ Accept wildcard characters: False ``` ### -MissedCallOption + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the action to take when the SLA group delegates do not answer a call. Possible values are: * Disconnect * Forward @@ -154,8 +150,7 @@ Specifies the action to take when the SLA group delegates do not answer a call. ```yaml Type: SlaUserMissedCallOption Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,13 +160,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the SLA group being created or modified. By default, the Set-CsSlaConfiguration cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,6 +178,9 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the sip address of a user account or a telephone number to forward the call when you select `Forward` in the `BusyOption` parameter. The target could be a user in your organization or a phone number following next syntax: * tel:\ * sip:\ @@ -188,8 +188,7 @@ Specifies the sip address of a user account or a telephone number to forward the ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,14 +197,34 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -224,6 +243,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration?view=skype-ps) +[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csslaconfiguration?view=skype-ps) -[Remove-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration?view=skype-ps) +[Remove-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csslaconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsStaticRoutingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsStaticRoutingConfiguration.md index e573931e83..3c6c6807ff 100644 --- a/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsStaticRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsStaticRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csstaticroutingconfiguration +schema: 2.0.0 +title: Set-CsStaticRoutingConfiguration --- # Set-CsStaticRoutingConfiguration @@ -48,7 +49,7 @@ This means that you can use the cmdlet to add new routes to a collection, or to ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = Get-CsStaticRoutingConfiguration -Identity global | Select-Object -ExpandProperty Route | Where-Object {$_.MatchUri -eq "litwareinc.com" -and $_.MatchOnlyPhoneUri -eq $True} @@ -67,7 +68,7 @@ After the route has been retrieved, the second command in the example adds that To do this, the `Set-CsStaticRoutingConfiguration` cmdlet is called along with the Route parameter; the parameter value @{Add=$x} instructs the `Set-CsStaticRoutingConfiguration` cmdlet to append the route stored in the variable $x to the collection of routes maintained in the Route property. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty Route | Where-Object {$_.MatchUri -eq "litwareinc.com" -and $_.MatchOnlyPhoneUri -eq $True} @@ -85,7 +86,7 @@ After the route has been retrieved, the second command deletes that route from t To do this, the `Set-CsStaticRoutingConfiguration` cmdlet is called along with the Route parameter; the parameter value @{Remove=$x} instructs the `Set-CsStaticRoutingConfiguration` cmdlet to delete the route stored in the variable $x. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com -Route $Null ``` @@ -97,7 +98,28 @@ After the command completes, the collection will still exist, but it will no lon ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the static routing configuration collection to be modified. To modify the global collection, use this syntax: @@ -115,8 +137,7 @@ If this parameter is not included the `Set-CsStaticRoutingConfiguration` cmdlet ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -126,13 +147,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,6 +165,9 @@ Accept wildcard characters: False ``` ### -Route + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Individual static routes maintained within the collection. Routes to be added to a collection must either be copied from another collection or created by using the `New-CsStaticRoute` cmdlet; to delete a route from a collection, you must first create an object reference to that route. For details, see the Examples section of help topic. @@ -149,8 +175,7 @@ For details, see the Examples section of help topic. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,14 +184,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -176,29 +203,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -212,13 +225,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings + The `Set-CsStaticRoutingConfiguration` cmdlet accepts pipelined instances of the static routing settings object. ## OUTPUTS -### +### None The `Set-CsStaticRoutingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings object. diff --git a/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsStorageServiceConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsStorageServiceConfiguration.md index e8dde2d1fe..8e3b102839 100644 --- a/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsStorageServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsStorageServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csstorageserviceconfiguration +schema: 2.0.0 +title: Set-CsStorageServiceConfiguration --- # Set-CsStorageServiceConfiguration @@ -48,36 +49,22 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 At this point in time there are no property values that can be modified by using the Set-CsStorageServiceConfiguration cmdlet. ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableAsyncAdaptorTaskAbort -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableAsyncAdaptorTaskAbort PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -87,13 +74,15 @@ Accept wildcard characters: False ``` ### -EnableAutoImportFlushedData + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,13 +92,15 @@ Accept wildcard characters: False ``` ### -EnableFabricReplicationSetReduction + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,13 +110,15 @@ Accept wildcard characters: False ``` ### -FabricInvalidStateTimeoutDuration + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: UInt64 ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,13 +128,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any nonfatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +146,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the storage service configuration settings to be modified. Storage service configuration settings can be applied to the global, site, or service scope (for the Registrar service only). @@ -169,8 +167,7 @@ To modify settings at the service level, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -180,13 +177,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,14 +194,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -216,13 +235,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings The `Set-CsStorageServiceConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings object. ## OUTPUTS -### -None. +### None The `Set-CsStorageServiceConfiguration` cmdlet does not return any data or objects. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradeConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradeConfiguration.md index c8556d260f..fb6d0ba39d 100644 --- a/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradeConfiguration.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-csteamsupgradeconfiguration -applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTeamsUpgradeConfiguration -schema: 2.0.0 -manager: bulenteg +applicable: Skype for Business Server 2015, Skype for Business Server 2019 author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csteamsupgradeconfiguration +schema: 2.0.0 +title: Set-CsTeamsUpgradeConfiguration --- # Set-CsTeamsUpgradeConfiguration @@ -32,7 +34,7 @@ Set-CsTeamsUpgradeConfiguration [-Tenant ] [-DownloadTeams ] [-Sf ## 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 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. @@ -47,94 +49,106 @@ The above cmdlet specifies that users subject to upgrade should download Teams i ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DownloadTeams + +> Applicable: Skype for Business Online + +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: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` +### -Force -### -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. +> Applicable: Skype for Business Online + +{{Fill Force Description}} ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named -Default value: True +Default value: None 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. + +### -Identity + +> Applicable: Skype for Business Online + +{{Fill Identity Description}} ```yaml -Type: string +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named -Default value: NativeLimitedClient +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -{{Fill Force Description}} + + + +### -SfBMeetingJoinUx + +> Applicable: Skype for Business Online + +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: SwitchParameter +Type: string Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named -Default value: None +Default value: NativeLimitedClient Accept pipeline input: False Accept wildcard characters: False ``` +### -Tenant -### -Identity -{{Fill Identity Description}} +> Applicable: Skype for Business Online + +{{Fill Tenant Description}} ```yaml -Type: XdsIdentity +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +> Applicable: Skype for Business Online -### -Tenant -{{Fill Tenant Description}} +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -144,6 +158,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -151,7 +168,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradePolicy.md similarity index 95% rename from skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradePolicy.md index 86e0f3e376..1b9c6b89c9 100644 --- a/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradePolicy.md @@ -1,14 +1,14 @@ --- -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 2015, Skype for Business Server 2019 -title: Set-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csteamsupgradepolicy +schema: 2.0.0 +title: Set-CsTeamsUpgradePolicy --- # Set-CsTeamsUpgradePolicy @@ -59,13 +59,14 @@ This disables notifications for users in the Redmond1 site. ### -Description +> Applicable: Skype for Business Server 2019 + Free form text that can be used by administrators as desired. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -75,13 +76,14 @@ Accept wildcard characters: False ### -Identity +> Applicable: Skype for Business Server 2019 + The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\" where \ is the name of the site. To specify any other policy provide the name of that policy. ```yaml Type: XdsIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: 1 Default value: None @@ -91,13 +93,14 @@ Accept wildcard characters: False ### -NotifySfbUsers +> Applicable: Skype for Business Server 2019 + If true, users with this policy see a notification in their Skype for Business client indicating that Teams is coming soon. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -107,13 +110,14 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Skype for Business Server 2019 + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTelemetryConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsTelemetryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTelemetryConfiguration.md index 8a7a2ec48f..d3409f7bcc 100644 --- a/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTelemetryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTelemetryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstelemetryconfiguration +schema: 2.0.0 +title: Set-CsTelemetryConfiguration --- # Set-CsTelemetryConfiguration @@ -35,7 +36,7 @@ For privacy information, see the Skype for Business Privacy Statement (https://g ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTelemetryConfiguration -Identity site:Redmond -EnableClientTelemetry $True ``` @@ -45,31 +46,17 @@ This example enables client telemetry on the configuration scoped to the Redmond ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableClientTelemetry -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableClientTelemetry When set to true, client telemetry will be enabled. The default is false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,13 +66,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -95,6 +84,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier that includes the scope of the telemetry configuration. Telemetry configurations can be scoped at the Global, Site, or Service level. For example, "site:Redmond" (for site). @@ -112,8 +104,7 @@ You can combine the two commands to zero in on a single role in a single pool. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -123,13 +114,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,14 +131,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -159,13 +172,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.Management.Automation.PSObject This cmdlet takes pipeline input of the `Get-CsTelemetryConfiguration` cmdlet. ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTenantHybridConfiguration.md similarity index 93% rename from skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTenantHybridConfiguration.md index ca249562b2..8c45d576dd 100644 --- a/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTenantHybridConfiguration.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-cstenanthybridconfiguration applicable: Skype for Business Server 2019 -title: Set-CsTenantHybridConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstenanthybridconfiguration +schema: 2.0.0 +title: Set-CsTenantHybridConfiguration --- # Set-CsTenantHybridConfiguration @@ -58,7 +60,7 @@ However, you can't create or modify hybrid PSTN sites through the CsTenantHybrid ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTenantHybridConfiguration -HybridConfigServiceInternalUrl "https://internal.litwareinc.com" ``` @@ -68,30 +70,16 @@ The command shown in Example 1 sets the internal service URL for the global coll ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -Force -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +> Applicable: Skype for Business Online -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: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -101,13 +89,15 @@ Accept wildcard characters: False ``` ### -HybridConfigServiceExternalUrl + +> Applicable: Skype for Business Online + External Web service URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -117,13 +107,15 @@ Accept wildcard characters: False ``` ### -HybridConfigServiceInternalUrl + +> Applicable: Skype for Business Online + Internal Web service URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -133,6 +125,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique Identity of the tenant hybrid configuration settings to be modified. Because you are limited to a single, global collection of hybrid configuration settings, the only collection that can be modified by using the Identity parameter is the global collection: @@ -143,8 +138,7 @@ To modify the settings for an individual tenant, use the Tenant parameter instea ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -154,13 +148,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online + 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: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -170,13 +166,15 @@ Accept wildcard characters: False ``` ### -PeerDestination + +> Applicable: Skype for Business Online + Fully qualified domain name of your on-premises Access Edge server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -186,6 +184,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. @@ -198,8 +199,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -209,6 +209,9 @@ Accept wildcard characters: False ``` ### -UseOnPremDialPlan + +> Applicable: Skype for Business Online + If set to $true, hybrid users will use the dial plan defined for your on-premises Skype for Business Server organization. If set to $false, hybrid users will use the dial plan defined for your Skype for Business Online organization. The default is $true. @@ -216,8 +219,25 @@ The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -227,13 +247,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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 @@ -247,14 +269,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsTenantHybridConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/Set-CsTenantUpdateTimeWindow.md similarity index 88% rename from skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTenantUpdateTimeWindow.md index 16213f56b6..335aaeb683 100644 --- a/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTenantUpdateTimeWindow.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-cstenantupdatetimewindow applicable: Skype for Business Online -title: Set-CsTenantUpdateTimeWindow -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstenantupdatetimewindow +schema: 2.0.0 +title: Set-CsTenantUpdateTimeWindow --- # Set-CsTenantUpdateTimeWindow @@ -69,7 +71,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTenantUpdateTimeWindow -Identity FirstAndLastWeekend -Monthly -WeeksOfMonth First,Last -DaysOfWeek Sunday,Saturday -StartTime 1:00 -Duration 5:00 ``` @@ -77,7 +79,7 @@ Set-CsTenantUpdateTimeWindow -Identity FirstAndLastWeekend -Monthly -WeeksOfMont This example updates an existing tenant update time window in the tenant in Monthly type. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsTenantUpdateTimeWindow -Identity MidDay -Monthly -DayOfMonth 15 -StartTime 5:00 -Duration 6:00 ``` @@ -85,7 +87,7 @@ Set-CsTenantUpdateTimeWindow -Identity MidDay -Monthly -DayOfMonth 15 -StartTime This example updates an existing tenant update time window in the tenant in Monthly type. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsTenantUpdateTimeWindow -Identity Weekday -Weekly -DaysOfWeek Monday,Tuesday,Wednesday,Thursday,Friday -StartTime 3:00 -Duration 10:00 ``` @@ -93,7 +95,7 @@ Set-CsTenantUpdateTimeWindow -Identity Weekday -Weekly -DaysOfWeek Monday,Tuesda This example updates an existing tenant update time window in the tenant in Weekly type. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsTenantUpdateTimeWindow -Identity Night -Daily ``` @@ -104,13 +106,15 @@ This example updates an existing tenant update time window in the tenant in Dail ## PARAMETERS ### -Daily + +> Applicable: Skype for Business Online + Type of Time window is daily. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -120,14 +124,16 @@ Accept wildcard characters: False ``` ### -DayOfMonth + +> Applicable: Skype for Business Online + Day of month. It must be defined when Type is Monthly. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -137,6 +143,9 @@ Accept wildcard characters: False ``` ### -DaysOfWeek + +> Applicable: Skype for Business Online + Days of week. It can be multiple days separated by a comma. It must be defined when Type is Weekly or Monthly. @@ -144,8 +153,7 @@ It must be defined when Type is Weekly or Monthly. ```yaml Type: TenantUpdateTimeWindowDayOfWeek Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -154,30 +162,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the identity of the tenant update time window. +### -Duration + +> Applicable: Skype for Business Online + +Duration of the update time window. ```yaml -Type: XdsGlobalRelativeIdentity +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Monthly -Type of Time window is monthly. +### -Force + +> Applicable: Skype for Business Online + +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 +Aliases: Required: False Position: Named @@ -186,32 +200,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Weekly -Type of Time window is weekly. +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the tenant update time window. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WeeksOfMonth -Weeks of month. -It can be multiple weeks separated by a comma. -It must be defined when Type is Monthly. +### -Instance + +> Applicable: Skype for Business Online + +PARAMVALUE: PSObject ```yaml -Type: TenantUpdateTimeWindowWeekOfMonth +Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -220,14 +236,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Monthly + +> Applicable: Skype for Business Online + +Type of Time window is monthly. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -236,14 +254,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Duration -Duration of the update time window. +### -StartTime + +> Applicable: Skype for Business Online + +Time of day when the update time window starts. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -252,16 +272,16 @@ 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. +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -270,14 +290,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: PSObject +### -Weekly + +> Applicable: Skype for Business Online + +Type of Time window is weekly. ```yaml -Type: PSObject +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -286,14 +308,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartTime -Time of day when the update time window starts. +### -WeeksOfMonth + +> Applicable: Skype for Business Online + +Weeks of month. +It can be multiple weeks separated by a comma. +It must be defined when Type is Monthly. ```yaml -Type: TimeSpan +Type: TenantUpdateTimeWindowWeekOfMonth Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -302,14 +328,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -319,13 +347,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/Set-CsTestDevice.md similarity index 85% rename from skype/skype-ps/skype/Set-CsTestDevice.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTestDevice.md index 47708627fc..3314e29471 100644 --- a/skype/skype-ps/skype/Set-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTestDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTestDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstestdevice +schema: 2.0.0 +title: Set-CsTestDevice --- # Set-CsTestDevice @@ -46,7 +47,7 @@ After a test device has been created, you can then use the `Set-CsTestDevice` cm ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsTestDevice -Identity site:Redmond/UCPhone -Identifier "09768-ABDR-83295" ``` @@ -54,7 +55,7 @@ Set-CsTestDevice -Identity site:Redmond/UCPhone -Identifier "09768-ABDR-83295" Example 1 modifies the Identifier property for the test device named UCPhone assigned to the Redmond site. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsTestDevice -Identity site:Redmond/UCPhone -IdentifierType SerialNumber -Identifier "09768-ABDR-83295" ``` @@ -65,45 +66,28 @@ In this case, however, the command not only specifies a new Identifier but also ## PARAMETERS -### -Identity -Indicates the Identity of the test device to be modified. -For example: - -`-Identity site:Redmond/UCPhoneTestDevice` +### -Force -Note that you cannot use wildcards when specifying an Identity. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Identifier -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Identifier Based on the IdentifierType, indicates the Media Access Control (MAC) address or serial number of the new test device. Serial numbers can be specified using numbers, letters, hyphens and underscores; for example: @@ -123,8 +107,7 @@ A MAC address such as 01-02-03-04-05 will not be accepted because it does not ha ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +117,9 @@ Accept wildcard characters: False ``` ### -IdentifierType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the test device will be uniquely identified by its MAC address or by its serial number. To identify a device by its MAC address, set the IdentifierType to MACAddress. To identify a device by its serial number, set the IdentifierType to SerialNumber. @@ -142,8 +128,7 @@ MACAddress and SerialNumber are the only allowed values. ```yaml Type: IdentifierType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,46 +137,76 @@ 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. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the test device to be modified. +For example: + +`-Identity site:Redmond/UCPhoneTestDevice` + +Note that you cannot use wildcards when specifying an Identity. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -205,13 +220,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice + The `Set-CsTestDevice` cmdlet accepts pipelined input of the test device object. ## OUTPUTS -### +### None The `Set-CsTestDevice` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. diff --git a/skype/skype-ps/skype/Set-CsTestUserCredential.md b/skype/skype-ps/SkypeForBusiness/Set-CsTestUserCredential.md similarity index 89% rename from skype/skype-ps/skype/Set-CsTestUserCredential.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTestUserCredential.md index 35ebd6a75a..9a06d840cb 100644 --- a/skype/skype-ps/skype/Set-CsTestUserCredential.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTestUserCredential.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstestusercredential applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTestUserCredential -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstestusercredential +schema: 2.0.0 +title: Set-CsTestUserCredential --- # Set-CsTestUserCredential @@ -50,7 +51,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTestUserCredential -SipAddress "sip:kenmyer@litwareinc.com" -UserName "litwareinc\kenmyer" -Password "07Apples" ``` @@ -59,7 +60,7 @@ The command shown in Example 1 configures the user with the SIP address sip:kenm Note that you must also supply the user name (in the form domain name\user name) and the user's password when you configure an account as a watcher node test user. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = Get-Credential "litwareinc\kenmyer" @@ -74,6 +75,9 @@ To do this, the first command in the example uses the `Get-Credential` cmdlet to ## PARAMETERS ### -Credential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to configure test credentials by using a Windows PowerShell credentials object rather than the Password and UserName parameters; this has the advantage of ensuring that the user password is masked when you type it onscreen. To use the Credential parameter you must first create a PSCredential object using the `Get-Credential` cmdlet and then store the resulting object in a variable. @@ -86,8 +90,7 @@ That variable is then used as the parameter value for the Credential parameter. ```yaml Type: PSCredential Parameter Sets: UsePSCredential -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -96,7 +99,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Password + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Password for the account whose test user credentials are being set. (Note that this password will be displayed onscreen in plain text.) For example: @@ -107,8 +131,7 @@ You do not need to use the Password or the UserName parameters if you use the Cr ```yaml Type: String Parameter Sets: UseRawText -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -118,6 +141,9 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the account whose test user credentials are being set. For example: @@ -126,8 +152,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -137,6 +162,9 @@ Accept wildcard characters: False ``` ### -UserName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User name of the account being configured for test credentials. The user name can be the SamAccountName or Active Directory DisplayName; for example: @@ -150,8 +178,7 @@ For example: ```yaml Type: String Parameter Sets: UseRawText -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -161,13 +188,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -176,30 +205,16 @@ 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -213,14 +228,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsTestUserCredential` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Set-CsTestUserCredential` cmdlet modifies existing instances of the System.Management.Automation.PSCredential object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystem.md similarity index 88% rename from skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md rename to skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystem.md index 8ceafe90ca..a6c1b487b8 100644 --- a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystem.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsThirdPartyVideoSystem -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csthirdpartyvideosystem +schema: 2.0.0 +title: Set-CsThirdPartyVideoSystem --- # Set-CsThirdPartyVideoSystem @@ -33,7 +34,7 @@ If you later need to modify the property values for one of these contact objects ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video System" | Set-CsThirdPartyVideoSystem -SipAddress "sip:redmondvideo$litwareinc.com" ``` @@ -43,7 +44,7 @@ To carry out this task, the command first uses the `Get-CsThirdPartyVideoSystem` The contact object for that system is then piped to the `Set-CsThirdPartyVideoSystem` cmdlet, which changes the object's SIP address to sip:redmondvideo@litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystem | Set-CsThirdPartyVideoSystem -Enabled $False ``` @@ -55,49 +56,16 @@ That collection is then piped to the `Set-CsThirdPartyVideoSystem` cmdlet, which ## PARAMETERS -### -Identity -Unique identifier for the video system being modified. -Video systems are identified by using the Active Directory distinguished name (DN) of the associated contact object. -By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. -In turn, that means that you might find it easier to modify third-party video systems by using the `Get-CsThirdPartyVideoSystem` cmdlet to return the devices and then piping those objects to the `Set-CsThirdPartyVideoSystem` cmdlet. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: 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 -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -DisplayName -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -DisplayName Configures the Active Directory display name of the video system. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +75,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) the video system can be used with Skype for Business Server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: CsEnabled -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -123,6 +93,9 @@ Accept wildcard characters: False ``` ### -ExchangeArchivingPolicy + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates where the contact's instant messaging sessions are archived. Allowed values are: @@ -137,8 +110,7 @@ ArchivingToExchange ```yaml Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,7 +119,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the video system being modified. +Video systems are identified by using the Active Directory distinguished name (DN) of the associated contact object. +By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. +In turn, that means that you might find it easier to modify third-party video systems by using the `Get-CsThirdPartyVideoSystem` cmdlet to return the devices and then piping those objects to the `Set-CsThirdPartyVideoSystem` cmdlet. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -LineURI + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Phone number for the analog device. The line URI should be specified by using the E.164 format, and should be prefixed by the "TEL:" prefix. For example: @@ -161,8 +157,7 @@ Any extension number should be added to the end of the line URI; for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,14 +167,16 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a contact object through the pipeline that represents the third-party video system being modified. By default, the `Set-CsThirdPartyVideoSystem` cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,6 +186,9 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier that allows the video system to communicate with SIP devices such as Skype for Business. The SIP address must be prefaced by the prefix "sip:". For example: @@ -198,8 +198,25 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -229,12 +248,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact The `Set-CsThirdPartyVideoSystem` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object. ## OUTPUTS -### +### None By default, the `Set-CsThirdPartyVideoSystem` cmdlet does not return any data or objects. However, if you include the PassThru parameter the cmdlet will pass instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object through the pipeline. diff --git a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystemPolicy.md similarity index 89% rename from skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystemPolicy.md index c59e5e1f93..f040034cb9 100644 --- a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystemPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsThirdPartyVideoSystemPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csthirdpartyvideosystempolicy +schema: 2.0.0 +title: Set-CsThirdPartyVideoSystemPolicy --- # Set-CsThirdPartyVideoSystemPolicy @@ -44,7 +45,7 @@ Both the global policy and any custom policies you create can later be modified ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsThirdPartyVideoSystemPolicy -Identity "RedmondVideoSystemPolicy" -SupportsSendingLowResolution $False ``` @@ -53,7 +54,7 @@ The command shown in Example 1 modifies the per-user third-party video system po In this example, the ability to send low-resolution video is disabled. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystemPolicy -Filter "site:*" | Set-CsThirdPartyVideoSystemPolicy -SupportsSendingLowResolution $False ``` @@ -65,30 +66,16 @@ That collection of site-based policies is then piped to the `Set-CsThirdPartyVid ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +85,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the policy when it was created. Third-party video system policies can be created at the global, site or per-user scope. To refer to the global instance, use this syntax: @@ -118,8 +108,7 @@ If this parameter is not specified then `Set-CsThirdPartyVideoSystemPolicy` will ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -129,13 +118,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,14 +136,16 @@ Accept wildcard characters: False ``` ### -SupportsSendingLowResolution + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not low-resolution video can be used in conjunction with a VTC device. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +155,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for the third-party video system policy being modified. For example: @@ -174,8 +170,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -185,13 +198,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -205,13 +220,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy The `Set-CsThirdPartyVideoSystemPolicy` cmdlet accepts pipelined instance of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsThirdPartyVideoSystemPolicy` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrunkConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTrunkConfiguration.md index d679673e79..4113e4bd73 100644 --- a/skype/skype-ps/skype/Set-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstrunkconfiguration +schema: 2.0.0 +title: Set-CsTrunkConfiguration --- # Set-CsTrunkConfiguration @@ -55,7 +56,7 @@ These settings configure such things as whether media bypass is enabled on this ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsTrunkConfiguration -Identity site:Redmond -EnableBypass $True ``` @@ -65,7 +66,7 @@ Media bypass is enabled by assigning the value $True to the EnableBypass paramet The remaining properties for this configuration will retain their existing values. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsOutboundTranslationRule -Identity site:Redmond/OTR1 -Translation '$1' ``` @@ -75,7 +76,7 @@ Notice that we don't actually make a call to the `Set-CsTrunkConfiguration` cmdl Changes made using the `Set-CsOutboundTranslationRule` cmdlet will be automatically reflected in the trunk configuration with an Identity matching the scope portion of the Identity of the outbound translation rule. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsTrunkConfiguration -Filter site:* | Set-CsTrunkConfiguration -SRTPMode "Optional" ``` @@ -85,7 +86,7 @@ The first part of the command is a call to the `Get-CsTrunkConfiguration` cmdlet This collection of configurations is then piped to the `Set-CsTrunkConfiguration` cmdlet, which sets the SRTPMode property of each to Optional. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Set-CsTrunkConfiguration -Identity site:Redmond -EnablePIDFLOSupport $True ``` @@ -98,43 +99,30 @@ You must set EnablePIDFLOSupport to True in order for location information to be ## PARAMETERS -### -Identity -A unique identifier that includes the scope of the trunk configuration. -Trunk configurations can exist at the Global scope, the Site scope, or at the Service scope for a PSTN Gateway service. -For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` +### -AcceptGatewayPAIForOutboundCalls -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -This parameter requires an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration, which can be retrieved by calling the `Get-CsTrunkConfiguration` cmdlet. +Set this parameter to True ($true) to modify the trunk configuration to display forwarded number for different trunks. +This parameter was introduced in the January 2019 cumulative update, for more information see [Incorrect caller ID is shown on the Skype for Business client in a call-forwarding scenario](https://support.microsoft.com/help/4458692/incorrect-caller-id-shown-on-the-skype-for-business-client-in-a-call) ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: True (ByValue) +Default value: False +Accept pipeline input: False Accept wildcard characters: False ``` + ### -ConcentratedTopology + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value of this parameter determines whether there is a well-known media termination point. (An example of a well-known media termination point would be a PSTN gateway where the media termination has the same IP as the signaling termination.) Set this value to False if the trunk does not have a well-known media termination point. @@ -143,8 +131,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,13 +141,36 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string describing the purpose of the trunk configuration. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable3pccRefer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the 3pcc protocol can be used to allow transferred calls to bypass the hosted site. +3pcc is also known as "third party control" and occurs when a third-party is used to connect a pair of callers (for example, an operator placing a call from person A to person B). +The REFER method is a standard SIP method which indicates that the recipient should contact a third-party by using information supplied by the sender. +The default value is False ($False). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -170,6 +180,9 @@ Accept wildcard characters: False ``` ### -EnableBypass + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value of this parameter determines whether media bypass is enabled for this trunk. Set this value to True to enable bypass. Note that in order for the media bypass to work successfully, certain capabilities must be supported by PSTN gateways, SBCs, and PBXs, including: @@ -194,8 +207,7 @@ 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 +Aliases: Required: False Position: Named @@ -204,16 +216,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMobileTrunkSupport -Defines whether the service provider is a mobile carrier. +### -EnableFastFailoverTimer -Default: False +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, outbound calls that are not answered by the gateway within 10 seconds will be routed to the next available trunk; if there are no additional trunks then the call will automatically be dropped. +In an organization with slow networks and gateway responses, that could potentially result in calls being dropped unnecessarily. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,18 +237,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePIDFLOSupport -Defines whether to route emergency calls with Presence Information Data Format Location Object (PIDF-LO) through the defined gateway. -Set this parameter to True if emergency calls are to be routed to a certified emergency services provider. -(The location will be transmitted with the call.) +### -EnableLocationRestriction -Default: False +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, location-based voice routing will be enabled for calls passing through the SIP trunks managed by the specified collection of SIP trunk configuration settings. +With location-based voice routing, the locations of both the user making the call and the user receiving the call are taken into account when calls are routed. +If this property is set to True (the default value is False) then you should also set the NetworkSiteId property. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -242,23 +257,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReferSupport -Defines whether this trunk supports receiving Refer requests from the Mediation Server. - -Media bypass can be enabled only under the following circumstances: +### -EnableMobileTrunkSupport -- The ConcentratedTopology parameter is set to True -- The EnableReferSupport parameter is set to False and RTCPActiveCalls and RTCPCallsOnHold are set to False, or EnableReferSupport is set to True +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that if EnableBypass is True and EnableReferSupport is False, bypass calls that are subsequently transferred will become non-bypass. +Defines whether the service provider is a mobile carrier. -Default: True +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 +Aliases: Required: False Position: Named @@ -267,20 +277,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSessionTimer -Specifies whether the session timer is enabled. -Session timers are used to determine whether a particular session is still active. +### -EnableOnlineVoice -Note that even if this parameter is set to False, session timers can be applicable if the remote connection has session timer enabled. -In such a case, the Mediation Server will reply to session timer probes from the remote entity. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the SIP trunks support online voice. +With online voice, users have an on-premises Lync Server account but have their voicemail hosted by Skype for Business Online. +The default value is False ($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 +Aliases: Required: False Position: Named @@ -289,18 +298,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSignalBoost -When this parameter is set to True the PSTN gateway, IP-PBX or SBC at the service provider will boost the audio volume in voice streams that are sent to the Mediation Server or Skype for Business Server clients. -If this value is set to False, audio will be boosted either at the Mediation Server (for non-bypass calls) or in Skype for Business Server clients (for bypass calls). +### -EnablePIDFLOSupport -Default: False +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Defines whether to route emergency calls with Presence Information Data Format Location Object (PIDF-LO) through the defined gateway. +Set this parameter to True if emergency calls are to be routed to a certified emergency services provider. +(The location will be transmitted with the call.) + +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 +Aliases: Required: False Position: Named @@ -309,16 +320,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEarlyDialogs -The maximum number of forked responses a PSTN gateway, IP-PBX, or SBC at the service provider can receive to an Invite that it sent to the Mediation Server. +### -EnableReferSupport -Default: 20 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Defines whether this trunk supports receiving Refer requests from the Mediation Server. + +Media bypass can be enabled only under the following circumstances: + +- The ConcentratedTopology parameter is set to True +- The EnableReferSupport parameter is set to False and RTCPActiveCalls and RTCPCallsOnHold are set to False, or EnableReferSupport is set to True + +Note that if EnableBypass is True and EnableReferSupport is False, bypass calls that are subsequently transferred will become non-bypass. + +Default: True ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -327,19 +347,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundTranslationRulesList -A collection of phone number translation rules that apply to calls handled by Outbound Routing (calls routed to PBX or PSTN destinations). +### -EnableRTPLatching -While this list and these rules can be modified directly with this cmdlet, we recommend that you modify the outbound translation rules with the `Set-CsOutboundTranslationRule` cmdlet. -The `Set-CsOutboundTranslationRule` cmdlet will modify the rule and these modifications will be automatically reflected in the trunk configuration. -To modify the trunk configuration by adding a new outbound translation rule, call the `New-CsOutboundTranslationRule` cmdlet; the new rule will be added to the trunk configuration with the matching scope. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether or not the SIP trunks support RTP latching. +RTP latching is a technology that enables RTP/RTCP connectivity through a NAT (network address translator) device or firewall. +The default value is False ($False). ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -348,16 +367,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemovePlusFromUri -Setting this parameter to True will cause the Mediation Server to remove leading plus signs (+) from Uniform Resources Identifiers (URIs) before sending them on to the service provider. +### -EnableSessionTimer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether the session timer is enabled. +Session timers are used to determine whether a particular session is still active. + +Note that even if this parameter is set to False, session timers can be applicable if the remote connection has session timer enabled. +In such a case, the Mediation Server will reply to session timer probes from the remote entity. 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 +Aliases: Required: False Position: Named @@ -366,21 +391,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RTCPActiveCalls -This parameter determines whether RTCP packets are sent from the PSTN gateway, IP-PBX or SBC at the service provider for active calls. -An active call in this context is a call where media is allowed to flow in at least one direction. -If RTCPActiveCalls is set to True, the Mediation Server or Skype for Business Server client can terminate a call if it does not receive RTCP packets for a period exceeding 30 seconds. +### -EnableSignalBoost -Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: True +When this parameter is set to True the PSTN gateway, IP-PBX or SBC at the service provider will boost the audio volume in voice streams that are sent to the Mediation Server or Skype for Business Server clients. +If this value is set to False, audio will be boosted either at the Mediation Server (for non-bypass calls) or in Skype for Business Server clients (for bypass calls). + +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 +Aliases: Required: False Position: Named @@ -389,21 +413,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RTCPCallsOnHold -This parameter determines whether RTCP packets continue to be sent across the trunk for calls that have been placed on hold and no media packets are expected to flow in either direction. -If Music on Hold is enabled at either the Skype for Business Server client or the trunk, the call will be considered to be active and this property will be ignored. -In these circumstances use the RTCPActiveCalls parameter. - -Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. +### -Force -Default: True +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -412,20 +431,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipResponseCodeTranslationRulesList -A list of SIP response code translation rules that apply to response codes received from a PSTN gateway, IP-PBX or SBC at the service provider. -These rules allow the administrator to map SIP response codes with values between 400 and 699 received over a trunk to new values more consistent with Skype for Business Server. +### -ForwardAnonymousCallGatewayPAI -You can create this list and corresponding rules directly with this cmdlet. -However, we recommend that you create the SIP response code translation rules by calling the `New-CsSipResponseCodeTranslationRule` cmdlet. -That cmdlet will create the rule and assign it to the trunk configuration with the matching scope. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +If an anonymous call is forwarded to an outgoing PSTN call, this parameter indicates whether the incoming P-Asserted-Identity (PAI) header at the Gateway call will be preserved in the PSTN call. The default value is **False** ($False). +**Notes:** +- `EnablePAIPAssthrough` is deprecated in favor of `ForwardAnonymousCallGatewayPAI`. This change is made by installing KB5016483. +- When `ForwardAnonymousCallGatewayPAI` is used, `ForwardPAI` must be set to **True**. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -434,28 +453,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SRTPMode -The value of this parameter determines the level of support for SRTP to protect media traffic between the Mediation Server and the PSTN gateway, IP-PBX, or SBC at the service provider. -For media bypass cases, this value must be compatible with the EncryptionLevel setting in the media configuration. -Media configuration is set by using the `New-CsMediaConfiguration` cmdlet and the `Set-CsMediaConfiguration` cmdlet. - -Valid values: - -- Required: SRTP encryption must be used. -- Optional: SRTP will be used if the service provider supports it. -- NotSupported: SRTP encryption is not supported and therefore will not be used. +### -ForwardCallHistory -Note: SRTPMode is used only if the gateway is configured to use Transport Layer Security (TLS). -If the gateway is configured with Transmission Control Protocol (TCP) as the transport, SRTPMode is internally set to NotSupported. - -Default: Required +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether call history information will be forwarded through the trunk. +The default value is False ($False). ```yaml -Type: SRTPMode +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -464,14 +472,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -ForwardPAI + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. +The PAI header provides a way to verify the identity of the caller. +The default value is False ($False). ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -480,49 +492,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier that includes the scope of the trunk configuration. +Trunk configurations can exist at the Global scope, the Site scope, or at the Service scope for a PSTN Gateway service. +For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). ```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 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +This parameter requires an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration, which can be retrieved by calling the `Get-CsTrunkConfiguration` cmdlet. ```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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Enable3pccRefer -Indicates whether the 3pcc protocol can be used to allow transferred calls to bypass the hosted site. -3pcc is also known as "third party control" and occurs when a third-party is used to connect a pair of callers (for example, an operator placing a call from person A to person B). -The REFER method is a standard SIP method which indicates that the recipient should contact a third-party by using information supplied by the sender. -The default value is False ($False). +### -MaxEarlyDialogs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum number of forked responses a PSTN gateway, IP-PBX, or SBC at the service provider can receive to an Invite that it sent to the Mediation Server. + +Default: 20 ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -531,17 +552,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFastFailoverTimer -When set to True, outbound calls that are not answered by the gateway within 10 seconds will be routed to the next available trunk; if there are no additional trunks then the call will automatically be dropped. -In an organization with slow networks and gateway responses, that could potentially result in calls being dropped unnecessarily. +### -NetworkSiteID -The default value is True. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Site ID of the network site associated with the collection of trunk configuration settings. +If the EnableLocationRestriction property is set to True then location-based voice routing through this trunk will be managed by using the settings configured for the specified site. +Network site IDs can be retrieved by using this command: + +`Get-CsNetworkSite | Select NetworkSiteID` ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -550,17 +574,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineVoice -Indicates whether the SIP trunks support online voice. -With online voice, users have an on-premises Lync Server account but have their voicemail hosted by Skype for Business Online. -The default value is False ($False). +### -OutboundCallingNumberTranslationRulesList +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of outbound calling number translation rules assigned to the trunk. +You can retrieve information about the available rules by running this command: + +`Get-CsOutboundCallingNumberTranslationRule` ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -569,16 +595,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRTPLatching -Indicates whether or not the SIP trunks support RTP latching. -RTP latching is a technology that enables RTP/RTCP connectivity through a NAT (network address translator) device or firewall. -The default value is False ($False). +### -OutboundTranslationRulesList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A collection of phone number translation rules that apply to calls handled by Outbound Routing (calls routed to PBX or PSTN destinations). + +While this list and these rules can be modified directly with this cmdlet, we recommend that you modify the outbound translation rules with the `Set-CsOutboundTranslationRule` cmdlet. +The `Set-CsOutboundTranslationRule` cmdlet will modify the rule and these modifications will be automatically reflected in the trunk configuration. +To modify the trunk configuration by adding a new outbound translation rule, call the `New-CsOutboundTranslationRule` cmdlet; the new rule will be added to the trunk configuration with the matching scope. + ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -587,15 +618,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardCallHistory -Indicates whether call history information will be forwarded through the trunk. -The default value is False ($False). +### -PstnUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of PSTN usages assigned to the trunk. +You can retrieve information about the available usages by running this command: + +`Get-CsPstnUsage` ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -604,16 +639,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardPAI -Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. -The PAI header provides a way to verify the identity of the caller. -The default value is False ($False). +### -RemovePlusFromUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Setting this parameter to True will cause the Mediation Server to remove leading plus signs (+) from Uniform Resources Identifiers (URIs) before sending them on to the service provider. + +Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -622,18 +659,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardAnonymousCallGatewayPAI -If an anonymous call is forwarded to an outgoing PSTN call, this parameter indicates whether the incoming P-Asserted-Identity (PAI) header at the Gateway call will be preserved in the PSTN call. The default value is **False** ($False). +### -RTCPActiveCalls + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter determines whether RTCP packets are sent from the PSTN gateway, IP-PBX or SBC at the service provider for active calls. +An active call in this context is a call where media is allowed to flow in at least one direction. +If RTCPActiveCalls is set to True, the Mediation Server or Skype for Business Server client can terminate a call if it does not receive RTCP packets for a period exceeding 30 seconds. + +Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. + +Default: True -**Notes:** -- `EnablePAIPAssthrough` is deprecated in favor of `ForwardAnonymousCallGatewayPAI`. This change is made by installing KB5016483. -- When `ForwardAnonymousCallGatewayPAI` is used, `ForwardPAI` must be set to **True**. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -642,17 +684,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundCallingNumberTranslationRulesList -Collection of outbound calling number translation rules assigned to the trunk. -You can retrieve information about the available rules by running this command: +### -RTCPCallsOnHold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter determines whether RTCP packets continue to be sent across the trunk for calls that have been placed on hold and no media packets are expected to flow in either direction. +If Music on Hold is enabled at either the Skype for Business Server client or the trunk, the call will be considered to be active and this property will be ignored. +In these circumstances use the RTCPActiveCalls parameter. + +Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. + +Default: True -`Get-CsOutboundCallingNumberTranslationRule` ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -661,17 +709,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsages -Collection of PSTN usages assigned to the trunk. -You can retrieve information about the available usages by running this command: +### -SipResponseCodeTranslationRulesList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A list of SIP response code translation rules that apply to response codes received from a PSTN gateway, IP-PBX or SBC at the service provider. +These rules allow the administrator to map SIP response codes with values between 400 and 699 received over a trunk to new values more consistent with Skype for Business Server. + +You can create this list and corresponding rules directly with this cmdlet. +However, we recommend that you create the SIP response code translation rules by calling the `New-CsSipResponseCodeTranslationRule` cmdlet. +That cmdlet will create the rule and assign it to the trunk configuration with the matching scope. -`Get-CsPstnUsage` ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -680,16 +733,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationRestriction -When set to True, location-based voice routing will be enabled for calls passing through the SIP trunks managed by the specified collection of SIP trunk configuration settings. -With location-based voice routing, the locations of both the user making the call and the user receiving the call are taken into account when calls are routed. -If this property is set to True (the default value is False) then you should also set the NetworkSiteId property. +### -SRTPMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The value of this parameter determines the level of support for SRTP to protect media traffic between the Mediation Server and the PSTN gateway, IP-PBX, or SBC at the service provider. +For media bypass cases, this value must be compatible with the EncryptionLevel setting in the media configuration. +Media configuration is set by using the `New-CsMediaConfiguration` cmdlet and the `Set-CsMediaConfiguration` cmdlet. + +Valid values: + +- Required: SRTP encryption must be used. +- Optional: SRTP will be used if the service provider supports it. +- NotSupported: SRTP encryption is not supported and therefore will not be used. + +Note: SRTPMode is used only if the gateway is configured to use Transport Layer Security (TLS). +If the gateway is configured with Transmission Control Protocol (TCP) as the transport, SRTPMode is internally set to NotSupported. + +Default: Required + ```yaml -Type: Boolean +Type: SRTPMode Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -698,18 +765,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID -Site ID of the network site associated with the collection of trunk configuration settings. -If the EnableLocationRestriction property is set to True then location-based voice routing through this trunk will be managed by using the settings configured for the specified site. -Network site IDs can be retrieved by using this command: +### -Confirm -`Get-CsNetworkSite | Select NetworkSiteID` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -718,36 +783,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptGatewayPAIForOutboundCalls -Set this parameter to True ($true) to modify the trunk configuration to display forwarded number for different trunks. -This parameter was introduced in the January 2019 cumulative update, for more information see [Incorrect caller ID is shown on the Skype for Business client in a call-forwarding scenario](https://support.microsoft.com/help/4458692/incorrect-caller-id-shown-on-the-skype-for-business-client-in-a-call) +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named -Default value: 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 -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration + Accepts pipelined input of trunk configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value; it modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplication.md similarity index 85% rename from skype/skype-ps/skype/Set-CsTrustedApplication.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplication.md index 5decd88312..6f727d87dd 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTrustedApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstrustedapplication +schema: 2.0.0 +title: Set-CsTrustedApplication --- # Set-CsTrustedApplication @@ -38,7 +39,7 @@ While this prefix is part of the Identity, it's not required when you specify th ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 -Port 6200 ``` @@ -51,15 +52,35 @@ We then include the Port parameter, giving it a value of 6200 to modify that val ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the trusted application you want to modify. Identity values must be entered in the format \/\, where pool FQDN is the FQDN of the pool on which the application resides, and application ID is the name of the application. ```yaml Type: ExternalApplicationIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -69,13 +90,15 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The port number on which the application will run. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -84,14 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -101,29 +126,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -137,13 +148,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.DisplayTrustedApplication object. +### Microsoft.Rtc.Management.Xds.DisplayTrustedApplication + Accepts pipelined input of trusted application objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplication. diff --git a/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationEndpoint.md similarity index 79% rename from skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationEndpoint.md index 505d5b29a7..f686ac803e 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTrustedApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstrustedapplicationendpoint +schema: 2.0.0 +title: Set-CsTrustedApplicationEndpoint --- # Set-CsTrustedApplicationEndpoint @@ -35,7 +36,7 @@ This cmdlet modifies an existing endpoint contact object in Active Directory Dom ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsTrustedApplicationEndpoint -Identity "sip:endpoint1@litwareinc.com" -DisplayName "Endpoint 1" ``` @@ -45,7 +46,7 @@ Notice that the Identity value begins with the string sip: followed by the SIP a The next parameter, DisplayName, is given a value of "Endpoint 1", which changes the display name of the contact to that value. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrustedApplicationEndpoint -Identity "Endpoint 1" | Set-CsTrustedApplicationEndpoint -DisplayNumber "(425)555-1212" ``` @@ -58,30 +59,16 @@ This object is then piped to the `Set-CsTrustedApplicationEndpoint` cmdlet, whic ## PARAMETERS -### -Identity -The Identity (the distinguished name) or the SIP address of the application endpoint to be modified. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DisplayName -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DisplayName The display name of the endpoint contact object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +78,15 @@ Accept wildcard characters: False ``` ### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The telephone number of the contact as it will appear in the Address Book. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +96,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether the contact is enabled for Skype for Business Server. Default: True @@ -116,7 +108,6 @@ Default: True 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 @@ -126,6 +117,9 @@ Accept wildcard characters: False ``` ### -EnabledForFederation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether federated users have access to this contact. Default: False @@ -133,8 +127,7 @@ 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 +Aliases: Required: False Position: Named @@ -144,6 +137,9 @@ Accept wildcard characters: False ``` ### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether the contact is enabled for Enterprise Voice. Default: True @@ -151,8 +147,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,15 +156,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -The phone number of the contact. -Must be in the format TEL:\, for example TEL:+14255551212. +### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the contact's instant messaging sessions are archived. +Allowed values are: + +* Uninitialized +* UseLyncArchivingPolicy +* ArchivingToExchange +* NoArchiving ```yaml -Type: String +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,16 +180,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrimaryLanguage -The primary language used for the trusted application. -The language must be configured using a valid language code, such as en-US (U.S. -English), fr-FR (French), etc. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity (the distinguished name) or the SIP address of the application endpoint to be modified. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The phone number of the contact. +Must be in the format TEL:\, for example TEL:+14255551212. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,16 +217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryLanguages -A collection of languages that can also be used for trusted applications. -Values must be configured as a comma-separated values list of language codes. -For example, the following syntax sets French Canadian and French as secondary languages: `-SecondaryLanguages "fr-CA","fr-FR"`. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Including this parameter will cause the cmdlet to not only modify the contact object but will return the new object as output. ```yaml -Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -214,15 +235,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -You cannot modify the SIP address of a contact. -The SIP address is assigned when the application endpoint is created. +### -PrimaryLanguage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The primary language used for the trusted application. +The language must be configured using a valid language code, such as en-US (U.S. +English), fr-FR (French), etc. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,14 +255,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -This parameter is not used with this cmdlet. +### -SecondaryLanguages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A collection of languages that can also be used for trusted applications. +Values must be configured as a comma-separated values list of language codes. +For example, the following syntax sets French Canadian and French as secondary languages: `-SecondaryLanguages "fr-CA","fr-FR"`. ```yaml -Type: String +Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,14 +275,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Including this parameter will cause the cmdlet to not only modify the contact object but will return the new object as output. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +You cannot modify the SIP address of a contact. +The SIP address is assigned when the application endpoint is created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -263,14 +294,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Type + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -280,13 +313,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -295,20 +330,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the contact's instant messaging sessions are archived. -Allowed values are: +### -WhatIf -* Uninitialized -* UseLyncArchivingPolicy -* ArchivingToExchange -* NoArchiving +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -322,13 +353,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact + Accepts pipelined input of trusted application endpoint objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact. diff --git a/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationPool.md similarity index 79% rename from skype/skype-ps/skype/Set-CsTrustedApplicationPool.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationPool.md index aa6bd0be59..197f4ff565 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTrustedApplicationPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstrustedapplicationpool +schema: 2.0.0 +title: Set-CsTrustedApplicationPool --- # Set-CsTrustedApplicationPool @@ -36,7 +37,7 @@ Note that you can't modify the computers that are associated with a pool by usin ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -OutboundOnly $True ``` @@ -49,30 +50,16 @@ This example modifies the OutboundOnly property of the pool by specifying a valu ## PARAMETERS -### -Identity -The fully qualified domain name (FQDN) or service ID of the pool whose settings you want to modify. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AppSharingPortCount -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AppSharingPortCount The number of ports available in the port range for application sharing connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -82,13 +69,15 @@ Accept wildcard characters: False ``` ### -AppSharingPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for application sharing connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,13 +87,15 @@ Accept wildcard characters: False ``` ### -AudioPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of ports available in the port range for audio connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,13 +105,15 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for audio connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,15 +122,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) or service ID of the pool whose settings you want to modify. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OutboundOnly + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether a trusted application can initiate a connection to a server within the pool. Set this value to True if you want all connections to be initiated by the server rather than the application. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +178,9 @@ Accept wildcard characters: False ``` ### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The service ID or FQDN of the Registrar service for the pool. Note that changing the Registrar will orphan any contacts attached to the application. Those contacts must be moved by calling the `Move-CsApplicationEndpoint` cmdlet. @@ -154,8 +188,7 @@ Those contacts must be moved by calling the `Move-CsApplicationEndpoint` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,6 +198,9 @@ Accept wildcard characters: False ``` ### -RequiresReplication + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether replication is required for this pool. Set this value to False if replication is not required. You would ordinarily set this parameter to False for Microsoft Outlook Web Access and manually-provisioned applications. @@ -173,8 +209,7 @@ You would ordinarily set this parameter to False for Microsoft Outlook Web Acces ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,6 +219,9 @@ Accept wildcard characters: False ``` ### -ThrottleAsServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Set this parameter to false to throttle connections between the servers within the pool and trusted applications as clients. This places greater restrictions on the connections than the default True, which throttles connections as servers. Throttling a connection simply places restrictions on the number of transactions that can occur simultaneously. @@ -191,8 +229,7 @@ Throttling a connection simply places restrictions on the number of transactions ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +239,9 @@ Accept wildcard characters: False ``` ### -TreatAsAuthenticated + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether authentication is required for trusted applications connecting to servers within the pool. Set this parameter to False if you want to require trusted applications to be authenticated. The default value of True allows the trusted applications to connect under the assumption they've already been authenticated. @@ -209,8 +249,7 @@ The default value of True allows the trusted applications to connect under the a ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,13 +259,15 @@ Accept wildcard characters: False ``` ### -VideoPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of ports available in the port range for video connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,13 +277,15 @@ Accept wildcard characters: False ``` ### -VideoPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for video connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,14 +294,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -268,29 +313,15 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -304,13 +335,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.DisplayExternalServer object. +### Microsoft.Rtc.Management.Xds.DisplayExternalServer + Accepts pipelined input of trusted application pool objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. diff --git a/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsUCPhoneConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUCPhoneConfiguration.md index 5a7d9ecb84..35d0a6a56c 100644 --- a/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUCPhoneConfiguration.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Set-CsUCPhoneConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csucphoneconfiguration +schema: 2.0.0 +title: Set-CsUCPhoneConfiguration --- # Set-CsUCPhoneConfiguration @@ -58,7 +60,7 @@ The following parameters are not applicable to Skype for Business Online: Calend ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsUCPhoneConfiguration -Identity global -SIPSecurityMode "Medium" ``` @@ -66,7 +68,7 @@ Set-CsUCPhoneConfiguration -Identity global -SIPSecurityMode "Medium" The command shown in Example 1 sets the SIP security mode of the global UC phone settings to Medium. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsUCPhoneConfiguration -Identity site:Redmond -PhoneLockTimeout "00:30:00" ``` @@ -75,7 +77,7 @@ Example 2 modifies the UC phone settings configured for the Redmond site. In this case, the PhoneLockTimeout property is set to 30 minutes; this is done by including the PhoneLockTimeout parameter and the parameter value "00:30:00" (00 hours: 30 minutes: 00 seconds). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUCPhoneConfiguration -Filter "site:*" | Set-CsUCPhoneConfiguration -PhoneLockTimeout "00:30:00" ``` @@ -86,7 +88,7 @@ To do this, the command starts off by calling the `Get-CsUCPhoneConfiguration` c This filtered collection is then piped to the `Set-CsUCPhoneConfiguration` cmdlet, which uses the PhoneLockTimeout parameter and the parameter value "00:30:00" (00 hours: 30 minutes: 00 seconds) to set the phone lock timeout value for each item in the collection to 30 minutes. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.SIPSecurityMode -ne "High"} | Set-CsUCPhoneConfiguration -EnforcePhoneLock $True -PhoneLockTimeout "00:30:00" ``` @@ -96,7 +98,7 @@ To perform this task, the command first uses the `Get-CsUCPhoneConfiguration` cm (Because SIP security can only be set to Low, Medium, or High, this clause will select all the settings where SIPSecurityMode is set to either Low or Medium.) The filtered collection is then piped to the `Set-CsUCPhoneConfiguration` cmdlet, which uses the EnforcePhoneLock and the PhoneLockTimeout parameters to modify the phone locking and phone lock timeout properties. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.PhoneLockTimeout -lt "00:10:00"} | Set-CsUCPhoneConfiguration -PhoneLockTimeout "00:10:00" ``` @@ -109,89 +111,119 @@ In turn, the filtered collection is piped to the `Set-CsUCPhoneConfiguration` cm ## PARAMETERS -### -Identity -Represents the unique identifier assigned to the collection of UC phone configuration settings. -To refer to the global settings, use this syntax: +### -CalendarPollInterval -`-Identity global` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -To refer to a collection configured at the site scope use syntax similar to this: +Indicates how often the UC device retrieves information from your Outlook calendar. +The value must be specified using the format hours:minutes:seconds; for example, to set the time interval to 1 hour (the maximum allowed interval) use this syntax: `-CalendarPollInterval "01:00:00"`. +The default value is 3 minutes (00:03:00). -`-Identity site:Redmond` -Note that you cannot use wildcard characters when specifying an Identity. +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: -If this parameter is omitted, then the `Set-CsUCPhoneConfiguration` cmdlet will modify the global settings. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcePhoneLock + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether or not UC phones are automatically locked after the number of minutes specified by PhoneLockTimeout. +The default value is True. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```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 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -CalendarPollInterval -Indicates how often the UC device retrieves information from your Outlook calendar. -The value must be specified using the format hours:minutes:seconds; for example, to set the time interval to 1 hour (the maximum allowed interval) use this syntax: `-CalendarPollInterval "01:00:00"`. -The default value is 3 minutes (00:03:00). +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the unique identifier assigned to the collection of UC phone configuration settings. +To refer to the global settings, use this syntax: + +`-Identity global` + +To refer to a collection configured at the site scope use syntax similar to this: + +`-Identity site:Redmond` + +Note that you cannot use wildcard characters when specifying an Identity. + +If this parameter is omitted, then the `Set-CsUCPhoneConfiguration` cmdlet will modify the global settings. ```yaml -Type: TimeSpan -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 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnforcePhoneLock -Determines whether or not UC phones are automatically locked after the number of minutes specified by PhoneLockTimeout. -The default value is True. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -LoggingLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables logging on the UC device. Valid values are Off; Low; Medium and High. The default value is Off. @@ -200,8 +232,7 @@ The default value is Off. ```yaml Type: LoggingLevel 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 +Aliases: Required: False Position: Named @@ -211,6 +242,9 @@ Accept wildcard characters: False ``` ### -MinPhonePinLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the minimum number of digits required for personal identification numbers (PINs). Minimum value: 4 @@ -223,8 +257,7 @@ Default: 6 ```yaml Type: Byte 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 +Aliases: Required: False Position: Named @@ -234,6 +267,9 @@ Accept wildcard characters: False ``` ### -PhoneLockTimeout + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the length of time, in minutes, that a UC phone will remain idle before automatically locking. This value must be less than 01:00:00 (1 hour). @@ -243,8 +279,7 @@ The default value is 00:10:00 (10 minutes). ```yaml Type: TimeSpan 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 +Aliases: Required: False Position: Named @@ -254,6 +289,9 @@ Accept wildcard characters: False ``` ### -SIPSecurityMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the level of security that the server applies to SIP sessions initiated by a UC phone. Valid values are: @@ -270,8 +308,7 @@ The default value is High. ```yaml Type: SIPSecurityMode 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 +Aliases: Required: False Position: Named @@ -280,19 +317,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Voice8021p -Specifies the user priority value (the 802.1p value) for voice traffic within the Skype for Business Server deployment. +### -Tenant -This setting is effective only for networks in which switches and bridges are 802.1p-capable. -The minimum value for this property is 0 and the maximum value is 7. -The default value is 0. +> Applicable: Skype for Business Online +{{Fill Tenant Description}} ```yaml -Type: Byte +Type: Guid 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 +Aliases: Required: False Position: Named @@ -301,19 +335,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceDiffServTag -Specifies the decimal representation of the 6-bit DiffServ Code Point (DSCP) priority marking. -This marking defines the Per Hop Behavior (PHB) for IP packets passed by the UC phones that are managed by this server. +### -Voice8021p -This value must be between 0 and 63, inclusive. -The default value is 40. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the user priority value (the 802.1p value) for voice traffic within the Skype for Business Server deployment. + +This setting is effective only for networks in which switches and bridges are 802.1p-capable. +The minimum value for this property is 0 and the maximum value is 7. +The default value is 0. ```yaml Type: Byte 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 +Aliases: Required: False Position: Named @@ -322,32 +358,21 @@ 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. - +### -VoiceDiffServTag -```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 +> 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 -``` +Specifies the decimal representation of the 6-bit DiffServ Code Point (DSCP) priority marking. +This marking defines the Per Hop Behavior (PHB) for IP packets passed by the UC phones that are managed by this server. -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +This value must be between 0 and 63, inclusive. +The default value is 40. ```yaml -Type: SwitchParameter +Type: Byte 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 +Aliases: Required: False Position: Named @@ -357,6 +382,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -364,7 +392,6 @@ Prompts you for confirmation before executing the command. 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 @@ -373,14 +400,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -{{Fill Tenant Description}} +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -394,13 +424,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings + The `Set-CsUCPhoneConfiguration` cmdlet accepts pipelined instances of the UC phone settings object. ## OUTPUTS -### +### None The `Set-CsUCPhoneConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. diff --git a/skype/skype-ps/skype/Set-CsUICulture.md b/skype/skype-ps/SkypeForBusiness/Set-CsUICulture.md similarity index 89% rename from skype/skype-ps/skype/Set-CsUICulture.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUICulture.md index e596429fed..507f33bc33 100644 --- a/skype/skype-ps/skype/Set-CsUICulture.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUICulture.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuiculture applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUICulture -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuiculture +schema: 2.0.0 +title: Set-CsUICulture --- # Set-CsUICulture @@ -44,7 +45,7 @@ For example, if you originally installed an Italian version of Skype for Busines ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsUICulture -Culture "en-US" ``` @@ -54,7 +55,7 @@ English. This is done by using the language code en-US. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsUICulture -Culture "default" ``` @@ -66,6 +67,9 @@ The default value is the culture setting used when you originally installed Skyp ## PARAMETERS ### -Culture + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify the culture used for the Lync Server Management Shell. Set the culture to "en-US" for U.S. English, or set the culture to "default" to use the language used when you originally installed Skype for Business Server. @@ -74,8 +78,7 @@ English, or set the culture to "default" to use the language used when you origi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -84,14 +87,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -100,14 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -121,13 +128,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsUICulture` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsUICulture` cmdlet does not return any values or objects. Instead, the cmdlet modifies existing instances of the System.Globalization.CultureInfo class. diff --git a/skype/skype-ps/skype/Set-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/Set-CsUnassignedNumber.md similarity index 85% rename from skype/skype-ps/skype/Set-CsUnassignedNumber.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUnassignedNumber.md index 404dd230e4..2c974462fe 100644 --- a/skype/skype-ps/skype/Set-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUnassignedNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUnassignedNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csunassignednumber +schema: 2.0.0 +title: Set-CsUnassignedNumber --- # Set-CsUnassignedNumber @@ -65,7 +66,7 @@ To check Exchange Auto Attendant settings, run the `Get-CsExUmContact` cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsUnassignedNumber -Identity UNSet1 -NumberRangeStart "+14255551000" -NumberRangeEnd "+14255551900" ``` @@ -75,7 +76,7 @@ We first pass the Identity parameter the value UNSet1, the name of the unassigne We then use the NumberRangeStart (+14255551000) and NumberRangeEnd (+14255551900) parameters to modify the range of unassigned numbers to which the specified announcement or Auto Attendant will apply. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUnassignedNumber | Where-Object {$_.AnnouncementName -match "Welcome"} | Set-CsUnassignedNumber -AnnouncementService ApplicationServer:redmond.litwareinc.com -AnnouncementName "Help Desk Announcement" ``` @@ -89,47 +90,16 @@ Note that even if the new Announcement has a different name but the same service ## PARAMETERS -### -Identity -The unique name for the range of unassigned numbers being modified. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: RangeSpecification, AnnouncementService, Identity, AutoAttendant -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -A reference to an object containing unassigned number settings. -This object must be of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange and can be retrieved by calling the `Get-CsUnassignedNumber` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: RangeSpecification, AnnouncementService, AutoAttendant, Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AnnouncementName -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AnnouncementName The name of the Announcement that will be used to handle calls to this range of numbers. ```yaml Type: String Parameter Sets: AnnouncementService -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 6 @@ -139,13 +109,15 @@ Accept wildcard characters: False ``` ### -AnnouncementService + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The fully qualified domain name (FQDN) or service ID of the Announcement server. ```yaml Type: String Parameter Sets: AnnouncementService Aliases: AnnouncementServerFqdn -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 5 @@ -155,6 +127,9 @@ Accept wildcard characters: False ``` ### -ExUmAutoAttendantPhoneNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number of the Exchange Auto Attendant to route calls in this range to. The Skype for Business Auto Attendant contact must already be set up in order to assign a value to this parameter. @@ -162,8 +137,7 @@ The Skype for Business Auto Attendant contact must already be set up in order to ```yaml Type: String Parameter Sets: AutoAttendant -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 5 @@ -172,28 +146,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberRangeStart -The first number in the range of unassigned numbers. -Must be less than or equal to the value supplied for NumberRangeEnd. +### -Force -The number must match the regular expression (tel:)?(\+)?\[1-9\]\d{0,17}(;ext=\[1-9\]\d{0,9})?. -This means the number may begin with the string tel: (if you don't specify that string it will be automatically added for you), a plus sign (+) and a digit 1 through 9. -The phone number can be up to 17 digits and may be followed by an extension in the format ;ext= followed by the extension number. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String -Parameter Sets: RangeSpecification, AnnouncementService, AutoAttendant -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique name for the range of unassigned numbers being modified. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: RangeSpecification, AnnouncementService, Identity, AutoAttendant +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to an object containing unassigned number settings. +This object must be of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange and can be retrieved by calling the `Get-CsUnassignedNumber` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: RangeSpecification, AnnouncementService, AutoAttendant, Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -NumberRangeEnd + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The last number in the range of unassigned numbers. Must be greater than or equal to the number supplied for NumberRangeStart. To specify a range of one number, use the same number for the NumberRangeStart and NumberRangeEnd. @@ -205,8 +216,7 @@ The phone number can be up to 17 digits and may be followed by and extension in ```yaml Type: String Parameter Sets: RangeSpecification, AnnouncementService, AutoAttendant -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 4 @@ -215,32 +225,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -It is possible for unassigned number ranges to overlap. -If a number falls within more than one range, the range with the highest priority will take effect. +### -NumberRangeStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The first number in the range of unassigned numbers. +Must be less than or equal to the value supplied for NumberRangeEnd. +The number must match the regular expression (tel:)?(\+)?\[1-9\]\d{0,17}(;ext=\[1-9\]\d{0,9})?. +This means the number may begin with the string tel: (if you don't specify that string it will be automatically added for you), a plus sign (+) and a digit 1 through 9. +The phone number can be up to 17 digits and may be followed by an extension in the format ;ext= followed by the extension 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 +Type: String +Parameter Sets: RangeSpecification, AnnouncementService, AutoAttendant +Aliases: Required: False -Position: Named +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +It is possible for unassigned number ranges to overlap. +If a number falls within more than one range, the range with the highest priority will take effect. + ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -249,14 +268,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -265,14 +286,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -286,13 +309,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange object. +### Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange + Accepts pipelined input of unassigned number objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange. diff --git a/skype/skype-ps/skype/Set-CsUser.md b/skype/skype-ps/SkypeForBusiness/Set-CsUser.md similarity index 88% rename from skype/skype-ps/skype/Set-CsUser.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUser.md index 6578b30a14..51c80c06c1 100644 --- a/skype/skype-ps/skype/Set-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUser.md @@ -1,13 +1,15 @@ --- -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 Server 2015, Skype for Business Server 2019 -title: Set-CsUser -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuser +schema: 2.0.0 +title: Set-CsUser --- # Set-CsUser @@ -42,7 +44,7 @@ You should not attempt to manually configure these attributes. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Set-CsUser -Identity "Pilar Ackerman" -EnterpriseVoiceEnabled $True ``` @@ -52,7 +54,7 @@ In this case, the account is modified to enable Enterprise Voice, the Microsoft This task is carried out by adding the EnterpriseVoiceEnabled parameter, and then setting the parameter value to $True. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsUser -LdapFilter "Department=Finance" | Set-CsUser -EnterpriseVoiceEnabled $True ``` @@ -61,7 +63,7 @@ In Example 2, all the users in the Finance department have their accounts enable 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 -------------------------- +### Example 3 ```powershell Set-CsUser -Identity "Pilar Ackerman" -LineUri "tel:+123456789" ``` @@ -71,28 +73,29 @@ In this case, the account is modified to set the phone number assigned to the us ## 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. +### -AcpInfo -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". +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: UserIdParameter +Type: AcpInfo 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 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -AudioVideoDisabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -104,7 +107,25 @@ You cannot disable A/V communications if a user is currently enabled for remote 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 +``` + +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: Required: False Position: Named @@ -114,6 +135,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -126,7 +150,6 @@ When you run the `Disable-CsUser` cmdlet, all the Skype for Business Server data 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 @@ -135,15 +158,19 @@ 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. +### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. ```yaml -Type: Fqdn +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 @@ -152,17 +179,25 @@ 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. +### -ExchangeArchivingPolicy -**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the user's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving ```yaml -Type: Boolean +Type: ExchangeArchivingPolicyOptionsEnum 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 @@ -172,6 +207,9 @@ Accept wildcard characters: False ``` ### -HostedVoiceMail + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -181,7 +219,6 @@ In addition, setting this option to True enables Skype for Business users to dir 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 @@ -190,36 +227,33 @@ 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. +### -Identity -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. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -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. +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. -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 +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: String +Type: UserIdParameter 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 +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -LineServerURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -228,7 +262,6 @@ For example: sip:rccgateway@litwareinc.com 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 @@ -237,20 +270,29 @@ 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. +### -LineURI -The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. -For example: tel:+14255551297. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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 Required: False Position: Named @@ -259,38 +301,29 @@ 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. +### -OnPremLineURI -To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. +> Applicable: Skype for Business Online -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +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. -### -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`. +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. + +**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. ```yaml Type: String 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 @@ -300,6 +333,9 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -309,7 +345,6 @@ By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. 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 @@ -318,14 +353,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PrivateLine + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -334,14 +377,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -RemoteCallControlTelephonyEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -350,15 +402,17 @@ 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. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: AcpInfo +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 @@ -367,23 +421,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the user's instant messaging sessions are archived. -Allowed values are: - -Uninitialized - -UseLyncArchivingPolicy +### -Confirm -ArchivingToExchange +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -NoArchiving +Prompts you for confirmation before executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -392,27 +439,16 @@ 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. +### -WhatIf -**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -426,14 +462,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.Stringor 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 -### +### None The `Set-CsUser` cmdlet does not return any objects. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsUserAcp.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserAcp.md similarity index 84% rename from skype/skype-ps/skype/Set-CsUserAcp.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserAcp.md index e79059fc9a..50083b73ce 100644 --- a/skype/skype-ps/skype/Set-CsUserAcp.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserAcp.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-csuseracp applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserAcp -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuseracp +schema: 2.0.0 +title: Set-CsUserAcp --- # Set-CsUserAcp @@ -51,7 +53,7 @@ If a match is not found, then a new provider will be added to Ken Myer's user ac ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsUserAcp -Identity "Ken Myer" -TollNumber "14255551298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP" ``` @@ -61,7 +63,7 @@ To do this, the Identity parameter is used to indicate the user account to be mo In addition, the required parameters TollNumber, ParticipantPassCode, Domain and Name are included, along with the appropriate parameter values. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsUser -LdapFilter "Department=Finance" | Set-CsUserAcp -TollNumber "14255551298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP" ``` @@ -71,7 +73,7 @@ To do this, the command first uses the `Get-CsUser` cmdlet and the LdapFilter (w This collection is then piped to the `Set-CsUserAcp` cmdlet, which assigns the same audio conferencing provider (Fabrikam ACP) to each user in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsUserAcp -Identity "Ken Myer" -TollNumber "14255551298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP" -TollFreeNumbers "18005551010", "18005551020" ``` @@ -83,7 +85,34 @@ To assign these two values, include the TollFreeNumbers parameter followed by th ## PARAMETERS +### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Domain name of the audio conferencing provider. +For example: + +`-Domain "fabrikam.com"` + +The domain name will be given to you by the audio conferencing provider. + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be modified. You can specify a user's identity 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 Domain Services display name (for example, Ken Myer). User identities can also be referenced by using the user's Active Directory distinguished name. @@ -95,8 +124,7 @@ For example, the Identity "* Smith" returns all the users with a display name th ```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 +Aliases: Required: True Position: 1 @@ -105,22 +133,20 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Domain -Domain name of the audio conferencing provider. -For example: +### -IsDefault -`-Domain "fabrikam.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The domain name will be given to you by the audio conferencing provider. +Indicates whether or not this is the default audio conferencing provider for the user. +Each user can only have one default provider. ```yaml -Type: String +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 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -128,6 +154,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the audio conferencing provider. For example: @@ -137,8 +166,7 @@ For example: ```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 +Aliases: Required: True Position: Named @@ -148,6 +176,9 @@ Accept wildcard characters: False ``` ### -ParticipantPasscode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Passcode required when connecting to a conference by using the audio conferencing provider. For example: @@ -157,8 +188,7 @@ For example: ```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 +Aliases: Required: True Position: Named @@ -167,36 +197,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TollNumber -Non-toll-free phone number used for audio conferences. -For example: - -`-TollNumber "14255551298"` - - -```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 +### -PassThru -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -IsDefault -Indicates whether or not this is the default audio conferencing provider for the user. -Each user can only have one default provider. +Enables you to pass an object through the pipeline that represents the user whose account properties are being configured. +The PassThru parameter is required in such cases because, by default, the `Set-CsUserAcp` cmdlet does not pass objects through the pipeline. ```yaml -Type: Boolean +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 +Aliases: Required: False Position: Named @@ -206,6 +218,9 @@ Accept wildcard characters: False ``` ### -TollFreeNumbers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of toll-free phone number used for audio conferences. For example: @@ -219,8 +234,7 @@ To add multiple toll-free numbers, separate the individual numbers by using comm ```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 +Aliases: Required: False Position: Named @@ -229,37 +243,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Url -Web URL for the audio conferencing provider; for example: +### -TollNumber -`-Url "https://acp.fabrikam.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The web URL enables audio conferencing providers to point users to a webpage containing additional dial-in phone numbers, as well as information about the services offered by the audio conferencing provider. +Non-toll-free phone number used for audio conferences. +For example: + +`-TollNumber "14255551298"` ```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 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass an object through the pipeline that represents the user whose account properties are being configured. -The PassThru parameter is required in such cases because, by default, the `Set-CsUserAcp` cmdlet does not pass objects through the pipeline. +### -Url + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Web URL for the audio conferencing provider; for example: + +`-Url "https://acp.fabrikam.com"` + +The web URL enables audio conferencing providers to point users to a webpage containing additional dial-in phone numbers, as well as information about the services offered by the audio conferencing provider. ```yaml -Type: SwitchParameter +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 +Aliases: Required: False Position: Named @@ -268,15 +288,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -285,15 +307,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -307,15 +331,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.Stringor Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. The `Set-CsUserAcp` 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 -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserCallForwardingSettings.md similarity index 92% rename from skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserCallForwardingSettings.md index 1c371c4113..8ab316a983 100644 --- a/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserCallForwardingSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csusercallforwardingsettings applicable: Skype for Business Server 2019 -title: Set-CsUserCallForwardingSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csusercallforwardingsettings +schema: 2.0.0 +title: Set-CsUserCallForwardingSettings --- # Set-CsUserCallForwardingSettings @@ -84,23 +85,10 @@ This example sends unanswered calls to voicemail after 30 seconds. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DelegateRingWaitTime -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019CU1 +> Applicable: Skype for Business Server 2019CU1 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegateRingWaitTime Specifies the time, in seconds, to wait before ringing delegates. Acceptable inputs: 0, 5, 10, 15. The parameter DelegateWaitRingTime needs to be explicitly set to a positive value to allow call forwarding to delegates. @@ -108,7 +96,6 @@ Specifies the time, in seconds, to wait before ringing delegates. Acceptable inp Type: Int32 Parameter Sets: EnableForwarding Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -118,13 +105,15 @@ Accept wildcard characters: False ``` ### -Delegates + +> Applicable: Skype for Business Server 2019CU1 + Specifies the list of delegates that calls will be forwarded to. This parameter can only be used with EnableForwarding and EnableSimulRing parameters. ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: EnableForwarding, EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -134,13 +123,15 @@ Accept wildcard characters: False ``` ### -DisableForwarding + +> Applicable: Skype for Business Server 2019CU1 + This is a switch parameter that disables forwarding. Cannot be used with the EnableSimulRing and EnableForwarding parameters. ```yaml Type: SwitchParameter Parameter Sets: DisableForwarding Aliases: -Applicable: Skype for Business Server 2019CU1 Required: True Position: Named @@ -150,13 +141,15 @@ Accept wildcard characters: False ``` ### -EnableForwarding + +> Applicable: Skype for Business Server 2019CU1 + Enables forwarding to the specified destination. Cannot be used with the EnableSimulRing and DisableForwarding parameters. ```yaml Type: String Parameter Sets: EnableForwarding Aliases: -Applicable: Skype for Business Server 2019CU1 Required: True Position: Named @@ -166,6 +159,9 @@ Accept wildcard characters: False ``` ### -EnableSimulRing + +> Applicable: Skype for Business Server 2019CU1 + This is a switch parameter that enables forwarding to the specified destination. Cannot be used along with the DisableForwarding and EnableForwarding parameters. SimulRingDestination can be a phone number, delegates, or team call group. Acceptable input formats: "\", Team, Delegates. @@ -173,7 +169,6 @@ This is a switch parameter that enables forwarding to the specified destination. Type: String Parameter Sets: EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: True Position: Named @@ -183,13 +178,15 @@ Accept wildcard characters: False ``` ### -SettingsActiveWorkHours + +> Applicable: Skype for Business Server 2019CU1 + Switch parameter that specifies that settings should apply during work hours defined in Outlook. When this is not specified, settings apply all the time by default. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -199,13 +196,15 @@ Accept wildcard characters: False ``` ### -Team + +> Applicable: Skype for Business Server 2019CU1 + Specifies list of team members that calls will be forwarded to. The add and remove switches will add and remove specified users from the Team Members list. The replace parameter will set the list to the specified list, wiping out the previous list. Add and remove can be used together, but neither of them can be used along with replace. Acceptable input formats for add/remove/replace list: The inputs can be a single user address (in one of the below formats), or a comma separated list of user addresses, in the 4 standard formats that Identity parameter accepts. ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -215,13 +214,15 @@ Accept wildcard characters: False ``` ### -TeamDelegateRingWaitTime + +> Applicable: Skype for Business Server 2019CU1 + Specifies the time, in seconds, to wait before ringing team members. ```yaml Type: Int32 Parameter Sets: EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -231,13 +232,15 @@ Accept wildcard characters: False ``` ### -UnansweredToOther + +> Applicable: Skype for Business Server 2019CU1 + Specifies that unanswered calls will be send to other user or phone number. ```yaml Type: String Parameter Sets: DisableForwarding, EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -247,13 +250,15 @@ Accept wildcard characters: False ``` ### -UnansweredToVoicemail + +> Applicable: Skype for Business Server 2019CU1 + Specifies that unanswered calls will be send to voicemail. ```yaml Type: SwitchParameter Parameter Sets: DisableForwarding, EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -263,13 +268,15 @@ Accept wildcard characters: False ``` ### -UnansweredWaitTime + +> Applicable: Skype for Business Server 2019CU1 + Specifies the time, in seconds, to wait before send unanswered calls to voicemail. ```yaml Type: Int32 Parameter Sets: DisableForwarding, EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -279,13 +286,15 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Skype for Business Server 2019CU1 + Specifies the SIP address of the user whose call forwarding settings will be modified. ```yaml Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2019CU1 Required: True Position: 0 @@ -294,6 +303,24 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2019CU1 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/skype/skype-ps/skype/Set-CsUserDatabaseState.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserDatabaseState.md similarity index 86% rename from skype/skype-ps/skype/Set-CsUserDatabaseState.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserDatabaseState.md index 457fd92a5b..c4174e365f 100644 --- a/skype/skype-ps/skype/Set-CsUserDatabaseState.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserDatabaseState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserdatabasestate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserDatabaseState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserdatabasestate +schema: 2.0.0 +title: Set-CsUserDatabaseState --- # Set-CsUserDatabaseState @@ -44,7 +45,7 @@ However, to run the `Set-CsUserDatabaseState` cmdlet remotely you will need to m ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsUserDatabaseState -Identity "UserDatabase:atl-sql-001.litwareinc.com" -Online $False ``` @@ -53,7 +54,7 @@ The command shown in Example 1 takes the user database UserDatabase:atl-sql-001. This is done by setting the Online property to $False. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsUserDatabaseState -RegistrarPool atl-cs-001.litwareinc.com -Online $False ``` @@ -61,7 +62,7 @@ Set-CsUserDatabaseState -RegistrarPool atl-cs-001.litwareinc.com -Online $False In Example 2, all the user databases on the Registrar pool `atl-cs-001.litwareinc.com` are taken offline. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsUserDatabaseState | Where-Object {$_.Online -eq $False} | ForEach-Object {Set-CsUserDatabaseState -Identity $_.Identity -Online $True} ``` @@ -76,7 +77,28 @@ That is because the latter cmdlet cannot directly accept pipelined information. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the user database whose online status is to be modified. For example: @@ -88,8 +110,7 @@ You cannot use both Identity and RegistrarPool in the same command, nor can you ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -99,14 +120,16 @@ Accept wildcard characters: False ``` ### -Online + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True), makes a database available online. When set to False ($False), takes a database offline. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -116,6 +139,9 @@ Accept wildcard characters: False ``` ### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the Registrar pool hosting the user databases whose online status is to be modified. For example: @@ -127,8 +153,7 @@ You cannot use both -Identity and -RegistrarPool in the same command, nor can yo ```yaml Type: Fqdn Parameter Sets: RegistrarPool -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -137,14 +162,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -154,29 +181,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -190,14 +203,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String. +### System.String The `Set-CsUserDatabaseState` cmdlet accepts a string value representing the Identity of the user database to be updated. ## OUTPUTS -### -None. +### None Instead, the `Set-CsUserDatabaseState` cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.UserStoreState object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsUserDelegates.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserDelegates.md similarity index 98% rename from skype/skype-ps/skype/Set-CsUserDelegates.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserDelegates.md index 51ab7a0a53..514519fd79 100644 --- a/skype/skype-ps/skype/Set-CsUserDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserDelegates.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserdelegates applicable: Skype for Business Server 2019 -title: Set-CsUserDelegates -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserdelegates +schema: 2.0.0 +title: Set-CsUserDelegates --- # Set-CsUserDelegates @@ -36,21 +37,6 @@ This cmdlet modifies the specified user's delegation settings, returns an object ## 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 -``` - ### -Delegates Specifies list of delegates. The add and remove switches will add and remove specified users from the delegates list. The replace parameter will set the list to the specified list, wiping out the previous list. Add and remove can be used together, but neither of them can be used along with replace. Acceptable input formats for add/remove/replace list: The inputs can be a single user address (in one of the below formats), or a comma separated list of user addresses, in the 4 standard formats that Identity parameter accepts. @@ -96,6 +82,21 @@ 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: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/skype/skype-ps/skype/Set-CsUserPstnSettings.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserPstnSettings.md similarity index 90% rename from skype/skype-ps/skype/Set-CsUserPstnSettings.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserPstnSettings.md index 92e36241ea..b9eea7de33 100644 --- a/skype/skype-ps/skype/Set-CsUserPstnSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserPstnSettings.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-csuserpstnsettings applicable: Skype for Business Online -title: Set-CsUserPstnSettings -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserpstnsettings +schema: 2.0.0 +title: Set-CsUserPstnSettings --- # Set-CsUserPstnSettings @@ -34,7 +36,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsUserPstnSettings -Identity jphillips@contoso.com -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -AllowInternationalCalls $true ``` @@ -44,30 +46,10 @@ This example modifies the specified user's PSTN settings to allow international ## 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: Skype for Business Online +### -AllowInternationalCalls -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -AllowInternationalCalls If set to $true, the user is enabled for international calls. If $false, international calls are not enabled. The default is $false. @@ -75,8 +57,7 @@ The default is $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -85,14 +66,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -HybridPSTNSite + +> Applicable: Skype for Business Online + +Specifies the identity (name) of the hybrid public switched telephone network (PSTN) site that provides PSTN services for the user. +Set HybridPSTNSite to $null to revert to the default PSTN site. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -101,24 +85,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HybridPSTNSite -Specifies the identity (name) of the hybrid public switched telephone network (PSTN) site that provides PSTN services for the user. -Set HybridPSTNSite to $null to revert to the default PSTN site. +### -Identity + +> Applicable: Skype for Business Online + +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: String +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. @@ -131,8 +126,25 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -142,6 +154,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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. @@ -149,7 +164,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 Required: False Position: Named @@ -163,12 +177,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserPstnSettings The `Set-CsUserPstnSettings` cmdlet returns instances of the UserPstnSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserReplicatorConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserReplicatorConfiguration.md index 55e92367ce..cfb52db99f 100644 --- a/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserReplicatorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserReplicatorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserreplicatorconfiguration +schema: 2.0.0 +title: Set-CsUserReplicatorConfiguration --- # Set-CsUserReplicatorConfiguration @@ -59,7 +60,7 @@ You can use this cmdlet to add or remove domains from the list of domains the Us ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsUserReplicatorConfiguration -Identity global -ReplicationCycleInterval "00:05:00" ``` @@ -67,7 +68,7 @@ Set-CsUserReplicatorConfiguration -Identity global -ReplicationCycleInterval "00 Example 1 sets the value of the ReplicationCycleInterval of the global User Replicator settings to five minutes (00 hours: 05 minutes: 00 seconds). -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsUserReplicatorConfiguration -Identity global -ADDomainNamingContextList $Null ``` @@ -77,7 +78,7 @@ This task is carried out by including the ADDomainNamingContextList parameter an By setting this value to null the User Replicator will automatically discover and synchronize with all the available domains. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsUserReplicatorConfiguration -Identity global -ADDomainNamingContextList @{Add="dc=fabrikam,dc=com"} ``` @@ -93,7 +94,7 @@ When the AdDomainNamingContextList property is set to anything but a null value, This will be the case even if there are other domains in the deployment. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Set-CsUserReplicatorConfiguration -Identity global -ADDomainNamingContextList @{Remove="dc=fabrikam,dc=com"} ``` @@ -104,56 +105,60 @@ To do this the syntax `@{Remove=}` is used, along with the distinguished name (D ## PARAMETERS -### -Identity -Unique identifier of the User Replicator configuration settings to be modified. -To modify the global settings, use this syntax: +### -ADDomainNamingContextList -`-Identity global` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Distinguished names of the Active Directory domains that the User Replicator must synchronize with. +For example, to add a domain to the list use syntax similar to this: +`-ADDomainNamingContextList @{Add="dc=fabrikam,dc=com"}` + +If you set this property to a null value the User Replicator will discover and synchronize with all available domains. +If this property is not null then the User Replicator will only synchronize with the domains specified in the ADDomainNamingContextList. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -DomainControllerList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +List of domain controllers to be used for user replication. +Typically the user replicator service is able to identify domain controllers by using the DsGetDcName Windows API. +Because of this, it is recommended that you consult with Microsoft support personnel before manually selecting domain controllers by using this parameter. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -ADDomainNamingContextList -Distinguished names of the Active Directory domains that the User Replicator must synchronize with. -For example, to add a domain to the list use syntax similar to this: +### -Force -`-ADDomainNamingContextList @{Add="dc=fabrikam,dc=com"}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If you set this property to a null value the User Replicator will discover and synchronize with all available domains. -If this property is not null then the User Replicator will only synchronize with the domains specified in the ADDomainNamingContextList. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,51 +167,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReplicationCycleInterval -Represents the amount of time that the User Replicator waits before checking for user account updates in AD DS. -The replication cycle interval can be any time value between 1 second and 23 hours, 59 minutes, and 59 seconds; the default value is 1 minute. -The interval must be expressed using the format hours:minutes:seconds. -For example, this syntax sets to time interval to one hour and 15 minutes: +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the User Replicator configuration settings to be modified. +To modify the global settings, use this syntax: + +`-Identity global` -`-ReplicationCycleInterval 01:15:00` ```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ReplicationCycleInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the amount of time that the User Replicator waits before checking for user account updates in AD DS. +The replication cycle interval can be any time value between 1 second and 23 hours, 59 minutes, and 59 seconds; the default value is 1 minute. +The interval must be expressed using the format hours:minutes:seconds. +For example, this syntax sets to time interval to one hour and 15 minutes: + +`-ReplicationCycleInterval 01:15:00` ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,14 +230,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SkipFirstSyncAllowedDowntime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates how long Skype for Business Server should wait for user data to synchronize before marking the service as started. +The default value is 2 hours (02:00:00), meaning that, after 2 hours, the status of the replication service will changed from Pending to Started. ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,16 +249,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainControllerList -List of domain controllers to be used for user replication. -Typically the user replicator service is able to identify domain controllers by using the DsGetDcName Windows API. -Because of this, it is recommended that you consult with Microsoft support personnel before manually selecting domain controllers by using this parameter. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -249,15 +267,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipFirstSyncAllowedDowntime -Indicates how long Skype for Business Server should wait for user data to synchronize before marking the service as started. -The default value is 2 hours (02:00:00), meaning that, after 2 hours, the status of the replication service will changed from Pending to Started. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -271,13 +290,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration + The `Set-CsUserReplicatorConfiguration` cmdlet accepts pipelined input of the User Replicator configuration object. ## OUTPUTS -### +### None The `Set-CsUserReplicatorConfiguration` cmdlet does not return any objects or values. Instead, the cmdlet modifies the global instance (the only such instance) of the Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsUserServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserServer.md similarity index 84% rename from skype/skype-ps/skype/Set-CsUserServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserServer.md index 5e4b1ca974..58a639c675 100644 --- a/skype/skype-ps/skype/Set-CsUserServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserserver +schema: 2.0.0 +title: Set-CsUserServer --- # Set-CsUserServer @@ -42,7 +43,7 @@ The cmdlet also lets you modify the port used for connections to the Focus Facto ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsUserServer -Identity "UserServer:atl-cs-001.litwareinc.com" -McuFactorySipPort 445 ``` @@ -51,7 +52,7 @@ The command shown in Example 1 changes the McuFactorySipPort for a single User S In this example, the port is changed to 445. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -UserServer | ForEach-Object {Set-CsUserServer -Identity $_.Identity -McuFactorySipPort 445} ``` @@ -65,32 +66,29 @@ The data must be piped to the `ForEach-Object` cmdlet because the `Set-CsUserSer ## PARAMETERS -### -Identity -Unique identifier for the User Services pool to be modified. -For example: - -`-Identity "UserServer:atl-cs-001.litwareinc.com"` - -Note that you can leave off the prefix "UserServer:" when specifying a User server. -For example: +### -ConfDirManagementWcfTcpPort -`-Identity "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Windows Communication Foundation (WCF) port used for managing conference directories. +The default value is 9001. ```yaml -Type: XdsGlobalRelativeIdentity +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ConferenceServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service ID for the conferencing server associated with the User Services pool. For example: @@ -100,8 +98,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,16 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -McuFactorySipPort -Port used for connecting to the Focus Factory (McuFactory). -The Focus Factory allocates media control units (MCUs) in order to add specific media types such as audio to conferences. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,34 +125,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserDatabase -Service ID for the user database associated with the User Services pool. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the User Services pool to be modified. For example: -`-UserDatabase "UserDatabase:atl-cs-001.litwareinc.com"` +`-Identity "UserServer:atl-cs-001.litwareinc.com"` + +Note that you can leave off the prefix "UserServer:" when specifying a User server. +For example: + +`-Identity "atl-cs-001.litwareinc.com"` ```yaml -Type: String +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 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. +### -McuFactorySipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for connecting to the Focus Factory (McuFactory). +The Focus Factory allocates media control units (MCUs) in order to add specific media types such as audio to conferences. + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,14 +172,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UserDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service ID for the user database associated with the User Services pool. +For example: + +`-UserDatabase "UserDatabase:atl-cs-001.litwareinc.com"` + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,14 +194,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -UserPinManagementWcfHttpPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used by Windows Communication Foundation (WCF) when managed user PINs. +The default value is 443. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,15 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfDirManagementWcfTcpPort -Windows Communication Foundation (WCF) port used for managing conference directories. -The default value is 9001. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -213,15 +231,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserPinManagementWcfHttpPort -Port used by Windows Communication Foundation (WCF) when managed user PINs. -The default value is 443. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -235,13 +254,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsUserServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsUserServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayUserServer object. diff --git a/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsUserServicesConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserServicesConfiguration.md index e84ea92d4a..b6769179cb 100644 --- a/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserServicesConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserservicesconfiguration +schema: 2.0.0 +title: Set-CsUserServicesConfiguration --- # Set-CsUserServicesConfiguration @@ -50,7 +51,7 @@ The `Set-CsUserServicesConfiguration` cmdlet provides a way for administrators t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsUserServicesConfiguration -Identity site:Redmond -AnonymousUserGracePeriod "00:30:00" ``` @@ -59,7 +60,7 @@ The command shown in Example 1 modifies the User Services configuration settings In this example, the AnonymousUserGracePeriod is set to 30 minutes (00 hours: 30 minutes: 00 seconds). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsUserServicesConfiguration -Identity site:Redmond -MaintenanceTimeOfDay "13:30" ``` @@ -69,7 +70,7 @@ This is done by using the MaintenanceTimeOfDay parameter and the parameter value That sets the maintenance time of day to 1:30 PM (13 hours and 30 minutes on a 24-hour clock). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUserServicesConfiguration -Filter "service:*" | Set-CsUserServicesConfiguration -MaxContacts 300 ``` @@ -79,7 +80,7 @@ To carry out this task, the command first uses the `Get-CsUserServicesConfigurat This filtered collection is then passed to the `Set-CsUserServicesConfiguration` cmdlet, which takes each item in the collection and sets the MaxContacts property to 300. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUserServicesConfiguration | Where-Object {$_.MaxContacts -gt 300} | Set-CsUserServicesConfiguration -MaxContacts 300 ``` @@ -93,51 +94,28 @@ In turn, the filtered collection is piped to the `Set-CsUserServicesConfiguratio ## PARAMETERS -### -Identity -Unique identifier for the User Services configuration settings to be modified. -To modify the global settings, use this syntax: - -`-Identity global` - -To modify settings configured at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To modify settings at the service level, use syntax like this: +### -AllowNonRoomSystemNotification -`-Identity service:UserServer:atl-cs-001.litwareinc.com` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: $true | $false ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -AnonymousUserGracePeriod -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AnonymousUserGracePeriod Represents the amount of time an anonymous (unauthenticated) user can remain in a meeting without an authenticated user being present in that same meeting. For example, if this value is set to 15 minutes an anonymous user can stay in the meeting for, at most, 15 minutes before an authenticated user must join. If an authenticated user does not join before the grace period expires then the anonymous user will be removed from the meeting. @@ -150,8 +128,7 @@ The grace period can be set to any value between 0 second and 1 day; the default ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +138,9 @@ Accept wildcard characters: False ``` ### -DeactivationGracePeriod + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of time that a meeting can remain active. This value must be specified using the following format: days.hours:minutes:seconds. For example, to enable a meeting to last for 60 hours you would use this format: 2.12:00:00 (2 days: 12 hours: 00 minutes: 00 seconds.) @@ -171,8 +151,7 @@ The default value is 1 day. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +161,9 @@ Accept wildcard characters: False ``` ### -DefaultSubscriptionExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. If no such request is issued, then the subscription is set to the value specified by the DefaultSubscriptionExpiration property. @@ -192,8 +174,7 @@ The default value is 28800 seconds (8 hours). ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,7 +183,76 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the User Services configuration settings to be modified. +To modify the global settings, use this syntax: + +`-Identity global` + +To modify settings configured at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To modify settings at the service level, use syntax like this: + +`-Identity service:UserServer:atl-cs-001.litwareinc.com` + + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -MaintenanceTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the time of day when regularly-scheduled database maintenance (such as the purging of outdated records) takes place. This value must be specified as a date-time value; you can use either the 24-hour format (for example, "14:00") or the 12-hour format (for example, "2:00 PM"). @@ -211,8 +261,7 @@ The default value for MaintenanceTimeOfDay is 1:00 AM (01:00:00). ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,6 +271,9 @@ Accept wildcard characters: False ``` ### -MaxContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of contacts a user can have; the default value is 250. The MaxContacts property represents the absolute maximum number of contacts a user can have. However, you can use the CsClientPolicy cmdlets to limit certain users to a maximum number of contacts lower than the value of MaxContacts. @@ -229,8 +281,7 @@ However, you can use the CsClientPolicy cmdlets to limit certain users to a maxi ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,6 +291,9 @@ Accept wildcard characters: False ``` ### -MaxPersonalNotes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum number of personal notes that are stored in the user's note history. By default, the last 3 personal notes are maintained in the note history. The maximum number of notes that can be maintained in the history is 10. @@ -247,8 +301,7 @@ The maximum number of notes that can be maintained in the history is 10. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,14 +311,16 @@ Accept wildcard characters: False ``` ### -MaxScheduledMeetingsPerOrganizer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of meetings that a single user can serve as organizer for at a given time. The default value is 1000; this means that, if a user is already the organizer for 1000 meetings, his or her attempt to schedule a new meeting (meeting number 1001) will fail. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +330,9 @@ Accept wildcard characters: False ``` ### -MaxSubscriptionExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. The MaxSubscriptionExpiration property represents the maximum amount of time that clients can be granted. @@ -286,8 +344,7 @@ The default value is 43200 seconds (12 hours). ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,14 +354,16 @@ Accept wildcard characters: False ``` ### -MaxSubscriptions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of SIP subscribe dialogs a user can have open at any one time. A subscribe dialog represents a request for SIP resources. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -313,32 +372,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscribeToCollapsedDG -If set to True (the default value), client applications will be allowed to subscribe to distribution groups that are not currently expanded in the Contacts list. -This enables the client to maintain up-to-minute presence information for each member of the group. -If set to False, client applications will not be allowed to subscribe to "collapsed" groups. +### -MinSubscriptionExpiration -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Subscriptions are created any time a user makes a request for data such as presence information. +When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. +The MinSubscriptionExpiration property represents the minimum amount of time that clients can be granted. +For example, if the minimum time is set to 1200 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 1200 seconds. + +The minimum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. +The default value is 1200 seconds (20 minutes). -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -347,30 +397,17 @@ 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 +### -PresenceProviders -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Collection of presence providers for the User Service configuration settings. +Presence providers are best added to a collection of User Service configuration settings by using the `New-CsPresenceProvider` cmdlet. ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -379,21 +416,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinSubscriptionExpiration -Subscriptions are created any time a user makes a request for data such as presence information. -When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. -The MinSubscriptionExpiration property represents the minimum amount of time that clients can be granted. -For example, if the minimum time is set to 1200 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 1200 seconds. +### -SubscribeToCollapsedDG -The minimum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. -The default value is 1200 seconds (20 minutes). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +If set to True (the default value), client applications will be allowed to subscribe to distribution groups that are not currently expanded in the Contacts list. +This enables the client to maintain up-to-minute presence information for each member of the group. +If set to False, client applications will not be allowed to subscribe to "collapsed" groups. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -402,15 +436,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PresenceProviders -Collection of presence providers for the User Service configuration settings. -Presence providers are best added to a collection of User Service configuration settings by using the `New-CsPresenceProvider` cmdlet. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -419,14 +454,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNonRoomSystemNotification -PARAMVALUE: $true | $false +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -440,13 +477,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings + The `Set-CsUserServicesConfiguration` cmdlet accepts pipelined instances of the user services settings object. ## OUTPUTS -### +### None The `Set-CsUserServicesConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. diff --git a/skype/skype-ps/skype/Set-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesPolicy.md similarity index 88% rename from skype/skype-ps/skype/Set-CsUserServicesPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserServicesPolicy.md index b616c7d545..1b01ddfd01 100644 --- a/skype/skype-ps/skype/Set-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserServicesPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserservicespolicy +schema: 2.0.0 +title: Set-CsUserServicesPolicy --- # Set-CsUserServicesPolicy @@ -56,7 +57,7 @@ The following parameters are not applicable to Skype for Business Online: Force, ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsUserServicesPolicy -Identity "RedmondUserServicesPolicy" -UcsAllowed $False ``` @@ -65,7 +66,7 @@ The command shown in Example 1 disables the use of the Unified Contact Store for This means that users managed by this policy will not have their contacts stored in the Unified Contact Store. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUserServicesPolicy -Filter "site:*" | Set-CsUserServicesPolicy -UcsAllowed $False ``` @@ -77,16 +78,17 @@ This collection is then piped to the `Set-CsUserServicesPolicy` cmdlet, which ta ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. -Suppresses the display of any non-fatal error message that might arise when running the command. +### -EnableAwaySinceIndication + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +98,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +117,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be modified. To modify the global policy, use this syntax: @@ -134,8 +141,7 @@ If this parameter is not included then the `Set-CsUserServicesPolicy` cmdlet wil ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -145,14 +151,16 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,7 +169,31 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -MigrationDelayInDays + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the number of days the system will wait before beginning a migration to or from the unified contact store. +MigrationDelayInDays can be set to any value between 0 and 180, inclusive. +The default value is 0. + + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the user services policy being modified. For example: @@ -175,8 +207,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -186,6 +217,9 @@ Accept wildcard characters: False ``` ### -UcsAllowed + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True (the default value) users affected by the policy will automatically be migrated to the unified contact store (assuming that they have an account on Exchange and that they log on using Skype for Business). When set to False, users can be removed from the unified contact store, but only if they are "manually" removed by the `Invoke-CsUcsRollback` cmdlet. @@ -193,8 +227,7 @@ When set to False, users can be removed from the unified contact store, but only ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,15 +236,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -220,34 +256,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAwaySinceIndication -PARAMVALUE: $true | $false - +### -WhatIf -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationDelayInDays -Specifies the number of days the system will wait before beginning a migration to or from the unified contact store. -MigrationDelayInDays can be set to any value between 0 and 180, inclusive. -The default value is 0. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -261,13 +280,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy The `Set-CsUserServicesPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsUserServicesPolicy` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsUserTeamMembers.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserTeamMembers.md similarity index 98% rename from skype/skype-ps/skype/Set-CsUserTeamMembers.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserTeamMembers.md index ec4147db30..3c6d0d391a 100644 --- a/skype/skype-ps/skype/Set-CsUserTeamMembers.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserTeamMembers.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserteammembers applicable: Skype for Business Server 2019 -title: Set-CsUserTeamMembers -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserteammembers +schema: 2.0.0 +title: Set-CsUserTeamMembers --- # Set-CsUserTeamMembers @@ -36,21 +37,6 @@ This cmdlet adds two other users to the specified user's team members list, retu ## 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 occur when running the command. @@ -96,6 +82,21 @@ 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: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/skype/skype-ps/skype/Set-CsVideoGateway.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoGateway.md similarity index 87% rename from skype/skype-ps/skype/Set-CsVideoGateway.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVideoGateway.md index 166e402503..065a680be2 100644 --- a/skype/skype-ps/skype/Set-CsVideoGateway.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideogateway applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVideoGateway -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvideogateway +schema: 2.0.0 +title: Set-CsVideoGateway --- # Set-CsVideoGateway @@ -37,7 +38,7 @@ After a Video Gateway has been defined, you can then manage the properties of th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVideoGateway -Identity "VideoGateway:atl-cs-001.litwareinc.com" -VideoGatewaySipClientTcpPort 444 ``` @@ -46,7 +47,7 @@ The command shown in Example 1 changes the TCP client port for the video gateway In this example, the port is set to 444. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsService -VideoGateway | Set-CsVideoGateway -VideoGatewaySipClientTcpPort 444 ``` @@ -57,30 +58,16 @@ To do this, the command first uses the `Get-CsService` cmdlet and the -VideoGate ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,6 +77,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the video gateway being modified. For example: @@ -98,8 +88,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -109,13 +98,15 @@ Accept wildcard characters: False ``` ### -VideoGatewaySipClientTcpPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + TCP (Transmission Control Protocol) listening port on the Video Gateway used for SIP trunk communication with a Video Interop Server pool. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,13 +116,15 @@ Accept wildcard characters: False ``` ### -VideoGatewaySipClientTlsPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + TLS (Transport Layer Security) listening port on the Video Gateway used for SIP trunk communication with a Video Interop Server pool. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +134,33 @@ Accept wildcard characters: False ``` ### -VideoInteropServer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Service location for the Video Interop Server associated with this Video Gateway. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -157,13 +170,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -177,13 +192,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayVideoGateway The `Set-CsVideoGateway` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayVideoGateway object. ## OUTPUTS -### -None. +### None The `Set-CsVideoGateway` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServer.md similarity index 86% rename from skype/skype-ps/skype/Set-CsVideoInteropServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServer.md index 206a48e916..e8646fd0fc 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserver applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVideoInteropServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvideointeropserver +schema: 2.0.0 +title: Set-CsVideoInteropServer --- # Set-CsVideoInteropServer @@ -44,7 +45,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVideoInteropServer -Identity "VideoInteropServer:atl-cs-001.litwareinc.com" -SipTrunkTlsPort 444 ``` @@ -52,7 +53,7 @@ Set-CsVideoInteropServer -Identity "VideoInteropServer:atl-cs-001.litwareinc.com This example sets the SIP trunk TLS port for the Video Interop server VideoInteropServer:atl-cs-001.litwareinc.com to port 444. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsService -VideoInteropServer | Set-CsVideoInteropServer -SipTrunkTlsPort 444 ``` @@ -65,6 +66,9 @@ That collection is then piped to the `Set-CsVideoInteropServer` cmdlet, which ch ## PARAMETERS ### -AudioPortCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100, then ports 60000 through 60099 will be used for audio traffic. @@ -72,8 +76,7 @@ For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,14 +86,16 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for sending and receiving audio traffic. For example: `-AudioPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,30 +104,16 @@ 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 Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +123,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Video Interop Server to be modified. For example: `-Identity "VideoInteropServer:atl-cs-001.litwareinc.com"`. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -149,14 +142,16 @@ Accept wildcard characters: False ``` ### -Registrar + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Service identity of the Registrar associated with the Video Interop Server. For example: `-Registrar "Registrar:atl-cs-001.litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,13 +161,15 @@ Accept wildcard characters: False ``` ### -RegistrationTcpPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,13 +179,15 @@ Accept wildcard characters: False ``` ### -RegistrationTlsPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,13 +197,15 @@ Accept wildcard characters: False ``` ### -SipTrunkTcpPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + TCP (Transmission Control Protocol) listening port on the Video Interop Server used for SIP trunk communication with a Video Gateway. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -214,13 +215,15 @@ Accept wildcard characters: False ``` ### -SipTrunkTlsPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + TLS (Transport Layer Security) listening port on the Video Interop Server used for SIP trunk communication with a Video Gateway. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,6 +233,9 @@ Accept wildcard characters: False ``` ### -VideoPortCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for sending and receiving video traffic. The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100, then ports 60000 through 60099 will be used for video traffic. @@ -237,8 +243,7 @@ For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,14 +253,34 @@ Accept wildcard characters: False ``` ### -VideoPortStart + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for sending and receiving video traffic. For example: `-AudioPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -265,13 +290,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -285,13 +312,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayVideoInteropServer The `Set-CsVideoInteropServer` accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayVideoInteropServer object. ## OUTPUTS -### -None. +### None The `Set-CsVideoInteropServer` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerConfiguration.md index 80989a190d..0a94c4dc3e 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVideoInteropServerConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvideointeropserverconfiguration +schema: 2.0.0 +title: Set-CsVideoInteropServerConfiguration --- # Set-CsVideoInteropServerConfiguration @@ -53,7 +54,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVideoInteropServerConfiguration -Identity "site:Redmond" -EnableEnhancedVideoExperience $False ``` @@ -61,7 +62,7 @@ Set-CsVideoInteropServerConfiguration -Identity "site:Redmond" -EnableEnhancedVi This example disables enhanced video experience for the collection of VIS settings assigned to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoInteropServerConfiguration | Set-CsVideoInteropServerConfiguration -EnableEnhancedVideoExperience $False ``` @@ -73,30 +74,16 @@ That collection is piped to the `Set-CsVideoInteropServerConfiguration` cmdlet, ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableEnhancedVideoExperience -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableEnhancedVideoExperience When set to True ($True) the single video stream coming from a third party video system will be converted to multiple streams in order to meet the needs of devices using different video resolutions or frame rates. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,13 +93,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +111,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the video server configuration settings to be modified. To modify the global settings, use this syntax: @@ -140,8 +132,7 @@ If this parameter is not included, the `Set-CsVideoInteropServerConfiguration` c ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -151,13 +142,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,14 +159,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -183,18 +196,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 -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration + The `Set-CsVideoInteropServerConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. ## OUTPUTS -### -None. -The `Set-CsVideoInteropServerConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md index 05da2f52c4..216fec460a 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVideoInteropServerSyntheticTransactionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvideointeropserversynthetictransactionconfiguration +schema: 2.0.0 +title: Set-CsVideoInteropServerSyntheticTransactionConfiguration --- # Set-CsVideoInteropServerSyntheticTransactionConfiguration @@ -36,7 +37,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVideoInteropServerSyntheticTransactionConfiguration -Identity Global -WatcherNodeFqdns "watchernode.contoso.com" ``` @@ -46,30 +47,16 @@ This example sets the Global configuration to trust connections from the Watcher ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,6 +66,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the VIS configuration when it was created. VIS settings can be configured at the global, site, or service scope (for the VideoInteropServer service only). To refer to the global instance, use this syntax: @@ -92,8 +82,7 @@ Use this syntax to refer to a collection at the site scope: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -103,13 +92,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +110,9 @@ Accept wildcard characters: False ``` ### -WatcherNodeFqdns + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the URL of the watcher node relevant to the synthetic transaction. For example: `-WatcherNodeFqdns "atl-cs-001.Contoso.com"`. Watcher nodes are computers that periodically use Microsoft System Center Operations Manager and Skype for Business Server synthetic transactions to verify that Skype for Business Server components are working as expected. @@ -132,8 +126,25 @@ To add or remove one or more values without affecting any existing entries, use ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -163,13 +176,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### VideoInteropServerSyntheticTransactionConfiguration Accepts pipelined instances of the VideoInteropServerSyntheticTransactionConfiguration object. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoTrunkConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVideoTrunkConfiguration.md index 32c668c947..e9e011bb8f 100644 --- a/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVideoTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvideotrunkconfiguration +schema: 2.0.0 +title: Set-CsVideoTrunkConfiguration --- # Set-CsVideoTrunkConfiguration @@ -59,7 +60,7 @@ Both the single global collection of settings and any custom settings that you c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVideoTrunkConfiguration -Identity "site:Seattle" -EnableSessionTimer $False ``` @@ -67,7 +68,7 @@ Set-CsVideoTrunkConfiguration -Identity "site:Seattle" -EnableSessionTimer $Fals This example disables session timers for the collection of Video Trunk configuration settings assigned to the Seattle site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoTrunkConfiguration | Set-CsVideoTrunkConfiguration -EnableSessionTimer $False ``` @@ -79,31 +80,17 @@ That collection is then piped to the `Set-CsVideoTrunkConfiguration` cmdlet, whi ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableMediaEncryptionForSipOverTls -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableMediaEncryptionForSipOverTls When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) uses TLS to protect SIP signaling and uses SRTP to protect the media traffic. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +100,9 @@ Accept wildcard characters: False ``` ### -EnableSessionTimer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether the session timer is enabled. Session timers are used to determine whether a particular session is still active. The default is false ($False). @@ -123,8 +113,7 @@ In such a case, the Video Interop Server will reply to session timer probes from ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,13 +123,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +141,9 @@ Accept wildcard characters: False ``` ### -ForwardErrorCorrectionType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the type of Forward Error Correction (FEC) to be used between the Video Interop Server (VIS) and a Video Gateway. The valid settings are: @@ -160,8 +154,7 @@ Cisco: Enables FEC compatible with Cisco Video Gateways, such as Cisco Unified C ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,14 +164,16 @@ Accept wildcard characters: False ``` ### -GatewaySendsRtcpForActiveCalls + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) sends RTCP for calls that are enabled for media sending from the Video Gateway or VTC. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,14 +183,16 @@ Accept wildcard characters: False ``` ### -GatewaySendsRtcpForCallsOnHold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) sends RTCP for calls that are disabled for media sending from the Video Gateway or VTC. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +202,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Identity parameter specifies the unique identifier for the video trunk configuration to be modified. For example, this syntax creates a new collection of settings assigned to the Redmond site: `-Identity "site:Redmond"`. @@ -215,8 +215,7 @@ If this parameter is not specified, the `Set-CsVideoTrunkConfiguration` cmdlet w ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -226,13 +225,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,14 +242,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -262,13 +283,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration The `Set-CsVideoTrunkConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration object. ## OUTPUTS -### -None. +### None The `Set-CsVideoTrunkConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVoiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsVoiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoiceConfiguration.md index 55b566c49c..b8ec218e77 100644 --- a/skype/skype-ps/skype/Set-CsVoiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoiceconfiguration +schema: 2.0.0 +title: Set-CsVoiceConfiguration --- # Set-CsVoiceConfiguration @@ -48,7 +49,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $a = Get-CsVoiceConfiguration @@ -84,15 +85,35 @@ That one line will accomplish the same task shown in Example 1. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The scope of this object. The only value possible for this parameter is Global. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -102,14 +123,16 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to a voice configuration (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration) object. An object of this type can be retrieved by calling the `Get-CsVoiceConfiguration` cmdlet. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +142,9 @@ Accept wildcard characters: False ``` ### -VoiceTestConfigurations + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of all voice test configurations (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration objects) defined for the Skype for Business Server deployment. You should modify individual voice test configuration objects by using the `Set-CsVoiceTestConfiguration` cmdlet. @@ -128,8 +154,7 @@ That is the recommended way of modifying configurations in this list. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,14 +163,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -155,29 +182,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -191,13 +204,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration + The `Set-CsVoiceConfiguration` cmdlet accepts pipelined input of a voice configuration object. ## OUTPUTS -### +### None The `Set-CsVoiceConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceNormalizationRule.md similarity index 83% rename from skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoiceNormalizationRule.md index 75e02f9f89..d9444a68a3 100644 --- a/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceNormalizationRule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicenormalizationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoicenormalizationrule +schema: 2.0.0 +title: Set-CsVoiceNormalizationRule --- # Set-CsVoiceNormalizationRule @@ -46,7 +48,7 @@ Rules that are modified by using this cmdlet are part of the dial plan and, in a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" -Description "Add a prefix to all numbers on site Redmond" ``` @@ -54,7 +56,7 @@ Set-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" -Descriptio This example sets the description of the rule Prefix Redmond on site Redmond to "Add a prefix to all numbers on site Redmond". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsVoiceNormalizationRule -Identity global/SeattleFourDigit -Description "Translate an internal four-digit extension" -Translation '+1206556$1' ``` @@ -65,7 +67,7 @@ In addition, a Translation value has been specified that modifies the rule to tr For example, if the existing pattern matched any four-digit number and the number 1234 were entered, this rule would translate that extension to the number +12065561234. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $a = Get-CsVoiceNormalizationRule -Identity global/RedmondFourDigit $a.name = "RedmondRule" @@ -81,90 +83,98 @@ Next, we pass the variable to the Instance parameter of the `Set-CsVoiceNormaliz ## PARAMETERS -### -Identity -A unique identifier for the rule. -The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A friendly description of the normalization rule. + +Maximum string length: 512 characters. + ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 1 +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. -This object must be of type NormalizationRule and can be retrieved by calling the `Get-CsVoiceNormalizationRule` cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A friendly description of the normalization rule. +### -Identity -Maximum string length: 512 characters. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A unique identifier for the rule. +The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 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 enterprise. -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 is set to False. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +This object must be of type NormalizationRule and can be retrieved by calling the `Get-CsVoiceNormalizationRule` cmdlet. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Priority -The order in which rules are applied. -A number might match more than one rule. -This parameter sets the order in which the rules are tested against the number. +### -IsInternalExtension + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, the result of applying this rule will be a number internal to the enterprise. +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 is set to False. ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,14 +184,16 @@ Accept wildcard characters: False ``` ### -Pattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that the dialed number must match in order for this rule to be applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,15 +202,19 @@ 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. +### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The order in which rules are applied. +A number might match more than one rule. +This parameter sets the order in which the rules are tested against the number. ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,15 +223,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Tenant +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +For internal Microsoft usage. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,15 +241,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Translation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The regular expression pattern that will be applied to the number to convert it to E.164 format. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -242,6 +261,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -249,7 +271,6 @@ Prompts you for confirmation before executing the command. 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 @@ -258,14 +279,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal Microsoft usage. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -279,13 +303,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule + The `Set-CsVoiceNormalizationRule` cmdlet accepts pipelined input of voice normalization rule objects. ## OUTPUTS -### +### None The `Set-CsVoiceNormalizationRule` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. diff --git a/skype/skype-ps/skype/Set-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoicePolicy.md similarity index 83% rename from skype/skype-ps/skype/Set-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoicePolicy.md index bd2491217f..43742a7ccc 100644 --- a/skype/skype-ps/skype/Set-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoicePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoicePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoicepolicy +schema: 2.0.0 +title: Set-CsVoicePolicy --- # Set-CsVoicePolicy @@ -53,7 +54,7 @@ Use this cmdlet to change the settings that enable and disable many of these fea ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoicePolicy UserVoicePolicy2 -AllowSimulRing $false -PstnUsages @{remove="Local"} ``` @@ -64,7 +65,7 @@ This command also removes "Local" from the list of PSTN usages for this policy. The Identity parameter is a positional parameter, therefore if you put the identity value first in the list of parameters you don't need to explicitly state that it's the Identity.) -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsPstnUsage @@ -81,48 +82,55 @@ This refers to the Usage property of the PSTN usage settings, which contains the ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -AllowCallForwarding + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is set to True, users assigned to this policy can forward calls. +If this parameter is set to False, calls cannot be forwarded. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. -This object must be of type VoicePolicy and can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. +### -AllowPSTNReRouting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When this parameter is set to True, calls made to internal numbers homed on another pool will be routed through the public switched telephone network (PSTN) when the pool or WAN is unavailable. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallForwarding -If this parameter is set to True, users assigned to this policy can forward calls. -If this parameter is set to False, calls cannot be forwarded. +### -AllowSimulRing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Simultaneous ring is a feature that allows multiple phones to ring when a single number is dialed. +Setting this parameter to True enables simultaneous ring. +If this parameter is set to False, simultaneous ring cannot be configured for any user assigned to this policy. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,14 +139,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPSTNReRouting -When this parameter is set to True, calls made to internal numbers homed on another pool will be routed through the public switched telephone network (PSTN) when the pool or WAN is unavailable. +### -CallForwardingSimulRingUsageType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way for administrators to manage call forwarding and simultaneous ringing. +Allowed values are: + +* VoicePolicyUsage - The default voice policy usage is used to manage call forwarding and simultaneous ringing on all calls. This is the default value. +* InternalOnly - Call forwarding and simultaneous ringing are limited to calls made from one Lync user to another. +* CustomUsage. A custom PSTN usage will be used to manage call forwarding and simultaneous ringing. This usage must be specified using the CustomCallForwardingSimulRingUsages parameter. ```yaml -Type: Boolean +Type: CallForwardingSimulRingUsageType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,16 +162,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSimulRing -Simultaneous ring is a feature that allows multiple phones to ring when a single number is dialed. -Setting this parameter to True enables simultaneous ring. -If this parameter is set to False, simultaneous ring cannot be configured for any user assigned to this policy. +### -CustomCallForwardingSimulRingUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Custom PSTN usage used to manage call forwarding and simultaneous ringing. +To add a custom usage to voice policy use syntax similar to this: + +`-CustomCallForwardingSimulRingUsages @{Add="RedmondPstnUsage"}` + +To remove a custom usage, use this syntax: + +`-CustomCallForwardingSimulRingUsages @{Remove="RedmondPstnUsage"}` + +Note that the usage must exist before it can be used with the CustomCallForwardingSimulRingUsages parameter. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,6 +190,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of the voice policy. Maximum length: 1040 characters. @@ -173,8 +200,25 @@ Maximum length: 1040 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBusyOptions + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill EnableBusyOptions Description}} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -184,6 +228,9 @@ Accept wildcard characters: False ``` ### -EnableBWPolicyOverride + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Policies can be set to limit bandwidth and set various other properties relating to network configuration. Setting this parameter to True will allow override of these policies. In other words, if this parameter is set to True no bandwidth checks will be made, calls will go through regardless of the call admission control (CAC) settings. @@ -191,8 +238,7 @@ In other words, if this parameter is set to True no bandwidth checks will be mad ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +248,9 @@ Accept wildcard characters: False ``` ### -EnableCallPark + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Call Park application allows a call to be held, or parked, at a certain number within a range of numbers for later retrieval. Setting this parameter to True enables this application for users assigned this policy. If this parameter is set to False, users assigned to this policy cannot park calls that have been dialed to their phone number. @@ -209,8 +258,7 @@ If this parameter is set to False, users assigned to this policy cannot park cal ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,14 +268,16 @@ Accept wildcard characters: False ``` ### -EnableCallTransfer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether calls can be transferred to another number. If this parameter is set to True, calls can be transferred; if the parameter is set to False, calls cannot be transferred. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,6 +287,9 @@ Accept wildcard characters: False ``` ### -EnableDelegation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Call delegation allows a user to answer calls for another user or make calls on the other user's behalf. For example, a manager can set up call delegation so that all incoming calls ring both his or her phone and the phone of an administrator. Setting this parameter to True allows users with this policy to set up call delegation. @@ -245,8 +298,7 @@ Setting this parameter to False disables call delegation. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -256,6 +308,9 @@ Accept wildcard characters: False ``` ### -EnableMaliciousCallTracing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Malicious call tracing is a standard that is in place to trace calls that a user designates as malicious. These calls can be traced even if caller ID is blocked. The trace is available only to the proper authorities and not to the user. @@ -264,8 +319,7 @@ Setting this property to True enables the ability to set a trace on malicious ca ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +329,9 @@ Accept wildcard characters: False ``` ### -EnableTeamCall + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Team Call allows a user to designate a group of other users whose phones will ring when that user's number is called. This feature is useful in teams where, for example, anyone from a team can answer incoming calls from customers. Setting this parameter to True enables this feature. @@ -282,8 +339,7 @@ Setting this parameter to True enables this feature. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,32 +348,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -A friendly name describing this policy. +### -EnableVoicemailEscapeTimer -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 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 -``` +When set to True, calls to an unanswered mobile device will be routed to the organization voicemail instead of the mobile device provider's voicemail. +If a call is answered "too soon" (that is, before the value configured for the PSTNVoicemailEscapeTimer property has elapsed) it will be assumed that the mobile device is not available and the call will be routed to the organization voicemail. -### -PreventPSTNTollBypass -PSTN tolls are more commonly known as long-distance charges. -Organizations can sometimes bypass these tolls by implementing a Voice over Internet Protocol (VoIP) solution that enables branch offices to connect via network calls. -Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. +The default value is 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 +Aliases: Required: False Position: Named @@ -326,20 +369,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsages -A list of PSTN usages available to this policy. -The PSTN usage ties a voice policy to a phone route. +### -Force -Any string value can be placed into this list, as long as the value exists in the current global list of PSTN usages. -(Duplicate strings are not allowed; all string must be unique.) The list of PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Keep in mind that if you use this parameter to remove all PSTN usages from the policy, users granted this policy will not be able to make outbound PSTN calls. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -348,46 +387,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier specifying the scope, and in some cases the name, of the policy. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 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. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +This object must be of type VoicePolicy and can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. ```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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A friendly name describing this policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -396,19 +442,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallForwardingSimulRingUsageType -Provides a way for administrators to manage call forwarding and simultaneous ringing. -Allowed values are: +### -PreventPSTNTollBypass -* VoicePolicyUsage - The default voice policy usage is used to manage call forwarding and simultaneous ringing on all calls. This is the default value. -* InternalOnly - Call forwarding and simultaneous ringing are limited to calls made from one Lync user to another. -* CustomUsage. A custom PSTN usage will be used to manage call forwarding and simultaneous ringing. This usage must be specified using the CustomCallForwardingSimulRingUsages parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +PSTN tolls are more commonly known as long-distance charges. +Organizations can sometimes bypass these tolls by implementing a Voice over Internet Protocol (VoIP) solution that enables branch offices to connect via network calls. +Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. ```yaml -Type: CallForwardingSimulRingUsageType +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -417,23 +462,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomCallForwardingSimulRingUsages -Custom PSTN usage used to manage call forwarding and simultaneous ringing. -To add a custom usage to voice policy use syntax similar to this: +### -PstnUsages -`-CustomCallForwardingSimulRingUsages @{Add="RedmondPstnUsage"}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To remove a custom usage, use this syntax: +A list of PSTN usages available to this policy. +The PSTN usage ties a voice policy to a phone route. -`-CustomCallForwardingSimulRingUsages @{Remove="RedmondPstnUsage"}` +Any string value can be placed into this list, as long as the value exists in the current global list of PSTN usages. +(Duplicate strings are not allowed; all string must be unique.) The list of PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet. -Note that the usage must exist before it can be used with the CustomCallForwardingSimulRingUsages parameter. +Keep in mind that if you use this parameter to remove all PSTN usages from the policy, users granted this policy will not be able to make outbound PSTN calls. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -442,26 +486,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVoicemailEscapeTimer -When set to True, calls to an unanswered mobile device will be routed to the organization voicemail instead of the mobile device provider's voicemail. -If a call is answered "too soon" (that is, before the value configured for the PSTNVoicemailEscapeTimer property has elapsed) it will be assumed that the mobile device is not available and the call will be routed to the organization voicemail. - -The default value is False. +### -PSTNVoicemailEscapeTimer -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` - -### -PSTNVoicemailEscapeTimer Amount of time (in milliseconds) used to determine whether or not a call has been answered "too soon." If a response is received within this time interval Skype for Business Server will assume that the mobile device is not available and automatically switch the call to the organization's voicemail. If no response is received before the time interval is reached then the call will be allowed to proceed. @@ -471,8 +499,7 @@ The default value is 1500 milliseconds. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -482,6 +509,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose voice policy is to be modified. For example: @@ -495,8 +525,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -506,6 +535,9 @@ Accept wildcard characters: False ``` ### -VoiceDeploymentMode + +> Applicable: Lync Server 2013 + Allowed values are: * OnPrem @@ -518,8 +550,7 @@ The default value is OnPrem. ```yaml Type: VoiceDeploymentMode Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -528,14 +559,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableBusyOptions -{{Fill EnableBusyOptions Description}} +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -549,13 +600,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy + Accepts pipelined input of voice policy objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig.Voice.VoicePolicy object. diff --git a/skype/skype-ps/skype/Set-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoute.md similarity index 86% rename from skype/skype-ps/skype/Set-CsVoiceRoute.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoute.md index 7a66daa439..1b5eea9894 100644 --- a/skype/skype-ps/skype/Set-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoiceRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoiceroute +schema: 2.0.0 +title: Set-CsVoiceRoute --- # Set-CsVoiceRoute @@ -44,7 +45,7 @@ A voice route includes a regular expression that identifies which phone numbers ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoiceRoute -Identity Route1 -Description "Test Route" ``` @@ -52,7 +53,7 @@ Set-CsVoiceRoute -Identity Route1 -Description "Test Route" This command sets the Description of the Route1 voice route to "Test Route." -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsVoiceRoute -Identity Route1 -PstnUsages @{add="Long Distance"} ``` @@ -61,7 +62,7 @@ The command in this example modifies the voice route with the identity Route1 to Long Distance must be in the list of global PSTN usages (which can be retrieved with a call to the `Get-CsPstnUsage` cmdlet). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $x = (Get-CsPstnUsage).Usage @@ -78,7 +79,7 @@ Notice the value passed to the PstnUsages parameter: @{replace=$x}. This value says to replace everything in the PstnUsages list for this route with the contents of $x, which contain the PSTN usages list retrieved in line 1. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $x = Get-CsVoiceRoute -Identity Route1 @@ -96,7 +97,7 @@ Next, the Name property of that object is assigned the string value "RouteA". Finally, the object (contained in the variable $x) is passed to the Instance parameter of the `Set-CsVoiceRoute` cmdlet to make the change. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` $y = Get-CsVoiceRoute -Identity Route1 @@ -114,56 +115,59 @@ Finally, we call the `Set-CsVoiceRoute` cmdlet, passing the Instance parameter t ## PARAMETERS -### -Identity -The unique identity of the voice route. -(If the route name contains a space, such as Test Route, you must enclose the full string in parentheses.) +### -AlternateCallerId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If the SuppressCallerId parameter is set to True, the value of the AlternateCallerId parameter will be displayed to receiving parties rather than the caller's actual number. +This number should be a valid number and could be used to represent a division within an organization, such as Support or Human Resources. + +If the SuppressCallerId parameter is set to False, the AlternateCallerId parameter is ignored. + +This value must match the regular expression (\+)?\[1-9\]\d*(;ext=\[1-9\]\d*)?. +In other words, the value can begin with a plus sign (+) but doesn't need to; must consist of any number of digits; and may be followed by an extension that begins with ;ext= followed by any number of digits. +(Note that if you include an extension the string must be placed within double quotes.) ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. -This object must be of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route and can be retrieved by calling the `Get-CsVoiceRoute` cmdlet. +### -Description +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A description of what this phone route is for. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AlternateCallerId -If the SuppressCallerId parameter is set to True, the value of the AlternateCallerId parameter will be displayed to receiving parties rather than the caller's actual number. -This number should be a valid number and could be used to represent a division within an organization, such as Support or Human Resources. +### -Force -If the SuppressCallerId parameter is set to False, the AlternateCallerId parameter is ignored. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This value must match the regular expression (\+)?\[1-9\]\d*(;ext=\[1-9\]\d*)?. -In other words, the value can begin with a plus sign (+) but doesn't need to; must consist of any number of digits; and may be followed by an extension that begins with ;ext= followed by any number of digits. -(Note that if you include an extension the string must be placed within double quotes.) +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,23 +176,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description of what this phone route is for. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identity of the voice route. +(If the route name contains a space, such as Test Route, you must enclose the full string in parentheses.) ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +This object must be of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route and can be retrieved by calling the `Get-CsVoiceRoute` cmdlet. + + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -NumberPattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that specifies the phone numbers to which this route applies. Numbers matching this pattern will be routed according to the rest of the routing settings. For example, the default number pattern, \[0-9\]{10}, specifies a 10-digit number containing any digits 0 through 9. @@ -196,8 +226,7 @@ For example, the default number pattern, \[0-9\]{10}, specifies a 10-digit numbe ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,14 +236,16 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number could resolve to multiple voice routes. The priority determines the order in which the routes will be applied if more than one route is possible. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +255,9 @@ Accept wildcard characters: False ``` ### -PstnGatewayList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A Mediation Server can be associated with multiple gateways. This parameter contains a list of gateways associated with this voice route. Each member of this list must be the service Identity of the PSTN gateway or Mediation Server. @@ -239,8 +273,7 @@ If you make changes to a voice route and leave the PstnGatewayList list empty, o ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -250,6 +283,9 @@ Accept wildcard characters: False ``` ### -PstnUsages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of PSTN usages (such as Local or Long Distance) that can be applied to this voice route. The PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet.) @@ -259,8 +295,7 @@ If you make changes to a voice route and leave the PstnUsages list empty, or if ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -270,6 +305,9 @@ Accept wildcard characters: False ``` ### -SuppressCallerId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether a caller's ID will be revealed on outbound calls. If this parameter is set to True, caller ID will be suppressed. In place of the actual ID, the value of the AlternateCallerId will be displayed. @@ -278,8 +316,7 @@ When SuppressCallerId is set to True, a value for AlternateCallerId must be supp ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -289,13 +326,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -304,30 +343,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -WhatIf -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -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 @@ -341,13 +366,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route + The `Set-CsVoiceRoute` cmdlet accepts pipelined input of voice route objects. ## OUTPUTS -### +### None The `Set-CsVoiceRoute` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route object. diff --git a/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoutingPolicy.md similarity index 86% rename from skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoutingPolicy.md index 1c2aeaffd5..bc8cf9ed7d 100644 --- a/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoiceRoutingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoiceroutingpolicy +schema: 2.0.0 +title: Set-CsVoiceRoutingPolicy --- # Set-CsVoiceRoutingPolicy @@ -45,7 +46,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -PstnUsages @{Add="Long Distance"} ``` @@ -53,7 +54,7 @@ Set-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -PstnUsages @{Add The command shown in Example 1 adds the PSTN usage "Long Distance" to the per-user voice routing policy RedmondVoiceRoutingPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -PstnUsages @{Remove="Local"} ``` @@ -61,7 +62,7 @@ Set-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -PstnUsages @{Rem In Example 2, the PSTN usage "Local" is removed from the per-user voice routing policy RedmondVoiceRoutingPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoutingPolicy | Where-Object {$_.PstnUsages -contains "Local"} | Set-CsVoiceRoutingPolicy -PstnUsages @{Remove="Local"} ``` @@ -74,31 +75,17 @@ Those policies are then piped to the `Set-CsVoiceRoutingPolicy` cmdlet, which de ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description Enables administrators to provide explanatory text to accompany a voice routing 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,13 +95,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +113,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier assigned to the policy when it was created. Voice routing policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: @@ -140,8 +132,7 @@ If you do not specify an Identity, then the `Set-CsVoiceRoutingPolicy` cmdlet wi ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -151,13 +142,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +160,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A friendly name describing this policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +178,9 @@ Accept wildcard characters: False ``` ### -PstnUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of PSTN usages (such as Local or Long Distance) that can be applied to this voice routing policy. The PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet.) @@ -190,8 +188,25 @@ The PSTN usage must be an existing usage. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -201,13 +216,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -221,13 +238,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy The `Set-CsVoiceRoutingPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsVoiceRoutingPolicy` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceTestConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoiceTestConfiguration.md index 56905fbe1a..cbb5016611 100644 --- a/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceTestConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoiceTestConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoicetestconfiguration +schema: 2.0.0 +title: Set-CsVoiceTestConfiguration --- # Set-CsVoiceTestConfiguration @@ -45,7 +46,7 @@ The configurations modified with this cmdlet are tested using the `Test-CsVoiceT ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoiceTestConfiguration -Identity TestConfig1 -DialedNumber 14255551212 ``` @@ -54,7 +55,7 @@ This example sets the dialed number of the voice test configuration for TestConf This is the number that will be checked against the voice policy and route to ensure normalization occurs as expected, as well as to ensure the correct routes and dial plans are being applied. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsVoiceTestConfiguration -Identity TestConfig1 -TargetDialPlan site:Redmond1 -ExpectedTranslatedNumber "+912065551212" ``` @@ -66,43 +67,10 @@ Because a change in dial plan could mean a change in normalization rules, the Ex ## PARAMETERS -### -Identity -A string uniquely identifying the test scenario you want to modify. - -The value of this parameter does not include scope because this object can be created only at the global scope. -Therefore only a name is required. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, 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 -``` - -### -Instance -An object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration that contains an existing voice test configuration with the changes you'd like to make to that configuration. -An object of this type can be retrieved by calling the `Get-CsVoiceTestConfiguration` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DialedNumber -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DialedNumber The phone number you want to use to test the policies, usages, and so on. Must be 512 characters or fewer. @@ -110,8 +78,7 @@ Must be 512 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +88,9 @@ Accept wildcard characters: False ``` ### -ExpectedRoute + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the voice route expected to be used during the configuration test. If a different route is used, based on the target dial plan and voice policy, the test will fail. You can retrieve available voice routes by calling the `Get-CsVoiceRoute` cmdlet. @@ -130,8 +100,7 @@ Must be 256 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +110,9 @@ Accept wildcard characters: False ``` ### -ExpectedTranslatedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number in the format you expect to see it in after translation. This is the value of the DialedNumber parameter after normalization. If you run the `Test-CsVoiceTestConfiguration` cmdlet and the DialedNumber does not result in the value in ExpectedTranslatedNumber, the test will report as Fail. @@ -151,8 +123,7 @@ Must be 512 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +133,9 @@ Accept wildcard characters: False ``` ### -ExpectedUsage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the PSTN usage expected to be used during the configuration test. If a different PSTN usage is used, based on the target dial plan and voice policy, the test will fail. You can retrieve available usages by calling the `Get-CsPstnUsage` cmdlet. @@ -172,8 +146,25 @@ Must be 256 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -182,7 +173,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string uniquely identifying the test scenario you want to modify. + +The value of this parameter does not include scope because this object can be created only at the global scope. +Therefore only a name is required. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration that contains an existing voice test configuration with the changes you'd like to make to that configuration. +An object of this type can be retrieved by calling the `Get-CsVoiceTestConfiguration` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -TargetDialplan + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity of the dial plan to be used for this test. Dial plans can be retrieved by calling the `Get-CsDialPlan` cmdlet. @@ -191,8 +225,7 @@ Must be 40 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +235,9 @@ Accept wildcard characters: False ``` ### -TargetVoicePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity of the voice policy against which to run this test. Voice policies can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. @@ -211,8 +247,7 @@ Must be 40 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,14 +256,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -238,29 +275,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -274,13 +297,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration + Accepts pipelined input of voice test configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration This cmdlet returns an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoicemailReroutingConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoicemailReroutingConfiguration.md index b20a8c0c9d..7808357d6f 100644 --- a/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoicemailReroutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoicemailReroutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoicemailreroutingconfiguration +schema: 2.0.0 +title: Set-CsVoicemailReroutingConfiguration --- # Set-CsVoicemailReroutingConfiguration @@ -44,7 +45,7 @@ Note that these settings are not available unless the Enabled property has been ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoicemailReroutingConfiguration -Identity site:Redmond1 -Enabled $True ``` @@ -52,7 +53,7 @@ Set-CsVoicemailReroutingConfiguration -Identity site:Redmond1 -Enabled $True This example enables the voice mail rerouting configuration settings for the site Redmond1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsVoicemailReroutingConfiguration -Identity site:Redmond1 -SubscriberAccessNumber "+14255551213" ``` @@ -62,54 +63,56 @@ This example modifies the voice mail rerouting settings that apply to the site R ## PARAMETERS -### -Identity -The unique identifier of the configuration you want to modify. -For this cmdlet the Identity will be either Global or Site:\, where \ is the name of the site to which the settings are applied. +### -AutoAttendantNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number of the Auto Attendant to which the voice mail deposit attempts should be re-routed. + +The number supplied to this parameter must be a LineUri of an existing contact object. + +Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +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. +### -Enabled -This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration (which can be retrieved by calling the `Get-CsVoicemailReroutingConfiguration` cmdlet). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether attempts to access voice mail should be re-routed through PSTN when IP connectivity is down. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoAttendantNumber -Phone number of the Auto Attendant to which the voice mail deposit attempts should be re-routed. +### -Force -The number supplied to this parameter must be a LineUri of an existing contact object. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,50 +121,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Indicates whether attempts to access voice mail should be re-routed through PSTN when IP connectivity is down. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the configuration you want to modify. +For this cmdlet the Identity will be either Global or Site:\, where \ is the name of the site to which the settings are applied. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscriberAccessNumber -Subscriber Access number to which the voice mail retrieval attempts should be re-routed. +### -Instance -The number supplied to this parameter must be a LineUri of an existing contact object. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration (which can be retrieved by calling the `Get-CsVoicemailReroutingConfiguration` cmdlet). -Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of 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 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -SubscriberAccessNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Subscriber Access number to which the voice mail retrieval attempts should be re-routed. + +The number supplied to this parameter must be a LineUri of an existing contact object. + +Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +183,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -186,14 +201,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -207,13 +224,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration + Accepts pipelined input of voice mail rerouting configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration. diff --git a/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsWatcherNodeConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsWatcherNodeConfiguration.md index 8f943ec290..9fa0dbad12 100644 --- a/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsWatcherNodeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsWatcherNodeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cswatchernodeconfiguration +schema: 2.0.0 +title: Set-CsWatcherNodeConfiguration --- # Set-CsWatcherNodeConfiguration @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsExtendedTest -TestUsers "sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com" -Name "Audio Conferencing Test" -TestType "AudioConferencingProvider" @@ -59,7 +60,7 @@ To do this, the first command in the example uses the `New-CsExtendedTest` cmdle In the second command, the `Set-CsWatcherNodeConfiguration` cmdlet adds the new test to the watcher node configuration settings; this is done by using the ExtendedTests parameter and the syntax `@{Add=$x}`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = Get-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" @@ -79,7 +80,7 @@ To remove the second extended test, use the syntax `RemoveAt(1)`. After the object reference has been updated, the final command uses the `Set-CsWatcherNodeConfiguration` cmdlet and the Instance parameter to write the changes made to the object reference back to the actual watcher node settings for the pool `atl-cs-001.litwareinc.com`. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" -ExtendedTests $Null ``` @@ -90,31 +91,17 @@ This task is performed by including the ExtendedTests parameter and the paramete ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Enabled -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Enabled Enables or disables the watcher node. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,14 +111,16 @@ Accept wildcard characters: False ``` ### -ExtendedTests + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to one or more instances of the ExtendedTest object. These objects must be created using the `New-CsExtendedTest` cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +130,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,13 +148,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool associated with the watcher node configuration settings. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -173,13 +166,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,13 +184,15 @@ Accept wildcard characters: False ``` ### -PortNumber + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +202,9 @@ Accept wildcard characters: False ``` ### -Tests + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Synthetic transactions to be run by the watcher node. Allowed values are: @@ -256,8 +256,7 @@ To disable all the tests for a watcher node, set the value of the Tests paramete ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -267,6 +266,9 @@ Accept wildcard characters: False ``` ### -TestUsers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP addresses of the test users employed by the watcher node. To add additional test users to the node use syntax similar to this: @@ -287,8 +289,7 @@ If you have two users and try to remove one of those users (ostensibly leaving t ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,15 +298,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseInternalWebUrls -When set to True ($True), instructs the watcher node to use the internal Web URLs rather than the external Web URLs. -This provides a way to way to verify URL validity for users located behind the organization's firewall. +### -UseAutoDiscovery + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), watcher nodes will use the Autodiscover service locate the target pool. +When set to False (the default value), watcher nodes will use the pool FQDN and SRV records to locate pools. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -314,14 +317,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UseInternalWebUrls + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), instructs the watcher node to use the internal Web URLs rather than the external Web URLs. +This provides a way to way to verify URL validity for users located behind the organization's firewall. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -331,13 +337,15 @@ Accept wildcard characters: False ``` ### -XmppTestReceiverMailAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + XMPP email address to be used when testing the XMPP gateway. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -346,15 +354,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseAutoDiscovery -When set to True ($True), watcher nodes will use the Autodiscover service locate the target pool. -When set to False (the default value), watcher nodes will use the pool FQDN and SRV records to locate pools. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -368,13 +395,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated The `Set-CsWatcherNodeConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsWatcherNodeConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsWebServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsWebServer.md similarity index 79% rename from skype/skype-ps/skype/Set-CsWebServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsWebServer.md index 5bf3b8c7cc..d47ed77d5d 100644 --- a/skype/skype-ps/skype/Set-CsWebServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsWebServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cswebserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsWebServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cswebserver +schema: 2.0.0 +title: Set-CsWebServer --- # Set-CsWebServer @@ -51,7 +52,7 @@ Port changes like these (and other modifications) can be made using the `Set-CsW ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsWebServer -Identity "WebServer:atl-cs-001.litwareinc.com" -PrimaryHttpPort 89 ``` @@ -60,7 +61,7 @@ The command shown in Example 1 changes the PrimaryHttpPort for a single Web Serv In this example, the port is changed to port number 89. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -WebServer | ForEach-Object {Set-CsWebServer -Identity $_.Identity -PrimaryHttpPort 89} ``` @@ -74,32 +75,10 @@ The data must be piped to the `ForEach-Object` cmdlet because the `Set-CsWebServ ## PARAMETERS -### -Identity -Unique identifier for the Web Services pool. -For example: - -`-Identity "WebServer:atl-cs-001.litwareinc.com"` - -Note that you can leave off the prefix "WebServer:" when specifying a Web server. -For example: - -`-Identity "atl-cs-001.litwareinc.com"` - +### -AppSharingPortCount -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppSharingPortCount Total number of ports allocated for application sharing. The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100 then ports 60000 through 60099 will be used for application sharing. @@ -108,8 +87,7 @@ The default value is 16383. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,14 +97,16 @@ Accept wildcard characters: False ``` ### -AppSharingPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for application sharing. The default value is 49152. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +116,9 @@ Accept wildcard characters: False ``` ### -ExternalFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) used by people connecting to the Web Services pool from outside the internal network. For example: @@ -145,8 +128,7 @@ For example: ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,14 +138,16 @@ Accept wildcard characters: False ``` ### -ExternalHttpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number for external web connections made using the HTTP protocol. The default value is port 8080. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,14 +157,16 @@ Accept wildcard characters: False ``` ### -ExternalHttpsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number for external web connections made using the HTTPS protocol. The default value is port 4443. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,15 +175,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrimaryHttpPort -Port number for internal web connections made using the HTTP protocol. -The default value is port 80. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,32 +193,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrimaryHttpsPort -Port number for internal web connections made using the HTTPS protocol. -The default value is port 443. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the Web Services pool. +For example: + +`-Identity "WebServer:atl-cs-001.litwareinc.com"` + +Note that you can leave off the prefix "WebServer:" when specifying a Web server. +For example: + +`-Identity "atl-cs-001.litwareinc.com"` + ```yaml -Type: UInt16 +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReachExternalPsomServerPort -External port number for the Persistent Shared Object Model Protocol, a Microsoft protocol used for conferences. -The default port number is 8061. +### -InternalFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name for the Mobility Services. +The InternalFqdn should only be accessible from inside the organization's firewall. + ```yaml -Type: UInt16 +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,15 +240,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReachPrimaryPsomServerPort -Primary port number for the Persistent Shared Object Model (PSOM) Protocol, a Microsoft protocol used for conferences. -The default port number is 8060. +### -McxSipExternalListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +External listening port for the Mobility service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,18 +258,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserServer -Service ID for the User Services pool associated with the Web Services pool. -For example: +### -McxSipPrimaryListeningPort -`-UserServer "UserServer:atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Internal listening port for the Mobility service. ```yaml -Type: String +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,14 +276,17 @@ 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. +### -MeetingRoomAdminPortalExternalListeningPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +External listening port for the Skype for Business Meeting Room Admin Portal. +The Admin Portal is a web-based utility that makes it easy for administrator to manage meeting rooms. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -293,14 +295,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MeetingRoomAdminPortalInternalListeningPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Internal listening port for the Skype for Business Meeting Room Admin Portal. +The Admin Portal is a web-based utility that makes it easy for administrator to manage meeting rooms. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -309,14 +314,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PrimaryHttpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port number for internal web connections made using the HTTP protocol. +The default value is port 80. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -325,16 +333,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InternalFqdn -Fully qualified domain name for the Mobility Services. -The InternalFqdn should only be accessible from inside the organization's firewall. +### -PrimaryHttpsPort +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port number for internal web connections made using the HTTPS protocol. +The default value is port 443. ```yaml -Type: Fqdn +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -344,14 +353,16 @@ Accept wildcard characters: False ``` ### -PublishedExternalHttpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number for the published external HTTP port. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -361,14 +372,16 @@ Accept wildcard characters: False ``` ### -PublishedExternalHttpsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + External port for the Mobility service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -378,14 +391,16 @@ Accept wildcard characters: False ``` ### -PublishedPrimaryHttpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number for the published primary HTTP port. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -395,14 +410,16 @@ Accept wildcard characters: False ``` ### -PublishedPrimaryHttpsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Internal port for the Mobility service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -411,14 +428,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -McxSipExternalListeningPort -External listening port for the Mobility service. +### -ReachExternalPsomServerPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +External port number for the Persistent Shared Object Model Protocol, a Microsoft protocol used for conferences. +The default port number is 8061. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -427,14 +447,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -McxSipPrimaryListeningPort -Internal listening port for the Mobility service. +### -ReachPrimaryPsomServerPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Primary port number for the Persistent Shared Object Model (PSOM) Protocol, a Microsoft protocol used for conferences. +The default port number is 8060. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -444,14 +467,16 @@ Accept wildcard characters: False ``` ### -RmWebSipExternalListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + External listening port for the Persistent Chat Room Management Web App. This application is available only if you have installed and configured Persistent Chat. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -461,14 +486,16 @@ Accept wildcard characters: False ``` ### -RmWebSipPrimaryListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Primary listening port for the Persistent Chat Room Management Web App. This application is available only if you have installed and configured Persistent Chat. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -478,14 +505,16 @@ Accept wildcard characters: False ``` ### -SupportConferenceConsoleSipExternalListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port for the Support Conferencing Console. The default value is 6007. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -495,14 +524,34 @@ Accept wildcard characters: False ``` ### -SupportConferenceConsoleSipPrimaryListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used by the Office 365 Support Conference Console. This console is used by support personnel to troubleshoot problems with conferences and online meetings. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UcapSipPrimaryListeningPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Primary listening port for the UCAP (Unified Communication Application Platform). + +```yaml +Type: UInt16 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -512,14 +561,16 @@ Accept wildcard characters: False ``` ### -UcwaSipExternalListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + External SIP listening port for the Unified Communications Web API (UCWA). The default value is 5088. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -529,14 +580,16 @@ Accept wildcard characters: False ``` ### -UcwaSipPrimaryListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Internal SIP listening port for the Unified Communications Web API (UCWA). The default value is 5089. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -545,15 +598,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingRoomAdminPortalExternalListeningPort -External listening port for the Skype for Business Meeting Room Admin Portal. -The Admin Portal is a web-based utility that makes it easy for administrator to manage meeting rooms. +### -UserServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service ID for the User Services pool associated with the Web Services pool. +For example: + +`-UserServer "UserServer:atl-cs-001.litwareinc.com"` + ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -562,15 +620,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingRoomAdminPortalInternalListeningPort -Internal listening port for the Skype for Business Meeting Room Admin Portal. -The Admin Portal is a web-based utility that makes it easy for administrator to manage meeting rooms. +### -VxmlSipPrimaryListeningPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used with Skype for Business Server. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -579,14 +638,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UcapSipPrimaryListeningPort -Primary listening port for the UCAP (Unified Communication Application Platform). +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -595,14 +656,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VxmlSipPrimaryListeningPort -This parameter is not currently used with Skype for Business Server. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -616,14 +679,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsWebServer` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Set-CsWebServer` cmdlet modifies instances of the Microsoft.Rtc.Management.Xds.DisplayWebServer object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsWebServiceConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsWebServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsWebServiceConfiguration.md index 7a41b51175..b4b8685645 100644 --- a/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsWebServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsWebServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cswebserviceconfiguration +schema: 2.0.0 +title: Set-CsWebServiceConfiguration --- # Set-CsWebServiceConfiguration @@ -168,62 +169,56 @@ This is done by setting the CrossDomainAuthorizationList property to a null valu ## PARAMETERS -### -Identity - -Unique identifier for the Web Services configuration settings to be modified. -To modify settings configured at the site scope, use syntax similar to this: - -`-Identity "site:Redmond"` - -To modify settings configured at the service scope, use syntax similar to this: - -`-Identity "service:WebServer:atl-cs-001.litwareinc.com"` - -To modify settings configured at the global scope, you can use this syntax: +### -AllowAnonymousAccessToLWAConference -`-identity global` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If the Identity parameter is not used then the `Set-CsWebServiceConfiguration` cmdlet will automatically modify the global collection. +When set to True, anonymous users will be allowed to attend Skype for Business Web App conferences. ```yaml -Type: XdsIdentity -Parameter Sets: Identity +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: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance +### -AllowExternalAuthentication -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), OAuth authentication can be used to authenticate external users. ```yaml -Type: PSObject -Parameter Sets: Instance +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: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousAccessToLWAConference +### -AutoLaunchLyncWebAccess -When set to True, anonymous users will be allowed to attend Skype for Business Web App conferences. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +When set to True, Skype for Business Web App will automatically be used as the default web popup for joining an online conference, provided that the prerequisites for using Skype for Business Web App (for example, Silverlight have been installed and Internet Explorer is not blocking pop-up windows) have been met. + +The default value is True. ```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 @@ -234,6 +229,8 @@ Accept wildcard characters: False ### -CASigningKeyLength +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Sets the size of the CA signing key, the private key used by a certification authority (CA) to sign digital certificates. The signing key length can be set to any integer value between 2048 and 16384 bytes; the default value is 2048. @@ -241,7 +238,30 @@ The signing key length can be set to any integer value between 2048 and 16384 by Type: UInt64 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 +``` + +### -CrossDomainAuthorizationList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of domains allowed to host web applications that send cross-domain scripting requests to the Skype for Business Server deployment. + +Domains to be added to the list must be created using the `New-CsWebOrigin` cmdlet and then added to the new collection of Web service configuration settings. +Note, too that domain names must be prefaced using the http: or the https: prefix. +See Examples 5, 6 and 7 of this help topic for more information. + +This parameter was introduced in the February, 2013 release of Lync Server 2013. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -252,6 +272,8 @@ Accept wildcard characters: False ### -DefaultValidityPeriodHours +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. DefaultValidityPeriodHours represents the amount of time a certificate will remain valid if the client does not request a custom validity period. @@ -262,7 +284,6 @@ The default value is 4320 (180 days). Type: UInt64 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 @@ -273,6 +294,8 @@ Accept wildcard characters: False ### -EnableCertChainDownload +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, servers presented with an authentication certificate will download the certificate chain for that certificate. The certificate chain traces an individual certificate back to the issuing CA. Certificates will not be accepted for authentication unless the certificate's CA is trusted. @@ -281,7 +304,6 @@ Certificates will not be accepted for authentication unless the certificate's CA 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 @@ -291,6 +313,8 @@ Accept wildcard characters: False ``` ### -EnableCORS +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, Cross-Origin Resource Sharing is enabled. ```yaml @@ -298,7 +322,6 @@ Type: Boolean Position: Named Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -309,6 +332,8 @@ Accept wildcard characters: False ### -EnableGroupExpansion +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, group expansion will be enabled in Skype for Business. With group expansion, users can configure a distribution group as a contact, then "expand" that group. When a group has been expanded, users can see the individual members of a group and their current presence information. @@ -317,7 +342,6 @@ When a group has been expanded, users can see the individual members of a group 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 @@ -326,16 +350,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InferCertChainFromSSL +### -EnableMediaBasicAuth -If set to True, servers will use the certificate information included in the Secure Sockets Layer (SSL) protocol to determine the issuing CA. -Certificates will not be accepted for authentication unless the certificate's CA is trusted. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), enables basic authentication for media. ```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 @@ -344,17 +368,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MACResolverUrl +### -EnableStatisticsInResponse -URL for a Web service capable of performing Media Access Control (MAC) resolution. -MAC resolution involves taking the MAC address of a connected client and returning the chassis and port IDs of the network switch that client is connected to. -MAC resolution is used by the Enhanced 9-1-1 service. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True) the X-MS-WebInfraStats header is included in all HTTP responses. +The default value is False ($False). ```yaml -Type: String +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 @@ -363,17 +387,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxCSRKeySize +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. -Sets the maximum size of the Certificate Signing Request (CSR) key. -(A CSR is a message sent from an applicant to a CA in order to apply for a digital certificate.) The maximum size for a CSR key can be set to any integer value between 1024 and 16384 bytes. -The default value is 16384. ```yaml -Type: UInt64 +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 @@ -382,19 +406,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxGroupSizeToExpand +### -HstsMaxAgeInSeconds -Represents the maximum number of people that will be displayed when a group is expanded. -For example, if MaxGroupSizeToExpand is set to 75 only the first 75 members of the group will be displayed any time the group is expanded. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -MaxGroupSizeToExpand can be set to any integer value between 1 and 1000, inclusive. -The default value is 100. +Specifies the value of max-age in Strict-Transport-Security header in a HTTPS response. +Default value is 315360000. +A negative value means Strict-Transport-Security header will not appear in HTTPS responses. ```yaml -Type: UInt32 +Type: Int64 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 @@ -403,38 +426,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxValidityPeriodHours +### -Identity -When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. -MaxValidityPeriodHours represents the maximum amount of time a client can request. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -MaxValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). -The default value is 8760. +Unique identifier for the Web Services configuration settings to be modified. +To modify settings configured at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +To modify settings configured at the service scope, use syntax similar to this: + +`-Identity "service:WebServer:atl-cs-001.litwareinc.com"` + +To modify settings configured at the global scope, you can use this syntax: + +`-identity global` + +If the Identity parameter is not used then the `Set-CsWebServiceConfiguration` cmdlet will automatically modify the global collection. ```yaml -Type: UInt64 -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MinCSRKeySize +### -InferCertChainFromSSL -Sets the minimum size of the Certificate Signing Request (CSR) key. -The minimum size can be set to any integer value between 1024 and 16384 bytes. -The default value is 16384. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, servers will use the certificate information included in the Secure Sockets Layer (SSL) protocol to determine the issuing CA. +Certificates will not be accepted for authentication unless the certificate's CA is trusted. ```yaml -Type: UInt64 +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 @@ -443,37 +476,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinValidityPeriodHours +### -Instance -When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. -MinValidityPeriodHours represents the minimum amount of time a client can request. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -MinValidityPeriodHours can be any integer value between 8 hours and 4320 hours (180 days). -The default value is 8. +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: UInt64 -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance 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 pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SecondaryLocationSourceUrl +### -MACResolverUrl -URL for a web service that can process a location request. -This service is only used when location requests cannot be resolved locally. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for a Web service capable of performing Media Access Control (MAC) resolution. +MAC resolution involves taking the MAC address of a connected client and returning the chassis and port IDs of the network switch that client is connected to. +MAC resolution is used by the Enhanced 9-1-1 service. ```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 @@ -482,18 +514,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowDownloadCommunicatorAttendeeLink - -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +### -MaxCSRKeySize -If set to True (the default value), users joining a meeting by using a client application other than Skype for Business will see a link that points them to a download for Skype for Business Web App. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Sets the maximum size of the Certificate Signing Request (CSR) key. +(A CSR is a message sent from an applicant to a CA in order to apply for a digital certificate.) The maximum size for a CSR key can be set to any integer value between 1024 and 16384 bytes. +The default value is 16384. ```yaml -Type: Boolean +Type: UInt64 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 @@ -502,18 +534,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowJoinUsingLegacyClientLink +### -MaxGroupSizeToExpand -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If set to True, users joining a meeting by using a client application other than Skype for Business will be given the opportunity to join the meeting by using their current client application. -The default value is False. +Represents the maximum number of people that will be displayed when a group is expanded. +For example, if MaxGroupSizeToExpand is set to 75 only the first 75 members of the group will be displayed any time the group is expanded. + +MaxGroupSizeToExpand can be set to any integer value between 1 and 1000, inclusive. +The default value is 100. ```yaml -Type: Boolean +Type: UInt32 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 @@ -522,18 +556,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TrustedCACerts +### -MaxValidityPeriodHours -Collection of certificates representing certificate chains trusted by the Web Server. -New certificates added to the collection must be created by using the `New-CsWebTrustedCACertificate` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This collection is not used if the InferCertChainFromSSL property is set to True. +When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. +MaxValidityPeriodHours represents the maximum amount of time a client can request. + +MaxValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). +The default value is 8760. ```yaml -Type: PSListModifier +Type: UInt64 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 @@ -542,16 +578,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseCertificateAuth +### -MinCSRKeySize -When set to True (the default value), clients can be authenticated using certificates. -Set this value to False to disable certificate authentication. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Sets the minimum size of the Certificate Signing Request (CSR) key. +The minimum size can be set to any integer value between 1024 and 16384 bytes. +The default value is 16384. ```yaml -Type: Boolean +Type: UInt64 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 @@ -560,16 +598,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UsePinAuth +### -MinValidityPeriodHours -When set to True (the default value), clients can be authenticated using personal identification numbers (PINs). -Set this value to False to disable PIN authentication. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. +MinValidityPeriodHours represents the minimum amount of time a client can request. + +MinValidityPeriodHours can be any integer value between 8 hours and 4320 hours (180 days). +The default value is 8. ```yaml -Type: Boolean +Type: UInt64 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 @@ -578,22 +620,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWindowsAuth - -Determines how (and if) users will be authenticated using Windows authentication; that is, using the same credentials they used when they logged on to Windows. -Valid values are: +### -MobilePreferredAuthType -Negotiate - The client and server will work together to determine the proper authentication protocol (either Kerberos or NTLM). +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -NTLM - Windows authentication will be allowed, but only using the NTLM protocol. +Specifies the default authentication method used for mobile client connectivity. +Values can include: None | OAuth | WebTicketServiceAnon | WebTicketServiceWinNegotiate | WebTicketServiceWinNtlm | WebTicketServiceCert | WebTicketServicePin | WsFedPassive | WsFedBearer | WebTicketServiceAuth. -None - Windows authentication will not be allowed. +Note that if this value is set to a method that is not supported, the web ticket service may not start and an error will be generated in the Event log. ```yaml -Type: UseWindowsAuth +Type: MobilePreferredAuthType 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 @@ -602,15 +641,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -OverrideAuthTypeForExternalClients -Describes what would happen if you executed the command without actually executing the command. +The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csauthconfig). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -619,15 +657,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -OverrideAuthTypeForInternalClients -Prompts you for confirmation before executing the command. +The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csauthconfig). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -636,16 +673,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -PendingGetWaitSupportingApps -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. +Supported applications are Android, iPhone, iPad, Macintosh, Windows. +To support all applications you can give All as input. +For example: +- To support Android and Macintosh - Android;Macintosh; +- To support all devices - All; +The default value is None. ```yaml -Type: SwitchParameter +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 @@ -654,15 +697,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalAuthentication +### -PendingGetWaitTimeOutInMinutes -When set to True (the default value), OAuth authentication can be used to authenticate external users. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. +The value can be specified in between 5 to 15 minutes (both inclusive). +The default value is 15 minutes. ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -671,19 +717,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoLaunchLyncWebAccess - -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +### -SecondaryLocationSourceUrl -When set to True, Skype for Business Web App will automatically be used as the default web popup for joining an online conference, provided that the prerequisites for using Skype for Business Web App (for example, Silverlight have been installed and Internet Explorer is not blocking pop-up windows) have been met. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is True. +URL for a web service that can process a location request. +This service is only used when location requests cannot be resolved locally. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -694,6 +738,8 @@ Accept wildcard characters: False ### -ShowAlternateJoinOptionsExpanded +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter has been deprecated for use with the on-premises version of Skype for Business Server. When set to True then alternate options for joining an online conference will automatically be expanded and shown to users. @@ -703,7 +749,6 @@ When set to False (the default value) these options will be available, but the u Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -712,16 +757,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWsFedPassiveAuth +### -ShowDownloadCommunicatorAttendeeLink + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +If set to True (the default value), users joining a meeting by using a client application other than Skype for Business will see a link that points them to a download for Skype for Business Web App. -When set to True, allows for passive authentication: authentication of users by using URL redirection or smart linking. -The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -730,15 +778,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WsFedPassiveMetadataUri +### -ShowJoinUsingLegacyClientLink -URI used by the WS-federation Web requestor protocol. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +If set to True, users joining a meeting by using a client application other than Skype for Business will be given the opportunity to join the meeting by using their current client application. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -747,21 +799,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CrossDomainAuthorizationList +### -TrustedCACerts -Collection of domains allowed to host web applications that send cross-domain scripting requests to the Skype for Business Server deployment. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Domains to be added to the list must be created using the `New-CsWebOrigin` cmdlet and then added to the new collection of Web service configuration settings. -Note, too that domain names must be prefaced using the http: or the https: prefix. -See Examples 5, 6 and 7 of this help topic for more information. +Collection of certificates representing certificate chains trusted by the Web Server. +New certificates added to the collection must be created by using the `New-CsWebTrustedCACertificate` cmdlet. -This parameter was introduced in the February, 2013 release of Lync Server 2013. +This collection is not used if the InferCertChainFromSSL property is set to True. ```yaml Type: PSListModifier Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -770,15 +820,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMediaBasicAuth +### -UseCertificateAuth -When set to True ($True), enables basic authentication for media. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), clients can be authenticated using certificates. +Set this value to False to disable certificate authentication. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -787,16 +839,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableStatisticsInResponse +### -UseDomainAuthInLWA -When set to True ($True) the X-MS-WebInfraStats header is included in all HTTP responses. -The default value is False ($False). +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, domain authentication can be employed as a way to authenticate Skype for Business Web App users. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -805,17 +857,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HstsMaxAgeInSeconds +### -UsePinAuth -Specifies the value of max-age in Strict-Transport-Security header in a HTTPS response. -Default value is 315360000. -A negative value means Strict-Transport-Security header will not appear in HTTPS responses. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), clients can be authenticated using personal identification numbers (PINs). +Set this value to False to disable PIN authentication. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -824,16 +876,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PendingGetWaitTimeOutInMinutes -Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. -The value can be specified in between 5 to 15 minutes (both inclusive). -The default value is 15 minutes. +### -UseWebClientLegacyUI + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the user interface is displayed for Lync Server 2013. +When set to False, the Skype for Business user interface is displayed. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -842,40 +895,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PendingGetWaitSupportingApps -Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. -Supported applications are Android, iPhone, iPad, Macintosh, Windows. -To support all applications you can give All as input. -For example: -- To support Android and Macintosh - Android;Macintosh; -- To support all devices - All; -The default value is None. +### -UseWindowsAuth -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: 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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Determines how (and if) users will be authenticated using Windows authentication; that is, using the same credentials they used when they logged on to Windows. +Valid values are: -### -MobilePreferredAuthType +Negotiate - The client and server will work together to determine the proper authentication protocol (either Kerberos or NTLM). -Specifies the default authentication method used for mobile client connectivity. -Values can include: None | OAuth | WebTicketServiceAnon | WebTicketServiceWinNegotiate | WebTicketServiceWinNtlm | WebTicketServiceCert | WebTicketServicePin | WsFedPassive | WsFedBearer | WebTicketServiceAuth. +NTLM - Windows authentication will be allowed, but only using the NTLM protocol. -Note that if this value is set to a method that is not supported, the web ticket service may not start and an error will be generated in the Event log. +None - Windows authentication will not be allowed. ```yaml -Type: MobilePreferredAuthType +Type: UseWindowsAuth Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -884,15 +920,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDomainAuthInLWA +### -UseWsFedPassiveAuth -When set to True, domain authentication can be employed as a way to authenticate Skype for Business Web App users. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, allows for passive authentication: authentication of users by using URL redirection or smart linking. +The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -901,16 +939,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWebClientLegacyUI +### -WsFedPassiveMetadataUri -When set to True, the user interface is displayed for Lync Server 2013. -When set to False, the Skype for Business user interface is displayed. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URI used by the WS-federation Web requestor protocol. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -919,14 +957,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverrideAuthTypeForExternalClients +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -935,14 +975,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverrideAuthTypeForInternalClients +### -WhatIf -The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/Set-CsXmppAllowedPartner.md similarity index 88% rename from skype/skype-ps/skype/Set-CsXmppAllowedPartner.md rename to skype/skype-ps/SkypeForBusiness/Set-CsXmppAllowedPartner.md index cb19f7f293..98999c62e1 100644 --- a/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsXmppAllowedPartner.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Set-CsXmppAllowedPartner -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csxmppallowedpartner +schema: 2.0.0 +title: Set-CsXmppAllowedPartner --- # Set-CsXmppAllowedPartner @@ -50,7 +51,7 @@ Skype for Business Server Control Panel: To edit the property values for an exis ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsXmppAllowedPartner -Identity "contoso.com" -SupportDialbackNegotiation $False ``` @@ -59,7 +60,7 @@ The command shown in Example 1 disables dialback negotiation for the XMPP allowe This is done by including the SupportDialbackNegotiation parameter and setting the parameter value to False ($False). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsXmppAllowedPartner | Set-CsXmppAllowedPartner -SaslNegotiation "Required" ``` @@ -69,7 +70,7 @@ To carry out this task, the command first uses the `Get-CsXmppAllowedPartner` cm That collection is then piped to the `Set-CsXmppAllowedPartner` cmdlet, which sets the value of the SaslNegotiation property for each partner in the collection to Required. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsXmppAllowedPartner -Identity "contoso.com" -AdditionalDomains @{Add="na.contoso.com"} ``` @@ -79,7 +80,7 @@ To do this, the AdditionalDomains parameter is included, along with the syntax @ That syntax adds na.contoso.com to any other domains currently found in the AdditionalDomains property. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsXmppAllowedPartner -Identity "contoso.com" -AdditionalDomains @{Remove="europe.contoso.com"} ``` @@ -89,7 +90,7 @@ To remove this domain, the AdditionalDomains parameter is included along with th That syntax removes Europe.contoso.com from the AdditionalDomains property without affecting any other domains that might also be stored in AdditionalDomains. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Set-CsXmppAllowedPartner -Identity "contoso.com" -AdditionalDomains $Null ``` @@ -101,13 +102,15 @@ This is done by including the AdditionalDomains parameter and the parameter valu ## PARAMETERS ### -AdditionalDomains + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Additional XMPP domains belonging to the allowed partner. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -116,30 +119,16 @@ 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 2013, Skype for Business Server 2015 +### -ConnectionLimit -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -ConnectionLimit Specifies the maximum number of simultaneous connections to a specific partner. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -149,14 +138,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables administrators to provide additional text regarding the XMPP allowed partner. For example, the Description might include contact information for the partner. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -166,13 +157,15 @@ Accept wildcard characters: False ``` ### -EnableKeepAlive + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates whether or not the XMPP partner should periodically transmit "keep alive" packets in order to verify that the connection is still active. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -182,13 +175,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -198,13 +193,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name (FQDN) of the XMPP allowed partner to be modified (for example, fabrikam.com). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -214,13 +211,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -230,6 +229,9 @@ Accept wildcard characters: False ``` ### -PartnerType + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies the relationship between Skype for Business Server and the XMPP partner. Allowed values are: @@ -243,8 +245,7 @@ The default value is PublicUnverified. ```yaml Type: PartnerType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -254,13 +255,15 @@ Accept wildcard characters: False ``` ### -ProxyFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full qualified domain name of the proxy server used by the XMPP partner. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -270,6 +273,9 @@ Accept wildcard characters: False ``` ### -SaslNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates support for the Simple Authentication and Security Layer protocol, a protocol used for server authentication. Allowed values are: @@ -283,8 +289,7 @@ The default value is Required. ```yaml Type: SaslNegotiation Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -294,6 +299,9 @@ Accept wildcard characters: False ``` ### -SupportDialbackNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates whether dialback negotiation will be supported. With dialback negotiation, when Server A contacts Server B communication is not immediately established. Instead, Server B first attempts to verify the identity if Server A by contacting the authoritative DNS server for the domain that Server A claims to be from. @@ -307,8 +315,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -318,6 +325,9 @@ Accept wildcard characters: False ``` ### -TlsNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates support for the Transport Layer Security protocol, a protocol used to encrypt server-to-server data streams. Allowed values are: @@ -332,8 +342,25 @@ The default value is Required. ```yaml Type: TlsNegotiation Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -343,13 +370,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -363,13 +392,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated The `Set-CsXmppAllowedPartner` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsXmppAllowedPartner` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsXmppGatewayConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsXmppGatewayConfiguration.md index 4a97a22ae7..300e90a829 100644 --- a/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsXmppGatewayConfiguration.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Set-CsXmppGatewayConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csxmppgatewayconfiguration +schema: 2.0.0 +title: Set-CsXmppGatewayConfiguration --- # Set-CsXmppGatewayConfiguration @@ -58,7 +59,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsXmppGatewayConfiguration -Identity "global" -ConnectionLimit 1200 ``` @@ -68,31 +69,17 @@ Example 1 modifies the ConnectionLimit property for the global collection of XMP ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -ConnectionLimit -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionLimit Total number of simultaneous connections allowed for all XMPP partners. The default value is 1000. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -102,6 +89,9 @@ Accept wildcard characters: False ``` ### -DialbackPassphrase + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Password used when connecting to an XMPP partner over a TCP dialback connection. With TCP dialback, the partner contacts the XMPP gateway and then hangs up. The XMPP gateway calls the partner back, and the communication session can then begin. @@ -109,8 +99,7 @@ The XMPP gateway calls the partner back, and the communication session can then ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -120,6 +109,9 @@ Accept wildcard characters: False ``` ### -EnableLoggingAllMessageBodies + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, Skype for Business Server will log the actual content of all instant messages. For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files. @@ -129,8 +121,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -140,13 +131,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -156,6 +149,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the XMPP gateway configuration settings to be modified. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the `Set-CsXmppGatewayConfiguration` cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -166,8 +162,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -177,13 +172,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -193,6 +190,9 @@ Accept wildcard characters: False ``` ### -KeepAliveInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum amount of time (in seconds) that can elapse before the partner must send a "keep alive" message. (A keep alive message simply verifies that the connection is still active.) If the time interval expires before a keep alive message is received, the connection will be closed. The default value is 300 seconds. @@ -200,8 +200,7 @@ The default value is 300 seconds. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -211,14 +210,16 @@ Accept wildcard characters: False ``` ### -PartnerConnectionLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Total number of simultaneous connections allowed for a single XMPP partner. The default value is 20. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -228,6 +229,9 @@ Accept wildcard characters: False ``` ### -StreamEstablishmentTimeout + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum amount of time (in seconds) allotted for the XMPP partner to establish an XMPP stream. If this timeout period is surpassed the connection will automatically be terminated. The default value is 60 seconds. @@ -235,8 +239,7 @@ The default value is 60 seconds. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -246,14 +249,16 @@ Accept wildcard characters: False ``` ### -StreamInactivityTimeout + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum amount of time (in seconds) that an XMPP stream can be inactive before the connection is automatically terminated. The default value is 600 seconds (10 minutes). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -263,14 +268,34 @@ Accept wildcard characters: False ``` ### -SubscriptionRefreshInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum amount of time (in seconds) that can elapse before the partner must refresh its presence subscription. The default value is 28800 seconds (8 hours). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -280,13 +305,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -300,13 +327,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings The `Set-CsXmppGatewayConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsXmppGatewayConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings object. ## NOTES diff --git a/skype/skype-ps/skype/Show-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Show-CsClsLogging.md similarity index 90% rename from skype/skype-ps/skype/Show-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Show-CsClsLogging.md index 034eb323fd..6a821bb970 100644 --- a/skype/skype-ps/skype/Show-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Show-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/show-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Show-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/show-csclslogging +schema: 2.0.0 +title: Show-CsClsLogging --- # Show-CsClsLogging @@ -40,7 +41,7 @@ The `Show-CsClsLogging` cmdlet returns information about all the scenarios curre ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Show-CsClsLogging ``` @@ -48,7 +49,7 @@ Show-CsClsLogging The command shown in Example 1 returns information about the scenarios currently being logged on the server where this cmdlet is run. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Show-CsClsLogging -Pools "atl-cs-001.litwareinc.com" ``` @@ -59,13 +60,15 @@ In Example 2, logging information is returned for all the servers in the pool `a ## PARAMETERS ### -AsXml + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, information is returned using XML. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to return logging information from a specified server or set of servers. To return information from a single server, specify the fully qualified domain name of that server. For example: @@ -91,8 +97,7 @@ If you do not include the Computers parameter or the Pools parameter, the `Show- ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to return logging information for each server in a pool. To return information for a pool, specify the fully qualified domain name of that pool. For example: @@ -115,8 +123,7 @@ Multiple pools can be specified by separating the pool FQDNs using commas: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,14 +137,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Show-CsClsLogging` cmdlet does not accept pipelined input. ## OUTPUTS -### -String value or XML output. +### System.Stringvalue or XML output. The `Show-CsClsLogging` cmdlet does not return objects. ## NOTES diff --git a/skype/skype-ps/skype/skype.md b/skype/skype-ps/SkypeForBusiness/SkypeForBusiness.md similarity index 95% rename from skype/skype-ps/skype/skype.md rename to skype/skype-ps/SkypeForBusiness/SkypeForBusiness.md index 54e242ca7d..2e82d832ab 100644 --- a/skype/skype-ps/skype/skype.md +++ b/skype/skype-ps/SkypeForBusiness/SkypeForBusiness.md @@ -28,6 +28,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Clear-CsDeviceUpdateLog](Clear-CsDeviceUpdateLog.md) ### [Clear-CsPersistentChatRoom](Clear-CsPersistentChatRoom.md) ### [Convert-CsUserData](Convert-CsUserData.md) +### [ConvertTo-JsonForPSWS](ConvertTo-JsonForPSWS.md) ### [Copy-CsVoicePolicy](Copy-CsVoicePolicy.md) ### [Debug-CsAddressBookReplication](Debug-CsAddressBookReplication.md) ### [Debug-CsDataConference](Debug-CsDataConference.md) @@ -41,7 +42,6 @@ The following cmdlet references are for Skype for Business Server Management She ### [Disable-CsComputer](Disable-CsComputer.md) ### [Disable-CsHostingProvider](Disable-CsHostingProvider.md) ### [Disable-CsMeetingRoom](Disable-CsMeetingRoom.md) -### [Disable-CsOnlineDialInConferencingUser](Disable-CsOnlineDialInConferencingUser.md) ### [Disable-CsPublicProvider](Disable-CsPublicProvider.md) ### [Disable-CsUser](Disable-CsUser.md) ### [Enable-CsAdDomain](Enable-CsAdDomain.md) @@ -78,6 +78,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Get-CsApplicationEndpoint](Get-CsApplicationEndpoint.md) ### [Get-CsArchivingConfiguration](Get-CsArchivingConfiguration.md) ### [Get-CsArchivingPolicy](Get-CsArchivingPolicy.md) +### [Get-CsAudioConferencingProvider](Get-CsAudioConferencingProvider.md) ### [Get-CsAudioTestServiceApplication](Get-CsAudioTestServiceApplication.md) ### [Get-CsAuthConfig](Get-CsAuthConfig.md) ### [Get-CsAutodiscoverConfiguration](Get-CsAutodiscoverConfiguration.md) @@ -86,6 +87,8 @@ The following cmdlet references are for Skype for Business Server Management She ### [Get-CsBackupServiceStatus](Get-CsBackupServiceStatus.md) ### [Get-CsBandwidthPolicyServiceConfiguration](Get-CsBandwidthPolicyServiceConfiguration.md) ### [Get-CsBlockedDomain](Get-CsBlockedDomain.md) +### [Get-CsBroadcastMeetingConfiguration](Get-CsBroadcastMeetingConfiguration.md) +### [Get-CsBroadcastMeetingPolicy](Get-CsBroadcastMeetingPolicy.md) ### [Get-CsBusyOptions](Get-CsBusyOptions.md) ### [Get-CsCallParkOrbit](Get-CsCallParkOrbit.md) ### [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) @@ -100,6 +103,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Get-CsClientVersionPolicyRule](Get-CsClientVersionPolicyRule.md) ### [Get-CsCloudCallDataConnector](Get-CsCloudCallDataConnector.md) ### [Get-CsCloudCallDataConnectorConfiguration](Get-CsCloudCallDataConnectorConfiguration.md) +### [Get-CsCloudMeetingPolicy](Get-CsCloudMeetingPolicy.md) ### [Get-CsClsAgentStatus](Get-CsClsAgentStatus.md) ### [Get-CsClsConfiguration](Get-CsClsConfiguration.md) ### [Get-CsClsRegion](Get-CsClsRegion.md) @@ -128,14 +132,19 @@ The following cmdlet references are for Skype for Business Server Management She ### [Get-CsEffectivePolicy](Get-CsEffectivePolicy.md) ### [Get-CsEnhancedEmergencyServiceDisclaimer](Get-CsEnhancedEmergencyServiceDisclaimer.md) ### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) +### [Get-CsExternalUserCommunicationPolicy](Get-CsExternalUserCommunicationPolicy.md) ### [Get-CsExUmContact](Get-CsExUmContact.md) ### [Get-CsFileTransferFilterConfiguration](Get-CsFileTransferFilterConfiguration.md) ### [Get-CsFIPSConfiguration](Get-CsFIPSConfiguration.md) +### [Get-CsGraphPolicy](Get-CsGraphPolicy.md) ### [Get-CsGroupPickupUserOrbit](Get-CsGroupPickupUserOrbit.md) ### [Get-CsHealthMonitoringConfiguration](Get-CsHealthMonitoringConfiguration.md) ### [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) ### [Get-CsHostingProvider](Get-CsHostingProvider.md) ### [Get-CsHybridApplicationEndpoint](Get-CsHybridApplicationEndpoint.md) +### [Get-CsHybridMediationServer](Get-CsHybridMediationServer.md) +### [Get-CsHybridPSTNAppliance](Get-CsHybridPSTNAppliance.md) +### [Get-CsHybridPSTNSite](Get-CsHybridPSTNSite.md) ### [Get-CsImConfiguration](Get-CsImConfiguration.md) ### [Get-CsImFilterConfiguration](Get-CsImFilterConfiguration.md) ### [Get-CsImTranslationConfiguration](Get-CsImTranslationConfiguration.md) @@ -167,12 +176,6 @@ The following cmdlet references are for Skype for Business Server Management She ### [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) ### [Get-CsOAuthConfiguration](Get-CsOAuthConfiguration.md) ### [Get-CsOAuthServer](Get-CsOAuthServer.md) -### [Get-CsOnlineDialInConferencingBridge](Get-CsOnlineDialInConferencingBridge.md) -### [Get-CsOnlineDialInConferencingLanguagesSupported](Get-CsOnlineDialInConferencingLanguagesSupported.md) -### [Get-CsOnlineDialInConferencingUserInfo](Get-CsOnlineDialInConferencingUserInfo.md) -### [Get-CsOnlineDialInConferencingUserState](Get-CsOnlineDialInConferencingUserState.md) -### [Get-CsOnlineNumberPortInOrder](Get-CsOnlineNumberPortInOrder.md) -### [Get-CsOnlineNumberPortOutOrderPin](Get-CsOnlineNumberPortOutOrderPin.md) ### [Get-CsOutboundCallingNumberTranslationRule](Get-CsOutboundCallingNumberTranslationRule.md) ### [Get-CsOutboundTranslationRule](Get-CsOutboundTranslationRule.md) ### [Get-CsPartnerApplication](Get-CsPartnerApplication.md) @@ -224,6 +227,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) ### [Get-CsTelemetryConfiguration](Get-CsTelemetryConfiguration.md) ### [Get-CsTenantHybridConfiguration](Get-CsTenantHybridConfiguration.md) +### [Get-CsTenantUpdateTimeWindow](Get-CsTenantUpdateTimeWindow.md) ### [Get-CsTestDevice](Get-CsTestDevice.md) ### [Get-CsTestUserCredential](Get-CsTestUserCredential.md) ### [Get-CsThirdPartyVideoSystem](Get-CsThirdPartyVideoSystem.md) @@ -244,10 +248,13 @@ The following cmdlet references are for Skype for Business Server Management She ### [Get-CsUserCallForwardingSettings](Get-CsUserCallForwardingSettings.md) ### [Get-CsUserDatabaseState](Get-CsUserDatabaseState.md) ### [Get-CsUserDelegates](Get-CsUserDelegates.md) +### [Get-CsUserLocationStatus](Get-CsUserLocationStatus.md) ### [Get-CsUserPoolInfo](Get-CsUserPoolInfo.md) +### [Get-CsUserPstnSettings](Get-CsUserPstnSettings.md) ### [Get-CsUserReplicatorConfiguration](Get-CsUserReplicatorConfiguration.md) ### [Get-CsUserServicesConfiguration](Get-CsUserServicesConfiguration.md) ### [Get-CsUserServicesPolicy](Get-CsUserServicesPolicy.md) +### [Get-CsUserSession](Get-CsUserSession.md) ### [Get-CsUserSettingsPageConfiguration](Get-CsUserSettingsPageConfiguration.md) ### [Get-CsUserTeamMembers](Get-CsUserTeamMembers.md) ### [Get-CsVideoInteropServerConfiguration](Get-CsVideoInteropServerConfiguration.md) @@ -273,6 +280,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Grant-CsConferencingPolicy](Grant-CsConferencingPolicy.md) ### [Grant-CsDialPlan](Grant-CsDialPlan.md) ### [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) +### [Grant-CsGraphPolicy](Grant-CsGraphPolicy.md) ### [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) ### [Grant-CsIPPhonePolicy](Grant-CsIPPhonePolicy.md) ### [Grant-CsLocationPolicy](Grant-CsLocationPolicy.md) @@ -373,6 +381,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [New-CsEmergencyNumber](New-CsEmergencyNumber.md) ### [New-CsExtendedTest](New-CsExtendedTest.md) ### [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) +### [New-CsExternalUserCommunicationPolicy](New-CsExternalUserCommunicationPolicy.md) ### [New-CsExUmContact](New-CsExUmContact.md) ### [New-CsFileTransferFilterConfiguration](New-CsFileTransferFilterConfiguration.md) ### [New-CsFIPSConfiguration](New-CsFIPSConfiguration.md) @@ -381,6 +390,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [New-CsHostedVoicemailPolicy](New-CsHostedVoicemailPolicy.md) ### [New-CsHostingProvider](New-CsHostingProvider.md) ### [New-CsHybridApplicationEndpoint](New-CsHybridApplicationEndpoint.md) +### [New-CsHybridPSTNSite](New-CsHybridPSTNSite.md) ### [New-CsImConfiguration](New-CsImConfiguration.md) ### [New-CsImFilterConfiguration](New-CsImFilterConfiguration.md) ### [New-CsImTranslationConfiguration](New-CsImTranslationConfiguration.md) @@ -403,9 +413,6 @@ The following cmdlet references are for Skype for Business Server Management She ### [New-CsNetworkSite](New-CsNetworkSite.md) ### [New-CsNetworkSubnet](New-CsNetworkSubnet.md) ### [New-CsOAuthServer](New-CsOAuthServer.md) -### [New-CsOnlineBulkAssignmentInput](New-CsOnlineBulkAssignmentInput.md) -### [New-CsOnlineNumberPortInOrder](New-CsOnlineNumberPortInOrder.md) -### [New-CsOnlineSession](New-CsOnlineSession.md) ### [New-CsOutboundCallingNumberTranslationRule](New-CsOutboundCallingNumberTranslationRule.md) ### [New-CsOutboundTranslationRule](New-CsOutboundTranslationRule.md) ### [New-CsPartnerApplication](New-CsPartnerApplication.md) @@ -457,6 +464,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [New-CsStorageServiceConfiguration](New-CsStorageServiceConfiguration.md) ### [New-CsTeamsUpgradePolicy](New-CsTeamsUpgradePolicy.md) ### [New-CsTelemetryConfiguration](New-CsTelemetryConfiguration.md) +### [New-CsTenantUpdateTimeWindow](New-CsTenantUpdateTimeWindow.md) ### [New-CsTestDevice](New-CsTestDevice.md) ### [New-CsThirdPartyVideoSystem](New-CsThirdPartyVideoSystem.md) ### [New-CsThirdPartyVideoSystemPolicy](New-CsThirdPartyVideoSystemPolicy.md) @@ -488,6 +496,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [New-CsXmppAllowedPartner](New-CsXmppAllowedPartner.md) ### [Publish-CsLisConfiguration](Publish-CsLisConfiguration.md) ### [Publish-CsTopology](Publish-CsTopology.md) +### [Register-CsHybridPSTNAppliance](Register-CsHybridPSTNAppliance.md) ### [Remove-CsAdditionalInternalDomain](Remove-CsAdditionalInternalDomain.md) ### [Remove-CsAddressBookConfiguration](Remove-CsAddressBookConfiguration.md) ### [Remove-CsAddressBookNormalizationConfiguration](Remove-CsAddressBookNormalizationConfiguration.md) @@ -534,6 +543,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Remove-CsDialPlan](Remove-CsDialPlan.md) ### [Remove-CsEnhancedEmergencyServiceDisclaimer](Remove-CsEnhancedEmergencyServiceDisclaimer.md) ### [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) +### [Remove-CsExternalUserCommunicationPolicy](Remove-CsExternalUserCommunicationPolicy.md) ### [Remove-CsExUmContact](Remove-CsExUmContact.md) ### [Remove-CsFileTransferFilterConfiguration](Remove-CsFileTransferFilterConfiguration.md) ### [Remove-CsFIPSConfiguration](Remove-CsFIPSConfiguration.md) @@ -542,6 +552,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Remove-CsHostedVoicemailPolicy](Remove-CsHostedVoicemailPolicy.md) ### [Remove-CsHostingProvider](Remove-CsHostingProvider.md) ### [Remove-CsHybridApplicationEndpoint](Remove-CsHybridApplicationEndpoint.md) +### [Remove-CsHybridPSTNSite](Remove-CsHybridPSTNSite.md) ### [Remove-CsImConfiguration](Remove-CsImConfiguration.md) ### [Remove-CsImFilterConfiguration](Remove-CsImFilterConfiguration.md) ### [Remove-CsImTranslationConfiguration](Remove-CsImTranslationConfiguration.md) @@ -567,7 +578,6 @@ The following cmdlet references are for Skype for Business Server Management She ### [Remove-CsNetworkSite](Remove-CsNetworkSite.md) ### [Remove-CsNetworkSubnet](Remove-CsNetworkSubnet.md) ### [Remove-CsOAuthServer](Remove-CsOAuthServer.md) -### [Remove-CsOnlineNumberPortInOrder](Remove-CsOnlineNumberPortInOrder.md) ### [Remove-CsOutboundCallingNumberTranslationRule](Remove-CsOutboundCallingNumberTranslationRule.md) ### [Remove-CsOutboundTranslationRule](Remove-CsOutboundTranslationRule.md) ### [Remove-CsPartnerApplication](Remove-CsPartnerApplication.md) @@ -606,6 +616,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Remove-CsStorageServiceConfiguration](Remove-CsStorageServiceConfiguration.md) ### [Remove-CsTeamsUpgradePolicy](Remove-CsTeamsUpgradePolicy.md) ### [Remove-CsTelemetryConfiguration](Remove-CsTelemetryConfiguration.md) +### [Remove-CsTenantUpdateTimeWindow](Remove-CsTenantUpdateTimeWindow.md) ### [Remove-CsTestDevice](Remove-CsTestDevice.md) ### [Remove-CsTestUserCredential](Remove-CsTestUserCredential.md) ### [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) @@ -664,10 +675,14 @@ The following cmdlet references are for Skype for Business Server Management She ### [Set-CsBackupServiceConfiguration](Set-CsBackupServiceConfiguration.md) ### [Set-CsBandwidthPolicyServiceConfiguration](Set-CsBandwidthPolicyServiceConfiguration.md) ### [Set-CsBlockedDomain](Set-CsBlockedDomain.md) +### [Set-CsBroadcastMeetingConfiguration](Set-CsBroadcastMeetingConfiguration.md) ### [Set-CsBusyOptions](Set-CsBusyOptions.md) ### [Set-CsCallParkOrbit](Set-CsCallParkOrbit.md) ### [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) ### [Set-CsCallViaWorkPolicy](Set-CsCallViaWorkPolicy.md) +### [Set-CsCceApplianceConfigurationReplicationStatus](Set-CsCceApplianceConfigurationReplicationStatus.md) +### [Set-CsCceApplianceDeploymentStatus](Set-CsCceApplianceDeploymentStatus.md) +### [Set-CsCceApplianceStatus](Set-CsCceApplianceStatus.md) ### [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) ### [Set-CsCertificate](Set-CsCertificate.md) ### [Set-CsClientPin](Set-CsClientPin.md) @@ -701,6 +716,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Set-CsEdgeServer](Set-CsEdgeServer.md) ### [Set-CsEnhancedEmergencyServiceDisclaimer](Set-CsEnhancedEmergencyServiceDisclaimer.md) ### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) +### [Set-CsExternalUserCommunicationPolicy](Set-CsExternalUserCommunicationPolicy.md) ### [Set-CsExUmContact](Set-CsExUmContact.md) ### [Set-CsFileTransferFilterConfiguration](Set-CsFileTransferFilterConfiguration.md) ### [Set-CsFIPSConfiguration](Set-CsFIPSConfiguration.md) @@ -709,6 +725,9 @@ The following cmdlet references are for Skype for Business Server Management She ### [Set-CsHostedVoicemailPolicy](Set-CsHostedVoicemailPolicy.md) ### [Set-CsHostingProvider](Set-CsHostingProvider.md) ### [Set-CsHybridApplicationEndpoint](Set-CsHybridApplicationEndpoint.md) +### [Set-CsHybridMediationServer](Set-CsHybridMediationServer.md) +### [Set-CsHybridPSTNAppliance](Set-CsHybridPSTNAppliance.md) +### [Set-CsHybridPSTNSite](Set-CsHybridPSTNSite.md) ### [Set-CsImConfiguration](Set-CsImConfiguration.md) ### [Set-CsImFilterConfiguration](Set-CsImFilterConfiguration.md) ### [Set-CsImTranslationConfiguration](Set-CsImTranslationConfiguration.md) @@ -741,11 +760,6 @@ The following cmdlet references are for Skype for Business Server Management She ### [Set-CsNetworkSubnet](Set-CsNetworkSubnet.md) ### [Set-CsOAuthConfiguration](Set-CsOAuthConfiguration.md) ### [Set-CsOAuthServer](Set-CsOAuthServer.md) -### [Set-CsOnlineDialInConferencingUserDefaultNumber](Set-CsOnlineDialInConferencingUserDefaultNumber.md) -### [Set-CsOnlineDirectoryUser](Set-CsOnlineDirectoryUser.md) -### [Set-CsOnlineNumberPortInOrder](Set-CsOnlineNumberPortInOrder.md) -### [Set-CsOnlineNumberPortOutOrderPin](Set-CsOnlineNumberPortOutOrderPin.md) -### [Set-CsOnlineVoiceUserBulk](Set-CsOnlineVoiceUserBulk.md) ### [Set-CsOutboundCallingNumberTranslationRule](Set-CsOutboundCallingNumberTranslationRule.md) ### [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) ### [Set-CsPartnerApplication](Set-CsPartnerApplication.md) @@ -791,6 +805,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Set-CsTeamsUpgradePolicy](Set-CsTeamsUpgradePolicy.md) ### [Set-CsTelemetryConfiguration](Set-CsTelemetryConfiguration.md) ### [Set-CsTenantHybridConfiguration](Set-CsTenantHybridConfiguration.md) +### [Set-CsTenantUpdateTimeWindow](Set-CsTenantUpdateTimeWindow.md) ### [Set-CsTestDevice](Set-CsTestDevice.md) ### [Set-CsTestUserCredential](Set-CsTestUserCredential.md) ### [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) @@ -807,6 +822,7 @@ The following cmdlet references are for Skype for Business Server Management She ### [Set-CsUserCallForwardingSettings](Set-CsUserCallForwardingSettings.md) ### [Set-CsUserDatabaseState](Set-CsUserDatabaseState.md) ### [Set-CsUserDelegates](Set-CsUserDelegates.md) +### [Set-CsUserPstnSettings](Set-CsUserPstnSettings.md) ### [Set-CsUserReplicatorConfiguration](Set-CsUserReplicatorConfiguration.md) ### [Set-CsUserServer](Set-CsUserServer.md) ### [Set-CsUserServicesConfiguration](Set-CsUserServicesConfiguration.md) @@ -830,7 +846,6 @@ The following cmdlet references are for Skype for Business Server Management She ### [Set-CsXmppAllowedPartner](Set-CsXmppAllowedPartner.md) ### [Set-CsXmppGatewayConfiguration](Set-CsXmppGatewayConfiguration.md) ### [Show-CsClsLogging](Show-CsClsLogging.md) -### [skype](skype.md) ### [Start-CsClsLogging](Start-CsClsLogging.md) ### [Start-CsPool](Start-CsPool.md) ### [Start-CsWindowsService](Start-CsWindowsService.md) @@ -869,9 +884,6 @@ The following cmdlet references are for Skype for Business Server Management She ### [Test-CsMcxConference](Test-CsMcxConference.md) ### [Test-CsMcxP2PIM](Test-CsMcxP2PIM.md) ### [Test-CsMcxPushNotification](Test-CsMcxPushNotification.md) -### [Test-CsOnlineCarrierPortabilityIn](Test-CsOnlineCarrierPortabilityIn.md) -### [Test-CsOnlineLisCivicAddress](Test-CsOnlineLisCivicAddress.md) -### [Test-CsOnlinePortabilityIn](Test-CsOnlinePortabilityIn.md) ### [Test-CsOUPermission](Test-CsOUPermission.md) ### [Test-CsP2PAV](Test-CsP2PAV.md) ### [Test-CsP2PVideoInteropServerSipTrunkAV](Test-CsP2PVideoInteropServerSipTrunkAV.md) @@ -901,8 +913,10 @@ The following cmdlet references are for Skype for Business Server Management She ### [Uninstall-CsMirrorDatabase](Uninstall-CsMirrorDatabase.md) ### [Unlock-CsClientPin](Unlock-CsClientPin.md) ### [Unpublish-CsLisConfiguration](Unpublish-CsLisConfiguration.md) +### [Unregister-CsHybridPSTNAppliance](Unregister-CsHybridPSTNAppliance.md) ### [Update-CsAddressBook](Update-CsAddressBook.md) ### [Update-CsAdminRole](Update-CsAdminRole.md) ### [Update-CsClsLogging](Update-CsClsLogging.md) +### [Update-CsTenantMeetingUrl](Update-CsTenantMeetingUrl.md) ### [Update-CsUserData](Update-CsUserData.md) ### [Update-CsUserDatabase](Update-CsUserDatabase.md) diff --git a/skype/skype-ps/skype/Start-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Start-CsClsLogging.md similarity index 89% rename from skype/skype-ps/skype/Start-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Start-CsClsLogging.md index 52f1ac216a..52b4673fa7 100644 --- a/skype/skype-ps/skype/Start-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Start-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/start-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Start-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/start-csclslogging +schema: 2.0.0 +title: Start-CsClsLogging --- # Start-CsClsLogging @@ -43,7 +44,7 @@ However, administrators can manually stop a logging operation at any time by usi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Start-CsClsLogging -Scenario "AlwaysOn" ``` @@ -51,7 +52,7 @@ Start-CsClsLogging -Scenario "AlwaysOn" Example 1 starts logging the AlwaysOn scenario on all the computers in the current topology. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Start-CsClsLogging -Scenario "cps" -Pools "atl-cs-001.litwareinc.com" -Duration 12:00 ``` @@ -61,36 +62,16 @@ The command shown in Example 2 starts CPS logging on all the computers in the po ## PARAMETERS -### -Scenario -Name of the centralized logging scenario to be started. -Available scenarios (and their names) names can be returned by using this command: - -`Get-CsClsScenario | Select-Object Name` - -Note that you can only specify one scenario per call to the `Start-CsClsLogging` cmdlet. -Also only one scenario other than the "AlwaysOn" scenario can be started on a computer at any one time. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AsXml -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AsXml When specified, information is returned using XML. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +81,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to start logging on a specified server or set of servers. To start logging on a single server, specify the fully qualified domain name of that server. For example: @@ -116,8 +100,7 @@ If you do not include the Computers parameter or the Pools parameter, the `Start ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,6 +110,9 @@ Accept wildcard characters: False ``` ### -Duration + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Amount of time that the logging operation should run. For example, this syntax causes the logging operation to run for 2 hours (0 days.02 hours:00 minutes) and then stop: @@ -146,8 +132,7 @@ The default value is 4 hours (04:00). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +142,9 @@ Accept wildcard characters: False ``` ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to start logging a scenario on each server in a pool. To start logging in a pool, specify the fully qualified domain name of that pool. For example: @@ -170,8 +158,7 @@ Multiple pools can be specified by separating the pool FQDNs using commas: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,19 +167,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Scenario + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the centralized logging scenario to be started. +Available scenarios (and their names) names can be returned by using this command: + +`Get-CsClsScenario | Select-Object Name` + +Note that you can only specify one scenario per call to the `Start-CsClsLogging` cmdlet. +Also only one scenario other than the "AlwaysOn" scenario can be started on a computer at any one time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None. +### None The `Start-CsClsLogging` cmdlet does not accept pipelined input. ## OUTPUTS -### -String value or XML output. +### System.Stringvalue or XML output. The `Start-CsClsLogging` cmdlet does not return objects. ## NOTES diff --git a/skype/skype-ps/skype/Start-CsPool.md b/skype/skype-ps/SkypeForBusiness/Start-CsPool.md similarity index 87% rename from skype/skype-ps/skype/Start-CsPool.md rename to skype/skype-ps/SkypeForBusiness/Start-CsPool.md index 61b0bbeaf5..a8eb6efdcd 100644 --- a/skype/skype-ps/skype/Start-CsPool.md +++ b/skype/skype-ps/SkypeForBusiness/Start-CsPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/start-cspool applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Start-CsPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/start-cspool +schema: 2.0.0 +title: Start-CsPool --- # Start-CsPool @@ -30,7 +31,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Start-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" -SkipRoutingGroup "bef5fa3b-3c97-4af0-abe7-611deee7616c" ``` @@ -40,31 +41,16 @@ This example starts the `"atl-cs-001.litwareinc.com"` pool and skips one routing ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool being started. -For example: `-PoolFqdn "atl-cs-001.litwareinc.com"` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -73,31 +59,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +### -PoolFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being started. +For example: `-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -QuorumLossRecovery + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If true ($True), user data is reloaded from the backup store for any routing groups currently in quorum loss. (A quorum loss occurs when neither a database nor its replicas are available.) The default is false ($False.) ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +98,9 @@ Accept wildcard characters: False ``` ### -SkipRoutingGroup + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies one or more routing groups by GUID to skip during startup. Use this parameter if one or more of the routing groups are having problems getting placed on servers. @@ -118,8 +112,7 @@ To specify more than one routing group use the syntax: `-SkipRoutingGroup "bef5f ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,6 +122,9 @@ Accept wildcard characters: False ``` ### -SkipServer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies one or more servers to skip during startup. Use this parameter if one or more of the front end servers cannot be started. Note that there is a minimum number of servers required for the pool to be functional. @@ -140,8 +136,25 @@ To specify more than one server use the syntax: `-SkipServer "AtlServerOne.litwa ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -151,13 +164,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -171,13 +186,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None +### None ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Start-CsWindowsService.md b/skype/skype-ps/SkypeForBusiness/Start-CsWindowsService.md similarity index 86% rename from skype/skype-ps/skype/Start-CsWindowsService.md rename to skype/skype-ps/SkypeForBusiness/Start-CsWindowsService.md index ab1c0c8008..f211e60d1e 100644 --- a/skype/skype-ps/skype/Start-CsWindowsService.md +++ b/skype/skype-ps/SkypeForBusiness/Start-CsWindowsService.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/start-cswindowsservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Start-CsWindowsService -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/start-cswindowsservice +schema: 2.0.0 +title: Start-CsWindowsService --- # Start-CsWindowsService @@ -50,7 +51,7 @@ However, the `Start-CsWindowsService` cmdlet will not automatically start any de ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Start-CsWindowsService ``` @@ -60,7 +61,7 @@ This is done by calling the `Start-CsWindowsService` cmdlet without any paramete Note that you will not receive an error if you try to start a service that has already been started. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Start-CsWindowsService -Name "RTCRGS" ``` @@ -69,7 +70,7 @@ Example 2 starts the Response Group application service on the local computer. To do this, the command uses the Name parameter followed by the service name: RTCRGS. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Start-CsWindowsService -Name "RTCRGS" -ComputerName atl-cs-001.litwareinc.com ``` @@ -78,7 +79,7 @@ The command shown in Example 3 also starts the Response Group application servic To start a service on a remote computer, include the ComputerName parameter followed by the FQDN of the remote computer. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsWindowsService | Where-Object {$_.Status -ne "Running"} | Start-CsWindowsService ``` @@ -91,39 +92,36 @@ This filtered collection is then piped to the `Start-CsWindowsService` cmdlet, w ## PARAMETERS -### -Name -Name of the Skype for Business Server service you want to start. -Note that you must use the service name (for example, RTCCAA) and not the service display name. -You can only pass a single service name to the Name parameter, and you cannot use wildcards in the service name. -Service names can be retrieved using the `Get-CsWindowsService` cmdlet. +### -ComputerName -Keep in mind that the `Start-CsWindowsService` cmdlet can only start Skype for Business Server services; you cannot use this cmdlet to start other Windows services. -For those services, you might be able to use the Windows PowerShell `Start-Service` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the remote computer hosting the service to be started; if this parameter is not included, then the `Start-CsWindowsService` cmdlet will start the specified service (or services) on the local computer. +The remote computer should be referenced using its FQDN; for example, atl-cs-001.litwareinc.com. ```yaml Type: String Parameter Sets: Name -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName -Name of the remote computer hosting the service to be started; if this parameter is not included, then the `Start-CsWindowsService` cmdlet will start the specified service (or services) on the local computer. -The remote computer should be referenced using its FQDN; for example, atl-cs-001.litwareinc.com. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -133,6 +131,9 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to start a service using an object reference rather than a service name. For example, if you use the `Get-CsWindowsService` cmdlet to return information about a service, and if you store the returned object in a variable named $x, you can then start the service using this command: @@ -144,8 +145,7 @@ For example, if you use the `Get-CsWindowsService` cmdlet to return information ```yaml Type: NTService Parameter Sets: InputObject -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,31 +154,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -NoWait -When present, causes the command to run and then immediately return control to the Windows PowerShell prompt. -If not present, control will not be returned until the command has completed and a status report has been written to the screen. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the Skype for Business Server service you want to start. +Note that you must use the service name (for example, RTCCAA) and not the service display name. +You can only pass a single service name to the Name parameter, and you cannot use wildcards in the service name. +Service names can be retrieved using the `Get-CsWindowsService` cmdlet. + +Keep in mind that the `Start-CsWindowsService` cmdlet can only start Skype for Business Server services; you cannot use this cmdlet to start other Windows services. +For those services, you might be able to use the Windows PowerShell `Start-Service` cmdlet. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Name +Aliases: Required: False -Position: Named +Position: 2 Default value: None 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. +### -NoWait + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, causes the command to run and then immediately return control to the Windows PowerShell prompt. +If not present, control will not be returned until the command has completed and a status report has been written to the screen. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,14 +199,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to an HTML file where error information can be stored. If this parameter is included, any errors that occur during the running of this cmdlet will be logged to the specified file (for example, C:\Logs\Service_report.html). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,14 +217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -220,14 +235,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -241,14 +258,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Deployment.Core.NTService object. +### Microsoft.Rtc.Management.Deployment.Core.NTService + The `Start-CsWindowsService` cmdlet accepts pipelined instances of the Windows service object. ## OUTPUTS -### -None. +### None Instead, the `Start-CsWindowsService` cmdlet starts instances of the Microsoft.Rtc.Management.Deployment.Core.NTService object. ## NOTES diff --git a/skype/skype-ps/skype/Stop-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Stop-CsClsLogging.md similarity index 89% rename from skype/skype-ps/skype/Stop-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Stop-CsClsLogging.md index 46d2784689..4e6d5c9e36 100644 --- a/skype/skype-ps/skype/Stop-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Stop-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/stop-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Stop-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/stop-csclslogging +schema: 2.0.0 +title: Stop-CsClsLogging --- # Stop-CsClsLogging @@ -42,7 +43,7 @@ However, administrators can manually stop a logging operation at any time by usi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Stop-CsClsLogging -Scenario "cps" ``` @@ -50,7 +51,7 @@ Stop-CsClsLogging -Scenario "cps" The command shown in Example 1 stops the CPS logging scenario on all the servers in the topology. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Stop-CsClsLogging -Scenario "cps" -Pools "atl-cs-001.litwareinc.com" ``` @@ -60,33 +61,16 @@ In Example 2, CPS logging scenario is stopped on all the servers in the pool `at ## PARAMETERS -### -Scenario -Name of the centralized logging scenario to be stopped. -Available scenarios (and their names) names can be returned by using this command: - -`Get-CsClsScenario | Select-Object Name` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AsXml -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AsXml When specified, information is returned using XML. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,6 +80,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to stop logging on a specified server or set of servers. To stop logging on a single server, specify the fully qualified domain name of that server. For example: @@ -112,8 +99,7 @@ If you do not include the Computers parameter or the Pools parameter, the `Stop- ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +109,9 @@ Accept wildcard characters: False ``` ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to stop logging on each server in a pool. To stop logging in a pool, specify the fully qualified domain name of that pool. For example: @@ -136,8 +125,7 @@ Multiple pools can be specified by separating the pool FQDNs using commas: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,19 +134,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Scenario + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the centralized logging scenario to be stopped. +Available scenarios (and their names) names can be returned by using this command: + +`Get-CsClsScenario | Select-Object Name` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None. +### None The `Stop-CsClsLogging` cmdlet does not accept pipelined input. ## OUTPUTS -### -String value or XML output. +### System.Stringvalue or XML output. The `Stop-CsClsLogging` cmdlet does not return objects. ## NOTES diff --git a/skype/skype-ps/skype/Stop-CsWindowsService.md b/skype/skype-ps/SkypeForBusiness/Stop-CsWindowsService.md similarity index 86% rename from skype/skype-ps/skype/Stop-CsWindowsService.md rename to skype/skype-ps/SkypeForBusiness/Stop-CsWindowsService.md index fa3302b7ad..39b0ed4729 100644 --- a/skype/skype-ps/skype/Stop-CsWindowsService.md +++ b/skype/skype-ps/SkypeForBusiness/Stop-CsWindowsService.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/stop-cswindowsservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Stop-CsWindowsService -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/stop-cswindowsservice +schema: 2.0.0 +title: Stop-CsWindowsService --- # Stop-CsWindowsService @@ -53,7 +54,7 @@ Eventually, all the existing requests will be filled and the service will then s ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Stop-CsWindowsService -Name "RTCRGS" ``` @@ -62,7 +63,7 @@ The command shown in Example 1 stops the Response Group application service on t The Response Group application service is identified by including the Name parameter and the name of that service: RTCRGS. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Stop-CsWindowsService -Name "RTCRGS" -ComputerName atl-cs-001.litwareinc.com ``` @@ -71,7 +72,7 @@ Example 2 also stops the Response Group application service; in this example, ho To stop a service on a remote computer, include the ComputerName parameter followed by the FQDN of the remote computer. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsWindowsService | Where-Object {$_.DisplayName -like "*Call Park*"} | Stop-CsWindowsService ``` @@ -84,39 +85,36 @@ The filtered collection is then piped to the `Stop-CsWindowsService` cmdlet, whi ## PARAMETERS -### -Name -Name of the Skype for Business Server service you want to stop. -Note that you must use the service name (for example, RTCCAA) and not the service display name. -You can only pass a single service name to the Name parameter, and you cannot use wildcards in the service name. -You can use the `Get-CsWindowsService` cmdlet to retrieve service names. +### -ComputerName -Keep in mind that the `Stop-CsWindowsService` cmdlet can only stop Skype for Business Server services; you cannot use this cmdlet to stop other Windows services. -For those services, you might be able to use the Windows PowerShell `Stop-Service` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the remote computer running the service to be stopped; if this parameter is not included, then the `Stop-CsWindowsService` cmdlet will stop the specified service on the local computer. +The remote computer should be referenced using its FQDN; for example, atl-mcs-001.litwareinc.com. ```yaml Type: String Parameter Sets: Name -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName -Name of the remote computer running the service to be stopped; if this parameter is not included, then the `Stop-CsWindowsService` cmdlet will stop the specified service on the local computer. -The remote computer should be referenced using its FQDN; for example, atl-mcs-001.litwareinc.com. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -126,14 +124,16 @@ Accept wildcard characters: False ``` ### -Graceful + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Instead of immediately shutting down a service, waits until all existing service requests have been filled. (However, all new service requests will be rejected.) The service will not completely shut down until all the existing requests have been filled. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +143,9 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to stop a service using an object reference rather than a service name. For example, if you use the `Get-CsWindowsService` cmdlet to return information about a service and if you store the returned object in a variable named $x, you can then stop the service using this command: @@ -153,8 +156,7 @@ Stop-CsWindowsService -InputObject $x.Name ```yaml Type: NTService Parameter Sets: InputObject -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,15 +165,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -NoWait -When present, causes the command to run and then immediately return control to the Windows PowerShell prompt. -If not present, control will not be returned until the command has completed and a status report has been written to the screen. +### -LeaveClsAgentRunning + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, stops all the Skype for Business Server services except for the centralized logging agent service. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,14 +183,16 @@ 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. +### -LeaveWebServerRunning + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, shuts down all services except the Web Server service on the specified computer. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,31 +201,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Path to an HTML file where error information can be written. -If this parameter is included, any errors that occur during the running of this cmdlet will be logged to the specified file (for example, C:\Logs\Service_report.html). +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the Skype for Business Server service you want to stop. +Note that you must use the service name (for example, RTCCAA) and not the service display name. +You can only pass a single service name to the Name parameter, and you cannot use wildcards in the service name. +You can use the `Get-CsWindowsService` cmdlet to retrieve service names. + +Keep in mind that the `Stop-CsWindowsService` cmdlet can only stop Skype for Business Server services; you cannot use this cmdlet to stop other Windows services. +For those services, you might be able to use the Windows PowerShell `Stop-Service` cmdlet. + ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: Name +Aliases: Required: False -Position: Named +Position: 2 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. +### -NoWait + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, causes the command to run and then immediately return control to the Windows PowerShell prompt. +If not present, control will not be returned until the command has completed and a status report has been written to the screen. ```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 +Aliases: Required: False Position: Named @@ -229,14 +245,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to an HTML file where error information can be written. +If this parameter is included, any errors that occur during the running of this cmdlet will be logged to the specified file (for example, C:\Logs\Service_report.html). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,14 +264,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LeaveClsAgentRunning -When specified, stops all the Skype for Business Server services except for the centralized logging agent service. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -261,14 +282,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LeaveWebServerRunning -When present, shuts down all services except the Web Server service on the specified computer. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -282,14 +305,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Deployment.Core.NTService object. +### Microsoft.Rtc.Management.Deployment.Core.NTService + The `Stop-CsWindowsService` cmdlet accepts pipelined instances of the Windows service object. ## OUTPUTS -### -None. +### None Instead, the `Stop-CsWindowsService` cmdlet stops instances of the Microsoft.Rtc.Management.Deployment.Core.NTService object. ## NOTES diff --git a/skype/skype-ps/skype/Sync-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Sync-CsClsLogging.md similarity index 91% rename from skype/skype-ps/skype/Sync-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Sync-CsClsLogging.md index f1e1fb7909..2b7db886ac 100644 --- a/skype/skype-ps/skype/Sync-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Sync-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/sync-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Sync-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/sync-csclslogging +schema: 2.0.0 +title: Sync-CsClsLogging --- # Sync-CsClsLogging @@ -42,7 +43,7 @@ When this is done, all the logging data currently in memory will be written to d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Sync-CsClsLogging ``` @@ -50,7 +51,7 @@ Sync-CsClsLogging The command shown in Example 1 flushes the centralized logging caches for all the servers in the topology. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Sync-CsClsLogging -Pools "atl-cs-001.litwareinc.com" ``` @@ -61,13 +62,15 @@ In Example 2, the centralized logging caches are flushed on all the servers in t ## PARAMETERS ### -AsXml + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, information is returned using XML. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to flush the centralized logging service cache on a specified server or set of servers. To flush a single server cache, specify the fully qualified domain name of that server. For example: @@ -93,8 +99,7 @@ If you do not include the Computers parameter or the Pools parameter, the `Sync- ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to flush the centralized logging service cache on each server in a pool. To flush the server caches in a pool, specify the fully qualified domain name of that pool. For example: @@ -117,8 +125,7 @@ Multiple pools can be specified by separating the pool FQDNs using commas: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +139,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Sync-CsClsLogging` cmdlet does not accept pipelined input. ## OUTPUTS -### -String value. +### System.Stringvalue. The `Sync-CsClsLogging` cmdlet does not return objects. ## NOTES diff --git a/skype/skype-ps/skype/Sync-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Sync-CsUserData.md similarity index 84% rename from skype/skype-ps/skype/Sync-CsUserData.md rename to skype/skype-ps/SkypeForBusiness/Sync-CsUserData.md index 24515c4190..4bd8646a03 100644 --- a/skype/skype-ps/skype/Sync-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Sync-CsUserData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/sync-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Sync-CsUserData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/sync-csuserdata +schema: 2.0.0 +title: Sync-CsUserData --- # Sync-CsUserData @@ -32,7 +33,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Sync- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Sync-CsUserData -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -42,36 +43,40 @@ The command shown in Example 1 syncs the pool `atl-cs-001.litwareinc.com` with i ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the primary Skype for Business Server pool. -For example: +### -LocalStore -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Retrieves the user data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the user data from the local replica of the Central Management store rather than from the Central Management store itself. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the primary Skype for Business Server pool. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -79,14 +84,16 @@ Accept wildcard characters: False ``` ### -RoutingGroup + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to synchronize data only for the specified routing groups. Routing groups are used to indicate the Front End server that users register with. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Synchronizes data with the preassigned backup pool. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,14 +125,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Sync-CsUserData` cmdlet does not accept pipelined output. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Test-CsASConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsASConference.md similarity index 82% rename from skype/skype-ps/skype/Test-CsASConference.md rename to skype/skype-ps/SkypeForBusiness/Test-CsASConference.md index 099b932352..ae31c0ed34 100644 --- a/skype/skype-ps/skype/Test-CsASConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsASConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csasconference applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsASConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csasconference +schema: 2.0.0 +title: Test-CsASConference --- # Test-CsASConference @@ -46,7 +47,7 @@ Skype for Business Server: The functions carried out by the `Test-CsASConference ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsASConference -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -56,7 +57,7 @@ This command assumes that you have configured a pair of test users for the speci If no such test users exist, the command will fail. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsASConference -TargetFqdn "atl-cs-001.litwareinc.com" -TestJoinLauncher ``` @@ -65,7 +66,7 @@ Example 2 tests the ability of the Join Launcher service to participate in an Ap Note that this command tests only the service itself; you do not need any mobile devices in order to run the command. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -85,84 +86,10 @@ To carry out this task, the `Test-CsASConference` cmdlet is called, along with t ## PARAMETERS -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: - -`$y = Get-Credential "litwareinc\pilar"` - -You need to supply the user password when running this command. - -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, 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 -``` - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -175,7 +102,6 @@ Allowed values are: Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,13 +111,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +129,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -222,7 +153,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -232,6 +162,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -243,7 +176,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -252,18 +184,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: `-ReceiverSipAddress "sip:pilar@litwareinc.com"`. -The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. +### -ReceiverCredential -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. + +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rc Required: True Position: Named @@ -272,13 +210,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReceiverSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. +For example: `-ReceiverSipAddress "sip:pilar@litwareinc.com"`. +The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -286,6 +233,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -293,7 +243,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -302,7 +251,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SenderCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. + +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SenderSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the second of the two user accounts to be tested. For example: `-SenderSipAddress "sip:kenmyer@litwareinc.com"`. The SenderSipAddress parameter must reference the same user account as SenderCredential. @@ -311,9 +289,8 @@ The SIP address is not required if you are running the test under the health mon ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -322,28 +299,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. + ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -TestJoinLauncher + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, tests the ability of the Join Launcher to participate in a conference. The Join Launcher is used to help users of mobile devices (and as a result, users of the Mobility Service) take part in conferences. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -357,13 +342,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsASConference` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsASConference` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsAVConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsAVConference.md similarity index 82% rename from skype/skype-ps/skype/Test-CsAVConference.md rename to skype/skype-ps/SkypeForBusiness/Test-CsAVConference.md index 10358b7db6..bf2ab0addf 100644 --- a/skype/skype-ps/skype/Test-CsAVConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAVConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csavconference applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsAVConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csavconference +schema: 2.0.0 +title: Test-CsAVConference --- # Test-CsAVConference @@ -59,7 +60,7 @@ Instead, the cmdlet verifies that the two users can make the connections necessa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsAVConference -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -74,7 +75,7 @@ If you have not defined test users for a pool then you must include the SenderSi The `Test-CsAVConference` cmdlet will then conduct its checks using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -94,36 +95,107 @@ To carry out this task, the `Test-CsAVConference` cmdlet is called, along with t ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID + +```yaml +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + + ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: ovv Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ReceiverCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the first of the two user accounts to be tested. The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: @@ -138,7 +210,6 @@ The receiver credential is not required if you are running the test under the he Type: PSCredential Parameter Sets: ClientPlatform Aliases: rc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -148,6 +219,9 @@ Accept wildcard characters: False ``` ### -ReceiverSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the first of the two user accounts to be tested. For example: `-ReceiverSipAddress "sip:pilar@litwareinc.com"`. The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. @@ -156,9 +230,8 @@ The SIP address is not required if you are running the test under the health mon ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -167,20 +240,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -RegistrarPort SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -188,7 +251,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -198,6 +260,9 @@ Accept wildcard characters: False ``` ### -SenderCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the second of the two user accounts to be tested. The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: @@ -212,7 +277,6 @@ The sender credential is not required if you are running the test under the heal Type: PSCredential Parameter Sets: ClientPlatform Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -222,18 +286,19 @@ Accept wildcard characters: False ``` ### -SenderSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the second of the two user accounts to be tested. For example: `-SenderSipAddress "sip:kenmyer@litwareinc.com"`. The SenderSipAddress parameter must reference the same user account as SenderCredential. The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. - ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -242,133 +307,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -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 occur when running the command. - -```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 -``` - -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -TargetFqdn -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -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 -``` - -### -Authentication -Type of authentication used in the test. -Allowed values are: - -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID - -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` - -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +### -TestJoinLauncher -```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` - -### -TestJoinLauncher When present, tests the ability of the Join Launcher to participate in an AV conference. The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -382,12 +349,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsAVConference` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md b/skype/skype-ps/SkypeForBusiness/Test-CsAVEdgeConnectivity.md similarity index 81% rename from skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md rename to skype/skype-ps/SkypeForBusiness/Test-CsAVEdgeConnectivity.md index 4a02865927..8a6716e1fb 100644 --- a/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAVEdgeConnectivity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csavedgeconnectivity applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsAVEdgeConnectivity -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csavedgeconnectivity +schema: 2.0.0 +title: Test-CsAVEdgeConnectivity --- # Test-CsAVEdgeConnectivity @@ -43,7 +44,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsAVEdgeConnectivity -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -51,7 +52,7 @@ Test-CsAVEdgeConnectivity -TargetFqdn "atl-cs-001.litwareinc.com" The command shown in Example 1 verifies that a preconfigured test user can connect to the A/V Edge server configured for the pool atl-cs-001.litwareinc.com Note that this command will fail if you have not defined at least one health monitoring test user for atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred = Get-Credential "litwareinc\kenmyer" @@ -65,72 +66,82 @@ After the credentials object has been obtained, the second command uses the `Tes ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -AVEdgeAddress + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +IP address of the Edge server being tested. +Specifying the IP address enables you to test the internal side of the Edge server; in turn, this allows you to verify the connection between the test client and the internal Edge server. +Note that the internal side often has multiple IP addresses. + ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credentials object for the account to be tested. -The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named +### -AVEdgeTCPPort -`$x: $x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +Transmission Control Protocol (TCP) of the Edge server being tested. + +The default value is 443. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UInt16 +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -AVEdgeUDPPort -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +User Datagram Protocol (UDP) port of the Edge server being tested. + +The default value is 3478. ```yaml -Type: AuthenticationMechanism +Type: UInt16 Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +169,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -175,7 +191,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -196,7 +214,6 @@ Do not use prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -213,7 +233,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -222,83 +241,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested; for example: `-UserSipAddress "sip:kenmyer@litwareinc.com"`. -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +### -TargetFqdn -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AVEdgeAddress -IP address of the Edge server being tested. -Specifying the IP address enables you to test the internal side of the Edge server; in turn, this allows you to verify the connection between the test client and the internal Edge server. -Note that the internal side often has multiple IP addresses. +### -UserCredential -```yaml -Type: String -Parameter Sets: (All) -Aliases: -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 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +User credentials object for the account to be tested. +The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named -### -AVEdgeTCPPort -Transmission Control Protocol (TCP) of the Edge server being tested. +`$x: $x = Get-Credential "litwareinc\kenmyer"` -The default value is 443. +You need to supply the user password when running this command. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. ```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AVEdgeUDPPort -User Datagram Protocol (UDP) port of the Edge server being tested. +### -UserSipAddress -The default value is 3478. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for user account to be tested; for example: `-UserSipAddress "sip:kenmyer@litwareinc.com"`. +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. ```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ua Required: False Position: Named @@ -312,13 +309,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsAVEdgeConnectivity` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsAVEdgeConnectivity` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsAddressBookService.md b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookService.md similarity index 82% rename from skype/skype-ps/skype/Test-CsAddressBookService.md rename to skype/skype-ps/SkypeForBusiness/Test-CsAddressBookService.md index cd35b1f681..2d65633ec2 100644 --- a/skype/skype-ps/skype/Test-CsAddressBookService.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookService.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csaddressbookservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsAddressBookService -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csaddressbookservice +schema: 2.0.0 +title: Test-CsAddressBookService --- # Test-CsAddressBookService @@ -63,7 +64,7 @@ You can test the Address Book Download Web service in two different ways: by tes ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsAddressBookService -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -72,7 +73,7 @@ Example 1 tests the Address Book Download Web service for the pool `atl-cs-001.l This command tests the Address Book Download Web service by using test users preconfigured for the pool `atl-cs-001.litwareinc.com`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -88,7 +89,7 @@ To run this command under Ken Myer's user credentials, the UserCredential parame In addition, Ken's SIP address must be supplied using the UserSipAddress parameter. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsAddressBookService -TargetUri https://atl-cs-001.litwareinc.com/abs/handler -UserSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -99,50 +100,89 @@ To do this, the `Test-CsAddressBookService` cmdlet is called along with two para ## PARAMETERS -### -UserCredential -User credential object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -Authentication -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address of the user to be used in the test. -If this parameter is not specified then `Test-CsAddressBookService` will conduct its checks by using the account of the logged-in user. +### -External + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to verify that external users can use the Address Book Download Web service. ```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: -Required: True +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 ``` +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` + ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -151,14 +191,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -External -Enables you to verify that external users can use the Address Book Download Web service. +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + ```yaml -Type: SwitchParameter -Parameter Sets: ClientPlatform, ServerPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: ovv Required: False Position: Named @@ -168,6 +216,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -175,7 +226,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ClientPlatform, ServerPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,6 +235,9 @@ Accept wildcard characters: False ``` ### -TargetFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the Registrar pool where the Address Book Download Web service is to be tested. For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. @@ -192,9 +245,8 @@ You cannot use both the TargetUri parameter and the TargetFqdn parameter in the ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -203,20 +255,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -TargetUri -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -TargetUri Uniform Resource Identifier (URI) of the Address Book Web Query service. For example: `-TargetUri "https://atl-cs-001.litwareinc.com/abs/handler"`. @@ -226,7 +268,6 @@ You cannot use both the TargetUri parameter and the TargetFqdn parameter in the Type: String Parameter Sets: TargetUri Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -235,54 +276,46 @@ 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. +### -UserCredential -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +User credential object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +You need to supply the user password when running this command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -UserSipAddress -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the user to be used in the test. +If this parameter is not specified then `Test-CsAddressBookService` will conduct its checks by using the account of the logged-in user. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ClientPlatform, TargetUri, ServerPlatform +Aliases: ua -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -290,6 +323,9 @@ Accept wildcard characters: False ``` ### -WebCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object containing user credentials for accessing the Location Information service. This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. @@ -299,59 +335,7 @@ This parameter is required if the TargetUri and UserSipAddress parameters are sp ```yaml Type: PSCredential Parameter Sets: TargetUri -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 -``` - -### -Authentication -Type of authentication used in the test. -Allowed values are: - -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID - -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -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 -``` - -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` - -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -365,13 +349,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsAddressBookService` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsAddressBookService` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookWebQuery.md similarity index 83% rename from skype/skype-ps/skype/Test-CsAddressBookWebQuery.md rename to skype/skype-ps/SkypeForBusiness/Test-CsAddressBookWebQuery.md index 6347a249c5..fffd3eb2c5 100644 --- a/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookWebQuery.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csaddressbookwebquery applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsAddressBookWebQuery -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csaddressbookwebquery +schema: 2.0.0 +title: Test-CsAddressBookWebQuery --- # Test-CsAddressBookWebQuery @@ -65,7 +66,7 @@ The test will be marked a success only if all of those steps can be completed. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -TargetSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -78,7 +79,7 @@ If test users have not been defined, then the command will fail. If you have not defined test users for a pool then you must include the UserSipAddress parameter and the credentials of the user under which the command should be run. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -94,7 +95,7 @@ To run this command under Ken Myer's user credentials, the UserCredential parame The command also uses the TargetSipAddress to specify that the cmdlet should search the Address Book for the contact with the SIP Address sip:kenmyer@litwareinc.com. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Test-CsAddressBookWebQuery -TargetUri https://atl-cs-001.litwareinc.com/groupexpansion -UserSipAddress "sip:packerman@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -105,47 +106,26 @@ To do this, the `Test-CsAddressBookWebQuery` cmdlet is called along with three p ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the Registrar pool where the Address Book Web Query service is to be tested. -For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. +### -Authentication -Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type of authentication used in the test. +Allowed values are: -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +TrustedServer -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Negotiate -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +ClientCertificate + +LiveID -### -TargetSipAddress -SIP address of the contact expected to be returned by the Address Book Web Query service. -For example: `-TargetSipAddress "sip:kenmyer@litwareinc.com"`. ```yaml -Type: String +Type: AuthenticationMechanism Parameter Sets: (All) -Aliases: sip -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Ath Required: False Position: Named @@ -154,57 +134,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetUri -Uniform Resource Identifier (URI) of the Address Book Web Query service. -For example: `-TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion"`. +### -External -Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to verify that external users can use the Address Book Web Query service. ```yaml -Type: String -Parameter Sets: TargetUri -Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credential object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named +### -Force -`$x: $x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address of the user to be used in the test. -If this parameter is not specified then the `Test-CsAddressBookWebQuery` cmdlet will conduct its checks by using health monitoring configuration settings for the pool being tested. +### -OutLoggerVariable +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -213,27 +201,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutVerboseVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -External -Enables you to verify that external users can use the Address Book Web Query service. ```yaml -Type: SwitchParameter -Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: ovv Required: False Position: Named @@ -243,6 +226,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -250,7 +236,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -259,14 +244,16 @@ 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. +### -SkypeSearchQuery + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: skype Required: False Position: Named @@ -275,36 +262,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -TargetFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Registrar pool where the Address Book Web Query service is to be tested. +For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. + +Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -TargetSipAddress -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +SIP address of the contact expected to be returned by the Address Book Web Query service. +For example: `-TargetSipAddress "sip:kenmyer@litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: sip Required: False Position: Named @@ -313,73 +302,63 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebCredential -An object containing user credentials for accessing the Location Information service. -This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. +### -TargetUri -This parameter is required if the TargetUri and UserSipAddress parameters are specified and the computer on which the command is run does not have a server certificate. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Uniform Resource Identifier (URI) of the Address Book Web Query service. +For example: `-TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion"`. + +Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. ```yaml -Type: PSCredential +Type: String Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: twsu -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -UserCredential -TrustedServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Negotiate - -ClientCertificate +User credential object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named -LiveID +`$x: $x = Get-Credential "litwareinc\kenmyer"` +You need to supply the user password when running this command. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +### -UserSipAddress -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To save the information stored in the logger variable to an XML file, use a command similar to this: +SIP address of the user to be used in the test. +If this parameter is not specified then the `Test-CsAddressBookWebQuery` cmdlet will conduct its checks by using health monitoring configuration settings for the pool being tested. -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri +Aliases: ua Required: False Position: Named @@ -388,14 +367,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkypeSearchQuery -PARAMVALUE: String +### -WebCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An object containing user credentials for accessing the Location Information service. +This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. + +This parameter is required if the TargetUri and UserSipAddress parameters are specified and the computer on which the command is run does not have a server certificate. + ```yaml -Type: String -Parameter Sets: (All) -Aliases: skype -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: TargetUri +Aliases: Required: False Position: Named @@ -409,13 +394,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsAddressBookWebQuery` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsAddressBookWebQuery` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md b/skype/skype-ps/SkypeForBusiness/Test-CsAudioConferencingProvider.md similarity index 85% rename from skype/skype-ps/skype/Test-CsAudioConferencingProvider.md rename to skype/skype-ps/SkypeForBusiness/Test-CsAudioConferencingProvider.md index 5c7f75a011..85521a40af 100644 --- a/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAudioConferencingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csaudioconferencingprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsAudioConferencingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csaudioconferencingprovider +schema: 2.0.0 +title: Test-CsAudioConferencingProvider --- # Test-CsAudioConferencingProvider @@ -56,7 +57,7 @@ Note that the test will fail if the user employed by the `Test-CsAudioConferenci ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsAudioConferencingProvider -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -67,7 +68,7 @@ If no test users have been defined for atl-cs-001.litwareinc.com, then the comma If you have not defined test users for a pool, then you must include the UserSipAddress parameter and the credentials of the user account that the command should employ when verifying the connection with an audio conferencing provider. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -84,60 +85,10 @@ To carry out this task, the `Test-CsAudioConferencingProvider` cmdlet is called, ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, 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 -``` - -### -UserCredential -User credential object for the account to be tested. -The value passed to `UserCredential` should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -150,7 +101,6 @@ Allowed values are: Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -160,6 +110,9 @@ Accept wildcard characters: False ``` ### -DialoutUserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the dialout user account to be tested. The value passed to DialoutUserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $x: @@ -171,8 +124,7 @@ You need to supply the user password when running this command. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +134,9 @@ Accept wildcard characters: False ``` ### -DialoutUserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the dialout user account to be tested. For example: `-DialoutUserSipAddress "sip:pilar@litwareinc.com"`. The DialoutUserSipAddress parameter must reference the same user account as DialoutUserCredential. @@ -190,8 +145,7 @@ The DialoutUserSipAddress parameter must reference the same user account as Dial ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,13 +155,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -217,6 +173,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -238,7 +197,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -248,6 +206,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -259,7 +220,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -269,6 +229,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -276,7 +239,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -285,15 +247,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. + +```yaml +Type: String +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TestJoinLauncher + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, tests the ability of the Join Launcher to participate in a conference. The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -302,33 +284,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for the user account to be tested. -For example: `-UserSipAddress "sip:kenmyer@litwareinc.com"`. -The UserSipAddress parameter must reference the same user account as UserCredential. +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the account to be tested. +The value passed to `UserCredential` should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the user account to be tested. +For example: `-UserSipAddress "sip:kenmyer@litwareinc.com"`. +The UserSipAddress parameter must reference the same user account as UserCredential. + +This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. + ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -340,13 +337,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsAudioConferencingProvider` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsAudioConferencingProvider` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsCertificateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsCertificateConfiguration.md similarity index 82% rename from skype/skype-ps/skype/Test-CsCertificateConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsCertificateConfiguration.md index a47d84c519..66e0dec4da 100644 --- a/skype/skype-ps/skype/Test-CsCertificateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsCertificateConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cscertificateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsCertificateConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cscertificateconfiguration +schema: 2.0.0 +title: Test-CsCertificateConfiguration --- # Test-CsCertificateConfiguration @@ -34,7 +35,7 @@ It is recommended that administrators use the `Get-CsCertificate` cmdlet to retr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsCertificateConfiguration ``` @@ -42,7 +43,7 @@ Test-CsCertificateConfiguration The command shown in Example 1 returns information about the certificates that are currently being used (on the local computer) by Skype for Business Server. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsCertificateConfiguration -Report "C:\Logs\Certificates.xml" ``` @@ -54,6 +55,9 @@ In this case, however, the Report parameter is used to specify a file path (C:\L ## PARAMETERS ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\Certificates.html"`. If this file already exists, it will be overwritten when you run the cmdlet. @@ -61,24 +65,7 @@ If this file already exists, it will be overwritten when you run the cmdlet. ```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 -``` - -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -92,14 +79,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsCertificateConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### -The `Test-CsCertificateConfiguration` cmdlet returns instances of the Microsoft.Rtc.Management.Deployment,CertificateExists object. +### Microsoft.Rtc.Management.Deployment.CertificateExists +The `Test-CsCertificateConfiguration` cmdlet returns instances of the Microsoft.Rtc.Management.Deployment.CertificateExists object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsClientAuth.md b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuth.md similarity index 90% rename from skype/skype-ps/skype/Test-CsClientAuth.md rename to skype/skype-ps/SkypeForBusiness/Test-CsClientAuth.md index 6bd285963b..72f3758e34 100644 --- a/skype/skype-ps/skype/Test-CsClientAuth.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuth.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csclientauth applicable: Lync Server 2010 -title: Test-CsClientAuth -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csclientauth +schema: 2.0.0 +title: Test-CsClientAuth --- # Test-CsClientAuth @@ -39,7 +40,7 @@ Who can run this cmdlet: To return a list of all the role-based access control ( ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -54,39 +55,36 @@ The second command then calls `Test-CsClientAuth`, specifying the FQDN of the Re ## PARAMETERS -### -UserCredential -User credential object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -Force -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2010 -You need to supply the user password when running this command. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential +Type: SwitchParameter Parameter Sets: (All) -Aliases: uc -Applicable: Lync Server 2010 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address of the user to be used in the test. -For example: `-UserSipAddress sip:kenmyer@litwareinc.com`. +### -OutVerboseVariable + +> Applicable: Lync Server 2010 + +{{Fill OutVerboseVariable Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: ua -Applicable: Lync Server 2010 +Aliases: ovv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -94,6 +92,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -101,7 +102,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2010 Required: False Position: Named @@ -110,24 +110,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetUri -URL of the certificate provisioning service. -If this parameter is not included then the `Test-CsClientAuth` will use the certificate provisioning service configured for the Registrar pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: tu -Applicable: Lync Server 2010 +### -TargetFqdn -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010 -### -TargetFqdn Fully qualified domain name (FQDN) of the Registrar pool where client authentication is to be tested. For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. @@ -135,7 +121,6 @@ For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. Type: String Parameter Sets: (All) Aliases: t -Applicable: Lync Server 2010 Required: False Position: 2 @@ -144,14 +129,17 @@ 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. +### -TargetUri + +> Applicable: Lync Server 2010 + +URL of the certificate provisioning service. +If this parameter is not included then the `Test-CsClientAuth` will use the certificate provisioning service configured for the Registrar pool. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010 +Aliases: tu Required: False Position: Named @@ -160,32 +148,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -UserCredential + +> Applicable: Lync Server 2010 + +User credential object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. ```yaml -Type: SwitchParameter +Type: PSCredential Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -{{Fill OutVerboseVariable Description}} +### -UserSipAddress + +> Applicable: Lync Server 2010 + +SIP address of the user to be used in the test. +For example: `-UserSipAddress sip:kenmyer@litwareinc.com`. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010 +Aliases: ua -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -197,12 +196,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput `Test-CsClientAuth` returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsClientAuthentication.md b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuthentication.md similarity index 87% rename from skype/skype-ps/skype/Test-CsClientAuthentication.md rename to skype/skype-ps/SkypeForBusiness/Test-CsClientAuthentication.md index b8dd9c675a..a433d6758f 100644 --- a/skype/skype-ps/skype/Test-CsClientAuthentication.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuthentication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csclientauthentication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsClientAuthentication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csclientauthentication +schema: 2.0.0 +title: Test-CsClientAuthentication --- # Test-CsClientAuthentication @@ -38,7 +39,7 @@ If a certificate cannot be found or downloaded, or if the cmdlet is unable to lo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -54,53 +55,16 @@ The second command then calls the `Test-CsClientAuthentication` cmdlet, specifyi ## PARAMETERS -### -UserCredential -User credential object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserSipAddress -SIP address of the user to be used in the test. -For example: `-UserSipAddress sip:kenmyer@litwareinc.com`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,13 +74,15 @@ Accept wildcard characters: False ``` ### -LiveIdAuthentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Verifies the ability of the test user to log on using their OrgId (Business LiveId) credentials. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +92,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -145,7 +114,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -155,6 +123,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -166,7 +137,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -176,6 +146,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -183,7 +156,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -193,6 +165,9 @@ Accept wildcard characters: False ``` ### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the Registrar pool where client authentication is to be tested. For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. @@ -200,7 +175,6 @@ For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. Type: String Parameter Sets: (All) Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -210,6 +184,9 @@ Accept wildcard characters: False ``` ### -TargetUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL of the certificate provisioning service. If this parameter is not included then the `Test-CsClientAuthentication` cmdlet will use the certificate provisioning service configured for the Registrar pool. @@ -218,7 +195,6 @@ If this parameter is not included then the `Test-CsClientAuthentication` cmdlet Type: String Parameter Sets: (All) Aliases: tu -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -227,17 +203,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: uc + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the user to be used in the test. +For example: `-UserSipAddress sip:kenmyer@litwareinc.com`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ua + +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. +### None ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsClientAuthentication` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Test-CsComputer.md similarity index 86% rename from skype/skype-ps/skype/Test-CsComputer.md rename to skype/skype-ps/SkypeForBusiness/Test-CsComputer.md index 24f055387a..a0f22f4e93 100644 --- a/skype/skype-ps/skype/Test-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cscomputer +schema: 2.0.0 +title: Test-CsComputer --- # Test-CsComputer @@ -35,7 +36,7 @@ For example, the `Test-CsComputer` cmdlet will verify that the Active Directory ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Test-CsComputer -Verbose ``` @@ -44,7 +45,7 @@ The command shown in Example 1 verifies the service activation status for the lo The Verbose parameter is included in the command to ensure that the success (or failure) of the operation is fully reported on the screen. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Test-CsComputer -Verbose -Report C:\Logs\Computer.html ``` @@ -57,6 +58,9 @@ This log is generated by including the Report parameter followed by the full pat ## PARAMETERS ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\Computer.html"`. If this file already exists, it will be overwritten when you run the cmdlet. @@ -64,24 +68,7 @@ If this file already exists, it will be overwritten when you run the cmdlet. ```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 -``` - -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -95,13 +82,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsComputer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsComputer` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsDataConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsDataConference.md similarity index 83% rename from skype/skype-ps/skype/Test-CsDataConference.md rename to skype/skype-ps/SkypeForBusiness/Test-CsDataConference.md index 261a1b7fce..a7ee094129 100644 --- a/skype/skype-ps/skype/Test-CsDataConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDataConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csdataconference applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsDataConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csdataconference +schema: 2.0.0 +title: Test-CsDataConference --- # Test-CsDataConference @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsDataConference -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -58,7 +59,7 @@ This command assumes that you have configured a pair of test users for the speci If no such test users exist, the command will fail. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential1 = Get-Credential "litwareinc\pilar" @@ -78,113 +79,67 @@ To carry out this task, the `Test-CsDataConference` cmdlet is called, along with ## PARAMETERS -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: +### -Authentication -`$y = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +Type of authentication used when running the test. +Allowed values are: -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. +### -Force -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name (FQDN) of the Persistent Chat pool to be tested. +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -IPVersion -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication -Type of authentication used when running the test. +IP addressing type used to connect to the test conference. Allowed values are: -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID +IPv4 -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +IPv6 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Both -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +Auto ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ipv Required: False Position: Named @@ -194,6 +149,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -215,7 +173,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -225,6 +182,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -236,7 +196,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -245,21 +204,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -ReceiverCredential -`-ReceiverSipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. + +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rc Required: True Position: Named @@ -268,13 +230,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReceiverSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. +For example: + +`-ReceiverSipAddress "sip:pilar@litwareinc.com"` + +The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -282,6 +256,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -289,7 +266,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -298,21 +274,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. -For example: +### -SenderCredential -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The SenderSipAddress parameter must reference the same user account as SenderCredential. +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: sc Required: True Position: Named @@ -321,53 +300,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SenderSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the second of the two user accounts to be tested. +For example: + +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` + +The SenderSipAddress parameter must reference the same user account as SenderCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TestJoinLauncher -When present, tests the ability of the Join Launcher to participate in a conference. -The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences. +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Persistent Chat pool to be tested. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IPVersion -IP addressing type used to connect to the test conference. -Allowed values are: - -IPv4 - -IPv6 +### -TestJoinLauncher -Both +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Auto +When present, tests the ability of the Join Launcher to participate in a conference. +The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: ipv -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -381,13 +367,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsDataConference` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsDataConference` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsDatabase.md b/skype/skype-ps/SkypeForBusiness/Test-CsDatabase.md similarity index 81% rename from skype/skype-ps/skype/Test-CsDatabase.md rename to skype/skype-ps/SkypeForBusiness/Test-CsDatabase.md index 8d7c71703f..d694744ff8 100644 --- a/skype/skype-ps/skype/Test-CsDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csdatabase applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csdatabase +schema: 2.0.0 +title: Test-CsDatabase --- # Test-CsDatabase @@ -52,7 +53,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsDatabase -CentralManagementDatabase ``` @@ -60,7 +61,7 @@ Test-CsDatabase -CentralManagementDatabase The command shown in Example 1 verifies the configuration of the Central Management database. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsDatabase -ConfiguredDatabases -SqlServerFqdn "atl-sql-001.litwareinc.com" ``` @@ -68,7 +69,7 @@ Test-CsDatabase -ConfiguredDatabases -SqlServerFqdn "atl-sql-001.litwareinc.com" Example 2 verifies all the Skype for Business Server databases installed on the computer atl-sql-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsDatabase -DatabaseType "Archiving" -SqlServerFqdn "atl-sql-001.litwareinc.com" -SqlInstanceName "archinst" ``` @@ -77,7 +78,7 @@ In Example 3, verification is performed only for the Archiving database installe Note that the SqlInstanceName parameter is included to specify the SQL Server instance (Archinst) where the Archiving database is located. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Test-CsDatabase -LocalService ``` @@ -88,14 +89,16 @@ The command shown in Example 4 verifies the databases installed on the local com ## PARAMETERS ### -CentralManagementDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Tests the configuration of the Central Management database. This parameter cannot be used in conjunction with the ConfiguredDatabases parameter or the DatabaseType parameter. ```yaml Type: SwitchParameter Parameter Sets: ByCMS -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -ConfiguredDatabases + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Tests the configuration of all the Skype for Business Server databases installed on the specified computer. You must include the SqlServerFqdn parameter when using the ConfiguredDatabases parameter. In addition, this parameter cannot be used in the same command as the CentralManagementDatabase or the DatabaseType parameters. @@ -113,8 +119,7 @@ In addition, this parameter cannot be used in the same command as the CentralMan ```yaml Type: SwitchParameter Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -DatabaseType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of database to be validated. Allowed values are: @@ -159,8 +167,7 @@ User ```yaml Type: DatabaseNameType Parameter Sets: ByDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -170,6 +177,9 @@ Accept wildcard characters: False ``` ### -LocalService + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Validates all the databases used by any of the Skype for Business Server services that are installed on the local computer. This includes not only locally-installed databases but also databases installed on remote computers, provided those databases are used by one or more local services. @@ -177,8 +187,7 @@ This includes not only locally-installed databases but also databases installed ```yaml Type: SwitchParameter Parameter Sets: ByLocal -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -187,14 +196,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name of the computer whether the databases to be validated are installed. +### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\TestDatabases.html"` ```yaml -Type: Fqdn -Parameter Sets: ByCMS -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -203,27 +217,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Fqdn -Parameter Sets: ByConfigured, ByDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -SqlInstanceName -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +SQL Server instance where the databases to be validated are installed. +For example: + +`-SqlInstanceName "rtc"` ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ByCMS, ByDatabase +Aliases: Required: False Position: Named @@ -232,17 +238,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -SqlServerFqdn -`-Report "C:\Logs\TestDatabases.html"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the computer whether the databases to be validated are installed. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: ByCMS, ByConfigured, ByDatabase +Aliases: Required: False Position: Named @@ -251,17 +256,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -SQL Server instance where the databases to be validated are installed. -For example: +### -Confirm -`-SqlInstanceName "rtc"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: ByCMS, ByDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -271,13 +275,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -291,13 +297,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsDatabase` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsDatabase` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsDialInConferencing.md b/skype/skype-ps/SkypeForBusiness/Test-CsDialInConferencing.md similarity index 84% rename from skype/skype-ps/skype/Test-CsDialInConferencing.md rename to skype/skype-ps/SkypeForBusiness/Test-CsDialInConferencing.md index b081788241..bf6ba98004 100644 --- a/skype/skype-ps/skype/Test-CsDialInConferencing.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDialInConferencing.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csdialinconferencing applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsDialInConferencing -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csdialinconferencing +schema: 2.0.0 +title: Test-CsDialInConferencing --- # Test-CsDialInConferencing @@ -58,7 +59,7 @@ The cmdlet does not actually make any phone calls or create any dial-in conferen ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsDialInConferencing -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -71,7 +72,7 @@ If test users have not been defined, then the command will fail because it will If you have not defined test users for a pool, then you must include the UserCredential parameter and the credentials of the user that the command should employ when trying to log on. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -88,69 +89,44 @@ To carry out this task, the `Test-CsDialInConferencing` cmdlet is called, along ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used in the test. +Allowed values are: -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +TrustedServer -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Negotiate -### -UserCredential -User credential object for the user account to be tested. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +ClientCertificate -`$x = Get-Credential "litwareinc\kenmyer"` +LiveID -You need to supply the user password when running this command. -This parameter is not required if you are conducting the test using the health monitoring configuration settings. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: cc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested. -For example: -UserSipAddress "sip:kenmyer@litwareinc.com". -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test using the health monitoring configuration settings. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ca -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -159,28 +135,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ca -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutLoggerVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv Required: False Position: Named @@ -189,14 +166,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: ovv Required: False Position: Named @@ -205,14 +190,17 @@ 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. +### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp Required: False Position: Named @@ -221,46 +209,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -TargetFqdn -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: - -TrustedServer +### -TargetPstnPhoneNumber -Negotiate +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -ClientCertificate +Phone number for a PSTN telephone that will be used to verify that PSTN users can join the dial-in conference. +For example: -LiveID +`-TargetPstnPhoneNumber "+12065551219"` +Note that TargetPstnPhoneNumber should only be included when you are using the VerifyConferenceJoinType parameter. ```yaml -Type: AuthenticationMechanism +Type: String Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rpn Required: False Position: Named @@ -269,48 +250,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` +### -UserCredential -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +User credential object for the user account to be tested. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -To save the information stored in the logger variable to an XML file, use a command similar to this: +`$x = Get-Credential "litwareinc\kenmyer"` -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +You need to supply the user password when running this command. +This parameter is not required if you are conducting the test using the health monitoring configuration settings. ```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: cc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetPstnPhoneNumber -Phone number for a PSTN telephone that will be used to verify that PSTN users can join the dial-in conference. -For example: +### -UserSipAddress -`-TargetPstnPhoneNumber "+12065551219"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that TargetPstnPhoneNumber should only be included when you are using the VerifyConferenceJoinType parameter. +SIP address for user account to be tested. +For example: -UserSipAddress "sip:kenmyer@litwareinc.com". +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test using the health monitoring configuration settings. ```yaml Type: String -Parameter Sets: (All) -Aliases: rpn -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ca Required: False Position: Named @@ -320,6 +297,9 @@ Accept wildcard characters: False ``` ### -VerifyConferenceJoin + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, verifies that the dial-in conference can joined by using a PSTN telephone. When performing this test you can optionally include the TargetPstnPhoneNumber. If you do that, TargetPstnPhoneNumber must specify the PSTN phone to be used for joining the conference. @@ -329,7 +309,6 @@ If TargetPstnPhoneNumber is not included then the `Test-CsDialInConferencing` cm Type: Boolean Parameter Sets: (All) Aliases: vcj -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -343,13 +322,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsDialInConferencing` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsDialInConferencing` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Test-CsDialPlan.md similarity index 91% rename from skype/skype-ps/skype/Test-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/Test-CsDialPlan.md index 77e180d416..e13527ff05 100644 --- a/skype/skype-ps/skype/Test-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsDialPlan -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csdialplan +schema: 2.0.0 +title: Test-CsDialPlan --- # Test-CsDialPlan @@ -33,7 +34,7 @@ You can use this cmdlet for troubleshooting issues with number translations or f ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDialPlan -Identity site:Redmond | Test-CsDialPlan -DialedNumber 14255559999 | Format-List ``` @@ -51,7 +52,7 @@ In order to see all the properties and values of the returned voice normalizatio This will list the phone number and normalization rule on separate lines, and the normalization rule properties and values will wrap to fit on the screen. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsDialPlan -Identity site:Redmond @@ -63,7 +64,7 @@ Example 2 is identical to Example 1 except that instead of piping the results of As in Example 1, we conclude this command by piping the output to the `Format-List` cmdlet so we can see more information about the voice normalization rule than appears by default. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDialPlan | Test-CsDialPlan -DialedNumber 2065559999 | Format-Table -Wrap ``` @@ -83,6 +84,9 @@ This shows each entry in table format (one column for the translated number and ## PARAMETERS ### -DialedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number against which you want to test the dial plan specified in the Dialplan parameter. Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber @@ -90,8 +94,7 @@ 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 +Aliases: Required: True Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Dialplan + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object containing a reference to the dial plan against which you want to test the number specified in the DialedNumber parameter. Full Data Type: Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile @@ -108,8 +114,7 @@ Full Data Type: Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationPro ```yaml Type: LocationProfile Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -123,13 +128,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile + Accepts pipelined input of dial plan objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.LocationProfileTestResult Returns an object of type Microsoft.Rtc.Management.Voice.LocationProfileTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsExStorageConnectivity.md b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageConnectivity.md similarity index 86% rename from skype/skype-ps/skype/Test-CsExStorageConnectivity.md rename to skype/skype-ps/SkypeForBusiness/Test-CsExStorageConnectivity.md index c2e02985e3..ad25d505e4 100644 --- a/skype/skype-ps/skype/Test-CsExStorageConnectivity.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageConnectivity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csexstorageconnectivity applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsExStorageConnectivity -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csexstorageconnectivity +schema: 2.0.0 +title: Test-CsExStorageConnectivity --- # Test-CsExStorageConnectivity @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsExStorageConnectivity -SipUri "sip:kenmyer@litwareinc.com" -Binding "NetNamedPipe" ``` @@ -49,7 +50,7 @@ The command shown in Example 1 tests to see if the Skype for Business Server Sto In this example, NetNamedPipe is used as the WCF binding. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsExStorageConnectivity -SipUri "sip:kenmyer@litwareinc.com" -Binding "NetNamedPipe" -Folder Dumpster ``` @@ -60,24 +61,10 @@ Example 2 verifies that the Skype for Business Server Storage Service can connec ## PARAMETERS -### -SipUri -SIP address of the Exchange mailbox where the test item should be created. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: s -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Binding -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Binding Windows Communication Foundation (WCF) binding. A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. valid values are: @@ -91,7 +78,6 @@ NetTCP Type: String Parameter Sets: (All) Aliases: b -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -101,13 +87,15 @@ Accept wildcard characters: False ``` ### -DeleteItem + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, the test item will be deleted from the Exchange mailbox at the end of the text. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +105,9 @@ Accept wildcard characters: False ``` ### -Folder + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the Exchange archiving folder that the cmdlet should connect to. Allowed values are: @@ -130,8 +121,7 @@ Dumpster ```yaml Type: ExchFolder Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +131,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +149,9 @@ Accept wildcard characters: False ``` ### -HostNameStorageService + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the server where the Skype for Business Server Storage Service is running. This parameter is required if the Binding is set to NetTCP. @@ -165,7 +160,6 @@ This parameter is required if the Binding is set to NetTCP. Type: String Parameter Sets: (All) Aliases: h -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -174,14 +168,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SipUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the Exchange mailbox where the test item should be created. + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: s + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UseCache + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When presents, instructs the cmdlet to used cached auto discovery results when attempting to connect to Exchange. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,13 +210,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsExStorageConnectivity` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ResourceData The `Test-CsExStorageConnectivity` cmdlet returns instances of the Microsoft.Rtc.Management.ResourceData object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsExStorageNotification.md b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageNotification.md similarity index 86% rename from skype/skype-ps/skype/Test-CsExStorageNotification.md rename to skype/skype-ps/SkypeForBusiness/Test-CsExStorageNotification.md index 0a1a1928e8..0c4cccbf19 100644 --- a/skype/skype-ps/skype/Test-CsExStorageNotification.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageNotification.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csexstoragenotification applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsExStorageNotification -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csexstoragenotification +schema: 2.0.0 +title: Test-CsExStorageNotification --- # Test-CsExStorageNotification @@ -34,7 +35,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsExStorageNotification -SipUri "sip:kenmyer@litwareinc.com" -Binding "NetNamedPipe" ``` @@ -45,23 +46,10 @@ In this example, NetNamedPipe is used as the WCF binding. ## PARAMETERS -### -SipUri -SIP address of the Exchange Server mailbox where the test item should be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: s -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Binding -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Binding Windows Communication Foundation (WCF) binding. A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. valid values are: @@ -73,7 +61,6 @@ valid values are: Type: String Parameter Sets: (All) Aliases: b -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -83,13 +70,15 @@ Accept wildcard characters: False ``` ### -DeleteItem + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, the test item will be deleted from the Exchange mailbox at the end of the text. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,13 +88,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +106,9 @@ Accept wildcard characters: False ``` ### -HostNameStorageService + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the server where the Skype for Business Server Storage Service is running. This parameter is required if the Binding is set to NetTCP. @@ -123,7 +117,6 @@ This parameter is required if the Binding is set to NetTCP. Type: String Parameter Sets: (All) Aliases: h -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -132,18 +125,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SipUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the Exchange Server mailbox where the test item should be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: s + +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. +### None The `Test-CsExStorageNotification` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ResourceData The `Test-CsExStorageNotification` cmdlet returns instances of the Microsoft.Rtc.Management.ResourceData object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsExUMConnectivity.md b/skype/skype-ps/SkypeForBusiness/Test-CsExUMConnectivity.md similarity index 83% rename from skype/skype-ps/skype/Test-CsExUMConnectivity.md rename to skype/skype-ps/SkypeForBusiness/Test-CsExUMConnectivity.md index 89de2a0acc..08ea21e3a9 100644 --- a/skype/skype-ps/skype/Test-CsExUMConnectivity.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExUMConnectivity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csexumconnectivity applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsExUMConnectivity -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csexumconnectivity +schema: 2.0.0 +title: Test-CsExUMConnectivity --- # Test-CsExUMConnectivity @@ -43,7 +44,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsExUMConnectivity -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -54,7 +55,7 @@ If they have, then the command will determine whether or not the first test user If test users have not been configured for the pool then the command will fail. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -68,7 +69,7 @@ Note that you must supply the password for this account in order to create a val The second command in the example uses the supplied credentials object ($x) and the SIP address of the user litwareinc\kenmyer in order to determine whether or this user can connect to Exchange Unified Messaging. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -85,60 +86,10 @@ That XML data is then written to a file named C:\Logs\ExumTest.xml by using the ## PARAMETERS -### -TargetFqdn -Fully qualified domain name of the pool being tested for Exchange Unified Messaging connectivity. - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, 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 -``` - -### -UserCredential -User credentials object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -155,7 +106,6 @@ LiveID Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -165,13 +115,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,6 +133,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -202,7 +157,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -212,6 +166,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -223,7 +180,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -233,6 +189,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -240,7 +199,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -249,34 +207,67 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address of the user to be used in the test. -For example: +### -TargetFqdn -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. +Fully qualified domain name of the pool being tested for Exchange Unified Messaging connectivity. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credentials object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. + +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +. +For example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. + ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -288,13 +279,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsExUMConnectivity` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsExUMConnectivity` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsExUMVoiceMail.md b/skype/skype-ps/SkypeForBusiness/Test-CsExUMVoiceMail.md similarity index 82% rename from skype/skype-ps/skype/Test-CsExUMVoiceMail.md rename to skype/skype-ps/SkypeForBusiness/Test-CsExUMVoiceMail.md index 54fb97e64e..f607fa1ba6 100644 --- a/skype/skype-ps/skype/Test-CsExUMVoiceMail.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExUMVoiceMail.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csexumvoicemail applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsExUMVoiceMail -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csexumvoicemail +schema: 2.0.0 +title: Test-CsExUMVoiceMail --- # Test-CsExUMVoiceMail @@ -44,7 +45,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsExUMVoiceMail -TargetFqdn "atl-cs-001.litwareinc.com" -ReceiverSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -55,7 +56,7 @@ If they have, then the command will determine whether or not the first test user If test users have not been configured for the pool then the command will fail. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential = Get-Credential "litwareinc\pilar" @@ -69,7 +70,7 @@ Note that you must supply the password for this account in order to create a val The second command in the example uses the supplied credentials object ($x) and the SIP address of the user litwareinc\kenmyer in order to determine whether or this user can connect to Exchange Unified Messaging voice mail. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsExUMVoiceMail -TargetFqdn "atl-cs-001.litwareinc.com" -ReceiverSipAddress "sip:kenmyer@litwareinc.com" -OutLoggerVariable VoicemailTest @@ -84,63 +85,10 @@ That XML data is then written to a file named C:\Logs\VoicemailTest.xml by using ## PARAMETERS -### -SenderCredential -User credential object for the user account that will be leaving the voicemail message. -The value passed to SenderCredential must be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. -For example: - -`-TargetFqdn atl-cs-001.litwareinc.com` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, 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 -``` - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -153,7 +101,6 @@ Allowed values are: Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -163,13 +110,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +128,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -200,7 +152,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -210,6 +161,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -221,7 +175,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -231,6 +184,9 @@ Accept wildcard characters: False ``` ### -ReceiverSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the user account that should receive the test voice mail (this must be a different SIP address than the SIP address used for the sender). For example: @@ -240,9 +196,8 @@ You do not have to include credentials for the voicemail recipient. ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -251,11 +206,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. + ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Int32 +Parameter Sets: (All) +Aliases: rp Required: False Position: Named @@ -264,17 +225,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +### -SenderCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the user account that will be leaving the voicemail message. +The value passed to SenderCredential must be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -282,6 +252,9 @@ Accept wildcard characters: False ``` ### -SenderSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the user account that will be leaving the voicemail message (this must be a different SIP address than the SIP address used for the receiver). For example: @@ -293,9 +266,8 @@ The SIP address is not required if you are running the test under the health mon ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -304,20 +276,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. +For example: + +`-TargetFqdn atl-cs-001.litwareinc.com` + ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WaveFile + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to .WAV audio file that can be used when testing the voice mail service. If this parameter is included, the `Test-CsExUMVoiceMail` cmdlet will play the specified .WAV file when connecting to Exchange voicemail. If this parameter is not included, a default audio file will be played instead. @@ -327,7 +310,6 @@ If this parameter is not included, a default audio file will be played instead. Type: String Parameter Sets: (All) Aliases: wf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -341,13 +323,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsExUMVoiceMail` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsExUMVoiceMail` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsFederatedPartner.md b/skype/skype-ps/SkypeForBusiness/Test-CsFederatedPartner.md similarity index 82% rename from skype/skype-ps/skype/Test-CsFederatedPartner.md rename to skype/skype-ps/SkypeForBusiness/Test-CsFederatedPartner.md index 91379de7a9..7abe4f4400 100644 --- a/skype/skype-ps/skype/Test-CsFederatedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsFederatedPartner.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csfederatedpartner applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsFederatedPartner -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csfederatedpartner +schema: 2.0.0 +title: Test-CsFederatedPartner --- # Test-CsFederatedPartner @@ -34,7 +35,7 @@ When using this cmdlet, make sure that the TargetFqdn parameter points to the in ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain fabrikam.com ``` @@ -43,7 +44,7 @@ The command shown in Example 1 verifies the connection between the local access Note that TargetFqdn must point to the internal Edge Server FQDN to which federated SIP traffic is directed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain push.lync.com -ProxyFqdn sipfed.online.lync.com ``` @@ -53,7 +54,7 @@ You must have configured this service as a hosting provider and must have added For more information, see Configuring for push notifications in Lync Server 2013. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAllowedDomain | ForEach-Object {Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain $_.Identity} ``` @@ -66,48 +67,16 @@ In turn, `ForEach-Object` runs the `Test-CsFederatedPartner` cmdlet against each ## PARAMETERS -### -Domain -Fully qualified domain name (FQDN) of the federated domain. -For example: `-Domain "fabrikam.com"`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: d -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -FQDN of the access proxy server used by your organization for federated SIP traffic. -The TargetFqdn must point to the internal Edge Server FQDN to which federated SIP traffic is directed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Certificate -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Certificate Enables you to provide an X509 certificate for authentication purposes when connecting to the federated domain. ```yaml Type: X509Certificate2 Parameter Sets: (All) Aliases: ce -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -116,30 +85,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyFqdn -FQDN of the access proxy server used by the federated organization. +### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the federated domain. +For example: `-Domain "fabrikam.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: pe -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: d -Required: False -Position: Named +Required: True +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,14 +122,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity on the screen as the cmdlet runs. +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: olv Required: False Position: Named @@ -165,6 +154,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -177,7 +169,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -186,30 +177,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. +### -ProxyFqdn -To store output in a logger variable named $TestOutput use the following syntax: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-OutLoggerVariable TestOutput` +FQDN of the access proxy server used by the federated organization. -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +```yaml +Type: String +Parameter Sets: (All) +Aliases: pe -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -To save the information stored in the logger variable to an XML file, use a command similar to this: +### -TargetFqdn -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the access proxy server used by your organization for federated SIP traffic. +The TargetFqdn must point to the internal Edge Server FQDN to which federated SIP traffic is directed. ```yaml Type: String Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -220,13 +219,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None `Test-CsFederatedPartner` does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput `Test-CsFederatedPartner` returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsGroupExpansion.md b/skype/skype-ps/SkypeForBusiness/Test-CsGroupExpansion.md similarity index 81% rename from skype/skype-ps/skype/Test-CsGroupExpansion.md rename to skype/skype-ps/SkypeForBusiness/Test-CsGroupExpansion.md index 857d5182b8..06da932c2d 100644 --- a/skype/skype-ps/skype/Test-CsGroupExpansion.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsGroupExpansion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csgroupexpansion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsGroupExpansion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csgroupexpansion +schema: 2.0.0 +title: Test-CsGroupExpansion --- # Test-CsGroupExpansion @@ -65,7 +66,7 @@ Note that you can test group expansion in two different ways: by testing the ser ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsGroupExpansion -TargetFqdn atl-cs-001.litwareinc.com -GroupEmailAddress FinanceGroup@litwareinc.com ``` @@ -76,31 +77,41 @@ To run the test, the command uses the group FinanceGroup@litwareinc.com. ## PARAMETERS -### -GroupEmailAddress -Email address of the targeted distribution group. -For example: `-GroupEmailAddress "FinanceGroup@litwareinc.com"`. +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: String +Type: AuthenticationMechanism Parameter Sets: (All) -Aliases: g -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Ath -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -External -Enables you to verify that external users can use group expansion. +### -DomainController + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to test group expansion. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml -Type: SwitchParameter -Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: DC Required: False Position: Named @@ -109,15 +120,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +### -External + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to verify that external users can use group expansion. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: ServerPlatform, ClientPlatform -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,49 +138,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name (FQDN) of the Registrar pool where group expansion is to be tested. -For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. - -Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. +### -Force -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetUri -Uniform Resource Identifier (URI) of the Group Expansion Web service. -For example: `-TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion"`. +### -GroupEmailAddress -Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Email address of the targeted distribution group. +For example: `-GroupEmailAddress "FinanceGroup@litwareinc.com"`. ```yaml Type: String -Parameter Sets: TargetUri -Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: g Required: True Position: Named @@ -177,41 +175,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credential object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -OutLoggerVariable -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You will need to supply the user password when running this command. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -The user credential is not required if you are running the test under the credentials of the logged-on user and using the TargetFqdn parameter. -The user credential is required if you are using the TargetUri parameter. +To store output in a logger variable named $TestOutput use the following syntax: -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +`-OutLoggerVariable TestOutput` -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: -### -UserSipAddress -SIP address of the user to be used in the test. -If this parameter is not specified, then the `Test-CsGroupExpansion` cmdlet will conduct its checks using the account of the logged-on user. +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -220,27 +206,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutVerboseVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -249,14 +230,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Type: Int32 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: rp Required: False Position: Named @@ -265,91 +249,87 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -TargetFqdn -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not prepend a $ character when specifying the variable name. +Fully qualified domain name (FQDN) of the Registrar pool where group expansion is to be tested. +For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. +Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WebCredential -An object containing user credentials for accessing the Location Information service. -This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. +### -TargetUri -This parameter is required if the TargetUri and UserSipAddress parameters are specified, and the computer on which the command is run does not have a server certificate. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Uniform Resource Identifier (URI) of the Group Expansion Web service. +For example: `-TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion"`. + +Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. ```yaml -Type: PSCredential +Type: String Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: twsu -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -UserCredential -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You will need to supply the user password when running this command. + +The user credential is not required if you are running the test under the credentials of the logged-on user and using the TargetFqdn parameter. +The user credential is required if you are using the TargetUri parameter. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +### -UserSipAddress -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To save the information stored in the logger variable to an XML file, use a command similar to this: +SIP address of the user to be used in the test. +If this parameter is not specified, then the `Test-CsGroupExpansion` cmdlet will conduct its checks using the account of the logged-on user. -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri +Aliases: ua Required: False Position: Named @@ -358,15 +338,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to test group expansion. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). +### -WebCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An object containing user credentials for accessing the Location Information service. +This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. + +This parameter is required if the TargetUri and UserSipAddress parameters are specified, and the computer on which the command is run does not have a server certificate. + ```yaml -Type: String -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: TargetUri +Aliases: Required: False Position: Named @@ -380,13 +365,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsGroupExpansion` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsGroupExpansion` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsGroupIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsGroupIM.md similarity index 84% rename from skype/skype-ps/skype/Test-CsGroupIM.md rename to skype/skype-ps/SkypeForBusiness/Test-CsGroupIM.md index 02b1dae31c..e9846c03be 100644 --- a/skype/skype-ps/skype/Test-CsGroupIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsGroupIM.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csgroupim applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsGroupIM -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csgroupim +schema: 2.0.0 +title: Test-CsGroupIM --- # Test-CsGroupIM @@ -73,7 +74,7 @@ Adding the Verbose parameter enables you to get a detailed account of all the ac ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsGroupIm -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -87,7 +88,7 @@ If you have not defined test users for a pool, then you must include the SenderS The `Test-CsGroupIM` cmdlet will then conduct its checks using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -107,36 +108,107 @@ To carry out this task, the `Test-CsGroupIM` cmdlet is called, along with the fo ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID + +```yaml +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + + ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: ovv Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ReceiverCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the first of the two user accounts to be tested. The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: @@ -151,7 +223,6 @@ The receiver credential is not required if you are running the test under the he Type: PSCredential Parameter Sets: ClientPlatform Aliases: rc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -161,6 +232,9 @@ Accept wildcard characters: False ``` ### -ReceiverSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the first of the two user accounts to be tested. For example: `-ReceiverSipAddress "sip:pilar@litwareinc.com"`. The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. @@ -170,9 +244,8 @@ The SIP address is not required if you are running the test under the health mon ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -181,20 +254,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -RegistrarPort SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -202,7 +265,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -212,6 +274,9 @@ Accept wildcard characters: False ``` ### -SenderCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the second of the two user accounts to be tested. The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: @@ -226,7 +291,6 @@ The sender credential is not required if you are running the test under the heal Type: PSCredential Parameter Sets: ClientPlatform Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -236,6 +300,9 @@ Accept wildcard characters: False ``` ### -SenderSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the second of the two user accounts to be tested. For example: `-SenderSipAddres "sip:kenmyer@litwareinc.com"`. The SenderSipAddress parameter must reference the same user account as SenderCredential. @@ -245,9 +312,8 @@ The SIP address is not required if you are running the test under the health mon ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -256,133 +322,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -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 occur when running the command. - -```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 -``` - -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -TargetFqdn -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -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 -``` - -### -Authentication -Type of authentication used in the test. -Allowed values are: - -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID - -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` - -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +### -TestJoinLauncher -```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> 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 -``` - -### -TestJoinLauncher When present, tests the ability of the Join Launcher to participate in an AV conference. The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -396,13 +364,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsGroupIM` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsGroupIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsIM.md similarity index 80% rename from skype/skype-ps/skype/Test-CsIM.md rename to skype/skype-ps/SkypeForBusiness/Test-CsIM.md index 76029053a9..fc50708416 100644 --- a/skype/skype-ps/skype/Test-CsIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsIM.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csim applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsIM -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csim +schema: 2.0.0 +title: Test-CsIM --- # Test-CsIM @@ -57,7 +58,7 @@ Assuming the two logons are successful, the cmdlet then initiates an instant mes ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsIm -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -72,7 +73,7 @@ If you have not defined a Registrar for a pool, then you must include the Sender The`Test-CsIM` cmdlet will then conduct its checks by using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -92,55 +93,47 @@ To do this, the `Test-CsIM` cmdlet is called along with the following parameters ## PARAMETERS -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: +### -Authentication -`$y = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +Type of authentication used in the test. +Allowed values are: -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. +TrustedServer -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Negotiate -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +ClientCertificate -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: `-ReceiverSipAddress "sip:jhaas@litwareinc.com"`. -The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. +LiveID -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -EmailHost + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Email host for user employed in the Legal Intercept test. +For example: + +`-EmailHost "litwareinc.com"` + ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -149,55 +142,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` +### -Force -You need to supply the user password when running this command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. -For example: `-SenderSipAddress "sip:kenmyer@litwareinc.com"`. -The SenderSipAddress parameter must reference the same user account as SenderCredential. - -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +### -IsSsl -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When set to True, specifies that the test is being conducted using the Secure Socket Layer (SSL) protocol. ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -206,44 +178,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -OutLoggerVariable -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, 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 -``` +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +To store output in a logger variable named $TestOutput use the following syntax: -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-OutLoggerVariable TestOutput` -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv Required: False Position: Named @@ -252,14 +209,22 @@ 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. +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -268,14 +233,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -Password + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Password for the employed in the Legal Intercept test. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -284,20 +251,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -Port -`-OutVerboseVariable TestOutput` - -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Port used for the Legal Intercept service. ```yaml -Type: String +Type: UInt16 Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -306,59 +269,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -ReceiverCredential -TrustedServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Negotiate +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: -ClientCertificate +`$y = Get-Credential "litwareinc\pilar"` -LiveID +You need to supply the user password when running this command. +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: rc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EmailHost -Email host for user employed in the Legal Intercept test. -For example: +### -ReceiverSipAddress -`-EmailHost "litwareinc.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. +For example: `-ReceiverSipAddress "sip:jhaas@litwareinc.com"`. +The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: ra -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IsSsl -When set to True, specifies that the test is being conducted using the Secure Socket Layer (SSL) protocol. +### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: Boolean +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp Required: False Position: Named @@ -367,75 +336,82 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: +### -SenderCredential -`-OutLoggerVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +`$x = Get-Credential "litwareinc\kenmyer"` -To save the information stored in the logger variable to an XML file, use a command similar to this: +You need to supply the user password when running this command. -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Password -Password for the employed in the Legal Intercept test. +### -SenderSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the second of the two user accounts to be tested. +For example: `-SenderSipAddress "sip:kenmyer@litwareinc.com"`. +The SenderSipAddress parameter must reference the same user account as SenderCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: sa -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Port -Port used for the Legal Intercept service. +### -TargetFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -TestLegalIntercept + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When used, instructs `Test-CsIM` to test the Legal Intercept service for the specified user. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -445,13 +421,15 @@ Accept wildcard characters: False ``` ### -Username + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User name for the user employed in the Legal Intercept test. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -461,13 +439,15 @@ Accept wildcard characters: False ``` ### -WaitSeconds + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time (in seconds) that the system should wait for the Legal Intercept service to respond. ```yaml Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -481,13 +461,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsIM` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsInterTrunkRouting.md b/skype/skype-ps/SkypeForBusiness/Test-CsInterTrunkRouting.md similarity index 87% rename from skype/skype-ps/skype/Test-CsInterTrunkRouting.md rename to skype/skype-ps/SkypeForBusiness/Test-CsInterTrunkRouting.md index c0afe78bea..c74d371c8a 100644 --- a/skype/skype-ps/skype/Test-CsInterTrunkRouting.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsInterTrunkRouting.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csintertrunkrouting applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsInterTrunkRouting -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csintertrunkrouting +schema: 2.0.0 +title: Test-CsInterTrunkRouting --- # Test-CsInterTrunkRouting @@ -34,7 +35,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $trunk = Get-CsTrunkConfiguration -Identity "site:Redmond" @@ -46,79 +47,87 @@ The commands shown in Example 1 return the matching routes and matching phone us ## PARAMETERS -### -TargetNumber -PSTN telephone number to be called when conducting the test. -The target phone number should specified using the E.164 format, which means that the number will look something like this: +### -Force -`-TargetNumber "tel:+12065551219"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The phone number should include the "tel:" prefix followed by a plus sign (+), the country/region calling code (1), the area code (206) and the phone number (5551219). -Do not use dashes, parentheses, or any other characters when specifying the phone number. +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: PhoneNumber +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TrunkConfiguration -Object reference to the trunk configuration being tested. +### -RouteSettings + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference that enables you to specify a collection of voice routing configuration settings when calling `Test-CsInterTrunkRouting`. To create this object reference, use a command similar to this: -`$trunk = Get-CsTrunkConfiguration -Identity "site:Redmond"` +`$route = Get-CsRoutingConfiguration -Identity "global"` ```yaml -Type: TrunkConfiguration +Type: PstnRoutingSettings Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +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. +### -TargetNumber + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +PSTN telephone number to be called when conducting the test. +The target phone number should specified using the E.164 format, which means that the number will look something like this: + +`-TargetNumber "tel:+12065551219"` + +The phone number should include the "tel:" prefix followed by a plus sign (+), the country/region calling code (1), the area code (206) and the phone number (5551219). +Do not use dashes, parentheses, or any other characters when specifying the phone number. ```yaml -Type: SwitchParameter +Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RouteSettings -Object reference that enables you to specify a collection of voice routing configuration settings when calling `Test-CsInterTrunkRouting`. +### -TrunkConfiguration + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference to the trunk configuration being tested. To create this object reference, use a command similar to this: -`$route = Get-CsRoutingConfiguration -Identity "global"` +`$trunk = Get-CsTrunkConfiguration -Identity "site:Redmond"` ```yaml -Type: PstnRoutingSettings +Type: TrunkConfiguration Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -127,13 +136,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None `Test-CsInterTrunkRouting` does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.InterTrunkRoutingTestResult `Test-CsInterTrunkRouting` returns instances of the Microsoft.Rtc.Management.Voice.InterTrunkRoutingTestResult object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Test-CsKerberosAccountAssignment.md similarity index 83% rename from skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md rename to skype/skype-ps/SkypeForBusiness/Test-CsKerberosAccountAssignment.md index f5ecfa9315..ebb7377ef1 100644 --- a/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsKerberosAccountAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsKerberosAccountAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cskerberosaccountassignment +schema: 2.0.0 +title: Test-CsKerberosAccountAssignment --- # Test-CsKerberosAccountAssignment @@ -35,7 +36,7 @@ The `Test-CsKerberosAccountAssignment` cmdlet provides a way for you to verify t ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Test-CsKerberosAccountAssignment -Identity site:Redmond ``` @@ -46,14 +47,16 @@ The command shown in Example 1 verifies that the Kerberos account assigned to th ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the site where the Kerberos account was assigned. For example: `-Identity "site:Redmond"`. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -63,30 +66,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\TestKerberos.html"`. ```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 -``` - -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -100,13 +89,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsKerberosAccountAssignment` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Test-CsKerberosAccountAssignment` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsLisCivicAddress.md b/skype/skype-ps/SkypeForBusiness/Test-CsLisCivicAddress.md similarity index 80% rename from skype/skype-ps/skype/Test-CsLisCivicAddress.md rename to skype/skype-ps/SkypeForBusiness/Test-CsLisCivicAddress.md index 2ff376a8bc..5be5e523ec 100644 --- a/skype/skype-ps/skype/Test-CsLisCivicAddress.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsLisCivicAddress.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csliscivicaddress applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsLisCivicAddress -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csliscivicaddress +schema: 2.0.0 +title: Test-CsLisCivicAddress --- # Test-CsLisCivicAddress @@ -38,7 +39,7 @@ Use the `Get-CsLisCivicAddress` cmdlet to retrieve civic addresses. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsLisCivicAddress -HouseNumber 1234 -HouseNumberSuffix "" -PreDirectional "" -StreetName Main -StreetSuffix St -PostDirectional "" -City Redmond -State WA -PostalCode 99999 -Country US -UpdateValidationStatus ``` @@ -47,7 +48,7 @@ This command validates the address with the properties matching the values speci Notice the inclusion of the UpdateValidationStatus parameter at the end: this will update the MSAGValid property of the address. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisCivicAddress | Test-CsLisCivicAddress -UpdateValidationStatus ``` @@ -60,6 +61,9 @@ These addresses are piped to the `Test-CsLisCivicAddress` cmdlet, which uses the ## PARAMETERS ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The location city. Maximum length: 64 characters. @@ -67,8 +71,7 @@ Maximum length: 64 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Country + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The country/region this location is in. Maximum length: 2 characters @@ -85,8 +91,7 @@ Maximum length: 2 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The house number of the location. For a company, this is the number on the street where the company is located. @@ -104,8 +112,7 @@ Maximum length: 10 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -123,8 +133,7 @@ Maximum length: 5 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The postal code associated with this location. Maximum length: 10 characters @@ -141,8 +153,7 @@ Maximum length: 10 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -PostDirectional + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -160,8 +174,7 @@ Maximum length: 2 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -PreDirectional + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -179,8 +195,7 @@ Maximum length: 2 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The state or province associated with this location. Maximum length: 2 characters @@ -197,8 +215,7 @@ Maximum length: 2 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,6 +225,9 @@ Accept wildcard characters: False ``` ### -StreetName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the street for this location. Maximum length: 60 characters @@ -215,8 +235,7 @@ Maximum length: 60 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -226,6 +245,9 @@ Accept wildcard characters: False ``` ### -StreetSuffix + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters @@ -233,8 +255,7 @@ Maximum length: 10 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,6 +265,9 @@ Accept wildcard characters: False ``` ### -UpdateValidationStatus + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Including this parameter will change the MSAGValid property of the civic address depending on whether the address is validated through this cmdlet. If the address is valid, MSAGValid will be set to True. Omitting this parameter will leave the MSAGValid value unchanged. @@ -251,8 +275,7 @@ Omitting this parameter will leave the MSAGValid value unchanged. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,14 +284,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -277,14 +302,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -298,12 +325,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input containing a Location Information Server (LIS) civic address object. ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsLisConfiguration.md similarity index 82% rename from skype/skype-ps/skype/Test-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsLisConfiguration.md index 40c2654be8..b250635d13 100644 --- a/skype/skype-ps/skype/Test-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cslisconfiguration +schema: 2.0.0 +title: Test-CsLisConfiguration --- # Test-CsLisConfiguration @@ -53,7 +54,7 @@ In addition, if you call this cmdlet without supplying any of the optional param ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsLisConfiguration -TargetFqdn atl-cs-001.litwareinc.com -Subnet 192.168.0.0 ``` @@ -67,7 +68,7 @@ To see if a health monitoring configuration exists, run the `Get-CsHealthMonitor To create a new health monitoring configuration, run the `New-CsHealthMonitoringConfiguration` cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsLisConfiguration -TargetFqdn atl-cs-001.litwareinc.com -Subnet 192.168.0.0 -UserSipAddress sip:kmyer@litwareinc.com ``` @@ -76,7 +77,7 @@ This example is identical to Example 1 but with the addition of the UserSipAddre Use this command when no synthetic transaction users have been set up, but where the computer on which the command is running has a server certificate. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $cred = Get-Credential @@ -90,7 +91,7 @@ The second line is identical to the command in Example 2 but with the addition o Use this command when no synthetic transaction users have been set up, and where the computer on which the command is running does not have a server certificate. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $cred = Get-Credential @@ -107,7 +108,7 @@ If a location can be found that maps to the subnet IP address 192.168.0.0, the M Use this command when the computer on which the command is running does not have a server certificate. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Test-CsLisConfiguration -TargetUri https://atl-cs-001.litwareinc.com/locationinformation/lisservice.svc -UserSipAddress sip:kmyer@litwareinc.com -Subnet 192.168.0.0 -Mac 0A-23-00-00-00-AA -PortId 4500 -ChassisId 0A-23-00-00-00-AA ``` @@ -118,92 +119,82 @@ Use this command when the computer on which the command is running has a server ## PARAMETERS -### -TargetFqdn -The fully qualified domain name (FQDN) (in the form server.litwareinc.com) of the server against which you want to run the test. +### -Authentication -This parameter is required unless you specify the TargetUri parameter, in which case you cannot specify a TargetFqdn. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type of authentication used in the test. +Allowed values are: + +TrustedServer + +Negotiate + +ClientCertificate + +LiveID -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetUri -The Uniform Resource Identifier (URI) of the Location Information service. -You can retrieve the URI of the Location Information service by running the following command: `Get-CsService -WebServer | Select-Object LisServiceInternalUri` - -If you specify a value for this parameter, the UserSipAddress parameter is also required. -If the computer you are running the command on does not have a server certificate, you must also specify a value for the WebCredential parameter. +### -BssId -This parameter is required unless you specify the TargetFqdn parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The Basic Service Set Identifier (BSSID) of a wireless access point. +This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String -Parameter Sets: TargetUri -Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: b -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -An object containing user credentials for accessing the Location Information service. -This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. +### -ChassisId -This parameter is required if the TargetFqdn and UserSipAddress parameters are specified, and if the computer from which you're running the cmdlet does not have a server certificate. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Media Access Control (MAC) address of a network switch. +This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab, or an IP address. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: c -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -The SIP address of a remote user. +### -External -If you specify a value for this parameter, the TargetFqdn or TargetUri parameter is also required. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter is required when you specify the TargetFqdn parameter only if you have not set up synthetic transactions users. -To see if synthetic transaction users have been set up, run the `Get-CsHealthMonitoringConfiguration` cmdlet. +This parameter is not supported for Location Information Server. ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: Required: False Position: Named @@ -212,28 +203,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + ```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BssId -The Basic Service Set Identifier (BSSID) of a wireless access point. +### -Mac + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The MAC address of the port switch. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) -Aliases: b -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: m Required: False Position: Named @@ -242,15 +240,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ChassisId -The Media Access Control (MAC) address of a network switch. -This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab, or an IP address. +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String Parameter Sets: (All) -Aliases: c -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv Required: False Position: Named @@ -259,31 +271,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -External -This parameter is not supported for Location Information Server. +### -OutVerboseVariable -```yaml -Type: SwitchParameter -Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -Mac -The MAC address of the port switch. -This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) -Aliases: m -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -293,6 +296,9 @@ Accept wildcard characters: False ``` ### -PortId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The ID of the port associated with the location to test. This can also contain a MAC address or IP address. @@ -300,7 +306,6 @@ This can also contain a MAC address or IP address. Type: String Parameter Sets: (All) Aliases: p -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -310,6 +315,9 @@ Accept wildcard characters: False ``` ### -PortIdSubType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The subtype of the port. This value can be entered as a numeric value or a string, but it must be a valid subtype. Valid subtypes are: @@ -324,7 +332,6 @@ Valid subtypes are: Type: PortIDSubType Parameter Sets: (All) Aliases: ps -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -334,13 +341,15 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The port number of the Registrar service. ```yaml Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -350,6 +359,9 @@ Accept wildcard characters: False ``` ### -Subnet + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The IP address of a subnet. This value should be entered as an IPv4 address (digits separated by periods, such as 192.0.2.0). @@ -357,7 +369,6 @@ This value should be entered as an IPv4 address (digits separated by periods, su Type: String Parameter Sets: (All) Aliases: s -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -366,81 +377,87 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebCredential -An object containing user credentials for accessing the Location Information service. -This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. +### -TargetFqdn -This parameter is required if the TargetUri and UserSipAddress parameters are specified, and the computer on which the command is run does not have a server certificate. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) (in the form server.litwareinc.com) of the server against which you want to run the test. + +This parameter is required unless you specify the TargetUri parameter, in which case you cannot specify a TargetFqdn. ```yaml -Type: PSCredential -Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -TargetUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Uniform Resource Identifier (URI) of the Location Information service. +You can retrieve the URI of the Location Information service by running the following command: `Get-CsService -WebServer | Select-Object LisServiceInternalUri` + +If you specify a value for this parameter, the UserSipAddress parameter is also required. +If the computer you are running the command on does not have a server certificate, you must also specify a value for the WebCredential parameter. + +This parameter is required unless you specify the TargetFqdn parameter. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: TargetUri +Aliases: twsu -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -UserCredential -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not prepend a $ character when specifying the variable name. +An object containing user credentials for accessing the Location Information service. +This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. +This parameter is required if the TargetFqdn and UserSipAddress parameters are specified, and if the computer from which you're running the cmdlet does not have a server certificate. ```yaml -Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: - -TrustedServer +### -UserSipAddress -Negotiate +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -ClientCertificate +The SIP address of a remote user. -LiveID +If you specify a value for this parameter, the TargetFqdn or TargetUri parameter is also required. +This parameter is required when you specify the TargetFqdn parameter only if you have not set up synthetic transactions users. +To see if synthetic transaction users have been set up, run the `Get-CsHealthMonitoringConfiguration` cmdlet. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri +Aliases: ua Required: False Position: Named @@ -449,27 +466,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +### -WebCredential -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To save the information stored in the logger variable to an XML file, use a command similar to this: +An object containing user credentials for accessing the Location Information service. +This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +This parameter is required if the TargetUri and UserSipAddress parameters are specified, and the computer on which the command is run does not have a server certificate. ```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: TargetUri +Aliases: Required: False Position: Named @@ -483,12 +492,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsLisConfiguration` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Test-CsLocationPolicy.md similarity index 84% rename from skype/skype-ps/skype/Test-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Test-CsLocationPolicy.md index a4881b7d5b..ff082b56f6 100644 --- a/skype/skype-ps/skype/Test-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cslocationpolicy +schema: 2.0.0 +title: Test-CsLocationPolicy --- # Test-CsLocationPolicy @@ -58,7 +59,7 @@ If a location policy for the subnet was not found, the LocationPolicyTagID will ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsLocationPolicy -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -67,7 +68,7 @@ This example determines the location policy of the current user (or currently co The TargetFqdn is required. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred = Get-Credential "litwareinc\kenmyer" @@ -87,7 +88,7 @@ However, in this example rather than using the preconfigured user, we're going t We pass that value (with the sip: prefix) to the UserSipAddress parameter, and the credentials for that user (stored in the $cred variable) to the UserCredential parameter. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsLocationPolicy -TargetFqdn atl-cs-001.litwareinc.com -UserSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -98,7 +99,7 @@ If the computer does not have a server certificate, you must specify credentials To find out whether there is a server certificate on the computer, call the `Get-CsCertificate` cmdlet. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Test-CsLocationPolicy -TargetFqdn atl-cs-001.litwareinc.com -Subnet 172.15.11.0 ``` @@ -116,44 +117,40 @@ For example: ## PARAMETERS -### -TargetFqdn -The fully qualified domain name (FQDN) of the pool on which the specified user or subnet is homed. -(If no user is specified, the preconfigured or current user will be assumed.) +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPort -The port number of the Registrar service. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,14 +159,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Subnet -The ID (the IP address) of the network subnet for which you want to test the location policy. +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String Parameter Sets: (All) -Aliases: s -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv Required: False Position: Named @@ -178,33 +190,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -An object containing the user ID and password of the user account where the location policy is being tested. -A credential object can be retrieved by calling the `Get-Credential` cmdlet, filling in the appropriate information, and saving the output to a variable. +### -OutVerboseVariable +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -UserSipAddress -The SIP address of the user whose location policy you want to test. -This must be in the format sip:\, for example, sip:kenmyer@litwareinc.com. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: ovv Required: False Position: Named @@ -213,27 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +The port number of the Registrar service. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp Required: False Position: Named @@ -242,20 +232,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -Subnet -`-OutVerboseVariable TestOutput` - -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The ID (the IP address) of the network subnet for which you want to test the location policy. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: s Required: False Position: Named @@ -264,49 +250,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -TargetFqdn -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the pool on which the specified user or subnet is homed. +(If no user is specified, the preconfigured or current user will be assumed.) ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. +### -UserCredential -To store output in a logger variable named $TestOutput use the following syntax: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-OutLoggerVariable TestOutput` +An object containing the user ID and password of the user account where the location policy is being tested. +A credential object can be retrieved by calling the `Get-Credential` cmdlet, filling in the appropriate information, and saving the output to a variable. -Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -To save the information stored in the logger variable to an XML file, use a command similar to this: +### -UserSipAddress -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP address of the user whose location policy you want to test. +This must be in the format sip:\, for example, sip:kenmyer@litwareinc.com. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ua Required: False Position: Named @@ -320,12 +312,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsLocationPolicy` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsManagementServer.md b/skype/skype-ps/SkypeForBusiness/Test-CsManagementServer.md similarity index 90% rename from skype/skype-ps/skype/Test-CsManagementServer.md rename to skype/skype-ps/SkypeForBusiness/Test-CsManagementServer.md index 3f9787e03b..96f5490331 100644 --- a/skype/skype-ps/skype/Test-CsManagementServer.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsManagementServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csmanagementserver applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsManagementServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csmanagementserver +schema: 2.0.0 +title: Test-CsManagementServer --- # Test-CsManagementServer @@ -32,7 +33,7 @@ The `Test-CsManagementServer` cmdlet enables you verify that the Management serv ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsManagementServer ``` @@ -44,6 +45,9 @@ Because there can only be a single instance of this service, no additional param ## PARAMETERS ### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -52,8 +56,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -67,13 +70,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `test-CsManagementServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsManagementServer` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsMcxConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsMcxConference.md similarity index 89% rename from skype/skype-ps/skype/Test-CsMcxConference.md rename to skype/skype-ps/SkypeForBusiness/Test-CsMcxConference.md index ead7987bb7..3036a2481c 100644 --- a/skype/skype-ps/skype/Test-CsMcxConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsMcxConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxconference applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 -title: Test-CsMcxConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csmcxconference +schema: 2.0.0 +title: Test-CsMcxConference --- # Test-CsMcxConference @@ -63,13 +64,15 @@ After the credentials objects have been created, you can then call the `Test-CsM ## PARAMETERS ### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allowed values are: TrustedServer; Negotiate; ClientCertificate; and LiveID. ```yaml Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -78,7 +81,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -OrganizerCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + User credential object for the user account acting as the meeting organizer. The value passed to OrganizerCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\adelaney and stores that object in a variable named $z: @@ -91,7 +115,6 @@ You need to supply the user password when running this command. Type: PSCredential Parameter Sets: (All) Aliases: oc -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -101,6 +124,9 @@ Accept wildcard characters: False ``` ### -OrganizerSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SIP address for the user account acting as the meeting organizer. For example: @@ -112,7 +138,6 @@ The OrganizerSipAddress parameter must reference the same user account as the Or Type: String Parameter Sets: (All) Aliases: oa -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -121,187 +146,187 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -OutLoggerVariable -```yaml -Type: String -Parameter Sets: (All) -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -### -User2Credential -User credential object for the second of the two user accounts to be tested. -The value passed to Use2rCredential should be an object reference obtained by using the`Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $y: +To store output in a logger variable named $TestOutput use the following syntax: -`$y = Get-Credential "litwareinc\kenmyer"` +`-OutLoggerVariable TestOutput` -You need to supply the user password when running this command. +Note: Do not use prepend a $ character when specifying the variable name. + +To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: PSCredential +Type: String Parameter Sets: (All) -Aliases: spc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -User2SipAddress -SIP address for the second of the two user accounts to be tested. -For example: +### -OutVerboseVariable -`-User2SipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The User2SipAddress parameter must reference the same user account as the User2Credential parameter. +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax + +`-OutVerboseVariable TestOutput` + +Do not use prepend a $ character when specifying the variable name. ```yaml Type: String Parameter Sets: (All) -Aliases: spa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credentials object for the first of the two user accounts to be tested. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $x: +### -RegistrarPort -`$x = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: PSCredential +Type: Int32 Parameter Sets: (All) -Aliases: fpc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -TargetFqdn -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -The UserSipAddress parameter must reference the same user account as the UserCredential parameter. +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String Parameter Sets: (All) -Aliases: fpa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: t Required: True -Position: Named +Position: 2 Default value: None 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. +### -User2Credential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the second of the two user accounts to be tested. +The value passed to Use2rCredential should be an object reference obtained by using the`Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. ```yaml -Type: SwitchParameter +Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: spc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. +### -User2SipAddress -To save the information stored in the logger variable to an HTML file, use a command similar to this: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +SIP address for the second of the two user accounts to be tested. +For example: -To save the information stored in the logger variable to an XML file, use a command similar to this: +`-User2SipAddress "sip:pilar@litwareinc.com"` -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +The User2SipAddress parameter must reference the same user account as the User2Credential parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: spa -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax +### -UserCredential -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not use prepend a $ character when specifying the variable name. +User credentials object for the first of the two user accounts to be tested. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: fpc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. +For example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +The UserSipAddress parameter must reference the same user account as the UserCredential parameter. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: fpa -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -313,14 +338,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsMcxConference` cmdlet does not accept pipelined input. ## OUTPUTS -### -The `Test-CsMcxConference` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. +### Microsoft.Rtc.SyntheticTransactions.TaskOutput ## NOTES diff --git a/skype/skype-ps/skype/Test-CsMcxP2PIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsMcxP2PIM.md similarity index 91% rename from skype/skype-ps/skype/Test-CsMcxP2PIM.md rename to skype/skype-ps/SkypeForBusiness/Test-CsMcxP2PIM.md index b56a148b8b..094da9b933 100644 --- a/skype/skype-ps/skype/Test-CsMcxP2PIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsMcxP2PIM.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxp2pim applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 -title: Test-CsMcxP2PIM -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csmcxp2pim +schema: 2.0.0 +title: Test-CsMcxP2PIM --- # Test-CsMcxP2PIM @@ -41,7 +42,7 @@ Instead, the cmdlet verifies that the two users are able to log on to Skype for ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $credential1 = Get-Credential "litwareinc\kenmyer" @@ -59,13 +60,15 @@ After the credential objects have been created, the final command calls the `Tes ## PARAMETERS ### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allowed values are: TrustedServer; Negotiate; ClientCertificate; and LiveID. ```yaml Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -74,84 +77,96 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverCredential -User credentials object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: +### -Force -`$y = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -You need to supply the user password when running this command. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential +Type: SwitchParameter Parameter Sets: (All) -Aliases: rc -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -OutLoggerVariable -`-ReceiverSipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -The ReceiverSipAddress parameter must reference the same user account as the ReceiverCredential parameter. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. + +To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String Parameter Sets: (All) -Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: olv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderCredential -User credentials object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -OutVerboseVariable -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -You need to supply the user password when running this command. +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not use prepend a $ character when specifying the variable name. ```yaml -Type: PSCredential +Type: String Parameter Sets: (All) -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: ovv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. -For example: +### -ReceiverCredential -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -The SenderSipAddress parameter must reference the same user account as the SenderCredential parameter. +User credentials object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: rc Required: True Position: Named @@ -160,30 +175,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -ReceiverSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +SIP address for the first of the two user accounts to be tested. +For example: + +`-ReceiverSipAddress "sip:pilar@litwareinc.com"` + +The ReceiverSipAddress parameter must reference the same user account as the ReceiverCredential parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: ra Required: True -Position: 2 +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 occur when running the command. +### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: rp Required: False Position: Named @@ -192,70 +217,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. +### -SenderCredential -To save the information stored in the logger variable to an HTML file, use a command similar to this: +> Applicable: Lync Server 2013, Skype for Business Server 2015 -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +User credentials object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -To save the information stored in the logger variable to an XML file, use a command similar to this: +`$x = Get-Credential "litwareinc\kenmyer"` -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +You need to supply the user password when running this command. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -SenderSipAddress -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -Do not use prepend a $ character when specifying the variable name. +SIP address for the second of the two user accounts to be tested. +For example: + +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` + +The SenderSipAddress parameter must reference the same user account as the SenderCredential parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: sa -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -266,13 +287,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsMcxP2PIM` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsMcxP2PIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsMcxPushNotification.md b/skype/skype-ps/SkypeForBusiness/Test-CsMcxPushNotification.md similarity index 91% rename from skype/skype-ps/skype/Test-CsMcxPushNotification.md rename to skype/skype-ps/SkypeForBusiness/Test-CsMcxPushNotification.md index cc044294c2..7c9d5603b4 100644 --- a/skype/skype-ps/skype/Test-CsMcxPushNotification.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsMcxPushNotification.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxpushnotification applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 -title: Test-CsMcxPushNotification -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csmcxpushnotification +schema: 2.0.0 +title: Test-CsMcxPushNotification --- # Test-CsMcxPushNotification @@ -42,7 +43,7 @@ When using this cmdlet, make sure that the AccessEdgeFqdn parameter points to th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsMcxPushNotification -AccessEdgeFqdn "atl-edge-001.litwareinc.com" ``` @@ -54,13 +55,15 @@ The AccessEdgeFqdn must point to the internal edge of the proxy server to which ## PARAMETERS ### -AccessEdgeFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name of the Access Edge server used to connect to the push notification service. ```yaml Type: String Parameter Sets: (All) Aliases: fqdn -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: 2 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to specify an X509 certificate to use for authentication purposes ```yaml Type: X509Certificate2 Parameter Sets: (All) Aliases: cert -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -123,7 +133,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax @@ -144,7 +156,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -158,13 +169,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsMcxPushNotification` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsMcxPushNotification` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsOUPermission.md b/skype/skype-ps/SkypeForBusiness/Test-CsOUPermission.md similarity index 81% rename from skype/skype-ps/skype/Test-CsOUPermission.md rename to skype/skype-ps/SkypeForBusiness/Test-CsOUPermission.md index 1dfd1ab566..c07a949a5d 100644 --- a/skype/skype-ps/skype/Test-CsOUPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsOUPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csoupermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsOUPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csoupermission +schema: 2.0.0 +title: Test-CsOUPermission --- # Test-CsOUPermission @@ -36,7 +37,7 @@ If the cmdlet returns False, you will then need to run the `Grant-CsOUPermission ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user" ``` @@ -46,70 +47,58 @@ The command shown in Example 1 verifies that user permissions have been set on t ## PARAMETERS -### -ObjectType -Type of object to be checked. -Valid values are: - -User - -Computer - -Contact - -AppContact - -InetOrgPerson +### -Domain -To check multiple objects in the same kind, separate the object types by using commas: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-ObjectType "user","computer","contact"` +Name of the domain where the OU to be checked is located. +If this parameter is not included, then the `Test-CsOUPermission` cmdlet will look for the OU on the current domain. ```yaml -Type: ObjectType +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OU -Distinguished name of the organizational unit (OU) to be checked. -For example: +### -DomainController -`-OU "ou=Redmond,dc=litwareinc,dc=com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you can only check a single OU per command. +Fully qualified domain name (FQDN) of a domain controller in your domain. +This parameter is not required if you are running the `Test-CsOUPermission` cmdlet on a computer with an account in your domain. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Domain -Name of the domain where the OU to be checked is located. -If this parameter is not included, then the `Test-CsOUPermission` cmdlet will look for the OU on the current domain. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a global catalog server in your domain. +This parameter is not required if you are running the `Test-CsOUPermission` cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,36 +107,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Fully qualified domain name (FQDN) of a domain controller in your domain. -This parameter is not required if you are running the `Test-CsOUPermission` cmdlet on a computer with an account in your domain. +### -ObjectType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of object to be checked. +Valid values are: + +User + +Computer + +Contact + +AppContact + +InetOrgPerson + +To check multiple objects in the same kind, separate the object types by using commas: + +`-ObjectType "user","computer","contact"` ```yaml -Type: Fqdn +Type: ObjectType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -FQDN of a global catalog server in your domain. -This parameter is not required if you are running the `Test-CsOUPermission` cmdlet on a computer with an account in your domain. +### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Distinguished name of the organizational unit (OU) to be checked. +For example: + +`-OU "ou=Redmond,dc=litwareinc,dc=com"` + +Note that you can only check a single OU per command. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -155,6 +166,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -166,24 +180,7 @@ If this file already exists, it will be overwritten when you run the cmdlet. ```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 -``` - -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -197,13 +194,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsOUPermission` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsOUPermission` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsP2PAV.md b/skype/skype-ps/SkypeForBusiness/Test-CsP2PAV.md similarity index 82% rename from skype/skype-ps/skype/Test-CsP2PAV.md rename to skype/skype-ps/SkypeForBusiness/Test-CsP2PAV.md index 8c3e9d9900..b49e14f2bb 100644 --- a/skype/skype-ps/skype/Test-CsP2PAV.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsP2PAV.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csp2pav applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsP2PAV -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csp2pav +schema: 2.0.0 +title: Test-CsP2PAV --- # Test-CsP2PAV @@ -58,7 +59,7 @@ Instead, the cmdlet simply verifies that the appropriate connections can be made ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsP2PAV -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -72,7 +73,7 @@ If you have not defined test users for a pool, then you must include the SenderS The `Test-CsP2PAV` cmdlet will then conduct its checks using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -92,75 +93,75 @@ To carry out this task, the `Test-CsP2PAV` cmdlet is called, along with the foll ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +TrustedServer + +Negotiate + +ClientCertificate + +LiveID -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: - -`$y = Get-Credential "litwareinc\pilar"` +### -Force -You need to supply the user password when running this command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -OutLoggerVariable -`-ReceiverSipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -169,28 +170,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutVerboseVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -199,22 +194,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -ReceiverCredential -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\pilar"` You need to supply the user password when running this command. -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rc Required: True Position: Named @@ -223,22 +220,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. +### -ReceiverSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. For example: -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +`-ReceiverSipAddress "sip:pilar@litwareinc.com"` -The SenderSipAddress parameter must reference the same user account as SenderCredential. +The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. - ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ra Required: False Position: Named @@ -247,27 +245,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp Required: False Position: Named @@ -276,62 +264,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +### -SenderCredential -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -`-OutVerboseVariable TestOutput` +`$x = Get-Credential "litwareinc\kenmyer"` -Do not prepend a $ character when specifying the variable name. +You need to supply the user password when running this command. +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -SenderSipAddress -TrustedServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Negotiate +SIP address for the second of the two user accounts to be tested. +For example: -ClientCertificate +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` -LiveID +The SenderSipAddress parameter must reference the same user account as SenderCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: sa Required: False Position: Named @@ -340,30 +316,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +### -TargetFqdn -To save the information stored in the logger variable to an XML file, use a command similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -374,13 +339,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsP2PAV` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsP2PAV` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md b/skype/skype-ps/SkypeForBusiness/Test-CsP2PVideoInteropServerSipTrunkAV.md similarity index 87% rename from skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md rename to skype/skype-ps/SkypeForBusiness/Test-CsP2PVideoInteropServerSipTrunkAV.md index 73035ead45..fd3c39ade1 100644 --- a/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsP2PVideoInteropServerSipTrunkAV.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csp2pvideointeropserversiptrunkav applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsP2PVideoInteropServerSipTrunkAV -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csp2pvideointeropserversiptrunkav +schema: 2.0.0 +title: Test-CsP2PVideoInteropServerSipTrunkAV --- # Test-CsP2PVideoInteropServerSipTrunkAV @@ -70,7 +71,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $cred1 = Get-Credential "contoso\user1" @@ -82,57 +83,10 @@ This example creates a credential variable and passes the credential and SIP add ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: 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 -``` - -### -UserCredential -User credentials object for the account to be tested. -The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named `$x: $x = Get-Credential "litwareinc\kenmyer"`. -You need to supply the user password when running `Get-Credential`. - -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Type of authentication used in the test. Allowed values are: @@ -148,7 +102,6 @@ LiveID Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -158,13 +111,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,6 +129,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When present, the transaction log for the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -195,7 +153,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -205,6 +162,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -216,7 +176,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -226,6 +185,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -233,7 +195,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -242,32 +203,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested; for example: `-UserSipAddress "sip:kenmyer@contoso.com"`. +### -TargetFqdn -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCredential + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +User credentials object for the account to be tested. +The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named `$x: $x = Get-Credential "litwareinc\kenmyer"`. +You need to supply the user password when running `Get-Credential`. + +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. + +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UserSipAddress + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for user account to be tested; for example: `-UserSipAddress "sip:kenmyer@contoso.com"`. + +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ua -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -279,13 +270,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None +### None ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Test-CsPersistentChatMessage.md b/skype/skype-ps/SkypeForBusiness/Test-CsPersistentChatMessage.md similarity index 86% rename from skype/skype-ps/skype/Test-CsPersistentChatMessage.md rename to skype/skype-ps/SkypeForBusiness/Test-CsPersistentChatMessage.md index d670ad8f25..7870d59840 100644 --- a/skype/skype-ps/skype/Test-CsPersistentChatMessage.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPersistentChatMessage.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Test-CsPersistentChatMessage -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cspersistentchatmessage +schema: 2.0.0 +title: Test-CsPersistentChatMessage --- # Test-CsPersistentChatMessage @@ -46,7 +47,7 @@ Skype for Business Server Control Panel : The functions carried out by the `Test ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -66,84 +67,10 @@ To carry out this task, the `Test-CsPersistentChatMessage` cmdlet is called, alo ## PARAMETERS -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: - -`$y = Get-Credential "litwareinc\pilar"` - -You need to supply the user password when running this command. - -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name (FQDN) of the Registrar pool to be tested. - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Authentication -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -160,7 +87,6 @@ LiveID Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -170,6 +96,9 @@ Accept wildcard characters: False ``` ### -ChatRoomUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Chat room location, consisting of the fully qualified domain name of the Persistent Chat Server and the name of the chat room. For example: @@ -178,8 +107,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -189,13 +117,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -205,6 +135,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -228,7 +161,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -238,6 +170,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -249,7 +184,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -258,21 +192,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -ReceiverCredential -`-ReceiverSipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. + +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: rc Required: True Position: Named @@ -281,13 +218,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReceiverSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +SIP address for the first of the two user accounts to be tested. +For example: + +`-ReceiverSipAddress "sip:pilar@litwareinc.com"` + +The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -295,6 +244,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -302,7 +254,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -311,21 +262,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. -For example: +### -SenderCredential -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -The SenderSipAddress parameter must reference the same user account as SenderCredential. +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: sc Required: True Position: Named @@ -334,13 +288,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SenderSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +SIP address for the second of the two user accounts to be tested. +For example: + +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` + +The SenderSipAddress parameter must reference the same user account as SenderCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -348,6 +314,9 @@ Accept wildcard characters: False ``` ### -Setup + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables the cmdlet to be run on a watcher node computer that does not have access to the Skype for Business Server topology. To allow for this, first run the `Test-CsPersistentChatMessage` along with the Setup parameter from a computer which does have access to the topology. After that, you will be able to run the cmdlet on your watcher node computers. @@ -358,8 +327,7 @@ If you use the Setup parameter you must also use the TestUser1SipAddress and Tes ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -368,14 +336,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name (FQDN) of the Registrar pool to be tested. + +```yaml +Type: String +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TestUser1SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SIP address of the first test user used in conjunction with the Setup parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -385,13 +373,15 @@ Accept wildcard characters: False ``` ### -TestUser2SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SIP address of the second test user used in conjunction with the Setup parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -405,13 +395,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsPersistentChatMessage` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsPersistentChatMessage` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsPhoneBootstrap.md b/skype/skype-ps/SkypeForBusiness/Test-CsPhoneBootstrap.md similarity index 83% rename from skype/skype-ps/skype/Test-CsPhoneBootstrap.md rename to skype/skype-ps/SkypeForBusiness/Test-CsPhoneBootstrap.md index d6cb06ded2..ca12ac8292 100644 --- a/skype/skype-ps/skype/Test-CsPhoneBootstrap.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPhoneBootstrap.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csphonebootstrap applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsPhoneBootstrap -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csphonebootstrap +schema: 2.0.0 +title: Test-CsPhoneBootstrap --- # Test-CsPhoneBootstrap @@ -38,7 +39,7 @@ This can also be done by using Enterprise DHCP Server and configuring the Skype ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsPhoneBootstrap -PhoneOrExtension "+14255551219" -Pin "0712" ``` @@ -47,7 +48,7 @@ The command shown in Example 1 verifies that the user with the specified phone n In order to run the test, the user's phone number (+14255551219) and the user's PIN (0712) must be supplied. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsPhoneBootstrap -PhoneOrExtension "+14255551219" -Pin "0712" -UserSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -58,48 +59,47 @@ In this example, the UserSipAddress parameter is included as an additional check ## PARAMETERS -### -PhoneOrExt -Telephone number or extension of the user account being tested. -For example: -PhoneOrExt "+14255551219". +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: ph -Applicable: Lync Server 2010, Lync Server 2013 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PIN -PIN of the user account being tested. +### -OutLoggerVariable -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv Required: False Position: Named @@ -108,86 +108,97 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name (FQDN) of the Registrar pool that hosts the user account to be tested. -If not specified, then DHCP discovery will be used to locate the Registrar pool. +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + ```yaml Type: String Parameter Sets: (All) -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetUri -URL of the certificate provisioning service. -If this parameter is not included, then the DHCP discovery will be used to locate the target URI. +### -PhoneOrExt + +> Applicable: Lync Server 2010, Lync Server 2013 + +Telephone number or extension of the user account being tested. +For example: -PhoneOrExt "+14255551219". ```yaml Type: String Parameter Sets: (All) -Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ph -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for the user account used in the text; for example: - -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +### -PhoneOrExtension -The UserSipAddress parameter must reference the supplied phone number and PIN; the test will fail if the included phone number and PIN do not belong to the user specified by the UserSipAddress parameter. -Note that the SIP address must include the "sip:" prefix. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Telephone number or extension of the user account being tested. +For example: -PhoneOrExt "+14255551219". ```yaml Type: String Parameter Sets: (All) -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ph -Required: False +Required: True 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 occur when running the command. +### -PIN + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +PIN of the user account being tested. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: rp Required: False Position: Named @@ -196,49 +207,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -TargetFqdn -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the Registrar pool that hosts the user account to be tested. +If not specified, then DHCP discovery will be used to locate the Registrar pool. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: t Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +### -TargetUri -To save the information stored in the logger variable to an XML file, use a command similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +URL of the certificate provisioning service. +If this parameter is not included, then the DHCP discovery will be used to locate the target URI. ```yaml Type: String Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: twsu Required: False Position: Named @@ -247,17 +245,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PhoneOrExtension -Telephone number or extension of the user account being tested. -For example: -PhoneOrExt "+14255551219". +### -UserSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the user account used in the text; for example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +The UserSipAddress parameter must reference the supplied phone number and PIN; the test will fail if the included phone number and PIN do not belong to the user specified by the UserSipAddress parameter. +Note that the SIP address must include the "sip:" prefix. + ```yaml Type: String Parameter Sets: (All) -Aliases: ph -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ua -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -269,13 +274,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsPhoneBootstrap` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsPhoneBootstrap` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsPresence.md b/skype/skype-ps/SkypeForBusiness/Test-CsPresence.md similarity index 83% rename from skype/skype-ps/skype/Test-CsPresence.md rename to skype/skype-ps/SkypeForBusiness/Test-CsPresence.md index 8a2d1f60ca..8abc25f11a 100644 --- a/skype/skype-ps/skype/Test-CsPresence.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPresence.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cspresence applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsPresence -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cspresence +schema: 2.0.0 +title: Test-CsPresence --- # Test-CsPresence @@ -64,7 +65,7 @@ After the exchange of presence information, the two test users are then logged o ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsPresence -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -78,7 +79,7 @@ If you have not defined test users for a pool, then you must include the Subscri The `Test-CsPresence` cmdlet will then conduct its checks using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -98,75 +99,71 @@ To carry out this task, the `Test-CsPresence` cmdlet is called, along with the f ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PublisherCredential -User credential object for the first of the two user accounts to be tested. -The value passed to PublisherCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -Force -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. - -The publisher credential is not required if you are running the test under the health monitoring configuration settings for the pool. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: pc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PublisherSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -OutLoggerVariable -`-PublisherSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The PublisherSipAddress parameter must reference the same user account as PublisherCredential. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: pa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -175,35 +172,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + + ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: pa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: ovv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscriberCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SubscriberCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: +### -PublisherCredential -`$y = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the first of the two user accounts to be tested. +The value passed to PublisherCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` You need to supply the user password when running this command. -The subscriber credential is not required if you are running the test under the health monitoring configuration settings for the pool. +The publisher credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: pc Required: True Position: Named @@ -212,22 +222,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscriberSipAddress -SIP address for the second of the two user accounts to be tested. +### -PublisherSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. For example: -`-SubscriberSipAddress "sip:pilar@litwareinc.com"` +`-PublisherSipAddress "sip:kenmyer@litwareinc.com"` -The SubscriberSipAddress parameter must reference the same user account as SubscriberCredential. +The PublisherSipAddress parameter must reference the same user account as PublisherCredential. The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. - ```yaml Type: String -Parameter Sets: ServerPlatform, TargetUri -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: pa Required: False Position: Named @@ -236,20 +247,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -RegistrarPort SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -257,7 +258,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -266,74 +266,50 @@ 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. +### -SubscriberCredential -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +User credential object for the second of the two user accounts to be tested. +The value passed to SubscriberCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. + +The subscriber credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: SwitchParameter -Parameter Sets: ServerPlatform, ClientPlatform -Aliases: vb -Applicable: Lync Server 2010 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -SubscriberSipAddress -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +SIP address for the second of the two user accounts to be tested. +For example: -```yaml -Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +`-SubscriberSipAddress "sip:pilar@litwareinc.com"` -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +The SubscriberSipAddress parameter must reference the same user account as SubscriberCredential. -### -Authentication -Type of authentication used in the test. -Allowed values are: +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, TargetUri, ClientPlatform +Aliases: sa Required: False Position: Named @@ -342,43 +318,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +### -TargetFqdn -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -TimeoutInSeconds + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: UInt32 ```yaml Type: UInt32 Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -392,13 +359,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsPresence` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsPresence` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsPstnOutboundCall.md b/skype/skype-ps/SkypeForBusiness/Test-CsPstnOutboundCall.md similarity index 85% rename from skype/skype-ps/skype/Test-CsPstnOutboundCall.md rename to skype/skype-ps/SkypeForBusiness/Test-CsPstnOutboundCall.md index dad3350baa..3a4d6c0851 100644 --- a/skype/skype-ps/skype/Test-CsPstnOutboundCall.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPstnOutboundCall.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cspstnoutboundcall applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsPstnOutboundCall -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cspstnoutboundcall +schema: 2.0.0 +title: Test-CsPstnOutboundCall --- # Test-CsPstnOutboundCall @@ -60,7 +61,7 @@ This call must also be manually ended by the administrator. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsPstnOutboundCall -TargetFqdn atl-cs-001.litwareinc.com -TargetPstnPhoneNumber "+15551234567" ``` @@ -74,7 +75,7 @@ If you have not defined test users for a pool, then you must include the UserSip The `Test-CsPstnOutboundCall` cmdlet will then conduct its checks using the specified user. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -89,7 +90,7 @@ With the credential object in hand, the second command in the example determines To carry out this task, the `Test-CsPstnOutboundCall` cmdlet is called, along with the following parameters: TargetFqdn (the FQDN of the Registrar pool); UserSipAddress (the SIP address for the user making the call); UserCredential (the Windows PowerShell object containing the credentials for the test user); and TargetPstnPhoneNumber (the phone number being called). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsPstnOutboundCall -TargetFqdn atl-cs-001.litwareinc.com -UserSipAddress sip:kenmyer@litwareinc.com -TargetPstnPhoneNumber "+15551234567" ``` @@ -101,101 +102,95 @@ When run like this, Skype for Business Server uses certificates to authenticate ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetPstnPhoneNumber -PSTN telephone number to be called when conducting the test. -The target phone number is best specified using the E.164 format, which means that the number will look something like this "+14255551298", with that number containing a plus sign (+) followed by the country/region calling code (1), the area code (425) and the phone number (5551298). -Do not use dashes, parentheses, or any other characters when specifying the phone number. +### -Force -If you do not use the E.164 format the dial plan of the test user will be appended to the number. -Skype for Business Server will then use that dial plan to normalize the number to the E.164 format. -If the number cannot be normalized then the call cannot be placed and the test will fail. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: rpn -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credentials object for the account to be tested. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -OutLoggerVariable -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. -You also do not need to specify this parameter if the test is being conducted in server platform mode. -In that case, Skype for Business Server will attempt to authenticate the user by using certificates. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: olv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for the user account to be tested. -For example: +### -OutVerboseVariable -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The UserSipAddress parameter must reference the same user account as UserCredential +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: -This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: ovv Required: False Position: Named @@ -204,20 +199,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -RegistrarPort SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -225,7 +210,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -234,103 +218,95 @@ 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 Server 2015, Skype for Business Server 2019 +### -TargetFqdn -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -TargetPstnPhoneNumber -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not prepend a $ character when specifying the variable name. +PSTN telephone number to be called when conducting the test. +The target phone number is best specified using the E.164 format, which means that the number will look something like this "+14255551298", with that number containing a plus sign (+) followed by the country/region calling code (1), the area code (425) and the phone number (5551298). +Do not use dashes, parentheses, or any other characters when specifying the phone number. + +If you do not use the E.164 format the dial plan of the test user will be appended to the number. +Skype for Business Server will then use that dial plan to normalize the number to the E.164 format. +If the number cannot be normalized then the call cannot be placed and the test will fail. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rpn -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -UserCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credentials object for the account to be tested. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. +You also do not need to specify this parameter if the test is being conducted in server platform mode. +In that case, Skype for Business Server will attempt to authenticate the user by using certificates. -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: +### -UserSipAddress -`-OutLoggerVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +SIP address for the user account to be tested. +For example: -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` -To save the information stored in the logger variable to an XML file, use a command similar to this: +The UserSipAddress parameter must reference the same user account as UserCredential -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: sa Required: False Position: Named @@ -344,13 +320,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsPstnOutboundCall` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsPstnOutboundCall` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md b/skype/skype-ps/SkypeForBusiness/Test-CsPstnPeerToPeerCall.md similarity index 83% rename from skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md rename to skype/skype-ps/SkypeForBusiness/Test-CsPstnPeerToPeerCall.md index 58c8bf1766..2ccfd540e4 100644 --- a/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPstnPeerToPeerCall.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cspstnpeertopeercall applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsPstnPeerToPeerCall -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cspstnpeertopeercall +schema: 2.0.0 +title: Test-CsPstnPeerToPeerCall --- # Test-CsPstnPeerToPeerCall @@ -61,7 +62,7 @@ However, the call is answered by the cmdlet itself, and no manual termination of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsPstnPeerToPeerCall -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -75,7 +76,7 @@ If you have not defined test users for a pool, and if you are not running in ser The `Test-CsPstnPeerToPeerCall` cmdlet will then conduct its checks using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -93,7 +94,7 @@ With the two credential objects in hand, the third command in the example determ To carry out this task, the `Test-CsPstnPeerToPeerCall` cmdlet is called, along with the following parameters: TargetFqdn (the FQDN of the Registrar pool); SenderSipAddress (the SIP address for the first test user); SenderCredential (the Windows PowerShell object containing the credentials for this same user); ReceiverSipAddress (the SIP address for the other test user); and ReceiverCredential (the Windows PowerShell object containing the credentials for the other user). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsPstnPeerToPeerCall -TargetFqdn atl-cs-001.litwareinc.com -SenderSipAddress "sip:jhaas@litwareinc.com" -ReceiverSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -105,75 +106,75 @@ When run like this, Skype for Business Server uses certificates to authenticate ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +TrustedServer + +Negotiate + +ClientCertificate + +LiveID -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: +### -Force -`$y = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. - -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool, or if you are running in server platform mode. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -OutLoggerVariable -`-ReceiverSipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -182,28 +183,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutVerboseVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -212,22 +207,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -ReceiverCredential -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\pilar"` You need to supply the user password when running this command. -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool, or if you are running in server platform mode. +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool, or if you are running in server platform mode. ```yaml Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rc Required: True Position: Named @@ -236,22 +233,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. +### -ReceiverSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. For example: -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +`-ReceiverSipAddress "sip:pilar@litwareinc.com"` -The SenderSipAddress parameter must reference the same user account as SenderCredential +The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ra Required: False Position: Named @@ -260,27 +259,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp Required: False Position: Named @@ -289,62 +278,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +### -SenderCredential -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -`-OutVerboseVariable TestOutput` +`$x = Get-Credential "litwareinc\kenmyer"` -Do not prepend a $ character when specifying the variable name. +You need to supply the user password when running this command. +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool, or if you are running in server platform mode. ```yaml -Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -SenderSipAddress -TrustedServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Negotiate +SIP address for the second of the two user accounts to be tested. +For example: -ClientCertificate +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` -LiveID +The SenderSipAddress parameter must reference the same user account as SenderCredential + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: sa Required: False Position: Named @@ -353,30 +330,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +### -TargetFqdn -To save the information stored in the logger variable to an XML file, use a command similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -387,13 +353,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsPstnPeerToPeerCall` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsPstnPeerToPeerCall` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsRegistration.md b/skype/skype-ps/SkypeForBusiness/Test-CsRegistration.md similarity index 84% rename from skype/skype-ps/skype/Test-CsRegistration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsRegistration.md index 6310aa0ec1..75318592bc 100644 --- a/skype/skype-ps/skype/Test-CsRegistration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsRegistration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csregistration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsRegistration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csregistration +schema: 2.0.0 +title: Test-CsRegistration --- # Test-CsRegistration @@ -66,7 +67,7 @@ Adding the Verbose parameter enables you to get a detailed account of all the ac ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsRegistration -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -79,7 +80,7 @@ If test users have not been defined, then the command will fail because it will If you have not defined test users for a pool, then you must include the UserSipAddress parameter and the credentials of the user that the command should use when trying to log on. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -96,44 +97,26 @@ To carry out this task, the `Test-CsRegistration` cmdlet is called, along with t ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used in the test. +Allowed values are: -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +TrustedServer -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Negotiate + +ClientCertificate + +LiveID -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: Int32 +Type: AuthenticationMechanism Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Ath Required: False Position: Named @@ -142,44 +125,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credentials object for the account to be tested. -The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named - -`$x: $x = Get-Credential "litwareinc\kenmyer"` +### -Force -You need to supply the user password when running this command. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested; for example: +### -OutLoggerVariable -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -188,27 +174,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutVerboseVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not use prepend a $ character when specifying the variable name. -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -217,14 +198,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: rp Required: False Position: Named @@ -233,75 +217,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -TargetFqdn -Do not use prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -UserCredential -TrustedServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Negotiate +User credentials object for the account to be tested. +The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named -ClientCertificate +`$x: $x = Get-Credential "litwareinc\kenmyer"` -LiveID +You need to supply the user password when running this command. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` +### -UserSipAddress -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +SIP address for user account to be tested; for example: -To save the information stored in the logger variable to an XML file, use a command similar to this: +`-UserSipAddress "sip:kenmyer@litwareinc.com"` -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ua Required: False Position: Named @@ -315,13 +289,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsRegistration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsRegistration` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsReplica.md b/skype/skype-ps/SkypeForBusiness/Test-CsReplica.md similarity index 89% rename from skype/skype-ps/skype/Test-CsReplica.md rename to skype/skype-ps/SkypeForBusiness/Test-CsReplica.md index fa960e4ed6..d941d04ebb 100644 --- a/skype/skype-ps/skype/Test-CsReplica.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsReplica.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csreplica applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsReplica -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csreplica +schema: 2.0.0 +title: Test-CsReplica --- # Test-CsReplica @@ -37,7 +38,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsReplica -Verbose ``` @@ -46,7 +47,7 @@ The command shown in Example 1 tests the Skype for Business Server replica servi In this example the Verbose parameter is used to ensure that information about the test - including the eventual failure or success of the test as well as the location of the report generated by the test - is displayed on screen. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsReplica -Verbose -Report C:\Logs\ReplicaTest.html ``` @@ -61,6 +62,9 @@ C:\Users\Administrator.Litwareinc\AppData\Local\Temp\1\Test-Cs-Replica-3db40ee0- ## PARAMETERS ### -GlobalCatalog + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of a global catalog server in your domain. This parameter is not required if you are running the `Test-CsReplica` cmdlet on a computer with an account in your domain. @@ -68,8 +72,7 @@ This parameter is not required if you are running the `Test-CsReplica` cmdlet on ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of a domain controller in your domain. This parameter is not required if you are running the `Test-CsReplica` cmdlet on a computer with an account in your domain. @@ -86,8 +92,7 @@ This parameter is not required if you are running the `Test-CsReplica` cmdlet on ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -105,8 +113,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,13 +127,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsReplica` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsReplica` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsSetupPermission.md b/skype/skype-ps/SkypeForBusiness/Test-CsSetupPermission.md similarity index 81% rename from skype/skype-ps/skype/Test-CsSetupPermission.md rename to skype/skype-ps/SkypeForBusiness/Test-CsSetupPermission.md index d3a68325b5..d90cd98d02 100644 --- a/skype/skype-ps/skype/Test-CsSetupPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsSetupPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cssetuppermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsSetupPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cssetuppermission +schema: 2.0.0 +title: Test-CsSetupPermission --- # Test-CsSetupPermission @@ -37,7 +38,7 @@ If the cmdlet returns False, you will need to run the `Grant-CsSetupPermission` ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsSetupPermission -ComputerOU "ou=CsServers,dc=litwareinc,dc=com" ``` @@ -48,6 +49,9 @@ The command shown in Example 1 checks to see if the required setup permissions h ## PARAMETERS ### -ComputerOU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name of the organizational unit (OU) that contains the accounts for the computers running Skype for Business Server. For example: "ou=CsServers,dc=litwareinc,dc=com". @@ -55,8 +59,7 @@ For example: "ou=CsServers,dc=litwareinc,dc=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 +Aliases: Required: True Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the domain where the OU to be checked is located. If this parameter is not included, then the `Test-CsSetupPermission` cmdlet will look for the OU in the current domain. @@ -73,8 +79,7 @@ If this parameter is not included, then the `Test-CsSetupPermission` cmdlet will ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a domain controller in your domain. This parameter is not required if you are running the `Test-CsSetupPermission` cmdlet on a computer with an account in your domain. @@ -91,8 +99,7 @@ This parameter is not required if you are running the `Test-CsSetupPermission` c ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a global catalog server in your domain. This parameter is not required if you are running the `Test-CsSetupPermission` cmdlet on a computer with an account in your domain. @@ -109,8 +119,7 @@ This parameter is not required if you are running the `Test-CsSetupPermission` c ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,29 +129,15 @@ Accept wildcard characters: False ``` ### -Report -Reports detailed activity to the screen as the cmdlet runs. - -```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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Verbose Reports detailed activity to the screen as the cmdlet runs. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -156,13 +151,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsSetupPermission` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsSetupPermission` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Test-CsTopology.md similarity index 82% rename from skype/skype-ps/skype/Test-CsTopology.md rename to skype/skype-ps/SkypeForBusiness/Test-CsTopology.md index 09df3bc984..482966bd76 100644 --- a/skype/skype-ps/skype/Test-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsTopology.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsTopology -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cstopology +schema: 2.0.0 +title: Test-CsTopology --- # Test-CsTopology @@ -36,7 +37,7 @@ For example, this command checks the state of the A/V Conferencing Server on the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsTopology ``` @@ -44,7 +45,7 @@ Test-CsTopology Example 1 validates the entire Skype for Business Server topology. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsTopology -Report "C:\Logs\Topology.xml" ``` @@ -53,7 +54,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1. In this case, however, the Report parameter is included to specify the location (C:\Logs\Topology.xml) where the output file should be written. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsTopology -Service "Registrar:atl-cs-001.litwareinc.com" ``` @@ -64,6 +65,9 @@ In Example 3, the `Test-CsTopology` cmdlet is used to validate a single service: ## PARAMETERS ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the `Test-CsTopology` cmdlet on a computer with an account in your domain. @@ -71,8 +75,7 @@ This parameter is not required if you are running the `Test-CsTopology` cmdlet o ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -90,8 +96,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,20 +105,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Service -When present, the `Test-CsTopology` cmdlet limits its validation checks to the specified service. -(Note that you can only specify one service at a time when using the Service parameter.) Services should be specified using the appropriate service ID; for example, this syntax refers to the Registrar service on the atl-cs-001.litwareinc.com pool: - -`-Service "Registrar:atl-cs-001.litwareinc.com"` +### -Report -If this parameter is not included then the entire topology will be validated. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\Topology.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,31 +124,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\Topology.html"` +### -Service -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When present, the `Test-CsTopology` cmdlet limits its validation checks to the specified service. +(Note that you can only specify one service at a time when using the Service parameter.) Services should be specified using the appropriate service ID; for example, this syntax refers to the Registrar service on the atl-cs-001.litwareinc.com pool: + +`-Service "Registrar:atl-cs-001.litwareinc.com"` + +If this parameter is not included then the entire topology will be validated. -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -160,13 +153,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsTopology` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsTopology` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsTrunkConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Test-CsTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsTrunkConfiguration.md index 7cbb042b1c..357a9802a3 100644 --- a/skype/skype-ps/skype/Test-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cstrunkconfiguration +schema: 2.0.0 +title: Test-CsTrunkConfiguration --- # Test-CsTrunkConfiguration @@ -32,7 +33,7 @@ These settings configure such things as whether media bypass is enabled on this ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $tc = Get-CsTrunkConfiguration -Identity Site:Redmond @@ -48,55 +49,61 @@ In line 2 we call the `Test-CsTrunkConfiguration` cmdlet, passing the phone numb ## PARAMETERS -### -DialedNumber -The phone number against which to test the configuration. +### -CallingNumber + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, returns the matched outbound translation rules for the specified phone number. +For example: + +`-CallingNumber "tel:+14255551219"` ```yaml Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TrunkConfiguration -A reference to a trunk configuration object against which to run the test. -Trunk configuration objects can be retrieved by calling the `Get-CsTrunkConfiguration` cmdlet. +### -DialedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The phone number against which to test the configuration. ```yaml -Type: TrunkConfiguration +Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -CallingNumber -When specified, returns the matched outbound translation rules for the specified phone number. -For example: +### -TrunkConfiguration -`-CallingNumber "tel:+14255551219"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a trunk configuration object against which to run the test. +Trunk configuration objects can be retrieved by calling the `Get-CsTrunkConfiguration` cmdlet. ```yaml -Type: PhoneNumber +Type: TrunkConfiguration Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -105,13 +112,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration + Accepts pipelined input of a trunk configuration object. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.TrunkConfigurationTestResult Returns a value of type Microsoft.Rtc.Management.Voice.TrunkConfigurationTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsUcwaConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsUcwaConference.md similarity index 83% rename from skype/skype-ps/skype/Test-CsUcwaConference.md rename to skype/skype-ps/SkypeForBusiness/Test-CsUcwaConference.md index c94960225f..047357211d 100644 --- a/skype/skype-ps/skype/Test-CsUcwaConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsUcwaConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csucwaconference applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsUcwaConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csucwaconference +schema: 2.0.0 +title: Test-CsUcwaConference --- # Test-CsUcwaConference @@ -57,7 +58,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsUcwaConference -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -66,7 +67,7 @@ The command shown in Example 1 verifies that a pair of test users can participat Note that this command will fail if you have not predefined a pair of health monitoring configuration test users for atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -86,84 +87,10 @@ To carry out this task, the `Test-CsUcwaConference` cmdlet is called, along with ## PARAMETERS -### -OrganizerCredential -User credential object for user account acting as the meeting organizer. -The value passed to OrganizerCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -The organizer credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: pc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParticipantCredential -User credential object for the user account acting as the meeting participant. -The value passed to ParticipantCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: - -`$y = Get-Credential "litwareinc\pilar"` - -You need to supply the user password when running this command. - -The participant credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, 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 -``` +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -180,7 +107,6 @@ LiveID Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -190,13 +116,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,18 +133,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrganizerSipAddress -SIP address for the meeting organizer. -For example: `-OrganizerSipAddress "sip:pilar@litwareinc.com"`. -The OrganizerSIPAddress parameter must reference the same user account as OrganizerCredential. +### -OrganizerCredential -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for user account acting as the meeting organizer. +The value passed to OrganizerCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +The organizer credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: pa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: pc Required: True Position: Named @@ -225,13 +159,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OrganizerSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the meeting organizer. +For example: `-OrganizerSipAddress "sip:pilar@litwareinc.com"`. +The OrganizerSIPAddress parameter must reference the same user account as OrganizerCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: pa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -239,6 +182,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -260,7 +206,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -270,6 +215,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -281,7 +229,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -290,19 +237,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ParticipantSipAddress -SIP address for the meeting participant. -For example: `-ParticipantSipAddress "sip:kenmyer@litwareinc.com"`. -The ParticipantSipAddress parameter must reference the same user account as ParticipantCredential. +### -ParticipantCredential -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +User credential object for the user account acting as the meeting participant. +The value passed to ParticipantCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. + +The participant credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: sc Required: True Position: Named @@ -311,13 +263,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParticipantSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the meeting participant. +For example: `-ParticipantSipAddress "sip:kenmyer@litwareinc.com"`. +The ParticipantSipAddress parameter must reference the same user account as ParticipantCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform, TargetUri +Parameter Sets: ClientPlatform, ServerPlatform, TargetUri Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -325,6 +286,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -332,7 +296,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ClientPlatform, ServerPlatform Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -341,18 +304,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. + +```yaml +Type: String +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None. +### None The `Test-CsUcwaConference` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.WebTaskOutput The `Test-CsUcwaConference` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.WebTaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsUnifiedContactStore.md b/skype/skype-ps/SkypeForBusiness/Test-CsUnifiedContactStore.md similarity index 83% rename from skype/skype-ps/skype/Test-CsUnifiedContactStore.md rename to skype/skype-ps/SkypeForBusiness/Test-CsUnifiedContactStore.md index e4e5ffea71..e40d4669e4 100644 --- a/skype/skype-ps/skype/Test-CsUnifiedContactStore.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsUnifiedContactStore.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csunifiedcontactstore applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsUnifiedContactStore -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csunifiedcontactstore +schema: 2.0.0 +title: Test-CsUnifiedContactStore --- # Test-CsUnifiedContactStore @@ -53,7 +54,7 @@ Lync Server Control Panel: The functions carried out by the `Test-csUnifiedConta ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -69,61 +70,10 @@ The second command in the example uses the supplied credentials object ($x) and ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, 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 -``` - -### -UserCredential -User credentials object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets +### -Authentication -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -136,7 +86,6 @@ Allowed values are: Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -146,13 +95,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +113,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -183,7 +137,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -193,6 +146,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -204,7 +160,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -214,6 +169,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -221,7 +179,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -230,19 +187,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address of the user to be used in the test. -For example: +### -Setup -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. +{{Fill Setup Description}} ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -251,43 +205,84 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SetupAndRun + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill SetupAndRun Description}} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. + + ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Setup -{{Fill Setup Description}} +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credentials object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SetupAndRun -{{Fill SetupAndRun Description}} +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the user to be used in the test. +For example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ua Required: False Position: Named @@ -301,13 +296,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsUnifiedContactStore` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.WebTaskOutput The `Test-CsUnifiedContactStore` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.WebTaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceNormalizationRule.md similarity index 90% rename from skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Test-CsVoiceNormalizationRule.md index 7506be3ac9..cc06a35392 100644 --- a/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceNormalizationRule.md @@ -1,12 +1,14 @@ --- -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 -title: Test-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: jenstrier +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csvoicenormalizationrule +schema: 2.0.0 +title: Test-CsVoiceNormalizationRule --- # Test-CsVoiceNormalizationRule @@ -34,7 +36,7 @@ Use this cmdlet to troubleshoot dialing issues or to verify that rules will work ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceNormalizationRule -Identity "global/11 digit number rule" | Test-CsVoiceNormalizationRule -DialedNumber 14255559999 ``` @@ -46,7 +48,7 @@ The output will be the DialedNumber after the voice normalization rule "global/1 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 -------------------------- +### Example 2 ``` $a = Get-CsVoiceNormalizationRule -Identity "global/11 digit number rule" Test-CsVoiceNormalizationRule -DialedNumber 5551212 -NormalizationRule $a @@ -57,7 +59,7 @@ object is first stored in the variable $a and then is passed as the value to the test will run. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceNormalizationRule | Test-CsVoiceNormalizationRule -DialedNumber 2065559999 ``` @@ -69,7 +71,7 @@ number 2065559999. The output will be a list of translated numbers, one for each 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 -------------------------- +### Example 4 ```powershell $nr=(Get-CsTenantDialPlan -Identity dp1).NormalizationRules $nr[0] @@ -97,6 +99,9 @@ dialed number 1234. The output shows that the rule normalize the dialed number t ## PARAMETERS ### -DialedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + 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 @@ -105,8 +110,7 @@ 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 +Aliases: Required: True Position: Named @@ -116,6 +120,9 @@ Accept wildcard characters: False ``` ### -NormalizationRule + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + 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. @@ -124,8 +131,7 @@ For Microsoft Teams, you can retrieve voice normalization rules by calling the ` ```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 +Aliases: Required: True Position: Named @@ -139,13 +145,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule + Accepts pipelined input of voice normalization rule objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.NormalizationRuleTestResult Returns an object of type Microsoft.Rtc.Management.Voice.NormalizationRuleTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoicePolicy.md similarity index 86% rename from skype/skype-ps/skype/Test-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Test-CsVoicePolicy.md index 9e26043f76..5c542a3d7d 100644 --- a/skype/skype-ps/skype/Test-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoicePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsVoicePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csvoicepolicy +schema: 2.0.0 +title: Test-CsVoicePolicy --- # Test-CsVoicePolicy @@ -32,7 +33,7 @@ Call the `Test-CsVoicePolicy` cmdlet to determine which (if any) route will be u ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoicePolicy -Identity site:Redmond | Test-CsVoicePolicy -TargetNumber "+14255559999" ``` @@ -44,7 +45,7 @@ The output will be the first voice route (based on the Priority property of the If no matching route is found (for example, if the number pattern matches the pattern for an 11-digit number and you supply a 7-digit number) a null value will be returned. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsVoicePolicy -Identity site:Redmond @@ -54,7 +55,7 @@ Test-CsVoicePolicy -TargetNumber "+14255559999" -VoicePolicy $a Example 2 is identical to Example 1 except that instead of piping the results of the Get operation directly to the `Test-CsVoicePolicy` cmdlet, the object is first stored in the variable $a and then is passed as the value to the parameter VoicePolicy to be used as the policy against which the test will run. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoicePolicy | Test-CsVoicePolicy -TargetNumber "+12065559999" ``` @@ -67,74 +68,82 @@ The output will be a list of matching routes along with the phone usages that we ## PARAMETERS -### -TargetNumber -The phone number against which to run the test. -This number should be in E.164 format (such as +14255551212). +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. ```yaml -Type: PhoneNumber +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VoicePolicy -A reference to the voice policy object against which to run the test. -Voice policy objects can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. +### -RouteSettings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Route settings against which to run the test. +The route settings can be retrieved with a call to the `Get-CsRoutingConfiguration` cmdlet. ```yaml -Type: VoicePolicy +Type: PstnRoutingSettings Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -RouteSettings -Route settings against which to run the test. -The route settings can be retrieved with a call to the `Get-CsRoutingConfiguration` cmdlet. +### -TargetNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The phone number against which to run the test. +This number should be in E.164 format (such as +14255551212). ```yaml -Type: PstnRoutingSettings +Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -VoicePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to the voice policy object against which to run the test. +Voice policy objects can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. ```yaml -Type: SwitchParameter +Type: VoicePolicy Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -143,13 +152,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy + Accepts pipelined input of voice policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.VoicePolicyTestResult Returns an object of type Microsoft.Rtc.Management.Voice.VoicePolicyTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceRoute.md similarity index 89% rename from skype/skype-ps/skype/Test-CsVoiceRoute.md rename to skype/skype-ps/SkypeForBusiness/Test-CsVoiceRoute.md index 4291233efd..b73dcadd34 100644 --- a/skype/skype-ps/skype/Test-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsVoiceRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csvoiceroute +schema: 2.0.0 +title: Test-CsVoiceRoute --- # Test-CsVoiceRoute @@ -32,7 +33,7 @@ You can use this cmdlet to troubleshoot routing issues or to simply try out phon ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $vr = Get-CsVoiceRoute -Identity testroute @@ -46,7 +47,7 @@ We also include the number we want to test in the TargetNumber parameter. The output is a Boolean value stating whether the target number matches the pattern for that route. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceRoute -Identity testroute | Test-CsVoiceRoute -TargetNumber "+14255551212" ``` @@ -58,7 +59,7 @@ We pipe that voice route to the `Test-CsVoiceRoute` cmdlet and test the route ag Note that we do not need to supply the Route parameter because the route was piped in to the cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoute | Test-CsVoiceRoute -TargetNumber "+14255551212" ``` @@ -67,7 +68,7 @@ This example retrieves a collection of all the voice routes defined within a Sky The output will be a True or False value for each route tested. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $z = Get-CsVoiceRoute @@ -89,7 +90,29 @@ The final output will be a (not very nicely formatted) list of voice route ident ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Route + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object containing a reference to the voice route against which you want to test the number specified in the TargetNumber parameter. You can retrieve a voice route object by calling the `Get-CsVoiceRoute` cmdlet. @@ -98,8 +121,7 @@ Full Data Type: Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route ```yaml Type: Route Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -109,6 +131,9 @@ Accept wildcard characters: False ``` ### -TargetNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number against which you want to test the voice route specified in the Route parameter. This number should be in E.164 format (such as +14255551212). @@ -117,8 +142,7 @@ 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 +Aliases: Required: True Position: Named @@ -127,35 +151,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. - - -```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 -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.WritableConfig.Policy.Voice.Route object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route + Accepts pipelined input of a voice route object. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.VoiceRouteTestResult Returns an object of type Microsoft.Rtc.Management.Voice.VoiceRouteTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceTestConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsVoiceTestConfiguration.md index ff6c869062..3e1ef0a3f0 100644 --- a/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceTestConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsVoiceTestConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csvoicetestconfiguration +schema: 2.0.0 +title: Test-CsVoiceTestConfiguration --- # Test-CsVoiceTestConfiguration @@ -44,7 +45,7 @@ If instead you enter a value for the TestCaseInputObject parameter, you can also ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceTestConfiguration -Identity TestConfig1 | Test-CsVoiceTestConfiguration ``` @@ -54,7 +55,7 @@ First the `Get-CsVoiceTestConfiguration` cmdlet is run to retrieve the configura That configuration object is then piped to the `Test-CsVoiceTestConfiguration` cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsVoiceTestConfiguration -Identity TestConfig1 @@ -64,7 +65,7 @@ Test-CsVoiceTestConfiguration -TestCaseInputObject $a 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 TestCaseInputObject to be used as the test configuration. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $dp = Get-CsDialPlan -Identity Global @@ -90,6 +91,9 @@ If you want to test the results against expectations you must define those expec ## PARAMETERS ### -DialedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number to run the test against. Based on the dial plan, route, and policy, this number will be normalized and displayed as output. @@ -100,8 +104,7 @@ You cannot supply a DialedNumber and a TestCaseInputObject. ```yaml Type: PhoneNumber Parameter Sets: AdhocTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -Dialplan + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to a dial plan object of the dial plan to use when running the test. Dial plan objects can be retrieved by calling the `Get-CsDialPlan` cmdlet. @@ -120,9 +126,8 @@ If you do, the object in this parameter must match the dial plan specified in th ```yaml Type: LocationProfile -Parameter Sets: AdhocTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: AdhocTest, StoredTest +Aliases: Required: True Position: Named @@ -131,11 +136,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + ```yaml -Type: LocationProfile -Parameter Sets: StoredTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteSettings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to an object containing all the voice routes available on the Skype for Business Server installation. +You can retrieve this object by calling the `Get-CsRoutingConfiguration` cmdlet. + +You can use this parameter with either the DialedNumber parameter or with the TestCaseInputObject parameter. + + +```yaml +Type: PstnRoutingSettings +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -145,6 +177,9 @@ Accept wildcard characters: False ``` ### -TestCaseInputObject + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object containing a reference to the voice configuration to test. This object reference can be retrieved by calling the `Get-CsVoiceTestConfiguration` cmdlet. @@ -154,8 +189,7 @@ You should also not specify a Dialplan or VoicePolicy, as those would be redunda ```yaml Type: TestConfiguration Parameter Sets: StoredTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -165,6 +199,9 @@ Accept wildcard characters: False ``` ### -VoicePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to a voice policy object of the voice policy to use when running the test. Voice policy objects can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. @@ -174,9 +211,8 @@ If you do, the object in this parameter must match the voice policy specified in ```yaml Type: VoicePolicy -Parameter Sets: AdhocTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: AdhocTest, StoredTest +Aliases: Required: True Position: Named @@ -185,67 +221,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: VoicePolicy -Parameter Sets: StoredTest -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 -``` - -### -RouteSettings -A reference to an object containing all the voice routes available on the Skype for Business Server installation. -You can retrieve this object by calling the `Get-CsRoutingConfiguration` cmdlet. - -You can use this parameter with either the DialedNumber parameter or with the TestCaseInputObject parameter. - - -```yaml -Type: PstnRoutingSettings -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 -``` - -### -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 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.WritableConfig.Policy.Voice.TestConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration + Accepts pipelined input of a voice test configuration object. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.OcsVoiceTestResult This cmdlet returns an object of type Microsoft.Rtc.Management.Voice.OcsVoiceTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsVoiceUser.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceUser.md similarity index 90% rename from skype/skype-ps/skype/Test-CsVoiceUser.md rename to skype/skype-ps/SkypeForBusiness/Test-CsVoiceUser.md index d31c01af75..0cd1760067 100644 --- a/skype/skype-ps/skype/Test-CsVoiceUser.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoiceuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsVoiceUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csvoiceuser +schema: 2.0.0 +title: Test-CsVoiceUser --- # Test-CsVoiceUser @@ -32,7 +33,7 @@ This cmdlet can be used to determine whether a specific phone number will route ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsVoiceUser -DialedNumber "+14255559999" -SipUri "sip:kmyer@litwareinc.com" -Verbose ``` @@ -44,7 +45,7 @@ Notice that we've also included the Verbose parameter. Verbose is a common Windows PowerShell parameter that will display additional information as the test is being conducted, such as which dial plan and voice policy are being loaded for the test. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser | ForEach-Object {$_.DisplayName; Test-CsVoiceUser -DialedNumber "+14255559999" -SipUri $_.SipAddress} | Format-List ``` @@ -65,6 +66,9 @@ Finally, because the output by default is in table format and can get cut off to ## PARAMETERS ### -DialedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number to test. Full data type: Microsoft.Rtc.Management.Voice.PhoneNumber @@ -72,8 +76,7 @@ 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 +Aliases: Required: True Position: Named @@ -82,40 +85,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipUri -The SIP URI of the user against which the test is taking place. -This is the Identity of the user as used in the CsUser cmdlets. -You can specify a user's identity 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). -Note that the SamAccountName cannot be used as an identity. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. ```yaml -Type: UserIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -SipUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP URI of the user against which the test is taking place. +This is the Identity of the user as used in the CsUser cmdlets. +You can specify a user's identity 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). +Note that the SamAccountName cannot be used as an identity. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -124,12 +131,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.OcsVoiceUserTestResult Returns an object of type Microsoft.Rtc.Management.Voice.OcsVoiceUserTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsWatcherNodeConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsWatcherNodeConfiguration.md index ab6e773b6e..c7d17ead77 100644 --- a/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWatcherNodeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsWatcherNodeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cswatchernodeconfiguration +schema: 2.0.0 +title: Test-CsWatcherNodeConfiguration --- # Test-CsWatcherNodeConfiguration @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsWatcherNodeConfiguration ``` @@ -50,6 +51,9 @@ The command shown in Example 1 verifies the configuration settings for each watc ## PARAMETERS ### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -58,8 +62,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -ReadCredentialsFromCurrentUserStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, instructs the `Test-CsWatcherNodeConfiguration` cmdlet to retrieve the user credentials from the user's credentials store. By default, the `Test-CsWatcherNodeConfiguration` cmdlet looks for credentials in the network service account's credentials store. @@ -76,8 +82,7 @@ By default, the `Test-CsWatcherNodeConfiguration` cmdlet looks for credentials i ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +96,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsWatcherNodeConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsWatcherNodeConfiguration` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsWebApp.md b/skype/skype-ps/SkypeForBusiness/Test-CsWebApp.md similarity index 83% rename from skype/skype-ps/skype/Test-CsWebApp.md rename to skype/skype-ps/SkypeForBusiness/Test-CsWebApp.md index fc6945a42c..03ab6a66fa 100644 --- a/skype/skype-ps/skype/Test-CsWebApp.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWebApp.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cswebapp applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsWebApp -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cswebapp +schema: 2.0.0 +title: Test-CsWebApp --- # Test-CsWebApp @@ -57,7 +58,7 @@ If you decide to conduct the test using actual user accounts you will need to su ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsWebApp -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -66,7 +67,7 @@ Example 1 verifies whether or not a pair of test users configured for the pool a This command will only succeed if you have configured test users for the pool by using the `CsHealthMonitoringConfiguration` cmdlets. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -83,7 +84,38 @@ In addition to the user credential parameters, the UserSipAddress and User2SipAd ## PARAMETERS +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used when running the test. +Allowed values are: + +TrustedServer + +Negotiate + +ClientCertificate + +LiveID + + +```yaml +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -External + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, causes the `Test-CsWebApp` cmdlet to test the Reach server's external web relay. If this parameter is not present, the cmdlet will test the internal web relay. The web relay serves as an intermediary between the internal network and the Internet. @@ -92,8 +124,7 @@ The web relay serves as an intermediary between the internal network and the Int ```yaml Type: SwitchParameter Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,14 +134,49 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not prepend a $ character when specifying the variable name. + +To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -120,6 +186,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -132,7 +201,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -142,6 +210,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -150,7 +221,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -160,17 +230,18 @@ Accept wildcard characters: False ``` ### -TargetFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the pool to be tested. For example: `-TargetFqdn atl-cs-001.litwareinc.com` - ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -179,20 +250,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -TargetUri -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -TargetUri Uniform Resource Identifier (URI) of the Reach server. For example: @@ -200,12 +261,10 @@ For example: You cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. - ```yaml Type: String Parameter Sets: TargetUri Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -215,6 +274,9 @@ Accept wildcard characters: False ``` ### -User2Credential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the second of the two user accounts to be tested. The value passed to User2Credential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $y: @@ -228,7 +290,6 @@ You need to supply the user password when running this command. Type: PSCredential Parameter Sets: ClientPlatform Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -238,6 +299,9 @@ Accept wildcard characters: False ``` ### -User2SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the second of the two user accounts to be tested. For example: @@ -250,7 +314,6 @@ This parameter is not required if you are running the test by using test users c Type: String Parameter Sets: ClientPlatform Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -260,6 +323,9 @@ Accept wildcard characters: False ``` ### -UserCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credentials object for the first of the two user accounts to be tested. The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $x: @@ -273,7 +339,6 @@ You need to supply the user password when running this command. Type: PSCredential Parameter Sets: ClientPlatform Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -283,6 +348,9 @@ Accept wildcard characters: False ``` ### -UserSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the first of the two user accounts to be tested. For example: @@ -290,12 +358,10 @@ For example: This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. - ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -304,20 +370,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WebCredential -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WebCredential User credential object for the user account to be used in the test. The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: @@ -330,65 +386,7 @@ This parameter is required if either the TargetUri parameter or the UserSipAddre ```yaml Type: PSCredential Parameter Sets: TargetUri -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 -``` - -### -Authentication -Type of authentication used when running the test. -Allowed values are: - -TrustedServer - -Negotiate - -ClientCertificate - -LiveID - - -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -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 -``` - -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not prepend a $ character when specifying the variable name. - -To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` - -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -402,14 +400,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS ### System.Object -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The Test-CsWebApp cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsWebAppAnonymous.md b/skype/skype-ps/SkypeForBusiness/Test-CsWebAppAnonymous.md similarity index 83% rename from skype/skype-ps/skype/Test-CsWebAppAnonymous.md rename to skype/skype-ps/SkypeForBusiness/Test-CsWebAppAnonymous.md index 56fef6875f..d1bd8271f0 100644 --- a/skype/skype-ps/skype/Test-CsWebAppAnonymous.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWebAppAnonymous.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cswebappanonymous applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsWebAppAnonymous -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cswebappanonymous +schema: 2.0.0 +title: Test-CsWebAppAnonymous --- # Test-CsWebAppAnonymous @@ -56,7 +57,7 @@ If you decide to conduct the test using an actual user account you will need to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsWebAppAnonymous -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -65,7 +66,7 @@ The command shown in Example 1 verifies whether or not a test user configured fo This command will only succeed if you have configured a test user for the pool by using the `CsHealthMonitoringConfiguration` cmdlets. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -80,7 +81,34 @@ In addition to the UserCredential parameter, the UserSipAddress parameter is als ## PARAMETERS +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used when running the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID + +```yaml +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -External + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, causes the `Test-CsWebAppAnonymous` cmdlet to test the Reach server's external web relay. If this parameter is not present, the cmdlet will test the internal web relay. The web relay serves as an intermediary between the internal network and the Internet. @@ -89,8 +117,7 @@ The web relay serves as an intermediary between the internal network and the Int ```yaml Type: SwitchParameter Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,14 +127,49 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not prepend a $ character when specifying the variable name. + +To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -117,6 +179,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -129,7 +194,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -139,6 +203,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -147,7 +214,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -157,17 +223,18 @@ Accept wildcard characters: False ``` ### -TargetFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the pool to be tested. For example: `-TargetFqdn atl-cs-001.litwareinc.com` - ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -176,20 +243,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -TargetUri -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -TargetUri Uniform Resource Identifier (URI) of the Reach server. For example: @@ -202,7 +259,6 @@ You cannot use both the TargetUri parameter and the TargetFqdn parameter in the Type: String Parameter Sets: TargetUri Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -212,6 +268,9 @@ Accept wildcard characters: False ``` ### -UserCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credentials object for the first of the two user accounts to be tested. The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $x: @@ -227,7 +286,6 @@ This parameter is not required if you are running the test by using test users c Type: PSCredential Parameter Sets: ClientPlatform Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -237,6 +295,9 @@ Accept wildcard characters: False ``` ### -UserSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the first of the two user accounts to be tested. For example: @@ -244,12 +305,10 @@ For example: This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. - ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -258,20 +317,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WebCredential -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WebCredential User credential object for the user account to be used in the test. The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: @@ -284,61 +333,7 @@ This parameter is required if either the TargetUri parameter or the UserSipAddre ```yaml Type: PSCredential Parameter Sets: TargetUri -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 -``` - -### -Authentication -Type of authentication used when running the test. -Allowed values are: - -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID - -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -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 -``` - -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not prepend a $ character when specifying the variable name. - -To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` - -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -352,14 +347,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS ### System.Object -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsWebAppAnonymous` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsWebScheduler.md b/skype/skype-ps/SkypeForBusiness/Test-CsWebScheduler.md similarity index 84% rename from skype/skype-ps/skype/Test-CsWebScheduler.md rename to skype/skype-ps/SkypeForBusiness/Test-CsWebScheduler.md index 8339aaae79..08d0274390 100644 --- a/skype/skype-ps/skype/Test-CsWebScheduler.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWebScheduler.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cswebscheduler applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsWebScheduler -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cswebscheduler +schema: 2.0.0 +title: Test-CsWebScheduler --- # Test-CsWebScheduler @@ -63,7 +64,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsWebScheduler -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -76,7 +77,7 @@ If test users have not been defined, then the command will fail because it will If you have not defined test users for a pool, then you must include the UserSipAddress parameter and the credentials of the user that the command should use when trying to log on. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -93,75 +94,10 @@ To carry out this task, the `Test-CsWebScheduler` cmdlet is called, along with t ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, 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 -``` - -### -TargetUri -Uniform Resource Identifier (URI) of the Web scheduler.Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. - -```yaml -Type: String -Parameter Sets: TargetUri -Aliases: twsu -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserCredential -User credential object for the account to be tested. -The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Allowed values are: * TrustedServer @@ -173,7 +109,6 @@ Allowed values are: Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -183,13 +118,15 @@ Accept wildcard characters: False ``` ### -External + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to verify that external users can use the web scheduler/ ```yaml Type: SwitchParameter Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,13 +136,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,6 +154,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -236,7 +178,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -246,6 +187,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -257,7 +201,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -267,6 +210,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -274,7 +220,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -283,34 +228,84 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested; for example: +### -TargetFqdn -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Uniform Resource Identifier (URI) of the Web scheduler.Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. + +```yaml +Type: String +Parameter Sets: TargetUri +Aliases: twsu + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the account to be tested. +The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. + +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for user account to be tested; for example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ClientPlatform, TargetUri +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -318,6 +313,9 @@ Accept wildcard characters: False ``` ### -WebCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the user account to be used in the test. The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: @@ -329,8 +327,7 @@ This parameter is required if the TargetUri parameter or the UserSipAddress para ```yaml Type: PSCredential Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -344,13 +341,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsWebScheduler` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.WebTaskOutput The `Test-CsWebScheduler` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.WebTaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsXmppIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsXmppIM.md similarity index 84% rename from skype/skype-ps/skype/Test-CsXmppIM.md rename to skype/skype-ps/SkypeForBusiness/Test-CsXmppIM.md index 2f3d174cf0..0b364a590b 100644 --- a/skype/skype-ps/skype/Test-CsXmppIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsXmppIM.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Test-CsXmppIM -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csxmppim +schema: 2.0.0 +title: Test-CsXmppIM --- # Test-CsXmppIM @@ -45,7 +46,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsXmppIM -TargetFqdn "atl-cs-001.litwareinc.com" -Receiver "adelany@contoso.com" ``` @@ -58,7 +59,7 @@ If test users have not been defined, then the command will fail because it will If you have not defined test users for a pool, then you must include the UserSipAddress parameter and the credentials of the user that the command should use when trying to log on. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -75,74 +76,10 @@ To carry out this task, the `Test-CsXmppIm` cmdlet is called, along with four pa ## PARAMETERS -### -Receiver -SIP address of the user who the test message is addressed to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name of the pool being tested. - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, 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 -``` - -### -UserCredential -User credential object for the user account to be tested. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named `$x:$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. +### -Authentication -This parameter is not required if you are conducting the test using the health monitoring configuration settings. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication User credential object for the account to be tested. The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named @@ -156,7 +93,6 @@ This parameter is not required if you are conducting the test under the health m Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -166,13 +102,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +120,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -203,7 +144,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -213,6 +153,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -224,7 +167,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -233,7 +175,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Receiver + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the user who the test message is addressed to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061 @@ -241,7 +204,6 @@ This parameter is not required if the Registrar uses the default port 5061 Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -250,34 +212,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested; for example: +### -TargetFqdn -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +Fully qualified domain name of the pool being tested. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the user account to be tested. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named `$x:$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +This parameter is not required if you are conducting the test using the health monitoring configuration settings. + +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for user account to be tested; for example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -289,13 +282,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsXmppIM` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsXmppIM` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Uninstall-CsDatabase.md b/skype/skype-ps/SkypeForBusiness/Uninstall-CsDatabase.md similarity index 82% rename from skype/skype-ps/skype/Uninstall-CsDatabase.md rename to skype/skype-ps/SkypeForBusiness/Uninstall-CsDatabase.md index 5963d866fb..1f52d8c098 100644 --- a/skype/skype-ps/skype/Uninstall-CsDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Uninstall-CsDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/uninstall-csdatabase applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Uninstall-CsDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/uninstall-csdatabase +schema: 2.0.0 +title: Uninstall-CsDatabase --- # Uninstall-CsDatabase @@ -42,7 +43,7 @@ Regardless of the reason, the `Uninstall-CsDatabase` cmdlet provides a way for y ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Uninstall-CsDatabase -CentralManagementDatabase -SqlServerFqdn atl-sql-001.litwareinc.com ``` @@ -50,7 +51,7 @@ Uninstall-CsDatabase -CentralManagementDatabase -SqlServerFqdn atl-sql-001.litwa The command shown in Example 1 deletes the Central Management store from the computer atl-sql-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Uninstall-CsDatabase -DatabaseType User -SqlServerFqdn atl-sql-001.litwareinc.com ``` @@ -61,32 +62,17 @@ When you use the DatabaseType parameter, all stores related to the specified dat ## PARAMETERS -### -SqlServerFqdn -Fully qualified domain name (FQDN) of the computer or SQL Server cluster where the database is located. -For example: `-SqlServer atl-sql-001.litwareinc.com`. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CentralManagementDatabase -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CentralManagementDatabase If present, uninstalls the Central Management store. You cannot use both CentralManagementDatabase and DatabaseType in the same command. ```yaml Type: SwitchParameter Parameter Sets: ByCMS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -96,6 +82,9 @@ Accept wildcard characters: False ``` ### -DatabaseType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Database to be deleted. Valid values are: @@ -131,8 +120,7 @@ To delete the Central Management store, use the CentralManagementDatabase parame ```yaml Type: DatabaseNameType Parameter Sets: ByDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -142,6 +130,9 @@ Accept wildcard characters: False ``` ### -Detach + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If present, detaches the specified database. When a database is detached, all the file locks imposed by SQL Server are removed. This enables you to directly access the database files in order to do such things as copy those files to another computer. @@ -149,8 +140,7 @@ This enables you to directly access the database files in order to do such thing ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,15 +149,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -Name of the database instance containing the database to be removed. -A database instance is a set of running processes that provides access to database files. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, forces removal of the database even if that database is currently in use. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,14 +167,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If present, forces removal of the database even if that database is currently in use. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\UninstallDatabase.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -192,15 +186,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\UninstallDatabase.html"` +### -SqlInstanceName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the database instance containing the database to be removed. +A database instance is a set of running processes that provides access to database files. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,16 +205,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SqlServerFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the computer or SQL Server cluster where the database is located. +For example: `-SqlServer atl-sql-001.litwareinc.com`. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -226,13 +225,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 @@ -246,13 +265,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Uninstall-CsDatabase cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Uninstall-CsDatabase` cmdlet does not return any values or objects. ## NOTES diff --git a/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md b/skype/skype-ps/SkypeForBusiness/Uninstall-CsMirrorDatabase.md similarity index 89% rename from skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md rename to skype/skype-ps/SkypeForBusiness/Uninstall-CsMirrorDatabase.md index 882ce126eb..0059fb2a29 100644 --- a/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Uninstall-CsMirrorDatabase.md @@ -1,13 +1,14 @@ --- -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, Skype for Business Server 2019 -title: Uninstall-CsMirrorDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/uninstall-csmirrordatabase +schema: 2.0.0 +title: Uninstall-CsMirrorDatabase --- # Uninstall-CsMirrorDatabase @@ -37,7 +38,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Unins ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Uninstall-CsMirrorDatabase -SqlServerFqdn "atl-mirror-001.litwareinc.com" -SqlInstanceName "RTC" -DatabaseType "User" -DropExistingDatabasesOnMirror ``` @@ -49,6 +50,9 @@ Because the DropExistingDatabaseOnMirror parameter was included, the command wil ## PARAMETERS ### -DatabaseType + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Type of mirror database to be installed. Allowed values are: @@ -82,8 +86,7 @@ User ```yaml Type: DatabaseNameType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -92,36 +95,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name (FQDN) of the computer containing the database is to be uninstalled. -For example: - -`-SqlServerFqdn atl-sql-001.litwareinc.com` +### -DropExistingDatabasesOnMirror -This should be the FQDN of the primary SQL Server computer. +> Applicable: Lync Server 2013, Skype for Business Server 2015 +When present, deletes any existing copies of the mirrored databases from the mirror server. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\UnInstallDatabaseMirror.html"` + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -130,14 +135,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DropExistingDatabasesOnMirror -When present, deletes any existing copies of the mirrored databases from the mirror server. +### -SqlInstanceName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Name of the database instance where the database is to be installed. +A database instance is simply a set of running processes that provides access to database files. +If this parameter is omitted, the `Uninstall-CsMirrorDatabase` cmdlet will use the default SQL Server instance. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -146,37 +156,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. +### -SqlServerFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name (FQDN) of the computer containing the database is to be uninstalled. For example: -`-Report "C:\Logs\UnInstallDatabaseMirror.html"` +`-SqlServerFqdn atl-sql-001.litwareinc.com` + +This should be the FQDN of the primary SQL Server computer. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -Name of the database instance where the database is to be installed. -A database instance is simply a set of running processes that provides access to database files. -If this parameter is omitted, the `Uninstall-CsMirrorDatabase` cmdlet will use the default SQL Server instance. +### -Confirm +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + 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 2013, Skype for Business Server 2015 Required: False Position: Named @@ -206,14 +221,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Uninstall-CsMirrorDatabase` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Unlock-CsClientPin.md b/skype/skype-ps/SkypeForBusiness/Unlock-CsClientPin.md similarity index 89% rename from skype/skype-ps/skype/Unlock-CsClientPin.md rename to skype/skype-ps/SkypeForBusiness/Unlock-CsClientPin.md index 9e0e115c1e..b0847356b3 100644 --- a/skype/skype-ps/skype/Unlock-CsClientPin.md +++ b/skype/skype-ps/SkypeForBusiness/Unlock-CsClientPin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/unlock-csclientpin applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Unlock-CsClientPin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/unlock-csclientpin +schema: 2.0.0 +title: Unlock-CsClientPin --- # Unlock-CsClientPin @@ -41,7 +42,7 @@ That means that you will not be able to run the `Unlock-CsClientPin` cmdlet from ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Unlock-CsClientPin -Identity "litwareinc\kenmyer" ``` @@ -49,7 +50,7 @@ Unlock-CsClientPin -Identity "litwareinc\kenmyer" In Example 1, the `Unlock-CsClientPin` cmdlet is used to unlock the PIN belonging to the user litwareinc\kenmyer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser | Get-CsClientPinInfo | Where-Object {$_.IsLockedOut -eq $True} | Unlock-CsClientPin ``` @@ -63,7 +64,28 @@ The resulting filtered collection is then piped to the `Unlock-CsClientPin` cmdl ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the user account for which the PIN should be unlocked. 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. @@ -74,8 +96,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -84,14 +105,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -101,29 +124,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -137,14 +146,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The `Unlock-CsClientPin` cmdlet accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### None The `Unlock-CsClientPin` cmdlet does not return a value or object. Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Management.UserPinService.PinInfoDetails object. diff --git a/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Unpublish-CsLisConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Unpublish-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Unpublish-CsLisConfiguration.md index 6b754867cf..9e4680c181 100644 --- a/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Unpublish-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/unpublish-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Unpublish-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/unpublish-cslisconfiguration +schema: 2.0.0 +title: Unpublish-CsLisConfiguration --- # Unpublish-CsLisConfiguration @@ -33,7 +34,7 @@ The `Unpublish-CsLisConfiguration` cmdlet removes the LIS configuration from the ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Unpublish-CsLisConfiguration ``` @@ -44,13 +45,15 @@ This command removes the LIS configuration from the Central Management store. ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 +Aliases: Required: False Position: Named @@ -59,14 +62,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before 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 +Aliases: cf Required: False Position: Named @@ -75,14 +80,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually 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 +Aliases: wi Required: False Position: Named @@ -96,12 +103,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Unregister-CsHybridPSTNAppliance.md similarity index 89% rename from skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md rename to skype/skype-ps/SkypeForBusiness/Unregister-CsHybridPSTNAppliance.md index 458d44b4aa..8d94a41739 100644 --- a/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Unregister-CsHybridPSTNAppliance.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance applicable: Skype for Business Online -title: Unregister-CsHybridPSTNAppliance -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/unregister-cshybridpstnappliance +schema: 2.0.0 +title: Unregister-CsHybridPSTNAppliance --- # Unregister-CsHybridPSTNAppliance @@ -36,7 +38,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Insert example commands for example 1. ``` @@ -47,30 +49,36 @@ Insert descriptive text for example 1. ## PARAMETERS -### -Identity -Specifies the identity of the Skype for Business Cloud Connector Edition appliance. +### -BypassDualWrite + +> Applicable: Skype for Business Online + +PARAMVALUE: $true | $false ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassDualWrite -PARAMVALUE: $true | $false +### -Force + +> Applicable: Skype for Business Online + +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: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -79,32 +87,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the Skype for Business Cloud Connector Edition appliance. ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: 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 + +> Applicable: Skype for Business Online + +PARAMVALUE: PSObject ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -113,14 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: PSObject +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -129,14 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -146,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Update-CsAddressBook.md b/skype/skype-ps/SkypeForBusiness/Update-CsAddressBook.md similarity index 88% rename from skype/skype-ps/skype/Update-CsAddressBook.md rename to skype/skype-ps/SkypeForBusiness/Update-CsAddressBook.md index 3db49c7148..19cea44381 100644 --- a/skype/skype-ps/skype/Update-CsAddressBook.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsAddressBook.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-csaddressbook applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Update-CsAddressBook -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-csaddressbook +schema: 2.0.0 +title: Update-CsAddressBook --- # Update-CsAddressBook @@ -36,7 +37,7 @@ If you can't wait for synchronization to take place or if it appears that, for s ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Update-CsAddressBook ``` @@ -45,7 +46,7 @@ In Example 1, the `Update-CsAddressBook` cmdlet is called without any parameters This synchronizes all the Address Book servers in the organization. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Update-CsAddressBook -Fqdn atl-abs-001.litwareinc.com ``` @@ -55,37 +56,41 @@ In Example 2, only a single Address Book server is synchronized: the server with ## PARAMETERS -### -Fqdn -Enables you to specify an individual Address Book to be updated. -If this parameter is not included then all of your Address Book servers will be synchronized with the User database. -Individual Address Book servers should be referenced by their fully qualified domain name (FQDN); for example, atl-abs-001.litwareinc.com. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + + ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -Fqdn +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to specify an individual Address Book to be updated. +If this parameter is not included then all of your Address Book servers will be synchronized with the User database. +Individual Address Book servers should be referenced by their fully qualified domain name (FQDN); for example, atl-abs-001.litwareinc.com. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -96,14 +101,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Update-CsAddressBook cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the Update-CsAddressBook cmdlet updates existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Update-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Update-CsAdminRole.md similarity index 86% rename from skype/skype-ps/skype/Update-CsAdminRole.md rename to skype/skype-ps/SkypeForBusiness/Update-CsAdminRole.md index 6b1a812753..32dc824859 100644 --- a/skype/skype-ps/skype/Update-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsAdminRole.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Update-CsAdminRole -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-csadminrole +schema: 2.0.0 +title: Update-CsAdminRole --- # Update-CsAdminRole @@ -32,7 +33,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Updat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Update-CsAdminRole ``` @@ -42,14 +43,16 @@ The command shown in Example 1 updates the RBAC definitions stored in the Centra ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -58,14 +61,16 @@ 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. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -75,13 +80,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -95,14 +102,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Update-CsAdminRole cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None The Update-CsAdminRole cmdlet does not return any data or objects. ## NOTES diff --git a/skype/skype-ps/skype/Update-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Update-CsClsLogging.md similarity index 90% rename from skype/skype-ps/skype/Update-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Update-CsClsLogging.md index 1478045d95..fb89e5bc2c 100644 --- a/skype/skype-ps/skype/Update-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Update-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-csclslogging +schema: 2.0.0 +title: Update-CsClsLogging --- # Update-CsClsLogging @@ -43,7 +44,7 @@ In addition, administrators can also use the `Update-CsClsLogging` cmdlet to cha ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Update-CsClsLogging -Duration 60 ``` @@ -52,7 +53,7 @@ The command shown in Example 1 modifies the logging duration time for servers in In this example, the duration time is set to 1 hour (60 minutes). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Update-CsClsLogging -Duration 60 -Pools "atl-cs-001.litwareinc.com" ``` @@ -62,45 +63,16 @@ In Example 2, the duration time is modified for all the servers in the pool atl- ## PARAMETERS -### -Duration -Amount of time that the logging operation should run. -For example, this syntax causes the logging operation to run for 2 hours (120 minutes) and then stop: - -`-Duration 120` - -This following syntax would specify a duration of 3 hours and 14 minutes: - -`-Duration 3:15` - -The following syntax would specify a duration of 6 days, 5 hours and 12 minutes: - -`-Duration 6.5:12` - -The default value is 30 minutes. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AsXml -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AsXml When specified, information is returned using XML. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +82,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to updates the centralized logging service on a specified server or set of servers. To update a single server, specify the fully qualified domain name of that server. For example: @@ -125,8 +100,7 @@ If you do not the Computers parameter or the Pools parameter, `Update-CsClsLoggi ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,7 +109,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Duration + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Amount of time that the logging operation should run. +For example, this syntax causes the logging operation to run for 2 hours (120 minutes) and then stop: + +`-Duration 120` + +This following syntax would specify a duration of 3 hours and 14 minutes: + +`-Duration 3:15` + +The following syntax would specify a duration of 6 days, 5 hours and 12 minutes: + +`-Duration 6.5:12` + +The default value is 30 minutes. + + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to update the centralized logging service on each server in a pool. To update the servers in a pool, specify the fully qualified domain name of that pool. For example: @@ -149,8 +159,7 @@ Multiple pools can be specified by separating the pool FQDNs using commas: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,14 +173,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Update-CsClsLogging cmdlet does not accept pipelined input. ## OUTPUTS -### -String value. +### System.Stringvalue. ## NOTES diff --git a/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md b/skype/skype-ps/SkypeForBusiness/Update-CsTenantMeetingUrl.md similarity index 95% rename from skype/skype-ps/skype/Update-CsTenantMeetingUrl.md rename to skype/skype-ps/SkypeForBusiness/Update-CsTenantMeetingUrl.md index 03dc67a577..7fd0cf7615 100644 --- a/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsTenantMeetingUrl.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-cstenantmeetingurl applicable: Skype for Business Online -title: Update-CsTenantMeetingUrl -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-cstenantmeetingurl +schema: 2.0.0 +title: Update-CsTenantMeetingUrl --- # Update-CsTenantMeetingUrl @@ -70,7 +72,7 @@ Meeting URL configuration will be updated! ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Update-CsTenantMeetingUrl -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" ``` @@ -79,7 +81,7 @@ The command shown in Example 1 updates the meeting URL for the tenant with the t (Note that you must supply the tenant ID in order for this command to complete.) After pressing ENTER to run the command, you will be asked if you are sure you want to update the meeting URL. You must answer yes to this prompt before `Update-CsTenantMeetingUrl` will actually make any changes to your Skype for Business Online configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Update-CsTenantMeetingUrl -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -Force ``` @@ -90,33 +92,16 @@ In this case, as soon as you press ENTER the command will run and your Skype for ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -Note that the default behavior of the `Update-CsMeetingUrl` is to display the confirmation prompt before making any updates. -That means that, if you want to display the confirmation prompt, you do not need to include the Confirm parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Force Suppresses the display of the confirmation prompt which would otherwise appear before `Update-CsMeetingUrl` makes any updates. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -126,6 +111,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the tenant account whose federation settings are being returned. For example: @@ -140,8 +128,28 @@ If you do not include the Tenant parameter then `Update-CsMeetingUrl` will promp ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before executing the command. + +Note that the default behavior of the `Update-CsMeetingUrl` is to display the confirmation prompt before making any updates. +That means that, if you want to display the confirmation prompt, you do not need to include the Confirm parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -151,13 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + 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 @@ -171,14 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None `Update-CsMeetingUrl` does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Update-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Update-CsUserData.md similarity index 82% rename from skype/skype-ps/skype/Update-CsUserData.md rename to skype/skype-ps/SkypeForBusiness/Update-CsUserData.md index 1002d5a2b2..5bed3d1baa 100644 --- a/skype/skype-ps/skype/Update-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsUserData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Update-CsUserData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-csuserdata +schema: 2.0.0 +title: Update-CsUserData --- # Update-CsUserData @@ -35,7 +36,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Updat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip" ``` @@ -43,7 +44,7 @@ Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip" The command shown in Example 1 updates Skype for Business Server user data based on information stored in the file C:\Logs\ExportedUserData.zip. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip" -UserFilter "kenmyer@litwareinc.com" ``` @@ -54,33 +55,19 @@ This is done by including the UserFilter parameter followed by the user's SIP ad ## PARAMETERS -### -FileName -Full path to the .ZIP file or .XML file containing the user data to be updated. -For example: +### -DomainController -`-FileName "C:\Data\Lync2010.zip"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables administrators to specify the FQDN of the domain controller to be used when running the `Update-CsUserData` cmdlet. +If not specified, the cmdlet will use the first available domain controller. -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Confirm -Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -89,33 +76,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables administrators to specify the FQDN of the domain controller to be used when running the `Update-CsUserData` cmdlet. -If not specified, the cmdlet will use the first available domain controller. +### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Full path to the .ZIP file or .XML file containing the user data to be updated. +For example: +`-FileName "C:\Data\Lync2010.zip"` ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,14 +116,16 @@ Accept wildcard characters: False ``` ### -RoutingGroupFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to update data only for the specified routing groups. Routing groups are used to indicate the Front End server that users register with. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,18 +134,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserFilter -Enables you to update data for a single user. -That user specified by using his or her SIP address, minus the sip: prefix. -For example: +### -TargetPoolFqdn -`-UserFilter "kenmyer@litwareinc.com"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Registrar pool containing the user accounts to be updated. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,14 +152,16 @@ 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. +### -TestMode + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When included in a command, `Update-CsUserData` will verify that the data can be updated, but will not actually update that data. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,14 +170,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetPoolFqdn -Registrar pool containing the user accounts to be updated. +### -ThreadCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Number of threads that can be devoted to the update task. ```yaml -Type: Fqdn +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,14 +188,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TestMode -When included in a command, `Update-CsUserData` will verify that the data can be updated, but will not actually update that data. +### -UserFileFilter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to a text file containing a list of user URIs for whom data should be exported. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,14 +206,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ThreadCount -Number of threads that can be devoted to the update task. +### -UserFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to update data for a single user. +That user specified by using his or her SIP address, minus the sip: prefix. +For example: + +`-UserFilter "kenmyer@litwareinc.com"` ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,14 +228,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserFileFilter -Full path to a text file containing a list of user URIs for whom data should be exported. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 Required: False Position: Named @@ -246,13 +269,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Update-CsUserData cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.User.UserData The Update-CsUserData cmdlet updates Skype for Business Server 2015 user information. ## NOTES diff --git a/skype/skype-ps/skype/Update-CsUserDatabase.md b/skype/skype-ps/SkypeForBusiness/Update-CsUserDatabase.md similarity index 88% rename from skype/skype-ps/skype/Update-CsUserDatabase.md rename to skype/skype-ps/SkypeForBusiness/Update-CsUserDatabase.md index e4b3514b60..8f823e0a8a 100644 --- a/skype/skype-ps/skype/Update-CsUserDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsUserDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-csuserdatabase applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Update-CsUserDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-csuserdatabase +schema: 2.0.0 +title: Update-CsUserDatabase --- # Update-CsUserDatabase @@ -37,14 +38,14 @@ You might also need to run this cmdlet if a product update ever includes a chang ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Update-CsUserDatabase ``` The command shown in Example 1 locates the user database for the pool where the local computer is located, then forces that database to connect to and return complete user information from Active Directory. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Update-CsUserDatabase -Fqdn atl-cs-001.litwareinc.com ``` @@ -55,34 +56,38 @@ In this case, that's the user database for the pool atl-cs-001.litwareinc.com. ## PARAMETERS -### -Fqdn -Fully qualified domain name (FQDN) of the computer hosting the user database. -If this parameter is not specified then the `Update-CsUserDatabase` cmdlet will update the user database for the pool that the local computer belongs to. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +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. +### -Fqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the computer hosting the user database. +If this parameter is not specified then the `Update-CsUserDatabase` cmdlet will update the user database for the pool that the local computer belongs to. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -93,14 +98,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Update-CsUserDatabase cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Update-CsUserDatabase` cmdlet updates instances of the Microsoft.Rtc.Management.Xds.DisplayUserDatabase object. ## NOTES diff --git a/spmt/spmt-ps/spmt/Add-SPMTTask.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Add-SPMTTask.md similarity index 64% rename from spmt/spmt-ps/spmt/Add-SPMTTask.md rename to spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Add-SPMTTask.md index eb66f4701b..d84248126f 100644 --- a/spmt/spmt-ps/spmt/Add-SPMTTask.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Add-SPMTTask.md @@ -1,7 +1,7 @@ --- -external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml +external help file: microsoft.sharepoint.migrationtool.powershell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/add-spmttask +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/add-spmttask applicable: SharePoint Migration Tool title: Add-SPMTTask schema: 2.0.0 @@ -13,98 +13,118 @@ ms.reviewer: # Add-SPMTTask ## SYNOPSIS -Add a new migration task to the registered migration session. Currently there are three different types of tasks allowed: File Share task, SharePoint task and JSON defined task. + +Add a new migration task to the registered migration session. ## SYNTAX -### FileShare -```powershell -Add-SPMTTask -FileShareSource -TargetSiteUrl -TargetList [-TargetListRelativePath ] +### FileShare (Default) + +``` +Add-SPMTTask -FileShareSource -TargetSiteUrl -TargetList + [-TargetListRelativePath ] [-MigrationType ] [] ``` ### SharePointMigrateAll -```powershell -Add-SPMTTask -SharePointSourceCredential -SharePointSourceSiteUrl -TargetSiteUrl -MigrateAll + +``` +Add-SPMTTask [-MigrateAll] -SharePointSourceSiteUrl + -SharePointSourceCredential -TargetSiteUrl [-MigrationType ] + [] ``` ### SharePointMigrateSelected -```powershell - Add-SPMTTask -SharePointSourceSiteUrl -SharePointSourceCredential -SourceList [-SourceListRelativePath ] -TargetSiteUrl -TargetList [-TargetListRelativePath ] + +``` +Add-SPMTTask -SharePointSourceSiteUrl -SharePointSourceCredential + [-SourceListRelativePath ] -SourceList -TargetSiteUrl + -TargetList [-TargetListRelativePath ] [-MigrationType ] + [] ``` ### Json -```powershell -Add-SPMTTask [-SharePointSourceCredential ] -JsonDefinition [] + +``` +Add-SPMTTask [-SharePointSourceCredential ] -JsonDefinition + [-MigrationType ] [] ``` +## DESCRIPTION + +Add a new migration task to the registered migration session. Currently there are three different +types of tasks allowed: File Share task, SharePoint task and JSON defined task. + ## EXAMPLES ### EXAMPLE 1 -```powershell -#Define SharePoint 2013 data source# -$Global:SourceSiteUrl = "https://YourOnPremSite/" -$Global:OnPremUserName = "Yourcomputer\administrator" -$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force -$Global:SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:OnPremUserName, $Global:OnPremPassword -$Global:SourceListName = "SourceListName" +This example adds one File Share migration task and one SharePoint 2013 migration task to the +registered migration session. +```powershell +#Define SharePoint 2013 data source# +$SourceSiteUrl = "https://YourOnPremSite/" +$OnPremUserName = "Yourcomputer\administrator" +$OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force +$SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $OnPremUserName, $OnPremPassword +$SourceListName = "SourceListName" #Define SPO target# -$Global:SPOUrl = "https://contoso.sharepoint.com" -$Global:UserName = "admin@contoso.onmicrosoft.com" -$Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force -$Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord -$Global:TargetListName = "TargetListName" +$SPOUrl = "https://contoso.sharepoint.com" +$UserName = "admin@contoso.onmicrosoft.com" +$PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force +$SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $UserName, $PassWord +$TargetListName = "TargetListName" #Define File Share data source# -$Global:FileshareSource = "YourFileShareDataSource" +$FileshareSource = "YourFileShareDataSource" #Import SPMT Migration Module# Import-Module Microsoft.SharePoint.MigrationTool.PowerShell #Register the SPMT session with SPO credentials# -Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force +Register-SPMTMigration -SPOCredential $SPOCredential -Force -#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.# -Add-SPMTTask -SharePointSourceCredential $Global:SPCredential -SharePointSourceSiteUrl $Global:SourceSiteUrl -TargetSiteUrl $Global:SPOUrl -MigrateAll -Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList $Global:TargetListName +# Add two tasks into the session. One is SharePoint migration task, and another is +# File Share migration task.# +Add-SPMTTask -SharePointSourceCredential $SPCredential -SharePointSourceSiteUrl $SourceSiteUrl -TargetSiteUrl $SPOUrl -MigrateAll +Add-SPMTTask -FileShareSource $FileshareSource -TargetSiteUrl $SPOUrl -TargetList $TargetListName ``` -This example adds one File Share migration task and one SharePoint 2013 migration task to the registered migration session. ### EXAMPLE 2 -```powershell +This example adds a new migration task to the registered migration session. Currently there are +three different types of tasks allowed: File Share task, SharePoint task and JSON defined task. +```powershell # Code snippets for bulk migration by loading the sample CSV with the name of spmt.csv - $csvItems = import-csv "C:\spmt.csv" -Header c1,c2,c3,c4,c5,c6 - ForEach ($item in $csvItems) - { - Write-Host $item.c1 - Add-SPMTTask -FileShareSource $item.c1 -TargetSiteUrl $item.c4 -TargetList $item.c5 -TargetListRelativePath $item.c6 - } +$csvItems = import-csv "C:\spmt.csv" -Header c1,c2,c3,c4,c5,c6 +ForEach ($item in $csvItems) { + Write-Host $item.c1 + Add-SPMTTask -FileShareSource $item.c1 -TargetSiteUrl $item.c4 -TargetList $item.c5 -TargetListRelativePath $item.c6 +} +``` +```CSV # Two migration tasks are defined in the file spmt.csv - D:\MigrationTest\Files\Average_1M\c,,,https://SPOSite.sharepoint.com,Documents,Test C:\work\Powershell\negative,,,https://SPOSite.sharepoint.com/,Documents,DocLibrary_SubfolderName +``` +```powershell # Code snippets for bulk migration by loading one JSON file: +$jsonItems = Get-Content -Raw -Path "C:\spmt.json" | ConvertFrom-Json +ForEach ($taskItem in $jsonItems.Tasks) { + $jsonString = ConvertTo-Json $taskItem -Depth 100 + Add-SPMTTask -JsonDefinition $jsonString -SharePointSourceCredential $onpremCredential +} +``` - - $jsonItems = Get-Content -Raw -Path "C:\spmt.json" | ConvertFrom-Json - ForEach ($taskItem in $jsonItems.Tasks) - { - $jsonString = ConvertTo-Json $taskItem -Depth 100 - Add-SPMTTask -JsonDefinition $jsonString -SharePointSourceCredential $onpremCredential - } - -# Three migration tasks are defined in the file spmt.json. - - +```json +// Three migration tasks are defined in the file spmt.json. { "Tasks":[ { @@ -155,11 +175,12 @@ C:\work\Powershell\negative,,,https://SPOSite.sharepoint.com/,Documents,DocLibra ] } ``` -This example adds a new migration task to the registered migration session. -Currently there are three different types of tasks allowed: File Share task, SharePoint task and JSON defined task. ### EXAMPLE 3 -``` + +This is a Json sample for File Share migration. + +```json { "SourcePath":"\\LocalOrFileShareDataSource", "TargetPath":"https://YourTargetSite", @@ -167,7 +188,7 @@ Currently there are three different types of tasks allowed: File Share task, Sha "TargetListRelativePath":"subfolder" } -Json sample for SharePoint migration(lists only): +// Json sample for SharePoint migration(lists only): { "SourcePath":"https://YourOnPremSite", "TargetPath":"https://YourTargetSite", @@ -181,7 +202,7 @@ Json sample for SharePoint migration(lists only): } } -Json sample for SharePoint migration(lists and subsites): +// Json sample for SharePoint migration(lists and subsites): { "SourcePath":"https://YourOnPremSite", "TargetPath":"https://YourTargetSite", @@ -211,12 +232,13 @@ Json sample for SharePoint migration(lists and subsites): } } -Json sample for SharePoint migration(whole site): +// Json sample for SharePoint migration(whole site): { "SourcePath":"https://YourOnPremSite/subsite2", "TargetPath":"https://YourTargetSite/targetSubSite2" } -Json sample with task level setting: + +// Json sample with task level setting: { "Tasks": [ { @@ -255,17 +277,18 @@ Json sample with task level setting: ] } -Note: Datetime format is "yyyy-MM-dd" +// Note: Datetime format is "yyyy-MM-dd" ``` -This is a Json sample for File Share migration. ## PARAMETERS ### -FileShareSource -This parameter is mandatory for File Share migration. Please specify the source folder path. For example: C:\SourceFiles. + +This parameter is mandatory for File Share migration. Please specify the source folder path. For +example: C:\SourceFiles. ```yaml -Type: String +Type: System.String Parameter Sets: FileShare Aliases: @@ -277,10 +300,11 @@ Accept wildcard characters: False ``` ### -JsonDefinition + Define one File share task or SharePoint task in JSON format. ```yaml -Type: String +Type: System.String Parameter Sets: Json Aliases: @@ -292,12 +316,12 @@ Accept wildcard characters: False ``` ### -MigrateAll -This is a switch parameter. -If set to True, all lists will be migrated. -If set to False, the customer will migrate selected lists. + +This is a switch parameter. If set to True, all lists will be migrated. If set to False, the +customer will migrate selected lists. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: SharePointMigrateAll Aliases: @@ -308,11 +332,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MigrationType + +{{ Fill MigrationType Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SharePointSourceCredential + Use this parameter to define SharePoint 2013 sign-in credentials. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: SharePointMigrateAll, SharePointMigrateSelected, Json Aliases: @@ -324,10 +365,11 @@ Accept wildcard characters: False ``` ### -SharePointSourceSiteUrl + Use this parameter to define SharePoint data source site URL. ```yaml -Type: String +Type: System.String Parameter Sets: SharePointMigrateAll, SharePointMigrateSelected Aliases: @@ -339,10 +381,11 @@ Accept wildcard characters: False ``` ### -SourceList + This parameter is mandatory and is to define source document library name or list name. ```yaml -Type: String +Type: System.String Parameter Sets: SharePointMigrateSelected Aliases: @@ -354,10 +397,11 @@ Accept wildcard characters: False ``` ### -SourceListRelativePath + This parameter is optional and is to define data source relative path. ```yaml -Type: String +Type: System.String Parameter Sets: SharePointMigrateSelected Aliases: @@ -369,10 +413,11 @@ Accept wildcard characters: False ``` ### -TargetList + This parameter is mandatory and is to define target library name or list name. ```yaml -Type: String +Type: System.String Parameter Sets: FileShare, SharePointMigrateSelected Aliases: @@ -384,10 +429,11 @@ Accept wildcard characters: False ``` ### -TargetListRelativePath + This parameter is optional and is to define target relative path. ```yaml -Type: String +Type: System.String Parameter Sets: FileShare, SharePointMigrateSelected Aliases: @@ -399,10 +445,12 @@ Accept wildcard characters: False ``` ### -TargetSiteUrl -This parameter is mandatory for both File Share and SharePoint migration and is to define the target site URL. + +This parameter is mandatory for both File Share and SharePoint migration and is to define the target +site URL. ```yaml -Type: String +Type: System.String Parameter Sets: FileShare, SharePointMigrateAll, SharePointMigrateSelected Aliases: @@ -414,7 +462,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). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Get-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Get-SPMTMigration.md new file mode 100644 index 0000000000..8fb2389351 --- /dev/null +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Get-SPMTMigration.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml +Module Name: Microsoft.SharePoint.MigrationTool.PowerShell +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/get-spmtmigration +applicable: SharePoint Migration Tool +title: Get-SPMTMigration +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Get-SPMTMigration + +## SYNOPSIS +Get the registered SPMT Migration. + +## SYNTAX + +```powershell +Get-SPMTMigration [] +``` + +## DESCRIPTION + +Return object of current session. It includes current tasks status and current session level +settings. + +The status of current tasks includes: + +1. Count of scanned files +2. Count of migrated files +3. Migration error message if there is any + +## EXAMPLES + +### EXAMPLE 1 + +This example starts a migration first, and then run "Get-SPMTMigration" to get the object of current +migration. + +```powershell +#Define SharePoint 2013 data source# +$SourceSiteUrl = "https://YourOnPremSite/" +$OnPremUserName = "Yourcomputer\administrator" +$OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force +$SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $OnPremUserName, $OnPremPassword +$SourceListName = "SourceListName" + +#Define SPO target# +$SPOUrl = "https://contoso.sharepoint.com" +$UserName = "admin@contoso.onmicrosoft.com" +$PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force +$SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $UserName, $PassWord +$TargetListName = "TargetListName" + +#Define Fileshare data source# +$FileshareSource = "YourFileShareDataSource" + +#Import SPMT Migration Module# +Import-Module Microsoft.SharePoint.MigrationTool.PowerShell + +#Register the SPMT session with SPO credentials# +Register-SPMTMigration -SPOCredential $SPOCredential -Force + +#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.# +Add-SPMTTask -SharePointSourceCredential $SPCredential -SharePointSourceSiteUrl $SourceSiteUrl -TargetSiteUrl $SPOUrl -MigrateAll +Add-SPMTTask -FileShareSource $FileshareSource -TargetSiteUrl $SPOUrl -TargetList $TargetListName + +#Start migration in the background# +Start-SPMTMigration -NoShow + +#Get the object of current migration# +$session = Get-SPMTMigration +``` + +## 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 diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Microsoft.SharePoint.MigrationTool.PowerShell.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Microsoft.SharePoint.MigrationTool.PowerShell.md new file mode 100644 index 0000000000..d57001d6a4 --- /dev/null +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Microsoft.SharePoint.MigrationTool.PowerShell.md @@ -0,0 +1,57 @@ +--- +Module Name: Microsoft.SharePoint.MigrationTool.PowerShell +Module Guid: 2dc42197-33c3-4a1a-b957-92ac375c77a4 +Download Help Link: +Help Version: +Locale: en-US +--- + +# Microsoft.SharePoint.MigrationTool.PowerShell Module + +## Description + +The following migration cmdlets are based on the SharePoint Migration Tool (SPMT) migration engine. +It will move files from File Share, SharePoint 2013 document libraries, or items of SharePoint 2013 +lists to Office 365. + +[Install SPMT and Get PowerShell module](https://spmtreleasescus.blob.core.windows.net/install/default.htm) + +> [!NOTE] +> PowerShell 5.0 and .NET Framework 4.6.2 or higher are required to support the migration of file +> paths of up to 400 characters. After installing SPMT, the PowerShell dlls are copied to +> `%userprofile%\Documents\WindowsPowerShell\Modules`. + +## Microsoft.SharePoint.MigrationTool.PowerShell Cmdlets + +### [Add-SPMTTask](Add-SPMTTask.md) + +Add a new migration task to the registered migration session. + +### [Get-SPMTMigration](Get-SPMTMigration.md) + +Get the registered SPMT Migration. + +### [Register-SPMTMigration](Register-SPMTMigration.md) + +This cmdlet will create a migration session and initialize it. + +### [Remove-SPMTTask](Remove-SPMTTask.md) + +Remove an existing migration task from the registered migration. + +### [Show-SPMTMigration](Show-SPMTMigration.md) + +If the user starts the migration with -NoShow parameter, running the 'Show-SPMTMigration' cmdlet +will display the task ID, data source location, target location and migration status in the console. + +### [Start-SPMTMigration](Start-SPMTMigration.md) + +This cmdlet will start the registered SPMT migration. + +### [Stop-SPMTMigration](Stop-SPMTMigration.md) + +Cancel the current migration session. + +### [Unregister-SPMTMigration](Unregister-SPMTMigration.md) + +Remove the SPMT migration session created. diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Register-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Register-SPMTMigration.md new file mode 100644 index 0000000000..5cfbe4e478 --- /dev/null +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Register-SPMTMigration.md @@ -0,0 +1,814 @@ +--- +external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml +Module Name: Microsoft.SharePoint.MigrationTool.PowerShell +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/register-spmtmigration +applicable: SharePoint Migration Tool +title: Register-SPMTMigration +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- +# Register-SPMTMigration + +## SYNOPSIS + +This cmdlet will create a migration session and initialize it. + +## SYNTAX + +``` +Register-SPMTMigration [-Force] [-SPOCredential ] [-ScanOnly ] + [-StartMigrationAutomaticallyWhenNoScanIssue ] [-EnableMultiRound ] + [-MigrateAllSiteFieldsAndContentTypes ] [-MigrateFileVersionHistory ] + [-KeepAllVersions ] [-NumberOfVersionToMigrate ] [-IncludeHiddenFiles ] + [-MigrateFilesCreatedAfter ] [-MigrateFilesModifiedAfter ] + [-SkipFilesWithExtension ] + [-SkipSitesWithName ] [-SkipListsWithName ] [-SkipContentTypesWithName ] + [-ReplacementOfInvalidChar ] [-DuplicatePageBehavior ] + [-AutomaticUserMapping ] [-PreserveUserPermissionsForSharePointSource ] + [-PreserveUserPermissionsForFileShare ] [-PreservePermissionInheritance ] + [-MigrateSiteSettings ] [-SkipListWithAudienceTargetingEnabled ] + [-UserMappingFile ] [-WorkingFolder ] [-UseCustomAzureStorage ] + [-EnableEncryption ] [-DeleteTempFilesWhenMigrationDone ] + [-MigrateWithoutRootFolder] [-IgnoreUpdate] + [-LookupReferencePolicy ] [-MigrationType ] + [-DefaultFlowOwnerEmail ] [-HandleUnspportedWorkflowActions ] + [-CustomAzureStorageAccount ] [-CustomAzureAccessKey ] + [-DisableNoScriptDuringMigration ] [-MigrateNavigation ] + [-MigrateTermGroups ] [] +``` + +## DESCRIPTION + +This cmdlet will create a migration session and initialize it. The initialization will configure +migration settings at session level. If no specific setting parameters are defined, default settings +will be used. After a session is registered, the user can add a migration task to the migration +session and start migration. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +#Define SPO target# +$SPOUrl = "https://contoso.sharepoint.com" +$UserName = "admin@contoso.onmicrosoft.com" +$PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force +$SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $UserName, $PassWord + +#Import SPMT Migration Module# +Import-Module Microsoft.SharePoint.MigrationTool.PowerShell + +#Register the SPMT session with SPO credentials# +Register-SPMTMigration -SPOCredential $SPOCredential -Force +``` + +This example registers a migration session. + +## PARAMETERS + +### -AutomaticUserMapping + +By default, this is set to On. If no User mapping file is provided by the user, then Azure Active +Directory is used as the default for user mapping or map by login name on sp2010. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAzureAccessKey + +If you use your own Azure storage, you need to set Azure storage account to On, enter your account +and key. You also need to select if you want to enable or disable encryption, and whether temporary +files are deleted when migration is completed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAzureStorageAccount + +The default is Off. If you wish to use your own Azure storage, set this value to On. + +If you choose to turn it On, additional fields will appear for you to enter your account and key, +and settings to select if you want to enable or disable encryption. You also need to decide whether +temporary files are deleted when migration is completed. + +**Note:** This feature is supported only for *General Purpose storage accounts* as General-Purpose +accounts support Azure blobs and queues. This feature is not available for Blob Storage accounts. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultFlowOwnerEmail + +The default flow owner name for workflow migration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteTempFilesWhenMigrationDone + +By default, this is set to Off. If you set this value to On, those temporary files in Custom Azure +storage generated during migration will be deleted when the migration is completed. Otherwise, those +temporary files will not be deleted. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableNoScriptDuringMigration + +By default this is set to On. will allow temporary change customize script status. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DuplicatePageBehavior + +Determine the behavior of the page file migration when encountering a page file with the same name +or same id on the target.By default, DuplicatePageBehavior is set to RENAME. + +- For RENAME, we will keep the conflicted page file on the target and rename the source page file + with a new name. +- For OVERWRITE, we will overwrite the conflicted page file on the target using the source page file +- For SKIP, we will skip migrating this conflicted page file. +- For NO_PAGES_MIGRATION, we will skip all the page files no matter they conflict with the target or + not during the migration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DuplicatePageBehavior + +Determine the behavior of the page file migration when encountering a page file with the same name +or same id on the target.By default, DuplicatePageBehavior is set to RENAME. + +- For RENAME, we will keep the conflicted page file on the target and rename the source page file + with a new name. +- For OVERWRITE, we will overwrite the conflicted page file on the target using the source page file +- For SKIP, we will skip migrating this conflicted page file. +- For NO_PAGES_MIGRATION, we will skip all the page files no matter they conflict with the target or + not during the migration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableEncryption + +The default is set to On. If you use your own Azure storage, you will set and define your account +and key, and decide and configure enable or disable encryption in settings, and whether temporary +files are deleted when migration is completed. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -EnableMultiRound + +The default setting is Off. This means the migration will only do one check round to make sure no +new changes or additions were made since the previous run. If it is set to On, it will do up to 5 +check round to make sure no changes or additions were made. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forcibly stop and unregister existing migration. + +Note: If you have a registered SPMT migration session already, the Force parameter will register a +new session anyway.The Force parameter performs the function of Stop-SMPTMigration and +Unregister-SPMTMigration together. If you have never run "Register-SPMTMigration", with or without +the Force parameter, a new session will be created. + +If you have an active migration and didn't use the Force parameter, you need to run +Stop-SPMTMigration, and then run Unregister-SPMTMigration to unregister the exiting migration +session first. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HandleUnspportedWorkflowActions + +The value should be Stop or Continue. +Default value is Stop. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreUpdate + +The default setting is OFF. + +Skip the checking and installation of new updates, even when a new version of PowerShell SPMT is +available. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeHiddenFiles + +If set to true, hidden system files will be migrated. By default, it is set to true. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeepAllVersions + +The default is set to On. If set to On, all version numbers of the file will be migrated. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LookupReferencePolicy + +The look up reference in list setting. Default is to migrate all referenced lists. Values can be 0, +1, 2, corresponding to FIND_ALL_REFERENCE,SKIP_AND_CONTINUE or DO_NOT_MIGRATE. + +```yaml +Type: Microsoft.SharePoint.MigrationTool.MigrationLib.Common.LookupReferenceScanPolicyEnum] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateAllSiteFieldsAndContentTypes + +The default setting is Off. If set to On, all the site fields and content types will be migrated. +Otherwise, only those fields and content types used by lists to be migrated will be migrated. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateFilesCreatedAfter + +If you choose to limit which files are to be migrated based on creation dates, set your values in +this section. This may be to limit the number of files migrated or to adhere to overall company +governance policy regarding to file retention. The default value is null. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateFilesModifiedAfter + +If you choose to limit what files are to be migrated based on modified dates, set your values in +this section. This may be to limit the number of files migrated or to adhere to overall company +governance policy regarding to file retention. The default value is null. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateFileVersionHistory + +If set to No, only the most recent versions of the file will be migrated. If set to Yes, you can +choose whether to keep all versions, or limit it to a specific number. By default, it is set to On. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateNavigation + +By default this is set to On. We will migrate the site and web navigation nodes when doing the +migration. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateSiteSettings + +Migrate site setting. Default is to preserver all settings. Values can be PRESERVE_ALL_SETTINGS, +PRESERVE_ALL_BUT_SKIP_TITLE_LOGO, ONLY_TITLE_LOGO, SKIP_ALL_SETTINGS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateTermGroups + +By default this is set to On. We will migrate the term groups when doing the migration. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateWithoutRootFolder + +In file share migrations, use this parameter to migrate only the root folder's contents to the +target. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationType + +Migration Type. The value can be WORKFLOW or CONTENT. Default value is CONTENT + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfVersionToMigrate + +You can choose a specific version number for the files to be migrated. By default, the number of +versions kept is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreservePermissionInheritance + +Keep subsite and list level permission inheritance. By default, it is true. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreserveUserPermissionsForFileShare + +By default, this is set to Off. If set to On, permissions will be preserved. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreserveUserPermissionsForSharePointSource + +By default, this is set to On. If set to Off, no permissions will be preserved. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplacementOfInvalidChar + +The replacement of invalid characters in filename/path. +There is no default value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanOnly + +The default is Off. When ScanOnly is On, only a scan will be performed. If you wish to scan migrated +items as a pre-assessment to migration, turn it On. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipContentTypesWithName + +To prevent certain content types from migrating, list each content type name, separating it with a +semicolon. The default value is null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipFilesWithExtension + +To prevent certain file types from migrating, list each extension, separate them with colons. The +default value is null. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipListsWithName + +To prevent certain lists from migrating, list each list name, separating it with a semicolon. The +default value is null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipListWithAudienceTargetingEnabled + +By default, this is set to On. Lists with an audience field, the migration will fail with warning +"Does not support list with audience settings' unless customer enable the 'Ignore audience' setting. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipSitesWithName + +To prevent certain sites from migrating, list each site name, separating it with a semicolon. The +default value is null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SPOCredential + +The credentials are used to connect the SharePoint Online tenant. If no credentials are passed in, +use ADAL OAuth2. Important: If you are using multifactor authentication on your tenant, do not use +the -SPOCredential parameter. The ADAL dialog will prompt for authentication and MFA. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartMigrationAutomaticallyWhenNoScanIssue + +By default, this is set to On. When StartMigrationAutomaticallyWhenNoScanIssue is turned on, it +means to start migration automatically if no scan issue. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomAzureStorage + +If you use your own Azure storage, you will set your account and key, and select if you want to +enable or disable encryption, and whether temporary files are deleted when migration is completed. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserMappingFile + +By default, Microsoft Entra lookup is used to map users when submitting migration jobs. If you +choose to use a custom user mapping file and you want to preserve user permissions, turn off +Microsoft Entra lookup.By doing so, if a user isn't found in the mapping file, the tool won't look +it up in Microsoft Entra ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkingFolder + +By default, a temp folder will be created as working folder. If you wish to specify your own +specific working folder, enter the name here. Note: By default, the working folder is +%appdata%\Microsoft\MigrationToolStorage.Please make sure that your working folder has a minimum of +150 GB of free space.It may need more depending on the size of the data you plan to migrate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Remove-SPMTTask.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Remove-SPMTTask.md new file mode 100644 index 0000000000..62da4980b3 --- /dev/null +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Remove-SPMTTask.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml +Module Name: Microsoft.SharePoint.MigrationTool.PowerShell +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/remove-spmttask +applicable: SharePoint Migration Tool +title: Remove-SPMTTask +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Remove-SPMTTask + +## SYNOPSIS +Remove an existing migration task from the registered migration. + +## SYNTAX + +``` +Remove-SPMTTask -TaskId [-Force] [] +``` + +## DESCRIPTION + +Remove an existing migration task from the registered migration. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes an existing migration task from the migration. + +```powershell +#Define SharePoint 2013 data source# +$SourceSiteUrl = "https://YourOnPremSite/" +$OnPremUserName = "Yourcomputer\administrator" +$OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force +$SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $OnPremUserName, $OnPremPassword +$SourceListName = "SourceListName" + +#Define SPO target# +$SPOUrl = "https://contoso.sharepoint.com" +$UserName = "admin@contoso.onmicrosoft.com" +$PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force +$SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $UserName, $PassWord +$TargetListName = "TargetListName" + +#Define File Share data source# +$FileshareSource = "YourFileShareDataSource" + +#Import SPMT Migration Module# +Import-Module Microsoft.SharePoint.MigrationTool.PowerShell + +#Register the SPMT session with SPO credentials# +Register-SPMTMigration -SPOCredential $SPOCredential -Force + +# Add two tasks into the session. One is SharePoint migration task, and another is +# File Share migration task. +Add-SPMTTask -SharePointSourceCredential $SPCredential -SharePointSourceSiteUrl $SourceSiteUrl -TargetSiteUrl $SPOUrl -MigrateAll +Add-SPMTTask -FileShareSource $FileshareSource -TargetSiteUrl $SPOUrl -TargetList $TargetListName + +#Start Migration in the background.# +Start-SPMTMigration -NoShow + +# Remove an existing migration task from the migration. Remember to replace the +# "XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" with your actual TaskID. You can get the TaskID in the console +# if the migration is running without -NoShow parameter. If the migration is running with -NoShow +# parameter, then find the TaskID after running "Get-SPMTMigration" first. + +Remove-SPMTTask -TaskID XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -Force +``` + +## PARAMETERS + +### -Force + +This parameter is optional. To remove a task already started, the Force parameter is required. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TaskId + +This parameter is mandatory and defines the ID of task to be removed. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: 00000000-0000-0000-0000-000000000000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -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/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Show-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Show-SPMTMigration.md new file mode 100644 index 0000000000..b649121945 --- /dev/null +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Show-SPMTMigration.md @@ -0,0 +1,90 @@ +--- +external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml +Module Name: Microsoft.SharePoint.MigrationTool.PowerShell +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/show-spmtmigration +applicable: SharePoint Migration Tool +title: Show-SPMTMigration +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Show-SPMTMigration + +## SYNOPSIS + +If the user starts the migration with -NoShow parameter, running the 'Show-SPMTMigration' cmdlet +will display the task ID, data source location, target location and migration status in the console. +Pressing Ctrl+C will return to NoShow mode. + +## SYNTAX + +``` +Show-SPMTMigration [] +``` + +## DESCRIPTION + +If the user starts the migration with -NoShow parameter, running the 'Show-SPMTMigration' cmdlet +will display the task ID, data source location, target location and migration status in the console. +Pressing Ctrl+C will return to NoShow mode. + +## EXAMPLES + +### EXAMPLE 1 + +This example, first, starts a migration with -NoShow parameter, then run 'Show-SPMTMigration', the +migration task ID, data source location, target location and migration status will show up in the +console. + +```powershell +# Define SharePoint 2013 data source +$SourceSiteUrl = "https://YourOnPremSite/" +$OnPremUserName = "Yourcomputer\administrator" +$OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force +$SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $OnPremUserName, $OnPremPassword +$SourceListName = "SourceListName" + +# Define SPO target +$SPOUrl = "https://contoso.sharepoint.com" +$UserName = "admin@contoso.onmicrosoft.com" +$PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force +$SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $UserName, $PassWord +$TargetListName = "TargetListName" + +# Define File Share data source +$FileshareSource = "YourFileShareDataSource" + +# Import SPMT Migration Module +Import-Module Microsoft.SharePoint.MigrationTool.PowerShell + +#Register the SPMT session with SPO credentials# +Register-SPMTMigration -SPOCredential $SPOCredential -Force + +# Add two tasks into the session. One is SharePoint migration task, and another is +# File Share migration task. +Add-SPMTTask -SharePointSourceCredential $SPCredential -SharePointSourceSiteUrl $SourceSiteUrl -TargetSiteUrl $SPOUrl -MigrateAll +Add-SPMTTask -FileShareSource $FileshareSource -TargetSiteUrl $SPOUrl -TargetList $TargetListName + +# Start Migration in the background. +Start-SPMTMigration -NoShow +Show-SPMTMigration +``` + +## 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 diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Start-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Start-SPMTMigration.md new file mode 100644 index 0000000000..5bb427b352 --- /dev/null +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Start-SPMTMigration.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml +Module Name: Microsoft.SharePoint.MigrationTool.PowerShell +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/start-spmtmigration +applicable: SharePoint Migration Tool +title: Start-SPMTMigration +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Start-SPMTMigration + +## SYNOPSIS +This cmdlet will start the registered SPMT migration. + +## SYNTAX + +``` +Start-SPMTMigration [-NoShow] [-ParametersValidationOnly] [] +``` + +## DESCRIPTION + +This cmdlet will start the registered SPMT migration. + +## EXAMPLES + +### EXAMPLE 1 + +This example starts a migration with one SharePoint migration task and one File Share migration task. + +```powershell +# Define SharePoint 2013 data source + +$SourceSiteUrl = "https://YourOnPremSite/" +$OnPremUserName = "Yourcomputer\administrator" +$OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force +$SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $OnPremUserName, $OnPremPassword +$SourceListName = "SourceListName" + +# Define SPO target +$SPOUrl = "https://contoso.sharepoint.com" +$UserName = "admin@contoso.onmicrosoft.com" +$PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force +$SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $UserName, $PassWord +$TargetListName = "TargetListName" + +# Define File Share data source +$FileshareSource = "YourFileShareDataSource" + +# Import SPMT Migration Module +Import-Module Microsoft.SharePoint.MigrationTool.PowerShell + +# Register the SPMT session with SPO credentials +Register-SPMTMigration -SPOCredential $SPOCredential -Force + +# Add two tasks into the session. One is SharePoint migration task, and another is +# File Share migration task. +Add-SPMTTask -SharePointSourceCredential $SPCredential -SharePointSourceSiteUrl $SourceSiteUrl -TargetSiteUrl $SPOUrl -MigrateAll +Add-SPMTTask -FileShareSource $FileshareSource -TargetSiteUrl $SPOUrl -TargetList $TargetListName + +# Start Migration in the console. +Start-SPMTMigration +``` + +## PARAMETERS + +### -NoShow + +In "-NoShow" mode, a message will be displayed to indicate that the migration is running in the +background. + +Note: Use the 'Show-SPMTMigration' to bring the migration from background to foreground. The task +ID, data source location, target location and migration status will be displayed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParametersValidationOnly + +Validate the parameters: check source access permissions, source existence and if TargetUrl is +valid. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/spmt/spmt-ps/spmt/Stop-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Stop-SPMTMigration.md similarity index 86% rename from spmt/spmt-ps/spmt/Stop-SPMTMigration.md rename to spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Stop-SPMTMigration.md index 211d84a4ec..ab0835c9a1 100644 --- a/spmt/spmt-ps/spmt/Stop-SPMTMigration.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Stop-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/stop-spmtmigration +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/stop-spmtmigration applicable: SharePoint Migration Tool title: Stop-SPMTMigration schema: 2.0.0 @@ -69,7 +69,11 @@ This example starts a migration first, then run "Stop-SPMTMigration" to cancel t ## 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/spmt/spmt-ps/spmt/Unregister-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Unregister-SPMTMigration.md similarity index 86% rename from spmt/spmt-ps/spmt/Unregister-SPMTMigration.md rename to spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Unregister-SPMTMigration.md index 173a2fee3e..3a60f64af7 100644 --- a/spmt/spmt-ps/spmt/Unregister-SPMTMigration.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Unregister-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/unregister-spmtmigration +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/unregister-spmtmigration applicable: SharePoint Migration Tool title: Unregister-SPMTMigration schema: 2.0.0 @@ -13,20 +13,23 @@ ms.reviewer: # Unregister-SPMTMigration ## SYNOPSIS + Remove the SPMT migration session created. ## SYNTAX -```powershell +``` Unregister-SPMTMigration [] ``` ## DESCRIPTION + Remove the SPMT migration session created. ## EXAMPLES ### EXAMPLE 1 + ```powershell #Define SharePoint 2013 data source# @@ -69,7 +72,11 @@ This example cancels the started migration and unregister the migration session. ## 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/spmt/spmt-ps/spmt/Get-SPMTMigration.md b/spmt/spmt-ps/spmt/Get-SPMTMigration.md deleted file mode 100644 index 1e4b20d6a6..0000000000 --- a/spmt/spmt-ps/spmt/Get-SPMTMigration.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml -Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/get-spmtmigration -applicable: SharePoint Migration Tool -title: Get-SPMTMigration -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-SPMTMigration - -## SYNOPSIS -Return the object of current session. It includes current tasks status and current session level settings. - -The status of current tasks includes: - -1. Count of scanned files -2. Count of migrated files -3. Migration error message if there is any. - -## SYNTAX - -```powershell -Get-SPMTMigration [] -``` - -## DESCRIPTION -Return object of current session. -It includes current tasks status and current session level settings. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -#Define SharePoint 2013 data source# -$Global:SourceSiteUrl = "https://YourOnPremSite/" -$Global:OnPremUserName = "Yourcomputer\administrator" -$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force -$Global:SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:OnPremUserName, $Global:OnPremPassword -$Global:SourceListName = "SourceListName" - - -#Define SPO target# -$Global:SPOUrl = "https://contoso.sharepoint.com" -$Global:UserName = "admin@contoso.onmicrosoft.com" -$Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force -$Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord -$Global:TargetListName = "TargetListName" - -#Define Fileshare data source# -$Global:FileshareSource = "YourFileShareDataSource" - -#Import SPMT Migration Module# -Import-Module Microsoft.SharePoint.MigrationTool.PowerShell - -#Register the SPMT session with SPO credentials# -Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force - -#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.# -Add-SPMTTask -SharePointSourceCredential $Global:SPCredential -SharePointSourceSiteUrl $Global:SourceSiteUrl -TargetSiteUrl $Global:SPOUrl -MigrateAll -Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList $Global:TargetListName - -#Start migration in the background# -Start-SPMTMigration -NoShow - -#Get the object of current migration# -$session = Get-SPMTMigration -``` - -This example starts a migration first, and then run "Get-SPMTMigration" to get the object of current migration. - -## 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 diff --git a/spmt/spmt-ps/spmt/Register-SPMTMigration.md b/spmt/spmt-ps/spmt/Register-SPMTMigration.md deleted file mode 100644 index f092abf2ef..0000000000 --- a/spmt/spmt-ps/spmt/Register-SPMTMigration.md +++ /dev/null @@ -1,611 +0,0 @@ ---- -external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml -Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/register-spmtmigration -applicable: SharePoint Migration Tool -title: Register-SPMTMigration -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Register-SPMTMigration - -## SYNOPSIS -This cmdlet will create a migration session and initialize it. The initialization will configure migration settings at session level. If no specific setting parameters are defined, default settings will be used. -After a session is registered, the user can add a migration task to the migration session and start migration. - -## SYNTAX - -```powershell -Register-SPMTMigration [-SPOCredentials] [-EnableMultiRound ] [-ScanOnly ] [-AzureActiveDirectoryLookup ] [-CustomAzureAccessKey ] [-CustomAzureStorageAccount ] [-DeleteTempFilesWhenMigrationDone ] [-EnableEncryption ] [-IgnoreUpdate ] [-KeepAllVersions ] [-MigrateFileVersionHistory ] [-MigrateOneNoteFolderAsOneNoteNoteBook ] [-MigrateFilesCreatedAfter ] [-MigrateFilesModifiedAfter ] [-SkipFilesWithExtension ] [-IncludeHiddenFiles ] [-NumberOfVersionToMigrate ] [-PreserveUserPermissionsForFileShare ] [-PreserveUserPermissionsForSharePointSource ] [-SkipListWithAudienceTargetingEnabled ] [-StartMigrationAutomaticallyWhenNoScanIssue ] [-UseCustomAzureStorage ] [-UserMappingFile ] [-MigrateAllSiteFieldsAndContentTypes] [-WorkingFolder ] [-SkipSitesWithName ] [-SkipListsWithName ] [-SkipContentTypesWithName ] [-DuplicatePageBehavior ] [-MigrateNavigation ] [-MigrateTermGroups ] [-MigrateWithoutRootFolder] -Force -``` - -## DESCRIPTION -This cmdlet will create a migration session and initialize it. The initialization will configure migration settings at session level. If no specific setting parameters are defined, default settings will be used. -After a session is registered, the user can add a migration task to the migration session and start migration. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -#Define SPO target# -$Global:SPOUrl = "https://contoso.sharepoint.com" -$Global:UserName = "admin@contoso.onmicrosoft.com" -$Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force -$Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord - -#Import SPMT Migration Module# -Import-Module Microsoft.SharePoint.MigrationTool.PowerShell - -#Register the SPMT session with SPO credentials# -Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force -``` - -This example registers a migration session. - -## PARAMETERS - -### -AzureActiveDirectoryLookup -By default, this is set to On. -If no user mapping file is provided by the user, then Microsoft Entra ID is used as the default for user mapping. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAzureAccessKey -If you use your own Azure storage, you need to set Azure storage account to On, enter your account and key. -You also need to select if you want to enable or disable encryption, and whether temporary files are deleted when migration is completed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomAzureStorageAccount -The default is Off. -If you wish to use your own Azure storage, set this value to On. - -If you choose to turn it On, additional fields will appear for you to enter your account and key, and settings to select if you want to enable or disable encryption. -You also need to decide whether temporary files are deleted when migration is completed. - -*Note: * This feature is supported only for *General Purpose storage accounts* as General-Purpose accounts support Azure blobs and queues. -This feature is not available for Blob Storage accounts. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteTempFilesWhenMigrationDone -By default, this is set to Off. If you set this value to On, those temporary files in Custom Azure storage generated during migration will be deleted when the migration is completed. Otherwise, those temporary files will not be deleted. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableEncryption -The default is set to On. -If you use your own Azure storage, you will set and define your account and key, and decide and configure enable or disable encryption in settings, and whether temporary files are deleted when migration is completed. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forcibly stop and unregister existing migration. - -Note: If you have a registered SPMT migration session already, the Force parameter will register a new session anyway.The Force parameter performs the function of Stop-SMPTMigration and Unregister-SPMTMigration together. -If you have never run "Register-SPMTMigration", with or without the Force parameter, a new session will be created. - -If you have an active migration and didn't use the Force parameter, you need to run Stop-SPMTMigration, and then run Unregister-SPMTMigration to unregister the exiting migration session first. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreUpdate -The default setting is OFF. - -Skip the checking and installation of new updates, even when a new version of PowerShell SPMT is available. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableMultiRound -The default setting is Off. -This means the migration will only do one check round to make sure no new changes or additions were made since the previous run. -If it is set to On, it will do up to 5 check round to make sure no changes or additions were made. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepAllVersions -The default is set to On. -If set to On, all version numbers of the file will be migrated. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateFileVersionHistory -If set to No, only the most recent versions of the file will be migrated. -If set to Yes, you can choose whether to keep all versions, or limit it to a specific number. -By default, it is set to On. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateFilesCreatedAfter -If you choose to limit which files are to be migrated based on creation dates, set your values in this section. -This may be to limit the number of files migrated or to adhere to overall company governance policy regarding to file retention. -The default value is null. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateFilesModifiedAfter -If you choose to limit what files are to be migrated based on modified dates, set your values in this section. -This may be to limit the number of files migrated or to adhere to overall company governance policy regarding to file retention. -The default value is null. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHiddenFiles -If set to true, hidden system files will be migrated. -By default, it 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 -``` - -### -MigrateOneNoteFolderAsOneNoteNoteBook -By default, MigrateOneNoteFolderAsOneNoteNoteBook is set to Off. -OneNote notebooks comprise of folders containing OneNote files and potentially nested subfolders with these files. -The root folder of such a hierarchy is a OneNote notebook and it must contain a .onetoc2 file. - -The current implementation is to mark the folders as notebooks at the end of the migration. -If a folder contains any non-onenote files, it won't be marked as a notebook. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfVersionToMigrate -You can choose a specific version number for the files to be migrated. -By default, the number of versions kept is 10. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreserveUserPermissionsForFileShare -By default, this is set to Off. -If set to On, permissions will be preserved. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreserveUserPermissionsForSharePointSource -By default, this is set to On. -If set to Off, no permissions will be preserved. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SPOCredential -The credentials are used to connect the SharePoint Online tenant. If no credentials are passed in, use ADAL OAuth2. Important: If you are using multifactor authentication on your tenant, do not use the -SPOCredential parameter. The ADAL dialog will prompt for authentication and MFA. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScanOnly -The default is Off. -When ScanOnly is On, only a scan will be performed. -If you wish to scan migrated items as a pre-assessment to migration, turn it On. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipFilesWithExtension -To prevent certain file types from migrating, list each extension, separate them with colons. -The default value is null. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipListWithAudienceTargetingEnabled -By default, this is set to On. -Lists with an audience field, the migration will fail with warning "Does not support list with audience settings' unless customer enable the 'Ignore audience' setting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartMigrationAutomaticallyWhenNoScanIssue -By default, this is set to On.When StartMigrationAutomaticallyWhenNoScanIssue is turned on, it means to start migration automatically if no scan issue. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseCustomAzureStorage -If you use your own Azure storage, you will set your account and key, and select if you want to enable or disable encryption, and whether temporary files are deleted when migration is completed. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserMappingFile -By default, Microsoft Entra lookup is used to map users when submitting migration jobs. -If you choose to use a custom user mapping file and you want to preserve user permissions, turn off Microsoft Entra lookup.By doing so, if a user isn't found in the mapping file, the tool won't look it up in Microsoft Entra ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateAllSiteFieldsAndContentTypes -The default setting is Off. -If set to On, all the site fields and content types will be migrated. -Otherwise, only those fields and content types used by lists to be migrated will be migrated. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkingFolder -By default, a temp folder will be created as working folder. -If you wish to specify your own specific working folder, enter the name here. -Note: By default, the working folder is %appdata%\Microsoft\MigrationToolStorage.Please make sure that your working folder has a minimum of 150 GB of free space.It may need more depending on the size of the data you plan to migrate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipSitesWithName -To prevent certain sites from migrating, list each site name, separating it with a semicolon. -The default value is null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipListsWithName -To prevent certain lists from migrating, list each list name, separating it with a semicolon. -The default value is null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipContentTypesWithName -To prevent certain content types from migrating, list each content type name, separating it with a semicolon. -The default value is null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DuplicatePageBehavior -Determine the behavior of the page file migration when encountering a page file with the same name or same id on the target.By default, DuplicatePageBehavior is set to RENAME. - -For RENAME, we will keep the conflicted page file on the target and rename the source page file with a new name. - -For OVERWRITE, we will overwrite the conflicted page file on the target using the source page file - -For SKIP, we will skip migrating this conflicted page file. - -For NO_PAGES_MIGRATION, we will skip all the page files no matter they conflict with the target or not during the migration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateNavigation -By default this is set to On. -We will migrate the site and web navigation nodes when doing the migration. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateTermGroups -By default this is set to On. -We will migrate the term groups when doing the migration. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateWithoutRootFolder -In file share migrations, use this parameter to migrate only the root folder's contents to the target. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/spmt/spmt-ps/spmt/Remove-SPMTTask.md b/spmt/spmt-ps/spmt/Remove-SPMTTask.md deleted file mode 100644 index a8c0c3f424..0000000000 --- a/spmt/spmt-ps/spmt/Remove-SPMTTask.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml -Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/remove-spmttask -applicable: SharePoint Migration Tool -title: Remove-SPMTTask -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Remove-SPMTTask - -## SYNOPSIS -Remove an existing migration task from the registered migration. - -## SYNTAX - -```powershell -Remove-SPMTTask -TaskId [-Force] -``` - -## DESCRIPTION -Remove an existing migration task from the registered migration. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -#Define SharePoint 2013 data source# - -$Global:SourceSiteUrl = "https://YourOnPremSite/" -$Global:OnPremUserName = "Yourcomputer\administrator" -$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force -$Global:SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:OnPremUserName, $Global:OnPremPassword -$Global:SourceListName = "SourceListName" - - -#Define SPO target# -$Global:SPOUrl = "https://contoso.sharepoint.com" -$Global:UserName = "admin@contoso.onmicrosoft.com" -$Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force -$Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord -$Global:TargetListName = "TargetListName" - -#Define File Share data source# -$Global:FileshareSource = "YourFileShareDataSource" - -#Import SPMT Migration Module# -Import-Module Microsoft.SharePoint.MigrationTool.PowerShell - -#Register the SPMT session with SPO credentials# -Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force - -#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.# -Add-SPMTTask -SharePointSourceCredential $Global:SPCredential -SharePointSourceSiteUrl $Global:SourceSiteUrl -TargetSiteUrl $Global:SPOUrl -MigrateAll -Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList $Global:TargetListName - -#Start Migration in the background.# -Start-SPMTMigration -NoShow - -#Remove an existing migration task from the migration. Remember to replace the "XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" with your actual TaskID. You can get the TaskID in the console if the migration is running without -NoShow parameter. If the migration is running with -NoShow parameter, then find the TaskID after running "Get-SPMTMigration" first.# -Remove-SPMTTask -TaskID XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -Force -``` - -This example removes an existing migration task from the migration. - -## PARAMETERS - -### -Force -This parameter is optional. -To remove a task already started, the Force parameter is required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TaskId -This parameter is mandatory and defines the ID of task to be removed. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: 00000000-0000-0000-0000-000000000000 -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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/spmt/spmt-ps/spmt/SharePointMigrationTool.md b/spmt/spmt-ps/spmt/SharePointMigrationTool.md deleted file mode 100644 index 0faff30e0e..0000000000 --- a/spmt/spmt-ps/spmt/SharePointMigrationTool.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -Module Name: SharePoint Migration Tool -Module Guid: joece26c-1775-4100-85c0-20c4d71eaa21 -title: SharePoint Migration Tool ---- - -# Microsoft SharePoint Migration Tool -## Description -The following migration cmdlets are based on the SharePoint Migration Tool (SPMT) migration engine. It will move files from File Share, SharePoint 2013 document libraries, or items of SharePoint 2013 lists to Office 365. - -[Install SPMT and Get PowerShell module](https://spmtreleasescus.blob.core.windows.net/install/default.htm "Install SPMT and Get PowerShell module") - -Notes: - -PowerShell 5.0 and .NET Framework 4.6.2 or higher are required to support the migration of file paths of up to 400 characters. - -After installing SPMT, the PowerShell dlls are copied to %userprofile%\Documents\WindowsPowerShell\Modules. - -## Microsoft Teams Cmdlets - -### [Add-SPMTTask](Add-SPMTTask.md) - -### [Get-SPMTMigration](Get-SPMTMigration.md) - -### [Register-SPMTMigration](Register-SPMTMigration.md) - -### [Remove-SPMTTask](Remove-SPMTTask.md) - -### [Show-SPMTMigration](Show-SPMTMigration.md) - -### [Start-SPMTMigration](Start-SPMTMigration.md) - -### [Stop-SPMTMigration](Stop-SPMTMigration.md) - -### [Unregister-SPMTMigration](Unregister-SPMTMigration.md) diff --git a/spmt/spmt-ps/spmt/Show-SPMTMigration.md b/spmt/spmt-ps/spmt/Show-SPMTMigration.md deleted file mode 100644 index 5d9ded7974..0000000000 --- a/spmt/spmt-ps/spmt/Show-SPMTMigration.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml -Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/show-spmtmigration -applicable: SharePoint Migration Tool -title: Show-SPMTMigration -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Show-SPMTMigration - -## SYNOPSIS -If the user starts the migration with -NoShow parameter, running the 'Show-SPMTMigration' cmdlet will display the task ID, data source location, target location and migration status in the console. Pressing Ctrl+C will return to NoShow mode. - -## SYNTAX - -```powershell -Show-SPMTMigration [] -``` - -## DESCRIPTION -If the user starts the migration with -NoShow parameter, running the 'Show-SPMTMigration' cmdlet will display the task ID, data source location, target location and migration status in the console. Pressing Ctrl+C will return to NoShow mode. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -#Define SharePoint 2013 data source# - -$Global:SourceSiteUrl = "https://YourOnPremSite/" -$Global:OnPremUserName = "Yourcomputer\administrator" -$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force -$Global:SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:OnPremUserName, $Global:OnPremPassword -$Global:SourceListName = "SourceListName" - - -#Define SPO target# -$Global:SPOUrl = "https://contoso.sharepoint.com" -$Global:UserName = "admin@contoso.onmicrosoft.com" -$Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force -$Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord -$Global:TargetListName = "TargetListName" - -#Define File Share data source# -$Global:FileshareSource = "YourFileShareDataSource" - -#Import SPMT Migration Module# -Import-Module Microsoft.SharePoint.MigrationTool.PowerShell - -#Register the SPMT session with SPO credentials# -Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force - -#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.# -Add-SPMTTask -SharePointSourceCredential $Global:SPCredential -SharePointSourceSiteUrl $Global:SourceSiteUrl -TargetSiteUrl $Global:SPOUrl -MigrateAll -Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList $Global:TargetListName - -#Start Migration in the background.# -Start-SPMTMigration -NoShow -Show-SPMTMigration -``` - -This example, first, starts a migration with -NoShow parameter, then run 'Show-SPMTMigration', the migration task ID, data source location, target location and migration status will show up in the console. - -## 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 diff --git a/spmt/spmt-ps/spmt/Start-SPMTMigration.md b/spmt/spmt-ps/spmt/Start-SPMTMigration.md deleted file mode 100644 index 285f7f17c9..0000000000 --- a/spmt/spmt-ps/spmt/Start-SPMTMigration.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml -Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/start-spmtmigration -applicable: SharePoint Migration Tool -title: Start-SPMTMigration -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Start-SPMTMigration - -## SYNOPSIS -This cmdlet will start the registered SPMT migration. - -## SYNTAX - -```powershell -Start-SPMTMigration [-NoShow] [-ParametersValidationOnly] -``` - -## DESCRIPTION -This cmdlet will start the registered SPMT migration. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -#Define SharePoint 2013 data source# - -$Global:SourceSiteUrl = "https://YourOnPremSite/" -$Global:OnPremUserName = "Yourcomputer\administrator" -$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force -$Global:SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:OnPremUserName, $Global:OnPremPassword -$Global:SourceListName = "SourceListName" - - -#Define SPO target# -$Global:SPOUrl = "https://contoso.sharepoint.com" -$Global:UserName = "admin@contoso.onmicrosoft.com" -$Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force -$Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord -$Global:TargetListName = "TargetListName" - -#Define File Share data source# -$Global:FileshareSource = "YourFileShareDataSource" - -#Import SPMT Migration Module# -Import-Module Microsoft.SharePoint.MigrationTool.PowerShell - -#Register the SPMT session with SPO credentials# -Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force - -#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.# -Add-SPMTTask -SharePointSourceCredential $Global:SPCredential -SharePointSourceSiteUrl $Global:SourceSiteUrl -TargetSiteUrl $Global:SPOUrl -MigrateAll -Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList $Global:TargetListName - -#Start Migration in the console.# -Start-SPMTMigration -``` - -This example starts a migration with one SharePoint migration task and one File Share migration task. - -## PARAMETERS - -### -NoShow -In "-NoShow" mode, a message will be displayed to indicate that the migration is running in the background. - -Note: Use the 'Show-SPMTMigration' to bring the migration from background to foreground. -The task ID, data source location, target location and migration status will be displayed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParametersValidationOnly -Validate the parameters: check source access permissions, source existence and if TargetUrl is valid. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS 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/docfx.json b/teams/docfx.json index 401d0beb8b..1b863ef7f6 100644 --- a/teams/docfx.json +++ b/teams/docfx.json @@ -21,18 +21,26 @@ "dest": "teams/teams-ps" }, { - "files": ["**/*.yml"], - "exclude": ["toc.yml"], - "src": "teams-ps", - "version": "teams-ps", - "dest": "module" - }, - { - "files": ["toc.yml"], - "src": "teams-ps", - "version": "teams-ps", - "dest": "module/teams-ps" - } + "files": ["**/*.yml"], + "exclude": ["toc.yml"], + "src": "teams-ps", + "version": "teams-ps", + "dest": "module" + }, + { + "files": ["toc.yml"], + "src": "teams-ps", + "version": "teams-ps", + "dest": "module/teams-ps" + }, + { + "files": [ + "**/*.md" + ], + "src": "virtual-folder", + "version": "teams-ps", + "dest": "module" + } ], "resource": [ { diff --git a/teams/teams-ps/teams/Add-TeamChannelUser.md b/teams/teams-ps/MicrosoftTeams/Add-TeamChannelUser.md similarity index 95% rename from teams/teams-ps/teams/Add-TeamChannelUser.md rename to teams/teams-ps/MicrosoftTeams/Add-TeamChannelUser.md index dcc55539d1..1dd701b38c 100644 --- a/teams/teams-ps/teams/Add-TeamChannelUser.md +++ b/teams/teams-ps/MicrosoftTeams/Add-TeamChannelUser.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/add-teamchanneluser -title: Add-TeamChannelUser +online version: https://learn.microsoft.com/powershell/module/microsoftteams/add-teamchanneluser schema: 2.0.0 +title: Add-TeamChannelUser --- # Add-TeamChannelUser @@ -11,10 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds an owner or member to the private channel. -The command will return immediately, but the Teams application will not reflect the update immediately. To see the update you should refresh the members page. - -Note: Technical limitations of private channels apply. To add a user as a member to a channel, they need to first be a member of the team. To make a user an owner of a channel, they need to first be a member of the channel. - ## SYNTAX ``` @@ -23,6 +20,10 @@ Add-TeamChannelUser -GroupId -DisplayName -User [-Rol ## DESCRIPTION +The command will return immediately, but the Teams application will not reflect the update immediately. To see the update you should refresh the members page. + +Note: Technical limitations of private channels apply. To add a user as a member to a channel, they need to first be a member of the team. To make a user an owner of a channel, they need to first be a member of the channel. + 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 @@ -50,8 +51,8 @@ Adds external user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 to a shared channel. ## PARAMETERS -### -GroupId -GroupId of the parent team +### -DisplayName +Display name of the private channel ```yaml Type: String @@ -65,8 +66,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Display name of the private channel +### -GroupId +GroupId of the parent team ```yaml Type: String @@ -80,24 +81,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -User -User's UPN (user principal name - e.g. -johndoe@example.com) +### -Role +Owner ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Role -Owner +### -TenantId +TenantId of the external user ```yaml Type: String @@ -111,15 +111,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -TenantId -TenantId of the external user +### -User +User's UPN (user principal name - e.g. +johndoe@example.com) ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) @@ -131,7 +132,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, DisplayName, User, Role, TenantId +### GroupId + +### DisplayName + +### User + +### Role + +### TenantId ## OUTPUTS diff --git a/teams/teams-ps/teams/Add-TeamUser.md b/teams/teams-ps/MicrosoftTeams/Add-TeamUser.md similarity index 94% rename from teams/teams-ps/teams/Add-TeamUser.md rename to teams/teams-ps/MicrosoftTeams/Add-TeamUser.md index 91f29ce8bb..e9430a7357 100644 --- a/teams/teams-ps/teams/Add-TeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Add-TeamUser.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/add-teamuser +schema: 2.0.0 +title: Add-TeamUser --- # Add-TeamUser @@ -51,32 +51,32 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -User -UPN of a user of the organization (user principal name - e.g. johndoe@example.com). +### -Role +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 Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: Member Accept pipeline input: True (ByPropertyName) 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. +### -User +UPN of a user of the organization (user principal name - e.g. johndoe@example.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: Member +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -86,7 +86,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, User, Role +### GroupId + +### User + +### Role ## OUTPUTS diff --git a/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/Clear-CsOnlineTelephoneNumberOrder.md similarity index 84% rename from teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/Clear-CsOnlineTelephoneNumberOrder.md index 36eee8cbf2..5fda790b62 100644 --- a/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/Clear-CsOnlineTelephoneNumberOrder.md @@ -1,13 +1,14 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: Clear-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder +schema: 2.0.0 +title: Clear-CsOnlineTelephoneNumberOrder --- # Clear-CsOnlineTelephoneNumberOrder @@ -28,7 +29,7 @@ Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telepho ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Clear-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 @@ -89,14 +90,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype) -[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) -[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder) -[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder) -[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md b/teams/teams-ps/MicrosoftTeams/Clear-TeamsEnvironmentConfig.md similarity index 92% rename from teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md rename to teams/teams-ps/MicrosoftTeams/Clear-TeamsEnvironmentConfig.md index 62e51c733c..3ee68e95f8 100644 --- a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/MicrosoftTeams/Clear-TeamsEnvironmentConfig.md @@ -1,13 +1,14 @@ --- +author: VikneshMSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Locale: en-US +manager: vinelap Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/clear-teamsenvironmentconfig -title: Clear-TeamsEnvironmentConfig -schema: 2.0.0 -author: VikneshMSFT ms.author: vimohan ms.reviewer: pbafna -manager: vinelap +online version: https://learn.microsoft.com/powershell/module/microsoftteams/clear-teamsenvironmentconfig +schema: 2.0.0 +title: Clear-TeamsEnvironmentConfig --- # Clear-TeamsEnvironmentConfig diff --git a/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/Complete-CsOnlineTelephoneNumberOrder.md similarity index 85% rename from teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/Complete-CsOnlineTelephoneNumberOrder.md index 8e367470c6..7ebed106c2 100644 --- a/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/Complete-CsOnlineTelephoneNumberOrder.md @@ -1,13 +1,14 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: Complete-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder +schema: 2.0.0 +title: Complete-CsOnlineTelephoneNumberOrder --- # Complete-CsOnlineTelephoneNumberOrder @@ -28,7 +29,7 @@ Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific te ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Complete-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 | fl @@ -89,14 +90,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype) -[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) -[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder) -[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder) -[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Connect-MicrosoftTeams.md b/teams/teams-ps/MicrosoftTeams/Connect-MicrosoftTeams.md similarity index 98% rename from teams/teams-ps/teams/Connect-MicrosoftTeams.md rename to teams/teams-ps/MicrosoftTeams/Connect-MicrosoftTeams.md index c713e2275a..fa2f921c8c 100644 --- a/teams/teams-ps/teams/Connect-MicrosoftTeams.md +++ b/teams/teams-ps/MicrosoftTeams/Connect-MicrosoftTeams.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/connect-microsoftteams +schema: 2.0.0 +title: Connect-MicrosoftTeams --- # Connect-MicrosoftTeams @@ -338,6 +338,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +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 +Parameter Sets: ManagedServiceLogin +Aliases: MSI, ManagedService +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LogFilePath The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. @@ -375,14 +392,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsAccessToken (Removed from version 2.3.2-preview) -Specifies a Microsoft Graph access token. -> [!WARNING] ->This parameter has been removed from version 2.3.2-preview. +### -ManagedServiceHostName +Host name for managed service login. ```yaml Type: String -Parameter Sets: AccessToken +Parameter Sets: ManagedServiceLogin Aliases: Required: False Position: Named @@ -391,17 +406,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantId -Specifies the ID of a tenant. - -If you do not specify this parameter, the account is authenticated with the home tenant. - -You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. +### -ManagedServicePort +Port number for managed service login. ```yaml -Type: String -Parameter Sets: UserCredential, AccessToken -Aliases: Domain, TenantDomain +Type: Int32 +Parameter Sets: ManagedServiceLogin +Aliases: Required: False Position: Named Default value: None @@ -409,28 +420,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ManagedServiceSecret +Secret, used for some kinds of managed service login. + ```yaml -Type: String -Parameter Sets: ServicePrincipalCertificate -Aliases: Domain, TenantDomain -Required: True +Type: SecureString +Parameter Sets: ManagedServiceLogin +Aliases: +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -MsAccessToken (Removed from version 2.3.2-preview) +Specifies a Microsoft Graph access token. +> [!WARNING] +>This parameter has been removed from version 2.3.2-preview. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: String +Parameter Sets: AccessToken +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -454,30 +469,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -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. +### -TenantId +Specifies the ID of a tenant. -```yaml -Type: SwitchParameter -Parameter Sets: ManagedServiceLogin -Aliases: MSI, ManagedService -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +If you do not specify this parameter, the account is authenticated with the home tenant. -### -ManagedServiceHostName -Host name for managed service login. +You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. ```yaml Type: String -Parameter Sets: ManagedServiceLogin -Aliases: +Parameter Sets: UserCredential, AccessToken, ServicePrincipalCertificate +Aliases: Domain, TenantDomain Required: False Position: Named Default value: None @@ -485,27 +487,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ManagedServicePort -Port number for managed service login. +### -UseDeviceAuthentication +Use device code authentication instead of a browser control. ```yaml -Type: Int32 -Parameter Sets: ManagedServiceLogin +Type: SwitchParameter +Parameter Sets: UserCredential Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -ManagedServiceSecret -Secret, used for some kinds of managed service login. - -```yaml -Type: SecureString -Parameter Sets: ManagedServiceLogin -Aliases: Required: False Position: Named Default value: None @@ -513,17 +502,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDeviceAuthentication -Use device code authentication instead of a browser control. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter -Parameter Sets: UserCredential -Aliases: - +Parameter Sets: (All) +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md b/teams/teams-ps/MicrosoftTeams/Disable-CsOnlineSipDomain.md similarity index 91% rename from teams/teams-ps/teams/Disable-CsOnlineSipDomain.md rename to teams/teams-ps/MicrosoftTeams/Disable-CsOnlineSipDomain.md index 932a55f2fe..a8cd1e0663 100644 --- a/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md +++ b/teams/teams-ps/MicrosoftTeams/Disable-CsOnlineSipDomain.md @@ -1,20 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain applicable: Microsoft Teams -title: Disable-CsOnlineSipDomain -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/disable-csonlinesipdomain +schema: 2.0.0 +title: Disable-CsOnlineSipDomain --- # Disable-CsOnlineSipDomain ## 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. +This cmdlet prevents provisioning of users in Skype for Business Online for the specified domain. ## SYNTAX @@ -23,6 +25,8 @@ Disable-CsOnlineSipDomain -Domain [-Force] [-Confirm] [ Applicable: Microsoft Teams + +The SIP domain to be disabled for online provisioning in Skype for Business Online. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf - -Required: False +Aliases: +Required: True Position: Named Default value: None Accept pipeline input: False @@ -93,13 +98,14 @@ Accept wildcard characters: False ### -Force +> Applicable: Microsoft Teams + Suppresses all confirmation prompts that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -125,8 +131,8 @@ This cmdlet is for advanced scenarios only. Organizations that are pure online o ## RELATED LINKS -[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/enable-csonlinesipdomain) +[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/enable-csonlinesipdomain) -[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain) +[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/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/Disconnect-MicrosoftTeams.md b/teams/teams-ps/MicrosoftTeams/Disconnect-MicrosoftTeams.md similarity index 92% rename from teams/teams-ps/teams/Disconnect-MicrosoftTeams.md rename to teams/teams-ps/MicrosoftTeams/Disconnect-MicrosoftTeams.md index b840da266f..4dbb514d06 100644 --- a/teams/teams-ps/teams/Disconnect-MicrosoftTeams.md +++ b/teams/teams-ps/MicrosoftTeams/Disconnect-MicrosoftTeams.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/disconnect-microsoftteams -title: Disconnect-MicrosoftTeams -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/disconnect-microsoftteams +schema: 2.0.0 +title: Disconnect-MicrosoftTeams --- # Disconnect-MicrosoftTeams @@ -32,13 +32,13 @@ Disconnects from the Microsoft Teams environment. ## PARAMETERS -### -WhatIf -Simulates what would happen if the cmdlet is run. The cmdlet is not run. +### -Confirm +Proactively accepts any confirmation prompts. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -47,13 +47,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Proactively accepts any confirmation prompts. +### -WhatIf +Simulates what would happen if the cmdlet is run. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Enable-CsOnlineSipDomain.md b/teams/teams-ps/MicrosoftTeams/Enable-CsOnlineSipDomain.md similarity index 87% rename from teams/teams-ps/teams/Enable-CsOnlineSipDomain.md rename to teams/teams-ps/MicrosoftTeams/Enable-CsOnlineSipDomain.md index 7356c8e473..c8533c2892 100644 --- a/teams/teams-ps/teams/Enable-CsOnlineSipDomain.md +++ b/teams/teams-ps/MicrosoftTeams/Enable-CsOnlineSipDomain.md @@ -1,21 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/enable-csonlinesipdomain applicable: Microsoft Teams -title: Enable-CsOnlineSipDomain -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/enable-csonlinesipdomain +schema: 2.0.0 +title: Enable-CsOnlineSipDomain --- # Enable-CsOnlineSipDomain ## SYNOPSIS -This cmdlet enables provisioning of users in Skype for Business Online for the specified domain. This cmdlet is only necessary to run if you previously disabled a domain using Disable-CsOnlineSipDomain. Enable-CsOnlineSipDomain is used to facilitate consolidation of separate Skype for Business deployments into a single Office 365 tenant. - +This cmdlet enables provisioning of users in Skype for Business Online for the specified domain. ## SYNTAX ```powershell @@ -23,6 +24,7 @@ Enable-CsOnlineSipDomain -Domain [-Force] [-Confirm] [ Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams -Required: True +Aliases: cf +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Domain -Prompts you for confirmation before running the cmdlet. +> Applicable: Microsoft Teams + +The SIP domain to be enabled for online provisioning in Skype for Business Online. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams -Required: False +Aliases: +Required: True Position: Named Default value: None Accept pipeline input: False @@ -86,13 +90,14 @@ Accept wildcard characters: False ### -Force +> Applicable: Microsoft Teams + Suppresses all confirmation prompts that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -117,6 +122,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain) +[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/disable-csonlinesipdomain) -[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain) +[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinesipdomain) diff --git a/teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md b/teams/teams-ps/MicrosoftTeams/Export-CsAcquiredPhoneNumber.md similarity index 89% rename from teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md rename to teams/teams-ps/MicrosoftTeams/Export-CsAcquiredPhoneNumber.md index 2af9e62f5d..1eb2ce032a 100644 --- a/teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Export-CsAcquiredPhoneNumber.md @@ -1,14 +1,14 @@ --- -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: +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +online version: https://learn.microsoft.com/powershell/module/microsoftteams/export-csacquiredphonenumber schema: 2.0.0 +title: Export-CsAcquiredPhoneNumber --- # Export-CsAcquiredPhoneNumber @@ -23,7 +23,7 @@ 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. +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/microsoftteams/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. @@ -124,4 +124,4 @@ 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) +[Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus) diff --git a/teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md b/teams/teams-ps/MicrosoftTeams/Export-CsAutoAttendantHolidays.md similarity index 88% rename from teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md rename to teams/teams-ps/MicrosoftTeams/Export-CsAutoAttendantHolidays.md index 610335e471..2223080fd1 100644 --- a/teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/MicrosoftTeams/Export-CsAutoAttendantHolidays.md @@ -1,19 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/export-csautoattendantholidays +schema: 2.0.0 +title: Export-CsAutoAttendantHolidays --- # Export-CsAutoAttendantHolidays ## SYNOPSIS -Use Export-CsAutoAttendantHolidays cmdlet to export holiday schedules of an existing Auto Attendant (AA). The data is exported as a byte array from the cmdlet, which can be dumped to disk as a CSV file and can later be imported using the Import-CsAutoAttendantHolidays cmdlet. +Use Export-CsAutoAttendantHolidays cmdlet to export holiday schedules of an existing Auto Attendant (AA). ## SYNTAX @@ -42,7 +44,7 @@ where ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $bytes = Export-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 [System.IO.File]::WriteAllBytes("C:\Exports\Holidays.csv", $bytes) @@ -53,13 +55,15 @@ In this example, the Export-CsAutoAttendantHolidays cmdlet is used to export hol ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the AA whose holiday schedules are to be exported. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -70,11 +74,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -99,6 +104,6 @@ The Export-CsAutoAttendantHolidays cmdlet accepts a string as the Identity param ## RELATED LINKS -[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays) +[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/import-csautoattendantholidays) -[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays) +[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantholidays) diff --git a/teams/teams-ps/teams/export-csonlineaudiofile.md b/teams/teams-ps/MicrosoftTeams/Export-CsOnlineAudioFile.md similarity index 78% rename from teams/teams-ps/teams/export-csonlineaudiofile.md rename to teams/teams-ps/MicrosoftTeams/Export-CsOnlineAudioFile.md index f0b747b543..ac593e6fce 100644 --- a/teams/teams-ps/teams/export-csonlineaudiofile.md +++ b/teams/teams-ps/MicrosoftTeams/Export-CsOnlineAudioFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile applicable: Microsoft Teams -title: Export-CsOnlineAudioFile -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/export-csonlineaudiofile +schema: 2.0.0 +title: Export-CsOnlineAudioFile --- # Export-CsOnlineAudioFile @@ -17,8 +18,9 @@ Use the Export-CsOnlineAudioFile cmdlet to download an existing audio file. ## SYNTAX -```powershell -Export-CsOnlineAudioFile [[-Identity] ] [-ApplicationId ] [] +``` +Export-CsOnlineAudioFile -Identity [-ApplicationId ] [-HttpPipelinePrepend ] + [] ``` ## DESCRIPTION @@ -26,7 +28,7 @@ The Export-CsOnlineAudioFile cmdlet downloads an existing Auto Attendant (AA), C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $content=Export-CsOnlineAudioFile -ApplicationId "HuntGroup" -Identity 57f800408f8848548dd1fbc18073fe46 [System.IO.File]::WriteAllBytes('C:\MyWaveFile.wav', $content) @@ -37,6 +39,9 @@ This example exports a Call Queue audio file and saves it as MyWaveFile.wav. ## PARAMETERS ### -ApplicationId + +> Applicable: Microsoft Teams + The ApplicationId parameter is the identifier for the application which will use this audio file. For example, if the audio file is used with an organizational auto attendant, then it needs to be set to "OrgAutoAttendant". If the audio file is used with a hunt group (call queue), then it needs to be set to "HuntGroup". If the audio file is used with Microsoft Teams, then it needs to be set to "TenantGlobal" Supported values: @@ -46,18 +51,32 @@ Supported values: - TenantGlobal ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: TenantGlobal Accept pipeline input: False Accept wildcard characters: False ``` +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The Id of the specific audio file that you would like to export. @@ -66,14 +85,15 @@ Type: System.String Parameter Sets: (All) Aliases: -Required: False +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -90,8 +110,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](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineaudiofile) -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) -[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineaudiofile) diff --git a/teams/teams-ps/teams/Find-CsGroup.md b/teams/teams-ps/MicrosoftTeams/Find-CsGroup.md similarity index 90% rename from teams/teams-ps/teams/Find-CsGroup.md rename to teams/teams-ps/MicrosoftTeams/Find-CsGroup.md index 18c265455b..a2447ed431 100644 --- a/teams/teams-ps/teams/Find-CsGroup.md +++ b/teams/teams-ps/MicrosoftTeams/Find-CsGroup.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/find-csgroup applicable: Microsoft Teams -title: Find-CsGroup +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/find-csgroup schema: 2.0.0 +title: Find-CsGroup --- # Find-CsGroup @@ -23,14 +25,14 @@ The Find-CsGroup cmdlet lets you search groups in the Azure Address Book Service ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Find-CsGroup -SearchQuery "Contoso Group" -MaxResults 5 ``` This example finds and displays up to five groups that match the "Contoso Group" search query. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Find-CsGroup -SearchQuery "ed0d1180-169e-47c7-b718-bf9e60543914" -ExactMatchOnly $true ``` @@ -39,30 +41,34 @@ This example finds and displays only those groups that are an exact match to the ## PARAMETERS -### -SearchQuery -The SearchQuery parameter defines a search query to search the display name or the sip address or the GUID of groups. This parameter accepts partial search query. The search is not case sensitive. +### -ExactMatchOnly + +> Applicable: Microsoft Teams + +The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExactMatchOnly -The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false. +### -Force + +> Applicable: Microsoft Teams + +PARAMVALUE: SwitchParameter ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -71,14 +77,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -MailEnabledOnly +Instructs the cmdlet to return mail enabled only groups. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -MaxResults + +> Applicable: Microsoft Teams + The MaxResults parameter identifies the maximum number of results to return. If this parameter is not provided, the default is value is 10. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -103,15 +110,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MailEnabledOnly -Instructs the cmdlet to return mail enabled only groups. +### -SearchQuery + +> Applicable: Microsoft Teams + +The SearchQuery parameter defines a search query to search the display name or the sip address or the GUID of groups. This parameter accepts partial search query. The search is not case sensitive. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -119,13 +129,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Find-CsOnlineApplicationInstance.md similarity index 85% rename from teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Find-CsOnlineApplicationInstance.md index 2744bd46e0..3acb65e43a 100644 --- a/teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Find-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance applicable: Microsoft Teams -title: Find-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance +schema: 2.0.0 +title: Find-CsOnlineApplicationInstance --- # Find-CsOnlineApplicationInstance @@ -28,28 +29,28 @@ If MaxResults is not specified, the number of returned applications instances is ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Find-CsOnlineApplicationInstance -SearchQuery "Test" ``` This example returns up to 10 application instances whose name starts with "Test". -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Find-CsOnlineApplicationInstance -SearchQuery "Test" -MaxResults 5 ``` This example returns up to 5 application instances whose name starts with "Test". -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell Find-CsOnlineApplicationInstance -SearchQuery "Test Auto Attendant" -ExactMatchOnly ``` This example returns up to 10 application instances whose name is "Test Auto Attendant". -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell Find-CsOnlineApplicationInstance -SearchQuery "Test Auto Attendant" -AssociatedOnly ``` @@ -58,16 +59,18 @@ This example returns up to 10 application instances whose name is "Test Auto Att ## PARAMETERS -### -SearchQuery -The SearchQuery parameter defines a query for application instances by display name, telephone number, or GUID of the application instance. This parameter accepts partial queries for display names and telephone numbers. The search is not case sensitive. +### -AssociatedOnly + +> Applicable: Microsoft Teams + +The AssociatedOnly parameter instructs the cmdlet to return only application instances that are associated to a configuration. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -ExactMatchOnly + +> Applicable: Microsoft Teams + The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -90,30 +95,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AssociatedOnly -The AssociatedOnly parameter instructs the cmdlet to return only application instances that are associated to a configuration. +### -Force + +> Applicable: Microsoft Teams + +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -UnAssociatedOnly -The UnAssociatedOnly parameter instructs the cmdlet to return only application instances that are not associated to any configuration. +### -MaxResults + +> Applicable: Microsoft Teams + +The MaxResults parameter identifies the maximum number of results to return. If this parameter is not provided, the default is value is 10. Max allowed value is 20. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -122,34 +131,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxResults -The MaxResults parameter identifies the maximum number of results to return. If this parameter is not provided, the default is value is 10. Max allowed value is 20. +### -SearchQuery + +> Applicable: Microsoft Teams + +The SearchQuery parameter defines a query for application instances by display name, telephone number, or GUID of the application instance. This parameter accepts partial queries for display names and telephone numbers. The search is not case sensitive. ```yaml -Type: UInt32 +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True 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. +### -UnAssociatedOnly + +> Applicable: Microsoft Teams + +The UnAssociatedOnly parameter instructs the cmdlet to return only application instances that are not associated to any configuration. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -169,10 +182,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) -[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Get-ALLM365TeamsApps.md b/teams/teams-ps/MicrosoftTeams/Get-AllM365TeamsApps.md similarity index 93% rename from teams/teams-ps/teams/Get-ALLM365TeamsApps.md rename to teams/teams-ps/MicrosoftTeams/Get-AllM365TeamsApps.md index b3dd4967bb..d4ff36be08 100644 --- a/teams/teams-ps/teams/Get-ALLM365TeamsApps.md +++ b/teams/teams-ps/MicrosoftTeams/Get-AllM365TeamsApps.md @@ -1,14 +1,15 @@ --- -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 +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 04/24/2024 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Get-AllM365TeamsApps schema: 2.0.0 +title: Get-AllM365TeamsApps --- # Get-AllM365TeamsApps @@ -107,5 +108,5 @@ Properties: ## RELATED LINKS -[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-m365teamsapp) -[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-m365teamsapp) +[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/microsoftteams/get-m365teamsapp) +[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/microsoftteams/get-m365teamsapp) diff --git a/teams/teams-ps/teams/Get-AssociatedTeam.md b/teams/teams-ps/MicrosoftTeams/Get-AssociatedTeam.md similarity index 88% rename from teams/teams-ps/teams/Get-AssociatedTeam.md rename to teams/teams-ps/MicrosoftTeams/Get-AssociatedTeam.md index 2bc7566964..897fc289ca 100644 --- a/teams/teams-ps/teams/Get-AssociatedTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Get-AssociatedTeam.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-associatedteam -title: Get-AssociatedTeam -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-associatedteam +schema: 2.0.0 +title: Get-AssociatedTeam --- # Get-AssociatedTeam @@ -77,5 +78,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) -[Get-SharedWithTeam](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-Team](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) +[Get-SharedWithTeam](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) diff --git a/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationAccessPolicy.md similarity index 87% rename from teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsApplicationAccessPolicy.md index a3cd76b4a4..cf598840da 100644 --- a/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csapplicationaccesspolicy +schema: 2.0.0 +title: Get-CsApplicationAccessPolicy --- # Get-CsApplicationAccessPolicy @@ -55,33 +56,33 @@ In the command shown above, information is returned for a single application acc ## PARAMETERS -### -Identity +### -Filter -Unique identifier assigned to the policy when it was created. +A filter that is not expressed in the standard wildcard language. ```yaml -Type: XdsIdentity -Parameter Sets: (All) +Type: String +Parameter Sets: Filter Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter +### -Identity -A filter that is not expressed in the standard wildcard language. +Unique identifier assigned to the policy when it was created. ```yaml -Type: String -Parameter Sets: Filter +Type: XdsIdentity +Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -115,10 +116,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) -[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy) -[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csapplicationaccesspolicy) -[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csapplicationaccesspolicy) +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationMeetingConfiguration.md similarity index 91% rename from teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsApplicationMeetingConfiguration.md index 0980ee7a04..93d753c78c 100644 --- a/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationMeetingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-CsApplicationMeetingConfiguration applicable: Teams -title: Get-CsApplicationMeetingConfiguration -schema: 2.0.0 -manager: zhengni author: jackry6350 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: yoren -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-CsApplicationMeetingConfiguration +schema: 2.0.0 +title: Get-CsApplicationMeetingConfiguration --- # Get-CsApplicationMeetingConfiguration @@ -40,50 +41,54 @@ The command shown above returns application meeting configuration settings that ## PARAMETERS -### -Identity +### -Filter -Unique identifier of the application meeting configuration settings to be returned. -Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsApplicationMeetingConfiguration cmdlet. -However, you can use the following syntax to retrieve the global settings: -Identity global. +> Applicable: Teams + +Enables you to use wildcards when specifying the application meeting 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: XdsIdentity -Parameter Sets: (All) +Type: String +Parameter Sets: Filter Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the application meeting 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*". +### -Identity + +Unique identifier of the application meeting configuration settings to be returned. +Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsApplicationMeetingConfiguration cmdlet. +However, you can use the following syntax to retrieve the global settings: -Identity global. ```yaml -Type: String -Parameter Sets: Filter +Type: XdsIdentity +Parameter Sets: (All) Aliases: -Applicable: Teams -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Teams + Retrieves the application meeting configuration 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: -Applicable: Teams Required: False Position: Named @@ -107,4 +112,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csapplicationmeetingconfiguration) +[Set-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csapplicationmeetingconfiguration) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendant.md similarity index 81% rename from teams/teams-ps/teams/Get-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendant.md index 5b972a6fe7..a7566f3443 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant +schema: 2.0.0 +title: Get-CsAutoAttendant --- # Get-CsAutoAttendant @@ -31,7 +33,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 @@ -73,31 +75,34 @@ This example skips initial 5 auto attendants and gets the next 10 AAs configured ## PARAMETERS -### -Identity -The identity for the AA to be retrieved. If this parameter is not specified, then all created AAs in the organization are returned. -If you specify this parameter, you can't specify the other parameters. +### -Descending + +> Applicable: Microsoft Teams + +If specified, the retrieved auto attendants would be sorted in descending order. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False 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. +### -ExcludeContent + +> Applicable: Microsoft Teams + +If specified, only auto attendants' names, identities and associated application instances will be retrieved. ```yaml -Type: System.UInt32 +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -106,14 +111,18 @@ Accept pipeline input: False 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. +### -First + +> Applicable: Microsoft Teams + +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: Microsoft Teams Required: False Position: Named @@ -122,30 +131,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NameFilter -If specified, only auto attendants whose names match that value would be returned. +### -Identity + +> Applicable: Microsoft Teams + +The identity for the AA to be retrieved. If this parameter is not specified, then all created AAs in the organization are returned. +If you specify this parameter, you can't specify the other parameters. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -SortBy -If specified, the retrieved auto attendants would be sorted by the specified property. +### -IncludeStatus + +> Applicable: Microsoft Teams + +If specified, the status records for each auto attendant in the result set are also retrieved. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -154,14 +168,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Descending -If specified, the retrieved auto attendants would be sorted in descending order. +### -NameFilter + +> Applicable: Microsoft Teams + +If specified, only auto attendants whose names match that value would be returned. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -170,14 +186,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeStatus -If specified, the status records for each auto attendant in the result set are also retrieved. +### -Skip + +> Applicable: Microsoft Teams + +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: SwitchParameter +Type: System.UInt32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -186,14 +204,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeContent -If specified, only auto attendants' names, identities and associated application instances will be retrieved. +### -SortBy + +> Applicable: Microsoft Teams + +If specified, the retrieved auto attendants would be sorted by the specified property. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -204,11 +224,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -233,12 +254,12 @@ The Get-CsAutoAttendant cmdlet accepts a string as the Identity parameter. ## RELATED LINKS -[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus) -[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendant) -[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant) -[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant) -[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/update-csautoattendant) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantHolidays.md similarity index 87% rename from teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantHolidays.md index 92114b548b..413002c8a4 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantHolidays.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantholidays +schema: 2.0.0 +title: Get-CsAutoAttendantHolidays --- # Get-CsAutoAttendantHolidays @@ -26,28 +28,28 @@ The Get-CsAutoAttendantHolidays provides a convenient way to visualize the infor ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` In this example, the Get-CsAutoAttendantHolidays cmdlet is used to get all holidays in an auto attendant with Identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -Years @(2017) ``` In this example, the Get-CsAutoAttendantHolidays cmdlet is used to get all holidays in year 2017 in an auto attendant with Identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -Years @(2017) -Names @("Christmas") ``` In this example, the Get-CsAutoAttendantHolidays cmdlet is used to get holiday named Christmas in the year 2017 in an auto attendant with Identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` (Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -Years @(2017) -Names @("Christmas")).DateTimeRanges ``` @@ -56,14 +58,33 @@ In this example, the Get-CsAutoAttendantHolidays cmdlet is used to retrieve the ## PARAMETERS +### -Force + +> Applicable: Microsoft Teams + +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 + +> Applicable: Microsoft Teams + Represents the identifier for the auto attendant whose holidays are to be retrieved. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -72,29 +93,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Names -```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 -``` +> Applicable: Microsoft Teams -### -Years -The Years parameter represents the years for the holidays to be retrieved. If this parameter is not specified, then holidays for all years in the AA are returned. +The Names parameter represents the names for the holidays to be retrieved. If this parameter is not specified, then all holidays in the AA are returned. ```yaml -Type: System.Collections.Generic.List[System.String] +Type: System.Collections.Generic.List[System.Int32] Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -103,14 +111,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Names -The Names parameter represents the names for the holidays to be retrieved. If this parameter is not specified, then all holidays in the AA are returned. +### -Years + +> Applicable: Microsoft Teams + +The Years parameter represents the years for the holidays to be retrieved. If this parameter is not specified, then holidays for all years in the AA are returned. ```yaml -Type: System.Collections.Generic.List[System.Int32] +Type: System.Collections.Generic.List[System.String] Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -136,6 +146,6 @@ The DateTimeRanges parameter in the output needs to be explicitly referenced to ## RELATED LINKS -[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays) +[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/import-csautoattendantholidays) -[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays) +[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/export-csautoattendantholidays) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantStatus.md similarity index 89% rename from teams/teams-ps/teams/Get-CsAutoAttendantStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantStatus.md index 69b5630115..903abd35cd 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus +schema: 2.0.0 +title: Get-CsAutoAttendantStatus --- # Get-CsAutoAttendantStatus @@ -26,14 +28,14 @@ This cmdlet provides a way to return the provisioning status of an auto attendan ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` In Example 1, the Get-CsAutoAttendantStatus cmdlet is used to get status records for all resources of an auto attendant with identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -IncludeResources @("AudioFile") ``` @@ -43,13 +45,15 @@ In Example 2, the Get-CsAutoAttendantStatus cmdlet is used to get status records ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + Represents the identifier for the auto attendant whose provisioning status is to be retrieved. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -59,6 +63,9 @@ Accept wildcard characters: False ``` ### -IncludeResources + +> Applicable: Microsoft Teams + The IncludeResources parameter identities the auto attendant resources whose status is to be retrieved. Available resources are: - AudioFile: Indicates status for audio files used by AA. - DialByNameVoiceResponses: Indicates status for speech recognition when using dial-by-name (directory lookup) feature with AA. @@ -69,7 +76,6 @@ Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: Accepted values: AudioFile, DialByNameVoiceResponses, SipProvisioning -applicable: Microsoft Teams Required: False Position: Named @@ -80,11 +86,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -109,4 +116,4 @@ The Get-CsAutoAttendantStatus cmdlet accepts a string as the Identity parameter. ## RELATED LINKS -[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage.md similarity index 87% rename from teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage.md index c6cb4253af..46521c39f0 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage +schema: 2.0.0 +title: Get-CsAutoAttendantSupportedLanguage --- # Get-CsAutoAttendantSupportedLanguage @@ -26,14 +28,14 @@ The Get-CsAutoAttendantSupportedLanguage cmdlet gets all languages (and their co ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantSupportedLanguage ``` This example gets all supported languages. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantSupportedLanguage -Identity "en-US" ``` @@ -43,13 +45,15 @@ This example gets the language that the Identity parameter specifies (en-US). ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter designates a specific language to be retrieved. If this parameter is not specified, then all supported languages are returned. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 @@ -60,11 +64,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone.md similarity index 87% rename from teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone.md index 1e0491d7e4..b8658d6121 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone +schema: 2.0.0 +title: Get-CsAutoAttendantSupportedTimeZone --- # Get-CsAutoAttendantSupportedTimeZone @@ -26,14 +28,14 @@ The Get-CsAutoAttendantSupportedTimeZone cmdlet gets all the time zones that the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantSupportedTimeZone ``` This example gets all supported time zones. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantSupportedTimeZone -Identity "Pacific Standard Time" ``` @@ -43,13 +45,15 @@ This example gets the timezone that the Identity parameter specifies (Pacific St ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter specifies a time zone to be retrieved. If this parameter is not used, then all supported time zones are returned. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 @@ -60,11 +64,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantTenantInformation.md similarity index 87% rename from teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantTenantInformation.md index 92a3a9bbc1..cf064e6dfe 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantTenantInformation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendanttenantinformation +schema: 2.0.0 +title: Get-CsAutoAttendantTenantInformation --- # Get-CsAutoAttendantTenantInformation @@ -26,7 +28,7 @@ The Get-CsAutoAttendantTenantInformation cmdlet gets the default tenant informat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantTenantInformation ``` @@ -37,11 +39,12 @@ Gets the default auto attendant information for the logged in tenant. ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/MicrosoftTeams/Get-CsBatchPolicyAssignmentOperation.md similarity index 97% rename from teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsBatchPolicyAssignmentOperation.md index b9a3895727..cc8cc8ca29 100644 --- a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsBatchPolicyAssignmentOperation.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csbatchpolicyassignmentoperation +schema: 2.0.0 +title: Get-CsBatchPolicyAssignmentOperation --- # Get-CsBatchPolicyAssignmentOperation @@ -90,36 +91,6 @@ In this example, the UserState property is expanded to see the status of each us ## PARAMETERS -### -Identity -The ID of a batch policy assignment operation. - -```yaml -Type: String -Parameter Sets: Get1 -Aliases: OperationId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Option filter - -```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 .NET debugger to attach @@ -165,6 +136,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +The ID of a batch policy assignment operation. + +```yaml +Type: String +Parameter Sets: Get1 +Aliases: OperationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Proxy The URI for the proxy server to use @@ -210,6 +196,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Status +Option filter + +```yaml +Type: String +Parameter Sets: Get +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). @@ -266,4 +267,4 @@ Contains the status for each user in the batch. ## RELATED LINKS -[New-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation) +[New-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchpolicyassignmentoperation) diff --git a/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsBatchTeamsDeploymentStatus.md similarity index 90% rename from teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsBatchTeamsDeploymentStatus.md index 2fdd9166f2..03cbd6c052 100644 --- a/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsBatchTeamsDeploymentStatus.md @@ -1,85 +1,86 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsBatchTeamsDeploymentStatus -title: Get-CsBatchTeamsDeploymentStatus -schema: 2.0.0 ---- - -# Get-CsBatchTeamsDeploymentStatus - -## SYNOPSIS - -This cmdlet is used to get the status of the batch deployment orchestration. - -## SYNTAX - -```powershell -Get-CsBatchTeamsDeploymentStatus -OrchestrationId - -InputObject - [] -``` - -## DESCRIPTION -After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus. - -To learn more, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id" -``` - -This command provides the status of the specified batch deployment orchestrationId. - -## PARAMETERS - -### OrchestrationId -This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Identity parameter. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Status of the orchestrationId - -Running: The orchestration is running. -Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. - -## NOTES - -## RELATED LINKS - -[New-CsBatchTeamsDeployment](https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsBatchTeamsDeploymentStatus +schema: 2.0.0 +title: Get-CsBatchTeamsDeploymentStatus +--- + +# Get-CsBatchTeamsDeploymentStatus + +## SYNOPSIS + +This cmdlet is used to get the status of the batch deployment orchestration. + +## SYNTAX + +```powershell +Get-CsBatchTeamsDeploymentStatus -OrchestrationId + -InputObject + [] +``` + +## DESCRIPTION +After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus. + +To learn more, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id" +``` + +This command provides the status of the specified batch deployment orchestrationId. + +## PARAMETERS + +### OrchestrationId +This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Status of the orchestrationId + +Running: The orchestration is running. +Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. + +## NOTES + +## RELATED LINKS + +[New-CsBatchTeamsDeployment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchteamsdeployment) diff --git a/teams/teams-ps/teams/Get-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/Get-CsCallQueue.md similarity index 78% rename from teams/teams-ps/teams/Get-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/Get-CsCallQueue.md index 4c197e143e..6e72deea7b 100644 --- a/teams/teams-ps/teams/Get-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsCallQueue.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -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 author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallqueue +schema: 2.0.0 +title: Get-CsCallQueue --- # Get-CsCallQueue @@ -27,14 +28,14 @@ The Get-CsCallQueue cmdlet lets you retrieve information about the Call Queues i ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCallQueue ``` -This example gets all Call Queues in the organization. +This example gets the first 100 call queues in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCallQueue -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` @@ -43,14 +44,16 @@ This example gets the Call Queue with the identity 5e3a575e-1faa-49ff-83c2-5cf1c ## PARAMETERS -### -Identity -PARAMVALUE: Guid +### -Descending + +> Applicable: Microsoft Teams + +The Descending parameter sorts Call Queues in descending order ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -59,14 +62,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -ExcludeContent + +> Applicable: Microsoft Teams + +The ExcludeContent parameter only displays the Name and Id of the Call Queues ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -76,13 +81,17 @@ 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. + +> Applicable: Microsoft Teams + +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: Microsoft Teams Required: False Position: Named @@ -91,14 +100,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Skip -The Skip parameter skips the first N Call Queues. It is intended to be used for pagination purposes. +### -Identity + +> Applicable: Microsoft Teams + +PARAMVALUE: Guid ```yaml -Type: Int32 +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -107,64 +118,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeContent -The ExcludeContent parameter only displays the Name and Id of the Call Queues +### -NameFilter + +> Applicable: Microsoft Teams + +The NameFilter parameter returns Call Queues where name contains specified string ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Sort -The Sort parameter specifies the property used to sort. +### -Skip + +> Applicable: Microsoft Teams + +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: String +Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: Name +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Descending -The Descending parameter sorts Call Queues in descending order +### -Sort + +> Applicable: Microsoft Teams + +The Sort parameter specifies the property used to sort. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: None +Default value: Name Accept pipeline input: False Accept wildcard characters: False ``` -### -NameFilter -The NameFilter parameter returns Call Queues where name contains specified string +### -Tenant + +> Applicable: Microsoft Teams + +PARAMVALUE: Guid ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Get-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Get-CsCallingLineIdentity.md similarity index 83% rename from teams/teams-ps/teams/Get-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Get-CsCallingLineIdentity.md index bbd56f2336..04383ba4ec 100644 --- a/teams/teams-ps/teams/Get-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity applicable: Microsoft Teams -title: Get-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallinglineidentity +schema: 2.0.0 +title: Get-CsCallingLineIdentity --- # Get-CsCallingLineIdentity @@ -48,33 +49,37 @@ The example gets and displays the Caller ID policies with Identity starting with ## PARAMETERS -### -Identity -The Identity parameter identifies the Caller ID policy. +### -Filter + +> Applicable: Microsoft Teams + +The Filter parameter lets you insert a string through which your search results are filtered. ```yaml Type: String -Parameter Sets: (Identity) +Parameter Sets: (Filter) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter lets you insert a string through which your search results are filtered. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter identifies the Caller ID policy. ```yaml Type: String -Parameter Sets: (Filter) +Parameter Sets: (Identity) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -93,10 +98,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cscallinglineidentity) -[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallinglineidentity) -[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallinglineidentity) -[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md b/teams/teams-ps/MicrosoftTeams/Get-CsCloudCallDataConnection.md similarity index 90% rename from teams/teams-ps/teams/Get-CsCloudCallDataConnection.md rename to teams/teams-ps/MicrosoftTeams/Get-CsCloudCallDataConnection.md index f2b7e131f9..2cac377631 100644 --- a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsCloudCallDataConnection.md @@ -1,15 +1,15 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Get-CsCloudCallDataConnection -online version: https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection -schema: 2.0.0 author: 2012ucp1544 +external help file: MicrosoftTeams-help.xml +Locale: en-US +manager: subadjat +Module Name: MicrosoftTeams ms.author: uditagrawal ms.reviewer: pbafna -manager: subadjat - +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cscloudcalldataconnection +schema: 2.0.0 +title: Get-CsCloudCallDataConnection --- # Get-CsCloudCallDataConnection @@ -59,4 +59,4 @@ The Get-CsCloudCallDataConnection cmdlet is only supported in commercial environ ## RELATED LINKS [Configure Call Data Connector](https://learn.microsoft.com/skypeforbusiness/hybrid/configure-call-data-connector) -[New-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection) +[New-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscloudcalldataconnection) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/Get-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..f7e66eeabd --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Get-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,95 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: tomkau +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: Get-CsComplianceRecordingForCallQueueTemplate +--- + +# Get-CsComplianceRecordingForCallQueueTemplate + +## SYNOPSIS +Retrieves a Compliance Recording for Call Queues template. + +## 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 + +> Applicable: Microsoft Teams + +The Id parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### 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-CsEffectiveTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Get-CsEffectiveTenantDialPlan.md similarity index 91% rename from teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Get-CsEffectiveTenantDialPlan.md index e7be699f75..711d8ec146 100644 --- a/teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsEffectiveTenantDialPlan.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cseffectivetenantdialplan +schema: 2.0.0 +title: Get-CsEffectiveTenantDialPlan --- # Get-CsEffectiveTenantDialPlan @@ -28,7 +29,7 @@ the EnterpriseVoice features. The EffectiveTenantDialPlanName is in the form Ten ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsEffectiveTenantDialPlan -Identity Vt1_User1 ``` @@ -37,39 +38,46 @@ This example gets the effective tenant dial plan for the Vt1_User1. ## PARAMETERS -### -Identity -The Identity parameter is the unique identifier of the user for whom to retrieve the effective tenant dial plan. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: UserIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False -Position: 1 +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. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter is the unique identifier of the user for whom to retrieve the effective tenant dial plan. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -OU + +> Applicable: Microsoft Teams + **Note:** This parameter is not supported in Teams PowerShell Module version 3.0.0 or later. The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. @@ -79,7 +87,6 @@ Only objects that exist in the specified location are returned. Type: OUIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -89,6 +96,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + **Note:** This parameter is not supported in Teams PowerShell Module version 3.0.0 or later. Specifies the number of records returned by the cmdlet. @@ -99,7 +109,6 @@ If set to 0, the command will run, but no data will be returned. Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -109,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -116,7 +128,6 @@ 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 Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsExportAcquiredPhoneNumberStatus.md similarity index 77% rename from teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsExportAcquiredPhoneNumberStatus.md index 1571bfb68b..431ad0fee9 100644 --- a/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsExportAcquiredPhoneNumberStatus.md @@ -1,20 +1,20 @@ --- -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: +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus schema: 2.0.0 +title: Get-CsExportAcquiredPhoneNumberStatus --- # Get-CsExportAcquiredPhoneNumberStatus ## SYNOPSIS -This cmdlet shows the status of the [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) cmdlet. +This cmdlet shows the status of the [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/export-csacquiredphonenumber) cmdlet. ## SYNTAX @@ -24,7 +24,7 @@ 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. +This cmdlet returns OrderId status from the respective [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/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. @@ -41,7 +41,7 @@ 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. +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/microsoftteams/export-csacquiredphonenumber) cmdlet. The status contains the download link for the file along with expiry date. ### Example 2 ```powershell @@ -68,7 +68,7 @@ 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. +This example stores the [Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/microsoftteams/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 @@ -104,4 +104,4 @@ 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) +[Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus) diff --git a/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsExternalAccessPolicy.md similarity index 92% rename from teams/teams-ps/teams/Get-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsExternalAccessPolicy.md index 6b5e5dfbaa..a316bd1298 100644 --- a/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsExternalAccessPolicy.md @@ -1,21 +1,20 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csexternalaccesspolicy +schema: 2.0.0 +title: Get-CsExternalAccessPolicy --- # 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 @@ -32,6 +31,10 @@ Get-CsExternalAccessPolicy [-Tenant ] [-Include ] [-Applicab ``` ## DESCRIPTION +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. + 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. @@ -44,7 +47,7 @@ External access policies can grant (or revoke) the ability of your users to do a Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -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). +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/microsoftteams/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. @@ -55,7 +58,7 @@ The Get-CsExternalAccessPolicy cmdlet provides a way for you to return informati ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-CsExternalAccessPolicy ``` @@ -63,7 +66,7 @@ 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) +### EXAMPLE 2 (Skype for Business Online) ``` Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" ``` @@ -71,7 +74,7 @@ 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) +### EXAMPLE 2 (Skype for Business Server 2015) ``` Get-CsExternalAccessPolicy -Identity site:Redmond ``` @@ -79,7 +82,7 @@ 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 -------------------------- +### Example 3 ``` Get-CsExternalAccessPolicy -Filter tag:* ``` @@ -87,7 +90,7 @@ 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 -------------------------- +### Example 4 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} ``` @@ -96,7 +99,7 @@ In Example 4, the Get-CsExternalAccessPolicy cmdlet and the Where-Object cmdlet 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 -------------------------- +### Example 5 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True} ``` @@ -106,7 +109,7 @@ In order to perform this task, the command first uses the Get-CsExternalAccessPo 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 -------------------------- +### EXAMPLE 6 ``` Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com" ``` @@ -119,25 +122,30 @@ NOTE: This command requires the Office 365 UsageLocation property to be configur ## 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. +### -ApplicableTo -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. +> Applicable: Microsoft Teams -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. +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: XdsIdentity -Parameter Sets: Identity, (All) +Type: UserIdParameter +Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -182,42 +190,40 @@ 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. +### -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: This parameter is not used with Skype for Business Online. +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: SwitchParameter -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity, (All) Aliases: Required: False -Position: Named +Position: 2 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"` +### -Include -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. +> Applicable: Microsoft Teams -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. +PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly ```yaml -Type: UserIdParameter +Type: PolicyFilter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -226,14 +232,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Include -PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly +### -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: PolicyFilter +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -243,13 +250,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -273,10 +282,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/Get-CsGroupPolicyAssignment.md similarity index 95% rename from teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsGroupPolicyAssignment.md index 015cc6cfd9..52014124dc 100644 --- a/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsGroupPolicyAssignment.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment -title: Get-CsGroupPolicyAssignment +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csgrouppolicyassignment schema: 2.0.0 +title: Get-CsGroupPolicyAssignment --- # Get-CsGroupPolicyAssignment @@ -147,8 +148,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment) -[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csgrouppolicyassignment) -[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsHybridTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Get-CsHybridTelephoneNumber.md new file mode 100644 index 0000000000..d7571f2051 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Get-CsHybridTelephoneNumber.md @@ -0,0 +1,219 @@ +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cshybridtelephonenumber +schema: 2.0.0 +title: Get-CsHybridTelephoneNumber +--- + +# Get-CsHybridTelephoneNumber + +## SYNOPSIS +This cmdlet displays information about one or more hybrid telephone numbers. + +## SYNTAX + +### Get1 (Default) +``` +Get-CsHybridTelephoneNumber [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### Get +``` +Get-CsHybridTelephoneNumber -TelephoneNumber [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity +``` +Get-CsHybridTelephoneNumber -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION + +> [!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/microsoftteams/get-csphonenumberassignment) + +This cmdlet displays information about one or more hybrid telephone numbers used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + +Returned results are sorted by telephone number in ascending order. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsHybridTelephoneNumber -TelephoneNumber 14025551234 +``` +```output +Id O365Region SourceType TargetType TelephoneNumber UserId +-- ---------- ---------- ---------- --------------- ------ +14025551234 NOAM Hybrid 14025551234 00000000-0000-0000-0000-000000000000 +``` +This example displays information about the phone number +1 (402) 555-1234. + +### Example 2 +```powershell +Get-CsHybridTelephoneNumber +``` +```output +Id O365Region SourceType TargetType TelephoneNumber UserId +-- ---------- ---------- ---------- --------------- ------ +14025551234 Hybrid 14025551234 +14025551235 Hybrid 14025551235 +``` +This example displays information about all hybrid telephone numbers in the tenant. Note that O365Region, TargetType, and UserId will not be populated. + +## PARAMETERS + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +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: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +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: 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 + +### None + +## OUTPUTS + +### None + +## NOTES +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](https://learn.microsoft.com/powershell/module/microsoftteams/new-cshybridtelephonenumber) + +[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Get-CsInboundBlockedNumberPattern.md similarity index 86% rename from teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Get-CsInboundBlockedNumberPattern.md index bf831c5aa7..013c1438c8 100644 --- a/teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -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: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundblockednumberpattern schema: 2.0.0 +title: Get-CsInboundBlockedNumberPattern --- # Get-CsInboundBlockedNumberPattern @@ -89,8 +90,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundblockednumberpattern) -[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundblockednumberpattern) -[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Get-CsInboundExemptNumberPattern.md similarity index 83% rename from teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Get-CsInboundExemptNumberPattern.md index 9f59ffa49a..101c2289d8 100644 --- a/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundexemptnumberpattern +schema: 2.0.0 +title: Get-CsInboundExemptNumberPattern --- # Get-CsInboundExemptNumberPattern @@ -96,12 +96,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable 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) +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundexemptnumberpattern) -[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundexemptnumberpattern) -[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) -[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..42f0e9d432 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1,206 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csmainlineattendantappointmentbookingflow +schema: 2.0.0 +title: Get-CsMainlineAttendantAppointmentBookingFlow +--- + +# Get-CsMainlineAttendantAppointmentBookingFlow + +## SYNOPSIS +The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet returns the identified Mainline attendant appointment booking flow. + +## SYNTAX + +``` +Get-CsMainlineAttendantAppointmentBookingFlow [-Identity ] [-Tenant ] [-First ] [-Skip ] [-ExcludeContent ] [-Sort ] [-Descending ] [-NameFilter ] [] +``` + +## DESCRIPTION +The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet lets you retrieve information about the Mainline attendant appointment booking flows n your organization. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsMainlineAttendantAppointmentBookingFlow +``` + +This example gets the first 100 Mainline attendant appointment booking flows in the organization. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsMainlineAttendantAppointmentBookingFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example gets the Mainline attendant appointment booking flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no appointment booking flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Identity + +> Applicable: Microsoft Teams + +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +> Applicable: Microsoft Teams + +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First + +> Applicable: Microsoft Teams + +The First parameter gets the first N appointment flows, up to a maximum of 100 at a time. +When not specified, the default behavior is to return the first 100 appointment flows. 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: + +Required: False +Position: Named +Default value: 100 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip + +> Applicable: Microsoft Teams + +The Skip parameter skips the first N appointment flows. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeContent + +> Applicable: Microsoft Teams + +The ExcludeContent parameter only displays the Name and Id of the appointment flow. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort + +> Applicable: Microsoft Teams + +The Sort parameter specifies the property used to sort. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Name +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Descending + +> Applicable: Microsoft Teams + +The Descending parameter sorts appointment booking flows in descending order + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NameFilter + +> Applicable: Microsoft Teams + +The NameFilter parameter returns appointment booking flows where the name contains specified string + +```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 + +### Identity +Represents the unique identifier of an appointment booking flow. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md new file mode 100644 index 0000000000..1360745f2e --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md @@ -0,0 +1,122 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csmainlineattendantflow +schema: 2.0.0 +title: Get-CsMainlineAttendantFlow +--- + +# Get-CsMainlineAttendantFlow + +## SYNOPSIS +The Get-CsMainlineAttendantFlow cmdlet returns information about the Mainline Attendant flows configured in your organization + +## SYNTAX + +``` +Get-CsMainlineAttendantFlow [-MaConfigId ] [-Type ] [-FlowId ] [-Tenant ] [] +``` + +## DESCRIPTION +The Get-CsMainlineAttendantFlow cmdlet returns information about the Mainline Attendant flows configured in your organization. + +> [!CAUTION] +> This cmdlet 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. + +## EXAMPLES + +### Example 1 +``` +Get-CsMainlineAttendantFlow +``` + +This example will list all the Mainline Attendant flows in the tenant. + +### Example 2 +``` +Get-CsMainlineAttendantFlow -MaConfig 0b31bbe5-e2a0-4117-9b6f-956bca6023f8 +``` + +This example will list all the Mainline Attendant flows associated with the specific configuration id. + +### Example 3 +``` +Get-CsMainlineAttendantFlow -Type Type 1 | Type 2 +``` + +This example will list all the Mainline Attendant flows with the specified type. + +### Example 4 +``` +Get-CsMainlineAttendantFlow -FlowId 956bca6-e2a0-4117-9b6f-023f80b31bbe5 +``` + +This example will list the Mainline Attendant flow with the specified flow id. + +## PARAMETERS + +### -MaConfigId +The Mainline Attendant configuration Id + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The Mainline Attendant flow type + +PARAMVALUE: Appointment | QuestionAndAnswer + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowId +The Mainline Attendant flow id + +```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 + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..89ed9d9101 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1,183 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csmainlineattendantquestionanswerflow +schema: 2.0.0 +title: Get-CsMainlineAttendantQuestionAnswerFlow +--- + +# Get-CsMainlineAttendantQuestionAnswerFlow + +## SYNOPSIS +The Get-CsMainlineAttendantQuestionAnswerFlow cmdlet returns the identified Mainline attendant question and answer flow. + +## SYNTAX + +``` +Get-CsMainlineAttendantQuestionAnswerFlow [-Identity ] [-Tenant ] [-First ] [-Skip ] [-ExcludeContent ] [-Sort ] [-Descending ] [-NameFilter ] [] +``` + +## DESCRIPTION +The Get-CsMainlineAttendantQuestionAnswerFlow cmdlet lets you retrieve information about the Mainline attendant question and answer flows n your organization. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsMainlineAttendantQuestionAnswerFlow +``` + +This example gets the first 100 Mainline attendant question and answer flows in the organization. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsMainlineAttendantQuestionAnswerFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example gets the Mainline attendant question and answer flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no question and answer flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Identity +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +The First parameter gets the first N appointment flows, up to a maximum of 100 at a time. +When not specified, the default behavior is to return the first 100 question and answer flows. 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: + +Required: False +Position: Named +Default value: 100 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +The Skip parameter skips the first N appointment flows. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeContent +The ExcludeContent parameter only displays the Name and Id of the question and answer flow. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The Sort parameter specifies the property used to sort. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Name +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Descending +The Descending parameter sorts appointment booking flows in descending order + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NameFilter +The NameFilter parameter returns question and answer booking flows where the name contains specified string + +```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 + +### Identity +Represents the unique identifier of a question and answer booking flow. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + diff --git a/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsMeetingMigrationStatus.md similarity index 88% rename from teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsMeetingMigrationStatus.md index 36129dc3a8..8f62227b79 100644 --- a/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsMeetingMigrationStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csmeetingmigrationstatus +schema: 2.0.0 +title: Get-CsMeetingMigrationStatus --- # Get-CsMeetingMigrationStatus @@ -27,14 +29,14 @@ You can use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of mee ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMeetingMigrationStatus -SummaryOnly ``` This example is used to get a summary status of all MMS migrations. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingMigrationStatus -Identity "ashaw@contoso.com" ``` @@ -43,46 +45,52 @@ This example gets the meeting migration status for user ashaw@contoso.com. ## PARAMETERS -### -Identity -Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. +### -EndTime + +> Applicable: Microsoft Teams + +Specifies the end date of the date range. ```yaml -Type: UserIdParameter +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StartTime -Specifies the start date of the date range. +### -Identity + +> Applicable: Microsoft Teams + +Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. ```yaml -Type: Object +Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EndTime -Specifies the end date of the date range. +### -StartTime + +> Applicable: Microsoft Teams + +Specifies the start date of the date range. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -91,14 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SummaryOnly -Specified that you want a summary status of MMS migrations returned. +### -State + +> Applicable: Microsoft Teams + +With this parameter you can filter by migration state. Possible values are: + +- Pending +- InProgress +- Failed +- Succeeded ```yaml -Type: SwitchParameter +Type: StateType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -107,19 +122,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -State -With this parameter you can filter by migration state. Possible values are: +### -SummaryOnly -- Pending -- InProgress -- Failed -- Succeeded +> Applicable: Microsoft Teams + +Specified that you want a summary status of MMS migrations returned. ```yaml -Type: StateType +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -158,8 +170,8 @@ where **MigrationType** can have the following values: - **AllToTeams** (All types to Teams) ## RELATED LINKS -[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration) +[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantmigrationconfiguration) -[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings) +[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantsettings) -[Start-CsExMeetingMigration](https://learn.microsoft.com/powershell/module/teams/start-csexmeetingmigration) +[Start-CsExMeetingMigration](https://learn.microsoft.com/powershell/module/microsoftteams/start-csexmeetingmigration) diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstance.md similarity index 84% rename from teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstance.md index c153103192..cbf2226874 100644 --- a/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance applicable: Microsoft Teams -title: Get-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstance +schema: 2.0.0 +title: Get-CsOnlineApplicationInstance --- # Get-CsOnlineApplicationInstance @@ -26,27 +27,27 @@ This cmdlet is used to get details of an application instance. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineApplicationInstance -Identity appinstance01@contoso.com ``` This example returns the application instance with identity "appinstance01@contoso.com". -### -------------------------- Example 2 -------------------------- +### 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 -------------------------- +### Example 3 ```powershell Get-CsOnlineApplicationInstance -ResultSize 10 ``` This example returns the first 10 application instances. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell Get-CsOnlineApplicationInstance ``` @@ -55,46 +56,52 @@ This example returns the details of all application instances. ## PARAMETERS -### -Identity -The UPN or the object ID of the application instance to retrieve. If this parameter nor parameter Identities are not provided, it will retrieve all application instances in the tenant. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: None +Default value: False 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. +### -Force + +> Applicable: Microsoft Teams + +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ResultSize -The result size for bulk get. This parameter is currently not working. +### -Identities + +> Applicable: Microsoft Teams + +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.Int32 +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,14 +110,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Skip -Skips the first specified number of returned results. The default value is 0. This parameter is currently not working. +### -Identity + +> Applicable: Microsoft Teams + +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.Int32 +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,47 +128,53 @@ 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. +### -ResultSize + +> Applicable: Microsoft Teams + +The result size for bulk get. This parameter is currently not working. ```yaml -Type: SwitchParameter +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Skip + +> Applicable: Microsoft Teams + +Skips the first specified number of returned results. The default value is 0. This parameter is currently not working. ```yaml -Type: SwitchParameter +Type: System.Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -179,10 +194,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) -[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/sync-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation.md similarity index 81% rename from teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation.md index f837f328ee..20eaa4837f 100644 --- a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation +schema: 2.0.0 +title: Get-CsOnlineApplicationInstanceAssociation --- # Get-CsOnlineApplicationInstanceAssociation @@ -26,7 +28,7 @@ Use the Get-CsOnlineApplicationInstanceAssociation cmdlet to get information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineApplicationInstanceAssociation -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` @@ -36,13 +38,15 @@ This example gets the association object for the application instance that has t ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the application instance whose association is to be retrieved. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -53,11 +57,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -82,8 +87,8 @@ The Get-CsOnlineApplicationInstanceAssociation cmdlet accepts a string as the Id ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus) -[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation) -[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus.md similarity index 82% rename from teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus.md index bf4db93e15..6a4565478e 100644 --- a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus +schema: 2.0.0 +title: Get-CsOnlineApplicationInstanceAssociationStatus --- # Get-CsOnlineApplicationInstanceAssociationStatus @@ -26,7 +28,7 @@ Use the Get-CsOnlineApplicationInstanceAssociationStatus cmdlet to get provision ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineApplicationInstanceAssociationStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` @@ -36,13 +38,15 @@ This example gets the provisioning status for the association object of the appl ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the application instance whose association provisioning status is to be retrieved. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -53,11 +57,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -82,8 +87,8 @@ The Get-CsOnlineApplicationInstanceAssociationStatus cmdlet accepts a string as ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation) -[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation) -[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioConferencingRoutingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioConferencingRoutingPolicy.md index e2a5e510e0..2b7bfa2a75 100644 --- a/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,120 +1,121 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudioconferencingroutingpolicy -title: Get-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# Get-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet retrieves all online audio conferencing routing policies for the tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Get-CsOnlineAudioConferencingRoutingPolicy +--- + +# Get-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet retrieves all online audio conferencing routing policies for the tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-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/teams/teams-ps/teams/Get-CsOnlineAudioFile.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioFile.md similarity index 82% rename from teams/teams-ps/teams/Get-CsOnlineAudioFile.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioFile.md index 65d7fc94b4..01c4a767fc 100644 --- a/teams/teams-ps/teams/Get-CsOnlineAudioFile.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioFile.md @@ -1,14 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: - +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineaudiofile +schema: 2.0.0 +title: Get-CsOnlineAudioFile --- # Get-CsOnlineAudioFile @@ -18,8 +17,9 @@ Returns information about a specific or all uploaded audio files of a given appl ## SYNTAX -```powershell -Get-CsOnlineAudioFile [[-Identity] ] [-ApplicationId ] [] +``` +Get-CsOnlineAudioFile [-Identity ] [-ApplicationId ] [-HttpPipelinePrepend ] + [] ``` ## DESCRIPTION @@ -81,7 +81,7 @@ Supported values: - TenantGlobal ```yaml -Type: System.string +Type: System.String Parameter Sets: (All) Aliases: @@ -92,6 +92,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. @@ -103,13 +118,14 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -125,8 +141,8 @@ 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) +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/export-csonlineaudiofile) -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) -[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineaudiofile) diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge.md index 8668124a9a..0d209da0de 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingBridge -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingBridge --- # Get-CsOnlineDialInConferencingBridge @@ -41,14 +43,14 @@ However, if the PSTN conferencing service status of the tenant is Disabled, no r ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineDialInConferencingBridge | fl ``` This example shows how to return all of the audio conferencing bridges that are being used and returns the results in a formatted list. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsOnlineDialInConferencingBridge -Tenant 26efe125-c070-46f9-8ed0-fc02165a167c ``` @@ -57,30 +59,47 @@ This example shows how to return all of the audio conferencing bridges for the g ## PARAMETERS -### -Identity -Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. +### -DomainController + +> Applicable: Skype for Business Online + +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): + +`-DomainController atl-cs-001.Contoso.com` + +Computer name: + +`-DomainController atl-cs-001` + +This parameter is reserved for internal Microsoft use. ```yaml -Type: Guid +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: DC Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Specifies the name of the audio conferencing bridge. +### -Force + +> Applicable: Skype for Business Online + +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: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -89,43 +108,34 @@ 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 include: - -Fully qualified domain name (FQDN): +### -Identity -`-DomainController atl-cs-001.Contoso.com` +> Applicable: Skype for Business Online -Computer name: - -`-DomainController atl-cs-001` - -This parameter is reserved for internal Microsoft use. +Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. ```yaml -Type: Fqdn +Type: Guid Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 1 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. +### -Name + +> Applicable: Skype for Business Online + +Specifies the name of the audio conferencing bridge. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -135,13 +145,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -151,13 +163,15 @@ Accept wildcard characters: False ``` ### -TenantDomain + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported.md similarity index 95% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported.md index b8c773dd60..1fefa9da95 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinglanguagessupported applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingLanguagesSupported -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinglanguagessupported +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingLanguagesSupported --- # Get-CsOnlineDialInConferencingLanguagesSupported @@ -30,7 +32,7 @@ When no languages are specified for a dial-in service number it will get the set ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineDialInConferencingLanguagesSupported | fl ``` @@ -40,6 +42,9 @@ This example allows returns the list of supported languages when you are using M ## PARAMETERS ### -DomainController + +> Applicable: Skype for Business Online + Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter include: @@ -51,7 +56,6 @@ Computer name: `-DomainController atl-cs-001` Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online Required: False Position: Named @@ -61,6 +65,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + 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. @@ -69,7 +76,6 @@ 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 Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber.md index daa9adb621..8818af882e 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingServiceNumber --- # Get-CsOnlineDialInConferencingServiceNumber @@ -54,21 +56,21 @@ A tenant administrator can only retrieve and view information that is associated ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialInConferencingServiceNumber | fl ``` This example returns all of the default service numbers for an organization in a formatted list. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineDialInConferencingServiceNumber -BridgeId 72dfe128-d079-46f8-8tr0-gb12369p167c | fl ``` This example returns all of the default service numbers for a specified audio conferencing bridge in a formatted list. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOnlineDialInConferencingBridge -Name "Conference Bridge" ``` @@ -78,6 +80,9 @@ This example returns all of the default service numbers for the audio conferenci ## PARAMETERS ### -BridgeId + +> Applicable: Microsoft Teams + Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. When it's used it returns all of the service numbers that are configured on the audio conferencing bridge. @@ -85,7 +90,6 @@ When it's used it returns all of the service numbers that are configured on the Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -94,30 +98,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the default dial-in service number string. +### -BridgeName + +> Applicable: Microsoft Teams + +Specifies the name of the audio conferencing bridge. +When it is used it returns all of the service numbers that are configured on the audio conferencing bridge. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -City + +> Applicable: Microsoft Teams + +Specifies the city geocode to be used. +When used it lists all of the service numbers for a specific city geocode. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -126,14 +136,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantDomain -This parameter is reserved for internal Microsoft use. +### -DomainController + +> Applicable: Microsoft Teams + +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): `-DomainController atl-cs-001.Contoso.com.` + +Computer name: `-DomainController atl-cs-001` ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False Position: Named @@ -142,15 +159,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeName -Specifies the name of the audio conferencing bridge. -When it is used it returns all of the service numbers that are configured on the audio conferencing bridge. +### -Force + +> Applicable: Microsoft Teams + +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: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -159,36 +179,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -City -Specifies the city geocode to be used. -When used it lists all of the service numbers for a specific city geocode. +### -Identity + +> Applicable: Microsoft Teams + +Specifies the default dial-in service number string. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 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 include: +### -ResultSize -Fully qualified domain name (FQDN): `-DomainController atl-cs-001.Contoso.com.` +> Applicable: Microsoft Teams -Computer name: `-DomainController atl-cs-001` +Specifies 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. +If set to 0 the command will run, but no data will be returned. +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: Fqdn +Type: Int32 Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -197,16 +221,16 @@ 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. +### -Tenant + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -215,20 +239,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResultSize -Specifies 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. +### -TenantDomain -The result size can be set to any whole number between 0 and 2147483647, inclusive. -If set to 0 the command will run, but no data will be returned. -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. +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings.md index 5f1ea406de..7e4eda4d45 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantsettings +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingTenantSettings --- # Get-CsOnlineDialInConferencingTenantSettings @@ -33,7 +35,7 @@ Get-CsOnlineDialInConferencingTenantSettings [-Tenant ] [-Filter ] ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialInConferencingTenantSettings ``` @@ -43,13 +45,15 @@ This example returns the global setting for the tenant administrator's organizat ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -59,13 +63,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -75,13 +81,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Microsoft Teams + Retrieves the settings from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -91,13 +99,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingUser.md similarity index 93% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingUser.md index 7c7a3686cb..c99c0c891a 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingUser.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencinguser +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingUser --- # Get-CsOnlineDialInConferencingUser @@ -43,7 +45,7 @@ The see a list of users with conferencing providers other than Microsoft use the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineDialInConferencingUser -Identity Ken.Myer@contoso.com ``` @@ -54,6 +56,8 @@ This example uses the User Principal Name (UPN) to retrieve the BridgeID and Ser ### -BridgeId +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. @@ -62,7 +66,6 @@ Specifies the globally-unique identifier (GUID) for the audio conferencing bridg Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -73,6 +76,8 @@ Accept wildcard characters: False ### -BridgeName +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. Specifies the name for the audio conferencing bridge. @@ -81,7 +86,6 @@ Specifies the name for the audio conferencing bridge. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -90,37 +94,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -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: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -DomainController -### -ServiceNumber +> Applicable: Microsoft Teams *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. -Specifies a service number to serve as a filter for the returned user collection. -Only users who have been assigned the specified number will be returned. -The service number can be specified in the following formats: E.164 number, +\ and tel:\. +This parameter is reserved for internal Microsoft use. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False Position: Named @@ -129,17 +114,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -Force + +> Applicable: Microsoft Teams *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. -This parameter is reserved for internal Microsoft use. +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: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -148,22 +136,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -Identity -*This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. +> Applicable: Microsoft Teams -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. +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: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -171,6 +158,8 @@ Accept wildcard characters: False ### -LdapFilter +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). @@ -182,7 +171,6 @@ For example, a filter that returns only users who work in the city of Redmond wo Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -192,6 +180,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + 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. @@ -203,7 +194,28 @@ If you set the ResultSize to 7 but you have only three users in your forest, the Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceNumber + +> Applicable: Microsoft Teams + +*This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. + +Specifies a service number to serve as a filter for the returned user collection. +Only users who have been assigned the specified number will be returned. +The service number can be specified in the following formats: E.164 number, +\ and tel:\. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -214,6 +226,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. NOTE: This parameter is reserved for internal Microsoft use. @@ -228,7 +242,6 @@ You can find your tenant ID by running this command: Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -239,6 +252,8 @@ Accept wildcard characters: False ### -TenantDomain +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. This parameter is reserved for internal Microsoft use. @@ -247,7 +262,6 @@ This parameter is reserved for internal Microsoft use. Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -268,4 +282,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineDialInConferencingUser](https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencinguser) +[Set-CsOnlineDialInConferencingUser](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinedialinconferencinguser) diff --git a/teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialOutPolicy.md similarity index 94% rename from teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialOutPolicy.md index 050f8fa643..f111b18c50 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialOutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialoutpolicy applicable: Microsoft Teams -title: Get-CsOnlineDialOutPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialoutpolicy +schema: 2.0.0 +title: Get-CsOnlineDialOutPolicy --- # Get-CsOnlineDialOutPolicy @@ -97,4 +98,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Grant-CsDialoutPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csdialoutpolicy) +[Grant-CsDialoutPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csdialoutpolicy) diff --git a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy.md index 44a0e83fd6..4b32244b79 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingpolicy applicable: Microsoft Teams -title: Get-CsOnlineDialinConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingpolicy +schema: 2.0.0 +title: Get-CsOnlineDialinConferencingPolicy --- # Get-CsOnlineDialinConferencingPolicy @@ -32,7 +34,7 @@ Retrieves the available Dial-in Conferencing policies in the tenant. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialinConferencingPolicy ``` @@ -42,13 +44,15 @@ This example retrieves all the available Dial in Conferencing policies in the te ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + 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: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -58,13 +62,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + A unique identifier specifying the scope and, in some cases the name, of the policy. If this parameter is omitted, all policies for the organization are returned. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -74,13 +80,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Microsoft Teams + Reserved for Microsoft Internal use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration.md index 7c1dbe713c..3943604e5f 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantconfiguration applicable: Microsoft Teams -title: Get-CsOnlineDialinConferencingTenantConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantconfiguration +schema: 2.0.0 +title: Get-CsOnlineDialinConferencingTenantConfiguration --- # Get-CsOnlineDialinConferencingTenantConfiguration ## SYNOPSIS Use the Get-CsOnlineDialinConferencingTenantConfiguration cmdlet to retrieve the tenant level configuration for dial-in conferencing. -The dial-in conferencing configuration specifies if dial-in conferencing is enabled for the tenant. ## SYNTAX @@ -42,7 +43,7 @@ There is one configuration per tenant. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialinConferencingTenantConfiguration ``` @@ -52,13 +53,15 @@ This example returns the configuration for the tenant administrator's organizati ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Microsoft Teams + Retrieves the configuration from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDirectoryTenant.md similarity index 90% rename from teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDirectoryTenant.md index 35a0ee1afb..62f8a563ef 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDirectoryTenant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedirectorytenant applicable: Microsoft Teams -title: Get-CsOnlineDirectoryTenant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedirectorytenant +schema: 2.0.0 +title: Get-CsOnlineDirectoryTenant --- # Get-CsOnlineDirectoryTenant @@ -28,7 +30,7 @@ Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve tenant parameters like An ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDirectoryTenant -Tenant 7a205197-8e59-487d-b9fa-3fc1b108f1e5 ``` @@ -38,13 +40,15 @@ This example returns the tenant specified by GUID. ## PARAMETERS ### -Confirm + +> Applicable: Microsoft Teams + 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 @@ -54,6 +58,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + 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. @@ -61,7 +68,6 @@ Valid inputs for this parameter are either the fully qualified domain name (FQDN Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -71,6 +77,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -79,7 +88,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -89,6 +97,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. For example: @@ -102,7 +113,6 @@ You can find your tenant ID by running this command: Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -112,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -119,7 +132,6 @@ 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 Required: False Position: Named @@ -143,4 +155,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber) +[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md similarity index 87% rename from teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md index 4c7b04e076..104817dfbf 100644 --- a/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Get-CsOnlineEnhancedEmergencyServiceDisclaimer --- # Get-CsOnlineEnhancedEmergencyServiceDisclaimer @@ -26,7 +28,7 @@ You can use this cmdlet to determine whether your organization has accepted the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion "US" ``` @@ -36,6 +38,9 @@ This example returns your organization's enhanced emergency service terms and co ## PARAMETERS ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies the region or country whose terms and conditions you wish to verify. The United States is currently the only country supported, but it must be specified as "US". @@ -43,7 +48,6 @@ The United States is currently the only country supported, but it must be specif Type: CountryInfo Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -53,13 +57,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -69,6 +75,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -77,7 +86,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -87,13 +95,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +113,15 @@ Accept wildcard characters: False ``` ### -Version + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -132,4 +144,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/teams/set-csonlineenhancedemergencyservicedisclaimer) +[Set-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineenhancedemergencyservicedisclaimer) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisCivicAddress.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisCivicAddress.md index 3a889df518..565c55536e 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisCivicAddress.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress applicable: Microsoft Teams -title: Get-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliscivicaddress +schema: 2.0.0 +title: Get-CsOnlineLisCivicAddress --- # Get-CsOnlineLisCivicAddress @@ -46,6 +47,8 @@ This example returns all the civic addresses in the city of Seattle. ### -AssignmentStatus +> Applicable: Microsoft Teams + **Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. Specifies whether the retrieved addresses have been assigned to users or not. @@ -55,7 +58,6 @@ Valid inputs are "Assigned", or "Unassigned". Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -65,13 +67,15 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Microsoft Teams + Specifies the city of the target civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -81,13 +85,15 @@ Accept wildcard characters: False ``` ### -CivicAddressId + +> Applicable: Microsoft Teams + Specifies the identity of the civic address to return. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -97,13 +103,15 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies the country or region of the target civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -113,13 +121,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the target civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -129,6 +139,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -137,7 +150,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -147,13 +159,15 @@ Accept wildcard characters: False ``` ### -LocationId + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -163,6 +177,9 @@ Accept wildcard characters: False ``` ### -NumberOfResultsToSkip + +> Applicable: Microsoft Teams + Specifies the number of results to skip. If there are a large number of civic addresses, you can limit the number of results by using the ResultSize parameter. If you limited the first cmdlet execution to 25 results, and want to look at the next 25 locations, then you leave ResultSize at 25 and set NumberOfResultsToSkip to 25 to omit the first 25 you've reviewed. @@ -174,7 +191,6 @@ For example the command below will return civic addresses 26-50 for Seattle. Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -184,13 +200,15 @@ Accept wildcard characters: False ``` ### -PopulateNumberOfTelephoneNumbers + +> Applicable: Microsoft Teams + If present, the PopulateNumberOfTelephoneNumbers switch causes the cmdlet to provide the number of phone numbers at the returned addresses. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -200,13 +218,15 @@ Accept wildcard characters: False ``` ### -PopulateNumberOfVoiceUsers + +> Applicable: Microsoft Teams + If present, the PopulateNumberOfVoiceUsers switch causes the cmdlet to provide the number of voice users at the returned addresses. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -216,13 +236,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + Specifies the maximum number of results to return. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -232,6 +254,9 @@ Accept wildcard characters: False ``` ### -ValidationStatus + +> Applicable: Microsoft Teams + Specifies the validation status of the addresses to be returned. Valid inputs are: Valid, Invalid, and Notvalidated. @@ -239,7 +264,6 @@ Valid inputs are: Valid, Invalid, and Notvalidated. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -258,8 +282,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliscivicaddress) -[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineliscivicaddress) -[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisLocation.md similarity index 90% rename from teams/teams-ps/teams/Get-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisLocation.md index 2fb1346e9a..27d43f95e0 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation applicable: Microsoft Teams -title: Get-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelislocation +schema: 2.0.0 +title: Get-CsOnlineLisLocation --- # Get-CsOnlineLisLocation @@ -79,69 +80,57 @@ This example returns the information on one location specified by its unique ide ## PARAMETERS -### -CivicAddressId -Specifies the identification number of the civic address that is associated with the target locations. +### -AssignmentStatus -```yaml -Type: Guid -Parameter Sets: UseCivicAddressId -Aliases: -Applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. -### -Location -Specifies an administrator defined description of the location to retrieve. -For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". +Specifies whether the retrieved locations have been assigned to users or not. +Valid inputs are "Assigned", or "Unassigned". ```yaml Type: String -Parameter Sets: UseLocation +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AssignmentStatus +### -City -**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. +> Applicable: Microsoft Teams -Specifies whether the retrieved locations have been assigned to users or not. -Valid inputs are "Assigned", or "Unassigned". +Specifies the city of the target location. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -City -Specifies the city of the target location. +### -CivicAddressId + +> Applicable: Microsoft Teams + +Specifies the identification number of the civic address that is associated with the target locations. ```yaml -Type: String -Parameter Sets: (All) +Type: Guid +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True @@ -149,13 +138,15 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies the country or region of the target location. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -165,13 +156,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the civic address that is associated with the target locations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -181,6 +174,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -189,7 +185,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -198,14 +193,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Location + +> Applicable: Microsoft Teams + +Specifies an administrator defined description of the location to retrieve. +For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". + +```yaml +Type: String +Parameter Sets: UseLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocationId + +> Applicable: Microsoft Teams + Specifies the unique identifier of the target location. ```yaml Type: Guid Parameter Sets: UseLocationId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -215,6 +231,9 @@ Accept wildcard characters: False ``` ### -NumberOfResultsToSkip + +> Applicable: Microsoft Teams + Specifies the number of results to skip. If there are a large number of locations, you can limit the number of results by using the ResultSize parameter. If you limited the first cmdlet execution to 25 results, and want to look at the next 25 locations, then you leave ResultSize at 25 and set NumberOfResultsToSkip to 25 to omit the first 25 you've reviewed. @@ -226,7 +245,6 @@ For example the command below will return locations 26-50 for Seattle. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -236,13 +254,15 @@ Accept wildcard characters: False ``` ### -PopulateNumberOfTelephoneNumbers + +> Applicable: Microsoft Teams + If present, the PopulateNumberOfTelephoneNumbers switch causes the cmdlet to provide the number of telephone numbers at the returned locations. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -252,13 +272,15 @@ Accept wildcard characters: False ``` ### -PopulateNumberOfVoiceUsers + +> Applicable: Microsoft Teams + If present, the PopulateNumberOfVoiceUsers switch causes the cmdlet to provide the number of voice users at the returned locations. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -268,13 +290,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + Specifies the maximum number of results to return. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -284,6 +308,9 @@ Accept wildcard characters: False ``` ### -ValidationStatus + +> Applicable: Microsoft Teams + Specifies the validation status of the addresses to be returned. Valid inputs are: Validated, Invalid, and Notvalidated. @@ -291,7 +318,6 @@ Valid inputs are: Validated, Invalid, and Notvalidated. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -309,14 +335,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Returns an instance, or instances of emergency location objects. +### PSObject +Returns an instance, or instances of emergency location objects. ## NOTES ## RELATED LINKS -[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelislocation) -[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinelislocation) -[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelislocation) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisPort.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisPort.md similarity index 85% rename from teams/teams-ps/teams/Get-CsOnlineLisPort.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisPort.md index 190850463c..e08da26adc 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisPort.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisPort.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport applicable: Microsoft Teams -title: Get-CsOnlineLisPort -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisport +schema: 2.0.0 +title: Get-CsOnlineLisPort --- # Get-CsOnlineLisPort ## SYNOPSIS -Retrieves one or more ports from the location configuration database. Each port can be associated with a location, in which case this cmdlet will also retrieve the location information of the ports. This location association 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. +Retrieves one or more ports from the location configuration database. ## SYNTAX @@ -21,6 +22,8 @@ Get-CsOnlineLisPort [[-ChassisID] ] [-Force] [-IsDebug ] [-NCSApiU ``` ## DESCRIPTION +Each port can be associated with a location, in which case this cmdlet will also retrieve the location information of the ports. This location association 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. + Enhanced 9-1-1 allows an emergency operator to identify the location of a caller without having to ask the caller for that information. In the case where a caller is calling from a Voice over Internet Protocol (VoIP) connection, that information must be extracted based on various connection factors. The VoIP administrator must configure a location map (called a wiremap) that will determine a caller's location. This cmdlet retrieves information on associations between physical locations and the port through which the client is connected. ## EXAMPLES @@ -53,13 +56,15 @@ Example 2 retrieves the location information for port G1/0/30 with ChassisID B8- ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -69,6 +74,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -77,7 +85,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -87,13 +94,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +112,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +130,15 @@ Accept wildcard characters: False ``` ### -PortID + +> Applicable: Microsoft Teams + This parameter identifies the ID of the port. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -135,13 +148,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -167,6 +182,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport) +[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisport) -[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport) +[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisport) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSubnet.md similarity index 82% rename from teams/teams-ps/teams/Get-CsOnlineLisSubnet.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSubnet.md index 7aff6725b1..a0afbc412e 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSubnet.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelissubnet applicable: Microsoft Teams -title: Get-CsOnlineLisSubnet -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelissubnet +schema: 2.0.0 +title: Get-CsOnlineLisSubnet --- # Get-CsOnlineLisSubnet ## SYNOPSIS -Retrieves one or more subnets from the location configuration database. Each subnet can be associated with a location, in which case this cmdlet will also retrieve the location information of the subnets. This location association 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. +Retrieves one or more subnets from the location configuration database. ## SYNTAX @@ -22,27 +23,29 @@ Get-CsOnlineLisSubnet [[-TenantId] ] [[-Subnet] ] [-IsDebug Applicable: Microsoft Teams + 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. @@ -60,7 +66,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -70,13 +75,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -86,13 +93,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -102,13 +111,15 @@ Accept wildcard characters: False ``` ### -Subnet + +> Applicable: Microsoft Teams + The IP address of the subnet. This value can be either IPv4 or IPv6 format. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -118,13 +129,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -134,13 +147,15 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 diff --git a/teams/teams-ps/teams/Get-CsOnlineLisSwitch.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSwitch.md similarity index 84% rename from teams/teams-ps/teams/Get-CsOnlineLisSwitch.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSwitch.md index c5be65a3ec..02432b310f 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisSwitch.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSwitch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch applicable: Microsoft Teams -title: Get-CsOnlineLisSwitch -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisswitch +schema: 2.0.0 +title: Get-CsOnlineLisSwitch --- # Get-CsOnlineLisSwitch ## SYNOPSIS -Retrieves one or more network switches from the location configuration database. Each switch can be associated with a location, in which case this cmdlet will also retrieve the location information of the switches. This location association 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. +Retrieves one or more network switches from the location configuration database. ## SYNTAX @@ -21,6 +22,8 @@ Get-CsOnlineLisSwitch [[-ChassisID] ] [-Force] [-IsDebug ] [-NCSAp ``` ## DESCRIPTION +Each switch can be associated with a location, in which case this cmdlet will also retrieve the location information of the switches. This location association 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. + Enhanced 9-1-1 allows an emergency operator to identify the location of a caller without having to ask the caller for that information. In the case where a caller is calling from a Voice over Internet Protocol (VoIP) connection, that information must be extracted based on various connection factors. The VoIP administrator must configure a location map (called a wiremap) that will determine a caller's location. This cmdlet retrieves information on associations between physical locations and the network switch through which the client is connected. ## EXAMPLES @@ -53,13 +56,15 @@ Example 2 retrieves Location Information Server (LIS) switch "B8-BE-BF-4A-A3-00" ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -69,6 +74,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -77,7 +85,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -87,13 +94,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +112,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +130,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -151,6 +164,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch) +[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisswitch) -[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch) +[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisswitch) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint.md similarity index 87% rename from teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint.md index a8526f7ab2..2151a67375 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint applicable: Microsoft Teams -title: Get-CsOnlineLisWirelessAccessPoint -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliswirelessaccesspoint +schema: 2.0.0 +title: Get-CsOnlineLisWirelessAccessPoint --- # Get-CsOnlineLisWirelessAccessPoint ## SYNOPSIS -Retrieves one or more wireless access points (WAPs) from the location configuration database. Each WAP can be associated with a location, in which case this cmdlet will also retrieve the location information of the WAPs. This location association 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. +Retrieves one or more wireless access points (WAPs) from the location configuration database. ## SYNTAX @@ -21,6 +22,8 @@ Get-CsOnlineLisWirelessAccessPoint [[-BSSID] ] [-Force] [-IsDebug ``` ## DESCRIPTION +Each WAP can be associated with a location, in which case this cmdlet will also retrieve the location information of the WAPs. This location association 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. + Enhanced 9-1-1 allows an emergency operator to identify the location of a caller without having to ask the caller for that information. In the case where a caller is calling from a Voice over Internet Protocol (VoIP) connection, that information must be extracted based on various connection factors. The VoIP administrator must configure a location map (called a wiremap) that will determine a caller's location. This cmdlet retrieves information on associations between physical locations and the WAP through which the client is connected. The BSSID (Basic Service Set Identifiers) is used to describe sections of a wireless local area network. It is the MAC of the 802.11 side of the access point. The BSSID parameter in this command also supports the wildcard format to cover all BSSIDs in the range which are sharing the same description and Location ID. The wildcard '*' can be on either the last one or two character(s). @@ -82,13 +85,15 @@ Example 4 retrieves Location Information Server (LIS) wireless access point "F0- ## PARAMETERS ### -BSSID + +> Applicable: Microsoft Teams + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. It can be presented in wildcard format. The wildcard '*' can be on either the last one or two character(s). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -106,7 +114,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -178,6 +191,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint) +[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliswirelessaccesspoint) -[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint) +[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliswirelessaccesspoint) diff --git a/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePSTNGateway.md similarity index 88% rename from teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlinePSTNGateway.md index c7574f56ce..5ac8b1b2a6 100644 --- a/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePSTNGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway applicable: Microsoft Teams -title: Get-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstngateway +schema: 2.0.0 +title: Get-CsOnlinePSTNGateway --- # Get-CsOnlinePSTNGateway @@ -50,11 +51,12 @@ This example selects all SBCs with identities matching the pattern *.contoso.com ### -Filter +> Applicable: Microsoft Teams + ```yaml Type: String Parameter Sets: Filter Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -63,13 +65,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The parameter is optional for the cmdlet. If not set all SBCs paired to the tenant are listed. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -92,8 +96,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstngateway) -[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinepstngateway) -[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinepstngateway) diff --git a/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePstnUsage.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlinePstnUsage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlinePstnUsage.md index c70a50caf0..ce8422aba9 100644 --- a/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePstnUsage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstnusage applicable: Microsoft Teams -title: Get-CsOnlinePstnUsage -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstnusage +schema: 2.0.0 +title: Get-CsOnlinePstnUsage --- # Get-CsOnlinePstnUsage @@ -34,7 +35,7 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CSOnlinePSTNUsage ``` @@ -87,4 +88,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstnusage) +[Set-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstnusage) diff --git a/teams/teams-ps/teams/Get-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSchedule.md similarity index 83% rename from teams/teams-ps/teams/Get-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineSchedule.md index 9b0227da05..0e9015c94b 100644 --- a/teams/teams-ps/teams/Get-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineschedule +schema: 2.0.0 +title: Get-CsOnlineSchedule --- # Get-CsOnlineSchedule @@ -26,14 +28,14 @@ The Get-CsOnlineSchedule cmdlet returns information about the schedules in your ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineSchedule ``` This example retrieves all schedules that belong to your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineSchedule -Id "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` @@ -43,13 +45,15 @@ This example gets the schedules that has the Id of f7a821dc-2d69-5ae8-8525-bcb4a ## PARAMETERS ### -Id + +> Applicable: Microsoft Teams + The Id for the schedule to be retrieved. If this parameter is not specified, then all schedules in the organization are returned. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 @@ -74,8 +78,8 @@ The Get-CsOnlineSchedule cmdlet accepts a string as the Id parameter. ## RELATED LINKS -[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange) +[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetimerange) -[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange) +[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedatetimerange) -[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) diff --git a/teams/teams-ps/teams/Get-CsOnlineSipDomain.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSipDomain.md similarity index 90% rename from teams/teams-ps/teams/Get-CsOnlineSipDomain.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineSipDomain.md index 0627f86a2a..e2f40e09e2 100644 --- a/teams/teams-ps/teams/Get-CsOnlineSipDomain.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSipDomain.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain applicable: Microsoft Teams -title: Get-CsOnlineSipDomain -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinesipdomain +schema: 2.0.0 +title: Get-CsOnlineSipDomain --- # Get-CsOnlineSipDomain @@ -43,13 +45,15 @@ List all disabled online SIP domains in the tenant. ## PARAMETERS ### -Domain + +> Applicable: Microsoft Teams + A specific domain to get the status of. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -58,6 +62,9 @@ Accept wildcard characters: False ``` ### -DomainStatus + +> Applicable: Microsoft Teams + This indicates the status of an online sip domain, which can be either enabled or disabled. ```yaml @@ -65,7 +72,6 @@ Type: DomainStatus Parameter Sets: (All) Aliases: Accepted values: All, Enabled, Disabled -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -88,8 +94,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain) +[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/disable-csonlinesipdomain) -[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/enable-csonlinesipdomain) +[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/enable-csonlinesipdomain) [Cloud consolidation for Teams and Skype for Business](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumber.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumber.md index 0fced81daf..f0d5299be4 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber applicable: Microsoft Teams -title: Get-CsOnlineTelephoneNumber -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumber +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumber --- # Get-CsOnlineTelephoneNumber @@ -15,8 +16,6 @@ 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](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 ``` @@ -24,19 +23,22 @@ Get-CsOnlineTelephoneNumber [-ActivationState ] [-Assigned Get-CsOnlineTelephoneNumber -TelephoneNumber 19294450177 ``` This example gets the attributes of a specific phone number. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineTelephoneNumber -CapitalOrMajorCity NOAM-US-NY-NY ``` @@ -82,13 +84,15 @@ This example gets the phone numbers with the city code designating New York, New ## PARAMETERS ### -ActivationState + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -Assigned + +> Applicable: Microsoft Teams + Specifies the function of the telephone number. The acceptable values are: @@ -111,7 +118,6 @@ The values for the Assigned parameter are case-sensitive. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -121,6 +127,9 @@ Accept wildcard characters: False ``` ### -CapitalOrMajorCity + +> Applicable: Microsoft Teams + Specifies the city by a concatenated string in the form: region-country-area-city. For example, "NOAM-US-OR-PO" would specify Portland, Oregon. @@ -130,7 +139,6 @@ The values for the CapitalOrMajorCity parameter are case-sensitive. Type: String Parameter Sets: (All) Aliases: CityCode -applicable: Microsoft Teams Required: False Position: Named @@ -140,13 +148,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -156,13 +166,15 @@ Accept wildcard characters: False ``` ### -ExpandLocation + +> Applicable: Microsoft Teams + Displays the location parameter with its value. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -172,6 +184,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -180,7 +195,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -190,6 +204,9 @@ Accept wildcard characters: False ``` ### -InventoryType + +> Applicable: Microsoft Teams + Specifies the target telephone number type for the cmdlet. Acceptable values are: @@ -203,7 +220,6 @@ The values for the InventoryType parameter are case-sensitive. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -213,13 +229,15 @@ Accept wildcard characters: False ``` ### -IsNotAssigned + +> Applicable: Microsoft Teams + Specifying this switch parameter will return only telephone numbers which are not assigned. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -229,6 +247,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + Specifies the number of records returned by the cmdlet. The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0, the command will run, but no data will be returned. @@ -237,7 +258,6 @@ If set to 0, the command will run, but no data will be returned. Type: UInt32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -247,6 +267,9 @@ Accept wildcard characters: False ``` ### -TelephoneNumber + +> Applicable: Microsoft Teams + Specifies the target telephone number. For example: @@ -256,7 +279,6 @@ For example: Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -266,6 +288,9 @@ Accept wildcard characters: False ``` ### -TelephoneNumberGreaterThan + +> Applicable: Microsoft Teams + Specifies a telephone number used by the cmdlet as the lower boundary of the telephone numbers returned. The telephone numbers returned will all be greater than the number provided. The telephone number should be in E.164 format. @@ -274,7 +299,6 @@ The telephone number should be in E.164 format. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -284,6 +308,9 @@ Accept wildcard characters: False ``` ### -TelephoneNumberLessThan + +> Applicable: Microsoft Teams + Specifies a telephone number used by the cmdlet as the upper boundary of the telephone numbers returned. The telephone numbers returned will all be less than the number provided. The telephone number should be in E.164 format. @@ -292,7 +319,6 @@ The telephone number should be in E.164 format. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -302,6 +328,9 @@ Accept wildcard characters: False ``` ### -TelephoneNumberStartsWith + +> Applicable: Microsoft Teams + Specifies the digits that the returned telephone numbers must begin with. To return numbers in the North American Numbering Plan 425 area code, use this syntax: -TelephoneNumberStartsWith 1425. To return numbers that are in the 206 area code and that begin with 88, use this syntax: -TelephoneNumberStartsWith 120688. @@ -311,7 +340,6 @@ You can use up to nine digits. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -321,13 +349,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -351,4 +381,4 @@ An instance or array of the objects. ## NOTES ## RELATED LINKS -[Remove-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-csonlinetelephonenumber) +[Remove-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinetelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberCountry.md similarity index 75% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberCountry.md index e2731e0eed..f3c8f360a2 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberCountry.md @@ -1,32 +1,33 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry -Module Name: MicrosoftTeams -title: Get-CsOnlineTelephoneNumberCountry -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumberCountry --- # Get-CsOnlineTelephoneNumberCountry ## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. +Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. ## SYNTAX ``` PS C:\> Get-CsOnlineTelephoneNumberCountry [] ``` -## DESCRIPTION +## DESCRIPTION Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineTelephoneNumberCountry ``` @@ -60,10 +61,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) -[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) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberOrder.md similarity index 83% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberOrder.md index ef349435bf..b11dbfd998 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberOrder.md @@ -1,19 +1,20 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: Get-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumberOrder --- # Get-CsOnlineTelephoneNumberOrder ## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number order. +Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number order. ## SYNTAX @@ -24,7 +25,7 @@ Get-CsOnlineTelephoneNumberOrder -OrderId [-OrderType ] ## DESCRIPTION -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. +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/microsoftteams/new-csonlinetelephonenumberorder), Direct Routing Number Upload [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedirectroutingtelephonenumberuploadorder), and Direct Routing Number Release [New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/microsoftteams/New-csonlinetelephonenumberreleaseorder). When the OrderType is not indicated, the cmdlet will default to a Search order. ## EXAMPLES @@ -52,9 +53,9 @@ ErrorCode NoError InventoryType Subscriber SendToServiceDesk False CountryCode CA - + PS C:\> $order.TelephoneNumbers - + Key Value --- ----- Location Vancouver @@ -78,17 +79,17 @@ CreatedBy ContosoAdmin Description Prefix Search Test NumberType UserSubscriber SearchType Prefix -AreaCode -PostalOrZipCode +AreaCode +PostalOrZipCode Quantity 1 Status Error IsManual False TelephoneNumbers {} -ReservationExpiryDate +ReservationExpiryDate ErrorCode OutOfStock InventoryType Subscriber SendToServiceDesk False -CountryCode +CountryCode ``` This example returns a failed telephone number search and the `ErrorCode` is showing that telephone numbers with `NumberPrefix: 1425` is `OutOfStock`. @@ -199,17 +200,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ## NOTES -Updates in Teams PowerShell Module version 6.7.1 and later: +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`. ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[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) -[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder) -[New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder) +[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedirectroutingtelephonenumberuploadorder) +[New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/microsoftteams/New-csonlinetelephonenumberreleaseorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberType.md similarity index 82% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberType.md index 5e43aab2d1..91dec5ee4a 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberType.md @@ -1,19 +1,20 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype -Module Name: MicrosoftTeams -title: Get-CsOnlineTelephoneNumberType -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumberType --- # Get-CsOnlineTelephoneNumberType ## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. The telephone numbers can then be used to set up calling features for users and services in your organization. +Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. ## SYNTAX @@ -27,7 +28,7 @@ Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported te ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineTelephoneNumberType -Country US ``` @@ -54,7 +55,7 @@ RequiresCivicAddress : True This example returns the list of supported number offerings in United States. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineTelephoneNumberType -Country CA | ft NumberType ``` @@ -101,10 +102,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype) -[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) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineUser.md similarity index 88% rename from teams/teams-ps/teams/Get-CsOnlineUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineUser.md index b04d3f9919..16d470b47f 100644 --- a/teams/teams-ps/teams/Get-CsOnlineUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineuser applicable: Microsoft Teams -title: Get-CsOnlineUser -schema: 2.0.0 -manager: sshastri author: praspatil +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sshastri +Module Name: MicrosoftTeams ms.author: praspatil -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineuser +schema: 2.0.0 +title: Get-CsOnlineUser --- # Get-CsOnlineUser @@ -21,11 +22,11 @@ Returns information about users who have accounts homed on Microsoft Teams or Sk Get-CsOnlineUser [[-Identity] ] [-AccountType ] [-Filter ] + [-Properties ] [-ResultSize ] [-SkipUserPolicies] [-SoftDeletedUser] [-Sort] - [-UsePreferredDC] [] ``` @@ -57,21 +58,21 @@ Users homed on Skype for Business Online will a TenantId that is equal to some v ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineUser ``` The command shown in Example 1 returns information for all the users configured as online users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineUser -Identity "sip:kenmyer@litwareinc.com" ``` In Example 2 information is returned for a single online user: the user with the SIP address "sip:kenmyer@litwareinc.com". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOnlineUser -Filter "ArchivingPolicy -eq 'RedmondArchiving'" ``` @@ -80,7 +81,7 @@ Example 3 uses the Filter parameter to limit the returned data to online users w To do this, the filter value {ArchivingPolicy -eq "RedmondArchiving"} is employed; that syntax limits returned data to users where the ArchivingPolicy property is equal to (-eq) "RedmondArchiving". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsOnlineUser -Filter {HideFromAddressLists -eq $True} ``` @@ -89,7 +90,7 @@ Example 4 returns information only for user accounts that have been configured s (That is, the Active Directory attribute msExchHideFromAddressLists is True.) To carry out this task, the Filter parameter is included along with the filter value {HideFromAddressLists -eq $True}. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234"} Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234,ext:"} @@ -98,14 +99,14 @@ Get-CsOnlineUser -Filter {LineURI -eq "1234"} Example 5 returns information for user accounts that have been assigned a designated phone number. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsOnlineUser -AccountType ResourceAccount ``` Example 6 returns information for user accounts that are categorized as resource accounts. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsOnlineUser -Filter "FeatureTypes -Contains 'PhoneSystem'" ``` @@ -115,6 +116,9 @@ Example 7 returns information for user's assigned plans. ## PARAMETERS ### -AccountType + +> Applicable: Microsoft Teams + This parameter is added to Get-CsOnlineUser starting from TPM 4.5.1 to indicate the user type. The possible values for the AccountType parameter are: - `User` - to query for user accounts. @@ -127,7 +131,6 @@ This parameter is added to Get-CsOnlineUser starting from TPM 4.5.1 to indicate Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -136,7 +139,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Filter + +> Applicable: Microsoft Teams + +Enables you to limit the returned data by filtering on specific attributes. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. + +The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. + +Examples: +- Get-CsOnlineUser -Filter {AssignedPlan -like "*MCO*"} +- Get-CsOnlineUser -Filter {UserPrincipalName -like "test*" -and (AssignedPlans -eq "MCOEV" -or AssignedPlans -like "MCOPSTN*")} +- Get-CsOnlineUser -Filter {OnPremHostingProvider -ne $null} +- Get-CsOnlineUser -Filter {WhenChanged -gt "1/25/2022 11:59:59 PM"} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Microsoft Teams + Indicates the Identity of the user account to be retrieved. For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account: @@ -158,7 +190,6 @@ 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 Required: False Position: 1 @@ -167,22 +198,20 @@ 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. +### -Properties -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"``. +> Applicable: Microsoft Teams + +Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Identity, UserPrincipalName, Alias, AccountEnabled and DisplayName attributes will always be present in the output. Please note that only attributes available in the output of the Get-CsOnlineUser cmdlet can be selected. For a complete list of available attributes, refer to the response of the Get-CsOnlineUser cmdlet. Examples: -- Get-CsOnlineUser -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"} +- Get-CsOnlineUser -Properties DisplayName, UserPrincipalName, FeatureTypes +- Get-CsOnlineUser -Properties DisplayName, Alias, LineURI ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -193,6 +222,8 @@ Accept wildcard characters: False ### -ResultSize +> Applicable: Microsoft Teams + **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. @@ -203,7 +234,6 @@ The result size can be set to any whole number between 0 and 2147483647, inclusi Type: Unlimited Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -213,13 +243,15 @@ Accept wildcard characters: False ``` ### -SkipUserPolicies + +> Applicable: Microsoft Teams + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -230,13 +262,14 @@ Accept wildcard characters: False ### -SoftDeletedUser +> Applicable: Microsoft Teams + This parameter enables you to return a collection of all the users who are deleted and can be restored within 30 days from their deletion time ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -247,6 +280,8 @@ Accept wildcard characters: False ### -Sort +> Applicable: Microsoft Teams + 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" @@ -258,7 +293,6 @@ Sorting is now enabled in Teams PowerShell Module by using the "-Sort" or "-Orde Type: String Parameter Sets: (All) Aliases: OrderBy -Applicable: Microsoft Teams Required: False Position: Named @@ -267,22 +301,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UsePreferredDC - -Reserved for Microsoft internal use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -315,6 +333,29 @@ A recent fix has addressed an issue where some Guest users were being omitted fr - Conferencing_RequiresCommunicationCredits: Allows pay-per minute Audio Conferencing without monthly licenses. - CommunicationCredits: Enables users to pay Teams calling and conferencing through the credits. +**Updates in Teams PowerShell Module verion 7.1.1 Preview and later**: + +- EffectivePolicyAssignments: The EffectivePolicyAssignments attribute has been added to the Get-CsOnlineUser cmdlet in commercial environments. This new attribute provides information about a user's effective policy assignments. Each assignment includes the following details: + - PolicyType - which specifies the type of policy assigned (for example, TeamsMeetingPolicy, TeamsCallingPolicy, and so on.) + - PolicyAssignment - which includes the display name of the assigned policy (displayName), the assignment type (assignmentType) indicating whether it is direct or group-based, the unique identifier of the policy (policyId), and the group identifier (groupId) if applicable. + **Note**: The policyId property isn't currently supported. + +**Updates in Teams PowerShell Module**: + +- DialPlan: DialPlan attribute will be deprecated and no longer populated in the output of Get-CsOnlineUser in all clouds. + +**Updates in Teams PowerShell Module version 7.0.0 and later**: + +- OptionFlags: OptionFlags attribute will no longer be populated with value in the output of Get-CsOnlineUser in all clouds. It's important to note that other details besides EnterpriseVoiceEnabled, previously found in OptionFlags, are no longer relevant for Teams. Administrators can still utilize the EnterpriseVoiceEnabled attribute in the output of the Get-CsOnlineUser cmdlet to get this information. This change will be rolled out to all Teams Powershell Module versions. + +**Updates in Teams PowerShell Module version 6.9.0 and later**: + +Adds new attribute in the output of Get-CsOnlineUser cmdlet in commercial environments. + - TelephoneNumbers: A new list of complex object that includes telephone number and its corresponding assignment category. The assignment category can include values such as 'Primary', 'Private', and 'Alternate'. + +Adds new parameter to the Get-CsOnlineUser cmdlet in all clouds: + - Properties: Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Note that the following properties will always be present in the output: Identity, UserPrincipalName, Alias, AccountEnabled, DisplayName. + **Updates in Teams PowerShell Module version 6.8.0 and later**: New policies - TeamsBYODAndDesksPolicy, TeamsAIPolicy, TeamsWorkLocationDetectionPolicy, TeamsMediaConnectivityPolicy, TeamsMeetingTemplatePermissionPolicy, TeamsVirtualAppointmentsPolicy and TeamsWorkLoadPolicy will be visible in the Get-CsOnlineUser cmdlet output. @@ -361,8 +402,6 @@ The following updates are applicable for organizations that use Microsoft Teams - 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.) -- 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. (Note: This change will be rolled out to all 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. @@ -562,4 +601,4 @@ In Teams PowerShell Modules 3.0.0 and above OnPremLineURI will only refer to the ## RELATED LINKS -[Set-CsUser](https://learn.microsoft.com/powershell/module/teams/set-csuser) +[Set-CsUser](https://learn.microsoft.com/powershell/module/microsoftteams/set-csuser) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoute.md similarity index 83% rename from teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoute.md index 530da92267..cc4fd60396 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoute.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute applicable: Microsoft Teams -title: Get-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroute +schema: 2.0.0 +title: Get-CsOnlineVoiceRoute --- # Get-CsOnlineVoiceRoute ## SYNOPSIS -Returns information about the online voice routes configured for use 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). +Returns information about the online voice routes configured for use in your tenant. ## SYNTAX @@ -36,28 +37,28 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineVoiceRoute ``` Retrieves the properties for all voice routes defined within the tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineVoiceRoute -Identity Route1 ``` Retrieves the properties for the Route1 voice route. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsOnlineVoiceRoute -Filter *test* ``` This command displays voice route settings where the Identity contains the string "test" anywhere within the value. To find the string test only at the end of the Identity, use the value \*test. Similarly, to find the string test only if it occurs at the beginning of the Identity, specify the value test\*. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> Get-CsOnlineVoiceRoute | Where-Object {$_.OnlinePstnGatewayList.Count -eq 0} ``` @@ -110,8 +111,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy.md similarity index 85% rename from teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy.md index 1aec9c2d0a..21d5485fe6 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Get-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Get-CsOnlineVoiceRoutingPolicy --- # Get-CsOnlineVoiceRoutingPolicy ## SYNOPSIS -Returns information about the online voice routing policies configured for use in your tenant. Online voice routing policies manage online PSTN usages for users of Phone System. +Returns information about the online voice routing policies configured for use in your tenant. ## SYNTAX @@ -34,35 +35,35 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy ``` The command shown in Example 1 returns information for all the online voice routing policies configured for use in the tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" ``` In Example 2, information is returned for a single online voice routing policy: the policy with the Identity RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy -Filter "tag:*" ``` The command shown in Example 3 returns information about all the online voice routing 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:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Long Distance"} ``` In Example 4, information is returned only for those online voice routing policies that include the PSTN usage "Long Distance". To carry out this task, the command first calls `Get-CsVoiceRoutingPolicy` without any parameters; that returns a collection of all the voice routing 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 OnlinePstnUsages property includes (-contains) the usage "Long Distance". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -notcontains "Long Distance"} ``` @@ -127,10 +128,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceUser.md similarity index 94% rename from teams/teams-ps/teams/Get-CsOnlineVoiceUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceUser.md index 71f7ff2efb..0355ab3e34 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceuser applicable: Microsoft Teams -title: Get-CsOnlineVoiceUser -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceuser +schema: 2.0.0 +title: Get-CsOnlineVoiceUser --- # Get-CsOnlineVoiceUser @@ -81,7 +82,7 @@ In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Team ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineVoiceUser -Identity Ken.Myer@contoso.com ``` @@ -91,13 +92,15 @@ This example uses the User Principal Name (UPN) to retrieve the location and pho ## PARAMETERS ### -CivicAddressId + +> Applicable: Microsoft Teams + Specifies the identity of the civic address that is assigned to the target users. ```yaml Type: XdsCivicAddressId Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -EnterpriseVoiceStatus + +> Applicable: Microsoft Teams + Possible values are: * All * Enabled @@ -132,7 +140,6 @@ Possible values are: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -142,13 +149,15 @@ Accept wildcard characters: False ``` ### -ExpandLocation + +> Applicable: Microsoft Teams + Displays the location parameter with its value. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -First + +> Applicable: Microsoft Teams + Specifies the number of users to return. The default is 100. @@ -165,7 +177,6 @@ The default is 100. Type: Unlimited Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. The Force switch specifies whether to suppress warning and confirmation messages. @@ -185,7 +199,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -195,6 +208,9 @@ Accept wildcard characters: False ``` ### -GetFromAAD + +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. Use this switch to get the users from Microsoft Entra ID. @@ -203,7 +219,6 @@ Use this switch to get the users from Microsoft Entra ID. Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -213,6 +228,9 @@ Accept wildcard characters: False ``` ### -GetPendingUsers + +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. Use this switch to get only the users in pending state. @@ -221,7 +239,6 @@ Use this switch to get only the users in pending state. Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -231,6 +248,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + Specifies the identity of the target user. Acceptable values include: @@ -244,7 +264,6 @@ Example: 98403f08-577c-46dd-851a-f0460a13b03d Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -254,6 +273,9 @@ Accept wildcard characters: False ``` ### -LocationId + +> Applicable: Microsoft Teams + Specifies the location identity of the location whose users will be returned. You can find location identifiers by using the `Get-CsOnlineLisLocation` cmdlet. @@ -261,7 +283,6 @@ You can find location identifiers by using the `Get-CsOnlineLisLocation` cmdlet. Type: LocationID Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -271,13 +292,15 @@ Accept wildcard characters: False ``` ### -NumberAssigned + +> Applicable: Microsoft Teams + If specified, the query will return users who have a phone number assigned. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -287,13 +310,15 @@ Accept wildcard characters: False ``` ### -NumberNotAssigned + +> Applicable: Microsoft Teams + If specified, the query will return users who do not have a phone number assigned. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -304,6 +329,8 @@ Accept wildcard characters: False ### -PSTNConnectivity +> Applicable: Microsoft Teams + Possible values are: * All * Online @@ -313,7 +340,6 @@ Possible values are: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -323,6 +349,9 @@ Accept wildcard characters: False ``` ### -SearchQuery + +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). For more details about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). @@ -333,7 +362,6 @@ If this parameter is empty, all users are returned. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -343,6 +371,9 @@ Accept wildcard characters: False ``` ### -Skip + +> Applicable: Microsoft Teams + Specifies the number of users to skip. If you used the First parameter to return the first 50 users and wanted to get another 50, you could use -Skip 50 to avoid returning the first 50 you've already reviewed. The default is 0. @@ -351,7 +382,6 @@ The default is 0. Type: Unlimited Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -361,6 +391,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. This parameter is reserved for internal Microsoft use. @@ -369,7 +402,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -393,4 +425,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlineVoiceUser](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceuser) +[Set-CsOnlineVoiceUser](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceuser) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailPolicy.md similarity index 85% rename from teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailPolicy.md index 844b74b828..d99a41c570 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy applicable: Microsoft Teams -title: Get-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailpolicy +schema: 2.0.0 +title: Get-CsOnlineVoicemailPolicy --- # Get-CsOnlineVoicemailPolicy @@ -32,21 +33,21 @@ This cmdlet retrieves information about one or more voicemail policies that have ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineVoicemailPolicy ``` In Example 1, the Get-CsOnlineVoicemailPolicy cmdlet is called without any additional parameters; this returns a collection of all the voicemail policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineVoicemailPolicy -Identity TranscriptionDisabled ``` In Example 2, the Get-CsOnlineVoicemailPolicy cmdlet is used to return the per-user voicemail policy that has an Identity TranscriptionDisabled. Because identities are unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOnlineVoicemailPolicy -Filter "tag:*" ``` @@ -55,37 +56,41 @@ Example 3 uses the Filter parameter to return all the voicemail policies that ha ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. If this parameter is omitted, all voicemail policies available for use are returned. +### -Filter + +> Applicable: Microsoft Teams + +This parameter accepts a wildcard string and returns all voicemail policies with identities matching that string. For example, a Filter value of Tag:* will return all preconfigured voicemail policy instances (excluding forest default "Global") available to use by the tenant admins. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter accepts a wildcard string and returns all voicemail policies with identities matching that string. For example, a Filter value of Tag:* will return all preconfigured voicemail policy instances (excluding forest default "Global") available to use by the tenant admins. + +### -Identity + +> Applicable: Microsoft Teams + +A unique identifier specifying the scope, and in some cases the name, of the policy. If this parameter is omitted, all voicemail policies available for use are returned. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -100,10 +105,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings.md similarity index 88% rename from teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings.md index b4437f7b08..9018403c51 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailusersettings applicable: Microsoft Teams -title: Get-CsOnlineVoicemailUserSettings -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailusersettings +schema: 2.0.0 +title: Get-CsOnlineVoicemailUserSettings --- # Get-CsOnlineVoicemailUserSettings @@ -26,7 +27,7 @@ The Get-CsOnlineVoicemailUserSettings cmdlet returns information about online vo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineVoicemailUserSettings -Identity sip:user@contoso.com ``` @@ -35,33 +36,35 @@ This example gets the online voicemail user settings of user with SIP URI sip:us ## PARAMETERS -### -Identity -The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +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 Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -81,4 +84,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) +[Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailusersettings) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md new file mode 100644 index 0000000000..bd61deb0f6 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md @@ -0,0 +1,201 @@ +--- +applicable: Microsoft Teams +author: juliiva +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: jomarque +Module Name: MicrosoftTeams +ms.author: juliiva +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cspersonalattendantsettings +schema: 2.0.0 +title: Get-CsPersonalAttendantSettings +--- + +# Get-CsPersonalAttendantSettings + +## SYNOPSIS + +**Limited Preview:** Functionality described in this document is currently in limited preview and only authorized organizations have access. + +This cmdlet will show personal attendant settings for a user. + +## SYNTAX + +``` +Get-CsPersonalAttendantSettings -Identity [] +``` + +## DESCRIPTION + +This cmdlet shows the personal attendant settings for a user. + +## EXAMPLES + +### Example 1 +``` +Get-CsPersonalAttendantSettings -Identity user1@contoso.com +``` +```output +IsPersonalAttendantEnabled : True +DefaultLanguage : en-US +DefaultVoice : Female +CalleeName : User1 +DefaultTone : Formal +IsBookingCalendarEnabled : False +IsNonContactCallbackEnabled : False +IsCallScreeningEnabled : False +AllowInboundInternalCalls : True +AllowInboundFederatedCalls : False +AllowInboundPSTNCalls : False +IsAutomaticTranscriptionEnabled : False +IsAutomaticRecordingEnabled : False +``` + +This example shows that user1@contoso.com has personal attendant enabled (personal attendant communicates in English). Personal attendant will refer to its owner as User1. +Personal attendant is only enabled for inbound Teams calls from the user's domain. Additional capabilities are turned off. + +### Example 2 +``` +Get-CsPersonalAttendantSettings -Identity user1@contoso.com +``` +```output +IsPersonalAttendantEnabled : True +DefaultLanguage : en-US +DefaultVoice : Female +CalleeName : User1 +DefaultTone : Formal +IsBookingCalendarEnabled : True +IsNonContactCallbackEnabled : False +IsCallScreeningEnabled : False +AllowInboundInternalCalls : True +AllowInboundFederatedCalls : False +AllowInboundPSTNCalls : False +IsAutomaticTranscriptionEnabled : False +IsAutomaticRecordingEnabled : False +``` + +This example shows that user1@contoso.com has personal attendant enabled. In addition to previously mentioned capabilities, personal attendant is able to access personal bookings calendar, +fetch the user's availability and schedule callbacks on behalf of the user. Calendar operations are enabled for all incoming callers. user1 must specify the bookings link in Teams Personal Attendant settings. + +### Example 3 +``` +Get-CsPersonalAttendantSettings -Identity user1@contoso.com +``` +```output +IsPersonalAttendantEnabled : True +DefaultLanguage : en-US +DefaultVoice : Female +CalleeName : User1 +DefaultTone : Formal +IsBookingCalendarEnabled : True +IsNonContactCallbackEnabled : True +IsCallScreeningEnabled : False +AllowInboundInternalCalls : True +AllowInboundFederatedCalls : True +AllowInboundPSTNCalls : True +IsAutomaticTranscriptionEnabled : False +IsAutomaticRecordingEnabled : False +``` + +This example shows that user1@contoso.com has personal attendant enabled. In addition to previously mentioned capabilities, personal attendant is enabled for all incoming calls: the user's domain, other domains and PSTN. + +### Example 4 +``` +Get-CsPersonalAttendantSettings -Identity user1@contoso.com +``` +```output +IsPersonalAttendantEnabled : True +DefaultLanguage : en-US +DefaultVoice : Female +CalleeName : User1 +DefaultTone : Formal +IsBookingCalendarEnabled : True +IsNonContactCallbackEnabled : True +IsCallScreeningEnabled : True +AllowInboundInternalCalls : True +AllowInboundFederatedCalls : True +AllowInboundPSTNCalls : True +IsAutomaticTranscriptionEnabled : False +IsAutomaticRecordingEnabled : False +``` + +This example shows that user1@contoso.com has personal attendant enabled. In addition to previously mentioned capabilities, personal attendant is enabled to evaluate the call's context and pass the info to the user. + +### Example 5 +``` +Get-CsPersonalAttendantSettings -Identity user1@contoso.com +``` +```output +IsPersonalAttendantEnabled : True +DefaultLanguage : en-US +DefaultVoice : Female +CalleeName : User1 +DefaultTone : Formal +IsBookingCalendarEnabled : True +IsNonContactCallbackEnabled : True +IsCallScreeningEnabled : True +AllowInboundInternalCalls : True +AllowInboundFederatedCalls : True +AllowInboundPSTNCalls : True +IsAutomaticTranscriptionEnabled : True +IsAutomaticRecordingEnabled : True +``` + +This example shows that user1@contoso.com has personal attendant enabled. In addition to previously mentioned capabilities, personal attendant is automatically storing call transcription and recording. + +### Example 6 +``` +Get-CsPersonalAttendantSettings -Identity user11@contoso.com +``` +```output +IsPersonalAttendantEnabled : False +DefaultLanguage : en-US +DefaultVoice : Female +CalleeName : +DefaultTone : Formal +IsBookingCalendarEnabled : False +IsNonContactCallbackEnabled : False +IsCallScreeningEnabled : True +AllowInboundInternalCalls : True +AllowInboundFederatedCalls : True +AllowInboundPSTNCalls : True +IsAutomaticTranscriptionEnabled : True +IsAutomaticRecordingEnabled : True +``` + +This example shows the default settings for the user that has never changed the personal attendant settings via Microsoft Teams. + +## PARAMETERS + +### -Identity +The Identity of the user to show personal attendant settings for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 7.3.0 or later. + +## RELATED LINKS + +[Set-CsPersonalAttendantSettings](./set-cspersonalattendantsettings.md) diff --git a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberAssignment.md similarity index 74% rename from teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberAssignment.md index 21832d36b4..4499f33849 100644 --- a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberAssignment.md @@ -1,595 +1,777 @@ ---- -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 -title: Get-CsPhoneNumberAssignment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Get-CsPhoneNumberAssignment - -## SYNOPSIS -This cmdlet displays information about one or more phone numbers. - -## SYNTAX - -### Assignment (Default) -```powershell -Get-CsPhoneNumberAssignment [-ActivationState ] [-AssignedPstnTargetId ] [-AssignmentCategory ] - [-CapabilitiesContain ] [-CivicAddressId ] [-Filter ] [-IsoCountryCode ] - [-LocationId ] [-NetworkSiteId ] [-NumberType ] [-PstnAssignmentStatus ] [-Skip ] [-TelephoneNumber ] - [-TelephoneNumberContain ] [-TelephoneNumberGreaterThan ] [-TelephoneNumberLessThan ] - [-TelephoneNumberStartsWith ] [-Top ] [] -``` - -## DESCRIPTION -This cmdlet displays information about one or more phone numbers. You can filter the phone numbers to return by using different parameters. - -Returned results are sorted by TelephoneNumber in ascending order. - -If you are using both -Skip X and -Top Y for filtering, the returned results will first be skipped by X, and then the top Y results will be returned. - -By default, this cmdlet returns a maximum of 500 results. A maximum of 1000 results can be returned using -Top filter. If you need to get more than 1000 results, a combination of -Skip and -Top filtering can be used to list incremental returns of 1000 numbers. If a full list of telephone numbers acquired by the tenant is required, you can use [Export-CsAcquiredPhoneNumber](./export-csacquiredphonenumber.md) cmdlet to download a list of all acquired telephone numbers. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumber +14025551234 -``` -```output -TelephoneNumber : +14025551234 -OperatorId : 2b24d246-a9ee-428b-96bc-fb9d9a053c8d -NumberType : CallingPlan -ActivationState : Activated -AssignedPstnTargetId : dc13d97b-7897-494e-bc28-6b469bf7a70e -AssignmentCategory : Primary -Capability : {UserAssignment} -City : Omaha -CivicAddressId : 703b30e5-dbdd-4132-9809-4c6160a6acc7 -IsoCountryCode : US -IsoSubdivision : Nebraska -LocationId : 407c17ae-8c41-431e-894a-38787c682f68 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : 7fc2f2eb-89aa-41d7-93de-73d015d22ff0 -PstnPartnerName : Microsoft -NumberSource : Online -ReverseNumberLookup : {} -``` -This example displays information about the Microsoft Calling Plan subscriber phone number +1 (402) 555-1234. You can see that it is assigned to a user. - -### Example 2 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" -``` -```output -TelephoneNumber : +12065551000;ext=524 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -``` -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. - -### Example 3 -```powershell -Get-CsPhoneNumberAssignment -CapabilitiesContain "VoiceApplicationAssignment,ConferenceAssignment" -``` -This example returns all phone numbers that have both the capability VoiceApplicationAssignment and the capability ConferenceAssignment assigned, but phone numbers that have only one of these capabilities assigned won't be returned. - -### Example 4 -```powershell -Get-CsPhoneNumberAssignment -AssignedPstnTargetId user1@contoso.com -``` -This example returns information about the phone number assigned to user1@contoso.com. - -### Example 5 -```powershell -Get-CsPhoneNumberAssignment -AssignedPstnTargetId aa1@contoso.com -``` -This example returns information about the phone number assigned to resource account aa1@contoso.com. - -### Example 6 -```powershell -Get-CsPhoneNumberAssignment -ActivationState Activated -CapabilitiesContain VoiceApplicationAssignment -PstnAssignmentStatus Unassigned -``` -This example returns information about all activated phone numbers with the capability VoiceApplicationAssignment that are not assigned. - -### Example 7 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumberContain "524" -``` -This example returns information about all phone numbers that contain the digits 524, including the phone number with extension 524 used in example 2. - -### Example 8 -```powershell -(Get-CsPhoneNumberAssignment | Where-Object {$_.NumberType.Contains('CallingPlan') -and $_.Capability.Contains('UserAssignment') -and ($_.PstnAssignmentStatus.Contains('UserAssigned') -or $_.PstnAssignmentStatus.Contains('Unassigned'))}).Count -``` -This example returns the number of Calling Plan subscriber phone numbers that are either assigned or not assigned to users. - -### Example 9 -```powershell -Get-CsPhoneNumberAssignment -Top (50::500) -``` -This example returns all phone numbers in the record between sequence 50 to 500. This parameter can be used to get upto a maximum 1000 results at a time. - -### Example 10 -```powershell -Get-CsPhoneNumberAssignment -Skip 1000 -Top 1000 -``` -This example returns all phone numbers sequenced between 1001 to 2000 in the record of phone numbers. - -### Example 11 -```powershell -Get-CsPhoneNumberAssignment -AssignedPstnTargetId 'TeamsSharedCallingRoutingPolicy|Tag:SC1' -``` -This example returns all phone numbers assigned as emergency numbers in the Teams shared calling routing policy instance SC1. - -### Example 12 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" -``` -```output -TelephoneNumber : +12065551000;ext=524 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {SkipInternalVoip} -``` -This example displays when SkipInternalVoip option is turned on for a number. - -### Example 13 -```powershell -Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -eq '+12065551000'" -``` -```output -TelephoneNumber : +12065551000 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -``` -This example shows a way to use -Filter parameter to display information of a specific number. - -### Example 14 -```powershell -Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -like '+12065551000' -and NumberType -eq 'DirectRouting'" -``` -```output -TelephoneNumber : +12065551000 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -``` -This example shows a way to get filtered results using multiple Filter parameters. - - -## PARAMETERS - -### -ActivationState -Filters the returned results based on the number type. Supported values are Activated, AssignmentPending, AssignmentFailed, UpdatePending, and UpdateFailed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -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: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCategory -This parameter is reserved for internal Microsoft use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapabilitiesContain -Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and TeamsPhoneMobile. - -If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like -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: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -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](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -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 country code assigned to the phone number. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -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](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSiteId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberType -Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PstnAssignmentStatus -Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, ThirdPartyAppAssigned, and PolicyAssigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -Skips the first X returned results and the default value is 0. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -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'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: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberContain - -Filters the returned results based on substring match for the specified string on TelephoneNumber. To search for a number with an extension, you need to specify -the digits of the extension. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberGreaterThan -Filters the returned results based on greater than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberLessThan to specify a -range of phone numbers to return results for. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberLessThan -Filters the returned results based on less than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberGreaterThan to specify a -range of phone numbers to return results for. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberStartsWith -Filters the returned results based on starts with string match for the specified string on TelephoneNumber. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Returns the first X returned results and the default value is 500. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -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 - -### None - -## OUTPUTS - -### ActivationState -The activation state of the telephone number. - -### AssignedPstnTargetId -The ID of the object the phone number is assigned to, either the ObjectId of a user or resource account or the policy instance ID of a Teams shared calling routing policy instance. - -### AssignmentCategory -This parameter is reserved for internal Microsoft use. - -### Capability -The list of capabilities assigned to the phone number. - -### City -The city where the phone number is located. - -### CivicAddressId -The ID of the CivicAddress assigned to the phone number. - -### IsoCountryCode -The ISO country code assigned to the phone number. - -### IsoSubDivision -The subdivision within the country/region assigned to the phone number, for example, the state for US phone numbers. - -### LocationId -The ID of the Location assigned to the phone number. - -### LocationUpdateSupported -Boolean stating if updating of the location assigned to the phone number is allowed. - -### NetworkSiteId -This parameter is reserved for internal Microsoft use. - -### NumberSource -The source of the phone number. Online for phone numbers assigned in Microsoft 365 and OnPremises for phone numbers assigned in AD on-premises and synchronized into Microsoft 365. - -### NumberType -The type of the phone number. - -### OperatorId -The ID of the operator. - -### PortInOrderStatus -The status of any port in order covering the phone number. - -### PstnAssignmentStatus -The assignment status of the phone number. - -### PstnPartnerId -The ID of the PSTN partner providing the phone number. - -### PstnPartnerName -The name of the PSTN partner. - -### TelephoneNumber -The phone number. The number is always displayed with prefixed "+", even if it was not assigned using prefixed "+". - -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](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) - -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumberassignment +schema: 2.0.0 +title: Get-CsPhoneNumberAssignment +--- + +# Get-CsPhoneNumberAssignment + +## SYNOPSIS +This cmdlet displays information about one or more phone numbers. + +## SYNTAX + +``` +Get-CsPhoneNumberAssignment [-ActivationState ] [-AssignedPstnTargetId ] + [-AssignmentCategory ] [-CapabilitiesContain ] [-CivicAddressId ] [-Filter ] + [-IsoCountryCode ] [-LocationId ] [-NetworkSiteId ] [-NumberType ] + [-PstnAssignmentStatus ] [-Skip ] [-TelephoneNumber ] + [-TelephoneNumberContain ] [-TelephoneNumberGreaterThan ] [-TelephoneNumberLessThan ] + [-TelephoneNumberStartsWith ] [-Top ] [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +## 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. Supported list of attributes for Filter are: +- TelephoneNumber +- OperatorId +- PstnAssignmentStatus (also supported AssignmentStatus) +- ActivationState +- IsoCountryCode +- Capability (also supported AcquiredCapabilities) +- IsOperatorConnect +- PstnPartnerName (also supported PartnerName) +- LocationId +- CivicAddressId +- NetworkSiteId +- NumberType +- AssignedPstnTargetId (also supported TargetId) +- TargetType +- AssignmentCategory +- ResourceAccountSharedCallingPolicySupported +- SupportedCustomerActions +- ReverseNumberLookup +- RoutingOptions +- SmsActivationState +- Tags + +If you are using both -Skip X and -Top Y for filtering, the returned results will first be skipped by X, and then the top Y results will be returned. + +By default, this cmdlet returns a maximum of 500 results. A maximum of 1000 results can be returned using -Top filter. If you need to get more than 1000 results, a combination of -Skip and -Top filtering can be used to list incremental returns of 1000 numbers. If a full list of telephone numbers acquired by the tenant is required, you can use [Export-CsAcquiredPhoneNumber](./export-csacquiredphonenumber.md) cmdlet to download a list of all acquired telephone numbers. + + +## EXAMPLES + +### Example 1 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber +14025551234 +``` +```output +TelephoneNumber : +14025551234 +OperatorId : 2b24d246-a9ee-428b-96bc-fb9d9a053c8d +NumberType : CallingPlan +ActivationState : Activated +AssignedPstnTargetId : dc13d97b-7897-494e-bc28-6b469bf7a70e +AssignmentCategory : Primary +Capability : {UserAssignment} +City : Omaha +CivicAddressId : 703b30e5-dbdd-4132-9809-4c6160a6acc7 +IsoCountryCode : US +IsoSubdivision : Nebraska +LocationId : 407c17ae-8c41-431e-894a-38787c682f68 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : 7fc2f2eb-89aa-41d7-93de-73d015d22ff0 +PstnPartnerName : Microsoft +NumberSource : Online +ReverseNumberLookup : {} +Tag : {} +``` +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. + +### Example 2 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" +``` +```output +TelephoneNumber : +12065551000;ext=524 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +Tag : {} +``` +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. + +### Example 3 +```powershell +Get-CsPhoneNumberAssignment -CapabilitiesContain "VoiceApplicationAssignment,ConferenceAssignment" +``` +This example returns all phone numbers that have both the capability VoiceApplicationAssignment and the capability ConferenceAssignment assigned, but phone numbers that have only one of these capabilities assigned won't be returned. + +### Example 4 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId user1@contoso.com +``` +This example returns information about the phone number assigned to user1@contoso.com. + +### Example 5 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId aa1@contoso.com +``` +This example returns information about the phone number assigned to resource account aa1@contoso.com. + +### Example 6 +```powershell +Get-CsPhoneNumberAssignment -ActivationState Activated -CapabilitiesContain VoiceApplicationAssignment -PstnAssignmentStatus Unassigned +``` +This example returns information about all activated phone numbers with the capability VoiceApplicationAssignment that are not assigned. + +### Example 7 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumberContain "524" +``` +This example returns information about all phone numbers that contain the digits 524, including the phone number with extension 524 used in example 2. + +### Example 8 +```powershell +Get-CsPhoneNumberAssignment -Skip 1000 -Top 1000 +``` +This example returns all phone numbers sequenced between 1001 to 2000 in the record of phone numbers. + + +### Example 9 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId 'TeamsSharedCallingRoutingPolicy|Tag:SC1' +``` +This example returns all phone numbers assigned as emergency numbers in the Teams shared calling routing policy instance SC1. + +### Example 10 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" +``` +```output +TelephoneNumber : +12065551000;ext=524 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a6f091 +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} +Tag : {} +``` +This example displays when SkipInternalVoip option is turned on for a number. + +### Example 11 +```powershell +Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -eq '+12065551000'" +``` +```output +TelephoneNumber : +12065551000 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +Tag : {} +``` +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-cff260a3f591 +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 : {} +Tag : {} +``` +This example shows a way to get filtered results using multiple Filter parameters. + +### Example 13 +```powershell +Get-CsPhoneNumberAssignment -Filter "Tags -contains ['Engineering']" +``` +```output +TelephoneNumber : +12065551102 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f071 +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 : {} +Tag : {Engineering} +``` +This example shows a way to get filtered results using tags. Tags are not case sensitive. + + +## PARAMETERS + +### -ActivationState + +> Applicable: Microsoft Teams + +Filters the returned results based on the number type. Supported values are Activated, AssignmentPending, AssignmentFailed, UpdatePending, and UpdateFailed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignedPstnTargetId + +> Applicable: Microsoft Teams + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignmentCategory + +> Applicable: Microsoft Teams + +This parameter is used to differentiate between Primary and Private line assignment for a user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapabilitiesContain + +> Applicable: Microsoft Teams + +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 +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CivicAddressId + +> Applicable: Microsoft Teams + +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/microsoftteams/get-csonlineliscivicaddress). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsoCountryCode + +> Applicable: Microsoft Teams + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationId + +> Applicable: Microsoft Teams + +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/microsoftteams/get-csonlinelislocation). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteId + +> Applicable: Microsoft Teams + +ID of a network site. A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberType + +> Applicable: Microsoft Teams + +Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PstnAssignmentStatus + +> Applicable: Microsoft Teams + +Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, ThirdPartyAppAssigned, and PolicyAssigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skips the first X returned results and the default value is 0. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberContain + +> Applicable: Microsoft Teams + +Filters the returned results based on substring match for the specified string on TelephoneNumber. To search for a number with an extension, you need to specify +the digits of the extension. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberGreaterThan + +> Applicable: Microsoft Teams + +Filters the returned results based on greater than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberLessThan to specify a +range of phone numbers to return results for. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberLessThan + +> Applicable: Microsoft Teams + +Filters the returned results based on less than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberGreaterThan to specify a +range of phone numbers to return results for. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberStartsWith + +> Applicable: Microsoft Teams + +Filters the returned results based on starts with string match for the specified string on TelephoneNumber. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top + +> Applicable: Microsoft Teams + +Returns the first X returned results and the default value is 500. + +```yaml +Type: System.Int32 +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 + +### ActivationState +The activation state of the telephone number. + +### AssignedPstnTargetId +The ID of the object the phone number is assigned to, either the ObjectId of a user or resource account or the policy instance ID of a Teams shared calling routing policy instance. + +### AssignmentCategory +Contains the assignment category such as Primary or Private. + +### Capability +The list of capabilities assigned to the phone number. + +### City +The city where the phone number is located. + +### CivicAddressId +The ID of the CivicAddress assigned to the phone number. + +### IsoCountryCode +The ISO country code assigned to the phone number. + +### IsoSubDivision +The subdivision within the country/region assigned to the phone number, for example, the state for US phone numbers. + +### LocationId +The ID of the Location assigned to the phone number. + +### LocationUpdateSupported +Boolean stating if updating of the location assigned to the phone number is allowed. + +### NetworkSiteId +This parameter is reserved for internal Microsoft use. + +### NumberSource +The source of the phone number. Online for phone numbers assigned in Microsoft 365 and OnPremises for phone numbers assigned in AD on-premises and synchronized into Microsoft 365. + +### NumberType +The type of the phone number. + +### OperatorId +The ID of the operator. + +### PortInOrderStatus +The status of any port in order covering the phone number. + +### PstnAssignmentStatus +The assignment status of the phone number. + +### PstnPartnerId +The ID of the PSTN partner providing the phone number. + +### PstnPartnerName +The name of the PSTN partner. + +### TelephoneNumber +The phone number. The number is always displayed with prefixed "+", even if it was not assigned using prefixed "+". + +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](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) + +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberTag.md new file mode 100644 index 0000000000..f5c25ae137 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberTag.md @@ -0,0 +1,59 @@ +--- +applicable: Microsoft Teams +author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +ms.reviewer: pavellatif +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumbertag +schema: 2.0.0 +title: Get-CsPhoneNumberTag +--- + +# 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/MicrosoftTeams/Get-CsPolicyPackage.md similarity index 91% rename from teams/teams-ps/teams/Get-CsPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsPolicyPackage.md index 0e3330e1af..5cc5357210 100644 --- a/teams/teams-ps/teams/Get-CsPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Get-CsPolicyPackage -author: serdarsoysal ms.author: serdars -manager: amitar -online version: https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage schema: 2.0.0 +title: Get-CsPolicyPackage --- # Get-CsPolicyPackage @@ -66,13 +67,14 @@ Returns the set of policies in the Education_PrimaryStudent policy package. ### -Identity +> Applicable: Microsoft Teams + The name of a specific policy package. All possible policy package names can be found by running Get-CsPolicyPackage. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 0 Default value: None @@ -107,8 +109,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation) -[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackage) -[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csuserpolicypackage) diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestStatus.md similarity index 99% rename from teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestStatus.md index 7152c35e07..9ed49ecffe 100644 --- a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestStatus.md @@ -1,10 +1,10 @@ --- +applicable: Microsoft Teams external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -online version: -title: Get-CsSdgBulkSignInRequestStatus schema: 2.0.0 +title: Get-CsSdgBulkSignInRequestStatus --- # Get-CsSdgBulkSignInRequestStatus diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestsSummary.md similarity index 98% rename from teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md rename to teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestsSummary.md index b1f9e93472..8f1d328eaa 100644 --- a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestsSummary.md @@ -1,10 +1,10 @@ --- +applicable: Microsoft Teams external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -online version: -title: Get-CsSdgBulkSignInRequestsSummary schema: 2.0.0 +title: Get-CsSdgBulkSignInRequestsSummary --- # Get-CsSdgBulkSignInRequestsSummary diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/Get-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..58f403ef60 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Get-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,94 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: tomkau +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: Get-CsSharedCallQueueHistoryTemplate +--- + +# Get-CsSharedCallQueueHistoryTemplate + +## SYNOPSIS +Use the Get-CsSharedCallQueueHistory cmdlet to list the Shared Call Queue History templates. + +## SYNTAX + +``` +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 + +> Applicable: Microsoft Teams + +The Id of the shared call queue history template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: false +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### 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/MicrosoftTeams/Get-CsTeamTemplate.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplate.md index de8f75a2f2..81dc98c798 100644 --- a/teams/teams-ps/teams/Get-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplate.md @@ -1,244 +1,244 @@ ---- -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-csteamtemplate -title: Get-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: farahf -schema: 2.0.0 ---- - -# Get-CsTeamTemplate - -## SYNOPSIS - -This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. - -NOTE: The returned template definition is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. - -## SYNTAX - -### Get (Default) - -```powershell -Get-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] -``` - -### GetViaIdentity - -```powershell -Get-CsTeamTemplate -InputObject [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] -``` - -## DESCRIPTION - -This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -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'. - -### EXAMPLE 2 - -```powershell -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. - -## PARAMETERS - -### -OdataId - -A composite URI of a template. - -```yaml -Type: String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -## NOTES - -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 ]`: - - `[CivicAddressId ]`: Civic address id. - - `[Country ]`: - - `[GroupId ]`: The ID of a group whose policy assignments will be returned. - - `[Id ]`: - - `[Identity ]`: - - `[Locale ]`: - - `[LocationId ]`: Location id. - - `[OdataId ]`: A composite URI of a template. - - `[OperationId ]`: The ID of a batch policy assignment operation. - - `[OrderId ]`: - - `[PackageName ]`: The name of a specific policy package - - `[PolicyType ]`: The policy type for which group policy assignments will be returned. - - `[Port ]`: - - `[PortInOrderId ]`: - - `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. - - `[SubnetId ]`: - - `[TenantId ]`: - - `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -## 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) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: farahf +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplate +schema: 2.0.0 +title: Get-CsTeamTemplate +--- + +# Get-CsTeamTemplate + +## SYNOPSIS + +This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + +## SYNTAX + +### Get (Default) + +```powershell +Get-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity + +```powershell +Get-CsTeamTemplate -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION + +This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + +NOTE: The returned template definition is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +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'. + +### EXAMPLE 2 + +```powershell +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. + +## PARAMETERS + +### -Break + +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OdataId + +A composite URI of a template. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: True +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: 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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +## NOTES + +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 ]`: + - `[CivicAddressId ]`: Civic address id. + - `[Country ]`: + - `[GroupId ]`: The ID of a group whose policy assignments will be returned. + - `[Id ]`: + - `[Identity ]`: + - `[Locale ]`: + - `[LocationId ]`: Location id. + - `[OdataId ]`: A composite URI of a template. + - `[OperationId ]`: The ID of a batch policy assignment operation. + - `[OrderId ]`: + - `[PackageName ]`: The name of a specific policy package + - `[PolicyType ]`: The policy type for which group policy assignments will be returned. + - `[Port ]`: + - `[PortInOrderId ]`: + - `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. + - `[SubnetId ]`: + - `[TenantId ]`: + - `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +## RELATED LINKS + +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) + +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplate) + +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamtemplate) + +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamtemplate) + +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Get-CsTeamTemplateList.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplateList.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTeamTemplateList.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplateList.md index c9928c4038..b88b964510 100644 --- a/teams/teams-ps/teams/Get-CsTeamTemplateList.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplateList.md @@ -1,147 +1,146 @@ ---- -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-csteamtemplatelist -title: Get-CsTeamTemplateList -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: farahf -schema: 2.0.0 ---- - -# Get-CsTeamTemplateList - -## 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 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 - -### Get (Default) - -```powershell -Get-CsTeamTemplateList [[-PublicTemplateLocale] ] [] -``` - -### GetViaIdentity - -```powershell -Get-CsTeamTemplateList -InputObject [] -``` - -## DESCRIPTION - -Get a list of available team templates - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> Get-CsTeamTemplateList -``` - -Returns all en-US templates within the universe of templates the admin's tenant has access to. - -Note: All 1P Microsoft templates will always be returned in the specified locale. If the locale is not specified, en-US will be used. - -### EXAMPLE 2 - -```powershell -PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3 -``` - -Returns all en-US templates that have 3 channels within the universe of templates the admin's tenant has access to. - -## PARAMETERS - -### -PublicTemplateLocale - -The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US. - -```yaml -Type: String -Parameter Sets: Get -Aliases: - -Required: False -Position: 1 -Default value: 'en-US' -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```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 - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateSummary - -## NOTES - -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 \\]:\ -\[CivicAddressId \\]: Civic address id.\ -\[Country \\]:\ -\[GroupId \\]: The ID of a group whose policy assignments will be returned.\ -\[Id \\]:\ -\[Identity \\]:\ -\[Locale \\]: The language and country code of templates localization.\ -\[LocationId \\]: Location id.\ -\[OdataId \\]: A composite URI of a template.\ -\[OperationId \\]: The ID of a batch policy assignment operation.\ -\[OrderId \\]:\ -\[PackageName \\]: The name of a specific policy package\ -\[PolicyType \\]: The policy type for which group policy assignments will be returned.\ -\[Port \\]:\ -\[PortInOrderId \\]:\ -\[SubnetId \\]:\ -\[TenantId \\]:\ -\[UserId \\]: UserId.\ -Supports Guid.\ -Eventually UPN and SIP. - -## 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) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: farahf +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist +schema: 2.0.0 +title: Get-CsTeamTemplateList +--- + +# Get-CsTeamTemplateList + +## SYNOPSIS +Get a list of available team templates + +## SYNTAX + +### Get (Default) + +```powershell +Get-CsTeamTemplateList [[-PublicTemplateLocale] ] [] +``` + +### GetViaIdentity + +```powershell +Get-CsTeamTemplateList -InputObject [] +``` + +## DESCRIPTION + +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. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> Get-CsTeamTemplateList +``` + +Returns all en-US templates within the universe of templates the admin's tenant has access to. + +Note: All 1P Microsoft templates will always be returned in the specified locale. If the locale is not specified, en-US will be used. + +### EXAMPLE 2 + +```powershell +PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3 +``` + +Returns all en-US templates that have 3 channels within the universe of templates the admin's tenant has access to. + +## PARAMETERS + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PublicTemplateLocale + +The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: False +Position: 1 +Default value: 'en-US' +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.IErrorObject + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateSummary + +## NOTES + +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 \\]:\ +\[CivicAddressId \\]: Civic address id.\ +\[Country \\]:\ +\[GroupId \\]: The ID of a group whose policy assignments will be returned.\ +\[Id \\]:\ +\[Identity \\]:\ +\[Locale \\]: The language and country code of templates localization.\ +\[LocationId \\]: Location id.\ +\[OdataId \\]: A composite URI of a template.\ +\[OperationId \\]: The ID of a batch policy assignment operation.\ +\[OrderId \\]:\ +\[PackageName \\]: The name of a specific policy package\ +\[PolicyType \\]: The policy type for which group policy assignments will be returned.\ +\[Port \\]:\ +\[PortInOrderId \\]:\ +\[SubnetId \\]:\ +\[TenantId \\]:\ +\[UserId \\]: UserId.\ +Supports Guid.\ +Eventually UPN and SIP. + +## RELATED LINKS + +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) + +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplate) + +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamtemplate) + +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamtemplate) + +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAIPolicy.md similarity index 71% rename from teams/teams-ps/teams/Get-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAIPolicy.md index 31df8e82df..e5d09c0aa8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: andywang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsAIPolicy +schema: 2.0.0 +title: Get-CsTeamsAIPolicy --- # Get-CsTeamsAIPolicy @@ -23,7 +24,7 @@ Get-CsTeamsAIPolicy [[-Identity] ] [-Filter ] [ Get-CsTeamsAIPolicy ``` -Retrieves Teams AI policies and shows "EnrollFace" and "EnrollVoice" values. +Retrieves Teams AI policies and shows "EnrollFace", "EnrollVoice" and "SpeakerAttributionBYOD" values. ## PARAMETERS -### -Identity -Identity of the Teams AI policy. +### -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: True +Required: False 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:*". +### -Identity +Identity of the Teams AI policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -80,10 +81,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaipolicy) -[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaipolicy) -[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAcsFederationConfiguration.md similarity index 85% rename from teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAcsFederationConfiguration.md index 6ba81b228a..445bcb18cb 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAcsFederationConfiguration.md @@ -1,22 +1,23 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsAcsFederationConfiguration -author: tomkau ms.author: tomkau -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsacsfederationconfiguration schema: 2.0.0 +title: Get-CsTeamsAcsFederationConfiguration --- # Get-CsTeamsAcsFederationConfiguration ## SYNOPSIS -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). +This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. ## SYNTAX -```powershell +``` Get-CsTeamsAcsFederationConfiguration [-Identity ] [-Filter ] @@ -31,7 +32,7 @@ This cmdlet is used retrieve the Teams and ACS federation configuration for a Te You must be a Teams service admin or a Teams communication admin for your organization to run the cmdlet. -## Examples +## EXAMPLES ### Example 1 ```powershell @@ -102,10 +103,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) +[Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy.md similarity index 81% rename from teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy.md index cc36983ff2..61dd52de46 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy.md @@ -1,23 +1,21 @@ --- -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 +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsapppermissionpolicy +schema: 2.0.0 +title: Get-CsTeamsAppPermissionPolicy --- # 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.** +As an admin, you can use app permission policies to allow or block apps for your users. ## SYNTAX @@ -33,10 +31,13 @@ Get-CsTeamsAppPermissionPolicy [-Tenant ] [-Filter ] [-Loca ``` ## 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: . +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppSetupPolicy.md similarity index 81% rename from teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppSetupPolicy.md index 47de4b4b99..16f6536082 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppSetupPolicy.md @@ -1,24 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsappsetuppolicy +schema: 2.0.0 +title: Get-CsTeamsAppSetupPolicy --- # Get-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy.md index 77cad0be0c..4c8c578e75 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy -title: Get-CsTeamsAudioConferencingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy schema: 2.0.0 +title: Get-CsTeamsAudioConferencingPolicy --- # Get-CsTeamsAudioConferencingPolicy @@ -103,8 +104,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy) -[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallHoldPolicy.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallHoldPolicy.md index 479035c0ea..04e7b9d2f6 100644 --- a/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -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: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallholdpolicy +schema: 2.0.0 +title: Get-CsTeamsCallHoldPolicy --- # Get-CsTeamsCallHoldPolicy @@ -118,10 +119,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy) -[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallholdpolicy) -[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallholdpolicy) -[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallholdpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallParkPolicy.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallParkPolicy.md index e9b195959d..54137a272e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallParkPolicy.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallparkpolicy +schema: 2.0.0 +title: Get-CsTeamsCallParkPolicy --- # Get-CsTeamsCallParkPolicy ## SYNOPSIS - -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 Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. - -NOTE: the call park feature is currently only available in the desktop and web clients. Call Park functionality is currently completely disabled in mobile clients. +The Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. ## SYNTAX @@ -34,6 +33,8 @@ Get-CsTeamsCallParkPolicy [-Tenant ] [-Filter ] [-LocalStor ## DESCRIPTION The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature. 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 Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. +NOTE: the call park feature is currently only available in the desktop and web clients. Call Park functionality is currently completely disabled in mobile clients. + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallingPolicy.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallingPolicy.md index 44a936109d..a1863d8ee0 100644 --- a/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallingpolicy +schema: 2.0.0 +title: Get-CsTeamsCallingPolicy --- # Get-CsTeamsCallingPolicy @@ -53,8 +53,9 @@ Retrieves the calling policies with Identity starting with Sales. ## PARAMETERS -### -Identity -Specify the TeamsCallingPolicy that you would like to retrieve. +### -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 @@ -62,15 +63,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: 1 +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:*". +### -Identity +Specify the TeamsCallingPolicy that you would like to retrieve. ```yaml Type: String @@ -78,7 +78,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -99,10 +99,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallingpolicy) -[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallingpolicy) -[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallingpolicy) -[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsChannelsPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsChannelsPolicy.md index 444867452e..767b0b4d93 100644 --- a/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsChannelsPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamschannelspolicy +schema: 2.0.0 +title: Get-CsTeamsChannelsPolicy --- # Get-CsTeamsChannelsPolicy @@ -42,35 +44,35 @@ Retrieves all policies related to Teams & Channels that are available in your or ## PARAMETERS -### -Identity -Specify the unique name of a policy you would like to retrieve. Use one of the following values: - -- `Global` -- The name of a custom policy you've created. If the value contains spaces, enclose the value in quotation marks ("). Note that the Identity value shows as `Tag:`, but the `` value also works. -- `Default`: This is a template that's used to populate the default property values when you create a new policy or to reset the property values in the global policy in case you delete it. Note that the Identity value shows as `Tag:Default`, but the `Default` value also works. +### -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: XdsIdentity -Parameter Sets: Identity +Type: String +Parameter Sets: Filter Aliases: Required: False -Position: 1 +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. For example, to return a collection of all the per-user policies, use this syntax: -Filter "tag:". +### -Identity +Specify the unique name of a policy you would like to retrieve. Use one of the following values: + +- `Global` +- The name of a custom policy you've created. If the value contains spaces, enclose the value in quotation marks ("). Note that the Identity value shows as `Tag:`, but the `` value also works. +- `Default`: This is a template that's used to populate the default property values when you create a new policy or to reset the property values in the global policy in case you delete it. Note that the Identity value shows as `Tag:Default`, but the `Default` value also works. ```yaml -Type: String -Parameter Sets: Filter +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsClientConfiguration.md similarity index 82% rename from teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsClientConfiguration.md index 8ade0c1ba8..69bb11b7c7 100644 --- a/teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsClientConfiguration.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsclientconfiguration +schema: 2.0.0 +title: Get-CsTeamsClientConfiguration --- # Get-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. This cmdlet allows IT admins to retrieve the effective configuration for their organization. +This cmdlet allows IT admins to retrieve the effective configuration for their organization. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication.md index a480bcadfc..eddedafe26 100644 --- a/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication.md @@ -1,20 +1,20 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication +schema: 2.0.0 +title: Get-CsTeamsComplianceRecordingApplication --- # 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 @@ -32,6 +32,7 @@ Get-CsTeamsComplianceRecordingApplication [-Tenant ] [-Filter Applicable: Microsoft Teams + Policy instance name (optional). ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -72,8 +75,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy.md similarity index 71% rename from teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy.md index 9a3a36317e..244c82580e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamseducationassignmentsapppolicy +schema: 2.0.0 +title: Get-CsTeamsEducationAssignmentsAppPolicy --- # Get-CsTeamsEducationAssignmentsAppPolicy ## SYNOPSIS - -This policy is controlled by Global and Teams Service Administrators, and is used to turn on/off certain features only related to the Assignments Service, which runs for tenants with EDU licenses. This cmdlet allows you to retrieve the current values of your Education Assignments App Policy. At this time, you can only modify your global policy - this policy type does not support user-level custom policies. +This cmdlet allows you to retrieve the current values of your Education Assignments App Policy. ## SYNTAX @@ -32,7 +32,10 @@ Get-CsTeamsEducationAssignmentsAppPolicy [-Tenant ] [-Filter ] [] ``` ### Filter -```powershell + +``` Get-CsTeamsEducationConfiguration [-Filter ] [] ``` @@ -32,7 +35,7 @@ This cmdlet is used to retrieve the organization-wide education configuration fo You must be a Teams Service Administrator for your organization to run the cmdlet. -## Examples +## EXAMPLES ### Example 1 ```powershell @@ -91,4 +94,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration) +[Set-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamseducationconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy.md index 82cff25140..165b263df3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Get-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Get-CsTeamsEmergencyCallRoutingPolicy --- # Get-CsTeamsEmergencyCallRoutingPolicy @@ -55,31 +57,31 @@ Retrieves all emergency call routing policies with identity starting with Test. ## PARAMETERS -### -Identity -Specify the policy that you would like to retrieve. +### -Filter + Enables you to use wildcard characters when indicating the policy (or policies) to be returned. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +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. +### -Identity +Specify the policy that you would like to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -98,10 +100,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy) -[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy.md similarity index 87% rename from teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy.md index 2bae2ad08c..49eb1d04c8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Get-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy schema: 2.0.0 +title: Get-CsTeamsEmergencyCallingPolicy --- # Get-CsTeamsEmergencyCallingPolicy @@ -72,31 +74,31 @@ This example displays extended notifications set on emergency calling policy wit ## PARAMETERS -### -Identity -Specify the policy that you would like to retrieve. +### -Filter +The Filter parameter allows you to limit the number of results based on filters on Identity you specify. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to limit the number of results based on filters on Identity you specify. +### -Identity +Specify the policy that you would like to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -117,10 +119,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy) -[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy) -[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEnhancedEncryptionPolicy.md similarity index 86% rename from teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEnhancedEncryptionPolicy.md index d1c2fd903d..9f15733ba9 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEnhancedEncryptionPolicy.md @@ -1,111 +1,112 @@ ---- -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: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Get-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Returns information about the teams enhanced encryption policies configured for use in your organization. -## SYNTAX - -``` -Get-CsTeamsEnhancedEncryptionPolicy [-LocalStore] [[-Identity] ] [-Filter ] - [] -``` - -## DESCRIPTION -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 -```PowerShell -PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -``` - -The command shown in Example 1 returns information for all the teams enhanced encryption policies configured for use in the tenant. - -### EXAMPLE 2 -```PowerShell -PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerEnhancedEncryptionPolicy' -``` - -In Example 2, information is returned for a single teams enhanced encryption policy: the policy with the Identity ContosoPartnerEnhancedEncryptionPolicy. - -## PARAMETERS - -### -LocalStore -Internal Microsoft use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -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) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed 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](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Get-CsTeamsEnhancedEncryptionPolicy +--- + +# Get-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Returns information about the teams enhanced encryption policies configured for use in your organization. +## SYNTAX + +``` +Get-CsTeamsEnhancedEncryptionPolicy [-LocalStore] [[-Identity] ] [-Filter ] + [] +``` + +## DESCRIPTION +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 +```PowerShell +PS C:\> Get-CsTeamsEnhancedEncryptionPolicy +``` + +The command shown in Example 1 returns information for all the teams enhanced encryption policies configured for use in the tenant. + +### EXAMPLE 2 +```PowerShell +PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerEnhancedEncryptionPolicy' +``` + +In Example 2, information is returned for a single teams enhanced encryption policy: the policy with the Identity ContosoPartnerEnhancedEncryptionPolicy. + +## PARAMETERS + +### -Filter +If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed policies. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams 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) +Aliases: + +Required: False +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: 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 + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEventsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEventsPolicy.md index db497af1ae..e0fa56fe4e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEventsPolicy.md @@ -1,90 +1,91 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseventspolicy -title: Get-CsTeamsEventsPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsEventsPolicy - -## SYNOPSIS -Returns information about the Teams Events policy. Note that this policy is currently still in preview. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsEventsPolicy [[-Identity] ] [] -``` - -### Filter -``` -Get-CsTeamsEventsPolicy [-Filter ] [] -``` - -## DESCRIPTION -Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsEventsPolicy -``` - -Returns information for all Teams Events policies available for use in the tenant. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsEventsPolicy -Identity Global -``` - -Returns information for Teams Events policy with identity "Global". - -## PARAMETERS - -### -Filter -Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams Events policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamseventspolicy +schema: 2.0.0 +title: Get-CsTeamsEventsPolicy +--- + +# Get-CsTeamsEventsPolicy + +## SYNOPSIS +Returns information about the Teams Events policy. Note that this policy is currently still in preview. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsEventsPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsEventsPolicy [-Filter ] [] +``` + +## DESCRIPTION +Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsEventsPolicy +``` + +Returns information for all Teams Events policies available for use in the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsEventsPolicy -Identity Global +``` + +Returns information for Teams Events policy with identity "Global". + +## PARAMETERS + +### -Filter +Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsExternalAccessConfiguration.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsExternalAccessConfiguration.md index ca976fe3ca..d29bdca8ee 100644 --- a/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsExternalAccessConfiguration.md @@ -1,15 +1,16 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsexternalaccessconfiguration -title: Get-CsTeamsExternalAccessConfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsexternalaccessconfiguration schema: 2.0.0 +title: Get-CsTeamsExternalAccessConfiguration --- # 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. +This cmdlet returns the current settings of your organization. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFeedbackPolicy.md similarity index 92% rename from teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsFeedbackPolicy.md index 5000645a03..92b57b2818 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFeedbackPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Get-CsTeamsFeedbackPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfeedbackpolicy +schema: 2.0.0 +title: Get-CsTeamsFeedbackPolicy --- # Get-CsTeamsFeedbackPolicy @@ -42,31 +43,31 @@ In this example, we retrieve all the existing Teams feedback policies in the org ## PARAMETERS -### -Identity -The unique identifier of the policy. +### -Filter +Internal Microsoft use ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Internal Microsoft use +### -Identity +The unique identifier of the policy. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFilesPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsFilesPolicy.md index 0340a280a1..e87e325295 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFilesPolicy.md @@ -1,15 +1,16 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy -title: Get-CsTeamsFilesPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfilespolicy schema: 2.0.0 +title: Get-CsTeamsFilesPolicy --- # Get-CsTeamsFilesPolicy ## SYNOPSIS -Use the \`Get-CsTeamsFilesPolicy\` cmdlet to get a list of all pre-configured policy instances related to teams files. +Get a list of all pre-configured policy instances related to teams files. ## SYNTAX @@ -54,33 +55,33 @@ The filter value "tag:*" tells the Get-CsTeamsFilesPolicy cmdlet to return only ## 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. +### -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: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named 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. +### -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: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -101,10 +102,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md index 274a3a8171..14a32c67ce 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US 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/microsoftteams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration +schema: 2.0.0 +title: Get-CsTeamsFirstPartyMeetingTemplateConfiguration --- # Get-CsTeamsFirstPartyMeetingTemplateConfiguration @@ -55,6 +56,8 @@ Fetches all the first-party templates on the tenant. ### -Identity +> Applicable: Microsoft Teams + This parameter can be used to fetch a specific instance of the configuration. Note: This configuration is read only and will only have the Global instance. @@ -63,7 +66,6 @@ Note: This configuration is read only and will only have the Global instance. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -81,4 +83,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplateconfiguration) +[Get-CsTeamsMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplateconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration.md index c14d3fbeec..d20d862687 100644 --- a/teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration.md @@ -1,13 +1,13 @@ --- +author: tomkau external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestcallingconfiguration +Locale: en-US +manager: bulenteg Module Name: MicrosoftTeams -title: Get-CsTeamsGuestCallingConfiguration -schema: 2.0.0 -author: tomkau ms.author: tomkau -manager: bulenteg -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsguestcallingconfiguration +schema: 2.0.0 +title: Get-CsTeamsGuestCallingConfiguration --- # Get-CsTeamsGuestCallingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration.md index fb9aee778f..3555fb9882 100644 --- a/teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsguestmeetingconfiguration +schema: 2.0.0 +title: Get-CsTeamsGuestMeetingConfiguration --- # Get-CsTeamsGuestMeetingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration.md index c5dbf828bd..4202b878fb 100644 --- a/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsguestmessagingconfiguration +schema: 2.0.0 +title: Get-CsTeamsGuestMessagingConfiguration --- # Get-CsTeamsGuestMessagingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsIPPhonePolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsIPPhonePolicy.md index 4df635ab40..753f46a1ae 100644 --- a/teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsipphonepolicy schema: 2.0.0 +title: Get-CsTeamsIPPhonePolicy --- # Get-CsTeamsIPPhonePolicy @@ -48,31 +49,31 @@ Retrieves the IP Phone Policy with name "CommonAreaPhone". ## PARAMETERS -### -Identity -Specify the unique name of the TeamsIPPhonePolicy that you would like to retrieve. +### -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: Identity +Parameter Sets: Filter Aliases: -Required: True -Position: 1 +Required: False +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 policies, use this syntax: -Filter "tag:*". +### -Identity +Specify the unique name of the TeamsIPPhonePolicy that you would like to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaConnectivityPolicy.md similarity index 84% rename from teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaConnectivityPolicy.md index 8c4debe867..52ceb4a618 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: runli +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +title: Get-CsTeamsMediaConnectivityPolicy --- # Get-CsTeamsMediaConnectivityPolicy @@ -91,10 +92,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy) -[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy) -[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy) -[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaLoggingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaLoggingPolicy.md index 85ecd6cb9c..9de6e861c2 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaLoggingPolicy.md @@ -1,13 +1,14 @@ --- -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 -title: Get-CsTeamsMediaLoggingPolicy author: LeoKuhorev -ms.author: leokukharau +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US manager: shalages +Module Name: MicrosoftTeams +ms.author: leokukharau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmedialoggingpolicy schema: 2.0.0 +title: Get-CsTeamsMediaLoggingPolicy --- # Get-CsTeamsMediaLoggingPolicy @@ -58,42 +59,44 @@ Return Teams Media Logging policy that is set for the entire tenant. ## PARAMETERS -### -Identity +### -Filter -Unique identifier assigned to the Teams Media Logging policy. Note that Teams Media Logging policy has only one instance that has Identity "Enabled". +> Applicable: Microsoft Teams -Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. +Enables using wildcards when specifying the policy (or policies) to be retrieved. +Note that you cannot use both the Filter and the Identity parameters in the same command. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: -applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables using wildcards when specifying the policy (or policies) to be retrieved. -Note that you cannot use both the Filter and the Identity parameters in the same command. +### -Identity + +> Applicable: Microsoft Teams + +Unique identifier assigned to the Teams Media Logging policy. Note that Teams Media Logging policy has only one instance that has Identity "Enabled". + +Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -108,4 +111,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy) +[Grant-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmedialoggingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy.md similarity index 86% rename from teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy.md index d7a61ce63f..af50137246 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Get-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # Get-CsTeamsMeetingBrandingPolicy @@ -93,12 +93,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration.md similarity index 84% rename from teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration.md index 973021d356..18e25f56c3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbroadcastconfiguration +schema: 2.0.0 +title: Get-CsTeamsMeetingBroadcastConfiguration --- # Get-CsTeamsMeetingBroadcastConfiguration ## SYNOPSIS -Get-CsTeamsMeetingBroadcastConfiguration \[\[-Identity\] \\] \[-Tenant \\] \[-ExposeSDNConfigurationJsonBlob \\] \[-LocalStore\] \[\\] - -Get-CsTeamsMeetingBroadcastConfiguration \[-Tenant \\] \[-ExposeSDNConfigurationJsonBlob \\] \[-Filter \\] \[-LocalStore\] \[\\] +Gets Tenant level configuration for broadcast events in Teams. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy.md index 0b2ca7c3cd..c3d06519ad 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Get-CsTeamsMeetingBroadcastPolicy --- # Get-CsTeamsMeetingBroadcastPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingConfiguration.md similarity index 93% rename from teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingConfiguration.md index 3cd9448904..a317e68552 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingconfiguration +schema: 2.0.0 +title: Get-CsTeamsMeetingConfiguration --- # Get-CsTeamsMeetingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingPolicy.md similarity index 92% rename from teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingPolicy.md index 3679deb1f5..a8de0bd11c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingPolicy.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingpolicy +schema: 2.0.0 +title: Get-CsTeamsMeetingPolicy --- # Get-CsTeamsMeetingPolicy @@ -36,14 +38,14 @@ The Get-CsTeamsMeetingPolicy cmdlet enables you to return information about all ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell 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 -------------------------- +### Example 2 ```powershell Get-CsTeamsMeetingPolicy -Identity SalesPolicy ``` @@ -51,7 +53,7 @@ Get-CsTeamsMeetingPolicy -Identity SalesPolicy In Example 2, Get-CsTeamsMeetingPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell Get-CsTeamsMeetingPolicy | Where-Object {$_.AllowMeetNow -eq $True} ``` @@ -60,7 +62,7 @@ The preceding command returns a collection of all the meeting policies where the To do this, Get-CsTeamsMeetingPolicy 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 AllowMeetNow property is equal to True. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell Get-CsTeamsMeetingPolicy -Identity Global | fl NewMeetingRecordingExpirationDays ``` diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplateConfiguration.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplateConfiguration.md index f5121f5202..40422e491b 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsMeetingTemplateConfiguration -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplateConfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsMeetingTemplateConfiguration schema: 2.0.0 +title: Get-CsTeamsMeetingTemplateConfiguration --- # Get-CsTeamsMeetingTemplateConfiguration @@ -53,6 +54,8 @@ Fetches all the custom templates on the tenant. ### -Identity +> Applicable: Microsoft Teams + This parameter can be used to fetch a specific instance of the configuration. Note: This configuration is read only and will only have the Global instance. @@ -61,7 +64,6 @@ Note: This configuration is read only and will only have the Global instance. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -79,4 +81,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsfirstpartymeetingtemplateconfiguration) +[Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfirstpartymeetingtemplateconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 86% rename from teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplatePermissionPolicy.md index 22af122659..3a877a3be8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplatePermissionPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Get-CsTeamsMeetingTemplatePermissionPolicy --- # Get-CsTeamsMeetingTemplatePermissionPolicy @@ -82,36 +83,38 @@ Note: _The "Tag:" prefix can be ignored when specifying the identity._ ## PARAMETERS -### -Identity +### -Filter -This parameter can be used to fetch a specific instance of the policy. +> Applicable: Microsoft Teams + +This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None Accept pipeline input: False -Accept wildcard characters: False +Accept wildcard characters: True ``` -### -Filter +### -Identity -This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. +> Applicable: Microsoft Teams + +This parameter can be used to fetch a specific instance of the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None Accept pipeline input: False -Accept wildcard characters: True +Accept wildcard characters: False ``` ### CommonParameters @@ -124,10 +127,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingConfiguration.md similarity index 90% rename from teams/teams-ps/teams/get-csteamsmessagingconfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingConfiguration.md index fc5ad06309..7a197af8c4 100644 --- a/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingConfiguration.md @@ -1,93 +1,94 @@ ---- -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) +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsMessagingConfiguration +schema: 2.0.0 +title: Get-CsTeamsMessagingConfiguration +--- + +# 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/microsoftteams/set-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingPolicy.md index 8f998b1d2f..055fdc8614 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingPolicy.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmessagingpolicy +schema: 2.0.0 +title: Get-CsTeamsMessagingPolicy --- # Get-CsTeamsMessagingPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMobilityPolicy.md similarity index 93% rename from teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMobilityPolicy.md index 3a147f9743..d6e704548c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmobilitypolicy +schema: 2.0.0 +title: Get-CsTeamsMobilityPolicy --- # Get-CsTeamsMobilityPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMultiTenantOrganizationConfiguration.md similarity index 85% rename from teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMultiTenantOrganizationConfiguration.md index 73ca7780ac..d4c7f80275 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMultiTenantOrganizationConfiguration.md @@ -1,15 +1,16 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: samlyu +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmultitenantorganizationconfiguration +schema: 2.0.0 +title: Get-CsTeamsMultiTenantOrganizationConfiguration --- -# Get-CsTeamsMultiTenantOrganizationConfiguration +# Get-CsTeamsMultiTenantOrganizationConfiguration ## SYNOPSIS diff --git a/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy.md index f098d86971..5fe67a86d5 100644 --- a/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsnetworkroamingpolicy schema: 2.0.0 +title: Get-CsTeamsNetworkRoamingPolicy --- # Get-CsTeamsNetworkRoamingPolicy @@ -44,14 +44,14 @@ To enable the network roaming policy for users who are not Enterprise Voice enab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsTeamsNetworkRoamingPolicy ``` In Example 1, Get-CsTeamsNetworkRoamingPolicy is called without any additional parameters; this returns a collection of all the teams network roaming policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsTeamsNetworkRoamingPolicy -Identity OfficePolicy ``` @@ -61,13 +61,12 @@ Because identities are unique, this command will never return more than one item ## PARAMETERS -### -Identity -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. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False @@ -77,12 +76,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +### -Identity +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: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False diff --git a/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNotificationAndFeedsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsNotificationAndFeedsPolicy.md index 95ac82e696..b0b1eb93f8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNotificationAndFeedsPolicy.md @@ -1,100 +1,101 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsnotificationandfeedspolicy +schema: 2.0.0 +title: Get-CsTeamsNotificationAndFeedsPolicy +--- + +# 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/MicrosoftTeams/Get-CsTeamsPersonalAttendantPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsPersonalAttendantPolicy.md new file mode 100644 index 0000000000..3d4f0402bb --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsPersonalAttendantPolicy.md @@ -0,0 +1,106 @@ +--- +applicable: Microsoft Teams +author: juliiva +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: jomarque +Module Name: MicrosoftTeams +ms.author: juliiva +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamspersonalattendantpolicy +schema: 2.0.0 +title: Get-CsTeamsPersonalAttendantPolicy +--- + +# Get-CsTeamsPersonalAttendantPolicy + +## SYNOPSIS + +**Limited Preview:** Functionality described in this document is currently in limited preview and only authorized organizations have access. + +Returns information about the Teams personal attendant policies configured for use in your organization. +Teams personal attendant policies help determine which users are able to use personal attendant and its functionalities within Microsoft Teams. + +## SYNTAX + +``` +Get-CsTeamsPersonalAttendantPolicy [-Identity ] [-Filter ] [] +``` + +## DESCRIPTION + +Returns information about the Teams personal attendant policies configured for use in your organization. +Teams personal attendant policies help determine which users are able to use personal attendant and its functionalities within Microsoft Teams. + +## EXAMPLES + +### Example 1 +``` +Get-CsTeamsPersonalAttendantPolicy -Identity SalesPersonalAttendantPolicy +``` + +Retrieves the personal attendant policy with the Identity "SalesPersonalAttendantPolicy". + +### Example 2 +``` +Get-CsTeamsPersonalAttendantPolicy -Filter "tag:Sales*" +``` + +Retrieves the personal attendant policies with Identity starting with Sales. + +## PARAMETERS + +### -Identity +Specify the TeamsPersonalAttendantPolicy that you would like to retrieve. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +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 + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +The cmdlet is available in Teams PowerShell module 7.2.1-preview or later. + +## RELATED LINKS + +[New-CsTeamsPersonalAttendantPolicy](./new-csteamspersonalattendantpolicy.md) + +[Set-CsTeamsPersonalAttendantPolicy](./set-csteamspersonalattendantpolicy.md) + +[Grant-CsTeamsPersonalAttendantPolicy](./grant-csteamspersonalattendantpolicy.md) + +[Remove-CsTeamsPersonalAttendantPolicy](./remove-csteamspersonalattendantpolicy.md) diff --git a/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRecordingRollOutPolicy.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsRecordingRollOutPolicy.md index f4c168932c..493ee2f5a3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams ms.author: ronwa +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsrecordingrolloutpolicy +schema: 2.0.0 +title: Get-CsTeamsRecordingRollOutPolicy --- # Get-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md index d0da8be66e..5231769195 100644 --- a/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,99 +1,102 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Get-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Get-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +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). + +## EXAMPLES + +## 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/MicrosoftTeams/Get-CsTeamsSettingsCustomApp.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSettingsCustomApp.md index 74dc4c20ca..a170e558de 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSettingsCustomApp.md @@ -1,83 +1,84 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssettingscustomapp +schema: 2.0.0 +title: Get-CsTeamsSettingsCustomApp +--- + +# 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/microsoftteams/set-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSharedCallingRoutingPolicy.md similarity index 87% rename from teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSharedCallingRoutingPolicy.md index 817189ce6e..2f2ee7b031 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -title: Get-CsTeamsSharedCallingRoutingPolicy -schema: 2.0.0 author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy +schema: 2.0.0 +title: Get-CsTeamsSharedCallingRoutingPolicy --- # Get-CsTeamsSharedCallingRoutingPolicy @@ -61,35 +60,35 @@ 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. - -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. +### -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: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +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:*". +### -Identity +Unique identifier of the Teams shared calling routing policy to be retrieved. + +You cannot use wildcard characters when specifying the Identity. If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsSharedCallingRoutingPolicy +returns all the Teams shared calling routing policies configured for use in the organization. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -105,10 +104,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy) -[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsAppPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsAppPolicy.md index e669a7e816..371677e591 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsAppPolicy.md @@ -1,107 +1,108 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsapppolicy +schema: 2.0.0 +title: Get-CsTeamsShiftsAppPolicy +--- + +# 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/MicrosoftTeams/Get-CsTeamsShiftsConnection.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnection.md index 5bfed6ecbd..8f0e90f914 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection schema: 2.0.0 +title: Get-CsTeamsShiftsConnection --- # Get-CsTeamsShiftsConnection @@ -109,6 +110,21 @@ Returns the connection with the specified -ConnectionId. ## PARAMETERS +### -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 +``` + ### -Break Wait for .NET debugger to attach. @@ -229,21 +245,6 @@ 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). @@ -261,8 +262,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnection) -[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnection) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionConnector.md similarity index 85% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionConnector.md index b236e9c29c..974ae50be3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionConnector.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionConnector -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionconnector schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionConnector --- # Get-CsTeamsShiftsConnectionConnector @@ -60,10 +61,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection) -[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionErrorReport.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionErrorReport.md index adf41720e0..0df570692a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionErrorReport.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionErrorReport -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionerrorreport schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionErrorReport --- # Get-CsTeamsShiftsConnectionErrorReport @@ -141,24 +142,10 @@ Returns the error report created after `2022-12-12T19:11:39.073Z`. ## PARAMETERS -### -ErrorReportId - -The ID of the error report. - -```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 -``` - ### -Activeness +> Applicable: Microsoft Teams + The flag indicating results should have which activeness. Set this to `ActiveOnly` to get Error reports that are not resolved. Set this to `InactiveOnly` to get Error reports that are resolved. @@ -168,7 +155,6 @@ Set this to `Both` to get both active and inactive Error reports. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -176,15 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId +### -After -The UUID of a WFM connection. +> Applicable: Microsoft Teams + +The timestamp indicating results should be after which date and time. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -192,15 +179,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorInstanceId - -The UUID of a connector instance. +### -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) +Parameter Sets: Get Aliases: -Applicable: Microsoft Teams + Required: False Position: Named Default value: None @@ -208,15 +194,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamId +### -Before -The UUID of a team in Graph. +> Applicable: Microsoft Teams + +The timestamp indicating results should be before which date and time. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -224,15 +211,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Operation - -The name of the action of the controller or the name of the command. +### -Break +Wait for the .NET debugger to attach. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + Required: False Position: Named Default value: None @@ -240,15 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Procedure +### -Code -The name of the executing function or procedure. +> Applicable: Microsoft Teams + +The enum value of error code, human readable string defined in codebase. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -256,15 +243,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Code +### -ConnectionId -The enum value of error code, human readable string defined in codebase. +> Applicable: Microsoft Teams + +The UUID of a WFM connection. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -272,15 +260,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Before +### -ConnectorInstanceId -The timestamp indicating results should be before which date and time. +> Applicable: Microsoft Teams + +The UUID of a connector instance. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -288,15 +277,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -After +### -ErrorReportId -The timestamp indicating results should be after which date and time. +> Applicable: Microsoft Teams + +The ID of the error report. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -304,12 +294,12 @@ 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. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: Get +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: Required: False @@ -319,11 +309,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for the .NET debugger to attach. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: SwitchParameter +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -334,29 +324,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -InputObject +Identity Parameter ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -Operation + +> Applicable: Microsoft Teams + +The name of the action of the controller or the name of the command. ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -364,18 +356,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter +### -Procedure + +> Applicable: Microsoft Teams + +The name of the executing function or procedure. ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity +Type: String +Parameter Sets: (All) Aliases: - -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -423,6 +417,23 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamId + +> Applicable: Microsoft Teams + +The UUID of a team in Graph. + +```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). @@ -434,4 +445,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Disable-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport) +[Disable-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/microsoftteams/disable-csteamsshiftsconnectionerrorreport) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionInstance.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionInstance.md index 9cae80f516..470a011735 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: leonardospina external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionInstance -author: leonardospina ms.author: lespina -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionInstance --- # Get-CsTeamsShiftsConnectionInstance @@ -272,8 +273,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionOperation.md similarity index 84% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionOperation.md index e1910f5da5..d837395e0a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionOperation.md @@ -1,31 +1,32 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionOperation -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionoperation schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionOperation --- # Get-CsTeamsShiftsConnectionOperation ## SYNOPSIS -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). +This cmdlet gets the requested batch mapping operation. ## SYNTAX ### Get (Default) -```powershell +``` Get-CsTeamsShiftsConnectionOperation -OperationId [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` ### GetViaIdentity -```powershell +``` Get-CsTeamsShiftsConnectionOperation -InputObject [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] @@ -33,7 +34,7 @@ Get-CsTeamsShiftsConnectionOperation -InputObject Get-CsTeamsShiftsConnectionOperation -OperationId c79131b7-9ecb-484b-a8df-2959c7c1e5f2 ``` + ```output CreatedDateTime LastActionDateTime Id Status TenantId Type WfmConnectorInstanceId ---------------- ------------------ ----------- ------ -------- ---- ---------------------- -12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2959c7c1e5f2 NotStarted dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a TeamsMappingOperation WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a113e01 +--------------- ------------------ ----------- ------ -------- ---- ---------------------- +12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2959c7c1e5f2 NotStarted dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a TeamsMappingOperation WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a113e01 ``` Returns the details of batch mapping operation with ID `c79131b7-9ecb-484b-a8df-2959c7c1e5f2`. @@ -182,4 +184,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap) +[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectionbatchteammap) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionSyncResult.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionSyncResult.md index d893f5cf7e..5f5946b32f 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionSyncResult.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionSyncResult -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionsyncresult +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionsyncresult schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionSyncResult --- # Get-CsTeamsShiftsConnectionSyncResult @@ -46,13 +47,14 @@ 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](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). +> Applicable: Microsoft Teams + +The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -60,35 +62,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamId +### -InputObject -The Teams team ID. It can be retrieved by visiting [AzureAAD](https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). +The Identity parameter. ```yaml -Type: String -Parameter Sets: (All) +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -InputObject +### -TeamId -The Identity parameter. +> Applicable: Microsoft Teams + +The Teams team ID. It can be retrieved by visiting [AzureAAD](https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity +Type: String +Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -103,4 +106,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionTeamMap.md similarity index 87% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionTeamMap.md index 7bdc708135..a83288964a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionTeamMap.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionTeamMap -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionteammap schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionTeamMap --- # Get-CsTeamsShiftsConnectionTeamMap @@ -23,7 +24,7 @@ Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId -InputObject Applicable: Microsoft Teams + The ID of the connection instance. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -90,6 +92,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Remove-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectionteammap) +[Remove-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectionteammap) -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmTeam.md similarity index 92% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmTeam.md index f65e7c3eed..cd1c59aeee 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmTeam.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionWfmTeam -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmteam schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionWfmTeam --- # Get-CsTeamsShiftsConnectionWfmTeam @@ -107,62 +108,64 @@ Returns the WFM teams for the WFM connection with ID `a2d1b091-5140-4dd2-987a-98 ## PARAMETERS -### -ConnectorInstanceId - -The ID of the connection instance. You can retrieve it by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). +### -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) +Parameter Sets: Get1, GetViaIdentity1 Aliases: -Applicable: Microsoft Teams -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId - -The ID of the connection. You can retrieve it by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -Break +Wait for the .NET debugger to attach. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -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. +### -ConnectionId + +> Applicable: Microsoft Teams + +The ID of the connection. You can retrieve it by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). ```yaml Type: String -Parameter Sets: Get1, GetViaIdentity1 +Parameter Sets: (All) Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for the .NET debugger to attach. +### -ConnectorInstanceId + +> Applicable: Microsoft Teams + +The ID of the connection instance. You can retrieve it by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -270,8 +273,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection) -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[Get-CsTeamsShiftsConnectionWfmUser](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser) +[Get-CsTeamsShiftsConnectionWfmUser](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmuser) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmUser.md similarity index 84% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmUser.md index f32eda9d1a..6b24542c66 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmUser.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionWfmUser -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmuser schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionWfmUser --- # Get-CsTeamsShiftsConnectionWfmUser @@ -49,13 +50,14 @@ 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](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). +> Applicable: Microsoft Teams + +The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -63,35 +65,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WfmTeamId +### -InputObject -The Teams team ID. It can be retrieved by running [Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam). +The identity parameter. ```yaml -Type: String -Parameter Sets: (All) +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -InputObject +### -WfmTeamId -The identity parameter. +> Applicable: Microsoft Teams + +The Teams team ID. It can be retrieved by running [Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmteam). ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity +Type: String +Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -106,6 +109,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam) +[Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmteam) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsPolicy.md similarity index 86% rename from teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsPolicy.md index 05e0a5d12c..9e7914d861 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsPolicy.md @@ -1,99 +1,102 @@ ---- -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 ---- - -# Get-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. - -## SYNTAX - -### Identity (Default) -```powershell -Get-CsTeamsShiftsPolicy [[-Identity] ] [] -``` - -### 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 -```powershell -PS C:\> Get-CsTeamsShiftsPolicy -``` - -Gets the properties of all instances of the TeamsShiftPolicy. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -``` - -Gets the properties of the OffShiftAccessMessage1Always instance of the TeamsShiftPolicy. - -## PARAMETERS - -### -Identity -Policy instance name. Optional. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the 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 - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamsshiftspolicy +schema: 2.0.0 +title: Get-CsTeamsShiftsPolicy +--- + +# Get-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsShiftsPolicy [[-Identity] ] [] +``` + +### 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 +```powershell +PS C:\> Get-CsTeamsShiftsPolicy +``` + +Gets the properties of all instances of the TeamsShiftPolicy. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always +``` + +Gets the properties of the OffShiftAccessMessage1Always instance of the TeamsShiftPolicy. + +## 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: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Microsoft Teams + +Policy instance name. Optional. + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSipDevicesConfiguration.md similarity index 86% rename from teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSipDevicesConfiguration.md index bae35132f4..97268744f3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSipDevicesConfiguration.md @@ -1,11 +1,12 @@ --- +author: anmandav external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsSipDevicesConfiguration -author: anmandav ms.author: anmandav -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssipdevicesconfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssipdevicesconfiguration schema: 2.0.0 +title: Get-CsTeamsSipDevicesConfiguration --- # Get-CsTeamsSipDevicesConfiguration @@ -16,7 +17,7 @@ This cmdlet is used to retrieve the organization-wide Teams SIP devices configur ## SYNTAX -```powershell +``` Get-CsTeamsSipDevicesConfiguration [] ``` @@ -26,7 +27,7 @@ This cmdlet is used to retrieve the organization-wide Teams SIP devices configur To execute the cmdlet, you need to hold a role within your organization such as Global Reader, Teams Administrator, or Teams Communication Administrator. -## Examples +## EXAMPLES ### Example 1 @@ -39,6 +40,8 @@ BulkSignIn : Enabled In this example, the organization has Bulk SignIn enabled for their SIP devices. +## 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). @@ -50,4 +53,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamssipdevicesconfiguration) +[Set-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssipdevicesconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliance.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliance.md index e62879f6a5..9c1be693cd 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliance.md @@ -1,95 +1,100 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssurvivablebranchappliance +schema: 2.0.0 +title: Get-CsTeamsSurvivableBranchAppliance +--- + +# Get-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Gets the Survivable Branch Appliance (SBA) configured in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsSurvivableBranchAppliance [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsSurvivableBranchAppliance [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +## 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/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliancePolicy.md index c978c4c0a6..dd1dfa3bb9 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,95 +1,100 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Get-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Get-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Get the Survivable Branch Appliance (SBA) Policy defined in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsSurvivableBranchAppliancePolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +## 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/MicrosoftTeams/Get-CsTeamsTargetingPolicy.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsTargetingPolicy.md index 8b48de854b..434b596532 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTargetingPolicy.md @@ -1,111 +1,109 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstargetingpolicy +schema: 2.0.0 +title: Get-CsTeamsTargetingPolicy +--- + +# Get-CsTeamsTargetingPolicy + +## SYNOPSIS +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. + +## 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. + +## 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/microsoftteams/set-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTemplatePermissionPolicy.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsTemplatePermissionPolicy.md index 783c5f16c2..d3f2915002 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTemplatePermissionPolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy -title: Get-CsTeamsTemplatePermissionPolicy author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy schema: 2.0.0 +title: Get-CsTeamsTemplatePermissionPolicy --- # Get-CsTeamsTemplatePermissionPolicy @@ -119,8 +119,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy) -[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy) -[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTranslationRule.md similarity index 68% rename from teams/teams-ps/teams/Get-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsTranslationRule.md index 402b525db2..d1f7344b2c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstranslationrule +schema: 2.0.0 +title: Get-CsTeamsTranslationRule --- # Get-CsTeamsTranslationRule @@ -19,12 +20,12 @@ Cmdlet to get an existing number manipulation rule (or list of rules). ### Identity (Default) ``` -Get-CsTeamsTranslationRule [[-Identity] ] [] +Get-CsTeamsTranslationRule [[-Identity] ] [-MsftInternalProcessingMode ] [] ``` ### Filter ``` -Get-CsTeamsTranslationRule [-Filter ] [] +Get-CsTeamsTranslationRule [-MsftInternalProcessingMode ] [-Filter ] [] ``` ## DESCRIPTION @@ -55,14 +56,34 @@ This command will show Identity, Name, Description, Pattern, and Translation par ## PARAMETERS +### -Filter + +> Applicable: Microsoft Teams + +The filter to use against the Identity of translation rules. + +```yaml +Type: System.String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Microsoft Teams + Identifier of the specific translation rule to display. ```yaml -Type: String -Parameter Sets: (Identity) +Type: System.String +Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -71,23 +92,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The filter to use against the Identity of translation rules. +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} ```yaml -Type: String -Parameter Sets: (Filter) +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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -96,10 +117,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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) +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstranslationrule) + +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamstranslationrule) -[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstranslationrule) -[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUnassignedNumberTreatment.md similarity index 66% rename from teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUnassignedNumberTreatment.md index cd8a81e96e..ca4f840bf8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUnassignedNumberTreatment.md @@ -1,105 +1,125 @@ ---- -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 -title: Get-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Get-CsTeamsUnassignedNumberTreatment - -## SYNOPSIS -Displays a specific or all treatments for how calls to an unassigned number range should be routed. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsUnassignedNumberTreatment [[-Identity] ] [] -``` - -### Filter -``` -Get-CsTeamsUnassignedNumberTreatment [-Filter ] [] -``` - -## DESCRIPTION -This cmdlet displays a specific or all treatments for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsTeamsUnassignedNumberTreatment -Identity MainAA -``` -This example displays the treatment MainAA. - -### Example 2 -```powershell -Get-CsTeamsUnassignedNumberTreatment -``` -This example displays all configured treatments. - -### Example 3 -```powershell -Get-CsTeamsUnassignedNumberTreatment -Filter Ann* -``` -This example displays all configured treatments with an Identity starting with Ann. - -## PARAMETERS - -### -Filter -Enables you to limit the returned data by filtering on the Identity attribute. - -```yaml -Type: String -Parameter Sets: (Filter) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Id of the specific treatment to show. - -```yaml -Type: System.String -Parameter Sets: (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 -The cmdlet is available in Teams PS module 2.5.1 or later. - -## RELATED LINKS -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) - -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) - -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment +schema: 2.0.0 +title: Get-CsTeamsUnassignedNumberTreatment +--- + +# Get-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +Displays a specific or all treatments for how calls to an unassigned number range should be routed. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsUnassignedNumberTreatment [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter +``` +Get-CsTeamsUnassignedNumberTreatment [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +This cmdlet displays a specific or all treatments for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsTeamsUnassignedNumberTreatment -Identity MainAA +``` +This example displays the treatment MainAA. + +### Example 2 +```powershell +Get-CsTeamsUnassignedNumberTreatment +``` +This example displays all configured treatments. + +### Example 3 +```powershell +Get-CsTeamsUnassignedNumberTreatment -Filter Ann* +``` +This example displays all configured treatments with an Identity starting with Ann. + +## PARAMETERS + +### -Filter + +> Applicable: Microsoft Teams + +Enables you to limit the returned data by filtering on the Identity attribute. + +```yaml +Type: System.String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the specific treatment to show. + +```yaml +Type: System.String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +## RELATED LINKS + +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment) + +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpdateManagementPolicy.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpdateManagementPolicy.md index 3bcd814b61..5f10990f13 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: gnamun +Module Name: MicrosoftTeams +ms.author: vargasj +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupdatemanagementpolicy +schema: 2.0.0 +title: Get-CsTeamsUpdateManagementPolicy --- # Get-CsTeamsUpdateManagementPolicy @@ -42,32 +43,32 @@ In this example, we retrieve all the existing Teams Update Management policies i ## PARAMETERS -### -Identity -The unique identifier of the policy. +### -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: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named 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. +### -Identity +The unique identifier of the policy. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradeConfiguration.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradeConfiguration.md index 7443bce227..7024501240 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradeConfiguration.md @@ -1,19 +1,21 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration +schema: 2.0.0 +title: Get-CsTeamsUpgradeConfiguration --- # 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. +Returns information related to managing the upgrade to Teams from Skype for Business. ## SYNTAX @@ -114,10 +116,10 @@ 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) +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsupgradeconfiguration) -[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradepolicy) -[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/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/MicrosoftTeams/Get-CsTeamsUpgradePolicy.md similarity index 84% rename from teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradePolicy.md index 1da715da85..6b0387f238 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradePolicy.md @@ -1,22 +1,21 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy +schema: 2.0.0 +title: Get-CsTeamsUpgradePolicy --- # 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**). +This cmdlet returns the set of instances of this policy. ## SYNTAX @@ -31,7 +30,11 @@ Get-CsTeamsUpgradePolicy [-Tenant ] [-Filter ] [-LocalStore] [ [!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**). + 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. @@ -127,45 +130,51 @@ 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. +### -Filter + +> Applicable: Microsoft Teams + +{{Fill Filter Description}} ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -{{Fill Filter Description}} + +### -Identity + +> Applicable: Microsoft Teams + +If identity parameter is passed, this will return a specific instance. If no identity parameter is specified, the cmdlet returns all instances. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### -Tenant + +> Applicable: Microsoft Teams + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -189,10 +198,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradeconfiguration) +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradeconfiguration) -[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsupgradeconfiguration) -[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/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/MicrosoftTeams/Get-CsTeamsVdiPolicy.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVdiPolicy.md index 41be427ab3..aadd7a94a4 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVdiPolicy.md @@ -1,99 +1,100 @@ ---- -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 +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvdipolicy +schema: 2.0.0 +title: Get-CsTeamsVdiPolicy +--- + +# Get-CsTeamsVdiPolicy + +## SYNOPSIS +The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. + +## 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. + +## 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/teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy.md similarity index 76% rename from teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy.md index be0b2b593d..3a47b7b839 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvideointeropservicepolicy +schema: 2.0.0 +title: Get-CsTeamsVideoInteropServicePolicy --- # Get-CsTeamsVideoInteropServicePolicy ## SYNOPSIS - -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. +The Get-CsTeamsVideoInteropServicePolicy cmdlet allows you to identify the pre-constructed policies that you can use in your organization. ## SYNTAX @@ -32,9 +32,12 @@ 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. - -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. +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. You +can assign this policy to one or more of your users leveraging the +Grant-CsTeamsVideoInteropServicePolicy cmdlet. ## EXAMPLES diff --git a/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVirtualAppointmentsPolicy.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVirtualAppointmentsPolicy.md index 5d698766b8..c26c238fb2 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy -title: Get-CsTeamsVirtualAppointmentsPolicy -schema: 2.0.0 ms.author: erocha -manager: sonaggarwal -author: emmanuelrocha001 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy +schema: 2.0.0 +title: Get-CsTeamsVirtualAppointmentsPolicy --- # Get-CsTeamsVirtualAppointmentsPolicy @@ -115,10 +116,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVoiceApplicationsPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVoiceApplicationsPolicy.md index 0a73f7a287..1e9c968987 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy -title: Get-CsTeamsVoiceApplicationsPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy schema: 2.0.0 +title: Get-CsTeamsVoiceApplicationsPolicy --- # Get-CsTeamsVoiceApplicationsPolicy @@ -51,6 +52,23 @@ The command shown in Example 3 returns information about all the Teams voice app ## PARAMETERS +### -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: + +-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 voice applications policy to be retrieved. To return the global policy, use this syntax: @@ -76,23 +94,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: - --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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -106,10 +107,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy) -[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy) -[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLoadPolicy.md similarity index 85% rename from teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLoadPolicy.md index 894f122d6b..f227b55115 100644 --- a/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLoadPolicy.md @@ -1,115 +1,116 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworkloadpolicy +schema: 2.0.0 +title: Get-CsTeamsWorkLoadPolicy +--- + +# 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/microsoftteams/remove-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLocationDetectionPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLocationDetectionPolicy.md index 2dd5152b3d..a0d5a1ee49 100644 --- a/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur 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 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy +schema: 2.0.0 +title: Get-CsTeamsWorkLocationDetectionPolicy --- # Get-CsTeamsWorkLocationDetectionPolicy @@ -116,10 +117,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy) -[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy) -[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy) -[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Get-CsTenant.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenant.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTenant.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenant.md index 2558268bcf..e014208800 100644 --- a/teams/teams-ps/teams/Get-CsTenant.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenant.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenant +schema: 2.0.0 +title: Get-CsTenant --- # Get-CsTenant @@ -93,7 +95,7 @@ In the Teams PowerShell Module version 3.0.0 or later, the following attributes ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenant ``` @@ -104,13 +106,15 @@ Organizations will have only one tenant. ## PARAMETERS ### -DomainController + +> Applicable: Microsoft Teams + This parameter is not used with Skype for Business Online and will be deprecated in the near future. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -121,6 +125,8 @@ Accept wildcard characters: False ### -Filter +> Applicable: Microsoft Teams + **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. @@ -140,7 +146,6 @@ You cannot use both the Identity parameter and the Filter parameter in the same Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -151,6 +156,8 @@ Accept wildcard characters: False ### -Identity +> Applicable: Microsoft Teams + **Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. Unique identifier for the tenant. @@ -164,7 +171,6 @@ If you do not include either the Identity or the Filter parameter then the `Get- Type: OUIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -175,6 +181,8 @@ Accept wildcard characters: False ### -ResultSize +> Applicable: Microsoft Teams + **Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. Enables you to limit the number of records returned by the cmdlet. @@ -189,7 +197,6 @@ If you set the tenants to 7 but you have only three contacts in your forest, the Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers.md index 8f125d7c02..dbe7682f5c 100644 --- a/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers +schema: 2.0.0 +title: Get-CsTenantBlockedCallingNumbers --- # Get-CsTenantBlockedCallingNumbers @@ -43,7 +45,7 @@ The scope of tenant blocked calling numbers is global across the given tenant. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantBlockedCallingNumbers ``` @@ -52,31 +54,31 @@ This example returns the tenant global settings for blocked calling numbers. It ## PARAMETERS -### -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. +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to limit the number of results based on filters you specify. +### -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: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -111,6 +113,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/set-cstenantblockedcallingnumbers) +[Set-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantblockedcallingnumbers) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Get-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantDialPlan.md similarity index 87% rename from teams/teams-ps/teams/Get-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantDialPlan.md index 6981f68fc3..1d92d218a5 100644 --- a/teams/teams-ps/teams/Get-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan +schema: 2.0.0 +title: Get-CsTenantDialPlan --- # Get-CsTenantDialPlan @@ -37,14 +38,14 @@ You can use the Get-CsTenantDialPlan cmdlet to retrieve specific information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantDialPlan ``` This example retrieves all existing tenant dial plans. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTenantDialPlan -Identity Vt1TenantDialPlan2 ``` @@ -54,13 +55,15 @@ This example retrieves the tenant dial plan that has an identity of Vt1TenantDia ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml Type: String Parameter Sets: (Filter) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter is a unique identifier that designates the name of the tenant dial plan to retrieve. ```yaml Type: String Parameter Sets: (Identity) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -98,10 +103,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cstenantdialplan) -[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan) -[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) -[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantdialplan) diff --git a/teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantFederationConfiguration.md similarity index 93% rename from teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantFederationConfiguration.md index 8a7b9f790c..339936d807 100644 --- a/teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantFederationConfiguration.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantfederationconfiguration +schema: 2.0.0 +title: Get-CsTenantFederationConfiguration --- # Get-CsTenantFederationConfiguration @@ -44,14 +46,14 @@ However, administrators must use the Get-CsTenantPublicProvider cmdlet in order ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantFederationConfiguration ``` The command shown in Exercise 1 returns federation configuration information for the current tenant: -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTenantFederationConfiguration | Select-Object -ExpandProperty AllowedDomains ``` @@ -61,6 +63,9 @@ In Example 2, information is returned for all the allowed domains found on the f ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + Enables you to use wildcard characters in order to return a collection of tenant federation configuration settings. Because each tenant is limited to a single, global collection of federation configuration settings there is no need to use the Filter parameter. However, this is valid syntax for the Get-CsTenantFederationConfiguration cmdlet: @@ -71,7 +76,6 @@ However, this is valid syntax for the Get-CsTenantFederationConfiguration cmdlet Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + Specifies the collection of tenant federation configuration settings to be returned. Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the Get-CsTenantFederationConfiguration cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. @@ -92,7 +99,6 @@ For example: Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -102,13 +108,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Microsoft Teams + This parameter is not used with Skype for Business Online. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -118,6 +126,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + Globally unique identifier (GUID) of the tenant account whose federation settings are being returned. For example: @@ -135,7 +146,6 @@ The Tenant parameter is primarily for use in a hybrid deployment. Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -159,4 +169,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantLicensingConfiguration.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantLicensingConfiguration.md index 5eab013035..59e90133a0 100644 --- a/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantLicensingConfiguration.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantlicensingconfiguration +schema: 2.0.0 +title: Get-CsTenantLicensingConfiguration --- # Get-CsTenantLicensingConfiguration @@ -40,7 +42,7 @@ If not, then licensing information is not available in the admin center. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantLicensingConfiguration ``` @@ -50,6 +52,9 @@ The command shown in Example 1 returns licensing configuration information for t ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + Enables you to use wildcard characters in order to return a collection of tenant licensing configuration settings. Because each tenant is limited to a single, global collection of licensing configuration settings there is no need to use the Filter parameter. @@ -57,7 +62,6 @@ Because each tenant is limited to a single, global collection of licensing confi Type: String Parameter Sets: Filter Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -67,6 +71,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + Specifies the collection of tenant licensing configuration settings to be returned. Because each tenant is limited to a single, global collection of licensing settings there is no need include this parameter when calling the Get-CsTenantLicensingConfiguration cmdlet. @@ -74,7 +81,6 @@ Because each tenant is limited to a single, global collection of licensing setti Type: XdsIdentity Parameter Sets: Identity Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -113,4 +119,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTenant](https://learn.microsoft.com/powershell/module/teams/get-cstenant) +[Get-CsTenant](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenant) diff --git a/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantMigrationConfiguration.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantMigrationConfiguration.md index 23ce62dd9e..00d6e5e756 100644 --- a/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantMigrationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantmigrationconfiguration +schema: 2.0.0 +title: Get-CsTenantMigrationConfiguration --- # Get-CsTenantMigrationConfiguration @@ -29,7 +31,7 @@ The Get-CsTenantMigrationConfiguration cmdlet retrieves the Meeting Migration Se ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsTenantMigrationConfiguration ``` @@ -39,13 +41,15 @@ This example shows the MMS configuration in your organization. ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -55,13 +59,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -71,13 +77,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -87,13 +95,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -112,4 +122,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration) +[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantmigrationconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkConfiguration.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkConfiguration.md index 110a8e54cc..6c4f63315f 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkConfiguration.md @@ -1,10 +1,11 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworkconfiguration schema: 2.0.0 -ms.reviewer: +title: Get-CsTenantNetworkConfiguration --- # Get-CsTenantNetworkConfiguration @@ -121,7 +122,7 @@ 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) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkRegion.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkRegion.md index 4e5bac9aa2..103827da09 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion applicable: Microsoft Teams -title: Get-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworkregion +schema: 2.0.0 +title: Get-CsTenantNetworkRegion --- # Get-CsTenantNetworkRegion @@ -98,8 +99,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworkregion) -[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworkregion) -[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSite.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSite.md index 140fb2c326..9b5bba3ee3 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite applicable: Microsoft Teams -title: Get-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite +schema: 2.0.0 +title: Get-CsTenantNetworkSite --- # Get-CsTenantNetworkSite @@ -165,8 +166,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](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksite) -[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksite) -[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSubnet.md similarity index 92% rename from teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSubnet.md index 451655976b..ef886c2a52 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet applicable: Microsoft Teams -title: Get-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksubnet +schema: 2.0.0 +title: Get-CsTenantNetworkSubnet --- # Get-CsTenantNetworkSubnet @@ -54,31 +55,31 @@ The command shown in Example 2 returns the IPv6 format network subnet within the ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network subnets to be returned. +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to limit the number of results based on filters you specify. +### -Identity +The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network subnets to be returned. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -97,8 +98,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksubnet) -[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksubnet) -[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet) +[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksubnet) diff --git a/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantTrustedIPAddress.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantTrustedIPAddress.md index 178e4bd1fa..bec063bfec 100644 --- a/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantTrustedIPAddress.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenanttrustedipaddress +schema: 2.0.0 +title: Get-CsTenantTrustedIPAddress --- # Get-CsTenantTrustedIPAddress diff --git a/teams/teams-ps/teams/Get-CsUserCallingSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserCallingSettings.md similarity index 73% rename from teams/teams-ps/teams/Get-CsUserCallingSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserCallingSettings.md index 43b422011c..4ba4c9a51b 100644 --- a/teams/teams-ps/teams/Get-CsUserCallingSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserCallingSettings.md @@ -1,249 +1,363 @@ ---- -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 -title: Get-CsUserCallingSettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Get-CsUserCallingSettings - -## SYNOPSIS -This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. - -## SYNTAX - -```powershell -Get-CsUserCallingSettings -Identity [] - -``` - -## DESCRIPTION -This cmdlet shows the call forwarding, simultaneous ringing, call group and delegation settings for a user. It will also show any call groups the user is a member of and -if someone else has added the user as a delegate. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsUserCallingSettings -Identity user1@contoso.com -``` -```output -SipUri : sip:user1@contoso.com -IsForwardingEnabled : True -ForwardingType : Immediate -ForwardingTarget : -ForwardingTargetType : Voicemail -IsUnansweredEnabled : False -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : -``` - -This example shows that user1@contoso.com has immediate call forwarding set (IsForwardingEnabled and ForwardingType) to route all incoming calls to voicemail (ForwardingTargetType). - -### Example 2 -```powershell -Get-CsUserCallingSettings -Identity user2@contoso.com -``` -```output -SipUri : sip:user2@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : sip:user3@contoso.com -ForwardingTargetType : SingleTarget -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : -``` - -This example shows that user2@contoso.com has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to user3@contoso.com -(ForwardingTarget and ForwardingTargetType) and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed -to voicemail (UnansweredTargetType). - -### Example 3 -```powershell -Get-CsUserCallingSettings -Identity user4@contoso.com -``` -```output -SipUri : sip:user4@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : -ForwardingTargetType : Group -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {sip:user5@contoso.com} -GroupMembershipDetails : CallGroupOwnerId:sip:user6@contoso.com -GroupNotificationOverride : Mute -``` -```powershell -(Get-CsUserCallingSettings -Identity user4@contoso.com).GroupMembershipDetails -``` -```output -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 -(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 -``` -```output -SipUri : sip:opr7@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : -ForwardingTargetType : MyDelegates -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : Id:sip:user8@contoso.com -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : Ring -``` -```powershell -(Get-CsUserCallingSettings -Identity user7@contoso.com).Delegates -``` -```output -Id : sip:user8@contoso.com -MakeCalls : True -ManageSettings : True -ReceiveCalls : True -``` - -This example shows that user7@contoso.com has simultaneous ringing set to his/her delegates (ForwardingTargetType). User8@contoso.com is the only delegate -(Delegates) and that user has all the permissions you can have as a delegate (Delegates). - -### Example 5 -```powershell -Get-CsUserCallingSettings -Identity user9@contoso.com -``` -```output -SipUri : sip:user9@contoso.com -IsForwardingEnabled : False -ForwardingType : Immediate -ForwardingTarget : -ForwardingTargetType : Voicemail -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : Id:sip:user10@contoso.com -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : Ring -``` -```powershell -(Get-CsUserCallingSettings -Identity user9@contoso.com).Delegators -``` -```output -Id : sip:user10@contoso.com -MakeCalls : True -ManageSettings : True -ReceiveCalls : True -``` - -This example shows that user9@contoso.com is a delegate of user10@contoso.com (Delegators) and that user10@contoso.com has given user9@contoso.com all the -permissions you can have as a delegate (Delegators). - -### Example 6 -```powershell -Get-CsUserCallingSettings -Identity user11@contoso.com -``` -```output -SipUri : sip:user11@contoso.com -IsForwardingEnabled : -ForwardingType : -ForwardingTarget : -ForwardingTargetType : -IsUnansweredEnabled : -UnansweredTarget : -UnansweredTargetType : -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : Simultaneous -CallGroupTargets : {} -GroupMembershipDetails : -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, -unanswered calls will by default be forwarded to voicemail after 30 seconds. - -## PARAMETERS - -### -Identity -The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId or the SIP address. - -```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 -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -## RELATED LINKS - -[Set-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csusercallingsettings +schema: 2.0.0 +title: Get-CsUserCallingSettings +--- + +# Get-CsUserCallingSettings + +## SYNOPSIS +This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. + +## SYNTAX + +### Get (Default) +``` +Get-CsUserCallingSettings -Identity [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity +``` +Get-CsUserCallingSettings -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION +This cmdlet shows the call forwarding, simultaneous ringing, call group and delegation settings for a user. It will also show any call groups the user is a member of and +if someone else has added the user as a delegate. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsUserCallingSettings -Identity user1@contoso.com +``` +```output +SipUri : sip:user1@contoso.com +IsForwardingEnabled : True +ForwardingType : Immediate +ForwardingTarget : +ForwardingTargetType : Voicemail +IsUnansweredEnabled : False +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : +``` + +This example shows that user1@contoso.com has immediate call forwarding set (IsForwardingEnabled and ForwardingType) to route all incoming calls to voicemail (ForwardingTargetType). + +### Example 2 +```powershell +Get-CsUserCallingSettings -Identity user2@contoso.com +``` +```output +SipUri : sip:user2@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : sip:user3@contoso.com +ForwardingTargetType : SingleTarget +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : +``` + +This example shows that user2@contoso.com has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to user3@contoso.com +(ForwardingTarget and ForwardingTargetType) and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed +to voicemail (UnansweredTargetType). + +### Example 3 +```powershell +Get-CsUserCallingSettings -Identity user4@contoso.com +``` +```output +SipUri : sip:user4@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : +ForwardingTargetType : Group +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {sip:user5@contoso.com} +GroupMembershipDetails : CallGroupOwnerId:sip:user6@contoso.com +GroupNotificationOverride : Mute +``` +```powershell +(Get-CsUserCallingSettings -Identity user4@contoso.com).GroupMembershipDetails +``` +```output +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 +(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 +``` +```output +SipUri : sip:opr7@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : +ForwardingTargetType : MyDelegates +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : Id:sip:user8@contoso.com +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : Ring +``` +```powershell +(Get-CsUserCallingSettings -Identity user7@contoso.com).Delegates +``` +```output +Id : sip:user8@contoso.com +MakeCalls : True +ManageSettings : True +ReceiveCalls : True +``` + +This example shows that user7@contoso.com has simultaneous ringing set to his/her delegates (ForwardingTargetType). User8@contoso.com is the only delegate +(Delegates) and that user has all the permissions you can have as a delegate (Delegates). + +### Example 5 +```powershell +Get-CsUserCallingSettings -Identity user9@contoso.com +``` +```output +SipUri : sip:user9@contoso.com +IsForwardingEnabled : False +ForwardingType : Immediate +ForwardingTarget : +ForwardingTargetType : Voicemail +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : Id:sip:user10@contoso.com +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : Ring +``` +```powershell +(Get-CsUserCallingSettings -Identity user9@contoso.com).Delegators +``` +```output +Id : sip:user10@contoso.com +MakeCalls : True +ManageSettings : True +ReceiveCalls : True +``` + +This example shows that user9@contoso.com is a delegate of user10@contoso.com (Delegators) and that user10@contoso.com has given user9@contoso.com all the +permissions you can have as a delegate (Delegators). + +### Example 6 +```powershell +Get-CsUserCallingSettings -Identity user11@contoso.com +``` +```output +SipUri : sip:user11@contoso.com +IsForwardingEnabled : +ForwardingType : +ForwardingTarget : +ForwardingTargetType : +IsUnansweredEnabled : +UnansweredTarget : +UnansweredTargetType : +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : Simultaneous +CallGroupTargets : {} +GroupMembershipDetails : +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, +unanswered calls will by default be forwarded to voicemail after 30 seconds. + +## PARAMETERS + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +{{ Fill InputObject Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +## RELATED LINKS + +[Set-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csusercallingdelegate) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyAssignment.md similarity index 96% rename from teams/teams-ps/teams/Get-CsUserPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyAssignment.md index 692be05e33..6075516892 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyAssignment.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicyassignment +schema: 2.0.0 +title: Get-CsUserPolicyAssignment --- # Get-CsUserPolicyAssignment @@ -88,44 +89,41 @@ d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/20 ## PARAMETERS -### -Identity -The identify of the user whose policy assignments will be returned. - -The -Identity parameter can be in the form of the users ObjectID (taken from Microsoft Entra ID) or in the form of the UPN (a.smith@example.com) +### -Break +Wait for .NET debugger to attach ```yaml -Type: String -Parameter Sets: Get +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline ```yaml -Type: IIc3AdminConfigRpPolicyIdentity -Parameter Sets: GetViaIdentity +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -Use to filter to a specific policy type. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline ```yaml -Type: String +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -136,41 +134,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach +### -Identity +The identify of the user whose policy assignments will be returned. + +The -Identity parameter can be in the form of the users ObjectID (taken from Microsoft Entra ID) or in the form of the UPN (a.smith@example.com) ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: Get Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: IIc3AdminConfigRpPolicyIdentity +Parameter Sets: GetViaIdentity Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -PolicyType +Use to filter to a specific policy type. ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: @@ -249,8 +250,8 @@ INPUTOBJECT \: Identity Parameter ## RELATED LINKS -[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment) -[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csgrouppolicyassignment) -[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackage.md similarity index 84% rename from teams/teams-ps/teams/Get-CsUserPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackage.md index c0edaf3689..0f254b84b7 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Get-CsUserPolicyPackage -author: serdarsoysal ms.author: serdars -manager: amitar -online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackage schema: 2.0.0 +title: Get-CsUserPolicyPackage --- # Get-CsUserPolicyPackage @@ -39,13 +40,14 @@ Returns the policy package that's assigned to johndoe@example.com. ### -Identity +> Applicable: Microsoft Teams + The user that will get their assigned policy package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -64,8 +66,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation) -[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csuserpolicypackage) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackageRecommendation.md similarity index 87% rename from teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackageRecommendation.md index ca19b2c0d9..88286a45c7 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackageRecommendation.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Get-CsUserPolicyPackageRecommendation -author: serdarsoysal ms.author: serdars -manager: amitar -online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation schema: 2.0.0 +title: Get-CsUserPolicyPackageRecommendation --- # Get-CsUserPolicyPackageRecommendation @@ -39,13 +40,14 @@ Returns recommendations for which policy packages are best suited for johndoe@ex ### -Identity +> Applicable: Microsoft Teams + The user that will receive policy package recommendations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -64,8 +66,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackage) -[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csuserpolicypackage) diff --git a/teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/Get-CsVideoInteropServiceProvider.md similarity index 88% rename from teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/Get-CsVideoInteropServiceProvider.md index 2210e9d40f..71d30859f2 100644 --- a/teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsVideoInteropServiceProvider.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csvideointeropserviceprovider +schema: 2.0.0 +title: Get-CsVideoInteropServiceProvider --- # Get-CsVideoInteropServiceProvider ## 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. +Get information about the Cloud Video Interop for Teams. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-M365TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Get-M365TeamsApp.md similarity index 94% rename from teams/teams-ps/teams/Get-M365TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Get-M365TeamsApp.md index 2d665c2c79..467ef10577 100644 --- a/teams/teams-ps/teams/Get-M365TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Get-M365TeamsApp.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Get-M365TeamsApp schema: 2.0.0 +title: Get-M365TeamsApp --- # Get-M365TeamsApp @@ -124,5 +125,5 @@ Properties: ## RELATED LINKS -[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) -[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) +[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/microsoftteams/get-allm365teamsapps) +[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/microsoftteams/get-allm365teamsapps) diff --git a/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedCustomPendingApps.md similarity index 56% rename from teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md rename to teams/teams-ps/MicrosoftTeams/Get-M365UnifiedCustomPendingApps.md index ef3041d61f..6c3a05f368 100644 --- a/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md +++ b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedCustomPendingApps.md @@ -1,17 +1,18 @@ --- -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 +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: swmerchant +Module Name: MicrosoftTeams +ms.author: mparadis ms.date: 01/14/2025 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Get-M365UnifiedCustomPendingApps schema: 2.0.0 +title: Get-M365UnifiedCustomPendingApps --- -# Get-M365UnifiedCustomPendingApps +# Get-M365UnifiedCustomPendingApps ## SYNOPSIS @@ -19,7 +20,7 @@ This cmdlet returns all custom Microsoft Teams apps that are pending review from ## SYNTAX -```powershell +``` Get-M365UnifiedCustomPendingApps [] ``` @@ -29,7 +30,7 @@ Get-M365UnifiedCustomPendingApps retrieves a complete list of all custom Microso ## EXAMPLES -### Example +### Example 1 ```powershell PS C:\> Get-M365UnifiedCustomPendingApps @@ -51,27 +52,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### 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. - -**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: +- **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 every time + 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. -- PendingPublishing -- PendingUpdate +## NOTES -**Metadata**: -The metadata of the app. \ No newline at end of file +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedTenantSettings.md similarity index 94% rename from teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-M365UnifiedTenantSettings.md index c67594e6ff..642654e597 100644 --- a/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedTenantSettings.md @@ -1,14 +1,15 @@ --- -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 +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 10/22/2024 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Get-M365UnifiedTenantSettings schema: 2.0.0 +title: Get-M365UnifiedTenantSettings --- # Get-M365UnifiedTenantSettings diff --git a/teams/teams-ps/teams/Get-SharedWithTeam.md b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeam.md similarity index 89% rename from teams/teams-ps/teams/Get-SharedWithTeam.md rename to teams/teams-ps/MicrosoftTeams/Get-SharedWithTeam.md index 4728ffa1b4..b7ba2002f4 100644 --- a/teams/teams-ps/teams/Get-SharedWithTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeam.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteam -title: Get-SharedWithTeam -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-sharedwithteam +schema: 2.0.0 +title: Get-SharedWithTeam --- # Get-SharedWithTeam @@ -41,8 +42,8 @@ Returns detail of a team with which a specified channel is shared. ## PARAMETERS -### -HostTeamId -Team ID of the host team (Group ID). +### -ChannelId +Thread ID of the shared channel. ```yaml Type: String @@ -56,8 +57,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ChannelId -Thread ID of the shared channel. +### -HostTeamId +Team ID of the host team (Group ID). ```yaml Type: String @@ -91,7 +92,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### HostTeamId, ChannelId, SharedWithTeamId +### HostTeamId + +### ChannelId + +### SharedWithTeamId ## OUTPUTS @@ -100,5 +105,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) -[Get-AssociatedTeam](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-Team](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) +[Get-AssociatedTeam](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) diff --git a/teams/teams-ps/teams/Get-SharedWithTeamUser.md b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeamUser.md similarity index 90% rename from teams/teams-ps/teams/Get-SharedWithTeamUser.md rename to teams/teams-ps/MicrosoftTeams/Get-SharedWithTeamUser.md index 4a3f016867..28b2d8a72b 100644 --- a/teams/teams-ps/teams/Get-SharedWithTeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeamUser.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteamuser -title: Get-SharedWithTeamUser -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-sharedwithteamuser +schema: 2.0.0 +title: Get-SharedWithTeamUser --- # Get-SharedWithTeamUser @@ -42,8 +43,8 @@ Returns owners of a team with which a specified channel is shared. ## PARAMETERS -### -HostTeamId -Team ID of the host team (Group ID). +### -ChannelId +Thread ID of the shared channel. ```yaml Type: String @@ -57,8 +58,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ChannelId -Thread ID of the shared channel. +### -HostTeamId +Team ID of the host team (Group ID). ```yaml Type: String @@ -72,33 +73,33 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -SharedWithTeamId -Team ID of the shared with team. +### -Role +Filters the results to only users with the given role of "Owner" or "Member". ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True Accept wildcard characters: False ``` -### -Role -Filters the results to only users with the given role of "Owner" or "Member". +### -SharedWithTeamId +Team ID of the shared with team. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -107,7 +108,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### HostTeamId, ChannelId, SharedWithTeamId +### HostTeamId + +### ChannelId + +### SharedWithTeamId ## OUTPUTS @@ -116,4 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-TeamUser](https://learn.microsoft.com/powershell/module/teams/get-teamuser) +[Get-TeamUser](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamuser) diff --git a/teams/teams-ps/teams/Get-Team.md b/teams/teams-ps/MicrosoftTeams/Get-Team.md similarity index 76% rename from teams/teams-ps/teams/Get-Team.md rename to teams/teams-ps/MicrosoftTeams/Get-Team.md index b2edb13e51..758df29b8a 100644 --- a/teams/teams-ps/teams/Get-Team.md +++ b/teams/teams-ps/MicrosoftTeams/Get-Team.md @@ -1,19 +1,18 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-team +schema: 2.0.0 +title: Get-Team --- # Get-Team ## SYNOPSIS - -This cmdlet supports retrieving teams with particular properties/information, including all teams that a specific user belongs to, all teams that have been archived, all teams with a specific display name, or all teams in the organization. +Get Team information based on particular properties. ## SYNTAX @@ -71,52 +70,12 @@ Returns the team that includes the specified escaped representation of its Displ ## PARAMETERS -### -User -User's UPN (user principal name - e.g. -johndoe@example.com) - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Filters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Archived If $true, filters to return teams that have been archived. If $false, filters to return teams that have not been archived. Do not specify any value to return teams that match filter regardless of archived state. This is a filter rather than an exact match. ```yaml Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Boolean -Parameter Sets: Filters +Parameter Sets: Identity, Filters Aliases: Required: False @@ -131,19 +90,7 @@ Specify this parameter to return teams with the provided display name as a filte ```yaml Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Filters +Parameter Sets: Identity, Filters Aliases: Required: False @@ -173,7 +120,7 @@ Specify the mailnickname of the team that is being returned. This acts as a filt ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Identity, Filters Aliases: Required: False @@ -183,24 +130,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NumberOfThreads +Specifies the number of threads to use. If you have sufficient network bandwidth and want to decrease the time required to retrieve the list of teams, use the -NumberOfThreads parameter, which supports a value from 1 through 20. + ```yaml -Type: String -Parameter Sets: Filters +Type: Int32 +Parameter Sets: All Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: False +Default value: 20 +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Visibility -Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. +### -User +User's UPN (user principal name - e.g. +johndoe@example.com) ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Identity, Filters Aliases: Required: False @@ -210,9 +161,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Visibility +Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. + ```yaml Type: String -Parameter Sets: Filters +Parameter Sets: Identity, Filters Aliases: Required: False @@ -222,27 +176,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberOfThreads -Specifies the number of threads to use. If you have sufficient network bandwidth and want to decrease the time required to retrieve the list of teams, use the -NumberOfThreads parameter, which supports a value from 1 through 20. - -```yaml -Type: Int32 -Parameter Sets: All -Aliases: - -Required: False -Position: Named -Default value: 20 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### UPN, UserID +### UPN + +### UserID ## OUTPUTS @@ -252,6 +193,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) +[New-Team](https://learn.microsoft.com/powershell/module/microsoftteams/new-team) -[Set-Team](https://learn.microsoft.com/powershell/module/teams/set-team) +[Set-Team](https://learn.microsoft.com/powershell/module/microsoftteams/set-team) diff --git a/teams/teams-ps/teams/Get-TeamAllChannel.md b/teams/teams-ps/MicrosoftTeams/Get-TeamAllChannel.md similarity index 90% rename from teams/teams-ps/teams/Get-TeamAllChannel.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamAllChannel.md index eae8aeb08e..3eaea1638c 100644 --- a/teams/teams-ps/teams/Get-TeamAllChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamAllChannel.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamallchannel -title: Get-TeamAllChannel -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamallchannel +schema: 2.0.0 +title: Get-TeamAllChannel --- # Get-TeamAllChannel @@ -75,7 +76,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, MembershipType +### GroupId + +### MembershipType ## OUTPUTS @@ -84,5 +87,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-TeamChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) -[Get-TeamIncomingChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) +[Get-TeamChannel](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchannel) +[Get-TeamIncomingChannel](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchannel) diff --git a/teams/teams-ps/teams/Get-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/Get-TeamChannel.md similarity index 93% rename from teams/teams-ps/teams/Get-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamChannel.md index 9eae890d9e..3003a7fb20 100644 --- a/teams/teams-ps/teams/Get-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamChannel.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamchannel -title: Get-TeamChannel +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchannel schema: 2.0.0 +title: Get-TeamChannel --- # Get-TeamChannel diff --git a/teams/teams-ps/teams/Get-TeamChannelUser.md b/teams/teams-ps/MicrosoftTeams/Get-TeamChannelUser.md similarity index 94% rename from teams/teams-ps/teams/Get-TeamChannelUser.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamChannelUser.md index a245c41c40..5c989c4f7d 100644 --- a/teams/teams-ps/teams/Get-TeamChannelUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamChannelUser.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamchanneluser -title: Get-TeamChannelUser +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchanneluser schema: 2.0.0 +title: Get-TeamChannelUser --- # Get-TeamChannelUser @@ -32,8 +33,8 @@ Get owners of channel with display name as "Engineering" ## PARAMETERS -### -GroupId -GroupId of the team +### -DisplayName +Display name of the channel ```yaml Type: String @@ -47,8 +48,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Display name of the channel +### -GroupId +GroupId of the team ```yaml Type: String diff --git a/teams/teams-ps/teams/Get-TeamIncomingChannel.md b/teams/teams-ps/MicrosoftTeams/Get-TeamIncomingChannel.md similarity index 88% rename from teams/teams-ps/teams/Get-TeamIncomingChannel.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamIncomingChannel.md index b1ad0429ef..964e62dc30 100644 --- a/teams/teams-ps/teams/Get-TeamIncomingChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamIncomingChannel.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamincomingchannel -title: Get-TeamIncomingChannel -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamincomingchannel +schema: 2.0.0 +title: Get-TeamIncomingChannel --- # Get-TeamIncomingChannel @@ -62,5 +63,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-TeamChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) -[Get-TeamAllChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) +[Get-TeamChannel](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchannel) +[Get-TeamAllChannel](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchannel) diff --git a/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md b/teams/teams-ps/MicrosoftTeams/Get-TeamTargetingHierarchyStatus.md similarity index 88% rename from teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamTargetingHierarchyStatus.md index 2480953c1b..92f62d0cf8 100644 --- a/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamTargetingHierarchyStatus.md @@ -1,18 +1,18 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamtargetinghierarchystatus +schema: 2.0.0 +title: Get-TeamTargetingHierarchyStatus --- # Get-TeamTargetingHierarchyStatus ## SYNOPSIS -Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy)) +Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/microsoftteams/set-teamtargetinghierarchy)) ## SYNTAX @@ -20,6 +20,8 @@ Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://l ``` Get-TeamTargetingHierarchyStatus [-RequestId ] [-ApiVersion ] [] ``` +## DESCRIPTION +The `Get-TeamTargetingHierarchyStatus` cmdlet retrieves the status of a hierarchy upload initiated by the `Set-TeamTargetingHierarchy` cmdlet. It provides information about the success or failure of the upload, including any errors encountered during the process. ## EXAMPLES @@ -67,35 +69,35 @@ Prompts for user credentials to connect and manage a Microsoft Teams environment ## PARAMETERS -### -RequestId -Specifies the ID returned by the Set-TeamTargetingHierarchy cmdlet. This parameter is optional and the status of the most recent upload will be retrieved. +### -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: True +Required: False Position: Named -Default value: None -Accept pipeline input: False +Default value: 1 +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. +### -RequestId +Specifies the ID returned by the Set-TeamTargetingHierarchy cmdlet. This parameter is optional and the status of the most recent upload will be retrieved. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 1 -Accept pipeline input: false +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` @@ -110,4 +112,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy) +[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/microsoftteams/set-teamtargetinghierarchy) diff --git a/teams/teams-ps/teams/Get-TeamUser.md b/teams/teams-ps/MicrosoftTeams/Get-TeamUser.md similarity index 93% rename from teams/teams-ps/teams/Get-TeamUser.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamUser.md index a7b4fd3d69..2f305472f3 100644 --- a/teams/teams-ps/teams/Get-TeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamUser.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamuser +schema: 2.0.0 +title: Get-TeamUser --- # Get-TeamUser diff --git a/teams/teams-ps/teams/Get-TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Get-TeamsApp.md similarity index 95% rename from teams/teams-ps/teams/Get-TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamsApp.md index e393faf0f5..d53c6a6ca1 100644 --- a/teams/teams-ps/teams/Get-TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamsApp.md @@ -1,13 +1,14 @@ --- +author: joeyglocke external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: islubin Module Name: MicrosoftTeams -title: Get-TeamsApp -author: joeyglocke ms.author: joglocke ms.reviewer: ken.withee -manager: islubin -online version: https://learn.microsoft.com/powershell/module/teams/get-teamsapp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamsapp schema: 2.0.0 +title: Get-TeamsApp --- # Get-TeamsApp diff --git a/teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsApplicationAccessPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsApplicationAccessPolicy.md index b321e2118c..cc4a149a58 100644 --- a/teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy applicable: Microsoft Teams -title: Grant-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni author: frankpeng7 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy +schema: 2.0.0 +title: Grant-CsApplicationAccessPolicy --- # Grant-CsApplicationAccessPolicy @@ -76,30 +77,13 @@ The command shown above assigns the per-user application access policy "ASimpleP ## PARAMETERS -### -Identity - -Indicates the user (object) ID of the user account to be assigned the per-user application access policy. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (the "tag:" prefix). For example, a policy with the Identity tag:ASimplePolicy has a PolicyName equal to ASimplePolicy. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -139,12 +123,29 @@ 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. +### -Identity + +Indicates the user (object) ID of the user account to be assigned the per-user application access policy. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +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 @@ -154,13 +155,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -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: cf +Aliases: Required: False Position: Named @@ -169,12 +171,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsftInternalProcessingMode +### -PolicyName -For internal use only. +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:ASimplePolicy has a PolicyName equal to ASimplePolicy. ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -185,13 +187,12 @@ 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. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -228,7 +229,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[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) +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Grant-CsCallingLineIdentity.md similarity index 89% rename from teams/teams-ps/teams/Grant-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsCallingLineIdentity.md index bac8b79e4c..4bb23ba840 100644 --- a/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity applicable: Microsoft Teams -title: Grant-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-cscallinglineidentity +schema: 2.0.0 +title: Grant-CsCallingLineIdentity --- # Grant-CsCallingLineIdentity @@ -60,14 +61,16 @@ This example assigns the Caller ID policy with the Identity CallerIDSeattle to t ## PARAMETERS -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter -Parameter Sets: (GrantToTenant) -Aliases: -applicable: Microsoft Teams +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -76,14 +79,16 @@ 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-CsCallingLineIdentity cmdlet does not pass objects through the pipeline. +### -Global + +> Applicable: Microsoft Teams + +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: (GrantToTenant) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -92,46 +97,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name (Identity) of the Caller ID policy to be assigned. To remove an existing user level policy assignment, specify PolicyName as $null. +### -Group + +> Applicable: Microsoft Teams + +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: -applicable: Microsoft Teams -Required: False -Position: 1 +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. +### -Identity + +> Applicable: Microsoft Teams + +The Identity of the user to whom the policy is being assigned. User Identities can be specified using the user's SIP address, the user's user principal name (UPN), or +the user's ObjectId/Identity. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (Identity) Aliases: -applicable: Microsoft Teams -Required: True +Required: False 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. +### -PassThru + +> Applicable: Microsoft Teams + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsCallingLineIdentity cmdlet does not pass objects through the pipeline. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -139,31 +151,35 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity of the user to whom the policy is being assigned. User Identities can be specified using the user's SIP address, the user's user principal name (UPN), or -the user's ObjectId/Identity. + +### -PolicyName + +> Applicable: Microsoft Teams + +The name (Identity) of the Caller ID policy to be assigned. To remove an existing user level policy assignment, specify PolicyName as $null. ```yaml Type: String -Parameter Sets: (Identity) +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 0 +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. +### -Rank + +> Applicable: Microsoft Teams + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: Required: False Position: Named @@ -171,15 +187,16 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -WhatIf -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +> Applicable: Microsoft Teams + +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: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -200,10 +217,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-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallinglineidentity) -[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallinglineidentity) -[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallinglineidentity) -[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Grant-CsDialoutPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsDialoutPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsDialoutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsDialoutPolicy.md index 73c1d5c787..7beb049a2e 100644 --- a/teams/teams-ps/teams/Grant-CsDialoutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsDialoutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csdialoutpolicy applicable: Microsoft Teams -title: Grant-CsDialoutPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csdialoutpolicy +schema: 2.0.0 +title: Grant-CsDialoutPolicy --- # Grant-CsDialoutPolicy @@ -76,14 +77,34 @@ This example assigns the policy instance "DialoutCPCandPSTNInternational" to the ## PARAMETERS +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the 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 + +> Applicable: Microsoft Teams + This parameter sets the tenant global policy instance. This is the policy that all users in the tenant will get unless they have a specific policy instance assigned. ```yaml Type: SwitchParameter Parameter Sets: GrantToTenant Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -93,13 +114,15 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: Microsoft Teams + Specifies the group used for the group policy assignment. ```yaml Type: String Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams Required: True Position: 0 @@ -109,13 +132,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of three formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's ObjectId/Identity. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 0 @@ -125,13 +150,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams + Returns the results of the command. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -141,6 +168,9 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Microsoft Teams + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DialoutCPCZoneAPSTNDomestic has a PolicyName equal to DialoutCPCZoneAPSTNDomestic. To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). @@ -149,7 +179,6 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -159,13 +188,15 @@ Accept wildcard characters: False ``` ### -Rank + +> Applicable: Microsoft Teams + The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml Type: Int32 Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -175,6 +206,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -182,23 +216,6 @@ The cmdlet is not run. 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 running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -223,4 +240,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](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialoutpolicy) +[Get-CsOnlineDialOutPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialoutpolicy) diff --git a/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsExternalAccessPolicy.md similarity index 86% rename from teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsExternalAccessPolicy.md index ffce2c43e2..6456e03865 100644 --- a/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsExternalAccessPolicy.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy +schema: 2.0.0 +title: Grant-CsExternalAccessPolicy --- # Grant-CsExternalAccessPolicy @@ -15,9 +17,6 @@ ms.reviewer: rogupta ## 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 @@ -42,6 +41,7 @@ Grant-CsExternalAccessPolicy [[-PolicyName] ] [-Global] [-Force] [ Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: UserIdParameter -Parameter Sets: GrantToUser +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: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondAccessPolicy has a PolicyName equal to RedmondAccessPolicy. +### -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". -To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. +```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: (All) +Parameter Sets: GrantToGroup 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 +Required: True +Position: 0 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. +### -Identity + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: Fqdn -Parameter Sets: (All) +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: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -196,7 +213,6 @@ By default, the Grant-CsExternalAccessPolicy cmdlet does not pass objects throug 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 @@ -205,17 +221,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -PolicyName + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +"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: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -236,31 +258,19 @@ 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: +### -Tenant -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -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". +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: Guid +Parameter Sets: (All) Aliases: -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -288,10 +298,10 @@ However, if you include the PassThru parameter, the cmdlet will return instances ## RELATED LINKS -[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexternalaccesspolicy) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md b/teams/teams-ps/MicrosoftTeams/Grant-CsGroupPolicyPackageAssignment.md similarity index 92% rename from teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsGroupPolicyPackageAssignment.md index a3f18f52c8..9d1e3f71f5 100644 --- a/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsGroupPolicyPackageAssignment.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: Grant-CsGroupPolicyPackageAssignment -author: serdarsoysal ms.author: serdars -manager: dasosby -online version: https://learn.microsoft.com/powershell/module/teams/grant-csgrouppolicypackageassignment +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csgrouppolicypackageassignment schema: 2.0.0 +title: Grant-CsGroupPolicyPackageAssignment --- # Grant-CsGroupPolicyPackageAssignment @@ -30,7 +31,7 @@ Policy rankings can be optionally specified for each policy type in the package - If the policy type was previously assigned to the group, the ranking for the policy type will not change. - If the policy type was not previously assigned to the group, the ranking for the policy type will be ranked last. -Finally, if a user was directly assigned a package, direct assignment takes precedence over group assignment. For more information on policy rankings and group policy assignments, please review [the description section under New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment#description). +Finally, if a user was directly assigned a package, direct assignment takes precedence over group assignment. For more information on policy rankings and group policy assignments, please review [the description section under New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment#description). ## EXAMPLES @@ -50,15 +51,31 @@ Assigns the Education_Teacher policy package to the group. The group will receiv ## 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 +``` + ### -GroupId +> Applicable: Microsoft Teams + A group id in the tenant. It can either be a group's object id or a group's email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -68,13 +85,14 @@ Accept wildcard characters: False ### -PackageName +> Applicable: Microsoft Teams + The name of a policy package. All policy package names can be found by running Get-CsPolicyPackage. To reset the currently assigned package value for the group, use $null or an empty string "". This will not remove any existing policy assignments to the group. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -84,13 +102,14 @@ Accept wildcard characters: False ### -PolicyRankings +> Applicable: Microsoft Teams + The policy rankings for each of the policy types in the package. To specify the policy rankings, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). Policy rank must be a number greater than or equal to 1. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 2 Default value: None @@ -114,21 +133,6 @@ Accept 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). @@ -140,6 +144,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineAudioConferencingRoutingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsOnlineAudioConferencingRoutingPolicy.md index d9f1d28be6..7bd387bd41 100644 --- a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,247 +1,248 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Grant-CsOnlineAudioConferencingRoutingPolicy +--- + +# 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/teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy.md index 4f5598bbb8..00ffcbc34c 100644 --- a/teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Grant-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Grant-CsOnlineVoiceRoutingPolicy --- # Grant-CsOnlineVoiceRoutingPolicy @@ -76,59 +77,57 @@ Example 5 assigns the online voice routing policy RedmondOnlineVoiceRoutingPolic ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user online voice routing policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. ```yaml -Type: String -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +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 online voice routing policy. By default, the `Grant-CsOnlineVoiceRoutingPolicy` cmdlet does not pass objects through the pipeline. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: GrantToGroup Aliases: -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondOnlineVoiceRoutingPolicy has a PolicyName equal to RedmondOnlineVoiceRoutingPolicy. - -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +### -Identity +Indicates the Identity of the user account to be assigned the per-user online voice routing policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity Aliases: -Required: True -Position: 1 +Required: False +Position: 0 Default value: None -Accept pipeline input: False +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, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the online voice routing policy. By default, the `Grant-CsOnlineVoiceRoutingPolicy` cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant +Parameter Sets: (All) Aliases: Required: False @@ -138,16 +137,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondOnlineVoiceRoutingPolicy has a PolicyName equal to RedmondOnlineVoiceRoutingPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: Required: True -Position: 0 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -182,10 +183,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](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy) -[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy.md similarity index 88% rename from teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy.md index fada417049..b19c9fe7ea 100644 --- a/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy +schema: 2.0.0 +title: Grant-CsOnlineVoicemailPolicy --- # Grant-CsOnlineVoicemailPolicy @@ -52,30 +53,16 @@ The command shown in Example 2 assigns the online voicemail policy Transcription ## PARAMETERS -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsOnlineVoicemailPolicy cmdlet does not pass objects through the pipeline. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -84,30 +71,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -A unique identifier(name) of the policy. +### -Global + +> Applicable: Microsoft Teams + +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Group + +> Applicable: Microsoft Teams + Specifies the group used for the group policy assignment. ```yaml Type: String Parameter Sets: GrantToGroup Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -116,14 +107,16 @@ 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. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP address or an Object ID. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: System.String +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -132,14 +125,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP address or an Object ID. +### -PassThru + +> Applicable: Microsoft Teams + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsOnlineVoicemailPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -148,14 +143,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PolicyName + +> Applicable: Microsoft Teams + +A unique identifier(name) of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +> Applicable: Microsoft Teams + +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 @@ -164,14 +179,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -192,10 +209,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 -[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAIPolicy.md similarity index 85% rename from teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAIPolicy.md index e4da7ca635..b1d3b5cd1d 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: andywang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Grant-CsTeamsAIPolicy +schema: 2.0.0 +title: Grant-CsTeamsAIPolicy --- # Grant-CsTeamsAIPolicy @@ -39,7 +40,7 @@ Grant-CsTeamsAIPolicy [[-PolicyName] ] [-Global] [-Force] [ and about app centric management at . - -This is only applicable for tenants who have not been migrated to ACM or UAM. +As an admin, you can use app permission policies to allow or block apps for your users. ## SYNTAX @@ -47,6 +45,8 @@ Grant-CsTeamsAppPermissionPolicy [[-PolicyName] ] [-Global] [-Force] [. +This is only applicable for tenants who have not been migrated to ACM or UAM. + ## EXAMPLES ### Example 1 @@ -102,6 +102,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The user to whom the policy should be assigned. @@ -146,6 +161,22 @@ 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 +``` + ### -Tenant Do not use. @@ -177,37 +208,6 @@ 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). diff --git a/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy.md similarity index 83% rename from teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy.md index 3568887beb..c6a457f961 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy.md @@ -1,24 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsappsetuppolicy +schema: 2.0.0 +title: Grant-CsTeamsAppSetupPolicy --- # Grant-CsTeamsAppSetupPolicy ## 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 setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. ## SYNTAX @@ -105,6 +102,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The user to whom the policy should be assigned. @@ -149,6 +161,21 @@ 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 +``` + ### -Tenant Do not use. @@ -180,36 +207,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy.md index 10b0d7085d..809765f7b5 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy -title: Grant-CsTeamsAudioConferencingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy schema: 2.0.0 +title: Grant-CsTeamsAudioConferencingPolicy --- # Grant-CsTeamsAudioConferencingPolicy @@ -47,6 +48,21 @@ In this example, a user with identity "Ken Myer" is being assigned the "Emea Use ## 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, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. @@ -62,6 +78,21 @@ 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 +``` + ### -Identity Indicates the Identity of the user account to be assigned the per-user online voice routing 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); or, 3) the user's Active Directory display name (for example, Ken Myer). @@ -123,36 +154,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```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. @@ -184,8 +185,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy) -[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy) -[Remove-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy) +[Remove-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy.md index 6d1b8028b7..2504b577f7 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -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: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallholdpolicy +schema: 2.0.0 +title: Grant-CsTeamsCallHoldPolicy --- # Grant-CsTeamsCallHoldPolicy @@ -79,6 +80,51 @@ The command shown in Example 5 sets the Teams call hold policy, ContosoPartnerTe ## 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 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: @@ -135,36 +181,6 @@ 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. @@ -196,21 +212,6 @@ Accept 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). @@ -226,10 +227,10 @@ The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or ## RELATED LINKS -[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy) -[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallholdpolicy) -[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallholdpolicy) -[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallholdpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallParkPolicy.md similarity index 78% rename from teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallParkPolicy.md index 65c8d7ab00..16a23ff60b 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallParkPolicy.md @@ -1,22 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallparkpolicy applicable: Microsoft Teams -title: Grant-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallparkpolicy +schema: 2.0.0 +title: Grant-CsTeamsCallParkPolicy --- # Grant-CsTeamsCallParkPolicy ## SYNOPSIS - -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 System license +The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. ## SYNTAX @@ -36,7 +34,14 @@ 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. +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. + +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 ## EXAMPLES @@ -56,27 +61,27 @@ Assigns a custom policy "Sales Policy" to the members of the group sales@contoso ## PARAMETERS -### -Identity -The User ID of the user to whom the policy is being assigned. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. By default, the cmdlet does not pass objects through the pipeline. +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: Required: False @@ -86,29 +91,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope ("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. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. +### -Identity +The User ID of the user to whom the policy is being assigned. + +```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 +If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. By default, the cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant +Parameter Sets: (All) Aliases: Required: False @@ -118,16 +136,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -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. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: Required: True -Position: 0 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -164,21 +184,6 @@ Accept 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). @@ -193,10 +198,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](https://learn.microsoft.com/powershell/module/teams/set-csteamscallparkpolicy) +[Set-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallparkpolicy) -[Get-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallparkpolicy) +[Get-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallparkpolicy) -[New-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallparkpolicy) +[New-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallparkpolicy) -[Remove-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallparkpolicy) +[Remove-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallparkpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallingPolicy.md index c843a89e58..b44a0ab4c6 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallingpolicy +schema: 2.0.0 +title: Grant-CsTeamsCallingPolicy --- # Grant-CsTeamsCallingPolicy @@ -63,57 +63,57 @@ Assigns the TeamsCallingPolicy called "SalesCallingPolicy" to the members of the ## PARAMETERS -### -Identity -The user object to whom the policy is being assigned. +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml -Type: String -Parameter Sets: (Identity) +Type: SwitchParameter +Parameter Sets: (GrantToTenant) Aliases: Required: False -Position: 0 +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-CsTeamsCallingPolicy cmdlet does not pass objects through the pipeline. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: (GrantToGroup) Aliases: -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the policy being assigned. To remove an existing user level policy assignment, specify PolicyName as $null. +### -Identity +The user object to whom the policy is being assigned. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (Identity) Aliases: Required: False -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsCallingPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter -Parameter Sets: (GrantToTenant) +Parameter Sets: (All) Aliases: Required: False @@ -123,16 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +The name of the policy being assigned. To remove an existing user level policy assignment, specify PolicyName as $null. ```yaml Type: String -Parameter Sets: (GrantToGroup) +Parameter Sets: (All) Aliases: -Required: True -Position: 0 +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -168,10 +168,10 @@ The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or ## RELATED LINKS -[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallingpolicy) -[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallingpolicy) -[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallingpolicy) -[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsChannelsPolicy.md similarity index 92% rename from teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsChannelsPolicy.md index abfbdfe908..208f05b30b 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsChannelsPolicy.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamschannelspolicy +schema: 2.0.0 +title: Grant-CsTeamsChannelsPolicy --- # Grant-CsTeamsChannelsPolicy ## SYNOPSIS - -The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. +The Grant-CsTeamsChannelsPolicy allows you to assign specific policies to users that have been created in your tenant. ## SYNTAX @@ -37,7 +38,7 @@ Grant-CsTeamsChannelsPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalP ``` ## DESCRIPTION -The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. The Grant-CsTeamsChannelsPolicy allows you to assign specific policies to users that have been created in your tenant. +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. ## EXAMPLES @@ -95,6 +96,21 @@ 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 +``` + ### -Identity Specify the user to whom the policy is being assigned. @@ -139,12 +155,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -154,28 +170,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Tenant +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: System.Guid 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: False @@ -185,15 +185,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy.md index caa013a167..bb1b8e110d 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: Grant-CsTeamsComplianceRecordingPolicy --- # Grant-CsTeamsComplianceRecordingPolicy @@ -73,23 +74,33 @@ 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: +### -Confirm +Prompts you for confirmation before running the cmdlet. -- 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: 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: UserIdParameter -Parameter Sets: Identity +Type: Fqdn +Parameter Sets: (All) Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -109,57 +120,48 @@ 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). +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: Required: True -Position: 1 +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 +### -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: -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. +- 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: System.Guid -Parameter Sets: (All) +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -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: Int32 -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: Required: False @@ -169,27 +171,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -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: GrantToGroup +Parameter Sets: (All) Aliases: Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -This parameter is reserved for internal Microsoft use. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -199,29 +205,24 @@ 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. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +You can return your tenant ID by running this command: -### -Confirm -Prompts you for confirmation before running the cmdlet. +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: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -261,20 +262,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCortanaPolicy.md similarity index 97% rename from teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCortanaPolicy.md index ef2205b07d..c963022870 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscortanapolicy +schema: 2.0.0 +title: Grant-CsTeamsCortanaPolicy --- # Grant-CsTeamsCortanaPolicy @@ -98,6 +99,21 @@ 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 +``` + ### -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. @@ -157,21 +173,6 @@ 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" diff --git a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy.md index c86a84aa89..35ba890327 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Grant-CsTeamsEmergencyCallRoutingPolicy --- # Grant-CsTeamsEmergencyCallRoutingPolicy @@ -56,6 +58,21 @@ This example assigns the Teams Emergency Call Routing policy (Test) to the membe ## 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 Sets the parameters of the Global policy instance to the values in the specified policy instance. @@ -162,21 +179,6 @@ Accept 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). @@ -190,10 +192,10 @@ The GrantToGroup syntax is supported in Teams PowerShell Module version 4.5.1-pr ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy) -[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy) -[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy.md index 6a5ce3b2a9..a16a1909e7 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc, pthota +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy schema: 2.0.0 +title: Grant-CsTeamsEmergencyCallingPolicy --- # Grant-CsTeamsEmergencyCallingPolicy @@ -53,6 +55,21 @@ Assigns the Teams Emergency Calling policy called "SalesTECP" to the Global poli ## 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 Sets the parameters of the Global policy instance to the values in the specified policy instance. @@ -159,21 +176,6 @@ Accept 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). @@ -189,10 +191,10 @@ The GrantToGroup syntax is supported in Teams PowerShell Module version 4.5.1-pr ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy) -[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy) -[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy) -[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEnhancedEncryptionPolicy.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEnhancedEncryptionPolicy.md index 58b0be1886..106ee672a2 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEnhancedEncryptionPolicy.md @@ -1,201 +1,202 @@ ---- -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: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Grant-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Cmdlet to assign a specific Teams enhanced encryption Policy to a user. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ][-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup -``` -Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] -Group [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Cmdlet to assign a specific Teams enhanced encryption Policy to a user. - -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 -```PowerShell -PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsEnhancedEncryptionPolicy' -``` - -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 -``` - -In Example 2, any per-user Teams enhanced encryption policy previously assigned to the user "Ken Myer" is revoked. - -As a result, the user will be managed by the global Teams enhanced encryption policy. - -## PARAMETERS - -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Global -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```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.Object -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Grant-CsTeamsEnhancedEncryptionPolicy +--- + +# Grant-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ][-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] -Group [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + +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 +```PowerShell +PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsEnhancedEncryptionPolicy' +``` + +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 +``` + +In Example 2, any per-user Teams enhanced encryption policy previously assigned to the user "Ken Myer" is revoked. + +As a result, the user will be managed by the global Teams enhanced encryption 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 +``` + +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +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 being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy) + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEventsPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEventsPolicy.md index ad83d722d4..04eb03be0c 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEventsPolicy.md @@ -1,207 +1,208 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamseventspolicy -title: Grant-CsTeamsEventsPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsEventsPolicy - -## SYNOPSIS -Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsEventsPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup -``` -Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] - [-Group] [-Rank ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Assigns Teams Events policy to a user, group of users, or the entire tenant. - -TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy DisablePublicWebinars -``` - -The command shown in Example 1 assigns the per-user Teams Events policy, DisablePublicWebinars, to the user with the user principal name (UPN) "user1@contoso.com". - -### Example 2 -```powershell -PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy $null -``` - -The command shown in Example 2 revokes the per-user Teams Events policy for the user with the user principal name (UPN) "user1@contoso.com". As a result, the user will be managed by the global Teams Events policy. - -### Example 3 -```powershell -PS C:\> Grant-CsTeamsEventsPolicy -Group "sales@contoso.com" -Rank 10 -Policy DisablePublicWebinars -``` - -The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "sales@contoso.com". - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the identity of the target user. Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -Use the "Global" Identity if you wish to set the policy for the entire tenant. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. - -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamseventspolicy +schema: 2.0.0 +title: Grant-CsTeamsEventsPolicy +--- + +# Grant-CsTeamsEventsPolicy + +## SYNOPSIS +Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsEventsPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] + [-Group] [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Assigns Teams Events policy to a user, group of users, or the entire tenant. + +TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy DisablePublicWebinars +``` + +The command shown in Example 1 assigns the per-user Teams Events policy, DisablePublicWebinars, to the user with the user principal name (UPN) "user1@contoso.com". + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy $null +``` + +The command shown in Example 2 revokes the per-user Teams Events policy for the user with the user principal name (UPN) "user1@contoso.com". As a result, the user will be managed by the global Teams Events policy. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Group "sales@contoso.com" -Rank 10 -Policy DisablePublicWebinars +``` + +The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "sales@contoso.com". + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy.md index cacbfb5a0b..539ec21dc4 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Grant-CsTeamsFeedbackPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfeedbackpolicy +schema: 2.0.0 +title: Grant-CsTeamsFeedbackPolicy --- # Grant-CsTeamsFeedbackPolicy @@ -95,6 +96,21 @@ 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 +``` + ### -Identity Indicates the identity of the user account the policy should be assigned to. @@ -140,12 +156,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: Object -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -155,28 +171,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Tenant +Internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Object 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: False @@ -186,15 +186,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFilesPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFilesPolicy.md index 3f44d72269..3f9f63aba5 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFilesPolicy.md @@ -1,207 +1,208 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/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) +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfilespolicy +schema: 2.0.0 +title: Grant-CsTeamsFilesPolicy +--- + +# 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/teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy.md similarity index 97% rename from teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy.md index 4e0833c5a5..8875198248 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsipphonepolicy schema: 2.0.0 +title: Grant-CsTeamsIPPhonePolicy --- # Grant-CsTeamsIPPhonePolicy @@ -98,6 +99,21 @@ 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 +``` + ### -Identity Indicates the identity of the user account the policy should be assigned to. @@ -143,21 +159,6 @@ 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. diff --git a/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaConnectivityPolicy.md similarity index 91% rename from teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaConnectivityPolicy.md index 126e7adfd2..260dd07111 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: runli +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Grant-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +title: Grant-CsTeamsMediaConnectivityPolicy --- # Grant-CsTeamsMediaConnectivityPolicy @@ -182,10 +183,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy) -[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy) -[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy) -[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaLoggingPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaLoggingPolicy.md index 960fd62910..d4131e4307 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaLoggingPolicy.md @@ -1,13 +1,14 @@ --- -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 -title: Grant-CsTeamsMediaLoggingPolicy author: LeoKuhorev -ms.author: leokukharau +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US manager: shalages +Module Name: MicrosoftTeams +ms.author: leokukharau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmedialoggingpolicy schema: 2.0.0 +title: Grant-CsTeamsMediaLoggingPolicy --- # Grant-CsTeamsMediaLoggingPolicy @@ -77,41 +78,34 @@ Unassign Teams Media Logging policy from the entire tenant. ## PARAMETERS -### -Identity - -Specifies the identity of the target user. -Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com +### -Confirm -Example: 98403f08-577c-46dd-851a-f0460a13b03d +> Applicable: Microsoft Teams -Use the "Global" Identity if you wish to set the policy for the entire tenant. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: -applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Global -Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. +> Applicable: Microsoft Teams + +When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -120,72 +114,83 @@ 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:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - -Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". - -If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: -applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global +### -Identity -When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". +> Applicable: Microsoft Teams + +Specifies the identity of the target user. +Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: String +Parameter Sets: Identity Aliases: -applicable: Microsoft Teams Required: False -Position: Named -Default value: False -Accept pipeline input: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf +### -PassThru -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +> Applicable: Microsoft Teams + +Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName + +> Applicable: Microsoft Teams + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". + +If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: -Required: True -Position: Named +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -206,15 +211,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -WhatIf -Prompts you for confirmation before running the cmdlet. +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -239,4 +246,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy) +[Get-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmedialoggingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy.md index cd29d655c1..7ce6703dd6 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Grant-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # Grant-CsTeamsMeetingBrandingPolicy @@ -54,6 +54,21 @@ In this example, the command will assign TeamsMeetingBrandingPolicy with the nam ## PARAMETERS +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. @@ -129,21 +144,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -157,12 +157,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy.md similarity index 87% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy.md index 1fac390b29..67c6f3e20c 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Grant-CsTeamsMeetingBroadcastPolicy --- # Grant-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS -Grant-CsTeamsMeetingBroadcastPolicy \[\[-Identity\] \\] \[-PolicyName\] \ \[-Tenant \\] \[-DomainController \\] \[-PassThru\] \[-WhatIf\] \[-Confirm\] \[\\] - -Grant-CsTeamsMeetingBroadcastPolicy \[-PolicyName\] \ \[-Tenant \\] \[-DomainController \\] \[-PassThru\] \[-Global\] \[-WhatIf\] \[-Confirm\] \[\\] +Use this cmdlet to assign a policy to a user. ## SYNTAX @@ -38,7 +38,7 @@ Grant-CsTeamsMeetingBroadcastPolicy [-PassThru] [[-PolicyName] ] ``` ## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to assign a policy to a user. +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## EXAMPLES @@ -88,6 +88,21 @@ 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 +``` + ### -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. @@ -147,21 +162,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Tenant ```yaml diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingPolicy.md index 555e7a9518..9928aaa8ff 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingPolicy.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingpolicy +schema: 2.0.0 +title: Grant-CsTeamsMeetingPolicy --- # Grant-CsTeamsMeetingPolicy @@ -50,11 +52,12 @@ In this example, a user with identity "Ken Myer" is being assigned the StudentMe ### -DomainController +> Applicable: Microsoft Teams + ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -63,59 +66,61 @@ 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. +### -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: UserIdParameter -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: -applicable: Microsoft Teams Required: False -Position: 0 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: GrantToGroup Aliases: -applicable: Microsoft Teams -Required: False +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. +### -Identity + +> Applicable: Microsoft Teams + +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 +Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +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". +### -PassThru + +> Applicable: Microsoft Teams ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant +Parameter Sets: (All) Aliases: Required: False @@ -125,16 +130,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName + +> Applicable: Microsoft Teams + +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: GrantToGroup +Parameter Sets: (All) Aliases: -Required: True -Position: Named +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -157,11 +165,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 85% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md index 591125a048..e6e183462b 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Grant-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Grant-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Grant-CsTeamsMeetingTemplatePermissionPolicy --- # Grant-CsTeamsMeetingTemplatePermissionPolicy @@ -54,15 +55,16 @@ Assigns a given policy to a user. ## PARAMETERS -### -PolicyName +### -Force -Specifies the Identity of the policy to assign to the user or group. +> Applicable: Microsoft Teams + +Forces the policy assignment. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -70,16 +72,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity +### -Global -This is the identifier of the user that the policy should be assigned to. +> Applicable: Microsoft Teams + +This is the equivalent to `-Identity Global`. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -88,13 +91,14 @@ Accept wildcard characters: False ### -Group +> Applicable: Microsoft Teams + This is the identifier of the group that the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -102,31 +106,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Global +### -Identity -This is the equivalent to `-Identity Global`. +> Applicable: Microsoft Teams + +This is the identifier of the user that the policy should be assigned to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -PolicyName -Forces the policy assignment. +> Applicable: Microsoft Teams + +Specifies the Identity of the policy to assign to the user or group. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -159,10 +165,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy) -[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMessagingPolicy.md similarity index 97% rename from teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMessagingPolicy.md index cbe96c09cb..152270a356 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMessagingPolicy.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmessagingpolicy +schema: 2.0.0 +title: Grant-CsTeamsMessagingPolicy --- # Grant-CsTeamsMessagingPolicy @@ -85,21 +87,6 @@ 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: 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". @@ -130,16 +117,16 @@ 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. +### -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: Int32 -Parameter Sets: GrantToGroup +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -174,6 +161,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant ```yaml diff --git a/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMobilityPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMobilityPolicy.md index 9ca488f23b..c79c90d5f9 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmobilitypolicy +schema: 2.0.0 +title: Grant-CsTeamsMobilityPolicy --- # Grant-CsTeamsMobilityPolicy @@ -63,89 +65,89 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The User Id of the user to whom the policy is being assigned. +### -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: UserIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +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 Global policy, you can assign $Null. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: Required: True -Position: 1 +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". +### -Identity +The User Id of the user to whom the policy is being assigned. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -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: String -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +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. +### -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: Int32 -Parameter Sets: GrantToGroup +Type: String +Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 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. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False diff --git a/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsPersonalAttendantPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsPersonalAttendantPolicy.md new file mode 100644 index 0000000000..7c28c9d8f3 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsPersonalAttendantPolicy.md @@ -0,0 +1,171 @@ +--- +applicable: Microsoft Teams +author: juliiva +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: jomarque +Module Name: MicrosoftTeams +ms.author: juliiva +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamspersonalattendantpolicy +schema: 2.0.0 +title: Grant-CsTeamsPersonalAttendantPolicy +--- + + +# Grant-CsTeamsPersonalAttendantPolicy + +## SYNOPSIS + +**Limited Preview:** Functionality described in this document is currently in limited preview and only authorized organizations have access. + +Assigns a specific Teams Personal Attendant Policy to a user, a group of users, or sets the Global policy instance. + +## SYNTAX + +```powershell +Grant-CsTeamsPersonalAttendantPolicy [-Identity ] [-PolicyName ] [-PassThru] [-Global] [-Rank ] [] +``` + +## DESCRIPTION +The Teams Personal Attendant Policies designate how users are able to use personal attendant and its functionalities within Microsoft Teams. This cmdlet allows admins to grant user level policies to individual users, to members of a group, or to set the Global policy instance. + +## EXAMPLES + +### Example 1 +``` +Grant-CsTeamsPersonalAttendantPolicy -identity user1@contoso.com -PolicyName SalesPersonalAttendantPolicy +``` + +Assigns the TeamsPersonalAttendantPolicy called "SalesPersonalAttendantPolicy" to user1@contoso.com + +### Example 2 +``` +Grant-CsTeamsPersonalAttendantPolicy -Global -PolicyName SalesPersonalAttendantPolicy +``` + +Assigns the TeamsPersonalAttendantPolicy called "SalesPersonalAttendantPolicy" to the Global policy instance. This sets the parameters in the Global policy instance to the values found +in the SalesPersonalAttendantPolicy instance. + +### Example 3 +``` +Grant-CsTeamsPersonalAttendantPolicy -Group sales@contoso.com -Rank 10 -PolicyName SalesPersonalAttendantPolicy +``` + +Assigns the TeamsPersonalAttendantPolicy called "SalesPersonalAttendantPolicy" to the members of the group sales@contoso.com. + +## PARAMETERS + +### -Identity +The user object to whom the policy is being assigned. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the policy being assigned. To remove an existing user level policy assignment, specify PolicyName as $null. + +```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. By default, the Grant-CsTeamsPersonalAttendantPolicy 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 +``` + +### -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: 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 + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +The cmdlet is available in Teams PowerShell module 7.2.1-preview or later. + +## RELATED LINKS + +[New-CsTeamsPersonalAttendantPolicy](./new-csteamspersonalattendantpolicy.md) + +[Set-CsTeamsPersonalAttendantPolicy](./set-csteamspersonalattendantpolicy.md) + +[Get-CsTeamsPersonalAttendantPolicy](./get-csteamspersonalattendantpolicy.md) + +[Remove-CsTeamsPersonalAttendantPolicy](./remove-csteamspersonalattendantpolicy.md) diff --git a/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRecordingRollOutPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRecordingRollOutPolicy.md index de38261c46..7dd7636329 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams ms.author: ronwa +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsrecordingrolloutpolicy +schema: 2.0.0 +title: Grant-CsTeamsRecordingRollOutPolicy --- # Grant-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md index e9460ea3d0..f3bb5bc3cc 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,204 +1,207 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Grant-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Grant-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. + +## SYNTAX + +### Identity (Default) + +``` +Grant-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +``` +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +``` +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). + +## EXAMPLES + +## 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/MicrosoftTeams/Grant-CsTeamsSharedCallingRoutingPolicy.md similarity index 84% rename from teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSharedCallingRoutingPolicy.md index 4eb7f30ac5..fffe5cff12 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsSharedCallingRoutingPolicy -schema: 2.0.0 author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy +schema: 2.0.0 +title: Grant-CsTeamsSharedCallingRoutingPolicy --- # Grant-CsTeamsSharedCallingRoutingPolicy @@ -39,6 +38,9 @@ Grant-CsTeamsSharedCallingRoutingPolicy -Global [[-PolicyName] ] [-Force Grant-CsTeamsSharedCallingRoutingPolicy [-Group] [[-PolicyName] ] -Rank [] ``` +## DESCRIPTION +The `Grant-CsTeamsSharedCallingRoutingPolicy` cmdlet assigns a Teams shared calling routing policy to a user, a group of users, or sets the Global policy instance. This cmdlet is used to manage how calls are routed in Microsoft Teams, allowing administrators to control call handling and routing behavior for users within their organization. + ## EXAMPLES ### EXAMPLE 1 @@ -55,34 +57,20 @@ Example 2 assigns the per-user Teams shared calling routing policy instance Seat ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user Teams shared calling routing policy. User identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's ObjectId or Identity. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +### -Force -### -PolicyName -Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Seattle has a PolicyName equal to Seattle. +> Applicable: Microsoft Teams -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -117,12 +105,29 @@ 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. +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams shared calling routing policy. User identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's ObjectId or Identity. ```yaml -Type: Int32 -Parameter Sets: (GrantToGroup) +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Seattle has a PolicyName equal to Seattle. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + +```yaml +Type: String +Parameter Sets: (All) Aliases: Required: False @@ -132,18 +137,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Type: Int32 +Parameter Sets: (GrantToGroup) +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -159,10 +163,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](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy) -[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy) -[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsShiftsPolicy.md similarity index 88% rename from teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsShiftsPolicy.md index 43875faa32..2be5e973bb 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsShiftsPolicy.md @@ -1,162 +1,167 @@ ---- -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 ---- - -# Grant-CsTeamsShiftsPolicy - -## SYNOPSIS - -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 cmdlet enables admins to grant Shifts specific policy settings to users in their tenant. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsShiftsPolicy -Identity IsaiahL@mwtdemo.onmicrosoft.com -PolicyName OffShiftAccessMessage1Always -``` -Applies the OffShiftAccessMessage1Always instance of TeamsShiftsPolicy to one user in the tenant. - -## PARAMETERS - -### -Identity -UserId to whom the policy is granted. Email id is acceptable. - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PolicyName -The name of the TeamsShiftsPolicy instance that is being applied to the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -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: True -Position: Named - -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-teamsshiftspolicy +schema: 2.0.0 +title: Grant-CsTeamsShiftsPolicy +--- + +# Grant-CsTeamsShiftsPolicy + +## SYNOPSIS + +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 cmdlet enables admins to grant Shifts specific policy settings to users in their tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsShiftsPolicy -Identity IsaiahL@mwtdemo.onmicrosoft.com -PolicyName OffShiftAccessMessage1Always +``` +Applies the OffShiftAccessMessage1Always instance of TeamsShiftsPolicy to one user in the tenant. + +## 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 +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 + +> Applicable: Microsoft Teams + +UserId to whom the policy is granted. Email id is acceptable. + +```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 + +> Applicable: Microsoft Teams + +The name of the TeamsShiftsPolicy instance that is being applied to the user. + +```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: True +Position: Named + +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftspolicy) + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 92% rename from teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md index bbe885264d..57349e431d 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,199 +1,204 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Grant-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Grant-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Grants a Survivable Branch Appliance (SBA) Policy to users in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +Grant-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +``` +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +``` +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +## 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/MicrosoftTeams/Grant-CsTeamsUpdateManagementPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpdateManagementPolicy.md index d17f961f44..e67586f45c 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: gnamun +Module Name: MicrosoftTeams +ms.author: vargasj +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsupdatemanagementpolicy +schema: 2.0.0 +title: Grant-CsTeamsUpdateManagementPolicy --- # Grant-CsTeamsUpdateManagementPolicy diff --git a/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpgradePolicy.md similarity index 98% rename from teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpgradePolicy.md index 54251476e5..b59e391ee5 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpgradePolicy.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy +schema: 2.0.0 +title: Grant-CsTeamsUpgradePolicy --- # Grant-CsTeamsUpgradePolicy @@ -154,28 +156,29 @@ After running these lines will create an HTML file on the Desktop of the curre ## PARAMETERS -### -Identity - -The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. +### -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: UserIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName +### -Global -The name of the policy instance. +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -186,46 +189,43 @@ 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. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: GrantToGroup Aliases: -Required: False -Position: 1 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Identity -Do not use. +The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. ```yaml -Type: Object -Parameter Sets: (All) +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -MigrateMeetingsToTeams +Not supported anymore, see the Description section. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: Boolean +Parameter Sets: (All) Aliases: Required: False @@ -235,44 +235,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -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: String -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateMeetingsToTeams -Not supported anymore, see the Description section. +### -PolicyName + +The name of the policy instance. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 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. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -282,12 +283,13 @@ 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. +### -Tenant + +Do not use. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: Object +Parameter Sets: (All) Aliases: Required: False @@ -318,8 +320,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [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) +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradeconfiguration) -[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsupgradeconfiguration) -[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradepolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVdiPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVdiPolicy.md index 6d3a365fa0..0e775357fe 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVdiPolicy.md @@ -1,153 +1,154 @@ ---- -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 +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvdipolicy +schema: 2.0.0 +title: Grant-CsTeamsVdiPolicy +--- + +# 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/teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy.md similarity index 95% rename from teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy.md index a6a5f02703..532b2e864a 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvideointeropservicepolicy +schema: 2.0.0 +title: Grant-CsTeamsVideoInteropServicePolicy --- # Grant-CsTeamsVideoInteropServicePolicy ## SYNOPSIS - -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. +The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. ## SYNTAX @@ -41,8 +41,6 @@ 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. -The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. - User needs to be assigned one policy from admin to create a CVI meeting. There could be multiple provides in a tenant, but user can only be assigned only one policy(provide). **FAQ**: @@ -144,6 +142,21 @@ 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 +``` + ### -Identity {{Fill Identity Description}} @@ -189,12 +202,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -204,44 +217,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Tenant +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: wi - -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 +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. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVirtualAppointmentsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVirtualAppointmentsPolicy.md index 1203279e74..aab8aec8e6 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy -title: Grant-CsTeamsVirtualAppointmentsPolicy -schema: 2.0.0 ms.author: erocha -manager: sonaggarwal -author: emmanuelrocha001 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy +schema: 2.0.0 +title: Grant-CsTeamsVirtualAppointmentsPolicy --- # Grant-CsTeamsVirtualAppointmentsPolicy @@ -185,11 +186,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy) -[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVoiceApplicationsPolicy.md similarity index 92% rename from teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVoiceApplicationsPolicy.md index e97f8b3ab1..5f994f136f 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy -title: Grant-CsTeamsVoiceApplicationsPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy schema: 2.0.0 +title: Grant-CsTeamsVoiceApplicationsPolicy --- # Grant-CsTeamsVoiceApplicationsPolicy @@ -51,27 +52,27 @@ Example 2 assigns the per-user online voice routing policy "SDA-Allow-All to all ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user Teams voice applications policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +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 voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: Required: False @@ -80,64 +81,63 @@ Default value: False Accept pipeline input: False Accept wildcard characters: False ``` - -### -PolicyName -"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. - -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: -Required: False -Position: 2 +Required: True +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, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams voice applications policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named -Default value: False -Accept pipeline input: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +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. +### -PolicyName +"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -158,15 +158,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -187,10 +188,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy) -[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy) -[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLoadPolicy.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLoadPolicy.md index b6dcf697af..39a805833f 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLoadPolicy.md @@ -1,253 +1,254 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworkloadpolicy +schema: 2.0.0 +title: Grant-CsTeamsWorkLoadPolicy +--- + +# 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/microsoftteams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLocationDetectionPolicy.md similarity index 91% rename from teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLocationDetectionPolicy.md index 35c5297361..67a1e95478 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur 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 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy +schema: 2.0.0 +title: Grant-CsTeamsWorkLocationDetectionPolicy --- # Grant-CsTeamsWorkLocationDetectionPolicy @@ -185,10 +186,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy) -[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy) -[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy) -[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTenantDialPlan.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTenantDialPlan.md index 9f4245e9a8..f6398048e4 100644 --- a/teams/teams-ps/teams/Grant-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-cstenantdialplan +schema: 2.0.0 +title: Grant-CsTenantDialPlan --- # Grant-CsTenantDialPlan @@ -69,13 +70,15 @@ This example grants the Vt1tenantDialPlan9 dial plan to members of the group sal ## PARAMETERS ### -Global + +> Applicable: Microsoft Teams + Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: SwitchParameter Parameter Sets: (GrantToTenant) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -84,82 +87,91 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Group + +> Applicable: Microsoft Teams + +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: (GrantToGroup) Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The PolicyName parameter is the name of the tenant dial plan to be assigned. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter identifies the user to whom the policy should be assigned. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (Identity) Aliases: -Applicable: Microsoft Teams Required: False -Position: 1 +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PassThru + +> Applicable: Microsoft Teams ```yaml -Type: String -Parameter Sets: (GrantToGroup) +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True -Position: 0 +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. +### -PolicyName + +> Applicable: Microsoft Teams + +The PolicyName parameter is the name of the tenant dial plan to be assigned. ```yaml -Type: Int32 -Parameter Sets: (GrantToGroup) +Type: String +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter identifies the user to whom the policy should be assigned. +### -Rank + +> Applicable: Microsoft Teams + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: String -Parameter Sets: (Identity) +Type: Int32 +Parameter Sets: (GrantToGroup) Aliases: -Applicable: Microsoft Teams Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -176,10 +188,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) -[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan) -[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantdialplan) -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Grant-CsUserPolicyPackage.md similarity index 88% rename from teams/teams-ps/teams/Grant-CsUserPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsUserPolicyPackage.md index 6d4fc120b3..0dcab00759 100644 --- a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsUserPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Grant-CsUserPolicyPackage -author: serdarsoysal ms.author: serdars -manager: amitar -online version: https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csuserpolicypackage schema: 2.0.0 +title: Grant-CsUserPolicyPackage --- # Grant-CsUserPolicyPackage @@ -37,15 +38,31 @@ Applies the Education_PrimaryStudent policy package to two users in the tenant. ## 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 +> Applicable: Microsoft Teams + A list of one or more users in the tenant. Note that there is a limit of 20 users you can apply the package to at a time. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -55,13 +72,14 @@ Accept wildcard characters: False ### -PackageName +> Applicable: Microsoft Teams + The name of a specific policy package to apply. All possible policy package names can be found by running Get-CsPolicyPackage. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -85,21 +103,6 @@ Accept 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). @@ -111,10 +114,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation) -[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackage) -[New-CsBatchPolicyPackageAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation) +[New-CsBatchPolicyPackageAssignmentOperation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchpolicypackageassignmentoperation) diff --git a/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md b/teams/teams-ps/MicrosoftTeams/Import-CsAutoAttendantHolidays.md similarity index 92% rename from teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md rename to teams/teams-ps/MicrosoftTeams/Import-CsAutoAttendantHolidays.md index aee3150e6e..4dbfb416bf 100644 --- a/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/MicrosoftTeams/Import-CsAutoAttendantHolidays.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/import-csautoattendantholidays +schema: 2.0.0 +title: Import-CsAutoAttendantHolidays --- # Import-CsAutoAttendantHolidays @@ -44,7 +46,7 @@ where ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv") Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -Input $bytes @@ -52,7 +54,7 @@ Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -I In this example, the Import-CsAutoAttendantHolidays cmdlet is used to import holiday schedule information from a file at path "C:\Imports\Holidays.csv" to an auto attendant with Identity of 6abea1cd-904b-520b-be96-1092cc096432. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv") Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -Input $bytes | Format-Table -Wrap -AutoSize @@ -63,13 +65,15 @@ In this example, the Import-CsAutoAttendantHolidays cmdlet is used to import hol ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the AA whose holiday schedules are to be imported. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -79,13 +83,15 @@ Accept wildcard characters: False ``` ### -Input + +> Applicable: Microsoft Teams + The Input parameter specifies the holiday schedule information that is to be imported. ```yaml Type: System.Byte[] Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -96,11 +102,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -125,6 +132,6 @@ The Import-CsAutoAttendantHolidays cmdlet accepts a string as the Identity param ## RELATED LINKS -[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays) +[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/export-csautoattendantholidays) -[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays) +[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantholidays) diff --git a/teams/teams-ps/teams/Import-CsOnlineAudioFile.md b/teams/teams-ps/MicrosoftTeams/Import-CsOnlineAudioFile.md similarity index 89% rename from teams/teams-ps/teams/Import-CsOnlineAudioFile.md rename to teams/teams-ps/MicrosoftTeams/Import-CsOnlineAudioFile.md index 08de362834..8b4932a602 100644 --- a/teams/teams-ps/teams/Import-CsOnlineAudioFile.md +++ b/teams/teams-ps/MicrosoftTeams/Import-CsOnlineAudioFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile applicable: Microsoft Teams -title: Import-CsOnlineAudioFile -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile +schema: 2.0.0 +title: Import-CsOnlineAudioFile --- # Import-CsOnlineAudioFile @@ -32,7 +33,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/teams/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/microsoftteams/new-csautoattendantprompt). ### Example 2 ```powershell @@ -40,7 +41,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/teams/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/microsoftteams/set-cscallqueue) to provide the audio file id. ### Example 3 ```powershell @@ -48,11 +49,14 @@ $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/teams/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/microsoftteams/new-csteamscallholdpolicy) to provide the audio file id. ## PARAMETERS ### -ApplicationId + +> Applicable: Microsoft Teams + The ApplicationId parameter is the identifier for the application which will use this audio file. For example, if the audio file will be used with an Auto Attendant, then it needs to be set to "OrgAutoAttendant". If the audio file will be used with a Call Queue, then it needs to be set to "HuntGroup". If the audio file will be used with Microsoft Teams, then it needs to be set to "TenantGlobal". Supported values: @@ -65,7 +69,6 @@ Supported values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -74,14 +77,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileName -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. +### -Content + +> Applicable: Microsoft Teams + +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: String +Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -90,14 +95,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Content -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. +### -FileName + +> Applicable: Microsoft Teams + +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: Byte[] +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -126,8 +133,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](https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile) +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/export-csonlineaudiofile) -[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineaudiofile) -[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineaudiofile) diff --git a/teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md b/teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md new file mode 100644 index 0000000000..09b0588616 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md @@ -0,0 +1,1761 @@ +--- +Locale: en-US +Module Guid: d910df43-3ca6-4c9c-a2e3-e9f45a8e2ad9 +Module Name: MicrosoftTeams +title: MicrosoftTeams PowerShell module +Download Help Link: +Help Version: +--- + +# MicrosoftTeams PowerShell module + +## Description +The following cmdlet references are for Microsoft Teams. + +## MicrosoftTeams Cmdlets + +### [Add-TeamChannelUser](Add-TeamChannelUser.md) +Adds an owner or member to the private channel. + +### [Add-TeamUser](Add-TeamUser.md) +The `Add-TeamUser` adds an owner or member to the team, and to the unified group which backs the team. + +### [Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) +Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telephone number search order and release the telephone numbers. The telephone numbers can then be available for search and acquire. + +### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md) +Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. + +### [Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) +Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. + +### [Connect-MicrosoftTeams](Connect-MicrosoftTeams.md) +The Connect-MicrosoftTeams cmdlet connects an authenticated account for use with cmdlets from the MicrosoftTeams module. + +### [Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) +This cmdlet prevents provisioning of users in Skype for Business Online for the specified domain. + +### [Disconnect-MicrosoftTeams](Disconnect-MicrosoftTeams.md) +{{Placeholder}} + +### [Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) +This cmdlet enables provisioning of users in Skype for Business Online for the specified domain. + +### [Export-CsAcquiredPhoneNumber](Export-CsAcquiredPhoneNumber.md) +This cmdlet exports the list of phone numbers acquired by Teams Phone tenant. + +### [Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) +Use Export-CsAutoAttendantHolidays cmdlet to export holiday schedules of an existing Auto Attendant (AA). + +### [Export-CsOnlineAudioFile](Export-CsOnlineAudioFile.md) +Use the Export-CsOnlineAudioFile cmdlet to download an existing audio file. + +### [Find-CsGroup](Find-CsGroup.md) +Use the Find-CsGroup cmdlet to search groups. + +### [Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria. + +### [Get-AllM365TeamsApps](Get-AllM365TeamsApps.md) +This cmdlet returns all Microsoft Teams apps in the app catalog, including Microsoft, custom, and non-Microsoft apps. + +### [Get-AssociatedTeam](Get-AssociatedTeam.md) +This cmdlet supports retrieving all teams associated with a user, including teams which host shared channels. + +### [Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) +Retrieves information about the application access policy configured for use in the tenant. + +### [Get-CsApplicationMeetingConfiguration](Get-CsApplicationMeetingConfiguration.md) +Retrieves information about the application meeting configuration settings configured for the tenant. + +### [Get-CsAutoAttendant](Get-CsAutoAttendant.md) +Use the Get-CsAutoAttendant cmdlet to get information about your Auto Attendants (AA). + +### [Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) +Use Get-CsAutoAttendantHolidays cmdlet to get the holiday information for an existing Auto Attendant (AA). + +### [Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) +Use Get-CsAutoAttendantStatus cmdlet to get the status of an Auto Attendant (AA) provisioning. + +### [Get-CsAutoAttendantSupportedLanguage](Get-CsAutoAttendantSupportedLanguage.md) +The Get-CsAutoAttendantSupportedLanguage cmdlet gets languages that are supported by the Auto Attendant (AA) service. + +### [Get-CsAutoAttendantSupportedTimeZone](Get-CsAutoAttendantSupportedTimeZone.md) +The Get-CsAutoAttendantSupportedTimeZone cmdlet gets supported time zones for the Auto Attendant (AA) service. + +### [Get-CsAutoAttendantTenantInformation](Get-CsAutoAttendantTenantInformation.md) +Gets the default tenant information for Auto Attendant (AA) feature. + +### [Get-CsBatchPolicyAssignmentOperation](Get-CsBatchPolicyAssignmentOperation.md) +This cmdlet is used to retrieve the status of batch policy assignment operations. + +### [Get-CsBatchTeamsDeploymentStatus](Get-CsBatchTeamsDeploymentStatus.md) +This cmdlet is used to get the status of the batch deployment orchestration. + +### [Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) +Use the `Get-CsCallingLineIdentity` cmdlet to display the Caller ID policies for your organization. + +### [Get-CsCallQueue](Get-CsCallQueue.md) +The Get-CsCallQueue cmdlet returns the identified Call Queues. + +### [Get-CsCloudCallDataConnection](Get-CsCloudCallDataConnection.md) +This cmdlet retrieves an already existing online call data connection. + +### [Get-CsComplianceRecordingForCallQueueTemplate](Get-CsComplianceRecordingForCallQueueTemplate.md) +```powershell Get-CsComplianceRecordingForCallQueueTemplate [-Id ] [] ``` + +### [Get-CsEffectiveTenantDialPlan](Get-CsEffectiveTenantDialPlan.md) +Use the Get-CsEffectiveTenantDialPlan cmdlet to retrieve an effective tenant dial plan. + +### [Get-CsExportAcquiredPhoneNumberStatus](Get-CsExportAcquiredPhoneNumberStatus.md) +This cmdlet shows the status of the [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/export-csacquiredphonenumber) cmdlet. + +### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) +Returns information about the external access policies that have been configured for use in your organization. + +### [Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) +This cmdlet is used to return group policy assignments. + +### [Get-CsHybridTelephoneNumber](Get-CsHybridTelephoneNumber.md) +This cmdlet displays information about one or more hybrid telephone numbers. + +### [Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) +Returns a list of all blocked number patterns added to the tenant list. + +### [Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) +Returns a specific or the full list of all number patterns exempt from call blocking. + +### [Get-CsMainlineAttendantAppointmentBookingFlow](Get-CsMainlineAttendantAppointmentBookingFlow.md) +Returns the identified Mainline attendant appointment booking flow. + +### [Get-CsMainlineAttendantFlow](Get-CsMainlineAttendantFlow.md) +Returns information about the Mainline Attendant flows configured in your organization. + +### [Get-CsMainlineAttendantQuestionAnswerFlow](Get-CsMainlineAttendantQuestionAnswerFlow.md) +Returns the identified Mainline attendant question and answer flow. + +### [Get-CsMeetingMigrationStatus](Get-CsMeetingMigrationStatus.md) +You use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of meeting migrations. + +### [Get-CsPersonalAttendantSettings](Get-CsPersonalAttendantSettings.md) +Returns the personal attendant settings for a user. + +### [Get-CsTeamsPersonalAttendantPolicy](Get-CsTeamsPersonalAttendantPolicy.md) +Returns information about the Teams personal attendant policies configured for use in your organization. + +### [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) +Get application instance for the tenant from Microsoft Entra ID. + +### [Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) +Use the Get-CsOnlineApplicationInstanceAssociation cmdlet to get information about the associations setup in your organization. + +### [Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) +Use the Get-CsOnlineApplicationInstanceAssociationStatus cmdlet to get the provisioning status for the associations you have setup in your organization. + +### [Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet retrieves all online audio conferencing routing policies for the tenant. + +### [Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) +Returns information about a specific or all uploaded audio files of a given application type. + +### [Get-CsOnlineDialInConferencingBridge](Get-CsOnlineDialInConferencingBridge.md) +Use the Get-CsOnlineDialInConferencingBridge cmdlet to view the settings on an audio conferencing bridge that is used when Microsoft is the audio conferencing provider. + +### [Get-CsOnlineDialInConferencingLanguagesSupported](Get-CsOnlineDialInConferencingLanguagesSupported.md) +Use the Get-CsOnlineDialInConferencingLanguagesSupported cmdlet to view the list of languages that are supported when an organization uses Microsoft as the dial-in audio conferencing provider. + +### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) +Retrieves the available Dial-in Conferencing policies in the tenant. + +### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) +Use the Get-CsOnlineDialInConferencingServiceNumber cmdlet to return all of the default dial-in service numbers that are assigned to an Office 365 audio conferencing bridge. + +### [Get-CsOnlineDialinConferencingTenantConfiguration](Get-CsOnlineDialinConferencingTenantConfiguration.md) +Use the Get-CsOnlineDialinConferencingTenantConfiguration cmdlet to retrieve the tenant level configuration for dial-in conferencing. + +### [Get-CsOnlineDialInConferencingTenantSettings](Get-CsOnlineDialInConferencingTenantSettings.md) +Use the Get-CsOnlineDialInConferencingTenantSettings cmdlet to retrieve tenant level settings for dial-in conferencing. + +### [Get-CsOnlineDialInConferencingUser](Get-CsOnlineDialInConferencingUser.md) +Use the `Get-CsOnlineDialInConferencingUser` cmdlet to view the properties and settings of users that are enabled for dial-in conferencing and are using Microsoft as their PSTN conferencing provider. + +### [Get-CsOnlineDialOutPolicy](Get-CsOnlineDialOutPolicy.md) +Use the `Get-CsOnlineDialOutPolicy` cmdlet to get all the available outbound calling restriction policies in your organization. + +### [Get-CsOnlineDirectoryTenant](Get-CsOnlineDirectoryTenant.md) +Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve a tenant and associated parameters from the Business Voice Directory. + +### [Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +Use the Get-CsOnlineEnhancedEmergencyServiceDisclaimer cmdlet to determine whether your organization has accepted the terms and conditions of enhanced emergency service. + +### [Get-CsOnlineLisCivicAddress](Get-CsOnlineLisCivicAddress.md) +Use the Get-CsOnlineLisCivicAddress cmdlet to retrieve information about existing emergency civic addresses defined in the Location Information Service (LIS). + +### [Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) +Use the Get-CsOnlineLisLocation cmdlet to retrieve information on previously defined locations in the Location Information Service (LIS.) + +### [Get-CsOnlineLisPort](Get-CsOnlineLisPort.md) +Retrieves one or more ports from the location configuration database. + +### [Get-CsOnlineLisSubnet](Get-CsOnlineLisSubnet.md) +Retrieves one or more subnets from the location configuration database. + +### [Get-CsOnlineLisSwitch](Get-CsOnlineLisSwitch.md) +Retrieves one or more network switches from the location configuration database. + +### [Get-CsOnlineLisWirelessAccessPoint](Get-CsOnlineLisWirelessAccessPoint.md) +Retrieves one or more wireless access points (WAPs) from the location configuration database. + +### [Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) +Shows the configuration of the previously defined Session Border Controller(s) (SBC(s)) that describes the settings for the peer entity. This cmdlet was introduced with Microsoft Phone System Direct Routing. + +### [Get-CsOnlinePstnUsage](Get-CsOnlinePstnUsage.md) +Returns information about online public switched telephone network (PSTN) usage records used in your tenant. + +### [Get-CsOnlineSchedule](Get-CsOnlineSchedule.md) +Use the Get-CsOnlineSchedule cmdlet to get information about schedules that belong to your organization. + +### [Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) +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. + +### [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) +Use the `Get-CsOnlineTelephoneNumber` to retrieve telephone numbers from the Business Voice Directory. + +### [Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) +Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. + +### [Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) +Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number order. + +### [Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) +Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. + +### [Get-CsOnlineUser](Get-CsOnlineUser.md) +Returns information about users who have accounts homed on Microsoft Teams or Skype for Business Online. + +### [Get-CsOnlineVoicemailPolicy](Get-CsOnlineVoicemailPolicy.md) +Use the `Get-CsOnlineVoicemailPolicy` cmdlet to get a list of all pre-configured policy instances related to Cloud Voicemail service. + +### [Get-CsOnlineVoicemailUserSettings](Get-CsOnlineVoicemailUserSettings.md) +Use the Get-CsOnlineVoicemailUserSettings cmdlet to get information about online voicemail user settings of a specific user. + +### [Get-CsOnlineVoiceRoute](Get-CsOnlineVoiceRoute.md) +Returns information about the online voice routes configured for use in your tenant. + +### [Get-CsOnlineVoiceRoutingPolicy](Get-CsOnlineVoiceRoutingPolicy.md) +Returns information about the online voice routing policies configured for use in your tenant. + +### [Get-CsOnlineVoiceUser](Get-CsOnlineVoiceUser.md) +Use the `Get-CsOnlineVoiceUser` cmdlet to retrieve a voice user's telephone number and location. + +### [Get-CsPhoneNumberAssignment](Get-CsPhoneNumberAssignment.md) +This cmdlet displays information about one or more phone numbers. + +### [Get-CsPhoneNumberTag](Get-CsPhoneNumberTag.md) +This cmdlet allows the admin to get a list of existing tags for telephone numbers. + +### [Get-CsPolicyPackage](Get-CsPolicyPackage.md) +This cmdlet supports retrieving all the policy packages available on a tenant. + +### [Get-CsSdgBulkSignInRequestsSummary](Get-CsSdgBulkSignInRequestsSummary.md) +Get the tenant level summary of all bulk sign in requests executed in the past 30 days. + +### [Get-CsSdgBulkSignInRequestStatus](Get-CsSdgBulkSignInRequestStatus.md) +Get the status of an active bulk sign in request. + +### [Get-CsSharedCallQueueHistoryTemplate](Get-CsSharedCallQueueHistoryTemplate.md) +```powershell Get-CsSharedCallQueueHistoryTemplate -Id [] ``` + +### [Get-CsTeamsAcsFederationConfiguration](Get-CsTeamsAcsFederationConfiguration.md) +This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. + +### [Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md) +This cmdlet retrieves all Teams AI policies for the tenant. + +### [Get-CsTeamsAppPermissionPolicy](Get-CsTeamsAppPermissionPolicy.md) +As an admin, you can use app permission policies to allow or block apps for your users. + +### [Get-CsTeamsAppSetupPolicy](Get-CsTeamsAppSetupPolicy.md) +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. + +### [Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) +Audio conferencing policies can be used to manage audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. + +### [Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) +Returns information about the policies configured to customize the call hold experience for Teams clients. + +### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) +Returns information about the teams calling policies configured for use in your organization. Teams calling policies help determine which users are able to use calling functionality within Microsoft Teams. + +### [Get-CsTeamsCallParkPolicy](Get-CsTeamsCallParkPolicy.md) +The Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. + +### [Get-CsTeamsChannelsPolicy](Get-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [Get-CsTeamsClientConfiguration](Get-CsTeamsClientConfiguration.md) +This cmdlet allows IT admins to retrieve the effective configuration for their organization. + +### [Get-CsTeamsComplianceRecordingApplication](Get-CsTeamsComplianceRecordingApplication.md) +Returns information about the application instances of policy-based recording applications that have been configured for administering automatic policy-based recording in your tenant. + +### [Get-CsTeamsComplianceRecordingPolicy](Get-CsTeamsComplianceRecordingPolicy.md) +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. + +### [Get-CsTeamsCortanaPolicy](Get-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +### [Get-CsTeamsEducationAssignmentsAppPolicy](Get-CsTeamsEducationAssignmentsAppPolicy.md) +This cmdlet allows you to retrieve the current values of your Education Assignments App Policy. + +### [Get-CsTeamsEducationConfiguration](Get-CsTeamsEducationConfiguration.md) +This cmdlet is used to retrieve the organization-wide education configuration for Teams. + +### [Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet returns one or more Emergency Call Routing policies. + +### [Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) +Returns information about the teams enhanced encryption policies configured for use in your organization. + +### [Get-CsTeamsEventsPolicy](Get-CsTeamsEventsPolicy.md) +Returns information about the Teams Events policy. Note that this policy is currently still in preview. + +### [Get-CsTeamsExternalAccessConfiguration](Get-CsTeamsExternalAccessConfiguration.md) +This cmdlet returns the current settings of your organization. + +### [Get-CsTeamsFeedbackPolicy](Get-CsTeamsFeedbackPolicy.md) +Use this cmdlet to retrieve the current Teams Feedback policies (the ability to send feedback about Teams to Microsoft and whether they receive the survey) in the organization. + +### [Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) +Get a list of all pre-configured policy instances related to teams files. + +### [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) +This cmdlet fetches the first-party meeting templates stored on the tenant. + +### [Get-CsTeamsGuestCallingConfiguration](Get-CsTeamsGuestCallingConfiguration.md) +Returns information about the GuestCallingConfiguration, which specifies what options guest users have for calling within Teams. + +### [Get-CsTeamsGuestMeetingConfiguration](Get-CsTeamsGuestMeetingConfiguration.md) +Designates what meeting features guests using Microsoft Teams will have available. + +### [Get-CsTeamsGuestMessagingConfiguration](Get-CsTeamsGuestMessagingConfiguration.md) +TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. This cmdlet returns your organization's current settings. + +### [Get-CsTeamsIPPhonePolicy](Get-CsTeamsIPPhonePolicy.md) +Get-CsTeamsIPPhonePolicy allows IT Admins to view policies for IP Phone experiences in Microsoft Teams. + +### [Get-CsTeamsMediaConnectivityPolicy](Get-CsTeamsMediaConnectivityPolicy.md) +This cmdlet retrieves all Teams media connectivity policies for the current tenant. + +### [Get-CsTeamsMediaLoggingPolicy](Get-CsTeamsMediaLoggingPolicy.md) +Returns information about the Teams Media Logging policy. + +### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [Get-CsTeamsMeetingBroadcastConfiguration](Get-CsTeamsMeetingBroadcastConfiguration.md) +Gets Tenant level configuration for broadcast events in Teams. + +### [Get-CsTeamsMeetingBroadcastPolicy](Get-CsTeamsMeetingBroadcastPolicy.md) +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. + +### [Get-CsTeamsMeetingConfiguration](Get-CsTeamsMeetingConfiguration.md) +The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants. + +### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) +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. + +### [Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) +This cmdlet fetches the custom meeting templates stored on the tenant. + +### [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) +Fetches the TeamsMeetingTemplatePermissionPolicy. This policy can be used to hide meeting templates from users and groups. + +### [Get-CsTeamsMessagingConfiguration](Get-CsTeamsMessagingConfiguration.md) +TeamsMessagingConfiguration determines the messaging settings for users. This cmdlet returns your organization's current settings. + +### [Get-CsTeamsMessagingPolicy](Get-CsTeamsMessagingPolicy.md) +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. + +### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Get-CsTeamsMultiTenantOrganizationConfiguration](Get-CsTeamsMultiTenantOrganizationConfiguration.md) +This cmdlet retrieves all tenant settings for Multi-tenant Organizations + +### [Get-CsTeamsNetworkRoamingPolicy](Get-CsTeamsNetworkRoamingPolicy.md) +Get-CsTeamsNetworkRoamingPolicy allows IT Admins to view policies for the Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [Get-CsTeamsNotificationAndFeedsPolicy](Get-CsTeamsNotificationAndFeedsPolicy.md) +Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. + +### [Get-CsTeamsRecordingRollOutPolicy](Get-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Get-CsTeamsRoomVideoTeleConferencingPolicy](Get-CsTeamsRoomVideoTeleConferencingPolicy.md) +Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. + +### [Get-CsTeamsSettingsCustomApp](Get-CsTeamsSettingsCustomApp.md) +Get the Custom Apps Setting's value of Teams Admin Center. + +### [Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) +Use the Get-CsTeamsSharedCallingRoutingPolicy cmdlet to get Teams shared calling routing policy information. Teams shared calling routing policy is used to configure shared calling. + +### [Get-CsTeamsShiftsAppPolicy](Get-CsTeamsShiftsAppPolicy.md) +Returns information about the Teams Shifts App policies that have been configured for use in your organization. + +### [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) +This cmdlet returns the list of existing workforce management (WFM) connections. It can also return the configuration details for a given WFM connection. + +### [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) +This cmdlet supports retrieving the available Shifts Connectors. + +### [Get-CsTeamsShiftsConnectionErrorReport](Get-CsTeamsShiftsConnectionErrorReport.md) +This cmdlet returns the list of all the team mapping error reports. It can also return the configuration details of one mapping error report with its ID provided or other filter parameters. + +### [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +This cmdlet returns the list of existing connection instances. It can also return the configuration details for a given connection instance. + +### [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md) +This cmdlet gets the requested batch mapping operation. + +### [Get-CsTeamsShiftsConnectionSyncResult](Get-CsTeamsShiftsConnectionSyncResult.md) +This cmdlet supports retrieving the list of user details in the mapped teams of last sync. + +### [Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) +This cmdlet supports retrieving the list of team mappings. + +### [Get-CsTeamsShiftsConnectionWfmTeam](Get-CsTeamsShiftsConnectionWfmTeam.md) +This cmdlet supports retrieving the list of available Workforce management (WFM) teams in the connection instance. + +### [Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) +This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. + +### [Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) +This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. + +### [Get-CsTeamsSipDevicesConfiguration](Get-CsTeamsSipDevicesConfiguration.md) +This cmdlet is used to retrieve the organization-wide Teams SIP devices configuration. + +### [Get-CsTeamsSurvivableBranchAppliance](Get-CsTeamsSurvivableBranchAppliance.md) +Gets the Survivable Branch Appliance (SBA) configured in the tenant. + +### [Get-CsTeamsSurvivableBranchAppliancePolicy](Get-CsTeamsSurvivableBranchAppliancePolicy.md) +Get the Survivable Branch Appliance (SBA) Policy defined in the tenant. + +### [Get-CsTeamsTargetingPolicy](Get-CsTeamsTargetingPolicy.md) +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. + +### [Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) +Fetches the TeamsTemplatePermissionPolicy. This policy can be used to hide Teams templates from users and groups. + +### [Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) +Cmdlet to get an existing number manipulation rule (or list of rules). + +### [Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) +Displays a specific or all treatments for how calls to an unassigned number range should be routed. + +### [Get-CsTeamsUpdateManagementPolicy](Get-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to retrieve the current Teams Update Management policies in the organization. + +### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) +Returns information related to managing the upgrade to Teams from Skype for Business. + +### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) +This cmdlet returns the set of instances of this policy. + +### [Get-CsTeamsVdiPolicy](Get-CsTeamsVdiPolicy.md) +The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. + +### [Get-CsTeamsVideoInteropServicePolicy](Get-CsTeamsVideoInteropServicePolicy.md) +The Get-CsTeamsVideoInteropServicePolicy cmdlet allows you to identify the pre-constructed policies that you can use in your organization. + +### [Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to fetch policy instances of TeamsVirtualAppointmentsPolicy. + +### [Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) +Use the Get-CsTeamsVoiceApplicationsPolicy cmdlet to get Teams voice applications policy information. + +### [Get-CsTeamsWorkLoadPolicy](Get-CsTeamsWorkLoadPolicy.md) +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +### [Get-CsTeamsWorkLocationDetectionPolicy](Get-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to fetch policy instances of TeamsWorkLocationDetectionPolicy. + +### [Get-CsTeamTemplate](Get-CsTeamTemplate.md) +This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + +### [Get-CsTeamTemplateList](Get-CsTeamTemplateList.md) +Get a list of available team templates + +### [Get-CsTenant](Get-CsTenant.md) +Returns information about the Microsoft Teams or Skype for Business Online tenants that have been configured for use in your organization. + +### [Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) +Use the Get-CsTenantBlockedCallingNumbers cmdlet to retrieve tenant blocked calling numbers setting. + +### [Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) +Use the Get-CsTenantDialPlan cmdlet to retrieve a tenant dial plan. + +### [Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) +Returns information about the federation configuration settings for your Skype for Business Online tenants. + +### [Get-CsTenantLicensingConfiguration](Get-CsTenantLicensingConfiguration.md) +Indicates whether licensing information for the specified tenant is available in the Teams admin center. + +### [Get-CsTenantMigrationConfiguration](Get-CsTenantMigrationConfiguration.md) +Use the Get-CsTenantMigrationConfiguration cmdlet to check if Meeting Migration Service (MMS) is enabled in your organization. + +### [Get-CsTenantNetworkConfiguration](Get-CsTenantNetworkConfiguration.md) +Returns information about the network regions, sites and subnets in the tenant network configuration. + +### [Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) +Returns information about the network region setting in the tenant. + +### [Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) +Returns information about the network site setting in the tenant. + +### [Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) +Returns information about the network subnet setting in the tenant. + +### [Get-CsTenantTrustedIPAddress](Get-CsTenantTrustedIPAddress.md) +Returns information about the external trusted IPs in the tenant. + +### [Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) +This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. + +### [Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md) +This cmdlet is used to return the policy assignments for a user, both directly assigned and inherited from a group. + +### [Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) +This cmdlet supports retrieving the policy package that's assigned to a user. + +### [Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) +This cmdlet supports retrieving recommendations for which policy packages are best suited for a given user. + +### [Get-CsVideoInteropServiceProvider](Get-CsVideoInteropServiceProvider.md) +Get information about the Cloud Video Interop for Teams. + +### [Get-M365TeamsApp](Get-M365TeamsApp.md) +This cmdlet returns app availability and state for the Microsoft Teams app. + +### [Get-M365UnifiedCustomPendingApps](Get-M365UnifiedCustomPendingApps.md) +This cmdlet returns all custom Microsoft Teams apps that are pending review from an IT Admin. + +### [Get-M365UnifiedTenantSettings](Get-M365UnifiedTenantSettings.md) +This cmdlet returns the current tenant settings for a particular tenant + +### [Get-SharedWithTeam](Get-SharedWithTeam.md) +This cmdlet supports retrieving teams with which a specified channel is shared. + +### [Get-SharedWithTeamUser](Get-SharedWithTeamUser.md) +This cmdlet supports retrieving users of a shared with team. + +### [Get-Team](Get-Team.md) +Get Team information based on particular properties. + +### [Get-TeamAllChannel](Get-TeamAllChannel.md) +This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. + +### [Get-TeamChannel](Get-TeamChannel.md) +This cmdlet supports retrieving channels hosted by a team. + +### [Get-TeamChannelUser](Get-TeamChannelUser.md) +Returns users of a channel. + +### [Get-TeamIncomingChannel](Get-TeamIncomingChannel.md) +This cmdlet supports retrieving incoming channels of a team. + +### [Get-TeamsApp](Get-TeamsApp.md) +Returns app information from the Teams tenant app store. + +### [Get-TeamTargetingHierarchyStatus](Get-TeamTargetingHierarchyStatus.md) +Get the status of a hierarchy upload. + +### [Get-TeamUser](Get-TeamUser.md) +Returns users of a team. + +### [Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) +Assigns a per-user application access policy to one or more users. + +### [Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) +Use the `Grant-CsCallingLineIdentity` cmdlet to apply a Caller ID policy to a user account, to a group of users, or to set the tenant Global instance. + +### [Grant-CsDialoutPolicy](Grant-CsDialoutPolicy.md) +Use the `Grant-CsDialoutPolicy` cmdlet to assign the tenant global, a group of users, or a per-user outbound calling restriction policy to one or more users. + +### [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) +Enables you to assign an external access policy to a user or a group of users. + +### [Grant-CsGroupPolicyPackageAssignment](Grant-CsGroupPolicyPackageAssignment.md) +This cmdlet assigns a policy package to a group in a tenant. + +### [Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant. + +### [Grant-CsOnlineVoicemailPolicy](Grant-CsOnlineVoicemailPolicy.md) +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. + +### [Grant-CsOnlineVoiceRoutingPolicy](Grant-CsOnlineVoiceRoutingPolicy.md) +Assigns a per-user online voice routing policy to one user, a group of users, or sets the Global policy instance. Online voice routing policies manage online PSTN usages for Phone System users. + +### [Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md) +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +### [Grant-CsTeamsAppPermissionPolicy](Grant-CsTeamsAppPermissionPolicy.md) +As an admin, you can use app permission policies to allow or block apps for your users. + +### [Grant-CsTeamsAppSetupPolicy](Grant-CsTeamsAppSetupPolicy.md) +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. + +### [Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) +Assigns a Teams audio-conferencing policy at the per-user scope. + +### [Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) +Assigns a per-user Teams call hold policy to one or more users. + +### [Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) +Assigns a specific Teams Calling Policy to a user, a group of users, or sets the Global policy instance. + +### [Grant-CsTeamsCallParkPolicy](Grant-CsTeamsCallParkPolicy.md) +The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. + +### [Grant-CsTeamsChannelsPolicy](Grant-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [Grant-CsTeamsComplianceRecordingPolicy](Grant-CsTeamsComplianceRecordingPolicy.md) +The Grant-CsTeamsChannelsPolicy allows you to assign specific policies to users that have been created in your tenant. + +### [Grant-CsTeamsCortanaPolicy](Grant-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) +This cmdlet assigns a Teams Emergency Calling policy. + +### [Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet assigns a Teams Emergency Call Routing policy. + +### [Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) +Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + +### [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-CsTeamsFeedbackPolicy](Grant-CsTeamsFeedbackPolicy.md) +Use this cmdlet to grant a specific Teams Feedback policy to a user (the ability to send feedback about Teams to Microsoft and whether they receive the survey). + +### [Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +### [Grant-CsTeamsIPPhonePolicy](Grant-CsTeamsIPPhonePolicy.md) +Use the Grant-CsTeamsIPPhonePolicy cmdlet to assign a set of Teams phone policies to a user account or group of user accounts. + +### [Grant-CsTeamsMediaConnectivityPolicy](Grant-CsTeamsMediaConnectivityPolicy.md) +This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant. + +### [Grant-CsTeamsMediaLoggingPolicy](Grant-CsTeamsMediaLoggingPolicy.md) +Assigns Teams Media Logging policy to a user or entire tenant. + +### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +Assigns a teams meeting branding policy at the per-user scope. + +### [Grant-CsTeamsMeetingBroadcastPolicy](Grant-CsTeamsMeetingBroadcastPolicy.md) +Use this cmdlet to assign a policy to a user. + +### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) +Assigns a teams meeting policy at the per-user scope. + +### [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) +This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to users or groups in a tenant. + +### [Grant-CsTeamsMessagingPolicy](Grant-CsTeamsMessagingPolicy.md) +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. + +### [Grant-CsTeamsMobilityPolicy](Grant-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Grant-CsTeamsPersonalAttendantPolicy](Grant-CsTeamsPersonalAttendantPolicy.md) +Assigns a specific Teams Personal Attendant Policy to a user, a group of users, or sets the Global policy instance. + +### [Grant-CsTeamsRecordingRollOutPolicy](Grant-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Grant-CsTeamsRoomVideoTeleConferencingPolicy](Grant-CsTeamsRoomVideoTeleConferencingPolicy.md) +Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. + +### [Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) +Assigns a specific Teams shared calling routing policy to a user, a group of users, or sets the Global policy instance. + +### [Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) +This cmdlet supports applying the TeamsShiftsPolicy to users in a tenant. + +### [Grant-CsTeamsSurvivableBranchAppliancePolicy](Grant-CsTeamsSurvivableBranchAppliancePolicy.md) +Grants a Survivable Branch Appliance (SBA) Policy to users in the tenant. + +### [Grant-CsTeamsUpdateManagementPolicy](Grant-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to grant a specific Teams Update Management policy to a user. + +### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. + +### [Grant-CsTeamsVdiPolicy](Grant-CsTeamsVdiPolicy.md) +Assigns a teams Vdi policy at the per-user scope. + +### [Grant-CsTeamsVideoInteropServicePolicy](Grant-CsTeamsVideoInteropServicePolicy.md) +The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. + +### [Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet applies an instance of the TeamsVirtualAppointmentsPolicy to users or groups in a tenant. + +### [Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) +Assigns a per-user Teams voice applications policy to one or more users. + +### [Grant-CsTeamsWorkLoadPolicy](Grant-CsTeamsWorkLoadPolicy.md) +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +### [Grant-CsTeamsWorkLocationDetectionPolicy](Grant-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant. + +### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) +Use the Grant-CsTenantDialPlan cmdlet to assign an existing tenant dial plan to a user, to a group of users, or to set the Global policy instance. + +### [Grant-CsUserPolicyPackage](Grant-CsUserPolicyPackage.md) +This cmdlet supports applying a policy package to users in a tenant. + +### [Import-CsAutoAttendantHolidays](Import-CsAutoAttendantHolidays.md) +Use Import-CsAutoAttendantHolidays cmdlet to import holiday schedules of an existing Auto Attendant (AA). + +### [Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) +Use the Import-CsOnlineAudioFile cmdlet to upload a new audio file. + +### [New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) +Creates a new application access policy. Application access policy contains a list of application (client) IDs. + +### [New-CsAutoAttendant](New-CsAutoAttendant.md) +Use the New-CsAutoAttendant cmdlet to create a new Auto Attendant (AA). + +### [New-CsAutoAttendantCallableEntity](New-CsAutoAttendantCallableEntity.md) +The New-CsAutoAttendantCallableEntity cmdlet lets you create a callable entity. + +### [New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) +Use the New-CsAutoAttendantCallFlow cmdlet to create a new call flow. + +### [New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md) +Use the `New-CsAutoAttendantCallHandlingAssociation` cmdlet to create a new call handling association. + +### [New-CsAutoAttendantDialScope](New-CsAutoAttendantDialScope.md) +Use New-CsAutoAttendantDialScope cmdlet to create dial-scopes for use with Auto Attendant (AA) service. + +### [New-CsAutoAttendantMenu](New-CsAutoAttendantMenu.md) +The New-CsAutoAttendantMenu cmdlet creates a new menu. + +### [New-CsAutoAttendantMenuOption](New-CsAutoAttendantMenuOption.md) +Use the New-CsAutoAttendantMenuOption cmdlet to create a new menu option. + +### [New-CsAutoAttendantPrompt](New-CsAutoAttendantPrompt.md) +Use the New-CsAutoAttendantPrompt cmdlet to create a new prompt. + +### [New-CsBatchPolicyAssignmentOperation](New-CsBatchPolicyAssignmentOperation.md) +This cmdlet is used to assign or unassign a policy to a batch of users. + +### [New-CsBatchPolicyPackageAssignmentOperation](New-CsBatchPolicyPackageAssignmentOperation.md) +This cmdlet submits an operation that applies a policy package to a batch of users in a tenant. + +### [New-CsBatchTeamsDeployment](New-CsBatchTeamsDeployment.md) +This cmdlet is used to run a batch deployment orchestration. + +### [New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) +Use the New-CsCallingLineIdentity cmdlet to create a new Caller ID policy for your organization. + +### [New-CsCallQueue](New-CsCallQueue.md) +Creates new Call Queue in your Skype for Business Online organization. + +### [New-CsCloudCallDataConnection](New-CsCloudCallDataConnection.md) +This cmdlet creates an online call data connection. + +### [New-CsComplianceRecordingForCallQueueTemplate](New-CsComplianceRecordingForCallQueueTemplate.md) +Use the New-CsComplianceRecordingForCallQueueTemplate cmdlet to create a Compliance Recording for Call Queues template. + +### [New-CsCustomPolicyPackage](New-CsCustomPolicyPackage.md) +This cmdlet creates a custom policy package. + +### [New-CsEdgeAllowAllKnownDomains](New-CsEdgeAllowAllKnownDomains.md) +Enables Skype for Business Online federation with all domains except for those domains included on the blocked domains list. + +### [New-CsEdgeAllowList](New-CsEdgeAllowList.md) +Enables administrators to specify the domains that their users will be allowed to communicate with. + +### [New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) +Used to specify a domain that will be added or removed from the set of domains enabled for federation or the set of domains disabled for federation. + +### [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) +Enables you to create a new external access policy. + +### [New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md) +This cmdlet is used to assign a policy to a security group or distribution list. + +### [New-CsHybridTelephoneNumber](New-CsHybridTelephoneNumber.md) +This cmdlet adds a hybrid telephone number to the tenant. + +### [New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) +Adds a blocked number pattern to the tenant list. + +### [New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) +This cmdlet lets you configure a new number pattern that is exempt from tenant call blocking. + +### [New-CsMainlineAttendantAppointmentBookingFlow](New-CsMainlineAttendantAppointmentBookingFlow.md) +Creates new Mainline Attendant appointment booking flows. + +### [New-CsMainlineAttendantQuestionAnswerFlow](New-CsMainlineAttendantQuestionAnswerFlow.md) +Creates new Mainline Attendant question and answer (FAQ) flows. + +### [New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) +Creates an application instance in Microsoft Entra ID. + +### [New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) +Use the New-CsOnlineApplicationInstanceAssociation cmdlet to associate either a single or multiple application instances with an application configuration, like auto attendant or call queue. + +### [New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet creates a Online Audio Conferencing Routing Policy. + +### [New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) +Use the New-CsOnlineDateTimeRange cmdlet to create a new date-time range. + +### [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md) +This cmdlet creates a request to upload Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. + +### [New-CsOnlineLisCivicAddress](New-CsOnlineLisCivicAddress.md) +Use the New-CsOnlineLisCivicAddress cmdlet to create a civic address in the Location Information Service (LIS). + +### [New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) +Use the New-CsOnlineLisLocation cmdlet to create a new emergency dispatch location within an existing civic address. + +### [New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) +Creates a new Session Border Controller (SBC) Configuration that describes the settings for the peer entity. + +### [New-CsOnlineSchedule](New-CsOnlineSchedule.md) +Use the New-CsOnlineSchedule cmdlet to create a new schedule. + +### [New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) +Use the `New-CsOnlineTelephoneNumberOrder` cmdlet to create a telephone number search order. + +### [New-CsOnlineTelephoneNumberReleaseOrder](New-CsOnlineTelephoneNumberReleaseOrder.md) +This cmdlet creates a request to release telephone numbers from Microsoft Teams telephone number management inventory. + +### [New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) +The New-CsOnlineTimeRange cmdlet creates a new time range. + +### [New-CsOnlineVoicemailPolicy](New-CsOnlineVoicemailPolicy.md) +Creates a new Online Voicemail policy. + +### [New-CsOnlineVoiceRoute](New-CsOnlineVoiceRoute.md) +Creates a new online voice route. + +### [New-CsOnlineVoiceRoutingPolicy](New-CsOnlineVoiceRoutingPolicy.md) +Creates a new online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. + +### [New-CsSdgBulkSignInRequest](New-CsSdgBulkSignInRequest.md) +Use the New-CsSdgBulkSignInRequest cmdlet to sign in a batch of up to 100 devices. + +### [New-CsSharedCallQueueHistoryTemplate](New-CsSharedCallQueueHistoryTemplate.md) +Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue History template. + +### [New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md) +This cmdlet creates a Teams AI policy. + +### [New-CsTeamsAppPermissionPolicy](New-CsTeamsAppPermissionPolicy.md) +As an admin, you can use app permission policies to allow or block apps for your users. + +### [New-CsTeamsAppSetupPolicy](New-CsTeamsAppSetupPolicy.md) +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. + +### [New-CsTeamsAudioConferencingPolicy](New-CsTeamsAudioConferencingPolicy.md) +{{Placeholder}} + +### [New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) +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. + +### [New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) +Use this cmdlet to create a new instance of a Teams Calling Policy. + +### [New-CsTeamsCallParkPolicy](New-CsTeamsCallParkPolicy.md) +The New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. + +### [New-CsTeamsChannelsPolicy](New-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [New-CsTeamsComplianceRecordingApplication](New-CsTeamsComplianceRecordingApplication.md) +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. + +### [New-CsTeamsComplianceRecordingPairedApplication](New-CsTeamsComplianceRecordingPairedApplication.md) +Creates a new association between multiple application instances of policy-based recording applications to achieve application resiliency in automatic policy-based recording scenarios. + +### [New-CsTeamsComplianceRecordingPolicy](New-CsTeamsComplianceRecordingPolicy.md) +Creates a new Teams recording policy for governing automatic policy-based recording in your tenant. + +### [New-CsTeamsCortanaPolicy](New-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +### [New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) +{{Placeholder}} + +### [New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet creates a new Teams Emergency Call Routing policy with one or more emergency number. + +### [New-CsTeamsEmergencyNumber](New-CsTeamsEmergencyNumber.md) +{{Placeholder}} + +### [New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) +Use this cmdlet to create a new Teams enhanced encryption policy. + +### [New-CsTeamsEventsPolicy](New-CsTeamsEventsPolicy.md) +This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. + +### [New-CsTeamsFeedbackPolicy](New-CsTeamsFeedbackPolicy.md) +Use this cmdlet to control whether users in your organization can send feedback about Teams to Microsoft through Give feedback and whether they receive the survey. + +### [New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) +Creates a new teams files policy. + +### [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md) +This cmdlet is used to create a `HiddenMeetingTemplate` object. + +### [New-CsTeamsHiddenTemplate](New-CsTeamsHiddenTemplate.md) +This cmdlet is used to create a `HiddenTemplate` object. + +### [New-CsTeamsIPPhonePolicy](New-CsTeamsIPPhonePolicy.md) +New-CsTeamsIPPhonePolicy allows you to create a policy to manage features related to Teams phone experiences. + +### [New-CsTeamsMediaConnectivityPolicy](New-CsTeamsMediaConnectivityPolicy.md) +This cmdlet creates a Teams media connectivity policy. + +### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [New-CsTeamsMeetingBroadcastPolicy](New-CsTeamsMeetingBroadcastPolicy.md) +Use this cmdlet to create a new policy. + +### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) +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. + +### [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) +Creates a new instance of the TeamsMeetingTemplatePermissionPolicy. + +### [New-CsTeamsMessagingPolicy](New-CsTeamsMessagingPolicy.md) +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. + +### [New-CsTeamsMobilityPolicy](New-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [New-CsTeamsNetworkRoamingPolicy](New-CsTeamsNetworkRoamingPolicy.md) +New-CsTeamsNetworkRoamingPolicy allows IT Admins to create policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [New-CsTeamsPersonalAttendantPolicy](New-CsTeamsPersonalAttendantPolicy.md) +Create a new instance of a Teams Personal Attendant Policy. + +### [New-CsTeamsRecordingRollOutPolicy](New-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [New-CsTeamsRoomVideoTeleConferencingPolicy](New-CsTeamsRoomVideoTeleConferencingPolicy.md) +Creates a new TeamsRoomVideoTeleConferencingPolicy. + +### [New-CsTeamsSharedCallingRoutingPolicy](New-CsTeamsSharedCallingRoutingPolicy.md) +Use the New-CsTeamsSharedCallingRoutingPolicy cmdlet to configure a shared calling routing policy. + +### [New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) +This cmdlet creates a new workforce management (WFM) connection. + +### [New-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.md) +This cmdlet submits an operation connecting multiple Microsoft Teams teams and Workforce management (WFM) teams. + +### [New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) +This cmdlet creates a Shifts connection instance. + +### [New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) +This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. + +### [New-CsTeamsSurvivableBranchAppliance](New-CsTeamsSurvivableBranchAppliance.md) +Creates a new Survivable Branch Appliance (SBA) object in the tenant. + +### [New-CsTeamsSurvivableBranchAppliancePolicy](New-CsTeamsSurvivableBranchAppliancePolicy.md) +Creates a new Survivable Branch Appliance (SBA) policy object in the tenant. + +### [New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) +Creates a new instance of the TeamsTemplatePermissionPolicy. + +### [New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) +Cmdlet to create a new telephone number manipulation rule. + +### [New-CsTeamsUnassignedNumberTreatment](New-CsTeamsUnassignedNumberTreatment.md) +Creates a new treatment for how calls to an unassigned number range should be routed. + +### [New-CsTeamsUpdateManagementPolicy](New-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to create Teams Update Management policy. + +### [New-CsTeamsVdiPolicy](New-CsTeamsVdiPolicy.md) +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. + +### [New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to create a new instance of the TeamsVirtualAppointmentsPolicy. + +### [New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) +Creates a new Teams voice applications policy. + +### [New-CsTeamsWorkLoadPolicy](New-CsTeamsWorkLoadPolicy.md) +This cmdlet creates a Teams Workload Policy instance for the tenant. + +### [New-CsTeamsWorkLocationDetectionPolicy](New-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to create a new instance of the TeamsWorkLocationDetectionPolicy. + +### [New-CsTeamTemplate](New-CsTeamTemplate.md) +This cmdlet lets you provision a new team template for use in Microsoft Teams. + +### [New-CsTenantDialPlan](New-CsTenantDialPlan.md) +Use the `New-CsTenantDialPlan` cmdlet to create a new tenant dial plan. + +### [New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) +Creates a new network region. + +### [New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) +Creates a new network site. + +### [New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) +Creates a new network subnet. + +### [New-CsTenantTrustedIPAddress](New-CsTenantTrustedIPAddress.md) +Creates a new IP address. + +### [New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) +This cmdlet will add a new delegate for calling in Microsoft Teams. + +### [New-CsVideoInteropServiceProvider](New-CsVideoInteropServiceProvider.md) +Use the New-CsVideoInteropServiceProvider to specify information about a supported CVI partner your organization would like to use. + +### [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) +Creates a new voice normalization rule. + +### [New-Team](New-Team.md) +This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. + +### [New-TeamChannel](New-TeamChannel.md) +Add a new channel to a team. + +### [New-TeamsApp](New-TeamsApp.md) +Creates a new app in the Teams tenant app store. + +### [Register-CsOnlineDialInConferencingServiceNumber](Register-CsOnlineDialInConferencingServiceNumber.md) +The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. + +### [Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) +Deletes an existing application access policy. + +### [Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) +Use the Remove-CsAutoAttendant cmdlet to delete an Auto Attendant (AA). + +### [Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) +Use the `Remove-CsCallingLineIdentity` cmdlet to remove a Caller ID policy from your organization. + +### [Remove-CsCallQueue](Remove-CsCallQueue.md) +The Remove-CsCallQueue cmdlet deletes an existing Call Queue. + +### [Remove-CsComplianceRecordingForCallQueueTemplate](Remove-CsComplianceRecordingForCallQueueTemplate.md) +Use the Remove-CsComplianceRecordingForCallQueueTemplate cmdlet to delete a Compliance Recording for Call Queues template. + +### [Remove-CsCustomPolicyPackage](Remove-CsCustomPolicyPackage.md) +This cmdlet deletes a custom policy package. + +### [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) +Enables you to remove an existing external access policy. + +### [Remove-CsGroupPolicyAssignment](Remove-CsGroupPolicyAssignment.md) +This cmdlet is used to remove a group policy assignment. + +### [Remove-CsHybridTelephoneNumber](Remove-CsHybridTelephoneNumber.md) +This cmdlet removes a hybrid telephone number. + +### [Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) +Removes a blocked number pattern from the tenant list. + +### [Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) +Removes a number pattern exempt from call blocking. + +### [Remove-CsMainlineAttendantAppointmentBookingFlow](Remove-CsMainlineAttendantAppointmentBookingFlow.md) +Removes an existing Mainline attendant appointment booking flow. + +### [Remove-CsMainlineAttendantQuestionAnswerFlow](Remove-CsMainlineAttendantQuestionAnswerFlow.md) +Removes an existing Mainline attendant question and answer flow. + +### [Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) +Use the Remove-CsOnlineApplicationInstanceAssociation cmdlet to remove the association between an application instance and the associated application configuration. + +### [Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet deletes an instance of the Online Audio Conferencing Routing Policy. + +### [Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) +Marks an audio file of application type TenantGlobal for deletion and later removal (within 24 hours). + +### [Remove-CsOnlineDialInConferencingTenantSettings](Remove-CsOnlineDialInConferencingTenantSettings.md) +Use the `Remove-CsOnlineDialInConferencingTenantSettings` cmdlet to revert the tenant level dial-in conferencing settings to their original defaults. + +### [Remove-CsOnlineLisCivicAddress](Remove-CsOnlineLisCivicAddress.md) +Use the Remove-CsOnlineLisCivicAddress cmdlet to delete an existing civic address from the Location Information Server (LIS). + +### [Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) +Use the Remove-CsOnlineLisLocation cmdlet to remove an existing emergency location from the Location Information Service (LIS). + +### [Remove-CsOnlineLisPort](Remove-CsOnlineLisPort.md) +Removes an association between a Location port and a location. This association 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. + +### [Remove-CsOnlineLisSubnet](Remove-CsOnlineLisSubnet.md) +Removes a Location Information Server (LIS) subnet. + +### [Remove-CsOnlineLisSwitch](Remove-CsOnlineLisSwitch.md) +Removes a Location Information Server (LIS) network switch. + +### [Remove-CsOnlineLisWirelessAccessPoint](Remove-CsOnlineLisWirelessAccessPoint.md) +Removes a Location Information Server (LIS) wireless access point (WAP). + +### [Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) +Removes the configuration of the previously defined Session Border Controller(s) (SBC(s)) that describes the settings for the peer entity. + +### [Remove-CsOnlineSchedule](Remove-CsOnlineSchedule.md) +Use the Remove-CsOnlineSchedule cmdlet to remove a schedule. + +### [Remove-CsOnlineTelephoneNumber](Remove-CsOnlineTelephoneNumber.md) +Use the `Remove-CsOnlineTelephoneNumber` cmdlet to remove one or more unassigned telephone numbers from your tenant. + +### [Remove-CsOnlineVoicemailPolicy](Remove-CsOnlineVoicemailPolicy.md) +Deletes an existing Online Voicemail policy or resets the Global policy instance to the default values. + +### [Remove-CsOnlineVoiceRoute](Remove-CsOnlineVoiceRoute.md) +Removes an online voice route. 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). + +### [Remove-CsOnlineVoiceRoutingPolicy](Remove-CsOnlineVoiceRoutingPolicy.md) +Deletes an existing online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. + +### [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) +This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). + +### [Remove-CsPhoneNumberTag](Remove-CsPhoneNumberTag.md) +This cmdlet allows admin to remove a tag from phone number. + +### [Remove-CsSharedCallQueueHistoryTemplate](Remove-CsSharedCallQueueHistoryTemplate.md) +```powershell Remove-CsSharedCallQueueHistoryTemplate -Id [] ``` + +### [Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md) +This cmdlet deletes a Teams AI policy. + +### [Remove-CsTeamsAppPermissionPolicy](Remove-CsTeamsAppPermissionPolicy.md) +This cmdlet allows you to remove app permission policies that have been created within your organization. + +### [Remove-CsTeamsAppSetupPolicy](Remove-CsTeamsAppSetupPolicy.md) +You can use this cmdlet to remove custom app setup policies. + +### [Remove-CsTeamsAudioConferencingPolicy](Remove-CsTeamsAudioConferencingPolicy.md) +Deletes a custom Teams audio conferencing policy. Audio conferencing policies are used to manage audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. + +### [Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) +Deletes an existing Teams call hold policy in your tenant. + +### [Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) +{{Placeholder}} + +### [Remove-CsTeamsCallParkPolicy](Remove-CsTeamsCallParkPolicy.md) +The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. + +### [Remove-CsTeamsChannelsPolicy](Remove-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [Remove-CsTeamsComplianceRecordingApplication](Remove-CsTeamsComplianceRecordingApplication.md) +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. + +### [Remove-CsTeamsComplianceRecordingPolicy](Remove-CsTeamsComplianceRecordingPolicy.md) +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. + +### [Remove-CsTeamsCortanaPolicy](Remove-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) +Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call. + +### [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet removes an existing Teams Emergency Call Routing policy instance. + +### [Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) +Use this cmdlet to remove an existing Teams enhanced encryption policy. + +### [Remove-CsTeamsEventsPolicy](Remove-CsTeamsEventsPolicy.md) +The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. + +### [Remove-CsTeamsFeedbackPolicy](Remove-CsTeamsFeedbackPolicy.md) +Use this cmdlet to remove a Teams Feedback policy from the Tenant. + +### [Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) +Deletes an existing teams files policy or resets the Global policy instance to the default values. + +### [Remove-CsTeamsIPPhonePolicy](Remove-CsTeamsIPPhonePolicy.md) +Use the Remove-CsTeamsIPPhonePolicy cmdlet to remove a custom policy that's been created for controlling Teams phone experiences. + +### [Remove-CsTeamsMediaConnectivityPolicy](Remove-CsTeamsMediaConnectivityPolicy.md) +This cmdlet deletes a Teams media connectivity policy. + +### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [Remove-CsTeamsMeetingBroadcastPolicy](Remove-CsTeamsMeetingBroadcastPolicy.md) +Deletes an existing Teams meeting broadcast policy in your tenant. + +### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) +The `CsTeamsMeetingPolicy` cmdlets removes a previously created TeamsMeetingPolicy. + +### [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) +Deletes an instance of TeamsMeetingTemplatePermissionPolicy. + +### [Remove-CsTeamsMessagingPolicy](Remove-CsTeamsMessagingPolicy.md) +Deletes a custom messaging policy. + +### [Remove-CsTeamsMobilityPolicy](Remove-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Remove-CsTeamsNetworkRoamingPolicy](Remove-CsTeamsNetworkRoamingPolicy.md) +Remove-CsTeamsNetworkRoamingPolicy allows IT Admins to delete policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [Remove-CsTeamsNotificationAndFeedsPolicy](Remove-CsTeamsNotificationAndFeedsPolicy.md) +Deletes an existing Teams Notification and Feeds Policy + +### [Remove-CsTeamsPersonalAttendantPolicy](Remove-CsTeamsPersonalAttendantPolicy.md) +Deletes an instance of a Teams Personal Attendant Policy. + +### [Remove-CsTeamsRecordingRollOutPolicy](Remove-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Remove-CsTeamsRoomVideoTeleConferencingPolicy](Remove-CsTeamsRoomVideoTeleConferencingPolicy.md) +Deletes an existing TeamsRoomVideoTeleConferencingPolicy. + +### [Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) +Deletes an existing Teams shared calling routing policy instance. + +### [Remove-CsTeamsShiftsConnection](Remove-CsTeamsShiftsConnection.md) +This cmdlet deletes a Shifts connection. + +### [Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) +This cmdlet deletes a Shifts connection instance. + +### [Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) +This cmdlet removes the mapping between the Microsoft Teams team and workforce management (WFM) team. + +### [Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) +The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. + +### [Remove-CsTeamsShiftsScheduleRecord](Remove-CsTeamsShiftsScheduleRecord.md) +This cmdlet enqueues the clear schedule message. + +### [Remove-CsTeamsSurvivableBranchAppliance](Remove-CsTeamsSurvivableBranchAppliance.md) +Removes a Survivable Branch Appliance (SBA) from the tenant. + +### [Remove-CsTeamsSurvivableBranchAppliancePolicy](Remove-CsTeamsSurvivableBranchAppliancePolicy.md) +Removes a Survivable Branch Appliance (SBA) policy from the tenant. + +### [Remove-CsTeamsTargetingPolicy](Remove-CsTeamsTargetingPolicy.md) +The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. + +### [Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) +Deletes an instance of TeamsTemplatePermissionPolicy. + +### [Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) +Cmdlet to remove an existing number manipulation rule (or list of rules). + +### [Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) +Removes a treatment for how calls to an unassigned number range should be routed. + +### [Remove-CsTeamsUpdateManagementPolicy](Remove-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to remove a Teams Update Management policy from the tenant. + +### [Remove-CsTeamsVdiPolicy](Remove-CsTeamsVdiPolicy.md) +This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. + +### [Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to delete an instance of TeamsVirtualAppointmentsPolicy. + +### [Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) +Deletes an existing Teams voice applications policy. + +### [Remove-CsTeamsWorkLoadPolicy](Remove-CsTeamsWorkLoadPolicy.md) +This cmdlet deletes a Teams Workload Policy instance. + +### [Remove-CsTeamsWorkLocationDetectionPolicy](Remove-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to delete an instance of TeamsWorkLocationDetectionPolicy. + +### [Remove-CsTeamTemplate](Remove-CsTeamTemplate.md) +This cmdlet deletes a specified Team Template from Microsoft Teams. + +### [Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) +Use the `Remove-CsTenantDialPlan` cmdlet to remove a tenant dial plan. + +### [Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) +Use the `Remove-CsTenantNetworkRegion` cmdlet to remove a tenant network region. + +### [Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) +Use the `Remove-CsTenantNetworkSite` cmdlet to remove a tenant network site. + +### [Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) +Use the `Remove-CsTenantNetworkSubnet` cmdlet to remove a tenant network subnet. + +### [Remove-CsTenantTrustedIPAddress](Remove-CsTenantTrustedIPAddress.md) +Use the `Remove-CsTenantTrustedIPAddress` cmdlet to remove a tenant trusted IP address. + +### [Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) +This cmdlet will remove a delegate for calling in Microsoft Teams. + +### [Remove-CsUserLicenseGracePeriod](Remove-CsUserLicenseGracePeriod.md) +The `CsUserLicenseGracePeriod` cmdlet expedites the delicensing operation for the assigned plan(s) of a user or resource account. + +### [Remove-CsVideoInteropServiceProvider](Remove-CsVideoInteropServiceProvider.md) +Use the Remove-CsVideoInteropServiceProvider to remove all provider information about a provider that your organization no longer uses. + +### [Remove-SharedWithTeam](Remove-SharedWithTeam.md) +This cmdlet supports unsharing a channel with a team. + +### [Remove-Team](Remove-Team.md) +This cmdlet deletes a specified Team from Microsoft Teams. NOTE: The associated Office 365 Unified Group will also be removed. + +### [Remove-TeamChannel](Remove-TeamChannel.md) +Delete a Teams channel. + +### [Remove-TeamChannelUser](Remove-TeamChannelUser.md) +Removes a user from a channel in Microsoft Teams. + +### [Remove-TeamsApp](Remove-TeamsApp.md) +Removes an app in the Teams tenant app store. + +### [Remove-TeamTargetingHierarchy](Remove-TeamTargetingHierarchy.md) +Removes the tenant's hierarchy. + +### [Remove-TeamUser](Remove-TeamUser.md) +Remove an owner or member from a team, and from the unified group which backs the team. + +### [Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) +Modifies an existing application access policy. + +### [Set-CsApplicationMeetingConfiguration](Set-CsApplicationMeetingConfiguration.md) +Modifies an existing application meeting configuration for the tenant. + +### [Set-CsAutoAttendant](Set-CsAutoAttendant.md) +Use the Set-CsAutoAttendant cmdlet to modify the properties of an existing Auto Attendant (AA). + +### [Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) +Use the `Set-CsCallingLineIdentity` cmdlet to modify a Caller ID policy in your organization. + +### [Set-CsCallQueue](Set-CsCallQueue.md) +Updates a Call Queue in your Skype for Business Online or Teams organization. + +### [Set-CsComplianceRecordingForCallQueueTemplate](Set-CsComplianceRecordingForCallQueueTemplate.md) +```powershell Set-CsComplianceRecordingForCallQueueTemplate -Instance [] ``` + +### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) +Enables you to modify the properties of an existing external access policy. + +### [Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) +Modifies one or more parameters of a blocked number pattern in the tenant list. + +### [Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) +Modifies one or more parameters of an exempt number pattern in the tenant list. + +### [Set-CsMainlineAttendantAppointmentBookingFlow](Set-CsMainlineAttendantAppointmentBookingFlow.md) +Modifies an existing Mainline Attendant appointment booking flow. + +### [Set-CsMainlineAttendantQuestionAnswerFlow](Set-CsMainlineAttendantQuestionAnswerFlow.md) +Modifies an existing Mainline Attendant question and answer (FAQ) flow. + +### [Set-CsPersonalAttendantSettings](Set-CsPersonalAttendantSettings.md) +Modifies the personal attendant settings for a user. + +### [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) +Updates an application instance in Microsoft Entra ID. + +### [Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. + +### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) +Use the `Set-CsOnlineDialInConferencingBridge` cmdlet to modify the settings of a Microsoft audio conferencing bridge. + +### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) +Use the `Set-CsOnlineDialInConferencingServiceNumber` cmdlet to modify the properties of a dial-in or audio conferencing service number that is used by callers when they dial in to a meeting. + +### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md) +Use the `Set-CsOnlineDialInConferencingTenantSettings` to modify the tenant level settings of dial-in conferencing. + +### [Set-CsOnlineDialInConferencingUser](Set-CsOnlineDialInConferencingUser.md) +Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of a user that has been enabled for Microsoft's audio conferencing service. + +### [Set-CsOnlineEnhancedEmergencyServiceDisclaimer](Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +You can use Get-CsOnlineEnhancedEmergencyServiceDisclaimer to see the status of the emergency service disclaimer. + +### [Set-CsOnlineLisCivicAddress](Set-CsOnlineLisCivicAddress.md) +Use the cmdlet to modify an existing civic address which has not been validated. + +### [Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) +Use the cmdlet to modify an existing emergency dispatch location. + +### [Set-CsOnlineLisPort](Set-CsOnlineLisPort.md) +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. + +### [Set-CsOnlineLisSubnet](Set-CsOnlineLisSubnet.md) +Creates a Location Information Server (LIS) subnet, creates an association between a subnet and a location, or modifies an existing subnet and its associated location. + +### [Set-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) +Creates a Location Information Server (LIS) switch, creates an association between a switch and a location, or modifies an existing switch and its associated location. + +### [Set-CsOnlineLisWirelessAccessPoint](Set-CsOnlineLisWirelessAccessPoint.md) +Creates a Location Information Server (LIS) wireless access point (WAP), creates an association between a WAP and a location, or modifies an existing WAP and its associated location. + +### [Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) +Modifies the previously defined Session Border Controller (SBC) Configuration that describes the settings for the peer entity. + +### [Set-CsOnlinePstnUsage](Set-CsOnlinePstnUsage.md) +Modifies a set of strings that identify the allowed online public switched telephone network (PSTN) usages. + +### [Set-CsOnlineSchedule](Set-CsOnlineSchedule.md) +Use the Set-CsOnlineSchedule cmdlet to update a schedule. + +### [Set-CsOnlineVoiceApplicationInstance](Set-CsOnlineVoiceApplicationInstance.md) +The cmdlet modifies an application instance in Microsoft Entra ID. + +### [Set-CsOnlineVoicemailPolicy](Set-CsOnlineVoicemailPolicy.md) +Modifies an existing Online Voicemail policy. + +### [Set-CsOnlineVoicemailUserSettings](Set-CsOnlineVoicemailUserSettings.md) +Use the Set-CsOnlineVoicemailUserSettings cmdlet to modify the online voicemail user settings of a specific user. + +### [Set-CsOnlineVoiceRoute](Set-CsOnlineVoiceRoute.md) +Modifies an online voice route. + +### [Set-CsOnlineVoiceRoutingPolicy](Set-CsOnlineVoiceRoutingPolicy.md) +Modifies an existing online voice routing policy. + +### [Set-CsOnlineVoiceUser](Set-CsOnlineVoiceUser.md) +Use the `Set-CsOnlineVoiceUser` cmdlet to set the PSTN specific parameters (like telephone numbers and emergency response locations.) + +### [Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) +This cmdlet will assign a phone number to a user or a resource account (online application instance). + +### [Set-CsPhoneNumberTag](Set-CsPhoneNumberTag.md) +This cmdlet allows the admin to create and assign a tag to a phone number. + +### [Set-CsSharedCallQueueHistoryTemplate](Set-CsSharedCallQueueHistoryTemplate.md) +```powershell Set-CsSharedCallQueueHistoryTemplate -Instance [] ``` + +### [Set-CsTeamsAcsFederationConfiguration](Set-CsTeamsAcsFederationConfiguration.md) +This cmdlet is used to manage the federation configuration between Teams and Azure Communication Services. + +### [Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md) +This cmdlet sets Teams AI policy value for users in the tenant. + +### [Set-CsTeamsAppPermissionPolicy](Set-CsTeamsAppPermissionPolicy.md) +Cmdlet to set the app permission policy for Teams. + +### [Set-CsTeamsAppSetupPolicy](Set-CsTeamsAppSetupPolicy.md) +Cmdlet to set the app setup policy for Teams. + +### [Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) +Audio conferencing policies can be used to manage audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. + +### [Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) +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. + +### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) +Use this cmdlet to update values in existing Teams Calling Policies. + +### [Set-CsTeamsCallParkPolicy](Set-CsTeamsCallParkPolicy.md) +The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. + +### [Set-CsTeamsChannelsPolicy](Set-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams and Channels experience within the Teams application. + +### [Set-CsTeamsClientConfiguration](Set-CsTeamsClientConfiguration.md) +Changes the Teams client configuration settings for the specified tenant. + +### [Set-CsTeamsComplianceRecordingApplication](Set-CsTeamsComplianceRecordingApplication.md) +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. + +### [Set-CsTeamsComplianceRecordingPolicy](Set-CsTeamsComplianceRecordingPolicy.md) +Modifies an existing Teams recording policy for governing automatic policy-based recording in your tenant. + +### [Set-CsTeamsCortanaPolicy](Set-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +Enables administrators to update a configured custom text on the banner displayed when compliance recording bots start recording the call. + +### [Set-CsTeamsEducationAssignmentsAppPolicy](Set-CsTeamsEducationAssignmentsAppPolicy.md) +This policy is controlled by Global and Teams Service Administrators, and is used to turn on/off certain features only related to the Assignments Service, which runs for tenants with EDU licenses. + +### [Set-CsTeamsEducationConfiguration](Set-CsTeamsEducationConfiguration.md) +This cmdlet is used to manage the organization-wide education configuration for Teams. + +### [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet modifies an existing Teams Emergency Call Routing Policy. + +### [Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +Use this cmdlet to update values in existing Teams enhanced encryption policy. + +### [Set-CsTeamsEventsPolicy](Set-CsTeamsEventsPolicy.md) +This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. + +### [Set-CsTeamsExternalAccessConfiguration](Set-CsTeamsExternalAccessConfiguration.md) +{{Placeholder}} + +### [Set-CsTeamsFeedbackPolicy](Set-CsTeamsFeedbackPolicy.md) +Use this cmdlet to modify a Teams feedback policy (the ability to send feedback about Teams to Microsoft and whether they receive the survey). + +### [Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) +Creates a new teams files policy. + +### [Set-CsTeamsGuestCallingConfiguration](Set-CsTeamsGuestCallingConfiguration.md) +Allows admins to set values in the GuestCallingConfiguration, which specifies what options guest users have for calling within Teams. + +### [Set-CsTeamsGuestMeetingConfiguration](Set-CsTeamsGuestMeetingConfiguration.md) +Designates what meeting features guests using Microsoft Teams will have available. Use this cmdlet to set the configuration. + +### [Set-CsTeamsGuestMessagingConfiguration](Set-CsTeamsGuestMessagingConfiguration.md) +TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. + +### [Set-CsTeamsIPPhonePolicy](Set-CsTeamsIPPhonePolicy.md) +Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing Teams phone policy settings. + +### [Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.md) +This cmdlet Set Teams media connectivity policy value for current tenant. + +### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [Set-CsTeamsMeetingBroadcastConfiguration](Set-CsTeamsMeetingBroadcastConfiguration.md) +Changes the Teams meeting broadcast configuration settings for the specified tenant. + +### [Set-CsTeamsMeetingBroadcastPolicy](Set-CsTeamsMeetingBroadcastPolicy.md) +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. + +### [Set-CsTeamsMeetingConfiguration](Set-CsTeamsMeetingConfiguration.md) +The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants. + +### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) +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. + +### [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) +This cmdlet updates an existing TeamsMeetingTemplatePermissionPolicy. + +### [Set-CsTeamsMessagingConfiguration](Set-CsTeamsMessagingConfiguration.md) +The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. + +### [Set-CsTeamsMessagingPolicy](Set-CsTeamsMessagingPolicy.md) +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. + +### [Set-CsTeamsMobilityPolicy](Set-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Set-CsTeamsMultiTenantOrganizationConfiguration](Set-CsTeamsMultiTenantOrganizationConfiguration.md) +This cmdlet configures the Multi-tenant Organization settings for the tenant. + +### [Set-CsTeamsPersonalAttendantPolicy](Set-CsTeamsPersonalAttendantPolicy.md) +Update an existing Teams Personal Attendant Policies. + +### [Set-CsTeamsNetworkRoamingPolicy](Set-CsTeamsNetworkRoamingPolicy.md) +Set-CsTeamsNetworkRoamingPolicy allows IT Admins to create or update policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [Set-CsTeamsNotificationAndFeedsPolicy](Set-CsTeamsNotificationAndFeedsPolicy.md) +Modifies an existing Teams Notifications and Feeds Policy + +### [Set-CsTeamsRecordingRollOutPolicy](Set-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Set-CsTeamsRoomVideoTeleConferencingPolicy](Set-CsTeamsRoomVideoTeleConferencingPolicy.md) +Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. + +### [Set-CsTeamsSettingsCustomApp](Set-CsTeamsSettingsCustomApp.md) +Set the Custom Apps Setting's value of Teams Admin Center. + +### [Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) +Use the Set-CsTeamsSharedCallingRoutingPolicy cmdlet to change a shared calling routing policy instance. + +### [Set-CsTeamsShiftsAppPolicy](Set-CsTeamsShiftsAppPolicy.md) +Allows you to set or update properties of a Teams Shifts App Policy instance. + +### [Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) +This cmdlet sets an existing workforce management (WFM) connection. + +### [Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) +This cmdlet updates a Shifts connection instance. + +### [Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. + +### [Set-CsTeamsSipDevicesConfiguration](Set-CsTeamsSipDevicesConfiguration.md) +This cmdlet is used to manage the organization-wide Teams SIP devices configuration. + +### [Set-CsTeamsSurvivableBranchAppliance](Set-CsTeamsSurvivableBranchAppliance.md) +Changes the Survivable Branch Appliance (SBA) configuration settings for the specified tenant. + +### [Set-CsTeamsSurvivableBranchAppliancePolicy](Set-CsTeamsSurvivableBranchAppliancePolicy.md) +Changes the Survivable Branch Appliance (SBA) Policy configuration settings for the specified tenant. + +### [Set-CsTeamsTargetingPolicy](Set-CsTeamsTargetingPolicy.md) +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. + +### [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) +This cmdlet updates an existing TeamsTemplatePermissionPolicy. + +### [Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) +Cmdlet to modify an existing normalization rule. + +### [Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) +Changes a treatment for how calls to an unassigned number range should be routed. + +### [Set-CsTeamsUpdateManagementPolicy](Set-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to modify a Teams Update Management policy. + +### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) +Manage certain aspects of client behavior for users being upgraded from Skype for Business to Teams. + +### [Set-CsTeamsVdiPolicy](Set-CsTeamsVdiPolicy.md) +The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. + +### [Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to update an instance of TeamsVirtualAppointmentsPolicy. + +### [Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) +Modifies an existing Teams voice applications policy. + +### [Set-CsTeamsWorkLoadPolicy](Set-CsTeamsWorkLoadPolicy.md) +This cmdlet sets the Teams Workload Policy value for current tenant. + +### [Set-CsTeamsWorkLocationDetectionPolicy](Set-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to update an instance of TeamsWorkLocationDetectionPolicy. + +### [Set-CsTenantBlockedCallingNumbers](Set-CsTenantBlockedCallingNumbers.md) +Use the Set-CsTenantBlockedCallingNumbers cmdlet to set tenant blocked calling numbers setting. + +### [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) +Use the `Set-CsTenantDialPlan` cmdlet to modify an existing tenant dial plan. + +### [Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) +Manages federation configuration settings for your Skype for Business Online tenants. + +### [Set-CsTenantMigrationConfiguration](Set-CsTenantMigrationConfiguration.md) +Used to enable or disable Meeting Migration Service (MMS). + +### [Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) +Changes the definintion of network regions. + +### [Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) +Changes the definition of network sites. + +### [Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) +Changes the definition of network subnets. + +### [Set-CsTenantTrustedIPAddress](Set-CsTenantTrustedIPAddress.md) +Changes the definition of network IP addresses. + +### [Set-CsUser](Set-CsUser.md) +Modifies Skype for Business properties for an existing user account. + +### [Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) +This cmdlet will change permissions for a delegate for calling in Microsoft Teams. + +### [Set-CsUserCallingSettings](Set-CsUserCallingSettings.md) +This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. + +### [Set-CsVideoInteropServiceProvider](Set-CsVideoInteropServiceProvider.md) +Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. + +### [Set-Team](Set-Team.md) +This cmdlet allows you to update properties of a team, including its displayname, description, and team-specific settings. + +### [Set-TeamArchivedState](Set-TeamArchivedState.md) +This cmdlet is used to freeze all of the team activity, but Teams Administrators and team owners will still be able to add or remove members and update roles. + +### [Set-TeamChannel](Set-TeamChannel.md) +Update Team channels settings. + +### [Set-TeamPicture](Set-TeamPicture.md) +Update the team picture. + +### [Set-TeamsApp](Set-TeamsApp.md) +Updates an app in the Teams tenant app store. + +### [Set-TeamsEnvironmentConfig](Set-TeamsEnvironmentConfig.md) +Sets environment-specific configurations on the local machine and is used to connect to the right environment when running Connect-MicrosoftTeams. + +### [Set-TeamTargetingHierarchy](Set-TeamTargetingHierarchy.md) +Upload a hierarchy to the tenant. + +### [Start-CsExMeetingMigration](Start-CsExMeetingMigration.md) +This cmdlet manually trigger a meeting migration request for the specified user. + +### [Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) +Sync the application instance from Microsoft Entra ID into Agent Provisioning Service. + +### [Test-CsEffectiveTenantDialPlan](Test-CsEffectiveTenantDialPlan.md) +Use the Test-CsEffectiveTenantDialPlan cmdlet to test a tenant dial plan. + +### [Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) +This cmdlet tests the given number against the created (by using New-CsInboundBlockedNumberPattern cmdlet) blocked numbers pattern. + +### [Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) +This cmdlet validates workforce management (WFM) connection settings. + +### [Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) +This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. + +### [Test-CsTeamsUnassignedNumberTreatment](Test-CsTeamsUnassignedNumberTreatment.md) +This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. + +### [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) +Tests a telephone number against a voice normalization rule and returns the number after the normalization rule has been applied. + +### [Unregister-CsOnlineDialInConferencingServiceNumber](Unregister-CsOnlineDialInConferencingServiceNumber.md) +Unassigns the previously assigned service number as default Conference Bridge number. + +### [Update-CsAutoAttendant](Update-CsAutoAttendant.md) +Use Update-CsAutoAttendant cmdlet to force an update of resources associated with an Auto Attendant (AA) provisioning. + +### [Update-CsCustomPolicyPackage](Update-CsCustomPolicyPackage.md) +**Note:** This cmdlet is currently in private preview. This cmdlet updates a custom policy package. + +### [Update-CsPhoneNumberTag](Update-CsPhoneNumberTag.md) +This cmdlet allows admin to update existing telephone number tags. + +### [Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) +This cmdlet updates an existing workforce management (WFM) connection. + +### [Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) +This cmdlet updates Shifts connection instance fields. + +### [Update-CsTeamTemplate](Update-CsTeamTemplate.md) +This cmdlet submits an operation that updates a custom team template with new team template settings. + +### [Update-M365TeamsApp](Update-M365TeamsApp.md) +This cmdlet updates app state and app available values for the Microsoft Teams app. + +### [Update-M365UnifiedCustomPendingApp](Update-M365UnifiedCustomPendingApp.md) +This cmdlet updates the review status for a custom Microsoft Teams app that is pending review from an IT Admin. + +### [Update-M365UnifiedTenantSettings](Update-M365UnifiedTenantSettings.md) +This cmdlet updates tenant settings. diff --git a/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsApplicationAccessPolicy.md similarity index 88% rename from teams/teams-ps/teams/New-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsApplicationAccessPolicy.md index 1f6d71a39b..8b6afd06f5 100644 --- a/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy applicable: Microsoft Teams -title: New-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni author: frankpeng7 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy +schema: 2.0.0 +title: New-CsApplicationAccessPolicy --- # New-CsApplicationAccessPolicy @@ -48,28 +49,28 @@ The command shown above shows how to create a new policy with a list of (three) ## PARAMETERS -### -Identity +### -AppIds -Unique identifier assigned to the policy when it was created. +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: XdsIdentity +Type: PSListModifier Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AppIds +### -Description -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). +Specifies the description of the policy. ```yaml -Type: PSListModifier +Type: String Parameter Sets: (All) Aliases: @@ -80,17 +81,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Specifies the description of the policy. +Unique identifier assigned to the policy when it was created. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -108,7 +109,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[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) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy) +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/New-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendant.md similarity index 88% rename from teams/teams-ps/teams/New-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendant.md index 98e32e7234..c066cb1110 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendant +schema: 2.0.0 +title: New-CsAutoAttendant --- # New-CsAutoAttendant @@ -18,7 +20,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 ] [-AuthorizedUsers ] [-HideAuthorizedUsers ] [-UserNameExtension ] [-Tenant ] [] +New-CsAutoAttendant -Name -LanguageId -TimeZoneId -DefaultCallFlow [-CallFlows ] [-CallHandlingAssociations ] [-Operator ] [-VoiceId ] [-EnableVoiceResponse] [-EnableMainlineAttendant] [-InclusionScope ] [-ExclusionScope ] [-AuthorizedUsers ] [-HideAuthorizedUsers ] [-UserNameExtension ] [-Tenant ] [] ``` ## DESCRIPTION @@ -32,6 +34,10 @@ You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly creat > > - -HideAuthorizedUsers > - -UserNameExtension +> +> 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. +> +> - -EnableMainLineAttendant **NOTES**: @@ -43,7 +49,7 @@ You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly creat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity $operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User @@ -80,7 +86,7 @@ This example creates a new AA named _Main auto attendant_ that has the following - The time zone is set to UTC. - An inclusion scope is specified. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity $operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User @@ -124,7 +130,7 @@ This example creates a new AA named _Main auto attendant_ that has the following - The default language is en-US. - The time zone is set to UTC. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell # Create Christmas Schedule $dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" @@ -209,9 +215,9 @@ 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](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) 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/microsoftteams/set-csautoattendant) cmdlet documentation for examples on how to do that. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell $aaName = "Main Auto Attendant" $language = "en-US" @@ -264,32 +270,36 @@ This example creates a new AA named _Main auto attendant_ that has the following ## PARAMETERS -### -Name -The Name parameter is a friendly name that is assigned to the AA. +### -AuthorizedUsers + +> Applicable: Microsoft Teams + +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: System.String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LanguageId -The LanguageId parameter is the language that is used to read text-to-speech (TTS) prompts. +### -CallFlows + +> Applicable: Microsoft Teams + +The CallFlows parameter represents call flows, which are required if they are referenced in the CallHandlingAssociations parameter. -You can query the supported languages using the [`Get-CsAutoAttendantSupportedLanguage`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage) cmdlet. +You can create CallFlows by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) cmdlet. ```yaml -Type: System.String +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -298,16 +308,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeZoneId -The TimeZoneId parameter represents the AA time zone. All schedules are evaluated based on this time zone. +### -CallHandlingAssociations + +> Applicable: Microsoft Teams + +The CallHandlingAssociations parameter represents the call handling associations. +The AA service uses call handling associations to determine which call flow to execute when a specific schedule is in effect. -You can query the supported timezones using the [`Get-CsAutoAttendantSupportedTimeZone`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone) cmdlet. +You can create CallHandlingAssociations by using the `New-CsAutoAttendantCallHandlingAssociation` cmdlet. ```yaml -Type: System.String +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -317,15 +330,17 @@ Accept wildcard characters: False ``` ### -DefaultCallFlow + +> Applicable: Microsoft Teams + 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`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. +You can create the DefaultCallFlow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) cmdlet. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -334,53 +349,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallFlows -The CallFlows parameter represents call flows, which are required if they are referenced in the CallHandlingAssociations parameter. +### -EnableMainlineAttendant + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ -You can create CallFlows by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +The EnableMainlineAttendant parameter enables Mainline Attendant features for this Auto attendant. + +> [!NOTE] +> 1. The Auto attendant must have a Resource account assigned +> 1. `-LanguageId` options are limited when Mainline Attendant is enabled +> 1. `-VoiceId` choices are limited when Mainline Attendate is enabled +> 1. `-EnableVoiceResponse` will be enabled automatically ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CallHandlingAssociations -The CallHandlingAssociations parameter represents the call handling associations. -The AA service uses call handling associations to determine which call flow to execute when a specific schedule is in effect. +### -EnableVoiceResponse -You can create CallHandlingAssociations by using the `New-CsAutoAttendantCallHandlingAssociation` cmdlet. +> Applicable: Microsoft Teams + +The EnableVoiceResponse parameter indicates whether voice response for AA is enabled. ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Operator -The Operator parameter represents the SIP address or PSTN number of the operator. +### -ExclusionScope -You can create callable entities by using the `New-CsAutoAttendantCallableEntity` cmdlet. +> Applicable: Microsoft Teams + +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`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantdialscope) cmdlet. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -389,21 +416,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceId -The VoiceId parameter represents the voice that is used to read text-to-speech (TTS) prompts. +### -HideAuthorizedUsers -You can query the supported voices by using the `Get-CsAutoAttendantSupportedLanguage` cmdlet. You can determine the default voice for a language by issuing the following command: +> Applicable: Microsoft Teams -``` -$language = Get-CsAutoAttendantSupportedLanguage -Identity "en-US" -$defaultVoice = $language.Voices[0].Id -``` +_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: System.String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -412,14 +436,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVoiceResponse -The EnableVoiceResponse parameter indicates whether voice response for AA is enabled. +### -InclusionScope + +> Applicable: Microsoft Teams + +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`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantdialscope) cmdlet. ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -428,36 +457,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InclusionScope -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. +### -LanguageId + +> Applicable: Microsoft Teams + +The LanguageId parameter is the language that is used to read text-to-speech (TTS) prompts. -Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. +You can query the supported languages using the [`Get-CsAutoAttendantSupportedLanguage`](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage) cmdlet. ```yaml -Type: Object +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExclusionScope -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. +### -Name -Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. +> Applicable: Microsoft Teams + +The Name parameter is a friendly name that is assigned to the AA. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator + +> Applicable: Microsoft Teams + +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: Microsoft Teams Required: False Position: Named @@ -466,14 +515,14 @@ 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). +### -Tenant + +> Applicable: Microsoft Teams ```yaml -Type: List +Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -482,18 +531,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HideAuthorizedUsers -_Saving an auto attendant configuration through Teams admin center will *remove* this setting._ +### -TimeZoneId -The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +> Applicable: Microsoft Teams + +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`](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone) cmdlet. ```yaml -Type: List +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -501,6 +552,9 @@ Accept wildcard characters: False ``` ### -UserNameExtension + +> Applicable: Microsoft Teams + _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. @@ -514,7 +568,6 @@ This parameter is used in dial search when multiple search results are found, as Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: false Position: Named Default value: None @@ -522,13 +575,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -VoiceId + +> Applicable: Microsoft Teams + +The VoiceId parameter represents the voice that is used to read text-to-speech (TTS) prompts. + +You can query the supported voices by using the `Get-CsAutoAttendantSupportedLanguage` cmdlet. ```yaml -Type: System.Guid +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -552,26 +610,26 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation) -[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant) -[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus) -[Get-CsAutoAttendantSupportedLanguage](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage) +[Get-CsAutoAttendantSupportedLanguage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage) -[Get-CsAutoAttendantSupportedTimeZone](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone) +[Get-CsAutoAttendantSupportedTimeZone](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone) -[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity) +[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallableentity) -[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) -[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation) +[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation) -[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) -[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant) -[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant) -[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/update-csautoattendant) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallFlow.md similarity index 65% rename from teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallFlow.md index e5d964c2c4..5edb50aea2 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallFlow.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow +schema: 2.0.0 +title: New-CsAutoAttendantCallFlow --- # New-CsAutoAttendantCallFlow @@ -24,9 +26,14 @@ 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. +> [!CAUTION] +> 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. +> +> - -RingResourceAccountDelegates + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -EnableDialByName @@ -35,7 +42,7 @@ $callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu This example creates a new call flow that renders the "Default Menu" menu. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts $menuPrompt -EnableDialByName @@ -47,16 +54,45 @@ This example creates a new call flow that plays a greeting before rendering the ## PARAMETERS -### -Name -The Name parameter represents a unique friendly name for the call flow. +### -ForceListenMenuEnabled + +> Applicable: Microsoft Teams + +If specified, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Greetings + +> Applicable: Microsoft Teams + +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`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantprompt) cmdlet. + +> [!NOTE] +> If Mainline Attendant is enabled, only TTS prompts are supported. +> +> If Mainline Attendant is enabled and no greeting text is provided, the following default prompt will be played: +> +> *Hello, and thank you for calling [Auto attendant name]. How can I assist you today? Please note that this call may be recorded for compliance purposes.* + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: (All) +Aliases: + +Required: False Position: Named Default value: None Accept pipeline input: False @@ -64,15 +100,17 @@ Accept wildcard characters: False ``` ### -Menu + +> Applicable: Microsoft Teams + 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`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu) cmdlet. +You can create a new menu by using the [`New-CsAutoAttendantMenu`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenu) cmdlet. ```yaml Type: System.Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -81,48 +119,56 @@ Accept pipeline input: False 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. +### -Name -You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) cmdlet. +> Applicable: Microsoft Teams + +The Name parameter represents a unique friendly name for the call flow. ```yaml -Type: System.Collections.Generic.List +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -RingResourceAccountDelegates + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +If enabled for this call flow, Auto Attendant will first ring the delegates assigned to the resource account the call is on. If none of the delegates answer, the call is returned to the Auto Attendant for standard processing. + +If there are no delegates assigned to the resource account the call is on then the Auto Attendant will process the call normally. ```yaml -Type: System.Guid +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ForceListenMenuEnabled +### -Tenant -If specified, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection. +> Applicable: Microsoft Teams ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -132,6 +178,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -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,6 +193,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsAutoAttendantMenu](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu) +[New-CsAutoAttendantMenu](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenu) -[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) +[Get-CsMainlineAttendantFlow](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantprompt) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation.md similarity index 87% rename from teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation.md index 0dd8a74ae2..bfb23abb50 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation +schema: 2.0.0 +title: New-CsAutoAttendantCallHandlingAssociation --- # New-CsAutoAttendantCallHandlingAssociation @@ -26,7 +28,7 @@ The `New-CsAutoAttendantCallHandlingAssociation` cmdlet creates a new call handl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $tr = New-CsOnlineTimeRange -Start 09:00 -End 17:00 $schedule = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr) -TuesdayHours @($tr) -WednesdayHours @($tr) -ThursdayHours @($tr) -FridayHours @($tr) -Complement @@ -46,7 +48,7 @@ This example creates the following: - a new after-hours call flow - a new after-hours call handling association -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $tr = New-CsOnlineTimeRange -Start 09:00 -End 17:00 $schedule = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr) -TuesdayHours @($tr) -WednesdayHours @($tr) -ThursdayHours @($tr) -FridayHours @($tr) -Complement @@ -66,7 +68,7 @@ This example creates the following: - a new after-hours call flow - a disabled after-hours call handling association -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" $schedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) @@ -90,15 +92,17 @@ This example creates the following: ## PARAMETERS ### -CallFlowId + +> Applicable: Microsoft Teams + The CallFlowId parameter represents the call flow to be associated with the schedule. -You can create a call flow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. +You can create a call flow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -107,35 +111,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScheduleId -The ScheduleId parameter represents the schedule to be associated with the call flow. +### -Disable + +> Applicable: Microsoft Teams -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. +The Disable parameter, if set, establishes that the call handling association is created as disabled. This parameter can only be used when the Type parameter is set to AfterHours. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -The Type parameter represents the type of the call handling association. Currently, only the following types are supported: +### -ScheduleId -- `AfterHours` -- `Holiday` +> Applicable: Microsoft Teams + +The ScheduleId parameter represents the schedule to be associated with the call flow. + +You can create a schedule by using the [New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) cmdlet. additionally, you can use [Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineschedule) cmdlet to get the schedules configured for your organization. ```yaml -Type: Object +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -144,14 +149,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Disable -The Disable parameter, if set, establishes that the call handling association is created as disabled. This parameter can only be used when the Type parameter is set to AfterHours. +### -Tenant + +> Applicable: Microsoft Teams + +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: SwitchParameter +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -160,24 +175,21 @@ 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" +### -Type -You can return your tenant ID by running this command: +> Applicable: Microsoft Teams -Get-CsTenant | Select-Object DisplayName, TenantID +The Type parameter represents the type of the call handling association. Currently, only the following types are supported: -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. +- `AfterHours` +- `Holiday` ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -199,8 +211,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) -[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) -[Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule) +[Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineschedule) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallableEntity.md similarity index 87% rename from teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallableEntity.md index c543fbf782..2a38fa9e72 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallableEntity.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallableentity +schema: 2.0.0 +title: New-CsAutoAttendantCallableEntity --- # New-CsAutoAttendantCallableEntity @@ -74,57 +76,65 @@ This example gets an Office 365 group by name using Find-CsGroup cmdlet. Then th ## PARAMETERS -### -Identity -The Identity parameter represents the ID of the callable entity; this can be either a Object ID or a TEL URI. +### -CallPriority -- Only the Object IDs of users that have Enterprise Voice enabled are supported. -- Only PSTN numbers that are acquired and assigned through Skype for Business Online are supported. +> Applicable: Microsoft Teams + +_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: System.String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: 3 Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -The Type parameter represents the type of the callable entity, which can be any of the following: +### -EnableSharedVoicemailSystemPromptSuppression -- User -- ApplicationEndpoint (when transferring to a Resource Account) -- ConfigurationEndpoint (when transferring directly to a nested Auto Attendant or Call Queue) -- ExternalPstn -- SharedVoicemail +> Applicable: Microsoft Teams -> [!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. +Suppresses the "Please leave a message after the tone" system prompt when transferring to shared voicemail. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -EnableTranscription + +> Applicable: Microsoft Teams + +Enables the email transcription of voicemail, this is only supported with shared voicemail callable entities. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -133,30 +143,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTranscription -Enables the email transcription of voicemail, this is only supported with shared voicemail callable entities. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter represents the ID of the callable entity; this can be either a Object ID or a TEL URI. + +- Only the Object IDs of users that have Enterprise Voice enabled are supported. +- Only PSTN numbers that are acquired and assigned through Skype for Business Online are supported. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSharedVoicemailSystemPromptSuppression -Suppresses the "Please leave a message after the tone" system prompt when transferring to shared voicemail. +### -Tenant + +> Applicable: Microsoft Teams ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -165,26 +180,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallPriority --- Private Preview customers only -The Call Priority of the MenuOption, only applies when the `Type` is `ApplicationEndpoint`. +### -Type -PARAMVALUE: 1 | 2 | 3 | 4 | 5 +> Applicable: Microsoft Teams -1 = Very High -2 = High -3 = Normal / Default -4 = Low -5 = Very Low +The Type parameter represents the type of the callable entity, which can be any of the following: + +- User +- 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: Int16 +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -204,6 +222,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineuser) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantDialScope.md similarity index 87% rename from teams/teams-ps/teams/New-CsAutoAttendantDialScope.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantDialScope.md index acea07c42e..8c2faba8f3 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantDialScope.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantdialscope +schema: 2.0.0 +title: New-CsAutoAttendantDialScope --- # New-CsAutoAttendantDialScope @@ -28,7 +30,7 @@ This cmdlet creates a new dial-scope to be used with Auto Attendant (AA) service ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $groupIds = @("00000000-0000-0000-0000-000000000000") $dialScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $groupIds @@ -36,7 +38,7 @@ $dialScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $groupIds In Example 1, the New-CsAutoAttendantDialScope cmdlet is used to create a dial-scope with a group whose id is 00000000-0000-0000-0000-000000000000. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $groupIds = Find-CsGroup -SearchQuery "Contoso Sales" | % { $_.Id } $dialScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $groupIds @@ -46,14 +48,18 @@ In Example 2, we use the Find-CsGroup cmdlet to find groups with name "Contoso S ## PARAMETERS -### -GroupScope -Indicates that a dial-scope based on groups (distribution lists, security groups) is to be created. +### -GroupIds + +> Applicable: Microsoft Teams + +Refers to the IDs of the groups that are to be included in the dial-scope. + +Group IDs can be obtained by using the Find-CsGroup cmdlet. ```yaml -Type: SwitchParameter +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -62,16 +68,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GroupIds -Refers to the IDs of the groups that are to be included in the dial-scope. +### -GroupScope -Group IDs can be obtained by using the Find-CsGroup cmdlet. +> Applicable: Microsoft Teams + +Indicates that a dial-scope based on groups (distribution lists, security groups) is to be created. ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -82,11 +88,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -110,4 +117,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Find-CsGroup](https://learn.microsoft.com/powershell/module/teams/find-csgroup) +[Find-CsGroup](https://learn.microsoft.com/powershell/module/microsoftteams/find-csgroup) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenu.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenu.md similarity index 86% rename from teams/teams-ps/teams/New-CsAutoAttendantMenu.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenu.md index 762182a023..27ca0ad7c7 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantMenu.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenu.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenu +schema: 2.0.0 +title: New-CsAutoAttendantMenu --- # New-CsAutoAttendantMenu @@ -26,7 +28,7 @@ The New-CsAutoAttendantMenu cmdlet creates a new menu for the Auto Attendant (AA ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -EnableDialByName -DirectorySearchMethod ByExtension @@ -34,7 +36,7 @@ $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -En This example creates a new menu that allows the caller to reach a target by name, and also defines the Directory Search Method to Dial By Extension. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $menuOptionZero = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign. For operator, press zero." @@ -45,14 +47,22 @@ This example creates a new menu that allows the caller to reach a target by name ## PARAMETERS -### -Name -The Name parameter represents a friendly name for the menu. +### -DirectorySearchMethod + +> Applicable: Microsoft Teams + +The DirectorySearchMethod parameter lets you define the type of Directory Search Method for the Auto Attendant menu, for more information, see [Set up a Cloud auto attendant](https://learn.microsoft.com/MicrosoftTeams/create-a-phone-system-auto-attendant?WT.mc_id=TeamsAdminCenterCSH) + +Possible values are + +- None +- ByName +- ByExtension ```yaml -Type: System.String +Type: Microsoft.Rtc.Management.Hosted.OAA.Models.DirectorySearchMethod Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -61,16 +71,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MenuOptions -The MenuOptions parameter is a list of menu options for this menu. These menu options specify what action to take when the user sends a particular input. +### -EnableDialByName -You can create menu options by using the New-CsAutoAttendantMenuOption cmdlet. +> Applicable: Microsoft Teams + +The EnableDialByName parameter lets users do a directory search by recipient name and get transferred to the party. ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -79,16 +89,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Prompts -The Prompts parameter reflects the prompts to play when the menu is activated. +### -MenuOptions -You can create new prompts by using the New-CsAutoAttendantPrompt cmdlet. +> Applicable: Microsoft Teams + +The MenuOptions parameter is a list of menu options for this menu. These menu options specify what action to take when the user sends a particular input. + +You can create menu options by using the New-CsAutoAttendantMenuOption cmdlet. ```yaml -Type: Object +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -97,38 +109,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDialByName -The EnableDialByName parameter lets users do a directory search by recipient name and get transferred to the party. +### -Name + +> Applicable: Microsoft Teams + +The Name parameter represents a friendly name for the menu. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DirectorySearchMethod -The DirectorySearchMethod parameter lets you define the type of Directory Search Method for the Auto Attendant menu, for more information, see [Set up a Cloud auto attendant](https://learn.microsoft.com/MicrosoftTeams/create-a-phone-system-auto-attendant?WT.mc_id=TeamsAdminCenterCSH) +### -Prompts -Possible values are +> Applicable: Microsoft Teams -- None -- ByName -- ByExtension +The Prompts parameter reflects the prompts to play when the menu is activated. + +You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantprompt) cmdlet. + +> [!NOTE] +> If Mainline Attendant is enabled, only TTS prompts are supported. ```yaml -Type: Microsoft.Rtc.Management.Hosted.OAA.Models.DirectorySearchMethod +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -137,11 +152,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -165,5 +181,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsAutoAttendantMenuOption](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption) -[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption) +[New-CsAutoAttendantMenuOption](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenuoption) +[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenuoption) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md similarity index 69% rename from teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md index 075d0dccbd..aa95b63c10 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenuoption +schema: 2.0.0 +title: New-CsAutoAttendantMenuOption --- # New-CsAutoAttendantMenuOption @@ -18,22 +20,29 @@ Use the New-CsAutoAttendantMenuOption cmdlet to create a new menu option. ## SYNTAX ``` -New-CsAutoAttendantMenuOption -Action -DtmfResponse [-VoiceResponses ] [-CallTarget ] [-Prompt ] [-Tenant ] [] +New-CsAutoAttendantMenuOption -Action -DtmfResponse [-VoiceResponses ] [-CallTarget ] [-Prompt ] [-MainlineAttendantTarget ] [-Description ] [-Tenant ] [] ``` ## DESCRIPTION The New-CsAutoAttendantMenuOption cmdlet creates a new menu option for the Auto Attendant (AA) service. The AA service uses the menu options to respond to a caller with the appropriate action. +> [!CAUTION] +> 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. +> +> - -Description +> - -Action MainLineAttendantFlow +> - -MainlineAttendantTarget + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $menuOption = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 ``` This example creates a menu option to call the operator when the 0 key is pressed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $troubleShootObjectId = (Get-CsOnlineUser troubleShoot@contoso.com).ObjectId $troubleShootEntity = New-CsAutoAttendantCallableEntity -Identity $troubleShootObjectId -Type ApplicationEndpoint @@ -42,7 +51,7 @@ $menuOption = New-CsAutoAttendantMenuOption -Action TransferCallToTarget -DtmfRe This example creates a menu option to transfer the call to an application endpoint when the caller speaks the word "Sales" or presses the 1 key. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $Prompt = New-CsAutoAttendantPrompt -ActiveType TextToSpeech -TextToSpeechPrompt "Our Office is open from Monday to Friday from 9 AM to 5 PM" $menuOption = New-CsAutoAttendantMenuOption -Action Announcement -DtmfResponse Tone2 -VoiceResponses "Hours" -Prompt $Prompt @@ -52,7 +61,11 @@ This example creates a menu option to play an announcement for the defined promp ## PARAMETERS + ### -Action + +> Applicable: Microsoft Teams + The Action parameter represents the action to be taken when the menu option is activated. The Action must be set to one of the following values: - Announcement - plays a defined prompt then returns to the menu @@ -64,7 +77,6 @@ The Action parameter represents the action to be taken when the menu option is a Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -73,37 +85,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DtmfResponse -The DtmfResponse parameter indicates the key on the telephone keypad to be pressed to activate the menu option. The DtmfResponse must be set to one of the following values: +### -CallTarget -- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. -- ToneStar - Corresponds to DTMF tone *. -- TonePound - Corresponds to DTMF tone #. -- Automatic - The action is executed without user response. +> Applicable: Microsoft Teams + +The CallTarget parameter represents the target for call transfer after the menu option is selected. + +CallTarget is required if the action of the menu option is TransferCallToTarget. + +Use the New-CsAutoAttendantCallableEntity cmdlet to create new callable entities. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceResponses -The VoiceResponses parameter represents the voice responses to select a menu option when Voice Responses are enabled for the auto attendant. +### -Description -Voice responses are currently limited to one voice response per menu option. +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +A description/set of keywords for the option. + +Used by Mainline Attendant only. + +Limit: 500 characters ```yaml -Type: System.Collections.Generic.List +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -112,20 +133,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallTarget -The CallTarget parameter represents the target for call transfer after the menu option is selected. +### -DtmfResponse -CallTarget is required if the action of the menu option is TransferCallToTarget. +> Applicable: Microsoft Teams -Use the New-CsAutoAttendantCallableEntity cmdlet to create new callable entities. +The DtmfResponse parameter indicates the key on the telephone keypad to be pressed to activate the menu option. The DtmfResponse 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 #. +- Automatic - The action is executed without user response. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MainlineAttendantTarget + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +The Mainline Attendant call flow target identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True if -Action = MainlineAttendantFlow Position: Named Default value: None Accept pipeline input: False @@ -133,6 +179,9 @@ Accept wildcard characters: False ``` ### -Prompt + +> Applicable: Microsoft Teams + The **Prompt** parameter reflects the prompts to play when the menu option is activated. You can create new prompts by using the **New-CsAutoAttendantPrompt** cmdlet. @@ -143,7 +192,6 @@ This parameter is required if the **Action** is set to **Announcement**. Type: Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -154,11 +202,32 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceResponses + +> Applicable: Microsoft Teams + +The VoiceResponses parameter represents the voice responses to select a menu option when Voice Responses are enabled for the auto attendant. + +Voice responses are currently limited to one voice response per menu option. + +```yaml +Type: System.Collections.Generic.List +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -182,4 +251,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity) +[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallableentity) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantPrompt.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantPrompt.md similarity index 90% rename from teams/teams-ps/teams/New-CsAutoAttendantPrompt.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantPrompt.md index 9a601bd5d8..2b528539cd 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantPrompt.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantPrompt.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt applicable: Microsoft Teams -title: New-CsAutoAttendantPrompt -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantprompt +schema: 2.0.0 +title: New-CsAutoAttendantPrompt --- # New-CsAutoAttendantPrompt @@ -37,14 +39,14 @@ The New-CsAutoAttendantPrompt cmdlet creates a new prompt for the Auto Attendant ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $ttsPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" ``` This example creates a new prompt that reads the supplied text. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content @@ -53,7 +55,7 @@ $audioFilePrompt = New-CsAutoAttendantPrompt -AudioFilePrompt $audioFile This example creates a new prompt that plays the selected audio file. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content @@ -65,6 +67,9 @@ This example creates a new prompt that has both audio file and text-to-speech da ## PARAMETERS ### -ActiveType + +> Applicable: Microsoft Teams + PARAMVALUE: None | TextToSpeech | AudioFile The ActiveType parameter identifies the active type (modality) of the AA prompt. It can be set to None (the prompt is disabled), TextToSpeech (text-to-speech is played when the prompt is rendered) or AudioFile (audio file data is played when the prompt is rendered). @@ -75,7 +80,6 @@ This is explicitly required if both Audio File and TTS prompts are specified. Ot Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -AudioFilePrompt + +> Applicable: Microsoft Teams + The AudioFilePrompt parameter represents the audio to play when the prompt is activated (rendered). This parameter is required when audio file prompts are being created. You can create audio files by using the `Import-CsOnlineAudioFile` cmdlet. @@ -93,7 +100,6 @@ This parameter is required when audio file prompts are being created. You can cr Type: Object Parameter Sets: AudioFile, Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -102,16 +108,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextToSpeechPrompt -The TextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt that is to be read when the prompt is activated. +### -Tenant -This parameter is required when text to speech prompts are being created. +> Applicable: Microsoft Teams ```yaml -Type: System.String -Parameter Sets: TextToSpeech, Dual +Type: System.Guid +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -120,13 +124,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -TextToSpeechPrompt + +> Applicable: Microsoft Teams + +The TextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt that is to be read when the prompt is activated. + +This parameter is required when text to speech prompts are being created. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: System.String +Parameter Sets: TextToSpeech, Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -150,4 +159,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyAssignmentOperation.md similarity index 97% rename from teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md rename to teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyAssignmentOperation.md index e710dfbc0a..fe8d43ed6f 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyAssignmentOperation.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchpolicyassignmentoperation +schema: 2.0.0 +title: New-CsBatchPolicyAssignmentOperation --- # New-CsBatchPolicyAssignmentOperation @@ -73,56 +74,56 @@ In this example, the batch of users is obtained by connecting to Microsoft Entra ## PARAMETERS -### -Identity -An array of users, specified either using object IDs (guid) or SIP addresses. There is a maximum of 5,000 users per batch. +### -AdditionalParameters +. ```yaml -Type: String +Type: Hashtable Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". +### -Break +Wait for .NET debugger to attach ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -The type of the policy to be assigned to the users. For the list of current policy types accepted by this parameter, see the Description section at the beginning of this article. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline ```yaml -Type: String +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OperationName -An optional name for the batch assignment operation. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline ```yaml -Type: String +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -133,60 +134,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdditionalParameters -. +### -Identity +An array of users, specified either using object IDs (guid) or SIP addresses. There is a maximum of 5,000 users per batch. ```yaml -Type: Hashtable +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach +### -OperationName +An optional name for the batch assignment operation. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -PolicyName +The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True 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 +### -PolicyType +The type of the policy to be assigned to the users. For the list of current policy types accepted by this parameter, see the Description section at the beginning of this article. ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -252,4 +253,4 @@ The ID of the operation that can be used with the Get-CsBatchPolicyAssignmentOpe ## RELATED LINKS -[Get-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation) +[Get-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csbatchpolicyassignmentoperation) diff --git a/teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyPackageAssignmentOperation.md similarity index 88% rename from teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md rename to teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyPackageAssignmentOperation.md index 7ff16c4092..bfce7fc16a 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyPackageAssignmentOperation.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: New-CsBatchPolicyPackageAssignmentOperation -author: serdarsoysal ms.author: serdars -manager: amitar -online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchpolicypackageassignmentoperation schema: 2.0.0 +title: New-CsBatchPolicyPackageAssignmentOperation --- # New-CsBatchPolicyPackageAssignmentOperation @@ -37,13 +38,14 @@ Applies the Education_PrimaryStudent policy package to three users in the tenant ### -Identity +> Applicable: Microsoft Teams + A list of one or more users in the tenant. A user identity can either be a user's object id or email address. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -53,13 +55,14 @@ Accept wildcard characters: False ### -PackageName +> Applicable: Microsoft Teams + The name of a specific policy package to apply. All policy package names can be found by running Get-CsPolicyPackage. To remove the currently assigned package, use $null or an empty string "". This will not remove any policy assignments, just the package assigned value. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -78,8 +81,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation) -[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackage) diff --git a/teams/teams-ps/teams/New-CsBatchTeamsDeployment.md b/teams/teams-ps/MicrosoftTeams/New-CsBatchTeamsDeployment.md similarity index 93% rename from teams/teams-ps/teams/New-CsBatchTeamsDeployment.md rename to teams/teams-ps/MicrosoftTeams/New-CsBatchTeamsDeployment.md index 90392de568..da1be57b71 100644 --- a/teams/teams-ps/teams/New-CsBatchTeamsDeployment.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsBatchTeamsDeployment.md @@ -1,98 +1,99 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment -title: New-CsBatchTeamsDeployment -schema: 2.0.0 ---- - -# New-CsBatchTeamsDeployment - -## SYNOPSIS - -This cmdlet is used to run a batch deployment orchestration. - -## SYNTAX - -``` -New-CsBatchTeamsDeployment -TeamsFilePath -UsersFilePath - -UsersToNotify [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Deploying Teams at scale enables admins to deploy up to 500 teams and add 25 users per team using one Teams PowerShell command and two CSV files. This allows admins to meet your organization's scale needs and significantly reduce deployment time. Admins can also use this solution to add and remove members from existing teams at scale. You can use this cmdlet to: -- Create teams using pre-built templates or your own custom templates. -- Add users to teams as owners or members. -- Manage teams at scale by adding or removing users from existing teams. -- Stay notified through email, including completion, status, and errors (if any). You can choose to notify up to five people about the status of each batch of teams you deploy. Team owners and members are automatically notified when they're added to a team. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-CsBatchTeamsDeployment -TeamsFilePath "C:\dscale\Teams.csv" -UsersFilePath "C:\dscale\Users.csv" -UsersToNotify "adminteams@contoso.com,adelev@contoso.com" -``` -This command runs a batch deployment with the provided parameters in the CSV files and emails the status and errors (if any) to adminteams@contoso.com and adelev@contoso.com. - -## PARAMETERS - -### -TeamsFilePath -The path to the CSV file that defines the teams you're creating. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsersFilePath -The path to the CSV file that maps the users you're adding to each team. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsersToNotify -The email addresses of up to five recipients to notify about this deployment. The recipients will receive email notifications about deployment status. The email contains the orchestration ID for the batch you submitted and any errors that may have occurred. - -```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 - -### OrchestrationId -The ID of the operation that can be used with the Get-CsBatchTeamsDeploymentStatus cmdlet to get the status of the operation. - -## NOTES - -## RELATED LINKS - -[Get-CsBatchTeamsDeploymentStatus](https://learn.microsoft.com/powershell/module/teams/get-csbatchteamsdeploymentstatus) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchteamsdeployment +schema: 2.0.0 +title: New-CsBatchTeamsDeployment +--- + +# New-CsBatchTeamsDeployment + +## SYNOPSIS + +This cmdlet is used to run a batch deployment orchestration. + +## SYNTAX + +``` +New-CsBatchTeamsDeployment -TeamsFilePath -UsersFilePath + -UsersToNotify [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deploying Teams at scale enables admins to deploy up to 500 teams and add 25 users per team using one Teams PowerShell command and two CSV files. This allows admins to meet your organization's scale needs and significantly reduce deployment time. Admins can also use this solution to add and remove members from existing teams at scale. You can use this cmdlet to: +- Create teams using pre-built templates or your own custom templates. +- Add users to teams as owners or members. +- Manage teams at scale by adding or removing users from existing teams. +- Stay notified through email, including completion, status, and errors (if any). You can choose to notify up to five people about the status of each batch of teams you deploy. Team owners and members are automatically notified when they're added to a team. + +## EXAMPLES + +### EXAMPLE 1 +``` +New-CsBatchTeamsDeployment -TeamsFilePath "C:\dscale\Teams.csv" -UsersFilePath "C:\dscale\Users.csv" -UsersToNotify "adminteams@contoso.com,adelev@contoso.com" +``` +This command runs a batch deployment with the provided parameters in the CSV files and emails the status and errors (if any) to adminteams@contoso.com and adelev@contoso.com. + +## PARAMETERS + +### -TeamsFilePath +The path to the CSV file that defines the teams you're creating. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersFilePath +The path to the CSV file that maps the users you're adding to each team. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersToNotify +The email addresses of up to five recipients to notify about this deployment. The recipients will receive email notifications about deployment status. The email contains the orchestration ID for the batch you submitted and any errors that may have occurred. + +```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 + +### OrchestrationId +The ID of the operation that can be used with the Get-CsBatchTeamsDeploymentStatus cmdlet to get the status of the operation. + +## NOTES + +## RELATED LINKS + +[Get-CsBatchTeamsDeploymentStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csbatchteamsdeploymentstatus) diff --git a/teams/teams-ps/teams/New-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/New-CsCallQueue.md similarity index 83% rename from teams/teams-ps/teams/New-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/New-CsCallQueue.md index dd28cd3bac..e970422246 100644 --- a/teams/teams-ps/teams/New-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCallQueue.md @@ -1,24 +1,25 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cscallqueue applicable: Microsoft Teams -title: New-CsCallQueue author: tomkau -ms.author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US manager: bulenteg -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallqueue schema: 2.0.0 +title: New-CsCallQueue --- # New-CsCallQueue ## SYNOPSIS -Creates new Call Queue in your Skype for Business Online organization. +Creates new Call Queue in your Teams organization. ## SYNTAX ``` -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 ] [-AuthorizedUsers ] [-HideAuthorizedUsers ] [-WelcomeTextToSpeechPrompt ] [-IsCallbackEnabled ] [-CallbackRequestDtmf ] [-WaitTimeBeforeOfferingCallbackInSecond ] [-NumberOfCallsInQueueBeforeOfferingCallback ] [-CallToAgentRatioThresholdBeforeOfferingCallback ] [-CallbackOfferAudioFilePromptResourceId ] [-CallbackOfferTextToSpeechPrompt [-CallbackEmailNotificationTarget ] [-ServiceLevelThresholdResponseTimeInSecond ] [-ShouldOverwriteCallableChannelProperty ] [] +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 @@ -28,14 +29,17 @@ The New-CsCallQueue cmdlet creates a new Call Queue. > The following configuration parameters are currently only available in PowerShell and do not appear in Teams admin center. Saving a call queue configuration through Teams admin center will _remove_ any of these configured items: > > - -HideAuthorizedUsers +> - -OverflowActionCallPriority > - -OverflowRedirectPersonTextToSpeechPrompt > - -OverflowRedirectPersonAudioFilePrompt > - -OverflowRedirectVoicemailTextToSpeechPrompt > - -OverflowRedirectVoicemailAudioFilePrompt +> - -TimeoutActionCallPriority > - -TimeoutRedirectPersonTextToSpeechPrompt > - -TimeoutRedirectPersonAudioFilePrompt > - -TimeoutRedirectVoicemailTextToSpeechPrompt > - -TimeoutRedirectVoicemailAudioFilePrompt +> - -NoAgentActionCallPriority > - -NoAgentRedirectPersonTextToSpeechPrompt > - -NoAgentRedirectPersonAudioFilePrompt > - -NoAgentRedirectVoicemailTextToSpeechPrompt @@ -43,11 +47,18 @@ The New-CsCallQueue cmdlet creates a new Call Queue. > > 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. > -> - -OverflowActionCallPriority -> - -TimeoutActionCallPriority -> - -NoAgentActionCallPriority +> - -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 @@ -68,30 +79,16 @@ This example creates a Call Queue for the organization named "Help Desk" with mu ## PARAMETERS -### -Name -The Name parameter specifies a unique name for the Call Queue. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -AgentAlertTime -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AgentAlertTime The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. The default value is 30 seconds. ```yaml Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -101,13 +98,15 @@ Accept wildcard characters: False ``` ### -AllowOptOut + +> Applicable: Microsoft Teams + The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -116,14 +115,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DistributionLists -The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. +### -AuthorizedUsers + +> Applicable: Microsoft Teams + +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 @@ -132,14 +133,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for Microsoft internal use only. +### -CallbackEmailNotificationTarget + +> Applicable: Microsoft Teams + +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 @@ -148,14 +151,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDefaultMusicOnHold -The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. +### -CallbackOfferAudioFilePromptResourceId + +> Applicable: Microsoft Teams + +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: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -164,14 +169,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeMusicAudioFileId -The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. +### -CallbackOfferTextToSpeechPrompt + +> Applicable: Microsoft Teams + +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: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -180,14 +187,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MusicOnHoldAudioFileId -The MusicOnHoldAudioFileId parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. +### -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: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -196,32 +209,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowAction -The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. +### -CallToAgentRatioThresholdBeforeOfferingCallback -PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail +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: Object +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: DisconnectWithBusy +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. +### -ChannelId + +> Applicable: Microsoft Teams + +Id of the channel to connect a call queue to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -230,24 +245,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionCallPriority -_Private Preview customers only_ -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -ChannelUserObjectId -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. +> Applicable: Microsoft Teams -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team the channels belongs to. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -256,48 +263,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowThreshold -The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. +### -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: Int16 +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: 50 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutAction -The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. +### -ConferenceMode -PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail +> Applicable: Microsoft Teams + +The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: + +- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. + +- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionTarget -The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. +### -CustomAudioFileAnnouncementForCR + +> Applicable: Microsoft Teams + +_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: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -306,24 +326,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionCallPriority -_Private Preview customers only_ +### -CustomAudioFileAnnouncementForCRFailure + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + _Saving a call queue configuration through Teams admin center will *remove* this setting._ -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. +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. -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionLists + +> Applicable: Microsoft Teams + +The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. ```yaml -Type: Int16 +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -332,67 +366,162 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutThreshold -The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. -The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. +### -EnableNoAgentSharedVoicemailSystemPromptSuppression + +> Applicable: Microsoft Teams + +The EnableNoAgentSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Int16 +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: 1200 +Default value: False 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. +### -EnableNoAgentSharedVoicemailTranscription -PARAMVALUE: AllCalls | NewCalls +> Applicable: Microsoft Teams + +The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False 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. +### -EnableOverflowSharedVoicemailSystemPromptSuppression -PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail +> Applicable: Microsoft Teams + +The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentActionTarget -The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a GUID or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a Microsoft 365 Group ID. Otherwise, this field is optional. +### -EnableOverflowSharedVoicemailTranscription + +> Applicable: Microsoft Teams + +The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailSystemPromptSuppression + +> Applicable: Microsoft Teams + +The EnableTimeoutSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailTranscription + +> Applicable: Microsoft Teams + +The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideAuthorizedUsers + +> Applicable: Microsoft Teams + +_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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsCallbackEnabled + +The IsCallbackEnabled parameter is used to turn on/off callback. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LanguageId + +> Applicable: Microsoft Teams + +The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter if either OverflowAction or TimeoutAction is set to SharedVoicemail. + +You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -401,9 +530,85 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LineUri + +> Applicable: Microsoft Teams + +This parameter is reserved 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 +``` + +### -MusicOnHoldAudioFileId + +> Applicable: Microsoft Teams + +The MusicOnHoldAudioFileId parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +> Applicable: Microsoft Teams + +The Name parameter specifies a unique name for the Call Queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentAction + +> Applicable: Microsoft Teams + +The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. + +PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoAgentActionCallPriority -_Private Preview customers only_ -_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +> Applicable: Microsoft Teams + +_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. @@ -414,11 +619,13 @@ PARAMVALUE: 1 | 2 | 3 | 4 | 5 - 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 @@ -427,68 +634,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RoutingMethod -The RoutingMethod parameter defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If the routing method is set to RoundRobin, the agents will be called using the Round Robin strategy so that all agents share the call load equally. If the routing method is set to LongestIdle, the agents will be called based on their idle time, that is, the agent that has been idle for the longest period will be called. +### -NoAgentActionTarget -PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle +> Applicable: Microsoft Teams + +The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a GUID or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a Microsoft 365 Group ID. Otherwise, this field is optional. ```yaml -Type: Object +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Attendant +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PresenceBasedRouting -The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. +### -NoAgentApplyTo + +> Applicable: Microsoft Teams + +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: Boolean +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: True +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -ConferenceMode -The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: +### -NoAgentDisconnectAudioFilePrompt -- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. +> Applicable: Microsoft Teams -- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. +The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. ```yaml -Type: Boolean +Type: Guid 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 ``` -### -Users -The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). +### -NoAgentDisconnectTextToSpeechPrompt + +> Applicable: Microsoft Teams + +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: List +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -497,16 +708,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LanguageId -The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter if either OverflowAction or TimeoutAction is set to SharedVoicemail. +### -NoAgentRedirectPersonAudioFilePrompt -You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. +> Applicable: Microsoft Teams + +_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: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -515,14 +728,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineUri -This parameter is reserved for Microsoft internal use only. +### -NoAgentRedirectPersonTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -531,16 +748,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OboResourceAccountIds -The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. +### -NoAgentRedirectPhoneNumberAudioFilePrompt + +> Applicable: Microsoft Teams -Only Call Queue managed by a Teams Channel will be able to use this feature. For more information, refer to [Manage your support Call Queue in Teams](https://support.microsoft.com/office/manage-your-support-call-queue-in-teams-9f07dabe-91c6-4a9b-a545-8ffdddd2504e). +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: List +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -549,14 +766,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectTextToSpeechPrompt -The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. +### -NoAgentRedirectPhoneNumberTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -565,14 +784,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectAudioFilePrompt -The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. +### -NoAgentRedirectVoiceAppAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -581,16 +802,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentRedirectVoiceAppTextToSpeechPrompt -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. +> Applicable: Microsoft Teams + +The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -599,16 +820,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonAudioFilePrompt +### -NoAgentRedirectVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + _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. +The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -617,14 +840,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppTextToSpeechPrompt -The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentRedirectVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -633,14 +860,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppAudioFilePrompt -The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentSharedVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -649,14 +878,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberTextToSpeechPrompt -The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -NoAgentSharedVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -665,14 +896,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberAudioFilePrompt -The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -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: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -681,16 +914,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OboResourceAccountIds -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. +> Applicable: Microsoft Teams + +The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -699,48 +932,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowAction -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. +> Applicable: Microsoft Teams + +The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. + +PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: DisconnectWithBusy Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailTextToSpeechPrompt -The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. +### -OverflowActionCallPriority -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ -### -OverflowSharedVoicemailAudioFilePrompt -The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. +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: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -749,46 +982,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailTranscription -The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -OverflowActionTarget + +> Applicable: Microsoft Teams + +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailSystemPromptSuppression -The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -OverflowDisconnectAudioFilePrompt + +> Applicable: Microsoft Teams + +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectTextToSpeechPrompt -The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. +### -OverflowDisconnectTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -797,14 +1036,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectAudioFilePrompt -The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. +### -OverflowRedirectPersonAudioFilePrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -813,16 +1056,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonTextToSpeechPrompt +### -OverflowRedirectPersonTextToSpeechPrompt + +> Applicable: Microsoft Teams + _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. +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -831,16 +1076,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowRedirectPhoneNumberAudioFilePrompt -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. +> Applicable: Microsoft Teams + +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -849,14 +1094,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppTextToSpeechPrompt -The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. +### -OverflowRedirectPhoneNumberTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -865,14 +1112,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppAudioFilePrompt -The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. +### -OverflowRedirectVoiceAppAudioFilePrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -881,14 +1130,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberTextToSpeechPrompt -The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowRedirectVoiceAppTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -897,14 +1148,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberAudioFilePrompt -The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowRedirectVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -913,16 +1168,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailTextToSpeechPrompt +### -OverflowRedirectVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + _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. +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -931,16 +1188,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowSharedVoicemailAudioFilePrompt -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. +> Applicable: Microsoft Teams + +The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -949,14 +1206,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailTextToSpeechPrompt -The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. +### -OverflowSharedVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -965,62 +1224,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailAudioFilePrompt -The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. +### -OverflowThreshold + +> Applicable: Microsoft Teams + +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: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: 50 Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailTranscription -The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. +### -PresenceBasedRouting + +> Applicable: Microsoft Teams + +The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailSystemPromptSuppression -The EnableTimeoutSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -RoutingMethod + +> Applicable: Microsoft Teams + +The RoutingMethod parameter defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If the routing method is set to RoundRobin, the agents will be called using the Round Robin strategy so that all agents share the call load equally. If the routing method is set to LongestIdle, the agents will be called based on their idle time, that is, the agent that has been idle for the longest period will be called. + +PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: Attendant Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectTextToSpeechPrompt -The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. +### -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: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1029,14 +1298,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectAudioFilePrompt -The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. +### -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: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1045,16 +1317,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonTextToSpeechPrompt +### -ShiftsSchedulingGroupId + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + _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. +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 @@ -1063,16 +1339,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonAudioFilePrompt +### -ShiftsTeamId + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + _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. +Id of the Team containing the Scheduling Group to connect a call queue to. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1081,30 +1361,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppTextToSpeechPrompt -The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppAudioFilePrompt -The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. +### -Tenant + +> Applicable: Microsoft Teams + +This parameter is reserved for Microsoft internal use only. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1113,14 +1395,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberTextToSpeechPrompt -The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -TextAnnouncementForCR + +> Applicable: Microsoft Teams + +_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 @@ -1129,14 +1417,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberAudioFilePrompt -The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -TextAnnouncementForCRFailure + +> Applicable: Microsoft Teams + +_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: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1145,34 +1439,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -TimeoutAction -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. +> Applicable: Microsoft Teams + +The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. + +PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -TimeoutActionCallPriority -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. +> Applicable: Microsoft Teams + +_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: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1181,14 +1489,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailTextToSpeechPrompt -The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. +### -TimeoutActionTarget + +> Applicable: Microsoft Teams + +The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1197,14 +1507,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailAudioFilePrompt -The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. +### -TimeoutDisconnectAudioFilePrompt + +> Applicable: Microsoft Teams + +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1213,46 +1525,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailTranscription -The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -TimeoutDisconnectTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailSystemPromptSuppression -The EnableNoAgentSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -TimeoutRedirectPersonAudioFilePrompt + +> Applicable: Microsoft Teams + +_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: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelId -Id of the channel to connect a call queue to. +### -TimeoutRedirectPersonTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1261,14 +1583,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelUserObjectId -Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team the channels belongs to. +### -TimeoutRedirectPhoneNumberAudioFilePrompt + +> Applicable: Microsoft Teams + +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1277,14 +1601,16 @@ 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). +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt + +> Applicable: Microsoft Teams + +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: List +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1293,16 +1619,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HideAuthorizedUsers -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -TimeoutRedirectVoiceAppAudioFilePrompt -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). +> Applicable: Microsoft Teams + +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: List +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1311,8 +1637,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeTextToSpeechPrompt -This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. +### -TimeoutRedirectVoiceAppTextToSpeechPrompt + +> Applicable: Microsoft Teams + +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 @@ -1326,12 +1655,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsCallbackEnabled +### -TimeoutRedirectVoicemailAudioFilePrompt -The IsCallbackEnabled parameter is used to turn on/off callback. +> Applicable: Microsoft Teams + +_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: Boolean +Type: Guid Parameter Sets: (All) Aliases: @@ -1342,15 +1675,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackRequestDtmf +### -TimeoutRedirectVoicemailTextToSpeechPrompt -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: +> Applicable: Microsoft Teams -- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. -- ToneStar - Corresponds to DTMF tone *. -- TonePound - Corresponds to DTMF tone #. +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. +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 @@ -1364,14 +1695,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WaitTimeBeforeOfferingCallbackInSecond +### -TimeoutSharedVoicemailAudioFilePrompt -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. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: @@ -1382,14 +1713,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberOfCallsInQueueBeforeOfferingCallback +### -TimeoutSharedVoicemailTextToSpeechPrompt -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. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: @@ -1400,11 +1731,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallToAgentRatioThresholdBeforeOfferingCallback +### -TimeoutThreshold -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. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +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 @@ -1413,20 +1745,21 @@ Aliases: Required: False Position: Named -Default value: None +Default value: 1200 Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferAudioFilePromptResourceId +### -UseDefaultMusicOnHold -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`. +> Applicable: Microsoft Teams + +The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1435,15 +1768,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferTextToSpeechPrompt +### -Users -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`. +> Applicable: Microsoft Teams + +The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1452,15 +1786,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackEmailNotificationTarget +### -WaitTimeBeforeOfferingCallbackInSecond -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`. +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: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1469,15 +1804,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceLevelThresholdResponseTimeInSecond -_Private Preview customers only_ +### -WelcomeMusicAudioFileId -The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. +> Applicable: Microsoft Teams -A value of `$null` indicates that a service level percentage will not be calculated for this call queue. +The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: @@ -1488,18 +1822,17 @@ 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. +### -WelcomeTextToSpeechPrompt +This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. ```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 ``` @@ -1517,3 +1850,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/teams/teams-ps/teams/New-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/New-CsCallingLineIdentity.md similarity index 91% rename from teams/teams-ps/teams/New-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/New-CsCallingLineIdentity.md index 93e83c74a1..902d493002 100644 --- a/teams/teams-ps/teams/New-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallinglineidentity +schema: 2.0.0 +title: New-CsCallingLineIdentity --- # New-CsCallingLineIdentity @@ -63,23 +64,10 @@ This example creates a new Caller ID policy that allows Teams users to make anon ## PARAMETERS -### -Identity -The Identity parameter identifies the Caller ID policy. +### -BlockIncomingPstnCallerID -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -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. @@ -88,7 +76,6 @@ The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN c Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -98,13 +85,15 @@ Accept wildcard characters: False ``` ### -CallingIDSubstitute + +> Applicable: Microsoft Teams + 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 Required: False Position: Named @@ -114,13 +103,33 @@ Accept wildcard characters: False ``` ### -CompanyName + +> Applicable: Microsoft Teams + This parameter sets the Calling party name (typically referred to as CNAM) on the outgoing PSTN 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 +``` + +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + The Description parameter briefly describes the Caller ID policy. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -EnableUserOverride + +> Applicable: Microsoft Teams + The EnableUserOverride parameter gives Microsoft Teams users the option under Settings and Calls to hide their phone number when making outgoing calls. The CallerID will be Anonymous. If CallingIDSubstitute is set to Anonymous, the EnableUserOverride parameter has no effect, and the caller ID is always set to Anonymous. @@ -156,7 +170,6 @@ EnableUserOverride has precedence over other settings in the policy unless subst Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -165,30 +178,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceAccount -This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter identifies the Caller ID policy. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False -Position: Named +Required: True +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. +### -ResourceAccount + +> Applicable: Microsoft Teams + +This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -197,14 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -WhatIf + +> Applicable: Microsoft Teams + +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: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -228,10 +247,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallinglineidentity) -[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cscallinglineidentity) -[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallinglineidentity) -[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallinglineidentity) diff --git a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md b/teams/teams-ps/MicrosoftTeams/New-CsCloudCallDataConnection.md similarity index 90% rename from teams/teams-ps/teams/New-CsCloudCallDataConnection.md rename to teams/teams-ps/MicrosoftTeams/New-CsCloudCallDataConnection.md index 772f8f1d49..a78d31ab05 100644 --- a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCloudCallDataConnection.md @@ -1,15 +1,15 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: New-CsCloudCallDataConnection -online version: https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection -schema: 2.0.0 author: 2012ucp1544 +external help file: MicrosoftTeams-help.xml +Locale: en-US +manager: subadjat +Module Name: MicrosoftTeams ms.author: uditagrawal ms.reviewer: pbafna -manager: subadjat - +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cscloudcalldataconnection +schema: 2.0.0 +title: New-CsCloudCallDataConnection --- # New-CsCloudCallDataConnection @@ -59,4 +59,4 @@ The New-CsCloudCallDataConnection cmdlet is only supported in commercial environ ## RELATED LINKS [Configure Call Data Connector](https://learn.microsoft.com/skypeforbusiness/hybrid/configure-call-data-connector) -[Get-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection) +[Get-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-cscloudcalldataconnection) diff --git a/teams/teams-ps/MicrosoftTeams/New-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..676809efba --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/New-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,199 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: tomkau +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: New-CsComplianceRecordingForCallQueueTemplate +--- + +# New-CsComplianceRecordingForCallQueueTemplate + +## SYNOPSIS +Use the New-CsComplianceRecordingForCallQueueTemplate cmdlet to create a Compliance Recording for Call Queues template. + +## SYNTAX + +``` +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 + +### -BotId + +> Applicable: Microsoft Teams + +The Application Instance Id of the compliance recording bot to invite. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentInvitationCount + +> Applicable: Microsoft Teams + +The number of concurrent invitations to send to the compliance recording for call queue bot. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +> Applicable: Microsoft Teams + +A description for the compliance recording for call queues template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +> Applicable: Microsoft Teams + +The name of the compliance recording for call queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PairedApplication + +> Applicable: Microsoft Teams + +The PairedApplication parameter specifies the paired application for the call queue. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeCall + +> Applicable: Microsoft Teams + +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: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringCall + +> Applicable: Microsoft Teams + +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: + +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 + +### 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/MicrosoftTeams/New-CsCustomPolicyPackage.md similarity index 86% rename from teams/teams-ps/teams/New-CsCustomPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/New-CsCustomPolicyPackage.md index bf6a5dfc6b..5510131935 100644 --- a/teams/teams-ps/teams/New-CsCustomPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCustomPolicyPackage.md @@ -1,20 +1,18 @@ --- +author: sunguchuan external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: New-CsCustomPolicyPackage -author: sunguchuan ms.author: gucsun -manager: dasosby -online version: https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cscustompolicypackage schema: 2.0.0 +title: New-CsCustomPolicyPackage --- # New-CsCustomPolicyPackage ## SYNOPSIS - -**Note:** This cmdlet is currently in private preview. - This cmdlet creates a custom policy package. ## SYNTAX @@ -27,6 +25,8 @@ New-CsCustomPolicyPackage -Identity -PolicyList [-Descriptio 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). +**Note:** This cmdlet is currently in private preview. + ## EXAMPLES ### Example 1 @@ -44,49 +44,52 @@ Creates a custom package named "MyPackage" with description "My package" and two ## PARAMETERS -### -Identity +### -Description -The name of the custom package. +> Applicable: Microsoft Teams + +The description of the custom package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True -Position: 0 +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyList +### -Identity -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). +> Applicable: Microsoft Teams + +The name of the custom package. ```yaml -Type: String[] +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -PolicyList -The description of the custom package. +> Applicable: Microsoft Teams + +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/microsoftteams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmessagingpolicy). ```yaml -Type: String +Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -103,6 +106,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage) +[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/update-cscustompolicypackage) -[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage) +[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscustompolicypackage) diff --git a/teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains.md similarity index 94% rename from teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md rename to teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains.md index 2aef1fe8ea..b5735fb638 100644 --- a/teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csedgeallowallknowndomains +schema: 2.0.0 +title: New-CsEdgeAllowAllKnownDomains --- # New-CsEdgeAllowAllKnownDomains @@ -51,7 +53,7 @@ To configure federation with all known domains, use a set of commands similar to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsEdgeAllowAllKnownDomains @@ -82,4 +84,4 @@ The New-CsEdgeAllowAllKnownDomains cmdlet creates new instances of the Microsoft ## RELATED LINKS -[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/New-CsEdgeAllowList.md b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowList.md similarity index 93% rename from teams/teams-ps/teams/New-CsEdgeAllowList.md rename to teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowList.md index 051c806683..57549a497b 100644 --- a/teams/teams-ps/teams/New-CsEdgeAllowList.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowList.md @@ -1,20 +1,21 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csedgeallowlist +schema: 2.0.0 +title: New-CsEdgeAllowList --- # New-CsEdgeAllowList ## SYNOPSIS Enables administrators to specify the domains that their users will be allowed to communicate with. -The `New-CsEdgeAllowList` cmdlet, which can be used only with Skype for Business Online, must be used in conjunction with the `New-CsEdgeDomainPattern` cmdlet and the `Set-CsTenantFederationConfiguration` cmdlet. ## SYNTAX @@ -23,6 +24,8 @@ New-CsEdgeAllowList [-AllowedDomain ] [] ``` ## DESCRIPTION +The `New-CsEdgeAllowList` cmdlet, which can be used only with Skype for Business Online, must be used in conjunction with the `New-CsEdgeDomainPattern` cmdlet and the `Set-CsTenantFederationConfiguration` cmdlet. + Federation is a service that enables users to exchange IM and presence information with users from other domains. With Skype for Business Online, administrators can use the federation configuration settings to govern: @@ -56,7 +59,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,7 +75,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" @@ -87,7 +90,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 @@ -101,6 +104,9 @@ The resulting object reference ($newAllowList) is then used in conjunction with ## PARAMETERS ### -AllowedDomain + +> Applicable: Microsoft Teams + Object reference to the new domain (or set of domains) to be added to the allowed domain list. Domain object references must be created by using the `New-CsEdgeDomainPattern` cmdlet. Multiple domain objects can be added by separating the object references using commas. @@ -112,7 +118,6 @@ For example: Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -139,6 +144,6 @@ The `New-CsEdgeAllowList` cmdlet creates new instances of the Microsoft.Rtc.Mana ## RELATED LINKS -[New-CsEdgeDomainPattern](https://learn.microsoft.com/powershell/module/teams/new-csedgedomainpattern) +[New-CsEdgeDomainPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csedgedomainpattern) -[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/New-CsEdgeDomainPattern.md b/teams/teams-ps/MicrosoftTeams/New-CsEdgeDomainPattern.md similarity index 93% rename from teams/teams-ps/teams/New-CsEdgeDomainPattern.md rename to teams/teams-ps/MicrosoftTeams/New-CsEdgeDomainPattern.md index 5bc669bc16..b4707cac30 100644 --- a/teams/teams-ps/teams/New-CsEdgeDomainPattern.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsEdgeDomainPattern.md @@ -1,21 +1,21 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csedgedomainpattern +schema: 2.0.0 +title: New-CsEdgeDomainPattern --- # New-CsEdgeDomainPattern ## SYNOPSIS Used to specify a domain that will be added or removed from the set of domains enabled for federation or the set of domains disabled for federation. -You must use the New-CsEdgeDomainPattern cmdlet when modifying the allowed or blocked domain lists. -String values (such as "fabrikam.com") cannot be directly passed to the cmdlets used to manage either of these lists. ## SYNTAX @@ -24,6 +24,9 @@ New-CsEdgeDomainPattern -Domain [] ``` ## DESCRIPTION +You must use the New-CsEdgeDomainPattern cmdlet when modifying the allowed or blocked domain lists. +String values (such as "fabrikam.com") cannot be directly passed to the cmdlets used to manage either of these lists. + Federation is a service that enables users to exchange IM and presence information with users from other domains. With Skype for Business Online, administrators can use the federation configuration settings to govern: @@ -48,7 +51,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" @@ -62,6 +65,9 @@ The second command then uses the Set-CsTenantFederationConfiguration cmdlet and ## PARAMETERS ### -Domain + +> Applicable: Microsoft Teams + Fully qualified domain name of the domain to be added to the allow list. For example: @@ -73,7 +79,6 @@ Note that you cannot use wildcards when specifying a domain name. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -100,4 +105,4 @@ The New-CsEdgeDomainPattern cmdlet creates new instances of the Microsoft.Rtc.Ma ## RELATED LINKS -[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/New-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsExternalAccessPolicy.md similarity index 81% rename from teams/teams-ps/teams/New-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsExternalAccessPolicy.md index 1d605cae3d..ba2a9e7a64 100644 --- a/teams/teams-ps/teams/New-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsExternalAccessPolicy.md @@ -1,12 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy +schema: 2.0.0 +title: New-CsExternalAccessPolicy --- # New-CsExternalAccessPolicy @@ -15,25 +17,18 @@ ms.reviewer: rogupta 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 ] + [-CommunicationWithExternalOrgs ] [-Confirm] [-Description ] [-EnableAcsFederationAccess ] [-EnableFederationAccess ] [-EnableOutsideAccess ] - [-EnablePublicCloudAccess ] [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] @@ -50,6 +45,9 @@ New-CsExternalAccessPolicy [-Identity] ## DESCRIPTION +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. 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. @@ -61,14 +59,14 @@ External access policies can grant (or revoke) the ability of your users to do a Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -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). +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/microsoftteams/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. +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/microsoftteams/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. @@ -84,7 +82,7 @@ The following parameters are not applicable to Skype for Business Online/Microso ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True -EnableOutsideAccess $True ``` @@ -92,7 +90,7 @@ New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $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 ------------------------ +### Example 2 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false @@ -100,7 +98,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederatio In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $True -EnableTeamsConsumerInbound $False ``` @@ -108,14 +106,12 @@ New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $Tr 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 -------------------------- +### EXAMPLE 4 ``` $x = New-CsExternalAccessPolicy -Identity RedmondAccessPolicy -InMemory $x.EnableFederationAccess = $True -$x.EnablePublicCloudAccess = $True - $x.EnableOutsideAccess = $True Set-CsExternalAccessPolicy -Instance $x @@ -125,54 +121,34 @@ 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. -### -------------------------- Example 5 ------------------------ +### 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. After that, we still have to enable the `CustomizeFederation` setting in the TenantFederationConfiguration to allow the federation settings as defined in the ExternalAccessPolicy to work. +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. +### -AllowedExternalDomains -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. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: +> [!NOTE] +> Please note that this parameter is in Private Preview. -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedExternalDomains -Indicates the domains that are allowed to communicate with the users of this policy. This is referenced only when `CommunicationWithExternalOrgs` is set to be `AllowSpecificExternalDomains`. +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 @@ -181,13 +157,18 @@ Accept wildcard characters: False ``` ### -BlockedExternalDomains -Indicates the domains that are blocked from communicating with the users of this policy. This is referenced only when `CommunicationWithExternalOrgs` is set to be `BlockSpecificExternalDomains`. + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +> [!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 @@ -196,19 +177,25 @@ Accept wildcard characters: False ``` ### -CommunicationWithExternalOrgs -Indicates how the users get assigned by this policy can communicate with the external orgs. There are 5 options: -- OrganizationDefault: the users of this policy will follow the federation settings defined in TenantFederationConfiguration -- AllowAllExternalDomains: the users are open to communicate with all domains -- AllowSpecificExternalDomains: the users can only communicate with the users of the domains defined in `AllowedExternalDomains` -- BlockSpecificExternalDomains: only users from the domains defined in `BlockedExternalDomains` are blocked from communicating with the users of this policy -- BlockAllExternalDomains: the users are not able to communicate with any external domains +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +> [!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 @@ -248,6 +235,9 @@ Accept wildcard characters: False ``` ### -EnableAcsFederationAccess + +> Applicable: Microsoft Teams + 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. @@ -258,7 +248,6 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -299,23 +288,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](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 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. @@ -406,6 +378,14 @@ Accept wildcard characters: False ### -FederatedBilateralChats 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) @@ -413,7 +393,7 @@ Aliases: Required: False Position: Named -Default value: True +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -433,6 +413,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -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 +``` + ### -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-\. @@ -523,10 +528,10 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Exte ## RELATED LINKS -[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) -[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/New-CsGroupPolicyAssignment.md similarity index 96% rename from teams/teams-ps/teams/New-CsGroupPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/New-CsGroupPolicyAssignment.md index efbf01984f..6ce675935e 100644 --- a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsGroupPolicyAssignment.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment +schema: 2.0.0 +title: New-CsGroupPolicyAssignment --- # New-CsGroupPolicyAssignment @@ -43,7 +44,7 @@ Once a group policy assignment is created, the policy assignment will be propaga > - 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](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment). +> - 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/microsoftteams/get-csuserpolicyassignment). > - Group policy assignment is currently not available in the Microsoft 365 DoD deployment. ## EXAMPLES @@ -99,6 +100,21 @@ e050ce51-54bc-45b7-b3e6-c00343d31274 TeamsMeetingPolicy AllOff 2 11/2/201 ## 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 +``` + ### -GroupId The ID of a batch policy assignment operation. @@ -114,17 +130,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -The type of policy to be assigned. +### -PassThru +Returns true when the command succeeds ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -144,32 +160,32 @@ 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. +### -PolicyType +The type of policy to be assigned. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns true when the command succeeds +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -190,21 +206,6 @@ Accept 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). @@ -216,8 +217,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsUserPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment) +[Get-CsUserPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicyassignment) -[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) +[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csgrouppolicyassignment) -[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/MicrosoftTeams/New-CsHybridTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/New-CsHybridTelephoneNumber.md new file mode 100644 index 0000000000..a2b32aed21 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/New-CsHybridTelephoneNumber.md @@ -0,0 +1,222 @@ +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cshybridtelephonenumber +schema: 2.0.0 +title: New-CsHybridTelephoneNumber +--- + +# New-CsHybridTelephoneNumber + +## SYNOPSIS +This cmdlet adds a hybrid telephone number to the tenant. + +## SYNTAX + +### New (Default) +``` +New-CsHybridTelephoneNumber -TelephoneNumber [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### NewViaIdentity +``` +New-CsHybridTelephoneNumber -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet adds a hybrid telephone number to the tenant that can be used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + +> [!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](New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md). + +## EXAMPLES + +### Example 1 +```powershell +New-CsHybridTelephoneNumber -TelephoneNumber +14025551234 +``` +This example adds the hybrid phone number +1 (402) 555-1234. + +## PARAMETERS + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +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: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: NewViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +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: New +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: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://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 +[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cshybridtelephonenumber) + +[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/get-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/New-CsInboundBlockedNumberPattern.md similarity index 90% rename from teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/New-CsInboundBlockedNumberPattern.md index ba2c63af2f..39ac70988a 100644 --- a/teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -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: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundblockednumberpattern schema: 2.0.0 +title: New-CsInboundBlockedNumberPattern --- # New-CsInboundBlockedNumberPattern @@ -43,6 +44,21 @@ This example adds a blocked number pattern to block inbound calls from +11234567 ## 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 A friendly description for the blocked number pattern to be created. @@ -134,21 +150,6 @@ Accept 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). @@ -164,8 +165,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundblockednumberpattern) -[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundblockednumberpattern) -[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/New-CsInboundExemptNumberPattern.md similarity index 82% rename from teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/New-CsInboundExemptNumberPattern.md index 63ed383946..1a0523d778 100644 --- a/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundexemptnumberpattern +schema: 2.0.0 +title: New-CsInboundExemptNumberPattern --- # New-CsInboundExemptNumberPattern @@ -20,7 +20,7 @@ This cmdlet lets you configure a new number pattern that is exempt from tenant c ### Identity (Default) -```powershell +``` New-CsInboundExemptNumberPattern -Identity -Pattern [-Description ] [-Enabled ] [-WhatIf] [-Confirm] [] ``` @@ -30,6 +30,8 @@ New-CsInboundExemptNumberPattern -Identity -Pattern [-Descript New-CsInboundExemptNumberPattern -Pattern -Name [-Description ] [-Enabled ] [-WhatIf] [-Confirm] [] ``` +## DESCRIPTION +The `New-CsInboundExemptNumberPattern` cmdlet creates a new inbound exempt number pattern that allows specific phone numbers to bypass tenant call blocking. This is useful for ensuring that important numbers, such as emergency services or critical business contacts, are not inadvertently blocked by the tenant's call blocking policies. ## EXAMPLES @@ -43,6 +45,22 @@ Creates a new inbound exempt number pattern for the numbers 1 (312) 555-88882 an ## 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 Sets the description of the number pattern. @@ -136,22 +154,6 @@ Accept 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). @@ -166,12 +168,12 @@ You can use Test-CsInboundBlockedNumberPattern to test your block and exempt pho ## RELATED LINKS -[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundexemptnumberpattern) -[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundexemptnumberpattern) -[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) -[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/MicrosoftTeams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/MicrosoftTeams/New-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..f07207651e --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/New-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1,129 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csmainlineattendantappointmentbookingflow +schema: 2.0.0 +title: New-CsMainlineAttendantAppointmentBookingFlow +--- + +# New-CsMainlineAttendantAppointmentBookingFlow + +## SYNOPSIS +Creates new Mainline Attendant appointment booking flow + +## SYNTAX + +``` +New-CsMainlineAttendantAppointmentBookingFlow -Name -Description -CallerAuthenticationMethod -ApiAuthenticationType -ApiDefinitions [-Tenant ] [] +``` + +## DESCRIPTION +The New-CsMainlineAttendantAppointmentBookingFlow cmdlet creates a new appointment booking connection that can be used with Mainline Attendant + +> [!CAUTION] +> This cmdlet 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. + +## EXAMPLES + + +## PARAMETERS + +### -Name +The name of the appointment booking flow + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for the appointment booking flow + +Limit: 500 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallerAuthenticationMethod +The method by which the caller is authenticated + +PARAVALUES: sms | email | verification_link | voiceprint | user_details + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiAuthenticationType +The method of authentication used by the API + +PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiDefinitions +The parameters used by the API + +```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 + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + diff --git a/teams/teams-ps/MicrosoftTeams/New-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/MicrosoftTeams/New-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..e8ae2d797b --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/New-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1,112 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csmainlineattendantquestionanswerflow +schema: 2.0.0 +title: New-CsMainlineAttendantQuestionAnswerFlow +--- + +# New-CsMainlineAttendantQuestionAnswerFlow + +## SYNOPSIS +Creates new Mainline Attendant question and answer (FAQ) flow + +## SYNTAX + +``` +New-CsMainlineAttendantQuestionAnswerFlow -Name -Description -ApiAuthenticationType -KnowledgeBase [-Tenant ] [] +``` + +## DESCRIPTION +The New-CsMainlineAttendantQuestionAnswerFlow cmdlet creates a question and answer connection that can be used with Mainline Attendant + +> [!CAUTION] +> This cmdlet 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. + +## EXAMPLES + + +## PARAMETERS + +### -Name +The name of the question and answer flow + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for the question and answer flow + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiAuthenticationType +The method of authentication used by the API + +PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KnowledgeBase +The knowledge base definition + +The parameters used by the API + +```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 + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + diff --git a/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstance.md similarity index 85% rename from teams/teams-ps/teams/New-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstance.md index 0254f15626..cb4af42e4e 100644 --- a/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance applicable: Microsoft Teams -title: New-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance +schema: 2.0.0 +title: New-CsOnlineApplicationInstance --- # New-CsOnlineApplicationInstance @@ -26,7 +27,7 @@ This cmdlet is used to create an application instance in Microsoft Entra ID. Thi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell New-CsOnlineApplicationInstance -UserPrincipalName appinstance01@contoso.com -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" ``` @@ -35,46 +36,52 @@ This example creates a new application instance for an Auto Attendant with UserP ## PARAMETERS -### -UserPrincipalName -The user principal name. It will be used as the SIP URI too. The user principal name should have an online domain. +### -ApplicationId + +> Applicable: Microsoft Teams + +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml -Type: System.String +Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Microsoft Teams + The display name. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -84,13 +91,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -99,31 +108,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -UserPrincipalName + +> Applicable: Microsoft Teams + +The user principal name. It will be used as the SIP URI too. The user principal name should have an online domain. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -143,10 +156,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstance) -[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) -[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/sync-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation.md similarity index 91% rename from teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation.md index 86240fc7e8..9488c48f99 100644 --- a/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation +schema: 2.0.0 +title: New-CsOnlineApplicationInstanceAssociation --- # New-CsOnlineApplicationInstanceAssociation @@ -28,7 +30,7 @@ You can get the Identity of the application instance from the ObjectId of the AD ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $applicationInstanceId = (Get-CsOnlineUser "main_auto_attendant@contoso.com").ObjectId # 76afc66a-5fe9-4a3d-ab7a-37c0e37b1f19 $autoAttendantId = (Get-CsAutoAttendant -NameFilter "Main Auto Attendant").Id # c2ee3e18-b738-5515-a97b-46be52dfc057 @@ -57,7 +59,7 @@ Get-CsAutoAttendant -Identity $autoAttendantId This example creates an association between an application instance that we have already created with UPN "main_auto_attendant@contoso.com" whose identity is "76afc66a-5fe9-4a3d-ab7a-37c0e37b1f19", and an auto attendant configuration that we created with display name "Main Auto Attendant" whose identity is "c2ee3e18-b738-5515-a97b-46be52dfc057". Once the association is created, the newly associated application instance would be listed under the `ApplicationInstances` property of the AA. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $applicationInstancesIdentities = (Find-CsOnlineApplicationInstance -SearchQuery "tel:+1206") | Select-Object -Property Id @@ -93,7 +95,7 @@ Get-CsAutoAttendant -Identity $autoAttendantId This example creates an association between multiple application instances that we had created before and to which we assigned phone numbers starting with "tel:+1206", and an auto attendant configuration that we created with display name "Main Auto Attendant" whose identity is "c2ee3e18-b738-5515-a97b-46be52dfc057". Once the associations are created, the newly associated application instances would listed under the `ApplicationInstances` property of the AA. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $applicationInstancesIdentities = (Find-CsOnlineApplicationInstance -SearchQuery "Main Auto Attendant") | Select-Object -Property Id @@ -112,30 +114,42 @@ This example creates an association between multiple application instances that ## PARAMETERS -### -Identities -The Identities parameter is the identities of application instances to be associated with the provided configuration ID. +### -CallPriority + +> Applicable: Microsoft Teams + +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: System.String[] +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: 3 Accept pipeline input: False Accept wildcard characters: False ``` ### -ConfigurationId + +> Applicable: Microsoft Teams + 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: Microsoft Teams Required: True Position: Named @@ -145,6 +159,9 @@ Accept wildcard characters: False ``` ### -ConfigurationType + +> Applicable: Microsoft Teams + The ConfigurationType parameter denotes the type of the configuration that would be associated with the provided application instances. It can be one of two values: @@ -156,7 +173,6 @@ It can be one of two values: Type: System.string Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -165,37 +181,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallPriority --- Private Preview customers only -The call priority assigned to calls arriving on this application instance if a priority has not already been assigned. +### -Identities -PARAMVALUE: 1 | 2 | 3 | 4 | 5 +> Applicable: Microsoft Teams -1 = Very High -2 = High -3 = Normal / Default -4 = Low -5 = Very Low +The Identities parameter is the identities of application instances to be associated with the provided configuration ID. ```yaml -Type: Int16 +Type: System.String[] Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -219,8 +230,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation) -[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus) -[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineAudioConferencingRoutingPolicy.md similarity index 92% rename from teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineAudioConferencingRoutingPolicy.md index f38c088398..d26c74dde3 100644 --- a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,177 +1,178 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: New-CsOnlineAudioConferencingRoutingPolicy +--- + +# 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/teams/teams-ps/teams/New-CsOnlineDateTimeRange.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDateTimeRange.md similarity index 90% rename from teams/teams-ps/teams/New-CsOnlineDateTimeRange.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineDateTimeRange.md index ad73e8f554..82f7121083 100644 --- a/teams/teams-ps/teams/New-CsOnlineDateTimeRange.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDateTimeRange.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedatetimerange +schema: 2.0.0 +title: New-CsOnlineDateTimeRange --- # New-CsOnlineDateTimeRange @@ -50,34 +52,38 @@ This example creates a date-time range spanning from December 24, 2017 9AM to De ## PARAMETERS -### -Start -The Start parameter represents the start bound of the date-time range. +### -End + +> Applicable: Microsoft Teams + +The End parameter represents the end bound of the date-time range. + +If not present, the end bound of the date time range is set to 00:00 of the day after the start date. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -End -The End parameter represents the end bound of the date-time range. +### -Start -If not present, the end bound of the date time range is set to 00:00 of the day after the start date. +> Applicable: Microsoft Teams + +The Start parameter represents the start bound of the date-time range. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -86,11 +92,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -114,4 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) diff --git a/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md similarity index 91% rename from teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md index b7d52913b8..680bffd86a 100644 --- a/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md @@ -1,20 +1,21 @@ --- -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 +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedirectroutingtelephonenumberuploadorder schema: 2.0.0 +title: New-CsOnlineDirectRoutingTelephoneNumberUploadOrder --- # 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. +This cmdlet creates a request to upload Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. ## SYNTAX @@ -23,7 +24,7 @@ New-CsOnlineDirectRoutingTelephoneNumberUploadOrder [-TelephoneNumber ] ``` ## 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. +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 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. 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"`. @@ -64,8 +65,8 @@ In this example, the content of a file with a list of Direct Routing telephone n ## 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. +### -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 @@ -79,11 +80,11 @@ 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. +### -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: String +Type: Byte[] Parameter Sets: (All) Aliases: @@ -94,8 +95,8 @@ 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. +### -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 @@ -109,11 +110,11 @@ 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. +### -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: Byte[] +Type: String Parameter Sets: (All) Aliases: @@ -142,4 +143,4 @@ 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 +[New-CsOnlineTelephoneNumberReleaseOrder](./new-csonlinetelephonenumberreleaseorder.md) diff --git a/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisCivicAddress.md similarity index 91% rename from teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineLisCivicAddress.md index 18fa5f7f05..678cedff32 100644 --- a/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisCivicAddress.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineliscivicaddress +schema: 2.0.0 +title: New-CsOnlineLisCivicAddress --- # New-CsOnlineLisCivicAddress @@ -75,31 +75,52 @@ This example creates a new civic address described as "West Coast Headquarters": ## PARAMETERS -### -CompanyName -Specifies the name of your organization. +### -City + +> Applicable: Microsoft Teams + +Specifies the city of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CountryOrRegion -Specifies the country or region of the new civic address. -Needs to be a valid country code as contained in the ISO 3166-1 alpha-2 specification. +### -CityAlias + +> Applicable: Microsoft Teams + +Specifies the city alias of the new civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName + +> Applicable: Microsoft Teams + +Specifies the name of your organization. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -108,14 +129,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -City -Specifies the city of the new civic address. +### -CompanyTaxId + +> Applicable: Microsoft Teams + +Specifies the company tax identifier of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -124,14 +147,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias -Specifies the city alias of the new civic address. +### -Confidence +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -140,16 +162,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CompanyTaxId -Specifies the company tax identifier of the new civic address. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryOrRegion + +> Applicable: Microsoft Teams + +Specifies the country or region of the new civic address. +Needs to be a valid country code as contained in the ISO 3166-1 alpha-2 specification. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -157,13 +200,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -173,6 +218,9 @@ Accept wildcard characters: False ``` ### -Elin + +> Applicable: Microsoft Teams + Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. @@ -180,7 +228,6 @@ This is used in Direct Routing EGW scenarios. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -190,6 +237,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -198,7 +248,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -208,13 +257,15 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Microsoft Teams + Specifies the numeric portion of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -224,6 +275,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Microsoft Teams + Specifies the 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". @@ -231,7 +285,21 @@ For example, if the property was multiplexed, the HouseNumberSuffix parameter wo 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: Required: False Position: Named @@ -241,13 +309,15 @@ Accept wildcard characters: False ``` ### -Latitude + +> Applicable: Microsoft Teams + 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 Required: True Position: Named @@ -257,13 +327,15 @@ Accept wildcard characters: False ``` ### -Longitude + +> Applicable: Microsoft Teams + 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 Required: True Position: Named @@ -273,13 +345,15 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Microsoft Teams + Specifies the postal code of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -289,6 +363,9 @@ Accept wildcard characters: False ``` ### -PostDirectional + +> Applicable: Microsoft Teams + Specifies the directional attribute of the new civic address which follows the street name. For example, "425 Smith Avenue NE". @@ -296,7 +373,6 @@ For example, "425 Smith Avenue NE". Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -306,6 +382,9 @@ Accept wildcard characters: False ``` ### -PreDirectional + +> Applicable: Microsoft Teams + Specifies the directional attribute of the new civic address which precedes the street name. For example, "425 NE Smith Avenue". @@ -313,7 +392,6 @@ For example, "425 NE Smith Avenue". Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -323,13 +401,15 @@ Accept wildcard characters: False ``` ### -StateOrProvince + +> Applicable: Microsoft Teams + Specifies the state or province of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -339,30 +419,15 @@ Accept wildcard characters: False ``` ### -StreetName -Specifies the street name of the new civic address. -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetSuffix -Specifies the street type of the new civic address. -The street suffix will typically be something like street, avenue, way, or boulevard. +Specifies the street name of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -371,23 +436,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confidence -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +### -StreetSuffix -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -IsAzureMapValidationRequired -This parameter is reserved for internal Microsoft use. +Specifies the street type of the new civic address. +The street suffix will typically be something like street, avenue, way, or boulevard. ```yaml Type: String @@ -417,6 +471,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -424,23 +481,6 @@ 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 - -Required: False -Position: Named -Default value: False -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 @@ -460,8 +500,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliscivicaddress) -[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliscivicaddress) -[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/New-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisLocation.md similarity index 89% rename from teams/teams-ps/teams/New-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineLisLocation.md index 418b3f5aa2..9ba0a8210b 100644 --- a/teams/teams-ps/teams/New-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation applicable: Microsoft Teams -title: New-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinelislocation +schema: 2.0.0 +title: New-CsOnlineLisLocation --- # New-CsOnlineLisLocation @@ -34,48 +35,56 @@ This example creates a new location called "Office 101, 1st Floor" in the civic ## PARAMETERS -### -CivicAddressId -Specifies the unique identifier of the civic address that will contain the new location. Civic address identities can be discovered by using the Get-CsOnlineLisCivicAddress cmdlet. +### -City + +> Applicable: Microsoft Teams + +Specifies the city of the civic address. + +**Note:** This parameter is not supported and is deprecated. ```yaml -Type: Guid -Parameter Sets: (All) +Type: String +Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -Location -Specifies an administrator-defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". +### -CityAlias + +> Applicable: Microsoft Teams + +Specifies the city alias. + +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -CountryOrRegion -Specifies the country or region of the civic address. +### -CivicAddressId -**Note:** This parameter is not supported and is deprecated. +> Applicable: Microsoft Teams + +Specifies the unique identifier of the civic address that will contain the new location. Civic address identities can be discovered by using the Get-CsOnlineLisCivicAddress cmdlet. ```yaml -Type: String -Parameter Sets: CreateCivicAddress -Aliases: Country -Applicable: Microsoft Teams +Type: Guid +Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -84,26 +93,31 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -City -Specifies the city of the civic address. +### -CompanyName + +> Applicable: Microsoft Teams + +Specifies the name of your organization. **Note:** This parameter is not supported and is deprecated. ```yaml Type: String -Parameter Sets: CreateCivicAddress -Aliases: -Applicable: Microsoft Teams +Parameter Sets: (All) +Aliases: Name Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias -Specifies the city alias. +### -CompanyTaxId + +> Applicable: Microsoft Teams + +The company tax ID. **Note:** This parameter is not supported and is deprecated. @@ -111,7 +125,6 @@ Specifies the city alias. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -120,16 +133,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -CompanyName -Specifies the name of your organization. +### -Confidence -**Note:** This parameter is not supported and is deprecated. +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: Name -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -138,41 +151,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CompanyTaxId -The company tax ID. +### -Confirm -**Note:** This parameter is not supported and is deprecated. +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: None -Accept pipeline input: True +Default value: False +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confidence -This parameter is reserved for internal Microsoft use. +### -CountryOrRegion + +> Applicable: Microsoft Teams + +Specifies the country or region of the civic address. + +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Parameter Sets: CreateCivicAddress +Aliases: Country -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -181,7 +201,6 @@ Specifies an administrator defined description of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -191,13 +210,33 @@ Accept wildcard characters: False ``` ### -Elin + +> Applicable: Microsoft Teams + Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. ```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 + +> Applicable: Microsoft Teams + +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 @@ -207,6 +246,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Microsoft Teams + Specifies the numeric portion of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -215,7 +257,6 @@ Specifies the numeric portion of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -225,6 +266,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Microsoft Teams + 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". @@ -234,7 +278,6 @@ For example, if the property was multiplexed, the HouseNumberSuffix parameter wo Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -244,6 +287,9 @@ Accept wildcard characters: False ``` ### -Latitude + +> Applicable: Microsoft Teams + Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. **Note:** This parameter is not supported and is deprecated. @@ -252,7 +298,6 @@ Specifies the angular distance of a place north or south of the earth's equator Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -261,7 +306,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Location + +> Applicable: Microsoft Teams + +Specifies an administrator-defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Longitude + +> Applicable: Microsoft Teams + Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. **Note:** This parameter is not supported and is deprecated. @@ -270,7 +336,6 @@ Specifies the angular distance of a place east or west of the meridian at Greenw Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -280,6 +345,9 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Microsoft Teams + Specifies the postal code of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -288,7 +356,6 @@ Specifies the postal code of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -298,6 +365,9 @@ Accept wildcard characters: False ``` ### -PostDirectional + +> Applicable: Microsoft Teams + Specifies the directional attribute of the civic address which follows the street name. For example, "425 Smith Avenue NE". **Note:** This parameter is not supported and is deprecated. @@ -306,7 +376,6 @@ Specifies the directional attribute of the civic address which follows the stree Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -316,6 +385,9 @@ Accept wildcard characters: False ``` ### -PreDirectional + +> Applicable: Microsoft Teams + Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue". **Note:** This parameter is not supported and is deprecated. @@ -324,7 +396,6 @@ Specifies the directional attribute of the civic address which precedes the stre Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -334,6 +405,9 @@ Accept wildcard characters: False ``` ### -StateOrProvince + +> Applicable: Microsoft Teams + Specifies the state or province of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -342,7 +416,6 @@ Specifies the state or province of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: State -Applicable: Microsoft Teams Required: False Position: Named @@ -352,6 +425,9 @@ Accept wildcard characters: False ``` ### -StreetName + +> Applicable: Microsoft Teams + Specifies the street name of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -360,7 +436,6 @@ Specifies the street name of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -370,6 +445,9 @@ Accept wildcard characters: False ``` ### -StreetSuffix + +> Applicable: Microsoft Teams + Specifies the modifier of the street name. The street suffix will typically be something like street, avenue, way, or boulevard. **Note:** This parameter is not supported and is deprecated. @@ -378,7 +456,6 @@ Specifies the modifier of the street name. The street suffix will typically be s Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -388,6 +465,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -395,7 +475,6 @@ 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 Required: False Position: Named @@ -404,38 +483,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: Microsoft Teams - -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: -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). @@ -447,8 +494,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelislocation) -[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelislocation) -[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelislocation) diff --git a/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlinePSTNGateway.md similarity index 82% rename from teams/teams-ps/teams/New-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlinePSTNGateway.md index 3da8fd129c..f59a9f0973 100644 --- a/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlinePSTNGateway.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinepstngateway +schema: 2.0.0 +title: New-CsOnlinePSTNGateway --- # New-CsOnlinePSTNGateway @@ -19,22 +21,60 @@ Creates a new Session Border Controller (SBC) Configuration that describes the s ### Identity (Default) ``` -New-CsOnlinePSTNGateway [-Identity] -SipSignalingPort [-BypassMode ] [-Description ] [-Enabled ] - [-FailoverResponseCodes ] [-FailoverTimeSeconds ] [-ForwardCallHistory ] [-ForwardPai ] [-GatewayLbrEnabledUserOverride ] - [-GatewaySiteId ] [-GatewaySiteLbrEnabled ] [-InboundPstnNumberTranslationRules ] [-InboundTeamsNumberTranslationRules ] - [-MaxConcurrentSessions ] [-MediaBypass ] [-MediaRelayRoutingLocationOverride ] [-OutboundPstnNumberTranslationRules ] - [-OutboundTeamsNumberTranslationRules ] [-PidfLoSupported ] [-ProxySbc ] [-SendSipOptions ] - [-WhatIf] [-Confirm] [] +New-CsOnlinePSTNGateway [-Identity] -SipSignalingPort + [-BypassMode ] + [-Confirm] + [-Description ] + [-Enabled ] + [-FailoverResponseCodes ] + [-FailoverTimeSeconds ] + [-ForwardCallHistory ] + [-ForwardPai ] + [-GatewayLbrEnabledUserOverride ] + [-GatewaySiteId ] + [-GatewaySiteLbrEnabled ] + [-IPAddressVersion ] + [-InboundPstnNumberTranslationRules ] + [-InboundTeamsNumberTranslationRules ] + [-MaxConcurrentSessions ] + [-MediaBypass ] + [-MediaRelayRoutingLocationOverride ] + [-OutboundPstnNumberTranslationRules ] + [-OutboundTeamsNumberTranslationRules ] + [-PidfLoSupported ] + [-ProxySbc ] + [-SendSipOptions ] + [-WhatIf] + [] ``` ### ParentAndRelativeKey ``` -New-CsOnlinePSTNGateway -SipSignalingPort -Fqdn [-BypassMode ] [-Description ] [-Enabled ] - [-FailoverResponseCodes ] [-FailoverTimeSeconds ] [-ForwardCallHistory ] [-ForwardPai ] [-GatewayLbrEnabledUserOverride ] - [-GatewaySiteId ] [-GatewaySiteLbrEnabled ] [-InboundPstnNumberTranslationRules ] [-InboundTeamsNumberTranslationRules ] - [-MaxConcurrentSessions ] [-MediaBypass ] [-MediaRelayRoutingLocationOverride ] [-OutboundPstnNumberTranslationRules ] - [-OutboundTeamsNumberTranslationRules ] [-PidfLoSupported ] [-ProxySbc ] [-SendSipOptions ] - [-WhatIf] [-Confirm] [] +New-CsOnlinePSTNGateway -Fqdn -SipSignalingPort + [-BypassMode ] + [-Confirm] + [-Description ] + [-Enabled ] + [-FailoverResponseCodes ] + [-FailoverTimeSeconds ] + [-ForwardCallHistory ] + [-ForwardPai ] + [-GatewayLbrEnabledUserOverride ] + [-GatewaySiteId ] + [-GatewaySiteLbrEnabled ] + [-IPAddressVersion ] + [-InboundPstnNumberTranslationRules ] + [-InboundTeamsNumberTranslationRules ] + [-MaxConcurrentSessions ] + [-MediaBypass ] + [-MediaRelayRoutingLocationOverride ] + [-OutboundPstnNumberTranslationRules ] + [-OutboundTeamsNumberTranslationRules ] + [-PidfLoSupported ] + [-ProxySbc ] + [-SendSipOptions ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -58,14 +98,47 @@ This example creates an SBC with FQDN sbc.contoso.com and signaling port 5061. F ## PARAMETERS +### -BypassMode +Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the 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 + +> Applicable: Microsoft Teams + Free-format string to describe the gateway. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -74,13 +147,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Microsoft Teams + Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC from service while it is being updated or during maintenance. Note if the parameter is not set the SBC will be created as disabled (default value -Enabled $false). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -89,6 +164,9 @@ Accept wildcard characters: False ``` ### -FailoverResponseCodes + +> Applicable: Microsoft Teams + 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 on receiving the specified codes try another SBC (if another SBC exists in the voice routing policy of the user). Find more information in the "Reference" section of "Phone @@ -100,7 +178,6 @@ Setting this parameter overwrites the default values, so if you want to include Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 408, 503, 504 @@ -109,13 +186,15 @@ Accept wildcard characters: False ``` ### -FailoverTimeSeconds + +> Applicable: Microsoft Teams + When set to 10 (default value), outbound calls that are not answered by the gateway within 10 seconds are routed to the next available trunk; if there are no additional trunks, then the call is automatically dropped. In an organization with slow networks and slow gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 10 @@ -124,13 +203,15 @@ Accept wildcard characters: False ``` ### -ForwardCallHistory + +> Applicable: Microsoft Teams + Indicates whether call history information will be forwarded to the SBC. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -139,13 +220,15 @@ Accept wildcard characters: False ``` ### -ForwardPai + +> Applicable: Microsoft Teams + Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False). Setting this parameter to $true will render the from header anonymous, in accordance of RFC5379 and RFC3325. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -154,13 +237,15 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Microsoft Teams + Limited to 63 characters, the FQDN registered for the SBC. Copied automatically to Identity of the SBC field. ```yaml Type: String Parameter Sets: ParentAndRelativeKey Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -168,46 +253,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewaySiteId -PSTN Gateway Site Id. +### -GatewayLbrEnabledUserOverride + +> Applicable: Microsoft Teams + +Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: $false Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewaySiteLbrEnabled -Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is enabled ($True), the SBC will report the site -name as defined by the tenant administrator. On an incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to -the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False). +### -GatewaySiteId + +> Applicable: Microsoft Teams + +PSTN Gateway Site Id. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: $false +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewayLbrEnabledUserOverride -Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. +### -GatewaySiteLbrEnabled + +> Applicable: Microsoft Teams + +Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is enabled ($True), the SBC will report the site +name as defined by the tenant administrator. On an incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to +the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -216,13 +307,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + When creating a new SBC, the identity must be identical to the -FQDN parameter, described above. If the parameter is not defined the Identity will be copied from the -FQDN parameter. The Identity parameter is not mandatory. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -230,14 +323,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxConcurrentSessions -Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent sessions is 90% or higher than this value. If the parameter is not set, alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours. +### -InboundPSTNNumberTranslationRules +Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. ```yaml -Type: System.Int32 +Type: Object Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -245,69 +337,73 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaBypass -Parameter indicates if the SBC supports Media Bypass and the administrator wants to use it for this SBC. +### -InboundTeamsNumberTranslationRules +This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: $false +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaRelayRoutingLocationOverride -Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter. +### -IPAddressVersion +Possible values are "IPv4" and '"Pv6". When "IPv6" is set, the SBC must use IPv6 for both signaling and media. **Note: IPv6 is supported only for non-media bypass scenarios.** ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: $false +Default value: IPv4 Accept pipeline input: False Accept wildcard characters: False ``` -### -SendSipOptions -Defines if an SBC will or will not send SIP Options messages. If disabled, the SBC will be excluded from the Monitoring and Alerting system. We highly recommend that you enable SIP Options. The default value is True. +### -MaxConcurrentSessions + +> Applicable: Microsoft Teams + +Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent sessions is 90% or higher than this value. If the parameter is not set, alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours. ```yaml -Type: Boolean +Type: System.Int32 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 ``` -### -SipSignalingPort -Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. Must be value between 1 and 65535. -Please note: Spelling of this parameter changed recently from SipSignallingPort to SipSignalingPort. +### -MediaBypass + +> Applicable: Microsoft Teams + +Parameter indicates if the SBC supports Media Bypass and the administrator wants to use it for this SBC. ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: $false Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassMode -Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle. +### -MediaRelayRoutingLocationOverride + +> Applicable: Microsoft Teams + +Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter. ```yaml Type: String @@ -315,13 +411,13 @@ Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: $false Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundTeamsNumberTranslationRules -This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. +### -OutboundPSTNNumberTranslationRules +Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction. ```yaml Type: Object @@ -334,8 +430,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundPSTNNumberTranslationRules -Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. +### -OutbundTeamsNumberTranslationRules +Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction. ```yaml Type: Object @@ -348,25 +444,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutbundTeamsNumberTranslationRules -Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction. +### -PidfloSupported + +> Applicable: Microsoft Teams + +Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: $false Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundPSTNNumberTranslationRules -Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction. +### -ProxySbc + +> Applicable: Microsoft Teams + +The FQDN of the proxy SBC. Used in Local Media Optimization configurations. ```yaml -Type: Object +Type: String Parameter Sets: (All) Aliases: Required: False @@ -376,30 +478,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PidfloSupported -Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user. +### -SendSipOptions + +> Applicable: Microsoft Teams + +Defines if an SBC will or will not send SIP Options messages. If disabled, the SBC will be excluded from the Monitoring and Alerting system. We highly recommend that you enable SIP Options. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: $false +Default value: $true Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxySbc -The FQDN of the proxy SBC. Used in Local Media Optimization configurations. +### -SipSignalingPort + +> Applicable: Microsoft Teams + +Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. Must be value between 1 and 65535. +Please note: Spelling of this parameter changed recently from SipSignallingPort to SipSignalingPort. ```yaml -Type: String +Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -407,6 +514,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -414,22 +524,6 @@ The cmdlet is not run. 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 running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -452,8 +546,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstngateway) -[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstngateway) -[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinepstngateway) diff --git a/teams/teams-ps/teams/New-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineSchedule.md similarity index 88% rename from teams/teams-ps/teams/New-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineSchedule.md index 321a1e96c4..bfb80eadf7 100644 --- a/teams/teams-ps/teams/New-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule +schema: 2.0.0 +title: New-CsOnlineSchedule --- # New-CsOnlineSchedule @@ -41,11 +43,11 @@ The New-CsOnlineSchedule cmdlet creates a new schedule for the Auto Attendant (A - For a fixed schedule, at most 10 date-time ranges can be specified. - You can create a new date-time range for a fixed schedule by using the New-CsOnlineDateTimeRange cmdlet. - The return type of this cmdlet composes a member for the underlying type/implementation. For example, in case of the weekly recurrent schedule, you can modify Monday's time ranges through the Schedule.WeeklyRecurrentSchedule.MondayHours property. Similarly, date-time ranges of a fixed schedule can be modified by using the Schedule.FixedSchedule.DateTimeRanges property. -- Schedules can then be used by [New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation). +- Schedules can then be used by [New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation). ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00 $tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00 @@ -54,7 +56,7 @@ $businessHours = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSch This example creates a weekly recurrent schedule that is active on Monday-Friday from 9AM-12PM and 1PM-5PM. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00 $tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00 @@ -63,7 +65,7 @@ $afterHours = New-CsOnlineSchedule -Name " After Hours" -WeeklyRecurrentSchedule This example creates a weekly recurrent schedule that is active at all times except Monday-Friday, 9AM-12PM and 1PM-5PM. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" $christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) @@ -71,7 +73,7 @@ $christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -Date This example creates a fixed schedule that is active from December 24, 2017 to December 26, 2017. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell $dtr1 = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" $dtr2 = New-CsOnlineDateTimeRange -Start "24/12/2018" -End "26/12/2018" @@ -80,7 +82,7 @@ $christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -Date This example creates a fixed schedule that is active from December 24, 2017 to December 26, 2017 and then from December 24, 2018 to December 26, 2018. -### -------------------------- Example 5 -------------------------- +### Example 5 ```powershell $notInEffectSchedule = New-CsOnlineSchedule -Name "NotInEffect" -FixedSchedule ``` @@ -89,62 +91,72 @@ This example creates a fixed schedule that is never active. ## PARAMETERS -### -Name -The Name parameter represents a unique friendly name for the schedule. +### -Complement + +> Applicable: Microsoft Teams + +The Complement parameter indicates how the schedule is used. +When Complement is enabled, the schedule is used as the inverse of the provided configuration. +For example, if Complement is enabled and the schedule only contains time ranges of Monday to Friday from 9AM to 5PM, then the schedule is active at all times other than the specified time ranges. ```yaml -Type: System.String -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WeeklyRecurrentSchedule -The WeeklyRecurrentSchedule parameter indicates that a weekly recurrent schedule is to be created. This parameter is mandatory when a weekly recurrent schedule is to be created. +### -DateTimeRanges + +> Applicable: Microsoft Teams + +List of date-time ranges for a fixed schedule. At most, 10 date-time ranges can be specified using this parameter. ```yaml -Type: SwitchParameter -Parameter Sets: WeeklyRecurrentSchedule +Type: System.Collections.Generic.List +Parameter Sets: FixedSchedule Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MondayHours -List of time ranges for that day. +### -FixedSchedule + +> Applicable: Microsoft Teams + +The FixedSchedule parameter indicates that a fixed schedule is to be created. ```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule +Type: SwitchParameter +Parameter Sets: FixedSchedule Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TuesdayHours +### -FridayHours + +> Applicable: Microsoft Teams + List of time ranges for that day. ```yaml Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -153,14 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WednesdayHours +### -MondayHours + +> Applicable: Microsoft Teams + List of time ranges for that day. ```yaml Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -169,30 +183,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ThursdayHours -List of time ranges for that day. +### -Name + +> Applicable: Microsoft Teams + +The Name parameter represents a unique friendly name for the schedule. ```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule +Type: System.String +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -FridayHours +### -SaturdayHours + +> Applicable: Microsoft Teams + List of time ranges for that day. ```yaml Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -201,14 +219,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SaturdayHours +### -SundayHours + +> Applicable: Microsoft Teams + List of time ranges for that day. ```yaml Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -217,14 +237,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SundayHours -List of time ranges for that day. +### -Tenant + +> Applicable: Microsoft Teams ```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule +Type: System.Guid +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -233,16 +253,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Complement -The Complement parameter indicates how the schedule is used. -When Complement is enabled, the schedule is used as the inverse of the provided configuration. -For example, if Complement is enabled and the schedule only contains time ranges of Monday to Friday from 9AM to 5PM, then the schedule is active at all times other than the specified time ranges. +### -ThursdayHours + +> Applicable: Microsoft Teams + +List of time ranges for that day. ```yaml -Type: SwitchParameter +Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -251,30 +271,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FixedSchedule -The FixedSchedule parameter indicates that a fixed schedule is to be created. +### -TuesdayHours + +> Applicable: Microsoft Teams + +List of time ranges for that day. ```yaml -Type: SwitchParameter -Parameter Sets: FixedSchedule +Type: System.Collections.Generic.List +Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DateTimeRanges -List of date-time ranges for a fixed schedule. At most, 10 date-time ranges can be specified using this parameter. +### -WednesdayHours + +> Applicable: Microsoft Teams + +List of time ranges for that day. ```yaml Type: System.Collections.Generic.List -Parameter Sets: FixedSchedule +Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -283,15 +307,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -WeeklyRecurrentSchedule + +> Applicable: Microsoft Teams + +The WeeklyRecurrentSchedule parameter indicates that a weekly recurrent schedule is to be created. This parameter is mandatory when a weekly recurrent schedule is to be created. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -313,12 +340,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange) +[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetimerange) -[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange) +[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedatetimerange) -[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) -[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation) +[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation) -[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendant) diff --git a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberOrder.md similarity index 93% rename from teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberOrder.md index a5408ee15d..5bf5e73814 100644 --- a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberOrder.md @@ -1,13 +1,14 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: New-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder +schema: 2.0.0 +title: New-CsOnlineTelephoneNumberOrder --- # New-CsOnlineTelephoneNumberOrder @@ -35,7 +36,7 @@ Telephone numbers can be created with 3 ways: ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 1" -Description "Civic address search example" -Country "US" -NumberType "UserSubscriber" -Quantity 1 -CivicAddressId 3b175352-4131-431e-970c-273226b8fb46 PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId @@ -68,7 +69,7 @@ New York City +17182000004 This example demonstrates a civic address based telephone number search. Telephone number +17182000004 is found to belong to the given address and is reserved for purchase. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 2" -Description "Number prefix search example" -Country "US" -NumberType "UserSubscriber" -Quantity 1 -NumberPrefix 1425 PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId @@ -101,7 +102,7 @@ Bellevue +14252000004 This example demonstrates a number prefix based telephone number search. Telephone number +14252000004 is found to have the desired number prefix and is reserved for purchase. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 3" -Description "Area code selection search example" -Country "US" -NumberType "ConferenceTollFree" -Quantity 1 -AreaCode 800 PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId @@ -267,10 +268,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype) -[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) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberReleaseOrder.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberReleaseOrder.md new file mode 100644 index 0000000000..8e87bbbe17 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberReleaseOrder.md @@ -0,0 +1,179 @@ +--- +applicable: Microsoft Teams +author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +ms.reviewer: pavellatif +online version: online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-csonlinetelephonenumberreleaseorder +schema: 2.0.0 +title: New-CsOnlineTelephoneNumberReleaseOrder +--- + +# New-CsOnlineTelephoneNumberReleaseOrder + +## SYNOPSIS + +This cmdlet creates a request to release telephone numbers from Microsoft Teams telephone number +management inventory. + +## SYNTAX + +``` +New-CsOnlineTelephoneNumberReleaseOrder [-TelephoneNumber ] [-StartingNumber ] + [-EndingNumber ] [-FileContent ] [] +``` + +## DESCRIPTION + +This cmdlet releases existing telephone numbers from Microsoft Teams telephone number management +inventory. Once released the phone numbers will not be visible in Teams PowerShell as acquired +telephone 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](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 Release -OrderId "orderId"`. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a telephone number "+123456789" is being released from Microsoft Teams telephone +number management inventory. + +### Example 2 + +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789,+134567890,+145678901" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a list of telephone numbers are being released from Microsoft Teams telephone +number management. + +### Example 3 + +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -StartingNumber "+12000000" -EndingNumber "+12000009" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a range of telephone numbers from "+12000000" to "+12000009" are being released from Microsoft Teams telephone number management. + +### 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 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 telephone numbers to be released. The `New-CsOnlineTelephoneNumberReleaseOrder` cmdlet is only used to pass the content. + +## PARAMETERS + +### -EndingNumber + +This is the ending number of a range of telephone number you wish to release from your tenant in +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 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 +``` + +### -StartingNumber + +This is the starting number of a range of telephone number you wish to release from your tenant in +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 +``` + +### -TelephoneNumber + +This is the telephone number you wish to release from your tenant in 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 +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsOnlineDirectRoutingTelephoneNumberUploadOrder](new-csonlinedirectroutingtelephonenumberuploadorder.md) diff --git a/teams/teams-ps/teams/New-CsOnlineTimeRange.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTimeRange.md similarity index 87% rename from teams/teams-ps/teams/New-CsOnlineTimeRange.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineTimeRange.md index e331b4ffe5..adafda55ff 100644 --- a/teams/teams-ps/teams/New-CsOnlineTimeRange.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTimeRange.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetimerange +schema: 2.0.0 +title: New-CsOnlineTimeRange --- # New-CsOnlineTimeRange @@ -31,14 +33,14 @@ The New-CsOnlineTimeRange cmdlet creates a new time range to be used with the Au ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $workdayTimeRange = New-CsOnlineTimeRange -Start 09:00 -End 17:00 ``` This example creates a time range for a 9AM to 5PM work day. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $allDayTimeRange = New-CsOnlineTimeRange -Start 00:00 -End 1.00:00 ``` @@ -47,14 +49,16 @@ This example creates a 24-hour time range. ## PARAMETERS -### -Start -The Start parameter represents the start bound of the time range. +### -End + +> Applicable: Microsoft Teams + +The End parameter represents the end bound of the time range. ```yaml Type: System.TimeSpan Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -63,14 +67,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -End -The End parameter represents the end bound of the time range. +### -Start + +> Applicable: Microsoft Teams + +The Start parameter represents the start bound of the time range. ```yaml Type: System.TimeSpan Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -81,11 +87,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoute.md similarity index 92% rename from teams/teams-ps/teams/New-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoute.md index 270d9deed1..d5a88b867c 100644 --- a/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoute.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute applicable: Microsoft Teams -title: New-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroute +schema: 2.0.0 +title: New-CsOnlineVoiceRoute --- # New-CsOnlineVoiceRoute ## SYNOPSIS -Creates a new online voice route. 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). +Creates a new online voice route. ## SYNTAX @@ -34,27 +35,29 @@ New-CsOnlineVoiceRoute [-BridgeSourcePhoneNumber ] [-Description New-CsOnlineVoiceRoute -Identity Route1 ``` The command in this example creates a new online voice route with an Identity of Route1. All other properties will be set to the default values. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> New-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{add="Long Distance"} -OnlinePstnGatewayList @{add="sbc1.litwareinc.com"} ``` The command in this example creates a new online voice route with an Identity of Route1. It also adds the online PSTN usage Long Distance to the list of usages and the service ID PstnGateway sbc1.litwareinc.com to the list of online PSTN gateways. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> $x = (Get-CsOnlinePstnUsage).Usage @@ -242,8 +245,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy.md similarity index 90% rename from teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy.md index a4646da2fa..65001aba92 100644 --- a/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: New-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: New-CsOnlineVoiceRoutingPolicy --- # New-CsOnlineVoiceRoutingPolicy @@ -30,14 +31,14 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> New-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages "Long Distance" ``` The command shown in Example 1 creates a new online per-user voice routing policy with the Identity RedmondOnlineVoiceRoutingPolicy. This policy is assigned a single online PSTN usage: Long Distance. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> New-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages "Long Distance", "Local", "Internal" ``` @@ -151,10 +152,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoicemailPolicy.md similarity index 75% rename from teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineVoicemailPolicy.md index 04a4f92099..9d6632e22d 100644 --- a/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoicemailPolicy.md @@ -1,35 +1,44 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoicemailpolicy +schema: 2.0.0 +title: New-CsOnlineVoicemailPolicy --- # New-CsOnlineVoicemailPolicy ## SYNOPSIS -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. +Creates a new Online Voicemail policy. ## SYNTAX ### Identity (Default) -```powershell -New-CsOnlineVoicemailPolicy [-Identity] [-EnableEditingCallAnswerRulesSetting ] [-EnableTranscription ] -[-EnableTranscriptionProfanityMasking ] [-EnableTranscriptionTranslation ] [-MaximumRecordingLength ] -[-PostAmbleAudioFile ] [-PreambleAudioFile ] [-PreamblePostambleMandatory ] -[-PrimarySystemPromptLanguage ] [-SecondarySystemPromptLanguage ] [-ShareData ] [-WhatIf] [-Confirm] [-Description ] [] +``` +New-CsOnlineVoicemailPolicy [-Identity] [-EnableEditingCallAnswerRulesSetting ] + [-EnableTranscription ] [-EnableTranscriptionProfanityMasking ] + [-EnableTranscriptionTranslation ] [-MaximumRecordingLength ] + [-PostAmbleAudioFile ] [-PreambleAudioFile ] + [-PreamblePostambleMandatory ] [-PrimarySystemPromptLanguage ] + [-SecondarySystemPromptLanguage ] [-ShareData ] [-WhatIf] [-Confirm] + [-Description ] [] ``` ## DESCRIPTION -Cloud Voicemail service provides organizations with voicemail deposit capabilities for Phone System implementation. +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 @@ -42,7 +51,7 @@ Tenant admin would be able to create a customized online voicemail policy to mat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" -MaximumRecordingLength ([TimeSpan]::FromSeconds(60)) ``` @@ -51,29 +60,50 @@ The command shown in Example 1 creates a per-user online voicemail policy Custom ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -Confirm + +> Applicable: Microsoft Teams + +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 about the policy. For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -EnableEditingCallAnswerRulesSetting + +> Applicable: Microsoft Teams + Controls if editing call answer rule settings are enabled or disabled for a user. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -83,13 +113,15 @@ Accept wildcard characters: False ``` ### -EnableTranscription + +> Applicable: Microsoft Teams + Allows you to disable or enable voicemail transcription. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -99,13 +131,15 @@ Accept wildcard characters: False ``` ### -EnableTranscriptionProfanityMasking + +> Applicable: Microsoft Teams + Allows you to disable or enable profanity masking for the voicemail transcriptions. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -115,13 +149,15 @@ Accept wildcard characters: False ``` ### -EnableTranscriptionTranslation + +> Applicable: Microsoft Teams + Allows you to disable or enable translation for the voicemail transcriptions. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -130,14 +166,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +A unique identifier specifying the scope, and in some cases the name, 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 +``` ### -MaximumRecordingLength + +> Applicable: Microsoft Teams + A duration of voicemail maximum recording length. The length should be between 30 seconds to 10 minutes. ```yaml Type: Duration Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -147,13 +202,15 @@ Accept wildcard characters: False ``` ### -PostambleAudioFile + +> Applicable: Microsoft Teams + The audio file to play to the caller after the user's voicemail greeting has played and before the caller is allowed to leave a voicemail message. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -162,13 +219,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -PreambleAudioFile + +> Applicable: Microsoft Teams + The audio file to play to the caller before the user's voicemail greeting is played. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -178,13 +237,15 @@ Accept wildcard characters: False ``` ### -PreamblePostambleMandatory + +> Applicable: Microsoft Teams + Is playing the Pre- or Post-amble mandatory before the caller can leave a message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -194,13 +255,15 @@ 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](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. + +> Applicable: Microsoft Teams + +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/microsoftteams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -210,13 +273,15 @@ 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](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. + +> Applicable: Microsoft Teams + +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/microsoftteams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -226,13 +291,15 @@ Accept wildcard characters: False ``` ### -ShareData + +> Applicable: Microsoft Teams + Specifies whether voicemail and transcription data are shared with the service for training and improving accuracy. Possible values are Defer and Deny. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -242,45 +309,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually 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 -``` - -### -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: +Aliases: wi Required: False Position: Named @@ -299,10 +336,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md b/teams/teams-ps/MicrosoftTeams/New-CsSdgBulkSignInRequest.md similarity index 99% rename from teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md rename to teams/teams-ps/MicrosoftTeams/New-CsSdgBulkSignInRequest.md index 3c44267712..d2ec0a7383 100644 --- a/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsSdgBulkSignInRequest.md @@ -1,10 +1,10 @@ --- +applicable: Microsoft Teams external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -online version: -title: New-CsSdgBulkSignInRequest schema: 2.0.0 +title: New-CsSdgBulkSignInRequest --- # New-CsSdgBulkSignInRequest diff --git a/teams/teams-ps/MicrosoftTeams/New-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..b4fec57d17 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/New-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,149 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: tomkau +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: New-CsSharedCallQueueHistoryTemplate +--- + +# New-CsSharedCallQueueHistoryTemplate + +## SYNOPSIS +Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue History template. + +## SYNTAX + +``` +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 + +### -AnsweredAndOutboundCalls + +> Applicable: Microsoft Teams + +A description for the shared call queue history template. + +PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Off +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +> Applicable: Microsoft Teams + +A description for the shared call queue history template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncomingMissedCalls + +> Applicable: Microsoft Teams + +A description for the shared call queue history template. + +PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Off +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +> Applicable: Microsoft Teams + +The name of the shared call queue history template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### 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/MicrosoftTeams/New-CsTeamTemplate.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamTemplate.md index 4230e09bf3..02744985eb 100644 --- a/teams/teams-ps/teams/New-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamTemplate.md @@ -1,810 +1,813 @@ ---- -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-csteamtemplate -title: New-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# New-CsTeamTemplate - -## 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](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. - -## SYNTAX - -### NewExpanded (Default) - -```powershell -New-CsTeamTemplate -Locale -DisplayName -ShortDescription - [-App ] [-Category ] [-Channel ] - [-Classification ] [-Description ] [-DiscoverySetting ] - [-FunSetting ] [-GuestSetting ] [-Icon ] - [-IsMembershipLimitedToOwner] [-MemberSetting ] - [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] - [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### New - -```powershell -New-CsTeamTemplate -Locale -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### NewViaIdentity - -```powershell -New-CsTeamTemplate -InputObject -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### NewViaIdentityExpanded - -```powershell -New-CsTeamTemplate -InputObject -DisplayName - -ShortDescription [-App ] [-Category ] - [-Channel ] [-Classification ] [-Description ] - [-DiscoverySetting ] [-FunSetting ] - [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] - [-MemberSetting ] [-MessagingSetting ] - [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] - [-Uri ] [-Visibility ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -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) -``` - -Step 1: Create new template from copy of existing template. Gets the template JSON file of Template with specified OData ID, creates a JSON file user can make edits in. -Step 2: Create a new template from the JSON file named "input". - -### 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.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 += ` -@{ ` - displayName="test"; ` - id="b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` - isFavoriteByDefault=$false; ` -} - -PS C:\> New-CsTeamTemplate -Locale en-US -Body $template -``` - -Create a template using a complex object syntax. - -### EXAMPLE 3 - -```powershell -PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` -DisplayName='New Template';` -ShortDescription='Short Definition';` -Description='New Description';` -App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` -Channel=@{` - displayName = "General";` - id= "General";` - isFavoriteByDefault= $true` - },` - @{` - displayName= "test";` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` - isFavoriteByDefault= $false` - }` -} - -PS C:\> New-CsTeamTemplate -Locale en-US -Body $template -``` - -Create template from scratch - -> [!Note] -> It can take up to 24 hours for Teams users to see a custom template change in the gallery. - -## PARAMETERS - -### -App - -Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. -To construct, see NOTES section for APP properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body - -The client input for a request to create a template. -Only admins from Config Api can perform this request. -To construct, see NOTES section for BODY properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate -Parameter Sets: New, NewViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category - -Gets or sets list of categories. - -```yaml -Type: System.String[] -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Channel - -Gets or sets the set of channel templates included in the team template. -To construct, see NOTES section for CHANNEL properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Classification - -Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Gets or sets the team's Description. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoverySetting - -Governs discoverability of a team. -To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName - -Gets or sets the team's DisplayName. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunSetting - -Governs use of fun media like giphy and stickers in the team. -To construct, see NOTES section for FUNSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestSetting - -Guest role settings for the team. -To construct, see NOTES section for GUESTSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Icon - -Gets or sets template icon. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity -Parameter Sets: NewViaIdentity, NewViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsMembershipLimitedToOwner - -Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Locale - -```yaml -Type: System.String -Parameter Sets: New, NewExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberSetting - -Member role settings for the team. -To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessagingSetting - -Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. -To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerUserObjectId - -Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishedBy - -Gets or sets published name. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShortDescription - -Gets or sets template short description. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Specialization - -The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateId - -Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri - -Gets or sets uri to be used for GetTemplate api call. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Visibility - -Used to control the scope of users who can view a group/team and its members, and ability to join. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateErrorResponse - -## NOTES - -ALIASES - -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. - -APP : Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. - -- `[Id ]`: Gets or sets the app's ID in the global apps catalog. - -BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. - -- `DisplayName `: Gets or sets the team's DisplayName. -- `ShortDescription `: Gets or sets template short description. -- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. - - `[Id ]`: Gets or sets the app's ID in the global apps catalog. -- `[Category ]`: Gets or sets list of categories. -- `[Channel ]`: Gets or sets the set of channel templates included in the team 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 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. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. -- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. -- `[Description ]`: Gets or sets the team's Description. -- `[DiscoverySetting ]`: Governs discoverability of a team. - - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. -- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. - - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. - - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - - `GiphyContentRating `: Gets or sets the rating filter on giphy content. -- `[GuestSetting ]`: Guest role settings for the team. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. -- `[Icon ]`: Gets or sets template icon. -- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. -- `[MemberSetting ]`: Member role settings for the team. - - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. - - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. - - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. - - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. -- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. - - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. -- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. -- `[PublishedBy ]`: Gets or sets published name. -- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. -- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. -- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. -- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. - -CHANNEL : Gets or sets the set of channel templates included in the team 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 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. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. - -DISCOVERYSETTING \: Governs discoverability of a team. - -- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - -FUNSETTING \: Governs use of fun media like giphy and stickers in the team. - -- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. -- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. -- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. -- `GiphyContentRating `: Gets or sets the rating filter on giphy content. - -GUESTSETTING \: Guest role settings for the team. - -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. - -INPUTOBJECT \: Identity Parameter - -- `[Bssid ]`: -- `[ChassisId ]`: -- `[CivicAddressId ]`: Civic address id. -- `[Country ]`: -- `[GroupId ]`: The ID of a group whose policy assignments will be returned. -- `[Id ]`: -- `[Identity ]`: -- `[Locale ]`: -- `[LocationId ]`: Location id. -- `[OdataId ]`: A composite URI of a template. -- `[OperationId ]`: The ID of a batch policy assignment operation. -- `[OrderId ]`: -- `[PackageName ]`: The name of a specific policy package -- `[PolicyType ]`: The policy type for which group policy assignments will be returned. -- `[Port ]`: -- `[PortInOrderId ]`: -- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. -- `[SubnetId ]`: -- `[TenantId ]`: -- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -MEMBERSETTING \: Member role settings for the team. - -- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. -- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. -- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. -- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. -- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. - -MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. - -- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. -- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. -- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. -- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. -- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - -## RELATED LINKS - -- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamtemplate +schema: 2.0.0 +title: New-CsTeamTemplate +--- + +# New-CsTeamTemplate + +## SYNOPSIS + +This cmdlet lets you provision a new team template for use in Microsoft Teams. + +## SYNTAX + +### NewExpanded (Default) + +``` +New-CsTeamTemplate -Locale -DisplayName -ShortDescription + [-App ] [-Category ] [-Channel ] + [-Classification ] [-Description ] [-DiscoverySetting ] + [-FunSetting ] [-GuestSetting ] [-Icon ] + [-IsMembershipLimitedToOwner] [-MemberSetting ] + [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] + [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### New + +``` +New-CsTeamTemplate -Locale -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### NewViaIdentity + +``` +New-CsTeamTemplate -InputObject -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### NewViaIdentityExpanded + +``` +New-CsTeamTemplate -InputObject -DisplayName + -ShortDescription [-App ] [-Category ] + [-Channel ] [-Classification ] [-Description ] + [-DiscoverySetting ] [-FunSetting ] + [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] + [-MemberSetting ] [-MessagingSetting ] + [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] + [-Uri ] [-Visibility ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +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). + +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. + + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +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) +``` + +Step 1: Create new template from copy of existing template. Gets the template JSON file of Template with specified OData ID, creates a JSON file user can make edits in. +Step 2: Create a new template from the JSON file named "input". + +### 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.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 += ` +@{ ` + displayName="test"; ` + id="b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` + isFavoriteByDefault=$false; ` +} + +PS C:\> New-CsTeamTemplate -Locale en-US -Body $template +``` + +Create a template using a complex object syntax. + +### EXAMPLE 3 + +```powershell +PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` +DisplayName='New Template';` +ShortDescription='Short Definition';` +Description='New Description';` +App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` +Channel=@{` + displayName = "General";` + id= "General";` + isFavoriteByDefault= $true` + },` + @{` + displayName= "test";` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` + isFavoriteByDefault= $false` + }` +} + +PS C:\> New-CsTeamTemplate -Locale en-US -Body $template +``` + +Create template from scratch + +> [!Note] +> It can take up to 24 hours for Teams users to see a custom template change in the gallery. + +## PARAMETERS + +### -App + +Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. +To construct, see NOTES section for APP properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body + +The client input for a request to create a template. +Only admins from Config Api can perform this request. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate +Parameter Sets: New, NewViaIdentity +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: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category + +Gets or sets list of categories. + +```yaml +Type: System.String[] +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Channel + +Gets or sets the set of channel templates included in the team template. +To construct, see NOTES section for CHANNEL properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Classification + +Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Gets or sets the team's Description. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoverySetting + +Governs discoverability of a team. +To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName + +Gets or sets the team's DisplayName. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunSetting + +Governs use of fun media like giphy and stickers in the team. +To construct, see NOTES section for FUNSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestSetting + +Guest role settings for the team. +To construct, see NOTES section for GUESTSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +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 +``` + +### -Icon + +Gets or sets template icon. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: NewViaIdentity, NewViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsMembershipLimitedToOwner + +Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale + +```yaml +Type: System.String +Parameter Sets: New, NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberSetting + +Member role settings for the team. +To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingSetting + +Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. +To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerUserObjectId + +Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +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: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishedBy + +Gets or sets published name. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShortDescription + +Gets or sets template short description. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Specialization + +The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateId + +Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri + +Gets or sets uri to be used for GetTemplate api call. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Visibility + +Used to control the scope of users who can view a group/team and its members, and ability to join. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateErrorResponse + +## NOTES + +ALIASES + +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. + +APP : Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. + +- `[Id ]`: Gets or sets the app's ID in the global apps catalog. + +BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. + +- `DisplayName `: Gets or sets the team's DisplayName. +- `ShortDescription `: Gets or sets template short description. +- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. + - `[Id ]`: Gets or sets the app's ID in the global apps catalog. +- `[Category ]`: Gets or sets list of categories. +- `[Channel ]`: Gets or sets the set of channel templates included in the team 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 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. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. +- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. +- `[Description ]`: Gets or sets the team's Description. +- `[DiscoverySetting ]`: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. +- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. + - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. + - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. + - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. + - `GiphyContentRating `: Gets or sets the rating filter on giphy content. +- `[GuestSetting ]`: Guest role settings for the team. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. +- `[Icon ]`: Gets or sets template icon. +- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. +- `[MemberSetting ]`: Member role settings for the team. + - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. + - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. + - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. + - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. + - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. +- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. + - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. + - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. + - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. + - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. + - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. +- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. +- `[PublishedBy ]`: Gets or sets published name. +- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. +- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. +- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. +- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. + +CHANNEL : Gets or sets the set of channel templates included in the team 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 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. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. + +DISCOVERYSETTING \: Governs discoverability of a team. + +- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. + +FUNSETTING \: Governs use of fun media like giphy and stickers in the team. + +- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. +- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. +- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. +- `GiphyContentRating `: Gets or sets the rating filter on giphy content. + +GUESTSETTING \: Guest role settings for the team. + +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. + +INPUTOBJECT \: Identity Parameter + +- `[Bssid ]`: +- `[ChassisId ]`: +- `[CivicAddressId ]`: Civic address id. +- `[Country ]`: +- `[GroupId ]`: The ID of a group whose policy assignments will be returned. +- `[Id ]`: +- `[Identity ]`: +- `[Locale ]`: +- `[LocationId ]`: Location id. +- `[OdataId ]`: A composite URI of a template. +- `[OperationId ]`: The ID of a batch policy assignment operation. +- `[OrderId ]`: +- `[PackageName ]`: The name of a specific policy package +- `[PolicyType ]`: The policy type for which group policy assignments will be returned. +- `[Port ]`: +- `[PortInOrderId ]`: +- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. +- `[SubnetId ]`: +- `[TenantId ]`: +- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +MEMBERSETTING \: Member role settings for the team. + +- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. +- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. +- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. +- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. +- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. + +MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. + +- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. +- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. +- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. +- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. +- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. + +## RELATED LINKS + +- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) diff --git a/teams/teams-ps/teams/New-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAIPolicy.md similarity index 68% rename from teams/teams-ps/teams/New-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAIPolicy.md index 594997baa4..4ccd6704b4 100644 --- a/teams/teams-ps/teams/New-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: andywang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsTeamsAIPolicy +schema: 2.0.0 +title: New-CsTeamsAIPolicy --- # New-CsTeamsAIPolicy @@ -17,12 +18,17 @@ This cmdlet creates a Teams AI policy. ## SYNTAX ```powershell -New-CsTeamsAIPolicy -Identity [-EnrollFace ] [-EnrollVoice ] [-Description ] [] +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. 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. +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. @@ -37,15 +43,15 @@ The newly created policy with value will be printed on success. ## PARAMETERS -### -Identity -Identity of the Teams AI policy. - +### -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: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -56,7 +62,7 @@ Accept wildcard characters: False Policy value of the Teams AI EnrollFace policy. EnrollFace controls user access to user face enrollment in the Teams app settings. ```yaml -Type: Boolean +Type: String Parameter Sets: ("Enabled","Disabled") Aliases: @@ -71,7 +77,7 @@ Accept wildcard characters: False Policy value of the Teams AI EnrollVoice policy. EnrollVoice controls user access to user voice enrollment in the Teams app settings. ```yaml -Type: Boolean +Type: String Parameter Sets: ("Enabled","Disabled") Aliases: @@ -82,21 +88,36 @@ 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. +### -Identity +Identity of the Teams AI policy. + ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None 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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -107,10 +128,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaipolicy) -[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaipolicy) -[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppPermissionPolicy.md similarity index 67% rename from teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAppPermissionPolicy.md index ff4308f76f..d2ab217f1b 100644 --- a/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppPermissionPolicy.md @@ -1,24 +1,21 @@ --- -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 +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsapppermissionpolicy +schema: 2.0.0 +title: New-CsTeamsAppPermissionPolicy --- # 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.** +As an admin, you can use app permission policies to allow or block apps for your users. ## SYNTAX @@ -41,9 +38,12 @@ New-CsTeamsAppPermissionPolicy [[-Identity] ] ## 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. +While the cmdlet may succeed, the changes aren't applied to the tenant. 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: . +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppSetupPolicy.md similarity index 84% rename from teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAppSetupPolicy.md index ff00d0c8a6..2c40d2b3ca 100644 --- a/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppSetupPolicy.md @@ -1,19 +1,17 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsappsetuppolicy applicable: Microsoft Teams -title: New-CsTeamsAppSetupPolicy +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsappsetuppolicy schema: 2.0.0 +title: New-CsTeamsAppSetupPolicy --- # New-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. ## SYNTAX @@ -36,11 +34,21 @@ New-CsTeamsAppSetupPolicy [-Identity] ``` ## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this +cmdlet. We require that all creation and modification of app setup polices (not including the +assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business +Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that +are most important for your users. You choose the apps to pin and set the order that they appear. +App setup policies let you showcase apps that users in your organization need, including ones built +by third parties or by developers in your organization. You can also use app setup policies to +manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the +bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: +. ## EXAMPLES @@ -99,16 +107,16 @@ Create a new TeamsAppSetupPolicy and install VivaConnections App in users' perso ## PARAMETERS -### -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: String -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 @@ -159,13 +167,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -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: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -174,13 +182,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the app setup policy. +### -Confirm +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -189,11 +197,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinnedAppBarApps -Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that are needed the most by users and promote ease of access. +### -Description +Description of the app setup policy. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] +Type: String Parameter Sets: (All) Aliases: @@ -204,26 +212,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinnedCallingBarApps -Determines the list of apps that are pre pinned for a participant in Calls. +### -Identity +Name of App setup policy. If empty, all Identities will be used by default. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PinnedMessageBarApps -Apps are pinned in messaging extensions and into the ellipsis menu. +### -PinnedAppBarApps +Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that are needed the most by users and promote ease of access. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] Parameter Sets: (All) Aliases: @@ -234,11 +242,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdditionalCustomizationApps -This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. +### -PinnedCallingBarApps +Determines the list of apps that are pre pinned for a participant in Calls. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] Parameter Sets: (All) Aliases: @@ -249,11 +257,11 @@ 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. +### -PinnedMessageBarApps +Apps are pinned in messaging extensions and into the ellipsis menu. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] Parameter Sets: (All) Aliases: diff --git a/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy.md similarity index 93% rename from teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy.md index e95b230bdc..f45e3a0df3 100644 --- a/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy -title: New-CsTeamsAudioConferencingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy schema: 2.0.0 +title: New-CsTeamsAudioConferencingPolicy --- # New-CsTeamsAudioConferencingPolicy @@ -53,6 +54,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. @@ -113,21 +129,6 @@ Accept 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. @@ -156,8 +157,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy) -[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallHoldPolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCallHoldPolicy.md index 92744364e9..d261c5a834 100644 --- a/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -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: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy +schema: 2.0.0 +title: New-CsTeamsCallHoldPolicy --- # New-CsTeamsCallHoldPolicy @@ -42,16 +43,31 @@ Any Microsoft Teams users who are assigned this policy will have their call hold ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new Teams call hold policy. +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +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 @@ -74,11 +90,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFileId -A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -89,16 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreamingSourceUrl -This parameter is reserved for internal Microsoft use. +### -Identity +Unique identifier to be assigned to the new Teams call hold policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -119,11 +135,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -150,21 +166,6 @@ Accept 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). @@ -180,12 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallholdpolicy) -[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallholdpolicy) -[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallholdpolicy) -[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallholdpolicy) -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallParkPolicy.md similarity index 80% rename from teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCallParkPolicy.md index ba4ca721a7..475eac960f 100644 --- a/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallParkPolicy.md @@ -1,33 +1,40 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallparkpolicy +schema: 2.0.0 +title: New-CsTeamsCallParkPolicy --- # New-CsTeamsCallParkPolicy ## SYNOPSIS - -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 New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. - -NOTE: The call park feature currently available in desktop. mobile and web clients. Supported with TeamsOnly mode. +The New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. ## SYNTAX ### Identity (Default) -```powershell -New-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [[-Identity] ] [-PickupRangeStart ] [-PickupRangeEnd ] [-ParkTimeoutSeconds ] [-Force] [-WhatIf] [-Confirm] [-Description ] [] + +``` +New-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [[-Identity] ] + [-PickupRangeStart ] [-PickupRangeEnd ] [-ParkTimeoutSeconds ] [-Force] + [-WhatIf] [-Confirm] [-Description ] [] ``` ## 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 New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. +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. + +NOTE: The call park feature currently available in desktop. mobile and web clients. Supported with TeamsOnly mode. ## EXAMPLES @@ -84,6 +91,21 @@ 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. @@ -114,10 +136,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PickupRangeEnd -Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. - -Note: PickupRangeStart must be smaller than PickupRangeEnd. +### -ParkTimeoutSeconds +Specify the number of seconds to wait before ringing the parker when the parked call hasn't been picked up. Value can be from 120 to 1800 (seconds). ```yaml Type: Integer @@ -126,13 +146,15 @@ Aliases: Required: False Position: Named -Default value: 99 +Default value: 300 Accept pipeline input: False Accept wildcard characters: False ``` -### -ParkTimeoutSeconds -Specify the number of seconds to wait before ringing the parker when the parked call hasn't been picked up. Value can be from 120 to 1800 (seconds). +### -PickupRangeEnd +Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. + +Note: PickupRangeStart must be smaller than PickupRangeEnd. ```yaml Type: Integer @@ -141,7 +163,7 @@ Aliases: Required: False Position: Named -Default value: 300 +Default value: 99 Accept pipeline input: False Accept wildcard characters: False ``` @@ -194,21 +216,6 @@ 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). diff --git a/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallingPolicy.md similarity index 87% rename from teams/teams-ps/teams/New-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCallingPolicy.md index 1cdf28cc2a..bc41338a65 100644 --- a/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallingPolicy.md @@ -1,14 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +ms.reviewer: alejandramu +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy +schema: 2.0.0 +title: New-CsTeamsCallingPolicy --- # New-CsTeamsCallingPolicy @@ -52,6 +53,8 @@ New-CsTeamsCallingPolicy [-Identity] [-PreventTollBypass ] [-SpamFilteringEnabledType ] [-VoiceSimulationInInterpreter ] + [-RealTimeText ] + [-ExplicitRecordingConsent ] [-WhatIf] [] ``` @@ -71,22 +74,10 @@ values in the Global policy instance. ## PARAMETERS -### -Identity -Name of the policy instance being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter > [!NOTE] > This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -101,7 +92,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -111,13 +101,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToPhone + +> Applicable: Microsoft Teams + 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 @@ -127,13 +119,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToUser + +> Applicable: Microsoft Teams + 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 @@ -143,13 +137,15 @@ Accept wildcard characters: False ``` ### -AllowCallGroups + +> Applicable: Microsoft Teams + 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 @@ -159,6 +155,9 @@ Accept wildcard characters: False ``` ### -AllowCallRedirect + +> Applicable: Microsoft Teams + Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway. Valid options are: @@ -171,7 +170,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -181,13 +179,15 @@ Accept wildcard characters: False ``` ### -AllowCloudRecordingForCalls + +> Applicable: Microsoft Teams + 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 @@ -197,13 +197,15 @@ Accept wildcard characters: False ``` ### -AllowDelegation + +> Applicable: Microsoft Teams + 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 @@ -213,6 +215,9 @@ Accept wildcard characters: False ``` ### -AllowPrivateCalling + +> Applicable: Microsoft Teams + 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. @@ -220,7 +225,6 @@ If you use Skype for Business for calling, this policy will not affect calling f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -230,13 +234,15 @@ Accept wildcard characters: False ``` ### -AllowSIPDevicesCalling + +> Applicable: Microsoft Teams + 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 @@ -246,13 +252,15 @@ Accept wildcard characters: False ``` ### -AllowTranscriptionForCalling + +> Applicable: Microsoft Teams + 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 @@ -262,6 +270,9 @@ Accept wildcard characters: False ``` ### -AllowVoicemail + +> Applicable: Microsoft Teams + Enables inbound calls to be routed to voicemail. Valid options are: @@ -274,7 +285,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -284,13 +294,15 @@ Accept wildcard characters: False ``` ### -AllowWebPSTNCalling + +> Applicable: Microsoft Teams + Allows PSTN calling from the Team web client. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -300,6 +312,9 @@ Accept wildcard characters: False ``` ### -AutoAnswerEnabledType + +> Applicable: Microsoft Teams + 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: @@ -311,7 +326,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -321,6 +335,9 @@ Accept wildcard characters: False ``` ### -BusyOnBusyEnabledType + +> Applicable: Microsoft Teams + 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: @@ -334,7 +351,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -344,6 +360,9 @@ Accept wildcard characters: False ``` ### -CallingSpendUserLimit + +> Applicable: Microsoft Teams + 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 @@ -352,7 +371,6 @@ Possible values: any positive integer Type: Long Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -361,13 +379,15 @@ Accept wildcard characters: False ``` ### -CallRecordingExpirationDays + +> Applicable: Microsoft Teams + 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 @@ -377,13 +397,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -393,18 +415,20 @@ Accept wildcard characters: False ``` ### -Copilot + +> Applicable: Microsoft Teams + 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. -- EnabledWithTranscript: Copilot will only work when transcription is enabled during calls. This is the default value. +- 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 @@ -414,13 +438,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + 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 @@ -430,6 +456,9 @@ Accept wildcard characters: False ``` ### -EnableSpendLimits + +> Applicable: Microsoft Teams + This setting allows an admin to enable or disable spend limits on PSTN calls for their user base. Possible values: @@ -441,7 +470,6 @@ Possible values: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: False @@ -465,13 +493,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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 @@ -480,7 +510,25 @@ 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 + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound federated calls should be routed. Valid options are: @@ -496,7 +544,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -506,6 +553,9 @@ Accept wildcard characters: False ``` ### -InboundPstnCallRoutingTreatment + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound PSTN calls should be routed. Valid options are: @@ -521,7 +571,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -531,6 +580,9 @@ Accept wildcard characters: False ``` ### -LiveCaptionsEnabledTypeForCalling + +> Applicable: Microsoft Teams + Determines whether real-time captions are available for the user in Teams calls. Valid options are: @@ -542,7 +594,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -552,6 +603,9 @@ Accept wildcard characters: False ``` ### -MusicOnHoldEnabledType + +> Applicable: Microsoft Teams + 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: @@ -564,7 +618,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -574,13 +627,15 @@ Accept wildcard characters: False ``` ### -PopoutAppPathForIncomingPstnCalls + +> Applicable: Microsoft Teams + 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: "" @@ -589,13 +644,15 @@ Accept wildcard characters: False ``` ### -PopoutForIncomingPstnCalls + +> Applicable: Microsoft Teams + 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 @@ -604,6 +661,9 @@ Accept wildcard characters: False ``` ### -PreventTollBypass + +> Applicable: Microsoft Teams + Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. > [!NOTE] @@ -613,7 +673,6 @@ Setting this parameter to True will send calls through PSTN and incur charges ra Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -622,7 +681,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RealTimeText + +> Applicable: Microsoft Teams + +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: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SpamFilteringEnabledType + +> Applicable: Microsoft Teams + Determines Spam filtering mode. Possible values: @@ -635,7 +719,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -646,6 +729,8 @@ Accept wildcard characters: False ### -VoiceSimulationInInterpreter +> Applicable: Microsoft Teams + >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -660,7 +745,27 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExplicitRecordingConsent + +This setting controls whether users must provide or obtain explicit consent before recording a 1:1 PSTN or Teams call. When enabled, both parties will receive a notification, and consent must be given before recording starts. + +Possible values: + +- **Enabled**: Requires users to give and obtain explicit consent before starting a call recording. +- **Disabled**: Users are not required to obtain explicit consent before recording starts. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -670,6 +775,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -677,7 +785,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -699,10 +806,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallingpolicy) -[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallingpolicy) -[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallingpolicy) -[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsChannelsPolicy.md similarity index 87% rename from teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsChannelsPolicy.md index e58f07ad06..c34f091af6 100644 --- a/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsChannelsPolicy.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamschannelspolicy applicable: Microsoft Teams -title: New-CsTeamsChannelsPolicy +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamschannelspolicy schema: 2.0.0 +title: New-CsTeamsChannelsPolicy --- # New-CsTeamsChannelsPolicy @@ -16,7 +18,7 @@ The CsTeamsChannelsPolicy allows you to manage features related to the Teams & C ``` New-CsTeamsChannelsPolicy [-Tenant ] [-AllowOrgWideTeamCreation ] [-EnablePrivateTeamDiscovery ] [-AllowPrivateChannelCreation ] - [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] + [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] [-ThreadedChannelCreation ] [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] [-Description ] [] ``` @@ -36,8 +38,8 @@ This example shows creating a new policy with name "StudentPolicy" where Private ## PARAMETERS -### -EnablePrivateTeamDiscovery -Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. +### -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](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml Type: Boolean @@ -51,13 +53,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowOrgWideTeamCreation +Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -66,10 +68,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Bypasses all non-fatal errors. +### -AllowPrivateChannelCreation +Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -80,26 +83,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy that you are creating. +### -AllowSharedChannelCreation +Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. ```yaml -Type: String -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 ``` -### -Tenant -Internal Microsoft use only. +### -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](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml -Type: System.Guid +Type: Boolean Parameter Sets: (All) Aliases: @@ -110,13 +113,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -125,11 +128,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOrgWideTeamCreation -Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. +### -Description +Specifies the description of the policy. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -140,8 +143,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateChannelCreation -Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. +### -EnablePrivateTeamDiscovery +Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml Type: Boolean @@ -155,11 +158,10 @@ Accept pipeline input: False 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](https://learn.microsoft.com/microsoftteams/teams-policies). - +### -Force +Bypasses all non-fatal errors. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -170,26 +172,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedChannelCreation -Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. +### -Identity +Specify the name of the policy that you are creating. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False 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](https://learn.microsoft.com/microsoftteams/teams-policies). +### -Tenant +Internal Microsoft use only. ```yaml -Type: Boolean +Type: System.Guid Parameter Sets: (All) Aliases: @@ -200,14 +202,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Specifies the description of the policy. +### -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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + Required: False Position: Named Default value: None @@ -230,10 +251,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamschannelspolicy) +[Set-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamschannelspolicy) -[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy) +[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamschannelspolicy) -[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy) +[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamschannelspolicy) -[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy) +[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamschannelspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication.md index a08b36dfb9..604a597600 100644 --- a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication +schema: 2.0.0 +title: New-CsTeamsComplianceRecordingApplication --- # New-CsTeamsComplianceRecordingApplication @@ -110,193 +111,161 @@ Please refer to the documentation of the ComplianceRecordingPairedApplications p ## PARAMETERS -### -Identity -A name that uniquely identifies the application instance of the policy-based recording application. +### -ComplianceRecordingPairedApplications +Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired 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. +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. -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: +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. -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. -### -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. +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: String -Parameter Sets: ParentAndRelativeKey +Type: ComplianceRecordingPairedApplication[] +Parameter Sets: (All) Aliases: -Required: True +Required: False 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. +### -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. -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: +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. -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +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. -### -RequiredBeforeMeetingJoin -Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. -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 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 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. +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: Boolean +Type: UInt32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: 1 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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: True +Default value: None 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. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None 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. +### -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: Boolean -Parameter Sets: (All) +Type: String +Parameter Sets: ParentAndRelativeKey Aliases: -Required: False +Required: True Position: Named -Default value: True +Default value: None 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. +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. +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. -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. +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: -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. +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -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. +### -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: UInt32 +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 1 +Default value: None 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. +### -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: ComplianceRecordingPairedApplication[] -Parameter Sets: (All) +Type: String +Parameter Sets: ParentAndRelativeKey Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -321,68 +290,100 @@ 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: +### -RequiredBeforeCallEstablishment +Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. -You can return your tenant ID by running this command: +If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. -Get-CsTenant | Select-Object DisplayName, TenantID +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: -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. +Required: False +Position: Named +Default value: True +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: System.Guid +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -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: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -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: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -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. +### -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: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: @@ -424,20 +425,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication.md similarity index 84% rename from teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication.md index d444f6ae79..293df49a22 100644 --- a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication +schema: 2.0.0 +title: New-CsTeamsComplianceRecordingPairedApplication --- # New-CsTeamsComplianceRecordingPairedApplication @@ -90,20 +91,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy.md similarity index 92% rename from teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy.md index e1caae78f9..6a73b4421d 100644 --- a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy.md @@ -1,12 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: New-CsTeamsComplianceRecordingPolicy --- # New-CsTeamsComplianceRecordingPolicy @@ -64,38 +66,36 @@ Any Microsoft Teams users who are assigned this policy will have their calls and ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new Teams recording policy. +### -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. -Use the "Global" Identity if you wish to assign this policy to the entire tenant. +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: XdsIdentity +Type: ComplianceRecordingApplication[] Parameter Sets: (All) Aliases: -Required: True -Position: 1 +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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -115,8 +115,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WarnUserOnRemoval -This parameter is reserved for future use. +### -CustomPromptsEnabled +Indicates whether compliance recording custom prompts feature is enabled for this tenant / user. ```yaml Type: Boolean @@ -125,13 +125,13 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None 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. +### -CustomPromptsPackageId +Reference to custom prompts package. ```yaml Type: String @@ -145,15 +145,11 @@ 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. +### -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: ComplianceRecordingApplication[] +Type: String Parameter Sets: (All) Aliases: @@ -179,8 +175,12 @@ 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. +### -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 @@ -194,22 +194,11 @@ 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. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -220,23 +209,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -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: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 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. +### -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 @@ -250,27 +242,37 @@ 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. +### -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: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomPromptsEnabled -Indicates whether compliance recording custom prompts feature is enabled for this tenant / user. +### -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: Boolean +Type: System.Guid Parameter Sets: (All) Aliases: @@ -281,17 +283,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomPromptsPackageId -Reference to custom prompts package. +### -WarnUserOnRemoval +This parameter is reserved for future use. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` @@ -327,20 +329,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCortanaPolicy.md similarity index 97% rename from teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCortanaPolicy.md index 247ea3b3a6..e4fa1420ed 100644 --- a/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscortanapolicy +schema: 2.0.0 +title: New-CsTeamsCortanaPolicy --- # New-CsTeamsCortanaPolicy diff --git a/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCustomBannerText.md similarity index 87% rename from teams/teams-ps/teams/New-CsTeamsCustomBannerText.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCustomBannerText.md index 4ed97c99b6..bd0911904e 100644 --- a/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCustomBannerText.md @@ -1,10 +1,11 @@ --- -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext -title: New-CsTeamsCustomBannerText -schema: 2.0.0 author: saleens7 +Locale: en-US +Module Name: MicrosoftTeams ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscustombannertext +schema: 2.0.0 +title: New-CsTeamsCustomBannerText --- # New-CsTeamsCustomBannerText @@ -36,14 +37,27 @@ This example creates an instance of TeamsCustomBannerText with the name CustomTe ## PARAMETERS +### -Description +The description that the global admin would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id + +> Applicable: Microsoft Teams + 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 @@ -62,17 +76,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -The description that the global admin would like to set to identify what this text represents. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -88,8 +91,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy.md similarity index 88% rename from teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy.md index 0cc06eb366..efdcfd97d1 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: New-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manger: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc, vaddank +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: New-CsTeamsEmergencyCallRoutingPolicy --- # New-CsTeamsEmergencyCallRoutingPolicy @@ -46,28 +48,28 @@ This example overrides the global emergency numbers from the global instance. ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the name of the policy. +### -AllowEnhancedEmergencyServices +Flag to enable Enhanced Emergency Services. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEnhancedEmergencyServices -Flag to enable Enhanced Emergency Services. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -92,7 +94,7 @@ Accept wildcard characters: False ``` ### -EmergencyNumbers -One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) cmdlet. +One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencynumber) cmdlet. ```yaml Type: Object @@ -106,29 +108,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity +The Identity parameter is a unique identifier that designates the name of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None 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 Required: False Position: Named @@ -152,12 +154,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy) -[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy) -[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) +[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencynumber) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification.md index 693ea5b9cd..8b038320b3 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingextendednotification schema: 2.0.0 +title: New-CsTeamsEmergencyCallingExtendedNotification --- # New-CsTeamsEmergencyCallingExtendedNotification @@ -50,8 +51,8 @@ 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. +### -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 @@ -65,8 +66,8 @@ 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. +### -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 @@ -111,6 +112,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy) -[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy.md similarity index 93% rename from teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy.md index 60f9db0fb7..e891bb4b26 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: New-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy schema: 2.0.0 +title: New-CsTeamsEmergencyCallingPolicy --- # New-CsTeamsEmergencyCallingPolicy @@ -60,16 +62,16 @@ New-CsTeamsEmergencyCallingPolicy -Identity ECP2 -Description "Test ECP2" -Exter ## PARAMETERS -### -Identity - The Identity parameter is a unique identifier that designates the name of the policy +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -139,6 +141,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + The Identity parameter is a unique identifier that designates the name of the policy + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NotificationDialOutNumber This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. @@ -202,21 +219,6 @@ Accept 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). @@ -232,12 +234,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy) -[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy) -[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy) -[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification) +[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingextendednotification) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyNumber.md similarity index 89% rename from teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyNumber.md index 9d89a4ced3..1745a5d46b 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyNumber.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber applicable: Microsoft Teams -title: New-CsTeamsEmergencyNumber author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc, pthota +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencynumber schema: 2.0.0 +title: New-CsTeamsEmergencyNumber --- # New-CsTeamsEmergencyNumber @@ -102,6 +104,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy) -[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEnhancedEncryptionPolicy.md similarity index 90% rename from teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEnhancedEncryptionPolicy.md index 94d8089d7a..41d1aec092 100644 --- a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEnhancedEncryptionPolicy.md @@ -1,189 +1,190 @@ ---- -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: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# New-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Use this cmdlet to create a new Teams enhanced encryption policy. - -## SYNTAX - -``` -New-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] - [[-Identity] ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Use this cmdlet to create a new Teams enhanced encryption policy. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -``` - -Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the default values to its settings. - -### EXAMPLE 2 -```PowerShell -PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -MeetingEndToEndEncryption DisabledUserOverride -``` - -Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the provided values to its settings. - -## PARAMETERS - -### -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 -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallingEndtoEndEncryptionEnabledType -Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingEndToEndEncryption -Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling Set-CsTeamsEnhancedEncryptionPolicy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: New-CsTeamsEnhancedEncryptionPolicy +--- + +# New-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Use this cmdlet to create a new Teams enhanced encryption policy. + +## SYNTAX + +``` +New-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] + [[-Identity] ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Use this cmdlet to create a new Teams enhanced encryption policy. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy +``` + +Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the default values to its settings. + +### EXAMPLE 2 +```PowerShell +PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -MeetingEndToEndEncryption DisabledUserOverride +``` + +Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the provided values to its settings. + +## PARAMETERS + +### -CallingEndtoEndEncryptionEnabledType +Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. + +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling Set-CsTeamsEnhancedEncryptionPolicy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingEndToEndEncryption +Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEventsPolicy.md similarity index 76% rename from teams/teams-ps/teams/New-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEventsPolicy.md index 66417ee5e3..bda9f1143f 100644 --- a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEventsPolicy.md @@ -1,373 +1,448 @@ ---- -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: 11/12/2024 ---- - -# New-CsTeamsEventsPolicy - -## SYNOPSIS -This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. - -## SYNTAX - -```powershell -New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-AllowTownhalls ] [-AllowEmailEditing ] [-Description ] -[-RecordingForTownhall ] [-RecordingForWebinar ] -[-TranscriptionForTownhall ] [-TranscriptionForWebinar ] [-AllowEventIntegrations ] [-TownhallChatExperience ] -[-UseMicrosoftECDN ] [-EventAccessType ] [-WhatIf] [-Confirm] [] -[-ImmersiveEvents ] -``` - -## DESCRIPTION -TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsEventsPolicy -Identity DisablePublicWebinars -AllowWebinars Enabled -EventAccessType EveryoneInCompanyExcludingGuests -``` - -The command shown in Example 1 creates a new per-user Teams Events policy with the Identity DisablePublicWebinars. This policy disables a user from creating public webinars. - -### Example 2 -```powershell -PS C:\> New-CsTeamsEventsPolicy -Identity DisableWebinars -AllowWebinars Disabled -``` - -The command shown in Example 2 creates a new per-user Teams Events policy with the Identity DisableWebinars. This policy disables a user from creating webinars. - -## PARAMETERS - -### -AllowWebinars -This setting governs if a user can create webinars using Teams Events. -Possible values are: - - **Enabled**: Enables creating webinars. - - **Disabled**: Disables creating webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseMicrosoftECDN -This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTownhalls -This setting governs if a user can create town halls using Teams Events. -Possible values are: - - **Enabled**: Enables creating town halls. - - **Disabled**: Disables creating town hall. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEmailEditing -This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. -Possible values are: - - **Enabled**: Enables editing of communication emails. - - **Disabled**: Disables editing of communication emails. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventAccessType -This setting governs which users can access the Town hall event and access the event registration page or the event site to register for a Webinar. It also governs which user type is allowed to join the session or sessions in the event for both event types. - -Possible values are: - - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - - - **EveryoneInCompanyExcludingGuests**: For Webinar - enables creating events to allow only in-tenant users to register and join the event. For Town hall - enables creating events to allow only in-tenant users to join the event (Note: for Town hall, in-tenant users include guests; this parameter will disable public Town halls). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Everyone -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedQuestionTypesInRegistrationForm -This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. - -Possible values are: DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedTownhallTypesForRecordingPublish -This setting governs which types of town halls can have their recordings published. - -Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedWebinarTypesForRecordingPublish -This setting governs which types of webinars can have their recordings published. - -Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordingForTownhall -Determines whether recording is allowed in a user's townhall. -Possible values are: - - **Enabled**: Allow recording in user's townhalls. - - **Disabled**: Prohibit recording in user's townhalls. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` -### -RecordingForWebinar -Determines whether recording is allowed in a user's webinar. -Possible values are: - - **Enabled**: Allow recording in user's webinars. - - **Disabled**: Prohibit recording in user's webinars. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` -### -TranscriptionForTownhall -Determines whether transcriptions are allowed in a user's townhall. -Possible values are: - - **Enabled**: Allow transcriptions in user's townhalls. - - **Disabled**: Prohibit transcriptions in user's townhalls. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` -### -TranscriptionForWebinar -Determines whether transcriptions are allowed in a user's webinar. -Possible values are: - - **Enabled**: Allow transcriptions in user's webinars. - - **Disabled**: Prohibit transcriptions in user's webinars. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmersiveEvents -This setting governs if a user can create Immersive Events using Teams Events. -Possible values are: - - **Enabled**: Enables creating Immersive Events. - - **Disabled**: Disables creating Immersive Events. - -```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 -``` - -### -Confirm -The Confirm switch does not work with this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch does not work with this cmdlet. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.date: 04/23/2025 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamseventspolicy +schema: 2.0.0 +title: New-CsTeamsEventsPolicy +--- + +# New-CsTeamsEventsPolicy + +## SYNOPSIS +This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. + +## SYNTAX + +```powershell +New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-AllowTownhalls ] [-ImmersiveEvents ] [-AllowEmailEditing ] [-Description ] +[-TownhallEventAttendeeAccess ] [-RecordingForTownhall ] [-RecordingForWebinar ] +[-TranscriptionForTownhall ] [-TranscriptionForWebinar ] [-AllowEventIntegrations ] [-TownhallChatExperience ] +[-UseMicrosoftECDN ] [-EventAccessType ] [-BroadcastPremiumApps ] [-MaxResolutionForTownhall ] [-HighBitrateForTownhall ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsEventsPolicy -Identity DisablePublicWebinars -AllowWebinars Enabled -EventAccessType EveryoneInCompanyExcludingGuests +``` + +The command shown in Example 1 creates a new per-user Teams Events policy with the Identity DisablePublicWebinars. This policy disables a user from creating public webinars. + +### Example 2 +```powershell +PS C:\> New-CsTeamsEventsPolicy -Identity DisableWebinars -AllowWebinars Disabled +``` + +The command shown in Example 2 creates a new per-user Teams Events policy with the Identity DisableWebinars. This policy disables a user from creating webinars. + +## PARAMETERS + +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. + +Possible values are: DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTownhallTypesForRecordingPublish +This setting governs which types of town halls can have their recordings published. + +Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedWebinarTypesForRecordingPublish +This setting governs which types of webinars can have their recordings published. + +Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailEditing +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. +Possible values are: + - **Enabled**: Enables editing of communication emails. + - **Disabled**: Disables editing of communication emails. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -AllowTownhalls +This setting governs if a user can create town halls using Teams Events. +Possible values are: + - **Enabled**: Enables creating town halls. + - **Disabled**: Disables creating town hall. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWebinars +This setting governs if a user can create webinars using Teams Events. +Possible values are: + - **Enabled**: Enables creating webinars. + - **Disabled**: Disables creating webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastPremiumApps +This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. + +Possible values are: +- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall +- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventAccessType +This setting governs which users can access the Town hall event and access the event registration page or the event site to register for a Webinar. It also governs which user type is allowed to join the session or sessions in the event for both event types. + +Possible values are: + - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + + - **EveryoneInCompanyExcludingGuests**: For Webinar - enables creating events to allow only in-tenant users to register and join the event. For Town hall - enables creating events to allow only in-tenant users to join the event (Note: for Town hall, in-tenant users include guests; this parameter will disable public Town halls). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmersiveEvents +This setting governs if a user can create Immersive Events using Teams Events. +Possible values are: + - **Enabled**: Enables creating Immersive Events. + - **Disabled**: Disables creating Immersive Events. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +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 +``` +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -UseMicrosoftECDN +This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxResolutionForTownhall +This policy sets the maximum video resolution supported in Town hall events. + +Possible values are: +- **Max720p**: Town halls support video resolution up to 720p. +- **Max1080p**: Town halls support video resolution up to 1080p. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Max1080p +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighBitrateForTownhall +This policy controls whether high-bitrate streaming is enabled for Town hall events. + +Possible values are: +- **Enabled**: Enables high bitrate for Town hall events. +- **Disabled**: Disables high bitrate for Town hall events. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -WhatIf +The WhatIf switch does not work with this cmdlet. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFeedbackPolicy.md similarity index 97% rename from teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsFeedbackPolicy.md index 97eb4b84ce..3101cf4a4c 100644 --- a/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFeedbackPolicy.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsfeedbackpolicy applicable: Microsoft Teams -title: New-CsTeamsFeedbackPolicy +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsfeedbackpolicy schema: 2.0.0 +title: New-CsTeamsFeedbackPolicy --- # New-CsTeamsFeedbackPolicy @@ -33,14 +35,13 @@ In this example, we create a feedback policy called New Hire Feedback Policy and ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowEmailCollection +Set this to TRUE to enable Email collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf - +Aliases: Required: False Position: Named Default value: None @@ -48,14 +49,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppress all non-fatal errors. +### -AllowLogCollection +Set this to TRUE to enable log collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -63,28 +63,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -A unique identifier. +### -AllowScreenshotCollection +Set this to TRUE to enable Screenshot collection. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: - Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -The InMemory parameter creates an object reference without actually committing the object as a permanent change. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -93,31 +92,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiveSurveysMode -Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. - -Possible values: - - Enabled - - Disabled - - EnabledUserOverride +### -EnableFeatureSuggestions + This setting will enable Tenant Admins to hide or show the Teams menu item “Help | Suggest a Feature”. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -Force +Suppress all non-fatal errors. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -128,33 +122,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserInitiatedMode - Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. - Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. - - Possible values: - - Enabled - - Disabled +### -Identity +A unique identifier. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: Enabled +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEmailCollection -Set this to TRUE to enable Email collection. +### -InMemory +The InMemory parameter creates an object reference without actually committing the object as a permanent change. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -162,27 +152,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowLogCollection -Set this to TRUE to enable log collection. +### -ReceiveSurveysMode +Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. + +Possible values: + - Enabled + - Disabled + - EnabledUserOverride ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: + Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowScreenshotCollection -Set this to TRUE to enable Screenshot collection. +### -Tenant +Internal Microsoft use only. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -190,17 +187,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”. +### -UserInitiatedMode + Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. + Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. + + Possible values: + - Enabled + - Disabled ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFilesPolicy.md similarity index 84% rename from teams/teams-ps/teams/New-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsFilesPolicy.md index dca829ac76..02cdf64b03 100644 --- a/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFilesPolicy.md @@ -1,24 +1,23 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy -title: New-CsTeamsFilesPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsfilespolicy schema: 2.0.0 +title: New-CsTeamsFilesPolicy --- # 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] [] + [-DefaultFileUploadAppId ] [-FileSharingInChatswithExternalUsers ] [-AutoShareFilesInExternalChats ] + [-Identity] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,24 +35,25 @@ The command shown in Example 1 creates a per-user teams files policy CustomTeams ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -AutoShareFilesInExternalChats + +Indicates if file scope will be changed automatically when sharing files and loops in chats with external or guest users. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named 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. +### -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) @@ -64,11 +64,11 @@ 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. +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. ```yaml Type: String @@ -98,10 +98,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileSharingInChatswithExternalUsers +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. -Indicates if file sharing in chats with external users is enabled. +```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) @@ -112,6 +126,7 @@ Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False + ``` ### -SPChannelFilesTab @@ -158,11 +173,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenMeetingTemplate.md similarity index 60% rename from teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenMeetingTemplate.md index afae69de7e..3178bb17d8 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenMeetingTemplate.md @@ -1,17 +1,18 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: New-CsTeamsHiddenMeetingTemplate -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsHiddenMeetingTemplate +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsTeamsHiddenMeetingTemplate schema: 2.0.0 +title: New-CsTeamsHiddenMeetingTemplate --- # New-CsTeamsHiddenMeetingTemplate ## SYNOPSIS -This cmdlet is used to create a `HiddenMeetingTemplate` object for use with the [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) and [Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) cmdlets. +This cmdlet is used to create a `HiddenMeetingTemplate` object. ## SYNTAX @@ -21,7 +22,9 @@ New-CsTeamsHiddenMeetingTemplate -Id [] ## DESCRIPTION -Creates an object that can be supplied as `HiddenMeetingTemplate` to the [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) and [Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) cmdlets. +Creates an object that can be supplied as `HiddenMeetingTemplate` to the +[New-CsTeamsMeetingTemplatePermissionPolicy](new-csteamsmeetingtemplatepermissionpolicy.md) and +[Set-CsTeamsMeetingTemplatePermissionPolicy](set-csteamsmeetingtemplatepermissionpolicy.md) cmdlets. ## EXAMPLES @@ -35,19 +38,20 @@ 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](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy). +For more examples of how this can be used, see the examples for [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy). ## PARAMETERS ### -Id +> Applicable: Microsoft Teams + ID of the meeting template to hide. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -65,8 +69,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy) -[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenTemplate.md similarity index 61% rename from teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenTemplate.md index 5df0f7b450..e706e97cba 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenTemplate.md @@ -1,20 +1,19 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate -title: New-CsTeamsHiddenTemplate author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddentemplate schema: 2.0.0 +title: New-CsTeamsHiddenTemplate --- # New-CsTeamsHiddenTemplate ## SYNOPSIS -This cmdlet is used to create a `HiddenTemplate` object for use with the [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) and [Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) cmdlets. - +This cmdlet is used to create a `HiddenTemplate` object. ## SYNTAX ``` @@ -22,7 +21,7 @@ New-CsTeamsHiddenTemplate -Id [] ``` ## DESCRIPTION -Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) and [Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) cmdlets. +Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTemplatePermissionPolicy](new-csteamstemplatepermissionpolicy.md) and [Set-CsTeamsTemplatePermissionPolicy](set-csteamstemplatepermissionpolicy.md) cmdlets. ## EXAMPLES @@ -31,7 +30,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](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy). +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/microsoftteams/new-csteamstemplatepermissionpolicy). ## PARAMETERS @@ -64,6 +63,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy) -[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsIPPhonePolicy.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsIPPhonePolicy.md index 93cdfa7a78..42de78fea6 100644 --- a/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsipphonepolicy schema: 2.0.0 +title: New-CsTeamsIPPhonePolicy --- # New-CsTeamsIPPhonePolicy @@ -50,21 +51,6 @@ This example shows a new policy being created called "CommonAreaPhone" setting t ## 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: @@ -179,6 +165,21 @@ 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. diff --git a/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMediaConnectivityPolicy.md similarity index 85% rename from teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMediaConnectivityPolicy.md index 3f141907b4..dcd649f436 100644 --- a/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: runli +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +title: New-CsTeamsMediaConnectivityPolicy --- # New-CsTeamsMediaConnectivityPolicy @@ -38,30 +39,30 @@ The newly created policy with value will be printed on success. ## PARAMETERS -### -Identity -Identity of the Teams media connectivity policy. +### -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: True +Required: False 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. +### -Identity +Identity of the Teams media connectivity policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -78,10 +79,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy) -[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy) -[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy) -[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy.md similarity index 92% rename from teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy.md index 6a2c7ee7cd..6f95d151b3 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy schema: 2.0.0 title: New-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # New-CsTeamsMeetingBrandingPolicy @@ -43,14 +43,13 @@ In this example, the command will create an empty meeting branding policy with t ## PARAMETERS -### -DefaultTheme -*This parameter is reserved for Microsoft internal use only.* -Identity of default meeting theme. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -59,11 +58,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingBackgroundImages -Enable custom meeting backgrounds. +### -DefaultTheme +*This parameter is reserved for Microsoft internal use only.* +Identity of default meeting theme. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -74,8 +74,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingOptionsThemeOverride -Allow organizer to control meeting theme. +### -EnableMeetingBackgroundImages +Enable custom meeting backgrounds. ```yaml Type: Boolean @@ -89,28 +89,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Identity of meeting branding policy that will be created. +### -EnableMeetingOptionsThemeOverride +Allow organizer to control meeting theme. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingBackgroundImages -*This parameter is reserved for Microsoft internal use only.* -List of meeting background images. -Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. +### -EnableNdiAssuranceSlate +This enables meeting Network Device Interface Assurance Slate branding. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) Aliases: @@ -121,13 +119,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingBrandingThemes -*This parameter is reserved for Microsoft internal use only.* -List of meeting branding themes. -Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -138,26 +134,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNdiAssuranceSlate -This enables meeting Network Device Interface Assurance Slate branding. +### -Identity +Identity of meeting branding policy that will be created. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 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. +### -MeetingBackgroundImages +*This parameter is reserved for Microsoft internal use only.* +List of meeting background images. +Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.NdiAssuranceSlate] +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -168,11 +166,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireBackgroundEffect -This mandates a meeting background for participants. +### -MeetingBrandingThemes +*This parameter is reserved for Microsoft internal use only.* +List of meeting branding themes. +Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -183,13 +183,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -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: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.NdiAssuranceSlate] Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -198,11 +198,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -RequireBackgroundEffect +This mandates a meeting background for participants. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -241,12 +241,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy.md similarity index 90% rename from teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy.md index 898cfcd848..ebde7b3258 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: New-CsTeamsMeetingBroadcastPolicy --- # New-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS - -New-CsTeamsMeetingBroadcastPolicy \[-Identity\] \ \[-Tenant \\] \[-Description \\] \[-AllowBroadcastScheduling \\] \[-AllowBroadcastTranscription \\] \[-BroadcastAttendeeVisibilityMode \\] \[-BroadcastRecordingMode \\] \[-InMemory\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] +Use this cmdlet to create a new policy. ## SYNTAX @@ -26,7 +27,7 @@ New-CsTeamsMeetingBroadcastPolicy [-Tenant ] [-Description ] ``` ## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to create a new policy. +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## EXAMPLES diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingPolicy.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingPolicy.md index 2dfc6e1ece..de4222da63 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingPolicy.md @@ -1,23 +1,24 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingpolicy +Locale: en-US +manager: bulenteg Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: New-CsTeamsMeetingPolicy +ms.date: 02/26/2025 +ms.reviewer: alejandramu +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingpolicy schema: 2.0.0 -manager: bulenteg -ms.reviewer: wblocker -ms.date: 11/12/2024 +title: New-CsTeamsMeetingPolicy --- # 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. +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. ## SYNTAX -```powershell +``` New-CsTeamsMeetingPolicy [-Identity] [-AIInterpreter ] [-AllowAnonymousUsersToDialOut ] @@ -119,6 +120,9 @@ New-CsTeamsMeetingPolicy [-Identity] [-WatermarkForCameraVideoPattern ] [-WatermarkForScreenSharingOpacity ] [-WatermarkForScreenSharingPattern ] + [-AllowedUsersForMeetingDetails ] + [-RealTimeText ] + [-ParticipantSlideControl ] [-WhatIf] [-WhoCanRegister ] [] @@ -127,10 +131,9 @@ New-CsTeamsMeetingPolicy [-Identity] ## DESCRIPTION The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. -The 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 ``` @@ -138,7 +141,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 ``` @@ -149,22 +152,10 @@ All other policy properties will use the default values. ## PARAMETERS -### -Identity -Specify the name of the policy being created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -179,7 +170,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -188,11 +178,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsersToDialOut -Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to #prohibit anonymous users from dialing out. - -> [!NOTE] -> This parameter is temporarily disabled. +### -AllowAnnotations +This setting will allow admins to choose which users will be able to use the Annotation feature. ```yaml Type: Boolean @@ -206,12 +193,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsersToJoinMeeting +### -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] -> 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. +> This parameter is temporarily disabled. ```yaml Type: Boolean @@ -220,13 +206,17 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsersToStartMeeting -Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting +### -AllowAnonymousUsersToJoinMeeting + +> [!NOTE] +> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check for details. + +Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting. ```yaml Type: Boolean @@ -235,13 +225,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: True 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. +### -AllowAnonymousUsersToStartMeeting +Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting ```yaml Type: Boolean @@ -370,6 +360,25 @@ 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 +``` + ### -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. @@ -386,6 +395,25 @@ 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 +``` + ### -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. @@ -498,21 +526,6 @@ 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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: TRUE -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowMeetingCoach This setting will allow admins to allow users the option of turning on Meeting Coach during meetings, which provides users with private personalized feedback on their communication and inclusivity. If set to True, then users will see and be able to click the option for turning on Meeting Coach during calls. If set to False, then users will not have the option to turn on Meeting Coach during calls. @@ -563,6 +576,21 @@ 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. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowNDIStreaming This parameter is reserved for internal Microsoft use. @@ -623,8 +651,8 @@ 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. +### -AllowParticipantGiveRequestControl +Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting ```yaml Type: Boolean @@ -633,13 +661,13 @@ Aliases: Required: False Position: Named -Default value: TRUE +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowParticipantGiveRequestControl -Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting +### -AllowPowerPointSharing +Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit ```yaml Type: Boolean @@ -653,8 +681,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 +### -AllowPrivateMeetingScheduling +Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -668,8 +696,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetingScheduling -Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. +### -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: Boolean @@ -678,7 +706,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: TRUE Accept pipeline input: False Accept wildcard characters: False ``` @@ -837,8 +865,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForScreenSharing -This setting allows scheduling meetings with watermarking for screen sharing enabled. +### -AllowWatermarkForCameraVideo +This setting allows scheduling meetings with watermarking for video enabled. ```yaml Type: Boolean @@ -852,8 +880,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForCameraVideo -This setting allows scheduling meetings with watermarking for video enabled. +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermarking for screen sharing enabled. ```yaml Type: Boolean @@ -882,25 +910,6 @@ 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. @@ -1051,18 +1060,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectToMeetingControls -Allows external connections of thirdparty apps to Microsoft Teams - -Possible values are: - -Enabled -Disabled +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -1071,13 +1075,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -ConnectToMeetingControls +Allows external connections of thirdparty apps to Microsoft Teams + +Possible values are: + +Enabled +Disabled ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -1210,7 +1219,7 @@ Accept wildcard characters: False ### -ExplicitRecordingConsent Set participant agreement and notification for Recording, Transcript, Copilot in Teams meetings. -Possible Values: +Possible Values: - Enabled: Explicit consent, requires participant agreement. - Disabled: Implicit consent, does not require participant agreement. @@ -1262,6 +1271,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Specify the name of the policy being created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InfoShownInReportMode This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. @@ -1322,13 +1346,8 @@ 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. +### -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 @@ -1342,8 +1361,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. +### -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 @@ -1431,6 +1455,9 @@ Accept wildcard characters: False ``` ### -MeetingInviteLanguages + +> Applicable: Microsoft Teams + 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] @@ -1444,7 +1471,6 @@ The preliminary list of available languages is shown below: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1473,6 +1499,8 @@ Accept wildcard characters: False ### -NoiseSuppressionForDialInParticipants +> Applicable: Microsoft Teams + >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1488,7 +1516,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1514,6 +1541,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParticipantSlideControl + +> Applicable: Microsoft Teams + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Determines whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibited from giving control, or being given control, in a meeting. + +Possible Values: +- Everyone: Anyone in the meeting can give or take control +- EveryoneInOrganization: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control +- EveryoneInOrganizationAndGuests: Only those who are Guests to the tenant, MTO users, and internal AAD users can give or take control +- None: No one in the meeting can give or take control + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +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. @@ -1544,6 +1598,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RealTimeText + +> Applicable: Microsoft Teams + +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: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecordingStorageMode This parameter can take two possible values: @@ -1770,6 +1846,8 @@ Accept wildcard characters: False ### -VoiceSimulationInInterpreter +> Applicable: Microsoft Teams + > [!NOTE] > This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1784,7 +1862,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 78% rename from teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingTemplatePermissionPolicy.md index 48a5347d44..c8392699c3 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: New-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMeetingTemplatePermissionPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: New-CsTeamsMeetingTemplatePermissionPolicy --- # New-CsTeamsMeetingTemplatePermissionPolicy @@ -20,7 +21,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](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplateconfiguration) and [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsfirstpartymeetingtemplateconfiguration) 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/microsoftteams/get-csteamsmeetingtemplateconfiguration) and [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfirstpartymeetingtemplateconfiguration) respectively. ## EXAMPLES @@ -44,15 +45,16 @@ Description : This is a test policy ## PARAMETERS -### -Identity +### -Description -Name of the new policy instance to be created. +> Applicable: Microsoft Teams + +Description of the new policy instance to be created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -62,14 +64,15 @@ Accept wildcard characters: False ### -HiddenMeetingTemplates +> Applicable: Microsoft Teams + The list of meeting template IDs to hide. -The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddenmeetingtemplate). ```yaml Type: HiddenMeetingTemplate[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -77,15 +80,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Description of the new policy instance to be created. +> Applicable: Microsoft Teams + +Name of the new policy instance to be created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -103,12 +107,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate) +[New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddenmeetingtemplate) -[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy) -[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMessagingPolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMessagingPolicy.md index 378a1cc6b7..3efbfe0e8b 100644 --- a/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMessagingPolicy.md @@ -1,9 +1,11 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmessagingpolicy schema: 2.0.0 +title: New-CsTeamsMessagingPolicy --- # New-CsTeamsMessagingPolicy @@ -55,6 +57,9 @@ New-CsTeamsMessagingPolicy [[-Identity] ] [-InOrganizationChatControl ] [-ReadReceiptsEnabledType ] [-Tenant ] + [-UsersCanDeleteBotMessages ] + [-AutoShareFilesInExternalChats ] + [-UseB2BInvitesToAddExternalUsers ] [] [-WhatIf] ``` @@ -74,20 +79,6 @@ 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 @@ -647,6 +638,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique identifier for the teams messaging policy to be created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -InMemory Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. @@ -715,6 +720,60 @@ 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 +``` + +### -UseB2BInvitesToAddExternalUsers + +Indicates whether B2B invites should be used to add external users when necessary. + +Possible values: + +- `Enabled`: External users will be added using B2B invites. +- `Disabled`: External users will not be added using B2B invites. + +```yaml +Type: System.String +Parameter Sets: (All) +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShareFilesInExternalChats + +Determines whether files are automatically shared in external chats. + +Possible values: + +- `Enabled`: Files are automatically shared in external chats. +- `Disabled`: Files are not automatically shared in external chats. + +```yaml +Type: System.String +Parameter Sets: (All) +Required: False +Position: Named +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. @@ -745,10 +804,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingpolicy) +[Set-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmessagingpolicy) -[Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy) +[Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmessagingpolicy) -[Grant-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmessagingpolicy) +[Grant-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmessagingpolicy) -[Remove-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmessagingpolicy) +[Remove-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmessagingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMobilityPolicy.md similarity index 96% rename from teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMobilityPolicy.md index 8bd31ac80b..0388da6660 100644 --- a/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmobilitypolicy +schema: 2.0.0 +title: New-CsTeamsMobilityPolicy --- # New-CsTeamsMobilityPolicy @@ -82,6 +84,21 @@ 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 +``` + ### -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. @@ -112,16 +129,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy that you are creating. +### -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: XdsIdentity +Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -143,22 +161,6 @@ 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). diff --git a/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy.md similarity index 97% rename from teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy.md index 54b53972d8..f75b17c907 100644 --- a/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsnetworkroamingpolicy schema: 2.0.0 +title: New-CsTeamsNetworkRoamingPolicy --- # New-CsTeamsNetworkRoamingPolicy @@ -50,63 +50,63 @@ The command shown in Example 2 creates a new teams network roaming policy with ## PARAMETERS -### -Identity -Unique identifier of the policy to be created. +### -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: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPVideo -Determines whether video is enabled in a user's meetings or calls. -Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. +### -Description +Description of the new policy to be created. ```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 ``` -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings. +### -Identity +Unique identifier of the policy to be created. ```yaml -Type: Integer +Type: XdsIdentity Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 50000 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the new policy to be created. +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. ```yaml -Type: String +Type: Integer Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: 50000 Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/MicrosoftTeams/New-CsTeamsPersonalAttendantPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsPersonalAttendantPolicy.md new file mode 100644 index 0000000000..a2a437a166 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsPersonalAttendantPolicy.md @@ -0,0 +1,295 @@ +--- +applicable: Microsoft Teams +author: juliiva +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: jomarque +Module Name: MicrosoftTeams +ms.author: juliiva +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamspersonalattendantpolicy +schema: 2.0.0 +title: New-CsTeamsPersonalAttendantPolicy +--- + +# New-CsTeamsPersonalAttendantPolicy + +## SYNOPSIS + +**Limited Preview:** Functionality described in this document is currently in limited preview and only authorized organizations have access. + +Use this cmdlet to create a new instance of a Teams Personal Attendant Policy. + +## SYNTAX + +``` +New-CsTeamsPersonalAttendantPolicy [-Identity ] [-PersonalAttendant ] [-CallScreening ] [-CalendarBookings ] [-InboundInternalCalls ] [-InboundFederatedCalls ] [-InboundPSTNCalls ] [-AutomaticTranscription ] [-AutomaticRecording ] [-Confirm] [-Force] [-WhatIf] [] +``` + +## DESCRIPTION +The Teams Personal Attendant Policy controls personal attendant and its functionalities available to users in Microsoft Teams. This cmdlet allows admins to create new policy instances. + +## EXAMPLES + +### Example 1 +``` +New-CsTeamsPersonalAttendantPolicy -Identity SalesPersonalAttendantPolicy -CallScreening Enabled +``` + +The cmdlet create the policy instance SalesPersonalAttendantPolicy and sets the value of the parameter CallScreening to Enabled. 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: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersonalAttendant +Enables the user to use the personal attendant + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallScreening +Enables the user to use the personal attendant call context evaluation features + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarBookings +Enables the user to use the personal attendant calendar related features + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundInternalCalls +Enables the user to use the personal attendant for incoming domain calls + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundFederatedCalls +Enables the user to use the personal attendant for incoming calls from other domains + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundPSTNCalls +Enables the user to use the personal attendant for incoming PSTN calls + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticTranscription +Enables the user to use the automatic storing of personal attendant call transcriptions + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticRecording +Enables the user to use the automatic storing of personal attendant call recordings + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept 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: False +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 + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +The cmdlet is available in Teams PowerShell module 7.2.1-preview or later. + +## RELATED LINKS + +[Get-CsTeamsPersonalAttendantPolicy](./get-csteamspersonalattendantpolicy.md) + +[Set-CsTeamsPersonalAttendantPolicy](./set-csteamspersonalattendantpolicy.md) + +[Grant-CsTeamsPersonalAttendantPolicy](./grant-csteamspersonalattendantpolicy.md) + +[Remove-CsTeamsPersonalAttendantPolicy](./remove-csteamspersonalattendantpolicy.md) diff --git a/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRecordingRollOutPolicy.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsRecordingRollOutPolicy.md index be3f26d1a2..2494dadd08 100644 --- a/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams ms.author: ronwa +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsrecordingrolloutpolicy +schema: 2.0.0 +title: New-CsTeamsRecordingRollOutPolicy --- # New-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 93% rename from teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsRoomVideoTeleConferencingPolicy.md index ad5c601ece..39da8904d1 100644 --- a/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,225 +1,228 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: New-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# New-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Creates a new TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +``` +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). + +## EXAMPLES + +## 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/MicrosoftTeams/New-CsTeamsSharedCallingRoutingPolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsSharedCallingRoutingPolicy.md index 1b61b77f9d..cb745646ea 100644 --- a/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy applicable: Microsoft Teams author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: -title: New-CsTeamsSharedCallingRoutingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy schema: 2.0.0 +title: New-CsTeamsSharedCallingRoutingPolicy --- # New-CsTeamsSharedCallingRoutingPolicy @@ -49,17 +48,20 @@ 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. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -102,69 +104,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceAccount -The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. +### -Force -The phone number assigned to the resource account must: -- Have the same phone number type and country as the emergency numbers configured in this policy instance. -- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. -- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. +> Applicable: Microsoft Teams -The same resource account can be used in multiple shared calling policy instances. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity +Unique identifier of the Teams shared calling routing policy to be created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False -Position: Named -Default value: False +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. +### -ResourceAccount +The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. + +The phone number assigned to the resource account must: +- Have the same phone number type and country as the emergency numbers configured in this policy instance. +- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) and the -LocationId parameter to set the location. +- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. + +The same resource account can be used in multiple shared calling policy instances. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -190,12 +195,12 @@ Shared Calling is not supported for Calling Plan service phone numbers in Romani This cmdlet was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS -[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy) -[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy) -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnection.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnection.md index f09cf35e77..a974b03ef3 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection schema: 2.0.0 +title: New-CsTeamsShiftsConnection --- # New-CsTeamsShiftsConnection @@ -128,6 +129,21 @@ TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ## PARAMETERS +### -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 +``` + ### -Body The request body. @@ -159,23 +175,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId -The WFM connector ID. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: NewExpanded -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connection name. +### -ConnectorId +The WFM connector ID. ```yaml Type: String @@ -204,13 +220,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline ```yaml -Type: SwitchParameter +Type: SendAsyncStep[] Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -219,8 +235,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline ```yaml Type: SendAsyncStep[] @@ -234,15 +250,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -Name +The connection name. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -324,21 +340,6 @@ 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). @@ -356,12 +357,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnection) -[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnection) -[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector) +[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionconnector) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionBatchTeamMap.md similarity index 89% rename from teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionBatchTeamMap.md index 0dcfcf6db0..4932e4be78 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionBatchTeamMap.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnectionBatchTeamMap -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectionbatchteammap schema: 2.0.0 +title: New-CsTeamsShiftsConnectionBatchTeamMap --- # New-CsTeamsShiftsConnectionBatchTeamMap @@ -23,7 +24,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](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation). +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/microsoftteams/get-csteamsshiftsconnectionoperation). ## EXAMPLES @@ -55,13 +56,14 @@ Sends 2 team mappings: one maps the Teams team with ID `eddc3b94-21d5-4ef0-a76a- ### -ConnectorInstanceId +> Applicable: Microsoft Teams + The connection instance ID used to map teams. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -71,13 +73,14 @@ Accept wildcard characters: False ### -TeamMapping +> Applicable: Microsoft Teams + The Teams mapping object list. ```yaml Type: TeamMap[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -97,4 +100,4 @@ Please check the example section for the format of TeamMap. ## RELATED LINKS -[Get-CsTeamsShiftsConnectionOperation](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation) +[Get-CsTeamsShiftsConnectionOperation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionoperation) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionInstance.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionInstance.md index 9570c08ad4..ea7bc5e45f 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: leonardospina external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnectionInstance -author: leonardospina ms.author: lespina -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance schema: 2.0.0 +title: New-CsTeamsShiftsConnectionInstance --- # New-CsTeamsShiftsConnectionInstance @@ -140,29 +141,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorAdminEmail -Gets or sets the list of connector admin email addresses. +### -ConnectionId +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). ```yaml -Type: String[] +Type: String Parameter Sets: NewExpanded Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId -Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -ConnectorAdminEmail +Gets or sets the list of connector admin email addresses. ```yaml -Type: String +Type: String[] Parameter Sets: NewExpanded Aliases: -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False @@ -183,36 +184,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Name +The connector instance name. ```yaml Type: String @@ -225,50 +226,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". - +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: Uri +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioSwapRequest -The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String @@ -281,11 +281,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -SyncFrequencyInMin +The sync frequency in minutes. ```yaml -Type: String +Type: Int32 Parameter Sets: NewExpanded Aliases: Required: True @@ -295,8 +295,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -309,36 +309,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True 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. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connector instance name. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -351,49 +351,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -SyncScenarioSwapRequest +The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + ```yaml -Type: Uri -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True 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. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: PSCredential -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -406,11 +407,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin -The sync frequency in minutes. +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Int32 +Type: String Parameter Sets: NewExpanded Aliases: Required: True @@ -452,12 +453,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance) -[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector) +[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionconnector) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsPolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsPolicy.md index 57a7c3e428..c44da9fe74 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsPolicy.md @@ -1,228 +1,243 @@ ---- -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 ---- - -# New-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. - -## SYNTAX - -```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 -```powershell -PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -``` - -Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the default values to its settings. - -### Example 2 -```powershell -PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false -``` - -Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. - -## PARAMETERS - -### -Identity -Policy instance name. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessType -Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. -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) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: UnrestrictedAccess_TeamsApp -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeFrequency -Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. - -```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 -``` - -### -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. -'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. -'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. -'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. -'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. -'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. -'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. -'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. -'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. -'CustomMessage' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: DefaultMessage -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageCustom -Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. - -```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 -``` - -### -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) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableScheduleOwnerPermissions -Indicates whether a user can manage a Shifts schedule as a team member. - -```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 -``` - -### -Confirm -Prompts you for confirmation before running the 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 - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-teamsshiftspolicy +schema: 2.0.0 +title: New-CsTeamsShiftsPolicy +--- + +# New-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. + +## SYNTAX + +```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 +```powershell +PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always +``` + +Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the default values to its settings. + +### Example 2 +```powershell +PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false +``` + +Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. + +## PARAMETERS + +### -AccessGracePeriodMinutes + +> Applicable: Microsoft Teams + +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) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessType + +> Applicable: Microsoft Teams + +Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. +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) +Aliases: +Required: False +Position: Named +Default value: UnrestrictedAccess_TeamsApp +Accept 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 +``` + +### -EnableScheduleOwnerPermissions + +> Applicable: Microsoft Teams + +Indicates whether a user can manage a Shifts schedule as a team member. + +```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 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 + +> Applicable: Microsoft Teams + +Policy instance name. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeFrequency + +> Applicable: Microsoft Teams + +Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageCustom + +> Applicable: Microsoft Teams + +Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageType + +> Applicable: Microsoft Teams + +The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. +'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. +'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. +'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. +'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. +'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. +'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. +'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. +'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. +'CustomMessage' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: DefaultMessage +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -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-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftspolicy) + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliance.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliance.md index e4ca073509..e7313c7241 100644 --- a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliance.md @@ -1,160 +1,165 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssurvivablebranchappliance +schema: 2.0.0 +title: New-CsTeamsSurvivableBranchAppliance +--- + +# New-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Creates a new Survivable Branch Appliance (SBA) object in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +New-CsTeamsSurvivableBranchAppliance [-Identity] [-Description ] [-Site ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey + +``` +New-CsTeamsSurvivableBranchAppliance [-Description ] [-Site ] + [-MsftInternalProcessingMode ] -Fqdn [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +## 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/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliancePolicy.md index 4fe55cb48c..f8af4e76c3 100644 --- a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,119 +1,124 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: New-CsTeamsSurvivableBranchAppliancePolicy +--- + +# New-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Creates a new Survivable Branch Appliance (SBA) policy object in the tenant. + +## SYNTAX + +```powershell +New-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-BranchApplianceFqdns ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +## 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/MicrosoftTeams/New-CsTeamsTemplatePermissionPolicy.md similarity index 86% rename from teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsTemplatePermissionPolicy.md index 88462d4a72..e06420aca1 100644 --- a/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTemplatePermissionPolicy.md @@ -1,163 +1,163 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy -title: New-CsTeamsTemplatePermissionPolicy -author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: -manager: weiliu2 -schema: 2.0.0 ---- - -# New-CsTeamsTemplatePermissionPolicy - -## SYNOPSIS -Creates a new instance of the TeamsTemplatePermissionPolicy. - -## SYNTAX - -``` -New-CsTeamsTemplatePermissionPolicy - [-HiddenTemplates ] - [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Creates a new instance of the policy with a name and a list of hidden Teams template IDs. The template IDs passed into the `HiddenTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist). - -## EXAMPLES - -### Example 1 - -Assuming there are two valid templates with IDs `com.microsoft.teams.template.ManageAProject` and `com.microsoft.teams.template.ManageAnEvent`, we will first create the `HiddenTemplate` objects. - -The next step would be to create the policy instance. -```powershell -PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent -PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject -PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) -PS >New-CsTeamsTemplatePermissionPolicy -Identity Foobar -HiddenTemplates $HiddenList -``` - -```output -Identity HiddenTemplates Description --------- --------------- ----------- -Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} -``` - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of the new policy instance to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. - -You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenTemplates -The list of Teams template IDs to hide. -The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). - -```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Name of the new policy instance to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### TeamsTemplatePermissionPolicy.Cmdlets.TeamsTemplatePermissionPolicy - -## NOTES - -## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) - -[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) - -[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) +--- +author: yishuaihuang4 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy +schema: 2.0.0 +title: New-CsTeamsTemplatePermissionPolicy +--- + +# New-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Creates a new instance of the TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +New-CsTeamsTemplatePermissionPolicy + [-HiddenTemplates ] + [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a new instance of the policy with a name and a list of hidden Teams template IDs. The template IDs passed into the `HiddenTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist). + +## EXAMPLES + +### Example 1 + +Assuming there are two valid templates with IDs `com.microsoft.teams.template.ManageAProject` and `com.microsoft.teams.template.ManageAnEvent`, we will first create the `HiddenTemplate` objects. + +The next step would be to create the policy instance. +```powershell +PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) +PS >New-CsTeamsTemplatePermissionPolicy -Identity Foobar -HiddenTemplates $HiddenList +``` + +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenTemplates +The list of Teams template IDs to hide. +The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddentemplate). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsTemplatePermissionPolicy.Cmdlets.TeamsTemplatePermissionPolicy + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTranslationRule.md similarity index 93% rename from teams/teams-ps/teams/New-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsTranslationRule.md index e760bec361..f376afd695 100644 --- a/teams/teams-ps/teams/New-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstranslationrule +schema: 2.0.0 +title: New-CsTeamsTranslationRule --- # New-CsTeamsTranslationRule @@ -76,15 +77,16 @@ This example creates a rule that adds the last four digits of a phone number sta ## 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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: (Identity) -Aliases: -Required: True -Position: 1 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -105,58 +107,57 @@ 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. +### -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: (All) +Parameter Sets: (Identity) Aliases: - -Required: False -Position: Named +Required: True +Position: 1 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. +### -Name +The name of the rule. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (ParentAndRelativeKey) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The name of the rule. +### -Pattern +A regular expression that caller or callee number must match in order for this rule to be applied. ```yaml Type: String -Parameter Sets: (ParentAndRelativeKey) +Parameter Sets: (All) Aliases: -Required: True +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. +### -Translation +The regular expression pattern that will be applied to the number to convert it. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -165,13 +166,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -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: cf +Aliases: wi Required: False Position: Named @@ -190,10 +191,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamstranslationrule) -[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstranslationrule) -[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstranslationrule) -[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUnassignedNumberTreatment.md similarity index 74% rename from teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsUnassignedNumberTreatment.md index cf47048628..0fd18acbb5 100644 --- a/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUnassignedNumberTreatment.md @@ -1,201 +1,253 @@ ---- -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 -title: New-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# New-CsTeamsUnassignedNumberTreatment - -## 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) -``` -New-CsTeamsUnassignedNumberTreatment [-Identity] [-Description ] [-Pattern ] [-Target ] - [-TargetType ] [-TreatmentPriority ] - [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey -``` -New-CsTeamsUnassignedNumberTreatment -TreatmentId [-Description ] [-Pattern ] [-Target ] - [-TargetType ] [-TreatmentPriority ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet creates a treatment for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa@contoso.com).ObjectId -New-CsTeamsUnassignedNumberTreatment -Identity MainAA -Pattern "^\+15552223333$" -TargetType ResourceAccount -Target $RAObjectId -TreatmentPriority 1 -``` -This example creates a treatment that will route all calls to the number +1 (555) 222-3333 to the resource account aa@contoso.com. -That resource account is associated with an Auto Attendant (not part of the example). - -### Example 2 -```powershell -$Content = Get-Content "C:\Media\MainAnnoucement.wav" -Encoding byte -ReadCount 0 -$AudioFile = Import-CsOnlineAudioFile -FileName "MainAnnouncement.wav" -Content $Content -$Fid=[System.Guid]::Parse($audioFile.Id) -New-CsTeamsUnassignedNumberTreatment -Identity TR1 -Pattern "^\+1555333\d{4}$" -TargetType Announcement -Target $Fid.Guid -TreatmentPriority 2 -``` -This example creates a treatment that will route all calls to unassigned numbers in the range +1 (555) 333-0000 to +1 (555) 333-9999 to the announcement service, -where the audio file MainAnnouncement.wav will be played to the caller. - -### Example 3 -```powershell -$UserObjectId = (Get-CsOnlineUser -Identity user@contoso.com).Identity -New-CsTeamsUnassignedNumberTreatment -Identity TR2 -Pattern "^\+15552224444$" -TargetType User -Target $UserObjectId -TreatmentPriority 3 -``` -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 -Free format description of this treatment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Id of the treatment. - -```yaml -Type: System.String -Parameter Sets: (Identity) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern -A regular expression that the called number must match in order for the treatment to take effect. It is best 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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetType -The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatmentId -The identity of the treatment. - -```yaml -Type: System.String -Parameter Sets: (ParentAndRelativeKey) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatmentPriority -The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - -```yaml -Type: System.Integer -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 -The cmdlet is available in Teams PS module 2.5.1 or later. - -The parameters Identity and TreatmentId are mutually exclusive. - -To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. - -To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. - -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 -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/teams/import-csonlineaudiofile) - -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) - -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) - -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) - -[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment +schema: 2.0.0 +title: New-CsTeamsUnassignedNumberTreatment +--- + +# New-CsTeamsUnassignedNumberTreatment + +## 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) +``` +New-CsTeamsUnassignedNumberTreatment -Identity [-Description ] [-Pattern ] + [-Target ] [-TargetType ] [-TreatmentPriority ] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsTeamsUnassignedNumberTreatment [-Description ] [-Pattern ] [-Target ] + [-TargetType ] [-TreatmentPriority ] [-MsftInternalProcessingMode ] + -TreatmentId [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet creates a treatment for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa@contoso.com).ObjectId +New-CsTeamsUnassignedNumberTreatment -Identity MainAA -Pattern "^\+15552223333$" -TargetType ResourceAccount -Target $RAObjectId -TreatmentPriority 1 +``` +This example creates a treatment that will route all calls to the number +1 (555) 222-3333 to the resource account aa@contoso.com. +That resource account is associated with an Auto Attendant (not part of the example). + +### Example 2 +```powershell +$Content = Get-Content "C:\Media\MainAnnoucement.wav" -Encoding byte -ReadCount 0 +$AudioFile = Import-CsOnlineAudioFile -FileName "MainAnnouncement.wav" -Content $Content +$Fid=[System.Guid]::Parse($audioFile.Id) +New-CsTeamsUnassignedNumberTreatment -Identity TR1 -Pattern "^\+1555333\d{4}$" -TargetType Announcement -Target $Fid.Guid -TreatmentPriority 2 +``` +This example creates a treatment that will route all calls to unassigned numbers in the range +1 (555) 333-0000 to +1 (555) 333-9999 to the announcement service, +where the audio file MainAnnouncement.wav will be played to the caller. + +### Example 3 +```powershell +$UserObjectId = (Get-CsOnlineUser -Identity user@contoso.com).Identity +New-CsTeamsUnassignedNumberTreatment -Identity TR2 -Pattern "^\+15552224444$" -TargetType User -Target $UserObjectId -TreatmentPriority 3 +``` +This example creates a treatment that will route all calls to the number +1 (555) 222-4444 to the user user@contoso.com. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free format description of this treatment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the treatment. + +```yaml +Type: System.String +Parameter Sets: Identity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: System.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 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 +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetType +The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatmentId +The identity of the treatment. + +```yaml +Type: System.String +Parameter Sets: (ParentAndRelativeKey) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatmentPriority +The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + +```yaml +Type: System.Int32 +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: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +The parameters Identity and TreatmentId are mutually exclusive. + +To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. + +To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. + +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 +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/microsoftteams/import-csonlineaudiofile) + +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment) + +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment) + +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUpdateManagementPolicy.md similarity index 90% rename from teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsUpdateManagementPolicy.md index d439835fe4..b26534d110 100644 --- a/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: gnamun +Module Name: MicrosoftTeams +ms.author: vargasj +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsupdatemanagementpolicy +schema: 2.0.0 +title: New-CsTeamsUpdateManagementPolicy --- # New-CsTeamsUpdateManagementPolicy @@ -44,41 +45,6 @@ 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. @@ -168,6 +134,21 @@ Accept 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 policy. For example, the Description might indicate the users the policy should be assigned to. @@ -184,12 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateDayOfWeek +### -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: - Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. +| ID | Campaign Category | +| -- | -- | +| 91382d07-8b89-444c-bbcb-cfe43133af33| What's New | +| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | ```yaml -Type: Int64 +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) Aliases: @@ -200,9 +185,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTime +### -Force +Suppress all non-fatal errors. -Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. +```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 +``` + +### -OCDIRedirect + +This setting controls whether users are redirected from teams.microsoft.com to the unified domain teams.cloud.microsoft. Possible values are: +- **Microsoft Default**, Microsoft will manage redirection behavior. If no explicit admin configuration is set, users may be redirected automatically. +- **Disabled**, Users will remain on teams.microsoft.com. Use this if your organization's apps are incompatible with the unified domain. +- **Enabled**, Users will be redirected to teams.cloud.microsoft. Use this only if your organization had previously opted out of redirection and now wants to opt back in. ```yaml Type: String @@ -216,12 +234,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTimeOfDay +### -UpdateDayOfWeek -Machine local time. Can be set only when AllowManagedUpdates is set to True + Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. ```yaml -Type: DateTime +Type: Int64 Parameter Sets: (All) Aliases: @@ -232,14 +250,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNewTeamsClient +### -UpdateTime -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. +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. ```yaml Type: String @@ -253,11 +266,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppress all non-fatal errors. +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) Aliases: @@ -268,16 +282,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -A unique identifier. +### -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: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVdiPolicy.md similarity index 87% rename from teams/teams-ps/teams/New-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsVdiPolicy.md index a8a03debbe..cc843f54e9 100644 --- a/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVdiPolicy.md @@ -1,165 +1,164 @@ ---- -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 +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvdipolicy +schema: 2.0.0 +title: New-CsTeamsVdiPolicy +--- + +# New-CsTeamsVdiPolicy + +## SYNOPSIS +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. + +## 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 for an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## 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/MicrosoftTeams/New-CsTeamsVirtualAppointmentsPolicy.md similarity index 89% rename from teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsVirtualAppointmentsPolicy.md index e231df2c8c..decd4e93b4 100644 --- a/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy -title: New-CsTeamsVirtualAppointmentsPolicy -schema: 2.0.0 ms.author: erocha -author: emmanuelrocha001 -manager: sonaggarwal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy +schema: 2.0.0 +title: New-CsTeamsVirtualAppointmentsPolicy --- # New-CsTeamsVirtualAppointmentsPolicy @@ -66,13 +67,15 @@ Accept wildcard characters: False ``` ### -EnableSmsNotifications + +> Applicable: Microsoft Teams + This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment template meeting. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -140,10 +143,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVoiceApplicationsPolicy.md similarity index 96% rename from teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsVoiceApplicationsPolicy.md index 5cc32a34f2..95df93adaa 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVoiceApplicationsPolicy.md @@ -1,10 +1,11 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy -title: New-CsTeamsVoiceApplicationsPolicy -schema: 2.0.0 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy ROBOTS: NOINDEX +schema: 2.0.0 +title: New-CsTeamsVoiceApplicationsPolicy --- # New-CsTeamsVoiceApplicationsPolicy @@ -85,25 +86,9 @@ The command shown in Example 2 creates a new per-user Teams voice applications p ## PARAMETERS -### -Identity - -Unique identifier assigned to the policy when it was created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAutoAttendantBusinessHoursGreetingChange +### -AllowAutoAttendantAfterHoursGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. ```yaml Type: Boolean @@ -117,9 +102,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursGreetingChange +### -AllowAutoAttendantAfterHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. ```yaml Type: Boolean @@ -133,9 +118,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayGreetingChange +### -AllowAutoAttendantBusinessHoursChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. ```yaml Type: Boolean @@ -149,9 +134,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursChange +### -AllowAutoAttendantBusinessHoursGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -165,9 +150,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidaysChange +### -AllowAutoAttendantBusinessHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. ```yaml Type: Boolean @@ -181,11 +166,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantTimeZoneChange - -_This option is not currently available in Queues app._ +### -AllowAutoAttendantHolidayGreetingChange -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. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. ```yaml Type: Boolean @@ -199,11 +182,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantLanguageChange - -_This option is not currently available in Queues app._ +### -AllowAutoAttendantHolidayRoutingChange -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. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. ```yaml Type: Boolean @@ -217,9 +198,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursRoutingChange +### -AllowAutoAttendantHolidaysChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. ```yaml Type: Boolean @@ -233,9 +214,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursRoutingChange +### -AllowAutoAttendantLanguageChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. ```yaml Type: Boolean @@ -249,9 +232,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayRoutingChange +### -AllowAutoAttendantTimeZoneChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. ```yaml Type: Boolean @@ -265,9 +250,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange +### -AllowCallQueueAgentOptChange -When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. ```yaml Type: Boolean @@ -281,9 +266,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMusicOnHoldChange +### -AllowCallQueueConferenceModeChange -When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. ```yaml Type: Boolean @@ -297,9 +282,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowSharedVoicemailGreetingChange +### -AllowCallQueueLanguageChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. ```yaml Type: Boolean @@ -313,9 +300,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutSharedVoicemailGreetingChange +### -AllowCallQueueMembershipChange -When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. ```yaml Type: Boolean @@ -329,11 +316,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentSharedVoicemailGreetingChange - -_This option is not currently available in Queues app._ +### -AllowCallQueueMusicOnHoldChange -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. +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -347,11 +332,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange +### -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 language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. +When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. ```yaml Type: Boolean @@ -365,9 +350,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMembershipChange +### -AllowCallQueueNoAgentsRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -381,9 +366,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +### -AllowCallQueueOptOutChange -When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. ```yaml Type: Boolean @@ -397,9 +382,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueRoutingMethodChange +### -AllowCallQueueOverflowRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. ```yaml Type: Boolean @@ -413,9 +398,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueuePresenceBasedRoutingChange +### -AllowCallQueueOverflowSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -429,9 +414,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOptOutChange +### -AllowCallQueuePresenceBasedRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. +When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. ```yaml Type: Boolean @@ -445,9 +430,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowRoutingChange +### -AllowCallQueueRoutingMethodChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. ```yaml Type: Boolean @@ -477,9 +462,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentsRoutingChange +### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -493,9 +478,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueAgentOptChange +### -AllowCallQueueWelcomeGreetingChange -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. +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -511,7 +496,7 @@ Accept wildcard characters: False ### -CallQueueAgentMonitorMode -_This option is not currently available in Queues app._ +> Applicable: Microsoft Teams PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover @@ -529,7 +514,6 @@ When set to `Takeover`, users affected by the policy will be allowed to monitor Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -540,7 +524,7 @@ Accept wildcard characters: False ### -CallQueueAgentMonitorNotificationMode -_This option is not currently available in Queues app._ +> Applicable: Microsoft Teams PARAMVALUE: Disabled | Agent @@ -552,7 +536,6 @@ When set to `Agent`, users affected by the policy will be allowed to monitor age Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -561,22 +544,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAutoAttendantMetricsPermission - -PARAMVALUE: Disabled | AuthorizedOnly | All - -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. - -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. +### -Confirm -> [!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. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Object -Parameter Sets: Dual -Aliases: -applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -585,22 +560,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeCallQueueMetricsPermission - -PARAMVALUE: Disabled | AuthorizedOnly | All - -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. - -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. +### -Description -> [!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. +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: Object -Parameter Sets: Dual +Type: String +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -609,22 +576,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAgentMetricsPermission +### -HistoricalAgentMetricsPermission + +> Applicable: Microsoft Teams 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 `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 real-time metrics for agents who are members in the call queues they are authorized for. +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. -> [!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. +When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -635,6 +602,8 @@ Accept wildcard characters: False ### -HistoricalAutoAttendantMetricsPermission +> Applicable: Microsoft Teams + PARAMVALUE: Disabled | AuthorizedOnly | All When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. @@ -647,7 +616,6 @@ When set to `All`, users affected by the policy will receive historical metrics Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -658,6 +626,8 @@ Accept wildcard characters: False ### -HistoricalCallQueueMetricsPermission +> Applicable: Microsoft Teams + PARAMVALUE: Disabled | AuthorizedOnly | All When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. @@ -670,7 +640,6 @@ When set to `All`, users affected by the policy will receive historical metrics Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -679,21 +648,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalAgentMetricsPermission +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAgentMetricsPermission + +> Applicable: Microsoft Teams 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 `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 historical metrics for agents who are members in the call queues they are authorized for. +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 historical 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: Microsoft Teams Required: False Position: Named @@ -702,15 +689,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -RealTimeAutoAttendantMetricsPermission -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +> Applicable: Microsoft Teams + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: Object +Parameter Sets: Dual +Aliases: Required: False Position: Named @@ -719,14 +714,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -RealTimeCallQueueMetricsPermission -Prompts you for confirmation before running the cmdlet. +> Applicable: Microsoft Teams + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: Object +Parameter Sets: Dual +Aliases: Required: False Position: Named @@ -735,14 +739,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -WhatIf -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -765,10 +770,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy) -[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy) -[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy) -[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLoadPolicy.md similarity index 89% rename from teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLoadPolicy.md index e2f6188c48..db54e55a4f 100644 --- a/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLoadPolicy.md @@ -1,239 +1,240 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworkloadpolicy +schema: 2.0.0 +title: New-CsTeamsWorkLoadPolicy +--- + +# 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/microsoftteams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLocationDetectionPolicy.md similarity index 80% rename from teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLocationDetectionPolicy.md index c99f3955de..a4ea47d20b 100644 --- a/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLocationDetectionPolicy.md @@ -1,18 +1,19 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur 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 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy +schema: 2.0.0 +title: New-CsTeamsWorkLocationDetectionPolicy --- # 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) +This cmdlet is used to create a new instance of the TeamsWorkLocationDetectionPolicy. ## SYNTAX @@ -25,6 +26,8 @@ New-CsTeamsWorkLocationDetectionPolicy [-EnableWorkLocationDetection ] 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). +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). + ## EXAMPLES ### Example 1 @@ -142,10 +145,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy) -[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy) -[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy) -[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/New-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantDialPlan.md similarity index 85% rename from teams/teams-ps/teams/New-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantDialPlan.md index 3496d58772..ab95636a90 100644 --- a/teams/teams-ps/teams/New-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan +schema: 2.0.0 +title: New-CsTenantDialPlan --- # New-CsTenantDialPlan @@ -27,18 +28,18 @@ 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/teams/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/microsoftteams/new-csvoicenormalizationrule) cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsTenantDialPlan -Identity vt1tenantDialPlan9 ``` This example creates a tenant dial plan that has an Identity of vt1tenantDialPlan9. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $nr2 = New-CsVoiceNormalizationRule -Identity Global/NR2 -Description "TestNR1" -Pattern '^(d{11})$' -Translation '+1' -InMemory New-CsTenantDialPlan -Identity vt1tenantDialPlan91 -NormalizationRules @{Add=$nr2} @@ -48,33 +49,16 @@ This example creates a new normalization rule and then applies that rule to a ne ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the name of the tenant dial plan. -Identity is an alphanumeric string that cannot exceed 49 characters. -Valid characters are alphabetic or numeric characters, hyphen (-) and dot (.). -The value should not begin with a (.) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Confirm -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -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 @@ -84,6 +68,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to and any other information that helps to identify the purpose of the tenant dial plan. Maximum characters: 1040. @@ -91,7 +78,6 @@ Maximum characters: 1040. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -100,21 +86,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter is a unique identifier that designates the name of the tenant dial plan. +Identity is an alphanumeric string that cannot exceed 49 characters. +Valid characters are alphabetic or numeric characters, hyphen (-) and dot (.). +The value should not begin with a (.) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NormalizationRules + +> Applicable: Microsoft Teams + The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. -Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet, which creates the rule and then assign it to the specified tenant dial plan using [Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) 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/microsoftteams/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/microsoftteams/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](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet. +You can create a new normalization rule by calling the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csvoicenormalizationrule) cmdlet. ```yaml Type: List Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -SimpleName + +> Applicable: Microsoft Teams + The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. @@ -137,7 +149,6 @@ However, if you don't provide a value, a default value matching the Identity of Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -147,6 +158,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -154,7 +168,6 @@ 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 Required: False Position: Named @@ -176,10 +189,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cstenantdialplan) -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan) -[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) -[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantdialplan) diff --git a/teams/teams-ps/teams/New-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkRegion.md similarity index 85% rename from teams/teams-ps/teams/New-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkRegion.md index 33bb7d2c2d..99f6e134d5 100644 --- a/teams/teams-ps/teams/New-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkRegion.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion applicable: Microsoft Teams -title: New-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworkregion +schema: 2.0.0 +title: New-CsTenantNetworkRegion --- # New-CsTenantNetworkRegion ## SYNOPSIS -As an admin, you can use the Teams PowerShell command, New-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. +Creates a new network region. ## SYNTAX @@ -30,6 +31,8 @@ New-CsTenantNetworkRegion -NetworkRegionID [-BypassID ] [-Centr ``` ## DESCRIPTION +A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. + Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. ## EXAMPLES @@ -43,22 +46,22 @@ The command shown in Example 1 creates the network region 'RegionA' with no desc ## PARAMETERS -### -Identity -Unique identifier for the network region to be created. +### -BypassID +This parameter is not used. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassID +### -CentralSite This parameter is not used. ```yaml @@ -73,13 +76,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CentralSite -This parameter is not used. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -103,30 +106,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -The name of the network region. This must be a string that is unique. You cannot specify an NetworkRegionID and an Identity at the same time. +### -Identity +Unique identifier for the network region to be created. ```yaml Type: String -Parameter Sets: ParentAndRelativeKey +Parameter Sets: Identity Aliases: Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkRegionID +The name of the network region. This must be a string that is unique. You cannot specify an NetworkRegionID and an Identity at the same time. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -163,8 +166,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworkregion) -[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworkregion) -[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/New-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSite.md similarity index 96% rename from teams/teams-ps/teams/New-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSite.md index 81412644a9..da04e430ab 100644 --- a/teams/teams-ps/teams/New-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite applicable: Microsoft Teams -title: New-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksite +schema: 2.0.0 +title: New-CsTenantNetworkSite --- # New-CsTenantNetworkSite @@ -66,16 +67,16 @@ PS C:\> New-CsTenantNetworkSite -NetworkSiteID "site3" -Description "site 3" -Ne The command shown in Example 3 creates the network site 'site3' with the description 'site 3'. This site is enabled for network roaming capabilities. The example associates the site with network region 'RedmondRegion' and network roaming policy 'TestNetworkRoamingPolicy'. ## PARAMETERS -### -Identity -Unique identifier for the network site to be created. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -96,8 +97,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmergencyCallRoutingPolicy -This parameter is used to assign a custom emergency call routing policy to a network site. For more information, see [Assign a custom emergency call routing policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). +### -EmergencyCallingPolicy +This parameter is used to assign a custom emergency calling policy to a network site. For more information see [Assign a custom emergency calling policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). ```yaml Type: String @@ -111,8 +112,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmergencyCallingPolicy -This parameter is used to assign a custom emergency calling policy to a network site. For more information see [Assign a custom emergency calling policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). +### -EmergencyCallRoutingPolicy +This parameter is used to assign a custom emergency call routing policy to a network site. For more information, see [Assign a custom emergency call routing policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). ```yaml Type: String @@ -141,6 +142,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique identifier for the network site 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 +``` + ### -LocationPolicy This parameter is reserved for Microsoft internal use. @@ -216,21 +232,6 @@ Accept 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. @@ -257,8 +258,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) -[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksite) -[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksite) diff --git a/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSubnet.md similarity index 80% rename from teams/teams-ps/teams/New-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSubnet.md index 0639975119..d6738ebcfe 100644 --- a/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSubnet.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet applicable: Microsoft Teams -title: New-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksubnet +schema: 2.0.0 +title: New-CsTenantNetworkSubnet --- # New-CsTenantNetworkSubnet ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, New-CsTenantNetworkSubnet to define network subnets and assign them to network sites. Each internal subnet may only be associated with one site. Tenant network subnet is used for Location Based Routing. +Creates a new network subnet. ## SYNTAX @@ -30,7 +31,7 @@ New-CsTenantNetworkSubnet -MaskBits -SubnetID [-Description ] -IPAddress [-MaskB ## DESCRIPTION External trusted IPs are the Internet external IPs of the enterprise network and are used to determine if the user's endpoint is inside the corporate network before checking for a specific site match. 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. -Both IPv4 and IPv6 trusted IP addresses are supported. +Both IPv4 and IPv6 trusted IP addresses are supported. You can define an unlimited number of external subnets for a tenant. ## EXAMPLES @@ -108,21 +108,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IPAddress -The name of the IP address. This must be a unique and valid IPv4 or IPv6 address. You cannot specify an IP address and an Identity at the same time. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier for the IP address to be created. @@ -153,6 +138,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IPAddress +The name of the IP address. This must be a unique and valid IPv4 or IPv6 address. You cannot specify an IP address and an Identity at the same time. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MaskBits This parameter determines the length of bits to mask to the subnet. diff --git a/teams/teams-ps/teams/New-CsUserCallingDelegate.md b/teams/teams-ps/MicrosoftTeams/New-CsUserCallingDelegate.md similarity index 75% rename from teams/teams-ps/teams/New-CsUserCallingDelegate.md rename to teams/teams-ps/MicrosoftTeams/New-CsUserCallingDelegate.md index bcb61efbcc..90b9401956 100644 --- a/teams/teams-ps/teams/New-CsUserCallingDelegate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsUserCallingDelegate.md @@ -1,137 +1,155 @@ ---- -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 -title: New-CsUserCallingDelegate -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# New-CsUserCallingDelegate - -## SYNOPSIS -This cmdlet will add a new delegate for calling in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -```powershell -New-CsUserCallingDelegate -Identity -Delegate -MakeCalls -ReceiveCalls -ManageSettings [] -``` - -## DESCRIPTION -This cmdlet adds a new delegate with given permissions for the specified user. - -## EXAMPLES - -### Example 1 -```powershell -New-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -ReceiveCalls $true -ManageSettings $true -``` - -## PARAMETERS - -### -Delegate -The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. - -A user can have up to 25 delegates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeCalls - -Specifies whether delegate is allowed to make calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: True -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManageSettings - -Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: True -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveCalls - -Specifies whether delegate is allowed to receive calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: True -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -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](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csusercallingdelegate +schema: 2.0.0 +title: New-CsUserCallingDelegate +--- + +# New-CsUserCallingDelegate + +## SYNOPSIS +This cmdlet will add a new delegate for calling in Microsoft Teams. + +## SYNTAX + +``` +New-CsUserCallingDelegate -Identity -Delegate -MakeCalls -ManageSettings + -ReceiveCalls [-HttpPipelinePrepend ] [] +``` + +## DESCRIPTION +This cmdlet adds a new delegate with given permissions for the specified user. + +## EXAMPLES + +### Example 1 +```powershell +New-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -ReceiveCalls $true -ManageSettings $true +``` + +## PARAMETERS + +### -Delegate +The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. + +A user can have up to 25 delegates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeCalls + +Specifies whether delegate is allowed to make calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageSettings + +Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveCalls + +Specifies whether delegate is allowed to receive calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: True +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +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](https://learn.microsoft.com/powershell/module/microsoftteams/get-csusercallingsettings) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/New-CsVideoInteropServiceProvider.md similarity index 94% rename from teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/New-CsVideoInteropServiceProvider.md index 06ece90114..de166c02f0 100644 --- a/teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsVideoInteropServiceProvider.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csvideointeropserviceprovider +schema: 2.0.0 +title: New-CsVideoInteropServiceProvider --- # New-CsVideoInteropServiceProvider ## 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. +Use the New-CsVideoInteropServiceProvider to specify information about a supported CVI partner your organization would like to use. ## SYNTAX @@ -35,8 +36,6 @@ New-CsVideoInteropServiceProvider [-Tenant ] -Name [-AadAp ## DESCRIPTION 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. -Use the New-CsVideoInteropServiceProvider to specify information about a supported CVI partner your organization would like to use. - Important note: New-CsVideoInteropServiceProvider does not do a check on the -Identity to be one of the Identity (without tag:) from the Get-CsTeamsVideoInteropServicePolicy, however if this is not set to match, the VTC coordinates will not added to the meetings correctly. Make sure that your "Identity" matches a valid policy identity. ## EXAMPLES diff --git a/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md b/teams/teams-ps/MicrosoftTeams/New-CsVoiceNormalizationRule.md similarity index 85% rename from teams/teams-ps/teams/New-CsVoiceNormalizationRule.md rename to teams/teams-ps/MicrosoftTeams/New-CsVoiceNormalizationRule.md index 50a147a31f..d672b68c5b 100644 --- a/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsVoiceNormalizationRule.md @@ -1,12 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csvoicenormalizationrule +schema: 2.0.0 +title: New-CsVoiceNormalizationRule --- # New-CsVoiceNormalizationRule @@ -14,11 +16,6 @@ ms.author: serdars ## 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) @@ -36,7 +33,11 @@ New-CsVoiceNormalizationRule [-Tenant ] -Parent -Name [- ``` ## DESCRIPTION -This cmdlet creates a named voice normalization rule. + +This cmdlet was introduced in Lync Server 2010. + +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. + 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. @@ -51,7 +52,7 @@ the `New-CsTenantDialPlan` or `Set-CsTenantDialPlan` cmdlets. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" ``` @@ -64,7 +65,7 @@ If the rule name does not contain a space you don't need to enclose the Identity 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 -------------------------- +### Example 2 ``` New-CsVoiceNormalizationRule -Parent SeattleUser -Name SeattleFourDigit -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' ``` @@ -81,7 +82,7 @@ Single quotes are required for these values; double quotes (or no quotes) will n 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 -------------------------- +### 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} @@ -91,64 +92,49 @@ This example creates a new in-memory voice normalization rule and then adds it t ## 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.) +### -Confirm -For Microsoft Teams, voice normalization rules can be created at the following scopes: global and tag. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -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. +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named 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. +### -Description +A friendly description of the normalization rule. + +Maximum string length: 512 characters. ```yaml Type: String -Parameter Sets: ParentAndRelativeKey +Parameter Sets: (All) Aliases: -Required: True +Required: False 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. +### -Force -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. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -159,35 +145,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A friendly description of the normalization rule. +### -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. -Maximum string length: 512 characters. +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: String -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: -Required: False -Position: Named +Required: True +Position: 2 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. +### -InMemory -Default: False +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: Boolean +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 @@ -196,16 +193,20 @@ 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. +### -IsInternalExtension -Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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: String +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 @@ -214,34 +215,39 @@ 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. +### -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: Int32 -Parameter Sets: (All) +Type: String +Parameter Sets: ParentAndRelativeKey Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -Required: False +Required: True 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. +### -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. -Default: +$1 (The default prefixes the number with a plus sign \[+\].) +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: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -250,14 +256,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Pattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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: SwitchParameter +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 @@ -266,17 +276,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. +### -Priority -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-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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: SwitchParameter +Type: Int32 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 @@ -285,27 +296,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Tenant -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +For internal Microsoft usage. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -314,14 +314,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Translation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -330,14 +334,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal Microsoft usage. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -363,10 +369,10 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Po ## RELATED LINKS -[Test-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/test-csvoicenormalizationrule) +[Test-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/microsoftteams/test-csvoicenormalizationrule) -[Get-CsDialPlan](https://learn.microsoft.com/powershell/module/teams/get-csdialplan) +[Get-CsDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-csdialplan) -[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan) -[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) diff --git a/teams/teams-ps/teams/New-Team.md b/teams/teams-ps/MicrosoftTeams/New-Team.md similarity index 95% rename from teams/teams-ps/teams/New-Team.md rename to teams/teams-ps/MicrosoftTeams/New-Team.md index 5ca7ae7b5c..d8eff81575 100644 --- a/teams/teams-ps/teams/New-Team.md +++ b/teams/teams-ps/MicrosoftTeams/New-Team.md @@ -1,24 +1,18 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-team +schema: 2.0.0 +title: New-Team --- # New-Team ## SYNOPSIS This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. -Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. - -If you want these groups to appear in Outlook clients, you can use the [Set-UnifiedGroup](https://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) @@ -48,6 +42,12 @@ New-Team -GroupId [-Owner ] [-AllowGiphy ] [-GiphyCont ## DESCRIPTION Creates a new team with user specified settings, and returns a Group object with a GroupID property. +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/exchangepowershell/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. + ## EXAMPLES ### Example 1 @@ -79,109 +79,23 @@ This example creates a team, adds three members to it, and creates three channel ## PARAMETERS -### -MailNickName -The MailNickName parameter specifies the alias for the associated Office 365 Group. -This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. -The value of the MailNickName parameter has to be unique across your tenant. -Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. - -For more details about the naming conventions see here: [New-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Classification -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Team description. Characters Limit - 1024. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Team display name. Characters Limit - 256. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Template -If you have an EDU license, you can use this parameter to specify which template you'd like to use for creating your group. -Do not use this parameter when converting an existing group. - -Valid values are: "EDU_Class" or "EDU_PLC" - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. -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. +### -AllowAddRemoveApps +Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) +Default value: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAddRemoveApps -Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. +### -AllowChannelMentions +Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. ```yaml Type: Boolean @@ -195,17 +109,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelMentions -Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. +### -AllowCreatePrivateChannels +Determines whether private channel creation is allowed for the team. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: CreateTeam Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -405,6 +319,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Classification +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Team description. Characters Limit - 1024. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Team display name. Characters Limit - 256. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -GiphyContentRating Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" @@ -422,7 +381,7 @@ Accept wildcard characters: False ### -GroupId Specify a GroupId to convert to a Team. If specified, you cannot provide the other values that are already specified by the existing group, namely: Visibility, Alias, Description, or DisplayName. -If, for example, you need to create a Team from an existing Microsoft 365 Group, use the _ExternalDirectoryObjectId_ property value returned by [Get-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup?view=exchange-ps). +If, for example, you need to create a Team from an existing Microsoft 365 Group, use the _ExternalDirectoryObjectId_ property value returned by [Get-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchangepowershell/get-unifiedgroup). ```yaml Type: String @@ -436,8 +395,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Visibility -Set to Public to allow all users in your organization to join the group by default. Set to Private to require that an owner approve the join request. +### -MailNickName +The MailNickName parameter specifies the alias for the associated Office 365 Group. +This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. +The value of the MailNickName parameter has to be unique across your tenant. +Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. + +For more details about the naming conventions see here: [New-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchangepowershell/new-unifiedgroup#parameters), Parameter: -Alias. ```yaml Type: String @@ -446,23 +410,26 @@ Aliases: Required: False Position: Named -Default value: Private +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ShowInTeamsSearchAndSuggestions -Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. +### -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. +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. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -481,18 +448,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreatePrivateChannels -Determines whether private channel creation is allowed for the team. +### -ShowInTeamsSearchAndSuggestions +Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. ```yaml Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Template +If you have an EDU license, you can use this parameter to specify which template you'd like to use for creating your group. +Do not use this parameter when converting an existing group. + +Valid values are: "EDU_Class" or "EDU_PLC" + +```yaml +Type: String Parameter Sets: CreateTeam Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Visibility +Set to Public to allow all users in your organization to join the group by default. Set to Private to require that an owner approve the join request. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: Private +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -509,8 +509,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Remove-Team](https://learn.microsoft.com/powershell/module/teams/remove-team) +[Remove-Team](https://learn.microsoft.com/powershell/module/microsoftteams/remove-team) -[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-Team](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) -[Set-Team](https://learn.microsoft.com/powershell/module/teams/set-team) +[Set-Team](https://learn.microsoft.com/powershell/module/microsoftteams/set-team) diff --git a/teams/teams-ps/teams/New-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/New-TeamChannel.md similarity index 93% rename from teams/teams-ps/teams/New-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/New-TeamChannel.md index 579b2c7209..9d20e98d8c 100644 --- a/teams/teams-ps/teams/New-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/New-TeamChannel.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-teamchannel +schema: 2.0.0 +title: New-TeamChannel --- # New-TeamChannel @@ -41,15 +41,16 @@ Create a private channel with display name as "Engineering" ## PARAMETERS -### -GroupId -GroupId of the team +### -Description +Channel description. +Channel description can be up to 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) @@ -72,16 +73,15 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Description -Channel description. -Channel description can be up to 1024 characters. +### -GroupId +GroupId of the team ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) @@ -123,7 +123,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, DisplayName, Description, MembershipType, Owner +### GroupId + +### DisplayName + +### Description + +### MembershipType + +### Owner ## OUTPUTS diff --git a/teams/teams-ps/teams/New-TeamsApp.md b/teams/teams-ps/MicrosoftTeams/New-TeamsApp.md similarity index 93% rename from teams/teams-ps/teams/New-TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/New-TeamsApp.md index 1ba731d7b5..5550f815a7 100644 --- a/teams/teams-ps/teams/New-TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/New-TeamsApp.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-teamsapp -title: New-TeamsApp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-teamsapp schema: 2.0.0 +title: New-TeamsApp --- # New-TeamsApp diff --git a/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber.md similarity index 86% rename from teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber.md index e2c1985c62..6b53e7a96e 100644 --- a/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber.md @@ -1,20 +1,21 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/register-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Register-CsOnlineDialInConferencingServiceNumber --- # 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. +The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. ## SYNTAX @@ -35,9 +36,12 @@ Register-CsOnlineDialInConferencingServiceNumber [-Instance] Applicable: Microsoft Teams + +PARAMVALUE: Guid ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: ConferencingServiceNumber +### -BridgeName + +> Applicable: Microsoft Teams + +PARAMVALUE: String ```yaml -Type: ConferencingServiceNumber +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeId -PARAMVALUE: Guid +### -DomainController + +> Applicable: Microsoft Teams + +PARAMVALUE: Fqdn ```yaml -Type: Guid +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False Position: Named @@ -94,14 +104,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeName -PARAMVALUE: String +### -Force + +> Applicable: Microsoft Teams + +PARAMVALUE: SwitchParameter ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -110,46 +122,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -PARAMVALUE: Fqdn +### -Identity + +> Applicable: Microsoft Teams + +PARAMVALUE: String ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Instance + +> Applicable: Microsoft Teams + +PARAMVALUE: ConferencingServiceNumber ```yaml -Type: SwitchParameter +Type: ConferencingServiceNumber Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -159,13 +177,15 @@ Accept wildcard characters: False ``` ### -TenantDomain + +> Applicable: Microsoft Teams + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsApplicationAccessPolicy.md similarity index 80% rename from teams/teams-ps/teams/Remove-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsApplicationAccessPolicy.md index 29aebeff75..a69e78a7d2 100644 --- a/teams/teams-ps/teams/Remove-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csapplicationaccesspolicy applicable: Microsoft Teams -title: Remove-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni author: frankpeng7 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csapplicationaccesspolicy +schema: 2.0.0 +title: Remove-CsApplicationAccessPolicy --- # Remove-CsApplicationAccessPolicy @@ -67,7 +68,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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) +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/Remove-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Remove-CsAutoAttendant.md similarity index 79% rename from teams/teams-ps/teams/Remove-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsAutoAttendant.md index a847c6ab1f..c1bdf99466 100644 --- a/teams/teams-ps/teams/Remove-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant +schema: 2.0.0 +title: Remove-CsAutoAttendant --- # Remove-CsAutoAttendant @@ -15,9 +17,6 @@ ms.reviewer: williamlooney ## SYNOPSIS Use the Remove-CsAutoAttendant cmdlet to delete an Auto Attendant (AA). -> [!NOTE] -> 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 ``` @@ -27,9 +26,12 @@ Remove-CsAutoAttendant -Identity [-Tenant ] [] ## DESCRIPTION The Remove-CsAutoAttendant cmdlet deletes an AA that is specified by the Identity parameter. +> [!NOTE] +> Remove any associated resource accounts with [Remove-CsOnlineApplicationInstanceAssociation](remove-csonlineapplicationinstanceassociation.md) before attempting to delete the Auto Attendant (AA). + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Remove-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" ``` @@ -39,13 +41,15 @@ This example deletes the AA that has an identity of fa9081d6-b4f3-5c96-baec-0b00 ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the AA to be removed. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -56,11 +60,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -85,8 +90,8 @@ The Remove-CsAutoAttendant cmdlet accepts a string as the Identity parameter. ## RELATED LINKS -[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendant) -[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant) -[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant) diff --git a/teams/teams-ps/teams/Remove-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/Remove-CsCallQueue.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsCallQueue.md index b4138debb8..f2bc36394b 100644 --- a/teams/teams-ps/teams/Remove-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsCallQueue.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -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 author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallqueue +schema: 2.0.0 +title: Remove-CsCallQueue --- # Remove-CsCallQueue @@ -27,7 +28,7 @@ The Remove-CsCallQueue cmdlet deletes an existing Call Queue specified by the Id ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCallQueue -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` @@ -37,13 +38,15 @@ This example removes the Call Queue with the identity 5e3a575e-1faa-49ff-83c2-5c ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -53,13 +56,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Remove-CsCallingLineIdentity.md similarity index 82% rename from teams/teams-ps/teams/Remove-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsCallingLineIdentity.md index 0a95b6cbed..b368c5418a 100644 --- a/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallinglineidentity +schema: 2.0.0 +title: Remove-CsCallingLineIdentity --- # Remove-CsCallingLineIdentity @@ -26,7 +27,7 @@ This cmdlet will remove a Caller ID policy from your organization or resets the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsCallingLineIdentity -Identity Anonymous ``` @@ -35,46 +36,52 @@ This example removes a Caller ID policy. ## PARAMETERS -### -Identity -The Identity parameter identifies the Caller ID policy. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 1 +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. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter identifies the Caller ID policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +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. +### -WhatIf + +> Applicable: Microsoft Teams + +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: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -94,10 +101,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallinglineidentity) -[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cscallinglineidentity) -[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallinglineidentity) -[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallinglineidentity) diff --git a/teams/teams-ps/MicrosoftTeams/Remove-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/Remove-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..2403795091 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,88 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: tomkau +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: Remove-CsComplianceRecordingForCallQueueTemplate +--- + +# Remove-CsComplianceRecordingForCallQueueTemplate + +## SYNOPSIS +Use the Remove-CsComplianceRecordingForCallQueueTemplate cmdlet to delete a Compliance Recording for Call Queues template. + +## 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 + +> Applicable: Microsoft Teams + +The Id parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### 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/MicrosoftTeams/Remove-CsCustomPolicyPackage.md similarity index 83% rename from teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsCustomPolicyPackage.md index c5fbbf878d..c4820ee128 100644 --- a/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsCustomPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: sunguchuan external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: Remove-CsCustomPolicyPackage -author: sunguchuan ms.author: gucsun -manager: dasosby -online version: https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscustompolicypackage schema: 2.0.0 +title: Remove-CsCustomPolicyPackage --- # Remove-CsCustomPolicyPackage @@ -38,13 +39,14 @@ Deletes a custom package named "MyPackage". ### -Identity +> Applicable: Microsoft Teams + The name of the custom package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -64,8 +66,8 @@ Default packages created by Microsoft cannot be deleted. ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage) +[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscustompolicypackage) -[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage) +[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/update-cscustompolicypackage) diff --git a/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsExternalAccessPolicy.md similarity index 84% rename from teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsExternalAccessPolicy.md index a801caa0bb..46cb77a34f 100644 --- a/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsExternalAccessPolicy.md @@ -1,21 +1,21 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csexternalaccesspolicy +schema: 2.0.0 +title: Remove-CsExternalAccessPolicy --- # 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 @@ -25,6 +25,8 @@ Remove-CsExternalAccessPolicy [-Tenant ] [-Identity] [-Force ``` ## DESCRIPTION +This cmdlet was introduced in Lync Server 2010. + 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. @@ -36,7 +38,7 @@ External access policies can grant (or revoke) the ability of your users to do a Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -3. (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. (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/microsoftteams/set-csteamsacsfederationconfiguration). 4. Communicate with people who have SIP accounts with a public instant messaging service such as Windows Live. @@ -53,7 +55,7 @@ Instead, the properties of the global policy will simply be reset to their defau ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsExternalAccessPolicy -Identity site:Redmond ``` @@ -61,7 +63,7 @@ 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 ------------------------ +### Example 2 ``` Get-CsExternalAccessPolicy -Filter site:* | Remove-CsExternalAccessPolicy ``` @@ -70,7 +72,7 @@ Example 2 deletes all the external access policies that have been configured at To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of policies configured at the site scope; the filter value "site:*" limits the returned data to external access policies that have an Identity that begins with the string value "site:". The filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} | Remove-CsExternalAccessPolicy ``` @@ -80,7 +82,7 @@ To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet to r This collection is then piped to the `Where-Object` cmdlet, which picks out only those policies where the EnableFederationAccess property is equal to True. This filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -or $_.EnablePublicCloudAccess -eq $True} | Remove-CsExternalAccessPolicy ``` @@ -96,37 +98,34 @@ To delete all the policies where both EnableFederationAccess and EnablePublicClo ## 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`. +### -Confirm -Note that wildcards are not allowed when specifying an Identity. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +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 +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -135,35 +134,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity -```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 +> 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 -``` +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`. -### -Confirm -Prompts you for confirmation before executing the command. +Note that wildcards are not allowed when specifying an Identity. ```yaml -Type: SwitchParameter +Type: XdsIdentity 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 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -189,6 +181,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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). @@ -209,10 +219,10 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo ## RELATED LINKS -[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/Remove-CsGroupPolicyAssignment.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsGroupPolicyAssignment.md index db975cb1bc..740084b301 100644 --- a/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsGroupPolicyAssignment.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csgrouppolicyassignment +schema: 2.0.0 +title: Remove-CsGroupPolicyAssignment --- # Remove-CsGroupPolicyAssignment @@ -54,47 +55,47 @@ In this example, the policy assignment with rank 2 is removed. As a result, the ## PARAMETERS -### -GroupId -The ID of the group from which the assignment will be removed. +### -Break +Wait for .NET debugger to attach ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -The policy type of the assignment to be removed from the group. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach +### -GroupId +The ID of the group from which the assignment will be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -144,6 +145,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyType +The policy type of the assignment to be removed from the group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Proxy The URI for the proxy server to use @@ -205,21 +221,6 @@ Accept 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). @@ -231,8 +232,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment) -[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) +[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csgrouppolicyassignment) -[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csgrouppolicyassignment) diff --git a/teams/teams-ps/MicrosoftTeams/Remove-CsHybridTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Remove-CsHybridTelephoneNumber.md new file mode 100644 index 0000000000..3820b89f33 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsHybridTelephoneNumber.md @@ -0,0 +1,237 @@ +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cshybridtelephonenumber +schema: 2.0.0 +title: Remove-CsHybridTelephoneNumber +--- + +# Remove-CsHybridTelephoneNumber + +## SYNOPSIS +This cmdlet removes a hybrid telephone number. + +## SYNTAX + +### Remove (Default) +``` +Remove-CsHybridTelephoneNumber -TelephoneNumber [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### RemoveViaIdentity +``` +Remove-CsHybridTelephoneNumber -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet removes a hybrid telephone number used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + +> [!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](new-csonlinetelephonenumberreleaseorder.md). + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsHybridTelephoneNumber -TelephoneNumber 14025551234 +``` +This example removes the hybrid phone number +1 (402) 555-1234. + +## PARAMETERS + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +{{ Fill InputObject Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: RemoveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +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: Remove +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: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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](http://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/microsoftteams/new-cshybridtelephonenumber) + +[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/get-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern.md index c41907981c..12a1f8a6df 100644 --- a/teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -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: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundblockednumberpattern schema: 2.0.0 +title: Remove-CsInboundBlockedNumberPattern --- # Remove-CsInboundBlockedNumberPattern @@ -35,6 +36,21 @@ This example removes a blocked number pattern identified as "BlockAutomatic". ## 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 A unique identifier specifying the blocked number pattern to be removed. @@ -66,21 +82,6 @@ Accept 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). @@ -92,8 +93,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundblockednumberpattern) -[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundblockednumberpattern) -[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundExemptNumberPattern.md similarity index 82% rename from teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsInboundExemptNumberPattern.md index 2abeb0572b..3b713cac0f 100644 --- a/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern +schema: 2.0.0 +title: Remove-CsInboundExemptNumberPattern --- # Remove-CsInboundExemptNumberPattern @@ -35,6 +35,21 @@ This removes the exempt number patterns with Identity Exempt1. ## 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 exempt number pattern to be listed. @@ -66,21 +81,6 @@ Accept 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). @@ -93,12 +93,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable 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) +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundexemptnumberpattern) -[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundexemptnumberpattern) -[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundexemptnumberpattern) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) -[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/MicrosoftTeams/Remove-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/MicrosoftTeams/Remove-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..22c8bc1dbf --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1,84 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csmainlineattendantappointmentbookingflow +schema: 2.0.0 +title: Remove-CsMainlineAttendantAppointmentBookingFlow +--- + +# Remove-CsMainlineAttendantAppointmentBookingFlow + +## SYNOPSIS +The Remove-CsMainlineAttendantAppointmentBookingFlow cmdlet deletes an existing Mainline attendant appointment booking flow. + +## SYNTAX + +``` +Remove-CsMainlineAttendantAppointmentBookingFlow -Identity [-Tenant ] [] +``` + +## DESCRIPTION +The Remove-CsMainlineAttendantAppointmentBookingFlow cmdlet deletes an existing Mainline attendant appointment booking flow. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsMainlineAttendantAppointmentBookingFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example removes the Mainline attendant appointment booking flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no appointment booking flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Identity +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 Mainline attendant appointment booking flow. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + diff --git a/teams/teams-ps/MicrosoftTeams/Remove-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/MicrosoftTeams/Remove-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..023b3d2ee9 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1,84 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csmainlineattendantquestionanswerflow +schema: 2.0.0 +title: Remove-CsMainlineAttendantQuestionAnswerFlow +--- + +# Remove-CsMainlineAttendantQuestionAnswerFlow + +## SYNOPSIS +The Remove-CsMainlineAttendantQuestionAnswerFlow cmdlet deletes an existing Mainline attendant question and answer flow. + +## SYNTAX + +``` +Remove-CsMainlineAttendantQuestionAnswerFlow -Identity [-Tenant ] [] +``` + +## DESCRIPTION +The Remove-CsMainlineAttendantQuestionAnswerFlow cmdlet deletes an existing Mainline attendant question and answer flow. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsMainlineAttendantQuestionAnswerFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example removes the Mainline attendant question and answer flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no question and answer flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Identity +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 Mainline attendant question and answer flow. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + diff --git a/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation.md similarity index 82% rename from teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation.md index 1fb51dfc00..baa0fc9cd3 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation +schema: 2.0.0 +title: Remove-CsOnlineApplicationInstanceAssociation --- # Remove-CsOnlineApplicationInstanceAssociation @@ -28,7 +30,7 @@ This is useful when you want to associate this application instance with another ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Remove-CsOnlineApplicationInstanceAssociation -Identities "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` @@ -38,13 +40,15 @@ This example removes the configuration association for the application instance ## PARAMETERS ### -Identities + +> Applicable: Microsoft Teams + The identities for the application instances whose configuration associations are to be removed. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -55,11 +59,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -84,8 +89,8 @@ The Remove-CsOnlineApplicationInstanceAssociation cmdlet accepts a string array ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation) -[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus) -[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioConferencingRoutingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioConferencingRoutingPolicy.md index b9ca408b21..285353fcd0 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,128 +1,129 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Remove-CsOnlineAudioConferencingRoutingPolicy +--- + +# 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/teams/teams-ps/teams/Remove-CsOnlineAudioFile.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioFile.md similarity index 70% rename from teams/teams-ps/teams/Remove-CsOnlineAudioFile.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioFile.md index 61f7bace1f..ef2290df7a 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineAudioFile.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioFile.md @@ -1,13 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineaudiofile +schema: 2.0.0 +title: Remove-CsOnlineAudioFile --- # Remove-CsOnlineAudioFile @@ -17,9 +17,8 @@ Marks an audio file of application type TenantGlobal for deletion and later remo ## SYNTAX -```powershell -Remove-CsOnlineAudioFile -Identity [] - +``` +Remove-CsOnlineAudioFile -Identity [-HttpPipelinePrepend ] [] ``` ## DESCRIPTION @@ -35,6 +34,21 @@ This cmdlet marks the audio file with Id dcfcc31daa9246f29d94d0a715ef877e for de ## PARAMETERS +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The Id of the specific audio file that you would like to mark for deletion. @@ -44,13 +58,14 @@ 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -69,8 +84,8 @@ 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) +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/export-csonlineaudiofile) -[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineaudiofile) -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings.md index 09faa588af..145288f16b 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinedialinconferencingtenantsettings +schema: 2.0.0 +title: Remove-CsOnlineDialInConferencingTenantSettings --- # Remove-CsOnlineDialInConferencingTenantSettings @@ -28,7 +30,7 @@ You can modify the settings using `Set-CsOnlineDialInConferencingTenantSettings` ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineDialInConferencingTenantSettings ``` @@ -37,30 +39,16 @@ This example reverts the tenant level dial-in conferencing settings to their ori ## PARAMETERS -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -Confirm -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -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 @@ -70,6 +58,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -78,7 +69,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -87,14 +77,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -104,6 +114,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -111,7 +124,6 @@ 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 Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisCivicAddress.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisCivicAddress.md index e78d109481..38137f3937 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisCivicAddress.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress applicable: Microsoft Teams -title: Remove-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliscivicaddress +schema: 2.0.0 +title: Remove-CsOnlineLisCivicAddress --- # Remove-CsOnlineLisCivicAddress @@ -45,6 +46,9 @@ This example removes all the emergency civic addresses in the city of Redmond. ## PARAMETERS ### -CivicAddressId + +> Applicable: Microsoft Teams + Specifies the unique identifier of the civic address to be deleted. You can find civic address identifiers by using the Get-CsOnlineLisCivicAddress cmdlet. @@ -52,7 +56,6 @@ You can find civic address identifiers by using the Get-CsOnlineLisCivicAddress Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -61,16 +64,16 @@ 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. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -79,15 +82,18 @@ 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. +### -Force + +> Applicable: Microsoft Teams + +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: wi -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -96,14 +102,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -WhatIf + +> Applicable: Microsoft Teams + +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: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -127,8 +136,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliscivicaddress) -[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineliscivicaddress) -[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisLocation.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisLocation.md index 4006964361..48af105cc5 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation applicable: Microsoft Teams -title: Remove-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelislocation +schema: 2.0.0 +title: Remove-CsOnlineLisLocation --- # Remove-CsOnlineLisLocation @@ -37,31 +38,16 @@ This example removes the location specified by its identity. ## PARAMETERS -### -LocationId -Specifies the unique identifier of the location to be deleted. -Location identities can be discovered by using the Get-CsOnlineLisLocation cmdlet. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -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 @@ -71,6 +57,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -79,7 +68,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -88,7 +76,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationId + +> Applicable: Microsoft Teams + +Specifies the unique identifier of the location to be deleted. +Location identities can be discovered by using the Get-CsOnlineLisLocation cmdlet. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -96,7 +106,6 @@ 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 Required: False Position: Named @@ -120,8 +129,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelislocation) -[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelislocation) -[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinelislocation) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisPort.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisPort.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsOnlineLisPort.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisPort.md index 6e1665a058..f119fd2f3b 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisPort.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisPort.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport applicable: Microsoft Teams -title: Remove-CsOnlineLisPort -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisport +schema: 2.0.0 +title: Remove-CsOnlineLisPort --- # Remove-CsOnlineLisPort @@ -38,13 +39,15 @@ Example 1 removes the location information for port 12174 with ChassisID 0B-23-C ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -53,16 +56,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -PortID -This parameter identifies the ID of the port. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -70,6 +75,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -78,7 +86,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -88,13 +95,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -104,13 +113,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,30 +130,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore -This parameter is reserved for internal Microsoft use. +### -PortID + +> Applicable: Microsoft Teams + +This parameter identifies the ID of the port. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -152,6 +167,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -159,7 +177,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -185,6 +202,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport) +[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisport) -[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport) +[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisport) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSubnet.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSubnet.md index eec633e37e..0c421973af 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSubnet.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelissubnet applicable: Microsoft Teams -title: Remove-CsOnlineLisSubnet -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelissubnet +schema: 2.0.0 +title: Remove-CsOnlineLisSubnet --- # Remove-CsOnlineLisSubnet @@ -26,14 +27,14 @@ Enhanced 9-1-1 (E9-1-1) allows an emergency operator to identify the location of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineLisSubnet -Subnet 10.10.10.10 ``` Example 1 removes the Location Information Service subnet "10.10.10.10". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Remove-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e ``` @@ -43,13 +44,15 @@ Example 1 removes the Location Information Service subnet "2001:4898:e8:6c:90d2: ## PARAMETERS ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -67,7 +73,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -93,13 +100,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -109,13 +118,15 @@ Accept wildcard characters: False ``` ### -Subnet + +> Applicable: Microsoft Teams + The IP address of the subnet. This value can be either IPv4 or IPv6 format. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 1 @@ -125,13 +136,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -141,13 +154,15 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 @@ -157,6 +172,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -164,7 +182,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSwitch.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSwitch.md index be82fd7ba5..682853fd4a 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSwitch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch applicable: Microsoft Teams -title: Remove-CsOnlineLisSwitch -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisswitch +schema: 2.0.0 +title: Remove-CsOnlineLisSwitch --- # Remove-CsOnlineLisSwitch @@ -36,13 +37,15 @@ Example 1 removes the switch with Chassis ID "0B-23-CD-16-AA-CC". ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -51,7 +54,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the 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 + +> Applicable: Microsoft Teams + 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. @@ -60,7 +84,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -70,13 +93,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -86,13 +111,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -102,13 +129,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -117,23 +146,10 @@ Accept 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 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -141,7 +157,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -167,6 +182,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch) +[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisswitch) -[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch) +[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisswitch) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint.md index ff2c7da4d7..8d03c86be1 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint applicable: Microsoft Teams -title: Remove-CsOnlineLisWirelessAccessPoint -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliswirelessaccesspoint +schema: 2.0.0 +title: Remove-CsOnlineLisWirelessAccessPoint --- # Remove-CsOnlineLisWirelessAccessPoint @@ -47,13 +48,15 @@ Example 2 removes the Location Information Server (LIS) wireless access point wi ## PARAMETERS ### -BSSID + +> Applicable: Microsoft Teams + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. It can be presented in wildcard format. The wildcard '*' can be on either the last one or two character(s). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -62,7 +65,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the 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 + +> Applicable: Microsoft Teams + 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. @@ -71,7 +95,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -81,13 +104,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -97,13 +122,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -113,13 +140,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -128,23 +157,10 @@ Accept 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 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -152,7 +168,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -176,6 +191,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint) +[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliswirelessaccesspoint) -[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint) +[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliswirelessaccesspoint) diff --git a/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlinePSTNGateway.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlinePSTNGateway.md index 6af2287599..5e869c3ef1 100644 --- a/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlinePSTNGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway applicable: Microsoft Teams -title: Remove-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinepstngateway +schema: 2.0.0 +title: Remove-CsOnlinePSTNGateway --- # Remove-CsOnlinePSTNGateway @@ -35,13 +36,15 @@ This example removes SBC with Identity (and FQDN) sbc.contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The parameter is mandatory for the cmdlet. The Identity is the same as the SBC FQDN. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -62,8 +65,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstngateway) -[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinepstngateway) -[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstngateway) diff --git a/teams/teams-ps/teams/Remove-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineSchedule.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineSchedule.md index 6dc49f8900..c72b991afe 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineschedule +schema: 2.0.0 +title: Remove-CsOnlineSchedule --- # Remove-CsOnlineSchedule @@ -25,7 +27,7 @@ The Remove-CsOnlineSchedule cmdlet deletes a schedule that is specified by using ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" ``` @@ -35,13 +37,15 @@ This example deletes the schedule that has an Id of fa9081d6-b4f3-5c96-baec-0b00 ## PARAMETERS ### -Id + +> Applicable: Microsoft Teams + The Id for the schedule to be removed. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -52,11 +56,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -81,6 +86,6 @@ The Remove-CsOnlineSchedule cmdlet accepts a string as the Id parameter. ## RELATED LINKS -[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) -[Set-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/set-csonlineschedule) +[Set-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineschedule) diff --git a/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineTelephoneNumber.md similarity index 92% rename from teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineTelephoneNumber.md index 4c26d98627..56112491b0 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineTelephoneNumber.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinetelephonenumber +schema: 2.0.0 +title: Remove-CsOnlineTelephoneNumber --- # Remove-CsOnlineTelephoneNumber @@ -26,7 +27,7 @@ This cmdlet removes one or more unassigned telephone numbers from your tenant. I ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineTelephoneNumber -TelephoneNumber 14258884567 ``` @@ -38,7 +39,7 @@ NumberIdsDeleted NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManage This example removes the specified telephone number from the tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` [string[]]$tns="+14255551234","+14255551233" Remove-CsOnlineTelephoneNumber -TelephoneNumber $tns @@ -54,28 +55,30 @@ 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 with or without the prefixed +, but needs to include country code etc. +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml -Type: String[] +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +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. +### -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: cf +Aliases: Required: False Position: Named @@ -84,17 +87,15 @@ 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. +### -TelephoneNumber +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: SwitchParameter +Type: String[] Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -134,4 +135,4 @@ None 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](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber) +[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumber) diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoute.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoute.md index c2487ee802..7477590ac3 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute applicable: Microsoft Teams -title: Remove-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroute +schema: 2.0.0 +title: Remove-CsOnlineVoiceRoute --- # Remove-CsOnlineVoiceRoute @@ -27,21 +28,21 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsOnlineVoiceRoute -Identity Route1 ``` Removes the settings for the online voice route with the identity Route1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\ Get-CsOnlineVoiceRoute | Remove-CsOnlineVoiceRoute ``` This command removes all online voice routes from the organization. First all online voice routes are retrieved by the `Get-CsOnlineVoiceRoute` cmdlet. These online voice routes are then piped to the `Remove-CsOnlineVoiceRoute` cmdlet, which removes each one. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\ Get-CsOnlineVoiceRoute -Filter *Redmond* | Remove-CsOnlineVoiceRoute ``` @@ -108,8 +109,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroute) -[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy.md index a92e803b2c..cc61a8333c 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Remove-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Remove-CsOnlineVoiceRoutingPolicy --- # Remove-CsOnlineVoiceRoutingPolicy @@ -29,21 +30,21 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" ``` The command shown in Example 1 deletes the online voice routing policy RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy -Filter "tag:*" | Remove-CsOnlineVoiceRoutingPolicy ``` In Example 2, all the online voice routing policies configured at the per-user scope are removed. To do this, the command first calls the `Get-CsOnlineVoiceRoutingPolicy` cmdlet along with the Filter parameter; the filter value "tag:\*" limits the returned data to online voice routing policies configured at the per-user scope. Those per-user policies are then piped to and removed by, the `Remove-CsOnlineVoiceRoutingPolicy` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Long Distance"} | Remove-CsOnlineVoiceRoutingPolicy ``` @@ -52,6 +53,21 @@ In Example 3, all the online voice routing polices that include the online PSTN ## 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. @@ -83,21 +99,6 @@ Accept 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). @@ -110,10 +111,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy) -[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy.md similarity index 83% rename from teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy.md index 37611ecdb3..f0f199b9b2 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy +schema: 2.0.0 +title: Remove-CsOnlineVoicemailPolicy --- # Remove-CsOnlineVoicemailPolicy @@ -26,7 +27,7 @@ Deletes an existing Online Voicemail policy or resets the Global policy instance ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" ``` @@ -34,46 +35,52 @@ The command shown in Example 1 deletes a per-user online voicemail policy Custom ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False -Position: 1 +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. +### -Identity + +> Applicable: Microsoft Teams + +A unique identifier specifying the scope, and in some cases the name, of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -93,10 +100,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/teams/get-csonlinevoicemailpolicy) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberAssignment.md similarity index 60% rename from teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberAssignment.md index 2bd32016e0..35819f80d0 100644 --- a/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberAssignment.md @@ -1,135 +1,183 @@ ---- -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 -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) -```powershell -Remove-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType [] -``` - -### RemoveAll -```powershell -Remove-CsPhoneNumberAssignment -Identity -RemoveAll [] -``` - -## DESCRIPTION -This cmdlet removes/unassigns a phone number from a user or resource account. The phone number continues to be available in the tenant. - -Unassigning a phone number from a user or resource account will automatically set EnterpriseVoiceEnabled to False. - -If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a -Code string parameter and a Message string parameter with additional details of the failure. - -**Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an -exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also -now support the -ErrorAction parameter to control the execution after an error has occurred. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan -``` -This example removes/unassigns the Microsoft Calling Plan phone number +1 (206) 555-1234 from the user user1@contoso.com. - -### Example 2 -```powershell -Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll -``` -This example removes/unassigns the phone number from user2@contoso.com. - -## PARAMETERS - -### -Identity -The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or -resource account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -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) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumberType -The type of phone number to unassign from the user or resource account. The supported values are DirectRouting, CallingPlan and OperatorConnect. - -```yaml -Type: System.String -Parameter Sets: (RemoveSome) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveAll -Unassigns the phone number from the user or resource account. - -```yaml -Type: Switch -Parameter Sets: (RemoveAll) -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 PowerShell module 3.0.0 or later. - -The cmdlet is only available in commercial and GCC cloud instances. - -## RELATED LINKS -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) - -[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment +schema: 2.0.0 +title: Remove-CsPhoneNumberAssignment +--- + +# Remove-CsPhoneNumberAssignment + +## SYNOPSIS +This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). + +## SYNTAX + +### RemoveSome (Default) +``` +Remove-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType + [-HttpPipelinePrepend ] [-Notify] [] +``` + +### RemoveAll +``` +Remove-CsPhoneNumberAssignment -Identity [-HttpPipelinePrepend ] [-RemoveAll] + [-Notify] [] +``` + +## DESCRIPTION +This cmdlet removes/unassigns a phone number from a user or resource account. The phone number continues to be available in the tenant. + +Unassigning a phone number from a user or resource account will automatically set EnterpriseVoiceEnabled to False. + +If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a +Code string parameter and a Message string parameter with additional details of the failure. Email notification to end user is a best effort operation. No error message will be displayed if the email fails to send. + + +**Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an +exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also +now support the -ErrorAction parameter to control the execution after an error has occurred. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan +``` +This example removes/unassigns the Microsoft Calling Plan telephone number +1 (206) 555-1234 from the user user1@contoso.com. + +### Example 2 +```powershell +Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll +``` +This example removes/unassigns all the telephone number from user2@contoso.com. + +### Example 3 +```powershell +Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan -Notify +``` +This example removes/unassigns the Microsoft Calling Plan phone number +1 (206) 555-1234 from the user user1@contoso.com and also sends an email notification to the user about the removal of telephone number. + +### Example 4 +```powershell +Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll -Notify +``` +This example removes/unassigns all the telephone number from user2@contoso.com and also sends an email notification to the user about the change. + +## PARAMETERS + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or +resource account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumberType +The type of phone number to unassign from the user or resource account. The supported values are DirectRouting, CallingPlan and OperatorConnect. + +```yaml +Type: System.String +Parameter Sets: RemoveSome +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAll +Unassigns the phone number from the user or resource account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemoveAll +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notify +Sends a best-effort email notification when a phone number is removed. Failures to send email are not reported. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +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](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) + +[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumberassignment) diff --git a/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberTag.md new file mode 100644 index 0000000000..7b336cff3c --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberTag.md @@ -0,0 +1,83 @@ +--- +applicable: Microsoft Teams +author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +ms.reviewer: pavellatif +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumbertag +schema: 2.0.0 +title: Remove-CsPhoneNumberTag +--- + +# 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/MicrosoftTeams/Remove-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/Remove-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..c12ad30521 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,88 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: tomkau +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: Remove-CsSharedCallQueueHistoryTemplate +--- + +# Remove-CsSharedCallQueueHistoryTemplate + +## SYNOPSIS +Deletes a Shared Call Queue History template. + +## SYNTAX + +``` +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 + +> Applicable: Microsoft Teams + +The Id parameter is the unique identifier assigned to the Shared Call Queue History template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### 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/MicrosoftTeams/Remove-CsTeamTemplate.md similarity index 91% rename from teams/teams-ps/teams/Remove-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamTemplate.md index ee73ec6d3d..f4fe5c56f8 100644 --- a/teams/teams-ps/teams/Remove-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamTemplate.md @@ -1,273 +1,276 @@ ---- -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-csteamtemplate -title: Remove-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: farahf -schema: 2.0.0 ---- - -# Remove-CsTeamTemplate - -## SYNOPSIS - -This cmdlet deletes a specified Team Template from Microsoft Teams. - -## SYNTAX - -### Delete (Default) - -```powershell -Remove-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### DeleteViaIdentity - -```powershell -Remove-CsTeamTemplate -InputObject [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -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'. - -### EXAMPLE 2 - -```powershell -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'. - -## PARAMETERS - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OdataId - -A composite URI of a template. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IAny - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -## NOTES - -ALIASES - -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 ]`: -- `[CivicAddressId ]`: Civic address id. -- `[Country ]`: -- `[GroupId ]`: The ID of a group whose policy assignments will be returned. -- `[Id ]`: -- `[Identity ]`: -- `[Locale ]`: -- `[LocationId ]`: Location id. -- `[OdataId ]`: A composite URI of a template. -- `[OperationId ]`: The ID of a batch policy assignment operation. -- `[OrderId ]`: -- `[PackageName ]`: The name of a specific policy package -- `[PolicyType ]`: The policy type for which group policy assignments will be returned. -- `[Port ]`: -- `[PortInOrderId ]`: -- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. -- `[SubnetId ]`: -- `[TenantId ]`: -- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -## 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) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: farahf +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamtemplate +schema: 2.0.0 +title: Remove-CsTeamTemplate +--- + +# Remove-CsTeamTemplate + +## SYNOPSIS +This cmdlet deletes a specified Team Template from Microsoft Teams. + +## SYNTAX + +### Delete (Default) + +``` +Remove-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity + +``` +Remove-CsTeamTemplate -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet deletes a specified Team Template from Microsoft Teams. The template can be identified by its OData ID or by using the Identity parameter. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +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'. + +### EXAMPLE 2 + +```powershell +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'. + +## PARAMETERS + +### -Break + +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +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. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OdataId + +A composite URI of a template. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +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: 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: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IAny + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +## NOTES + +ALIASES + +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 ]`: +- `[CivicAddressId ]`: Civic address id. +- `[Country ]`: +- `[GroupId ]`: The ID of a group whose policy assignments will be returned. +- `[Id ]`: +- `[Identity ]`: +- `[Locale ]`: +- `[LocationId ]`: Location id. +- `[OdataId ]`: A composite URI of a template. +- `[OperationId ]`: The ID of a batch policy assignment operation. +- `[OrderId ]`: +- `[PackageName ]`: The name of a specific policy package +- `[PolicyType ]`: The policy type for which group policy assignments will be returned. +- `[Port ]`: +- `[PortInOrderId ]`: +- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. +- `[SubnetId ]`: +- `[TenantId ]`: +- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +## RELATED LINKS + +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) + +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplate) + +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamtemplate) + +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamtemplate) + +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAIPolicy.md similarity index 70% rename from teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAIPolicy.md index 655f12b5b5..524da05c3f 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: andywang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsTeamsAIPolicy +schema: 2.0.0 +title: Remove-CsTeamsAIPolicy --- # Remove-CsTeamsAIPolicy @@ -23,7 +24,7 @@ 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. 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. +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. @@ -64,10 +65,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaipolicy) -[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaipolicy) -[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy.md similarity index 74% rename from teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy.md index 409570c300..3fbe3ba680 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy.md @@ -1,26 +1,21 @@ --- -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 +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsapppermissionpolicy +schema: 2.0.0 +title: Remove-CsTeamsAppPermissionPolicy --- # 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.** +This cmdlet allows you to remove app permission policies that have been created within your organization. ## SYNTAX @@ -36,6 +31,8 @@ As an admin, you can use app permission policies to enable or block specific app 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.** + ## EXAMPLES ### Example 1 @@ -47,33 +44,34 @@ 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. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -82,30 +80,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Microsoft Teams + +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: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Microsoft Teams + +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -114,14 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -WhatIf + +> Applicable: Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy.md similarity index 73% rename from teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy.md index fa290e6383..fae66e7260 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy.md @@ -1,25 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsappsetuppolicy +schema: 2.0.0 +title: Remove-CsTeamsAppSetupPolicy --- # Remove-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: You can use this cmdlet to remove custom app setup policies. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -If you run Remove-CsTeamsAppSetupPolicy on the Global policy, it will be reset to the defaults provided for new organizations. +You can use this cmdlet to remove custom app setup policies. ## SYNTAX @@ -48,33 +44,34 @@ 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. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -83,30 +80,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Microsoft Teams + +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: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Microsoft Teams + +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -115,14 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -WhatIf + +> Applicable: Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy.md index 5866a31e39..532fd43779 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy -title: Remove-CsTeamsAudioConferencingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaudioconferencingpolicy schema: 2.0.0 +title: Remove-CsTeamsAudioConferencingPolicy --- # Remove-CsTeamsAudioConferencingPolicy @@ -32,6 +33,21 @@ In the example shown above, the command will delete the "Emea Users" audio confe ## 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. Suppresses any confirmation prompts that would otherwise be displayed before making changes. @@ -63,21 +79,6 @@ 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. @@ -107,8 +108,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy) -[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy.md index e735cc0dc3..4a01c1b807 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -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: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallholdpolicy +schema: 2.0.0 +title: Remove-CsTeamsCallHoldPolicy --- # Remove-CsTeamsCallHoldPolicy @@ -48,18 +49,18 @@ The Filter value "Tag:*" limits the returned data to Teams call hold policies co ## PARAMETERS -### -Identity -Unique identifier of the Teams call hold policy to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -78,29 +79,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity +Unique identifier of the Teams call hold policy to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) 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 Required: False Position: Named @@ -122,10 +123,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy) -[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallholdpolicy) -[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallholdpolicy) -[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallholdpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallParkPolicy.md similarity index 92% rename from teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallParkPolicy.md index 8504928e7c..17db311865 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallParkPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallparkpolicy +schema: 2.0.0 +title: Remove-CsTeamsCallParkPolicy --- # Remove-CsTeamsCallParkPolicy @@ -39,33 +41,34 @@ Deletes a custom policy that has already been created in the organization. ## PARAMETERS -### -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. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -74,30 +77,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Microsoft Teams + +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: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Microsoft Teams + +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -106,14 +116,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -WhatIf + +> Applicable: Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallingPolicy.md similarity index 86% rename from teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallingPolicy.md index f22acb63d5..8a566bb862 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallingPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallingpolicy schema: 2.0.0 +title: Remove-CsTeamsCallingPolicy --- # Remove-CsTeamsCallingPolicy @@ -41,33 +42,33 @@ 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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity + The Identity parameter is the unique identifier of the Teams Calling Policy instance to remove or reset. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -100,10 +101,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallingpolicy) -[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallingpolicy) -[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallingpolicy) -[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsChannelsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsChannelsPolicy.md index 1adb7d3231..950b555a5a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsChannelsPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamschannelspolicy +schema: 2.0.0 +title: Remove-CsTeamsChannelsPolicy --- # Remove-CsTeamsChannelsPolicy @@ -39,34 +41,16 @@ Deletes a custom policy that has already been created in the organization. ## PARAMETERS -### -Identity -The name of the policy to be removed. Wildcards are not supported. - -To remove a custom policy, use syntax similar to this: `-Identity "Student Policy"`. - -To "remove" the global policy, use the following syntax: `-Identity Global`. You can't actually remove the global policy. Instead, all properties will be reset to their default values as shown in the default policy (`Tag:Default`). - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -Confirm -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -76,13 +60,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -91,14 +77,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +The name of the policy to be removed. Wildcards are not supported. + +To remove a custom policy, use syntax similar to this: `-Identity "Student Policy"`. + +To "remove" the global policy, use the following syntax: `-Identity Global`. You can't actually remove the global policy. Instead, all properties will be reset to their default values as shown in the default policy (`Tag:Default`). + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Tenant + +> Applicable: Microsoft Teams + Internal Microsoft use only. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -108,13 +118,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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 diff --git a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication.md index 05cb425285..1e18077eff 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication +schema: 2.0.0 +title: Remove-CsTeamsComplianceRecordingApplication --- # Remove-CsTeamsComplianceRecordingApplication @@ -55,6 +56,36 @@ The command shown in Example 2 deletes all existing associations between applica ## 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 A name that uniquely identifies the application instance of the policy-based recording application. @@ -100,36 +131,6 @@ Accept 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. @@ -161,20 +162,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy.md similarity index 86% rename from teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy.md index c121ab2692..2aae88bb8e 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: Remove-CsTeamsComplianceRecordingPolicy --- # Remove-CsTeamsComplianceRecordingPolicy @@ -56,6 +57,36 @@ The Filter value "Tag:*" limits the returned data to Teams recording policies co ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier to be assigned to the new Teams recording policy. @@ -99,36 +130,6 @@ Accept 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. @@ -160,20 +161,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCortanaPolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCortanaPolicy.md index bac8a3df1d..70da0afba6 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscortanapolicy +schema: 2.0.0 +title: Remove-CsTeamsCortanaPolicy --- # Remove-CsTeamsCortanaPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCustomBannerText.md similarity index 81% rename from teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCustomBannerText.md index 8619d8cca2..f53e25f2f6 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCustomBannerText.md @@ -1,16 +1,16 @@ --- -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText -title: Remove-CsTeamsCustomBannerText -schema: 2.0.0 author: saleens7 +Locale: en-US +Module Name: MicrosoftTeams ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsTeamsCustomBannerText +schema: 2.0.0 +title: Remove-CsTeamsCustomBannerText --- # Remove-CsTeamsCustomBannerText ## SYNOPSIS - Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call. ## SYNTAX @@ -27,6 +27,7 @@ Removes a single instance of custom banner text. ## EXAMPLES ### Example 1 +```powershell PS C:\> Remove-CsTeamsCustomBannerText -Identity CustomText ``` @@ -35,13 +36,15 @@ This example removes a TeamsCustomBannerText instance with the name "CustomText" ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + Policy instance name (optional). ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -64,8 +67,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy.md similarity index 83% rename from teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy.md index 09e839d382..c9cb715046 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Remove-CsTeamsEmergencyCallRoutingPolicy --- # Remove-CsTeamsEmergencyCallRoutingPolicy @@ -42,6 +44,21 @@ This example resets the Teams Emergency Call Routing Global policy instance to i ## 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 of the Teams Emergency Call Routing policy to remove. @@ -73,21 +90,6 @@ Accept 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). @@ -99,10 +101,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy) -[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy) -[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy.md similarity index 84% rename from teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy.md index 0f35301904..d023e900fd 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy schema: 2.0.0 +title: Remove-CsTeamsEmergencyCallingPolicy --- # Remove-CsTeamsEmergencyCallingPolicy @@ -41,6 +43,21 @@ This example resets the Global Policy instance to 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 +``` + ### -Identity The Identity parameter is the unique identifier of the Teams Emergency Calling policy to remove. @@ -72,21 +89,6 @@ Accept 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). @@ -102,10 +104,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy) -[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy) -[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEnhancedEncryptionPolicy.md similarity index 86% rename from teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEnhancedEncryptionPolicy.md index 2e310c4d61..d21aab0d52 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEnhancedEncryptionPolicy.md @@ -1,128 +1,129 @@ ---- -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: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Remove-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Use this cmdlet to remove an existing Teams enhanced encryption policy. - -## SYNTAX - -``` -Remove-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Use this cmdlet to remove an existing Teams enhanced encryption policy. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> Remove-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerTeamsEnhancedEncryptionPolicy' -``` - -The command shown in Example 1 deletes the Teams enhanced encryption policy ContosoPartnerTeamsEnhancedEncryptionPolicy. - -### EXAMPLE 2 -```PowerShell -PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Filter 'Tag:*' | Remove-CsTeamsEnhancedEncryptionPolicy -``` - -In Example 2, all the Teams enhanced encryption policies configured at the per-user scope are removed. The Filter value "Tag:*" limits the returned data to Teams enhanced encryption policies configured at the per-user scope. Those per-user policies are then removed. - -## PARAMETERS - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -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: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Remove-CsTeamsEnhancedEncryptionPolicy +--- + +# Remove-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Use this cmdlet to remove an existing Teams enhanced encryption policy. + +## SYNTAX + +``` +Remove-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Use this cmdlet to remove an existing Teams enhanced encryption policy. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> Remove-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerTeamsEnhancedEncryptionPolicy' +``` + +The command shown in Example 1 deletes the Teams enhanced encryption policy ContosoPartnerTeamsEnhancedEncryptionPolicy. + +### EXAMPLE 2 +```PowerShell +PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Filter 'Tag:*' | Remove-CsTeamsEnhancedEncryptionPolicy +``` + +In Example 2, all the Teams enhanced encryption policies configured at the per-user scope are removed. The Filter value "Tag:*" limits the returned data to Teams enhanced encryption policies configured at the per-user scope. Those per-user policies are then removed. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy) + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEventsPolicy.md similarity index 92% rename from teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEventsPolicy.md index adc94c0242..517c39816e 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEventsPolicy.md @@ -1,94 +1,95 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamseventspolicy -title: Remove-CsTeamsEventsPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsEventsPolicy - -## SYNOPSIS -The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. - -## SYNTAX - -``` -Remove-CsTeamsEventsPolicy [-Identity] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Deletes a previously created TeamsEventsPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsEventsPolicy -Identity DisablePublicWebinars -``` - -In this example, the command will delete the DisablePublicWebinars policy from the organization's list of policies. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamseventspolicy +schema: 2.0.0 +title: Remove-CsTeamsEventsPolicy +--- + +# Remove-CsTeamsEventsPolicy + +## SYNOPSIS +The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. + +## SYNTAX + +``` +Remove-CsTeamsEventsPolicy [-Identity] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Deletes a previously created TeamsEventsPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsEventsPolicy -Identity DisablePublicWebinars +``` + +In this example, the command will delete the DisablePublicWebinars policy from the organization's list of policies. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy.md index c001e0e880..fe1c14b60a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Remove-CsTeamsFeedbackPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsfeedbackpolicy +schema: 2.0.0 +title: Remove-CsTeamsFeedbackPolicy --- # Remove-CsTeamsFeedbackPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFilesPolicy.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFilesPolicy.md index 8b2f609c8e..6fb3c9e4dc 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFilesPolicy.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy -title: Remove-CsTeamsFilesPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsfilespolicy schema: 2.0.0 +title: Remove-CsTeamsFilesPolicy --- # Remove-CsTeamsFilesPolicy @@ -58,11 +59,11 @@ You are not able to delete the pre-configured policy instances Default, Transcri ## RELATED LINKS -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy.md index f31fdeafd5..f2e7cec78a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsipphonepolicy schema: 2.0.0 +title: Remove-CsTeamsIPPhonePolicy --- # Remove-CsTeamsIPPhonePolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMediaConnectivityPolicy.md similarity index 82% rename from teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMediaConnectivityPolicy.md index a2b3b79a34..4e4a1dd7d4 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: runli +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +title: Remove-CsTeamsMediaConnectivityPolicy --- # Remove-CsTeamsMediaConnectivityPolicy @@ -62,8 +63,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy) -[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy) -[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy.md index ac3f34c82e..49a2313c07 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Remove-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # Remove-CsTeamsMeetingBrandingPolicy @@ -35,20 +35,6 @@ In this example, the command deletes the `policy test` meeting branding policy f ## PARAMETERS -### -Identity -Unique identifier of the policy to be deleted. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -79,6 +65,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique identifier of the policy to be deleted. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -WhatIf Describes what would happen if you executed the command without actually executing the command. @@ -107,12 +107,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy.md index 3b8ee0ebd4..3bcd894698 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy.md @@ -1,19 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Remove-CsTeamsMeetingBroadcastPolicy --- # Remove-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS -Remove-CsTeamsMeetingBroadcastPolicy \[-Identity\] \ \[-Tenant \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] +Deletes an existing Teams meeting broadcast policy in your tenant. ## SYNTAX @@ -23,7 +25,7 @@ Remove-CsTeamsMeetingBroadcastPolicy [-Tenant ] [-Identity] ``` ## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to delete an existing policy. +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## EXAMPLES diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingPolicy.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingPolicy.md index afc4b6bca6..e4a899e0bf 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingPolicy.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingpolicy +schema: 2.0.0 +title: Remove-CsTeamsMeetingPolicy --- # Remove-CsTeamsMeetingPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 84% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md index b813ff072b..85c5c31122 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Remove-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Remove-CsTeamsMeetingTemplatePermissionPolicy --- # Remove-CsTeamsMeetingTemplatePermissionPolicy @@ -54,13 +55,14 @@ At line:1 char:1 ### -Identity +> Applicable: Microsoft Teams + Identity of the policy instance to be deleted. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -78,10 +80,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy) -[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMessagingPolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMessagingPolicy.md index 1529b4300f..3b29832b50 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMessagingPolicy.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmessagingpolicy +schema: 2.0.0 +title: Remove-CsTeamsMessagingPolicy --- # Remove-CsTeamsMessagingPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMobilityPolicy.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMobilityPolicy.md index 8cce132f98..c37a73085b 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmobilitypolicy +schema: 2.0.0 +title: Remove-CsTeamsMobilityPolicy --- # Remove-CsTeamsMobilityPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy.md index 5192c02bc6..24b864bac3 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsnetworkroamingpolicy schema: 2.0.0 +title: Remove-CsTeamsNetworkRoamingPolicy --- # Remove-CsTeamsNetworkRoamingPolicy @@ -32,7 +32,7 @@ More on the impact of bit rate setting on bandwidth can be found [here](https:// ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsTeamsNetworkRoamingPolicy -Identity OfficePolicy ``` diff --git a/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNotificationAndFeedsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNotificationAndFeedsPolicy.md index 172211f455..0e3a9dad82 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNotificationAndFeedsPolicy.md @@ -1,109 +1,110 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsnotificationandfeedspolicy +schema: 2.0.0 +title: Remove-CsTeamsNotificationAndFeedsPolicy +--- + +# 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/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsPersonalAttendantPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsPersonalAttendantPolicy.md new file mode 100644 index 0000000000..a472467b17 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsPersonalAttendantPolicy.md @@ -0,0 +1,118 @@ +--- +applicable: Microsoft Teams +author: juliiva +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: jomarque +Module Name: MicrosoftTeams +ms.author: juliiva +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamspersonalattendantpolicy +schema: 2.0.0 +title: Remove-CsTeamsPersonalAttendantPolicy +--- + +# Remove-CsTeamsPersonalAttendantPolicy + +## SYNOPSIS + +**Limited Preview:** Functionality described in this document is currently in limited preview and only authorized organizations have access. + +Use this cmdlet to remove an existing instance of a Teams Personal Attendant Policy or reset the Global policy instance to the default values. + +## SYNTAX + +``` +Remove-CsTeamsPersonalAttendantPolicy -Identity [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet removes an existing Teams Personal Attendant Policy instance or resets the Global policy instance to the default values. + +## EXAMPLES + +### Example 1 +``` +Remove-CsTeamsPersonalAttendantPolicy -Identity SalesPersonalAttendantPolicy +``` + +This example removes the Teams Personal Attendant Policy with identity SalesPersonalAttendantPolicy + +### Example 2 +``` +Remove-CsTeamsPersonalAttendantPolicy -Identity Global +``` + +This example resets the Global Personal Attendant Policy instance to the default values. + +## PARAMETERS + +### -Identity + The Identity parameter is the unique identifier of the Teams Personal Attendant Policy instance to remove or reset. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +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 +``` + +### -Confirm +Prompts you for confirmation before running the 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 + +The cmdlet is available in Teams PowerShell module 7.2.1-preview or later. + +## RELATED LINKS + +[New-CsTeamsPersonalAttendantPolicy](./new-csteamspersonalattendantpolicy.md) + +[Get-CsTeamsPersonalAttendantPolicy](./get-csteamspersonalattendantpolicy.md) + +[Set-CsTeamsPersonalAttendantPolicy](./set-csteamspersonalattendantpolicy.md) + +[Grant-CsTeamsPersonalAttendantPolicy](./grant-csteamspersonalattendantpolicy.md) diff --git a/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRecordingRollOutPolicy.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRecordingRollOutPolicy.md index 6a51b6ae29..c654410d6a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams ms.author: ronwa +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsrecordingrolloutpolicy +schema: 2.0.0 +title: Remove-CsTeamsRecordingRollOutPolicy --- # Remove-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md index e1a8839e41..730c849119 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,107 +1,110 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Remove-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Remove-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Deletes an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +``` +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). + +## EXAMPLES + +## 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/MicrosoftTeams/Remove-CsTeamsSharedCallingRoutingPolicy.md similarity index 86% rename from teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSharedCallingRoutingPolicy.md index 536843d50b..31de502225 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsSharedCallingRoutingPolicy -schema: 2.0.0 author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy +schema: 2.0.0 +title: Remove-CsTeamsSharedCallingRoutingPolicy --- # Remove-CsTeamsSharedCallingRoutingPolicy @@ -44,29 +43,31 @@ and removed by the Remove-CsTeamsSharedCallingRoutingPolicy cmdlet. ## PARAMETERS -### -Identity -Unique identifier assigned to the policy when it is created. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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 @@ -75,29 +76,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity +Unique identifier assigned to the policy when it is created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) 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 Required: False Position: Named @@ -117,10 +118,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](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy) -[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy) -[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnection.md similarity index 84% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnection.md index a86968dfd2..e1b5bf16cf 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: stepfitz Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: stepfitz -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnection +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnection schema: 2.0.0 +title: Remove-CsTeamsShiftsConnection --- # Remove-CsTeamsShiftsConnection @@ -23,7 +24,7 @@ Remove-CsTeamsShiftsConnection -ConnectionId -InputObject Applicable: Microsoft Teams + The ID of the connection that you want to delete. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -95,8 +97,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection) -[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnection) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionInstance.md similarity index 77% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionInstance.md index 843cf262ce..736d85f320 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsConnectionInstance -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Remove-CsTeamsShiftsConnectionInstance --- # Remove-CsTeamsShiftsConnectionInstance @@ -23,7 +24,7 @@ Remove-CsTeamsShiftsConnectionInstance -ConnectorInstanceId [ Applicable: Microsoft Teams + The ID of the connection instance that you want to delete. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -63,8 +65,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionTeamMap.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionTeamMap.md index 48935f7bec..f0aee82c92 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionTeamMap.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsConnectionTeamMap -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectionteammap +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectionteammap schema: 2.0.0 +title: Remove-CsTeamsShiftsConnectionTeamMap --- # Remove-CsTeamsShiftsConnectionTeamMap @@ -23,7 +24,7 @@ Remove-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId -TeamId Applicable: Microsoft Teams The ID of the connection instance that you want to delete. @@ -60,7 +47,6 @@ The ID of the connection instance that you want to delete. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -100,6 +86,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamId + +> Applicable: Microsoft Teams + +The ID of the connection instance that you want to delete. + +```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). @@ -111,6 +114,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap) +[Get-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionteammap) -[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap) +[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectionbatchteammap) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsPolicy.md similarity index 82% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsPolicy.md index f7201e43a2..9433535351 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsPolicy.md @@ -1,70 +1,73 @@ ---- -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 ---- - -# Remove-CsTeamsShiftsPolicy - -## SYNOPSIS - -The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. - -Note: A TeamsShiftsPolicy needs to be unassigned from all the users before it can be deleted. - -## SYNTAX - -``` -Remove-CsTeamsShiftsPolicy [-Identity] [] -``` - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -``` - -In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". - -## PARAMETERS - -### -Identity -Policy instance name. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-teamsshiftspolicy +schema: 2.0.0 +title: Remove-CsTeamsShiftsPolicy +--- + +# Remove-CsTeamsShiftsPolicy + +## SYNOPSIS +The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. + +## SYNTAX + +``` +Remove-CsTeamsShiftsPolicy [-Identity] [] +``` + +## DESCRIPTION +Note: A TeamsShiftsPolicy needs to be unassigned from all the users before it can be deleted. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage +``` + +In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". + +## PARAMETERS + +### -Identity + +> Applicable: Microsoft Teams + +Policy instance name. + +```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 + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftspolicy) + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsScheduleRecord.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsScheduleRecord.md index 5c64fec405..b1ec41e3fd 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsScheduleRecord.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsScheduleRecord -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsschedulerecord +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsschedulerecord schema: 2.0.0 +title: Remove-CsTeamsShiftsScheduleRecord --- # Remove-CsTeamsShiftsScheduleRecord @@ -47,29 +48,29 @@ Removes the Shifts schedule record of swapRequest and openShiftRequest scenarios ## PARAMETERS -### -ClearSchedulingGroup -A value indicating whether to clear schedule group. +### -Body +The request body. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: IClearScheduleRequest +Parameter Sets: Remove Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -DateRangeEndDate -The end date of removing schedule record. +### -Break +Wait for .NET debugger to attach. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + Required: False Position: Named Default value: None @@ -77,29 +78,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DateRangeStartDate -The start date of removing schedule record. +### -ClearSchedulingGroup + +> Applicable: Microsoft Teams + +A value indicating whether to clear schedule group. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -The user ID of designated actor. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: RemoveExpanded -Aliases: -Applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + Required: False Position: Named Default value: None @@ -107,59 +110,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EntityType -The entity types. +### -DateRangeEndDate + +> Applicable: Microsoft Teams + +The end date of removing schedule record. ```yaml -Type: String[] -Parameter Sets: RemoveExpanded +Type: String +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamId -The Teams team ID where you want to remove schedule record. +### -DateRangeStartDate + +> Applicable: Microsoft Teams + +The start date of removing schedule record. ```yaml Type: String -Parameter Sets: RemoveExpanded +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Body -The request body. - -```yaml -Type: IClearScheduleRequest -Parameter Sets: Remove -Aliases: +### -DesignatedActorId -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Break -Wait for .NET debugger to attach. +The user ID of designated actor. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: RemoveExpanded Aliases: - Required: False Position: Named Default value: None @@ -167,15 +161,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -EntityType -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +> Applicable: Microsoft Teams -Required: False +The entity types. + +```yaml +Type: String[] +Parameter Sets: RemoveExpanded +Aliases: +Required: True Position: Named Default value: None Accept pipeline input: False @@ -272,6 +268,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamId + +> Applicable: Microsoft Teams + +The Teams team ID where you want to remove schedule record. + +```yaml +Type: String +Parameter Sets: RemoveExpanded +Aliases: +Required: True +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. diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliance.md similarity index 73% rename from teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliance.md index ec60890b7b..5a871abaeb 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliance.md @@ -1,103 +1,112 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssurvivablebranchappliance +schema: 2.0.0 +title: Remove-CsTeamsSurvivableBranchAppliance +--- + +# Remove-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Removes a Survivable Branch Appliance (SBA) from the tenant. + +## SYNTAX + +``` +Remove-CsTeamsSurvivableBranchAppliance [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +## 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/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md index 6aa49338fb..e33aac4d51 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,103 +1,108 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Remove-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Remove-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Removes a Survivable Branch Appliance (SBA) policy from the tenant. + +## SYNTAX + +``` +Remove-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +## 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/MicrosoftTeams/Remove-CsTeamsTargetingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTargetingPolicy.md index 669d6bc872..08e7368f74 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTargetingPolicy.md @@ -1,120 +1,121 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstargetingpolicy +schema: 2.0.0 +title: Remove-CsTeamsTargetingPolicy +--- + +# 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/microsoftteams/get-csteamstargetingpolicy) +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTemplatePermissionPolicy.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTemplatePermissionPolicy.md index 28ecb18cd4..50084252ca 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTemplatePermissionPolicy.md @@ -1,135 +1,135 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy -title: Remove-CsTeamsTemplatePermissionPolicy -author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: -manager: weiliu2 -schema: 2.0.0 ---- - -# Remove-CsTeamsTemplatePermissionPolicy - -## SYNOPSIS -Deletes an instance of TeamsTemplatePermissionPolicy. - -## SYNTAX - -``` -Remove-CsTeamsTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Deletes an instance of TeamsTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. - -## EXAMPLES - -### Example 1 -```powershell -PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar -``` - -Deletes a policy instance with the Identity *Foobar*. - -### Example 2 -```powershell -PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar -``` - -```output -Remove-CsTeamsTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users or groups. Ensure policy is not assigned before removing. Please refer to documentation. CorrelationId: 8622aac5-00c3-4071-b6d0-d070db8f663f -At line:1 char:1 -+ Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar ... -+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsTemplatePermissionPolicy], PolicyRpException - + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsTemplatePermissionPolicyCmdlet -``` - -Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. - -You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Name of the policy instance to be deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) - -[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) - -[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) +--- +author: yishuaihuang4 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy +schema: 2.0.0 +title: Remove-CsTeamsTemplatePermissionPolicy +--- + +# Remove-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Deletes an instance of TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +Remove-CsTeamsTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes an instance of TeamsTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +### Example 1 +```powershell +PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` + +Deletes a policy instance with the Identity *Foobar*. + +### Example 2 +```powershell +PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` + +```output +Remove-CsTeamsTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users or groups. Ensure policy is not assigned before removing. Please refer to documentation. CorrelationId: 8622aac5-00c3-4071-b6d0-d070db8f663f +At line:1 char:1 ++ Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsTemplatePermissionPolicy], PolicyRpException + + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsTemplatePermissionPolicyCmdlet +``` + +Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the policy instance to be deleted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy) + +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTranslationRule.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTranslationRule.md index a1cc4fdcae..3c4d85c496 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstranslationrule +schema: 2.0.0 +title: Remove-CsTeamsTranslationRule --- # Remove-CsTeamsTranslationRule @@ -42,6 +43,21 @@ This example removes all translation rules with Identifier starting with tst. ## 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 Identifier of the rule. This parameter is required. @@ -72,21 +88,6 @@ Accept 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). @@ -97,10 +98,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstranslationrule) -[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstranslationrule) -[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstranslationrule) -[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUnassignedNumberTreatment.md similarity index 79% rename from teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUnassignedNumberTreatment.md index 118a64f812..8bf1e3ee3c 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUnassignedNumberTreatment.md @@ -1,74 +1,73 @@ ---- -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 -title: Remove-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Remove-CsTeamsUnassignedNumberTreatment - -## SYNOPSIS -Removes a treatment for how calls to an unassigned number range should be routed. - -## SYNTAX - -``` -Remove-CsTeamsUnassignedNumberTreatment [-Identity] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet removes a treatment for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsTeamsUnassignedNumberTreatment -Identity MainAA -``` -This example removes the treatment MainAA. - -## PARAMETERS - -### -Identity -The Id of the specific treatment to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: ByPropertyName -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.5.1 or later. - -## RELATED LINKS -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) - -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) - -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) - -[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment +schema: 2.0.0 +title: Remove-CsTeamsUnassignedNumberTreatment +--- + +# Remove-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +Removes a treatment for how calls to an unassigned number range should be routed. + +## SYNTAX + +``` +Remove-CsTeamsUnassignedNumberTreatment [-Identity] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet removes a treatment for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsTeamsUnassignedNumberTreatment -Identity MainAA +``` +This example removes the treatment MainAA. + +## PARAMETERS + +### -Identity +The Id of the specific treatment to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: ByPropertyName +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +## RELATED LINKS +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment) + +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment) + +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUpdateManagementPolicy.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUpdateManagementPolicy.md index e558236294..3ebed226fd 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: gnamun +Module Name: MicrosoftTeams +ms.author: vargasj +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsupdatemanagementpolicy +schema: 2.0.0 +title: Remove-CsTeamsUpdateManagementPolicy --- # Remove-CsTeamsUpdateManagementPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVdiPolicy.md similarity index 93% rename from teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVdiPolicy.md index 66afd2e7e6..79dd7426cf 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVdiPolicy.md @@ -1,108 +1,109 @@ ---- -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 +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvdipolicy +schema: 2.0.0 +title: Remove-CsTeamsVdiPolicy +--- + +# 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/MicrosoftTeams/Remove-CsTeamsVirtualAppointmentsPolicy.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVirtualAppointmentsPolicy.md index a1a3852ec4..0d24c97b0a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy -title: Remove-CsTeamsVirtualAppointmentsPolicy -schema: 2.0.0 ms.author: erocha -author: emmanuelrocha001 -manager: sonaggarwal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy +schema: 2.0.0 +title: Remove-CsTeamsVirtualAppointmentsPolicy --- # Remove-CsTeamsVirtualAppointmentsPolicy @@ -109,10 +110,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy) -[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVoiceApplicationsPolicy.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVoiceApplicationsPolicy.md index 8458e8f402..5d603635c2 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy -title: Remove-CsTeamsVoiceApplicationsPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy schema: 2.0.0 +title: Remove-CsTeamsVoiceApplicationsPolicy --- # Remove-CsTeamsVoiceApplicationsPolicy @@ -37,6 +38,21 @@ In Example 2, all Teams voice applications policies configured at the per-user s ## 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. @@ -68,21 +84,6 @@ Accept 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). @@ -97,10 +98,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy) -[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy) -[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLoadPolicy.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLoadPolicy.md index c32aafbb08..375513c4fa 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLoadPolicy.md @@ -1,125 +1,126 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworkloadpolicy +schema: 2.0.0 +title: Remove-CsTeamsWorkLoadPolicy +--- + +# 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/microsoftteams/set-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLocationDetectionPolicy.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLocationDetectionPolicy.md index fd2938fd43..bf82c7158c 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur 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 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy +schema: 2.0.0 +title: Remove-CsTeamsWorkLocationDetectionPolicy --- # Remove-CsTeamsWorkLocationDetectionPolicy @@ -112,10 +113,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy) -[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy) -[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy) -[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantDialPlan.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantDialPlan.md index 41c2e91c20..ca0759ae95 100644 --- a/teams/teams-ps/teams/Remove-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantdialplan +schema: 2.0.0 +title: Remove-CsTenantDialPlan --- # Remove-CsTenantDialPlan @@ -32,7 +33,7 @@ If no tenant dial plan is assigned to an organization, the Global dial plan is u ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsTenantDialPlan -Identity Vt1TenantDialPlan2 ``` @@ -41,46 +42,52 @@ This example removes the Vt1TenantDialPlan2. ## PARAMETERS -### -Identity -The Identity parameter is the unique identifier of the tenant dial plan to remove. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm parameter prompts you for confirmation before the command is executed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm parameter prompts you for confirmation before the command is executed. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter is the unique identifier of the tenant dial plan to remove. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -102,10 +109,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cstenantdialplan) -[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan) -[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkRegion.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkRegion.md index 5e4b94b289..b3acfe35fc 100644 --- a/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion applicable: Microsoft Teams -title: Remove-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworkregion +schema: 2.0.0 +title: Remove-CsTenantNetworkRegion --- # Remove-CsTenantNetworkRegion @@ -36,33 +37,33 @@ The command shown in Example 1 removes 'RedmondRegion'. ## PARAMETERS -### -Identity -Unique identifier for the network region to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network region to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -94,8 +95,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworkregion) -[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworkregion) -[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSite.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSite.md index a21acb85be..ceb55656bb 100644 --- a/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite applicable: Microsoft Teams -title: Remove-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksite +schema: 2.0.0 +title: Remove-CsTenantNetworkSite --- # Remove-CsTenantNetworkSite @@ -37,33 +38,33 @@ The command shown in Example 1 removes 'site1'. ## PARAMETERS -### -Identity -Unique identifier for the network site to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network site to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -95,8 +96,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksite) -[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) -[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSubnet.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSubnet.md index 2e8c9def13..61c2284540 100644 --- a/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet applicable: Microsoft Teams -title: Remove-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksubnet +schema: 2.0.0 +title: Remove-CsTenantNetworkSubnet --- # Remove-CsTenantNetworkSubnet @@ -37,33 +38,33 @@ The command shown in Example 1 removes '192.168.0.1'. ## PARAMETERS -### -Identity -Unique identifier for the network subnet to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network subnet to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -93,8 +94,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksubnet) -[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksubnet) -[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet) +[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksubnet) diff --git a/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantTrustedIPAddress.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantTrustedIPAddress.md index 36eb4e2803..b3aef26e1f 100644 --- a/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantTrustedIPAddress.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenanttrustedipaddress +schema: 2.0.0 +title: Remove-CsTenantTrustedIPAddress --- # Remove-CsTenantTrustedIPAddress diff --git a/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md b/teams/teams-ps/MicrosoftTeams/Remove-CsUserCallingDelegate.md similarity index 70% rename from teams/teams-ps/teams/Remove-CsUserCallingDelegate.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsUserCallingDelegate.md index 56d6d9bce2..41b799defd 100644 --- a/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsUserCallingDelegate.md @@ -1,91 +1,106 @@ ---- -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 -title: Remove-CsUserCallingDelegate -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Remove-CsUserCallingDelegate - -## SYNOPSIS -This cmdlet will remove a delegate for calling in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -```powershell -Remove-CsUserCallingDelegate -Identity -Delegate [] -``` - -## DESCRIPTION -This cmdlet will remove a delegate for the specified user. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -``` -This example shows removing the delegate user2@contoso.com. - -## PARAMETERS - -### -Delegate -The Identity of the delegate to remove. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to remove a delegate for. Can be specified using the ObjectId or the SIP address. - -```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 -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -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](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csusercallingdelegate +schema: 2.0.0 +title: Remove-CsUserCallingDelegate +--- + +# Remove-CsUserCallingDelegate + +## SYNOPSIS +This cmdlet will remove a delegate for calling in Microsoft Teams. + +## SYNTAX + +``` +Remove-CsUserCallingDelegate -Identity -Delegate [-HttpPipelinePrepend ] + [] +``` + +## DESCRIPTION +This cmdlet will remove a delegate for the specified user. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com +``` +This example shows removing the delegate user2@contoso.com. + +## PARAMETERS + +### -Delegate +The Identity of the delegate to remove. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to remove a delegate for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +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](https://learn.microsoft.com/powershell/module/microsoftteams/get-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csusercallingdelegate) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md b/teams/teams-ps/MicrosoftTeams/Remove-CsUserLicenseGracePeriod.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsUserLicenseGracePeriod.md index 8ba1f83cc3..6ea72c3041 100644 --- a/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsUserLicenseGracePeriod.md @@ -1,13 +1,14 @@ --- +author: serdarsoysal +description: This cmdlet expedites the delicensing operation for an account's assigned plans by removing the grace period, permanently deleting the assigned plans. external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars +ms.date: 02/01/2024 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 +title: Remove-CsUserLicenseGracePeriod --- # Remove-CsUserLicenseGracePeriod @@ -63,19 +64,35 @@ In Example 2, the capability specified refers to plans assigned to the user(s) u ## PARAMETERS -### -Identity +### -Action -Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan. +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: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName,ByValue) +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -111,19 +128,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Identity -Returns the results of the command. By default, this cmdlet does not generate any output. +Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName,ByValue) Accept wildcard characters: False ``` @@ -143,12 +160,12 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Action +### -PassThru -Used to specify which action should be taken. +Returns the results of the command. By default, this cmdlet does not generate any output. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -159,22 +176,6 @@ 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). @@ -189,4 +190,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineuser) diff --git a/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/Remove-CsVideoInteropServiceProvider.md similarity index 79% rename from teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsVideoInteropServiceProvider.md index 9344dcff1d..87c04e1285 100644 --- a/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsVideoInteropServiceProvider.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csvideointeropserviceprovider +schema: 2.0.0 +title: Remove-CsVideoInteropServiceProvider --- # Remove-CsVideoInteropServiceProvider ## 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. +Use the Remove-CsVideoInteropServiceProvider to remove all provider information about a provider that your organization no longer uses. ## SYNTAX @@ -30,7 +31,7 @@ Remove-CsVideoInteropServiceProvider [[-Identity] ] ## DESCRIPTION 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. -Use the Remove-CsVideoInteropServiceProvider to remove all provider information about a provider that your organization no longer uses. The only input is Identity - the provider you wish to remove. +The only input is Identity - the provider you wish to remove. ## EXAMPLES diff --git a/teams/teams-ps/teams/Remove-SharedWithTeam.md b/teams/teams-ps/MicrosoftTeams/Remove-SharedWithTeam.md similarity index 88% rename from teams/teams-ps/teams/Remove-SharedWithTeam.md rename to teams/teams-ps/MicrosoftTeams/Remove-SharedWithTeam.md index e143bc6c3c..8ff065c637 100644 --- a/teams/teams-ps/teams/Remove-SharedWithTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-SharedWithTeam.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-sharedwithteam -title: Remove-SharedWithTeam -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-sharedwithteam +schema: 2.0.0 +title: Remove-SharedWithTeam --- # Remove-SharedWithTeam @@ -34,8 +35,8 @@ Unshares a channel with a team. ## PARAMETERS -### -HostTeamId -Team ID of the host team (Group ID). +### -ChannelId +Thread ID of the shared channel. ```yaml Type: String @@ -49,8 +50,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ChannelId -Thread ID of the shared channel. +### -HostTeamId +Team ID of the host team (Group ID). ```yaml Type: String @@ -84,11 +85,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### HostTeamId, ChannelId, SharedWithTeamId +### HostTeamId + +### ChannelId + +### SharedWithTeamId ## OUTPUTS ## NOTES ## RELATED LINKS -[Remove-Team](https://learn.microsoft.com/powershell/module/teams/remove-team) +[Remove-Team](https://learn.microsoft.com/powershell/module/microsoftteams/remove-team) diff --git a/teams/teams-ps/teams/Remove-Team.md b/teams/teams-ps/MicrosoftTeams/Remove-Team.md similarity index 87% rename from teams/teams-ps/teams/Remove-Team.md rename to teams/teams-ps/MicrosoftTeams/Remove-Team.md index b379c99308..9cd5325395 100644 --- a/teams/teams-ps/teams/Remove-Team.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-Team.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-team +schema: 2.0.0 +title: Remove-Team --- # Remove-Team @@ -62,4 +62,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) +[New-Team](https://learn.microsoft.com/powershell/module/microsoftteams/new-team) diff --git a/teams/teams-ps/teams/Remove-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannel.md similarity index 94% rename from teams/teams-ps/teams/Remove-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamChannel.md index 9ab0da2703..6c1315d525 100644 --- a/teams/teams-ps/teams/Remove-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannel.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-teamchannel +schema: 2.0.0 +title: Remove-TeamChannel --- # Remove-TeamChannel @@ -14,11 +14,6 @@ ms.reviewer: ## SYNOPSIS 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. -So a subsequent call to Add-TeamChannel using the same channel name will fail if enough time has not passed. - ## SYNTAX ``` @@ -26,6 +21,10 @@ Remove-TeamChannel -GroupId -DisplayName [] ``` ## DESCRIPTION +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. +So a subsequent call to Add-TeamChannel using the same channel name will fail if enough time has not passed. > [!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 `https://www.poshtestgallery.com/packages/MicrosoftTeams`. @@ -39,8 +38,8 @@ Remove-TeamChannel -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "T ## PARAMETERS -### -GroupId -GroupId of the team +### -DisplayName +Channel name to be deleted ```yaml Type: String @@ -54,8 +53,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Channel name to be deleted +### -GroupId +GroupId of the team ```yaml Type: String diff --git a/teams/teams-ps/teams/Remove-TeamChannelUser.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannelUser.md similarity index 79% rename from teams/teams-ps/teams/Remove-TeamChannelUser.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamChannelUser.md index 5593e0c440..11624d3a06 100644 --- a/teams/teams-ps/teams/Remove-TeamChannelUser.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannelUser.md @@ -1,21 +1,16 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-teamchanneluser -title: Remove-TeamChannelUser +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-teamchanneluser schema: 2.0.0 +title: Remove-TeamChannelUser --- # 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. - -To turn an existing Owner into a Member, specify role parameter as Owner. - -> [!Note] -> Last owner cannot be removed from the private channel. +Removes a user from a channel in Microsoft Teams. ## SYNTAX @@ -26,20 +21,28 @@ 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](/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](/microsoftteams/teams-powershell-release-notes). + +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 a Member, specify role parameter as Owner. + +> [!NOTE] +> Last owner cannot be removed from the private channel. ## EXAMPLES ### Example 1 + ``` Remove-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com ``` ## PARAMETERS -### -GroupId -GroupId of the team +### -DisplayName +Display name of the private channel ```yaml Type: String @@ -53,8 +56,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Display name of the private channel +### -GroupId +GroupId of the team ```yaml Type: String @@ -68,31 +71,31 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -User -User's email address (e.g. -johndoe@example.com) +### -Role +Use this to demote a user from owner to member of the team ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Role -Use this to demote a user from owner to member of the team +### -User +User's email address (e.g. +johndoe@example.com) ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) diff --git a/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamTargetingHierarchy.md similarity index 91% rename from teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamTargetingHierarchy.md index 01e2e675e0..b0e482b4ce 100644 --- a/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamTargetingHierarchy.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/connect-microsoftteams +schema: 2.0.0 +title: Remove-TeamTargetingHierarchy --- # Remove-TeamTargetingHierarchy @@ -61,4 +61,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy) +[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/microsoftteams/set-teamtargetinghierarchy) diff --git a/teams/teams-ps/teams/Remove-TeamUser.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamUser.md similarity index 86% rename from teams/teams-ps/teams/Remove-TeamUser.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamUser.md index 1bc56b8ac7..cfdaf883c9 100644 --- a/teams/teams-ps/teams/Remove-TeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamUser.md @@ -1,25 +1,19 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-teamuser +schema: 2.0.0 +title: Remove-TeamUser --- # Remove-TeamUser ## SYNOPSIS - Remove an owner or member from a team, and from the unified group which backs the team. -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: last owner cannot be removed from the team. - ## SYNTAX ``` @@ -27,6 +21,11 @@ Remove-TeamUser -GroupId -User [-Role ] [ Applicable: Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowRemoveParticipantAppIds +### -Force -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). +> Applicable: Teams + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -103,46 +106,52 @@ 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. +### -Identity + +Unique identifier of the application meeting configuration settings to be returned. +Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Set-CsApplicationMeetingConfiguration cmdlet. +However, you can use the following syntax to retrieve the global settings: -Identity global. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Teams -Required: False -Position: Named +Required: True +Position: 1 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. +### -Instance + +> Applicable: Teams + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Teams +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Teams +Aliases: wi Required: False Position: Named @@ -169,4 +178,4 @@ The `Set-CsApplicationMeetingConfiguration` cmdlet does not return any objects o ## RELATED LINKS -[Get-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csapplicationmeetingconfiguration) +[Get-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csapplicationmeetingconfiguration) diff --git a/teams/teams-ps/teams/Set-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Set-CsAutoAttendant.md similarity index 91% rename from teams/teams-ps/teams/Set-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Set-CsAutoAttendant.md index f1241561ad..8d94531a40 100644 --- a/teams/teams-ps/teams/Set-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant +schema: 2.0.0 +title: Set-CsAutoAttendant --- # Set-CsAutoAttendant @@ -26,7 +28,7 @@ The Set-CsAutoAttendant cmdlet lets you modify the properties of an auto attenda ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" @@ -48,7 +50,7 @@ Set-CsAutoAttendant -Instance $autoAttendant This example adds a Christmas holiday to an AA that has an Identity of fa9081d6-b4f3-5c96-baec-0b00077709e5. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" @@ -78,7 +80,7 @@ Set-CsAutoAttendant -Instance $autoAttendant This example modifies the Christmas holiday greeting for the AA that has an Identity of fa9081d6-b4f3-5c96-baec-0b00077709e5. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" $autoAttendant.CallHandlingAssociations @@ -117,6 +119,9 @@ This example modifies an existing AA, removing the Christmas holiday call handli ## PARAMETERS ### -Instance + +> Applicable: Microsoft Teams + The Instance parameter is the object reference to the AA to be modified. You can retrieve an object reference to an existing AA by using the Get-CsAutoAttendant cmdlet and assigning the returned value to a variable. @@ -125,7 +130,6 @@ You can retrieve an object reference to an existing AA by using the Get-CsAutoAt Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -136,11 +140,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -166,12 +171,12 @@ The modified instance of the `Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAtt ## RELATED LINKS -[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendant) -[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant) -[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus) -[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant) -[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/update-csautoattendant) diff --git a/teams/teams-ps/teams/Set-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/Set-CsCallQueue.md similarity index 77% rename from teams/teams-ps/teams/Set-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/Set-CsCallQueue.md index 90feb9aaf2..c937a33d56 100644 --- a/teams/teams-ps/teams/Set-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsCallQueue.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cscallqueue applicable: Microsoft Teams -title: Set-CsCallQueue -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallqueue +schema: 2.0.0 +title: Set-CsCallQueue --- # Set-CsCallQueue @@ -19,7 +20,7 @@ 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 ] [-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> ] [-ShouldOverwriteCallableChannelProperty ] [] +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 @@ -34,110 +35,120 @@ Note that this cmdlet is in the Skype for Business Online PowerShell module and > The following configuration parameters are currently only available in PowerShell and do not appear in Teams admin center. Saving a call queue configuration through Teams admin center will _remove_ any of these configured items. > > - -HideAuthorizedUsers +> - -OverflowActionCallPriority > - -OverflowRedirectPersonTextToSpeechPrompt > - -OverflowRedirectPersonAudioFilePrompt > - -OverflowRedirectVoicemailTextToSpeechPrompt > - -OverflowRedirectVoicemailAudioFilePrompt +> - -TimeoutActionCallPriority > - -TimeoutRedirectPersonTextToSpeechPrompt > - -TimeoutRedirectPersonAudioFilePrompt > - -TimeoutRedirectVoicemailTextToSpeechPrompt > - -TimeoutRedirectVoicemailAudioFilePrompt +> - -NoAgentActionCallPriority > - -NoAgentRedirectPersonTextToSpeechPrompt > - -NoAgentRedirectPersonAudioFilePrompt > - -NoAgentRedirectVoicemailTextToSpeechPrompt > - -NoAgentRedirectVoicemailAudioFilePrompt -> - -IsCallbackEnabled -> - -CallbackRequestDtmf -> - -WaitTimeBeforeOfferingCallbackInSecond -> - -NumberOfCallsInQueueBeforeOfferingCallback -> - -CallToAgentRatioThresholdBeforeOfferingCallback -> - -CallbackOfferAudioFilePromptResourceId -> - -CallbackOfferTextToSpeechPrompt -> - -CallbackEmailNotificationTarget > > 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. > -> - -OverflowActionCallPriority -> - -TimeoutActionCallPriority -> - -NoAgentActionCallPriority +> - -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/teams/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/microsoftteams/import-csonlineaudiofile) ## PARAMETERS -### -Identity -PARAMVALUE: Guid +### -AgentAlertTime + +> Applicable: Microsoft Teams + +The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. ```yaml -Type: Object +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: 30 Accept pipeline input: False Accept wildcard characters: False ``` -### -AgentAlertTime -The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. +### -AllowOptOut + +> Applicable: Microsoft Teams + +The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. ```yaml -Type: Int16 +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: 30 +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOptOut -The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. +### -AuthorizedUsers + +> Applicable: Microsoft Teams + +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: Boolean +Type: List 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 ``` -### -DistributionLists -The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. +### -CallbackEmailNotificationTarget + +> Applicable: Microsoft Teams + +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: List +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -146,14 +157,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MusicOnHoldAudioFileId -The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. +### -CallbackOfferAudioFilePromptResourceId + +> Applicable: Microsoft Teams + +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 @@ -162,14 +175,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the Call Queue. +### -CallbackOfferTextToSpeechPrompt + +> Applicable: Microsoft Teams + +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 @@ -178,14 +193,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OboResourceAccountIds -The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. +### -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: List +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -194,32 +215,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowAction -The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. +### -CallToAgentRatioThresholdBeforeOfferingCallback -PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail +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: Object +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: DisconnectWithBusy +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. +### -ChannelId + +> Applicable: Microsoft Teams + +Id of the channel to connect a call queue to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -228,23 +251,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionCallPriority -_Private Preview customers only_ +### -ChannelUserObjectId -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. +> Applicable: Microsoft Teams -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team that the channel belongs to. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -253,66 +269,83 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowThreshold -The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. +### -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: Int16 +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: 50 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RoutingMethod -The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called. +### -ConferenceMode -PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle +> Applicable: Microsoft Teams + +The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: + +- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. + +- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Attendant +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutAction -The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. +### -CustomAudioFileAnnouncementForCR -PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail +> Applicable: Microsoft Teams + +_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: Object +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionTarget -The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. +### -CustomAudioFileAnnouncementForCRFailure + +> Applicable: Microsoft Teams + +_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: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -321,23 +354,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionCallPriority -_Private Preview customers only_ +### -DistributionLists -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. +> Applicable: Microsoft Teams -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. ```yaml -Type: Int16 +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -346,67 +372,234 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutThreshold -The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. -The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. +### -EnableNoAgentSharedVoicemailSystemPromptSuppression + +> Applicable: Microsoft Teams + +The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Int16 +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: 1200 +Default value: False 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. +### -EnableNoAgentSharedVoicemailTranscription -PARAMVALUE: AllCalls | NewCalls +> Applicable: Microsoft Teams + +The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False 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. +### -EnableOverflowSharedVoicemailSystemPromptSuppression -PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail +> Applicable: Microsoft Teams + +The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOverflowSharedVoicemailTranscription + +> Applicable: Microsoft Teams + +The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailSystemPromptSuppression + +> Applicable: Microsoft Teams + +The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailTranscription + +> Applicable: Microsoft Teams + +The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideAuthorizedUsers + +> Applicable: Microsoft Teams + +_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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Microsoft Teams + +PARAMVALUE: Guid ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentActionTarget -The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this field is optional. +### -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 +``` + +### -LanguageId + +> Applicable: Microsoft Teams + +The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter If either OverflowAction or TimeoutAction is set to SharedVoicemail. + +You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineUri + +> Applicable: Microsoft Teams + +This parameter is reserved 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 +``` + +### -MusicOnHoldAudioFileId + +> Applicable: Microsoft Teams + +The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +> Applicable: Microsoft Teams + +The Name parameter specifies a unique name for the Call Queue. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -415,8 +608,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NoAgentAction + +> Applicable: Microsoft Teams + +The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. + +PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoAgentActionCallPriority -_Private Preview customers only_ + +> Applicable: Microsoft Teams + +_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. @@ -427,11 +643,13 @@ PARAMVALUE: 1 | 2 | 3 | 4 | 5 - 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 @@ -440,14 +658,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDefaultMusicOnHold -The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. +### -NoAgentActionTarget + +> Applicable: Microsoft Teams + +The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this field is optional. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -456,66 +676,74 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeMusicAudioFileId -The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. +### -NoAgentApplyTo + +> Applicable: Microsoft Teams + +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: Guid +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -PresenceBasedRouting -The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. +### -NoAgentDisconnectAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConferenceMode -The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: +### -NoAgentDisconnectTextToSpeechPrompt -- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. +> Applicable: Microsoft Teams -- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. +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: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Users -The User parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). +### -NoAgentRedirectPersonAudioFilePrompt + +> Applicable: Microsoft Teams + +_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: List +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -524,14 +752,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for Microsoft internal use only. +### -NoAgentRedirectPersonTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_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: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -540,16 +772,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LanguageId -The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter If either OverflowAction or TimeoutAction is set to SharedVoicemail. +### -NoAgentRedirectPhoneNumberAudioFilePrompt -You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. +> Applicable: Microsoft Teams + +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: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -558,14 +790,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineUri -This parameter is reserved for Microsoft internal use only. +### -NoAgentRedirectPhoneNumberTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -574,14 +808,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectAudioFilePrompt -The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. +### -NoAgentRedirectVoiceAppAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -590,14 +826,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectTextToSpeechPrompt -The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. +### -NoAgentRedirectVoiceAppTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -606,16 +844,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonAudioFilePrompt +### -NoAgentRedirectVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + _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. +The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -624,16 +864,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonTextToSpeechPrompt +### -NoAgentRedirectVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + _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. +The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -642,14 +884,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppAudioFilePrompt -The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentSharedVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -658,14 +902,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppTextToSpeechPrompt -The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentSharedVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -674,14 +920,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberAudioFilePrompt -The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -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: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -690,14 +938,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberTextToSpeechPrompt -The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -OboResourceAccountIds + +> Applicable: Microsoft Teams + +The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -706,34 +956,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowAction -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. +> Applicable: Microsoft Teams + +The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. + +PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: DisconnectWithBusy Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowActionCallPriority -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. +> Applicable: Microsoft Teams + +_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: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -742,14 +1006,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailTextToSpeechPrompt -The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. +### -OverflowActionTarget + +> Applicable: Microsoft Teams + +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -758,14 +1024,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailAudioFilePrompt -The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. +### -OverflowDisconnectAudioFilePrompt + +> Applicable: Microsoft Teams + +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -774,46 +1042,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailTranscription -The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -OverflowDisconnectTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailSystemPromptSuppression -The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -OverflowRedirectPersonAudioFilePrompt -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -### -TimeoutDisconnectAudioFilePrompt -The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -822,14 +1080,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectTextToSpeechPrompt -The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. +### -OverflowRedirectPersonTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -838,14 +1100,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonAudioFilePrompt -The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. +### -OverflowRedirectPhoneNumberAudioFilePrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -854,16 +1118,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowRedirectPhoneNumberTextToSpeechPrompt -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. +> Applicable: Microsoft Teams + +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -872,16 +1136,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowRedirectVoiceAppAudioFilePrompt -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. +> Applicable: Microsoft Teams + +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -890,14 +1154,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppTextToSpeechPrompt -The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. +### -OverflowRedirectVoiceAppTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -906,14 +1172,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberAudioFilePrompt -The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowRedirectVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -922,14 +1192,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberTextToSpeechPrompt -The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowRedirectVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -938,16 +1212,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowSharedVoicemailAudioFilePrompt -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. +> Applicable: Microsoft Teams + +The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -956,16 +1230,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowSharedVoicemailTextToSpeechPrompt -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. +> Applicable: Microsoft Teams + +The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -974,46 +1248,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailTextToSpeechPrompt -The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -OverflowThreshold -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -TimeoutSharedVoicemailAudioFilePrompt -The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. +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: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: 50 Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailTranscription -The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. +### -PresenceBasedRouting + +> Applicable: Microsoft Teams + +The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1022,30 +1284,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailSystemPromptSuppression -The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -RoutingMethod + +> Applicable: Microsoft Teams + +The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called. + +PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: Attendant Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectTextToSpeechPrompt -The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. +### -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: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1054,14 +1322,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectAudioFilePrompt -The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. +### -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: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1070,16 +1341,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonTextToSpeechPrompt +### -ShiftsSchedulingGroupId + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + _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. +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 @@ -1088,16 +1363,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonAudioFilePrompt +### -ShiftsTeamId + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + _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. +Id of the Team containing the Scheduling Group to connect a call queue to. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1106,30 +1385,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppTextToSpeechPrompt -The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppAudioFilePrompt -The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. +### -Tenant + +> Applicable: Microsoft Teams + +This parameter is reserved for Microsoft internal use only. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1138,14 +1419,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberTextToSpeechPrompt -The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -TextAnnouncementForCR + +> Applicable: Microsoft Teams + +_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 @@ -1154,14 +1441,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberAudioFilePrompt -The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -TextAnnouncementForCRFailure + +> Applicable: Microsoft Teams + +_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: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1170,34 +1463,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -TimeoutAction -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. +> Applicable: Microsoft Teams + +The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. + +PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -TimeoutActionCallPriority -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. +> Applicable: Microsoft Teams + +_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: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1206,14 +1513,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailTextToSpeechPrompt -The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. +### -TimeoutActionTarget + +> Applicable: Microsoft Teams + +The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1222,14 +1531,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailAudioFilePrompt -The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. +### -TimeoutDisconnectAudioFilePrompt + +> Applicable: Microsoft Teams + +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1238,46 +1549,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailTranscription -The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -TimeoutDisconnectTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailSystemPromptSuppression -The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -TimeoutRedirectPersonAudioFilePrompt + +> Applicable: Microsoft Teams + +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: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelId -Id of the channel to connect a call queue to. +### -TimeoutRedirectPersonTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1286,14 +1605,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelUserObjectId -The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team that the channel belongs to. +### -TimeoutRedirectPhoneNumberAudioFilePrompt + +> Applicable: Microsoft Teams + +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1302,14 +1623,16 @@ 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). +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt + +> Applicable: Microsoft Teams + +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: List +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1318,16 +1641,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HideAuthorizedUsers +### -TimeoutRedirectVoiceAppAudioFilePrompt + +> Applicable: Microsoft Teams + _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). +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: List +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1336,8 +1661,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeTextToSpeechPrompt -This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. +### -TimeoutRedirectVoiceAppTextToSpeechPrompt + +> Applicable: Microsoft Teams + +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 @@ -1351,12 +1679,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsCallbackEnabled +### -TimeoutRedirectVoicemailAudioFilePrompt -The IsCallbackEnabled parameter is used to turn on/off callback. +> Applicable: Microsoft Teams + +_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: Boolean +Type: Guid Parameter Sets: (All) Aliases: @@ -1367,15 +1699,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackRequestDtmf +### -TimeoutRedirectVoicemailTextToSpeechPrompt -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: +> Applicable: Microsoft Teams -- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. -- ToneStar - Corresponds to DTMF tone *. -- TonePound - Corresponds to DTMF tone #. +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. +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 @@ -1389,14 +1719,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WaitTimeBeforeOfferingCallbackInSecond +### -TimeoutSharedVoicemailAudioFilePrompt -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. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: @@ -1407,14 +1737,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberOfCallsInQueueBeforeOfferingCallback +### -TimeoutSharedVoicemailTextToSpeechPrompt -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. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: @@ -1425,11 +1755,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallToAgentRatioThresholdBeforeOfferingCallback +### -TimeoutThreshold -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. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +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 @@ -1438,20 +1769,21 @@ Aliases: Required: False Position: Named -Default value: None +Default value: 1200 Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferAudioFilePromptResourceId +### -UseDefaultMusicOnHold -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`. +> Applicable: Microsoft Teams + +The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1460,15 +1792,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferTextToSpeechPrompt +### -Users -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`. +> Applicable: Microsoft Teams + +The User parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1477,15 +1810,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackEmailNotificationTarget +### -WaitTimeBeforeOfferingCallbackInSecond -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`. +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: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1494,15 +1828,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceLevelThresholdResponseTimeInSecond -_Private Preview customers only_ +### -WelcomeMusicAudioFileId -The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. +> Applicable: Microsoft Teams -A value of `$null` indicates that a service level percentage will not be calculated for this call queue. +The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: @@ -1513,18 +1846,17 @@ 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. +### -WelcomeTextToSpeechPrompt +This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. ```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 ``` @@ -1541,3 +1873,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/teams/teams-ps/teams/Set-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Set-CsCallingLineIdentity.md similarity index 91% rename from teams/teams-ps/teams/Set-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Set-CsCallingLineIdentity.md index 16e76a4a04..cbb5068444 100644 --- a/teams/teams-ps/teams/Set-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallinglineidentity +schema: 2.0.0 +title: Set-CsCallingLineIdentity --- # Set-CsCallingLineIdentity @@ -66,6 +67,9 @@ This example modifies the Caller ID policy and allows Teams users to make anonym ## PARAMETERS ### -BlockIncomingPstnCallerID + +> Applicable: Microsoft Teams + 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 Teams user, then Caller ID for incoming calls is suppressed/anonymous. @@ -74,7 +78,6 @@ The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN c Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -CallingIDSubstitute + +> Applicable: Microsoft Teams + The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The possible values are Anonymous, LineUri and Resource. @@ -91,7 +97,6 @@ The possible values are Anonymous, LineUri and Resource. Type: CallingIDSubstituteType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -101,13 +106,33 @@ Accept wildcard characters: False ``` ### -CompanyName + +> Applicable: Microsoft Teams + This parameter sets the Calling party name (typically referred to as CNAM) on the outgoing PSTN 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 +``` + +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -117,13 +142,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + The Description parameter briefly describes the Caller ID policy. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -133,6 +160,9 @@ Accept wildcard characters: False ``` ### -EnableUserOverride + +> Applicable: Microsoft Teams + The EnableUserOverride parameter gives Microsoft Teams users the option under Settings and Calls to hide their phone number when making outgoing calls. The CallerID will be Anonymous. If CallingIDSubstitute is set to Anonymous, the EnableUserOverride parameter has no effect, and the caller ID is always set to Anonymous. @@ -143,7 +173,6 @@ EnableUserOverride has precedence over other settings in the policy unless subst Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -153,13 +182,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter identifies the Caller ID policy. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -169,13 +200,15 @@ Accept wildcard characters: False ``` ### -ResourceAccount + +> Applicable: Microsoft Teams + This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -185,6 +218,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -192,23 +228,6 @@ 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 - -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 @@ -227,10 +246,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallinglineidentity) -[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cscallinglineidentity) -[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallinglineidentity) -[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallinglineidentity) diff --git a/teams/teams-ps/MicrosoftTeams/Set-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/Set-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..6acf6f65cf --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Set-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,90 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: tomkau +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: Set-CsComplianceRecordingForCallQueueTemplate +--- + +# Set-CsComplianceRecordingForCallQueueTemplate + +## SYNOPSIS +Use the Set-CsComplianceRecordingForCallQueueTemplate cmdlet to make changes to an existing Compliance Recording for Call Queues template. + +## 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 + +> Applicable: Microsoft Teams + +The Instance parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### 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/MicrosoftTeams/Set-CsExternalAccessPolicy.md similarity index 73% rename from teams/teams-ps/teams/Set-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsExternalAccessPolicy.md index a1987361a2..44a3aaa384 100644 --- a/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsExternalAccessPolicy.md @@ -1,19 +1,18 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy +schema: 2.0.0 +title: Set-CsExternalAccessPolicy --- # 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 @@ -22,13 +21,12 @@ This cmdlet was introduced in Lync Server 2010. Set-CsExternalAccessPolicy [[-Identity] ] [-AllowedExternalDomains ] [-BlockedExternalDomains ] - [-CommunicationWithExternalOrgs ] + [-CommunicationWithExternalOrgs ] [-Confirm] [-Description ] [-EnableAcsFederationAccess ] [-EnableFederationAccess ] [-EnableOutsideAccess ] - [-EnablePublicCloudAccess ] [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] @@ -47,13 +45,12 @@ Set-CsExternalAccessPolicy [[-Identity] ] Set-CsExternalAccessPolicy [-Instance ] [-AllowedExternalDomains ] [-BlockedExternalDomains ] - [-CommunicationWithExternalOrgs ] + [-CommunicationWithExternalOrgs ] [-Confirm] [-Description ] [-EnableAcsFederationAccess ] [-EnableFederationAccess ] [-EnableOutsideAccess ] - [-EnablePublicCloudAccess ] [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] @@ -68,6 +65,8 @@ Set-CsExternalAccessPolicy [-Instance ] ``` ## DESCRIPTION +This cmdlet was introduced in Lync Server 2010. + 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. @@ -79,7 +78,7 @@ External access policies can grant (or revoke) the ability of your users to do a Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -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. +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/microsoftteams/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. @@ -88,7 +87,7 @@ This enables your users to use Skype for Business and log on to Skype for Busine The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, Instance, PipelineVariable, and Tenant -5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) cmdlet or Teams admin center under the External Access setting. +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/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. @@ -96,7 +95,7 @@ If you would like to grant this capability to all of your users you can call the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederationAccess $True ``` @@ -104,7 +103,7 @@ Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederati The command shown in Example 1 modifies the per-user external access policy that has the Identity RedmondExternalAccessPolicy. In this example, the command changes the value of the EnableFederationAccess property to True. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsExternalAccessPolicy | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` @@ -113,7 +112,7 @@ In Example 2, federation access is enabled for all the external access policies To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet without any parameters; this returns a collection of all the external policies currently configured for use. That collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which changes the value of the EnableFederationAccess property for each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsExternalAccessPolicy -Filter tag:* | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` @@ -123,18 +122,7 @@ To carry out this task, the first thing the command does is use the `Get-CsExter (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 ------------------------ +### Example 4 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $false New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAccess $true @@ -142,7 +130,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAc 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 ------------------------ +### Example 5 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false @@ -150,62 +138,27 @@ New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederatio In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. -### -------------------------- Example 6 ------------------------ +### 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. After that, we still have to enable the `CustomizeFederation` setting in the TenantFederationConfiguration to allow the federation settings as defined in the ExternalAccessPolicy to work. +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 -``` +### -AllowedExternalDomains -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```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 +> [!NOTE] +> Please note that this parameter is in Private Preview. -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowedExternalDomains -Indicates the domains that are allowed to communicate with the users of this policy. This is referenced only when `CommunicationWithExternalOrgs` is set to be `AllowSpecificExternalDomains` +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 @@ -215,12 +168,17 @@ Accept wildcard characters: False ``` ### -BlockedExternalDomains -Indicates the domains that are blocked from communicating with the users of this policy. This is referenced only when `CommunicationWithExternalOrgs` is set to be `BlockSpecificExternalDomains` + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +> [!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 @@ -230,19 +188,25 @@ Accept wildcard characters: False ``` ### -CommunicationWithExternalOrgs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +> [!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: the users of this policy will follow the federation settings defined in TenantFederationConfiguration. -- AllowAllExternalDomains: the users are open to communicate with all domains. -- AllowSpecificExternalDomains: the users can only communicate with the users of the domains defined in `AllowedExternalDomains`. -- BlockSpecificExternalDomains: only users from the domains defined in `BlockedExternalDomains` are blocked from communicating with the users of this policy. -- BlockAllExternalDomains: the users are not able to communicate with any external domains. +- 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 @@ -252,13 +216,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -268,6 +234,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -275,7 +244,6 @@ For example, the Description might include information about the users the polic 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 @@ -285,6 +253,9 @@ Accept wildcard characters: False ``` ### -EnableAcsFederationAccess + +> Applicable: Microsoft Teams + 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. @@ -297,7 +268,6 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -306,6 +276,9 @@ Accept wildcard characters: False ``` ### -EnableFederationAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -314,7 +287,6 @@ The default value is True. 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 @@ -324,32 +296,16 @@ 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 -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -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](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +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 @@ -359,6 +315,9 @@ Accept wildcard characters: False ``` ### -EnablePublicCloudAudioVideoAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -367,7 +326,6 @@ The default value is False. 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 @@ -377,6 +335,9 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + (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. @@ -388,7 +349,6 @@ The default value is True. 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 @@ -398,6 +358,9 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerInbound + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + (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. @@ -409,7 +372,6 @@ The default value is True. 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 @@ -435,6 +397,9 @@ Accept wildcard characters: False ``` ### -EnableXmppAccess + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -442,7 +407,6 @@ The default value is False. 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 @@ -454,6 +418,14 @@ Accept wildcard characters: False ### -FederatedBilateralChats 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) @@ -461,19 +433,21 @@ Aliases: Required: False Position: Named -Default value: True +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -482,6 +456,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -RestrictTeamsConsumerAccessToExternalUserProfiles Defines if a user is restriced to collaboration with Teams Consumer (TFL) user only in Extended Directory Possible Values: True, False @@ -521,13 +538,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -555,10 +574,10 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl ## RELATED LINKS -[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Set-CsInboundBlockedNumberPattern.md similarity index 89% rename from teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Set-CsInboundBlockedNumberPattern.md index 010cb41526..5d6b3e2e5d 100644 --- a/teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -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: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundblockednumberpattern schema: 2.0.0 +title: Set-CsInboundBlockedNumberPattern --- # Set-CsInboundBlockedNumberPattern @@ -37,6 +38,21 @@ This example modifies a blocked number pattern to block inbound calls from +1123 ## 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 A friendly description for the blocked number pattern to be modified. @@ -113,21 +129,6 @@ Accept 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). @@ -139,8 +140,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundblockednumberpattern) -[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundblockednumberpattern) -[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Set-CsInboundExemptNumberPattern.md similarity index 87% rename from teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Set-CsInboundExemptNumberPattern.md index 592cc10d0f..59eea50441 100644 --- a/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundexemptnumberpattern +schema: 2.0.0 +title: Set-CsInboundExemptNumberPattern --- # Set-CsInboundExemptNumberPattern @@ -48,6 +48,22 @@ Disables the exempt number pattern from usage in call blocking ## 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 Sets the description of the number pattern. @@ -126,22 +142,6 @@ Accept 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). @@ -156,12 +156,12 @@ You can use Test-CsInboundBlockedNumberPattern to test your block and exempt pho ## RELATED LINKS -[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundexemptnumberpattern) -[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern) +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundexemptnumberpattern) -[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) -[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..61e17500cc --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1,145 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csmainlineattendantappointmentbookingflow +schema: 2.0.0 +title: Set-CsMainlineAttendantAppointmentBookingFlow +--- + +# Set-CsMainlineAttendantAppointmentBookingFlow + +## SYNOPSIS +Changes an existing Mainline Attendant appointment booking flow + +## SYNTAX + +``` +Set-CsMainlineAttendantAppointmentBookingFlow -Identity [-Name ] [-Description ] [-CallerAuthenticationMethod ] [-ApiAuthenticationType ] [-ApiDefinitions ] [-Tenant ] [] +``` + +## DESCRIPTION +The Set-CsMainlineAttendantAppointmentBookingFlow cmdlet changes an existing appointment booking flow that is used with Mainline Attendant + +> [!CAUTION] +> This cmdlet 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. + +## EXAMPLES + + +## PARAMETERS + +### -Identity +The unique Id of the appointment booking flow to change + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the appointment booking flow + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for the appointment booking flow + +Limit: 500 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallerAuthenticationMethod +The method by which the caller is authenticated + +PARAVALUES: sms | email | verification_link | voiceprint | user_details + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiAuthenticationType +The method of authentication used by the API + +PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiDefinitions +The parameters used by the API + +```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 + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + + diff --git a/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..5335328561 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1,128 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csmainlineattendantquestionanswerflow +schema: 2.0.0 +title: Set-CsMainlineAttendantQuestionAnswerFlow +--- + +# Set-CsMainlineAttendantQuestionAnswerFlow + +## SYNOPSIS +Changes an existing Mainline Attendant question and answer (FAQ) flow + +## SYNTAX + +``` +Set-CsMainlineAttendantQuestionAnswerFlow -Identity [-Name ] [-Description ] [-ApiAuthenticationType ] [-KnowledgeBase ] [-Tenant ] [] +``` + +## DESCRIPTION +The Set-CsMainlineAttendantQuestionAnswerFlow cmdlet changes an existing question and answer connection that can be used with Mainline Attendant + +> [!CAUTION] +> This cmdlet 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. + +## EXAMPLES + + +## PARAMETERS + +### -Identity +The unique identifier for the question and answer flow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the question and answer flow + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for the question and answer flow + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiAuthenticationType +The method of authentication used by the API + +PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KnowledgeBase +The knowledge base definition + +The parameters used by the API + +```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 + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + + diff --git a/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineApplicationInstance.md similarity index 84% rename from teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineApplicationInstance.md index 4e64fee3fa..8bd14ac852 100644 --- a/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance applicable: Microsoft Teams -title: Set-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineapplicationinstance +schema: 2.0.0 +title: Set-CsOnlineApplicationInstance --- # Set-CsOnlineApplicationInstance @@ -15,8 +16,6 @@ ms.reviewer: ## SYNOPSIS Updates an application instance in Microsoft Entra ID. -**Note**: The use of this cmdlet for assigning phone numbers in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. - ## SYNTAX ``` @@ -26,9 +25,11 @@ Set-CsOnlineApplicationInstance [-Identity] [[-OnpremPhoneNumber] Applicable: Microsoft Teams + The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -87,29 +71,34 @@ 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. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Microsoft Teams + The display name. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +108,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -134,31 +125,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity + +> Applicable: Microsoft Teams + +The URI or ID of the application instance to update. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnpremPhoneNumber + +> Applicable: Microsoft Teams + +**Note**: Using this parameter has been deprecated in commercial and GCC cloud instances. Use the new Set-CsPhoneNumberAssignment cmdlet instead. + +Assigns a hybrid (on-premise) telephone number to the application instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -178,10 +193,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) -[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/sync-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineAudioConferencingRoutingPolicy.md similarity index 92% rename from teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineAudioConferencingRoutingPolicy.md index a1b9ec1f59..2cd5a40efd 100644 --- a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,177 +1,178 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Set-CsOnlineAudioConferencingRoutingPolicy +--- + +# 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/teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge.md similarity index 91% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge.md index a0d2c3d32d..68ba0dc9ec 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinedialinconferencingbridge +schema: 2.0.0 +title: Set-CsOnlineDialInConferencingBridge --- # Set-CsOnlineDialInConferencingBridge @@ -43,14 +45,14 @@ The `Set-CsOnlineDialInConferencingBridge` cmdlet can be used to set the default ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingBridge -Name "Conference Bridge" -DefaultServiceNumber 14255551234 ``` This example sets the default dial-in phone number to 14255551234 for the audio conferencing bridge named "Conference Bridge". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $bridge = Get-CsOnlineDialInConferencingBridge -Name "Conference Bridge" @@ -63,46 +65,61 @@ This example changes the name of a conference bridge by creating a conference br ## PARAMETERS -### -Identity -Specifies the globally-unique identifier (GUID) for the audio conferencing bridge to be modified. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to a Microsoft audio conferencing bridge object to the cmdlet rather than set individual parameter values. +### -DefaultServiceNumber + +> Applicable: Microsoft Teams + +Specifies the default phone number to be used on the Microsoft audio conferencing bridge. +The default number is used in meeting invitations. + +The DefaultServiceNumber must be assigned to the audio conferencing bridge. +Also, when the default service number is changed, the service number of existing users will not be changed. ```yaml -Type: ConferencingBridge +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Specifies the name of the audio conferencing bridge to be modified. +### -DomainController + +> Applicable: Microsoft Teams + +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): -DomainController atl-cs-001.Contoso.com. + +Computer name: -DomainController atl-cs-001 ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False Position: Named @@ -111,14 +128,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Force + +> Applicable: Microsoft Teams + +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: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -127,57 +148,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultServiceNumber -Specifies the default phone number to be used on the Microsoft audio conferencing bridge. -The default number is used in meeting invitations. +### -Identity -The DefaultServiceNumber must be assigned to the audio conferencing bridge. -Also, when the default service number is changed, the service number of existing users will not be changed. +> Applicable: Microsoft Teams + +Specifies the globally-unique identifier (GUID) for the audio conferencing bridge to be modified. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 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 include: +### -Instance -Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com. +> Applicable: Microsoft Teams -Computer name: -DomainController atl-cs-001 +Allows you to pass a reference to a Microsoft audio conferencing bridge object to the cmdlet rather than set individual parameter values. ```yaml -Type: Fqdn +Type: ConferencingBridge Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 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. +### -Name + +> Applicable: Microsoft Teams + +Specifies the name of the audio conferencing bridge to be modified. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -187,13 +203,15 @@ Accept wildcard characters: False ``` ### -SetDefault + +> Applicable: Microsoft Teams + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -203,13 +221,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -219,13 +239,15 @@ Accept wildcard characters: False ``` ### -TenantDomain + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -235,6 +257,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -242,7 +267,6 @@ 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 Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber.md similarity index 93% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber.md index a64dcc2c2b..660b0be139 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Set-CsOnlineDialInConferencingServiceNumber --- # Set-CsOnlineDialInConferencingServiceNumber @@ -87,7 +89,7 @@ Ukrainian ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingServiceNumber -Identity +14255551234 -PrimaryLanguage de-de -SecondaryLanguages en-us, ja-jp, en-gb ``` @@ -96,47 +98,59 @@ This example sets the primary language to German (Germany) and the secondary lan ## PARAMETERS -### -Identity -Specifies the default dial-in service number string. -The service number can be specified in the following formats: E.164 number, +\ and tel:\. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to the Office 365 audio service number object to the cmdlet rather than set individual parameter values. +### -DomainController + +> Applicable: Microsoft Teams + +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): -DomainController atl-cs-001.Contoso.com. + +Computer name: -DomainController atl-cs-001 ```yaml -Type: ConferencingServiceNumber +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False -Position: 1 +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. +### -Force + +> Applicable: Microsoft Teams + +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: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -145,46 +159,47 @@ 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 include: +### -Identity -Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com. +> Applicable: Microsoft Teams -Computer name: -DomainController atl-cs-001 +Specifies the default dial-in service number string. +The service number can be specified in the following formats: E.164 number, +\ and tel:\. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 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 + +> Applicable: Microsoft Teams + +Allows you to pass a reference to the Office 365 audio service number object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter +Type: ConferencingServiceNumber Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PrimaryLanguage + +> Applicable: Microsoft Teams + Specifies the primary language that is used when users call into a meeting. The culture ID is used. For example, en-US for US English, ja-JP for Japanese, or es-ES for Spanish. @@ -195,7 +210,6 @@ Use the `Get-CsOnlineDialInConferencingLanguagesSupported` cmdlet to get a list Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -205,13 +219,15 @@ Accept wildcard characters: False ``` ### -RestoreDefaultLanguages + +> Applicable: Microsoft Teams + Including this switch restores all of the default languages for the audio conferencing service number. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -221,6 +237,9 @@ Accept wildcard characters: False ``` ### -SecondaryLanguages + +> Applicable: Microsoft Teams + Specifies the secondary languages that can be used when users call into a meeting. The culture ID is used. For example, en-US for US English, ja-JP for Japanese, or es-ES for Spanish. @@ -233,7 +252,6 @@ Use the `Get-CsOnlineDialInConferencingLanguagesSupported` cmdlet to get a list Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -243,13 +261,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -259,6 +279,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -266,7 +289,6 @@ 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 Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings.md similarity index 94% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings.md index 26cf1b24c2..d995355ff2 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingtenantsettings applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingTenantSettings +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinedialinconferencingtenantsettings schema: 2.0.0 +title: Set-CsOnlineDialInConferencingTenantSettings --- # Set-CsOnlineDialInConferencingTenantSettings @@ -41,7 +43,7 @@ The following parameters are not applicable to Teams: EnableDialOutJoinConfirmat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingTenantSettings -EnableEntryExitNotifications $True -EnableNameRecording $True -PinLength 7 ``` @@ -49,7 +51,7 @@ 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 -------------------------- +### Example 2 ``` Set-CsOnlineDialInConferencingTenantSettings -SendEmailFromOverride $true -SendEmailFromAddress admin@contoso.com -SendEmailFromDisplayName "Conferencing Administrator" ``` @@ -93,7 +95,7 @@ Accept wildcard characters: False ### -AllowFederatedUsersToDialOutToThirdParty -Specifies at this scope if dial out to third party participants is allowed. Possible settings are [No|Yes|RequireSameEnterpriseUser]. +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 @@ -109,6 +111,9 @@ Accept wildcard characters: False ``` ### -AllowPSTNOnlyMeetingsByDefault + +> Applicable: Microsoft Teams + 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. If $false, the user setting will be false. @@ -126,7 +131,6 @@ For more information on the "AllowPSTNOnlyMeetings" user setting, see `Set-CsOnl Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -137,6 +141,8 @@ Accept wildcard characters: False ### -AutomaticallyMigrateUserMeetings +> Applicable: Microsoft Teams + 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 @@ -144,7 +150,6 @@ PARAMVALUE: $true | $false Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -155,6 +160,8 @@ Accept wildcard characters: False ### -AutomaticallyReplaceAcpProvider +> Applicable: Microsoft Teams + 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 @@ -162,7 +169,6 @@ PARAMVALUE: $true | $false Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -172,6 +178,9 @@ Accept wildcard characters: False ``` ### -AutomaticallySendEmailsToUsers + +> Applicable: Microsoft Teams + Specifies whether advisory emails will be sent to users when the events listed below occur. Setting the parameter to $true enables the emails to be sent, $false disables the emails. The default is $true. @@ -188,7 +197,6 @@ Changes to either the user's conference ID, or the user's default dial-in confer Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -198,13 +206,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + 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 @@ -231,6 +241,8 @@ Accept wildcard characters: False ### -EnableEntryExitNotifications +> Applicable: Microsoft Teams + 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. @@ -241,7 +253,6 @@ This setting can be overridden on a meeting by meeting basis when a user joins a Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -252,6 +263,8 @@ Accept wildcard characters: False ### -EnableNameRecording +> Applicable: Microsoft Teams + 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. @@ -261,7 +274,6 @@ The default is $true. Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -272,6 +284,8 @@ Accept wildcard characters: False ### -EntryExitAnnouncementsType +> Applicable: Microsoft Teams + Specifies if the Entry and Exit Announcement Uses names or tones only. PARAMVALUE: UseNames | ToneOnly @@ -279,7 +293,6 @@ PARAMVALUE: UseNames | ToneOnly Type: EntryExitAnnouncementsType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -289,6 +302,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -297,7 +313,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -307,13 +322,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -323,13 +340,15 @@ Accept wildcard characters: False ``` ### -IncludeTollFreeNumberInMeetingInvites + +> Applicable: Microsoft Teams + This parameter is obsolete and not functional. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -339,13 +358,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Microsoft Teams + 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: -applicable: Microsoft Teams Required: False Position: Named @@ -354,8 +375,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MaskPstnNumbersType +This parameter allows tenant administrators to configure masking of PSTN participant phone numbers in the roster view for Microsoft Teams meetings enabled for Audio Conferencing, scheduled within the organization. + +Possible values are: +- MaskedForExternalUsers (masked to external users) +- MaskedForAllUsers (masked for everyone) +- NoMasking (visible to everyone) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: MaskedForExternalUsers +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MigrateServiceNumbersOnCrossForestMove +> Applicable: Microsoft Teams + 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 @@ -363,7 +406,6 @@ PARAMVALUE: $true | $false Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -389,6 +431,9 @@ Accept wildcard characters: False ``` ### -PinLength + +> Applicable: Microsoft Teams + Specifies the number of digits in the automatically generated PINs. Organizers can enter their PIN to start a meeting they scheduled if they join via phone and are the first person to join. The minimum value is 4, the maximum is 12, and the default is 5. @@ -400,7 +445,6 @@ The PIN of a user that did not schedule the meeting will not enable that user to Type: UInt32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -410,6 +454,9 @@ Accept wildcard characters: False ``` ### -SendEmailFromAddress + +> Applicable: Microsoft Teams + Specifies the email address to use in the "From" contact information on emails that are sent to users to notify them of their dial-in conferencing settings, or when their settings change. The email address needs to be in the form \@\. For example, "KenMyer@Contoso.com" or "Admin@Contoso.com". @@ -422,7 +469,6 @@ Note: The parameter has been deprecated and may be removed in future versions. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -432,6 +478,9 @@ Accept wildcard characters: False ``` ### -SendEmailFromDisplayName + +> Applicable: Microsoft Teams + Specifies the display name to use in the "From" contact information on emails that are sent to users to notify them of their dial-in conferencing settings, or when their settings change. The SendEmailFromDisplayName value is used only if the SendEmailFromDisplayName setting is specified, and the SendEmailFromOverride setting is $true. @@ -442,7 +491,6 @@ Note: The parameter has been deprecated and may be removed in future versions. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -452,6 +500,9 @@ Accept wildcard characters: False ``` ### -SendEmailFromOverride + +> Applicable: Microsoft Teams + Specifies if the contact information on dial-in conferencing notifications will be the default generated by Office 365, or administrator defined values. Setting SendEmailFromOverride to $true enables the system to use the SendEmailFromAddress and SendEmailFromDisplayName parameter inputs as the "From" contact information. Setting this parameter to $false will cause email notifications to be sent with the system generated default. @@ -467,7 +518,6 @@ Note: The parameter has been deprecated and may be removed in future versions. Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -477,13 +527,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -494,6 +546,8 @@ Accept wildcard characters: False ### -UseUniqueConferenceIds +> Applicable: Microsoft Teams + Specifies if Private Meetings are enabled for the users in this tenant. PARAMVALUE: $true | $false @@ -501,7 +555,6 @@ PARAMVALUE: $true | $false Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -510,27 +563,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaskPstnNumbersType -This parameter allows tenant administrators to configure masking of PSTN participant phone numbers in the roster view for Microsoft Teams meetings enabled for Audio Conferencing, scheduled within the organization. - -Possible values are: -- MaskedForExternalUsers (masked to external users) -- MaskedForAllUsers (masked for everyone) -- NoMasking (visible to everyone) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +### -WhatIf -Required: False -Position: Named -Default value: MaskedForExternalUsers -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -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. @@ -538,7 +574,6 @@ 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 Required: False Position: Named @@ -557,6 +592,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings) +[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantsettings) -[Remove-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/remove-csonlinedialinconferencingtenantsettings) +[Remove-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinedialinconferencingtenantsettings) diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingUser.md similarity index 89% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingUser.md index a0768687dc..0ba11ffd6a 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingUser.md @@ -1,18 +1,17 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinedialinconferencinguser schema: 2.0.0 +title: Set-CsOnlineDialInConferencingUser --- # Set-CsOnlineDialInConferencingUser ## 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/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. ## SYNTAX @@ -40,16 +39,19 @@ The `Set-CsOnlineDialInConferencingUser` cmdlet is used to modify properties for This cmdlet will not work for users with third-party conferencing providers. The cmdlet will verify that the correct license is assigned to the user. +> [!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/microsoftteams/set-csteamsmeetingpolicy). The capabilities associated with the ResetConferenceId and ConferenceId parameters are no longer supported. + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -ResetLeaderPin -ServiceNumber 14255037265 ``` This example shows how to reset the meeting leader's PIN and set the audio conferencing provider default meeting phone number. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conference Bridge" ``` @@ -58,34 +60,37 @@ This example sets a user's conference bridge assignment. ## PARAMETERS -### -Identity -Specifies the Identity of the user account to be to be modified. -A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. +### -AllowPSTNOnlyMeetings + +> Applicable: Microsoft Teams + +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: UserIdParameter +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantDomain -Specifies the domain name for the tenant or organization. +### -AllowTollFreeDialIn -This parameter is reserved for internal Microsoft use. +> Applicable: Microsoft Teams + +If toll-free numbers are available in your Microsoft Audio Conferencing bridge, this parameter controls if they can be used to join the meetings of a given user. This setting can ONLY be managed using the TeamsAudioConferencingPolicy. By default, AllowTollFreeDialin is always set to True. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -94,17 +99,12 @@ 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. - +### -AsJob +The parameter is used to run commands as background jobs. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -114,13 +114,15 @@ Accept wildcard characters: False ``` ### -BridgeId + +> Applicable: Microsoft Teams + Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -130,13 +132,15 @@ Accept wildcard characters: False ``` ### -BridgeName + +> Applicable: Microsoft Teams + Specifies the name of the audio conferencing bridge. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -146,13 +150,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + 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 @@ -162,6 +168,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter include: @@ -175,7 +184,6 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -185,6 +193,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -193,7 +204,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -202,14 +212,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +Specifies the Identity of the user account to be to be modified. +A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). +You can also reference a user account by using the user's Active Directory distinguished name. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResetLeaderPin + +> Applicable: Microsoft Teams + Specifies whether to reset the meeting organizer or leaders PIN for meetings. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -219,13 +251,15 @@ Accept wildcard characters: False ``` ### -SendEmail + +> Applicable: Microsoft Teams + Send an email to the user containing their Audio Conference information. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -235,13 +269,15 @@ Accept wildcard characters: False ``` ### -SendEmailFromAddress + +> Applicable: Microsoft Teams + 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: Microsoft Teams Required: False Position: Named @@ -251,13 +287,15 @@ Accept wildcard characters: False ``` ### -SendEmailFromDisplayName + +> Applicable: Microsoft Teams + 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: Microsoft Teams Required: False Position: Named @@ -267,13 +305,15 @@ Accept wildcard characters: False ``` ### -SendEmailToAddress + +> Applicable: Microsoft Teams + 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: Microsoft Teams Required: False Position: Named @@ -283,6 +323,9 @@ Accept wildcard characters: False ``` ### -ServiceNumber + +> Applicable: Microsoft Teams + Specifies the default service number for the user. The default number is used in meeting invitations. The cmdlet will verify that the service number is assigned to the user's current conference bridge, or the one the user is being assigned to. @@ -293,7 +336,6 @@ The service number can be specified in the following formats: E.164 number, +\ Applicable: Microsoft Teams + 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` @@ -313,7 +358,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -322,14 +366,18 @@ 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:\. +### -TenantDomain + +> Applicable: Microsoft Teams + +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: Microsoft Teams Required: False Position: Named @@ -338,30 +386,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf parameter is not implemented for this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +### -TollFreeServiceNumber -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AllowTollFreeDialIn -If toll-free numbers are available in your Microsoft Audio Conferencing bridge, this parameter controls if they can be used to join the meetings of a given user. This setting can ONLY be managed using the TeamsAudioConferencingPolicy. By default, AllowTollFreeDialin is always set to True. +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: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -370,12 +404,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -The parameter is used to run commands as background jobs. +### -WhatIf + +> Applicable: Microsoft Teams + +The WhatIf parameter is not implemented for this cmdlet. + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -395,6 +433,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy) -[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md similarity index 92% rename from teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md index 289ee4575e..9816a0ca9f 100644 --- a/teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md @@ -1,18 +1,30 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Set-CsOnlineEnhancedEmergencyServiceDisclaimer --- # Set-CsOnlineEnhancedEmergencyServiceDisclaimer ## SYNOPSIS +You can use Get-CsOnlineEnhancedEmergencyServiceDisclaimer to see the status of the emergency service disclaimer. + +## SYNTAX + +``` +Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion [-Version ] [-ForceAccept] + [-Tenant ] [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION When using Microsoft Teams PSTN Calling Services you need to record your organization's acceptance of the enhanced emergency service terms and conditions. This is done per country/region and it needs to be done before you can provide PSTN calling services to Microsoft Teams users in the country/region. @@ -22,23 +34,15 @@ when you create an emergency address in a country/region. Any tenant administrator can accept the terms and conditions and it only needs to be done once per country/region. -As the output the cmdlet will show the emergency service disclaimer and that it has been accepted. You can use Get-CsOnlineEnhancedEmergencyServiceDisclaimer to see the status of the emergency service disclaimer. - -## SYNTAX +As the output the cmdlet will show the emergency service disclaimer and that it has been accepted. -``` -Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion [-Version ] [-ForceAccept] - [-Tenant ] [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION You must run this cmdlet prior to assigning Microsoft Calling Plan phone numbers and locations to voice enabled users or accept the similar disclaimer in the Teams admin center. Microsoft Calling Plan phone numbers are available in several countries/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 -------------------------- +### Example 1 ``` Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion US ``` @@ -48,13 +52,13 @@ version of the enhanced emergency service terms and conditions. ## PARAMETERS -### -CountryOrRegion -Specifies the region or country whose terms and conditions you wish to accept. You need to use the ISO 31661-1 alpha-2 2 letter code for the country. For example for the United States it must be specified as "US" and for Denmark it must be specified as "DK". +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -63,13 +67,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -CountryOrRegion +Specifies the region or country whose terms and conditions you wish to accept. You need to use the ISO 31661-1 alpha-2 2 letter code for the country. For example for the United States it must be specified as "US" and for Denmark it must be specified as "DK". ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -181,4 +185,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/teams/get-csonlineenhancedemergencyservicedisclaimer) +[Get-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineenhancedemergencyservicedisclaimer) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisCivicAddress.md similarity index 88% rename from teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisCivicAddress.md index e14a5b9850..bb65946698 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisCivicAddress.md @@ -1,23 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress applicable: Microsoft Teams -title: Set-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliscivicaddress +schema: 2.0.0 +title: Set-CsOnlineLisCivicAddress --- # Set-CsOnlineLisCivicAddress ## SYNOPSIS -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 public use with limited countries and certain fields. The remaining countries and fields are for Microsoft internal use only. +Use the cmdlet to modify an existing civic address which has not been validated. ## SYNTAX @@ -32,6 +29,11 @@ Set-CsOnlineLisCivicAddress -CivicAddressId [-CompanyName ] [-Com ``` ## DESCRIPTION +Validated civic addresses cannot be modified. + +> [!IMPORTANT] +> Due to a current issue, the parameters **-CompanyName** and **-CountryOrRegion** are required as an interim workaround for this cmdlet. + 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: @@ -39,6 +41,9 @@ Australia, Brazil, Canada, Croatia, Czech Republic, Estonia, Hong Kong, Hungary, 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. +> [!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. + ## EXAMPLES ### Example 1 @@ -57,30 +62,35 @@ This example modifies the latitude, longitude and ELIN name of the civic address ## PARAMETERS -### -CivicAddressId -Specifies the unique identifier of the civic address to be modified. +### -City + +> Applicable: Microsoft Teams + +Specifies a new city for the civic address. Publicly editable. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -City -Specifies a new city for the civic address. Publicly editable. +### -CityAlias + +> Applicable: Microsoft Teams + +Short form of the city name. +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -89,17 +99,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias -Short form of the city name. -This parameter is reserved for internal Microsoft use. +### -CivicAddressId + +> Applicable: Microsoft Teams + +Specifies the unique identifier of the civic address to be modified. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -107,13 +118,15 @@ Accept wildcard characters: False ``` ### -CompanyName + +> Applicable: Microsoft Teams + Specifies a new company name for the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -123,14 +136,31 @@ Accept wildcard characters: False ``` ### -CompanyTaxId -Used to store TaxId for regulatory reasons. + +> Applicable: Microsoft Teams + +Used to store TaxId for regulatory reasons. +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 +``` + +### -Confidence This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -140,13 +170,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + 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 @@ -156,8 +188,11 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies a new country or region for the civic address. -For public use, restricted to the following countries: +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** @@ -165,7 +200,6 @@ For public use, restricted to the following countries: Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -175,13 +209,34 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies a new description for the civic address. 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 +``` + +### -Elin + +> Applicable: Microsoft Teams + +Specifies the Emergency Location Identification Number. +This is used in Direct Routing EGW scenarios. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -191,6 +246,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -199,7 +257,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -209,13 +266,15 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Microsoft Teams + Specifies the new numeric portion of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -225,6 +284,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Microsoft Teams + 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". @@ -234,7 +296,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -243,14 +304,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PostalCode -Specifies the new postal code of the civic address. Publicly editable. +### -IsAzureMapValidationRequired +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -259,17 +319,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PostDirectional -Specifies the new directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". +### -Latitude -This parameter is reserved for internal Microsoft use. +> Applicable: Microsoft Teams + +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 Required: False Position: Named @@ -278,17 +337,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PreDirectional -Specifies the new directional attribute of the civic address which precedes the street name. -For example, "425 NE Smith Avenue ". +### -Longitude -This parameter is reserved for internal Microsoft use. +> Applicable: Microsoft Teams + +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 @@ -297,14 +355,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StateOrProvince -Specifies the new state or province of the civic address. Publicly editable. +### -PostalCode + +> Applicable: Microsoft Teams + +Specifies the new postal code of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -313,14 +373,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreetName -Specifies the new street name of the civic address. Publicly editable. +### -PostDirectional + +> Applicable: Microsoft Teams + +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 Required: False Position: Named @@ -329,9 +394,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreetSuffix -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. +### -PreDirectional + +> Applicable: Microsoft Teams + +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. @@ -339,7 +407,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -348,14 +415,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ValidationStatus -Microsoft internal use only +### -StateOrProvince + +> Applicable: Microsoft Teams + +Specifies the new state or province of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -364,25 +433,11 @@ 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 +### -StreetName -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confidence -This parameter is reserved for internal Microsoft use. +Specifies the new street name of the civic address. Publicly editable. ```yaml Type: String @@ -396,31 +451,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Elin -Specifies the Emergency Location Identification Number. -This is used in Direct Routing EGW scenarios. +### -StreetSuffix -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. -### -Latitude -Specifies the angular distance of a place north or south of the earth's equator in the decimal degrees format. Publicly editable. +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -429,14 +472,16 @@ Accept pipeline input: False 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. Publicly editable. +### -ValidationStatus + +> Applicable: Microsoft Teams + +Microsoft internal use only ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -445,17 +490,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsAzureMapValidationRequired -This parameter is reserved for internal Microsoft use. +### -WhatIf + +> Applicable: Microsoft Teams + +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: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -471,8 +520,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliscivicaddress) -[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineliscivicaddress) -[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisLocation.md similarity index 91% rename from teams/teams-ps/teams/Set-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisLocation.md index d93fd56f49..341e732273 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation applicable: Microsoft Teams -title: Set-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelislocation +schema: 2.0.0 +title: Set-CsOnlineLisLocation --- # Set-CsOnlineLisLocation @@ -45,77 +46,69 @@ This example changes the location description of the location specified by its l ## PARAMETERS -### -CivicAddressId -Specifies the unique identifier of the civic address that contains the location to be modified. -Civic address identities can be discovered by using the \`Get-CsOnlineLisCivicAddress\` cmdlet. +### -City + +> Applicable: Microsoft Teams + +Specifies the city of the civic address. **Note:** This parameter is not supported and will be deprecated. ```yaml -Type: Guid +Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -Specifies the unique identifier of the location to be modified. Location identities can be discovered by using the \`Get-CsOnlineLisLocation\` cmdlet. - -```yaml -Type: Guid -Parameter Sets: UseLocationId -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +### -CityAlias -### -City -Specifies the city of the civic address. +> Applicable: Microsoft Teams -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. ```yaml Type: String -Parameter Sets: UseCivicAddressId +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias +### -CivicAddressId -**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. +> Applicable: Microsoft Teams + +Specifies the unique identifier of the civic address that contains the location to be modified. +Civic address identities can be discovered by using the \`Get-CsOnlineLisCivicAddress\` cmdlet. + +**Note:** This parameter is not supported and will be deprecated. ```yaml -Type: String -Parameter Sets: (All) +Type: Guid +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` ### -CompanyName + +> Applicable: Microsoft Teams + Specifies the name of your organization. **Note:** This parameter is not supported and will be deprecated. @@ -124,7 +117,6 @@ Specifies the name of your organization. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -134,6 +126,9 @@ Accept wildcard characters: False ``` ### -CompanyTaxId + +> Applicable: Microsoft Teams + The company tax ID. **Note:** This parameter is not supported and will be deprecated. @@ -142,7 +137,6 @@ The company tax ID. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -153,13 +147,14 @@ Accept wildcard characters: False ### -Confidence +> Applicable: Microsoft Teams + **Note:** This parameter is not supported and will be deprecated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -168,7 +163,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies the country or region of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -177,7 +193,6 @@ Specifies the country or region of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -195,7 +213,6 @@ Specifies an administrator defined description of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -205,6 +222,9 @@ Accept wildcard characters: False ``` ### -Elin + +> Applicable: Microsoft Teams + Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. **Note:** You can set or change the ELIN, but you can't clear its value. If you need to clear the value, you should recreate the location. @@ -213,7 +233,6 @@ Specifies the Emergency Location Identification Number. This is used in Direct R Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -222,7 +241,30 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Force + +> Applicable: Microsoft Teams + +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 +``` + ### -HouseNumber + +> Applicable: Microsoft Teams + Specifies the numeric portion of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -231,7 +273,6 @@ Specifies the numeric portion of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -241,6 +282,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Microsoft Teams + 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". @@ -250,7 +294,6 @@ For example, if the property was multiplexed, the HouseNumberSuffix parameter wo Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -259,26 +302,29 @@ Accept pipeline input: True 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. +### -IsAzureMapValidationRequired -**Note:** This parameter is not supported and will be deprecated. +> Applicable: Microsoft Teans + +This parameter is reserved for internal Microsoft use. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False 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. +### -Latitude + +> Applicable: Microsoft Teams + +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. @@ -286,7 +332,6 @@ Specifies the angular distance of a place east or west of the meridian at Greenw Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -294,14 +339,17 @@ Default value: None Accept pipeline input: True Accept wildcard characters: False ``` + ### -Location + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". ```yaml Type: String Parameter Sets: UseLocationId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -310,35 +358,36 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -PostalCode -Specifies the postal code of the civic address. +### -LocationId -**Note:** This parameter is not supported and will be deprecated. +> Applicable: Microsoft Teams + +Specifies the unique identifier of the location to be modified. Location identities can be discovered by using the \`Get-CsOnlineLisLocation\` cmdlet. ```yaml -Type: String -Parameter Sets: UseCivicAddressId +Type: Guid +Parameter Sets: UseLocationId Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -PostDirectional -Specifies the directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". +### -Longitude + +> Applicable: Microsoft Teams + +Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. **Note:** This parameter is not supported and will be deprecated. ```yaml Type: String -Parameter Sets: UseCivicAddressId +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -346,9 +395,11 @@ Default value: None Accept pipeline input: True Accept wildcard characters: False ``` +### -PostalCode -### -PreDirectional -Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue ". +> Applicable: Microsoft Teams + +Specifies the postal code of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -356,7 +407,6 @@ Specifies the directional attribute of the civic address which precedes the stre Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -365,8 +415,12 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -StateOrProvince -Specifies the state or province of the civic address. +### -PostDirectional + +> Applicable: Microsoft Teams + +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. @@ -374,7 +428,6 @@ Specifies the state or province of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -383,8 +436,11 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -StreetName -Specifies the street name of the civic address. +### -PreDirectional + +> Applicable: Microsoft Teams + +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. @@ -392,7 +448,6 @@ Specifies the street name of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -401,8 +456,11 @@ Accept pipeline input: True 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. +### -StateOrProvince + +> Applicable: Microsoft Teams + +Specifies the state or province of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -410,7 +468,6 @@ Specifies a modifier of the street name of the civic address. The street suffix Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teans Required: False Position: Named @@ -419,41 +476,50 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -IsAzureMapValidationRequired -This parameter is reserved for internal Microsoft use. +### -StreetName + +> Applicable: Microsoft Teams + +Specifies the street name of the civic address. + +**Note:** This parameter is not supported and will be deprecated. ```yaml Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teans Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -StreetSuffix + +> Applicable: Microsoft Teans + +Specifies a modifier of the street name of the civic address. The street suffix will typically be something like street, avenue, way, or boulevard. + +**Note:** This parameter is not supported and will be deprecated. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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. @@ -461,23 +527,6 @@ 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 - -Required: False -Position: Named -Default value: False -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 @@ -497,8 +546,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinelislocation) -[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelislocation) -[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelislocation) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisPort.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisPort.md similarity index 91% rename from teams/teams-ps/teams/Set-CsOnlineLisPort.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisPort.md index 39f8049001..b23506958f 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisPort.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisPort.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport applicable: Microsoft Teams -title: Set-CsOnlineLisPort -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisport +schema: 2.0.0 +title: Set-CsOnlineLisPort --- # Set-CsOnlineLisPort @@ -50,13 +51,15 @@ Example 3 creates the association between port "12174" and LocationId "efd7273e- ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + 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 Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -65,32 +68,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -Specifies the unique identifier of the location to be modified. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -PortID -If the PortID subtype is a MAC Address, 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 subtype, such as Interface Name), this value must be in a string format as set on the switch. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -98,13 +87,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the port. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -114,6 +105,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -122,7 +116,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -132,13 +125,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -147,14 +142,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationId + +> Applicable: Microsoft Teams + +Specifies the unique identifier of the location to be modified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -163,30 +178,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore -This parameter is reserved for internal Microsoft use. +### -PortID + +> Applicable: Microsoft Teams + +If the PortID subtype is a MAC Address, 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 subtype, such as Interface Name), this value must be in a string format as set on the switch. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -196,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -203,7 +225,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -229,6 +250,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport) +[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisport) -[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport) +[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisport) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSubnet.md similarity index 92% rename from teams/teams-ps/teams/Set-CsOnlineLisSubnet.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSubnet.md index ae42f3ce2d..a6373a4613 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSubnet.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelissubnet applicable: Microsoft Teams -title: Set-CsOnlineLisSubnet -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelissubnet +schema: 2.0.0 +title: Set-CsOnlineLisSubnet --- # Set-CsOnlineLisSubnet @@ -48,13 +49,15 @@ Example 2 creates the Location Information Service subnet in IPv6 format "2001:4 ## PARAMETERS ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the Location Information Service subnet. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -88,7 +96,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -114,13 +123,15 @@ Accept wildcard characters: False ``` ### -LocationId + +> Applicable: Microsoft Teams + Specifies the unique identifier of the location to be modified. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -130,13 +141,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -146,13 +159,15 @@ Accept wildcard characters: False ``` ### -Subnet + +> Applicable: Microsoft Teams + The IP address of the subnet. This value can be either IPv4 or IPv6 format. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 1 @@ -162,13 +177,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -178,13 +195,15 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 @@ -194,6 +213,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -201,7 +223,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSwitch.md similarity index 90% rename from teams/teams-ps/teams/Set-CsOnlineLisSwitch.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSwitch.md index 71e862e8a2..d70cf60b81 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSwitch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch applicable: Microsoft Teams -title: Set-CsOnlineLisSwitch -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisswitch +schema: 2.0.0 +title: Set-CsOnlineLisSwitch --- # Set-CsOnlineLisSwitch @@ -36,6 +37,9 @@ Example 1 creates a switch with Chassis ID "B8-BE-BF-4A-A3-00", and associates i ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + 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 @@ -43,7 +47,6 @@ Otherwise, (different sub type, such as Interface Name), then this value must be Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -52,16 +55,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -The name for this location. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -69,13 +74,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the switch. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -85,6 +92,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -93,7 +103,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +112,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -118,30 +129,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NCSApiUrl -This parameter is reserved for internal Microsoft use. +### -LocationId + +> Applicable: Microsoft Teams + +The name for this location. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore +### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -150,14 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -167,6 +184,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -174,7 +194,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -200,6 +219,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch) +[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisswitch) -[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch) +[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisswitch) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint.md similarity index 91% rename from teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint.md index 75045602f9..328a5f0a27 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint applicable: Microsoft Teams -title: Set-CsOnlineLisWirelessAccessPoint -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliswirelessaccesspoint +schema: 2.0.0 +title: Set-CsOnlineLisWirelessAccessPoint --- # Set-CsOnlineLisWirelessAccessPoint @@ -47,13 +48,15 @@ Example 2 creates the wireless access point with Chassis ID "F0-6E-0B-C2-04-*", ## PARAMETERS ### -BSSID + +> Applicable: Microsoft Teams + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. If an entry with the specified BSSID value does not exist, a new WAP will be created. If an entry with the specified BSSID already exists, that entry will be replaced. It can be presented in wildcard format. The wildcard '*' can be on either the last one or two character(s). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -62,16 +65,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -The name for this location. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the WAP. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -95,6 +102,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -103,7 +113,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -113,13 +122,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -128,30 +139,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NCSApiUrl -This parameter is reserved for internal Microsoft use. +### -LocationId + +> Applicable: Microsoft Teams + +The name for this location. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore +### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -160,14 +175,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -177,6 +194,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -184,7 +204,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -210,6 +229,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint) +[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliswirelessaccesspoint) -[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint) +[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliswirelessaccesspoint) diff --git a/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePSTNGateway.md similarity index 85% rename from teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlinePSTNGateway.md index aa577953e6..3b137b465b 100644 --- a/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePSTNGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway applicable: Microsoft Teams -title: Set-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstngateway +schema: 2.0.0 +title: Set-CsOnlinePSTNGateway --- # Set-CsOnlinePSTNGateway @@ -18,12 +19,32 @@ Modifies the previously defined Session Border Controller (SBC) Configuration th ## SYNTAX ``` -Set-CsOnlinePSTNGateway [[-Identity] ] [-BypassMode ] [-Description ] [-Enabled ] - [-FailoverResponseCodes ] [-FailoverTimeSeconds ] [-ForwardCallHistory ] [-ForwardPai ] [-GatewayLbrEnabledUserOverride ] - [-GatewaySiteId ] [-GatewaySiteLbrEnabled ] [-InboundPstnNumberTranslationRules ] [-InboundTeamsNumberTranslationRules ] - [-MaxConcurrentSessions ] [-MediaBypass ] [-MediaRelayRoutingLocationOverride ] [-OutboundPstnNumberTranslationRules ] - [-OutboundTeamsNumberTranslationRules ] [-PidfLoSupported ] [-ProxySbc ] [-SendSipOptions ] [-SipSignalingPort ] - [-WhatIf] [-Confirm] [] +Set-CsOnlinePSTNGateway [[-Identity] ] + [-BypassMode ] + [-Confirm] + [-Description ] + [-Enabled ] + [-FailoverResponseCodes ] + [-FailoverTimeSeconds ] + [-ForwardCallHistory ] + [-ForwardPai ] + [-GatewayLbrEnabledUserOverride ] + [-GatewaySiteId ] + [-GatewaySiteLbrEnabled ] + [-IPAddressVersion ] + [-InboundPstnNumberTranslationRules ] + [-InboundTeamsNumberTranslationRules ] + [-MaxConcurrentSessions ] + [-MediaBypass ] + [-MediaRelayRoutingLocationOverride ] + [-OutboundPstnNumberTranslationRules ] + [-OutboundTeamsNumberTranslationRules ] + [-PidfLoSupported ] + [-ProxySbc ] + [-SendSipOptions ] + [-SipSignalingPort ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -47,14 +68,47 @@ This example modifies the configuration of an SBC with identity (and FQDN) sbc. ## PARAMETERS +### -BypassMode +Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the 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 + +> Applicable: Microsoft Teams + Free-format string to describe the gateway. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -63,13 +117,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Microsoft Teams + Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC from service while it is being updated or during maintenance. Note if the parameter is not set the SBC will be created as disabled (default value -Enabled $false). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -78,6 +134,9 @@ Accept wildcard characters: False ``` ### -FailoverResponseCodes + +> Applicable: Microsoft Teams + If Direct Routing receives any 4xx or 6xx SIP error code in response on outgoing Invite (outgoing means call from a Teams client to PSTN with traffic flow :Teams Client -> Direct Routing -> SBC -> Telephony network) the call is considered completed by default. Setting the SIP codes in this parameter forces Direct Routing on receiving the specified codes try another SBC (if another SBC exists in the voice routing policy of the user). @@ -89,7 +148,6 @@ Setting this parameter overwrites the default values, so if you want to include Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 408, 503, 504 @@ -98,13 +156,15 @@ Accept wildcard characters: False ``` ### -FailoverTimeSeconds + +> Applicable: Microsoft Teams + When set to 10 (default value), outbound calls that are not answered by the gateway within 10 seconds are routed to the next available trunk; if there are no additional trunks, then the call is automatically dropped. In an organization with slow networks and slow gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 10 @@ -113,13 +173,15 @@ Accept wildcard characters: False ``` ### -ForwardCallHistory + +> Applicable: Microsoft Teams + Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -128,13 +190,15 @@ Accept wildcard characters: False ``` ### -ForwardPai + +> Applicable: Microsoft Teams + Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False). Setting this parameter to $true will render the from header anonymous, in accordance of RFC5379 and RFC3325. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -142,44 +206,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewaySiteId -PSTN Gateway Site Id. +### -GatewayLbrEnabledUserOverride + +> Applicable: Microsoft Teams + +Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: $false Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewayLbrEnabledUserOverride -Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. +### -GatewaySiteId + +> Applicable: Microsoft Teams + +PSTN Gateway Site Id. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: $false +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -GatewaySiteLbrEnabled + +> Applicable: Microsoft Teams + Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is turned on, the SBC will report the site name as defined by tenant administrator. On incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -188,13 +258,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The parameter is mandatory when modifying an existing SBC. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -202,14 +274,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxConcurrentSessions -Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent session is 90% or higher than this value. If this parameter is not set, the alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours. +### -InboundPSTNNumberTranslationRules +Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. ```yaml -Type: System.Int32 +Type: Object Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -217,69 +288,73 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaBypass -Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC. +### -InboundTeamsNumberTranslationRules +This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: $false +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaRelayRoutingLocationOverride - -Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter. +### -IPAddressVersion +Possible values are "IPv4" and '"Pv6". When "IPv6" is set, the SBC must use IPv6 for both signaling and media. **Note: IPv6 is supported only for non-media bypass scenarios.** ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: $false +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SendSipOptions -Defines if an SBC will or will not send the SIP options. If disabled, the SBC will be excluded from Monitoring and Alerting system. We highly recommend that you enable SIP options. Default value is True. +### -MaxConcurrentSessions + +> Applicable: Microsoft Teams + +Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent session is 90% or higher than this value. If this parameter is not set, the alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours. ```yaml -Type: Boolean +Type: System.Int32 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 ``` -### -SipSignalingPort -Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. The value must be between 1 and 65535. +### -MediaBypass + +> Applicable: Microsoft Teams + +Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC. ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: $false Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassMode -Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle. +### -MediaRelayRoutingLocationOverride + +> Applicable: Microsoft Teams + +Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter. ```yaml Type: String @@ -287,13 +362,13 @@ Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: $false Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundTeamsNumberTranslationRules -This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. +### -OutboundPSTNNumberTranslationRules +Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction. ```yaml Type: Object @@ -306,8 +381,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundPSTNNumberTranslationRules -Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. +### -OutboundTeamsNumberTranslationRules +Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction. ```yaml Type: Object @@ -320,25 +395,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundTeamsNumberTranslationRules -Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction. +### -PidfloSupported + +> Applicable: Microsoft Teams + +Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: $false Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundPSTNNumberTranslationRules -Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction. +### -ProxySbc + +> Applicable: Microsoft Teams + +The FQDN of the proxy SBC. Used in Local Media Optimization configurations. ```yaml -Type: Object +Type: String Parameter Sets: (All) Aliases: Required: False @@ -348,29 +429,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PidfloSupported -Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user. +### -SendSipOptions + +> Applicable: Microsoft Teams + +Defines if an SBC will or will not send the SIP options. If disabled, the SBC will be excluded from Monitoring and Alerting system. We highly recommend that you enable SIP options. Default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: $false +Default value: $true Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxySbc -The FQDN of the proxy SBC. Used in Local Media Optimization configurations. +### -SipSignalingPort + +> Applicable: Microsoft Teams + +Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. The value must be between 1 and 65535. ```yaml -Type: String +Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -379,6 +464,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -386,22 +474,6 @@ The cmdlet is not run. 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 running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -422,8 +494,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinepstngateway) -[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstngateway) -[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinepstngateway) diff --git a/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePstnUsage.md similarity index 89% rename from teams/teams-ps/teams/Set-CsOnlinePstnUsage.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlinePstnUsage.md index 549dcdcc10..3a2e9594ec 100644 --- a/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePstnUsage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstnusage applicable: Microsoft Teams -title: Set-CsOnlinePstnUsage -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstnusage +schema: 2.0.0 +title: Set-CsOnlinePstnUsage --- # Set-CsOnlinePstnUsage @@ -29,28 +30,28 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsOnlinePstnUsage -Identity global -Usage @{add="International"} ``` This command adds the string "International" to the current list of available PSTN usages. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsOnlinePstnUsage -Identity global -Usage @{remove="Local"} ``` This command removes the string "Local" from the list of available PSTN usages. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Set-CsOnlinePstnUsage -Usage @{remove="Local"} ``` The command in this example performs the exact same action as the command in Example 2: it removes the "Local" PSTN usage. This example shows the command without the Identity parameter specified. The only Identity available to the Set-CsOnlinePstnUsage cmdlet is the Global identity; omitting the Identity parameter defaults to Global. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> Set-CsOnlinePstnUsage -Usage @{replace="International","Restricted"} ``` @@ -134,4 +135,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstnusage) +[Get-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstnusage) diff --git a/teams/teams-ps/teams/Set-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineSchedule.md similarity index 88% rename from teams/teams-ps/teams/Set-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineSchedule.md index 7f4392b0fa..99378400fc 100644 --- a/teams/teams-ps/teams/Set-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineschedule +schema: 2.0.0 +title: Set-CsOnlineSchedule --- # Set-CsOnlineSchedule @@ -25,7 +27,7 @@ The Set-CsOnlineSchedule cmdlet lets you modify the properties of a schedule. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $schedule = Get-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" $schedule.Name = "Christmas Holiday" @@ -34,7 +36,7 @@ Set-CsOnlineSchedule -Instance $schedule This example modifies the name of the schedule that has a Id of fa9081d6-b4f3-5c96-baec-0b00077709e5. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $schedule = Get-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" @@ -57,13 +59,15 @@ This example updates an existing holiday schedule, adding a new date/time range ## PARAMETERS ### -Instance + +> Applicable: Microsoft Teams + The Instance parameter is the object reference to the schedule to be modified. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -74,11 +78,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -103,6 +108,6 @@ The modified instance of the `Microsoft.Rtc.Management.Hosted.Online.Models.Sche ## RELATED LINKS -[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) -[Remove-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/remove-csonlineschedule) +[Remove-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineschedule) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance.md similarity index 90% rename from teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance.md index f62687992e..1b69298b70 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance.md @@ -1,22 +1,20 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceapplicationinstance +schema: 2.0.0 +title: Set-CsOnlineVoiceApplicationInstance --- # 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. +The cmdlet modifies an application instance in Microsoft Entra ID. ## SYNTAX ``` @@ -33,6 +31,9 @@ Set-CsOnlineVoiceApplicationInstance [[-Identity] ] ## DESCRIPTION This cmdlet is used to modify an application instance in Microsoft Entra ID. +**Note**: This cmdlet has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) and +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) cmdlets instead. + ## EXAMPLES ### Example 1 @@ -172,4 +173,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoute.md similarity index 95% rename from teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoute.md index e88a324e6f..cc24ec7a5e 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoute.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroute +schema: 2.0.0 +title: Set-CsOnlineVoiceRoute --- # Set-CsOnlineVoiceRoute @@ -31,21 +33,21 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -Description "Test Route" ``` This command sets the Description of the Route1 online voice route to "Test Route." -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{add="Long Distance"} ``` The command in this example modifies the online voice route with the identity Route1 to add the online PSTN usage Long Distance to the list of usages for this voice route. Long Distance must be in the list of global online PSTN usages (which can be retrieved with a call to the `Get-CsOnlinePstnUsage` cmdlet). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> $x = (Get-CsOnlinePstnUsage).Usage @@ -214,8 +216,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroute) -[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy.md index c541ead593..39f6ca7600 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Set-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Set-CsOnlineVoiceRoutingPolicy --- # Set-CsOnlineVoiceRoutingPolicy @@ -31,21 +32,21 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages @{Add="Long Distance"} ``` The command shown in Example 1 adds the online PSTN usage "Long Distance" to the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages @{Remove="Local"} ``` In Example 2, the online PSTN usage "Local" is removed from the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Set-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Local"} | Set-CsOnlineVoiceRoutingPolicy -OnlinePstnUsages @{Remove="Local"} ``` @@ -165,10 +166,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy) -[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceUser.md similarity index 88% rename from teams/teams-ps/teams/Set-CsOnlineVoiceUser.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceUser.md index d7f09686d0..3d9db13679 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceUser.md @@ -1,13 +1,14 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceuser +schema: 2.0.0 +title: Set-CsOnlineVoiceUser --- # Set-CsOnlineVoiceUser @@ -15,10 +16,6 @@ ms.reviewer: ## SYNOPSIS 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](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and -[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. - ## SYNTAX ``` @@ -27,17 +24,20 @@ Set-CsOnlineVoiceUser [-Identity] [-Tenant ] [-Telephone ``` ## DESCRIPTION +**Note**: This cmdlet has been deprecated. Use the new +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) and +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) cmdlets instead. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineVoiceUser -Identity 3c37e1c7-78f9-4703-82ee-a6b68516794e -TelephoneNumber +14255037311 -LocationID c7c5a17f-00d7-47c0-9ddb-3383229d606b ``` This example sets the telephone number and location for a user identified by the user ObjectID. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineVoiceUser -Identity user@domain.com -TelephoneNumber $null ``` @@ -46,39 +46,16 @@ This example removes the telephone number for a user identified by the user's SI ## 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: Object -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -Confirm -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -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 @@ -88,13 +65,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -104,6 +83,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -112,7 +94,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -121,7 +102,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +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: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocationID + +> Applicable: Microsoft Teams + Specifies the unique identifier of the emergency location to assign to the user. Location identities can be discovered by using the `Get-CsOnlineLisLocation` cmdlet. @@ -131,7 +142,6 @@ This parameter is required for users based in the US. Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -141,6 +151,9 @@ Accept wildcard characters: False ``` ### -TelephoneNumber + +> Applicable: Microsoft Teams + Specifies the telephone number to be assigned to the user. The value must be in E.164 format: +14255043920. Setting the value to $Null clears the user's telephone number. @@ -149,7 +162,6 @@ Setting the value to $Null clears the user's telephone number. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -159,13 +171,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -175,13 +189,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf parameter is not implemented for this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailPolicy.md similarity index 84% rename from teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailPolicy.md index e5f0a4f436..6aaf292eb4 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailPolicy.md @@ -1,19 +1,20 @@ --- -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: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailpolicy +schema: 2.0.0 +title: Set-CsOnlineVoicemailPolicy --- # 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 the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. +Modifies an existing Online Voicemail policy. ## SYNTAX @@ -41,14 +42,14 @@ Tenant admin would be able to create a customized online voicemail policy to mat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" -MaximumRecordingLength ([TimeSpan]::FromSeconds(60)) ``` The command shown in Example 1 changes the MaximumRecordingLength to 60 seconds for the per-user online voicemail policy CustomOnlineVoicemailPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineVoicemailPolicy -EnableTranscriptionProfanityMasking $false ``` @@ -57,30 +58,49 @@ The command shown in Example 2 changes the EnableTranscriptionProfanityMasking t ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -Confirm + +> Applicable: Microsoft Teams + +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 about the policy. For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -EnableEditingCallAnswerRulesSetting + +> Applicable: Microsoft Teams + Controls if editing call answer rule settings are enabled or disabled for a user. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -90,13 +110,15 @@ Accept wildcard characters: False ``` ### -EnableTranscription + +> Applicable: Microsoft Teams + Allows you to disable or enable voicemail transcription. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -106,13 +128,15 @@ Accept wildcard characters: False ``` ### -EnableTranscriptionProfanityMasking + +> Applicable: Microsoft Teams + Allows you to disable or enable profanity masking for the voicemail transcriptions. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -122,13 +146,15 @@ Accept wildcard characters: False ``` ### -EnableTranscriptionTranslation + +> Applicable: Microsoft Teams + Allows you to disable or enable translation for the voicemail transcriptions. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -137,14 +163,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +A unique identifier specifying the scope, and in some cases the name, 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 +``` + ### -MaximumRecordingLength + +> Applicable: Microsoft Teams + A duration of voicemail maximum recording length. The length should be between 30 seconds to 10 minutes. ```yaml Type: Duration Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -154,13 +200,15 @@ Accept wildcard characters: False ``` ### -PostambleAudioFile + +> Applicable: Microsoft Teams + The audio file to play to the caller after the user's voicemail greeting has played and before the caller is allowed to leave a voicemail message. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -168,13 +216,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -PreambleAudioFile + +> Applicable: Microsoft Teams + The audio file to play to the caller before the user's voicemail greeting is played. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -183,13 +233,15 @@ Accept wildcard characters: False ``` ### -PreamblePostambleMandatory + +> Applicable: Microsoft Teams + Is playing the Pre- or Post-amble mandatory before the caller can leave a message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: False @@ -198,13 +250,15 @@ 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](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. + +> Applicable: Microsoft Teams + +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/microsoftteams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -214,13 +268,15 @@ 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](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. + +> Applicable: Microsoft Teams + +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/microsoftteams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -230,13 +286,15 @@ Accept wildcard characters: False ``` ### -ShareData + +> Applicable: Microsoft Teams + Specifies whether voicemail and transcription data are shared with the service for training and improving accuracy. Possible values are Defer and Deny. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -246,44 +304,15 @@ 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 -``` +> Applicable: Microsoft Teams -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually 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 -``` - -### -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: +Aliases: wi Required: False Position: Named @@ -302,10 +331,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings.md similarity index 92% rename from teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings.md index 679bea74c8..3c4eb2413a 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings applicable: Microsoft Teams -title: Set-CsOnlineVoicemailUserSettings -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailusersettings +schema: 2.0.0 +title: Set-CsOnlineVoicemailUserSettings --- # Set-CsOnlineVoicemailUserSettings @@ -31,35 +32,35 @@ For example, tenant admin could enable/disable voicemail, change voicemail promp ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineVoicemailUserSettings -Identity sip:user1@contoso.com -VoicemailEnabled $true ``` This example changes VoicemailEnabled setting to true for the user with SIP URI sip:user1@contoso.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineVoicemailUserSettings -Identity user2@contoso.com -PromptLanguage "en-US" -OofGreetingFollowCalendarEnabled $false ``` This example changes PromptLanguage setting to "en-US" and OofGreetingFollowCalendarEnabled setting to false for user2@contoso.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsOnlineVoicemailUserSettings -Identity user3@contoso.com -CallAnswerRule PromptOnlyWithTransfer -TransferTarget sip:user4@contoso.com ``` This example changes CallAnswerRule setting to PromptOnlyWithTransfer and set TransferTarget to "sip:user4@contoso.com" for user3@contoso.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsOnlineVoicemailUserSettings -Identity user5@contoso.com -CallAnswerRule VoicemailWithTransferOption -TransferTarget "+14255551234" ``` This example changes CallAnswerRule setting to VoicemailWithTransferOption and set TransferTarget to "+14255551234" for user5@contoso.com.. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Set-CsOnlineVoicemailUserSettings -Identity user6@contoso.com -DefaultGreetingPromptOverwrite "Hi, I am currently not available." ``` @@ -68,36 +69,40 @@ This example changes DefaultGreetingPromptOverwrite setting to "Hi, I am current ## PARAMETERS -### -Identity -The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. +### -CallAnswerRule + +> Applicable: Microsoft Teams + +The CallAnswerRule parameter represents the value of the call answer rule, which can be any of the following: + +- DeclineCall +- PromptOnly +- PromptOnlyWithTransfer +- RegularVoicemail +- VoicemailWithTransferOption ```yaml -Type: System.String +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CallAnswerRule -The CallAnswerRule parameter represents the value of the call answer rule, which can be any of the following: +### -Confirm -- DeclineCall -- PromptOnly -- PromptOnlyWithTransfer -- RegularVoicemail -- VoicemailWithTransferOption +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -DefaultGreetingPromptOverwrite + +> Applicable: Microsoft Teams + The DefaultGreetingPromptOverwrite parameter represents the contents that overwrite the default normal greeting prompt. If the user's normal custom greeting is not set and DefaultGreetingPromptOverwrite is not empty, the voicemail service will play this overwrite greeting instead of the default normal greeting in the voicemail deposit scenario. @@ -114,7 +122,6 @@ If the user's normal custom greeting is not set and DefaultGreetingPromptOverwri Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -DefaultOofGreetingPromptOverwrite + +> Applicable: Microsoft Teams + The DefaultOofGreetingPromptOverwrite parameter represents the contents that overwrite the default out-of-office greeting prompt. If the user's out-of-office custom greeting is not set and DefaultOofGreetingPromptOverwrite is not empty, the voicemail service will play this overwrite greeting instead of the default out-of-office greeting in the voicemail deposit scenario. @@ -131,7 +141,6 @@ If the user's out-of-office custom greeting is not set and DefaultOofGreetingPro Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -155,14 +164,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OofGreetingEnabled + +> Applicable: Microsoft Teams + The OofGreetingEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -172,13 +201,15 @@ Accept wildcard characters: False ``` ### -OofGreetingFollowAutomaticRepliesEnabled + +> Applicable: Microsoft Teams + The OofGreetingFollowAutomaticRepliesEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario when user set automatic replies in Outlook. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -188,6 +219,9 @@ Accept wildcard characters: False ``` ### -PromptLanguage + +> Applicable: Microsoft Teams + The PromptLanguage parameter represents the language that is used to play voicemail prompts. The following languages are supported: @@ -251,7 +285,6 @@ The following languages are supported: Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -261,13 +294,15 @@ Accept wildcard characters: False ``` ### -ShareData + +> Applicable: Microsoft Teams + Specifies whether voicemail and transcription data is shared with the service for training and improving accuracy. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -277,6 +312,9 @@ Accept wildcard characters: False ``` ### -TransferTarget + +> Applicable: Microsoft Teams + 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. For user with Enterprise Voice enabled, a valid telephone number could also be accepted as TransferTarget. @@ -285,7 +323,6 @@ For user with Enterprise Voice enabled, a valid telephone number could also be a Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -295,13 +332,15 @@ Accept wildcard characters: False ``` ### -VoicemailEnabled + +> Applicable: Microsoft Teams + The VoicemailEnabled parameter represents whether to enable voicemail service. If set to $false, the user has no voicemail service. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -311,29 +350,15 @@ 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 +> 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. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -357,4 +382,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailusersettings) +[Get-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailusersettings) diff --git a/teams/teams-ps/MicrosoftTeams/Set-CsPersonalAttendantSettings.md b/teams/teams-ps/MicrosoftTeams/Set-CsPersonalAttendantSettings.md new file mode 100644 index 0000000000..a9a9293b23 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Set-CsPersonalAttendantSettings.md @@ -0,0 +1,348 @@ +--- +applicable: Microsoft Teams +author: juliiva +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: jomarque +Module Name: MicrosoftTeams +ms.author: juliiva +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cspersonalattendantsettings +schema: 2.0.0 +title: Set-CsPersonalAttendantSettings +--- + +# Set-CsPersonalAttendantSettings + +## SYNOPSIS + +**Limited Preview:** Functionality described in this document is currently in limited preview and only authorized organizations have access. + +This cmdlet will set personal attendant settings for the specified user. + +## SYNTAX + +``` +Set-CsPersonalAttendantSettings -Identity -IsPersonalAttendantEnabled -DefaultLanguage [-DefaultVoice ] [-CalleeName ] [-DefaultTone ] -IsBookingCalendarEnabled [-IsNonContactCallbackEnabled ] -IsCallScreeningEnabled -AllowInboundInternalCalls -AllowInboundFederatedCalls -AllowInboundPSTNCalls -IsAutomaticTranscriptionEnabled -IsAutomaticRecordingEnabled [] +``` + +## DESCRIPTION + +This cmdlet sets personal attendant settings for the specified user. + +When specifying settings you need to specify all settings, for instance, you can't just turn call screening on. Instead, you need to +start by getting the current settings, making the necessary changes, and then setting/writing all settings. + +## EXAMPLES + +### Example 1 +``` +Set-CsPersonalAttendantSettings -Identity user1@contoso.com -IsPersonalAttendantEnabled $true -DefaultLanguage en-US -CalleeName User1 -IsBookingCalendarEnabled $false -IsCallScreeningEnabled $false +-AllowInboundInternalCalls $true -AllowInboundFederatedCalls $false -AllowInboundPSTNCalls $false -IsAutomaticTranscriptionEnabled $false -IsAutomaticRecordingEnabled $false +``` + +This example shows setting up personal attendant for user1@contoso.com. Personal attendant communicates in English. Personal attendant will refer to its owner as User1. +Personal attendant is only enabled for inbound Teams calls from the user's domain. Additional capabilities are turned off. + +### Example 2 +``` +Set-CsPersonalAttendantSettings -Identity user1@contoso.com -IsPersonalAttendantEnabled $true -DefaultLanguage en-US -CalleeName User1 -IsBookingCalendarEnabled $true -IsCallScreeningEnabled $false +-AllowInboundInternalCalls $true -AllowInboundFederatedCalls $false -AllowInboundPSTNCalls $false -IsAutomaticTranscriptionEnabled $false -IsAutomaticRecordingEnabled $false +``` + +This example shows setting up personal attendant for user1@contoso.com. In addition to previously mentioned capabilities, personal attendant is able to access personal bookings calendar, +fetch the user's availability and schedule callbacks on behalf of the user. Calendar operations are enabled for all incoming callers. user1 must specify the bookings link in Teams Personal Attendant settings. + +### Example 3 +``` +Set-CsPersonalAttendantSettings -Identity user1@contoso.com -IsPersonalAttendantEnabled $true -DefaultLanguage en-US -CalleeName User1 -IsBookingCalendarEnabled $true -IsCallScreeningEnabled $false +-AllowInboundInternalCalls $true -AllowInboundFederatedCalls $true -AllowInboundPSTNCalls $true -IsAutomaticTranscriptionEnabled $false -IsAutomaticRecordingEnabled $false +``` + +This example shows setting up personal attendant for user1@contoso.com. In addition to previously mentioned capabilities, personal attendant is enabled for all incoming calls: the user's domain, other domains and PSTN. + +### Example 4 +``` +Set-CsPersonalAttendantSettings -Identity user1@contoso.com -IsPersonalAttendantEnabled $true -DefaultLanguage en-US -CalleeName User1 -IsBookingCalendarEnabled $true -IsCallScreeningEnabled $true +-AllowInboundInternalCalls $true -AllowInboundFederatedCalls $true -AllowInboundPSTNCalls $true -IsAutomaticTranscriptionEnabled $false -IsAutomaticRecordingEnabled $false +``` + +This example shows setting up personal attendant for user1@contoso.com. In addition to previously mentioned capabilities, personal attendant is enabled to evaluate the call's context and pass the info to the user. + +### Example 5 +``` +Set-CsPersonalAttendantSettings -Identity user1@contoso.com -IsPersonalAttendantEnabled $true -DefaultLanguage en-US -CalleeName User1 -IsBookingCalendarEnabled $true -IsCallScreeningEnabled $true +-AllowInboundInternalCalls $true -AllowInboundFederatedCalls $true -AllowInboundPSTNCalls $true -IsAutomaticTranscriptionEnabled $true -IsAutomaticRecordingEnabled $true +``` + +This example shows setting up personal attendant for user1@contoso.com. In addition to previously mentioned capabilities, personal attendant is automatically storing call transcription and recording. + +### Example 6 +``` +Set-CsPersonalAttendantSettings -Identity user1@contoso.com -IsPersonalAttendantEnabled $false +``` + +This example shows turning off personal attendant for user1@contoso.com. + +### Example 7 +``` +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $false +Set-CsPersonalAttendantSettings -Identity user1@contoso.com -IsPersonalAttendantEnabled $true -DefaultLanguage en-US -CalleeName User1 -IsBookingCalendarEnabled $false -IsCallScreeningEnabled $false +-AllowInboundInternalCalls $true -AllowInboundFederatedCalls $false -AllowInboundPSTNCalls $false -IsAutomaticTranscriptionEnabled $false -IsAutomaticRecordingEnabled $false +``` + +This example shows how to set up personal attendant for a user, who has call forwarding enabled. + +### Example 8 +``` +Set-CsUserCallingSettings -Identity user1@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType Voicemail -UnansweredDelay 00:00:20 +Set-CsPersonalAttendantSettings -Identity user1@contoso.com -IsPersonalAttendantEnabled $true -DefaultLanguage en-US -CalleeName User1 -IsBookingCalendarEnabled $false -IsCallScreeningEnabled $false +-AllowInboundInternalCalls $true -AllowInboundFederatedCalls $false -AllowInboundPSTNCalls $false -IsAutomaticTranscriptionEnabled $false -IsAutomaticRecordingEnabled $false +``` + +This example shows how to set up personal attendant for a user, who would like to use unanswered call functionality simultaniously with personal attendant. + +## PARAMETERS + +### -Identity +The Identity of the user to set personal attendant settings for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsPersonalAttendantEnabled +This parameter controls whether personal attendant is enabled or not. If personal attendant is enabled, then at least one of: AllowInboundInternalCalls, AllowInboundFederatedCalls, AllowInboundPSTNCalls must be enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultLanguage +Language to be used by personal attendant in communication. The preliminary list of supported languages is: +en-US, fr-FR, ar-SA, zh-CN, zh-TW, cs-CZ, da-DK, nl-NL, en-AU, en-GB, fi-FI, fr-CA, de-DE, el-GR, hi-IN, id-ID, it-IT, ja-JP, ko-KR, nb-NO, pl-PL, pt-BR, ru-RU, es-ES, es-US, sv-SE, th-TH, tr-TR + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: en-US +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultVoice +Voice to be used by personal attendant in communication. Supported values are Female and Male. + +> [!NOTE] +> This parameter is currently in development and changing it does not change the behavior of Personal Attendant. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Female +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalleeName +Name that personal attendant uses when referring to its owner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultTone +Tone to be used by personal attendant in communication. Supported values are Formal and Casual. + +> [!NOTE] +> This parameter is currently in development and enabling/disabling it does not change the behavior of Personal Attendant. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Formal +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsBookingCalendarEnabled +This parameter controls whether personal attendant can access personal bookings calendar to fetch the user's availability and schedule callbacks on behalf of the user. +If access to personal calendar is enabled by admin, user must specify the bookings link in Teams Personal Attendant settings. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsNonContactCallbackEnabled +This parameter controls whether personal attendant calendar operations for callers not in the user contact list are enabled or not. + +> [!NOTE] +> This parameter is currently in development and enabling/disabling it does not change the behavior of Personal Attendant. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsCallScreeningEnabled +This parameter controls whether personal attendant evaluates calls context and passes the info to the user. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowInboundInternalCalls +This parameter controls whether personal attendant for incoming domain calls is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowInboundFederatedCalls +This parameter controls whether personal attendant for incoming calls from other domains is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowInboundPSTNCalls +This parameter controls whether personal attendant for incoming PSTN calls is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAutomaticTranscriptionEnabled +This parameter controls whether automatic storing of transcriptions (of personal attendant calls) is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAutomaticRecordingEnabled +This parameter controls whether automatic storing of recordings (of personal attendant calls) is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 7.3.0 or later. + +The specified user need to have the Microsoft Phone System license assigned. + +The cmdlet is validating different settings and is always writing all the parameters. You might see validation errors from the cmdlet due to +this behavior. As an example, if you already have call forwarding set up and you want to set up personal attendant, you will get a validation error. + + +## RELATED LINKS +[Get-CsPersonalAttendantSettings](./get-cspersonalattendantsettings.md) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberAssignment.md similarity index 71% rename from teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md rename to teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberAssignment.md index 77f4b58a11..1923a2bfd4 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberAssignment.md @@ -1,300 +1,375 @@ ---- -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 -title: Set-CsPhoneNumberAssignment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsPhoneNumberAssignment - -## SYNOPSIS -This cmdlet will assign a phone number to a user or a resource account (online application instance). - -## SYNTAX - -### LocationUpdate (Default) -```powershell -Set-CsPhoneNumberAssignment -PhoneNumber -LocationId [] -``` - -### NetworkSiteUpdate -```powershell -Set-CsPhoneNumberAssignment -PhoneNumber -NetworkSiteId [] -``` - -### Assignment -```powershell -Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType - [-LocationId ] [-NetworkSiteId ] [-AssignmentCategory ] [] -``` - -### Attribute -```powershell -Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled [] -``` - -### ReverseNumberLookup -```powershell -Set-CsPhoneNumberAssignment -PhoneNumber -ReverseNumberLookup [] -``` - -## DESCRIPTION -This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. - -You can also assign a location to a phone number. - -To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlet. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan -``` -This example assigns the Microsoft Calling Plan phone number +1 (206) 555-1234 to the user user1@contoso.com. - -### Example 2 -```powershell -$loc=Get-CsOnlineLisLocation -City Vancouver -Set-CsPhoneNumberAssignment -Identity user2@contoso.com -PhoneNumber +12065551224 -PhoneNumberType CallingPlan -LocationId $loc.LocationId -``` -This example finds the emergency location defined for the corporate location Vancouver and assigns the Microsoft Calling Plan phone number +1 (206) 555-1224 and location to the user user2@contoso.com. - -### Example 3 -```powershell -Set-CsPhoneNumberAssignment -Identity user3@contoso.com -EnterpriseVoiceEnabled $true -``` -This example sets the EnterpriseVoiceEnabled flag on the user user3@contoso.com. - -### Example 4 -```powershell -Set-CsPhoneNumberAssignment -Identity user3@contoso.com -LocationId 'null' -PhoneNumber +12065551226 -PhoneNumberType OperatorConnect -``` -This example removes the emergency location from the phone number for user user3@contoso.com. - -### Example 5 -```powershell -Set-CsPhoneNumberAssignment -Identity cq1@contoso.com -PhoneNumber +14255551225 -PhoneNumberType DirectRouting -``` -This example assigns the Direct Routing phone number +1 (425) 555-1225 to the resource account cq1@contoso.com. - -### Example 6 -```powershell -Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -``` -This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 to the user user4@contoso.com. - -### Example 7 -```powershell -Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occurred } -``` -This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. - -### Example 8 -```powershell -$TempUser = "tempuser@contoso.com" -$OldLoc=Get-CsOnlineLisLocation -City Vancouver -$NewLoc=Get-CsOnlineLisLocation -City Seattle -$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment -foreach ($No in $Numbers) { - Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId - Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -} -``` -This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers, assigning each phone number temporarily with the new location to a user, and then unassigning the phone number again from the user. - -### Example 9 -```powershell -$loc=Get-CsOnlineLisLocation -City Toronto -Set-CsPhoneNumberAssignment -PhoneNumber +12065551224 -LocationId $loc.LocationId -``` -This example shows how to set the location on a phone number. - -### Example 10 -```powershell -$OldLocationId = "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" -$NewLocationId = "951fac72-955e-4734-ab74-cc4c0f761c0b" -# Get all phone numbers in old location -$pns = Get-CsPhoneNumberAssignment -LocationId $OldLocationId -Write-Host $pns.count numbers found in old location $OldLocationId -# Move all those phone numbers to the new location -foreach ($pn in $pns) { - Try { - Set-CsPhoneNumberAssignment -PhoneNumber $pn.TelephoneNumber -LocationId $NewLocationId -ErrorAction Stop - Write-Host $pn.TelephoneNumber was updated to have location $NewLocationId - } - Catch { - Write-Host Could not update $pn.TelephoneNumber with location $NewLocationId - } -} -Write-Host (Get-CsPhoneNumberAssignment -LocationId $OldLocationId).Count numbers found in old location $OldLocationId -Write-Host (Get-CsPhoneNumberAssignment -LocationId $NewLocationId).Count numbers found in new location $NewLocationId -``` -This Example shows how to update the LocationID from an old location to a new location for a set of phone numbers. - -### Example 11 -```powershell -Set-CsPhoneNumberAssignment -Identity user3@contoso.com -PhoneNumber +12065551226 -ReverseNumberLookup 'SkipInternalVoip' -``` -This example shows how to turn off reverse number lookup (RNL) on a phone number. When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. This example is only applicable for Direct Routing phone numbers. - -## PARAMETERS - -### -AssignmentCategory -This parameter is reserved for internal Microsoft use. - -```yaml -Type: System.String -Parameter Sets: (Assignment) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnterpriseVoiceEnabled -Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. - -This parameter is mutual exclusive with PhoneNumber. - -```yaml -Type: System.Boolean -Parameter Sets: (Attribute) -Aliases: -Applicable: Microsoft Teams - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or -resource account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationId -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. -If you want to remove the location, use the string value null for LocationId. - -```yaml -Type: System.String -Parameter Sets: (Assignment, LocationUpdate) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSiteId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: System.String -Parameter Sets: (Assignment) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -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'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. - -Setting a phone number will automatically set EnterpriseVoiceEnabled to True. - -```yaml -Type: System.String -Parameter Sets: (Assignment, LocationUpdate) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumberType -The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. - -```yaml -Type: System.String -Parameter Sets: (Assignment) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReverseNumberLookup -This parameter is used to control the behavior of reverse number lookup (RNL) for a phone number.When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. - -```yaml -Type: String -Parameter Sets: (ReverseNumberLookupUpdate, Assignment) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -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 PowerShell module 3.0.0 or later. The parameter set LocationUpdate was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The parameter set NetworkSiteUpdate was introduced in Teams PowerShell module 5.5.1-preview. - -The cmdlet is only available in commercial and GCC cloud instances. - -If a user or resource account has a phone number set in Active Directory on-premises and synched into Microsoft 365, you can't use Set-CsPhoneNumberAssignment to set the phone number. You will have to clear the phone number from the on-premises Active Directory and let that change sync into Microsoft 365 first. - -The previous command for assigning phone numbers to users Set-CsUser had the parameter HostedVoiceMail. Setting HostedVoiceMail for Microsoft Teams users is no longer -necessary and that is why the parameter is not available on Set-CsPhoneNumberAssignment. - -## RELATED LINKS -[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) - -[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment +schema: 2.0.0 +title: Set-CsPhoneNumberAssignment +--- + +# Set-CsPhoneNumberAssignment + +## SYNOPSIS +This cmdlet will assign a phone number to a user or a resource account (online application instance). + +## SYNTAX + +### LocationUpdate (Default) +``` +Set-CsPhoneNumberAssignment -PhoneNumber -LocationId [-HttpPipelinePrepend ] + [] +``` + +### NetworkSiteUpdate +``` +Set-CsPhoneNumberAssignment -PhoneNumber [-HttpPipelinePrepend ] + -NetworkSiteId [] +``` + +### ReverseNumberLookupUpdate +``` +Set-CsPhoneNumberAssignment -PhoneNumber [-HttpPipelinePrepend ] + -ReverseNumberLookup [] +``` + +### Assignment +``` +Set-CsPhoneNumberAssignment -PhoneNumber [-LocationId ] + [-HttpPipelinePrepend ] -Identity -PhoneNumberType + [-NetworkSiteId ] [-AssignmentCategory ] [-ReverseNumberLookup ] [-Notify] [] +``` + +### Attribute +``` +Set-CsPhoneNumberAssignment [-HttpPipelinePrepend ] -Identity + -EnterpriseVoiceEnabled [] +``` + +## DESCRIPTION +This cmdlet assigns a telephone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. + +You can also assign a location to a phone number. + +To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan +``` +This example assigns the Microsoft Calling Plan phone number +1 (206) 555-1234 to the user user1@contoso.com. + +### Example 2 +```powershell +$loc=Get-CsOnlineLisLocation -City Vancouver +Set-CsPhoneNumberAssignment -Identity user2@contoso.com -PhoneNumber +12065551224 -PhoneNumberType CallingPlan -LocationId $loc.LocationId +``` +This example finds the emergency location defined for the corporate location Vancouver and assigns the Microsoft Calling Plan phone number +1 (206) 555-1224 and location to the user user2@contoso.com. + +### Example 3 +```powershell +Set-CsPhoneNumberAssignment -Identity user3@contoso.com -EnterpriseVoiceEnabled $true +``` +This example sets the EnterpriseVoiceEnabled flag on the user user3@contoso.com. + +### Example 4 +```powershell +Set-CsPhoneNumberAssignment -Identity user3@contoso.com -LocationId 'null' -PhoneNumber +12065551226 -PhoneNumberType OperatorConnect +``` +This example removes the emergency location from the phone number for user user3@contoso.com. + +### Example 5 +```powershell +Set-CsPhoneNumberAssignment -Identity cq1@contoso.com -PhoneNumber +14255551225 -PhoneNumberType DirectRouting +``` +This example assigns the Direct Routing phone number +1 (425) 555-1225 to the resource account cq1@contoso.com. + +### Example 6 +```powershell +Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting +``` +This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 to the user user4@contoso.com. + +### Example 7 +```powershell +Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occurred } +``` +This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. + +### Example 8 +```powershell +$TempUser = "tempuser@contoso.com" +$OldLoc=Get-CsOnlineLisLocation -City Vancouver +$NewLoc=Get-CsOnlineLisLocation -City Seattle +$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment +foreach ($No in $Numbers) { + Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId + Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber +} +``` +This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers, assigning each phone number temporarily with the new location to a user, and then unassigning the phone number again from the user. + +### Example 9 +```powershell +$loc=Get-CsOnlineLisLocation -City Toronto +Set-CsPhoneNumberAssignment -PhoneNumber +12065551224 -LocationId $loc.LocationId +``` +This example shows how to set the location on a phone number. + +### Example 10 +```powershell +$OldLocationId = "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" +$NewLocationId = "951fac72-955e-4734-ab74-cc4c0f761c0b" +# Get all phone numbers in old location +$pns = Get-CsPhoneNumberAssignment -LocationId $OldLocationId +Write-Host $pns.count numbers found in old location $OldLocationId +# Move all those phone numbers to the new location +foreach ($pn in $pns) { + Try { + Set-CsPhoneNumberAssignment -PhoneNumber $pn.TelephoneNumber -LocationId $NewLocationId -ErrorAction Stop + Write-Host $pn.TelephoneNumber was updated to have location $NewLocationId + } + Catch { + Write-Host Could not update $pn.TelephoneNumber with location $NewLocationId + } +} +Write-Host (Get-CsPhoneNumberAssignment -LocationId $OldLocationId).Count numbers found in old location $OldLocationId +Write-Host (Get-CsPhoneNumberAssignment -LocationId $NewLocationId).Count numbers found in new location $NewLocationId +``` +This Example shows how to update the LocationID from an old location to a new location for a set of phone numbers. + +### Example 11 +```powershell +Set-CsPhoneNumberAssignment -Identity user3@contoso.com -PhoneNumber +12065551226 -ReverseNumberLookup 'SkipInternalVoip' +``` +This example shows how to turn off reverse number lookup (RNL) on a phone number. When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. This example is only applicable for Direct Routing phone numbers. + +### Example 12 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -AssignmentCategory Private +``` +This example shows how to assign a private phone number (incoming calls only) to a user. + +### Example 13 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -LocationId "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" -Notify +``` +This example shows how to send an email to Teams phone users informing them about the new telephone number assignment. Note: For assignment of India telephone numbers provided by Airtel, Teams Phone users will automatically receive an email outlining the usage guidelines and restrictions. This notification is mandatory and cannot be opted out of. + +## PARAMETERS + +### -AssignmentCategory + +> Applicable: Microsoft Teams + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseVoiceEnabled + +> Applicable: Microsoft Teams + +Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. + +This parameter is mutual exclusive with PhoneNumber. + +```yaml +Type: System.Boolean +Parameter Sets: Attribute +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or +resource account. + +```yaml +Type: System.String +Parameter Sets: Assignment, Attribute +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationId +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. +If you want to remove the location, use the string value null for LocationId. + +```yaml +Type: System.String +Parameter Sets: LocationUpdate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteId + +> Applicable: Microsoft Teams + +ID of a network site. A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. + +```yaml +Type: System.String +Parameter Sets: Assignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.String +Parameter Sets: NetworkSiteUpdate, 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: System.Management.Automation.SwitchParameter +Parameter Sets: Assignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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'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. + +Setting a phone number will automatically set EnterpriseVoiceEnabled to True. + +```yaml +Type: System.String +Parameter Sets: LocationUpdate, NetworkSiteUpdate, ReverseNumberLookupUpdate, Assignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumberType +The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. + +```yaml +Type: System.String +Parameter Sets: Assignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseNumberLookup +This parameter is used to control the behavior of reverse number lookup (RNL) for a phone number.When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. + +```yaml +Type: System.String +Parameter Sets: ReverseNumberLookupUpdate +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 +The cmdlet is available in Teams PowerShell module 3.0.0 or later. The parameter set LocationUpdate was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The parameter set NetworkSiteUpdate was introduced in Teams PowerShell module 5.5.1-preview. + +The cmdlet is only available in commercial and GCC cloud instances. + +If a user or resource account has a phone number set in Active Directory on-premises and synched into Microsoft 365, you can't use Set-CsPhoneNumberAssignment to set the phone number. You will have to clear the phone number from the on-premises Active Directory and let that change sync into Microsoft 365 first. + +The previous command for assigning phone numbers to users Set-CsUser had the parameter HostedVoiceMail. Setting HostedVoiceMail for Microsoft Teams users is no longer +necessary and that is why the parameter is not available on Set-CsPhoneNumberAssignment. + +## RELATED LINKS +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) + +[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumberassignment) diff --git a/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberTag.md new file mode 100644 index 0000000000..26ec20868d --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberTag.md @@ -0,0 +1,83 @@ +--- +applicable: Microsoft Teams +author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +ms.reviewer: pavellatif +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumbertag +schema: 2.0.0 +title: Set-CsPhoneNumberTag +--- + +# 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/microsoftteams/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/microsoftteams/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/MicrosoftTeams/Set-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/Set-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..55bb1a52b0 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Set-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,92 @@ +--- +applicable: Microsoft Teams +author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: tomkau +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: Set-CsSharedCallQueueHistoryTemplate +--- + +# Set-CsSharedCallQueueHistoryTemplate + +## SYNOPSIS +Use the Set-CsSharedCallQueueHistoryTemplate cmdlet to change a Shared Call Queue History template + +## SYNTAX + +``` +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 + +> Applicable: Microsoft Teams + +The instance of the shared call queue history template to change. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### 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/MicrosoftTeams/Set-CsTeamsAIPolicy.md similarity index 64% rename from teams/teams-ps/teams/Set-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAIPolicy.md index f72a598f5b..caa9cad7f9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: andywang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsTeamsAIPolicy +schema: 2.0.0 +title: Set-CsTeamsAIPolicy --- # Set-CsTeamsAIPolicy @@ -17,19 +18,20 @@ This cmdlet sets Teams AI policy value for users in the tenant. ## SYNTAX -``` +```powershell Set-CsTeamsAIPolicy [[-Identity] ] - [-EnrollFace ] - [-EnrollVoice ] + [-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. 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. +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 Teams AI policy EnrollFace and EnrollVoice value for the tenant. The values of EnrollFace and EnrollVoice can be set to "Enabled" or "Disabled". +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 @@ -49,43 +51,64 @@ 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 4 +### Example 5 ```powershell PS C:\> Set-CsTeamsAIPolicy -Identity Test -EnrollVoice Enabled ``` Set Teams AI policy "EnrollVoice" value to "Enabled" for identity "Test". -### Example 5 +### 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 6 +### Example 8 ```powershell PS C:\> Set-CsTeamsAIPolicy -Identity Test -EnrollVoice Disabled ``` Set Teams AI policy "EnrollVoice" value to "Disabled" for identity "Test". -## PARAMETERS +### Example 9 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -SpeakerAttributionBYOD Disabled +``` -### -Identity -Identity of the Teams AI policy. +Set Teams AI policy "SpeakerAttributionBYOD" value to "Disabled" for identity "Test". +## PARAMETERS + +### -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: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -96,7 +119,7 @@ Accept wildcard characters: False Policy value of the Teams AI EnrollFace policy. EnrollFace controls user access to user face enrollment in the Teams app settings. ```yaml -Type: Boolean +Type: String Parameter Sets: ("Enabled","Disabled") Aliases: @@ -111,7 +134,7 @@ Accept wildcard characters: False Policy value of the Teams AI EnrollVoice policy. EnrollVoice controls user access to user voice enrollment in the Teams app settings. ```yaml -Type: Boolean +Type: String Parameter Sets: ("Enabled","Disabled") Aliases: @@ -122,21 +145,36 @@ 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. +### -Identity +Identity of the Teams AI policy. + ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None 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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -148,10 +186,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaipolicy) -[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaipolicy) -[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAcsFederationConfiguration.md similarity index 62% rename from teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAcsFederationConfiguration.md index a45d8ff72a..b311a9c415 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAcsFederationConfiguration.md @@ -1,19 +1,18 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsAcsFederationConfiguration -author: tomkau ms.author: tomkau -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration schema: 2.0.0 +title: Set-CsTeamsAcsFederationConfiguration --- # Set-CsTeamsAcsFederationConfiguration ## 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](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). ## SYNTAX @@ -22,7 +21,12 @@ This cmdlet is used to manage the federation configuration between Teams and Azu Set-CsTeamsAcsFederationConfiguration [-Identity ] [-EnableAcsUsers ] + [-AllowAllAcsResources ] [-AllowedAcsResources ] + [-BlockedAcsResources ] + [-RequireAcsFederationForMeeting ] + [-LabelForAllowedAcsUsers ] + [-HideBannerForAllowedAcsUsers ] [-WhatIf] [-Confirm] [] @@ -55,9 +59,9 @@ Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowedAcsResources ## PARAMETERS -### -EnableAcsUsers +### -AllowAllAcsResources -Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. +DEPRECATED. Do not use. ```yaml Type: Boolean @@ -81,6 +85,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BlockedAcsResources + +List of blocked Azure Communication Services resources. + +The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. + +```yaml +Type: String[] +Position: Named +Default value: Empty/Null +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAcsUsers + +Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. + +```yaml +Type: Boolean +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideBannerForAllowedAcsUsers + +This configuration controls the display of the 'limited call features' banner for Azure Communication Services users participating in Teams meetings or calls. Possible values are: True, False. Set to True to hide the banner for allowed ACS users in Teams meetings or calls. + +```yaml +Type: Boolean +Position: Named +Default value: False +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: @@ -97,6 +139,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LabelForAllowedAcsUsers + +This configuration controls the user label that is displayed for Azure Communication Services users when they join Teams meetings or calls. Possible values are: Unverified, External. When the value is set to Unverified, the ACS user label is displayed as 'Unverified' when an ACS user joins Teams meetings or calls. When the value is set to External, if an ACS user joins a Teams meeting or call from a resource listed in AllowAllAcsResources, their label should be displayed as 'External'. + +```yaml +Type: String +Position: Named +Default value: Unverified +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireAcsFederationForMeeting + +This configuration controls whether ACS Federation is required for meetings. Possibles values are: True, False. + +```yaml +Type: Boolean +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). @@ -108,10 +174,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration) +[Get-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsacsfederationconfiguration) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy.md index 58ff1553f7..f7f47218fc 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy.md @@ -1,21 +1,21 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: prkosh +Module Name: MicrosoftTeams ms.author: serdars +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsapppermissionpolicy +schema: 2.0.0 +title: Set-CsTeamsAppPermissionPolicy --- # 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 . +Cmdlet to set the app permission policy for Teams. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppSetupPolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppSetupPolicy.md index 1e6e8b5c3a..2ff01ce2cd 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppSetupPolicy.md @@ -1,24 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsappsetuppolicy applicable: Microsoft Teams -title: Set-CsTeamsAppSetupPolicy +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsappsetuppolicy schema: 2.0.0 +title: Set-CsTeamsAppSetupPolicy --- # Set-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Cmdlet to set the app setup policy for Teams. ## SYNTAX ### Identity (Default) -```powershell +``` Set-CsTeamsAppSetupPolicy [[-Identity] ] [-AllowSideLoading ] [-AllowUserPinning ] @@ -37,7 +35,7 @@ Set-CsTeamsAppSetupPolicy [[-Identity] ] ``` ### Instance -```powershell +``` Set-CsTeamsAppSetupPolicy [-Instance ] [-AllowSideLoading ] [-AllowUserPinning ] @@ -118,33 +116,18 @@ Step 3: Settings to install these apps in your users' personal Teams environment ## PARAMETERS -### -Identity -Name of app setup policy. If empty, all identities will be used by default. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Do not use. +### -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: PSObject -Parameter Sets: Instance +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: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -193,21 +176,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdditionalCustomizationApps -This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. - -```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AppPresetMeetingList This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. @@ -268,6 +236,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Name of app setup policy. If empty, all identities will be used by default. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Do not use. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -PinnedAppBarApps Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that users need the most and promote ease of access. diff --git a/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy.md index aee67a3709..f14ae209f8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy -title: Set-CsTeamsAudioConferencingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy schema: 2.0.0 +title: Set-CsTeamsAudioConferencingPolicy --- # Set-CsTeamsAudioConferencingPolicy @@ -62,6 +63,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. @@ -123,21 +139,6 @@ Accept 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. @@ -167,8 +168,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy) -[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallHoldPolicy.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallHoldPolicy.md index 27aaba2f36..c801cf5fce 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -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: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallholdpolicy +schema: 2.0.0 +title: Set-CsTeamsCallHoldPolicy --- # Set-CsTeamsCallHoldPolicy @@ -54,16 +55,31 @@ This policy is re-assigned the description from its existing value to "country m ## PARAMETERS -### -Identity -Unique identifier of the Teams call hold policy being modified. +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +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 @@ -86,11 +102,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFileId -A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -101,16 +117,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreamingSourceUrl -This parameter is reserved for internal Microsoft use. +### -Identity +Unique identifier of the Teams call hold policy being modified. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -131,11 +147,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -162,21 +178,6 @@ Accept 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). @@ -192,12 +193,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallholdpolicy) -[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy) -[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallholdpolicy) -[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallholdpolicy) -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallParkPolicy.md similarity index 86% rename from teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallParkPolicy.md index 14c75e129a..2046a276bb 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallParkPolicy.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallparkpolicy +schema: 2.0.0 +title: Set-CsTeamsCallParkPolicy --- # Set-CsTeamsCallParkPolicy ## SYNOPSIS - -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 is currently available in desktop, mobile, and web clients. Supported with TeamsOnly mode. +The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. ## SYNTAX @@ -39,7 +38,12 @@ Set-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [-I ``` ## 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 Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. +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. + +NOTE: The call park feature is currently available in desktop, mobile, and web clients. Supported with TeamsOnly mode. ## EXAMPLES @@ -96,6 +100,21 @@ 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 +``` + ### -Force Suppress all non-fatal errors @@ -141,19 +160,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -PickupRangeEnd -Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. - -Note: PickupRangeStart must be smaller than PickupRangeEnd. +### -MsftInternalProcessingMode +For Internal use only. ```yaml -Type: Integer +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 99 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -173,8 +190,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PickupRangeStart -Specify the minimum value that a rendered pickup code can take. Value can be from 10 to 9999. +### -PickupRangeEnd +Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. Note: PickupRangeStart must be smaller than PickupRangeEnd. @@ -185,47 +202,33 @@ Aliases: Required: False Position: Named -Default value: 10 +Default value: 99 Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -PickupRangeStart +Specify the minimum value that a rendered pickup code can take. Value can be from 10 to 9999. -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Note: PickupRangeStart must be smaller than PickupRangeEnd. ```yaml -Type: SwitchParameter +Type: Integer Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named -Default value: None +Default value: 10 Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the policy. +### -Tenant +Internal Microsoft use only. ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: @@ -236,13 +239,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsftInternalProcessingMode -For Internal use only. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallingPolicy.md similarity index 87% rename from teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallingPolicy.md index 4c4ecadcb6..073df110ea 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallingPolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy applicable: Microsoft Teams -title: Set-CsTeamsCallingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +ms.reviewer: alejandramu +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallingpolicy +schema: 2.0.0 +title: Set-CsTeamsCallingPolicy --- # Set-CsTeamsCallingPolicy @@ -51,6 +52,8 @@ Set-CsTeamsCallingPolicy [-Identity] [-PreventTollBypass ] [-SpamFilteringEnabledType ] [-VoiceSimulationInInterpreter ] + [-RealTimeText ] + [-ExplicitRecordingConsent ] [-WhatIf] [] ``` @@ -79,22 +82,10 @@ 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: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -109,7 +100,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +109,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToPhone + +> Applicable: Microsoft Teams + 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 @@ -135,13 +127,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToUser + +> Applicable: Microsoft Teams + 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 @@ -151,13 +145,15 @@ Accept wildcard characters: False ``` ### -AllowCallGroups + +> Applicable: Microsoft Teams + 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 @@ -167,6 +163,9 @@ Accept wildcard characters: False ``` ### -AllowCallRedirect + +> Applicable: Microsoft Teams + Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway. Valid options are: @@ -179,7 +178,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -189,13 +187,15 @@ Accept wildcard characters: False ``` ### -AllowCloudRecordingForCalls + +> Applicable: Microsoft Teams + 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 @@ -205,13 +205,15 @@ Accept wildcard characters: False ``` ### -AllowDelegation + +> Applicable: Microsoft Teams + 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 @@ -221,6 +223,9 @@ Accept wildcard characters: False ``` ### -AllowPrivateCalling + +> Applicable: Microsoft Teams + 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. @@ -228,7 +233,6 @@ If you use Skype for Business for calling, this policy will not affect calling f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -238,13 +242,15 @@ Accept wildcard characters: False ``` ### -AllowSIPDevicesCalling + +> Applicable: Microsoft Teams + 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 @@ -254,13 +260,15 @@ Accept wildcard characters: False ``` ### -AllowTranscriptionForCalling + +> Applicable: Microsoft Teams + 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 @@ -270,6 +278,9 @@ Accept wildcard characters: False ``` ### -AllowVoicemail + +> Applicable: Microsoft Teams + Enables inbound calls to be routed to voicemail. Valid options are: @@ -282,7 +293,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -292,13 +302,15 @@ Accept wildcard characters: False ``` ### -AllowWebPSTNCalling + +> Applicable: Microsoft Teams + Allows PSTN calling from the Teams web client. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -324,6 +336,9 @@ Accept wildcard characters: False ``` ### -BusyOnBusyEnabledType + +> Applicable: Microsoft Teams + 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: @@ -337,7 +352,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -347,6 +361,9 @@ Accept wildcard characters: False ``` ### -CallingSpendUserLimit + +> Applicable: Microsoft Teams + 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 @@ -355,7 +372,6 @@ Possible values: any positive integer Type: Long Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -365,13 +381,15 @@ Accept wildcard characters: False ``` ### -CallRecordingExpirationDays + +> Applicable: Microsoft Teams + 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 @@ -381,13 +399,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -397,18 +417,20 @@ Accept wildcard characters: False ``` ### -Copilot + +> Applicable: Microsoft Teams + 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. -- EnabledWithTranscript: Copilot will only work when transcription is enabled during calls. This is the default value. +- 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 @@ -418,13 +440,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + 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 @@ -434,6 +458,9 @@ Accept wildcard characters: False ``` ### -EnableSpendLimits + +> Applicable: Microsoft Teams + This setting allows an admin to enable or disable spend limits on PSTN calls for their user base. Possible values: @@ -445,7 +472,6 @@ Possible values: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -471,13 +497,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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 @@ -486,7 +514,25 @@ 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 + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound federated calls should be routed. Valid options are: @@ -501,7 +547,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -511,6 +556,9 @@ Accept wildcard characters: False ``` ### -InboundPstnCallRoutingTreatment + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound PSTN calls should be routed. Valid options are: @@ -526,7 +574,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -536,6 +583,9 @@ Accept wildcard characters: False ``` ### -LiveCaptionsEnabledTypeForCalling + +> Applicable: Microsoft Teams + Determines whether real-time captions are available for the user in Teams calls. Valid options are: @@ -547,7 +597,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -557,6 +606,9 @@ Accept wildcard characters: False ``` ### -MusicOnHoldEnabledType + +> Applicable: Microsoft Teams + 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: @@ -569,7 +621,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -579,13 +630,15 @@ Accept wildcard characters: False ``` ### -PopoutAppPathForIncomingPstnCalls + +> Applicable: Microsoft Teams + 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: "" @@ -594,13 +647,15 @@ Accept wildcard characters: False ``` ### -PopoutForIncomingPstnCalls + +> Applicable: Microsoft Teams + 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 @@ -609,6 +664,9 @@ Accept wildcard characters: False ``` ### -PreventTollBypass + +> Applicable: Microsoft Teams + Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. > [!NOTE] @@ -618,7 +676,6 @@ Setting this parameter to True will send calls through PSTN and incur charges ra Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -627,7 +684,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RealTimeText + +> Applicable: Microsoft Teams + +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: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SpamFilteringEnabledType + +> Applicable: Microsoft Teams + Determines if spam detection is enabled for inbound PSTN calls. Possible values: @@ -639,7 +721,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -650,6 +731,8 @@ Accept wildcard characters: False ### -VoiceSimulationInInterpreter +> Applicable: Microsoft Teams + > [!NOTE] > This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -664,7 +747,27 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExplicitRecordingConsent + +This setting controls whether users must provide or obtain explicit consent before recording a 1:1 PSTN or Teams call. When enabled, both parties will receive a notification, and consent must be given before recording starts. + +Possible values: + +- **Enabled**: Requires users to give and obtain explicit consent before starting a call recording. +- **Disabled**: Users are not required to obtain explicit consent before recording starts. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -674,6 +777,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -681,7 +787,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -705,10 +810,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallingpolicy) -[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallingpolicy) -[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallingpolicy) -[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsChannelsPolicy.md similarity index 88% rename from teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsChannelsPolicy.md index bdd2663355..a6f1d5b995 100644 --- a/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsChannelsPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamschannelspolicy +schema: 2.0.0 +title: Set-CsTeamsChannelsPolicy --- # Set-CsTeamsChannelsPolicy @@ -22,7 +24,7 @@ The CsTeamsChannelsPolicy allows you to manage features related to the Teams and ``` Set-CsTeamsChannelsPolicy [-Tenant ] [-AllowOrgWideTeamCreation ] [-EnablePrivateTeamDiscovery ] [-AllowPrivateChannelCreation ] - [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] + [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] [-ThreadedChannelCreation ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -50,14 +52,13 @@ This example shows updating an existing policy with name "StudentPolicy" and ena ## PARAMETERS -### -EnablePrivateTeamDiscovery -Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. +### -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](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -65,13 +66,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowOrgWideTeamCreation +Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -80,11 +81,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Bypass all non-fatal errors. +### -AllowPrivateChannelCreation +Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -95,41 +96,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Use this parameter to specify the name of the policy being updated. +### -AllowSharedChannelCreation +Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. ```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 ``` -### -Instance -Use this parameter to pass the policy object output of Get-CsTeamsChannelsPolicy to update that policy. +### -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](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml -Type: PSObject -Parameter Sets: Instance +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: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -EnablePrivateTeamDiscovery +Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml -Type: System.Guid +Type: Boolean Parameter Sets: (All) Aliases: @@ -140,13 +154,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Force +Bypass all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -155,43 +169,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOrgWideTeamCreation -Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. +### -Identity +Use this parameter to specify the name of the policy being updated. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateChannelCreation -Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. +### -Instance +Use this parameter to pass the policy object output of Get-CsTeamsChannelsPolicy to update that policy. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) 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](https://learn.microsoft.com/microsoftteams/teams-policies). +### -Tenant +Internal Microsoft use only. ```yaml -Type: Boolean +Type: System.Guid Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -199,27 +214,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedChannelCreation -Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: + Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False 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](https://learn.microsoft.com/microsoftteams/teams-policies). +### -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: Named Default value: None @@ -242,10 +263,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamschannelspolicy) +[New-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamschannelspolicy) -[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy) +[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamschannelspolicy) -[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy) +[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamschannelspolicy) -[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy) +[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamschannelspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsClientConfiguration.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsClientConfiguration.md index d2685ba41e..f228bf78c8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsClientConfiguration.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsclientconfiguration +schema: 2.0.0 +title: Set-CsTeamsClientConfiguration --- # 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. +Changes the Teams client configuration settings for the specified tenant. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication.md index 1e7e7f36f9..4f9489228b 100644 --- a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication +schema: 2.0.0 +title: Set-CsTeamsComplianceRecordingApplication --- # Set-CsTeamsComplianceRecordingApplication @@ -115,105 +116,158 @@ Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredD ## PARAMETERS -### -Identity -A name that uniquely identifies the application instance of the policy-based recording application. +### -ComplianceRecordingPairedApplications +Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired 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. +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: XdsIdentity -Parameter Sets: Identity +Type: ComplianceRecordingPairedApplication[] +Parameter Sets: (All) Aliases: Required: False -Position: 1 +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. +### -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: PSObject -Parameter Sets: Instance +Type: UInt32 +Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: True (ByValue) +Default value: 1 +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. +### -Confirm +Prompts you for confirmation before running the cmdlet. -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. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -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. +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: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None 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. +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. -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. +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: Boolean -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named -Default value: True +Position: 1 +Default value: None 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. +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: -If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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: Boolean +Type: Int32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None 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. +### -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 leaves the call or is dropped from the call. +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 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 fails to join the call. ```yaml Type: Boolean @@ -227,84 +281,61 @@ 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. +### -RequiredBeforeMeetingJoin +Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. -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. +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. -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. +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: UInt32 +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 1 +Default value: True 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. +### -RequiredDuringCall +Indicates whether the policy-based recording application must be in the call while the call is active. -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. +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. -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. +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: ComplianceRecordingPairedApplication[] +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True 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. +### -RequiredDuringMeeting +Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. -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. +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: Int32 +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` @@ -335,36 +366,6 @@ Accept 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. @@ -396,20 +397,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy.md index 482a4c801b..51b820b33a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: Set-CsTeamsComplianceRecordingPolicy --- # Set-CsTeamsComplianceRecordingPolicy @@ -96,43 +97,44 @@ This effectively stops automatic policy-based recording for all new calls and me ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new Teams recording policy. +### -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. -Use the "Global" Identity if you wish to assign this policy to the entire tenant. +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: XdsIdentity -Parameter Sets: Identity +Type: ComplianceRecordingApplication[] +Parameter Sets: (All) Aliases: Required: False -Position: 1 +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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### CustomBanner -References the Custom Banner text in the storage. +### -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: Guid +Type: String Parameter Sets: (All) Aliases: @@ -143,12 +145,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Controls whether this Teams recording policy is active or not. +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording -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. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: -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. +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 @@ -162,8 +175,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WarnUserOnRemoval -This parameter is reserved for future use. +### -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 @@ -172,16 +189,16 @@ Aliases: Required: False Position: Named -Default value: True +Default value: False 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. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -192,50 +209,49 @@ 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. +### -Identity +Unique identifier to be assigned to the new 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. +Use the "Global" Identity if you wish to assign this policy to the entire tenant. ```yaml -Type: ComplianceRecordingApplication[] -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 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 + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -DisableComplianceRecordingAudioNotificationForCalls -Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. +### CustomBanner +References the Custom Banner text in the storage. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -281,32 +297,17 @@ Accept 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. +### -WarnUserOnRemoval +This parameter is reserved for future use. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` @@ -342,20 +343,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCortanaPolicy.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCortanaPolicy.md index 15607b6980..d9e9f930b4 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscortanapolicy +schema: 2.0.0 +title: Set-CsTeamsCortanaPolicy --- # Set-CsTeamsCortanaPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCustomBannerText.md similarity index 79% rename from teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCustomBannerText.md index 131dd52c2a..5aca9146d6 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCustomBannerText.md @@ -1,10 +1,11 @@ --- -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText -title: Set-CsTeamsCustomBannerText -schema: 2.0.0 author: saleens7 +Locale: en-US +Module Name: MicrosoftTeams ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsTeamsCustomBannerText +schema: 2.0.0 +title: Set-CsTeamsCustomBannerText --- # Set-CsTeamsCustomBannerText @@ -27,6 +28,8 @@ Updates a single instance of custom banner text. ## EXAMPLES ### Example 1 + +``` PS C:\> Set-CsTeamsCustomBannerText -Id 123e4567-e89b-12d3-a456-426614174000 -Description "Custom Banner Text Example" -Text "Custom Text" ``` @@ -34,43 +37,55 @@ This example sets the properties of the CustomText instance of TeamsCustomBanner ## PARAMETERS -### -Id -The Identity of the CustomBannerText. +### -Description +The description that you would like to set to identify what this text represents. ```yaml -Type: Guid -Parameter Sets: Identity +Type: System.String +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Text -The text that you would like to set in the policy. +### -Id + +> Applicable: Microsoft Teams + +The Identity of the CustomBannerText. ```yaml -Type: String +Type: System.Guid +Parameter Sets: Identity +Aliases: + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -The description that you would like to set to identify what this text represents. +### -Text +The text that you would like to set in the policy. ```yaml -Type: String +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -86,8 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy.md index 3306c4828f..0c5878ad60 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -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 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamseducationassignmentsapppolicy +schema: 2.0.0 +title: Set-CsTeamsEducationAssignmentsAppPolicy --- # Set-CsTeamsEducationAssignmentsAppPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationConfiguration.md similarity index 66% rename from teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationConfiguration.md index 2574fce8c8..812ee9c67d 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationConfiguration.md @@ -1,14 +1,15 @@ --- +author: SaritaBehera external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsEducationConfiguration -author: SaritaBehera ms.author: saritabehera -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamseducationconfiguration schema: 2.0.0 +title: Set-CsTeamsEducationConfiguration --- -# Set-CsTeamsEdcuationConfiguration +# Set-CsTeamsEducationConfiguration ## SYNOPSIS @@ -17,12 +18,9 @@ This cmdlet is used to manage the organization-wide education configuration for ## SYNTAX ```powershell -Set-CsTeamsEducationConfiguration - [-ParentGuardianPreferredContactMethod ] - [-UpdateParentInformation ] - [-WhatIf] - [-Confirm] - [] +Set-CsTeamsEducationConfiguration [-ParentGuardianPreferredContactMethod ] + [-UpdateParentInformation ] [-EduGenerativeAIEnhancements ] [-Identity ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -67,7 +65,11 @@ Set-CsTeamsEducationConfiguration -UpdateParentInformation Disabled Indicates whether Email or SMS is the preferred contact method used for parent communication invitations. Possible values are 'Email' and 'SMS'. ```yaml -Type: String +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False Position: Named Default value: Email Accept pipeline input: False @@ -78,13 +80,50 @@ Accept wildcard characters: False Indicates whether updating parents contact information is Enabled/Disabled by educators. Possible values are 'Enabled' and 'Disabled'. ```yaml -Type: String +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False Position: Named Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` +### -EduGenerativeAIEnhancements + +Controls whether generative AI enhancements are enabled in the education environment. + +Possible values: + +- `Enabled`: Generative AI features are available to educators and students. +- `Disabled`: Generative AI features are disabled across the tenant. + +```yaml +Type: System.String +Parameter Sets: (All) +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the education configuration to set. + +```yaml +Type: System.String +Parameter Sets: (All) +Required: False +Position: Named +Default value: Global +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -96,4 +135,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamseducationconfiguration) +[Get-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamseducationconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy.md similarity index 88% rename from teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy.md index f17f6774c5..8e69edbb30 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Set-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Set-CsTeamsEmergencyCallRoutingPolicy --- # Set-CsTeamsEmergencyCallRoutingPolicy @@ -68,6 +70,21 @@ Accept 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 Provides a description of the Teams Emergency Call Routing policy to identify the purpose of setting it. @@ -84,7 +101,7 @@ Accept wildcard characters: False ``` ### -EmergencyNumbers -One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) cmdlet. +One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencynumber) cmdlet. ```yaml Type: Object @@ -128,21 +145,6 @@ Accept 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). @@ -154,12 +156,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy) -[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy) -[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) +[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencynumber) diff --git a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy.md index b67d6b3cd5..caaff67ff0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Set-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy schema: 2.0.0 +title: Set-CsTeamsEmergencyCallingPolicy --- # Set-CsTeamsEmergencyCallingPolicy @@ -55,6 +57,21 @@ This example first creates two new Teams Emergency Calling Extended Notification ## 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 Provides a description of the Teams Emergency Calling policy to identify the purpose of setting it. @@ -196,21 +213,6 @@ Accept 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). @@ -222,12 +224,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy) -[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy) -[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy) -[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification) +[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingextendednotification) diff --git a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEnhancedEncryptionPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEnhancedEncryptionPolicy.md index 33b326f662..2387c68a97 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEnhancedEncryptionPolicy.md @@ -1,209 +1,210 @@ ---- -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: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Set-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Use this cmdlet to update values in existing Teams enhanced encryption policy. - -## SYNTAX - -``` -Set-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] - [[-Identity] ] [-Force] [-Instance ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Use this cmdlet to update values in existing Teams enhanced encryption policy. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -``` - -The command shown in Example 1 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - -This policy is re-assigned CallingEndtoEndEncryptionEnabledType to be DisabledUserOverride. - -Any Microsoft Teams users who are assigned this policy will have their enhanced encryption policy customized such that the user can use the enhanced encryption setting in Teams. - -### EXAMPLE 2 -```PowerShell -PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -MeetingEndToEndEncryption DisabledUserOverride -``` - -The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - -This policy has re-assigned MeetingEndToEndEncryption to be DisabledUserOverride. - -Any Microsoft Teams users who are assigned this policy and have a Teams Premium license will have the option to create end-to-end encrypted meetings. [Learn more about end-to-end encryption for Teams meetings](https://support.microsoft.com/en-us/office/use-end-to-end-encryption-for-teams-meetings-a8326d15-d187-49c4-ac99-14c17dbd617c). - -### EXAMPLE 3 -```PowerShell -PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" -``` - -The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - -This policy is re-assigned the description from its existing value to "allow useroverride". - -## PARAMETERS - -### -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 -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallingEndtoEndEncryptionEnabledType -Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingEndToEndEncryption -Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -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 -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Use this to pipe a specific enhanced encryption policy to be set. You can only modify the global policy, so can only pass the global instance of the enhanced encryption policy. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the 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.Object -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Set-CsTeamsEnhancedEncryptionPolicy +--- + +# Set-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Use this cmdlet to update values in existing Teams enhanced encryption policy. + +## SYNTAX + +``` +Set-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] + [[-Identity] ] [-Force] [-Instance ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Use this cmdlet to update values in existing Teams enhanced encryption policy. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -CallingEndtoEndEncryptionEnabledType DisabledUserOverride +``` + +The command shown in Example 1 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + +This policy is re-assigned CallingEndtoEndEncryptionEnabledType to be DisabledUserOverride. + +Any Microsoft Teams users who are assigned this policy will have their enhanced encryption policy customized such that the user can use the enhanced encryption setting in Teams. + +### EXAMPLE 2 +```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -MeetingEndToEndEncryption DisabledUserOverride +``` + +The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + +This policy has re-assigned MeetingEndToEndEncryption to be DisabledUserOverride. + +Any Microsoft Teams users who are assigned this policy and have a Teams Premium license will have the option to create end-to-end encrypted meetings. [Learn more about end-to-end encryption for Teams meetings](https://support.microsoft.com/en-us/office/use-end-to-end-encryption-for-teams-meetings-a8326d15-d187-49c4-ac99-14c17dbd617c). + +### EXAMPLE 3 +```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" +``` + +The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + +This policy is re-assigned the description from its existing value to "allow useroverride". + +## PARAMETERS + +### -CallingEndtoEndEncryptionEnabledType +Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. + +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +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 +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Use this to pipe a specific enhanced encryption policy to be set. You can only modify the global policy, so can only pass the global instance of the enhanced encryption policy. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MeetingEndToEndEncryption +Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy) + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEventsPolicy.md similarity index 77% rename from teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEventsPolicy.md index d6e5e66d0d..ec716bcce9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEventsPolicy.md @@ -1,435 +1,508 @@ ---- -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: 11/12/2024 ---- - -# Set-CsTeamsEventsPolicy - -## SYNOPSIS -This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. - -## SYNTAX - -``` -Set-CsTeamsEventsPolicy [-AllowWebinars ] [-EventAccessType ] [-AllowTownhalls ] - [-AllowEmailEditing ] [-AllowedQuestionTypesInRegistrationForm ] - [-AllowEventIntegrations ] [-AllowedWebinarTypesForRecordingPublish ] - [-AllowedTownhallTypesForRecordingPublish ] [-TownhallChatExperience ] [-Description ] - [-RecordingForTownhall ] [-RecordingForWebinar ] - [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] - [-UseMicrosoftECDN ] - [-Identity] [-Force] [-WhatIf] [-Confirm] [] - [-ImmersiveEvents ] -``` - -## DESCRIPTION -User-level policy for tenant admin to configure options for customizing Teams events experiences. Use this cmdlet to update an existing policy. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled -``` - -The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. - -## PARAMETERS - -### -AllowWebinars -This setting governs if a user can create webinars using Teams Events. -Possible values are: - - **Enabled**: Enables creating webinars. - - **Disabled**: Disables creating webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseMicrosoftECDN -This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTownhalls -This setting governs if a user can create town halls using Teams Events. -Possible values are: - - **Enabled**: Enables creating town halls. - - **Disabled**: Disables creating town halls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEmailEditing -This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. -Possible values are: - - **Enabled**: Enables editing of communication emails. - - **Disabled**: Disables editing of communication emails. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch does not work with this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventAccessType - -> [!NOTE] -> Currently, webinar and town hall event access is managed together via EventAccessType. - -This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. -Possible values are: - - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - - **EveryoneInCompanyExcludingGuests**: Enables creating events to allow only in-tenant users to register and join the event. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedQuestionTypesInRegistrationForm -This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. - -Possible values are: -DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedTownhallTypesForRecordingPublish -This setting describes how IT admins can control which types of Town Hall attendees can have their recordings published. - -Possible values are: -None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedWebinarTypesForRecordingPublish -This setting describes how IT admins can control which types of webinar attendees can have their recordings published. - -Possible values are: -None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEventIntegrations -This setting governs access to the integrations tab in the event creation workflow. - -Possible values -true, false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TownhallChatExperience -This setting governs whether the user can enable the Comment Stream chat experience for Town Halls. - -Possible values are: Optimized, None. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordingForTownhall -Determines whether recording is allowed in a user's townhall. - -Possible values are: - - **Enabled**: Allow recording in user's townhalls. - - **Disabled**: Prohibit recording in user's townhalls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordingForWebinar -Determines whether recording is allowed in a user's webinar. - -Possible values are: - - **Enabled**: Allow recording in user's webinars. - - **Disabled**: Prohibit recording in user's webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TranscriptionForTownhall -Determines whether transcriptions are allowed in a user's townhall. - -Possible values are: - - **Enabled**: Allow transcriptions in user's townhalls. - - **Disabled**: Prohibit transcriptions in user's townhalls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TranscriptionForWebinar -Determines whether transcriptions are allowed in a user's webinar. - -Possible values are: - - **Enabled**: Allow transcriptions in user's webinars. - - **Disabled**: Prohibit transcriptions in user's webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmersiveEvents -This setting governs if a user can create Immersive Events using Teams Events. -Possible values are: - - **Enabled**: Enables creating Immersive Events. - - **Disabled**: Disables creating Immersive Events. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch does not work with this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch does not work with this cmdlet. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.date: 04/23/2025 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamseventspolicy +schema: 2.0.0 +title: Set-CsTeamsEventsPolicy +--- + +# Set-CsTeamsEventsPolicy + +## SYNOPSIS +This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. + +## SYNTAX + +``` +Set-CsTeamsEventsPolicy [-AllowWebinars ] [-EventAccessType ] [-AllowTownhalls ] [-ImmersiveEvents ] + [-TownhallEventAttendeeAccess ] [-AllowEmailEditing ] [-AllowedQuestionTypesInRegistrationForm ] + [-AllowEventIntegrations ] [-AllowedWebinarTypesForRecordingPublish ] + [-AllowedTownhallTypesForRecordingPublish ] [-TownhallChatExperience ] [-Description ] + [-RecordingForTownhall ] [-RecordingForWebinar ] [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] + [-UseMicrosoftECDN ] [-BroadcastPremiumApps ] [-MaxResolutionForTownhall ] [-HighBitrateForTownhall ] +``` + +## DESCRIPTION +User-level policy for tenant admin to configure options for customizing Teams events experiences. Use this cmdlet to update an existing policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled +``` + +The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. + +## PARAMETERS + +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. + +Possible values are: +DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTownhallTypesForRecordingPublish +This setting describes how IT admins can control which types of Town Hall attendees can have their recordings published. + +Possible values are: +None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedWebinarTypesForRecordingPublish +This setting describes how IT admins can control which types of webinar attendees can have their recordings published. + +Possible values are: +None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailEditing +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. +Possible values are: + - **Enabled**: Enables editing of communication emails. + - **Disabled**: Disables editing of communication emails. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEventIntegrations +This setting governs access to the integrations tab in the event creation workflow. + +Possible values +true, false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTownhalls +This setting governs if a user can create town halls using Teams Events. +Possible values are: + - **Enabled**: Enables creating town halls. + - **Disabled**: Disables creating town halls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWebinars +This setting governs if a user can create webinars using Teams Events. +Possible values are: + - **Enabled**: Enables creating webinars. + - **Disabled**: Disables creating webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastPremiumApps +This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. + +Possible values are: +- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall +- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventAccessType + +> [!NOTE] +> Currently, webinar and town hall event access is managed together via EventAccessType. + +This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. +Possible values are: + - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + - **EveryoneInCompanyExcludingGuests**: Enables creating events to allow only in-tenant users to register and join the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmersiveEvents +This setting governs if a user can create Immersive Events using Teams Events. +Possible values are: + - **Enabled**: Enables creating Immersive Events. + - **Disabled**: Disables creating Immersive Events. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +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 +``` + +### -TownhallChatExperience +This setting governs whether the user can enable the Comment Stream chat experience for Town Halls. + +Possible values are: Optimized, None. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -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 +``` + +### -UseMicrosoftECDN +This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxResolutionForTownhall +This policy sets the maximum video resolution supported in Town hall events. + +Possible values are: +- **Max720p**: Town halls support video resolution up to 720p. +- **Max1080p**: Town halls support video resolution up to 1080p. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Max1080p +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighBitrateForTownhall +This policy controls whether high-bitrate streaming is enabled for Town hall events. + +Possible values are: +- **Enabled**: Enables high bitrate for Town hall events. +- **Disabled**: Disables high bitrate for Town hall events. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch does not work with this cmdlet. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsExternalAccessConfiguration.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsExternalAccessConfiguration.md index 3538e2a0af..fefdebfadf 100644 --- a/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsExternalAccessConfiguration.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsexternalaccessconfiguration -title: Set-CsTeamsExternalAccessConfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsexternalaccessconfiguration schema: 2.0.0 +title: Set-CsTeamsExternalAccessConfiguration --- # Set-CsTeamsExternalAccessConfiguration @@ -38,32 +39,32 @@ In this example, the admin has added two malicious users into the blocked list. ## PARAMETERS -### -BlockExternalAccessUserAccess -Designates whether BlockedUsers list is taking effect or not. $true means BlockedUsers are blocked and can't communicate with internal users. +### -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: Boolean +Type: List Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None 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. +### -BlockExternalAccessUserAccess +Designates whether BlockedUsers list is taking effect or not. $true means BlockedUsers are blocked and can't communicate with internal users. ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFeedbackPolicy.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsFeedbackPolicy.md index c6a1f2b39c..650e304074 100644 --- a/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFeedbackPolicy.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Set-CsTeamsFeedbackPolicy +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsfeedbackpolicy schema: 2.0.0 +title: Set-CsTeamsFeedbackPolicy --- # Set-CsTeamsFeedbackPolicy @@ -44,28 +46,28 @@ In this example, the policy "New Hire Feedback Policy" is modified, sets the use ## PARAMETERS -### -Identity -The unique identifier of the policy. +### -AllowEmailCollection +Set this to TRUE to enable Email collection. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowLogCollection +Set this to TRUE to enable log collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -74,11 +76,11 @@ 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. +### -AllowScreenshotCollection +Set this to TRUE to enable Screenshot collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -89,13 +91,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Internal Microsoft use. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -104,32 +106,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiveSurveysMode -Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. -Set it to EnabledUserOverride to have users receive the survey and allow them to opt out. - -Possible values: - - Enabled - - Disabled - - EnabledUserOverride +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use. +### -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: @@ -140,13 +137,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserInitiatedMode - Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. - Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. - -Possible values: - - Enabled - - Disabled +### -Identity +The unique identifier of the policy. ```yaml Type: String @@ -154,17 +146,17 @@ Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: Enabled +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEmailCollection -Set this to TRUE to enable Email collection. +### -Instance +Internal Microsoft use. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: @@ -175,26 +167,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowLogCollection -Set this to TRUE to enable log collection. +### -ReceiveSurveysMode +Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. +Set it to EnabledUserOverride to have users receive the survey and allow them to opt out. + +Possible values: + - Enabled + - Disabled + - EnabledUserOverride ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowScreenshotCollection -Set this to TRUE to enable Screenshot collection. +### -Tenant +Internal Microsoft use. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: @@ -205,18 +203,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 +### -UserInitiatedMode + Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. + Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. + +Possible values: + - Enabled + - Disabled ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFilesPolicy.md similarity index 86% rename from teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsFilesPolicy.md index 1a28cf4317..0e2848efb2 100644 --- a/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFilesPolicy.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy -title: Set-CsTeamsFilesPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsfilespolicy schema: 2.0.0 +title: Set-CsTeamsFilesPolicy --- # Set-CsTeamsFilesPolicy @@ -17,8 +18,8 @@ The policies also specify third-party app ID to allow file storage (e.g., Box). ```powershell Set-CsTeamsFilesPolicy [-NativeFileEntryPoints ] [-SPChannelFilesTab ] - [-DefaultFileUploadAppId ] [-FileSharingInChatswithExternalUsers ] [-Identity] - [-Force] [-WhatIf] [-Confirm] [] + [-DefaultFileUploadAppId ] [-FileSharingInChatswithExternalUsers ] [-AutoShareFilesInExternalChats ] + [-Identity] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -44,36 +45,37 @@ The command shown in Example 2 changes the DefaultFileUploadAppId to AppId_GUID ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -AutoShareFilesInExternalChats + +Indicates if file scope will be changed automatically when sharing files and loops in chats with external or guest users. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named 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. +### -Confirm +Prompts you for confirmation before executing the command. + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: None +Default value: False 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. @@ -89,28 +91,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -119,26 +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. +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -FileSharingInChatswithExternalUsers - -Indicates if file sharing in chats with external users is enabled. - +### -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) @@ -149,8 +151,8 @@ 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. @@ -167,6 +169,21 @@ 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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -178,11 +195,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration.md index f79231986e..925a28854e 100644 --- a/teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsguestcallingconfiguration +schema: 2.0.0 +title: Set-CsTeamsGuestCallingConfiguration --- # Set-CsTeamsGuestCallingConfiguration diff --git a/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration.md index 1c4ee27ee2..99ce363e58 100644 --- a/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration.md @@ -1,10 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestmeetingconfiguration -applicable: Microsoft Teams -title: Set-CsTeamsGuestMeetingConfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsguestmeetingconfiguration schema: 2.0.0 +title: Set-CsTeamsGuestMeetingConfiguration --- # Set-CsTeamsGuestMeetingConfiguration @@ -74,6 +75,21 @@ 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 +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -195,21 +211,6 @@ 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). diff --git a/teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration.md similarity index 88% rename from teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration.md index 4e5e35b1d8..bc8e112950 100644 --- a/teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsguestmessagingconfiguration +schema: 2.0.0 +title: Set-CsTeamsGuestMessagingConfiguration --- # Set-CsTeamsGuestMessagingConfiguration @@ -21,7 +23,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 +31,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] [] ``` @@ -62,6 +64,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowImmersiveReader +Determines if immersive reader for viewing messages is enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowMemes Determines if memes are available for use. @@ -107,8 +124,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserDeleteMessage -Determines if a user is allowed to delete their own messages. +### -AllowUserDeleteChat +Turn this setting on to allow users to permanently delete their one-on-one chat, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. ```yaml Type: Boolean @@ -117,13 +134,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: TRUE Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserEditMessage -Determines if a user is allowed to edit their own messages. +### -AllowUserDeleteMessage +Determines if a user is allowed to delete their own messages. ```yaml Type: Boolean @@ -137,13 +154,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowUserEditMessage +Determines if a user is allowed to edit their own messages. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -152,12 +169,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -166,17 +184,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserDeleteChat -Turn this setting on to allow users to permanently delete their one-on-one chat, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. +### -Force ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: TRUE +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -196,39 +213,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowImmersiveReader -Determines if immersive reader for viewing messages is enabled. +### -Identity ```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 ``` -### -Identity +### -Instance ```yaml -Type: XdsIdentity +Type: PSObject Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance +### -Tenant ```yaml -Type: PSObject +Type: Guid Parameter Sets: (All) Aliases: @@ -239,16 +255,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -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: 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 ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsIPPhonePolicy.md similarity index 98% rename from teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsIPPhonePolicy.md index 0f608fbf29..c696b45c13 100644 --- a/teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsipphonepolicy schema: 2.0.0 +title: Set-CsTeamsIPPhonePolicy --- # Set-CsTeamsIPPhonePolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMediaConnectivityPolicy.md similarity index 83% rename from teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMediaConnectivityPolicy.md index 7bb81a371f..13154e5816 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: runli +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +title: Set-CsTeamsMediaConnectivityPolicy --- # Set-CsTeamsMediaConnectivityPolicy @@ -41,32 +42,32 @@ Set Teams media connectivity policy "DirectConnection" value to "Disabled" for i ## PARAMETERS -### -Identity -Identity of the Teams media connectivity policy. +### -DirectConnection +Policy value of the Teams media connectivity DirectConnection policy. ```yaml -Type: String -Parameter Sets: (All) +Type: Boolean +Parameter Sets: ("Enabled","Disabled") Aliases: Required: True Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -DirectConnection -Policy value of the Teams media connectivity DirectConnection policy. +### -Identity +Identity of the Teams media connectivity policy. ```yaml -Type: Boolean -Parameter Sets: ("Enabled","Disabled") +Type: String +Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -82,10 +83,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy) -[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy) -[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy) -[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) \ No newline at end of file +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy.md index 033a024718..644612567a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy.md @@ -1,14 +1,14 @@ --- +applicable: Microsoft Teams +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Set-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas -applicable: Microsoft Teams --- # Set-CsTeamsMeetingBrandingPolicy @@ -45,6 +45,21 @@ In this example, the commands will change the brand accent color of the theme in ## 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 +``` + ### -DefaultTheme *This parameter is reserved for Microsoft internal use only.* Identity of default meeting theme. @@ -91,6 +106,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Identity of meeting branding policy that will be updated. To refer to the global policy, use this syntax: `-Identity global`. @@ -139,36 +169,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Describes what would happen if you executed the command without actually executing the command. @@ -197,12 +197,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration.md similarity index 86% rename from teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration.md index a369ef43c1..8971cb0b04 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration.md @@ -1,23 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbroadcastconfiguration +schema: 2.0.0 +title: Set-CsTeamsMeetingBroadcastConfiguration --- # Set-CsTeamsMeetingBroadcastConfiguration ## SYNOPSIS -Set-CsTeamsMeetingBroadcastConfiguration \[\[-Identity\] \\] \[-Tenant \\] \[-SupportURL \\] \[-AllowSdnProviderForBroadcastMeeting \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] - -Set-CsTeamsMeetingBroadcastConfiguration -SdnProviderName \ -SdnApiTemplateUrl \ \[-Tenant \\] \[-SupportURL \\] \[-AllowSdnProviderForBroadcastMeeting \\] \[-SdnLicenseId \\] \[-SdnApiToken \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] - -Set-CsTeamsMeetingBroadcastConfiguration \[-Tenant \\] \[-SupportURL \\] \[-AllowSdnProviderForBroadcastMeeting \\] \[-Instance \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] +Changes the Teams meeting broadcast configuration settings for the specified tenant. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy.md index 5fda5b675c..0aa969b728 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Set-CsTeamsMeetingBroadcastPolicy --- # Set-CsTeamsMeetingBroadcastPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingConfiguration.md similarity index 98% rename from teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingConfiguration.md index 10cd0d63f9..e3408ef993 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingConfiguration.md @@ -1,10 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingconfiguration -applicable: Microsoft Teams -title: Set-CsTeamsMeetingConfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingconfiguration schema: 2.0.0 +title: Set-CsTeamsMeetingConfiguration --- # Set-CsTeamsMeetingConfiguration @@ -222,9 +223,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableQoS +### -DisableAppInteractionForAnonymousUsers +Determines if anonymous users can interact with apps in meetings. Set to TRUE to disable App interaction. +Possible values: -Determines whether Quality of Service Marking for real-time media (audio, video, screen/app sharing) is enabled in the tenant. Set this to TRUE to enable and FALSE to disable +- True +- False ```yaml Type: Boolean @@ -238,12 +242,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -EnableQoS -{{Fill Force Description}} +Determines whether Quality of Service Marking for real-time media (audio, video, screen/app sharing) is enabled in the tenant. Set this to TRUE to enable and FALSE to disable ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -254,9 +258,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpURL +### -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: -URL to a website where users can obtain assistance on joining the meeting.This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries +- Enabled +- Disabled ```yaml Type: String @@ -265,31 +272,33 @@ Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The only valid input is Global +### -Force + +{{Fill Force Description}} ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Use this parameter to update a saved configuration instance +### -HelpURL + +URL to a website where users can obtain assistance on joining the meeting.This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries ```yaml -Type: PSObject +Type: String Parameter Sets: (All) Aliases: @@ -300,27 +309,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegalURL -URL to a website containing legal information and meeting disclaimers. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries +### -Identity +The only valid input is Global ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LogoURL - -URL to a logo image. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries +### -Instance +Use this parameter to update a saved configuration instance ```yaml -Type: String +Type: PSObject Parameter Sets: (All) Aliases: @@ -331,15 +339,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableAppInteractionForAnonymousUsers -Determines if anonymous users can interact with apps in meetings. Set to TRUE to disable App interaction. -Possible values: - -- True -- False +### -LegalURL +URL to a website containing legal information and meeting disclaimers. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -350,12 +354,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant - -Internal Microsoft use +### -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: Guid +Type: Boolean Parameter Sets: (All) Aliases: @@ -366,12 +370,9 @@ 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: +### -LogoURL -- Enabled -- Disabled +URL to a logo image. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries ```yaml Type: String @@ -380,17 +381,17 @@ Aliases: Required: False Position: Named -Default value: Enabled +Default value: None 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. +### -Tenant + +Internal Microsoft use ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingPolicy.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingPolicy.md index 212c717c07..8ae549b548 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingPolicy.md @@ -1,15 +1,16 @@ --- -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 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: wblocker -ms.date: 11/12/2024 +ms.date: 02/26/2025 +ms.reviewer: alejandramu +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingpolicy +schema: 2.0.0 +title: Set-CsTeamsMeetingPolicy --- # Set-CsTeamsMeetingPolicy @@ -123,6 +124,9 @@ Set-CsTeamsMeetingPolicy [[-Identity] ] [-WatermarkForCameraVideoPattern ] [-WatermarkForScreenSharingOpacity ] [-WatermarkForScreenSharingPattern ] + [-AllowedUsersForMeetingDetails ] + [-RealTimeText ] + [-ParticipantSlideControl [-WhatIf] [-WhoCanRegister ] [] @@ -165,22 +169,10 @@ This policy will use all the existing values except one: AllowNetworkConfigurati ## PARAMETERS -### -Identity -Specify the name of the policy being created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -195,7 +187,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -224,9 +215,6 @@ Accept wildcard characters: False Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to prohibit anonymous users from dialing out. -> [!NOTE] -> This parameter is temporarily disabled. - ```yaml Type: Boolean Parameter Sets: (All) @@ -287,6 +275,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowBreakoutRooms +Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -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. @@ -328,8 +331,11 @@ 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. +### -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 @@ -338,16 +344,13 @@ Aliases: Required: False Position: Named -Default value: True +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. +### -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 @@ -361,11 +364,12 @@ 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. +### -AllowDocumentCollaboration + +This setting will allow admins to choose which users will be able to use the Document Collaboration feature. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -376,9 +380,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDocumentCollaboration +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. -This setting will allow admins to choose which users will be able to use the Document Collaboration feature. +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 +``` + +### -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 +``` + +### -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 @@ -392,6 +431,25 @@ 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 +``` + ### -AllowEngagementReport Determines whether meeting organizers are allowed to download the attendee engagement report. Possible values are: @@ -429,6 +487,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowExternalNonTrustedMeetingChat +This field controls whether a user is allowed to chat in external meetings with users from non-trusted organizations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowExternalParticipantGiveRequestControl Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting. @@ -572,31 +645,31 @@ 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. +### -AllowNDIStreaming +This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. ```yaml Type: Boolean Parameter Sets: (All) Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNDIStreaming -This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. +### -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 ``` @@ -661,8 +734,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetNow -This setting controls whether a user can start an ad hoc private meeting. +### -AllowPrivateMeetingScheduling +Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. + +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -676,11 +752,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetingScheduling -Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. - -> [!NOTE] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. +### -AllowPrivateMeetNow +This setting controls whether a user can start an ad hoc private meeting. ```yaml Type: Boolean @@ -800,22 +873,6 @@ 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. @@ -837,23 +894,8 @@ 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. +### -AllowWatermarkForCameraVideo +This setting allows scheduling meetings with watermarking for video enabled. ```yaml Type: Boolean @@ -862,7 +904,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -882,21 +924,6 @@ 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. @@ -912,28 +939,8 @@ 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. +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 @@ -986,22 +993,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoRecording - -This setting will enable Tenant Admins to turn on/off the auto recording feature. - -```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: @@ -1050,6 +1041,22 @@ 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 +``` + ### -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. @@ -1266,7 +1273,7 @@ Accept wildcard characters: False ### -ExplicitRecordingConsent Set participant agreement and notification for Recording, Transcript, Copilot in Teams meetings. -Possible Values: +Possible Values: - Enabled: Explicit consent, requires participant agreement. - Disabled: Implicit consent, does not require participant agreement. @@ -1320,6 +1327,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Specify the name of the policy being created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InfoShownInReportMode This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. @@ -1479,6 +1501,9 @@ Accept wildcard characters: False ``` ### -MeetingInviteLanguages + +> Applicable: Microsoft Teams + 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] @@ -1492,7 +1517,6 @@ The preliminary list of available languages is shown below: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1520,6 +1544,8 @@ Accept wildcard characters: False ``` ### -NoiseSuppressionForDialInParticipants +> Applicable: Microsoft Teams + >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1535,7 +1561,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1564,6 +1589,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParticipantSlideControl + +> Applicable: Microsoft Teams + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Determines whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibited from giving control, or being given control, in a meeting. + +Possible Values: +- Everyone: Anyone in the meeting can give or take control +- EveryoneInOrganization: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control +- EveryoneInOrganizationAndGuests: Only those who are Guests to the tenant, MTO users, and internal AAD users can give or take control +- None: No one in the meeting can give or take control + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +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. @@ -1599,6 +1651,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RealTimeText + +> Applicable: Microsoft Teams + +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: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecordingStorageMode This parameter can take two possible values: @@ -1723,7 +1797,7 @@ Possible values are: - Disabled - Enabled -Set this to Enabled to allow up to 20,000 extra view-only attendees to join. +Set this to Enabled to allow up to 10,000 extra view-only attendees to join. ```yaml Type: String @@ -1835,6 +1909,8 @@ Accept wildcard characters: False ### -VoiceSimulationInInterpreter +> Applicable: Microsoft Teams + > [!NOTE] > This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1849,7 +1925,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 81% rename from teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingTemplatePermissionPolicy.md index e9a319c5d3..57fb8c5872 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMeetingTemplatePermissionPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Set-CsTeamsMeetingTemplatePermissionPolicy --- # Set-CsTeamsMeetingTemplatePermissionPolicy @@ -43,15 +44,16 @@ Updates the hidden meeting templates array. ## PARAMETERS -### -Identity +### -Description -Name of the policy instance to be updated. +> Applicable: Microsoft Teams + +Pass in a new description if that field needs to be updated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -61,14 +63,15 @@ Accept wildcard characters: False ### -HiddenMeetingTemplates +> Applicable: Microsoft Teams + The updated list of meeting template IDs to hide. -The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddenmeetingtemplate). ```yaml Type: HiddenMeetingTemplate[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -76,15 +79,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Pass in a new description if that field needs to be updated. +> Applicable: Microsoft Teams + +Name of the policy instance to be updated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -102,10 +106,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingConfiguration.md similarity index 81% rename from teams/teams-ps/teams/set-csteamsmessagingconfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingConfiguration.md index dd01cdb45b..5934c368b8 100644 --- a/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingConfiguration.md @@ -1,241 +1,290 @@ ---- -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 ] - [-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 -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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) +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsTeamsMessagingConfiguration +schema: 2.0.0 +title: Set-CsTeamsMessagingConfiguration +--- + +# 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 + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/microsoftteams/get-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingPolicy.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingPolicy.md index fee0e9ed4e..5d867c419e 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingPolicy.md @@ -1,9 +1,11 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmessagingpolicy schema: 2.0.0 +title: Set-CsTeamsMessagingPolicy --- # Set-CsTeamsMessagingPolicy @@ -55,6 +57,9 @@ Set-CsTeamsMessagingPolicy [[-Identity] ] [-InOrganizationChatControl ] [-ReadReceiptsEnabledType ] [-Tenant ] + [-UsersCanDeleteBotMessages ] + [-AutoShareFilesInExternalChats ] + [-UseB2BInvitesToAddExternalUsers ] [-WhatIf] [] ``` @@ -100,6 +105,9 @@ Set-CsTeamsMessagingPolicy [-Instance ] [-InOrganizationChatControl ] [-ReadReceiptsEnabledType ] [-Tenant ] + [-UsersCanDeleteBotMessages ] + [-AutoShareFilesInExternalChats ] + [-UseB2BInvitesToAddExternalUsers ] [-WhatIf] [] ``` @@ -129,38 +137,6 @@ All other policy properties will be left as previously assigned. ## PARAMETERS -### -Identity -Identity for the teams messaging policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: `-Identity TeamsMessagingPolicy`. - -If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowChatWithGroup This setting determines if users can chat with groups (Distribution, M365 and Security groups). Possible values: True, False @@ -716,6 +692,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Identity for the teams messaging policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: `-Identity TeamsMessagingPolicy`. + +If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +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. @@ -731,6 +724,21 @@ 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 +``` + ### -ReadReceiptsEnabledType Use this setting to specify whether read receipts are user controlled, enabled for everyone, or disabled. Set this to UserPreference, Everyone or None. @@ -769,6 +777,59 @@ 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 +``` + +### -UseB2BInvitesToAddExternalUsers + +Indicates whether B2B invites should be used to add external users when necessary. + +Possible values: + +- `Enabled`: External users will be added using B2B invites. +- `Disabled`: External users will not be added using B2B invites. + +```yaml +Type: System.String +Parameter Sets: (All) +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShareFilesInExternalChats + +Determines whether files are automatically shared in external chats. + +Possible values: + +- `Enabled`: Files are automatically shared in external chats. +- `Disabled`: Files are not automatically shared in external chats. + +```yaml +Type: System.String +Parameter Sets: (All) +Required: False +Position: Named +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. diff --git a/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMobilityPolicy.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMobilityPolicy.md index 483c23e72a..bd60a9f009 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmobilitypolicy +schema: 2.0.0 +title: Set-CsTeamsMobilityPolicy --- # Set-CsTeamsMobilityPolicy @@ -87,23 +89,23 @@ 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. +### -Identity +Specify the name of the policy that you are creating. ```yaml -Type: String -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 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. +### -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 @@ -117,16 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy that you are creating. +### -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: XdsIdentity -Parameter Sets: Identity +Type: String +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMultiTenantOrganizationConfiguration.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMultiTenantOrganizationConfiguration.md index 0e092c6abe..c68af050c0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMultiTenantOrganizationConfiguration.md @@ -1,12 +1,13 @@ --- -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 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: samlyu +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmultitenantorganizationconfiguration +schema: 2.0.0 +title: Set-CsTeamsMultiTenantOrganizationConfiguration --- # Set-CsTeamsMultiTenantOrganizationConfiguration @@ -45,32 +46,32 @@ Set Teams Multi-tenant Organization Setting "CopilotFromHomeTenant" value to "En ## PARAMETERS -### -Identity -Identity of the Teams Multi-tenant Organization Setting. +### -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: String -Parameter Sets: (All) +Type: Boolean +Parameter Sets: ("Enabled","Disabled") Aliases: Required: True Position: Named -Default value: None +Default value: Enabled 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. +### -Identity +Identity of the Teams Multi-tenant Organization Setting. ```yaml -Type: Boolean -Parameter Sets: ("Enabled","Disabled") +Type: String +Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy.md index f7d01f2e45..4d76dd2327 100644 --- a/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsnetworkroamingpolicy schema: 2.0.0 +title: Set-CsTeamsNetworkRoamingPolicy --- # Set-CsTeamsNetworkRoamingPolicy @@ -39,7 +39,7 @@ To enable the network roaming policy for users who are not Enterprise Voice enab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> Set-CsTeamsNetworkRoamingPolicy -Identity "RedmondRoaming" -AllowIPVideo $true -MediaBitRateKb 2000 -Description "Redmond campus roaming policy" ``` @@ -48,63 +48,63 @@ The command shown in Example 1 updates the teams network roaming policy with Id ## PARAMETERS -### -Identity -Unique identifier of the policy to be modified. +### -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: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPVideo -Determines whether video is enabled in a user's meetings or calls. -Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. +### -Description +Description of the policy to be edited. ```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 ``` -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings. +### -Identity +Unique identifier of the policy to be modified. ```yaml -Type: Integer +Type: XdsIdentity Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 50000 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the policy to be edited. +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. ```yaml -Type: String +Type: Integer Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: 50000 Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNotificationAndFeedsPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsNotificationAndFeedsPolicy.md index b5598c89ee..c4840eb91a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNotificationAndFeedsPolicy.md @@ -1,166 +1,167 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsnotificationandfeedspolicy +schema: 2.0.0 +title: Set-CsTeamsNotificationAndFeedsPolicy +--- + +# 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/teams/teams-ps/MicrosoftTeams/Set-CsTeamsPersonalAttendantPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsPersonalAttendantPolicy.md new file mode 100644 index 0000000000..615ec54416 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsPersonalAttendantPolicy.md @@ -0,0 +1,304 @@ +--- +applicable: Microsoft Teams +author: juliiva +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: jomarque +Module Name: MicrosoftTeams +ms.author: juliiva +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamspersonalattendantpolicy +schema: 2.0.0 +title: Set-CsTeamsPersonalAttendantPolicy +--- + +# Set-CsTeamsPersonalAttendantPolicy + +## SYNOPSIS + +**Limited Preview:** Functionality described in this document is currently in limited preview and only authorized organizations have access. + +Use this cmdlet to update values in existing Teams Personal Attendant Policies. + +## SYNTAX + +``` +Set-CsTeamsPersonalAttendantPolicy [-Identity ] [-PersonalAttendant ] [-CallScreening ] [-CalendarBookings ] [-InboundInternalCalls ] [-InboundFederatedCalls ] [-InboundPSTNCalls ] [-AutomaticTranscription ] [-AutomaticRecording ] [-Confirm] [-Force] [-WhatIf] [] +``` + +## DESCRIPTION +The Teams Personal Attendant Policy controls personal attendant and its functionalities available to users in Microsoft Teams. This cmdlet allows admins to set values in +a given Personal Attendant Policy instance. + +Only the parameters specified are changed. Other parameters keep their existing values. + +## EXAMPLES + +### Example 1 +``` +Set-CsTeamsPersonalAttendantPolicy -Identity Global -CallScreening Disabled +``` + +Sets the value of the parameter CallScreening in the Global (default) Teams Personal Attendant Policy instance. + +### Example 2 +``` +Set-CsTeamsPersonalAttendantPolicy -Identity SalesPersonalAttendantPolicy -CalendarBookings Disabled +``` + +Sets the value of the parameter CalendarBookings to Disabled in the Teams Personal Attendant Policy instance called SalesPersonalAttendantPolicy. + +## PARAMETERS + +### -Identity +Name of the policy instance being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersonalAttendant +Enables the user to use the personal attendant + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallScreening +Enables the user to use the personal attendant call context evaluation features + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CalendarBookings +Enables the user to use the personal attendant calendar related features + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundInternalCalls +Enables the user to use the personal attendant for incoming domain calls + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundFederatedCalls +Enables the user to use the personal attendant for incoming calls from other domains + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundPSTNCalls +Enables the user to use the personal attendant for incoming PSTN calls + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticTranscription +Enables the user to use the automatic storing of personal attendant call transcriptions + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticRecording +Enables the user to use the automatic storing of personal attendant call recordings + +Possible values: + +- EnabledUserOverride: Users can set their preferences from personal attendant settings in the Teams app. +- Enabled: Enables the user to use this functionality. +- Disabled: The user is not enabled to use this functionality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept 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: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +The cmdlet is available in Teams PowerShell module 7.2.1-preview or later. + +## RELATED LINKS + +[New-CsTeamsPersonalAttendantPolicy](./new-csteamspersonalattendantpolicy.md) + +[Get-CsTeamsPersonalAttendantPolicy](./get-csteamspersonalattendantpolicy.md) + +[Grant-CsTeamsPersonalAttendantPolicy](./grant-csteamspersonalattendantpolicy.md) + +[Remove-CsTeamsPersonalAttendantPolicy](./remove-csteamspersonalattendantpolicy.md) diff --git a/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRecordingRollOutPolicy.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsRecordingRollOutPolicy.md index f41ad5f975..657068267a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams ms.author: ronwa +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsrecordingrolloutpolicy +schema: 2.0.0 +title: Set-CsTeamsRecordingRollOutPolicy --- # Set-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md index 171a3e9cd7..822eb17ae8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,225 +1,228 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Set-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Set-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +``` +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). + +## EXAMPLES + +## 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/MicrosoftTeams/Set-CsTeamsSettingsCustomApp.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSettingsCustomApp.md index 455aab2ff0..0cdb3de4bc 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSettingsCustomApp.md @@ -1,95 +1,96 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssettingscustomapp +schema: 2.0.0 +title: Set-CsTeamsSettingsCustomApp +--- + +# 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 +``` + +### -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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/microsoftteams/get-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSharedCallingRoutingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSharedCallingRoutingPolicy.md index 31c805cfbb..d31630e75b 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSharedCallingRoutingPolicy.md @@ -1,15 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -title: Set-CsTeamsSharedCallingRoutingPolicy -schema: 2.0.0 author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: - +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy +schema: 2.0.0 +title: Set-CsTeamsSharedCallingRoutingPolicy --- # Set-CsTeamsSharedCallingRoutingPolicy @@ -45,17 +43,20 @@ 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. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -98,69 +99,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceAccount -The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. +### -Force -The phone number assigned to the resource account must: -- Have the same phone number type and country as the emergency numbers configured in this policy instance. -- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. -- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. +> Applicable: Microsoft Teams -The same resource account can be used in multiple shared calling policy instances. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity +Unique identifier of the Teams shared calling routing policy to be created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False -Position: Named -Default value: False +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. +### -ResourceAccount +The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. + +The phone number assigned to the resource account must: +- Have the same phone number type and country as the emergency numbers configured in this policy instance. +- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) and the -LocationId parameter to set the location. +- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. + +The same resource account can be used in multiple shared calling policy instances. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -186,12 +190,12 @@ Shared Calling is not supported for Calling Plan service phone numbers in Romani This cmdlet was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS -[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy) -[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy) -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsAppPolicy.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsAppPolicy.md index abbbb97e70..e7b4818e46 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsAppPolicy.md @@ -1,133 +1,134 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsapppolicy +schema: 2.0.0 +title: Set-CsTeamsShiftsAppPolicy +--- + +# 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/MicrosoftTeams/Set-CsTeamsShiftsConnection.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnection.md index dd1eca6bb1..af400016d9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Set-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnection schema: 2.0.0 +title: Set-CsTeamsShiftsConnection --- # Set-CsTeamsShiftsConnection @@ -168,6 +169,21 @@ In case of an error, you can capture the error response as follows: ## PARAMETERS +### -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 +``` + ### -Body The request body. @@ -214,7 +230,7 @@ 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). +The WFM connection ID for the instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). ```yaml Type: String @@ -228,6 +244,51 @@ 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 +``` + +### -ConnectorSpecificSettings +The connector-specific settings. + +```yaml +Type: IUpdateWfmConnectionRequestConnectorSpecificSettings +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + ### -HttpPipelineAppend SendAsync Pipeline Steps to be appended to the front of the pipeline. @@ -303,21 +364,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector-specific settings. - -```yaml -Type: IUpdateWfmConnectionRequestConnectorSpecificSettings -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Proxy The URI for the proxy server to use. @@ -394,51 +440,6 @@ 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). @@ -458,10 +459,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection) -[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection) -[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnection) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnectionInstance.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnectionInstance.md index eb62460fc0..45259a9d6d 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: leonardospina external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Set-CsTeamsShiftsConnectionInstance -author: leonardospina ms.author: lespina -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Set-CsTeamsShiftsConnectionInstance --- # Set-CsTeamsShiftsConnectionInstance @@ -165,6 +166,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectionId +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ConnectorAdminEmail Gets or sets the list of connector admin email addresses. @@ -193,8 +208,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId -Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -DesignatedActorId +Gets or sets the designated actor ID that App acts as for Shifts Graph API calls. ```yaml Type: String @@ -207,54 +222,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -Gets or sets the designated actor ID that App acts as for Shifts Graph API calls. +### -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: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -IfMatch +The value of the etag field as returned by the cmdlets. ```yaml Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Parameter Sets: (All) Aliases: Required: True Position: Named @@ -263,22 +279,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -InputObject +Identity Parameter. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: SetViaIdentityExpanded, SetViaIdentity Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SyncScenarioSwapRequest -The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Name +The connector instance name. ```yaml Type: String @@ -291,50 +307,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: Uri +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String @@ -347,40 +363,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -SyncFrequencyInMin +The sync frequency in minutes. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: Int32 +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True 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. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The value of the etag field as returned by the cmdlets. +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: Required: True Position: Named @@ -389,22 +405,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: SetViaIdentityExpanded, SetViaIdentity +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connector instance name. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -417,50 +433,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Uri -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True 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. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: PSCredential -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -473,11 +489,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin -The sync frequency in minutes. +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Int32 +Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: Required: True @@ -502,21 +518,6 @@ 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). @@ -536,12 +537,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance) -[Update-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance) +[Update-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsPolicy.md index 6835a0dfa9..a87af15d4c 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsPolicy.md @@ -1,220 +1,235 @@ ---- -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 ---- - -# Set-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. - -## SYNTAX - -```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 -```powershell -PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 -``` -In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", a warning message (Message 1) will always be displayed to the user on opening Teams during off shift hours. - -## PARAMETERS - -### -Identity -Policy instance name. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessType -Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. -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) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: UnrestrictedAccess_TeamsApp -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageType -The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. -'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. -'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. -'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. -'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. -'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. -'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. -'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. -'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. -'CustomMessage' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: DefaultMessage -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageCustom -Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. - -```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 -``` - -### -ShiftNoticeFrequency -Frequency of warning dialog displayed when user opens Teams. Set one of Always, ShowOnceOnChange, Never. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: Always -Accept pipeline input: False -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) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableScheduleOwnerPermissions -Indicates whether a user can manage a Shifts schedule as a team member. - -```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 -``` - -### -Confirm -Prompts you for confirmation before running the 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 - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teamsshiftspolicy +schema: 2.0.0 +title: Set-CsTeamsShiftsPolicy +--- + +# Set-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. + +## SYNTAX + +```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 +```powershell +PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 +``` +In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", a warning message (Message 1) will always be displayed to the user on opening Teams during off shift hours. + +## PARAMETERS + +### -AccessGracePeriodMinutes + +> Applicable: Microsoft Teams + +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) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessType + +> Applicable: Microsoft Teams + +Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. +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) +Aliases: +Required: False +Position: Named +Default value: UnrestrictedAccess_TeamsApp +Accept 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 +``` + +### -EnableScheduleOwnerPermissions + +> Applicable: Microsoft Teams + +Indicates whether a user can manage a Shifts schedule as a team member. + +```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 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 + +> Applicable: Microsoft Teams + +Policy instance name. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeFrequency + +> Applicable: Microsoft Teams + +Frequency of warning dialog displayed when user opens Teams. Set one of Always, ShowOnceOnChange, Never. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: Always +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageCustom + +> Applicable: Microsoft Teams + +Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageType + +> Applicable: Microsoft Teams + +The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. +'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. +'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. +'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. +'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. +'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. +'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. +'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. +'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. +'CustomMessage' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: DefaultMessage +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSipDevicesConfiguration.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSipDevicesConfiguration.md index 2163f1d2f1..2c1924c3f9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSipDevicesConfiguration.md @@ -1,11 +1,12 @@ --- +author: anmandav external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsSipDevicesConfiguration -author: anmandav ms.author: anmandav -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssipdevicesconfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssipdevicesconfiguration schema: 2.0.0 +title: Set-CsTeamsSipDevicesConfiguration --- # Set-CsTeamsSipDevicesConfiguration @@ -102,4 +103,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamssipdevicesconfiguration) +[Get-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssipdevicesconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliance.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliance.md index 49fabb2ff1..fbba72c88f 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliance.md @@ -1,135 +1,140 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssurvivablebranchappliance +schema: 2.0.0 +title: Set-CsTeamsSurvivableBranchAppliance +--- + +# Set-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Changes the Survivable Branch Appliance (SBA) configuration settings for the specified tenant. + +## SYNTAX + +``` +Set-CsTeamsSurvivableBranchAppliance [-Description ] [[-Identity] ] [-Site ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +## 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/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliancePolicy.md index fe8cc3c54b..1e1e1de51b 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,119 +1,124 @@ ---- -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 +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Set-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Set-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Changes the Survivable Branch Appliance (SBA) Policy configuration settings for the specified tenant. + +## SYNTAX + +``` +Set-CsTeamsSurvivableBranchAppliancePolicy [-BranchApplianceFqdns ] [[-Identity] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +## 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/MicrosoftTeams/Set-CsTeamsTargetingPolicy.md similarity index 89% rename from teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsTargetingPolicy.md index f1e5d3000d..ccb2bcac75 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTargetingPolicy.md @@ -1,204 +1,202 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstargetingpolicy +schema: 2.0.0 +title: Set-CsTeamsTargetingPolicy +--- + +# Set-CsTeamsTargetingPolicy + +## SYNOPSIS +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. + +## 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. + +## 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/microsoftteams/get-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTemplatePermissionPolicy.md similarity index 85% rename from teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsTemplatePermissionPolicy.md index 8aa49764df..7f08503422 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTemplatePermissionPolicy.md @@ -1,155 +1,155 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy -title: Set-CsTeamsTemplatePermissionPolicy -author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: -manager: weiliu2 -schema: 2.0.0 ---- - -# Set-CsTeamsTemplatePermissionPolicy - -## SYNOPSIS -This cmdlet updates an existing TeamsTemplatePermissionPolicy. - -## SYNTAX - -``` -Set-CsTeamsTemplatePermissionPolicy - [-HiddenTemplates ] - [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Updates any of the properties of an existing instance of the TeamsTemplatePermissionPolicy. - -## EXAMPLES - -### Example 1 -```powershell -PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent -PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject -PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) -PS >Set-CsTeamsTemplatePermissionPolicy -Identity Global -HiddenTemplates $HiddenList -``` - -Updates the hidden templates array. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Adds a new description if that field needs to be updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. - -You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenTemplates -The updated list of Teams template IDs to hide. -The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). - -```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Name of the policy instance to be updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) - -[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) - -[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) +--- +author: yishuaihuang4 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy +schema: 2.0.0 +title: Set-CsTeamsTemplatePermissionPolicy +--- + +# Set-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +This cmdlet updates an existing TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +Set-CsTeamsTemplatePermissionPolicy + [-HiddenTemplates ] + [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Updates any of the properties of an existing instance of the TeamsTemplatePermissionPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) +PS >Set-CsTeamsTemplatePermissionPolicy -Identity Global -HiddenTemplates $HiddenList +``` + +Updates the hidden templates array. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Adds a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenTemplates +The updated list of Teams template IDs to hide. +The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddentemplate). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy) + +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTranslationRule.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsTranslationRule.md index 64bcdc16c5..dc6fa66265 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstranslationrule +schema: 2.0.0 +title: Set-CsTeamsTranslationRule --- # Set-CsTeamsTranslationRule @@ -36,16 +37,16 @@ This example modifies the rule that initially configured to strip +1206555 from ## 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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +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 @@ -66,8 +67,8 @@ 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. +### -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 @@ -75,14 +76,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 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. +### -Pattern +A regular expression that caller or callee number must match in order for this rule to be applied. ```yaml Type: String @@ -96,13 +97,13 @@ 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. +### -Translation +The regular expression pattern that will be applied to the number to convert it. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -111,13 +112,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -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: cf +Aliases: wi Required: False Position: Named @@ -136,10 +137,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstranslationrule) -[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstranslationrule) -[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamstranslationrule) -[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUnassignedNumberTreatment.md similarity index 72% rename from teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsUnassignedNumberTreatment.md index 75ea8483a8..78d34f0671 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUnassignedNumberTreatment.md @@ -1,166 +1,217 @@ ---- -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 -title: Set-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsTeamsUnassignedNumberTreatment - -## 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 - -``` -Set-CsTeamsUnassignedNumberTreatment [[-Identity] ] [-Description ] [-Pattern ] [-Target ] [-TargetType ] - [-TreatmentPriority ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet changes a treatment for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa2@contoso.com).ObjectId -Set-CsTeamsUnassignedNumberTreatment -Identity MainAA -Target $RAObjectId -``` -This example changes the treatment MainAA to route the calls to the resource account aa2@contoso.com. - -### Example 2 -```powershell -$UserObjectId = (Get-CsOnlineUser -Identity user2@contoso.com).Identity -Set-CsTeamsUnassignedNumberTreatment -Identity User2PSTN -TargetType User -Target $UserObjectId -``` -This example changes the treatment User2PSTN to route the calls to the user user2@contoso.com. - -## PARAMETERS - -### -Description -Free format description of this treatment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Id of the specific treatment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern -A regular expression that the called number must match in order for the treatment to take effect. It is best 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: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetType -The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatmentPriority -The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - -```yaml -Type: System.Integer -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 - -### System.Object - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.5.1 or later. - -Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. - -To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. - -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 -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/teams/import-csonlineaudiofile) - -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) - -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) - -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) - -[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment +schema: 2.0.0 +title: Set-CsTeamsUnassignedNumberTreatment +--- + +# Set-CsTeamsUnassignedNumberTreatment + +## 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 + +``` +Set-CsTeamsUnassignedNumberTreatment [-Description ] [[-Identity] ] [-Pattern ] + [-Target ] [-TargetType ] [-TreatmentPriority ] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet changes a treatment for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa2@contoso.com).ObjectId +Set-CsTeamsUnassignedNumberTreatment -Identity MainAA -Target $RAObjectId +``` +This example changes the treatment MainAA to route the calls to the resource account aa2@contoso.com. + +### Example 2 +```powershell +$UserObjectId = (Get-CsOnlineUser -Identity user2@contoso.com).Identity +Set-CsTeamsUnassignedNumberTreatment -Identity User2PSTN -TargetType User -Target $UserObjectId +``` +This example changes the treatment User2PSTN to route the calls to the user user2@contoso.com. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free format description of this treatment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the specific treatment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: System.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 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 +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetType +The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatmentPriority +The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + +```yaml +Type: System.Int32 +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: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. + +To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. + +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 +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/microsoftteams/import-csonlineaudiofile) + +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment) + +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment) + +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment) + +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpdateManagementPolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpdateManagementPolicy.md index 4567271d50..0adf083515 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: gnamun +Module Name: MicrosoftTeams +ms.author: vargasj +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsupdatemanagementpolicy +schema: 2.0.0 +title: Set-CsTeamsUpdateManagementPolicy --- # Set-CsTeamsUpdateManagementPolicy @@ -41,41 +42,6 @@ In this example, the policy "Campaign Policy" is modified, disabling the in-prod ## 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. @@ -165,6 +131,21 @@ Accept 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 policy. For example, the Description might indicate the users the policy should be assigned to. @@ -181,12 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateDayOfWeek +### -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: - Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. +| ID | Campaign Category | +| -- | -- | +| 91382d07-8b89-444c-bbcb-cfe43133af33 | What's New | +| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | ```yaml -Type: Int64 +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) Aliases: @@ -197,15 +182,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTime +### -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. -Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. +```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 +``` + +### -OCDIRedirect +This setting controls whether users are redirected from teams.microsoft.com to the unified domain teams.cloud.microsoft. Possible values are: +- **Microsoft Default**, Microsoft will manage redirection behavior. If no explicit admin configuration is set, users may be redirected automatically. +- **Disabled**, Users will remain on teams.microsoft.com. Use this if your organization's apps are incompatible with the unified domain. +- **Enabled**, Users will be redirected to teams.cloud.microsoft. Use this only if your organization had previously opted out of redirection and now wants to opt back in. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + Required: False Position: Named Default value: None @@ -213,12 +229,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTimeOfDay +### -UpdateDayOfWeek -Machine local time. Can be set only when AllowManagedUpdates is set to True + Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. ```yaml -Type: DateTime +Type: Int64 Parameter Sets: (All) Aliases: @@ -229,14 +245,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNewTeamsClient +### -UpdateTime -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. +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. ```yaml Type: String @@ -250,11 +261,12 @@ 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. +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) Aliases: @@ -265,16 +277,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The unique identifier of the policy. +### -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: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpgradeConfiguration.md similarity index 86% rename from teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpgradeConfiguration.md index 001f0dbe19..26d730b4a6 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpgradeConfiguration.md @@ -1,15 +1,17 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsupgradeconfiguration schema: 2.0.0 +title: Set-CsTeamsUpgradeConfiguration --- # 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. +Manage certain aspects of client behavior for users being upgraded from Skype for Business to Teams. ## SYNTAX @@ -43,14 +45,15 @@ The above cmdlet specifies that users subject to upgrade should download Teams i ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -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: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -59,44 +62,51 @@ 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. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: True +Default value: None 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. + +### -DownloadTeams + +> Applicable: Microsoft Teams + +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: string +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: NativeLimitedClient +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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 @@ -106,13 +116,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + For internal use only. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -121,31 +133,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal use only. +### -SfBMeetingJoinUx + +> Applicable: Microsoft Teams + +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: Guid +Type: string Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: NativeLimitedClient Accept pipeline input: False Accept wildcard characters: False ``` +### -Tenant -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +> Applicable: Microsoft Teams + +For internal use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -154,15 +168,17 @@ 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 - +### -WhatIf + +> Applicable: Microsoft Teams + +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: Named @@ -187,10 +203,10 @@ 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-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradeconfiguration) -[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradepolicy) -[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/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/MicrosoftTeams/Set-CsTeamsVdiPolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsVdiPolicy.md index 5c21d8c52c..d853f4cc48 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVdiPolicy.md @@ -1,165 +1,164 @@ ---- -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 +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cteamsvdipolicy +schema: 2.0.0 +title: Set-CsTeamsVdiPolicy +--- + +# Set-CsTeamsVdiPolicy + +## SYNOPSIS +The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. + +## 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. + +## 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/MicrosoftTeams/Set-CsTeamsVirtualAppointmentsPolicy.md similarity index 86% rename from teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsVirtualAppointmentsPolicy.md index 363ba6ac2f..920e382332 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy -title: Set-CsTeamsVirtualAppointmentsPolicy -schema: 2.0.0 -author: emmanuelrocha001 ms.author: erocha -manager: sonaggarwal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy +schema: 2.0.0 +title: Set-CsTeamsVirtualAppointmentsPolicy --- # Set-CsTeamsVirtualAppointmentsPolicy @@ -52,13 +53,15 @@ Accept wildcard characters: False ``` ### -EnableSmsNotifications + +> Applicable: Microsoft Teams + This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment template meeting. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -126,10 +129,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy) -[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVoiceApplicationsPolicy.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsVoiceApplicationsPolicy.md index 681eef77f1..00e6906d85 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy -title: Set-CsTeamsVoiceApplicationsPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy schema: 2.0.0 +title: Set-CsTeamsVoiceApplicationsPolicy --- # Set-CsTeamsVoiceApplicationsPolicy @@ -74,9 +75,9 @@ The command shown in Example 1 sets allowing CQ overflow shared voicemail greeti ## PARAMETERS -### -AllowAutoAttendantBusinessHoursGreetingChange +### -AllowAutoAttendantAfterHoursGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. ```yaml Type: Boolean @@ -90,9 +91,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursGreetingChange +### -AllowAutoAttendantAfterHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. ```yaml Type: Boolean @@ -106,9 +107,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayGreetingChange +### -AllowAutoAttendantBusinessHoursChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. ```yaml Type: Boolean @@ -122,9 +123,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursChange +### -AllowAutoAttendantBusinessHoursGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -138,9 +139,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidaysChange +### -AllowAutoAttendantBusinessHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. ```yaml Type: Boolean @@ -154,11 +155,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantTimeZoneChange - -_This option is not currently available in Queues app._ +### -AllowAutoAttendantHolidayGreetingChange -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. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. ```yaml Type: Boolean @@ -172,11 +171,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantLanguageChange - -_This option is not currently available in Queues app._ +### -AllowAutoAttendantHolidayRoutingChange -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. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. ```yaml Type: Boolean @@ -190,9 +187,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursRoutingChange +### -AllowAutoAttendantHolidaysChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. ```yaml Type: Boolean @@ -206,9 +203,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursRoutingChange +### -AllowAutoAttendantLanguageChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. ```yaml Type: Boolean @@ -222,9 +221,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayRoutingChange +### -AllowAutoAttendantTimeZoneChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. ```yaml Type: Boolean @@ -238,9 +239,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange +### -AllowCallQueueAgentOptChange -When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. ```yaml Type: Boolean @@ -254,9 +255,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMusicOnHoldChange +### -AllowCallQueueConferenceModeChange -When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. ```yaml Type: Boolean @@ -270,9 +271,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowSharedVoicemailGreetingChange +### -AllowCallQueueLanguageChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. ```yaml Type: Boolean @@ -286,9 +289,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutSharedVoicemailGreetingChange +### -AllowCallQueueMembershipChange -When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. ```yaml Type: Boolean @@ -302,11 +305,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentSharedVoicemailGreetingChange - -_This option is not currently available in Queues app._ +### -AllowCallQueueMusicOnHoldChange -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. +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -320,11 +321,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange -_This option is not currently available in Queues app._ +_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. +When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. ```yaml Type: Boolean @@ -338,9 +339,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMembershipChange +### -AllowCallQueueNoAgentsRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -354,9 +355,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +### -AllowCallQueueOptOutChange -When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. ```yaml Type: Boolean @@ -370,9 +371,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueRoutingMethodChange +### -AllowCallQueueOverflowRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. ```yaml Type: Boolean @@ -386,9 +387,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueuePresenceBasedRoutingChange +### -AllowCallQueueOverflowSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -402,9 +403,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOptOutChange +### -AllowCallQueuePresenceBasedRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. +When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. ```yaml Type: Boolean @@ -418,9 +419,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowRoutingChange +### -AllowCallQueueRoutingMethodChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. ```yaml Type: Boolean @@ -450,9 +451,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentsRoutingChange +### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -466,9 +467,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueAgentOptChange +### -AllowCallQueueWelcomeGreetingChange -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. +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -484,7 +485,7 @@ Accept wildcard characters: False ### -CallQueueAgentMonitorMode -_This option is not currently available in Queues app._ +> Applicable: Microsoft Teams PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover @@ -502,7 +503,6 @@ When set to `Takeover`, users affected by the policy will be allowed to monitor Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -513,7 +513,7 @@ Accept wildcard characters: False ### -CallQueueAgentMonitorNotificationMode -_This option is not currently available in Queues app._ +> Applicable: Microsoft Teams PARAMVALUE: Disabled | Agent @@ -525,7 +525,6 @@ When set to `Agent`, users affected by the policy will be allowed to monitor age Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -534,22 +533,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAutoAttendantMetricsPermission - -PARAMVALUE: Disabled | AuthorizedOnly | All - -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. - -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. +### -Confirm -> [!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. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Object -Parameter Sets: Dual -Aliases: -applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -558,22 +549,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeCallQueueMetricsPermission +### -HistoricalAgentMetricsPermission + +> Applicable: Microsoft Teams 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 `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 real-time metrics for call queues they are authorized for. +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. -> [!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. +When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -582,22 +573,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAgentMetricsPermission +### -HistoricalAutoAttendantMetricsPermission + +> Applicable: Microsoft Teams 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 `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 real-time metrics for agents who are members in the call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` will not be able to access real-time metrics. +When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -606,21 +597,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalAutoAttendantMetricsPermission +### -HistoricalCallQueueMetricsPermission + +> Applicable: Microsoft Teams 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 `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 auto attendants they are authorized for. +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 auto attendants in the organization. +When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -629,44 +621,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalCallQueueMetricsPermission +### -Identity -PARAMVALUE: Disabled | AuthorizedOnly | All +Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: -When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. +-Identity global -When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. +To refer to a per-user policy, use syntax similar to this: -When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. +-Identity "SDA-Allow-All" + +If you do not specify an Identity, then the `Set-CsTeamsVoiceApplicationsPolicy` cmdlet will modify the global policy. ```yaml -Type: Object -Parameter Sets: Dual +Type: String +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalAgentMetricsPermission +### -RealTimeAgentMetricsPermission + +> Applicable: Microsoft Teams 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 `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 historical metrics for agents who are members in the call queues they are authorized for. +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 historical 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: Microsoft Teams Required: False Position: Named @@ -675,39 +670,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity +### -RealTimeAutoAttendantMetricsPermission -Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: +> Applicable: Microsoft Teams --Identity global +PARAMVALUE: Disabled | AuthorizedOnly | All -To refer to a per-user policy, use syntax similar to this: +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. --Identity "SDA-Allow-All" +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. -If you do not specify an Identity, then the `Set-CsTeamsVoiceApplicationsPolicy` cmdlet will modify the global policy. +> [!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: String -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -RealTimeCallQueueMetricsPermission -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +> Applicable: Microsoft Teams + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` will not be able to access real-time metrics. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: Object +Parameter Sets: Dual +Aliases: Required: False Position: Named @@ -716,14 +720,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -WhatIf -Prompts you for confirmation before running the cmdlet. +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -746,10 +751,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy) -[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy) -[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLoadPolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLoadPolicy.md index 1db49482a3..74dcf437f0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLoadPolicy.md @@ -1,239 +1,240 @@ ---- -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) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworkloadpolicy +schema: 2.0.0 +title: Set-CsTeamsWorkLoadPolicy +--- + +# 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/microsoftteams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLocationDetectionPolicy.md similarity index 88% rename from teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLocationDetectionPolicy.md index 176485db17..a00018cf97 100644 --- a/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur 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 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy +schema: 2.0.0 +title: Set-CsTeamsWorkLocationDetectionPolicy --- # Set-CsTeamsWorkLocationDetectionPolicy @@ -127,10 +128,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy) -[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy) -[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy) -[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers.md index 616604a4f9..05aba88905 100644 --- a/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantblockedcallingnumbers +schema: 2.0.0 +title: Set-CsTenantBlockedCallingNumbers --- # Set-CsTenantBlockedCallingNumbers @@ -45,28 +47,28 @@ To get the current tenant blocked calling numbers setting, use Get-CsTenantBlock ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTenantBlockedCallingNumbers -Enabled $false ``` This example turns off the tenant blocked calling numbers setting. No inbound number will be blocked from this feature. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsTenantBlockedCallingNumbers -Enabled $true ``` This example turns on the tenant blocked calling numbers setting. Inbound calls will be blocked based on the list of blocked number patterns. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsTenantBlockedCallingNumbers -Name "MyCustomBlockedCallingNumbersName" ``` This example renames the current blocked calling numbers with "MyCustomBlockedCallingNumbersName". No change is made besides the Name field change. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsTenantBlockedCallingNumbers -InboundBlockedNumberPatterns @((New-CsInboundBlockedNumberPattern -Name "AnonymousBlockedPattern" -Enabled $true -Pattern "^(?!)Anonymous")) ``` @@ -77,21 +79,6 @@ 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. @@ -137,6 +124,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -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 +``` + ### -InboundBlockedNumberPatterns The InboundBlockedNumberPatterns parameter contains the list of InboundBlockedNumberPatterns. @@ -242,6 +244,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Set-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantDialPlan.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantDialPlan.md index 1df48b83dc..0a54df8656 100644 --- a/teams/teams-ps/teams/Set-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan applicable: Microsoft Teams -title: Set-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan +schema: 2.0.0 +title: Set-CsTenantDialPlan --- # Set-CsTenantDialPlan @@ -67,13 +68,15 @@ Finally, we pass the variable back to the NormalizationRules parameter of the `S ## PARAMETERS ### -Confirm + +> Applicable: Microsoft Teams + 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 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. Maximum characters is 1040. @@ -90,7 +96,6 @@ Maximum characters is 1040. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -116,8 +123,11 @@ Accept wildcard characters: False ``` ### -NormalizationRules + +> Applicable: Microsoft Teams + The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. -Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet, which creates the rule and assigns it to the specified tenant dial plan. +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/microsoftteams/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. @@ -125,7 +135,6 @@ The number of normalization rules cannot exceed 50 per TenantDialPlan. Type: List Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -SimpleName + +> Applicable: Microsoft Teams + The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. This string can be up to 49 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), and parentheses (()). @@ -143,7 +155,6 @@ This string can be up to 49 characters long. Valid characters are alphabetic or Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -153,13 +164,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -181,10 +194,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cstenantdialplan) -[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan) -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan) -[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantdialplan) diff --git a/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantFederationConfiguration.md similarity index 84% rename from teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantFederationConfiguration.md index c820afa22f..cdc8e8077b 100644 --- a/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantFederationConfiguration.md @@ -1,21 +1,22 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: williamlooney ms.date: 12/11/2024 +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration +schema: 2.0.0 +title: Set-CsTenantFederationConfiguration --- # Set-CsTenantFederationConfiguration ## SYNOPSIS 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. ## SYNTAX @@ -23,9 +24,10 @@ These settings are used to determine which domains (if any) your users are allow ``` Set-CsTenantFederationConfiguration [-Tenant ] [-AllowedDomains ] [-BlockedDomains ] [-BlockAllSubdomains ] - [-AllowFederatedUsers ] [-AllowPublicUsers ] [-AllowTeamsConsumer ] [-AllowTeamsConsumerInbound ] + [-AllowFederatedUsers ] [-AllowTeamsConsumer ] [-AllowTeamsConsumerInbound ] [-TreatDiscoveredPartnersAsUnverified ] [-SharedSipAddressSpace ] [-RestrictTeamsConsumerToExternalUserProfiles ] - [-AllowedDomainsAsAList ] [-ExternalAccessWithTrialTenants ] [-CustomizeFederation ] + [-AllowedDomainsAsAList ] [-ExternalAccessWithTrialTenants ] + [-DomainBlockingForMDOAdminsInTeams ] [-AllowedTrialTenantDomains ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -33,12 +35,15 @@ Set-CsTenantFederationConfiguration [-Tenant ] ### Instance ``` Set-CsTenantFederationConfiguration [-Tenant ] [-AllowedDomains ] - [-BlockedDomains ] [-BlockAllSubdomains ] [-AllowFederatedUsers ] [-AllowPublicUsers ] + [-BlockedDomains ] [-BlockAllSubdomains ] [-AllowFederatedUsers ] [-TreatDiscoveredPartnersAsUnverified ] [-SharedSipAddressSpace ] [-RestrictTeamsConsumerToExternalUserProfiles ] - [-AllowedDomainsAsAList ] [-CustomizeFederation ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] + [-AllowedDomainsAsAList ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION +> [!NOTE] +> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter AllowPublicUsers can no longer be used. + Federation is a service that enables users to exchange IM and presence information with users from other domains. With Skype for Business Online, administrators can use the federation configuration settings to govern: @@ -52,28 +57,21 @@ However, administrators must use the `Set-CsTenantPublicProvider` cmdlet in orde ## EXAMPLES -### -------------------------- Example 1 -------------------------- -``` -Set-CsTenantFederationConfiguration -AllowPublicUsers $False -``` - -The command shown in Example 1 disables communication with public providers for the current tenant. - -### -------------------------- Example 2 -------------------------- +### Example 1 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" Set-CsTenantFederationConfiguration -BlockedDomains @{Replace=$x} ``` -In Example 2, the domain fabrikam.com is assigned as the only domain on the blocked domains list for current tenant. +In Example 1, the domain fabrikam.com is assigned as the only domain on the blocked domains list for current tenant. To do this, the first command in the example uses the `New-CsEdgeDomainPattern` cmdlet to create a new domain object for fabrikam.com. 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 -------------------------- +### Example 3 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -86,7 +84,7 @@ 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 -------------------------- +### Example 4 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -99,7 +97,7 @@ 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 -------------------------- +### Example 5 ``` Set-CsTenantFederationConfiguration -BlockedDomains $Null ``` @@ -108,7 +106,7 @@ Example 5 shows how you can remove all the domains assigned to the blocked domai To do this, simply include the BlockedDomains parameter and set the parameter value to null ($Null). When this command completes, the blocked domain list will be cleared. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -120,7 +118,7 @@ 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 -------------------------- +### Example 7 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -131,7 +129,7 @@ Set-CsTenantFederationConfiguration -AllowedDomainsAsAList @{Add=$list} Example 7 shows how you can add domains to the existing Allowed Domains using a List object. First, a List is created and domains are added to it, then use the Add method in the AllowedDomainsAsAList 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 AllowedDomains list. -### -------------------------- Example 8 -------------------------- +### Example 8 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -142,14 +140,14 @@ Set-CsTenantFederationConfiguration -AllowedDomainsAsAList @{Remove=$list} Example 8 shows how you can remove domains from the existing Allowed Domains using a List object. First, a List is created and domains are added to it, then use the Remove method in the AllowedDomainsAsAList 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 AllowedDomains list. -### -------------------------- Example 9 -------------------------- +### Example 9 ``` Set-CsTenantFederationConfiguration -AllowTeamsConsumer $True -AllowTeamsConsumerInbound $False ``` 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 ------------------------- +### Example 10 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -165,14 +163,14 @@ When the BlockAllSubdomains is enabled, all users from all subdomains of all dom 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 ------------------------- +### 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 -------------------------- +### Example 12 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -185,7 +183,16 @@ Using the `AllowedTrialTenantDomains` parameter, you can whitelist specific "tri 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 -------------------------- +### 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") @@ -193,11 +200,11 @@ $list.add("contoso.com") Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Add=$list} ``` -Example 13 shows how you can add domains to the existing Allowed Trial Tenant Domains using a List collection object. +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 14 -------------------------- +### Example 15 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -205,20 +212,21 @@ $list.add("contoso.com") Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Remove=$list} ``` -Example 14 shows how you can remove domains from the existing Allowed Trial Tenant Domains using a List collection object. +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. -### -------------------------- Example 15 ------------------------- +### Example 16 ``` -Set-CsTenantFederationConfiguration -CustomizeFederation $True +Set-CsTenantFederationConfiguration -DomainBlockingForMDOAdminsInTeams "Enabled" ``` -Example 15 shows how you can enable the feature where you can customize your federation in ExternalAccessPolicy. - ## PARAMETERS ### -AllowedDomains + +> Applicable: Microsoft Teams + Domain objects (created by using the `New-CsEdgeAllowList` cmdlet or the `New-CsEdgeAllowAllKnownDomains` cmdlet) that represent the domains that users are allowed to communicate with. If the `New-CsEdgeAllowAllKnownDomains` cmdlet is used then users can communicate with any domain that does not appear on the blocked domains list. If the `New-CsEdgeAllowList` cmdlet is used then users can only communicate with domains that have been added to the allowed domains list. @@ -232,7 +240,6 @@ The AllowedDomains parameter can support up to 4,000 domains. Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -241,15 +248,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowFederatedUsers -When set to True (the default value) users will be potentially allowed to communicate with users from other domains. -If this property is set to False then users cannot communicate with users from other domains regardless of the values assigned to the AllowedDomains and BlockedDomains properties. +### -AllowedDomainsAsAList + +> Applicable: Microsoft Teams + +You can specify allowed domains using a List object that contains the domains that users are allowed to communicate with. See Examples section. ```yaml -Type: Boolean +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -258,15 +266,21 @@ 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. +### -AllowedTrialTenantDomains + +> Applicable: Microsoft Teams + +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: Boolean +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -274,8 +288,13 @@ 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. + +### -AllowFederatedUsers + +> Applicable: Microsoft Teams + +When set to True (the default value) users will be potentially allowed to communicate with users from other domains. +If this property is set to False then users cannot communicate with users from other domains regardless of the values assigned to the AllowedDomains and BlockedDomains properties. ```yaml Type: Boolean @@ -284,13 +303,13 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTeamsConsumerInbound -Allows people using Teams with an account that's not managed by an organization, to discover and start communication with users in your organization. When -AllowTeamsConsumer is enabled and this parameter is disabled, only the users in your organization will be able to discover and start communication with people using Teams with an account that's not managed by an organization, but they will not discover and start communications with users in your organization. +### -AllowTeamsConsumer +Allows federation with people using Teams with an account that's not managed by an organization. ```yaml Type: Boolean @@ -304,25 +323,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockedDomains -If the AllowedDomains property has been set to AllowAllKnownDomains, then users will be allowed to communicate with users from any domain except domains that appear in the blocked domains list. -If the AllowedDomains property has not been set to AllowAllKnownDomains, then the blocked list is ignored, and users can only communicate with domains that have been expressly added to the allowed domains list. -The BlockedDomains parameter can support up to 4,000 domains. +### -AllowTeamsConsumerInbound +Allows people using Teams with an account that's not managed by an organization, to discover and start communication with users in your organization. When -AllowTeamsConsumer is enabled and this parameter is disabled, only the users in your organization will be able to discover and start communication with people using Teams with an account that's not managed by an organization, but they will not discover and start communications with users in your organization. ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### -BlockAllSubdomains + +> Applicable: Skype for Business Online + 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. @@ -332,7 +351,6 @@ But all subdomains for domains in this list will also be blocked. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -341,14 +359,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -BlockedDomains + +> Applicable: Microsoft Teams + +If the AllowedDomains property has been set to AllowAllKnownDomains, then users will be allowed to communicate with users from any domain except domains that appear in the blocked domains list. +If the AllowedDomains property has not been set to AllowAllKnownDomains, then the blocked list is ignored, and users can only communicate with domains that have been expressly added to the allowed domains list. +The BlockedDomains parameter can support up to 4,000 domains. ```yaml -Type: SwitchParameter +Type: List Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -357,14 +379,16 @@ 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. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -373,35 +397,39 @@ 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: +### -DomainBlockingForMDOAdminsInTeams -`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` +> Applicable: Microsoft Teams + +When set to 'Enabled', security operations team will be able to add domains to the blocklist on security portal. +When set to 'Disabled', security operations team will not have permissions to update the domains blocklist. ```yaml -Type: XdsIdentity +Type: DomainBlockingForMDOAdminsInTeamsType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 2 +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. +### -ExternalAccessWithTrialTenants + +> Applicable: Microsoft Teams + +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: PSObject +Type: ExternalAccessWithTrialTenantsType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -410,15 +438,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharedSipAddressSpace -When set to True, indicates that the users homed on Skype for Business Online use the same SIP domain as users homed on the on-premises version of Skype for Business Server. -The default value is False, meaning that the two sets of users have different SIP domains. +### -Force + +> Applicable: Microsoft Teams + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -427,43 +456,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose federation settings are being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -Identity -You can return your tenant ID by running this command: +> Applicable: Microsoft Teams -`Get-CsTenant | Select-Object DisplayName, TenantID` +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: -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. +`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` ```yaml -Type: Guid +Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TreatDiscoveredPartnersAsUnverified -When set to True, messages sent from discovered partners are considered unverified. -That means that those messages will be delivered only if they were sent from a person who is on the recipient's Contacts list. -The default value is False ($False). +### -Instance + +> Applicable: Microsoft Teams + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean +Type: PSObject Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -472,14 +497,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedDomainsAsAList -You can specify allowed domains using a List object that contains the domains that users are allowed to communicate with. See Examples section. +### -RestrictTeamsConsumerToExternalUserProfiles +Defines if a user is restricted to collaboration with Teams Consumer (TFL) user only in Extended Directory. +Possible values: True, False ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -488,18 +513,17 @@ 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. +### -SharedSipAddressSpace -Allowed - Communication with other tenants is allowed based on other settings. +> Applicable: Microsoft Teams -Blocked - Communication with users in tenants that contain only trial licenses will be blocked. +When set to True, indicates that the users homed on Skype for Business Online use the same SIP domain as users homed on the on-premises version of Skype for Business Server. +The default value is False, meaning that the two sets of users have different SIP domains. ```yaml -Type: ExternalAccessWithTrialTenantsType +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -508,33 +532,25 @@ 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. +### -Tenant -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. +> Applicable: Microsoft Teams -```yaml -Type: List -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Globally unique identifier (GUID) of the tenant account whose federation settings are being modified. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -RestrictTeamsConsumerToExternalUserProfiles -Defines if a user is restriced to collaboration with Teams Consumer (TFL) user only in Extended Directory. -Possible values: True, False +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: @@ -545,9 +561,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomizeFederation -Defines if we enable more customized federation settings in ExternalAccessPolicy or not. For example, when this is true, if the `AllowedDomains` includes [a.com, b.com], but the `AllowedExternalDomains` of the ExternalAccessPolicy includes [c.com], then users assigned by the ExternalAccessPolicy will only be allowed to access c.com, all other users will have access to a.com and b.com as defined in `AllowedDomains`. -Possible values: True, False +### -TreatDiscoveredPartnersAsUnverified + +> Applicable: Microsoft Teams + +When set to True, messages sent from discovered partners are considered unverified. +That means that those messages will be delivered only if they were sent from a person who is on the recipient's Contacts list. +The default value is False ($False). ```yaml Type: Boolean @@ -556,19 +576,21 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + 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 @@ -595,4 +617,4 @@ Instead, the `Set-CsTenantFederationConfiguration` cmdlet modifies existing inst ## RELATED LINKS -[Get-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantfederationconfiguration) +[Get-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantMigrationConfiguration.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantMigrationConfiguration.md index 9008b4da94..9a171130ab 100644 --- a/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantMigrationConfiguration.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantmigrationconfiguration +schema: 2.0.0 +title: Set-CsTenantMigrationConfiguration --- # Set-CsTenantMigrationConfiguration @@ -45,7 +47,7 @@ For more information, see [Using the Meeting Migration Service (MMS)](https://le ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTenantMigrationConfiguration -MeetingMigrationEnabled $false ``` @@ -54,31 +56,34 @@ This example disables MMS in the organization. ## PARAMETERS -### -Identity -Unique identifier for the Migration Configuration. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: -applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf 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 + +> Applicable: Microsoft Teams + +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 -Parameter Sets: Instance +Type: SwitchParameter +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -87,30 +92,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity + +> Applicable: Microsoft Teams + +Unique identifier for the Migration Configuration. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Type: String +Parameter Sets: Identity +Aliases: 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 + +> Applicable: Microsoft Teams + +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) +Type: PSObject +Parameter Sets: Instance Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -120,13 +130,15 @@ Accept wildcard characters: False ``` ### -MeetingMigrationEnabled + +> Applicable: Microsoft Teams + Set this to false to disable the Meeting Migration Service. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -136,6 +148,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + Globally unique identifier (GUID) of the tenant account whose Migration Configurations are being created. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" @@ -148,7 +163,6 @@ Get-CsTenant | Select-Object DisplayName, TenantID Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -158,13 +172,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkRegion.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkRegion.md index 7ec40da511..d15b9c716d 100644 --- a/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkRegion.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion applicable: Microsoft Teams -title: Set-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworkregion +schema: 2.0.0 +title: Set-CsTenantNetworkRegion --- # Set-CsTenantNetworkRegion ## SYNOPSIS -As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. +Changes the definintion of network regions. ## SYNTAX @@ -24,6 +25,8 @@ Set-CsTenantNetworkRegion [[-Identity] ] [-CentralSite ] [-Descr ``` ## DESCRIPTION +As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. + Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. ## EXAMPLES @@ -37,12 +40,12 @@ The command shown in Example 1 sets the network region 'RegionA' with the descri ## PARAMETERS -### -Identity -Unique identifier for the network region to be set. +### -CentralSite +This parameter is not used. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: (All) Aliases: Required: False @@ -52,13 +55,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CentralSite -This parameter is not used. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -82,12 +85,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -The name of the network region. Not required in this PowerShell command. +### -Identity +Unique identifier for the network region to be set. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Required: False @@ -97,13 +100,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkRegionID +The name of the network region. Not required in this PowerShell command. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -142,8 +145,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworkregion) -[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworkregion) -[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSite.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSite.md index 9f97f7495e..97f473ae54 100644 --- a/teams/teams-ps/teams/Set-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSite.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite applicable: Microsoft Teams -title: Set-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksite +schema: 2.0.0 +title: Set-CsTenantNetworkSite --- # Set-CsTenantNetworkSite ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, Set-CsTenantNetworkSite to define network sites. Network sites are defined as a collection of IP subnets. Each network site must be associated with a network region. Tenant network site is used for Location Based Routing. +Changes the definition of network sites. ## SYNTAX @@ -56,13 +57,13 @@ The command shown in Example 3 sets the network site 'site3' with description 's ## PARAMETERS -### -Identity -Unique identifier for the network site to be set. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -131,8 +132,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationPolicy -This parameter is reserved for internal Microsoft use. +### -Identity +Unique identifier for the network site to be set. ```yaml Type: String @@ -146,8 +147,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -NetworkRegionID is the identifier for the network region which the current network site is associating to. +### -LocationPolicy +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -161,8 +162,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRoamingPolicy -NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. +### -NetworkRegionID +NetworkRegionID is the identifier for the network region which the current network site is associating to. ```yaml Type: String @@ -176,13 +177,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkRoamingPolicy +NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -220,8 +221,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksite) -[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksite) -[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSubnet.md similarity index 89% rename from teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSubnet.md index 52e3aea595..68cfec5f4c 100644 --- a/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSubnet.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet applicable: Microsoft Teams -title: Set-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksubnet +schema: 2.0.0 +title: Set-CsTenantNetworkSubnet --- # Set-CsTenantNetworkSubnet ## SYNOPSIS -As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkSubnet to define network subnets and assign them to network sites. Each internal subnet may only be associated with one site. The organization's network subnet is used for Location-Based Routing. +Changes the definition of network subnets. ## SYNTAX @@ -48,16 +49,16 @@ IPv6 format subnet accepts maskbits from 0 to 128 inclusive. ## PARAMETERS -### -Identity -Unique identifier for the network subnet to be set. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -78,28 +79,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaskBits -This parameter determines the length of bits to mask to the subnet. - -IPv4 format subnet accepts maskbits from 0 to 32 inclusive. IPv6 format subnet accepts maskbits from 0 to 128 inclusive. +### -Identity +Unique identifier for the network subnet to be set. ```yaml -Type: Int32 -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID -NetworkSiteID is the identifier for the network site which the current network subnet is associating to. +### -MaskBits +This parameter determines the length of bits to mask to the subnet. + +IPv4 format subnet accepts maskbits from 0 to 32 inclusive. IPv6 format subnet accepts maskbits from 0 to 128 inclusive. ```yaml -Type: String +Type: Int32 Parameter Sets: (All) Aliases: @@ -110,13 +111,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkSiteID +NetworkSiteID is the identifier for the network site which the current network subnet is associating to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -150,8 +151,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksubnet) -[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksubnet) -[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksubnet) diff --git a/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantTrustedIPAddress.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantTrustedIPAddress.md index 8e93bf341c..fe867e81e1 100644 --- a/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantTrustedIPAddress.md @@ -1,19 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenanttrustedipaddress +schema: 2.0.0 +title: Set-CsTenantTrustedIPAddress --- # Set-CsTenantTrustedIPAddress ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, Set-CsTenantTrustedIPAddress to define external subnets and assign them to the tenant. You can define an unlimited number of external subnets for a tenant. +Changes the definition of network IP addresses. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsUser.md b/teams/teams-ps/MicrosoftTeams/Set-CsUser.md similarity index 87% rename from teams/teams-ps/teams/Set-CsUser.md rename to teams/teams-ps/MicrosoftTeams/Set-CsUser.md index 97f1298690..8bf3dfd394 100644 --- a/teams/teams-ps/teams/Set-CsUser.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsUser.md @@ -1,23 +1,21 @@ --- -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 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csuser +schema: 2.0.0 +title: Set-CsUser --- # 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 @@ -31,6 +29,11 @@ Set-CsUser [-DomainController ] [-Identity] [-PassThru] ``` ## DESCRIPTION +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/microsoftteams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) cmdlets instead. + 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. @@ -42,7 +45,7 @@ You should not attempt to manually configure these attributes. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Set-CsUser -Identity "Pilar Ackerman" -EnterpriseVoiceEnabled $True ``` @@ -51,7 +54,7 @@ In Example 1, the `Set-CsUser` cmdlet is used to modify the user account with th 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 -------------------------- +### Example 2 ```powershell Get-CsUser -LdapFilter "Department=Finance" | Set-CsUser -EnterpriseVoiceEnabled $True ``` @@ -60,7 +63,7 @@ In Example 2, all the users in the Finance department have their accounts enable 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 -------------------------- +### Example 3 ```powershell Set-CsUser -Identity "Pilar Ackerman" -LineUri "tel:+123456789" ``` @@ -70,28 +73,29 @@ In this case, the account is modified to set the phone number assigned to the us ## 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. +### -AcpInfo -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". +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: UserIdParameter +Type: AcpInfo 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 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -AudioVideoDisabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -103,7 +107,43 @@ You cannot disable A/V communications if a user is currently enabled for remote 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 +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: Required: False Position: Named @@ -113,6 +153,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -125,7 +168,6 @@ When you run the `Disable-CsUser` cmdlet, all the Skype for Business Server data 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 @@ -134,15 +176,19 @@ 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. +### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +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/microsoftteams/set-csphonenumberassignment) cmdlet instead. ```yaml -Type: Fqdn +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 @@ -151,17 +197,25 @@ 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. +### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the user's instant messaging sessions are archived. +Allowed values are: -**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. +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving ```yaml -Type: Boolean +Type: ExchangeArchivingPolicyOptionsEnum 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 @@ -171,6 +225,9 @@ Accept wildcard characters: False ``` ### -HostedVoiceMail + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -180,7 +237,6 @@ In addition, setting this option to True enables Skype for Business users to dir 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 @@ -189,36 +245,33 @@ 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. +### -Identity -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. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -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. +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. -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 +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: String +Type: UserIdParameter 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 +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -LineServerURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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 @@ -227,7 +280,6 @@ For example: sip:rccgateway@litwareinc.com 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 @@ -236,20 +288,29 @@ 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. +### -LineURI -The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. -For example: tel:+14255551297. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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 Required: False Position: Named @@ -258,38 +319,29 @@ 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. +### -OnPremLineURI -To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. +> Applicable: Microsoft Teams -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +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. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +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. -### -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`. +**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/microsoftteams/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: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -299,6 +351,9 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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. @@ -308,7 +363,6 @@ By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. 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 @@ -317,30 +371,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PrivateLine -```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 +> 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 -``` +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. -### -Confirm -Prompts you for confirmation before executing the command. +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: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -349,15 +395,23 @@ 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. +### -RemoteCallControlTelephonyEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +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: AcpInfo +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 @@ -366,23 +420,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the user's instant messaging sessions are archived. -Allowed values are: - -Uninitialized - -UseLyncArchivingPolicy +### -SipAddress -ArchivingToExchange +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -NoArchiving +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: ExchangeArchivingPolicyOptionsEnum +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -391,27 +439,16 @@ 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. +### -WhatIf -**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. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -439,4 +476,4 @@ The `Set-CsUser` cmdlet does not return any objects. ## RELATED LINKS -[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineuser) diff --git a/teams/teams-ps/teams/Set-CsUserCallingDelegate.md b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingDelegate.md similarity index 73% rename from teams/teams-ps/teams/Set-CsUserCallingDelegate.md rename to teams/teams-ps/MicrosoftTeams/Set-CsUserCallingDelegate.md index ac17aa7a8a..57879dac3b 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingDelegate.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingDelegate.md @@ -1,144 +1,164 @@ ---- -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 -title: Set-CsUserCallingDelegate -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsUserCallingDelegate - -## SYNOPSIS -This cmdlet will change permissions for a delegate for calling in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -```powershell -Set-CsUserCallingDelegate -Identity -Delegate [-MakeCalls ] [-ReceiveCalls ] [-ManageSettings ] [] -``` - -## DESCRIPTION -This cmdlet can change the permissions assigned to a delegate for the specified user. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $false -ReceiveCalls $true -ManageSettings $false -``` -This example shows setting the permissions for user1@contoso.com's delegate user2@contoso.com. - -### Example 2 -```powershell -Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -``` -This example shows setting the MakeCalls permissions to True for user1@contoso.com's delegate user2@contoso.com. - -## PARAMETERS - -### -Delegate -The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. - -A user can have up to 25 delegates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeCalls - -Specifies whether delegate is allowed to make calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: False -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManageSettings - -Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: False -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveCalls - -Specifies whether delegate is allowed to receive calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: False -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -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](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingdelegate +schema: 2.0.0 +title: Set-CsUserCallingDelegate +--- + +# Set-CsUserCallingDelegate + +## SYNOPSIS +This cmdlet will change permissions for a delegate for calling in Microsoft Teams. + +## SYNTAX + +``` +Set-CsUserCallingDelegate -Identity -Delegate [-MakeCalls ] + [-ManageSettings ] [-ReceiveCalls ] [-HttpPipelinePrepend ] + [] +``` + +## DESCRIPTION +This cmdlet can change the permissions assigned to a delegate for the specified user. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $false -ReceiveCalls $true -ManageSettings $false +``` +This example shows setting the permissions for user1@contoso.com's delegate user2@contoso.com. + +### Example 2 +```powershell +Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true +``` +This example shows setting the MakeCalls permissions to True for user1@contoso.com's delegate user2@contoso.com. + +## PARAMETERS + +### -Delegate +The Identity of the delegate to add. +Can be specified using the ObjectId or the SIP address. + +A user can have up to 25 delegates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeCalls + +Specifies whether delegate is allowed to make calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageSettings + +Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveCalls + +Specifies whether delegate is allowed to receive calls on behalf of the specified user. + +```yaml +Type: System.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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +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](https://learn.microsoft.com/powershell/module/microsoftteams/get-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Set-CsUserCallingSettings.md b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingSettings.md similarity index 82% rename from teams/teams-ps/teams/Set-CsUserCallingSettings.md rename to teams/teams-ps/MicrosoftTeams/Set-CsUserCallingSettings.md index 4b590f4ab2..e66b399f80 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingSettings.md @@ -1,414 +1,450 @@ ---- -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 -title: Set-CsUserCallingSettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsUserCallingSettings - -## SYNOPSIS -This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. - -## SYNTAX - -### Identity (Default) -```powershell -Set-CsUserCallingSettings -Identity [] -``` - -### ForwardingOnOff -```powershell -Set-CsUserCallingSettings -Identity -IsForwardingEnabled [] -``` - -### Forwarding -```powershell -Set-CsUserCallingSettings -Identity -IsForwardingEnabled -ForwardingType [-ForwardingTarget ] -ForwardingTargetType [] -``` - -### UnansweredOnOff -```powershell -Set-CsUserCallingSettings -Identity -IsUnansweredEnabled [] -``` - -### Unanswered -```powershell -Set-CsUserCallingSettings -Identity -IsUnansweredEnabled [-UnansweredTarget ] -UnansweredTargetType -UnansweredDelay [] -``` - -### CallGroup -```powershell -Set-CsUserCallingSettings -Identity -CallGroupOrder -CallGroupTargets [] -``` - -### CallGroupMembership -```powershell -Set-CsUserCallingSettings -Identity -GroupMembershipDetails [] -``` - -### CallGroupNotification -```powershell -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 -start by getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Voicemail -``` -This example shows setting immediate call forwarding to voicemail for user1@contoso.com. - -### Example 2 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $false -``` -This example shows removing call forwarding for user1@contoso.com. - -### Example 3 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Simultaneous -ForwardingTargetType SingleTarget -ForwardingTarget "+12065551234" -``` -This example shows setting simultaneous ringing to +12065551234 for user1@contoso.com. - -### Example 4 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType MyDelegates -UnansweredDelay 00:00:30 -``` -This example shows setting unanswered call forward to the delegates after 30 seconds for user1@contoso.com. - -### Example 5 -```powershell -$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. - -### Example 6 -```powershell -$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com -$cgt = {$ucs.CallGroupTargets}.Invoke() -$cgt.Add("sip:user5@contoso.com") -$cgt.Remove("sip:user6@contoso.com") -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets $cgt - -$gmd = (Get-CsUserCallingSettings -Identity user5@contoso.com).GroupMembershipDetails -$gmd[[array]::IndexOf($gmd.CallGroupOwnerId,'sip:user1@contoso.com')].NotificationSetting = 'Banner' -Set-CsUserCallingSettings -Identity user5@contoso.com -GroupMembershipDetails $gmd -``` - -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 notification setting for a member for a particular call group is defined on the member. In this case user5@contoso.com. - -### Example 7 -```powershell -$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets @() -``` - -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'} -) -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 -notification for the first call group and Mute notification for the last one. - -### Example 9 -```powershell -Set-CsUserCallingSettings -Identity user2@contoso.com -GroupNotificationOverride 'Mute' -``` - -This example shows how to set the group notification override for user2@contoso.com. This setting overrides any specific notification setting set for the user -on any call group the user is a member of. - -### Example 10 -```powershell -Set-CsUserCallingSettings -Identity user6@contoso.com -IsForwardingEnabled $false -Set-CsUserCallingSettings -Identity user6@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType Voicemail -UnansweredDelay 00:00:20 -``` - -This example shows how to set the default call forwarding settings for a user. - -### Example 11 -```powershell -Set-CsUserCallingSettings -Identity user7@contoso.com -IsUnansweredEnabled $false -``` - -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 - -The order in which to call members of the Call Group. The supported values are Simultaneous and InOrder. - -You can only use InOrder, if the call group has 5 or less members. - -```yaml -Type: System.String -Parameter Sets: (CallGroup) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallGroupTargets -The members of the Call Group. You need to always specify the full set of members as the parameter value. What you set here will overwrite the current call group membership. - -A call group can have up to 25 members. - -```yaml -Type: System.Array of System.String -Parameter Sets: (CallGroup) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingTarget - -The forwarding target. Supported types of values are ObjectId's, SIP addresses and phone numbers. -For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. - -Only used when ForwardingTargetType is SingleTarget. - -```yaml -Type: System.String -Parameter Sets: (Forwarding) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingTargetType - -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). - -```yaml -Type: System.String -Parameter Sets: (Forwarding) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingType - -The type of forwarding to set. Supported values are Immediate and Simultaneous - -```yaml -Type: System.String -Parameter Sets: (Forwarding) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupMembershipDetails - -The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a -call group and the notification setting for the specified user for that call group. - -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) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -GroupNotificationOverride - -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) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsForwardingEnabled - -This parameter controls whether forwarding is enabled or not. - -```yaml -Type: System.Boolean -Parameter Sets: (ForwardingOnOff,Forwarding) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsUnansweredEnabled - -This parameter controls whether forwarding for unanswered calls is enabled or not. - -```yaml -Type: System.Boolean -Parameter Sets: (UnansweredOnOff,Unanswered) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnansweredDelay - -The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and -60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds. - -```yaml -Type: System.String -Parameter Sets: (Unanswered) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnansweredTarget - -The unanswered target. Supported type of values are ObjectId, SIP address and phone number. -For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. - -Only used when UnansweredTargetType is SingleTarget. - -```yaml -Type: System.String -Parameter Sets: (Unanswered) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnansweredTargetType - -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. - -```yaml -Type: System.String -Parameter Sets: (Unanswered) -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 -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -The specified user need to have the Microsoft Phone System license assigned. - -When forwarding to MyDelegates, the specified user needs to have one or more delegates defined that are allowed to receive calls. When forwarding to Group, the -specified user needs to have one or more members of the user's call group. - -The cmdlet is validating the different settings and is always writing all the parameters in a settings group. You might see validation errors from the cmdlet due to -this behavior. As an example, if you have ForwardingTargetType set to Group and you want to remove all members of the call group, you will get a validation error. - -You can specify a SIP URI without 'sip:' on input, but the output from Get-CsUserCallingSettings will show the full SIP URI. - -You are not able to configure delegates via this cmdlet. Please use New-CsUserCallingDelegate, Set-CsUserCallingDelegate cmdlets and Remove-CsUserCallingDelegate. - -## RELATED LINKS -[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingsettings +schema: 2.0.0 +title: Set-CsUserCallingSettings +--- + +# Set-CsUserCallingSettings + +## SYNOPSIS +This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. + +## SYNTAX + +### Identity (Default) +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] [] +``` + +### CallGroupNotification +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -GroupNotificationOverride [] +``` + +### CallGroupMembership +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -GroupMembershipDetails [] +``` + +### CallGroup +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] -CallGroupOrder + -CallGroupTargets [] +``` + +### Unanswered +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -IsUnansweredEnabled -UnansweredDelay [-UnansweredTarget ] + [-UnansweredTargetType ] [] +``` + +### UnansweredOnOff +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -IsUnansweredEnabled [] +``` + +### Forwarding +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -IsForwardingEnabled -ForwardingType -ForwardingTargetType + [-ForwardingTarget ] [] +``` + +### ForwardingOnOff +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -IsForwardingEnabled [] +``` + +## 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 +start by getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Voicemail +``` +This example shows setting immediate call forwarding to voicemail for user1@contoso.com. + +### Example 2 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $false +``` +This example shows removing call forwarding for user1@contoso.com. + +### Example 3 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Simultaneous -ForwardingTargetType SingleTarget -ForwardingTarget "+12065551234" +``` +This example shows setting simultaneous ringing to +12065551234 for user1@contoso.com. + +### Example 4 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType MyDelegates -UnansweredDelay 00:00:30 +``` +This example shows setting unanswered call forward to the delegates after 30 seconds for user1@contoso.com. + +### Example 5 +```powershell +$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. + +### Example 6 +```powershell +$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com +$cgt = {$ucs.CallGroupTargets}.Invoke() +$cgt.Add("sip:user5@contoso.com") +$cgt.Remove("sip:user6@contoso.com") +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets $cgt + +$gmd = (Get-CsUserCallingSettings -Identity user5@contoso.com).GroupMembershipDetails +$gmd[[array]::IndexOf($gmd.CallGroupOwnerId,'sip:user1@contoso.com')].NotificationSetting = 'Banner' +Set-CsUserCallingSettings -Identity user5@contoso.com -GroupMembershipDetails $gmd +``` + +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 notification setting for a member for a particular call group is defined on the member. In this case user5@contoso.com. + +### Example 7 +```powershell +$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets @() +``` + +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'} +) +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 +notification for the first call group and Mute notification for the last one. + +### Example 9 +```powershell +Set-CsUserCallingSettings -Identity user2@contoso.com -GroupNotificationOverride 'Mute' +``` + +This example shows how to set the group notification override for user2@contoso.com. This setting overrides any specific notification setting set for the user +on any call group the user is a member of. + +### Example 10 +```powershell +Set-CsUserCallingSettings -Identity user6@contoso.com -IsForwardingEnabled $false +Set-CsUserCallingSettings -Identity user6@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType Voicemail -UnansweredDelay 00:00:20 +``` + +This example shows how to set the default call forwarding settings for a user. + +### Example 11 +```powershell +Set-CsUserCallingSettings -Identity user7@contoso.com -IsUnansweredEnabled $false +``` + +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 + +The order in which to call members of the Call Group. The supported values are Simultaneous and InOrder. + +You can only use InOrder, if the call group has 5 or less members. + +```yaml +Type: System.String +Parameter Sets: CallGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallGroupTargets +The members of the Call Group. You need to always specify the full set of members as the parameter value. What you set here will overwrite the current call group membership. + +A call group can have up to 25 members. + +```yaml +Type: System.Array +Parameter Sets: CallGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingTarget + +The forwarding target. Supported types of values are ObjectId's, SIP addresses and phone numbers. +For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. + +Only used when ForwardingTargetType is SingleTarget. + +```yaml +Type: System.String +Parameter Sets: Forwarding +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingTargetType + +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). + +```yaml +Type: System.String +Parameter Sets: Forwarding +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingType + +The type of forwarding to set. Supported values are Immediate and Simultaneous + +```yaml +Type: System.String +Parameter Sets: Forwarding +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMembershipDetails + +The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a +call group and the notification setting for the specified user for that call group. + +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: CallGroupMembership +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -GroupNotificationOverride + +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: CallGroupNotification +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsForwardingEnabled + +This parameter controls whether forwarding is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: Forwarding, ForwardingOnOff +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUnansweredEnabled + +This parameter controls whether forwarding for unanswered calls is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: Unanswered, UnansweredOnOff +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredDelay + +The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and +60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds. + +```yaml +Type: System.String +Parameter Sets: Unanswered +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredTarget + +The unanswered target. Supported type of values are ObjectId, SIP address and phone number. +For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. + +Only used when UnansweredTargetType is SingleTarget. + +```yaml +Type: System.String +Parameter Sets: Unanswered +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredTargetType + +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. + +```yaml +Type: System.String +Parameter Sets: Unanswered +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 +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +The specified user need to have the Microsoft Phone System license assigned. + +When forwarding to MyDelegates, the specified user needs to have one or more delegates defined that are allowed to receive calls. When forwarding to Group, the +specified user needs to have one or more members of the user's call group. + +The cmdlet is validating the different settings and is always writing all the parameters in a settings group. You might see validation errors from the cmdlet due to +this behavior. As an example, if you have ForwardingTargetType set to Group and you want to remove all members of the call group, you will get a validation error. + +You can specify a SIP URI without 'sip:' on input, but the output from Get-CsUserCallingSettings will show the full SIP URI. + +You are not able to configure delegates via this cmdlet. Please use New-CsUserCallingDelegate, Set-CsUserCallingDelegate cmdlets and Remove-CsUserCallingDelegate. + +## RELATED LINKS +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csusercallingdelegate) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/Set-CsVideoInteropServiceProvider.md similarity index 97% rename from teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/Set-CsVideoInteropServiceProvider.md index 87c3b8383b..a8280cd247 100644 --- a/teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsVideoInteropServiceProvider.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csvideointeropserviceprovider +schema: 2.0.0 +title: Set-CsVideoInteropServiceProvider --- # Set-CsVideoInteropServiceProvider diff --git a/teams/teams-ps/teams/Set-Team.md b/teams/teams-ps/MicrosoftTeams/Set-Team.md similarity index 97% rename from teams/teams-ps/teams/Set-Team.md rename to teams/teams-ps/MicrosoftTeams/Set-Team.md index ec7260f07c..e5bdc94f92 100644 --- a/teams/teams-ps/teams/Set-Team.md +++ b/teams/teams-ps/MicrosoftTeams/Set-Team.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-team +schema: 2.0.0 +title: Set-Team --- # Set-Team @@ -40,27 +40,26 @@ Set-Team -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Updated Tea ## PARAMETERS -### -GroupId -GroupId of the team +### -AllowAddRemoveApps +Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Team display name. -Team Name Characters Limit - 256. +### -AllowChannelMentions +Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -71,13 +70,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Team description. -Team Description Characters Limit - 1024. +### -AllowCreatePrivateChannels +Determines whether private channel creation is allowed for the team. ```yaml -Type: String -Parameter Sets: (All) +Type: Boolean +Parameter Sets: CreateTeam Aliases: Required: False @@ -87,13 +85,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MailNickName -The MailNickName parameter specifies the alias for the associated Office 365 Group. -This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. -The value of the MailNickName parameter has to be unique across your tenant. +### -AllowCreateUpdateChannels +Setting that determines whether or not members (and not just owners) are allowed to create channels. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -104,11 +100,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Classification -This parameter is reserved for internal Microsoft use. +### -AllowCreateUpdateRemoveConnectors +Setting that determines whether or not members (and not only owners) can manage connectors in the team. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -119,12 +115,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Visibility -Team visibility. -Valid values are "Private" and "Public" +### -AllowCreateUpdateRemoveTabs +Setting that determines whether or not members (and not only owners) can manage tabs in channels. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -135,8 +130,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAddRemoveApps -Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. +### -AllowCustomMemes +Setting that determines whether or not members can use the custom memes functionality in teams. ```yaml Type: Boolean @@ -150,8 +145,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelMentions -Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. +### -AllowDeleteChannels +Setting that determines whether or not members (and not only owners) can delete channels in the team. ```yaml Type: Boolean @@ -165,8 +160,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreateUpdateChannels -Setting that determines whether or not members (and not just owners) are allowed to create channels. +### -AllowGiphy +Setting that determines whether or not giphy can be used in the team. ```yaml Type: Boolean @@ -180,8 +175,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreateUpdateRemoveConnectors -Setting that determines whether or not members (and not only owners) can manage connectors in the team. +### -AllowGuestCreateUpdateChannels +Setting that determines whether or not guests can create channels in the team. ```yaml Type: Boolean @@ -195,8 +190,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreateUpdateRemoveTabs -Setting that determines whether or not members (and not only owners) can manage tabs in channels. +### -AllowGuestDeleteChannels +Setting that determines whether or not guests can delete in the team. ```yaml Type: Boolean @@ -210,8 +205,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCustomMemes -Setting that determines whether or not members can use the custom memes functionality in teams. +### -AllowOwnerDeleteMessages +Setting that determines whether or not owners can delete messages that they or other members of the team have posted. ```yaml Type: Boolean @@ -225,8 +220,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDeleteChannels -Setting that determines whether or not members (and not only owners) can delete channels in the team. +### -AllowStickersAndMemes +Setting that determines whether stickers and memes usage is allowed in the team. ```yaml Type: Boolean @@ -240,8 +235,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowGiphy -Setting that determines whether or not giphy can be used in the team. +### -AllowTeamMentions +Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) ```yaml Type: Boolean @@ -255,8 +250,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowGuestCreateUpdateChannels -Setting that determines whether or not guests can create channels in the team. +### -AllowUserDeleteMessages +Setting that determines whether or not members can delete messages that they have posted. ```yaml Type: Boolean @@ -270,8 +265,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowGuestDeleteChannels -Setting that determines whether or not guests can delete in the team. +### -AllowUserEditMessages +Setting that determines whether or not users can edit messages that they have posted. ```yaml Type: Boolean @@ -285,11 +280,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOwnerDeleteMessages -Setting that determines whether or not owners can delete messages that they or other members of the team have posted. +### -Classification +This parameter is reserved for internal Microsoft use. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -300,11 +295,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowStickersAndMemes -Setting that determines whether stickers and memes usage is allowed in the team. +### -Description +Team description. +Team Description Characters Limit - 1024. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -315,11 +311,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTeamMentions -Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) +### -DisplayName +Team display name. +Team Name Characters Limit - 256. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -330,11 +327,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserDeleteMessages -Setting that determines whether or not members can delete messages that they have posted. +### -GiphyContentRating +Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -345,23 +342,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserEditMessages -Setting that determines whether or not users can edit messages that they have posted. +### -GroupId +GroupId of the team ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -GiphyContentRating -Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" +### -MailNickName +The MailNickName parameter specifies the alias for the associated Office 365 Group. +This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. +The value of the MailNickName parameter has to be unique across your tenant. ```yaml Type: String @@ -389,12 +388,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreatePrivateChannels -Determines whether private channel creation is allowed for the team. +### -Visibility +Team visibility. +Valid values are "Private" and "Public" ```yaml -Type: Boolean -Parameter Sets: CreateTeam +Type: String +Parameter Sets: (All) Aliases: Required: False @@ -415,6 +415,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-Team](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) -[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) +[New-Team](https://learn.microsoft.com/powershell/module/microsoftteams/new-team) diff --git a/teams/teams-ps/teams/Set-TeamArchivedState.md b/teams/teams-ps/MicrosoftTeams/Set-TeamArchivedState.md similarity index 96% rename from teams/teams-ps/teams/Set-TeamArchivedState.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamArchivedState.md index 5b3b53ee89..c9e850cd7e 100644 --- a/teams/teams-ps/teams/Set-TeamArchivedState.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamArchivedState.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teamarchivedstate +schema: 2.0.0 +title: Set-TeamArchivedState --- # Set-TeamArchivedState diff --git a/teams/teams-ps/teams/Set-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/Set-TeamChannel.md similarity index 95% rename from teams/teams-ps/teams/Set-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamChannel.md index 14b6fa83e6..d740d5726e 100644 --- a/teams/teams-ps/teams/Set-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamChannel.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teamchannel +schema: 2.0.0 +title: Set-TeamChannel --- # Set-TeamChannel @@ -36,8 +36,8 @@ Set-TeamChannel -GroupId c58566a6-4bb4-4221-98d4-47677dbdbef6 -CurrentDisplayNam ## PARAMETERS -### -GroupId -GroupId of the team +### -CurrentDisplayName +Current channel name ```yaml Type: String @@ -51,41 +51,41 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -CurrentDisplayName -Current channel name +### -Description +Updated Channel description. +Channel Description Characters Limit - 1024. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -NewDisplayName -New Channel display name. -Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : \< \> ? -+ | ' " +### -GroupId +GroupId of the team ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Description -Updated Channel description. -Channel Description Characters Limit - 1024. +### -NewDisplayName +New Channel display name. +Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : \< \> ? ++ | ' " ```yaml Type: String diff --git a/teams/teams-ps/teams/Set-TeamPicture.md b/teams/teams-ps/MicrosoftTeams/Set-TeamPicture.md similarity index 94% rename from teams/teams-ps/teams/Set-TeamPicture.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamPicture.md index eeb537153b..2f1a701a64 100644 --- a/teams/teams-ps/teams/Set-TeamPicture.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamPicture.md @@ -1,25 +1,19 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teampicture +schema: 2.0.0 +title: Set-TeamPicture --- # Set-TeamPicture ## SYNOPSIS - 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: this cmdlet is not support in special government environments (TeamsGCCH and TeamsDoD) and is currently only supported in our beta release. - ## SYNTAX ``` @@ -27,6 +21,10 @@ Set-TeamPicture -GroupId -ImagePath [] ``` ## DESCRIPTION +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. ## EXAMPLES diff --git a/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md b/teams/teams-ps/MicrosoftTeams/Set-TeamTargetingHierarchy.md similarity index 94% rename from teams/teams-ps/teams/Set-TeamTargetingHierarchy.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamTargetingHierarchy.md index 4f8a952534..1aa85c5f33 100644 --- a/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamTargetingHierarchy.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US 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 -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/connect-microsoftteams +schema: 2.0.0 +title: Set-TeamTargetingHierarchy --- # Set-TeamTargetingHierarchy @@ -47,35 +47,35 @@ requestId c67e86109d88479e9708c3b7e8ff7217 ## PARAMETERS -### -FilePath -Specifies the path to a CSV file that defines the hierarchy. +### -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: True +Required: False Position: Named -Default value: None -Accept pipeline input: False +Default value: 1 +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. +### -FilePath +Specifies the path to a CSV file that defines the hierarchy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 1 -Accept pipeline input: false +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` @@ -90,4 +90,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-TeamTargetingHierarchyStatus](https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus) +[Get-TeamTargetingHierarchyStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamtargetinghierarchystatus) diff --git a/teams/teams-ps/teams/Set-TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Set-TeamsApp.md similarity index 93% rename from teams/teams-ps/teams/Set-TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamsApp.md index 3f493249cb..bdaa599aa2 100644 --- a/teams/teams-ps/teams/Set-TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamsApp.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-teamsapp -title: Set-TeamsApp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teamsapp schema: 2.0.0 +title: Set-TeamsApp --- # Set-TeamsApp diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/MicrosoftTeams/Set-TeamsEnvironmentConfig.md similarity index 97% rename from teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamsEnvironmentConfig.md index 81c1a3382e..e522775a6f 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamsEnvironmentConfig.md @@ -1,13 +1,14 @@ --- +author: VikneshMSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Locale: en-US +manager: vinelap Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-teamsenvironmentconfig -title: Set-TeamsEnvironmentConfig -schema: 2.0.0 -author: VikneshMSFT ms.author: vimohan ms.reviewer: pbafna -manager: vinelap +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teamsenvironmentconfig +schema: 2.0.0 +title: Set-TeamsEnvironmentConfig --- # Set-TeamsEnvironmentConfig diff --git a/teams/teams-ps/teams/Start-CsExMeetingMigration.md b/teams/teams-ps/MicrosoftTeams/Start-CsExMeetingMigration.md similarity index 90% rename from teams/teams-ps/teams/Start-CsExMeetingMigration.md rename to teams/teams-ps/MicrosoftTeams/Start-CsExMeetingMigration.md index 411d082929..8c5c9bf9f3 100644 --- a/teams/teams-ps/teams/Start-CsExMeetingMigration.md +++ b/teams/teams-ps/MicrosoftTeams/Start-CsExMeetingMigration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/start-csexmeetingmigration applicable: Microsoft Teams -title: Start-CsExMeetingMigration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/start-csexmeetingmigration +schema: 2.0.0 +title: Start-CsExMeetingMigration --- # Start-CsExMeetingMigration @@ -29,7 +31,7 @@ Also, with `Start-CsExMeetingMigration` cmdlet, you can start a meeting migratio ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Start-CsExMeetingMigration -Identity ashaw@contoso.com -TargetMeetingType Teams ``` @@ -39,6 +41,9 @@ This example below shows how to initiate meeting migration for user ashaw@contos ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + 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) @@ -49,7 +54,6 @@ Specifies the Identity of the user account to be modified. A user identity can b Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -59,6 +63,9 @@ Accept wildcard characters: False ``` ### -SourceMeetingType + +> Applicable: Microsoft Teams + The possible values are: * **All:** indicates that both Skype for Business meetings and Teams meetings should be updated. This is the **default value**. * **SfB:** indicates that only Skype for Business meetings (whether on-premises or online) should be updated. @@ -68,7 +75,6 @@ The possible values are: Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -78,6 +84,9 @@ Accept wildcard characters: False ``` ### -TargetMeetingType + +> Applicable: Microsoft Teams + The possible values are: * **Current:** specifies that Skype for Business meetings remain Skype for Business meetings and Teams meetings remain Teams meetings. However audio conferencing coordinates might be changed, and any on-premises Skype for Business meetings would be migrated to Skype for Business Online. This is the **default value**. * **Teams:** specifies that any existing meeting must be migrated to Teams, regardless of whether the meeting is hosted in Skype for Business online or on-premises, and regardless of whether any audio conferencing updates are required. @@ -86,7 +95,6 @@ The possible values are: Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -107,8 +115,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/teams/get-csmeetingmigrationstatus) +[Get-CsMeetingMigrationStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csmeetingmigrationstatus) -[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration) +[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantmigrationconfiguration) -[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration) +[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantmigrationconfiguration) diff --git a/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Sync-CsOnlineApplicationInstance.md similarity index 88% rename from teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Sync-CsOnlineApplicationInstance.md index 8076e411c3..a77d6ed724 100644 --- a/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Sync-CsOnlineApplicationInstance.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance applicable: Microsoft Teams -title: Sync-CsOnlineApplicationInstance -schema: 2.0.0 author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: naveenv -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/sync-csonlineapplicationinstance +schema: 2.0.0 +title: Sync-CsOnlineApplicationInstance --- # 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. +Sync the application instance from Microsoft Entra ID into Agent Provisioning Service. ## SYNTAX @@ -22,18 +23,18 @@ Sync-CsOnlineApplicationInstance -ObjectId [-CallbackUri ] [-Forc ``` ## DESCRIPTION -Use the Sync-CsOnlineApplicationInstance cmdlet to sync application instances from Microsoft Entra ID into Agent Provisioning Service. +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. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Sync-CsOnlineApplicationInstance -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationId yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy ``` This example sync application instance with object ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" and application ID "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy" into Agent Provisioning Service. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Sync-CsOnlineApplicationInstance -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationId 00000000-0000-0000-0000-000000000000 ``` @@ -43,11 +44,11 @@ The command removes the mapping for application instance with object ID "xxxxxxx ## PARAMETERS -### -CallbackUri -This parameter is reserved for internal Microsoft use. +### -AcsResourceId +The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: @@ -58,8 +59,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ObjectId -The application instance ID. +### -ApplicationId +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid @@ -73,11 +74,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. +### -CallbackUri +This parameter is reserved for internal Microsoft use. ```yaml -Type: System.Guid +Type: String Parameter Sets: (All) Aliases: @@ -88,13 +89,13 @@ 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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -118,14 +119,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -ObjectId +The application instance ID. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -134,13 +134,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -160,10 +161,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) -[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Test-CsEffectiveTenantDialPlan.md similarity index 90% rename from teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Test-CsEffectiveTenantDialPlan.md index 1402626383..7f9be8612c 100644 --- a/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsEffectiveTenantDialPlan.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-cseffectivetenantdialplan +schema: 2.0.0 +title: Test-CsEffectiveTenantDialPlan --- # Test-CsEffectiveTenantDialPlan @@ -34,14 +36,14 @@ The `Test-CsEffectiveTenantDialPlan` cmdlet normalizes the dialed number by appl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsEffectiveTenantDialPlan -Identity adelev | Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 ``` 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 -------------------------- +### Example 2 ``` Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 -Identity adelev@contoso.onmicrosoft.com ``` @@ -50,14 +52,16 @@ This example tests the given dialed number against a specific identity. ## PARAMETERS -### -DialedNumber -The DialedNumber parameter is the phone number to be normalized with the effective tenant dial plan. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: PhoneNumber +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -66,14 +70,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Indicates the identity of the user account to be tested against. The user's SIP address, the user's user principal name (UPN) or the user's display name can be specified. +### -DialedNumber + +> Applicable: Microsoft Teams + +The DialedNumber parameter is the phone number to be normalized with the effective tenant dial plan. ```yaml -Type: UserIdParameter +Type: PhoneNumber Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -82,14 +88,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -EffectiveTenantDialPlanName + +> Applicable: Microsoft Teams + +The EffectiveTenantDialPlanName parameter is the effective tenant dial plan name in the form of TenantId_TenantDialPlan_GlobalVoiceDialPlan. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -99,6 +107,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + 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. @@ -107,7 +118,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -116,15 +126,16 @@ 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. +### -Identity + +> Applicable: Microsoft Teams + +Indicates the identity of the user account to be tested against. The user's SIP address, the user's user principal name (UPN) or the user's display name can be specified. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -133,14 +144,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EffectiveTenantDialPlanName -The EffectiveTenantDialPlanName parameter is the effective tenant dial plan name in the form of TenantId_TenantDialPlan_GlobalVoiceDialPlan. +### -TenantScopeOnly + +> Applicable: Microsoft Teams + +Runs the test only against Tenant-level dial plans (does not take into account Service Level Dial Plans). ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -149,14 +162,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantScopeOnly -Runs the test only against Tenant-level dial plans (does not take into account Service Level Dial Plans). +### -WhatIf + +> Applicable: Microsoft Teams + +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: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Test-CsInboundBlockedNumberPattern.md similarity index 93% rename from teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Test-CsInboundBlockedNumberPattern.md index 56da11fbfd..166872828e 100644 --- a/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsInboundBlockedNumberPattern.md @@ -1,11 +1,13 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern +title: Test-CsInboundBlockedNumberPattern --- # Test-CsInboundBlockedNumberPattern diff --git a/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsShiftsConnectionValidate.md similarity index 91% rename from teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md rename to teams/teams-ps/MicrosoftTeams/Test-CsTeamsShiftsConnectionValidate.md index 7d7fd3966d..2295e94b39 100644 --- a/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsShiftsConnectionValidate.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Test-CsTeamsShiftsConnectionValidate -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate schema: 2.0.0 +title: Test-CsTeamsShiftsConnectionValidate --- # Test-CsTeamsShiftsConnectionValidate @@ -51,13 +52,14 @@ Returns the list of conflicts if there are any. Empty result means there's no co ### -ConnectorId +> Applicable: Microsoft Teams + The ID of the shifts connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -65,15 +67,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name - -The connector's instance name. +### -ConnectorSpecificSettings +The connector specific settings. ```yaml -Type: String -Parameter Sets: (All) +Type: IConnectorInstanceRequestConnectorSpecificSettings +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None @@ -81,14 +82,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector specific settings. +### -Name + +> Applicable: Microsoft Teams + +The connector's instance name. ```yaml -Type: IConnectorInstanceRequestConnectorSpecificSettings -Parameter Sets: NewExpanded +Type: String +Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -107,6 +110,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/MicrosoftTeams/Test-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsTranslationRule.md new file mode 100644 index 0000000000..c575afd2dc --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsTranslationRule.md @@ -0,0 +1,176 @@ +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamstranslationrule +schema: 2.0.0 +title: Test-CsTeamsTranslationRule +--- + +# Test-CsTeamsTranslationRule + +## SYNOPSIS +This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. + +## SYNTAX + +``` +Test-CsTeamsTranslationRule -PhoneNumber [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +## 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 + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumber +The phone number to test. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://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/microsoftteams/new-csteamstranslationrule) + +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstranslationrule) + +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstranslationrule) + +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsUnassignedNumberTreatment.md similarity index 79% rename from teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Test-CsTeamsUnassignedNumberTreatment.md index 1682ef0ba6..429b936303 100644 --- a/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsUnassignedNumberTreatment.md @@ -1,11 +1,12 @@ --- -external help file: Microsoft.TeamsCmdlets.Powershell.Custom.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment -Module Name: Microsoft Teams -title: Test-CsTeamsUnassignedNumberTreatment author: firatakandere +external help file: Microsoft.TeamsCmdlets.Powershell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: osakande +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment schema: 2.0.0 +title: Test-CsTeamsUnassignedNumberTreatment --- # Test-CsTeamsUnassignedNumberTreatment @@ -37,13 +38,13 @@ Tests the "321321321" number to check if there is a matching unassigned number t The phone number to be tested. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: True Position: Named -Default Value: None +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -64,10 +65,10 @@ The cmdlet is available in Teams PS module 3.2.0-preview or later. ## RELATED LINKS -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment) -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment) -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment) -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md b/teams/teams-ps/MicrosoftTeams/Test-CsVoiceNormalizationRule.md similarity index 80% rename from teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md rename to teams/teams-ps/MicrosoftTeams/Test-CsVoiceNormalizationRule.md index 43647176a6..4de8034499 100644 --- a/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsVoiceNormalizationRule.md @@ -1,21 +1,20 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-csvoicenormalizationrule +schema: 2.0.0 +title: Test-CsVoiceNormalizationRule --- # 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 @@ -25,14 +24,17 @@ Test-CsVoiceNormalizationRule -DialedNumber -NormalizationRule Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + 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 @@ -100,7 +105,6 @@ Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber 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 @@ -110,6 +114,9 @@ Accept wildcard characters: False ``` ### -NormalizationRule + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + 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. @@ -119,7 +126,6 @@ For Microsoft Teams, you can retrieve voice normalization rules by calling the ` 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 @@ -146,6 +152,6 @@ Returns an object of type Microsoft.Rtc.Management.Voice.NormalizationRuleTestRe ## RELATED LINKS -[New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) +[New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csvoicenormalizationrule) -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber.md similarity index 87% rename from teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber.md index a2f7712c39..34b3532993 100644 --- a/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,15 @@ --- -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/unregister-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Unregister-CsOnlineDialInConferencingServiceNumber --- # Unregister-CsOnlineDialInConferencingServiceNumber @@ -28,7 +30,7 @@ Unassigns the previously assigned service number as default Conference Bridge nu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Unregister-CsOnlineDialInConferencingServiceNumber -BridgeName "Conference Bridge" -RemoveDefaultServiceNumber 1234 ``` @@ -37,46 +39,52 @@ Unassigns the 1234 Service Number to the given Conference Bridge. ## PARAMETERS -### -Identity -PARAMVALUE: String +### -BridgeId + +> Applicable: Microsoft Teams + +PARAMVALUE: Guid ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: ConferencingServiceNumber +### -BridgeName + +> Applicable: Microsoft Teams + +PARAMVALUE: String ```yaml -Type: ConferencingServiceNumber +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeId -PARAMVALUE: Guid +### -DomainController + +> Applicable: Microsoft Teams + +PARAMVALUE: Fqdn ```yaml -Type: Guid +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False Position: Named @@ -85,14 +93,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeName -PARAMVALUE: String +### -Force + +> Applicable: Microsoft Teams + +PARAMVALUE: SwitchParameter ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -101,46 +111,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -PARAMVALUE: Fqdn +### -Identity + +> Applicable: Microsoft Teams + +PARAMVALUE: String ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Instance + +> Applicable: Microsoft Teams + +PARAMVALUE: ConferencingServiceNumber ```yaml -Type: SwitchParameter +Type: ConferencingServiceNumber Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -RemoveDefaultServiceNumber + +> Applicable: Microsoft Teams + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -150,13 +166,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -166,13 +184,15 @@ Accept wildcard characters: False ``` ### -TenantDomain + +> Applicable: Microsoft Teams + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Update-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Update-CsAutoAttendant.md similarity index 83% rename from teams/teams-ps/teams/Update-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Update-CsAutoAttendant.md index e904781ef4..e33cbb4737 100644 --- a/teams/teams-ps/teams/Update-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/update-csautoattendant +schema: 2.0.0 +title: Update-CsAutoAttendant --- # Update-CsAutoAttendant @@ -24,11 +26,11 @@ 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`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) 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/microsoftteams/get-csautoattendantstatus) cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Update-CsAutoAttendant -Identity "6abea1cd-904b-520b-be96-1092cc096432" ``` @@ -38,13 +40,15 @@ In Example 1, the Update-CsAutoAttendant cmdlet is used to update all resources ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the AA whose resources are to be updated. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -55,11 +59,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -84,10 +89,10 @@ The Update-CsAutoAttendant cmdlet accepts a string as the Identity parameter. ## RELATED LINKS -[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant) -[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus) -[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant) -[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant) diff --git a/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Update-CsCustomPolicyPackage.md similarity index 85% rename from teams/teams-ps/teams/Update-CsCustomPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Update-CsCustomPolicyPackage.md index b993377f9a..430d0913ab 100644 --- a/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsCustomPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: sunguchuan external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: Update-CsCustomPolicyPackage -author: sunguchuan ms.author: gucsun -manager: dasosby -online version: https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/update-cscustompolicypackage schema: 2.0.0 +title: Update-CsCustomPolicyPackage --- # Update-CsCustomPolicyPackage @@ -44,49 +45,52 @@ Updates the custom package named "MyPackage" to have a description of "My packag ## PARAMETERS -### -Identity +### -Description -The name of the custom package. +> Applicable: Microsoft Teams + +The description of the custom package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True -Position: 0 +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyList +### -Identity -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). +> Applicable: Microsoft Teams + +The name of the custom package. ```yaml -Type: String[] +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -PolicyList -The description of the custom package. +> Applicable: Microsoft Teams + +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/microsoftteams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmessagingpolicy). ```yaml -Type: String +Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -104,8 +108,8 @@ The resulting custom package's contents will be replaced by the new one instead ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage) +[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscustompolicypackage) -[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage) +[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscustompolicypackage) diff --git a/teams/teams-ps/MicrosoftTeams/Update-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Update-CsPhoneNumberTag.md new file mode 100644 index 0000000000..7f751afe00 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Update-CsPhoneNumberTag.md @@ -0,0 +1,83 @@ +--- +applicable: Microsoft Teams +author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +ms.reviewer: pavellatif +online version: https://learn.microsoft.com/powershell/module/microsoftteams/update-csphonenumbertag +schema: 2.0.0 +title: Update-CsPhoneNumberTag +--- + +# 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/microsoftteams/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/MicrosoftTeams/Update-CsTeamTemplate.md similarity index 96% rename from teams/teams-ps/teams/Update-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/Update-CsTeamTemplate.md index 67710e31ba..70800546a1 100644 --- a/teams/teams-ps/teams/Update-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsTeamTemplate.md @@ -1,809 +1,809 @@ ---- -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-csteamtemplate -title: Update-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# Update-CsTeamTemplate - -## SYNOPSIS - -This cmdlet submits an operation that updates a custom team template with new team template settings. - -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. - -## SYNTAX - -### UpdateExpanded (Default) - -```powershell -Update-CsTeamTemplate -OdataId -DisplayName -ShortDescription - [-App ] [-Category ] [-Channel ] - [-Classification ] [-Description ] [-DiscoverySetting ] - [-FunSetting ] [-GuestSetting ] [-Icon ] - [-IsMembershipLimitedToOwner] [-MemberSetting ] - [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] - [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-Confirm] [-WhatIf] - [] -``` - -### Update - -```powershell -Update-CsTeamTemplate -OdataId -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### UpdateViaIdentity - -```powershell -Update-CsTeamTemplate -InputObject -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### UpdateViaIdentityExpanded - -```powershell -Update-CsTeamTemplate -InputObject -DisplayName - -ShortDescription [-App ] [-Category ] - [-Channel ] [-Classification ] [-Description ] - [-DiscoverySetting ] [-FunSetting ] - [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] - [-MemberSetting ] [-MessagingSetting ] - [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] - [-Uri ] [-Visibility ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -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) -``` - -Step 1: Creates a JSON file of the template you have specified. -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 @{` -DisplayName='New Template';` -ShortDescription='Short Definition';` -Description='New Description';` -App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` -Channel=@{` - displayName = "General";` - id= "General";` - isFavoriteByDefault= $true` - },` - @{` - displayName= "test";` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` - isFavoriteByDefault= $false` - }` -} - -PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body $template -``` - -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' ` --Locale en-US -DisplayName 'New Template' ` --ShortDescription 'New Description' ` --App @{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'} ` --Channel @{ ` -displayName = "General"; ` -id= "General"; ` -isFavoriteByDefault= $true ` -}, ` -@{ ` - displayName= "test"; ` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` - isFavoriteByDefault= $false ` -} -``` -> [!Note] -> It can take up to 24 hours for Teams users to see a custom template change in the gallery. - -## PARAMETERS - -### -App - -Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. -To construct, see NOTES section for APP properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body - -The client input for a request to create a template. -Only admins from Config Api can perform this request. -To construct, see NOTES section for BODY properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate -Parameter Sets: Update, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category - -Gets or sets list of categories. - -```yaml -Type: System.String[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Channel - -Gets or sets the set of channel templates included in the team template. -To construct, see NOTES section for CHANNEL properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Classification - -Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Gets or sets the team's Description. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoverySetting - -Governs discoverability of a team. -To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName - -Gets or sets the team's DisplayName. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunSetting - -Governs use of fun media like giphy and stickers in the team. -To construct, see NOTES section for FUNSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestSetting - -Guest role settings for the team. -To construct, see NOTES section for GUESTSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Icon - -Gets or sets template icon. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsMembershipLimitedToOwner - -Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberSetting - -Member role settings for the team. -To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessagingSetting - -Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. -To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OdataId - -A composite URI of a template. - -```yaml -Type: System.String -Parameter Sets: Update, UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerUserObjectId - -Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishedBy - -Gets or sets published name. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShortDescription - -Gets or sets template short description. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Specialization - -The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateId - -Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri - -Gets or sets uri to be used for GetTemplate api call. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Visibility - -Used to control the scope of users who can view a group/team and its members, and ability to join. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -## NOTES - -ALIASES - -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. - -APP \: Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. - -- `[Id ]`: Gets or sets the app's ID in the global apps catalog. - -BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. - -- `DisplayName `: Gets or sets the team's DisplayName. -- `ShortDescription `: Gets or sets template short description. -- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. - - `[Id ]`: Gets or sets the app's ID in the global apps catalog. -- `[Category ]`: Gets or sets list of categories. -- `[Channel ]`: Gets or sets the set of channel templates included in the team 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 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. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. -- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. -- `[Description ]`: Gets or sets the team's Description. -- `[DiscoverySetting ]`: Governs discoverability of a team. - - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. -- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. - - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. - - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - - `GiphyContentRating `: Gets or sets the rating filter on giphy content. -- `[GuestSetting ]`: Guest role settings for the team. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. -- `[Icon ]`: Gets or sets template icon. -- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. -- `[MemberSetting ]`: Member role settings for the team. - - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. - - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. - - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. - - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. -- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. - - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. -- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. -- `[PublishedBy ]`: Gets or sets published name. -- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. -- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. -- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. -- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. - -CHANNEL : Gets or sets the set of channel templates included in the team 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 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. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. - -DISCOVERYSETTING \: Governs discoverability of a team. - -- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - -FUNSETTING \: Governs use of fun media like giphy and stickers in the team. - -- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. -- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. -- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. -- `GiphyContentRating `: Gets or sets the rating filter on giphy content. - -GUESTSETTING \: Guest role settings for the team. - -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. - -INPUTOBJECT \: Identity Parameter - -- `[Bssid ]`: -- `[ChassisId ]`: -- `[CivicAddressId ]`: Civic address id. -- `[Country ]`: -- `[GroupId ]`: The ID of a group whose policy assignments will be returned. -- `[Id ]`: -- `[Identity ]`: -- `[Locale ]`: -- `[LocationId ]`: Location id. -- `[OdataId ]`: A composite URI of a template. -- `[OperationId ]`: The ID of a batch policy assignment operation. -- `[OrderId ]`: -- `[PackageName ]`: The name of a specific policy package -- `[PolicyType ]`: The policy type for which group policy assignments will be returned. -- `[Port ]`: -- `[PortInOrderId ]`: -- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. -- `[SubnetId ]`: -- `[TenantId ]`: -- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -MEMBERSETTING \: Member role settings for the team. - -- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. -- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. -- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. -- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. -- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. - -MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. - -- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. -- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. -- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. -- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. -- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - -## RELATED LINKS - -- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamtemplate +schema: 2.0.0 +title: Update-CsTeamTemplate +--- + +# Update-CsTeamTemplate + +## SYNOPSIS + +This cmdlet submits an operation that updates a custom team template with new team template settings. + +## SYNTAX + +### UpdateExpanded (Default) + +```powershell +Update-CsTeamTemplate -OdataId -DisplayName -ShortDescription + [-App ] [-Category ] [-Channel ] + [-Classification ] [-Description ] [-DiscoverySetting ] + [-FunSetting ] [-GuestSetting ] [-Icon ] + [-IsMembershipLimitedToOwner] [-MemberSetting ] + [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] + [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-Confirm] [-WhatIf] + [] +``` + +### Update + +```powershell +Update-CsTeamTemplate -OdataId -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentity + +``` +Update-CsTeamTemplate -InputObject -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded + +``` +Update-CsTeamTemplate -InputObject -DisplayName + -ShortDescription [-App ] [-Category ] + [-Channel ] [-Classification ] [-Description ] + [-DiscoverySetting ] [-FunSetting ] + [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] + [-MemberSetting ] [-MessagingSetting ] + [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] + [-Uri ] [-Visibility ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +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. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +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) +``` + +Step 1: Creates a JSON file of the template you have specified. +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 @{` +DisplayName='New Template';` +ShortDescription='Short Definition';` +Description='New Description';` +App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` +Channel=@{` + displayName = "General";` + id= "General";` + isFavoriteByDefault= $true` + },` + @{` + displayName= "test";` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` + isFavoriteByDefault= $false` + }` +} + +PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body $template +``` + +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' ` +-Locale en-US -DisplayName 'New Template' ` +-ShortDescription 'New Description' ` +-App @{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'} ` +-Channel @{ ` +displayName = "General"; ` +id= "General"; ` +isFavoriteByDefault= $true ` +}, ` +@{ ` + displayName= "test"; ` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` + isFavoriteByDefault= $false ` +} +``` +> [!Note] +> It can take up to 24 hours for Teams users to see a custom template change in the gallery. + +## PARAMETERS + +### -App + +Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. +To construct, see NOTES section for APP properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body + +The client input for a request to create a template. +Only admins from Config Api can perform this request. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate +Parameter Sets: Update, UpdateViaIdentity +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: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category + +Gets or sets list of categories. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Channel + +Gets or sets the set of channel templates included in the team template. +To construct, see NOTES section for CHANNEL properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Classification + +Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Gets or sets the team's Description. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoverySetting + +Governs discoverability of a team. +To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName + +Gets or sets the team's DisplayName. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunSetting + +Governs use of fun media like giphy and stickers in the team. +To construct, see NOTES section for FUNSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestSetting + +Guest role settings for the team. +To construct, see NOTES section for GUESTSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +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 +``` + +### -Icon + +Gets or sets template icon. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsMembershipLimitedToOwner + +Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberSetting + +Member role settings for the team. +To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingSetting + +Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. +To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OdataId + +A composite URI of a template. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerUserObjectId + +Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy + +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential + +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials + +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishedBy + +Gets or sets published name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShortDescription + +Gets or sets template short description. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Specialization + +The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateId + +Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri + +Gets or sets uri to be used for GetTemplate api call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Visibility + +Used to control the scope of users who can view a group/team and its members, and ability to join. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +## NOTES + +ALIASES + +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. + +APP \: Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. + +- `[Id ]`: Gets or sets the app's ID in the global apps catalog. + +BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. + +- `DisplayName `: Gets or sets the team's DisplayName. +- `ShortDescription `: Gets or sets template short description. +- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. + - `[Id ]`: Gets or sets the app's ID in the global apps catalog. +- `[Category ]`: Gets or sets list of categories. +- `[Channel ]`: Gets or sets the set of channel templates included in the team 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 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. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. +- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. +- `[Description ]`: Gets or sets the team's Description. +- `[DiscoverySetting ]`: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. +- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. + - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. + - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. + - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. + - `GiphyContentRating `: Gets or sets the rating filter on giphy content. +- `[GuestSetting ]`: Guest role settings for the team. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. +- `[Icon ]`: Gets or sets template icon. +- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. +- `[MemberSetting ]`: Member role settings for the team. + - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. + - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. + - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. + - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. + - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. +- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. + - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. + - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. + - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. + - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. + - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. +- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. +- `[PublishedBy ]`: Gets or sets published name. +- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. +- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. +- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. +- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. + +CHANNEL : Gets or sets the set of channel templates included in the team 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 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. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. + +DISCOVERYSETTING \: Governs discoverability of a team. + +- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. + +FUNSETTING \: Governs use of fun media like giphy and stickers in the team. + +- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. +- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. +- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. +- `GiphyContentRating `: Gets or sets the rating filter on giphy content. + +GUESTSETTING \: Guest role settings for the team. + +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. + +INPUTOBJECT \: Identity Parameter + +- `[Bssid ]`: +- `[ChassisId ]`: +- `[CivicAddressId ]`: Civic address id. +- `[Country ]`: +- `[GroupId ]`: The ID of a group whose policy assignments will be returned. +- `[Id ]`: +- `[Identity ]`: +- `[Locale ]`: +- `[LocationId ]`: Location id. +- `[OdataId ]`: A composite URI of a template. +- `[OperationId ]`: The ID of a batch policy assignment operation. +- `[OrderId ]`: +- `[PackageName ]`: The name of a specific policy package +- `[PolicyType ]`: The policy type for which group policy assignments will be returned. +- `[Port ]`: +- `[PortInOrderId ]`: +- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. +- `[SubnetId ]`: +- `[TenantId ]`: +- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +MEMBERSETTING \: Member role settings for the team. + +- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. +- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. +- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. +- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. +- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. + +MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. + +- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. +- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. +- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. +- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. +- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. + +## RELATED LINKS + +- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnection.md similarity index 96% rename from teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnection.md index 776c82c956..52f196b47d 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnection.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Update-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: -online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection +online version: https://docs.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnection schema: 2.0.0 +title: Update-CsTeamsShiftsConnection --- # Update-CsTeamsShiftsConnection @@ -133,6 +133,21 @@ Updates the connection with the specified -ConnectionId with the given settings. ## PARAMETERS +### -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 +``` + ### -Body The request body. @@ -178,27 +193,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -ConnectionId +The WFM connection ID for the instance. +This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, Update Aliases: -Required: False +Required: True 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. +### -ConnectorId +Used to specify the unique identifier of the connector being used for the connection. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -208,38 +224,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The value of the ETag field as returned by the cmdlets. +### -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: String -Parameter Sets: (All) +Type: IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The connector instance name. +### -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 @@ -253,11 +254,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: Uri +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -268,11 +269,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: PSCredential +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -283,44 +284,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -IfMatch +The value of the ETag field as returned by the cmdlets. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. +### -InputObject +Identity Parameter ```yaml -Type: String +Type: IConfigApiBasedCmdletsIdentity Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Name +The connector instance name. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: Required: False Position: Named @@ -329,11 +329,11 @@ 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. +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String +Type: Uri Parameter Sets: (All) Aliases: @@ -344,28 +344,27 @@ 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). +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: UpdateExpanded, Update +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +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. +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: Required: False @@ -375,28 +374,29 @@ 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. +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. ```yaml -Type: IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: -Required: False +Required: True 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. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -424,10 +424,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection) -[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnection) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnectionInstance.md similarity index 96% rename from teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnectionInstance.md index 466a0bf1c7..a397729b44 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,12 @@ --- +author: nunocorreia-ms external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Update-CsTeamsShiftsConnectionInstance -author: nunocorreia-ms ms.author: nunocorreia -manager: -online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance +online version: https://docs.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Update-CsTeamsShiftsConnectionInstance --- # Update-CsTeamsShiftsConnectionInstance @@ -145,6 +145,22 @@ 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/microsoftteams/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 +``` + ### -ConnectorAdminEmail Gets or sets the list of connector admin email addresses. @@ -187,54 +203,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -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: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -IfMatch +The value of the ETag field as returned by the cmdlets. ```yaml Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: (All) Aliases: Required: True Position: Named @@ -243,96 +260,96 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioSwapRequest -The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -InputObject +Identity Parameter ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Name +The connector instance name. ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: Uri +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +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. +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: -Required: False +Required: True 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. +### -SyncFrequencyInMin +The sync frequency in minutes. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: Int32 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False Position: Named @@ -341,12 +358,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The value of the ETag field as returned by the cmdlets. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True Position: Named @@ -355,82 +372,82 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connector instance name. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Uri -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True 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. +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: PSCredential -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True Position: Named @@ -439,59 +456,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin -The sync frequency in minutes. +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Int32 +Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Required: False +Required: True 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). +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: - -Required: False +Required: True 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. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named Default value: None @@ -518,12 +518,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Update-M365TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Update-M365TeamsApp.md similarity index 96% rename from teams/teams-ps/teams/Update-M365TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Update-M365TeamsApp.md index 7fccff1744..168d4ef992 100644 --- a/teams/teams-ps/teams/Update-M365TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Update-M365TeamsApp.md @@ -1,14 +1,15 @@ --- -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 +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 04/24/2024 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Update-M365TeamsApp schema: 2.0.0 +title: Update-M365TeamsApp --- # Update-M365TeamsApp @@ -76,6 +77,22 @@ 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 +``` + ### -Groups List of all the groups for whom the app is enabled or disabled. @@ -108,13 +125,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsBlocked +### -InstallForGroups -The state of the app in the tenant. +List of all the groups for whom the app is installed. ```yaml -Type: Boolean -Parameter Sets: (true, false) +Type: String[] +Parameter Sets: (All) Aliases: Required: False @@ -124,9 +141,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OperationType +### -InstallForOperationType -Operation performed on the app assigment. +Operation performed on the app installation. ```yaml Type: String @@ -140,9 +157,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Users +### -InstallForUsers -List of all the users for whom the app is enabled or disabled. +List of all the users for whom the app is installed. ```yaml Type: String[] @@ -156,13 +173,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppInstallType +### -InstallVersion -App installation type. +App version to be installed. ```yaml Type: String -Parameter Sets: (Everyone, UsersandGroups, Noone) Aliases: Required: True @@ -172,41 +188,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallForOperationType +### -IsBlocked -Operation performed on the app installation. +The state of the app in the tenant. ```yaml -Type: String -Parameter Sets: (Add, Remove) +Type: Boolean +Parameter Sets: (true, false) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallForUsers +### -OperationType -List of all the users for whom the app is installed. +Operation performed on the app assigment. ```yaml -Type: String[] -Parameter Sets: (All) +Type: String +Parameter Sets: (Add, Remove) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallForGroups +### -Users -List of all the groups for whom the app is installed. +List of all the users for whom the app is enabled or disabled. ```yaml Type: String[] @@ -220,21 +236,6 @@ 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). @@ -251,5 +252,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) -[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) +[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/microsoftteams/get-allm365teamsapps) +[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/microsoftteams/get-allm365teamsapps) diff --git a/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedCustomPendingApp.md similarity index 86% rename from teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md rename to teams/teams-ps/MicrosoftTeams/Update-M365UnifiedCustomPendingApp.md index 5408e6cfeb..af52986bbf 100644 --- a/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md +++ b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedCustomPendingApp.md @@ -1,25 +1,26 @@ --- -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 +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: swmerchant +Module Name: MicrosoftTeams +ms.author: mparadis ms.date: 01/20/2025 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Update-M365UnifiedCustomPendingApp schema: 2.0.0 +title: Update-M365UnifiedCustomPendingApp --- # Update-M365UnifiedCustomPendingApp ## SYNOPSIS -This cmdlet updates the review status for a custom Microsoft Teams app that is pending review from an IT Admin. +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 ``` @@ -34,6 +35,7 @@ This cmdlet allows administrators to reject or publish custom Microsoft Teams ap ```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 @@ -41,11 +43,12 @@ Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4 ```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 +### -Id Application ID of the Teams app. @@ -61,7 +64,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### ReviewStatus +### -ReviewStatus The review status of the Teams app. @@ -89,4 +92,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object -## NOTES \ No newline at end of file +## NOTES + +## RELATED LINKS \ No newline at end of file diff --git a/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedTenantSettings.md similarity index 95% rename from teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Update-M365UnifiedTenantSettings.md index ed119948d2..01caa21b7a 100644 --- a/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedTenantSettings.md @@ -1,14 +1,15 @@ --- -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 +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 10/22/2024 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Update-M365UnifiedTenantSettings schema: 2.0.0 +title: Update-M365UnifiedTenantSettings --- # Update-M365UnifiedTenantSettings @@ -45,28 +46,29 @@ Updates the tenant setting for GlobalApp to None ## PARAMETERS -### -SettingName +### -Groups -Setting Name to be changed. +List of all the groups for whom the app is enabled or disabled. ```yaml -Type: String -Parameter Sets: (DefaultApp, GlobalApp, PrivateApp, EnableCopilotExtensibility) +Type: String[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SettingValue -Setting Value to be changed. +### -Operation + +Operation performed (whether we are adding or removing users/groups). ```yaml Type: String -Parameter Sets: (All, None, Some) +Parameter Sets: (add, remove) Aliases: Required: True @@ -76,13 +78,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Operation +### -SettingName -Operation performed (whether we are adding or removing users/groups). +Setting Name to be changed. ```yaml Type: String -Parameter Sets: (add, remove) +Parameter Sets: (DefaultApp, GlobalApp, PrivateApp, EnableCopilotExtensibility) Aliases: Required: True @@ -92,25 +94,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Users - -List of all the users for whom the app is enabled or disabled. +### -SettingValue +Setting Value to be changed. ```yaml -Type: String[] -Parameter Sets: (All) +Type: String +Parameter Sets: (All, None, Some) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Groups +### -Users -List of all the groups for whom the app is enabled or disabled. +List of all the users for whom the app is enabled or disabled. ```yaml Type: String[] diff --git a/teams/teams-ps/teams/Add-TeamsAppInstallation.md b/teams/teams-ps/teams/Add-TeamsAppInstallation.md deleted file mode 100644 index 031a1aa094..0000000000 --- a/teams/teams-ps/teams/Add-TeamsAppInstallation.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -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 ---- - -# Add-TeamsAppInstallation - -## SYNOPSIS -Add a Teams App to Microsoft Teams. - -## SYNTAX - -### TeamScope -``` -Add-TeamsAppInstallation -AppId -TeamId [-Permissions ] [] -``` - -### UserScope -``` -Add-TeamsAppInstallation -AppId -UserId [-Permissions ] [] -``` - -## DESCRIPTION -Add a Teams App to Microsoft Teams. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://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 - -### Example 1 -```powershell -PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example adds a Teams App to Microsoft Teams. - -### Example 2 -```powershell -PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -Permissions "TeamSettings.Read.Group ChannelMessage.Read.Group" -``` - -This example adds a Teams App to Microsoft Teams with RSC Permissions. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Permissions -RSC permissions for the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md index 84d184eb9d..60edafb900 100644 --- a/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md +++ b/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md @@ -13,8 +13,6 @@ schema: 2.0.0 ## SYNOPSIS -**Note:** This cmdlet is currently in public preview. - This cmdlet disables an error report. ## SYNTAX @@ -25,6 +23,8 @@ Disable-CsTeamsShiftsConnectionErrorReport -ErrorReportId [ Applicable: Microsoft Teams + The ID of the error report that you want to disable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None diff --git a/teams/teams-ps/teams/Get-CsDialPlan.md b/teams/teams-ps/teams/Get-CsDialPlan.md deleted file mode 100644 index f7d347abb0..0000000000 --- a/teams/teams-ps/teams/Get-CsDialPlan.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -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/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md deleted file mode 100644 index 86b67ece76..0000000000 --- a/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -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 -title: Get-CsHybridTelephoneNumber -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: - ---- - -# Get-CsHybridTelephoneNumber - -## SYNOPSIS -This cmdlet displays information about one or more hybrid telephone numbers. - -## SYNTAX - -### Assignment (Default) -```powershell -Get-CsHybridTelephoneNumber [-TelephoneNumber ] -InputObject [] -``` - -## DESCRIPTION -This cmdlet displays information about one or more hybrid telephone numbers used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - -Returned results are sorted by telephone number in ascending order. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsHybridTelephoneNumber -TelephoneNumber 14025551234 -``` -```output -Id O365Region SourceType TargetType TelephoneNumber UserId --- ---------- ---------- ---------- --------------- ------ -14025551234 NOAM Hybrid 14025551234 00000000-0000-0000-0000-000000000000 -``` -This example displays information about the phone number +1 (402) 555-1234. - -### Example 2 -```powershell -Get-CsHybridTelephoneNumber -``` -```output -Id O365Region SourceType TargetType TelephoneNumber UserId --- ---------- ---------- ---------- --------------- ------ -14025551234 Hybrid 14025551234 -14025551235 Hybrid 14025551235 -``` -This example displays information about all hybrid telephone numbers in the tenant. Note that O365Region, TargetType, and UserId will not be populated. - -## PARAMETERS - -### -TelephoneNumber -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: -Applicable: Microsoft Teams - -Required: False -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). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -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](https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber) - -[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md b/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md deleted file mode 100644 index 445cec3c6a..0000000000 --- a/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -title: Get-LicenseReportForChangeNotificationSubscription -author: serdarsoysal -ms.author: serdars -manager: alagra -online version: https://learn.microsoft.com/powershell/module/teams/get-licensereportforchangenotificationsubscription -schema: 2.0.0 ---- - -# Get-LicenseReportForChangeNotificationSubscription - -## SYNOPSIS - -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] [] -``` - -## 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](https://learn.microsoft.com/graph/teams-licenses). -This cmdlet is currently supported in preview version only. - -## EXAMPLES - -### Example -```powershell -PS C:\> Get-LicenseReportForChangeNotificationSubscription -Period 7 -``` - -Returns license info and total messages sent by users in the last 7 days. - -## PARAMETERS - -### -Period - -Number of days prior to today. Acceptable values are 7, 30, 90 and 180. - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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-TeamFunSettings.md b/teams/teams-ps/teams/Get-TeamFunSettings.md deleted file mode 100644 index 00fb19db53..0000000000 --- a/teams/teams-ps/teams/Get-TeamFunSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamFunSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teamfunsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamFunSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's fun settings, run Get-Team. - -Gets a team's fun settings. - -## SYNTAX - -``` -Get-TeamFunSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamFunSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamGuestSettings.md b/teams/teams-ps/teams/Get-TeamGuestSettings.md deleted file mode 100644 index 91b260b35c..0000000000 --- a/teams/teams-ps/teams/Get-TeamGuestSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamGuestSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teamguestsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamGuestSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's guest settings, run Get-Team. - -Gets Team guest settings. - -## SYNTAX - -``` -Get-TeamGuestSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamGuestSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamMemberSettings.md b/teams/teams-ps/teams/Get-TeamMemberSettings.md deleted file mode 100644 index f2b4df4491..0000000000 --- a/teams/teams-ps/teams/Get-TeamMemberSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamMemberSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teammembersettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamMemberSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's member settings, run Get-Team. - -Gets team member settings. - -## SYNTAX - -``` -Get-TeamMemberSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamMemberSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamMessagingSettings.md b/teams/teams-ps/teams/Get-TeamMessagingSettings.md deleted file mode 100644 index 75cbd47356..0000000000 --- a/teams/teams-ps/teams/Get-TeamMessagingSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamMessagingSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teammessagingsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamMessagingSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's messaging settings, run Get-Team. - -Gets team messaging settings. - -## SYNTAX - -``` -Get-TeamMessagingSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamMessagingSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamsAppInstallation.md b/teams/teams-ps/teams/Get-TeamsAppInstallation.md deleted file mode 100644 index 39ef59a41c..0000000000 --- a/teams/teams-ps/teams/Get-TeamsAppInstallation.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -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 -ms.reviewer: ---- - -# Get-TeamsAppInstallation - -## SYNOPSIS -Get a Teams App installed in Microsoft Teams. - -## SYNTAX - -### TeamScope (Default) -``` -Get-TeamsAppInstallation -TeamId [-AppInstallationId ] [-AppId ] [] -``` - -### UserScope -``` -Get-TeamsAppInstallation -UserId [-AppInstallationId ] [-AppId ] [] -``` - -## DESCRIPTION -Get a Teams App installed in Microsoft Teams. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://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 - -### Example 1 -```powershell -PS C:\> Get-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example gets a Teams App specifying its AppId and the TeamId. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AppInstallationId -Installation identifier of the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md b/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md deleted file mode 100644 index e85a10218d..0000000000 --- a/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -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: williamlooney ---- - -# Grant-CsCloudMeetingPolicy - -## SYNOPSIS -Grants Skype Meetings polices for a user. - -## SYNTAX - -``` -Grant-CsCloudMeetingPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-Identity] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Grant-CsCloudMeetingPolicy cmdlet enables or disables automatic scheduling of Skype Meetings features for a specified user. -The default is disabled. - -To enable automatic scheduling for all users in a tenant, use the Set-CsCloudMeetingPolicy cmdlet. - -Note that the policies to use this cmdlet are not available unless the Set-CsCloudMeetingConfiguration cmdlet has been run to enable Skype Meetings polices for a tenant. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -Grant-CsCloudMeetingPolicy -PolicyName AutoScheduleEnabled -Identity "JaneC" -``` - -This example enables Skype Meetings automatic scheduling for a user. - -## PARAMETERS - -### -Identity -Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: `-Identity "SeattlePSTN".` - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the policy for all users automatic Skype Meeting Ready scheduling. -Can be either AutoScheduleEnabled or AutoScheduleDisabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -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 - -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: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -@{Text=} - -```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 -``` - -### -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` - -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. -The tenant ID will be determined by your connection and credentials. -The Tenant parameter is primarily for use in a hybrid deployment. - -```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 -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -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/Grant-CsExternalUserCommunicationPolicy.md b/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md deleted file mode 100644 index d587ae4503..0000000000 --- a/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -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: williamlooney ---- - -# Grant-CsExternalUserCommunicationPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsExternalUserCommunicationPolicy [[-Identity] ] [-PolicyName] - [-Tenant ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsExternalUserCommunicationPolicy [-PolicyName] [-Tenant ] - [-DomainController ] [-PassThru] [-Global] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - -## PARAMETERS - -### -PolicyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```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 -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```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 -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md deleted file mode 100644 index ac7c68a354..0000000000 --- a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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 -title: New-CsHybridTelephoneNumber -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# New-CsHybridTelephoneNumber - -## SYNOPSIS -This cmdlet adds a hybrid telephone number to the tenant. - -## SYNTAX - -### Identity (Default) -```powershell -New-CsHybridTelephoneNumber -TelephoneNumber [-Force] -InputObject [] -``` - -## DESCRIPTION -This cmdlet adds a hybrid telephone number to the tenant that can be used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - -## EXAMPLES - -### Example 1 -```powershell -New-CsHybridTelephoneNumber -TelephoneNumber +14025551234 -``` -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'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 -``` - -### -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). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -The cmdlet is only available in GCC High and DoD cloud instances. - -## RELATED LINKS -[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber) - -[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md deleted file mode 100644 index b9ccb97cab..0000000000 --- a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -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/teams/teams-ps/teams/New-CsTeamsCustomBannerText b/teams/teams-ps/teams/New-CsTeamsCustomBannerText deleted file mode 100644 index af23fbf760..0000000000 --- a/teams/teams-ps/teams/New-CsTeamsCustomBannerText +++ /dev/null @@ -1,95 +0,0 @@ ---- -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-CsTeamsPinnedApp.md b/teams/teams-ps/teams/New-CsTeamsPinnedApp.md deleted file mode 100644 index 6c96bf3b11..0000000000 --- a/teams/teams-ps/teams/New-CsTeamsPinnedApp.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -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: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# New-CsTeamsPinnedApp - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -### Identity (Default) -``` -New-CsTeamsPinnedApp [-Tenant ] -Order [-Priority ] [-Identity] - [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey -``` -New-CsTeamsPinnedApp [-Tenant ] -Parent -Id -Order [-Priority ] - [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally not provided - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -Id -Do not use. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do not use. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -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 -``` - -### -Order -Do not use. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parent -Do not use. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Do not use. - -```yaml -Type: Int32 -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md deleted file mode 100644 index 4f3aeb401a..0000000000 --- a/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -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. - -## 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/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText deleted file mode 100644 index 9e9dcd1434..0000000000 --- a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText +++ /dev/null @@ -1,71 +0,0 @@ ---- -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-CsTeamsPinnedApp.md b/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md deleted file mode 100644 index 669b830d56..0000000000 --- a/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csteamspinnedapp -applicable: Microsoft Teams -title: Remove-CsTeamsPinnedApp -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Remove-CsTeamsPinnedApp - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -``` -Remove-CsTeamsPinnedApp [[-Identity] ] - [-Confirm] - [-Force] - [-Tenant ] - [-WhatIf] - [] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally not provided - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-TeamsAppInstallation.md b/teams/teams-ps/teams/Remove-TeamsAppInstallation.md deleted file mode 100644 index 36234579ef..0000000000 --- a/teams/teams-ps/teams/Remove-TeamsAppInstallation.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -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 -ms.reviewer: ---- - -# Remove-TeamsAppInstallation - -## SYNOPSIS -Removes a Teams App installed in Microsoft Teams. - -## SYNTAX - -### TeamScope -``` -Remove-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -TeamId - [] -``` - -### UserScope -``` -Remove-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -UserId - [] -``` - -## DESCRIPTION -Removes a Teams App installed in Microsoft Teams. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://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 - -### Example 1 -```powershell -PS C:\> Remove-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example removes a Teams App in Microsoft Teams specifying its AppId and TeamId. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AppInstallationId -Installation identifier of the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md deleted file mode 100644 index c74a4f85ba..0000000000 --- a/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -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: williamlooney ---- - -# Set-CsGroupPolicyAssignment - -## SYNOPSIS - -> [!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](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) - -[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) - -[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md deleted file mode 100644 index 9b13013f9e..0000000000 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csonlinedialinconferencinguserdefaultnumber -applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingUserDefaultNumber -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Set-CsOnlineDialInConferencingUserDefaultNumber - -## SYNOPSIS -Replace the default toll or toll-free number for all users. - -> [!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 -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain ] [-Tenant ] - -BridgeName [-FromNumber ] -ToNumber -NumberType - [-CountryOrRegion ] [-AreaOrState ] [-CapitalOrMajorCity ] [-RescheduleMeetings] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### FilterByUsageLocation -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain ] [-Tenant ] - [-BridgeName ] -BridgeId -ToNumber -NumberType - -CountryOrRegion [-AreaOrState ] [-CapitalOrMajorCity ] [-RescheduleMeetings] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### UniqueBridgeParams -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain ] [-Tenant ] - -BridgeId -FromNumber -ToNumber -NumberType [-RescheduleMeetings] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineDialInConferencingUserDefaultNumber -FromNumber 14255550100 -ToNumber 14255550101 -NumberType Toll -RescheduleMeetings -BridgeId 9884626f-dcfb-49f4-8025-912f5bc68fdc -``` - -This example replaces the default toll or toll-free number for all users who have the number 14255550100 as a default number to the number 14255550101 and starts the process of rescheduling their meetings. - -## PARAMETERS - -### -BridgeId -The Bridge Id results from running [Get-CsOnlineDialInConferencingBridge](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge) -For example "9884626f-dcfb-49f4-8025-912f5bc68fdc". You can either specify BridgeName or BridgeId. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BridgeName -The Bridge Name results from running [Get-CsOnlineDialInConferencingBridge](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge) -For example "Conference Bridge". You can either specify BridgeName or BridgeId. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -A String representing the Country or Region this Dial In Conferencing Default number belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromNumber -The current default number defined. -$null if no number defined. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberType -The type of number this Dial In Conferencing Default number has. -Valid values are - -- Toll -- TollFree - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToNumber -The new number to assign, without the + sign, for example 14255550101. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AreaOrState -A String representing the Area or State this Dial In Conferencing Default number belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapitalOrMajorCity -A String representing the Capital or Major City this Dial In Conferencing Default number belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 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 -``` - -### -RescheduleMeetings -Sends e-mail notifications to Meeting attendees with the updated settings. - -```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 -``` - -### -TenantDomain -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 -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText deleted file mode 100644 index e13c9bf900..0000000000 --- a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText +++ /dev/null @@ -1,93 +0,0 @@ ---- -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-CsTeamsPinnedApp.md b/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md deleted file mode 100644 index fac26286e2..0000000000 --- a/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csteamspinnedapp -applicable: Microsoft Teams -title: Set-CsTeamsPinnedApp -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Set-CsTeamsPinnedApp - -## SYNOPSIS -**NOTE**: This cmdlet has been deprecated. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsPinnedApp [-Tenant ] [-Order ] [-Priority ] [[-Identity] ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTeamsPinnedApp [-Tenant ] [-Order ] [-Priority ] [-Instance ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**NOTE**: This cmdlet has been deprecated. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally not provided. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do not use. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Do not use. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Order -Do not use. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Do not use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Do not use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamFunSettings.md b/teams/teams-ps/teams/Set-TeamFunSettings.md deleted file mode 100644 index b0c4f9d5ab..0000000000 --- a/teams/teams-ps/teams/Set-TeamFunSettings.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamFunSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teamfunsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamFunSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Update Giphy, Stickers and Memes settings. - -## SYNTAX - -``` -Set-TeamFunSettings -GroupId [-AllowGiphy ] [-GiphyContentRating ] - [-AllowStickersAndMemes ] [-AllowCustomMemes ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamFunSettings -GroupId 0ebb500c-f5f3-44dd-b155-cc8c4f383e2d -AllowGiphy true -GiphyContentRating Strict -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowGiphy -Setting to enable giphy for team - -```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 -``` - -### -GiphyContentRating -Settings to set content rating for giphy. -Can be "Strict" or "Moderate" - -```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 -``` - -### -AllowStickersAndMemes -Enable Stickers and memes - -```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 -``` - -### -AllowCustomMemes -Allow custom memes to be uploaded - -```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 -``` - -## INPUTS - -### GroupId, AllowGiphy, GiphyContentRating, AllowStickersAndMemes, AllowCustomMemes - - -## OUTPUTS - - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamGuestSettings.md b/teams/teams-ps/teams/Set-TeamGuestSettings.md deleted file mode 100644 index 97674abb46..0000000000 --- a/teams/teams-ps/teams/Set-TeamGuestSettings.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamGuestSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teamguestsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamGuestSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Updates team guest settings. - -## SYNTAX - -``` -Set-TeamGuestSettings -GroupId [-AllowCreateUpdateChannels ] [-AllowDeleteChannels ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamGuestSettings -GroupId a61f5a96-a0cf-43db-a7c8-cec05f8a8fc4 -AllowCreateUpdateChannels true -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowCreateUpdateChannels -Settings to create and update channels - -```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 -``` - -### -AllowDeleteChannels -Settings to Delete channels - -```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 -``` - -## INPUTS - -### GroupId - -### AllowCreateUpdateChannels - -### AllowDeleteChannels - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamMemberSettings.md b/teams/teams-ps/teams/Set-TeamMemberSettings.md deleted file mode 100644 index 0e21dfe1c8..0000000000 --- a/teams/teams-ps/teams/Set-TeamMemberSettings.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamMemberSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teammembersettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamMemberSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Updates team member settings. - -## SYNTAX - -``` -Set-TeamMemberSettings -GroupId [-AllowCreateUpdateChannels ] [-AllowDeleteChannels ] - [-AllowAddRemoveApps ] [-AllowCreateUpdateRemoveTabs ] - [-AllowCreateUpdateRemoveConnectors ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamMemberSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowCreateUpdateChannels false -``` - -### -------------------------- Example 2 -------------------------- -``` -Set-TeamMemberSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowDeleteChannels true -AllowAddRemoveApps false -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowCreateUpdateChannels -Setting to create and update channels - -```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 -``` - -### -AllowDeleteChannels -Setting to Delete channels - -```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 -``` - -### -AllowAddRemoveApps -Setting to add and remove apps to teams - -```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 -``` - -### -AllowCreateUpdateRemoveTabs -Setting to create, update and remove tabs - -```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 -``` - -### -AllowCreateUpdateRemoveConnectors -Setting to create, update and remove connectors - -```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 -``` - -## INPUTS - -### GroupId - -### AllowCreateUpdateChannels - -### AllowDeleteChannels - -### AllowAddRemoveApps - -### AllowCreateUpdateRemoveTabs - -### AllowCreateUpdateRemoveConnectors - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamMessagingSettings.md b/teams/teams-ps/teams/Set-TeamMessagingSettings.md deleted file mode 100644 index eebbf86afa..0000000000 --- a/teams/teams-ps/teams/Set-TeamMessagingSettings.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamMessagingSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teammessagingsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamMessagingSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Updates team messaging settings. - -## SYNTAX - -``` -Set-TeamMessagingSettings -GroupId [-AllowUserEditMessages ] - [-AllowUserDeleteMessages ] [-AllowOwnerDeleteMessages ] [-AllowTeamMentions ] - [-AllowChannelMentions ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamMessagingSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowUserEditMessages true -``` - -### -------------------------- Example 2 -------------------------- -``` -Set-TeamMessagingSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowUserDeleteMessages false -AllowChannelMentions true -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUserEditMessages -Setting to allow user to edit messages - -```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 -``` - -### -AllowUserDeleteMessages -Setting to allow user to delete messages - -```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 -``` - -### -AllowOwnerDeleteMessages -Setting to allow owner to Delete messages - -```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 -``` - -### -AllowTeamMentions -Allow @team or @\[team name\] mentions. -This will notify everyone in the team - -```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 -``` - -### -AllowChannelMentions -Allow @channel or @\[channel name\] mentions. -This wil notify members who've favorited that channel - -```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 -``` - -## INPUTS - -### GroupId - -### AllowUserEditMessages - -### AllowUserDeleteMessages - -### AllowOwnerDeleteMessages - -### AllowTeamMentions - -### AllowChannelMentions - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md b/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md deleted file mode 100644 index 42891b66a8..0000000000 --- a/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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/Update-TeamsAppInstallation.md b/teams/teams-ps/teams/Update-TeamsAppInstallation.md deleted file mode 100644 index d7ce547680..0000000000 --- a/teams/teams-ps/teams/Update-TeamsAppInstallation.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -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 -ms.reviewer: ---- - -# Update-TeamsAppInstallation - -## SYNOPSIS -Update a Teams App in Microsoft Teams. - -## SYNTAX - -### TeamScope -``` -Update-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -TeamId - [-Permissions ] [] -``` - -### UserScope -``` -Update-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -UserId - [-Permissions ] [] -``` - -## DESCRIPTION -Update a Teams App in Microsoft Teams. -This won't update teams client; this will update an application installed on the user/team. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://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 - -### Example 1 -```powershell -PS C:\> Update-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example updates a Teams App in Microsoft Teams specifying its AppId and TeamId. - -### Example 2 -```powershell -PS C:\> Update-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -Permissions "TeamSettings.Read.Group ChannelMessage.Read.Group" -``` - -This example updates a Teams App in Microsoft Teams specifying its AppId and TeamId and RSC Permissions. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AppInstallationId -Installation identifier of the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Permissions -RSC permissions for the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/teams.md b/teams/teams-ps/teams/teams.md deleted file mode 100644 index 058504f325..0000000000 --- a/teams/teams-ps/teams/teams.md +++ /dev/null @@ -1,548 +0,0 @@ ---- -Module Name: Microsoft Teams PowerShell -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -title: teams ---- - -# Microsoft Teams PowerShell - -## Description -The following cmdlet references are for Microsoft Teams. - -## Microsoft Teams Cmdlets - -### [Add-TeamChannelUser](Add-TeamChannelUser.md) -### [Add-TeamsAppInstallation](Add-TeamsAppInstallation.md) -### [Add-TeamUser](Add-TeamUser.md) -### [Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) -### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md) -### [Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) -### [Connect-MicrosoftTeams](Connect-MicrosoftTeams.md) -### [Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) -### [Disable-CsTeamsShiftsConnectionErrorReport](Disable-CsTeamsShiftsConnectionErrorReport.md) -### [Disconnect-MicrosoftTeams](Disconnect-MicrosoftTeams.md) -### [Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) -### [Export-CsAcquiredPhoneNumber](Export-CsAcquiredPhoneNumber.md) -### [Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) -### [export-csonlineaudiofile](export-csonlineaudiofile.md) -### [Find-CsGroup](Find-CsGroup.md) -### [Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) -### [Get-AssociatedTeam](Get-AssociatedTeam.md) -### [Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) -### [Get-CsApplicationMeetingConfiguration](Get-CsApplicationMeetingConfiguration.md) -### [Get-CsAutoAttendant](Get-CsAutoAttendant.md) -### [Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) -### [Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) -### [Get-CsAutoAttendantSupportedLanguage](Get-CsAutoAttendantSupportedLanguage.md) -### [Get-CsAutoAttendantSupportedTimeZone](Get-CsAutoAttendantSupportedTimeZone.md) -### [Get-CsAutoAttendantTenantInformation](Get-CsAutoAttendantTenantInformation.md) -### [Get-CsBatchPolicyAssignmentOperation](Get-CsBatchPolicyAssignmentOperation.md) -### [Get-CsBatchTeamsDeploymentStatus](Get-CsBatchTeamsDeploymentStatus.md) -### [Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) -### [Get-CsCallQueue](Get-CsCallQueue.md) -### [Get-CsCloudCallDataConnection](Get-CsCloudCallDataConnection.md) -### [Get-CsDialPlan](Get-CsDialPlan.md) -### [Get-CsEffectiveTenantDialPlan](Get-CsEffectiveTenantDialPlan.md) -### [Get-CsExportAcquiredPhoneNumberStatus](Get-CsExportAcquiredPhoneNumberStatus.md) -### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) -### [Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) -### [Get-CsHybridTelephoneNumber](Get-CsHybridTelephoneNumber.md) -### [Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) -### [Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) -### [Get-CsMeetingMigrationStatus](Get-CsMeetingMigrationStatus.md) -### [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) -### [Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) -### [Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) -### [Get-CsCsOnlineAudioConferencingRoutingPolicy][Get-CsOnlineAudioConferencingRoutingPolicy.md] -### [Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) -### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) -### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) -### [Get-CsOnlineDialinConferencingTenantConfiguration](Get-CsOnlineDialinConferencingTenantConfiguration.md) -### [Get-CsOnlineDialInConferencingTenantSettings](Get-CsOnlineDialInConferencingTenantSettings.md) -### [Get-CsOnlineDialInConferencingUser](Get-CsOnlineDialInConferencingUser.md) -### [Get-CsOnlineDialOutPolicy](Get-CsOnlineDialOutPolicy.md) -### [Get-CsOnlineDirectoryTenant](Get-CsOnlineDirectoryTenant.md) -### [Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) -### [Get-CsOnlineLisCivicAddress](Get-CsOnlineLisCivicAddress.md) -### [Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) -### [Get-CsOnlineLisPort](Get-CsOnlineLisPort.md) -### [Get-CsOnlineLisSubnet](Get-CsOnlineLisSubnet.md) -### [Get-CsOnlineLisSwitch](Get-CsOnlineLisSwitch.md) -### [Get-CsOnlineLisWirelessAccessPoint](Get-CsOnlineLisWirelessAccessPoint.md) -### [Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) -### [Get-CsOnlinePstnUsage](Get-CsOnlinePstnUsage.md) -### [Get-CsOnlineSchedule](Get-CsOnlineSchedule.md) -### [Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) -### [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) -### [Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) -### [Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) -### [Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) -### [Get-CsOnlineUser](Get-CsOnlineUser.md) -### [Get-CsOnlineVoicemailPolicy](Get-CsOnlineVoicemailPolicy.md) -### [Get-CsOnlineVoicemailUserSettings](Get-CsOnlineVoicemailUserSettings.md) -### [Get-CsOnlineVoiceRoute](Get-CsOnlineVoiceRoute.md) -### [Get-CsOnlineVoiceRoutingPolicy](Get-CsOnlineVoiceRoutingPolicy.md) -### [Get-CsOnlineVoiceUser](Get-CsOnlineVoiceUser.md) -### [Get-CsPhoneNumberAssignment](Get-CsPhoneNumberAssignment.md) -### [Get-CsPolicyPackage](Get-CsPolicyPackage.md) -### [Get-CsTeamsAcsFederationConfiguration](Get-CsTeamsAcsFederationConfiguration.md) -### [Get-CsTeamsAppPermissionPolicy](Get-CsTeamsAppPermissionPolicy.md) -### [Get-CsTeamsAppSetupPolicy](Get-CsTeamsAppSetupPolicy.md) -### [Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) -### [Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) -### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) -### [Get-CsTeamsCallParkPolicy](Get-CsTeamsCallParkPolicy.md) -### [Get-CsTeamsChannelsPolicy](Get-CsTeamsChannelsPolicy.md) -### [Get-CsTeamsClientConfiguration](Get-CsTeamsClientConfiguration.md) -### [Get-CsTeamsComplianceRecordingApplication](Get-CsTeamsComplianceRecordingApplication.md) -### [Get-CsTeamsComplianceRecordingPolicy](Get-CsTeamsComplianceRecordingPolicy.md) -### [Get-CsTeamsCortanaPolicy](Get-CsTeamsCortanaPolicy.md) -### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) -### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) -### [Get-CsTeamsEducationAssignmentsAppPolicy](Get-CsTeamsEducationAssignmentsAppPolicy.md) -### [Get-CsTeamsEducationConfiguration](Get-CsTeamsEducationConfiguration.md) -### [Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) -### [Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) -### [Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) -### [Get-CsTeamsEventsPolicy](Get-CsTeamsEventsPolicy.md) -### [Get-CsTeamsFeedbackPolicy](Get-CsTeamsFeedbackPolicy.md) -### [Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) -### [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) -### [Get-CsTeamsGuestCallingConfiguration](Get-CsTeamsGuestCallingConfiguration.md) -### [Get-CsTeamsGuestMeetingConfiguration](Get-CsTeamsGuestMeetingConfiguration.md) -### [Get-CsTeamsGuestMessagingConfiguration](Get-CsTeamsGuestMessagingConfiguration.md) -### [Get-CsTeamsIPPhonePolicy](Get-CsTeamsIPPhonePolicy.md) -### [Get-CsTeamsMediaLoggingPolicy](Get-CsTeamsMediaLoggingPolicy.md) -### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) -### [Get-CsTeamsMeetingBroadcastConfiguration](Get-CsTeamsMeetingBroadcastConfiguration.md) -### [Get-CsTeamsMeetingBroadcastPolicy](Get-CsTeamsMeetingBroadcastPolicy.md) -### [Get-CsTeamsMeetingConfiguration](Get-CsTeamsMeetingConfiguration.md) -### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) -### [Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) -### [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Get-CsTeamsMessagingConfiguration](Get-CsTeamsMessagingConfiguration.md) -### [Get-CsTeamsMessagingPolicy](Get-CsTeamsMessagingPolicy.md) -### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) -### [Get-CsTeamsNetworkRoamingPolicy](Get-CsTeamsNetworkRoamingPolicy.md) -### [Get-CsTeamsRecordingRollOutPolicy](Get-CsTeamsRecordingRollOutPolicy.md) -### [Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) -### [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) -### [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) -### [Get-CsTeamsShiftsConnectionErrorReport](Get-CsTeamsShiftsConnectionErrorReport.md) -### [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) -### [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md) -### [Get-CsTeamsShiftsConnectionSyncResult](Get-CsTeamsShiftsConnectionSyncResult.md) -### [Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) -### [Get-CsTeamsShiftsConnectionWfmTeam](Get-CsTeamsShiftsConnectionWfmTeam.md) -### [Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) -### [Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) -### [Get-CsTeamsSipDevicesConfiguration](Get-CsTeamsSipDevicesConfiguration.md) -### [Get-CsTeamsSurvivableBranchAppliance](Get-CsTeamsSurvivableBranchAppliance.md) -### [Get-CsTeamsSurvivableBranchAppliancePolicy](Get-CsTeamsSurvivableBranchAppliancePolicy.md) -### [Get-CsTeamsTargetingPolicy](Get-CsTeamsTargetingPolicy.md) -### [Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) -### [Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) -### [Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) -### [Get-CsTeamsUpdateManagementPolicy](Get-CsTeamsUpdateManagementPolicy.md) -### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) -### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) -### [Get-CsTeamsVdiPolicy](Get-CsTeamsVdiPolicy.md) -### [Get-CsTeamsVideoInteropServicePolicy](Get-CsTeamsVideoInteropServicePolicy.md) -### [Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) -### [Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) -### [Get-CsTeamsWorkLoadPolicy](Get-CsTeamsWorkLoadPolicy.md) -### [Get-CsTeamsWorkLocationDetectionPolicy](Get-CsTeamsWorkLocationDetectionPolicy.md) -### [Get-CsTeamTemplate](Get-CsTeamTemplate.md) -### [Get-CsTeamTemplateList](Get-CsTeamTemplateList.md) -### [Get-CsTenant](Get-CsTenant.md) -### [Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) -### [Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) -### [Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) -### [Get-CsTenantLicensingConfiguration](Get-CsTenantLicensingConfiguration.md) -### [Get-CsTenantMigrationConfiguration](Get-CsTenantMigrationConfiguration.md) -### [Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) -### [Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) -### [Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) -### [Get-CsTenantTrustedIPAddress](Get-CsTenantTrustedIPAddress.md) -### [Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) -### [Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md) -### [Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) -### [Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) -### [Get-CsVideoInteropServiceProvider](Get-CsVideoInteropServiceProvider.md) -### [Get-LicenseReportForChangeNotificationSubscription](Get-LicenseReportForChangeNotificationSubscription.md) -### [Get-M365UnifiedCustomPendingApps](Get-M365UnifiedCustomPendingApps.md) -### [Get-SharedWithTeam](Get-SharedWithTeam.md) -### [Get-SharedWithTeamUser](Get-SharedWithTeamUser.md) -### [Get-Team](Get-Team.md) -### [Get-TeamAllChannel](Get-TeamAllChannel.md) -### [Get-TeamChannel](Get-TeamChannel.md) -### [Get-TeamChannelUser](Get-TeamChannelUser.md) -### [Get-TeamFunSettings](Get-TeamFunSettings.md) -### [Get-TeamGuestSettings](Get-TeamGuestSettings.md) -### [Get-TeamIncomingChannel](Get-TeamIncomingChannel.md) -### [Get-TeamMemberSettings](Get-TeamMemberSettings.md) -### [Get-TeamMessagingSettings](Get-TeamMessagingSettings.md) -### [Get-TeamsApp](Get-TeamsApp.md) -### [Get-TeamsAppInstallation](Get-TeamsAppInstallation.md) -### [Get-TeamTargetingHierarchyStatus](Get-TeamTargetingHierarchyStatus.md) -### [Get-TeamUser](Get-TeamUser.md) -### [Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) -### [Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) -### [Grant-CsCloudMeetingPolicy](Grant-CsCloudMeetingPolicy.md) -### [Grant-CsDialoutPolicy](Grant-CsDialoutPolicy.md) -### [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) -### [Grant-CsExternalUserCommunicationPolicy](Grant-CsExternalUserCommunicationPolicy.md) -### [Grant-CsGroupPolicyPackageAssignment](Grant-CsGroupPolicyPackageAssignment.md) -### [Grant-CsOnlineVoicemailPolicy](Grant-CsOnlineVoicemailPolicy.md) -### [Grant-CsOnlineVoiceRoutingPolicy](Grant-CsOnlineVoiceRoutingPolicy.md) -### [Grant-CsTeamsAppPermissionPolicy](Grant-CsTeamsAppPermissionPolicy.md) -### [Grant-CsTeamsAppSetupPolicy](Grant-CsTeamsAppSetupPolicy.md) -### [Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) -### [Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) -### [Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) -### [Grant-CsTeamsCallParkPolicy](Grant-CsTeamsCallParkPolicy.md) -### [Grant-CsTeamsChannelsPolicy](Grant-CsTeamsChannelsPolicy.md) -### [Grant-CsTeamsComplianceRecordingPolicy](Grant-CsTeamsComplianceRecordingPolicy.md) -### [Grant-CsTeamsCortanaPolicy](Grant-CsTeamsCortanaPolicy.md) -### [Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) -### [Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) -### [Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) -### [Grant-CsTeamsEventsPolicy](Grant-CsTeamsEventsPolicy.md) -### [Grant-CsTeamsFeedbackPolicy](Grant-CsTeamsFeedbackPolicy.md) -### [Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) -### [Grant-CsTeamsIPPhonePolicy](Grant-CsTeamsIPPhonePolicy.md) -### [Grant-CsTeamsMediaLoggingPolicy](Grant-CsTeamsMediaLoggingPolicy.md) -### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) -### [Grant-CsTeamsMeetingBroadcastPolicy](Grant-CsTeamsMeetingBroadcastPolicy.md) -### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) -### [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Grant-CsTeamsMessagingPolicy](Grant-CsTeamsMessagingPolicy.md) -### [Grant-CsTeamsMobilityPolicy](Grant-CsTeamsMobilityPolicy.md) -### [Grant-CsTeamsRecordingRollOutPolicy](Grant-CsTeamsRecordingRollOutPolicy.md) -### [Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) -### [Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) -### [Grant-CsTeamsUpdateManagementPolicy](Grant-CsTeamsUpdateManagementPolicy.md) -### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -### [Grant-CsTeamsVdiPolicy](Grant-CsTeamsVdiPolicy.md) -### [Grant-CsTeamsVideoInteropServicePolicy](Grant-CsTeamsVideoInteropServicePolicy.md) -### [Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) -### [Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) -### [Grant-CsTeamsWorkLoadPolicy](Grant-CsTeamsWorkLoadPolicy.md) -### [Grant-CsTeamsWorkLocationDetectionPolicy](Grant-CsTeamsWorkLocationDetectionPolicy.md) -### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) -### [Grant-CsUserPolicyPackage](Grant-CsUserPolicyPackage.md) -### [Import-CsAutoAttendantHolidays](Import-CsAutoAttendantHolidays.md) -### [Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) -### [New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) -### [New-CsAutoAttendant](New-CsAutoAttendant.md) -### [New-CsAutoAttendantCallableEntity](New-CsAutoAttendantCallableEntity.md) -### [New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) -### [New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md) -### [New-CsAutoAttendantDialScope](New-CsAutoAttendantDialScope.md) -### [New-CsAutoAttendantMenu](New-CsAutoAttendantMenu.md) -### [New-CsAutoAttendantMenuOption](New-CsAutoAttendantMenuOption.md) -### [New-CsAutoAttendantPrompt](New-CsAutoAttendantPrompt.md) -### [New-CsBatchPolicyAssignmentOperation](New-CsBatchPolicyAssignmentOperation.md) -### [New-CsBatchPolicyPackageAssignmentOperation](New-CsBatchPolicyPackageAssignmentOperation.md) -### [New-CsBatchTeamsDeployment](New-CsBatchTeamsDeployment.md) -### [New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) -### [New-CsCallQueue](New-CsCallQueue.md) -### [New-CsCloudCallDataConnection](New-CsCloudCallDataConnection.md) -### [New-CsCustomPolicyPackage](New-CsCustomPolicyPackage.md) -### [New-CsEdgeAllowAllKnownDomains](New-CsEdgeAllowAllKnownDomains.md) -### [New-CsEdgeAllowList](New-CsEdgeAllowList.md) -### [New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) -### [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) -### [New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md) -### [New-CsHybridTelephoneNumber](New-CsHybridTelephoneNumber.md) -### [New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) -### [New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) -### [New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) -### [New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) -### [New-CsCsOnlineAudioConferencingRoutingPolicy][New-CsOnlineAudioConferencingRoutingPolicy.md] -### [New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) -### [New-CsOnlineLisCivicAddress](New-CsOnlineLisCivicAddress.md) -### [New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) -### [New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) -### [New-CsOnlineSchedule](New-CsOnlineSchedule.md) -### [New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) -### [New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) -### [New-CsOnlineVoicemailPolicy](New-CsOnlineVoicemailPolicy.md) -### [New-CsOnlineVoiceRoute](New-CsOnlineVoiceRoute.md) -### [New-CsOnlineVoiceRoutingPolicy](New-CsOnlineVoiceRoutingPolicy.md) -### [New-CsTeamsAppPermissionPolicy](New-CsTeamsAppPermissionPolicy.md) -### [New-CsTeamsAppSetupPolicy](New-CsTeamsAppSetupPolicy.md) -### [New-CsTeamsAudioConferencingPolicy](New-CsTeamsAudioConferencingPolicy.md) -### [New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) -### [New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) -### [New-CsTeamsCallParkPolicy](New-CsTeamsCallParkPolicy.md) -### [New-CsTeamsChannelsPolicy](New-CsTeamsChannelsPolicy.md) -### [New-CsTeamsComplianceRecordingApplication](New-CsTeamsComplianceRecordingApplication.md) -### [New-CsTeamsComplianceRecordingPairedApplication](New-CsTeamsComplianceRecordingPairedApplication.md) -### [New-CsTeamsComplianceRecordingPolicy](New-CsTeamsComplianceRecordingPolicy.md) -### [New-CsTeamsCortanaPolicy](New-CsTeamsCortanaPolicy.md) -### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) -### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) -### [New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) -### [New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) -### [New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) -### [New-CsTeamsEmergencyNumber](New-CsTeamsEmergencyNumber.md) -### [New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) -### [New-CsTeamsEventsPolicy](New-CsTeamsEventsPolicy.md) -### [New-CsTeamsFeedbackPolicy](New-CsTeamsFeedbackPolicy.md) -### [New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) -### [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md) -### [New-CsTeamsHiddenTemplate](New-CsTeamsHiddenTemplate.md) -### [New-CsTeamsIPPhonePolicy](New-CsTeamsIPPhonePolicy.md) -### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) -### [New-CsTeamsMeetingBroadcastPolicy](New-CsTeamsMeetingBroadcastPolicy.md) -### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) -### [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) -### [New-CsTeamsMessagingPolicy](New-CsTeamsMessagingPolicy.md) -### [New-CsTeamsMobilityPolicy](New-CsTeamsMobilityPolicy.md) -### [New-CsTeamsNetworkRoamingPolicy](New-CsTeamsNetworkRoamingPolicy.md) -### [New-CsTeamsPinnedApp](New-CsTeamsPinnedApp.md) -### [New-CsTeamsRecordingRollOutPolicy](New-CsTeamsRecordingRollOutPolicy.md) -### [New-CsTeamsSharedCallingRoutingPolicy](New-CsTeamsSharedCallingRoutingPolicy.md) -### [New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) -### [New-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.md) -### [New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) -### [New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) -### [New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) -### [New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) -### [New-CsTeamsUnassignedNumberTreatment](New-CsTeamsUnassignedNumberTreatment.md) -### [New-CsTeamsUpdateManagementPolicy](New-CsTeamsUpdateManagementPolicy.md) -### [New-CsTeamsVdiPolicy](New-CsTeamsVdiPolicy.md) -### [New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) -### [New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) -### [New-CsTeamsWorkLoadPolicy](New-CsTeamsWorkLoadPolicy.md) -### [New-CsTeamsWorkLocationDetectionPolicy](New-CsTeamsWorkLocationDetectionPolicy.md) -### [New-CsTeamTemplate](New-CsTeamTemplate.md) -### [New-CsTenantDialPlan](New-CsTenantDialPlan.md) -### [New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) -### [New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) -### [New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) -### [New-CsTenantTrustedIPAddress](New-CsTenantTrustedIPAddress.md) -### [New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) -### [New-CsVideoInteropServiceProvider](New-CsVideoInteropServiceProvider.md) -### [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) -### [New-Team](New-Team.md) -### [New-TeamChannel](New-TeamChannel.md) -### [New-TeamsApp](New-TeamsApp.md) -### [Register-CsOnlineDialInConferencingServiceNumber](Register-CsOnlineDialInConferencingServiceNumber.md) -### [Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) -### [Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) -### [Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) -### [Remove-CsCallQueue](Remove-CsCallQueue.md) -### [Remove-CsCustomPolicyPackage](Remove-CsCustomPolicyPackage.md) -### [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) -### [Remove-CsGroupPolicyAssignment](Remove-CsGroupPolicyAssignment.md) -### [Remove-CsHybridTelephoneNumber](Remove-CsHybridTelephoneNumber.md) -### [Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) -### [Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) -### [Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) -### [Remove-CsCsOnlineAudioConferencingRoutingPolicy][Remove-CsOnlineAudioConferencingRoutingPolicy.md] -### [Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) -### [Remove-CsOnlineDialInConferencingTenantSettings](Remove-CsOnlineDialInConferencingTenantSettings.md) -### [Remove-CsOnlineLisCivicAddress](Remove-CsOnlineLisCivicAddress.md) -### [Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) -### [Remove-CsOnlineLisPort](Remove-CsOnlineLisPort.md) -### [Remove-CsOnlineLisSubnet](Remove-CsOnlineLisSubnet.md) -### [Remove-CsOnlineLisSwitch](Remove-CsOnlineLisSwitch.md) -### [Remove-CsOnlineLisWirelessAccessPoint](Remove-CsOnlineLisWirelessAccessPoint.md) -### [Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) -### [Remove-CsOnlineSchedule](Remove-CsOnlineSchedule.md) -### [Remove-CsOnlineTelephoneNumber](Remove-CsOnlineTelephoneNumber.md) -### [Remove-CsOnlineVoicemailPolicy](Remove-CsOnlineVoicemailPolicy.md) -### [Remove-CsOnlineVoiceRoute](Remove-CsOnlineVoiceRoute.md) -### [Remove-CsOnlineVoiceRoutingPolicy](Remove-CsOnlineVoiceRoutingPolicy.md) -### [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) -### [Remove-CsTeamsAppPermissionPolicy](Remove-CsTeamsAppPermissionPolicy.md) -### [Remove-CsTeamsAppSetupPolicy](Remove-CsTeamsAppSetupPolicy.md) -### [Remove-CsTeamsAudioConferencingPolicy](Remove-CsTeamsAudioConferencingPolicy.md) -### [Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) -### [Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) -### [Remove-CsTeamsCallParkPolicy](Remove-CsTeamsCallParkPolicy.md) -### [Remove-CsTeamsChannelsPolicy](Remove-CsTeamsChannelsPolicy.md) -### [Remove-CsTeamsComplianceRecordingApplication](Remove-CsTeamsComplianceRecordingApplication.md) -### [Remove-CsTeamsComplianceRecordingPolicy](Remove-CsTeamsComplianceRecordingPolicy.md) -### [Remove-CsTeamsCortanaPolicy](Remove-CsTeamsCortanaPolicy.md) -### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) -### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) -### [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) -### [Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) -### [Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) -### [Remove-CsTeamsEventsPolicy](Remove-CsTeamsEventsPolicy.md) -### [Remove-CsTeamsFeedbackPolicy](Remove-CsTeamsFeedbackPolicy.md) -### [Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) -### [Remove-CsTeamsIPPhonePolicy](Remove-CsTeamsIPPhonePolicy.md) -### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) -### [Remove-CsTeamsMeetingBroadcastPolicy](Remove-CsTeamsMeetingBroadcastPolicy.md) -### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) -### [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Remove-CsTeamsMessagingPolicy](Remove-CsTeamsMessagingPolicy.md) -### [Remove-CsTeamsMobilityPolicy](Remove-CsTeamsMobilityPolicy.md) -### [Remove-CsTeamsNetworkRoamingPolicy](Remove-CsTeamsNetworkRoamingPolicy.md) -### [Remove-CsTeamsPinnedApp](Remove-CsTeamsPinnedApp.md) -### [Remove-CsTeamsRecordingRollOutPolicy](Remove-CsTeamsRecordingRollOutPolicy.md) -### [Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) -### [Remove-CsTeamsShiftsConnection](Remove-CsTeamsShiftsConnection.md) -### [Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) -### [Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) -### [Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) -### [Remove-CsTeamsShiftsScheduleRecord](Remove-CsTeamsShiftsScheduleRecord.md) -### [Remove-CsTeamsSurvivableBranchAppliance](Remove-CsTeamsSurvivableBranchAppliance.md) -### [Remove-CsTeamsSurvivableBranchAppliancePolicy](Remove-CsTeamsSurvivableBranchAppliancePolicy.md) -### [Remove-CsTeamsTargetingPolicy](Remove-CsTeamsTargetingPolicy.md) -### [Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) -### [Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) -### [Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) -### [Remove-CsTeamsUpdateManagementPolicy](Remove-CsTeamsUpdateManagementPolicy.md) -### [Remove-CsTeamsVdiPolicy](Remove-CsTeamsVdiPolicy.md) -### [Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) -### [Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) -### [Remove-CsTeamsWorkLoadPolicy](Remove-CsTeamsWorkLoadPolicy.md) -### [Remove-CsTeamsWorkLocationDetectionPolicy](Remove-CsTeamsWorkLocationDetectionPolicy.md) -### [Remove-CsTeamTemplate](Remove-CsTeamTemplate.md) -### [Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) -### [Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) -### [Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) -### [Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) -### [Remove-CsTenantTrustedIPAddress](Remove-CsTenantTrustedIPAddress.md) -### [Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) -### [Remove-CsVideoInteropServiceProvider](Remove-CsVideoInteropServiceProvider.md) -### [Remove-SharedWithTeam](Remove-SharedWithTeam.md) -### [Remove-Team](Remove-Team.md) -### [Remove-TeamChannel](Remove-TeamChannel.md) -### [Remove-TeamChannelUser](Remove-TeamChannelUser.md) -### [Remove-TeamsApp](Remove-TeamsApp.md) -### [Remove-TeamsAppInstallation](Remove-TeamsAppInstallation.md) -### [Remove-TeamTargetingHierarchy](Remove-TeamTargetingHierarchy.md) -### [Remove-TeamUser](Remove-TeamUser.md) -### [Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) -### [Set-CsApplicationMeetingConfiguration](Set-CsApplicationMeetingConfiguration.md) -### [Set-CsAutoAttendant](Set-CsAutoAttendant.md) -### [Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) -### [Set-CsCallQueue](Set-CsCallQueue.md) -### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) -### [Set-CsGroupPolicyAssignment](Set-CsGroupPolicyAssignment.md) -### [Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) -### [Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) -### [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) -### [Set-CsCsOnlineAudioConferencingRoutingPolicy][Set-CsOnlineAudioConferencingRoutingPolicy.md] -### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) -### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) -### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md) -### [Set-CsOnlineDialInConferencingUser](Set-CsOnlineDialInConferencingUser.md) -### [Set-CsOnlineEnhancedEmergencyServiceDisclaimer](Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md) -### [Set-CsOnlineLisCivicAddress](Set-CsOnlineLisCivicAddress.md) -### [Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) -### [Set-CsOnlineLisPort](Set-CsOnlineLisPort.md) -### [Set-CsOnlineLisSubnet](Set-CsOnlineLisSubnet.md) -### [Set-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) -### [Set-CsOnlineLisWirelessAccessPoint](Set-CsOnlineLisWirelessAccessPoint.md) -### [Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) -### [Set-CsOnlinePstnUsage](Set-CsOnlinePstnUsage.md) -### [Set-CsOnlineSchedule](Set-CsOnlineSchedule.md) -### [Set-CsOnlineVoiceApplicationInstance](Set-CsOnlineVoiceApplicationInstance.md) -### [Set-CsOnlineVoicemailPolicy](Set-CsOnlineVoicemailPolicy.md) -### [Set-CsOnlineVoicemailUserSettings](Set-CsOnlineVoicemailUserSettings.md) -### [Set-CsOnlineVoiceRoute](Set-CsOnlineVoiceRoute.md) -### [Set-CsOnlineVoiceRoutingPolicy](Set-CsOnlineVoiceRoutingPolicy.md) -### [Set-CsOnlineVoiceUser](Set-CsOnlineVoiceUser.md) -### [Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) -### [Set-CsTeamsAcsFederationConfiguration](Set-CsTeamsAcsFederationConfiguration.md) -### [Set-CsTeamsAppPermissionPolicy](Set-CsTeamsAppPermissionPolicy.md) -### [Set-CsTeamsAppSetupPolicy](Set-CsTeamsAppSetupPolicy.md) -### [Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) -### [Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) -### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) -### [Set-CsTeamsCallParkPolicy](Set-CsTeamsCallParkPolicy.md) -### [Set-CsTeamsChannelsPolicy](Set-CsTeamsChannelsPolicy.md) -### [Set-CsTeamsClientConfiguration](Set-CsTeamsClientConfiguration.md) -### [Set-CsTeamsComplianceRecordingApplication](Set-CsTeamsComplianceRecordingApplication.md) -### [Set-CsTeamsComplianceRecordingPolicy](Set-CsTeamsComplianceRecordingPolicy.md) -### [Set-CsTeamsCortanaPolicy](Set-CsTeamsCortanaPolicy.md) -### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) -### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) -### [Set-CsTeamsEducationAssignmentsAppPolicy](Set-CsTeamsEducationAssignmentsAppPolicy.md) -### [Set-CsTeamsEducationConfiguration](Set-CsTeamsEducationConfiguration.md) -### [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) -### [Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) -### [Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) -### [Set-CsTeamsEventsPolicy](Set-CsTeamsEventsPolicy.md) -### [Set-CsTeamsFeedbackPolicy](Set-CsTeamsFeedbackPolicy.md) -### [Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) -### [Set-CsTeamsGuestCallingConfiguration](Set-CsTeamsGuestCallingConfiguration.md) -### [Set-CsTeamsGuestMeetingConfiguration](Set-CsTeamsGuestMeetingConfiguration.md) -### [Set-CsTeamsGuestMessagingConfiguration](Set-CsTeamsGuestMessagingConfiguration.md) -### [Set-CsTeamsIPPhonePolicy](Set-CsTeamsIPPhonePolicy.md) -### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) -### [Set-CsTeamsMeetingBroadcastConfiguration](Set-CsTeamsMeetingBroadcastConfiguration.md) -### [Set-CsTeamsMeetingBroadcastPolicy](Set-CsTeamsMeetingBroadcastPolicy.md) -### [Set-CsTeamsMeetingConfiguration](Set-CsTeamsMeetingConfiguration.md) -### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) -### [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Set-CsTeamsMessagingConfiguration](Set-CsTeamsMessagingConfiguration.md) -### [Set-CsTeamsMessagingPolicy](Set-CsTeamsMessagingPolicy.md) -### [Set-CsTeamsMobilityPolicy](Set-CsTeamsMobilityPolicy.md) -### [Set-CsTeamsNetworkRoamingPolicy](Set-CsTeamsNetworkRoamingPolicy.md) -### [Set-CsTeamsPinnedApp](Set-CsTeamsPinnedApp.md) -### [Set-CsTeamsRecordingRollOutPolicy](Set-CsTeamsRecordingRollOutPolicy.md) -### [Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) -### [Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) -### [Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) -### [Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) -### [Set-CsTeamsSipDevicesConfiguration](Set-CsTeamsSipDevicesConfiguration.md) -### [Set-CsTeamsSurvivableBranchAppliance](Set-CsTeamsSurvivableBranchAppliance.md) -### [Set-CsTeamsSurvivableBranchAppliancePolicy](Set-CsTeamsSurvivableBranchAppliancePolicy.md) -### [Set-CsTeamsTargetingPolicy](Set-CsTeamsTargetingPolicy.md) -### [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) -### [Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) -### [Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) -### [Set-CsTeamsUpdateManagementPolicy](Set-CsTeamsUpdateManagementPolicy.md) -### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) -### [Set-CsTeamsVdiPolicy](Set-CsTeamsVdiPolicy.md) -### [Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) -### [Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) -### [Set-CsTeamsWorkLoadPolicy](Set-CsTeamsWorkLoadPolicy.md) -### [Set-CsTeamsWorkLocationDetectionPolicy](Set-CsTeamsWorkLocationDetectionPolicy.md) -### [Set-CsTenantBlockedCallingNumbers](Set-CsTenantBlockedCallingNumbers.md) -### [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) -### [Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) -### [Set-CsTenantMigrationConfiguration](Set-CsTenantMigrationConfiguration.md) -### [Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) -### [Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) -### [Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) -### [Set-CsTenantTrustedIPAddress](Set-CsTenantTrustedIPAddress.md) -### [Set-CsUser](Set-CsUser.md) -### [Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) -### [Set-CsUserCallingSettings](Set-CsUserCallingSettings.md) -### [Set-CsVideoInteropServiceProvider](Set-CsVideoInteropServiceProvider.md) -### [Set-Team](Set-Team.md) -### [Set-TeamArchivedState](Set-TeamArchivedState.md) -### [Set-TeamChannel](Set-TeamChannel.md) -### [Set-TeamFunSettings](Set-TeamFunSettings.md) -### [Set-TeamGuestSettings](Set-TeamGuestSettings.md) -### [Set-TeamMemberSettings](Set-TeamMemberSettings.md) -### [Set-TeamMessagingSettings](Set-TeamMessagingSettings.md) -### [Set-TeamPicture](Set-TeamPicture.md) -### [Set-TeamsApp](Set-TeamsApp.md) -### [Set-TeamsEnvironmentConfig](Set-TeamsEnvironmentConfig.md) -### [Set-TeamTargetingHierarchy](Set-TeamTargetingHierarchy.md) -### [Start-CsExMeetingMigration](Start-CsExMeetingMigration.md) -### [Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) -### [Test-CsEffectiveTenantDialPlan](Test-CsEffectiveTenantDialPlan.md) -### [Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) -### [Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) -### [Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) -### [Test-CsTeamsUnassignedNumberTreatment](Test-CsTeamsUnassignedNumberTreatment.md) -### [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) -### [Unregister-CsOnlineDialInConferencingServiceNumber](Unregister-CsOnlineDialInConferencingServiceNumber.md) -### [Update-CsAutoAttendant](Update-CsAutoAttendant.md) -### [Update-CsCustomPolicyPackage](Update-CsCustomPolicyPackage.md) -### [Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) -### [Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) -### [Update-CsTeamTemplate](Update-CsTeamTemplate.md) -### [Update-M365UnifiedCustomPendingApp](Update-M365UnifiedCustomPendingApp.md) -### [Update-TeamsAppInstallation](Update-TeamsAppInstallation.md) diff --git a/test/MicrosoftTeams/Set-CsTeamsEdcuationConfiguration.yml b/test/MicrosoftTeams/Set-CsTeamsEdcuationConfiguration.yml new file mode 100644 index 0000000000..796a96129b --- /dev/null +++ b/test/MicrosoftTeams/Set-CsTeamsEdcuationConfiguration.yml @@ -0,0 +1,109 @@ +metadata: + author: SaritaBehera + document type: cmdlet + external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml + HelpUri: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamseducationconfiguration + Locale: en-US + Module Name: MicrosoftTeams + ms.author: saritabehera + PlatyPS schema version: 2024-05-01 + title: Set-CsTeamsEducationConfiguration +title: Set-CsTeamsEdcuationConfiguration +synopsis: This cmdlet is used to manage the organization-wide education configuration for Teams. +syntaxes: +- commandName: Set-CsTeamsEducationConfiguration + parameterSetName: Default + isDefault: true + parameters: + - '[-ParentGuardianPreferredContactMethod ]' + - '[-UpdateParentInformation ]' + - '[-WhatIf]' + - '[-Confirm]' +aliases: '' +description: |- + This cmdlet is used to manage the organization-wide education configuration for Teams which contains settings that are applicable to education organizations. + + You must be a Teams Service Administrator for your organization to run the cmdlet. +examples: +- title: Example 1 + description: >- + In this example, Email is set as the preferred contact method used for parent communication invitations across the organization. + + + ```powershell + + Set-CsTeamsEducationConfiguration -ParentGuardianPreferredContactMethod Email + + ``` +- title: Example 2 + description: >- + In this example, SMS is set as the preferred contact method used for parent communication invitations across the organization. + + + ```powershell + + Set-CsTeamsEducationConfiguration -ParentGuardianPreferredContactMethod SMS + + ``` +- title: Example 3 + description: >- + In this example, updating parents contact information is enabled by educators across the organization. + + + ```powershell + + Set-CsTeamsEducationConfiguration -UpdateParentInformation Enabled + + ``` +- title: Example 4 + description: >- + In this example, updating parents contact information is disabled by educators across the organization. + + + ```powershell + + Set-CsTeamsEducationConfiguration -UpdateParentInformation Disabled + + ``` +parameters: +- name: ParentGuardianPreferredContactMethod + type: System.String + description: Indicates whether Email or SMS is the preferred contact method used for parent communication invitations. Possible values are 'Email' and 'SMS'. + defaultValue: Email + supportsWildcards: false + isDynamic: false + aliases: [] + dontShow: false + acceptedValues: [] + parameterSets: + - &o0 + name: (All) + position: Named + isRequired: false + valueFromPipeline: false + valueFromPipelineByPropertyName: false + valueFromRemainingArguments: false + helpMessage: '' +- name: UpdateParentInformation + type: System.String + description: Indicates whether updating parents contact information is Enabled/Disabled by educators. Possible values are 'Enabled' and 'Disabled'. + defaultValue: Enabled + supportsWildcards: false + isDynamic: false + aliases: [] + dontShow: false + acceptedValues: [] + parameterSets: + - *o0 + helpMessage: '' + +- name: CommonParameters + description: |- + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, + -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, + -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see + [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +notes: '' +links: +- text: 'Get-CsTeamsEducationConfiguration' + href: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamseducationconfiguration diff --git a/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboards.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboards.md new file mode 100644 index 0000000000..98ca948043 --- /dev/null +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboards.md @@ -0,0 +1,157 @@ +--- +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 + +``` +Get-OriginalFluidWhiteboards [-UserId] [[-ConnectMgGraph] ] [[-ContinuationToken] ] + [-ForceAuthPrompt] [[-IncrementalRunName] ] [] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are originally created as Fluid whiteboards, directly into users OneDrive. + +## EXAMPLES + +### EXAMPLE 1 + +Get all user's whiteboards that are originally created as Fluid whiteboards directly into users OneDrive. + +```powershell +PS C:\>Get-OriginalFluidWhiteboards -UserId 00000000-0000-0000-0000-000000000001 +``` + + +```Output +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 + +### -ConnectMgGraph +{{ Fill ConnectMgGraph Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinuationToken +{{ Fill ContinuationToken Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -IncrementalRunName +{{ Fill IncrementalRunName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboardsForTenant.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboardsForTenant.md new file mode 100644 index 0000000000..f7b62579a6 --- /dev/null +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboardsForTenant.md @@ -0,0 +1,190 @@ +--- +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 + +``` +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 + +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. + +```powershell +PS C:\>Get-OriginalFluidWhiteboardsForTenant +``` + +```Output +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 + +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. + +```powershell +PS C:\>Get-OriginalFluidWhiteboardsForTenant -IncrementalRunName 1 +``` + +```Output +[ + "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 + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## 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/WhiteboardAdmin/Get-Whiteboard.md similarity index 71% rename from whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-Whiteboard.md index ca0223451d..03e8645122 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-Whiteboard.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboard @@ -13,40 +13,39 @@ ms.reviewer: # Get-Whiteboard ## 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 -```powershell +``` Get-Whiteboard [-UserId] [[-WhiteboardId] ] [-ForceAuthPrompt] [] ``` ## DESCRIPTION -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. ## EXAMPLES ### EXAMPLE 1 ```powershell -PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 +Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 ``` Get all of a user's whiteboards. ### EXAMPLE 2 -```powershell -PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId 00000000-0000-0000-0000-000000000002 -``` - Get a user's specific whiteboard. -### Output +```powershell +Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId 00000000-0000-0000-0000-000000000002 +``` -```yaml +```Output baseApi: baseApi-value id: whiteboardId-value userId: userId-value @@ -68,60 +67,60 @@ eTag: eTag-value ## PARAMETERS -### -UserId +### -ForceAuthPrompt -The ID of the user account to query whiteboards for. All whiteboards this account has access to will be returned. +Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: Guid +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -WhiteboardId +### -UserId -Optional. The ID of a specific whiteboard. +The ID of the user account to query whiteboards for. All whiteboards this account has access to will +be returned. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: -Required: False -Position: 2 +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. +### -WhiteboardId +(Optional) The ID of a specific Whiteboard to query, if not specified all whiteboards are queried. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 2 +Default value: None 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) +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) ## INPUTS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardOwners.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardOwners.md similarity index 61% rename from whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardOwners.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardOwners.md index 1f5bb1aa2a..91c7256f50 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardOwners.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardOwners.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardowners @@ -13,32 +13,34 @@ ms.reviewer: # Get-WhiteboardOwners ## SYNOPSIS - Gets all the users in a tenant who own whiteboards in a specified geography. ## SYNTAX -```powershell -Get-WhiteboardOwners [-Geography] [[-ContinuationToken] ] [-ForceAuthPrompt] [] +``` +Get-WhiteboardOwners [-Geography] [[-ContinuationToken] ] [-ForceAuthPrompt] + [] ``` ## DESCRIPTION -Gets all the users in a tenant who own whiteboards in a specified geography. Returns them as an object containing a list of user object, a tenantId and a continuation token. By calling repeatedly passing in the new continuation tokens, all the owners for a tenant can be gathered. The data returned is precalculated and therefore not realtime. Results are precalculated approximately every two weeks. +Gets all the users in a tenant who own whiteboards in a specified geography. Returns them as an +object containing a list of user object, a tenantId and a continuation token. By calling repeatedly +passing in the new continuation tokens, all the owners for a tenant can be gathered. The data +returned is precalculated and therefore not realtime. Results are precalculated approximately every +two weeks. ## EXAMPLES ### EXAMPLE 1 +Get the owners in the European geography. + ```powershell PS C:\>Get-WhiteboardOwners -Geography Europe ``` -Get the owners in the European geography. - -### Output - -```yaml +```Output TenantId: tenantId Geography: The geography queried for Items: List of user ids @@ -47,60 +49,63 @@ ContinuationToken: continuation token ## PARAMETERS -### -Geography +### -ContinuationToken -Required. The geography to look for board owners in. Accepted values are: Europe, Australia, or Worldwide (all boards not in australia or europe). +(Optional) A continuation token based on the last time this function was called. Due to the large +volume of boards in a tenant, results are returned in chunks at a time, with a continuation token to +signify where to pick up from. To start from the beginning, pass in null. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -ContinuationToken +### -ForceAuthPrompt -Optional. The continuation token returned in a previous call. +Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 2 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -Geography -Optional. Always prompt for auth. Use to ignore cached credentials. +Required. The geography to look for board owners in. Accepted values are: Europe, Australia, or +Worldwide (all boards not in australia or europe). ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS diff --git a/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardSettings.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardSettings.md new file mode 100644 index 0000000000..1d6374671b --- /dev/null +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardSettings.md @@ -0,0 +1,86 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsettings +applicable: Microsoft Whiteboard +title: Get-WhiteboardSettings +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-WhiteboardSettings + +## SYNOPSIS +Get the users Whiteboard settings. + +## SYNTAX + +``` +Get-WhiteboardSettings [-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 +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: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/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/WhiteboardAdmin/Get-WhiteboardsForTenant.md similarity index 66% rename from whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenant.md index 2f9679d567..99e434215a 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenant.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsfortenant @@ -13,30 +13,29 @@ ms.reviewer: # Get-WhiteboardsForTenant ## 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 +### 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 +Get-WhiteboardsForTenant -Geography Europe ``` ```Output @@ -77,65 +76,80 @@ meetingId : eTag : W/"datetime'2023-01-06T19%3A22%3A42.6717851Z'" ``` +### Example 2 + +```powershell +Get-WhiteboardsForTenant -Geography Europe -IncrementalRunName 1 +``` + +Gets all the tenant whiteboards in Europe and incrementally writes them to Whiteboards-1.txt file in +the current directory. Saves progress at WhiteboardAdminRun-1.txt file until the request is +completed. If this file already exists, continues the progress using the last saved token. + ## PARAMETERS -### -Geography +### -ForceAuthPrompt -The geography to look for board owners in. Accepted values are `Europe`, `Australia`, or `Worldwide` (all boards not in Australia or Europe). +Always prompt for authentication. Use to ignore cached credentials. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -IncrementalRunName - -Saves incremental progress as the cmdlet runs. Use to resume a partially completed run. Use the same **IncrementalRunName** value on later calls to continue a previously canceled or failed run. Writes progress and results to `.txt` files in the current directory: +### -Geography -- `Whiteboards-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. -- `WhiteboardAdminRun-*.txt` contains the current state where `*` is the provided **IncrementalRunName**. This file should not be modified manually. +The geography to look for board owners in. Accepted values are `Europe`, `Australia`, or `Worldwide` +(all boards not in Australia or Europe). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: -Required: False -Position: 2 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -IncrementalRunName -Always prompt for authentication. Use to ignore cached credentials. +Saves incremental progress as the cmdlet runs. Use to resume a partially completed run. Use the same +**IncrementalRunName** value on later calls to continue a previously canceled or failed run. Writes +progress and results to `.txt` files in the current directory: + +- `Whiteboards-*.txt` contains the incremental results containing whiteboard objects for the tenant + where `*` is the provided **IncrementalRunName**. +- `WhiteboardAdminRun-*.txt` contains the current state where `*` is the provided + **IncrementalRunName**. This file should not be modified manually. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 2 +Default value: None 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS diff --git a/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenantMigrated.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenantMigrated.md new file mode 100644 index 0000000000..c9f0cb28ad --- /dev/null +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenantMigrated.md @@ -0,0 +1,188 @@ +--- +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 + +``` +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 + +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. + +```powershell +Get-WhiteboardsForTenantMigrated +``` + +```Output +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 + +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. + +```powershell +Get-WhiteboardsForTenantMigrated -IncrementalRunName 1 +``` + +```Output +[ + "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 + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsMigrated.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsMigrated.md new file mode 100644 index 0000000000..e9d9d7ec5d --- /dev/null +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsMigrated.md @@ -0,0 +1,158 @@ +--- +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 + +``` +Get-WhiteboardsMigrated [-UserId] [[-ConnectMgGraph] ] [[-ContinuationToken] ] + [-ForceAuthPrompt] [[-IncrementalRunName] ] [] +``` + +## 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 + +Get all user's migrated whiteboards. + +```powershell +Get-WhiteboardsMigrated -UserId e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +``` + +```Output +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 + +### -ConnectMgGraph +{{ Fill ConnectMgGraph Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinuationToken +{{ Fill ContinuationToken Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncrementalRunName +{{ Fill IncrementalRunName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: System.Guid +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/p/?LinkID=113216) + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Invoke-TransferAllWhiteboards.md similarity index 69% rename from whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Invoke-TransferAllWhiteboards.md index a770d4b062..3ccd15a974 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Invoke-TransferAllWhiteboards.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/invoke-transferallwhiteboards @@ -13,13 +13,13 @@ ms.reviewer: # Invoke-TransferAllWhiteboards ## SYNOPSIS - -Transfer ownership of all whiteboards owned by a user to another user. +Transfer ownership of all Whiteboards owned by a user to another user. ## SYNTAX -```powershell -Invoke-TransferAllWhiteboards [-OldOwnerId] [-NewOwnerId] [-ForceAuthPrompt] [-WhatIf] [-Confirm] [] +``` +Invoke-TransferAllWhiteboards [-OldOwnerId] [-NewOwnerId] [-ForceAuthPrompt] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,7 +31,7 @@ Transfer ownership of all whiteboards owned by a user to another user. ### EXAMPLE 1 ```powershell -PS C:\>Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 -WhatIf +Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 -WhatIf ``` Check how many whiteboards will be transferred without transferring them. @@ -39,28 +39,27 @@ Check how many whiteboards will be transferred without transferring them. ### EXAMPLE 2 ```powershell -PS C:\>Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 +Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 ``` Transfer (and prompt before performing any write actions). ## PARAMETERS -### -OldOwnerId +### -ForceAuthPrompt -The ID of the previous owner. +Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: Guid +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` ### -NewOwnerId @@ -68,7 +67,7 @@ Applicable: Microsoft Whiteboard The ID of the new owner. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -77,63 +76,62 @@ Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -OldOwnerId -Optional. Always prompt for auth. Use to ignore cached credentials. +The ID of the previous owner. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -WhatIf +### -Confirm -Execute the command without making any actual changes. Only calls read methods on the REST service. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -Confirm +### -WhatIf -Prompts you for confirmation before running the cmdlet. +Execute the command without making any actual changes. Only calls read methods on the REST service. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named Default value: None 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS diff --git a/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Remove-Whiteboard.md similarity index 70% rename from whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Remove-Whiteboard.md index 69a0893606..e2032059a9 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Remove-Whiteboard.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/remove-whiteboard @@ -13,8 +13,7 @@ ms.reviewer: # Remove-Whiteboard ## SYNOPSIS - -Deletes the specified whiteboard for the given user from the Microsoft Whiteboard service. If the user is the owner of the whiteboard, the entire whiteboard will be deleted. If the user has joined the whiteboard but does not own it, they will be removed and the whiteboard will still be accessible by others. +Deletes the specified whiteboard for the given user from the Microsoft Whiteboard service. ## SYNTAX @@ -24,7 +23,10 @@ Remove-Whiteboard [-UserId] [-WhiteboardId] [-ForceAuthPrompt] [ [-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-000000000000 +``` + +Restore the whiteboard. + +## PARAMETERS + +### -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 +``` + +### -WhiteboardId + +The ID of a specific whiteboard to restore. + +```yaml +Type: System.Guid +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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardOwner.md similarity index 71% rename from whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardOwner.md index 3b05afdd46..95090b1463 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardOwner.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/set-whiteboardowner @@ -13,13 +13,13 @@ ms.reviewer: # Set-WhiteboardOwner ## SYNOPSIS - -Sets the owner for a whiteboard. +Sets the owner for a Whiteboard. ## SYNTAX -```powershell -Set-WhiteboardOwner [-WhiteboardId] [-OldOwnerId] [-NewOwnerId] [-ForceAuthPrompt] [-WhatIf] [-Confirm] [] +``` +Set-WhiteboardOwner [-WhiteboardId] [-OldOwnerId] [-NewOwnerId] [-ForceAuthPrompt] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,118 +31,115 @@ Sets the owner for a whiteboard. ### EXAMPLE 1 ```powershell -PS C:\>Set-WhiteboardOwner -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 -WhiteboardId 00000000-0000-0000-0000-000000000003 +Set-WhiteboardOwner -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 ``` Move whiteboard ownership from one user to another. ## PARAMETERS -### -WhiteboardId +### -ForceAuthPrompt -The whiteboard for which the owner is being changed. +Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: Guid +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -OldOwnerId +### -NewOwnerId -The ID of the previous owner. +The ID of the new owner. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -NewOwnerId +### -OldOwnerId -The ID of the new owner. +The ID of the previous owner. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Required: True -Position: 3 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -WhiteboardId -Optional. Always prompt for auth. Use to ignore cached credentials. +The whiteboard for which the owner is being changed. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -WhatIf +### -Confirm -Shows what would happen if the cmdlet runs. The cmdlet is not run. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` -### -Confirm +### -WhatIf -Prompts you for confirmation before running the cmdlet. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named Default value: None 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS diff --git a/whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardSettings.md new file mode 100644 index 0000000000..f7f81517de --- /dev/null +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardSettings.md @@ -0,0 +1,91 @@ +--- +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 + +``` +Set-WhiteboardSettings [-Settings] [-ForceAuthPrompt] [] +``` + +## 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 +$settings = Get-WhiteboardSettings +$settings.isEnabledGa = $true +Set-WhiteboardSettings -Settings $settings +``` + +## PARAMETERS + +### -ForceAuthPrompt + +Always prompt for authentication. Use to ignore cached credentials. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Settings + +The object to use as Whiteboard Settings. Should be retrieved via +[Get-WhiteboardSettings](Get-WhiteboardSettings.md). + +```yaml +Type: System.Management.Automation.PSObject +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/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/WhiteboardAdmin/WhiteboardAdmin.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/WhiteboardAdmin.md new file mode 100644 index 0000000000..ff0f11e89b --- /dev/null +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/WhiteboardAdmin.md @@ -0,0 +1,77 @@ +--- +Module Name: WhiteboardAdmin +Module Guid: cc24f7d4-4cf7-46d3-bd87-30a3d44ecf96 +Download Help Link: +Help Version: +Locale: en-US +--- + +# WhiteboardAdmin Module + +## Description + +The following cmdlet references are for Microsoft Whiteboard. See +[Overview](/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 +> +> To get a whiteboard that is in OneDrive for any user, Admin should have access to their user's +> OneDrive. Admin can use Admin portal to give the `Site-CollectionAdmin` role to user account for +> which they want to get all whiteboards. +> +> 1. Go to **SharePoint Admin center** +> 2. On left hand side, select **More features** +> 3. In **User profiles**, select **Open** > **Manage User profiles** > **Search user** > +> **Manage site collection owners** > **Add Admin as Site Collection Administrator**. + +## WhiteboardAdmin Cmdlets + +### [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 directly into OneDrive for all users under that admin and returns them as objects. + +### [Get-Whiteboard](Get-Whiteboard.md) +Gets one or more whiteboards in Azure from the Microsoft Whiteboard service and returns them as objects. + +### [Get-WhiteboardOwners](Get-WhiteboardOwners.md) +Gets all the users in a tenant who own whiteboards in a specified geography. + +### [Get-WhiteboardSettings](Get-WhiteboardSettings.md) +Get the users Whiteboard settings. + +### [Get-WhiteboardsForTenant](Get-WhiteboardsForTenant.md) +Gets all the whiteboards in Azure associated with a tenant in a specified geography. + +### [Get-WhiteboardsForTenantMigrated](Get-WhiteboardsForTenantMigrated.md) +Gets one or more whiteboards that are migrated to OneDrive 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. + +### [Invoke-TransferAllWhiteboards](Invoke-TransferAllWhiteboards.md) +Transfer ownership of all Whiteboards owned by a user to another user. + +### [Remove-Whiteboard](Remove-Whiteboard.md) +Deletes the specified whiteboard for the given user from the Microsoft Whiteboard service. + +### [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. + +### [Set-WhiteboardOwner](Set-WhiteboardOwner.md) +Sets the owner for a Whiteboard. + +### [Set-WhiteboardSettings](Set-WhiteboardSettings.md) +Get the users Whiteboard settings. diff --git a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md deleted file mode 100644 index 00451f81bc..0000000000 --- a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -Module Name: Microsoft Whiteboard Admin -Module Guid: CC24F7D4-4CF7-46D3-BD87-30A3D44ECF96 -title: Microsoft Whiteboard ---- - -# Microsoft Whiteboard Admin - -## Description - -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). - - -## Microsoft Whiteboard Admin cmdlets - -### [Get-Whiteboard](Get-Whiteboard.md) - -Gets one or more whiteboards from the Microsoft Whiteboard service and returns them as objects. - -### [Get-WhiteboardOwners](Get-WhiteboardOwners.md) - -Gets all the users in a tenant who own whiteboards in a specified geography. - -### [Get-WhiteboardsForTenant](Get-WhiteboardsForTenant.md) - -Gets all the whiteboards associated with a tenant in a specified geography. - -### [Invoke-TransferAllWhiteboard](Invoke-TransferAllWhiteboards.md) - -Transfer ownership of all whiteboards owned by a user to another user. - -### [Remove-Whiteboard](Remove-Whiteboard.md) - -Deletes the specified whiteboard for the given user from the Microsoft Whiteboard service. If the user is the owner of the whiteboard, the entire whiteboard will be deleted. If the user has joined the whiteboard but does not own it, they will be removed and the whiteboard will still be accessible by others. - -### [Set-WhiteboardOwner](Set-WhiteboardOwner.md) - -Sets the owner for a whiteboard.